Commit | Line | Data |
---|---|---|
320ae51f JA |
1 | #ifndef BLK_MQ_H |
2 | #define BLK_MQ_H | |
3 | ||
4 | #include <linux/blkdev.h> | |
88459642 | 5 | #include <linux/sbitmap.h> |
320ae51f JA |
6 | |
7 | struct blk_mq_tags; | |
f70ced09 | 8 | struct blk_flush_queue; |
320ae51f | 9 | |
320ae51f JA |
10 | struct blk_mq_hw_ctx { |
11 | struct { | |
12 | spinlock_t lock; | |
13 | struct list_head dispatch; | |
8d354f13 | 14 | unsigned long state; /* BLK_MQ_S_* flags */ |
320ae51f JA |
15 | } ____cacheline_aligned_in_smp; |
16 | ||
27489a3c | 17 | struct work_struct run_work; |
e4043dcf | 18 | cpumask_var_t cpumask; |
506e931f JA |
19 | int next_cpu; |
20 | int next_cpu_batch; | |
320ae51f JA |
21 | |
22 | unsigned long flags; /* BLK_MQ_F_* flags */ | |
23 | ||
24 | struct request_queue *queue; | |
f70ced09 | 25 | struct blk_flush_queue *fq; |
320ae51f JA |
26 | |
27 | void *driver_data; | |
28 | ||
88459642 | 29 | struct sbitmap ctx_map; |
1429d7c9 | 30 | |
4bb659b1 | 31 | struct blk_mq_ctx **ctxs; |
8d354f13 | 32 | unsigned int nr_ctx; |
4bb659b1 | 33 | |
8537b120 | 34 | atomic_t wait_index; |
320ae51f | 35 | |
320ae51f JA |
36 | struct blk_mq_tags *tags; |
37 | ||
38 | unsigned long queued; | |
39 | unsigned long run; | |
8d354f13 | 40 | #define BLK_MQ_MAX_DISPATCH_ORDER 7 |
320ae51f JA |
41 | unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER]; |
42 | ||
320ae51f | 43 | unsigned int numa_node; |
17ded320 | 44 | unsigned int queue_num; |
320ae51f | 45 | |
0d2602ca JA |
46 | atomic_t nr_active; |
47 | ||
8d354f13 JA |
48 | struct delayed_work delay_work; |
49 | ||
9467f859 | 50 | struct hlist_node cpuhp_dead; |
320ae51f | 51 | struct kobject kobj; |
05229bee | 52 | |
6e219353 | 53 | unsigned long poll_considered; |
05229bee JA |
54 | unsigned long poll_invoked; |
55 | unsigned long poll_success; | |
320ae51f JA |
56 | }; |
57 | ||
24d2f903 | 58 | struct blk_mq_tag_set { |
bdd17e75 | 59 | unsigned int *mq_map; |
320ae51f JA |
60 | struct blk_mq_ops *ops; |
61 | unsigned int nr_hw_queues; | |
e3a2b3f9 | 62 | unsigned int queue_depth; /* max hw supported */ |
320ae51f JA |
63 | unsigned int reserved_tags; |
64 | unsigned int cmd_size; /* per-request extra data */ | |
65 | int numa_node; | |
66 | unsigned int timeout; | |
67 | unsigned int flags; /* BLK_MQ_F_* */ | |
24d2f903 CH |
68 | void *driver_data; |
69 | ||
70 | struct blk_mq_tags **tags; | |
0d2602ca JA |
71 | |
72 | struct mutex tag_list_lock; | |
73 | struct list_head tag_list; | |
320ae51f JA |
74 | }; |
75 | ||
74c45052 JA |
76 | struct blk_mq_queue_data { |
77 | struct request *rq; | |
78 | struct list_head *list; | |
79 | bool last; | |
80 | }; | |
81 | ||
82 | typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, const struct blk_mq_queue_data *); | |
0152fb6b | 83 | typedef enum blk_eh_timer_return (timeout_fn)(struct request *, bool); |
320ae51f JA |
84 | typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int); |
85 | typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int); | |
24d2f903 CH |
86 | typedef int (init_request_fn)(void *, struct request *, unsigned int, |
87 | unsigned int, unsigned int); | |
88 | typedef void (exit_request_fn)(void *, struct request *, unsigned int, | |
89 | unsigned int); | |
486cf989 | 90 | typedef int (reinit_request_fn)(void *, struct request *); |
320ae51f | 91 | |
81481eb4 CH |
92 | typedef void (busy_iter_fn)(struct blk_mq_hw_ctx *, struct request *, void *, |
93 | bool); | |
f26cdc85 | 94 | typedef void (busy_tag_iter_fn)(struct request *, void *, bool); |
05229bee | 95 | typedef int (poll_fn)(struct blk_mq_hw_ctx *, unsigned int); |
da695ba2 | 96 | typedef int (map_queues_fn)(struct blk_mq_tag_set *set); |
05229bee | 97 | |
81481eb4 | 98 | |
320ae51f JA |
99 | struct blk_mq_ops { |
100 | /* | |
101 | * Queue request | |
102 | */ | |
103 | queue_rq_fn *queue_rq; | |
104 | ||
320ae51f JA |
105 | /* |
106 | * Called on request timeout | |
107 | */ | |
0152fb6b | 108 | timeout_fn *timeout; |
320ae51f | 109 | |
05229bee JA |
110 | /* |
111 | * Called to poll for completion of a specific tag. | |
112 | */ | |
113 | poll_fn *poll; | |
114 | ||
30a91cb4 CH |
115 | softirq_done_fn *complete; |
116 | ||
320ae51f JA |
117 | /* |
118 | * Called when the block layer side of a hardware queue has been | |
119 | * set up, allowing the driver to allocate/init matching structures. | |
120 | * Ditto for exit/teardown. | |
121 | */ | |
122 | init_hctx_fn *init_hctx; | |
123 | exit_hctx_fn *exit_hctx; | |
e9b267d9 CH |
124 | |
125 | /* | |
126 | * Called for every command allocated by the block layer to allow | |
127 | * the driver to set up driver specific data. | |
f70ced09 ML |
128 | * |
129 | * Tag greater than or equal to queue_depth is for setting up | |
130 | * flush request. | |
131 | * | |
e9b267d9 CH |
132 | * Ditto for exit/teardown. |
133 | */ | |
134 | init_request_fn *init_request; | |
135 | exit_request_fn *exit_request; | |
486cf989 | 136 | reinit_request_fn *reinit_request; |
da695ba2 CH |
137 | |
138 | map_queues_fn *map_queues; | |
320ae51f JA |
139 | }; |
140 | ||
141 | enum { | |
142 | BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */ | |
143 | BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */ | |
144 | BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */ | |
145 | ||
146 | BLK_MQ_F_SHOULD_MERGE = 1 << 0, | |
8a58d1f1 JA |
147 | BLK_MQ_F_TAG_SHARED = 1 << 1, |
148 | BLK_MQ_F_SG_MERGE = 1 << 2, | |
e167dfb5 | 149 | BLK_MQ_F_DEFER_ISSUE = 1 << 4, |
1b792f2f | 150 | BLK_MQ_F_BLOCKING = 1 << 5, |
24391c0d SL |
151 | BLK_MQ_F_ALLOC_POLICY_START_BIT = 8, |
152 | BLK_MQ_F_ALLOC_POLICY_BITS = 1, | |
320ae51f | 153 | |
5d12f905 | 154 | BLK_MQ_S_STOPPED = 0, |
0d2602ca | 155 | BLK_MQ_S_TAG_ACTIVE = 1, |
320ae51f | 156 | |
a4391c64 | 157 | BLK_MQ_MAX_DEPTH = 10240, |
506e931f JA |
158 | |
159 | BLK_MQ_CPU_WORK_BATCH = 8, | |
320ae51f | 160 | }; |
24391c0d SL |
161 | #define BLK_MQ_FLAG_TO_ALLOC_POLICY(flags) \ |
162 | ((flags >> BLK_MQ_F_ALLOC_POLICY_START_BIT) & \ | |
163 | ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1)) | |
164 | #define BLK_ALLOC_POLICY_TO_MQ_FLAG(policy) \ | |
165 | ((policy & ((1 << BLK_MQ_F_ALLOC_POLICY_BITS) - 1)) \ | |
166 | << BLK_MQ_F_ALLOC_POLICY_START_BIT) | |
320ae51f | 167 | |
24d2f903 | 168 | struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *); |
b62c21b7 MS |
169 | struct request_queue *blk_mq_init_allocated_queue(struct blk_mq_tag_set *set, |
170 | struct request_queue *q); | |
b21d5b30 MB |
171 | int blk_mq_register_dev(struct device *, struct request_queue *); |
172 | void blk_mq_unregister_dev(struct device *, struct request_queue *); | |
320ae51f | 173 | |
24d2f903 CH |
174 | int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set); |
175 | void blk_mq_free_tag_set(struct blk_mq_tag_set *set); | |
176 | ||
320ae51f JA |
177 | void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule); |
178 | ||
feb71dae | 179 | void blk_mq_insert_request(struct request *, bool, bool, bool); |
320ae51f | 180 | void blk_mq_free_request(struct request *rq); |
7c7f2f2b | 181 | void blk_mq_free_hctx_request(struct blk_mq_hw_ctx *, struct request *rq); |
320ae51f | 182 | bool blk_mq_can_queue(struct blk_mq_hw_ctx *); |
6f3b0e8b CH |
183 | |
184 | enum { | |
185 | BLK_MQ_REQ_NOWAIT = (1 << 0), /* return when out of requests */ | |
186 | BLK_MQ_REQ_RESERVED = (1 << 1), /* allocate from reserved pool */ | |
187 | }; | |
188 | ||
4ce01dd1 | 189 | struct request *blk_mq_alloc_request(struct request_queue *q, int rw, |
6f3b0e8b | 190 | unsigned int flags); |
1f5bd336 ML |
191 | struct request *blk_mq_alloc_request_hctx(struct request_queue *q, int op, |
192 | unsigned int flags, unsigned int hctx_idx); | |
0e62f51f | 193 | struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag); |
320ae51f | 194 | |
205fb5f5 BVA |
195 | enum { |
196 | BLK_MQ_UNIQUE_TAG_BITS = 16, | |
197 | BLK_MQ_UNIQUE_TAG_MASK = (1 << BLK_MQ_UNIQUE_TAG_BITS) - 1, | |
198 | }; | |
199 | ||
200 | u32 blk_mq_unique_tag(struct request *rq); | |
201 | ||
202 | static inline u16 blk_mq_unique_tag_to_hwq(u32 unique_tag) | |
203 | { | |
204 | return unique_tag >> BLK_MQ_UNIQUE_TAG_BITS; | |
205 | } | |
206 | ||
207 | static inline u16 blk_mq_unique_tag_to_tag(u32 unique_tag) | |
208 | { | |
209 | return unique_tag & BLK_MQ_UNIQUE_TAG_MASK; | |
210 | } | |
211 | ||
320ae51f | 212 | |
973c0191 | 213 | int blk_mq_request_started(struct request *rq); |
e2490073 | 214 | void blk_mq_start_request(struct request *rq); |
c8a446ad CH |
215 | void blk_mq_end_request(struct request *rq, int error); |
216 | void __blk_mq_end_request(struct request *rq, int error); | |
320ae51f | 217 | |
ed0791b2 | 218 | void blk_mq_requeue_request(struct request *rq); |
6fca6a61 | 219 | void blk_mq_add_to_requeue_list(struct request *rq, bool at_head); |
c68ed59f | 220 | void blk_mq_cancel_requeue_work(struct request_queue *q); |
6fca6a61 | 221 | void blk_mq_kick_requeue_list(struct request_queue *q); |
2849450a | 222 | void blk_mq_delay_kick_requeue_list(struct request_queue *q, unsigned long msecs); |
1885b24d | 223 | void blk_mq_abort_requeue_list(struct request_queue *q); |
f4829a9b | 224 | void blk_mq_complete_request(struct request *rq, int error); |
30a91cb4 | 225 | |
320ae51f JA |
226 | void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx); |
227 | void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx); | |
280d45f6 | 228 | void blk_mq_stop_hw_queues(struct request_queue *q); |
2f268556 | 229 | void blk_mq_start_hw_queues(struct request_queue *q); |
1b4a3258 | 230 | void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async); |
b94ec296 | 231 | void blk_mq_run_hw_queues(struct request_queue *q, bool async); |
70f4db63 | 232 | void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs); |
e0489487 SG |
233 | void blk_mq_tagset_busy_iter(struct blk_mq_tag_set *tagset, |
234 | busy_tag_iter_fn *fn, void *priv); | |
c761d96b | 235 | void blk_mq_freeze_queue(struct request_queue *q); |
b4c6a028 KB |
236 | void blk_mq_unfreeze_queue(struct request_queue *q); |
237 | void blk_mq_freeze_queue_start(struct request_queue *q); | |
486cf989 | 238 | int blk_mq_reinit_tagset(struct blk_mq_tag_set *set); |
320ae51f | 239 | |
868f2f0b KB |
240 | void blk_mq_update_nr_hw_queues(struct blk_mq_tag_set *set, int nr_hw_queues); |
241 | ||
320ae51f JA |
242 | /* |
243 | * Driver command data is immediately after the request. So subtract request | |
2963e3f7 | 244 | * size to get back to the original request, add request size to get the PDU. |
320ae51f JA |
245 | */ |
246 | static inline struct request *blk_mq_rq_from_pdu(void *pdu) | |
247 | { | |
248 | return pdu - sizeof(struct request); | |
249 | } | |
250 | static inline void *blk_mq_rq_to_pdu(struct request *rq) | |
251 | { | |
2963e3f7 | 252 | return rq + 1; |
320ae51f JA |
253 | } |
254 | ||
320ae51f | 255 | #define queue_for_each_hw_ctx(q, hctx, i) \ |
0d0b7d42 JA |
256 | for ((i) = 0; (i) < (q)->nr_hw_queues && \ |
257 | ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++) | |
320ae51f | 258 | |
320ae51f | 259 | #define hctx_for_each_ctx(hctx, ctx, i) \ |
0d0b7d42 JA |
260 | for ((i) = 0; (i) < (hctx)->nr_ctx && \ |
261 | ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++) | |
320ae51f | 262 | |
320ae51f | 263 | #endif |