elevator.h 7.1 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
#ifndef _LINUX_ELEVATOR_H
#define _LINUX_ELEVATOR_H

4
#include <linux/percpu.h>
5
#include <linux/hashtable.h>
6

7 8
#ifdef CONFIG_BLOCK

9 10
struct io_cq;

11
typedef int (elevator_merge_fn) (struct request_queue *, struct request **,
L
Linus Torvalds 已提交
12 13
				 struct bio *);

14
typedef void (elevator_merge_req_fn) (struct request_queue *, struct request *, struct request *);
L
Linus Torvalds 已提交
15

16
typedef void (elevator_merged_fn) (struct request_queue *, struct request *, int);
L
Linus Torvalds 已提交
17

18
typedef int (elevator_allow_merge_fn) (struct request_queue *, struct request *, struct bio *);
19

D
Divyesh Shah 已提交
20 21 22
typedef void (elevator_bio_merged_fn) (struct request_queue *,
						struct request *, struct bio *);

23
typedef int (elevator_dispatch_fn) (struct request_queue *, int);
L
Linus Torvalds 已提交
24

25 26 27 28
typedef void (elevator_add_req_fn) (struct request_queue *, struct request *);
typedef struct request *(elevator_request_list_fn) (struct request_queue *, struct request *);
typedef void (elevator_completed_req_fn) (struct request_queue *, struct request *);
typedef int (elevator_may_queue_fn) (struct request_queue *, int);
L
Linus Torvalds 已提交
29

30
typedef void (elevator_init_icq_fn) (struct io_cq *);
31
typedef void (elevator_exit_icq_fn) (struct io_cq *);
32 33
typedef int (elevator_set_req_fn) (struct request_queue *, struct request *,
				   struct bio *, gfp_t);
34
typedef void (elevator_put_req_fn) (struct request *);
35 36
typedef void (elevator_activate_req_fn) (struct request_queue *, struct request *);
typedef void (elevator_deactivate_req_fn) (struct request_queue *, struct request *);
L
Linus Torvalds 已提交
37

38
typedef int (elevator_init_fn) (struct request_queue *);
J
Jens Axboe 已提交
39
typedef void (elevator_exit_fn) (struct elevator_queue *);
L
Linus Torvalds 已提交
40 41 42 43 44 45

struct elevator_ops
{
	elevator_merge_fn *elevator_merge_fn;
	elevator_merged_fn *elevator_merged_fn;
	elevator_merge_req_fn *elevator_merge_req_fn;
46
	elevator_allow_merge_fn *elevator_allow_merge_fn;
D
Divyesh Shah 已提交
47
	elevator_bio_merged_fn *elevator_bio_merged_fn;
L
Linus Torvalds 已提交
48

49
	elevator_dispatch_fn *elevator_dispatch_fn;
L
Linus Torvalds 已提交
50
	elevator_add_req_fn *elevator_add_req_fn;
51
	elevator_activate_req_fn *elevator_activate_req_fn;
L
Linus Torvalds 已提交
52 53 54 55 56 57 58
	elevator_deactivate_req_fn *elevator_deactivate_req_fn;

	elevator_completed_req_fn *elevator_completed_req_fn;

	elevator_request_list_fn *elevator_former_req_fn;
	elevator_request_list_fn *elevator_latter_req_fn;

59 60
	elevator_init_icq_fn *elevator_init_icq_fn;	/* see iocontext.h */
	elevator_exit_icq_fn *elevator_exit_icq_fn;	/* ditto */
61

L
Linus Torvalds 已提交
62 63 64 65 66 67 68 69 70 71 72
	elevator_set_req_fn *elevator_set_req_fn;
	elevator_put_req_fn *elevator_put_req_fn;

	elevator_may_queue_fn *elevator_may_queue_fn;

	elevator_init_fn *elevator_init_fn;
	elevator_exit_fn *elevator_exit_fn;
};

#define ELV_NAME_MAX	(16)

73 74
struct elv_fs_entry {
	struct attribute attr;
J
Jens Axboe 已提交
75 76
	ssize_t (*show)(struct elevator_queue *, char *);
	ssize_t (*store)(struct elevator_queue *, const char *, size_t);
77 78
};

L
Linus Torvalds 已提交
79 80 81 82 83
/*
 * identifies an elevator type, such as AS or deadline
 */
struct elevator_type
{
84 85 86 87
	/* managed by elevator core */
	struct kmem_cache *icq_cache;

	/* fields provided by elevator implementation */
L
Linus Torvalds 已提交
88
	struct elevator_ops ops;
89 90
	size_t icq_size;	/* see iocontext.h */
	size_t icq_align;	/* ditto */
91
	struct elv_fs_entry *elevator_attrs;
L
Linus Torvalds 已提交
92 93
	char elevator_name[ELV_NAME_MAX];
	struct module *elevator_owner;
94 95 96

	/* managed by elevator core */
	char icq_cache_name[ELV_NAME_MAX + 5];	/* elvname + "_io_cq" */
T
Tejun Heo 已提交
97
	struct list_head list;
L
Linus Torvalds 已提交
98 99
};

100 101
#define ELV_HASH_BITS 6

L
Linus Torvalds 已提交
102
/*
A
Adrian Bunk 已提交
103
 * each queue has an elevator_queue associated with it
L
Linus Torvalds 已提交
104 105 106
 */
