blkcg: handle dying request_queue when associating a blkg
[sfrench/cifs-2.6.git] / block / blk-cgroup.c
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  * For policy-specific per-blkcg data:
14  * Copyright (C) 2015 Paolo Valente <paolo.valente@unimore.it>
15  *                    Arianna Avanzini <avanzini.arianna@gmail.com>
16  */
17 #include <linux/ioprio.h>
18 #include <linux/kdev_t.h>
19 #include <linux/module.h>
20 #include <linux/sched/signal.h>
21 #include <linux/err.h>
22 #include <linux/blkdev.h>
23 #include <linux/backing-dev.h>
24 #include <linux/slab.h>
25 #include <linux/genhd.h>
26 #include <linux/delay.h>
27 #include <linux/atomic.h>
28 #include <linux/ctype.h>
29 #include <linux/blk-cgroup.h>
30 #include <linux/tracehook.h>
31 #include "blk.h"
32
33 #define MAX_KEY_LEN 100
34
35 /*
36  * blkcg_pol_mutex protects blkcg_policy[] and policy [de]activation.
37  * blkcg_pol_register_mutex nests outside of it and synchronizes entire
38  * policy [un]register operations including cgroup file additions /
39  * removals.  Putting cgroup file registration outside blkcg_pol_mutex
40  * allows grabbing it from cgroup callbacks.
41  */
42 static DEFINE_MUTEX(blkcg_pol_register_mutex);
43 static DEFINE_MUTEX(blkcg_pol_mutex);
44
45 struct blkcg blkcg_root;
46 EXPORT_SYMBOL_GPL(blkcg_root);
47
48 struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;
49
50 static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
51
52 static LIST_HEAD(all_blkcgs);           /* protected by blkcg_pol_mutex */
53
54 static bool blkcg_debug_stats = false;
55
56 static bool blkcg_policy_enabled(struct request_queue *q,
57                                  const struct blkcg_policy *pol)
58 {
59         return pol && test_bit(pol->plid, q->blkcg_pols);
60 }
61
62 /**
63  * blkg_free - free a blkg
64  * @blkg: blkg to free
65  *
66  * Free @blkg which may be partially allocated.
67  */
68 static void blkg_free(struct blkcg_gq *blkg)
69 {
70         int i;
71
72         if (!blkg)
73                 return;
74
75         for (i = 0; i < BLKCG_MAX_POLS; i++)
76                 if (blkg->pd[i])
77                         blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
78
79         blkg_rwstat_exit(&blkg->stat_ios);
80         blkg_rwstat_exit(&blkg->stat_bytes);
81         kfree(blkg);
82 }
83
84 static void __blkg_release(struct rcu_head *rcu)
85 {
86         struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);
87
88         percpu_ref_exit(&blkg->refcnt);
89
90         /* release the blkcg and parent blkg refs this blkg has been holding */
91         css_put(&blkg->blkcg->css);
92         if (blkg->parent)
93                 blkg_put(blkg->parent);
94
95         wb_congested_put(blkg->wb_congested);
96
97         blkg_free(blkg);
98 }
99
100 /*
101  * A group is RCU protected, but having an rcu lock does not mean that one
102  * can access all the fields of blkg and assume these are valid.  For
103  * example, don't try to follow throtl_data and request queue links.
104  *
105  * Having a reference to blkg under an rcu allows accesses to only values
106  * local to groups like group stats and group rate limits.
107  */
108 static void blkg_release(struct percpu_ref *ref)
109 {
110         struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);
111
112         call_rcu(&blkg->rcu_head, __blkg_release);
113 }
114
115 /**
116  * blkg_alloc - allocate a blkg
117  * @blkcg: block cgroup the new blkg is associated with
118  * @q: request_queue the new blkg is associated with
119  * @gfp_mask: allocation mask to use
120  *
121  * Allocate a new blkg assocating @blkcg and @q.
122  */
123 static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct request_queue *q,
124                                    gfp_t gfp_mask)
125 {
126         struct blkcg_gq *blkg;
127         int i;
128
129         /* alloc and init base part */
130         blkg = kzalloc_node(sizeof(*blkg), gfp_mask, q->node);
131         if (!blkg)
132                 return NULL;
133
134         if (blkg_rwstat_init(&blkg->stat_bytes, gfp_mask) ||
135             blkg_rwstat_init(&blkg->stat_ios, gfp_mask))
136                 goto err_free;
137
138         blkg->q = q;
139         INIT_LIST_HEAD(&blkg->q_node);
140         blkg->blkcg = blkcg;
141
142         for (i = 0; i < BLKCG_MAX_POLS; i++) {
143                 struct blkcg_policy *pol = blkcg_policy[i];
144                 struct blkg_policy_data *pd;
145
146                 if (!blkcg_policy_enabled(q, pol))
147                         continue;
148
149                 /* alloc per-policy data and attach it to blkg */
150                 pd = pol->pd_alloc_fn(gfp_mask, q->node);
151                 if (!pd)
152                         goto err_free;
153
154                 blkg->pd[i] = pd;
155                 pd->blkg = blkg;
156                 pd->plid = i;
157         }
158
159         return blkg;
160
161 err_free:
162         blkg_free(blkg);
163         return NULL;
164 }
165
166 struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
167                                       struct request_queue *q, bool update_hint)
168 {
169         struct blkcg_gq *blkg;
170
171         /*
172          * Hint didn't match.  Look up from the radix tree.  Note that the
173          * hint can only be updated under queue_lock as otherwise @blkg
174          * could have already been removed from blkg_tree.  The caller is
175          * responsible for grabbing queue_lock if @update_hint.
176          */
177         blkg = radix_tree_lookup(&blkcg->blkg_tree, q->id);
178         if (blkg && blkg->q == q) {
179                 if (update_hint) {
180                         lockdep_assert_held(&q->queue_lock);
181                         rcu_assign_pointer(blkcg->blkg_hint, blkg);
182                 }
183                 return blkg;
184         }
185
186         return NULL;
187 }
188 EXPORT_SYMBOL_GPL(blkg_lookup_slowpath);
189
190 /*
191  * If @new_blkg is %NULL, this function tries to allocate a new one as
192  * necessary using %GFP_NOWAIT.  @new_blkg is always consumed on return.
193  */
194 static struct blkcg_gq *blkg_create(struct blkcg *blkcg,
195                                     struct request_queue *q,
196                                     struct blkcg_gq *new_blkg)
197 {
198         struct blkcg_gq *blkg;
199         struct bdi_writeback_congested *wb_congested;
200         int i, ret;
201
202         WARN_ON_ONCE(!rcu_read_lock_held());
203         lockdep_assert_held(&q->queue_lock);
204
205         /* request_queue is dying, do not create/recreate a blkg */
206         if (blk_queue_dying(q)) {
207                 ret = -ENODEV;
208                 goto err_free_blkg;
209         }
210
211         /* blkg holds a reference to blkcg */
212         if (!css_tryget_online(&blkcg->css)) {
213                 ret = -ENODEV;
214                 goto err_free_blkg;
215         }
216
217         wb_congested = wb_congested_get_create(q->backing_dev_info,
218                                                blkcg->css.id,
219                                                GFP_NOWAIT | __GFP_NOWARN);
220         if (!wb_congested) {
221                 ret = -ENOMEM;
222                 goto err_put_css;
223         }
224
225         /* allocate */
226         if (!new_blkg) {
227                 new_blkg = blkg_alloc(blkcg, q, GFP_NOWAIT | __GFP_NOWARN);
228                 if (unlikely(!new_blkg)) {
229                         ret = -ENOMEM;
230                         goto err_put_congested;
231                 }
232         }
233         blkg = new_blkg;
234         blkg->wb_congested = wb_congested;
235
236         /* link parent */
237         if (blkcg_parent(blkcg)) {
238                 blkg->parent = __blkg_lookup(blkcg_parent(blkcg), q, false);
239                 if (WARN_ON_ONCE(!blkg->parent)) {
240                         ret = -ENODEV;
241                         goto err_put_congested;
242                 }
243                 blkg_get(blkg->parent);
244         }
245
246         ret = percpu_ref_init(&blkg->refcnt, blkg_release, 0,
247                               GFP_NOWAIT | __GFP_NOWARN);
248         if (ret)
249                 goto err_cancel_ref;
250
251         /* invoke per-policy init */
252         for (i = 0; i < BLKCG_MAX_POLS; i++) {
253                 struct blkcg_policy *pol = blkcg_policy[i];
254
255                 if (blkg->pd[i] && pol->pd_init_fn)
256                         pol->pd_init_fn(blkg->pd[i]);
257         }
258
259         /* insert */
260         spin_lock(&blkcg->lock);
261         ret = radix_tree_insert(&blkcg->blkg_tree, q->id, blkg);
262         if (likely(!ret)) {
263                 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
264                 list_add(&blkg->q_node, &q->blkg_list);
265
266                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
267                         struct blkcg_policy *pol = blkcg_policy[i];
268
269                         if (blkg->pd[i] && pol->pd_online_fn)
270                                 pol->pd_online_fn(blkg->pd[i]);
271                 }
272         }
273         blkg->online = true;
274         spin_unlock(&blkcg->lock);
275
276         if (!ret)
277                 return blkg;
278
279         /* @blkg failed fully initialized, use the usual release path */
280         blkg_put(blkg);
281         return ERR_PTR(ret);
282
283 err_cancel_ref:
284         percpu_ref_exit(&blkg->refcnt);
285 err_put_congested:
286         wb_congested_put(wb_congested);
287 err_put_css:
288         css_put(&blkcg->css);
289 err_free_blkg:
290         blkg_free(new_blkg);
291         return ERR_PTR(ret);
292 }
293
294 /**
295  * __blkg_lookup_create - lookup blkg, try to create one if not there
296  * @blkcg: blkcg of interest
297  * @q: request_queue of interest
298  *
299  * Lookup blkg for the @blkcg - @q pair.  If it doesn't exist, try to
300  * create one.  blkg creation is performed recursively from blkcg_root such
301  * that all non-root blkg's have access to the parent blkg.  This function
302  * should be called under RCU read lock and @q->queue_lock.
303  *
304  * Returns the blkg or the closest blkg if blkg_create() fails as it walks
305  * down from root.
306  */
307 struct blkcg_gq *__blkg_lookup_create(struct blkcg *blkcg,
308                                       struct request_queue *q)
309 {
310         struct blkcg_gq *blkg;
311
312         WARN_ON_ONCE(!rcu_read_lock_held());
313         lockdep_assert_held(&q->queue_lock);
314
315         blkg = __blkg_lookup(blkcg, q, true);
316         if (blkg)
317                 return blkg;
318
319         /*
320          * Create blkgs walking down from blkcg_root to @blkcg, so that all
321          * non-root blkgs have access to their parents.  Returns the closest
322          * blkg to the intended blkg should blkg_create() fail.
323          */
324         while (true) {
325                 struct blkcg *pos = blkcg;
326                 struct blkcg *parent = blkcg_parent(blkcg);
327                 struct blkcg_gq *ret_blkg = q->root_blkg;
328
329                 while (parent) {
330                         blkg = __blkg_lookup(parent, q, false);
331                         if (blkg) {
332                                 /* remember closest blkg */
333                                 ret_blkg = blkg;
334                                 break;
335                         }
336                         pos = parent;
337                         parent = blkcg_parent(parent);
338                 }
339
340                 blkg = blkg_create(pos, q, NULL);
341                 if (IS_ERR(blkg))
342                         return ret_blkg;
343                 if (pos == blkcg)
344                         return blkg;
345         }
346 }
347
348 /**
349  * blkg_lookup_create - find or create a blkg
350  * @blkcg: target block cgroup
351  * @q: target request_queue
352  *
353  * This looks up or creates the blkg representing the unique pair
354  * of the blkcg and the request_queue.
355  */
356 struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
357                                     struct request_queue *q)
358 {
359         struct blkcg_gq *blkg = blkg_lookup(blkcg, q);
360
361         if (unlikely(!blkg)) {
362                 spin_lock_irq(&q->queue_lock);
363                 blkg = __blkg_lookup_create(blkcg, q);
364                 spin_unlock_irq(&q->queue_lock);
365         }
366
367         return blkg;
368 }
369
370 static void blkg_destroy(struct blkcg_gq *blkg)
371 {
372         struct blkcg *blkcg = blkg->blkcg;
373         struct blkcg_gq *parent = blkg->parent;
374         int i;
375
376         lockdep_assert_held(&blkg->q->queue_lock);
377         lockdep_assert_held(&blkcg->lock);
378
379         /* Something wrong if we are trying to remove same group twice */
380         WARN_ON_ONCE(list_empty(&blkg->q_node));
381         WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
382
383         for (i = 0; i < BLKCG_MAX_POLS; i++) {
384                 struct blkcg_policy *pol = blkcg_policy[i];
385
386                 if (blkg->pd[i] && pol->pd_offline_fn)
387                         pol->pd_offline_fn(blkg->pd[i]);
388         }
389
390         if (parent) {
391                 blkg_rwstat_add_aux(&parent->stat_bytes, &blkg->stat_bytes);
392                 blkg_rwstat_add_aux(&parent->stat_ios, &blkg->stat_ios);
393         }
394
395         blkg->online = false;
396
397         radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
398         list_del_init(&blkg->q_node);
399         hlist_del_init_rcu(&blkg->blkcg_node);
400
401         /*
402          * Both setting lookup hint to and clearing it from @blkg are done
403          * under queue_lock.  If it's not pointing to @blkg now, it never
404          * will.  Hint assignment itself can race safely.
405          */
406         if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
407                 rcu_assign_pointer(blkcg->blkg_hint, NULL);
408
409         /*
410          * Put the reference taken at the time of creation so that when all
411          * queues are gone, group can be destroyed.
412          */
413         percpu_ref_kill(&blkg->refcnt);
414 }
415
416 /**
417  * blkg_destroy_all - destroy all blkgs associated with a request_queue
418  * @q: request_queue of interest
419  *
420  * Destroy all blkgs associated with @q.
421  */
422 static void blkg_destroy_all(struct request_queue *q)
423 {
424         struct blkcg_gq *blkg, *n;
425
426         spin_lock_irq(&q->queue_lock);
427         list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
428                 struct blkcg *blkcg = blkg->blkcg;
429
430                 spin_lock(&blkcg->lock);
431                 blkg_destroy(blkg);
432                 spin_unlock(&blkcg->lock);
433         }
434
435         q->root_blkg = NULL;
436         spin_unlock_irq(&q->queue_lock);
437 }
438
439 /*
440  * A group is RCU protected, but having an rcu lock does not mean that one
441  * can access all the fields of blkg and assume these are valid.  For
442  * example, don't try to follow throtl_data and request queue links.
443  *
444  * Having a reference to blkg under an rcu allows accesses to only values
445  * local to groups like group stats and group rate limits.
446  */
447 void __blkg_release_rcu(struct rcu_head *rcu_head)
448 {
449         struct blkcg_gq *blkg = container_of(rcu_head, struct blkcg_gq, rcu_head);
450
451         /* release the blkcg and parent blkg refs this blkg has been holding */
452         css_put(&blkg->blkcg->css);
453         if (blkg->parent)
454                 blkg_put(blkg->parent);
455
456         wb_congested_put(blkg->wb_congested);
457
458         blkg_free(blkg);
459 }
460 EXPORT_SYMBOL_GPL(__blkg_release_rcu);
461
462 static int blkcg_reset_stats(struct cgroup_subsys_state *css,
463                              struct cftype *cftype, u64 val)
464 {
465         struct blkcg *blkcg = css_to_blkcg(css);
466         struct blkcg_gq *blkg;
467         int i;
468
469         mutex_lock(&blkcg_pol_mutex);
470         spin_lock_irq(&blkcg->lock);
471
472         /*
473          * Note that stat reset is racy - it doesn't synchronize against
474          * stat updates.  This is a debug feature which shouldn't exist
475          * anyway.  If you get hit by a race, retry.
476          */
477         hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
478                 blkg_rwstat_reset(&blkg->stat_bytes);
479                 blkg_rwstat_reset(&blkg->stat_ios);
480
481                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
482                         struct blkcg_policy *pol = blkcg_policy[i];
483
484                         if (blkg->pd[i] && pol->pd_reset_stats_fn)
485                                 pol->pd_reset_stats_fn(blkg->pd[i]);
486                 }
487         }
488
489         spin_unlock_irq(&blkcg->lock);
490         mutex_unlock(&blkcg_pol_mutex);
491         return 0;
492 }
493
494 const char *blkg_dev_name(struct blkcg_gq *blkg)
495 {
496         /* some drivers (floppy) instantiate a queue w/o disk registered */
497         if (blkg->q->backing_dev_info->dev)
498                 return dev_name(blkg->q->backing_dev_info->dev);
499         return NULL;
500 }
501
502 /**
503  * blkcg_print_blkgs - helper for printing per-blkg data
504  * @sf: seq_file to print to
505  * @blkcg: blkcg of interest
506  * @prfill: fill function to print out a blkg
507  * @pol: policy in question
508  * @data: data to be passed to @prfill
509  * @show_total: to print out sum of prfill return values or not
510  *
511  * This function invokes @prfill on each blkg of @blkcg if pd for the
512  * policy specified by @pol exists.  @prfill is invoked with @sf, the
513  * policy data and @data and the matching queue lock held.  If @show_total
514  * is %true, the sum of the return values from @prfill is printed with
515  * "Total" label at the end.
516  *
517  * This is to be used to construct print functions for
518  * cftype->read_seq_string method.
519  */
520 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
521                        u64 (*prfill)(struct seq_file *,
522                                      struct blkg_policy_data *, int),
523                        const struct blkcg_policy *pol, int data,
524                        bool show_total)
525 {
526         struct blkcg_gq *blkg;
527         u64 total = 0;
528
529         rcu_read_lock();
530         hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
531                 spin_lock_irq(&blkg->q->queue_lock);
532                 if (blkcg_policy_enabled(blkg->q, pol))
533                         total += prfill(sf, blkg->pd[pol->plid], data);
534                 spin_unlock_irq(&blkg->q->queue_lock);
535         }
536         rcu_read_unlock();
537
538         if (show_total)
539                 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
540 }
541 EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
542
543 /**
544  * __blkg_prfill_u64 - prfill helper for a single u64 value
545  * @sf: seq_file to print to
546  * @pd: policy private data of interest
547  * @v: value to print
548  *
549  * Print @v to @sf for the device assocaited with @pd.
550  */
551 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
552 {
553         const char *dname = blkg_dev_name(pd->blkg);
554
555         if (!dname)
556                 return 0;
557
558         seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
559         return v;
560 }
561 EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
562
563 /**
564  * __blkg_prfill_rwstat - prfill helper for a blkg_rwstat
565  * @sf: seq_file to print to
566  * @pd: policy private data of interest
567  * @rwstat: rwstat to print
568  *
569  * Print @rwstat to @sf for the device assocaited with @pd.
570  */
571 u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
572                          const struct blkg_rwstat *rwstat)
573 {
574         static const char *rwstr[] = {
575                 [BLKG_RWSTAT_READ]      = "Read",
576                 [BLKG_RWSTAT_WRITE]     = "Write",
577                 [BLKG_RWSTAT_SYNC]      = "Sync",
578                 [BLKG_RWSTAT_ASYNC]     = "Async",
579                 [BLKG_RWSTAT_DISCARD]   = "Discard",
580         };
581         const char *dname = blkg_dev_name(pd->blkg);
582         u64 v;
583         int i;
584
585         if (!dname)
586                 return 0;
587
588         for (i = 0; i < BLKG_RWSTAT_NR; i++)
589                 seq_printf(sf, "%s %s %llu\n", dname, rwstr[i],
590                            (unsigned long long)atomic64_read(&rwstat->aux_cnt[i]));
591
592         v = atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_READ]) +
593                 atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_WRITE]) +
594                 atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_DISCARD]);
595         seq_printf(sf, "%s Total %llu\n", dname, (unsigned long long)v);
596         return v;
597 }
598 EXPORT_SYMBOL_GPL(__blkg_prfill_rwstat);
599
600 /**
601  * blkg_prfill_stat - prfill callback for blkg_stat
602  * @sf: seq_file to print to
603  * @pd: policy private data of interest
604  * @off: offset to the blkg_stat in @pd
605  *
606  * prfill callback for printing a blkg_stat.
607  */
608 u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off)
609 {
610         return __blkg_prfill_u64(sf, pd, blkg_stat_read((void *)pd + off));
611 }
612 EXPORT_SYMBOL_GPL(blkg_prfill_stat);
613
614 /**
615  * blkg_prfill_rwstat - prfill callback for blkg_rwstat
616  * @sf: seq_file to print to
617  * @pd: policy private data of interest
618  * @off: offset to the blkg_rwstat in @pd
619  *
620  * prfill callback for printing a blkg_rwstat.
621  */
622 u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
623                        int off)
624 {
625         struct blkg_rwstat rwstat = blkg_rwstat_read((void *)pd + off);
626
627         return __blkg_prfill_rwstat(sf, pd, &rwstat);
628 }
629 EXPORT_SYMBOL_GPL(blkg_prfill_rwstat);
630
631 static u64 blkg_prfill_rwstat_field(struct seq_file *sf,
632                                     struct blkg_policy_data *pd, int off)
633 {
634         struct blkg_rwstat rwstat = blkg_rwstat_read((void *)pd->blkg + off);
635
636         return __blkg_prfill_rwstat(sf, pd, &rwstat);
637 }
638
639 /**
640  * blkg_print_stat_bytes - seq_show callback for blkg->stat_bytes
641  * @sf: seq_file to print to
642  * @v: unused
643  *
644  * To be used as cftype->seq_show to print blkg->stat_bytes.
645  * cftype->private must be set to the blkcg_policy.
646  */
647 int blkg_print_stat_bytes(struct seq_file *sf, void *v)
648 {
649         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
650                           blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
651                           offsetof(struct blkcg_gq, stat_bytes), true);
652         return 0;
653 }
654 EXPORT_SYMBOL_GPL(blkg_print_stat_bytes);
655
656 /**
657  * blkg_print_stat_bytes - seq_show callback for blkg->stat_ios
658  * @sf: seq_file to print to
659  * @v: unused
660  *
661  * To be used as cftype->seq_show to print blkg->stat_ios.  cftype->private
662  * must be set to the blkcg_policy.
663  */
664 int blkg_print_stat_ios(struct seq_file *sf, void *v)
665 {
666         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
667                           blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
668                           offsetof(struct blkcg_gq, stat_ios), true);
669         return 0;
670 }
671 EXPORT_SYMBOL_GPL(blkg_print_stat_ios);
672
673 static u64 blkg_prfill_rwstat_field_recursive(struct seq_file *sf,
674                                               struct blkg_policy_data *pd,
675                                               int off)
676 {
677         struct blkg_rwstat rwstat = blkg_rwstat_recursive_sum(pd->blkg,
678                                                               NULL, off);
679         return __blkg_prfill_rwstat(sf, pd, &rwstat);
680 }
681
682 /**
683  * blkg_print_stat_bytes_recursive - recursive version of blkg_print_stat_bytes
684  * @sf: seq_file to print to
685  * @v: unused
686  */
687 int blkg_print_stat_bytes_recursive(struct seq_file *sf, void *v)
688 {
689         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
690                           blkg_prfill_rwstat_field_recursive,
691                           (void *)seq_cft(sf)->private,
692                           offsetof(struct blkcg_gq, stat_bytes), true);
693         return 0;
694 }
695 EXPORT_SYMBOL_GPL(blkg_print_stat_bytes_recursive);
696
697 /**
698  * blkg_print_stat_ios_recursive - recursive version of blkg_print_stat_ios
699  * @sf: seq_file to print to
700  * @v: unused
701  */
702 int blkg_print_stat_ios_recursive(struct seq_file *sf, void *v)
703 {
704         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
705                           blkg_prfill_rwstat_field_recursive,
706                           (void *)seq_cft(sf)->private,
707                           offsetof(struct blkcg_gq, stat_ios), true);
708         return 0;
709 }
710 EXPORT_SYMBOL_GPL(blkg_print_stat_ios_recursive);
711
712 /**
713  * blkg_stat_recursive_sum - collect hierarchical blkg_stat
714  * @blkg: blkg of interest
715  * @pol: blkcg_policy which contains the blkg_stat
716  * @off: offset to the blkg_stat in blkg_policy_data or @blkg
717  *
718  * Collect the blkg_stat specified by @blkg, @pol and @off and all its
719  * online descendants and their aux counts.  The caller must be holding the
720  * queue lock for online tests.
721  *
722  * If @pol is NULL, blkg_stat is at @off bytes into @blkg; otherwise, it is
723  * at @off bytes into @blkg's blkg_policy_data of the policy.
724  */
725 u64 blkg_stat_recursive_sum(struct blkcg_gq *blkg,
726                             struct blkcg_policy *pol, int off)
727 {
728         struct blkcg_gq *pos_blkg;
729         struct cgroup_subsys_state *pos_css;
730         u64 sum = 0;
731
732         lockdep_assert_held(&blkg->q->queue_lock);
733
734         rcu_read_lock();
735         blkg_for_each_descendant_pre(pos_blkg, pos_css, blkg) {
736                 struct blkg_stat *stat;
737
738                 if (!pos_blkg->online)
739                         continue;
740
741                 if (pol)
742                         stat = (void *)blkg_to_pd(pos_blkg, pol) + off;
743                 else
744                         stat = (void *)blkg + off;
745
746                 sum += blkg_stat_read(stat) + atomic64_read(&stat->aux_cnt);
747         }
748         rcu_read_unlock();
749
750         return sum;
751 }
752 EXPORT_SYMBOL_GPL(blkg_stat_recursive_sum);
753
754 /**
755  * blkg_rwstat_recursive_sum - collect hierarchical blkg_rwstat
756  * @blkg: blkg of interest
757  * @pol: blkcg_policy which contains the blkg_rwstat
758  * @off: offset to the blkg_rwstat in blkg_policy_data or @blkg
759  *
760  * Collect the blkg_rwstat specified by @blkg, @pol and @off and all its
761  * online descendants and their aux counts.  The caller must be holding the
762  * queue lock for online tests.
763  *
764  * If @pol is NULL, blkg_rwstat is at @off bytes into @blkg; otherwise, it
765  * is at @off bytes into @blkg's blkg_policy_data of the policy.
766  */
767 struct blkg_rwstat blkg_rwstat_recursive_sum(struct blkcg_gq *blkg,
768                                              struct blkcg_policy *pol, int off)
769 {
770         struct blkcg_gq *pos_blkg;
771         struct cgroup_subsys_state *pos_css;
772         struct blkg_rwstat sum = { };
773         int i;
774
775         lockdep_assert_held(&blkg->q->queue_lock);
776
777         rcu_read_lock();
778         blkg_for_each_descendant_pre(pos_blkg, pos_css, blkg) {
779                 struct blkg_rwstat *rwstat;
780
781                 if (!pos_blkg->online)
782                         continue;
783
784                 if (pol)
785                         rwstat = (void *)blkg_to_pd(pos_blkg, pol) + off;
786                 else
787                         rwstat = (void *)pos_blkg + off;
788
789                 for (i = 0; i < BLKG_RWSTAT_NR; i++)
790                         atomic64_add(atomic64_read(&rwstat->aux_cnt[i]) +
791                                 percpu_counter_sum_positive(&rwstat->cpu_cnt[i]),
792                                 &sum.aux_cnt[i]);
793         }
794         rcu_read_unlock();
795
796         return sum;
797 }
798 EXPORT_SYMBOL_GPL(blkg_rwstat_recursive_sum);
799
800 /* Performs queue bypass and policy enabled checks then looks up blkg. */
801 static struct blkcg_gq *blkg_lookup_check(struct blkcg *blkcg,
802                                           const struct blkcg_policy *pol,
803                                           struct request_queue *q)
804 {
805         WARN_ON_ONCE(!rcu_read_lock_held());
806         lockdep_assert_held(&q->queue_lock);
807
808         if (!blkcg_policy_enabled(q, pol))
809                 return ERR_PTR(-EOPNOTSUPP);
810         return __blkg_lookup(blkcg, q, true /* update_hint */);
811 }
812
813 /**
814  * blkg_conf_prep - parse and prepare for per-blkg config update
815  * @blkcg: target block cgroup
816  * @pol: target policy
817  * @input: input string
818  * @ctx: blkg_conf_ctx to be filled
819  *
820  * Parse per-blkg config update from @input and initialize @ctx with the
821  * result.  @ctx->blkg points to the blkg to be updated and @ctx->body the
822  * part of @input following MAJ:MIN.  This function returns with RCU read
823  * lock and queue lock held and must be paired with blkg_conf_finish().
824  */
825 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
826                    char *input, struct blkg_conf_ctx *ctx)
827         __acquires(rcu) __acquires(&disk->queue->queue_lock)
828 {
829         struct gendisk *disk;
830         struct request_queue *q;
831         struct blkcg_gq *blkg;
832         unsigned int major, minor;
833         int key_len, part, ret;
834         char *body;
835
836         if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
837                 return -EINVAL;
838
839         body = input + key_len;
840         if (!isspace(*body))
841                 return -EINVAL;
842         body = skip_spaces(body);
843
844         disk = get_gendisk(MKDEV(major, minor), &part);
845         if (!disk)
846                 return -ENODEV;
847         if (part) {
848                 ret = -ENODEV;
849                 goto fail;
850         }
851
852         q = disk->queue;
853
854         rcu_read_lock();
855         spin_lock_irq(&q->queue_lock);
856
857         blkg = blkg_lookup_check(blkcg, pol, q);
858         if (IS_ERR(blkg)) {
859                 ret = PTR_ERR(blkg);
860                 goto fail_unlock;
861         }
862
863         if (blkg)
864                 goto success;
865
866         /*
867          * Create blkgs walking down from blkcg_root to @blkcg, so that all
868          * non-root blkgs have access to their parents.
869          */
870         while (true) {
871                 struct blkcg *pos = blkcg;
872                 struct blkcg *parent;
873                 struct blkcg_gq *new_blkg;
874
875                 parent = blkcg_parent(blkcg);
876                 while (parent && !__blkg_lookup(parent, q, false)) {
877                         pos = parent;
878                         parent = blkcg_parent(parent);
879                 }
880
881                 /* Drop locks to do new blkg allocation with GFP_KERNEL. */
882                 spin_unlock_irq(&q->queue_lock);
883                 rcu_read_unlock();
884
885                 new_blkg = blkg_alloc(pos, q, GFP_KERNEL);
886                 if (unlikely(!new_blkg)) {
887                         ret = -ENOMEM;
888                         goto fail;
889                 }
890
891                 rcu_read_lock();
892                 spin_lock_irq(&q->queue_lock);
893
894                 blkg = blkg_lookup_check(pos, pol, q);
895                 if (IS_ERR(blkg)) {
896                         ret = PTR_ERR(blkg);
897                         goto fail_unlock;
898                 }
899
900                 if (blkg) {
901                         blkg_free(new_blkg);
902                 } else {
903                         blkg = blkg_create(pos, q, new_blkg);
904                         if (unlikely(IS_ERR(blkg))) {
905                                 ret = PTR_ERR(blkg);
906                                 goto fail_unlock;
907                         }
908                 }
909
910                 if (pos == blkcg)
911                         goto success;
912         }
913 success:
914         ctx->disk = disk;
915         ctx->blkg = blkg;
916         ctx->body = body;
917         return 0;
918
919 fail_unlock:
920         spin_unlock_irq(&q->queue_lock);
921         rcu_read_unlock();
922 fail:
923         put_disk_and_module(disk);
924         /*
925          * If queue was bypassing, we should retry.  Do so after a
926          * short msleep().  It isn't strictly necessary but queue
927          * can be bypassing for some time and it's always nice to
928          * avoid busy looping.
929          */
930         if (ret == -EBUSY) {
931                 msleep(10);
932                 ret = restart_syscall();
933         }
934         return ret;
935 }
936
937 /**
938  * blkg_conf_finish - finish up per-blkg config update
939  * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
940  *
941  * Finish up after per-blkg config update.  This function must be paired
942  * with blkg_conf_prep().
943  */
944 void blkg_conf_finish(struct blkg_conf_ctx *ctx)
945         __releases(&ctx->disk->queue->queue_lock) __releases(rcu)
946 {
947         spin_unlock_irq(&ctx->disk->queue->queue_lock);
948         rcu_read_unlock();
949         put_disk_and_module(ctx->disk);
950 }
951
952 static int blkcg_print_stat(struct seq_file *sf, void *v)
953 {
954         struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
955         struct blkcg_gq *blkg;
956
957         rcu_read_lock();
958
959         hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
960                 const char *dname;
961                 char *buf;
962                 struct blkg_rwstat rwstat;
963                 u64 rbytes, wbytes, rios, wios, dbytes, dios;
964                 size_t size = seq_get_buf(sf, &buf), off = 0;
965                 int i;
966                 bool has_stats = false;
967
968                 dname = blkg_dev_name(blkg);
969                 if (!dname)
970                         continue;
971
972                 /*
973                  * Hooray string manipulation, count is the size written NOT
974                  * INCLUDING THE \0, so size is now count+1 less than what we
975                  * had before, but we want to start writing the next bit from
976                  * the \0 so we only add count to buf.
977                  */
978                 off += scnprintf(buf+off, size-off, "%s ", dname);
979
980                 spin_lock_irq(&blkg->q->queue_lock);
981
982                 rwstat = blkg_rwstat_recursive_sum(blkg, NULL,
983                                         offsetof(struct blkcg_gq, stat_bytes));
984                 rbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_READ]);
985                 wbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_WRITE]);
986                 dbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_DISCARD]);
987
988                 rwstat = blkg_rwstat_recursive_sum(blkg, NULL,
989                                         offsetof(struct blkcg_gq, stat_ios));
990                 rios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_READ]);
991                 wios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_WRITE]);
992                 dios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_DISCARD]);
993
994                 spin_unlock_irq(&blkg->q->queue_lock);
995
996                 if (rbytes || wbytes || rios || wios) {
997                         has_stats = true;
998                         off += scnprintf(buf+off, size-off,
999                                          "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
1000                                          rbytes, wbytes, rios, wios,
1001                                          dbytes, dios);
1002                 }
1003
1004                 if (!blkcg_debug_stats)
1005                         goto next;
1006
1007                 if (atomic_read(&blkg->use_delay)) {
1008                         has_stats = true;
1009                         off += scnprintf(buf+off, size-off,
1010                                          " use_delay=%d delay_nsec=%llu",
1011                                          atomic_read(&blkg->use_delay),
1012                                         (unsigned long long)atomic64_read(&blkg->delay_nsec));
1013                 }
1014
1015                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
1016                         struct blkcg_policy *pol = blkcg_policy[i];
1017                         size_t written;
1018
1019                         if (!blkg->pd[i] || !pol->pd_stat_fn)
1020                                 continue;
1021
1022                         written = pol->pd_stat_fn(blkg->pd[i], buf+off, size-off);
1023                         if (written)
1024                                 has_stats = true;
1025                         off += written;
1026                 }
1027 next:
1028                 if (has_stats) {
1029                         off += scnprintf(buf+off, size-off, "\n");
1030                         seq_commit(sf, off);
1031                 }
1032         }
1033
1034         rcu_read_unlock();
1035         return 0;
1036 }
1037
1038 static struct cftype blkcg_files[] = {
1039         {
1040                 .name = "stat",
1041                 .flags = CFTYPE_NOT_ON_ROOT,
1042                 .seq_show = blkcg_print_stat,
1043         },
1044         { }     /* terminate */
1045 };
1046
1047 static struct cftype blkcg_legacy_files[] = {
1048         {
1049                 .name = "reset_stats",
1050                 .write_u64 = blkcg_reset_stats,
1051         },
1052         { }     /* terminate */
1053 };
1054
1055 /*
1056  * blkcg destruction is a three-stage process.
1057  *
1058  * 1. Destruction starts.  The blkcg_css_offline() callback is invoked
1059  *    which offlines writeback.  Here we tie the next stage of blkg destruction
1060  *    to the completion of writeback associated with the blkcg.  This lets us
1061  *    avoid punting potentially large amounts of outstanding writeback to root
1062  *    while maintaining any ongoing policies.  The next stage is triggered when
1063  *    the nr_cgwbs count goes to zero.
1064  *
1065  * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
1066  *    and handles the destruction of blkgs.  Here the css reference held by
1067  *    the blkg is put back eventually allowing blkcg_css_free() to be called.
1068  *    This work may occur in cgwb_release_workfn() on the cgwb_release
1069  *    workqueue.  Any submitted ios that fail to get the blkg ref will be
1070  *    punted to the root_blkg.
1071  *
1072  * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
1073  *    This finally frees the blkcg.
1074  */
1075
1076 /**
1077  * blkcg_css_offline - cgroup css_offline callback
1078  * @css: css of interest
1079  *
1080  * This function is called when @css is about to go away.  Here the cgwbs are
1081  * offlined first and only once writeback associated with the blkcg has
1082  * finished do we start step 2 (see above).
1083  */
1084 static void blkcg_css_offline(struct cgroup_subsys_state *css)
1085 {
1086         struct blkcg *blkcg = css_to_blkcg(css);
1087
1088         /* this prevents anyone from attaching or migrating to this blkcg */
1089         wb_blkcg_offline(blkcg);
1090
1091         /* put the base cgwb reference allowing step 2 to be triggered */
1092         blkcg_cgwb_put(blkcg);
1093 }
1094
1095 /**
1096  * blkcg_destroy_blkgs - responsible for shooting down blkgs
1097  * @blkcg: blkcg of interest
1098  *
1099  * blkgs should be removed while holding both q and blkcg locks.  As blkcg lock
1100  * is nested inside q lock, this function performs reverse double lock dancing.
1101  * Destroying the blkgs releases the reference held on the blkcg's css allowing
1102  * blkcg_css_free to eventually be called.
1103  *
1104  * This is the blkcg counterpart of ioc_release_fn().
1105  */
1106 void blkcg_destroy_blkgs(struct blkcg *blkcg)
1107 {
1108         spin_lock_irq(&blkcg->lock);
1109
1110         while (!hlist_empty(&blkcg->blkg_list)) {
1111                 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
1112                                                 struct blkcg_gq, blkcg_node);
1113                 struct request_queue *q = blkg->q;
1114
1115                 if (spin_trylock(&q->queue_lock)) {
1116                         blkg_destroy(blkg);
1117                         spin_unlock(&q->queue_lock);
1118                 } else {
1119                         spin_unlock_irq(&blkcg->lock);
1120                         cpu_relax();
1121                         spin_lock_irq(&blkcg->lock);
1122                 }
1123         }
1124
1125         spin_unlock_irq(&blkcg->lock);
1126 }
1127
1128 static void blkcg_css_free(struct cgroup_subsys_state *css)
1129 {
1130         struct blkcg *blkcg = css_to_blkcg(css);
1131         int i;
1132
1133         mutex_lock(&blkcg_pol_mutex);
1134
1135         list_del(&blkcg->all_blkcgs_node);
1136
1137         for (i = 0; i < BLKCG_MAX_POLS; i++)
1138                 if (blkcg->cpd[i])
1139                         blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1140
1141         mutex_unlock(&blkcg_pol_mutex);
1142
1143         kfree(blkcg);
1144 }
1145
1146 static struct cgroup_subsys_state *
1147 blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
1148 {
1149         struct blkcg *blkcg;
1150         struct cgroup_subsys_state *ret;
1151         int i;
1152
1153         mutex_lock(&blkcg_pol_mutex);
1154
1155         if (!parent_css) {
1156                 blkcg = &blkcg_root;
1157         } else {
1158                 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1159                 if (!blkcg) {
1160                         ret = ERR_PTR(-ENOMEM);
1161                         goto unlock;
1162                 }
1163         }
1164
1165         for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1166                 struct blkcg_policy *pol = blkcg_policy[i];
1167                 struct blkcg_policy_data *cpd;
1168
1169                 /*
1170                  * If the policy hasn't been attached yet, wait for it
1171                  * to be attached before doing anything else. Otherwise,
1172                  * check if the policy requires any specific per-cgroup
1173                  * data: if it does, allocate and initialize it.
1174                  */
1175                 if (!pol || !pol->cpd_alloc_fn)
1176                         continue;
1177
1178                 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1179                 if (!cpd) {
1180                         ret = ERR_PTR(-ENOMEM);
1181                         goto free_pd_blkcg;
1182                 }
1183                 blkcg->cpd[i] = cpd;
1184                 cpd->blkcg = blkcg;
1185                 cpd->plid = i;
1186                 if (pol->cpd_init_fn)
1187                         pol->cpd_init_fn(cpd);
1188         }
1189
1190         spin_lock_init(&blkcg->lock);
1191         INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
1192         INIT_HLIST_HEAD(&blkcg->blkg_list);
1193 #ifdef CONFIG_CGROUP_WRITEBACK
1194         INIT_LIST_HEAD(&blkcg->cgwb_list);
1195         refcount_set(&blkcg->cgwb_refcnt, 1);
1196 #endif
1197         list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1198
1199         mutex_unlock(&blkcg_pol_mutex);
1200         return &blkcg->css;
1201
1202 free_pd_blkcg:
1203         for (i--; i >= 0; i--)
1204                 if (blkcg->cpd[i])
1205                         blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1206
1207         if (blkcg != &blkcg_root)
1208                 kfree(blkcg);
1209 unlock:
1210         mutex_unlock(&blkcg_pol_mutex);
1211         return ret;
1212 }
1213
1214 /**
1215  * blkcg_init_queue - initialize blkcg part of request queue
1216  * @q: request_queue to initialize
1217  *
1218  * Called from blk_alloc_queue_node(). Responsible for initializing blkcg
1219  * part of new request_queue @q.
1220  *
1221  * RETURNS:
1222  * 0 on success, -errno on failure.
1223  */
1224 int blkcg_init_queue(struct request_queue *q)
1225 {
1226         struct blkcg_gq *new_blkg, *blkg;
1227         bool preloaded;
1228         int ret;
1229
1230         new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
1231         if (!new_blkg)
1232                 return -ENOMEM;
1233
1234         preloaded = !radix_tree_preload(GFP_KERNEL);
1235
1236         /* Make sure the root blkg exists. */
1237         rcu_read_lock();
1238         spin_lock_irq(&q->queue_lock);
1239         blkg = blkg_create(&blkcg_root, q, new_blkg);
1240         if (IS_ERR(blkg))
1241                 goto err_unlock;
1242         q->root_blkg = blkg;
1243         spin_unlock_irq(&q->queue_lock);
1244         rcu_read_unlock();
1245
1246         if (preloaded)
1247                 radix_tree_preload_end();
1248
1249         ret = blk_iolatency_init(q);
1250         if (ret)
1251                 goto err_destroy_all;
1252
1253         ret = blk_throtl_init(q);
1254         if (ret)
1255                 goto err_destroy_all;
1256         return 0;
1257
1258 err_destroy_all:
1259         blkg_destroy_all(q);
1260         return ret;
1261 err_unlock:
1262         spin_unlock_irq(&q->queue_lock);
1263         rcu_read_unlock();
1264         if (preloaded)
1265                 radix_tree_preload_end();
1266         return PTR_ERR(blkg);
1267 }
1268
1269 /**
1270  * blkcg_drain_queue - drain blkcg part of request_queue
1271  * @q: request_queue to drain
1272  *
1273  * Called from blk_drain_queue().  Responsible for draining blkcg part.
1274  */
1275 void blkcg_drain_queue(struct request_queue *q)
1276 {
1277         lockdep_assert_held(&q->queue_lock);
1278
1279         /*
1280          * @q could be exiting and already have destroyed all blkgs as
1281          * indicated by NULL root_blkg.  If so, don't confuse policies.
1282          */
1283         if (!q->root_blkg)
1284                 return;
1285
1286         blk_throtl_drain(q);
1287 }
1288
1289 /**
1290  * blkcg_exit_queue - exit and release blkcg part of request_queue
1291  * @q: request_queue being released
1292  *
1293  * Called from blk_release_queue().  Responsible for exiting blkcg part.
1294  */
1295 void blkcg_exit_queue(struct request_queue *q)
1296 {
1297         blkg_destroy_all(q);
1298         blk_throtl_exit(q);
1299 }
1300
1301 /*
1302  * We cannot support shared io contexts, as we have no mean to support
1303  * two tasks with the same ioc in two different groups without major rework
1304  * of the main cic data structures.  For now we allow a task to change
1305  * its cgroup only if it's the only owner of its ioc.
1306  */
1307 static int blkcg_can_attach(struct cgroup_taskset *tset)
1308 {
1309         struct task_struct *task;
1310         struct cgroup_subsys_state *dst_css;
1311         struct io_context *ioc;
1312         int ret = 0;
1313
1314         /* task_lock() is needed to avoid races with exit_io_context() */
1315         cgroup_taskset_for_each(task, dst_css, tset) {
1316                 task_lock(task);
1317                 ioc = task->io_context;
1318                 if (ioc && atomic_read(&ioc->nr_tasks) > 1)
1319                         ret = -EINVAL;
1320                 task_unlock(task);
1321                 if (ret)
1322                         break;
1323         }
1324         return ret;
1325 }
1326
1327 static void blkcg_bind(struct cgroup_subsys_state *root_css)
1328 {
1329         int i;
1330
1331         mutex_lock(&blkcg_pol_mutex);
1332
1333         for (i = 0; i < BLKCG_MAX_POLS; i++) {
1334                 struct blkcg_policy *pol = blkcg_policy[i];
1335                 struct blkcg *blkcg;
1336
1337                 if (!pol || !pol->cpd_bind_fn)
1338                         continue;
1339
1340                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
1341                         if (blkcg->cpd[pol->plid])
1342                                 pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
1343         }
1344         mutex_unlock(&blkcg_pol_mutex);
1345 }
1346
1347 static void blkcg_exit(struct task_struct *tsk)
1348 {
1349         if (tsk->throttle_queue)
1350                 blk_put_queue(tsk->throttle_queue);
1351         tsk->throttle_queue = NULL;
1352 }
1353
1354 struct cgroup_subsys io_cgrp_subsys = {
1355         .css_alloc = blkcg_css_alloc,
1356         .css_offline = blkcg_css_offline,
1357         .css_free = blkcg_css_free,
1358         .can_attach = blkcg_can_attach,
1359         .bind = blkcg_bind,
1360         .dfl_cftypes = blkcg_files,
1361         .legacy_cftypes = blkcg_legacy_files,
1362         .legacy_name = "blkio",
1363         .exit = blkcg_exit,
1364 #ifdef CONFIG_MEMCG
1365         /*
1366          * This ensures that, if available, memcg is automatically enabled
1367          * together on the default hierarchy so that the owner cgroup can
1368          * be retrieved from writeback pages.
1369          */
1370         .depends_on = 1 << memory_cgrp_id,
1371 #endif
1372 };
1373 EXPORT_SYMBOL_GPL(io_cgrp_subsys);
1374
1375 /**
1376  * blkcg_activate_policy - activate a blkcg policy on a request_queue
1377  * @q: request_queue of interest
1378  * @pol: blkcg policy to activate
1379  *
1380  * Activate @pol on @q.  Requires %GFP_KERNEL context.  @q goes through
1381  * bypass mode to populate its blkgs with policy_data for @pol.
1382  *
1383  * Activation happens with @q bypassed, so nobody would be accessing blkgs
1384  * from IO path.  Update of each blkg is protected by both queue and blkcg
1385  * locks so that holding either lock and testing blkcg_policy_enabled() is
1386  * always enough for dereferencing policy data.
1387  *
1388  * The caller is responsible for synchronizing [de]activations and policy
1389  * [un]registerations.  Returns 0 on success, -errno on failure.
1390  */
1391 int blkcg_activate_policy(struct request_queue *q,
1392                           const struct blkcg_policy *pol)
1393 {
1394         struct blkg_policy_data *pd_prealloc = NULL;
1395         struct blkcg_gq *blkg;
1396         int ret;
1397
1398         if (blkcg_policy_enabled(q, pol))
1399                 return 0;
1400
1401         if (queue_is_mq(q))
1402                 blk_mq_freeze_queue(q);
1403 pd_prealloc:
1404         if (!pd_prealloc) {
1405                 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q->node);
1406                 if (!pd_prealloc) {
1407                         ret = -ENOMEM;
1408                         goto out_bypass_end;
1409                 }
1410         }
1411
1412         spin_lock_irq(&q->queue_lock);
1413
1414         list_for_each_entry(blkg, &q->blkg_list, q_node) {
1415                 struct blkg_policy_data *pd;
1416
1417                 if (blkg->pd[pol->plid])
1418                         continue;
1419
1420                 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q->node);
1421                 if (!pd)
1422                         swap(pd, pd_prealloc);
1423                 if (!pd) {
1424                         spin_unlock_irq(&q->queue_lock);
1425                         goto pd_prealloc;
1426                 }
1427
1428                 blkg->pd[pol->plid] = pd;
1429                 pd->blkg = blkg;
1430                 pd->plid = pol->plid;
1431                 if (pol->pd_init_fn)
1432                         pol->pd_init_fn(pd);
1433         }
1434
1435         __set_bit(pol->plid, q->blkcg_pols);
1436         ret = 0;
1437
1438         spin_unlock_irq(&q->queue_lock);
1439 out_bypass_end:
1440         if (queue_is_mq(q))
1441                 blk_mq_unfreeze_queue(q);
1442         if (pd_prealloc)
1443                 pol->pd_free_fn(pd_prealloc);
1444         return ret;
1445 }
1446 EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1447
1448 /**
1449  * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1450  * @q: request_queue of interest
1451  * @pol: blkcg policy to deactivate
1452  *
1453  * Deactivate @pol on @q.  Follows the same synchronization rules as
1454  * blkcg_activate_policy().
1455  */
1456 void blkcg_deactivate_policy(struct request_queue *q,
1457                              const struct blkcg_policy *pol)
1458 {
1459         struct blkcg_gq *blkg;
1460
1461         if (!blkcg_policy_enabled(q, pol))
1462                 return;
1463
1464         if (queue_is_mq(q))
1465                 blk_mq_freeze_queue(q);
1466
1467         spin_lock_irq(&q->queue_lock);
1468
1469         __clear_bit(pol->plid, q->blkcg_pols);
1470
1471         list_for_each_entry(blkg, &q->blkg_list, q_node) {
1472                 if (blkg->pd[pol->plid]) {
1473                         if (pol->pd_offline_fn)
1474                                 pol->pd_offline_fn(blkg->pd[pol->plid]);
1475                         pol->pd_free_fn(blkg->pd[pol->plid]);
1476                         blkg->pd[pol->plid] = NULL;
1477                 }
1478         }
1479
1480         spin_unlock_irq(&q->queue_lock);
1481
1482         if (queue_is_mq(q))
1483                 blk_mq_unfreeze_queue(q);
1484 }
1485 EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1486
1487 /**
1488  * blkcg_policy_register - register a blkcg policy
1489  * @pol: blkcg policy to register
1490  *
1491  * Register @pol with blkcg core.  Might sleep and @pol may be modified on
1492  * successful registration.  Returns 0 on success and -errno on failure.
1493  */
1494 int blkcg_policy_register(struct blkcg_policy *pol)
1495 {
1496         struct blkcg *blkcg;
1497         int i, ret;
1498
1499         mutex_lock(&blkcg_pol_register_mutex);
1500         mutex_lock(&blkcg_pol_mutex);
1501
1502         /* find an empty slot */
1503         ret = -ENOSPC;
1504         for (i = 0; i < BLKCG_MAX_POLS; i++)
1505                 if (!blkcg_policy[i])
1506                         break;
1507         if (i >= BLKCG_MAX_POLS) {
1508                 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
1509                 goto err_unlock;
1510         }
1511
1512         /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1513         if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1514                 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1515                 goto err_unlock;
1516
1517         /* register @pol */
1518         pol->plid = i;
1519         blkcg_policy[pol->plid] = pol;
1520
1521         /* allocate and install cpd's */
1522         if (pol->cpd_alloc_fn) {
1523                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1524                         struct blkcg_policy_data *cpd;
1525
1526                         cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1527                         if (!cpd)
1528                                 goto err_free_cpds;
1529
1530                         blkcg->cpd[pol->plid] = cpd;
1531                         cpd->blkcg = blkcg;
1532                         cpd->plid = pol->plid;
1533                         pol->cpd_init_fn(cpd);
1534                 }
1535         }
1536
1537         mutex_unlock(&blkcg_pol_mutex);
1538
1539         /* everything is in place, add intf files for the new policy */
1540         if (pol->dfl_cftypes)
1541                 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1542                                                pol->dfl_cftypes));
1543         if (pol->legacy_cftypes)
1544                 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
1545                                                   pol->legacy_cftypes));
1546         mutex_unlock(&blkcg_pol_register_mutex);
1547         return 0;
1548
1549 err_free_cpds:
1550         if (pol->cpd_free_fn) {
1551                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1552                         if (blkcg->cpd[pol->plid]) {
1553                                 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1554                                 blkcg->cpd[pol->plid] = NULL;
1555                         }
1556                 }
1557         }
1558         blkcg_policy[pol->plid] = NULL;
1559 err_unlock:
1560         mutex_unlock(&blkcg_pol_mutex);
1561         mutex_unlock(&blkcg_pol_register_mutex);
1562         return ret;
1563 }
1564 EXPORT_SYMBOL_GPL(blkcg_policy_register);
1565
1566 /**
1567  * blkcg_policy_unregister - unregister a blkcg policy
1568  * @pol: blkcg policy to unregister
1569  *
1570  * Undo blkcg_policy_register(@pol).  Might sleep.
1571  */
1572 void blkcg_policy_unregister(struct blkcg_policy *pol)
1573 {
1574         struct blkcg *blkcg;
1575
1576         mutex_lock(&blkcg_pol_register_mutex);
1577
1578         if (WARN_ON(blkcg_policy[pol->plid] != pol))
1579                 goto out_unlock;
1580
1581         /* kill the intf files first */
1582         if (pol->dfl_cftypes)
1583                 cgroup_rm_cftypes(pol->dfl_cftypes);
1584         if (pol->legacy_cftypes)
1585                 cgroup_rm_cftypes(pol->legacy_cftypes);
1586
1587         /* remove cpds and unregister */
1588         mutex_lock(&blkcg_pol_mutex);
1589
1590         if (pol->cpd_free_fn) {
1591                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1592                         if (blkcg->cpd[pol->plid]) {
1593                                 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1594                                 blkcg->cpd[pol->plid] = NULL;
1595                         }
1596                 }
1597         }
1598         blkcg_policy[pol->plid] = NULL;
1599
1600         mutex_unlock(&blkcg_pol_mutex);
1601 out_unlock:
1602         mutex_unlock(&blkcg_pol_register_mutex);
1603 }
1604 EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
1605
1606 /*
1607  * Scale the accumulated delay based on how long it has been since we updated
1608  * the delay.  We only call this when we are adding delay, in case it's been a
1609  * while since we added delay, and when we are checking to see if we need to
1610  * delay a task, to account for any delays that may have occurred.
1611  */
1612 static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1613 {
1614         u64 old = atomic64_read(&blkg->delay_start);
1615
1616         /*
1617          * We only want to scale down every second.  The idea here is that we
1618          * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1619          * time window.  We only want to throttle tasks for recent delay that
1620          * has occurred, in 1 second time windows since that's the maximum
1621          * things can be throttled.  We save the current delay window in
1622          * blkg->last_delay so we know what amount is still left to be charged
1623          * to the blkg from this point onward.  blkg->last_use keeps track of
1624          * the use_delay counter.  The idea is if we're unthrottling the blkg we
1625          * are ok with whatever is happening now, and we can take away more of
1626          * the accumulated delay as we've already throttled enough that
1627          * everybody is happy with their IO latencies.
1628          */
1629         if (time_before64(old + NSEC_PER_SEC, now) &&
1630             atomic64_cmpxchg(&blkg->delay_start, old, now) == old) {
1631                 u64 cur = atomic64_read(&blkg->delay_nsec);
1632                 u64 sub = min_t(u64, blkg->last_delay, now - old);
1633                 int cur_use = atomic_read(&blkg->use_delay);
1634
1635                 /*
1636                  * We've been unthrottled, subtract a larger chunk of our
1637                  * accumulated delay.
1638                  */
1639                 if (cur_use < blkg->last_use)
1640                         sub = max_t(u64, sub, blkg->last_delay >> 1);
1641
1642                 /*
1643                  * This shouldn't happen, but handle it anyway.  Our delay_nsec
1644                  * should only ever be growing except here where we subtract out
1645                  * min(last_delay, 1 second), but lord knows bugs happen and I'd
1646                  * rather not end up with negative numbers.
1647                  */
1648                 if (unlikely(cur < sub)) {
1649                         atomic64_set(&blkg->delay_nsec, 0);
1650                         blkg->last_delay = 0;
1651                 } else {
1652                         atomic64_sub(sub, &blkg->delay_nsec);
1653                         blkg->last_delay = cur - sub;
1654                 }
1655                 blkg->last_use = cur_use;
1656         }
1657 }
1658
1659 /*
1660  * This is called when we want to actually walk up the hierarchy and check to
1661  * see if we need to throttle, and then actually throttle if there is some
1662  * accumulated delay.  This should only be called upon return to user space so
1663  * we're not holding some lock that would induce a priority inversion.
1664  */
1665 static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1666 {
1667         u64 now = ktime_to_ns(ktime_get());
1668         u64 exp;
1669         u64 delay_nsec = 0;
1670         int tok;
1671
1672         while (blkg->parent) {
1673                 if (atomic_read(&blkg->use_delay)) {
1674                         blkcg_scale_delay(blkg, now);
1675                         delay_nsec = max_t(u64, delay_nsec,
1676                                            atomic64_read(&blkg->delay_nsec));
1677                 }
1678                 blkg = blkg->parent;
1679         }
1680
1681         if (!delay_nsec)
1682                 return;
1683
1684         /*
1685          * Let's not sleep for all eternity if we've amassed a huge delay.
1686          * Swapping or metadata IO can accumulate 10's of seconds worth of
1687          * delay, and we want userspace to be able to do _something_ so cap the
1688          * delays at 1 second.  If there's 10's of seconds worth of delay then
1689          * the tasks will be delayed for 1 second for every syscall.
1690          */
1691         delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
1692
1693         /*
1694          * TODO: the use_memdelay flag is going to be for the upcoming psi stuff
1695          * that hasn't landed upstream yet.  Once that stuff is in place we need
1696          * to do a psi_memstall_enter/leave if memdelay is set.
1697          */
1698
1699         exp = ktime_add_ns(now, delay_nsec);
1700         tok = io_schedule_prepare();
1701         do {
1702                 __set_current_state(TASK_KILLABLE);
1703                 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1704                         break;
1705         } while (!fatal_signal_pending(current));
1706         io_schedule_finish(tok);
1707 }
1708
1709 /**
1710  * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1711  *
1712  * This is only called if we've been marked with set_notify_resume().  Obviously
1713  * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1714  * check to see if current->throttle_queue is set and if not this doesn't do
1715  * anything.  This should only ever be called by the resume code, it's not meant
1716  * to be called by people willy-nilly as it will actually do the work to
1717  * throttle the task if it is setup for throttling.
1718  */
1719 void blkcg_maybe_throttle_current(void)
1720 {
1721         struct request_queue *q = current->throttle_queue;
1722         struct cgroup_subsys_state *css;
1723         struct blkcg *blkcg;
1724         struct blkcg_gq *blkg;
1725         bool use_memdelay = current->use_memdelay;
1726
1727         if (!q)
1728                 return;
1729
1730         current->throttle_queue = NULL;
1731         current->use_memdelay = false;
1732
1733         rcu_read_lock();
1734         css = kthread_blkcg();
1735         if (css)
1736                 blkcg = css_to_blkcg(css);
1737         else
1738                 blkcg = css_to_blkcg(task_css(current, io_cgrp_id));
1739
1740         if (!blkcg)
1741                 goto out;
1742         blkg = blkg_lookup(blkcg, q);
1743         if (!blkg)
1744                 goto out;
1745         if (!blkg_tryget(blkg))
1746                 goto out;
1747         rcu_read_unlock();
1748
1749         blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1750         blkg_put(blkg);
1751         blk_put_queue(q);
1752         return;
1753 out:
1754         rcu_read_unlock();
1755         blk_put_queue(q);
1756 }
1757
1758 /**
1759  * blkcg_schedule_throttle - this task needs to check for throttling
1760  * @q - the request queue IO was submitted on
1761  * @use_memdelay - do we charge this to memory delay for PSI
1762  *
1763  * This is called by the IO controller when we know there's delay accumulated
1764  * for the blkg for this task.  We do not pass the blkg because there are places
1765  * we call this that may not have that information, the swapping code for
1766  * instance will only have a request_queue at that point.  This set's the
1767  * notify_resume for the task to check and see if it requires throttling before
1768  * returning to user space.
1769  *
1770  * We will only schedule once per syscall.  You can call this over and over
1771  * again and it will only do the check once upon return to user space, and only
1772  * throttle once.  If the task needs to be throttled again it'll need to be
1773  * re-set at the next time we see the task.
1774  */
1775 void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay)
1776 {
1777         if (unlikely(current->flags & PF_KTHREAD))
1778                 return;
1779
1780         if (!blk_get_queue(q))
1781                 return;
1782
1783         if (current->throttle_queue)
1784                 blk_put_queue(current->throttle_queue);
1785         current->throttle_queue = q;
1786         if (use_memdelay)
1787                 current->use_memdelay = use_memdelay;
1788         set_notify_resume(current);
1789 }
1790
1791 /**
1792  * blkcg_add_delay - add delay to this blkg
1793  * @now - the current time in nanoseconds
1794  * @delta - how many nanoseconds of delay to add
1795  *
1796  * Charge @delta to the blkg's current delay accumulation.  This is used to
1797  * throttle tasks if an IO controller thinks we need more throttling.
1798  */
1799 void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1800 {
1801         blkcg_scale_delay(blkg, now);
1802         atomic64_add(delta, &blkg->delay_nsec);
1803 }
1804
1805 module_param(blkcg_debug_stats, bool, 0644);
1806 MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");