1 // SPDX-License-Identifier: GPL-2.0
3 * buffered writeback throttling. loosely based on CoDel. We can't drop
4 * packets for IO scheduling, so the logic is something like this:
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.
19 * Copyright (C) 2016 Jens Axboe
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>
29 #include "blk-rq-qos.h"
31 #define CREATE_TRACE_POINTS
32 #include <trace/events/wbt.h>
34 static inline void wbt_clear_state(struct request
*rq
)
39 static inline enum wbt_flags
wbt_flags(struct request
*rq
)
44 static inline bool wbt_is_tracked(struct request
*rq
)
46 return rq
->wbt_flags
& WBT_TRACKED
;
49 static inline bool wbt_is_read(struct request
*rq
)
51 return rq
->wbt_flags
& WBT_READ
;
56 * Default setting, we'll scale up (to 75% of QD max) or down (min 1)
57 * from here depending on device stats
64 RWB_WINDOW_NSEC
= 100 * 1000 * 1000ULL,
67 * Disregard stats, if we don't meet this minimum
69 RWB_MIN_WRITE_SAMPLES
= 3,
72 * If we have this number of consecutive windows with not enough
73 * information to scale up or down, scale up.
78 static inline bool rwb_enabled(struct rq_wb
*rwb
)
80 return rwb
&& rwb
->wb_normal
!= 0;
83 static void wb_timestamp(struct rq_wb
*rwb
, unsigned long *var
)
85 if (rwb_enabled(rwb
)) {
86 const unsigned long cur
= jiffies
;
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.
97 static bool wb_recent_wait(struct rq_wb
*rwb
)
99 struct bdi_writeback
*wb
= &rwb
->rqos
.q
->backing_dev_info
->wb
;
101 return time_before(jiffies
, wb
->dirty_sleep
+ HZ
);
104 static inline struct rq_wait
*get_rq_wait(struct rq_wb
*rwb
,
105 enum wbt_flags wb_acct
)
107 if (wb_acct
& WBT_KSWAPD
)
108 return &rwb
->rq_wait
[WBT_RWQ_KSWAPD
];
109 else if (wb_acct
& WBT_DISCARD
)
110 return &rwb
->rq_wait
[WBT_RWQ_DISCARD
];
112 return &rwb
->rq_wait
[WBT_RWQ_BG
];
115 static void rwb_wake_all(struct rq_wb
*rwb
)
119 for (i
= 0; i
< WBT_NUM_RWQ
; i
++) {
120 struct rq_wait
*rqw
= &rwb
->rq_wait
[i
];
122 if (wq_has_sleeper(&rqw
->wait
))
123 wake_up_all(&rqw
->wait
);
127 static void wbt_rqw_done(struct rq_wb
*rwb
, struct rq_wait
*rqw
,
128 enum wbt_flags wb_acct
)
132 inflight
= atomic_dec_return(&rqw
->inflight
);
135 * wbt got disabled with IO in flight. Wake up any potential
136 * waiters, we don't have to do more than that.
138 if (unlikely(!rwb_enabled(rwb
))) {
144 * For discards, our limit is always the background. For writes, if
145 * the device does write back caching, drop further down before we
148 if (wb_acct
& WBT_DISCARD
)
149 limit
= rwb
->wb_background
;
150 else if (rwb
->wc
&& !wb_recent_wait(rwb
))
153 limit
= rwb
->wb_normal
;
156 * Don't wake anyone up if we are above the normal limit.
158 if (inflight
&& inflight
>= limit
)
161 if (wq_has_sleeper(&rqw
->wait
)) {
162 int diff
= limit
- inflight
;
164 if (!inflight
|| diff
>= rwb
->wb_background
/ 2)
165 wake_up_all(&rqw
->wait
);
169 static void __wbt_done(struct rq_qos
*rqos
, enum wbt_flags wb_acct
)
171 struct rq_wb
*rwb
= RQWB(rqos
);
174 if (!(wb_acct
& WBT_TRACKED
))
177 rqw
= get_rq_wait(rwb
, wb_acct
);
178 wbt_rqw_done(rwb
, rqw
, wb_acct
);
182 * Called on completion of a request. Note that it's also called when
183 * a request is merged, when the request gets freed.
185 static void wbt_done(struct rq_qos
*rqos
, struct request
*rq
)
187 struct rq_wb
*rwb
= RQWB(rqos
);
189 if (!wbt_is_tracked(rq
)) {
190 if (rwb
->sync_cookie
== rq
) {
192 rwb
->sync_cookie
= NULL
;
196 wb_timestamp(rwb
, &rwb
->last_comp
);
198 WARN_ON_ONCE(rq
== rwb
->sync_cookie
);
199 __wbt_done(rqos
, wbt_flags(rq
));
204 static inline bool stat_sample_valid(struct blk_rq_stat
*stat
)
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.
212 return (stat
[READ
].nr_samples
>= 1 &&
213 stat
[WRITE
].nr_samples
>= RWB_MIN_WRITE_SAMPLES
);
216 static u64
rwb_sync_issue_lat(struct rq_wb
*rwb
)
218 u64 now
, issue
= READ_ONCE(rwb
->sync_issue
);
220 if (!issue
|| !rwb
->sync_cookie
)
223 now
= ktime_to_ns(ktime_get());
234 static int latency_exceeded(struct rq_wb
*rwb
, struct blk_rq_stat
*stat
)
236 struct backing_dev_info
*bdi
= rwb
->rqos
.q
->backing_dev_info
;
237 struct rq_depth
*rqd
= &rwb
->rq_depth
;
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.
249 thislat
= rwb_sync_issue_lat(rwb
);
250 if (thislat
> rwb
->cur_win_nsec
||
251 (thislat
> rwb
->min_lat_nsec
&& !stat
[READ
].nr_samples
)) {
252 trace_wbt_lat(bdi
, thislat
);
257 * No read/write mix, if stat isn't valid
259 if (!stat_sample_valid(stat
)) {
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.
266 if (stat
[WRITE
].nr_samples
|| wb_recent_wait(rwb
) ||
268 return LAT_UNKNOWN_WRITES
;
273 * If the 'min' latency exceeds our target, step down.
275 if (stat
[READ
].min
> rwb
->min_lat_nsec
) {
276 trace_wbt_lat(bdi
, stat
[READ
].min
);
277 trace_wbt_stat(bdi
, stat
);
282 trace_wbt_stat(bdi
, stat
);
287 static void rwb_trace_step(struct rq_wb
*rwb
, const char *msg
)
289 struct backing_dev_info
*bdi
= rwb
->rqos
.q
->backing_dev_info
;
290 struct rq_depth
*rqd
= &rwb
->rq_depth
;
292 trace_wbt_step(bdi
, msg
, rqd
->scale_step
, rwb
->cur_win_nsec
,
293 rwb
->wb_background
, rwb
->wb_normal
, rqd
->max_depth
);
296 static void calc_wb_limits(struct rq_wb
*rwb
)
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;
304 rwb
->wb_normal
= (rwb
->rq_depth
.max_depth
+ 1) / 2;
305 rwb
->wb_background
= (rwb
->rq_depth
.max_depth
+ 3) / 4;
309 static void scale_up(struct rq_wb
*rwb
)
311 if (!rq_depth_scale_up(&rwb
->rq_depth
))
314 rwb
->unknown_cnt
= 0;
316 rwb_trace_step(rwb
, tracepoint_string("scale up"));
319 static void scale_down(struct rq_wb
*rwb
, bool hard_throttle
)
321 if (!rq_depth_scale_down(&rwb
->rq_depth
, hard_throttle
))
324 rwb
->unknown_cnt
= 0;
325 rwb_trace_step(rwb
, tracepoint_string("scale down"));
328 static void rwb_arm_timer(struct rq_wb
*rwb
)
330 struct rq_depth
*rqd
= &rwb
->rq_depth
;
332 if (rqd
->scale_step
> 0) {
334 * We should speed this up, using some variant of a fast
335 * integer inverse square root calculation. Since we only do
336 * this for every window expiration, it's not a huge deal,
339 rwb
->cur_win_nsec
= div_u64(rwb
->win_nsec
<< 4,
340 int_sqrt((rqd
->scale_step
+ 1) << 8));
343 * For step < 0, we don't want to increase/decrease the
346 rwb
->cur_win_nsec
= rwb
->win_nsec
;
349 blk_stat_activate_nsecs(rwb
->cb
, rwb
->cur_win_nsec
);
352 static void wb_timer_fn(struct blk_stat_callback
*cb
)
354 struct rq_wb
*rwb
= cb
->data
;
355 struct rq_depth
*rqd
= &rwb
->rq_depth
;
356 unsigned int inflight
= wbt_inflight(rwb
);
359 status
= latency_exceeded(rwb
, cb
->stat
);
361 trace_wbt_timer(rwb
->rqos
.q
->backing_dev_info
, status
, rqd
->scale_step
,
365 * If we exceeded the latency target, step down. If we did not,
366 * step one level up. If we don't know enough to say either exceeded
367 * or ok, then don't do anything.
371 scale_down(rwb
, true);
376 case LAT_UNKNOWN_WRITES
:
378 * We started a the center step, but don't have a valid
379 * read/write sample, but we do have writes going on.
380 * Allow step to go negative, to increase write perf.
385 if (++rwb
->unknown_cnt
< RWB_UNKNOWN_BUMP
)
388 * We get here when previously scaled reduced depth, and we
389 * currently don't have a valid read/write sample. For that
390 * case, slowly return to center state (step == 0).
392 if (rqd
->scale_step
> 0)
394 else if (rqd
->scale_step
< 0)
395 scale_down(rwb
, false);
402 * Re-arm timer, if we have IO in flight
404 if (rqd
->scale_step
|| inflight
)
408 static void wbt_update_limits(struct rq_wb
*rwb
)
410 struct rq_depth
*rqd
= &rwb
->rq_depth
;
413 rqd
->scaled_max
= false;
415 rq_depth_calc_max_depth(rqd
);
421 u64
wbt_get_min_lat(struct request_queue
*q
)
423 struct rq_qos
*rqos
= wbt_rq_qos(q
);
426 return RQWB(rqos
)->min_lat_nsec
;
429 void wbt_set_min_lat(struct request_queue
*q
, u64 val
)
431 struct rq_qos
*rqos
= wbt_rq_qos(q
);
434 RQWB(rqos
)->min_lat_nsec
= val
;
435 RQWB(rqos
)->enable_state
= WBT_STATE_ON_MANUAL
;
436 wbt_update_limits(RQWB(rqos
));
440 static bool close_io(struct rq_wb
*rwb
)
442 const unsigned long now
= jiffies
;
444 return time_before(now
, rwb
->last_issue
+ HZ
/ 10) ||
445 time_before(now
, rwb
->last_comp
+ HZ
/ 10);
448 #define REQ_HIPRIO (REQ_SYNC | REQ_META | REQ_PRIO)
450 static inline unsigned int get_limit(struct rq_wb
*rwb
, unsigned long rw
)
455 * If we got disabled, just return UINT_MAX. This ensures that
456 * we'll properly inc a new IO, and dec+wakeup at the end.
458 if (!rwb_enabled(rwb
))
461 if ((rw
& REQ_OP_MASK
) == REQ_OP_DISCARD
)
462 return rwb
->wb_background
;
465 * At this point we know it's a buffered write. If this is
466 * kswapd trying to free memory, or REQ_SYNC is set, then
467 * it's WB_SYNC_ALL writeback, and we'll use the max limit for
468 * that. If the write is marked as a background write, then use
469 * the idle limit, or go to normal if we haven't had competing
472 if ((rw
& REQ_HIPRIO
) || wb_recent_wait(rwb
) || current_is_kswapd())
473 limit
= rwb
->rq_depth
.max_depth
;
474 else if ((rw
& REQ_BACKGROUND
) || close_io(rwb
)) {
476 * If less than 100ms since we completed unrelated IO,
477 * limit us to half the depth for background writeback.
479 limit
= rwb
->wb_background
;
481 limit
= rwb
->wb_normal
;
486 struct wbt_wait_data
{
488 enum wbt_flags wb_acct
;
492 static bool wbt_inflight_cb(struct rq_wait
*rqw
, void *private_data
)
494 struct wbt_wait_data
*data
= private_data
;
495 return rq_wait_inc_below(rqw
, get_limit(data
->rwb
, data
->rw
));
498 static void wbt_cleanup_cb(struct rq_wait
*rqw
, void *private_data
)
500 struct wbt_wait_data
*data
= private_data
;
501 wbt_rqw_done(data
->rwb
, rqw
, data
->wb_acct
);
505 * Block if we will exceed our limit, or if we are currently waiting for
506 * the timer to kick off queuing again.
508 static void __wbt_wait(struct rq_wb
*rwb
, enum wbt_flags wb_acct
,
511 struct rq_wait
*rqw
= get_rq_wait(rwb
, wb_acct
);
512 struct wbt_wait_data data
= {
518 rq_qos_wait(rqw
, &data
, wbt_inflight_cb
, wbt_cleanup_cb
);
521 static inline bool wbt_should_throttle(struct rq_wb
*rwb
, struct bio
*bio
)
523 switch (bio_op(bio
)) {
526 * Don't throttle WRITE_ODIRECT
528 if ((bio
->bi_opf
& (REQ_SYNC
| REQ_IDLE
)) ==
529 (REQ_SYNC
| REQ_IDLE
))
539 static enum wbt_flags
bio_to_wbt_flags(struct rq_wb
*rwb
, struct bio
*bio
)
541 enum wbt_flags flags
= 0;
543 if (!rwb_enabled(rwb
))
546 if (bio_op(bio
) == REQ_OP_READ
) {
548 } else if (wbt_should_throttle(rwb
, bio
)) {
549 if (current_is_kswapd())
551 if (bio_op(bio
) == REQ_OP_DISCARD
)
552 flags
|= WBT_DISCARD
;
553 flags
|= WBT_TRACKED
;
558 static void wbt_cleanup(struct rq_qos
*rqos
, struct bio
*bio
)
560 struct rq_wb
*rwb
= RQWB(rqos
);
561 enum wbt_flags flags
= bio_to_wbt_flags(rwb
, bio
);
562 __wbt_done(rqos
, flags
);
566 * Returns true if the IO request should be accounted, false if not.
567 * May sleep, if we have exceeded the writeback limits. Caller can pass
568 * in an irq held spinlock, if it holds one when calling this function.
569 * If we do sleep, we'll release and re-grab it.
571 static void wbt_wait(struct rq_qos
*rqos
, struct bio
*bio
)
573 struct rq_wb
*rwb
= RQWB(rqos
);
574 enum wbt_flags flags
;
576 flags
= bio_to_wbt_flags(rwb
, bio
);
577 if (!(flags
& WBT_TRACKED
)) {
578 if (flags
& WBT_READ
)
579 wb_timestamp(rwb
, &rwb
->last_issue
);
583 __wbt_wait(rwb
, flags
, bio
->bi_opf
);
585 if (!blk_stat_is_active(rwb
->cb
))
589 static void wbt_track(struct rq_qos
*rqos
, struct request
*rq
, struct bio
*bio
)
591 struct rq_wb
*rwb
= RQWB(rqos
);
592 rq
->wbt_flags
|= bio_to_wbt_flags(rwb
, bio
);
595 static void wbt_issue(struct rq_qos
*rqos
, struct request
*rq
)
597 struct rq_wb
*rwb
= RQWB(rqos
);
599 if (!rwb_enabled(rwb
))
603 * Track sync issue, in case it takes a long time to complete. Allows us
604 * to react quicker, if a sync IO takes a long time to complete. Note
605 * that this is just a hint. The request can go away when it completes,
606 * so it's important we never dereference it. We only use the address to
607 * compare with, which is why we store the sync_issue time locally.
609 if (wbt_is_read(rq
) && !rwb
->sync_issue
) {
610 rwb
->sync_cookie
= rq
;
611 rwb
->sync_issue
= rq
->io_start_time_ns
;
615 static void wbt_requeue(struct rq_qos
*rqos
, struct request
*rq
)
617 struct rq_wb
*rwb
= RQWB(rqos
);
618 if (!rwb_enabled(rwb
))
620 if (rq
== rwb
->sync_cookie
) {
622 rwb
->sync_cookie
= NULL
;
626 void wbt_set_write_cache(struct request_queue
*q
, bool write_cache_on
)
628 struct rq_qos
*rqos
= wbt_rq_qos(q
);
630 RQWB(rqos
)->wc
= write_cache_on
;
634 * Enable wbt if defaults are configured that way
636 void wbt_enable_default(struct request_queue
*q
)
638 struct rq_qos
*rqos
= wbt_rq_qos(q
);
639 /* Throttling already enabled? */
643 /* Queue not registered? Maybe shutting down... */
644 if (!blk_queue_registered(q
))
647 if (queue_is_mq(q
) && IS_ENABLED(CONFIG_BLK_WBT_MQ
))
650 EXPORT_SYMBOL_GPL(wbt_enable_default
);
652 u64
wbt_default_latency_nsec(struct request_queue
*q
)
655 * We default to 2msec for non-rotational storage, and 75msec
656 * for rotational storage.
658 if (blk_queue_nonrot(q
))
664 static int wbt_data_dir(const struct request
*rq
)
666 const int op
= req_op(rq
);
668 if (op
== REQ_OP_READ
)
670 else if (op_is_write(op
))
677 static void wbt_queue_depth_changed(struct rq_qos
*rqos
)
679 RQWB(rqos
)->rq_depth
.queue_depth
= blk_queue_depth(rqos
->q
);
680 wbt_update_limits(RQWB(rqos
));
683 static void wbt_exit(struct rq_qos
*rqos
)
685 struct rq_wb
*rwb
= RQWB(rqos
);
686 struct request_queue
*q
= rqos
->q
;
688 blk_stat_remove_callback(q
, rwb
->cb
);
689 blk_stat_free_callback(rwb
->cb
);
694 * Disable wbt, if enabled by default.
696 void wbt_disable_default(struct request_queue
*q
)
698 struct rq_qos
*rqos
= wbt_rq_qos(q
);
703 if (rwb
->enable_state
== WBT_STATE_ON_DEFAULT
) {
704 blk_stat_deactivate(rwb
->cb
);
708 EXPORT_SYMBOL_GPL(wbt_disable_default
);
710 #ifdef CONFIG_BLK_DEBUG_FS
711 static int wbt_curr_win_nsec_show(void *data
, struct seq_file
*m
)
713 struct rq_qos
*rqos
= data
;
714 struct rq_wb
*rwb
= RQWB(rqos
);
716 seq_printf(m
, "%llu\n", rwb
->cur_win_nsec
);
720 static int wbt_enabled_show(void *data
, struct seq_file
*m
)
722 struct rq_qos
*rqos
= data
;
723 struct rq_wb
*rwb
= RQWB(rqos
);
725 seq_printf(m
, "%d\n", rwb
->enable_state
);
729 static int wbt_id_show(void *data
, struct seq_file
*m
)
731 struct rq_qos
*rqos
= data
;
733 seq_printf(m
, "%u\n", rqos
->id
);
737 static int wbt_inflight_show(void *data
, struct seq_file
*m
)
739 struct rq_qos
*rqos
= data
;
740 struct rq_wb
*rwb
= RQWB(rqos
);
743 for (i
= 0; i
< WBT_NUM_RWQ
; i
++)
744 seq_printf(m
, "%d: inflight %d\n", i
,
745 atomic_read(&rwb
->rq_wait
[i
].inflight
));
749 static int wbt_min_lat_nsec_show(void *data
, struct seq_file
*m
)
751 struct rq_qos
*rqos
= data
;
752 struct rq_wb
*rwb
= RQWB(rqos
);
754 seq_printf(m
, "%lu\n", rwb
->min_lat_nsec
);
758 static int wbt_unknown_cnt_show(void *data
, struct seq_file
*m
)
760 struct rq_qos
*rqos
= data
;
761 struct rq_wb
*rwb
= RQWB(rqos
);
763 seq_printf(m
, "%u\n", rwb
->unknown_cnt
);
767 static int wbt_normal_show(void *data
, struct seq_file
*m
)
769 struct rq_qos
*rqos
= data
;
770 struct rq_wb
*rwb
= RQWB(rqos
);
772 seq_printf(m
, "%u\n", rwb
->wb_normal
);
776 static int wbt_background_show(void *data
, struct seq_file
*m
)
778 struct rq_qos
*rqos
= data
;
779 struct rq_wb
*rwb
= RQWB(rqos
);
781 seq_printf(m
, "%u\n", rwb
->wb_background
);
785 static const struct blk_mq_debugfs_attr wbt_debugfs_attrs
[] = {
786 {"curr_win_nsec", 0400, wbt_curr_win_nsec_show
},
787 {"enabled", 0400, wbt_enabled_show
},
788 {"id", 0400, wbt_id_show
},
789 {"inflight", 0400, wbt_inflight_show
},
790 {"min_lat_nsec", 0400, wbt_min_lat_nsec_show
},
791 {"unknown_cnt", 0400, wbt_unknown_cnt_show
},
792 {"wb_normal", 0400, wbt_normal_show
},
793 {"wb_background", 0400, wbt_background_show
},
798 static struct rq_qos_ops wbt_rqos_ops
= {
799 .throttle
= wbt_wait
,
802 .requeue
= wbt_requeue
,
804 .cleanup
= wbt_cleanup
,
805 .queue_depth_changed
= wbt_queue_depth_changed
,
807 #ifdef CONFIG_BLK_DEBUG_FS
808 .debugfs_attrs
= wbt_debugfs_attrs
,
812 int wbt_init(struct request_queue
*q
)
817 rwb
= kzalloc(sizeof(*rwb
), GFP_KERNEL
);
821 rwb
->cb
= blk_stat_alloc_callback(wb_timer_fn
, wbt_data_dir
, 2, rwb
);
827 for (i
= 0; i
< WBT_NUM_RWQ
; i
++)
828 rq_wait_init(&rwb
->rq_wait
[i
]);
830 rwb
->rqos
.id
= RQ_QOS_WBT
;
831 rwb
->rqos
.ops
= &wbt_rqos_ops
;
833 rwb
->last_comp
= rwb
->last_issue
= jiffies
;
834 rwb
->win_nsec
= RWB_WINDOW_NSEC
;
835 rwb
->enable_state
= WBT_STATE_ON_DEFAULT
;
837 rwb
->rq_depth
.default_depth
= RWB_DEF_DEPTH
;
840 * Assign rwb and add the stats callback.
842 rq_qos_add(q
, &rwb
->rqos
);
843 blk_stat_add_callback(q
, rwb
->cb
);
845 rwb
->min_lat_nsec
= wbt_default_latency_nsec(q
);
847 wbt_queue_depth_changed(&rwb
->rqos
);
848 wbt_set_write_cache(q
, test_bit(QUEUE_FLAG_WC
, &q
->queue_flags
));