scsi: blk-mq: Return budget token from .get_budget callback
[linux-2.6-microblaze.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. For shared queues, maintain
49  * a count of how many hardware queues are marked for restart.
50  */
51 void blk_mq_sched_mark_restart_hctx(struct blk_mq_hw_ctx *hctx)
52 {
53         if (test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state))
54                 return;
55
56         set_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
57 }
58 EXPORT_SYMBOL_GPL(blk_mq_sched_mark_restart_hctx);
59
60 void blk_mq_sched_restart(struct blk_mq_hw_ctx *hctx)
61 {
62         if (!test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state))
63                 return;
64         clear_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
65
66         /*
67          * Order clearing SCHED_RESTART and list_empty_careful(&hctx->dispatch)
68          * in blk_mq_run_hw_queue(). Its pair is the barrier in
69          * blk_mq_dispatch_rq_list(). So dispatch code won't see SCHED_RESTART,
70          * meantime new request added to hctx->dispatch is missed to check in
71          * blk_mq_run_hw_queue().
72          */
73         smp_mb();
74
75         blk_mq_run_hw_queue(hctx, true);
76 }
77
78 static int sched_rq_cmp(void *priv, struct list_head *a, 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() returns BLK_STS_NO_RESOURCE.
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                 int budget_token;
135
136                 if (e->type->ops.has_work && !e->type->ops.has_work(hctx))
137                         break;
138
139                 if (!list_empty_careful(&hctx->dispatch)) {
140                         busy = true;
141                         break;
142                 }
143
144                 budget_token = blk_mq_get_dispatch_budget(q);
145                 if (budget_token < 0)
146                         break;
147
148                 rq = e->type->ops.dispatch_request(hctx);
149                 if (!rq) {
150                         blk_mq_put_dispatch_budget(q, budget_token);
151                         /*
152                          * We're releasing without dispatching. Holding the
153                          * budget could have blocked any "hctx"s with the
154                          * same queue and if we didn't dispatch then there's
155                          * no guarantee anyone will kick the queue.  Kick it
156                          * ourselves.
157                          */
158                         run_queue = true;
159                         break;
160                 }
161
162                 blk_mq_set_rq_budget_token(rq, budget_token);
163
164                 /*
165                  * Now this rq owns the budget which has to be released
166                  * if this rq won't be queued to driver via .queue_rq()
167                  * in blk_mq_dispatch_rq_list().
168                  */
169                 list_add_tail(&rq->queuelist, &rq_list);
170                 if (rq->mq_hctx != hctx)
171                         multi_hctxs = true;
172         } while (++count < max_dispatch);
173
174         if (!count) {
175                 if (run_queue)
176                         blk_mq_delay_run_hw_queues(q, BLK_MQ_BUDGET_DELAY);
177         } else if (multi_hctxs) {
178                 /*
179                  * Requests from different hctx may be dequeued from some
180                  * schedulers, such as bfq and deadline.
181                  *
182                  * Sort the requests in the list according to their hctx,
183                  * dispatch batching requests from same hctx at a time.
184                  */
185                 list_sort(NULL, &rq_list, sched_rq_cmp);
186                 do {
187                         dispatched |= blk_mq_dispatch_hctx_list(&rq_list);
188                 } while (!list_empty(&rq_list));
189         } else {
190                 dispatched = blk_mq_dispatch_rq_list(hctx, &rq_list, count);
191         }
192
193         if (busy)
194                 return -EAGAIN;
195         return !!dispatched;
196 }
197
198 static int blk_mq_do_dispatch_sched(struct blk_mq_hw_ctx *hctx)
199 {
200         int ret;
201
202         do {
203                 ret = __blk_mq_do_dispatch_sched(hctx);
204         } while (ret == 1);
205
206         return ret;
207 }
208
209 static struct blk_mq_ctx *blk_mq_next_ctx(struct blk_mq_hw_ctx *hctx,
210                                           struct blk_mq_ctx *ctx)
211 {
212         unsigned short idx = ctx->index_hw[hctx->type];
213
214         if (++idx == hctx->nr_ctx)
215                 idx = 0;
216
217         return hctx->ctxs[idx];
218 }
219
220 /*
221  * Only SCSI implements .get_budget and .put_budget, and SCSI restarts
222  * its queue by itself in its completion handler, so we don't need to
223  * restart queue if .get_budget() returns BLK_STS_NO_RESOURCE.
224  *
225  * Returns -EAGAIN if hctx->dispatch was found non-empty and run_work has to
226  * be run again.  This is necessary to avoid starving flushes.
227  */
228 static int blk_mq_do_dispatch_ctx(struct blk_mq_hw_ctx *hctx)
229 {
230         struct request_queue *q = hctx->queue;
231         LIST_HEAD(rq_list);
232         struct blk_mq_ctx *ctx = READ_ONCE(hctx->dispatch_from);
233         int ret = 0;
234         struct request *rq;
235
236         do {
237                 int budget_token;
238
239                 if (!list_empty_careful(&hctx->dispatch)) {
240                         ret = -EAGAIN;
241                         break;
242                 }
243
244                 if (!sbitmap_any_bit_set(&hctx->ctx_map))
245                         break;
246
247                 budget_token = blk_mq_get_dispatch_budget(q);
248                 if (budget_token < 0)
249                         break;
250
251                 rq = blk_mq_dequeue_from_ctx(hctx, ctx);
252                 if (!rq) {
253                         blk_mq_put_dispatch_budget(q, budget_token);
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                 blk_mq_set_rq_budget_token(rq, budget_token);
266
267                 /*
268                  * Now this rq owns the budget which has to be released
269                  * if this rq won't be queued to driver via .queue_rq()
270                  * in blk_mq_dispatch_rq_list().
271                  */
272                 list_add(&rq->queuelist, &rq_list);
273
274                 /* round robin for fair dispatch */
275                 ctx = blk_mq_next_ctx(hctx, rq->mq_ctx);
276
277         } while (blk_mq_dispatch_rq_list(rq->mq_hctx, &rq_list, 1));
278
279         WRITE_ONCE(hctx->dispatch_from, ctx);
280         return ret;
281 }
282
283 static int __blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
284 {
285         struct request_queue *q = hctx->queue;
286         struct elevator_queue *e = q->elevator;
287         const bool has_sched_dispatch = e && e->type->ops.dispatch_request;
288         int ret = 0;
289         LIST_HEAD(rq_list);
290
291         /*
292          * If we have previous entries on our dispatch list, grab them first for
293          * more fair dispatch.
294          */
295         if (!list_empty_careful(&hctx->dispatch)) {
296                 spin_lock(&hctx->lock);
297                 if (!list_empty(&hctx->dispatch))
298                         list_splice_init(&hctx->dispatch, &rq_list);
299                 spin_unlock(&hctx->lock);
300         }
301
302         /*
303          * Only ask the scheduler for requests, if we didn't have residual
304          * requests from the dispatch list. This is to avoid the case where
305          * we only ever dispatch a fraction of the requests available because
306          * of low device queue depth. Once we pull requests out of the IO
307          * scheduler, we can no longer merge or sort them. So it's best to
308          * leave them there for as long as we can. Mark the hw queue as
309          * needing a restart in that case.
310          *
311          * We want to dispatch from the scheduler if there was nothing
312          * on the dispatch list or we were able to dispatch from the
313          * dispatch list.
314          */
315         if (!list_empty(&rq_list)) {
316                 blk_mq_sched_mark_restart_hctx(hctx);
317                 if (blk_mq_dispatch_rq_list(hctx, &rq_list, 0)) {
318                         if (has_sched_dispatch)
319                                 ret = blk_mq_do_dispatch_sched(hctx);
320                         else
321                                 ret = blk_mq_do_dispatch_ctx(hctx);
322                 }
323         } else if (has_sched_dispatch) {
324                 ret = blk_mq_do_dispatch_sched(hctx);
325         } else if (hctx->dispatch_busy) {
326                 /* dequeue request one by one from sw queue if queue is busy */
327                 ret = blk_mq_do_dispatch_ctx(hctx);
328         } else {
329                 blk_mq_flush_busy_ctxs(hctx, &rq_list);
330                 blk_mq_dispatch_rq_list(hctx, &rq_list, 0);
331         }
332
333         return ret;
334 }
335
336 void blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
337 {
338         struct request_queue *q = hctx->queue;
339
340         /* RCU or SRCU read lock is needed before checking quiesced flag */
341         if (unlikely(blk_mq_hctx_stopped(hctx) || blk_queue_quiesced(q)))
342                 return;
343
344         hctx->run++;
345
346         /*
347          * A return of -EAGAIN is an indication that hctx->dispatch is not
348          * empty and we must run again in order to avoid starving flushes.
349          */
350         if (__blk_mq_sched_dispatch_requests(hctx) == -EAGAIN) {
351                 if (__blk_mq_sched_dispatch_requests(hctx) == -EAGAIN)
352                         blk_mq_run_hw_queue(hctx, true);
353         }
354 }
355
356 bool __blk_mq_sched_bio_merge(struct request_queue *q, struct bio *bio,
357                 unsigned int nr_segs)
358 {
359         struct elevator_queue *e = q->elevator;
360         struct blk_mq_ctx *ctx = blk_mq_get_ctx(q);
361         struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, bio->bi_opf, ctx);
362         bool ret = false;
363         enum hctx_type type;
364
365         if (e && e->type->ops.bio_merge)
366                 return e->type->ops.bio_merge(hctx, bio, nr_segs);
367
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 static bool blk_mq_sched_bypass_insert(struct blk_mq_hw_ctx *hctx,
397                                        bool has_sched,
398                                        struct request *rq)
399 {
400         /*
401          * dispatch flush and passthrough rq directly
402          *
403          * passthrough request has to be added to hctx->dispatch directly.
404          * For some reason, device may be in one situation which can't
405          * handle FS request, so STS_RESOURCE is always returned and the
406          * FS request will be added to hctx->dispatch. However passthrough
407          * request may be required at that time for fixing the problem. If
408          * passthrough request is added to scheduler queue, there isn't any
409          * chance to dispatch it given we prioritize requests in hctx->dispatch.
410          */
411         if ((rq->rq_flags & RQF_FLUSH_SEQ) || blk_rq_is_passthrough(rq))
412                 return true;
413
414         if (has_sched)
415                 rq->rq_flags |= RQF_SORTED;
416
417         return false;
418 }
419
420 void blk_mq_sched_insert_request(struct request *rq, bool at_head,
421                                  bool run_queue, bool async)
422 {
423         struct request_queue *q = rq->q;
424         struct elevator_queue *e = q->elevator;
425         struct blk_mq_ctx *ctx = rq->mq_ctx;
426         struct blk_mq_hw_ctx *hctx = rq->mq_hctx;
427
428         WARN_ON(e && (rq->tag != BLK_MQ_NO_TAG));
429
430         if (blk_mq_sched_bypass_insert(hctx, !!e, rq)) {
431                 /*
432                  * Firstly normal IO request is inserted to scheduler queue or
433                  * sw queue, meantime we add flush request to dispatch queue(
434                  * hctx->dispatch) directly and there is at most one in-flight
435                  * flush request for each hw queue, so it doesn't matter to add
436                  * flush request to tail or front of the dispatch queue.
437                  *
438                  * Secondly in case of NCQ, flush request belongs to non-NCQ
439                  * command, and queueing it will fail when there is any
440                  * in-flight normal IO request(NCQ command). When adding flush
441                  * rq to the front of hctx->dispatch, it is easier to introduce
442                  * extra time to flush rq's latency because of S_SCHED_RESTART
443                  * compared with adding to the tail of dispatch queue, then
444                  * chance of flush merge is increased, and less flush requests
445                  * will be issued to controller. It is observed that ~10% time
446                  * is saved in blktests block/004 on disk attached to AHCI/NCQ
447                  * drive when adding flush rq to the front of hctx->dispatch.
448                  *
449                  * Simply queue flush rq to the front of hctx->dispatch so that
450                  * intensive flush workloads can benefit in case of NCQ HW.
451                  */
452                 at_head = (rq->rq_flags & RQF_FLUSH_SEQ) ? true : at_head;
453                 blk_mq_request_bypass_insert(rq, at_head, false);
454                 goto run;
455         }
456
457         if (e && e->type->ops.insert_requests) {
458                 LIST_HEAD(list);
459
460                 list_add(&rq->queuelist, &list);
461                 e->type->ops.insert_requests(hctx, &list, at_head);
462         } else {
463                 spin_lock(&ctx->lock);
464                 __blk_mq_insert_request(hctx, rq, at_head);
465                 spin_unlock(&ctx->lock);
466         }
467
468 run:
469         if (run_queue)
470                 blk_mq_run_hw_queue(hctx, async);
471 }
472
473 void blk_mq_sched_insert_requests(struct blk_mq_hw_ctx *hctx,
474                                   struct blk_mq_ctx *ctx,
475                                   struct list_head *list, bool run_queue_async)
476 {
477         struct elevator_queue *e;
478         struct request_queue *q = hctx->queue;
479
480         /*
481          * blk_mq_sched_insert_requests() is called from flush plug
482          * context only, and hold one usage counter to prevent queue
483          * from being released.
484          */
485         percpu_ref_get(&q->q_usage_counter);
486
487         e = hctx->queue->elevator;
488         if (e && e->type->ops.insert_requests)
489                 e->type->ops.insert_requests(hctx, list, false);
490         else {
491                 /*
492                  * try to issue requests directly if the hw queue isn't
493                  * busy in case of 'none' scheduler, and this way may save
494                  * us one extra enqueue & dequeue to sw queue.
495                  */
496                 if (!hctx->dispatch_busy && !e && !run_queue_async) {
497                         blk_mq_try_issue_list_directly(hctx, list);
498                         if (list_empty(list))
499                                 goto out;
500                 }
501                 blk_mq_insert_requests(hctx, ctx, list);
502         }
503
504         blk_mq_run_hw_queue(hctx, run_queue_async);
505  out:
506         percpu_ref_put(&q->q_usage_counter);
507 }
508
509 static void blk_mq_sched_free_tags(struct blk_mq_tag_set *set,
510                                    struct blk_mq_hw_ctx *hctx,
511                                    unsigned int hctx_idx)
512 {
513         unsigned int flags = set->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
514
515         if (hctx->sched_tags) {
516                 blk_mq_free_rqs(set, hctx->sched_tags, hctx_idx);
517                 blk_mq_free_rq_map(hctx->sched_tags, flags);
518                 hctx->sched_tags = NULL;
519         }
520 }
521
522 static int blk_mq_sched_alloc_tags(struct request_queue *q,
523                                    struct blk_mq_hw_ctx *hctx,
524                                    unsigned int hctx_idx)
525 {
526         struct blk_mq_tag_set *set = q->tag_set;
527         /* Clear HCTX_SHARED so tags are init'ed */
528         unsigned int flags = set->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
529         int ret;
530
531         hctx->sched_tags = blk_mq_alloc_rq_map(set, hctx_idx, q->nr_requests,
532                                                set->reserved_tags, flags);
533         if (!hctx->sched_tags)
534                 return -ENOMEM;
535
536         ret = blk_mq_alloc_rqs(set, hctx->sched_tags, hctx_idx, q->nr_requests);
537         if (ret)
538                 blk_mq_sched_free_tags(set, hctx, hctx_idx);
539
540         return ret;
541 }
542
543 /* called in queue's release handler, tagset has gone away */
544 static void blk_mq_sched_tags_teardown(struct request_queue *q)
545 {
546         struct blk_mq_hw_ctx *hctx;
547         int i;
548
549         queue_for_each_hw_ctx(q, hctx, i) {
550                 /* Clear HCTX_SHARED so tags are freed */
551                 unsigned int flags = hctx->flags & ~BLK_MQ_F_TAG_HCTX_SHARED;
552
553                 if (hctx->sched_tags) {
554                         blk_mq_free_rq_map(hctx->sched_tags, flags);
555                         hctx->sched_tags = NULL;
556                 }
557         }
558 }
559
560 int blk_mq_init_sched(struct request_queue *q, struct elevator_type *e)
561 {
562         struct blk_mq_hw_ctx *hctx;
563         struct elevator_queue *eq;
564         unsigned int i;
565         int ret;
566
567         if (!e) {
568                 q->elevator = NULL;
569                 q->nr_requests = q->tag_set->queue_depth;
570                 return 0;
571         }
572
573         /*
574          * Default to double of smaller one between hw queue_depth and 128,
575          * since we don't split into sync/async like the old code did.
576          * Additionally, this is a per-hw queue depth.
577          */
578         q->nr_requests = 2 * min_t(unsigned int, q->tag_set->queue_depth,
579                                    BLKDEV_MAX_RQ);
580
581         queue_for_each_hw_ctx(q, hctx, i) {
582                 ret = blk_mq_sched_alloc_tags(q, hctx, i);
583                 if (ret)
584                         goto err;
585         }
586
587         ret = e->ops.init_sched(q, e);
588         if (ret)
589                 goto err;
590
591         blk_mq_debugfs_register_sched(q);
592
593         queue_for_each_hw_ctx(q, hctx, i) {
594                 if (e->ops.init_hctx) {
595                         ret = e->ops.init_hctx(hctx, i);
596                         if (ret) {
597                                 eq = q->elevator;
598                                 blk_mq_sched_free_requests(q);
599                                 blk_mq_exit_sched(q, eq);
600                                 kobject_put(&eq->kobj);
601                                 return ret;
602                         }
603                 }
604                 blk_mq_debugfs_register_sched_hctx(q, hctx);
605         }
606
607         return 0;
608
609 err:
610         blk_mq_sched_free_requests(q);
611         blk_mq_sched_tags_teardown(q);
612         q->elevator = NULL;
613         return ret;
614 }
615
616 /*
617  * called in either blk_queue_cleanup or elevator_switch, tagset
618  * is required for freeing requests
619  */
620 void blk_mq_sched_free_requests(struct request_queue *q)
621 {
622         struct blk_mq_hw_ctx *hctx;
623         int i;
624
625         queue_for_each_hw_ctx(q, hctx, i) {
626                 if (hctx->sched_tags)
627                         blk_mq_free_rqs(q->tag_set, hctx->sched_tags, i);
628         }
629 }
630
631 void blk_mq_exit_sched(struct request_queue *q, struct elevator_queue *e)
632 {
633         struct blk_mq_hw_ctx *hctx;
634         unsigned int i;
635
636         queue_for_each_hw_ctx(q, hctx, i) {
637                 blk_mq_debugfs_unregister_sched_hctx(hctx);
638                 if (e->type->ops.exit_hctx && hctx->sched_data) {
639                         e->type->ops.exit_hctx(hctx, i);
640                         hctx->sched_data = NULL;
641                 }
642         }
643         blk_mq_debugfs_unregister_sched(q);
644         if (e->type->ops.exit_sched)
645                 e->type->ops.exit_sched(e);
646         blk_mq_sched_tags_teardown(q);
647         q->elevator = NULL;
648 }