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