deadline-iosched.c 11.2 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
	unsigned int batching;		/* number of sequential requests made */
	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;
};

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

55 56 57 58 59
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
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74
/*
 * 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
75
static void
76
deadline_add_rq_rb(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
77
{
78
	struct rb_root *root = deadline_rb_root(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
79

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

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

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

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

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

103
	deadline_add_rq_rb(dd, rq);
104

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

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

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

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

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

135
		__rq = elv_rb_find(&dd->sort_list[bio_data_dir(bio)], sector);
Linus Torvalds's avatar
Linus Torvalds committed
136
		if (__rq) {
137
			BUG_ON(sector != blk_rq_pos(__rq));
Linus Torvalds's avatar
Linus Torvalds committed
138

139
			if (elv_bio_merge_ok(__rq, bio)) {
140 141
				*req = __rq;
				return ELEVATOR_FRONT_MERGE;
Linus Torvalds's avatar
Linus Torvalds committed
142 143 144 145 146 147 148
			}
		}
	}

	return ELEVATOR_NO_MERGE;
}

149
static void deadline_merged_request(struct request_queue *q,
150
				    struct request *req, enum elv_merge type)
Linus Torvalds's avatar
Linus Torvalds committed
151 152 153 154 155 156
{
	struct deadline_data *dd = q->elevator->elevator_data;

	/*
	 * if the merge was a front merge, we need to reposition request
	 */
157
	if (type == ELEVATOR_FRONT_MERGE) {
158
		elv_rb_del(deadline_rb_root(dd, req), req);
159
		deadline_add_rq_rb(dd, req);
Linus Torvalds's avatar
Linus Torvalds committed
160 161 162 163
	}
}

static void
164
deadline_merged_requests(struct request_queue *q, struct request *req,
Linus Torvalds's avatar
Linus Torvalds committed
165 166 167
			 struct request *next)
{
	/*
168 169
	 * 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
170
	 */
171
	if (!list_empty(&req->queuelist) && !list_empty(&next->queuelist)) {
172 173
		if (time_before((unsigned long)next->fifo_time,
				(unsigned long)req->fifo_time)) {
174
			list_move(&req->queuelist, &next->queuelist);
175
			req->fifo_time = next->fifo_time;
Linus Torvalds's avatar
Linus Torvalds committed
176 177 178 179 180 181 182 183 184 185 186 187 188
		}
	}

	/*
	 * 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
189
deadline_move_to_dispatch(struct deadline_data *dd, struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
190
{
191
	struct request_queue *q = rq->q;
Linus Torvalds's avatar
Linus Torvalds committed
192

193 194
	deadline_remove_request(q, rq);
	elv_dispatch_add_tail(q, rq);
Linus Torvalds's avatar
Linus Torvalds committed
195 196 197 198 199 200
}

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

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

	/*
	 * take it off the sort and fifo list, move
	 * to dispatch queue
	 */
213
	deadline_move_to_dispatch(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
214 215 216
}

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

	/*
225
	 * rq is expired!
Linus Torvalds's avatar
Linus Torvalds committed
226
	 */
227
	if (time_after_eq(jiffies, (unsigned long)rq->fifo_time))
Linus Torvalds's avatar
Linus Torvalds committed
228 229 230 231 232 233 234 235 236
		return 1;

	return 0;
}

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

	/*
	 * batches are currently reads XOR writes
	 */
248 249
	if (dd->next_rq[WRITE])
		rq = dd->next_rq[WRITE];
250
	else
251
		rq = dd->next_rq[READ];
Linus Torvalds's avatar
Linus Torvalds committed
252

253 254 255
	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
256 257 258 259 260 261 262

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

	if (reads) {
263
		BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[READ]));
Linus Torvalds's avatar
Linus Torvalds committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

		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:
279
		BUG_ON(RB_EMPTY_ROOT(&dd->sort_list[WRITE]));
Linus Torvalds's avatar
Linus Torvalds committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293

		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
	 */
294 295 296 297 298 299
	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.
		 */
300
		rq = rq_entry_fifo(dd->fifo_list[data_dir].next);
