blkio-throttle: There is no need to convert jiffies to milli seconds
[linux-3.10.git] / block / blk-throttle.c
1 /*
2  * Interface for controlling IO bandwidth on a request queue
3  *
4  * Copyright (C) 2010 Vivek Goyal <vgoyal@redhat.com>
5  */
6
7 #include <linux/module.h>
8 #include <linux/slab.h>
9 #include <linux/blkdev.h>
10 #include <linux/bio.h>
11 #include <linux/blktrace_api.h>
12 #include "blk-cgroup.h"
13
14 /* Max dispatch from a group in 1 round */
15 static int throtl_grp_quantum = 8;
16
17 /* Total max dispatch from all groups in one round */
18 static int throtl_quantum = 32;
19
20 /* Throttling is performed over 100ms slice and after that slice is renewed */
21 static unsigned long throtl_slice = HZ/10;      /* 100 ms */
22
23 struct throtl_rb_root {
24         struct rb_root rb;
25         struct rb_node *left;
26         unsigned int count;
27         unsigned long min_disptime;
28 };
29
30 #define THROTL_RB_ROOT  (struct throtl_rb_root) { .rb = RB_ROOT, .left = NULL, \
31                         .count = 0, .min_disptime = 0}
32
33 #define rb_entry_tg(node)       rb_entry((node), struct throtl_grp, rb_node)
34
35 struct throtl_grp {
36         /* List of throtl groups on the request queue*/
37         struct hlist_node tg_node;
38
39         /* active throtl group service_tree member */
40         struct rb_node rb_node;
41
42         /*
43          * Dispatch time in jiffies. This is the estimated time when group
44          * will unthrottle and is ready to dispatch more bio. It is used as
45          * key to sort active groups in service tree.
46          */
47         unsigned long disptime;
48
49         struct blkio_group blkg;
50         atomic_t ref;
51         unsigned int flags;
52
53         /* Two lists for READ and WRITE */
54         struct bio_list bio_lists[2];
55
56         /* Number of queued bios on READ and WRITE lists */
57         unsigned int nr_queued[2];
58
59         /* bytes per second rate limits */
60         uint64_t bps[2];
61
62         /* IOPS limits */
63         unsigned int iops[2];
64
65         /* Number of bytes disptached in current slice */
66         uint64_t bytes_disp[2];
67         /* Number of bio's dispatched in current slice */
68         unsigned int io_disp[2];
69
70         /* When did we start a new slice */
71         unsigned long slice_start[2];
72         unsigned long slice_end[2];
73
74         /* Some throttle limits got updated for the group */
75         bool limits_changed;
76 };
77
78 struct throtl_data
79 {
80         /* List of throtl groups */
81         struct hlist_head tg_list;
82
83         /* service tree for active throtl groups */
84         struct throtl_rb_root tg_service_tree;
85
86         struct throtl_grp root_tg;
87         struct request_queue *queue;
88
89         /* Total Number of queued bios on READ and WRITE lists */
90         unsigned int nr_queued[2];
91
92         /*
93          * number of total undestroyed groups
94          */
95         unsigned int nr_undestroyed_grps;
96
97         /* Work for dispatching throttled bios */
98         struct delayed_work throtl_work;
99
100         atomic_t limits_changed;
101 };
102
103 enum tg_state_flags {
104         THROTL_TG_FLAG_on_rr = 0,       /* on round-robin busy list */
105 };
106
107 #define THROTL_TG_FNS(name)                                             \
108 static inline void throtl_mark_tg_##name(struct throtl_grp *tg)         \
109 {                                                                       \
110         (tg)->flags |= (1 << THROTL_TG_FLAG_##name);                    \
111 }                                                                       \
112 static inline void throtl_clear_tg_##name(struct throtl_grp *tg)        \
113 {                                                                       \
114         (tg)->flags &= ~(1 << THROTL_TG_FLAG_##name);                   \
115 }                                                                       \
116 static inline int throtl_tg_##name(const struct throtl_grp *tg)         \
117 {                                                                       \
118         return ((tg)->flags & (1 << THROTL_TG_FLAG_##name)) != 0;       \
119 }
120
121 THROTL_TG_FNS(on_rr);
122
123 #define throtl_log_tg(td, tg, fmt, args...)                             \
124         blk_add_trace_msg((td)->queue, "throtl %s " fmt,                \
125                                 blkg_path(&(tg)->blkg), ##args);        \
126
127 #define throtl_log(td, fmt, args...)    \
128         blk_add_trace_msg((td)->queue, "throtl " fmt, ##args)
129
130 static inline struct throtl_grp *tg_of_blkg(struct blkio_group *blkg)
131 {
132         if (blkg)
133                 return container_of(blkg, struct throtl_grp, blkg);
134
135         return NULL;
136 }
137
138 static inline int total_nr_queued(struct throtl_data *td)
139 {
140         return (td->nr_queued[0] + td->nr_queued[1]);
141 }
142
143 static inline struct throtl_grp *throtl_ref_get_tg(struct throtl_grp *tg)
144 {
145         atomic_inc(&tg->ref);
146         return tg;
147 }
148
149 static void throtl_put_tg(struct throtl_grp *tg)
150 {
151         BUG_ON(atomic_read(&tg->ref) <= 0);
152         if (!atomic_dec_and_test(&tg->ref))
153                 return;
154         kfree(tg);
155 }
156
157 static struct throtl_grp * throtl_find_alloc_tg(struct throtl_data *td,
158                         struct cgroup *cgroup)
159 {
160         struct blkio_cgroup *blkcg = cgroup_to_blkio_cgroup(cgroup);
161         struct throtl_grp *tg = NULL;
162         void *key = td;
163         struct backing_dev_info *bdi = &td->queue->backing_dev_info;
164         unsigned int major, minor;
165
166         /*
167          * TODO: Speed up blkiocg_lookup_group() by maintaining a radix
168          * tree of blkg (instead of traversing through hash list all
169          * the time.
170          */
171         tg = tg_of_blkg(blkiocg_lookup_group(blkcg, key));
172
173         /* Fill in device details for root group */
174         if (tg && !tg->blkg.dev && bdi->dev && dev_name(bdi->dev)) {
175                 sscanf(dev_name(bdi->dev), "%u:%u", &major, &minor);
176                 tg->blkg.dev = MKDEV(major, minor);
177                 goto done;
178         }
179
180         if (tg)
181                 goto done;
182
183         tg = kzalloc_node(sizeof(*tg), GFP_ATOMIC, td->queue->node);
184         if (!tg)
185                 goto done;
186
187         INIT_HLIST_NODE(&tg->tg_node);
188         RB_CLEAR_NODE(&tg->rb_node);
189         bio_list_init(&tg->bio_lists[0]);
190         bio_list_init(&tg->bio_lists[1]);
191
192         /*
193          * Take the initial reference that will be released on destroy
194          * This can be thought of a joint reference by cgroup and
195          * request queue which will be dropped by either request queue
196          * exit or cgroup deletion path depending on who is exiting first.
197          */
198         atomic_set(&tg->ref, 1);
199
200         /* Add group onto cgroup list */
201         sscanf(dev_name(bdi->dev), "%u:%u", &major, &minor);
202         blkiocg_add_blkio_group(blkcg, &tg->blkg, (void *)td,
203                                 MKDEV(major, minor), BLKIO_POLICY_THROTL);
204
205         tg->bps[READ] = blkcg_get_read_bps(blkcg, tg->blkg.dev);
206         tg->bps[WRITE] = blkcg_get_write_bps(blkcg, tg->blkg.dev);
207         tg->iops[READ] = blkcg_get_read_iops(blkcg, tg->blkg.dev);
208         tg->iops[WRITE] = blkcg_get_write_iops(blkcg, tg->blkg.dev);
209
210         hlist_add_head(&tg->tg_node, &td->tg_list);
211         td->nr_undestroyed_grps++;
212 done:
213         return tg;
214 }
215
216 static struct throtl_grp * throtl_get_tg(struct throtl_data *td)
217 {
218         struct cgroup *cgroup;
219         struct throtl_grp *tg = NULL;
220
221         rcu_read_lock();
222         cgroup = task_cgroup(current, blkio_subsys_id);
223         tg = throtl_find_alloc_tg(td, cgroup);
224         if (!tg)
225                 tg = &td->root_tg;
226         rcu_read_unlock();
227         return tg;
228 }
229
230 static struct throtl_grp *throtl_rb_first(struct throtl_rb_root *root)
231 {
232         /* Service tree is empty */
233         if (!root->count)
234                 return NULL;
235
236         if (!root->left)
237                 root->left = rb_first(&root->rb);
238
239         if (root->left)
240                 return rb_entry_tg(root->left);
241
242         return NULL;
243 }
244
245 static void rb_erase_init(struct rb_node *n, struct rb_root *root)
246 {
247         rb_erase(n, root);
248         RB_CLEAR_NODE(n);
249 }
250
251 static void throtl_rb_erase(struct rb_node *n, struct throtl_rb_root *root)
252 {
253         if (root->left == n)
254                 root->left = NULL;
255         rb_erase_init(n, &root->rb);
256         --root->count;
257 }
258
259 static void update_min_dispatch_time(struct throtl_rb_root *st)
260 {
261         struct throtl_grp *tg;
262
263         tg = throtl_rb_first(st);
264         if (!tg)
265                 return;
266
267         st->min_disptime = tg->disptime;
268 }
269
270 static void
271 tg_service_tree_add(struct throtl_rb_root *st, struct throtl_grp *tg)
272 {
273         struct rb_node **node = &st->rb.rb_node;
274         struct rb_node *parent = NULL;
275         struct throtl_grp *__tg;
276         unsigned long key = tg->disptime;
277         int left = 1;
278
279         while (*node != NULL) {
280                 parent = *node;
281                 __tg = rb_entry_tg(parent);
282
283                 if (time_before(key, __tg->disptime))
284                         node = &parent->rb_left;
285                 else {
286                         node = &parent->rb_right;
287                         left = 0;
288                 }
289         }
290
291         if (left)
292                 st->left = &tg->rb_node;
293
294         rb_link_node(&tg->rb_node, parent, node);
295         rb_insert_color(&tg->rb_node, &st->rb);
296 }
297
298 static void __throtl_enqueue_tg(struct throtl_data *td, struct throtl_grp *tg)
299 {
300         struct throtl_rb_root *st = &td->tg_service_tree;
301
302         tg_service_tree_add(st, tg);
303         throtl_mark_tg_on_rr(tg);
304         st->count++;
305 }
306
307 static void throtl_enqueue_tg(struct throtl_data *td, struct throtl_grp *tg)
308 {
309         if (!throtl_tg_on_rr(tg))
310                 __throtl_enqueue_tg(td, tg);
311 }
312
313 static void __throtl_dequeue_tg(struct throtl_data *td, struct throtl_grp *tg)
314 {
315         throtl_rb_erase(&tg->rb_node, &td->tg_service_tree);
316         throtl_clear_tg_on_rr(tg);
317 }
318
319 static void throtl_dequeue_tg(struct throtl_data *td, struct throtl_grp *tg)
320 {
321         if (throtl_tg_on_rr(tg))
322                 __throtl_dequeue_tg(td, tg);
323 }
324
325 static void throtl_schedule_next_dispatch(struct throtl_data *td)
326 {
327         struct throtl_rb_root *st = &td->tg_service_tree;
328
329         /*
330          * If there are more bios pending, schedule more work.
331          */
332         if (!total_nr_queued(td))
333                 return;
334
335         BUG_ON(!st->count);
336
337         update_min_dispatch_time(st);
338
339         if (time_before_eq(st->min_disptime, jiffies))
340                 throtl_schedule_delayed_work(td->queue, 0);
341         else
342                 throtl_schedule_delayed_work(td->queue,
343                                 (st->min_disptime - jiffies));
344 }
345
346 static inline void
347 throtl_start_new_slice(struct throtl_data *td, struct throtl_grp *tg, bool rw)
348 {
349         tg->bytes_disp[rw] = 0;
350         tg->io_disp[rw] = 0;
351         tg->slice_start[rw] = jiffies;
352         tg->slice_end[rw] = jiffies + throtl_slice;
353         throtl_log_tg(td, tg, "[%c] new slice start=%lu end=%lu jiffies=%lu",
354                         rw == READ ? 'R' : 'W', tg->slice_start[rw],
355                         tg->slice_end[rw], jiffies);
356 }
357
358 static inline void throtl_extend_slice(struct throtl_data *td,
359                 struct throtl_grp *tg, bool rw, unsigned long jiffy_end)
360 {
361         tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
362         throtl_log_tg(td, tg, "[%c] extend slice start=%lu end=%lu jiffies=%lu",
363                         rw == READ ? 'R' : 'W', tg->slice_start[rw],
364                         tg->slice_end[rw], jiffies);
365 }
366
367 /* Determine if previously allocated or extended slice is complete or not */
368 static bool
369 throtl_slice_used(struct throtl_data *td, struct throtl_grp *tg, bool rw)
370 {
371         if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
372                 return 0;
373
374         return 1;
375 }
376
377 /* Trim the used slices and adjust slice start accordingly */
378 static inline void
379 throtl_trim_slice(struct throtl_data *td, struct throtl_grp *tg, bool rw)
380 {
381         unsigned long nr_slices, time_elapsed, io_trim;
382         u64 bytes_trim, tmp;
383
384         BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
385
386         /*
387          * If bps are unlimited (-1), then time slice don't get
388          * renewed. Don't try to trim the slice if slice is used. A new
389          * slice will start when appropriate.
390          */
391         if (throtl_slice_used(td, tg, rw))
392                 return;
393
394         time_elapsed = jiffies - tg->slice_start[rw];
395
396         nr_slices = time_elapsed / throtl_slice;
397
398         if (!nr_slices)
399                 return;
400         tmp = tg->bps[rw] * throtl_slice * nr_slices;
401         do_div(tmp, HZ);
402         bytes_trim = tmp;
403
404         io_trim = (tg->iops[rw] * throtl_slice * nr_slices)/HZ;
405
406         if (!bytes_trim && !io_trim)
407                 return;
408
409         if (tg->bytes_disp[rw] >= bytes_trim)
410                 tg->bytes_disp[rw] -= bytes_trim;
411         else
412                 tg->bytes_disp[rw] = 0;
413
414         if (tg->io_disp[rw] >= io_trim)
415                 tg->io_disp[rw] -= io_trim;
416         else
417                 tg->io_disp[rw] = 0;
418
419         tg->slice_start[rw] += nr_slices * throtl_slice;
420
421         throtl_log_tg(td, tg, "[%c] trim slice nr=%lu bytes=%llu io=%lu"
422                         " start=%lu end=%lu jiffies=%lu",
423                         rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
424                         tg->slice_start[rw], tg->slice_end[rw], jiffies);
425 }
426
427 static bool tg_with_in_iops_limit(struct throtl_data *td, struct throtl_grp *tg,
428                 struct bio *bio, unsigned long *wait)
429 {
430         bool rw = bio_data_dir(bio);
431         unsigned int io_allowed;
432         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
433
434         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
435
436         /* Slice has just started. Consider one slice interval */
437         if (!jiffy_elapsed)
438                 jiffy_elapsed_rnd = throtl_slice;
439
440         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
441
442         io_allowed = (tg->iops[rw] * jiffy_elapsed_rnd) / HZ;
443
444         if (tg->io_disp[rw] + 1 <= io_allowed) {
445                 if (wait)
446                         *wait = 0;
447                 return 1;
448         }
449
450         /* Calc approx time to dispatch */
451         jiffy_wait = ((tg->io_disp[rw] + 1) * HZ)/tg->iops[rw] + 1;
452
453         if (jiffy_wait > jiffy_elapsed)
454                 jiffy_wait = jiffy_wait - jiffy_elapsed;
455         else
456                 jiffy_wait = 1;
457
458         if (wait)
459                 *wait = jiffy_wait;
460         return 0;
461 }
462
463 static bool tg_with_in_bps_limit(struct throtl_data *td, struct throtl_grp *tg,
464                 struct bio *bio, unsigned long *wait)
465 {
466         bool rw = bio_data_dir(bio);
467         u64 bytes_allowed, extra_bytes, tmp;
468         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
469
470         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
471
472         /* Slice has just started. Consider one slice interval */
473         if (!jiffy_elapsed)
474                 jiffy_elapsed_rnd = throtl_slice;
475
476         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
477
478         tmp = tg->bps[rw] * jiffy_elapsed_rnd;
479         do_div(tmp, HZ);
480         bytes_allowed = tmp;
481
482         if (tg->bytes_disp[rw] + bio->bi_size <= bytes_allowed) {
483                 if (wait)
484                         *wait = 0;
485                 return 1;
486         }
487
488         /* Calc approx time to dispatch */
489         extra_bytes = tg->bytes_disp[rw] + bio->bi_size - bytes_allowed;
490         jiffy_wait = div64_u64(extra_bytes * HZ, tg->bps[rw]);
491
492         if (!jiffy_wait)
493                 jiffy_wait = 1;
494
495         /*
496          * This wait time is without taking into consideration the rounding
497          * up we did. Add that time also.
498          */
499         jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
500         if (wait)
501                 *wait = jiffy_wait;
502         return 0;
503 }
504
505 /*
506  * Returns whether one can dispatch a bio or not. Also returns approx number
507  * of jiffies to wait before this bio is with-in IO rate and can be dispatched
508  */
509 static bool tg_may_dispatch(struct throtl_data *td, struct throtl_grp *tg,
510                                 struct bio *bio, unsigned long *wait)
511 {
512         bool rw = bio_data_dir(bio);
513         unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
514
515         /*
516          * Currently whole state machine of group depends on first bio
517          * queued in the group bio list. So one should not be calling
518          * this function with a different bio if there are other bios
519          * queued.
520          */
521         BUG_ON(tg->nr_queued[rw] && bio != bio_list_peek(&tg->bio_lists[rw]));
522
523         /* If tg->bps = -1, then BW is unlimited */
524         if (tg->bps[rw] == -1 && tg->iops[rw] == -1) {
525                 if (wait)
526                         *wait = 0;
527                 return 1;
528         }
529
530         /*
531          * If previous slice expired, start a new one otherwise renew/extend
532          * existing slice to make sure it is at least throtl_slice interval
533          * long since now.
534          */
535         if (throtl_slice_used(td, tg, rw))
536                 throtl_start_new_slice(td, tg, rw);
537         else {
538                 if (time_before(tg->slice_end[rw], jiffies + throtl_slice))
539                         throtl_extend_slice(td, tg, rw, jiffies + throtl_slice);
540         }
541
542         if (tg_with_in_bps_limit(td, tg, bio, &bps_wait)
543             && tg_with_in_iops_limit(td, tg, bio, &iops_wait)) {
544                 if (wait)
545                         *wait = 0;
546                 return 1;
547         }
548
549         max_wait = max(bps_wait, iops_wait);
550
551         if (wait)
552                 *wait = max_wait;
553
554         if (time_before(tg->slice_end[rw], jiffies + max_wait))
555                 throtl_extend_slice(td, tg, rw, jiffies + max_wait);
556
557         return 0;
558 }
559
560 static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
561 {
562         bool rw = bio_data_dir(bio);
563         bool sync = bio->bi_rw & REQ_SYNC;
564
565         /* Charge the bio to the group */
566         tg->bytes_disp[rw] += bio->bi_size;
567         tg->io_disp[rw]++;
568
569         /*
570          * TODO: This will take blkg->stats_lock. Figure out a way
571          * to avoid this cost.
572          */
573         blkiocg_update_dispatch_stats(&tg->blkg, bio->bi_size, rw, sync);
574 }
575
576 static void throtl_add_bio_tg(struct throtl_data *td, struct throtl_grp *tg,
577                         struct bio *bio)
578 {
579         bool rw = bio_data_dir(bio);
580
581         bio_list_add(&tg->bio_lists[rw], bio);
582         /* Take a bio reference on tg */
583         throtl_ref_get_tg(tg);
584         tg->nr_queued[rw]++;
585         td->nr_queued[rw]++;
586         throtl_enqueue_tg(td, tg);
587 }
588
589 static void tg_update_disptime(struct throtl_data *td, struct throtl_grp *tg)
590 {
591         unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
592         struct bio *bio;
593
594         if ((bio = bio_list_peek(&tg->bio_lists[READ])))
595                 tg_may_dispatch(td, tg, bio, &read_wait);
596
597         if ((bio = bio_list_peek(&tg->bio_lists[WRITE])))
598                 tg_may_dispatch(td, tg, bio, &write_wait);
599
600         min_wait = min(read_wait, write_wait);
601         disptime = jiffies + min_wait;
602
603         /* Update dispatch time */
604         throtl_dequeue_tg(td, tg);
605         tg->disptime = disptime;
606         throtl_enqueue_tg(td, tg);
607 }
608
609 static void tg_dispatch_one_bio(struct throtl_data *td, struct throtl_grp *tg,
610                                 bool rw, struct bio_list *bl)
611 {
612         struct bio *bio;
613
614         bio = bio_list_pop(&tg->bio_lists[rw]);
615         tg->nr_queued[rw]--;
616         /* Drop bio reference on tg */
617         throtl_put_tg(tg);
618
619         BUG_ON(td->nr_queued[rw] <= 0);
620         td->nr_queued[rw]--;
621
622         throtl_charge_bio(tg, bio);
623         bio_list_add(bl, bio);
624         bio->bi_rw |= REQ_THROTTLED;
625
626         throtl_trim_slice(td, tg, rw);
627 }
628
629 static int throtl_dispatch_tg(struct throtl_data *td, struct throtl_grp *tg,
630                                 struct bio_list *bl)
631 {
632         unsigned int nr_reads = 0, nr_writes = 0;
633         unsigned int max_nr_reads = throtl_grp_quantum*3/4;
634         unsigned int max_nr_writes = throtl_grp_quantum - nr_reads;
635         struct bio *bio;
636
637         /* Try to dispatch 75% READS and 25% WRITES */
638
639         while ((bio = bio_list_peek(&tg->bio_lists[READ]))
640                 && tg_may_dispatch(td, tg, bio, NULL)) {
641
642                 tg_dispatch_one_bio(td, tg, bio_data_dir(bio), bl);
643                 nr_reads++;
644
645                 if (nr_reads >= max_nr_reads)
646                         break;
647         }
648
649         while ((bio = bio_list_peek(&tg->bio_lists[WRITE]))
650                 && tg_may_dispatch(td, tg, bio, NULL)) {
651
652                 tg_dispatch_one_bio(td, tg, bio_data_dir(bio), bl);
653                 nr_writes++;
654
655                 if (nr_writes >= max_nr_writes)
656                         break;
657         }
658
659         return nr_reads + nr_writes;
660 }
661
662 static int throtl_select_dispatch(struct throtl_data *td, struct bio_list *bl)
663 {
664         unsigned int nr_disp = 0;
665         struct throtl_grp *tg;
666         struct throtl_rb_root *st = &td->tg_service_tree;
667
668         while (1) {
669                 tg = throtl_rb_first(st);
670
671                 if (!tg)
672                         break;
673
674                 if (time_before(jiffies, tg->disptime))
675                         break;
676
677                 throtl_dequeue_tg(td, tg);
678
679                 nr_disp += throtl_dispatch_tg(td, tg, bl);
680
681                 if (tg->nr_queued[0] || tg->nr_queued[1]) {
682                         tg_update_disptime(td, tg);
683                         throtl_enqueue_tg(td, tg);
684                 }
685
686                 if (nr_disp >= throtl_quantum)
687                         break;
688         }
689
690         return nr_disp;
691 }
692
693 static void throtl_process_limit_change(struct throtl_data *td)
694 {
695         struct throtl_grp *tg;
696         struct hlist_node *pos, *n;
697
698         /*
699          * Make sure atomic_inc() effects from
700          * throtl_update_blkio_group_read_bps(), group of functions are
701          * visible.
702          * Is this required or smp_mb__after_atomic_inc() was suffcient
703          * after the atomic_inc().
704          */
705         smp_rmb();
706         if (!atomic_read(&td->limits_changed))
707                 return;
708
709         throtl_log(td, "limit changed =%d", atomic_read(&td->limits_changed));
710
711         hlist_for_each_entry_safe(tg, pos, n, &td->tg_list, tg_node) {
712                 /*
713                  * Do I need an smp_rmb() here to make sure tg->limits_changed
714                  * update is visible. I am relying on smp_rmb() at the
715                  * beginning of function and not putting a new one here.
716                  */
717
718                 if (throtl_tg_on_rr(tg) && tg->limits_changed) {
719                         throtl_log_tg(td, tg, "limit change rbps=%llu wbps=%llu"
720                                 " riops=%u wiops=%u", tg->bps[READ],
721                                 tg->bps[WRITE], tg->iops[READ],
722                                 tg->iops[WRITE]);
723                         tg_update_disptime(td, tg);
724                         tg->limits_changed = false;
725                 }
726         }
727
728         smp_mb__before_atomic_dec();
729         atomic_dec(&td->limits_changed);
730         smp_mb__after_atomic_dec();
731 }
732
733 /* Dispatch throttled bios. Should be called without queue lock held. */
734 static int throtl_dispatch(struct request_queue *q)
735 {
736         struct throtl_data *td = q->td;
737         unsigned int nr_disp = 0;
738         struct bio_list bio_list_on_stack;
739         struct bio *bio;
740
741         spin_lock_irq(q->queue_lock);
742
743         throtl_process_limit_change(td);
744
745         if (!total_nr_queued(td))
746                 goto out;
747
748         bio_list_init(&bio_list_on_stack);
749
750         throtl_log(td, "dispatch nr_queued=%lu read=%u write=%u",
751                         total_nr_queued(td), td->nr_queued[READ],
752                         td->nr_queued[WRITE]);
753
754         nr_disp = throtl_select_dispatch(td, &bio_list_on_stack);
755
756         if (nr_disp)
757                 throtl_log(td, "bios disp=%u", nr_disp);
758
759         throtl_schedule_next_dispatch(td);
760 out:
761         spin_unlock_irq(q->queue_lock);
762
763         /*
764          * If we dispatched some requests, unplug the queue to make sure
765          * immediate dispatch
766          */
767         if (nr_disp) {
768                 while((bio = bio_list_pop(&bio_list_on_stack)))
769                         generic_make_request(bio);
770                 blk_unplug(q);
771         }
772         return nr_disp;
773 }
774
775 void blk_throtl_work(struct work_struct *work)
776 {
777         struct throtl_data *td = container_of(work, struct throtl_data,
778                                         throtl_work.work);
779         struct request_queue *q = td->queue;
780
781         throtl_dispatch(q);
782 }
783
784 /* Call with queue lock held */
785 void throtl_schedule_delayed_work(struct request_queue *q, unsigned long delay)
786 {
787
788         struct throtl_data *td = q->td;
789         struct delayed_work *dwork = &td->throtl_work;
790
791         if (total_nr_queued(td) > 0) {
792                 /*
793                  * We might have a work scheduled to be executed in future.
794                  * Cancel that and schedule a new one.
795                  */
796                 __cancel_delayed_work(dwork);
797                 kblockd_schedule_delayed_work(q, dwork, delay);
798                 throtl_log(td, "schedule work. delay=%lu jiffies=%lu",
799                                 delay, jiffies);
800         }
801 }
802 EXPORT_SYMBOL(throtl_schedule_delayed_work);
803
804 static void
805 throtl_destroy_tg(struct throtl_data *td, struct throtl_grp *tg)
806 {
807         /* Something wrong if we are trying to remove same group twice */
808         BUG_ON(hlist_unhashed(&tg->tg_node));
809
810         hlist_del_init(&tg->tg_node);
811
812         /*
813          * Put the reference taken at the time of creation so that when all
814          * queues are gone, group can be destroyed.
815          */
816         throtl_put_tg(tg);
817         td->nr_undestroyed_grps--;
818 }
819
820 static void throtl_release_tgs(struct throtl_data *td)
821 {
822         struct hlist_node *pos, *n;
823         struct throtl_grp *tg;
824
825         hlist_for_each_entry_safe(tg, pos, n, &td->tg_list, tg_node) {
826                 /*
827                  * If cgroup removal path got to blk_group first and removed
828                  * it from cgroup list, then it will take care of destroying
829                  * cfqg also.
830                  */
831                 if (!blkiocg_del_blkio_group(&tg->blkg))
832                         throtl_destroy_tg(td, tg);
833         }
834 }
835
836 static void throtl_td_free(struct throtl_data *td)
837 {
838         kfree(td);
839 }
840
841 /*
842  * Blk cgroup controller notification saying that blkio_group object is being
843  * delinked as associated cgroup object is going away. That also means that
844  * no new IO will come in this group. So get rid of this group as soon as
845  * any pending IO in the group is finished.
846  *
847  * This function is called under rcu_read_lock(). key is the rcu protected
848  * pointer. That means "key" is a valid throtl_data pointer as long as we are
849  * rcu read lock.
850  *
851  * "key" was fetched from blkio_group under blkio_cgroup->lock. That means
852  * it should not be NULL as even if queue was going away, cgroup deltion
853  * path got to it first.
854  */
855 void throtl_unlink_blkio_group(void *key, struct blkio_group *blkg)
856 {
857         unsigned long flags;
858         struct throtl_data *td = key;
859
860         spin_lock_irqsave(td->queue->queue_lock, flags);
861         throtl_destroy_tg(td, tg_of_blkg(blkg));
862         spin_unlock_irqrestore(td->queue->queue_lock, flags);
863 }
864
865 /*
866  * For all update functions, key should be a valid pointer because these
867  * update functions are called under blkcg_lock, that means, blkg is
868  * valid and in turn key is valid. queue exit path can not race becuase
869  * of blkcg_lock
870  *
871  * Can not take queue lock in update functions as queue lock under blkcg_lock
872  * is not allowed. Under other paths we take blkcg_lock under queue_lock.
873  */
874 static void throtl_update_blkio_group_read_bps(void *key,
875                                 struct blkio_group *blkg, u64 read_bps)
876 {
877         struct throtl_data *td = key;
878
879         tg_of_blkg(blkg)->bps[READ] = read_bps;
880         /* Make sure read_bps is updated before setting limits_changed */
881         smp_wmb();
882         tg_of_blkg(blkg)->limits_changed = true;
883
884         /* Make sure tg->limits_changed is updated before td->limits_changed */
885         smp_mb__before_atomic_inc();
886         atomic_inc(&td->limits_changed);
887         smp_mb__after_atomic_inc();
888
889         /* Schedule a work now to process the limit change */
890         throtl_schedule_delayed_work(td->queue, 0);
891 }
892
893 static void throtl_update_blkio_group_write_bps(void *key,
894                                 struct blkio_group *blkg, u64 write_bps)
895 {
896         struct throtl_data *td = key;
897
898         tg_of_blkg(blkg)->bps[WRITE] = write_bps;
899         smp_wmb();
900         tg_of_blkg(blkg)->limits_changed = true;
901         smp_mb__before_atomic_inc();
902         atomic_inc(&td->limits_changed);
903         smp_mb__after_atomic_inc();
904         throtl_schedule_delayed_work(td->queue, 0);
905 }
906
907 static void throtl_update_blkio_group_read_iops(void *key,
908                         struct blkio_group *blkg, unsigned int read_iops)
909 {
910         struct throtl_data *td = key;
911
912         tg_of_blkg(blkg)->iops[READ] = read_iops;
913         smp_wmb();
914         tg_of_blkg(blkg)->limits_changed = true;
915         smp_mb__before_atomic_inc();
916         atomic_inc(&td->limits_changed);
917         smp_mb__after_atomic_inc();
918         throtl_schedule_delayed_work(td->queue, 0);
919 }
920
921 static void throtl_update_blkio_group_write_iops(void *key,
922                         struct blkio_group *blkg, unsigned int write_iops)
923 {
924         struct throtl_data *td = key;
925
926         tg_of_blkg(blkg)->iops[WRITE] = write_iops;
927         smp_wmb();
928         tg_of_blkg(blkg)->limits_changed = true;
929         smp_mb__before_atomic_inc();
930         atomic_inc(&td->limits_changed);
931         smp_mb__after_atomic_inc();
932         throtl_schedule_delayed_work(td->queue, 0);
933 }
934
935 void throtl_shutdown_timer_wq(struct request_queue *q)
936 {
937         struct throtl_data *td = q->td;
938
939         cancel_delayed_work_sync(&td->throtl_work);
940 }
941
942 static struct blkio_policy_type blkio_policy_throtl = {
943         .ops = {
944                 .blkio_unlink_group_fn = throtl_unlink_blkio_group,
945                 .blkio_update_group_read_bps_fn =
946                                         throtl_update_blkio_group_read_bps,
947                 .blkio_update_group_write_bps_fn =
948                                         throtl_update_blkio_group_write_bps,
949                 .blkio_update_group_read_iops_fn =
950                                         throtl_update_blkio_group_read_iops,
951                 .blkio_update_group_write_iops_fn =
952                                         throtl_update_blkio_group_write_iops,
953         },
954         .plid = BLKIO_POLICY_THROTL,
955 };
956
957 int blk_throtl_bio(struct request_queue *q, struct bio **biop)
958 {
959         struct throtl_data *td = q->td;
960         struct throtl_grp *tg;
961         struct bio *bio = *biop;
962         bool rw = bio_data_dir(bio), update_disptime = true;
963
964         if (bio->bi_rw & REQ_THROTTLED) {
965                 bio->bi_rw &= ~REQ_THROTTLED;
966                 return 0;
967         }
968
969         spin_lock_irq(q->queue_lock);
970         tg = throtl_get_tg(td);
971
972         if (tg->nr_queued[rw]) {
973                 /*
974                  * There is already another bio queued in same dir. No
975                  * need to update dispatch time.
976                  * Still update the disptime if rate limits on this group
977                  * were changed.
978                  */
979                 if (!tg->limits_changed)
980                         update_disptime = false;
981                 else
982                         tg->limits_changed = false;
983
984                 goto queue_bio;
985         }
986
987         /* Bio is with-in rate limit of group */
988         if (tg_may_dispatch(td, tg, bio, NULL)) {
989                 throtl_charge_bio(tg, bio);
990                 goto out;
991         }
992
993 queue_bio:
994         throtl_log_tg(td, tg, "[%c] bio. bdisp=%u sz=%u bps=%llu"
995                         " iodisp=%u iops=%u queued=%d/%d",
996                         rw == READ ? 'R' : 'W',
997                         tg->bytes_disp[rw], bio->bi_size, tg->bps[rw],
998                         tg->io_disp[rw], tg->iops[rw],
999                         tg->nr_queued[READ], tg->nr_queued[WRITE]);
1000
1001         throtl_add_bio_tg(q->td, tg, bio);
1002         *biop = NULL;
1003
1004         if (update_disptime) {
1005                 tg_update_disptime(td, tg);
1006                 throtl_schedule_next_dispatch(td);
1007         }
1008
1009 out:
1010         spin_unlock_irq(q->queue_lock);
1011         return 0;
1012 }
1013
1014 int blk_throtl_init(struct request_queue *q)
1015 {
1016         struct throtl_data *td;
1017         struct throtl_grp *tg;
1018
1019         td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
1020         if (!td)
1021                 return -ENOMEM;
1022
1023         INIT_HLIST_HEAD(&td->tg_list);
1024         td->tg_service_tree = THROTL_RB_ROOT;
1025         atomic_set(&td->limits_changed, 0);
1026
1027         /* Init root group */
1028         tg = &td->root_tg;
1029         INIT_HLIST_NODE(&tg->tg_node);
1030         RB_CLEAR_NODE(&tg->rb_node);
1031         bio_list_init(&tg->bio_lists[0]);
1032         bio_list_init(&tg->bio_lists[1]);
1033
1034         /* Practically unlimited BW */
1035         tg->bps[0] = tg->bps[1] = -1;
1036         tg->iops[0] = tg->iops[1] = -1;
1037
1038         /*
1039          * Set root group reference to 2. One reference will be dropped when
1040          * all groups on tg_list are being deleted during queue exit. Other
1041          * reference will remain there as we don't want to delete this group
1042          * as it is statically allocated and gets destroyed when throtl_data
1043          * goes away.
1044          */
1045         atomic_set(&tg->ref, 2);
1046         hlist_add_head(&tg->tg_node, &td->tg_list);
1047         td->nr_undestroyed_grps++;
1048
1049         INIT_DELAYED_WORK(&td->throtl_work, blk_throtl_work);
1050
1051         rcu_read_lock();
1052         blkiocg_add_blkio_group(&blkio_root_cgroup, &tg->blkg, (void *)td,
1053                                         0, BLKIO_POLICY_THROTL);
1054         rcu_read_unlock();
1055
1056         /* Attach throtl data to request queue */
1057         td->queue = q;
1058         q->td = td;
1059         return 0;
1060 }
1061
1062 void blk_throtl_exit(struct request_queue *q)
1063 {
1064         struct throtl_data *td = q->td;
1065         bool wait = false;
1066
1067         BUG_ON(!td);
1068
1069         throtl_shutdown_timer_wq(q);
1070
1071         spin_lock_irq(q->queue_lock);
1072         throtl_release_tgs(td);
1073
1074         /* If there are other groups */
1075         if (td->nr_undestroyed_grps > 0)
1076                 wait = true;
1077
1078         spin_unlock_irq(q->queue_lock);
1079
1080         /*
1081          * Wait for tg->blkg->key accessors to exit their grace periods.
1082          * Do this wait only if there are other undestroyed groups out
1083          * there (other than root group). This can happen if cgroup deletion
1084          * path claimed the responsibility of cleaning up a group before
1085          * queue cleanup code get to the group.
1086          *
1087          * Do not call synchronize_rcu() unconditionally as there are drivers
1088          * which create/delete request queue hundreds of times during scan/boot
1089          * and synchronize_rcu() can take significant time and slow down boot.
1090          */
1091         if (wait)
1092                 synchronize_rcu();
1093
1094         /*
1095          * Just being safe to make sure after previous flush if some body did
1096          * update limits through cgroup and another work got queued, cancel
1097          * it.
1098          */
1099         throtl_shutdown_timer_wq(q);
1100         throtl_td_free(td);
1101 }
1102
1103 static int __init throtl_init(void)
1104 {
1105         blkio_policy_register(&blkio_policy_throtl);
1106         return 0;
1107 }
1108
1109 module_init(throtl_init);