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