2 * blk-mq scheduling framework
4 * Copyright (C) 2016 Jens Axboe
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/blk-mq.h>
10 #include <trace/events/block.h>
14 #include "blk-mq-sched.h"
15 #include "blk-mq-tag.h"
18 void blk_mq_sched_free_hctx_data(struct request_queue *q,
19 void (*exit)(struct blk_mq_hw_ctx *))
21 struct blk_mq_hw_ctx *hctx;
24 queue_for_each_hw_ctx(q, hctx, i) {
25 if (exit && hctx->sched_data)
27 kfree(hctx->sched_data);
28 hctx->sched_data = NULL;
31 EXPORT_SYMBOL_GPL(blk_mq_sched_free_hctx_data);
33 int blk_mq_sched_init_hctx_data(struct request_queue *q, size_t size,
34 int (*init)(struct blk_mq_hw_ctx *),
35 void (*exit)(struct blk_mq_hw_ctx *))
37 struct blk_mq_hw_ctx *hctx;
41 queue_for_each_hw_ctx(q, hctx, i) {
42 hctx->sched_data = kmalloc_node(size, GFP_KERNEL, hctx->numa_node);
43 if (!hctx->sched_data) {
52 * We don't want to give exit() a partially
53 * initialized sched_data. init() must clean up
56 kfree(hctx->sched_data);
57 hctx->sched_data = NULL;
65 blk_mq_sched_free_hctx_data(q, exit);
68 EXPORT_SYMBOL_GPL(blk_mq_sched_init_hctx_data);
70 static void __blk_mq_sched_assign_ioc(struct request_queue *q,
73 struct io_context *ioc)
77 spin_lock_irq(q->queue_lock);
78 icq = ioc_lookup_icq(ioc, q);
79 spin_unlock_irq(q->queue_lock);
82 icq = ioc_create_icq(ioc, q, GFP_ATOMIC);
88 if (!blk_mq_sched_get_rq_priv(q, rq, bio)) {
89 rq->rq_flags |= RQF_ELVPRIV;
90 get_io_context(icq->ioc);
97 static void blk_mq_sched_assign_ioc(struct request_queue *q,
98 struct request *rq, struct bio *bio)
100 struct io_context *ioc;
104 __blk_mq_sched_assign_ioc(q, rq, bio, ioc);
107 struct request *blk_mq_sched_get_request(struct request_queue *q,
110 struct blk_mq_alloc_data *data)
112 struct elevator_queue *e = q->elevator;
113 struct blk_mq_hw_ctx *hctx;
114 struct blk_mq_ctx *ctx;
117 blk_queue_enter_live(q);
118 ctx = blk_mq_get_ctx(q);
119 hctx = blk_mq_map_queue(q, ctx->cpu);
121 blk_mq_set_alloc_data(data, q, data->flags, ctx, hctx);
124 data->flags |= BLK_MQ_REQ_INTERNAL;
127 * Flush requests are special and go directly to the
130 if (!op_is_flush(op) && e->type->ops.mq.get_request) {
131 rq = e->type->ops.mq.get_request(q, op, data);
133 rq->rq_flags |= RQF_QUEUED;
135 rq = __blk_mq_alloc_request(data, op);
137 rq = __blk_mq_alloc_request(data, op);
139 data->hctx->tags->rqs[rq->tag] = rq;
143 if (!op_is_flush(op)) {
145 if (e && e->type->icq_cache)
146 blk_mq_sched_assign_ioc(q, rq, bio);
148 data->hctx->queued++;
156 void blk_mq_sched_put_request(struct request *rq)
158 struct request_queue *q = rq->q;
159 struct elevator_queue *e = q->elevator;
161 if (rq->rq_flags & RQF_ELVPRIV) {
162 blk_mq_sched_put_rq_priv(rq->q, rq);
164 put_io_context(rq->elv.icq->ioc);
169 if ((rq->rq_flags & RQF_QUEUED) && e && e->type->ops.mq.put_request)
170 e->type->ops.mq.put_request(rq);
172 blk_mq_finish_request(rq);
175 void blk_mq_sched_dispatch_requests(struct blk_mq_hw_ctx *hctx)
177 struct elevator_queue *e = hctx->queue->elevator;
178 const bool has_sched_dispatch = e && e->type->ops.mq.dispatch_request;
179 bool did_work = false;
182 if (unlikely(blk_mq_hctx_stopped(hctx)))
188 * If we have previous entries on our dispatch list, grab them first for
189 * more fair dispatch.
191 if (!list_empty_careful(&hctx->dispatch)) {
192 spin_lock(&hctx->lock);
193 if (!list_empty(&hctx->dispatch))
194 list_splice_init(&hctx->dispatch, &rq_list);
195 spin_unlock(&hctx->lock);
199 * Only ask the scheduler for requests, if we didn't have residual
200 * requests from the dispatch list. This is to avoid the case where
201 * we only ever dispatch a fraction of the requests available because
202 * of low device queue depth. Once we pull requests out of the IO
203 * scheduler, we can no longer merge or sort them. So it's best to
204 * leave them there for as long as we can. Mark the hw queue as
205 * needing a restart in that case.
207 if (!list_empty(&rq_list)) {
208 blk_mq_sched_mark_restart(hctx);
209 did_work = blk_mq_dispatch_rq_list(hctx, &rq_list);
210 } else if (!has_sched_dispatch) {
211 blk_mq_flush_busy_ctxs(hctx, &rq_list);
212 blk_mq_dispatch_rq_list(hctx, &rq_list);
216 * We want to dispatch from the scheduler if we had no work left
217 * on the dispatch list, OR if we did have work but weren't able
220 if (!did_work && has_sched_dispatch) {
224 rq = e->type->ops.mq.dispatch_request(hctx);
227 list_add(&rq->queuelist, &rq_list);
228 } while (blk_mq_dispatch_rq_list(hctx, &rq_list));
232 void blk_mq_sched_move_to_dispatch(struct blk_mq_hw_ctx *hctx,
233 struct list_head *rq_list,
234 struct request *(*get_rq)(struct blk_mq_hw_ctx *))
243 list_add_tail(&rq->queuelist, rq_list);
246 EXPORT_SYMBOL_GPL(blk_mq_sched_move_to_dispatch);
248 bool blk_mq_sched_try_merge(struct request_queue *q, struct bio *bio,
249 struct request **merged_request)
253 switch (elv_merge(q, &rq, bio)) {
254 case ELEVATOR_BACK_MERGE:
255 if (!blk_mq_sched_allow_merge(q, rq, bio))
257 if (!bio_attempt_back_merge(q, rq, bio))
259 *merged_request = attempt_back_merge(q, rq);
260 if (!*merged_request)
261 elv_merged_request(q, rq, ELEVATOR_BACK_MERGE);
263 case ELEVATOR_FRONT_MERGE:
264 if (!blk_mq_sched_allow_merge(q, rq, bio))
266 if (!bio_attempt_front_merge(q, rq, bio))
268 *merged_request = attempt_front_merge(q, rq);
269 if (!*merged_request)
270 elv_merged_request(q, rq, ELEVATOR_FRONT_MERGE);
276 EXPORT_SYMBOL_GPL(blk_mq_sched_try_merge);
278 bool __blk_mq_sched_bio_merge(struct request_queue *q, struct bio *bio)
280 struct elevator_queue *e = q->elevator;
282 if (e->type->ops.mq.bio_merge) {
283 struct blk_mq_ctx *ctx = blk_mq_get_ctx(q);
284 struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
287 return e->type->ops.mq.bio_merge(hctx, bio);
293 bool blk_mq_sched_try_insert_merge(struct request_queue *q, struct request *rq)
295 return rq_mergeable(rq) && elv_attempt_insert_merge(q, rq);
297 EXPORT_SYMBOL_GPL(blk_mq_sched_try_insert_merge);
299 void blk_mq_sched_request_inserted(struct request *rq)
301 trace_block_rq_insert(rq->q, rq);
303 EXPORT_SYMBOL_GPL(blk_mq_sched_request_inserted);
305 static bool blk_mq_sched_bypass_insert(struct blk_mq_hw_ctx *hctx,
309 rq->rq_flags |= RQF_SORTED;
314 * If we already have a real request tag, send directly to
317 spin_lock(&hctx->lock);
318 list_add(&rq->queuelist, &hctx->dispatch);
319 spin_unlock(&hctx->lock);
323 static void blk_mq_sched_restart_hctx(struct blk_mq_hw_ctx *hctx)
325 if (test_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state)) {
326 clear_bit(BLK_MQ_S_SCHED_RESTART, &hctx->state);
327 if (blk_mq_hctx_has_pending(hctx))
328 blk_mq_run_hw_queue(hctx, true);
332 void blk_mq_sched_restart_queues(struct blk_mq_hw_ctx *hctx)
336 if (!(hctx->flags & BLK_MQ_F_TAG_SHARED))
337 blk_mq_sched_restart_hctx(hctx);
339 struct request_queue *q = hctx->queue;
341 if (!test_bit(QUEUE_FLAG_RESTART, &q->queue_flags))
344 clear_bit(QUEUE_FLAG_RESTART, &q->queue_flags);
346 queue_for_each_hw_ctx(q, hctx, i)
347 blk_mq_sched_restart_hctx(hctx);
352 * Add flush/fua to the queue. If we fail getting a driver tag, then
353 * punt to the requeue list. Requeue will re-invoke us from a context
354 * that's safe to block from.
356 static void blk_mq_sched_insert_flush(struct blk_mq_hw_ctx *hctx,
357 struct request *rq, bool can_block)
359 if (blk_mq_get_driver_tag(rq, &hctx, can_block)) {
360 blk_insert_flush(rq);
361 blk_mq_run_hw_queue(hctx, true);
363 blk_mq_add_to_requeue_list(rq, false, true);
366 void blk_mq_sched_insert_request(struct request *rq, bool at_head,
367 bool run_queue, bool async, bool can_block)
369 struct request_queue *q = rq->q;
370 struct elevator_queue *e = q->elevator;
371 struct blk_mq_ctx *ctx = rq->mq_ctx;
372 struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
374 if (rq->tag == -1 && op_is_flush(rq->cmd_flags)) {
375 blk_mq_sched_insert_flush(hctx, rq, can_block);
379 if (e && blk_mq_sched_bypass_insert(hctx, rq))
382 if (e && e->type->ops.mq.insert_requests) {
385 list_add(&rq->queuelist, &list);
386 e->type->ops.mq.insert_requests(hctx, &list, at_head);
388 spin_lock(&ctx->lock);
389 __blk_mq_insert_request(hctx, rq, at_head);
390 spin_unlock(&ctx->lock);
395 blk_mq_run_hw_queue(hctx, async);
398 void blk_mq_sched_insert_requests(struct request_queue *q,
399 struct blk_mq_ctx *ctx,
400 struct list_head *list, bool run_queue_async)
402 struct blk_mq_hw_ctx *hctx = blk_mq_map_queue(q, ctx->cpu);
403 struct elevator_queue *e = hctx->queue->elevator;
406 struct request *rq, *next;
409 * We bypass requests that already have a driver tag assigned,
410 * which should only be flushes. Flushes are only ever inserted
411 * as single requests, so we shouldn't ever hit the
412 * WARN_ON_ONCE() below (but let's handle it just in case).
414 list_for_each_entry_safe(rq, next, list, queuelist) {
415 if (WARN_ON_ONCE(rq->tag != -1)) {
416 list_del_init(&rq->queuelist);
417 blk_mq_sched_bypass_insert(hctx, rq);
422 if (e && e->type->ops.mq.insert_requests)
423 e->type->ops.mq.insert_requests(hctx, list, false);
425 blk_mq_insert_requests(hctx, ctx, list);
427 blk_mq_run_hw_queue(hctx, run_queue_async);
430 static void blk_mq_sched_free_tags(struct blk_mq_tag_set *set,
431 struct blk_mq_hw_ctx *hctx,
432 unsigned int hctx_idx)
434 if (hctx->sched_tags) {
435 blk_mq_free_rqs(set, hctx->sched_tags, hctx_idx);
436 blk_mq_free_rq_map(hctx->sched_tags);
437 hctx->sched_tags = NULL;
441 int blk_mq_sched_setup(struct request_queue *q)
443 struct blk_mq_tag_set *set = q->tag_set;
444 struct blk_mq_hw_ctx *hctx;
448 * Default to 256, since we don't split into sync/async like the
449 * old code did. Additionally, this is a per-hw queue depth.
451 q->nr_requests = 2 * BLKDEV_MAX_RQ;
454 * We're switching to using an IO scheduler, so setup the hctx
455 * scheduler tags and switch the request map from the regular
456 * tags to scheduler tags. First allocate what we need, so we
457 * can safely fail and fallback, if needed.
460 queue_for_each_hw_ctx(q, hctx, i) {
461 hctx->sched_tags = blk_mq_alloc_rq_map(set, i, q->nr_requests, 0);
462 if (!hctx->sched_tags) {
466 ret = blk_mq_alloc_rqs(set, hctx->sched_tags, i, q->nr_requests);
472 * If we failed, free what we did allocate
475 queue_for_each_hw_ctx(q, hctx, i) {
476 if (!hctx->sched_tags)
478 blk_mq_sched_free_tags(set, hctx, i);
487 void blk_mq_sched_teardown(struct request_queue *q)
489 struct blk_mq_tag_set *set = q->tag_set;
490 struct blk_mq_hw_ctx *hctx;
493 queue_for_each_hw_ctx(q, hctx, i)
494 blk_mq_sched_free_tags(set, hctx, i);
497 int blk_mq_sched_init(struct request_queue *q)
501 #if defined(CONFIG_DEFAULT_SQ_NONE)
502 if (q->nr_hw_queues == 1)
505 #if defined(CONFIG_DEFAULT_MQ_NONE)
506 if (q->nr_hw_queues > 1)
510 mutex_lock(&q->sysfs_lock);
511 ret = elevator_init(q, NULL);
512 mutex_unlock(&q->sysfs_lock);