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