blob: 4931756d86d99a0194114229ec04001c223a3963 [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/*
Christoph Hellwigd3849952016-11-01 07:40:11 -060066 * Return the data direction, READ or WRITE.
67 */
68#define bio_data_dir(bio) \
69 (op_is_write(bio_op(bio)) ? WRITE : READ)
70
71/*
Kent Overstreet458b76e2013-09-24 16:26:05 -070072 * Check whether this bio carries any data or not. A NULL bio is allowed.
73 */
74static inline bool bio_has_data(struct bio *bio)
75{
76 if (bio &&
77 bio->bi_iter.bi_size &&
Adrian Hunter7afafc82016-08-16 10:59:35 +030078 bio_op(bio) != REQ_OP_DISCARD &&
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080079 bio_op(bio) != REQ_OP_SECURE_ERASE &&
80 bio_op(bio) != REQ_OP_WRITE_ZEROES)
Kent Overstreet458b76e2013-09-24 16:26:05 -070081 return true;
82
83 return false;
84}
85
Mike Christie95fe6c12016-06-05 14:31:48 -050086static inline bool bio_no_advance_iter(struct bio *bio)
87{
Adrian Hunter7afafc82016-08-16 10:59:35 +030088 return bio_op(bio) == REQ_OP_DISCARD ||
89 bio_op(bio) == REQ_OP_SECURE_ERASE ||
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -080090 bio_op(bio) == REQ_OP_WRITE_SAME ||
91 bio_op(bio) == REQ_OP_WRITE_ZEROES;
Mike Christie95fe6c12016-06-05 14:31:48 -050092}
93
Kent Overstreet458b76e2013-09-24 16:26:05 -070094static inline bool bio_mergeable(struct bio *bio)
95{
Jens Axboe1eff9d32016-08-05 15:35:16 -060096 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
Kent Overstreet458b76e2013-09-24 16:26:05 -070097 return false;
98
99 return true;
100}
101
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900102static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200103{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700104 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700105 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100106 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700107 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200108}
109
110static inline void *bio_data(struct bio *bio)
111{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700112 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200113 return page_address(bio_page(bio)) + bio_offset(bio);
114
115 return NULL;
116}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118/*
119 * will die
120 */
121#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
122#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
123
124/*
125 * queues that have highmem support enabled may still need to revert to
126 * PIO transfers occasionally and thus map high pages temporarily. For
127 * permanent PIO fall back, user is probably better off disabling highmem
128 * I/O completely on that queue (see ide-dma for example)
129 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700130#define __bio_kmap_atomic(bio, iter) \
131 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
132 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Kent Overstreetf619d252013-08-07 14:30:33 -0700134#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/*
137 * merge helpers etc
138 */
139
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100140/* Default implementation of BIOVEC_PHYS_MERGEABLE */
141#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
142 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144/*
145 * allow arch override, for eg virtualized architectures (put in asm/io.h)
146 */
147#ifndef BIOVEC_PHYS_MERGEABLE
148#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100149 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#endif
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
153 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
154#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400155 __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 -0700156
Jens Axboe66cb45a2014-06-24 16:22:24 -0600157/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800158 * drivers should _never_ use the all version - the bio may have been split
159 * before it got to the driver and the driver won't own all of it
160 */
161#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700162 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800163
Kent Overstreet4550dd62013-08-07 14:26:21 -0700164static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
165 unsigned bytes)
166{
167 iter->bi_sector += bytes >> 9;
168
Mike Christie95fe6c12016-06-05 14:31:48 -0500169 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700170 iter->bi_size -= bytes;
171 else
172 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
173}
174
Kent Overstreet79886132013-11-23 17:19:00 -0800175#define __bio_for_each_segment(bvl, bio, iter, start) \
176 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700177 (iter).bi_size && \
178 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
179 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800180
181#define bio_for_each_segment(bvl, bio, iter) \
182 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
183
Kent Overstreet4550dd62013-08-07 14:26:21 -0700184#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Ming Leic18a1e02017-02-14 23:28:59 +0800186static inline unsigned __bio_segments(struct bio *bio, struct bvec_iter *bvec)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700187{
188 unsigned segs = 0;
189 struct bio_vec bv;
190 struct bvec_iter iter;
191
Kent Overstreet8423ae32014-02-10 17:45:50 -0800192 /*
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800193 * We special case discard/write same/write zeroes, because they
194 * interpret bi_size differently:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800195 */
196
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800197 switch (bio_op(bio)) {
198 case REQ_OP_DISCARD:
199 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800200 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700201 return 0;
202 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800203 return 1;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800204 default:
205 break;
206 }
Kent Overstreet8423ae32014-02-10 17:45:50 -0800207
Ming Leic18a1e02017-02-14 23:28:59 +0800208 __bio_for_each_segment(bv, bio, iter, *bvec)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700209 segs++;
210
211 return segs;
212}
213
Ming Leic18a1e02017-02-14 23:28:59 +0800214static inline unsigned bio_segments(struct bio *bio)
215{
216 return __bio_segments(bio, &bio->bi_iter);
217}
218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219/*
220 * get a reference to a bio, so it won't disappear. the intended use is
221 * something like:
222 *
223 * bio_get(bio);
224 * submit_bio(rw, bio);
225 * if (bio->bi_flags ...)
226 * do_something
227 * bio_put(bio);
228 *
229 * without the bio_get(), it could potentially complete I/O before submit_bio
230 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
231 * runs
232 */
Jens Axboedac56212015-04-17 16:23:59 -0600233static inline void bio_get(struct bio *bio)
234{
235 bio->bi_flags |= (1 << BIO_REFFED);
236 smp_mb__before_atomic();
237 atomic_inc(&bio->__bi_cnt);
238}
239
240static inline void bio_cnt_set(struct bio *bio, unsigned int count)
241{
242 if (count != 1) {
243 bio->bi_flags |= (1 << BIO_REFFED);
244 smp_mb__before_atomic();
245 }
246 atomic_set(&bio->__bi_cnt, count);
247}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600249static inline bool bio_flagged(struct bio *bio, unsigned int bit)
250{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600251 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600252}
253
254static inline void bio_set_flag(struct bio *bio, unsigned int bit)
255{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600256 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600257}
258
259static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
260{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600261 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600262}
263
Ming Lei7bcd79a2016-02-26 23:40:50 +0800264static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
265{
266 *bv = bio_iovec(bio);
267}
268
269static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
270{
271 struct bvec_iter iter = bio->bi_iter;
272 int idx;
273
Ming Lei7bcd79a2016-02-26 23:40:50 +0800274 if (unlikely(!bio_multiple_segments(bio))) {
275 *bv = bio_iovec(bio);
276 return;
277 }
278
279 bio_advance_iter(bio, &iter, iter.bi_size);
280
281 if (!iter.bi_bvec_done)
282 idx = iter.bi_idx - 1;
283 else /* in the middle of bvec */
284 idx = iter.bi_idx;
285
286 *bv = bio->bi_io_vec[idx];
287
288 /*
289 * iter.bi_bvec_done records actual length of the last bvec
290 * if this bio ends in the middle of one io vector
291 */
292 if (iter.bi_bvec_done)
293 bv->bv_len = iter.bi_bvec_done;
294}
295
Martin K. Petersenc6115292014-09-26 19:20:08 -0400296enum bip_flags {
297 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
298 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
299 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
300 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
301 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
302};
303
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200304/*
305 * bio integrity payload
306 */
307struct bio_integrity_payload {
308 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800310 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200311
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800312 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200313
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200314 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200315 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600316 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400317 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200318
319 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700320
321 struct bio_vec *bip_vec;
322 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200323};
Martin K. Petersen18593082014-09-26 19:20:01 -0400324
Keith Busch06c1e392015-12-03 09:32:21 -0700325#if defined(CONFIG_BLK_DEV_INTEGRITY)
326
327static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
328{
Jens Axboe1eff9d32016-08-05 15:35:16 -0600329 if (bio->bi_opf & REQ_INTEGRITY)
Keith Busch06c1e392015-12-03 09:32:21 -0700330 return bio->bi_integrity;
331
332 return NULL;
333}
334
Martin K. Petersenc6115292014-09-26 19:20:08 -0400335static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
336{
337 struct bio_integrity_payload *bip = bio_integrity(bio);
338
339 if (bip)
340 return bip->bip_flags & flag;
341
342 return false;
343}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400344
Martin K. Petersen18593082014-09-26 19:20:01 -0400345static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
346{
347 return bip->bip_iter.bi_sector;
348}
349
350static inline void bip_set_seed(struct bio_integrity_payload *bip,
351 sector_t seed)
352{
353 bip->bip_iter.bi_sector = seed;
354}
355
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200356#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Kent Overstreet6678d832013-08-07 11:14:32 -0700358extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800359extern struct bio *bio_split(struct bio *bio, int sectors,
360 gfp_t gfp, struct bio_set *bs);
361
362/**
363 * bio_next_split - get next @sectors from a bio, splitting if necessary
364 * @bio: bio to split
365 * @sectors: number of sectors to split from the front of @bio
366 * @gfp: gfp mask
367 * @bs: bio set to allocate from
368 *
369 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
370 * than @sectors, returns the original bio unchanged.
371 */
372static inline struct bio *bio_next_split(struct bio *bio, int sectors,
373 gfp_t gfp, struct bio_set *bs)
374{
375 if (sectors >= bio_sectors(bio))
376 return bio;
377
378 return bio_split(bio, sectors, gfp, bs);
379}
380
Jens Axboebb799ca2008-12-10 15:35:05 +0100381extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400382extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600384extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300386extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Kent Overstreet59d276f2013-11-23 18:19:27 -0800389extern void __bio_clone_fast(struct bio *, struct bio *);
390extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700391extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
Ming Leic18a1e02017-02-14 23:28:59 +0800392extern struct bio *bio_clone_bioset_partial(struct bio *, gfp_t,
393 struct bio_set *, int, int);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700394
Kent Overstreet3f86a822012-09-06 15:35:01 -0700395extern struct bio_set *fs_bio_set;
396
397static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
398{
399 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
400}
401
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700402static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
403{
404 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
405}
406
Kent Overstreet3f86a822012-09-06 15:35:01 -0700407static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
408{
409 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
410}
411
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700412static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
413{
414 return bio_clone_bioset(bio, gfp_mask, NULL);
415
416}
417
Christoph Hellwig1e3914d2016-11-01 07:40:12 -0600418extern blk_qc_t submit_bio(struct bio *);
419
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200420extern void bio_endio(struct bio *);
421
422static inline void bio_io_error(struct bio *bio)
423{
424 bio->bi_error = -EIO;
425 bio_endio(bio);
426}
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428struct request_queue;
429extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Mike Christie4e49ea42016-06-05 14:31:41 -0500431extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700432extern void bio_advance(struct bio *, unsigned);
433
Ming Lei3a83f462016-11-22 08:57:21 -0700434extern void bio_init(struct bio *bio, struct bio_vec *table,
435 unsigned short max_vecs);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700436extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800437void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600440extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
441 unsigned int, unsigned int);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600442int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900443struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200444extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100445 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200447extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400448 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200449extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
450 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451extern void bio_set_pages_dirty(struct bio *bio);
452extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100453
Gu Zheng394ffa52014-11-24 11:05:22 +0800454void generic_start_io_acct(int rw, unsigned long sectors,
455 struct hd_struct *part);
456void generic_end_io_acct(int rw, struct hd_struct *part,
457 unsigned long start_time);
458
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100459#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
460# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
461#endif
462#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
463extern void bio_flush_dcache_pages(struct bio *bi);
464#else
465static inline void bio_flush_dcache_pages(struct bio *bi)
466{
467}
468#endif
469
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700470extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700471extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Guoqing Jiang491221f2016-09-22 03:10:01 -0400472extern void bio_free_pages(struct bio *bio);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700473
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900474extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500475 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100476 const struct iov_iter *,
477 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478extern int bio_uncopy_user(struct bio *);
479void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700480extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
481extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200482extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200483
Tejun Heo852c7882012-03-05 13:15:27 -0800484#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400485int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800486int bio_associate_current(struct bio *bio);
487void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200488void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800489#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400490static inline int bio_associate_blkcg(struct bio *bio,
491 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800492static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
493static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200494static inline void bio_clone_blkcg_association(struct bio *dst,
495 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800496#endif /* CONFIG_BLK_CGROUP */
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498#ifdef CONFIG_HIGHMEM
499/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100500 * remember never ever reenable interrupts between a bvec_kmap_irq and
501 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100503static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 unsigned long addr;
506
507 /*
508 * might not be a highmem page, but the preempt/irq count
509 * balancing is a lot nicer this way
510 */
511 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800512 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514 BUG_ON(addr & ~PAGE_MASK);
515
516 return (char *) addr + bvec->bv_offset;
517}
518
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100519static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
521 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
522
Cong Wange8e3c3d2011-11-25 23:14:27 +0800523 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 local_irq_restore(*flags);
525}
526
527#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200528static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
529{
530 return page_address(bvec->bv_page) + bvec->bv_offset;
531}
532
533static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
534{
535 *flags = 0;
536}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537#endif
538
Kent Overstreetf619d252013-08-07 14:30:33 -0700539static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 unsigned long *flags)
541{
Kent Overstreetf619d252013-08-07 14:30:33 -0700542 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
544#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
545
546#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700547 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
549
Jens Axboe7a67f632008-08-08 11:17:12 +0200550/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200551 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200552 *
553 * A bio_list anchors a singly-linked list of bios chained through the bi_next
554 * member of the bio. The bio_list also caches the last list member to allow
555 * fast access to the tail.
556 */
557struct bio_list {
558 struct bio *head;
559 struct bio *tail;
560};
561
562static inline int bio_list_empty(const struct bio_list *bl)
563{
564 return bl->head == NULL;
565}
566
567static inline void bio_list_init(struct bio_list *bl)
568{
569 bl->head = bl->tail = NULL;
570}
571
Jens Axboe320ae512013-10-24 09:20:05 +0100572#define BIO_EMPTY_LIST { NULL, NULL }
573
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200574#define bio_list_for_each(bio, bl) \
575 for (bio = (bl)->head; bio; bio = bio->bi_next)
576
577static inline unsigned bio_list_size(const struct bio_list *bl)
578{
579 unsigned sz = 0;
580 struct bio *bio;
581
582 bio_list_for_each(bio, bl)
583 sz++;
584
585 return sz;
586}
587
588static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
589{
590 bio->bi_next = NULL;
591
592 if (bl->tail)
593 bl->tail->bi_next = bio;
594 else
595 bl->head = bio;
596
597 bl->tail = bio;
598}
599
600static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
601{
602 bio->bi_next = bl->head;
603
604 bl->head = bio;
605
606 if (!bl->tail)
607 bl->tail = bio;
608}
609
610static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
611{
612 if (!bl2->head)
613 return;
614
615 if (bl->tail)
616 bl->tail->bi_next = bl2->head;
617 else
618 bl->head = bl2->head;
619
620 bl->tail = bl2->tail;
621}
622
623static inline void bio_list_merge_head(struct bio_list *bl,
624 struct bio_list *bl2)
625{
626 if (!bl2->head)
627 return;
628
629 if (bl->head)
630 bl2->tail->bi_next = bl->head;
631 else
632 bl->tail = bl2->tail;
633
634 bl->head = bl2->head;
635}
636
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000637static inline struct bio *bio_list_peek(struct bio_list *bl)
638{
639 return bl->head;
640}
641
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200642static inline struct bio *bio_list_pop(struct bio_list *bl)
643{
644 struct bio *bio = bl->head;
645
646 if (bio) {
647 bl->head = bl->head->bi_next;
648 if (!bl->head)
649 bl->tail = NULL;
650
651 bio->bi_next = NULL;
652 }
653
654 return bio;
655}
656
657static inline struct bio *bio_list_get(struct bio_list *bl)
658{
659 struct bio *bio = bl->head;
660
661 bl->head = bl->tail = NULL;
662
663 return bio;
664}
665
Kent Overstreet57fb2332012-08-24 04:56:11 -0700666/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400667 * Increment chain count for the bio. Make sure the CHAIN flag update
668 * is visible before the raised count.
669 */
670static inline void bio_inc_remaining(struct bio *bio)
671{
672 bio_set_flag(bio, BIO_CHAIN);
673 smp_mb__before_atomic();
674 atomic_inc(&bio->__bi_remaining);
675}
676
677/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700678 * bio_set is used to allow other portions of the IO system to
679 * allocate their own private memory pools for bio and iovec structures.
680 * These memory pools in turn all allocate from the bio_slab
681 * and the bvec_slabs[].
682 */
683#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700684
685struct bio_set {
686 struct kmem_cache *bio_slab;
687 unsigned int front_pad;
688
689 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700690 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700691#if defined(CONFIG_BLK_DEV_INTEGRITY)
692 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700693 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700694#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700695
696 /*
697 * Deadlock avoidance for stacking block drivers: see comments in
698 * bio_alloc_bioset() for details
699 */
700 spinlock_t rescue_lock;
701 struct bio_list rescue_list;
702 struct work_struct rescue_work;
703 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700704};
705
706struct biovec_slab {
707 int nr_vecs;
708 char *name;
709 struct kmem_cache *slab;
710};
711
712/*
713 * a small number of entries is fine, not going to be performance critical.
714 * basically we just need to survive
715 */
716#define BIO_SPLIT_ENTRIES 2
717
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200718#if defined(CONFIG_BLK_DEV_INTEGRITY)
719
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800720#define bip_for_each_vec(bvl, bip, iter) \
721 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200722
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200723#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
724 for_each_bio(_bio) \
725 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
726
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200727extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700728extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200729extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400730extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200731extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200732extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200733extern void bio_integrity_advance(struct bio *, unsigned int);
734extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700735extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200736extern int bioset_integrity_create(struct bio_set *, int);
737extern void bioset_integrity_free(struct bio_set *);
738extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200739
740#else /* CONFIG_BLK_DEV_INTEGRITY */
741
Martin K. Petersenc6115292014-09-26 19:20:08 -0400742static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100743{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400744 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100745}
746
Martin K. Petersene7258c12014-09-26 19:19:55 -0400747static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100748{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400749 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100750}
751
752static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
753{
754 return 0;
755}
756
757static inline void bioset_integrity_free (struct bio_set *bs)
758{
759 return;
760}
761
762static inline int bio_integrity_prep(struct bio *bio)
763{
764 return 0;
765}
766
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700767static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100768{
769 return;
770}
771
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100772static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700773 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100774{
775 return 0;
776}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100777
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100778static inline void bio_integrity_advance(struct bio *bio,
779 unsigned int bytes_done)
780{
781 return;
782}
783
784static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
785 unsigned int sectors)
786{
787 return;
788}
789
790static inline void bio_integrity_init(void)
791{
792 return;
793}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200794
Martin K. Petersenc6115292014-09-26 19:20:08 -0400795static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
796{
797 return false;
798}
799
Keith Busch06c1e392015-12-03 09:32:21 -0700800static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
801 unsigned int nr)
802{
803 return ERR_PTR(-EINVAL);
804}
805
806static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
807 unsigned int len, unsigned int offset)
808{
809 return 0;
810}
811
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200812#endif /* CONFIG_BLK_DEV_INTEGRITY */
813
David Howells02a5e0a2007-08-11 22:34:32 +0200814#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815#endif /* __LINUX_BIO_H */