blob: 926b50322a469c9d16c48ed35e10c4c12bd695f3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_ELEVATOR_H
2#define _LINUX_ELEVATOR_H
3
Jens Axboe4a893e82006-07-22 15:37:43 +02004#include <linux/percpu.h>
5
David Howells93614012006-09-30 20:45:40 +02006#ifdef CONFIG_BLOCK
7
Jens Axboe165125e2007-07-24 09:28:11 +02008typedef int (elevator_merge_fn) (struct request_queue *, struct request **,
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 struct bio *);
10
Jens Axboe165125e2007-07-24 09:28:11 +020011typedef void (elevator_merge_req_fn) (struct request_queue *, struct request *, struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
Jens Axboe165125e2007-07-24 09:28:11 +020013typedef void (elevator_merged_fn) (struct request_queue *, struct request *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
Jens Axboe165125e2007-07-24 09:28:11 +020015typedef int (elevator_allow_merge_fn) (struct request_queue *, struct request *, struct bio *);
Jens Axboeda775262006-12-20 11:04:12 +010016
Divyesh Shah812d4022010-04-08 21:14:23 -070017typedef void (elevator_bio_merged_fn) (struct request_queue *,
18 struct request *, struct bio *);
19
Jens Axboe165125e2007-07-24 09:28:11 +020020typedef int (elevator_dispatch_fn) (struct request_queue *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Jens Axboe165125e2007-07-24 09:28:11 +020022typedef void (elevator_add_req_fn) (struct request_queue *, struct request *);
23typedef int (elevator_queue_empty_fn) (struct request_queue *);
24typedef struct request *(elevator_request_list_fn) (struct request_queue *, struct request *);
25typedef void (elevator_completed_req_fn) (struct request_queue *, struct request *);
26typedef int (elevator_may_queue_fn) (struct request_queue *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Jens Axboe165125e2007-07-24 09:28:11 +020028typedef int (elevator_set_req_fn) (struct request_queue *, struct request *, gfp_t);
Jens Axboebb37b942006-12-01 10:42:33 +010029typedef void (elevator_put_req_fn) (struct request *);
Jens Axboe165125e2007-07-24 09:28:11 +020030typedef void (elevator_activate_req_fn) (struct request_queue *, struct request *);
31typedef void (elevator_deactivate_req_fn) (struct request_queue *, struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Jens Axboe165125e2007-07-24 09:28:11 +020033typedef void *(elevator_init_fn) (struct request_queue *);
Jens Axboeb374d182008-10-31 10:05:07 +010034typedef void (elevator_exit_fn) (struct elevator_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36struct elevator_ops
37{
38 elevator_merge_fn *elevator_merge_fn;
39 elevator_merged_fn *elevator_merged_fn;
40 elevator_merge_req_fn *elevator_merge_req_fn;
Jens Axboeda775262006-12-20 11:04:12 +010041 elevator_allow_merge_fn *elevator_allow_merge_fn;
Divyesh Shah812d4022010-04-08 21:14:23 -070042 elevator_bio_merged_fn *elevator_bio_merged_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Tejun Heo8922e162005-10-20 16:23:44 +020044 elevator_dispatch_fn *elevator_dispatch_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 elevator_add_req_fn *elevator_add_req_fn;
Tejun Heo8922e162005-10-20 16:23:44 +020046 elevator_activate_req_fn *elevator_activate_req_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 elevator_deactivate_req_fn *elevator_deactivate_req_fn;
48
49 elevator_queue_empty_fn *elevator_queue_empty_fn;
50 elevator_completed_req_fn *elevator_completed_req_fn;
51
52 elevator_request_list_fn *elevator_former_req_fn;
53 elevator_request_list_fn *elevator_latter_req_fn;
54
55 elevator_set_req_fn *elevator_set_req_fn;
56 elevator_put_req_fn *elevator_put_req_fn;
57
58 elevator_may_queue_fn *elevator_may_queue_fn;
59
60 elevator_init_fn *elevator_init_fn;
61 elevator_exit_fn *elevator_exit_fn;
Al Viroe17a9482006-03-18 13:21:20 -050062 void (*trim)(struct io_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
64
65#define ELV_NAME_MAX (16)
66
Al Viroe572ec72006-03-18 22:27:18 -050067struct elv_fs_entry {
68 struct attribute attr;
Jens Axboeb374d182008-10-31 10:05:07 +010069 ssize_t (*show)(struct elevator_queue *, char *);
70 ssize_t (*store)(struct elevator_queue *, const char *, size_t);
Al Viroe572ec72006-03-18 22:27:18 -050071};
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/*
74 * identifies an elevator type, such as AS or deadline
75 */
76struct elevator_type
77{
78 struct list_head list;
79 struct elevator_ops ops;
Al Viroe572ec72006-03-18 22:27:18 -050080 struct elv_fs_entry *elevator_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 char elevator_name[ELV_NAME_MAX];
82 struct module *elevator_owner;
83};
84
85/*
Adrian Bunk54069582006-01-10 00:09:36 +010086 * each queue has an elevator_queue associated with it
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 */
88struct elevator_queue
89{
90 struct elevator_ops *ops;
91 void *elevator_data;
92 struct kobject kobj;
93 struct elevator_type *elevator_type;
Al Viro3d1ab402006-03-18 18:35:43 -050094 struct mutex sysfs_lock;
Jens Axboe98170642006-07-28 09:23:08 +020095 struct hlist_head *hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096};
97
98/*
99 * block elevator interface
100 */
Jens Axboe165125e2007-07-24 09:28:11 +0200101extern void elv_dispatch_sort(struct request_queue *, struct request *);
102extern void elv_dispatch_add_tail(struct request_queue *, struct request *);
103extern void elv_add_request(struct request_queue *, struct request *, int, int);
104extern void __elv_add_request(struct request_queue *, struct request *, int, int);
105extern void elv_insert(struct request_queue *, struct request *, int);
106extern int elv_merge(struct request_queue *, struct request **, struct bio *);
107extern void elv_merge_requests(struct request_queue *, struct request *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 struct request *);
Jens Axboe165125e2007-07-24 09:28:11 +0200109extern void elv_merged_request(struct request_queue *, struct request *, int);
Divyesh Shah812d4022010-04-08 21:14:23 -0700110extern void elv_bio_merged(struct request_queue *q, struct request *,
111 struct bio *);
Jens Axboe165125e2007-07-24 09:28:11 +0200112extern void elv_requeue_request(struct request_queue *, struct request *);
113extern int elv_queue_empty(struct request_queue *);
Jens Axboe165125e2007-07-24 09:28:11 +0200114extern struct request *elv_former_request(struct request_queue *, struct request *);
115extern struct request *elv_latter_request(struct request_queue *, struct request *);
116extern int elv_register_queue(struct request_queue *q);
117extern void elv_unregister_queue(struct request_queue *q);
118extern int elv_may_queue(struct request_queue *, int);
Mike Anderson11914a52008-09-13 20:31:27 +0200119extern void elv_abort_queue(struct request_queue *);
Jens Axboe165125e2007-07-24 09:28:11 +0200120extern void elv_completed_request(struct request_queue *, struct request *);
121extern int elv_set_request(struct request_queue *, struct request *, gfp_t);
122extern void elv_put_request(struct request_queue *, struct request *);
Jerome Marchand26308ea2009-03-27 10:31:51 +0100123extern void elv_drain_elevator(struct request_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125/*
126 * io scheduler registration
127 */
Adrian Bunk2fdd82b2007-12-12 18:51:56 +0100128extern void elv_register(struct elevator_type *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129extern void elv_unregister(struct elevator_type *);
130
131/*
132 * io scheduler sysfs switching
133 */
Jens Axboe165125e2007-07-24 09:28:11 +0200134extern ssize_t elv_iosched_show(struct request_queue *, char *);
135extern ssize_t elv_iosched_store(struct request_queue *, const char *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Jens Axboe165125e2007-07-24 09:28:11 +0200137extern int elevator_init(struct request_queue *, char *);
Jens Axboeb374d182008-10-31 10:05:07 +0100138extern void elevator_exit(struct elevator_queue *);
Jens Axboe5dd531a2010-08-23 13:52:19 +0200139extern int elevator_change(struct request_queue *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140extern int elv_rq_merge_ok(struct request *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142/*
Jens Axboe2e662b62006-07-13 11:55:04 +0200143 * Helper functions.
144 */
Jens Axboe165125e2007-07-24 09:28:11 +0200145extern struct request *elv_rb_former_request(struct request_queue *, struct request *);
146extern struct request *elv_rb_latter_request(struct request_queue *, struct request *);
Jens Axboe2e662b62006-07-13 11:55:04 +0200147
148/*
149 * rb support functions.
150 */
151extern struct request *elv_rb_add(struct rb_root *, struct request *);
152extern void elv_rb_del(struct rb_root *, struct request *);
153extern struct request *elv_rb_find(struct rb_root *, sector_t);
154
155/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 * Return values from elevator merger
157 */
158#define ELEVATOR_NO_MERGE 0
159#define ELEVATOR_FRONT_MERGE 1
160#define ELEVATOR_BACK_MERGE 2
161
162/*
163 * Insertion selection
164 */
165#define ELEVATOR_INSERT_FRONT 1
166#define ELEVATOR_INSERT_BACK 2
167#define ELEVATOR_INSERT_SORT 3
Tejun Heo797e7db2006-01-06 09:51:03 +0100168#define ELEVATOR_INSERT_REQUEUE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170/*
171 * return values from elevator_may_queue_fn
172 */
173enum {
174 ELV_MQUEUE_MAY,
175 ELV_MQUEUE_NO,
176 ELV_MQUEUE_MUST,
177};
178
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900179#define rq_end_sector(rq) (blk_rq_pos(rq) + blk_rq_sectors(rq))
Jens Axboe2e662b62006-07-13 11:55:04 +0200180#define rb_entry_rq(node) rb_entry((node), struct request, rb_node)
Jens Axboe1b47f532005-10-20 16:37:00 +0200181
Jens Axboe1fbfdfc2006-07-11 21:49:15 +0200182/*
Jens Axboec7c22e42008-09-13 20:26:01 +0200183 * Hack to reuse the csd.list list_head as the fifo time holder while
Jens Axboe1fbfdfc2006-07-11 21:49:15 +0200184 * the request is in the io scheduler. Saves an unsigned long in rq.
185 */
Jens Axboec7c22e42008-09-13 20:26:01 +0200186#define rq_fifo_time(rq) ((unsigned long) (rq)->csd.list.next)
187#define rq_set_fifo_time(rq,exp) ((rq)->csd.list.next = (void *) (exp))
Jens Axboe1fbfdfc2006-07-11 21:49:15 +0200188#define rq_entry_fifo(ptr) list_entry((ptr), struct request, queuelist)
189#define rq_fifo_clear(rq) do { \
190 list_del_init(&(rq)->queuelist); \
Jens Axboec7c22e42008-09-13 20:26:01 +0200191 INIT_LIST_HEAD(&(rq)->csd.list); \
Jens Axboe1fbfdfc2006-07-11 21:49:15 +0200192 } while (0)
193
Jens Axboe4a893e82006-07-22 15:37:43 +0200194/*
195 * io context count accounting
196 */
197#define elv_ioc_count_mod(name, __val) \
198 do { \
199 preempt_disable(); \
200 __get_cpu_var(name) += (__val); \
201 preempt_enable(); \
202 } while (0)
203
204#define elv_ioc_count_inc(name) elv_ioc_count_mod(name, 1)
205#define elv_ioc_count_dec(name) elv_ioc_count_mod(name, -1)
206
207#define elv_ioc_count_read(name) \
208({ \
209 unsigned long __val = 0; \
210 int __cpu; \
211 smp_wmb(); \
212 for_each_possible_cpu(__cpu) \
213 __val += per_cpu(name, __cpu); \
214 __val; \
215})
216
David Howells93614012006-09-30 20:45:40 +0200217#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218#endif