]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/blk-mq.h
nbd: fix use after free on module unload
[mirror_ubuntu-jammy-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
27489a3c 18 struct work_struct 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
da55f2cc 36 wait_queue_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 41
6a83e74d
BVA
42 struct srcu_struct queue_rq_srcu;
43
320ae51f
JA
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
7587a5ae 54 struct delayed_work delayed_run_work;
8d354f13
JA
55 struct delayed_work delay_work;
56
9467f859 57 struct hlist_node cpuhp_dead;
320ae51f 58 struct kobject kobj;
05229bee 59
6e219353 60 unsigned long poll_considered;
05229bee
JA
61 unsigned long poll_invoked;
62 unsigned long poll_success;
320ae51f
JA
63};
64
24d2f903 65struct blk_mq_tag_set {
bdd17e75 66 unsigned int *mq_map;
f8a5b122 67 const struct blk_mq_ops *ops;
320ae51f 68 unsigned int nr_hw_queues;
e3a2b3f9 69 unsigned int queue_depth; /* max hw supported */
320ae51f
JA
70 unsigned int reserved_tags;
71 unsigned int cmd_size; /* per-request extra data */
72 int numa_node;
73 unsigned int timeout;
74 unsigned int flags; /* BLK_MQ_F_* */
24d2f903
CH
75 void *driver_data;
76
77 struct blk_mq_tags **tags;
0d2602ca
JA
78
79 struct mutex tag_list_lock;
80 struct list_head tag_list;
320ae51f
JA
81};
82
74c45052
JA
83struct blk_mq_queue_data {
84 struct request *rq;
74c45052
JA
85 bool last;
86};
87
88typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, const struct blk_mq_queue_data *);
0152fb6b 89typedef enum blk_eh_timer_return (timeout_fn)(struct request *, bool);
320ae51f
JA
90typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
91typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
24d2f903
CH
92typedef int (init_request_fn)(void *, struct request *, unsigned int,
93 unsigned int, unsigned int);
94typedef void (exit_request_fn)(void *, struct request *, unsigned int,
95 unsigned int);
486cf989 96typedef int (reinit_request_fn)(void *, struct request *);
320ae51f 97
81481eb4
CH
98typedef void (busy_iter_fn)(struct blk_mq_hw_ctx *, struct request *, void *,
99 bool);
f26cdc85 100typedef void (busy_tag_iter_fn)(struct request *, void *, bool);
05229bee 101typedef int (poll_fn)(struct blk_mq_hw_ctx *, unsigned int);
da695ba2 102typedef int (map_queues_fn)(struct blk_mq_tag_set *set);
05229bee 103
81481eb4 104
320ae51f
JA
105struct blk_mq_ops {
106 /*
107 * Queue request
108 */
109 queue_rq_fn *queue_rq;
110
320ae51f
JA
111 /*
112 * Called on request timeout
113 */
0152fb6b 114 timeout_fn *timeout;
320ae51f 115
05229bee
JA
116 /*
117 * Called to poll for completion of a specific tag.
118 */
119 poll_fn *poll;
120
30a91cb4
CH
121 softirq_done_fn *complete;
122
320ae51f
JA
123 /*
124 * Called when the block layer side of a hardware queue has been
125 * set up, allowing the driver to allocate/init matching structures.
126 * Ditto for exit/teardown.
127 */
128 init_hctx_fn *init_hctx;
129 exit_hctx_fn *exit_hctx;
e9b267d9
CH
130
131 /*
132 * Called for every command allocated by the block layer to allow
133 * the driver to set up driver specific data.
f70ced09
ML
134 *
135 * Tag greater than or equal to queue_depth is for setting up
136 * flush request.
137 *
e9b267d9
CH
138 * Ditto for exit/teardown.
139 */
140 init_request_fn *init_request;
141 exit_request_fn *exit_request;
486cf989 142 reinit_request_fn *reinit_request;
da695ba2
CH
143
144 map_queues_fn *map_queues;
2836ee4b
BVA
145
146#ifdef CONFIG_BLK_DEBUG_FS
147 /*
148 * Used by the debugfs implementation to show driver-specific
149 * information about a request.
150 */
151 void (*show_rq)(struct seq_file *m, struct request *rq);
152#endif
320ae51f
JA
153};
154
155enum {
156 BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */
157 BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */
158 BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */
159
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,
320ae51f 172
a4391c64 173 BLK_MQ_MAX_DEPTH = 10240,
506e931f
JA
174
175 BLK_MQ_CPU_WORK_BATCH = 8,
320ae51f 176};
24391c0d
SL
177#define BLK_MQ_FLAG_TO_ALLOC_POLICY(flags) \
178 ((flags >> BLK_MQ_F_ALLOC_POLICY_START_BIT) & \
179 ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1))
180#define BLK_ALLOC_POLICY_TO_MQ_FLAG(policy) \
181 ((policy & ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1)) \
182 << BLK_MQ_F_ALLOC_POLICY_START_BIT)
320ae51f 183
24d2f903 184struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
b62c21b7
MS
185struct request_queue *blk_mq_init_allocated_queue(struct blk_mq_tag_set *set,
186 struct request_queue *q);
b21d5b30
MB
187int blk_mq_register_dev(struct device *, struct request_queue *);
188void blk_mq_unregister_dev(struct device *, struct request_queue *);
320ae51f 189
24d2f903
CH
190int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
191void blk_mq_free_tag_set(struct blk_mq_tag_set *set);
192
320ae51f
JA
193void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
194
320ae51f
JA
195void blk_mq_free_request(struct request *rq);
196bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
6f3b0e8b
CH
197
198enum {
199 BLK_MQ_REQ_NOWAIT = (1 << 0), /* return when out of requests */
200 BLK_MQ_REQ_RESERVED = (1 << 1), /* allocate from reserved pool */
bd166ef1 201 BLK_MQ_REQ_INTERNAL = (1 << 2), /* allocate internal/sched tag */
6f3b0e8b
CH
202};
203
4ce01dd1 204struct request *blk_mq_alloc_request(struct request_queue *q, int rw,
6f3b0e8b 205 unsigned int flags);
1f5bd336
ML
206struct request *blk_mq_alloc_request_hctx(struct request_queue *q, int op,
207 unsigned int flags, unsigned int hctx_idx);
0e62f51f 208struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);
320ae51f 209
205fb5f5
BVA
210enum {
211 BLK_MQ_UNIQUE_TAG_BITS = 16,
212 BLK_MQ_UNIQUE_TAG_MASK = (1 << BLK_MQ_UNIQUE_TAG_BITS) - 1,
213};
214
215u32 blk_mq_unique_tag(struct request *rq);
216
217static inline u16 blk_mq_unique_tag_to_hwq(u32 unique_tag)
218{
219 return unique_tag >> BLK_MQ_UNIQUE_TAG_BITS;
220}
221
222static inline u16 blk_mq_unique_tag_to_tag(u32 unique_tag)
223{
224 return unique_tag & BLK_MQ_UNIQUE_TAG_MASK;
225}
226
320ae51f 227
973c0191 228int blk_mq_request_started(struct request *rq);
e2490073 229void blk_mq_start_request(struct request *rq);
c8a446ad
CH
230void blk_mq_end_request(struct request *rq, int error);
231void __blk_mq_end_request(struct request *rq, int error);
320ae51f 232
2b053aca
BVA
233void blk_mq_requeue_request(struct request *rq, bool kick_requeue_list);
234void blk_mq_add_to_requeue_list(struct request *rq, bool at_head,
235 bool kick_requeue_list);
6fca6a61 236void blk_mq_kick_requeue_list(struct request_queue *q);
2849450a 237void blk_mq_delay_kick_requeue_list(struct request_queue *q, unsigned long msecs);
1885b24d 238void blk_mq_abort_requeue_list(struct request_queue *q);
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);
7587a5ae 248void blk_mq_delay_run_hw_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
5b727272 249void blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
b94ec296 250void blk_mq_run_hw_queues(struct request_queue *q, bool async);
70f4db63 251void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
e0489487
SG
252void blk_mq_tagset_busy_iter(struct blk_mq_tag_set *tagset,
253 busy_tag_iter_fn *fn, void *priv);
c761d96b 254void blk_mq_freeze_queue(struct request_queue *q);
b4c6a028 255void blk_mq_unfreeze_queue(struct request_queue *q);
1671d522 256void blk_freeze_queue_start(struct request_queue *q);
6bae363e 257void blk_mq_freeze_queue_wait(struct request_queue *q);
f91328c4
KB
258int blk_mq_freeze_queue_wait_timeout(struct request_queue *q,
259 unsigned long timeout);
486cf989 260int blk_mq_reinit_tagset(struct blk_mq_tag_set *set);
320ae51f 261
9e5a7e22 262int blk_mq_map_queues(struct blk_mq_tag_set *set);
868f2f0b
KB
263void blk_mq_update_nr_hw_queues(struct blk_mq_tag_set *set, int nr_hw_queues);
264
320ae51f
JA
265/*
266 * Driver command data is immediately after the request. So subtract request
2963e3f7 267 * size to get back to the original request, add request size to get the PDU.
320ae51f
JA
268 */
269static inline struct request *blk_mq_rq_from_pdu(void *pdu)
270{
271 return pdu - sizeof(struct request);
272}
273static inline void *blk_mq_rq_to_pdu(struct request *rq)
274{
2963e3f7 275 return rq + 1;
320ae51f
JA
276}
277
320ae51f 278#define queue_for_each_hw_ctx(q, hctx, i) \
0d0b7d42
JA
279 for ((i) = 0; (i) < (q)->nr_hw_queues && \
280 ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
320ae51f 281
320ae51f 282#define hctx_for_each_ctx(hctx, ctx, i) \
0d0b7d42
JA
283 for ((i) = 0; (i) < (hctx)->nr_ctx && \
284 ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
320ae51f 285
320ae51f 286#endif