]> asedeno.scripts.mit.edu Git - linux.git/blob - block/blk-mq-sched.c
block: Introduce request_queue.initialize_rq_fn()
[linux.git] / block / blk-mq-sched.c
1 /*
2  * blk-mq scheduling framework
3  *
4  * Copyright (C) 2016 Jens Axboe
5  */
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/blk-mq.h>
9
10 #include <trace/events/block.h>
11
12 #include "blk.h"
13 #include "blk-mq.h"
14 #include "blk-mq-debugfs.h"
15 #include "blk-mq-sched.h"
16 #include "blk-mq-tag.h"
17 #include "blk-wbt.h"
18
19 void blk_mq_sched_free_hctx_data(struct request_queue *q,
20                                  void (*exit)(struct blk_mq_hw_ctx *))
21 {
22         struct blk_mq_hw_ctx *hctx;
23         int i;
24
25         queue_for_each_hw_ctx(q, hctx, i) {
26                 if (exit && hctx->sched_data)
27                         exit(hctx);
28                 kfree(hctx->sched_data);
29                 hctx->sched_data = NULL;
30         }
31 }
32 EXPORT_SYMBOL_GPL(blk_mq_sched_free_hctx_data);
33
34 void blk_mq_sched_assign_ioc(struct request *rq, struct bio *bio)
35 {
36         struct request_queue *q = rq->q;
37         struct io_context *ioc = rq_ioc(bio);
38         struct io_cq *icq;
39
40         spin_lock_irq(q->queue_lock);
41         icq = ioc_lookup_icq(ioc, q);
42         spin_unlock_irq(q->queue_lock);
43
44         if (!icq) {
45                 icq = ioc_create_icq(ioc, q, GFP_ATOMIC);
46                 if (!icq)
47                         return;
48         }
49         get_io_context(icq->ioc);
50         rq->elv.icq = icq;
51 }
52
53 void blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
54 {
55         struct request_queue *q = hctx->queue;
56         struct elevator_queue *e = q->elevator;
57         const bool has_sched_dispatch = e && e->type->ops.mq.dispatch_request;
58         bool did_work = false;
59         LIST_HEAD(rq_list);
60
61         /* RCU or SRCU read lock is needed before checking quiesced flag */
62         if (unlikely(blk_mq_hctx_stopped(hctx) || blk_queue_quiesced(q)))
63                 return;
64
65         hctx->run++;
66
67         /*
68          * If we have previous entries on our dispatch list, grab them first for
69          * more fair dispatch.
70          */
71         if (!list_empty_careful(&hctx->dispatch)) {
72                 spin_lock(&hctx->lock);
73                 if (!list_empty(&hctx->dispatch))
74                         list_splice_init(&hctx->dispatch, &rq_list);
75                 spin_unlock(&hctx->lock);
76         }
77
78         /*
79          * Only ask the scheduler for requests, if we didn't have residual
80          * requests from the dispatch list. This is to avoid the case where
81          * we only ever dispatch a fraction of the requests available because
82          * of low device queue depth. Once we pull requests out of the IO
83          * scheduler, we can no longer merge or sort them. So it's best to
84          * leave them there for as long as we can. Mark the hw queue as
85          * needing a restart in that case.
86          */
87         if (!list_empty(&rq_list)) {
88                 blk_mq_sched_mark_restart_hctx(hctx);
89                 did_work = blk_mq_dispatch_rq_list(q, &rq_list);
90         } else if (!has_sched_dispatch) {
91                 blk_mq_flush_busy_ctxs(hctx, &rq_list);
92                 blk_mq_dispatch_rq_list(q, &rq_list);
93         }
94
95         /*
96          * We want to dispatch from the scheduler if we had no work left
97          * on the dispatch list, OR if we did have work but weren't able
98          * to make progress.
99          */
100         if (!did_work && has_sched_dispatch) {
101                 do {
102                         struct request *rq;
103
104                         rq = e->type->ops.mq.dispatch_request(hctx);
105                         if (!rq)
106                                 break;
107                         list_add(&rq->queuelist, &rq_list);
108                 } while (blk_mq_dispatch_rq_list(q, &rq_list));
109         }
110 }
111
112 bool blk_mq_sched_try_merge(struct request_queue *q, struct bio *bio,
113                             struct request **merged_request)
114 {
115         struct request *rq;
116
117         switch (elv_merge(q, &rq, bio)) {
118         case ELEVATOR_BACK_MERGE:
119                 if (!blk_mq_sched_allow_merge(q, rq, bio))
120                         return false;
121                 if (!bio_attempt_back_merge(q, rq, bio))
122                         return false;
123                 *merged_request = attempt_back_merge(q, rq);
124                 if (!*merged_request)
125                         elv_merged_request(q, rq, ELEVATOR_BACK_MERGE);
126                 return true;
127         case ELEVATOR_FRONT_MERGE:
128                 if (!blk_mq_sched_allow_merge(q, rq, bio))
129                         return false;
130                 if (!bio_attempt_front_merge(q, rq, bio))
131                         return false;
132                 *merged_request = attempt_front_merge(q, rq);
133                 if (!*merged_request)
134                         elv_merged_request(q, rq, ELEVATOR_FRONT_MERGE);
135                 return true;
136         default:
137                 return false;
138         }
139 }
140 EXPORT_SYMBOL_GPL(blk_mq_sched_try_merge);
141
142 /*
143  * Reverse check our software queue for entries that we could potentially
144  * merge with. Currently includes a hand-wavy stop count of 8, to not spend
145  * too much time checking for merges.
146  */
147 static bool blk_mq_attempt_merge(struct request_queue *q,
148                                  struct blk_mq_ctx *ctx, struct bio *bio)
149 {
150         struct request *rq;
151         int checked = 8;
152
153         list_for_each_entry_reverse(rq, &ctx->rq_list, queuelist) {
154                 bool merged = false;
155
156                 if (!checked--)
157                         break;
158
159                 if (!blk_rq_merge_ok(rq, bio))
160                         continue;
161
162                 switch (blk_try_merge(rq, bio)) {
163                 case ELEVATOR_BACK_MERGE:
164                         if (blk_mq_sched_allow_merge(q, rq, bio))
165                                 merged = bio_attempt_back_merge(q, rq, bio);
166                         break;
167                 case ELEVATOR_FRONT_MERGE:
168                         if (blk_mq_sched_allow_merge(q, rq, bio))
169                                 merged = bio_attempt_front_merge(q, rq, bio);
170                         break;
171                 case ELEVATOR_DISCARD_MERGE:
172                         merged = bio_attempt_discard_merge(q, rq, bio);
173                         break;
174                 default:
175                         continue;
176                 }
177
178                 if (merged)
179                         ctx->rq_merged++;
180                 return merged;
181         }
182
183         return false;
184 }
185
186 bool __blk_mq_sched_bio_merge(struct request_queue *q, struct bio *bio)
187 {
188         struct elevator_queue *e = q->elevator;
189         struct blk_mq_ctx *ctx = blk_mq_get_ctx(q);
190         struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
191         bool ret = false;
192
193         if (e && e->type->ops.mq.bio_merge) {
194                 blk_mq_put_ctx(ctx);
195                 return e->type->ops.mq.bio_merge(hctx, bio);
196         }
197
198         if (hctx->flags & BLK_MQ_F_SHOULD_MERGE) {
199                 /* default per sw-queue merge */
200                 spin_lock(&ctx->lock);
201                 ret = blk_mq_attempt_merge(q, ctx, bio);
202                 spin_unlock(&ctx->lock);
203         }
204
205         blk_mq_put_ctx(ctx);
206         return ret;
207 }
208
209 bool blk_mq_sched_try_insert_merge(struct request_queue *q, struct request *rq)
210 {
211         return rq_mergeable(rq) && elv_attempt_insert_merge(q, rq);
212 }
213 EXPORT_SYMBOL_GPL(blk_mq_sched_try_insert_merge);
214
215 void blk_mq_sched_request_inserted(struct request *rq)
216 {
217         trace_block_rq_insert(rq->q, rq);
218 }
219 EXPORT_SYMBOL_GPL(blk_mq_sched_request_inserted);
220
221 static bool blk_mq_sched_bypass_insert(struct blk_mq_hw_ctx *hctx,
222                                        struct request *rq)
223 {
224         if (rq->tag == -1) {
225                 rq->rq_flags |= RQF_SORTED;
226                 return false;
227         }
228
229         /*
230          * If we already have a real request tag, send directly to
231          * the dispatch list.
232          */
233         spin_lock(&hctx->lock);
234         list_add(&rq->queuelist, &hctx->dispatch);
235         spin_unlock(&hctx->lock);
236         return true;
237 }
238
239 static bool blk_mq_sched_restart_hctx(struct blk_mq_hw_ctx *hctx)
240 {
241         if (test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state)) {
242                 clear_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
243                 if (blk_mq_hctx_has_pending(hctx)) {
244                         blk_mq_run_hw_queue(hctx, true);
245                         return true;
246                 }
247         }
248         return false;
249 }
250
251 /**
252  * list_for_each_entry_rcu_rr - iterate in a round-robin fashion over rcu list
253  * @pos:    loop cursor.
254  * @skip:   the list element that will not be examined. Iteration starts at
255  *          @skip->next.
256  * @head:   head of the list to examine. This list must have at least one
257  *          element, namely @skip.
258  * @member: name of the list_head structure within typeof(*pos).
259  */
260 #define list_for_each_entry_rcu_rr(pos, skip, head, member)             \
261         for ((pos) = (skip);                                            \
262              (pos = (pos)->member.next != (head) ? list_entry_rcu(      \
263                         (pos)->member.next, typeof(*pos), member) :     \
264               list_entry_rcu((pos)->member.next->next, typeof(*pos), member)), \
265              (pos) != (skip); )
266
267 /*
268  * Called after a driver tag has been freed to check whether a hctx needs to
269  * be restarted. Restarts @hctx if its tag set is not shared. Restarts hardware
270  * queues in a round-robin fashion if the tag set of @hctx is shared with other
271  * hardware queues.
272  */
273 void blk_mq_sched_restart(struct blk_mq_hw_ctx *const hctx)
274 {
275         struct blk_mq_tags *const tags = hctx->tags;
276         struct blk_mq_tag_set *const set = hctx->queue->tag_set;
277         struct request_queue *const queue = hctx->queue, *q;
278         struct blk_mq_hw_ctx *hctx2;
279         unsigned int i, j;
280
281         if (set->flags & BLK_MQ_F_TAG_SHARED) {
282                 rcu_read_lock();
283                 list_for_each_entry_rcu_rr(q, queue, &set->tag_list,
284                                            tag_set_list) {
285                         queue_for_each_hw_ctx(q, hctx2, i)
286                                 if (hctx2->tags == tags &&
287                                     blk_mq_sched_restart_hctx(hctx2))
288                                         goto done;
289                 }
290                 j = hctx->queue_num + 1;
291                 for (i = 0; i < queue->nr_hw_queues; i++, j++) {
292                         if (j == queue->nr_hw_queues)
293                                 j = 0;
294                         hctx2 = queue->queue_hw_ctx[j];
295                         if (hctx2->tags == tags &&
296                             blk_mq_sched_restart_hctx(hctx2))
297                                 break;
298                 }
299 done:
300                 rcu_read_unlock();
301         } else {
302                 blk_mq_sched_restart_hctx(hctx);
303         }
304 }
305
306 /*
307  * Add flush/fua to the queue. If we fail getting a driver tag, then
308  * punt to the requeue list. Requeue will re-invoke us from a context
309  * that's safe to block from.
310  */
311 static void blk_mq_sched_insert_flush(struct blk_mq_hw_ctx *hctx,
312                                       struct request *rq, bool can_block)
313 {
314         if (blk_mq_get_driver_tag(rq, &hctx, can_block)) {
315                 blk_insert_flush(rq);
316                 blk_mq_run_hw_queue(hctx, true);
317         } else
318                 blk_mq_add_to_requeue_list(rq, false, true);
319 }
320
321 void blk_mq_sched_insert_request(struct request *rq, bool at_head,
322                                  bool run_queue, bool async, bool can_block)
323 {
324         struct request_queue *q = rq->q;
325         struct elevator_queue *e = q->elevator;
326         struct blk_mq_ctx *ctx = rq->mq_ctx;
327         struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
328
329         if (rq->tag == -1 && op_is_flush(rq->cmd_flags)) {
330                 blk_mq_sched_insert_flush(hctx, rq, can_block);
331                 return;
332         }
333
334         if (e && blk_mq_sched_bypass_insert(hctx, rq))
335                 goto run;
336
337         if (e && e->type->ops.mq.insert_requests) {
338                 LIST_HEAD(list);
339
340                 list_add(&rq->queuelist, &list);
341                 e->type->ops.mq.insert_requests(hctx, &list, at_head);
342         } else {
343                 spin_lock(&ctx->lock);
344                 __blk_mq_insert_request(hctx, rq, at_head);
345                 spin_unlock(&ctx->lock);
346         }
347
348 run:
349         if (run_queue)
350                 blk_mq_run_hw_queue(hctx, async);
351 }
352
353 void blk_mq_sched_insert_requests(struct request_queue *q,
354                                   struct blk_mq_ctx *ctx,
355                                   struct list_head *list, bool run_queue_async)
356 {
357         struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
358         struct elevator_queue *e = hctx->queue->elevator;
359
360         if (e) {
361                 struct request *rq, *next;
362
363                 /*
364                  * We bypass requests that already have a driver tag assigned,
365                  * which should only be flushes. Flushes are only ever inserted
366                  * as single requests, so we shouldn't ever hit the
367                  * WARN_ON_ONCE() below (but let's handle it just in case).
368                  */
369                 list_for_each_entry_safe(rq, next, list, queuelist) {
370                         if (WARN_ON_ONCE(rq->tag != -1)) {
371                                 list_del_init(&rq->queuelist);
372                                 blk_mq_sched_bypass_insert(hctx, rq);
373                         }
374                 }
375         }
376
377         if (e && e->type->ops.mq.insert_requests)
378                 e->type->ops.mq.insert_requests(hctx, list, false);
379         else
380                 blk_mq_insert_requests(hctx, ctx, list);
381
382         blk_mq_run_hw_queue(hctx, run_queue_async);
383 }
384
385 static void blk_mq_sched_free_tags(struct blk_mq_tag_set *set,
386                                    struct blk_mq_hw_ctx *hctx,
387                                    unsigned int hctx_idx)
388 {
389         if (hctx->sched_tags) {
390                 blk_mq_free_rqs(set, hctx->sched_tags, hctx_idx);
391                 blk_mq_free_rq_map(hctx->sched_tags);
392                 hctx->sched_tags = NULL;
393         }
394 }
395
396 static int blk_mq_sched_alloc_tags(struct request_queue *q,
397                                    struct blk_mq_hw_ctx *hctx,
398                                    unsigned int hctx_idx)
399 {
400         struct blk_mq_tag_set *set = q->tag_set;
401         int ret;
402
403         hctx->sched_tags = blk_mq_alloc_rq_map(set, hctx_idx, q->nr_requests,
404                                                set->reserved_tags);
405         if (!hctx->sched_tags)
406                 return -ENOMEM;
407
408         ret = blk_mq_alloc_rqs(set, hctx->sched_tags, hctx_idx, q->nr_requests);
409         if (ret)
410                 blk_mq_sched_free_tags(set, hctx, hctx_idx);
411
412         return ret;
413 }
414
415 static void blk_mq_sched_tags_teardown(struct request_queue *q)
416 {
417         struct blk_mq_tag_set *set = q->tag_set;
418         struct blk_mq_hw_ctx *hctx;
419         int i;
420
421         queue_for_each_hw_ctx(q, hctx, i)
422                 blk_mq_sched_free_tags(set, hctx, i);
423 }
424
425 int blk_mq_sched_init_hctx(struct request_queue *q, struct blk_mq_hw_ctx *hctx,
426                            unsigned int hctx_idx)
427 {
428         struct elevator_queue *e = q->elevator;
429         int ret;
430
431         if (!e)
432                 return 0;
433
434         ret = blk_mq_sched_alloc_tags(q, hctx, hctx_idx);
435         if (ret)
436                 return ret;
437
438         if (e->type->ops.mq.init_hctx) {
439                 ret = e->type->ops.mq.init_hctx(hctx, hctx_idx);
440                 if (ret) {
441                         blk_mq_sched_free_tags(q->tag_set, hctx, hctx_idx);
442                         return ret;
443                 }
444         }
445
446         blk_mq_debugfs_register_sched_hctx(q, hctx);
447
448         return 0;
449 }
450
451 void blk_mq_sched_exit_hctx(struct request_queue *q, struct blk_mq_hw_ctx *hctx,
452                             unsigned int hctx_idx)
453 {
454         struct elevator_queue *e = q->elevator;
455
456         if (!e)
457                 return;
458
459         blk_mq_debugfs_unregister_sched_hctx(hctx);
460
461         if (e->type->ops.mq.exit_hctx && hctx->sched_data) {
462                 e->type->ops.mq.exit_hctx(hctx, hctx_idx);
463                 hctx->sched_data = NULL;
464         }
465
466         blk_mq_sched_free_tags(q->tag_set, hctx, hctx_idx);
467 }
468
469 int blk_mq_init_sched(struct request_queue *q, struct elevator_type *e)
470 {
471         struct blk_mq_hw_ctx *hctx;
472         struct elevator_queue *eq;
473         unsigned int i;
474         int ret;
475
476         if (!e) {
477                 q->elevator = NULL;
478                 return 0;
479         }
480
481         /*
482          * Default to 256, since we don't split into sync/async like the
483          * old code did. Additionally, this is a per-hw queue depth.
484          */
485         q->nr_requests = 2 * BLKDEV_MAX_RQ;
486
487         queue_for_each_hw_ctx(q, hctx, i) {
488                 ret = blk_mq_sched_alloc_tags(q, hctx, i);
489                 if (ret)
490                         goto err;
491         }
492
493         ret = e->ops.mq.init_sched(q, e);
494         if (ret)
495                 goto err;
496
497         blk_mq_debugfs_register_sched(q);
498
499         queue_for_each_hw_ctx(q, hctx, i) {
500                 if (e->ops.mq.init_hctx) {
501                         ret = e->ops.mq.init_hctx(hctx, i);
502                         if (ret) {
503                                 eq = q->elevator;
504                                 blk_mq_exit_sched(q, eq);
505                                 kobject_put(&eq->kobj);
506                                 return ret;
507                         }
508                 }
509                 blk_mq_debugfs_register_sched_hctx(q, hctx);
510         }
511
512         return 0;
513
514 err:
515         blk_mq_sched_tags_teardown(q);
516         q->elevator = NULL;
517         return ret;
518 }
519
520 void blk_mq_exit_sched(struct request_queue *q, struct elevator_queue *e)
521 {
522         struct blk_mq_hw_ctx *hctx;
523         unsigned int i;
524
525         queue_for_each_hw_ctx(q, hctx, i) {
526                 blk_mq_debugfs_unregister_sched_hctx(hctx);
527                 if (e->type->ops.mq.exit_hctx && hctx->sched_data) {
528                         e->type->ops.mq.exit_hctx(hctx, i);
529                         hctx->sched_data = NULL;
530                 }
531         }
532         blk_mq_debugfs_unregister_sched(q);
533         if (e->type->ops.mq.exit_sched)
534                 e->type->ops.mq.exit_sched(e);
535         blk_mq_sched_tags_teardown(q);
536         q->elevator = NULL;
537 }
538
539 int blk_mq_sched_init(struct request_queue *q)
540 {
541         int ret;
542
543         mutex_lock(&q->sysfs_lock);
544         ret = elevator_init(q, NULL);
545         mutex_unlock(&q->sysfs_lock);
546
547         return ret;
548 }