blob: f03e158ee1977544f89476ee5634ba0a46bc582b [file] [log] [blame]
Vivek Goyale43473b2010-09-15 17:06:35 -04001/*
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>
Tejun Heoeea8f412015-05-22 17:13:17 -040012#include <linux/blk-cgroup.h>
Tejun Heobc9fcbf2011-10-19 14:31:18 +020013#include "blk.h"
Vivek Goyale43473b2010-09-15 17:06:35 -040014
15/* Max dispatch from a group in 1 round */
16static int throtl_grp_quantum = 8;
17
18/* Total max dispatch from all groups in one round */
19static int throtl_quantum = 32;
20
Shaohua Lid61fcfa2017-03-27 10:51:38 -070021/* Throttling is performed over a slice and after that slice is renewed */
22#define DFL_THROTL_SLICE_HD (HZ / 10)
23#define DFL_THROTL_SLICE_SSD (HZ / 50)
Shaohua Li297e3d82017-03-27 10:51:37 -070024#define MAX_THROTL_SLICE (HZ)
Shaohua Li9e234ee2017-03-27 10:51:41 -070025#define DFL_IDLE_THRESHOLD_SSD (1000L) /* 1 ms */
26#define DFL_IDLE_THRESHOLD_HD (100L * 1000) /* 100 ms */
27#define MAX_IDLE_TIME (5L * 1000 * 1000) /* 5 s */
Vivek Goyale43473b2010-09-15 17:06:35 -040028
Tejun Heo3c798392012-04-16 13:57:25 -070029static struct blkcg_policy blkcg_policy_throtl;
Tejun Heo03814112012-03-05 13:15:14 -080030
Vivek Goyal450adcb2011-03-01 13:40:54 -050031/* A workqueue to queue throttle related work */
32static struct workqueue_struct *kthrotld_workqueue;
Vivek Goyal450adcb2011-03-01 13:40:54 -050033
Tejun Heoc5cc2072013-05-14 13:52:38 -070034/*
35 * To implement hierarchical throttling, throtl_grps form a tree and bios
36 * are dispatched upwards level by level until they reach the top and get
37 * issued. When dispatching bios from the children and local group at each
38 * level, if the bios are dispatched into a single bio_list, there's a risk
39 * of a local or child group which can queue many bios at once filling up
40 * the list starving others.
41 *
42 * To avoid such starvation, dispatched bios are queued separately
43 * according to where they came from. When they are again dispatched to
44 * the parent, they're popped in round-robin order so that no single source
45 * hogs the dispatch window.
46 *
47 * throtl_qnode is used to keep the queued bios separated by their sources.
48 * Bios are queued to throtl_qnode which in turn is queued to
49 * throtl_service_queue and then dispatched in round-robin order.
50 *
51 * It's also used to track the reference counts on blkg's. A qnode always
52 * belongs to a throtl_grp and gets queued on itself or the parent, so
53 * incrementing the reference of the associated throtl_grp when a qnode is
54 * queued and decrementing when dequeued is enough to keep the whole blkg
55 * tree pinned while bios are in flight.
56 */
57struct throtl_qnode {
58 struct list_head node; /* service_queue->queued[] */
59 struct bio_list bios; /* queued bios */
60 struct throtl_grp *tg; /* tg this qnode belongs to */
61};
62
Tejun Heoc9e03322013-05-14 13:52:32 -070063struct throtl_service_queue {
Tejun Heo77216b02013-05-14 13:52:36 -070064 struct throtl_service_queue *parent_sq; /* the parent service_queue */
65
Tejun Heo73f0d492013-05-14 13:52:35 -070066 /*
67 * Bios queued directly to this service_queue or dispatched from
68 * children throtl_grp's.
69 */
Tejun Heoc5cc2072013-05-14 13:52:38 -070070 struct list_head queued[2]; /* throtl_qnode [READ/WRITE] */
Tejun Heo73f0d492013-05-14 13:52:35 -070071 unsigned int nr_queued[2]; /* number of queued bios */
72
73 /*
74 * RB tree of active children throtl_grp's, which are sorted by
75 * their ->disptime.
76 */
Tejun Heoc9e03322013-05-14 13:52:32 -070077 struct rb_root pending_tree; /* RB tree of active tgs */
78 struct rb_node *first_pending; /* first node in the tree */
79 unsigned int nr_pending; /* # queued in the tree */
80 unsigned long first_pending_disptime; /* disptime of the first tg */
Tejun Heo69df0ab2013-05-14 13:52:36 -070081 struct timer_list pending_timer; /* fires on first_pending_disptime */
Vivek Goyale43473b2010-09-15 17:06:35 -040082};
83
Tejun Heo5b2c16a2013-05-14 13:52:32 -070084enum tg_state_flags {
85 THROTL_TG_PENDING = 1 << 0, /* on parent's pending tree */
Tejun Heo0e9f4162013-05-14 13:52:35 -070086 THROTL_TG_WAS_EMPTY = 1 << 1, /* bio_lists[] became non-empty */
Tejun Heo5b2c16a2013-05-14 13:52:32 -070087};
88
Vivek Goyale43473b2010-09-15 17:06:35 -040089#define rb_entry_tg(node) rb_entry((node), struct throtl_grp, rb_node)
90
Shaohua Li9f626e32017-03-27 10:51:30 -070091enum {
Shaohua Licd5ab1b2017-03-27 10:51:32 -070092 LIMIT_LOW,
Shaohua Li9f626e32017-03-27 10:51:30 -070093 LIMIT_MAX,
94 LIMIT_CNT,
95};
96
Vivek Goyale43473b2010-09-15 17:06:35 -040097struct throtl_grp {
Tejun Heof95a04a2012-04-16 13:57:26 -070098 /* must be the first member */
99 struct blkg_policy_data pd;
100
Tejun Heoc9e03322013-05-14 13:52:32 -0700101 /* active throtl group service_queue member */
Vivek Goyale43473b2010-09-15 17:06:35 -0400102 struct rb_node rb_node;
103
Tejun Heo0f3457f2013-05-14 13:52:32 -0700104 /* throtl_data this group belongs to */
105 struct throtl_data *td;
106
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700107 /* this group's service queue */
108 struct throtl_service_queue service_queue;
109
Vivek Goyale43473b2010-09-15 17:06:35 -0400110 /*
Tejun Heoc5cc2072013-05-14 13:52:38 -0700111 * qnode_on_self is used when bios are directly queued to this
112 * throtl_grp so that local bios compete fairly with bios
113 * dispatched from children. qnode_on_parent is used when bios are
114 * dispatched from this throtl_grp into its parent and will compete
115 * with the sibling qnode_on_parents and the parent's
116 * qnode_on_self.
117 */
118 struct throtl_qnode qnode_on_self[2];
119 struct throtl_qnode qnode_on_parent[2];
120
121 /*
Vivek Goyale43473b2010-09-15 17:06:35 -0400122 * Dispatch time in jiffies. This is the estimated time when group
123 * will unthrottle and is ready to dispatch more bio. It is used as
124 * key to sort active groups in service tree.
125 */
126 unsigned long disptime;
127
Vivek Goyale43473b2010-09-15 17:06:35 -0400128 unsigned int flags;
129
Tejun Heo693e7512013-05-14 13:52:38 -0700130 /* are there any throtl rules between this group and td? */
131 bool has_rules[2];
132
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700133 /* internally used bytes per second rate limits */
Shaohua Li9f626e32017-03-27 10:51:30 -0700134 uint64_t bps[2][LIMIT_CNT];
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700135 /* user configured bps limits */
136 uint64_t bps_conf[2][LIMIT_CNT];
Vivek Goyale43473b2010-09-15 17:06:35 -0400137
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700138 /* internally used IOPS limits */
Shaohua Li9f626e32017-03-27 10:51:30 -0700139 unsigned int iops[2][LIMIT_CNT];
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700140 /* user configured IOPS limits */
141 unsigned int iops_conf[2][LIMIT_CNT];
Vivek Goyal8e89d132010-09-15 17:06:37 -0400142
Vivek Goyale43473b2010-09-15 17:06:35 -0400143 /* Number of bytes disptached in current slice */
144 uint64_t bytes_disp[2];
Vivek Goyal8e89d132010-09-15 17:06:37 -0400145 /* Number of bio's dispatched in current slice */
146 unsigned int io_disp[2];
Vivek Goyale43473b2010-09-15 17:06:35 -0400147
Shaohua Li3f0abd82017-03-27 10:51:35 -0700148 unsigned long last_low_overflow_time[2];
149
150 uint64_t last_bytes_disp[2];
151 unsigned int last_io_disp[2];
152
153 unsigned long last_check_time;
154
Shaohua Liaec24242017-03-27 10:51:39 -0700155 unsigned long last_dispatch_time[2];
156
Vivek Goyale43473b2010-09-15 17:06:35 -0400157 /* When did we start a new slice */
158 unsigned long slice_start[2];
159 unsigned long slice_end[2];
Shaohua Li9e234ee2017-03-27 10:51:41 -0700160
161 unsigned long last_finish_time; /* ns / 1024 */
162 unsigned long checked_last_finish_time; /* ns / 1024 */
163 unsigned long avg_idletime; /* ns / 1024 */
164 unsigned long idletime_threshold; /* us */
Vivek Goyale43473b2010-09-15 17:06:35 -0400165};
166
167struct throtl_data
168{
Vivek Goyale43473b2010-09-15 17:06:35 -0400169 /* service tree for active throtl groups */
Tejun Heoc9e03322013-05-14 13:52:32 -0700170 struct throtl_service_queue service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -0400171
Vivek Goyale43473b2010-09-15 17:06:35 -0400172 struct request_queue *queue;
173
174 /* Total Number of queued bios on READ and WRITE lists */
175 unsigned int nr_queued[2];
176
Shaohua Li297e3d82017-03-27 10:51:37 -0700177 unsigned int throtl_slice;
178
Vivek Goyale43473b2010-09-15 17:06:35 -0400179 /* Work for dispatching throttled bios */
Tejun Heo69df0ab2013-05-14 13:52:36 -0700180 struct work_struct dispatch_work;
Shaohua Li9f626e32017-03-27 10:51:30 -0700181 unsigned int limit_index;
182 bool limit_valid[LIMIT_CNT];
Shaohua Li3f0abd82017-03-27 10:51:35 -0700183
Shaohua Liada75b62017-03-27 10:51:42 -0700184 unsigned long dft_idletime_threshold; /* us */
185
Shaohua Li3f0abd82017-03-27 10:51:35 -0700186 unsigned long low_upgrade_time;
187 unsigned long low_downgrade_time;
Shaohua Li7394e312017-03-27 10:51:40 -0700188
189 unsigned int scale;
Vivek Goyale43473b2010-09-15 17:06:35 -0400190};
191
Tejun Heo69df0ab2013-05-14 13:52:36 -0700192static void throtl_pending_timer_fn(unsigned long arg);
193
Tejun Heof95a04a2012-04-16 13:57:26 -0700194static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
195{
196 return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
197}
198
Tejun Heo3c798392012-04-16 13:57:25 -0700199static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
Tejun Heo03814112012-03-05 13:15:14 -0800200{
Tejun Heof95a04a2012-04-16 13:57:26 -0700201 return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
Tejun Heo03814112012-03-05 13:15:14 -0800202}
203
Tejun Heo3c798392012-04-16 13:57:25 -0700204static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
Tejun Heo03814112012-03-05 13:15:14 -0800205{
Tejun Heof95a04a2012-04-16 13:57:26 -0700206 return pd_to_blkg(&tg->pd);
Tejun Heo03814112012-03-05 13:15:14 -0800207}
208
Tejun Heofda6f272013-05-14 13:52:36 -0700209/**
210 * sq_to_tg - return the throl_grp the specified service queue belongs to
211 * @sq: the throtl_service_queue of interest
212 *
213 * Return the throtl_grp @sq belongs to. If @sq is the top-level one
214 * embedded in throtl_data, %NULL is returned.
215 */
216static struct throtl_grp *sq_to_tg(struct throtl_service_queue *sq)
217{
218 if (sq && sq->parent_sq)
219 return container_of(sq, struct throtl_grp, service_queue);
220 else
221 return NULL;
222}
Vivek Goyale43473b2010-09-15 17:06:35 -0400223
Tejun Heofda6f272013-05-14 13:52:36 -0700224/**
225 * sq_to_td - return throtl_data the specified service queue belongs to
226 * @sq: the throtl_service_queue of interest
227 *
Masahiro Yamadab43daed2017-02-27 14:29:09 -0800228 * A service_queue can be embedded in either a throtl_grp or throtl_data.
Tejun Heofda6f272013-05-14 13:52:36 -0700229 * Determine the associated throtl_data accordingly and return it.
230 */
231static struct throtl_data *sq_to_td(struct throtl_service_queue *sq)
232{
233 struct throtl_grp *tg = sq_to_tg(sq);
234
235 if (tg)
236 return tg->td;
237 else
238 return container_of(sq, struct throtl_data, service_queue);
239}
240
Shaohua Li7394e312017-03-27 10:51:40 -0700241/*
242 * cgroup's limit in LIMIT_MAX is scaled if low limit is set. This scale is to
243 * make the IO dispatch more smooth.
244 * Scale up: linearly scale up according to lapsed time since upgrade. For
245 * every throtl_slice, the limit scales up 1/2 .low limit till the
246 * limit hits .max limit
247 * Scale down: exponentially scale down if a cgroup doesn't hit its .low limit
248 */
249static uint64_t throtl_adjusted_limit(uint64_t low, struct throtl_data *td)
250{
251 /* arbitrary value to avoid too big scale */
252 if (td->scale < 4096 && time_after_eq(jiffies,
253 td->low_upgrade_time + td->scale * td->throtl_slice))
254 td->scale = (jiffies - td->low_upgrade_time) / td->throtl_slice;
255
256 return low + (low >> 1) * td->scale;
257}
258
Shaohua Li9f626e32017-03-27 10:51:30 -0700259static uint64_t tg_bps_limit(struct throtl_grp *tg, int rw)
260{
Shaohua Lib22c4172017-03-27 10:51:33 -0700261 struct blkcg_gq *blkg = tg_to_blkg(tg);
Shaohua Li7394e312017-03-27 10:51:40 -0700262 struct throtl_data *td;
Shaohua Lib22c4172017-03-27 10:51:33 -0700263 uint64_t ret;
264
265 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && !blkg->parent)
266 return U64_MAX;
Shaohua Li7394e312017-03-27 10:51:40 -0700267
268 td = tg->td;
269 ret = tg->bps[rw][td->limit_index];
270 if (ret == 0 && td->limit_index == LIMIT_LOW)
Shaohua Lib22c4172017-03-27 10:51:33 -0700271 return tg->bps[rw][LIMIT_MAX];
Shaohua Li7394e312017-03-27 10:51:40 -0700272
273 if (td->limit_index == LIMIT_MAX && tg->bps[rw][LIMIT_LOW] &&
274 tg->bps[rw][LIMIT_LOW] != tg->bps[rw][LIMIT_MAX]) {
275 uint64_t adjusted;
276
277 adjusted = throtl_adjusted_limit(tg->bps[rw][LIMIT_LOW], td);
278 ret = min(tg->bps[rw][LIMIT_MAX], adjusted);
279 }
Shaohua Lib22c4172017-03-27 10:51:33 -0700280 return ret;
Shaohua Li9f626e32017-03-27 10:51:30 -0700281}
282
283static unsigned int tg_iops_limit(struct throtl_grp *tg, int rw)
284{
Shaohua Lib22c4172017-03-27 10:51:33 -0700285 struct blkcg_gq *blkg = tg_to_blkg(tg);
Shaohua Li7394e312017-03-27 10:51:40 -0700286 struct throtl_data *td;
Shaohua Lib22c4172017-03-27 10:51:33 -0700287 unsigned int ret;
288
289 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && !blkg->parent)
290 return UINT_MAX;
Shaohua Li7394e312017-03-27 10:51:40 -0700291 td = tg->td;
292 ret = tg->iops[rw][td->limit_index];
Shaohua Lib22c4172017-03-27 10:51:33 -0700293 if (ret == 0 && tg->td->limit_index == LIMIT_LOW)
294 return tg->iops[rw][LIMIT_MAX];
Shaohua Li7394e312017-03-27 10:51:40 -0700295
296 if (td->limit_index == LIMIT_MAX && tg->iops[rw][LIMIT_LOW] &&
297 tg->iops[rw][LIMIT_LOW] != tg->iops[rw][LIMIT_MAX]) {
298 uint64_t adjusted;
299
300 adjusted = throtl_adjusted_limit(tg->iops[rw][LIMIT_LOW], td);
301 if (adjusted > UINT_MAX)
302 adjusted = UINT_MAX;
303 ret = min_t(unsigned int, tg->iops[rw][LIMIT_MAX], adjusted);
304 }
Shaohua Lib22c4172017-03-27 10:51:33 -0700305 return ret;
Shaohua Li9f626e32017-03-27 10:51:30 -0700306}
307
Tejun Heofda6f272013-05-14 13:52:36 -0700308/**
309 * throtl_log - log debug message via blktrace
310 * @sq: the service_queue being reported
311 * @fmt: printf format string
312 * @args: printf args
313 *
314 * The messages are prefixed with "throtl BLKG_NAME" if @sq belongs to a
315 * throtl_grp; otherwise, just "throtl".
Tejun Heofda6f272013-05-14 13:52:36 -0700316 */
317#define throtl_log(sq, fmt, args...) do { \
318 struct throtl_grp *__tg = sq_to_tg((sq)); \
319 struct throtl_data *__td = sq_to_td((sq)); \
320 \
321 (void)__td; \
Shaohua Li59fa0222016-05-09 17:22:15 -0700322 if (likely(!blk_trace_note_message_enabled(__td->queue))) \
323 break; \
Tejun Heofda6f272013-05-14 13:52:36 -0700324 if ((__tg)) { \
325 char __pbuf[128]; \
326 \
327 blkg_path(tg_to_blkg(__tg), __pbuf, sizeof(__pbuf)); \
328 blk_add_trace_msg(__td->queue, "throtl %s " fmt, __pbuf, ##args); \
329 } else { \
330 blk_add_trace_msg(__td->queue, "throtl " fmt, ##args); \
331 } \
332} while (0)
Vivek Goyale43473b2010-09-15 17:06:35 -0400333
Tejun Heoc5cc2072013-05-14 13:52:38 -0700334static void throtl_qnode_init(struct throtl_qnode *qn, struct throtl_grp *tg)
335{
336 INIT_LIST_HEAD(&qn->node);
337 bio_list_init(&qn->bios);
338 qn->tg = tg;
339}
340
341/**
342 * throtl_qnode_add_bio - add a bio to a throtl_qnode and activate it
343 * @bio: bio being added
344 * @qn: qnode to add bio to
345 * @queued: the service_queue->queued[] list @qn belongs to
346 *
347 * Add @bio to @qn and put @qn on @queued if it's not already on.
348 * @qn->tg's reference count is bumped when @qn is activated. See the
349 * comment on top of throtl_qnode definition for details.
350 */
351static void throtl_qnode_add_bio(struct bio *bio, struct throtl_qnode *qn,
352 struct list_head *queued)
353{
354 bio_list_add(&qn->bios, bio);
355 if (list_empty(&qn->node)) {
356 list_add_tail(&qn->node, queued);
357 blkg_get(tg_to_blkg(qn->tg));
358 }
359}
360
361/**
362 * throtl_peek_queued - peek the first bio on a qnode list
363 * @queued: the qnode list to peek
364 */
365static struct bio *throtl_peek_queued(struct list_head *queued)
366{
367 struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
368 struct bio *bio;
369
370 if (list_empty(queued))
371 return NULL;
372
373 bio = bio_list_peek(&qn->bios);
374 WARN_ON_ONCE(!bio);
375 return bio;
376}
377
378/**
379 * throtl_pop_queued - pop the first bio form a qnode list
380 * @queued: the qnode list to pop a bio from
381 * @tg_to_put: optional out argument for throtl_grp to put
382 *
383 * Pop the first bio from the qnode list @queued. After popping, the first
384 * qnode is removed from @queued if empty or moved to the end of @queued so
385 * that the popping order is round-robin.
386 *
387 * When the first qnode is removed, its associated throtl_grp should be put
388 * too. If @tg_to_put is NULL, this function automatically puts it;
389 * otherwise, *@tg_to_put is set to the throtl_grp to put and the caller is
390 * responsible for putting it.
391 */
392static struct bio *throtl_pop_queued(struct list_head *queued,
393 struct throtl_grp **tg_to_put)
394{
395 struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
396 struct bio *bio;
397
398 if (list_empty(queued))
399 return NULL;
400
401 bio = bio_list_pop(&qn->bios);
402 WARN_ON_ONCE(!bio);
403
404 if (bio_list_empty(&qn->bios)) {
405 list_del_init(&qn->node);
406 if (tg_to_put)
407 *tg_to_put = qn->tg;
408 else
409 blkg_put(tg_to_blkg(qn->tg));
410 } else {
411 list_move_tail(&qn->node, queued);
412 }
413
414 return bio;
415}
416
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700417/* init a service_queue, assumes the caller zeroed it */
Tejun Heob2ce2642015-08-18 14:55:13 -0700418static void throtl_service_queue_init(struct throtl_service_queue *sq)
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700419{
Tejun Heoc5cc2072013-05-14 13:52:38 -0700420 INIT_LIST_HEAD(&sq->queued[0]);
421 INIT_LIST_HEAD(&sq->queued[1]);
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700422 sq->pending_tree = RB_ROOT;
Tejun Heo69df0ab2013-05-14 13:52:36 -0700423 setup_timer(&sq->pending_timer, throtl_pending_timer_fn,
424 (unsigned long)sq);
425}
426
Tejun Heo001bea72015-08-18 14:55:11 -0700427static struct blkg_policy_data *throtl_pd_alloc(gfp_t gfp, int node)
428{
Tejun Heo4fb72032015-08-18 14:55:12 -0700429 struct throtl_grp *tg;
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700430 int rw;
Tejun Heo4fb72032015-08-18 14:55:12 -0700431
432 tg = kzalloc_node(sizeof(*tg), gfp, node);
433 if (!tg)
Tejun Heo77ea7332015-08-18 14:55:24 -0700434 return NULL;
Tejun Heo4fb72032015-08-18 14:55:12 -0700435
Tejun Heob2ce2642015-08-18 14:55:13 -0700436 throtl_service_queue_init(&tg->service_queue);
437
438 for (rw = READ; rw <= WRITE; rw++) {
439 throtl_qnode_init(&tg->qnode_on_self[rw], tg);
440 throtl_qnode_init(&tg->qnode_on_parent[rw], tg);
441 }
442
443 RB_CLEAR_NODE(&tg->rb_node);
Shaohua Li9f626e32017-03-27 10:51:30 -0700444 tg->bps[READ][LIMIT_MAX] = U64_MAX;
445 tg->bps[WRITE][LIMIT_MAX] = U64_MAX;
446 tg->iops[READ][LIMIT_MAX] = UINT_MAX;
447 tg->iops[WRITE][LIMIT_MAX] = UINT_MAX;
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700448 tg->bps_conf[READ][LIMIT_MAX] = U64_MAX;
449 tg->bps_conf[WRITE][LIMIT_MAX] = U64_MAX;
450 tg->iops_conf[READ][LIMIT_MAX] = UINT_MAX;
451 tg->iops_conf[WRITE][LIMIT_MAX] = UINT_MAX;
452 /* LIMIT_LOW will have default value 0 */
Tejun Heob2ce2642015-08-18 14:55:13 -0700453
Tejun Heo4fb72032015-08-18 14:55:12 -0700454 return &tg->pd;
Tejun Heo001bea72015-08-18 14:55:11 -0700455}
456
Tejun Heoa9520cd2015-08-18 14:55:14 -0700457static void throtl_pd_init(struct blkg_policy_data *pd)
Vivek Goyala29a1712011-05-19 15:38:19 -0400458{
Tejun Heoa9520cd2015-08-18 14:55:14 -0700459 struct throtl_grp *tg = pd_to_tg(pd);
460 struct blkcg_gq *blkg = tg_to_blkg(tg);
Tejun Heo77216b02013-05-14 13:52:36 -0700461 struct throtl_data *td = blkg->q->td;
Tejun Heob2ce2642015-08-18 14:55:13 -0700462 struct throtl_service_queue *sq = &tg->service_queue;
Tejun Heocd1604f2012-03-05 13:15:06 -0800463
Tejun Heo91381252013-05-14 13:52:38 -0700464 /*
Tejun Heoaa6ec292014-07-09 10:08:08 -0400465 * If on the default hierarchy, we switch to properly hierarchical
Tejun Heo91381252013-05-14 13:52:38 -0700466 * behavior where limits on a given throtl_grp are applied to the
467 * whole subtree rather than just the group itself. e.g. If 16M
468 * read_bps limit is set on the root group, the whole system can't
469 * exceed 16M for the device.
470 *
Tejun Heoaa6ec292014-07-09 10:08:08 -0400471 * If not on the default hierarchy, the broken flat hierarchy
Tejun Heo91381252013-05-14 13:52:38 -0700472 * behavior is retained where all throtl_grps are treated as if
473 * they're all separate root groups right below throtl_data.
474 * Limits of a group don't interact with limits of other groups
475 * regardless of the position of the group in the hierarchy.
476 */
Tejun Heob2ce2642015-08-18 14:55:13 -0700477 sq->parent_sq = &td->service_queue;
Tejun Heo9e10a132015-09-18 11:56:28 -0400478 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && blkg->parent)
Tejun Heob2ce2642015-08-18 14:55:13 -0700479 sq->parent_sq = &blkg_to_tg(blkg->parent)->service_queue;
Tejun Heo77216b02013-05-14 13:52:36 -0700480 tg->td = td;
Shaohua Li9e234ee2017-03-27 10:51:41 -0700481
Shaohua Liada75b62017-03-27 10:51:42 -0700482 tg->idletime_threshold = td->dft_idletime_threshold;
Tejun Heo8a3d2612012-04-01 14:38:44 -0700483}
484
Tejun Heo693e7512013-05-14 13:52:38 -0700485/*
486 * Set has_rules[] if @tg or any of its parents have limits configured.
487 * This doesn't require walking up to the top of the hierarchy as the
488 * parent's has_rules[] is guaranteed to be correct.
489 */
490static void tg_update_has_rules(struct throtl_grp *tg)
491{
492 struct throtl_grp *parent_tg = sq_to_tg(tg->service_queue.parent_sq);
Shaohua Li9f626e32017-03-27 10:51:30 -0700493 struct throtl_data *td = tg->td;
Tejun Heo693e7512013-05-14 13:52:38 -0700494 int rw;
495
496 for (rw = READ; rw <= WRITE; rw++)
497 tg->has_rules[rw] = (parent_tg && parent_tg->has_rules[rw]) ||
Shaohua Li9f626e32017-03-27 10:51:30 -0700498 (td->limit_valid[td->limit_index] &&
499 (tg_bps_limit(tg, rw) != U64_MAX ||
500 tg_iops_limit(tg, rw) != UINT_MAX));
Tejun Heo693e7512013-05-14 13:52:38 -0700501}
502
Tejun Heoa9520cd2015-08-18 14:55:14 -0700503static void throtl_pd_online(struct blkg_policy_data *pd)
Tejun Heo693e7512013-05-14 13:52:38 -0700504{
Shaohua Liaec24242017-03-27 10:51:39 -0700505 struct throtl_grp *tg = pd_to_tg(pd);
Tejun Heo693e7512013-05-14 13:52:38 -0700506 /*
507 * We don't want new groups to escape the limits of its ancestors.
508 * Update has_rules[] after a new group is brought online.
509 */
Shaohua Liaec24242017-03-27 10:51:39 -0700510 tg_update_has_rules(tg);
511 tg->last_dispatch_time[READ] = jiffies;
512 tg->last_dispatch_time[WRITE] = jiffies;
Tejun Heo693e7512013-05-14 13:52:38 -0700513}
514
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700515static void blk_throtl_update_limit_valid(struct throtl_data *td)
516{
517 struct cgroup_subsys_state *pos_css;
518 struct blkcg_gq *blkg;
519 bool low_valid = false;
520
521 rcu_read_lock();
522 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
523 struct throtl_grp *tg = blkg_to_tg(blkg);
524
525 if (tg->bps[READ][LIMIT_LOW] || tg->bps[WRITE][LIMIT_LOW] ||
526 tg->iops[READ][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW])
527 low_valid = true;
528 }
529 rcu_read_unlock();
530
531 td->limit_valid[LIMIT_LOW] = low_valid;
532}
533
Shaohua Lic79892c2017-03-27 10:51:34 -0700534static void throtl_upgrade_state(struct throtl_data *td);
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700535static void throtl_pd_offline(struct blkg_policy_data *pd)
536{
537 struct throtl_grp *tg = pd_to_tg(pd);
538
539 tg->bps[READ][LIMIT_LOW] = 0;
540 tg->bps[WRITE][LIMIT_LOW] = 0;
541 tg->iops[READ][LIMIT_LOW] = 0;
542 tg->iops[WRITE][LIMIT_LOW] = 0;
543
544 blk_throtl_update_limit_valid(tg->td);
545
Shaohua Lic79892c2017-03-27 10:51:34 -0700546 if (!tg->td->limit_valid[tg->td->limit_index])
547 throtl_upgrade_state(tg->td);
Shaohua Licd5ab1b2017-03-27 10:51:32 -0700548}
549
Tejun Heo001bea72015-08-18 14:55:11 -0700550static void throtl_pd_free(struct blkg_policy_data *pd)
551{
Tejun Heo4fb72032015-08-18 14:55:12 -0700552 struct throtl_grp *tg = pd_to_tg(pd);
553
Tejun Heob2ce2642015-08-18 14:55:13 -0700554 del_timer_sync(&tg->service_queue.pending_timer);
Tejun Heo4fb72032015-08-18 14:55:12 -0700555 kfree(tg);
Tejun Heo001bea72015-08-18 14:55:11 -0700556}
557
Tejun Heo0049af72013-05-14 13:52:33 -0700558static struct throtl_grp *
559throtl_rb_first(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400560{
561 /* Service tree is empty */
Tejun Heo0049af72013-05-14 13:52:33 -0700562 if (!parent_sq->nr_pending)
Vivek Goyale43473b2010-09-15 17:06:35 -0400563 return NULL;
564
Tejun Heo0049af72013-05-14 13:52:33 -0700565 if (!parent_sq->first_pending)
566 parent_sq->first_pending = rb_first(&parent_sq->pending_tree);
Vivek Goyale43473b2010-09-15 17:06:35 -0400567
Tejun Heo0049af72013-05-14 13:52:33 -0700568 if (parent_sq->first_pending)
569 return rb_entry_tg(parent_sq->first_pending);
Vivek Goyale43473b2010-09-15 17:06:35 -0400570
571 return NULL;
572}
573
574static void rb_erase_init(struct rb_node *n, struct rb_root *root)
575{
576 rb_erase(n, root);
577 RB_CLEAR_NODE(n);
578}
579
Tejun Heo0049af72013-05-14 13:52:33 -0700580static void throtl_rb_erase(struct rb_node *n,
581 struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400582{
Tejun Heo0049af72013-05-14 13:52:33 -0700583 if (parent_sq->first_pending == n)
584 parent_sq->first_pending = NULL;
585 rb_erase_init(n, &parent_sq->pending_tree);
586 --parent_sq->nr_pending;
Vivek Goyale43473b2010-09-15 17:06:35 -0400587}
588
Tejun Heo0049af72013-05-14 13:52:33 -0700589static void update_min_dispatch_time(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400590{
591 struct throtl_grp *tg;
592
Tejun Heo0049af72013-05-14 13:52:33 -0700593 tg = throtl_rb_first(parent_sq);
Vivek Goyale43473b2010-09-15 17:06:35 -0400594 if (!tg)
595 return;
596
Tejun Heo0049af72013-05-14 13:52:33 -0700597 parent_sq->first_pending_disptime = tg->disptime;
Vivek Goyale43473b2010-09-15 17:06:35 -0400598}
599
Tejun Heo77216b02013-05-14 13:52:36 -0700600static void tg_service_queue_add(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400601{
Tejun Heo77216b02013-05-14 13:52:36 -0700602 struct throtl_service_queue *parent_sq = tg->service_queue.parent_sq;
Tejun Heo0049af72013-05-14 13:52:33 -0700603 struct rb_node **node = &parent_sq->pending_tree.rb_node;
Vivek Goyale43473b2010-09-15 17:06:35 -0400604 struct rb_node *parent = NULL;
605 struct throtl_grp *__tg;
606 unsigned long key = tg->disptime;
607 int left = 1;
608
609 while (*node != NULL) {
610 parent = *node;
611 __tg = rb_entry_tg(parent);
612
613 if (time_before(key, __tg->disptime))
614 node = &parent->rb_left;
615 else {
616 node = &parent->rb_right;
617 left = 0;
618 }
619 }
620
621 if (left)
Tejun Heo0049af72013-05-14 13:52:33 -0700622 parent_sq->first_pending = &tg->rb_node;
Vivek Goyale43473b2010-09-15 17:06:35 -0400623
624 rb_link_node(&tg->rb_node, parent, node);
Tejun Heo0049af72013-05-14 13:52:33 -0700625 rb_insert_color(&tg->rb_node, &parent_sq->pending_tree);
Vivek Goyale43473b2010-09-15 17:06:35 -0400626}
627
Tejun Heo77216b02013-05-14 13:52:36 -0700628static void __throtl_enqueue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400629{
Tejun Heo77216b02013-05-14 13:52:36 -0700630 tg_service_queue_add(tg);
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700631 tg->flags |= THROTL_TG_PENDING;
Tejun Heo77216b02013-05-14 13:52:36 -0700632 tg->service_queue.parent_sq->nr_pending++;
Vivek Goyale43473b2010-09-15 17:06:35 -0400633}
634
Tejun Heo77216b02013-05-14 13:52:36 -0700635static void throtl_enqueue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400636{
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700637 if (!(tg->flags & THROTL_TG_PENDING))
Tejun Heo77216b02013-05-14 13:52:36 -0700638 __throtl_enqueue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400639}
640
Tejun Heo77216b02013-05-14 13:52:36 -0700641static void __throtl_dequeue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400642{
Tejun Heo77216b02013-05-14 13:52:36 -0700643 throtl_rb_erase(&tg->rb_node, tg->service_queue.parent_sq);
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700644 tg->flags &= ~THROTL_TG_PENDING;
Vivek Goyale43473b2010-09-15 17:06:35 -0400645}
646
Tejun Heo77216b02013-05-14 13:52:36 -0700647static void throtl_dequeue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400648{
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700649 if (tg->flags & THROTL_TG_PENDING)
Tejun Heo77216b02013-05-14 13:52:36 -0700650 __throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400651}
652
Tejun Heoa9131a22013-05-14 13:52:31 -0700653/* Call with queue lock held */
Tejun Heo69df0ab2013-05-14 13:52:36 -0700654static void throtl_schedule_pending_timer(struct throtl_service_queue *sq,
655 unsigned long expires)
Tejun Heoa9131a22013-05-14 13:52:31 -0700656{
Shaohua Li297e3d82017-03-27 10:51:37 -0700657 unsigned long max_expire = jiffies + 8 * sq_to_tg(sq)->td->throtl_slice;
Shaohua Li06cceed2017-03-27 10:51:36 -0700658
659 /*
660 * Since we are adjusting the throttle limit dynamically, the sleep
661 * time calculated according to previous limit might be invalid. It's
662 * possible the cgroup sleep time is very long and no other cgroups
663 * have IO running so notify the limit changes. Make sure the cgroup
664 * doesn't sleep too long to avoid the missed notification.
665 */
666 if (time_after(expires, max_expire))
667 expires = max_expire;
Tejun Heo69df0ab2013-05-14 13:52:36 -0700668 mod_timer(&sq->pending_timer, expires);
669 throtl_log(sq, "schedule timer. delay=%lu jiffies=%lu",
670 expires - jiffies, jiffies);
Tejun Heoa9131a22013-05-14 13:52:31 -0700671}
672
Tejun Heo7f52f982013-05-14 13:52:37 -0700673/**
674 * throtl_schedule_next_dispatch - schedule the next dispatch cycle
675 * @sq: the service_queue to schedule dispatch for
676 * @force: force scheduling
677 *
678 * Arm @sq->pending_timer so that the next dispatch cycle starts on the
679 * dispatch time of the first pending child. Returns %true if either timer
680 * is armed or there's no pending child left. %false if the current
681 * dispatch window is still open and the caller should continue
682 * dispatching.
683 *
684 * If @force is %true, the dispatch timer is always scheduled and this
685 * function is guaranteed to return %true. This is to be used when the
686 * caller can't dispatch itself and needs to invoke pending_timer
687 * unconditionally. Note that forced scheduling is likely to induce short
688 * delay before dispatch starts even if @sq->first_pending_disptime is not
689 * in the future and thus shouldn't be used in hot paths.
690 */
691static bool throtl_schedule_next_dispatch(struct throtl_service_queue *sq,
692 bool force)
Vivek Goyale43473b2010-09-15 17:06:35 -0400693{
Tejun Heo6a525602013-05-14 13:52:32 -0700694 /* any pending children left? */
Tejun Heoc9e03322013-05-14 13:52:32 -0700695 if (!sq->nr_pending)
Tejun Heo7f52f982013-05-14 13:52:37 -0700696 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400697
Tejun Heoc9e03322013-05-14 13:52:32 -0700698 update_min_dispatch_time(sq);
Vivek Goyale43473b2010-09-15 17:06:35 -0400699
Tejun Heo69df0ab2013-05-14 13:52:36 -0700700 /* is the next dispatch time in the future? */
Tejun Heo7f52f982013-05-14 13:52:37 -0700701 if (force || time_after(sq->first_pending_disptime, jiffies)) {
Tejun Heo69df0ab2013-05-14 13:52:36 -0700702 throtl_schedule_pending_timer(sq, sq->first_pending_disptime);
Tejun Heo7f52f982013-05-14 13:52:37 -0700703 return true;
Tejun Heo69df0ab2013-05-14 13:52:36 -0700704 }
705
Tejun Heo7f52f982013-05-14 13:52:37 -0700706 /* tell the caller to continue dispatching */
707 return false;
Vivek Goyale43473b2010-09-15 17:06:35 -0400708}
709
Vivek Goyal32ee5bc2013-05-14 13:52:38 -0700710static inline void throtl_start_new_slice_with_credit(struct throtl_grp *tg,
711 bool rw, unsigned long start)
712{
713 tg->bytes_disp[rw] = 0;
714 tg->io_disp[rw] = 0;
715
716 /*
717 * Previous slice has expired. We must have trimmed it after last
718 * bio dispatch. That means since start of last slice, we never used
719 * that bandwidth. Do try to make use of that bandwidth while giving
720 * credit.
721 */
722 if (time_after_eq(start, tg->slice_start[rw]))
723 tg->slice_start[rw] = start;
724
Shaohua Li297e3d82017-03-27 10:51:37 -0700725 tg->slice_end[rw] = jiffies + tg->td->throtl_slice;
Vivek Goyal32ee5bc2013-05-14 13:52:38 -0700726 throtl_log(&tg->service_queue,
727 "[%c] new slice with credit start=%lu end=%lu jiffies=%lu",
728 rw == READ ? 'R' : 'W', tg->slice_start[rw],
729 tg->slice_end[rw], jiffies);
730}
731
Tejun Heo0f3457f2013-05-14 13:52:32 -0700732static inline void throtl_start_new_slice(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400733{
734 tg->bytes_disp[rw] = 0;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400735 tg->io_disp[rw] = 0;
Vivek Goyale43473b2010-09-15 17:06:35 -0400736 tg->slice_start[rw] = jiffies;
Shaohua Li297e3d82017-03-27 10:51:37 -0700737 tg->slice_end[rw] = jiffies + tg->td->throtl_slice;
Tejun Heofda6f272013-05-14 13:52:36 -0700738 throtl_log(&tg->service_queue,
739 "[%c] new slice start=%lu end=%lu jiffies=%lu",
740 rw == READ ? 'R' : 'W', tg->slice_start[rw],
741 tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400742}
743
Tejun Heo0f3457f2013-05-14 13:52:32 -0700744static inline void throtl_set_slice_end(struct throtl_grp *tg, bool rw,
745 unsigned long jiffy_end)
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100746{
Shaohua Li297e3d82017-03-27 10:51:37 -0700747 tg->slice_end[rw] = roundup(jiffy_end, tg->td->throtl_slice);
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100748}
749
Tejun Heo0f3457f2013-05-14 13:52:32 -0700750static inline void throtl_extend_slice(struct throtl_grp *tg, bool rw,
751 unsigned long jiffy_end)
Vivek Goyale43473b2010-09-15 17:06:35 -0400752{
Shaohua Li297e3d82017-03-27 10:51:37 -0700753 tg->slice_end[rw] = roundup(jiffy_end, tg->td->throtl_slice);
Tejun Heofda6f272013-05-14 13:52:36 -0700754 throtl_log(&tg->service_queue,
755 "[%c] extend slice start=%lu end=%lu jiffies=%lu",
756 rw == READ ? 'R' : 'W', tg->slice_start[rw],
757 tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400758}
759
760/* Determine if previously allocated or extended slice is complete or not */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700761static bool throtl_slice_used(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400762{
763 if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200764 return false;
Vivek Goyale43473b2010-09-15 17:06:35 -0400765
766 return 1;
767}
768
769/* Trim the used slices and adjust slice start accordingly */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700770static inline void throtl_trim_slice(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400771{
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200772 unsigned long nr_slices, time_elapsed, io_trim;
773 u64 bytes_trim, tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400774
775 BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
776
777 /*
778 * If bps are unlimited (-1), then time slice don't get
779 * renewed. Don't try to trim the slice if slice is used. A new
780 * slice will start when appropriate.
781 */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700782 if (throtl_slice_used(tg, rw))
Vivek Goyale43473b2010-09-15 17:06:35 -0400783 return;
784
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100785 /*
786 * A bio has been dispatched. Also adjust slice_end. It might happen
787 * that initially cgroup limit was very low resulting in high
788 * slice_end, but later limit was bumped up and bio was dispached
789 * sooner, then we need to reduce slice_end. A high bogus slice_end
790 * is bad because it does not allow new slice to start.
791 */
792
Shaohua Li297e3d82017-03-27 10:51:37 -0700793 throtl_set_slice_end(tg, rw, jiffies + tg->td->throtl_slice);
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100794
Vivek Goyale43473b2010-09-15 17:06:35 -0400795 time_elapsed = jiffies - tg->slice_start[rw];
796
Shaohua Li297e3d82017-03-27 10:51:37 -0700797 nr_slices = time_elapsed / tg->td->throtl_slice;
Vivek Goyale43473b2010-09-15 17:06:35 -0400798
799 if (!nr_slices)
800 return;
Shaohua Li297e3d82017-03-27 10:51:37 -0700801 tmp = tg_bps_limit(tg, rw) * tg->td->throtl_slice * nr_slices;
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200802 do_div(tmp, HZ);
803 bytes_trim = tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400804
Shaohua Li297e3d82017-03-27 10:51:37 -0700805 io_trim = (tg_iops_limit(tg, rw) * tg->td->throtl_slice * nr_slices) /
806 HZ;
Vivek Goyale43473b2010-09-15 17:06:35 -0400807
Vivek Goyal8e89d132010-09-15 17:06:37 -0400808 if (!bytes_trim && !io_trim)
Vivek Goyale43473b2010-09-15 17:06:35 -0400809 return;
810
811 if (tg->bytes_disp[rw] >= bytes_trim)
812 tg->bytes_disp[rw] -= bytes_trim;
813 else
814 tg->bytes_disp[rw] = 0;
815
Vivek Goyal8e89d132010-09-15 17:06:37 -0400816 if (tg->io_disp[rw] >= io_trim)
817 tg->io_disp[rw] -= io_trim;
818 else
819 tg->io_disp[rw] = 0;
820
Shaohua Li297e3d82017-03-27 10:51:37 -0700821 tg->slice_start[rw] += nr_slices * tg->td->throtl_slice;
Vivek Goyale43473b2010-09-15 17:06:35 -0400822
Tejun Heofda6f272013-05-14 13:52:36 -0700823 throtl_log(&tg->service_queue,
824 "[%c] trim slice nr=%lu bytes=%llu io=%lu start=%lu end=%lu jiffies=%lu",
825 rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
826 tg->slice_start[rw], tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400827}
828
Tejun Heo0f3457f2013-05-14 13:52:32 -0700829static bool tg_with_in_iops_limit(struct throtl_grp *tg, struct bio *bio,
830 unsigned long *wait)
Vivek Goyale43473b2010-09-15 17:06:35 -0400831{
832 bool rw = bio_data_dir(bio);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400833 unsigned int io_allowed;
Vivek Goyale43473b2010-09-15 17:06:35 -0400834 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
Vivek Goyalc49c06e2010-10-01 21:16:42 +0200835 u64 tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400836
Vivek Goyal8e89d132010-09-15 17:06:37 -0400837 jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
Vivek Goyale43473b2010-09-15 17:06:35 -0400838
Vivek Goyal8e89d132010-09-15 17:06:37 -0400839 /* Slice has just started. Consider one slice interval */
840 if (!jiffy_elapsed)
Shaohua Li297e3d82017-03-27 10:51:37 -0700841 jiffy_elapsed_rnd = tg->td->throtl_slice;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400842
Shaohua Li297e3d82017-03-27 10:51:37 -0700843 jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, tg->td->throtl_slice);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400844
Vivek Goyalc49c06e2010-10-01 21:16:42 +0200845 /*
846 * jiffy_elapsed_rnd should not be a big value as minimum iops can be
847 * 1 then at max jiffy elapsed should be equivalent of 1 second as we
848 * will allow dispatch after 1 second and after that slice should
849 * have been trimmed.
850 */
851
Shaohua Li9f626e32017-03-27 10:51:30 -0700852 tmp = (u64)tg_iops_limit(tg, rw) * jiffy_elapsed_rnd;
Vivek Goyalc49c06e2010-10-01 21:16:42 +0200853 do_div(tmp, HZ);
854
855 if (tmp > UINT_MAX)
856 io_allowed = UINT_MAX;
857 else
858 io_allowed = tmp;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400859
860 if (tg->io_disp[rw] + 1 <= io_allowed) {
Vivek Goyale43473b2010-09-15 17:06:35 -0400861 if (wait)
862 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200863 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400864 }
865
Vivek Goyal8e89d132010-09-15 17:06:37 -0400866 /* Calc approx time to dispatch */
Shaohua Li9f626e32017-03-27 10:51:30 -0700867 jiffy_wait = ((tg->io_disp[rw] + 1) * HZ) / tg_iops_limit(tg, rw) + 1;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400868
869 if (jiffy_wait > jiffy_elapsed)
870 jiffy_wait = jiffy_wait - jiffy_elapsed;
871 else
872 jiffy_wait = 1;
873
874 if (wait)
875 *wait = jiffy_wait;
876 return 0;
877}
878
Tejun Heo0f3457f2013-05-14 13:52:32 -0700879static bool tg_with_in_bps_limit(struct throtl_grp *tg, struct bio *bio,
880 unsigned long *wait)
Vivek Goyal8e89d132010-09-15 17:06:37 -0400881{
882 bool rw = bio_data_dir(bio);
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200883 u64 bytes_allowed, extra_bytes, tmp;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400884 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
Vivek Goyale43473b2010-09-15 17:06:35 -0400885
886 jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
887
888 /* Slice has just started. Consider one slice interval */
889 if (!jiffy_elapsed)
Shaohua Li297e3d82017-03-27 10:51:37 -0700890 jiffy_elapsed_rnd = tg->td->throtl_slice;
Vivek Goyale43473b2010-09-15 17:06:35 -0400891
Shaohua Li297e3d82017-03-27 10:51:37 -0700892 jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, tg->td->throtl_slice);
Vivek Goyale43473b2010-09-15 17:06:35 -0400893
Shaohua Li9f626e32017-03-27 10:51:30 -0700894 tmp = tg_bps_limit(tg, rw) * jiffy_elapsed_rnd;
Vivek Goyal5e901a22010-10-01 21:16:38 +0200895 do_div(tmp, HZ);
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200896 bytes_allowed = tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400897
Kent Overstreet4f024f32013-10-11 15:44:27 -0700898 if (tg->bytes_disp[rw] + bio->bi_iter.bi_size <= bytes_allowed) {
Vivek Goyale43473b2010-09-15 17:06:35 -0400899 if (wait)
900 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200901 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400902 }
903
904 /* Calc approx time to dispatch */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700905 extra_bytes = tg->bytes_disp[rw] + bio->bi_iter.bi_size - bytes_allowed;
Shaohua Li9f626e32017-03-27 10:51:30 -0700906 jiffy_wait = div64_u64(extra_bytes * HZ, tg_bps_limit(tg, rw));
Vivek Goyale43473b2010-09-15 17:06:35 -0400907
908 if (!jiffy_wait)
909 jiffy_wait = 1;
910
911 /*
912 * This wait time is without taking into consideration the rounding
913 * up we did. Add that time also.
914 */
915 jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
Vivek Goyale43473b2010-09-15 17:06:35 -0400916 if (wait)
917 *wait = jiffy_wait;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400918 return 0;
919}
Vivek Goyale43473b2010-09-15 17:06:35 -0400920
Vivek Goyal8e89d132010-09-15 17:06:37 -0400921/*
922 * Returns whether one can dispatch a bio or not. Also returns approx number
923 * of jiffies to wait before this bio is with-in IO rate and can be dispatched
924 */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700925static bool tg_may_dispatch(struct throtl_grp *tg, struct bio *bio,
926 unsigned long *wait)
Vivek Goyal8e89d132010-09-15 17:06:37 -0400927{
928 bool rw = bio_data_dir(bio);
929 unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
930
931 /*
932 * Currently whole state machine of group depends on first bio
933 * queued in the group bio list. So one should not be calling
934 * this function with a different bio if there are other bios
935 * queued.
936 */
Tejun Heo73f0d492013-05-14 13:52:35 -0700937 BUG_ON(tg->service_queue.nr_queued[rw] &&
Tejun Heoc5cc2072013-05-14 13:52:38 -0700938 bio != throtl_peek_queued(&tg->service_queue.queued[rw]));
Vivek Goyal8e89d132010-09-15 17:06:37 -0400939
940 /* If tg->bps = -1, then BW is unlimited */
Shaohua Li9f626e32017-03-27 10:51:30 -0700941 if (tg_bps_limit(tg, rw) == U64_MAX &&
942 tg_iops_limit(tg, rw) == UINT_MAX) {
Vivek Goyal8e89d132010-09-15 17:06:37 -0400943 if (wait)
944 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200945 return true;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400946 }
947
948 /*
949 * If previous slice expired, start a new one otherwise renew/extend
950 * existing slice to make sure it is at least throtl_slice interval
Vivek Goyal164c80e2016-09-19 15:12:41 -0600951 * long since now. New slice is started only for empty throttle group.
952 * If there is queued bio, that means there should be an active
953 * slice and it should be extended instead.
Vivek Goyal8e89d132010-09-15 17:06:37 -0400954 */
Vivek Goyal164c80e2016-09-19 15:12:41 -0600955 if (throtl_slice_used(tg, rw) && !(tg->service_queue.nr_queued[rw]))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700956 throtl_start_new_slice(tg, rw);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400957 else {
Shaohua Li297e3d82017-03-27 10:51:37 -0700958 if (time_before(tg->slice_end[rw],
959 jiffies + tg->td->throtl_slice))
960 throtl_extend_slice(tg, rw,
961 jiffies + tg->td->throtl_slice);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400962 }
963
Tejun Heo0f3457f2013-05-14 13:52:32 -0700964 if (tg_with_in_bps_limit(tg, bio, &bps_wait) &&
965 tg_with_in_iops_limit(tg, bio, &iops_wait)) {
Vivek Goyal8e89d132010-09-15 17:06:37 -0400966 if (wait)
967 *wait = 0;
968 return 1;
969 }
970
971 max_wait = max(bps_wait, iops_wait);
972
973 if (wait)
974 *wait = max_wait;
975
976 if (time_before(tg->slice_end[rw], jiffies + max_wait))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700977 throtl_extend_slice(tg, rw, jiffies + max_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -0400978
979 return 0;
980}
981
982static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
983{
984 bool rw = bio_data_dir(bio);
Vivek Goyale43473b2010-09-15 17:06:35 -0400985
986 /* Charge the bio to the group */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700987 tg->bytes_disp[rw] += bio->bi_iter.bi_size;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400988 tg->io_disp[rw]++;
Shaohua Li3f0abd82017-03-27 10:51:35 -0700989 tg->last_bytes_disp[rw] += bio->bi_iter.bi_size;
990 tg->last_io_disp[rw]++;
Vivek Goyale43473b2010-09-15 17:06:35 -0400991
Tejun Heo2a0f61e2013-05-14 13:52:36 -0700992 /*
Christoph Hellwig8d2bbd42016-10-20 15:12:12 +0200993 * BIO_THROTTLED is used to prevent the same bio to be throttled
Tejun Heo2a0f61e2013-05-14 13:52:36 -0700994 * more than once as a throttled bio will go through blk-throtl the
995 * second time when it eventually gets issued. Set it when a bio
996 * is being charged to a tg.
Tejun Heo2a0f61e2013-05-14 13:52:36 -0700997 */
Christoph Hellwig8d2bbd42016-10-20 15:12:12 +0200998 if (!bio_flagged(bio, BIO_THROTTLED))
999 bio_set_flag(bio, BIO_THROTTLED);
Vivek Goyale43473b2010-09-15 17:06:35 -04001000}
1001
Tejun Heoc5cc2072013-05-14 13:52:38 -07001002/**
1003 * throtl_add_bio_tg - add a bio to the specified throtl_grp
1004 * @bio: bio to add
1005 * @qn: qnode to use
1006 * @tg: the target throtl_grp
1007 *
1008 * Add @bio to @tg's service_queue using @qn. If @qn is not specified,
1009 * tg->qnode_on_self[] is used.
1010 */
1011static void throtl_add_bio_tg(struct bio *bio, struct throtl_qnode *qn,
1012 struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -04001013{
Tejun Heo73f0d492013-05-14 13:52:35 -07001014 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -04001015 bool rw = bio_data_dir(bio);
1016
Tejun Heoc5cc2072013-05-14 13:52:38 -07001017 if (!qn)
1018 qn = &tg->qnode_on_self[rw];
1019
Tejun Heo0e9f4162013-05-14 13:52:35 -07001020 /*
1021 * If @tg doesn't currently have any bios queued in the same
1022 * direction, queueing @bio can change when @tg should be
1023 * dispatched. Mark that @tg was empty. This is automatically
1024 * cleaered on the next tg_update_disptime().
1025 */
1026 if (!sq->nr_queued[rw])
1027 tg->flags |= THROTL_TG_WAS_EMPTY;
1028
Tejun Heoc5cc2072013-05-14 13:52:38 -07001029 throtl_qnode_add_bio(bio, qn, &sq->queued[rw]);
1030
Tejun Heo73f0d492013-05-14 13:52:35 -07001031 sq->nr_queued[rw]++;
Tejun Heo77216b02013-05-14 13:52:36 -07001032 throtl_enqueue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001033}
1034
Tejun Heo77216b02013-05-14 13:52:36 -07001035static void tg_update_disptime(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -04001036{
Tejun Heo73f0d492013-05-14 13:52:35 -07001037 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -04001038 unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
1039 struct bio *bio;
1040
Markus Elfringd609af32017-01-21 22:15:33 +01001041 bio = throtl_peek_queued(&sq->queued[READ]);
1042 if (bio)
Tejun Heo0f3457f2013-05-14 13:52:32 -07001043 tg_may_dispatch(tg, bio, &read_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -04001044
Markus Elfringd609af32017-01-21 22:15:33 +01001045 bio = throtl_peek_queued(&sq->queued[WRITE]);
1046 if (bio)
Tejun Heo0f3457f2013-05-14 13:52:32 -07001047 tg_may_dispatch(tg, bio, &write_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -04001048
1049 min_wait = min(read_wait, write_wait);
1050 disptime = jiffies + min_wait;
1051
Vivek Goyale43473b2010-09-15 17:06:35 -04001052 /* Update dispatch time */
Tejun Heo77216b02013-05-14 13:52:36 -07001053 throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001054 tg->disptime = disptime;
Tejun Heo77216b02013-05-14 13:52:36 -07001055 throtl_enqueue_tg(tg);
Tejun Heo0e9f4162013-05-14 13:52:35 -07001056
1057 /* see throtl_add_bio_tg() */
1058 tg->flags &= ~THROTL_TG_WAS_EMPTY;
Vivek Goyale43473b2010-09-15 17:06:35 -04001059}
1060
Vivek Goyal32ee5bc2013-05-14 13:52:38 -07001061static void start_parent_slice_with_credit(struct throtl_grp *child_tg,
1062 struct throtl_grp *parent_tg, bool rw)
1063{
1064 if (throtl_slice_used(parent_tg, rw)) {
1065 throtl_start_new_slice_with_credit(parent_tg, rw,
1066 child_tg->slice_start[rw]);
1067 }
1068
1069}
1070
Tejun Heo77216b02013-05-14 13:52:36 -07001071static void tg_dispatch_one_bio(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -04001072{
Tejun Heo73f0d492013-05-14 13:52:35 -07001073 struct throtl_service_queue *sq = &tg->service_queue;
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001074 struct throtl_service_queue *parent_sq = sq->parent_sq;
1075 struct throtl_grp *parent_tg = sq_to_tg(parent_sq);
Tejun Heoc5cc2072013-05-14 13:52:38 -07001076 struct throtl_grp *tg_to_put = NULL;
Vivek Goyale43473b2010-09-15 17:06:35 -04001077 struct bio *bio;
1078
Tejun Heoc5cc2072013-05-14 13:52:38 -07001079 /*
1080 * @bio is being transferred from @tg to @parent_sq. Popping a bio
1081 * from @tg may put its reference and @parent_sq might end up
1082 * getting released prematurely. Remember the tg to put and put it
1083 * after @bio is transferred to @parent_sq.
1084 */
1085 bio = throtl_pop_queued(&sq->queued[rw], &tg_to_put);
Tejun Heo73f0d492013-05-14 13:52:35 -07001086 sq->nr_queued[rw]--;
Vivek Goyale43473b2010-09-15 17:06:35 -04001087
1088 throtl_charge_bio(tg, bio);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001089
1090 /*
1091 * If our parent is another tg, we just need to transfer @bio to
1092 * the parent using throtl_add_bio_tg(). If our parent is
1093 * @td->service_queue, @bio is ready to be issued. Put it on its
1094 * bio_lists[] and decrease total number queued. The caller is
1095 * responsible for issuing these bios.
1096 */
1097 if (parent_tg) {
Tejun Heoc5cc2072013-05-14 13:52:38 -07001098 throtl_add_bio_tg(bio, &tg->qnode_on_parent[rw], parent_tg);
Vivek Goyal32ee5bc2013-05-14 13:52:38 -07001099 start_parent_slice_with_credit(tg, parent_tg, rw);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001100 } else {
Tejun Heoc5cc2072013-05-14 13:52:38 -07001101 throtl_qnode_add_bio(bio, &tg->qnode_on_parent[rw],
1102 &parent_sq->queued[rw]);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001103 BUG_ON(tg->td->nr_queued[rw] <= 0);
1104 tg->td->nr_queued[rw]--;
1105 }
Vivek Goyale43473b2010-09-15 17:06:35 -04001106
Tejun Heo0f3457f2013-05-14 13:52:32 -07001107 throtl_trim_slice(tg, rw);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001108
Tejun Heoc5cc2072013-05-14 13:52:38 -07001109 if (tg_to_put)
1110 blkg_put(tg_to_blkg(tg_to_put));
Vivek Goyale43473b2010-09-15 17:06:35 -04001111}
1112
Tejun Heo77216b02013-05-14 13:52:36 -07001113static int throtl_dispatch_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -04001114{
Tejun Heo73f0d492013-05-14 13:52:35 -07001115 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -04001116 unsigned int nr_reads = 0, nr_writes = 0;
1117 unsigned int max_nr_reads = throtl_grp_quantum*3/4;
Vivek Goyalc2f68052010-11-15 19:32:42 +01001118 unsigned int max_nr_writes = throtl_grp_quantum - max_nr_reads;
Vivek Goyale43473b2010-09-15 17:06:35 -04001119 struct bio *bio;
1120
1121 /* Try to dispatch 75% READS and 25% WRITES */
1122
Tejun Heoc5cc2072013-05-14 13:52:38 -07001123 while ((bio = throtl_peek_queued(&sq->queued[READ])) &&
Tejun Heo0f3457f2013-05-14 13:52:32 -07001124 tg_may_dispatch(tg, bio, NULL)) {
Vivek Goyale43473b2010-09-15 17:06:35 -04001125
Tejun Heo77216b02013-05-14 13:52:36 -07001126 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Vivek Goyale43473b2010-09-15 17:06:35 -04001127 nr_reads++;
1128
1129 if (nr_reads >= max_nr_reads)
1130 break;
1131 }
1132
Tejun Heoc5cc2072013-05-14 13:52:38 -07001133 while ((bio = throtl_peek_queued(&sq->queued[WRITE])) &&
Tejun Heo0f3457f2013-05-14 13:52:32 -07001134 tg_may_dispatch(tg, bio, NULL)) {
Vivek Goyale43473b2010-09-15 17:06:35 -04001135
Tejun Heo77216b02013-05-14 13:52:36 -07001136 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Vivek Goyale43473b2010-09-15 17:06:35 -04001137 nr_writes++;
1138
1139 if (nr_writes >= max_nr_writes)
1140 break;
1141 }
1142
1143 return nr_reads + nr_writes;
1144}
1145
Tejun Heo651930b2013-05-14 13:52:35 -07001146static int throtl_select_dispatch(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -04001147{
1148 unsigned int nr_disp = 0;
Vivek Goyale43473b2010-09-15 17:06:35 -04001149
1150 while (1) {
Tejun Heo73f0d492013-05-14 13:52:35 -07001151 struct throtl_grp *tg = throtl_rb_first(parent_sq);
1152 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -04001153
1154 if (!tg)
1155 break;
1156
1157 if (time_before(jiffies, tg->disptime))
1158 break;
1159
Tejun Heo77216b02013-05-14 13:52:36 -07001160 throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001161
Tejun Heo77216b02013-05-14 13:52:36 -07001162 nr_disp += throtl_dispatch_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001163
Tejun Heo73f0d492013-05-14 13:52:35 -07001164 if (sq->nr_queued[0] || sq->nr_queued[1])
Tejun Heo77216b02013-05-14 13:52:36 -07001165 tg_update_disptime(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001166
1167 if (nr_disp >= throtl_quantum)
1168 break;
1169 }
1170
1171 return nr_disp;
1172}
1173
Shaohua Lic79892c2017-03-27 10:51:34 -07001174static bool throtl_can_upgrade(struct throtl_data *td,
1175 struct throtl_grp *this_tg);
Tejun Heo6e1a5702013-05-14 13:52:37 -07001176/**
1177 * throtl_pending_timer_fn - timer function for service_queue->pending_timer
1178 * @arg: the throtl_service_queue being serviced
1179 *
1180 * This timer is armed when a child throtl_grp with active bio's become
1181 * pending and queued on the service_queue's pending_tree and expires when
1182 * the first child throtl_grp should be dispatched. This function
Tejun Heo2e48a532013-05-14 13:52:38 -07001183 * dispatches bio's from the children throtl_grps to the parent
1184 * service_queue.
1185 *
1186 * If the parent's parent is another throtl_grp, dispatching is propagated
1187 * by either arming its pending_timer or repeating dispatch directly. If
1188 * the top-level service_tree is reached, throtl_data->dispatch_work is
1189 * kicked so that the ready bio's are issued.
Tejun Heo6e1a5702013-05-14 13:52:37 -07001190 */
Tejun Heo69df0ab2013-05-14 13:52:36 -07001191static void throtl_pending_timer_fn(unsigned long arg)
1192{
1193 struct throtl_service_queue *sq = (void *)arg;
Tejun Heo2e48a532013-05-14 13:52:38 -07001194 struct throtl_grp *tg = sq_to_tg(sq);
Tejun Heo69df0ab2013-05-14 13:52:36 -07001195 struct throtl_data *td = sq_to_td(sq);
Tejun Heocb761992013-05-14 13:52:31 -07001196 struct request_queue *q = td->queue;
Tejun Heo2e48a532013-05-14 13:52:38 -07001197 struct throtl_service_queue *parent_sq;
1198 bool dispatched;
Tejun Heo6e1a5702013-05-14 13:52:37 -07001199 int ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04001200
1201 spin_lock_irq(q->queue_lock);
Shaohua Lic79892c2017-03-27 10:51:34 -07001202 if (throtl_can_upgrade(td, NULL))
1203 throtl_upgrade_state(td);
1204
Tejun Heo2e48a532013-05-14 13:52:38 -07001205again:
1206 parent_sq = sq->parent_sq;
1207 dispatched = false;
Vivek Goyale43473b2010-09-15 17:06:35 -04001208
Tejun Heo7f52f982013-05-14 13:52:37 -07001209 while (true) {
1210 throtl_log(sq, "dispatch nr_queued=%u read=%u write=%u",
Tejun Heo2e48a532013-05-14 13:52:38 -07001211 sq->nr_queued[READ] + sq->nr_queued[WRITE],
1212 sq->nr_queued[READ], sq->nr_queued[WRITE]);
Vivek Goyale43473b2010-09-15 17:06:35 -04001213
Tejun Heo7f52f982013-05-14 13:52:37 -07001214 ret = throtl_select_dispatch(sq);
1215 if (ret) {
Tejun Heo7f52f982013-05-14 13:52:37 -07001216 throtl_log(sq, "bios disp=%u", ret);
1217 dispatched = true;
Tejun Heo651930b2013-05-14 13:52:35 -07001218 }
Vivek Goyale43473b2010-09-15 17:06:35 -04001219
Tejun Heo7f52f982013-05-14 13:52:37 -07001220 if (throtl_schedule_next_dispatch(sq, false))
1221 break;
1222
1223 /* this dispatch windows is still open, relax and repeat */
1224 spin_unlock_irq(q->queue_lock);
1225 cpu_relax();
1226 spin_lock_irq(q->queue_lock);
1227 }
Tejun Heo6a525602013-05-14 13:52:32 -07001228
Tejun Heo2e48a532013-05-14 13:52:38 -07001229 if (!dispatched)
1230 goto out_unlock;
Tejun Heo6e1a5702013-05-14 13:52:37 -07001231
Tejun Heo2e48a532013-05-14 13:52:38 -07001232 if (parent_sq) {
1233 /* @parent_sq is another throl_grp, propagate dispatch */
1234 if (tg->flags & THROTL_TG_WAS_EMPTY) {
1235 tg_update_disptime(tg);
1236 if (!throtl_schedule_next_dispatch(parent_sq, false)) {
1237 /* window is already open, repeat dispatching */
1238 sq = parent_sq;
1239 tg = sq_to_tg(sq);
1240 goto again;
1241 }
1242 }
1243 } else {
1244 /* reached the top-level, queue issueing */
1245 queue_work(kthrotld_workqueue, &td->dispatch_work);
1246 }
1247out_unlock:
Tejun Heo6e1a5702013-05-14 13:52:37 -07001248 spin_unlock_irq(q->queue_lock);
1249}
1250
1251/**
1252 * blk_throtl_dispatch_work_fn - work function for throtl_data->dispatch_work
1253 * @work: work item being executed
1254 *
1255 * This function is queued for execution when bio's reach the bio_lists[]
1256 * of throtl_data->service_queue. Those bio's are ready and issued by this
1257 * function.
1258 */
Fabian Frederick8876e142014-04-17 21:41:16 +02001259static void blk_throtl_dispatch_work_fn(struct work_struct *work)
Tejun Heo6e1a5702013-05-14 13:52:37 -07001260{
1261 struct throtl_data *td = container_of(work, struct throtl_data,
1262 dispatch_work);
1263 struct throtl_service_queue *td_sq = &td->service_queue;
1264 struct request_queue *q = td->queue;
1265 struct bio_list bio_list_on_stack;
1266 struct bio *bio;
1267 struct blk_plug plug;
1268 int rw;
1269
1270 bio_list_init(&bio_list_on_stack);
1271
1272 spin_lock_irq(q->queue_lock);
Tejun Heoc5cc2072013-05-14 13:52:38 -07001273 for (rw = READ; rw <= WRITE; rw++)
1274 while ((bio = throtl_pop_queued(&td_sq->queued[rw], NULL)))
1275 bio_list_add(&bio_list_on_stack, bio);
Vivek Goyale43473b2010-09-15 17:06:35 -04001276 spin_unlock_irq(q->queue_lock);
1277
Tejun Heo6e1a5702013-05-14 13:52:37 -07001278 if (!bio_list_empty(&bio_list_on_stack)) {
Vivek Goyal69d60eb2011-03-09 08:27:37 +01001279 blk_start_plug(&plug);
Vivek Goyale43473b2010-09-15 17:06:35 -04001280 while((bio = bio_list_pop(&bio_list_on_stack)))
1281 generic_make_request(bio);
Vivek Goyal69d60eb2011-03-09 08:27:37 +01001282 blk_finish_plug(&plug);
Vivek Goyale43473b2010-09-15 17:06:35 -04001283 }
Vivek Goyale43473b2010-09-15 17:06:35 -04001284}
1285
Tejun Heof95a04a2012-04-16 13:57:26 -07001286static u64 tg_prfill_conf_u64(struct seq_file *sf, struct blkg_policy_data *pd,
1287 int off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001288{
Tejun Heof95a04a2012-04-16 13:57:26 -07001289 struct throtl_grp *tg = pd_to_tg(pd);
1290 u64 v = *(u64 *)((void *)tg + off);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001291
Shaohua Li2ab54922017-03-27 10:51:29 -07001292 if (v == U64_MAX)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001293 return 0;
Tejun Heof95a04a2012-04-16 13:57:26 -07001294 return __blkg_prfill_u64(sf, pd, v);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001295}
1296
Tejun Heof95a04a2012-04-16 13:57:26 -07001297static u64 tg_prfill_conf_uint(struct seq_file *sf, struct blkg_policy_data *pd,
1298 int off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001299{
Tejun Heof95a04a2012-04-16 13:57:26 -07001300 struct throtl_grp *tg = pd_to_tg(pd);
1301 unsigned int v = *(unsigned int *)((void *)tg + off);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001302
Shaohua Li2ab54922017-03-27 10:51:29 -07001303 if (v == UINT_MAX)
Tejun Heoaf133ce2012-04-01 14:38:44 -07001304 return 0;
Tejun Heof95a04a2012-04-16 13:57:26 -07001305 return __blkg_prfill_u64(sf, pd, v);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001306}
1307
Tejun Heo2da8ca82013-12-05 12:28:04 -05001308static int tg_print_conf_u64(struct seq_file *sf, void *v)
Tejun Heoaf133ce2012-04-01 14:38:44 -07001309{
Tejun Heo2da8ca82013-12-05 12:28:04 -05001310 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_u64,
1311 &blkcg_policy_throtl, seq_cft(sf)->private, false);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001312 return 0;
1313}
1314
Tejun Heo2da8ca82013-12-05 12:28:04 -05001315static int tg_print_conf_uint(struct seq_file *sf, void *v)
Vivek Goyale43473b2010-09-15 17:06:35 -04001316{
Tejun Heo2da8ca82013-12-05 12:28:04 -05001317 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_uint,
1318 &blkcg_policy_throtl, seq_cft(sf)->private, false);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001319 return 0;
Vivek Goyale43473b2010-09-15 17:06:35 -04001320}
1321
Tejun Heo69948b02015-08-18 14:55:32 -07001322static void tg_conf_updated(struct throtl_grp *tg)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001323{
Tejun Heo69948b02015-08-18 14:55:32 -07001324 struct throtl_service_queue *sq = &tg->service_queue;
Tejun Heo492eb212013-08-08 20:11:25 -04001325 struct cgroup_subsys_state *pos_css;
Tejun Heo69948b02015-08-18 14:55:32 -07001326 struct blkcg_gq *blkg;
Tejun Heoaf133ce2012-04-01 14:38:44 -07001327
Tejun Heofda6f272013-05-14 13:52:36 -07001328 throtl_log(&tg->service_queue,
1329 "limit change rbps=%llu wbps=%llu riops=%u wiops=%u",
Shaohua Li9f626e32017-03-27 10:51:30 -07001330 tg_bps_limit(tg, READ), tg_bps_limit(tg, WRITE),
1331 tg_iops_limit(tg, READ), tg_iops_limit(tg, WRITE));
Tejun Heo632b4492013-05-14 13:52:31 -07001332
1333 /*
Tejun Heo693e7512013-05-14 13:52:38 -07001334 * Update has_rules[] flags for the updated tg's subtree. A tg is
1335 * considered to have rules if either the tg itself or any of its
1336 * ancestors has rules. This identifies groups without any
1337 * restrictions in the whole hierarchy and allows them to bypass
1338 * blk-throttle.
1339 */
Tejun Heo69948b02015-08-18 14:55:32 -07001340 blkg_for_each_descendant_pre(blkg, pos_css, tg_to_blkg(tg))
Tejun Heo693e7512013-05-14 13:52:38 -07001341 tg_update_has_rules(blkg_to_tg(blkg));
1342
1343 /*
Tejun Heo632b4492013-05-14 13:52:31 -07001344 * We're already holding queue_lock and know @tg is valid. Let's
1345 * apply the new config directly.
1346 *
1347 * Restart the slices for both READ and WRITES. It might happen
1348 * that a group's limit are dropped suddenly and we don't want to
1349 * account recently dispatched IO with new low rate.
1350 */
Tejun Heo0f3457f2013-05-14 13:52:32 -07001351 throtl_start_new_slice(tg, 0);
1352 throtl_start_new_slice(tg, 1);
Tejun Heo632b4492013-05-14 13:52:31 -07001353
Tejun Heo5b2c16a2013-05-14 13:52:32 -07001354 if (tg->flags & THROTL_TG_PENDING) {
Tejun Heo77216b02013-05-14 13:52:36 -07001355 tg_update_disptime(tg);
Tejun Heo7f52f982013-05-14 13:52:37 -07001356 throtl_schedule_next_dispatch(sq->parent_sq, true);
Tejun Heo632b4492013-05-14 13:52:31 -07001357 }
Tejun Heo69948b02015-08-18 14:55:32 -07001358}
Tejun Heo60c2bc22012-04-01 14:38:43 -07001359
Tejun Heo69948b02015-08-18 14:55:32 -07001360static ssize_t tg_set_conf(struct kernfs_open_file *of,
1361 char *buf, size_t nbytes, loff_t off, bool is_u64)
1362{
1363 struct blkcg *blkcg = css_to_blkcg(of_css(of));
1364 struct blkg_conf_ctx ctx;
1365 struct throtl_grp *tg;
1366 int ret;
1367 u64 v;
1368
1369 ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
1370 if (ret)
1371 return ret;
1372
1373 ret = -EINVAL;
1374 if (sscanf(ctx.body, "%llu", &v) != 1)
1375 goto out_finish;
1376 if (!v)
Shaohua Li2ab54922017-03-27 10:51:29 -07001377 v = U64_MAX;
Tejun Heo69948b02015-08-18 14:55:32 -07001378
1379 tg = blkg_to_tg(ctx.blkg);
1380
1381 if (is_u64)
1382 *(u64 *)((void *)tg + of_cft(of)->private) = v;
1383 else
1384 *(unsigned int *)((void *)tg + of_cft(of)->private) = v;
1385
1386 tg_conf_updated(tg);
Tejun Heo36aa9e52015-08-18 14:55:31 -07001387 ret = 0;
1388out_finish:
Tejun Heo60c2bc22012-04-01 14:38:43 -07001389 blkg_conf_finish(&ctx);
Tejun Heo36aa9e52015-08-18 14:55:31 -07001390 return ret ?: nbytes;
Tejun Heo60c2bc22012-04-01 14:38:43 -07001391}
1392
Tejun Heo451af502014-05-13 12:16:21 -04001393static ssize_t tg_set_conf_u64(struct kernfs_open_file *of,
1394 char *buf, size_t nbytes, loff_t off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001395{
Tejun Heo451af502014-05-13 12:16:21 -04001396 return tg_set_conf(of, buf, nbytes, off, true);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001397}
1398
Tejun Heo451af502014-05-13 12:16:21 -04001399static ssize_t tg_set_conf_uint(struct kernfs_open_file *of,
1400 char *buf, size_t nbytes, loff_t off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001401{
Tejun Heo451af502014-05-13 12:16:21 -04001402 return tg_set_conf(of, buf, nbytes, off, false);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001403}
1404
Tejun Heo880f50e2015-08-18 14:55:30 -07001405static struct cftype throtl_legacy_files[] = {
Tejun Heo60c2bc22012-04-01 14:38:43 -07001406 {
1407 .name = "throttle.read_bps_device",
Shaohua Li9f626e32017-03-27 10:51:30 -07001408 .private = offsetof(struct throtl_grp, bps[READ][LIMIT_MAX]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001409 .seq_show = tg_print_conf_u64,
Tejun Heo451af502014-05-13 12:16:21 -04001410 .write = tg_set_conf_u64,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001411 },
1412 {
1413 .name = "throttle.write_bps_device",
Shaohua Li9f626e32017-03-27 10:51:30 -07001414 .private = offsetof(struct throtl_grp, bps[WRITE][LIMIT_MAX]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001415 .seq_show = tg_print_conf_u64,
Tejun Heo451af502014-05-13 12:16:21 -04001416 .write = tg_set_conf_u64,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001417 },
1418 {
1419 .name = "throttle.read_iops_device",
Shaohua Li9f626e32017-03-27 10:51:30 -07001420 .private = offsetof(struct throtl_grp, iops[READ][LIMIT_MAX]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001421 .seq_show = tg_print_conf_uint,
Tejun Heo451af502014-05-13 12:16:21 -04001422 .write = tg_set_conf_uint,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001423 },
1424 {
1425 .name = "throttle.write_iops_device",
Shaohua Li9f626e32017-03-27 10:51:30 -07001426 .private = offsetof(struct throtl_grp, iops[WRITE][LIMIT_MAX]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001427 .seq_show = tg_print_conf_uint,
Tejun Heo451af502014-05-13 12:16:21 -04001428 .write = tg_set_conf_uint,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001429 },
1430 {
1431 .name = "throttle.io_service_bytes",
Tejun Heo77ea7332015-08-18 14:55:24 -07001432 .private = (unsigned long)&blkcg_policy_throtl,
1433 .seq_show = blkg_print_stat_bytes,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001434 },
1435 {
1436 .name = "throttle.io_serviced",
Tejun Heo77ea7332015-08-18 14:55:24 -07001437 .private = (unsigned long)&blkcg_policy_throtl,
1438 .seq_show = blkg_print_stat_ios,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001439 },
1440 { } /* terminate */
1441};
1442
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001443static u64 tg_prfill_limit(struct seq_file *sf, struct blkg_policy_data *pd,
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001444 int off)
1445{
1446 struct throtl_grp *tg = pd_to_tg(pd);
1447 const char *dname = blkg_dev_name(pd->blkg);
1448 char bufs[4][21] = { "max", "max", "max", "max" };
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001449 u64 bps_dft;
1450 unsigned int iops_dft;
Shaohua Liada75b62017-03-27 10:51:42 -07001451 char idle_time[26] = "";
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001452
1453 if (!dname)
1454 return 0;
Shaohua Li9f626e32017-03-27 10:51:30 -07001455
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001456 if (off == LIMIT_LOW) {
1457 bps_dft = 0;
1458 iops_dft = 0;
1459 } else {
1460 bps_dft = U64_MAX;
1461 iops_dft = UINT_MAX;
1462 }
1463
1464 if (tg->bps_conf[READ][off] == bps_dft &&
1465 tg->bps_conf[WRITE][off] == bps_dft &&
1466 tg->iops_conf[READ][off] == iops_dft &&
Shaohua Liada75b62017-03-27 10:51:42 -07001467 tg->iops_conf[WRITE][off] == iops_dft &&
1468 (off != LIMIT_LOW || tg->idletime_threshold ==
1469 tg->td->dft_idletime_threshold))
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001470 return 0;
1471
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001472 if (tg->bps_conf[READ][off] != bps_dft)
Shaohua Li9f626e32017-03-27 10:51:30 -07001473 snprintf(bufs[0], sizeof(bufs[0]), "%llu",
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001474 tg->bps_conf[READ][off]);
1475 if (tg->bps_conf[WRITE][off] != bps_dft)
Shaohua Li9f626e32017-03-27 10:51:30 -07001476 snprintf(bufs[1], sizeof(bufs[1]), "%llu",
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001477 tg->bps_conf[WRITE][off]);
1478 if (tg->iops_conf[READ][off] != iops_dft)
Shaohua Li9f626e32017-03-27 10:51:30 -07001479 snprintf(bufs[2], sizeof(bufs[2]), "%u",
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001480 tg->iops_conf[READ][off]);
1481 if (tg->iops_conf[WRITE][off] != iops_dft)
Shaohua Li9f626e32017-03-27 10:51:30 -07001482 snprintf(bufs[3], sizeof(bufs[3]), "%u",
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001483 tg->iops_conf[WRITE][off]);
Shaohua Liada75b62017-03-27 10:51:42 -07001484 if (off == LIMIT_LOW) {
1485 if (tg->idletime_threshold == ULONG_MAX)
1486 strcpy(idle_time, " idle=max");
1487 else
1488 snprintf(idle_time, sizeof(idle_time), " idle=%lu",
1489 tg->idletime_threshold);
1490 }
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001491
Shaohua Liada75b62017-03-27 10:51:42 -07001492 seq_printf(sf, "%s rbps=%s wbps=%s riops=%s wiops=%s%s\n",
1493 dname, bufs[0], bufs[1], bufs[2], bufs[3], idle_time);
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001494 return 0;
1495}
1496
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001497static int tg_print_limit(struct seq_file *sf, void *v)
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001498{
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001499 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_limit,
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001500 &blkcg_policy_throtl, seq_cft(sf)->private, false);
1501 return 0;
1502}
1503
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001504static ssize_t tg_set_limit(struct kernfs_open_file *of,
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001505 char *buf, size_t nbytes, loff_t off)
1506{
1507 struct blkcg *blkcg = css_to_blkcg(of_css(of));
1508 struct blkg_conf_ctx ctx;
1509 struct throtl_grp *tg;
1510 u64 v[4];
Shaohua Liada75b62017-03-27 10:51:42 -07001511 unsigned long idle_time;
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001512 int ret;
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001513 int index = of_cft(of)->private;
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001514
1515 ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
1516 if (ret)
1517 return ret;
1518
1519 tg = blkg_to_tg(ctx.blkg);
1520
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001521 v[0] = tg->bps_conf[READ][index];
1522 v[1] = tg->bps_conf[WRITE][index];
1523 v[2] = tg->iops_conf[READ][index];
1524 v[3] = tg->iops_conf[WRITE][index];
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001525
Shaohua Liada75b62017-03-27 10:51:42 -07001526 idle_time = tg->idletime_threshold;
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001527 while (true) {
1528 char tok[27]; /* wiops=18446744073709551616 */
1529 char *p;
Shaohua Li2ab54922017-03-27 10:51:29 -07001530 u64 val = U64_MAX;
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001531 int len;
1532
1533 if (sscanf(ctx.body, "%26s%n", tok, &len) != 1)
1534 break;
1535 if (tok[0] == '\0')
1536 break;
1537 ctx.body += len;
1538
1539 ret = -EINVAL;
1540 p = tok;
1541 strsep(&p, "=");
1542 if (!p || (sscanf(p, "%llu", &val) != 1 && strcmp(p, "max")))
1543 goto out_finish;
1544
1545 ret = -ERANGE;
1546 if (!val)
1547 goto out_finish;
1548
1549 ret = -EINVAL;
1550 if (!strcmp(tok, "rbps"))
1551 v[0] = val;
1552 else if (!strcmp(tok, "wbps"))
1553 v[1] = val;
1554 else if (!strcmp(tok, "riops"))
1555 v[2] = min_t(u64, val, UINT_MAX);
1556 else if (!strcmp(tok, "wiops"))
1557 v[3] = min_t(u64, val, UINT_MAX);
Shaohua Liada75b62017-03-27 10:51:42 -07001558 else if (off == LIMIT_LOW && !strcmp(tok, "idle"))
1559 idle_time = val;
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001560 else
1561 goto out_finish;
1562 }
1563
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001564 tg->bps_conf[READ][index] = v[0];
1565 tg->bps_conf[WRITE][index] = v[1];
1566 tg->iops_conf[READ][index] = v[2];
1567 tg->iops_conf[WRITE][index] = v[3];
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001568
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001569 if (index == LIMIT_MAX) {
1570 tg->bps[READ][index] = v[0];
1571 tg->bps[WRITE][index] = v[1];
1572 tg->iops[READ][index] = v[2];
1573 tg->iops[WRITE][index] = v[3];
1574 }
1575 tg->bps[READ][LIMIT_LOW] = min(tg->bps_conf[READ][LIMIT_LOW],
1576 tg->bps_conf[READ][LIMIT_MAX]);
1577 tg->bps[WRITE][LIMIT_LOW] = min(tg->bps_conf[WRITE][LIMIT_LOW],
1578 tg->bps_conf[WRITE][LIMIT_MAX]);
1579 tg->iops[READ][LIMIT_LOW] = min(tg->iops_conf[READ][LIMIT_LOW],
1580 tg->iops_conf[READ][LIMIT_MAX]);
1581 tg->iops[WRITE][LIMIT_LOW] = min(tg->iops_conf[WRITE][LIMIT_LOW],
1582 tg->iops_conf[WRITE][LIMIT_MAX]);
1583
1584 if (index == LIMIT_LOW) {
1585 blk_throtl_update_limit_valid(tg->td);
1586 if (tg->td->limit_valid[LIMIT_LOW])
1587 tg->td->limit_index = LIMIT_LOW;
Shaohua Liada75b62017-03-27 10:51:42 -07001588 tg->idletime_threshold = (idle_time == ULONG_MAX) ?
1589 ULONG_MAX : idle_time;
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001590 }
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001591 tg_conf_updated(tg);
1592 ret = 0;
1593out_finish:
1594 blkg_conf_finish(&ctx);
1595 return ret ?: nbytes;
1596}
1597
1598static struct cftype throtl_files[] = {
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001599#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
1600 {
1601 .name = "low",
1602 .flags = CFTYPE_NOT_ON_ROOT,
1603 .seq_show = tg_print_limit,
1604 .write = tg_set_limit,
1605 .private = LIMIT_LOW,
1606 },
1607#endif
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001608 {
1609 .name = "max",
1610 .flags = CFTYPE_NOT_ON_ROOT,
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001611 .seq_show = tg_print_limit,
1612 .write = tg_set_limit,
1613 .private = LIMIT_MAX,
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001614 },
1615 { } /* terminate */
1616};
1617
Vivek Goyalda527772011-03-02 19:05:33 -05001618static void throtl_shutdown_wq(struct request_queue *q)
Vivek Goyale43473b2010-09-15 17:06:35 -04001619{
1620 struct throtl_data *td = q->td;
1621
Tejun Heo69df0ab2013-05-14 13:52:36 -07001622 cancel_work_sync(&td->dispatch_work);
Vivek Goyale43473b2010-09-15 17:06:35 -04001623}
1624
Tejun Heo3c798392012-04-16 13:57:25 -07001625static struct blkcg_policy blkcg_policy_throtl = {
Tejun Heo2ee867dc2015-08-18 14:55:34 -07001626 .dfl_cftypes = throtl_files,
Tejun Heo880f50e2015-08-18 14:55:30 -07001627 .legacy_cftypes = throtl_legacy_files,
Tejun Heof9fcc2d2012-04-16 13:57:27 -07001628
Tejun Heo001bea72015-08-18 14:55:11 -07001629 .pd_alloc_fn = throtl_pd_alloc,
Tejun Heof9fcc2d2012-04-16 13:57:27 -07001630 .pd_init_fn = throtl_pd_init,
Tejun Heo693e7512013-05-14 13:52:38 -07001631 .pd_online_fn = throtl_pd_online,
Shaohua Licd5ab1b2017-03-27 10:51:32 -07001632 .pd_offline_fn = throtl_pd_offline,
Tejun Heo001bea72015-08-18 14:55:11 -07001633 .pd_free_fn = throtl_pd_free,
Vivek Goyale43473b2010-09-15 17:06:35 -04001634};
1635
Shaohua Li3f0abd82017-03-27 10:51:35 -07001636static unsigned long __tg_last_low_overflow_time(struct throtl_grp *tg)
1637{
1638 unsigned long rtime = jiffies, wtime = jiffies;
1639
1640 if (tg->bps[READ][LIMIT_LOW] || tg->iops[READ][LIMIT_LOW])
1641 rtime = tg->last_low_overflow_time[READ];
1642 if (tg->bps[WRITE][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW])
1643 wtime = tg->last_low_overflow_time[WRITE];
1644 return min(rtime, wtime);
1645}
1646
1647/* tg should not be an intermediate node */
1648static unsigned long tg_last_low_overflow_time(struct throtl_grp *tg)
1649{
1650 struct throtl_service_queue *parent_sq;
1651 struct throtl_grp *parent = tg;
1652 unsigned long ret = __tg_last_low_overflow_time(tg);
1653
1654 while (true) {
1655 parent_sq = parent->service_queue.parent_sq;
1656 parent = sq_to_tg(parent_sq);
1657 if (!parent)
1658 break;
1659
1660 /*
1661 * The parent doesn't have low limit, it always reaches low
1662 * limit. Its overflow time is useless for children
1663 */
1664 if (!parent->bps[READ][LIMIT_LOW] &&
1665 !parent->iops[READ][LIMIT_LOW] &&
1666 !parent->bps[WRITE][LIMIT_LOW] &&
1667 !parent->iops[WRITE][LIMIT_LOW])
1668 continue;
1669 if (time_after(__tg_last_low_overflow_time(parent), ret))
1670 ret = __tg_last_low_overflow_time(parent);
1671 }
1672 return ret;
1673}
1674
Shaohua Li9e234ee2017-03-27 10:51:41 -07001675static bool throtl_tg_is_idle(struct throtl_grp *tg)
1676{
1677 /*
1678 * cgroup is idle if:
1679 * - single idle is too long, longer than a fixed value (in case user
1680 * configure a too big threshold) or 4 times of slice
1681 * - average think time is more than threshold
1682 */
1683 unsigned long time = jiffies_to_usecs(4 * tg->td->throtl_slice);
1684
1685 time = min_t(unsigned long, MAX_IDLE_TIME, time);
1686 return (ktime_get_ns() >> 10) - tg->last_finish_time > time ||
1687 tg->avg_idletime > tg->idletime_threshold;
1688}
1689
Shaohua Lic79892c2017-03-27 10:51:34 -07001690static bool throtl_tg_can_upgrade(struct throtl_grp *tg)
1691{
1692 struct throtl_service_queue *sq = &tg->service_queue;
1693 bool read_limit, write_limit;
1694
1695 /*
1696 * if cgroup reaches low limit (if low limit is 0, the cgroup always
1697 * reaches), it's ok to upgrade to next limit
1698 */
1699 read_limit = tg->bps[READ][LIMIT_LOW] || tg->iops[READ][LIMIT_LOW];
1700 write_limit = tg->bps[WRITE][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW];
1701 if (!read_limit && !write_limit)
1702 return true;
1703 if (read_limit && sq->nr_queued[READ] &&
1704 (!write_limit || sq->nr_queued[WRITE]))
1705 return true;
1706 if (write_limit && sq->nr_queued[WRITE] &&
1707 (!read_limit || sq->nr_queued[READ]))
1708 return true;
Shaohua Liaec24242017-03-27 10:51:39 -07001709
1710 if (time_after_eq(jiffies,
1711 tg->last_dispatch_time[READ] + tg->td->throtl_slice) &&
1712 time_after_eq(jiffies,
1713 tg->last_dispatch_time[WRITE] + tg->td->throtl_slice))
1714 return true;
Shaohua Lic79892c2017-03-27 10:51:34 -07001715 return false;
1716}
1717
1718static bool throtl_hierarchy_can_upgrade(struct throtl_grp *tg)
1719{
1720 while (true) {
1721 if (throtl_tg_can_upgrade(tg))
1722 return true;
1723 tg = sq_to_tg(tg->service_queue.parent_sq);
1724 if (!tg || !tg_to_blkg(tg)->parent)
1725 return false;
1726 }
1727 return false;
1728}
1729
1730static bool throtl_can_upgrade(struct throtl_data *td,
1731 struct throtl_grp *this_tg)
1732{
1733 struct cgroup_subsys_state *pos_css;
1734 struct blkcg_gq *blkg;
1735
1736 if (td->limit_index != LIMIT_LOW)
1737 return false;
1738
Shaohua Li297e3d82017-03-27 10:51:37 -07001739 if (time_before(jiffies, td->low_downgrade_time + td->throtl_slice))
Shaohua Li3f0abd82017-03-27 10:51:35 -07001740 return false;
1741
Shaohua Lic79892c2017-03-27 10:51:34 -07001742 rcu_read_lock();
1743 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
1744 struct throtl_grp *tg = blkg_to_tg(blkg);
1745
1746 if (tg == this_tg)
1747 continue;
1748 if (!list_empty(&tg_to_blkg(tg)->blkcg->css.children))
1749 continue;
1750 if (!throtl_hierarchy_can_upgrade(tg)) {
1751 rcu_read_unlock();
1752 return false;
1753 }
1754 }
1755 rcu_read_unlock();
1756 return true;
1757}
1758
1759static void throtl_upgrade_state(struct throtl_data *td)
1760{
1761 struct cgroup_subsys_state *pos_css;
1762 struct blkcg_gq *blkg;
1763
1764 td->limit_index = LIMIT_MAX;
Shaohua Li3f0abd82017-03-27 10:51:35 -07001765 td->low_upgrade_time = jiffies;
Shaohua Li7394e312017-03-27 10:51:40 -07001766 td->scale = 0;
Shaohua Lic79892c2017-03-27 10:51:34 -07001767 rcu_read_lock();
1768 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
1769 struct throtl_grp *tg = blkg_to_tg(blkg);
1770 struct throtl_service_queue *sq = &tg->service_queue;
1771
1772 tg->disptime = jiffies - 1;
1773 throtl_select_dispatch(sq);
1774 throtl_schedule_next_dispatch(sq, false);
1775 }
1776 rcu_read_unlock();
1777 throtl_select_dispatch(&td->service_queue);
1778 throtl_schedule_next_dispatch(&td->service_queue, false);
1779 queue_work(kthrotld_workqueue, &td->dispatch_work);
1780}
1781
Shaohua Li3f0abd82017-03-27 10:51:35 -07001782static void throtl_downgrade_state(struct throtl_data *td, int new)
1783{
Shaohua Li7394e312017-03-27 10:51:40 -07001784 td->scale /= 2;
1785
1786 if (td->scale) {
1787 td->low_upgrade_time = jiffies - td->scale * td->throtl_slice;
1788 return;
1789 }
1790
Shaohua Li3f0abd82017-03-27 10:51:35 -07001791 td->limit_index = new;
1792 td->low_downgrade_time = jiffies;
1793}
1794
1795static bool throtl_tg_can_downgrade(struct throtl_grp *tg)
1796{
1797 struct throtl_data *td = tg->td;
1798 unsigned long now = jiffies;
1799
Shaohua Liaec24242017-03-27 10:51:39 -07001800 if (time_after_eq(now, tg->last_dispatch_time[READ] +
1801 td->throtl_slice) &&
1802 time_after_eq(now, tg->last_dispatch_time[WRITE] +
1803 td->throtl_slice))
1804 return false;
Shaohua Li3f0abd82017-03-27 10:51:35 -07001805 /*
1806 * If cgroup is below low limit, consider downgrade and throttle other
1807 * cgroups
1808 */
Shaohua Li297e3d82017-03-27 10:51:37 -07001809 if (time_after_eq(now, td->low_upgrade_time + td->throtl_slice) &&
1810 time_after_eq(now, tg_last_low_overflow_time(tg) +
1811 td->throtl_slice))
Shaohua Li3f0abd82017-03-27 10:51:35 -07001812 return true;
1813 return false;
1814}
1815
1816static bool throtl_hierarchy_can_downgrade(struct throtl_grp *tg)
1817{
1818 while (true) {
1819 if (!throtl_tg_can_downgrade(tg))
1820 return false;
1821 tg = sq_to_tg(tg->service_queue.parent_sq);
1822 if (!tg || !tg_to_blkg(tg)->parent)
1823 break;
1824 }
1825 return true;
1826}
1827
1828static void throtl_downgrade_check(struct throtl_grp *tg)
1829{
1830 uint64_t bps;
1831 unsigned int iops;
1832 unsigned long elapsed_time;
1833 unsigned long now = jiffies;
1834
1835 if (tg->td->limit_index != LIMIT_MAX ||
1836 !tg->td->limit_valid[LIMIT_LOW])
1837 return;
1838 if (!list_empty(&tg_to_blkg(tg)->blkcg->css.children))
1839 return;
Shaohua Li297e3d82017-03-27 10:51:37 -07001840 if (time_after(tg->last_check_time + tg->td->throtl_slice, now))
Shaohua Li3f0abd82017-03-27 10:51:35 -07001841 return;
1842
1843 elapsed_time = now - tg->last_check_time;
1844 tg->last_check_time = now;
1845
Shaohua Li297e3d82017-03-27 10:51:37 -07001846 if (time_before(now, tg_last_low_overflow_time(tg) +
1847 tg->td->throtl_slice))
Shaohua Li3f0abd82017-03-27 10:51:35 -07001848 return;
1849
1850 if (tg->bps[READ][LIMIT_LOW]) {
1851 bps = tg->last_bytes_disp[READ] * HZ;
1852 do_div(bps, elapsed_time);
1853 if (bps >= tg->bps[READ][LIMIT_LOW])
1854 tg->last_low_overflow_time[READ] = now;
1855 }
1856
1857 if (tg->bps[WRITE][LIMIT_LOW]) {
1858 bps = tg->last_bytes_disp[WRITE] * HZ;
1859 do_div(bps, elapsed_time);
1860 if (bps >= tg->bps[WRITE][LIMIT_LOW])
1861 tg->last_low_overflow_time[WRITE] = now;
1862 }
1863
1864 if (tg->iops[READ][LIMIT_LOW]) {
1865 iops = tg->last_io_disp[READ] * HZ / elapsed_time;
1866 if (iops >= tg->iops[READ][LIMIT_LOW])
1867 tg->last_low_overflow_time[READ] = now;
1868 }
1869
1870 if (tg->iops[WRITE][LIMIT_LOW]) {
1871 iops = tg->last_io_disp[WRITE] * HZ / elapsed_time;
1872 if (iops >= tg->iops[WRITE][LIMIT_LOW])
1873 tg->last_low_overflow_time[WRITE] = now;
1874 }
1875
1876 /*
1877 * If cgroup is below low limit, consider downgrade and throttle other
1878 * cgroups
1879 */
1880 if (throtl_hierarchy_can_downgrade(tg))
1881 throtl_downgrade_state(tg->td, LIMIT_LOW);
1882
1883 tg->last_bytes_disp[READ] = 0;
1884 tg->last_bytes_disp[WRITE] = 0;
1885 tg->last_io_disp[READ] = 0;
1886 tg->last_io_disp[WRITE] = 0;
1887}
1888
Shaohua Li9e234ee2017-03-27 10:51:41 -07001889static void blk_throtl_update_idletime(struct throtl_grp *tg)
1890{
1891 unsigned long now = ktime_get_ns() >> 10;
1892 unsigned long last_finish_time = tg->last_finish_time;
1893
1894 if (now <= last_finish_time || last_finish_time == 0 ||
1895 last_finish_time == tg->checked_last_finish_time)
1896 return;
1897
1898 tg->avg_idletime = (tg->avg_idletime * 7 + now - last_finish_time) >> 3;
1899 tg->checked_last_finish_time = last_finish_time;
1900}
1901
Tejun Heoae118892015-08-18 14:55:20 -07001902bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
1903 struct bio *bio)
Vivek Goyale43473b2010-09-15 17:06:35 -04001904{
Tejun Heoc5cc2072013-05-14 13:52:38 -07001905 struct throtl_qnode *qn = NULL;
Tejun Heoae118892015-08-18 14:55:20 -07001906 struct throtl_grp *tg = blkg_to_tg(blkg ?: q->root_blkg);
Tejun Heo73f0d492013-05-14 13:52:35 -07001907 struct throtl_service_queue *sq;
Tejun Heo0e9f4162013-05-14 13:52:35 -07001908 bool rw = bio_data_dir(bio);
Tejun Heobc16a4f2011-10-19 14:33:01 +02001909 bool throttled = false;
Shaohua Li9e234ee2017-03-27 10:51:41 -07001910 int ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04001911
Tejun Heoae118892015-08-18 14:55:20 -07001912 WARN_ON_ONCE(!rcu_read_lock_held());
1913
Tejun Heo2a0f61e2013-05-14 13:52:36 -07001914 /* see throtl_charge_bio() */
Christoph Hellwig8d2bbd42016-10-20 15:12:12 +02001915 if (bio_flagged(bio, BIO_THROTTLED) || !tg->has_rules[rw])
Tejun Heobc16a4f2011-10-19 14:33:01 +02001916 goto out;
Vivek Goyale43473b2010-09-15 17:06:35 -04001917
1918 spin_lock_irq(q->queue_lock);
Tejun Heoc9589f02015-08-18 14:55:19 -07001919
1920 if (unlikely(blk_queue_bypass(q)))
Tejun Heobc16a4f2011-10-19 14:33:01 +02001921 goto out_unlock;
Vivek Goyalf469a7b2011-05-19 15:38:23 -04001922
Shaohua Li9e234ee2017-03-27 10:51:41 -07001923 ret = bio_associate_current(bio);
1924#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
1925 if (ret == 0 || ret == -EBUSY)
1926 bio->bi_cg_private = tg;
1927#endif
1928 blk_throtl_update_idletime(tg);
1929
Tejun Heo73f0d492013-05-14 13:52:35 -07001930 sq = &tg->service_queue;
1931
Shaohua Lic79892c2017-03-27 10:51:34 -07001932again:
Tejun Heo9e660ac2013-05-14 13:52:38 -07001933 while (true) {
Shaohua Liaec24242017-03-27 10:51:39 -07001934 tg->last_dispatch_time[rw] = jiffies;
Shaohua Li3f0abd82017-03-27 10:51:35 -07001935 if (tg->last_low_overflow_time[rw] == 0)
1936 tg->last_low_overflow_time[rw] = jiffies;
1937 throtl_downgrade_check(tg);
Tejun Heo9e660ac2013-05-14 13:52:38 -07001938 /* throtl is FIFO - if bios are already queued, should queue */
1939 if (sq->nr_queued[rw])
1940 break;
Vivek Goyalde701c72011-03-07 21:09:32 +01001941
Tejun Heo9e660ac2013-05-14 13:52:38 -07001942 /* if above limits, break to queue */
Shaohua Lic79892c2017-03-27 10:51:34 -07001943 if (!tg_may_dispatch(tg, bio, NULL)) {
Shaohua Li3f0abd82017-03-27 10:51:35 -07001944 tg->last_low_overflow_time[rw] = jiffies;
Shaohua Lic79892c2017-03-27 10:51:34 -07001945 if (throtl_can_upgrade(tg->td, tg)) {
1946 throtl_upgrade_state(tg->td);
1947 goto again;
1948 }
Tejun Heo9e660ac2013-05-14 13:52:38 -07001949 break;
Shaohua Lic79892c2017-03-27 10:51:34 -07001950 }
Tejun Heo9e660ac2013-05-14 13:52:38 -07001951
1952 /* within limits, let's charge and dispatch directly */
Vivek Goyale43473b2010-09-15 17:06:35 -04001953 throtl_charge_bio(tg, bio);
Vivek Goyal04521db2011-03-22 21:54:29 +01001954
1955 /*
1956 * We need to trim slice even when bios are not being queued
1957 * otherwise it might happen that a bio is not queued for
1958 * a long time and slice keeps on extending and trim is not
1959 * called for a long time. Now if limits are reduced suddenly
1960 * we take into account all the IO dispatched so far at new
1961 * low rate and * newly queued IO gets a really long dispatch
1962 * time.
1963 *
1964 * So keep on trimming slice even if bio is not queued.
1965 */
Tejun Heo0f3457f2013-05-14 13:52:32 -07001966 throtl_trim_slice(tg, rw);
Tejun Heo9e660ac2013-05-14 13:52:38 -07001967
1968 /*
1969 * @bio passed through this layer without being throttled.
1970 * Climb up the ladder. If we''re already at the top, it
1971 * can be executed directly.
1972 */
Tejun Heoc5cc2072013-05-14 13:52:38 -07001973 qn = &tg->qnode_on_parent[rw];
Tejun Heo9e660ac2013-05-14 13:52:38 -07001974 sq = sq->parent_sq;
1975 tg = sq_to_tg(sq);
1976 if (!tg)
1977 goto out_unlock;
Vivek Goyale43473b2010-09-15 17:06:35 -04001978 }
1979
Tejun Heo9e660ac2013-05-14 13:52:38 -07001980 /* out-of-limit, queue to @tg */
Tejun Heofda6f272013-05-14 13:52:36 -07001981 throtl_log(sq, "[%c] bio. bdisp=%llu sz=%u bps=%llu iodisp=%u iops=%u queued=%d/%d",
1982 rw == READ ? 'R' : 'W',
Shaohua Li9f626e32017-03-27 10:51:30 -07001983 tg->bytes_disp[rw], bio->bi_iter.bi_size,
1984 tg_bps_limit(tg, rw),
1985 tg->io_disp[rw], tg_iops_limit(tg, rw),
Tejun Heofda6f272013-05-14 13:52:36 -07001986 sq->nr_queued[READ], sq->nr_queued[WRITE]);
Vivek Goyale43473b2010-09-15 17:06:35 -04001987
Shaohua Li3f0abd82017-03-27 10:51:35 -07001988 tg->last_low_overflow_time[rw] = jiffies;
1989
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001990 tg->td->nr_queued[rw]++;
Tejun Heoc5cc2072013-05-14 13:52:38 -07001991 throtl_add_bio_tg(bio, qn, tg);
Tejun Heobc16a4f2011-10-19 14:33:01 +02001992 throttled = true;
Vivek Goyale43473b2010-09-15 17:06:35 -04001993
Tejun Heo7f52f982013-05-14 13:52:37 -07001994 /*
1995 * Update @tg's dispatch time and force schedule dispatch if @tg
1996 * was empty before @bio. The forced scheduling isn't likely to
1997 * cause undue delay as @bio is likely to be dispatched directly if
1998 * its @tg's disptime is not in the future.
1999 */
Tejun Heo0e9f4162013-05-14 13:52:35 -07002000 if (tg->flags & THROTL_TG_WAS_EMPTY) {
Tejun Heo77216b02013-05-14 13:52:36 -07002001 tg_update_disptime(tg);
Tejun Heo7f52f982013-05-14 13:52:37 -07002002 throtl_schedule_next_dispatch(tg->service_queue.parent_sq, true);
Vivek Goyale43473b2010-09-15 17:06:35 -04002003 }
2004
Tejun Heobc16a4f2011-10-19 14:33:01 +02002005out_unlock:
Vivek Goyale43473b2010-09-15 17:06:35 -04002006 spin_unlock_irq(q->queue_lock);
Tejun Heobc16a4f2011-10-19 14:33:01 +02002007out:
Tejun Heo2a0f61e2013-05-14 13:52:36 -07002008 /*
2009 * As multiple blk-throtls may stack in the same issue path, we
2010 * don't want bios to leave with the flag set. Clear the flag if
2011 * being issued.
2012 */
2013 if (!throttled)
Christoph Hellwig8d2bbd42016-10-20 15:12:12 +02002014 bio_clear_flag(bio, BIO_THROTTLED);
Tejun Heobc16a4f2011-10-19 14:33:01 +02002015 return throttled;
Vivek Goyale43473b2010-09-15 17:06:35 -04002016}
2017
Shaohua Li9e234ee2017-03-27 10:51:41 -07002018#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2019void blk_throtl_bio_endio(struct bio *bio)
2020{
2021 struct throtl_grp *tg;
2022
2023 tg = bio->bi_cg_private;
2024 if (!tg)
2025 return;
2026 bio->bi_cg_private = NULL;
2027
2028 tg->last_finish_time = ktime_get_ns() >> 10;
2029}
2030#endif
2031
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002032/*
2033 * Dispatch all bios from all children tg's queued on @parent_sq. On
2034 * return, @parent_sq is guaranteed to not have any active children tg's
2035 * and all bios from previously active tg's are on @parent_sq->bio_lists[].
2036 */
2037static void tg_drain_bios(struct throtl_service_queue *parent_sq)
2038{
2039 struct throtl_grp *tg;
2040
2041 while ((tg = throtl_rb_first(parent_sq))) {
2042 struct throtl_service_queue *sq = &tg->service_queue;
2043 struct bio *bio;
2044
2045 throtl_dequeue_tg(tg);
2046
Tejun Heoc5cc2072013-05-14 13:52:38 -07002047 while ((bio = throtl_peek_queued(&sq->queued[READ])))
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002048 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Tejun Heoc5cc2072013-05-14 13:52:38 -07002049 while ((bio = throtl_peek_queued(&sq->queued[WRITE])))
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002050 tg_dispatch_one_bio(tg, bio_data_dir(bio));
2051 }
2052}
2053
Tejun Heoc9a929d2011-10-19 14:42:16 +02002054/**
2055 * blk_throtl_drain - drain throttled bios
2056 * @q: request_queue to drain throttled bios for
2057 *
2058 * Dispatch all currently throttled bios on @q through ->make_request_fn().
2059 */
2060void blk_throtl_drain(struct request_queue *q)
2061 __releases(q->queue_lock) __acquires(q->queue_lock)
2062{
2063 struct throtl_data *td = q->td;
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002064 struct blkcg_gq *blkg;
Tejun Heo492eb212013-08-08 20:11:25 -04002065 struct cgroup_subsys_state *pos_css;
Tejun Heoc9a929d2011-10-19 14:42:16 +02002066 struct bio *bio;
Tejun Heo651930b2013-05-14 13:52:35 -07002067 int rw;
Tejun Heoc9a929d2011-10-19 14:42:16 +02002068
Andi Kleen8bcb6c72012-03-30 12:33:28 +02002069 queue_lockdep_assert_held(q);
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002070 rcu_read_lock();
Tejun Heoc9a929d2011-10-19 14:42:16 +02002071
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002072 /*
2073 * Drain each tg while doing post-order walk on the blkg tree, so
2074 * that all bios are propagated to td->service_queue. It'd be
2075 * better to walk service_queue tree directly but blkg walk is
2076 * easier.
2077 */
Tejun Heo492eb212013-08-08 20:11:25 -04002078 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg)
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002079 tg_drain_bios(&blkg_to_tg(blkg)->service_queue);
Tejun Heo73f0d492013-05-14 13:52:35 -07002080
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002081 /* finally, transfer bios from top-level tg's into the td */
2082 tg_drain_bios(&td->service_queue);
2083
2084 rcu_read_unlock();
Tejun Heoc9a929d2011-10-19 14:42:16 +02002085 spin_unlock_irq(q->queue_lock);
2086
Tejun Heo2a12f0d2013-05-14 13:52:37 -07002087 /* all bios now should be in td->service_queue, issue them */
Tejun Heo651930b2013-05-14 13:52:35 -07002088 for (rw = READ; rw <= WRITE; rw++)
Tejun Heoc5cc2072013-05-14 13:52:38 -07002089 while ((bio = throtl_pop_queued(&td->service_queue.queued[rw],
2090 NULL)))
Tejun Heo651930b2013-05-14 13:52:35 -07002091 generic_make_request(bio);
Tejun Heoc9a929d2011-10-19 14:42:16 +02002092
2093 spin_lock_irq(q->queue_lock);
2094}
2095
Vivek Goyale43473b2010-09-15 17:06:35 -04002096int blk_throtl_init(struct request_queue *q)
2097{
2098 struct throtl_data *td;
Tejun Heoa2b16932012-04-13 13:11:33 -07002099 int ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04002100
2101 td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
2102 if (!td)
2103 return -ENOMEM;
2104
Tejun Heo69df0ab2013-05-14 13:52:36 -07002105 INIT_WORK(&td->dispatch_work, blk_throtl_dispatch_work_fn);
Tejun Heob2ce2642015-08-18 14:55:13 -07002106 throtl_service_queue_init(&td->service_queue);
Vivek Goyale43473b2010-09-15 17:06:35 -04002107
Tejun Heocd1604f2012-03-05 13:15:06 -08002108 q->td = td;
Vivek Goyal29b12582011-05-19 15:38:24 -04002109 td->queue = q;
Vivek Goyal02977e42010-10-01 14:49:48 +02002110
Shaohua Li9f626e32017-03-27 10:51:30 -07002111 td->limit_valid[LIMIT_MAX] = true;
Shaohua Licd5ab1b2017-03-27 10:51:32 -07002112 td->limit_index = LIMIT_MAX;
Shaohua Li3f0abd82017-03-27 10:51:35 -07002113 td->low_upgrade_time = jiffies;
2114 td->low_downgrade_time = jiffies;
Shaohua Li9e234ee2017-03-27 10:51:41 -07002115
Tejun Heoa2b16932012-04-13 13:11:33 -07002116 /* activate policy */
Tejun Heo3c798392012-04-16 13:57:25 -07002117 ret = blkcg_activate_policy(q, &blkcg_policy_throtl);
Tejun Heoa2b16932012-04-13 13:11:33 -07002118 if (ret)
Vivek Goyal29b12582011-05-19 15:38:24 -04002119 kfree(td);
Tejun Heoa2b16932012-04-13 13:11:33 -07002120 return ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04002121}
2122
2123void blk_throtl_exit(struct request_queue *q)
2124{
Tejun Heoc875f4d2012-03-05 13:15:22 -08002125 BUG_ON(!q->td);
Vivek Goyalda527772011-03-02 19:05:33 -05002126 throtl_shutdown_wq(q);
Tejun Heo3c798392012-04-16 13:57:25 -07002127 blkcg_deactivate_policy(q, &blkcg_policy_throtl);
Tejun Heoc9a929d2011-10-19 14:42:16 +02002128 kfree(q->td);
Vivek Goyale43473b2010-09-15 17:06:35 -04002129}
2130
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002131void blk_throtl_register_queue(struct request_queue *q)
2132{
2133 struct throtl_data *td;
Shaohua Li9e234ee2017-03-27 10:51:41 -07002134 struct cgroup_subsys_state *pos_css;
2135 struct blkcg_gq *blkg;
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002136
2137 td = q->td;
2138 BUG_ON(!td);
2139
Shaohua Liada75b62017-03-27 10:51:42 -07002140 if (blk_queue_nonrot(q)) {
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002141 td->throtl_slice = DFL_THROTL_SLICE_SSD;
Shaohua Liada75b62017-03-27 10:51:42 -07002142 td->dft_idletime_threshold = DFL_IDLE_THRESHOLD_SSD;
2143 } else {
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002144 td->throtl_slice = DFL_THROTL_SLICE_HD;
Shaohua Liada75b62017-03-27 10:51:42 -07002145 td->dft_idletime_threshold = DFL_IDLE_THRESHOLD_HD;
2146 }
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002147#ifndef CONFIG_BLK_DEV_THROTTLING_LOW
2148 /* if no low limit, use previous default */
2149 td->throtl_slice = DFL_THROTL_SLICE_HD;
2150#endif
Shaohua Li9e234ee2017-03-27 10:51:41 -07002151
2152 /*
2153 * some tg are created before queue is fully initialized, eg, nonrot
2154 * isn't initialized yet
2155 */
2156 rcu_read_lock();
2157 blkg_for_each_descendant_post(blkg, pos_css, q->root_blkg) {
2158 struct throtl_grp *tg = blkg_to_tg(blkg);
2159
Shaohua Liada75b62017-03-27 10:51:42 -07002160 tg->idletime_threshold = td->dft_idletime_threshold;
Shaohua Li9e234ee2017-03-27 10:51:41 -07002161 }
2162 rcu_read_unlock();
Shaohua Lid61fcfa2017-03-27 10:51:38 -07002163}
2164
Shaohua Li297e3d82017-03-27 10:51:37 -07002165#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2166ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page)
2167{
2168 if (!q->td)
2169 return -EINVAL;
2170 return sprintf(page, "%u\n", jiffies_to_msecs(q->td->throtl_slice));
2171}
2172
2173ssize_t blk_throtl_sample_time_store(struct request_queue *q,
2174 const char *page, size_t count)
2175{
2176 unsigned long v;
2177 unsigned long t;
2178
2179 if (!q->td)
2180 return -EINVAL;
2181 if (kstrtoul(page, 10, &v))
2182 return -EINVAL;
2183 t = msecs_to_jiffies(v);
2184 if (t == 0 || t > MAX_THROTL_SLICE)
2185 return -EINVAL;
2186 q->td->throtl_slice = t;
2187 return count;
2188}
2189#endif
2190
Vivek Goyale43473b2010-09-15 17:06:35 -04002191static int __init throtl_init(void)
2192{
Vivek Goyal450adcb2011-03-01 13:40:54 -05002193 kthrotld_workqueue = alloc_workqueue("kthrotld", WQ_MEM_RECLAIM, 0);
2194 if (!kthrotld_workqueue)
2195 panic("Failed to create kthrotld\n");
2196
Tejun Heo3c798392012-04-16 13:57:25 -07002197 return blkcg_policy_register(&blkcg_policy_throtl);
Vivek Goyale43473b2010-09-15 17:06:35 -04002198}
2199
2200module_init(throtl_init);