1 // SPDX-License-Identifier: GPL-2.0
3 * Common Block IO controller cgroup interface
5 * Based on ideas and code from CFQ, CFS and BFQ:
6 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
8 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
9 * Paolo Valente <paolo.valente@unimore.it>
11 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
12 * Nauman Rafique <nauman@google.com>
14 * For policy-specific per-blkcg data:
15 * Copyright (C) 2015 Paolo Valente <paolo.valente@unimore.it>
16 * Arianna Avanzini <avanzini.arianna@gmail.com>
18 #include <linux/ioprio.h>
19 #include <linux/kdev_t.h>
20 #include <linux/module.h>
21 #include <linux/sched/signal.h>
22 #include <linux/err.h>
23 #include <linux/blkdev.h>
24 #include <linux/backing-dev.h>
25 #include <linux/slab.h>
26 #include <linux/delay.h>
27 #include <linux/atomic.h>
28 #include <linux/ctype.h>
29 #include <linux/resume_user_mode.h>
30 #include <linux/psi.h>
31 #include <linux/part_stat.h>
33 #include "blk-cgroup.h"
34 #include "blk-ioprio.h"
35 #include "blk-throttle.h"
38 * blkcg_pol_mutex protects blkcg_policy[] and policy [de]activation.
39 * blkcg_pol_register_mutex nests outside of it and synchronizes entire
40 * policy [un]register operations including cgroup file additions /
41 * removals. Putting cgroup file registration outside blkcg_pol_mutex
42 * allows grabbing it from cgroup callbacks.
44 static DEFINE_MUTEX(blkcg_pol_register_mutex);
45 static DEFINE_MUTEX(blkcg_pol_mutex);
47 struct blkcg blkcg_root;
48 EXPORT_SYMBOL_GPL(blkcg_root);
50 struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;
51 EXPORT_SYMBOL_GPL(blkcg_root_css);
53 static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
55 static LIST_HEAD(all_blkcgs); /* protected by blkcg_pol_mutex */
57 bool blkcg_debug_stats = false;
58 static struct workqueue_struct *blkcg_punt_bio_wq;
60 #define BLKG_DESTROY_BATCH_SIZE 64
63 * blkcg_css - find the current css
65 * Find the css associated with either the kthread or the current task.
66 * This may return a dying css, so it is up to the caller to use tryget logic
67 * to confirm it is alive and well.
69 static struct cgroup_subsys_state *blkcg_css(void)
71 struct cgroup_subsys_state *css;
73 css = kthread_blkcg();
76 return task_css(current, io_cgrp_id);
79 static bool blkcg_policy_enabled(struct request_queue *q,
80 const struct blkcg_policy *pol)
82 return pol && test_bit(pol->plid, q->blkcg_pols);
85 static void blkg_free_workfn(struct work_struct *work)
87 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
91 for (i = 0; i < BLKCG_MAX_POLS; i++)
93 blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
96 blk_put_queue(blkg->q);
97 free_percpu(blkg->iostat_cpu);
98 percpu_ref_exit(&blkg->refcnt);
103 * blkg_free - free a blkg
104 * @blkg: blkg to free
106 * Free @blkg which may be partially allocated.
108 static void blkg_free(struct blkcg_gq *blkg)
114 * Both ->pd_free_fn() and request queue's release handler may
115 * sleep, so free us by scheduling one work func
117 INIT_WORK(&blkg->free_work, blkg_free_workfn);
118 schedule_work(&blkg->free_work);
121 static void __blkg_release(struct rcu_head *rcu)
123 struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);
125 WARN_ON(!bio_list_empty(&blkg->async_bios));
127 /* release the blkcg and parent blkg refs this blkg has been holding */
128 css_put(&blkg->blkcg->css);
130 blkg_put(blkg->parent);
135 * A group is RCU protected, but having an rcu lock does not mean that one
136 * can access all the fields of blkg and assume these are valid. For
137 * example, don't try to follow throtl_data and request queue links.
139 * Having a reference to blkg under an rcu allows accesses to only values
140 * local to groups like group stats and group rate limits.
142 static void blkg_release(struct percpu_ref *ref)
144 struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);
146 call_rcu(&blkg->rcu_head, __blkg_release);
149 static void blkg_async_bio_workfn(struct work_struct *work)
151 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
153 struct bio_list bios = BIO_EMPTY_LIST;
155 struct blk_plug plug;
156 bool need_plug = false;
158 /* as long as there are pending bios, @blkg can't go away */
159 spin_lock_bh(&blkg->async_bio_lock);
160 bio_list_merge(&bios, &blkg->async_bios);
161 bio_list_init(&blkg->async_bios);
162 spin_unlock_bh(&blkg->async_bio_lock);
164 /* start plug only when bio_list contains at least 2 bios */
165 if (bios.head && bios.head->bi_next) {
167 blk_start_plug(&plug);
169 while ((bio = bio_list_pop(&bios)))
172 blk_finish_plug(&plug);
176 * bio_blkcg_css - return the blkcg CSS associated with a bio
179 * This returns the CSS for the blkcg associated with a bio, or %NULL if not
180 * associated. Callers are expected to either handle %NULL or know association
181 * has been done prior to calling this.
183 struct cgroup_subsys_state *bio_blkcg_css(struct bio *bio)
185 if (!bio || !bio->bi_blkg)
187 return &bio->bi_blkg->blkcg->css;
189 EXPORT_SYMBOL_GPL(bio_blkcg_css);
192 * blkcg_parent - get the parent of a blkcg
193 * @blkcg: blkcg of interest
195 * Return the parent blkcg of @blkcg. Can be called anytime.
197 static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
199 return css_to_blkcg(blkcg->css.parent);
203 * blkg_alloc - allocate a blkg
204 * @blkcg: block cgroup the new blkg is associated with
205 * @disk: gendisk the new blkg is associated with
206 * @gfp_mask: allocation mask to use
208 * Allocate a new blkg assocating @blkcg and @q.
210 static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct gendisk *disk,
213 struct blkcg_gq *blkg;
216 /* alloc and init base part */
217 blkg = kzalloc_node(sizeof(*blkg), gfp_mask, disk->queue->node);
221 if (percpu_ref_init(&blkg->refcnt, blkg_release, 0, gfp_mask))
224 blkg->iostat_cpu = alloc_percpu_gfp(struct blkg_iostat_set, gfp_mask);
225 if (!blkg->iostat_cpu)
228 if (!blk_get_queue(disk->queue))
231 blkg->q = disk->queue;
232 INIT_LIST_HEAD(&blkg->q_node);
233 spin_lock_init(&blkg->async_bio_lock);
234 bio_list_init(&blkg->async_bios);
235 INIT_WORK(&blkg->async_bio_work, blkg_async_bio_workfn);
238 u64_stats_init(&blkg->iostat.sync);
239 for_each_possible_cpu(cpu)
240 u64_stats_init(&per_cpu_ptr(blkg->iostat_cpu, cpu)->sync);
242 for (i = 0; i < BLKCG_MAX_POLS; i++) {
243 struct blkcg_policy *pol = blkcg_policy[i];
244 struct blkg_policy_data *pd;
246 if (!blkcg_policy_enabled(disk->queue, pol))
249 /* alloc per-policy data and attach it to blkg */
250 pd = pol->pd_alloc_fn(gfp_mask, disk->queue, blkcg);
267 * If @new_blkg is %NULL, this function tries to allocate a new one as
268 * necessary using %GFP_NOWAIT. @new_blkg is always consumed on return.
270 static struct blkcg_gq *blkg_create(struct blkcg *blkcg, struct gendisk *disk,
271 struct blkcg_gq *new_blkg)
273 struct blkcg_gq *blkg;
276 lockdep_assert_held(&disk->queue->queue_lock);
278 /* request_queue is dying, do not create/recreate a blkg */
279 if (blk_queue_dying(disk->queue)) {
284 /* blkg holds a reference to blkcg */
285 if (!css_tryget_online(&blkcg->css)) {
292 new_blkg = blkg_alloc(blkcg, disk, GFP_NOWAIT | __GFP_NOWARN);
293 if (unlikely(!new_blkg)) {
301 if (blkcg_parent(blkcg)) {
302 blkg->parent = blkg_lookup(blkcg_parent(blkcg), disk->queue);
303 if (WARN_ON_ONCE(!blkg->parent)) {
307 blkg_get(blkg->parent);
310 /* invoke per-policy init */
311 for (i = 0; i < BLKCG_MAX_POLS; i++) {
312 struct blkcg_policy *pol = blkcg_policy[i];
314 if (blkg->pd[i] && pol->pd_init_fn)
315 pol->pd_init_fn(blkg->pd[i]);
319 spin_lock(&blkcg->lock);
320 ret = radix_tree_insert(&blkcg->blkg_tree, disk->queue->id, blkg);
322 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
323 list_add(&blkg->q_node, &disk->queue->blkg_list);
325 for (i = 0; i < BLKCG_MAX_POLS; i++) {
326 struct blkcg_policy *pol = blkcg_policy[i];
328 if (blkg->pd[i] && pol->pd_online_fn)
329 pol->pd_online_fn(blkg->pd[i]);
333 spin_unlock(&blkcg->lock);
338 /* @blkg failed fully initialized, use the usual release path */
343 css_put(&blkcg->css);
350 * blkg_lookup_create - lookup blkg, try to create one if not there
351 * @blkcg: blkcg of interest
352 * @disk: gendisk of interest
354 * Lookup blkg for the @blkcg - @disk pair. If it doesn't exist, try to
355 * create one. blkg creation is performed recursively from blkcg_root such
356 * that all non-root blkg's have access to the parent blkg. This function
357 * should be called under RCU read lock and takes @disk->queue->queue_lock.
359 * Returns the blkg or the closest blkg if blkg_create() fails as it walks
362 static struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
363 struct gendisk *disk)
365 struct request_queue *q = disk->queue;
366 struct blkcg_gq *blkg;
369 WARN_ON_ONCE(!rcu_read_lock_held());
371 blkg = blkg_lookup(blkcg, q);
375 spin_lock_irqsave(&q->queue_lock, flags);
376 blkg = blkg_lookup(blkcg, q);
378 if (blkcg != &blkcg_root &&
379 blkg != rcu_dereference(blkcg->blkg_hint))
380 rcu_assign_pointer(blkcg->blkg_hint, blkg);
385 * Create blkgs walking down from blkcg_root to @blkcg, so that all
386 * non-root blkgs have access to their parents. Returns the closest
387 * blkg to the intended blkg should blkg_create() fail.
390 struct blkcg *pos = blkcg;
391 struct blkcg *parent = blkcg_parent(blkcg);
392 struct blkcg_gq *ret_blkg = q->root_blkg;
395 blkg = blkg_lookup(parent, q);
397 /* remember closest blkg */
402 parent = blkcg_parent(parent);
405 blkg = blkg_create(pos, disk, NULL);
415 spin_unlock_irqrestore(&q->queue_lock, flags);
419 static void blkg_destroy(struct blkcg_gq *blkg)
421 struct blkcg *blkcg = blkg->blkcg;
424 lockdep_assert_held(&blkg->q->queue_lock);
425 lockdep_assert_held(&blkcg->lock);
427 /* Something wrong if we are trying to remove same group twice */
428 WARN_ON_ONCE(list_empty(&blkg->q_node));
429 WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
431 for (i = 0; i < BLKCG_MAX_POLS; i++) {
432 struct blkcg_policy *pol = blkcg_policy[i];
434 if (blkg->pd[i] && pol->pd_offline_fn)
435 pol->pd_offline_fn(blkg->pd[i]);
438 blkg->online = false;
440 radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
441 list_del_init(&blkg->q_node);
442 hlist_del_init_rcu(&blkg->blkcg_node);
445 * Both setting lookup hint to and clearing it from @blkg are done
446 * under queue_lock. If it's not pointing to @blkg now, it never
447 * will. Hint assignment itself can race safely.
449 if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
450 rcu_assign_pointer(blkcg->blkg_hint, NULL);
453 * Put the reference taken at the time of creation so that when all
454 * queues are gone, group can be destroyed.
456 percpu_ref_kill(&blkg->refcnt);
459 static void blkg_destroy_all(struct gendisk *disk)
461 struct request_queue *q = disk->queue;
462 struct blkcg_gq *blkg, *n;
463 int count = BLKG_DESTROY_BATCH_SIZE;
466 spin_lock_irq(&q->queue_lock);
467 list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
468 struct blkcg *blkcg = blkg->blkcg;
470 spin_lock(&blkcg->lock);
472 spin_unlock(&blkcg->lock);
475 * in order to avoid holding the spin lock for too long, release
476 * it when a batch of blkgs are destroyed.
479 count = BLKG_DESTROY_BATCH_SIZE;
480 spin_unlock_irq(&q->queue_lock);
487 spin_unlock_irq(&q->queue_lock);
490 static int blkcg_reset_stats(struct cgroup_subsys_state *css,
491 struct cftype *cftype, u64 val)
493 struct blkcg *blkcg = css_to_blkcg(css);
494 struct blkcg_gq *blkg;
497 mutex_lock(&blkcg_pol_mutex);
498 spin_lock_irq(&blkcg->lock);
501 * Note that stat reset is racy - it doesn't synchronize against
502 * stat updates. This is a debug feature which shouldn't exist
503 * anyway. If you get hit by a race, retry.
505 hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
506 for_each_possible_cpu(cpu) {
507 struct blkg_iostat_set *bis =
508 per_cpu_ptr(blkg->iostat_cpu, cpu);
509 memset(bis, 0, sizeof(*bis));
511 memset(&blkg->iostat, 0, sizeof(blkg->iostat));
513 for (i = 0; i < BLKCG_MAX_POLS; i++) {
514 struct blkcg_policy *pol = blkcg_policy[i];
516 if (blkg->pd[i] && pol->pd_reset_stats_fn)
517 pol->pd_reset_stats_fn(blkg->pd[i]);
521 spin_unlock_irq(&blkcg->lock);
522 mutex_unlock(&blkcg_pol_mutex);
526 const char *blkg_dev_name(struct blkcg_gq *blkg)
528 if (!blkg->q->disk || !blkg->q->disk->bdi->dev)
530 return bdi_dev_name(blkg->q->disk->bdi);
534 * blkcg_print_blkgs - helper for printing per-blkg data
535 * @sf: seq_file to print to
536 * @blkcg: blkcg of interest
537 * @prfill: fill function to print out a blkg
538 * @pol: policy in question
539 * @data: data to be passed to @prfill
540 * @show_total: to print out sum of prfill return values or not
542 * This function invokes @prfill on each blkg of @blkcg if pd for the
543 * policy specified by @pol exists. @prfill is invoked with @sf, the
544 * policy data and @data and the matching queue lock held. If @show_total
545 * is %true, the sum of the return values from @prfill is printed with
546 * "Total" label at the end.
548 * This is to be used to construct print functions for
549 * cftype->read_seq_string method.
551 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
552 u64 (*prfill)(struct seq_file *,
553 struct blkg_policy_data *, int),
554 const struct blkcg_policy *pol, int data,
557 struct blkcg_gq *blkg;
561 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
562 spin_lock_irq(&blkg->q->queue_lock);
563 if (blkcg_policy_enabled(blkg->q, pol))
564 total += prfill(sf, blkg->pd[pol->plid], data);
565 spin_unlock_irq(&blkg->q->queue_lock);
570 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
572 EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
575 * __blkg_prfill_u64 - prfill helper for a single u64 value
576 * @sf: seq_file to print to
577 * @pd: policy private data of interest
580 * Print @v to @sf for the device assocaited with @pd.
582 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
584 const char *dname = blkg_dev_name(pd->blkg);
589 seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
592 EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
595 * blkcg_conf_open_bdev - parse and open bdev for per-blkg config update
596 * @inputp: input string pointer
598 * Parse the device node prefix part, MAJ:MIN, of per-blkg config update
599 * from @input and get and return the matching bdev. *@inputp is
600 * updated to point past the device node prefix. Returns an ERR_PTR()
603 * Use this function iff blkg_conf_prep() can't be used for some reason.
605 struct block_device *blkcg_conf_open_bdev(char **inputp)
607 char *input = *inputp;
608 unsigned int major, minor;
609 struct block_device *bdev;
612 if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
613 return ERR_PTR(-EINVAL);
616 if (!isspace(*input))
617 return ERR_PTR(-EINVAL);
618 input = skip_spaces(input);
620 bdev = blkdev_get_no_open(MKDEV(major, minor));
622 return ERR_PTR(-ENODEV);
623 if (bdev_is_partition(bdev)) {
624 blkdev_put_no_open(bdev);
625 return ERR_PTR(-ENODEV);
633 * blkg_conf_prep - parse and prepare for per-blkg config update
634 * @blkcg: target block cgroup
635 * @pol: target policy
636 * @input: input string
637 * @ctx: blkg_conf_ctx to be filled
639 * Parse per-blkg config update from @input and initialize @ctx with the
640 * result. @ctx->blkg points to the blkg to be updated and @ctx->body the
641 * part of @input following MAJ:MIN. This function returns with RCU read
642 * lock and queue lock held and must be paired with blkg_conf_finish().
644 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
645 char *input, struct blkg_conf_ctx *ctx)
646 __acquires(rcu) __acquires(&bdev->bd_queue->queue_lock)
648 struct block_device *bdev;
649 struct gendisk *disk;
650 struct request_queue *q;
651 struct blkcg_gq *blkg;
654 bdev = blkcg_conf_open_bdev(&input);
656 return PTR_ERR(bdev);
657 disk = bdev->bd_disk;
661 * blkcg_deactivate_policy() requires queue to be frozen, we can grab
662 * q_usage_counter to prevent concurrent with blkcg_deactivate_policy().
664 ret = blk_queue_enter(q, 0);
669 spin_lock_irq(&q->queue_lock);
671 if (!blkcg_policy_enabled(q, pol)) {
676 blkg = blkg_lookup(blkcg, q);
681 * Create blkgs walking down from blkcg_root to @blkcg, so that all
682 * non-root blkgs have access to their parents.
685 struct blkcg *pos = blkcg;
686 struct blkcg *parent;
687 struct blkcg_gq *new_blkg;
689 parent = blkcg_parent(blkcg);
690 while (parent && !blkg_lookup(parent, q)) {
692 parent = blkcg_parent(parent);
695 /* Drop locks to do new blkg allocation with GFP_KERNEL. */
696 spin_unlock_irq(&q->queue_lock);
699 new_blkg = blkg_alloc(pos, disk, GFP_KERNEL);
700 if (unlikely(!new_blkg)) {
702 goto fail_exit_queue;
705 if (radix_tree_preload(GFP_KERNEL)) {
708 goto fail_exit_queue;
712 spin_lock_irq(&q->queue_lock);
714 if (!blkcg_policy_enabled(q, pol)) {
720 blkg = blkg_lookup(pos, q);
724 blkg = blkg_create(pos, disk, new_blkg);
731 radix_tree_preload_end();
744 radix_tree_preload_end();
746 spin_unlock_irq(&q->queue_lock);
751 blkdev_put_no_open(bdev);
753 * If queue was bypassing, we should retry. Do so after a
754 * short msleep(). It isn't strictly necessary but queue
755 * can be bypassing for some time and it's always nice to
756 * avoid busy looping.
760 ret = restart_syscall();
764 EXPORT_SYMBOL_GPL(blkg_conf_prep);
767 * blkg_conf_finish - finish up per-blkg config update
768 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
770 * Finish up after per-blkg config update. This function must be paired
771 * with blkg_conf_prep().
773 void blkg_conf_finish(struct blkg_conf_ctx *ctx)
774 __releases(&ctx->bdev->bd_queue->queue_lock) __releases(rcu)
776 spin_unlock_irq(&bdev_get_queue(ctx->bdev)->queue_lock);
778 blkdev_put_no_open(ctx->bdev);
780 EXPORT_SYMBOL_GPL(blkg_conf_finish);
782 static void blkg_iostat_set(struct blkg_iostat *dst, struct blkg_iostat *src)
786 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
787 dst->bytes[i] = src->bytes[i];
788 dst->ios[i] = src->ios[i];
792 static void blkg_iostat_add(struct blkg_iostat *dst, struct blkg_iostat *src)
796 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
797 dst->bytes[i] += src->bytes[i];
798 dst->ios[i] += src->ios[i];
802 static void blkg_iostat_sub(struct blkg_iostat *dst, struct blkg_iostat *src)
806 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
807 dst->bytes[i] -= src->bytes[i];
808 dst->ios[i] -= src->ios[i];
812 static void blkcg_iostat_update(struct blkcg_gq *blkg, struct blkg_iostat *cur,
813 struct blkg_iostat *last)
815 struct blkg_iostat delta;
818 /* propagate percpu delta to global */
819 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
820 blkg_iostat_set(&delta, cur);
821 blkg_iostat_sub(&delta, last);
822 blkg_iostat_add(&blkg->iostat.cur, &delta);
823 blkg_iostat_add(last, &delta);
824 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
827 static void blkcg_rstat_flush(struct cgroup_subsys_state *css, int cpu)
829 struct blkcg *blkcg = css_to_blkcg(css);
830 struct blkcg_gq *blkg;
832 /* Root-level stats are sourced from system-wide IO stats */
833 if (!cgroup_parent(css->cgroup))
838 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
839 struct blkcg_gq *parent = blkg->parent;
840 struct blkg_iostat_set *bisc = per_cpu_ptr(blkg->iostat_cpu, cpu);
841 struct blkg_iostat cur;
844 /* fetch the current per-cpu values */
846 seq = u64_stats_fetch_begin(&bisc->sync);
847 blkg_iostat_set(&cur, &bisc->cur);
848 } while (u64_stats_fetch_retry(&bisc->sync, seq));
850 blkcg_iostat_update(blkg, &cur, &bisc->last);
852 /* propagate global delta to parent (unless that's root) */
853 if (parent && parent->parent)
854 blkcg_iostat_update(parent, &blkg->iostat.cur,
862 * We source root cgroup stats from the system-wide stats to avoid
863 * tracking the same information twice and incurring overhead when no
864 * cgroups are defined. For that reason, cgroup_rstat_flush in
865 * blkcg_print_stat does not actually fill out the iostat in the root
868 * However, we would like to re-use the printing code between the root and
869 * non-root cgroups to the extent possible. For that reason, we simulate
870 * flushing the root cgroup's stats by explicitly filling in the iostat
871 * with disk level statistics.
873 static void blkcg_fill_root_iostats(void)
875 struct class_dev_iter iter;
878 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
879 while ((dev = class_dev_iter_next(&iter))) {
880 struct block_device *bdev = dev_to_bdev(dev);
881 struct blkcg_gq *blkg = bdev->bd_disk->queue->root_blkg;
882 struct blkg_iostat tmp;
886 memset(&tmp, 0, sizeof(tmp));
887 for_each_possible_cpu(cpu) {
888 struct disk_stats *cpu_dkstats;
890 cpu_dkstats = per_cpu_ptr(bdev->bd_stats, cpu);
891 tmp.ios[BLKG_IOSTAT_READ] +=
892 cpu_dkstats->ios[STAT_READ];
893 tmp.ios[BLKG_IOSTAT_WRITE] +=
894 cpu_dkstats->ios[STAT_WRITE];
895 tmp.ios[BLKG_IOSTAT_DISCARD] +=
896 cpu_dkstats->ios[STAT_DISCARD];
897 // convert sectors to bytes
898 tmp.bytes[BLKG_IOSTAT_READ] +=
899 cpu_dkstats->sectors[STAT_READ] << 9;
900 tmp.bytes[BLKG_IOSTAT_WRITE] +=
901 cpu_dkstats->sectors[STAT_WRITE] << 9;
902 tmp.bytes[BLKG_IOSTAT_DISCARD] +=
903 cpu_dkstats->sectors[STAT_DISCARD] << 9;
906 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
907 blkg_iostat_set(&blkg->iostat.cur, &tmp);
908 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
912 static void blkcg_print_one_stat(struct blkcg_gq *blkg, struct seq_file *s)
914 struct blkg_iostat_set *bis = &blkg->iostat;
915 u64 rbytes, wbytes, rios, wios, dbytes, dios;
923 dname = blkg_dev_name(blkg);
927 seq_printf(s, "%s ", dname);
930 seq = u64_stats_fetch_begin(&bis->sync);
932 rbytes = bis->cur.bytes[BLKG_IOSTAT_READ];
933 wbytes = bis->cur.bytes[BLKG_IOSTAT_WRITE];
934 dbytes = bis->cur.bytes[BLKG_IOSTAT_DISCARD];
935 rios = bis->cur.ios[BLKG_IOSTAT_READ];
936 wios = bis->cur.ios[BLKG_IOSTAT_WRITE];
937 dios = bis->cur.ios[BLKG_IOSTAT_DISCARD];
938 } while (u64_stats_fetch_retry(&bis->sync, seq));
940 if (rbytes || wbytes || rios || wios) {
941 seq_printf(s, "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
942 rbytes, wbytes, rios, wios,
946 if (blkcg_debug_stats && atomic_read(&blkg->use_delay)) {
947 seq_printf(s, " use_delay=%d delay_nsec=%llu",
948 atomic_read(&blkg->use_delay),
949 atomic64_read(&blkg->delay_nsec));
952 for (i = 0; i < BLKCG_MAX_POLS; i++) {
953 struct blkcg_policy *pol = blkcg_policy[i];
955 if (!blkg->pd[i] || !pol->pd_stat_fn)
958 pol->pd_stat_fn(blkg->pd[i], s);
964 static int blkcg_print_stat(struct seq_file *sf, void *v)
966 struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
967 struct blkcg_gq *blkg;
969 if (!seq_css(sf)->parent)
970 blkcg_fill_root_iostats();
972 cgroup_rstat_flush(blkcg->css.cgroup);
975 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
976 spin_lock_irq(&blkg->q->queue_lock);
977 blkcg_print_one_stat(blkg, sf);
978 spin_unlock_irq(&blkg->q->queue_lock);
984 static struct cftype blkcg_files[] = {
987 .seq_show = blkcg_print_stat,
992 static struct cftype blkcg_legacy_files[] = {
994 .name = "reset_stats",
995 .write_u64 = blkcg_reset_stats,
1000 #ifdef CONFIG_CGROUP_WRITEBACK
1001 struct list_head *blkcg_get_cgwb_list(struct cgroup_subsys_state *css)
1003 return &css_to_blkcg(css)->cgwb_list;
1008 * blkcg destruction is a three-stage process.
1010 * 1. Destruction starts. The blkcg_css_offline() callback is invoked
1011 * which offlines writeback. Here we tie the next stage of blkg destruction
1012 * to the completion of writeback associated with the blkcg. This lets us
1013 * avoid punting potentially large amounts of outstanding writeback to root
1014 * while maintaining any ongoing policies. The next stage is triggered when
1015 * the nr_cgwbs count goes to zero.
1017 * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
1018 * and handles the destruction of blkgs. Here the css reference held by
1019 * the blkg is put back eventually allowing blkcg_css_free() to be called.
1020 * This work may occur in cgwb_release_workfn() on the cgwb_release
1021 * workqueue. Any submitted ios that fail to get the blkg ref will be
1022 * punted to the root_blkg.
1024 * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
1025 * This finally frees the blkcg.
1029 * blkcg_destroy_blkgs - responsible for shooting down blkgs
1030 * @blkcg: blkcg of interest
1032 * blkgs should be removed while holding both q and blkcg locks. As blkcg lock
1033 * is nested inside q lock, this function performs reverse double lock dancing.
1034 * Destroying the blkgs releases the reference held on the blkcg's css allowing
1035 * blkcg_css_free to eventually be called.
1037 * This is the blkcg counterpart of ioc_release_fn().
1039 static void blkcg_destroy_blkgs(struct blkcg *blkcg)
1043 spin_lock_irq(&blkcg->lock);
1045 while (!hlist_empty(&blkcg->blkg_list)) {
1046 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
1047 struct blkcg_gq, blkcg_node);
1048 struct request_queue *q = blkg->q;
1050 if (need_resched() || !spin_trylock(&q->queue_lock)) {
1052 * Given that the system can accumulate a huge number
1053 * of blkgs in pathological cases, check to see if we
1054 * need to rescheduling to avoid softlockup.
1056 spin_unlock_irq(&blkcg->lock);
1058 spin_lock_irq(&blkcg->lock);
1063 spin_unlock(&q->queue_lock);
1066 spin_unlock_irq(&blkcg->lock);
1070 * blkcg_pin_online - pin online state
1071 * @blkcg_css: blkcg of interest
1073 * While pinned, a blkcg is kept online. This is primarily used to
1074 * impedance-match blkg and cgwb lifetimes so that blkg doesn't go offline
1075 * while an associated cgwb is still active.
1077 void blkcg_pin_online(struct cgroup_subsys_state *blkcg_css)
1079 refcount_inc(&css_to_blkcg(blkcg_css)->online_pin);
1083 * blkcg_unpin_online - unpin online state
1084 * @blkcg_css: blkcg of interest
1086 * This is primarily used to impedance-match blkg and cgwb lifetimes so
1087 * that blkg doesn't go offline while an associated cgwb is still active.
1088 * When this count goes to zero, all active cgwbs have finished so the
1089 * blkcg can continue destruction by calling blkcg_destroy_blkgs().
1091 void blkcg_unpin_online(struct cgroup_subsys_state *blkcg_css)
1093 struct blkcg *blkcg = css_to_blkcg(blkcg_css);
1096 if (!refcount_dec_and_test(&blkcg->online_pin))
1098 blkcg_destroy_blkgs(blkcg);
1099 blkcg = blkcg_parent(blkcg);
1104 * blkcg_css_offline - cgroup css_offline callback
1105 * @css: css of interest
1107 * This function is called when @css is about to go away. Here the cgwbs are
1108 * offlined first and only once writeback associated with the blkcg has
1109 * finished do we start step 2 (see above).
1111 static void blkcg_css_offline(struct cgroup_subsys_state *css)
1113 /* this prevents anyone from attaching or migrating to this blkcg */
1114 wb_blkcg_offline(css);
1116 /* put the base online pin allowing step 2 to be triggered */
1117 blkcg_unpin_online(css);
1120 static void blkcg_css_free(struct cgroup_subsys_state *css)
1122 struct blkcg *blkcg = css_to_blkcg(css);
1125 mutex_lock(&blkcg_pol_mutex);
1127 list_del(&blkcg->all_blkcgs_node);
1129 for (i = 0; i < BLKCG_MAX_POLS; i++)
1131 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1133 mutex_unlock(&blkcg_pol_mutex);
1138 static struct cgroup_subsys_state *
1139 blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
1141 struct blkcg *blkcg;
1142 struct cgroup_subsys_state *ret;
1145 mutex_lock(&blkcg_pol_mutex);
1148 blkcg = &blkcg_root;
1150 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1152 ret = ERR_PTR(-ENOMEM);
1157 for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1158 struct blkcg_policy *pol = blkcg_policy[i];
1159 struct blkcg_policy_data *cpd;
1162 * If the policy hasn't been attached yet, wait for it
1163 * to be attached before doing anything else. Otherwise,
1164 * check if the policy requires any specific per-cgroup
1165 * data: if it does, allocate and initialize it.
1167 if (!pol || !pol->cpd_alloc_fn)
1170 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1172 ret = ERR_PTR(-ENOMEM);
1175 blkcg->cpd[i] = cpd;
1178 if (pol->cpd_init_fn)
1179 pol->cpd_init_fn(cpd);
1182 spin_lock_init(&blkcg->lock);
1183 refcount_set(&blkcg->online_pin, 1);
1184 INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
1185 INIT_HLIST_HEAD(&blkcg->blkg_list);
1186 #ifdef CONFIG_CGROUP_WRITEBACK
1187 INIT_LIST_HEAD(&blkcg->cgwb_list);
1189 list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1191 mutex_unlock(&blkcg_pol_mutex);
1195 for (i--; i >= 0; i--)
1197 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1199 if (blkcg != &blkcg_root)
1202 mutex_unlock(&blkcg_pol_mutex);
1206 static int blkcg_css_online(struct cgroup_subsys_state *css)
1208 struct blkcg *parent = blkcg_parent(css_to_blkcg(css));
1211 * blkcg_pin_online() is used to delay blkcg offline so that blkgs
1212 * don't go offline while cgwbs are still active on them. Pin the
1213 * parent so that offline always happens towards the root.
1216 blkcg_pin_online(&parent->css);
1220 int blkcg_init_disk(struct gendisk *disk)
1222 struct request_queue *q = disk->queue;
1223 struct blkcg_gq *new_blkg, *blkg;
1227 INIT_LIST_HEAD(&q->blkg_list);
1229 new_blkg = blkg_alloc(&blkcg_root, disk, GFP_KERNEL);
1233 preloaded = !radix_tree_preload(GFP_KERNEL);
1235 /* Make sure the root blkg exists. */
1236 /* spin_lock_irq can serve as RCU read-side critical section. */
1237 spin_lock_irq(&q->queue_lock);
1238 blkg = blkg_create(&blkcg_root, disk, new_blkg);
1241 q->root_blkg = blkg;
1242 spin_unlock_irq(&q->queue_lock);
1245 radix_tree_preload_end();
1247 ret = blk_ioprio_init(disk);
1249 goto err_destroy_all;
1251 ret = blk_throtl_init(disk);
1253 goto err_ioprio_exit;
1255 ret = blk_iolatency_init(disk);
1257 goto err_throtl_exit;
1262 blk_throtl_exit(disk);
1264 blk_ioprio_exit(disk);
1266 blkg_destroy_all(disk);
1269 spin_unlock_irq(&q->queue_lock);
1271 radix_tree_preload_end();
1272 return PTR_ERR(blkg);
1275 void blkcg_exit_disk(struct gendisk *disk)
1277 blkg_destroy_all(disk);
1278 blk_throtl_exit(disk);
1281 static void blkcg_bind(struct cgroup_subsys_state *root_css)
1285 mutex_lock(&blkcg_pol_mutex);
1287 for (i = 0; i < BLKCG_MAX_POLS; i++) {
1288 struct blkcg_policy *pol = blkcg_policy[i];
1289 struct blkcg *blkcg;
1291 if (!pol || !pol->cpd_bind_fn)
1294 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
1295 if (blkcg->cpd[pol->plid])
1296 pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
1298 mutex_unlock(&blkcg_pol_mutex);
1301 static void blkcg_exit(struct task_struct *tsk)
1303 if (tsk->throttle_queue)
1304 blk_put_queue(tsk->throttle_queue);
1305 tsk->throttle_queue = NULL;
1308 struct cgroup_subsys io_cgrp_subsys = {
1309 .css_alloc = blkcg_css_alloc,
1310 .css_online = blkcg_css_online,
1311 .css_offline = blkcg_css_offline,
1312 .css_free = blkcg_css_free,
1313 .css_rstat_flush = blkcg_rstat_flush,
1315 .dfl_cftypes = blkcg_files,
1316 .legacy_cftypes = blkcg_legacy_files,
1317 .legacy_name = "blkio",
1321 * This ensures that, if available, memcg is automatically enabled
1322 * together on the default hierarchy so that the owner cgroup can
1323 * be retrieved from writeback pages.
1325 .depends_on = 1 << memory_cgrp_id,
1328 EXPORT_SYMBOL_GPL(io_cgrp_subsys);
1331 * blkcg_activate_policy - activate a blkcg policy on a request_queue
1332 * @q: request_queue of interest
1333 * @pol: blkcg policy to activate
1335 * Activate @pol on @q. Requires %GFP_KERNEL context. @q goes through
1336 * bypass mode to populate its blkgs with policy_data for @pol.
1338 * Activation happens with @q bypassed, so nobody would be accessing blkgs
1339 * from IO path. Update of each blkg is protected by both queue and blkcg
1340 * locks so that holding either lock and testing blkcg_policy_enabled() is
1341 * always enough for dereferencing policy data.
1343 * The caller is responsible for synchronizing [de]activations and policy
1344 * [un]registerations. Returns 0 on success, -errno on failure.
1346 int blkcg_activate_policy(struct request_queue *q,
1347 const struct blkcg_policy *pol)
1349 struct blkg_policy_data *pd_prealloc = NULL;
1350 struct blkcg_gq *blkg, *pinned_blkg = NULL;
1353 if (blkcg_policy_enabled(q, pol))
1357 blk_mq_freeze_queue(q);
1359 spin_lock_irq(&q->queue_lock);
1361 /* blkg_list is pushed at the head, reverse walk to allocate parents first */
1362 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node) {
1363 struct blkg_policy_data *pd;
1365 if (blkg->pd[pol->plid])
1368 /* If prealloc matches, use it; otherwise try GFP_NOWAIT */
1369 if (blkg == pinned_blkg) {
1373 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q,
1379 * GFP_NOWAIT failed. Free the existing one and
1380 * prealloc for @blkg w/ GFP_KERNEL.
1383 blkg_put(pinned_blkg);
1387 spin_unlock_irq(&q->queue_lock);
1390 pol->pd_free_fn(pd_prealloc);
1391 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q,
1399 blkg->pd[pol->plid] = pd;
1401 pd->plid = pol->plid;
1404 /* all allocated, init in the same order */
1405 if (pol->pd_init_fn)
1406 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node)
1407 pol->pd_init_fn(blkg->pd[pol->plid]);
1409 __set_bit(pol->plid, q->blkcg_pols);
1412 spin_unlock_irq(&q->queue_lock);
1415 blk_mq_unfreeze_queue(q);
1417 blkg_put(pinned_blkg);
1419 pol->pd_free_fn(pd_prealloc);
1423 /* alloc failed, nothing's initialized yet, free everything */
1424 spin_lock_irq(&q->queue_lock);
1425 list_for_each_entry(blkg, &q->blkg_list, q_node) {
1426 struct blkcg *blkcg = blkg->blkcg;
1428 spin_lock(&blkcg->lock);
1429 if (blkg->pd[pol->plid]) {
1430 pol->pd_free_fn(blkg->pd[pol->plid]);
1431 blkg->pd[pol->plid] = NULL;
1433 spin_unlock(&blkcg->lock);
1435 spin_unlock_irq(&q->queue_lock);
1439 EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1442 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1443 * @q: request_queue of interest
1444 * @pol: blkcg policy to deactivate
1446 * Deactivate @pol on @q. Follows the same synchronization rules as
1447 * blkcg_activate_policy().
1449 void blkcg_deactivate_policy(struct request_queue *q,
1450 const struct blkcg_policy *pol)
1452 struct blkcg_gq *blkg;
1454 if (!blkcg_policy_enabled(q, pol))
1458 blk_mq_freeze_queue(q);
1460 spin_lock_irq(&q->queue_lock);
1462 __clear_bit(pol->plid, q->blkcg_pols);
1464 list_for_each_entry(blkg, &q->blkg_list, q_node) {
1465 struct blkcg *blkcg = blkg->blkcg;
1467 spin_lock(&blkcg->lock);
1468 if (blkg->pd[pol->plid]) {
1469 if (pol->pd_offline_fn)
1470 pol->pd_offline_fn(blkg->pd[pol->plid]);
1471 pol->pd_free_fn(blkg->pd[pol->plid]);
1472 blkg->pd[pol->plid] = NULL;
1474 spin_unlock(&blkcg->lock);
1477 spin_unlock_irq(&q->queue_lock);
1480 blk_mq_unfreeze_queue(q);
1482 EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1484 static void blkcg_free_all_cpd(struct blkcg_policy *pol)
1486 struct blkcg *blkcg;
1488 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1489 if (blkcg->cpd[pol->plid]) {
1490 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1491 blkcg->cpd[pol->plid] = NULL;
1497 * blkcg_policy_register - register a blkcg policy
1498 * @pol: blkcg policy to register
1500 * Register @pol with blkcg core. Might sleep and @pol may be modified on
1501 * successful registration. Returns 0 on success and -errno on failure.
1503 int blkcg_policy_register(struct blkcg_policy *pol)
1505 struct blkcg *blkcg;
1508 mutex_lock(&blkcg_pol_register_mutex);
1509 mutex_lock(&blkcg_pol_mutex);
1511 /* find an empty slot */
1513 for (i = 0; i < BLKCG_MAX_POLS; i++)
1514 if (!blkcg_policy[i])
1516 if (i >= BLKCG_MAX_POLS) {
1517 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
1521 /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1522 if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1523 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1528 blkcg_policy[pol->plid] = pol;
1530 /* allocate and install cpd's */
1531 if (pol->cpd_alloc_fn) {
1532 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1533 struct blkcg_policy_data *cpd;
1535 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1539 blkcg->cpd[pol->plid] = cpd;
1541 cpd->plid = pol->plid;
1542 if (pol->cpd_init_fn)
1543 pol->cpd_init_fn(cpd);
1547 mutex_unlock(&blkcg_pol_mutex);
1549 /* everything is in place, add intf files for the new policy */
1550 if (pol->dfl_cftypes)
1551 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1553 if (pol->legacy_cftypes)
1554 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
1555 pol->legacy_cftypes));
1556 mutex_unlock(&blkcg_pol_register_mutex);
1560 if (pol->cpd_free_fn)
1561 blkcg_free_all_cpd(pol);
1563 blkcg_policy[pol->plid] = NULL;
1565 mutex_unlock(&blkcg_pol_mutex);
1566 mutex_unlock(&blkcg_pol_register_mutex);
1569 EXPORT_SYMBOL_GPL(blkcg_policy_register);
1572 * blkcg_policy_unregister - unregister a blkcg policy
1573 * @pol: blkcg policy to unregister
1575 * Undo blkcg_policy_register(@pol). Might sleep.
1577 void blkcg_policy_unregister(struct blkcg_policy *pol)
1579 mutex_lock(&blkcg_pol_register_mutex);
1581 if (WARN_ON(blkcg_policy[pol->plid] != pol))
1584 /* kill the intf files first */
1585 if (pol->dfl_cftypes)
1586 cgroup_rm_cftypes(pol->dfl_cftypes);
1587 if (pol->legacy_cftypes)
1588 cgroup_rm_cftypes(pol->legacy_cftypes);
1590 /* remove cpds and unregister */
1591 mutex_lock(&blkcg_pol_mutex);
1593 if (pol->cpd_free_fn)
1594 blkcg_free_all_cpd(pol);
1596 blkcg_policy[pol->plid] = NULL;
1598 mutex_unlock(&blkcg_pol_mutex);
1600 mutex_unlock(&blkcg_pol_register_mutex);
1602 EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
1604 bool __blkcg_punt_bio_submit(struct bio *bio)
1606 struct blkcg_gq *blkg = bio->bi_blkg;
1608 /* consume the flag first */
1609 bio->bi_opf &= ~REQ_CGROUP_PUNT;
1611 /* never bounce for the root cgroup */
1615 spin_lock_bh(&blkg->async_bio_lock);
1616 bio_list_add(&blkg->async_bios, bio);
1617 spin_unlock_bh(&blkg->async_bio_lock);
1619 queue_work(blkcg_punt_bio_wq, &blkg->async_bio_work);
1624 * Scale the accumulated delay based on how long it has been since we updated
1625 * the delay. We only call this when we are adding delay, in case it's been a
1626 * while since we added delay, and when we are checking to see if we need to
1627 * delay a task, to account for any delays that may have occurred.
1629 static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1631 u64 old = atomic64_read(&blkg->delay_start);
1633 /* negative use_delay means no scaling, see blkcg_set_delay() */
1634 if (atomic_read(&blkg->use_delay) < 0)
1638 * We only want to scale down every second. The idea here is that we
1639 * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1640 * time window. We only want to throttle tasks for recent delay that
1641 * has occurred, in 1 second time windows since that's the maximum
1642 * things can be throttled. We save the current delay window in
1643 * blkg->last_delay so we know what amount is still left to be charged
1644 * to the blkg from this point onward. blkg->last_use keeps track of
1645 * the use_delay counter. The idea is if we're unthrottling the blkg we
1646 * are ok with whatever is happening now, and we can take away more of
1647 * the accumulated delay as we've already throttled enough that
1648 * everybody is happy with their IO latencies.
1650 if (time_before64(old + NSEC_PER_SEC, now) &&
1651 atomic64_try_cmpxchg(&blkg->delay_start, &old, now)) {
1652 u64 cur = atomic64_read(&blkg->delay_nsec);
1653 u64 sub = min_t(u64, blkg->last_delay, now - old);
1654 int cur_use = atomic_read(&blkg->use_delay);
1657 * We've been unthrottled, subtract a larger chunk of our
1658 * accumulated delay.
1660 if (cur_use < blkg->last_use)
1661 sub = max_t(u64, sub, blkg->last_delay >> 1);
1664 * This shouldn't happen, but handle it anyway. Our delay_nsec
1665 * should only ever be growing except here where we subtract out
1666 * min(last_delay, 1 second), but lord knows bugs happen and I'd
1667 * rather not end up with negative numbers.
1669 if (unlikely(cur < sub)) {
1670 atomic64_set(&blkg->delay_nsec, 0);
1671 blkg->last_delay = 0;
1673 atomic64_sub(sub, &blkg->delay_nsec);
1674 blkg->last_delay = cur - sub;
1676 blkg->last_use = cur_use;
1681 * This is called when we want to actually walk up the hierarchy and check to
1682 * see if we need to throttle, and then actually throttle if there is some
1683 * accumulated delay. This should only be called upon return to user space so
1684 * we're not holding some lock that would induce a priority inversion.
1686 static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1688 unsigned long pflags;
1690 u64 now = ktime_to_ns(ktime_get());
1695 while (blkg->parent) {
1696 int use_delay = atomic_read(&blkg->use_delay);
1701 blkcg_scale_delay(blkg, now);
1702 this_delay = atomic64_read(&blkg->delay_nsec);
1703 if (this_delay > delay_nsec) {
1704 delay_nsec = this_delay;
1705 clamp = use_delay > 0;
1708 blkg = blkg->parent;
1715 * Let's not sleep for all eternity if we've amassed a huge delay.
1716 * Swapping or metadata IO can accumulate 10's of seconds worth of
1717 * delay, and we want userspace to be able to do _something_ so cap the
1718 * delays at 0.25s. If there's 10's of seconds worth of delay then the
1719 * tasks will be delayed for 0.25 second for every syscall. If
1720 * blkcg_set_delay() was used as indicated by negative use_delay, the
1721 * caller is responsible for regulating the range.
1724 delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
1727 psi_memstall_enter(&pflags);
1729 exp = ktime_add_ns(now, delay_nsec);
1730 tok = io_schedule_prepare();
1732 __set_current_state(TASK_KILLABLE);
1733 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1735 } while (!fatal_signal_pending(current));
1736 io_schedule_finish(tok);
1739 psi_memstall_leave(&pflags);
1743 * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1745 * This is only called if we've been marked with set_notify_resume(). Obviously
1746 * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1747 * check to see if current->throttle_queue is set and if not this doesn't do
1748 * anything. This should only ever be called by the resume code, it's not meant
1749 * to be called by people willy-nilly as it will actually do the work to
1750 * throttle the task if it is setup for throttling.
1752 void blkcg_maybe_throttle_current(void)
1754 struct request_queue *q = current->throttle_queue;
1755 struct blkcg *blkcg;
1756 struct blkcg_gq *blkg;
1757 bool use_memdelay = current->use_memdelay;
1762 current->throttle_queue = NULL;
1763 current->use_memdelay = false;
1766 blkcg = css_to_blkcg(blkcg_css());
1769 blkg = blkg_lookup(blkcg, q);
1772 if (!blkg_tryget(blkg))
1776 blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1786 * blkcg_schedule_throttle - this task needs to check for throttling
1787 * @gendisk: disk to throttle
1788 * @use_memdelay: do we charge this to memory delay for PSI
1790 * This is called by the IO controller when we know there's delay accumulated
1791 * for the blkg for this task. We do not pass the blkg because there are places
1792 * we call this that may not have that information, the swapping code for
1793 * instance will only have a block_device at that point. This set's the
1794 * notify_resume for the task to check and see if it requires throttling before
1795 * returning to user space.
1797 * We will only schedule once per syscall. You can call this over and over
1798 * again and it will only do the check once upon return to user space, and only
1799 * throttle once. If the task needs to be throttled again it'll need to be
1800 * re-set at the next time we see the task.
1802 void blkcg_schedule_throttle(struct gendisk *disk, bool use_memdelay)
1804 struct request_queue *q = disk->queue;
1806 if (unlikely(current->flags & PF_KTHREAD))
1809 if (current->throttle_queue != q) {
1810 if (!blk_get_queue(q))
1813 if (current->throttle_queue)
1814 blk_put_queue(current->throttle_queue);
1815 current->throttle_queue = q;
1819 current->use_memdelay = use_memdelay;
1820 set_notify_resume(current);
1824 * blkcg_add_delay - add delay to this blkg
1825 * @blkg: blkg of interest
1826 * @now: the current time in nanoseconds
1827 * @delta: how many nanoseconds of delay to add
1829 * Charge @delta to the blkg's current delay accumulation. This is used to
1830 * throttle tasks if an IO controller thinks we need more throttling.
1832 void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1834 if (WARN_ON_ONCE(atomic_read(&blkg->use_delay) < 0))
1836 blkcg_scale_delay(blkg, now);
1837 atomic64_add(delta, &blkg->delay_nsec);
1841 * blkg_tryget_closest - try and get a blkg ref on the closet blkg
1845 * As the failure mode here is to walk up the blkg tree, this ensure that the
1846 * blkg->parent pointers are always valid. This returns the blkg that it ended
1847 * up taking a reference on or %NULL if no reference was taken.
1849 static inline struct blkcg_gq *blkg_tryget_closest(struct bio *bio,
1850 struct cgroup_subsys_state *css)
1852 struct blkcg_gq *blkg, *ret_blkg = NULL;
1855 blkg = blkg_lookup_create(css_to_blkcg(css), bio->bi_bdev->bd_disk);
1857 if (blkg_tryget(blkg)) {
1861 blkg = blkg->parent;
1869 * bio_associate_blkg_from_css - associate a bio with a specified css
1873 * Associate @bio with the blkg found by combining the css's blkg and the
1874 * request_queue of the @bio. An association failure is handled by walking up
1875 * the blkg tree. Therefore, the blkg associated can be anything between @blkg
1876 * and q->root_blkg. This situation only happens when a cgroup is dying and
1877 * then the remaining bios will spill to the closest alive blkg.
1879 * A reference will be taken on the blkg and will be released when @bio is
1882 void bio_associate_blkg_from_css(struct bio *bio,
1883 struct cgroup_subsys_state *css)
1886 blkg_put(bio->bi_blkg);
1888 if (css && css->parent) {
1889 bio->bi_blkg = blkg_tryget_closest(bio, css);
1891 blkg_get(bdev_get_queue(bio->bi_bdev)->root_blkg);
1892 bio->bi_blkg = bdev_get_queue(bio->bi_bdev)->root_blkg;
1895 EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
1898 * bio_associate_blkg - associate a bio with a blkg
1901 * Associate @bio with the blkg found from the bio's css and request_queue.
1902 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
1903 * already associated, the css is reused and association redone as the
1904 * request_queue may have changed.
1906 void bio_associate_blkg(struct bio *bio)
1908 struct cgroup_subsys_state *css;
1913 css = bio_blkcg_css(bio);
1917 bio_associate_blkg_from_css(bio, css);
1921 EXPORT_SYMBOL_GPL(bio_associate_blkg);
1924 * bio_clone_blkg_association - clone blkg association from src to dst bio
1925 * @dst: destination bio
1928 void bio_clone_blkg_association(struct bio *dst, struct bio *src)
1931 bio_associate_blkg_from_css(dst, bio_blkcg_css(src));
1933 EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
1935 static int blk_cgroup_io_type(struct bio *bio)
1937 if (op_is_discard(bio->bi_opf))
1938 return BLKG_IOSTAT_DISCARD;
1939 if (op_is_write(bio->bi_opf))
1940 return BLKG_IOSTAT_WRITE;
1941 return BLKG_IOSTAT_READ;
1944 void blk_cgroup_bio_start(struct bio *bio)
1946 int rwd = blk_cgroup_io_type(bio), cpu;
1947 struct blkg_iostat_set *bis;
1948 unsigned long flags;
1951 bis = per_cpu_ptr(bio->bi_blkg->iostat_cpu, cpu);
1952 flags = u64_stats_update_begin_irqsave(&bis->sync);
1955 * If the bio is flagged with BIO_CGROUP_ACCT it means this is a split
1956 * bio and we would have already accounted for the size of the bio.
1958 if (!bio_flagged(bio, BIO_CGROUP_ACCT)) {
1959 bio_set_flag(bio, BIO_CGROUP_ACCT);
1960 bis->cur.bytes[rwd] += bio->bi_iter.bi_size;
1962 bis->cur.ios[rwd]++;
1964 u64_stats_update_end_irqrestore(&bis->sync, flags);
1965 if (cgroup_subsys_on_dfl(io_cgrp_subsys))
1966 cgroup_rstat_updated(bio->bi_blkg->blkcg->css.cgroup, cpu);
1970 bool blk_cgroup_congested(void)
1972 struct cgroup_subsys_state *css;
1976 for (css = blkcg_css(); css; css = css->parent) {
1977 if (atomic_read(&css->cgroup->congestion_count)) {
1986 static int __init blkcg_init(void)
1988 blkcg_punt_bio_wq = alloc_workqueue("blkcg_punt_bio",
1989 WQ_MEM_RECLAIM | WQ_FREEZABLE |
1990 WQ_UNBOUND | WQ_SYSFS, 0);
1991 if (!blkcg_punt_bio_wq)
1995 subsys_initcall(blkcg_init);
1997 module_param(blkcg_debug_stats, bool, 0644);
1998 MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");