301
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305
		/*
		 * The last req was the same dir and we have a next request in
		 * sort order. No expired requests so continue on from here.
		 */
306
		rq = dd->next_rq[data_dir];
Linus Torvalds's avatar
Linus Torvalds committed
307 308
	}

309 310
	dd->batching = 0;

Linus Torvalds's avatar
Linus Torvalds committed
311 312
dispatch_request:
	/*
313
	 * rq is the selected appropriate request.
Linus Torvalds's avatar
Linus Torvalds committed
314 315
	 */
	dd->batching++;
316
	deadline_move_request(dd, rq);
Linus Torvalds's avatar
Linus Torvalds committed
317 318 319 320

	return 1;
}

321
static void deadline_exit_queue(struct elevator_queue *e)
Linus Torvalds's avatar
Linus Torvalds committed
322 323 324 325 326 327 328 329 330 331
{
	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);
}

/*
332
 * initialize elevator private data (deadline_data).
Linus Torvalds's avatar
Linus Torvalds committed
333
 */
334
static int deadline_init_queue(struct request_queue *q, struct elevator_type *e)
Linus Torvalds's avatar
Linus Torvalds committed
335 336
{
	struct deadline_data *dd;
337 338 339 340 341
	struct elevator_queue *eq;

	eq = elevator_alloc(q, e);
	if (!eq)
		return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
342

343
	dd = kzalloc_node(sizeof(*dd), GFP_KERNEL, q->node);
344 345
	if (!dd) {
		kobject_put(&eq->kobj);
346
		return -ENOMEM;
347 348
	}
	eq->elevator_data = dd;
Linus Torvalds's avatar
Linus Torvalds committed
349 350 351 352 353 354 355 356 357 358

	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;
359

360 361 362
	spin_lock_irq(q->queue_lock);
	q->elevator = eq;
	spin_unlock_irq(q->queue_lock);
363
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
364 365 366 367 368 369 370 371 372 373 374 375
}

/*
 * sysfs parts below
 */

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

376 377
static void
deadline_var_store(int *var, const char *page)
Linus Torvalds's avatar
Linus Torvalds committed
378 379 380 381 382 383 384
{
	char *p = (char *) page;

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

#define SHOW_FUNCTION(__FUNC, __VAR, __CONV)				\
385
static ssize_t __FUNC(struct elevator_queue *e, char *page)		\
Linus Torvalds's avatar
Linus Torvalds committed
386
{									\
387 388
	struct deadline_data *dd = e->elevator_data;			\
	int __data = __VAR;						\
Linus Torvalds's avatar
Linus Torvalds committed
389 390 391 392
	if (__CONV)							\
		__data = jiffies_to_msecs(__data);			\
	return deadline_var_show(__data, (page));			\
}
393 394 395 396 397
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
398 399 400
#undef SHOW_FUNCTION

#define STORE_FUNCTION(__FUNC, __PTR, MIN, MAX, __CONV)			\
401
static ssize_t __FUNC(struct elevator_queue *e, const char *page, size_t count)	\
Linus Torvalds's avatar
Linus Torvalds committed
402
{									\
403
	struct deadline_data *dd = e->elevator_data;			\
Linus Torvalds's avatar
Linus Torvalds committed
404
	int __data;							\
405
	deadline_var_store(&__data, (page));				\
Linus Torvalds's avatar
Linus Torvalds committed
406 407 408 409 410 411 412 413
	if (__data < (MIN))						\
		__data = (MIN);						\
	else if (__data > (MAX))					\
		__data = (MAX);						\
	if (__CONV)							\
		*(__PTR) = msecs_to_jiffies(__data);			\
	else								\
		*(__PTR) = __data;					\
414
	return count;							\
Linus Torvalds's avatar
Linus Torvalds committed
415
}
416 417 418 419 420
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
421 422
#undef STORE_FUNCTION

423 424 425 426 427 428 429 430 431 432 433
#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
434 435 436
};

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

449
	.elevator_attrs = deadline_attrs,
Linus Torvalds's avatar
Linus Torvalds committed
450 451 452 453 454 455
	.elevator_name = "deadline",
	.elevator_owner = THIS_MODULE,
};

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

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");