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