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 #include "blk.h"
  14
  15 /* Max dispatch from a group in 1 round */
  16 static int throtl_grp_quantum = 8;
  17
  18 /* Total max dispatch from all groups in one round */
  19 static int throtl_quantum = 32;
  20
  21 /* Throttling is performed over 100ms slice and after that slice is renewed */
  22 static unsigned long throtl_slice = HZ/10;      /* 100 ms */
  23
  24 static struct blkcg_policy blkcg_policy_throtl;
  25
  26 /* A workqueue to queue throttle related work */
  27 static struct workqueue_struct *kthrotld_workqueue;
  28
  29 struct throtl_service_queue {
  30         struct throtl_service_queue *parent_sq; /* the parent service_queue */
  31
  32         /*
  33          * Bios queued directly to this service_queue or dispatched from
  34          * children throtl_grp's.
  35          */
  36         struct bio_list         bio_lists[2];   /* queued bios [READ/WRITE] */
  37         unsigned int            nr_queued[2];   /* number of queued bios */
  38
  39         /*
  40          * RB tree of active children throtl_grp's, which are sorted by
  41          * their ->disptime.
  42          */
  43         struct rb_root          pending_tree;   /* RB tree of active tgs */
  44         struct rb_node          *first_pending; /* first node in the tree */
  45         unsigned int            nr_pending;     /* # queued in the tree */
  46         unsigned long           first_pending_disptime; /* disptime of the first tg */
  47         struct timer_list       pending_timer;  /* fires on first_pending_disptime */
  48 };
  49
  50 enum tg_state_flags {
  51         THROTL_TG_PENDING       = 1 << 0,       /* on parent's pending tree */
  52         THROTL_TG_WAS_EMPTY     = 1 << 1,       /* bio_lists[] became non-empty */
  53 };
  54
  55 #define rb_entry_tg(node)       rb_entry((node), struct throtl_grp, rb_node)
  56
  57 /* Per-cpu group stats */
  58 struct tg_stats_cpu {
  59         /* total bytes transferred */
  60         struct blkg_rwstat              service_bytes;
  61         /* total IOs serviced, post merge */
  62         struct blkg_rwstat              serviced;
  63 };
  64
  65 struct throtl_grp {
  66         /* must be the first member */
  67         struct blkg_policy_data pd;
  68
  69         /* active throtl group service_queue member */
  70         struct rb_node rb_node;
  71
  72         /* throtl_data this group belongs to */
  73         struct throtl_data *td;
  74
  75         /* this group's service queue */
  76         struct throtl_service_queue service_queue;
  77
  78         /*
  79          * Dispatch time in jiffies. This is the estimated time when group
  80          * will unthrottle and is ready to dispatch more bio. It is used as
  81          * key to sort active groups in service tree.
  82          */
  83         unsigned long disptime;
  84
  85         unsigned int flags;
  86
  87         /* bytes per second rate limits */
  88         uint64_t bps[2];
  89
  90         /* IOPS limits */
  91         unsigned int iops[2];
  92
  93         /* Number of bytes disptached in current slice */
  94         uint64_t bytes_disp[2];
  95         /* Number of bio's dispatched in current slice */
  96         unsigned int io_disp[2];
  97
  98         /* When did we start a new slice */
  99         unsigned long slice_start[2];
 100         unsigned long slice_end[2];
 101
 102         /* Per cpu stats pointer */
 103         struct tg_stats_cpu __percpu *stats_cpu;
 104
 105         /* List of tgs waiting for per cpu stats memory to be allocated */
 106         struct list_head stats_alloc_node;
 107 };
 108
 109 struct throtl_data
 110 {
 111         /* service tree for active throtl groups */
 112         struct throtl_service_queue service_queue;
 113
 114         struct request_queue *queue;
 115
 116         /* Total Number of queued bios on READ and WRITE lists */
 117         unsigned int nr_queued[2];
 118
 119         /*
 120          * number of total undestroyed groups
 121          */
 122         unsigned int nr_undestroyed_grps;
 123
 124         /* Work for dispatching throttled bios */
 125         struct work_struct dispatch_work;
 126 };
 127
 128 /* list and work item to allocate percpu group stats */
 129 static DEFINE_SPINLOCK(tg_stats_alloc_lock);
 130 static LIST_HEAD(tg_stats_alloc_list);
 131
 132 static void tg_stats_alloc_fn(struct work_struct *);
 133 static DECLARE_DELAYED_WORK(tg_stats_alloc_work, tg_stats_alloc_fn);
 134
 135 static void throtl_pending_timer_fn(unsigned long arg);
 136
 137 static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
 138 {
 139         return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
 140 }
 141
 142 static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
 143 {
 144         return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
 145 }
 146
 147 static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
 148 {
 149         return pd_to_blkg(&tg->pd);
 150 }
 151
 152 static inline struct throtl_grp *td_root_tg(struct throtl_data *td)
 153 {
 154         return blkg_to_tg(td->queue->root_blkg);
 155 }
 156
 157 /**
 158  * sq_to_tg - return the throl_grp the specified service queue belongs to
 159  * @sq: the throtl_service_queue of interest
 160  *
 161  * Return the throtl_grp @sq belongs to.  If @sq is the top-level one
 162  * embedded in throtl_data, %NULL is returned.
 163  */
 164 static struct throtl_grp *sq_to_tg(struct throtl_service_queue *sq)
 165 {
 166         if (sq && sq->parent_sq)
 167                 return container_of(sq, struct throtl_grp, service_queue);
 168         else
 169                 return NULL;
 170 }
 171
 172 /**
 173  * sq_to_td - return throtl_data the specified service queue belongs to
 174  * @sq: the throtl_service_queue of interest
 175  *
 176  * A service_queue can be embeded in either a throtl_grp or throtl_data.
 177  * Determine the associated throtl_data accordingly and return it.
 178  */
 179 static struct throtl_data *sq_to_td(struct throtl_service_queue *sq)
 180 {
 181         struct throtl_grp *tg = sq_to_tg(sq);
 182
 183         if (tg)
 184                 return tg->td;
 185         else
 186                 return container_of(sq, struct throtl_data, service_queue);
 187 }
 188
 189 /**
 190  * throtl_log - log debug message via blktrace
 191  * @sq: the service_queue being reported
 192  * @fmt: printf format string
 193  * @args: printf args
 194  *
 195  * The messages are prefixed with "throtl BLKG_NAME" if @sq belongs to a
 196  * throtl_grp; otherwise, just "throtl".
 197  *
 198  * TODO: this should be made a function and name formatting should happen
 199  * after testing whether blktrace is enabled.
 200  */
 201 #define throtl_log(sq, fmt, args...)    do {                            \
 202         struct throtl_grp *__tg = sq_to_tg((sq));                       \
 203         struct throtl_data *__td = sq_to_td((sq));                      \
 204                                                                         \
 205         (void)__td;                                                     \
 206         if ((__tg)) {                                                   \
 207                 char __pbuf[128];                                       \
 208                                                                         \
 209                 blkg_path(tg_to_blkg(__tg), __pbuf, sizeof(__pbuf));    \
 210                 blk_add_trace_msg(__td->queue, "throtl %s " fmt, __pbuf, ##args); \
 211         } else {                                                        \
 212                 blk_add_trace_msg(__td->queue, "throtl " fmt, ##args);  \
 213         }                                                               \
 214 } while (0)
 215
 216 /*
 217  * Worker for allocating per cpu stat for tgs. This is scheduled on the
 218  * system_wq once there are some groups on the alloc_list waiting for
 219  * allocation.
 220  */
 221 static void tg_stats_alloc_fn(struct work_struct *work)
 222 {
 223         static struct tg_stats_cpu *stats_cpu;  /* this fn is non-reentrant */
 224         struct delayed_work *dwork = to_delayed_work(work);
 225         bool empty = false;
 226
 227 alloc_stats:
 228         if (!stats_cpu) {
 229                 stats_cpu = alloc_percpu(struct tg_stats_cpu);
 230                 if (!stats_cpu) {
 231                         /* allocation failed, try again after some time */
 232                         schedule_delayed_work(dwork, msecs_to_jiffies(10));
 233                         return;
 234                 }
 235         }
 236
 237         spin_lock_irq(&tg_stats_alloc_lock);
 238
 239         if (!list_empty(&tg_stats_alloc_list)) {
 240                 struct throtl_grp *tg = list_first_entry(&tg_stats_alloc_list,
 241                                                          struct throtl_grp,
 242                                                          stats_alloc_node);
 243                 swap(tg->stats_cpu, stats_cpu);
 244                 list_del_init(&tg->stats_alloc_node);
 245         }
 246
 247         empty = list_empty(&tg_stats_alloc_list);
 248         spin_unlock_irq(&tg_stats_alloc_lock);
 249         if (!empty)
 250                 goto alloc_stats;
 251 }
 252
 253 /* init a service_queue, assumes the caller zeroed it */
 254 static void throtl_service_queue_init(struct throtl_service_queue *sq,
 255                                       struct throtl_service_queue *parent_sq)
 256 {
 257         bio_list_init(&sq->bio_lists[0]);
 258         bio_list_init(&sq->bio_lists[1]);
 259         sq->pending_tree = RB_ROOT;
 260         sq->parent_sq = parent_sq;
 261         setup_timer(&sq->pending_timer, throtl_pending_timer_fn,
 262                     (unsigned long)sq);
 263 }
 264
 265 static void throtl_service_queue_exit(struct throtl_service_queue *sq)
 266 {
 267         del_timer_sync(&sq->pending_timer);
 268 }
 269
 270 static void throtl_pd_init(struct blkcg_gq *blkg)
 271 {
 272         struct throtl_grp *tg = blkg_to_tg(blkg);
 273         struct throtl_data *td = blkg->q->td;
 274         unsigned long flags;
 275
 276         throtl_service_queue_init(&tg->service_queue, &td->service_queue);
 277         RB_CLEAR_NODE(&tg->rb_node);
 278         tg->td = td;
 279
 280         tg->bps[READ] = -1;
 281         tg->bps[WRITE] = -1;
 282         tg->iops[READ] = -1;
 283         tg->iops[WRITE] = -1;
 284
 285         /*
 286          * Ugh... We need to perform per-cpu allocation for tg->stats_cpu
 287          * but percpu allocator can't be called from IO path.  Queue tg on
 288          * tg_stats_alloc_list and allocate from work item.
 289          */
 290         spin_lock_irqsave(&tg_stats_alloc_lock, flags);
 291         list_add(&tg->stats_alloc_node, &tg_stats_alloc_list);
 292         schedule_delayed_work(&tg_stats_alloc_work, 0);
 293         spin_unlock_irqrestore(&tg_stats_alloc_lock, flags);
 294 }
 295
 296 static void throtl_pd_exit(struct blkcg_gq *blkg)
 297 {
 298         struct throtl_grp *tg = blkg_to_tg(blkg);
 299         unsigned long flags;
 300
 301         spin_lock_irqsave(&tg_stats_alloc_lock, flags);
 302         list_del_init(&tg->stats_alloc_node);
 303         spin_unlock_irqrestore(&tg_stats_alloc_lock, flags);
 304
 305         free_percpu(tg->stats_cpu);
 306
 307         throtl_service_queue_exit(&tg->service_queue);
 308 }
 309
 310 static void throtl_pd_reset_stats(struct blkcg_gq *blkg)
 311 {
 312         struct throtl_grp *tg = blkg_to_tg(blkg);
 313         int cpu;
 314
 315         if (tg->stats_cpu == NULL)
 316                 return;
 317
 318         for_each_possible_cpu(cpu) {
 319                 struct tg_stats_cpu *sc = per_cpu_ptr(tg->stats_cpu, cpu);
 320
 321                 blkg_rwstat_reset(&sc->service_bytes);
 322                 blkg_rwstat_reset(&sc->serviced);
 323         }
 324 }
 325
 326 static struct throtl_grp *throtl_lookup_tg(struct throtl_data *td,
 327                                            struct blkcg *blkcg)
 328 {
 329         /*
 330          * This is the common case when there are no blkcgs.  Avoid lookup
 331          * in this case
 332          */
 333         if (blkcg == &blkcg_root)
 334                 return td_root_tg(td);
 335
 336         return blkg_to_tg(blkg_lookup(blkcg, td->queue));
 337 }
 338
 339 static struct throtl_grp *throtl_lookup_create_tg(struct throtl_data *td,
 340                                                   struct blkcg *blkcg)
 341 {
 342         struct request_queue *q = td->queue;
 343         struct throtl_grp *tg = NULL;
 344
 345         /*
 346          * This is the common case when there are no blkcgs.  Avoid lookup
 347          * in this case
 348          */
 349         if (blkcg == &blkcg_root) {
 350                 tg = td_root_tg(td);
 351         } else {
 352                 struct blkcg_gq *blkg;
 353
 354                 blkg = blkg_lookup_create(blkcg, q);
 355
 356                 /* if %NULL and @q is alive, fall back to root_tg */
 357                 if (!IS_ERR(blkg))
 358                         tg = blkg_to_tg(blkg);
 359                 else if (!blk_queue_dying(q))
 360                         tg = td_root_tg(td);
 361         }
 362
 363         return tg;
 364 }
 365
 366 static struct throtl_grp *
 367 throtl_rb_first(struct throtl_service_queue *parent_sq)
 368 {
 369         /* Service tree is empty */
 370         if (!parent_sq->nr_pending)
 371                 return NULL;
 372
 373         if (!parent_sq->first_pending)
 374                 parent_sq->first_pending = rb_first(&parent_sq->pending_tree);
 375
 376         if (parent_sq->first_pending)
 377                 return rb_entry_tg(parent_sq->first_pending);
 378
 379         return NULL;
 380 }
 381
 382 static void rb_erase_init(struct rb_node *n, struct rb_root *root)
 383 {
 384         rb_erase(n, root);
 385         RB_CLEAR_NODE(n);
 386 }
 387
 388 static void throtl_rb_erase(struct rb_node *n,
 389                             struct throtl_service_queue *parent_sq)
 390 {
 391         if (parent_sq->first_pending == n)
 392                 parent_sq->first_pending = NULL;
 393         rb_erase_init(n, &parent_sq->pending_tree);
 394         --parent_sq->nr_pending;
 395 }
 396
 397 static void update_min_dispatch_time(struct throtl_service_queue *parent_sq)
 398 {
 399         struct throtl_grp *tg;
 400
 401         tg = throtl_rb_first(parent_sq);
 402         if (!tg)
 403                 return;
 404
 405         parent_sq->first_pending_disptime = tg->disptime;
 406 }
 407
 408 static void tg_service_queue_add(struct throtl_grp *tg)
 409 {
 410         struct throtl_service_queue *parent_sq = tg->service_queue.parent_sq;
 411         struct rb_node **node = &parent_sq->pending_tree.rb_node;
 412         struct rb_node *parent = NULL;
 413         struct throtl_grp *__tg;
 414         unsigned long key = tg->disptime;
 415         int left = 1;
 416
 417         while (*node != NULL) {
 418                 parent = *node;
 419                 __tg = rb_entry_tg(parent);
 420
 421                 if (time_before(key, __tg->disptime))
 422                         node = &parent->rb_left;
 423                 else {
 424                         node = &parent->rb_right;
 425                         left = 0;
 426                 }
 427         }
 428
 429         if (left)
 430                 parent_sq->first_pending = &tg->rb_node;
 431
 432         rb_link_node(&tg->rb_node, parent, node);
 433         rb_insert_color(&tg->rb_node, &parent_sq->pending_tree);
 434 }
 435
 436 static void __throtl_enqueue_tg(struct throtl_grp *tg)
 437 {
 438         tg_service_queue_add(tg);
 439         tg->flags |= THROTL_TG_PENDING;
 440         tg->service_queue.parent_sq->nr_pending++;
 441 }
 442
 443 static void throtl_enqueue_tg(struct throtl_grp *tg)
 444 {
 445         if (!(tg->flags & THROTL_TG_PENDING))
 446                 __throtl_enqueue_tg(tg);
 447 }
 448
 449 static void __throtl_dequeue_tg(struct throtl_grp *tg)
 450 {
 451         throtl_rb_erase(&tg->rb_node, tg->service_queue.parent_sq);
 452         tg->flags &= ~THROTL_TG_PENDING;
 453 }
 454
 455 static void throtl_dequeue_tg(struct throtl_grp *tg)
 456 {
 457         if (tg->flags & THROTL_TG_PENDING)
 458                 __throtl_dequeue_tg(tg);
 459 }
 460
 461 /* Call with queue lock held */
 462 static void throtl_schedule_pending_timer(struct throtl_service_queue *sq,
 463                                           unsigned long expires)
 464 {
 465         mod_timer(&sq->pending_timer, expires);
 466         throtl_log(sq, "schedule timer. delay=%lu jiffies=%lu",
 467                    expires - jiffies, jiffies);
 468 }
 469
 470 /**
 471  * throtl_schedule_next_dispatch - schedule the next dispatch cycle
 472  * @sq: the service_queue to schedule dispatch for
 473  * @force: force scheduling
 474  *
 475  * Arm @sq->pending_timer so that the next dispatch cycle starts on the
 476  * dispatch time of the first pending child.  Returns %true if either timer
 477  * is armed or there's no pending child left.  %false if the current
 478  * dispatch window is still open and the caller should continue
 479  * dispatching.
 480  *
 481  * If @force is %true, the dispatch timer is always scheduled and this
 482  * function is guaranteed to return %true.  This is to be used when the
 483  * caller can't dispatch itself and needs to invoke pending_timer
 484  * unconditionally.  Note that forced scheduling is likely to induce short
 485  * delay before dispatch starts even if @sq->first_pending_disptime is not
 486  * in the future and thus shouldn't be used in hot paths.
 487  */
 488 static bool throtl_schedule_next_dispatch(struct throtl_service_queue *sq,
 489                                           bool force)
 490 {
 491         /* any pending children left? */
 492         if (!sq->nr_pending)
 493                 return true;
 494
 495         update_min_dispatch_time(sq);
 496
 497         /* is the next dispatch time in the future? */
 498         if (force || time_after(sq->first_pending_disptime, jiffies)) {
 499                 throtl_schedule_pending_timer(sq, sq->first_pending_disptime);
 500                 return true;
 501         }
 502
 503         /* tell the caller to continue dispatching */
 504         return false;
 505 }
 506
 507 static inline void throtl_start_new_slice(struct throtl_grp *tg, bool rw)
 508 {
 509         tg->bytes_disp[rw] = 0;
 510         tg->io_disp[rw] = 0;
 511         tg->slice_start[rw] = jiffies;
 512         tg->slice_end[rw] = jiffies + throtl_slice;
 513         throtl_log(&tg->service_queue,
 514                    "[%c] new slice start=%lu end=%lu jiffies=%lu",
 515                    rw == READ ? 'R' : 'W', tg->slice_start[rw],
 516                    tg->slice_end[rw], jiffies);
 517 }
 518
 519 static inline void throtl_set_slice_end(struct throtl_grp *tg, bool rw,
 520                                         unsigned long jiffy_end)
 521 {
 522         tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
 523 }
 524
 525 static inline void throtl_extend_slice(struct throtl_grp *tg, bool rw,
 526                                        unsigned long jiffy_end)
 527 {
 528         tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
 529         throtl_log(&tg->service_queue,
 530                    "[%c] extend slice start=%lu end=%lu jiffies=%lu",
 531                    rw == READ ? 'R' : 'W', tg->slice_start[rw],
 532                    tg->slice_end[rw], jiffies);
 533 }
 534
 535 /* Determine if previously allocated or extended slice is complete or not */
 536 static bool throtl_slice_used(struct throtl_grp *tg, bool rw)
 537 {
 538         if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
 539                 return 0;
 540
 541         return 1;
 542 }
 543
 544 /* Trim the used slices and adjust slice start accordingly */
 545 static inline void throtl_trim_slice(struct throtl_grp *tg, bool rw)
 546 {
 547         unsigned long nr_slices, time_elapsed, io_trim;
 548         u64 bytes_trim, tmp;
 549
 550         BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
 551
 552         /*
 553          * If bps are unlimited (-1), then time slice don't get
 554          * renewed. Don't try to trim the slice if slice is used. A new
 555          * slice will start when appropriate.
 556          */
 557         if (throtl_slice_used(tg, rw))
 558                 return;
 559
 560         /*
 561          * A bio has been dispatched. Also adjust slice_end. It might happen
 562          * that initially cgroup limit was very low resulting in high
 563          * slice_end, but later limit was bumped up and bio was dispached
 564          * sooner, then we need to reduce slice_end. A high bogus slice_end
 565          * is bad because it does not allow new slice to start.
 566          */
 567
 568         throtl_set_slice_end(tg, rw, jiffies + throtl_slice);
 569
 570         time_elapsed = jiffies - tg->slice_start[rw];
 571
 572         nr_slices = time_elapsed / throtl_slice;
 573
 574         if (!nr_slices)
 575                 return;
 576         tmp = tg->bps[rw] * throtl_slice * nr_slices;
 577         do_div(tmp, HZ);
 578         bytes_trim = tmp;
 579
 580         io_trim = (tg->iops[rw] * throtl_slice * nr_slices)/HZ;
 581
 582         if (!bytes_trim && !io_trim)
 583                 return;
 584
 585         if (tg->bytes_disp[rw] >= bytes_trim)
 586                 tg->bytes_disp[rw] -= bytes_trim;
 587         else
 588                 tg->bytes_disp[rw] = 0;
 589
 590         if (tg->io_disp[rw] >= io_trim)
 591                 tg->io_disp[rw] -= io_trim;
 592         else
 593                 tg->io_disp[rw] = 0;
 594
 595         tg->slice_start[rw] += nr_slices * throtl_slice;
 596
 597         throtl_log(&tg->service_queue,
 598                    "[%c] trim slice nr=%lu bytes=%llu io=%lu start=%lu end=%lu jiffies=%lu",
 599                    rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
 600                    tg->slice_start[rw], tg->slice_end[rw], jiffies);
 601 }
 602
 603 static bool tg_with_in_iops_limit(struct throtl_grp *tg, struct bio *bio,
 604                                   unsigned long *wait)
 605 {
 606         bool rw = bio_data_dir(bio);
 607         unsigned int io_allowed;
 608         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
 609         u64 tmp;
 610
 611         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
 612
 613         /* Slice has just started. Consider one slice interval */
 614         if (!jiffy_elapsed)
 615                 jiffy_elapsed_rnd = throtl_slice;
 616
 617         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
 618
 619         /*
 620          * jiffy_elapsed_rnd should not be a big value as minimum iops can be
 621          * 1 then at max jiffy elapsed should be equivalent of 1 second as we
 622          * will allow dispatch after 1 second and after that slice should
 623          * have been trimmed.
 624          */
 625
 626         tmp = (u64)tg->iops[rw] * jiffy_elapsed_rnd;
 627         do_div(tmp, HZ);
 628
 629         if (tmp > UINT_MAX)
 630                 io_allowed = UINT_MAX;
 631         else
 632                 io_allowed = tmp;
 633
 634         if (tg->io_disp[rw] + 1 <= io_allowed) {
 635                 if (wait)
 636                         *wait = 0;
 637                 return 1;
 638         }
 639
 640         /* Calc approx time to dispatch */
 641         jiffy_wait = ((tg->io_disp[rw] + 1) * HZ)/tg->iops[rw] + 1;
 642
 643         if (jiffy_wait > jiffy_elapsed)
 644                 jiffy_wait = jiffy_wait - jiffy_elapsed;
 645         else
 646                 jiffy_wait = 1;
 647
 648         if (wait)
 649                 *wait = jiffy_wait;
 650         return 0;
 651 }
 652
 653 static bool tg_with_in_bps_limit(struct throtl_grp *tg, struct bio *bio,
 654                                  unsigned long *wait)
 655 {
 656         bool rw = bio_data_dir(bio);
 657         u64 bytes_allowed, extra_bytes, tmp;
 658         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
 659
 660         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
 661
 662         /* Slice has just started. Consider one slice interval */
 663         if (!jiffy_elapsed)
 664                 jiffy_elapsed_rnd = throtl_slice;
 665
 666         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
 667
 668         tmp = tg->bps[rw] * jiffy_elapsed_rnd;
 669         do_div(tmp, HZ);
 670         bytes_allowed = tmp;
 671
 672         if (tg->bytes_disp[rw] + bio->bi_size <= bytes_allowed) {
 673                 if (wait)
 674                         *wait = 0;
 675                 return 1;
 676         }
 677
 678         /* Calc approx time to dispatch */
 679         extra_bytes = tg->bytes_disp[rw] + bio->bi_size - bytes_allowed;
 680         jiffy_wait = div64_u64(extra_bytes * HZ, tg->bps[rw]);
 681
 682         if (!jiffy_wait)
 683                 jiffy_wait = 1;
 684
 685         /*
 686          * This wait time is without taking into consideration the rounding
 687          * up we did. Add that time also.
 688          */
 689         jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
 690         if (wait)
 691                 *wait = jiffy_wait;
 692         return 0;
 693 }
 694
 695 static bool tg_no_rule_group(struct throtl_grp *tg, bool rw) {
 696         if (tg->bps[rw] == -1 && tg->iops[rw] == -1)
 697                 return 1;
 698         return 0;
 699 }
 700
 701 /*
 702  * Returns whether one can dispatch a bio or not. Also returns approx number
 703  * of jiffies to wait before this bio is with-in IO rate and can be dispatched
 704  */
 705 static bool tg_may_dispatch(struct throtl_grp *tg, struct bio *bio,
 706                             unsigned long *wait)
 707 {
 708         bool rw = bio_data_dir(bio);
 709         unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
 710
 711         /*
 712          * Currently whole state machine of group depends on first bio
 713          * queued in the group bio list. So one should not be calling
 714          * this function with a different bio if there are other bios
 715          * queued.
 716          */
 717         BUG_ON(tg->service_queue.nr_queued[rw] &&
 718                bio != bio_list_peek(&tg->service_queue.bio_lists[rw]));
 719
 720         /* If tg->bps = -1, then BW is unlimited */
 721         if (tg->bps[rw] == -1 && tg->iops[rw] == -1) {
 722                 if (wait)
 723                         *wait = 0;
 724                 return 1;
 725         }
 726
 727         /*
 728          * If previous slice expired, start a new one otherwise renew/extend
 729          * existing slice to make sure it is at least throtl_slice interval
 730          * long since now.
 731          */
 732         if (throtl_slice_used(tg, rw))
 733                 throtl_start_new_slice(tg, rw);
 734         else {
 735                 if (time_before(tg->slice_end[rw], jiffies + throtl_slice))
 736                         throtl_extend_slice(tg, rw, jiffies + throtl_slice);
 737         }
 738
 739         if (tg_with_in_bps_limit(tg, bio, &bps_wait) &&
 740             tg_with_in_iops_limit(tg, bio, &iops_wait)) {
 741                 if (wait)
 742                         *wait = 0;
 743                 return 1;
 744         }
 745
 746         max_wait = max(bps_wait, iops_wait);
 747
 748         if (wait)
 749                 *wait = max_wait;
 750
 751         if (time_before(tg->slice_end[rw], jiffies + max_wait))
 752                 throtl_extend_slice(tg, rw, jiffies + max_wait);
 753
 754         return 0;
 755 }
 756
 757 static void throtl_update_dispatch_stats(struct blkcg_gq *blkg, u64 bytes,
 758                                          int rw)
 759 {
 760         struct throtl_grp *tg = blkg_to_tg(blkg);
 761         struct tg_stats_cpu *stats_cpu;
 762         unsigned long flags;
 763
 764         /* If per cpu stats are not allocated yet, don't do any accounting. */
 765         if (tg->stats_cpu == NULL)
 766                 return;
 767
 768         /*
 769          * Disabling interrupts to provide mutual exclusion between two
 770          * writes on same cpu. It probably is not needed for 64bit. Not
 771          * optimizing that case yet.
 772          */
 773         local_irq_save(flags);
 774
 775         stats_cpu = this_cpu_ptr(tg->stats_cpu);
 776
 777         blkg_rwstat_add(&stats_cpu->serviced, rw, 1);
 778         blkg_rwstat_add(&stats_cpu->service_bytes, rw, bytes);
 779
 780         local_irq_restore(flags);
 781 }
 782
 783 static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
 784 {
 785         bool rw = bio_data_dir(bio);
 786
 787         /* Charge the bio to the group */
 788         tg->bytes_disp[rw] += bio->bi_size;
 789         tg->io_disp[rw]++;
 790
 791         /*
 792          * REQ_THROTTLED is used to prevent the same bio to be throttled
 793          * more than once as a throttled bio will go through blk-throtl the
 794          * second time when it eventually gets issued.  Set it when a bio
 795          * is being charged to a tg.
 796          *
 797          * Dispatch stats aren't recursive and each @bio should only be
 798          * accounted by the @tg it was originally associated with.  Let's
 799          * update the stats when setting REQ_THROTTLED for the first time
 800          * which is guaranteed to be for the @bio's original tg.
 801          */
 802         if (!(bio->bi_rw & REQ_THROTTLED)) {
 803                 bio->bi_rw |= REQ_THROTTLED;
 804                 throtl_update_dispatch_stats(tg_to_blkg(tg), bio->bi_size,
 805                                              bio->bi_rw);
 806         }
 807 }
 808
 809 static void throtl_add_bio_tg(struct bio *bio, struct throtl_grp *tg)
 810 {
 811         struct throtl_service_queue *sq = &tg->service_queue;
 812         bool rw = bio_data_dir(bio);
 813
 814         /*
 815          * If @tg doesn't currently have any bios queued in the same
 816          * direction, queueing @bio can change when @tg should be
 817          * dispatched.  Mark that @tg was empty.  This is automatically
 818          * cleaered on the next tg_update_disptime().
 819          */
 820         if (!sq->nr_queued[rw])
 821                 tg->flags |= THROTL_TG_WAS_EMPTY;
 822
 823         bio_list_add(&sq->bio_lists[rw], bio);
 824         /* Take a bio reference on tg */
 825         blkg_get(tg_to_blkg(tg));
 826         sq->nr_queued[rw]++;
 827         throtl_enqueue_tg(tg);
 828 }
 829
 830 static void tg_update_disptime(struct throtl_grp *tg)
 831 {
 832         struct throtl_service_queue *sq = &tg->service_queue;
 833         unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
 834         struct bio *bio;
 835
 836         if ((bio = bio_list_peek(&sq->bio_lists[READ])))
 837                 tg_may_dispatch(tg, bio, &read_wait);
 838
 839         if ((bio = bio_list_peek(&sq->bio_lists[WRITE])))
 840                 tg_may_dispatch(tg, bio, &write_wait);
 841
 842         min_wait = min(read_wait, write_wait);
 843         disptime = jiffies + min_wait;
 844
 845         /* Update dispatch time */
 846         throtl_dequeue_tg(tg);
 847         tg->disptime = disptime;
 848         throtl_enqueue_tg(tg);
 849
 850         /* see throtl_add_bio_tg() */
 851         tg->flags &= ~THROTL_TG_WAS_EMPTY;
 852 }
 853
 854 static void tg_dispatch_one_bio(struct throtl_grp *tg, bool rw)
 855 {
 856         struct throtl_service_queue *sq = &tg->service_queue;
 857         struct throtl_service_queue *parent_sq = sq->parent_sq;
 858         struct throtl_grp *parent_tg = sq_to_tg(parent_sq);
 859         struct bio *bio;
 860
 861         bio = bio_list_pop(&sq->bio_lists[rw]);
 862         sq->nr_queued[rw]--;
 863
 864         throtl_charge_bio(tg, bio);
 865
 866         /*
 867          * If our parent is another tg, we just need to transfer @bio to
 868          * the parent using throtl_add_bio_tg().  If our parent is
 869          * @td->service_queue, @bio is ready to be issued.  Put it on its
 870          * bio_lists[] and decrease total number queued.  The caller is
 871          * responsible for issuing these bios.
 872          */
 873         if (parent_tg) {
 874                 throtl_add_bio_tg(bio, parent_tg);
 875         } else {
 876                 bio_list_add(&parent_sq->bio_lists[rw], bio);
 877                 BUG_ON(tg->td->nr_queued[rw] <= 0);
 878                 tg->td->nr_queued[rw]--;
 879         }
 880
 881         throtl_trim_slice(tg, rw);
 882
 883         /* @bio is transferred to parent, drop its blkg reference */
 884         blkg_put(tg_to_blkg(tg));
 885 }
 886
 887 static int throtl_dispatch_tg(struct throtl_grp *tg)
 888 {
 889         struct throtl_service_queue *sq = &tg->service_queue;
 890         unsigned int nr_reads = 0, nr_writes = 0;
 891         unsigned int max_nr_reads = throtl_grp_quantum*3/4;
 892         unsigned int max_nr_writes = throtl_grp_quantum - max_nr_reads;
 893         struct bio *bio;
 894
 895         /* Try to dispatch 75% READS and 25% WRITES */
 896
 897         while ((bio = bio_list_peek(&sq->bio_lists[READ])) &&
 898                tg_may_dispatch(tg, bio, NULL)) {
 899
 900                 tg_dispatch_one_bio(tg, bio_data_dir(bio));
 901                 nr_reads++;
 902
 903                 if (nr_reads >= max_nr_reads)
 904                         break;
 905         }
 906
 907         while ((bio = bio_list_peek(&sq->bio_lists[WRITE])) &&
 908                tg_may_dispatch(tg, bio, NULL)) {
 909
 910                 tg_dispatch_one_bio(tg, bio_data_dir(bio));
 911                 nr_writes++;
 912
 913                 if (nr_writes >= max_nr_writes)
 914                         break;
 915         }
 916
 917         return nr_reads + nr_writes;
 918 }
 919
 920 static int throtl_select_dispatch(struct throtl_service_queue *parent_sq)
 921 {
 922         unsigned int nr_disp = 0;
 923
 924         while (1) {
 925                 struct throtl_grp *tg = throtl_rb_first(parent_sq);
 926                 struct throtl_service_queue *sq = &tg->service_queue;
 927
 928                 if (!tg)
 929                         break;
 930
 931                 if (time_before(jiffies, tg->disptime))
 932                         break;
 933
 934                 throtl_dequeue_tg(tg);
 935
 936                 nr_disp += throtl_dispatch_tg(tg);
 937
 938                 if (sq->nr_queued[0] || sq->nr_queued[1])
 939                         tg_update_disptime(tg);
 940
 941                 if (nr_disp >= throtl_quantum)
 942                         break;
 943         }
 944
 945         return nr_disp;
 946 }
 947
 948 /**
 949  * throtl_pending_timer_fn - timer function for service_queue->pending_timer
 950  * @arg: the throtl_service_queue being serviced
 951  *
 952  * This timer is armed when a child throtl_grp with active bio's become
 953  * pending and queued on the service_queue's pending_tree and expires when
 954  * the first child throtl_grp should be dispatched.  This function
 955  * dispatches bio's from the children throtl_grps to the parent
 956  * service_queue.
 957  *
 958  * If the parent's parent is another throtl_grp, dispatching is propagated
 959  * by either arming its pending_timer or repeating dispatch directly.  If
 960  * the top-level service_tree is reached, throtl_data->dispatch_work is
 961  * kicked so that the ready bio's are issued.
 962  */
 963 static void throtl_pending_timer_fn(unsigned long arg)
 964 {
 965         struct throtl_service_queue *sq = (void *)arg;
 966         struct throtl_grp *tg = sq_to_tg(sq);
 967         struct throtl_data *td = sq_to_td(sq);
 968         struct request_queue *q = td->queue;
 969         struct throtl_service_queue *parent_sq;
 970         bool dispatched;
 971         int ret;
 972
 973         spin_lock_irq(q->queue_lock);
 974 again:
 975         parent_sq = sq->parent_sq;
 976         dispatched = false;
 977
 978         while (true) {
 979                 throtl_log(sq, "dispatch nr_queued=%u read=%u write=%u",
 980                            sq->nr_queued[READ] + sq->nr_queued[WRITE],
 981                            sq->nr_queued[READ], sq->nr_queued[WRITE]);
 982
 983                 ret = throtl_select_dispatch(sq);
 984                 if (ret) {
 985                         throtl_log(sq, "bios disp=%u", ret);
 986                         dispatched = true;
 987                 }
 988
 989                 if (throtl_schedule_next_dispatch(sq, false))
 990                         break;
 991
 992                 /* this dispatch windows is still open, relax and repeat */
 993                 spin_unlock_irq(q->queue_lock);
 994                 cpu_relax();
 995                 spin_lock_irq(q->queue_lock);
 996         }
 997
 998         if (!dispatched)
 999                 goto out_unlock;
1000
1001         if (parent_sq) {
1002                 /* @parent_sq is another throl_grp, propagate dispatch */
1003                 if (tg->flags & THROTL_TG_WAS_EMPTY) {
1004                         tg_update_disptime(tg);
1005                         if (!throtl_schedule_next_dispatch(parent_sq, false)) {
1006                                 /* window is already open, repeat dispatching */
1007                                 sq = parent_sq;
1008                                 tg = sq_to_tg(sq);
1009                                 goto again;
1010                         }
1011                 }
1012         } else {
1013                 /* reached the top-level, queue issueing */
1014                 queue_work(kthrotld_workqueue, &td->dispatch_work);
1015         }
1016 out_unlock:
1017         spin_unlock_irq(q->queue_lock);
1018 }
1019
1020 /**
1021  * blk_throtl_dispatch_work_fn - work function for throtl_data->dispatch_work
1022  * @work: work item being executed
1023  *
1024  * This function is queued for execution when bio's reach the bio_lists[]
1025  * of throtl_data->service_queue.  Those bio's are ready and issued by this
1026  * function.
1027  */
1028 void blk_throtl_dispatch_work_fn(struct work_struct *work)
1029 {
1030         struct throtl_data *td = container_of(work, struct throtl_data,
1031                                               dispatch_work);
1032         struct throtl_service_queue *td_sq = &td->service_queue;
1033         struct request_queue *q = td->queue;
1034         struct bio_list bio_list_on_stack;
1035         struct bio *bio;
1036         struct blk_plug plug;
1037         int rw;
1038
1039         bio_list_init(&bio_list_on_stack);
1040
1041         spin_lock_irq(q->queue_lock);
1042         for (rw = READ; rw <= WRITE; rw++) {
1043                 bio_list_merge(&bio_list_on_stack, &td_sq->bio_lists[rw]);
1044                 bio_list_init(&td_sq->bio_lists[rw]);
1045         }
1046         spin_unlock_irq(q->queue_lock);
1047
1048         if (!bio_list_empty(&bio_list_on_stack)) {
1049                 blk_start_plug(&plug);
1050                 while((bio = bio_list_pop(&bio_list_on_stack)))
1051                         generic_make_request(bio);
1052                 blk_finish_plug(&plug);
1053         }
1054 }
1055
1056 static u64 tg_prfill_cpu_rwstat(struct seq_file *sf,
1057                                 struct blkg_policy_data *pd, int off)
1058 {
1059         struct throtl_grp *tg = pd_to_tg(pd);
1060         struct blkg_rwstat rwstat = { }, tmp;
1061         int i, cpu;
1062
1063         for_each_possible_cpu(cpu) {
1064                 struct tg_stats_cpu *sc = per_cpu_ptr(tg->stats_cpu, cpu);
1065
1066                 tmp = blkg_rwstat_read((void *)sc + off);
1067                 for (i = 0; i < BLKG_RWSTAT_NR; i++)
1068                         rwstat.cnt[i] += tmp.cnt[i];
1069         }
1070
1071         return __blkg_prfill_rwstat(sf, pd, &rwstat);
1072 }
1073
1074 static int tg_print_cpu_rwstat(struct cgroup *cgrp, struct cftype *cft,
1075                                struct seq_file *sf)
1076 {
1077         struct blkcg *blkcg = cgroup_to_blkcg(cgrp);
1078
1079         blkcg_print_blkgs(sf, blkcg, tg_prfill_cpu_rwstat, &blkcg_policy_throtl,
1080                           cft->private, true);
1081         return 0;
1082 }
1083
1084 static u64 tg_prfill_conf_u64(struct seq_file *sf, struct blkg_policy_data *pd,
1085                               int off)
1086 {
1087         struct throtl_grp *tg = pd_to_tg(pd);
1088         u64 v = *(u64 *)((void *)tg + off);
1089
1090         if (v == -1)
1091                 return 0;
1092         return __blkg_prfill_u64(sf, pd, v);
1093 }
1094
1095 static u64 tg_prfill_conf_uint(struct seq_file *sf, struct blkg_policy_data *pd,
1096                                int off)
1097 {
1098         struct throtl_grp *tg = pd_to_tg(pd);
1099         unsigned int v = *(unsigned int *)((void *)tg + off);
1100
1101         if (v == -1)
1102                 return 0;
1103         return __blkg_prfill_u64(sf, pd, v);
1104 }
1105
1106 static int tg_print_conf_u64(struct cgroup *cgrp, struct cftype *cft,
1107                              struct seq_file *sf)
1108 {
1109         blkcg_print_blkgs(sf, cgroup_to_blkcg(cgrp), tg_prfill_conf_u64,
1110                           &blkcg_policy_throtl, cft->private, false);
1111         return 0;
1112 }
1113
1114 static int tg_print_conf_uint(struct cgroup *cgrp, struct cftype *cft,
1115                               struct seq_file *sf)
1116 {
1117         blkcg_print_blkgs(sf, cgroup_to_blkcg(cgrp), tg_prfill_conf_uint,
1118                           &blkcg_policy_throtl, cft->private, false);
1119         return 0;
1120 }
1121
1122 static int tg_set_conf(struct cgroup *cgrp, struct cftype *cft, const char *buf,
1123                        bool is_u64)
1124 {
1125         struct blkcg *blkcg = cgroup_to_blkcg(cgrp);
1126         struct blkg_conf_ctx ctx;
1127         struct throtl_grp *tg;
1128         struct throtl_service_queue *sq;
1129         int ret;
1130
1131         ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
1132         if (ret)
1133                 return ret;
1134
1135         tg = blkg_to_tg(ctx.blkg);
1136         sq = &tg->service_queue;
1137
1138         if (!ctx.v)
1139                 ctx.v = -1;
1140
1141         if (is_u64)
1142                 *(u64 *)((void *)tg + cft->private) = ctx.v;
1143         else
1144                 *(unsigned int *)((void *)tg + cft->private) = ctx.v;
1145
1146         throtl_log(&tg->service_queue,
1147                    "limit change rbps=%llu wbps=%llu riops=%u wiops=%u",
1148                    tg->bps[READ], tg->bps[WRITE],
1149                    tg->iops[READ], tg->iops[WRITE]);
1150
1151         /*
1152          * We're already holding queue_lock and know @tg is valid.  Let's
1153          * apply the new config directly.
1154          *
1155          * Restart the slices for both READ and WRITES. It might happen
1156          * that a group's limit are dropped suddenly and we don't want to
1157          * account recently dispatched IO with new low rate.
1158          */
1159         throtl_start_new_slice(tg, 0);
1160         throtl_start_new_slice(tg, 1);
1161
1162         if (tg->flags & THROTL_TG_PENDING) {
1163                 tg_update_disptime(tg);
1164                 throtl_schedule_next_dispatch(sq->parent_sq, true);
1165         }
1166
1167         blkg_conf_finish(&ctx);
1168         return 0;
1169 }
1170
1171 static int tg_set_conf_u64(struct cgroup *cgrp, struct cftype *cft,
1172                            const char *buf)
1173 {
1174         return tg_set_conf(cgrp, cft, buf, true);
1175 }
1176
1177 static int tg_set_conf_uint(struct cgroup *cgrp, struct cftype *cft,
1178                             const char *buf)
1179 {
1180         return tg_set_conf(cgrp, cft, buf, false);
1181 }
1182
1183 static struct cftype throtl_files[] = {
1184         {
1185                 .name = "throttle.read_bps_device",
1186                 .private = offsetof(struct throtl_grp, bps[READ]),
1187                 .read_seq_string = tg_print_conf_u64,
1188                 .write_string = tg_set_conf_u64,
1189                 .max_write_len = 256,
1190         },
1191         {
1192                 .name = "throttle.write_bps_device",
1193                 .private = offsetof(struct throtl_grp, bps[WRITE]),
1194                 .read_seq_string = tg_print_conf_u64,
1195                 .write_string = tg_set_conf_u64,
1196                 .max_write_len = 256,
1197         },
1198         {
1199                 .name = "throttle.read_iops_device",
1200                 .private = offsetof(struct throtl_grp, iops[READ]),
1201                 .read_seq_string = tg_print_conf_uint,
1202                 .write_string = tg_set_conf_uint,
1203                 .max_write_len = 256,
1204         },
1205         {
1206                 .name = "throttle.write_iops_device",
1207                 .private = offsetof(struct throtl_grp, iops[WRITE]),
1208                 .read_seq_string = tg_print_conf_uint,
1209                 .write_string = tg_set_conf_uint,
1210                 .max_write_len = 256,
1211         },
1212         {
1213                 .name = "throttle.io_service_bytes",
1214                 .private = offsetof(struct tg_stats_cpu, service_bytes),
1215                 .read_seq_string = tg_print_cpu_rwstat,
1216         },
1217         {
1218                 .name = "throttle.io_serviced",
1219                 .private = offsetof(struct tg_stats_cpu, serviced),
1220                 .read_seq_string = tg_print_cpu_rwstat,
1221         },
1222         { }     /* terminate */
1223 };
1224
1225 static void throtl_shutdown_wq(struct request_queue *q)
1226 {
1227         struct throtl_data *td = q->td;
1228
1229         cancel_work_sync(&td->dispatch_work);
1230 }
1231
1232 static struct blkcg_policy blkcg_policy_throtl = {
1233         .pd_size                = sizeof(struct throtl_grp),
1234         .cftypes                = throtl_files,
1235
1236         .pd_init_fn             = throtl_pd_init,
1237         .pd_exit_fn             = throtl_pd_exit,
1238         .pd_reset_stats_fn      = throtl_pd_reset_stats,
1239 };
1240
1241 bool blk_throtl_bio(struct request_queue *q, struct bio *bio)
1242 {
1243         struct throtl_data *td = q->td;
1244         struct throtl_grp *tg;
1245         struct throtl_service_queue *sq;
1246         bool rw = bio_data_dir(bio);
1247         struct blkcg *blkcg;
1248         bool throttled = false;
1249
1250         /* see throtl_charge_bio() */
1251         if (bio->bi_rw & REQ_THROTTLED)
1252                 goto out;
1253
1254         /*
1255          * A throtl_grp pointer retrieved under rcu can be used to access
1256          * basic fields like stats and io rates. If a group has no rules,
1257          * just update the dispatch stats in lockless manner and return.
1258          */
1259         rcu_read_lock();
1260         blkcg = bio_blkcg(bio);
1261         tg = throtl_lookup_tg(td, blkcg);
1262         if (tg) {
1263                 if (tg_no_rule_group(tg, rw)) {
1264                         throtl_update_dispatch_stats(tg_to_blkg(tg),
1265                                                      bio->bi_size, bio->bi_rw);
1266                         goto out_unlock_rcu;
1267                 }
1268         }
1269
1270         /*
1271          * Either group has not been allocated yet or it is not an unlimited
1272          * IO group
1273          */
1274         spin_lock_irq(q->queue_lock);
1275         tg = throtl_lookup_create_tg(td, blkcg);
1276         if (unlikely(!tg))
1277                 goto out_unlock;
1278
1279         sq = &tg->service_queue;
1280
1281         while (true) {
1282                 /* throtl is FIFO - if bios are already queued, should queue */
1283                 if (sq->nr_queued[rw])
1284                         break;
1285
1286                 /* if above limits, break to queue */
1287                 if (!tg_may_dispatch(tg, bio, NULL))
1288                         break;
1289
1290                 /* within limits, let's charge and dispatch directly */
1291                 throtl_charge_bio(tg, bio);
1292
1293                 /*
1294                  * We need to trim slice even when bios are not being queued
1295                  * otherwise it might happen that a bio is not queued for
1296                  * a long time and slice keeps on extending and trim is not
1297                  * called for a long time. Now if limits are reduced suddenly
1298                  * we take into account all the IO dispatched so far at new
1299                  * low rate and * newly queued IO gets a really long dispatch
1300                  * time.
1301                  *
1302                  * So keep on trimming slice even if bio is not queued.
1303                  */
1304                 throtl_trim_slice(tg, rw);
1305
1306                 /*
1307                  * @bio passed through this layer without being throttled.
1308                  * Climb up the ladder.  If we''re already at the top, it
1309                  * can be executed directly.
1310                  */
1311                 sq = sq->parent_sq;
1312                 tg = sq_to_tg(sq);
1313                 if (!tg)
1314                         goto out_unlock;
1315         }
1316
1317         /* out-of-limit, queue to @tg */
1318         throtl_log(sq, "[%c] bio. bdisp=%llu sz=%u bps=%llu iodisp=%u iops=%u queued=%d/%d",
1319                    rw == READ ? 'R' : 'W',
1320                    tg->bytes_disp[rw], bio->bi_size, tg->bps[rw],
1321                    tg->io_disp[rw], tg->iops[rw],
1322                    sq->nr_queued[READ], sq->nr_queued[WRITE]);
1323
1324         bio_associate_current(bio);
1325         tg->td->nr_queued[rw]++;
1326         throtl_add_bio_tg(bio, tg);
1327         throttled = true;
1328
1329         /*
1330          * Update @tg's dispatch time and force schedule dispatch if @tg
1331          * was empty before @bio.  The forced scheduling isn't likely to
1332          * cause undue delay as @bio is likely to be dispatched directly if
1333          * its @tg's disptime is not in the future.
1334          */
1335         if (tg->flags & THROTL_TG_WAS_EMPTY) {
1336                 tg_update_disptime(tg);
1337                 throtl_schedule_next_dispatch(tg->service_queue.parent_sq, true);
1338         }
1339
1340 out_unlock:
1341         spin_unlock_irq(q->queue_lock);
1342 out_unlock_rcu:
1343         rcu_read_unlock();
1344 out:
1345         /*
1346          * As multiple blk-throtls may stack in the same issue path, we
1347          * don't want bios to leave with the flag set.  Clear the flag if
1348          * being issued.
1349          */
1350         if (!throttled)
1351                 bio->bi_rw &= ~REQ_THROTTLED;
1352         return throttled;
1353 }
1354
1355 /*
1356  * Dispatch all bios from all children tg's queued on @parent_sq.  On
1357  * return, @parent_sq is guaranteed to not have any active children tg's
1358  * and all bios from previously active tg's are on @parent_sq->bio_lists[].
1359  */
1360 static void tg_drain_bios(struct throtl_service_queue *parent_sq)
1361 {
1362         struct throtl_grp *tg;
1363
1364         while ((tg = throtl_rb_first(parent_sq))) {
1365                 struct throtl_service_queue *sq = &tg->service_queue;
1366                 struct bio *bio;
1367
1368                 throtl_dequeue_tg(tg);
1369
1370                 while ((bio = bio_list_peek(&sq->bio_lists[READ])))
1371                         tg_dispatch_one_bio(tg, bio_data_dir(bio));
1372                 while ((bio = bio_list_peek(&sq->bio_lists[WRITE])))
1373                         tg_dispatch_one_bio(tg, bio_data_dir(bio));
1374         }
1375 }
1376
1377 /**
1378  * blk_throtl_drain - drain throttled bios
1379  * @q: request_queue to drain throttled bios for
1380  *
1381  * Dispatch all currently throttled bios on @q through ->make_request_fn().
1382  */
1383 void blk_throtl_drain(struct request_queue *q)
1384         __releases(q->queue_lock) __acquires(q->queue_lock)
1385 {
1386         struct throtl_data *td = q->td;
1387         struct blkcg_gq *blkg;
1388         struct cgroup *pos_cgrp;
1389         struct bio *bio;
1390         int rw;
1391
1392         queue_lockdep_assert_held(q);
1393         rcu_read_lock();
1394
1395         /*
1396          * Drain each tg while doing post-order walk on the blkg tree, so
1397          * that all bios are propagated to td->service_queue.  It'd be
1398          * better to walk service_queue tree directly but blkg walk is
1399          * easier.
1400          */
1401         blkg_for_each_descendant_post(blkg, pos_cgrp, td->queue->root_blkg)
1402                 tg_drain_bios(&blkg_to_tg(blkg)->service_queue);
1403
1404         tg_drain_bios(&td_root_tg(td)->service_queue);
1405
1406         /* finally, transfer bios from top-level tg's into the td */
1407         tg_drain_bios(&td->service_queue);
1408
1409         rcu_read_unlock();
1410         spin_unlock_irq(q->queue_lock);
1411
1412         /* all bios now should be in td->service_queue, issue them */
1413         for (rw = READ; rw <= WRITE; rw++)
1414                 while ((bio = bio_list_pop(&td->service_queue.bio_lists[rw])))
1415                         generic_make_request(bio);
1416
1417         spin_lock_irq(q->queue_lock);
1418 }
1419
1420 int blk_throtl_init(struct request_queue *q)
1421 {
1422         struct throtl_data *td;
1423         int ret;
1424
1425         td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
1426         if (!td)
1427                 return -ENOMEM;
1428
1429         INIT_WORK(&td->dispatch_work, blk_throtl_dispatch_work_fn);
1430         throtl_service_queue_init(&td->service_queue, NULL);
1431
1432         q->td = td;
1433         td->queue = q;
1434
1435         /* activate policy */
1436         ret = blkcg_activate_policy(q, &blkcg_policy_throtl);
1437         if (ret)
1438                 kfree(td);
1439         return ret;
1440 }
1441
1442 void blk_throtl_exit(struct request_queue *q)
1443 {
1444         BUG_ON(!q->td);
1445         throtl_shutdown_wq(q);
1446         blkcg_deactivate_policy(q, &blkcg_policy_throtl);
1447         kfree(q->td);
1448 }
1449
1450 static int __init throtl_init(void)
1451 {
1452         kthrotld_workqueue = alloc_workqueue("kthrotld", WQ_MEM_RECLAIM, 0);
1453         if (!kthrotld_workqueue)
1454                 panic("Failed to create kthrotld\n");
1455
1456         return blkcg_policy_register(&blkcg_policy_throtl);
1457 }
1458
1459 module_init(throtl_init);