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