GNU Linux-libre 5.10.217-gnu1
[releases.git] / block / blk-mq-sched.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * blk-mq scheduling framework
4  *
5  * Copyright (C) 2016 Jens Axboe
6  */
7 #include <linux/kernel.h>
8 #include <linux/module.h>
9 #include <linux/blk-mq.h>
10 #include <linux/list_sort.h>
11
12 #include <trace/events/block.h>
13
14 #include "blk.h"
15 #include "blk-mq.h"
16 #include "blk-mq-debugfs.h"
17 #include "blk-mq-sched.h"
18 #include "blk-mq-tag.h"
19 #include "blk-wbt.h"
20
21 void blk_mq_sched_assign_ioc(struct request *rq)
22 {
23         struct request_queue *q = rq->q;
24         struct io_context *ioc;
25         struct io_cq *icq;
26
27         /*
28          * May not have an IO context if it's a passthrough request
29          */
30         ioc = current->io_context;
31         if (!ioc)
32                 return;
33
34         spin_lock_irq(&q->queue_lock);
35         icq = ioc_lookup_icq(ioc, q);
36         spin_unlock_irq(&q->queue_lock);
37
38         if (!icq) {
39                 icq = ioc_create_icq(ioc, q, GFP_ATOMIC);
40                 if (!icq)
41                         return;
42         }
43         get_io_context(icq->ioc);
44         rq->elv.icq = icq;
45 }
46
47 /*
48  * Mark a hardware queue as needing a restart.
49  */
50 void blk_mq_sched_mark_restart_hctx(struct blk_mq_hw_ctx *hctx)
51 {
52         if (test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state))
53                 return;
54
55         set_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
56 }
57 EXPORT_SYMBOL_GPL(blk_mq_sched_mark_restart_hctx);
58
59 void blk_mq_sched_restart(struct blk_mq_hw_ctx *hctx)
60 {
61         if (!test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state))
62                 return;
63         clear_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
64
65         /*
66          * Order clearing SCHED_RESTART and list_empty_careful(&hctx->dispatch)
67          * in blk_mq_run_hw_queue(). Its pair is the barrier in
68          * blk_mq_dispatch_rq_list(). So dispatch code won't see SCHED_RESTART,
69          * meantime new request added to hctx->dispatch is missed to check in
70          * blk_mq_run_hw_queue().
71          */
72         smp_mb();
73
74         blk_mq_run_hw_queue(hctx, true);
75 }
76
77 static int sched_rq_cmp(void *priv, const struct list_head *a,
78                         const struct list_head *b)
79 {
80         struct request *rqa = container_of(a, struct request, queuelist);
81         struct request *rqb = container_of(b, struct request, queuelist);
82
83         return rqa->mq_hctx > rqb->mq_hctx;
84 }
85
86 static bool blk_mq_dispatch_hctx_list(struct list_head *rq_list)
87 {
88         struct blk_mq_hw_ctx *hctx =
89                 list_first_entry(rq_list, struct request, queuelist)->mq_hctx;
90         struct request *rq;
91         LIST_HEAD(hctx_list);
92         unsigned int count = 0;
93
94         list_for_each_entry(rq, rq_list, queuelist) {
95                 if (rq->mq_hctx != hctx) {
96                         list_cut_before(&hctx_list, rq_list, &rq->queuelist);
97                         goto dispatch;
98                 }
99                 count++;
100         }
101         list_splice_tail_init(rq_list, &hctx_list);
102
103 dispatch:
104         return blk_mq_dispatch_rq_list(hctx, &hctx_list, count);
105 }
106
107 #define BLK_MQ_BUDGET_DELAY     3               /* ms units */
108
109 /*
110  * Only SCSI implements .get_budget and .put_budget, and SCSI restarts
111  * its queue by itself in its completion handler, so we don't need to
112  * restart queue if .get_budget() fails to get the budget.
113  *
114  * Returns -EAGAIN if hctx->dispatch was found non-empty and run_work has to
115  * be run again.  This is necessary to avoid starving flushes.
116  */
117 static int __blk_mq_do_dispatch_sched(struct blk_mq_hw_ctx *hctx)
118 {
119         struct request_queue *q = hctx->queue;
120         struct elevator_queue *e = q->elevator;
121         bool multi_hctxs = false, run_queue = false;
122         bool dispatched = false, busy = false;
123         unsigned int max_dispatch;
124         LIST_HEAD(rq_list);
125         int count = 0;
126
127         if (hctx->dispatch_busy)
128                 max_dispatch = 1;
129         else
130                 max_dispatch = hctx->queue->nr_requests;
131
132         do {
133                 struct request *rq;
134
135                 if (e->type->ops.has_work && !e->type->ops.has_work(hctx))
136                         break;
137
138                 if (!list_empty_careful(&hctx->dispatch)) {
139                         busy = true;
140                         break;
141                 }
142
143                 if (!blk_mq_get_dispatch_budget(q))
144                         break;
145
146                 rq = e->type->ops.dispatch_request(hctx);
147                 if (!rq) {
148                         blk_mq_put_dispatch_budget(q);
149                         /*
150                          * We're releasing without dispatching. Holding the
151                          * budget could have blocked any "hctx"s with the
152                          * same queue and if we didn't dispatch then there's
153                          * no guarantee anyone will kick the queue.  Kick it
154                          * ourselves.
155                          */
156                         run_queue = true;
157                         break;
158                 }
159
160                 /*
161                  * Now this rq owns the budget which has to be released
162                  * if this rq won't be queued to driver via .queue_rq()
163                  * in blk_mq_dispatch_rq_list().
164                  */
165                 list_add_tail(&rq->queuelist, &rq_list);
166                 if (rq->mq_hctx != hctx)
167                         multi_hctxs = true;
168         } while (++count < max_dispatch);
169
170         if (!count) {
171                 if (run_queue)
172                         blk_mq_delay_run_hw_queues(q, BLK_MQ_BUDGET_DELAY);
173         } else if (multi_hctxs) {
174                 /*
175                  * Requests from different hctx may be dequeued from some
176                  * schedulers, such as bfq and deadline.
177                  *
178                  * Sort the requests in the list according to their hctx,
179                  * dispatch batching requests from same hctx at a time.
180                  */
181                 list_sort(NULL, &rq_list, sched_rq_cmp);
182                 do {
183                         dispatched |= blk_mq_dispatch_hctx_list(&rq_list);
184                 } while (!list_empty(&rq_list));
185         } else {
186                 dispatched = blk_mq_dispatch_rq_list(hctx, &rq_list, count);
187         }
188
189         if (busy)
190                 return -EAGAIN;
191         return !!dispatched;
192 }
193
194 static int blk_mq_do_dispatch_sched(struct blk_mq_hw_ctx *hctx)
195 {
196         unsigned long end = jiffies + HZ;
197         int ret;
198
199         do {
200                 ret = __blk_mq_do_dispatch_sched(hctx);
201                 if (ret != 1)
202                         break;
203                 if (need_resched() || time_is_before_jiffies(end)) {
204                         blk_mq_delay_run_hw_queue(hctx, 0);
205                         break;
206                 }
207         } while (1);
208
209         return ret;
210 }
211
212 static struct blk_mq_ctx *blk_mq_next_ctx(struct blk_mq_hw_ctx *hctx,
213                                           struct blk_mq_ctx *ctx)
214 {
215         unsigned short idx = ctx->index_hw[hctx->type];
216
217         if (++idx == hctx->nr_ctx)
218                 idx = 0;
219
220         return hctx->ctxs[idx];
221 }
222
223 /*
224  * Only SCSI implements .get_budget and .put_budget, and SCSI restarts
225  * its queue by itself in its completion handler, so we don't need to
226  * restart queue if .get_budget() fails to get the budget.
227  *
228  * Returns -EAGAIN if hctx->dispatch was found non-empty and run_work has to
229  * be run again.  This is necessary to avoid starving flushes.
230  */
231 static int blk_mq_do_dispatch_ctx(struct blk_mq_hw_ctx *hctx)
232 {
233         struct request_queue *q = hctx->queue;
234         LIST_HEAD(rq_list);
235         struct blk_mq_ctx *ctx = READ_ONCE(hctx->dispatch_from);
236         int ret = 0;
237         struct request *rq;
238
239         do {
240                 if (!list_empty_careful(&hctx->dispatch)) {
241                         ret = -EAGAIN;
242                         break;
243                 }
244
245                 if (!sbitmap_any_bit_set(&hctx->ctx_map))
246                         break;
247
248                 if (!blk_mq_get_dispatch_budget(q))
249                         break;
250
251                 rq = blk_mq_dequeue_from_ctx(hctx, ctx);
252                 if (!rq) {
253                         blk_mq_put_dispatch_budget(q);
254                         /*
255                          * We're releasing without dispatching. Holding the
256                          * budget could have blocked any "hctx"s with the
257                          * same queue and if we didn't dispatch then there's
258                          * no guarantee anyone will kick the queue.  Kick it
259                          * ourselves.
260                          */
261                         blk_mq_delay_run_hw_queues(q, BLK_MQ_BUDGET_DELAY);
262                         break;
263                 }
264
265                 /*
266                  * Now this rq owns the budget which has to be released
267                  * if this rq won't be queued to driver via .queue_rq()
268                  * in blk_mq_dispatch_rq_list().
269                  */
270                 list_add(&rq->queuelist, &rq_list);
271
272                 /* round robin for fair dispatch */
273                 ctx = blk_mq_next_ctx(hctx, rq->mq_ctx);
274
275         } while (blk_mq_dispatch_rq_list(rq->mq_hctx, &rq_list, 1));
276
277         WRITE_ONCE(hctx->dispatch_from, ctx);
278         return ret;
279 }
280
281 static int __blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
282 {
283         struct request_queue *q = hctx->queue;
284         struct elevator_queue *e = q->elevator;
285         const bool has_sched_dispatch = e && e->type->ops.dispatch_request;
286         int ret = 0;
287         LIST_HEAD(rq_list);
288
289         /*
290          * If we have previous entries on our dispatch list, grab them first for
291          * more fair dispatch.
292          */
293         if (!list_empty_careful(&hctx->dispatch)) {
294                 spin_lock(&hctx->lock);
295                 if (!list_empty(&hctx->dispatch))
296                         list_splice_init(&hctx->dispatch, &rq_list);
297                 spin_unlock(&hctx->lock);
298         }
299
300         /*
301          * Only ask the scheduler for requests, if we didn't have residual
302          * requests from the dispatch list. This is to avoid the case where
303          * we only ever dispatch a fraction of the requests available because
304          * of low device queue depth. Once we pull requests out of the IO
305          * scheduler, we can no longer merge or sort them. So it's best to
306          * leave them there for as long as we can. Mark the hw queue as
307          * needing a restart in that case.
308          *
309          * We want to dispatch from the scheduler if there was nothing
310          * on the dispatch list or we were able to dispatch from the
311          * dispatch list.
312          */
313         if (!list_empty(&rq_list)) {
314                 blk_mq_sched_mark_restart_hctx(hctx);
315                 if (blk_mq_dispatch_rq_list(hctx, &rq_list, 0)) {
316                         if (has_sched_dispatch)
317                                 ret = blk_mq_do_dispatch_sched(hctx);
318                         else
319                                 ret = blk_mq_do_dispatch_ctx(hctx);
320                 }
321         } else if (has_sched_dispatch) {
322                 ret = blk_mq_do_dispatch_sched(hctx);
323         } else if (hctx->dispatch_busy) {
324                 /* dequeue request one by one from sw queue if queue is busy */
325                 ret = blk_mq_do_dispatch_ctx(hctx);
326         } else {
327                 blk_mq_flush_busy_ctxs(hctx, &rq_list);
328                 blk_mq_dispatch_rq_list(hctx, &rq_list, 0);
329         }
330
331         return ret;
332 }
333
334 void blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
335 {
336         struct request_queue *q = hctx->queue;
337
338         /* RCU or SRCU read lock is needed before checking quiesced flag */
339         if (unlikely(blk_mq_hctx_stopped(hctx) || blk_queue_quiesced(q)))
340                 return;
341
342         hctx->run++;
343
344         /*
345          * A return of -EAGAIN is an indication that hctx->dispatch is not
346          * empty and we must run again in order to avoid starving flushes.
347          */
348         if (__blk_mq_sched_dispatch_requests(hctx) == -EAGAIN) {
349                 if (__blk_mq_sched_dispatch_requests(hctx) == -EAGAIN)
350                         blk_mq_run_hw_queue(hctx, true);
351         }
352 }
353
354 bool __blk_mq_sched_bio_merge(struct request_queue *q, struct bio *bio,
355                 unsigned int nr_segs)
356 {
357         struct elevator_queue *e = q->elevator;
358         struct blk_mq_ctx *ctx;
359         struct blk_mq_hw_ctx *hctx;
360         bool ret = false;
361         enum hctx_type type;
362
363         if (e && e->type->ops.bio_merge)
364                 return e->type->ops.bio_merge(q, bio, nr_segs);
365
366         ctx = blk_mq_get_ctx(q);
367         hctx = blk_mq_map_queue(q, bio->bi_opf, ctx);
368         type = hctx->type;
369         if (!(hctx->flags & BLK_MQ_F_SHOULD_MERGE) ||
370             list_empty_careful(&ctx->rq_lists[type]))
371                 return false;
372
373         /* default per sw-queue merge */
374         spin_lock(&ctx->lock);
375         /*
376          * Reverse check our software queue for entries that we could
377          * potentially merge with. Currently includes a hand-wavy stop
378          * count of 8, to not spend too much time checking for merges.
379          */
380         if (blk_bio_list_merge(q, &ctx->rq_lists[type], bio, nr_segs)) {
381                 ctx->rq_merged++;
382                 ret = true;
383         }
384
385         spin_unlock(&ctx->lock);
386
387         return ret;
388 }
389
390 bool blk_mq_sched_try_insert_merge(struct request_queue *q, struct request *rq)
391 {
392         return rq_mergeable(rq) && elv_attempt_insert_merge(q, rq);
393 }
394 EXPORT_SYMBOL_GPL(blk_mq_sched_try_insert_merge);
395
396 void blk_mq_sched_request_inserted(struct request *rq)
397 {
398         trace_block_rq_insert(rq);
399 }
400 EXPORT_SYMBOL_GPL(blk_mq_sched_request_inserted);
401
402 static bool blk_mq_sched_bypass_insert(struct blk_mq_hw_ctx *hctx,
403                                        bool has_sched,
404                                        struct request *rq)
405 {
406         /*
407          * dispatch flush and passthrough rq directly
408          *
409          * passthrough request has to be added to hctx->dispatch directly.
410          * For some reason, device may be in one situation which can't
411          * handle FS request, so STS_RESOURCE is always returned and the
412          * FS request will be added to hctx->dispatch. However passthrough
413          * request may be required at that time for fixing the problem. If
414          * passthrough request is added to scheduler queue, there isn't any
415          * chance to dispatch it given we prioritize requests in hctx->dispatch.
416          */
417         if ((rq->rq_flags & RQF_FLUSH_SEQ) || blk_rq_is_passthrough(rq))
418                 return true;
419
420         if (has_sched)
421                 rq->rq_flags |= RQF_SORTED;
422
423         return false;
424 }
425
426 void blk_mq_sched_insert_request(struct request *rq, bool at_head,
427                                  bool run_queue, bool async)
428 {
429         struct request_queue *q = rq->q;
430         struct elevator_queue *e = q->elevator;
431         struct blk_mq_ctx *ctx = rq->mq_ctx;
432         struct blk_mq_hw_ctx *hctx = rq->mq_hctx;
433
434         WARN_ON(e && (rq->tag != BLK_MQ_NO_TAG));
435
436         if (blk_mq_sched_bypass_insert(hctx, !!e, rq)) {
437                 /*
438                  * Firstly normal IO request is inserted to scheduler queue or
439                  * sw queue, meantime we add flush request to dispatch queue(
440                  * hctx->dispatch) directly and there is at most one in-flight
441                  * flush request for each hw queue, so it doesn't matter to add
442                  * flush request to tail or front of the dispatch queue.
443                  *
444                  * Secondly in case of NCQ, flush request belongs to non-NCQ
445                  * command, and queueing it will fail when there is any
446                  * in-flight normal IO request(NCQ command). When adding flush
447                  * rq to the front of hctx->dispatch, it is easier to introduce
448                  * extra time to flush rq's latency because of S_SCHED_RESTART
449                  * compared with adding to the tail of dispatch queue, then
450                  * chance of flush merge is increased, and less flush requests
451                  * will be issued to controller. It is observed that ~10% time
452                  * is saved in blktests block/004 on disk attached to AHCI/NCQ
453                  * drive when adding flush rq to the front of hctx->dispatch.
454                  *
455                  * Simply queue flush rq to the front of hctx->dispatch so that
456                  * intensive flush workloads can benefit in case of NCQ HW.
457                  */
458                 at_head = (rq->rq_flags & RQF_FLUSH_SEQ) ? true : at_head;
459                 blk_mq_request_bypass_insert(rq, at_head, false);
460                 goto run;
461         }
462
463         if (e && e->type->ops.insert_requests) {
464                 LIST_HEAD(list);
465
466                 list_add(&rq->queuelist, &list);
467                 e->type->ops.insert_requests(hctx, &list, at_head);
468         } else {
469                 spin_lock(&ctx->lock);
470                 __blk_mq_insert_request(hctx, rq, at_head);
471                 spin_unlock(&ctx->lock);
472         }
473
474 run:
475         if (run_queue)
476                 blk_mq_run_hw_queue(hctx, async);
477 }
478
479 void blk_mq_sched_insert_requests(struct blk_mq_hw_ctx *hctx,
480                                   struct blk_mq_ctx *ctx,
481                                   struct list_head *list, bool run_queue_async)
482 {
483         struct elevator_queue *e;
484         struct request_queue *q = hctx->queue;
485
486         /*
487          * blk_mq_sched_insert_requests() is called from flush plug
488          * context only, and hold one usage counter to prevent queue
489          * from being released.
490          */
491         percpu_ref_get(&q->q_usage_counter);
492
493         e = hctx->queue->elevator;
494         if (e && e->type->ops.insert_requests)
495                 e->type->ops.insert_requests(hctx, list, false);
496         else {
497                 /*
498                  * try to issue requests directly if the hw queue isn't
499                  * busy in case of 'none' scheduler, and this way may save
500                  * us one extra enqueue & dequeue to sw queue.
501                  */
502                 if (!hctx->dispatch_busy && !e && !run_queue_async) {
503                         blk_mq_try_issue_list_directly(hctx, list);
504                         if (list_empty(list))
505                                 goto out;
506                 }
507                 blk_mq_insert_requests(hctx, ctx, list);
508         }
509
510         blk_mq_run_hw_queue(hctx, run_queue_async);
511  out:
512         percpu_ref_put(&q->q_usage_counter);
513 }
514
515 static void blk_mq_sched_free_tags(struct blk_mq_tag_set *set,
516                                    struct blk_mq_hw_ctx *hctx,
517                                    unsigned int hctx_idx)
518 {
519         unsigned int flags = set->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
520
521         if (hctx->sched_tags) {
522                 blk_mq_free_rqs(set, hctx->sched_tags, hctx_idx);
523                 blk_mq_free_rq_map(hctx->sched_tags, flags);
524                 hctx->sched_tags = NULL;
525         }
526 }
527
528 static int blk_mq_sched_alloc_tags(struct request_queue *q,
529                                    struct blk_mq_hw_ctx *hctx,
530                                    unsigned int hctx_idx)
531 {
532         struct blk_mq_tag_set *set = q->tag_set;
533         /* Clear HCTX_SHARED so tags are init'ed */
534         unsigned int flags = set->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
535         int ret;
536
537         hctx->sched_tags = blk_mq_alloc_rq_map(set, hctx_idx, q->nr_requests,
538                                                set->reserved_tags, flags);
539         if (!hctx->sched_tags)
540                 return -ENOMEM;
541
542         ret = blk_mq_alloc_rqs(set, hctx->sched_tags, hctx_idx, q->nr_requests);
543         if (ret)
544                 blk_mq_sched_free_tags(set, hctx, hctx_idx);
545
546         return ret;
547 }
548
549 /* called in queue's release handler, tagset has gone away */
550 static void blk_mq_sched_tags_teardown(struct request_queue *q)
551 {
552         struct blk_mq_hw_ctx *hctx;
553         int i;
554
555         queue_for_each_hw_ctx(q, hctx, i) {
556                 /* Clear HCTX_SHARED so tags are freed */
557                 unsigned int flags = hctx->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
558
559                 if (hctx->sched_tags) {
560                         blk_mq_free_rq_map(hctx->sched_tags, flags);
561                         hctx->sched_tags = NULL;
562                 }
563         }
564 }
565
566 int blk_mq_init_sched(struct request_queue *q, struct elevator_type *e)
567 {
568         struct blk_mq_hw_ctx *hctx;
569         struct elevator_queue *eq;
570         unsigned int i;
571         int ret;
572
573         if (!e) {
574                 q->elevator = NULL;
575                 q->nr_requests = q->tag_set->queue_depth;
576                 return 0;
577         }
578
579         /*
580          * Default to double of smaller one between hw queue_depth and 128,
581          * since we don't split into sync/async like the old code did.
582          * Additionally, this is a per-hw queue depth.
583          */
584         q->nr_requests = 2 * min_t(unsigned int, q->tag_set->queue_depth,
585                                    BLKDEV_MAX_RQ);
586
587         queue_for_each_hw_ctx(q, hctx, i) {
588                 ret = blk_mq_sched_alloc_tags(q, hctx, i);
589                 if (ret)
590                         goto err;
591         }
592
593         ret = e->ops.init_sched(q, e);
594         if (ret)
595                 goto err;
596
597         blk_mq_debugfs_register_sched(q);
598
599         queue_for_each_hw_ctx(q, hctx, i) {
600                 if (e->ops.init_hctx) {
601                         ret = e->ops.init_hctx(hctx, i);
602                         if (ret) {
603                                 eq = q->elevator;
604                                 blk_mq_sched_free_requests(q);
605                                 blk_mq_exit_sched(q, eq);
606                                 kobject_put(&eq->kobj);
607                                 return ret;
608                         }
609                 }
610                 blk_mq_debugfs_register_sched_hctx(q, hctx);
611         }
612
613         return 0;
614
615 err:
616         blk_mq_sched_free_requests(q);
617         blk_mq_sched_tags_teardown(q);
618         q->elevator = NULL;
619         return ret;
620 }
621
622 /*
623  * called in either blk_queue_cleanup or elevator_switch, tagset
624  * is required for freeing requests
625  */
626 void blk_mq_sched_free_requests(struct request_queue *q)
627 {
628         struct blk_mq_hw_ctx *hctx;
629         int i;
630
631         queue_for_each_hw_ctx(q, hctx, i) {
632                 if (hctx->sched_tags)
633                         blk_mq_free_rqs(q->tag_set, hctx->sched_tags, i);
634         }
635 }
636
637 void blk_mq_exit_sched(struct request_queue *q, struct elevator_queue *e)
638 {
639         struct blk_mq_hw_ctx *hctx;
640         unsigned int i;
641
642         queue_for_each_hw_ctx(q, hctx, i) {
643                 blk_mq_debugfs_unregister_sched_hctx(hctx);
644                 if (e->type->ops.exit_hctx && hctx->sched_data) {
645                         e->type->ops.exit_hctx(hctx, i);
646                         hctx->sched_data = NULL;
647                 }
648         }
649         blk_mq_debugfs_unregister_sched(q);
650         if (e->type->ops.exit_sched)
651                 e->type->ops.exit_sched(e);
652         blk_mq_sched_tags_teardown(q);
653         q->elevator = NULL;
654 }