[PATCH] elevator_t lifetime rules and sysfs fixes
[linux-3.10.git] / include / linux / elevator.h
1 #ifndef _LINUX_ELEVATOR_H
2 #define _LINUX_ELEVATOR_H
3
4 typedef int (elevator_merge_fn) (request_queue_t *, struct request **,
5                                  struct bio *);
6
7 typedef void (elevator_merge_req_fn) (request_queue_t *, struct request *, struct request *);
8
9 typedef void (elevator_merged_fn) (request_queue_t *, struct request *);
10
11 typedef int (elevator_dispatch_fn) (request_queue_t *, int);
12
13 typedef void (elevator_add_req_fn) (request_queue_t *, struct request *);
14 typedef int (elevator_queue_empty_fn) (request_queue_t *);
15 typedef struct request *(elevator_request_list_fn) (request_queue_t *, struct request *);
16 typedef void (elevator_completed_req_fn) (request_queue_t *, struct request *);
17 typedef int (elevator_may_queue_fn) (request_queue_t *, int, struct bio *);
18
19 typedef int (elevator_set_req_fn) (request_queue_t *, struct request *, struct bio *, gfp_t);
20 typedef void (elevator_put_req_fn) (request_queue_t *, struct request *);
21 typedef void (elevator_activate_req_fn) (request_queue_t *, struct request *);
22 typedef void (elevator_deactivate_req_fn) (request_queue_t *, struct request *);
23
24 typedef int (elevator_init_fn) (request_queue_t *, elevator_t *);
25 typedef void (elevator_exit_fn) (elevator_t *);
26
27 struct elevator_ops
28 {
29         elevator_merge_fn *elevator_merge_fn;
30         elevator_merged_fn *elevator_merged_fn;
31         elevator_merge_req_fn *elevator_merge_req_fn;
32
33         elevator_dispatch_fn *elevator_dispatch_fn;
34         elevator_add_req_fn *elevator_add_req_fn;
35         elevator_activate_req_fn *elevator_activate_req_fn;
36         elevator_deactivate_req_fn *elevator_deactivate_req_fn;
37
38         elevator_queue_empty_fn *elevator_queue_empty_fn;
39         elevator_completed_req_fn *elevator_completed_req_fn;
40
41         elevator_request_list_fn *elevator_former_req_fn;
42         elevator_request_list_fn *elevator_latter_req_fn;
43
44         elevator_set_req_fn *elevator_set_req_fn;
45         elevator_put_req_fn *elevator_put_req_fn;
46
47         elevator_may_queue_fn *elevator_may_queue_fn;
48
49         elevator_init_fn *elevator_init_fn;
50         elevator_exit_fn *elevator_exit_fn;
51         void (*trim)(struct io_context *);
52 };
53
54 #define ELV_NAME_MAX    (16)
55
56 /*
57  * identifies an elevator type, such as AS or deadline
58  */
59 struct elevator_type
60 {
61         struct list_head list;
62         struct elevator_ops ops;
63         struct elevator_type *elevator_type;
64         struct attribute **elevator_attrs;
65         char elevator_name[ELV_NAME_MAX];
66         struct module *elevator_owner;
67 };
68
69 /*
70  * each queue has an elevator_queue associated with it
71  */
72 struct elevator_queue
73 {
74         struct elevator_ops *ops;
75         void *elevator_data;
76         struct kobject kobj;
77         struct elevator_type *elevator_type;
78         struct mutex sysfs_lock;
79 };
80
81 /*
82  * block elevator interface
83  */
84 extern void elv_dispatch_sort(request_queue_t *, struct request *);
85 extern void elv_add_request(request_queue_t *, struct request *, int, int);
86 extern void __elv_add_request(request_queue_t *, struct request *, int, int);
87 extern void elv_insert(request_queue_t *, struct request *, int);
88 extern int elv_merge(request_queue_t *, struct request **, struct bio *);
89 extern void elv_merge_requests(request_queue_t *, struct request *,
90                                struct request *);
91 extern void elv_merged_request(request_queue_t *, struct request *);
92 extern void elv_dequeue_request(request_queue_t *, struct request *);
93 extern void elv_requeue_request(request_queue_t *, struct request *);
94 extern int elv_queue_empty(request_queue_t *);
95 extern struct request *elv_next_request(struct request_queue *q);
96 extern struct request *elv_former_request(request_queue_t *, struct request *);
97 extern struct request *elv_latter_request(request_queue_t *, struct request *);
98 extern int elv_register_queue(request_queue_t *q);
99 extern void elv_unregister_queue(request_queue_t *q);
100 extern int elv_may_queue(request_queue_t *, int, struct bio *);
101 extern void elv_completed_request(request_queue_t *, struct request *);
102 extern int elv_set_request(request_queue_t *, struct request *, struct bio *, gfp_t);
103 extern void elv_put_request(request_queue_t *, struct request *);
104
105 /*
106  * io scheduler registration
107  */
108 extern int elv_register(struct elevator_type *);
109 extern void elv_unregister(struct elevator_type *);
110
111 /*
112  * io scheduler sysfs switching
113  */
114 extern ssize_t elv_iosched_show(request_queue_t *, char *);
115 extern ssize_t elv_iosched_store(request_queue_t *, const char *, size_t);
116
117 extern int elevator_init(request_queue_t *, char *);
118 extern void elevator_exit(elevator_t *);
119 extern int elv_rq_merge_ok(struct request *, struct bio *);
120
121 /*
122  * Return values from elevator merger
123  */
124 #define ELEVATOR_NO_MERGE       0
125 #define ELEVATOR_FRONT_MERGE    1
126 #define ELEVATOR_BACK_MERGE     2
127
128 /*
129  * Insertion selection
130  */
131 #define ELEVATOR_INSERT_FRONT   1
132 #define ELEVATOR_INSERT_BACK    2
133 #define ELEVATOR_INSERT_SORT    3
134 #define ELEVATOR_INSERT_REQUEUE 4
135
136 /*
137  * return values from elevator_may_queue_fn
138  */
139 enum {
140         ELV_MQUEUE_MAY,
141         ELV_MQUEUE_NO,
142         ELV_MQUEUE_MUST,
143 };
144
145 struct elv_fs_entry {
146         struct attribute attr;
147         ssize_t (*show)(elevator_t *, char *);
148         ssize_t (*store)(elevator_t *, const char *, size_t);
149 };
150
151 #define rq_end_sector(rq)       ((rq)->sector + (rq)->nr_sectors)
152
153 #endif