Commit | Line | Data |
---|---|---|
8c16567d | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 | 2 | /* |
1da177e4 | 3 | * Copyright (C) 2001 Jens Axboe <axboe@suse.de> |
1da177e4 LT |
4 | */ |
5 | #ifndef __LINUX_BIO_H | |
6 | #define __LINUX_BIO_H | |
7 | ||
1da177e4 | 8 | #include <linux/mempool.h> |
7cc01581 TH |
9 | /* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */ |
10 | #include <linux/blk_types.h> | |
3e1a88ec | 11 | #include <linux/uio.h> |
7cc01581 | 12 | |
a8affc03 | 13 | #define BIO_MAX_VECS 256U |
5f7136db | 14 | |
fd8f8ede CH |
15 | struct queue_limits; |
16 | ||
5f7136db MWO |
17 | static inline unsigned int bio_max_segs(unsigned int nr_segs) |
18 | { | |
a8affc03 | 19 | return min(nr_segs, BIO_MAX_VECS); |
5f7136db | 20 | } |
1da177e4 | 21 | |
43b62ce3 MC |
22 | #define bio_prio(bio) (bio)->bi_ioprio |
23 | #define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio) | |
22e2c507 | 24 | |
4550dd6c KO |
25 | #define bio_iter_iovec(bio, iter) \ |
26 | bvec_iter_bvec((bio)->bi_io_vec, (iter)) | |
27 | ||
28 | #define bio_iter_page(bio, iter) \ | |
29 | bvec_iter_page((bio)->bi_io_vec, (iter)) | |
30 | #define bio_iter_len(bio, iter) \ | |
31 | bvec_iter_len((bio)->bi_io_vec, (iter)) | |
32 | #define bio_iter_offset(bio, iter) \ | |
33 | bvec_iter_offset((bio)->bi_io_vec, (iter)) | |
34 | ||
35 | #define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter) | |
36 | #define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter) | |
37 | #define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter) | |
7988613b | 38 | |
38a72dac KO |
39 | #define bvec_iter_sectors(iter) ((iter).bi_size >> 9) |
40 | #define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter))) | |
41 | ||
42 | #define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter) | |
43 | #define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter) | |
bf2de6f5 | 44 | |
d3849953 CH |
45 | /* |
46 | * Return the data direction, READ or WRITE. | |
47 | */ | |
48 | #define bio_data_dir(bio) \ | |
49 | (op_is_write(bio_op(bio)) ? WRITE : READ) | |
50 | ||
458b76ed KO |
51 | /* |
52 | * Check whether this bio carries any data or not. A NULL bio is allowed. | |
53 | */ | |
54 | static inline bool bio_has_data(struct bio *bio) | |
55 | { | |
56 | if (bio && | |
57 | bio->bi_iter.bi_size && | |
7afafc8a | 58 | bio_op(bio) != REQ_OP_DISCARD && |
a6f0788e CK |
59 | bio_op(bio) != REQ_OP_SECURE_ERASE && |
60 | bio_op(bio) != REQ_OP_WRITE_ZEROES) | |
458b76ed KO |
61 | return true; |
62 | ||
63 | return false; | |
64 | } | |
65 | ||
c1527c0e | 66 | static inline bool bio_no_advance_iter(const struct bio *bio) |
95fe6c1a | 67 | { |
7afafc8a AH |
68 | return bio_op(bio) == REQ_OP_DISCARD || |
69 | bio_op(bio) == REQ_OP_SECURE_ERASE || | |
a6f0788e | 70 | bio_op(bio) == REQ_OP_WRITE_ZEROES; |
95fe6c1a MC |
71 | } |
72 | ||
bf2de6f5 JA |
73 | static inline void *bio_data(struct bio *bio) |
74 | { | |
458b76ed | 75 | if (bio_has_data(bio)) |
bf2de6f5 JA |
76 | return page_address(bio_page(bio)) + bio_offset(bio); |
77 | ||
78 | return NULL; | |
79 | } | |
1da177e4 | 80 | |
1200e07f ML |
81 | static inline bool bio_next_segment(const struct bio *bio, |
82 | struct bvec_iter_all *iter) | |
83 | { | |
84 | if (iter->idx >= bio->bi_vcnt) | |
85 | return false; | |
86 | ||
87 | bvec_advance(&bio->bi_io_vec[iter->idx], iter); | |
88 | return true; | |
89 | } | |
6dc4f100 | 90 | |
d74c6d51 KO |
91 | /* |
92 | * drivers should _never_ use the all version - the bio may have been split | |
93 | * before it got to the driver and the driver won't own all of it | |
94 | */ | |
2b070cfe CH |
95 | #define bio_for_each_segment_all(bvl, bio, iter) \ |
96 | for (bvl = bvec_init_iter_all(&iter); bio_next_segment((bio), &iter); ) | |
d74c6d51 | 97 | |
c1527c0e BVA |
98 | static inline void bio_advance_iter(const struct bio *bio, |
99 | struct bvec_iter *iter, unsigned int bytes) | |
4550dd6c KO |
100 | { |
101 | iter->bi_sector += bytes >> 9; | |
102 | ||
7759eb23 | 103 | if (bio_no_advance_iter(bio)) |
4550dd6c | 104 | iter->bi_size -= bytes; |
7759eb23 | 105 | else |
4550dd6c | 106 | bvec_iter_advance(bio->bi_io_vec, iter, bytes); |
b1fb2c52 | 107 | /* TODO: It is reasonable to complete bio with error here. */ |
f9df1cd9 DM |
108 | } |
109 | ||
22b56c29 PB |
110 | /* @bytes should be less or equal to bvec[i->bi_idx].bv_len */ |
111 | static inline void bio_advance_iter_single(const struct bio *bio, | |
112 | struct bvec_iter *iter, | |
113 | unsigned int bytes) | |
114 | { | |
115 | iter->bi_sector += bytes >> 9; | |
116 | ||
117 | if (bio_no_advance_iter(bio)) | |
118 | iter->bi_size -= bytes; | |
119 | else | |
120 | bvec_iter_advance_single(bio->bi_io_vec, iter, bytes); | |
121 | } | |
122 | ||
d4aa57a1 JA |
123 | void __bio_advance(struct bio *, unsigned bytes); |
124 | ||
125 | /** | |
126 | * bio_advance - increment/complete a bio by some number of bytes | |
127 | * @bio: bio to advance | |
6fd3c510 | 128 | * @nbytes: number of bytes to complete |
d4aa57a1 JA |
129 | * |
130 | * This updates bi_sector, bi_size and bi_idx; if the number of bytes to | |
131 | * complete doesn't align with a bvec boundary, then bv_len and bv_offset will | |
132 | * be updated on the last bvec as well. | |
133 | * | |
134 | * @bio will then represent the remaining, uncompleted portion of the io. | |
135 | */ | |
136 | static inline void bio_advance(struct bio *bio, unsigned int nbytes) | |
137 | { | |
138 | if (nbytes == bio->bi_iter.bi_size) { | |
139 | bio->bi_iter.bi_size = 0; | |
140 | return; | |
141 | } | |
142 | __bio_advance(bio, nbytes); | |
143 | } | |
144 | ||
7988613b KO |
145 | #define __bio_for_each_segment(bvl, bio, iter, start) \ |
146 | for (iter = (start); \ | |
4550dd6c KO |
147 | (iter).bi_size && \ |
148 | ((bvl = bio_iter_iovec((bio), (iter))), 1); \ | |
22b56c29 | 149 | bio_advance_iter_single((bio), &(iter), (bvl).bv_len)) |
7988613b KO |
150 | |
151 | #define bio_for_each_segment(bvl, bio, iter) \ | |
152 | __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter) | |
153 | ||
d18d9174 ML |
154 | #define __bio_for_each_bvec(bvl, bio, iter, start) \ |
155 | for (iter = (start); \ | |
156 | (iter).bi_size && \ | |
157 | ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \ | |
22b56c29 | 158 | bio_advance_iter_single((bio), &(iter), (bvl).bv_len)) |
d18d9174 ML |
159 | |
160 | /* iterate over multi-page bvec */ | |
161 | #define bio_for_each_bvec(bvl, bio, iter) \ | |
162 | __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter) | |
163 | ||
1072c12d OS |
164 | /* |
165 | * Iterate over all multi-page bvecs. Drivers shouldn't use this version for the | |
166 | * same reasons as bio_for_each_segment_all(). | |
167 | */ | |
168 | #define bio_for_each_bvec_all(bvl, bio, i) \ | |
169 | for (i = 0, bvl = bio_first_bvec_all(bio); \ | |
640d1930 | 170 | i < (bio)->bi_vcnt; i++, bvl++) |
1072c12d | 171 | |
4550dd6c | 172 | #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len) |
1da177e4 | 173 | |
f4595875 | 174 | static inline unsigned bio_segments(struct bio *bio) |
458b76ed KO |
175 | { |
176 | unsigned segs = 0; | |
177 | struct bio_vec bv; | |
178 | struct bvec_iter iter; | |
179 | ||
8423ae3d | 180 | /* |
a6f0788e CK |
181 | * We special case discard/write same/write zeroes, because they |
182 | * interpret bi_size differently: | |
8423ae3d KO |
183 | */ |
184 | ||
a6f0788e CK |
185 | switch (bio_op(bio)) { |
186 | case REQ_OP_DISCARD: | |
187 | case REQ_OP_SECURE_ERASE: | |
a6f0788e | 188 | case REQ_OP_WRITE_ZEROES: |
f9d03f96 | 189 | return 0; |
a6f0788e CK |
190 | default: |
191 | break; | |
192 | } | |
8423ae3d | 193 | |
f4595875 | 194 | bio_for_each_segment(bv, bio, iter) |
458b76ed KO |
195 | segs++; |
196 | ||
197 | return segs; | |
198 | } | |
199 | ||
1da177e4 LT |
200 | /* |
201 | * get a reference to a bio, so it won't disappear. the intended use is | |
202 | * something like: | |
203 | * | |
204 | * bio_get(bio); | |
205 | * submit_bio(rw, bio); | |
206 | * if (bio->bi_flags ...) | |
207 | * do_something | |
208 | * bio_put(bio); | |
209 | * | |
210 | * without the bio_get(), it could potentially complete I/O before submit_bio | |
211 | * returns. and then bio would be freed memory when if (bio->bi_flags ...) | |
212 | * runs | |
213 | */ | |
dac56212 JA |
214 | static inline void bio_get(struct bio *bio) |
215 | { | |
216 | bio->bi_flags |= (1 << BIO_REFFED); | |
217 | smp_mb__before_atomic(); | |
218 | atomic_inc(&bio->__bi_cnt); | |
219 | } | |
220 | ||
221 | static inline void bio_cnt_set(struct bio *bio, unsigned int count) | |
222 | { | |
223 | if (count != 1) { | |
224 | bio->bi_flags |= (1 << BIO_REFFED); | |
f381c6a4 | 225 | smp_mb(); |
dac56212 JA |
226 | } |
227 | atomic_set(&bio->__bi_cnt, count); | |
228 | } | |
1da177e4 | 229 | |
b7c44ed9 JA |
230 | static inline bool bio_flagged(struct bio *bio, unsigned int bit) |
231 | { | |
09e8c253 | 232 | return bio->bi_flags & (1U << bit); |
b7c44ed9 JA |
233 | } |
234 | ||
235 | static inline void bio_set_flag(struct bio *bio, unsigned int bit) | |
236 | { | |
2c68f6dc | 237 | bio->bi_flags |= (1U << bit); |
b7c44ed9 JA |
238 | } |
239 | ||
240 | static inline void bio_clear_flag(struct bio *bio, unsigned int bit) | |
241 | { | |
2c68f6dc | 242 | bio->bi_flags &= ~(1U << bit); |
b7c44ed9 JA |
243 | } |
244 | ||
86292abc ML |
245 | static inline struct bio_vec *bio_first_bvec_all(struct bio *bio) |
246 | { | |
247 | WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)); | |
248 | return bio->bi_io_vec; | |
249 | } | |
250 | ||
251 | static inline struct page *bio_first_page_all(struct bio *bio) | |
252 | { | |
253 | return bio_first_bvec_all(bio)->bv_page; | |
254 | } | |
255 | ||
6d2790d9 Z |
256 | static inline struct folio *bio_first_folio_all(struct bio *bio) |
257 | { | |
258 | return page_folio(bio_first_page_all(bio)); | |
259 | } | |
260 | ||
86292abc ML |
261 | static inline struct bio_vec *bio_last_bvec_all(struct bio *bio) |
262 | { | |
263 | WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)); | |
264 | return &bio->bi_io_vec[bio->bi_vcnt - 1]; | |
265 | } | |
266 | ||
640d1930 MWO |
267 | /** |
268 | * struct folio_iter - State for iterating all folios in a bio. | |
269 | * @folio: The current folio we're iterating. NULL after the last folio. | |
270 | * @offset: The byte offset within the current folio. | |
271 | * @length: The number of bytes in this iteration (will not cross folio | |
272 | * boundary). | |
273 | */ | |
274 | struct folio_iter { | |
275 | struct folio *folio; | |
276 | size_t offset; | |
277 | size_t length; | |
278 | /* private: for use by the iterator */ | |
170f37d6 | 279 | struct folio *_next; |
640d1930 MWO |
280 | size_t _seg_count; |
281 | int _i; | |
282 | }; | |
283 | ||
284 | static inline void bio_first_folio(struct folio_iter *fi, struct bio *bio, | |
285 | int i) | |
286 | { | |
287 | struct bio_vec *bvec = bio_first_bvec_all(bio) + i; | |
288 | ||
289 | fi->folio = page_folio(bvec->bv_page); | |
290 | fi->offset = bvec->bv_offset + | |
291 | PAGE_SIZE * (bvec->bv_page - &fi->folio->page); | |
292 | fi->_seg_count = bvec->bv_len; | |
293 | fi->length = min(folio_size(fi->folio) - fi->offset, fi->_seg_count); | |
170f37d6 | 294 | fi->_next = folio_next(fi->folio); |
640d1930 MWO |
295 | fi->_i = i; |
296 | } | |
297 | ||
298 | static inline void bio_next_folio(struct folio_iter *fi, struct bio *bio) | |
299 | { | |
300 | fi->_seg_count -= fi->length; | |
301 | if (fi->_seg_count) { | |
170f37d6 | 302 | fi->folio = fi->_next; |
640d1930 MWO |
303 | fi->offset = 0; |
304 | fi->length = min(folio_size(fi->folio), fi->_seg_count); | |
170f37d6 | 305 | fi->_next = folio_next(fi->folio); |
640d1930 MWO |
306 | } else if (fi->_i + 1 < bio->bi_vcnt) { |
307 | bio_first_folio(fi, bio, fi->_i + 1); | |
308 | } else { | |
309 | fi->folio = NULL; | |
310 | } | |
311 | } | |
312 | ||
313 | /** | |
314 | * bio_for_each_folio_all - Iterate over each folio in a bio. | |
315 | * @fi: struct folio_iter which is updated for each folio. | |
316 | * @bio: struct bio to iterate over. | |
317 | */ | |
318 | #define bio_for_each_folio_all(fi, bio) \ | |
319 | for (bio_first_folio(&fi, bio, 0); fi.folio; bio_next_folio(&fi, bio)) | |
320 | ||
c611529e MP |
321 | enum bip_flags { |
322 | BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */ | |
323 | BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */ | |
324 | BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */ | |
325 | BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */ | |
326 | BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */ | |
327 | }; | |
328 | ||
7ba1ba12 MP |
329 | /* |
330 | * bio integrity payload | |
331 | */ | |
332 | struct bio_integrity_payload { | |
333 | struct bio *bip_bio; /* parent bio */ | |
7ba1ba12 | 334 | |
d57a5f7c | 335 | struct bvec_iter bip_iter; |
7ba1ba12 | 336 | |
7ba1ba12 | 337 | unsigned short bip_vcnt; /* # of integrity bio_vecs */ |
cbcd1054 | 338 | unsigned short bip_max_vcnt; /* integrity bio_vec slots */ |
b1f01388 | 339 | unsigned short bip_flags; /* control flags */ |
7ba1ba12 | 340 | |
7759eb23 ML |
341 | struct bvec_iter bio_iter; /* for rewinding parent bio */ |
342 | ||
7ba1ba12 | 343 | struct work_struct bip_work; /* I/O completion */ |
6fda981c KO |
344 | |
345 | struct bio_vec *bip_vec; | |
0a368bf0 | 346 | struct bio_vec bip_inline_vecs[];/* embedded bvec array */ |
7ba1ba12 | 347 | }; |
18593088 | 348 | |
06c1e390 KB |
349 | #if defined(CONFIG_BLK_DEV_INTEGRITY) |
350 | ||
351 | static inline struct bio_integrity_payload *bio_integrity(struct bio *bio) | |
352 | { | |
1eff9d32 | 353 | if (bio->bi_opf & REQ_INTEGRITY) |
06c1e390 KB |
354 | return bio->bi_integrity; |
355 | ||
356 | return NULL; | |
357 | } | |
358 | ||
c611529e MP |
359 | static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag) |
360 | { | |
361 | struct bio_integrity_payload *bip = bio_integrity(bio); | |
362 | ||
363 | if (bip) | |
364 | return bip->bip_flags & flag; | |
365 | ||
366 | return false; | |
367 | } | |
b1f01388 | 368 | |
18593088 MP |
369 | static inline sector_t bip_get_seed(struct bio_integrity_payload *bip) |
370 | { | |
371 | return bip->bip_iter.bi_sector; | |
372 | } | |
373 | ||
374 | static inline void bip_set_seed(struct bio_integrity_payload *bip, | |
375 | sector_t seed) | |
376 | { | |
377 | bip->bip_iter.bi_sector = seed; | |
378 | } | |
379 | ||
7ba1ba12 | 380 | #endif /* CONFIG_BLK_DEV_INTEGRITY */ |
1da177e4 | 381 | |
e83502ca | 382 | void bio_trim(struct bio *bio, sector_t offset, sector_t size); |
20d0189b KO |
383 | extern struct bio *bio_split(struct bio *bio, int sectors, |
384 | gfp_t gfp, struct bio_set *bs); | |
fd8f8ede CH |
385 | struct bio *bio_split_rw(struct bio *bio, const struct queue_limits *lim, |
386 | unsigned *segs, struct bio_set *bs, unsigned max_bytes); | |
20d0189b KO |
387 | |
388 | /** | |
389 | * bio_next_split - get next @sectors from a bio, splitting if necessary | |
390 | * @bio: bio to split | |
391 | * @sectors: number of sectors to split from the front of @bio | |
392 | * @gfp: gfp mask | |
393 | * @bs: bio set to allocate from | |
394 | * | |
6fd3c510 | 395 | * Return: a bio representing the next @sectors of @bio - if the bio is smaller |
20d0189b KO |
396 | * than @sectors, returns the original bio unchanged. |
397 | */ | |
398 | static inline struct bio *bio_next_split(struct bio *bio, int sectors, | |
399 | gfp_t gfp, struct bio_set *bs) | |
400 | { | |
401 | if (sectors >= bio_sectors(bio)) | |
402 | return bio; | |
403 | ||
404 | return bio_split(bio, sectors, gfp, bs); | |
405 | } | |
406 | ||
011067b0 N |
407 | enum { |
408 | BIOSET_NEED_BVECS = BIT(0), | |
47e0fb46 | 409 | BIOSET_NEED_RESCUER = BIT(1), |
be4d234d | 410 | BIOSET_PERCPU_CACHE = BIT(2), |
011067b0 | 411 | }; |
dad08527 KO |
412 | extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags); |
413 | extern void bioset_exit(struct bio_set *); | |
8aa6ba2f | 414 | extern int biovec_init_pool(mempool_t *pool, int pool_entries); |
1da177e4 | 415 | |
609be106 | 416 | struct bio *bio_alloc_bioset(struct block_device *bdev, unsigned short nr_vecs, |
16458cf3 | 417 | blk_opf_t opf, gfp_t gfp_mask, |
609be106 | 418 | struct bio_set *bs); |
066ff571 | 419 | struct bio *bio_kmalloc(unsigned short nr_vecs, gfp_t gfp_mask); |
1da177e4 LT |
420 | extern void bio_put(struct bio *); |
421 | ||
abfc426d CH |
422 | struct bio *bio_alloc_clone(struct block_device *bdev, struct bio *bio_src, |
423 | gfp_t gfp, struct bio_set *bs); | |
424 | int bio_init_clone(struct block_device *bdev, struct bio *bio, | |
425 | struct bio *bio_src, gfp_t gfp); | |
bf800ef1 | 426 | |
f4f8154a | 427 | extern struct bio_set fs_bio_set; |
3f86a82a | 428 | |
07888c66 | 429 | static inline struct bio *bio_alloc(struct block_device *bdev, |
16458cf3 | 430 | unsigned short nr_vecs, blk_opf_t opf, gfp_t gfp_mask) |
3f86a82a | 431 | { |
07888c66 | 432 | return bio_alloc_bioset(bdev, nr_vecs, opf, gfp_mask, &fs_bio_set); |
3f86a82a KO |
433 | } |
434 | ||
3e08773c | 435 | void submit_bio(struct bio *bio); |
1e3914d4 | 436 | |
4246a0b6 CH |
437 | extern void bio_endio(struct bio *); |
438 | ||
439 | static inline void bio_io_error(struct bio *bio) | |
440 | { | |
4e4cbee9 | 441 | bio->bi_status = BLK_STS_IOERR; |
4246a0b6 CH |
442 | bio_endio(bio); |
443 | } | |
444 | ||
03a07c92 GR |
445 | static inline void bio_wouldblock_error(struct bio *bio) |
446 | { | |
abb30460 | 447 | bio_set_flag(bio, BIO_QUIET); |
03a07c92 | 448 | bio->bi_status = BLK_STS_AGAIN; |
4246a0b6 CH |
449 | bio_endio(bio); |
450 | } | |
451 | ||
3e1a88ec PB |
452 | /* |
453 | * Calculate number of bvec segments that should be allocated to fit data | |
c42bca92 PB |
454 | * pointed by @iter. If @iter is backed by bvec it's going to be reused |
455 | * instead of allocating a new one. | |
3e1a88ec PB |
456 | */ |
457 | static inline int bio_iov_vecs_to_alloc(struct iov_iter *iter, int max_segs) | |
458 | { | |
c42bca92 PB |
459 | if (iov_iter_is_bvec(iter)) |
460 | return 0; | |
3e1a88ec PB |
461 | return iov_iter_npages(iter, max_segs); |
462 | } | |
463 | ||
1da177e4 | 464 | struct request_queue; |
1da177e4 | 465 | |
4e49ea4a | 466 | extern int submit_bio_wait(struct bio *bio); |
49add496 | 467 | void bio_init(struct bio *bio, struct block_device *bdev, struct bio_vec *table, |
16458cf3 | 468 | unsigned short max_vecs, blk_opf_t opf); |
9ae3b3f5 | 469 | extern void bio_uninit(struct bio *); |
16458cf3 | 470 | void bio_reset(struct bio *bio, struct block_device *bdev, blk_opf_t opf); |
196d38bc | 471 | void bio_chain(struct bio *, struct bio *); |
1da177e4 | 472 | |
83f2caaa JT |
473 | int __must_check bio_add_page(struct bio *bio, struct page *page, unsigned len, |
474 | unsigned off); | |
6c500000 JT |
475 | bool __must_check bio_add_folio(struct bio *bio, struct folio *folio, |
476 | size_t len, size_t off); | |
6e68af66 MC |
477 | extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *, |
478 | unsigned int, unsigned int); | |
ae29333f JT |
479 | int bio_add_zone_append_page(struct bio *bio, struct page *page, |
480 | unsigned int len, unsigned int offset); | |
0aa69fd3 CH |
481 | void __bio_add_page(struct bio *bio, struct page *page, |
482 | unsigned int len, unsigned int off); | |
7a150f1e JT |
483 | void bio_add_folio_nofail(struct bio *bio, struct folio *folio, size_t len, |
484 | size_t off); | |
2cefe4db | 485 | int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter); |
1bb6b810 | 486 | void bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter); |
c809084a | 487 | void __bio_release_pages(struct bio *bio, bool mark_dirty); |
1da177e4 LT |
488 | extern void bio_set_pages_dirty(struct bio *bio); |
489 | extern void bio_check_pages_dirty(struct bio *bio); | |
2d4dc890 | 490 | |
ee4b4e22 JA |
491 | extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter, |
492 | struct bio *src, struct bvec_iter *src_iter); | |
16ac3d63 | 493 | extern void bio_copy_data(struct bio *dst, struct bio *src); |
491221f8 | 494 | extern void bio_free_pages(struct bio *bio); |
29125ed6 | 495 | void guard_bio_eod(struct bio *bio); |
649f070e KO |
496 | void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter); |
497 | ||
498 | static inline void zero_fill_bio(struct bio *bio) | |
499 | { | |
500 | zero_fill_bio_iter(bio, bio->bi_iter); | |
501 | } | |
38a72dac | 502 | |
c809084a PB |
503 | static inline void bio_release_pages(struct bio *bio, bool mark_dirty) |
504 | { | |
e4cc6465 | 505 | if (bio_flagged(bio, BIO_PAGE_PINNED)) |
c809084a PB |
506 | __bio_release_pages(bio, mark_dirty); |
507 | } | |
508 | ||
74d46992 | 509 | #define bio_dev(bio) \ |
309dca30 | 510 | disk_devt((bio)->bi_bdev->bd_disk) |
74d46992 | 511 | |
852c788f | 512 | #ifdef CONFIG_BLK_CGROUP |
2268c0fe | 513 | void bio_associate_blkg(struct bio *bio); |
fd42df30 DZ |
514 | void bio_associate_blkg_from_css(struct bio *bio, |
515 | struct cgroup_subsys_state *css); | |
db6638d7 | 516 | void bio_clone_blkg_association(struct bio *dst, struct bio *src); |
3480373e | 517 | void blkcg_punt_bio_submit(struct bio *bio); |
852c788f | 518 | #else /* CONFIG_BLK_CGROUP */ |
2268c0fe | 519 | static inline void bio_associate_blkg(struct bio *bio) { } |
fd42df30 DZ |
520 | static inline void bio_associate_blkg_from_css(struct bio *bio, |
521 | struct cgroup_subsys_state *css) | |
522 | { } | |
db6638d7 DZ |
523 | static inline void bio_clone_blkg_association(struct bio *dst, |
524 | struct bio *src) { } | |
3480373e CH |
525 | static inline void blkcg_punt_bio_submit(struct bio *bio) |
526 | { | |
527 | submit_bio(bio); | |
528 | } | |
852c788f TH |
529 | #endif /* CONFIG_BLK_CGROUP */ |
530 | ||
cf6d6238 PB |
531 | static inline void bio_set_dev(struct bio *bio, struct block_device *bdev) |
532 | { | |
533 | bio_clear_flag(bio, BIO_REMAPPED); | |
534 | if (bio->bi_bdev != bdev) | |
320fb0f9 | 535 | bio_clear_flag(bio, BIO_BPS_THROTTLED); |
cf6d6238 PB |
536 | bio->bi_bdev = bdev; |
537 | bio_associate_blkg(bio); | |
538 | } | |
539 | ||
8f3d8ba2 | 540 | /* |
e686307f | 541 | * BIO list management for use by remapping drivers (e.g. DM or MD) and loop. |
8f3d8ba2 CH |
542 | * |
543 | * A bio_list anchors a singly-linked list of bios chained through the bi_next | |
544 | * member of the bio. The bio_list also caches the last list member to allow | |
545 | * fast access to the tail. | |
546 | */ | |
547 | struct bio_list { | |
548 | struct bio *head; | |
549 | struct bio *tail; | |
550 | }; | |
551 | ||
552 | static inline int bio_list_empty(const struct bio_list *bl) | |
553 | { | |
554 | return bl->head == NULL; | |
555 | } | |
556 | ||
557 | static inline void bio_list_init(struct bio_list *bl) | |
558 | { | |
559 | bl->head = bl->tail = NULL; | |
560 | } | |
561 | ||
320ae51f JA |
562 | #define BIO_EMPTY_LIST { NULL, NULL } |
563 | ||
8f3d8ba2 CH |
564 | #define bio_list_for_each(bio, bl) \ |
565 | for (bio = (bl)->head; bio; bio = bio->bi_next) | |
566 | ||
567 | static inline unsigned bio_list_size(const struct bio_list *bl) | |
568 | { | |
569 | unsigned sz = 0; | |
570 | struct bio *bio; | |
571 | ||
572 | bio_list_for_each(bio, bl) | |
573 | sz++; | |
574 | ||
575 | return sz; | |
576 | } | |
577 | ||
578 | static inline void bio_list_add(struct bio_list *bl, struct bio *bio) | |
579 | { | |
580 | bio->bi_next = NULL; | |
581 | ||
582 | if (bl->tail) | |
583 | bl->tail->bi_next = bio; | |
584 | else | |
585 | bl->head = bio; | |
586 | ||
587 | bl->tail = bio; | |
588 | } | |
589 | ||
590 | static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio) | |
591 | { | |
592 | bio->bi_next = bl->head; | |
593 | ||
594 | bl->head = bio; | |
595 | ||
596 | if (!bl->tail) | |
597 | bl->tail = bio; | |
598 | } | |
599 | ||
600 | static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2) | |
601 | { | |
602 | if (!bl2->head) | |
603 | return; | |
604 | ||
605 | if (bl->tail) | |
606 | bl->tail->bi_next = bl2->head; | |
607 | else | |
608 | bl->head = bl2->head; | |
609 | ||
610 | bl->tail = bl2->tail; | |
611 | } | |
612 | ||
613 | static inline void bio_list_merge_head(struct bio_list *bl, | |
614 | struct bio_list *bl2) | |
615 | { | |
616 | if (!bl2->head) | |
617 | return; | |
618 | ||
619 | if (bl->head) | |
620 | bl2->tail->bi_next = bl->head; | |
621 | else | |
622 | bl->tail = bl2->tail; | |
623 | ||
624 | bl->head = bl2->head; | |
625 | } | |
626 | ||
13685a16 GU |
627 | static inline struct bio *bio_list_peek(struct bio_list *bl) |
628 | { | |
629 | return bl->head; | |
630 | } | |
631 | ||
8f3d8ba2 CH |
632 | static inline struct bio *bio_list_pop(struct bio_list *bl) |
633 | { | |
634 | struct bio *bio = bl->head; | |
635 | ||
636 | if (bio) { | |
637 | bl->head = bl->head->bi_next; | |
638 | if (!bl->head) | |
639 | bl->tail = NULL; | |
640 | ||
641 | bio->bi_next = NULL; | |
642 | } | |
643 | ||
644 | return bio; | |
645 | } | |
646 | ||
647 | static inline struct bio *bio_list_get(struct bio_list *bl) | |
648 | { | |
649 | struct bio *bio = bl->head; | |
650 | ||
651 | bl->head = bl->tail = NULL; | |
652 | ||
653 | return bio; | |
654 | } | |
655 | ||
0ef5a50c MS |
656 | /* |
657 | * Increment chain count for the bio. Make sure the CHAIN flag update | |
658 | * is visible before the raised count. | |
659 | */ | |
660 | static inline void bio_inc_remaining(struct bio *bio) | |
661 | { | |
662 | bio_set_flag(bio, BIO_CHAIN); | |
663 | smp_mb__before_atomic(); | |
664 | atomic_inc(&bio->__bi_remaining); | |
665 | } | |
666 | ||
57fb233f KO |
667 | /* |
668 | * bio_set is used to allow other portions of the IO system to | |
669 | * allocate their own private memory pools for bio and iovec structures. | |
670 | * These memory pools in turn all allocate from the bio_slab | |
671 | * and the bvec_slabs[]. | |
672 | */ | |
673 | #define BIO_POOL_SIZE 2 | |
57fb233f KO |
674 | |
675 | struct bio_set { | |
676 | struct kmem_cache *bio_slab; | |
677 | unsigned int front_pad; | |
678 | ||
be4d234d JA |
679 | /* |
680 | * per-cpu bio alloc cache | |
681 | */ | |
682 | struct bio_alloc_cache __percpu *cache; | |
683 | ||
8aa6ba2f KO |
684 | mempool_t bio_pool; |
685 | mempool_t bvec_pool; | |
57fb233f | 686 | #if defined(CONFIG_BLK_DEV_INTEGRITY) |
8aa6ba2f KO |
687 | mempool_t bio_integrity_pool; |
688 | mempool_t bvec_integrity_pool; | |
57fb233f | 689 | #endif |
df2cb6da | 690 | |
9f180e31 | 691 | unsigned int back_pad; |
df2cb6da KO |
692 | /* |
693 | * Deadlock avoidance for stacking block drivers: see comments in | |
694 | * bio_alloc_bioset() for details | |
695 | */ | |
696 | spinlock_t rescue_lock; | |
697 | struct bio_list rescue_list; | |
698 | struct work_struct rescue_work; | |
699 | struct workqueue_struct *rescue_workqueue; | |
be4d234d JA |
700 | |
701 | /* | |
702 | * Hot un-plug notifier for the per-cpu cache, if used | |
703 | */ | |
704 | struct hlist_node cpuhp_dead; | |
57fb233f KO |
705 | }; |
706 | ||
338aa96d KO |
707 | static inline bool bioset_initialized(struct bio_set *bs) |
708 | { | |
709 | return bs->bio_slab != NULL; | |
710 | } | |
711 | ||
7ba1ba12 MP |
712 | #if defined(CONFIG_BLK_DEV_INTEGRITY) |
713 | ||
d57a5f7c KO |
714 | #define bip_for_each_vec(bvl, bip, iter) \ |
715 | for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter) | |
7ba1ba12 | 716 | |
13f05c8d MP |
717 | #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \ |
718 | for_each_bio(_bio) \ | |
719 | bip_for_each_vec(_bvl, _bio->bi_integrity, _iter) | |
720 | ||
7ba1ba12 | 721 | extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int); |
7ba1ba12 | 722 | extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int); |
e23947bd | 723 | extern bool bio_integrity_prep(struct bio *); |
7ba1ba12 | 724 | extern void bio_integrity_advance(struct bio *, unsigned int); |
fbd08e76 | 725 | extern void bio_integrity_trim(struct bio *); |
1e2a410f | 726 | extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t); |
7878cba9 MP |
727 | extern int bioset_integrity_create(struct bio_set *, int); |
728 | extern void bioset_integrity_free(struct bio_set *); | |
729 | extern void bio_integrity_init(void); | |
7ba1ba12 MP |
730 | |
731 | #else /* CONFIG_BLK_DEV_INTEGRITY */ | |
732 | ||
c611529e | 733 | static inline void *bio_integrity(struct bio *bio) |
6898e3bd | 734 | { |
c611529e | 735 | return NULL; |
6898e3bd MP |
736 | } |
737 | ||
6898e3bd MP |
738 | static inline int bioset_integrity_create(struct bio_set *bs, int pool_size) |
739 | { | |
740 | return 0; | |
741 | } | |
742 | ||
743 | static inline void bioset_integrity_free (struct bio_set *bs) | |
744 | { | |
745 | return; | |
746 | } | |
747 | ||
e23947bd | 748 | static inline bool bio_integrity_prep(struct bio *bio) |
6898e3bd | 749 | { |
e23947bd | 750 | return true; |
6898e3bd MP |
751 | } |
752 | ||
0c614e2d | 753 | static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src, |
1e2a410f | 754 | gfp_t gfp_mask) |
0c614e2d SR |
755 | { |
756 | return 0; | |
757 | } | |
6898e3bd | 758 | |
6898e3bd MP |
759 | static inline void bio_integrity_advance(struct bio *bio, |
760 | unsigned int bytes_done) | |
761 | { | |
762 | return; | |
763 | } | |
764 | ||
fbd08e76 | 765 | static inline void bio_integrity_trim(struct bio *bio) |
6898e3bd MP |
766 | { |
767 | return; | |
768 | } | |
769 | ||
770 | static inline void bio_integrity_init(void) | |
771 | { | |
772 | return; | |
773 | } | |
7ba1ba12 | 774 | |
c611529e MP |
775 | static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag) |
776 | { | |
777 | return false; | |
778 | } | |
779 | ||
06c1e390 KB |
780 | static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp, |
781 | unsigned int nr) | |
782 | { | |
783 | return ERR_PTR(-EINVAL); | |
784 | } | |
785 | ||
786 | static inline int bio_integrity_add_page(struct bio *bio, struct page *page, | |
787 | unsigned int len, unsigned int offset) | |
788 | { | |
789 | return 0; | |
790 | } | |
791 | ||
7ba1ba12 MP |
792 | #endif /* CONFIG_BLK_DEV_INTEGRITY */ |
793 | ||
0bbb280d JA |
794 | /* |
795 | * Mark a bio as polled. Note that for async polled IO, the caller must | |
796 | * expect -EWOULDBLOCK if we cannot allocate a request (or other resources). | |
797 | * We cannot block waiting for requests on polled IO, as those completions | |
798 | * must be found by the caller. This is different than IRQ driven IO, where | |
799 | * it's safe to wait for IO to complete. | |
800 | */ | |
801 | static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb) | |
802 | { | |
6ce913fe | 803 | bio->bi_opf |= REQ_POLLED; |
2bc05769 | 804 | if (kiocb->ki_flags & IOCB_NOWAIT) |
0bbb280d JA |
805 | bio->bi_opf |= REQ_NOWAIT; |
806 | } | |
807 | ||
b53f3dcd MS |
808 | static inline void bio_clear_polled(struct bio *bio) |
809 | { | |
53eab8e7 | 810 | bio->bi_opf &= ~REQ_POLLED; |
b53f3dcd MS |
811 | } |
812 | ||
0a3140ea | 813 | struct bio *blk_next_bio(struct bio *bio, struct block_device *bdev, |
16458cf3 | 814 | unsigned int nr_pages, blk_opf_t opf, gfp_t gfp); |
c28a6147 | 815 | |
1da177e4 | 816 | #endif /* __LINUX_BIO_H */ |