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