blob: c6d765382926441c5945a9ab3970c8ac7aa38c70 [file] [log] [blame]
Christoph Hellwig8c165672019-04-30 14:42:39 -04001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
5#ifndef __LINUX_BIO_H
6#define __LINUX_BIO_H
7
8#include <linux/highmem.h>
9#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020010#include <linux/ioprio.h>
Tejun Heo7cc01582010-08-03 13:14:58 +020011/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
12#include <linux/blk_types.h>
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#define BIO_DEBUG
15
16#ifdef BIO_DEBUG
17#define BIO_BUG_ON BUG_ON
18#else
19#define BIO_BUG_ON
20#endif
21
Alexey Dobriyand84a8472006-06-25 05:49:32 -070022#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Mike Christie43b62ce2016-06-05 14:32:20 -050024#define bio_prio(bio) (bio)->bi_ioprio
25#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020026
Kent Overstreet4550dd62013-08-07 14:26:21 -070027#define bio_iter_iovec(bio, iter) \
28 bvec_iter_bvec((bio)->bi_io_vec, (iter))
29
30#define bio_iter_page(bio, iter) \
31 bvec_iter_page((bio)->bi_io_vec, (iter))
32#define bio_iter_len(bio, iter) \
33 bvec_iter_len((bio)->bi_io_vec, (iter))
34#define bio_iter_offset(bio, iter) \
35 bvec_iter_offset((bio)->bi_io_vec, (iter))
36
37#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
38#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
39#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080040
Kent Overstreet458b76e2013-09-24 16:26:05 -070041#define bio_multiple_segments(bio) \
42 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet38a72da2018-05-08 21:33:53 -040043
44#define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
45#define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
46
47#define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter)
48#define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter)
Jens Axboebf2de6f2007-09-27 13:01:25 +020049
Kent Overstreet458b76e2013-09-24 16:26:05 -070050/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060051 * Return the data direction, READ or WRITE.
52 */
53#define bio_data_dir(bio) \
54 (op_is_write(bio_op(bio)) ? WRITE : READ)
55
56/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070057 * Check whether this bio carries any data or not. A NULL bio is allowed.
58 */
59static inline bool bio_has_data(struct bio *bio)
60{
61 if (bio &&
62 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030063 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080064 bio_op(bio) != REQ_OP_SECURE_ERASE &&
65 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070066 return true;
67
68 return false;
69}
70
Bart Van Asschec1527c02020-05-18 21:07:35 -070071static inline bool bio_no_advance_iter(const struct bio *bio)
Mike Christie95fe6c12016-06-05 14:31:48 -050072{
Adrian Hunter7afafc82016-08-16 10:59:35 +030073 return bio_op(bio) == REQ_OP_DISCARD ||
74 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080075 bio_op(bio) == REQ_OP_WRITE_SAME ||
76 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -050077}
78
Kent Overstreet458b76e2013-09-24 16:26:05 -070079static inline bool bio_mergeable(struct bio *bio)
80{
Jens Axboe1eff9d32016-08-05 15:35:16 -060081 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -070082 return false;
83
84 return true;
85}
86
Tejun Heo2e46e8b2009-05-07 22:24:41 +090087static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +020088{
Kent Overstreet458b76e2013-09-24 16:26:05 -070089 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -070090 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +010091 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -070092 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +020093}
94
95static inline void *bio_data(struct bio *bio)
96{
Kent Overstreet458b76e2013-09-24 16:26:05 -070097 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +020098 return page_address(bio_page(bio)) + bio_offset(bio);
99
100 return NULL;
101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Ming Lei79d08f82019-07-01 15:14:46 +0800103/**
104 * bio_full - check if the bio is full
105 * @bio: bio to check
106 * @len: length of one segment to be added
107 *
108 * Return true if @bio is full and one segment with @len bytes can't be
109 * added to the bio, otherwise return false
110 */
111static inline bool bio_full(struct bio *bio, unsigned len)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700112{
Ming Lei79d08f82019-07-01 15:14:46 +0800113 if (bio->bi_vcnt >= bio->bi_max_vecs)
114 return true;
115
116 if (bio->bi_iter.bi_size > UINT_MAX - len)
117 return true;
118
119 return false;
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700120}
121
Ming Lei1200e07f2019-04-08 19:02:38 +0800122static inline bool bio_next_segment(const struct bio *bio,
123 struct bvec_iter_all *iter)
124{
125 if (iter->idx >= bio->bi_vcnt)
126 return false;
127
128 bvec_advance(&bio->bi_io_vec[iter->idx], iter);
129 return true;
130}
Ming Lei6dc4f102019-02-15 19:13:19 +0800131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800133 * drivers should _never_ use the all version - the bio may have been split
134 * before it got to the driver and the driver won't own all of it
135 */
Christoph Hellwig2b070cf2019-04-25 09:03:00 +0200136#define bio_for_each_segment_all(bvl, bio, iter) \
137 for (bvl = bvec_init_iter_all(&iter); bio_next_segment((bio), &iter); )
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800138
Bart Van Asschec1527c02020-05-18 21:07:35 -0700139static inline void bio_advance_iter(const struct bio *bio,
140 struct bvec_iter *iter, unsigned int bytes)
Kent Overstreet4550dd62013-08-07 14:26:21 -0700141{
142 iter->bi_sector += bytes >> 9;
143
Ming Lei7759eb22018-09-05 15:45:54 -0600144 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700145 iter->bi_size -= bytes;
Ming Lei7759eb22018-09-05 15:45:54 -0600146 else
Kent Overstreet4550dd62013-08-07 14:26:21 -0700147 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700148 /* TODO: It is reasonable to complete bio with error here. */
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700149}
150
Kent Overstreet79886132013-11-23 17:19:00 -0800151#define __bio_for_each_segment(bvl, bio, iter, start) \
152 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700153 (iter).bi_size && \
154 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
155 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800156
157#define bio_for_each_segment(bvl, bio, iter) \
158 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
159
Ming Leid18d9172019-02-15 19:13:11 +0800160#define __bio_for_each_bvec(bvl, bio, iter, start) \
161 for (iter = (start); \
162 (iter).bi_size && \
163 ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \
164 bio_advance_iter((bio), &(iter), (bvl).bv_len))
165
166/* iterate over multi-page bvec */
167#define bio_for_each_bvec(bvl, bio, iter) \
168 __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter)
169
Omar Sandoval1072c122020-04-16 14:46:11 -0700170/*
171 * Iterate over all multi-page bvecs. Drivers shouldn't use this version for the
172 * same reasons as bio_for_each_segment_all().
173 */
174#define bio_for_each_bvec_all(bvl, bio, i) \
175 for (i = 0, bvl = bio_first_bvec_all(bio); \
176 i < (bio)->bi_vcnt; i++, bvl++) \
177
Kent Overstreet4550dd62013-08-07 14:26:21 -0700178#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Shaohua Lif4595872017-03-24 10:34:43 -0700180static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700181{
182 unsigned segs = 0;
183 struct bio_vec bv;
184 struct bvec_iter iter;
185
Kent Overstreet8423ae32014-02-10 17:45:50 -0800186 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800187 * We special case discard/write same/write zeroes, because they
188 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800189 */
190
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800191 switch (bio_op(bio)) {
192 case REQ_OP_DISCARD:
193 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800194 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700195 return 0;
196 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800197 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800198 default:
199 break;
200 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800201
Shaohua Lif4595872017-03-24 10:34:43 -0700202 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700203 segs++;
204
205 return segs;
206}
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208/*
209 * get a reference to a bio, so it won't disappear. the intended use is
210 * something like:
211 *
212 * bio_get(bio);
213 * submit_bio(rw, bio);
214 * if (bio->bi_flags ...)
215 * do_something
216 * bio_put(bio);
217 *
218 * without the bio_get(), it could potentially complete I/O before submit_bio
219 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
220 * runs
221 */
Jens Axboedac56212015-04-17 16:23:59 -0600222static inline void bio_get(struct bio *bio)
223{
224 bio->bi_flags |= (1 << BIO_REFFED);
225 smp_mb__before_atomic();
226 atomic_inc(&bio->__bi_cnt);
227}
228
229static inline void bio_cnt_set(struct bio *bio, unsigned int count)
230{
231 if (count != 1) {
232 bio->bi_flags |= (1 << BIO_REFFED);
Andrea Parrif381c6a2019-05-20 19:23:56 +0200233 smp_mb();
Jens Axboedac56212015-04-17 16:23:59 -0600234 }
235 atomic_set(&bio->__bi_cnt, count);
236}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600238static inline bool bio_flagged(struct bio *bio, unsigned int bit)
239{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600240 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600241}
242
243static inline void bio_set_flag(struct bio *bio, unsigned int bit)
244{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600245 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600246}
247
248static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
249{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600250 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600251}
252
Ming Lei7bcd79a2016-02-26 23:40:50 +0800253static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
254{
255 *bv = bio_iovec(bio);
256}
257
258static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
259{
260 struct bvec_iter iter = bio->bi_iter;
261 int idx;
262
Ming Lei7bcd79a2016-02-26 23:40:50 +0800263 if (unlikely(!bio_multiple_segments(bio))) {
264 *bv = bio_iovec(bio);
265 return;
266 }
267
268 bio_advance_iter(bio, &iter, iter.bi_size);
269
270 if (!iter.bi_bvec_done)
271 idx = iter.bi_idx - 1;
272 else /* in the middle of bvec */
273 idx = iter.bi_idx;
274
275 *bv = bio->bi_io_vec[idx];
276
277 /*
278 * iter.bi_bvec_done records actual length of the last bvec
279 * if this bio ends in the middle of one io vector
280 */
281 if (iter.bi_bvec_done)
282 bv->bv_len = iter.bi_bvec_done;
283}
284
Ming Lei86292ab2017-12-18 20:22:03 +0800285static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
286{
287 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
288 return bio->bi_io_vec;
289}
290
291static inline struct page *bio_first_page_all(struct bio *bio)
292{
293 return bio_first_bvec_all(bio)->bv_page;
294}
295
296static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
297{
298 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
299 return &bio->bi_io_vec[bio->bi_vcnt - 1];
300}
301
Martin K. Petersenc6115292014-09-26 19:20:08 -0400302enum bip_flags {
303 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
304 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
305 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
306 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
307 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
308};
309
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200310/*
311 * bio integrity payload
312 */
313struct bio_integrity_payload {
314 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200315
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800316 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200317
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200318 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200319 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600320 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400321 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200322
Ming Lei7759eb22018-09-05 15:45:54 -0600323 struct bvec_iter bio_iter; /* for rewinding parent bio */
324
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200325 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700326
327 struct bio_vec *bip_vec;
Gustavo A. R. Silva0a368bf2020-03-23 16:40:21 -0500328 struct bio_vec bip_inline_vecs[];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200329};
Martin K. Petersen18593082014-09-26 19:20:01 -0400330
Keith Busch06c1e392015-12-03 09:32:21 -0700331#if defined(CONFIG_BLK_DEV_INTEGRITY)
332
333static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
334{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600335 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700336 return bio->bi_integrity;
337
338 return NULL;
339}
340
Martin K. Petersenc6115292014-09-26 19:20:08 -0400341static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
342{
343 struct bio_integrity_payload *bip = bio_integrity(bio);
344
345 if (bip)
346 return bip->bip_flags & flag;
347
348 return false;
349}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400350
Martin K. Petersen18593082014-09-26 19:20:01 -0400351static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
352{
353 return bip->bip_iter.bi_sector;
354}
355
356static inline void bip_set_seed(struct bio_integrity_payload *bip,
357 sector_t seed)
358{
359 bip->bip_iter.bi_sector = seed;
360}
361
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200362#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Kent Overstreet6678d832013-08-07 11:14:32 -0700364extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800365extern struct bio *bio_split(struct bio *bio, int sectors,
366 gfp_t gfp, struct bio_set *bs);
367
368/**
369 * bio_next_split - get next @sectors from a bio, splitting if necessary
370 * @bio: bio to split
371 * @sectors: number of sectors to split from the front of @bio
372 * @gfp: gfp mask
373 * @bs: bio set to allocate from
374 *
375 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
376 * than @sectors, returns the original bio unchanged.
377 */
378static inline struct bio *bio_next_split(struct bio *bio, int sectors,
379 gfp_t gfp, struct bio_set *bs)
380{
381 if (sectors >= bio_sectors(bio))
382 return bio;
383
384 return bio_split(bio, sectors, gfp, bs);
385}
386
NeilBrown011067b2017-06-18 14:38:57 +1000387enum {
388 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000389 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000390};
Kent Overstreetdad08522018-05-20 18:25:58 -0400391extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
392extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400393extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600394extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300396extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Kent Overstreet59d276f2013-11-23 18:19:27 -0800399extern void __bio_clone_fast(struct bio *, struct bio *);
400extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700401
Kent Overstreetf4f81542018-05-08 21:33:52 -0400402extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700403
404static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
405{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400406 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700407}
408
409static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
410{
411 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
412}
413
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600414extern blk_qc_t submit_bio(struct bio *);
415
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200416extern void bio_endio(struct bio *);
417
418static inline void bio_io_error(struct bio *bio)
419{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200420 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200421 bio_endio(bio);
422}
423
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500424static inline void bio_wouldblock_error(struct bio *bio)
425{
Jens Axboeabb30462020-06-01 10:02:01 -0600426 bio_set_flag(bio, BIO_QUIET);
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500427 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700428 bio_endio(bio);
429}
NeilBrown6712ecf2007-09-27 12:47:43 +0200430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Mike Christie4e49ea42016-06-05 14:31:41 -0500433extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700434extern void bio_advance(struct bio *, unsigned);
435
Ming Lei3a83f462016-11-22 08:57:21 -0700436extern void bio_init(struct bio *bio, struct bio_vec *table,
437 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600438extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700439extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800440void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600443extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
444 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700445bool __bio_try_merge_page(struct bio *bio, struct page *page,
Christoph Hellwigff896732019-06-17 11:14:11 +0200446 unsigned int len, unsigned int off, bool *same_page);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700447void __bio_add_page(struct bio *bio, struct page *page,
448 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600449int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
Christoph Hellwigd241a952019-06-26 15:49:21 +0200450void bio_release_pages(struct bio *bio, bool mark_dirty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451extern void bio_set_pages_dirty(struct bio *bio);
452extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100453
Kent Overstreet45db54d2018-05-08 21:33:54 -0400454extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
455 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700456extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400457extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400458extern void bio_free_pages(struct bio *bio);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400459void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
Ming Lei85a8ce62019-12-28 07:05:48 +0800460void bio_truncate(struct bio *bio, unsigned new_size);
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100461void guard_bio_eod(struct bio *bio);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400462
463static inline void zero_fill_bio(struct bio *bio)
464{
465 zero_fill_bio_iter(bio, bio->bi_iter);
466}
467
Kent Overstreet9f060e22012-10-12 15:29:33 -0700468extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
469extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200470extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800471extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200472
Christoph Hellwig74d46992017-08-23 19:10:32 +0200473#define bio_set_dev(bio, bdev) \
474do { \
Shaohua Li111be882017-12-20 11:10:17 -0700475 if ((bio)->bi_disk != (bdev)->bd_disk) \
476 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200477 (bio)->bi_disk = (bdev)->bd_disk; \
478 (bio)->bi_partno = (bdev)->bd_partno; \
Dennis Zhou5cdf2e32018-12-05 12:10:31 -0500479 bio_associate_blkg(bio); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200480} while (0)
481
482#define bio_copy_dev(dst, src) \
483do { \
484 (dst)->bi_disk = (src)->bi_disk; \
485 (dst)->bi_partno = (src)->bi_partno; \
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500486 bio_clone_blkg_association(dst, src); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200487} while (0)
488
489#define bio_dev(bio) \
490 disk_devt((bio)->bi_disk)
491
Tejun Heo852c7882012-03-05 13:15:27 -0800492#ifdef CONFIG_BLK_CGROUP
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500493void bio_associate_blkg(struct bio *bio);
Dennis Zhoufd42df32018-12-05 12:10:34 -0500494void bio_associate_blkg_from_css(struct bio *bio,
495 struct cgroup_subsys_state *css);
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500496void bio_clone_blkg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800497#else /* CONFIG_BLK_CGROUP */
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500498static inline void bio_associate_blkg(struct bio *bio) { }
Dennis Zhoufd42df32018-12-05 12:10:34 -0500499static inline void bio_associate_blkg_from_css(struct bio *bio,
500 struct cgroup_subsys_state *css)
501{ }
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500502static inline void bio_clone_blkg_association(struct bio *dst,
503 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800504#endif /* CONFIG_BLK_CGROUP */
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506#ifdef CONFIG_HIGHMEM
507/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100508 * remember never ever reenable interrupts between a bvec_kmap_irq and
509 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100511static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
513 unsigned long addr;
514
515 /*
516 * might not be a highmem page, but the preempt/irq count
517 * balancing is a lot nicer this way
518 */
519 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800520 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
522 BUG_ON(addr & ~PAGE_MASK);
523
524 return (char *) addr + bvec->bv_offset;
525}
526
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100527static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{
529 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
530
Cong Wange8e3c3d2011-11-25 23:14:27 +0800531 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 local_irq_restore(*flags);
533}
534
535#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200536static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
537{
538 return page_address(bvec->bv_page) + bvec->bv_offset;
539}
540
541static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
542{
543 *flags = 0;
544}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545#endif
546
Jens Axboe7a67f632008-08-08 11:17:12 +0200547/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200548 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200549 *
550 * A bio_list anchors a singly-linked list of bios chained through the bi_next
551 * member of the bio. The bio_list also caches the last list member to allow
552 * fast access to the tail.
553 */
554struct bio_list {
555 struct bio *head;
556 struct bio *tail;
557};
558
559static inline int bio_list_empty(const struct bio_list *bl)
560{
561 return bl->head == NULL;
562}
563
564static inline void bio_list_init(struct bio_list *bl)
565{
566 bl->head = bl->tail = NULL;
567}
568
Jens Axboe320ae512013-10-24 09:20:05 +0100569#define BIO_EMPTY_LIST { NULL, NULL }
570
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200571#define bio_list_for_each(bio, bl) \
572 for (bio = (bl)->head; bio; bio = bio->bi_next)
573
574static inline unsigned bio_list_size(const struct bio_list *bl)
575{
576 unsigned sz = 0;
577 struct bio *bio;
578
579 bio_list_for_each(bio, bl)
580 sz++;
581
582 return sz;
583}
584
585static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
586{
587 bio->bi_next = NULL;
588
589 if (bl->tail)
590 bl->tail->bi_next = bio;
591 else
592 bl->head = bio;
593
594 bl->tail = bio;
595}
596
597static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
598{
599 bio->bi_next = bl->head;
600
601 bl->head = bio;
602
603 if (!bl->tail)
604 bl->tail = bio;
605}
606
607static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
608{
609 if (!bl2->head)
610 return;
611
612 if (bl->tail)
613 bl->tail->bi_next = bl2->head;
614 else
615 bl->head = bl2->head;
616
617 bl->tail = bl2->tail;
618}
619
620static inline void bio_list_merge_head(struct bio_list *bl,
621 struct bio_list *bl2)
622{
623 if (!bl2->head)
624 return;
625
626 if (bl->head)
627 bl2->tail->bi_next = bl->head;
628 else
629 bl->tail = bl2->tail;
630
631 bl->head = bl2->head;
632}
633
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000634static inline struct bio *bio_list_peek(struct bio_list *bl)
635{
636 return bl->head;
637}
638
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200639static inline struct bio *bio_list_pop(struct bio_list *bl)
640{
641 struct bio *bio = bl->head;
642
643 if (bio) {
644 bl->head = bl->head->bi_next;
645 if (!bl->head)
646 bl->tail = NULL;
647
648 bio->bi_next = NULL;
649 }
650
651 return bio;
652}
653
654static inline struct bio *bio_list_get(struct bio_list *bl)
655{
656 struct bio *bio = bl->head;
657
658 bl->head = bl->tail = NULL;
659
660 return bio;
661}
662
Kent Overstreet57fb2332012-08-24 04:56:11 -0700663/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400664 * Increment chain count for the bio. Make sure the CHAIN flag update
665 * is visible before the raised count.
666 */
667static inline void bio_inc_remaining(struct bio *bio)
668{
669 bio_set_flag(bio, BIO_CHAIN);
670 smp_mb__before_atomic();
671 atomic_inc(&bio->__bi_remaining);
672}
673
674/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700675 * bio_set is used to allow other portions of the IO system to
676 * allocate their own private memory pools for bio and iovec structures.
677 * These memory pools in turn all allocate from the bio_slab
678 * and the bvec_slabs[].
679 */
680#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700681
682struct bio_set {
683 struct kmem_cache *bio_slab;
684 unsigned int front_pad;
685
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400686 mempool_t bio_pool;
687 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700688#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400689 mempool_t bio_integrity_pool;
690 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700691#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700692
693 /*
694 * Deadlock avoidance for stacking block drivers: see comments in
695 * bio_alloc_bioset() for details
696 */
697 spinlock_t rescue_lock;
698 struct bio_list rescue_list;
699 struct work_struct rescue_work;
700 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700701};
702
703struct biovec_slab {
704 int nr_vecs;
705 char *name;
706 struct kmem_cache *slab;
707};
708
Kent Overstreet338aa962018-05-20 18:25:47 -0400709static inline bool bioset_initialized(struct bio_set *bs)
710{
711 return bs->bio_slab != NULL;
712}
713
Kent Overstreet57fb2332012-08-24 04:56:11 -0700714/*
715 * a small number of entries is fine, not going to be performance critical.
716 * basically we just need to survive
717 */
718#define BIO_SPLIT_ENTRIES 2
719
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200720#if defined(CONFIG_BLK_DEV_INTEGRITY)
721
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800722#define bip_for_each_vec(bvl, bip, iter) \
723 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200724
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200725#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
726 for_each_bio(_bio) \
727 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
728
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200729extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200730extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700731extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200732extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700733extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700734extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200735extern int bioset_integrity_create(struct bio_set *, int);
736extern void bioset_integrity_free(struct bio_set *);
737extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200738
739#else /* CONFIG_BLK_DEV_INTEGRITY */
740
Martin K. Petersenc6115292014-09-26 19:20:08 -0400741static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100742{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400743 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100744}
745
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100746static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
747{
748 return 0;
749}
750
751static inline void bioset_integrity_free (struct bio_set *bs)
752{
753 return;
754}
755
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700756static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100757{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700758 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100759}
760
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100761static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700762 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100763{
764 return 0;
765}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100766
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100767static inline void bio_integrity_advance(struct bio *bio,
768 unsigned int bytes_done)
769{
770 return;
771}
772
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700773static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100774{
775 return;
776}
777
778static inline void bio_integrity_init(void)
779{
780 return;
781}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200782
Martin K. Petersenc6115292014-09-26 19:20:08 -0400783static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
784{
785 return false;
786}
787
Keith Busch06c1e392015-12-03 09:32:21 -0700788static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
789 unsigned int nr)
790{
791 return ERR_PTR(-EINVAL);
792}
793
794static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
795 unsigned int len, unsigned int offset)
796{
797 return 0;
798}
799
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200800#endif /* CONFIG_BLK_DEV_INTEGRITY */
801
Jens Axboe0bbb2802018-12-21 09:10:46 -0700802/*
803 * Mark a bio as polled. Note that for async polled IO, the caller must
804 * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
805 * We cannot block waiting for requests on polled IO, as those completions
806 * must be found by the caller. This is different than IRQ driven IO, where
807 * it's safe to wait for IO to complete.
808 */
809static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
810{
811 bio->bi_opf |= REQ_HIPRI;
812 if (!is_sync_kiocb(kiocb))
813 bio->bi_opf |= REQ_NOWAIT;
814}
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816#endif /* __LINUX_BIO_H */