blk-rq-qos: move rq_qos_add and rq_qos_del out of line
[linux-block.git] / block / blk-wbt.c
CommitLineData
3dcf60bc 1// SPDX-License-Identifier: GPL-2.0
e34cbd30
JA
2/*
3 * buffered writeback throttling. loosely based on CoDel. We can't drop
4 * packets for IO scheduling, so the logic is something like this:
5 *
6 * - Monitor latencies in a defined window of time.
7 * - If the minimum latency in the above window exceeds some target, increment
8 * scaling step and scale down queue depth by a factor of 2x. The monitoring
9 * window is then shrunk to 100 / sqrt(scaling step + 1).
10 * - For any window where we don't have solid data on what the latencies
11 * look like, retain status quo.
12 * - If latencies look good, decrement scaling step.
13 * - If we're only doing writes, allow the scaling step to go negative. This
14 * will temporarily boost write performance, snapping back to a stable
15 * scaling step of 0 if reads show up or the heavy writers finish. Unlike
16 * positive scaling steps where we shrink the monitoring window, a negative
17 * scaling step retains the default step==0 window size.
18 *
19 * Copyright (C) 2016 Jens Axboe
20 *
21 */
22#include <linux/kernel.h>
23#include <linux/blk_types.h>
24#include <linux/slab.h>
25#include <linux/backing-dev.h>
26#include <linux/swap.h>
27
0bc65bd4 28#include "blk-stat.h"
e34cbd30 29#include "blk-wbt.h"
a7905043 30#include "blk-rq-qos.h"
671fae5e 31#include "elevator.h"
e34cbd30
JA
32
33#define CREATE_TRACE_POINTS
34#include <trace/events/wbt.h>
35
0bc65bd4
CH
36enum wbt_flags {
37 WBT_TRACKED = 1, /* write, tracked for throttling */
38 WBT_READ = 2, /* read */
39 WBT_KSWAPD = 4, /* write, from kswapd */
40 WBT_DISCARD = 8, /* discard */
41
42 WBT_NR_BITS = 4, /* number of bits */
43};
44
45enum {
46 WBT_RWQ_BG = 0,
47 WBT_RWQ_KSWAPD,
48 WBT_RWQ_DISCARD,
49 WBT_NUM_RWQ,
50};
51
52/*
53 * If current state is WBT_STATE_ON/OFF_DEFAULT, it can be covered to any other
54 * state, if current state is WBT_STATE_ON/OFF_MANUAL, it can only be covered
55 * to WBT_STATE_OFF/ON_MANUAL.
56 */
57enum {
58 WBT_STATE_ON_DEFAULT = 1, /* on by default */
59 WBT_STATE_ON_MANUAL = 2, /* on manually by sysfs */
60 WBT_STATE_OFF_DEFAULT = 3, /* off by default */
61 WBT_STATE_OFF_MANUAL = 4, /* off manually by sysfs */
62};
63
64struct rq_wb {
65 /*
66 * Settings that govern how we throttle
67 */
68 unsigned int wb_background; /* background writeback */
69 unsigned int wb_normal; /* normal writeback */
70
71 short enable_state; /* WBT_STATE_* */
72
73 /*
74 * Number of consecutive periods where we don't have enough
75 * information to make a firm scale up/down decision.
76 */
77 unsigned int unknown_cnt;
78
79 u64 win_nsec; /* default window size */
80 u64 cur_win_nsec; /* current window size */
81
82 struct blk_stat_callback *cb;
83
84 u64 sync_issue;
85 void *sync_cookie;
86
87 unsigned int wc;
88
89 unsigned long last_issue; /* last non-throttled issue */
90 unsigned long last_comp; /* last non-throttled comp */
91 unsigned long min_lat_nsec;
92 struct rq_qos rqos;
93 struct rq_wait rq_wait[WBT_NUM_RWQ];
94 struct rq_depth rq_depth;
95};
96
97static inline struct rq_wb *RQWB(struct rq_qos *rqos)
98{
99 return container_of(rqos, struct rq_wb, rqos);
100}
101
a8a45941 102static inline void wbt_clear_state(struct request *rq)
934031a1 103{
544ccc8d 104 rq->wbt_flags = 0;
934031a1
OS
105}
106
a8a45941 107static inline enum wbt_flags wbt_flags(struct request *rq)
934031a1 108{
544ccc8d 109 return rq->wbt_flags;
934031a1
OS
110}
111
a8a45941 112static inline bool wbt_is_tracked(struct request *rq)
934031a1 113{
544ccc8d 114 return rq->wbt_flags & WBT_TRACKED;
934031a1
OS
115}
116
a8a45941 117static inline bool wbt_is_read(struct request *rq)
934031a1 118{
544ccc8d 119 return rq->wbt_flags & WBT_READ;
934031a1
OS
120}
121
e34cbd30
JA
122enum {
123 /*
124 * Default setting, we'll scale up (to 75% of QD max) or down (min 1)
125 * from here depending on device stats
126 */
127 RWB_DEF_DEPTH = 16,
128
129 /*
130 * 100msec window
131 */
132 RWB_WINDOW_NSEC = 100 * 1000 * 1000ULL,
133
134 /*
135 * Disregard stats, if we don't meet this minimum
136 */
137 RWB_MIN_WRITE_SAMPLES = 3,
138
139 /*
140 * If we have this number of consecutive windows with not enough
141 * information to scale up or down, scale up.
142 */
143 RWB_UNKNOWN_BUMP = 5,
144};
145
146static inline bool rwb_enabled(struct rq_wb *rwb)
147{
1d0903d6
ZY
148 return rwb && rwb->enable_state != WBT_STATE_OFF_DEFAULT &&
149 rwb->wb_normal != 0;
e34cbd30
JA
150}
151
e34cbd30
JA
152static void wb_timestamp(struct rq_wb *rwb, unsigned long *var)
153{
154 if (rwb_enabled(rwb)) {
155 const unsigned long cur = jiffies;
156
157 if (cur != *var)
158 *var = cur;
159 }
160}
161
162/*
163 * If a task was rate throttled in balance_dirty_pages() within the last
164 * second or so, use that to indicate a higher cleaning rate.
165 */
166static bool wb_recent_wait(struct rq_wb *rwb)
167{
d152c682 168 struct bdi_writeback *wb = &rwb->rqos.q->disk->bdi->wb;
e34cbd30
JA
169
170 return time_before(jiffies, wb->dirty_sleep + HZ);
171}
172
8bea6090
JA
173static inline struct rq_wait *get_rq_wait(struct rq_wb *rwb,
174 enum wbt_flags wb_acct)
e34cbd30 175{
8bea6090
JA
176 if (wb_acct & WBT_KSWAPD)
177 return &rwb->rq_wait[WBT_RWQ_KSWAPD];
782f5697
JA
178 else if (wb_acct & WBT_DISCARD)
179 return &rwb->rq_wait[WBT_RWQ_DISCARD];
8bea6090
JA
180
181 return &rwb->rq_wait[WBT_RWQ_BG];
e34cbd30
JA
182}
183
184static void rwb_wake_all(struct rq_wb *rwb)
185{
186 int i;
187
188 for (i = 0; i < WBT_NUM_RWQ; i++) {
189 struct rq_wait *rqw = &rwb->rq_wait[i];
190
b7882093 191 if (wq_has_sleeper(&rqw->wait))
e34cbd30
JA
192 wake_up_all(&rqw->wait);
193 }
194}
195
061a5427
JA
196static void wbt_rqw_done(struct rq_wb *rwb, struct rq_wait *rqw,
197 enum wbt_flags wb_acct)
e34cbd30 198{
e34cbd30
JA
199 int inflight, limit;
200
e34cbd30
JA
201 inflight = atomic_dec_return(&rqw->inflight);
202
203 /*
204 * wbt got disabled with IO in flight. Wake up any potential
205 * waiters, we don't have to do more than that.
206 */
207 if (unlikely(!rwb_enabled(rwb))) {
208 rwb_wake_all(rwb);
209 return;
210 }
211
212 /*
782f5697
JA
213 * For discards, our limit is always the background. For writes, if
214 * the device does write back caching, drop further down before we
215 * wake people up.
e34cbd30 216 */
782f5697
JA
217 if (wb_acct & WBT_DISCARD)
218 limit = rwb->wb_background;
219 else if (rwb->wc && !wb_recent_wait(rwb))
e34cbd30
JA
220 limit = 0;
221 else
222 limit = rwb->wb_normal;
223
224 /*
225 * Don't wake anyone up if we are above the normal limit.
226 */
227 if (inflight && inflight >= limit)
228 return;
229
b7882093 230 if (wq_has_sleeper(&rqw->wait)) {
e34cbd30
JA
231 int diff = limit - inflight;
232
233 if (!inflight || diff >= rwb->wb_background / 2)
38cfb5a4 234 wake_up_all(&rqw->wait);
e34cbd30
JA
235 }
236}
237
061a5427
JA
238static void __wbt_done(struct rq_qos *rqos, enum wbt_flags wb_acct)
239{
240 struct rq_wb *rwb = RQWB(rqos);
241 struct rq_wait *rqw;
242
243 if (!(wb_acct & WBT_TRACKED))
244 return;
245
246 rqw = get_rq_wait(rwb, wb_acct);
247 wbt_rqw_done(rwb, rqw, wb_acct);
248}
249
e34cbd30
JA
250/*
251 * Called on completion of a request. Note that it's also called when
252 * a request is merged, when the request gets freed.
253 */
a7905043 254static void wbt_done(struct rq_qos *rqos, struct request *rq)
e34cbd30 255{
a7905043 256 struct rq_wb *rwb = RQWB(rqos);
e34cbd30 257
a8a45941
OS
258 if (!wbt_is_tracked(rq)) {
259 if (rwb->sync_cookie == rq) {
e34cbd30
JA
260 rwb->sync_issue = 0;
261 rwb->sync_cookie = NULL;
262 }
263
a8a45941 264 if (wbt_is_read(rq))
e34cbd30 265 wb_timestamp(rwb, &rwb->last_comp);
e34cbd30 266 } else {
a8a45941 267 WARN_ON_ONCE(rq == rwb->sync_cookie);
a7905043 268 __wbt_done(rqos, wbt_flags(rq));
e34cbd30 269 }
a8a45941 270 wbt_clear_state(rq);
e34cbd30
JA
271}
272
4121d385 273static inline bool stat_sample_valid(struct blk_rq_stat *stat)
e34cbd30
JA
274{
275 /*
276 * We need at least one read sample, and a minimum of
277 * RWB_MIN_WRITE_SAMPLES. We require some write samples to know
278 * that it's writes impacting us, and not just some sole read on
279 * a device that is in a lower power state.
280 */
fa2e39cb
OS
281 return (stat[READ].nr_samples >= 1 &&
282 stat[WRITE].nr_samples >= RWB_MIN_WRITE_SAMPLES);
e34cbd30
JA
283}
284
285static u64 rwb_sync_issue_lat(struct rq_wb *rwb)
286{
6aa7de05 287 u64 now, issue = READ_ONCE(rwb->sync_issue);
e34cbd30
JA
288
289 if (!issue || !rwb->sync_cookie)
290 return 0;
291
292 now = ktime_to_ns(ktime_get());
293 return now - issue;
294}
295
0bc65bd4
CH
296static inline unsigned int wbt_inflight(struct rq_wb *rwb)
297{
298 unsigned int i, ret = 0;
299
300 for (i = 0; i < WBT_NUM_RWQ; i++)
301 ret += atomic_read(&rwb->rq_wait[i].inflight);
302
303 return ret;
304}
305
e34cbd30
JA
306enum {
307 LAT_OK = 1,
308 LAT_UNKNOWN,
309 LAT_UNKNOWN_WRITES,
310 LAT_EXCEEDED,
311};
312
34dbad5d 313static int latency_exceeded(struct rq_wb *rwb, struct blk_rq_stat *stat)
e34cbd30 314{
d152c682 315 struct backing_dev_info *bdi = rwb->rqos.q->disk->bdi;
a7905043 316 struct rq_depth *rqd = &rwb->rq_depth;
e34cbd30
JA
317 u64 thislat;
318
319 /*
320 * If our stored sync issue exceeds the window size, or it
321 * exceeds our min target AND we haven't logged any entries,
322 * flag the latency as exceeded. wbt works off completion latencies,
323 * but for a flooded device, a single sync IO can take a long time
324 * to complete after being issued. If this time exceeds our
325 * monitoring window AND we didn't see any other completions in that
326 * window, then count that sync IO as a violation of the latency.
327 */
328 thislat = rwb_sync_issue_lat(rwb);
329 if (thislat > rwb->cur_win_nsec ||
fa2e39cb 330 (thislat > rwb->min_lat_nsec && !stat[READ].nr_samples)) {
d8a0cbfd 331 trace_wbt_lat(bdi, thislat);
e34cbd30
JA
332 return LAT_EXCEEDED;
333 }
334
335 /*
336 * No read/write mix, if stat isn't valid
337 */
338 if (!stat_sample_valid(stat)) {
339 /*
340 * If we had writes in this stat window and the window is
341 * current, we're only doing writes. If a task recently
342 * waited or still has writes in flights, consider us doing
343 * just writes as well.
344 */
34dbad5d
OS
345 if (stat[WRITE].nr_samples || wb_recent_wait(rwb) ||
346 wbt_inflight(rwb))
e34cbd30
JA
347 return LAT_UNKNOWN_WRITES;
348 return LAT_UNKNOWN;
349 }
350
351 /*
352 * If the 'min' latency exceeds our target, step down.
353 */
fa2e39cb
OS
354 if (stat[READ].min > rwb->min_lat_nsec) {
355 trace_wbt_lat(bdi, stat[READ].min);
d8a0cbfd 356 trace_wbt_stat(bdi, stat);
e34cbd30
JA
357 return LAT_EXCEEDED;
358 }
359
a7905043 360 if (rqd->scale_step)
d8a0cbfd 361 trace_wbt_stat(bdi, stat);
e34cbd30
JA
362
363 return LAT_OK;
364}
365
e34cbd30
JA
366static void rwb_trace_step(struct rq_wb *rwb, const char *msg)
367{
d152c682 368 struct backing_dev_info *bdi = rwb->rqos.q->disk->bdi;
a7905043 369 struct rq_depth *rqd = &rwb->rq_depth;
d8a0cbfd 370
a7905043
JB
371 trace_wbt_step(bdi, msg, rqd->scale_step, rwb->cur_win_nsec,
372 rwb->wb_background, rwb->wb_normal, rqd->max_depth);
e34cbd30
JA
373}
374
a7905043 375static void calc_wb_limits(struct rq_wb *rwb)
e34cbd30 376{
a7905043
JB
377 if (rwb->min_lat_nsec == 0) {
378 rwb->wb_normal = rwb->wb_background = 0;
379 } else if (rwb->rq_depth.max_depth <= 2) {
380 rwb->wb_normal = rwb->rq_depth.max_depth;
381 rwb->wb_background = 1;
382 } else {
383 rwb->wb_normal = (rwb->rq_depth.max_depth + 1) / 2;
384 rwb->wb_background = (rwb->rq_depth.max_depth + 3) / 4;
385 }
386}
e34cbd30 387
a7905043
JB
388static void scale_up(struct rq_wb *rwb)
389{
b84477d3
HS
390 if (!rq_depth_scale_up(&rwb->rq_depth))
391 return;
a7905043 392 calc_wb_limits(rwb);
e34cbd30 393 rwb->unknown_cnt = 0;
5e65a203 394 rwb_wake_all(rwb);
3a89c25d 395 rwb_trace_step(rwb, tracepoint_string("scale up"));
e34cbd30
JA
396}
397
e34cbd30
JA
398static void scale_down(struct rq_wb *rwb, bool hard_throttle)
399{
b84477d3
HS
400 if (!rq_depth_scale_down(&rwb->rq_depth, hard_throttle))
401 return;
e34cbd30 402 calc_wb_limits(rwb);
a7905043 403 rwb->unknown_cnt = 0;
3a89c25d 404 rwb_trace_step(rwb, tracepoint_string("scale down"));
e34cbd30
JA
405}
406
407static void rwb_arm_timer(struct rq_wb *rwb)
408{
a7905043
JB
409 struct rq_depth *rqd = &rwb->rq_depth;
410
411 if (rqd->scale_step > 0) {
e34cbd30
JA
412 /*
413 * We should speed this up, using some variant of a fast
414 * integer inverse square root calculation. Since we only do
415 * this for every window expiration, it's not a huge deal,
416 * though.
417 */
418 rwb->cur_win_nsec = div_u64(rwb->win_nsec << 4,
a7905043 419 int_sqrt((rqd->scale_step + 1) << 8));
e34cbd30
JA
420 } else {
421 /*
422 * For step < 0, we don't want to increase/decrease the
423 * window size.
424 */
425 rwb->cur_win_nsec = rwb->win_nsec;
426 }
427
34dbad5d 428 blk_stat_activate_nsecs(rwb->cb, rwb->cur_win_nsec);
e34cbd30
JA
429}
430
34dbad5d 431static void wb_timer_fn(struct blk_stat_callback *cb)
e34cbd30 432{
34dbad5d 433 struct rq_wb *rwb = cb->data;
a7905043 434 struct rq_depth *rqd = &rwb->rq_depth;
e34cbd30
JA
435 unsigned int inflight = wbt_inflight(rwb);
436 int status;
437
480d42dc
AR
438 if (!rwb->rqos.q->disk)
439 return;
440
34dbad5d 441 status = latency_exceeded(rwb, cb->stat);
e34cbd30 442
d152c682
CH
443 trace_wbt_timer(rwb->rqos.q->disk->bdi, status, rqd->scale_step,
444 inflight);
e34cbd30
JA
445
446 /*
447 * If we exceeded the latency target, step down. If we did not,
448 * step one level up. If we don't know enough to say either exceeded
449 * or ok, then don't do anything.
450 */
451 switch (status) {
452 case LAT_EXCEEDED:
453 scale_down(rwb, true);
454 break;
455 case LAT_OK:
456 scale_up(rwb);
457 break;
458 case LAT_UNKNOWN_WRITES:
459 /*
460 * We started a the center step, but don't have a valid
461 * read/write sample, but we do have writes going on.
462 * Allow step to go negative, to increase write perf.
463 */
464 scale_up(rwb);
465 break;
466 case LAT_UNKNOWN:
467 if (++rwb->unknown_cnt < RWB_UNKNOWN_BUMP)
468 break;
469 /*
470 * We get here when previously scaled reduced depth, and we
471 * currently don't have a valid read/write sample. For that
472 * case, slowly return to center state (step == 0).
473 */
a7905043 474 if (rqd->scale_step > 0)
e34cbd30 475 scale_up(rwb);
a7905043 476 else if (rqd->scale_step < 0)
e34cbd30
JA
477 scale_down(rwb, false);
478 break;
479 default:
480 break;
481 }
482
483 /*
484 * Re-arm timer, if we have IO in flight
485 */
a7905043 486 if (rqd->scale_step || inflight)
e34cbd30
JA
487 rwb_arm_timer(rwb);
488}
489
4d89e1d1 490static void wbt_update_limits(struct rq_wb *rwb)
e34cbd30 491{
a7905043
JB
492 struct rq_depth *rqd = &rwb->rq_depth;
493
494 rqd->scale_step = 0;
495 rqd->scaled_max = false;
496
497 rq_depth_calc_max_depth(rqd);
e34cbd30
JA
498 calc_wb_limits(rwb);
499
500 rwb_wake_all(rwb);
501}
502
3642ef4d
YK
503bool wbt_disabled(struct request_queue *q)
504{
505 struct rq_qos *rqos = wbt_rq_qos(q);
506
507 return !rqos || RQWB(rqos)->enable_state == WBT_STATE_OFF_DEFAULT ||
508 RQWB(rqos)->enable_state == WBT_STATE_OFF_MANUAL;
509}
510
a7905043
JB
511u64 wbt_get_min_lat(struct request_queue *q)
512{
513 struct rq_qos *rqos = wbt_rq_qos(q);
514 if (!rqos)
515 return 0;
516 return RQWB(rqos)->min_lat_nsec;
517}
518
519void wbt_set_min_lat(struct request_queue *q, u64 val)
520{
521 struct rq_qos *rqos = wbt_rq_qos(q);
522 if (!rqos)
523 return;
a9a236d2 524
a7905043 525 RQWB(rqos)->min_lat_nsec = val;
a9a236d2
YK
526 if (val)
527 RQWB(rqos)->enable_state = WBT_STATE_ON_MANUAL;
528 else
529 RQWB(rqos)->enable_state = WBT_STATE_OFF_MANUAL;
530
4d89e1d1 531 wbt_update_limits(RQWB(rqos));
a7905043
JB
532}
533
534
e34cbd30
JA
535static bool close_io(struct rq_wb *rwb)
536{
537 const unsigned long now = jiffies;
538
539 return time_before(now, rwb->last_issue + HZ / 10) ||
540 time_before(now, rwb->last_comp + HZ / 10);
541}
542
543#define REQ_HIPRIO (REQ_SYNC | REQ_META | REQ_PRIO)
544
16458cf3 545static inline unsigned int get_limit(struct rq_wb *rwb, blk_opf_t opf)
e34cbd30
JA
546{
547 unsigned int limit;
548
ffa358dc
JA
549 /*
550 * If we got disabled, just return UINT_MAX. This ensures that
551 * we'll properly inc a new IO, and dec+wakeup at the end.
552 */
553 if (!rwb_enabled(rwb))
554 return UINT_MAX;
555
16458cf3 556 if ((opf & REQ_OP_MASK) == REQ_OP_DISCARD)
782f5697
JA
557 return rwb->wb_background;
558
e34cbd30
JA
559 /*
560 * At this point we know it's a buffered write. If this is
3dfbdc44 561 * kswapd trying to free memory, or REQ_SYNC is set, then
e34cbd30
JA
562 * it's WB_SYNC_ALL writeback, and we'll use the max limit for
563 * that. If the write is marked as a background write, then use
564 * the idle limit, or go to normal if we haven't had competing
565 * IO for a bit.
566 */
16458cf3 567 if ((opf & REQ_HIPRIO) || wb_recent_wait(rwb) || current_is_kswapd())
a7905043 568 limit = rwb->rq_depth.max_depth;
16458cf3 569 else if ((opf & REQ_BACKGROUND) || close_io(rwb)) {
e34cbd30
JA
570 /*
571 * If less than 100ms since we completed unrelated IO,
572 * limit us to half the depth for background writeback.
573 */
574 limit = rwb->wb_background;
575 } else
576 limit = rwb->wb_normal;
577
578 return limit;
579}
580
38cfb5a4 581struct wbt_wait_data {
38cfb5a4 582 struct rq_wb *rwb;
b6c7b58f 583 enum wbt_flags wb_acct;
16458cf3 584 blk_opf_t opf;
38cfb5a4
JA
585};
586
b6c7b58f 587static bool wbt_inflight_cb(struct rq_wait *rqw, void *private_data)
38cfb5a4 588{
b6c7b58f 589 struct wbt_wait_data *data = private_data;
16458cf3 590 return rq_wait_inc_below(rqw, get_limit(data->rwb, data->opf));
b6c7b58f 591}
38cfb5a4 592
b6c7b58f
JB
593static void wbt_cleanup_cb(struct rq_wait *rqw, void *private_data)
594{
595 struct wbt_wait_data *data = private_data;
596 wbt_rqw_done(data->rwb, rqw, data->wb_acct);
38cfb5a4
JA
597}
598
e34cbd30
JA
599/*
600 * Block if we will exceed our limit, or if we are currently waiting for
601 * the timer to kick off queuing again.
602 */
8bea6090 603static void __wbt_wait(struct rq_wb *rwb, enum wbt_flags wb_acct,
16458cf3 604 blk_opf_t opf)
e34cbd30 605{
8bea6090 606 struct rq_wait *rqw = get_rq_wait(rwb, wb_acct);
38cfb5a4 607 struct wbt_wait_data data = {
38cfb5a4 608 .rwb = rwb,
b6c7b58f 609 .wb_acct = wb_acct,
16458cf3 610 .opf = opf,
38cfb5a4 611 };
e34cbd30 612
b6c7b58f 613 rq_qos_wait(rqw, &data, wbt_inflight_cb, wbt_cleanup_cb);
e34cbd30
JA
614}
615
482e302a 616static inline bool wbt_should_throttle(struct bio *bio)
e34cbd30 617{
782f5697
JA
618 switch (bio_op(bio)) {
619 case REQ_OP_WRITE:
620 /*
621 * Don't throttle WRITE_ODIRECT
622 */
623 if ((bio->bi_opf & (REQ_SYNC | REQ_IDLE)) ==
624 (REQ_SYNC | REQ_IDLE))
625 return false;
df561f66 626 fallthrough;
782f5697
JA
627 case REQ_OP_DISCARD:
628 return true;
629 default:
e34cbd30 630 return false;
782f5697 631 }
e34cbd30
JA
632}
633
c1c80384
JB
634static enum wbt_flags bio_to_wbt_flags(struct rq_wb *rwb, struct bio *bio)
635{
636 enum wbt_flags flags = 0;
637
c125311d
JA
638 if (!rwb_enabled(rwb))
639 return 0;
640
c1c80384
JB
641 if (bio_op(bio) == REQ_OP_READ) {
642 flags = WBT_READ;
482e302a 643 } else if (wbt_should_throttle(bio)) {
c1c80384
JB
644 if (current_is_kswapd())
645 flags |= WBT_KSWAPD;
646 if (bio_op(bio) == REQ_OP_DISCARD)
647 flags |= WBT_DISCARD;
648 flags |= WBT_TRACKED;
649 }
650 return flags;
651}
652
653static void wbt_cleanup(struct rq_qos *rqos, struct bio *bio)
654{
655 struct rq_wb *rwb = RQWB(rqos);
656 enum wbt_flags flags = bio_to_wbt_flags(rwb, bio);
657 __wbt_done(rqos, flags);
658}
659
e34cbd30 660/*
e34cbd30
JA
661 * May sleep, if we have exceeded the writeback limits. Caller can pass
662 * in an irq held spinlock, if it holds one when calling this function.
663 * If we do sleep, we'll release and re-grab it.
664 */
d5337560 665static void wbt_wait(struct rq_qos *rqos, struct bio *bio)
e34cbd30 666{
a7905043 667 struct rq_wb *rwb = RQWB(rqos);
c1c80384 668 enum wbt_flags flags;
e34cbd30 669
c1c80384 670 flags = bio_to_wbt_flags(rwb, bio);
df60f6e8 671 if (!(flags & WBT_TRACKED)) {
c1c80384 672 if (flags & WBT_READ)
e34cbd30 673 wb_timestamp(rwb, &rwb->last_issue);
c1c80384 674 return;
e34cbd30
JA
675 }
676
d5337560 677 __wbt_wait(rwb, flags, bio->bi_opf);
e34cbd30 678
34dbad5d 679 if (!blk_stat_is_active(rwb->cb))
e34cbd30 680 rwb_arm_timer(rwb);
c1c80384 681}
e34cbd30 682
c1c80384
JB
683static void wbt_track(struct rq_qos *rqos, struct request *rq, struct bio *bio)
684{
685 struct rq_wb *rwb = RQWB(rqos);
686 rq->wbt_flags |= bio_to_wbt_flags(rwb, bio);
e34cbd30
JA
687}
688
c83f536a 689static void wbt_issue(struct rq_qos *rqos, struct request *rq)
e34cbd30 690{
a7905043
JB
691 struct rq_wb *rwb = RQWB(rqos);
692
e34cbd30
JA
693 if (!rwb_enabled(rwb))
694 return;
695
696 /*
a8a45941
OS
697 * Track sync issue, in case it takes a long time to complete. Allows us
698 * to react quicker, if a sync IO takes a long time to complete. Note
699 * that this is just a hint. The request can go away when it completes,
700 * so it's important we never dereference it. We only use the address to
701 * compare with, which is why we store the sync_issue time locally.
e34cbd30 702 */
a8a45941
OS
703 if (wbt_is_read(rq) && !rwb->sync_issue) {
704 rwb->sync_cookie = rq;
544ccc8d 705 rwb->sync_issue = rq->io_start_time_ns;
e34cbd30
JA
706 }
707}
708
c83f536a 709static void wbt_requeue(struct rq_qos *rqos, struct request *rq)
e34cbd30 710{
a7905043 711 struct rq_wb *rwb = RQWB(rqos);
e34cbd30
JA
712 if (!rwb_enabled(rwb))
713 return;
a8a45941 714 if (rq == rwb->sync_cookie) {
e34cbd30
JA
715 rwb->sync_issue = 0;
716 rwb->sync_cookie = NULL;
717 }
718}
719
a7905043 720void wbt_set_write_cache(struct request_queue *q, bool write_cache_on)
e34cbd30 721{
a7905043
JB
722 struct rq_qos *rqos = wbt_rq_qos(q);
723 if (rqos)
724 RQWB(rqos)->wc = write_cache_on;
e34cbd30 725}
e34cbd30 726
8330cdb0
JK
727/*
728 * Enable wbt if defaults are configured that way
729 */
04aad37b 730void wbt_enable_default(struct gendisk *disk)
8330cdb0 731{
04aad37b 732 struct request_queue *q = disk->queue;
671fae5e
YK
733 struct rq_qos *rqos;
734 bool disable_flag = q->elevator &&
735 test_bit(ELEVATOR_FLAG_DISABLE_WBT, &q->elevator->flags);
76a80408 736
8330cdb0 737 /* Throttling already enabled? */
671fae5e 738 rqos = wbt_rq_qos(q);
76a80408 739 if (rqos) {
671fae5e
YK
740 if (!disable_flag &&
741 RQWB(rqos)->enable_state == WBT_STATE_OFF_DEFAULT)
76a80408 742 RQWB(rqos)->enable_state = WBT_STATE_ON_DEFAULT;
8330cdb0 743 return;
76a80408 744 }
8330cdb0
JK
745
746 /* Queue not registered? Maybe shutting down... */
58c898ba 747 if (!blk_queue_registered(q))
8330cdb0
JK
748 return;
749
671fae5e 750 if (queue_is_mq(q) && !disable_flag)
958f2965 751 wbt_init(disk);
8330cdb0
JK
752}
753EXPORT_SYMBOL_GPL(wbt_enable_default);
754
80e091d1
JA
755u64 wbt_default_latency_nsec(struct request_queue *q)
756{
757 /*
758 * We default to 2msec for non-rotational storage, and 75msec
759 * for rotational storage.
760 */
761 if (blk_queue_nonrot(q))
762 return 2000000ULL;
763 else
764 return 75000000ULL;
765}
766
99c749a4
JA
767static int wbt_data_dir(const struct request *rq)
768{
77e7ffd7 769 const enum req_op op = req_op(rq);
5235553d
JA
770
771 if (op == REQ_OP_READ)
772 return READ;
825843b0 773 else if (op_is_write(op))
5235553d
JA
774 return WRITE;
775
776 /* don't account */
777 return -1;
99c749a4
JA
778}
779
9677a3e0
TH
780static void wbt_queue_depth_changed(struct rq_qos *rqos)
781{
782 RQWB(rqos)->rq_depth.queue_depth = blk_queue_depth(rqos->q);
4d89e1d1 783 wbt_update_limits(RQWB(rqos));
9677a3e0
TH
784}
785
a7905043
JB
786static void wbt_exit(struct rq_qos *rqos)
787{
788 struct rq_wb *rwb = RQWB(rqos);
789 struct request_queue *q = rqos->q;
790
791 blk_stat_remove_callback(q, rwb->cb);
792 blk_stat_free_callback(rwb->cb);
793 kfree(rwb);
794}
795
796/*
797 * Disable wbt, if enabled by default.
798 */
04aad37b 799void wbt_disable_default(struct gendisk *disk)
a7905043 800{
04aad37b 801 struct rq_qos *rqos = wbt_rq_qos(disk->queue);
a7905043
JB
802 struct rq_wb *rwb;
803 if (!rqos)
804 return;
805 rwb = RQWB(rqos);
544fbd16
ML
806 if (rwb->enable_state == WBT_STATE_ON_DEFAULT) {
807 blk_stat_deactivate(rwb->cb);
1d0903d6 808 rwb->enable_state = WBT_STATE_OFF_DEFAULT;
544fbd16 809 }
a7905043 810}
e815f404 811EXPORT_SYMBOL_GPL(wbt_disable_default);
a7905043 812
d19afebc
ML
813#ifdef CONFIG_BLK_DEBUG_FS
814static int wbt_curr_win_nsec_show(void *data, struct seq_file *m)
815{
816 struct rq_qos *rqos = data;
817 struct rq_wb *rwb = RQWB(rqos);
818
819 seq_printf(m, "%llu\n", rwb->cur_win_nsec);
820 return 0;
821}
822
823static int wbt_enabled_show(void *data, struct seq_file *m)
824{
825 struct rq_qos *rqos = data;
826 struct rq_wb *rwb = RQWB(rqos);
827
828 seq_printf(m, "%d\n", rwb->enable_state);
829 return 0;
830}
831
832static int wbt_id_show(void *data, struct seq_file *m)
833{
834 struct rq_qos *rqos = data;
835
836 seq_printf(m, "%u\n", rqos->id);
837 return 0;
838}
839
840static int wbt_inflight_show(void *data, struct seq_file *m)
841{
842 struct rq_qos *rqos = data;
843 struct rq_wb *rwb = RQWB(rqos);
844 int i;
845
846 for (i = 0; i < WBT_NUM_RWQ; i++)
847 seq_printf(m, "%d: inflight %d\n", i,
848 atomic_read(&rwb->rq_wait[i].inflight));
849 return 0;
850}
851
852static int wbt_min_lat_nsec_show(void *data, struct seq_file *m)
853{
854 struct rq_qos *rqos = data;
855 struct rq_wb *rwb = RQWB(rqos);
856
857 seq_printf(m, "%lu\n", rwb->min_lat_nsec);
858 return 0;
859}
860
861static int wbt_unknown_cnt_show(void *data, struct seq_file *m)
862{
863 struct rq_qos *rqos = data;
864 struct rq_wb *rwb = RQWB(rqos);
865
866 seq_printf(m, "%u\n", rwb->unknown_cnt);
867 return 0;
868}
869
870static int wbt_normal_show(void *data, struct seq_file *m)
871{
872 struct rq_qos *rqos = data;
873 struct rq_wb *rwb = RQWB(rqos);
874
875 seq_printf(m, "%u\n", rwb->wb_normal);
876 return 0;
877}
878
879static int wbt_background_show(void *data, struct seq_file *m)
880{
881 struct rq_qos *rqos = data;
882 struct rq_wb *rwb = RQWB(rqos);
883
884 seq_printf(m, "%u\n", rwb->wb_background);
885 return 0;
886}
887
888static const struct blk_mq_debugfs_attr wbt_debugfs_attrs[] = {
889 {"curr_win_nsec", 0400, wbt_curr_win_nsec_show},
890 {"enabled", 0400, wbt_enabled_show},
891 {"id", 0400, wbt_id_show},
892 {"inflight", 0400, wbt_inflight_show},
893 {"min_lat_nsec", 0400, wbt_min_lat_nsec_show},
894 {"unknown_cnt", 0400, wbt_unknown_cnt_show},
895 {"wb_normal", 0400, wbt_normal_show},
896 {"wb_background", 0400, wbt_background_show},
897 {},
898};
899#endif
900
a7905043
JB
901static struct rq_qos_ops wbt_rqos_ops = {
902 .throttle = wbt_wait,
903 .issue = wbt_issue,
c1c80384 904 .track = wbt_track,
a7905043
JB
905 .requeue = wbt_requeue,
906 .done = wbt_done,
c1c80384 907 .cleanup = wbt_cleanup,
9677a3e0 908 .queue_depth_changed = wbt_queue_depth_changed,
a7905043 909 .exit = wbt_exit,
d19afebc
ML
910#ifdef CONFIG_BLK_DEBUG_FS
911 .debugfs_attrs = wbt_debugfs_attrs,
912#endif
a7905043
JB
913};
914
958f2965 915int wbt_init(struct gendisk *disk)
e34cbd30 916{
958f2965 917 struct request_queue *q = disk->queue;
e34cbd30
JA
918 struct rq_wb *rwb;
919 int i;
14a6e2eb 920 int ret;
e34cbd30 921
e34cbd30
JA
922 rwb = kzalloc(sizeof(*rwb), GFP_KERNEL);
923 if (!rwb)
924 return -ENOMEM;
925
99c749a4 926 rwb->cb = blk_stat_alloc_callback(wb_timer_fn, wbt_data_dir, 2, rwb);
34dbad5d
OS
927 if (!rwb->cb) {
928 kfree(rwb);
929 return -ENOMEM;
930 }
931
a7905043
JB
932 for (i = 0; i < WBT_NUM_RWQ; i++)
933 rq_wait_init(&rwb->rq_wait[i]);
e34cbd30 934
a7905043
JB
935 rwb->rqos.id = RQ_QOS_WBT;
936 rwb->rqos.ops = &wbt_rqos_ops;
937 rwb->rqos.q = q;
e34cbd30 938 rwb->last_comp = rwb->last_issue = jiffies;
e34cbd30 939 rwb->win_nsec = RWB_WINDOW_NSEC;
d62118b6 940 rwb->enable_state = WBT_STATE_ON_DEFAULT;
285febab 941 rwb->wc = test_bit(QUEUE_FLAG_WC, &q->queue_flags);
a7905043 942 rwb->rq_depth.default_depth = RWB_DEF_DEPTH;
8c5035df 943 rwb->min_lat_nsec = wbt_default_latency_nsec(q);
4e1d91ae
CH
944 rwb->rq_depth.queue_depth = blk_queue_depth(q);
945 wbt_update_limits(rwb);
e34cbd30
JA
946
947 /*
34dbad5d 948 * Assign rwb and add the stats callback.
e34cbd30 949 */
14a6e2eb
JH
950 ret = rq_qos_add(q, &rwb->rqos);
951 if (ret)
952 goto err_free;
953
34dbad5d 954 blk_stat_add_callback(q, rwb->cb);
e34cbd30 955
e34cbd30 956 return 0;
14a6e2eb
JH
957
958err_free:
959 blk_stat_free_callback(rwb->cb);
960 kfree(rwb);
961 return ret;
962
e34cbd30 963}