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