blob: 0f23b56826403b5dd2fdb781671fd696e6e0cb68 [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
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700105static inline bool bio_full(struct bio *bio)
106{
107 return bio->bi_vcnt >= bio->bi_max_vecs;
108}
109
Ming Lei1200e07f2019-04-08 19:02:38 +0800110static inline bool bio_next_segment(const struct bio *bio,
111 struct bvec_iter_all *iter)
112{
113 if (iter->idx >= bio->bi_vcnt)
114 return false;
115
116 bvec_advance(&bio->bi_io_vec[iter->idx], iter);
117 return true;
118}
Ming Lei6dc4f102019-02-15 19:13:19 +0800119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800121 * drivers should _never_ use the all version - the bio may have been split
122 * before it got to the driver and the driver won't own all of it
123 */
Christoph Hellwig2b070cf2019-04-25 09:03:00 +0200124#define bio_for_each_segment_all(bvl, bio, iter) \
125 for (bvl = bvec_init_iter_all(&iter); bio_next_segment((bio), &iter); )
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800126
Kent Overstreet4550dd62013-08-07 14:26:21 -0700127static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
128 unsigned bytes)
129{
130 iter->bi_sector += bytes >> 9;
131
Ming Lei7759eb22018-09-05 15:45:54 -0600132 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700133 iter->bi_size -= bytes;
Ming Lei7759eb22018-09-05 15:45:54 -0600134 else
Kent Overstreet4550dd62013-08-07 14:26:21 -0700135 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700136 /* TODO: It is reasonable to complete bio with error here. */
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700137}
138
Kent Overstreet79886132013-11-23 17:19:00 -0800139#define __bio_for_each_segment(bvl, bio, iter, start) \
140 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700141 (iter).bi_size && \
142 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
143 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800144
145#define bio_for_each_segment(bvl, bio, iter) \
146 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
147
Ming Leid18d9172019-02-15 19:13:11 +0800148#define __bio_for_each_bvec(bvl, bio, iter, start) \
149 for (iter = (start); \
150 (iter).bi_size && \
151 ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \
152 bio_advance_iter((bio), &(iter), (bvl).bv_len))
153
154/* iterate over multi-page bvec */
155#define bio_for_each_bvec(bvl, bio, iter) \
156 __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter)
157
Kent Overstreet4550dd62013-08-07 14:26:21 -0700158#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Shaohua Lif4595872017-03-24 10:34:43 -0700160static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700161{
162 unsigned segs = 0;
163 struct bio_vec bv;
164 struct bvec_iter iter;
165
Kent Overstreet8423ae32014-02-10 17:45:50 -0800166 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800167 * We special case discard/write same/write zeroes, because they
168 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800169 */
170
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800171 switch (bio_op(bio)) {
172 case REQ_OP_DISCARD:
173 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800174 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700175 return 0;
176 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800177 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800178 default:
179 break;
180 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800181
Shaohua Lif4595872017-03-24 10:34:43 -0700182 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700183 segs++;
184
185 return segs;
186}
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/*
189 * get a reference to a bio, so it won't disappear. the intended use is
190 * something like:
191 *
192 * bio_get(bio);
193 * submit_bio(rw, bio);
194 * if (bio->bi_flags ...)
195 * do_something
196 * bio_put(bio);
197 *
198 * without the bio_get(), it could potentially complete I/O before submit_bio
199 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
200 * runs
201 */
Jens Axboedac56212015-04-17 16:23:59 -0600202static inline void bio_get(struct bio *bio)
203{
204 bio->bi_flags |= (1 << BIO_REFFED);
205 smp_mb__before_atomic();
206 atomic_inc(&bio->__bi_cnt);
207}
208
209static inline void bio_cnt_set(struct bio *bio, unsigned int count)
210{
211 if (count != 1) {
212 bio->bi_flags |= (1 << BIO_REFFED);
Andrea Parrif381c6a2019-05-20 19:23:56 +0200213 smp_mb();
Jens Axboedac56212015-04-17 16:23:59 -0600214 }
215 atomic_set(&bio->__bi_cnt, count);
216}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600218static inline bool bio_flagged(struct bio *bio, unsigned int bit)
219{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600220 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600221}
222
223static inline void bio_set_flag(struct bio *bio, unsigned int bit)
224{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600225 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600226}
227
228static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
229{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600230 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600231}
232
Ming Lei7bcd79a2016-02-26 23:40:50 +0800233static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
234{
235 *bv = bio_iovec(bio);
236}
237
238static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
239{
240 struct bvec_iter iter = bio->bi_iter;
241 int idx;
242
Ming Lei7bcd79a2016-02-26 23:40:50 +0800243 if (unlikely(!bio_multiple_segments(bio))) {
244 *bv = bio_iovec(bio);
245 return;
246 }
247
248 bio_advance_iter(bio, &iter, iter.bi_size);
249
250 if (!iter.bi_bvec_done)
251 idx = iter.bi_idx - 1;
252 else /* in the middle of bvec */
253 idx = iter.bi_idx;
254
255 *bv = bio->bi_io_vec[idx];
256
257 /*
258 * iter.bi_bvec_done records actual length of the last bvec
259 * if this bio ends in the middle of one io vector
260 */
261 if (iter.bi_bvec_done)
262 bv->bv_len = iter.bi_bvec_done;
263}
264
Ming Lei86292ab2017-12-18 20:22:03 +0800265static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
266{
267 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
268 return bio->bi_io_vec;
269}
270
271static inline struct page *bio_first_page_all(struct bio *bio)
272{
273 return bio_first_bvec_all(bio)->bv_page;
274}
275
276static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
277{
278 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
279 return &bio->bi_io_vec[bio->bi_vcnt - 1];
280}
281
Martin K. Petersenc6115292014-09-26 19:20:08 -0400282enum bip_flags {
283 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
284 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
285 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
286 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
287 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
288};
289
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200290/*
291 * bio integrity payload
292 */
293struct bio_integrity_payload {
294 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200295
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800296 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200297
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200298 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200299 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600300 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400301 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200302
Ming Lei7759eb22018-09-05 15:45:54 -0600303 struct bvec_iter bio_iter; /* for rewinding parent bio */
304
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700306
307 struct bio_vec *bip_vec;
308 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309};
Martin K. Petersen18593082014-09-26 19:20:01 -0400310
Keith Busch06c1e392015-12-03 09:32:21 -0700311#if defined(CONFIG_BLK_DEV_INTEGRITY)
312
313static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
314{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600315 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700316 return bio->bi_integrity;
317
318 return NULL;
319}
320
Martin K. Petersenc6115292014-09-26 19:20:08 -0400321static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
322{
323 struct bio_integrity_payload *bip = bio_integrity(bio);
324
325 if (bip)
326 return bip->bip_flags & flag;
327
328 return false;
329}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400330
Martin K. Petersen18593082014-09-26 19:20:01 -0400331static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
332{
333 return bip->bip_iter.bi_sector;
334}
335
336static inline void bip_set_seed(struct bio_integrity_payload *bip,
337 sector_t seed)
338{
339 bip->bip_iter.bi_sector = seed;
340}
341
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200342#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Kent Overstreet6678d832013-08-07 11:14:32 -0700344extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800345extern struct bio *bio_split(struct bio *bio, int sectors,
346 gfp_t gfp, struct bio_set *bs);
347
348/**
349 * bio_next_split - get next @sectors from a bio, splitting if necessary
350 * @bio: bio to split
351 * @sectors: number of sectors to split from the front of @bio
352 * @gfp: gfp mask
353 * @bs: bio set to allocate from
354 *
355 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
356 * than @sectors, returns the original bio unchanged.
357 */
358static inline struct bio *bio_next_split(struct bio *bio, int sectors,
359 gfp_t gfp, struct bio_set *bs)
360{
361 if (sectors >= bio_sectors(bio))
362 return bio;
363
364 return bio_split(bio, sectors, gfp, bs);
365}
366
NeilBrown011067b2017-06-18 14:38:57 +1000367enum {
368 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000369 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000370};
Kent Overstreetdad08522018-05-20 18:25:58 -0400371extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
372extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba2f2018-05-08 21:33:50 -0400373extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600374extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300376extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Kent Overstreet59d276f2013-11-23 18:19:27 -0800379extern void __bio_clone_fast(struct bio *, struct bio *);
380extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700381
Kent Overstreetf4f81542018-05-08 21:33:52 -0400382extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700383
384static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
385{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400386 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700387}
388
389static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
390{
391 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
392}
393
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600394extern blk_qc_t submit_bio(struct bio *);
395
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200396extern void bio_endio(struct bio *);
397
398static inline void bio_io_error(struct bio *bio)
399{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200400 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200401 bio_endio(bio);
402}
403
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500404static inline void bio_wouldblock_error(struct bio *bio)
405{
406 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700407 bio_endio(bio);
408}
NeilBrown6712ecf2007-09-27 12:47:43 +0200409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410struct request_queue;
411extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Mike Christie4e49ea42016-06-05 14:31:41 -0500413extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700414extern void bio_advance(struct bio *, unsigned);
415
Ming Lei3a83f462016-11-22 08:57:21 -0700416extern void bio_init(struct bio *bio, struct bio_vec *table,
417 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600418extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700419extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800420void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600423extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
424 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700425bool __bio_try_merge_page(struct bio *bio, struct page *page,
Ming Lei07173c32019-02-15 19:13:20 +0800426 unsigned int len, unsigned int off, bool same_page);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700427void __bio_add_page(struct bio *bio, struct page *page,
428 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600429int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900430struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200431extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400432 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200434extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400435 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200436extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
437 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438extern void bio_set_pages_dirty(struct bio *bio);
439extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100440
Michael Callahanddcf35d2018-07-18 04:47:39 -0700441void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600442 unsigned long sectors, struct hd_struct *part);
Michael Callahanddcf35d2018-07-18 04:47:39 -0700443void generic_end_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600444 struct hd_struct *part,
445 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800446
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100447#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
448# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
449#endif
450#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
451extern void bio_flush_dcache_pages(struct bio *bi);
452#else
453static inline void bio_flush_dcache_pages(struct bio *bi)
454{
455}
456#endif
457
Kent Overstreet45db54d2018-05-08 21:33:54 -0400458extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
459 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700460extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400461extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400462extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700463
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900464extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500465 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400466 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100467 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468extern int bio_uncopy_user(struct bio *);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400469void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
470
471static inline void zero_fill_bio(struct bio *bio)
472{
473 zero_fill_bio_iter(bio, bio->bi_iter);
474}
475
Kent Overstreet9f060e22012-10-12 15:29:33 -0700476extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
477extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200478extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800479extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200480
Christoph Hellwig74d46992017-08-23 19:10:32 +0200481#define bio_set_dev(bio, bdev) \
482do { \
Shaohua Li111be882017-12-20 11:10:17 -0700483 if ((bio)->bi_disk != (bdev)->bd_disk) \
484 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200485 (bio)->bi_disk = (bdev)->bd_disk; \
486 (bio)->bi_partno = (bdev)->bd_partno; \
Dennis Zhou5cdf2e32018-12-05 12:10:31 -0500487 bio_associate_blkg(bio); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200488} while (0)
489
490#define bio_copy_dev(dst, src) \
491do { \
492 (dst)->bi_disk = (src)->bi_disk; \
493 (dst)->bi_partno = (src)->bi_partno; \
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500494 bio_clone_blkg_association(dst, src); \
Christoph Hellwig74d46992017-08-23 19:10:32 +0200495} while (0)
496
497#define bio_dev(bio) \
498 disk_devt((bio)->bi_disk)
499
Tejun Heo0d3bd882018-07-03 11:14:54 -0400500#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500501void bio_associate_blkg_from_page(struct bio *bio, struct page *page);
Tejun Heo0d3bd882018-07-03 11:14:54 -0400502#else
Dennis Zhou6a7f6d82018-12-05 12:10:33 -0500503static inline void bio_associate_blkg_from_page(struct bio *bio,
504 struct page *page) { }
Tejun Heo0d3bd882018-07-03 11:14:54 -0400505#endif
506
Tejun Heo852c7882012-03-05 13:15:27 -0800507#ifdef CONFIG_BLK_CGROUP
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500508void bio_disassociate_blkg(struct bio *bio);
509void bio_associate_blkg(struct bio *bio);
Dennis Zhoufd42df32018-12-05 12:10:34 -0500510void bio_associate_blkg_from_css(struct bio *bio,
511 struct cgroup_subsys_state *css);
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500512void bio_clone_blkg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800513#else /* CONFIG_BLK_CGROUP */
Dennis Zhou2268c0f2018-12-05 12:10:29 -0500514static inline void bio_disassociate_blkg(struct bio *bio) { }
515static inline void bio_associate_blkg(struct bio *bio) { }
Dennis Zhoufd42df32018-12-05 12:10:34 -0500516static inline void bio_associate_blkg_from_css(struct bio *bio,
517 struct cgroup_subsys_state *css)
518{ }
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500519static inline void bio_clone_blkg_association(struct bio *dst,
520 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800521#endif /* CONFIG_BLK_CGROUP */
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523#ifdef CONFIG_HIGHMEM
524/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100525 * remember never ever reenable interrupts between a bvec_kmap_irq and
526 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100528static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
530 unsigned long addr;
531
532 /*
533 * might not be a highmem page, but the preempt/irq count
534 * balancing is a lot nicer this way
535 */
536 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800537 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
539 BUG_ON(addr & ~PAGE_MASK);
540
541 return (char *) addr + bvec->bv_offset;
542}
543
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100544static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
547
Cong Wange8e3c3d2011-11-25 23:14:27 +0800548 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 local_irq_restore(*flags);
550}
551
552#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200553static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
554{
555 return page_address(bvec->bv_page) + bvec->bv_offset;
556}
557
558static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
559{
560 *flags = 0;
561}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562#endif
563
Jens Axboe7a67f632008-08-08 11:17:12 +0200564/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200565 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200566 *
567 * A bio_list anchors a singly-linked list of bios chained through the bi_next
568 * member of the bio. The bio_list also caches the last list member to allow
569 * fast access to the tail.
570 */
571struct bio_list {
572 struct bio *head;
573 struct bio *tail;
574};
575
576static inline int bio_list_empty(const struct bio_list *bl)
577{
578 return bl->head == NULL;
579}
580
581static inline void bio_list_init(struct bio_list *bl)
582{
583 bl->head = bl->tail = NULL;
584}
585
Jens Axboe320ae512013-10-24 09:20:05 +0100586#define BIO_EMPTY_LIST { NULL, NULL }
587
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200588#define bio_list_for_each(bio, bl) \
589 for (bio = (bl)->head; bio; bio = bio->bi_next)
590
591static inline unsigned bio_list_size(const struct bio_list *bl)
592{
593 unsigned sz = 0;
594 struct bio *bio;
595
596 bio_list_for_each(bio, bl)
597 sz++;
598
599 return sz;
600}
601
602static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
603{
604 bio->bi_next = NULL;
605
606 if (bl->tail)
607 bl->tail->bi_next = bio;
608 else
609 bl->head = bio;
610
611 bl->tail = bio;
612}
613
614static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
615{
616 bio->bi_next = bl->head;
617
618 bl->head = bio;
619
620 if (!bl->tail)
621 bl->tail = bio;
622}
623
624static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
625{
626 if (!bl2->head)
627 return;
628
629 if (bl->tail)
630 bl->tail->bi_next = bl2->head;
631 else
632 bl->head = bl2->head;
633
634 bl->tail = bl2->tail;
635}
636
637static inline void bio_list_merge_head(struct bio_list *bl,
638 struct bio_list *bl2)
639{
640 if (!bl2->head)
641 return;
642
643 if (bl->head)
644 bl2->tail->bi_next = bl->head;
645 else
646 bl->tail = bl2->tail;
647
648 bl->head = bl2->head;
649}
650
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000651static inline struct bio *bio_list_peek(struct bio_list *bl)
652{
653 return bl->head;
654}
655
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200656static inline struct bio *bio_list_pop(struct bio_list *bl)
657{
658 struct bio *bio = bl->head;
659
660 if (bio) {
661 bl->head = bl->head->bi_next;
662 if (!bl->head)
663 bl->tail = NULL;
664
665 bio->bi_next = NULL;
666 }
667
668 return bio;
669}
670
671static inline struct bio *bio_list_get(struct bio_list *bl)
672{
673 struct bio *bio = bl->head;
674
675 bl->head = bl->tail = NULL;
676
677 return bio;
678}
679
Kent Overstreet57fb2332012-08-24 04:56:11 -0700680/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400681 * Increment chain count for the bio. Make sure the CHAIN flag update
682 * is visible before the raised count.
683 */
684static inline void bio_inc_remaining(struct bio *bio)
685{
686 bio_set_flag(bio, BIO_CHAIN);
687 smp_mb__before_atomic();
688 atomic_inc(&bio->__bi_remaining);
689}
690
691/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700692 * bio_set is used to allow other portions of the IO system to
693 * allocate their own private memory pools for bio and iovec structures.
694 * These memory pools in turn all allocate from the bio_slab
695 * and the bvec_slabs[].
696 */
697#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700698
699struct bio_set {
700 struct kmem_cache *bio_slab;
701 unsigned int front_pad;
702
Kent Overstreet8aa6ba2f2018-05-08 21:33:50 -0400703 mempool_t bio_pool;
704 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700705#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba2f2018-05-08 21:33:50 -0400706 mempool_t bio_integrity_pool;
707 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700708#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700709
710 /*
711 * Deadlock avoidance for stacking block drivers: see comments in
712 * bio_alloc_bioset() for details
713 */
714 spinlock_t rescue_lock;
715 struct bio_list rescue_list;
716 struct work_struct rescue_work;
717 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700718};
719
720struct biovec_slab {
721 int nr_vecs;
722 char *name;
723 struct kmem_cache *slab;
724};
725
Kent Overstreet338aa962018-05-20 18:25:47 -0400726static inline bool bioset_initialized(struct bio_set *bs)
727{
728 return bs->bio_slab != NULL;
729}
730
Kent Overstreet57fb2332012-08-24 04:56:11 -0700731/*
732 * a small number of entries is fine, not going to be performance critical.
733 * basically we just need to survive
734 */
735#define BIO_SPLIT_ENTRIES 2
736
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200737#if defined(CONFIG_BLK_DEV_INTEGRITY)
738
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800739#define bip_for_each_vec(bvl, bip, iter) \
740 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200741
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200742#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
743 for_each_bio(_bio) \
744 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
745
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200746extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200747extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700748extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200749extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700750extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700751extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200752extern int bioset_integrity_create(struct bio_set *, int);
753extern void bioset_integrity_free(struct bio_set *);
754extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200755
756#else /* CONFIG_BLK_DEV_INTEGRITY */
757
Martin K. Petersenc6115292014-09-26 19:20:08 -0400758static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100759{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400760 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100761}
762
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100763static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
764{
765 return 0;
766}
767
768static inline void bioset_integrity_free (struct bio_set *bs)
769{
770 return;
771}
772
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700773static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100774{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700775 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100776}
777
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100778static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700779 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100780{
781 return 0;
782}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100783
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100784static inline void bio_integrity_advance(struct bio *bio,
785 unsigned int bytes_done)
786{
787 return;
788}
789
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700790static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100791{
792 return;
793}
794
795static inline void bio_integrity_init(void)
796{
797 return;
798}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200799
Martin K. Petersenc6115292014-09-26 19:20:08 -0400800static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
801{
802 return false;
803}
804
Keith Busch06c1e392015-12-03 09:32:21 -0700805static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
806 unsigned int nr)
807{
808 return ERR_PTR(-EINVAL);
809}
810
811static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
812 unsigned int len, unsigned int offset)
813{
814 return 0;
815}
816
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200817#endif /* CONFIG_BLK_DEV_INTEGRITY */
818
Jens Axboe0bbb2802018-12-21 09:10:46 -0700819/*
820 * Mark a bio as polled. Note that for async polled IO, the caller must
821 * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
822 * We cannot block waiting for requests on polled IO, as those completions
823 * must be found by the caller. This is different than IRQ driven IO, where
824 * it's safe to wait for IO to complete.
825 */
826static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
827{
828 bio->bi_opf |= REQ_HIPRI;
829 if (!is_sync_kiocb(kiocb))
830 bio->bi_opf |= REQ_NOWAIT;
831}
832
David Howells02a5e0a2007-08-11 22:34:32 +0200833#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834#endif /* __LINUX_BIO_H */