]> git.ipfire.org Git - people/ms/linux.git/blame - block/blk-cgroup.c
hwmon: (lm90) Add support for unsigned and signed temperatures
[people/ms/linux.git] / block / blk-cgroup.c
CommitLineData
3dcf60bc 1// SPDX-License-Identifier: GPL-2.0
31e4c28d
VG
2/*
3 * Common Block IO controller cgroup interface
4 *
5 * Based on ideas and code from CFQ, CFS and BFQ:
6 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
7 *
8 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
9 * Paolo Valente <paolo.valente@unimore.it>
10 *
11 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
12 * Nauman Rafique <nauman@google.com>
e48453c3
AA
13 *
14 * For policy-specific per-blkcg data:
15 * Copyright (C) 2015 Paolo Valente <paolo.valente@unimore.it>
16 * Arianna Avanzini <avanzini.arianna@gmail.com>
31e4c28d
VG
17 */
18#include <linux/ioprio.h>
22084190 19#include <linux/kdev_t.h>
9d6a986c 20#include <linux/module.h>
174cd4b1 21#include <linux/sched/signal.h>
accee785 22#include <linux/err.h>
9195291e 23#include <linux/blkdev.h>
52ebea74 24#include <linux/backing-dev.h>
5a0e3ad6 25#include <linux/slab.h>
72e06c25 26#include <linux/delay.h>
9a9e8a26 27#include <linux/atomic.h>
36aa9e5f 28#include <linux/ctype.h>
03248add 29#include <linux/resume_user_mode.h>
fd112c74 30#include <linux/psi.h>
82d981d4 31#include <linux/part_stat.h>
5efd6113 32#include "blk.h"
672fdcf0 33#include "blk-cgroup.h"
556910e3 34#include "blk-ioprio.h"
a7b36ee6 35#include "blk-throttle.h"
3e252066 36
838f13bf
TH
37/*
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.
43 */
44static DEFINE_MUTEX(blkcg_pol_register_mutex);
bc0d6501 45static DEFINE_MUTEX(blkcg_pol_mutex);
923adde1 46
e48453c3 47struct blkcg blkcg_root;
3c798398 48EXPORT_SYMBOL_GPL(blkcg_root);
9d6a986c 49
496d5e75 50struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;
9b0eb69b 51EXPORT_SYMBOL_GPL(blkcg_root_css);
496d5e75 52
3c798398 53static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
035d10b2 54
7876f930
TH
55static LIST_HEAD(all_blkcgs); /* protected by blkcg_pol_mutex */
56
07b0fdec 57bool blkcg_debug_stats = false;
d3f77dfd 58static struct workqueue_struct *blkcg_punt_bio_wq;
903d23f0 59
a731763f
YK
60#define BLKG_DESTROY_BATCH_SIZE 64
61
bc5fee91
CH
62/**
63 * blkcg_css - find the current css
64 *
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.
68 */
69static struct cgroup_subsys_state *blkcg_css(void)
70{
71 struct cgroup_subsys_state *css;
72
73 css = kthread_blkcg();
74 if (css)
75 return css;
76 return task_css(current, io_cgrp_id);
77}
78
a2b1693b 79static bool blkcg_policy_enabled(struct request_queue *q,
3c798398 80 const struct blkcg_policy *pol)
a2b1693b
TH
81{
82 return pol && test_bit(pol->plid, q->blkcg_pols);
83}
84
d578c770 85static void blkg_free_workfn(struct work_struct *work)
0381411e 86{
d578c770
ML
87 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
88 free_work);
e8989fae 89 int i;
549d3aa8 90
db613670 91 for (i = 0; i < BLKCG_MAX_POLS; i++)
001bea73
TH
92 if (blkg->pd[i])
93 blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
e8989fae 94
0a9a25ca
ML
95 if (blkg->q)
96 blk_put_queue(blkg->q);
f7331648 97 free_percpu(blkg->iostat_cpu);
ef069b97 98 percpu_ref_exit(&blkg->refcnt);
549d3aa8 99 kfree(blkg);
0381411e
TH
100}
101
d578c770
ML
102/**
103 * blkg_free - free a blkg
104 * @blkg: blkg to free
105 *
106 * Free @blkg which may be partially allocated.
107 */
108static void blkg_free(struct blkcg_gq *blkg)
109{
110 if (!blkg)
111 return;
112
113 /*
114 * Both ->pd_free_fn() and request queue's release handler may
115 * sleep, so free us by scheduling one work func
116 */
117 INIT_WORK(&blkg->free_work, blkg_free_workfn);
118 schedule_work(&blkg->free_work);
119}
120
7fcf2b03
DZ
121static void __blkg_release(struct rcu_head *rcu)
122{
123 struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);
124
d3f77dfd
TH
125 WARN_ON(!bio_list_empty(&blkg->async_bios));
126
7fcf2b03
DZ
127 /* release the blkcg and parent blkg refs this blkg has been holding */
128 css_put(&blkg->blkcg->css);
129 if (blkg->parent)
130 blkg_put(blkg->parent);
7fcf2b03
DZ
131 blkg_free(blkg);
132}
133
134/*
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.
138 *
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.
141 */
142static void blkg_release(struct percpu_ref *ref)
143{
144 struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);
145
146 call_rcu(&blkg->rcu_head, __blkg_release);
147}
148
d3f77dfd
TH
149static void blkg_async_bio_workfn(struct work_struct *work)
150{
151 struct blkcg_gq *blkg = container_of(work, struct blkcg_gq,
152 async_bio_work);
153 struct bio_list bios = BIO_EMPTY_LIST;
154 struct bio *bio;
192f1c6b
XT
155 struct blk_plug plug;
156 bool need_plug = false;
d3f77dfd
TH
157
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);
163
192f1c6b
XT
164 /* start plug only when bio_list contains at least 2 bios */
165 if (bios.head && bios.head->bi_next) {
166 need_plug = true;
167 blk_start_plug(&plug);
168 }
d3f77dfd
TH
169 while ((bio = bio_list_pop(&bios)))
170 submit_bio(bio);
192f1c6b
XT
171 if (need_plug)
172 blk_finish_plug(&plug);
d3f77dfd
TH
173}
174
bbb1ebe7
CH
175/**
176 * bio_blkcg_css - return the blkcg CSS associated with a bio
177 * @bio: target bio
178 *
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.
182 */
183struct cgroup_subsys_state *bio_blkcg_css(struct bio *bio)
184{
185 if (!bio || !bio->bi_blkg)
186 return NULL;
187 return &bio->bi_blkg->blkcg->css;
188}
189EXPORT_SYMBOL_GPL(bio_blkcg_css);
190
397c9f46
CH
191/**
192 * blkcg_parent - get the parent of a blkcg
193 * @blkcg: blkcg of interest
194 *
195 * Return the parent blkcg of @blkcg. Can be called anytime.
196 */
197static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
198{
199 return css_to_blkcg(blkcg->css.parent);
200}
201
0381411e
TH
202/**
203 * blkg_alloc - allocate a blkg
204 * @blkcg: block cgroup the new blkg is associated with
205 * @q: request_queue the new blkg is associated with
15974993 206 * @gfp_mask: allocation mask to use
0381411e 207 *
e8989fae 208 * Allocate a new blkg assocating @blkcg and @q.
0381411e 209 */
15974993
TH
210static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct request_queue *q,
211 gfp_t gfp_mask)
0381411e 212{
3c798398 213 struct blkcg_gq *blkg;
f7331648 214 int i, cpu;
0381411e
TH
215
216 /* alloc and init base part */
15974993 217 blkg = kzalloc_node(sizeof(*blkg), gfp_mask, q->node);
0381411e
TH
218 if (!blkg)
219 return NULL;
220
ef069b97
TH
221 if (percpu_ref_init(&blkg->refcnt, blkg_release, 0, gfp_mask))
222 goto err_free;
223
f7331648
TH
224 blkg->iostat_cpu = alloc_percpu_gfp(struct blkg_iostat_set, gfp_mask);
225 if (!blkg->iostat_cpu)
77ea7338
TH
226 goto err_free;
227
0a9a25ca
ML
228 if (!blk_get_queue(q))
229 goto err_free;
230
c875f4d0 231 blkg->q = q;
e8989fae 232 INIT_LIST_HEAD(&blkg->q_node);
d3f77dfd
TH
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);
0381411e 236 blkg->blkcg = blkcg;
0381411e 237
f7331648
TH
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);
241
8bd435b3 242 for (i = 0; i < BLKCG_MAX_POLS; i++) {
3c798398 243 struct blkcg_policy *pol = blkcg_policy[i];
e8989fae 244 struct blkg_policy_data *pd;
0381411e 245
a2b1693b 246 if (!blkcg_policy_enabled(q, pol))
e8989fae
TH
247 continue;
248
249 /* alloc per-policy data and attach it to blkg */
cf09a8ee 250 pd = pol->pd_alloc_fn(gfp_mask, q, blkcg);
a051661c
TH
251 if (!pd)
252 goto err_free;
549d3aa8 253
e8989fae
TH
254 blkg->pd[i] = pd;
255 pd->blkg = blkg;
b276a876 256 pd->plid = i;
e8989fae
TH
257 }
258
0381411e 259 return blkg;
a051661c
TH
260
261err_free:
262 blkg_free(blkg);
263 return NULL;
0381411e
TH
264}
265
24f29046
TH
266struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
267 struct request_queue *q, bool update_hint)
80fd9979 268{
3c798398 269 struct blkcg_gq *blkg;
80fd9979 270
a637120e 271 /*
86cde6b6
TH
272 * Hint didn't match. Look up from the radix tree. Note that the
273 * hint can only be updated under queue_lock as otherwise @blkg
274 * could have already been removed from blkg_tree. The caller is
275 * responsible for grabbing queue_lock if @update_hint.
a637120e
TH
276 */
277 blkg = radix_tree_lookup(&blkcg->blkg_tree, q->id);
86cde6b6
TH
278 if (blkg && blkg->q == q) {
279 if (update_hint) {
0d945c1f 280 lockdep_assert_held(&q->queue_lock);
86cde6b6
TH
281 rcu_assign_pointer(blkcg->blkg_hint, blkg);
282 }
a637120e 283 return blkg;
86cde6b6 284 }
a637120e 285
80fd9979
TH
286 return NULL;
287}
ae118896 288EXPORT_SYMBOL_GPL(blkg_lookup_slowpath);
80fd9979 289
15974993 290/*
d708f0d5
JA
291 * If @new_blkg is %NULL, this function tries to allocate a new one as
292 * necessary using %GFP_NOWAIT. @new_blkg is always consumed on return.
15974993 293 */
86cde6b6 294static struct blkcg_gq *blkg_create(struct blkcg *blkcg,
d708f0d5
JA
295 struct request_queue *q,
296 struct blkcg_gq *new_blkg)
5624a4e4 297{
d708f0d5 298 struct blkcg_gq *blkg;
f427d909 299 int i, ret;
5624a4e4 300
0d945c1f 301 lockdep_assert_held(&q->queue_lock);
cd1604fa 302
0273ac34
DZ
303 /* request_queue is dying, do not create/recreate a blkg */
304 if (blk_queue_dying(q)) {
305 ret = -ENODEV;
306 goto err_free_blkg;
307 }
308
7ee9c562 309 /* blkg holds a reference to blkcg */
ec903c0c 310 if (!css_tryget_online(&blkcg->css)) {
20386ce0 311 ret = -ENODEV;
93e6d5d8 312 goto err_free_blkg;
15974993 313 }
cd1604fa 314
d708f0d5
JA
315 /* allocate */
316 if (!new_blkg) {
317 new_blkg = blkg_alloc(blkcg, q, GFP_NOWAIT | __GFP_NOWARN);
318 if (unlikely(!new_blkg)) {
319 ret = -ENOMEM;
8c911f3d 320 goto err_put_css;
15974993
TH
321 }
322 }
d708f0d5 323 blkg = new_blkg;
cd1604fa 324
db613670 325 /* link parent */
3c547865
TH
326 if (blkcg_parent(blkcg)) {
327 blkg->parent = __blkg_lookup(blkcg_parent(blkcg), q, false);
328 if (WARN_ON_ONCE(!blkg->parent)) {
20386ce0 329 ret = -ENODEV;
8c911f3d 330 goto err_put_css;
3c547865
TH
331 }
332 blkg_get(blkg->parent);
333 }
334
db613670
TH
335 /* invoke per-policy init */
336 for (i = 0; i < BLKCG_MAX_POLS; i++) {
337 struct blkcg_policy *pol = blkcg_policy[i];
338
339 if (blkg->pd[i] && pol->pd_init_fn)
a9520cd6 340 pol->pd_init_fn(blkg->pd[i]);
db613670
TH
341 }
342
343 /* insert */
cd1604fa 344 spin_lock(&blkcg->lock);
a637120e
TH
345 ret = radix_tree_insert(&blkcg->blkg_tree, q->id, blkg);
346 if (likely(!ret)) {
347 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
348 list_add(&blkg->q_node, &q->blkg_list);
f427d909
TH
349
350 for (i = 0; i < BLKCG_MAX_POLS; i++) {
351 struct blkcg_policy *pol = blkcg_policy[i];
352
353 if (blkg->pd[i] && pol->pd_online_fn)
a9520cd6 354 pol->pd_online_fn(blkg->pd[i]);
f427d909 355 }
a637120e 356 }
f427d909 357 blkg->online = true;
cd1604fa 358 spin_unlock(&blkcg->lock);
496fb780 359
ec13b1d6 360 if (!ret)
a637120e 361 return blkg;
15974993 362
3c547865
TH
363 /* @blkg failed fully initialized, use the usual release path */
364 blkg_put(blkg);
365 return ERR_PTR(ret);
366
d708f0d5 367err_put_css:
496fb780 368 css_put(&blkcg->css);
93e6d5d8 369err_free_blkg:
d708f0d5 370 blkg_free(new_blkg);
93e6d5d8 371 return ERR_PTR(ret);
31e4c28d 372}
3c96cb32 373
86cde6b6 374/**
8c546287 375 * blkg_lookup_create - lookup blkg, try to create one if not there
86cde6b6
TH
376 * @blkcg: blkcg of interest
377 * @q: request_queue of interest
378 *
379 * Lookup blkg for the @blkcg - @q pair. If it doesn't exist, try to
3c547865
TH
380 * create one. blkg creation is performed recursively from blkcg_root such
381 * that all non-root blkg's have access to the parent blkg. This function
8c546287 382 * should be called under RCU read lock and takes @q->queue_lock.
86cde6b6 383 *
beea9da0
DZ
384 * Returns the blkg or the closest blkg if blkg_create() fails as it walks
385 * down from root.
86cde6b6 386 */
8c546287
CH
387static struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
388 struct request_queue *q)
3c96cb32 389{
86cde6b6 390 struct blkcg_gq *blkg;
8c546287 391 unsigned long flags;
86cde6b6
TH
392
393 WARN_ON_ONCE(!rcu_read_lock_held());
86cde6b6 394
8c546287 395 blkg = blkg_lookup(blkcg, q);
86cde6b6
TH
396 if (blkg)
397 return blkg;
398
8c546287
CH
399 spin_lock_irqsave(&q->queue_lock, flags);
400 blkg = __blkg_lookup(blkcg, q, true);
401 if (blkg)
402 goto found;
403
3c547865
TH
404 /*
405 * Create blkgs walking down from blkcg_root to @blkcg, so that all
beea9da0
DZ
406 * non-root blkgs have access to their parents. Returns the closest
407 * blkg to the intended blkg should blkg_create() fail.
3c547865
TH
408 */
409 while (true) {
410 struct blkcg *pos = blkcg;
411 struct blkcg *parent = blkcg_parent(blkcg);
beea9da0
DZ
412 struct blkcg_gq *ret_blkg = q->root_blkg;
413
414 while (parent) {
415 blkg = __blkg_lookup(parent, q, false);
416 if (blkg) {
417 /* remember closest blkg */
418 ret_blkg = blkg;
419 break;
420 }
3c547865
TH
421 pos = parent;
422 parent = blkcg_parent(parent);
423 }
424
d708f0d5 425 blkg = blkg_create(pos, q, NULL);
8c546287
CH
426 if (IS_ERR(blkg)) {
427 blkg = ret_blkg;
428 break;
429 }
beea9da0 430 if (pos == blkcg)
8c546287 431 break;
b978962a
DZ
432 }
433
8c546287
CH
434found:
435 spin_unlock_irqrestore(&q->queue_lock, flags);
b978962a
DZ
436 return blkg;
437}
438
3c798398 439static void blkg_destroy(struct blkcg_gq *blkg)
03aa264a 440{
3c798398 441 struct blkcg *blkcg = blkg->blkcg;
6b065462 442 int i;
03aa264a 443
0d945c1f 444 lockdep_assert_held(&blkg->q->queue_lock);
9f13ef67 445 lockdep_assert_held(&blkcg->lock);
03aa264a
TH
446
447 /* Something wrong if we are trying to remove same group twice */
e8989fae 448 WARN_ON_ONCE(list_empty(&blkg->q_node));
9f13ef67 449 WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
a637120e 450
6b065462
DZF
451 for (i = 0; i < BLKCG_MAX_POLS; i++) {
452 struct blkcg_policy *pol = blkcg_policy[i];
453
454 if (blkg->pd[i] && pol->pd_offline_fn)
455 pol->pd_offline_fn(blkg->pd[i]);
456 }
457
f427d909
TH
458 blkg->online = false;
459
a637120e 460 radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
e8989fae 461 list_del_init(&blkg->q_node);
9f13ef67 462 hlist_del_init_rcu(&blkg->blkcg_node);
03aa264a 463
a637120e
TH
464 /*
465 * Both setting lookup hint to and clearing it from @blkg are done
466 * under queue_lock. If it's not pointing to @blkg now, it never
467 * will. Hint assignment itself can race safely.
468 */
ec6c676a 469 if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
a637120e
TH
470 rcu_assign_pointer(blkcg->blkg_hint, NULL);
471
03aa264a
TH
472 /*
473 * Put the reference taken at the time of creation so that when all
474 * queues are gone, group can be destroyed.
475 */
7fcf2b03 476 percpu_ref_kill(&blkg->refcnt);
03aa264a
TH
477}
478
9f13ef67
TH
479/**
480 * blkg_destroy_all - destroy all blkgs associated with a request_queue
481 * @q: request_queue of interest
9f13ef67 482 *
3c96cb32 483 * Destroy all blkgs associated with @q.
9f13ef67 484 */
3c96cb32 485static void blkg_destroy_all(struct request_queue *q)
72e06c25 486{
3c798398 487 struct blkcg_gq *blkg, *n;
a731763f 488 int count = BLKG_DESTROY_BATCH_SIZE;
72e06c25 489
a731763f 490restart:
0d945c1f 491 spin_lock_irq(&q->queue_lock);
9f13ef67 492 list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
3c798398 493 struct blkcg *blkcg = blkg->blkcg;
72e06c25 494
9f13ef67
TH
495 spin_lock(&blkcg->lock);
496 blkg_destroy(blkg);
497 spin_unlock(&blkcg->lock);
a731763f
YK
498
499 /*
500 * in order to avoid holding the spin lock for too long, release
501 * it when a batch of blkgs are destroyed.
502 */
503 if (!(--count)) {
504 count = BLKG_DESTROY_BATCH_SIZE;
505 spin_unlock_irq(&q->queue_lock);
506 cond_resched();
507 goto restart;
508 }
72e06c25 509 }
6fe810bd
TH
510
511 q->root_blkg = NULL;
0d945c1f 512 spin_unlock_irq(&q->queue_lock);
72e06c25
TH
513}
514
182446d0
TH
515static int blkcg_reset_stats(struct cgroup_subsys_state *css,
516 struct cftype *cftype, u64 val)
303a3acb 517{
182446d0 518 struct blkcg *blkcg = css_to_blkcg(css);
3c798398 519 struct blkcg_gq *blkg;
f7331648 520 int i, cpu;
303a3acb 521
838f13bf 522 mutex_lock(&blkcg_pol_mutex);
303a3acb 523 spin_lock_irq(&blkcg->lock);
997a026c
TH
524
525 /*
526 * Note that stat reset is racy - it doesn't synchronize against
527 * stat updates. This is a debug feature which shouldn't exist
528 * anyway. If you get hit by a race, retry.
529 */
b67bfe0d 530 hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
f7331648
TH
531 for_each_possible_cpu(cpu) {
532 struct blkg_iostat_set *bis =
533 per_cpu_ptr(blkg->iostat_cpu, cpu);
534 memset(bis, 0, sizeof(*bis));
535 }
536 memset(&blkg->iostat, 0, sizeof(blkg->iostat));
77ea7338 537
8bd435b3 538 for (i = 0; i < BLKCG_MAX_POLS; i++) {
3c798398 539 struct blkcg_policy *pol = blkcg_policy[i];
549d3aa8 540
a9520cd6
TH
541 if (blkg->pd[i] && pol->pd_reset_stats_fn)
542 pol->pd_reset_stats_fn(blkg->pd[i]);
bc0d6501 543 }
303a3acb 544 }
f0bdc8cd 545
303a3acb 546 spin_unlock_irq(&blkcg->lock);
bc0d6501 547 mutex_unlock(&blkcg_pol_mutex);
303a3acb
DS
548 return 0;
549}
550
dd165eb3 551const char *blkg_dev_name(struct blkcg_gq *blkg)
303a3acb 552{
d152c682 553 if (!blkg->q->disk || !blkg->q->disk->bdi->dev)
edb0872f 554 return NULL;
d152c682 555 return bdi_dev_name(blkg->q->disk->bdi);
303a3acb
DS
556}
557
d3d32e69
TH
558/**
559 * blkcg_print_blkgs - helper for printing per-blkg data
560 * @sf: seq_file to print to
561 * @blkcg: blkcg of interest
562 * @prfill: fill function to print out a blkg
563 * @pol: policy in question
564 * @data: data to be passed to @prfill
565 * @show_total: to print out sum of prfill return values or not
566 *
567 * This function invokes @prfill on each blkg of @blkcg if pd for the
568 * policy specified by @pol exists. @prfill is invoked with @sf, the
810ecfa7
TH
569 * policy data and @data and the matching queue lock held. If @show_total
570 * is %true, the sum of the return values from @prfill is printed with
571 * "Total" label at the end.
d3d32e69
TH
572 *
573 * This is to be used to construct print functions for
574 * cftype->read_seq_string method.
575 */
3c798398 576void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
f95a04af
TH
577 u64 (*prfill)(struct seq_file *,
578 struct blkg_policy_data *, int),
3c798398 579 const struct blkcg_policy *pol, int data,
ec399347 580 bool show_total)
5624a4e4 581{
3c798398 582 struct blkcg_gq *blkg;
d3d32e69 583 u64 total = 0;
5624a4e4 584
810ecfa7 585 rcu_read_lock();
ee89f812 586 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
0d945c1f 587 spin_lock_irq(&blkg->q->queue_lock);
a2b1693b 588 if (blkcg_policy_enabled(blkg->q, pol))
f95a04af 589 total += prfill(sf, blkg->pd[pol->plid], data);
0d945c1f 590 spin_unlock_irq(&blkg->q->queue_lock);
810ecfa7
TH
591 }
592 rcu_read_unlock();
d3d32e69
TH
593
594 if (show_total)
595 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
596}
829fdb50 597EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
d3d32e69
TH
598
599/**
600 * __blkg_prfill_u64 - prfill helper for a single u64 value
601 * @sf: seq_file to print to
f95a04af 602 * @pd: policy private data of interest
d3d32e69
TH
603 * @v: value to print
604 *
f95a04af 605 * Print @v to @sf for the device assocaited with @pd.
d3d32e69 606 */
f95a04af 607u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
d3d32e69 608{
f95a04af 609 const char *dname = blkg_dev_name(pd->blkg);
d3d32e69
TH
610
611 if (!dname)
612 return 0;
613
614 seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
615 return v;
616}
829fdb50 617EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
d3d32e69 618
457e490f
TE
619/* Performs queue bypass and policy enabled checks then looks up blkg. */
620static struct blkcg_gq *blkg_lookup_check(struct blkcg *blkcg,
621 const struct blkcg_policy *pol,
622 struct request_queue *q)
623{
624 WARN_ON_ONCE(!rcu_read_lock_held());
0d945c1f 625 lockdep_assert_held(&q->queue_lock);
457e490f
TE
626
627 if (!blkcg_policy_enabled(q, pol))
628 return ERR_PTR(-EOPNOTSUPP);
457e490f
TE
629 return __blkg_lookup(blkcg, q, true /* update_hint */);
630}
631
015d254c 632/**
22ae8ce8 633 * blkcg_conf_open_bdev - parse and open bdev for per-blkg config update
015d254c
TH
634 * @inputp: input string pointer
635 *
636 * Parse the device node prefix part, MAJ:MIN, of per-blkg config update
22ae8ce8 637 * from @input and get and return the matching bdev. *@inputp is
015d254c
TH
638 * updated to point past the device node prefix. Returns an ERR_PTR()
639 * value on error.
640 *
641 * Use this function iff blkg_conf_prep() can't be used for some reason.
642 */
22ae8ce8 643struct block_device *blkcg_conf_open_bdev(char **inputp)
015d254c
TH
644{
645 char *input = *inputp;
646 unsigned int major, minor;
22ae8ce8
CH
647 struct block_device *bdev;
648 int key_len;
015d254c
TH
649
650 if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
651 return ERR_PTR(-EINVAL);
652
653 input += key_len;
654 if (!isspace(*input))
655 return ERR_PTR(-EINVAL);
656 input = skip_spaces(input);
657
22ae8ce8
CH
658 bdev = blkdev_get_no_open(MKDEV(major, minor));
659 if (!bdev)
015d254c 660 return ERR_PTR(-ENODEV);
22ae8ce8
CH
661 if (bdev_is_partition(bdev)) {
662 blkdev_put_no_open(bdev);
015d254c
TH
663 return ERR_PTR(-ENODEV);
664 }
665
666 *inputp = input;
22ae8ce8 667 return bdev;
015d254c
TH
668}
669
3a8b31d3
TH
670/**
671 * blkg_conf_prep - parse and prepare for per-blkg config update
672 * @blkcg: target block cgroup
da8b0662 673 * @pol: target policy
3a8b31d3
TH
674 * @input: input string
675 * @ctx: blkg_conf_ctx to be filled
676 *
677 * Parse per-blkg config update from @input and initialize @ctx with the
36aa9e5f
TH
678 * result. @ctx->blkg points to the blkg to be updated and @ctx->body the
679 * part of @input following MAJ:MIN. This function returns with RCU read
680 * lock and queue lock held and must be paired with blkg_conf_finish().
3a8b31d3 681 */
3c798398 682int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
36aa9e5f 683 char *input, struct blkg_conf_ctx *ctx)
ed6cddef 684 __acquires(rcu) __acquires(&bdev->bd_queue->queue_lock)
34d0f179 685{
22ae8ce8 686 struct block_device *bdev;
457e490f 687 struct request_queue *q;
3c798398 688 struct blkcg_gq *blkg;
015d254c 689 int ret;
36aa9e5f 690
22ae8ce8
CH
691 bdev = blkcg_conf_open_bdev(&input);
692 if (IS_ERR(bdev))
693 return PTR_ERR(bdev);
e56da7e2 694
ed6cddef 695 q = bdev_get_queue(bdev);
da8b0662 696
0c9d338c
YK
697 /*
698 * blkcg_deactivate_policy() requires queue to be frozen, we can grab
699 * q_usage_counter to prevent concurrent with blkcg_deactivate_policy().
700 */
701 ret = blk_queue_enter(q, 0);
702 if (ret)
15c30104 703 goto fail;
0c9d338c 704
457e490f 705 rcu_read_lock();
0d945c1f 706 spin_lock_irq(&q->queue_lock);
e56da7e2 707
457e490f 708 blkg = blkg_lookup_check(blkcg, pol, q);
4bfd482e
TH
709 if (IS_ERR(blkg)) {
710 ret = PTR_ERR(blkg);
457e490f
TE
711 goto fail_unlock;
712 }
713
714 if (blkg)
715 goto success;
716
717 /*
718 * Create blkgs walking down from blkcg_root to @blkcg, so that all
719 * non-root blkgs have access to their parents.
720 */
721 while (true) {
722 struct blkcg *pos = blkcg;
723 struct blkcg *parent;
724 struct blkcg_gq *new_blkg;
725
726 parent = blkcg_parent(blkcg);
727 while (parent && !__blkg_lookup(parent, q, false)) {
728 pos = parent;
729 parent = blkcg_parent(parent);
730 }
731
732 /* Drop locks to do new blkg allocation with GFP_KERNEL. */
0d945c1f 733 spin_unlock_irq(&q->queue_lock);
3a8b31d3 734 rcu_read_unlock();
457e490f
TE
735
736 new_blkg = blkg_alloc(pos, q, GFP_KERNEL);
737 if (unlikely(!new_blkg)) {
738 ret = -ENOMEM;
15c30104 739 goto fail_exit_queue;
7702e8f4 740 }
3a8b31d3 741
f255c19b
GKB
742 if (radix_tree_preload(GFP_KERNEL)) {
743 blkg_free(new_blkg);
744 ret = -ENOMEM;
15c30104 745 goto fail_exit_queue;
f255c19b
GKB
746 }
747
457e490f 748 rcu_read_lock();
0d945c1f 749 spin_lock_irq(&q->queue_lock);
457e490f
TE
750
751 blkg = blkg_lookup_check(pos, pol, q);
752 if (IS_ERR(blkg)) {
753 ret = PTR_ERR(blkg);
52abfcbd 754 blkg_free(new_blkg);
f255c19b 755 goto fail_preloaded;
457e490f
TE
756 }
757
758 if (blkg) {
759 blkg_free(new_blkg);
760 } else {
761 blkg = blkg_create(pos, q, new_blkg);
98d669b4 762 if (IS_ERR(blkg)) {
457e490f 763 ret = PTR_ERR(blkg);
f255c19b 764 goto fail_preloaded;
457e490f
TE
765 }
766 }
767
f255c19b
GKB
768 radix_tree_preload_end();
769
457e490f
TE
770 if (pos == blkcg)
771 goto success;
772 }
773success:
0c9d338c 774 blk_queue_exit(q);
22ae8ce8 775 ctx->bdev = bdev;
3a8b31d3 776 ctx->blkg = blkg;
015d254c 777 ctx->body = input;
726fa694 778 return 0;
457e490f 779
f255c19b
GKB
780fail_preloaded:
781 radix_tree_preload_end();
457e490f 782fail_unlock:
0d945c1f 783 spin_unlock_irq(&q->queue_lock);
457e490f 784 rcu_read_unlock();
15c30104
YK
785fail_exit_queue:
786 blk_queue_exit(q);
457e490f 787fail:
22ae8ce8 788 blkdev_put_no_open(bdev);
457e490f
TE
789 /*
790 * If queue was bypassing, we should retry. Do so after a
791 * short msleep(). It isn't strictly necessary but queue
792 * can be bypassing for some time and it's always nice to
793 * avoid busy looping.
794 */
795 if (ret == -EBUSY) {
796 msleep(10);
797 ret = restart_syscall();
798 }
799 return ret;
34d0f179 800}
89f3b6d6 801EXPORT_SYMBOL_GPL(blkg_conf_prep);
34d0f179 802
3a8b31d3
TH
803/**
804 * blkg_conf_finish - finish up per-blkg config update
805 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
806 *
807 * Finish up after per-blkg config update. This function must be paired
808 * with blkg_conf_prep().
809 */
829fdb50 810void blkg_conf_finish(struct blkg_conf_ctx *ctx)
ed6cddef 811 __releases(&ctx->bdev->bd_queue->queue_lock) __releases(rcu)
34d0f179 812{
ed6cddef 813 spin_unlock_irq(&bdev_get_queue(ctx->bdev)->queue_lock);
3a8b31d3 814 rcu_read_unlock();
22ae8ce8 815 blkdev_put_no_open(ctx->bdev);
34d0f179 816}
89f3b6d6 817EXPORT_SYMBOL_GPL(blkg_conf_finish);
34d0f179 818
cd1fc4b9
BB
819static void blkg_iostat_set(struct blkg_iostat *dst, struct blkg_iostat *src)
820{
821 int i;
822
823 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
824 dst->bytes[i] = src->bytes[i];
825 dst->ios[i] = src->ios[i];
826 }
827}
828
829static void blkg_iostat_add(struct blkg_iostat *dst, struct blkg_iostat *src)
830{
831 int i;
832
833 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
834 dst->bytes[i] += src->bytes[i];
835 dst->ios[i] += src->ios[i];
836 }
837}
838
839static void blkg_iostat_sub(struct blkg_iostat *dst, struct blkg_iostat *src)
840{
841 int i;
842
843 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
844 dst->bytes[i] -= src->bytes[i];
845 dst->ios[i] -= src->ios[i];
846 }
847}
848
849static void blkcg_rstat_flush(struct cgroup_subsys_state *css, int cpu)
850{
851 struct blkcg *blkcg = css_to_blkcg(css);
852 struct blkcg_gq *blkg;
853
dc26532a
JW
854 /* Root-level stats are sourced from system-wide IO stats */
855 if (!cgroup_parent(css->cgroup))
856 return;
857
cd1fc4b9
BB
858 rcu_read_lock();
859
860 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
861 struct blkcg_gq *parent = blkg->parent;
862 struct blkg_iostat_set *bisc = per_cpu_ptr(blkg->iostat_cpu, cpu);
863 struct blkg_iostat cur, delta;
c3df5fb5 864 unsigned long flags;
cd1fc4b9
BB
865 unsigned int seq;
866
867 /* fetch the current per-cpu values */
868 do {
869 seq = u64_stats_fetch_begin(&bisc->sync);
870 blkg_iostat_set(&cur, &bisc->cur);
871 } while (u64_stats_fetch_retry(&bisc->sync, seq));
872
873 /* propagate percpu delta to global */
c3df5fb5 874 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
cd1fc4b9
BB
875 blkg_iostat_set(&delta, &cur);
876 blkg_iostat_sub(&delta, &bisc->last);
877 blkg_iostat_add(&blkg->iostat.cur, &delta);
878 blkg_iostat_add(&bisc->last, &delta);
c3df5fb5 879 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
cd1fc4b9 880
dc26532a
JW
881 /* propagate global delta to parent (unless that's root) */
882 if (parent && parent->parent) {
c3df5fb5 883 flags = u64_stats_update_begin_irqsave(&parent->iostat.sync);
cd1fc4b9
BB
884 blkg_iostat_set(&delta, &blkg->iostat.cur);
885 blkg_iostat_sub(&delta, &blkg->iostat.last);
886 blkg_iostat_add(&parent->iostat.cur, &delta);
887 blkg_iostat_add(&blkg->iostat.last, &delta);
c3df5fb5 888 u64_stats_update_end_irqrestore(&parent->iostat.sync, flags);
cd1fc4b9
BB
889 }
890 }
891
892 rcu_read_unlock();
893}
894
ef45fe47 895/*
dc26532a
JW
896 * We source root cgroup stats from the system-wide stats to avoid
897 * tracking the same information twice and incurring overhead when no
898 * cgroups are defined. For that reason, cgroup_rstat_flush in
899 * blkcg_print_stat does not actually fill out the iostat in the root
900 * cgroup's blkcg_gq.
ef45fe47
BB
901 *
902 * However, we would like to re-use the printing code between the root and
903 * non-root cgroups to the extent possible. For that reason, we simulate
904 * flushing the root cgroup's stats by explicitly filling in the iostat
905 * with disk level statistics.
906 */
907static void blkcg_fill_root_iostats(void)
908{
909 struct class_dev_iter iter;
910 struct device *dev;
911
912 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
913 while ((dev = class_dev_iter_next(&iter))) {
0d02129e
CH
914 struct block_device *bdev = dev_to_bdev(dev);
915 struct blkcg_gq *blkg =
ed6cddef 916 blk_queue_root_blkg(bdev_get_queue(bdev));
ef45fe47
BB
917 struct blkg_iostat tmp;
918 int cpu;
f122d103 919 unsigned long flags;
ef45fe47
BB
920
921 memset(&tmp, 0, sizeof(tmp));
922 for_each_possible_cpu(cpu) {
923 struct disk_stats *cpu_dkstats;
924
0d02129e 925 cpu_dkstats = per_cpu_ptr(bdev->bd_stats, cpu);
ef45fe47
BB
926 tmp.ios[BLKG_IOSTAT_READ] +=
927 cpu_dkstats->ios[STAT_READ];
928 tmp.ios[BLKG_IOSTAT_WRITE] +=
929 cpu_dkstats->ios[STAT_WRITE];
930 tmp.ios[BLKG_IOSTAT_DISCARD] +=
931 cpu_dkstats->ios[STAT_DISCARD];
932 // convert sectors to bytes
933 tmp.bytes[BLKG_IOSTAT_READ] +=
934 cpu_dkstats->sectors[STAT_READ] << 9;
935 tmp.bytes[BLKG_IOSTAT_WRITE] +=
936 cpu_dkstats->sectors[STAT_WRITE] << 9;
937 tmp.bytes[BLKG_IOSTAT_DISCARD] +=
938 cpu_dkstats->sectors[STAT_DISCARD] << 9;
ef45fe47 939 }
f122d103
CZ
940
941 flags = u64_stats_update_begin_irqsave(&blkg->iostat.sync);
942 blkg_iostat_set(&blkg->iostat.cur, &tmp);
943 u64_stats_update_end_irqrestore(&blkg->iostat.sync, flags);
ef45fe47
BB
944 }
945}
946
49cb5168 947static void blkcg_print_one_stat(struct blkcg_gq *blkg, struct seq_file *s)
2ee867dc 948{
49cb5168
CH
949 struct blkg_iostat_set *bis = &blkg->iostat;
950 u64 rbytes, wbytes, rios, wios, dbytes, dios;
49cb5168
CH
951 const char *dname;
952 unsigned seq;
49cb5168 953 int i;
ef45fe47 954
49cb5168
CH
955 if (!blkg->online)
956 return;
2ee867dc 957
49cb5168
CH
958 dname = blkg_dev_name(blkg);
959 if (!dname)
960 return;
2ee867dc 961
252c651a 962 seq_printf(s, "%s ", dname);
b0814361 963
49cb5168
CH
964 do {
965 seq = u64_stats_fetch_begin(&bis->sync);
b0814361 966
49cb5168
CH
967 rbytes = bis->cur.bytes[BLKG_IOSTAT_READ];
968 wbytes = bis->cur.bytes[BLKG_IOSTAT_WRITE];
969 dbytes = bis->cur.bytes[BLKG_IOSTAT_DISCARD];
970 rios = bis->cur.ios[BLKG_IOSTAT_READ];
971 wios = bis->cur.ios[BLKG_IOSTAT_WRITE];
972 dios = bis->cur.ios[BLKG_IOSTAT_DISCARD];
973 } while (u64_stats_fetch_retry(&bis->sync, seq));
2ee867dc 974
49cb5168 975 if (rbytes || wbytes || rios || wios) {
252c651a 976 seq_printf(s, "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
49cb5168
CH
977 rbytes, wbytes, rios, wios,
978 dbytes, dios);
979 }
903d23f0 980
49cb5168 981 if (blkcg_debug_stats && atomic_read(&blkg->use_delay)) {
252c651a 982 seq_printf(s, " use_delay=%d delay_nsec=%llu",
49cb5168
CH
983 atomic_read(&blkg->use_delay),
984 atomic64_read(&blkg->delay_nsec));
985 }
2ee867dc 986
49cb5168
CH
987 for (i = 0; i < BLKCG_MAX_POLS; i++) {
988 struct blkcg_policy *pol = blkcg_policy[i];
2ee867dc 989
49cb5168
CH
990 if (!blkg->pd[i] || !pol->pd_stat_fn)
991 continue;
903d23f0 992
3607849d 993 pol->pd_stat_fn(blkg->pd[i], s);
49cb5168 994 }
d09d8df3 995
3607849d 996 seq_puts(s, "\n");
49cb5168 997}
903d23f0 998
49cb5168
CH
999static int blkcg_print_stat(struct seq_file *sf, void *v)
1000{
1001 struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
1002 struct blkcg_gq *blkg;
903d23f0 1003
49cb5168
CH
1004 if (!seq_css(sf)->parent)
1005 blkcg_fill_root_iostats();
1006 else
1007 cgroup_rstat_flush(blkcg->css.cgroup);
07b0fdec 1008
49cb5168
CH
1009 rcu_read_lock();
1010 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
1011 spin_lock_irq(&blkg->q->queue_lock);
1012 blkcg_print_one_stat(blkg, sf);
b0814361 1013 spin_unlock_irq(&blkg->q->queue_lock);
2ee867dc 1014 }
2ee867dc
TH
1015 rcu_read_unlock();
1016 return 0;
1017}
1018
e1f3b941 1019static struct cftype blkcg_files[] = {
2ee867dc
TH
1020 {
1021 .name = "stat",
1022 .seq_show = blkcg_print_stat,
1023 },
1024 { } /* terminate */
1025};
1026
e1f3b941 1027static struct cftype blkcg_legacy_files[] = {
84c124da
DS
1028 {
1029 .name = "reset_stats",
3c798398 1030 .write_u64 = blkcg_reset_stats,
22084190 1031 },
4baf6e33 1032 { } /* terminate */
31e4c28d
VG
1033};
1034
dec223c9
CH
1035#ifdef CONFIG_CGROUP_WRITEBACK
1036struct list_head *blkcg_get_cgwb_list(struct cgroup_subsys_state *css)
1037{
1038 return &css_to_blkcg(css)->cgwb_list;
1039}
1040#endif
1041
59b57717
DZF
1042/*
1043 * blkcg destruction is a three-stage process.
1044 *
1045 * 1. Destruction starts. The blkcg_css_offline() callback is invoked
1046 * which offlines writeback. Here we tie the next stage of blkg destruction
1047 * to the completion of writeback associated with the blkcg. This lets us
1048 * avoid punting potentially large amounts of outstanding writeback to root
1049 * while maintaining any ongoing policies. The next stage is triggered when
1050 * the nr_cgwbs count goes to zero.
1051 *
1052 * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
1053 * and handles the destruction of blkgs. Here the css reference held by
1054 * the blkg is put back eventually allowing blkcg_css_free() to be called.
1055 * This work may occur in cgwb_release_workfn() on the cgwb_release
1056 * workqueue. Any submitted ios that fail to get the blkg ref will be
1057 * punted to the root_blkg.
1058 *
1059 * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
1060 * This finally frees the blkcg.
1061 */
1062
59b57717
DZF
1063/**
1064 * blkcg_destroy_blkgs - responsible for shooting down blkgs
1065 * @blkcg: blkcg of interest
1066 *
1067 * blkgs should be removed while holding both q and blkcg locks. As blkcg lock
1068 * is nested inside q lock, this function performs reverse double lock dancing.
1069 * Destroying the blkgs releases the reference held on the blkcg's css allowing
1070 * blkcg_css_free to eventually be called.
1071 *
1072 * This is the blkcg counterpart of ioc_release_fn().
1073 */
397c9f46 1074static void blkcg_destroy_blkgs(struct blkcg *blkcg)
59b57717 1075{
6c635cae
BW
1076 might_sleep();
1077
9f13ef67 1078 spin_lock_irq(&blkcg->lock);
7ee9c562 1079
4c699480
JQ
1080 while (!hlist_empty(&blkcg->blkg_list)) {
1081 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
6b065462 1082 struct blkcg_gq, blkcg_node);
4c699480
JQ
1083 struct request_queue *q = blkg->q;
1084
6c635cae
BW
1085 if (need_resched() || !spin_trylock(&q->queue_lock)) {
1086 /*
1087 * Given that the system can accumulate a huge number
1088 * of blkgs in pathological cases, check to see if we
1089 * need to rescheduling to avoid softlockup.
1090 */
4c699480 1091 spin_unlock_irq(&blkcg->lock);
6c635cae 1092 cond_resched();
4c699480 1093 spin_lock_irq(&blkcg->lock);
6c635cae 1094 continue;
4c699480 1095 }
6c635cae
BW
1096
1097 blkg_destroy(blkg);
1098 spin_unlock(&q->queue_lock);
4c699480 1099 }
6b065462 1100
4c699480
JQ
1101 spin_unlock_irq(&blkcg->lock);
1102}
1103
397c9f46
CH
1104/**
1105 * blkcg_pin_online - pin online state
1106 * @blkcg_css: blkcg of interest
1107 *
1108 * While pinned, a blkcg is kept online. This is primarily used to
1109 * impedance-match blkg and cgwb lifetimes so that blkg doesn't go offline
1110 * while an associated cgwb is still active.
1111 */
1112void blkcg_pin_online(struct cgroup_subsys_state *blkcg_css)
1113{
1114 refcount_inc(&css_to_blkcg(blkcg_css)->online_pin);
1115}
1116
1117/**
1118 * blkcg_unpin_online - unpin online state
1119 * @blkcg_css: blkcg of interest
1120 *
1121 * This is primarily used to impedance-match blkg and cgwb lifetimes so
1122 * that blkg doesn't go offline while an associated cgwb is still active.
1123 * When this count goes to zero, all active cgwbs have finished so the
1124 * blkcg can continue destruction by calling blkcg_destroy_blkgs().
1125 */
1126void blkcg_unpin_online(struct cgroup_subsys_state *blkcg_css)
1127{
1128 struct blkcg *blkcg = css_to_blkcg(blkcg_css);
1129
1130 do {
1131 if (!refcount_dec_and_test(&blkcg->online_pin))
1132 break;
1133 blkcg_destroy_blkgs(blkcg);
1134 blkcg = blkcg_parent(blkcg);
1135 } while (blkcg);
1136}
1137
1138/**
1139 * blkcg_css_offline - cgroup css_offline callback
1140 * @css: css of interest
1141 *
1142 * This function is called when @css is about to go away. Here the cgwbs are
1143 * offlined first and only once writeback associated with the blkcg has
1144 * finished do we start step 2 (see above).
1145 */
1146static void blkcg_css_offline(struct cgroup_subsys_state *css)
1147{
1148 /* this prevents anyone from attaching or migrating to this blkcg */
dec223c9 1149 wb_blkcg_offline(css);
397c9f46
CH
1150
1151 /* put the base online pin allowing step 2 to be triggered */
1152 blkcg_unpin_online(css);
1153}
1154
eb95419b 1155static void blkcg_css_free(struct cgroup_subsys_state *css)
7ee9c562 1156{
eb95419b 1157 struct blkcg *blkcg = css_to_blkcg(css);
bc915e61 1158 int i;
7ee9c562 1159
7876f930 1160 mutex_lock(&blkcg_pol_mutex);
e4a9bde9 1161
7876f930 1162 list_del(&blkcg->all_blkcgs_node);
7876f930 1163
bc915e61 1164 for (i = 0; i < BLKCG_MAX_POLS; i++)
e4a9bde9
TH
1165 if (blkcg->cpd[i])
1166 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1167
1168 mutex_unlock(&blkcg_pol_mutex);
1169
bc915e61 1170 kfree(blkcg);
31e4c28d
VG
1171}
1172
eb95419b
TH
1173static struct cgroup_subsys_state *
1174blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
31e4c28d 1175{
3c798398 1176 struct blkcg *blkcg;
e48453c3
AA
1177 struct cgroup_subsys_state *ret;
1178 int i;
31e4c28d 1179
7876f930
TH
1180 mutex_lock(&blkcg_pol_mutex);
1181
eb95419b 1182 if (!parent_css) {
3c798398 1183 blkcg = &blkcg_root;
bc915e61
TH
1184 } else {
1185 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1186 if (!blkcg) {
1187 ret = ERR_PTR(-ENOMEM);
4c18c9e9 1188 goto unlock;
bc915e61 1189 }
e48453c3
AA
1190 }
1191
1192 for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1193 struct blkcg_policy *pol = blkcg_policy[i];
1194 struct blkcg_policy_data *cpd;
1195
1196 /*
1197 * If the policy hasn't been attached yet, wait for it
1198 * to be attached before doing anything else. Otherwise,
1199 * check if the policy requires any specific per-cgroup
1200 * data: if it does, allocate and initialize it.
1201 */
e4a9bde9 1202 if (!pol || !pol->cpd_alloc_fn)
e48453c3
AA
1203 continue;
1204
e4a9bde9 1205 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
e48453c3
AA
1206 if (!cpd) {
1207 ret = ERR_PTR(-ENOMEM);
1208 goto free_pd_blkcg;
1209 }
81437648
TH
1210 blkcg->cpd[i] = cpd;
1211 cpd->blkcg = blkcg;
e48453c3 1212 cpd->plid = i;
e4a9bde9
TH
1213 if (pol->cpd_init_fn)
1214 pol->cpd_init_fn(cpd);
e48453c3 1215 }
31e4c28d 1216
31e4c28d 1217 spin_lock_init(&blkcg->lock);
d866dbf6 1218 refcount_set(&blkcg->online_pin, 1);
e00f4f4d 1219 INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
31e4c28d 1220 INIT_HLIST_HEAD(&blkcg->blkg_list);
52ebea74
TH
1221#ifdef CONFIG_CGROUP_WRITEBACK
1222 INIT_LIST_HEAD(&blkcg->cgwb_list);
1223#endif
7876f930
TH
1224 list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1225
1226 mutex_unlock(&blkcg_pol_mutex);
31e4c28d 1227 return &blkcg->css;
e48453c3
AA
1228
1229free_pd_blkcg:
1230 for (i--; i >= 0; i--)
e4a9bde9
TH
1231 if (blkcg->cpd[i])
1232 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
4c18c9e9 1233
1234 if (blkcg != &blkcg_root)
1235 kfree(blkcg);
1236unlock:
7876f930 1237 mutex_unlock(&blkcg_pol_mutex);
e48453c3 1238 return ret;
31e4c28d
VG
1239}
1240
4308a434
TH
1241static int blkcg_css_online(struct cgroup_subsys_state *css)
1242{
397c9f46 1243 struct blkcg *parent = blkcg_parent(css_to_blkcg(css));
4308a434
TH
1244
1245 /*
1246 * blkcg_pin_online() is used to delay blkcg offline so that blkgs
1247 * don't go offline while cgwbs are still active on them. Pin the
1248 * parent so that offline always happens towards the root.
1249 */
1250 if (parent)
397c9f46 1251 blkcg_pin_online(css);
4308a434
TH
1252 return 0;
1253}
1254
5efd6113
TH
1255/**
1256 * blkcg_init_queue - initialize blkcg part of request queue
1257 * @q: request_queue to initialize
1258 *
c62b37d9 1259 * Called from blk_alloc_queue(). Responsible for initializing blkcg
5efd6113
TH
1260 * part of new request_queue @q.
1261 *
1262 * RETURNS:
1263 * 0 on success, -errno on failure.
1264 */
1265int blkcg_init_queue(struct request_queue *q)
1266{
d708f0d5
JA
1267 struct blkcg_gq *new_blkg, *blkg;
1268 bool preloaded;
ec13b1d6
TH
1269 int ret;
1270
472e4314
ML
1271 INIT_LIST_HEAD(&q->blkg_list);
1272
d708f0d5
JA
1273 new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
1274 if (!new_blkg)
1275 return -ENOMEM;
1276
1277 preloaded = !radix_tree_preload(GFP_KERNEL);
1278
bea54883 1279 /* Make sure the root blkg exists. */
77c570a1 1280 /* spin_lock_irq can serve as RCU read-side critical section. */
0d945c1f 1281 spin_lock_irq(&q->queue_lock);
d708f0d5 1282 blkg = blkg_create(&blkcg_root, q, new_blkg);
901932a3
JB
1283 if (IS_ERR(blkg))
1284 goto err_unlock;
1285 q->root_blkg = blkg;
0d945c1f 1286 spin_unlock_irq(&q->queue_lock);
ec13b1d6 1287
d708f0d5
JA
1288 if (preloaded)
1289 radix_tree_preload_end();
1290
556910e3
BVA
1291 ret = blk_ioprio_init(q);
1292 if (ret)
1293 goto err_destroy_all;
1294
19688d7f
BVA
1295 ret = blk_throtl_init(q);
1296 if (ret)
04be60b5 1297 goto err_destroy_all;
19688d7f 1298
6f5ddde4
YX
1299 ret = blk_iolatency_init(q);
1300 if (ret) {
1301 blk_throtl_exit(q);
1302 goto err_destroy_all;
1303 }
1304
04be60b5 1305 return 0;
901932a3 1306
04be60b5 1307err_destroy_all:
04be60b5 1308 blkg_destroy_all(q);
04be60b5 1309 return ret;
901932a3 1310err_unlock:
0d945c1f 1311 spin_unlock_irq(&q->queue_lock);
901932a3
JB
1312 if (preloaded)
1313 radix_tree_preload_end();
1314 return PTR_ERR(blkg);
5efd6113
TH
1315}
1316
5efd6113
TH
1317/**
1318 * blkcg_exit_queue - exit and release blkcg part of request_queue
1319 * @q: request_queue being released
1320 *
7585d508 1321 * Called from blk_exit_queue(). Responsible for exiting blkcg part.
5efd6113
TH
1322 */
1323void blkcg_exit_queue(struct request_queue *q)
1324{
3c96cb32 1325 blkg_destroy_all(q);
5efd6113
TH
1326 blk_throtl_exit(q);
1327}
1328
69d7fde5
TH
1329static void blkcg_bind(struct cgroup_subsys_state *root_css)
1330{
1331 int i;
1332
1333 mutex_lock(&blkcg_pol_mutex);
1334
1335 for (i = 0; i < BLKCG_MAX_POLS; i++) {
1336 struct blkcg_policy *pol = blkcg_policy[i];
1337 struct blkcg *blkcg;
1338
1339 if (!pol || !pol->cpd_bind_fn)
1340 continue;
1341
1342 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
1343 if (blkcg->cpd[pol->plid])
1344 pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
1345 }
1346 mutex_unlock(&blkcg_pol_mutex);
1347}
1348
d09d8df3
JB
1349static void blkcg_exit(struct task_struct *tsk)
1350{
1351 if (tsk->throttle_queue)
1352 blk_put_queue(tsk->throttle_queue);
1353 tsk->throttle_queue = NULL;
1354}
1355
c165b3e3 1356struct cgroup_subsys io_cgrp_subsys = {
92fb9748 1357 .css_alloc = blkcg_css_alloc,
4308a434 1358 .css_online = blkcg_css_online,
92fb9748
TH
1359 .css_offline = blkcg_css_offline,
1360 .css_free = blkcg_css_free,
f7331648 1361 .css_rstat_flush = blkcg_rstat_flush,
69d7fde5 1362 .bind = blkcg_bind,
2ee867dc 1363 .dfl_cftypes = blkcg_files,
880f50e2 1364 .legacy_cftypes = blkcg_legacy_files,
c165b3e3 1365 .legacy_name = "blkio",
d09d8df3 1366 .exit = blkcg_exit,
1ced953b
TH
1367#ifdef CONFIG_MEMCG
1368 /*
1369 * This ensures that, if available, memcg is automatically enabled
1370 * together on the default hierarchy so that the owner cgroup can
1371 * be retrieved from writeback pages.
1372 */
1373 .depends_on = 1 << memory_cgrp_id,
1374#endif
676f7c8f 1375};
c165b3e3 1376EXPORT_SYMBOL_GPL(io_cgrp_subsys);
676f7c8f 1377
a2b1693b
TH
1378/**
1379 * blkcg_activate_policy - activate a blkcg policy on a request_queue
1380 * @q: request_queue of interest
1381 * @pol: blkcg policy to activate
1382 *
1383 * Activate @pol on @q. Requires %GFP_KERNEL context. @q goes through
1384 * bypass mode to populate its blkgs with policy_data for @pol.
1385 *
1386 * Activation happens with @q bypassed, so nobody would be accessing blkgs
1387 * from IO path. Update of each blkg is protected by both queue and blkcg
1388 * locks so that holding either lock and testing blkcg_policy_enabled() is
1389 * always enough for dereferencing policy data.
1390 *
1391 * The caller is responsible for synchronizing [de]activations and policy
1392 * [un]registerations. Returns 0 on success, -errno on failure.
1393 */
1394int blkcg_activate_policy(struct request_queue *q,
3c798398 1395 const struct blkcg_policy *pol)
a2b1693b 1396{
4c55f4f9 1397 struct blkg_policy_data *pd_prealloc = NULL;
9d179b86 1398 struct blkcg_gq *blkg, *pinned_blkg = NULL;
4c55f4f9 1399 int ret;
a2b1693b
TH
1400
1401 if (blkcg_policy_enabled(q, pol))
1402 return 0;
1403
344e9ffc 1404 if (queue_is_mq(q))
bd166ef1 1405 blk_mq_freeze_queue(q);
9d179b86 1406retry:
0d945c1f 1407 spin_lock_irq(&q->queue_lock);
a2b1693b 1408
9d179b86 1409 /* blkg_list is pushed at the head, reverse walk to allocate parents first */
71c81407 1410 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node) {
4c55f4f9
TH
1411 struct blkg_policy_data *pd;
1412
1413 if (blkg->pd[pol->plid])
1414 continue;
a2b1693b 1415
9d179b86
TH
1416 /* If prealloc matches, use it; otherwise try GFP_NOWAIT */
1417 if (blkg == pinned_blkg) {
1418 pd = pd_prealloc;
1419 pd_prealloc = NULL;
1420 } else {
1421 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q,
1422 blkg->blkcg);
1423 }
1424
4c55f4f9 1425 if (!pd) {
9d179b86
TH
1426 /*
1427 * GFP_NOWAIT failed. Free the existing one and
1428 * prealloc for @blkg w/ GFP_KERNEL.
1429 */
1430 if (pinned_blkg)
1431 blkg_put(pinned_blkg);
1432 blkg_get(blkg);
1433 pinned_blkg = blkg;
1434
0d945c1f 1435 spin_unlock_irq(&q->queue_lock);
9d179b86
TH
1436
1437 if (pd_prealloc)
1438 pol->pd_free_fn(pd_prealloc);
1439 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q,
1440 blkg->blkcg);
1441 if (pd_prealloc)
1442 goto retry;
1443 else
1444 goto enomem;
4c55f4f9 1445 }
a2b1693b
TH
1446
1447 blkg->pd[pol->plid] = pd;
1448 pd->blkg = blkg;
b276a876 1449 pd->plid = pol->plid;
a2b1693b
TH
1450 }
1451
9d179b86
TH
1452 /* all allocated, init in the same order */
1453 if (pol->pd_init_fn)
1454 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node)
1455 pol->pd_init_fn(blkg->pd[pol->plid]);
1456
a2b1693b
TH
1457 __set_bit(pol->plid, q->blkcg_pols);
1458 ret = 0;
4c55f4f9 1459
0d945c1f 1460 spin_unlock_irq(&q->queue_lock);
9d179b86 1461out:
344e9ffc 1462 if (queue_is_mq(q))
bd166ef1 1463 blk_mq_unfreeze_queue(q);
9d179b86
TH
1464 if (pinned_blkg)
1465 blkg_put(pinned_blkg);
001bea73
TH
1466 if (pd_prealloc)
1467 pol->pd_free_fn(pd_prealloc);
a2b1693b 1468 return ret;
9d179b86
TH
1469
1470enomem:
1471 /* alloc failed, nothing's initialized yet, free everything */
1472 spin_lock_irq(&q->queue_lock);
1473 list_for_each_entry(blkg, &q->blkg_list, q_node) {
858560b2
LJ
1474 struct blkcg *blkcg = blkg->blkcg;
1475
1476 spin_lock(&blkcg->lock);
9d179b86
TH
1477 if (blkg->pd[pol->plid]) {
1478 pol->pd_free_fn(blkg->pd[pol->plid]);
1479 blkg->pd[pol->plid] = NULL;
1480 }
858560b2 1481 spin_unlock(&blkcg->lock);
9d179b86
TH
1482 }
1483 spin_unlock_irq(&q->queue_lock);
1484 ret = -ENOMEM;
1485 goto out;
a2b1693b
TH
1486}
1487EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1488
1489/**
1490 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1491 * @q: request_queue of interest
1492 * @pol: blkcg policy to deactivate
1493 *
1494 * Deactivate @pol on @q. Follows the same synchronization rules as
1495 * blkcg_activate_policy().
1496 */
1497void blkcg_deactivate_policy(struct request_queue *q,
3c798398 1498 const struct blkcg_policy *pol)
a2b1693b 1499{
3c798398 1500 struct blkcg_gq *blkg;
a2b1693b
TH
1501
1502 if (!blkcg_policy_enabled(q, pol))
1503 return;
1504
344e9ffc 1505 if (queue_is_mq(q))
bd166ef1 1506 blk_mq_freeze_queue(q);
bd166ef1 1507
0d945c1f 1508 spin_lock_irq(&q->queue_lock);
a2b1693b
TH
1509
1510 __clear_bit(pol->plid, q->blkcg_pols);
1511
1512 list_for_each_entry(blkg, &q->blkg_list, q_node) {
858560b2
LJ
1513 struct blkcg *blkcg = blkg->blkcg;
1514
1515 spin_lock(&blkcg->lock);
001bea73 1516 if (blkg->pd[pol->plid]) {
6b065462 1517 if (pol->pd_offline_fn)
a9520cd6 1518 pol->pd_offline_fn(blkg->pd[pol->plid]);
001bea73
TH
1519 pol->pd_free_fn(blkg->pd[pol->plid]);
1520 blkg->pd[pol->plid] = NULL;
1521 }
858560b2 1522 spin_unlock(&blkcg->lock);
a2b1693b
TH
1523 }
1524
0d945c1f 1525 spin_unlock_irq(&q->queue_lock);
bd166ef1 1526
344e9ffc 1527 if (queue_is_mq(q))
bd166ef1 1528 blk_mq_unfreeze_queue(q);
a2b1693b
TH
1529}
1530EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1531
8bd435b3 1532/**
3c798398
TH
1533 * blkcg_policy_register - register a blkcg policy
1534 * @pol: blkcg policy to register
8bd435b3 1535 *
3c798398
TH
1536 * Register @pol with blkcg core. Might sleep and @pol may be modified on
1537 * successful registration. Returns 0 on success and -errno on failure.
8bd435b3 1538 */
d5bf0291 1539int blkcg_policy_register(struct blkcg_policy *pol)
3e252066 1540{
06b285bd 1541 struct blkcg *blkcg;
8bd435b3 1542 int i, ret;
e8989fae 1543
838f13bf 1544 mutex_lock(&blkcg_pol_register_mutex);
bc0d6501
TH
1545 mutex_lock(&blkcg_pol_mutex);
1546
8bd435b3
TH
1547 /* find an empty slot */
1548 ret = -ENOSPC;
1549 for (i = 0; i < BLKCG_MAX_POLS; i++)
3c798398 1550 if (!blkcg_policy[i])
8bd435b3 1551 break;
01c5f85a
JA
1552 if (i >= BLKCG_MAX_POLS) {
1553 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
838f13bf 1554 goto err_unlock;
01c5f85a 1555 }
035d10b2 1556
e8401073 1557 /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1558 if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1559 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1560 goto err_unlock;
1561
06b285bd 1562 /* register @pol */
3c798398 1563 pol->plid = i;
06b285bd
TH
1564 blkcg_policy[pol->plid] = pol;
1565
1566 /* allocate and install cpd's */
e4a9bde9 1567 if (pol->cpd_alloc_fn) {
06b285bd
TH
1568 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1569 struct blkcg_policy_data *cpd;
1570
e4a9bde9 1571 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
bbb427e3 1572 if (!cpd)
06b285bd 1573 goto err_free_cpds;
06b285bd 1574
81437648
TH
1575 blkcg->cpd[pol->plid] = cpd;
1576 cpd->blkcg = blkcg;
06b285bd 1577 cpd->plid = pol->plid;
86a5bba5
TH
1578 if (pol->cpd_init_fn)
1579 pol->cpd_init_fn(cpd);
06b285bd
TH
1580 }
1581 }
1582
838f13bf 1583 mutex_unlock(&blkcg_pol_mutex);
8bd435b3 1584
8bd435b3 1585 /* everything is in place, add intf files for the new policy */
2ee867dc
TH
1586 if (pol->dfl_cftypes)
1587 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1588 pol->dfl_cftypes));
880f50e2 1589 if (pol->legacy_cftypes)
c165b3e3 1590 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
880f50e2 1591 pol->legacy_cftypes));
838f13bf
TH
1592 mutex_unlock(&blkcg_pol_register_mutex);
1593 return 0;
1594
06b285bd 1595err_free_cpds:
58a9edce 1596 if (pol->cpd_free_fn) {
06b285bd 1597 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
e4a9bde9
TH
1598 if (blkcg->cpd[pol->plid]) {
1599 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1600 blkcg->cpd[pol->plid] = NULL;
1601 }
06b285bd
TH
1602 }
1603 }
1604 blkcg_policy[pol->plid] = NULL;
838f13bf 1605err_unlock:
bc0d6501 1606 mutex_unlock(&blkcg_pol_mutex);
838f13bf 1607 mutex_unlock(&blkcg_pol_register_mutex);
8bd435b3 1608 return ret;
3e252066 1609}
3c798398 1610EXPORT_SYMBOL_GPL(blkcg_policy_register);
3e252066 1611
8bd435b3 1612/**
3c798398
TH
1613 * blkcg_policy_unregister - unregister a blkcg policy
1614 * @pol: blkcg policy to unregister
8bd435b3 1615 *
3c798398 1616 * Undo blkcg_policy_register(@pol). Might sleep.
8bd435b3 1617 */
3c798398 1618void blkcg_policy_unregister(struct blkcg_policy *pol)
3e252066 1619{
06b285bd
TH
1620 struct blkcg *blkcg;
1621
838f13bf 1622 mutex_lock(&blkcg_pol_register_mutex);
bc0d6501 1623
3c798398 1624 if (WARN_ON(blkcg_policy[pol->plid] != pol))
8bd435b3
TH
1625 goto out_unlock;
1626
1627 /* kill the intf files first */
2ee867dc
TH
1628 if (pol->dfl_cftypes)
1629 cgroup_rm_cftypes(pol->dfl_cftypes);
880f50e2
TH
1630 if (pol->legacy_cftypes)
1631 cgroup_rm_cftypes(pol->legacy_cftypes);
44ea53de 1632
06b285bd 1633 /* remove cpds and unregister */
838f13bf 1634 mutex_lock(&blkcg_pol_mutex);
06b285bd 1635
58a9edce 1636 if (pol->cpd_free_fn) {
06b285bd 1637 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
e4a9bde9
TH
1638 if (blkcg->cpd[pol->plid]) {
1639 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1640 blkcg->cpd[pol->plid] = NULL;
1641 }
06b285bd
TH
1642 }
1643 }
3c798398 1644 blkcg_policy[pol->plid] = NULL;
06b285bd 1645
bc0d6501 1646 mutex_unlock(&blkcg_pol_mutex);
838f13bf
TH
1647out_unlock:
1648 mutex_unlock(&blkcg_pol_register_mutex);
3e252066 1649}
3c798398 1650EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
903d23f0 1651
d3f77dfd
TH
1652bool __blkcg_punt_bio_submit(struct bio *bio)
1653{
1654 struct blkcg_gq *blkg = bio->bi_blkg;
1655
1656 /* consume the flag first */
1657 bio->bi_opf &= ~REQ_CGROUP_PUNT;
1658
1659 /* never bounce for the root cgroup */
1660 if (!blkg->parent)
1661 return false;
1662
1663 spin_lock_bh(&blkg->async_bio_lock);
1664 bio_list_add(&blkg->async_bios, bio);
1665 spin_unlock_bh(&blkg->async_bio_lock);
1666
1667 queue_work(blkcg_punt_bio_wq, &blkg->async_bio_work);
1668 return true;
1669}
1670
d09d8df3
JB
1671/*
1672 * Scale the accumulated delay based on how long it has been since we updated
1673 * the delay. We only call this when we are adding delay, in case it's been a
1674 * while since we added delay, and when we are checking to see if we need to
1675 * delay a task, to account for any delays that may have occurred.
1676 */
1677static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1678{
1679 u64 old = atomic64_read(&blkg->delay_start);
1680
54c52e10
TH
1681 /* negative use_delay means no scaling, see blkcg_set_delay() */
1682 if (atomic_read(&blkg->use_delay) < 0)
1683 return;
1684
d09d8df3
JB
1685 /*
1686 * We only want to scale down every second. The idea here is that we
1687 * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1688 * time window. We only want to throttle tasks for recent delay that
1689 * has occurred, in 1 second time windows since that's the maximum
1690 * things can be throttled. We save the current delay window in
1691 * blkg->last_delay so we know what amount is still left to be charged
1692 * to the blkg from this point onward. blkg->last_use keeps track of
1693 * the use_delay counter. The idea is if we're unthrottling the blkg we
1694 * are ok with whatever is happening now, and we can take away more of
1695 * the accumulated delay as we've already throttled enough that
1696 * everybody is happy with their IO latencies.
1697 */
1698 if (time_before64(old + NSEC_PER_SEC, now) &&
1699 atomic64_cmpxchg(&blkg->delay_start, old, now) == old) {
1700 u64 cur = atomic64_read(&blkg->delay_nsec);
1701 u64 sub = min_t(u64, blkg->last_delay, now - old);
1702 int cur_use = atomic_read(&blkg->use_delay);
1703
1704 /*
1705 * We've been unthrottled, subtract a larger chunk of our
1706 * accumulated delay.
1707 */
1708 if (cur_use < blkg->last_use)
1709 sub = max_t(u64, sub, blkg->last_delay >> 1);
1710
1711 /*
1712 * This shouldn't happen, but handle it anyway. Our delay_nsec
1713 * should only ever be growing except here where we subtract out
1714 * min(last_delay, 1 second), but lord knows bugs happen and I'd
1715 * rather not end up with negative numbers.
1716 */
1717 if (unlikely(cur < sub)) {
1718 atomic64_set(&blkg->delay_nsec, 0);
1719 blkg->last_delay = 0;
1720 } else {
1721 atomic64_sub(sub, &blkg->delay_nsec);
1722 blkg->last_delay = cur - sub;
1723 }
1724 blkg->last_use = cur_use;
1725 }
1726}
1727
1728/*
1729 * This is called when we want to actually walk up the hierarchy and check to
1730 * see if we need to throttle, and then actually throttle if there is some
1731 * accumulated delay. This should only be called upon return to user space so
1732 * we're not holding some lock that would induce a priority inversion.
1733 */
1734static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1735{
fd112c74 1736 unsigned long pflags;
5160a5a5 1737 bool clamp;
d09d8df3
JB
1738 u64 now = ktime_to_ns(ktime_get());
1739 u64 exp;
1740 u64 delay_nsec = 0;
1741 int tok;
1742
1743 while (blkg->parent) {
5160a5a5
TH
1744 int use_delay = atomic_read(&blkg->use_delay);
1745
1746 if (use_delay) {
1747 u64 this_delay;
1748
d09d8df3 1749 blkcg_scale_delay(blkg, now);
5160a5a5
TH
1750 this_delay = atomic64_read(&blkg->delay_nsec);
1751 if (this_delay > delay_nsec) {
1752 delay_nsec = this_delay;
1753 clamp = use_delay > 0;
1754 }
d09d8df3
JB
1755 }
1756 blkg = blkg->parent;
1757 }
1758
1759 if (!delay_nsec)
1760 return;
1761
1762 /*
1763 * Let's not sleep for all eternity if we've amassed a huge delay.
1764 * Swapping or metadata IO can accumulate 10's of seconds worth of
1765 * delay, and we want userspace to be able to do _something_ so cap the
5160a5a5
TH
1766 * delays at 0.25s. If there's 10's of seconds worth of delay then the
1767 * tasks will be delayed for 0.25 second for every syscall. If
1768 * blkcg_set_delay() was used as indicated by negative use_delay, the
1769 * caller is responsible for regulating the range.
d09d8df3 1770 */
5160a5a5
TH
1771 if (clamp)
1772 delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
d09d8df3 1773
fd112c74
JB
1774 if (use_memdelay)
1775 psi_memstall_enter(&pflags);
d09d8df3
JB
1776
1777 exp = ktime_add_ns(now, delay_nsec);
1778 tok = io_schedule_prepare();
1779 do {
1780 __set_current_state(TASK_KILLABLE);
1781 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1782 break;
1783 } while (!fatal_signal_pending(current));
1784 io_schedule_finish(tok);
fd112c74
JB
1785
1786 if (use_memdelay)
1787 psi_memstall_leave(&pflags);
d09d8df3
JB
1788}
1789
1790/**
1791 * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1792 *
1793 * This is only called if we've been marked with set_notify_resume(). Obviously
1794 * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1795 * check to see if current->throttle_queue is set and if not this doesn't do
1796 * anything. This should only ever be called by the resume code, it's not meant
1797 * to be called by people willy-nilly as it will actually do the work to
1798 * throttle the task if it is setup for throttling.
1799 */
1800void blkcg_maybe_throttle_current(void)
1801{
1802 struct request_queue *q = current->throttle_queue;
d09d8df3
JB
1803 struct blkcg *blkcg;
1804 struct blkcg_gq *blkg;
1805 bool use_memdelay = current->use_memdelay;
1806
1807 if (!q)
1808 return;
1809
1810 current->throttle_queue = NULL;
1811 current->use_memdelay = false;
1812
1813 rcu_read_lock();
82778259 1814 blkcg = css_to_blkcg(blkcg_css());
d09d8df3
JB
1815 if (!blkcg)
1816 goto out;
1817 blkg = blkg_lookup(blkcg, q);
1818 if (!blkg)
1819 goto out;
7754f669 1820 if (!blkg_tryget(blkg))
d09d8df3
JB
1821 goto out;
1822 rcu_read_unlock();
d09d8df3
JB
1823
1824 blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1825 blkg_put(blkg);
cc7ecc25 1826 blk_put_queue(q);
d09d8df3
JB
1827 return;
1828out:
1829 rcu_read_unlock();
1830 blk_put_queue(q);
1831}
d09d8df3
JB
1832
1833/**
1834 * blkcg_schedule_throttle - this task needs to check for throttling
537d71b3
BVA
1835 * @q: the request queue IO was submitted on
1836 * @use_memdelay: do we charge this to memory delay for PSI
d09d8df3
JB
1837 *
1838 * This is called by the IO controller when we know there's delay accumulated
1839 * for the blkg for this task. We do not pass the blkg because there are places
1840 * we call this that may not have that information, the swapping code for
1841 * instance will only have a request_queue at that point. This set's the
1842 * notify_resume for the task to check and see if it requires throttling before
1843 * returning to user space.
1844 *
1845 * We will only schedule once per syscall. You can call this over and over
1846 * again and it will only do the check once upon return to user space, and only
1847 * throttle once. If the task needs to be throttled again it'll need to be
1848 * re-set at the next time we see the task.
1849 */
1850void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay)
1851{
1852 if (unlikely(current->flags & PF_KTHREAD))
1853 return;
1854
49d1822b
CX
1855 if (current->throttle_queue != q) {
1856 if (!blk_get_queue(q))
1857 return;
1858
1859 if (current->throttle_queue)
1860 blk_put_queue(current->throttle_queue);
1861 current->throttle_queue = q;
1862 }
d09d8df3 1863
d09d8df3
JB
1864 if (use_memdelay)
1865 current->use_memdelay = use_memdelay;
1866 set_notify_resume(current);
1867}
d09d8df3
JB
1868
1869/**
1870 * blkcg_add_delay - add delay to this blkg
537d71b3
BVA
1871 * @blkg: blkg of interest
1872 * @now: the current time in nanoseconds
1873 * @delta: how many nanoseconds of delay to add
d09d8df3
JB
1874 *
1875 * Charge @delta to the blkg's current delay accumulation. This is used to
1876 * throttle tasks if an IO controller thinks we need more throttling.
1877 */
1878void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1879{
54c52e10
TH
1880 if (WARN_ON_ONCE(atomic_read(&blkg->use_delay) < 0))
1881 return;
d09d8df3
JB
1882 blkcg_scale_delay(blkg, now);
1883 atomic64_add(delta, &blkg->delay_nsec);
1884}
d09d8df3 1885
28fc591f
CH
1886/**
1887 * blkg_tryget_closest - try and get a blkg ref on the closet blkg
13c7863d
CH
1888 * @bio: target bio
1889 * @css: target css
28fc591f 1890 *
13c7863d
CH
1891 * As the failure mode here is to walk up the blkg tree, this ensure that the
1892 * blkg->parent pointers are always valid. This returns the blkg that it ended
1893 * up taking a reference on or %NULL if no reference was taken.
28fc591f 1894 */
13c7863d
CH
1895static inline struct blkcg_gq *blkg_tryget_closest(struct bio *bio,
1896 struct cgroup_subsys_state *css)
28fc591f 1897{
13c7863d 1898 struct blkcg_gq *blkg, *ret_blkg = NULL;
28fc591f 1899
13c7863d 1900 rcu_read_lock();
309dca30 1901 blkg = blkg_lookup_create(css_to_blkcg(css),
ed6cddef 1902 bdev_get_queue(bio->bi_bdev));
28fc591f
CH
1903 while (blkg) {
1904 if (blkg_tryget(blkg)) {
1905 ret_blkg = blkg;
1906 break;
1907 }
1908 blkg = blkg->parent;
1909 }
13c7863d 1910 rcu_read_unlock();
28fc591f
CH
1911
1912 return ret_blkg;
1913}
1914
1915/**
1916 * bio_associate_blkg_from_css - associate a bio with a specified css
1917 * @bio: target bio
1918 * @css: target css
1919 *
1920 * Associate @bio with the blkg found by combining the css's blkg and the
1921 * request_queue of the @bio. An association failure is handled by walking up
1922 * the blkg tree. Therefore, the blkg associated can be anything between @blkg
1923 * and q->root_blkg. This situation only happens when a cgroup is dying and
1924 * then the remaining bios will spill to the closest alive blkg.
1925 *
1926 * A reference will be taken on the blkg and will be released when @bio is
1927 * freed.
1928 */
1929void bio_associate_blkg_from_css(struct bio *bio,
1930 struct cgroup_subsys_state *css)
1931{
28fc591f
CH
1932 if (bio->bi_blkg)
1933 blkg_put(bio->bi_blkg);
1934
a5b97526 1935 if (css && css->parent) {
13c7863d 1936 bio->bi_blkg = blkg_tryget_closest(bio, css);
a5b97526 1937 } else {
ed6cddef
PB
1938 blkg_get(bdev_get_queue(bio->bi_bdev)->root_blkg);
1939 bio->bi_blkg = bdev_get_queue(bio->bi_bdev)->root_blkg;
a5b97526 1940 }
28fc591f
CH
1941}
1942EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
1943
1944/**
1945 * bio_associate_blkg - associate a bio with a blkg
1946 * @bio: target bio
1947 *
1948 * Associate @bio with the blkg found from the bio's css and request_queue.
1949 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
1950 * already associated, the css is reused and association redone as the
1951 * request_queue may have changed.
1952 */
1953void bio_associate_blkg(struct bio *bio)
1954{
1955 struct cgroup_subsys_state *css;
1956
1957 rcu_read_lock();
1958
1959 if (bio->bi_blkg)
bbb1ebe7 1960 css = bio_blkcg_css(bio);
28fc591f
CH
1961 else
1962 css = blkcg_css();
1963
1964 bio_associate_blkg_from_css(bio, css);
1965
1966 rcu_read_unlock();
1967}
1968EXPORT_SYMBOL_GPL(bio_associate_blkg);
1969
1970/**
1971 * bio_clone_blkg_association - clone blkg association from src to dst bio
1972 * @dst: destination bio
1973 * @src: source bio
1974 */
1975void bio_clone_blkg_association(struct bio *dst, struct bio *src)
1976{
22b106e5
JK
1977 if (src->bi_blkg)
1978 bio_associate_blkg_from_css(dst, bio_blkcg_css(src));
28fc591f
CH
1979}
1980EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
1981
db18a53e
CH
1982static int blk_cgroup_io_type(struct bio *bio)
1983{
1984 if (op_is_discard(bio->bi_opf))
1985 return BLKG_IOSTAT_DISCARD;
1986 if (op_is_write(bio->bi_opf))
1987 return BLKG_IOSTAT_WRITE;
1988 return BLKG_IOSTAT_READ;
1989}
1990
1991void blk_cgroup_bio_start(struct bio *bio)
1992{
1993 int rwd = blk_cgroup_io_type(bio), cpu;
1994 struct blkg_iostat_set *bis;
3c08b093 1995 unsigned long flags;
db18a53e
CH
1996
1997 cpu = get_cpu();
1998 bis = per_cpu_ptr(bio->bi_blkg->iostat_cpu, cpu);
3c08b093 1999 flags = u64_stats_update_begin_irqsave(&bis->sync);
db18a53e
CH
2000
2001 /*
2002 * If the bio is flagged with BIO_CGROUP_ACCT it means this is a split
2003 * bio and we would have already accounted for the size of the bio.
2004 */
2005 if (!bio_flagged(bio, BIO_CGROUP_ACCT)) {
2006 bio_set_flag(bio, BIO_CGROUP_ACCT);
0b8cc25d 2007 bis->cur.bytes[rwd] += bio->bi_iter.bi_size;
db18a53e
CH
2008 }
2009 bis->cur.ios[rwd]++;
2010
3c08b093 2011 u64_stats_update_end_irqrestore(&bis->sync, flags);
db18a53e
CH
2012 if (cgroup_subsys_on_dfl(io_cgrp_subsys))
2013 cgroup_rstat_updated(bio->bi_blkg->blkcg->css.cgroup, cpu);
2014 put_cpu();
2015}
2016
216889aa
CH
2017bool blk_cgroup_congested(void)
2018{
2019 struct cgroup_subsys_state *css;
2020 bool ret = false;
2021
2022 rcu_read_lock();
d200ca14 2023 for (css = blkcg_css(); css; css = css->parent) {
216889aa
CH
2024 if (atomic_read(&css->cgroup->congestion_count)) {
2025 ret = true;
2026 break;
2027 }
216889aa
CH
2028 }
2029 rcu_read_unlock();
2030 return ret;
2031}
2032
d3f77dfd
TH
2033static int __init blkcg_init(void)
2034{
2035 blkcg_punt_bio_wq = alloc_workqueue("blkcg_punt_bio",
2036 WQ_MEM_RECLAIM | WQ_FREEZABLE |
2037 WQ_UNBOUND | WQ_SYSFS, 0);
2038 if (!blkcg_punt_bio_wq)
2039 return -ENOMEM;
2040 return 0;
2041}
2042subsys_initcall(blkcg_init);
2043
903d23f0
JB
2044module_param(blkcg_debug_stats, bool, 0644);
2045MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");