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 rb_root          pending_tree;   /* RB tree of active tgs */
  31         struct rb_node          *first_pending; /* first node in the tree */
  32         unsigned int            nr_pending;     /* # queued in the tree */
  33         unsigned long           first_pending_disptime; /* disptime of the first tg */
  34 };
  35
  36 enum tg_state_flags {
  37         THROTL_TG_PENDING       = 1 << 0,       /* on parent's pending tree */
  38 };
  39
  40 #define rb_entry_tg(node)       rb_entry((node), struct throtl_grp, rb_node)
  41
  42 /* Per-cpu group stats */
  43 struct tg_stats_cpu {
  44         /* total bytes transferred */
  45         struct blkg_rwstat              service_bytes;
  46         /* total IOs serviced, post merge */
  47         struct blkg_rwstat              serviced;
  48 };
  49
  50 struct throtl_grp {
  51         /* must be the first member */
  52         struct blkg_policy_data pd;
  53
  54         /* active throtl group service_queue member */
  55         struct rb_node rb_node;
  56
  57         /* throtl_data this group belongs to */
  58         struct throtl_data *td;
  59
  60         /* this group's service queue */
  61         struct throtl_service_queue service_queue;
  62
  63         /*
  64          * Dispatch time in jiffies. This is the estimated time when group
  65          * will unthrottle and is ready to dispatch more bio. It is used as
  66          * key to sort active groups in service tree.
  67          */
  68         unsigned long disptime;
  69
  70         unsigned int flags;
  71
  72         /* Two lists for READ and WRITE */
  73         struct bio_list bio_lists[2];
  74
  75         /* Number of queued bios on READ and WRITE lists */
  76         unsigned int nr_queued[2];
  77
  78         /* bytes per second rate limits */
  79         uint64_t bps[2];
  80
  81         /* IOPS limits */
  82         unsigned int iops[2];
  83
  84         /* Number of bytes disptached in current slice */
  85         uint64_t bytes_disp[2];
  86         /* Number of bio's dispatched in current slice */
  87         unsigned int io_disp[2];
  88
  89         /* When did we start a new slice */
  90         unsigned long slice_start[2];
  91         unsigned long slice_end[2];
  92
  93         /* Per cpu stats pointer */
  94         struct tg_stats_cpu __percpu *stats_cpu;
  95
  96         /* List of tgs waiting for per cpu stats memory to be allocated */
  97         struct list_head stats_alloc_node;
  98 };
  99
 100 struct throtl_data
 101 {
 102         /* service tree for active throtl groups */
 103         struct throtl_service_queue service_queue;
 104
 105         struct request_queue *queue;
 106
 107         /* Total Number of queued bios on READ and WRITE lists */
 108         unsigned int nr_queued[2];
 109
 110         /*
 111          * number of total undestroyed groups
 112          */
 113         unsigned int nr_undestroyed_grps;
 114
 115         /* Work for dispatching throttled bios */
 116         struct delayed_work dispatch_work;
 117 };
 118
 119 /* list and work item to allocate percpu group stats */
 120 static DEFINE_SPINLOCK(tg_stats_alloc_lock);
 121 static LIST_HEAD(tg_stats_alloc_list);
 122
 123 static void tg_stats_alloc_fn(struct work_struct *);
 124 static DECLARE_DELAYED_WORK(tg_stats_alloc_work, tg_stats_alloc_fn);
 125
 126 static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
 127 {
 128         return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
 129 }
 130
 131 static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
 132 {
 133         return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
 134 }
 135
 136 static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
 137 {
 138         return pd_to_blkg(&tg->pd);
 139 }
 140
 141 static inline struct throtl_grp *td_root_tg(struct throtl_data *td)
 142 {
 143         return blkg_to_tg(td->queue->root_blkg);
 144 }
 145
 146 #define throtl_log_tg(tg, fmt, args...) do {                            \
 147         char __pbuf[128];                                               \
 148                                                                         \
 149         blkg_path(tg_to_blkg(tg), __pbuf, sizeof(__pbuf));              \
 150         blk_add_trace_msg((tg)->td->queue, "throtl %s " fmt, __pbuf, ##args); \
 151 } while (0)
 152
 153 #define throtl_log(td, fmt, args...)    \
 154         blk_add_trace_msg((td)->queue, "throtl " fmt, ##args)
 155
 156 /*
 157  * Worker for allocating per cpu stat for tgs. This is scheduled on the
 158  * system_wq once there are some groups on the alloc_list waiting for
 159  * allocation.
 160  */
 161 static void tg_stats_alloc_fn(struct work_struct *work)
 162 {
 163         static struct tg_stats_cpu *stats_cpu;  /* this fn is non-reentrant */
 164         struct delayed_work *dwork = to_delayed_work(work);
 165         bool empty = false;
 166
 167 alloc_stats:
 168         if (!stats_cpu) {
 169                 stats_cpu = alloc_percpu(struct tg_stats_cpu);
 170                 if (!stats_cpu) {
 171                         /* allocation failed, try again after some time */
 172                         schedule_delayed_work(dwork, msecs_to_jiffies(10));
 173                         return;
 174                 }
 175         }
 176
 177         spin_lock_irq(&tg_stats_alloc_lock);
 178
 179         if (!list_empty(&tg_stats_alloc_list)) {
 180                 struct throtl_grp *tg = list_first_entry(&tg_stats_alloc_list,
 181                                                          struct throtl_grp,
 182                                                          stats_alloc_node);
 183                 swap(tg->stats_cpu, stats_cpu);
 184                 list_del_init(&tg->stats_alloc_node);
 185         }
 186
 187         empty = list_empty(&tg_stats_alloc_list);
 188         spin_unlock_irq(&tg_stats_alloc_lock);
 189         if (!empty)
 190                 goto alloc_stats;
 191 }
 192
 193 /* init a service_queue, assumes the caller zeroed it */
 194 static void throtl_service_queue_init(struct throtl_service_queue *sq)
 195 {
 196         sq->pending_tree = RB_ROOT;
 197 }
 198
 199 static void throtl_pd_init(struct blkcg_gq *blkg)
 200 {
 201         struct throtl_grp *tg = blkg_to_tg(blkg);
 202         unsigned long flags;
 203
 204         throtl_service_queue_init(&tg->service_queue);
 205         RB_CLEAR_NODE(&tg->rb_node);
 206         tg->td = blkg->q->td;
 207         bio_list_init(&tg->bio_lists[0]);
 208         bio_list_init(&tg->bio_lists[1]);
 209
 210         tg->bps[READ] = -1;
 211         tg->bps[WRITE] = -1;
 212         tg->iops[READ] = -1;
 213         tg->iops[WRITE] = -1;
 214
 215         /*
 216          * Ugh... We need to perform per-cpu allocation for tg->stats_cpu
 217          * but percpu allocator can't be called from IO path.  Queue tg on
 218          * tg_stats_alloc_list and allocate from work item.
 219          */
 220         spin_lock_irqsave(&tg_stats_alloc_lock, flags);
 221         list_add(&tg->stats_alloc_node, &tg_stats_alloc_list);
 222         schedule_delayed_work(&tg_stats_alloc_work, 0);
 223         spin_unlock_irqrestore(&tg_stats_alloc_lock, flags);
 224 }
 225
 226 static void throtl_pd_exit(struct blkcg_gq *blkg)
 227 {
 228         struct throtl_grp *tg = blkg_to_tg(blkg);
 229         unsigned long flags;
 230
 231         spin_lock_irqsave(&tg_stats_alloc_lock, flags);
 232         list_del_init(&tg->stats_alloc_node);
 233         spin_unlock_irqrestore(&tg_stats_alloc_lock, flags);
 234
 235         free_percpu(tg->stats_cpu);
 236 }
 237
 238 static void throtl_pd_reset_stats(struct blkcg_gq *blkg)
 239 {
 240         struct throtl_grp *tg = blkg_to_tg(blkg);
 241         int cpu;
 242
 243         if (tg->stats_cpu == NULL)
 244                 return;
 245
 246         for_each_possible_cpu(cpu) {
 247                 struct tg_stats_cpu *sc = per_cpu_ptr(tg->stats_cpu, cpu);
 248
 249                 blkg_rwstat_reset(&sc->service_bytes);
 250                 blkg_rwstat_reset(&sc->serviced);
 251         }
 252 }
 253
 254 static struct throtl_grp *throtl_lookup_tg(struct throtl_data *td,
 255                                            struct blkcg *blkcg)
 256 {
 257         /*
 258          * This is the common case when there are no blkcgs.  Avoid lookup
 259          * in this case
 260          */
 261         if (blkcg == &blkcg_root)
 262                 return td_root_tg(td);
 263
 264         return blkg_to_tg(blkg_lookup(blkcg, td->queue));
 265 }
 266
 267 static struct throtl_grp *throtl_lookup_create_tg(struct throtl_data *td,
 268                                                   struct blkcg *blkcg)
 269 {
 270         struct request_queue *q = td->queue;
 271         struct throtl_grp *tg = NULL;
 272
 273         /*
 274          * This is the common case when there are no blkcgs.  Avoid lookup
 275          * in this case
 276          */
 277         if (blkcg == &blkcg_root) {
 278                 tg = td_root_tg(td);
 279         } else {
 280                 struct blkcg_gq *blkg;
 281
 282                 blkg = blkg_lookup_create(blkcg, q);
 283
 284                 /* if %NULL and @q is alive, fall back to root_tg */
 285                 if (!IS_ERR(blkg))
 286                         tg = blkg_to_tg(blkg);
 287                 else if (!blk_queue_dying(q))
 288                         tg = td_root_tg(td);
 289         }
 290
 291         return tg;
 292 }
 293
 294 static struct throtl_grp *
 295 throtl_rb_first(struct throtl_service_queue *parent_sq)
 296 {
 297         /* Service tree is empty */
 298         if (!parent_sq->nr_pending)
 299                 return NULL;
 300
 301         if (!parent_sq->first_pending)
 302                 parent_sq->first_pending = rb_first(&parent_sq->pending_tree);
 303
 304         if (parent_sq->first_pending)
 305                 return rb_entry_tg(parent_sq->first_pending);
 306
 307         return NULL;
 308 }
 309
 310 static void rb_erase_init(struct rb_node *n, struct rb_root *root)
 311 {
 312         rb_erase(n, root);
 313         RB_CLEAR_NODE(n);
 314 }
 315
 316 static void throtl_rb_erase(struct rb_node *n,
 317                             struct throtl_service_queue *parent_sq)
 318 {
 319         if (parent_sq->first_pending == n)
 320                 parent_sq->first_pending = NULL;
 321         rb_erase_init(n, &parent_sq->pending_tree);
 322         --parent_sq->nr_pending;
 323 }
 324
 325 static void update_min_dispatch_time(struct throtl_service_queue *parent_sq)
 326 {
 327         struct throtl_grp *tg;
 328
 329         tg = throtl_rb_first(parent_sq);
 330         if (!tg)
 331                 return;
 332
 333         parent_sq->first_pending_disptime = tg->disptime;
 334 }
 335
 336 static void tg_service_queue_add(struct throtl_grp *tg,
 337                                  struct throtl_service_queue *parent_sq)
 338 {
 339         struct rb_node **node = &parent_sq->pending_tree.rb_node;
 340         struct rb_node *parent = NULL;
 341         struct throtl_grp *__tg;
 342         unsigned long key = tg->disptime;
 343         int left = 1;
 344
 345         while (*node != NULL) {
 346                 parent = *node;
 347                 __tg = rb_entry_tg(parent);
 348
 349                 if (time_before(key, __tg->disptime))
 350                         node = &parent->rb_left;
 351                 else {
 352                         node = &parent->rb_right;
 353                         left = 0;
 354                 }
 355         }
 356
 357         if (left)
 358                 parent_sq->first_pending = &tg->rb_node;
 359
 360         rb_link_node(&tg->rb_node, parent, node);
 361         rb_insert_color(&tg->rb_node, &parent_sq->pending_tree);
 362 }
 363
 364 static void __throtl_enqueue_tg(struct throtl_grp *tg,
 365                                 struct throtl_service_queue *parent_sq)
 366 {
 367         tg_service_queue_add(tg, parent_sq);
 368         tg->flags |= THROTL_TG_PENDING;
 369         parent_sq->nr_pending++;
 370 }
 371
 372 static void throtl_enqueue_tg(struct throtl_grp *tg,
 373                               struct throtl_service_queue *parent_sq)
 374 {
 375         if (!(tg->flags & THROTL_TG_PENDING))
 376                 __throtl_enqueue_tg(tg, parent_sq);
 377 }
 378
 379 static void __throtl_dequeue_tg(struct throtl_grp *tg,
 380                                 struct throtl_service_queue *parent_sq)
 381 {
 382         throtl_rb_erase(&tg->rb_node, parent_sq);
 383         tg->flags &= ~THROTL_TG_PENDING;
 384 }
 385
 386 static void throtl_dequeue_tg(struct throtl_grp *tg,
 387                               struct throtl_service_queue *parent_sq)
 388 {
 389         if (tg->flags & THROTL_TG_PENDING)
 390                 __throtl_dequeue_tg(tg, parent_sq);
 391 }
 392
 393 /* Call with queue lock held */
 394 static void throtl_schedule_delayed_work(struct throtl_data *td,
 395                                          unsigned long delay)
 396 {
 397         struct delayed_work *dwork = &td->dispatch_work;
 398
 399         mod_delayed_work(kthrotld_workqueue, dwork, delay);
 400         throtl_log(td, "schedule work. delay=%lu jiffies=%lu", delay, jiffies);
 401 }
 402
 403 static void throtl_schedule_next_dispatch(struct throtl_data *td)
 404 {
 405         struct throtl_service_queue *sq = &td->service_queue;
 406
 407         /* any pending children left? */
 408         if (!sq->nr_pending)
 409                 return;
 410
 411         update_min_dispatch_time(sq);
 412
 413         if (time_before_eq(sq->first_pending_disptime, jiffies))
 414                 throtl_schedule_delayed_work(td, 0);
 415         else
 416                 throtl_schedule_delayed_work(td, sq->first_pending_disptime - jiffies);
 417 }
 418
 419 static inline void throtl_start_new_slice(struct throtl_grp *tg, bool rw)
 420 {
 421         tg->bytes_disp[rw] = 0;
 422         tg->io_disp[rw] = 0;
 423         tg->slice_start[rw] = jiffies;
 424         tg->slice_end[rw] = jiffies + throtl_slice;
 425         throtl_log_tg(tg, "[%c] new slice start=%lu end=%lu jiffies=%lu",
 426                         rw == READ ? 'R' : 'W', tg->slice_start[rw],
 427                         tg->slice_end[rw], jiffies);
 428 }
 429
 430 static inline void throtl_set_slice_end(struct throtl_grp *tg, bool rw,
 431                                         unsigned long jiffy_end)
 432 {
 433         tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
 434 }
 435
 436 static inline void throtl_extend_slice(struct throtl_grp *tg, bool rw,
 437                                        unsigned long jiffy_end)
 438 {
 439         tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
 440         throtl_log_tg(tg, "[%c] extend slice start=%lu end=%lu jiffies=%lu",
 441                         rw == READ ? 'R' : 'W', tg->slice_start[rw],
 442                         tg->slice_end[rw], jiffies);
 443 }
 444
 445 /* Determine if previously allocated or extended slice is complete or not */
 446 static bool throtl_slice_used(struct throtl_grp *tg, bool rw)
 447 {
 448         if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
 449                 return 0;
 450
 451         return 1;
 452 }
 453
 454 /* Trim the used slices and adjust slice start accordingly */
 455 static inline void throtl_trim_slice(struct throtl_grp *tg, bool rw)
 456 {
 457         unsigned long nr_slices, time_elapsed, io_trim;
 458         u64 bytes_trim, tmp;
 459
 460         BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
 461
 462         /*
 463          * If bps are unlimited (-1), then time slice don't get
 464          * renewed. Don't try to trim the slice if slice is used. A new
 465          * slice will start when appropriate.
 466          */
 467         if (throtl_slice_used(tg, rw))
 468                 return;
 469
 470         /*
 471          * A bio has been dispatched. Also adjust slice_end. It might happen
 472          * that initially cgroup limit was very low resulting in high
 473          * slice_end, but later limit was bumped up and bio was dispached
 474          * sooner, then we need to reduce slice_end. A high bogus slice_end
 475          * is bad because it does not allow new slice to start.
 476          */
 477
 478         throtl_set_slice_end(tg, rw, jiffies + throtl_slice);
 479
 480         time_elapsed = jiffies - tg->slice_start[rw];
 481
 482         nr_slices = time_elapsed / throtl_slice;
 483
 484         if (!nr_slices)
 485                 return;
 486         tmp = tg->bps[rw] * throtl_slice * nr_slices;
 487         do_div(tmp, HZ);
 488         bytes_trim = tmp;
 489
 490         io_trim = (tg->iops[rw] * throtl_slice * nr_slices)/HZ;
 491
 492         if (!bytes_trim && !io_trim)
 493                 return;
 494
 495         if (tg->bytes_disp[rw] >= bytes_trim)
 496                 tg->bytes_disp[rw] -= bytes_trim;
 497         else
 498                 tg->bytes_disp[rw] = 0;
 499
 500         if (tg->io_disp[rw] >= io_trim)
 501                 tg->io_disp[rw] -= io_trim;
 502         else
 503                 tg->io_disp[rw] = 0;
 504
 505         tg->slice_start[rw] += nr_slices * throtl_slice;
 506
 507         throtl_log_tg(tg, "[%c] trim slice nr=%lu bytes=%llu io=%lu"
 508                         " start=%lu end=%lu jiffies=%lu",
 509                         rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
 510                         tg->slice_start[rw], tg->slice_end[rw], jiffies);
 511 }
 512
 513 static bool tg_with_in_iops_limit(struct throtl_grp *tg, struct bio *bio,
 514                                   unsigned long *wait)
 515 {
 516         bool rw = bio_data_dir(bio);
 517         unsigned int io_allowed;
 518         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
 519         u64 tmp;
 520
 521         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
 522
 523         /* Slice has just started. Consider one slice interval */
 524         if (!jiffy_elapsed)
 525                 jiffy_elapsed_rnd = throtl_slice;
 526
 527         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
 528
 529         /*
 530          * jiffy_elapsed_rnd should not be a big value as minimum iops can be
 531          * 1 then at max jiffy elapsed should be equivalent of 1 second as we
 532          * will allow dispatch after 1 second and after that slice should
 533          * have been trimmed.
 534          */
 535
 536         tmp = (u64)tg->iops[rw] * jiffy_elapsed_rnd;
 537         do_div(tmp, HZ);
 538
 539         if (tmp > UINT_MAX)
 540                 io_allowed = UINT_MAX;
 541         else
 542                 io_allowed = tmp;
 543
 544         if (tg->io_disp[rw] + 1 <= io_allowed) {
 545                 if (wait)
 546                         *wait = 0;
 547                 return 1;
 548         }
 549
 550         /* Calc approx time to dispatch */
 551         jiffy_wait = ((tg->io_disp[rw] + 1) * HZ)/tg->iops[rw] + 1;
 552
 553         if (jiffy_wait > jiffy_elapsed)
 554                 jiffy_wait = jiffy_wait - jiffy_elapsed;
 555         else
 556                 jiffy_wait = 1;
 557
 558         if (wait)
 559                 *wait = jiffy_wait;
 560         return 0;
 561 }
 562
 563 static bool tg_with_in_bps_limit(struct throtl_grp *tg, struct bio *bio,
 564                                  unsigned long *wait)
 565 {
 566         bool rw = bio_data_dir(bio);
 567         u64 bytes_allowed, extra_bytes, tmp;
 568         unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
 569
 570         jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
 571
 572         /* Slice has just started. Consider one slice interval */
 573         if (!jiffy_elapsed)
 574                 jiffy_elapsed_rnd = throtl_slice;
 575
 576         jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
 577
 578         tmp = tg->bps[rw] * jiffy_elapsed_rnd;
 579         do_div(tmp, HZ);
 580         bytes_allowed = tmp;
 581
 582         if (tg->bytes_disp[rw] + bio->bi_size <= bytes_allowed) {
 583                 if (wait)
 584                         *wait = 0;
 585                 return 1;
 586         }
 587
 588         /* Calc approx time to dispatch */
 589         extra_bytes = tg->bytes_disp[rw] + bio->bi_size - bytes_allowed;
 590         jiffy_wait = div64_u64(extra_bytes * HZ, tg->bps[rw]);
 591
 592         if (!jiffy_wait)
 593                 jiffy_wait = 1;
 594
 595         /*
 596          * This wait time is without taking into consideration the rounding
 597          * up we did. Add that time also.
 598          */
 599         jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
 600         if (wait)
 601                 *wait = jiffy_wait;
 602         return 0;
 603 }
 604
 605 static bool tg_no_rule_group(struct throtl_grp *tg, bool rw) {
 606         if (tg->bps[rw] == -1 && tg->iops[rw] == -1)
 607                 return 1;
 608         return 0;
 609 }
 610
 611 /*
 612  * Returns whether one can dispatch a bio or not. Also returns approx number
 613  * of jiffies to wait before this bio is with-in IO rate and can be dispatched
 614  */
 615 static bool tg_may_dispatch(struct throtl_grp *tg, struct bio *bio,
 616                             unsigned long *wait)
 617 {
 618         bool rw = bio_data_dir(bio);
 619         unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
 620
 621         /*
 622          * Currently whole state machine of group depends on first bio
 623          * queued in the group bio list. So one should not be calling
 624          * this function with a different bio if there are other bios
 625          * queued.
 626          */
 627         BUG_ON(tg->nr_queued[rw] && bio != bio_list_peek(&tg->bio_lists[rw]));
 628
 629         /* If tg->bps = -1, then BW is unlimited */
 630         if (tg->bps[rw] == -1 && tg->iops[rw] == -1) {
 631                 if (wait)
 632                         *wait = 0;
 633                 return 1;
 634         }
 635
 636         /*
 637          * If previous slice expired, start a new one otherwise renew/extend
 638          * existing slice to make sure it is at least throtl_slice interval
 639          * long since now.
 640          */
 641         if (throtl_slice_used(tg, rw))
 642                 throtl_start_new_slice(tg, rw);
 643         else {
 644                 if (time_before(tg->slice_end[rw], jiffies + throtl_slice))
 645                         throtl_extend_slice(tg, rw, jiffies + throtl_slice);
 646         }
 647
 648         if (tg_with_in_bps_limit(tg, bio, &bps_wait) &&
 649             tg_with_in_iops_limit(tg, bio, &iops_wait)) {
 650                 if (wait)
 651                         *wait = 0;
 652                 return 1;
 653         }
 654
 655         max_wait = max(bps_wait, iops_wait);
 656
 657         if (wait)
 658                 *wait = max_wait;
 659
 660         if (time_before(tg->slice_end[rw], jiffies + max_wait))
 661                 throtl_extend_slice(tg, rw, jiffies + max_wait);
 662
 663         return 0;
 664 }
 665
 666 static void throtl_update_dispatch_stats(struct blkcg_gq *blkg, u64 bytes,
 667                                          int rw)
 668 {
 669         struct throtl_grp *tg = blkg_to_tg(blkg);
 670         struct tg_stats_cpu *stats_cpu;
 671         unsigned long flags;
 672
 673         /* If per cpu stats are not allocated yet, don't do any accounting. */
 674         if (tg->stats_cpu == NULL)
 675                 return;
 676
 677         /*
 678          * Disabling interrupts to provide mutual exclusion between two
 679          * writes on same cpu. It probably is not needed for 64bit. Not
 680          * optimizing that case yet.
 681          */
 682         local_irq_save(flags);
 683
 684         stats_cpu = this_cpu_ptr(tg->stats_cpu);
 685
 686         blkg_rwstat_add(&stats_cpu->serviced, rw, 1);
 687         blkg_rwstat_add(&stats_cpu->service_bytes, rw, bytes);
 688
 689         local_irq_restore(flags);
 690 }
 691
 692 static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
 693 {
 694         bool rw = bio_data_dir(bio);
 695
 696         /* Charge the bio to the group */
 697         tg->bytes_disp[rw] += bio->bi_size;
 698         tg->io_disp[rw]++;
 699
 700         throtl_update_dispatch_stats(tg_to_blkg(tg), bio->bi_size, bio->bi_rw);
 701 }
 702
 703 static void throtl_add_bio_tg(struct bio *bio, struct throtl_grp *tg,
 704                               struct throtl_service_queue *parent_sq)
 705 {
 706         bool rw = bio_data_dir(bio);
 707
 708         bio_list_add(&tg->bio_lists[rw], bio);
 709         /* Take a bio reference on tg */
 710         blkg_get(tg_to_blkg(tg));
 711         tg->nr_queued[rw]++;
 712         tg->td->nr_queued[rw]++;
 713         throtl_enqueue_tg(tg, parent_sq);
 714 }
 715
 716 static void tg_update_disptime(struct throtl_grp *tg,
 717                                struct throtl_service_queue *parent_sq)
 718 {
 719         unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
 720         struct bio *bio;
 721
 722         if ((bio = bio_list_peek(&tg->bio_lists[READ])))
 723                 tg_may_dispatch(tg, bio, &read_wait);
 724
 725         if ((bio = bio_list_peek(&tg->bio_lists[WRITE])))
 726                 tg_may_dispatch(tg, bio, &write_wait);
 727
 728         min_wait = min(read_wait, write_wait);
 729         disptime = jiffies + min_wait;
 730
 731         /* Update dispatch time */
 732         throtl_dequeue_tg(tg, parent_sq);
 733         tg->disptime = disptime;
 734         throtl_enqueue_tg(tg, parent_sq);
 735 }
 736
 737 static void tg_dispatch_one_bio(struct throtl_grp *tg, bool rw,
 738                                 struct bio_list *bl)
 739 {
 740         struct bio *bio;
 741
 742         bio = bio_list_pop(&tg->bio_lists[rw]);
 743         tg->nr_queued[rw]--;
 744         /* Drop bio reference on blkg */
 745         blkg_put(tg_to_blkg(tg));
 746
 747         BUG_ON(tg->td->nr_queued[rw] <= 0);
 748         tg->td->nr_queued[rw]--;
 749
 750         throtl_charge_bio(tg, bio);
 751         bio_list_add(bl, bio);
 752         bio->bi_rw |= REQ_THROTTLED;
 753
 754         throtl_trim_slice(tg, rw);
 755 }
 756
 757 static int throtl_dispatch_tg(struct throtl_grp *tg, struct bio_list *bl)
 758 {
 759         unsigned int nr_reads = 0, nr_writes = 0;
 760         unsigned int max_nr_reads = throtl_grp_quantum*3/4;
 761         unsigned int max_nr_writes = throtl_grp_quantum - max_nr_reads;
 762         struct bio *bio;
 763
 764         /* Try to dispatch 75% READS and 25% WRITES */
 765
 766         while ((bio = bio_list_peek(&tg->bio_lists[READ])) &&
 767                tg_may_dispatch(tg, bio, NULL)) {
 768
 769                 tg_dispatch_one_bio(tg, bio_data_dir(bio), bl);
 770                 nr_reads++;
 771
 772                 if (nr_reads >= max_nr_reads)
 773                         break;
 774         }
 775
 776         while ((bio = bio_list_peek(&tg->bio_lists[WRITE])) &&
 777                tg_may_dispatch(tg, bio, NULL)) {
 778
 779                 tg_dispatch_one_bio(tg, bio_data_dir(bio), bl);
 780                 nr_writes++;
 781
 782                 if (nr_writes >= max_nr_writes)
 783                         break;
 784         }
 785
 786         return nr_reads + nr_writes;
 787 }
 788
 789 static int throtl_select_dispatch(struct throtl_service_queue *parent_sq,
 790                                   struct bio_list *bl)
 791 {
 792         unsigned int nr_disp = 0;
 793         struct throtl_grp *tg;
 794
 795         while (1) {
 796                 tg = throtl_rb_first(parent_sq);
 797
 798                 if (!tg)
 799                         break;
 800
 801                 if (time_before(jiffies, tg->disptime))
 802                         break;
 803
 804                 throtl_dequeue_tg(tg, parent_sq);
 805
 806                 nr_disp += throtl_dispatch_tg(tg, bl);
 807
 808                 if (tg->nr_queued[0] || tg->nr_queued[1])
 809                         tg_update_disptime(tg, parent_sq);
 810
 811                 if (nr_disp >= throtl_quantum)
 812                         break;
 813         }
 814
 815         return nr_disp;
 816 }
 817
 818 /* work function to dispatch throttled bios */
 819 void blk_throtl_dispatch_work_fn(struct work_struct *work)
 820 {
 821         struct throtl_data *td = container_of(to_delayed_work(work),
 822                                               struct throtl_data, dispatch_work);
 823         struct request_queue *q = td->queue;
 824         unsigned int nr_disp = 0;
 825         struct bio_list bio_list_on_stack;
 826         struct bio *bio;
 827         struct blk_plug plug;
 828
 829         spin_lock_irq(q->queue_lock);
 830
 831         bio_list_init(&bio_list_on_stack);
 832
 833         throtl_log(td, "dispatch nr_queued=%u read=%u write=%u",
 834                    td->nr_queued[READ] + td->nr_queued[WRITE],
 835                    td->nr_queued[READ], td->nr_queued[WRITE]);
 836
 837         nr_disp = throtl_select_dispatch(&td->service_queue, &bio_list_on_stack);
 838
 839         if (nr_disp)
 840                 throtl_log(td, "bios disp=%u", nr_disp);
 841
 842         throtl_schedule_next_dispatch(td);
 843
 844         spin_unlock_irq(q->queue_lock);
 845
 846         /*
 847          * If we dispatched some requests, unplug the queue to make sure
 848          * immediate dispatch
 849          */
 850         if (nr_disp) {
 851                 blk_start_plug(&plug);
 852                 while((bio = bio_list_pop(&bio_list_on_stack)))
 853                         generic_make_request(bio);
 854                 blk_finish_plug(&plug);
 855         }
 856 }
 857
 858 static u64 tg_prfill_cpu_rwstat(struct seq_file *sf,
 859                                 struct blkg_policy_data *pd, int off)
 860 {
 861         struct throtl_grp *tg = pd_to_tg(pd);
 862         struct blkg_rwstat rwstat = { }, tmp;
 863         int i, cpu;
 864
 865         for_each_possible_cpu(cpu) {
 866                 struct tg_stats_cpu *sc = per_cpu_ptr(tg->stats_cpu, cpu);
 867
 868                 tmp = blkg_rwstat_read((void *)sc + off);
 869                 for (i = 0; i < BLKG_RWSTAT_NR; i++)
 870                         rwstat.cnt[i] += tmp.cnt[i];
 871         }
 872
 873         return __blkg_prfill_rwstat(sf, pd, &rwstat);
 874 }
 875
 876 static int tg_print_cpu_rwstat(struct cgroup *cgrp, struct cftype *cft,
 877                                struct seq_file *sf)
 878 {
 879         struct blkcg *blkcg = cgroup_to_blkcg(cgrp);
 880
 881         blkcg_print_blkgs(sf, blkcg, tg_prfill_cpu_rwstat, &blkcg_policy_throtl,
 882                           cft->private, true);
 883         return 0;
 884 }
 885
 886 static u64 tg_prfill_conf_u64(struct seq_file *sf, struct blkg_policy_data *pd,
 887                               int off)
 888 {
 889         struct throtl_grp *tg = pd_to_tg(pd);
 890         u64 v = *(u64 *)((void *)tg + off);
 891
 892         if (v == -1)
 893                 return 0;
 894         return __blkg_prfill_u64(sf, pd, v);
 895 }
 896
 897 static u64 tg_prfill_conf_uint(struct seq_file *sf, struct blkg_policy_data *pd,
 898                                int off)
 899 {
 900         struct throtl_grp *tg = pd_to_tg(pd);
 901         unsigned int v = *(unsigned int *)((void *)tg + off);
 902
 903         if (v == -1)
 904                 return 0;
 905         return __blkg_prfill_u64(sf, pd, v);
 906 }
 907
 908 static int tg_print_conf_u64(struct cgroup *cgrp, struct cftype *cft,
 909                              struct seq_file *sf)
 910 {
 911         blkcg_print_blkgs(sf, cgroup_to_blkcg(cgrp), tg_prfill_conf_u64,
 912                           &blkcg_policy_throtl, cft->private, false);
 913         return 0;
 914 }
 915
 916 static int tg_print_conf_uint(struct cgroup *cgrp, struct cftype *cft,
 917                               struct seq_file *sf)
 918 {
 919         blkcg_print_blkgs(sf, cgroup_to_blkcg(cgrp), tg_prfill_conf_uint,
 920                           &blkcg_policy_throtl, cft->private, false);
 921         return 0;
 922 }
 923
 924 static int tg_set_conf(struct cgroup *cgrp, struct cftype *cft, const char *buf,
 925                        bool is_u64)
 926 {
 927         struct blkcg *blkcg = cgroup_to_blkcg(cgrp);
 928         struct blkg_conf_ctx ctx;
 929         struct throtl_grp *tg;
 930         struct throtl_data *td;
 931         int ret;
 932
 933         ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
 934         if (ret)
 935                 return ret;
 936
 937         tg = blkg_to_tg(ctx.blkg);
 938         td = ctx.blkg->q->td;
 939
 940         if (!ctx.v)
 941                 ctx.v = -1;
 942
 943         if (is_u64)
 944                 *(u64 *)((void *)tg + cft->private) = ctx.v;
 945         else
 946                 *(unsigned int *)((void *)tg + cft->private) = ctx.v;
 947
 948         throtl_log_tg(tg, "limit change rbps=%llu wbps=%llu riops=%u wiops=%u",
 949                       tg->bps[READ], tg->bps[WRITE],
 950                       tg->iops[READ], tg->iops[WRITE]);
 951
 952         /*
 953          * We're already holding queue_lock and know @tg is valid.  Let's
 954          * apply the new config directly.
 955          *
 956          * Restart the slices for both READ and WRITES. It might happen
 957          * that a group's limit are dropped suddenly and we don't want to
 958          * account recently dispatched IO with new low rate.
 959          */
 960         throtl_start_new_slice(tg, 0);
 961         throtl_start_new_slice(tg, 1);
 962
 963         if (tg->flags & THROTL_TG_PENDING) {
 964                 tg_update_disptime(tg, &td->service_queue);
 965                 throtl_schedule_next_dispatch(td);
 966         }
 967
 968         blkg_conf_finish(&ctx);
 969         return 0;
 970 }
 971
 972 static int tg_set_conf_u64(struct cgroup *cgrp, struct cftype *cft,
 973                            const char *buf)
 974 {
 975         return tg_set_conf(cgrp, cft, buf, true);
 976 }
 977
 978 static int tg_set_conf_uint(struct cgroup *cgrp, struct cftype *cft,
 979                             const char *buf)
 980 {
 981         return tg_set_conf(cgrp, cft, buf, false);
 982 }
 983
 984 static struct cftype throtl_files[] = {
 985         {
 986                 .name = "throttle.read_bps_device",
 987                 .private = offsetof(struct throtl_grp, bps[READ]),
 988                 .read_seq_string = tg_print_conf_u64,
 989                 .write_string = tg_set_conf_u64,
 990                 .max_write_len = 256,
 991         },
 992         {
 993                 .name = "throttle.write_bps_device",
 994                 .private = offsetof(struct throtl_grp, bps[WRITE]),
 995                 .read_seq_string = tg_print_conf_u64,
 996                 .write_string = tg_set_conf_u64,
 997                 .max_write_len = 256,
 998         },
 999         {
1000                 .name = "throttle.read_iops_device",
1001                 .private = offsetof(struct throtl_grp, iops[READ]),
1002                 .read_seq_string = tg_print_conf_uint,
1003                 .write_string = tg_set_conf_uint,
1004                 .max_write_len = 256,
1005         },
1006         {
1007                 .name = "throttle.write_iops_device",
1008                 .private = offsetof(struct throtl_grp, iops[WRITE]),
1009                 .read_seq_string = tg_print_conf_uint,
1010                 .write_string = tg_set_conf_uint,
1011                 .max_write_len = 256,
1012         },
1013         {
1014                 .name = "throttle.io_service_bytes",
1015                 .private = offsetof(struct tg_stats_cpu, service_bytes),
1016                 .read_seq_string = tg_print_cpu_rwstat,
1017         },
1018         {
1019                 .name = "throttle.io_serviced",
1020                 .private = offsetof(struct tg_stats_cpu, serviced),
1021                 .read_seq_string = tg_print_cpu_rwstat,
1022         },
1023         { }     /* terminate */
1024 };
1025
1026 static void throtl_shutdown_wq(struct request_queue *q)
1027 {
1028         struct throtl_data *td = q->td;
1029
1030         cancel_delayed_work_sync(&td->dispatch_work);
1031 }
1032
1033 static struct blkcg_policy blkcg_policy_throtl = {
1034         .pd_size                = sizeof(struct throtl_grp),
1035         .cftypes                = throtl_files,
1036
1037         .pd_init_fn             = throtl_pd_init,
1038         .pd_exit_fn             = throtl_pd_exit,
1039         .pd_reset_stats_fn      = throtl_pd_reset_stats,
1040 };
1041
1042 bool blk_throtl_bio(struct request_queue *q, struct bio *bio)
1043 {
1044         struct throtl_data *td = q->td;
1045         struct throtl_grp *tg;
1046         bool rw = bio_data_dir(bio), update_disptime = true;
1047         struct blkcg *blkcg;
1048         bool throttled = false;
1049
1050         if (bio->bi_rw & REQ_THROTTLED) {
1051                 bio->bi_rw &= ~REQ_THROTTLED;
1052                 goto out;
1053         }
1054
1055         /*
1056          * A throtl_grp pointer retrieved under rcu can be used to access
1057          * basic fields like stats and io rates. If a group has no rules,
1058          * just update the dispatch stats in lockless manner and return.
1059          */
1060         rcu_read_lock();
1061         blkcg = bio_blkcg(bio);
1062         tg = throtl_lookup_tg(td, blkcg);
1063         if (tg) {
1064                 if (tg_no_rule_group(tg, rw)) {
1065                         throtl_update_dispatch_stats(tg_to_blkg(tg),
1066                                                      bio->bi_size, bio->bi_rw);
1067                         goto out_unlock_rcu;
1068                 }
1069         }
1070
1071         /*
1072          * Either group has not been allocated yet or it is not an unlimited
1073          * IO group
1074          */
1075         spin_lock_irq(q->queue_lock);
1076         tg = throtl_lookup_create_tg(td, blkcg);
1077         if (unlikely(!tg))
1078                 goto out_unlock;
1079
1080         if (tg->nr_queued[rw]) {
1081                 /*
1082                  * There is already another bio queued in same dir. No
1083                  * need to update dispatch time.
1084                  */
1085                 update_disptime = false;
1086                 goto queue_bio;
1087
1088         }
1089
1090         /* Bio is with-in rate limit of group */
1091         if (tg_may_dispatch(tg, bio, NULL)) {
1092                 throtl_charge_bio(tg, bio);
1093
1094                 /*
1095                  * We need to trim slice even when bios are not being queued
1096                  * otherwise it might happen that a bio is not queued for
1097                  * a long time and slice keeps on extending and trim is not
1098                  * called for a long time. Now if limits are reduced suddenly
1099                  * we take into account all the IO dispatched so far at new
1100                  * low rate and * newly queued IO gets a really long dispatch
1101                  * time.
1102                  *
1103                  * So keep on trimming slice even if bio is not queued.
1104                  */
1105                 throtl_trim_slice(tg, rw);
1106                 goto out_unlock;
1107         }
1108
1109 queue_bio:
1110         throtl_log_tg(tg, "[%c] bio. bdisp=%llu sz=%u bps=%llu"
1111                         " iodisp=%u iops=%u queued=%d/%d",
1112                         rw == READ ? 'R' : 'W',
1113                         tg->bytes_disp[rw], bio->bi_size, tg->bps[rw],
1114                         tg->io_disp[rw], tg->iops[rw],
1115                         tg->nr_queued[READ], tg->nr_queued[WRITE]);
1116
1117         bio_associate_current(bio);
1118         throtl_add_bio_tg(bio, tg, &q->td->service_queue);
1119         throttled = true;
1120
1121         if (update_disptime) {
1122                 tg_update_disptime(tg, &td->service_queue);
1123                 throtl_schedule_next_dispatch(td);
1124         }
1125
1126 out_unlock:
1127         spin_unlock_irq(q->queue_lock);
1128 out_unlock_rcu:
1129         rcu_read_unlock();
1130 out:
1131         return throttled;
1132 }
1133
1134 /**
1135  * blk_throtl_drain - drain throttled bios
1136  * @q: request_queue to drain throttled bios for
1137  *
1138  * Dispatch all currently throttled bios on @q through ->make_request_fn().
1139  */
1140 void blk_throtl_drain(struct request_queue *q)
1141         __releases(q->queue_lock) __acquires(q->queue_lock)
1142 {
1143         struct throtl_data *td = q->td;
1144         struct throtl_service_queue *parent_sq = &td->service_queue;
1145         struct throtl_grp *tg;
1146         struct bio_list bl;
1147         struct bio *bio;
1148
1149         queue_lockdep_assert_held(q);
1150
1151         bio_list_init(&bl);
1152
1153         while ((tg = throtl_rb_first(parent_sq))) {
1154                 throtl_dequeue_tg(tg, parent_sq);
1155
1156                 while ((bio = bio_list_peek(&tg->bio_lists[READ])))
1157                         tg_dispatch_one_bio(tg, bio_data_dir(bio), &bl);
1158                 while ((bio = bio_list_peek(&tg->bio_lists[WRITE])))
1159                         tg_dispatch_one_bio(tg, bio_data_dir(bio), &bl);
1160         }
1161         spin_unlock_irq(q->queue_lock);
1162
1163         while ((bio = bio_list_pop(&bl)))
1164                 generic_make_request(bio);
1165
1166         spin_lock_irq(q->queue_lock);
1167 }
1168
1169 int blk_throtl_init(struct request_queue *q)
1170 {
1171         struct throtl_data *td;
1172         int ret;
1173
1174         td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
1175         if (!td)
1176                 return -ENOMEM;
1177
1178         INIT_DELAYED_WORK(&td->dispatch_work, blk_throtl_dispatch_work_fn);
1179         throtl_service_queue_init(&td->service_queue);
1180
1181         q->td = td;
1182         td->queue = q;
1183
1184         /* activate policy */
1185         ret = blkcg_activate_policy(q, &blkcg_policy_throtl);
1186         if (ret)
1187                 kfree(td);
1188         return ret;
1189 }
1190
1191 void blk_throtl_exit(struct request_queue *q)
1192 {
1193         BUG_ON(!q->td);
1194         throtl_shutdown_wq(q);
1195         blkcg_deactivate_policy(q, &blkcg_policy_throtl);
1196         kfree(q->td);
1197 }
1198
1199 static int __init throtl_init(void)
1200 {
1201         kthrotld_workqueue = alloc_workqueue("kthrotld", WQ_MEM_RECLAIM, 0);
1202         if (!kthrotld_workqueue)
1203                 panic("Failed to create kthrotld\n");
1204
1205         return blkcg_policy_register(&blkcg_policy_throtl);
1206 }
1207
1208 module_init(throtl_init);