blob: 51371740d2a8f08175c2fd69f454d943ae5ea968 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tejun Heo7cc01582010-08-03 13:14:58 +020010 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public Licens
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
17 */
18#ifndef __LINUX_BIO_H
19#define __LINUX_BIO_H
20
21#include <linux/highmem.h>
22#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020023#include <linux/ioprio.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050024#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
David Howells02a5e0a2007-08-11 22:34:32 +020026#ifdef CONFIG_BLOCK
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <asm/io.h>
29
Tejun Heo7cc01582010-08-03 13:14:58 +020030/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
31#include <linux/blk_types.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define BIO_DEBUG
34
35#ifdef BIO_DEBUG
36#define BIO_BUG_ON BUG_ON
37#else
38#define BIO_BUG_ON
39#endif
40
Huang Ying225311a2017-09-06 16:22:30 -070041#ifdef CONFIG_THP_SWAP
42#if HPAGE_PMD_NR > 256
43#define BIO_MAX_PAGES HPAGE_PMD_NR
44#else
Alexey Dobriyand84a8472006-06-25 05:49:32 -070045#define BIO_MAX_PAGES 256
Huang Ying225311a2017-09-06 16:22:30 -070046#endif
47#else
48#define BIO_MAX_PAGES 256
49#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Mike Christie43b62ce2016-06-05 14:32:20 -050051#define bio_prio(bio) (bio)->bi_ioprio
52#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020053
Kent Overstreet4550dd62013-08-07 14:26:21 -070054#define bio_iter_iovec(bio, iter) \
55 bvec_iter_bvec((bio)->bi_io_vec, (iter))
56
57#define bio_iter_page(bio, iter) \
58 bvec_iter_page((bio)->bi_io_vec, (iter))
59#define bio_iter_len(bio, iter) \
60 bvec_iter_len((bio)->bi_io_vec, (iter))
61#define bio_iter_offset(bio, iter) \
62 bvec_iter_offset((bio)->bi_io_vec, (iter))
63
64#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
65#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
66#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080067
Kent Overstreet458b76e2013-09-24 16:26:05 -070068#define bio_multiple_segments(bio) \
69 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet38a72da2018-05-08 21:33:53 -040070
71#define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
72#define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
73
74#define bio_sectors(bio) bvec_iter_sectors((bio)->bi_iter)
75#define bio_end_sector(bio) bvec_iter_end_sector((bio)->bi_iter)
Jens Axboebf2de6f2007-09-27 13:01:25 +020076
Kent Overstreet458b76e2013-09-24 16:26:05 -070077/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060078 * Return the data direction, READ or WRITE.
79 */
80#define bio_data_dir(bio) \
81 (op_is_write(bio_op(bio)) ? WRITE : READ)
82
83/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070084 * Check whether this bio carries any data or not. A NULL bio is allowed.
85 */
86static inline bool bio_has_data(struct bio *bio)
87{
88 if (bio &&
89 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030090 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080091 bio_op(bio) != REQ_OP_SECURE_ERASE &&
92 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070093 return true;
94
95 return false;
96}
97
Mike Christie95fe6c12016-06-05 14:31:48 -050098static inline bool bio_no_advance_iter(struct bio *bio)
99{
Adrian Hunter7afafc82016-08-16 10:59:35 +0300100 return bio_op(bio) == REQ_OP_DISCARD ||
101 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800102 bio_op(bio) == REQ_OP_WRITE_SAME ||
103 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -0500104}
105
Kent Overstreet458b76e2013-09-24 16:26:05 -0700106static inline bool bio_mergeable(struct bio *bio)
107{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600108 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700109 return false;
110
111 return true;
112}
113
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900114static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200115{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700116 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700117 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100118 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700119 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200120}
121
122static inline void *bio_data(struct bio *bio)
123{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700124 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200125 return page_address(bio_page(bio)) + bio_offset(bio);
126
127 return NULL;
128}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700130static inline bool bio_full(struct bio *bio)
131{
132 return bio->bi_vcnt >= bio->bi_max_vecs;
133}
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/*
136 * will die
137 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
139
140/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * merge helpers etc
142 */
143
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100144/* Default implementation of BIOVEC_PHYS_MERGEABLE */
145#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
146 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/*
149 * allow arch override, for eg virtualized architectures (put in asm/io.h)
150 */
151#ifndef BIOVEC_PHYS_MERGEABLE
152#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100153 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#endif
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
157 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
158#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400159 __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 -0700160
Jens Axboe66cb45a2014-06-24 16:22:24 -0600161/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800162 * drivers should _never_ use the all version - the bio may have been split
163 * before it got to the driver and the driver won't own all of it
164 */
165#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700166 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800167
Kent Overstreet4550dd62013-08-07 14:26:21 -0700168static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
169 unsigned bytes)
170{
171 iter->bi_sector += bytes >> 9;
172
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700173 if (bio_no_advance_iter(bio)) {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700174 iter->bi_size -= bytes;
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700175 iter->bi_done += bytes;
176 } else {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700177 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700178 /* TODO: It is reasonable to complete bio with error here. */
179 }
Kent Overstreet4550dd62013-08-07 14:26:21 -0700180}
181
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700182static inline bool bio_rewind_iter(struct bio *bio, struct bvec_iter *iter,
183 unsigned int bytes)
184{
185 iter->bi_sector -= bytes >> 9;
186
187 if (bio_no_advance_iter(bio)) {
188 iter->bi_size += bytes;
189 iter->bi_done -= bytes;
190 return true;
191 }
192
193 return bvec_iter_rewind(bio->bi_io_vec, iter, bytes);
194}
195
Kent Overstreet79886132013-11-23 17:19:00 -0800196#define __bio_for_each_segment(bvl, bio, iter, start) \
197 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700198 (iter).bi_size && \
199 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
200 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800201
202#define bio_for_each_segment(bvl, bio, iter) \
203 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
204
Kent Overstreet4550dd62013-08-07 14:26:21 -0700205#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Shaohua Lif4595872017-03-24 10:34:43 -0700207static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700208{
209 unsigned segs = 0;
210 struct bio_vec bv;
211 struct bvec_iter iter;
212
Kent Overstreet8423ae32014-02-10 17:45:50 -0800213 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800214 * We special case discard/write same/write zeroes, because they
215 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800216 */
217
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800218 switch (bio_op(bio)) {
219 case REQ_OP_DISCARD:
220 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800221 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700222 return 0;
223 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800224 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800225 default:
226 break;
227 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800228
Shaohua Lif4595872017-03-24 10:34:43 -0700229 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700230 segs++;
231
232 return segs;
233}
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235/*
236 * get a reference to a bio, so it won't disappear. the intended use is
237 * something like:
238 *
239 * bio_get(bio);
240 * submit_bio(rw, bio);
241 * if (bio->bi_flags ...)
242 * do_something
243 * bio_put(bio);
244 *
245 * without the bio_get(), it could potentially complete I/O before submit_bio
246 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
247 * runs
248 */
Jens Axboedac56212015-04-17 16:23:59 -0600249static inline void bio_get(struct bio *bio)
250{
251 bio->bi_flags |= (1 << BIO_REFFED);
252 smp_mb__before_atomic();
253 atomic_inc(&bio->__bi_cnt);
254}
255
256static inline void bio_cnt_set(struct bio *bio, unsigned int count)
257{
258 if (count != 1) {
259 bio->bi_flags |= (1 << BIO_REFFED);
260 smp_mb__before_atomic();
261 }
262 atomic_set(&bio->__bi_cnt, count);
263}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600265static inline bool bio_flagged(struct bio *bio, unsigned int bit)
266{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600267 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600268}
269
270static inline void bio_set_flag(struct bio *bio, unsigned int bit)
271{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600272 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600273}
274
275static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
276{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600277 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600278}
279
Ming Lei7bcd79a2016-02-26 23:40:50 +0800280static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
281{
282 *bv = bio_iovec(bio);
283}
284
285static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
286{
287 struct bvec_iter iter = bio->bi_iter;
288 int idx;
289
Ming Lei7bcd79a2016-02-26 23:40:50 +0800290 if (unlikely(!bio_multiple_segments(bio))) {
291 *bv = bio_iovec(bio);
292 return;
293 }
294
295 bio_advance_iter(bio, &iter, iter.bi_size);
296
297 if (!iter.bi_bvec_done)
298 idx = iter.bi_idx - 1;
299 else /* in the middle of bvec */
300 idx = iter.bi_idx;
301
302 *bv = bio->bi_io_vec[idx];
303
304 /*
305 * iter.bi_bvec_done records actual length of the last bvec
306 * if this bio ends in the middle of one io vector
307 */
308 if (iter.bi_bvec_done)
309 bv->bv_len = iter.bi_bvec_done;
310}
311
Ming Lei86292ab2017-12-18 20:22:03 +0800312static inline unsigned bio_pages_all(struct bio *bio)
313{
314 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
315 return bio->bi_vcnt;
316}
317
318static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
319{
320 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
321 return bio->bi_io_vec;
322}
323
324static inline struct page *bio_first_page_all(struct bio *bio)
325{
326 return bio_first_bvec_all(bio)->bv_page;
327}
328
329static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
330{
331 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
332 return &bio->bi_io_vec[bio->bi_vcnt - 1];
333}
334
Martin K. Petersenc6115292014-09-26 19:20:08 -0400335enum bip_flags {
336 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
337 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
338 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
339 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
340 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
341};
342
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200343/*
344 * bio integrity payload
345 */
346struct bio_integrity_payload {
347 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200348
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800349 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200350
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200351 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200352 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600353 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400354 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200355
356 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700357
358 struct bio_vec *bip_vec;
359 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200360};
Martin K. Petersen18593082014-09-26 19:20:01 -0400361
Keith Busch06c1e392015-12-03 09:32:21 -0700362#if defined(CONFIG_BLK_DEV_INTEGRITY)
363
364static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
365{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600366 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700367 return bio->bi_integrity;
368
369 return NULL;
370}
371
Martin K. Petersenc6115292014-09-26 19:20:08 -0400372static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
373{
374 struct bio_integrity_payload *bip = bio_integrity(bio);
375
376 if (bip)
377 return bip->bip_flags & flag;
378
379 return false;
380}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400381
Martin K. Petersen18593082014-09-26 19:20:01 -0400382static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
383{
384 return bip->bip_iter.bi_sector;
385}
386
387static inline void bip_set_seed(struct bio_integrity_payload *bip,
388 sector_t seed)
389{
390 bip->bip_iter.bi_sector = seed;
391}
392
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200393#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Kent Overstreet6678d832013-08-07 11:14:32 -0700395extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800396extern struct bio *bio_split(struct bio *bio, int sectors,
397 gfp_t gfp, struct bio_set *bs);
398
399/**
400 * bio_next_split - get next @sectors from a bio, splitting if necessary
401 * @bio: bio to split
402 * @sectors: number of sectors to split from the front of @bio
403 * @gfp: gfp mask
404 * @bs: bio set to allocate from
405 *
406 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
407 * than @sectors, returns the original bio unchanged.
408 */
409static inline struct bio *bio_next_split(struct bio *bio, int sectors,
410 gfp_t gfp, struct bio_set *bs)
411{
412 if (sectors >= bio_sectors(bio))
413 return bio;
414
415 return bio_split(bio, sectors, gfp, bs);
416}
417
NeilBrown011067b2017-06-18 14:38:57 +1000418enum {
419 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000420 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000421};
Kent Overstreetdad08522018-05-20 18:25:58 -0400422extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
423extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400424extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600425extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300427extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Kent Overstreet59d276f2013-11-23 18:19:27 -0800430extern void __bio_clone_fast(struct bio *, struct bio *);
431extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700432
Kent Overstreetf4f81542018-05-08 21:33:52 -0400433extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700434
435static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
436{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400437 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700438}
439
440static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
441{
442 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
443}
444
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600445extern blk_qc_t submit_bio(struct bio *);
446
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200447extern void bio_endio(struct bio *);
448
449static inline void bio_io_error(struct bio *bio)
450{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200451 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200452 bio_endio(bio);
453}
454
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500455static inline void bio_wouldblock_error(struct bio *bio)
456{
457 bio->bi_status = BLK_STS_AGAIN;
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700458 bio_endio(bio);
459}
NeilBrown6712ecf2007-09-27 12:47:43 +0200460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461struct request_queue;
462extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Mike Christie4e49ea42016-06-05 14:31:41 -0500464extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700465extern void bio_advance(struct bio *, unsigned);
466
Ming Lei3a83f462016-11-22 08:57:21 -0700467extern void bio_init(struct bio *bio, struct bio_vec *table,
468 unsigned short max_vecs);
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600469extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700470extern void bio_reset(struct bio *);
Kent Overstreet196d38b2013-11-23 18:34:15 -0800471void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600474extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
475 unsigned int, unsigned int);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700476bool __bio_try_merge_page(struct bio *bio, struct page *page,
477 unsigned int len, unsigned int off);
478void __bio_add_page(struct bio *bio, struct page *page,
479 unsigned int len, unsigned int off);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600480int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900481struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200482extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400483 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200485extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400486 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200487extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
488 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489extern void bio_set_pages_dirty(struct bio *bio);
490extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100491
Michael Callahanddcf35d2018-07-18 04:47:39 -0700492void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600493 unsigned long sectors, struct hd_struct *part);
Michael Callahanddcf35d2018-07-18 04:47:39 -0700494void generic_end_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -0600495 struct hd_struct *part,
496 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800497
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100498#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
499# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
500#endif
501#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
502extern void bio_flush_dcache_pages(struct bio *bi);
503#else
504static inline void bio_flush_dcache_pages(struct bio *bi)
505{
506}
507#endif
508
Kent Overstreet45db54d2018-05-08 21:33:54 -0400509extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
510 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700511extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400512extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400513extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700514
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900515extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500516 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400517 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100518 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519extern int bio_uncopy_user(struct bio *);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400520void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
521
522static inline void zero_fill_bio(struct bio *bio)
523{
524 zero_fill_bio_iter(bio, bio->bi_iter);
525}
526
Kent Overstreet9f060e22012-10-12 15:29:33 -0700527extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
528extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200529extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800530extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200531
Christoph Hellwig74d46992017-08-23 19:10:32 +0200532#define bio_set_dev(bio, bdev) \
533do { \
Shaohua Li111be882017-12-20 11:10:17 -0700534 if ((bio)->bi_disk != (bdev)->bd_disk) \
535 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200536 (bio)->bi_disk = (bdev)->bd_disk; \
537 (bio)->bi_partno = (bdev)->bd_partno; \
538} while (0)
539
540#define bio_copy_dev(dst, src) \
541do { \
542 (dst)->bi_disk = (src)->bi_disk; \
543 (dst)->bi_partno = (src)->bi_partno; \
544} while (0)
545
546#define bio_dev(bio) \
547 disk_devt((bio)->bi_disk)
548
Tejun Heo0d3bd882018-07-03 11:14:54 -0400549#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
550int bio_associate_blkcg_from_page(struct bio *bio, struct page *page);
551#else
552static inline int bio_associate_blkcg_from_page(struct bio *bio,
553 struct page *page) { return 0; }
554#endif
555
Tejun Heo852c7882012-03-05 13:15:27 -0800556#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400557int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Josef Bacik08e18ea2018-07-03 11:14:50 -0400558int bio_associate_blkg(struct bio *bio, struct blkcg_gq *blkg);
Tejun Heo852c7882012-03-05 13:15:27 -0800559void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200560void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800561#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400562static inline int bio_associate_blkcg(struct bio *bio,
563 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800564static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200565static inline void bio_clone_blkcg_association(struct bio *dst,
566 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800567#endif /* CONFIG_BLK_CGROUP */
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569#ifdef CONFIG_HIGHMEM
570/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100571 * remember never ever reenable interrupts between a bvec_kmap_irq and
572 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100574static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 unsigned long addr;
577
578 /*
579 * might not be a highmem page, but the preempt/irq count
580 * balancing is a lot nicer this way
581 */
582 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800583 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
585 BUG_ON(addr & ~PAGE_MASK);
586
587 return (char *) addr + bvec->bv_offset;
588}
589
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100590static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591{
592 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
593
Cong Wange8e3c3d2011-11-25 23:14:27 +0800594 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 local_irq_restore(*flags);
596}
597
598#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200599static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
600{
601 return page_address(bvec->bv_page) + bvec->bv_offset;
602}
603
604static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
605{
606 *flags = 0;
607}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608#endif
609
Jens Axboe7a67f632008-08-08 11:17:12 +0200610/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200611 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200612 *
613 * A bio_list anchors a singly-linked list of bios chained through the bi_next
614 * member of the bio. The bio_list also caches the last list member to allow
615 * fast access to the tail.
616 */
617struct bio_list {
618 struct bio *head;
619 struct bio *tail;
620};
621
622static inline int bio_list_empty(const struct bio_list *bl)
623{
624 return bl->head == NULL;
625}
626
627static inline void bio_list_init(struct bio_list *bl)
628{
629 bl->head = bl->tail = NULL;
630}
631
Jens Axboe320ae512013-10-24 09:20:05 +0100632#define BIO_EMPTY_LIST { NULL, NULL }
633
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200634#define bio_list_for_each(bio, bl) \
635 for (bio = (bl)->head; bio; bio = bio->bi_next)
636
637static inline unsigned bio_list_size(const struct bio_list *bl)
638{
639 unsigned sz = 0;
640 struct bio *bio;
641
642 bio_list_for_each(bio, bl)
643 sz++;
644
645 return sz;
646}
647
648static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
649{
650 bio->bi_next = NULL;
651
652 if (bl->tail)
653 bl->tail->bi_next = bio;
654 else
655 bl->head = bio;
656
657 bl->tail = bio;
658}
659
660static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
661{
662 bio->bi_next = bl->head;
663
664 bl->head = bio;
665
666 if (!bl->tail)
667 bl->tail = bio;
668}
669
670static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
671{
672 if (!bl2->head)
673 return;
674
675 if (bl->tail)
676 bl->tail->bi_next = bl2->head;
677 else
678 bl->head = bl2->head;
679
680 bl->tail = bl2->tail;
681}
682
683static inline void bio_list_merge_head(struct bio_list *bl,
684 struct bio_list *bl2)
685{
686 if (!bl2->head)
687 return;
688
689 if (bl->head)
690 bl2->tail->bi_next = bl->head;
691 else
692 bl->tail = bl2->tail;
693
694 bl->head = bl2->head;
695}
696
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000697static inline struct bio *bio_list_peek(struct bio_list *bl)
698{
699 return bl->head;
700}
701
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200702static inline struct bio *bio_list_pop(struct bio_list *bl)
703{
704 struct bio *bio = bl->head;
705
706 if (bio) {
707 bl->head = bl->head->bi_next;
708 if (!bl->head)
709 bl->tail = NULL;
710
711 bio->bi_next = NULL;
712 }
713
714 return bio;
715}
716
717static inline struct bio *bio_list_get(struct bio_list *bl)
718{
719 struct bio *bio = bl->head;
720
721 bl->head = bl->tail = NULL;
722
723 return bio;
724}
725
Kent Overstreet57fb2332012-08-24 04:56:11 -0700726/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400727 * Increment chain count for the bio. Make sure the CHAIN flag update
728 * is visible before the raised count.
729 */
730static inline void bio_inc_remaining(struct bio *bio)
731{
732 bio_set_flag(bio, BIO_CHAIN);
733 smp_mb__before_atomic();
734 atomic_inc(&bio->__bi_remaining);
735}
736
737/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700738 * bio_set is used to allow other portions of the IO system to
739 * allocate their own private memory pools for bio and iovec structures.
740 * These memory pools in turn all allocate from the bio_slab
741 * and the bvec_slabs[].
742 */
743#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700744
745struct bio_set {
746 struct kmem_cache *bio_slab;
747 unsigned int front_pad;
748
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400749 mempool_t bio_pool;
750 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700751#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400752 mempool_t bio_integrity_pool;
753 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700754#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700755
756 /*
757 * Deadlock avoidance for stacking block drivers: see comments in
758 * bio_alloc_bioset() for details
759 */
760 spinlock_t rescue_lock;
761 struct bio_list rescue_list;
762 struct work_struct rescue_work;
763 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700764};
765
766struct biovec_slab {
767 int nr_vecs;
768 char *name;
769 struct kmem_cache *slab;
770};
771
Kent Overstreet338aa962018-05-20 18:25:47 -0400772static inline bool bioset_initialized(struct bio_set *bs)
773{
774 return bs->bio_slab != NULL;
775}
776
Kent Overstreet57fb2332012-08-24 04:56:11 -0700777/*
778 * a small number of entries is fine, not going to be performance critical.
779 * basically we just need to survive
780 */
781#define BIO_SPLIT_ENTRIES 2
782
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200783#if defined(CONFIG_BLK_DEV_INTEGRITY)
784
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800785#define bip_for_each_vec(bvl, bip, iter) \
786 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200787
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200788#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
789 for_each_bio(_bio) \
790 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
791
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200792extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200793extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700794extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200795extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700796extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700797extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200798extern int bioset_integrity_create(struct bio_set *, int);
799extern void bioset_integrity_free(struct bio_set *);
800extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200801
802#else /* CONFIG_BLK_DEV_INTEGRITY */
803
Martin K. Petersenc6115292014-09-26 19:20:08 -0400804static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100805{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400806 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100807}
808
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100809static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
810{
811 return 0;
812}
813
814static inline void bioset_integrity_free (struct bio_set *bs)
815{
816 return;
817}
818
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700819static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100820{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700821 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100822}
823
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100824static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700825 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100826{
827 return 0;
828}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100829
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100830static inline void bio_integrity_advance(struct bio *bio,
831 unsigned int bytes_done)
832{
833 return;
834}
835
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700836static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100837{
838 return;
839}
840
841static inline void bio_integrity_init(void)
842{
843 return;
844}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200845
Martin K. Petersenc6115292014-09-26 19:20:08 -0400846static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
847{
848 return false;
849}
850
Keith Busch06c1e392015-12-03 09:32:21 -0700851static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
852 unsigned int nr)
853{
854 return ERR_PTR(-EINVAL);
855}
856
857static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
858 unsigned int len, unsigned int offset)
859{
860 return 0;
861}
862
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200863#endif /* CONFIG_BLK_DEV_INTEGRITY */
864
David Howells02a5e0a2007-08-11 22:34:32 +0200865#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866#endif /* __LINUX_BIO_H */