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"
36 #include "blk-rq-qos.h"
39 * blkcg_pol_mutex protects blkcg_policy[] and policy [de]activation.
40 * blkcg_pol_register_mutex nests outside of it and synchronizes entire
41 * policy [un]register operations including cgroup file additions /
42 * removals. Putting cgroup file registration outside blkcg_pol_mutex
43 * allows grabbing it from cgroup callbacks.
45 static DEFINE_MUTEX(blkcg_pol_register_mutex);
46 static DEFINE_MUTEX(blkcg_pol_mutex);
48 struct blkcg blkcg_root;
49 EXPORT_SYMBOL_GPL(blkcg_root);
51 struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;
52 EXPORT_SYMBOL_GPL(blkcg_root_css);
54 static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
56 static LIST_HEAD(all_blkcgs); /* protected by blkcg_pol_mutex */
58 bool blkcg_debug_stats = false;
59 static struct workqueue_struct *blkcg_punt_bio_wq;
61 #define BLKG_DESTROY_BATCH_SIZE 64
64 * blkcg_css - find the current css
66 * Find the css associated with either the kthread or the current task.
67 * This may return a dying css, so it is up to the caller to use tryget logic
68 * to confirm it is alive and well.
70 static struct cgroup_subsys_state *blkcg_css(void)
72 struct cgroup_subsys_state *css;
74 css = kthread_blkcg();
77 return task_css(current, io_cgrp_id);
80 static bool blkcg_policy_enabled(struct request_queue *q,
81 const struct blkcg_policy *pol)
83 return pol && test_bit(pol->plid, q->blkcg_pols);
86 static void blkg_free_workfn(struct work_struct *work)
88 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
92 for (i = 0; i < BLKCG_MAX_POLS; i++)
94 blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
97 blk_put_queue(blkg->q);
98 free_percpu(blkg->iostat_cpu);
99 percpu_ref_exit(&blkg->refcnt);
104 * blkg_free - free a blkg
105 * @blkg: blkg to free
107 * Free @blkg which may be partially allocated.
109 static void blkg_free(struct blkcg_gq *blkg)
115 * Both ->pd_free_fn() and request queue's release handler may
116 * sleep, so free us by scheduling one work func
118 INIT_WORK(&blkg->free_work, blkg_free_workfn);
119 schedule_work(&blkg->free_work);
122 static void __blkg_release(struct rcu_head *rcu)
124 struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);
126 WARN_ON(!bio_list_empty(&blkg->async_bios));
128 /* release the blkcg and parent blkg refs this blkg has been holding */
129 css_put(&blkg->blkcg->css);
131 blkg_put(blkg->parent);
136 * A group is RCU protected, but having an rcu lock does not mean that one
137 * can access all the fields of blkg and assume these are valid. For
138 * example, don't try to follow throtl_data and request queue links.
140 * Having a reference to blkg under an rcu allows accesses to only values
141 * local to groups like group stats and group rate limits.
143 static void blkg_release(struct percpu_ref *ref)
145 struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);
147 call_rcu(&blkg->rcu_head, __blkg_release);
150 static void blkg_async_bio_workfn(struct work_struct *work)
152 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
154 struct bio_list bios = BIO_EMPTY_LIST;
156 struct blk_plug plug;
157 bool need_plug = false;
159 /* as long as there are pending bios, @blkg can't go away */
160 spin_lock_bh(&blkg->async_bio_lock);
161 bio_list_merge(&bios, &blkg->async_bios);
162 bio_list_init(&blkg->async_bios);
163 spin_unlock_bh(&blkg->async_bio_lock);
165 /* start plug only when bio_list contains at least 2 bios */
166 if (bios.head && bios.head->bi_next) {
168 blk_start_plug(&plug);
170 while ((bio = bio_list_pop(&bios)))
173 blk_finish_plug(&plug);
177 * bio_blkcg_css - return the blkcg CSS associated with a bio
180 * This returns the CSS for the blkcg associated with a bio, or %NULL if not
181 * associated. Callers are expected to either handle %NULL or know association
182 * has been done prior to calling this.
184 struct cgroup_subsys_state *bio_blkcg_css(struct bio *bio)
186 if (!bio || !bio->bi_blkg)
188 return &bio->bi_blkg->blkcg->css;
190 EXPORT_SYMBOL_GPL(bio_blkcg_css);
193 * blkcg_parent - get the parent of a blkcg
194 * @blkcg: blkcg of interest
196 * Return the parent blkcg of @blkcg. Can be called anytime.
198 static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
200 return css_to_blkcg(blkcg->css.parent);
204 * blkg_alloc - allocate a blkg
205 * @blkcg: block cgroup the new blkg is associated with
206 * @disk: gendisk the new blkg is associated with
207 * @gfp_mask: allocation mask to use
209 * Allocate a new blkg assocating @blkcg and @q.
211 static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct gendisk *disk,
214 struct blkcg_gq *blkg;
217 /* alloc and init base part */
218 blkg = kzalloc_node(sizeof(*blkg), gfp_mask, disk->queue->node);
222 if (percpu_ref_init(&blkg->refcnt, blkg_release, 0, gfp_mask))
225 blkg->iostat_cpu = alloc_percpu_gfp(struct blkg_iostat_set, gfp_mask);
226 if (!blkg->iostat_cpu)
229 if (!blk_get_queue(disk->queue))
232 blkg->q = disk->queue;
233 INIT_LIST_HEAD(&blkg->q_node);
234 spin_lock_init(&blkg->async_bio_lock);
235 bio_list_init(&blkg->async_bios);
236 INIT_WORK(&blkg->async_bio_work, blkg_async_bio_workfn);
239 u64_stats_init(&blkg->iostat.sync);
240 for_each_possible_cpu(cpu)
241 u64_stats_init(&per_cpu_ptr(blkg->iostat_cpu, cpu)->sync);
243 for (i = 0; i < BLKCG_MAX_POLS; i++) {
244 struct blkcg_policy *pol = blkcg_policy[i];
245 struct blkg_policy_data *pd;
247 if (!blkcg_policy_enabled(disk->queue, pol))
250 /* alloc per-policy data and attach it to blkg */
251 pd = pol->pd_alloc_fn(gfp_mask, disk->queue, blkcg);
268 * If @new_blkg is %NULL, this function tries to allocate a new one as
269 * necessary using %GFP_NOWAIT. @new_blkg is always consumed on return.
271 static struct blkcg_gq *blkg_create(struct blkcg *blkcg, struct gendisk *disk,
272 struct blkcg_gq *new_blkg)
274 struct blkcg_gq *blkg;
277 lockdep_assert_held(&disk->queue->queue_lock);
279 /* request_queue is dying, do not create/recreate a blkg */
280 if (blk_queue_dying(disk->queue)) {
285 /* blkg holds a reference to blkcg */
286 if (!css_tryget_online(&blkcg->css)) {
293 new_blkg = blkg_alloc(blkcg, disk, GFP_NOWAIT | __GFP_NOWARN);
294 if (unlikely(!new_blkg)) {
302 if (blkcg_parent(blkcg)) {
303 blkg->parent = blkg_lookup(blkcg_parent(blkcg), disk->queue);
304 if (WARN_ON_ONCE(!blkg->parent)) {
308 blkg_get(blkg->parent);
311 /* invoke per-policy init */
312 for (i = 0; i < BLKCG_MAX_POLS; i++) {
313 struct blkcg_policy *pol = blkcg_policy[i];
315 if (blkg->pd[i] && pol->pd_init_fn)
316 pol->pd_init_fn(blkg->pd[i]);
320 spin_lock(&blkcg->lock);
321 ret = radix_tree_insert(&blkcg->blkg_tree, disk->queue->id, blkg);
323 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
324 list_add(&blkg->q_node, &disk->queue->blkg_list);
326 for (i = 0; i < BLKCG_MAX_POLS; i++) {
327 struct blkcg_policy *pol = blkcg_policy[i];
329 if (blkg->pd[i] && pol->pd_online_fn)
330 pol->pd_online_fn(blkg->pd[i]);
334 spin_unlock(&blkcg->lock);
339 /* @blkg failed fully initialized, use the usual release path */
344 css_put(&blkcg->css);
351 * blkg_lookup_create - lookup blkg, try to create one if not there
352 * @blkcg: blkcg of interest
353 * @disk: gendisk of interest
355 * Lookup blkg for the @blkcg - @disk pair. If it doesn't exist, try to
356 * create one. blkg creation is performed recursively from blkcg_root such
357 * that all non-root blkg's have access to the parent blkg. This function
358 * should be called under RCU read lock and takes @disk->queue->queue_lock.
360 * Returns the blkg or the closest blkg if blkg_create() fails as it walks
363 static struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
364 struct gendisk *disk)
366 struct request_queue *q = disk->queue;
367 struct blkcg_gq *blkg;
370 WARN_ON_ONCE(!rcu_read_lock_held());
372 blkg = blkg_lookup(blkcg, q);
376 spin_lock_irqsave(&q->queue_lock, flags);
377 blkg = blkg_lookup(blkcg, q);
379 if (blkcg != &blkcg_root &&
380 blkg != rcu_dereference(blkcg->blkg_hint))
381 rcu_assign_pointer(blkcg->blkg_hint, blkg);
386 * Create blkgs walking down from blkcg_root to @blkcg, so that all
387 * non-root blkgs have access to their parents. Returns the closest
388 * blkg to the intended blkg should blkg_create() fail.
391 struct blkcg *pos = blkcg;
392 struct blkcg *parent = blkcg_parent(blkcg);
393 struct blkcg_gq *ret_blkg = q->root_blkg;
396 blkg = blkg_lookup(parent, q);
398 /* remember closest blkg */
403 parent = blkcg_parent(parent);
406 blkg = blkg_create(pos, disk, NULL);
416 spin_unlock_irqrestore(&q->queue_lock, flags);
420 static void blkg_destroy(struct blkcg_gq *blkg)
422 struct blkcg *blkcg = blkg->blkcg;
425 lockdep_assert_held(&blkg->q->queue_lock);
426 lockdep_assert_held(&blkcg->lock);
428 /* Something wrong if we are trying to remove same group twice */
429 WARN_ON_ONCE(list_empty(&blkg->q_node));
430 WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
432 for (i = 0; i < BLKCG_MAX_POLS; i++) {
433 struct blkcg_policy *pol = blkcg_policy[i];
435 if (blkg->pd[i] && pol->pd_offline_fn)
436 pol->pd_offline_fn(blkg->pd[i]);
439 blkg->online = false;
441 radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
442 list_del_init(&blkg->q_node);
443 hlist_del_init_rcu(&blkg->blkcg_node);
446 * Both setting lookup hint to and clearing it from @blkg are done
447 * under queue_lock. If it's not pointing to @blkg now, it never
448 * will. Hint assignment itself can race safely.
450 if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
451 rcu_assign_pointer(blkcg->blkg_hint, NULL);
454 * Put the reference taken at the time of creation so that when all
455 * queues are gone, group can be destroyed.
457 percpu_ref_kill(&blkg->refcnt);
460 static void blkg_destroy_all(struct gendisk *disk)
462 struct request_queue *q = disk->queue;
463 struct blkcg_gq *blkg, *n;
464 int count = BLKG_DESTROY_BATCH_SIZE;
467 spin_lock_irq(&q->queue_lock);
468 list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
469 struct blkcg *blkcg = blkg->blkcg;
471 if (hlist_unhashed(&blkg->blkcg_node))
474 spin_lock(&blkcg->lock);
476 spin_unlock(&blkcg->lock);
479 * in order to avoid holding the spin lock for too long, release
480 * it when a batch of blkgs are destroyed.
483 count = BLKG_DESTROY_BATCH_SIZE;
484 spin_unlock_irq(&q->queue_lock);
491 spin_unlock_irq(&q->queue_lock);
494 static int blkcg_reset_stats(struct cgroup_subsys_state *css,
495 struct cftype *cftype, u64 val)
497 struct blkcg *blkcg = css_to_blkcg(css);
498 struct blkcg_gq *blkg;
501 mutex_lock(&blkcg_pol_mutex);
502 spin_lock_irq(&blkcg->lock);
505 * Note that stat reset is racy - it doesn't synchronize against
506 * stat updates. This is a debug feature which shouldn't exist
507 * anyway. If you get hit by a race, retry.
509 hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
510 for_each_possible_cpu(cpu) {
511 struct blkg_iostat_set *bis =
512 per_cpu_ptr(blkg->iostat_cpu, cpu);
513 memset(bis, 0, sizeof(*bis));
515 memset(&blkg->iostat, 0, sizeof(blkg->iostat));
517 for (i = 0; i < BLKCG_MAX_POLS; i++) {
518 struct blkcg_policy *pol = blkcg_policy[i];
520 if (blkg->pd[i] && pol->pd_reset_stats_fn)
521 pol->pd_reset_stats_fn(blkg->pd[i]);
525 spin_unlock_irq(&blkcg->lock);
526 mutex_unlock(&blkcg_pol_mutex);
530 const char *blkg_dev_name(struct blkcg_gq *blkg)
532 if (!blkg->q->disk || !blkg->q->disk->bdi->dev)
534 return bdi_dev_name(blkg->q->disk->bdi);
538 * blkcg_print_blkgs - helper for printing per-blkg data
539 * @sf: seq_file to print to
540 * @blkcg: blkcg of interest
541 * @prfill: fill function to print out a blkg
542 * @pol: policy in question
543 * @data: data to be passed to @prfill
544 * @show_total: to print out sum of prfill return values or not
546 * This function invokes @prfill on each blkg of @blkcg if pd for the
547 * policy specified by @pol exists. @prfill is invoked with @sf, the
548 * policy data and @data and the matching queue lock held. If @show_total
549 * is %true, the sum of the return values from @prfill is printed with
550 * "Total" label at the end.
552 * This is to be used to construct print functions for
553 * cftype->read_seq_string method.
555 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
556 u64 (*prfill)(struct seq_file *,
557 struct blkg_policy_data *, int),
558 const struct blkcg_policy *pol, int data,
561 struct blkcg_gq *blkg;
565 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
566 spin_lock_irq(&blkg->q->queue_lock);
567 if (blkcg_policy_enabled(blkg->q, pol))
568 total += prfill(sf, blkg->pd[pol->plid], data);
569 spin_unlock_irq(&blkg->q->queue_lock);
574 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
576 EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
579 * __blkg_prfill_u64 - prfill helper for a single u64 value
580 * @sf: seq_file to print to
581 * @pd: policy private data of interest
584 * Print @v to @sf for the device assocaited with @pd.
586 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
588 const char *dname = blkg_dev_name(pd->blkg);
593 seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
596 EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
599 * blkcg_conf_open_bdev - parse and open bdev for per-blkg config update
600 * @inputp: input string pointer
602 * Parse the device node prefix part, MAJ:MIN, of per-blkg config update
603 * from @input and get and return the matching bdev. *@inputp is
604 * updated to point past the device node prefix. Returns an ERR_PTR()
607 * Use this function iff blkg_conf_prep() can't be used for some reason.
609 struct block_device *blkcg_conf_open_bdev(char **inputp)
611 char *input = *inputp;
612 unsigned int major, minor;
613 struct block_device *bdev;
616 if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
617 return ERR_PTR(-EINVAL);
620 if (!isspace(*input))
621 return ERR_PTR(-EINVAL);
622 input = skip_spaces(input);
624 bdev = blkdev_get_no_open(MKDEV(major, minor));
626 return ERR_PTR(-ENODEV);
627 if (bdev_is_partition(bdev)) {
628 blkdev_put_no_open(bdev);
629 return ERR_PTR(-ENODEV);
637 * blkg_conf_prep - parse and prepare for per-blkg config update
638 * @blkcg: target block cgroup
639 * @pol: target policy
640 * @input: input string
641 * @ctx: blkg_conf_ctx to be filled
643 * Parse per-blkg config update from @input and initialize @ctx with the
644 * result. @ctx->blkg points to the blkg to be updated and @ctx->body the
645 * part of @input following MAJ:MIN. This function returns with RCU read
646 * lock and queue lock held and must be paired with blkg_conf_finish().
648 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
649 char *input, struct blkg_conf_ctx *ctx)
650 __acquires(rcu) __acquires(&bdev->bd_queue->queue_lock)
652 struct block_device *bdev;
653 struct gendisk *disk;
654 struct request_queue *q;
655 struct blkcg_gq *blkg;
658 bdev = blkcg_conf_open_bdev(&input);
660 return PTR_ERR(bdev);
661 disk = bdev->bd_disk;
665 * blkcg_deactivate_policy() requires queue to be frozen, we can grab
666 * q_usage_counter to prevent concurrent with blkcg_deactivate_policy().
668 ret = blk_queue_enter(q, 0);
673 spin_lock_irq(&q->queue_lock);
675 if (!blkcg_policy_enabled(q, pol)) {
680 blkg = blkg_lookup(blkcg, q);
685 * Create blkgs walking down from blkcg_root to @blkcg, so that all
686 * non-root blkgs have access to their parents.
689 struct blkcg *pos = blkcg;
690 struct blkcg *parent;
691 struct blkcg_gq *new_blkg;
693 parent = blkcg_parent(blkcg);
694 while (parent && !blkg_lookup(parent, q)) {
696 parent = blkcg_parent(parent);
699 /* Drop locks to do new blkg allocation with GFP_KERNEL. */
700 spin_unlock_irq(&q->queue_lock);
703 new_blkg = blkg_alloc(pos, disk, GFP_KERNEL);
704 if (unlikely(!new_blkg)) {
706 goto fail_exit_queue;
709 if (radix_tree_preload(GFP_KERNEL)) {
712 goto fail_exit_queue;
716 spin_lock_irq(&q->queue_lock);
718 if (!blkcg_policy_enabled(q, pol)) {
724 blkg = blkg_lookup(pos, q);
728 blkg = blkg_create(pos, disk, new_blkg);
735 radix_tree_preload_end();
748 radix_tree_preload_end();
750 spin_unlock_irq(&q->queue_lock);
755 blkdev_put_no_open(bdev);
757 * If queue was bypassing, we should retry. Do so after a
758 * short msleep(). It isn't strictly necessary but queue
759 * can be bypassing for some time and it's always nice to
760 * avoid busy looping.
764 ret = restart_syscall();
768 EXPORT_SYMBOL_GPL(blkg_conf_prep);
771 * blkg_conf_finish - finish up per-blkg config update
772 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
774 * Finish up after per-blkg config update. This function must be paired
775 * with blkg_conf_prep().
777 void blkg_conf_finish(struct blkg_conf_ctx *ctx)
778 __releases(&ctx->bdev->bd_queue->queue_lock) __releases(rcu)
780 spin_unlock_irq(&bdev_get_queue(ctx->bdev)->queue_lock);
782 blkdev_put_no_open(ctx->bdev);
784 EXPORT_SYMBOL_GPL(blkg_conf_finish);
786 static void blkg_iostat_set(struct blkg_iostat *dst, struct blkg_iostat *src)
790 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
791 dst->bytes[i] = src->bytes[i];
792 dst->ios[i] = src->ios[i];
796 static void blkg_iostat_add(struct blkg_iostat *dst, struct blkg_iostat *src)
800 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
801 dst->bytes[i] += src->bytes[i];
802 dst->ios[i] += src->ios[i];
806 static void blkg_iostat_sub(struct blkg_iostat *dst, struct blkg_iostat *src)
810 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
811 dst->bytes[i] -= src->bytes[i];
812 dst->ios[i] -= src->ios[i];
816 static void blkcg_iostat_update(struct blkcg_gq *blkg, struct blkg_iostat *cur,
817 struct blkg_iostat *last)
819 struct blkg_iostat delta;
822 /* propagate percpu delta to global */
823 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
824 blkg_iostat_set(&delta, cur);
825 blkg_iostat_sub(&delta, last);
826 blkg_iostat_add(&blkg->iostat.cur, &delta);
827 blkg_iostat_add(last, &delta);
828 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
831 static void blkcg_rstat_flush(struct cgroup_subsys_state *css, int cpu)
833 struct blkcg *blkcg = css_to_blkcg(css);
834 struct blkcg_gq *blkg;
836 /* Root-level stats are sourced from system-wide IO stats */
837 if (!cgroup_parent(css->cgroup))
842 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
843 struct blkcg_gq *parent = blkg->parent;
844 struct blkg_iostat_set *bisc = per_cpu_ptr(blkg->iostat_cpu, cpu);
845 struct blkg_iostat cur;
848 /* fetch the current per-cpu values */
850 seq = u64_stats_fetch_begin(&bisc->sync);
851 blkg_iostat_set(&cur, &bisc->cur);
852 } while (u64_stats_fetch_retry(&bisc->sync, seq));
854 blkcg_iostat_update(blkg, &cur, &bisc->last);
856 /* propagate global delta to parent (unless that's root) */
857 if (parent && parent->parent)
858 blkcg_iostat_update(parent, &blkg->iostat.cur,
866 * We source root cgroup stats from the system-wide stats to avoid
867 * tracking the same information twice and incurring overhead when no
868 * cgroups are defined. For that reason, cgroup_rstat_flush in
869 * blkcg_print_stat does not actually fill out the iostat in the root
872 * However, we would like to re-use the printing code between the root and
873 * non-root cgroups to the extent possible. For that reason, we simulate
874 * flushing the root cgroup's stats by explicitly filling in the iostat
875 * with disk level statistics.
877 static void blkcg_fill_root_iostats(void)
879 struct class_dev_iter iter;
882 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
883 while ((dev = class_dev_iter_next(&iter))) {
884 struct block_device *bdev = dev_to_bdev(dev);
885 struct blkcg_gq *blkg = bdev->bd_disk->queue->root_blkg;
886 struct blkg_iostat tmp;
890 memset(&tmp, 0, sizeof(tmp));
891 for_each_possible_cpu(cpu) {
892 struct disk_stats *cpu_dkstats;
894 cpu_dkstats = per_cpu_ptr(bdev->bd_stats, cpu);
895 tmp.ios[BLKG_IOSTAT_READ] +=
896 cpu_dkstats->ios[STAT_READ];
897 tmp.ios[BLKG_IOSTAT_WRITE] +=
898 cpu_dkstats->ios[STAT_WRITE];
899 tmp.ios[BLKG_IOSTAT_DISCARD] +=
900 cpu_dkstats->ios[STAT_DISCARD];
901 // convert sectors to bytes
902 tmp.bytes[BLKG_IOSTAT_READ] +=
903 cpu_dkstats->sectors[STAT_READ] << 9;
904 tmp.bytes[BLKG_IOSTAT_WRITE] +=
905 cpu_dkstats->sectors[STAT_WRITE] << 9;
906 tmp.bytes[BLKG_IOSTAT_DISCARD] +=
907 cpu_dkstats->sectors[STAT_DISCARD] << 9;
910 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
911 blkg_iostat_set(&blkg->iostat.cur, &tmp);
912 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
916 static void blkcg_print_one_stat(struct blkcg_gq *blkg, struct seq_file *s)
918 struct blkg_iostat_set *bis = &blkg->iostat;
919 u64 rbytes, wbytes, rios, wios, dbytes, dios;
927 dname = blkg_dev_name(blkg);
931 seq_printf(s, "%s ", dname);
934 seq = u64_stats_fetch_begin(&bis->sync);
936 rbytes = bis->cur.bytes[BLKG_IOSTAT_READ];
937 wbytes = bis->cur.bytes[BLKG_IOSTAT_WRITE];
938 dbytes = bis->cur.bytes[BLKG_IOSTAT_DISCARD];
939 rios = bis->cur.ios[BLKG_IOSTAT_READ];
940 wios = bis->cur.ios[BLKG_IOSTAT_WRITE];
941 dios = bis->cur.ios[BLKG_IOSTAT_DISCARD];
942 } while (u64_stats_fetch_retry(&bis->sync, seq));
944 if (rbytes || wbytes || rios || wios) {
945 seq_printf(s, "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
946 rbytes, wbytes, rios, wios,
950 if (blkcg_debug_stats && atomic_read(&blkg->use_delay)) {
951 seq_printf(s, " use_delay=%d delay_nsec=%llu",
952 atomic_read(&blkg->use_delay),
953 atomic64_read(&blkg->delay_nsec));
956 for (i = 0; i < BLKCG_MAX_POLS; i++) {
957 struct blkcg_policy *pol = blkcg_policy[i];
959 if (!blkg->pd[i] || !pol->pd_stat_fn)
962 pol->pd_stat_fn(blkg->pd[i], s);
968 static int blkcg_print_stat(struct seq_file *sf, void *v)
970 struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
971 struct blkcg_gq *blkg;
973 if (!seq_css(sf)->parent)
974 blkcg_fill_root_iostats();
976 cgroup_rstat_flush(blkcg->css.cgroup);
979 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
980 spin_lock_irq(&blkg->q->queue_lock);
981 blkcg_print_one_stat(blkg, sf);
982 spin_unlock_irq(&blkg->q->queue_lock);
988 static struct cftype blkcg_files[] = {
991 .seq_show = blkcg_print_stat,
996 static struct cftype blkcg_legacy_files[] = {
998 .name = "reset_stats",
999 .write_u64 = blkcg_reset_stats,
1004 #ifdef CONFIG_CGROUP_WRITEBACK
1005 struct list_head *blkcg_get_cgwb_list(struct cgroup_subsys_state *css)
1007 return &css_to_blkcg(css)->cgwb_list;
1012 * blkcg destruction is a three-stage process.
1014 * 1. Destruction starts. The blkcg_css_offline() callback is invoked
1015 * which offlines writeback. Here we tie the next stage of blkg destruction
1016 * to the completion of writeback associated with the blkcg. This lets us
1017 * avoid punting potentially large amounts of outstanding writeback to root
1018 * while maintaining any ongoing policies. The next stage is triggered when
1019 * the nr_cgwbs count goes to zero.
1021 * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
1022 * and handles the destruction of blkgs. Here the css reference held by
1023 * the blkg is put back eventually allowing blkcg_css_free() to be called.
1024 * This work may occur in cgwb_release_workfn() on the cgwb_release
1025 * workqueue. Any submitted ios that fail to get the blkg ref will be
1026 * punted to the root_blkg.
1028 * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
1029 * This finally frees the blkcg.
1033 * blkcg_destroy_blkgs - responsible for shooting down blkgs
1034 * @blkcg: blkcg of interest
1036 * blkgs should be removed while holding both q and blkcg locks. As blkcg lock
1037 * is nested inside q lock, this function performs reverse double lock dancing.
1038 * Destroying the blkgs releases the reference held on the blkcg's css allowing
1039 * blkcg_css_free to eventually be called.
1041 * This is the blkcg counterpart of ioc_release_fn().
1043 static void blkcg_destroy_blkgs(struct blkcg *blkcg)
1047 spin_lock_irq(&blkcg->lock);
1049 while (!hlist_empty(&blkcg->blkg_list)) {
1050 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
1051 struct blkcg_gq, blkcg_node);
1052 struct request_queue *q = blkg->q;
1054 if (need_resched() || !spin_trylock(&q->queue_lock)) {
1056 * Given that the system can accumulate a huge number
1057 * of blkgs in pathological cases, check to see if we
1058 * need to rescheduling to avoid softlockup.
1060 spin_unlock_irq(&blkcg->lock);
1062 spin_lock_irq(&blkcg->lock);
1067 spin_unlock(&q->queue_lock);
1070 spin_unlock_irq(&blkcg->lock);
1074 * blkcg_pin_online - pin online state
1075 * @blkcg_css: blkcg of interest
1077 * While pinned, a blkcg is kept online. This is primarily used to
1078 * impedance-match blkg and cgwb lifetimes so that blkg doesn't go offline
1079 * while an associated cgwb is still active.
1081 void blkcg_pin_online(struct cgroup_subsys_state *blkcg_css)
1083 refcount_inc(&css_to_blkcg(blkcg_css)->online_pin);
1087 * blkcg_unpin_online - unpin online state
1088 * @blkcg_css: blkcg of interest
1090 * This is primarily used to impedance-match blkg and cgwb lifetimes so
1091 * that blkg doesn't go offline while an associated cgwb is still active.
1092 * When this count goes to zero, all active cgwbs have finished so the
1093 * blkcg can continue destruction by calling blkcg_destroy_blkgs().
1095 void blkcg_unpin_online(struct cgroup_subsys_state *blkcg_css)
1097 struct blkcg *blkcg = css_to_blkcg(blkcg_css);
1100 if (!refcount_dec_and_test(&blkcg->online_pin))
1102 blkcg_destroy_blkgs(blkcg);
1103 blkcg = blkcg_parent(blkcg);
1108 * blkcg_css_offline - cgroup css_offline callback
1109 * @css: css of interest
1111 * This function is called when @css is about to go away. Here the cgwbs are
1112 * offlined first and only once writeback associated with the blkcg has
1113 * finished do we start step 2 (see above).
1115 static void blkcg_css_offline(struct cgroup_subsys_state *css)
1117 /* this prevents anyone from attaching or migrating to this blkcg */
1118 wb_blkcg_offline(css);
1120 /* put the base online pin allowing step 2 to be triggered */
1121 blkcg_unpin_online(css);
1124 static void blkcg_css_free(struct cgroup_subsys_state *css)
1126 struct blkcg *blkcg = css_to_blkcg(css);
1129 mutex_lock(&blkcg_pol_mutex);
1131 list_del(&blkcg->all_blkcgs_node);
1133 for (i = 0; i < BLKCG_MAX_POLS; i++)
1135 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1137 mutex_unlock(&blkcg_pol_mutex);
1142 static struct cgroup_subsys_state *
1143 blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
1145 struct blkcg *blkcg;
1146 struct cgroup_subsys_state *ret;
1149 mutex_lock(&blkcg_pol_mutex);
1152 blkcg = &blkcg_root;
1154 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1156 ret = ERR_PTR(-ENOMEM);
1161 for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1162 struct blkcg_policy *pol = blkcg_policy[i];
1163 struct blkcg_policy_data *cpd;
1166 * If the policy hasn't been attached yet, wait for it
1167 * to be attached before doing anything else. Otherwise,
1168 * check if the policy requires any specific per-cgroup
1169 * data: if it does, allocate and initialize it.
1171 if (!pol || !pol->cpd_alloc_fn)
1174 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1176 ret = ERR_PTR(-ENOMEM);
1179 blkcg->cpd[i] = cpd;
1182 if (pol->cpd_init_fn)
1183 pol->cpd_init_fn(cpd);
1186 spin_lock_init(&blkcg->lock);
1187 refcount_set(&blkcg->online_pin, 1);
1188 INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
1189 INIT_HLIST_HEAD(&blkcg->blkg_list);
1190 #ifdef CONFIG_CGROUP_WRITEBACK
1191 INIT_LIST_HEAD(&blkcg->cgwb_list);
1193 list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1195 mutex_unlock(&blkcg_pol_mutex);
1199 for (i--; i >= 0; i--)
1201 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1203 if (blkcg != &blkcg_root)
1206 mutex_unlock(&blkcg_pol_mutex);
1210 static int blkcg_css_online(struct cgroup_subsys_state *css)
1212 struct blkcg *parent = blkcg_parent(css_to_blkcg(css));
1215 * blkcg_pin_online() is used to delay blkcg offline so that blkgs
1216 * don't go offline while cgwbs are still active on them. Pin the
1217 * parent so that offline always happens towards the root.
1220 blkcg_pin_online(&parent->css);
1224 int blkcg_init_disk(struct gendisk *disk)
1226 struct request_queue *q = disk->queue;
1227 struct blkcg_gq *new_blkg, *blkg;
1231 INIT_LIST_HEAD(&q->blkg_list);
1233 new_blkg = blkg_alloc(&blkcg_root, disk, GFP_KERNEL);
1237 preloaded = !radix_tree_preload(GFP_KERNEL);
1239 /* Make sure the root blkg exists. */
1240 /* spin_lock_irq can serve as RCU read-side critical section. */
1241 spin_lock_irq(&q->queue_lock);
1242 blkg = blkg_create(&blkcg_root, disk, new_blkg);
1245 q->root_blkg = blkg;
1246 spin_unlock_irq(&q->queue_lock);
1249 radix_tree_preload_end();
1251 ret = blk_ioprio_init(disk);
1253 goto err_destroy_all;
1255 ret = blk_throtl_init(disk);
1257 goto err_ioprio_exit;
1259 ret = blk_iolatency_init(disk);
1261 goto err_throtl_exit;
1266 blk_throtl_exit(disk);
1268 blk_ioprio_exit(disk);
1270 blkg_destroy_all(disk);
1273 spin_unlock_irq(&q->queue_lock);
1275 radix_tree_preload_end();
1276 return PTR_ERR(blkg);
1279 void blkcg_exit_disk(struct gendisk *disk)
1281 blkg_destroy_all(disk);
1282 rq_qos_exit(disk->queue);
1283 blk_throtl_exit(disk);
1286 static void blkcg_bind(struct cgroup_subsys_state *root_css)
1290 mutex_lock(&blkcg_pol_mutex);
1292 for (i = 0; i < BLKCG_MAX_POLS; i++) {
1293 struct blkcg_policy *pol = blkcg_policy[i];
1294 struct blkcg *blkcg;
1296 if (!pol || !pol->cpd_bind_fn)
1299 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
1300 if (blkcg->cpd[pol->plid])
1301 pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
1303 mutex_unlock(&blkcg_pol_mutex);
1306 static void blkcg_exit(struct task_struct *tsk)
1308 if (tsk->throttle_queue)
1309 blk_put_queue(tsk->throttle_queue);
1310 tsk->throttle_queue = NULL;
1313 struct cgroup_subsys io_cgrp_subsys = {
1314 .css_alloc = blkcg_css_alloc,
1315 .css_online = blkcg_css_online,
1316 .css_offline = blkcg_css_offline,
1317 .css_free = blkcg_css_free,
1318 .css_rstat_flush = blkcg_rstat_flush,
1320 .dfl_cftypes = blkcg_files,
1321 .legacy_cftypes = blkcg_legacy_files,
1322 .legacy_name = "blkio",
1326 * This ensures that, if available, memcg is automatically enabled
1327 * together on the default hierarchy so that the owner cgroup can
1328 * be retrieved from writeback pages.
1330 .depends_on = 1 << memory_cgrp_id,
1333 EXPORT_SYMBOL_GPL(io_cgrp_subsys);
1336 * blkcg_activate_policy - activate a blkcg policy on a request_queue
1337 * @q: request_queue of interest
1338 * @pol: blkcg policy to activate
1340 * Activate @pol on @q. Requires %GFP_KERNEL context. @q goes through
1341 * bypass mode to populate its blkgs with policy_data for @pol.
1343 * Activation happens with @q bypassed, so nobody would be accessing blkgs
1344 * from IO path. Update of each blkg is protected by both queue and blkcg
1345 * locks so that holding either lock and testing blkcg_policy_enabled() is
1346 * always enough for dereferencing policy data.
1348 * The caller is responsible for synchronizing [de]activations and policy
1349 * [un]registerations. Returns 0 on success, -errno on failure.
1351 int blkcg_activate_policy(struct request_queue *q,
1352 const struct blkcg_policy *pol)
1354 struct blkg_policy_data *pd_prealloc = NULL;
1355 struct blkcg_gq *blkg, *pinned_blkg = NULL;
1358 if (blkcg_policy_enabled(q, pol))
1362 blk_mq_freeze_queue(q);
1364 spin_lock_irq(&q->queue_lock);
1366 /* blkg_list is pushed at the head, reverse walk to allocate parents first */
1367 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node) {
1368 struct blkg_policy_data *pd;
1370 if (blkg->pd[pol->plid])
1373 /* If prealloc matches, use it; otherwise try GFP_NOWAIT */
1374 if (blkg == pinned_blkg) {
1378 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q,
1384 * GFP_NOWAIT failed. Free the existing one and
1385 * prealloc for @blkg w/ GFP_KERNEL.
1388 blkg_put(pinned_blkg);
1392 spin_unlock_irq(&q->queue_lock);
1395 pol->pd_free_fn(pd_prealloc);
1396 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q,
1404 blkg->pd[pol->plid] = pd;
1406 pd->plid = pol->plid;
1409 /* all allocated, init in the same order */
1410 if (pol->pd_init_fn)
1411 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node)
1412 pol->pd_init_fn(blkg->pd[pol->plid]);
1414 if (pol->pd_online_fn)
1415 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node)
1416 pol->pd_online_fn(blkg->pd[pol->plid]);
1418 __set_bit(pol->plid, q->blkcg_pols);
1421 spin_unlock_irq(&q->queue_lock);
1424 blk_mq_unfreeze_queue(q);
1426 blkg_put(pinned_blkg);
1428 pol->pd_free_fn(pd_prealloc);
1432 /* alloc failed, nothing's initialized yet, free everything */
1433 spin_lock_irq(&q->queue_lock);
1434 list_for_each_entry(blkg, &q->blkg_list, q_node) {
1435 struct blkcg *blkcg = blkg->blkcg;
1437 spin_lock(&blkcg->lock);
1438 if (blkg->pd[pol->plid]) {
1439 pol->pd_free_fn(blkg->pd[pol->plid]);
1440 blkg->pd[pol->plid] = NULL;
1442 spin_unlock(&blkcg->lock);
1444 spin_unlock_irq(&q->queue_lock);
1448 EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1451 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1452 * @q: request_queue of interest
1453 * @pol: blkcg policy to deactivate
1455 * Deactivate @pol on @q. Follows the same synchronization rules as
1456 * blkcg_activate_policy().
1458 void blkcg_deactivate_policy(struct request_queue *q,
1459 const struct blkcg_policy *pol)
1461 struct blkcg_gq *blkg;
1463 if (!blkcg_policy_enabled(q, pol))
1467 blk_mq_freeze_queue(q);
1469 spin_lock_irq(&q->queue_lock);
1471 __clear_bit(pol->plid, q->blkcg_pols);
1473 list_for_each_entry(blkg, &q->blkg_list, q_node) {
1474 struct blkcg *blkcg = blkg->blkcg;
1476 spin_lock(&blkcg->lock);
1477 if (blkg->pd[pol->plid]) {
1478 if (pol->pd_offline_fn)
1479 pol->pd_offline_fn(blkg->pd[pol->plid]);
1480 pol->pd_free_fn(blkg->pd[pol->plid]);
1481 blkg->pd[pol->plid] = NULL;
1483 spin_unlock(&blkcg->lock);
1486 spin_unlock_irq(&q->queue_lock);
1489 blk_mq_unfreeze_queue(q);
1491 EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1493 static void blkcg_free_all_cpd(struct blkcg_policy *pol)
1495 struct blkcg *blkcg;
1497 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1498 if (blkcg->cpd[pol->plid]) {
1499 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1500 blkcg->cpd[pol->plid] = NULL;
1506 * blkcg_policy_register - register a blkcg policy
1507 * @pol: blkcg policy to register
1509 * Register @pol with blkcg core. Might sleep and @pol may be modified on
1510 * successful registration. Returns 0 on success and -errno on failure.
1512 int blkcg_policy_register(struct blkcg_policy *pol)
1514 struct blkcg *blkcg;
1517 mutex_lock(&blkcg_pol_register_mutex);
1518 mutex_lock(&blkcg_pol_mutex);
1520 /* find an empty slot */
1522 for (i = 0; i < BLKCG_MAX_POLS; i++)
1523 if (!blkcg_policy[i])
1525 if (i >= BLKCG_MAX_POLS) {
1526 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
1530 /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1531 if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1532 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1537 blkcg_policy[pol->plid] = pol;
1539 /* allocate and install cpd's */
1540 if (pol->cpd_alloc_fn) {
1541 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1542 struct blkcg_policy_data *cpd;
1544 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1548 blkcg->cpd[pol->plid] = cpd;
1550 cpd->plid = pol->plid;
1551 if (pol->cpd_init_fn)
1552 pol->cpd_init_fn(cpd);
1556 mutex_unlock(&blkcg_pol_mutex);
1558 /* everything is in place, add intf files for the new policy */
1559 if (pol->dfl_cftypes)
1560 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1562 if (pol->legacy_cftypes)
1563 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
1564 pol->legacy_cftypes));
1565 mutex_unlock(&blkcg_pol_register_mutex);
1569 if (pol->cpd_free_fn)
1570 blkcg_free_all_cpd(pol);
1572 blkcg_policy[pol->plid] = NULL;
1574 mutex_unlock(&blkcg_pol_mutex);
1575 mutex_unlock(&blkcg_pol_register_mutex);
1578 EXPORT_SYMBOL_GPL(blkcg_policy_register);
1581 * blkcg_policy_unregister - unregister a blkcg policy
1582 * @pol: blkcg policy to unregister
1584 * Undo blkcg_policy_register(@pol). Might sleep.
1586 void blkcg_policy_unregister(struct blkcg_policy *pol)
1588 mutex_lock(&blkcg_pol_register_mutex);
1590 if (WARN_ON(blkcg_policy[pol->plid] != pol))
1593 /* kill the intf files first */
1594 if (pol->dfl_cftypes)
1595 cgroup_rm_cftypes(pol->dfl_cftypes);
1596 if (pol->legacy_cftypes)
1597 cgroup_rm_cftypes(pol->legacy_cftypes);
1599 /* remove cpds and unregister */
1600 mutex_lock(&blkcg_pol_mutex);
1602 if (pol->cpd_free_fn)
1603 blkcg_free_all_cpd(pol);
1605 blkcg_policy[pol->plid] = NULL;
1607 mutex_unlock(&blkcg_pol_mutex);
1609 mutex_unlock(&blkcg_pol_register_mutex);
1611 EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
1613 bool __blkcg_punt_bio_submit(struct bio *bio)
1615 struct blkcg_gq *blkg = bio->bi_blkg;
1617 /* consume the flag first */
1618 bio->bi_opf &= ~REQ_CGROUP_PUNT;
1620 /* never bounce for the root cgroup */
1624 spin_lock_bh(&blkg->async_bio_lock);
1625 bio_list_add(&blkg->async_bios, bio);
1626 spin_unlock_bh(&blkg->async_bio_lock);
1628 queue_work(blkcg_punt_bio_wq, &blkg->async_bio_work);
1633 * Scale the accumulated delay based on how long it has been since we updated
1634 * the delay. We only call this when we are adding delay, in case it's been a
1635 * while since we added delay, and when we are checking to see if we need to
1636 * delay a task, to account for any delays that may have occurred.
1638 static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1640 u64 old = atomic64_read(&blkg->delay_start);
1642 /* negative use_delay means no scaling, see blkcg_set_delay() */
1643 if (atomic_read(&blkg->use_delay) < 0)
1647 * We only want to scale down every second. The idea here is that we
1648 * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1649 * time window. We only want to throttle tasks for recent delay that
1650 * has occurred, in 1 second time windows since that's the maximum
1651 * things can be throttled. We save the current delay window in
1652 * blkg->last_delay so we know what amount is still left to be charged
1653 * to the blkg from this point onward. blkg->last_use keeps track of
1654 * the use_delay counter. The idea is if we're unthrottling the blkg we
1655 * are ok with whatever is happening now, and we can take away more of
1656 * the accumulated delay as we've already throttled enough that
1657 * everybody is happy with their IO latencies.
1659 if (time_before64(old + NSEC_PER_SEC, now) &&
1660 atomic64_try_cmpxchg(&blkg->delay_start, &old, now)) {
1661 u64 cur = atomic64_read(&blkg->delay_nsec);
1662 u64 sub = min_t(u64, blkg->last_delay, now - old);
1663 int cur_use = atomic_read(&blkg->use_delay);
1666 * We've been unthrottled, subtract a larger chunk of our
1667 * accumulated delay.
1669 if (cur_use < blkg->last_use)
1670 sub = max_t(u64, sub, blkg->last_delay >> 1);
1673 * This shouldn't happen, but handle it anyway. Our delay_nsec
1674 * should only ever be growing except here where we subtract out
1675 * min(last_delay, 1 second), but lord knows bugs happen and I'd
1676 * rather not end up with negative numbers.
1678 if (unlikely(cur < sub)) {
1679 atomic64_set(&blkg->delay_nsec, 0);
1680 blkg->last_delay = 0;
1682 atomic64_sub(sub, &blkg->delay_nsec);
1683 blkg->last_delay = cur - sub;
1685 blkg->last_use = cur_use;
1690 * This is called when we want to actually walk up the hierarchy and check to
1691 * see if we need to throttle, and then actually throttle if there is some
1692 * accumulated delay. This should only be called upon return to user space so
1693 * we're not holding some lock that would induce a priority inversion.
1695 static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1697 unsigned long pflags;
1699 u64 now = ktime_to_ns(ktime_get());
1704 while (blkg->parent) {
1705 int use_delay = atomic_read(&blkg->use_delay);
1710 blkcg_scale_delay(blkg, now);
1711 this_delay = atomic64_read(&blkg->delay_nsec);
1712 if (this_delay > delay_nsec) {
1713 delay_nsec = this_delay;
1714 clamp = use_delay > 0;
1717 blkg = blkg->parent;
1724 * Let's not sleep for all eternity if we've amassed a huge delay.
1725 * Swapping or metadata IO can accumulate 10's of seconds worth of
1726 * delay, and we want userspace to be able to do _something_ so cap the
1727 * delays at 0.25s. If there's 10's of seconds worth of delay then the
1728 * tasks will be delayed for 0.25 second for every syscall. If
1729 * blkcg_set_delay() was used as indicated by negative use_delay, the
1730 * caller is responsible for regulating the range.
1733 delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
1736 psi_memstall_enter(&pflags);
1738 exp = ktime_add_ns(now, delay_nsec);
1739 tok = io_schedule_prepare();
1741 __set_current_state(TASK_KILLABLE);
1742 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1744 } while (!fatal_signal_pending(current));
1745 io_schedule_finish(tok);
1748 psi_memstall_leave(&pflags);
1752 * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1754 * This is only called if we've been marked with set_notify_resume(). Obviously
1755 * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1756 * check to see if current->throttle_queue is set and if not this doesn't do
1757 * anything. This should only ever be called by the resume code, it's not meant
1758 * to be called by people willy-nilly as it will actually do the work to
1759 * throttle the task if it is setup for throttling.
1761 void blkcg_maybe_throttle_current(void)
1763 struct request_queue *q = current->throttle_queue;
1764 struct blkcg *blkcg;
1765 struct blkcg_gq *blkg;
1766 bool use_memdelay = current->use_memdelay;
1771 current->throttle_queue = NULL;
1772 current->use_memdelay = false;
1775 blkcg = css_to_blkcg(blkcg_css());
1778 blkg = blkg_lookup(blkcg, q);
1781 if (!blkg_tryget(blkg))
1785 blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1795 * blkcg_schedule_throttle - this task needs to check for throttling
1796 * @gendisk: disk to throttle
1797 * @use_memdelay: do we charge this to memory delay for PSI
1799 * This is called by the IO controller when we know there's delay accumulated
1800 * for the blkg for this task. We do not pass the blkg because there are places
1801 * we call this that may not have that information, the swapping code for
1802 * instance will only have a block_device at that point. This set's the
1803 * notify_resume for the task to check and see if it requires throttling before
1804 * returning to user space.
1806 * We will only schedule once per syscall. You can call this over and over
1807 * again and it will only do the check once upon return to user space, and only
1808 * throttle once. If the task needs to be throttled again it'll need to be
1809 * re-set at the next time we see the task.
1811 void blkcg_schedule_throttle(struct gendisk *disk, bool use_memdelay)
1813 struct request_queue *q = disk->queue;
1815 if (unlikely(current->flags & PF_KTHREAD))
1818 if (current->throttle_queue != q) {
1819 if (!blk_get_queue(q))
1822 if (current->throttle_queue)
1823 blk_put_queue(current->throttle_queue);
1824 current->throttle_queue = q;
1828 current->use_memdelay = use_memdelay;
1829 set_notify_resume(current);
1833 * blkcg_add_delay - add delay to this blkg
1834 * @blkg: blkg of interest
1835 * @now: the current time in nanoseconds
1836 * @delta: how many nanoseconds of delay to add
1838 * Charge @delta to the blkg's current delay accumulation. This is used to
1839 * throttle tasks if an IO controller thinks we need more throttling.
1841 void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1843 if (WARN_ON_ONCE(atomic_read(&blkg->use_delay) < 0))
1845 blkcg_scale_delay(blkg, now);
1846 atomic64_add(delta, &blkg->delay_nsec);
1850 * blkg_tryget_closest - try and get a blkg ref on the closet blkg
1854 * As the failure mode here is to walk up the blkg tree, this ensure that the
1855 * blkg->parent pointers are always valid. This returns the blkg that it ended
1856 * up taking a reference on or %NULL if no reference was taken.
1858 static inline struct blkcg_gq *blkg_tryget_closest(struct bio *bio,
1859 struct cgroup_subsys_state *css)
1861 struct blkcg_gq *blkg, *ret_blkg = NULL;
1864 blkg = blkg_lookup_create(css_to_blkcg(css), bio->bi_bdev->bd_disk);
1866 if (blkg_tryget(blkg)) {
1870 blkg = blkg->parent;
1878 * bio_associate_blkg_from_css - associate a bio with a specified css
1882 * Associate @bio with the blkg found by combining the css's blkg and the
1883 * request_queue of the @bio. An association failure is handled by walking up
1884 * the blkg tree. Therefore, the blkg associated can be anything between @blkg
1885 * and q->root_blkg. This situation only happens when a cgroup is dying and
1886 * then the remaining bios will spill to the closest alive blkg.
1888 * A reference will be taken on the blkg and will be released when @bio is
1891 void bio_associate_blkg_from_css(struct bio *bio,
1892 struct cgroup_subsys_state *css)
1895 blkg_put(bio->bi_blkg);
1897 if (css && css->parent) {
1898 bio->bi_blkg = blkg_tryget_closest(bio, css);
1900 blkg_get(bdev_get_queue(bio->bi_bdev)->root_blkg);
1901 bio->bi_blkg = bdev_get_queue(bio->bi_bdev)->root_blkg;
1904 EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
1907 * bio_associate_blkg - associate a bio with a blkg
1910 * Associate @bio with the blkg found from the bio's css and request_queue.
1911 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
1912 * already associated, the css is reused and association redone as the
1913 * request_queue may have changed.
1915 void bio_associate_blkg(struct bio *bio)
1917 struct cgroup_subsys_state *css;
1922 css = bio_blkcg_css(bio);
1926 bio_associate_blkg_from_css(bio, css);
1930 EXPORT_SYMBOL_GPL(bio_associate_blkg);
1933 * bio_clone_blkg_association - clone blkg association from src to dst bio
1934 * @dst: destination bio
1937 void bio_clone_blkg_association(struct bio *dst, struct bio *src)
1940 bio_associate_blkg_from_css(dst, bio_blkcg_css(src));
1942 EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
1944 static int blk_cgroup_io_type(struct bio *bio)
1946 if (op_is_discard(bio->bi_opf))
1947 return BLKG_IOSTAT_DISCARD;
1948 if (op_is_write(bio->bi_opf))
1949 return BLKG_IOSTAT_WRITE;
1950 return BLKG_IOSTAT_READ;
1953 void blk_cgroup_bio_start(struct bio *bio)
1955 int rwd = blk_cgroup_io_type(bio), cpu;
1956 struct blkg_iostat_set *bis;
1957 unsigned long flags;
1960 bis = per_cpu_ptr(bio->bi_blkg->iostat_cpu, cpu);
1961 flags = u64_stats_update_begin_irqsave(&bis->sync);
1964 * If the bio is flagged with BIO_CGROUP_ACCT it means this is a split
1965 * bio and we would have already accounted for the size of the bio.
1967 if (!bio_flagged(bio, BIO_CGROUP_ACCT)) {
1968 bio_set_flag(bio, BIO_CGROUP_ACCT);
1969 bis->cur.bytes[rwd] += bio->bi_iter.bi_size;
1971 bis->cur.ios[rwd]++;
1973 u64_stats_update_end_irqrestore(&bis->sync, flags);
1974 if (cgroup_subsys_on_dfl(io_cgrp_subsys))
1975 cgroup_rstat_updated(bio->bi_blkg->blkcg->css.cgroup, cpu);
1979 bool blk_cgroup_congested(void)
1981 struct cgroup_subsys_state *css;
1985 for (css = blkcg_css(); css; css = css->parent) {
1986 if (atomic_read(&css->cgroup->congestion_count)) {
1995 static int __init blkcg_init(void)
1997 blkcg_punt_bio_wq = alloc_workqueue("blkcg_punt_bio",
1998 WQ_MEM_RECLAIM | WQ_FREEZABLE |
1999 WQ_UNBOUND | WQ_SYSFS, 0);
2000 if (!blkcg_punt_bio_wq)
2004 subsys_initcall(blkcg_init);
2006 module_param(blkcg_debug_stats, bool, 0644);
2007 MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");