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