thermal: armada: fix formula documentation comment
[linux-2.6-block.git] / include / linux / blk-mq.h
CommitLineData
320ae51f
JA
1#ifndef BLK_MQ_H
2#define BLK_MQ_H
3
4#include <linux/blkdev.h>
88459642 5#include <linux/sbitmap.h>
6a83e74d 6#include <linux/srcu.h>
320ae51f
JA
7
8struct blk_mq_tags;
f70ced09 9struct blk_flush_queue;
320ae51f 10
320ae51f
JA
11struct blk_mq_hw_ctx {
12 struct {
13 spinlock_t lock;
14 struct list_head dispatch;
8d354f13 15 unsigned long state; /* BLK_MQ_S_* flags */
320ae51f
JA
16 } ____cacheline_aligned_in_smp;
17
9f993737 18 struct delayed_work run_work;
e4043dcf 19 cpumask_var_t cpumask;
506e931f
JA
20 int next_cpu;
21 int next_cpu_batch;
320ae51f
JA
22
23 unsigned long flags; /* BLK_MQ_F_* flags */
24
bd166ef1 25 void *sched_data;
320ae51f 26 struct request_queue *queue;
f70ced09 27 struct blk_flush_queue *fq;
320ae51f
JA
28
29 void *driver_data;
30
88459642 31 struct sbitmap ctx_map;
1429d7c9 32
4bb659b1 33 struct blk_mq_ctx **ctxs;
8d354f13 34 unsigned int nr_ctx;
4bb659b1 35
ac6424b9 36 wait_queue_entry_t dispatch_wait;
8537b120 37 atomic_t wait_index;
320ae51f 38
320ae51f 39 struct blk_mq_tags *tags;
bd166ef1 40 struct blk_mq_tags *sched_tags;
320ae51f
JA
41
42 unsigned long queued;
43 unsigned long run;
8d354f13 44#define BLK_MQ_MAX_DISPATCH_ORDER 7
320ae51f
JA
45 unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER];
46
320ae51f 47 unsigned int numa_node;
17ded320 48 unsigned int queue_num;
320ae51f 49
0d2602ca
JA
50 atomic_t nr_active;
51
9467f859 52 struct hlist_node cpuhp_dead;
320ae51f 53 struct kobject kobj;
05229bee 54
6e219353 55 unsigned long poll_considered;
05229bee
JA
56 unsigned long poll_invoked;
57 unsigned long poll_success;
9c1051aa
OS
58
59#ifdef CONFIG_BLK_DEBUG_FS
60 struct dentry *debugfs_dir;
d332ce09 61 struct dentry *sched_debugfs_dir;
9c1051aa 62#endif
07319678
BVA
63
64 /* Must be the last member - see also blk_mq_hw_ctx_size(). */
65 struct srcu_struct queue_rq_srcu[0];
320ae51f
JA
66};
67
24d2f903 68struct blk_mq_tag_set {
bdd17e75 69 unsigned int *mq_map;
f8a5b122 70 const struct blk_mq_ops *ops;
320ae51f 71 unsigned int nr_hw_queues;
e3a2b3f9 72 unsigned int queue_depth; /* max hw supported */
320ae51f
JA
73 unsigned int reserved_tags;
74 unsigned int cmd_size; /* per-request extra data */
75 int numa_node;
76 unsigned int timeout;
77 unsigned int flags; /* BLK_MQ_F_* */
24d2f903
CH
78 void *driver_data;
79
80 struct blk_mq_tags **tags;
0d2602ca
JA
81
82 struct mutex tag_list_lock;
83 struct list_head tag_list;
320ae51f
JA
84};
85
74c45052
JA
86struct blk_mq_queue_data {
87 struct request *rq;
74c45052
JA
88 bool last;
89};
90
fc17b653
CH
91typedef blk_status_t (queue_rq_fn)(struct blk_mq_hw_ctx *,
92 const struct blk_mq_queue_data *);
0152fb6b 93typedef enum blk_eh_timer_return (timeout_fn)(struct request *, bool);
320ae51f
JA
94typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
95typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
d6296d39 96typedef int (init_request_fn)(struct blk_mq_tag_set *set, struct request *,
24d2f903 97 unsigned int, unsigned int);
d6296d39 98typedef void (exit_request_fn)(struct blk_mq_tag_set *set, struct request *,
24d2f903 99 unsigned int);
320ae51f 100
81481eb4
CH
101typedef void (busy_iter_fn)(struct blk_mq_hw_ctx *, struct request *, void *,
102 bool);
f26cdc85 103typedef void (busy_tag_iter_fn)(struct request *, void *, bool);
05229bee 104typedef int (poll_fn)(struct blk_mq_hw_ctx *, unsigned int);
da695ba2 105typedef int (map_queues_fn)(struct blk_mq_tag_set *set);
05229bee 106
81481eb4 107
320ae51f
JA
108struct blk_mq_ops {
109 /*
110 * Queue request
111 */
112 queue_rq_fn *queue_rq;
113
320ae51f
JA
114 /*
115 * Called on request timeout
116 */
0152fb6b 117 timeout_fn *timeout;
320ae51f 118
05229bee
JA
119 /*
120 * Called to poll for completion of a specific tag.
121 */
122 poll_fn *poll;
123
30a91cb4
CH
124 softirq_done_fn *complete;
125
320ae51f
JA
126 /*
127 * Called when the block layer side of a hardware queue has been
128 * set up, allowing the driver to allocate/init matching structures.
129 * Ditto for exit/teardown.
130 */
131 init_hctx_fn *init_hctx;
132 exit_hctx_fn *exit_hctx;
e9b267d9
CH
133
134 /*
135 * Called for every command allocated by the block layer to allow
136 * the driver to set up driver specific data.
f70ced09
ML
137 *
138 * Tag greater than or equal to queue_depth is for setting up
139 * flush request.
140 *
e9b267d9
CH
141 * Ditto for exit/teardown.
142 */
143 init_request_fn *init_request;
144 exit_request_fn *exit_request;
d280bab3
BVA
145 /* Called from inside blk_get_request() */
146 void (*initialize_rq_fn)(struct request *rq);
da695ba2
CH
147
148 map_queues_fn *map_queues;
2836ee4b
BVA
149
150#ifdef CONFIG_BLK_DEBUG_FS
151 /*
152 * Used by the debugfs implementation to show driver-specific
153 * information about a request.
154 */
155 void (*show_rq)(struct seq_file *m, struct request *rq);
156#endif
320ae51f
JA
157};
158
159enum {
320ae51f 160 BLK_MQ_F_SHOULD_MERGE = 1 << 0,
8a58d1f1
JA
161 BLK_MQ_F_TAG_SHARED = 1 << 1,
162 BLK_MQ_F_SG_MERGE = 1 << 2,
1b792f2f 163 BLK_MQ_F_BLOCKING = 1 << 5,
d3484991 164 BLK_MQ_F_NO_SCHED = 1 << 6,
24391c0d
SL
165 BLK_MQ_F_ALLOC_POLICY_START_BIT = 8,
166 BLK_MQ_F_ALLOC_POLICY_BITS = 1,
320ae51f 167
5d12f905 168 BLK_MQ_S_STOPPED = 0,
0d2602ca 169 BLK_MQ_S_TAG_ACTIVE = 1,
bd166ef1 170 BLK_MQ_S_SCHED_RESTART = 2,
da55f2cc 171 BLK_MQ_S_TAG_WAITING = 3,
21c6e939 172 BLK_MQ_S_START_ON_RUN = 4,
320ae51f 173
a4391c64 174 BLK_MQ_MAX_DEPTH = 10240,
506e931f
JA
175
176 BLK_MQ_CPU_WORK_BATCH = 8,
320ae51f 177};
24391c0d
SL
178#define BLK_MQ_FLAG_TO_ALLOC_POLICY(flags) \
179 ((flags >> BLK_MQ_F_ALLOC_POLICY_START_BIT) & \
180 ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1))
181#define BLK_ALLOC_POLICY_TO_MQ_FLAG(policy) \
182 ((policy & ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1)) \
183 << BLK_MQ_F_ALLOC_POLICY_START_BIT)
320ae51f 184
24d2f903 185struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
b62c21b7
MS
186struct request_queue *blk_mq_init_allocated_queue(struct blk_mq_tag_set *set,
187 struct request_queue *q);
b21d5b30
MB
188int blk_mq_register_dev(struct device *, struct request_queue *);
189void blk_mq_unregister_dev(struct device *, struct request_queue *);
320ae51f 190
24d2f903
CH
191int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
192void blk_mq_free_tag_set(struct blk_mq_tag_set *set);
193
320ae51f
JA
194void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
195
320ae51f
JA
196void blk_mq_free_request(struct request *rq);
197bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
6f3b0e8b
CH
198
199enum {
200 BLK_MQ_REQ_NOWAIT = (1 << 0), /* return when out of requests */
201 BLK_MQ_REQ_RESERVED = (1 << 1), /* allocate from reserved pool */
bd166ef1 202 BLK_MQ_REQ_INTERNAL = (1 << 2), /* allocate internal/sched tag */
6f3b0e8b
CH
203};
204
cd6ce148 205struct request *blk_mq_alloc_request(struct request_queue *q, unsigned int op,
6f3b0e8b 206 unsigned int flags);
cd6ce148
BVA
207struct request *blk_mq_alloc_request_hctx(struct request_queue *q,
208 unsigned int op, unsigned int flags, unsigned int hctx_idx);
0e62f51f 209struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);
320ae51f 210
205fb5f5
BVA
211enum {
212 BLK_MQ_UNIQUE_TAG_BITS = 16,
213 BLK_MQ_UNIQUE_TAG_MASK = (1 << BLK_MQ_UNIQUE_TAG_BITS) - 1,
214};
215
216u32 blk_mq_unique_tag(struct request *rq);
217
218static inline u16 blk_mq_unique_tag_to_hwq(u32 unique_tag)
219{
220 return unique_tag >> BLK_MQ_UNIQUE_TAG_BITS;
221}
222
223static inline u16 blk_mq_unique_tag_to_tag(u32 unique_tag)
224{
225 return unique_tag & BLK_MQ_UNIQUE_TAG_MASK;
226}
227
320ae51f 228
973c0191 229int blk_mq_request_started(struct request *rq);
e2490073 230void blk_mq_start_request(struct request *rq);
2a842aca
CH
231void blk_mq_end_request(struct request *rq, blk_status_t error);
232void __blk_mq_end_request(struct request *rq, blk_status_t error);
320ae51f 233
2b053aca
BVA
234void blk_mq_requeue_request(struct request *rq, bool kick_requeue_list);
235void blk_mq_add_to_requeue_list(struct request *rq, bool at_head,
236 bool kick_requeue_list);
6fca6a61 237void blk_mq_kick_requeue_list(struct request_queue *q);
2849450a 238void blk_mq_delay_kick_requeue_list(struct request_queue *q, unsigned long msecs);
08e0029a 239void blk_mq_complete_request(struct request *rq);
30a91cb4 240
fd001443 241bool blk_mq_queue_stopped(struct request_queue *q);
320ae51f
JA
242void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
243void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
280d45f6 244void blk_mq_stop_hw_queues(struct request_queue *q);
2f268556 245void blk_mq_start_hw_queues(struct request_queue *q);
ae911c5e 246void blk_mq_start_stopped_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
1b4a3258 247void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
97e01209 248void blk_mq_quiesce_queue(struct request_queue *q);
e4e73913 249void blk_mq_unquiesce_queue(struct request_queue *q);
7587a5ae 250void blk_mq_delay_run_hw_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
5b727272 251void blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
b94ec296 252void blk_mq_run_hw_queues(struct request_queue *q, bool async);
70f4db63 253void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
e0489487
SG
254void blk_mq_tagset_busy_iter(struct blk_mq_tag_set *tagset,
255 busy_tag_iter_fn *fn, void *priv);
c761d96b 256void blk_mq_freeze_queue(struct request_queue *q);
b4c6a028 257void blk_mq_unfreeze_queue(struct request_queue *q);
1671d522 258void blk_freeze_queue_start(struct request_queue *q);
6bae363e 259void blk_mq_freeze_queue_wait(struct request_queue *q);
f91328c4
KB
260int blk_mq_freeze_queue_wait_timeout(struct request_queue *q,
261 unsigned long timeout);
d352ae20
BVA
262int blk_mq_reinit_tagset(struct blk_mq_tag_set *set,
263 int (reinit_request)(void *, struct request *));
320ae51f 264
9e5a7e22 265int blk_mq_map_queues(struct blk_mq_tag_set *set);
868f2f0b
KB
266void blk_mq_update_nr_hw_queues(struct blk_mq_tag_set *set, int nr_hw_queues);
267
852ec809 268void blk_mq_quiesce_queue_nowait(struct request_queue *q);
4f084b41 269
320ae51f
JA
270/*
271 * Driver command data is immediately after the request. So subtract request
2963e3f7 272 * size to get back to the original request, add request size to get the PDU.
320ae51f
JA
273 */
274static inline struct request *blk_mq_rq_from_pdu(void *pdu)
275{
276 return pdu - sizeof(struct request);
277}
278static inline void *blk_mq_rq_to_pdu(struct request *rq)
279{
2963e3f7 280 return rq + 1;
320ae51f
JA
281}
282
320ae51f 283#define queue_for_each_hw_ctx(q, hctx, i) \
0d0b7d42
JA
284 for ((i) = 0; (i) < (q)->nr_hw_queues && \
285 ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
320ae51f 286
320ae51f 287#define hctx_for_each_ctx(hctx, ctx, i) \
0d0b7d42
JA
288 for ((i) = 0; (i) < (hctx)->nr_ctx && \
289 ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
320ae51f 290
320ae51f 291#endif