Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _LINUX_ELEVATOR_H |
| 2 | #define _LINUX_ELEVATOR_H |
| 3 | |
Jens Axboe | 4a893e8 | 2006-07-22 15:37:43 +0200 | [diff] [blame] | 4 | #include <linux/percpu.h> |
Sasha Levin | 242d98f | 2012-12-17 10:01:27 -0500 | [diff] [blame] | 5 | #include <linux/hashtable.h> |
Jens Axboe | 4a893e8 | 2006-07-22 15:37:43 +0200 | [diff] [blame] | 6 | |
David Howells | 9361401 | 2006-09-30 20:45:40 +0200 | [diff] [blame] | 7 | #ifdef CONFIG_BLOCK |
| 8 | |
Tejun Heo | 7e5a879 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 9 | struct io_cq; |
Jianpeng Ma | d50235b | 2013-07-03 13:25:24 +0200 | [diff] [blame^] | 10 | struct elevator_type; |
Tejun Heo | 7e5a879 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 11 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 12 | typedef int (elevator_merge_fn) (struct request_queue *, struct request **, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | struct bio *); |
| 14 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 15 | typedef void (elevator_merge_req_fn) (struct request_queue *, struct request *, struct request *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 17 | typedef void (elevator_merged_fn) (struct request_queue *, struct request *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 19 | typedef int (elevator_allow_merge_fn) (struct request_queue *, struct request *, struct bio *); |
Jens Axboe | da77526 | 2006-12-20 11:04:12 +0100 | [diff] [blame] | 20 | |
Divyesh Shah | 812d402 | 2010-04-08 21:14:23 -0700 | [diff] [blame] | 21 | typedef void (elevator_bio_merged_fn) (struct request_queue *, |
| 22 | struct request *, struct bio *); |
| 23 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 24 | typedef int (elevator_dispatch_fn) (struct request_queue *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 26 | typedef void (elevator_add_req_fn) (struct request_queue *, struct request *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 27 | typedef struct request *(elevator_request_list_fn) (struct request_queue *, struct request *); |
| 28 | typedef void (elevator_completed_req_fn) (struct request_queue *, struct request *); |
| 29 | typedef int (elevator_may_queue_fn) (struct request_queue *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | |
Tejun Heo | 9b84cac | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 31 | typedef void (elevator_init_icq_fn) (struct io_cq *); |
Tejun Heo | 7e5a879 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 32 | typedef void (elevator_exit_icq_fn) (struct io_cq *); |
Tejun Heo | 852c788 | 2012-03-05 13:15:27 -0800 | [diff] [blame] | 33 | typedef int (elevator_set_req_fn) (struct request_queue *, struct request *, |
| 34 | struct bio *, gfp_t); |
Jens Axboe | bb37b94 | 2006-12-01 10:42:33 +0100 | [diff] [blame] | 35 | typedef void (elevator_put_req_fn) (struct request *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 36 | typedef void (elevator_activate_req_fn) (struct request_queue *, struct request *); |
| 37 | typedef void (elevator_deactivate_req_fn) (struct request_queue *, struct request *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
Jianpeng Ma | d50235b | 2013-07-03 13:25:24 +0200 | [diff] [blame^] | 39 | typedef int (elevator_init_fn) (struct request_queue *, |
| 40 | struct elevator_type *e); |
Jens Axboe | b374d18 | 2008-10-31 10:05:07 +0100 | [diff] [blame] | 41 | typedef void (elevator_exit_fn) (struct elevator_queue *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | |
| 43 | struct elevator_ops |
| 44 | { |
| 45 | elevator_merge_fn *elevator_merge_fn; |
| 46 | elevator_merged_fn *elevator_merged_fn; |
| 47 | elevator_merge_req_fn *elevator_merge_req_fn; |
Jens Axboe | da77526 | 2006-12-20 11:04:12 +0100 | [diff] [blame] | 48 | elevator_allow_merge_fn *elevator_allow_merge_fn; |
Divyesh Shah | 812d402 | 2010-04-08 21:14:23 -0700 | [diff] [blame] | 49 | elevator_bio_merged_fn *elevator_bio_merged_fn; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
Tejun Heo | 8922e16 | 2005-10-20 16:23:44 +0200 | [diff] [blame] | 51 | elevator_dispatch_fn *elevator_dispatch_fn; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | elevator_add_req_fn *elevator_add_req_fn; |
Tejun Heo | 8922e16 | 2005-10-20 16:23:44 +0200 | [diff] [blame] | 53 | elevator_activate_req_fn *elevator_activate_req_fn; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | elevator_deactivate_req_fn *elevator_deactivate_req_fn; |
| 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | elevator_completed_req_fn *elevator_completed_req_fn; |
| 57 | |
| 58 | elevator_request_list_fn *elevator_former_req_fn; |
| 59 | elevator_request_list_fn *elevator_latter_req_fn; |
| 60 | |
Tejun Heo | f1f8cc9 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 61 | elevator_init_icq_fn *elevator_init_icq_fn; /* see iocontext.h */ |
| 62 | elevator_exit_icq_fn *elevator_exit_icq_fn; /* ditto */ |
Tejun Heo | 7e5a879 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 63 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 64 | elevator_set_req_fn *elevator_set_req_fn; |
| 65 | elevator_put_req_fn *elevator_put_req_fn; |
| 66 | |
| 67 | elevator_may_queue_fn *elevator_may_queue_fn; |
| 68 | |
| 69 | elevator_init_fn *elevator_init_fn; |
| 70 | elevator_exit_fn *elevator_exit_fn; |
| 71 | }; |
| 72 | |
| 73 | #define ELV_NAME_MAX (16) |
| 74 | |
Al Viro | e572ec7 | 2006-03-18 22:27:18 -0500 | [diff] [blame] | 75 | struct elv_fs_entry { |
| 76 | struct attribute attr; |
Jens Axboe | b374d18 | 2008-10-31 10:05:07 +0100 | [diff] [blame] | 77 | ssize_t (*show)(struct elevator_queue *, char *); |
| 78 | ssize_t (*store)(struct elevator_queue *, const char *, size_t); |
Al Viro | e572ec7 | 2006-03-18 22:27:18 -0500 | [diff] [blame] | 79 | }; |
| 80 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | /* |
| 82 | * identifies an elevator type, such as AS or deadline |
| 83 | */ |
| 84 | struct elevator_type |
| 85 | { |
Tejun Heo | 3d3c237 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 86 | /* managed by elevator core */ |
| 87 | struct kmem_cache *icq_cache; |
| 88 | |
| 89 | /* fields provided by elevator implementation */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | struct elevator_ops ops; |
Tejun Heo | f1f8cc9 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 91 | size_t icq_size; /* see iocontext.h */ |
| 92 | size_t icq_align; /* ditto */ |
Al Viro | e572ec7 | 2006-03-18 22:27:18 -0500 | [diff] [blame] | 93 | struct elv_fs_entry *elevator_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | char elevator_name[ELV_NAME_MAX]; |
| 95 | struct module *elevator_owner; |
Tejun Heo | 3d3c237 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 96 | |
| 97 | /* managed by elevator core */ |
| 98 | char icq_cache_name[ELV_NAME_MAX + 5]; /* elvname + "_io_cq" */ |
Tejun Heo | 22f746e | 2011-12-14 00:33:41 +0100 | [diff] [blame] | 99 | struct list_head list; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | }; |
| 101 | |
Sasha Levin | 242d98f | 2012-12-17 10:01:27 -0500 | [diff] [blame] | 102 | #define ELV_HASH_BITS 6 |
| 103 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | /* |
Adrian Bunk | 5406958 | 2006-01-10 00:09:36 +0100 | [diff] [blame] | 105 | * each queue has an elevator_queue associated with it |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | */ |
| 107 | struct elevator_queue |
| 108 | { |
Tejun Heo | 22f746e | 2011-12-14 00:33:41 +0100 | [diff] [blame] | 109 | struct elevator_type *type; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | void *elevator_data; |
| 111 | struct kobject kobj; |
Al Viro | 3d1ab40 | 2006-03-18 18:35:43 -0500 | [diff] [blame] | 112 | struct mutex sysfs_lock; |
Jens Axboe | 430c62f | 2010-10-07 09:35:16 +0200 | [diff] [blame] | 113 | unsigned int registered:1; |
Sasha Levin | 242d98f | 2012-12-17 10:01:27 -0500 | [diff] [blame] | 114 | DECLARE_HASHTABLE(hash, ELV_HASH_BITS); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | }; |
| 116 | |
| 117 | /* |
| 118 | * block elevator interface |
| 119 | */ |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 120 | extern void elv_dispatch_sort(struct request_queue *, struct request *); |
| 121 | extern void elv_dispatch_add_tail(struct request_queue *, struct request *); |
Jens Axboe | 7eaceac | 2011-03-10 08:52:07 +0100 | [diff] [blame] | 122 | extern void elv_add_request(struct request_queue *, struct request *, int); |
| 123 | extern void __elv_add_request(struct request_queue *, struct request *, int); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 124 | extern int elv_merge(struct request_queue *, struct request **, struct bio *); |
| 125 | extern void elv_merge_requests(struct request_queue *, struct request *, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | struct request *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 127 | extern void elv_merged_request(struct request_queue *, struct request *, int); |
Divyesh Shah | 812d402 | 2010-04-08 21:14:23 -0700 | [diff] [blame] | 128 | extern void elv_bio_merged(struct request_queue *q, struct request *, |
| 129 | struct bio *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 130 | extern void elv_requeue_request(struct request_queue *, struct request *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 131 | extern struct request *elv_former_request(struct request_queue *, struct request *); |
| 132 | extern struct request *elv_latter_request(struct request_queue *, struct request *); |
| 133 | extern int elv_register_queue(struct request_queue *q); |
| 134 | extern void elv_unregister_queue(struct request_queue *q); |
| 135 | extern int elv_may_queue(struct request_queue *, int); |
Mike Anderson | 11914a5 | 2008-09-13 20:31:27 +0200 | [diff] [blame] | 136 | extern void elv_abort_queue(struct request_queue *); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 137 | extern void elv_completed_request(struct request_queue *, struct request *); |
Tejun Heo | 852c788 | 2012-03-05 13:15:27 -0800 | [diff] [blame] | 138 | extern int elv_set_request(struct request_queue *q, struct request *rq, |
| 139 | struct bio *bio, gfp_t gfp_mask); |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 140 | extern void elv_put_request(struct request_queue *, struct request *); |
Jerome Marchand | 26308ea | 2009-03-27 10:31:51 +0100 | [diff] [blame] | 141 | extern void elv_drain_elevator(struct request_queue *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | |
| 143 | /* |
| 144 | * io scheduler registration |
| 145 | */ |
Tejun Heo | bb813f4 | 2013-01-18 14:05:56 -0800 | [diff] [blame] | 146 | extern void __init load_default_elevator_module(void); |
Tejun Heo | 3d3c237 | 2011-12-14 00:33:42 +0100 | [diff] [blame] | 147 | extern int elv_register(struct elevator_type *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | extern void elv_unregister(struct elevator_type *); |
| 149 | |
| 150 | /* |
| 151 | * io scheduler sysfs switching |
| 152 | */ |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 153 | extern ssize_t elv_iosched_show(struct request_queue *, char *); |
| 154 | extern ssize_t elv_iosched_store(struct request_queue *, const char *, size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 156 | extern int elevator_init(struct request_queue *, char *); |
Jens Axboe | b374d18 | 2008-10-31 10:05:07 +0100 | [diff] [blame] | 157 | extern void elevator_exit(struct elevator_queue *); |
Jens Axboe | 5dd531a | 2010-08-23 13:52:19 +0200 | [diff] [blame] | 158 | extern int elevator_change(struct request_queue *, const char *); |
Tejun Heo | 050c8ea | 2012-02-08 09:19:38 +0100 | [diff] [blame] | 159 | extern bool elv_rq_merge_ok(struct request *, struct bio *); |
Jianpeng Ma | d50235b | 2013-07-03 13:25:24 +0200 | [diff] [blame^] | 160 | extern struct elevator_queue *elevator_alloc(struct request_queue *, |
| 161 | struct elevator_type *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
| 163 | /* |
Jens Axboe | 2e662b6 | 2006-07-13 11:55:04 +0200 | [diff] [blame] | 164 | * Helper functions. |
| 165 | */ |
Jens Axboe | 165125e | 2007-07-24 09:28:11 +0200 | [diff] [blame] | 166 | extern struct request *elv_rb_former_request(struct request_queue *, struct request *); |
| 167 | extern struct request *elv_rb_latter_request(struct request_queue *, struct request *); |
Jens Axboe | 2e662b6 | 2006-07-13 11:55:04 +0200 | [diff] [blame] | 168 | |
| 169 | /* |
| 170 | * rb support functions. |
| 171 | */ |
Jeff Moyer | 796d511 | 2011-06-02 21:19:05 +0200 | [diff] [blame] | 172 | extern void elv_rb_add(struct rb_root *, struct request *); |
Jens Axboe | 2e662b6 | 2006-07-13 11:55:04 +0200 | [diff] [blame] | 173 | extern void elv_rb_del(struct rb_root *, struct request *); |
| 174 | extern struct request *elv_rb_find(struct rb_root *, sector_t); |
| 175 | |
| 176 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | * Return values from elevator merger |
| 178 | */ |
| 179 | #define ELEVATOR_NO_MERGE 0 |
| 180 | #define ELEVATOR_FRONT_MERGE 1 |
| 181 | #define ELEVATOR_BACK_MERGE 2 |
| 182 | |
| 183 | /* |
| 184 | * Insertion selection |
| 185 | */ |
| 186 | #define ELEVATOR_INSERT_FRONT 1 |
| 187 | #define ELEVATOR_INSERT_BACK 2 |
| 188 | #define ELEVATOR_INSERT_SORT 3 |
Tejun Heo | 797e7db | 2006-01-06 09:51:03 +0100 | [diff] [blame] | 189 | #define ELEVATOR_INSERT_REQUEUE 4 |
Tejun Heo | ae1b153 | 2011-01-25 12:43:54 +0100 | [diff] [blame] | 190 | #define ELEVATOR_INSERT_FLUSH 5 |
Jens Axboe | 5e84ea3 | 2011-03-21 10:14:27 +0100 | [diff] [blame] | 191 | #define ELEVATOR_INSERT_SORT_MERGE 6 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 192 | |
| 193 | /* |
| 194 | * return values from elevator_may_queue_fn |
| 195 | */ |
| 196 | enum { |
| 197 | ELV_MQUEUE_MAY, |
| 198 | ELV_MQUEUE_NO, |
| 199 | ELV_MQUEUE_MUST, |
| 200 | }; |
| 201 | |
Tejun Heo | 2e46e8b | 2009-05-07 22:24:41 +0900 | [diff] [blame] | 202 | #define rq_end_sector(rq) (blk_rq_pos(rq) + blk_rq_sectors(rq)) |
Jens Axboe | 2e662b6 | 2006-07-13 11:55:04 +0200 | [diff] [blame] | 203 | #define rb_entry_rq(node) rb_entry((node), struct request, rb_node) |
Jens Axboe | 1b47f53 | 2005-10-20 16:37:00 +0200 | [diff] [blame] | 204 | |
Jens Axboe | 1fbfdfc | 2006-07-11 21:49:15 +0200 | [diff] [blame] | 205 | /* |
Jens Axboe | c7c22e4 | 2008-09-13 20:26:01 +0200 | [diff] [blame] | 206 | * Hack to reuse the csd.list list_head as the fifo time holder while |
Jens Axboe | 1fbfdfc | 2006-07-11 21:49:15 +0200 | [diff] [blame] | 207 | * the request is in the io scheduler. Saves an unsigned long in rq. |
| 208 | */ |
Jens Axboe | c7c22e4 | 2008-09-13 20:26:01 +0200 | [diff] [blame] | 209 | #define rq_fifo_time(rq) ((unsigned long) (rq)->csd.list.next) |
| 210 | #define rq_set_fifo_time(rq,exp) ((rq)->csd.list.next = (void *) (exp)) |
Jens Axboe | 1fbfdfc | 2006-07-11 21:49:15 +0200 | [diff] [blame] | 211 | #define rq_entry_fifo(ptr) list_entry((ptr), struct request, queuelist) |
| 212 | #define rq_fifo_clear(rq) do { \ |
| 213 | list_del_init(&(rq)->queuelist); \ |
Jens Axboe | c7c22e4 | 2008-09-13 20:26:01 +0200 | [diff] [blame] | 214 | INIT_LIST_HEAD(&(rq)->csd.list); \ |
Jens Axboe | 1fbfdfc | 2006-07-11 21:49:15 +0200 | [diff] [blame] | 215 | } while (0) |
| 216 | |
Tejun Heo | bb813f4 | 2013-01-18 14:05:56 -0800 | [diff] [blame] | 217 | #else /* CONFIG_BLOCK */ |
| 218 | |
| 219 | static inline void load_default_elevator_module(void) { } |
| 220 | |
David Howells | 9361401 | 2006-09-30 20:45:40 +0200 | [diff] [blame] | 221 | #endif /* CONFIG_BLOCK */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | #endif |