blob: bb6090aa165d362ae399194fdca8d58b7cb8f5bf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tejun Heo7cc01582010-08-03 13:14:58 +020010 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public Licens
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
17 */
18#ifndef __LINUX_BIO_H
19#define __LINUX_BIO_H
20
21#include <linux/highmem.h>
22#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020023#include <linux/ioprio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
David Howells02a5e0a2007-08-11 22:34:32 +020025#ifdef CONFIG_BLOCK
Tejun Heo7cc01582010-08-03 13:14:58 +020026/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
27#include <linux/blk_types.h>
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define BIO_DEBUG
30
31#ifdef BIO_DEBUG
32#define BIO_BUG_ON BUG_ON
33#else
34#define BIO_BUG_ON
35#endif
36
Alexey Dobriyand84a8472006-06-25 05:49:32 -070037#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Mike Christie43b62ce2016-06-05 14:32:20 -050039#define bio_prio(bio) (bio)->bi_ioprio
40#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020041
Kent Overstreet4550dd62013-08-07 14:26:21 -070042#define bio_iter_iovec(bio, iter) \
43 bvec_iter_bvec((bio)->bi_io_vec, (iter))
44
45#define bio_iter_page(bio, iter) \
46 bvec_iter_page((bio)->bi_io_vec, (iter))
47#define bio_iter_len(bio, iter) \
48 bvec_iter_len((bio)->bi_io_vec, (iter))
49#define bio_iter_offset(bio, iter) \
50 bvec_iter_offset((bio)->bi_io_vec, (iter))
51
52#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
53#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
54#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080055
Kent Overstreet458b76e2013-09-24 16:26:05 -070056#define bio_multiple_segments(bio) \
57 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet38a72da2018-05-08 21:33:53 -040058
59#define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
60#define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
61
62#define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter)
63#define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter)
Jens Axboebf2de6f2007-09-27 13:01:25 +020064
Kent Overstreet458b76e2013-09-24 16:26:05 -070065/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060066 * Return the data direction, READ or WRITE.
67 */
68#define bio_data_dir(bio) \
69 (op_is_write(bio_op(bio)) ? WRITE : READ)
70
71/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070072 * Check whether this bio carries any data or not. A NULL bio is allowed.
73 */
74static inline bool bio_has_data(struct bio *bio)
75{
76 if (bio &&
77 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030078 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080079 bio_op(bio) != REQ_OP_SECURE_ERASE &&
80 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070081 return true;
82
83 return false;
84}
85
Mike Christie95fe6c12016-06-05 14:31:48 -050086static inline bool bio_no_advance_iter(struct bio *bio)
87{
Adrian Hunter7afafc82016-08-16 10:59:35 +030088 return bio_op(bio) == REQ_OP_DISCARD ||
89 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080090 bio_op(bio) == REQ_OP_WRITE_SAME ||
91 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -050092}
93
Kent Overstreet458b76e2013-09-24 16:26:05 -070094static inline bool bio_mergeable(struct bio *bio)
95{
Jens Axboe1eff9d32016-08-05 15:35:16 -060096 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -070097 return false;
98
99 return true;
100}
101
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900102static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200103{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700104 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700105 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100106 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700107 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200108}
109
110static inline void *bio_data(struct bio *bio)
111{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700112 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200113 return page_address(bio_page(bio)) + bio_offset(bio);
114
115 return NULL;
116}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700118static inline bool bio_full(struct bio *bio)
119{
120 return bio->bi_vcnt >= bio->bi_max_vecs;
121}
122
Ming Lei6dc4f102019-02-15 19:13:19 +0800123#define mp_bvec_for_each_segment(bv, bvl, i, iter_all) \
124 for (bv = bvec_init_iter_all(&iter_all); \
125 (iter_all.done < (bvl)->bv_len) && \
126 (mp_bvec_next_segment((bvl), &iter_all), 1); \
127 iter_all.done += bv->bv_len, i += 1)
128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800130 * drivers should _never_ use the all version - the bio may have been split
131 * before it got to the driver and the driver won't own all of it
132 */
Ming Lei6dc4f102019-02-15 19:13:19 +0800133#define bio_for_each_segment_all(bvl, bio, i, iter_all) \
134 for (i = 0, iter_all.idx = 0; iter_all.idx < (bio)->bi_vcnt; iter_all.idx++) \
135 mp_bvec_for_each_segment(bvl, &((bio)->bi_io_vec[iter_all.idx]), i, iter_all)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800136
Kent Overstreet4550dd62013-08-07 14:26:21 -0700137static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
138 unsigned bytes)
139{
140 iter->bi_sector += bytes >> 9;
141
Ming Lei7759eb22018-09-05 15:45:54 -0600142 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700143 iter->bi_size -= bytes;
Ming Lei7759eb22018-09-05 15:45:54 -0600144 else
Kent Overstreet4550dd62013-08-07 14:26:21 -0700145 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700146 /* TODO: It is reasonable to complete bio with error here. */
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700147}
148
Kent Overstreet79886132013-11-23 17:19:00 -0800149#define __bio_for_each_segment(bvl, bio, iter, start) \
150 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700151 (iter).bi_size && \
152 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
153 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800154
155#define bio_for_each_segment(bvl, bio, iter) \
156 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
157
Ming Leid18d9172019-02-15 19:13:11 +0800158#define __bio_for_each_bvec(bvl, bio, iter, start) \
159 for (iter = (start); \
160 (iter).bi_size && \
161 ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \
162 bio_advance_iter((bio), &(iter), (bvl).bv_len))
163
164/* iterate over multi-page bvec */
165#define bio_for_each_bvec(bvl, bio, iter) \
166 __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter)
167
Kent Overstreet4550dd62013-08-07 14:26:21 -0700168#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Shaohua Lif4595872017-03-24 10:34:43 -0700170static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700171{
172 unsigned segs = 0;
173 struct bio_vec bv;
174 struct bvec_iter iter;
175
Kent Overstreet8423ae32014-02-10 17:45:50 -0800176 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800177 * We special case discard/write same/write zeroes, because they
178 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800179 */
180
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800181 switch (bio_op(bio)) {
182 case REQ_OP_DISCARD:
183 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800184 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700185 return 0;
186 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800187 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800188 default:
189 break;
190 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800191
Shaohua Lif4595872017-03-24 10:34:43 -0700192 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700193 segs++;
194
195 return segs;
196}
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198/*
199 * get a reference to a bio, so it won't disappear. the intended use is
200 * something like:
201 *
202 * bio_get(bio);
203 * submit_bio(rw, bio);
204 * if (bio->bi_flags ...)
205 * do_something
206 * bio_put(bio);
207 *
208 * without the bio_get(), it could potentially complete I/O before submit_bio
209 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
210 * runs
211 */
Jens Axboedac56212015-04-17 16:23:59 -0600212static inline void bio_get(struct bio *bio)
213{
214 bio->bi_flags |= (1 << BIO_REFFED);
215 smp_mb__before_atomic();
216 atomic_inc(&bio->__bi_cnt);
217}
218
219static inline void bio_cnt_set(struct bio *bio, unsigned int count)
220{
221 if (count != 1) {
222 bio->bi_flags |= (1 << BIO_REFFED);
223 smp_mb__before_atomic();
224 }
225 atomic_set(&bio->__bi_cnt, count);
226}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600228static inline bool bio_flagged(struct bio *bio, unsigned int bit)
229{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600230 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600231}
232
233static inline void bio_set_flag(struct bio *bio, unsigned int bit)
234{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600235 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600236}
237
238static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
239{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600240 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600241}
242
Ming Lei7bcd79a2016-02-26 23:40:50 +0800243static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
244{
245 *bv = bio_iovec(bio);
246}
247
248static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
249{
250 struct bvec_iter iter = bio->bi_iter;
251 int idx;
252
Ming Lei7bcd79a2016-02-26 23:40:50 +0800253 if (unlikely(!bio_multiple_segments(bio))) {
254 *bv = bio_iovec(bio);
255 return;
256 }
257
258 bio_advance_iter(bio, &iter, iter.bi_size);
259
260 if (!iter.bi_bvec_done)
261 idx = iter.bi_idx - 1;
262 else /* in the middle of bvec */
263 idx = iter.bi_idx;
264
265 *bv = bio->bi_io_vec[idx];
266
267 /*
268 * iter.bi_bvec_done records actual length of the last bvec
269 * if this bio ends in the middle of one io vector
270 */
271 if (iter.bi_bvec_done)
272 bv->bv_len = iter.bi_bvec_done;
273}
274
Ming Lei86292ab2017-12-18 20:22:03 +0800275static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
276{
277 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
278 return bio->bi_io_vec;
279}
280
281static inline struct page *bio_first_page_all(struct bio *bio)
282{
283 return bio_first_bvec_all(bio)->bv_page;
284}
285
286static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
287{
288 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
289 return &bio->bi_io_vec[bio->bi_vcnt - 1];
290}
291
Martin K. Petersenc6115292014-09-26 19:20:08 -0400292enum bip_flags {
293 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
294 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
295 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
296 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
297 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
298};
299
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200300/*
301 * bio integrity payload
302 */
303struct bio_integrity_payload {
304 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800306 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200307
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200308 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600310 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400311 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200312
Ming Lei7759eb22018-09-05 15:45:54 -0600313 struct bvec_iter bio_iter; /* for rewinding parent bio */
314
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200315 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700316
317 struct bio_vec *bip_vec;
318 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200319};
Martin K. Petersen18593082014-09-26 19:20:01 -0400320
Keith Busch06c1e392015-12-03 09:32:21 -0700321#if defined(CONFIG_BLK_DEV_INTEGRITY)
322
323static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
324{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600325 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700326 return bio->bi_integrity;
327
328 return NULL;
329}
330
Martin K. Petersenc6115292014-09-26 19:20:08 -0400331static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
332{
333 struct bio_integrity_payload *bip = bio_integrity(bio);
334
335 if (bip)
336 return bip->bip_flags & flag;
337
338 return false;
339}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400340
Martin K. Petersen18593082014-09-26 19:20:01 -0400341static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
342{
343 return bip->bip_iter.bi_sector;
344}
345
346static inline void bip_set_seed(struct bio_integrity_payload *bip,
347 sector_t seed)
348{
349 bip->bip_iter.bi_sector = seed;
350}
351
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200352#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Kent Overstreet6678d832013-08-07 11:14:32 -0700354extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800355extern struct bio *bio_split(struct bio *bio, int sectors,
356 gfp_t gfp, struct bio_set *bs);
357
358/**
359 * bio_next_split - get next @sectors from a bio, splitting if necessary
360 * @bio: bio to split
361 * @sectors: number of sectors to split from the front of @bio
362 * @gfp: gfp mask
363 * @bs: bio set to allocate from
364 *
365 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
366 * than @sectors, returns the original bio unchanged.
367 */
368static inline struct bio *bio_next_split(struct bio *bio, int sectors,
369 gfp_t gfp, struct bio_set *bs)
370{
371 if (sectors >= bio_sectors(bio))
372 return bio;
373
374 return bio_split(bio, sectors, gfp, bs);
375}
376
NeilBrown011067b2017-06-18 14:38:57 +1000377enum {
378 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000379 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000380};
Kent Overstreetdad08522018-05-20 18:25:58 -0400381extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
382extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400383extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600384extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300386extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Kent Overstreet59d276f2013-11-23 18:19:27 -0800389extern void __bio_clone_fast(struct bio *, struct bio *);
390extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700391
Kent Overstreetf4f81542018-05-08 21:33:52 -0400392extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700393
394static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
395{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400396 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700397}
398
399static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
400{
401 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
402}
403
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600404extern blk_qc_t submit_bio(struct bio *);
405
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200406extern void bio_endio(struct bio *);
407
408static inline void bio_io_error(struct bio *bio)
409{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200410 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200411 bio_endio(bio);
412}
413
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500414static inline void bio_wouldblock_error(struct bio *bio)
415{
416 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700417 bio_endio(bio);
418}
NeilBrown6712ecf2007-09-27 12:47:43 +0200419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420struct request_queue;
421extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Mike Christie4e49ea42016-06-05 14:31:41 -0500423extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700424extern void bio_advance(struct bio *, unsigned);
425
Ming Lei3a83f462016-11-22 08:57:21 -0700426extern void bio_init(struct bio *bio, struct bio_vec *table,
427 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600428extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700429extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800430void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600433extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
434 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700435bool __bio_try_merge_page(struct bio *bio, struct page *page,
Ming Lei07173c32019-02-15 19:13:20 +0800436 unsigned int len, unsigned int off, bool same_page);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700437void __bio_add_page(struct bio *bio, struct page *page,
438 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600439int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900440struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200441extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400442 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200444extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400445 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200446extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
447 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448extern void bio_set_pages_dirty(struct bio *bio);
449extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100450
Michael Callahanddcf35d2018-07-18 04:47:39 -0700451void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600452 unsigned long sectors, struct hd_struct *part);
Michael Callahanddcf35d2018-07-18 04:47:39 -0700453void generic_end_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600454 struct hd_struct *part,
455 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800456
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100457#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
458# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
459#endif
460#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
461extern void bio_flush_dcache_pages(struct bio *bi);
462#else
463static inline void bio_flush_dcache_pages(struct bio *bi)
464{
465}
466#endif
467
Kent Overstreet45db54d2018-05-08 21:33:54 -0400468extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
469 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700470extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400471extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400472extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700473
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900474extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500475 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400476 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100477 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478extern int bio_uncopy_user(struct bio *);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400479void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
480
481static inline void zero_fill_bio(struct bio *bio)
482{
483 zero_fill_bio_iter(bio, bio->bi_iter);
484}
485
Kent Overstreet9f060e22012-10-12 15:29:33 -0700486extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
487extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200488extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800489extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200490
Christoph Hellwig74d46992017-08-23 19:10:32 +0200491#define bio_set_dev(bio, bdev) \
492do { \
Shaohua Li111be882017-12-20 11:10:17 -0700493 if ((bio)->bi_disk != (bdev)->bd_disk) \
494 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200495 (bio)->bi_disk = (bdev)->bd_disk; \
496 (bio)->bi_partno = (bdev)->bd_partno; \
Dennis Zhou5cdf2e32018-12-05 12:10:31 -0500497 bio_associate_blkg(bio); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200498} while (0)
499
500#define bio_copy_dev(dst, src) \
501do { \
502 (dst)->bi_disk = (src)->bi_disk; \
503 (dst)->bi_partno = (src)->bi_partno; \
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500504 bio_clone_blkg_association(dst, src); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200505} while (0)
506
507#define bio_dev(bio) \
508 disk_devt((bio)->bi_disk)
509
Tejun Heo0d3bd882018-07-03 11:14:54 -0400510#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500511void bio_associate_blkg_from_page(struct bio *bio, struct page *page);
Tejun Heo0d3bd882018-07-03 11:14:54 -0400512#else
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500513static inline void bio_associate_blkg_from_page(struct bio *bio,
514 struct page *page) { }
Tejun Heo0d3bd882018-07-03 11:14:54 -0400515#endif
516
Tejun Heo852c7882012-03-05 13:15:27 -0800517#ifdef CONFIG_BLK_CGROUP
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500518void bio_disassociate_blkg(struct bio *bio);
519void bio_associate_blkg(struct bio *bio);
Dennis Zhoufd42df32018-12-05 12:10:34 -0500520void bio_associate_blkg_from_css(struct bio *bio,
521 struct cgroup_subsys_state *css);
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500522void bio_clone_blkg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800523#else /* CONFIG_BLK_CGROUP */
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500524static inline void bio_disassociate_blkg(struct bio *bio) { }
525static inline void bio_associate_blkg(struct bio *bio) { }
Dennis Zhoufd42df32018-12-05 12:10:34 -0500526static inline void bio_associate_blkg_from_css(struct bio *bio,
527 struct cgroup_subsys_state *css)
528{ }
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500529static inline void bio_clone_blkg_association(struct bio *dst,
530 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800531#endif /* CONFIG_BLK_CGROUP */
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533#ifdef CONFIG_HIGHMEM
534/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100535 * remember never ever reenable interrupts between a bvec_kmap_irq and
536 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100538static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
540 unsigned long addr;
541
542 /*
543 * might not be a highmem page, but the preempt/irq count
544 * balancing is a lot nicer this way
545 */
546 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800547 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 BUG_ON(addr & ~PAGE_MASK);
550
551 return (char *) addr + bvec->bv_offset;
552}
553
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100554static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
556 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
557
Cong Wange8e3c3d2011-11-25 23:14:27 +0800558 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 local_irq_restore(*flags);
560}
561
562#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200563static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
564{
565 return page_address(bvec->bv_page) + bvec->bv_offset;
566}
567
568static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
569{
570 *flags = 0;
571}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572#endif
573
Jens Axboe7a67f632008-08-08 11:17:12 +0200574/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200575 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200576 *
577 * A bio_list anchors a singly-linked list of bios chained through the bi_next
578 * member of the bio. The bio_list also caches the last list member to allow
579 * fast access to the tail.
580 */
581struct bio_list {
582 struct bio *head;
583 struct bio *tail;
584};
585
586static inline int bio_list_empty(const struct bio_list *bl)
587{
588 return bl->head == NULL;
589}
590
591static inline void bio_list_init(struct bio_list *bl)
592{
593 bl->head = bl->tail = NULL;
594}
595
Jens Axboe320ae512013-10-24 09:20:05 +0100596#define BIO_EMPTY_LIST { NULL, NULL }
597
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200598#define bio_list_for_each(bio, bl) \
599 for (bio = (bl)->head; bio; bio = bio->bi_next)
600
601static inline unsigned bio_list_size(const struct bio_list *bl)
602{
603 unsigned sz = 0;
604 struct bio *bio;
605
606 bio_list_for_each(bio, bl)
607 sz++;
608
609 return sz;
610}
611
612static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
613{
614 bio->bi_next = NULL;
615
616 if (bl->tail)
617 bl->tail->bi_next = bio;
618 else
619 bl->head = bio;
620
621 bl->tail = bio;
622}
623
624static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
625{
626 bio->bi_next = bl->head;
627
628 bl->head = bio;
629
630 if (!bl->tail)
631 bl->tail = bio;
632}
633
634static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
635{
636 if (!bl2->head)
637 return;
638
639 if (bl->tail)
640 bl->tail->bi_next = bl2->head;
641 else
642 bl->head = bl2->head;
643
644 bl->tail = bl2->tail;
645}
646
647static inline void bio_list_merge_head(struct bio_list *bl,
648 struct bio_list *bl2)
649{
650 if (!bl2->head)
651 return;
652
653 if (bl->head)
654 bl2->tail->bi_next = bl->head;
655 else
656 bl->tail = bl2->tail;
657
658 bl->head = bl2->head;
659}
660
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000661static inline struct bio *bio_list_peek(struct bio_list *bl)
662{
663 return bl->head;
664}
665
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200666static inline struct bio *bio_list_pop(struct bio_list *bl)
667{
668 struct bio *bio = bl->head;
669
670 if (bio) {
671 bl->head = bl->head->bi_next;
672 if (!bl->head)
673 bl->tail = NULL;
674
675 bio->bi_next = NULL;
676 }
677
678 return bio;
679}
680
681static inline struct bio *bio_list_get(struct bio_list *bl)
682{
683 struct bio *bio = bl->head;
684
685 bl->head = bl->tail = NULL;
686
687 return bio;
688}
689
Kent Overstreet57fb2332012-08-24 04:56:11 -0700690/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400691 * Increment chain count for the bio. Make sure the CHAIN flag update
692 * is visible before the raised count.
693 */
694static inline void bio_inc_remaining(struct bio *bio)
695{
696 bio_set_flag(bio, BIO_CHAIN);
697 smp_mb__before_atomic();
698 atomic_inc(&bio->__bi_remaining);
699}
700
701/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700702 * bio_set is used to allow other portions of the IO system to
703 * allocate their own private memory pools for bio and iovec structures.
704 * These memory pools in turn all allocate from the bio_slab
705 * and the bvec_slabs[].
706 */
707#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700708
709struct bio_set {
710 struct kmem_cache *bio_slab;
711 unsigned int front_pad;
712
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400713 mempool_t bio_pool;
714 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700715#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400716 mempool_t bio_integrity_pool;
717 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700718#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700719
720 /*
721 * Deadlock avoidance for stacking block drivers: see comments in
722 * bio_alloc_bioset() for details
723 */
724 spinlock_t rescue_lock;
725 struct bio_list rescue_list;
726 struct work_struct rescue_work;
727 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700728};
729
730struct biovec_slab {
731 int nr_vecs;
732 char *name;
733 struct kmem_cache *slab;
734};
735
Kent Overstreet338aa962018-05-20 18:25:47 -0400736static inline bool bioset_initialized(struct bio_set *bs)
737{
738 return bs->bio_slab != NULL;
739}
740
Kent Overstreet57fb2332012-08-24 04:56:11 -0700741/*
742 * a small number of entries is fine, not going to be performance critical.
743 * basically we just need to survive
744 */
745#define BIO_SPLIT_ENTRIES 2
746
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200747#if defined(CONFIG_BLK_DEV_INTEGRITY)
748
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800749#define bip_for_each_vec(bvl, bip, iter) \
750 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200751
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200752#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
753 for_each_bio(_bio) \
754 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
755
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200756extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200757extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700758extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200759extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700760extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700761extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200762extern int bioset_integrity_create(struct bio_set *, int);
763extern void bioset_integrity_free(struct bio_set *);
764extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200765
766#else /* CONFIG_BLK_DEV_INTEGRITY */
767
Martin K. Petersenc6115292014-09-26 19:20:08 -0400768static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100769{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400770 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100771}
772
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100773static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
774{
775 return 0;
776}
777
778static inline void bioset_integrity_free (struct bio_set *bs)
779{
780 return;
781}
782
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700783static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100784{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700785 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100786}
787
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100788static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700789 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100790{
791 return 0;
792}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100793
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100794static inline void bio_integrity_advance(struct bio *bio,
795 unsigned int bytes_done)
796{
797 return;
798}
799
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700800static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100801{
802 return;
803}
804
805static inline void bio_integrity_init(void)
806{
807 return;
808}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200809
Martin K. Petersenc6115292014-09-26 19:20:08 -0400810static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
811{
812 return false;
813}
814
Keith Busch06c1e392015-12-03 09:32:21 -0700815static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
816 unsigned int nr)
817{
818 return ERR_PTR(-EINVAL);
819}
820
821static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
822 unsigned int len, unsigned int offset)
823{
824 return 0;
825}
826
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200827#endif /* CONFIG_BLK_DEV_INTEGRITY */
828
Jens Axboe0bbb2802018-12-21 09:10:46 -0700829/*
830 * Mark a bio as polled. Note that for async polled IO, the caller must
831 * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
832 * We cannot block waiting for requests on polled IO, as those completions
833 * must be found by the caller. This is different than IRQ driven IO, where
834 * it's safe to wait for IO to complete.
835 */
836static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
837{
838 bio->bi_opf |= REQ_HIPRI;
839 if (!is_sync_kiocb(kiocb))
840 bio->bi_opf |= REQ_NOWAIT;
841}
842
David Howells02a5e0a2007-08-11 22:34:32 +0200843#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844#endif /* __LINUX_BIO_H */