blkcg: make blkcg_gq's hierarchical
[linux-2.6-block.git] / block / blk-cgroup.c
CommitLineData
31e4c28d
VG
1/*
2 * Common Block IO controller cgroup interface
3 *
4 * Based on ideas and code from CFQ, CFS and BFQ:
5 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
6 *
7 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
8 * Paolo Valente <paolo.valente@unimore.it>
9 *
10 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
11 * Nauman Rafique <nauman@google.com>
12 */
13#include <linux/ioprio.h>
22084190 14#include <linux/kdev_t.h>
9d6a986c 15#include <linux/module.h>
accee785 16#include <linux/err.h>
9195291e 17#include <linux/blkdev.h>
5a0e3ad6 18#include <linux/slab.h>
34d0f179 19#include <linux/genhd.h>
72e06c25 20#include <linux/delay.h>
9a9e8a26 21#include <linux/atomic.h>
72e06c25 22#include "blk-cgroup.h"
5efd6113 23#include "blk.h"
3e252066 24
84c124da
DS
25#define MAX_KEY_LEN 100
26
bc0d6501 27static DEFINE_MUTEX(blkcg_pol_mutex);
923adde1 28
3c798398
TH
29struct blkcg blkcg_root = { .cfq_weight = 2 * CFQ_WEIGHT_DEFAULT };
30EXPORT_SYMBOL_GPL(blkcg_root);
9d6a986c 31
3c798398 32static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
035d10b2 33
a2b1693b 34static bool blkcg_policy_enabled(struct request_queue *q,
3c798398 35 const struct blkcg_policy *pol)
a2b1693b
TH
36{
37 return pol && test_bit(pol->plid, q->blkcg_pols);
38}
39
0381411e
TH
40/**
41 * blkg_free - free a blkg
42 * @blkg: blkg to free
43 *
44 * Free @blkg which may be partially allocated.
45 */
3c798398 46static void blkg_free(struct blkcg_gq *blkg)
0381411e 47{
e8989fae 48 int i;
549d3aa8
TH
49
50 if (!blkg)
51 return;
52
8bd435b3 53 for (i = 0; i < BLKCG_MAX_POLS; i++) {
3c798398 54 struct blkcg_policy *pol = blkcg_policy[i];
e8989fae
TH
55 struct blkg_policy_data *pd = blkg->pd[i];
56
9ade5ea4
TH
57 if (!pd)
58 continue;
59
f9fcc2d3
TH
60 if (pol && pol->pd_exit_fn)
61 pol->pd_exit_fn(blkg);
9ade5ea4 62
9ade5ea4 63 kfree(pd);
0381411e 64 }
e8989fae 65
a051661c 66 blk_exit_rl(&blkg->rl);
549d3aa8 67 kfree(blkg);
0381411e
TH
68}
69
70/**
71 * blkg_alloc - allocate a blkg
72 * @blkcg: block cgroup the new blkg is associated with
73 * @q: request_queue the new blkg is associated with
15974993 74 * @gfp_mask: allocation mask to use
0381411e 75 *
e8989fae 76 * Allocate a new blkg assocating @blkcg and @q.
0381411e 77 */
15974993
TH
78static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct request_queue *q,
79 gfp_t gfp_mask)
0381411e 80{
3c798398 81 struct blkcg_gq *blkg;
e8989fae 82 int i;
0381411e
TH
83
84 /* alloc and init base part */
15974993 85 blkg = kzalloc_node(sizeof(*blkg), gfp_mask, q->node);
0381411e
TH
86 if (!blkg)
87 return NULL;
88
c875f4d0 89 blkg->q = q;
e8989fae 90 INIT_LIST_HEAD(&blkg->q_node);
0381411e 91 blkg->blkcg = blkcg;
1adaf3dd 92 blkg->refcnt = 1;
0381411e 93
a051661c
TH
94 /* root blkg uses @q->root_rl, init rl only for !root blkgs */
95 if (blkcg != &blkcg_root) {
96 if (blk_init_rl(&blkg->rl, q, gfp_mask))
97 goto err_free;
98 blkg->rl.blkg = blkg;
99 }
100
8bd435b3 101 for (i = 0; i < BLKCG_MAX_POLS; i++) {
3c798398 102 struct blkcg_policy *pol = blkcg_policy[i];
e8989fae 103 struct blkg_policy_data *pd;
0381411e 104
a2b1693b 105 if (!blkcg_policy_enabled(q, pol))
e8989fae
TH
106 continue;
107
108 /* alloc per-policy data and attach it to blkg */
15974993 109 pd = kzalloc_node(pol->pd_size, gfp_mask, q->node);
a051661c
TH
110 if (!pd)
111 goto err_free;
549d3aa8 112
e8989fae
TH
113 blkg->pd[i] = pd;
114 pd->blkg = blkg;
e8989fae 115
9b2ea86b 116 /* invoke per-policy init */
356d2e58 117 if (pol->pd_init_fn)
f9fcc2d3 118 pol->pd_init_fn(blkg);
e8989fae
TH
119 }
120
0381411e 121 return blkg;
a051661c
TH
122
123err_free:
124 blkg_free(blkg);
125 return NULL;
0381411e
TH
126}
127
3c798398 128static struct blkcg_gq *__blkg_lookup(struct blkcg *blkcg,
86cde6b6 129 struct request_queue *q, bool update_hint)
80fd9979 130{
3c798398 131 struct blkcg_gq *blkg;
80fd9979 132
a637120e
TH
133 blkg = rcu_dereference(blkcg->blkg_hint);
134 if (blkg && blkg->q == q)
135 return blkg;
136
137 /*
86cde6b6
TH
138 * Hint didn't match. Look up from the radix tree. Note that the
139 * hint can only be updated under queue_lock as otherwise @blkg
140 * could have already been removed from blkg_tree. The caller is
141 * responsible for grabbing queue_lock if @update_hint.
a637120e
TH
142 */
143 blkg = radix_tree_lookup(&blkcg->blkg_tree, q->id);
86cde6b6
TH
144 if (blkg && blkg->q == q) {
145 if (update_hint) {
146 lockdep_assert_held(q->queue_lock);
147 rcu_assign_pointer(blkcg->blkg_hint, blkg);
148 }
a637120e 149 return blkg;
86cde6b6 150 }
a637120e 151
80fd9979
TH
152 return NULL;
153}
154
155/**
156 * blkg_lookup - lookup blkg for the specified blkcg - q pair
157 * @blkcg: blkcg of interest
158 * @q: request_queue of interest
159 *
160 * Lookup blkg for the @blkcg - @q pair. This function should be called
161 * under RCU read lock and is guaranteed to return %NULL if @q is bypassing
162 * - see blk_queue_bypass_start() for details.
163 */
3c798398 164struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, struct request_queue *q)
80fd9979
TH
165{
166 WARN_ON_ONCE(!rcu_read_lock_held());
167
168 if (unlikely(blk_queue_bypass(q)))
169 return NULL;
86cde6b6 170 return __blkg_lookup(blkcg, q, false);
80fd9979
TH
171}
172EXPORT_SYMBOL_GPL(blkg_lookup);
173
15974993
TH
174/*
175 * If @new_blkg is %NULL, this function tries to allocate a new one as
176 * necessary using %GFP_ATOMIC. @new_blkg is always consumed on return.
177 */
86cde6b6
TH
178static struct blkcg_gq *blkg_create(struct blkcg *blkcg,
179 struct request_queue *q,
180 struct blkcg_gq *new_blkg)
5624a4e4 181{
3c798398 182 struct blkcg_gq *blkg;
496fb780 183 int ret;
5624a4e4 184
cd1604fa
TH
185 WARN_ON_ONCE(!rcu_read_lock_held());
186 lockdep_assert_held(q->queue_lock);
187
7ee9c562 188 /* blkg holds a reference to blkcg */
15974993 189 if (!css_tryget(&blkcg->css)) {
93e6d5d8
TH
190 ret = -EINVAL;
191 goto err_free_blkg;
15974993 192 }
cd1604fa 193
496fb780 194 /* allocate */
15974993
TH
195 if (!new_blkg) {
196 new_blkg = blkg_alloc(blkcg, q, GFP_ATOMIC);
197 if (unlikely(!new_blkg)) {
93e6d5d8
TH
198 ret = -ENOMEM;
199 goto err_put_css;
15974993
TH
200 }
201 }
202 blkg = new_blkg;
cd1604fa 203
3c547865
TH
204 /* link parent and insert */
205 if (blkcg_parent(blkcg)) {
206 blkg->parent = __blkg_lookup(blkcg_parent(blkcg), q, false);
207 if (WARN_ON_ONCE(!blkg->parent)) {
208 blkg = ERR_PTR(-EINVAL);
209 goto err_put_css;
210 }
211 blkg_get(blkg->parent);
212 }
213
cd1604fa 214 spin_lock(&blkcg->lock);
a637120e
TH
215 ret = radix_tree_insert(&blkcg->blkg_tree, q->id, blkg);
216 if (likely(!ret)) {
217 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
218 list_add(&blkg->q_node, &q->blkg_list);
219 }
cd1604fa 220 spin_unlock(&blkcg->lock);
496fb780 221
a637120e
TH
222 if (!ret)
223 return blkg;
15974993 224
3c547865
TH
225 /* @blkg failed fully initialized, use the usual release path */
226 blkg_put(blkg);
227 return ERR_PTR(ret);
228
93e6d5d8 229err_put_css:
496fb780 230 css_put(&blkcg->css);
93e6d5d8 231err_free_blkg:
15974993 232 blkg_free(new_blkg);
93e6d5d8 233 return ERR_PTR(ret);
31e4c28d 234}
3c96cb32 235
86cde6b6
TH
236/**
237 * blkg_lookup_create - lookup blkg, try to create one if not there
238 * @blkcg: blkcg of interest
239 * @q: request_queue of interest
240 *
241 * Lookup blkg for the @blkcg - @q pair. If it doesn't exist, try to
3c547865
TH
242 * create one. blkg creation is performed recursively from blkcg_root such
243 * that all non-root blkg's have access to the parent blkg. This function
244 * should be called under RCU read lock and @q->queue_lock.
86cde6b6
TH
245 *
246 * Returns pointer to the looked up or created blkg on success, ERR_PTR()
247 * value on error. If @q is dead, returns ERR_PTR(-EINVAL). If @q is not
248 * dead and bypassing, returns ERR_PTR(-EBUSY).
249 */
3c798398
TH
250struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
251 struct request_queue *q)
3c96cb32 252{
86cde6b6
TH
253 struct blkcg_gq *blkg;
254
255 WARN_ON_ONCE(!rcu_read_lock_held());
256 lockdep_assert_held(q->queue_lock);
257
3c96cb32
TH
258 /*
259 * This could be the first entry point of blkcg implementation and
260 * we shouldn't allow anything to go through for a bypassing queue.
261 */
262 if (unlikely(blk_queue_bypass(q)))
3f3299d5 263 return ERR_PTR(blk_queue_dying(q) ? -EINVAL : -EBUSY);
86cde6b6
TH
264
265 blkg = __blkg_lookup(blkcg, q, true);
266 if (blkg)
267 return blkg;
268
3c547865
TH
269 /*
270 * Create blkgs walking down from blkcg_root to @blkcg, so that all
271 * non-root blkgs have access to their parents.
272 */
273 while (true) {
274 struct blkcg *pos = blkcg;
275 struct blkcg *parent = blkcg_parent(blkcg);
276
277 while (parent && !__blkg_lookup(parent, q, false)) {
278 pos = parent;
279 parent = blkcg_parent(parent);
280 }
281
282 blkg = blkg_create(pos, q, NULL);
283 if (pos == blkcg || IS_ERR(blkg))
284 return blkg;
285 }
3c96cb32 286}
cd1604fa 287EXPORT_SYMBOL_GPL(blkg_lookup_create);
31e4c28d 288
3c798398 289static void blkg_destroy(struct blkcg_gq *blkg)
03aa264a 290{
3c798398 291 struct blkcg *blkcg = blkg->blkcg;
03aa264a 292
27e1f9d1 293 lockdep_assert_held(blkg->q->queue_lock);
9f13ef67 294 lockdep_assert_held(&blkcg->lock);
03aa264a
TH
295
296 /* Something wrong if we are trying to remove same group twice */
e8989fae 297 WARN_ON_ONCE(list_empty(&blkg->q_node));
9f13ef67 298 WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
a637120e
TH
299
300 radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
e8989fae 301 list_del_init(&blkg->q_node);
9f13ef67 302 hlist_del_init_rcu(&blkg->blkcg_node);
03aa264a 303
a637120e
TH
304 /*
305 * Both setting lookup hint to and clearing it from @blkg are done
306 * under queue_lock. If it's not pointing to @blkg now, it never
307 * will. Hint assignment itself can race safely.
308 */
309 if (rcu_dereference_raw(blkcg->blkg_hint) == blkg)
310 rcu_assign_pointer(blkcg->blkg_hint, NULL);
311
03aa264a
TH
312 /*
313 * Put the reference taken at the time of creation so that when all
314 * queues are gone, group can be destroyed.
315 */
316 blkg_put(blkg);
317}
318
9f13ef67
TH
319/**
320 * blkg_destroy_all - destroy all blkgs associated with a request_queue
321 * @q: request_queue of interest
9f13ef67 322 *
3c96cb32 323 * Destroy all blkgs associated with @q.
9f13ef67 324 */
3c96cb32 325static void blkg_destroy_all(struct request_queue *q)
72e06c25 326{
3c798398 327 struct blkcg_gq *blkg, *n;
72e06c25 328
6d18b008 329 lockdep_assert_held(q->queue_lock);
72e06c25 330
9f13ef67 331 list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
3c798398 332 struct blkcg *blkcg = blkg->blkcg;
72e06c25 333
9f13ef67
TH
334 spin_lock(&blkcg->lock);
335 blkg_destroy(blkg);
336 spin_unlock(&blkcg->lock);
72e06c25 337 }
65635cbc
JN
338
339 /*
340 * root blkg is destroyed. Just clear the pointer since
341 * root_rl does not take reference on root blkg.
342 */
343 q->root_blkg = NULL;
344 q->root_rl.blkg = NULL;
72e06c25
TH
345}
346
1adaf3dd
TH
347static void blkg_rcu_free(struct rcu_head *rcu_head)
348{
3c798398 349 blkg_free(container_of(rcu_head, struct blkcg_gq, rcu_head));
1adaf3dd
TH
350}
351
3c798398 352void __blkg_release(struct blkcg_gq *blkg)
1adaf3dd 353{
3c547865 354 /* release the blkcg and parent blkg refs this blkg has been holding */
1adaf3dd 355 css_put(&blkg->blkcg->css);
3c547865
TH
356 if (blkg->parent)
357 blkg_put(blkg->parent);
1adaf3dd
TH
358
359 /*
360 * A group is freed in rcu manner. But having an rcu lock does not
361 * mean that one can access all the fields of blkg and assume these
362 * are valid. For example, don't try to follow throtl_data and
363 * request queue links.
364 *
365 * Having a reference to blkg under an rcu allows acess to only
366 * values local to groups like group stats and group rate limits
367 */
368 call_rcu(&blkg->rcu_head, blkg_rcu_free);
369}
370EXPORT_SYMBOL_GPL(__blkg_release);
371
a051661c
TH
372/*
373 * The next function used by blk_queue_for_each_rl(). It's a bit tricky
374 * because the root blkg uses @q->root_rl instead of its own rl.
375 */
376struct request_list *__blk_queue_next_rl(struct request_list *rl,
377 struct request_queue *q)
378{
379 struct list_head *ent;
380 struct blkcg_gq *blkg;
381
382 /*
383 * Determine the current blkg list_head. The first entry is
384 * root_rl which is off @q->blkg_list and mapped to the head.
385 */
386 if (rl == &q->root_rl) {
387 ent = &q->blkg_list;
65c77fd9
JN
388 /* There are no more block groups, hence no request lists */
389 if (list_empty(ent))
390 return NULL;
a051661c
TH
391 } else {
392 blkg = container_of(rl, struct blkcg_gq, rl);
393 ent = &blkg->q_node;
394 }
395
396 /* walk to the next list_head, skip root blkcg */
397 ent = ent->next;
398 if (ent == &q->root_blkg->q_node)
399 ent = ent->next;
400 if (ent == &q->blkg_list)
401 return NULL;
402
403 blkg = container_of(ent, struct blkcg_gq, q_node);
404 return &blkg->rl;
405}
406
3c798398
TH
407static int blkcg_reset_stats(struct cgroup *cgroup, struct cftype *cftype,
408 u64 val)
303a3acb 409{
3c798398
TH
410 struct blkcg *blkcg = cgroup_to_blkcg(cgroup);
411 struct blkcg_gq *blkg;
303a3acb 412 struct hlist_node *n;
bc0d6501 413 int i;
303a3acb 414
bc0d6501 415 mutex_lock(&blkcg_pol_mutex);
303a3acb 416 spin_lock_irq(&blkcg->lock);
997a026c
TH
417
418 /*
419 * Note that stat reset is racy - it doesn't synchronize against
420 * stat updates. This is a debug feature which shouldn't exist
421 * anyway. If you get hit by a race, retry.
422 */
303a3acb 423 hlist_for_each_entry(blkg, n, &blkcg->blkg_list, blkcg_node) {
8bd435b3 424 for (i = 0; i < BLKCG_MAX_POLS; i++) {
3c798398 425 struct blkcg_policy *pol = blkcg_policy[i];
549d3aa8 426
a2b1693b 427 if (blkcg_policy_enabled(blkg->q, pol) &&
f9fcc2d3
TH
428 pol->pd_reset_stats_fn)
429 pol->pd_reset_stats_fn(blkg);
bc0d6501 430 }
303a3acb 431 }
f0bdc8cd 432
303a3acb 433 spin_unlock_irq(&blkcg->lock);
bc0d6501 434 mutex_unlock(&blkcg_pol_mutex);
303a3acb
DS
435 return 0;
436}
437
3c798398 438static const char *blkg_dev_name(struct blkcg_gq *blkg)
303a3acb 439{
d3d32e69
TH
440 /* some drivers (floppy) instantiate a queue w/o disk registered */
441 if (blkg->q->backing_dev_info.dev)
442 return dev_name(blkg->q->backing_dev_info.dev);
443 return NULL;
303a3acb
DS
444}
445
d3d32e69
TH
446/**
447 * blkcg_print_blkgs - helper for printing per-blkg data
448 * @sf: seq_file to print to
449 * @blkcg: blkcg of interest
450 * @prfill: fill function to print out a blkg
451 * @pol: policy in question
452 * @data: data to be passed to @prfill
453 * @show_total: to print out sum of prfill return values or not
454 *
455 * This function invokes @prfill on each blkg of @blkcg if pd for the
456 * policy specified by @pol exists. @prfill is invoked with @sf, the
457 * policy data and @data. If @show_total is %true, the sum of the return
458 * values from @prfill is printed with "Total" label at the end.
459 *
460 * This is to be used to construct print functions for
461 * cftype->read_seq_string method.
462 */
3c798398 463void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
f95a04af
TH
464 u64 (*prfill)(struct seq_file *,
465 struct blkg_policy_data *, int),
3c798398 466 const struct blkcg_policy *pol, int data,
ec399347 467 bool show_total)
5624a4e4 468{
3c798398 469 struct blkcg_gq *blkg;
d3d32e69
TH
470 struct hlist_node *n;
471 u64 total = 0;
5624a4e4 472
d3d32e69
TH
473 spin_lock_irq(&blkcg->lock);
474 hlist_for_each_entry(blkg, n, &blkcg->blkg_list, blkcg_node)
a2b1693b 475 if (blkcg_policy_enabled(blkg->q, pol))
f95a04af 476 total += prfill(sf, blkg->pd[pol->plid], data);
d3d32e69
TH
477 spin_unlock_irq(&blkcg->lock);
478
479 if (show_total)
480 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
481}
829fdb50 482EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
d3d32e69
TH
483
484/**
485 * __blkg_prfill_u64 - prfill helper for a single u64 value
486 * @sf: seq_file to print to
f95a04af 487 * @pd: policy private data of interest
d3d32e69
TH
488 * @v: value to print
489 *
f95a04af 490 * Print @v to @sf for the device assocaited with @pd.
d3d32e69 491 */
f95a04af 492u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
d3d32e69 493{
f95a04af 494 const char *dname = blkg_dev_name(pd->blkg);
d3d32e69
TH
495
496 if (!dname)
497 return 0;
498
499 seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
500 return v;
501}
829fdb50 502EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
d3d32e69
TH
503
504/**
505 * __blkg_prfill_rwstat - prfill helper for a blkg_rwstat
506 * @sf: seq_file to print to
f95a04af 507 * @pd: policy private data of interest
d3d32e69
TH
508 * @rwstat: rwstat to print
509 *
f95a04af 510 * Print @rwstat to @sf for the device assocaited with @pd.
d3d32e69 511 */
f95a04af 512u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
829fdb50 513 const struct blkg_rwstat *rwstat)
d3d32e69
TH
514{
515 static const char *rwstr[] = {
516 [BLKG_RWSTAT_READ] = "Read",
517 [BLKG_RWSTAT_WRITE] = "Write",
518 [BLKG_RWSTAT_SYNC] = "Sync",
519 [BLKG_RWSTAT_ASYNC] = "Async",
520 };
f95a04af 521 const char *dname = blkg_dev_name(pd->blkg);
d3d32e69
TH
522 u64 v;
523 int i;
524
525 if (!dname)
526 return 0;
527
528 for (i = 0; i < BLKG_RWSTAT_NR; i++)
529 seq_printf(sf, "%s %s %llu\n", dname, rwstr[i],
530 (unsigned long long)rwstat->cnt[i]);
531
532 v = rwstat->cnt[BLKG_RWSTAT_READ] + rwstat->cnt[BLKG_RWSTAT_WRITE];
533 seq_printf(sf, "%s Total %llu\n", dname, (unsigned long long)v);
534 return v;
535}
536
5bc4afb1
TH
537/**
538 * blkg_prfill_stat - prfill callback for blkg_stat
539 * @sf: seq_file to print to
f95a04af
TH
540 * @pd: policy private data of interest
541 * @off: offset to the blkg_stat in @pd
5bc4afb1
TH
542 *
543 * prfill callback for printing a blkg_stat.
544 */
f95a04af 545u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off)
d3d32e69 546{
f95a04af 547 return __blkg_prfill_u64(sf, pd, blkg_stat_read((void *)pd + off));
d3d32e69 548}
5bc4afb1 549EXPORT_SYMBOL_GPL(blkg_prfill_stat);
d3d32e69 550
5bc4afb1
TH
551/**
552 * blkg_prfill_rwstat - prfill callback for blkg_rwstat
553 * @sf: seq_file to print to
f95a04af
TH
554 * @pd: policy private data of interest
555 * @off: offset to the blkg_rwstat in @pd
5bc4afb1
TH
556 *
557 * prfill callback for printing a blkg_rwstat.
558 */
f95a04af
TH
559u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
560 int off)
d3d32e69 561{
f95a04af 562 struct blkg_rwstat rwstat = blkg_rwstat_read((void *)pd + off);
d3d32e69 563
f95a04af 564 return __blkg_prfill_rwstat(sf, pd, &rwstat);
d3d32e69 565}
5bc4afb1 566EXPORT_SYMBOL_GPL(blkg_prfill_rwstat);
d3d32e69 567
3a8b31d3
TH
568/**
569 * blkg_conf_prep - parse and prepare for per-blkg config update
570 * @blkcg: target block cgroup
da8b0662 571 * @pol: target policy
3a8b31d3
TH
572 * @input: input string
573 * @ctx: blkg_conf_ctx to be filled
574 *
575 * Parse per-blkg config update from @input and initialize @ctx with the
576 * result. @ctx->blkg points to the blkg to be updated and @ctx->v the new
da8b0662
TH
577 * value. This function returns with RCU read lock and queue lock held and
578 * must be paired with blkg_conf_finish().
3a8b31d3 579 */
3c798398
TH
580int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
581 const char *input, struct blkg_conf_ctx *ctx)
da8b0662 582 __acquires(rcu) __acquires(disk->queue->queue_lock)
34d0f179 583{
3a8b31d3 584 struct gendisk *disk;
3c798398 585 struct blkcg_gq *blkg;
726fa694
TH
586 unsigned int major, minor;
587 unsigned long long v;
588 int part, ret;
34d0f179 589
726fa694
TH
590 if (sscanf(input, "%u:%u %llu", &major, &minor, &v) != 3)
591 return -EINVAL;
3a8b31d3 592
726fa694 593 disk = get_gendisk(MKDEV(major, minor), &part);
4bfd482e 594 if (!disk || part)
726fa694 595 return -EINVAL;
e56da7e2
TH
596
597 rcu_read_lock();
4bfd482e 598 spin_lock_irq(disk->queue->queue_lock);
da8b0662 599
a2b1693b 600 if (blkcg_policy_enabled(disk->queue, pol))
3c96cb32 601 blkg = blkg_lookup_create(blkcg, disk->queue);
a2b1693b
TH
602 else
603 blkg = ERR_PTR(-EINVAL);
e56da7e2 604
4bfd482e
TH
605 if (IS_ERR(blkg)) {
606 ret = PTR_ERR(blkg);
3a8b31d3 607 rcu_read_unlock();
da8b0662 608 spin_unlock_irq(disk->queue->queue_lock);
3a8b31d3
TH
609 put_disk(disk);
610 /*
611 * If queue was bypassing, we should retry. Do so after a
612 * short msleep(). It isn't strictly necessary but queue
613 * can be bypassing for some time and it's always nice to
614 * avoid busy looping.
615 */
616 if (ret == -EBUSY) {
617 msleep(10);
618 ret = restart_syscall();
7702e8f4 619 }
726fa694 620 return ret;
062a644d 621 }
3a8b31d3
TH
622
623 ctx->disk = disk;
624 ctx->blkg = blkg;
726fa694
TH
625 ctx->v = v;
626 return 0;
34d0f179 627}
829fdb50 628EXPORT_SYMBOL_GPL(blkg_conf_prep);
34d0f179 629
3a8b31d3
TH
630/**
631 * blkg_conf_finish - finish up per-blkg config update
632 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
633 *
634 * Finish up after per-blkg config update. This function must be paired
635 * with blkg_conf_prep().
636 */
829fdb50 637void blkg_conf_finish(struct blkg_conf_ctx *ctx)
da8b0662 638 __releases(ctx->disk->queue->queue_lock) __releases(rcu)
34d0f179 639{
da8b0662 640 spin_unlock_irq(ctx->disk->queue->queue_lock);
3a8b31d3
TH
641 rcu_read_unlock();
642 put_disk(ctx->disk);
34d0f179 643}
829fdb50 644EXPORT_SYMBOL_GPL(blkg_conf_finish);
34d0f179 645
3c798398 646struct cftype blkcg_files[] = {
84c124da
DS
647 {
648 .name = "reset_stats",
3c798398 649 .write_u64 = blkcg_reset_stats,
22084190 650 },
4baf6e33 651 { } /* terminate */
31e4c28d
VG
652};
653
9f13ef67 654/**
92fb9748 655 * blkcg_css_offline - cgroup css_offline callback
9f13ef67
TH
656 * @cgroup: cgroup of interest
657 *
658 * This function is called when @cgroup is about to go away and responsible
659 * for shooting down all blkgs associated with @cgroup. blkgs should be
660 * removed while holding both q and blkcg locks. As blkcg lock is nested
661 * inside q lock, this function performs reverse double lock dancing.
662 *
663 * This is the blkcg counterpart of ioc_release_fn().
664 */
92fb9748 665static void blkcg_css_offline(struct cgroup *cgroup)
31e4c28d 666{
3c798398 667 struct blkcg *blkcg = cgroup_to_blkcg(cgroup);
b1c35769 668
9f13ef67 669 spin_lock_irq(&blkcg->lock);
7ee9c562 670
9f13ef67 671 while (!hlist_empty(&blkcg->blkg_list)) {
3c798398
TH
672 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
673 struct blkcg_gq, blkcg_node);
c875f4d0 674 struct request_queue *q = blkg->q;
b1c35769 675
9f13ef67
TH
676 if (spin_trylock(q->queue_lock)) {
677 blkg_destroy(blkg);
678 spin_unlock(q->queue_lock);
679 } else {
680 spin_unlock_irq(&blkcg->lock);
9f13ef67 681 cpu_relax();
a5567932 682 spin_lock_irq(&blkcg->lock);
0f3942a3 683 }
9f13ef67 684 }
b1c35769 685
9f13ef67 686 spin_unlock_irq(&blkcg->lock);
7ee9c562
TH
687}
688
92fb9748 689static void blkcg_css_free(struct cgroup *cgroup)
7ee9c562 690{
3c798398 691 struct blkcg *blkcg = cgroup_to_blkcg(cgroup);
7ee9c562 692
3c798398 693 if (blkcg != &blkcg_root)
67523c48 694 kfree(blkcg);
31e4c28d
VG
695}
696
92fb9748 697static struct cgroup_subsys_state *blkcg_css_alloc(struct cgroup *cgroup)
31e4c28d 698{
9a9e8a26 699 static atomic64_t id_seq = ATOMIC64_INIT(0);
3c798398 700 struct blkcg *blkcg;
0341509f 701 struct cgroup *parent = cgroup->parent;
31e4c28d 702
0341509f 703 if (!parent) {
3c798398 704 blkcg = &blkcg_root;
31e4c28d
VG
705 goto done;
706 }
707
31e4c28d
VG
708 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
709 if (!blkcg)
710 return ERR_PTR(-ENOMEM);
711
3381cb8d 712 blkcg->cfq_weight = CFQ_WEIGHT_DEFAULT;
9a9e8a26 713 blkcg->id = atomic64_inc_return(&id_seq); /* root is 0, start from 1 */
31e4c28d
VG
714done:
715 spin_lock_init(&blkcg->lock);
a637120e 716 INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_ATOMIC);
31e4c28d
VG
717 INIT_HLIST_HEAD(&blkcg->blkg_list);
718
719 return &blkcg->css;
720}
721
5efd6113
TH
722/**
723 * blkcg_init_queue - initialize blkcg part of request queue
724 * @q: request_queue to initialize
725 *
726 * Called from blk_alloc_queue_node(). Responsible for initializing blkcg
727 * part of new request_queue @q.
728 *
729 * RETURNS:
730 * 0 on success, -errno on failure.
731 */
732int blkcg_init_queue(struct request_queue *q)
733{
734 might_sleep();
735
3c96cb32 736 return blk_throtl_init(q);
5efd6113
TH
737}
738
739/**
740 * blkcg_drain_queue - drain blkcg part of request_queue
741 * @q: request_queue to drain
742 *
743 * Called from blk_drain_queue(). Responsible for draining blkcg part.
744 */
745void blkcg_drain_queue(struct request_queue *q)
746{
747 lockdep_assert_held(q->queue_lock);
748
749 blk_throtl_drain(q);
750}
751
752/**
753 * blkcg_exit_queue - exit and release blkcg part of request_queue
754 * @q: request_queue being released
755 *
756 * Called from blk_release_queue(). Responsible for exiting blkcg part.
757 */
758void blkcg_exit_queue(struct request_queue *q)
759{
6d18b008 760 spin_lock_irq(q->queue_lock);
3c96cb32 761 blkg_destroy_all(q);
6d18b008
TH
762 spin_unlock_irq(q->queue_lock);
763
5efd6113
TH
764 blk_throtl_exit(q);
765}
766
31e4c28d
VG
767/*
768 * We cannot support shared io contexts, as we have no mean to support
769 * two tasks with the same ioc in two different groups without major rework
770 * of the main cic data structures. For now we allow a task to change
771 * its cgroup only if it's the only owner of its ioc.
772 */
3c798398 773static int blkcg_can_attach(struct cgroup *cgrp, struct cgroup_taskset *tset)
31e4c28d 774{
bb9d97b6 775 struct task_struct *task;
31e4c28d
VG
776 struct io_context *ioc;
777 int ret = 0;
778
779 /* task_lock() is needed to avoid races with exit_io_context() */
bb9d97b6
TH
780 cgroup_taskset_for_each(task, cgrp, tset) {
781 task_lock(task);
782 ioc = task->io_context;
783 if (ioc && atomic_read(&ioc->nr_tasks) > 1)
784 ret = -EINVAL;
785 task_unlock(task);
786 if (ret)
787 break;
788 }
31e4c28d
VG
789 return ret;
790}
791
676f7c8f
TH
792struct cgroup_subsys blkio_subsys = {
793 .name = "blkio",
92fb9748
TH
794 .css_alloc = blkcg_css_alloc,
795 .css_offline = blkcg_css_offline,
796 .css_free = blkcg_css_free,
3c798398 797 .can_attach = blkcg_can_attach,
676f7c8f 798 .subsys_id = blkio_subsys_id,
3c798398 799 .base_cftypes = blkcg_files,
676f7c8f 800 .module = THIS_MODULE,
8c7f6edb
TH
801
802 /*
803 * blkio subsystem is utterly broken in terms of hierarchy support.
804 * It treats all cgroups equally regardless of where they're
805 * located in the hierarchy - all cgroups are treated as if they're
806 * right below the root. Fix it and remove the following.
807 */
808 .broken_hierarchy = true,
676f7c8f
TH
809};
810EXPORT_SYMBOL_GPL(blkio_subsys);
811
a2b1693b
TH
812/**
813 * blkcg_activate_policy - activate a blkcg policy on a request_queue
814 * @q: request_queue of interest
815 * @pol: blkcg policy to activate
816 *
817 * Activate @pol on @q. Requires %GFP_KERNEL context. @q goes through
818 * bypass mode to populate its blkgs with policy_data for @pol.
819 *
820 * Activation happens with @q bypassed, so nobody would be accessing blkgs
821 * from IO path. Update of each blkg is protected by both queue and blkcg
822 * locks so that holding either lock and testing blkcg_policy_enabled() is
823 * always enough for dereferencing policy data.
824 *
825 * The caller is responsible for synchronizing [de]activations and policy
826 * [un]registerations. Returns 0 on success, -errno on failure.
827 */
828int blkcg_activate_policy(struct request_queue *q,
3c798398 829 const struct blkcg_policy *pol)
a2b1693b
TH
830{
831 LIST_HEAD(pds);
86cde6b6 832 struct blkcg_gq *blkg, *new_blkg;
a2b1693b
TH
833 struct blkg_policy_data *pd, *n;
834 int cnt = 0, ret;
15974993 835 bool preloaded;
a2b1693b
TH
836
837 if (blkcg_policy_enabled(q, pol))
838 return 0;
839
15974993 840 /* preallocations for root blkg */
86cde6b6
TH
841 new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
842 if (!new_blkg)
15974993
TH
843 return -ENOMEM;
844
845 preloaded = !radix_tree_preload(GFP_KERNEL);
846
a2b1693b
TH
847 blk_queue_bypass_start(q);
848
86cde6b6
TH
849 /*
850 * Make sure the root blkg exists and count the existing blkgs. As
851 * @q is bypassing at this point, blkg_lookup_create() can't be
852 * used. Open code it.
853 */
a2b1693b
TH
854 spin_lock_irq(q->queue_lock);
855
856 rcu_read_lock();
86cde6b6
TH
857 blkg = __blkg_lookup(&blkcg_root, q, false);
858 if (blkg)
859 blkg_free(new_blkg);
860 else
861 blkg = blkg_create(&blkcg_root, q, new_blkg);
a2b1693b
TH
862 rcu_read_unlock();
863
15974993
TH
864 if (preloaded)
865 radix_tree_preload_end();
866
a2b1693b
TH
867 if (IS_ERR(blkg)) {
868 ret = PTR_ERR(blkg);
869 goto out_unlock;
870 }
871 q->root_blkg = blkg;
a051661c 872 q->root_rl.blkg = blkg;
a2b1693b
TH
873
874 list_for_each_entry(blkg, &q->blkg_list, q_node)
875 cnt++;
876
877 spin_unlock_irq(q->queue_lock);
878
879 /* allocate policy_data for all existing blkgs */
880 while (cnt--) {
f95a04af 881 pd = kzalloc_node(pol->pd_size, GFP_KERNEL, q->node);
a2b1693b
TH
882 if (!pd) {
883 ret = -ENOMEM;
884 goto out_free;
885 }
886 list_add_tail(&pd->alloc_node, &pds);
887 }
888
889 /*
890 * Install the allocated pds. With @q bypassing, no new blkg
891 * should have been created while the queue lock was dropped.
892 */
893 spin_lock_irq(q->queue_lock);
894
895 list_for_each_entry(blkg, &q->blkg_list, q_node) {
896 if (WARN_ON(list_empty(&pds))) {
897 /* umm... this shouldn't happen, just abort */
898 ret = -ENOMEM;
899 goto out_unlock;
900 }
901 pd = list_first_entry(&pds, struct blkg_policy_data, alloc_node);
902 list_del_init(&pd->alloc_node);
903
904 /* grab blkcg lock too while installing @pd on @blkg */
905 spin_lock(&blkg->blkcg->lock);
906
907 blkg->pd[pol->plid] = pd;
908 pd->blkg = blkg;
f9fcc2d3 909 pol->pd_init_fn(blkg);
a2b1693b
TH
910
911 spin_unlock(&blkg->blkcg->lock);
912 }
913
914 __set_bit(pol->plid, q->blkcg_pols);
915 ret = 0;
916out_unlock:
917 spin_unlock_irq(q->queue_lock);
918out_free:
919 blk_queue_bypass_end(q);
920 list_for_each_entry_safe(pd, n, &pds, alloc_node)
921 kfree(pd);
922 return ret;
923}
924EXPORT_SYMBOL_GPL(blkcg_activate_policy);
925
926/**
927 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
928 * @q: request_queue of interest
929 * @pol: blkcg policy to deactivate
930 *
931 * Deactivate @pol on @q. Follows the same synchronization rules as
932 * blkcg_activate_policy().
933 */
934void blkcg_deactivate_policy(struct request_queue *q,
3c798398 935 const struct blkcg_policy *pol)
a2b1693b 936{
3c798398 937 struct blkcg_gq *blkg;
a2b1693b
TH
938
939 if (!blkcg_policy_enabled(q, pol))
940 return;
941
942 blk_queue_bypass_start(q);
943 spin_lock_irq(q->queue_lock);
944
945 __clear_bit(pol->plid, q->blkcg_pols);
946
6d18b008
TH
947 /* if no policy is left, no need for blkgs - shoot them down */
948 if (bitmap_empty(q->blkcg_pols, BLKCG_MAX_POLS))
949 blkg_destroy_all(q);
950
a2b1693b
TH
951 list_for_each_entry(blkg, &q->blkg_list, q_node) {
952 /* grab blkcg lock too while removing @pd from @blkg */
953 spin_lock(&blkg->blkcg->lock);
954
f9fcc2d3
TH
955 if (pol->pd_exit_fn)
956 pol->pd_exit_fn(blkg);
a2b1693b
TH
957
958 kfree(blkg->pd[pol->plid]);
959 blkg->pd[pol->plid] = NULL;
960
961 spin_unlock(&blkg->blkcg->lock);
962 }
963
964 spin_unlock_irq(q->queue_lock);
965 blk_queue_bypass_end(q);
966}
967EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
968
8bd435b3 969/**
3c798398
TH
970 * blkcg_policy_register - register a blkcg policy
971 * @pol: blkcg policy to register
8bd435b3 972 *
3c798398
TH
973 * Register @pol with blkcg core. Might sleep and @pol may be modified on
974 * successful registration. Returns 0 on success and -errno on failure.
8bd435b3 975 */
3c798398 976int blkcg_policy_register(struct blkcg_policy *pol)
3e252066 977{
8bd435b3 978 int i, ret;
e8989fae 979
f95a04af
TH
980 if (WARN_ON(pol->pd_size < sizeof(struct blkg_policy_data)))
981 return -EINVAL;
982
bc0d6501
TH
983 mutex_lock(&blkcg_pol_mutex);
984
8bd435b3
TH
985 /* find an empty slot */
986 ret = -ENOSPC;
987 for (i = 0; i < BLKCG_MAX_POLS; i++)
3c798398 988 if (!blkcg_policy[i])
8bd435b3
TH
989 break;
990 if (i >= BLKCG_MAX_POLS)
991 goto out_unlock;
035d10b2 992
8bd435b3 993 /* register and update blkgs */
3c798398
TH
994 pol->plid = i;
995 blkcg_policy[i] = pol;
8bd435b3 996
8bd435b3 997 /* everything is in place, add intf files for the new policy */
3c798398
TH
998 if (pol->cftypes)
999 WARN_ON(cgroup_add_cftypes(&blkio_subsys, pol->cftypes));
8bd435b3
TH
1000 ret = 0;
1001out_unlock:
bc0d6501 1002 mutex_unlock(&blkcg_pol_mutex);
8bd435b3 1003 return ret;
3e252066 1004}
3c798398 1005EXPORT_SYMBOL_GPL(blkcg_policy_register);
3e252066 1006
8bd435b3 1007/**
3c798398
TH
1008 * blkcg_policy_unregister - unregister a blkcg policy
1009 * @pol: blkcg policy to unregister
8bd435b3 1010 *
3c798398 1011 * Undo blkcg_policy_register(@pol). Might sleep.
8bd435b3 1012 */
3c798398 1013void blkcg_policy_unregister(struct blkcg_policy *pol)
3e252066 1014{
bc0d6501
TH
1015 mutex_lock(&blkcg_pol_mutex);
1016
3c798398 1017 if (WARN_ON(blkcg_policy[pol->plid] != pol))
8bd435b3
TH
1018 goto out_unlock;
1019
1020 /* kill the intf files first */
3c798398
TH
1021 if (pol->cftypes)
1022 cgroup_rm_cftypes(&blkio_subsys, pol->cftypes);
44ea53de 1023
8bd435b3 1024 /* unregister and update blkgs */
3c798398 1025 blkcg_policy[pol->plid] = NULL;
8bd435b3 1026out_unlock:
bc0d6501 1027 mutex_unlock(&blkcg_pol_mutex);
3e252066 1028}
3c798398 1029EXPORT_SYMBOL_GPL(blkcg_policy_unregister);