deadline-iosched.c 11.1 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3
/*
 *  Deadline i/o scheduler.
 *
4
 *  Copyright (C) 2002 Jens Axboe <axboe@kernel.dk>
Linus Torvalds's avatar
Linus Torvalds committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 */
#include <linux/kernel.h>
#include <linux/fs.h>
#include <linux/blkdev.h>
#include <linux/elevator.h>
#include <linux/bio.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/compiler.h>
#include <linux/rbtree.h>

/*
 * See Documentation/block/deadline-iosched.txt
 */
20 21 22 23
static const int read_expire = HZ / 2;  /* max time before a read is submitted. */
static const int write_expire = 5 * HZ; /* ditto for writes, these limits are SOFT! */
static const int writes_starved = 2;    /* max times reads can starve a write */
static const int fifo_batch = 16;       /* # of sequential requests treated as one
Linus Torvalds's avatar
Linus Torvalds committed
24 25 26 27 28 29 30 31 32 33 34 35
				     by the above parameters. For throughput. */

struct deadline_data {
	/*
	 * run time data
	 */

	/*
	 * requests (deadline_rq s) are present on both sort_list and fifo_list
	 */
	struct rb_root sort_list[2];	
	struct list_head fifo_list[2];
36

Linus Torvalds's avatar
Linus Torvalds committed
37 38 39
	/*
	 * next in sort order. read, write or both are NULL
	 */
40
	struct request *next_rq[2];
Linus Torvalds's avatar
Linus Torvalds committed
41 42 43 44 45 46 47 48 49 50 51 52 53
	unsigned int batching;		/* number of sequential requests made */
	sector_t last_sector;		/* head position */
	unsigned int starved;		/* times reads have starved writes */

	/*
	 * settings that change how the i/o scheduler behaves
	 */
	int fifo_expire[2];
	int fifo_batch;
	int writes_starved;
	int front_merges;
};

54
static void deadline_move_request(struct deadline_data *, struct request *);
Linus Torvalds's avatar
Linus Torvalds committed
55

56 57 58 59 60
static inline struct rb_root *
deadline_rb_root(struct deadline_data *dd, struct request *rq)
{
	return &dd->sort_list[rq_data_dir(rq)];
}
Linus Torvalds's avatar
Linus Torvalds committed
61

62 63 64 65 66 67 68 69 70 71 72 73 74 75
/*
 * get the request after `rq' in sector-sorted order
 */
static inline struct request *
deadline_latter_request(struct request *rq)
{
	struct rb_node *node = rb_next(&rq->rb_node);

	if (node)
		return rb_entry_rq(node);

	return NULL;
}

