Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * The Kyber I/O scheduler. Controls latency by throttling queue depths using
4 * scalable techniques.
5 *
6 * Copyright (C) 2017 Facebook
7 */
8
9#include <linux/kernel.h>
10#include <linux/blkdev.h>
11#include <linux/blk-mq.h>
12#include <linux/module.h>
13#include <linux/sbitmap.h>
14
15#include <trace/events/block.h>
16
17#include "elevator.h"
18#include "blk.h"
19#include "blk-mq.h"
20#include "blk-mq-debugfs.h"
21#include "blk-mq-sched.h"
22#include "blk-mq-tag.h"
23
24#define CREATE_TRACE_POINTS
25#include <trace/events/kyber.h>
26
27/*
28 * Scheduling domains: the device is divided into multiple domains based on the
29 * request type.
30 */
31enum {
32 KYBER_READ,
33 KYBER_WRITE,
34 KYBER_DISCARD,
35 KYBER_OTHER,
36 KYBER_NUM_DOMAINS,
37};
38
39static const char *kyber_domain_names[] = {
40 [KYBER_READ] = "READ",
41 [KYBER_WRITE] = "WRITE",
42 [KYBER_DISCARD] = "DISCARD",
43 [KYBER_OTHER] = "OTHER",
44};
45
46enum {
47 /*
48 * In order to prevent starvation of synchronous requests by a flood of
49 * asynchronous requests, we reserve 25% of requests for synchronous
50 * operations.
51 */
52 KYBER_ASYNC_PERCENT = 75,
53};
54
55/*
56 * Maximum device-wide depth for each scheduling domain.
57 *
58 * Even for fast devices with lots of tags like NVMe, you can saturate the
59 * device with only a fraction of the maximum possible queue depth. So, we cap
60 * these to a reasonable value.
61 */
62static const unsigned int kyber_depth[] = {
63 [KYBER_READ] = 256,
64 [KYBER_WRITE] = 128,
65 [KYBER_DISCARD] = 64,
66 [KYBER_OTHER] = 16,
67};
68
69/*
70 * Default latency targets for each scheduling domain.
71 */
72static const u64 kyber_latency_targets[] = {
73 [KYBER_READ] = 2ULL * NSEC_PER_MSEC,
74 [KYBER_WRITE] = 10ULL * NSEC_PER_MSEC,
75 [KYBER_DISCARD] = 5ULL * NSEC_PER_SEC,
76};
77
78/*
79 * Batch size (number of requests we'll dispatch in a row) for each scheduling
80 * domain.
81 */
82static const unsigned int kyber_batch_size[] = {
83 [KYBER_READ] = 16,
84 [KYBER_WRITE] = 8,
85 [KYBER_DISCARD] = 1,
86 [KYBER_OTHER] = 1,
87};
88
89/*
90 * Requests latencies are recorded in a histogram with buckets defined relative
91 * to the target latency:
92 *
93 * <= 1/4 * target latency
94 * <= 1/2 * target latency
95 * <= 3/4 * target latency
96 * <= target latency
97 * <= 1 1/4 * target latency
98 * <= 1 1/2 * target latency
99 * <= 1 3/4 * target latency
100 * > 1 3/4 * target latency
101 */
102enum {
103 /*
104 * The width of the latency histogram buckets is
105 * 1 / (1 << KYBER_LATENCY_SHIFT) * target latency.
106 */
107 KYBER_LATENCY_SHIFT = 2,
108 /*
109 * The first (1 << KYBER_LATENCY_SHIFT) buckets are <= target latency,
110 * thus, "good".
111 */
112 KYBER_GOOD_BUCKETS = 1 << KYBER_LATENCY_SHIFT,
113 /* There are also (1 << KYBER_LATENCY_SHIFT) "bad" buckets. */
114 KYBER_LATENCY_BUCKETS = 2 << KYBER_LATENCY_SHIFT,
115};
116
117/*
118 * We measure both the total latency and the I/O latency (i.e., latency after
119 * submitting to the device).
120 */
121enum {
122 KYBER_TOTAL_LATENCY,
123 KYBER_IO_LATENCY,
124};
125
126static const char *kyber_latency_type_names[] = {
127 [KYBER_TOTAL_LATENCY] = "total",
128 [KYBER_IO_LATENCY] = "I/O",
129};
130
131/*
132 * Per-cpu latency histograms: total latency and I/O latency for each scheduling
133 * domain except for KYBER_OTHER.
134 */
135struct kyber_cpu_latency {
136 atomic_t buckets[KYBER_OTHER][2][KYBER_LATENCY_BUCKETS];
137};
138
139/*
140 * There is a same mapping between ctx & hctx and kcq & khd,
141 * we use request->mq_ctx->index_hw to index the kcq in khd.
142 */
143struct kyber_ctx_queue {
144 /*
145 * Used to ensure operations on rq_list and kcq_map to be an atmoic one.
146 * Also protect the rqs on rq_list when merge.
147 */
148 spinlock_t lock;
149 struct list_head rq_list[KYBER_NUM_DOMAINS];
150} ____cacheline_aligned_in_smp;
151
152struct kyber_queue_data {
153 struct request_queue *q;
154 dev_t dev;
155
156 /*
157 * Each scheduling domain has a limited number of in-flight requests
158 * device-wide, limited by these tokens.
159 */
160 struct sbitmap_queue domain_tokens[KYBER_NUM_DOMAINS];
161
162 /*
163 * Async request percentage, converted to per-word depth for
164 * sbitmap_get_shallow().
165 */
166 unsigned int async_depth;
167
168 struct kyber_cpu_latency __percpu *cpu_latency;
169
170 /* Timer for stats aggregation and adjusting domain tokens. */
171 struct timer_list timer;
172
173 unsigned int latency_buckets[KYBER_OTHER][2][KYBER_LATENCY_BUCKETS];
174
175 unsigned long latency_timeout[KYBER_OTHER];
176
177 int domain_p99[KYBER_OTHER];
178
179 /* Target latencies in nanoseconds. */
180 u64 latency_targets[KYBER_OTHER];
181};
182
183struct kyber_hctx_data {
184 spinlock_t lock;
185 struct list_head rqs[KYBER_NUM_DOMAINS];
186 unsigned int cur_domain;
187 unsigned int batching;
188 struct kyber_ctx_queue *kcqs;
189 struct sbitmap kcq_map[KYBER_NUM_DOMAINS];
190 struct sbq_wait domain_wait[KYBER_NUM_DOMAINS];
191 struct sbq_wait_state *domain_ws[KYBER_NUM_DOMAINS];
192 atomic_t wait_index[KYBER_NUM_DOMAINS];
193};
194
195static int kyber_domain_wake(wait_queue_entry_t *wait, unsigned mode, int flags,
196 void *key);
197
198static unsigned int kyber_sched_domain(blk_opf_t opf)
199{
200 switch (opf & REQ_OP_MASK) {
201 case REQ_OP_READ:
202 return KYBER_READ;
203 case REQ_OP_WRITE:
204 return KYBER_WRITE;
205 case REQ_OP_DISCARD:
206 return KYBER_DISCARD;
207 default:
208 return KYBER_OTHER;
209 }
210}
211
212static void flush_latency_buckets(struct kyber_queue_data *kqd,
213 struct kyber_cpu_latency *cpu_latency,
214 unsigned int sched_domain, unsigned int type)
215{
216 unsigned int *buckets = kqd->latency_buckets[sched_domain][type];
217 atomic_t *cpu_buckets = cpu_latency->buckets[sched_domain][type];
218 unsigned int bucket;
219
220 for (bucket = 0; bucket < KYBER_LATENCY_BUCKETS; bucket++)
221 buckets[bucket] += atomic_xchg(&cpu_buckets[bucket], 0);
222}
223
224/*
225 * Calculate the histogram bucket with the given percentile rank, or -1 if there
226 * aren't enough samples yet.
227 */
228static int calculate_percentile(struct kyber_queue_data *kqd,
229 unsigned int sched_domain, unsigned int type,
230 unsigned int percentile)
231{
232 unsigned int *buckets = kqd->latency_buckets[sched_domain][type];
233 unsigned int bucket, samples = 0, percentile_samples;
234
235 for (bucket = 0; bucket < KYBER_LATENCY_BUCKETS; bucket++)
236 samples += buckets[bucket];
237
238 if (!samples)
239 return -1;
240
241 /*
242 * We do the calculation once we have 500 samples or one second passes
243 * since the first sample was recorded, whichever comes first.
244 */
245 if (!kqd->latency_timeout[sched_domain])
246 kqd->latency_timeout[sched_domain] = max(jiffies + HZ, 1UL);
247 if (samples < 500 &&
248 time_is_after_jiffies(kqd->latency_timeout[sched_domain])) {
249 return -1;
250 }
251 kqd->latency_timeout[sched_domain] = 0;
252
253 percentile_samples = DIV_ROUND_UP(samples * percentile, 100);
254 for (bucket = 0; bucket < KYBER_LATENCY_BUCKETS - 1; bucket++) {
255 if (buckets[bucket] >= percentile_samples)
256 break;
257 percentile_samples -= buckets[bucket];
258 }
259 memset(buckets, 0, sizeof(kqd->latency_buckets[sched_domain][type]));
260
261 trace_kyber_latency(kqd->dev, kyber_domain_names[sched_domain],
262 kyber_latency_type_names[type], percentile,
263 bucket + 1, 1 << KYBER_LATENCY_SHIFT, samples);
264
265 return bucket;
266}
267
268static void kyber_resize_domain(struct kyber_queue_data *kqd,
269 unsigned int sched_domain, unsigned int depth)
270{
271 depth = clamp(depth, 1U, kyber_depth[sched_domain]);
272 if (depth != kqd->domain_tokens[sched_domain].sb.depth) {
273 sbitmap_queue_resize(&kqd->domain_tokens[sched_domain], depth);
274 trace_kyber_adjust(kqd->dev, kyber_domain_names[sched_domain],
275 depth);
276 }
277}
278
279static void kyber_timer_fn(struct timer_list *t)
280{
281 struct kyber_queue_data *kqd = from_timer(kqd, t, timer);
282 unsigned int sched_domain;
283 int cpu;
284 bool bad = false;
285
286 /* Sum all of the per-cpu latency histograms. */
287 for_each_online_cpu(cpu) {
288 struct kyber_cpu_latency *cpu_latency;
289
290 cpu_latency = per_cpu_ptr(kqd->cpu_latency, cpu);
291 for (sched_domain = 0; sched_domain < KYBER_OTHER; sched_domain++) {
292 flush_latency_buckets(kqd, cpu_latency, sched_domain,
293 KYBER_TOTAL_LATENCY);
294 flush_latency_buckets(kqd, cpu_latency, sched_domain,
295 KYBER_IO_LATENCY);
296 }
297 }
298
299 /*
300 * Check if any domains have a high I/O latency, which might indicate
301 * congestion in the device. Note that we use the p90; we don't want to
302 * be too sensitive to outliers here.
303 */
304 for (sched_domain = 0; sched_domain < KYBER_OTHER; sched_domain++) {
305 int p90;
306
307 p90 = calculate_percentile(kqd, sched_domain, KYBER_IO_LATENCY,
308 90);
309 if (p90 >= KYBER_GOOD_BUCKETS)
310 bad = true;
311 }
312
313 /*
314 * Adjust the scheduling domain depths. If we determined that there was
315 * congestion, we throttle all domains with good latencies. Either way,
316 * we ease up on throttling domains with bad latencies.
317 */
318 for (sched_domain = 0; sched_domain < KYBER_OTHER; sched_domain++) {
319 unsigned int orig_depth, depth;
320 int p99;
321
322 p99 = calculate_percentile(kqd, sched_domain,
323 KYBER_TOTAL_LATENCY, 99);
324 /*
325 * This is kind of subtle: different domains will not
326 * necessarily have enough samples to calculate the latency
327 * percentiles during the same window, so we have to remember
328 * the p99 for the next time we observe congestion; once we do,
329 * we don't want to throttle again until we get more data, so we
330 * reset it to -1.
331 */
332 if (bad) {
333 if (p99 < 0)
334 p99 = kqd->domain_p99[sched_domain];
335 kqd->domain_p99[sched_domain] = -1;
336 } else if (p99 >= 0) {
337 kqd->domain_p99[sched_domain] = p99;
338 }
339 if (p99 < 0)
340 continue;
341
342 /*
343 * If this domain has bad latency, throttle less. Otherwise,
344 * throttle more iff we determined that there is congestion.
345 *
346 * The new depth is scaled linearly with the p99 latency vs the
347 * latency target. E.g., if the p99 is 3/4 of the target, then
348 * we throttle down to 3/4 of the current depth, and if the p99
349 * is 2x the target, then we double the depth.
350 */
351 if (bad || p99 >= KYBER_GOOD_BUCKETS) {
352 orig_depth = kqd->domain_tokens[sched_domain].sb.depth;
353 depth = (orig_depth * (p99 + 1)) >> KYBER_LATENCY_SHIFT;
354 kyber_resize_domain(kqd, sched_domain, depth);
355 }
356 }
357}
358
359static struct kyber_queue_data *kyber_queue_data_alloc(struct request_queue *q)
360{
361 struct kyber_queue_data *kqd;
362 int ret = -ENOMEM;
363 int i;
364
365 kqd = kzalloc_node(sizeof(*kqd), GFP_KERNEL, q->node);
366 if (!kqd)
367 goto err;
368
369 kqd->q = q;
370 kqd->dev = disk_devt(q->disk);
371
372 kqd->cpu_latency = alloc_percpu_gfp(struct kyber_cpu_latency,
373 GFP_KERNEL | __GFP_ZERO);
374 if (!kqd->cpu_latency)
375 goto err_kqd;
376
377 timer_setup(&kqd->timer, kyber_timer_fn, 0);
378
379 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
380 WARN_ON(!kyber_depth[i]);
381 WARN_ON(!kyber_batch_size[i]);
382 ret = sbitmap_queue_init_node(&kqd->domain_tokens[i],
383 kyber_depth[i], -1, false,
384 GFP_KERNEL, q->node);
385 if (ret) {
386 while (--i >= 0)
387 sbitmap_queue_free(&kqd->domain_tokens[i]);
388 goto err_buckets;
389 }
390 }
391
392 for (i = 0; i < KYBER_OTHER; i++) {
393 kqd->domain_p99[i] = -1;
394 kqd->latency_targets[i] = kyber_latency_targets[i];
395 }
396
397 return kqd;
398
399err_buckets:
400 free_percpu(kqd->cpu_latency);
401err_kqd:
402 kfree(kqd);
403err:
404 return ERR_PTR(ret);
405}
406
407static int kyber_init_sched(struct request_queue *q, struct elevator_type *e)
408{
409 struct kyber_queue_data *kqd;
410 struct elevator_queue *eq;
411
412 eq = elevator_alloc(q, e);
413 if (!eq)
414 return -ENOMEM;
415
416 kqd = kyber_queue_data_alloc(q);
417 if (IS_ERR(kqd)) {
418 kobject_put(&eq->kobj);
419 return PTR_ERR(kqd);
420 }
421
422 blk_stat_enable_accounting(q);
423
424 blk_queue_flag_clear(QUEUE_FLAG_SQ_SCHED, q);
425
426 eq->elevator_data = kqd;
427 q->elevator = eq;
428
429 return 0;
430}
431
432static void kyber_exit_sched(struct elevator_queue *e)
433{
434 struct kyber_queue_data *kqd = e->elevator_data;
435 int i;
436
437 timer_shutdown_sync(&kqd->timer);
438 blk_stat_disable_accounting(kqd->q);
439
440 for (i = 0; i < KYBER_NUM_DOMAINS; i++)
441 sbitmap_queue_free(&kqd->domain_tokens[i]);
442 free_percpu(kqd->cpu_latency);
443 kfree(kqd);
444}
445
446static void kyber_ctx_queue_init(struct kyber_ctx_queue *kcq)
447{
448 unsigned int i;
449
450 spin_lock_init(&kcq->lock);
451 for (i = 0; i < KYBER_NUM_DOMAINS; i++)
452 INIT_LIST_HEAD(&kcq->rq_list[i]);
453}
454
455static void kyber_depth_updated(struct blk_mq_hw_ctx *hctx)
456{
457 struct kyber_queue_data *kqd = hctx->queue->elevator->elevator_data;
458 struct blk_mq_tags *tags = hctx->sched_tags;
459 unsigned int shift = tags->bitmap_tags.sb.shift;
460
461 kqd->async_depth = (1U << shift) * KYBER_ASYNC_PERCENT / 100U;
462
463 sbitmap_queue_min_shallow_depth(&tags->bitmap_tags, kqd->async_depth);
464}
465
466static int kyber_init_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
467{
468 struct kyber_hctx_data *khd;
469 int i;
470
471 khd = kmalloc_node(sizeof(*khd), GFP_KERNEL, hctx->numa_node);
472 if (!khd)
473 return -ENOMEM;
474
475 khd->kcqs = kmalloc_array_node(hctx->nr_ctx,
476 sizeof(struct kyber_ctx_queue),
477 GFP_KERNEL, hctx->numa_node);
478 if (!khd->kcqs)
479 goto err_khd;
480
481 for (i = 0; i < hctx->nr_ctx; i++)
482 kyber_ctx_queue_init(&khd->kcqs[i]);
483
484 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
485 if (sbitmap_init_node(&khd->kcq_map[i], hctx->nr_ctx,
486 ilog2(8), GFP_KERNEL, hctx->numa_node,
487 false, false)) {
488 while (--i >= 0)
489 sbitmap_free(&khd->kcq_map[i]);
490 goto err_kcqs;
491 }
492 }
493
494 spin_lock_init(&khd->lock);
495
496 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
497 INIT_LIST_HEAD(&khd->rqs[i]);
498 khd->domain_wait[i].sbq = NULL;
499 init_waitqueue_func_entry(&khd->domain_wait[i].wait,
500 kyber_domain_wake);
501 khd->domain_wait[i].wait.private = hctx;
502 INIT_LIST_HEAD(&khd->domain_wait[i].wait.entry);
503 atomic_set(&khd->wait_index[i], 0);
504 }
505
506 khd->cur_domain = 0;
507 khd->batching = 0;
508
509 hctx->sched_data = khd;
510 kyber_depth_updated(hctx);
511
512 return 0;
513
514err_kcqs:
515 kfree(khd->kcqs);
516err_khd:
517 kfree(khd);
518 return -ENOMEM;
519}
520
521static void kyber_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
522{
523 struct kyber_hctx_data *khd = hctx->sched_data;
524 int i;
525
526 for (i = 0; i < KYBER_NUM_DOMAINS; i++)
527 sbitmap_free(&khd->kcq_map[i]);
528 kfree(khd->kcqs);
529 kfree(hctx->sched_data);
530}
531
532static int rq_get_domain_token(struct request *rq)
533{
534 return (long)rq->elv.priv[0];
535}
536
537static void rq_set_domain_token(struct request *rq, int token)
538{
539 rq->elv.priv[0] = (void *)(long)token;
540}
541
542static void rq_clear_domain_token(struct kyber_queue_data *kqd,
543 struct request *rq)
544{
545 unsigned int sched_domain;
546 int nr;
547
548 nr = rq_get_domain_token(rq);
549 if (nr != -1) {
550 sched_domain = kyber_sched_domain(rq->cmd_flags);
551 sbitmap_queue_clear(&kqd->domain_tokens[sched_domain], nr,
552 rq->mq_ctx->cpu);
553 }
554}
555
556static void kyber_limit_depth(blk_opf_t opf, struct blk_mq_alloc_data *data)
557{
558 /*
559 * We use the scheduler tags as per-hardware queue queueing tokens.
560 * Async requests can be limited at this stage.
561 */
562 if (!op_is_sync(opf)) {
563 struct kyber_queue_data *kqd = data->q->elevator->elevator_data;
564
565 data->shallow_depth = kqd->async_depth;
566 }
567}
568
569static bool kyber_bio_merge(struct request_queue *q, struct bio *bio,
570 unsigned int nr_segs)
571{
572 struct blk_mq_ctx *ctx = blk_mq_get_ctx(q);
573 struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, bio->bi_opf, ctx);
574 struct kyber_hctx_data *khd = hctx->sched_data;
575 struct kyber_ctx_queue *kcq = &khd->kcqs[ctx->index_hw[hctx->type]];
576 unsigned int sched_domain = kyber_sched_domain(bio->bi_opf);
577 struct list_head *rq_list = &kcq->rq_list[sched_domain];
578 bool merged;
579
580 spin_lock(&kcq->lock);
581 merged = blk_bio_list_merge(hctx->queue, rq_list, bio, nr_segs);
582 spin_unlock(&kcq->lock);
583
584 return merged;
585}
586
587static void kyber_prepare_request(struct request *rq)
588{
589 rq_set_domain_token(rq, -1);
590}
591
592static void kyber_insert_requests(struct blk_mq_hw_ctx *hctx,
593 struct list_head *rq_list, bool at_head)
594{
595 struct kyber_hctx_data *khd = hctx->sched_data;
596 struct request *rq, *next;
597
598 list_for_each_entry_safe(rq, next, rq_list, queuelist) {
599 unsigned int sched_domain = kyber_sched_domain(rq->cmd_flags);
600 struct kyber_ctx_queue *kcq = &khd->kcqs[rq->mq_ctx->index_hw[hctx->type]];
601 struct list_head *head = &kcq->rq_list[sched_domain];
602
603 spin_lock(&kcq->lock);
604 trace_block_rq_insert(rq);
605 if (at_head)
606 list_move(&rq->queuelist, head);
607 else
608 list_move_tail(&rq->queuelist, head);
609 sbitmap_set_bit(&khd->kcq_map[sched_domain],
610 rq->mq_ctx->index_hw[hctx->type]);
611 spin_unlock(&kcq->lock);
612 }
613}
614
615static void kyber_finish_request(struct request *rq)
616{
617 struct kyber_queue_data *kqd = rq->q->elevator->elevator_data;
618
619 rq_clear_domain_token(kqd, rq);
620}
621
622static void add_latency_sample(struct kyber_cpu_latency *cpu_latency,
623 unsigned int sched_domain, unsigned int type,
624 u64 target, u64 latency)
625{
626 unsigned int bucket;
627 u64 divisor;
628
629 if (latency > 0) {
630 divisor = max_t(u64, target >> KYBER_LATENCY_SHIFT, 1);
631 bucket = min_t(unsigned int, div64_u64(latency - 1, divisor),
632 KYBER_LATENCY_BUCKETS - 1);
633 } else {
634 bucket = 0;
635 }
636
637 atomic_inc(&cpu_latency->buckets[sched_domain][type][bucket]);
638}
639
640static void kyber_completed_request(struct request *rq, u64 now)
641{
642 struct kyber_queue_data *kqd = rq->q->elevator->elevator_data;
643 struct kyber_cpu_latency *cpu_latency;
644 unsigned int sched_domain;
645 u64 target;
646
647 sched_domain = kyber_sched_domain(rq->cmd_flags);
648 if (sched_domain == KYBER_OTHER)
649 return;
650
651 cpu_latency = get_cpu_ptr(kqd->cpu_latency);
652 target = kqd->latency_targets[sched_domain];
653 add_latency_sample(cpu_latency, sched_domain, KYBER_TOTAL_LATENCY,
654 target, now - rq->start_time_ns);
655 add_latency_sample(cpu_latency, sched_domain, KYBER_IO_LATENCY, target,
656 now - rq->io_start_time_ns);
657 put_cpu_ptr(kqd->cpu_latency);
658
659 timer_reduce(&kqd->timer, jiffies + HZ / 10);
660}
661
662struct flush_kcq_data {
663 struct kyber_hctx_data *khd;
664 unsigned int sched_domain;
665 struct list_head *list;
666};
667
668static bool flush_busy_kcq(struct sbitmap *sb, unsigned int bitnr, void *data)
669{
670 struct flush_kcq_data *flush_data = data;
671 struct kyber_ctx_queue *kcq = &flush_data->khd->kcqs[bitnr];
672
673 spin_lock(&kcq->lock);
674 list_splice_tail_init(&kcq->rq_list[flush_data->sched_domain],
675 flush_data->list);
676 sbitmap_clear_bit(sb, bitnr);
677 spin_unlock(&kcq->lock);
678
679 return true;
680}
681
682static void kyber_flush_busy_kcqs(struct kyber_hctx_data *khd,
683 unsigned int sched_domain,
684 struct list_head *list)
685{
686 struct flush_kcq_data data = {
687 .khd = khd,
688 .sched_domain = sched_domain,
689 .list = list,
690 };
691
692 sbitmap_for_each_set(&khd->kcq_map[sched_domain],
693 flush_busy_kcq, &data);
694}
695
696static int kyber_domain_wake(wait_queue_entry_t *wqe, unsigned mode, int flags,
697 void *key)
698{
699 struct blk_mq_hw_ctx *hctx = READ_ONCE(wqe->private);
700 struct sbq_wait *wait = container_of(wqe, struct sbq_wait, wait);
701
702 sbitmap_del_wait_queue(wait);
703 blk_mq_run_hw_queue(hctx, true);
704 return 1;
705}
706
707static int kyber_get_domain_token(struct kyber_queue_data *kqd,
708 struct kyber_hctx_data *khd,
709 struct blk_mq_hw_ctx *hctx)
710{
711 unsigned int sched_domain = khd->cur_domain;
712 struct sbitmap_queue *domain_tokens = &kqd->domain_tokens[sched_domain];
713 struct sbq_wait *wait = &khd->domain_wait[sched_domain];
714 struct sbq_wait_state *ws;
715 int nr;
716
717 nr = __sbitmap_queue_get(domain_tokens);
718
719 /*
720 * If we failed to get a domain token, make sure the hardware queue is
721 * run when one becomes available. Note that this is serialized on
722 * khd->lock, but we still need to be careful about the waker.
723 */
724 if (nr < 0 && list_empty_careful(&wait->wait.entry)) {
725 ws = sbq_wait_ptr(domain_tokens,
726 &khd->wait_index[sched_domain]);
727 khd->domain_ws[sched_domain] = ws;
728 sbitmap_add_wait_queue(domain_tokens, ws, wait);
729
730 /*
731 * Try again in case a token was freed before we got on the wait
732 * queue.
733 */
734 nr = __sbitmap_queue_get(domain_tokens);
735 }
736
737 /*
738 * If we got a token while we were on the wait queue, remove ourselves
739 * from the wait queue to ensure that all wake ups make forward
740 * progress. It's possible that the waker already deleted the entry
741 * between the !list_empty_careful() check and us grabbing the lock, but
742 * list_del_init() is okay with that.
743 */
744 if (nr >= 0 && !list_empty_careful(&wait->wait.entry)) {
745 ws = khd->domain_ws[sched_domain];
746 spin_lock_irq(&ws->wait.lock);
747 sbitmap_del_wait_queue(wait);
748 spin_unlock_irq(&ws->wait.lock);
749 }
750
751 return nr;
752}
753
754static struct request *
755kyber_dispatch_cur_domain(struct kyber_queue_data *kqd,
756 struct kyber_hctx_data *khd,
757 struct blk_mq_hw_ctx *hctx)
758{
759 struct list_head *rqs;
760 struct request *rq;
761 int nr;
762
763 rqs = &khd->rqs[khd->cur_domain];
764
765 /*
766 * If we already have a flushed request, then we just need to get a
767 * token for it. Otherwise, if there are pending requests in the kcqs,
768 * flush the kcqs, but only if we can get a token. If not, we should
769 * leave the requests in the kcqs so that they can be merged. Note that
770 * khd->lock serializes the flushes, so if we observed any bit set in
771 * the kcq_map, we will always get a request.
772 */
773 rq = list_first_entry_or_null(rqs, struct request, queuelist);
774 if (rq) {
775 nr = kyber_get_domain_token(kqd, khd, hctx);
776 if (nr >= 0) {
777 khd->batching++;
778 rq_set_domain_token(rq, nr);
779 list_del_init(&rq->queuelist);
780 return rq;
781 } else {
782 trace_kyber_throttled(kqd->dev,
783 kyber_domain_names[khd->cur_domain]);
784 }
785 } else if (sbitmap_any_bit_set(&khd->kcq_map[khd->cur_domain])) {
786 nr = kyber_get_domain_token(kqd, khd, hctx);
787 if (nr >= 0) {
788 kyber_flush_busy_kcqs(khd, khd->cur_domain, rqs);
789 rq = list_first_entry(rqs, struct request, queuelist);
790 khd->batching++;
791 rq_set_domain_token(rq, nr);
792 list_del_init(&rq->queuelist);
793 return rq;
794 } else {
795 trace_kyber_throttled(kqd->dev,
796 kyber_domain_names[khd->cur_domain]);
797 }
798 }
799
800 /* There were either no pending requests or no tokens. */
801 return NULL;
802}
803
804static struct request *kyber_dispatch_request(struct blk_mq_hw_ctx *hctx)
805{
806 struct kyber_queue_data *kqd = hctx->queue->elevator->elevator_data;
807 struct kyber_hctx_data *khd = hctx->sched_data;
808 struct request *rq;
809 int i;
810
811 spin_lock(&khd->lock);
812
813 /*
814 * First, if we are still entitled to batch, try to dispatch a request
815 * from the batch.
816 */
817 if (khd->batching < kyber_batch_size[khd->cur_domain]) {
818 rq = kyber_dispatch_cur_domain(kqd, khd, hctx);
819 if (rq)
820 goto out;
821 }
822
823 /*
824 * Either,
825 * 1. We were no longer entitled to a batch.
826 * 2. The domain we were batching didn't have any requests.
827 * 3. The domain we were batching was out of tokens.
828 *
829 * Start another batch. Note that this wraps back around to the original
830 * domain if no other domains have requests or tokens.
831 */
832 khd->batching = 0;
833 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
834 if (khd->cur_domain == KYBER_NUM_DOMAINS - 1)
835 khd->cur_domain = 0;
836 else
837 khd->cur_domain++;
838
839 rq = kyber_dispatch_cur_domain(kqd, khd, hctx);
840 if (rq)
841 goto out;
842 }
843
844 rq = NULL;
845out:
846 spin_unlock(&khd->lock);
847 return rq;
848}
849
850static bool kyber_has_work(struct blk_mq_hw_ctx *hctx)
851{
852 struct kyber_hctx_data *khd = hctx->sched_data;
853 int i;
854
855 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
856 if (!list_empty_careful(&khd->rqs[i]) ||
857 sbitmap_any_bit_set(&khd->kcq_map[i]))
858 return true;
859 }
860
861 return false;
862}
863
864#define KYBER_LAT_SHOW_STORE(domain, name) \
865static ssize_t kyber_##name##_lat_show(struct elevator_queue *e, \
866 char *page) \
867{ \
868 struct kyber_queue_data *kqd = e->elevator_data; \
869 \
870 return sprintf(page, "%llu\n", kqd->latency_targets[domain]); \
871} \
872 \
873static ssize_t kyber_##name##_lat_store(struct elevator_queue *e, \
874 const char *page, size_t count) \
875{ \
876 struct kyber_queue_data *kqd = e->elevator_data; \
877 unsigned long long nsec; \
878 int ret; \
879 \
880 ret = kstrtoull(page, 10, &nsec); \
881 if (ret) \
882 return ret; \
883 \
884 kqd->latency_targets[domain] = nsec; \
885 \
886 return count; \
887}
888KYBER_LAT_SHOW_STORE(KYBER_READ, read);
889KYBER_LAT_SHOW_STORE(KYBER_WRITE, write);
890#undef KYBER_LAT_SHOW_STORE
891
892#define KYBER_LAT_ATTR(op) __ATTR(op##_lat_nsec, 0644, kyber_##op##_lat_show, kyber_##op##_lat_store)
893static struct elv_fs_entry kyber_sched_attrs[] = {
894 KYBER_LAT_ATTR(read),
895 KYBER_LAT_ATTR(write),
896 __ATTR_NULL
897};
898#undef KYBER_LAT_ATTR
899
900#ifdef CONFIG_BLK_DEBUG_FS
901#define KYBER_DEBUGFS_DOMAIN_ATTRS(domain, name) \
902static int kyber_##name##_tokens_show(void *data, struct seq_file *m) \
903{ \
904 struct request_queue *q = data; \
905 struct kyber_queue_data *kqd = q->elevator->elevator_data; \
906 \
907 sbitmap_queue_show(&kqd->domain_tokens[domain], m); \
908 return 0; \
909} \
910 \
911static void *kyber_##name##_rqs_start(struct seq_file *m, loff_t *pos) \
912 __acquires(&khd->lock) \
913{ \
914 struct blk_mq_hw_ctx *hctx = m->private; \
915 struct kyber_hctx_data *khd = hctx->sched_data; \
916 \
917 spin_lock(&khd->lock); \
918 return seq_list_start(&khd->rqs[domain], *pos); \
919} \
920 \
921static void *kyber_##name##_rqs_next(struct seq_file *m, void *v, \
922 loff_t *pos) \
923{ \
924 struct blk_mq_hw_ctx *hctx = m->private; \
925 struct kyber_hctx_data *khd = hctx->sched_data; \
926 \
927 return seq_list_next(v, &khd->rqs[domain], pos); \
928} \
929 \
930static void kyber_##name##_rqs_stop(struct seq_file *m, void *v) \
931 __releases(&khd->lock) \
932{ \
933 struct blk_mq_hw_ctx *hctx = m->private; \
934 struct kyber_hctx_data *khd = hctx->sched_data; \
935 \
936 spin_unlock(&khd->lock); \
937} \
938 \
939static const struct seq_operations kyber_##name##_rqs_seq_ops = { \
940 .start = kyber_##name##_rqs_start, \
941 .next = kyber_##name##_rqs_next, \
942 .stop = kyber_##name##_rqs_stop, \
943 .show = blk_mq_debugfs_rq_show, \
944}; \
945 \
946static int kyber_##name##_waiting_show(void *data, struct seq_file *m) \
947{ \
948 struct blk_mq_hw_ctx *hctx = data; \
949 struct kyber_hctx_data *khd = hctx->sched_data; \
950 wait_queue_entry_t *wait = &khd->domain_wait[domain].wait; \
951 \
952 seq_printf(m, "%d\n", !list_empty_careful(&wait->entry)); \
953 return 0; \
954}
955KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_READ, read)
956KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_WRITE, write)
957KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_DISCARD, discard)
958KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_OTHER, other)
959#undef KYBER_DEBUGFS_DOMAIN_ATTRS
960
961static int kyber_async_depth_show(void *data, struct seq_file *m)
962{
963 struct request_queue *q = data;
964 struct kyber_queue_data *kqd = q->elevator->elevator_data;
965
966 seq_printf(m, "%u\n", kqd->async_depth);
967 return 0;
968}
969
970static int kyber_cur_domain_show(void *data, struct seq_file *m)
971{
972 struct blk_mq_hw_ctx *hctx = data;
973 struct kyber_hctx_data *khd = hctx->sched_data;
974
975 seq_printf(m, "%s\n", kyber_domain_names[khd->cur_domain]);
976 return 0;
977}
978
979static int kyber_batching_show(void *data, struct seq_file *m)
980{
981 struct blk_mq_hw_ctx *hctx = data;
982 struct kyber_hctx_data *khd = hctx->sched_data;
983
984 seq_printf(m, "%u\n", khd->batching);
985 return 0;
986}
987
988#define KYBER_QUEUE_DOMAIN_ATTRS(name) \
989 {#name "_tokens", 0400, kyber_##name##_tokens_show}
990static const struct blk_mq_debugfs_attr kyber_queue_debugfs_attrs[] = {
991 KYBER_QUEUE_DOMAIN_ATTRS(read),
992 KYBER_QUEUE_DOMAIN_ATTRS(write),
993 KYBER_QUEUE_DOMAIN_ATTRS(discard),
994 KYBER_QUEUE_DOMAIN_ATTRS(other),
995 {"async_depth", 0400, kyber_async_depth_show},
996 {},
997};
998#undef KYBER_QUEUE_DOMAIN_ATTRS
999
1000#define KYBER_HCTX_DOMAIN_ATTRS(name) \
1001 {#name "_rqs", 0400, .seq_ops = &kyber_##name##_rqs_seq_ops}, \
1002 {#name "_waiting", 0400, kyber_##name##_waiting_show}
1003static const struct blk_mq_debugfs_attr kyber_hctx_debugfs_attrs[] = {
1004 KYBER_HCTX_DOMAIN_ATTRS(read),
1005 KYBER_HCTX_DOMAIN_ATTRS(write),
1006 KYBER_HCTX_DOMAIN_ATTRS(discard),
1007 KYBER_HCTX_DOMAIN_ATTRS(other),
1008 {"cur_domain", 0400, kyber_cur_domain_show},
1009 {"batching", 0400, kyber_batching_show},
1010 {},
1011};
1012#undef KYBER_HCTX_DOMAIN_ATTRS
1013#endif
1014
1015static struct elevator_type kyber_sched = {
1016 .ops = {
1017 .init_sched = kyber_init_sched,
1018 .exit_sched = kyber_exit_sched,
1019 .init_hctx = kyber_init_hctx,
1020 .exit_hctx = kyber_exit_hctx,
1021 .limit_depth = kyber_limit_depth,
1022 .bio_merge = kyber_bio_merge,
1023 .prepare_request = kyber_prepare_request,
1024 .insert_requests = kyber_insert_requests,
1025 .finish_request = kyber_finish_request,
1026 .requeue_request = kyber_finish_request,
1027 .completed_request = kyber_completed_request,
1028 .dispatch_request = kyber_dispatch_request,
1029 .has_work = kyber_has_work,
1030 .depth_updated = kyber_depth_updated,
1031 },
1032#ifdef CONFIG_BLK_DEBUG_FS
1033 .queue_debugfs_attrs = kyber_queue_debugfs_attrs,
1034 .hctx_debugfs_attrs = kyber_hctx_debugfs_attrs,
1035#endif
1036 .elevator_attrs = kyber_sched_attrs,
1037 .elevator_name = "kyber",
1038 .elevator_owner = THIS_MODULE,
1039};
1040
1041static int __init kyber_init(void)
1042{
1043 return elv_register(&kyber_sched);
1044}
1045
1046static void __exit kyber_exit(void)
1047{
1048 elv_unregister(&kyber_sched);
1049}
1050
1051module_init(kyber_init);
1052module_exit(kyber_exit);
1053
1054MODULE_AUTHOR("Omar Sandoval");
1055MODULE_LICENSE("GPL");
1056MODULE_DESCRIPTION("Kyber I/O scheduler");
1/*
2 * The Kyber I/O scheduler. Controls latency by throttling queue depths using
3 * scalable techniques.
4 *
5 * Copyright (C) 2017 Facebook
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public
9 * License v2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#include <linux/kernel.h>
21#include <linux/blkdev.h>
22#include <linux/blk-mq.h>
23#include <linux/elevator.h>
24#include <linux/module.h>
25#include <linux/sbitmap.h>
26
27#include "blk.h"
28#include "blk-mq.h"
29#include "blk-mq-debugfs.h"
30#include "blk-mq-sched.h"
31#include "blk-mq-tag.h"
32#include "blk-stat.h"
33
34/* Scheduling domains. */
35enum {
36 KYBER_READ,
37 KYBER_SYNC_WRITE,
38 KYBER_OTHER, /* Async writes, discard, etc. */
39 KYBER_NUM_DOMAINS,
40};
41
42enum {
43 KYBER_MIN_DEPTH = 256,
44
45 /*
46 * In order to prevent starvation of synchronous requests by a flood of
47 * asynchronous requests, we reserve 25% of requests for synchronous
48 * operations.
49 */
50 KYBER_ASYNC_PERCENT = 75,
51};
52
53/*
54 * Initial device-wide depths for each scheduling domain.
55 *
56 * Even for fast devices with lots of tags like NVMe, you can saturate
57 * the device with only a fraction of the maximum possible queue depth.
58 * So, we cap these to a reasonable value.
59 */
60static const unsigned int kyber_depth[] = {
61 [KYBER_READ] = 256,
62 [KYBER_SYNC_WRITE] = 128,
63 [KYBER_OTHER] = 64,
64};
65
66/*
67 * Scheduling domain batch sizes. We favor reads.
68 */
69static const unsigned int kyber_batch_size[] = {
70 [KYBER_READ] = 16,
71 [KYBER_SYNC_WRITE] = 8,
72 [KYBER_OTHER] = 8,
73};
74
75struct kyber_queue_data {
76 struct request_queue *q;
77
78 struct blk_stat_callback *cb;
79
80 /*
81 * The device is divided into multiple scheduling domains based on the
82 * request type. Each domain has a fixed number of in-flight requests of
83 * that type device-wide, limited by these tokens.
84 */
85 struct sbitmap_queue domain_tokens[KYBER_NUM_DOMAINS];
86
87 /*
88 * Async request percentage, converted to per-word depth for
89 * sbitmap_get_shallow().
90 */
91 unsigned int async_depth;
92
93 /* Target latencies in nanoseconds. */
94 u64 read_lat_nsec, write_lat_nsec;
95};
96
97struct kyber_hctx_data {
98 spinlock_t lock;
99 struct list_head rqs[KYBER_NUM_DOMAINS];
100 unsigned int cur_domain;
101 unsigned int batching;
102 wait_queue_entry_t domain_wait[KYBER_NUM_DOMAINS];
103 struct sbq_wait_state *domain_ws[KYBER_NUM_DOMAINS];
104 atomic_t wait_index[KYBER_NUM_DOMAINS];
105};
106
107static int kyber_domain_wake(wait_queue_entry_t *wait, unsigned mode, int flags,
108 void *key);
109
110static int rq_sched_domain(const struct request *rq)
111{
112 unsigned int op = rq->cmd_flags;
113
114 if ((op & REQ_OP_MASK) == REQ_OP_READ)
115 return KYBER_READ;
116 else if ((op & REQ_OP_MASK) == REQ_OP_WRITE && op_is_sync(op))
117 return KYBER_SYNC_WRITE;
118 else
119 return KYBER_OTHER;
120}
121
122enum {
123 NONE = 0,
124 GOOD = 1,
125 GREAT = 2,
126 BAD = -1,
127 AWFUL = -2,
128};
129
130#define IS_GOOD(status) ((status) > 0)
131#define IS_BAD(status) ((status) < 0)
132
133static int kyber_lat_status(struct blk_stat_callback *cb,
134 unsigned int sched_domain, u64 target)
135{
136 u64 latency;
137
138 if (!cb->stat[sched_domain].nr_samples)
139 return NONE;
140
141 latency = cb->stat[sched_domain].mean;
142 if (latency >= 2 * target)
143 return AWFUL;
144 else if (latency > target)
145 return BAD;
146 else if (latency <= target / 2)
147 return GREAT;
148 else /* (latency <= target) */
149 return GOOD;
150}
151
152/*
153 * Adjust the read or synchronous write depth given the status of reads and
154 * writes. The goal is that the latencies of the two domains are fair (i.e., if
155 * one is good, then the other is good).
156 */
157static void kyber_adjust_rw_depth(struct kyber_queue_data *kqd,
158 unsigned int sched_domain, int this_status,
159 int other_status)
160{
161 unsigned int orig_depth, depth;
162
163 /*
164 * If this domain had no samples, or reads and writes are both good or
165 * both bad, don't adjust the depth.
166 */
167 if (this_status == NONE ||
168 (IS_GOOD(this_status) && IS_GOOD(other_status)) ||
169 (IS_BAD(this_status) && IS_BAD(other_status)))
170 return;
171
172 orig_depth = depth = kqd->domain_tokens[sched_domain].sb.depth;
173
174 if (other_status == NONE) {
175 depth++;
176 } else {
177 switch (this_status) {
178 case GOOD:
179 if (other_status == AWFUL)
180 depth -= max(depth / 4, 1U);
181 else
182 depth -= max(depth / 8, 1U);
183 break;
184 case GREAT:
185 if (other_status == AWFUL)
186 depth /= 2;
187 else
188 depth -= max(depth / 4, 1U);
189 break;
190 case BAD:
191 depth++;
192 break;
193 case AWFUL:
194 if (other_status == GREAT)
195 depth += 2;
196 else
197 depth++;
198 break;
199 }
200 }
201
202 depth = clamp(depth, 1U, kyber_depth[sched_domain]);
203 if (depth != orig_depth)
204 sbitmap_queue_resize(&kqd->domain_tokens[sched_domain], depth);
205}
206
207/*
208 * Adjust the depth of other requests given the status of reads and synchronous
209 * writes. As long as either domain is doing fine, we don't throttle, but if
210 * both domains are doing badly, we throttle heavily.
211 */
212static void kyber_adjust_other_depth(struct kyber_queue_data *kqd,
213 int read_status, int write_status,
214 bool have_samples)
215{
216 unsigned int orig_depth, depth;
217 int status;
218
219 orig_depth = depth = kqd->domain_tokens[KYBER_OTHER].sb.depth;
220
221 if (read_status == NONE && write_status == NONE) {
222 depth += 2;
223 } else if (have_samples) {
224 if (read_status == NONE)
225 status = write_status;
226 else if (write_status == NONE)
227 status = read_status;
228 else
229 status = max(read_status, write_status);
230 switch (status) {
231 case GREAT:
232 depth += 2;
233 break;
234 case GOOD:
235 depth++;
236 break;
237 case BAD:
238 depth -= max(depth / 4, 1U);
239 break;
240 case AWFUL:
241 depth /= 2;
242 break;
243 }
244 }
245
246 depth = clamp(depth, 1U, kyber_depth[KYBER_OTHER]);
247 if (depth != orig_depth)
248 sbitmap_queue_resize(&kqd->domain_tokens[KYBER_OTHER], depth);
249}
250
251/*
252 * Apply heuristics for limiting queue depths based on gathered latency
253 * statistics.
254 */
255static void kyber_stat_timer_fn(struct blk_stat_callback *cb)
256{
257 struct kyber_queue_data *kqd = cb->data;
258 int read_status, write_status;
259
260 read_status = kyber_lat_status(cb, KYBER_READ, kqd->read_lat_nsec);
261 write_status = kyber_lat_status(cb, KYBER_SYNC_WRITE, kqd->write_lat_nsec);
262
263 kyber_adjust_rw_depth(kqd, KYBER_READ, read_status, write_status);
264 kyber_adjust_rw_depth(kqd, KYBER_SYNC_WRITE, write_status, read_status);
265 kyber_adjust_other_depth(kqd, read_status, write_status,
266 cb->stat[KYBER_OTHER].nr_samples != 0);
267
268 /*
269 * Continue monitoring latencies if we aren't hitting the targets or
270 * we're still throttling other requests.
271 */
272 if (!blk_stat_is_active(kqd->cb) &&
273 ((IS_BAD(read_status) || IS_BAD(write_status) ||
274 kqd->domain_tokens[KYBER_OTHER].sb.depth < kyber_depth[KYBER_OTHER])))
275 blk_stat_activate_msecs(kqd->cb, 100);
276}
277
278static unsigned int kyber_sched_tags_shift(struct kyber_queue_data *kqd)
279{
280 /*
281 * All of the hardware queues have the same depth, so we can just grab
282 * the shift of the first one.
283 */
284 return kqd->q->queue_hw_ctx[0]->sched_tags->bitmap_tags.sb.shift;
285}
286
287static struct kyber_queue_data *kyber_queue_data_alloc(struct request_queue *q)
288{
289 struct kyber_queue_data *kqd;
290 unsigned int max_tokens;
291 unsigned int shift;
292 int ret = -ENOMEM;
293 int i;
294
295 kqd = kmalloc_node(sizeof(*kqd), GFP_KERNEL, q->node);
296 if (!kqd)
297 goto err;
298 kqd->q = q;
299
300 kqd->cb = blk_stat_alloc_callback(kyber_stat_timer_fn, rq_sched_domain,
301 KYBER_NUM_DOMAINS, kqd);
302 if (!kqd->cb)
303 goto err_kqd;
304
305 /*
306 * The maximum number of tokens for any scheduling domain is at least
307 * the queue depth of a single hardware queue. If the hardware doesn't
308 * have many tags, still provide a reasonable number.
309 */
310 max_tokens = max_t(unsigned int, q->tag_set->queue_depth,
311 KYBER_MIN_DEPTH);
312 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
313 WARN_ON(!kyber_depth[i]);
314 WARN_ON(!kyber_batch_size[i]);
315 ret = sbitmap_queue_init_node(&kqd->domain_tokens[i],
316 max_tokens, -1, false, GFP_KERNEL,
317 q->node);
318 if (ret) {
319 while (--i >= 0)
320 sbitmap_queue_free(&kqd->domain_tokens[i]);
321 goto err_cb;
322 }
323 sbitmap_queue_resize(&kqd->domain_tokens[i], kyber_depth[i]);
324 }
325
326 shift = kyber_sched_tags_shift(kqd);
327 kqd->async_depth = (1U << shift) * KYBER_ASYNC_PERCENT / 100U;
328
329 kqd->read_lat_nsec = 2000000ULL;
330 kqd->write_lat_nsec = 10000000ULL;
331
332 return kqd;
333
334err_cb:
335 blk_stat_free_callback(kqd->cb);
336err_kqd:
337 kfree(kqd);
338err:
339 return ERR_PTR(ret);
340}
341
342static int kyber_init_sched(struct request_queue *q, struct elevator_type *e)
343{
344 struct kyber_queue_data *kqd;
345 struct elevator_queue *eq;
346
347 eq = elevator_alloc(q, e);
348 if (!eq)
349 return -ENOMEM;
350
351 kqd = kyber_queue_data_alloc(q);
352 if (IS_ERR(kqd)) {
353 kobject_put(&eq->kobj);
354 return PTR_ERR(kqd);
355 }
356
357 eq->elevator_data = kqd;
358 q->elevator = eq;
359
360 blk_stat_add_callback(q, kqd->cb);
361
362 return 0;
363}
364
365static void kyber_exit_sched(struct elevator_queue *e)
366{
367 struct kyber_queue_data *kqd = e->elevator_data;
368 struct request_queue *q = kqd->q;
369 int i;
370
371 blk_stat_remove_callback(q, kqd->cb);
372
373 for (i = 0; i < KYBER_NUM_DOMAINS; i++)
374 sbitmap_queue_free(&kqd->domain_tokens[i]);
375 blk_stat_free_callback(kqd->cb);
376 kfree(kqd);
377}
378
379static int kyber_init_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
380{
381 struct kyber_hctx_data *khd;
382 int i;
383
384 khd = kmalloc_node(sizeof(*khd), GFP_KERNEL, hctx->numa_node);
385 if (!khd)
386 return -ENOMEM;
387
388 spin_lock_init(&khd->lock);
389
390 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
391 INIT_LIST_HEAD(&khd->rqs[i]);
392 init_waitqueue_func_entry(&khd->domain_wait[i],
393 kyber_domain_wake);
394 khd->domain_wait[i].private = hctx;
395 INIT_LIST_HEAD(&khd->domain_wait[i].entry);
396 atomic_set(&khd->wait_index[i], 0);
397 }
398
399 khd->cur_domain = 0;
400 khd->batching = 0;
401
402 hctx->sched_data = khd;
403
404 return 0;
405}
406
407static void kyber_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
408{
409 kfree(hctx->sched_data);
410}
411
412static int rq_get_domain_token(struct request *rq)
413{
414 return (long)rq->elv.priv[0];
415}
416
417static void rq_set_domain_token(struct request *rq, int token)
418{
419 rq->elv.priv[0] = (void *)(long)token;
420}
421
422static void rq_clear_domain_token(struct kyber_queue_data *kqd,
423 struct request *rq)
424{
425 unsigned int sched_domain;
426 int nr;
427
428 nr = rq_get_domain_token(rq);
429 if (nr != -1) {
430 sched_domain = rq_sched_domain(rq);
431 sbitmap_queue_clear(&kqd->domain_tokens[sched_domain], nr,
432 rq->mq_ctx->cpu);
433 }
434}
435
436static void kyber_limit_depth(unsigned int op, struct blk_mq_alloc_data *data)
437{
438 /*
439 * We use the scheduler tags as per-hardware queue queueing tokens.
440 * Async requests can be limited at this stage.
441 */
442 if (!op_is_sync(op)) {
443 struct kyber_queue_data *kqd = data->q->elevator->elevator_data;
444
445 data->shallow_depth = kqd->async_depth;
446 }
447}
448
449static void kyber_prepare_request(struct request *rq, struct bio *bio)
450{
451 rq_set_domain_token(rq, -1);
452}
453
454static void kyber_finish_request(struct request *rq)
455{
456 struct kyber_queue_data *kqd = rq->q->elevator->elevator_data;
457
458 rq_clear_domain_token(kqd, rq);
459}
460
461static void kyber_completed_request(struct request *rq)
462{
463 struct request_queue *q = rq->q;
464 struct kyber_queue_data *kqd = q->elevator->elevator_data;
465 unsigned int sched_domain;
466 u64 now, latency, target;
467
468 /*
469 * Check if this request met our latency goal. If not, quickly gather
470 * some statistics and start throttling.
471 */
472 sched_domain = rq_sched_domain(rq);
473 switch (sched_domain) {
474 case KYBER_READ:
475 target = kqd->read_lat_nsec;
476 break;
477 case KYBER_SYNC_WRITE:
478 target = kqd->write_lat_nsec;
479 break;
480 default:
481 return;
482 }
483
484 /* If we are already monitoring latencies, don't check again. */
485 if (blk_stat_is_active(kqd->cb))
486 return;
487
488 now = __blk_stat_time(ktime_to_ns(ktime_get()));
489 if (now < blk_stat_time(&rq->issue_stat))
490 return;
491
492 latency = now - blk_stat_time(&rq->issue_stat);
493
494 if (latency > target)
495 blk_stat_activate_msecs(kqd->cb, 10);
496}
497
498static void kyber_flush_busy_ctxs(struct kyber_hctx_data *khd,
499 struct blk_mq_hw_ctx *hctx)
500{
501 LIST_HEAD(rq_list);
502 struct request *rq, *next;
503
504 blk_mq_flush_busy_ctxs(hctx, &rq_list);
505 list_for_each_entry_safe(rq, next, &rq_list, queuelist) {
506 unsigned int sched_domain;
507
508 sched_domain = rq_sched_domain(rq);
509 list_move_tail(&rq->queuelist, &khd->rqs[sched_domain]);
510 }
511}
512
513static int kyber_domain_wake(wait_queue_entry_t *wait, unsigned mode, int flags,
514 void *key)
515{
516 struct blk_mq_hw_ctx *hctx = READ_ONCE(wait->private);
517
518 list_del_init(&wait->entry);
519 blk_mq_run_hw_queue(hctx, true);
520 return 1;
521}
522
523static int kyber_get_domain_token(struct kyber_queue_data *kqd,
524 struct kyber_hctx_data *khd,
525 struct blk_mq_hw_ctx *hctx)
526{
527 unsigned int sched_domain = khd->cur_domain;
528 struct sbitmap_queue *domain_tokens = &kqd->domain_tokens[sched_domain];
529 wait_queue_entry_t *wait = &khd->domain_wait[sched_domain];
530 struct sbq_wait_state *ws;
531 int nr;
532
533 nr = __sbitmap_queue_get(domain_tokens);
534
535 /*
536 * If we failed to get a domain token, make sure the hardware queue is
537 * run when one becomes available. Note that this is serialized on
538 * khd->lock, but we still need to be careful about the waker.
539 */
540 if (nr < 0 && list_empty_careful(&wait->entry)) {
541 ws = sbq_wait_ptr(domain_tokens,
542 &khd->wait_index[sched_domain]);
543 khd->domain_ws[sched_domain] = ws;
544 add_wait_queue(&ws->wait, wait);
545
546 /*
547 * Try again in case a token was freed before we got on the wait
548 * queue.
549 */
550 nr = __sbitmap_queue_get(domain_tokens);
551 }
552
553 /*
554 * If we got a token while we were on the wait queue, remove ourselves
555 * from the wait queue to ensure that all wake ups make forward
556 * progress. It's possible that the waker already deleted the entry
557 * between the !list_empty_careful() check and us grabbing the lock, but
558 * list_del_init() is okay with that.
559 */
560 if (nr >= 0 && !list_empty_careful(&wait->entry)) {
561 ws = khd->domain_ws[sched_domain];
562 spin_lock_irq(&ws->wait.lock);
563 list_del_init(&wait->entry);
564 spin_unlock_irq(&ws->wait.lock);
565 }
566
567 return nr;
568}
569
570static struct request *
571kyber_dispatch_cur_domain(struct kyber_queue_data *kqd,
572 struct kyber_hctx_data *khd,
573 struct blk_mq_hw_ctx *hctx,
574 bool *flushed)
575{
576 struct list_head *rqs;
577 struct request *rq;
578 int nr;
579
580 rqs = &khd->rqs[khd->cur_domain];
581 rq = list_first_entry_or_null(rqs, struct request, queuelist);
582
583 /*
584 * If there wasn't already a pending request and we haven't flushed the
585 * software queues yet, flush the software queues and check again.
586 */
587 if (!rq && !*flushed) {
588 kyber_flush_busy_ctxs(khd, hctx);
589 *flushed = true;
590 rq = list_first_entry_or_null(rqs, struct request, queuelist);
591 }
592
593 if (rq) {
594 nr = kyber_get_domain_token(kqd, khd, hctx);
595 if (nr >= 0) {
596 khd->batching++;
597 rq_set_domain_token(rq, nr);
598 list_del_init(&rq->queuelist);
599 return rq;
600 }
601 }
602
603 /* There were either no pending requests or no tokens. */
604 return NULL;
605}
606
607static struct request *kyber_dispatch_request(struct blk_mq_hw_ctx *hctx)
608{
609 struct kyber_queue_data *kqd = hctx->queue->elevator->elevator_data;
610 struct kyber_hctx_data *khd = hctx->sched_data;
611 bool flushed = false;
612 struct request *rq;
613 int i;
614
615 spin_lock(&khd->lock);
616
617 /*
618 * First, if we are still entitled to batch, try to dispatch a request
619 * from the batch.
620 */
621 if (khd->batching < kyber_batch_size[khd->cur_domain]) {
622 rq = kyber_dispatch_cur_domain(kqd, khd, hctx, &flushed);
623 if (rq)
624 goto out;
625 }
626
627 /*
628 * Either,
629 * 1. We were no longer entitled to a batch.
630 * 2. The domain we were batching didn't have any requests.
631 * 3. The domain we were batching was out of tokens.
632 *
633 * Start another batch. Note that this wraps back around to the original
634 * domain if no other domains have requests or tokens.
635 */
636 khd->batching = 0;
637 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
638 if (khd->cur_domain == KYBER_NUM_DOMAINS - 1)
639 khd->cur_domain = 0;
640 else
641 khd->cur_domain++;
642
643 rq = kyber_dispatch_cur_domain(kqd, khd, hctx, &flushed);
644 if (rq)
645 goto out;
646 }
647
648 rq = NULL;
649out:
650 spin_unlock(&khd->lock);
651 return rq;
652}
653
654static bool kyber_has_work(struct blk_mq_hw_ctx *hctx)
655{
656 struct kyber_hctx_data *khd = hctx->sched_data;
657 int i;
658
659 for (i = 0; i < KYBER_NUM_DOMAINS; i++) {
660 if (!list_empty_careful(&khd->rqs[i]))
661 return true;
662 }
663 return sbitmap_any_bit_set(&hctx->ctx_map);
664}
665
666#define KYBER_LAT_SHOW_STORE(op) \
667static ssize_t kyber_##op##_lat_show(struct elevator_queue *e, \
668 char *page) \
669{ \
670 struct kyber_queue_data *kqd = e->elevator_data; \
671 \
672 return sprintf(page, "%llu\n", kqd->op##_lat_nsec); \
673} \
674 \
675static ssize_t kyber_##op##_lat_store(struct elevator_queue *e, \
676 const char *page, size_t count) \
677{ \
678 struct kyber_queue_data *kqd = e->elevator_data; \
679 unsigned long long nsec; \
680 int ret; \
681 \
682 ret = kstrtoull(page, 10, &nsec); \
683 if (ret) \
684 return ret; \
685 \
686 kqd->op##_lat_nsec = nsec; \
687 \
688 return count; \
689}
690KYBER_LAT_SHOW_STORE(read);
691KYBER_LAT_SHOW_STORE(write);
692#undef KYBER_LAT_SHOW_STORE
693
694#define KYBER_LAT_ATTR(op) __ATTR(op##_lat_nsec, 0644, kyber_##op##_lat_show, kyber_##op##_lat_store)
695static struct elv_fs_entry kyber_sched_attrs[] = {
696 KYBER_LAT_ATTR(read),
697 KYBER_LAT_ATTR(write),
698 __ATTR_NULL
699};
700#undef KYBER_LAT_ATTR
701
702#ifdef CONFIG_BLK_DEBUG_FS
703#define KYBER_DEBUGFS_DOMAIN_ATTRS(domain, name) \
704static int kyber_##name##_tokens_show(void *data, struct seq_file *m) \
705{ \
706 struct request_queue *q = data; \
707 struct kyber_queue_data *kqd = q->elevator->elevator_data; \
708 \
709 sbitmap_queue_show(&kqd->domain_tokens[domain], m); \
710 return 0; \
711} \
712 \
713static void *kyber_##name##_rqs_start(struct seq_file *m, loff_t *pos) \
714 __acquires(&khd->lock) \
715{ \
716 struct blk_mq_hw_ctx *hctx = m->private; \
717 struct kyber_hctx_data *khd = hctx->sched_data; \
718 \
719 spin_lock(&khd->lock); \
720 return seq_list_start(&khd->rqs[domain], *pos); \
721} \
722 \
723static void *kyber_##name##_rqs_next(struct seq_file *m, void *v, \
724 loff_t *pos) \
725{ \
726 struct blk_mq_hw_ctx *hctx = m->private; \
727 struct kyber_hctx_data *khd = hctx->sched_data; \
728 \
729 return seq_list_next(v, &khd->rqs[domain], pos); \
730} \
731 \
732static void kyber_##name##_rqs_stop(struct seq_file *m, void *v) \
733 __releases(&khd->lock) \
734{ \
735 struct blk_mq_hw_ctx *hctx = m->private; \
736 struct kyber_hctx_data *khd = hctx->sched_data; \
737 \
738 spin_unlock(&khd->lock); \
739} \
740 \
741static const struct seq_operations kyber_##name##_rqs_seq_ops = { \
742 .start = kyber_##name##_rqs_start, \
743 .next = kyber_##name##_rqs_next, \
744 .stop = kyber_##name##_rqs_stop, \
745 .show = blk_mq_debugfs_rq_show, \
746}; \
747 \
748static int kyber_##name##_waiting_show(void *data, struct seq_file *m) \
749{ \
750 struct blk_mq_hw_ctx *hctx = data; \
751 struct kyber_hctx_data *khd = hctx->sched_data; \
752 wait_queue_entry_t *wait = &khd->domain_wait[domain]; \
753 \
754 seq_printf(m, "%d\n", !list_empty_careful(&wait->entry)); \
755 return 0; \
756}
757KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_READ, read)
758KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_SYNC_WRITE, sync_write)
759KYBER_DEBUGFS_DOMAIN_ATTRS(KYBER_OTHER, other)
760#undef KYBER_DEBUGFS_DOMAIN_ATTRS
761
762static int kyber_async_depth_show(void *data, struct seq_file *m)
763{
764 struct request_queue *q = data;
765 struct kyber_queue_data *kqd = q->elevator->elevator_data;
766
767 seq_printf(m, "%u\n", kqd->async_depth);
768 return 0;
769}
770
771static int kyber_cur_domain_show(void *data, struct seq_file *m)
772{
773 struct blk_mq_hw_ctx *hctx = data;
774 struct kyber_hctx_data *khd = hctx->sched_data;
775
776 switch (khd->cur_domain) {
777 case KYBER_READ:
778 seq_puts(m, "READ\n");
779 break;
780 case KYBER_SYNC_WRITE:
781 seq_puts(m, "SYNC_WRITE\n");
782 break;
783 case KYBER_OTHER:
784 seq_puts(m, "OTHER\n");
785 break;
786 default:
787 seq_printf(m, "%u\n", khd->cur_domain);
788 break;
789 }
790 return 0;
791}
792
793static int kyber_batching_show(void *data, struct seq_file *m)
794{
795 struct blk_mq_hw_ctx *hctx = data;
796 struct kyber_hctx_data *khd = hctx->sched_data;
797
798 seq_printf(m, "%u\n", khd->batching);
799 return 0;
800}
801
802#define KYBER_QUEUE_DOMAIN_ATTRS(name) \
803 {#name "_tokens", 0400, kyber_##name##_tokens_show}
804static const struct blk_mq_debugfs_attr kyber_queue_debugfs_attrs[] = {
805 KYBER_QUEUE_DOMAIN_ATTRS(read),
806 KYBER_QUEUE_DOMAIN_ATTRS(sync_write),
807 KYBER_QUEUE_DOMAIN_ATTRS(other),
808 {"async_depth", 0400, kyber_async_depth_show},
809 {},
810};
811#undef KYBER_QUEUE_DOMAIN_ATTRS
812
813#define KYBER_HCTX_DOMAIN_ATTRS(name) \
814 {#name "_rqs", 0400, .seq_ops = &kyber_##name##_rqs_seq_ops}, \
815 {#name "_waiting", 0400, kyber_##name##_waiting_show}
816static const struct blk_mq_debugfs_attr kyber_hctx_debugfs_attrs[] = {
817 KYBER_HCTX_DOMAIN_ATTRS(read),
818 KYBER_HCTX_DOMAIN_ATTRS(sync_write),
819 KYBER_HCTX_DOMAIN_ATTRS(other),
820 {"cur_domain", 0400, kyber_cur_domain_show},
821 {"batching", 0400, kyber_batching_show},
822 {},
823};
824#undef KYBER_HCTX_DOMAIN_ATTRS
825#endif
826
827static struct elevator_type kyber_sched = {
828 .ops.mq = {
829 .init_sched = kyber_init_sched,
830 .exit_sched = kyber_exit_sched,
831 .init_hctx = kyber_init_hctx,
832 .exit_hctx = kyber_exit_hctx,
833 .limit_depth = kyber_limit_depth,
834 .prepare_request = kyber_prepare_request,
835 .finish_request = kyber_finish_request,
836 .requeue_request = kyber_finish_request,
837 .completed_request = kyber_completed_request,
838 .dispatch_request = kyber_dispatch_request,
839 .has_work = kyber_has_work,
840 },
841 .uses_mq = true,
842#ifdef CONFIG_BLK_DEBUG_FS
843 .queue_debugfs_attrs = kyber_queue_debugfs_attrs,
844 .hctx_debugfs_attrs = kyber_hctx_debugfs_attrs,
845#endif
846 .elevator_attrs = kyber_sched_attrs,
847 .elevator_name = "kyber",
848 .elevator_owner = THIS_MODULE,
849};
850
851static int __init kyber_init(void)
852{
853 return elv_register(&kyber_sched);
854}
855
856static void __exit kyber_exit(void)
857{
858 elv_unregister(&kyber_sched);
859}
860
861module_init(kyber_init);
862module_exit(kyber_exit);
863
864MODULE_AUTHOR("Omar Sandoval");
865MODULE_LICENSE("GPL");
866MODULE_DESCRIPTION("Kyber I/O scheduler");