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