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