Linus Torvalds's avatar
Linus Torvalds committed
76
static void
77
deadline_add_rq_rb(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
78
{
79
	struct rb_root *root = deadline_rb_root(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
80

81
	elv_rb_add(root, rq);
Linus Torvalds's avatar
Linus Torvalds committed
82 83 84
}

static inline void
85
deadline_del_rq_rb(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
86
{
87
	const int data_dir = rq_data_dir(rq);
Linus Torvalds's avatar
Linus Torvalds committed
88

89 90
	if (dd->next_rq[data_dir] == rq)
		dd->next_rq[data_dir] = deadline_latter_request(rq);
Linus Torvalds's avatar
Linus Torvalds committed
91

92
	elv_rb_del(deadline_rb_root(dd, rq), rq);
Linus Torvalds's avatar
Linus Torvalds committed
93 94 95
}

/*
96
 * add rq to rbtree and fifo
Linus Torvalds's avatar
Linus Torvalds committed
97
 */
98
static void
Linus Torvalds's avatar
Linus Torvalds committed
99 100 101
deadline_add_request(struct request_queue *q, struct request *rq)
{
	struct deadline_data *dd = q->elevator->elevator_data;
102
	const int data_dir = rq_data_dir(rq);
Linus Torvalds's avatar
Linus Torvalds committed
103

104
	deadline_add_rq_rb(dd, rq);
105

Linus Torvalds's avatar
Linus Torvalds committed
106
	/*
107
	 * set expire time and add to fifo list
Linus Torvalds's avatar
Linus Torvalds committed
108
	 */
109 110
	rq_set_fifo_time(rq, jiffies + dd->fifo_expire[data_dir]);
	list_add_tail(&rq->queuelist, &dd->fifo_list[data_dir]);
Linus Torvalds's avatar
Linus Torvalds committed
111 112 113
}

/*
114
 * remove rq from rbtree and fifo.
Linus Torvalds's avatar
Linus Torvalds committed
115
 */
116
static void deadline_remove_request(struct request_queue *q, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
117
{
118
	struct deadline_data *dd = q->elevator->elevator_data;
Linus Torvalds's avatar
Linus Torvalds committed
119

120 121
	rq_fifo_clear(rq);
	deadline_del_rq_rb(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
122 123 124
}

static int
125
deadline_merge(struct request_queue *q, struct request **req, struct bio *bio)
Linus Torvalds's avatar
Linus Torvalds committed
126 127 128 129 130 131 132 133 134
{
	struct deadline_data *dd = q->elevator->elevator_data;
	struct request *__rq;
	int ret;

	/*
	 * check for front merge
	 */
	if (dd->front_merges) {
135
		sector_t sector = bio_end_sector(bio);
Linus Torvalds's avatar
Linus Torvalds committed
136

137
		__rq = elv_rb_find(&dd->sort_list[bio_data_dir(bio)], sector);
Linus Torvalds's avatar
Linus Torvalds committed
138
		if (__rq) {
139
			BUG_ON(sector != blk_rq_pos(__rq));
Linus Torvalds's avatar
Linus Torvalds committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153

			if (elv_rq_merge_ok(__rq, bio)) {
				ret = ELEVATOR_FRONT_MERGE;
				goto out;
			}
		}
	}

	return ELEVATOR_NO_MERGE;
out:
	*req = __rq;
	return ret;
}

154 155
static void deadline_merged_request(struct request_queue *q,
				    struct request *req, int type)
Linus Torvalds's avatar
Linus Torvalds committed
156 157 158 159 160 161
{
	struct deadline_data *dd = q->elevator->elevator_data;

	/*
	 * if the merge was a front merge, we need to reposition request
	 */
162
	if (type == ELEVATOR_FRONT_MERGE) {
163
		elv_rb_del(deadline_rb_root(dd, req), req);
164
		deadline_add_rq_rb(dd, req);
Linus Torvalds's avatar
Linus Torvalds committed
165 166 167 168
	}
}

static void
169
deadline_merged_requests(struct request_queue *q, struct request *req,
Linus Torvalds's avatar
Linus Torvalds committed
170 171 172
			 struct request *next)
{
	/*
173 174
	 * if next expires before rq, assign its expire time to rq
	 * and move into next position (next will be deleted) in fifo
Linus Torvalds's avatar
Linus Torvalds committed
175
	 */
176 177 178 179
	if (!list_empty(&req->queuelist) && !list_empty(&next->queuelist)) {
		if (time_before(rq_fifo_time(next), rq_fifo_time(req))) {
			list_move(&req->queuelist, &next->queuelist);
			rq_set_fifo_time(req, rq_fifo_time(next));
Linus Torvalds's avatar
Linus Torvalds committed
180 181 182 183 184 185 186 187 188 189 190 191 192
		}
	}

	/*
	 * kill knowledge of next, this one is a goner
	 */
	deadline_remove_request(q, next);
}

/*
 * move request from sort list to dispatch queue.
 */
static inline void
193
deadline_move_to_dispatch(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
194
{
195
	struct request_queue *q = rq->q;
Linus Torvalds's avatar
Linus Torvalds committed
196

197 198
	deadline_remove_request(q, rq);
	elv_dispatch_add_tail(q, rq);
Linus Torvalds's avatar
Linus Torvalds committed
199 200 201 202 203 204
}

/*
 * move an entry to dispatch queue
 */
static void
205
deadline_move_request(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
206
{
207
	const int data_dir = rq_data_dir(rq);
Linus Torvalds's avatar
Linus Torvalds committed
208

209 210
	dd->next_rq[READ] = NULL;
	dd->next_rq[WRITE] = NULL;
211
	dd->next_rq[data_dir] = deadline_latter_request(rq);
Linus Torvalds's avatar
Linus Torvalds committed
212

213
	dd->last_sector = rq_end_sector(rq);
Linus Torvalds's avatar
Linus Torvalds committed
214 215 216 217 218

	/*
	 * take it off the sort and fifo list, move
	 * to dispatch queue
	 */
219
	deadline_move_to_dispatch(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
220 221 222
}

/*
223
 * deadline_check_fifo returns 0 if there are no expired requests on the fifo,
Linus Torvalds's avatar
Linus Torvalds committed
224 225 226 227
 * 1 otherwise. Requires !list_empty(&dd->fifo_list[data_dir])
 */
static inline int deadline_check_fifo(struct deadline_data *dd, int ddir)
{
228
	struct request *rq = rq_entry_fifo(dd->fifo_list[ddir].next);
Linus Torvalds's avatar
Linus Torvalds committed
229 230

	/*
231
	 * rq is expired!
Linus Torvalds's avatar
Linus Torvalds committed
232
	 */
233
	if (time_after_eq(jiffies, rq_fifo_time(rq)))
Linus Torvalds's avatar
Linus Torvalds committed
234 235 236 237 238 239 240 241 242
		return 1;

	return 0;
}

/*
 * deadline_dispatch_requests selects the best request according to
 * read/write expire, fifo_batch, etc
 */
243
static int deadline_dispatch_requests(struct request_queue *q, int force)
Linus Torvalds's avatar
Linus Torvalds committed
244
{
245
	struct deadline_data *dd = q->elevator->elevator_data;
Linus Torvalds's avatar
Linus Torvalds committed
246 247
	const int reads = !list_empty(&dd->fifo_list[READ]);
	const int writes = !list_empty(&dd->fifo_list[WRITE]);
248
	struct request *rq;
249
	int data_dir;
Linus Torvalds's avatar
Linus Torvalds committed
250 251 252 253

	/*
	 * batches are currently reads XOR writes
	 */
254 255
	if (dd->next_rq[WRITE])
		rq = dd->next_rq[WRITE];
256
	else
257
		rq = dd->next_rq[READ];
Linus Torvalds's avatar
Linus Torvalds committed
258

259 260 261
	if (rq && dd->batching < dd->fifo_batch)
		/* we have a next request are still entitled to batch */
		goto dispatch_request;
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265 266 267 268

	/*
	 * at this point we are not running a batch. select the appropriate
	 * data direction (read / write)
	 */

	if (reads) {
269
		BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[READ]));
Linus Torvalds's avatar
Linus Torvalds committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

		if (writes && (dd->starved++ >= dd->writes_starved))
			goto dispatch_writes;

		data_dir = READ;

		goto dispatch_find_request;
	}

	/*
	 * there are either no reads or writes have been starved
	 */

	if (writes) {
dispatch_writes:
285
		BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[WRITE]));
Linus Torvalds's avatar
Linus Torvalds committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299

		dd->starved = 0;

		data_dir = WRITE;

		goto dispatch_find_request;
	}

	return 0;

dispatch_find_request:
	/*
	 * we are not running a batch, find best request for selected data_dir
	 */
300 301 302 303 304 305
	if (deadline_check_fifo(dd, data_dir) || !dd->next_rq[data_dir]) {
		/*
		 * A deadline has expired, the last request was in the other
		 * direction, or we have run out of higher-sectored requests.
		 * Start again from the request with the earliest expiry time.
		 */
306
		rq = rq_entry_fifo(dd->fifo_list[data_dir].next);
307
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
308 309 310 311
		/*
		 * The last req was the same dir and we have a next request in
		 * sort order. No expired requests so continue on from here.
		 */
312
		rq = dd->next_rq[data_dir];
Linus Torvalds's avatar
Linus Torvalds committed
313 314
	}

315 316
	dd->batching = 0;

Linus Torvalds's avatar
Linus Torvalds committed
317 318
dispatch_request:
	/*
319
	 * rq is the selected appropriate request.
Linus Torvalds's avatar
Linus Torvalds committed
320 321
	 */
	dd->batching++;
322
	deadline_move_request(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
323 324 325 326

	return 1;
}

327
static void deadline_exit_queue(struct elevator_queue *e)
Linus Torvalds's avatar
Linus Torvalds committed
328 329 330 331 332 333 334 335 336 337
{
	struct deadline_data *dd = e->elevator_data;

	BUG_ON(!list_empty(&dd->fifo_list[READ]));
	BUG_ON(!list_empty(&dd->fifo_list[WRITE]));

	kfree(dd);
}

/*
338
 * initialize elevator private data (deadline_data).
Linus Torvalds's avatar
Linus Torvalds committed
339
 */
340
static int deadline_init_queue(struct request_queue *q)
Linus Torvalds's avatar
Linus Torvalds committed
341 342 343
{
	struct deadline_data *dd;

344
	dd = kmalloc_node(sizeof(*dd), GFP_KERNEL | __GFP_ZERO, q->node);
Linus Torvalds's avatar
Linus Torvalds committed
345
	if (!dd)
346
		return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
347 348 349 350 351 352 353 354 355 356

	INIT_LIST_HEAD(&dd->fifo_list[READ]);
	INIT_LIST_HEAD(&dd->fifo_list[WRITE]);
	dd->sort_list[READ] = RB_ROOT;
	dd->sort_list[WRITE] = RB_ROOT;
	dd->fifo_expire[READ] = read_expire;
	dd->fifo_expire[WRITE] = write_expire;
	dd->writes_starved = writes_starved;
	dd->front_merges = 1;
	dd->fifo_batch = fifo_batch;
357 358 359

	q->elevator->elevator_data = dd;
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
}

/*
 * sysfs parts below
 */

static ssize_t
deadline_var_show(int var, char *page)
{
	return sprintf(page, "%d\n", var);
}

static ssize_t
deadline_var_store(int *var, const char *page, size_t count)
{
	char *p = (char *) page;

	*var = simple_strtol(p, &p, 10);
	return count;
}

#define SHOW_FUNCTION(__FUNC, __VAR, __CONV)				\
382
static ssize_t __FUNC(struct elevator_queue *e, char *page)		\
Linus Torvalds's avatar
Linus Torvalds committed
383
{									\
384 385
	struct deadline_data *dd = e->elevator_data;			\
	int __data = __VAR;						\
Linus Torvalds's avatar
Linus Torvalds committed
386 387 388 389
	if (__CONV)							\
		__data = jiffies_to_msecs(__data);			\
	return deadline_var_show(__data, (page));			\
}
390 391 392 393 394
SHOW_FUNCTION(deadline_read_expire_show, dd->fifo_expire[READ], 1);
SHOW_FUNCTION(deadline_write_expire_show, dd->fifo_expire[WRITE], 1);
SHOW_FUNCTION(deadline_writes_starved_show, dd->writes_starved, 0);
SHOW_FUNCTION(deadline_front_merges_show, dd->front_merges, 0);
SHOW_FUNCTION(deadline_fifo_batch_show, dd->fifo_batch, 0);
Linus Torvalds's avatar
Linus Torvalds committed
395 396 397
#undef SHOW_FUNCTION

#define STORE_FUNCTION(__FUNC, __PTR, MIN, MAX, __CONV)			\
398
static ssize_t __FUNC(struct elevator_queue *e, const char *page, size_t count)	\
Linus Torvalds's avatar
Linus Torvalds committed
399
{									\
400
	struct deadline_data *dd = e->elevator_data;			\
Linus Torvalds's avatar
Linus Torvalds committed
401 402 403 404 405 406 407 408 409 410 411 412
	int __data;							\
	int ret = deadline_var_store(&__data, (page), count);		\
	if (__data < (MIN))						\
		__data = (MIN);						\
	else if (__data > (MAX))					\
		__data = (MAX);						\
	if (__CONV)							\
		*(__PTR) = msecs_to_jiffies(__data);			\
	else								\
		*(__PTR) = __data;					\
	return ret;							\
}
413 414 415 416 417
STORE_FUNCTION(deadline_read_expire_store, &dd->fifo_expire[READ], 0, INT_MAX, 1);
STORE_FUNCTION(deadline_write_expire_store, &dd->fifo_expire[WRITE], 0, INT_MAX, 1);
STORE_FUNCTION(deadline_writes_starved_store, &dd->writes_starved, INT_MIN, INT_MAX, 0);
STORE_FUNCTION(deadline_front_merges_store, &dd->front_merges, 0, 1, 0);
STORE_FUNCTION(deadline_fifo_batch_store, &dd->fifo_batch, 0, INT_MAX, 0);
Linus Torvalds's avatar
Linus Torvalds committed
418 419
#undef STORE_FUNCTION

420 421 422 423 424 425 426 427 428 429 430
#define DD_ATTR(name) \
	__ATTR(name, S_IRUGO|S_IWUSR, deadline_##name##_show, \
				      deadline_##name##_store)

static struct elv_fs_entry deadline_attrs[] = {
	DD_ATTR(read_expire),
	DD_ATTR(write_expire),
	DD_ATTR(writes_starved),
	DD_ATTR(front_merges),
	DD_ATTR(fifo_batch),
	__ATTR_NULL
Linus Torvalds's avatar
Linus Torvalds committed
431 432 433 434 435 436 437
};

static struct elevator_type iosched_deadline = {
	.ops = {
		.elevator_merge_fn = 		deadline_merge,
		.elevator_merged_fn =		deadline_merged_request,
		.elevator_merge_req_fn =	deadline_merged_requests,
438 439
		.elevator_dispatch_fn =		deadline_dispatch_requests,
		.elevator_add_req_fn =		deadline_add_request,
440 441
		.elevator_former_req_fn =	elv_rb_former_request,
		.elevator_latter_req_fn =	elv_rb_latter_request,
Linus Torvalds's avatar
Linus Torvalds committed
442 443 444 445
		.elevator_init_fn =		deadline_init_queue,
		.elevator_exit_fn =		deadline_exit_queue,
	},

446
	.elevator_attrs = deadline_attrs,
Linus Torvalds's avatar
Linus Torvalds committed
447 448 449 450 451 452
	.elevator_name = "deadline",
	.elevator_owner = THIS_MODULE,
};

static int __init deadline_init(void)
{
453
	return elv_register(&iosched_deadline);
Linus Torvalds's avatar
Linus Torvalds committed
454 455 456 457 458 459 460 461 462 463 464 465 466
}

static void __exit deadline_exit(void)
{
	elv_unregister(&iosched_deadline);
}

module_init(deadline_init);
module_exit(deadline_exit);

MODULE_AUTHOR("Jens Axboe");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("deadline IO scheduler");