blob: 8af553a0ba00daaf09994be44c7c71aca9a3bfdc [file] [log] [blame]
Christoph Hellwig3dcf60b2019-04-30 14:42:43 -04001// SPDX-License-Identifier: GPL-2.0
Jens Axboee34cbd32016-11-09 12:36:15 -07002/*
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
28#include "blk-wbt.h"
Josef Bacika7905042018-07-03 09:32:35 -060029#include "blk-rq-qos.h"
Jens Axboee34cbd32016-11-09 12:36:15 -070030
31#define CREATE_TRACE_POINTS
32#include <trace/events/wbt.h>
33
Omar Sandovala8a45942018-05-09 02:08:48 -070034static inline void wbt_clear_state(struct request *rq)
Omar Sandoval934031a2018-05-09 02:08:47 -070035{
Omar Sandoval544ccc8d2018-05-09 02:08:50 -070036 rq->wbt_flags = 0;
Omar Sandoval934031a2018-05-09 02:08:47 -070037}
38
Omar Sandovala8a45942018-05-09 02:08:48 -070039static inline enum wbt_flags wbt_flags(struct request *rq)
Omar Sandoval934031a2018-05-09 02:08:47 -070040{
Omar Sandoval544ccc8d2018-05-09 02:08:50 -070041 return rq->wbt_flags;
Omar Sandoval934031a2018-05-09 02:08:47 -070042}
43
Omar Sandovala8a45942018-05-09 02:08:48 -070044static inline bool wbt_is_tracked(struct request *rq)
Omar Sandoval934031a2018-05-09 02:08:47 -070045{
Omar Sandoval544ccc8d2018-05-09 02:08:50 -070046 return rq->wbt_flags & WBT_TRACKED;
Omar Sandoval934031a2018-05-09 02:08:47 -070047}
48
Omar Sandovala8a45942018-05-09 02:08:48 -070049static inline bool wbt_is_read(struct request *rq)
Omar Sandoval934031a2018-05-09 02:08:47 -070050{
Omar Sandoval544ccc8d2018-05-09 02:08:50 -070051 return rq->wbt_flags & WBT_READ;
Omar Sandoval934031a2018-05-09 02:08:47 -070052}
53
Jens Axboee34cbd32016-11-09 12:36:15 -070054enum {
55 /*
56 * Default setting, we'll scale up (to 75% of QD max) or down (min 1)
57 * from here depending on device stats
58 */
59 RWB_DEF_DEPTH = 16,
60
61 /*
62 * 100msec window
63 */
64 RWB_WINDOW_NSEC = 100 * 1000 * 1000ULL,
65
66 /*
67 * Disregard stats, if we don't meet this minimum
68 */
69 RWB_MIN_WRITE_SAMPLES = 3,
70
71 /*
72 * If we have this number of consecutive windows with not enough
73 * information to scale up or down, scale up.
74 */
75 RWB_UNKNOWN_BUMP = 5,
76};
77
78static inline bool rwb_enabled(struct rq_wb *rwb)
79{
80 return rwb && rwb->wb_normal != 0;
81}
82
Jens Axboee34cbd32016-11-09 12:36:15 -070083static void wb_timestamp(struct rq_wb *rwb, unsigned long *var)
84{
85 if (rwb_enabled(rwb)) {
86 const unsigned long cur = jiffies;
87
88 if (cur != *var)
89 *var = cur;
90 }
91}
92
93/*
94 * If a task was rate throttled in balance_dirty_pages() within the last
95 * second or so, use that to indicate a higher cleaning rate.
96 */
97static bool wb_recent_wait(struct rq_wb *rwb)
98{
Josef Bacika7905042018-07-03 09:32:35 -060099 struct bdi_writeback *wb = &rwb->rqos.q->backing_dev_info->wb;
Jens Axboee34cbd32016-11-09 12:36:15 -0700100
101 return time_before(jiffies, wb->dirty_sleep + HZ);
102}
103
Jens Axboe8bea6092018-05-07 09:57:08 -0600104static inline struct rq_wait *get_rq_wait(struct rq_wb *rwb,
105 enum wbt_flags wb_acct)
Jens Axboee34cbd32016-11-09 12:36:15 -0700106{
Jens Axboe8bea6092018-05-07 09:57:08 -0600107 if (wb_acct & WBT_KSWAPD)
108 return &rwb->rq_wait[WBT_RWQ_KSWAPD];
Jens Axboe782f5692018-05-07 10:03:23 -0600109 else if (wb_acct & WBT_DISCARD)
110 return &rwb->rq_wait[WBT_RWQ_DISCARD];
Jens Axboe8bea6092018-05-07 09:57:08 -0600111
112 return &rwb->rq_wait[WBT_RWQ_BG];
Jens Axboee34cbd32016-11-09 12:36:15 -0700113}
114
115static void rwb_wake_all(struct rq_wb *rwb)
116{
117 int i;
118
119 for (i = 0; i < WBT_NUM_RWQ; i++) {
120 struct rq_wait *rqw = &rwb->rq_wait[i];
121
Jens Axboeb7882092018-08-20 13:20:50 -0600122 if (wq_has_sleeper(&rqw->wait))
Jens Axboee34cbd32016-11-09 12:36:15 -0700123 wake_up_all(&rqw->wait);
124 }
125}
126
Jens Axboe061a5422018-08-26 10:09:06 -0600127static void wbt_rqw_done(struct rq_wb *rwb, struct rq_wait *rqw,
128 enum wbt_flags wb_acct)
Jens Axboee34cbd32016-11-09 12:36:15 -0700129{
Jens Axboee34cbd32016-11-09 12:36:15 -0700130 int inflight, limit;
131
Jens Axboee34cbd32016-11-09 12:36:15 -0700132 inflight = atomic_dec_return(&rqw->inflight);
133
134 /*
135 * wbt got disabled with IO in flight. Wake up any potential
136 * waiters, we don't have to do more than that.
137 */
138 if (unlikely(!rwb_enabled(rwb))) {
139 rwb_wake_all(rwb);
140 return;
141 }
142
143 /*
Jens Axboe782f5692018-05-07 10:03:23 -0600144 * For discards, our limit is always the background. For writes, if
145 * the device does write back caching, drop further down before we
146 * wake people up.
Jens Axboee34cbd32016-11-09 12:36:15 -0700147 */
Jens Axboe782f5692018-05-07 10:03:23 -0600148 if (wb_acct & WBT_DISCARD)
149 limit = rwb->wb_background;
150 else if (rwb->wc && !wb_recent_wait(rwb))
Jens Axboee34cbd32016-11-09 12:36:15 -0700151 limit = 0;
152 else
153 limit = rwb->wb_normal;
154
155 /*
156 * Don't wake anyone up if we are above the normal limit.
157 */
158 if (inflight && inflight >= limit)
159 return;
160
Jens Axboeb7882092018-08-20 13:20:50 -0600161 if (wq_has_sleeper(&rqw->wait)) {
Jens Axboee34cbd32016-11-09 12:36:15 -0700162 int diff = limit - inflight;
163
164 if (!inflight || diff >= rwb->wb_background / 2)
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600165 wake_up_all(&rqw->wait);
Jens Axboee34cbd32016-11-09 12:36:15 -0700166 }
167}
168
Jens Axboe061a5422018-08-26 10:09:06 -0600169static void __wbt_done(struct rq_qos *rqos, enum wbt_flags wb_acct)
170{
171 struct rq_wb *rwb = RQWB(rqos);
172 struct rq_wait *rqw;
173
174 if (!(wb_acct & WBT_TRACKED))
175 return;
176
177 rqw = get_rq_wait(rwb, wb_acct);
178 wbt_rqw_done(rwb, rqw, wb_acct);
179}
180
Jens Axboee34cbd32016-11-09 12:36:15 -0700181/*
182 * Called on completion of a request. Note that it's also called when
183 * a request is merged, when the request gets freed.
184 */
Josef Bacika7905042018-07-03 09:32:35 -0600185static void wbt_done(struct rq_qos *rqos, struct request *rq)
Jens Axboee34cbd32016-11-09 12:36:15 -0700186{
Josef Bacika7905042018-07-03 09:32:35 -0600187 struct rq_wb *rwb = RQWB(rqos);
Jens Axboee34cbd32016-11-09 12:36:15 -0700188
Omar Sandovala8a45942018-05-09 02:08:48 -0700189 if (!wbt_is_tracked(rq)) {
190 if (rwb->sync_cookie == rq) {
Jens Axboee34cbd32016-11-09 12:36:15 -0700191 rwb->sync_issue = 0;
192 rwb->sync_cookie = NULL;
193 }
194
Omar Sandovala8a45942018-05-09 02:08:48 -0700195 if (wbt_is_read(rq))
Jens Axboee34cbd32016-11-09 12:36:15 -0700196 wb_timestamp(rwb, &rwb->last_comp);
Jens Axboee34cbd32016-11-09 12:36:15 -0700197 } else {
Omar Sandovala8a45942018-05-09 02:08:48 -0700198 WARN_ON_ONCE(rq == rwb->sync_cookie);
Josef Bacika7905042018-07-03 09:32:35 -0600199 __wbt_done(rqos, wbt_flags(rq));
Jens Axboee34cbd32016-11-09 12:36:15 -0700200 }
Omar Sandovala8a45942018-05-09 02:08:48 -0700201 wbt_clear_state(rq);
Jens Axboee34cbd32016-11-09 12:36:15 -0700202}
203
Arnd Bergmann4121d382016-11-16 16:29:57 +0100204static inline bool stat_sample_valid(struct blk_rq_stat *stat)
Jens Axboee34cbd32016-11-09 12:36:15 -0700205{
206 /*
207 * We need at least one read sample, and a minimum of
208 * RWB_MIN_WRITE_SAMPLES. We require some write samples to know
209 * that it's writes impacting us, and not just some sole read on
210 * a device that is in a lower power state.
211 */
Omar Sandovalfa2e39c2017-03-21 08:56:06 -0700212 return (stat[READ].nr_samples >= 1 &&
213 stat[WRITE].nr_samples >= RWB_MIN_WRITE_SAMPLES);
Jens Axboee34cbd32016-11-09 12:36:15 -0700214}
215
216static u64 rwb_sync_issue_lat(struct rq_wb *rwb)
217{
Mark Rutland6aa7de02017-10-23 14:07:29 -0700218 u64 now, issue = READ_ONCE(rwb->sync_issue);
Jens Axboee34cbd32016-11-09 12:36:15 -0700219
220 if (!issue || !rwb->sync_cookie)
221 return 0;
222
223 now = ktime_to_ns(ktime_get());
224 return now - issue;
225}
226
227enum {
228 LAT_OK = 1,
229 LAT_UNKNOWN,
230 LAT_UNKNOWN_WRITES,
231 LAT_EXCEEDED,
232};
233
Omar Sandoval34dbad52017-03-21 08:56:08 -0700234static int latency_exceeded(struct rq_wb *rwb, struct blk_rq_stat *stat)
Jens Axboee34cbd32016-11-09 12:36:15 -0700235{
Josef Bacika7905042018-07-03 09:32:35 -0600236 struct backing_dev_info *bdi = rwb->rqos.q->backing_dev_info;
237 struct rq_depth *rqd = &rwb->rq_depth;
Jens Axboee34cbd32016-11-09 12:36:15 -0700238 u64 thislat;
239
240 /*
241 * If our stored sync issue exceeds the window size, or it
242 * exceeds our min target AND we haven't logged any entries,
243 * flag the latency as exceeded. wbt works off completion latencies,
244 * but for a flooded device, a single sync IO can take a long time
245 * to complete after being issued. If this time exceeds our
246 * monitoring window AND we didn't see any other completions in that
247 * window, then count that sync IO as a violation of the latency.
248 */
249 thislat = rwb_sync_issue_lat(rwb);
250 if (thislat > rwb->cur_win_nsec ||
Omar Sandovalfa2e39c2017-03-21 08:56:06 -0700251 (thislat > rwb->min_lat_nsec && !stat[READ].nr_samples)) {
Jens Axboed8a0cbf2016-11-10 21:52:53 -0700252 trace_wbt_lat(bdi, thislat);
Jens Axboee34cbd32016-11-09 12:36:15 -0700253 return LAT_EXCEEDED;
254 }
255
256 /*
257 * No read/write mix, if stat isn't valid
258 */
259 if (!stat_sample_valid(stat)) {
260 /*
261 * If we had writes in this stat window and the window is
262 * current, we're only doing writes. If a task recently
263 * waited or still has writes in flights, consider us doing
264 * just writes as well.
265 */
Omar Sandoval34dbad52017-03-21 08:56:08 -0700266 if (stat[WRITE].nr_samples || wb_recent_wait(rwb) ||
267 wbt_inflight(rwb))
Jens Axboee34cbd32016-11-09 12:36:15 -0700268 return LAT_UNKNOWN_WRITES;
269 return LAT_UNKNOWN;
270 }
271
272 /*
273 * If the 'min' latency exceeds our target, step down.
274 */
Omar Sandovalfa2e39c2017-03-21 08:56:06 -0700275 if (stat[READ].min > rwb->min_lat_nsec) {
276 trace_wbt_lat(bdi, stat[READ].min);
Jens Axboed8a0cbf2016-11-10 21:52:53 -0700277 trace_wbt_stat(bdi, stat);
Jens Axboee34cbd32016-11-09 12:36:15 -0700278 return LAT_EXCEEDED;
279 }
280
Josef Bacika7905042018-07-03 09:32:35 -0600281 if (rqd->scale_step)
Jens Axboed8a0cbf2016-11-10 21:52:53 -0700282 trace_wbt_stat(bdi, stat);
Jens Axboee34cbd32016-11-09 12:36:15 -0700283
284 return LAT_OK;
285}
286
Jens Axboee34cbd32016-11-09 12:36:15 -0700287static void rwb_trace_step(struct rq_wb *rwb, const char *msg)
288{
Josef Bacika7905042018-07-03 09:32:35 -0600289 struct backing_dev_info *bdi = rwb->rqos.q->backing_dev_info;
290 struct rq_depth *rqd = &rwb->rq_depth;
Jens Axboed8a0cbf2016-11-10 21:52:53 -0700291
Josef Bacika7905042018-07-03 09:32:35 -0600292 trace_wbt_step(bdi, msg, rqd->scale_step, rwb->cur_win_nsec,
293 rwb->wb_background, rwb->wb_normal, rqd->max_depth);
294}
295
296static void calc_wb_limits(struct rq_wb *rwb)
297{
298 if (rwb->min_lat_nsec == 0) {
299 rwb->wb_normal = rwb->wb_background = 0;
300 } else if (rwb->rq_depth.max_depth <= 2) {
301 rwb->wb_normal = rwb->rq_depth.max_depth;
302 rwb->wb_background = 1;
303 } else {
304 rwb->wb_normal = (rwb->rq_depth.max_depth + 1) / 2;
305 rwb->wb_background = (rwb->rq_depth.max_depth + 3) / 4;
306 }
Jens Axboee34cbd32016-11-09 12:36:15 -0700307}
308
309static void scale_up(struct rq_wb *rwb)
310{
Josef Bacika7905042018-07-03 09:32:35 -0600311 rq_depth_scale_up(&rwb->rq_depth);
312 calc_wb_limits(rwb);
Jens Axboee34cbd32016-11-09 12:36:15 -0700313 rwb->unknown_cnt = 0;
Josef Bacik5e65a202018-10-11 15:29:30 -0400314 rwb_wake_all(rwb);
Josef Bacika7905042018-07-03 09:32:35 -0600315 rwb_trace_step(rwb, "scale up");
Jens Axboee34cbd32016-11-09 12:36:15 -0700316}
317
Jens Axboee34cbd32016-11-09 12:36:15 -0700318static void scale_down(struct rq_wb *rwb, bool hard_throttle)
319{
Josef Bacika7905042018-07-03 09:32:35 -0600320 rq_depth_scale_down(&rwb->rq_depth, hard_throttle);
Jens Axboee34cbd32016-11-09 12:36:15 -0700321 calc_wb_limits(rwb);
Josef Bacika7905042018-07-03 09:32:35 -0600322 rwb->unknown_cnt = 0;
Josef Bacika7905042018-07-03 09:32:35 -0600323 rwb_trace_step(rwb, "scale down");
Jens Axboee34cbd32016-11-09 12:36:15 -0700324}
325
326static void rwb_arm_timer(struct rq_wb *rwb)
327{
Josef Bacika7905042018-07-03 09:32:35 -0600328 struct rq_depth *rqd = &rwb->rq_depth;
329
330 if (rqd->scale_step > 0) {
Jens Axboee34cbd32016-11-09 12:36:15 -0700331 /*
332 * We should speed this up, using some variant of a fast
333 * integer inverse square root calculation. Since we only do
334 * this for every window expiration, it's not a huge deal,
335 * though.
336 */
337 rwb->cur_win_nsec = div_u64(rwb->win_nsec << 4,
Josef Bacika7905042018-07-03 09:32:35 -0600338 int_sqrt((rqd->scale_step + 1) << 8));
Jens Axboee34cbd32016-11-09 12:36:15 -0700339 } else {
340 /*
341 * For step < 0, we don't want to increase/decrease the
342 * window size.
343 */
344 rwb->cur_win_nsec = rwb->win_nsec;
345 }
346
Omar Sandoval34dbad52017-03-21 08:56:08 -0700347 blk_stat_activate_nsecs(rwb->cb, rwb->cur_win_nsec);
Jens Axboee34cbd32016-11-09 12:36:15 -0700348}
349
Omar Sandoval34dbad52017-03-21 08:56:08 -0700350static void wb_timer_fn(struct blk_stat_callback *cb)
Jens Axboee34cbd32016-11-09 12:36:15 -0700351{
Omar Sandoval34dbad52017-03-21 08:56:08 -0700352 struct rq_wb *rwb = cb->data;
Josef Bacika7905042018-07-03 09:32:35 -0600353 struct rq_depth *rqd = &rwb->rq_depth;
Jens Axboee34cbd32016-11-09 12:36:15 -0700354 unsigned int inflight = wbt_inflight(rwb);
355 int status;
356
Omar Sandoval34dbad52017-03-21 08:56:08 -0700357 status = latency_exceeded(rwb, cb->stat);
Jens Axboee34cbd32016-11-09 12:36:15 -0700358
Josef Bacika7905042018-07-03 09:32:35 -0600359 trace_wbt_timer(rwb->rqos.q->backing_dev_info, status, rqd->scale_step,
Jens Axboed8a0cbf2016-11-10 21:52:53 -0700360 inflight);
Jens Axboee34cbd32016-11-09 12:36:15 -0700361
362 /*
363 * If we exceeded the latency target, step down. If we did not,
364 * step one level up. If we don't know enough to say either exceeded
365 * or ok, then don't do anything.
366 */
367 switch (status) {
368 case LAT_EXCEEDED:
369 scale_down(rwb, true);
370 break;
371 case LAT_OK:
372 scale_up(rwb);
373 break;
374 case LAT_UNKNOWN_WRITES:
375 /*
376 * We started a the center step, but don't have a valid
377 * read/write sample, but we do have writes going on.
378 * Allow step to go negative, to increase write perf.
379 */
380 scale_up(rwb);
381 break;
382 case LAT_UNKNOWN:
383 if (++rwb->unknown_cnt < RWB_UNKNOWN_BUMP)
384 break;
385 /*
386 * We get here when previously scaled reduced depth, and we
387 * currently don't have a valid read/write sample. For that
388 * case, slowly return to center state (step == 0).
389 */
Josef Bacika7905042018-07-03 09:32:35 -0600390 if (rqd->scale_step > 0)
Jens Axboee34cbd32016-11-09 12:36:15 -0700391 scale_up(rwb);
Josef Bacika7905042018-07-03 09:32:35 -0600392 else if (rqd->scale_step < 0)
Jens Axboee34cbd32016-11-09 12:36:15 -0700393 scale_down(rwb, false);
394 break;
395 default:
396 break;
397 }
398
399 /*
400 * Re-arm timer, if we have IO in flight
401 */
Josef Bacika7905042018-07-03 09:32:35 -0600402 if (rqd->scale_step || inflight)
Jens Axboee34cbd32016-11-09 12:36:15 -0700403 rwb_arm_timer(rwb);
404}
405
Josef Bacika7905042018-07-03 09:32:35 -0600406static void __wbt_update_limits(struct rq_wb *rwb)
Jens Axboee34cbd32016-11-09 12:36:15 -0700407{
Josef Bacika7905042018-07-03 09:32:35 -0600408 struct rq_depth *rqd = &rwb->rq_depth;
409
410 rqd->scale_step = 0;
411 rqd->scaled_max = false;
412
413 rq_depth_calc_max_depth(rqd);
Jens Axboee34cbd32016-11-09 12:36:15 -0700414 calc_wb_limits(rwb);
415
416 rwb_wake_all(rwb);
417}
418
Josef Bacika7905042018-07-03 09:32:35 -0600419void wbt_update_limits(struct request_queue *q)
420{
421 struct rq_qos *rqos = wbt_rq_qos(q);
422 if (!rqos)
423 return;
424 __wbt_update_limits(RQWB(rqos));
425}
426
427u64 wbt_get_min_lat(struct request_queue *q)
428{
429 struct rq_qos *rqos = wbt_rq_qos(q);
430 if (!rqos)
431 return 0;
432 return RQWB(rqos)->min_lat_nsec;
433}
434
435void wbt_set_min_lat(struct request_queue *q, u64 val)
436{
437 struct rq_qos *rqos = wbt_rq_qos(q);
438 if (!rqos)
439 return;
440 RQWB(rqos)->min_lat_nsec = val;
441 RQWB(rqos)->enable_state = WBT_STATE_ON_MANUAL;
442 __wbt_update_limits(RQWB(rqos));
443}
444
445
Jens Axboee34cbd32016-11-09 12:36:15 -0700446static bool close_io(struct rq_wb *rwb)
447{
448 const unsigned long now = jiffies;
449
450 return time_before(now, rwb->last_issue + HZ / 10) ||
451 time_before(now, rwb->last_comp + HZ / 10);
452}
453
454#define REQ_HIPRIO (REQ_SYNC | REQ_META | REQ_PRIO)
455
456static inline unsigned int get_limit(struct rq_wb *rwb, unsigned long rw)
457{
458 unsigned int limit;
459
Jens Axboeffa358d2018-08-20 13:24:25 -0600460 /*
461 * If we got disabled, just return UINT_MAX. This ensures that
462 * we'll properly inc a new IO, and dec+wakeup at the end.
463 */
464 if (!rwb_enabled(rwb))
465 return UINT_MAX;
466
Jens Axboe782f5692018-05-07 10:03:23 -0600467 if ((rw & REQ_OP_MASK) == REQ_OP_DISCARD)
468 return rwb->wb_background;
469
Jens Axboee34cbd32016-11-09 12:36:15 -0700470 /*
471 * At this point we know it's a buffered write. If this is
weiping zhang3dfbdc42017-11-23 21:40:10 +0800472 * kswapd trying to free memory, or REQ_SYNC is set, then
Jens Axboee34cbd32016-11-09 12:36:15 -0700473 * it's WB_SYNC_ALL writeback, and we'll use the max limit for
474 * that. If the write is marked as a background write, then use
475 * the idle limit, or go to normal if we haven't had competing
476 * IO for a bit.
477 */
478 if ((rw & REQ_HIPRIO) || wb_recent_wait(rwb) || current_is_kswapd())
Josef Bacika7905042018-07-03 09:32:35 -0600479 limit = rwb->rq_depth.max_depth;
Jens Axboee34cbd32016-11-09 12:36:15 -0700480 else if ((rw & REQ_BACKGROUND) || close_io(rwb)) {
481 /*
482 * If less than 100ms since we completed unrelated IO,
483 * limit us to half the depth for background writeback.
484 */
485 limit = rwb->wb_background;
486 } else
487 limit = rwb->wb_normal;
488
489 return limit;
490}
491
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600492struct wbt_wait_data {
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600493 struct rq_wb *rwb;
Josef Bacikb6c7b582018-12-04 12:59:03 -0500494 enum wbt_flags wb_acct;
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600495 unsigned long rw;
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600496};
497
Josef Bacikb6c7b582018-12-04 12:59:03 -0500498static bool wbt_inflight_cb(struct rq_wait *rqw, void *private_data)
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600499{
Josef Bacikb6c7b582018-12-04 12:59:03 -0500500 struct wbt_wait_data *data = private_data;
501 return rq_wait_inc_below(rqw, get_limit(data->rwb, data->rw));
502}
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600503
Josef Bacikb6c7b582018-12-04 12:59:03 -0500504static void wbt_cleanup_cb(struct rq_wait *rqw, void *private_data)
505{
506 struct wbt_wait_data *data = private_data;
507 wbt_rqw_done(data->rwb, rqw, data->wb_acct);
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600508}
509
Jens Axboee34cbd32016-11-09 12:36:15 -0700510/*
511 * Block if we will exceed our limit, or if we are currently waiting for
512 * the timer to kick off queuing again.
513 */
Jens Axboe8bea6092018-05-07 09:57:08 -0600514static void __wbt_wait(struct rq_wb *rwb, enum wbt_flags wb_acct,
Christoph Hellwigd5337562018-11-14 17:02:09 +0100515 unsigned long rw)
Jens Axboee34cbd32016-11-09 12:36:15 -0700516{
Jens Axboe8bea6092018-05-07 09:57:08 -0600517 struct rq_wait *rqw = get_rq_wait(rwb, wb_acct);
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600518 struct wbt_wait_data data = {
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600519 .rwb = rwb,
Josef Bacikb6c7b582018-12-04 12:59:03 -0500520 .wb_acct = wb_acct,
Jens Axboe38cfb5a2018-08-26 10:10:05 -0600521 .rw = rw,
522 };
Jens Axboee34cbd32016-11-09 12:36:15 -0700523
Josef Bacikb6c7b582018-12-04 12:59:03 -0500524 rq_qos_wait(rqw, &data, wbt_inflight_cb, wbt_cleanup_cb);
Jens Axboee34cbd32016-11-09 12:36:15 -0700525}
526
527static inline bool wbt_should_throttle(struct rq_wb *rwb, struct bio *bio)
528{
Jens Axboe782f5692018-05-07 10:03:23 -0600529 switch (bio_op(bio)) {
530 case REQ_OP_WRITE:
531 /*
532 * Don't throttle WRITE_ODIRECT
533 */
534 if ((bio->bi_opf & (REQ_SYNC | REQ_IDLE)) ==
535 (REQ_SYNC | REQ_IDLE))
536 return false;
537 /* fallthrough */
538 case REQ_OP_DISCARD:
539 return true;
540 default:
Jens Axboee34cbd32016-11-09 12:36:15 -0700541 return false;
Jens Axboe782f5692018-05-07 10:03:23 -0600542 }
Jens Axboee34cbd32016-11-09 12:36:15 -0700543}
544
Josef Bacikc1c80382018-07-03 11:14:59 -0400545static enum wbt_flags bio_to_wbt_flags(struct rq_wb *rwb, struct bio *bio)
546{
547 enum wbt_flags flags = 0;
548
Jens Axboec1253112018-08-23 09:34:46 -0600549 if (!rwb_enabled(rwb))
550 return 0;
551
Josef Bacikc1c80382018-07-03 11:14:59 -0400552 if (bio_op(bio) == REQ_OP_READ) {
553 flags = WBT_READ;
554 } else if (wbt_should_throttle(rwb, bio)) {
555 if (current_is_kswapd())
556 flags |= WBT_KSWAPD;
557 if (bio_op(bio) == REQ_OP_DISCARD)
558 flags |= WBT_DISCARD;
559 flags |= WBT_TRACKED;
560 }
561 return flags;
562}
563
564static void wbt_cleanup(struct rq_qos *rqos, struct bio *bio)
565{
566 struct rq_wb *rwb = RQWB(rqos);
567 enum wbt_flags flags = bio_to_wbt_flags(rwb, bio);
568 __wbt_done(rqos, flags);
569}
570
Jens Axboee34cbd32016-11-09 12:36:15 -0700571/*
572 * Returns true if the IO request should be accounted, false if not.
573 * May sleep, if we have exceeded the writeback limits. Caller can pass
574 * in an irq held spinlock, if it holds one when calling this function.
575 * If we do sleep, we'll release and re-grab it.
576 */
Christoph Hellwigd5337562018-11-14 17:02:09 +0100577static void wbt_wait(struct rq_qos *rqos, struct bio *bio)
Jens Axboee34cbd32016-11-09 12:36:15 -0700578{
Josef Bacika7905042018-07-03 09:32:35 -0600579 struct rq_wb *rwb = RQWB(rqos);
Josef Bacikc1c80382018-07-03 11:14:59 -0400580 enum wbt_flags flags;
Jens Axboee34cbd32016-11-09 12:36:15 -0700581
Josef Bacikc1c80382018-07-03 11:14:59 -0400582 flags = bio_to_wbt_flags(rwb, bio);
Ming Leidf60f6e2018-08-14 23:57:49 +0800583 if (!(flags & WBT_TRACKED)) {
Josef Bacikc1c80382018-07-03 11:14:59 -0400584 if (flags & WBT_READ)
Jens Axboee34cbd32016-11-09 12:36:15 -0700585 wb_timestamp(rwb, &rwb->last_issue);
Josef Bacikc1c80382018-07-03 11:14:59 -0400586 return;
Jens Axboee34cbd32016-11-09 12:36:15 -0700587 }
588
Christoph Hellwigd5337562018-11-14 17:02:09 +0100589 __wbt_wait(rwb, flags, bio->bi_opf);
Jens Axboee34cbd32016-11-09 12:36:15 -0700590
Omar Sandoval34dbad52017-03-21 08:56:08 -0700591 if (!blk_stat_is_active(rwb->cb))
Jens Axboee34cbd32016-11-09 12:36:15 -0700592 rwb_arm_timer(rwb);
Josef Bacikc1c80382018-07-03 11:14:59 -0400593}
Jens Axboee34cbd32016-11-09 12:36:15 -0700594
Josef Bacikc1c80382018-07-03 11:14:59 -0400595static void wbt_track(struct rq_qos *rqos, struct request *rq, struct bio *bio)
596{
597 struct rq_wb *rwb = RQWB(rqos);
598 rq->wbt_flags |= bio_to_wbt_flags(rwb, bio);
Jens Axboee34cbd32016-11-09 12:36:15 -0700599}
600
Bart Van Asschec83f5362019-01-23 11:05:57 -0800601static void wbt_issue(struct rq_qos *rqos, struct request *rq)
Jens Axboee34cbd32016-11-09 12:36:15 -0700602{
Josef Bacika7905042018-07-03 09:32:35 -0600603 struct rq_wb *rwb = RQWB(rqos);
604
Jens Axboee34cbd32016-11-09 12:36:15 -0700605 if (!rwb_enabled(rwb))
606 return;
607
608 /*
Omar Sandovala8a45942018-05-09 02:08:48 -0700609 * Track sync issue, in case it takes a long time to complete. Allows us
610 * to react quicker, if a sync IO takes a long time to complete. Note
611 * that this is just a hint. The request can go away when it completes,
612 * so it's important we never dereference it. We only use the address to
613 * compare with, which is why we store the sync_issue time locally.
Jens Axboee34cbd32016-11-09 12:36:15 -0700614 */
Omar Sandovala8a45942018-05-09 02:08:48 -0700615 if (wbt_is_read(rq) && !rwb->sync_issue) {
616 rwb->sync_cookie = rq;
Omar Sandoval544ccc8d2018-05-09 02:08:50 -0700617 rwb->sync_issue = rq->io_start_time_ns;
Jens Axboee34cbd32016-11-09 12:36:15 -0700618 }
619}
620
Bart Van Asschec83f5362019-01-23 11:05:57 -0800621static void wbt_requeue(struct rq_qos *rqos, struct request *rq)
Jens Axboee34cbd32016-11-09 12:36:15 -0700622{
Josef Bacika7905042018-07-03 09:32:35 -0600623 struct rq_wb *rwb = RQWB(rqos);
Jens Axboee34cbd32016-11-09 12:36:15 -0700624 if (!rwb_enabled(rwb))
625 return;
Omar Sandovala8a45942018-05-09 02:08:48 -0700626 if (rq == rwb->sync_cookie) {
Jens Axboee34cbd32016-11-09 12:36:15 -0700627 rwb->sync_issue = 0;
628 rwb->sync_cookie = NULL;
629 }
630}
631
Josef Bacika7905042018-07-03 09:32:35 -0600632void wbt_set_write_cache(struct request_queue *q, bool write_cache_on)
Jens Axboee34cbd32016-11-09 12:36:15 -0700633{
Josef Bacika7905042018-07-03 09:32:35 -0600634 struct rq_qos *rqos = wbt_rq_qos(q);
635 if (rqos)
636 RQWB(rqos)->wc = write_cache_on;
Jens Axboee34cbd32016-11-09 12:36:15 -0700637}
638
Jan Kara3f19cd22017-04-11 11:29:01 +0200639/*
Jan Kara8330cdb2017-04-19 11:33:27 +0200640 * Enable wbt if defaults are configured that way
641 */
642void wbt_enable_default(struct request_queue *q)
643{
Josef Bacika7905042018-07-03 09:32:35 -0600644 struct rq_qos *rqos = wbt_rq_qos(q);
Jan Kara8330cdb2017-04-19 11:33:27 +0200645 /* Throttling already enabled? */
Josef Bacika7905042018-07-03 09:32:35 -0600646 if (rqos)
Jan Kara8330cdb2017-04-19 11:33:27 +0200647 return;
648
649 /* Queue not registered? Maybe shutting down... */
Ming Lei58c898b2019-08-27 19:01:47 +0800650 if (!blk_queue_registered(q))
Jan Kara8330cdb2017-04-19 11:33:27 +0200651 return;
652
Jens Axboe344e9ff2018-11-15 12:22:51 -0700653 if (queue_is_mq(q) && IS_ENABLED(CONFIG_BLK_WBT_MQ))
Jan Kara8330cdb2017-04-19 11:33:27 +0200654 wbt_init(q);
655}
656EXPORT_SYMBOL_GPL(wbt_enable_default);
657
Jens Axboe80e091d2016-11-28 09:22:47 -0700658u64 wbt_default_latency_nsec(struct request_queue *q)
659{
660 /*
661 * We default to 2msec for non-rotational storage, and 75msec
662 * for rotational storage.
663 */
664 if (blk_queue_nonrot(q))
665 return 2000000ULL;
666 else
667 return 75000000ULL;
668}
669
Jens Axboe99c749a2017-04-21 07:55:42 -0600670static int wbt_data_dir(const struct request *rq)
671{
Jens Axboe5235553d2018-02-05 13:16:56 -0700672 const int op = req_op(rq);
673
674 if (op == REQ_OP_READ)
675 return READ;
Jens Axboe825843b2018-05-03 09:14:57 -0600676 else if (op_is_write(op))
Jens Axboe5235553d2018-02-05 13:16:56 -0700677 return WRITE;
678
679 /* don't account */
680 return -1;
Jens Axboe99c749a2017-04-21 07:55:42 -0600681}
682
Tejun Heo9677a3e2019-08-28 15:05:55 -0700683static void wbt_queue_depth_changed(struct rq_qos *rqos)
684{
685 RQWB(rqos)->rq_depth.queue_depth = blk_queue_depth(rqos->q);
686 __wbt_update_limits(RQWB(rqos));
687}
688
Josef Bacika7905042018-07-03 09:32:35 -0600689static void wbt_exit(struct rq_qos *rqos)
690{
691 struct rq_wb *rwb = RQWB(rqos);
692 struct request_queue *q = rqos->q;
693
694 blk_stat_remove_callback(q, rwb->cb);
695 blk_stat_free_callback(rwb->cb);
696 kfree(rwb);
697}
698
699/*
700 * Disable wbt, if enabled by default.
701 */
702void wbt_disable_default(struct request_queue *q)
703{
704 struct rq_qos *rqos = wbt_rq_qos(q);
705 struct rq_wb *rwb;
706 if (!rqos)
707 return;
708 rwb = RQWB(rqos);
Ming Lei544fbd12018-12-12 19:44:34 +0800709 if (rwb->enable_state == WBT_STATE_ON_DEFAULT) {
710 blk_stat_deactivate(rwb->cb);
Josef Bacika7905042018-07-03 09:32:35 -0600711 rwb->wb_normal = 0;
Ming Lei544fbd12018-12-12 19:44:34 +0800712 }
Josef Bacika7905042018-07-03 09:32:35 -0600713}
Jens Axboee815f402018-11-15 12:31:27 -0700714EXPORT_SYMBOL_GPL(wbt_disable_default);
Josef Bacika7905042018-07-03 09:32:35 -0600715
Ming Leid19afeb2018-12-17 09:46:01 +0800716#ifdef CONFIG_BLK_DEBUG_FS
717static int wbt_curr_win_nsec_show(void *data, struct seq_file *m)
718{
719 struct rq_qos *rqos = data;
720 struct rq_wb *rwb = RQWB(rqos);
721
722 seq_printf(m, "%llu\n", rwb->cur_win_nsec);
723 return 0;
724}
725
726static int wbt_enabled_show(void *data, struct seq_file *m)
727{
728 struct rq_qos *rqos = data;
729 struct rq_wb *rwb = RQWB(rqos);
730
731 seq_printf(m, "%d\n", rwb->enable_state);
732 return 0;
733}
734
735static int wbt_id_show(void *data, struct seq_file *m)
736{
737 struct rq_qos *rqos = data;
738
739 seq_printf(m, "%u\n", rqos->id);
740 return 0;
741}
742
743static int wbt_inflight_show(void *data, struct seq_file *m)
744{
745 struct rq_qos *rqos = data;
746 struct rq_wb *rwb = RQWB(rqos);
747 int i;
748
749 for (i = 0; i < WBT_NUM_RWQ; i++)
750 seq_printf(m, "%d: inflight %d\n", i,
751 atomic_read(&rwb->rq_wait[i].inflight));
752 return 0;
753}
754
755static int wbt_min_lat_nsec_show(void *data, struct seq_file *m)
756{
757 struct rq_qos *rqos = data;
758 struct rq_wb *rwb = RQWB(rqos);
759
760 seq_printf(m, "%lu\n", rwb->min_lat_nsec);
761 return 0;
762}
763
764static int wbt_unknown_cnt_show(void *data, struct seq_file *m)
765{
766 struct rq_qos *rqos = data;
767 struct rq_wb *rwb = RQWB(rqos);
768
769 seq_printf(m, "%u\n", rwb->unknown_cnt);
770 return 0;
771}
772
773static int wbt_normal_show(void *data, struct seq_file *m)
774{
775 struct rq_qos *rqos = data;
776 struct rq_wb *rwb = RQWB(rqos);
777
778 seq_printf(m, "%u\n", rwb->wb_normal);
779 return 0;
780}
781
782static int wbt_background_show(void *data, struct seq_file *m)
783{
784 struct rq_qos *rqos = data;
785 struct rq_wb *rwb = RQWB(rqos);
786
787 seq_printf(m, "%u\n", rwb->wb_background);
788 return 0;
789}
790
791static const struct blk_mq_debugfs_attr wbt_debugfs_attrs[] = {
792 {"curr_win_nsec", 0400, wbt_curr_win_nsec_show},
793 {"enabled", 0400, wbt_enabled_show},
794 {"id", 0400, wbt_id_show},
795 {"inflight", 0400, wbt_inflight_show},
796 {"min_lat_nsec", 0400, wbt_min_lat_nsec_show},
797 {"unknown_cnt", 0400, wbt_unknown_cnt_show},
798 {"wb_normal", 0400, wbt_normal_show},
799 {"wb_background", 0400, wbt_background_show},
800 {},
801};
802#endif
803
Josef Bacika7905042018-07-03 09:32:35 -0600804static struct rq_qos_ops wbt_rqos_ops = {
805 .throttle = wbt_wait,
806 .issue = wbt_issue,
Josef Bacikc1c80382018-07-03 11:14:59 -0400807 .track = wbt_track,
Josef Bacika7905042018-07-03 09:32:35 -0600808 .requeue = wbt_requeue,
809 .done = wbt_done,
Josef Bacikc1c80382018-07-03 11:14:59 -0400810 .cleanup = wbt_cleanup,
Tejun Heo9677a3e2019-08-28 15:05:55 -0700811 .queue_depth_changed = wbt_queue_depth_changed,
Josef Bacika7905042018-07-03 09:32:35 -0600812 .exit = wbt_exit,
Ming Leid19afeb2018-12-17 09:46:01 +0800813#ifdef CONFIG_BLK_DEBUG_FS
814 .debugfs_attrs = wbt_debugfs_attrs,
815#endif
Josef Bacika7905042018-07-03 09:32:35 -0600816};
817
Jens Axboe8054b892016-11-10 21:50:51 -0700818int wbt_init(struct request_queue *q)
Jens Axboee34cbd32016-11-09 12:36:15 -0700819{
820 struct rq_wb *rwb;
821 int i;
822
Jens Axboee34cbd32016-11-09 12:36:15 -0700823 rwb = kzalloc(sizeof(*rwb), GFP_KERNEL);
824 if (!rwb)
825 return -ENOMEM;
826
Jens Axboe99c749a2017-04-21 07:55:42 -0600827 rwb->cb = blk_stat_alloc_callback(wb_timer_fn, wbt_data_dir, 2, rwb);
Omar Sandoval34dbad52017-03-21 08:56:08 -0700828 if (!rwb->cb) {
829 kfree(rwb);
830 return -ENOMEM;
831 }
832
Josef Bacika7905042018-07-03 09:32:35 -0600833 for (i = 0; i < WBT_NUM_RWQ; i++)
834 rq_wait_init(&rwb->rq_wait[i]);
Jens Axboee34cbd32016-11-09 12:36:15 -0700835
Josef Bacika7905042018-07-03 09:32:35 -0600836 rwb->rqos.id = RQ_QOS_WBT;
837 rwb->rqos.ops = &wbt_rqos_ops;
838 rwb->rqos.q = q;
Jens Axboee34cbd32016-11-09 12:36:15 -0700839 rwb->last_comp = rwb->last_issue = jiffies;
Jens Axboee34cbd32016-11-09 12:36:15 -0700840 rwb->win_nsec = RWB_WINDOW_NSEC;
Jens Axboed62118b2016-11-28 09:40:34 -0700841 rwb->enable_state = WBT_STATE_ON_DEFAULT;
Josef Bacika7905042018-07-03 09:32:35 -0600842 rwb->wc = 1;
843 rwb->rq_depth.default_depth = RWB_DEF_DEPTH;
844 __wbt_update_limits(rwb);
Jens Axboee34cbd32016-11-09 12:36:15 -0700845
846 /*
Omar Sandoval34dbad52017-03-21 08:56:08 -0700847 * Assign rwb and add the stats callback.
Jens Axboee34cbd32016-11-09 12:36:15 -0700848 */
Josef Bacika7905042018-07-03 09:32:35 -0600849 rq_qos_add(q, &rwb->rqos);
Omar Sandoval34dbad52017-03-21 08:56:08 -0700850 blk_stat_add_callback(q, rwb->cb);
Jens Axboee34cbd32016-11-09 12:36:15 -0700851
Jens Axboe80e091d2016-11-28 09:22:47 -0700852 rwb->min_lat_nsec = wbt_default_latency_nsec(q);
Jens Axboee34cbd32016-11-09 12:36:15 -0700853
Tejun Heo9677a3e2019-08-28 15:05:55 -0700854 wbt_queue_depth_changed(&rwb->rqos);
Josef Bacika7905042018-07-03 09:32:35 -0600855 wbt_set_write_cache(q, test_bit(QUEUE_FLAG_WC, &q->queue_flags));
Jens Axboee34cbd32016-11-09 12:36:15 -0700856
857 return 0;
858}