blob: 84abd1706dcb86cbd56014f3a297615cb3bffdbb [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
130/*
131 * will die
132 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
134
135/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * 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
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700168 if (bio_no_advance_iter(bio)) {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700169 iter->bi_size -= bytes;
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700170 iter->bi_done += bytes;
171 } else {
Kent Overstreet4550dd62013-08-07 14:26:21 -0700172 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
Dmitry Monakhovb1fb2c52017-06-29 11:31:13 -0700173 /* TODO: It is reasonable to complete bio with error here. */
174 }
Kent Overstreet4550dd62013-08-07 14:26:21 -0700175}
176
Dmitry Monakhovf9df1cd2017-06-29 11:31:14 -0700177static inline bool bio_rewind_iter(struct bio *bio, struct bvec_iter *iter,
178 unsigned int bytes)
179{
180 iter->bi_sector -= bytes >> 9;
181
182 if (bio_no_advance_iter(bio)) {
183 iter->bi_size += bytes;
184 iter->bi_done -= bytes;
185 return true;
186 }
187
188 return bvec_iter_rewind(bio->bi_io_vec, iter, bytes);
189}
190
Kent Overstreet79886132013-11-23 17:19:00 -0800191#define __bio_for_each_segment(bvl, bio, iter, start) \
192 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700193 (iter).bi_size && \
194 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
195 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800196
197#define bio_for_each_segment(bvl, bio, iter) \
198 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
199
Kent Overstreet4550dd62013-08-07 14:26:21 -0700200#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Shaohua Lif4595872017-03-24 10:34:43 -0700202static inline unsigned bio_segments(struct bio *bio)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700203{
204 unsigned segs = 0;
205 struct bio_vec bv;
206 struct bvec_iter iter;
207
Kent Overstreet8423ae32014-02-10 17:45:50 -0800208 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800209 * We special case discard/write same/write zeroes, because they
210 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800211 */
212
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800213 switch (bio_op(bio)) {
214 case REQ_OP_DISCARD:
215 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800216 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700217 return 0;
218 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800219 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800220 default:
221 break;
222 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800223
Shaohua Lif4595872017-03-24 10:34:43 -0700224 bio_for_each_segment(bv, bio, iter)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700225 segs++;
226
227 return segs;
228}
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230/*
231 * get a reference to a bio, so it won't disappear. the intended use is
232 * something like:
233 *
234 * bio_get(bio);
235 * submit_bio(rw, bio);
236 * if (bio->bi_flags ...)
237 * do_something
238 * bio_put(bio);
239 *
240 * without the bio_get(), it could potentially complete I/O before submit_bio
241 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
242 * runs
243 */
Jens Axboedac56212015-04-17 16:23:59 -0600244static inline void bio_get(struct bio *bio)
245{
246 bio->bi_flags |= (1 << BIO_REFFED);
247 smp_mb__before_atomic();
248 atomic_inc(&bio->__bi_cnt);
249}
250
251static inline void bio_cnt_set(struct bio *bio, unsigned int count)
252{
253 if (count != 1) {
254 bio->bi_flags |= (1 << BIO_REFFED);
255 smp_mb__before_atomic();
256 }
257 atomic_set(&bio->__bi_cnt, count);
258}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600260static inline bool bio_flagged(struct bio *bio, unsigned int bit)
261{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600262 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600263}
264
265static inline void bio_set_flag(struct bio *bio, unsigned int bit)
266{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600267 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600268}
269
270static inline void bio_clear_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
Ming Lei7bcd79a2016-02-26 23:40:50 +0800275static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
276{
277 *bv = bio_iovec(bio);
278}
279
280static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
281{
282 struct bvec_iter iter = bio->bi_iter;
283 int idx;
284
Ming Lei7bcd79a2016-02-26 23:40:50 +0800285 if (unlikely(!bio_multiple_segments(bio))) {
286 *bv = bio_iovec(bio);
287 return;
288 }
289
290 bio_advance_iter(bio, &iter, iter.bi_size);
291
292 if (!iter.bi_bvec_done)
293 idx = iter.bi_idx - 1;
294 else /* in the middle of bvec */
295 idx = iter.bi_idx;
296
297 *bv = bio->bi_io_vec[idx];
298
299 /*
300 * iter.bi_bvec_done records actual length of the last bvec
301 * if this bio ends in the middle of one io vector
302 */
303 if (iter.bi_bvec_done)
304 bv->bv_len = iter.bi_bvec_done;
305}
306
Ming Lei86292ab2017-12-18 20:22:03 +0800307static inline unsigned bio_pages_all(struct bio *bio)
308{
309 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
310 return bio->bi_vcnt;
311}
312
313static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
314{
315 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
316 return bio->bi_io_vec;
317}
318
319static inline struct page *bio_first_page_all(struct bio *bio)
320{
321 return bio_first_bvec_all(bio)->bv_page;
322}
323
324static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
325{
326 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
327 return &bio->bi_io_vec[bio->bi_vcnt - 1];
328}
329
Martin K. Petersenc6115292014-09-26 19:20:08 -0400330enum bip_flags {
331 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
332 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
333 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
334 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
335 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
336};
337
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200338/*
339 * bio integrity payload
340 */
341struct bio_integrity_payload {
342 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200343
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800344 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200345
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200346 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200347 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600348 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400349 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200350
351 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700352
353 struct bio_vec *bip_vec;
354 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200355};
Martin K. Petersen18593082014-09-26 19:20:01 -0400356
Keith Busch06c1e392015-12-03 09:32:21 -0700357#if defined(CONFIG_BLK_DEV_INTEGRITY)
358
359static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
360{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600361 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700362 return bio->bi_integrity;
363
364 return NULL;
365}
366
Martin K. Petersenc6115292014-09-26 19:20:08 -0400367static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
368{
369 struct bio_integrity_payload *bip = bio_integrity(bio);
370
371 if (bip)
372 return bip->bip_flags & flag;
373
374 return false;
375}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400376
Martin K. Petersen18593082014-09-26 19:20:01 -0400377static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
378{
379 return bip->bip_iter.bi_sector;
380}
381
382static inline void bip_set_seed(struct bio_integrity_payload *bip,
383 sector_t seed)
384{
385 bip->bip_iter.bi_sector = seed;
386}
387
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200388#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Kent Overstreet6678d832013-08-07 11:14:32 -0700390extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800391extern struct bio *bio_split(struct bio *bio, int sectors,
392 gfp_t gfp, struct bio_set *bs);
393
394/**
395 * bio_next_split - get next @sectors from a bio, splitting if necessary
396 * @bio: bio to split
397 * @sectors: number of sectors to split from the front of @bio
398 * @gfp: gfp mask
399 * @bs: bio set to allocate from
400 *
401 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
402 * than @sectors, returns the original bio unchanged.
403 */
404static inline struct bio *bio_next_split(struct bio *bio, int sectors,
405 gfp_t gfp, struct bio_set *bs)
406{
407 if (sectors >= bio_sectors(bio))
408 return bio;
409
410 return bio_split(bio, sectors, gfp, bs);
411}
412
NeilBrown011067b2017-06-18 14:38:57 +1000413enum {
414 BIOSET_NEED_BVECS = BIT(0),
NeilBrown47e0fb42017-06-18 14:38:57 +1000415 BIOSET_NEED_RESCUER = BIT(1),
NeilBrown011067b2017-06-18 14:38:57 +1000416};
Kent Overstreetdad08522018-05-20 18:25:58 -0400417extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
418extern void bioset_exit(struct bio_set *);
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400419extern int biovec_init_pool(mempool_t *pool, int pool_entries);
Jens Axboe28e89fd92018-06-07 14:42:05 -0600420extern int bioset_init_from_src(struct bio_set *bs, struct bio_set *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300422extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Kent Overstreet59d276f2013-11-23 18:19:27 -0800425extern void __bio_clone_fast(struct bio *, struct bio *);
426extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700427extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
428
Kent Overstreetf4f81542018-05-08 21:33:52 -0400429extern struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700430
431static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
432{
Kent Overstreetf4f81542018-05-08 21:33:52 -0400433 return bio_alloc_bioset(gfp_mask, nr_iovecs, &fs_bio_set);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700434}
435
436static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
437{
438 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
439}
440
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700441static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
442{
443 return bio_clone_bioset(bio, gfp_mask, NULL);
444
445}
446
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600447extern blk_qc_t submit_bio(struct bio *);
448
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200449extern void bio_endio(struct bio *);
450
451static inline void bio_io_error(struct bio *bio)
452{
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200453 bio->bi_status = BLK_STS_IOERR;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200454 bio_endio(bio);
455}
456
Goldwyn Rodrigues03a07c92017-06-20 07:05:46 -0500457static inline void bio_wouldblock_error(struct bio *bio)
458{
459 bio->bi_status = BLK_STS_AGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 bio_endio(bio);
461}
462
NeilBrown6712ecf2007-09-27 12:47:43 +0200463struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464extern int bio_phys_segments(struct request_queue *, struct bio *);
465
Mike Christie4e49ea42016-06-05 14:31:41 -0500466extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700467extern void bio_advance(struct bio *, unsigned);
468
Ming Lei3a83f462016-11-22 08:57:21 -0700469extern void bio_init(struct bio *bio, struct bio_vec *table,
470 unsigned short max_vecs);
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600471extern void bio_uninit(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700472extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800473void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600476extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
477 unsigned int, unsigned int);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600478int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900479struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200480extern struct bio *bio_map_user_iov(struct request_queue *,
Al Viroe81cef52017-09-24 09:25:39 -0400481 struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200483extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400484 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200485extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
486 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487extern void bio_set_pages_dirty(struct bio *bio);
488extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100489
Jens Axboed62e26b2017-06-30 21:55:08 -0600490void generic_start_io_acct(struct request_queue *q, int rw,
491 unsigned long sectors, struct hd_struct *part);
492void generic_end_io_acct(struct request_queue *q, int rw,
493 struct hd_struct *part,
494 unsigned long start_time);
Gu Zheng394ffa52014-11-24 11:05:22 +0800495
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100496#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
497# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
498#endif
499#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
500extern void bio_flush_dcache_pages(struct bio *bi);
501#else
502static inline void bio_flush_dcache_pages(struct bio *bi)
503{
504}
505#endif
506
Kent Overstreet45db54d2018-05-08 21:33:54 -0400507extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
508 struct bio *src, struct bvec_iter *src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700509extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreet45db54d2018-05-08 21:33:54 -0400510extern void bio_list_copy_data(struct bio *dst, struct bio *src);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400511extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700512
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900513extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500514 struct rq_map_data *,
Al Viroe81cef52017-09-24 09:25:39 -0400515 struct iov_iter *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100516 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517extern int bio_uncopy_user(struct bio *);
Kent Overstreet38a72da2018-05-08 21:33:53 -0400518void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
519
520static inline void zero_fill_bio(struct bio *bio)
521{
522 zero_fill_bio_iter(bio, bio->bi_iter);
523}
524
Kent Overstreet9f060e22012-10-12 15:29:33 -0700525extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
526extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200527extern unsigned int bvec_nr_vecs(unsigned short idx);
Jiufei Xue9c0fb1e2018-02-27 20:10:18 +0800528extern const char *bio_devname(struct bio *bio, char *buffer);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200529
Christoph Hellwig74d46992017-08-23 19:10:32 +0200530#define bio_set_dev(bio, bdev) \
531do { \
Shaohua Li111be882017-12-20 11:10:17 -0700532 if ((bio)->bi_disk != (bdev)->bd_disk) \
533 bio_clear_flag(bio, BIO_THROTTLED);\
Christoph Hellwig74d46992017-08-23 19:10:32 +0200534 (bio)->bi_disk = (bdev)->bd_disk; \
535 (bio)->bi_partno = (bdev)->bd_partno; \
536} while (0)
537
538#define bio_copy_dev(dst, src) \
539do { \
540 (dst)->bi_disk = (src)->bi_disk; \
541 (dst)->bi_partno = (src)->bi_partno; \
542} while (0)
543
544#define bio_dev(bio) \
545 disk_devt((bio)->bi_disk)
546
Tejun Heo852c7882012-03-05 13:15:27 -0800547#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400548int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800549void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200550void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800551#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400552static inline int bio_associate_blkcg(struct bio *bio,
553 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800554static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200555static inline void bio_clone_blkcg_association(struct bio *dst,
556 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800557#endif /* CONFIG_BLK_CGROUP */
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559#ifdef CONFIG_HIGHMEM
560/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100561 * remember never ever reenable interrupts between a bvec_kmap_irq and
562 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100564static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
566 unsigned long addr;
567
568 /*
569 * might not be a highmem page, but the preempt/irq count
570 * balancing is a lot nicer this way
571 */
572 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800573 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 BUG_ON(addr & ~PAGE_MASK);
576
577 return (char *) addr + bvec->bv_offset;
578}
579
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100580static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
582 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
583
Cong Wange8e3c3d2011-11-25 23:14:27 +0800584 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 local_irq_restore(*flags);
586}
587
588#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200589static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
590{
591 return page_address(bvec->bv_page) + bvec->bv_offset;
592}
593
594static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
595{
596 *flags = 0;
597}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598#endif
599
Jens Axboe7a67f632008-08-08 11:17:12 +0200600/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200601 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200602 *
603 * A bio_list anchors a singly-linked list of bios chained through the bi_next
604 * member of the bio. The bio_list also caches the last list member to allow
605 * fast access to the tail.
606 */
607struct bio_list {
608 struct bio *head;
609 struct bio *tail;
610};
611
612static inline int bio_list_empty(const struct bio_list *bl)
613{
614 return bl->head == NULL;
615}
616
617static inline void bio_list_init(struct bio_list *bl)
618{
619 bl->head = bl->tail = NULL;
620}
621
Jens Axboe320ae512013-10-24 09:20:05 +0100622#define BIO_EMPTY_LIST { NULL, NULL }
623
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200624#define bio_list_for_each(bio, bl) \
625 for (bio = (bl)->head; bio; bio = bio->bi_next)
626
627static inline unsigned bio_list_size(const struct bio_list *bl)
628{
629 unsigned sz = 0;
630 struct bio *bio;
631
632 bio_list_for_each(bio, bl)
633 sz++;
634
635 return sz;
636}
637
638static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
639{
640 bio->bi_next = NULL;
641
642 if (bl->tail)
643 bl->tail->bi_next = bio;
644 else
645 bl->head = bio;
646
647 bl->tail = bio;
648}
649
650static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
651{
652 bio->bi_next = bl->head;
653
654 bl->head = bio;
655
656 if (!bl->tail)
657 bl->tail = bio;
658}
659
660static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
661{
662 if (!bl2->head)
663 return;
664
665 if (bl->tail)
666 bl->tail->bi_next = bl2->head;
667 else
668 bl->head = bl2->head;
669
670 bl->tail = bl2->tail;
671}
672
673static inline void bio_list_merge_head(struct bio_list *bl,
674 struct bio_list *bl2)
675{
676 if (!bl2->head)
677 return;
678
679 if (bl->head)
680 bl2->tail->bi_next = bl->head;
681 else
682 bl->tail = bl2->tail;
683
684 bl->head = bl2->head;
685}
686
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000687static inline struct bio *bio_list_peek(struct bio_list *bl)
688{
689 return bl->head;
690}
691
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200692static inline struct bio *bio_list_pop(struct bio_list *bl)
693{
694 struct bio *bio = bl->head;
695
696 if (bio) {
697 bl->head = bl->head->bi_next;
698 if (!bl->head)
699 bl->tail = NULL;
700
701 bio->bi_next = NULL;
702 }
703
704 return bio;
705}
706
707static inline struct bio *bio_list_get(struct bio_list *bl)
708{
709 struct bio *bio = bl->head;
710
711 bl->head = bl->tail = NULL;
712
713 return bio;
714}
715
Kent Overstreet57fb2332012-08-24 04:56:11 -0700716/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400717 * Increment chain count for the bio. Make sure the CHAIN flag update
718 * is visible before the raised count.
719 */
720static inline void bio_inc_remaining(struct bio *bio)
721{
722 bio_set_flag(bio, BIO_CHAIN);
723 smp_mb__before_atomic();
724 atomic_inc(&bio->__bi_remaining);
725}
726
727/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700728 * bio_set is used to allow other portions of the IO system to
729 * allocate their own private memory pools for bio and iovec structures.
730 * These memory pools in turn all allocate from the bio_slab
731 * and the bvec_slabs[].
732 */
733#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700734
735struct bio_set {
736 struct kmem_cache *bio_slab;
737 unsigned int front_pad;
738
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400739 mempool_t bio_pool;
740 mempool_t bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700741#if defined(CONFIG_BLK_DEV_INTEGRITY)
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400742 mempool_t bio_integrity_pool;
743 mempool_t bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700744#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700745
746 /*
747 * Deadlock avoidance for stacking block drivers: see comments in
748 * bio_alloc_bioset() for details
749 */
750 spinlock_t rescue_lock;
751 struct bio_list rescue_list;
752 struct work_struct rescue_work;
753 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700754};
755
756struct biovec_slab {
757 int nr_vecs;
758 char *name;
759 struct kmem_cache *slab;
760};
761
Kent Overstreet338aa962018-05-20 18:25:47 -0400762static inline bool bioset_initialized(struct bio_set *bs)
763{
764 return bs->bio_slab != NULL;
765}
766
Kent Overstreet57fb2332012-08-24 04:56:11 -0700767/*
768 * a small number of entries is fine, not going to be performance critical.
769 * basically we just need to survive
770 */
771#define BIO_SPLIT_ENTRIES 2
772
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200773#if defined(CONFIG_BLK_DEV_INTEGRITY)
774
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800775#define bip_for_each_vec(bvl, bip, iter) \
776 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200777
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200778#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
779 for_each_bio(_bio) \
780 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
781
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200782extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200783extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700784extern bool bio_integrity_prep(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200785extern void bio_integrity_advance(struct bio *, unsigned int);
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700786extern void bio_integrity_trim(struct bio *);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700787extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200788extern int bioset_integrity_create(struct bio_set *, int);
789extern void bioset_integrity_free(struct bio_set *);
790extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200791
792#else /* CONFIG_BLK_DEV_INTEGRITY */
793
Martin K. Petersenc6115292014-09-26 19:20:08 -0400794static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100795{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400796 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100797}
798
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100799static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
800{
801 return 0;
802}
803
804static inline void bioset_integrity_free (struct bio_set *bs)
805{
806 return;
807}
808
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700809static inline bool bio_integrity_prep(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100810{
Dmitry Monakhove23947b2017-06-29 11:31:11 -0700811 return true;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100812}
813
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100814static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700815 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100816{
817 return 0;
818}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100819
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100820static inline void bio_integrity_advance(struct bio *bio,
821 unsigned int bytes_done)
822{
823 return;
824}
825
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -0700826static inline void bio_integrity_trim(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100827{
828 return;
829}
830
831static inline void bio_integrity_init(void)
832{
833 return;
834}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200835
Martin K. Petersenc6115292014-09-26 19:20:08 -0400836static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
837{
838 return false;
839}
840
Keith Busch06c1e392015-12-03 09:32:21 -0700841static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
842 unsigned int nr)
843{
844 return ERR_PTR(-EINVAL);
845}
846
847static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
848 unsigned int len, unsigned int offset)
849{
850 return 0;
851}
852
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200853#endif /* CONFIG_BLK_DEV_INTEGRITY */
854
David Howells02a5e0a2007-08-11 22:34:32 +0200855#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856#endif /* __LINUX_BIO_H */