]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - block/blk.h
netfilter: flowtable: use dev_fill_forward_path() to obtain ingress device
[mirror_ubuntu-jammy-kernel.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 6#include <linux/blk-mq.h>
c6a564ff 7#include <linux/part_stat.h>
a892c8d5 8#include <linux/blk-crypto.h>
c39ae60d 9#include <xen/xen.h>
a892c8d5 10#include "blk-crypto-internal.h"
f70ced09 11#include "blk-mq.h"
c3e22192 12#include "blk-mq-sched.h"
a73f730d 13
0d2602ca
JA
14/* Max future timer expiry for timeouts */
15#define BLK_MAX_TIMEOUT (5 * HZ)
16
18fbda91 17extern struct dentry *blk_debugfs_root;
18fbda91 18
7c94e1c1 19struct blk_flush_queue {
7c94e1c1
ML
20 unsigned int flush_pending_idx:1;
21 unsigned int flush_running_idx:1;
8d699663 22 blk_status_t rq_status;
7c94e1c1
ML
23 unsigned long flush_pending_since;
24 struct list_head flush_queue[2];
25 struct list_head flush_data_in_flight;
26 struct request *flush_rq;
0048b483 27
7c94e1c1
ML
28 spinlock_t mq_flush_lock;
29};
30
8324aa91
JA
31extern struct kmem_cache *blk_requestq_cachep;
32extern struct kobj_type blk_queue_ktype;
a73f730d 33extern struct ida blk_queue_ida;
8324aa91 34
f9afca4d
JA
35static inline struct blk_flush_queue *
36blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 37{
8ccdf4a3 38 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
39}
40
09ac46c4
TH
41static inline void __blk_get_queue(struct request_queue *q)
42{
43 kobject_get(&q->kobj);
44}
45
8d699663
YY
46static inline bool
47is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
48{
49 return hctx->fq->flush_rq == req;
50}
51
754a1572
GJ
52struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
53 gfp_t flags);
f70ced09 54void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 55
3ef28e83
DW
56void blk_freeze_queue(struct request_queue *q);
57
dc0b8a57 58#define BIO_INLINE_VECS 4
7a800a20
CH
59struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
60 gfp_t gfp_mask);
61void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs);
eec716a1 62
3dccdae5
CH
63static inline bool biovec_phys_mergeable(struct request_queue *q,
64 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 65{
3dccdae5 66 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
67 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
68 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
69
70 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 71 return false;
0383ad43 72 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 73 return false;
3dccdae5
CH
74 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
75 return false;
6a9f5f24
CH
76 return true;
77}
78
27ca1d4e
CH
79static inline bool __bvec_gap_to_prev(struct request_queue *q,
80 struct bio_vec *bprv, unsigned int offset)
81{
df376b2e 82 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
83 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
84}
85
86/*
87 * Check if adding a bio_vec after bprv with offset would create a gap in
88 * the SG list. Most drivers don't care about this, but some do.
89 */
90static inline bool bvec_gap_to_prev(struct request_queue *q,
91 struct bio_vec *bprv, unsigned int offset)
92{
93 if (!queue_virt_boundary(q))
94 return false;
95 return __bvec_gap_to_prev(q, bprv, offset);
96}
97
5a48fc14
DW
98#ifdef CONFIG_BLK_DEV_INTEGRITY
99void blk_flush_integrity(void);
7c20f116 100bool __bio_integrity_endio(struct bio *);
ece841ab 101void bio_integrity_free(struct bio *bio);
7c20f116
CH
102static inline bool bio_integrity_endio(struct bio *bio)
103{
104 if (bio_integrity(bio))
105 return __bio_integrity_endio(bio);
106 return true;
107}
43b729bf 108
92cf2fd1
CH
109bool blk_integrity_merge_rq(struct request_queue *, struct request *,
110 struct request *);
d59da419
CH
111bool blk_integrity_merge_bio(struct request_queue *, struct request *,
112 struct bio *);
92cf2fd1 113
43b729bf
CH
114static inline bool integrity_req_gap_back_merge(struct request *req,
115 struct bio *next)
116{
117 struct bio_integrity_payload *bip = bio_integrity(req->bio);
118 struct bio_integrity_payload *bip_next = bio_integrity(next);
119
120 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
121 bip_next->bip_vec[0].bv_offset);
122}
123
124static inline bool integrity_req_gap_front_merge(struct request *req,
125 struct bio *bio)
126{
127 struct bio_integrity_payload *bip = bio_integrity(bio);
128 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
129
130 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
131 bip_next->bip_vec[0].bv_offset);
132}
581e2600
CH
133
134void blk_integrity_add(struct gendisk *);
135void blk_integrity_del(struct gendisk *);
43b729bf 136#else /* CONFIG_BLK_DEV_INTEGRITY */
92cf2fd1
CH
137static inline bool blk_integrity_merge_rq(struct request_queue *rq,
138 struct request *r1, struct request *r2)
139{
140 return true;
141}
d59da419
CH
142static inline bool blk_integrity_merge_bio(struct request_queue *rq,
143 struct request *r, struct bio *b)
144{
145 return true;
146}
43b729bf
CH
147static inline bool integrity_req_gap_back_merge(struct request *req,
148 struct bio *next)
149{
150 return false;
151}
152static inline bool integrity_req_gap_front_merge(struct request *req,
153 struct bio *bio)
154{
155 return false;
156}
157
5a48fc14
DW
158static inline void blk_flush_integrity(void)
159{
160}
7c20f116
CH
161static inline bool bio_integrity_endio(struct bio *bio)
162{
163 return true;
164}
ece841ab
JT
165static inline void bio_integrity_free(struct bio *bio)
166{
167}
581e2600
CH
168static inline void blk_integrity_add(struct gendisk *disk)
169{
170}
171static inline void blk_integrity_del(struct gendisk *disk)
172{
173}
43b729bf 174#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 175
0d2602ca 176unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 177void blk_add_timer(struct request *req);
320ae51f 178
320ae51f 179bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 180 unsigned int nr_segs, struct request **same_queue_rq);
bdc6a287
BW
181bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
182 struct bio *bio, unsigned int nr_segs);
320ae51f 183
b5af37ab 184void blk_account_io_start(struct request *req);
522a7775 185void blk_account_io_done(struct request *req, u64 now);
320ae51f 186
158dbda0
TH
187/*
188 * Internal elevator interface
189 */
e8064021 190#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 191
ae1b1539 192void blk_insert_flush(struct request *rq);
dd831006 193
954b4a5c 194void elevator_init_mq(struct request_queue *q);
d48ece20
JW
195int elevator_switch_mq(struct request_queue *q,
196 struct elevator_type *new_e);
c3e22192 197void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 198int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
199void elv_unregister_queue(struct request_queue *q);
200
c3e22192
ML
201static inline void elevator_exit(struct request_queue *q,
202 struct elevator_queue *e)
203{
284b94be
ML
204 lockdep_assert_held(&q->sysfs_lock);
205
c3e22192
ML
206 blk_mq_sched_free_requests(q);
207 __elevator_exit(q, e);
208}
209
3ad5cee5
CH
210ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
211 char *buf);
212ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
213 char *buf);
214ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
215 char *buf);
216ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
217 char *buf);
218ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
219 const char *buf, size_t count);
581d4e28
JA
220ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
221ssize_t part_timeout_store(struct device *, struct device_attribute *,
222 const char *, size_t);
581d4e28 223
f695ca38 224void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
14ccb66b
CH
225int ll_back_merge_fn(struct request *req, struct bio *bio,
226 unsigned int nr_segs);
5e84ea3a
JA
227int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
228 struct request *next);
e9cd19c0 229unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 230void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 231bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 232enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 233
ff88972c
AB
234int blk_dev_init(void);
235
c2553b58
JA
236/*
237 * Contribute to IO statistics IFF:
238 *
239 * a) it's attached to a gendisk, and
48d9b0d4 240 * b) the queue had IO stats enabled when this request was started
c2553b58 241 */
599d067d 242static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 243{
48d9b0d4 244 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
245}
246
6cf7677f
CH
247static inline void req_set_nomerge(struct request_queue *q, struct request *req)
248{
249 req->cmd_flags |= REQ_NOMERGE;
250 if (req == q->last_merge)
251 q->last_merge = NULL;
252}
253
1adfc5e4
ML
254/*
255 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
256 * is defined as 'unsigned int', meantime it has to aligned to with logical
257 * block size which is the minimum accepted unit by hardware.
258 */
259static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
260{
261 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
262}
263
9b15d109
CL
264/*
265 * The max bio size which is aligned to q->limits.discard_granularity. This
266 * is a hint to split large discard bio in generic block layer, then if device
267 * driver needs to split the discard bio into smaller ones, their bi_size can
268 * be very probably and easily aligned to discard_granularity of the device's
269 * queue.
270 */
271static inline unsigned int bio_aligned_discard_max_sectors(
272 struct request_queue *q)
273{
274 return round_down(UINT_MAX, q->limits.discard_granularity) >>
275 SECTOR_SHIFT;
276}
277
f2dbd76a
TH
278/*
279 * Internal io_context interface
280 */
281void get_io_context(struct io_context *ioc);
47fdd4ca 282struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
283struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
284 gfp_t gfp_mask);
7e5a8794 285void ioc_clear_queue(struct request_queue *q);
f2dbd76a 286
24acfc34 287int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 288
f2dbd76a
TH
289/*
290 * Internal throttling interface
291 */
bc9fcbf9 292#ifdef CONFIG_BLK_DEV_THROTTLING
bc9fcbf9
TH
293extern int blk_throtl_init(struct request_queue *q);
294extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 295extern void blk_throtl_register_queue(struct request_queue *q);
db18a53e 296bool blk_throtl_bio(struct bio *bio);
bc9fcbf9 297#else /* CONFIG_BLK_DEV_THROTTLING */
bc9fcbf9
TH
298static inline int blk_throtl_init(struct request_queue *q) { return 0; }
299static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 300static inline void blk_throtl_register_queue(struct request_queue *q) { }
db18a53e 301static inline bool blk_throtl_bio(struct bio *bio) { return false; }
bc9fcbf9 302#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
303#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
304extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
305extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
306 const char *page, size_t count);
9e234eea 307extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 308extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
309#else
310static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 311static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 312#endif
bc9fcbf9 313
3bce016a
CH
314#ifdef CONFIG_BOUNCE
315extern int init_emergency_isa_pool(void);
316extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
317#else
318static inline int init_emergency_isa_pool(void)
319{
320 return 0;
321}
322static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
323{
324}
325#endif /* CONFIG_BOUNCE */
326
d7067512
JB
327#ifdef CONFIG_BLK_CGROUP_IOLATENCY
328extern int blk_iolatency_init(struct request_queue *q);
329#else
330static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
331#endif
332
a2d6b3a2
DLM
333struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
334
bf505456
DLM
335#ifdef CONFIG_BLK_DEV_ZONED
336void blk_queue_free_zone_bitmaps(struct request_queue *q);
508aebb8 337void blk_queue_clear_zone_settings(struct request_queue *q);
bf505456
DLM
338#else
339static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
508aebb8 340static inline void blk_queue_clear_zone_settings(struct request_queue *q) {}
bf505456
DLM
341#endif
342
9fc995a6 343int blk_alloc_devt(struct block_device *part, dev_t *devt);
581e2600 344void blk_free_devt(dev_t devt);
581e2600
CH
345char *disk_name(struct gendisk *hd, int partno, char *buf);
346#define ADDPART_FLAG_NONE 0
347#define ADDPART_FLAG_RAID 1
348#define ADDPART_FLAG_WHOLEDISK 2
0d02129e 349void delete_partition(struct block_device *part);
fa9156ae
CH
350int bdev_add_partition(struct block_device *bdev, int partno,
351 sector_t start, sector_t length);
352int bdev_del_partition(struct block_device *bdev, int partno);
353int bdev_resize_partition(struct block_device *bdev, int partno,
354 sector_t start, sector_t length);
581e2600 355
e4581105 356int bio_add_hw_page(struct request_queue *q, struct bio *bio,
130879f1 357 struct page *page, unsigned int len, unsigned int offset,
e4581105 358 unsigned int max_sectors, bool *same_page);
130879f1 359
bc9fcbf9 360#endif /* BLK_INTERNAL_H */