]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - include/linux/blk-mq.h
blk-mq: introduce blk_mq_complete_request_sync()
[thirdparty/kernel/stable.git] / include / linux / blk-mq.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
320ae51f
JA
2#ifndef BLK_MQ_H
3#define BLK_MQ_H
4
5#include <linux/blkdev.h>
88459642 6#include <linux/sbitmap.h>
6a83e74d 7#include <linux/srcu.h>
320ae51f
JA
8
9struct blk_mq_tags;
f70ced09 10struct blk_flush_queue;
320ae51f 11
fe644072
LW
12/**
13 * struct blk_mq_hw_ctx - State for a hardware queue facing the hardware block device
14 */
320ae51f
JA
15struct blk_mq_hw_ctx {
16 struct {
17 spinlock_t lock;
18 struct list_head dispatch;
8d354f13 19 unsigned long state; /* BLK_MQ_S_* flags */
320ae51f
JA
20 } ____cacheline_aligned_in_smp;
21
9f993737 22 struct delayed_work run_work;
e4043dcf 23 cpumask_var_t cpumask;
506e931f
JA
24 int next_cpu;
25 int next_cpu_batch;
320ae51f
JA
26
27 unsigned long flags; /* BLK_MQ_F_* flags */
28
bd166ef1 29 void *sched_data;
320ae51f 30 struct request_queue *queue;
f70ced09 31 struct blk_flush_queue *fq;
320ae51f
JA
32
33 void *driver_data;
34
88459642 35 struct sbitmap ctx_map;
1429d7c9 36
b347689f 37 struct blk_mq_ctx *dispatch_from;
6e768717 38 unsigned int dispatch_busy;
b347689f 39
f31967f0
JA
40 unsigned short type;
41 unsigned short nr_ctx;
6e768717 42 struct blk_mq_ctx **ctxs;
4bb659b1 43
5815839b 44 spinlock_t dispatch_wait_lock;
eb619fdb 45 wait_queue_entry_t dispatch_wait;
8537b120 46 atomic_t wait_index;
320ae51f 47
320ae51f 48 struct blk_mq_tags *tags;
bd166ef1 49 struct blk_mq_tags *sched_tags;
320ae51f
JA
50
51 unsigned long queued;
52 unsigned long run;
8d354f13 53#define BLK_MQ_MAX_DISPATCH_ORDER 7
320ae51f
JA
54 unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER];
55
320ae51f 56 unsigned int numa_node;
17ded320 57 unsigned int queue_num;
320ae51f 58
0d2602ca
JA
59 atomic_t nr_active;
60
9467f859 61 struct hlist_node cpuhp_dead;
320ae51f 62 struct kobject kobj;
05229bee 63
6e219353 64 unsigned long poll_considered;
05229bee
JA
65 unsigned long poll_invoked;
66 unsigned long poll_success;
9c1051aa
OS
67
68#ifdef CONFIG_BLK_DEBUG_FS
69 struct dentry *debugfs_dir;
d332ce09 70 struct dentry *sched_debugfs_dir;
9c1051aa 71#endif
07319678
BVA
72
73 /* Must be the last member - see also blk_mq_hw_ctx_size(). */
05707b64 74 struct srcu_struct srcu[0];
320ae51f
JA
75};
76
ed76e329
JA
77struct blk_mq_queue_map {
78 unsigned int *mq_map;
79 unsigned int nr_queues;
843477d4 80 unsigned int queue_offset;
ed76e329
JA
81};
82
e20ba6e1
CH
83enum hctx_type {
84 HCTX_TYPE_DEFAULT, /* all I/O not otherwise accounted for */
85 HCTX_TYPE_READ, /* just for READ I/O */
86 HCTX_TYPE_POLL, /* polled I/O of any kind */
87
88 HCTX_MAX_TYPES,
ed76e329
JA
89};
90
24d2f903 91struct blk_mq_tag_set {
b3c661b1
JA
92 /*
93 * map[] holds ctx -> hctx mappings, one map exists for each type
94 * that the driver wishes to support. There are no restrictions
95 * on maps being of the same size, and it's perfectly legal to
96 * share maps between types.
97 */
ed76e329 98 struct blk_mq_queue_map map[HCTX_MAX_TYPES];
b3c661b1 99 unsigned int nr_maps; /* nr entries in map[] */
f8a5b122 100 const struct blk_mq_ops *ops;
ed76e329 101 unsigned int nr_hw_queues; /* nr hw queues across maps */
e3a2b3f9 102 unsigned int queue_depth; /* max hw supported */
320ae51f
JA
103 unsigned int reserved_tags;
104 unsigned int cmd_size; /* per-request extra data */
105 int numa_node;
106 unsigned int timeout;
107 unsigned int flags; /* BLK_MQ_F_* */
24d2f903
CH
108 void *driver_data;
109
110 struct blk_mq_tags **tags;
0d2602ca
JA
111
112 struct mutex tag_list_lock;
113 struct list_head tag_list;
320ae51f
JA
114};
115
74c45052
JA
116struct blk_mq_queue_data {
117 struct request *rq;
74c45052
JA
118 bool last;
119};
120
fc17b653
CH
121typedef blk_status_t (queue_rq_fn)(struct blk_mq_hw_ctx *,
122 const struct blk_mq_queue_data *);
d666ba98 123typedef void (commit_rqs_fn)(struct blk_mq_hw_ctx *);
88022d72 124typedef bool (get_budget_fn)(struct blk_mq_hw_ctx *);
de148297 125typedef void (put_budget_fn)(struct blk_mq_hw_ctx *);
0152fb6b 126typedef enum blk_eh_timer_return (timeout_fn)(struct request *, bool);
320ae51f
JA
127typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
128typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
d6296d39 129typedef int (init_request_fn)(struct blk_mq_tag_set *set, struct request *,
24d2f903 130 unsigned int, unsigned int);
d6296d39 131typedef void (exit_request_fn)(struct blk_mq_tag_set *set, struct request *,
24d2f903 132 unsigned int);
320ae51f 133
7baa8572 134typedef bool (busy_iter_fn)(struct blk_mq_hw_ctx *, struct request *, void *,
81481eb4 135 bool);
7baa8572 136typedef bool (busy_tag_iter_fn)(struct request *, void *, bool);
9743139c 137typedef int (poll_fn)(struct blk_mq_hw_ctx *);
da695ba2 138typedef int (map_queues_fn)(struct blk_mq_tag_set *set);
9ba20527 139typedef bool (busy_fn)(struct request_queue *);
c7bb9ad1 140typedef void (complete_fn)(struct request *);
05229bee 141
81481eb4 142
320ae51f
JA
143struct blk_mq_ops {
144 /*
145 * Queue request
146 */
147 queue_rq_fn *queue_rq;
148
d666ba98
JA
149 /*
150 * If a driver uses bd->last to judge when to submit requests to
151 * hardware, it must define this function. In case of errors that
152 * make us stop issuing further requests, this hook serves the
153 * purpose of kicking the hardware (which the last request otherwise
154 * would have done).
155 */
156 commit_rqs_fn *commit_rqs;
157
de148297
ML
158 /*
159 * Reserve budget before queue request, once .queue_rq is
160 * run, it is driver's responsibility to release the
161 * reserved budget. Also we have to handle failure case
162 * of .get_budget for avoiding I/O deadlock.
163 */
164 get_budget_fn *get_budget;
165 put_budget_fn *put_budget;
166
320ae51f
JA
167 /*
168 * Called on request timeout
169 */
0152fb6b 170 timeout_fn *timeout;
320ae51f 171
05229bee
JA
172 /*
173 * Called to poll for completion of a specific tag.
174 */
175 poll_fn *poll;
176
c7bb9ad1 177 complete_fn *complete;
30a91cb4 178
320ae51f
JA
179 /*
180 * Called when the block layer side of a hardware queue has been
181 * set up, allowing the driver to allocate/init matching structures.
182 * Ditto for exit/teardown.
183 */
184 init_hctx_fn *init_hctx;
185 exit_hctx_fn *exit_hctx;
e9b267d9
CH
186
187 /*
188 * Called for every command allocated by the block layer to allow
189 * the driver to set up driver specific data.
f70ced09
ML
190 *
191 * Tag greater than or equal to queue_depth is for setting up
192 * flush request.
193 *
e9b267d9
CH
194 * Ditto for exit/teardown.
195 */
196 init_request_fn *init_request;
197 exit_request_fn *exit_request;
d280bab3
BVA
198 /* Called from inside blk_get_request() */
199 void (*initialize_rq_fn)(struct request *rq);
da695ba2 200
9ba20527
JA
201 /*
202 * If set, returns whether or not this queue currently is busy
203 */
204 busy_fn *busy;
205
da695ba2 206 map_queues_fn *map_queues;
2836ee4b
BVA
207
208#ifdef CONFIG_BLK_DEBUG_FS
209 /*
210 * Used by the debugfs implementation to show driver-specific
211 * information about a request.
212 */
213 void (*show_rq)(struct seq_file *m, struct request *rq);
214#endif
320ae51f
JA
215};
216
217enum {
320ae51f 218 BLK_MQ_F_SHOULD_MERGE = 1 << 0,
8a58d1f1 219 BLK_MQ_F_TAG_SHARED = 1 << 1,
1b792f2f 220 BLK_MQ_F_BLOCKING = 1 << 5,
d3484991 221 BLK_MQ_F_NO_SCHED = 1 << 6,
24391c0d
SL
222 BLK_MQ_F_ALLOC_POLICY_START_BIT = 8,
223 BLK_MQ_F_ALLOC_POLICY_BITS = 1,
320ae51f 224
5d12f905 225 BLK_MQ_S_STOPPED = 0,
0d2602ca 226 BLK_MQ_S_TAG_ACTIVE = 1,
bd166ef1 227 BLK_MQ_S_SCHED_RESTART = 2,
320ae51f 228
a4391c64 229 BLK_MQ_MAX_DEPTH = 10240,
506e931f
JA
230
231 BLK_MQ_CPU_WORK_BATCH = 8,
320ae51f 232};
24391c0d
SL
233#define BLK_MQ_FLAG_TO_ALLOC_POLICY(flags) \
234 ((flags >> BLK_MQ_F_ALLOC_POLICY_START_BIT) & \
235 ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1))
236#define BLK_ALLOC_POLICY_TO_MQ_FLAG(policy) \
237 ((policy & ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1)) \
238 << BLK_MQ_F_ALLOC_POLICY_START_BIT)
320ae51f 239
24d2f903 240struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
b62c21b7
MS
241struct request_queue *blk_mq_init_allocated_queue(struct blk_mq_tag_set *set,
242 struct request_queue *q);
9316a9ed
JA
243struct request_queue *blk_mq_init_sq_queue(struct blk_mq_tag_set *set,
244 const struct blk_mq_ops *ops,
245 unsigned int queue_depth,
246 unsigned int set_flags);
b21d5b30
MB
247int blk_mq_register_dev(struct device *, struct request_queue *);
248void blk_mq_unregister_dev(struct device *, struct request_queue *);
320ae51f 249
24d2f903
CH
250int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
251void blk_mq_free_tag_set(struct blk_mq_tag_set *set);
252
320ae51f
JA
253void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
254
320ae51f
JA
255void blk_mq_free_request(struct request *rq);
256bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
6f3b0e8b 257
3c94d83c 258bool blk_mq_queue_inflight(struct request_queue *q);
ae879912 259
6f3b0e8b 260enum {
9a95e4ef
BVA
261 /* return when out of requests */
262 BLK_MQ_REQ_NOWAIT = (__force blk_mq_req_flags_t)(1 << 0),
263 /* allocate from reserved pool */
264 BLK_MQ_REQ_RESERVED = (__force blk_mq_req_flags_t)(1 << 1),
265 /* allocate internal/sched tag */
266 BLK_MQ_REQ_INTERNAL = (__force blk_mq_req_flags_t)(1 << 2),
267 /* set RQF_PREEMPT */
268 BLK_MQ_REQ_PREEMPT = (__force blk_mq_req_flags_t)(1 << 3),
6f3b0e8b
CH
269};
270
cd6ce148 271struct request *blk_mq_alloc_request(struct request_queue *q, unsigned int op,
9a95e4ef 272 blk_mq_req_flags_t flags);
cd6ce148 273struct request *blk_mq_alloc_request_hctx(struct request_queue *q,
9a95e4ef
BVA
274 unsigned int op, blk_mq_req_flags_t flags,
275 unsigned int hctx_idx);
0e62f51f 276struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);
320ae51f 277
205fb5f5
BVA
278enum {
279 BLK_MQ_UNIQUE_TAG_BITS = 16,
280 BLK_MQ_UNIQUE_TAG_MASK = (1 << BLK_MQ_UNIQUE_TAG_BITS) - 1,
281};
282
283u32 blk_mq_unique_tag(struct request *rq);
284
285static inline u16 blk_mq_unique_tag_to_hwq(u32 unique_tag)
286{
287 return unique_tag >> BLK_MQ_UNIQUE_TAG_BITS;
288}
289
290static inline u16 blk_mq_unique_tag_to_tag(u32 unique_tag)
291{
292 return unique_tag & BLK_MQ_UNIQUE_TAG_MASK;
293}
294
320ae51f 295
973c0191 296int blk_mq_request_started(struct request *rq);
e2490073 297void blk_mq_start_request(struct request *rq);
2a842aca
CH
298void blk_mq_end_request(struct request *rq, blk_status_t error);
299void __blk_mq_end_request(struct request *rq, blk_status_t error);
320ae51f 300
2b053aca 301void blk_mq_requeue_request(struct request *rq, bool kick_requeue_list);
6fca6a61 302void blk_mq_kick_requeue_list(struct request_queue *q);
2849450a 303void blk_mq_delay_kick_requeue_list(struct request_queue *q, unsigned long msecs);
16c15eb1 304bool blk_mq_complete_request(struct request *rq);
1b8f21b7 305void blk_mq_complete_request_sync(struct request *rq);
9c558734
JA
306bool blk_mq_bio_list_merge(struct request_queue *q, struct list_head *list,
307 struct bio *bio);
fd001443 308bool blk_mq_queue_stopped(struct request_queue *q);
320ae51f
JA
309void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
310void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
280d45f6 311void blk_mq_stop_hw_queues(struct request_queue *q);
2f268556 312void blk_mq_start_hw_queues(struct request_queue *q);
ae911c5e 313void blk_mq_start_stopped_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
1b4a3258 314void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
97e01209 315void blk_mq_quiesce_queue(struct request_queue *q);
e4e73913 316void blk_mq_unquiesce_queue(struct request_queue *q);
7587a5ae 317void blk_mq_delay_run_hw_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
79f720a7 318bool blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
b94ec296 319void blk_mq_run_hw_queues(struct request_queue *q, bool async);
e0489487
SG
320void blk_mq_tagset_busy_iter(struct blk_mq_tag_set *tagset,
321 busy_tag_iter_fn *fn, void *priv);
c761d96b 322void blk_mq_freeze_queue(struct request_queue *q);
b4c6a028 323void blk_mq_unfreeze_queue(struct request_queue *q);
1671d522 324void blk_freeze_queue_start(struct request_queue *q);
6bae363e 325void blk_mq_freeze_queue_wait(struct request_queue *q);
f91328c4
KB
326int blk_mq_freeze_queue_wait_timeout(struct request_queue *q,
327 unsigned long timeout);
320ae51f 328
ed76e329 329int blk_mq_map_queues(struct blk_mq_queue_map *qmap);
868f2f0b
KB
330void blk_mq_update_nr_hw_queues(struct blk_mq_tag_set *set, int nr_hw_queues);
331
852ec809 332void blk_mq_quiesce_queue_nowait(struct request_queue *q);
4f084b41 333
9cf2bab6
JA
334unsigned int blk_mq_rq_cpu(struct request *rq);
335
320ae51f
JA
336/*
337 * Driver command data is immediately after the request. So subtract request
2963e3f7 338 * size to get back to the original request, add request size to get the PDU.
320ae51f
JA
339 */
340static inline struct request *blk_mq_rq_from_pdu(void *pdu)
341{
342 return pdu - sizeof(struct request);
343}
344static inline void *blk_mq_rq_to_pdu(struct request *rq)
345{
2963e3f7 346 return rq + 1;
320ae51f
JA
347}
348
320ae51f 349#define queue_for_each_hw_ctx(q, hctx, i) \
0d0b7d42
JA
350 for ((i) = 0; (i) < (q)->nr_hw_queues && \
351 ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
320ae51f 352
320ae51f 353#define hctx_for_each_ctx(hctx, ctx, i) \
0d0b7d42
JA
354 for ((i) = 0; (i) < (hctx)->nr_ctx && \
355 ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
320ae51f 356
7b7ab780
SG
357static inline blk_qc_t request_to_qc_t(struct blk_mq_hw_ctx *hctx,
358 struct request *rq)
359{
360 if (rq->tag != -1)
361 return rq->tag | (hctx->queue_num << BLK_QC_T_SHIFT);
362
363 return rq->internal_tag | (hctx->queue_num << BLK_QC_T_SHIFT) |
364 BLK_QC_T_INTERNAL;
365}
366
320ae51f 367#endif