blob: d5e8689f86b8c8c30cccc770f572820ebcdf4c8a [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
Alexey Dobriyand84a8472006-06-25 05:49:32 -070041#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Mike Christie43b62ce2016-06-05 14:32:20 -050043#define bio_prio(bio) (bio)->bi_ioprio
44#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020045
Kent Overstreet4550dd62013-08-07 14:26:21 -070046#define bio_iter_iovec(bio, iter) \
47 bvec_iter_bvec((bio)->bi_io_vec, (iter))
48
49#define bio_iter_page(bio, iter) \
50 bvec_iter_page((bio)->bi_io_vec, (iter))
51#define bio_iter_len(bio, iter) \
52 bvec_iter_len((bio)->bi_io_vec, (iter))
53#define bio_iter_offset(bio, iter) \
54 bvec_iter_offset((bio)->bi_io_vec, (iter))
55
56#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
57#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
58#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080059
Kent Overstreet458b76e2013-09-24 16:26:05 -070060#define bio_multiple_segments(bio) \
61 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -070062#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
63#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
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
118/*
119 * will die
120 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
122
123/*
124 * queues that have highmem support enabled may still need to revert to
125 * PIO transfers occasionally and thus map high pages temporarily. For
126 * permanent PIO fall back, user is probably better off disabling highmem
127 * I/O completely on that queue (see ide-dma for example)
128 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700129#define __bio_kmap_atomic(bio, iter) \
130 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
131 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Kent Overstreetf619d252013-08-07 14:30:33 -0700133#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/*
136 * merge helpers etc
137 */
138
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100139/* Default implementation of BIOVEC_PHYS_MERGEABLE */
140#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
141 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/*
144 * allow arch override, for eg virtualized architectures (put in asm/io.h)
145 */
146#ifndef BIOVEC_PHYS_MERGEABLE
147#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100148 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149#endif
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
152 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
153#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400154 __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 -0700155
Jens Axboe66cb45a2014-06-24 16:22:24 -0600156/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800157 * drivers should _never_ use the all version - the bio may have been split
158 * before it got to the driver and the driver won't own all of it
159 */
160#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700161 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800162
Kent Overstreet4550dd62013-08-07 14:26:21 -0700163static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
164 unsigned bytes)
165{
166 iter->bi_sector += bytes >> 9;
167
Mike Christie95fe6c12016-06-05 14:31:48 -0500168 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700169 iter->bi_size -= bytes;
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700170 else {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700171 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700172 /* TODO: It is reasonable to complete bio with error here. */
173 }
Kent Overstreet4550dd62013-08-07 14:26:21 -0700174}
175
Kent Overstreet79886132013-11-23 17:19:00 -0800176#define __bio_for_each_segment(bvl, bio, iter, start) \
177 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700178 (iter).bi_size && \
179 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
180 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800181
182#define bio_for_each_segment(bvl, bio, iter) \
183 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
184
Kent Overstreet4550dd62013-08-07 14:26:21 -0700185#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Shaohua Lif4595872017-03-24 10:34:43 -0700187static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700188{
189 unsigned segs = 0;
190 struct bio_vec bv;
191 struct bvec_iter iter;
192
Kent Overstreet8423ae32014-02-10 17:45:50 -0800193 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800194 * We special case discard/write same/write zeroes, because they
195 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800196 */
197
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800198 switch (bio_op(bio)) {
199 case REQ_OP_DISCARD:
200 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800201 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700202 return 0;
203 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800204 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800205 default:
206 break;
207 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800208
Shaohua Lif4595872017-03-24 10:34:43 -0700209 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700210 segs++;
211
212 return segs;
213}
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215/*
216 * get a reference to a bio, so it won't disappear. the intended use is
217 * something like:
218 *
219 * bio_get(bio);
220 * submit_bio(rw, bio);
221 * if (bio->bi_flags ...)
222 * do_something
223 * bio_put(bio);
224 *
225 * without the bio_get(), it could potentially complete I/O before submit_bio
226 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
227 * runs
228 */
Jens Axboedac56212015-04-17 16:23:59 -0600229static inline void bio_get(struct bio *bio)
230{
231 bio->bi_flags |= (1 << BIO_REFFED);
232 smp_mb__before_atomic();
233 atomic_inc(&bio->__bi_cnt);
234}
235
236static inline void bio_cnt_set(struct bio *bio, unsigned int count)
237{
238 if (count != 1) {
239 bio->bi_flags |= (1 << BIO_REFFED);
240 smp_mb__before_atomic();
241 }
242 atomic_set(&bio->__bi_cnt, count);
243}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600245static inline bool bio_flagged(struct bio *bio, unsigned int bit)
246{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600247 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600248}
249
250static inline void bio_set_flag(struct bio *bio, unsigned int bit)
251{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600252 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600253}
254
255static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
256{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600257 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600258}
259
Ming Lei7bcd79a2016-02-26 23:40:50 +0800260static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
261{
262 *bv = bio_iovec(bio);
263}
264
265static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
266{
267 struct bvec_iter iter = bio->bi_iter;
268 int idx;
269
Ming Lei7bcd79a2016-02-26 23:40:50 +0800270 if (unlikely(!bio_multiple_segments(bio))) {
271 *bv = bio_iovec(bio);
272 return;
273 }
274
275 bio_advance_iter(bio, &iter, iter.bi_size);
276
277 if (!iter.bi_bvec_done)
278 idx = iter.bi_idx - 1;
279 else /* in the middle of bvec */
280 idx = iter.bi_idx;
281
282 *bv = bio->bi_io_vec[idx];
283
284 /*
285 * iter.bi_bvec_done records actual length of the last bvec
286 * if this bio ends in the middle of one io vector
287 */
288 if (iter.bi_bvec_done)
289 bv->bv_len = iter.bi_bvec_done;
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
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800308 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200310 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200311 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600312 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400313 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200314
315 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 +1000377extern struct bio_set *bioset_create(unsigned int, unsigned int, int flags);
378enum {
379 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000380 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000381};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600383extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300385extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Kent Overstreet59d276f2013-11-23 18:19:27 -0800388extern void __bio_clone_fast(struct bio *, struct bio *);
389extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700390extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
391
Kent Overstreet3f86a822012-09-06 15:35:01 -0700392extern struct bio_set *fs_bio_set;
393
394static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
395{
396 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
397}
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
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700404static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
405{
406 return bio_clone_bioset(bio, gfp_mask, NULL);
407
408}
409
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600410extern blk_qc_t submit_bio(struct bio *);
411
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200412extern void bio_endio(struct bio *);
413
414static inline void bio_io_error(struct bio *bio)
415{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200416 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200417 bio_endio(bio);
418}
419
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500420static inline void bio_wouldblock_error(struct bio *bio)
421{
422 bio->bi_status = BLK_STS_AGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 bio_endio(bio);
424}
425
NeilBrown6712ecf2007-09-27 12:47:43 +0200426struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427extern int bio_phys_segments(struct request_queue *, struct bio *);
428
Mike Christie4e49ea42016-06-05 14:31:41 -0500429extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700430extern void bio_advance(struct bio *, unsigned);
431
Ming Lei3a83f462016-11-22 08:57:21 -0700432extern void bio_init(struct bio *bio, struct bio_vec *table,
433 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600434extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700435extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800436void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600439extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
440 unsigned int, unsigned int);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600441int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900442struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200443extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100444 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200446extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400447 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200448extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
449 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450extern void bio_set_pages_dirty(struct bio *bio);
451extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100452
Gu Zheng394ffa52014-11-24 11:05:22 +0800453void generic_start_io_acct(int rw, unsigned long sectors,
454 struct hd_struct *part);
455void generic_end_io_acct(int rw, struct hd_struct *part,
456 unsigned long start_time);
457
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100458#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
459# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
460#endif
461#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
462extern void bio_flush_dcache_pages(struct bio *bi);
463#else
464static inline void bio_flush_dcache_pages(struct bio *bi)
465{
466}
467#endif
468
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700469extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700470extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400471extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700472
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900473extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500474 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100475 const struct iov_iter *,
476 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477extern int bio_uncopy_user(struct bio *);
478void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700479extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
480extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200481extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200482
Tejun Heo852c7882012-03-05 13:15:27 -0800483#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400484int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800485int bio_associate_current(struct bio *bio);
486void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200487void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800488#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400489static inline int bio_associate_blkcg(struct bio *bio,
490 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800491static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
492static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200493static inline void bio_clone_blkcg_association(struct bio *dst,
494 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800495#endif /* CONFIG_BLK_CGROUP */
496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497#ifdef CONFIG_HIGHMEM
498/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100499 * remember never ever reenable interrupts between a bvec_kmap_irq and
500 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100502static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
504 unsigned long addr;
505
506 /*
507 * might not be a highmem page, but the preempt/irq count
508 * balancing is a lot nicer this way
509 */
510 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800511 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
513 BUG_ON(addr & ~PAGE_MASK);
514
515 return (char *) addr + bvec->bv_offset;
516}
517
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100518static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
520 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
521
Cong Wange8e3c3d2011-11-25 23:14:27 +0800522 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 local_irq_restore(*flags);
524}
525
526#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200527static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
528{
529 return page_address(bvec->bv_page) + bvec->bv_offset;
530}
531
532static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
533{
534 *flags = 0;
535}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536#endif
537
Kent Overstreetf619d252013-08-07 14:30:33 -0700538static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 unsigned long *flags)
540{
Kent Overstreetf619d252013-08-07 14:30:33 -0700541 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542}
543#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
544
545#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700546 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
548
Jens Axboe7a67f632008-08-08 11:17:12 +0200549/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200550 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200551 *
552 * A bio_list anchors a singly-linked list of bios chained through the bi_next
553 * member of the bio. The bio_list also caches the last list member to allow
554 * fast access to the tail.
555 */
556struct bio_list {
557 struct bio *head;
558 struct bio *tail;
559};
560
561static inline int bio_list_empty(const struct bio_list *bl)
562{
563 return bl->head == NULL;
564}
565
566static inline void bio_list_init(struct bio_list *bl)
567{
568 bl->head = bl->tail = NULL;
569}
570
Jens Axboe320ae512013-10-24 09:20:05 +0100571#define BIO_EMPTY_LIST { NULL, NULL }
572
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200573#define bio_list_for_each(bio, bl) \
574 for (bio = (bl)->head; bio; bio = bio->bi_next)
575
576static inline unsigned bio_list_size(const struct bio_list *bl)
577{
578 unsigned sz = 0;
579 struct bio *bio;
580
581 bio_list_for_each(bio, bl)
582 sz++;
583
584 return sz;
585}
586
587static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
588{
589 bio->bi_next = NULL;
590
591 if (bl->tail)
592 bl->tail->bi_next = bio;
593 else
594 bl->head = bio;
595
596 bl->tail = bio;
597}
598
599static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
600{
601 bio->bi_next = bl->head;
602
603 bl->head = bio;
604
605 if (!bl->tail)
606 bl->tail = bio;
607}
608
609static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
610{
611 if (!bl2->head)
612 return;
613
614 if (bl->tail)
615 bl->tail->bi_next = bl2->head;
616 else
617 bl->head = bl2->head;
618
619 bl->tail = bl2->tail;
620}
621
622static inline void bio_list_merge_head(struct bio_list *bl,
623 struct bio_list *bl2)
624{
625 if (!bl2->head)
626 return;
627
628 if (bl->head)
629 bl2->tail->bi_next = bl->head;
630 else
631 bl->tail = bl2->tail;
632
633 bl->head = bl2->head;
634}
635
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000636static inline struct bio *bio_list_peek(struct bio_list *bl)
637{
638 return bl->head;
639}
640
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200641static inline struct bio *bio_list_pop(struct bio_list *bl)
642{
643 struct bio *bio = bl->head;
644
645 if (bio) {
646 bl->head = bl->head->bi_next;
647 if (!bl->head)
648 bl->tail = NULL;
649
650 bio->bi_next = NULL;
651 }
652
653 return bio;
654}
655
656static inline struct bio *bio_list_get(struct bio_list *bl)
657{
658 struct bio *bio = bl->head;
659
660 bl->head = bl->tail = NULL;
661
662 return bio;
663}
664
Kent Overstreet57fb2332012-08-24 04:56:11 -0700665/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400666 * Increment chain count for the bio. Make sure the CHAIN flag update
667 * is visible before the raised count.
668 */
669static inline void bio_inc_remaining(struct bio *bio)
670{
671 bio_set_flag(bio, BIO_CHAIN);
672 smp_mb__before_atomic();
673 atomic_inc(&bio->__bi_remaining);
674}
675
676/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700677 * bio_set is used to allow other portions of the IO system to
678 * allocate their own private memory pools for bio and iovec structures.
679 * These memory pools in turn all allocate from the bio_slab
680 * and the bvec_slabs[].
681 */
682#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700683
684struct bio_set {
685 struct kmem_cache *bio_slab;
686 unsigned int front_pad;
687
688 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700689 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700690#if defined(CONFIG_BLK_DEV_INTEGRITY)
691 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700692 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700693#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700694
695 /*
696 * Deadlock avoidance for stacking block drivers: see comments in
697 * bio_alloc_bioset() for details
698 */
699 spinlock_t rescue_lock;
700 struct bio_list rescue_list;
701 struct work_struct rescue_work;
702 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700703};
704
705struct biovec_slab {
706 int nr_vecs;
707 char *name;
708 struct kmem_cache *slab;
709};
710
711/*
712 * a small number of entries is fine, not going to be performance critical.
713 * basically we just need to survive
714 */
715#define BIO_SPLIT_ENTRIES 2
716
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200717#if defined(CONFIG_BLK_DEV_INTEGRITY)
718
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800719#define bip_for_each_vec(bvl, bip, iter) \
720 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200721
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200722#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
723 for_each_bio(_bio) \
724 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
725
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200726extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700727extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200728extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700729extern bool bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200730extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200731extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700732extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700733extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200734extern int bioset_integrity_create(struct bio_set *, int);
735extern void bioset_integrity_free(struct bio_set *);
736extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200737
738#else /* CONFIG_BLK_DEV_INTEGRITY */
739
Martin K. Petersenc6115292014-09-26 19:20:08 -0400740static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100741{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400742 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100743}
744
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100745static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
746{
747 return 0;
748}
749
750static inline void bioset_integrity_free (struct bio_set *bs)
751{
752 return;
753}
754
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700755static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100756{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700757 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100758}
759
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700760static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100761{
762 return;
763}
764
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100765static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700766 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100767{
768 return 0;
769}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100770
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100771static inline void bio_integrity_advance(struct bio *bio,
772 unsigned int bytes_done)
773{
774 return;
775}
776
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700777static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100778{
779 return;
780}
781
782static inline void bio_integrity_init(void)
783{
784 return;
785}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200786
Martin K. Petersenc6115292014-09-26 19:20:08 -0400787static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
788{
789 return false;
790}
791
Keith Busch06c1e392015-12-03 09:32:21 -0700792static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
793 unsigned int nr)
794{
795 return ERR_PTR(-EINVAL);
796}
797
798static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
799 unsigned int len, unsigned int offset)
800{
801 return 0;
802}
803
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200804#endif /* CONFIG_BLK_DEV_INTEGRITY */
805
David Howells02a5e0a2007-08-11 22:34:32 +0200806#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807#endif /* __LINUX_BIO_H */