blob: 58f02ec899fc01f0ee2d1f991256c3faeb6cbf8e [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>
Paul Gortmaker187f1882011-11-23 20:12:59 -050024#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
David Howells02a5e0a2007-08-11 22:34:32 +020026#ifdef CONFIG_BLOCK
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <asm/io.h>
29
Tejun Heo7cc01582010-08-03 13:14:58 +020030/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
31#include <linux/blk_types.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define BIO_DEBUG
34
35#ifdef BIO_DEBUG
36#define BIO_BUG_ON BUG_ON
37#else
38#define BIO_BUG_ON
39#endif
40
Huang Ying225311a2017-09-06 16:22:30 -070041#ifdef CONFIG_THP_SWAP
42#if HPAGE_PMD_NR > 256
43#define BIO_MAX_PAGES HPAGE_PMD_NR
44#else
Alexey Dobriyand84a8472006-06-25 05:49:32 -070045#define BIO_MAX_PAGES 256
Huang Ying225311a2017-09-06 16:22:30 -070046#endif
47#else
48#define BIO_MAX_PAGES 256
49#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Mike Christie43b62ce2016-06-05 14:32:20 -050051#define bio_prio(bio) (bio)->bi_ioprio
52#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020053
Kent Overstreet4550dd62013-08-07 14:26:21 -070054#define bio_iter_iovec(bio, iter) \
55 bvec_iter_bvec((bio)->bi_io_vec, (iter))
56
57#define bio_iter_page(bio, iter) \
58 bvec_iter_page((bio)->bi_io_vec, (iter))
59#define bio_iter_len(bio, iter) \
60 bvec_iter_len((bio)->bi_io_vec, (iter))
61#define bio_iter_offset(bio, iter) \
62 bvec_iter_offset((bio)->bi_io_vec, (iter))
63
64#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
65#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
66#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080067
Kent Overstreet458b76e2013-09-24 16:26:05 -070068#define bio_multiple_segments(bio) \
69 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet38a72da2018-05-08 21:33:53 -040070
71#define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
72#define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
73
74#define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter)
75#define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter)
Zhen Kongee7bdc62019-03-14 10:55:19 -070076#define bio_dun(bio) ((bio)->bi_iter.bi_dun)
77#define bio_duns(bio) (bio_sectors(bio) >> 3) /* 4KB unit */
78#define bio_end_dun(bio) (bio_dun(bio) + bio_duns(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +020079
Kent Overstreet458b76e2013-09-24 16:26:05 -070080/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060081 * Return the data direction, READ or WRITE.
82 */
83#define bio_data_dir(bio) \
84 (op_is_write(bio_op(bio)) ? WRITE : READ)
85
86/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070087 * Check whether this bio carries any data or not. A NULL bio is allowed.
88 */
89static inline bool bio_has_data(struct bio *bio)
90{
91 if (bio &&
92 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030093 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080094 bio_op(bio) != REQ_OP_SECURE_ERASE &&
95 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070096 return true;
97
98 return false;
99}
100
Mike Christie95fe6c12016-06-05 14:31:48 -0500101static inline bool bio_no_advance_iter(struct bio *bio)
102{
Adrian Hunter7afafc82016-08-16 10:59:35 +0300103 return bio_op(bio) == REQ_OP_DISCARD ||
104 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800105 bio_op(bio) == REQ_OP_WRITE_SAME ||
106 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -0500107}
108
Kent Overstreet458b76e2013-09-24 16:26:05 -0700109static inline bool bio_mergeable(struct bio *bio)
110{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600111 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700112 return false;
113
114 return true;
115}
116
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900117static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200118{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700119 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700120 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100121 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700122 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200123}
124
125static inline void *bio_data(struct bio *bio)
126{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700127 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200128 return page_address(bio_page(bio)) + bio_offset(bio);
129
130 return NULL;
131}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700133static inline bool bio_full(struct bio *bio)
134{
135 return bio->bi_vcnt >= bio->bi_max_vecs;
136}
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138/*
139 * will die
140 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
142
143/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 * merge helpers etc
145 */
146
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100147/* Default implementation of BIOVEC_PHYS_MERGEABLE */
148#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
149 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/*
152 * allow arch override, for eg virtualized architectures (put in asm/io.h)
153 */
154#ifndef BIOVEC_PHYS_MERGEABLE
155#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100156 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#endif
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
160 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
161#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400162 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Jens Axboe66cb45a2014-06-24 16:22:24 -0600164/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800165 * drivers should _never_ use the all version - the bio may have been split
166 * before it got to the driver and the driver won't own all of it
167 */
168#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700169 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800170
Kent Overstreet4550dd62013-08-07 14:26:21 -0700171static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
172 unsigned bytes)
173{
174 iter->bi_sector += bytes >> 9;
175
Zhen Kongee7bdc62019-03-14 10:55:19 -0700176#ifdef CONFIG_PFK
177 if (iter->bi_dun)
178 iter->bi_dun += bytes >> 12;
179#endif
180
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700181 if (bio_no_advance_iter(bio)) {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700182 iter->bi_size -= bytes;
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700183 iter->bi_done += bytes;
184 } else {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700185 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700186 /* TODO: It is reasonable to complete bio with error here. */
187 }
Kent Overstreet4550dd62013-08-07 14:26:21 -0700188}
189
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700190static inline bool bio_rewind_iter(struct bio *bio, struct bvec_iter *iter,
191 unsigned int bytes)
192{
193 iter->bi_sector -= bytes >> 9;
194
195 if (bio_no_advance_iter(bio)) {
196 iter->bi_size += bytes;
197 iter->bi_done -= bytes;
198 return true;
199 }
200
201 return bvec_iter_rewind(bio->bi_io_vec, iter, bytes);
202}
203
Kent Overstreet79886132013-11-23 17:19:00 -0800204#define __bio_for_each_segment(bvl, bio, iter, start) \
205 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700206 (iter).bi_size && \
207 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
208 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800209
210#define bio_for_each_segment(bvl, bio, iter) \
211 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
212
Kent Overstreet4550dd62013-08-07 14:26:21 -0700213#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Shaohua Lif4595872017-03-24 10:34:43 -0700215static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700216{
217 unsigned segs = 0;
218 struct bio_vec bv;
219 struct bvec_iter iter;
220
Kent Overstreet8423ae32014-02-10 17:45:50 -0800221 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800222 * We special case discard/write same/write zeroes, because they
223 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800224 */
225
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800226 switch (bio_op(bio)) {
227 case REQ_OP_DISCARD:
228 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800229 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700230 return 0;
231 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800232 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800233 default:
234 break;
235 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800236
Shaohua Lif4595872017-03-24 10:34:43 -0700237 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700238 segs++;
239
240 return segs;
241}
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/*
244 * get a reference to a bio, so it won't disappear. the intended use is
245 * something like:
246 *
247 * bio_get(bio);
248 * submit_bio(rw, bio);
249 * if (bio->bi_flags ...)
250 * do_something
251 * bio_put(bio);
252 *
253 * without the bio_get(), it could potentially complete I/O before submit_bio
254 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
255 * runs
256 */
Jens Axboedac56212015-04-17 16:23:59 -0600257static inline void bio_get(struct bio *bio)
258{
259 bio->bi_flags |= (1 << BIO_REFFED);
260 smp_mb__before_atomic();
261 atomic_inc(&bio->__bi_cnt);
262}
263
264static inline void bio_cnt_set(struct bio *bio, unsigned int count)
265{
266 if (count != 1) {
267 bio->bi_flags |= (1 << BIO_REFFED);
268 smp_mb__before_atomic();
269 }
270 atomic_set(&bio->__bi_cnt, count);
271}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600273static inline bool bio_flagged(struct bio *bio, unsigned int bit)
274{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600275 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600276}
277
278static inline void bio_set_flag(struct bio *bio, unsigned int bit)
279{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600280 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600281}
282
283static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
284{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600285 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600286}
287
Ming Lei7bcd79a2016-02-26 23:40:50 +0800288static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
289{
290 *bv = bio_iovec(bio);
291}
292
293static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
294{
295 struct bvec_iter iter = bio->bi_iter;
296 int idx;
297
Ming Lei7bcd79a2016-02-26 23:40:50 +0800298 if (unlikely(!bio_multiple_segments(bio))) {
299 *bv = bio_iovec(bio);
300 return;
301 }
302
303 bio_advance_iter(bio, &iter, iter.bi_size);
304
305 if (!iter.bi_bvec_done)
306 idx = iter.bi_idx - 1;
307 else /* in the middle of bvec */
308 idx = iter.bi_idx;
309
310 *bv = bio->bi_io_vec[idx];
311
312 /*
313 * iter.bi_bvec_done records actual length of the last bvec
314 * if this bio ends in the middle of one io vector
315 */
316 if (iter.bi_bvec_done)
317 bv->bv_len = iter.bi_bvec_done;
318}
319
Ming Lei86292ab2017-12-18 20:22:03 +0800320static inline unsigned bio_pages_all(struct bio *bio)
321{
322 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
323 return bio->bi_vcnt;
324}
325
326static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
327{
328 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
329 return bio->bi_io_vec;
330}
331
332static inline struct page *bio_first_page_all(struct bio *bio)
333{
334 return bio_first_bvec_all(bio)->bv_page;
335}
336
337static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
338{
339 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
340 return &bio->bi_io_vec[bio->bi_vcnt - 1];
341}
342
Martin K. Petersenc6115292014-09-26 19:20:08 -0400343enum bip_flags {
344 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
345 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
346 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
347 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
348 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
349};
350
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200351/*
352 * bio integrity payload
353 */
354struct bio_integrity_payload {
355 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200356
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800357 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200358
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200359 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200360 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600361 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400362 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200363
364 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700365
366 struct bio_vec *bip_vec;
367 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200368};
Martin K. Petersen18593082014-09-26 19:20:01 -0400369
Keith Busch06c1e392015-12-03 09:32:21 -0700370#if defined(CONFIG_BLK_DEV_INTEGRITY)
371
372static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
373{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600374 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700375 return bio->bi_integrity;
376
377 return NULL;
378}
379
Martin K. Petersenc6115292014-09-26 19:20:08 -0400380static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
381{
382 struct bio_integrity_payload *bip = bio_integrity(bio);
383
384 if (bip)
385 return bip->bip_flags & flag;
386
387 return false;
388}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400389
Martin K. Petersen18593082014-09-26 19:20:01 -0400390static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
391{
392 return bip->bip_iter.bi_sector;
393}
394
395static inline void bip_set_seed(struct bio_integrity_payload *bip,
396 sector_t seed)
397{
398 bip->bip_iter.bi_sector = seed;
399}
400
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200401#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Kent Overstreet6678d832013-08-07 11:14:32 -0700403extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800404extern struct bio *bio_split(struct bio *bio, int sectors,
405 gfp_t gfp, struct bio_set *bs);
406
407/**
408 * bio_next_split - get next @sectors from a bio, splitting if necessary
409 * @bio: bio to split
410 * @sectors: number of sectors to split from the front of @bio
411 * @gfp: gfp mask
412 * @bs: bio set to allocate from
413 *
414 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
415 * than @sectors, returns the original bio unchanged.
416 */
417static inline struct bio *bio_next_split(struct bio *bio, int sectors,
418 gfp_t gfp, struct bio_set *bs)
419{
420 if (sectors >= bio_sectors(bio))
421 return bio;
422
423 return bio_split(bio, sectors, gfp, bs);
424}
425
NeilBrown011067b2017-06-18 14:38:57 +1000426enum {
427 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000428 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000429};
Kent Overstreetdad08522018-05-20 18:25:58 -0400430extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
431extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400432extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600433extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300435extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Kent Overstreet59d276f2013-11-23 18:19:27 -0800438extern void __bio_clone_fast(struct bio *, struct bio *);
439extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700440
Kent Overstreetf4f81542018-05-08 21:33:52 -0400441extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700442
443static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
444{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400445 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700446}
447
448static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
449{
450 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
451}
452
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600453extern blk_qc_t submit_bio(struct bio *);
454
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200455extern void bio_endio(struct bio *);
456
457static inline void bio_io_error(struct bio *bio)
458{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200459 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200460 bio_endio(bio);
461}
462
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500463static inline void bio_wouldblock_error(struct bio *bio)
464{
465 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700466 bio_endio(bio);
467}
NeilBrown6712ecf2007-09-27 12:47:43 +0200468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469struct request_queue;
470extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Mike Christie4e49ea42016-06-05 14:31:41 -0500472extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700473extern void bio_advance(struct bio *, unsigned);
474
Ming Lei3a83f462016-11-22 08:57:21 -0700475extern void bio_init(struct bio *bio, struct bio_vec *table,
476 unsigned short max_vecs);
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600477extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700478extern void bio_reset(struct bio *);
Kent Overstreet196d38b2013-11-23 18:34:15 -0800479void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600482extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
483 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700484bool __bio_try_merge_page(struct bio *bio, struct page *page,
485 unsigned int len, unsigned int off);
486void __bio_add_page(struct bio *bio, struct page *page,
487 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600488int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900489struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200490extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400491 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200493extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400494 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200495extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
496 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497extern void bio_set_pages_dirty(struct bio *bio);
498extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100499
Michael Callahanddcf35d2018-07-18 04:47:39 -0700500void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600501 unsigned long sectors, struct hd_struct *part);
Michael Callahanddcf35d2018-07-18 04:47:39 -0700502void generic_end_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600503 struct hd_struct *part,
504 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800505
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100506#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
507# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
508#endif
509#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
510extern void bio_flush_dcache_pages(struct bio *bi);
511#else
512static inline void bio_flush_dcache_pages(struct bio *bi)
513{
514}
515#endif
516
Kent Overstreet45db54d2018-05-08 21:33:54 -0400517extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
518 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700519extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400520extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400521extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700522
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900523extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500524 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400525 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100526 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527extern int bio_uncopy_user(struct bio *);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400528void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
529
530static inline void zero_fill_bio(struct bio *bio)
531{
532 zero_fill_bio_iter(bio, bio->bi_iter);
533}
534
Kent Overstreet9f060e22012-10-12 15:29:33 -0700535extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
536extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200537extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800538extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200539
Christoph Hellwig74d46992017-08-23 19:10:32 +0200540#define bio_set_dev(bio, bdev) \
541do { \
Shaohua Li111be882017-12-20 11:10:17 -0700542 if ((bio)->bi_disk != (bdev)->bd_disk) \
543 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200544 (bio)->bi_disk = (bdev)->bd_disk; \
545 (bio)->bi_partno = (bdev)->bd_partno; \
546} while (0)
547
548#define bio_copy_dev(dst, src) \
549do { \
550 (dst)->bi_disk = (src)->bi_disk; \
551 (dst)->bi_partno = (src)->bi_partno; \
552} while (0)
553
554#define bio_dev(bio) \
555 disk_devt((bio)->bi_disk)
556
Tejun Heo0d3bd882018-07-03 11:14:54 -0400557#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
558int bio_associate_blkcg_from_page(struct bio *bio, struct page *page);
559#else
560static inline int bio_associate_blkcg_from_page(struct bio *bio,
561 struct page *page) { return 0; }
562#endif
563
Tejun Heo852c7882012-03-05 13:15:27 -0800564#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400565int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Josef Bacik08e18ea2018-07-03 11:14:50 -0400566int bio_associate_blkg(struct bio *bio, struct blkcg_gq *blkg);
Tejun Heo852c7882012-03-05 13:15:27 -0800567void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200568void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800569#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400570static inline int bio_associate_blkcg(struct bio *bio,
571 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800572static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200573static inline void bio_clone_blkcg_association(struct bio *dst,
574 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800575#endif /* CONFIG_BLK_CGROUP */
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577#ifdef CONFIG_HIGHMEM
578/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100579 * remember never ever reenable interrupts between a bvec_kmap_irq and
580 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100582static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
584 unsigned long addr;
585
586 /*
587 * might not be a highmem page, but the preempt/irq count
588 * balancing is a lot nicer this way
589 */
590 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800591 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
593 BUG_ON(addr & ~PAGE_MASK);
594
595 return (char *) addr + bvec->bv_offset;
596}
597
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100598static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599{
600 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
601
Cong Wange8e3c3d2011-11-25 23:14:27 +0800602 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 local_irq_restore(*flags);
604}
605
606#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200607static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
608{
609 return page_address(bvec->bv_page) + bvec->bv_offset;
610}
611
612static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
613{
614 *flags = 0;
615}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616#endif
617
Jens Axboe7a67f632008-08-08 11:17:12 +0200618/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200619 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200620 *
621 * A bio_list anchors a singly-linked list of bios chained through the bi_next
622 * member of the bio. The bio_list also caches the last list member to allow
623 * fast access to the tail.
624 */
625struct bio_list {
626 struct bio *head;
627 struct bio *tail;
628};
629
630static inline int bio_list_empty(const struct bio_list *bl)
631{
632 return bl->head == NULL;
633}
634
635static inline void bio_list_init(struct bio_list *bl)
636{
637 bl->head = bl->tail = NULL;
638}
639
Jens Axboe320ae512013-10-24 09:20:05 +0100640#define BIO_EMPTY_LIST { NULL, NULL }
641
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200642#define bio_list_for_each(bio, bl) \
643 for (bio = (bl)->head; bio; bio = bio->bi_next)
644
645static inline unsigned bio_list_size(const struct bio_list *bl)
646{
647 unsigned sz = 0;
648 struct bio *bio;
649
650 bio_list_for_each(bio, bl)
651 sz++;
652
653 return sz;
654}
655
656static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
657{
658 bio->bi_next = NULL;
659
660 if (bl->tail)
661 bl->tail->bi_next = bio;
662 else
663 bl->head = bio;
664
665 bl->tail = bio;
666}
667
668static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
669{
670 bio->bi_next = bl->head;
671
672 bl->head = bio;
673
674 if (!bl->tail)
675 bl->tail = bio;
676}
677
678static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
679{
680 if (!bl2->head)
681 return;
682
683 if (bl->tail)
684 bl->tail->bi_next = bl2->head;
685 else
686 bl->head = bl2->head;
687
688 bl->tail = bl2->tail;
689}
690
691static inline void bio_list_merge_head(struct bio_list *bl,
692 struct bio_list *bl2)
693{
694 if (!bl2->head)
695 return;
696
697 if (bl->head)
698 bl2->tail->bi_next = bl->head;
699 else
700 bl->tail = bl2->tail;
701
702 bl->head = bl2->head;
703}
704
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000705static inline struct bio *bio_list_peek(struct bio_list *bl)
706{
707 return bl->head;
708}
709
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200710static inline struct bio *bio_list_pop(struct bio_list *bl)
711{
712 struct bio *bio = bl->head;
713
714 if (bio) {
715 bl->head = bl->head->bi_next;
716 if (!bl->head)
717 bl->tail = NULL;
718
719 bio->bi_next = NULL;
720 }
721
722 return bio;
723}
724
725static inline struct bio *bio_list_get(struct bio_list *bl)
726{
727 struct bio *bio = bl->head;
728
729 bl->head = bl->tail = NULL;
730
731 return bio;
732}
733
Kent Overstreet57fb2332012-08-24 04:56:11 -0700734/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400735 * Increment chain count for the bio. Make sure the CHAIN flag update
736 * is visible before the raised count.
737 */
738static inline void bio_inc_remaining(struct bio *bio)
739{
740 bio_set_flag(bio, BIO_CHAIN);
741 smp_mb__before_atomic();
742 atomic_inc(&bio->__bi_remaining);
743}
744
745/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700746 * bio_set is used to allow other portions of the IO system to
747 * allocate their own private memory pools for bio and iovec structures.
748 * These memory pools in turn all allocate from the bio_slab
749 * and the bvec_slabs[].
750 */
751#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700752
753struct bio_set {
754 struct kmem_cache *bio_slab;
755 unsigned int front_pad;
756
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400757 mempool_t bio_pool;
758 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700759#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400760 mempool_t bio_integrity_pool;
761 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700762#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700763
764 /*
765 * Deadlock avoidance for stacking block drivers: see comments in
766 * bio_alloc_bioset() for details
767 */
768 spinlock_t rescue_lock;
769 struct bio_list rescue_list;
770 struct work_struct rescue_work;
771 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700772};
773
774struct biovec_slab {
775 int nr_vecs;
776 char *name;
777 struct kmem_cache *slab;
778};
779
Kent Overstreet338aa962018-05-20 18:25:47 -0400780static inline bool bioset_initialized(struct bio_set *bs)
781{
782 return bs->bio_slab != NULL;
783}
784
Kent Overstreet57fb2332012-08-24 04:56:11 -0700785/*
786 * a small number of entries is fine, not going to be performance critical.
787 * basically we just need to survive
788 */
789#define BIO_SPLIT_ENTRIES 2
790
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200791#if defined(CONFIG_BLK_DEV_INTEGRITY)
792
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800793#define bip_for_each_vec(bvl, bip, iter) \
794 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200795
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200796#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
797 for_each_bio(_bio) \
798 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
799
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200800extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200801extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700802extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200803extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700804extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700805extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200806extern int bioset_integrity_create(struct bio_set *, int);
807extern void bioset_integrity_free(struct bio_set *);
808extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200809
810#else /* CONFIG_BLK_DEV_INTEGRITY */
811
Martin K. Petersenc6115292014-09-26 19:20:08 -0400812static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100813{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400814 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100815}
816
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100817static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
818{
819 return 0;
820}
821
822static inline void bioset_integrity_free (struct bio_set *bs)
823{
824 return;
825}
826
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700827static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100828{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700829 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100830}
831
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100832static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700833 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100834{
835 return 0;
836}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100837
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100838static inline void bio_integrity_advance(struct bio *bio,
839 unsigned int bytes_done)
840{
841 return;
842}
843
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700844static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100845{
846 return;
847}
848
849static inline void bio_integrity_init(void)
850{
851 return;
852}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200853
Martin K. Petersenc6115292014-09-26 19:20:08 -0400854static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
855{
856 return false;
857}
858
Keith Busch06c1e392015-12-03 09:32:21 -0700859static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
860 unsigned int nr)
861{
862 return ERR_PTR(-EINVAL);
863}
864
865static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
866 unsigned int len, unsigned int offset)
867{
868 return 0;
869}
870
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200871#endif /* CONFIG_BLK_DEV_INTEGRITY */
872
David Howells02a5e0a2007-08-11 22:34:32 +0200873#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874#endif /* __LINUX_BIO_H */