]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - block/blk-throttle.c
drm/shmem-helper: Remove errant put in error path
[mirror_ubuntu-jammy-kernel.git] / block / blk-throttle.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
e43473b7
VG
2/*
3 * Interface for controlling IO bandwidth on a request queue
4 *
5 * Copyright (C) 2010 Vivek Goyal <vgoyal@redhat.com>
6 */
7
8#include <linux/module.h>
9#include <linux/slab.h>
10#include <linux/blkdev.h>
11#include <linux/bio.h>
12#include <linux/blktrace_api.h>
eea8f41c 13#include <linux/blk-cgroup.h>
bc9fcbf9 14#include "blk.h"
1d156646 15#include "blk-cgroup-rwstat.h"
e43473b7
VG
16
17/* Max dispatch from a group in 1 round */
e675df2a 18#define THROTL_GRP_QUANTUM 8
e43473b7
VG
19
20/* Total max dispatch from all groups in one round */
e675df2a 21#define THROTL_QUANTUM 32
e43473b7 22
d61fcfa4
SL
23/* Throttling is performed over a slice and after that slice is renewed */
24#define DFL_THROTL_SLICE_HD (HZ / 10)
25#define DFL_THROTL_SLICE_SSD (HZ / 50)
297e3d85 26#define MAX_THROTL_SLICE (HZ)
9e234eea 27#define MAX_IDLE_TIME (5L * 1000 * 1000) /* 5 s */
9bb67aeb
SL
28#define MIN_THROTL_BPS (320 * 1024)
29#define MIN_THROTL_IOPS (10)
b4f428ef
SL
30#define DFL_LATENCY_TARGET (-1L)
31#define DFL_IDLE_THRESHOLD (0)
6679a90c
SL
32#define DFL_HD_BASELINE_LATENCY (4000L) /* 4ms */
33#define LATENCY_FILTERED_SSD (0)
34/*
35 * For HD, very small latency comes from sequential IO. Such IO is helpless to
36 * help determine if its IO is impacted by others, hence we ignore the IO
37 */
38#define LATENCY_FILTERED_HD (1000L) /* 1ms */
e43473b7 39
3c798398 40static struct blkcg_policy blkcg_policy_throtl;
0381411e 41
450adcbe
VG
42/* A workqueue to queue throttle related work */
43static struct workqueue_struct *kthrotld_workqueue;
450adcbe 44
c5cc2070
TH
45/*
46 * To implement hierarchical throttling, throtl_grps form a tree and bios
47 * are dispatched upwards level by level until they reach the top and get
48 * issued. When dispatching bios from the children and local group at each
49 * level, if the bios are dispatched into a single bio_list, there's a risk
50 * of a local or child group which can queue many bios at once filling up
51 * the list starving others.
52 *
53 * To avoid such starvation, dispatched bios are queued separately
54 * according to where they came from. When they are again dispatched to
55 * the parent, they're popped in round-robin order so that no single source
56 * hogs the dispatch window.
57 *
58 * throtl_qnode is used to keep the queued bios separated by their sources.
59 * Bios are queued to throtl_qnode which in turn is queued to
60 * throtl_service_queue and then dispatched in round-robin order.
61 *
62 * It's also used to track the reference counts on blkg's. A qnode always
63 * belongs to a throtl_grp and gets queued on itself or the parent, so
64 * incrementing the reference of the associated throtl_grp when a qnode is
65 * queued and decrementing when dequeued is enough to keep the whole blkg
66 * tree pinned while bios are in flight.
67 */
68struct throtl_qnode {
69 struct list_head node; /* service_queue->queued[] */
70 struct bio_list bios; /* queued bios */
71 struct throtl_grp *tg; /* tg this qnode belongs to */
72};
73
c9e0332e 74struct throtl_service_queue {
77216b04
TH
75 struct throtl_service_queue *parent_sq; /* the parent service_queue */
76
73f0d49a
TH
77 /*
78 * Bios queued directly to this service_queue or dispatched from
79 * children throtl_grp's.
80 */
c5cc2070 81 struct list_head queued[2]; /* throtl_qnode [READ/WRITE] */
73f0d49a
TH
82 unsigned int nr_queued[2]; /* number of queued bios */
83
84 /*
85 * RB tree of active children throtl_grp's, which are sorted by
86 * their ->disptime.
87 */
9ff01255 88 struct rb_root_cached pending_tree; /* RB tree of active tgs */
c9e0332e
TH
89 unsigned int nr_pending; /* # queued in the tree */
90 unsigned long first_pending_disptime; /* disptime of the first tg */
69df0ab0 91 struct timer_list pending_timer; /* fires on first_pending_disptime */
e43473b7
VG
92};
93
5b2c16aa
TH
94enum tg_state_flags {
95 THROTL_TG_PENDING = 1 << 0, /* on parent's pending tree */
0e9f4164 96 THROTL_TG_WAS_EMPTY = 1 << 1, /* bio_lists[] became non-empty */
5b2c16aa
TH
97};
98
e43473b7
VG
99#define rb_entry_tg(node) rb_entry((node), struct throtl_grp, rb_node)
100
9f626e37 101enum {
cd5ab1b0 102 LIMIT_LOW,
9f626e37
SL
103 LIMIT_MAX,
104 LIMIT_CNT,
105};
106
e43473b7 107struct throtl_grp {
f95a04af
TH
108 /* must be the first member */
109 struct blkg_policy_data pd;
110
c9e0332e 111 /* active throtl group service_queue member */
e43473b7
VG
112 struct rb_node rb_node;
113
0f3457f6
TH
114 /* throtl_data this group belongs to */
115 struct throtl_data *td;
116
49a2f1e3
TH
117 /* this group's service queue */
118 struct throtl_service_queue service_queue;
119
c5cc2070
TH
120 /*
121 * qnode_on_self is used when bios are directly queued to this
122 * throtl_grp so that local bios compete fairly with bios
123 * dispatched from children. qnode_on_parent is used when bios are
124 * dispatched from this throtl_grp into its parent and will compete
125 * with the sibling qnode_on_parents and the parent's
126 * qnode_on_self.
127 */
128 struct throtl_qnode qnode_on_self[2];
129 struct throtl_qnode qnode_on_parent[2];
130
e43473b7
VG
131 /*
132 * Dispatch time in jiffies. This is the estimated time when group
133 * will unthrottle and is ready to dispatch more bio. It is used as
134 * key to sort active groups in service tree.
135 */
136 unsigned long disptime;
137
e43473b7
VG
138 unsigned int flags;
139
693e751e
TH
140 /* are there any throtl rules between this group and td? */
141 bool has_rules[2];
142
cd5ab1b0 143 /* internally used bytes per second rate limits */
9f626e37 144 uint64_t bps[2][LIMIT_CNT];
cd5ab1b0
SL
145 /* user configured bps limits */
146 uint64_t bps_conf[2][LIMIT_CNT];
e43473b7 147
cd5ab1b0 148 /* internally used IOPS limits */
9f626e37 149 unsigned int iops[2][LIMIT_CNT];
cd5ab1b0
SL
150 /* user configured IOPS limits */
151 unsigned int iops_conf[2][LIMIT_CNT];
8e89d13f 152
b53b072c 153 /* Number of bytes dispatched in current slice */
e43473b7 154 uint64_t bytes_disp[2];
8e89d13f
VG
155 /* Number of bio's dispatched in current slice */
156 unsigned int io_disp[2];
e43473b7 157
3f0abd80
SL
158 unsigned long last_low_overflow_time[2];
159
160 uint64_t last_bytes_disp[2];
161 unsigned int last_io_disp[2];
162
163 unsigned long last_check_time;
164
ec80991d 165 unsigned long latency_target; /* us */
5b81fc3c 166 unsigned long latency_target_conf; /* us */
e43473b7
VG
167 /* When did we start a new slice */
168 unsigned long slice_start[2];
169 unsigned long slice_end[2];
9e234eea
SL
170
171 unsigned long last_finish_time; /* ns / 1024 */
172 unsigned long checked_last_finish_time; /* ns / 1024 */
173 unsigned long avg_idletime; /* ns / 1024 */
174 unsigned long idletime_threshold; /* us */
5b81fc3c 175 unsigned long idletime_threshold_conf; /* us */
53696b8d
SL
176
177 unsigned int bio_cnt; /* total bios */
178 unsigned int bad_bio_cnt; /* bios exceeding latency threshold */
179 unsigned long bio_cnt_reset_time;
7ca46438 180
4f1e9630
CX
181 atomic_t io_split_cnt[2];
182 atomic_t last_io_split_cnt[2];
183
7ca46438
TH
184 struct blkg_rwstat stat_bytes;
185 struct blkg_rwstat stat_ios;
e43473b7
VG
186};
187
b9147dd1
SL
188/* We measure latency for request size from <= 4k to >= 1M */
189#define LATENCY_BUCKET_SIZE 9
190
191struct latency_bucket {
192 unsigned long total_latency; /* ns / 1024 */
193 int samples;
194};
195
196struct avg_latency_bucket {
197 unsigned long latency; /* ns / 1024 */
198 bool valid;
199};
200
e43473b7
VG
201struct throtl_data
202{
e43473b7 203 /* service tree for active throtl groups */
c9e0332e 204 struct throtl_service_queue service_queue;
e43473b7 205
e43473b7
VG
206 struct request_queue *queue;
207
208 /* Total Number of queued bios on READ and WRITE lists */
209 unsigned int nr_queued[2];
210
297e3d85
SL
211 unsigned int throtl_slice;
212
e43473b7 213 /* Work for dispatching throttled bios */
69df0ab0 214 struct work_struct dispatch_work;
9f626e37
SL
215 unsigned int limit_index;
216 bool limit_valid[LIMIT_CNT];
3f0abd80
SL
217
218 unsigned long low_upgrade_time;
219 unsigned long low_downgrade_time;
7394e31f
SL
220
221 unsigned int scale;
b9147dd1 222
b889bf66
JQ
223 struct latency_bucket tmp_buckets[2][LATENCY_BUCKET_SIZE];
224 struct avg_latency_bucket avg_buckets[2][LATENCY_BUCKET_SIZE];
225 struct latency_bucket __percpu *latency_buckets[2];
b9147dd1 226 unsigned long last_calculate_time;
6679a90c 227 unsigned long filtered_latency;
b9147dd1
SL
228
229 bool track_bio_latency;
e43473b7
VG
230};
231
e99e88a9 232static void throtl_pending_timer_fn(struct timer_list *t);
69df0ab0 233
f95a04af
TH
234static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
235{
236 return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
237}
238
3c798398 239static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
0381411e 240{
f95a04af 241 return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
0381411e
TH
242}
243
3c798398 244static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
0381411e 245{
f95a04af 246 return pd_to_blkg(&tg->pd);
0381411e
TH
247}
248
fda6f272
TH
249/**
250 * sq_to_tg - return the throl_grp the specified service queue belongs to
251 * @sq: the throtl_service_queue of interest
252 *
253 * Return the throtl_grp @sq belongs to. If @sq is the top-level one
254 * embedded in throtl_data, %NULL is returned.
255 */
256static struct throtl_grp *sq_to_tg(struct throtl_service_queue *sq)
257{
258 if (sq && sq->parent_sq)
259 return container_of(sq, struct throtl_grp, service_queue);
260 else
261 return NULL;
262}
263
264/**
265 * sq_to_td - return throtl_data the specified service queue belongs to
266 * @sq: the throtl_service_queue of interest
267 *
b43daedc 268 * A service_queue can be embedded in either a throtl_grp or throtl_data.
fda6f272
TH
269 * Determine the associated throtl_data accordingly and return it.
270 */
271static struct throtl_data *sq_to_td(struct throtl_service_queue *sq)
272{
273 struct throtl_grp *tg = sq_to_tg(sq);
274
275 if (tg)
276 return tg->td;
277 else
278 return container_of(sq, struct throtl_data, service_queue);
279}
280
7394e31f
SL
281/*
282 * cgroup's limit in LIMIT_MAX is scaled if low limit is set. This scale is to
283 * make the IO dispatch more smooth.
284 * Scale up: linearly scale up according to lapsed time since upgrade. For
285 * every throtl_slice, the limit scales up 1/2 .low limit till the
286 * limit hits .max limit
287 * Scale down: exponentially scale down if a cgroup doesn't hit its .low limit
288 */
289static uint64_t throtl_adjusted_limit(uint64_t low, struct throtl_data *td)
290{
291 /* arbitrary value to avoid too big scale */
292 if (td->scale < 4096 && time_after_eq(jiffies,
293 td->low_upgrade_time + td->scale * td->throtl_slice))
294 td->scale = (jiffies - td->low_upgrade_time) / td->throtl_slice;
295
296 return low + (low >> 1) * td->scale;
297}
298
9f626e37
SL
299static uint64_t tg_bps_limit(struct throtl_grp *tg, int rw)
300{
b22c417c 301 struct blkcg_gq *blkg = tg_to_blkg(tg);
7394e31f 302 struct throtl_data *td;
b22c417c
SL
303 uint64_t ret;
304
305 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && !blkg->parent)
306 return U64_MAX;
7394e31f
SL
307
308 td = tg->td;
309 ret = tg->bps[rw][td->limit_index];
9bb67aeb
SL
310 if (ret == 0 && td->limit_index == LIMIT_LOW) {
311 /* intermediate node or iops isn't 0 */
312 if (!list_empty(&blkg->blkcg->css.children) ||
313 tg->iops[rw][td->limit_index])
314 return U64_MAX;
315 else
316 return MIN_THROTL_BPS;
317 }
7394e31f
SL
318
319 if (td->limit_index == LIMIT_MAX && tg->bps[rw][LIMIT_LOW] &&
320 tg->bps[rw][LIMIT_LOW] != tg->bps[rw][LIMIT_MAX]) {
321 uint64_t adjusted;
322
323 adjusted = throtl_adjusted_limit(tg->bps[rw][LIMIT_LOW], td);
324 ret = min(tg->bps[rw][LIMIT_MAX], adjusted);
325 }
b22c417c 326 return ret;
9f626e37
SL
327}
328
329static unsigned int tg_iops_limit(struct throtl_grp *tg, int rw)
330{
b22c417c 331 struct blkcg_gq *blkg = tg_to_blkg(tg);
7394e31f 332 struct throtl_data *td;
b22c417c
SL
333 unsigned int ret;
334
335 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && !blkg->parent)
336 return UINT_MAX;
9bb67aeb 337
7394e31f
SL
338 td = tg->td;
339 ret = tg->iops[rw][td->limit_index];
9bb67aeb
SL
340 if (ret == 0 && tg->td->limit_index == LIMIT_LOW) {
341 /* intermediate node or bps isn't 0 */
342 if (!list_empty(&blkg->blkcg->css.children) ||
343 tg->bps[rw][td->limit_index])
344 return UINT_MAX;
345 else
346 return MIN_THROTL_IOPS;
347 }
7394e31f
SL
348
349 if (td->limit_index == LIMIT_MAX && tg->iops[rw][LIMIT_LOW] &&
350 tg->iops[rw][LIMIT_LOW] != tg->iops[rw][LIMIT_MAX]) {
351 uint64_t adjusted;
352
353 adjusted = throtl_adjusted_limit(tg->iops[rw][LIMIT_LOW], td);
354 if (adjusted > UINT_MAX)
355 adjusted = UINT_MAX;
356 ret = min_t(unsigned int, tg->iops[rw][LIMIT_MAX], adjusted);
357 }
b22c417c 358 return ret;
9f626e37
SL
359}
360
b9147dd1
SL
361#define request_bucket_index(sectors) \
362 clamp_t(int, order_base_2(sectors) - 3, 0, LATENCY_BUCKET_SIZE - 1)
363
fda6f272
TH
364/**
365 * throtl_log - log debug message via blktrace
366 * @sq: the service_queue being reported
367 * @fmt: printf format string
368 * @args: printf args
369 *
370 * The messages are prefixed with "throtl BLKG_NAME" if @sq belongs to a
371 * throtl_grp; otherwise, just "throtl".
fda6f272
TH
372 */
373#define throtl_log(sq, fmt, args...) do { \
374 struct throtl_grp *__tg = sq_to_tg((sq)); \
375 struct throtl_data *__td = sq_to_td((sq)); \
376 \
377 (void)__td; \
59fa0224
SL
378 if (likely(!blk_trace_note_message_enabled(__td->queue))) \
379 break; \
fda6f272 380 if ((__tg)) { \
35fe6d76
SL
381 blk_add_cgroup_trace_msg(__td->queue, \
382 tg_to_blkg(__tg)->blkcg, "throtl " fmt, ##args);\
fda6f272
TH
383 } else { \
384 blk_add_trace_msg(__td->queue, "throtl " fmt, ##args); \
385 } \
54e7ed12 386} while (0)
e43473b7 387
ea0ea2bc
SL
388static inline unsigned int throtl_bio_data_size(struct bio *bio)
389{
390 /* assume it's one sector */
391 if (unlikely(bio_op(bio) == REQ_OP_DISCARD))
392 return 512;
393 return bio->bi_iter.bi_size;
394}
395
c5cc2070
TH
396static void throtl_qnode_init(struct throtl_qnode *qn, struct throtl_grp *tg)
397{
398 INIT_LIST_HEAD(&qn->node);
399 bio_list_init(&qn->bios);
400 qn->tg = tg;
401}
402
403/**
404 * throtl_qnode_add_bio - add a bio to a throtl_qnode and activate it
405 * @bio: bio being added
406 * @qn: qnode to add bio to
407 * @queued: the service_queue->queued[] list @qn belongs to
408 *
409 * Add @bio to @qn and put @qn on @queued if it's not already on.
410 * @qn->tg's reference count is bumped when @qn is activated. See the
411 * comment on top of throtl_qnode definition for details.
412 */
413static void throtl_qnode_add_bio(struct bio *bio, struct throtl_qnode *qn,
414 struct list_head *queued)
415{
416 bio_list_add(&qn->bios, bio);
417 if (list_empty(&qn->node)) {
418 list_add_tail(&qn->node, queued);
419 blkg_get(tg_to_blkg(qn->tg));
420 }
421}
422
423/**
424 * throtl_peek_queued - peek the first bio on a qnode list
425 * @queued: the qnode list to peek
426 */
427static struct bio *throtl_peek_queued(struct list_head *queued)
428{
b7b609de 429 struct throtl_qnode *qn;
c5cc2070
TH
430 struct bio *bio;
431
432 if (list_empty(queued))
433 return NULL;
434
b7b609de 435 qn = list_first_entry(queued, struct throtl_qnode, node);
c5cc2070
TH
436 bio = bio_list_peek(&qn->bios);
437 WARN_ON_ONCE(!bio);
438 return bio;
439}
440
441/**
442 * throtl_pop_queued - pop the first bio form a qnode list
443 * @queued: the qnode list to pop a bio from
444 * @tg_to_put: optional out argument for throtl_grp to put
445 *
446 * Pop the first bio from the qnode list @queued. After popping, the first
447 * qnode is removed from @queued if empty or moved to the end of @queued so
448 * that the popping order is round-robin.
449 *
450 * When the first qnode is removed, its associated throtl_grp should be put
451 * too. If @tg_to_put is NULL, this function automatically puts it;
452 * otherwise, *@tg_to_put is set to the throtl_grp to put and the caller is
453 * responsible for putting it.
454 */
455static struct bio *throtl_pop_queued(struct list_head *queued,
456 struct throtl_grp **tg_to_put)
457{
b7b609de 458 struct throtl_qnode *qn;
c5cc2070
TH
459 struct bio *bio;
460
461 if (list_empty(queued))
462 return NULL;
463
b7b609de 464 qn = list_first_entry(queued, struct throtl_qnode, node);
c5cc2070
TH
465 bio = bio_list_pop(&qn->bios);
466 WARN_ON_ONCE(!bio);
467
468 if (bio_list_empty(&qn->bios)) {
469 list_del_init(&qn->node);
470 if (tg_to_put)
471 *tg_to_put = qn->tg;
472 else
473 blkg_put(tg_to_blkg(qn->tg));
474 } else {
475 list_move_tail(&qn->node, queued);
476 }
477
478 return bio;
479}
480
49a2f1e3 481/* init a service_queue, assumes the caller zeroed it */
b2ce2643 482static void throtl_service_queue_init(struct throtl_service_queue *sq)
49a2f1e3 483{
c5cc2070
TH
484 INIT_LIST_HEAD(&sq->queued[0]);
485 INIT_LIST_HEAD(&sq->queued[1]);
9ff01255 486 sq->pending_tree = RB_ROOT_CACHED;
e99e88a9 487 timer_setup(&sq->pending_timer, throtl_pending_timer_fn, 0);
69df0ab0
TH
488}
489
cf09a8ee
TH
490static struct blkg_policy_data *throtl_pd_alloc(gfp_t gfp,
491 struct request_queue *q,
492 struct blkcg *blkcg)
001bea73 493{
4fb72036 494 struct throtl_grp *tg;
24bdb8ef 495 int rw;
4fb72036 496
cf09a8ee 497 tg = kzalloc_node(sizeof(*tg), gfp, q->node);
4fb72036 498 if (!tg)
77ea7338 499 return NULL;
4fb72036 500
7ca46438
TH
501 if (blkg_rwstat_init(&tg->stat_bytes, gfp))
502 goto err_free_tg;
503
504 if (blkg_rwstat_init(&tg->stat_ios, gfp))
505 goto err_exit_stat_bytes;
506
b2ce2643
TH
507 throtl_service_queue_init(&tg->service_queue);
508
509 for (rw = READ; rw <= WRITE; rw++) {
510 throtl_qnode_init(&tg->qnode_on_self[rw], tg);
511 throtl_qnode_init(&tg->qnode_on_parent[rw], tg);
512 }
513
514 RB_CLEAR_NODE(&tg->rb_node);
9f626e37
SL
515 tg->bps[READ][LIMIT_MAX] = U64_MAX;
516 tg->bps[WRITE][LIMIT_MAX] = U64_MAX;
517 tg->iops[READ][LIMIT_MAX] = UINT_MAX;
518 tg->iops[WRITE][LIMIT_MAX] = UINT_MAX;
cd5ab1b0
SL
519 tg->bps_conf[READ][LIMIT_MAX] = U64_MAX;
520 tg->bps_conf[WRITE][LIMIT_MAX] = U64_MAX;
521 tg->iops_conf[READ][LIMIT_MAX] = UINT_MAX;
522 tg->iops_conf[WRITE][LIMIT_MAX] = UINT_MAX;
523 /* LIMIT_LOW will have default value 0 */
b2ce2643 524
ec80991d 525 tg->latency_target = DFL_LATENCY_TARGET;
5b81fc3c 526 tg->latency_target_conf = DFL_LATENCY_TARGET;
b4f428ef
SL
527 tg->idletime_threshold = DFL_IDLE_THRESHOLD;
528 tg->idletime_threshold_conf = DFL_IDLE_THRESHOLD;
ec80991d 529
4fb72036 530 return &tg->pd;
7ca46438
TH
531
532err_exit_stat_bytes:
533 blkg_rwstat_exit(&tg->stat_bytes);
534err_free_tg:
535 kfree(tg);
536 return NULL;
001bea73
TH
537}
538
a9520cd6 539static void throtl_pd_init(struct blkg_policy_data *pd)
a29a171e 540{
a9520cd6
TH
541 struct throtl_grp *tg = pd_to_tg(pd);
542 struct blkcg_gq *blkg = tg_to_blkg(tg);
77216b04 543 struct throtl_data *td = blkg->q->td;
b2ce2643 544 struct throtl_service_queue *sq = &tg->service_queue;
cd1604fa 545
9138125b 546 /*
aa6ec29b 547 * If on the default hierarchy, we switch to properly hierarchical
9138125b
TH
548 * behavior where limits on a given throtl_grp are applied to the
549 * whole subtree rather than just the group itself. e.g. If 16M
550 * read_bps limit is set on the root group, the whole system can't
551 * exceed 16M for the device.
552 *
aa6ec29b 553 * If not on the default hierarchy, the broken flat hierarchy
9138125b
TH
554 * behavior is retained where all throtl_grps are treated as if
555 * they're all separate root groups right below throtl_data.
556 * Limits of a group don't interact with limits of other groups
557 * regardless of the position of the group in the hierarchy.
558 */
b2ce2643 559 sq->parent_sq = &td->service_queue;
9e10a130 560 if (cgroup_subsys_on_dfl(io_cgrp_subsys) && blkg->parent)
b2ce2643 561 sq->parent_sq = &blkg_to_tg(blkg->parent)->service_queue;
77216b04 562 tg->td = td;
8a3d2615
TH
563}
564
693e751e
TH
565/*
566 * Set has_rules[] if @tg or any of its parents have limits configured.
567 * This doesn't require walking up to the top of the hierarchy as the
568 * parent's has_rules[] is guaranteed to be correct.
569 */
570static void tg_update_has_rules(struct throtl_grp *tg)
571{
572 struct throtl_grp *parent_tg = sq_to_tg(tg->service_queue.parent_sq);
9f626e37 573 struct throtl_data *td = tg->td;
693e751e
TH
574 int rw;
575
576 for (rw = READ; rw <= WRITE; rw++)
577 tg->has_rules[rw] = (parent_tg && parent_tg->has_rules[rw]) ||
9f626e37
SL
578 (td->limit_valid[td->limit_index] &&
579 (tg_bps_limit(tg, rw) != U64_MAX ||
580 tg_iops_limit(tg, rw) != UINT_MAX));
693e751e
TH
581}
582
a9520cd6 583static void throtl_pd_online(struct blkg_policy_data *pd)
693e751e 584{
aec24246 585 struct throtl_grp *tg = pd_to_tg(pd);
693e751e
TH
586 /*
587 * We don't want new groups to escape the limits of its ancestors.
588 * Update has_rules[] after a new group is brought online.
589 */
aec24246 590 tg_update_has_rules(tg);
693e751e
TH
591}
592
acaf523a 593#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
cd5ab1b0
SL
594static void blk_throtl_update_limit_valid(struct throtl_data *td)
595{
596 struct cgroup_subsys_state *pos_css;
597 struct blkcg_gq *blkg;
598 bool low_valid = false;
599
600 rcu_read_lock();
601 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
602 struct throtl_grp *tg = blkg_to_tg(blkg);
603
604 if (tg->bps[READ][LIMIT_LOW] || tg->bps[WRITE][LIMIT_LOW] ||
43ada787 605 tg->iops[READ][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW]) {
cd5ab1b0 606 low_valid = true;
43ada787
LB
607 break;
608 }
cd5ab1b0
SL
609 }
610 rcu_read_unlock();
611
612 td->limit_valid[LIMIT_LOW] = low_valid;
613}
acaf523a
YK
614#else
615static inline void blk_throtl_update_limit_valid(struct throtl_data *td)
616{
617}
618#endif
cd5ab1b0 619
c79892c5 620static void throtl_upgrade_state(struct throtl_data *td);
cd5ab1b0
SL
621static void throtl_pd_offline(struct blkg_policy_data *pd)
622{
623 struct throtl_grp *tg = pd_to_tg(pd);
624
625 tg->bps[READ][LIMIT_LOW] = 0;
626 tg->bps[WRITE][LIMIT_LOW] = 0;
627 tg->iops[READ][LIMIT_LOW] = 0;
628 tg->iops[WRITE][LIMIT_LOW] = 0;
629
630 blk_throtl_update_limit_valid(tg->td);
631
c79892c5
SL
632 if (!tg->td->limit_valid[tg->td->limit_index])
633 throtl_upgrade_state(tg->td);
cd5ab1b0
SL
634}
635
001bea73
TH
636static void throtl_pd_free(struct blkg_policy_data *pd)
637{
4fb72036
TH
638 struct throtl_grp *tg = pd_to_tg(pd);
639
b2ce2643 640 del_timer_sync(&tg->service_queue.pending_timer);
7ca46438
TH
641 blkg_rwstat_exit(&tg->stat_bytes);
642 blkg_rwstat_exit(&tg->stat_ios);
4fb72036 643 kfree(tg);
001bea73
TH
644}
645
0049af73
TH
646static struct throtl_grp *
647throtl_rb_first(struct throtl_service_queue *parent_sq)
e43473b7 648{
9ff01255 649 struct rb_node *n;
e43473b7 650
9ff01255
LB
651 n = rb_first_cached(&parent_sq->pending_tree);
652 WARN_ON_ONCE(!n);
653 if (!n)
654 return NULL;
655 return rb_entry_tg(n);
e43473b7
VG
656}
657
0049af73
TH
658static void throtl_rb_erase(struct rb_node *n,
659 struct throtl_service_queue *parent_sq)
e43473b7 660{
9ff01255
LB
661 rb_erase_cached(n, &parent_sq->pending_tree);
662 RB_CLEAR_NODE(n);
0049af73 663 --parent_sq->nr_pending;
e43473b7
VG
664}
665
0049af73 666static void update_min_dispatch_time(struct throtl_service_queue *parent_sq)
e43473b7
VG
667{
668 struct throtl_grp *tg;
669
0049af73 670 tg = throtl_rb_first(parent_sq);
e43473b7
VG
671 if (!tg)
672 return;
673
0049af73 674 parent_sq->first_pending_disptime = tg->disptime;
e43473b7
VG
675}
676
77216b04 677static void tg_service_queue_add(struct throtl_grp *tg)
e43473b7 678{
77216b04 679 struct throtl_service_queue *parent_sq = tg->service_queue.parent_sq;
9ff01255 680 struct rb_node **node = &parent_sq->pending_tree.rb_root.rb_node;
e43473b7
VG
681 struct rb_node *parent = NULL;
682 struct throtl_grp *__tg;
683 unsigned long key = tg->disptime;
9ff01255 684 bool leftmost = true;
e43473b7
VG
685
686 while (*node != NULL) {
687 parent = *node;
688 __tg = rb_entry_tg(parent);
689
690 if (time_before(key, __tg->disptime))
691 node = &parent->rb_left;
692 else {
693 node = &parent->rb_right;
9ff01255 694 leftmost = false;
e43473b7
VG
695 }
696 }
697
e43473b7 698 rb_link_node(&tg->rb_node, parent, node);
9ff01255
LB
699 rb_insert_color_cached(&tg->rb_node, &parent_sq->pending_tree,
700 leftmost);
e43473b7
VG
701}
702
77216b04 703static void throtl_enqueue_tg(struct throtl_grp *tg)
e43473b7 704{
29379674
BW
705 if (!(tg->flags & THROTL_TG_PENDING)) {
706 tg_service_queue_add(tg);
707 tg->flags |= THROTL_TG_PENDING;
708 tg->service_queue.parent_sq->nr_pending++;
709 }
e43473b7
VG
710}
711
77216b04 712static void throtl_dequeue_tg(struct throtl_grp *tg)
e43473b7 713{
29379674
BW
714 if (tg->flags & THROTL_TG_PENDING) {
715 throtl_rb_erase(&tg->rb_node, tg->service_queue.parent_sq);
716 tg->flags &= ~THROTL_TG_PENDING;
717 }
e43473b7
VG
718}
719
a9131a27 720/* Call with queue lock held */
69df0ab0
TH
721static void throtl_schedule_pending_timer(struct throtl_service_queue *sq,
722 unsigned long expires)
a9131a27 723{
a41b816c 724 unsigned long max_expire = jiffies + 8 * sq_to_td(sq)->throtl_slice;
06cceedc
SL
725
726 /*
727 * Since we are adjusting the throttle limit dynamically, the sleep
728 * time calculated according to previous limit might be invalid. It's
729 * possible the cgroup sleep time is very long and no other cgroups
730 * have IO running so notify the limit changes. Make sure the cgroup
731 * doesn't sleep too long to avoid the missed notification.
732 */
733 if (time_after(expires, max_expire))
734 expires = max_expire;
69df0ab0
TH
735 mod_timer(&sq->pending_timer, expires);
736 throtl_log(sq, "schedule timer. delay=%lu jiffies=%lu",
737 expires - jiffies, jiffies);
a9131a27
TH
738}
739
7f52f98c
TH
740/**
741 * throtl_schedule_next_dispatch - schedule the next dispatch cycle
742 * @sq: the service_queue to schedule dispatch for
743 * @force: force scheduling
744 *
745 * Arm @sq->pending_timer so that the next dispatch cycle starts on the
746 * dispatch time of the first pending child. Returns %true if either timer
747 * is armed or there's no pending child left. %false if the current
748 * dispatch window is still open and the caller should continue
749 * dispatching.
750 *
751 * If @force is %true, the dispatch timer is always scheduled and this
752 * function is guaranteed to return %true. This is to be used when the
753 * caller can't dispatch itself and needs to invoke pending_timer
754 * unconditionally. Note that forced scheduling is likely to induce short
755 * delay before dispatch starts even if @sq->first_pending_disptime is not
756 * in the future and thus shouldn't be used in hot paths.
757 */
758static bool throtl_schedule_next_dispatch(struct throtl_service_queue *sq,
759 bool force)
e43473b7 760{
6a525600 761 /* any pending children left? */
c9e0332e 762 if (!sq->nr_pending)
7f52f98c 763 return true;
e43473b7 764
c9e0332e 765 update_min_dispatch_time(sq);
e43473b7 766
69df0ab0 767 /* is the next dispatch time in the future? */
7f52f98c 768 if (force || time_after(sq->first_pending_disptime, jiffies)) {
69df0ab0 769 throtl_schedule_pending_timer(sq, sq->first_pending_disptime);
7f52f98c 770 return true;
69df0ab0
TH
771 }
772
7f52f98c
TH
773 /* tell the caller to continue dispatching */
774 return false;
e43473b7
VG
775}
776
32ee5bc4
VG
777static inline void throtl_start_new_slice_with_credit(struct throtl_grp *tg,
778 bool rw, unsigned long start)
779{
780 tg->bytes_disp[rw] = 0;
781 tg->io_disp[rw] = 0;
782
4f1e9630
CX
783 atomic_set(&tg->io_split_cnt[rw], 0);
784
32ee5bc4
VG
785 /*
786 * Previous slice has expired. We must have trimmed it after last
787 * bio dispatch. That means since start of last slice, we never used
788 * that bandwidth. Do try to make use of that bandwidth while giving
789 * credit.
790 */
791 if (time_after_eq(start, tg->slice_start[rw]))
792 tg->slice_start[rw] = start;
793
297e3d85 794 tg->slice_end[rw] = jiffies + tg->td->throtl_slice;
32ee5bc4
VG
795 throtl_log(&tg->service_queue,
796 "[%c] new slice with credit start=%lu end=%lu jiffies=%lu",
797 rw == READ ? 'R' : 'W', tg->slice_start[rw],
798 tg->slice_end[rw], jiffies);
799}
800
0f3457f6 801static inline void throtl_start_new_slice(struct throtl_grp *tg, bool rw)
e43473b7
VG
802{
803 tg->bytes_disp[rw] = 0;
8e89d13f 804 tg->io_disp[rw] = 0;
e43473b7 805 tg->slice_start[rw] = jiffies;
297e3d85 806 tg->slice_end[rw] = jiffies + tg->td->throtl_slice;
4f1e9630
CX
807
808 atomic_set(&tg->io_split_cnt[rw], 0);
809
fda6f272
TH
810 throtl_log(&tg->service_queue,
811 "[%c] new slice start=%lu end=%lu jiffies=%lu",
812 rw == READ ? 'R' : 'W', tg->slice_start[rw],
813 tg->slice_end[rw], jiffies);
e43473b7
VG
814}
815
0f3457f6
TH
816static inline void throtl_set_slice_end(struct throtl_grp *tg, bool rw,
817 unsigned long jiffy_end)
d1ae8ffd 818{
297e3d85 819 tg->slice_end[rw] = roundup(jiffy_end, tg->td->throtl_slice);
d1ae8ffd
VG
820}
821
0f3457f6
TH
822static inline void throtl_extend_slice(struct throtl_grp *tg, bool rw,
823 unsigned long jiffy_end)
e43473b7 824{
1da30f95 825 throtl_set_slice_end(tg, rw, jiffy_end);
fda6f272
TH
826 throtl_log(&tg->service_queue,
827 "[%c] extend slice start=%lu end=%lu jiffies=%lu",
828 rw == READ ? 'R' : 'W', tg->slice_start[rw],
829 tg->slice_end[rw], jiffies);
e43473b7
VG
830}
831
832/* Determine if previously allocated or extended slice is complete or not */
0f3457f6 833static bool throtl_slice_used(struct throtl_grp *tg, bool rw)
e43473b7
VG
834{
835 if (time_in_range(jiffies, tg->slice_start[rw], tg->slice_end[rw]))
5cf8c227 836 return false;
e43473b7 837
0b6bad7d 838 return true;
e43473b7
VG
839}
840
841/* Trim the used slices and adjust slice start accordingly */
0f3457f6 842static inline void throtl_trim_slice(struct throtl_grp *tg, bool rw)
e43473b7 843{
3aad5d3e
VG
844 unsigned long nr_slices, time_elapsed, io_trim;
845 u64 bytes_trim, tmp;
e43473b7
VG
846
847 BUG_ON(time_before(tg->slice_end[rw], tg->slice_start[rw]));
848
849 /*
850 * If bps are unlimited (-1), then time slice don't get
851 * renewed. Don't try to trim the slice if slice is used. A new
852 * slice will start when appropriate.
853 */
0f3457f6 854 if (throtl_slice_used(tg, rw))
e43473b7
VG
855 return;
856
d1ae8ffd
VG
857 /*
858 * A bio has been dispatched. Also adjust slice_end. It might happen
859 * that initially cgroup limit was very low resulting in high
b53b072c 860 * slice_end, but later limit was bumped up and bio was dispatched
d1ae8ffd
VG
861 * sooner, then we need to reduce slice_end. A high bogus slice_end
862 * is bad because it does not allow new slice to start.
863 */
864
297e3d85 865 throtl_set_slice_end(tg, rw, jiffies + tg->td->throtl_slice);
d1ae8ffd 866
e43473b7
VG
867 time_elapsed = jiffies - tg->slice_start[rw];
868
297e3d85 869 nr_slices = time_elapsed / tg->td->throtl_slice;
e43473b7
VG
870
871 if (!nr_slices)
872 return;
297e3d85 873 tmp = tg_bps_limit(tg, rw) * tg->td->throtl_slice * nr_slices;
3aad5d3e
VG
874 do_div(tmp, HZ);
875 bytes_trim = tmp;
e43473b7 876
297e3d85
SL
877 io_trim = (tg_iops_limit(tg, rw) * tg->td->throtl_slice * nr_slices) /
878 HZ;
e43473b7 879
8e89d13f 880 if (!bytes_trim && !io_trim)
e43473b7
VG
881 return;
882
883 if (tg->bytes_disp[rw] >= bytes_trim)
884 tg->bytes_disp[rw] -= bytes_trim;
885 else
886 tg->bytes_disp[rw] = 0;
887
8e89d13f
VG
888 if (tg->io_disp[rw] >= io_trim)
889 tg->io_disp[rw] -= io_trim;
890 else
891 tg->io_disp[rw] = 0;
892
297e3d85 893 tg->slice_start[rw] += nr_slices * tg->td->throtl_slice;
e43473b7 894
fda6f272
TH
895 throtl_log(&tg->service_queue,
896 "[%c] trim slice nr=%lu bytes=%llu io=%lu start=%lu end=%lu jiffies=%lu",
897 rw == READ ? 'R' : 'W', nr_slices, bytes_trim, io_trim,
898 tg->slice_start[rw], tg->slice_end[rw], jiffies);
e43473b7
VG
899}
900
0f3457f6 901static bool tg_with_in_iops_limit(struct throtl_grp *tg, struct bio *bio,
4599ea49 902 u32 iops_limit, unsigned long *wait)
e43473b7
VG
903{
904 bool rw = bio_data_dir(bio);
8e89d13f 905 unsigned int io_allowed;
e43473b7 906 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
c49c06e4 907 u64 tmp;
e43473b7 908
87fbeb88
BW
909 if (iops_limit == UINT_MAX) {
910 if (wait)
911 *wait = 0;
912 return true;
913 }
914
3a10f999 915 jiffy_elapsed = jiffies - tg->slice_start[rw];
e43473b7 916
3a10f999
KK
917 /* Round up to the next throttle slice, wait time must be nonzero */
918 jiffy_elapsed_rnd = roundup(jiffy_elapsed + 1, tg->td->throtl_slice);
8e89d13f 919
c49c06e4
VG
920 /*
921 * jiffy_elapsed_rnd should not be a big value as minimum iops can be
922 * 1 then at max jiffy elapsed should be equivalent of 1 second as we
923 * will allow dispatch after 1 second and after that slice should
924 * have been trimmed.
925 */
926
4599ea49 927 tmp = (u64)iops_limit * jiffy_elapsed_rnd;
c49c06e4
VG
928 do_div(tmp, HZ);
929
930 if (tmp > UINT_MAX)
931 io_allowed = UINT_MAX;
932 else
933 io_allowed = tmp;
8e89d13f
VG
934
935 if (tg->io_disp[rw] + 1 <= io_allowed) {
e43473b7
VG
936 if (wait)
937 *wait = 0;
5cf8c227 938 return true;
e43473b7
VG
939 }
940
8e89d13f 941 /* Calc approx time to dispatch */
991f61fe 942 jiffy_wait = jiffy_elapsed_rnd - jiffy_elapsed;
8e89d13f
VG
943
944 if (wait)
945 *wait = jiffy_wait;
0b6bad7d 946 return false;
8e89d13f
VG
947}
948
0f3457f6 949static bool tg_with_in_bps_limit(struct throtl_grp *tg, struct bio *bio,
4599ea49 950 u64 bps_limit, unsigned long *wait)
8e89d13f
VG
951{
952 bool rw = bio_data_dir(bio);
7363e677 953 u64 bytes_allowed, extra_bytes;
8e89d13f 954 unsigned long jiffy_elapsed, jiffy_wait, jiffy_elapsed_rnd;
ea0ea2bc 955 unsigned int bio_size = throtl_bio_data_size(bio);
e43473b7 956
87fbeb88
BW
957 if (bps_limit == U64_MAX) {
958 if (wait)
959 *wait = 0;
960 return true;
961 }
962
e43473b7
VG
963 jiffy_elapsed = jiffy_elapsed_rnd = jiffies - tg->slice_start[rw];
964
965 /* Slice has just started. Consider one slice interval */
966 if (!jiffy_elapsed)
297e3d85 967 jiffy_elapsed_rnd = tg->td->throtl_slice;
e43473b7 968
297e3d85 969 jiffy_elapsed_rnd = roundup(jiffy_elapsed_rnd, tg->td->throtl_slice);
7363e677
YK
970 bytes_allowed = mul_u64_u64_div_u64(bps_limit, (u64)jiffy_elapsed_rnd,
971 (u64)HZ);
e43473b7 972
ea0ea2bc 973 if (tg->bytes_disp[rw] + bio_size <= bytes_allowed) {
e43473b7
VG
974 if (wait)
975 *wait = 0;
5cf8c227 976 return true;
e43473b7
VG
977 }
978
979 /* Calc approx time to dispatch */
ea0ea2bc 980 extra_bytes = tg->bytes_disp[rw] + bio_size - bytes_allowed;
4599ea49 981 jiffy_wait = div64_u64(extra_bytes * HZ, bps_limit);
e43473b7
VG
982
983 if (!jiffy_wait)
984 jiffy_wait = 1;
985
986 /*
987 * This wait time is without taking into consideration the rounding
988 * up we did. Add that time also.
989 */
990 jiffy_wait = jiffy_wait + (jiffy_elapsed_rnd - jiffy_elapsed);
e43473b7
VG
991 if (wait)
992 *wait = jiffy_wait;
0b6bad7d 993 return false;
8e89d13f
VG
994}
995
996/*
997 * Returns whether one can dispatch a bio or not. Also returns approx number
998 * of jiffies to wait before this bio is with-in IO rate and can be dispatched
999 */
0f3457f6
TH
1000static bool tg_may_dispatch(struct throtl_grp *tg, struct bio *bio,
1001 unsigned long *wait)
8e89d13f
VG
1002{
1003 bool rw = bio_data_dir(bio);
1004 unsigned long bps_wait = 0, iops_wait = 0, max_wait = 0;
4599ea49
BW
1005 u64 bps_limit = tg_bps_limit(tg, rw);
1006 u32 iops_limit = tg_iops_limit(tg, rw);
8e89d13f
VG
1007
1008 /*
1009 * Currently whole state machine of group depends on first bio
1010 * queued in the group bio list. So one should not be calling
1011 * this function with a different bio if there are other bios
1012 * queued.
1013 */
73f0d49a 1014 BUG_ON(tg->service_queue.nr_queued[rw] &&
c5cc2070 1015 bio != throtl_peek_queued(&tg->service_queue.queued[rw]));
e43473b7 1016
8e89d13f 1017 /* If tg->bps = -1, then BW is unlimited */
4599ea49 1018 if (bps_limit == U64_MAX && iops_limit == UINT_MAX) {
8e89d13f
VG
1019 if (wait)
1020 *wait = 0;
5cf8c227 1021 return true;
8e89d13f
VG
1022 }
1023
1024 /*
1025 * If previous slice expired, start a new one otherwise renew/extend
1026 * existing slice to make sure it is at least throtl_slice interval
164c80ed
VG
1027 * long since now. New slice is started only for empty throttle group.
1028 * If there is queued bio, that means there should be an active
1029 * slice and it should be extended instead.
8e89d13f 1030 */
164c80ed 1031 if (throtl_slice_used(tg, rw) && !(tg->service_queue.nr_queued[rw]))
0f3457f6 1032 throtl_start_new_slice(tg, rw);
8e89d13f 1033 else {
297e3d85
SL
1034 if (time_before(tg->slice_end[rw],
1035 jiffies + tg->td->throtl_slice))
1036 throtl_extend_slice(tg, rw,
1037 jiffies + tg->td->throtl_slice);
8e89d13f
VG
1038 }
1039
4f1e9630
CX
1040 if (iops_limit != UINT_MAX)
1041 tg->io_disp[rw] += atomic_xchg(&tg->io_split_cnt[rw], 0);
1042
4599ea49
BW
1043 if (tg_with_in_bps_limit(tg, bio, bps_limit, &bps_wait) &&
1044 tg_with_in_iops_limit(tg, bio, iops_limit, &iops_wait)) {
8e89d13f
VG
1045 if (wait)
1046 *wait = 0;
0b6bad7d 1047 return true;
8e89d13f
VG
1048 }
1049
1050 max_wait = max(bps_wait, iops_wait);
1051
1052 if (wait)
1053 *wait = max_wait;
1054
1055 if (time_before(tg->slice_end[rw], jiffies + max_wait))
0f3457f6 1056 throtl_extend_slice(tg, rw, jiffies + max_wait);
e43473b7 1057
0b6bad7d 1058 return false;
e43473b7
VG
1059}
1060
1061static void throtl_charge_bio(struct throtl_grp *tg, struct bio *bio)
1062{
1063 bool rw = bio_data_dir(bio);
ea0ea2bc 1064 unsigned int bio_size = throtl_bio_data_size(bio);
e43473b7
VG
1065
1066 /* Charge the bio to the group */
ea0ea2bc 1067 tg->bytes_disp[rw] += bio_size;
8e89d13f 1068 tg->io_disp[rw]++;
ea0ea2bc 1069 tg->last_bytes_disp[rw] += bio_size;
3f0abd80 1070 tg->last_io_disp[rw]++;
e43473b7 1071
2a0f61e6 1072 /*
8d2bbd4c 1073 * BIO_THROTTLED is used to prevent the same bio to be throttled
2a0f61e6
TH
1074 * more than once as a throttled bio will go through blk-throtl the
1075 * second time when it eventually gets issued. Set it when a bio
1076 * is being charged to a tg.
2a0f61e6 1077 */
8d2bbd4c
CH
1078 if (!bio_flagged(bio, BIO_THROTTLED))
1079 bio_set_flag(bio, BIO_THROTTLED);
e43473b7
VG
1080}
1081
c5cc2070
TH
1082/**
1083 * throtl_add_bio_tg - add a bio to the specified throtl_grp
1084 * @bio: bio to add
1085 * @qn: qnode to use
1086 * @tg: the target throtl_grp
1087 *
1088 * Add @bio to @tg's service_queue using @qn. If @qn is not specified,
1089 * tg->qnode_on_self[] is used.
1090 */
1091static void throtl_add_bio_tg(struct bio *bio, struct throtl_qnode *qn,
1092 struct throtl_grp *tg)
e43473b7 1093{
73f0d49a 1094 struct throtl_service_queue *sq = &tg->service_queue;
e43473b7
VG
1095 bool rw = bio_data_dir(bio);
1096
c5cc2070
TH
1097 if (!qn)
1098 qn = &tg->qnode_on_self[rw];
1099
0e9f4164
TH
1100 /*
1101 * If @tg doesn't currently have any bios queued in the same
1102 * direction, queueing @bio can change when @tg should be
1103 * dispatched. Mark that @tg was empty. This is automatically
b53b072c 1104 * cleared on the next tg_update_disptime().
0e9f4164
TH
1105 */
1106 if (!sq->nr_queued[rw])
1107 tg->flags |= THROTL_TG_WAS_EMPTY;
1108
c5cc2070
TH
1109 throtl_qnode_add_bio(bio, qn, &sq->queued[rw]);
1110
73f0d49a 1111 sq->nr_queued[rw]++;
77216b04 1112 throtl_enqueue_tg(tg);
e43473b7
VG
1113}
1114
77216b04 1115static void tg_update_disptime(struct throtl_grp *tg)
e43473b7 1116{
73f0d49a 1117 struct throtl_service_queue *sq = &tg->service_queue;
e43473b7
VG
1118 unsigned long read_wait = -1, write_wait = -1, min_wait = -1, disptime;
1119 struct bio *bio;
1120
d609af3a
ME
1121 bio = throtl_peek_queued(&sq->queued[READ]);
1122 if (bio)
0f3457f6 1123 tg_may_dispatch(tg, bio, &read_wait);
e43473b7 1124
d609af3a
ME
1125 bio = throtl_peek_queued(&sq->queued[WRITE]);
1126 if (bio)
0f3457f6 1127 tg_may_dispatch(tg, bio, &write_wait);
e43473b7
VG
1128
1129 min_wait = min(read_wait, write_wait);
1130 disptime = jiffies + min_wait;
1131
e43473b7 1132 /* Update dispatch time */
77216b04 1133 throtl_dequeue_tg(tg);
e43473b7 1134 tg->disptime = disptime;
77216b04 1135 throtl_enqueue_tg(tg);
0e9f4164
TH
1136
1137 /* see throtl_add_bio_tg() */
1138 tg->flags &= ~THROTL_TG_WAS_EMPTY;
e43473b7
VG
1139}
1140
32ee5bc4
VG
1141static void start_parent_slice_with_credit(struct throtl_grp *child_tg,
1142 struct throtl_grp *parent_tg, bool rw)
1143{
1144 if (throtl_slice_used(parent_tg, rw)) {
1145 throtl_start_new_slice_with_credit(parent_tg, rw,
1146 child_tg->slice_start[rw]);
1147 }
1148
1149}
1150
77216b04 1151static void tg_dispatch_one_bio(struct throtl_grp *tg, bool rw)
e43473b7 1152{
73f0d49a 1153 struct throtl_service_queue *sq = &tg->service_queue;
6bc9c2b4
TH
1154 struct throtl_service_queue *parent_sq = sq->parent_sq;
1155 struct throtl_grp *parent_tg = sq_to_tg(parent_sq);
c5cc2070 1156 struct throtl_grp *tg_to_put = NULL;
e43473b7
VG
1157 struct bio *bio;
1158
c5cc2070
TH
1159 /*
1160 * @bio is being transferred from @tg to @parent_sq. Popping a bio
1161 * from @tg may put its reference and @parent_sq might end up
1162 * getting released prematurely. Remember the tg to put and put it
1163 * after @bio is transferred to @parent_sq.
1164 */
1165 bio = throtl_pop_queued(&sq->queued[rw], &tg_to_put);
73f0d49a 1166 sq->nr_queued[rw]--;
e43473b7
VG
1167
1168 throtl_charge_bio(tg, bio);
6bc9c2b4
TH
1169
1170 /*
1171 * If our parent is another tg, we just need to transfer @bio to
1172 * the parent using throtl_add_bio_tg(). If our parent is
1173 * @td->service_queue, @bio is ready to be issued. Put it on its
1174 * bio_lists[] and decrease total number queued. The caller is
1175 * responsible for issuing these bios.
1176 */
1177 if (parent_tg) {
c5cc2070 1178 throtl_add_bio_tg(bio, &tg->qnode_on_parent[rw], parent_tg);
32ee5bc4 1179 start_parent_slice_with_credit(tg, parent_tg, rw);
6bc9c2b4 1180 } else {
c5cc2070
TH
1181 throtl_qnode_add_bio(bio, &tg->qnode_on_parent[rw],
1182 &parent_sq->queued[rw]);
6bc9c2b4
TH
1183 BUG_ON(tg->td->nr_queued[rw] <= 0);
1184 tg->td->nr_queued[rw]--;
1185 }
e43473b7 1186
0f3457f6 1187 throtl_trim_slice(tg, rw);
6bc9c2b4 1188
c5cc2070
TH
1189 if (tg_to_put)
1190 blkg_put(tg_to_blkg(tg_to_put));
e43473b7
VG
1191}
1192
77216b04 1193static int throtl_dispatch_tg(struct throtl_grp *tg)
e43473b7 1194{
73f0d49a 1195 struct throtl_service_queue *sq = &tg->service_queue;
e43473b7 1196 unsigned int nr_reads = 0, nr_writes = 0;
e675df2a
BW
1197 unsigned int max_nr_reads = THROTL_GRP_QUANTUM * 3 / 4;
1198 unsigned int max_nr_writes = THROTL_GRP_QUANTUM - max_nr_reads;
e43473b7
VG
1199 struct bio *bio;
1200
1201 /* Try to dispatch 75% READS and 25% WRITES */
1202
c5cc2070 1203 while ((bio = throtl_peek_queued(&sq->queued[READ])) &&
0f3457f6 1204 tg_may_dispatch(tg, bio, NULL)) {
e43473b7 1205
77216b04 1206 tg_dispatch_one_bio(tg, bio_data_dir(bio));
e43473b7
VG
1207 nr_reads++;
1208
1209 if (nr_reads >= max_nr_reads)
1210 break;
1211 }
1212
c5cc2070 1213 while ((bio = throtl_peek_queued(&sq->queued[WRITE])) &&
0f3457f6 1214 tg_may_dispatch(tg, bio, NULL)) {
e43473b7 1215
77216b04 1216 tg_dispatch_one_bio(tg, bio_data_dir(bio));
e43473b7
VG
1217 nr_writes++;
1218
1219 if (nr_writes >= max_nr_writes)
1220 break;
1221 }
1222
1223 return nr_reads + nr_writes;
1224}
1225
651930bc 1226static int throtl_select_dispatch(struct throtl_service_queue *parent_sq)
e43473b7
VG
1227{
1228 unsigned int nr_disp = 0;
e43473b7
VG
1229
1230 while (1) {
2397611a 1231 struct throtl_grp *tg;
2ab74cd2 1232 struct throtl_service_queue *sq;
e43473b7 1233
2397611a
BW
1234 if (!parent_sq->nr_pending)
1235 break;
1236
1237 tg = throtl_rb_first(parent_sq);
e43473b7
VG
1238 if (!tg)
1239 break;
1240
1241 if (time_before(jiffies, tg->disptime))
1242 break;
1243
77216b04 1244 throtl_dequeue_tg(tg);
e43473b7 1245
77216b04 1246 nr_disp += throtl_dispatch_tg(tg);
e43473b7 1247
2ab74cd2 1248 sq = &tg->service_queue;
73f0d49a 1249 if (sq->nr_queued[0] || sq->nr_queued[1])
77216b04 1250 tg_update_disptime(tg);
e43473b7 1251
e675df2a 1252 if (nr_disp >= THROTL_QUANTUM)
e43473b7
VG
1253 break;
1254 }
1255
1256 return nr_disp;
1257}
1258
c79892c5
SL
1259static bool throtl_can_upgrade(struct throtl_data *td,
1260 struct throtl_grp *this_tg);
6e1a5704
TH
1261/**
1262 * throtl_pending_timer_fn - timer function for service_queue->pending_timer
216382dc 1263 * @t: the pending_timer member of the throtl_service_queue being serviced
6e1a5704
TH
1264 *
1265 * This timer is armed when a child throtl_grp with active bio's become
1266 * pending and queued on the service_queue's pending_tree and expires when
1267 * the first child throtl_grp should be dispatched. This function
2e48a530
TH
1268 * dispatches bio's from the children throtl_grps to the parent
1269 * service_queue.
1270 *
1271 * If the parent's parent is another throtl_grp, dispatching is propagated
1272 * by either arming its pending_timer or repeating dispatch directly. If
1273 * the top-level service_tree is reached, throtl_data->dispatch_work is
1274 * kicked so that the ready bio's are issued.
6e1a5704 1275 */
e99e88a9 1276static void throtl_pending_timer_fn(struct timer_list *t)
69df0ab0 1277{
e99e88a9 1278 struct throtl_service_queue *sq = from_timer(sq, t, pending_timer);
2e48a530 1279 struct throtl_grp *tg = sq_to_tg(sq);
69df0ab0 1280 struct throtl_data *td = sq_to_td(sq);
cb76199c 1281 struct request_queue *q = td->queue;
2e48a530
TH
1282 struct throtl_service_queue *parent_sq;
1283 bool dispatched;
6e1a5704 1284 int ret;
e43473b7 1285
0d945c1f 1286 spin_lock_irq(&q->queue_lock);
c79892c5
SL
1287 if (throtl_can_upgrade(td, NULL))
1288 throtl_upgrade_state(td);
1289
2e48a530
TH
1290again:
1291 parent_sq = sq->parent_sq;
1292 dispatched = false;
e43473b7 1293
7f52f98c
TH
1294 while (true) {
1295 throtl_log(sq, "dispatch nr_queued=%u read=%u write=%u",
2e48a530
TH
1296 sq->nr_queued[READ] + sq->nr_queued[WRITE],
1297 sq->nr_queued[READ], sq->nr_queued[WRITE]);
7f52f98c
TH
1298
1299 ret = throtl_select_dispatch(sq);
1300 if (ret) {
7f52f98c
TH
1301 throtl_log(sq, "bios disp=%u", ret);
1302 dispatched = true;
1303 }
e43473b7 1304
7f52f98c
TH
1305 if (throtl_schedule_next_dispatch(sq, false))
1306 break;
e43473b7 1307
7f52f98c 1308 /* this dispatch windows is still open, relax and repeat */
0d945c1f 1309 spin_unlock_irq(&q->queue_lock);
7f52f98c 1310 cpu_relax();
0d945c1f 1311 spin_lock_irq(&q->queue_lock);
651930bc 1312 }
e43473b7 1313
2e48a530
TH
1314 if (!dispatched)
1315 goto out_unlock;
6e1a5704 1316
2e48a530
TH
1317 if (parent_sq) {
1318 /* @parent_sq is another throl_grp, propagate dispatch */
1319 if (tg->flags & THROTL_TG_WAS_EMPTY) {
1320 tg_update_disptime(tg);
1321 if (!throtl_schedule_next_dispatch(parent_sq, false)) {
1322 /* window is already open, repeat dispatching */
1323 sq = parent_sq;
1324 tg = sq_to_tg(sq);
1325 goto again;
1326 }
1327 }
1328 } else {
b53b072c 1329 /* reached the top-level, queue issuing */
2e48a530
TH
1330 queue_work(kthrotld_workqueue, &td->dispatch_work);
1331 }
1332out_unlock:
0d945c1f 1333 spin_unlock_irq(&q->queue_lock);
6e1a5704 1334}
e43473b7 1335
6e1a5704
TH
1336/**
1337 * blk_throtl_dispatch_work_fn - work function for throtl_data->dispatch_work
1338 * @work: work item being executed
1339 *
b53b072c
BW
1340 * This function is queued for execution when bios reach the bio_lists[]
1341 * of throtl_data->service_queue. Those bios are ready and issued by this
6e1a5704
TH
1342 * function.
1343 */
8876e140 1344static void blk_throtl_dispatch_work_fn(struct work_struct *work)
6e1a5704
TH
1345{
1346 struct throtl_data *td = container_of(work, struct throtl_data,
1347 dispatch_work);
1348 struct throtl_service_queue *td_sq = &td->service_queue;
1349 struct request_queue *q = td->queue;
1350 struct bio_list bio_list_on_stack;
1351 struct bio *bio;
1352 struct blk_plug plug;
1353 int rw;
1354
1355 bio_list_init(&bio_list_on_stack);
1356
0d945c1f 1357 spin_lock_irq(&q->queue_lock);
c5cc2070
TH
1358 for (rw = READ; rw <= WRITE; rw++)
1359 while ((bio = throtl_pop_queued(&td_sq->queued[rw], NULL)))
1360 bio_list_add(&bio_list_on_stack, bio);
0d945c1f 1361 spin_unlock_irq(&q->queue_lock);
6e1a5704
TH
1362
1363 if (!bio_list_empty(&bio_list_on_stack)) {
69d60eb9 1364 blk_start_plug(&plug);
ed00aabd
CH
1365 while ((bio = bio_list_pop(&bio_list_on_stack)))
1366 submit_bio_noacct(bio);
69d60eb9 1367 blk_finish_plug(&plug);
e43473b7 1368 }
e43473b7
VG
1369}
1370
f95a04af
TH
1371static u64 tg_prfill_conf_u64(struct seq_file *sf, struct blkg_policy_data *pd,
1372 int off)
60c2bc2d 1373{
f95a04af
TH
1374 struct throtl_grp *tg = pd_to_tg(pd);
1375 u64 v = *(u64 *)((void *)tg + off);
60c2bc2d 1376
2ab5492d 1377 if (v == U64_MAX)
60c2bc2d 1378 return 0;
f95a04af 1379 return __blkg_prfill_u64(sf, pd, v);
60c2bc2d
TH
1380}
1381
f95a04af
TH
1382static u64 tg_prfill_conf_uint(struct seq_file *sf, struct blkg_policy_data *pd,
1383 int off)
e43473b7 1384{
f95a04af
TH
1385 struct throtl_grp *tg = pd_to_tg(pd);
1386 unsigned int v = *(unsigned int *)((void *)tg + off);
fe071437 1387
2ab5492d 1388 if (v == UINT_MAX)
af133ceb 1389 return 0;
f95a04af 1390 return __blkg_prfill_u64(sf, pd, v);
e43473b7
VG
1391}
1392
2da8ca82 1393static int tg_print_conf_u64(struct seq_file *sf, void *v)
8e89d13f 1394{
2da8ca82
TH
1395 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_u64,
1396 &blkcg_policy_throtl, seq_cft(sf)->private, false);
af133ceb 1397 return 0;
8e89d13f
VG
1398}
1399
2da8ca82 1400static int tg_print_conf_uint(struct seq_file *sf, void *v)
8e89d13f 1401{
2da8ca82
TH
1402 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_conf_uint,
1403 &blkcg_policy_throtl, seq_cft(sf)->private, false);
af133ceb 1404 return 0;
60c2bc2d
TH
1405}
1406
9bb67aeb 1407static void tg_conf_updated(struct throtl_grp *tg, bool global)
60c2bc2d 1408{
69948b07 1409 struct throtl_service_queue *sq = &tg->service_queue;
492eb21b 1410 struct cgroup_subsys_state *pos_css;
69948b07 1411 struct blkcg_gq *blkg;
af133ceb 1412
fda6f272
TH
1413 throtl_log(&tg->service_queue,
1414 "limit change rbps=%llu wbps=%llu riops=%u wiops=%u",
9f626e37
SL
1415 tg_bps_limit(tg, READ), tg_bps_limit(tg, WRITE),
1416 tg_iops_limit(tg, READ), tg_iops_limit(tg, WRITE));
632b4493 1417
693e751e
TH
1418 /*
1419 * Update has_rules[] flags for the updated tg's subtree. A tg is
1420 * considered to have rules if either the tg itself or any of its
1421 * ancestors has rules. This identifies groups without any
1422 * restrictions in the whole hierarchy and allows them to bypass
1423 * blk-throttle.
1424 */
9bb67aeb
SL
1425 blkg_for_each_descendant_pre(blkg, pos_css,
1426 global ? tg->td->queue->root_blkg : tg_to_blkg(tg)) {
5b81fc3c
SL
1427 struct throtl_grp *this_tg = blkg_to_tg(blkg);
1428 struct throtl_grp *parent_tg;
1429
1430 tg_update_has_rules(this_tg);
1431 /* ignore root/second level */
1432 if (!cgroup_subsys_on_dfl(io_cgrp_subsys) || !blkg->parent ||
1433 !blkg->parent->parent)
1434 continue;
1435 parent_tg = blkg_to_tg(blkg->parent);
1436 /*
1437 * make sure all children has lower idle time threshold and
1438 * higher latency target
1439 */
1440 this_tg->idletime_threshold = min(this_tg->idletime_threshold,
1441 parent_tg->idletime_threshold);
1442 this_tg->latency_target = max(this_tg->latency_target,
1443 parent_tg->latency_target);
1444 }
693e751e 1445
632b4493
TH
1446 /*
1447 * We're already holding queue_lock and know @tg is valid. Let's
1448 * apply the new config directly.
1449 *
1450 * Restart the slices for both READ and WRITES. It might happen
1451 * that a group's limit are dropped suddenly and we don't want to
1452 * account recently dispatched IO with new low rate.
1453 */
ff8b22c0
BW
1454 throtl_start_new_slice(tg, READ);
1455 throtl_start_new_slice(tg, WRITE);
632b4493 1456
5b2c16aa 1457 if (tg->flags & THROTL_TG_PENDING) {
77216b04 1458 tg_update_disptime(tg);
7f52f98c 1459 throtl_schedule_next_dispatch(sq->parent_sq, true);
632b4493 1460 }
69948b07
TH
1461}
1462
1463static ssize_t tg_set_conf(struct kernfs_open_file *of,
1464 char *buf, size_t nbytes, loff_t off, bool is_u64)
1465{
1466 struct blkcg *blkcg = css_to_blkcg(of_css(of));
1467 struct blkg_conf_ctx ctx;
1468 struct throtl_grp *tg;
1469 int ret;
1470 u64 v;
1471
1472 ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
1473 if (ret)
1474 return ret;
1475
1476 ret = -EINVAL;
1477 if (sscanf(ctx.body, "%llu", &v) != 1)
1478 goto out_finish;
1479 if (!v)
2ab5492d 1480 v = U64_MAX;
69948b07
TH
1481
1482 tg = blkg_to_tg(ctx.blkg);
1483
1484 if (is_u64)
1485 *(u64 *)((void *)tg + of_cft(of)->private) = v;
1486 else
1487 *(unsigned int *)((void *)tg + of_cft(of)->private) = v;
60c2bc2d 1488
9bb67aeb 1489 tg_conf_updated(tg, false);
36aa9e5f
TH
1490 ret = 0;
1491out_finish:
60c2bc2d 1492 blkg_conf_finish(&ctx);
36aa9e5f 1493 return ret ?: nbytes;
8e89d13f
VG
1494}
1495
451af504
TH
1496static ssize_t tg_set_conf_u64(struct kernfs_open_file *of,
1497 char *buf, size_t nbytes, loff_t off)
60c2bc2d 1498{
451af504 1499 return tg_set_conf(of, buf, nbytes, off, true);
60c2bc2d
TH
1500}
1501
451af504
TH
1502static ssize_t tg_set_conf_uint(struct kernfs_open_file *of,
1503 char *buf, size_t nbytes, loff_t off)
60c2bc2d 1504{
451af504 1505 return tg_set_conf(of, buf, nbytes, off, false);
60c2bc2d
TH
1506}
1507
7ca46438
TH
1508static int tg_print_rwstat(struct seq_file *sf, void *v)
1509{
1510 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
1511 blkg_prfill_rwstat, &blkcg_policy_throtl,
1512 seq_cft(sf)->private, true);
1513 return 0;
1514}
1515
1516static u64 tg_prfill_rwstat_recursive(struct seq_file *sf,
1517 struct blkg_policy_data *pd, int off)
1518{
1519 struct blkg_rwstat_sample sum;
1520
1521 blkg_rwstat_recursive_sum(pd_to_blkg(pd), &blkcg_policy_throtl, off,
1522 &sum);
1523 return __blkg_prfill_rwstat(sf, pd, &sum);
1524}
1525
1526static int tg_print_rwstat_recursive(struct seq_file *sf, void *v)
1527{
1528 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
1529 tg_prfill_rwstat_recursive, &blkcg_policy_throtl,
1530 seq_cft(sf)->private, true);
1531 return 0;
1532}
1533
880f50e2 1534static struct cftype throtl_legacy_files[] = {
60c2bc2d
TH
1535 {
1536 .name = "throttle.read_bps_device",
9f626e37 1537 .private = offsetof(struct throtl_grp, bps[READ][LIMIT_MAX]),
2da8ca82 1538 .seq_show = tg_print_conf_u64,
451af504 1539 .write = tg_set_conf_u64,
60c2bc2d
TH
1540 },
1541 {
1542 .name = "throttle.write_bps_device",
9f626e37 1543 .private = offsetof(struct throtl_grp, bps[WRITE][LIMIT_MAX]),
2da8ca82 1544 .seq_show = tg_print_conf_u64,
451af504 1545 .write = tg_set_conf_u64,
60c2bc2d
TH
1546 },
1547 {
1548 .name = "throttle.read_iops_device",
9f626e37 1549 .private = offsetof(struct throtl_grp, iops[READ][LIMIT_MAX]),
2da8ca82 1550 .seq_show = tg_print_conf_uint,
451af504 1551 .write = tg_set_conf_uint,
60c2bc2d
TH
1552 },
1553 {
1554 .name = "throttle.write_iops_device",
9f626e37 1555 .private = offsetof(struct throtl_grp, iops[WRITE][LIMIT_MAX]),
2da8ca82 1556 .seq_show = tg_print_conf_uint,
451af504 1557 .write = tg_set_conf_uint,
60c2bc2d
TH
1558 },
1559 {
1560 .name = "throttle.io_service_bytes",
7ca46438
TH
1561 .private = offsetof(struct throtl_grp, stat_bytes),
1562 .seq_show = tg_print_rwstat,
60c2bc2d 1563 },
17534c6f 1564 {
1565 .name = "throttle.io_service_bytes_recursive",
7ca46438
TH
1566 .private = offsetof(struct throtl_grp, stat_bytes),
1567 .seq_show = tg_print_rwstat_recursive,
17534c6f 1568 },
60c2bc2d
TH
1569 {
1570 .name = "throttle.io_serviced",
7ca46438
TH
1571 .private = offsetof(struct throtl_grp, stat_ios),
1572 .seq_show = tg_print_rwstat,
60c2bc2d 1573 },
17534c6f 1574 {
1575 .name = "throttle.io_serviced_recursive",
7ca46438
TH
1576 .private = offsetof(struct throtl_grp, stat_ios),
1577 .seq_show = tg_print_rwstat_recursive,
17534c6f 1578 },
60c2bc2d
TH
1579 { } /* terminate */
1580};
1581
cd5ab1b0 1582static u64 tg_prfill_limit(struct seq_file *sf, struct blkg_policy_data *pd,
2ee867dc
TH
1583 int off)
1584{
1585 struct throtl_grp *tg = pd_to_tg(pd);
1586 const char *dname = blkg_dev_name(pd->blkg);
1587 char bufs[4][21] = { "max", "max", "max", "max" };
cd5ab1b0
SL
1588 u64 bps_dft;
1589 unsigned int iops_dft;
ada75b6e 1590 char idle_time[26] = "";
ec80991d 1591 char latency_time[26] = "";
2ee867dc
TH
1592
1593 if (!dname)
1594 return 0;
9f626e37 1595
cd5ab1b0
SL
1596 if (off == LIMIT_LOW) {
1597 bps_dft = 0;
1598 iops_dft = 0;
1599 } else {
1600 bps_dft = U64_MAX;
1601 iops_dft = UINT_MAX;
1602 }
1603
1604 if (tg->bps_conf[READ][off] == bps_dft &&
1605 tg->bps_conf[WRITE][off] == bps_dft &&
1606 tg->iops_conf[READ][off] == iops_dft &&
ada75b6e 1607 tg->iops_conf[WRITE][off] == iops_dft &&
ec80991d 1608 (off != LIMIT_LOW ||
b4f428ef 1609 (tg->idletime_threshold_conf == DFL_IDLE_THRESHOLD &&
5b81fc3c 1610 tg->latency_target_conf == DFL_LATENCY_TARGET)))
2ee867dc
TH
1611 return 0;
1612
9bb67aeb 1613 if (tg->bps_conf[READ][off] != U64_MAX)
9f626e37 1614 snprintf(bufs[0], sizeof(bufs[0]), "%llu",
cd5ab1b0 1615 tg->bps_conf[READ][off]);
9bb67aeb 1616 if (tg->bps_conf[WRITE][off] != U64_MAX)
9f626e37 1617 snprintf(bufs[1], sizeof(bufs[1]), "%llu",
cd5ab1b0 1618 tg->bps_conf[WRITE][off]);
9bb67aeb 1619 if (tg->iops_conf[READ][off] != UINT_MAX)
9f626e37 1620 snprintf(bufs[2], sizeof(bufs[2]), "%u",
cd5ab1b0 1621 tg->iops_conf[READ][off]);
9bb67aeb 1622 if (tg->iops_conf[WRITE][off] != UINT_MAX)
9f626e37 1623 snprintf(bufs[3], sizeof(bufs[3]), "%u",
cd5ab1b0 1624 tg->iops_conf[WRITE][off]);
ada75b6e 1625 if (off == LIMIT_LOW) {
5b81fc3c 1626 if (tg->idletime_threshold_conf == ULONG_MAX)
ada75b6e
SL
1627 strcpy(idle_time, " idle=max");
1628 else
1629 snprintf(idle_time, sizeof(idle_time), " idle=%lu",
5b81fc3c 1630 tg->idletime_threshold_conf);
ec80991d 1631
5b81fc3c 1632 if (tg->latency_target_conf == ULONG_MAX)
ec80991d
SL
1633 strcpy(latency_time, " latency=max");
1634 else
1635 snprintf(latency_time, sizeof(latency_time),
5b81fc3c 1636 " latency=%lu", tg->latency_target_conf);
ada75b6e 1637 }
2ee867dc 1638
ec80991d
SL
1639 seq_printf(sf, "%s rbps=%s wbps=%s riops=%s wiops=%s%s%s\n",
1640 dname, bufs[0], bufs[1], bufs[2], bufs[3], idle_time,
1641 latency_time);
2ee867dc
TH
1642 return 0;
1643}
1644
cd5ab1b0 1645static int tg_print_limit(struct seq_file *sf, void *v)
2ee867dc 1646{
cd5ab1b0 1647 blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)), tg_prfill_limit,
2ee867dc
TH
1648 &blkcg_policy_throtl, seq_cft(sf)->private, false);
1649 return 0;
1650}
1651
cd5ab1b0 1652static ssize_t tg_set_limit(struct kernfs_open_file *of,
2ee867dc
TH
1653 char *buf, size_t nbytes, loff_t off)
1654{
1655 struct blkcg *blkcg = css_to_blkcg(of_css(of));
1656 struct blkg_conf_ctx ctx;
1657 struct throtl_grp *tg;
1658 u64 v[4];
ada75b6e 1659 unsigned long idle_time;
ec80991d 1660 unsigned long latency_time;
2ee867dc 1661 int ret;
cd5ab1b0 1662 int index = of_cft(of)->private;
2ee867dc
TH
1663
1664 ret = blkg_conf_prep(blkcg, &blkcg_policy_throtl, buf, &ctx);
1665 if (ret)
1666 return ret;
1667
1668 tg = blkg_to_tg(ctx.blkg);
1669
cd5ab1b0
SL
1670 v[0] = tg->bps_conf[READ][index];
1671 v[1] = tg->bps_conf[WRITE][index];
1672 v[2] = tg->iops_conf[READ][index];
1673 v[3] = tg->iops_conf[WRITE][index];
2ee867dc 1674
5b81fc3c
SL
1675 idle_time = tg->idletime_threshold_conf;
1676 latency_time = tg->latency_target_conf;
2ee867dc
TH
1677 while (true) {
1678 char tok[27]; /* wiops=18446744073709551616 */
1679 char *p;
2ab5492d 1680 u64 val = U64_MAX;
2ee867dc
TH
1681 int len;
1682
1683 if (sscanf(ctx.body, "%26s%n", tok, &len) != 1)
1684 break;
1685 if (tok[0] == '\0')
1686 break;
1687 ctx.body += len;
1688
1689 ret = -EINVAL;
1690 p = tok;
1691 strsep(&p, "=");
1692 if (!p || (sscanf(p, "%llu", &val) != 1 && strcmp(p, "max")))
1693 goto out_finish;
1694
1695 ret = -ERANGE;
1696 if (!val)
1697 goto out_finish;
1698
1699 ret = -EINVAL;
5b7048b8 1700 if (!strcmp(tok, "rbps") && val > 1)
2ee867dc 1701 v[0] = val;
5b7048b8 1702 else if (!strcmp(tok, "wbps") && val > 1)
2ee867dc 1703 v[1] = val;
5b7048b8 1704 else if (!strcmp(tok, "riops") && val > 1)
2ee867dc 1705 v[2] = min_t(u64, val, UINT_MAX);
5b7048b8 1706 else if (!strcmp(tok, "wiops") && val > 1)
2ee867dc 1707 v[3] = min_t(u64, val, UINT_MAX);
ada75b6e
SL
1708 else if (off == LIMIT_LOW && !strcmp(tok, "idle"))
1709 idle_time = val;
ec80991d
SL
1710 else if (off == LIMIT_LOW && !strcmp(tok, "latency"))
1711 latency_time = val;
2ee867dc
TH
1712 else
1713 goto out_finish;
1714 }
1715
cd5ab1b0
SL
1716 tg->bps_conf[READ][index] = v[0];
1717 tg->bps_conf[WRITE][index] = v[1];
1718 tg->iops_conf[READ][index] = v[2];
1719 tg->iops_conf[WRITE][index] = v[3];
2ee867dc 1720
cd5ab1b0
SL
1721 if (index == LIMIT_MAX) {
1722 tg->bps[READ][index] = v[0];
1723 tg->bps[WRITE][index] = v[1];
1724 tg->iops[READ][index] = v[2];
1725 tg->iops[WRITE][index] = v[3];
1726 }
1727 tg->bps[READ][LIMIT_LOW] = min(tg->bps_conf[READ][LIMIT_LOW],
1728 tg->bps_conf[READ][LIMIT_MAX]);
1729 tg->bps[WRITE][LIMIT_LOW] = min(tg->bps_conf[WRITE][LIMIT_LOW],
1730 tg->bps_conf[WRITE][LIMIT_MAX]);
1731 tg->iops[READ][LIMIT_LOW] = min(tg->iops_conf[READ][LIMIT_LOW],
1732 tg->iops_conf[READ][LIMIT_MAX]);
1733 tg->iops[WRITE][LIMIT_LOW] = min(tg->iops_conf[WRITE][LIMIT_LOW],
1734 tg->iops_conf[WRITE][LIMIT_MAX]);
b4f428ef
SL
1735 tg->idletime_threshold_conf = idle_time;
1736 tg->latency_target_conf = latency_time;
1737
1738 /* force user to configure all settings for low limit */
1739 if (!(tg->bps[READ][LIMIT_LOW] || tg->iops[READ][LIMIT_LOW] ||
1740 tg->bps[WRITE][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW]) ||
1741 tg->idletime_threshold_conf == DFL_IDLE_THRESHOLD ||
1742 tg->latency_target_conf == DFL_LATENCY_TARGET) {
1743 tg->bps[READ][LIMIT_LOW] = 0;
1744 tg->bps[WRITE][LIMIT_LOW] = 0;
1745 tg->iops[READ][LIMIT_LOW] = 0;
1746 tg->iops[WRITE][LIMIT_LOW] = 0;
1747 tg->idletime_threshold = DFL_IDLE_THRESHOLD;
1748 tg->latency_target = DFL_LATENCY_TARGET;
1749 } else if (index == LIMIT_LOW) {
5b81fc3c 1750 tg->idletime_threshold = tg->idletime_threshold_conf;
5b81fc3c 1751 tg->latency_target = tg->latency_target_conf;
cd5ab1b0 1752 }
b4f428ef
SL
1753
1754 blk_throtl_update_limit_valid(tg->td);
1755 if (tg->td->limit_valid[LIMIT_LOW]) {
1756 if (index == LIMIT_LOW)
1757 tg->td->limit_index = LIMIT_LOW;
1758 } else
1759 tg->td->limit_index = LIMIT_MAX;
9bb67aeb
SL
1760 tg_conf_updated(tg, index == LIMIT_LOW &&
1761 tg->td->limit_valid[LIMIT_LOW]);
2ee867dc
TH
1762 ret = 0;
1763out_finish:
1764 blkg_conf_finish(&ctx);
1765 return ret ?: nbytes;
1766}
1767
1768static struct cftype throtl_files[] = {
cd5ab1b0
SL
1769#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
1770 {
1771 .name = "low",
1772 .flags = CFTYPE_NOT_ON_ROOT,
1773 .seq_show = tg_print_limit,
1774 .write = tg_set_limit,
1775 .private = LIMIT_LOW,
1776 },
1777#endif
2ee867dc
TH
1778 {
1779 .name = "max",
1780 .flags = CFTYPE_NOT_ON_ROOT,
cd5ab1b0
SL
1781 .seq_show = tg_print_limit,
1782 .write = tg_set_limit,
1783 .private = LIMIT_MAX,
2ee867dc
TH
1784 },
1785 { } /* terminate */
1786};
1787
da527770 1788static void throtl_shutdown_wq(struct request_queue *q)
e43473b7
VG
1789{
1790 struct throtl_data *td = q->td;
1791
69df0ab0 1792 cancel_work_sync(&td->dispatch_work);
e43473b7
VG
1793}
1794
3c798398 1795static struct blkcg_policy blkcg_policy_throtl = {
2ee867dc 1796 .dfl_cftypes = throtl_files,
880f50e2 1797 .legacy_cftypes = throtl_legacy_files,
f9fcc2d3 1798
001bea73 1799 .pd_alloc_fn = throtl_pd_alloc,
f9fcc2d3 1800 .pd_init_fn = throtl_pd_init,
693e751e 1801 .pd_online_fn = throtl_pd_online,
cd5ab1b0 1802 .pd_offline_fn = throtl_pd_offline,
001bea73 1803 .pd_free_fn = throtl_pd_free,
e43473b7
VG
1804};
1805
3f0abd80
SL
1806static unsigned long __tg_last_low_overflow_time(struct throtl_grp *tg)
1807{
1808 unsigned long rtime = jiffies, wtime = jiffies;
1809
1810 if (tg->bps[READ][LIMIT_LOW] || tg->iops[READ][LIMIT_LOW])
1811 rtime = tg->last_low_overflow_time[READ];
1812 if (tg->bps[WRITE][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW])
1813 wtime = tg->last_low_overflow_time[WRITE];
1814 return min(rtime, wtime);
1815}
1816
1817/* tg should not be an intermediate node */
1818static unsigned long tg_last_low_overflow_time(struct throtl_grp *tg)
1819{
1820 struct throtl_service_queue *parent_sq;
1821 struct throtl_grp *parent = tg;
1822 unsigned long ret = __tg_last_low_overflow_time(tg);
1823
1824 while (true) {
1825 parent_sq = parent->service_queue.parent_sq;
1826 parent = sq_to_tg(parent_sq);
1827 if (!parent)
1828 break;
1829
1830 /*
1831 * The parent doesn't have low limit, it always reaches low
1832 * limit. Its overflow time is useless for children
1833 */
1834 if (!parent->bps[READ][LIMIT_LOW] &&
1835 !parent->iops[READ][LIMIT_LOW] &&
1836 !parent->bps[WRITE][LIMIT_LOW] &&
1837 !parent->iops[WRITE][LIMIT_LOW])
1838 continue;
1839 if (time_after(__tg_last_low_overflow_time(parent), ret))
1840 ret = __tg_last_low_overflow_time(parent);
1841 }
1842 return ret;
1843}
1844
9e234eea
SL
1845static bool throtl_tg_is_idle(struct throtl_grp *tg)
1846{
1847 /*
1848 * cgroup is idle if:
1849 * - single idle is too long, longer than a fixed value (in case user
b4f428ef 1850 * configure a too big threshold) or 4 times of idletime threshold
9e234eea 1851 * - average think time is more than threshold
53696b8d 1852 * - IO latency is largely below threshold
9e234eea 1853 */
b4f428ef 1854 unsigned long time;
4cff729f 1855 bool ret;
9e234eea 1856
b4f428ef
SL
1857 time = min_t(unsigned long, MAX_IDLE_TIME, 4 * tg->idletime_threshold);
1858 ret = tg->latency_target == DFL_LATENCY_TARGET ||
1859 tg->idletime_threshold == DFL_IDLE_THRESHOLD ||
1860 (ktime_get_ns() >> 10) - tg->last_finish_time > time ||
1861 tg->avg_idletime > tg->idletime_threshold ||
1862 (tg->latency_target && tg->bio_cnt &&
53696b8d 1863 tg->bad_bio_cnt * 5 < tg->bio_cnt);
4cff729f
SL
1864 throtl_log(&tg->service_queue,
1865 "avg_idle=%ld, idle_threshold=%ld, bad_bio=%d, total_bio=%d, is_idle=%d, scale=%d",
1866 tg->avg_idletime, tg->idletime_threshold, tg->bad_bio_cnt,
1867 tg->bio_cnt, ret, tg->td->scale);
1868 return ret;
9e234eea
SL
1869}
1870
c79892c5
SL
1871static bool throtl_tg_can_upgrade(struct throtl_grp *tg)
1872{
1873 struct throtl_service_queue *sq = &tg->service_queue;
1874 bool read_limit, write_limit;
1875
1876 /*
1877 * if cgroup reaches low limit (if low limit is 0, the cgroup always
1878 * reaches), it's ok to upgrade to next limit
1879 */
1880 read_limit = tg->bps[READ][LIMIT_LOW] || tg->iops[READ][LIMIT_LOW];
1881 write_limit = tg->bps[WRITE][LIMIT_LOW] || tg->iops[WRITE][LIMIT_LOW];
1882 if (!read_limit && !write_limit)
1883 return true;
1884 if (read_limit && sq->nr_queued[READ] &&
1885 (!write_limit || sq->nr_queued[WRITE]))
1886 return true;
1887 if (write_limit && sq->nr_queued[WRITE] &&
1888 (!read_limit || sq->nr_queued[READ]))
1889 return true;
aec24246
SL
1890
1891 if (time_after_eq(jiffies,
fa6fb5aa
SL
1892 tg_last_low_overflow_time(tg) + tg->td->throtl_slice) &&
1893 throtl_tg_is_idle(tg))
aec24246 1894 return true;
c79892c5
SL
1895 return false;
1896}
1897
1898static bool throtl_hierarchy_can_upgrade(struct throtl_grp *tg)
1899{
1900 while (true) {
1901 if (throtl_tg_can_upgrade(tg))
1902 return true;
1903 tg = sq_to_tg(tg->service_queue.parent_sq);
1904 if (!tg || !tg_to_blkg(tg)->parent)
1905 return false;
1906 }
1907 return false;
1908}
1909
1910static bool throtl_can_upgrade(struct throtl_data *td,
1911 struct throtl_grp *this_tg)
1912{
1913 struct cgroup_subsys_state *pos_css;
1914 struct blkcg_gq *blkg;
1915
1916 if (td->limit_index != LIMIT_LOW)
1917 return false;
1918
297e3d85 1919 if (time_before(jiffies, td->low_downgrade_time + td->throtl_slice))
3f0abd80
SL
1920 return false;
1921
c79892c5
SL
1922 rcu_read_lock();
1923 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
1924 struct throtl_grp *tg = blkg_to_tg(blkg);
1925
1926 if (tg == this_tg)
1927 continue;
1928 if (!list_empty(&tg_to_blkg(tg)->blkcg->css.children))
1929 continue;
1930 if (!throtl_hierarchy_can_upgrade(tg)) {
1931 rcu_read_unlock();
1932 return false;
1933 }
1934 }
1935 rcu_read_unlock();
1936 return true;
1937}
1938
fa6fb5aa
SL
1939static void throtl_upgrade_check(struct throtl_grp *tg)
1940{
1941 unsigned long now = jiffies;
1942
1943 if (tg->td->limit_index != LIMIT_LOW)
1944 return;
1945
1946 if (time_after(tg->last_check_time + tg->td->throtl_slice, now))
1947 return;
1948
1949 tg->last_check_time = now;
1950
1951 if (!time_after_eq(now,
1952 __tg_last_low_overflow_time(tg) + tg->td->throtl_slice))
1953 return;
1954
1955 if (throtl_can_upgrade(tg->td, NULL))
1956 throtl_upgrade_state(tg->td);
1957}
1958
c79892c5
SL
1959static void throtl_upgrade_state(struct throtl_data *td)
1960{
1961 struct cgroup_subsys_state *pos_css;
1962 struct blkcg_gq *blkg;
1963
4cff729f 1964 throtl_log(&td->service_queue, "upgrade to max");
c79892c5 1965 td->limit_index = LIMIT_MAX;
3f0abd80 1966 td->low_upgrade_time = jiffies;
7394e31f 1967 td->scale = 0;
c79892c5
SL
1968 rcu_read_lock();
1969 blkg_for_each_descendant_post(blkg, pos_css, td->queue->root_blkg) {
1970 struct throtl_grp *tg = blkg_to_tg(blkg);
1971 struct throtl_service_queue *sq = &tg->service_queue;
1972
1973 tg->disptime = jiffies - 1;
1974 throtl_select_dispatch(sq);
4f02fb76 1975 throtl_schedule_next_dispatch(sq, true);
c79892c5
SL
1976 }
1977 rcu_read_unlock();
1978 throtl_select_dispatch(&td->service_queue);
4f02fb76 1979 throtl_schedule_next_dispatch(&td->service_queue, true);
c79892c5
SL
1980 queue_work(kthrotld_workqueue, &td->dispatch_work);
1981}
1982
4247d9c8 1983static void throtl_downgrade_state(struct throtl_data *td)
3f0abd80 1984{
7394e31f
SL
1985 td->scale /= 2;
1986
4cff729f 1987 throtl_log(&td->service_queue, "downgrade, scale %d", td->scale);
7394e31f
SL
1988 if (td->scale) {
1989 td->low_upgrade_time = jiffies - td->scale * td->throtl_slice;
1990 return;
1991 }
1992
4247d9c8 1993 td->limit_index = LIMIT_LOW;
3f0abd80
SL
1994 td->low_downgrade_time = jiffies;
1995}
1996
1997static bool throtl_tg_can_downgrade(struct throtl_grp *tg)
1998{
1999 struct throtl_data *td = tg->td;
2000 unsigned long now = jiffies;
2001
2002 /*
2003 * If cgroup is below low limit, consider downgrade and throttle other
2004 * cgroups
2005 */
297e3d85
SL
2006 if (time_after_eq(now, td->low_upgrade_time + td->throtl_slice) &&
2007 time_after_eq(now, tg_last_low_overflow_time(tg) +
fa6fb5aa
SL
2008 td->throtl_slice) &&
2009 (!throtl_tg_is_idle(tg) ||
2010 !list_empty(&tg_to_blkg(tg)->blkcg->css.children)))
3f0abd80
SL
2011 return true;
2012 return false;
2013}
2014
2015static bool throtl_hierarchy_can_downgrade(struct throtl_grp *tg)
2016{
2017 while (true) {
2018 if (!throtl_tg_can_downgrade(tg))
2019 return false;
2020 tg = sq_to_tg(tg->service_queue.parent_sq);
2021 if (!tg || !tg_to_blkg(tg)->parent)
2022 break;
2023 }
2024 return true;
2025}
2026
2027static void throtl_downgrade_check(struct throtl_grp *tg)
2028{
2029 uint64_t bps;
2030 unsigned int iops;
2031 unsigned long elapsed_time;
2032 unsigned long now = jiffies;
2033
2034 if (tg->td->limit_index != LIMIT_MAX ||
2035 !tg->td->limit_valid[LIMIT_LOW])
2036 return;
2037 if (!list_empty(&tg_to_blkg(tg)->blkcg->css.children))
2038 return;
297e3d85 2039 if (time_after(tg->last_check_time + tg->td->throtl_slice, now))
3f0abd80
SL
2040 return;
2041
2042 elapsed_time = now - tg->last_check_time;
2043 tg->last_check_time = now;
2044
297e3d85
SL
2045 if (time_before(now, tg_last_low_overflow_time(tg) +
2046 tg->td->throtl_slice))
3f0abd80
SL
2047 return;
2048
2049 if (tg->bps[READ][LIMIT_LOW]) {
2050 bps = tg->last_bytes_disp[READ] * HZ;
2051 do_div(bps, elapsed_time);
2052 if (bps >= tg->bps[READ][LIMIT_LOW])
2053 tg->last_low_overflow_time[READ] = now;
2054 }
2055
2056 if (tg->bps[WRITE][LIMIT_LOW]) {
2057 bps = tg->last_bytes_disp[WRITE] * HZ;
2058 do_div(bps, elapsed_time);
2059 if (bps >= tg->bps[WRITE][LIMIT_LOW])
2060 tg->last_low_overflow_time[WRITE] = now;
2061 }
2062
2063 if (tg->iops[READ][LIMIT_LOW]) {
4f1e9630 2064 tg->last_io_disp[READ] += atomic_xchg(&tg->last_io_split_cnt[READ], 0);
3f0abd80
SL
2065 iops = tg->last_io_disp[READ] * HZ / elapsed_time;
2066 if (iops >= tg->iops[READ][LIMIT_LOW])
2067 tg->last_low_overflow_time[READ] = now;
2068 }
2069
2070 if (tg->iops[WRITE][LIMIT_LOW]) {
4f1e9630 2071 tg->last_io_disp[WRITE] += atomic_xchg(&tg->last_io_split_cnt[WRITE], 0);
3f0abd80
SL
2072 iops = tg->last_io_disp[WRITE] * HZ / elapsed_time;
2073 if (iops >= tg->iops[WRITE][LIMIT_LOW])
2074 tg->last_low_overflow_time[WRITE] = now;
2075 }
2076
2077 /*
2078 * If cgroup is below low limit, consider downgrade and throttle other
2079 * cgroups
2080 */
2081 if (throtl_hierarchy_can_downgrade(tg))
4247d9c8 2082 throtl_downgrade_state(tg->td);
3f0abd80
SL
2083
2084 tg->last_bytes_disp[READ] = 0;
2085 tg->last_bytes_disp[WRITE] = 0;
2086 tg->last_io_disp[READ] = 0;
2087 tg->last_io_disp[WRITE] = 0;
2088}
2089
9e234eea
SL
2090static void blk_throtl_update_idletime(struct throtl_grp *tg)
2091{
7901601a 2092 unsigned long now;
9e234eea
SL
2093 unsigned long last_finish_time = tg->last_finish_time;
2094
7901601a
BW
2095 if (last_finish_time == 0)
2096 return;
2097
2098 now = ktime_get_ns() >> 10;
2099 if (now <= last_finish_time ||
9e234eea
SL
2100 last_finish_time == tg->checked_last_finish_time)
2101 return;
2102
2103 tg->avg_idletime = (tg->avg_idletime * 7 + now - last_finish_time) >> 3;
2104 tg->checked_last_finish_time = last_finish_time;
2105}
2106
b9147dd1
SL
2107#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2108static void throtl_update_latency_buckets(struct throtl_data *td)
2109{
b889bf66
JQ
2110 struct avg_latency_bucket avg_latency[2][LATENCY_BUCKET_SIZE];
2111 int i, cpu, rw;
2112 unsigned long last_latency[2] = { 0 };
2113 unsigned long latency[2];
b9147dd1 2114
b185efa7 2115 if (!blk_queue_nonrot(td->queue) || !td->limit_valid[LIMIT_LOW])
b9147dd1
SL
2116 return;
2117 if (time_before(jiffies, td->last_calculate_time + HZ))
2118 return;
2119 td->last_calculate_time = jiffies;
2120
2121 memset(avg_latency, 0, sizeof(avg_latency));
b889bf66
JQ
2122 for (rw = READ; rw <= WRITE; rw++) {
2123 for (i = 0; i < LATENCY_BUCKET_SIZE; i++) {
2124 struct latency_bucket *tmp = &td->tmp_buckets[rw][i];
2125
2126 for_each_possible_cpu(cpu) {
2127 struct latency_bucket *bucket;
2128
2129 /* this isn't race free, but ok in practice */
2130 bucket = per_cpu_ptr(td->latency_buckets[rw],
2131 cpu);
2132 tmp->total_latency += bucket[i].total_latency;
2133 tmp->samples += bucket[i].samples;
2134 bucket[i].total_latency = 0;
2135 bucket[i].samples = 0;
2136 }
b9147dd1 2137
b889bf66
JQ
2138 if (tmp->samples >= 32) {
2139 int samples = tmp->samples;
b9147dd1 2140
b889bf66 2141 latency[rw] = tmp->total_latency;
b9147dd1 2142
b889bf66
JQ
2143 tmp->total_latency = 0;
2144 tmp->samples = 0;
2145 latency[rw] /= samples;
2146 if (latency[rw] == 0)
2147 continue;
2148 avg_latency[rw][i].latency = latency[rw];
2149 }
b9147dd1
SL
2150 }
2151 }
2152
b889bf66
JQ
2153 for (rw = READ; rw <= WRITE; rw++) {
2154 for (i = 0; i < LATENCY_BUCKET_SIZE; i++) {
2155 if (!avg_latency[rw][i].latency) {
2156 if (td->avg_buckets[rw][i].latency < last_latency[rw])
2157 td->avg_buckets[rw][i].latency =
2158 last_latency[rw];
2159 continue;
2160 }
b9147dd1 2161
b889bf66
JQ
2162 if (!td->avg_buckets[rw][i].valid)
2163 latency[rw] = avg_latency[rw][i].latency;
2164 else
2165 latency[rw] = (td->avg_buckets[rw][i].latency * 7 +
2166 avg_latency[rw][i].latency) >> 3;
b9147dd1 2167
b889bf66
JQ
2168 td->avg_buckets[rw][i].latency = max(latency[rw],
2169 last_latency[rw]);
2170 td->avg_buckets[rw][i].valid = true;
2171 last_latency[rw] = td->avg_buckets[rw][i].latency;
2172 }
b9147dd1 2173 }
4cff729f
SL
2174
2175 for (i = 0; i < LATENCY_BUCKET_SIZE; i++)
2176 throtl_log(&td->service_queue,
b889bf66
JQ
2177 "Latency bucket %d: read latency=%ld, read valid=%d, "
2178 "write latency=%ld, write valid=%d", i,
2179 td->avg_buckets[READ][i].latency,
2180 td->avg_buckets[READ][i].valid,
2181 td->avg_buckets[WRITE][i].latency,
2182 td->avg_buckets[WRITE][i].valid);
b9147dd1
SL
2183}
2184#else
2185static inline void throtl_update_latency_buckets(struct throtl_data *td)
2186{
2187}
2188#endif
2189
4f1e9630
CX
2190void blk_throtl_charge_bio_split(struct bio *bio)
2191{
2192 struct blkcg_gq *blkg = bio->bi_blkg;
2193 struct throtl_grp *parent = blkg_to_tg(blkg);
2194 struct throtl_service_queue *parent_sq;
2195 bool rw = bio_data_dir(bio);
2196
2197 do {
2198 if (!parent->has_rules[rw])
2199 break;
2200
2201 atomic_inc(&parent->io_split_cnt[rw]);
2202 atomic_inc(&parent->last_io_split_cnt[rw]);
2203
2204 parent_sq = parent->service_queue.parent_sq;
2205 parent = sq_to_tg(parent_sq);
2206 } while (parent);
2207}
2208
db18a53e 2209bool blk_throtl_bio(struct bio *bio)
e43473b7 2210{
309dca30 2211 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
db18a53e 2212 struct blkcg_gq *blkg = bio->bi_blkg;
c5cc2070 2213 struct throtl_qnode *qn = NULL;
a2e83ef9 2214 struct throtl_grp *tg = blkg_to_tg(blkg);
73f0d49a 2215 struct throtl_service_queue *sq;
0e9f4164 2216 bool rw = bio_data_dir(bio);
bc16a4f9 2217 bool throttled = false;
b9147dd1 2218 struct throtl_data *td = tg->td;
e43473b7 2219
93b80638 2220 rcu_read_lock();
ae118896 2221
2a0f61e6 2222 /* see throtl_charge_bio() */
7ca46438
TH
2223 if (bio_flagged(bio, BIO_THROTTLED))
2224 goto out;
2225
2226 if (!cgroup_subsys_on_dfl(io_cgrp_subsys)) {
2227 blkg_rwstat_add(&tg->stat_bytes, bio->bi_opf,
2228 bio->bi_iter.bi_size);
2229 blkg_rwstat_add(&tg->stat_ios, bio->bi_opf, 1);
2230 }
2231
2232 if (!tg->has_rules[rw])
bc16a4f9 2233 goto out;
e43473b7 2234
0d945c1f 2235 spin_lock_irq(&q->queue_lock);
c9589f03 2236
b9147dd1
SL
2237 throtl_update_latency_buckets(td);
2238
9e234eea
SL
2239 blk_throtl_update_idletime(tg);
2240
73f0d49a
TH
2241 sq = &tg->service_queue;
2242
c79892c5 2243again:
9e660acf 2244 while (true) {
3f0abd80
SL
2245 if (tg->last_low_overflow_time[rw] == 0)
2246 tg->last_low_overflow_time[rw] = jiffies;
2247 throtl_downgrade_check(tg);
fa6fb5aa 2248 throtl_upgrade_check(tg);
9e660acf
TH
2249 /* throtl is FIFO - if bios are already queued, should queue */
2250 if (sq->nr_queued[rw])
2251 break;
de701c74 2252
9e660acf 2253 /* if above limits, break to queue */
c79892c5 2254 if (!tg_may_dispatch(tg, bio, NULL)) {
3f0abd80 2255 tg->last_low_overflow_time[rw] = jiffies;
b9147dd1
SL
2256 if (throtl_can_upgrade(td, tg)) {
2257 throtl_upgrade_state(td);
c79892c5
SL
2258 goto again;
2259 }
9e660acf 2260 break;
c79892c5 2261 }
9e660acf
TH
2262
2263 /* within limits, let's charge and dispatch directly */
e43473b7 2264 throtl_charge_bio(tg, bio);
04521db0
VG
2265
2266 /*
2267 * We need to trim slice even when bios are not being queued
2268 * otherwise it might happen that a bio is not queued for
2269 * a long time and slice keeps on extending and trim is not
2270 * called for a long time. Now if limits are reduced suddenly
2271 * we take into account all the IO dispatched so far at new
2272 * low rate and * newly queued IO gets a really long dispatch
2273 * time.
2274 *
2275 * So keep on trimming slice even if bio is not queued.
2276 */
0f3457f6 2277 throtl_trim_slice(tg, rw);
9e660acf
TH
2278
2279 /*
2280 * @bio passed through this layer without being throttled.
b53b072c 2281 * Climb up the ladder. If we're already at the top, it
9e660acf
TH
2282 * can be executed directly.
2283 */
c5cc2070 2284 qn = &tg->qnode_on_parent[rw];
9e660acf
TH
2285 sq = sq->parent_sq;
2286 tg = sq_to_tg(sq);
2287 if (!tg)
2288 goto out_unlock;
e43473b7
VG
2289 }
2290
9e660acf 2291 /* out-of-limit, queue to @tg */
fda6f272
TH
2292 throtl_log(sq, "[%c] bio. bdisp=%llu sz=%u bps=%llu iodisp=%u iops=%u queued=%d/%d",
2293 rw == READ ? 'R' : 'W',
9f626e37
SL
2294 tg->bytes_disp[rw], bio->bi_iter.bi_size,
2295 tg_bps_limit(tg, rw),
2296 tg->io_disp[rw], tg_iops_limit(tg, rw),
fda6f272 2297 sq->nr_queued[READ], sq->nr_queued[WRITE]);
e43473b7 2298
3f0abd80
SL
2299 tg->last_low_overflow_time[rw] = jiffies;
2300
b9147dd1 2301 td->nr_queued[rw]++;
c5cc2070 2302 throtl_add_bio_tg(bio, qn, tg);
bc16a4f9 2303 throttled = true;
e43473b7 2304
7f52f98c
TH
2305 /*
2306 * Update @tg's dispatch time and force schedule dispatch if @tg
2307 * was empty before @bio. The forced scheduling isn't likely to
2308 * cause undue delay as @bio is likely to be dispatched directly if
2309 * its @tg's disptime is not in the future.
2310 */
0e9f4164 2311 if (tg->flags & THROTL_TG_WAS_EMPTY) {
77216b04 2312 tg_update_disptime(tg);
7f52f98c 2313 throtl_schedule_next_dispatch(tg->service_queue.parent_sq, true);
e43473b7
VG
2314 }
2315
bc16a4f9 2316out_unlock:
0d945c1f 2317 spin_unlock_irq(&q->queue_lock);
bc16a4f9 2318out:
111be883 2319 bio_set_flag(bio, BIO_THROTTLED);
b9147dd1
SL
2320
2321#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2322 if (throttled || !td->track_bio_latency)
5238dcf4 2323 bio->bi_issue.value |= BIO_ISSUE_THROTL_SKIP_LATENCY;
b9147dd1 2324#endif
93b80638 2325 rcu_read_unlock();
bc16a4f9 2326 return throttled;
e43473b7
VG
2327}
2328
9e234eea 2329#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
b9147dd1
SL
2330static void throtl_track_latency(struct throtl_data *td, sector_t size,
2331 int op, unsigned long time)
2332{
2333 struct latency_bucket *latency;
2334 int index;
2335
b889bf66
JQ
2336 if (!td || td->limit_index != LIMIT_LOW ||
2337 !(op == REQ_OP_READ || op == REQ_OP_WRITE) ||
b9147dd1
SL
2338 !blk_queue_nonrot(td->queue))
2339 return;
2340
2341 index = request_bucket_index(size);
2342
b889bf66 2343 latency = get_cpu_ptr(td->latency_buckets[op]);
b9147dd1
SL
2344 latency[index].total_latency += time;
2345 latency[index].samples++;
b889bf66 2346 put_cpu_ptr(td->latency_buckets[op]);
b9147dd1
SL
2347}
2348
2349void blk_throtl_stat_add(struct request *rq, u64 time_ns)
2350{
2351 struct request_queue *q = rq->q;
2352 struct throtl_data *td = q->td;
2353
3d244306
HT
2354 throtl_track_latency(td, blk_rq_stats_sectors(rq), req_op(rq),
2355 time_ns >> 10);
b9147dd1
SL
2356}
2357
9e234eea
SL
2358void blk_throtl_bio_endio(struct bio *bio)
2359{
08e18eab 2360 struct blkcg_gq *blkg;
9e234eea 2361 struct throtl_grp *tg;
b9147dd1
SL
2362 u64 finish_time_ns;
2363 unsigned long finish_time;
2364 unsigned long start_time;
2365 unsigned long lat;
b889bf66 2366 int rw = bio_data_dir(bio);
9e234eea 2367
08e18eab
JB
2368 blkg = bio->bi_blkg;
2369 if (!blkg)
9e234eea 2370 return;
08e18eab 2371 tg = blkg_to_tg(blkg);
b185efa7
BW
2372 if (!tg->td->limit_valid[LIMIT_LOW])
2373 return;
9e234eea 2374
b9147dd1
SL
2375 finish_time_ns = ktime_get_ns();
2376 tg->last_finish_time = finish_time_ns >> 10;
2377
5238dcf4
OS
2378 start_time = bio_issue_time(&bio->bi_issue) >> 10;
2379 finish_time = __bio_issue_time(finish_time_ns) >> 10;
08e18eab 2380 if (!start_time || finish_time <= start_time)
53696b8d
SL
2381 return;
2382
2383 lat = finish_time - start_time;
b9147dd1 2384 /* this is only for bio based driver */
5238dcf4
OS
2385 if (!(bio->bi_issue.value & BIO_ISSUE_THROTL_SKIP_LATENCY))
2386 throtl_track_latency(tg->td, bio_issue_size(&bio->bi_issue),
2387 bio_op(bio), lat);
53696b8d 2388
6679a90c 2389 if (tg->latency_target && lat >= tg->td->filtered_latency) {
53696b8d
SL
2390 int bucket;
2391 unsigned int threshold;
2392
5238dcf4 2393 bucket = request_bucket_index(bio_issue_size(&bio->bi_issue));
b889bf66 2394 threshold = tg->td->avg_buckets[rw][bucket].latency +
53696b8d
SL
2395 tg->latency_target;
2396 if (lat > threshold)
2397 tg->bad_bio_cnt++;
2398 /*
2399 * Not race free, could get wrong count, which means cgroups
2400 * will be throttled
2401 */
2402 tg->bio_cnt++;
2403 }
2404
2405 if (time_after(jiffies, tg->bio_cnt_reset_time) || tg->bio_cnt > 1024) {
2406 tg->bio_cnt_reset_time = tg->td->throtl_slice + jiffies;
2407 tg->bio_cnt /= 2;
2408 tg->bad_bio_cnt /= 2;
b9147dd1 2409 }
9e234eea
SL
2410}
2411#endif
2412
e43473b7
VG
2413int blk_throtl_init(struct request_queue *q)
2414{
2415 struct throtl_data *td;
a2b1693b 2416 int ret;
e43473b7
VG
2417
2418 td = kzalloc_node(sizeof(*td), GFP_KERNEL, q->node);
2419 if (!td)
2420 return -ENOMEM;
b889bf66 2421 td->latency_buckets[READ] = __alloc_percpu(sizeof(struct latency_bucket) *
b9147dd1 2422 LATENCY_BUCKET_SIZE, __alignof__(u64));
b889bf66
JQ
2423 if (!td->latency_buckets[READ]) {
2424 kfree(td);
2425 return -ENOMEM;
2426 }
2427 td->latency_buckets[WRITE] = __alloc_percpu(sizeof(struct latency_bucket) *
b9147dd1 2428 LATENCY_BUCKET_SIZE, __alignof__(u64));
b889bf66
JQ
2429 if (!td->latency_buckets[WRITE]) {
2430 free_percpu(td->latency_buckets[READ]);
b9147dd1
SL
2431 kfree(td);
2432 return -ENOMEM;
2433 }
e43473b7 2434
69df0ab0 2435 INIT_WORK(&td->dispatch_work, blk_throtl_dispatch_work_fn);
b2ce2643 2436 throtl_service_queue_init(&td->service_queue);
e43473b7 2437
cd1604fa 2438 q->td = td;
29b12589 2439 td->queue = q;
02977e4a 2440
9f626e37 2441 td->limit_valid[LIMIT_MAX] = true;
cd5ab1b0 2442 td->limit_index = LIMIT_MAX;
3f0abd80
SL
2443 td->low_upgrade_time = jiffies;
2444 td->low_downgrade_time = jiffies;
9e234eea 2445
a2b1693b 2446 /* activate policy */
3c798398 2447 ret = blkcg_activate_policy(q, &blkcg_policy_throtl);
b9147dd1 2448 if (ret) {
b889bf66
JQ
2449 free_percpu(td->latency_buckets[READ]);
2450 free_percpu(td->latency_buckets[WRITE]);
f51b802c 2451 kfree(td);
b9147dd1 2452 }
a2b1693b 2453 return ret;
e43473b7
VG
2454}
2455
2456void blk_throtl_exit(struct request_queue *q)
2457{
c875f4d0 2458 BUG_ON(!q->td);
884f0e84 2459 del_timer_sync(&q->td->service_queue.pending_timer);
da527770 2460 throtl_shutdown_wq(q);
3c798398 2461 blkcg_deactivate_policy(q, &blkcg_policy_throtl);
b889bf66
JQ
2462 free_percpu(q->td->latency_buckets[READ]);
2463 free_percpu(q->td->latency_buckets[WRITE]);
c9a929dd 2464 kfree(q->td);
e43473b7
VG
2465}
2466
d61fcfa4
SL
2467void blk_throtl_register_queue(struct request_queue *q)
2468{
2469 struct throtl_data *td;
6679a90c 2470 int i;
d61fcfa4
SL
2471
2472 td = q->td;
2473 BUG_ON(!td);
2474
6679a90c 2475 if (blk_queue_nonrot(q)) {
d61fcfa4 2476 td->throtl_slice = DFL_THROTL_SLICE_SSD;
6679a90c
SL
2477 td->filtered_latency = LATENCY_FILTERED_SSD;
2478 } else {
d61fcfa4 2479 td->throtl_slice = DFL_THROTL_SLICE_HD;
6679a90c 2480 td->filtered_latency = LATENCY_FILTERED_HD;
b889bf66
JQ
2481 for (i = 0; i < LATENCY_BUCKET_SIZE; i++) {
2482 td->avg_buckets[READ][i].latency = DFL_HD_BASELINE_LATENCY;
2483 td->avg_buckets[WRITE][i].latency = DFL_HD_BASELINE_LATENCY;
2484 }
6679a90c 2485 }
d61fcfa4
SL
2486#ifndef CONFIG_BLK_DEV_THROTTLING_LOW
2487 /* if no low limit, use previous default */
2488 td->throtl_slice = DFL_THROTL_SLICE_HD;
2489#endif
9e234eea 2490
344e9ffc 2491 td->track_bio_latency = !queue_is_mq(q);
b9147dd1
SL
2492 if (!td->track_bio_latency)
2493 blk_stat_enable_accounting(q);
d61fcfa4
SL
2494}
2495
297e3d85
SL
2496#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2497ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page)
2498{
2499 if (!q->td)
2500 return -EINVAL;
2501 return sprintf(page, "%u\n", jiffies_to_msecs(q->td->throtl_slice));
2502}
2503
2504ssize_t blk_throtl_sample_time_store(struct request_queue *q,
2505 const char *page, size_t count)
2506{
2507 unsigned long v;
2508 unsigned long t;
2509
2510 if (!q->td)
2511 return -EINVAL;
2512 if (kstrtoul(page, 10, &v))
2513 return -EINVAL;
2514 t = msecs_to_jiffies(v);
2515 if (t == 0 || t > MAX_THROTL_SLICE)
2516 return -EINVAL;
2517 q->td->throtl_slice = t;
2518 return count;
2519}
2520#endif
2521
e43473b7
VG
2522static int __init throtl_init(void)
2523{
450adcbe
VG
2524 kthrotld_workqueue = alloc_workqueue("kthrotld", WQ_MEM_RECLAIM, 0);
2525 if (!kthrotld_workqueue)
2526 panic("Failed to create kthrotld\n");
2527
3c798398 2528 return blkcg_policy_register(&blkcg_policy_throtl);
e43473b7
VG
2529}
2530
2531module_init(throtl_init);