1 // SPDX-License-Identifier: GPL-2.0
3 * Block device elevator/IO-scheduler.
5 * Copyright (C) 2000 Andrea Arcangeli <andrea@suse.de> SuSE
7 * 30042000 Jens Axboe <axboe@kernel.dk> :
9 * Split the elevator a bit so that it is possible to choose a different
10 * one or even write a new "plug in". There are three pieces:
11 * - elevator_fn, inserts a new request in the queue list
12 * - elevator_merge_fn, decides whether a new buffer can be merged with
14 * - elevator_dequeue_fn, called when a request is taken off the active list
16 * 20082000 Dave Jones <davej@suse.de> :
17 * Removed tests for max-bomb-segments, which was breaking elvtune
18 * when run without -bN
21 * - Rework again to work with bio instead of buffer_heads
22 * - loose bi_dev comparisons, partition handling is right now
23 * - completely modularize elevator setup and teardown
26 #include <linux/kernel.h>
28 #include <linux/blkdev.h>
29 #include <linux/bio.h>
30 #include <linux/module.h>
31 #include <linux/slab.h>
32 #include <linux/init.h>
33 #include <linux/compiler.h>
34 #include <linux/blktrace_api.h>
35 #include <linux/hash.h>
36 #include <linux/uaccess.h>
37 #include <linux/pm_runtime.h>
39 #include <trace/events/block.h>
43 #include "blk-mq-sched.h"
46 #include "blk-cgroup.h"
48 /* Holding context data for changing elevator */
49 struct elv_change_ctx {
53 /* for unregistering old elevator */
54 struct elevator_queue *old;
55 /* for registering new elevator */
56 struct elevator_queue *new;
59 static DEFINE_SPINLOCK(elv_list_lock);
60 static LIST_HEAD(elv_list);
65 #define rq_hash_key(rq) (blk_rq_pos(rq) + blk_rq_sectors(rq))
68 * Query io scheduler to see if the current process issuing bio may be
71 static bool elv_iosched_allow_bio_merge(struct request *rq, struct bio *bio)
73 struct request_queue *q = rq->q;
74 struct elevator_queue *e = q->elevator;
76 if (e->type->ops.allow_merge)
77 return e->type->ops.allow_merge(q, rq, bio);
83 * can we safely merge with this request?
85 bool elv_bio_merge_ok(struct request *rq, struct bio *bio)
87 if (!blk_rq_merge_ok(rq, bio))
90 if (!elv_iosched_allow_bio_merge(rq, bio))
95 EXPORT_SYMBOL(elv_bio_merge_ok);
98 * elevator_match - Check whether @e's name or alias matches @name
99 * @e: Scheduler to test
100 * @name: Elevator name to test
102 * Return true if the elevator @e's name or alias matches @name.
104 static bool elevator_match(const struct elevator_type *e, const char *name)
106 return !strcmp(e->elevator_name, name) ||
107 (e->elevator_alias && !strcmp(e->elevator_alias, name));
110 static struct elevator_type *__elevator_find(const char *name)
112 struct elevator_type *e;
114 list_for_each_entry(e, &elv_list, list)
115 if (elevator_match(e, name))
120 static struct elevator_type *elevator_find_get(const char *name)
122 struct elevator_type *e;
124 spin_lock(&elv_list_lock);
125 e = __elevator_find(name);
126 if (e && (!elevator_tryget(e)))
128 spin_unlock(&elv_list_lock);
132 static const struct kobj_type elv_ktype;
134 struct elevator_queue *elevator_alloc(struct request_queue *q,
135 struct elevator_type *e)
137 struct elevator_queue *eq;
139 eq = kzalloc_node(sizeof(*eq), GFP_KERNEL, q->node);
145 kobject_init(&eq->kobj, &elv_ktype);
146 mutex_init(&eq->sysfs_lock);
151 EXPORT_SYMBOL(elevator_alloc);
153 static void elevator_release(struct kobject *kobj)
155 struct elevator_queue *e;
157 e = container_of(kobj, struct elevator_queue, kobj);
158 elevator_put(e->type);
162 static void elevator_exit(struct request_queue *q)
164 struct elevator_queue *e = q->elevator;
166 lockdep_assert_held(&q->elevator_lock);
169 blk_mq_sched_free_rqs(q);
171 mutex_lock(&e->sysfs_lock);
172 blk_mq_exit_sched(q, e);
173 mutex_unlock(&e->sysfs_lock);
176 static inline void __elv_rqhash_del(struct request *rq)
179 rq->rq_flags &= ~RQF_HASHED;
182 void elv_rqhash_del(struct request_queue *q, struct request *rq)
185 __elv_rqhash_del(rq);
187 EXPORT_SYMBOL_GPL(elv_rqhash_del);
189 void elv_rqhash_add(struct request_queue *q, struct request *rq)
191 struct elevator_queue *e = q->elevator;
193 BUG_ON(ELV_ON_HASH(rq));
194 hash_add(e->hash, &rq->hash, rq_hash_key(rq));
195 rq->rq_flags |= RQF_HASHED;
197 EXPORT_SYMBOL_GPL(elv_rqhash_add);
199 void elv_rqhash_reposition(struct request_queue *q, struct request *rq)
201 __elv_rqhash_del(rq);
202 elv_rqhash_add(q, rq);
205 struct request *elv_rqhash_find(struct request_queue *q, sector_t offset)
207 struct elevator_queue *e = q->elevator;
208 struct hlist_node *next;
211 hash_for_each_possible_safe(e->hash, rq, next, hash, offset) {
212 BUG_ON(!ELV_ON_HASH(rq));
214 if (unlikely(!rq_mergeable(rq))) {
215 __elv_rqhash_del(rq);
219 if (rq_hash_key(rq) == offset)
227 * RB-tree support functions for inserting/lookup/removal of requests
228 * in a sorted RB tree.
230 void elv_rb_add(struct rb_root *root, struct request *rq)
232 struct rb_node **p = &root->rb_node;
233 struct rb_node *parent = NULL;
234 struct request *__rq;
238 __rq = rb_entry(parent, struct request, rb_node);
240 if (blk_rq_pos(rq) < blk_rq_pos(__rq))
242 else if (blk_rq_pos(rq) >= blk_rq_pos(__rq))
246 rb_link_node(&rq->rb_node, parent, p);
247 rb_insert_color(&rq->rb_node, root);
249 EXPORT_SYMBOL(elv_rb_add);
251 void elv_rb_del(struct rb_root *root, struct request *rq)
253 BUG_ON(RB_EMPTY_NODE(&rq->rb_node));
254 rb_erase(&rq->rb_node, root);
255 RB_CLEAR_NODE(&rq->rb_node);
257 EXPORT_SYMBOL(elv_rb_del);
259 struct request *elv_rb_find(struct rb_root *root, sector_t sector)
261 struct rb_node *n = root->rb_node;
265 rq = rb_entry(n, struct request, rb_node);
267 if (sector < blk_rq_pos(rq))
269 else if (sector > blk_rq_pos(rq))
277 EXPORT_SYMBOL(elv_rb_find);
279 enum elv_merge elv_merge(struct request_queue *q, struct request **req,
282 struct elevator_queue *e = q->elevator;
283 struct request *__rq;
287 * nomerges: No merges at all attempted
288 * noxmerges: Only simple one-hit cache try
289 * merges: All merge tries attempted
291 if (blk_queue_nomerges(q) || !bio_mergeable(bio))
292 return ELEVATOR_NO_MERGE;
295 * First try one-hit cache.
297 if (q->last_merge && elv_bio_merge_ok(q->last_merge, bio)) {
298 enum elv_merge ret = blk_try_merge(q->last_merge, bio);
300 if (ret != ELEVATOR_NO_MERGE) {
301 *req = q->last_merge;
306 if (blk_queue_noxmerges(q))
307 return ELEVATOR_NO_MERGE;
310 * See if our hash lookup can find a potential backmerge.
312 __rq = elv_rqhash_find(q, bio->bi_iter.bi_sector);
313 if (__rq && elv_bio_merge_ok(__rq, bio)) {
316 if (blk_discard_mergable(__rq))
317 return ELEVATOR_DISCARD_MERGE;
318 return ELEVATOR_BACK_MERGE;
321 if (e->type->ops.request_merge)
322 return e->type->ops.request_merge(q, req, bio);
324 return ELEVATOR_NO_MERGE;
328 * Attempt to do an insertion back merge. Only check for the case where
329 * we can append 'rq' to an existing request, so we can throw 'rq' away
332 * Returns true if we merged, false otherwise. 'free' will contain all
333 * requests that need to be freed.
335 bool elv_attempt_insert_merge(struct request_queue *q, struct request *rq,
336 struct list_head *free)
338 struct request *__rq;
341 if (blk_queue_nomerges(q))
345 * First try one-hit cache.
347 if (q->last_merge && blk_attempt_req_merge(q, q->last_merge, rq)) {
348 list_add(&rq->queuelist, free);
352 if (blk_queue_noxmerges(q))
357 * See if our hash lookup can find a potential backmerge.
360 __rq = elv_rqhash_find(q, blk_rq_pos(rq));
361 if (!__rq || !blk_attempt_req_merge(q, __rq, rq))
364 list_add(&rq->queuelist, free);
365 /* The merged request could be merged with others, try again */
373 void elv_merged_request(struct request_queue *q, struct request *rq,
376 struct elevator_queue *e = q->elevator;
378 if (e->type->ops.request_merged)
379 e->type->ops.request_merged(q, rq, type);
381 if (type == ELEVATOR_BACK_MERGE)
382 elv_rqhash_reposition(q, rq);
387 void elv_merge_requests(struct request_queue *q, struct request *rq,
388 struct request *next)
390 struct elevator_queue *e = q->elevator;
392 if (e->type->ops.requests_merged)
393 e->type->ops.requests_merged(q, rq, next);
395 elv_rqhash_reposition(q, rq);
399 struct request *elv_latter_request(struct request_queue *q, struct request *rq)
401 struct elevator_queue *e = q->elevator;
403 if (e->type->ops.next_request)
404 return e->type->ops.next_request(q, rq);
409 struct request *elv_former_request(struct request_queue *q, struct request *rq)
411 struct elevator_queue *e = q->elevator;
413 if (e->type->ops.former_request)
414 return e->type->ops.former_request(q, rq);
419 #define to_elv(atr) container_of_const((atr), struct elv_fs_entry, attr)
422 elv_attr_show(struct kobject *kobj, struct attribute *attr, char *page)
424 const struct elv_fs_entry *entry = to_elv(attr);
425 struct elevator_queue *e;
426 ssize_t error = -ENODEV;
431 e = container_of(kobj, struct elevator_queue, kobj);
432 mutex_lock(&e->sysfs_lock);
433 if (!test_bit(ELEVATOR_FLAG_DYING, &e->flags))
434 error = entry->show(e, page);
435 mutex_unlock(&e->sysfs_lock);
440 elv_attr_store(struct kobject *kobj, struct attribute *attr,
441 const char *page, size_t length)
443 const struct elv_fs_entry *entry = to_elv(attr);
444 struct elevator_queue *e;
445 ssize_t error = -ENODEV;
450 e = container_of(kobj, struct elevator_queue, kobj);
451 mutex_lock(&e->sysfs_lock);
452 if (!test_bit(ELEVATOR_FLAG_DYING, &e->flags))
453 error = entry->store(e, page, length);
454 mutex_unlock(&e->sysfs_lock);
458 static const struct sysfs_ops elv_sysfs_ops = {
459 .show = elv_attr_show,
460 .store = elv_attr_store,
463 static const struct kobj_type elv_ktype = {
464 .sysfs_ops = &elv_sysfs_ops,
465 .release = elevator_release,
468 static int elv_register_queue(struct request_queue *q,
469 struct elevator_queue *e,
474 error = kobject_add(&e->kobj, &q->disk->queue_kobj, "iosched");
476 const struct elv_fs_entry *attr = e->type->elevator_attrs;
478 while (attr->attr.name) {
479 if (sysfs_create_file(&e->kobj, &attr->attr))
485 kobject_uevent(&e->kobj, KOBJ_ADD);
488 * Sched is initialized, it is ready to export it via
491 blk_mq_sched_reg_debugfs(q);
492 set_bit(ELEVATOR_FLAG_REGISTERED, &e->flags);
497 static void elv_unregister_queue(struct request_queue *q,
498 struct elevator_queue *e)
500 if (e && test_and_clear_bit(ELEVATOR_FLAG_REGISTERED, &e->flags)) {
501 kobject_uevent(&e->kobj, KOBJ_REMOVE);
502 kobject_del(&e->kobj);
504 /* unexport via debugfs before exiting sched */
505 blk_mq_sched_unreg_debugfs(q);
509 int elv_register(struct elevator_type *e)
511 /* finish request is mandatory */
512 if (WARN_ON_ONCE(!e->ops.finish_request))
514 /* insert_requests and dispatch_request are mandatory */
515 if (WARN_ON_ONCE(!e->ops.insert_requests || !e->ops.dispatch_request))
518 /* create icq_cache if requested */
520 if (WARN_ON(e->icq_size < sizeof(struct io_cq)) ||
521 WARN_ON(e->icq_align < __alignof__(struct io_cq)))
524 snprintf(e->icq_cache_name, sizeof(e->icq_cache_name),
525 "%s_io_cq", e->elevator_name);
526 e->icq_cache = kmem_cache_create(e->icq_cache_name, e->icq_size,
527 e->icq_align, 0, NULL);
532 /* register, don't allow duplicate names */
533 spin_lock(&elv_list_lock);
534 if (__elevator_find(e->elevator_name)) {
535 spin_unlock(&elv_list_lock);
536 kmem_cache_destroy(e->icq_cache);
539 list_add_tail(&e->list, &elv_list);
540 spin_unlock(&elv_list_lock);
542 printk(KERN_INFO "io scheduler %s registered\n", e->elevator_name);
546 EXPORT_SYMBOL_GPL(elv_register);
548 void elv_unregister(struct elevator_type *e)
551 spin_lock(&elv_list_lock);
552 list_del_init(&e->list);
553 spin_unlock(&elv_list_lock);
556 * Destroy icq_cache if it exists. icq's are RCU managed. Make
557 * sure all RCU operations are complete before proceeding.
561 kmem_cache_destroy(e->icq_cache);
565 EXPORT_SYMBOL_GPL(elv_unregister);
568 * Switch to new_e io scheduler.
570 * If switching fails, we are most likely running out of memory and not able
571 * to restore the old io scheduler, so leaving the io scheduler being none.
573 static int elevator_switch(struct request_queue *q, struct elv_change_ctx *ctx)
575 struct elevator_type *new_e = NULL;
578 WARN_ON_ONCE(q->mq_freeze_depth == 0);
579 lockdep_assert_held(&q->elevator_lock);
581 if (strncmp(ctx->name, "none", 4)) {
582 new_e = elevator_find_get(ctx->name);
587 blk_mq_quiesce_queue(q);
590 ctx->old = q->elevator;
595 ret = blk_mq_init_sched(q, new_e);
598 ctx->new = q->elevator;
600 blk_queue_flag_clear(QUEUE_FLAG_SQ_SCHED, q);
602 q->nr_requests = q->tag_set->queue_depth;
604 blk_add_trace_msg(q, "elv switch: %s", ctx->name);
607 blk_mq_unquiesce_queue(q);
610 pr_warn("elv: switch to \"%s\" failed, falling back to \"none\"\n",
611 new_e->elevator_name);
619 static void elv_exit_and_release(struct request_queue *q)
621 struct elevator_queue *e;
624 memflags = blk_mq_freeze_queue(q);
625 mutex_lock(&q->elevator_lock);
628 mutex_unlock(&q->elevator_lock);
629 blk_mq_unfreeze_queue(q, memflags);
631 kobject_put(&e->kobj);
634 static int elevator_change_done(struct request_queue *q,
635 struct elv_change_ctx *ctx)
640 bool enable_wbt = test_bit(ELEVATOR_FLAG_ENABLE_WBT_ON_EXIT,
643 elv_unregister_queue(q, ctx->old);
644 kobject_put(&ctx->old->kobj);
646 wbt_enable_default(q->disk);
649 ret = elv_register_queue(q, ctx->new, !ctx->no_uevent);
651 elv_exit_and_release(q);
657 * Switch this queue to the given IO scheduler.
659 static int elevator_change(struct request_queue *q, struct elv_change_ctx *ctx)
661 unsigned int memflags;
664 lockdep_assert_held(&q->tag_set->update_nr_hwq_lock);
666 memflags = blk_mq_freeze_queue(q);
668 * May be called before adding disk, when there isn't any FS I/O,
669 * so freezing queue plus canceling dispatch work is enough to
670 * drain any dispatch activities originated from passthrough
671 * requests, then no need to quiesce queue which may add long boot
672 * latency, especially when lots of disks are involved.
674 * Disk isn't added yet, so verifying queue lock only manually.
676 blk_mq_cancel_work_sync(q);
677 mutex_lock(&q->elevator_lock);
678 if (!(q->elevator && elevator_match(q->elevator->type, ctx->name)))
679 ret = elevator_switch(q, ctx);
680 mutex_unlock(&q->elevator_lock);
681 blk_mq_unfreeze_queue(q, memflags);
683 ret = elevator_change_done(q, ctx);
689 * The I/O scheduler depends on the number of hardware queues, this forces a
690 * reattachment when nr_hw_queues changes.
692 void elv_update_nr_hw_queues(struct request_queue *q)
694 struct elv_change_ctx ctx = {};
697 WARN_ON_ONCE(q->mq_freeze_depth == 0);
699 mutex_lock(&q->elevator_lock);
700 if (q->elevator && !blk_queue_dying(q) && blk_queue_registered(q)) {
701 ctx.name = q->elevator->type->elevator_name;
703 /* force to reattach elevator after nr_hw_queue is updated */
704 ret = elevator_switch(q, &ctx);
706 mutex_unlock(&q->elevator_lock);
707 blk_mq_unfreeze_queue_nomemrestore(q);
709 WARN_ON_ONCE(elevator_change_done(q, &ctx));
713 * Use the default elevator settings. If the chosen elevator initialization
714 * fails, fall back to the "none" elevator (no elevator).
716 void elevator_set_default(struct request_queue *q)
718 struct elv_change_ctx ctx = {
719 .name = "mq-deadline",
724 /* now we allow to switch elevator */
725 blk_queue_flag_clear(QUEUE_FLAG_NO_ELV_SWITCH, q);
727 if (q->tag_set->flags & BLK_MQ_F_NO_SCHED_BY_DEFAULT)
731 * For single queue devices, default to using mq-deadline. If we
732 * have multiple queues or mq-deadline is not available, default
735 if (elevator_find_get(ctx.name) && (q->nr_hw_queues == 1 ||
736 blk_mq_is_shared_tags(q->tag_set->flags)))
737 err = elevator_change(q, &ctx);
739 pr_warn("\"%s\" elevator initialization, failed %d, "
740 "falling back to \"none\"\n", ctx.name, err);
743 void elevator_set_none(struct request_queue *q)
745 struct elv_change_ctx ctx = {
750 err = elevator_change(q, &ctx);
752 pr_warn("%s: set none elevator failed %d\n", __func__, err);
755 static void elv_iosched_load_module(const char *elevator_name)
757 struct elevator_type *found;
759 spin_lock(&elv_list_lock);
760 found = __elevator_find(elevator_name);
761 spin_unlock(&elv_list_lock);
764 request_module("%s-iosched", elevator_name);
767 ssize_t elv_iosched_store(struct gendisk *disk, const char *buf,
770 char elevator_name[ELV_NAME_MAX];
771 struct elv_change_ctx ctx = {};
773 struct request_queue *q = disk->queue;
774 struct blk_mq_tag_set *set = q->tag_set;
776 /* Make sure queue is not in the middle of being removed */
777 if (!blk_queue_registered(q))
781 * If the attribute needs to load a module, do it before freezing the
782 * queue to ensure that the module file can be read when the request
783 * queue is the one for the device storing the module file.
785 strscpy(elevator_name, buf, sizeof(elevator_name));
786 ctx.name = strstrip(elevator_name);
788 elv_iosched_load_module(ctx.name);
790 down_read(&set->update_nr_hwq_lock);
791 if (!blk_queue_no_elv_switch(q)) {
792 ret = elevator_change(q, &ctx);
798 up_read(&set->update_nr_hwq_lock);
802 ssize_t elv_iosched_show(struct gendisk *disk, char *name)
804 struct request_queue *q = disk->queue;
805 struct elevator_type *cur = NULL, *e;
808 mutex_lock(&q->elevator_lock);
810 len += sprintf(name+len, "[none] ");
812 len += sprintf(name+len, "none ");
813 cur = q->elevator->type;
816 spin_lock(&elv_list_lock);
817 list_for_each_entry(e, &elv_list, list) {
819 len += sprintf(name+len, "[%s] ", e->elevator_name);
821 len += sprintf(name+len, "%s ", e->elevator_name);
823 spin_unlock(&elv_list_lock);
825 len += sprintf(name+len, "\n");
826 mutex_unlock(&q->elevator_lock);
831 struct request *elv_rb_former_request(struct request_queue *q,
834 struct rb_node *rbprev = rb_prev(&rq->rb_node);
837 return rb_entry_rq(rbprev);
841 EXPORT_SYMBOL(elv_rb_former_request);
843 struct request *elv_rb_latter_request(struct request_queue *q,
846 struct rb_node *rbnext = rb_next(&rq->rb_node);
849 return rb_entry_rq(rbnext);
853 EXPORT_SYMBOL(elv_rb_latter_request);
855 static int __init elevator_setup(char *str)
857 pr_warn("Kernel parameter elevator= does not have any effect anymore.\n"
858 "Please use sysfs to set IO scheduler for individual devices.\n");
862 __setup("elevator=", elevator_setup);