block: merge BIOVEC_SEG_BOUNDARY into biovec_phys_mergeable
[linux-block.git] / block / blk.h
CommitLineData
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
19extern struct dentry *blk_debugfs_root;
20#endif
21
7c94e1c1
ML
22struct 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 39extern struct kmem_cache *blk_requestq_cachep;
320ae51f 40extern struct kmem_cache *request_cachep;
8324aa91 41extern struct kobj_type blk_queue_ktype;
a73f730d 42extern 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 */
51static 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
57static 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
66static 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
75static 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
88static 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
101static 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
107static 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 113static 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
121static inline void __blk_get_queue(struct request_queue *q)
122{
123 kobject_get(&q->kobj);
124}
125
f70ced09
ML
126struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
127 int node, int cmd_size);
128void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 129
5b788ce3
TH
130int blk_init_rl(struct request_list *rl, struct request_queue *q,
131 gfp_t gfp_mask);
b425e504 132void blk_exit_rl(struct request_queue *q, struct request_list *rl);
4cf6324b 133void blk_exit_queue(struct request_queue *q);
86db1e29
JA
134void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
135 struct bio *bio);
d732580b
TH
136void blk_queue_bypass_start(struct request_queue *q);
137void blk_queue_bypass_end(struct request_queue *q);
8324aa91 138void __blk_queue_free_tags(struct request_queue *q);
3ef28e83
DW
139void blk_freeze_queue(struct request_queue *q);
140
141static 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
6a9f5f24
CH
152#ifndef ARCH_BIOVEC_PHYS_MERGEABLE
153#define ARCH_BIOVEC_PHYS_MERGEABLE(vec1, vec2) true
154#endif
155
3dccdae5
CH
156static inline bool biovec_phys_mergeable(struct request_queue *q,
157 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 158{
3dccdae5
CH
159 unsigned long mask = queue_segment_boundary(q);
160 phys_addr_t addr1 = bvec_to_phys(vec1);
161 phys_addr_t addr2 = bvec_to_phys(vec2);
162
163 if (addr1 + vec1->bv_len != addr2)
6a9f5f24
CH
164 return false;
165 if (!ARCH_BIOVEC_PHYS_MERGEABLE(vec1, vec2))
166 return false;
3dccdae5
CH
167 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
168 return false;
6a9f5f24
CH
169 return true;
170}
171
27ca1d4e
CH
172static inline bool __bvec_gap_to_prev(struct request_queue *q,
173 struct bio_vec *bprv, unsigned int offset)
174{
175 return offset ||
176 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
177}
178
179/*
180 * Check if adding a bio_vec after bprv with offset would create a gap in
181 * the SG list. Most drivers don't care about this, but some do.
182 */
183static inline bool bvec_gap_to_prev(struct request_queue *q,
184 struct bio_vec *bprv, unsigned int offset)
185{
186 if (!queue_virt_boundary(q))
187 return false;
188 return __bvec_gap_to_prev(q, bprv, offset);
189}
190
5a48fc14
DW
191#ifdef CONFIG_BLK_DEV_INTEGRITY
192void blk_flush_integrity(void);
7c20f116
CH
193bool __bio_integrity_endio(struct bio *);
194static inline bool bio_integrity_endio(struct bio *bio)
195{
196 if (bio_integrity(bio))
197 return __bio_integrity_endio(bio);
198 return true;
199}
43b729bf
CH
200
201static inline bool integrity_req_gap_back_merge(struct request *req,
202 struct bio *next)
203{
204 struct bio_integrity_payload *bip = bio_integrity(req->bio);
205 struct bio_integrity_payload *bip_next = bio_integrity(next);
206
207 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
208 bip_next->bip_vec[0].bv_offset);
209}
210
211static inline bool integrity_req_gap_front_merge(struct request *req,
212 struct bio *bio)
213{
214 struct bio_integrity_payload *bip = bio_integrity(bio);
215 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
216
217 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
218 bip_next->bip_vec[0].bv_offset);
219}
220#else /* CONFIG_BLK_DEV_INTEGRITY */
221static inline bool integrity_req_gap_back_merge(struct request *req,
222 struct bio *next)
223{
224 return false;
225}
226static inline bool integrity_req_gap_front_merge(struct request *req,
227 struct bio *bio)
228{
229 return false;
230}
231
5a48fc14
DW
232static inline void blk_flush_integrity(void)
233{
234}
7c20f116
CH
235static inline bool bio_integrity_endio(struct bio *bio)
236{
237 return true;
238}
43b729bf 239#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 240
287922eb 241void blk_timeout_work(struct work_struct *work);
0d2602ca 242unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 243void blk_add_timer(struct request *req);
242f9dcb 244void blk_delete_timer(struct request *);
242f9dcb 245
320ae51f
JA
246
247bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
248 struct bio *bio);
249bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
250 struct bio *bio);
1e739730
CH
251bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
252 struct bio *bio);
320ae51f 253bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
5b3f341f
SL
254 unsigned int *request_count,
255 struct request **same_queue_rq);
0809e3ac 256unsigned int blk_plug_queued_count(struct request_queue *q);
320ae51f
JA
257
258void blk_account_io_start(struct request *req, bool new_io);
259void blk_account_io_completion(struct request *req, unsigned int bytes);
522a7775 260void blk_account_io_done(struct request *req, u64 now);
320ae51f 261
242f9dcb
JA
262/*
263 * EH timer and IO completion will both attempt to 'grab' the request, make
e14575b3
JA
264 * sure that only one of them succeeds. Steal the bottom bit of the
265 * __deadline field for this.
242f9dcb
JA
266 */
267static inline int blk_mark_rq_complete(struct request *rq)
268{
e14575b3 269 return test_and_set_bit(0, &rq->__deadline);
242f9dcb
JA
270}
271
272static inline void blk_clear_rq_complete(struct request *rq)
273{
e14575b3
JA
274 clear_bit(0, &rq->__deadline);
275}
276
277static inline bool blk_rq_is_complete(struct request *rq)
278{
279 return test_bit(0, &rq->__deadline);
242f9dcb 280}
86db1e29 281
158dbda0
TH
282/*
283 * Internal elevator interface
284 */
e8064021 285#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 286
ae1b1539 287void blk_insert_flush(struct request *rq);
dd831006 288
158dbda0
TH
289static inline void elv_activate_rq(struct request_queue *q, struct request *rq)
290{
291 struct elevator_queue *e = q->elevator;
292
c51ca6cf
JA
293 if (e->type->ops.sq.elevator_activate_req_fn)
294 e->type->ops.sq.elevator_activate_req_fn(q, rq);
158dbda0
TH
295}
296
297static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq)
298{
299 struct elevator_queue *e = q->elevator;
300
c51ca6cf
JA
301 if (e->type->ops.sq.elevator_deactivate_req_fn)
302 e->type->ops.sq.elevator_deactivate_req_fn(q, rq);
158dbda0
TH
303}
304
ddb72532 305int elevator_init(struct request_queue *);
131d08e1 306int elevator_init_mq(struct request_queue *q);
d48ece20
JW
307int elevator_switch_mq(struct request_queue *q,
308 struct elevator_type *new_e);
a8a275c9 309void elevator_exit(struct request_queue *, struct elevator_queue *);
83d016ac
BVA
310int elv_register_queue(struct request_queue *q);
311void elv_unregister_queue(struct request_queue *q);
312
807d4af2
CH
313struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
314
581d4e28
JA
315#ifdef CONFIG_FAIL_IO_TIMEOUT
316int blk_should_fake_timeout(struct request_queue *);
317ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
318ssize_t part_timeout_store(struct device *, struct device_attribute *,
319 const char *, size_t);
320#else
321static inline int blk_should_fake_timeout(struct request_queue *q)
322{
323 return 0;
324}
325#endif
326
d6d48196
JA
327int ll_back_merge_fn(struct request_queue *q, struct request *req,
328 struct bio *bio);
329int ll_front_merge_fn(struct request_queue *q, struct request *req,
330 struct bio *bio);
b973cb7e
JA
331struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
332struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
5e84ea3a
JA
333int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
334 struct request *next);
d6d48196 335void blk_recalc_rq_segments(struct request *rq);
80a761fd 336void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 337bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 338enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 339
8324aa91
JA
340void blk_queue_congestion_threshold(struct request_queue *q);
341
ff88972c
AB
342int blk_dev_init(void);
343
f253b86b 344
8324aa91
JA
345/*
346 * Return the threshold (number of used requests) at which the queue is
347 * considered to be congested. It include a little hysteresis to keep the
348 * context switch rate down.
349 */
350static inline int queue_congestion_on_threshold(struct request_queue *q)
351{
352 return q->nr_congestion_on;
353}
354
355/*
356 * The threshold at which a queue is considered to be uncongested
357 */
358static inline int queue_congestion_off_threshold(struct request_queue *q)
359{
360 return q->nr_congestion_off;
361}
362
e3a2b3f9
JA
363extern int blk_update_nr_requests(struct request_queue *, unsigned int);
364
c2553b58
JA
365/*
366 * Contribute to IO statistics IFF:
367 *
368 * a) it's attached to a gendisk, and
369 * b) the queue had IO stats enabled when this request was started, and
e2a60da7 370 * c) it's a file system request
c2553b58 371 */
599d067d 372static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 373{
33659ebb 374 return rq->rq_disk &&
e8064021 375 (rq->rq_flags & RQF_IO_STAT) &&
57292b58 376 !blk_rq_is_passthrough(rq);
fb8ec18c
JA
377}
378
6cf7677f
CH
379static inline void req_set_nomerge(struct request_queue *q, struct request *req)
380{
381 req->cmd_flags |= REQ_NOMERGE;
382 if (req == q->last_merge)
383 q->last_merge = NULL;
384}
385
0a72e7f4
JA
386/*
387 * Steal a bit from this field for legacy IO path atomic IO marking. Note that
388 * setting the deadline clears the bottom bit, potentially clearing the
389 * completed bit. The user has to be OK with this (current ones are fine).
390 */
391static inline void blk_rq_set_deadline(struct request *rq, unsigned long time)
392{
393 rq->__deadline = time & ~0x1UL;
394}
395
396static inline unsigned long blk_rq_deadline(struct request *rq)
397{
398 return rq->__deadline & ~0x1UL;
399}
400
f2dbd76a
TH
401/*
402 * Internal io_context interface
403 */
404void get_io_context(struct io_context *ioc);
47fdd4ca 405struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
406struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
407 gfp_t gfp_mask);
7e5a8794 408void ioc_clear_queue(struct request_queue *q);
f2dbd76a 409
24acfc34 410int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 411
c23ecb42
JA
412/**
413 * rq_ioc - determine io_context for request allocation
414 * @bio: request being allocated is for this bio (can be %NULL)
415 *
416 * Determine io_context to use for request allocation for @bio. May return
417 * %NULL if %current->io_context doesn't exist.
418 */
419static inline struct io_context *rq_ioc(struct bio *bio)
420{
421#ifdef CONFIG_BLK_CGROUP
422 if (bio && bio->bi_ioc)
423 return bio->bi_ioc;
424#endif
425 return current->io_context;
426}
427
f2dbd76a
TH
428/**
429 * create_io_context - try to create task->io_context
f2dbd76a
TH
430 * @gfp_mask: allocation mask
431 * @node: allocation node
432 *
24acfc34
TH
433 * If %current->io_context is %NULL, allocate a new io_context and install
434 * it. Returns the current %current->io_context which may be %NULL if
435 * allocation failed.
f2dbd76a
TH
436 *
437 * Note that this function can't be called with IRQ disabled because
24acfc34 438 * task_lock which protects %current->io_context is IRQ-unsafe.
f2dbd76a 439 */
24acfc34 440static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
f2dbd76a
TH
441{
442 WARN_ON_ONCE(irqs_disabled());
24acfc34
TH
443 if (unlikely(!current->io_context))
444 create_task_io_context(current, gfp_mask, node);
445 return current->io_context;
f2dbd76a
TH
446}
447
448/*
449 * Internal throttling interface
450 */
bc9fcbf9 451#ifdef CONFIG_BLK_DEV_THROTTLING
c9a929dd 452extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9
TH
453extern int blk_throtl_init(struct request_queue *q);
454extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 455extern void blk_throtl_register_queue(struct request_queue *q);
bc9fcbf9 456#else /* CONFIG_BLK_DEV_THROTTLING */
c9a929dd 457static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9
TH
458static inline int blk_throtl_init(struct request_queue *q) { return 0; }
459static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 460static inline void blk_throtl_register_queue(struct request_queue *q) { }
bc9fcbf9 461#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
462#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
463extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
464extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
465 const char *page, size_t count);
9e234eea 466extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 467extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
468#else
469static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 470static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 471#endif
bc9fcbf9 472
3bce016a
CH
473#ifdef CONFIG_BOUNCE
474extern int init_emergency_isa_pool(void);
475extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
476#else
477static inline int init_emergency_isa_pool(void)
478{
479 return 0;
480}
481static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
482{
483}
484#endif /* CONFIG_BOUNCE */
485
454be724
ML
486extern void blk_drain_queue(struct request_queue *q);
487
d7067512
JB
488#ifdef CONFIG_BLK_CGROUP_IOLATENCY
489extern int blk_iolatency_init(struct request_queue *q);
490#else
491static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
492#endif
493
bc9fcbf9 494#endif /* BLK_INTERNAL_H */