blob: 97cb48f03dc73ce701668891f3fd4f6f70ab9004 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tejun Heo7cc01582010-08-03 13:14:58 +020010 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public Licens
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
17 */
18#ifndef __LINUX_BIO_H
19#define __LINUX_BIO_H
20
21#include <linux/highmem.h>
22#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020023#include <linux/ioprio.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050024#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
David Howells02a5e0a2007-08-11 22:34:32 +020026#ifdef CONFIG_BLOCK
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <asm/io.h>
29
Tejun Heo7cc01582010-08-03 13:14:58 +020030/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
31#include <linux/blk_types.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define BIO_DEBUG
34
35#ifdef BIO_DEBUG
36#define BIO_BUG_ON BUG_ON
37#else
38#define BIO_BUG_ON
39#endif
40
Alexey Dobriyand84a8472006-06-25 05:49:32 -070041#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Mike Christie43b62ce2016-06-05 14:32:20 -050043#define bio_prio(bio) (bio)->bi_ioprio
44#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020045
Kent Overstreet4550dd62013-08-07 14:26:21 -070046#define bio_iter_iovec(bio, iter) \
47 bvec_iter_bvec((bio)->bi_io_vec, (iter))
48
49#define bio_iter_page(bio, iter) \
50 bvec_iter_page((bio)->bi_io_vec, (iter))
51#define bio_iter_len(bio, iter) \
52 bvec_iter_len((bio)->bi_io_vec, (iter))
53#define bio_iter_offset(bio, iter) \
54 bvec_iter_offset((bio)->bi_io_vec, (iter))
55
56#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
57#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
58#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080059
Kent Overstreet458b76e2013-09-24 16:26:05 -070060#define bio_multiple_segments(bio) \
61 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -070062#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
63#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +020064
Kent Overstreet458b76e2013-09-24 16:26:05 -070065/*
66 * Check whether this bio carries any data or not. A NULL bio is allowed.
67 */
68static inline bool bio_has_data(struct bio *bio)
69{
70 if (bio &&
71 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030072 bio_op(bio) != REQ_OP_DISCARD &&
73 bio_op(bio) != REQ_OP_SECURE_ERASE)
Kent Overstreet458b76e2013-09-24 16:26:05 -070074 return true;
75
76 return false;
77}
78
Mike Christie95fe6c12016-06-05 14:31:48 -050079static inline bool bio_no_advance_iter(struct bio *bio)
80{
Adrian Hunter7afafc82016-08-16 10:59:35 +030081 return bio_op(bio) == REQ_OP_DISCARD ||
82 bio_op(bio) == REQ_OP_SECURE_ERASE ||
83 bio_op(bio) == REQ_OP_WRITE_SAME;
Mike Christie95fe6c12016-06-05 14:31:48 -050084}
85
Kent Overstreet458b76e2013-09-24 16:26:05 -070086static inline bool bio_is_rw(struct bio *bio)
87{
88 if (!bio_has_data(bio))
89 return false;
90
Mike Christie95fe6c12016-06-05 14:31:48 -050091 if (bio_no_advance_iter(bio))
Kent Overstreet458b76e2013-09-24 16:26:05 -070092 return false;
93
94 return true;
95}
96
97static inline bool bio_mergeable(struct bio *bio)
98{
Jens Axboe1eff9d32016-08-05 15:35:16 -060099 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700100 return false;
101
102 return true;
103}
104
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900105static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200106{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700107 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700108 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100109 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700110 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200111}
112
113static inline void *bio_data(struct bio *bio)
114{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700115 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200116 return page_address(bio_page(bio)) + bio_offset(bio);
117
118 return NULL;
119}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121/*
122 * will die
123 */
124#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
125#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
126
127/*
128 * queues that have highmem support enabled may still need to revert to
129 * PIO transfers occasionally and thus map high pages temporarily. For
130 * permanent PIO fall back, user is probably better off disabling highmem
131 * I/O completely on that queue (see ide-dma for example)
132 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700133#define __bio_kmap_atomic(bio, iter) \
134 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
135 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Kent Overstreetf619d252013-08-07 14:30:33 -0700137#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/*
140 * merge helpers etc
141 */
142
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100143/* Default implementation of BIOVEC_PHYS_MERGEABLE */
144#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
145 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/*
148 * allow arch override, for eg virtualized architectures (put in asm/io.h)
149 */
150#ifndef BIOVEC_PHYS_MERGEABLE
151#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100152 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#endif
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
156 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
157#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400158 __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 -0700159
Jens Axboe66cb45a2014-06-24 16:22:24 -0600160/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800161 * drivers should _never_ use the all version - the bio may have been split
162 * before it got to the driver and the driver won't own all of it
163 */
164#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700165 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800166
Kent Overstreet4550dd62013-08-07 14:26:21 -0700167static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
168 unsigned bytes)
169{
170 iter->bi_sector += bytes >> 9;
171
Mike Christie95fe6c12016-06-05 14:31:48 -0500172 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700173 iter->bi_size -= bytes;
174 else
175 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
176}
177
Kent Overstreet79886132013-11-23 17:19:00 -0800178#define __bio_for_each_segment(bvl, bio, iter, start) \
179 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700180 (iter).bi_size && \
181 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
182 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800183
184#define bio_for_each_segment(bvl, bio, iter) \
185 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
186
Kent Overstreet4550dd62013-08-07 14:26:21 -0700187#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Kent Overstreet458b76e2013-09-24 16:26:05 -0700189static inline unsigned bio_segments(struct bio *bio)
190{
191 unsigned segs = 0;
192 struct bio_vec bv;
193 struct bvec_iter iter;
194
Kent Overstreet8423ae32014-02-10 17:45:50 -0800195 /*
196 * We special case discard/write same, because they interpret bi_size
197 * differently:
198 */
199
Mike Christie95fe6c12016-06-05 14:31:48 -0500200 if (bio_op(bio) == REQ_OP_DISCARD)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800201 return 1;
202
Adrian Hunter7afafc82016-08-16 10:59:35 +0300203 if (bio_op(bio) == REQ_OP_SECURE_ERASE)
204 return 1;
205
Mike Christie95fe6c12016-06-05 14:31:48 -0500206 if (bio_op(bio) == REQ_OP_WRITE_SAME)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800207 return 1;
208
Kent Overstreet458b76e2013-09-24 16:26:05 -0700209 bio_for_each_segment(bv, bio, iter)
210 segs++;
211
212 return segs;
213}
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215/*
216 * get a reference to a bio, so it won't disappear. the intended use is
217 * something like:
218 *
219 * bio_get(bio);
220 * submit_bio(rw, bio);
221 * if (bio->bi_flags ...)
222 * do_something
223 * bio_put(bio);
224 *
225 * without the bio_get(), it could potentially complete I/O before submit_bio
226 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
227 * runs
228 */
Jens Axboedac56212015-04-17 16:23:59 -0600229static inline void bio_get(struct bio *bio)
230{
231 bio->bi_flags |= (1 << BIO_REFFED);
232 smp_mb__before_atomic();
233 atomic_inc(&bio->__bi_cnt);
234}
235
236static inline void bio_cnt_set(struct bio *bio, unsigned int count)
237{
238 if (count != 1) {
239 bio->bi_flags |= (1 << BIO_REFFED);
240 smp_mb__before_atomic();
241 }
242 atomic_set(&bio->__bi_cnt, count);
243}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600245static inline bool bio_flagged(struct bio *bio, unsigned int bit)
246{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600247 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600248}
249
250static inline void bio_set_flag(struct bio *bio, unsigned int bit)
251{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600252 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600253}
254
255static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
256{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600257 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600258}
259
Ming Lei7bcd79a2016-02-26 23:40:50 +0800260static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
261{
262 *bv = bio_iovec(bio);
263}
264
265static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
266{
267 struct bvec_iter iter = bio->bi_iter;
268 int idx;
269
Ming Lei7bcd79a2016-02-26 23:40:50 +0800270 if (unlikely(!bio_multiple_segments(bio))) {
271 *bv = bio_iovec(bio);
272 return;
273 }
274
275 bio_advance_iter(bio, &iter, iter.bi_size);
276
277 if (!iter.bi_bvec_done)
278 idx = iter.bi_idx - 1;
279 else /* in the middle of bvec */
280 idx = iter.bi_idx;
281
282 *bv = bio->bi_io_vec[idx];
283
284 /*
285 * iter.bi_bvec_done records actual length of the last bvec
286 * if this bio ends in the middle of one io vector
287 */
288 if (iter.bi_bvec_done)
289 bv->bv_len = iter.bi_bvec_done;
290}
291
Martin K. Petersenc6115292014-09-26 19:20:08 -0400292enum bip_flags {
293 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
294 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
295 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
296 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
297 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
298};
299
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200300/*
301 * bio integrity payload
302 */
303struct bio_integrity_payload {
304 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800306 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200307
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800308 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200310 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200311 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600312 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400313 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200314
315 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700316
317 struct bio_vec *bip_vec;
318 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200319};
Martin K. Petersen18593082014-09-26 19:20:01 -0400320
Keith Busch06c1e392015-12-03 09:32:21 -0700321#if defined(CONFIG_BLK_DEV_INTEGRITY)
322
323static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
324{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600325 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700326 return bio->bi_integrity;
327
328 return NULL;
329}
330
Martin K. Petersenc6115292014-09-26 19:20:08 -0400331static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
332{
333 struct bio_integrity_payload *bip = bio_integrity(bio);
334
335 if (bip)
336 return bip->bip_flags & flag;
337
338 return false;
339}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400340
Martin K. Petersen18593082014-09-26 19:20:01 -0400341static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
342{
343 return bip->bip_iter.bi_sector;
344}
345
346static inline void bip_set_seed(struct bio_integrity_payload *bip,
347 sector_t seed)
348{
349 bip->bip_iter.bi_sector = seed;
350}
351
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200352#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Kent Overstreet6678d832013-08-07 11:14:32 -0700354extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800355extern struct bio *bio_split(struct bio *bio, int sectors,
356 gfp_t gfp, struct bio_set *bs);
357
358/**
359 * bio_next_split - get next @sectors from a bio, splitting if necessary
360 * @bio: bio to split
361 * @sectors: number of sectors to split from the front of @bio
362 * @gfp: gfp mask
363 * @bs: bio set to allocate from
364 *
365 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
366 * than @sectors, returns the original bio unchanged.
367 */
368static inline struct bio *bio_next_split(struct bio *bio, int sectors,
369 gfp_t gfp, struct bio_set *bs)
370{
371 if (sectors >= bio_sectors(bio))
372 return bio;
373
374 return bio_split(bio, sectors, gfp, bs);
375}
376
Jens Axboebb799ca2008-12-10 15:35:05 +0100377extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400378extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600380extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Al Virodd0fc662005-10-07 07:46:04 +0100382extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Kent Overstreet59d276f2013-11-23 18:19:27 -0800385extern void __bio_clone_fast(struct bio *, struct bio *);
386extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700387extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
388
Kent Overstreet3f86a822012-09-06 15:35:01 -0700389extern struct bio_set *fs_bio_set;
390
391static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
392{
393 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
394}
395
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700396static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
397{
398 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
399}
400
Kent Overstreet3f86a822012-09-06 15:35:01 -0700401static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
402{
403 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
404}
405
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700406static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
407{
408 return bio_clone_bioset(bio, gfp_mask, NULL);
409
410}
411
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200412extern void bio_endio(struct bio *);
413
414static inline void bio_io_error(struct bio *bio)
415{
416 bio->bi_error = -EIO;
417 bio_endio(bio);
418}
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420struct request_queue;
421extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Mike Christie4e49ea42016-06-05 14:31:41 -0500423extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700424extern void bio_advance(struct bio *, unsigned);
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426extern void bio_init(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700427extern void bio_reset(struct bio *);
Kent Overstreet196d38b2013-11-23 18:34:15 -0800428void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600431extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
432 unsigned int, unsigned int);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900433struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200434extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100435 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200437extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400438 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200439extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
440 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441extern void bio_set_pages_dirty(struct bio *bio);
442extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100443
Gu Zheng394ffa52014-11-24 11:05:22 +0800444void generic_start_io_acct(int rw, unsigned long sectors,
445 struct hd_struct *part);
446void generic_end_io_acct(int rw, struct hd_struct *part,
447 unsigned long start_time);
448
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100449#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
450# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
451#endif
452#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
453extern void bio_flush_dcache_pages(struct bio *bi);
454#else
455static inline void bio_flush_dcache_pages(struct bio *bi)
456{
457}
458#endif
459
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700460extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700461extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400462extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700463
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900464extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500465 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100466 const struct iov_iter *,
467 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468extern int bio_uncopy_user(struct bio *);
469void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700470extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
471extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200472extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200473
Tejun Heo852c7882012-03-05 13:15:27 -0800474#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400475int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800476int bio_associate_current(struct bio *bio);
477void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200478void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800479#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400480static inline int bio_associate_blkcg(struct bio *bio,
481 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800482static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
483static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200484static inline void bio_clone_blkcg_association(struct bio *dst,
485 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800486#endif /* CONFIG_BLK_CGROUP */
487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488#ifdef CONFIG_HIGHMEM
489/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100490 * remember never ever reenable interrupts between a bvec_kmap_irq and
491 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100493static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
495 unsigned long addr;
496
497 /*
498 * might not be a highmem page, but the preempt/irq count
499 * balancing is a lot nicer this way
500 */
501 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800502 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504 BUG_ON(addr & ~PAGE_MASK);
505
506 return (char *) addr + bvec->bv_offset;
507}
508
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100509static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
511 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
512
Cong Wange8e3c3d2011-11-25 23:14:27 +0800513 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 local_irq_restore(*flags);
515}
516
517#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200518static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
519{
520 return page_address(bvec->bv_page) + bvec->bv_offset;
521}
522
523static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
524{
525 *flags = 0;
526}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527#endif
528
Kent Overstreetf619d252013-08-07 14:30:33 -0700529static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 unsigned long *flags)
531{
Kent Overstreetf619d252013-08-07 14:30:33 -0700532 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
535
536#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700537 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
539
Jens Axboe7a67f632008-08-08 11:17:12 +0200540/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200541 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200542 *
543 * A bio_list anchors a singly-linked list of bios chained through the bi_next
544 * member of the bio. The bio_list also caches the last list member to allow
545 * fast access to the tail.
546 */
547struct bio_list {
548 struct bio *head;
549 struct bio *tail;
550};
551
552static inline int bio_list_empty(const struct bio_list *bl)
553{
554 return bl->head == NULL;
555}
556
557static inline void bio_list_init(struct bio_list *bl)
558{
559 bl->head = bl->tail = NULL;
560}
561
Jens Axboe320ae512013-10-24 09:20:05 +0100562#define BIO_EMPTY_LIST { NULL, NULL }
563
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200564#define bio_list_for_each(bio, bl) \
565 for (bio = (bl)->head; bio; bio = bio->bi_next)
566
567static inline unsigned bio_list_size(const struct bio_list *bl)
568{
569 unsigned sz = 0;
570 struct bio *bio;
571
572 bio_list_for_each(bio, bl)
573 sz++;
574
575 return sz;
576}
577
578static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
579{
580 bio->bi_next = NULL;
581
582 if (bl->tail)
583 bl->tail->bi_next = bio;
584 else
585 bl->head = bio;
586
587 bl->tail = bio;
588}
589
590static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
591{
592 bio->bi_next = bl->head;
593
594 bl->head = bio;
595
596 if (!bl->tail)
597 bl->tail = bio;
598}
599
600static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
601{
602 if (!bl2->head)
603 return;
604
605 if (bl->tail)
606 bl->tail->bi_next = bl2->head;
607 else
608 bl->head = bl2->head;
609
610 bl->tail = bl2->tail;
611}
612
613static inline void bio_list_merge_head(struct bio_list *bl,
614 struct bio_list *bl2)
615{
616 if (!bl2->head)
617 return;
618
619 if (bl->head)
620 bl2->tail->bi_next = bl->head;
621 else
622 bl->tail = bl2->tail;
623
624 bl->head = bl2->head;
625}
626
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000627static inline struct bio *bio_list_peek(struct bio_list *bl)
628{
629 return bl->head;
630}
631
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200632static inline struct bio *bio_list_pop(struct bio_list *bl)
633{
634 struct bio *bio = bl->head;
635
636 if (bio) {
637 bl->head = bl->head->bi_next;
638 if (!bl->head)
639 bl->tail = NULL;
640
641 bio->bi_next = NULL;
642 }
643
644 return bio;
645}
646
647static inline struct bio *bio_list_get(struct bio_list *bl)
648{
649 struct bio *bio = bl->head;
650
651 bl->head = bl->tail = NULL;
652
653 return bio;
654}
655
Kent Overstreet57fb2332012-08-24 04:56:11 -0700656/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400657 * Increment chain count for the bio. Make sure the CHAIN flag update
658 * is visible before the raised count.
659 */
660static inline void bio_inc_remaining(struct bio *bio)
661{
662 bio_set_flag(bio, BIO_CHAIN);
663 smp_mb__before_atomic();
664 atomic_inc(&bio->__bi_remaining);
665}
666
667/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700668 * bio_set is used to allow other portions of the IO system to
669 * allocate their own private memory pools for bio and iovec structures.
670 * These memory pools in turn all allocate from the bio_slab
671 * and the bvec_slabs[].
672 */
673#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700674
675struct bio_set {
676 struct kmem_cache *bio_slab;
677 unsigned int front_pad;
678
679 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700680 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700681#if defined(CONFIG_BLK_DEV_INTEGRITY)
682 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700683 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700684#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700685
686 /*
687 * Deadlock avoidance for stacking block drivers: see comments in
688 * bio_alloc_bioset() for details
689 */
690 spinlock_t rescue_lock;
691 struct bio_list rescue_list;
692 struct work_struct rescue_work;
693 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700694};
695
696struct biovec_slab {
697 int nr_vecs;
698 char *name;
699 struct kmem_cache *slab;
700};
701
702/*
703 * a small number of entries is fine, not going to be performance critical.
704 * basically we just need to survive
705 */
706#define BIO_SPLIT_ENTRIES 2
707
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200708#if defined(CONFIG_BLK_DEV_INTEGRITY)
709
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800710#define bip_for_each_vec(bvl, bip, iter) \
711 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200712
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200713#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
714 for_each_bio(_bio) \
715 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
716
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200717extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700718extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200719extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400720extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200721extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200722extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200723extern void bio_integrity_advance(struct bio *, unsigned int);
724extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700725extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200726extern int bioset_integrity_create(struct bio_set *, int);
727extern void bioset_integrity_free(struct bio_set *);
728extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200729
730#else /* CONFIG_BLK_DEV_INTEGRITY */
731
Martin K. Petersenc6115292014-09-26 19:20:08 -0400732static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100733{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400734 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100735}
736
Martin K. Petersene7258c12014-09-26 19:19:55 -0400737static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100738{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400739 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100740}
741
742static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
743{
744 return 0;
745}
746
747static inline void bioset_integrity_free (struct bio_set *bs)
748{
749 return;
750}
751
752static inline int bio_integrity_prep(struct bio *bio)
753{
754 return 0;
755}
756
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700757static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100758{
759 return;
760}
761
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100762static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700763 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100764{
765 return 0;
766}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100767
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100768static inline void bio_integrity_advance(struct bio *bio,
769 unsigned int bytes_done)
770{
771 return;
772}
773
774static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
775 unsigned int sectors)
776{
777 return;
778}
779
780static inline void bio_integrity_init(void)
781{
782 return;
783}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200784
Martin K. Petersenc6115292014-09-26 19:20:08 -0400785static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
786{
787 return false;
788}
789
Keith Busch06c1e392015-12-03 09:32:21 -0700790static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
791 unsigned int nr)
792{
793 return ERR_PTR(-EINVAL);
794}
795
796static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
797 unsigned int len, unsigned int offset)
798{
799 return 0;
800}
801
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200802#endif /* CONFIG_BLK_DEV_INTEGRITY */
803
David Howells02a5e0a2007-08-11 22:34:32 +0200804#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805#endif /* __LINUX_BIO_H */