blob: 23ddf4b46a9b016ef7adab062604c2b08f5563f7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * 2.5 block I/O model
3 *
4 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tejun Heo7cc01582010-08-03 13:14:58 +020012 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public Licens
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
19 */
20#ifndef __LINUX_BIO_H
21#define __LINUX_BIO_H
22
23#include <linux/highmem.h>
24#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020025#include <linux/ioprio.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050026#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
David Howells02a5e0a2007-08-11 22:34:32 +020028#ifdef CONFIG_BLOCK
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <asm/io.h>
31
Tejun Heo7cc01582010-08-03 13:14:58 +020032/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
33#include <linux/blk_types.h>
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define BIO_DEBUG
36
37#ifdef BIO_DEBUG
38#define BIO_BUG_ON BUG_ON
39#else
40#define BIO_BUG_ON
41#endif
42
Alexey Dobriyand84a8472006-06-25 05:49:32 -070043#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Mike Christie43b62ce2016-06-05 14:32:20 -050045#define bio_prio(bio) (bio)->bi_ioprio
46#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020047
Kent Overstreet4550dd62013-08-07 14:26:21 -070048#define bio_iter_iovec(bio, iter) \
49 bvec_iter_bvec((bio)->bi_io_vec, (iter))
50
51#define bio_iter_page(bio, iter) \
52 bvec_iter_page((bio)->bi_io_vec, (iter))
53#define bio_iter_len(bio, iter) \
54 bvec_iter_len((bio)->bi_io_vec, (iter))
55#define bio_iter_offset(bio, iter) \
56 bvec_iter_offset((bio)->bi_io_vec, (iter))
57
58#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
59#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
60#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080061
Kent Overstreet458b76e2013-09-24 16:26:05 -070062#define bio_multiple_segments(bio) \
63 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -070064#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
65#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +020066
Kent Overstreet458b76e2013-09-24 16:26:05 -070067/*
68 * Check whether this bio carries any data or not. A NULL bio is allowed.
69 */
70static inline bool bio_has_data(struct bio *bio)
71{
72 if (bio &&
73 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030074 bio_op(bio) != REQ_OP_DISCARD &&
75 bio_op(bio) != REQ_OP_SECURE_ERASE)
Kent Overstreet458b76e2013-09-24 16:26:05 -070076 return true;
77
78 return false;
79}
80
Mike Christie95fe6c12016-06-05 14:31:48 -050081static inline bool bio_no_advance_iter(struct bio *bio)
82{
Adrian Hunter7afafc82016-08-16 10:59:35 +030083 return bio_op(bio) == REQ_OP_DISCARD ||
84 bio_op(bio) == REQ_OP_SECURE_ERASE ||
85 bio_op(bio) == REQ_OP_WRITE_SAME;
Mike Christie95fe6c12016-06-05 14:31:48 -050086}
87
Kent Overstreet458b76e2013-09-24 16:26:05 -070088static inline bool bio_is_rw(struct bio *bio)
89{
90 if (!bio_has_data(bio))
91 return false;
92
Mike Christie95fe6c12016-06-05 14:31:48 -050093 if (bio_no_advance_iter(bio))
Kent Overstreet458b76e2013-09-24 16:26:05 -070094 return false;
95
96 return true;
97}
98
99static inline bool bio_mergeable(struct bio *bio)
100{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600101 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700102 return false;
103
104 return true;
105}
106
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900107static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200108{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700109 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700110 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100111 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700112 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200113}
114
115static inline void *bio_data(struct bio *bio)
116{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700117 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200118 return page_address(bio_page(bio)) + bio_offset(bio);
119
120 return NULL;
121}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123/*
124 * will die
125 */
126#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
127#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
128
129/*
130 * queues that have highmem support enabled may still need to revert to
131 * PIO transfers occasionally and thus map high pages temporarily. For
132 * permanent PIO fall back, user is probably better off disabling highmem
133 * I/O completely on that queue (see ide-dma for example)
134 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700135#define __bio_kmap_atomic(bio, iter) \
136 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
137 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Kent Overstreetf619d252013-08-07 14:30:33 -0700139#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141/*
142 * merge helpers etc
143 */
144
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100145/* Default implementation of BIOVEC_PHYS_MERGEABLE */
146#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
147 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149/*
150 * allow arch override, for eg virtualized architectures (put in asm/io.h)
151 */
152#ifndef BIOVEC_PHYS_MERGEABLE
153#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100154 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#endif
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
158 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
159#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400160 __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 -0700161
Jens Axboe66cb45a2014-06-24 16:22:24 -0600162/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800163 * drivers should _never_ use the all version - the bio may have been split
164 * before it got to the driver and the driver won't own all of it
165 */
166#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700167 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800168
Kent Overstreet4550dd62013-08-07 14:26:21 -0700169static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
170 unsigned bytes)
171{
172 iter->bi_sector += bytes >> 9;
173
Mike Christie95fe6c12016-06-05 14:31:48 -0500174 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700175 iter->bi_size -= bytes;
176 else
177 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
178}
179
Kent Overstreet79886132013-11-23 17:19:00 -0800180#define __bio_for_each_segment(bvl, bio, iter, start) \
181 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700182 (iter).bi_size && \
183 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
184 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800185
186#define bio_for_each_segment(bvl, bio, iter) \
187 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
188
Kent Overstreet4550dd62013-08-07 14:26:21 -0700189#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Kent Overstreet458b76e2013-09-24 16:26:05 -0700191static inline unsigned bio_segments(struct bio *bio)
192{
193 unsigned segs = 0;
194 struct bio_vec bv;
195 struct bvec_iter iter;
196
Kent Overstreet8423ae32014-02-10 17:45:50 -0800197 /*
198 * We special case discard/write same, because they interpret bi_size
199 * differently:
200 */
201
Mike Christie95fe6c12016-06-05 14:31:48 -0500202 if (bio_op(bio) == REQ_OP_DISCARD)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800203 return 1;
204
Adrian Hunter7afafc82016-08-16 10:59:35 +0300205 if (bio_op(bio) == REQ_OP_SECURE_ERASE)
206 return 1;
207
Mike Christie95fe6c12016-06-05 14:31:48 -0500208 if (bio_op(bio) == REQ_OP_WRITE_SAME)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800209 return 1;
210
Kent Overstreet458b76e2013-09-24 16:26:05 -0700211 bio_for_each_segment(bv, bio, iter)
212 segs++;
213
214 return segs;
215}
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/*
218 * get a reference to a bio, so it won't disappear. the intended use is
219 * something like:
220 *
221 * bio_get(bio);
222 * submit_bio(rw, bio);
223 * if (bio->bi_flags ...)
224 * do_something
225 * bio_put(bio);
226 *
227 * without the bio_get(), it could potentially complete I/O before submit_bio
228 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
229 * runs
230 */
Jens Axboedac56212015-04-17 16:23:59 -0600231static inline void bio_get(struct bio *bio)
232{
233 bio->bi_flags |= (1 << BIO_REFFED);
234 smp_mb__before_atomic();
235 atomic_inc(&bio->__bi_cnt);
236}
237
238static inline void bio_cnt_set(struct bio *bio, unsigned int count)
239{
240 if (count != 1) {
241 bio->bi_flags |= (1 << BIO_REFFED);
242 smp_mb__before_atomic();
243 }
244 atomic_set(&bio->__bi_cnt, count);
245}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600247static inline bool bio_flagged(struct bio *bio, unsigned int bit)
248{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600249 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600250}
251
252static inline void bio_set_flag(struct bio *bio, unsigned int bit)
253{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600254 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600255}
256
257static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
258{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600259 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600260}
261
Ming Lei7bcd79a2016-02-26 23:40:50 +0800262static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
263{
264 *bv = bio_iovec(bio);
265}
266
267static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
268{
269 struct bvec_iter iter = bio->bi_iter;
270 int idx;
271
Ming Lei7bcd79a2016-02-26 23:40:50 +0800272 if (unlikely(!bio_multiple_segments(bio))) {
273 *bv = bio_iovec(bio);
274 return;
275 }
276
277 bio_advance_iter(bio, &iter, iter.bi_size);
278
279 if (!iter.bi_bvec_done)
280 idx = iter.bi_idx - 1;
281 else /* in the middle of bvec */
282 idx = iter.bi_idx;
283
284 *bv = bio->bi_io_vec[idx];
285
286 /*
287 * iter.bi_bvec_done records actual length of the last bvec
288 * if this bio ends in the middle of one io vector
289 */
290 if (iter.bi_bvec_done)
291 bv->bv_len = iter.bi_bvec_done;
292}
293
Martin K. Petersenc6115292014-09-26 19:20:08 -0400294enum bip_flags {
295 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
296 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
297 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
298 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
299 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
300};
301
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200302/*
303 * bio integrity payload
304 */
305struct bio_integrity_payload {
306 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200307
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800308 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800310 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200311
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200312 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200313 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600314 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400315 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200316
317 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700318
319 struct bio_vec *bip_vec;
320 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200321};
Martin K. Petersen18593082014-09-26 19:20:01 -0400322
Keith Busch06c1e392015-12-03 09:32:21 -0700323#if defined(CONFIG_BLK_DEV_INTEGRITY)
324
325static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
326{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600327 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700328 return bio->bi_integrity;
329
330 return NULL;
331}
332
Martin K. Petersenc6115292014-09-26 19:20:08 -0400333static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
334{
335 struct bio_integrity_payload *bip = bio_integrity(bio);
336
337 if (bip)
338 return bip->bip_flags & flag;
339
340 return false;
341}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400342
Martin K. Petersen18593082014-09-26 19:20:01 -0400343static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
344{
345 return bip->bip_iter.bi_sector;
346}
347
348static inline void bip_set_seed(struct bio_integrity_payload *bip,
349 sector_t seed)
350{
351 bip->bip_iter.bi_sector = seed;
352}
353
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200354#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
Kent Overstreet6678d832013-08-07 11:14:32 -0700356extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800357extern struct bio *bio_split(struct bio *bio, int sectors,
358 gfp_t gfp, struct bio_set *bs);
359
360/**
361 * bio_next_split - get next @sectors from a bio, splitting if necessary
362 * @bio: bio to split
363 * @sectors: number of sectors to split from the front of @bio
364 * @gfp: gfp mask
365 * @bs: bio set to allocate from
366 *
367 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
368 * than @sectors, returns the original bio unchanged.
369 */
370static inline struct bio *bio_next_split(struct bio *bio, int sectors,
371 gfp_t gfp, struct bio_set *bs)
372{
373 if (sectors >= bio_sectors(bio))
374 return bio;
375
376 return bio_split(bio, sectors, gfp, bs);
377}
378
Jens Axboebb799ca2008-12-10 15:35:05 +0100379extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400380extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600382extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Al Virodd0fc662005-10-07 07:46:04 +0100384extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Kent Overstreet59d276f2013-11-23 18:19:27 -0800387extern void __bio_clone_fast(struct bio *, struct bio *);
388extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700389extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
390
Kent Overstreet3f86a822012-09-06 15:35:01 -0700391extern struct bio_set *fs_bio_set;
392
393static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
394{
395 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
396}
397
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700398static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
399{
400 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
401}
402
Kent Overstreet3f86a822012-09-06 15:35:01 -0700403static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
404{
405 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
406}
407
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700408static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
409{
410 return bio_clone_bioset(bio, gfp_mask, NULL);
411
412}
413
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200414extern void bio_endio(struct bio *);
415
416static inline void bio_io_error(struct bio *bio)
417{
418 bio->bi_error = -EIO;
419 bio_endio(bio);
420}
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422struct request_queue;
423extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Mike Christie4e49ea42016-06-05 14:31:41 -0500425extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700426extern void bio_advance(struct bio *, unsigned);
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428extern void bio_init(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700429extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800430void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600433extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
434 unsigned int, unsigned int);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900435struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200436extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100437 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200439extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400440 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200441extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
442 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443extern void bio_set_pages_dirty(struct bio *bio);
444extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100445
Gu Zheng394ffa52014-11-24 11:05:22 +0800446void generic_start_io_acct(int rw, unsigned long sectors,
447 struct hd_struct *part);
448void generic_end_io_acct(int rw, struct hd_struct *part,
449 unsigned long start_time);
450
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100451#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
452# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
453#endif
454#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
455extern void bio_flush_dcache_pages(struct bio *bi);
456#else
457static inline void bio_flush_dcache_pages(struct bio *bi)
458{
459}
460#endif
461
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700462extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700463extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700464
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900465extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500466 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100467 const struct iov_iter *,
468 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469extern int bio_uncopy_user(struct bio *);
470void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700471extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
472extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200473extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200474
Tejun Heo852c7882012-03-05 13:15:27 -0800475#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400476int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800477int bio_associate_current(struct bio *bio);
478void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200479void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800480#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400481static inline int bio_associate_blkcg(struct bio *bio,
482 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800483static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
484static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200485static inline void bio_clone_blkcg_association(struct bio *dst,
486 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800487#endif /* CONFIG_BLK_CGROUP */
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489#ifdef CONFIG_HIGHMEM
490/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100491 * remember never ever reenable interrupts between a bvec_kmap_irq and
492 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100494static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
496 unsigned long addr;
497
498 /*
499 * might not be a highmem page, but the preempt/irq count
500 * balancing is a lot nicer this way
501 */
502 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800503 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
505 BUG_ON(addr & ~PAGE_MASK);
506
507 return (char *) addr + bvec->bv_offset;
508}
509
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100510static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
512 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
513
Cong Wange8e3c3d2011-11-25 23:14:27 +0800514 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 local_irq_restore(*flags);
516}
517
518#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200519static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
520{
521 return page_address(bvec->bv_page) + bvec->bv_offset;
522}
523
524static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
525{
526 *flags = 0;
527}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528#endif
529
Kent Overstreetf619d252013-08-07 14:30:33 -0700530static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 unsigned long *flags)
532{
Kent Overstreetf619d252013-08-07 14:30:33 -0700533 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
536
537#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700538 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
540
Jens Axboe7a67f632008-08-08 11:17:12 +0200541/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200542 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200543 *
544 * A bio_list anchors a singly-linked list of bios chained through the bi_next
545 * member of the bio. The bio_list also caches the last list member to allow
546 * fast access to the tail.
547 */
548struct bio_list {
549 struct bio *head;
550 struct bio *tail;
551};
552
553static inline int bio_list_empty(const struct bio_list *bl)
554{
555 return bl->head == NULL;
556}
557
558static inline void bio_list_init(struct bio_list *bl)
559{
560 bl->head = bl->tail = NULL;
561}
562
Jens Axboe320ae512013-10-24 09:20:05 +0100563#define BIO_EMPTY_LIST { NULL, NULL }
564
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200565#define bio_list_for_each(bio, bl) \
566 for (bio = (bl)->head; bio; bio = bio->bi_next)
567
568static inline unsigned bio_list_size(const struct bio_list *bl)
569{
570 unsigned sz = 0;
571 struct bio *bio;
572
573 bio_list_for_each(bio, bl)
574 sz++;
575
576 return sz;
577}
578
579static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
580{
581 bio->bi_next = NULL;
582
583 if (bl->tail)
584 bl->tail->bi_next = bio;
585 else
586 bl->head = bio;
587
588 bl->tail = bio;
589}
590
591static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
592{
593 bio->bi_next = bl->head;
594
595 bl->head = bio;
596
597 if (!bl->tail)
598 bl->tail = bio;
599}
600
601static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
602{
603 if (!bl2->head)
604 return;
605
606 if (bl->tail)
607 bl->tail->bi_next = bl2->head;
608 else
609 bl->head = bl2->head;
610
611 bl->tail = bl2->tail;
612}
613
614static inline void bio_list_merge_head(struct bio_list *bl,
615 struct bio_list *bl2)
616{
617 if (!bl2->head)
618 return;
619
620 if (bl->head)
621 bl2->tail->bi_next = bl->head;
622 else
623 bl->tail = bl2->tail;
624
625 bl->head = bl2->head;
626}
627
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000628static inline struct bio *bio_list_peek(struct bio_list *bl)
629{
630 return bl->head;
631}
632
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200633static inline struct bio *bio_list_pop(struct bio_list *bl)
634{
635 struct bio *bio = bl->head;
636
637 if (bio) {
638 bl->head = bl->head->bi_next;
639 if (!bl->head)
640 bl->tail = NULL;
641
642 bio->bi_next = NULL;
643 }
644
645 return bio;
646}
647
648static inline struct bio *bio_list_get(struct bio_list *bl)
649{
650 struct bio *bio = bl->head;
651
652 bl->head = bl->tail = NULL;
653
654 return bio;
655}
656
Kent Overstreet57fb2332012-08-24 04:56:11 -0700657/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400658 * Increment chain count for the bio. Make sure the CHAIN flag update
659 * is visible before the raised count.
660 */
661static inline void bio_inc_remaining(struct bio *bio)
662{
663 bio_set_flag(bio, BIO_CHAIN);
664 smp_mb__before_atomic();
665 atomic_inc(&bio->__bi_remaining);
666}
667
668/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700669 * bio_set is used to allow other portions of the IO system to
670 * allocate their own private memory pools for bio and iovec structures.
671 * These memory pools in turn all allocate from the bio_slab
672 * and the bvec_slabs[].
673 */
674#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700675
676struct bio_set {
677 struct kmem_cache *bio_slab;
678 unsigned int front_pad;
679
680 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700681 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700682#if defined(CONFIG_BLK_DEV_INTEGRITY)
683 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700684 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700685#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700686
687 /*
688 * Deadlock avoidance for stacking block drivers: see comments in
689 * bio_alloc_bioset() for details
690 */
691 spinlock_t rescue_lock;
692 struct bio_list rescue_list;
693 struct work_struct rescue_work;
694 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700695};
696
697struct biovec_slab {
698 int nr_vecs;
699 char *name;
700 struct kmem_cache *slab;
701};
702
703/*
704 * a small number of entries is fine, not going to be performance critical.
705 * basically we just need to survive
706 */
707#define BIO_SPLIT_ENTRIES 2
708
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200709#if defined(CONFIG_BLK_DEV_INTEGRITY)
710
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800711#define bip_for_each_vec(bvl, bip, iter) \
712 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200713
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200714#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
715 for_each_bio(_bio) \
716 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
717
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200718extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700719extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200720extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400721extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200722extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200723extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200724extern void bio_integrity_advance(struct bio *, unsigned int);
725extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700726extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200727extern int bioset_integrity_create(struct bio_set *, int);
728extern void bioset_integrity_free(struct bio_set *);
729extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200730
731#else /* CONFIG_BLK_DEV_INTEGRITY */
732
Martin K. Petersenc6115292014-09-26 19:20:08 -0400733static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100734{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400735 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100736}
737
Martin K. Petersene7258c12014-09-26 19:19:55 -0400738static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100739{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400740 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100741}
742
743static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
744{
745 return 0;
746}
747
748static inline void bioset_integrity_free (struct bio_set *bs)
749{
750 return;
751}
752
753static inline int bio_integrity_prep(struct bio *bio)
754{
755 return 0;
756}
757
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700758static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100759{
760 return;
761}
762
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100763static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700764 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100765{
766 return 0;
767}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100768
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100769static inline void bio_integrity_advance(struct bio *bio,
770 unsigned int bytes_done)
771{
772 return;
773}
774
775static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
776 unsigned int sectors)
777{
778 return;
779}
780
781static inline void bio_integrity_init(void)
782{
783 return;
784}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200785
Martin K. Petersenc6115292014-09-26 19:20:08 -0400786static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
787{
788 return false;
789}
790
Keith Busch06c1e392015-12-03 09:32:21 -0700791static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
792 unsigned int nr)
793{
794 return ERR_PTR(-EINVAL);
795}
796
797static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
798 unsigned int len, unsigned int offset)
799{
800 return 0;
801}
802
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200803#endif /* CONFIG_BLK_DEV_INTEGRITY */
804
David Howells02a5e0a2007-08-11 22:34:32 +0200805#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806#endif /* __LINUX_BIO_H */