]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - block/blk-cgroup.c
blk-cgroup: Fix memleak on error path
[mirror_ubuntu-jammy-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
TH
558/**
559 * blkg_conf_prep - parse and prepare for per-blkg config update
560 * @inputp: input string pointer
561 *
562 * Parse the device node prefix part, MAJ:MIN, of per-blkg config update
563 * from @input and get and return the matching gendisk. *@inputp is
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 */
569struct gendisk *blkcg_conf_get_disk(char **inputp)
570{
571 char *input = *inputp;
572 unsigned int major, minor;
573 struct gendisk *disk;
574 int key_len, part;
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
584 disk = get_gendisk(MKDEV(major, minor), &part);
585 if (!disk)
586 return ERR_PTR(-ENODEV);
587 if (part) {
588 put_disk_and_module(disk);
589 return ERR_PTR(-ENODEV);
590 }
591
592 *inputp = input;
593 return disk;
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)
0d945c1f 610 __acquires(rcu) __acquires(&disk->queue->queue_lock)
34d0f179 611{
3a8b31d3 612 struct gendisk *disk;
457e490f 613 struct request_queue *q;
3c798398 614 struct blkcg_gq *blkg;
015d254c 615 int ret;
36aa9e5f 616
015d254c
TH
617 disk = blkcg_conf_get_disk(&input);
618 if (IS_ERR(disk))
619 return PTR_ERR(disk);
e56da7e2 620
457e490f 621 q = 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
457e490f 660 rcu_read_lock();
0d945c1f 661 spin_lock_irq(&q->queue_lock);
457e490f
TE
662
663 blkg = blkg_lookup_check(pos, pol, q);
664 if (IS_ERR(blkg)) {
665 ret = PTR_ERR(blkg);
52abfcbd 666 blkg_free(new_blkg);
457e490f
TE
667 goto fail_unlock;
668 }
669
670 if (blkg) {
671 blkg_free(new_blkg);
672 } else {
673 blkg = blkg_create(pos, q, new_blkg);
98d669b4 674 if (IS_ERR(blkg)) {
457e490f
TE
675 ret = PTR_ERR(blkg);
676 goto fail_unlock;
677 }
678 }
679
680 if (pos == blkcg)
681 goto success;
682 }
683success:
3a8b31d3
TH
684 ctx->disk = disk;
685 ctx->blkg = blkg;
015d254c 686 ctx->body = input;
726fa694 687 return 0;
457e490f
TE
688
689fail_unlock:
0d945c1f 690 spin_unlock_irq(&q->queue_lock);
457e490f
TE
691 rcu_read_unlock();
692fail:
9df6c299 693 put_disk_and_module(disk);
457e490f
TE
694 /*
695 * If queue was bypassing, we should retry. Do so after a
696 * short msleep(). It isn't strictly necessary but queue
697 * can be bypassing for some time and it's always nice to
698 * avoid busy looping.
699 */
700 if (ret == -EBUSY) {
701 msleep(10);
702 ret = restart_syscall();
703 }
704 return ret;
34d0f179 705}
89f3b6d6 706EXPORT_SYMBOL_GPL(blkg_conf_prep);
34d0f179 707
3a8b31d3
TH
708/**
709 * blkg_conf_finish - finish up per-blkg config update
710 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
711 *
712 * Finish up after per-blkg config update. This function must be paired
713 * with blkg_conf_prep().
714 */
829fdb50 715void blkg_conf_finish(struct blkg_conf_ctx *ctx)
0d945c1f 716 __releases(&ctx->disk->queue->queue_lock) __releases(rcu)
34d0f179 717{
0d945c1f 718 spin_unlock_irq(&ctx->disk->queue->queue_lock);
3a8b31d3 719 rcu_read_unlock();
9df6c299 720 put_disk_and_module(ctx->disk);
34d0f179 721}
89f3b6d6 722EXPORT_SYMBOL_GPL(blkg_conf_finish);
34d0f179 723
cd1fc4b9
BB
724static void blkg_iostat_set(struct blkg_iostat *dst, struct blkg_iostat *src)
725{
726 int i;
727
728 for (i = 0; i < BLKG_IOSTAT_NR; i++) {
729 dst->bytes[i] = src->bytes[i];
730 dst->ios[i] = src->ios[i];
731 }
732}
733
734static void blkg_iostat_add(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_sub(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 blkcg_rstat_flush(struct cgroup_subsys_state *css, int cpu)
755{
756 struct blkcg *blkcg = css_to_blkcg(css);
757 struct blkcg_gq *blkg;
758
759 rcu_read_lock();
760
761 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
762 struct blkcg_gq *parent = blkg->parent;
763 struct blkg_iostat_set *bisc = per_cpu_ptr(blkg->iostat_cpu, cpu);
764 struct blkg_iostat cur, delta;
765 unsigned int seq;
766
767 /* fetch the current per-cpu values */
768 do {
769 seq = u64_stats_fetch_begin(&bisc->sync);
770 blkg_iostat_set(&cur, &bisc->cur);
771 } while (u64_stats_fetch_retry(&bisc->sync, seq));
772
773 /* propagate percpu delta to global */
774 u64_stats_update_begin(&blkg->iostat.sync);
775 blkg_iostat_set(&delta, &cur);
776 blkg_iostat_sub(&delta, &bisc->last);
777 blkg_iostat_add(&blkg->iostat.cur, &delta);
778 blkg_iostat_add(&bisc->last, &delta);
779 u64_stats_update_end(&blkg->iostat.sync);
780
781 /* propagate global delta to parent */
782 if (parent) {
783 u64_stats_update_begin(&parent->iostat.sync);
784 blkg_iostat_set(&delta, &blkg->iostat.cur);
785 blkg_iostat_sub(&delta, &blkg->iostat.last);
786 blkg_iostat_add(&parent->iostat.cur, &delta);
787 blkg_iostat_add(&blkg->iostat.last, &delta);
788 u64_stats_update_end(&parent->iostat.sync);
789 }
790 }
791
792 rcu_read_unlock();
793}
794
ef45fe47
BB
795/*
796 * The rstat algorithms intentionally don't handle the root cgroup to avoid
797 * incurring overhead when no cgroups are defined. For that reason,
798 * cgroup_rstat_flush in blkcg_print_stat does not actually fill out the
799 * iostat in the root cgroup's blkcg_gq.
800 *
801 * However, we would like to re-use the printing code between the root and
802 * non-root cgroups to the extent possible. For that reason, we simulate
803 * flushing the root cgroup's stats by explicitly filling in the iostat
804 * with disk level statistics.
805 */
806static void blkcg_fill_root_iostats(void)
807{
808 struct class_dev_iter iter;
809 struct device *dev;
810
811 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
812 while ((dev = class_dev_iter_next(&iter))) {
813 struct gendisk *disk = dev_to_disk(dev);
814 struct hd_struct *part = disk_get_part(disk, 0);
815 struct blkcg_gq *blkg = blk_queue_root_blkg(disk->queue);
816 struct blkg_iostat tmp;
817 int cpu;
818
819 memset(&tmp, 0, sizeof(tmp));
820 for_each_possible_cpu(cpu) {
821 struct disk_stats *cpu_dkstats;
822
823 cpu_dkstats = per_cpu_ptr(part->dkstats, cpu);
824 tmp.ios[BLKG_IOSTAT_READ] +=
825 cpu_dkstats->ios[STAT_READ];
826 tmp.ios[BLKG_IOSTAT_WRITE] +=
827 cpu_dkstats->ios[STAT_WRITE];
828 tmp.ios[BLKG_IOSTAT_DISCARD] +=
829 cpu_dkstats->ios[STAT_DISCARD];
830 // convert sectors to bytes
831 tmp.bytes[BLKG_IOSTAT_READ] +=
832 cpu_dkstats->sectors[STAT_READ] << 9;
833 tmp.bytes[BLKG_IOSTAT_WRITE] +=
834 cpu_dkstats->sectors[STAT_WRITE] << 9;
835 tmp.bytes[BLKG_IOSTAT_DISCARD] +=
836 cpu_dkstats->sectors[STAT_DISCARD] << 9;
837
838 u64_stats_update_begin(&blkg->iostat.sync);
839 blkg_iostat_set(&blkg->iostat.cur, &tmp);
840 u64_stats_update_end(&blkg->iostat.sync);
841 }
842 }
843}
844
2ee867dc
TH
845static int blkcg_print_stat(struct seq_file *sf, void *v)
846{
847 struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
848 struct blkcg_gq *blkg;
849
ef45fe47
BB
850 if (!seq_css(sf)->parent)
851 blkcg_fill_root_iostats();
852 else
853 cgroup_rstat_flush(blkcg->css.cgroup);
854
2ee867dc
TH
855 rcu_read_lock();
856
857 hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
f7331648 858 struct blkg_iostat_set *bis = &blkg->iostat;
2ee867dc 859 const char *dname;
903d23f0 860 char *buf;
636620b6 861 u64 rbytes, wbytes, rios, wios, dbytes, dios;
903d23f0
JB
862 size_t size = seq_get_buf(sf, &buf), off = 0;
863 int i;
864 bool has_stats = false;
f7331648 865 unsigned seq;
2ee867dc 866
b0814361
TH
867 spin_lock_irq(&blkg->q->queue_lock);
868
869 if (!blkg->online)
870 goto skip;
871
2ee867dc
TH
872 dname = blkg_dev_name(blkg);
873 if (!dname)
b0814361 874 goto skip;
2ee867dc 875
903d23f0
JB
876 /*
877 * Hooray string manipulation, count is the size written NOT
878 * INCLUDING THE \0, so size is now count+1 less than what we
879 * had before, but we want to start writing the next bit from
880 * the \0 so we only add count to buf.
881 */
882 off += scnprintf(buf+off, size-off, "%s ", dname);
883
f7331648
TH
884 do {
885 seq = u64_stats_fetch_begin(&bis->sync);
2ee867dc 886
f7331648
TH
887 rbytes = bis->cur.bytes[BLKG_IOSTAT_READ];
888 wbytes = bis->cur.bytes[BLKG_IOSTAT_WRITE];
889 dbytes = bis->cur.bytes[BLKG_IOSTAT_DISCARD];
890 rios = bis->cur.ios[BLKG_IOSTAT_READ];
891 wios = bis->cur.ios[BLKG_IOSTAT_WRITE];
892 dios = bis->cur.ios[BLKG_IOSTAT_DISCARD];
893 } while (u64_stats_fetch_retry(&bis->sync, seq));
2ee867dc 894
903d23f0
JB
895 if (rbytes || wbytes || rios || wios) {
896 has_stats = true;
897 off += scnprintf(buf+off, size-off,
636620b6
TH
898 "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
899 rbytes, wbytes, rios, wios,
900 dbytes, dios);
903d23f0
JB
901 }
902
07b0fdec 903 if (blkcg_debug_stats && atomic_read(&blkg->use_delay)) {
d09d8df3
JB
904 has_stats = true;
905 off += scnprintf(buf+off, size-off,
906 " use_delay=%d delay_nsec=%llu",
907 atomic_read(&blkg->use_delay),
908 (unsigned long long)atomic64_read(&blkg->delay_nsec));
909 }
910
903d23f0
JB
911 for (i = 0; i < BLKCG_MAX_POLS; i++) {
912 struct blkcg_policy *pol = blkcg_policy[i];
913 size_t written;
914
915 if (!blkg->pd[i] || !pol->pd_stat_fn)
916 continue;
917
918 written = pol->pd_stat_fn(blkg->pd[i], buf+off, size-off);
919 if (written)
920 has_stats = true;
921 off += written;
922 }
07b0fdec 923
903d23f0 924 if (has_stats) {
f539da82
TH
925 if (off < size - 1) {
926 off += scnprintf(buf+off, size-off, "\n");
927 seq_commit(sf, off);
928 } else {
929 seq_commit(sf, -1);
930 }
903d23f0 931 }
b0814361
TH
932 skip:
933 spin_unlock_irq(&blkg->q->queue_lock);
2ee867dc
TH
934 }
935
936 rcu_read_unlock();
937 return 0;
938}
939
e1f3b941 940static struct cftype blkcg_files[] = {
2ee867dc
TH
941 {
942 .name = "stat",
943 .seq_show = blkcg_print_stat,
944 },
945 { } /* terminate */
946};
947
e1f3b941 948static struct cftype blkcg_legacy_files[] = {
84c124da
DS
949 {
950 .name = "reset_stats",
3c798398 951 .write_u64 = blkcg_reset_stats,
22084190 952 },
4baf6e33 953 { } /* terminate */
31e4c28d
VG
954};
955
59b57717
DZF
956/*
957 * blkcg destruction is a three-stage process.
958 *
959 * 1. Destruction starts. The blkcg_css_offline() callback is invoked
960 * which offlines writeback. Here we tie the next stage of blkg destruction
961 * to the completion of writeback associated with the blkcg. This lets us
962 * avoid punting potentially large amounts of outstanding writeback to root
963 * while maintaining any ongoing policies. The next stage is triggered when
964 * the nr_cgwbs count goes to zero.
965 *
966 * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
967 * and handles the destruction of blkgs. Here the css reference held by
968 * the blkg is put back eventually allowing blkcg_css_free() to be called.
969 * This work may occur in cgwb_release_workfn() on the cgwb_release
970 * workqueue. Any submitted ios that fail to get the blkg ref will be
971 * punted to the root_blkg.
972 *
973 * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
974 * This finally frees the blkcg.
975 */
976
9f13ef67 977/**
92fb9748 978 * blkcg_css_offline - cgroup css_offline callback
eb95419b 979 * @css: css of interest
9f13ef67 980 *
59b57717
DZF
981 * This function is called when @css is about to go away. Here the cgwbs are
982 * offlined first and only once writeback associated with the blkcg has
983 * finished do we start step 2 (see above).
9f13ef67 984 */
eb95419b 985static void blkcg_css_offline(struct cgroup_subsys_state *css)
31e4c28d 986{
eb95419b 987 struct blkcg *blkcg = css_to_blkcg(css);
b1c35769 988
59b57717
DZF
989 /* this prevents anyone from attaching or migrating to this blkcg */
990 wb_blkcg_offline(blkcg);
991
d866dbf6
TH
992 /* put the base online pin allowing step 2 to be triggered */
993 blkcg_unpin_online(blkcg);
59b57717
DZF
994}
995
996/**
997 * blkcg_destroy_blkgs - responsible for shooting down blkgs
998 * @blkcg: blkcg of interest
999 *
1000 * blkgs should be removed while holding both q and blkcg locks. As blkcg lock
1001 * is nested inside q lock, this function performs reverse double lock dancing.
1002 * Destroying the blkgs releases the reference held on the blkcg's css allowing
1003 * blkcg_css_free to eventually be called.
1004 *
1005 * This is the blkcg counterpart of ioc_release_fn().
1006 */
1007void blkcg_destroy_blkgs(struct blkcg *blkcg)
1008{
9f13ef67 1009 spin_lock_irq(&blkcg->lock);
7ee9c562 1010
4c699480
JQ
1011 while (!hlist_empty(&blkcg->blkg_list)) {
1012 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
6b065462 1013 struct blkcg_gq, blkcg_node);
4c699480
JQ
1014 struct request_queue *q = blkg->q;
1015
0d945c1f 1016 if (spin_trylock(&q->queue_lock)) {
4c699480 1017 blkg_destroy(blkg);
0d945c1f 1018 spin_unlock(&q->queue_lock);
4c699480
JQ
1019 } else {
1020 spin_unlock_irq(&blkcg->lock);
1021 cpu_relax();
1022 spin_lock_irq(&blkcg->lock);
1023 }
1024 }
6b065462 1025
4c699480
JQ
1026 spin_unlock_irq(&blkcg->lock);
1027}
1028
eb95419b 1029static void blkcg_css_free(struct cgroup_subsys_state *css)
7ee9c562 1030{
eb95419b 1031 struct blkcg *blkcg = css_to_blkcg(css);
bc915e61 1032 int i;
7ee9c562 1033
7876f930 1034 mutex_lock(&blkcg_pol_mutex);
e4a9bde9 1035
7876f930 1036 list_del(&blkcg->all_blkcgs_node);
7876f930 1037
bc915e61 1038 for (i = 0; i < BLKCG_MAX_POLS; i++)
e4a9bde9
TH
1039 if (blkcg->cpd[i])
1040 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1041
1042 mutex_unlock(&blkcg_pol_mutex);
1043
bc915e61 1044 kfree(blkcg);
31e4c28d
VG
1045}
1046
eb95419b
TH
1047static struct cgroup_subsys_state *
1048blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
31e4c28d 1049{
3c798398 1050 struct blkcg *blkcg;
e48453c3
AA
1051 struct cgroup_subsys_state *ret;
1052 int i;
31e4c28d 1053
7876f930
TH
1054 mutex_lock(&blkcg_pol_mutex);
1055
eb95419b 1056 if (!parent_css) {
3c798398 1057 blkcg = &blkcg_root;
bc915e61
TH
1058 } else {
1059 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1060 if (!blkcg) {
1061 ret = ERR_PTR(-ENOMEM);
4c18c9e9 1062 goto unlock;
bc915e61 1063 }
e48453c3
AA
1064 }
1065
1066 for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1067 struct blkcg_policy *pol = blkcg_policy[i];
1068 struct blkcg_policy_data *cpd;
1069
1070 /*
1071 * If the policy hasn't been attached yet, wait for it
1072 * to be attached before doing anything else. Otherwise,
1073 * check if the policy requires any specific per-cgroup
1074 * data: if it does, allocate and initialize it.
1075 */
e4a9bde9 1076 if (!pol || !pol->cpd_alloc_fn)
e48453c3
AA
1077 continue;
1078
e4a9bde9 1079 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
e48453c3
AA
1080 if (!cpd) {
1081 ret = ERR_PTR(-ENOMEM);
1082 goto free_pd_blkcg;
1083 }
81437648
TH
1084 blkcg->cpd[i] = cpd;
1085 cpd->blkcg = blkcg;
e48453c3 1086 cpd->plid = i;
e4a9bde9
TH
1087 if (pol->cpd_init_fn)
1088 pol->cpd_init_fn(cpd);
e48453c3 1089 }
31e4c28d 1090
31e4c28d 1091 spin_lock_init(&blkcg->lock);
d866dbf6 1092 refcount_set(&blkcg->online_pin, 1);
e00f4f4d 1093 INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
31e4c28d 1094 INIT_HLIST_HEAD(&blkcg->blkg_list);
52ebea74
TH
1095#ifdef CONFIG_CGROUP_WRITEBACK
1096 INIT_LIST_HEAD(&blkcg->cgwb_list);
1097#endif
7876f930
TH
1098 list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1099
1100 mutex_unlock(&blkcg_pol_mutex);
31e4c28d 1101 return &blkcg->css;
e48453c3
AA
1102
1103free_pd_blkcg:
1104 for (i--; i >= 0; i--)
e4a9bde9
TH
1105 if (blkcg->cpd[i])
1106 blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
4c18c9e9 1107
1108 if (blkcg != &blkcg_root)
1109 kfree(blkcg);
1110unlock:
7876f930 1111 mutex_unlock(&blkcg_pol_mutex);
e48453c3 1112 return ret;
31e4c28d
VG
1113}
1114
4308a434
TH
1115static int blkcg_css_online(struct cgroup_subsys_state *css)
1116{
1117 struct blkcg *blkcg = css_to_blkcg(css);
1118 struct blkcg *parent = blkcg_parent(blkcg);
1119
1120 /*
1121 * blkcg_pin_online() is used to delay blkcg offline so that blkgs
1122 * don't go offline while cgwbs are still active on them. Pin the
1123 * parent so that offline always happens towards the root.
1124 */
1125 if (parent)
1126 blkcg_pin_online(parent);
1127 return 0;
1128}
1129
5efd6113
TH
1130/**
1131 * blkcg_init_queue - initialize blkcg part of request queue
1132 * @q: request_queue to initialize
1133 *
c62b37d9 1134 * Called from blk_alloc_queue(). Responsible for initializing blkcg
5efd6113
TH
1135 * part of new request_queue @q.
1136 *
1137 * RETURNS:
1138 * 0 on success, -errno on failure.
1139 */
1140int blkcg_init_queue(struct request_queue *q)
1141{
d708f0d5
JA
1142 struct blkcg_gq *new_blkg, *blkg;
1143 bool preloaded;
ec13b1d6
TH
1144 int ret;
1145
d708f0d5
JA
1146 new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
1147 if (!new_blkg)
1148 return -ENOMEM;
1149
1150 preloaded = !radix_tree_preload(GFP_KERNEL);
1151
bea54883 1152 /* Make sure the root blkg exists. */
ec13b1d6 1153 rcu_read_lock();
0d945c1f 1154 spin_lock_irq(&q->queue_lock);
d708f0d5 1155 blkg = blkg_create(&blkcg_root, q, new_blkg);
901932a3
JB
1156 if (IS_ERR(blkg))
1157 goto err_unlock;
1158 q->root_blkg = blkg;
0d945c1f 1159 spin_unlock_irq(&q->queue_lock);
ec13b1d6
TH
1160 rcu_read_unlock();
1161
d708f0d5
JA
1162 if (preloaded)
1163 radix_tree_preload_end();
1164
27029b4b 1165 ret = blk_throtl_init(q);
04be60b5
CH
1166 if (ret)
1167 goto err_destroy_all;
d7067512 1168
27029b4b
YY
1169 ret = blk_iolatency_init(q);
1170 if (ret) {
1171 blk_throtl_exit(q);
04be60b5 1172 goto err_destroy_all;
27029b4b 1173 }
04be60b5 1174 return 0;
901932a3 1175
04be60b5 1176err_destroy_all:
04be60b5 1177 blkg_destroy_all(q);
04be60b5 1178 return ret;
901932a3 1179err_unlock:
0d945c1f 1180 spin_unlock_irq(&q->queue_lock);
901932a3
JB
1181 rcu_read_unlock();
1182 if (preloaded)
1183 radix_tree_preload_end();
1184 return PTR_ERR(blkg);
5efd6113
TH
1185}
1186
5efd6113
TH
1187/**
1188 * blkcg_exit_queue - exit and release blkcg part of request_queue
1189 * @q: request_queue being released
1190 *
7585d508 1191 * Called from blk_exit_queue(). Responsible for exiting blkcg part.
5efd6113
TH
1192 */
1193void blkcg_exit_queue(struct request_queue *q)
1194{
3c96cb32 1195 blkg_destroy_all(q);
5efd6113
TH
1196 blk_throtl_exit(q);
1197}
1198
31e4c28d
VG
1199/*
1200 * We cannot support shared io contexts, as we have no mean to support
1201 * two tasks with the same ioc in two different groups without major rework
1202 * of the main cic data structures. For now we allow a task to change
1203 * its cgroup only if it's the only owner of its ioc.
1204 */
1f7dd3e5 1205static int blkcg_can_attach(struct cgroup_taskset *tset)
31e4c28d 1206{
bb9d97b6 1207 struct task_struct *task;
1f7dd3e5 1208 struct cgroup_subsys_state *dst_css;
31e4c28d
VG
1209 struct io_context *ioc;
1210 int ret = 0;
1211
1212 /* task_lock() is needed to avoid races with exit_io_context() */
1f7dd3e5 1213 cgroup_taskset_for_each(task, dst_css, tset) {
bb9d97b6
TH
1214 task_lock(task);
1215 ioc = task->io_context;
1216 if (ioc && atomic_read(&ioc->nr_tasks) > 1)
1217 ret = -EINVAL;
1218 task_unlock(task);
1219 if (ret)
1220 break;
1221 }
31e4c28d
VG
1222 return ret;
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,
3c798398 1257 .can_attach = blkcg_can_attach,
f7331648 1258 .css_rstat_flush = blkcg_rstat_flush,
69d7fde5 1259 .bind = blkcg_bind,
2ee867dc 1260 .dfl_cftypes = blkcg_files,
880f50e2 1261 .legacy_cftypes = blkcg_legacy_files,
c165b3e3 1262 .legacy_name = "blkio",
d09d8df3 1263 .exit = blkcg_exit,
1ced953b
TH
1264#ifdef CONFIG_MEMCG
1265 /*
1266 * This ensures that, if available, memcg is automatically enabled
1267 * together on the default hierarchy so that the owner cgroup can
1268 * be retrieved from writeback pages.
1269 */
1270 .depends_on = 1 << memory_cgrp_id,
1271#endif
676f7c8f 1272};
c165b3e3 1273EXPORT_SYMBOL_GPL(io_cgrp_subsys);
676f7c8f 1274
a2b1693b
TH
1275/**
1276 * blkcg_activate_policy - activate a blkcg policy on a request_queue
1277 * @q: request_queue of interest
1278 * @pol: blkcg policy to activate
1279 *
1280 * Activate @pol on @q. Requires %GFP_KERNEL context. @q goes through
1281 * bypass mode to populate its blkgs with policy_data for @pol.
1282 *
1283 * Activation happens with @q bypassed, so nobody would be accessing blkgs
1284 * from IO path. Update of each blkg is protected by both queue and blkcg
1285 * locks so that holding either lock and testing blkcg_policy_enabled() is
1286 * always enough for dereferencing policy data.
1287 *
1288 * The caller is responsible for synchronizing [de]activations and policy
1289 * [un]registerations. Returns 0 on success, -errno on failure.
1290 */
1291int blkcg_activate_policy(struct request_queue *q,
3c798398 1292 const struct blkcg_policy *pol)
a2b1693b 1293{
4c55f4f9 1294 struct blkg_policy_data *pd_prealloc = NULL;
9d179b86 1295 struct blkcg_gq *blkg, *pinned_blkg = NULL;
4c55f4f9 1296 int ret;
a2b1693b
TH
1297
1298 if (blkcg_policy_enabled(q, pol))
1299 return 0;
1300
344e9ffc 1301 if (queue_is_mq(q))
bd166ef1 1302 blk_mq_freeze_queue(q);
9d179b86 1303retry:
0d945c1f 1304 spin_lock_irq(&q->queue_lock);
a2b1693b 1305
9d179b86 1306 /* blkg_list is pushed at the head, reverse walk to allocate parents first */
71c81407 1307 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node) {
4c55f4f9
TH
1308 struct blkg_policy_data *pd;
1309
1310 if (blkg->pd[pol->plid])
1311 continue;
a2b1693b 1312
9d179b86
TH
1313 /* If prealloc matches, use it; otherwise try GFP_NOWAIT */
1314 if (blkg == pinned_blkg) {
1315 pd = pd_prealloc;
1316 pd_prealloc = NULL;
1317 } else {
1318 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q,
1319 blkg->blkcg);
1320 }
1321
4c55f4f9 1322 if (!pd) {
9d179b86
TH
1323 /*
1324 * GFP_NOWAIT failed. Free the existing one and
1325 * prealloc for @blkg w/ GFP_KERNEL.
1326 */
1327 if (pinned_blkg)
1328 blkg_put(pinned_blkg);
1329 blkg_get(blkg);
1330 pinned_blkg = blkg;
1331
0d945c1f 1332 spin_unlock_irq(&q->queue_lock);
9d179b86
TH
1333
1334 if (pd_prealloc)
1335 pol->pd_free_fn(pd_prealloc);
1336 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q,
1337 blkg->blkcg);
1338 if (pd_prealloc)
1339 goto retry;
1340 else
1341 goto enomem;
4c55f4f9 1342 }
a2b1693b
TH
1343
1344 blkg->pd[pol->plid] = pd;
1345 pd->blkg = blkg;
b276a876 1346 pd->plid = pol->plid;
a2b1693b
TH
1347 }
1348
9d179b86
TH
1349 /* all allocated, init in the same order */
1350 if (pol->pd_init_fn)
1351 list_for_each_entry_reverse(blkg, &q->blkg_list, q_node)
1352 pol->pd_init_fn(blkg->pd[pol->plid]);
1353
a2b1693b
TH
1354 __set_bit(pol->plid, q->blkcg_pols);
1355 ret = 0;
4c55f4f9 1356
0d945c1f 1357 spin_unlock_irq(&q->queue_lock);
9d179b86 1358out:
344e9ffc 1359 if (queue_is_mq(q))
bd166ef1 1360 blk_mq_unfreeze_queue(q);
9d179b86
TH
1361 if (pinned_blkg)
1362 blkg_put(pinned_blkg);
001bea73
TH
1363 if (pd_prealloc)
1364 pol->pd_free_fn(pd_prealloc);
a2b1693b 1365 return ret;
9d179b86
TH
1366
1367enomem:
1368 /* alloc failed, nothing's initialized yet, free everything */
1369 spin_lock_irq(&q->queue_lock);
1370 list_for_each_entry(blkg, &q->blkg_list, q_node) {
1371 if (blkg->pd[pol->plid]) {
1372 pol->pd_free_fn(blkg->pd[pol->plid]);
1373 blkg->pd[pol->plid] = NULL;
1374 }
1375 }
1376 spin_unlock_irq(&q->queue_lock);
1377 ret = -ENOMEM;
1378 goto out;
a2b1693b
TH
1379}
1380EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1381
1382/**
1383 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1384 * @q: request_queue of interest
1385 * @pol: blkcg policy to deactivate
1386 *
1387 * Deactivate @pol on @q. Follows the same synchronization rules as
1388 * blkcg_activate_policy().
1389 */
1390void blkcg_deactivate_policy(struct request_queue *q,
3c798398 1391 const struct blkcg_policy *pol)
a2b1693b 1392{
3c798398 1393 struct blkcg_gq *blkg;
a2b1693b
TH
1394
1395 if (!blkcg_policy_enabled(q, pol))
1396 return;
1397
344e9ffc 1398 if (queue_is_mq(q))
bd166ef1 1399 blk_mq_freeze_queue(q);
bd166ef1 1400
0d945c1f 1401 spin_lock_irq(&q->queue_lock);
a2b1693b
TH
1402
1403 __clear_bit(pol->plid, q->blkcg_pols);
1404
1405 list_for_each_entry(blkg, &q->blkg_list, q_node) {
001bea73 1406 if (blkg->pd[pol->plid]) {
6b065462 1407 if (pol->pd_offline_fn)
a9520cd6 1408 pol->pd_offline_fn(blkg->pd[pol->plid]);
001bea73
TH
1409 pol->pd_free_fn(blkg->pd[pol->plid]);
1410 blkg->pd[pol->plid] = NULL;
1411 }
a2b1693b
TH
1412 }
1413
0d945c1f 1414 spin_unlock_irq(&q->queue_lock);
bd166ef1 1415
344e9ffc 1416 if (queue_is_mq(q))
bd166ef1 1417 blk_mq_unfreeze_queue(q);
a2b1693b
TH
1418}
1419EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1420
8bd435b3 1421/**
3c798398
TH
1422 * blkcg_policy_register - register a blkcg policy
1423 * @pol: blkcg policy to register
8bd435b3 1424 *
3c798398
TH
1425 * Register @pol with blkcg core. Might sleep and @pol may be modified on
1426 * successful registration. Returns 0 on success and -errno on failure.
8bd435b3 1427 */
d5bf0291 1428int blkcg_policy_register(struct blkcg_policy *pol)
3e252066 1429{
06b285bd 1430 struct blkcg *blkcg;
8bd435b3 1431 int i, ret;
e8989fae 1432
838f13bf 1433 mutex_lock(&blkcg_pol_register_mutex);
bc0d6501
TH
1434 mutex_lock(&blkcg_pol_mutex);
1435
8bd435b3
TH
1436 /* find an empty slot */
1437 ret = -ENOSPC;
1438 for (i = 0; i < BLKCG_MAX_POLS; i++)
3c798398 1439 if (!blkcg_policy[i])
8bd435b3 1440 break;
01c5f85a
JA
1441 if (i >= BLKCG_MAX_POLS) {
1442 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
838f13bf 1443 goto err_unlock;
01c5f85a 1444 }
035d10b2 1445
e8401073 1446 /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1447 if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1448 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1449 goto err_unlock;
1450
06b285bd 1451 /* register @pol */
3c798398 1452 pol->plid = i;
06b285bd
TH
1453 blkcg_policy[pol->plid] = pol;
1454
1455 /* allocate and install cpd's */
e4a9bde9 1456 if (pol->cpd_alloc_fn) {
06b285bd
TH
1457 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1458 struct blkcg_policy_data *cpd;
1459
e4a9bde9 1460 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
bbb427e3 1461 if (!cpd)
06b285bd 1462 goto err_free_cpds;
06b285bd 1463
81437648
TH
1464 blkcg->cpd[pol->plid] = cpd;
1465 cpd->blkcg = blkcg;
06b285bd 1466 cpd->plid = pol->plid;
86a5bba5
TH
1467 if (pol->cpd_init_fn)
1468 pol->cpd_init_fn(cpd);
06b285bd
TH
1469 }
1470 }
1471
838f13bf 1472 mutex_unlock(&blkcg_pol_mutex);
8bd435b3 1473
8bd435b3 1474 /* everything is in place, add intf files for the new policy */
2ee867dc
TH
1475 if (pol->dfl_cftypes)
1476 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1477 pol->dfl_cftypes));
880f50e2 1478 if (pol->legacy_cftypes)
c165b3e3 1479 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
880f50e2 1480 pol->legacy_cftypes));
838f13bf
TH
1481 mutex_unlock(&blkcg_pol_register_mutex);
1482 return 0;
1483
06b285bd 1484err_free_cpds:
58a9edce 1485 if (pol->cpd_free_fn) {
06b285bd 1486 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
e4a9bde9
TH
1487 if (blkcg->cpd[pol->plid]) {
1488 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1489 blkcg->cpd[pol->plid] = NULL;
1490 }
06b285bd
TH
1491 }
1492 }
1493 blkcg_policy[pol->plid] = NULL;
838f13bf 1494err_unlock:
bc0d6501 1495 mutex_unlock(&blkcg_pol_mutex);
838f13bf 1496 mutex_unlock(&blkcg_pol_register_mutex);
8bd435b3 1497 return ret;
3e252066 1498}
3c798398 1499EXPORT_SYMBOL_GPL(blkcg_policy_register);
3e252066 1500
8bd435b3 1501/**
3c798398
TH
1502 * blkcg_policy_unregister - unregister a blkcg policy
1503 * @pol: blkcg policy to unregister
8bd435b3 1504 *
3c798398 1505 * Undo blkcg_policy_register(@pol). Might sleep.
8bd435b3 1506 */
3c798398 1507void blkcg_policy_unregister(struct blkcg_policy *pol)
3e252066 1508{
06b285bd
TH
1509 struct blkcg *blkcg;
1510
838f13bf 1511 mutex_lock(&blkcg_pol_register_mutex);
bc0d6501 1512
3c798398 1513 if (WARN_ON(blkcg_policy[pol->plid] != pol))
8bd435b3
TH
1514 goto out_unlock;
1515
1516 /* kill the intf files first */
2ee867dc
TH
1517 if (pol->dfl_cftypes)
1518 cgroup_rm_cftypes(pol->dfl_cftypes);
880f50e2
TH
1519 if (pol->legacy_cftypes)
1520 cgroup_rm_cftypes(pol->legacy_cftypes);
44ea53de 1521
06b285bd 1522 /* remove cpds and unregister */
838f13bf 1523 mutex_lock(&blkcg_pol_mutex);
06b285bd 1524
58a9edce 1525 if (pol->cpd_free_fn) {
06b285bd 1526 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
e4a9bde9
TH
1527 if (blkcg->cpd[pol->plid]) {
1528 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1529 blkcg->cpd[pol->plid] = NULL;
1530 }
06b285bd
TH
1531 }
1532 }
3c798398 1533 blkcg_policy[pol->plid] = NULL;
06b285bd 1534
bc0d6501 1535 mutex_unlock(&blkcg_pol_mutex);
838f13bf
TH
1536out_unlock:
1537 mutex_unlock(&blkcg_pol_register_mutex);
3e252066 1538}
3c798398 1539EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
903d23f0 1540
d3f77dfd
TH
1541bool __blkcg_punt_bio_submit(struct bio *bio)
1542{
1543 struct blkcg_gq *blkg = bio->bi_blkg;
1544
1545 /* consume the flag first */
1546 bio->bi_opf &= ~REQ_CGROUP_PUNT;
1547
1548 /* never bounce for the root cgroup */
1549 if (!blkg->parent)
1550 return false;
1551
1552 spin_lock_bh(&blkg->async_bio_lock);
1553 bio_list_add(&blkg->async_bios, bio);
1554 spin_unlock_bh(&blkg->async_bio_lock);
1555
1556 queue_work(blkcg_punt_bio_wq, &blkg->async_bio_work);
1557 return true;
1558}
1559
d09d8df3
JB
1560/*
1561 * Scale the accumulated delay based on how long it has been since we updated
1562 * the delay. We only call this when we are adding delay, in case it's been a
1563 * while since we added delay, and when we are checking to see if we need to
1564 * delay a task, to account for any delays that may have occurred.
1565 */
1566static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1567{
1568 u64 old = atomic64_read(&blkg->delay_start);
1569
54c52e10
TH
1570 /* negative use_delay means no scaling, see blkcg_set_delay() */
1571 if (atomic_read(&blkg->use_delay) < 0)
1572 return;
1573
d09d8df3
JB
1574 /*
1575 * We only want to scale down every second. The idea here is that we
1576 * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1577 * time window. We only want to throttle tasks for recent delay that
1578 * has occurred, in 1 second time windows since that's the maximum
1579 * things can be throttled. We save the current delay window in
1580 * blkg->last_delay so we know what amount is still left to be charged
1581 * to the blkg from this point onward. blkg->last_use keeps track of
1582 * the use_delay counter. The idea is if we're unthrottling the blkg we
1583 * are ok with whatever is happening now, and we can take away more of
1584 * the accumulated delay as we've already throttled enough that
1585 * everybody is happy with their IO latencies.
1586 */
1587 if (time_before64(old + NSEC_PER_SEC, now) &&
1588 atomic64_cmpxchg(&blkg->delay_start, old, now) == old) {
1589 u64 cur = atomic64_read(&blkg->delay_nsec);
1590 u64 sub = min_t(u64, blkg->last_delay, now - old);
1591 int cur_use = atomic_read(&blkg->use_delay);
1592
1593 /*
1594 * We've been unthrottled, subtract a larger chunk of our
1595 * accumulated delay.
1596 */
1597 if (cur_use < blkg->last_use)
1598 sub = max_t(u64, sub, blkg->last_delay >> 1);
1599
1600 /*
1601 * This shouldn't happen, but handle it anyway. Our delay_nsec
1602 * should only ever be growing except here where we subtract out
1603 * min(last_delay, 1 second), but lord knows bugs happen and I'd
1604 * rather not end up with negative numbers.
1605 */
1606 if (unlikely(cur < sub)) {
1607 atomic64_set(&blkg->delay_nsec, 0);
1608 blkg->last_delay = 0;
1609 } else {
1610 atomic64_sub(sub, &blkg->delay_nsec);
1611 blkg->last_delay = cur - sub;
1612 }
1613 blkg->last_use = cur_use;
1614 }
1615}
1616
1617/*
1618 * This is called when we want to actually walk up the hierarchy and check to
1619 * see if we need to throttle, and then actually throttle if there is some
1620 * accumulated delay. This should only be called upon return to user space so
1621 * we're not holding some lock that would induce a priority inversion.
1622 */
1623static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1624{
fd112c74 1625 unsigned long pflags;
5160a5a5 1626 bool clamp;
d09d8df3
JB
1627 u64 now = ktime_to_ns(ktime_get());
1628 u64 exp;
1629 u64 delay_nsec = 0;
1630 int tok;
1631
1632 while (blkg->parent) {
5160a5a5
TH
1633 int use_delay = atomic_read(&blkg->use_delay);
1634
1635 if (use_delay) {
1636 u64 this_delay;
1637
d09d8df3 1638 blkcg_scale_delay(blkg, now);
5160a5a5
TH
1639 this_delay = atomic64_read(&blkg->delay_nsec);
1640 if (this_delay > delay_nsec) {
1641 delay_nsec = this_delay;
1642 clamp = use_delay > 0;
1643 }
d09d8df3
JB
1644 }
1645 blkg = blkg->parent;
1646 }
1647
1648 if (!delay_nsec)
1649 return;
1650
1651 /*
1652 * Let's not sleep for all eternity if we've amassed a huge delay.
1653 * Swapping or metadata IO can accumulate 10's of seconds worth of
1654 * delay, and we want userspace to be able to do _something_ so cap the
5160a5a5
TH
1655 * delays at 0.25s. If there's 10's of seconds worth of delay then the
1656 * tasks will be delayed for 0.25 second for every syscall. If
1657 * blkcg_set_delay() was used as indicated by negative use_delay, the
1658 * caller is responsible for regulating the range.
d09d8df3 1659 */
5160a5a5
TH
1660 if (clamp)
1661 delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
d09d8df3 1662
fd112c74
JB
1663 if (use_memdelay)
1664 psi_memstall_enter(&pflags);
d09d8df3
JB
1665
1666 exp = ktime_add_ns(now, delay_nsec);
1667 tok = io_schedule_prepare();
1668 do {
1669 __set_current_state(TASK_KILLABLE);
1670 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1671 break;
1672 } while (!fatal_signal_pending(current));
1673 io_schedule_finish(tok);
fd112c74
JB
1674
1675 if (use_memdelay)
1676 psi_memstall_leave(&pflags);
d09d8df3
JB
1677}
1678
1679/**
1680 * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1681 *
1682 * This is only called if we've been marked with set_notify_resume(). Obviously
1683 * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1684 * check to see if current->throttle_queue is set and if not this doesn't do
1685 * anything. This should only ever be called by the resume code, it's not meant
1686 * to be called by people willy-nilly as it will actually do the work to
1687 * throttle the task if it is setup for throttling.
1688 */
1689void blkcg_maybe_throttle_current(void)
1690{
1691 struct request_queue *q = current->throttle_queue;
1692 struct cgroup_subsys_state *css;
1693 struct blkcg *blkcg;
1694 struct blkcg_gq *blkg;
1695 bool use_memdelay = current->use_memdelay;
1696
1697 if (!q)
1698 return;
1699
1700 current->throttle_queue = NULL;
1701 current->use_memdelay = false;
1702
1703 rcu_read_lock();
1704 css = kthread_blkcg();
1705 if (css)
1706 blkcg = css_to_blkcg(css);
1707 else
1708 blkcg = css_to_blkcg(task_css(current, io_cgrp_id));
1709
1710 if (!blkcg)
1711 goto out;
1712 blkg = blkg_lookup(blkcg, q);
1713 if (!blkg)
1714 goto out;
7754f669 1715 if (!blkg_tryget(blkg))
d09d8df3
JB
1716 goto out;
1717 rcu_read_unlock();
d09d8df3
JB
1718
1719 blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1720 blkg_put(blkg);
cc7ecc25 1721 blk_put_queue(q);
d09d8df3
JB
1722 return;
1723out:
1724 rcu_read_unlock();
1725 blk_put_queue(q);
1726}
d09d8df3
JB
1727
1728/**
1729 * blkcg_schedule_throttle - this task needs to check for throttling
537d71b3
BVA
1730 * @q: the request queue IO was submitted on
1731 * @use_memdelay: do we charge this to memory delay for PSI
d09d8df3
JB
1732 *
1733 * This is called by the IO controller when we know there's delay accumulated
1734 * for the blkg for this task. We do not pass the blkg because there are places
1735 * we call this that may not have that information, the swapping code for
1736 * instance will only have a request_queue at that point. This set's the
1737 * notify_resume for the task to check and see if it requires throttling before
1738 * returning to user space.
1739 *
1740 * We will only schedule once per syscall. You can call this over and over
1741 * again and it will only do the check once upon return to user space, and only
1742 * throttle once. If the task needs to be throttled again it'll need to be
1743 * re-set at the next time we see the task.
1744 */
1745void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay)
1746{
1747 if (unlikely(current->flags & PF_KTHREAD))
1748 return;
1749
1750 if (!blk_get_queue(q))
1751 return;
1752
1753 if (current->throttle_queue)
1754 blk_put_queue(current->throttle_queue);
1755 current->throttle_queue = q;
1756 if (use_memdelay)
1757 current->use_memdelay = use_memdelay;
1758 set_notify_resume(current);
1759}
d09d8df3
JB
1760
1761/**
1762 * blkcg_add_delay - add delay to this blkg
537d71b3
BVA
1763 * @blkg: blkg of interest
1764 * @now: the current time in nanoseconds
1765 * @delta: how many nanoseconds of delay to add
d09d8df3
JB
1766 *
1767 * Charge @delta to the blkg's current delay accumulation. This is used to
1768 * throttle tasks if an IO controller thinks we need more throttling.
1769 */
1770void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1771{
54c52e10
TH
1772 if (WARN_ON_ONCE(atomic_read(&blkg->use_delay) < 0))
1773 return;
d09d8df3
JB
1774 blkcg_scale_delay(blkg, now);
1775 atomic64_add(delta, &blkg->delay_nsec);
1776}
d09d8df3 1777
28fc591f
CH
1778/**
1779 * blkg_tryget_closest - try and get a blkg ref on the closet blkg
13c7863d
CH
1780 * @bio: target bio
1781 * @css: target css
28fc591f 1782 *
13c7863d
CH
1783 * As the failure mode here is to walk up the blkg tree, this ensure that the
1784 * blkg->parent pointers are always valid. This returns the blkg that it ended
1785 * up taking a reference on or %NULL if no reference was taken.
28fc591f 1786 */
13c7863d
CH
1787static inline struct blkcg_gq *blkg_tryget_closest(struct bio *bio,
1788 struct cgroup_subsys_state *css)
28fc591f 1789{
13c7863d 1790 struct blkcg_gq *blkg, *ret_blkg = NULL;
28fc591f 1791
13c7863d
CH
1792 rcu_read_lock();
1793 blkg = blkg_lookup_create(css_to_blkcg(css), bio->bi_disk->queue);
28fc591f
CH
1794 while (blkg) {
1795 if (blkg_tryget(blkg)) {
1796 ret_blkg = blkg;
1797 break;
1798 }
1799 blkg = blkg->parent;
1800 }
13c7863d 1801 rcu_read_unlock();
28fc591f
CH
1802
1803 return ret_blkg;
1804}
1805
1806/**
1807 * bio_associate_blkg_from_css - associate a bio with a specified css
1808 * @bio: target bio
1809 * @css: target css
1810 *
1811 * Associate @bio with the blkg found by combining the css's blkg and the
1812 * request_queue of the @bio. An association failure is handled by walking up
1813 * the blkg tree. Therefore, the blkg associated can be anything between @blkg
1814 * and q->root_blkg. This situation only happens when a cgroup is dying and
1815 * then the remaining bios will spill to the closest alive blkg.
1816 *
1817 * A reference will be taken on the blkg and will be released when @bio is
1818 * freed.
1819 */
1820void bio_associate_blkg_from_css(struct bio *bio,
1821 struct cgroup_subsys_state *css)
1822{
28fc591f
CH
1823 if (bio->bi_blkg)
1824 blkg_put(bio->bi_blkg);
1825
a5b97526 1826 if (css && css->parent) {
13c7863d 1827 bio->bi_blkg = blkg_tryget_closest(bio, css);
a5b97526 1828 } else {
13c7863d
CH
1829 blkg_get(bio->bi_disk->queue->root_blkg);
1830 bio->bi_blkg = bio->bi_disk->queue->root_blkg;
a5b97526 1831 }
28fc591f
CH
1832}
1833EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
1834
1835/**
1836 * bio_associate_blkg - associate a bio with a blkg
1837 * @bio: target bio
1838 *
1839 * Associate @bio with the blkg found from the bio's css and request_queue.
1840 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
1841 * already associated, the css is reused and association redone as the
1842 * request_queue may have changed.
1843 */
1844void bio_associate_blkg(struct bio *bio)
1845{
1846 struct cgroup_subsys_state *css;
1847
1848 rcu_read_lock();
1849
1850 if (bio->bi_blkg)
1851 css = &bio_blkcg(bio)->css;
1852 else
1853 css = blkcg_css();
1854
1855 bio_associate_blkg_from_css(bio, css);
1856
1857 rcu_read_unlock();
1858}
1859EXPORT_SYMBOL_GPL(bio_associate_blkg);
1860
1861/**
1862 * bio_clone_blkg_association - clone blkg association from src to dst bio
1863 * @dst: destination bio
1864 * @src: source bio
1865 */
1866void bio_clone_blkg_association(struct bio *dst, struct bio *src)
1867{
1868 if (src->bi_blkg) {
1869 if (dst->bi_blkg)
1870 blkg_put(dst->bi_blkg);
1871 blkg_get(src->bi_blkg);
1872 dst->bi_blkg = src->bi_blkg;
1873 }
1874}
1875EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
1876
db18a53e
CH
1877static int blk_cgroup_io_type(struct bio *bio)
1878{
1879 if (op_is_discard(bio->bi_opf))
1880 return BLKG_IOSTAT_DISCARD;
1881 if (op_is_write(bio->bi_opf))
1882 return BLKG_IOSTAT_WRITE;
1883 return BLKG_IOSTAT_READ;
1884}
1885
1886void blk_cgroup_bio_start(struct bio *bio)
1887{
1888 int rwd = blk_cgroup_io_type(bio), cpu;
1889 struct blkg_iostat_set *bis;
1890
1891 cpu = get_cpu();
1892 bis = per_cpu_ptr(bio->bi_blkg->iostat_cpu, cpu);
1893 u64_stats_update_begin(&bis->sync);
1894
1895 /*
1896 * If the bio is flagged with BIO_CGROUP_ACCT it means this is a split
1897 * bio and we would have already accounted for the size of the bio.
1898 */
1899 if (!bio_flagged(bio, BIO_CGROUP_ACCT)) {
1900 bio_set_flag(bio, BIO_CGROUP_ACCT);
0b8cc25d 1901 bis->cur.bytes[rwd] += bio->bi_iter.bi_size;
db18a53e
CH
1902 }
1903 bis->cur.ios[rwd]++;
1904
1905 u64_stats_update_end(&bis->sync);
1906 if (cgroup_subsys_on_dfl(io_cgrp_subsys))
1907 cgroup_rstat_updated(bio->bi_blkg->blkcg->css.cgroup, cpu);
1908 put_cpu();
1909}
1910
d3f77dfd
TH
1911static int __init blkcg_init(void)
1912{
1913 blkcg_punt_bio_wq = alloc_workqueue("blkcg_punt_bio",
1914 WQ_MEM_RECLAIM | WQ_FREEZABLE |
1915 WQ_UNBOUND | WQ_SYSFS, 0);
1916 if (!blkcg_punt_bio_wq)
1917 return -ENOMEM;
1918 return 0;
1919}
1920subsys_initcall(blkcg_init);
1921
903d23f0
JB
1922module_param(blkcg_debug_stats, bool, 0644);
1923MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");