elevator.h 6.9 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
struct io_cq;
10
struct elevator_type;
11

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

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

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

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

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

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

26 27 28 29
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 已提交
30

31
typedef void (elevator_init_icq_fn) (struct io_cq *);
32
typedef void (elevator_exit_icq_fn) (struct io_cq *);
33 34
typedef int (elevator_set_req_fn) (struct request_queue *, struct request *,
				   struct bio *, gfp_t);
35
typedef void (elevator_put_req_fn) (struct request *);
36 37
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 已提交
38

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

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

51
	elevator_dispatch_fn *elevator_dispatch_fn;
L
Linus Torvalds 已提交
52
	elevator_add_req_fn *elevator_add_req_fn;
53
	elevator_activate_req_fn *elevator_activate_req_fn;
L
Linus Torvalds 已提交
54 55 56 57 58 59 60
	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;

61 62
	elevator_init_icq_fn *elevator_init_icq_fn;	/* see iocontext.h */
	elevator_exit_icq_fn *elevator_exit_icq_fn;	/* ditto */
63

L
Linus Torvalds 已提交
64 65 66 67 68 69 70 71 72 73 74
	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)

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

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

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

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

102 103
#define ELV_HASH_BITS 6

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

/*
 * block elevator interface
 */
120 121
extern void elv_dispatch_sort(struct request_queue *, struct request *);
extern void elv_dispatch_add_tail(struct request_queue *, struct request *);
J
Jens Axboe 已提交
122 123
extern void elv_add_request(struct request_queue *, struct request *, int);
extern void __elv_add_request(struct request_queue *, struct request *, int);
124 125
extern int elv_merge(struct request_queue *, struct request **, struct bio *);
extern void elv_merge_requests(struct request_queue *, struct request *,
L
Linus Torvalds 已提交
126
			       struct request *);
127
extern void elv_merged_request(struct request_queue *, struct request *, int);
D
Divyesh Shah 已提交
128 129
extern void elv_bio_merged(struct request_queue *q, struct request *,
				struct bio *);
130 131 132 133 134 135
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);
136
extern void elv_abort_queue(struct request_queue *);
137
extern void elv_completed_request(struct request_queue *, struct request *);
138 139
extern int elv_set_request(struct request_queue *q, struct request *rq,
			   struct bio *bio, gfp_t gfp_mask);
140
extern void elv_put_request(struct request_queue *, struct request *);
141
extern void elv_drain_elevator(struct request_queue *);
L
Linus Torvalds 已提交
142 143 144 145

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

/*
 * io scheduler sysfs switching
 */
153 154
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 已提交
155

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

163 164 165
/*
 * Helper functions.
 */
166 167
extern struct request *elv_rb_former_request(struct request_queue *, struct request *);
extern struct request *elv_rb_latter_request(struct request_queue *, struct request *);
168 169 170 171

/*
 * rb support functions.
 */
172
extern void elv_rb_add(struct rb_root *, struct request *);
173 174 175
extern void elv_rb_del(struct rb_root *, struct request *);
extern struct request *elv_rb_find(struct rb_root *, sector_t);

L
Linus Torvalds 已提交
176 177 178 179 180 181 182 183 184 185 186 187 188
/*
 * 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
189
#define ELEVATOR_INSERT_REQUEUE	4
190
#define ELEVATOR_INSERT_FLUSH	5
191
#define ELEVATOR_INSERT_SORT_MERGE	6
L
Linus Torvalds 已提交
192 193 194 195 196 197 198 199 200 201

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

202
#define rq_end_sector(rq)	(blk_rq_pos(rq) + blk_rq_sectors(rq))
203
#define rb_entry_rq(node)	rb_entry((node), struct request, rb_node)
J
Jens Axboe 已提交
204

205
#define rq_entry_fifo(ptr)	list_entry((ptr), struct request, queuelist)
206
#define rq_fifo_clear(rq)	list_del_init(&(rq)->queuelist)
207

208 209 210 211
#else /* CONFIG_BLOCK */

static inline void load_default_elevator_module(void) { }

212
#endif /* CONFIG_BLOCK */
L
Linus Torvalds 已提交
213
#endif