struct elevator_queue
{
T
Tejun Heo 已提交
107
	struct elevator_type *type;
L
Linus Torvalds 已提交
108 109
	void *elevator_data;
	struct kobject kobj;
110
	struct mutex sysfs_lock;
111
	unsigned int registered:1;
112
	DECLARE_HASHTABLE(hash, ELV_HASH_BITS);
L
Linus Torvalds 已提交
113 114 115 116 117
};

/*
 * block elevator interface
 */
118 119
extern void elv_dispatch_sort(struct request_queue *, struct request *);
extern void elv_dispatch_add_tail(struct request_queue *, struct request *);
J
Jens Axboe 已提交
120 121
extern void elv_add_request(struct request_queue *, struct request *, int);
extern void __elv_add_request(struct request_queue *, struct request *, int);
122 123
extern int elv_merge(struct request_queue *, struct request **, struct bio *);
extern void elv_merge_requests(struct request_queue *, struct request *,
L
Linus Torvalds 已提交
124
			       struct request *);
125
extern void elv_merged_request(struct request_queue *, struct request *, int);
D
Divyesh Shah 已提交
126 127
extern void elv_bio_merged(struct request_queue *q, struct request *,
				struct bio *);
128 129 130 131 132 133
extern void elv_requeue_request(struct request_queue *, struct request *);
extern struct request *elv_former_request(struct request_queue *, struct request *);
extern struct request *elv_latter_request(struct request_queue *, struct request *);
extern int elv_register_queue(struct request_queue *q);
extern void elv_unregister_queue(struct request_queue *q);
extern int elv_may_queue(struct request_queue *, int);
134
extern void elv_abort_queue(struct request_queue *);
135
extern void elv_completed_request(struct request_queue *, struct request *);
136 137
extern int elv_set_request(struct request_queue *q, struct request *rq,
			   struct bio *bio, gfp_t gfp_mask);
138
extern void elv_put_request(struct request_queue *, struct request *);
139
extern void elv_drain_elevator(struct request_queue *);
L
Linus Torvalds 已提交
140 141 142 143

/*
 * io scheduler registration
 */
144
extern void __init load_default_elevator_module(void);
145
extern int elv_register(struct elevator_type *);
L
Linus Torvalds 已提交
146 147 148 149 150
extern void elv_unregister(struct elevator_type *);

/*
 * io scheduler sysfs switching
 */
151 152
extern ssize_t elv_iosched_show(struct request_queue *, char *);
extern ssize_t elv_iosched_store(struct request_queue *, const char *, size_t);
L
Linus Torvalds 已提交
153

154
extern int elevator_init(struct request_queue *, char *);
J
Jens Axboe 已提交
155
extern void elevator_exit(struct elevator_queue *);
156
extern int elevator_change(struct request_queue *, const char *);
157
extern bool elv_rq_merge_ok(struct request *, struct bio *);
L
Linus Torvalds 已提交
158

159 160 161
/*
 * Helper functions.
 */
162 163
extern struct request *elv_rb_former_request(struct request_queue *, struct request *);
extern struct request *elv_rb_latter_request(struct request_queue *, struct request *);
164 165 166 167

/*
 * rb support functions.
 */
168
extern void elv_rb_add(struct rb_root *, struct request *);
169 170 171
extern void elv_rb_del(struct rb_root *, struct request *);
extern struct request *elv_rb_find(struct rb_root *, sector_t);

L
Linus Torvalds 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184
/*
 * Return values from elevator merger
 */
#define ELEVATOR_NO_MERGE	0
#define ELEVATOR_FRONT_MERGE	1
#define ELEVATOR_BACK_MERGE	2

/*
 * Insertion selection
 */
#define ELEVATOR_INSERT_FRONT	1
#define ELEVATOR_INSERT_BACK	2
#define ELEVATOR_INSERT_SORT	3
185
#define ELEVATOR_INSERT_REQUEUE	4
186
#define ELEVATOR_INSERT_FLUSH	5
187
#define ELEVATOR_INSERT_SORT_MERGE	6
L
Linus Torvalds 已提交
188 189 190 191 192 193 194 195 196 197

/*
 * return values from elevator_may_queue_fn
 */
enum {
	ELV_MQUEUE_MAY,
	ELV_MQUEUE_NO,
	ELV_MQUEUE_MUST,
};

198
#define rq_end_sector(rq)	(blk_rq_pos(rq) + blk_rq_sectors(rq))
199
#define rb_entry_rq(node)	rb_entry((node), struct request, rb_node)
J
Jens Axboe 已提交
200

201
/*
202
 * Hack to reuse the csd.list list_head as the fifo time holder while
203 204
 * the request is in the io scheduler. Saves an unsigned long in rq.
 */
205 206
#define rq_fifo_time(rq)	((unsigned long) (rq)->csd.list.next)
#define rq_set_fifo_time(rq,exp)	((rq)->csd.list.next = (void *) (exp))
207 208 209
#define rq_entry_fifo(ptr)	list_entry((ptr), struct request, queuelist)
#define rq_fifo_clear(rq)	do {		\
	list_del_init(&(rq)->queuelist);	\
210
	INIT_LIST_HEAD(&(rq)->csd.list);	\
211 212
	} while (0)

213 214 215 216
#else /* CONFIG_BLOCK */

static inline void load_default_elevator_module(void) { }

217
#endif /* CONFIG_BLOCK */
L
Linus Torvalds 已提交
218
#endif