block: mark bio_add_folio as __must_check
[linux-block.git] / include / linux / bio.h
CommitLineData
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
15struct queue_limits;
16
5f7136db
MWO
17static 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 */
54static 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 66static 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
73static 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
81static 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
98static 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 */
111static 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
123void __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 */
136static 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 174static 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
214static 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
221static 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
230static inline bool bio_flagged(struct bio *bio, unsigned int bit)
231{
09e8c253 232 return bio->bi_flags & (1U << bit);
b7c44ed9
JA
233}
234
235static inline void bio_set_flag(struct bio *bio, unsigned int bit)
236{
2c68f6dc 237 bio->bi_flags |= (1U << bit);
b7c44ed9
JA
238}
239
240static 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
245static 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
251static inline struct page *bio_first_page_all(struct bio *bio)
252{
253 return bio_first_bvec_all(bio)->bv_page;
254}
255
256static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
257{
258 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
259 return &bio->bi_io_vec[bio->bi_vcnt - 1];
260}
261
640d1930
MWO
262/**
263 * struct folio_iter - State for iterating all folios in a bio.
264 * @folio: The current folio we're iterating. NULL after the last folio.
265 * @offset: The byte offset within the current folio.
266 * @length: The number of bytes in this iteration (will not cross folio
267 * boundary).
268 */
269struct folio_iter {
270 struct folio *folio;
271 size_t offset;
272 size_t length;
273 /* private: for use by the iterator */
170f37d6 274 struct folio *_next;
640d1930
MWO
275 size_t _seg_count;
276 int _i;
277};
278
279static inline void bio_first_folio(struct folio_iter *fi, struct bio *bio,
280 int i)
281{
282 struct bio_vec *bvec = bio_first_bvec_all(bio) + i;
283
284 fi->folio = page_folio(bvec->bv_page);
285 fi->offset = bvec->bv_offset +
286 PAGE_SIZE * (bvec->bv_page - &fi->folio->page);
287 fi->_seg_count = bvec->bv_len;
288 fi->length = min(folio_size(fi->folio) - fi->offset, fi->_seg_count);
170f37d6 289 fi->_next = folio_next(fi->folio);
640d1930
MWO
290 fi->_i = i;
291}
292
293static inline void bio_next_folio(struct folio_iter *fi, struct bio *bio)
294{
295 fi->_seg_count -= fi->length;
296 if (fi->_seg_count) {
170f37d6 297 fi->folio = fi->_next;
640d1930
MWO
298 fi->offset = 0;
299 fi->length = min(folio_size(fi->folio), fi->_seg_count);
170f37d6 300 fi->_next = folio_next(fi->folio);
640d1930
MWO
301 } else if (fi->_i + 1 < bio->bi_vcnt) {
302 bio_first_folio(fi, bio, fi->_i + 1);
303 } else {
304 fi->folio = NULL;
305 }
306}
307
308/**
309 * bio_for_each_folio_all - Iterate over each folio in a bio.
310 * @fi: struct folio_iter which is updated for each folio.
311 * @bio: struct bio to iterate over.
312 */
313#define bio_for_each_folio_all(fi, bio) \
314 for (bio_first_folio(&fi, bio, 0); fi.folio; bio_next_folio(&fi, bio))
315
c611529e
MP
316enum bip_flags {
317 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
318 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
319 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
320 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
321 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
322};
323
7ba1ba12
MP
324/*
325 * bio integrity payload
326 */
327struct bio_integrity_payload {
328 struct bio *bip_bio; /* parent bio */
7ba1ba12 329
d57a5f7c 330 struct bvec_iter bip_iter;
7ba1ba12 331
7ba1ba12 332 unsigned short bip_vcnt; /* # of integrity bio_vecs */
cbcd1054 333 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
b1f01388 334 unsigned short bip_flags; /* control flags */
7ba1ba12 335
7759eb23
ML
336 struct bvec_iter bio_iter; /* for rewinding parent bio */
337
7ba1ba12 338 struct work_struct bip_work; /* I/O completion */
6fda981c
KO
339
340 struct bio_vec *bip_vec;
0a368bf0 341 struct bio_vec bip_inline_vecs[];/* embedded bvec array */
7ba1ba12 342};
18593088 343
06c1e390
KB
344#if defined(CONFIG_BLK_DEV_INTEGRITY)
345
346static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
347{
1eff9d32 348 if (bio->bi_opf & REQ_INTEGRITY)
06c1e390
KB
349 return bio->bi_integrity;
350
351 return NULL;
352}
353
c611529e
MP
354static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
355{
356 struct bio_integrity_payload *bip = bio_integrity(bio);
357
358 if (bip)
359 return bip->bip_flags & flag;
360
361 return false;
362}
b1f01388 363
18593088
MP
364static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
365{
366 return bip->bip_iter.bi_sector;
367}
368
369static inline void bip_set_seed(struct bio_integrity_payload *bip,
370 sector_t seed)
371{
372 bip->bip_iter.bi_sector = seed;
373}
374
7ba1ba12 375#endif /* CONFIG_BLK_DEV_INTEGRITY */
1da177e4 376
e83502ca 377void bio_trim(struct bio *bio, sector_t offset, sector_t size);
20d0189b
KO
378extern struct bio *bio_split(struct bio *bio, int sectors,
379 gfp_t gfp, struct bio_set *bs);
fd8f8ede
CH
380struct bio *bio_split_rw(struct bio *bio, const struct queue_limits *lim,
381 unsigned *segs, struct bio_set *bs, unsigned max_bytes);
20d0189b
KO
382
383/**
384 * bio_next_split - get next @sectors from a bio, splitting if necessary
385 * @bio: bio to split
386 * @sectors: number of sectors to split from the front of @bio
387 * @gfp: gfp mask
388 * @bs: bio set to allocate from
389 *
6fd3c510 390 * Return: a bio representing the next @sectors of @bio - if the bio is smaller
20d0189b
KO
391 * than @sectors, returns the original bio unchanged.
392 */
393static inline struct bio *bio_next_split(struct bio *bio, int sectors,
394 gfp_t gfp, struct bio_set *bs)
395{
396 if (sectors >= bio_sectors(bio))
397 return bio;
398
399 return bio_split(bio, sectors, gfp, bs);
400}
401
011067b0
N
402enum {
403 BIOSET_NEED_BVECS = BIT(0),
47e0fb46 404 BIOSET_NEED_RESCUER = BIT(1),
be4d234d 405 BIOSET_PERCPU_CACHE = BIT(2),
011067b0 406};
dad08527
KO
407extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
408extern void bioset_exit(struct bio_set *);
8aa6ba2f 409extern int biovec_init_pool(mempool_t *pool, int pool_entries);
1da177e4 410
609be106 411struct bio *bio_alloc_bioset(struct block_device *bdev, unsigned short nr_vecs,
16458cf3 412 blk_opf_t opf, gfp_t gfp_mask,
609be106 413 struct bio_set *bs);
066ff571 414struct bio *bio_kmalloc(unsigned short nr_vecs, gfp_t gfp_mask);
1da177e4
LT
415extern void bio_put(struct bio *);
416
abfc426d
CH
417struct bio *bio_alloc_clone(struct block_device *bdev, struct bio *bio_src,
418 gfp_t gfp, struct bio_set *bs);
419int bio_init_clone(struct block_device *bdev, struct bio *bio,
420 struct bio *bio_src, gfp_t gfp);
bf800ef1 421
f4f8154a 422extern struct bio_set fs_bio_set;
3f86a82a 423
07888c66 424static inline struct bio *bio_alloc(struct block_device *bdev,
16458cf3 425 unsigned short nr_vecs, blk_opf_t opf, gfp_t gfp_mask)
3f86a82a 426{
07888c66 427 return bio_alloc_bioset(bdev, nr_vecs, opf, gfp_mask, &fs_bio_set);
3f86a82a
KO
428}
429
3e08773c 430void submit_bio(struct bio *bio);
1e3914d4 431
4246a0b6
CH
432extern void bio_endio(struct bio *);
433
434static inline void bio_io_error(struct bio *bio)
435{
4e4cbee9 436 bio->bi_status = BLK_STS_IOERR;
4246a0b6
CH
437 bio_endio(bio);
438}
439
03a07c92
GR
440static inline void bio_wouldblock_error(struct bio *bio)
441{
abb30460 442 bio_set_flag(bio, BIO_QUIET);
03a07c92 443 bio->bi_status = BLK_STS_AGAIN;
4246a0b6
CH
444 bio_endio(bio);
445}
446
3e1a88ec
PB
447/*
448 * Calculate number of bvec segments that should be allocated to fit data
c42bca92
PB
449 * pointed by @iter. If @iter is backed by bvec it's going to be reused
450 * instead of allocating a new one.
3e1a88ec
PB
451 */
452static inline int bio_iov_vecs_to_alloc(struct iov_iter *iter, int max_segs)
453{
c42bca92
PB
454 if (iov_iter_is_bvec(iter))
455 return 0;
3e1a88ec
PB
456 return iov_iter_npages(iter, max_segs);
457}
458
1da177e4 459struct request_queue;
1da177e4 460
4e49ea4a 461extern int submit_bio_wait(struct bio *bio);
49add496 462void bio_init(struct bio *bio, struct block_device *bdev, struct bio_vec *table,
16458cf3 463 unsigned short max_vecs, blk_opf_t opf);
9ae3b3f5 464extern void bio_uninit(struct bio *);
16458cf3 465void bio_reset(struct bio *bio, struct block_device *bdev, blk_opf_t opf);
196d38bc 466void bio_chain(struct bio *, struct bio *);
1da177e4 467
83f2caaa
JT
468int __must_check bio_add_page(struct bio *bio, struct page *page, unsigned len,
469 unsigned off);
6c500000
JT
470bool __must_check bio_add_folio(struct bio *bio, struct folio *folio,
471 size_t len, size_t off);
6e68af66
MC
472extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
473 unsigned int, unsigned int);
ae29333f
JT
474int bio_add_zone_append_page(struct bio *bio, struct page *page,
475 unsigned int len, unsigned int offset);
0aa69fd3
CH
476void __bio_add_page(struct bio *bio, struct page *page,
477 unsigned int len, unsigned int off);
7a150f1e
JT
478void bio_add_folio_nofail(struct bio *bio, struct folio *folio, size_t len,
479 size_t off);
2cefe4db 480int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
1bb6b810 481void bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter);
c809084a 482void __bio_release_pages(struct bio *bio, bool mark_dirty);
1da177e4
LT
483extern void bio_set_pages_dirty(struct bio *bio);
484extern void bio_check_pages_dirty(struct bio *bio);
2d4dc890 485
ee4b4e22
JA
486extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
487 struct bio *src, struct bvec_iter *src_iter);
16ac3d63 488extern void bio_copy_data(struct bio *dst, struct bio *src);
491221f8 489extern void bio_free_pages(struct bio *bio);
29125ed6 490void guard_bio_eod(struct bio *bio);
6f822e1b 491void zero_fill_bio(struct bio *bio);
38a72dac 492
c809084a
PB
493static inline void bio_release_pages(struct bio *bio, bool mark_dirty)
494{
fd363244
DH
495 if (bio_flagged(bio, BIO_PAGE_REFFED) ||
496 bio_flagged(bio, BIO_PAGE_PINNED))
c809084a
PB
497 __bio_release_pages(bio, mark_dirty);
498}
499
74d46992 500#define bio_dev(bio) \
309dca30 501 disk_devt((bio)->bi_bdev->bd_disk)
74d46992 502
852c788f 503#ifdef CONFIG_BLK_CGROUP
2268c0fe 504void bio_associate_blkg(struct bio *bio);
fd42df30
DZ
505void bio_associate_blkg_from_css(struct bio *bio,
506 struct cgroup_subsys_state *css);
db6638d7 507void bio_clone_blkg_association(struct bio *dst, struct bio *src);
3480373e 508void blkcg_punt_bio_submit(struct bio *bio);
852c788f 509#else /* CONFIG_BLK_CGROUP */
2268c0fe 510static inline void bio_associate_blkg(struct bio *bio) { }
fd42df30
DZ
511static inline void bio_associate_blkg_from_css(struct bio *bio,
512 struct cgroup_subsys_state *css)
513{ }
db6638d7
DZ
514static inline void bio_clone_blkg_association(struct bio *dst,
515 struct bio *src) { }
3480373e
CH
516static inline void blkcg_punt_bio_submit(struct bio *bio)
517{
518 submit_bio(bio);
519}
852c788f
TH
520#endif /* CONFIG_BLK_CGROUP */
521
cf6d6238
PB
522static inline void bio_set_dev(struct bio *bio, struct block_device *bdev)
523{
524 bio_clear_flag(bio, BIO_REMAPPED);
525 if (bio->bi_bdev != bdev)
320fb0f9 526 bio_clear_flag(bio, BIO_BPS_THROTTLED);
cf6d6238
PB
527 bio->bi_bdev = bdev;
528 bio_associate_blkg(bio);
529}
530
8f3d8ba2 531/*
e686307f 532 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
8f3d8ba2
CH
533 *
534 * A bio_list anchors a singly-linked list of bios chained through the bi_next
535 * member of the bio. The bio_list also caches the last list member to allow
536 * fast access to the tail.
537 */
538struct bio_list {
539 struct bio *head;
540 struct bio *tail;
541};
542
543static inline int bio_list_empty(const struct bio_list *bl)
544{
545 return bl->head == NULL;
546}
547
548static inline void bio_list_init(struct bio_list *bl)
549{
550 bl->head = bl->tail = NULL;
551}
552
320ae51f
JA
553#define BIO_EMPTY_LIST { NULL, NULL }
554
8f3d8ba2
CH
555#define bio_list_for_each(bio, bl) \
556 for (bio = (bl)->head; bio; bio = bio->bi_next)
557
558static inline unsigned bio_list_size(const struct bio_list *bl)
559{
560 unsigned sz = 0;
561 struct bio *bio;
562
563 bio_list_for_each(bio, bl)
564 sz++;
565
566 return sz;
567}
568
569static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
570{
571 bio->bi_next = NULL;
572
573 if (bl->tail)
574 bl->tail->bi_next = bio;
575 else
576 bl->head = bio;
577
578 bl->tail = bio;
579}
580
581static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
582{
583 bio->bi_next = bl->head;
584
585 bl->head = bio;
586
587 if (!bl->tail)
588 bl->tail = bio;
589}
590
591static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
592{
593 if (!bl2->head)
594 return;
595
596 if (bl->tail)
597 bl->tail->bi_next = bl2->head;
598 else
599 bl->head = bl2->head;
600
601 bl->tail = bl2->tail;
602}
603
604static inline void bio_list_merge_head(struct bio_list *bl,
605 struct bio_list *bl2)
606{
607 if (!bl2->head)
608 return;
609
610 if (bl->head)
611 bl2->tail->bi_next = bl->head;
612 else
613 bl->tail = bl2->tail;
614
615 bl->head = bl2->head;
616}
617
13685a16
GU
618static inline struct bio *bio_list_peek(struct bio_list *bl)
619{
620 return bl->head;
621}
622
8f3d8ba2
CH
623static inline struct bio *bio_list_pop(struct bio_list *bl)
624{
625 struct bio *bio = bl->head;
626
627 if (bio) {
628 bl->head = bl->head->bi_next;
629 if (!bl->head)
630 bl->tail = NULL;
631
632 bio->bi_next = NULL;
633 }
634
635 return bio;
636}
637
638static inline struct bio *bio_list_get(struct bio_list *bl)
639{
640 struct bio *bio = bl->head;
641
642 bl->head = bl->tail = NULL;
643
644 return bio;
645}
646
0ef5a50c
MS
647/*
648 * Increment chain count for the bio. Make sure the CHAIN flag update
649 * is visible before the raised count.
650 */
651static inline void bio_inc_remaining(struct bio *bio)
652{
653 bio_set_flag(bio, BIO_CHAIN);
654 smp_mb__before_atomic();
655 atomic_inc(&bio->__bi_remaining);
656}
657
57fb233f
KO
658/*
659 * bio_set is used to allow other portions of the IO system to
660 * allocate their own private memory pools for bio and iovec structures.
661 * These memory pools in turn all allocate from the bio_slab
662 * and the bvec_slabs[].
663 */
664#define BIO_POOL_SIZE 2
57fb233f
KO
665
666struct bio_set {
667 struct kmem_cache *bio_slab;
668 unsigned int front_pad;
669
be4d234d
JA
670 /*
671 * per-cpu bio alloc cache
672 */
673 struct bio_alloc_cache __percpu *cache;
674
8aa6ba2f
KO
675 mempool_t bio_pool;
676 mempool_t bvec_pool;
57fb233f 677#if defined(CONFIG_BLK_DEV_INTEGRITY)
8aa6ba2f
KO
678 mempool_t bio_integrity_pool;
679 mempool_t bvec_integrity_pool;
57fb233f 680#endif
df2cb6da 681
9f180e31 682 unsigned int back_pad;
df2cb6da
KO
683 /*
684 * Deadlock avoidance for stacking block drivers: see comments in
685 * bio_alloc_bioset() for details
686 */
687 spinlock_t rescue_lock;
688 struct bio_list rescue_list;
689 struct work_struct rescue_work;
690 struct workqueue_struct *rescue_workqueue;
be4d234d
JA
691
692 /*
693 * Hot un-plug notifier for the per-cpu cache, if used
694 */
695 struct hlist_node cpuhp_dead;
57fb233f
KO
696};
697
338aa96d
KO
698static inline bool bioset_initialized(struct bio_set *bs)
699{
700 return bs->bio_slab != NULL;
701}
702
7ba1ba12
MP
703#if defined(CONFIG_BLK_DEV_INTEGRITY)
704
d57a5f7c
KO
705#define bip_for_each_vec(bvl, bip, iter) \
706 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
7ba1ba12 707
13f05c8d
MP
708#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
709 for_each_bio(_bio) \
710 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
711
7ba1ba12 712extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
7ba1ba12 713extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
e23947bd 714extern bool bio_integrity_prep(struct bio *);
7ba1ba12 715extern void bio_integrity_advance(struct bio *, unsigned int);
fbd08e76 716extern void bio_integrity_trim(struct bio *);
1e2a410f 717extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
7878cba9
MP
718extern int bioset_integrity_create(struct bio_set *, int);
719extern void bioset_integrity_free(struct bio_set *);
720extern void bio_integrity_init(void);
7ba1ba12
MP
721
722#else /* CONFIG_BLK_DEV_INTEGRITY */
723
c611529e 724static inline void *bio_integrity(struct bio *bio)
6898e3bd 725{
c611529e 726 return NULL;
6898e3bd
MP
727}
728
6898e3bd
MP
729static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
730{
731 return 0;
732}
733
734static inline void bioset_integrity_free (struct bio_set *bs)
735{
736 return;
737}
738
e23947bd 739static inline bool bio_integrity_prep(struct bio *bio)
6898e3bd 740{
e23947bd 741 return true;
6898e3bd
MP
742}
743
0c614e2d 744static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
1e2a410f 745 gfp_t gfp_mask)
0c614e2d
SR
746{
747 return 0;
748}
6898e3bd 749
6898e3bd
MP
750static inline void bio_integrity_advance(struct bio *bio,
751 unsigned int bytes_done)
752{
753 return;
754}
755
fbd08e76 756static inline void bio_integrity_trim(struct bio *bio)
6898e3bd
MP
757{
758 return;
759}
760
761static inline void bio_integrity_init(void)
762{
763 return;
764}
7ba1ba12 765
c611529e
MP
766static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
767{
768 return false;
769}
770
06c1e390
KB
771static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
772 unsigned int nr)
773{
774 return ERR_PTR(-EINVAL);
775}
776
777static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
778 unsigned int len, unsigned int offset)
779{
780 return 0;
781}
782
7ba1ba12
MP
783#endif /* CONFIG_BLK_DEV_INTEGRITY */
784
0bbb280d
JA
785/*
786 * Mark a bio as polled. Note that for async polled IO, the caller must
787 * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
788 * We cannot block waiting for requests on polled IO, as those completions
789 * must be found by the caller. This is different than IRQ driven IO, where
790 * it's safe to wait for IO to complete.
791 */
792static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
793{
6ce913fe 794 bio->bi_opf |= REQ_POLLED;
0bbb280d
JA
795 if (!is_sync_kiocb(kiocb))
796 bio->bi_opf |= REQ_NOWAIT;
797}
798
b53f3dcd
MS
799static inline void bio_clear_polled(struct bio *bio)
800{
53eab8e7 801 bio->bi_opf &= ~REQ_POLLED;
b53f3dcd
MS
802}
803
0a3140ea 804struct bio *blk_next_bio(struct bio *bio, struct block_device *bdev,
16458cf3 805 unsigned int nr_pages, blk_opf_t opf, gfp_t gfp);
c28a6147 806
1da177e4 807#endif /* __LINUX_BIO_H */