blob: a0ee494a6329a8cc48760bceb81ea6ba9f56585e [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
David Howells02a5e0a2007-08-11 22:34:32 +020012#ifdef CONFIG_BLOCK
Tejun Heo7cc01582010-08-03 13:14:58 +020013/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
14#include <linux/blk_types.h>
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#define BIO_DEBUG
17
18#ifdef BIO_DEBUG
19#define BIO_BUG_ON BUG_ON
20#else
21#define BIO_BUG_ON
22#endif
23
Alexey Dobriyand84a8472006-06-25 05:49:32 -070024#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Mike Christie43b62ce2016-06-05 14:32:20 -050026#define bio_prio(bio) (bio)->bi_ioprio
27#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020028
Kent Overstreet4550dd62013-08-07 14:26:21 -070029#define bio_iter_iovec(bio, iter) \
30 bvec_iter_bvec((bio)->bi_io_vec, (iter))
31
32#define bio_iter_page(bio, iter) \
33 bvec_iter_page((bio)->bi_io_vec, (iter))
34#define bio_iter_len(bio, iter) \
35 bvec_iter_len((bio)->bi_io_vec, (iter))
36#define bio_iter_offset(bio, iter) \
37 bvec_iter_offset((bio)->bi_io_vec, (iter))
38
39#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
40#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
41#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080042
Kent Overstreet458b76e2013-09-24 16:26:05 -070043#define bio_multiple_segments(bio) \
44 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet38a72da2018-05-08 21:33:53 -040045
46#define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
47#define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
48
49#define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter)
50#define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter)
Jens Axboebf2de6f2007-09-27 13:01:25 +020051
Kent Overstreet458b76e2013-09-24 16:26:05 -070052/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060053 * Return the data direction, READ or WRITE.
54 */
55#define bio_data_dir(bio) \
56 (op_is_write(bio_op(bio)) ? WRITE : READ)
57
58/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070059 * Check whether this bio carries any data or not. A NULL bio is allowed.
60 */
61static inline bool bio_has_data(struct bio *bio)
62{
63 if (bio &&
64 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030065 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080066 bio_op(bio) != REQ_OP_SECURE_ERASE &&
67 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070068 return true;
69
70 return false;
71}
72
Mike Christie95fe6c12016-06-05 14:31:48 -050073static inline bool bio_no_advance_iter(struct bio *bio)
74{
Adrian Hunter7afafc82016-08-16 10:59:35 +030075 return bio_op(bio) == REQ_OP_DISCARD ||
76 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080077 bio_op(bio) == REQ_OP_WRITE_SAME ||
78 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -050079}
80
Kent Overstreet458b76e2013-09-24 16:26:05 -070081static inline bool bio_mergeable(struct bio *bio)
82{
Jens Axboe1eff9d32016-08-05 15:35:16 -060083 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -070084 return false;
85
86 return true;
87}
88
Tejun Heo2e46e8b2009-05-07 22:24:41 +090089static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +020090{
Kent Overstreet458b76e2013-09-24 16:26:05 -070091 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -070092 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +010093 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -070094 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +020095}
96
97static inline void *bio_data(struct bio *bio)
98{
Kent Overstreet458b76e2013-09-24 16:26:05 -070099 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200100 return page_address(bio_page(bio)) + bio_offset(bio);
101
102 return NULL;
103}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Ming Lei79d08f82019-07-01 15:14:46 +0800105/**
106 * bio_full - check if the bio is full
107 * @bio: bio to check
108 * @len: length of one segment to be added
109 *
110 * Return true if @bio is full and one segment with @len bytes can't be
111 * added to the bio, otherwise return false
112 */
113static inline bool bio_full(struct bio *bio, unsigned len)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700114{
Ming Lei79d08f82019-07-01 15:14:46 +0800115 if (bio->bi_vcnt >= bio->bi_max_vecs)
116 return true;
117
118 if (bio->bi_iter.bi_size > UINT_MAX - len)
119 return true;
120
121 return false;
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700122}
123
Ming Lei1200e07f2019-04-08 19:02:38 +0800124static inline bool bio_next_segment(const struct bio *bio,
125 struct bvec_iter_all *iter)
126{
127 if (iter->idx >= bio->bi_vcnt)
128 return false;
129
130 bvec_advance(&bio->bi_io_vec[iter->idx], iter);
131 return true;
132}
Ming Lei6dc4f102019-02-15 19:13:19 +0800133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800135 * drivers should _never_ use the all version - the bio may have been split
136 * before it got to the driver and the driver won't own all of it
137 */
Christoph Hellwig2b070cf2019-04-25 09:03:00 +0200138#define bio_for_each_segment_all(bvl, bio, iter) \
139 for (bvl = bvec_init_iter_all(&iter); bio_next_segment((bio), &iter); )
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800140
Kent Overstreet4550dd62013-08-07 14:26:21 -0700141static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
142 unsigned bytes)
143{
144 iter->bi_sector += bytes >> 9;
145
Ming Lei7759eb22018-09-05 15:45:54 -0600146 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700147 iter->bi_size -= bytes;
Ming Lei7759eb22018-09-05 15:45:54 -0600148 else
Kent Overstreet4550dd62013-08-07 14:26:21 -0700149 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700150 /* TODO: It is reasonable to complete bio with error here. */
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700151}
152
Kent Overstreet79886132013-11-23 17:19:00 -0800153#define __bio_for_each_segment(bvl, bio, iter, start) \
154 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700155 (iter).bi_size && \
156 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
157 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800158
159#define bio_for_each_segment(bvl, bio, iter) \
160 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
161
Ming Leid18d9172019-02-15 19:13:11 +0800162#define __bio_for_each_bvec(bvl, bio, iter, start) \
163 for (iter = (start); \
164 (iter).bi_size && \
165 ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \
166 bio_advance_iter((bio), &(iter), (bvl).bv_len))
167
168/* iterate over multi-page bvec */
169#define bio_for_each_bvec(bvl, bio, iter) \
170 __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter)
171
Kent Overstreet4550dd62013-08-07 14:26:21 -0700172#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Shaohua Lif4595872017-03-24 10:34:43 -0700174static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700175{
176 unsigned segs = 0;
177 struct bio_vec bv;
178 struct bvec_iter iter;
179
Kent Overstreet8423ae32014-02-10 17:45:50 -0800180 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800181 * We special case discard/write same/write zeroes, because they
182 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800183 */
184
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800185 switch (bio_op(bio)) {
186 case REQ_OP_DISCARD:
187 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800188 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700189 return 0;
190 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800191 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800192 default:
193 break;
194 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800195
Shaohua Lif4595872017-03-24 10:34:43 -0700196 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700197 segs++;
198
199 return segs;
200}
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/*
203 * get a reference to a bio, so it won't disappear. the intended use is
204 * something like:
205 *
206 * bio_get(bio);
207 * submit_bio(rw, bio);
208 * if (bio->bi_flags ...)
209 * do_something
210 * bio_put(bio);
211 *
212 * without the bio_get(), it could potentially complete I/O before submit_bio
213 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
214 * runs
215 */
Jens Axboedac56212015-04-17 16:23:59 -0600216static inline void bio_get(struct bio *bio)
217{
218 bio->bi_flags |= (1 << BIO_REFFED);
219 smp_mb__before_atomic();
220 atomic_inc(&bio->__bi_cnt);
221}
222
223static inline void bio_cnt_set(struct bio *bio, unsigned int count)
224{
225 if (count != 1) {
226 bio->bi_flags |= (1 << BIO_REFFED);
Andrea Parrif381c6a2019-05-20 19:23:56 +0200227 smp_mb();
Jens Axboedac56212015-04-17 16:23:59 -0600228 }
229 atomic_set(&bio->__bi_cnt, count);
230}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600232static inline bool bio_flagged(struct bio *bio, unsigned int bit)
233{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600234 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600235}
236
237static inline void bio_set_flag(struct bio *bio, unsigned int bit)
238{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600239 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600240}
241
242static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
243{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600244 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600245}
246
Ming Lei7bcd79a2016-02-26 23:40:50 +0800247static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
248{
249 *bv = bio_iovec(bio);
250}
251
252static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
253{
254 struct bvec_iter iter = bio->bi_iter;
255 int idx;
256
Ming Lei7bcd79a2016-02-26 23:40:50 +0800257 if (unlikely(!bio_multiple_segments(bio))) {
258 *bv = bio_iovec(bio);
259 return;
260 }
261
262 bio_advance_iter(bio, &iter, iter.bi_size);
263
264 if (!iter.bi_bvec_done)
265 idx = iter.bi_idx - 1;
266 else /* in the middle of bvec */
267 idx = iter.bi_idx;
268
269 *bv = bio->bi_io_vec[idx];
270
271 /*
272 * iter.bi_bvec_done records actual length of the last bvec
273 * if this bio ends in the middle of one io vector
274 */
275 if (iter.bi_bvec_done)
276 bv->bv_len = iter.bi_bvec_done;
277}
278
Ming Lei86292ab2017-12-18 20:22:03 +0800279static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
280{
281 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
282 return bio->bi_io_vec;
283}
284
285static inline struct page *bio_first_page_all(struct bio *bio)
286{
287 return bio_first_bvec_all(bio)->bv_page;
288}
289
290static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
291{
292 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
293 return &bio->bi_io_vec[bio->bi_vcnt - 1];
294}
295
Martin K. Petersenc6115292014-09-26 19:20:08 -0400296enum bip_flags {
297 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
298 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
299 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
300 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
301 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
302};
303
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200304/*
305 * bio integrity payload
306 */
307struct bio_integrity_payload {
308 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800310 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200311
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200312 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200313 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600314 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400315 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200316
Ming Lei7759eb22018-09-05 15:45:54 -0600317 struct bvec_iter bio_iter; /* for rewinding parent bio */
318
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200319 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700320
321 struct bio_vec *bip_vec;
Gustavo A. R. Silva0a368bf2020-03-23 16:40:21 -0500322 struct bio_vec bip_inline_vecs[];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200323};
Martin K. Petersen18593082014-09-26 19:20:01 -0400324
Keith Busch06c1e392015-12-03 09:32:21 -0700325#if defined(CONFIG_BLK_DEV_INTEGRITY)
326
327static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
328{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600329 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700330 return bio->bi_integrity;
331
332 return NULL;
333}
334
Martin K. Petersenc6115292014-09-26 19:20:08 -0400335static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
336{
337 struct bio_integrity_payload *bip = bio_integrity(bio);
338
339 if (bip)
340 return bip->bip_flags & flag;
341
342 return false;
343}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400344
Martin K. Petersen18593082014-09-26 19:20:01 -0400345static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
346{
347 return bip->bip_iter.bi_sector;
348}
349
350static inline void bip_set_seed(struct bio_integrity_payload *bip,
351 sector_t seed)
352{
353 bip->bip_iter.bi_sector = seed;
354}
355
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200356#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Kent Overstreet6678d832013-08-07 11:14:32 -0700358extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800359extern struct bio *bio_split(struct bio *bio, int sectors,
360 gfp_t gfp, struct bio_set *bs);
361
362/**
363 * bio_next_split - get next @sectors from a bio, splitting if necessary
364 * @bio: bio to split
365 * @sectors: number of sectors to split from the front of @bio
366 * @gfp: gfp mask
367 * @bs: bio set to allocate from
368 *
369 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
370 * than @sectors, returns the original bio unchanged.
371 */
372static inline struct bio *bio_next_split(struct bio *bio, int sectors,
373 gfp_t gfp, struct bio_set *bs)
374{
375 if (sectors >= bio_sectors(bio))
376 return bio;
377
378 return bio_split(bio, sectors, gfp, bs);
379}
380
NeilBrown011067b2017-06-18 14:38:57 +1000381enum {
382 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000383 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000384};
Kent Overstreetdad08522018-05-20 18:25:58 -0400385extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
386extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400387extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600388extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300390extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Kent Overstreet59d276f2013-11-23 18:19:27 -0800393extern void __bio_clone_fast(struct bio *, struct bio *);
394extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700395
Kent Overstreetf4f81542018-05-08 21:33:52 -0400396extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700397
398static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
399{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400400 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700401}
402
403static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
404{
405 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
406}
407
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600408extern blk_qc_t submit_bio(struct bio *);
409
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200410extern void bio_endio(struct bio *);
411
412static inline void bio_io_error(struct bio *bio)
413{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200414 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200415 bio_endio(bio);
416}
417
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500418static inline void bio_wouldblock_error(struct bio *bio)
419{
420 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700421 bio_endio(bio);
422}
NeilBrown6712ecf2007-09-27 12:47:43 +0200423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Mike Christie4e49ea42016-06-05 14:31:41 -0500426extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700427extern void bio_advance(struct bio *, unsigned);
428
Ming Lei3a83f462016-11-22 08:57:21 -0700429extern void bio_init(struct bio *bio, struct bio_vec *table,
430 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600431extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700432extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800433void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600436extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
437 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700438bool __bio_try_merge_page(struct bio *bio, struct page *page,
Christoph Hellwigff896732019-06-17 11:14:11 +0200439 unsigned int len, unsigned int off, bool *same_page);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700440void __bio_add_page(struct bio *bio, struct page *page,
441 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600442int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
Christoph Hellwigd241a952019-06-26 15:49:21 +0200443void bio_release_pages(struct bio *bio, bool mark_dirty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444extern void bio_set_pages_dirty(struct bio *bio);
445extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100446
Michael Callahanddcf35d2018-07-18 04:47:39 -0700447void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600448 unsigned long sectors, struct hd_struct *part);
Michael Callahanddcf35d2018-07-18 04:47:39 -0700449void generic_end_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600450 struct hd_struct *part,
451 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800452
Kent Overstreet45db54d2018-05-08 21:33:54 -0400453extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
454 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700455extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400456extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400457extern void bio_free_pages(struct bio *bio);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400458void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
Ming Lei85a8ce62019-12-28 07:05:48 +0800459void bio_truncate(struct bio *bio, unsigned new_size);
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100460void guard_bio_eod(struct bio *bio);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400461
462static inline void zero_fill_bio(struct bio *bio)
463{
464 zero_fill_bio_iter(bio, bio->bi_iter);
465}
466
Kent Overstreet9f060e22012-10-12 15:29:33 -0700467extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
468extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200469extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800470extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200471
Christoph Hellwig74d46992017-08-23 19:10:32 +0200472#define bio_set_dev(bio, bdev) \
473do { \
Shaohua Li111be882017-12-20 11:10:17 -0700474 if ((bio)->bi_disk != (bdev)->bd_disk) \
475 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200476 (bio)->bi_disk = (bdev)->bd_disk; \
477 (bio)->bi_partno = (bdev)->bd_partno; \
Dennis Zhou5cdf2e32018-12-05 12:10:31 -0500478 bio_associate_blkg(bio); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200479} while (0)
480
481#define bio_copy_dev(dst, src) \
482do { \
483 (dst)->bi_disk = (src)->bi_disk; \
484 (dst)->bi_partno = (src)->bi_partno; \
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500485 bio_clone_blkg_association(dst, src); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200486} while (0)
487
488#define bio_dev(bio) \
489 disk_devt((bio)->bi_disk)
490
Tejun Heo0d3bd882018-07-03 11:14:54 -0400491#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500492void bio_associate_blkg_from_page(struct bio *bio, struct page *page);
Tejun Heo0d3bd882018-07-03 11:14:54 -0400493#else
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500494static inline void bio_associate_blkg_from_page(struct bio *bio,
495 struct page *page) { }
Tejun Heo0d3bd882018-07-03 11:14:54 -0400496#endif
497
Tejun Heo852c7882012-03-05 13:15:27 -0800498#ifdef CONFIG_BLK_CGROUP
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500499void bio_disassociate_blkg(struct bio *bio);
500void bio_associate_blkg(struct bio *bio);
Dennis Zhoufd42df32018-12-05 12:10:34 -0500501void bio_associate_blkg_from_css(struct bio *bio,
502 struct cgroup_subsys_state *css);
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500503void bio_clone_blkg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800504#else /* CONFIG_BLK_CGROUP */
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500505static inline void bio_disassociate_blkg(struct bio *bio) { }
506static inline void bio_associate_blkg(struct bio *bio) { }
Dennis Zhoufd42df32018-12-05 12:10:34 -0500507static inline void bio_associate_blkg_from_css(struct bio *bio,
508 struct cgroup_subsys_state *css)
509{ }
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500510static inline void bio_clone_blkg_association(struct bio *dst,
511 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800512#endif /* CONFIG_BLK_CGROUP */
513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514#ifdef CONFIG_HIGHMEM
515/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100516 * remember never ever reenable interrupts between a bvec_kmap_irq and
517 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100519static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
521 unsigned long addr;
522
523 /*
524 * might not be a highmem page, but the preempt/irq count
525 * balancing is a lot nicer this way
526 */
527 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800528 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530 BUG_ON(addr & ~PAGE_MASK);
531
532 return (char *) addr + bvec->bv_offset;
533}
534
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100535static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
538
Cong Wange8e3c3d2011-11-25 23:14:27 +0800539 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 local_irq_restore(*flags);
541}
542
543#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200544static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
545{
546 return page_address(bvec->bv_page) + bvec->bv_offset;
547}
548
549static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
550{
551 *flags = 0;
552}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#endif
554
Jens Axboe7a67f632008-08-08 11:17:12 +0200555/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200556 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200557 *
558 * A bio_list anchors a singly-linked list of bios chained through the bi_next
559 * member of the bio. The bio_list also caches the last list member to allow
560 * fast access to the tail.
561 */
562struct bio_list {
563 struct bio *head;
564 struct bio *tail;
565};
566
567static inline int bio_list_empty(const struct bio_list *bl)
568{
569 return bl->head == NULL;
570}
571
572static inline void bio_list_init(struct bio_list *bl)
573{
574 bl->head = bl->tail = NULL;
575}
576
Jens Axboe320ae512013-10-24 09:20:05 +0100577#define BIO_EMPTY_LIST { NULL, NULL }
578
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200579#define bio_list_for_each(bio, bl) \
580 for (bio = (bl)->head; bio; bio = bio->bi_next)
581
582static inline unsigned bio_list_size(const struct bio_list *bl)
583{
584 unsigned sz = 0;
585 struct bio *bio;
586
587 bio_list_for_each(bio, bl)
588 sz++;
589
590 return sz;
591}
592
593static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
594{
595 bio->bi_next = NULL;
596
597 if (bl->tail)
598 bl->tail->bi_next = bio;
599 else
600 bl->head = bio;
601
602 bl->tail = bio;
603}
604
605static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
606{
607 bio->bi_next = bl->head;
608
609 bl->head = bio;
610
611 if (!bl->tail)
612 bl->tail = bio;
613}
614
615static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
616{
617 if (!bl2->head)
618 return;
619
620 if (bl->tail)
621 bl->tail->bi_next = bl2->head;
622 else
623 bl->head = bl2->head;
624
625 bl->tail = bl2->tail;
626}
627
628static inline void bio_list_merge_head(struct bio_list *bl,
629 struct bio_list *bl2)
630{
631 if (!bl2->head)
632 return;
633
634 if (bl->head)
635 bl2->tail->bi_next = bl->head;
636 else
637 bl->tail = bl2->tail;
638
639 bl->head = bl2->head;
640}
641
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000642static inline struct bio *bio_list_peek(struct bio_list *bl)
643{
644 return bl->head;
645}
646
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200647static inline struct bio *bio_list_pop(struct bio_list *bl)
648{
649 struct bio *bio = bl->head;
650
651 if (bio) {
652 bl->head = bl->head->bi_next;
653 if (!bl->head)
654 bl->tail = NULL;
655
656 bio->bi_next = NULL;
657 }
658
659 return bio;
660}
661
662static inline struct bio *bio_list_get(struct bio_list *bl)
663{
664 struct bio *bio = bl->head;
665
666 bl->head = bl->tail = NULL;
667
668 return bio;
669}
670
Kent Overstreet57fb2332012-08-24 04:56:11 -0700671/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400672 * Increment chain count for the bio. Make sure the CHAIN flag update
673 * is visible before the raised count.
674 */
675static inline void bio_inc_remaining(struct bio *bio)
676{
677 bio_set_flag(bio, BIO_CHAIN);
678 smp_mb__before_atomic();
679 atomic_inc(&bio->__bi_remaining);
680}
681
682/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700683 * bio_set is used to allow other portions of the IO system to
684 * allocate their own private memory pools for bio and iovec structures.
685 * These memory pools in turn all allocate from the bio_slab
686 * and the bvec_slabs[].
687 */
688#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700689
690struct bio_set {
691 struct kmem_cache *bio_slab;
692 unsigned int front_pad;
693
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400694 mempool_t bio_pool;
695 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700696#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400697 mempool_t bio_integrity_pool;
698 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700699#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700700
701 /*
702 * Deadlock avoidance for stacking block drivers: see comments in
703 * bio_alloc_bioset() for details
704 */
705 spinlock_t rescue_lock;
706 struct bio_list rescue_list;
707 struct work_struct rescue_work;
708 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700709};
710
711struct biovec_slab {
712 int nr_vecs;
713 char *name;
714 struct kmem_cache *slab;
715};
716
Kent Overstreet338aa962018-05-20 18:25:47 -0400717static inline bool bioset_initialized(struct bio_set *bs)
718{
719 return bs->bio_slab != NULL;
720}
721
Kent Overstreet57fb2332012-08-24 04:56:11 -0700722/*
723 * a small number of entries is fine, not going to be performance critical.
724 * basically we just need to survive
725 */
726#define BIO_SPLIT_ENTRIES 2
727
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200728#if defined(CONFIG_BLK_DEV_INTEGRITY)
729
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800730#define bip_for_each_vec(bvl, bip, iter) \
731 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200732
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200733#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
734 for_each_bio(_bio) \
735 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
736
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200737extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200738extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700739extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200740extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700741extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700742extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200743extern int bioset_integrity_create(struct bio_set *, int);
744extern void bioset_integrity_free(struct bio_set *);
745extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200746
747#else /* CONFIG_BLK_DEV_INTEGRITY */
748
Martin K. Petersenc6115292014-09-26 19:20:08 -0400749static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100750{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400751 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100752}
753
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100754static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
755{
756 return 0;
757}
758
759static inline void bioset_integrity_free (struct bio_set *bs)
760{
761 return;
762}
763
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700764static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100765{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700766 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100767}
768
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100769static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700770 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100771{
772 return 0;
773}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100774
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100775static inline void bio_integrity_advance(struct bio *bio,
776 unsigned int bytes_done)
777{
778 return;
779}
780
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700781static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100782{
783 return;
784}
785
786static inline void bio_integrity_init(void)
787{
788 return;
789}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200790
Martin K. Petersenc6115292014-09-26 19:20:08 -0400791static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
792{
793 return false;
794}
795
Keith Busch06c1e392015-12-03 09:32:21 -0700796static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
797 unsigned int nr)
798{
799 return ERR_PTR(-EINVAL);
800}
801
802static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
803 unsigned int len, unsigned int offset)
804{
805 return 0;
806}
807
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200808#endif /* CONFIG_BLK_DEV_INTEGRITY */
809
Jens Axboe0bbb2802018-12-21 09:10:46 -0700810/*
811 * Mark a bio as polled. Note that for async polled IO, the caller must
812 * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
813 * We cannot block waiting for requests on polled IO, as those completions
814 * must be found by the caller. This is different than IRQ driven IO, where
815 * it's safe to wait for IO to complete.
816 */
817static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
818{
819 bio->bi_opf |= REQ_HIPRI;
820 if (!is_sync_kiocb(kiocb))
821 bio->bi_opf |= REQ_NOWAIT;
822}
823
David Howells02a5e0a2007-08-11 22:34:32 +0200824#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825#endif /* __LINUX_BIO_H */