blob: ce547a25e8aed5d61efd5c0ce9b5c450af4fabcc [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 Overstreet4f024f32013-10-11 15:44:27 -070070#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
71#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +020072
Kent Overstreet458b76e2013-09-24 16:26:05 -070073/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060074 * Return the data direction, READ or WRITE.
75 */
76#define bio_data_dir(bio) \
77 (op_is_write(bio_op(bio)) ? WRITE : READ)
78
79/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070080 * Check whether this bio carries any data or not. A NULL bio is allowed.
81 */
82static inline bool bio_has_data(struct bio *bio)
83{
84 if (bio &&
85 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030086 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080087 bio_op(bio) != REQ_OP_SECURE_ERASE &&
88 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070089 return true;
90
91 return false;
92}
93
Mike Christie95fe6c12016-06-05 14:31:48 -050094static inline bool bio_no_advance_iter(struct bio *bio)
95{
Adrian Hunter7afafc82016-08-16 10:59:35 +030096 return bio_op(bio) == REQ_OP_DISCARD ||
97 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080098 bio_op(bio) == REQ_OP_WRITE_SAME ||
99 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -0500100}
101
Kent Overstreet458b76e2013-09-24 16:26:05 -0700102static inline bool bio_mergeable(struct bio *bio)
103{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600104 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700105 return false;
106
107 return true;
108}
109
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900110static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200111{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700112 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700113 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100114 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700115 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200116}
117
118static inline void *bio_data(struct bio *bio)
119{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700120 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200121 return page_address(bio_page(bio)) + bio_offset(bio);
122
123 return NULL;
124}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/*
127 * will die
128 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
130
131/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * merge helpers etc
133 */
134
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100135/* Default implementation of BIOVEC_PHYS_MERGEABLE */
136#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
137 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/*
140 * allow arch override, for eg virtualized architectures (put in asm/io.h)
141 */
142#ifndef BIOVEC_PHYS_MERGEABLE
143#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100144 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#endif
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
148 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
149#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400150 __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 -0700151
Jens Axboe66cb45a2014-06-24 16:22:24 -0600152/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800153 * drivers should _never_ use the all version - the bio may have been split
154 * before it got to the driver and the driver won't own all of it
155 */
156#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700157 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800158
Kent Overstreet4550dd62013-08-07 14:26:21 -0700159static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
160 unsigned bytes)
161{
162 iter->bi_sector += bytes >> 9;
163
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700164 if (bio_no_advance_iter(bio)) {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700165 iter->bi_size -= bytes;
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700166 iter->bi_done += bytes;
167 } else {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700168 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700169 /* TODO: It is reasonable to complete bio with error here. */
170 }
Kent Overstreet4550dd62013-08-07 14:26:21 -0700171}
172
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700173static inline bool bio_rewind_iter(struct bio *bio, struct bvec_iter *iter,
174 unsigned int bytes)
175{
176 iter->bi_sector -= bytes >> 9;
177
178 if (bio_no_advance_iter(bio)) {
179 iter->bi_size += bytes;
180 iter->bi_done -= bytes;
181 return true;
182 }
183
184 return bvec_iter_rewind(bio->bi_io_vec, iter, bytes);
185}
186
Kent Overstreet79886132013-11-23 17:19:00 -0800187#define __bio_for_each_segment(bvl, bio, iter, start) \
188 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700189 (iter).bi_size && \
190 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
191 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800192
193#define bio_for_each_segment(bvl, bio, iter) \
194 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
195
Kent Overstreet4550dd62013-08-07 14:26:21 -0700196#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Shaohua Lif4595872017-03-24 10:34:43 -0700198static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700199{
200 unsigned segs = 0;
201 struct bio_vec bv;
202 struct bvec_iter iter;
203
Kent Overstreet8423ae32014-02-10 17:45:50 -0800204 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800205 * We special case discard/write same/write zeroes, because they
206 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800207 */
208
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800209 switch (bio_op(bio)) {
210 case REQ_OP_DISCARD:
211 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800212 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700213 return 0;
214 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800215 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800216 default:
217 break;
218 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800219
Shaohua Lif4595872017-03-24 10:34:43 -0700220 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700221 segs++;
222
223 return segs;
224}
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226/*
227 * get a reference to a bio, so it won't disappear. the intended use is
228 * something like:
229 *
230 * bio_get(bio);
231 * submit_bio(rw, bio);
232 * if (bio->bi_flags ...)
233 * do_something
234 * bio_put(bio);
235 *
236 * without the bio_get(), it could potentially complete I/O before submit_bio
237 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
238 * runs
239 */
Jens Axboedac56212015-04-17 16:23:59 -0600240static inline void bio_get(struct bio *bio)
241{
242 bio->bi_flags |= (1 << BIO_REFFED);
243 smp_mb__before_atomic();
244 atomic_inc(&bio->__bi_cnt);
245}
246
247static inline void bio_cnt_set(struct bio *bio, unsigned int count)
248{
249 if (count != 1) {
250 bio->bi_flags |= (1 << BIO_REFFED);
251 smp_mb__before_atomic();
252 }
253 atomic_set(&bio->__bi_cnt, count);
254}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600256static inline bool bio_flagged(struct bio *bio, unsigned int bit)
257{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600258 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600259}
260
261static inline void bio_set_flag(struct bio *bio, unsigned int bit)
262{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600263 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600264}
265
266static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
267{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600268 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600269}
270
Ming Lei7bcd79a2016-02-26 23:40:50 +0800271static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
272{
273 *bv = bio_iovec(bio);
274}
275
276static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
277{
278 struct bvec_iter iter = bio->bi_iter;
279 int idx;
280
Ming Lei7bcd79a2016-02-26 23:40:50 +0800281 if (unlikely(!bio_multiple_segments(bio))) {
282 *bv = bio_iovec(bio);
283 return;
284 }
285
286 bio_advance_iter(bio, &iter, iter.bi_size);
287
288 if (!iter.bi_bvec_done)
289 idx = iter.bi_idx - 1;
290 else /* in the middle of bvec */
291 idx = iter.bi_idx;
292
293 *bv = bio->bi_io_vec[idx];
294
295 /*
296 * iter.bi_bvec_done records actual length of the last bvec
297 * if this bio ends in the middle of one io vector
298 */
299 if (iter.bi_bvec_done)
300 bv->bv_len = iter.bi_bvec_done;
301}
302
Ming Lei86292ab2017-12-18 20:22:03 +0800303static inline unsigned bio_pages_all(struct bio *bio)
304{
305 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
306 return bio->bi_vcnt;
307}
308
309static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
310{
311 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
312 return bio->bi_io_vec;
313}
314
315static inline struct page *bio_first_page_all(struct bio *bio)
316{
317 return bio_first_bvec_all(bio)->bv_page;
318}
319
320static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
321{
322 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
323 return &bio->bi_io_vec[bio->bi_vcnt - 1];
324}
325
Martin K. Petersenc6115292014-09-26 19:20:08 -0400326enum bip_flags {
327 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
328 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
329 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
330 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
331 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
332};
333
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200334/*
335 * bio integrity payload
336 */
337struct bio_integrity_payload {
338 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200339
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800340 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200341
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200342 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200343 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600344 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400345 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200346
347 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700348
349 struct bio_vec *bip_vec;
350 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200351};
Martin K. Petersen18593082014-09-26 19:20:01 -0400352
Keith Busch06c1e392015-12-03 09:32:21 -0700353#if defined(CONFIG_BLK_DEV_INTEGRITY)
354
355static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
356{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600357 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700358 return bio->bi_integrity;
359
360 return NULL;
361}
362
Martin K. Petersenc6115292014-09-26 19:20:08 -0400363static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
364{
365 struct bio_integrity_payload *bip = bio_integrity(bio);
366
367 if (bip)
368 return bip->bip_flags & flag;
369
370 return false;
371}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400372
Martin K. Petersen18593082014-09-26 19:20:01 -0400373static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
374{
375 return bip->bip_iter.bi_sector;
376}
377
378static inline void bip_set_seed(struct bio_integrity_payload *bip,
379 sector_t seed)
380{
381 bip->bip_iter.bi_sector = seed;
382}
383
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200384#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Kent Overstreet6678d832013-08-07 11:14:32 -0700386extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800387extern struct bio *bio_split(struct bio *bio, int sectors,
388 gfp_t gfp, struct bio_set *bs);
389
390/**
391 * bio_next_split - get next @sectors from a bio, splitting if necessary
392 * @bio: bio to split
393 * @sectors: number of sectors to split from the front of @bio
394 * @gfp: gfp mask
395 * @bs: bio set to allocate from
396 *
397 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
398 * than @sectors, returns the original bio unchanged.
399 */
400static inline struct bio *bio_next_split(struct bio *bio, int sectors,
401 gfp_t gfp, struct bio_set *bs)
402{
403 if (sectors >= bio_sectors(bio))
404 return bio;
405
406 return bio_split(bio, sectors, gfp, bs);
407}
408
NeilBrown011067b2017-06-18 14:38:57 +1000409extern struct bio_set *bioset_create(unsigned int, unsigned int, int flags);
410enum {
411 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000412 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000413};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600415extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300417extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Kent Overstreet59d276f2013-11-23 18:19:27 -0800420extern void __bio_clone_fast(struct bio *, struct bio *);
421extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700422extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
423
Kent Overstreet3f86a822012-09-06 15:35:01 -0700424extern struct bio_set *fs_bio_set;
425
426static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
427{
428 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
429}
430
431static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
432{
433 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
434}
435
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700436static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
437{
438 return bio_clone_bioset(bio, gfp_mask, NULL);
439
440}
441
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600442extern blk_qc_t submit_bio(struct bio *);
443
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200444extern void bio_endio(struct bio *);
445
446static inline void bio_io_error(struct bio *bio)
447{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200448 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200449 bio_endio(bio);
450}
451
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500452static inline void bio_wouldblock_error(struct bio *bio)
453{
454 bio->bi_status = BLK_STS_AGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 bio_endio(bio);
456}
457
NeilBrown6712ecf2007-09-27 12:47:43 +0200458struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459extern int bio_phys_segments(struct request_queue *, struct bio *);
460
Mike Christie4e49ea42016-06-05 14:31:41 -0500461extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700462extern void bio_advance(struct bio *, unsigned);
463
Ming Lei3a83f462016-11-22 08:57:21 -0700464extern void bio_init(struct bio *bio, struct bio_vec *table,
465 unsigned short max_vecs);
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600466extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700467extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800468void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600471extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
472 unsigned int, unsigned int);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600473int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900474struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200475extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400476 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200478extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400479 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200480extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
481 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482extern void bio_set_pages_dirty(struct bio *bio);
483extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100484
Jens Axboed62e26b2017-06-30 21:55:08 -0600485void generic_start_io_acct(struct request_queue *q, int rw,
486 unsigned long sectors, struct hd_struct *part);
487void generic_end_io_acct(struct request_queue *q, int rw,
488 struct hd_struct *part,
489 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800490
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100491#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
492# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
493#endif
494#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
495extern void bio_flush_dcache_pages(struct bio *bi);
496#else
497static inline void bio_flush_dcache_pages(struct bio *bi)
498{
499}
500#endif
501
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700502extern void bio_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400503extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700504
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900505extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500506 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400507 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100508 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509extern int bio_uncopy_user(struct bio *);
510void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700511extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
512extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200513extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800514extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200515
Christoph Hellwig74d46992017-08-23 19:10:32 +0200516#define bio_set_dev(bio, bdev) \
517do { \
Shaohua Li111be882017-12-20 11:10:17 -0700518 if ((bio)->bi_disk != (bdev)->bd_disk) \
519 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200520 (bio)->bi_disk = (bdev)->bd_disk; \
521 (bio)->bi_partno = (bdev)->bd_partno; \
522} while (0)
523
524#define bio_copy_dev(dst, src) \
525do { \
526 (dst)->bi_disk = (src)->bi_disk; \
527 (dst)->bi_partno = (src)->bi_partno; \
528} while (0)
529
530#define bio_dev(bio) \
531 disk_devt((bio)->bi_disk)
532
Tejun Heo852c7882012-03-05 13:15:27 -0800533#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400534int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800535void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200536void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800537#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400538static inline int bio_associate_blkcg(struct bio *bio,
539 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800540static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200541static inline void bio_clone_blkcg_association(struct bio *dst,
542 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800543#endif /* CONFIG_BLK_CGROUP */
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545#ifdef CONFIG_HIGHMEM
546/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100547 * remember never ever reenable interrupts between a bvec_kmap_irq and
548 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100550static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
552 unsigned long addr;
553
554 /*
555 * might not be a highmem page, but the preempt/irq count
556 * balancing is a lot nicer this way
557 */
558 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800559 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561 BUG_ON(addr & ~PAGE_MASK);
562
563 return (char *) addr + bvec->bv_offset;
564}
565
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100566static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
568 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
569
Cong Wange8e3c3d2011-11-25 23:14:27 +0800570 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 local_irq_restore(*flags);
572}
573
574#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200575static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
576{
577 return page_address(bvec->bv_page) + bvec->bv_offset;
578}
579
580static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
581{
582 *flags = 0;
583}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#endif
585
Jens Axboe7a67f632008-08-08 11:17:12 +0200586/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200587 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200588 *
589 * A bio_list anchors a singly-linked list of bios chained through the bi_next
590 * member of the bio. The bio_list also caches the last list member to allow
591 * fast access to the tail.
592 */
593struct bio_list {
594 struct bio *head;
595 struct bio *tail;
596};
597
598static inline int bio_list_empty(const struct bio_list *bl)
599{
600 return bl->head == NULL;
601}
602
603static inline void bio_list_init(struct bio_list *bl)
604{
605 bl->head = bl->tail = NULL;
606}
607
Jens Axboe320ae512013-10-24 09:20:05 +0100608#define BIO_EMPTY_LIST { NULL, NULL }
609
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200610#define bio_list_for_each(bio, bl) \
611 for (bio = (bl)->head; bio; bio = bio->bi_next)
612
613static inline unsigned bio_list_size(const struct bio_list *bl)
614{
615 unsigned sz = 0;
616 struct bio *bio;
617
618 bio_list_for_each(bio, bl)
619 sz++;
620
621 return sz;
622}
623
624static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
625{
626 bio->bi_next = NULL;
627
628 if (bl->tail)
629 bl->tail->bi_next = bio;
630 else
631 bl->head = bio;
632
633 bl->tail = bio;
634}
635
636static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
637{
638 bio->bi_next = bl->head;
639
640 bl->head = bio;
641
642 if (!bl->tail)
643 bl->tail = bio;
644}
645
646static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
647{
648 if (!bl2->head)
649 return;
650
651 if (bl->tail)
652 bl->tail->bi_next = bl2->head;
653 else
654 bl->head = bl2->head;
655
656 bl->tail = bl2->tail;
657}
658
659static inline void bio_list_merge_head(struct bio_list *bl,
660 struct bio_list *bl2)
661{
662 if (!bl2->head)
663 return;
664
665 if (bl->head)
666 bl2->tail->bi_next = bl->head;
667 else
668 bl->tail = bl2->tail;
669
670 bl->head = bl2->head;
671}
672
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000673static inline struct bio *bio_list_peek(struct bio_list *bl)
674{
675 return bl->head;
676}
677
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200678static inline struct bio *bio_list_pop(struct bio_list *bl)
679{
680 struct bio *bio = bl->head;
681
682 if (bio) {
683 bl->head = bl->head->bi_next;
684 if (!bl->head)
685 bl->tail = NULL;
686
687 bio->bi_next = NULL;
688 }
689
690 return bio;
691}
692
693static inline struct bio *bio_list_get(struct bio_list *bl)
694{
695 struct bio *bio = bl->head;
696
697 bl->head = bl->tail = NULL;
698
699 return bio;
700}
701
Kent Overstreet57fb2332012-08-24 04:56:11 -0700702/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400703 * Increment chain count for the bio. Make sure the CHAIN flag update
704 * is visible before the raised count.
705 */
706static inline void bio_inc_remaining(struct bio *bio)
707{
708 bio_set_flag(bio, BIO_CHAIN);
709 smp_mb__before_atomic();
710 atomic_inc(&bio->__bi_remaining);
711}
712
713/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700714 * bio_set is used to allow other portions of the IO system to
715 * allocate their own private memory pools for bio and iovec structures.
716 * These memory pools in turn all allocate from the bio_slab
717 * and the bvec_slabs[].
718 */
719#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700720
721struct bio_set {
722 struct kmem_cache *bio_slab;
723 unsigned int front_pad;
724
725 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700726 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700727#if defined(CONFIG_BLK_DEV_INTEGRITY)
728 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700729 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700730#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700731
732 /*
733 * Deadlock avoidance for stacking block drivers: see comments in
734 * bio_alloc_bioset() for details
735 */
736 spinlock_t rescue_lock;
737 struct bio_list rescue_list;
738 struct work_struct rescue_work;
739 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700740};
741
742struct biovec_slab {
743 int nr_vecs;
744 char *name;
745 struct kmem_cache *slab;
746};
747
748/*
749 * a small number of entries is fine, not going to be performance critical.
750 * basically we just need to survive
751 */
752#define BIO_SPLIT_ENTRIES 2
753
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200754#if defined(CONFIG_BLK_DEV_INTEGRITY)
755
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800756#define bip_for_each_vec(bvl, bip, iter) \
757 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200758
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200759#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
760 for_each_bio(_bio) \
761 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
762
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200763extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200764extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700765extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200766extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700767extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700768extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200769extern int bioset_integrity_create(struct bio_set *, int);
770extern void bioset_integrity_free(struct bio_set *);
771extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200772
773#else /* CONFIG_BLK_DEV_INTEGRITY */
774
Martin K. Petersenc6115292014-09-26 19:20:08 -0400775static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100776{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400777 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100778}
779
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100780static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
781{
782 return 0;
783}
784
785static inline void bioset_integrity_free (struct bio_set *bs)
786{
787 return;
788}
789
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700790static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100791{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700792 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100793}
794
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100795static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700796 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100797{
798 return 0;
799}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100800
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100801static inline void bio_integrity_advance(struct bio *bio,
802 unsigned int bytes_done)
803{
804 return;
805}
806
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700807static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100808{
809 return;
810}
811
812static inline void bio_integrity_init(void)
813{
814 return;
815}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200816
Martin K. Petersenc6115292014-09-26 19:20:08 -0400817static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
818{
819 return false;
820}
821
Keith Busch06c1e392015-12-03 09:32:21 -0700822static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
823 unsigned int nr)
824{
825 return ERR_PTR(-EINVAL);
826}
827
828static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
829 unsigned int len, unsigned int offset)
830{
831 return 0;
832}
833
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200834#endif /* CONFIG_BLK_DEV_INTEGRITY */
835
David Howells02a5e0a2007-08-11 22:34:32 +0200836#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837#endif /* __LINUX_BIO_H */