]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
8324aa91 JA |
2 | #ifndef BLK_INTERNAL_H |
3 | #define BLK_INTERNAL_H | |
4 | ||
a73f730d | 5 | #include <linux/idr.h> |
f70ced09 ML |
6 | #include <linux/blk-mq.h> |
7 | #include "blk-mq.h" | |
a73f730d | 8 | |
86db1e29 JA |
9 | /* Amount of time in which a process may batch requests */ |
10 | #define BLK_BATCH_TIME (HZ/50UL) | |
11 | ||
12 | /* Number of requests a "batching" process may submit */ | |
13 | #define BLK_BATCH_REQ 32 | |
14 | ||
0d2602ca JA |
15 | /* Max future timer expiry for timeouts */ |
16 | #define BLK_MAX_TIMEOUT (5 * HZ) | |
17 | ||
18fbda91 OS |
18 | #ifdef CONFIG_DEBUG_FS |
19 | extern struct dentry *blk_debugfs_root; | |
20 | #endif | |
21 | ||
7c94e1c1 ML |
22 | struct blk_flush_queue { |
23 | unsigned int flush_queue_delayed:1; | |
24 | unsigned int flush_pending_idx:1; | |
25 | unsigned int flush_running_idx:1; | |
26 | unsigned long flush_pending_since; | |
27 | struct list_head flush_queue[2]; | |
28 | struct list_head flush_data_in_flight; | |
29 | struct request *flush_rq; | |
0048b483 ML |
30 | |
31 | /* | |
32 | * flush_rq shares tag with this rq, both can't be active | |
33 | * at the same time | |
34 | */ | |
35 | struct request *orig_rq; | |
7c94e1c1 ML |
36 | spinlock_t mq_flush_lock; |
37 | }; | |
38 | ||
8324aa91 | 39 | extern struct kmem_cache *blk_requestq_cachep; |
320ae51f | 40 | extern struct kmem_cache *request_cachep; |
8324aa91 | 41 | extern struct kobj_type blk_queue_ktype; |
a73f730d | 42 | extern struct ida blk_queue_ida; |
8324aa91 | 43 | |
8a0ac14b BVA |
44 | /* |
45 | * @q->queue_lock is set while a queue is being initialized. Since we know | |
46 | * that no other threads access the queue object before @q->queue_lock has | |
47 | * been set, it is safe to manipulate queue flags without holding the | |
48 | * queue_lock if @q->queue_lock == NULL. See also blk_alloc_queue_node() and | |
49 | * blk_init_allocated_queue(). | |
50 | */ | |
51 | static inline void queue_lockdep_assert_held(struct request_queue *q) | |
52 | { | |
53 | if (q->queue_lock) | |
54 | lockdep_assert_held(q->queue_lock); | |
55 | } | |
56 | ||
57 | static inline void queue_flag_set_unlocked(unsigned int flag, | |
58 | struct request_queue *q) | |
59 | { | |
60 | if (test_bit(QUEUE_FLAG_INIT_DONE, &q->queue_flags) && | |
61 | kref_read(&q->kobj.kref)) | |
62 | lockdep_assert_held(q->queue_lock); | |
63 | __set_bit(flag, &q->queue_flags); | |
64 | } | |
65 | ||
66 | static inline void queue_flag_clear_unlocked(unsigned int flag, | |
67 | struct request_queue *q) | |
68 | { | |
69 | if (test_bit(QUEUE_FLAG_INIT_DONE, &q->queue_flags) && | |
70 | kref_read(&q->kobj.kref)) | |
71 | lockdep_assert_held(q->queue_lock); | |
72 | __clear_bit(flag, &q->queue_flags); | |
73 | } | |
74 | ||
75 | static inline int queue_flag_test_and_clear(unsigned int flag, | |
76 | struct request_queue *q) | |
77 | { | |
78 | queue_lockdep_assert_held(q); | |
79 | ||
80 | if (test_bit(flag, &q->queue_flags)) { | |
81 | __clear_bit(flag, &q->queue_flags); | |
82 | return 1; | |
83 | } | |
84 | ||
85 | return 0; | |
86 | } | |
87 | ||
88 | static inline int queue_flag_test_and_set(unsigned int flag, | |
89 | struct request_queue *q) | |
90 | { | |
91 | queue_lockdep_assert_held(q); | |
92 | ||
93 | if (!test_bit(flag, &q->queue_flags)) { | |
94 | __set_bit(flag, &q->queue_flags); | |
95 | return 0; | |
96 | } | |
97 | ||
98 | return 1; | |
99 | } | |
100 | ||
101 | static inline void queue_flag_set(unsigned int flag, struct request_queue *q) | |
102 | { | |
103 | queue_lockdep_assert_held(q); | |
104 | __set_bit(flag, &q->queue_flags); | |
105 | } | |
106 | ||
107 | static inline void queue_flag_clear(unsigned int flag, struct request_queue *q) | |
108 | { | |
109 | queue_lockdep_assert_held(q); | |
110 | __clear_bit(flag, &q->queue_flags); | |
111 | } | |
112 | ||
7c94e1c1 | 113 | static inline struct blk_flush_queue *blk_get_flush_queue( |
e97c293c | 114 | struct request_queue *q, struct blk_mq_ctx *ctx) |
7c94e1c1 | 115 | { |
7d7e0f90 CH |
116 | if (q->mq_ops) |
117 | return blk_mq_map_queue(q, ctx->cpu)->fq; | |
118 | return q->fq; | |
7c94e1c1 ML |
119 | } |
120 | ||
09ac46c4 TH |
121 | static inline void __blk_get_queue(struct request_queue *q) |
122 | { | |
123 | kobject_get(&q->kobj); | |
124 | } | |
125 | ||
f70ced09 ML |
126 | struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q, |
127 | int node, int cmd_size); | |
128 | void blk_free_flush_queue(struct blk_flush_queue *q); | |
f3552655 | 129 | |
5b788ce3 TH |
130 | int blk_init_rl(struct request_list *rl, struct request_queue *q, |
131 | gfp_t gfp_mask); | |
b425e504 | 132 | void blk_exit_rl(struct request_queue *q, struct request_list *rl); |
4cf6324b | 133 | void blk_exit_queue(struct request_queue *q); |
86db1e29 JA |
134 | void blk_rq_bio_prep(struct request_queue *q, struct request *rq, |
135 | struct bio *bio); | |
d732580b TH |
136 | void blk_queue_bypass_start(struct request_queue *q); |
137 | void blk_queue_bypass_end(struct request_queue *q); | |
8324aa91 | 138 | void __blk_queue_free_tags(struct request_queue *q); |
3ef28e83 DW |
139 | void blk_freeze_queue(struct request_queue *q); |
140 | ||
141 | static inline void blk_queue_enter_live(struct request_queue *q) | |
142 | { | |
143 | /* | |
144 | * Given that running in generic_make_request() context | |
145 | * guarantees that a live reference against q_usage_counter has | |
146 | * been established, further references under that same context | |
147 | * need not check that the queue has been frozen (marked dead). | |
148 | */ | |
149 | percpu_ref_get(&q->q_usage_counter); | |
150 | } | |
8324aa91 | 151 | |
27ca1d4e CH |
152 | static inline bool __bvec_gap_to_prev(struct request_queue *q, |
153 | struct bio_vec *bprv, unsigned int offset) | |
154 | { | |
155 | return offset || | |
156 | ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q)); | |
157 | } | |
158 | ||
159 | /* | |
160 | * Check if adding a bio_vec after bprv with offset would create a gap in | |
161 | * the SG list. Most drivers don't care about this, but some do. | |
162 | */ | |
163 | static inline bool bvec_gap_to_prev(struct request_queue *q, | |
164 | struct bio_vec *bprv, unsigned int offset) | |
165 | { | |
166 | if (!queue_virt_boundary(q)) | |
167 | return false; | |
168 | return __bvec_gap_to_prev(q, bprv, offset); | |
169 | } | |
170 | ||
5a48fc14 DW |
171 | #ifdef CONFIG_BLK_DEV_INTEGRITY |
172 | void blk_flush_integrity(void); | |
7c20f116 CH |
173 | bool __bio_integrity_endio(struct bio *); |
174 | static inline bool bio_integrity_endio(struct bio *bio) | |
175 | { | |
176 | if (bio_integrity(bio)) | |
177 | return __bio_integrity_endio(bio); | |
178 | return true; | |
179 | } | |
43b729bf CH |
180 | |
181 | static inline bool integrity_req_gap_back_merge(struct request *req, | |
182 | struct bio *next) | |
183 | { | |
184 | struct bio_integrity_payload *bip = bio_integrity(req->bio); | |
185 | struct bio_integrity_payload *bip_next = bio_integrity(next); | |
186 | ||
187 | return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1], | |
188 | bip_next->bip_vec[0].bv_offset); | |
189 | } | |
190 | ||
191 | static inline bool integrity_req_gap_front_merge(struct request *req, | |
192 | struct bio *bio) | |
193 | { | |
194 | struct bio_integrity_payload *bip = bio_integrity(bio); | |
195 | struct bio_integrity_payload *bip_next = bio_integrity(req->bio); | |
196 | ||
197 | return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1], | |
198 | bip_next->bip_vec[0].bv_offset); | |
199 | } | |
200 | #else /* CONFIG_BLK_DEV_INTEGRITY */ | |
201 | static inline bool integrity_req_gap_back_merge(struct request *req, | |
202 | struct bio *next) | |
203 | { | |
204 | return false; | |
205 | } | |
206 | static inline bool integrity_req_gap_front_merge(struct request *req, | |
207 | struct bio *bio) | |
208 | { | |
209 | return false; | |
210 | } | |
211 | ||
5a48fc14 DW |
212 | static inline void blk_flush_integrity(void) |
213 | { | |
214 | } | |
7c20f116 CH |
215 | static inline bool bio_integrity_endio(struct bio *bio) |
216 | { | |
217 | return true; | |
218 | } | |
43b729bf | 219 | #endif /* CONFIG_BLK_DEV_INTEGRITY */ |
8324aa91 | 220 | |
287922eb | 221 | void blk_timeout_work(struct work_struct *work); |
0d2602ca | 222 | unsigned long blk_rq_timeout(unsigned long timeout); |
87ee7b11 | 223 | void blk_add_timer(struct request *req); |
242f9dcb | 224 | void blk_delete_timer(struct request *); |
242f9dcb | 225 | |
320ae51f JA |
226 | |
227 | bool bio_attempt_front_merge(struct request_queue *q, struct request *req, | |
228 | struct bio *bio); | |
229 | bool bio_attempt_back_merge(struct request_queue *q, struct request *req, | |
230 | struct bio *bio); | |
1e739730 CH |
231 | bool bio_attempt_discard_merge(struct request_queue *q, struct request *req, |
232 | struct bio *bio); | |
320ae51f | 233 | bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio, |
5b3f341f SL |
234 | unsigned int *request_count, |
235 | struct request **same_queue_rq); | |
0809e3ac | 236 | unsigned int blk_plug_queued_count(struct request_queue *q); |
320ae51f JA |
237 | |
238 | void blk_account_io_start(struct request *req, bool new_io); | |
239 | void blk_account_io_completion(struct request *req, unsigned int bytes); | |
522a7775 | 240 | void blk_account_io_done(struct request *req, u64 now); |
320ae51f | 241 | |
242f9dcb JA |
242 | /* |
243 | * EH timer and IO completion will both attempt to 'grab' the request, make | |
e14575b3 JA |
244 | * sure that only one of them succeeds. Steal the bottom bit of the |
245 | * __deadline field for this. | |
242f9dcb JA |
246 | */ |
247 | static inline int blk_mark_rq_complete(struct request *rq) | |
248 | { | |
e14575b3 | 249 | return test_and_set_bit(0, &rq->__deadline); |
242f9dcb JA |
250 | } |
251 | ||
252 | static inline void blk_clear_rq_complete(struct request *rq) | |
253 | { | |
e14575b3 JA |
254 | clear_bit(0, &rq->__deadline); |
255 | } | |
256 | ||
257 | static inline bool blk_rq_is_complete(struct request *rq) | |
258 | { | |
259 | return test_bit(0, &rq->__deadline); | |
242f9dcb | 260 | } |
86db1e29 | 261 | |
158dbda0 TH |
262 | /* |
263 | * Internal elevator interface | |
264 | */ | |
e8064021 | 265 | #define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED) |
158dbda0 | 266 | |
ae1b1539 | 267 | void blk_insert_flush(struct request *rq); |
dd831006 | 268 | |
158dbda0 TH |
269 | static inline void elv_activate_rq(struct request_queue *q, struct request *rq) |
270 | { | |
271 | struct elevator_queue *e = q->elevator; | |
272 | ||
c51ca6cf JA |
273 | if (e->type->ops.sq.elevator_activate_req_fn) |
274 | e->type->ops.sq.elevator_activate_req_fn(q, rq); | |
158dbda0 TH |
275 | } |
276 | ||
277 | static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq) | |
278 | { | |
279 | struct elevator_queue *e = q->elevator; | |
280 | ||
c51ca6cf JA |
281 | if (e->type->ops.sq.elevator_deactivate_req_fn) |
282 | e->type->ops.sq.elevator_deactivate_req_fn(q, rq); | |
158dbda0 TH |
283 | } |
284 | ||
ddb72532 | 285 | int elevator_init(struct request_queue *); |
131d08e1 | 286 | int elevator_init_mq(struct request_queue *q); |
d48ece20 JW |
287 | int elevator_switch_mq(struct request_queue *q, |
288 | struct elevator_type *new_e); | |
a8a275c9 | 289 | void elevator_exit(struct request_queue *, struct elevator_queue *); |
83d016ac BVA |
290 | int elv_register_queue(struct request_queue *q); |
291 | void elv_unregister_queue(struct request_queue *q); | |
292 | ||
807d4af2 CH |
293 | struct hd_struct *__disk_get_part(struct gendisk *disk, int partno); |
294 | ||
581d4e28 JA |
295 | #ifdef CONFIG_FAIL_IO_TIMEOUT |
296 | int blk_should_fake_timeout(struct request_queue *); | |
297 | ssize_t part_timeout_show(struct device *, struct device_attribute *, char *); | |
298 | ssize_t part_timeout_store(struct device *, struct device_attribute *, | |
299 | const char *, size_t); | |
300 | #else | |
301 | static inline int blk_should_fake_timeout(struct request_queue *q) | |
302 | { | |
303 | return 0; | |
304 | } | |
305 | #endif | |
306 | ||
d6d48196 JA |
307 | int ll_back_merge_fn(struct request_queue *q, struct request *req, |
308 | struct bio *bio); | |
309 | int ll_front_merge_fn(struct request_queue *q, struct request *req, | |
310 | struct bio *bio); | |
b973cb7e JA |
311 | struct request *attempt_back_merge(struct request_queue *q, struct request *rq); |
312 | struct request *attempt_front_merge(struct request_queue *q, struct request *rq); | |
5e84ea3a JA |
313 | int blk_attempt_req_merge(struct request_queue *q, struct request *rq, |
314 | struct request *next); | |
d6d48196 | 315 | void blk_recalc_rq_segments(struct request *rq); |
80a761fd | 316 | void blk_rq_set_mixed_merge(struct request *rq); |
050c8ea8 | 317 | bool blk_rq_merge_ok(struct request *rq, struct bio *bio); |
34fe7c05 | 318 | enum elv_merge blk_try_merge(struct request *rq, struct bio *bio); |
d6d48196 | 319 | |
8324aa91 JA |
320 | void blk_queue_congestion_threshold(struct request_queue *q); |
321 | ||
ff88972c AB |
322 | int blk_dev_init(void); |
323 | ||
f253b86b | 324 | |
8324aa91 JA |
325 | /* |
326 | * Return the threshold (number of used requests) at which the queue is | |
327 | * considered to be congested. It include a little hysteresis to keep the | |
328 | * context switch rate down. | |
329 | */ | |
330 | static inline int queue_congestion_on_threshold(struct request_queue *q) | |
331 | { | |
332 | return q->nr_congestion_on; | |
333 | } | |
334 | ||
335 | /* | |
336 | * The threshold at which a queue is considered to be uncongested | |
337 | */ | |
338 | static inline int queue_congestion_off_threshold(struct request_queue *q) | |
339 | { | |
340 | return q->nr_congestion_off; | |
341 | } | |
342 | ||
e3a2b3f9 JA |
343 | extern int blk_update_nr_requests(struct request_queue *, unsigned int); |
344 | ||
c2553b58 JA |
345 | /* |
346 | * Contribute to IO statistics IFF: | |
347 | * | |
348 | * a) it's attached to a gendisk, and | |
349 | * b) the queue had IO stats enabled when this request was started, and | |
e2a60da7 | 350 | * c) it's a file system request |
c2553b58 | 351 | */ |
599d067d | 352 | static inline bool blk_do_io_stat(struct request *rq) |
fb8ec18c | 353 | { |
33659ebb | 354 | return rq->rq_disk && |
e8064021 | 355 | (rq->rq_flags & RQF_IO_STAT) && |
57292b58 | 356 | !blk_rq_is_passthrough(rq); |
fb8ec18c JA |
357 | } |
358 | ||
6cf7677f CH |
359 | static inline void req_set_nomerge(struct request_queue *q, struct request *req) |
360 | { | |
361 | req->cmd_flags |= REQ_NOMERGE; | |
362 | if (req == q->last_merge) | |
363 | q->last_merge = NULL; | |
364 | } | |
365 | ||
0a72e7f4 JA |
366 | /* |
367 | * Steal a bit from this field for legacy IO path atomic IO marking. Note that | |
368 | * setting the deadline clears the bottom bit, potentially clearing the | |
369 | * completed bit. The user has to be OK with this (current ones are fine). | |
370 | */ | |
371 | static inline void blk_rq_set_deadline(struct request *rq, unsigned long time) | |
372 | { | |
373 | rq->__deadline = time & ~0x1UL; | |
374 | } | |
375 | ||
376 | static inline unsigned long blk_rq_deadline(struct request *rq) | |
377 | { | |
378 | return rq->__deadline & ~0x1UL; | |
379 | } | |
380 | ||
f2dbd76a TH |
381 | /* |
382 | * Internal io_context interface | |
383 | */ | |
384 | void get_io_context(struct io_context *ioc); | |
47fdd4ca | 385 | struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q); |
24acfc34 TH |
386 | struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q, |
387 | gfp_t gfp_mask); | |
7e5a8794 | 388 | void ioc_clear_queue(struct request_queue *q); |
f2dbd76a | 389 | |
24acfc34 | 390 | int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node); |
f2dbd76a | 391 | |
c23ecb42 JA |
392 | /** |
393 | * rq_ioc - determine io_context for request allocation | |
394 | * @bio: request being allocated is for this bio (can be %NULL) | |
395 | * | |
396 | * Determine io_context to use for request allocation for @bio. May return | |
397 | * %NULL if %current->io_context doesn't exist. | |
398 | */ | |
399 | static inline struct io_context *rq_ioc(struct bio *bio) | |
400 | { | |
401 | #ifdef CONFIG_BLK_CGROUP | |
402 | if (bio && bio->bi_ioc) | |
403 | return bio->bi_ioc; | |
404 | #endif | |
405 | return current->io_context; | |
406 | } | |
407 | ||
f2dbd76a TH |
408 | /** |
409 | * create_io_context - try to create task->io_context | |
f2dbd76a TH |
410 | * @gfp_mask: allocation mask |
411 | * @node: allocation node | |
412 | * | |
24acfc34 TH |
413 | * If %current->io_context is %NULL, allocate a new io_context and install |
414 | * it. Returns the current %current->io_context which may be %NULL if | |
415 | * allocation failed. | |
f2dbd76a TH |
416 | * |
417 | * Note that this function can't be called with IRQ disabled because | |
24acfc34 | 418 | * task_lock which protects %current->io_context is IRQ-unsafe. |
f2dbd76a | 419 | */ |
24acfc34 | 420 | static inline struct io_context *create_io_context(gfp_t gfp_mask, int node) |
f2dbd76a TH |
421 | { |
422 | WARN_ON_ONCE(irqs_disabled()); | |
24acfc34 TH |
423 | if (unlikely(!current->io_context)) |
424 | create_task_io_context(current, gfp_mask, node); | |
425 | return current->io_context; | |
f2dbd76a TH |
426 | } |
427 | ||
428 | /* | |
429 | * Internal throttling interface | |
430 | */ | |
bc9fcbf9 | 431 | #ifdef CONFIG_BLK_DEV_THROTTLING |
c9a929dd | 432 | extern void blk_throtl_drain(struct request_queue *q); |
bc9fcbf9 TH |
433 | extern int blk_throtl_init(struct request_queue *q); |
434 | extern void blk_throtl_exit(struct request_queue *q); | |
d61fcfa4 | 435 | extern void blk_throtl_register_queue(struct request_queue *q); |
bc9fcbf9 | 436 | #else /* CONFIG_BLK_DEV_THROTTLING */ |
c9a929dd | 437 | static inline void blk_throtl_drain(struct request_queue *q) { } |
bc9fcbf9 TH |
438 | static inline int blk_throtl_init(struct request_queue *q) { return 0; } |
439 | static inline void blk_throtl_exit(struct request_queue *q) { } | |
d61fcfa4 | 440 | static inline void blk_throtl_register_queue(struct request_queue *q) { } |
bc9fcbf9 | 441 | #endif /* CONFIG_BLK_DEV_THROTTLING */ |
297e3d85 SL |
442 | #ifdef CONFIG_BLK_DEV_THROTTLING_LOW |
443 | extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page); | |
444 | extern ssize_t blk_throtl_sample_time_store(struct request_queue *q, | |
445 | const char *page, size_t count); | |
9e234eea | 446 | extern void blk_throtl_bio_endio(struct bio *bio); |
b9147dd1 | 447 | extern void blk_throtl_stat_add(struct request *rq, u64 time); |
9e234eea SL |
448 | #else |
449 | static inline void blk_throtl_bio_endio(struct bio *bio) { } | |
b9147dd1 | 450 | static inline void blk_throtl_stat_add(struct request *rq, u64 time) { } |
297e3d85 | 451 | #endif |
bc9fcbf9 | 452 | |
3bce016a CH |
453 | #ifdef CONFIG_BOUNCE |
454 | extern int init_emergency_isa_pool(void); | |
455 | extern void blk_queue_bounce(struct request_queue *q, struct bio **bio); | |
456 | #else | |
457 | static inline int init_emergency_isa_pool(void) | |
458 | { | |
459 | return 0; | |
460 | } | |
461 | static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio) | |
462 | { | |
463 | } | |
464 | #endif /* CONFIG_BOUNCE */ | |
465 | ||
454be724 ML |
466 | extern void blk_drain_queue(struct request_queue *q); |
467 | ||
d7067512 JB |
468 | #ifdef CONFIG_BLK_CGROUP_IOLATENCY |
469 | extern int blk_iolatency_init(struct request_queue *q); | |
470 | #else | |
471 | static inline int blk_iolatency_init(struct request_queue *q) { return 0; } | |
472 | #endif | |
473 | ||
bc9fcbf9 | 474 | #endif /* BLK_INTERNAL_H */ |