2 * Deadline i/o scheduler.
4 * Copyright (C) 2002 Jens Axboe <axboe@kernel.dk>
6 #include <linux/kernel.h>
8 #include <linux/blkdev.h>
9 #include <linux/elevator.h>
10 #include <linux/bio.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/init.h>
14 #include <linux/compiler.h>
15 #include <linux/rbtree.h>
18 * See Documentation/block/deadline-iosched.txt
20 static const int read_expire = HZ / 2; /* max time before a read is submitted. */
21 static const int write_expire = 5 * HZ; /* ditto for writes, these limits are SOFT! */
22 static const int writes_starved = 2; /* max times reads can starve a write */
23 static const int fifo_batch = 16; /* # of sequential requests treated as one
24 by the above parameters. For throughput. */
26 struct deadline_data {
32 * requests (deadline_rq s) are present on both sort_list and fifo_list
34 struct rb_root sort_list[2];
35 struct list_head fifo_list[2];
38 * next in sort order. read, write or both are NULL
40 struct request *next_rq[2];
41 unsigned int batching; /* number of sequential requests made */
42 sector_t last_sector; /* head position */
43 unsigned int starved; /* times reads have starved writes */
46 * settings that change how the i/o scheduler behaves
54 static void deadline_move_request(struct deadline_data *, struct request *);
56 #define RQ_RB_ROOT(dd, rq) (&(dd)->sort_list[rq_data_dir((rq))])
59 deadline_add_rq_rb(struct deadline_data *dd, struct request *rq)
61 struct rb_root *root = RQ_RB_ROOT(dd, rq);
62 struct request *__alias;
65 __alias = elv_rb_add(root, rq);
66 if (unlikely(__alias)) {
67 deadline_move_request(dd, __alias);
73 deadline_del_rq_rb(struct deadline_data *dd, struct request *rq)
75 const int data_dir = rq_data_dir(rq);
77 if (dd->next_rq[data_dir] == rq) {
78 struct rb_node *rbnext = rb_next(&rq->rb_node);
80 dd->next_rq[data_dir] = NULL;
82 dd->next_rq[data_dir] = rb_entry_rq(rbnext);
85 elv_rb_del(RQ_RB_ROOT(dd, rq), rq);
89 * add rq to rbtree and fifo
92 deadline_add_request(struct request_queue *q, struct request *rq)
94 struct deadline_data *dd = q->elevator->elevator_data;
95 const int data_dir = rq_data_dir(rq);
97 deadline_add_rq_rb(dd, rq);
100 * set expire time (only used for reads) and add to fifo list
102 rq_set_fifo_time(rq, jiffies + dd->fifo_expire[data_dir]);
103 list_add_tail(&rq->queuelist, &dd->fifo_list[data_dir]);
107 * remove rq from rbtree and fifo.
109 static void deadline_remove_request(request_queue_t *q, struct request *rq)
111 struct deadline_data *dd = q->elevator->elevator_data;
114 deadline_del_rq_rb(dd, rq);
118 deadline_merge(request_queue_t *q, struct request **req, struct bio *bio)
120 struct deadline_data *dd = q->elevator->elevator_data;
121 struct request *__rq;
125 * check for front merge
127 if (dd->front_merges) {
128 sector_t sector = bio->bi_sector + bio_sectors(bio);
130 __rq = elv_rb_find(&dd->sort_list[bio_data_dir(bio)], sector);
132 BUG_ON(sector != __rq->sector);
134 if (elv_rq_merge_ok(__rq, bio)) {
135 ret = ELEVATOR_FRONT_MERGE;
141 return ELEVATOR_NO_MERGE;
147 static void deadline_merged_request(request_queue_t *q, struct request *req,
150 struct deadline_data *dd = q->elevator->elevator_data;
153 * if the merge was a front merge, we need to reposition request
155 if (type == ELEVATOR_FRONT_MERGE) {
156 elv_rb_del(RQ_RB_ROOT(dd, req), req);
157 deadline_add_rq_rb(dd, req);
162 deadline_merged_requests(request_queue_t *q, struct request *req,
163 struct request *next)
166 * if next expires before rq, assign its expire time to rq
167 * and move into next position (next will be deleted) in fifo
169 if (!list_empty(&req->queuelist) && !list_empty(&next->queuelist)) {
170 if (time_before(rq_fifo_time(next), rq_fifo_time(req))) {
171 list_move(&req->queuelist, &next->queuelist);
172 rq_set_fifo_time(req, rq_fifo_time(next));
177 * kill knowledge of next, this one is a goner
179 deadline_remove_request(q, next);
183 * move request from sort list to dispatch queue.
186 deadline_move_to_dispatch(struct deadline_data *dd, struct request *rq)
188 request_queue_t *q = rq->q;
190 deadline_remove_request(q, rq);
191 elv_dispatch_add_tail(q, rq);
195 * move an entry to dispatch queue
198 deadline_move_request(struct deadline_data *dd, struct request *rq)
200 const int data_dir = rq_data_dir(rq);
201 struct rb_node *rbnext = rb_next(&rq->rb_node);
203 dd->next_rq[READ] = NULL;
204 dd->next_rq[WRITE] = NULL;
207 dd->next_rq[data_dir] = rb_entry_rq(rbnext);
209 dd->last_sector = rq->sector + rq->nr_sectors;
212 * take it off the sort and fifo list, move
215 deadline_move_to_dispatch(dd, rq);
219 * deadline_check_fifo returns 0 if there are no expired reads on the fifo,
220 * 1 otherwise. Requires !list_empty(&dd->fifo_list[data_dir])
222 static inline int deadline_check_fifo(struct deadline_data *dd, int ddir)
224 struct request *rq = rq_entry_fifo(dd->fifo_list[ddir].next);
229 if (time_after(jiffies, rq_fifo_time(rq)))
236 * deadline_dispatch_requests selects the best request according to
237 * read/write expire, fifo_batch, etc
239 static int deadline_dispatch_requests(request_queue_t *q, int force)
241 struct deadline_data *dd = q->elevator->elevator_data;
242 const int reads = !list_empty(&dd->fifo_list[READ]);
243 const int writes = !list_empty(&dd->fifo_list[WRITE]);
248 * batches are currently reads XOR writes
250 if (dd->next_rq[WRITE])
251 rq = dd->next_rq[WRITE];
253 rq = dd->next_rq[READ];
256 /* we have a "next request" */
258 if (dd->last_sector != rq->sector)
259 /* end the batch on a non sequential request */
260 dd->batching += dd->fifo_batch;
262 if (dd->batching < dd->fifo_batch)
263 /* we are still entitled to batch */
264 goto dispatch_request;
268 * at this point we are not running a batch. select the appropriate
269 * data direction (read / write)
273 BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[READ]));
275 if (writes && (dd->starved++ >= dd->writes_starved))
276 goto dispatch_writes;
280 goto dispatch_find_request;
284 * there are either no reads or writes have been starved
289 BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[WRITE]));
295 goto dispatch_find_request;
300 dispatch_find_request:
302 * we are not running a batch, find best request for selected data_dir
304 if (deadline_check_fifo(dd, data_dir)) {
305 /* An expired request exists - satisfy it */
307 rq = rq_entry_fifo(dd->fifo_list[data_dir].next);
309 } else if (dd->next_rq[data_dir]) {
311 * The last req was the same dir and we have a next request in
312 * sort order. No expired requests so continue on from here.
314 rq = dd->next_rq[data_dir];
316 struct rb_node *node;
318 * The last req was the other direction or we have run out of
319 * higher-sectored requests. Go back to the lowest sectored
320 * request (1 way elevator) and start a new batch.
323 node = rb_first(&dd->sort_list[data_dir]);
325 rq = rb_entry_rq(node);
330 * rq is the selected appropriate request.
333 deadline_move_request(dd, rq);
338 static int deadline_queue_empty(request_queue_t *q)
340 struct deadline_data *dd = q->elevator->elevator_data;
342 return list_empty(&dd->fifo_list[WRITE])
343 && list_empty(&dd->fifo_list[READ]);
346 static void deadline_exit_queue(elevator_t *e)
348 struct deadline_data *dd = e->elevator_data;
350 BUG_ON(!list_empty(&dd->fifo_list[READ]));
351 BUG_ON(!list_empty(&dd->fifo_list[WRITE]));
357 * initialize elevator private data (deadline_data).
359 static void *deadline_init_queue(request_queue_t *q)
361 struct deadline_data *dd;
363 dd = kmalloc_node(sizeof(*dd), GFP_KERNEL | __GFP_ZERO, q->node);
367 INIT_LIST_HEAD(&dd->fifo_list[READ]);
368 INIT_LIST_HEAD(&dd->fifo_list[WRITE]);
369 dd->sort_list[READ] = RB_ROOT;
370 dd->sort_list[WRITE] = RB_ROOT;
371 dd->fifo_expire[READ] = read_expire;
372 dd->fifo_expire[WRITE] = write_expire;
373 dd->writes_starved = writes_starved;
374 dd->front_merges = 1;
375 dd->fifo_batch = fifo_batch;
384 deadline_var_show(int var, char *page)
386 return sprintf(page, "%d\n", var);
390 deadline_var_store(int *var, const char *page, size_t count)
392 char *p = (char *) page;
394 *var = simple_strtol(p, &p, 10);
398 #define SHOW_FUNCTION(__FUNC, __VAR, __CONV) \
399 static ssize_t __FUNC(elevator_t *e, char *page) \
401 struct deadline_data *dd = e->elevator_data; \
402 int __data = __VAR; \
404 __data = jiffies_to_msecs(__data); \
405 return deadline_var_show(__data, (page)); \
407 SHOW_FUNCTION(deadline_read_expire_show, dd->fifo_expire[READ], 1);
408 SHOW_FUNCTION(deadline_write_expire_show, dd->fifo_expire[WRITE], 1);
409 SHOW_FUNCTION(deadline_writes_starved_show, dd->writes_starved, 0);
410 SHOW_FUNCTION(deadline_front_merges_show, dd->front_merges, 0);
411 SHOW_FUNCTION(deadline_fifo_batch_show, dd->fifo_batch, 0);
414 #define STORE_FUNCTION(__FUNC, __PTR, MIN, MAX, __CONV) \
415 static ssize_t __FUNC(elevator_t *e, const char *page, size_t count) \
417 struct deadline_data *dd = e->elevator_data; \
419 int ret = deadline_var_store(&__data, (page), count); \
420 if (__data < (MIN)) \
422 else if (__data > (MAX)) \
425 *(__PTR) = msecs_to_jiffies(__data); \
430 STORE_FUNCTION(deadline_read_expire_store, &dd->fifo_expire[READ], 0, INT_MAX, 1);
431 STORE_FUNCTION(deadline_write_expire_store, &dd->fifo_expire[WRITE], 0, INT_MAX, 1);
432 STORE_FUNCTION(deadline_writes_starved_store, &dd->writes_starved, INT_MIN, INT_MAX, 0);
433 STORE_FUNCTION(deadline_front_merges_store, &dd->front_merges, 0, 1, 0);
434 STORE_FUNCTION(deadline_fifo_batch_store, &dd->fifo_batch, 0, INT_MAX, 0);
435 #undef STORE_FUNCTION
437 #define DD_ATTR(name) \
438 __ATTR(name, S_IRUGO|S_IWUSR, deadline_##name##_show, \
439 deadline_##name##_store)
441 static struct elv_fs_entry deadline_attrs[] = {
442 DD_ATTR(read_expire),
443 DD_ATTR(write_expire),
444 DD_ATTR(writes_starved),
445 DD_ATTR(front_merges),
450 static struct elevator_type iosched_deadline = {
452 .elevator_merge_fn = deadline_merge,
453 .elevator_merged_fn = deadline_merged_request,
454 .elevator_merge_req_fn = deadline_merged_requests,
455 .elevator_dispatch_fn = deadline_dispatch_requests,
456 .elevator_add_req_fn = deadline_add_request,
457 .elevator_queue_empty_fn = deadline_queue_empty,
458 .elevator_former_req_fn = elv_rb_former_request,
459 .elevator_latter_req_fn = elv_rb_latter_request,
460 .elevator_init_fn = deadline_init_queue,
461 .elevator_exit_fn = deadline_exit_queue,
464 .elevator_attrs = deadline_attrs,
465 .elevator_name = "deadline",
466 .elevator_owner = THIS_MODULE,
469 static int __init deadline_init(void)
471 return elv_register(&iosched_deadline);
474 static void __exit deadline_exit(void)
476 elv_unregister(&iosched_deadline);
479 module_init(deadline_init);
480 module_exit(deadline_exit);
482 MODULE_AUTHOR("Jens Axboe");
483 MODULE_LICENSE("GPL");
484 MODULE_DESCRIPTION("deadline IO scheduler");