blob: c0b2263a222ae2c7f53dc79a632ee20f3dd09f76 [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
21/* Throttling is performed over 100ms slice and after that slice is renewed */
22static unsigned long throtl_slice = HZ/10; /* 100 ms */
23
Tejun Heo3c798392012-04-16 13:57:25 -070024static struct blkcg_policy blkcg_policy_throtl;
Tejun Heo03814112012-03-05 13:15:14 -080025
Vivek Goyal450adcb2011-03-01 13:40:54 -050026/* A workqueue to queue throttle related work */
27static struct workqueue_struct *kthrotld_workqueue;
Vivek Goyal450adcb2011-03-01 13:40:54 -050028
Tejun Heoc5cc2072013-05-14 13:52:38 -070029/*
30 * To implement hierarchical throttling, throtl_grps form a tree and bios
31 * are dispatched upwards level by level until they reach the top and get
32 * issued. When dispatching bios from the children and local group at each
33 * level, if the bios are dispatched into a single bio_list, there's a risk
34 * of a local or child group which can queue many bios at once filling up
35 * the list starving others.
36 *
37 * To avoid such starvation, dispatched bios are queued separately
38 * according to where they came from. When they are again dispatched to
39 * the parent, they're popped in round-robin order so that no single source
40 * hogs the dispatch window.
41 *
42 * throtl_qnode is used to keep the queued bios separated by their sources.
43 * Bios are queued to throtl_qnode which in turn is queued to
44 * throtl_service_queue and then dispatched in round-robin order.
45 *
46 * It's also used to track the reference counts on blkg's. A qnode always
47 * belongs to a throtl_grp and gets queued on itself or the parent, so
48 * incrementing the reference of the associated throtl_grp when a qnode is
49 * queued and decrementing when dequeued is enough to keep the whole blkg
50 * tree pinned while bios are in flight.
51 */
52struct throtl_qnode {
53 struct list_head node; /* service_queue->queued[] */
54 struct bio_list bios; /* queued bios */
55 struct throtl_grp *tg; /* tg this qnode belongs to */
56};
57
Tejun Heoc9e03322013-05-14 13:52:32 -070058struct throtl_service_queue {
Tejun Heo77216b02013-05-14 13:52:36 -070059 struct throtl_service_queue *parent_sq; /* the parent service_queue */
60
Tejun Heo73f0d492013-05-14 13:52:35 -070061 /*
62 * Bios queued directly to this service_queue or dispatched from
63 * children throtl_grp's.
64 */
Tejun Heoc5cc2072013-05-14 13:52:38 -070065 struct list_head queued[2]; /* throtl_qnode [READ/WRITE] */
Tejun Heo73f0d492013-05-14 13:52:35 -070066 unsigned int nr_queued[2]; /* number of queued bios */
67
68 /*
69 * RB tree of active children throtl_grp's, which are sorted by
70 * their ->disptime.
71 */
Tejun Heoc9e03322013-05-14 13:52:32 -070072 struct rb_root pending_tree; /* RB tree of active tgs */
73 struct rb_node *first_pending; /* first node in the tree */
74 unsigned int nr_pending; /* # queued in the tree */
75 unsigned long first_pending_disptime; /* disptime of the first tg */
Tejun Heo69df0ab2013-05-14 13:52:36 -070076 struct timer_list pending_timer; /* fires on first_pending_disptime */
Vivek Goyale43473b2010-09-15 17:06:35 -040077};
78
Tejun Heo5b2c16a2013-05-14 13:52:32 -070079enum tg_state_flags {
80 THROTL_TG_PENDING = 1 << 0, /* on parent's pending tree */
Tejun Heo0e9f4162013-05-14 13:52:35 -070081 THROTL_TG_WAS_EMPTY = 1 << 1, /* bio_lists[] became non-empty */
Tejun Heo5b2c16a2013-05-14 13:52:32 -070082};
83
Vivek Goyale43473b2010-09-15 17:06:35 -040084#define rb_entry_tg(node) rb_entry((node), struct throtl_grp, rb_node)
85
86struct throtl_grp {
Tejun Heof95a04a2012-04-16 13:57:26 -070087 /* must be the first member */
88 struct blkg_policy_data pd;
89
Tejun Heoc9e03322013-05-14 13:52:32 -070090 /* active throtl group service_queue member */
Vivek Goyale43473b2010-09-15 17:06:35 -040091 struct rb_node rb_node;
92
Tejun Heo0f3457f2013-05-14 13:52:32 -070093 /* throtl_data this group belongs to */
94 struct throtl_data *td;
95
Tejun Heo49a2f1e2013-05-14 13:52:34 -070096 /* this group's service queue */
97 struct throtl_service_queue service_queue;
98
Vivek Goyale43473b2010-09-15 17:06:35 -040099 /*
Tejun Heoc5cc2072013-05-14 13:52:38 -0700100 * qnode_on_self is used when bios are directly queued to this
101 * throtl_grp so that local bios compete fairly with bios
102 * dispatched from children. qnode_on_parent is used when bios are
103 * dispatched from this throtl_grp into its parent and will compete
104 * with the sibling qnode_on_parents and the parent's
105 * qnode_on_self.
106 */
107 struct throtl_qnode qnode_on_self[2];
108 struct throtl_qnode qnode_on_parent[2];
109
110 /*
Vivek Goyale43473b2010-09-15 17:06:35 -0400111 * Dispatch time in jiffies. This is the estimated time when group
112 * will unthrottle and is ready to dispatch more bio. It is used as
113 * key to sort active groups in service tree.
114 */
115 unsigned long disptime;
116
Vivek Goyale43473b2010-09-15 17:06:35 -0400117 unsigned int flags;
118
Tejun Heo693e7512013-05-14 13:52:38 -0700119 /* are there any throtl rules between this group and td? */
120 bool has_rules[2];
121
Vivek Goyale43473b2010-09-15 17:06:35 -0400122 /* bytes per second rate limits */
123 uint64_t bps[2];
124
Vivek Goyal8e89d132010-09-15 17:06:37 -0400125 /* IOPS limits */
126 unsigned int iops[2];
127
Vivek Goyale43473b2010-09-15 17:06:35 -0400128 /* Number of bytes disptached in current slice */
129 uint64_t bytes_disp[2];
Vivek Goyal8e89d132010-09-15 17:06:37 -0400130 /* Number of bio's dispatched in current slice */
131 unsigned int io_disp[2];
Vivek Goyale43473b2010-09-15 17:06:35 -0400132
133 /* When did we start a new slice */
134 unsigned long slice_start[2];
135 unsigned long slice_end[2];
Vivek Goyalfe071432010-10-01 14:49:49 +0200136
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700137 /* total bytes transferred */
138 struct blkg_rwstat service_bytes;
139 /* total IOs serviced, post merge */
140 struct blkg_rwstat serviced;
Vivek Goyale43473b2010-09-15 17:06:35 -0400141};
142
143struct throtl_data
144{
Vivek Goyale43473b2010-09-15 17:06:35 -0400145 /* service tree for active throtl groups */
Tejun Heoc9e03322013-05-14 13:52:32 -0700146 struct throtl_service_queue service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -0400147
Vivek Goyale43473b2010-09-15 17:06:35 -0400148 struct request_queue *queue;
149
150 /* Total Number of queued bios on READ and WRITE lists */
151 unsigned int nr_queued[2];
152
153 /*
Vivek Goyal02977e42010-10-01 14:49:48 +0200154 * number of total undestroyed groups
Vivek Goyale43473b2010-09-15 17:06:35 -0400155 */
156 unsigned int nr_undestroyed_grps;
157
158 /* Work for dispatching throttled bios */
Tejun Heo69df0ab2013-05-14 13:52:36 -0700159 struct work_struct dispatch_work;
Vivek Goyale43473b2010-09-15 17:06:35 -0400160};
161
Tejun Heo69df0ab2013-05-14 13:52:36 -0700162static void throtl_pending_timer_fn(unsigned long arg);
163
Tejun Heof95a04a2012-04-16 13:57:26 -0700164static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
165{
166 return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
167}
168
Tejun Heo3c798392012-04-16 13:57:25 -0700169static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
Tejun Heo03814112012-03-05 13:15:14 -0800170{
Tejun Heof95a04a2012-04-16 13:57:26 -0700171 return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
Tejun Heo03814112012-03-05 13:15:14 -0800172}
173
Tejun Heo3c798392012-04-16 13:57:25 -0700174static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
Tejun Heo03814112012-03-05 13:15:14 -0800175{
Tejun Heof95a04a2012-04-16 13:57:26 -0700176 return pd_to_blkg(&tg->pd);
Tejun Heo03814112012-03-05 13:15:14 -0800177}
178
Tejun Heofda6f272013-05-14 13:52:36 -0700179/**
180 * sq_to_tg - return the throl_grp the specified service queue belongs to
181 * @sq: the throtl_service_queue of interest
182 *
183 * Return the throtl_grp @sq belongs to. If @sq is the top-level one
184 * embedded in throtl_data, %NULL is returned.
185 */
186static struct throtl_grp *sq_to_tg(struct throtl_service_queue *sq)
187{
188 if (sq && sq->parent_sq)
189 return container_of(sq, struct throtl_grp, service_queue);
190 else
191 return NULL;
192}
Vivek Goyale43473b2010-09-15 17:06:35 -0400193
Tejun Heofda6f272013-05-14 13:52:36 -0700194/**
195 * sq_to_td - return throtl_data the specified service queue belongs to
196 * @sq: the throtl_service_queue of interest
197 *
198 * A service_queue can be embeded in either a throtl_grp or throtl_data.
199 * Determine the associated throtl_data accordingly and return it.
200 */
201static struct throtl_data *sq_to_td(struct throtl_service_queue *sq)
202{
203 struct throtl_grp *tg = sq_to_tg(sq);
204
205 if (tg)
206 return tg->td;
207 else
208 return container_of(sq, struct throtl_data, service_queue);
209}
210
211/**
212 * throtl_log - log debug message via blktrace
213 * @sq: the service_queue being reported
214 * @fmt: printf format string
215 * @args: printf args
216 *
217 * The messages are prefixed with "throtl BLKG_NAME" if @sq belongs to a
218 * throtl_grp; otherwise, just "throtl".
219 *
220 * TODO: this should be made a function and name formatting should happen
221 * after testing whether blktrace is enabled.
222 */
223#define throtl_log(sq, fmt, args...) do { \
224 struct throtl_grp *__tg = sq_to_tg((sq)); \
225 struct throtl_data *__td = sq_to_td((sq)); \
226 \
227 (void)__td; \
228 if ((__tg)) { \
229 char __pbuf[128]; \
230 \
231 blkg_path(tg_to_blkg(__tg), __pbuf, sizeof(__pbuf)); \
232 blk_add_trace_msg(__td->queue, "throtl %s " fmt, __pbuf, ##args); \
233 } else { \
234 blk_add_trace_msg(__td->queue, "throtl " fmt, ##args); \
235 } \
236} while (0)
Vivek Goyale43473b2010-09-15 17:06:35 -0400237
Tejun Heoc5cc2072013-05-14 13:52:38 -0700238static void throtl_qnode_init(struct throtl_qnode *qn, struct throtl_grp *tg)
239{
240 INIT_LIST_HEAD(&qn->node);
241 bio_list_init(&qn->bios);
242 qn->tg = tg;
243}
244
245/**
246 * throtl_qnode_add_bio - add a bio to a throtl_qnode and activate it
247 * @bio: bio being added
248 * @qn: qnode to add bio to
249 * @queued: the service_queue->queued[] list @qn belongs to
250 *
251 * Add @bio to @qn and put @qn on @queued if it's not already on.
252 * @qn->tg's reference count is bumped when @qn is activated. See the
253 * comment on top of throtl_qnode definition for details.
254 */
255static void throtl_qnode_add_bio(struct bio *bio, struct throtl_qnode *qn,
256 struct list_head *queued)
257{
258 bio_list_add(&qn->bios, bio);
259 if (list_empty(&qn->node)) {
260 list_add_tail(&qn->node, queued);
261 blkg_get(tg_to_blkg(qn->tg));
262 }
263}
264
265/**
266 * throtl_peek_queued - peek the first bio on a qnode list
267 * @queued: the qnode list to peek
268 */
269static struct bio *throtl_peek_queued(struct list_head *queued)
270{
271 struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
272 struct bio *bio;
273
274 if (list_empty(queued))
275 return NULL;
276
277 bio = bio_list_peek(&qn->bios);
278 WARN_ON_ONCE(!bio);
279 return bio;
280}
281
282/**
283 * throtl_pop_queued - pop the first bio form a qnode list
284 * @queued: the qnode list to pop a bio from
285 * @tg_to_put: optional out argument for throtl_grp to put
286 *
287 * Pop the first bio from the qnode list @queued. After popping, the first
288 * qnode is removed from @queued if empty or moved to the end of @queued so
289 * that the popping order is round-robin.
290 *
291 * When the first qnode is removed, its associated throtl_grp should be put
292 * too. If @tg_to_put is NULL, this function automatically puts it;
293 * otherwise, *@tg_to_put is set to the throtl_grp to put and the caller is
294 * responsible for putting it.
295 */
296static struct bio *throtl_pop_queued(struct list_head *queued,
297 struct throtl_grp **tg_to_put)
298{
299 struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
300 struct bio *bio;
301
302 if (list_empty(queued))
303 return NULL;
304
305 bio = bio_list_pop(&qn->bios);
306 WARN_ON_ONCE(!bio);
307
308 if (bio_list_empty(&qn->bios)) {
309 list_del_init(&qn->node);
310 if (tg_to_put)
311 *tg_to_put = qn->tg;
312 else
313 blkg_put(tg_to_blkg(qn->tg));
314 } else {
315 list_move_tail(&qn->node, queued);
316 }
317
318 return bio;
319}
320
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700321/* init a service_queue, assumes the caller zeroed it */
Tejun Heob2ce2642015-08-18 14:55:13 -0700322static void throtl_service_queue_init(struct throtl_service_queue *sq)
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700323{
Tejun Heoc5cc2072013-05-14 13:52:38 -0700324 INIT_LIST_HEAD(&sq->queued[0]);
325 INIT_LIST_HEAD(&sq->queued[1]);
Tejun Heo49a2f1e2013-05-14 13:52:34 -0700326 sq->pending_tree = RB_ROOT;
Tejun Heo69df0ab2013-05-14 13:52:36 -0700327 setup_timer(&sq->pending_timer, throtl_pending_timer_fn,
328 (unsigned long)sq);
329}
330
Tejun Heo001bea72015-08-18 14:55:11 -0700331static struct blkg_policy_data *throtl_pd_alloc(gfp_t gfp, int node)
332{
Tejun Heo4fb72032015-08-18 14:55:12 -0700333 struct throtl_grp *tg;
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700334 int rw;
Tejun Heo4fb72032015-08-18 14:55:12 -0700335
336 tg = kzalloc_node(sizeof(*tg), gfp, node);
337 if (!tg)
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700338 goto err;
Tejun Heo4fb72032015-08-18 14:55:12 -0700339
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700340 if (blkg_rwstat_init(&tg->service_bytes, gfp) ||
341 blkg_rwstat_init(&tg->serviced, gfp))
342 goto err_free_tg;
Tejun Heo4fb72032015-08-18 14:55:12 -0700343
Tejun Heob2ce2642015-08-18 14:55:13 -0700344 throtl_service_queue_init(&tg->service_queue);
345
346 for (rw = READ; rw <= WRITE; rw++) {
347 throtl_qnode_init(&tg->qnode_on_self[rw], tg);
348 throtl_qnode_init(&tg->qnode_on_parent[rw], tg);
349 }
350
351 RB_CLEAR_NODE(&tg->rb_node);
352 tg->bps[READ] = -1;
353 tg->bps[WRITE] = -1;
354 tg->iops[READ] = -1;
355 tg->iops[WRITE] = -1;
356
Tejun Heo4fb72032015-08-18 14:55:12 -0700357 return &tg->pd;
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700358
359err_free_tg:
360 blkg_rwstat_exit(&tg->serviced);
361 blkg_rwstat_exit(&tg->service_bytes);
362 kfree(tg);
363err:
364 return NULL;
Tejun Heo001bea72015-08-18 14:55:11 -0700365}
366
Tejun Heoa9520cd2015-08-18 14:55:14 -0700367static void throtl_pd_init(struct blkg_policy_data *pd)
Vivek Goyala29a1712011-05-19 15:38:19 -0400368{
Tejun Heoa9520cd2015-08-18 14:55:14 -0700369 struct throtl_grp *tg = pd_to_tg(pd);
370 struct blkcg_gq *blkg = tg_to_blkg(tg);
Tejun Heo77216b02013-05-14 13:52:36 -0700371 struct throtl_data *td = blkg->q->td;
Tejun Heob2ce2642015-08-18 14:55:13 -0700372 struct throtl_service_queue *sq = &tg->service_queue;
Tejun Heocd1604f2012-03-05 13:15:06 -0800373
Tejun Heo91381252013-05-14 13:52:38 -0700374 /*
Tejun Heoaa6ec292014-07-09 10:08:08 -0400375 * If on the default hierarchy, we switch to properly hierarchical
Tejun Heo91381252013-05-14 13:52:38 -0700376 * behavior where limits on a given throtl_grp are applied to the
377 * whole subtree rather than just the group itself. e.g. If 16M
378 * read_bps limit is set on the root group, the whole system can't
379 * exceed 16M for the device.
380 *
Tejun Heoaa6ec292014-07-09 10:08:08 -0400381 * If not on the default hierarchy, the broken flat hierarchy
Tejun Heo91381252013-05-14 13:52:38 -0700382 * behavior is retained where all throtl_grps are treated as if
383 * they're all separate root groups right below throtl_data.
384 * Limits of a group don't interact with limits of other groups
385 * regardless of the position of the group in the hierarchy.
386 */
Tejun Heob2ce2642015-08-18 14:55:13 -0700387 sq->parent_sq = &td->service_queue;
Tejun Heoaa6ec292014-07-09 10:08:08 -0400388 if (cgroup_on_dfl(blkg->blkcg->css.cgroup) && blkg->parent)
Tejun Heob2ce2642015-08-18 14:55:13 -0700389 sq->parent_sq = &blkg_to_tg(blkg->parent)->service_queue;
Tejun Heo77216b02013-05-14 13:52:36 -0700390 tg->td = td;
Tejun Heo8a3d2612012-04-01 14:38:44 -0700391}
392
Tejun Heo693e7512013-05-14 13:52:38 -0700393/*
394 * Set has_rules[] if @tg or any of its parents have limits configured.
395 * This doesn't require walking up to the top of the hierarchy as the
396 * parent's has_rules[] is guaranteed to be correct.
397 */
398static void tg_update_has_rules(struct throtl_grp *tg)
399{
400 struct throtl_grp *parent_tg = sq_to_tg(tg->service_queue.parent_sq);
401 int rw;
402
403 for (rw = READ; rw <= WRITE; rw++)
404 tg->has_rules[rw] = (parent_tg && parent_tg->has_rules[rw]) ||
405 (tg->bps[rw] != -1 || tg->iops[rw] != -1);
406}
407
Tejun Heoa9520cd2015-08-18 14:55:14 -0700408static void throtl_pd_online(struct blkg_policy_data *pd)
Tejun Heo693e7512013-05-14 13:52:38 -0700409{
410 /*
411 * We don't want new groups to escape the limits of its ancestors.
412 * Update has_rules[] after a new group is brought online.
413 */
Tejun Heoa9520cd2015-08-18 14:55:14 -0700414 tg_update_has_rules(pd_to_tg(pd));
Tejun Heo693e7512013-05-14 13:52:38 -0700415}
416
Tejun Heo001bea72015-08-18 14:55:11 -0700417static void throtl_pd_free(struct blkg_policy_data *pd)
418{
Tejun Heo4fb72032015-08-18 14:55:12 -0700419 struct throtl_grp *tg = pd_to_tg(pd);
420
Tejun Heob2ce2642015-08-18 14:55:13 -0700421 del_timer_sync(&tg->service_queue.pending_timer);
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700422 blkg_rwstat_exit(&tg->serviced);
423 blkg_rwstat_exit(&tg->service_bytes);
Tejun Heo4fb72032015-08-18 14:55:12 -0700424 kfree(tg);
Tejun Heo001bea72015-08-18 14:55:11 -0700425}
426
Tejun Heoa9520cd2015-08-18 14:55:14 -0700427static void throtl_pd_reset_stats(struct blkg_policy_data *pd)
Tejun Heo8a3d2612012-04-01 14:38:44 -0700428{
Tejun Heoa9520cd2015-08-18 14:55:14 -0700429 struct throtl_grp *tg = pd_to_tg(pd);
Tejun Heo8a3d2612012-04-01 14:38:44 -0700430
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700431 blkg_rwstat_reset(&tg->service_bytes);
432 blkg_rwstat_reset(&tg->serviced);
Vivek Goyala29a1712011-05-19 15:38:19 -0400433}
434
Tejun Heo0049af72013-05-14 13:52:33 -0700435static struct throtl_grp *
436throtl_rb_first(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400437{
438 /* Service tree is empty */
Tejun Heo0049af72013-05-14 13:52:33 -0700439 if (!parent_sq->nr_pending)
Vivek Goyale43473b2010-09-15 17:06:35 -0400440 return NULL;
441
Tejun Heo0049af72013-05-14 13:52:33 -0700442 if (!parent_sq->first_pending)
443 parent_sq->first_pending = rb_first(&parent_sq->pending_tree);
Vivek Goyale43473b2010-09-15 17:06:35 -0400444
Tejun Heo0049af72013-05-14 13:52:33 -0700445 if (parent_sq->first_pending)
446 return rb_entry_tg(parent_sq->first_pending);
Vivek Goyale43473b2010-09-15 17:06:35 -0400447
448 return NULL;
449}
450
451static void rb_erase_init(struct rb_node *n, struct rb_root *root)
452{
453 rb_erase(n, root);
454 RB_CLEAR_NODE(n);
455}
456
Tejun Heo0049af72013-05-14 13:52:33 -0700457static void throtl_rb_erase(struct rb_node *n,
458 struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400459{
Tejun Heo0049af72013-05-14 13:52:33 -0700460 if (parent_sq->first_pending == n)
461 parent_sq->first_pending = NULL;
462 rb_erase_init(n, &parent_sq->pending_tree);
463 --parent_sq->nr_pending;
Vivek Goyale43473b2010-09-15 17:06:35 -0400464}
465
Tejun Heo0049af72013-05-14 13:52:33 -0700466static void update_min_dispatch_time(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -0400467{
468 struct throtl_grp *tg;
469
Tejun Heo0049af72013-05-14 13:52:33 -0700470 tg = throtl_rb_first(parent_sq);
Vivek Goyale43473b2010-09-15 17:06:35 -0400471 if (!tg)
472 return;
473
Tejun Heo0049af72013-05-14 13:52:33 -0700474 parent_sq->first_pending_disptime = tg->disptime;
Vivek Goyale43473b2010-09-15 17:06:35 -0400475}
476
Tejun Heo77216b02013-05-14 13:52:36 -0700477static void tg_service_queue_add(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400478{
Tejun Heo77216b02013-05-14 13:52:36 -0700479 struct throtl_service_queue *parent_sq = tg->service_queue.parent_sq;
Tejun Heo0049af72013-05-14 13:52:33 -0700480 struct rb_node **node = &parent_sq->pending_tree.rb_node;
Vivek Goyale43473b2010-09-15 17:06:35 -0400481 struct rb_node *parent = NULL;
482 struct throtl_grp *__tg;
483 unsigned long key = tg->disptime;
484 int left = 1;
485
486 while (*node != NULL) {
487 parent = *node;
488 __tg = rb_entry_tg(parent);
489
490 if (time_before(key, __tg->disptime))
491 node = &parent->rb_left;
492 else {
493 node = &parent->rb_right;
494 left = 0;
495 }
496 }
497
498 if (left)
Tejun Heo0049af72013-05-14 13:52:33 -0700499 parent_sq->first_pending = &tg->rb_node;
Vivek Goyale43473b2010-09-15 17:06:35 -0400500
501 rb_link_node(&tg->rb_node, parent, node);
Tejun Heo0049af72013-05-14 13:52:33 -0700502 rb_insert_color(&tg->rb_node, &parent_sq->pending_tree);
Vivek Goyale43473b2010-09-15 17:06:35 -0400503}
504
Tejun Heo77216b02013-05-14 13:52:36 -0700505static void __throtl_enqueue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400506{
Tejun Heo77216b02013-05-14 13:52:36 -0700507 tg_service_queue_add(tg);
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700508 tg->flags |= THROTL_TG_PENDING;
Tejun Heo77216b02013-05-14 13:52:36 -0700509 tg->service_queue.parent_sq->nr_pending++;
Vivek Goyale43473b2010-09-15 17:06:35 -0400510}
511
Tejun Heo77216b02013-05-14 13:52:36 -0700512static void throtl_enqueue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400513{
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700514 if (!(tg->flags & THROTL_TG_PENDING))
Tejun Heo77216b02013-05-14 13:52:36 -0700515 __throtl_enqueue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400516}
517
Tejun Heo77216b02013-05-14 13:52:36 -0700518static void __throtl_dequeue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400519{
Tejun Heo77216b02013-05-14 13:52:36 -0700520 throtl_rb_erase(&tg->rb_node, tg->service_queue.parent_sq);
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700521 tg->flags &= ~THROTL_TG_PENDING;
Vivek Goyale43473b2010-09-15 17:06:35 -0400522}
523
Tejun Heo77216b02013-05-14 13:52:36 -0700524static void throtl_dequeue_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400525{
Tejun Heo5b2c16a2013-05-14 13:52:32 -0700526 if (tg->flags & THROTL_TG_PENDING)
Tejun Heo77216b02013-05-14 13:52:36 -0700527 __throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400528}
529
Tejun Heoa9131a22013-05-14 13:52:31 -0700530/* Call with queue lock held */
Tejun Heo69df0ab2013-05-14 13:52:36 -0700531static void throtl_schedule_pending_timer(struct throtl_service_queue *sq,
532 unsigned long expires)
Tejun Heoa9131a22013-05-14 13:52:31 -0700533{
Tejun Heo69df0ab2013-05-14 13:52:36 -0700534 mod_timer(&sq->pending_timer, expires);
535 throtl_log(sq, "schedule timer. delay=%lu jiffies=%lu",
536 expires - jiffies, jiffies);
Tejun Heoa9131a22013-05-14 13:52:31 -0700537}
538
Tejun Heo7f52f982013-05-14 13:52:37 -0700539/**
540 * throtl_schedule_next_dispatch - schedule the next dispatch cycle
541 * @sq: the service_queue to schedule dispatch for
542 * @force: force scheduling
543 *
544 * Arm @sq->pending_timer so that the next dispatch cycle starts on the
545 * dispatch time of the first pending child. Returns %true if either timer
546 * is armed or there's no pending child left. %false if the current
547 * dispatch window is still open and the caller should continue
548 * dispatching.
549 *
550 * If @force is %true, the dispatch timer is always scheduled and this
551 * function is guaranteed to return %true. This is to be used when the
552 * caller can't dispatch itself and needs to invoke pending_timer
553 * unconditionally. Note that forced scheduling is likely to induce short
554 * delay before dispatch starts even if @sq->first_pending_disptime is not
555 * in the future and thus shouldn't be used in hot paths.
556 */
557static bool throtl_schedule_next_dispatch(struct throtl_service_queue *sq,
558 bool force)
Vivek Goyale43473b2010-09-15 17:06:35 -0400559{
Tejun Heo6a525602013-05-14 13:52:32 -0700560 /* any pending children left? */
Tejun Heoc9e03322013-05-14 13:52:32 -0700561 if (!sq->nr_pending)
Tejun Heo7f52f982013-05-14 13:52:37 -0700562 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400563
Tejun Heoc9e03322013-05-14 13:52:32 -0700564 update_min_dispatch_time(sq);
Vivek Goyale43473b2010-09-15 17:06:35 -0400565
Tejun Heo69df0ab2013-05-14 13:52:36 -0700566 /* is the next dispatch time in the future? */
Tejun Heo7f52f982013-05-14 13:52:37 -0700567 if (force || time_after(sq->first_pending_disptime, jiffies)) {
Tejun Heo69df0ab2013-05-14 13:52:36 -0700568 throtl_schedule_pending_timer(sq, sq->first_pending_disptime);
Tejun Heo7f52f982013-05-14 13:52:37 -0700569 return true;
Tejun Heo69df0ab2013-05-14 13:52:36 -0700570 }
571
Tejun Heo7f52f982013-05-14 13:52:37 -0700572 /* tell the caller to continue dispatching */
573 return false;
Vivek Goyale43473b2010-09-15 17:06:35 -0400574}
575
Vivek Goyal32ee5bc2013-05-14 13:52:38 -0700576static inline void throtl_start_new_slice_with_credit(struct throtl_grp *tg,
577 bool rw, unsigned long start)
578{
579 tg->bytes_disp[rw] = 0;
580 tg->io_disp[rw] = 0;
581
582 /*
583 * Previous slice has expired. We must have trimmed it after last
584 * bio dispatch. That means since start of last slice, we never used
585 * that bandwidth. Do try to make use of that bandwidth while giving
586 * credit.
587 */
588 if (time_after_eq(start, tg->slice_start[rw]))
589 tg->slice_start[rw] = start;
590
591 tg->slice_end[rw] = jiffies + throtl_slice;
592 throtl_log(&tg->service_queue,
593 "[%c] new slice with credit start=%lu end=%lu jiffies=%lu",
594 rw == READ ? 'R' : 'W', tg->slice_start[rw],
595 tg->slice_end[rw], jiffies);
596}
597
Tejun Heo0f3457f2013-05-14 13:52:32 -0700598static inline void throtl_start_new_slice(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400599{
600 tg->bytes_disp[rw] = 0;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400601 tg->io_disp[rw] = 0;
Vivek Goyale43473b2010-09-15 17:06:35 -0400602 tg->slice_start[rw] = jiffies;
603 tg->slice_end[rw] = jiffies + throtl_slice;
Tejun Heofda6f272013-05-14 13:52:36 -0700604 throtl_log(&tg->service_queue,
605 "[%c] new slice start=%lu end=%lu jiffies=%lu",
606 rw == READ ? 'R' : 'W', tg->slice_start[rw],
607 tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400608}
609
Tejun Heo0f3457f2013-05-14 13:52:32 -0700610static inline void throtl_set_slice_end(struct throtl_grp *tg, bool rw,
611 unsigned long jiffy_end)
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100612{
613 tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
614}
615
Tejun Heo0f3457f2013-05-14 13:52:32 -0700616static inline void throtl_extend_slice(struct throtl_grp *tg, bool rw,
617 unsigned long jiffy_end)
Vivek Goyale43473b2010-09-15 17:06:35 -0400618{
619 tg->slice_end[rw] = roundup(jiffy_end, throtl_slice);
Tejun Heofda6f272013-05-14 13:52:36 -0700620 throtl_log(&tg->service_queue,
621 "[%c] extend slice start=%lu end=%lu jiffies=%lu",
622 rw == READ ? 'R' : 'W', tg->slice_start[rw],
623 tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400624}
625
626/* Determine if previously allocated or extended slice is complete or not */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700627static bool throtl_slice_used(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400628{
629 if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200630 return false;
Vivek Goyale43473b2010-09-15 17:06:35 -0400631
632 return 1;
633}
634
635/* Trim the used slices and adjust slice start accordingly */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700636static inline void throtl_trim_slice(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400637{
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200638 unsigned long nr_slices, time_elapsed, io_trim;
639 u64 bytes_trim, tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400640
641 BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
642
643 /*
644 * If bps are unlimited (-1), then time slice don't get
645 * renewed. Don't try to trim the slice if slice is used. A new
646 * slice will start when appropriate.
647 */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700648 if (throtl_slice_used(tg, rw))
Vivek Goyale43473b2010-09-15 17:06:35 -0400649 return;
650
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100651 /*
652 * A bio has been dispatched. Also adjust slice_end. It might happen
653 * that initially cgroup limit was very low resulting in high
654 * slice_end, but later limit was bumped up and bio was dispached
655 * sooner, then we need to reduce slice_end. A high bogus slice_end
656 * is bad because it does not allow new slice to start.
657 */
658
Tejun Heo0f3457f2013-05-14 13:52:32 -0700659 throtl_set_slice_end(tg, rw, jiffies + throtl_slice);
Vivek Goyald1ae8ff2010-12-01 19:34:46 +0100660
Vivek Goyale43473b2010-09-15 17:06:35 -0400661 time_elapsed = jiffies - tg->slice_start[rw];
662
663 nr_slices = time_elapsed / throtl_slice;
664
665 if (!nr_slices)
666 return;
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200667 tmp = tg->bps[rw] * throtl_slice * nr_slices;
668 do_div(tmp, HZ);
669 bytes_trim = tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400670
Vivek Goyal8e89d132010-09-15 17:06:37 -0400671 io_trim = (tg->iops[rw] * throtl_slice * nr_slices)/HZ;
Vivek Goyale43473b2010-09-15 17:06:35 -0400672
Vivek Goyal8e89d132010-09-15 17:06:37 -0400673 if (!bytes_trim && !io_trim)
Vivek Goyale43473b2010-09-15 17:06:35 -0400674 return;
675
676 if (tg->bytes_disp[rw] >= bytes_trim)
677 tg->bytes_disp[rw] -= bytes_trim;
678 else
679 tg->bytes_disp[rw] = 0;
680
Vivek Goyal8e89d132010-09-15 17:06:37 -0400681 if (tg->io_disp[rw] >= io_trim)
682 tg->io_disp[rw] -= io_trim;
683 else
684 tg->io_disp[rw] = 0;
685
Vivek Goyale43473b2010-09-15 17:06:35 -0400686 tg->slice_start[rw] += nr_slices * throtl_slice;
687
Tejun Heofda6f272013-05-14 13:52:36 -0700688 throtl_log(&tg->service_queue,
689 "[%c] trim slice nr=%lu bytes=%llu io=%lu start=%lu end=%lu jiffies=%lu",
690 rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
691 tg->slice_start[rw], tg->slice_end[rw], jiffies);
Vivek Goyale43473b2010-09-15 17:06:35 -0400692}
693
Tejun Heo0f3457f2013-05-14 13:52:32 -0700694static bool tg_with_in_iops_limit(struct throtl_grp *tg, struct bio *bio,
695 unsigned long *wait)
Vivek Goyale43473b2010-09-15 17:06:35 -0400696{
697 bool rw = bio_data_dir(bio);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400698 unsigned int io_allowed;
Vivek Goyale43473b2010-09-15 17:06:35 -0400699 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
Vivek Goyalc49c06e2010-10-01 21:16:42 +0200700 u64 tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400701
Vivek Goyal8e89d132010-09-15 17:06:37 -0400702 jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
Vivek Goyale43473b2010-09-15 17:06:35 -0400703
Vivek Goyal8e89d132010-09-15 17:06:37 -0400704 /* Slice has just started. Consider one slice interval */
705 if (!jiffy_elapsed)
706 jiffy_elapsed_rnd = throtl_slice;
707
708 jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
709
Vivek Goyalc49c06e2010-10-01 21:16:42 +0200710 /*
711 * jiffy_elapsed_rnd should not be a big value as minimum iops can be
712 * 1 then at max jiffy elapsed should be equivalent of 1 second as we
713 * will allow dispatch after 1 second and after that slice should
714 * have been trimmed.
715 */
716
717 tmp = (u64)tg->iops[rw] * jiffy_elapsed_rnd;
718 do_div(tmp, HZ);
719
720 if (tmp > UINT_MAX)
721 io_allowed = UINT_MAX;
722 else
723 io_allowed = tmp;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400724
725 if (tg->io_disp[rw] + 1 <= io_allowed) {
Vivek Goyale43473b2010-09-15 17:06:35 -0400726 if (wait)
727 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200728 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400729 }
730
Vivek Goyal8e89d132010-09-15 17:06:37 -0400731 /* Calc approx time to dispatch */
732 jiffy_wait = ((tg->io_disp[rw] + 1) * HZ)/tg->iops[rw] + 1;
733
734 if (jiffy_wait > jiffy_elapsed)
735 jiffy_wait = jiffy_wait - jiffy_elapsed;
736 else
737 jiffy_wait = 1;
738
739 if (wait)
740 *wait = jiffy_wait;
741 return 0;
742}
743
Tejun Heo0f3457f2013-05-14 13:52:32 -0700744static bool tg_with_in_bps_limit(struct throtl_grp *tg, struct bio *bio,
745 unsigned long *wait)
Vivek Goyal8e89d132010-09-15 17:06:37 -0400746{
747 bool rw = bio_data_dir(bio);
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200748 u64 bytes_allowed, extra_bytes, tmp;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400749 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
Vivek Goyale43473b2010-09-15 17:06:35 -0400750
751 jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
752
753 /* Slice has just started. Consider one slice interval */
754 if (!jiffy_elapsed)
755 jiffy_elapsed_rnd = throtl_slice;
756
757 jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, throtl_slice);
758
Vivek Goyal5e901a22010-10-01 21:16:38 +0200759 tmp = tg->bps[rw] * jiffy_elapsed_rnd;
760 do_div(tmp, HZ);
Vivek Goyal3aad5d32010-10-01 14:51:14 +0200761 bytes_allowed = tmp;
Vivek Goyale43473b2010-09-15 17:06:35 -0400762
Kent Overstreet4f024f32013-10-11 15:44:27 -0700763 if (tg->bytes_disp[rw] + bio->bi_iter.bi_size <= bytes_allowed) {
Vivek Goyale43473b2010-09-15 17:06:35 -0400764 if (wait)
765 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200766 return true;
Vivek Goyale43473b2010-09-15 17:06:35 -0400767 }
768
769 /* Calc approx time to dispatch */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700770 extra_bytes = tg->bytes_disp[rw] + bio->bi_iter.bi_size - bytes_allowed;
Vivek Goyale43473b2010-09-15 17:06:35 -0400771 jiffy_wait = div64_u64(extra_bytes * HZ, tg->bps[rw]);
772
773 if (!jiffy_wait)
774 jiffy_wait = 1;
775
776 /*
777 * This wait time is without taking into consideration the rounding
778 * up we did. Add that time also.
779 */
780 jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
Vivek Goyale43473b2010-09-15 17:06:35 -0400781 if (wait)
782 *wait = jiffy_wait;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400783 return 0;
784}
Vivek Goyale43473b2010-09-15 17:06:35 -0400785
Vivek Goyal8e89d132010-09-15 17:06:37 -0400786/*
787 * Returns whether one can dispatch a bio or not. Also returns approx number
788 * of jiffies to wait before this bio is with-in IO rate and can be dispatched
789 */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700790static bool tg_may_dispatch(struct throtl_grp *tg, struct bio *bio,
791 unsigned long *wait)
Vivek Goyal8e89d132010-09-15 17:06:37 -0400792{
793 bool rw = bio_data_dir(bio);
794 unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
795
796 /*
797 * Currently whole state machine of group depends on first bio
798 * queued in the group bio list. So one should not be calling
799 * this function with a different bio if there are other bios
800 * queued.
801 */
Tejun Heo73f0d492013-05-14 13:52:35 -0700802 BUG_ON(tg->service_queue.nr_queued[rw] &&
Tejun Heoc5cc2072013-05-14 13:52:38 -0700803 bio != throtl_peek_queued(&tg->service_queue.queued[rw]));
Vivek Goyal8e89d132010-09-15 17:06:37 -0400804
805 /* If tg->bps = -1, then BW is unlimited */
806 if (tg->bps[rw] == -1 && tg->iops[rw] == -1) {
807 if (wait)
808 *wait = 0;
Fabian Frederick5cf8c222014-05-02 18:28:17 +0200809 return true;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400810 }
811
812 /*
813 * If previous slice expired, start a new one otherwise renew/extend
814 * existing slice to make sure it is at least throtl_slice interval
815 * long since now.
816 */
Tejun Heo0f3457f2013-05-14 13:52:32 -0700817 if (throtl_slice_used(tg, rw))
818 throtl_start_new_slice(tg, rw);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400819 else {
820 if (time_before(tg->slice_end[rw], jiffies + throtl_slice))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700821 throtl_extend_slice(tg, rw, jiffies + throtl_slice);
Vivek Goyal8e89d132010-09-15 17:06:37 -0400822 }
823
Tejun Heo0f3457f2013-05-14 13:52:32 -0700824 if (tg_with_in_bps_limit(tg, bio, &bps_wait) &&
825 tg_with_in_iops_limit(tg, bio, &iops_wait)) {
Vivek Goyal8e89d132010-09-15 17:06:37 -0400826 if (wait)
827 *wait = 0;
828 return 1;
829 }
830
831 max_wait = max(bps_wait, iops_wait);
832
833 if (wait)
834 *wait = max_wait;
835
836 if (time_before(tg->slice_end[rw], jiffies + max_wait))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700837 throtl_extend_slice(tg, rw, jiffies + max_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -0400838
839 return 0;
840}
841
Tejun Heo3c798392012-04-16 13:57:25 -0700842static void throtl_update_dispatch_stats(struct blkcg_gq *blkg, u64 bytes,
Tejun Heo629ed0b2012-04-01 14:38:44 -0700843 int rw)
844{
Tejun Heo8a3d2612012-04-01 14:38:44 -0700845 struct throtl_grp *tg = blkg_to_tg(blkg);
Tejun Heo629ed0b2012-04-01 14:38:44 -0700846 unsigned long flags;
847
Tejun Heo629ed0b2012-04-01 14:38:44 -0700848 /*
849 * Disabling interrupts to provide mutual exclusion between two
850 * writes on same cpu. It probably is not needed for 64bit. Not
851 * optimizing that case yet.
852 */
853 local_irq_save(flags);
854
Tejun Heo24bdb8e2015-08-18 14:55:22 -0700855 blkg_rwstat_add(&tg->serviced, rw, 1);
856 blkg_rwstat_add(&tg->service_bytes, rw, bytes);
Tejun Heo629ed0b2012-04-01 14:38:44 -0700857
858 local_irq_restore(flags);
859}
860
Vivek Goyale43473b2010-09-15 17:06:35 -0400861static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
862{
863 bool rw = bio_data_dir(bio);
Vivek Goyale43473b2010-09-15 17:06:35 -0400864
865 /* Charge the bio to the group */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700866 tg->bytes_disp[rw] += bio->bi_iter.bi_size;
Vivek Goyal8e89d132010-09-15 17:06:37 -0400867 tg->io_disp[rw]++;
Vivek Goyale43473b2010-09-15 17:06:35 -0400868
Tejun Heo2a0f61e2013-05-14 13:52:36 -0700869 /*
870 * REQ_THROTTLED is used to prevent the same bio to be throttled
871 * more than once as a throttled bio will go through blk-throtl the
872 * second time when it eventually gets issued. Set it when a bio
873 * is being charged to a tg.
874 *
875 * Dispatch stats aren't recursive and each @bio should only be
876 * accounted by the @tg it was originally associated with. Let's
877 * update the stats when setting REQ_THROTTLED for the first time
878 * which is guaranteed to be for the @bio's original tg.
879 */
880 if (!(bio->bi_rw & REQ_THROTTLED)) {
881 bio->bi_rw |= REQ_THROTTLED;
Kent Overstreet4f024f32013-10-11 15:44:27 -0700882 throtl_update_dispatch_stats(tg_to_blkg(tg),
883 bio->bi_iter.bi_size, bio->bi_rw);
Tejun Heo2a0f61e2013-05-14 13:52:36 -0700884 }
Vivek Goyale43473b2010-09-15 17:06:35 -0400885}
886
Tejun Heoc5cc2072013-05-14 13:52:38 -0700887/**
888 * throtl_add_bio_tg - add a bio to the specified throtl_grp
889 * @bio: bio to add
890 * @qn: qnode to use
891 * @tg: the target throtl_grp
892 *
893 * Add @bio to @tg's service_queue using @qn. If @qn is not specified,
894 * tg->qnode_on_self[] is used.
895 */
896static void throtl_add_bio_tg(struct bio *bio, struct throtl_qnode *qn,
897 struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400898{
Tejun Heo73f0d492013-05-14 13:52:35 -0700899 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -0400900 bool rw = bio_data_dir(bio);
901
Tejun Heoc5cc2072013-05-14 13:52:38 -0700902 if (!qn)
903 qn = &tg->qnode_on_self[rw];
904
Tejun Heo0e9f4162013-05-14 13:52:35 -0700905 /*
906 * If @tg doesn't currently have any bios queued in the same
907 * direction, queueing @bio can change when @tg should be
908 * dispatched. Mark that @tg was empty. This is automatically
909 * cleaered on the next tg_update_disptime().
910 */
911 if (!sq->nr_queued[rw])
912 tg->flags |= THROTL_TG_WAS_EMPTY;
913
Tejun Heoc5cc2072013-05-14 13:52:38 -0700914 throtl_qnode_add_bio(bio, qn, &sq->queued[rw]);
915
Tejun Heo73f0d492013-05-14 13:52:35 -0700916 sq->nr_queued[rw]++;
Tejun Heo77216b02013-05-14 13:52:36 -0700917 throtl_enqueue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400918}
919
Tejun Heo77216b02013-05-14 13:52:36 -0700920static void tg_update_disptime(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400921{
Tejun Heo73f0d492013-05-14 13:52:35 -0700922 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -0400923 unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
924 struct bio *bio;
925
Tejun Heoc5cc2072013-05-14 13:52:38 -0700926 if ((bio = throtl_peek_queued(&sq->queued[READ])))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700927 tg_may_dispatch(tg, bio, &read_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -0400928
Tejun Heoc5cc2072013-05-14 13:52:38 -0700929 if ((bio = throtl_peek_queued(&sq->queued[WRITE])))
Tejun Heo0f3457f2013-05-14 13:52:32 -0700930 tg_may_dispatch(tg, bio, &write_wait);
Vivek Goyale43473b2010-09-15 17:06:35 -0400931
932 min_wait = min(read_wait, write_wait);
933 disptime = jiffies + min_wait;
934
Vivek Goyale43473b2010-09-15 17:06:35 -0400935 /* Update dispatch time */
Tejun Heo77216b02013-05-14 13:52:36 -0700936 throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -0400937 tg->disptime = disptime;
Tejun Heo77216b02013-05-14 13:52:36 -0700938 throtl_enqueue_tg(tg);
Tejun Heo0e9f4162013-05-14 13:52:35 -0700939
940 /* see throtl_add_bio_tg() */
941 tg->flags &= ~THROTL_TG_WAS_EMPTY;
Vivek Goyale43473b2010-09-15 17:06:35 -0400942}
943
Vivek Goyal32ee5bc2013-05-14 13:52:38 -0700944static void start_parent_slice_with_credit(struct throtl_grp *child_tg,
945 struct throtl_grp *parent_tg, bool rw)
946{
947 if (throtl_slice_used(parent_tg, rw)) {
948 throtl_start_new_slice_with_credit(parent_tg, rw,
949 child_tg->slice_start[rw]);
950 }
951
952}
953
Tejun Heo77216b02013-05-14 13:52:36 -0700954static void tg_dispatch_one_bio(struct throtl_grp *tg, bool rw)
Vivek Goyale43473b2010-09-15 17:06:35 -0400955{
Tejun Heo73f0d492013-05-14 13:52:35 -0700956 struct throtl_service_queue *sq = &tg->service_queue;
Tejun Heo6bc9c2b2013-05-14 13:52:38 -0700957 struct throtl_service_queue *parent_sq = sq->parent_sq;
958 struct throtl_grp *parent_tg = sq_to_tg(parent_sq);
Tejun Heoc5cc2072013-05-14 13:52:38 -0700959 struct throtl_grp *tg_to_put = NULL;
Vivek Goyale43473b2010-09-15 17:06:35 -0400960 struct bio *bio;
961
Tejun Heoc5cc2072013-05-14 13:52:38 -0700962 /*
963 * @bio is being transferred from @tg to @parent_sq. Popping a bio
964 * from @tg may put its reference and @parent_sq might end up
965 * getting released prematurely. Remember the tg to put and put it
966 * after @bio is transferred to @parent_sq.
967 */
968 bio = throtl_pop_queued(&sq->queued[rw], &tg_to_put);
Tejun Heo73f0d492013-05-14 13:52:35 -0700969 sq->nr_queued[rw]--;
Vivek Goyale43473b2010-09-15 17:06:35 -0400970
971 throtl_charge_bio(tg, bio);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -0700972
973 /*
974 * If our parent is another tg, we just need to transfer @bio to
975 * the parent using throtl_add_bio_tg(). If our parent is
976 * @td->service_queue, @bio is ready to be issued. Put it on its
977 * bio_lists[] and decrease total number queued. The caller is
978 * responsible for issuing these bios.
979 */
980 if (parent_tg) {
Tejun Heoc5cc2072013-05-14 13:52:38 -0700981 throtl_add_bio_tg(bio, &tg->qnode_on_parent[rw], parent_tg);
Vivek Goyal32ee5bc2013-05-14 13:52:38 -0700982 start_parent_slice_with_credit(tg, parent_tg, rw);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -0700983 } else {
Tejun Heoc5cc2072013-05-14 13:52:38 -0700984 throtl_qnode_add_bio(bio, &tg->qnode_on_parent[rw],
985 &parent_sq->queued[rw]);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -0700986 BUG_ON(tg->td->nr_queued[rw] <= 0);
987 tg->td->nr_queued[rw]--;
988 }
Vivek Goyale43473b2010-09-15 17:06:35 -0400989
Tejun Heo0f3457f2013-05-14 13:52:32 -0700990 throtl_trim_slice(tg, rw);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -0700991
Tejun Heoc5cc2072013-05-14 13:52:38 -0700992 if (tg_to_put)
993 blkg_put(tg_to_blkg(tg_to_put));
Vivek Goyale43473b2010-09-15 17:06:35 -0400994}
995
Tejun Heo77216b02013-05-14 13:52:36 -0700996static int throtl_dispatch_tg(struct throtl_grp *tg)
Vivek Goyale43473b2010-09-15 17:06:35 -0400997{
Tejun Heo73f0d492013-05-14 13:52:35 -0700998 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -0400999 unsigned int nr_reads = 0, nr_writes = 0;
1000 unsigned int max_nr_reads = throtl_grp_quantum*3/4;
Vivek Goyalc2f68052010-11-15 19:32:42 +01001001 unsigned int max_nr_writes = throtl_grp_quantum - max_nr_reads;
Vivek Goyale43473b2010-09-15 17:06:35 -04001002 struct bio *bio;
1003
1004 /* Try to dispatch 75% READS and 25% WRITES */
1005
Tejun Heoc5cc2072013-05-14 13:52:38 -07001006 while ((bio = throtl_peek_queued(&sq->queued[READ])) &&
Tejun Heo0f3457f2013-05-14 13:52:32 -07001007 tg_may_dispatch(tg, bio, NULL)) {
Vivek Goyale43473b2010-09-15 17:06:35 -04001008
Tejun Heo77216b02013-05-14 13:52:36 -07001009 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Vivek Goyale43473b2010-09-15 17:06:35 -04001010 nr_reads++;
1011
1012 if (nr_reads >= max_nr_reads)
1013 break;
1014 }
1015
Tejun Heoc5cc2072013-05-14 13:52:38 -07001016 while ((bio = throtl_peek_queued(&sq->queued[WRITE])) &&
Tejun Heo0f3457f2013-05-14 13:52:32 -07001017 tg_may_dispatch(tg, bio, NULL)) {
Vivek Goyale43473b2010-09-15 17:06:35 -04001018
Tejun Heo77216b02013-05-14 13:52:36 -07001019 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Vivek Goyale43473b2010-09-15 17:06:35 -04001020 nr_writes++;
1021
1022 if (nr_writes >= max_nr_writes)
1023 break;
1024 }
1025
1026 return nr_reads + nr_writes;
1027}
1028
Tejun Heo651930b2013-05-14 13:52:35 -07001029static int throtl_select_dispatch(struct throtl_service_queue *parent_sq)
Vivek Goyale43473b2010-09-15 17:06:35 -04001030{
1031 unsigned int nr_disp = 0;
Vivek Goyale43473b2010-09-15 17:06:35 -04001032
1033 while (1) {
Tejun Heo73f0d492013-05-14 13:52:35 -07001034 struct throtl_grp *tg = throtl_rb_first(parent_sq);
1035 struct throtl_service_queue *sq = &tg->service_queue;
Vivek Goyale43473b2010-09-15 17:06:35 -04001036
1037 if (!tg)
1038 break;
1039
1040 if (time_before(jiffies, tg->disptime))
1041 break;
1042
Tejun Heo77216b02013-05-14 13:52:36 -07001043 throtl_dequeue_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001044
Tejun Heo77216b02013-05-14 13:52:36 -07001045 nr_disp += throtl_dispatch_tg(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001046
Tejun Heo73f0d492013-05-14 13:52:35 -07001047 if (sq->nr_queued[0] || sq->nr_queued[1])
Tejun Heo77216b02013-05-14 13:52:36 -07001048 tg_update_disptime(tg);
Vivek Goyale43473b2010-09-15 17:06:35 -04001049
1050 if (nr_disp >= throtl_quantum)
1051 break;
1052 }
1053
1054 return nr_disp;
1055}
1056
Tejun Heo6e1a5702013-05-14 13:52:37 -07001057/**
1058 * throtl_pending_timer_fn - timer function for service_queue->pending_timer
1059 * @arg: the throtl_service_queue being serviced
1060 *
1061 * This timer is armed when a child throtl_grp with active bio's become
1062 * pending and queued on the service_queue's pending_tree and expires when
1063 * the first child throtl_grp should be dispatched. This function
Tejun Heo2e48a532013-05-14 13:52:38 -07001064 * dispatches bio's from the children throtl_grps to the parent
1065 * service_queue.
1066 *
1067 * If the parent's parent is another throtl_grp, dispatching is propagated
1068 * by either arming its pending_timer or repeating dispatch directly. If
1069 * the top-level service_tree is reached, throtl_data->dispatch_work is
1070 * kicked so that the ready bio's are issued.
Tejun Heo6e1a5702013-05-14 13:52:37 -07001071 */
Tejun Heo69df0ab2013-05-14 13:52:36 -07001072static void throtl_pending_timer_fn(unsigned long arg)
1073{
1074 struct throtl_service_queue *sq = (void *)arg;
Tejun Heo2e48a532013-05-14 13:52:38 -07001075 struct throtl_grp *tg = sq_to_tg(sq);
Tejun Heo69df0ab2013-05-14 13:52:36 -07001076 struct throtl_data *td = sq_to_td(sq);
Tejun Heocb761992013-05-14 13:52:31 -07001077 struct request_queue *q = td->queue;
Tejun Heo2e48a532013-05-14 13:52:38 -07001078 struct throtl_service_queue *parent_sq;
1079 bool dispatched;
Tejun Heo6e1a5702013-05-14 13:52:37 -07001080 int ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04001081
1082 spin_lock_irq(q->queue_lock);
Tejun Heo2e48a532013-05-14 13:52:38 -07001083again:
1084 parent_sq = sq->parent_sq;
1085 dispatched = false;
Vivek Goyale43473b2010-09-15 17:06:35 -04001086
Tejun Heo7f52f982013-05-14 13:52:37 -07001087 while (true) {
1088 throtl_log(sq, "dispatch nr_queued=%u read=%u write=%u",
Tejun Heo2e48a532013-05-14 13:52:38 -07001089 sq->nr_queued[READ] + sq->nr_queued[WRITE],
1090 sq->nr_queued[READ], sq->nr_queued[WRITE]);
Vivek Goyale43473b2010-09-15 17:06:35 -04001091
Tejun Heo7f52f982013-05-14 13:52:37 -07001092 ret = throtl_select_dispatch(sq);
1093 if (ret) {
Tejun Heo7f52f982013-05-14 13:52:37 -07001094 throtl_log(sq, "bios disp=%u", ret);
1095 dispatched = true;
Tejun Heo651930b2013-05-14 13:52:35 -07001096 }
Vivek Goyale43473b2010-09-15 17:06:35 -04001097
Tejun Heo7f52f982013-05-14 13:52:37 -07001098 if (throtl_schedule_next_dispatch(sq, false))
1099 break;
1100
1101 /* this dispatch windows is still open, relax and repeat */
1102 spin_unlock_irq(q->queue_lock);
1103 cpu_relax();
1104 spin_lock_irq(q->queue_lock);
1105 }
Tejun Heo6a525602013-05-14 13:52:32 -07001106
Tejun Heo2e48a532013-05-14 13:52:38 -07001107 if (!dispatched)
1108 goto out_unlock;
Tejun Heo6e1a5702013-05-14 13:52:37 -07001109
Tejun Heo2e48a532013-05-14 13:52:38 -07001110 if (parent_sq) {
1111 /* @parent_sq is another throl_grp, propagate dispatch */
1112 if (tg->flags & THROTL_TG_WAS_EMPTY) {
1113 tg_update_disptime(tg);
1114 if (!throtl_schedule_next_dispatch(parent_sq, false)) {
1115 /* window is already open, repeat dispatching */
1116 sq = parent_sq;
1117 tg = sq_to_tg(sq);
1118 goto again;
1119 }
1120 }
1121 } else {
1122 /* reached the top-level, queue issueing */
1123 queue_work(kthrotld_workqueue, &td->dispatch_work);
1124 }
1125out_unlock:
Tejun Heo6e1a5702013-05-14 13:52:37 -07001126 spin_unlock_irq(q->queue_lock);
1127}
1128
1129/**
1130 * blk_throtl_dispatch_work_fn - work function for throtl_data->dispatch_work
1131 * @work: work item being executed
1132 *
1133 * This function is queued for execution when bio's reach the bio_lists[]
1134 * of throtl_data->service_queue. Those bio's are ready and issued by this
1135 * function.
1136 */
Fabian Frederick8876e142014-04-17 21:41:16 +02001137static void blk_throtl_dispatch_work_fn(struct work_struct *work)
Tejun Heo6e1a5702013-05-14 13:52:37 -07001138{
1139 struct throtl_data *td = container_of(work, struct throtl_data,
1140 dispatch_work);
1141 struct throtl_service_queue *td_sq = &td->service_queue;
1142 struct request_queue *q = td->queue;
1143 struct bio_list bio_list_on_stack;
1144 struct bio *bio;
1145 struct blk_plug plug;
1146 int rw;
1147
1148 bio_list_init(&bio_list_on_stack);
1149
1150 spin_lock_irq(q->queue_lock);
Tejun Heoc5cc2072013-05-14 13:52:38 -07001151 for (rw = READ; rw <= WRITE; rw++)
1152 while ((bio = throtl_pop_queued(&td_sq->queued[rw], NULL)))
1153 bio_list_add(&bio_list_on_stack, bio);
Vivek Goyale43473b2010-09-15 17:06:35 -04001154 spin_unlock_irq(q->queue_lock);
1155
Tejun Heo6e1a5702013-05-14 13:52:37 -07001156 if (!bio_list_empty(&bio_list_on_stack)) {
Vivek Goyal69d60eb2011-03-09 08:27:37 +01001157 blk_start_plug(&plug);
Vivek Goyale43473b2010-09-15 17:06:35 -04001158 while((bio = bio_list_pop(&bio_list_on_stack)))
1159 generic_make_request(bio);
Vivek Goyal69d60eb2011-03-09 08:27:37 +01001160 blk_finish_plug(&plug);
Vivek Goyale43473b2010-09-15 17:06:35 -04001161 }
Vivek Goyale43473b2010-09-15 17:06:35 -04001162}
1163
Tejun Heo24bdb8e2015-08-18 14:55:22 -07001164static int tg_print_rwstat(struct seq_file *sf, void *v)
Tejun Heo41b38b62012-04-01 14:38:44 -07001165{
Tejun Heo24bdb8e2015-08-18 14:55:22 -07001166 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), blkg_prfill_rwstat,
Tejun Heo2da8ca82013-12-05 12:28:04 -05001167 &blkcg_policy_throtl, seq_cft(sf)->private, true);
Tejun Heo41b38b62012-04-01 14:38:44 -07001168 return 0;
1169}
1170
Tejun Heof95a04a2012-04-16 13:57:26 -07001171static u64 tg_prfill_conf_u64(struct seq_file *sf, struct blkg_policy_data *pd,
1172 int off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001173{
Tejun Heof95a04a2012-04-16 13:57:26 -07001174 struct throtl_grp *tg = pd_to_tg(pd);
1175 u64 v = *(u64 *)((void *)tg + off);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001176
Tejun Heoaf133ce2012-04-01 14:38:44 -07001177 if (v == -1)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001178 return 0;
Tejun Heof95a04a2012-04-16 13:57:26 -07001179 return __blkg_prfill_u64(sf, pd, v);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001180}
1181
Tejun Heof95a04a2012-04-16 13:57:26 -07001182static u64 tg_prfill_conf_uint(struct seq_file *sf, struct blkg_policy_data *pd,
1183 int off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001184{
Tejun Heof95a04a2012-04-16 13:57:26 -07001185 struct throtl_grp *tg = pd_to_tg(pd);
1186 unsigned int v = *(unsigned int *)((void *)tg + off);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001187
1188 if (v == -1)
1189 return 0;
Tejun Heof95a04a2012-04-16 13:57:26 -07001190 return __blkg_prfill_u64(sf, pd, v);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001191}
1192
Tejun Heo2da8ca82013-12-05 12:28:04 -05001193static int tg_print_conf_u64(struct seq_file *sf, void *v)
Tejun Heoaf133ce2012-04-01 14:38:44 -07001194{
Tejun Heo2da8ca82013-12-05 12:28:04 -05001195 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_u64,
1196 &blkcg_policy_throtl, seq_cft(sf)->private, false);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001197 return 0;
1198}
1199
Tejun Heo2da8ca82013-12-05 12:28:04 -05001200static int tg_print_conf_uint(struct seq_file *sf, void *v)
Vivek Goyale43473b2010-09-15 17:06:35 -04001201{
Tejun Heo2da8ca82013-12-05 12:28:04 -05001202 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_uint,
1203 &blkcg_policy_throtl, seq_cft(sf)->private, false);
Tejun Heoaf133ce2012-04-01 14:38:44 -07001204 return 0;
Vivek Goyale43473b2010-09-15 17:06:35 -04001205}
1206
Tejun Heo451af502014-05-13 12:16:21 -04001207static ssize_t tg_set_conf(struct kernfs_open_file *of,
1208 char *buf, size_t nbytes, loff_t off, bool is_u64)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001209{
Tejun Heo451af502014-05-13 12:16:21 -04001210 struct blkcg *blkcg = css_to_blkcg(of_css(of));
Tejun Heo60c2bc22012-04-01 14:38:43 -07001211 struct blkg_conf_ctx ctx;
Tejun Heoaf133ce2012-04-01 14:38:44 -07001212 struct throtl_grp *tg;
Tejun Heo69df0ab2013-05-14 13:52:36 -07001213 struct throtl_service_queue *sq;
Tejun Heo693e7512013-05-14 13:52:38 -07001214 struct blkcg_gq *blkg;
Tejun Heo492eb212013-08-08 20:11:25 -04001215 struct cgroup_subsys_state *pos_css;
Tejun Heo60c2bc22012-04-01 14:38:43 -07001216 int ret;
1217
Tejun Heo3c798392012-04-16 13:57:25 -07001218 ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001219 if (ret)
1220 return ret;
1221
Tejun Heoaf133ce2012-04-01 14:38:44 -07001222 tg = blkg_to_tg(ctx.blkg);
Tejun Heo69df0ab2013-05-14 13:52:36 -07001223 sq = &tg->service_queue;
Tejun Heoaf133ce2012-04-01 14:38:44 -07001224
Tejun Heoa2b16932012-04-13 13:11:33 -07001225 if (!ctx.v)
1226 ctx.v = -1;
Tejun Heoaf133ce2012-04-01 14:38:44 -07001227
Tejun Heoa2b16932012-04-13 13:11:33 -07001228 if (is_u64)
Tejun Heo451af502014-05-13 12:16:21 -04001229 *(u64 *)((void *)tg + of_cft(of)->private) = ctx.v;
Tejun Heoa2b16932012-04-13 13:11:33 -07001230 else
Tejun Heo451af502014-05-13 12:16:21 -04001231 *(unsigned int *)((void *)tg + of_cft(of)->private) = ctx.v;
Tejun Heoaf133ce2012-04-01 14:38:44 -07001232
Tejun Heofda6f272013-05-14 13:52:36 -07001233 throtl_log(&tg->service_queue,
1234 "limit change rbps=%llu wbps=%llu riops=%u wiops=%u",
1235 tg->bps[READ], tg->bps[WRITE],
1236 tg->iops[READ], tg->iops[WRITE]);
Tejun Heo632b4492013-05-14 13:52:31 -07001237
1238 /*
Tejun Heo693e7512013-05-14 13:52:38 -07001239 * Update has_rules[] flags for the updated tg's subtree. A tg is
1240 * considered to have rules if either the tg itself or any of its
1241 * ancestors has rules. This identifies groups without any
1242 * restrictions in the whole hierarchy and allows them to bypass
1243 * blk-throttle.
1244 */
Tejun Heo492eb212013-08-08 20:11:25 -04001245 blkg_for_each_descendant_pre(blkg, pos_css, ctx.blkg)
Tejun Heo693e7512013-05-14 13:52:38 -07001246 tg_update_has_rules(blkg_to_tg(blkg));
1247
1248 /*
Tejun Heo632b4492013-05-14 13:52:31 -07001249 * We're already holding queue_lock and know @tg is valid. Let's
1250 * apply the new config directly.
1251 *
1252 * Restart the slices for both READ and WRITES. It might happen
1253 * that a group's limit are dropped suddenly and we don't want to
1254 * account recently dispatched IO with new low rate.
1255 */
Tejun Heo0f3457f2013-05-14 13:52:32 -07001256 throtl_start_new_slice(tg, 0);
1257 throtl_start_new_slice(tg, 1);
Tejun Heo632b4492013-05-14 13:52:31 -07001258
Tejun Heo5b2c16a2013-05-14 13:52:32 -07001259 if (tg->flags & THROTL_TG_PENDING) {
Tejun Heo77216b02013-05-14 13:52:36 -07001260 tg_update_disptime(tg);
Tejun Heo7f52f982013-05-14 13:52:37 -07001261 throtl_schedule_next_dispatch(sq->parent_sq, true);
Tejun Heo632b4492013-05-14 13:52:31 -07001262 }
Tejun Heo60c2bc22012-04-01 14:38:43 -07001263
1264 blkg_conf_finish(&ctx);
Tejun Heo451af502014-05-13 12:16:21 -04001265 return nbytes;
Tejun Heo60c2bc22012-04-01 14:38:43 -07001266}
1267
Tejun Heo451af502014-05-13 12:16:21 -04001268static ssize_t tg_set_conf_u64(struct kernfs_open_file *of,
1269 char *buf, size_t nbytes, loff_t off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001270{
Tejun Heo451af502014-05-13 12:16:21 -04001271 return tg_set_conf(of, buf, nbytes, off, true);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001272}
1273
Tejun Heo451af502014-05-13 12:16:21 -04001274static ssize_t tg_set_conf_uint(struct kernfs_open_file *of,
1275 char *buf, size_t nbytes, loff_t off)
Tejun Heo60c2bc22012-04-01 14:38:43 -07001276{
Tejun Heo451af502014-05-13 12:16:21 -04001277 return tg_set_conf(of, buf, nbytes, off, false);
Tejun Heo60c2bc22012-04-01 14:38:43 -07001278}
1279
1280static struct cftype throtl_files[] = {
1281 {
1282 .name = "throttle.read_bps_device",
Tejun Heoaf133ce2012-04-01 14:38:44 -07001283 .private = offsetof(struct throtl_grp, bps[READ]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001284 .seq_show = tg_print_conf_u64,
Tejun Heo451af502014-05-13 12:16:21 -04001285 .write = tg_set_conf_u64,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001286 },
1287 {
1288 .name = "throttle.write_bps_device",
Tejun Heoaf133ce2012-04-01 14:38:44 -07001289 .private = offsetof(struct throtl_grp, bps[WRITE]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001290 .seq_show = tg_print_conf_u64,
Tejun Heo451af502014-05-13 12:16:21 -04001291 .write = tg_set_conf_u64,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001292 },
1293 {
1294 .name = "throttle.read_iops_device",
Tejun Heoaf133ce2012-04-01 14:38:44 -07001295 .private = offsetof(struct throtl_grp, iops[READ]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001296 .seq_show = tg_print_conf_uint,
Tejun Heo451af502014-05-13 12:16:21 -04001297 .write = tg_set_conf_uint,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001298 },
1299 {
1300 .name = "throttle.write_iops_device",
Tejun Heoaf133ce2012-04-01 14:38:44 -07001301 .private = offsetof(struct throtl_grp, iops[WRITE]),
Tejun Heo2da8ca82013-12-05 12:28:04 -05001302 .seq_show = tg_print_conf_uint,
Tejun Heo451af502014-05-13 12:16:21 -04001303 .write = tg_set_conf_uint,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001304 },
1305 {
1306 .name = "throttle.io_service_bytes",
Tejun Heo24bdb8e2015-08-18 14:55:22 -07001307 .private = offsetof(struct throtl_grp, service_bytes),
1308 .seq_show = tg_print_rwstat,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001309 },
1310 {
1311 .name = "throttle.io_serviced",
Tejun Heo24bdb8e2015-08-18 14:55:22 -07001312 .private = offsetof(struct throtl_grp, serviced),
1313 .seq_show = tg_print_rwstat,
Tejun Heo60c2bc22012-04-01 14:38:43 -07001314 },
1315 { } /* terminate */
1316};
1317
Vivek Goyalda527772011-03-02 19:05:33 -05001318static void throtl_shutdown_wq(struct request_queue *q)
Vivek Goyale43473b2010-09-15 17:06:35 -04001319{
1320 struct throtl_data *td = q->td;
1321
Tejun Heo69df0ab2013-05-14 13:52:36 -07001322 cancel_work_sync(&td->dispatch_work);
Vivek Goyale43473b2010-09-15 17:06:35 -04001323}
1324
Tejun Heo3c798392012-04-16 13:57:25 -07001325static struct blkcg_policy blkcg_policy_throtl = {
Tejun Heof9fcc2d2012-04-16 13:57:27 -07001326 .cftypes = throtl_files,
1327
Tejun Heo001bea72015-08-18 14:55:11 -07001328 .pd_alloc_fn = throtl_pd_alloc,
Tejun Heof9fcc2d2012-04-16 13:57:27 -07001329 .pd_init_fn = throtl_pd_init,
Tejun Heo693e7512013-05-14 13:52:38 -07001330 .pd_online_fn = throtl_pd_online,
Tejun Heo001bea72015-08-18 14:55:11 -07001331 .pd_free_fn = throtl_pd_free,
Tejun Heof9fcc2d2012-04-16 13:57:27 -07001332 .pd_reset_stats_fn = throtl_pd_reset_stats,
Vivek Goyale43473b2010-09-15 17:06:35 -04001333};
1334
Tejun Heoae118892015-08-18 14:55:20 -07001335bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
1336 struct bio *bio)
Vivek Goyale43473b2010-09-15 17:06:35 -04001337{
Tejun Heoc5cc2072013-05-14 13:52:38 -07001338 struct throtl_qnode *qn = NULL;
Tejun Heoae118892015-08-18 14:55:20 -07001339 struct throtl_grp *tg = blkg_to_tg(blkg ?: q->root_blkg);
Tejun Heo73f0d492013-05-14 13:52:35 -07001340 struct throtl_service_queue *sq;
Tejun Heo0e9f4162013-05-14 13:52:35 -07001341 bool rw = bio_data_dir(bio);
Tejun Heobc16a4f2011-10-19 14:33:01 +02001342 bool throttled = false;
Vivek Goyale43473b2010-09-15 17:06:35 -04001343
Tejun Heoae118892015-08-18 14:55:20 -07001344 WARN_ON_ONCE(!rcu_read_lock_held());
1345
Tejun Heo2a0f61e2013-05-14 13:52:36 -07001346 /* see throtl_charge_bio() */
Tejun Heoae118892015-08-18 14:55:20 -07001347 if ((bio->bi_rw & REQ_THROTTLED) || !tg->has_rules[rw])
Tejun Heobc16a4f2011-10-19 14:33:01 +02001348 goto out;
Vivek Goyale43473b2010-09-15 17:06:35 -04001349
1350 spin_lock_irq(q->queue_lock);
Tejun Heoc9589f02015-08-18 14:55:19 -07001351
1352 if (unlikely(blk_queue_bypass(q)))
Tejun Heobc16a4f2011-10-19 14:33:01 +02001353 goto out_unlock;
Vivek Goyalf469a7b2011-05-19 15:38:23 -04001354
Tejun Heo73f0d492013-05-14 13:52:35 -07001355 sq = &tg->service_queue;
1356
Tejun Heo9e660ac2013-05-14 13:52:38 -07001357 while (true) {
1358 /* throtl is FIFO - if bios are already queued, should queue */
1359 if (sq->nr_queued[rw])
1360 break;
Vivek Goyalde701c72011-03-07 21:09:32 +01001361
Tejun Heo9e660ac2013-05-14 13:52:38 -07001362 /* if above limits, break to queue */
1363 if (!tg_may_dispatch(tg, bio, NULL))
1364 break;
1365
1366 /* within limits, let's charge and dispatch directly */
Vivek Goyale43473b2010-09-15 17:06:35 -04001367 throtl_charge_bio(tg, bio);
Vivek Goyal04521db2011-03-22 21:54:29 +01001368
1369 /*
1370 * We need to trim slice even when bios are not being queued
1371 * otherwise it might happen that a bio is not queued for
1372 * a long time and slice keeps on extending and trim is not
1373 * called for a long time. Now if limits are reduced suddenly
1374 * we take into account all the IO dispatched so far at new
1375 * low rate and * newly queued IO gets a really long dispatch
1376 * time.
1377 *
1378 * So keep on trimming slice even if bio is not queued.
1379 */
Tejun Heo0f3457f2013-05-14 13:52:32 -07001380 throtl_trim_slice(tg, rw);
Tejun Heo9e660ac2013-05-14 13:52:38 -07001381
1382 /*
1383 * @bio passed through this layer without being throttled.
1384 * Climb up the ladder. If we''re already at the top, it
1385 * can be executed directly.
1386 */
Tejun Heoc5cc2072013-05-14 13:52:38 -07001387 qn = &tg->qnode_on_parent[rw];
Tejun Heo9e660ac2013-05-14 13:52:38 -07001388 sq = sq->parent_sq;
1389 tg = sq_to_tg(sq);
1390 if (!tg)
1391 goto out_unlock;
Vivek Goyale43473b2010-09-15 17:06:35 -04001392 }
1393
Tejun Heo9e660ac2013-05-14 13:52:38 -07001394 /* out-of-limit, queue to @tg */
Tejun Heofda6f272013-05-14 13:52:36 -07001395 throtl_log(sq, "[%c] bio. bdisp=%llu sz=%u bps=%llu iodisp=%u iops=%u queued=%d/%d",
1396 rw == READ ? 'R' : 'W',
Kent Overstreet4f024f32013-10-11 15:44:27 -07001397 tg->bytes_disp[rw], bio->bi_iter.bi_size, tg->bps[rw],
Tejun Heofda6f272013-05-14 13:52:36 -07001398 tg->io_disp[rw], tg->iops[rw],
1399 sq->nr_queued[READ], sq->nr_queued[WRITE]);
Vivek Goyale43473b2010-09-15 17:06:35 -04001400
Tejun Heo671058f2012-03-05 13:15:29 -08001401 bio_associate_current(bio);
Tejun Heo6bc9c2b2013-05-14 13:52:38 -07001402 tg->td->nr_queued[rw]++;
Tejun Heoc5cc2072013-05-14 13:52:38 -07001403 throtl_add_bio_tg(bio, qn, tg);
Tejun Heobc16a4f2011-10-19 14:33:01 +02001404 throttled = true;
Vivek Goyale43473b2010-09-15 17:06:35 -04001405
Tejun Heo7f52f982013-05-14 13:52:37 -07001406 /*
1407 * Update @tg's dispatch time and force schedule dispatch if @tg
1408 * was empty before @bio. The forced scheduling isn't likely to
1409 * cause undue delay as @bio is likely to be dispatched directly if
1410 * its @tg's disptime is not in the future.
1411 */
Tejun Heo0e9f4162013-05-14 13:52:35 -07001412 if (tg->flags & THROTL_TG_WAS_EMPTY) {
Tejun Heo77216b02013-05-14 13:52:36 -07001413 tg_update_disptime(tg);
Tejun Heo7f52f982013-05-14 13:52:37 -07001414 throtl_schedule_next_dispatch(tg->service_queue.parent_sq, true);
Vivek Goyale43473b2010-09-15 17:06:35 -04001415 }
1416
Tejun Heobc16a4f2011-10-19 14:33:01 +02001417out_unlock:
Vivek Goyale43473b2010-09-15 17:06:35 -04001418 spin_unlock_irq(q->queue_lock);
Tejun Heobc16a4f2011-10-19 14:33:01 +02001419out:
Tejun Heo2a0f61e2013-05-14 13:52:36 -07001420 /*
1421 * As multiple blk-throtls may stack in the same issue path, we
1422 * don't want bios to leave with the flag set. Clear the flag if
1423 * being issued.
1424 */
1425 if (!throttled)
1426 bio->bi_rw &= ~REQ_THROTTLED;
Tejun Heobc16a4f2011-10-19 14:33:01 +02001427 return throttled;
Vivek Goyale43473b2010-09-15 17:06:35 -04001428}
1429
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001430/*
1431 * Dispatch all bios from all children tg's queued on @parent_sq. On
1432 * return, @parent_sq is guaranteed to not have any active children tg's
1433 * and all bios from previously active tg's are on @parent_sq->bio_lists[].
1434 */
1435static void tg_drain_bios(struct throtl_service_queue *parent_sq)
1436{
1437 struct throtl_grp *tg;
1438
1439 while ((tg = throtl_rb_first(parent_sq))) {
1440 struct throtl_service_queue *sq = &tg->service_queue;
1441 struct bio *bio;
1442
1443 throtl_dequeue_tg(tg);
1444
Tejun Heoc5cc2072013-05-14 13:52:38 -07001445 while ((bio = throtl_peek_queued(&sq->queued[READ])))
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001446 tg_dispatch_one_bio(tg, bio_data_dir(bio));
Tejun Heoc5cc2072013-05-14 13:52:38 -07001447 while ((bio = throtl_peek_queued(&sq->queued[WRITE])))
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001448 tg_dispatch_one_bio(tg, bio_data_dir(bio));
1449 }
1450}
1451
Tejun Heoc9a929d2011-10-19 14:42:16 +02001452/**
1453 * blk_throtl_drain - drain throttled bios
1454 * @q: request_queue to drain throttled bios for
1455 *
1456 * Dispatch all currently throttled bios on @q through ->make_request_fn().
1457 */
1458void blk_throtl_drain(struct request_queue *q)
1459 __releases(q->queue_lock) __acquires(q->queue_lock)
1460{
1461 struct throtl_data *td = q->td;
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001462 struct blkcg_gq *blkg;
Tejun Heo492eb212013-08-08 20:11:25 -04001463 struct cgroup_subsys_state *pos_css;
Tejun Heoc9a929d2011-10-19 14:42:16 +02001464 struct bio *bio;
Tejun Heo651930b2013-05-14 13:52:35 -07001465 int rw;
Tejun Heoc9a929d2011-10-19 14:42:16 +02001466
Andi Kleen8bcb6c72012-03-30 12:33:28 +02001467 queue_lockdep_assert_held(q);
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001468 rcu_read_lock();
Tejun Heoc9a929d2011-10-19 14:42:16 +02001469
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001470 /*
1471 * Drain each tg while doing post-order walk on the blkg tree, so
1472 * that all bios are propagated to td->service_queue. It'd be
1473 * better to walk service_queue tree directly but blkg walk is
1474 * easier.
1475 */
Tejun Heo492eb212013-08-08 20:11:25 -04001476 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg)
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001477 tg_drain_bios(&blkg_to_tg(blkg)->service_queue);
Tejun Heo73f0d492013-05-14 13:52:35 -07001478
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001479 /* finally, transfer bios from top-level tg's into the td */
1480 tg_drain_bios(&td->service_queue);
1481
1482 rcu_read_unlock();
Tejun Heoc9a929d2011-10-19 14:42:16 +02001483 spin_unlock_irq(q->queue_lock);
1484
Tejun Heo2a12f0d2013-05-14 13:52:37 -07001485 /* all bios now should be in td->service_queue, issue them */
Tejun Heo651930b2013-05-14 13:52:35 -07001486 for (rw = READ; rw <= WRITE; rw++)
Tejun Heoc5cc2072013-05-14 13:52:38 -07001487 while ((bio = throtl_pop_queued(&td->service_queue.queued[rw],
1488 NULL)))
Tejun Heo651930b2013-05-14 13:52:35 -07001489 generic_make_request(bio);
Tejun Heoc9a929d2011-10-19 14:42:16 +02001490
1491 spin_lock_irq(q->queue_lock);
1492}
1493
Vivek Goyale43473b2010-09-15 17:06:35 -04001494int blk_throtl_init(struct request_queue *q)
1495{
1496 struct throtl_data *td;
Tejun Heoa2b16932012-04-13 13:11:33 -07001497 int ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04001498
1499 td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
1500 if (!td)
1501 return -ENOMEM;
1502
Tejun Heo69df0ab2013-05-14 13:52:36 -07001503 INIT_WORK(&td->dispatch_work, blk_throtl_dispatch_work_fn);
Tejun Heob2ce2642015-08-18 14:55:13 -07001504 throtl_service_queue_init(&td->service_queue);
Vivek Goyale43473b2010-09-15 17:06:35 -04001505
Tejun Heocd1604f2012-03-05 13:15:06 -08001506 q->td = td;
Vivek Goyal29b12582011-05-19 15:38:24 -04001507 td->queue = q;
Vivek Goyal02977e42010-10-01 14:49:48 +02001508
Tejun Heoa2b16932012-04-13 13:11:33 -07001509 /* activate policy */
Tejun Heo3c798392012-04-16 13:57:25 -07001510 ret = blkcg_activate_policy(q, &blkcg_policy_throtl);
Tejun Heoa2b16932012-04-13 13:11:33 -07001511 if (ret)
Vivek Goyal29b12582011-05-19 15:38:24 -04001512 kfree(td);
Tejun Heoa2b16932012-04-13 13:11:33 -07001513 return ret;
Vivek Goyale43473b2010-09-15 17:06:35 -04001514}
1515
1516void blk_throtl_exit(struct request_queue *q)
1517{
Tejun Heoc875f4d2012-03-05 13:15:22 -08001518 BUG_ON(!q->td);
Vivek Goyalda527772011-03-02 19:05:33 -05001519 throtl_shutdown_wq(q);
Tejun Heo3c798392012-04-16 13:57:25 -07001520 blkcg_deactivate_policy(q, &blkcg_policy_throtl);
Tejun Heoc9a929d2011-10-19 14:42:16 +02001521 kfree(q->td);
Vivek Goyale43473b2010-09-15 17:06:35 -04001522}
1523
1524static int __init throtl_init(void)
1525{
Vivek Goyal450adcb2011-03-01 13:40:54 -05001526 kthrotld_workqueue = alloc_workqueue("kthrotld", WQ_MEM_RECLAIM, 0);
1527 if (!kthrotld_workqueue)
1528 panic("Failed to create kthrotld\n");
1529
Tejun Heo3c798392012-04-16 13:57:25 -07001530 return blkcg_policy_register(&blkcg_policy_throtl);
Vivek Goyale43473b2010-09-15 17:06:35 -04001531}
1532
1533module_init(throtl_init);