block: remove legacy IO schedulers
[sfrench/cifs-2.6.git] / block / elevator.c
1 /*
2  *  Block device elevator/IO-scheduler.
3  *
4  *  Copyright (C) 2000 Andrea Arcangeli <andrea@suse.de> SuSE
5  *
6  * 30042000 Jens Axboe <axboe@kernel.dk> :
7  *
8  * Split the elevator a bit so that it is possible to choose a different
9  * one or even write a new "plug in". There are three pieces:
10  * - elevator_fn, inserts a new request in the queue list
11  * - elevator_merge_fn, decides whether a new buffer can be merged with
12  *   an existing request
13  * - elevator_dequeue_fn, called when a request is taken off the active list
14  *
15  * 20082000 Dave Jones <davej@suse.de> :
16  * Removed tests for max-bomb-segments, which was breaking elvtune
17  *  when run without -bN
18  *
19  * Jens:
20  * - Rework again to work with bio instead of buffer_heads
21  * - loose bi_dev comparisons, partition handling is right now
22  * - completely modularize elevator setup and teardown
23  *
24  */
25 #include <linux/kernel.h>
26 #include <linux/fs.h>
27 #include <linux/blkdev.h>
28 #include <linux/elevator.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>
38 #include <linux/blk-cgroup.h>
39
40 #include <trace/events/block.h>
41
42 #include "blk.h"
43 #include "blk-mq-sched.h"
44 #include "blk-pm.h"
45 #include "blk-wbt.h"
46
47 static DEFINE_SPINLOCK(elv_list_lock);
48 static LIST_HEAD(elv_list);
49
50 /*
51  * Merge hash stuff.
52  */
53 #define rq_hash_key(rq)         (blk_rq_pos(rq) + blk_rq_sectors(rq))
54
55 /*
56  * Query io scheduler to see if the current process issuing bio may be
57  * merged with rq.
58  */
59 static int elv_iosched_allow_bio_merge(struct request *rq, struct bio *bio)
60 {
61         struct request_queue *q = rq->q;
62         struct elevator_queue *e = q->elevator;
63
64         if (e->uses_mq && e->type->ops.mq.allow_merge)
65                 return e->type->ops.mq.allow_merge(q, rq, bio);
66         else if (!e->uses_mq && e->type->ops.sq.elevator_allow_bio_merge_fn)
67                 return e->type->ops.sq.elevator_allow_bio_merge_fn(q, rq, bio);
68
69         return 1;
70 }
71
72 /*
73  * can we safely merge with this request?
74  */
75 bool elv_bio_merge_ok(struct request *rq, struct bio *bio)
76 {
77         if (!blk_rq_merge_ok(rq, bio))
78                 return false;
79
80         if (!elv_iosched_allow_bio_merge(rq, bio))
81                 return false;
82
83         return true;
84 }
85 EXPORT_SYMBOL(elv_bio_merge_ok);
86
87 static bool elevator_match(const struct elevator_type *e, const char *name)
88 {
89         if (!strcmp(e->elevator_name, name))
90                 return true;
91         if (e->elevator_alias && !strcmp(e->elevator_alias, name))
92                 return true;
93
94         return false;
95 }
96
97 /*
98  * Return scheduler with name 'name' and with matching 'mq capability
99  */
100 static struct elevator_type *elevator_find(const char *name, bool mq)
101 {
102         struct elevator_type *e;
103
104         list_for_each_entry(e, &elv_list, list) {
105                 if (elevator_match(e, name) && (mq == e->uses_mq))
106                         return e;
107         }
108
109         return NULL;
110 }
111
112 static void elevator_put(struct elevator_type *e)
113 {
114         module_put(e->elevator_owner);
115 }
116
117 static struct elevator_type *elevator_get(struct request_queue *q,
118                                           const char *name, bool try_loading)
119 {
120         struct elevator_type *e;
121
122         spin_lock(&elv_list_lock);
123
124         e = elevator_find(name, q->mq_ops != NULL);
125         if (!e && try_loading) {
126                 spin_unlock(&elv_list_lock);
127                 request_module("%s-iosched", name);
128                 spin_lock(&elv_list_lock);
129                 e = elevator_find(name, q->mq_ops != NULL);
130         }
131
132         if (e && !try_module_get(e->elevator_owner))
133                 e = NULL;
134
135         spin_unlock(&elv_list_lock);
136         return e;
137 }
138
139 static char chosen_elevator[ELV_NAME_MAX];
140
141 static int __init elevator_setup(char *str)
142 {
143         /*
144          * Be backwards-compatible with previous kernels, so users
145          * won't get the wrong elevator.
146          */
147         strncpy(chosen_elevator, str, sizeof(chosen_elevator) - 1);
148         return 1;
149 }
150
151 __setup("elevator=", elevator_setup);
152
153 /* called during boot to load the elevator chosen by the elevator param */
154 void __init load_default_elevator_module(void)
155 {
156         struct elevator_type *e;
157
158         if (!chosen_elevator[0])
159                 return;
160
161         /*
162          * Boot parameter is deprecated, we haven't supported that for MQ.
163          * Only look for non-mq schedulers from here.
164          */
165         spin_lock(&elv_list_lock);
166         e = elevator_find(chosen_elevator, false);
167         spin_unlock(&elv_list_lock);
168
169         if (!e)
170                 request_module("%s-iosched", chosen_elevator);
171 }
172
173 static struct kobj_type elv_ktype;
174
175 struct elevator_queue *elevator_alloc(struct request_queue *q,
176                                   struct elevator_type *e)
177 {
178         struct elevator_queue *eq;
179
180         eq = kzalloc_node(sizeof(*eq), GFP_KERNEL, q->node);
181         if (unlikely(!eq))
182                 return NULL;
183
184         eq->type = e;
185         kobject_init(&eq->kobj, &elv_ktype);
186         mutex_init(&eq->sysfs_lock);
187         hash_init(eq->hash);
188         eq->uses_mq = e->uses_mq;
189
190         return eq;
191 }
192 EXPORT_SYMBOL(elevator_alloc);
193
194 static void elevator_release(struct kobject *kobj)
195 {
196         struct elevator_queue *e;
197
198         e = container_of(kobj, struct elevator_queue, kobj);
199         elevator_put(e->type);
200         kfree(e);
201 }
202
203 /*
204  * Use the default elevator specified by config boot param for non-mq devices,
205  * or by config option.  Don't try to load modules as we could be running off
206  * async and request_module() isn't allowed from async.
207  */
208 int elevator_init(struct request_queue *q)
209 {
210         struct elevator_type *e = NULL;
211         int err = 0;
212
213         /*
214          * q->sysfs_lock must be held to provide mutual exclusion between
215          * elevator_switch() and here.
216          */
217         mutex_lock(&q->sysfs_lock);
218         if (unlikely(q->elevator))
219                 goto out_unlock;
220
221         if (*chosen_elevator) {
222                 e = elevator_get(q, chosen_elevator, false);
223                 if (!e)
224                         printk(KERN_ERR "I/O scheduler %s not found\n",
225                                                         chosen_elevator);
226         }
227
228         if (!e) {
229                 printk(KERN_ERR
230                         "Default I/O scheduler not found. Using noop.\n");
231                 e = elevator_get(q, "noop", false);
232         }
233
234         err = e->ops.sq.elevator_init_fn(q, e);
235         if (err)
236                 elevator_put(e);
237 out_unlock:
238         mutex_unlock(&q->sysfs_lock);
239         return err;
240 }
241
242 void elevator_exit(struct request_queue *q, struct elevator_queue *e)
243 {
244         mutex_lock(&e->sysfs_lock);
245         if (e->uses_mq && e->type->ops.mq.exit_sched)
246                 blk_mq_exit_sched(q, e);
247         else if (!e->uses_mq && e->type->ops.sq.elevator_exit_fn)
248                 e->type->ops.sq.elevator_exit_fn(e);
249         mutex_unlock(&e->sysfs_lock);
250
251         kobject_put(&e->kobj);
252 }
253
254 static inline void __elv_rqhash_del(struct request *rq)
255 {
256         hash_del(&rq->hash);
257         rq->rq_flags &= ~RQF_HASHED;
258 }
259
260 void elv_rqhash_del(struct request_queue *q, struct request *rq)
261 {
262         if (ELV_ON_HASH(rq))
263                 __elv_rqhash_del(rq);
264 }
265 EXPORT_SYMBOL_GPL(elv_rqhash_del);
266
267 void elv_rqhash_add(struct request_queue *q, struct request *rq)
268 {
269         struct elevator_queue *e = q->elevator;
270
271         BUG_ON(ELV_ON_HASH(rq));
272         hash_add(e->hash, &rq->hash, rq_hash_key(rq));
273         rq->rq_flags |= RQF_HASHED;
274 }
275 EXPORT_SYMBOL_GPL(elv_rqhash_add);
276
277 void elv_rqhash_reposition(struct request_queue *q, struct request *rq)
278 {
279         __elv_rqhash_del(rq);
280         elv_rqhash_add(q, rq);
281 }
282
283 struct request *elv_rqhash_find(struct request_queue *q, sector_t offset)
284 {
285         struct elevator_queue *e = q->elevator;
286         struct hlist_node *next;
287         struct request *rq;
288
289         hash_for_each_possible_safe(e->hash, rq, next, hash, offset) {
290                 BUG_ON(!ELV_ON_HASH(rq));
291
292                 if (unlikely(!rq_mergeable(rq))) {
293                         __elv_rqhash_del(rq);
294                         continue;
295                 }
296
297                 if (rq_hash_key(rq) == offset)
298                         return rq;
299         }
300
301         return NULL;
302 }
303
304 /*
305  * RB-tree support functions for inserting/lookup/removal of requests
306  * in a sorted RB tree.
307  */
308 void elv_rb_add(struct rb_root *root, struct request *rq)
309 {
310         struct rb_node **p = &root->rb_node;
311         struct rb_node *parent = NULL;
312         struct request *__rq;
313
314         while (*p) {
315                 parent = *p;
316                 __rq = rb_entry(parent, struct request, rb_node);
317
318                 if (blk_rq_pos(rq) < blk_rq_pos(__rq))
319                         p = &(*p)->rb_left;
320                 else if (blk_rq_pos(rq) >= blk_rq_pos(__rq))
321                         p = &(*p)->rb_right;
322         }
323
324         rb_link_node(&rq->rb_node, parent, p);
325         rb_insert_color(&rq->rb_node, root);
326 }
327 EXPORT_SYMBOL(elv_rb_add);
328
329 void elv_rb_del(struct rb_root *root, struct request *rq)
330 {
331         BUG_ON(RB_EMPTY_NODE(&rq->rb_node));
332         rb_erase(&rq->rb_node, root);
333         RB_CLEAR_NODE(&rq->rb_node);
334 }
335 EXPORT_SYMBOL(elv_rb_del);
336
337 struct request *elv_rb_find(struct rb_root *root, sector_t sector)
338 {
339         struct rb_node *n = root->rb_node;
340         struct request *rq;
341
342         while (n) {
343                 rq = rb_entry(n, struct request, rb_node);
344
345                 if (sector < blk_rq_pos(rq))
346                         n = n->rb_left;
347                 else if (sector > blk_rq_pos(rq))
348                         n = n->rb_right;
349                 else
350                         return rq;
351         }
352
353         return NULL;
354 }
355 EXPORT_SYMBOL(elv_rb_find);
356
357 enum elv_merge elv_merge(struct request_queue *q, struct request **req,
358                 struct bio *bio)
359 {
360         struct elevator_queue *e = q->elevator;
361         struct request *__rq;
362
363         /*
364          * Levels of merges:
365          *      nomerges:  No merges at all attempted
366          *      noxmerges: Only simple one-hit cache try
367          *      merges:    All merge tries attempted
368          */
369         if (blk_queue_nomerges(q) || !bio_mergeable(bio))
370                 return ELEVATOR_NO_MERGE;
371
372         /*
373          * First try one-hit cache.
374          */
375         if (q->last_merge && elv_bio_merge_ok(q->last_merge, bio)) {
376                 enum elv_merge ret = blk_try_merge(q->last_merge, bio);
377
378                 if (ret != ELEVATOR_NO_MERGE) {
379                         *req = q->last_merge;
380                         return ret;
381                 }
382         }
383
384         if (blk_queue_noxmerges(q))
385                 return ELEVATOR_NO_MERGE;
386
387         /*
388          * See if our hash lookup can find a potential backmerge.
389          */
390         __rq = elv_rqhash_find(q, bio->bi_iter.bi_sector);
391         if (__rq && elv_bio_merge_ok(__rq, bio)) {
392                 *req = __rq;
393                 return ELEVATOR_BACK_MERGE;
394         }
395
396         if (e->uses_mq && e->type->ops.mq.request_merge)
397                 return e->type->ops.mq.request_merge(q, req, bio);
398         else if (!e->uses_mq && e->type->ops.sq.elevator_merge_fn)
399                 return e->type->ops.sq.elevator_merge_fn(q, req, bio);
400
401         return ELEVATOR_NO_MERGE;
402 }
403
404 /*
405  * Attempt to do an insertion back merge. Only check for the case where
406  * we can append 'rq' to an existing request, so we can throw 'rq' away
407  * afterwards.
408  *
409  * Returns true if we merged, false otherwise
410  */
411 bool elv_attempt_insert_merge(struct request_queue *q, struct request *rq)
412 {
413         struct request *__rq;
414         bool ret;
415
416         if (blk_queue_nomerges(q))
417                 return false;
418
419         /*
420          * First try one-hit cache.
421          */
422         if (q->last_merge && blk_attempt_req_merge(q, q->last_merge, rq))
423                 return true;
424
425         if (blk_queue_noxmerges(q))
426                 return false;
427
428         ret = false;
429         /*
430          * See if our hash lookup can find a potential backmerge.
431          */
432         while (1) {
433                 __rq = elv_rqhash_find(q, blk_rq_pos(rq));
434                 if (!__rq || !blk_attempt_req_merge(q, __rq, rq))
435                         break;
436
437                 /* The merged request could be merged with others, try again */
438                 ret = true;
439                 rq = __rq;
440         }
441
442         return ret;
443 }
444
445 void elv_merged_request(struct request_queue *q, struct request *rq,
446                 enum elv_merge type)
447 {
448         struct elevator_queue *e = q->elevator;
449
450         if (e->uses_mq && e->type->ops.mq.request_merged)
451                 e->type->ops.mq.request_merged(q, rq, type);
452         else if (!e->uses_mq && e->type->ops.sq.elevator_merged_fn)
453                 e->type->ops.sq.elevator_merged_fn(q, rq, type);
454
455         if (type == ELEVATOR_BACK_MERGE)
456                 elv_rqhash_reposition(q, rq);
457
458         q->last_merge = rq;
459 }
460
461 void elv_merge_requests(struct request_queue *q, struct request *rq,
462                              struct request *next)
463 {
464         struct elevator_queue *e = q->elevator;
465         bool next_sorted = false;
466
467         if (e->uses_mq && e->type->ops.mq.requests_merged)
468                 e->type->ops.mq.requests_merged(q, rq, next);
469         else if (e->type->ops.sq.elevator_merge_req_fn) {
470                 next_sorted = (__force bool)(next->rq_flags & RQF_SORTED);
471                 if (next_sorted)
472                         e->type->ops.sq.elevator_merge_req_fn(q, rq, next);
473         }
474
475         elv_rqhash_reposition(q, rq);
476
477         if (next_sorted) {
478                 elv_rqhash_del(q, next);
479                 q->nr_sorted--;
480         }
481
482         q->last_merge = rq;
483 }
484
485 void elv_bio_merged(struct request_queue *q, struct request *rq,
486                         struct bio *bio)
487 {
488         struct elevator_queue *e = q->elevator;
489
490         if (WARN_ON_ONCE(e->uses_mq))
491                 return;
492
493         if (e->type->ops.sq.elevator_bio_merged_fn)
494                 e->type->ops.sq.elevator_bio_merged_fn(q, rq, bio);
495 }
496
497 void elv_requeue_request(struct request_queue *q, struct request *rq)
498 {
499         /*
500          * it already went through dequeue, we need to decrement the
501          * in_flight count again
502          */
503         if (blk_account_rq(rq)) {
504                 q->in_flight[rq_is_sync(rq)]--;
505                 if (rq->rq_flags & RQF_SORTED)
506                         elv_deactivate_rq(q, rq);
507         }
508
509         rq->rq_flags &= ~RQF_STARTED;
510
511         blk_pm_requeue_request(rq);
512
513         __elv_add_request(q, rq, ELEVATOR_INSERT_REQUEUE);
514 }
515
516 void elv_drain_elevator(struct request_queue *q)
517 {
518         struct elevator_queue *e = q->elevator;
519         static int printed;
520
521         if (WARN_ON_ONCE(e->uses_mq))
522                 return;
523
524         lockdep_assert_held(q->queue_lock);
525
526         while (e->type->ops.sq.elevator_dispatch_fn(q, 1))
527                 ;
528         if (q->nr_sorted && !blk_queue_is_zoned(q) && printed++ < 10 ) {
529                 printk(KERN_ERR "%s: forced dispatching is broken "
530                        "(nr_sorted=%u), please report this\n",
531                        q->elevator->type->elevator_name, q->nr_sorted);
532         }
533 }
534
535 void __elv_add_request(struct request_queue *q, struct request *rq, int where)
536 {
537         trace_block_rq_insert(q, rq);
538
539         blk_pm_add_request(q, rq);
540
541         rq->q = q;
542
543         if (rq->rq_flags & RQF_SOFTBARRIER) {
544                 /* barriers are scheduling boundary, update end_sector */
545                 if (!blk_rq_is_passthrough(rq)) {
546                         q->end_sector = rq_end_sector(rq);
547                         q->boundary_rq = rq;
548                 }
549         } else if (!(rq->rq_flags & RQF_ELVPRIV) &&
550                     (where == ELEVATOR_INSERT_SORT ||
551                      where == ELEVATOR_INSERT_SORT_MERGE))
552                 where = ELEVATOR_INSERT_BACK;
553
554         switch (where) {
555         case ELEVATOR_INSERT_REQUEUE:
556         case ELEVATOR_INSERT_FRONT:
557                 rq->rq_flags |= RQF_SOFTBARRIER;
558                 list_add(&rq->queuelist, &q->queue_head);
559                 break;
560
561         case ELEVATOR_INSERT_BACK:
562                 rq->rq_flags |= RQF_SOFTBARRIER;
563                 elv_drain_elevator(q);
564                 list_add_tail(&rq->queuelist, &q->queue_head);
565                 /*
566                  * We kick the queue here for the following reasons.
567                  * - The elevator might have returned NULL previously
568                  *   to delay requests and returned them now.  As the
569                  *   queue wasn't empty before this request, ll_rw_blk
570                  *   won't run the queue on return, resulting in hang.
571                  * - Usually, back inserted requests won't be merged
572                  *   with anything.  There's no point in delaying queue
573                  *   processing.
574                  */
575                 __blk_run_queue(q);
576                 break;
577
578         case ELEVATOR_INSERT_SORT_MERGE:
579                 /*
580                  * If we succeed in merging this request with one in the
581                  * queue already, we are done - rq has now been freed,
582                  * so no need to do anything further.
583                  */
584                 if (elv_attempt_insert_merge(q, rq))
585                         break;
586                 /* fall through */
587         case ELEVATOR_INSERT_SORT:
588                 BUG_ON(blk_rq_is_passthrough(rq));
589                 rq->rq_flags |= RQF_SORTED;
590                 q->nr_sorted++;
591                 if (rq_mergeable(rq)) {
592                         elv_rqhash_add(q, rq);
593                         if (!q->last_merge)
594                                 q->last_merge = rq;
595                 }
596
597                 /*
598                  * Some ioscheds (cfq) run q->request_fn directly, so
599                  * rq cannot be accessed after calling
600                  * elevator_add_req_fn.
601                  */
602                 q->elevator->type->ops.sq.elevator_add_req_fn(q, rq);
603                 break;
604
605         case ELEVATOR_INSERT_FLUSH:
606                 rq->rq_flags |= RQF_SOFTBARRIER;
607                 blk_insert_flush(rq);
608                 break;
609         default:
610                 printk(KERN_ERR "%s: bad insertion point %d\n",
611                        __func__, where);
612                 BUG();
613         }
614 }
615 EXPORT_SYMBOL(__elv_add_request);
616
617 void elv_add_request(struct request_queue *q, struct request *rq, int where)
618 {
619         unsigned long flags;
620
621         spin_lock_irqsave(q->queue_lock, flags);
622         __elv_add_request(q, rq, where);
623         spin_unlock_irqrestore(q->queue_lock, flags);
624 }
625 EXPORT_SYMBOL(elv_add_request);
626
627 struct request *elv_latter_request(struct request_queue *q, struct request *rq)
628 {
629         struct elevator_queue *e = q->elevator;
630
631         if (e->uses_mq && e->type->ops.mq.next_request)
632                 return e->type->ops.mq.next_request(q, rq);
633         else if (!e->uses_mq && e->type->ops.sq.elevator_latter_req_fn)
634                 return e->type->ops.sq.elevator_latter_req_fn(q, rq);
635
636         return NULL;
637 }
638
639 struct request *elv_former_request(struct request_queue *q, struct request *rq)
640 {
641         struct elevator_queue *e = q->elevator;
642
643         if (e->uses_mq && e->type->ops.mq.former_request)
644                 return e->type->ops.mq.former_request(q, rq);
645         if (!e->uses_mq && e->type->ops.sq.elevator_former_req_fn)
646                 return e->type->ops.sq.elevator_former_req_fn(q, rq);
647         return NULL;
648 }
649
650 int elv_set_request(struct request_queue *q, struct request *rq,
651                     struct bio *bio, gfp_t gfp_mask)
652 {
653         struct elevator_queue *e = q->elevator;
654
655         if (WARN_ON_ONCE(e->uses_mq))
656                 return 0;
657
658         if (e->type->ops.sq.elevator_set_req_fn)
659                 return e->type->ops.sq.elevator_set_req_fn(q, rq, bio, gfp_mask);
660         return 0;
661 }
662
663 void elv_put_request(struct request_queue *q, struct request *rq)
664 {
665         struct elevator_queue *e = q->elevator;
666
667         if (WARN_ON_ONCE(e->uses_mq))
668                 return;
669
670         if (e->type->ops.sq.elevator_put_req_fn)
671                 e->type->ops.sq.elevator_put_req_fn(rq);
672 }
673
674 int elv_may_queue(struct request_queue *q, unsigned int op)
675 {
676         struct elevator_queue *e = q->elevator;
677
678         if (WARN_ON_ONCE(e->uses_mq))
679                 return 0;
680
681         if (e->type->ops.sq.elevator_may_queue_fn)
682                 return e->type->ops.sq.elevator_may_queue_fn(q, op);
683
684         return ELV_MQUEUE_MAY;
685 }
686
687 void elv_completed_request(struct request_queue *q, struct request *rq)
688 {
689         struct elevator_queue *e = q->elevator;
690
691         if (WARN_ON_ONCE(e->uses_mq))
692                 return;
693
694         /*
695          * request is released from the driver, io must be done
696          */
697         if (blk_account_rq(rq)) {
698                 q->in_flight[rq_is_sync(rq)]--;
699                 if ((rq->rq_flags & RQF_SORTED) &&
700                     e->type->ops.sq.elevator_completed_req_fn)
701                         e->type->ops.sq.elevator_completed_req_fn(q, rq);
702         }
703 }
704
705 #define to_elv(atr) container_of((atr), struct elv_fs_entry, attr)
706
707 static ssize_t
708 elv_attr_show(struct kobject *kobj, struct attribute *attr, char *page)
709 {
710         struct elv_fs_entry *entry = to_elv(attr);
711         struct elevator_queue *e;
712         ssize_t error;
713
714         if (!entry->show)
715                 return -EIO;
716
717         e = container_of(kobj, struct elevator_queue, kobj);
718         mutex_lock(&e->sysfs_lock);
719         error = e->type ? entry->show(e, page) : -ENOENT;
720         mutex_unlock(&e->sysfs_lock);
721         return error;
722 }
723
724 static ssize_t
725 elv_attr_store(struct kobject *kobj, struct attribute *attr,
726                const char *page, size_t length)
727 {
728         struct elv_fs_entry *entry = to_elv(attr);
729         struct elevator_queue *e;
730         ssize_t error;
731
732         if (!entry->store)
733                 return -EIO;
734
735         e = container_of(kobj, struct elevator_queue, kobj);
736         mutex_lock(&e->sysfs_lock);
737         error = e->type ? entry->store(e, page, length) : -ENOENT;
738         mutex_unlock(&e->sysfs_lock);
739         return error;
740 }
741
742 static const struct sysfs_ops elv_sysfs_ops = {
743         .show   = elv_attr_show,
744         .store  = elv_attr_store,
745 };
746
747 static struct kobj_type elv_ktype = {
748         .sysfs_ops      = &elv_sysfs_ops,
749         .release        = elevator_release,
750 };
751
752 int elv_register_queue(struct request_queue *q)
753 {
754         struct elevator_queue *e = q->elevator;
755         int error;
756
757         lockdep_assert_held(&q->sysfs_lock);
758
759         error = kobject_add(&e->kobj, &q->kobj, "%s", "iosched");
760         if (!error) {
761                 struct elv_fs_entry *attr = e->type->elevator_attrs;
762                 if (attr) {
763                         while (attr->attr.name) {
764                                 if (sysfs_create_file(&e->kobj, &attr->attr))
765                                         break;
766                                 attr++;
767                         }
768                 }
769                 kobject_uevent(&e->kobj, KOBJ_ADD);
770                 e->registered = 1;
771                 if (!e->uses_mq && e->type->ops.sq.elevator_registered_fn)
772                         e->type->ops.sq.elevator_registered_fn(q);
773         }
774         return error;
775 }
776
777 void elv_unregister_queue(struct request_queue *q)
778 {
779         lockdep_assert_held(&q->sysfs_lock);
780
781         if (q) {
782                 struct elevator_queue *e = q->elevator;
783
784                 kobject_uevent(&e->kobj, KOBJ_REMOVE);
785                 kobject_del(&e->kobj);
786                 e->registered = 0;
787                 /* Re-enable throttling in case elevator disabled it */
788                 wbt_enable_default(q);
789         }
790 }
791
792 int elv_register(struct elevator_type *e)
793 {
794         char *def = "";
795
796         /* create icq_cache if requested */
797         if (e->icq_size) {
798                 if (WARN_ON(e->icq_size < sizeof(struct io_cq)) ||
799                     WARN_ON(e->icq_align < __alignof__(struct io_cq)))
800                         return -EINVAL;
801
802                 snprintf(e->icq_cache_name, sizeof(e->icq_cache_name),
803                          "%s_io_cq", e->elevator_name);
804                 e->icq_cache = kmem_cache_create(e->icq_cache_name, e->icq_size,
805                                                  e->icq_align, 0, NULL);
806                 if (!e->icq_cache)
807                         return -ENOMEM;
808         }
809
810         /* register, don't allow duplicate names */
811         spin_lock(&elv_list_lock);
812         if (elevator_find(e->elevator_name, e->uses_mq)) {
813                 spin_unlock(&elv_list_lock);
814                 kmem_cache_destroy(e->icq_cache);
815                 return -EBUSY;
816         }
817         list_add_tail(&e->list, &elv_list);
818         spin_unlock(&elv_list_lock);
819
820         printk(KERN_INFO "io scheduler %s registered%s\n", e->elevator_name,
821                                                                 def);
822         return 0;
823 }
824 EXPORT_SYMBOL_GPL(elv_register);
825
826 void elv_unregister(struct elevator_type *e)
827 {
828         /* unregister */
829         spin_lock(&elv_list_lock);
830         list_del_init(&e->list);
831         spin_unlock(&elv_list_lock);
832
833         /*
834          * Destroy icq_cache if it exists.  icq's are RCU managed.  Make
835          * sure all RCU operations are complete before proceeding.
836          */
837         if (e->icq_cache) {
838                 rcu_barrier();
839                 kmem_cache_destroy(e->icq_cache);
840                 e->icq_cache = NULL;
841         }
842 }
843 EXPORT_SYMBOL_GPL(elv_unregister);
844
845 int elevator_switch_mq(struct request_queue *q,
846                               struct elevator_type *new_e)
847 {
848         int ret;
849
850         lockdep_assert_held(&q->sysfs_lock);
851
852         if (q->elevator) {
853                 if (q->elevator->registered)
854                         elv_unregister_queue(q);
855                 ioc_clear_queue(q);
856                 elevator_exit(q, q->elevator);
857         }
858
859         ret = blk_mq_init_sched(q, new_e);
860         if (ret)
861                 goto out;
862
863         if (new_e) {
864                 ret = elv_register_queue(q);
865                 if (ret) {
866                         elevator_exit(q, q->elevator);
867                         goto out;
868                 }
869         }
870
871         if (new_e)
872                 blk_add_trace_msg(q, "elv switch: %s", new_e->elevator_name);
873         else
874                 blk_add_trace_msg(q, "elv switch: none");
875
876 out:
877         return ret;
878 }
879
880 /*
881  * For blk-mq devices, we default to using mq-deadline, if available, for single
882  * queue devices.  If deadline isn't available OR we have multiple queues,
883  * default to "none".
884  */
885 int elevator_init_mq(struct request_queue *q)
886 {
887         struct elevator_type *e;
888         int err = 0;
889
890         if (q->nr_hw_queues != 1)
891                 return 0;
892
893         /*
894          * q->sysfs_lock must be held to provide mutual exclusion between
895          * elevator_switch() and here.
896          */
897         mutex_lock(&q->sysfs_lock);
898         if (unlikely(q->elevator))
899                 goto out_unlock;
900
901         e = elevator_get(q, "mq-deadline", false);
902         if (!e)
903                 goto out_unlock;
904
905         err = blk_mq_init_sched(q, e);
906         if (err)
907                 elevator_put(e);
908 out_unlock:
909         mutex_unlock(&q->sysfs_lock);
910         return err;
911 }
912
913
914 /*
915  * switch to new_e io scheduler. be careful not to introduce deadlocks -
916  * we don't free the old io scheduler, before we have allocated what we
917  * need for the new one. this way we have a chance of going back to the old
918  * one, if the new one fails init for some reason.
919  */
920 static int elevator_switch(struct request_queue *q, struct elevator_type *new_e)
921 {
922         struct elevator_queue *old = q->elevator;
923         bool old_registered = false;
924         int err;
925
926         lockdep_assert_held(&q->sysfs_lock);
927
928         if (q->mq_ops) {
929                 blk_mq_freeze_queue(q);
930                 blk_mq_quiesce_queue(q);
931
932                 err = elevator_switch_mq(q, new_e);
933
934                 blk_mq_unquiesce_queue(q);
935                 blk_mq_unfreeze_queue(q);
936
937                 return err;
938         }
939
940         /*
941          * Turn on BYPASS and drain all requests w/ elevator private data.
942          * Block layer doesn't call into a quiesced elevator - all requests
943          * are directly put on the dispatch list without elevator data
944          * using INSERT_BACK.  All requests have SOFTBARRIER set and no
945          * merge happens either.
946          */
947         if (old) {
948                 old_registered = old->registered;
949
950                 blk_queue_bypass_start(q);
951
952                 /* unregister and clear all auxiliary data of the old elevator */
953                 if (old_registered)
954                         elv_unregister_queue(q);
955
956                 ioc_clear_queue(q);
957         }
958
959         /* allocate, init and register new elevator */
960         err = new_e->ops.sq.elevator_init_fn(q, new_e);
961         if (err)
962                 goto fail_init;
963
964         err = elv_register_queue(q);
965         if (err)
966                 goto fail_register;
967
968         /* done, kill the old one and finish */
969         if (old) {
970                 elevator_exit(q, old);
971                 blk_queue_bypass_end(q);
972         }
973
974         blk_add_trace_msg(q, "elv switch: %s", new_e->elevator_name);
975
976         return 0;
977
978 fail_register:
979         elevator_exit(q, q->elevator);
980 fail_init:
981         /* switch failed, restore and re-register old elevator */
982         if (old) {
983                 q->elevator = old;
984                 elv_register_queue(q);
985                 blk_queue_bypass_end(q);
986         }
987
988         return err;
989 }
990
991 /*
992  * Switch this queue to the given IO scheduler.
993  */
994 static int __elevator_change(struct request_queue *q, const char *name)
995 {
996         char elevator_name[ELV_NAME_MAX];
997         struct elevator_type *e;
998
999         /* Make sure queue is not in the middle of being removed */
1000         if (!test_bit(QUEUE_FLAG_REGISTERED, &q->queue_flags))
1001                 return -ENOENT;
1002
1003         /*
1004          * Special case for mq, turn off scheduling
1005          */
1006         if (q->mq_ops && !strncmp(name, "none", 4))
1007                 return elevator_switch(q, NULL);
1008
1009         strlcpy(elevator_name, name, sizeof(elevator_name));
1010         e = elevator_get(q, strstrip(elevator_name), true);
1011         if (!e)
1012                 return -EINVAL;
1013
1014         if (q->elevator && elevator_match(q->elevator->type, elevator_name)) {
1015                 elevator_put(e);
1016                 return 0;
1017         }
1018
1019         return elevator_switch(q, e);
1020 }
1021
1022 static inline bool elv_support_iosched(struct request_queue *q)
1023 {
1024         if (q->mq_ops && q->tag_set && (q->tag_set->flags &
1025                                 BLK_MQ_F_NO_SCHED))
1026                 return false;
1027         return true;
1028 }
1029
1030 ssize_t elv_iosched_store(struct request_queue *q, const char *name,
1031                           size_t count)
1032 {
1033         int ret;
1034
1035         if (!(q->mq_ops || q->request_fn) || !elv_support_iosched(q))
1036                 return count;
1037
1038         ret = __elevator_change(q, name);
1039         if (!ret)
1040                 return count;
1041
1042         return ret;
1043 }
1044
1045 ssize_t elv_iosched_show(struct request_queue *q, char *name)
1046 {
1047         struct elevator_queue *e = q->elevator;
1048         struct elevator_type *elv = NULL;
1049         struct elevator_type *__e;
1050         bool uses_mq = q->mq_ops != NULL;
1051         int len = 0;
1052
1053         if (!queue_is_rq_based(q))
1054                 return sprintf(name, "none\n");
1055
1056         if (!q->elevator)
1057                 len += sprintf(name+len, "[none] ");
1058         else
1059                 elv = e->type;
1060
1061         spin_lock(&elv_list_lock);
1062         list_for_each_entry(__e, &elv_list, list) {
1063                 if (elv && elevator_match(elv, __e->elevator_name) &&
1064                     (__e->uses_mq == uses_mq)) {
1065                         len += sprintf(name+len, "[%s] ", elv->elevator_name);
1066                         continue;
1067                 }
1068                 if (__e->uses_mq && q->mq_ops && elv_support_iosched(q))
1069                         len += sprintf(name+len, "%s ", __e->elevator_name);
1070                 else if (!__e->uses_mq && !q->mq_ops)
1071                         len += sprintf(name+len, "%s ", __e->elevator_name);
1072         }
1073         spin_unlock(&elv_list_lock);
1074
1075         if (q->mq_ops && q->elevator)
1076                 len += sprintf(name+len, "none");
1077
1078         len += sprintf(len+name, "\n");
1079         return len;
1080 }
1081
1082 struct request *elv_rb_former_request(struct request_queue *q,
1083                                       struct request *rq)
1084 {
1085         struct rb_node *rbprev = rb_prev(&rq->rb_node);
1086
1087         if (rbprev)
1088                 return rb_entry_rq(rbprev);
1089
1090         return NULL;
1091 }
1092 EXPORT_SYMBOL(elv_rb_former_request);
1093
1094 struct request *elv_rb_latter_request(struct request_queue *q,
1095                                       struct request *rq)
1096 {
1097         struct rb_node *rbnext = rb_next(&rq->rb_node);
1098
1099         if (rbnext)
1100                 return rb_entry_rq(rbnext);
1101
1102         return NULL;
1103 }
1104 EXPORT_SYMBOL(elv_rb_latter_request);