blob: 88bc64f00bb53cb01fe60ca87dfafd7c9c0f0f4a [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#define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_CACHE_SHIFT)
45#define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
46
47/*
Jens Axboe22e2c502005-06-27 10:55:12 +020048 * upper 16 bits of bi_rw define the io priority of this bio
49 */
50#define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
51#define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
52#define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
53
54#define bio_set_prio(bio, prio) do { \
55 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
56 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
57 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
58} while (0)
59
60/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * various member access, note that bio_data should of course not be used
62 * on highmem page vectors
63 */
Kent Overstreet4550dd62013-08-07 14:26:21 -070064#define __bvec_iter_bvec(bvec, iter) (&(bvec)[(iter).bi_idx])
Kent Overstreeta4ad39b12013-08-07 14:24:32 -070065
Kent Overstreet4550dd62013-08-07 14:26:21 -070066#define bvec_iter_page(bvec, iter) \
67 (__bvec_iter_bvec((bvec), (iter))->bv_page)
68
69#define bvec_iter_len(bvec, iter) \
70 min((iter).bi_size, \
71 __bvec_iter_bvec((bvec), (iter))->bv_len - (iter).bi_bvec_done)
72
73#define bvec_iter_offset(bvec, iter) \
74 (__bvec_iter_bvec((bvec), (iter))->bv_offset + (iter).bi_bvec_done)
75
76#define bvec_iter_bvec(bvec, iter) \
77((struct bio_vec) { \
78 .bv_page = bvec_iter_page((bvec), (iter)), \
79 .bv_len = bvec_iter_len((bvec), (iter)), \
80 .bv_offset = bvec_iter_offset((bvec), (iter)), \
81})
82
83#define bio_iter_iovec(bio, iter) \
84 bvec_iter_bvec((bio)->bi_io_vec, (iter))
85
86#define bio_iter_page(bio, iter) \
87 bvec_iter_page((bio)->bi_io_vec, (iter))
88#define bio_iter_len(bio, iter) \
89 bvec_iter_len((bio)->bi_io_vec, (iter))
90#define bio_iter_offset(bio, iter) \
91 bvec_iter_offset((bio)->bi_io_vec, (iter))
92
93#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
94#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
95#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080096
Kent Overstreet458b76e2013-09-24 16:26:05 -070097#define bio_multiple_segments(bio) \
98 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -070099#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
100#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200101
Kent Overstreet458b76e2013-09-24 16:26:05 -0700102/*
103 * Check whether this bio carries any data or not. A NULL bio is allowed.
104 */
105static inline bool bio_has_data(struct bio *bio)
106{
107 if (bio &&
108 bio->bi_iter.bi_size &&
109 !(bio->bi_rw & REQ_DISCARD))
110 return true;
111
112 return false;
113}
114
115static inline bool bio_is_rw(struct bio *bio)
116{
117 if (!bio_has_data(bio))
118 return false;
119
120 if (bio->bi_rw & BIO_NO_ADVANCE_ITER_MASK)
121 return false;
122
123 return true;
124}
125
126static inline bool bio_mergeable(struct bio *bio)
127{
128 if (bio->bi_rw & REQ_NOMERGE_FLAGS)
129 return false;
130
131 return true;
132}
133
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900134static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200135{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700136 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700137 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100138 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700139 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200140}
141
142static inline void *bio_data(struct bio *bio)
143{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700144 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200145 return page_address(bio_page(bio)) + bio_offset(bio);
146
147 return NULL;
148}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150/*
151 * will die
152 */
153#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
154#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
155
156/*
157 * queues that have highmem support enabled may still need to revert to
158 * PIO transfers occasionally and thus map high pages temporarily. For
159 * permanent PIO fall back, user is probably better off disabling highmem
160 * I/O completely on that queue (see ide-dma for example)
161 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700162#define __bio_kmap_atomic(bio, iter) \
163 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
164 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Kent Overstreetf619d252013-08-07 14:30:33 -0700166#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168/*
169 * merge helpers etc
170 */
171
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100172/* Default implementation of BIOVEC_PHYS_MERGEABLE */
173#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
174 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176/*
177 * allow arch override, for eg virtualized architectures (put in asm/io.h)
178 */
179#ifndef BIOVEC_PHYS_MERGEABLE
180#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100181 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182#endif
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
185 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
186#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400187 __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 -0700188
Jens Axboe66cb45a2014-06-24 16:22:24 -0600189/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800190 * drivers should _never_ use the all version - the bio may have been split
191 * before it got to the driver and the driver won't own all of it
192 */
193#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700194 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800195
Kent Overstreet4550dd62013-08-07 14:26:21 -0700196static inline void bvec_iter_advance(struct bio_vec *bv, struct bvec_iter *iter,
197 unsigned bytes)
198{
199 WARN_ONCE(bytes > iter->bi_size,
200 "Attempted to advance past end of bvec iter\n");
201
202 while (bytes) {
203 unsigned len = min(bytes, bvec_iter_len(bv, *iter));
204
205 bytes -= len;
206 iter->bi_size -= len;
207 iter->bi_bvec_done += len;
208
209 if (iter->bi_bvec_done == __bvec_iter_bvec(bv, *iter)->bv_len) {
210 iter->bi_bvec_done = 0;
211 iter->bi_idx++;
212 }
213 }
214}
215
216#define for_each_bvec(bvl, bio_vec, iter, start) \
Martin K. Petersenb7aa84d2014-04-08 22:43:43 -0400217 for (iter = (start); \
218 (iter).bi_size && \
219 ((bvl = bvec_iter_bvec((bio_vec), (iter))), 1); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700220 bvec_iter_advance((bio_vec), &(iter), (bvl).bv_len))
221
222
223static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
224 unsigned bytes)
225{
226 iter->bi_sector += bytes >> 9;
227
228 if (bio->bi_rw & BIO_NO_ADVANCE_ITER_MASK)
229 iter->bi_size -= bytes;
230 else
231 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
232}
233
Kent Overstreet79886132013-11-23 17:19:00 -0800234#define __bio_for_each_segment(bvl, bio, iter, start) \
235 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700236 (iter).bi_size && \
237 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
238 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800239
240#define bio_for_each_segment(bvl, bio, iter) \
241 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
242
Kent Overstreet4550dd62013-08-07 14:26:21 -0700243#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Kent Overstreet458b76e2013-09-24 16:26:05 -0700245static inline unsigned bio_segments(struct bio *bio)
246{
247 unsigned segs = 0;
248 struct bio_vec bv;
249 struct bvec_iter iter;
250
Kent Overstreet8423ae32014-02-10 17:45:50 -0800251 /*
252 * We special case discard/write same, because they interpret bi_size
253 * differently:
254 */
255
256 if (bio->bi_rw & REQ_DISCARD)
257 return 1;
258
259 if (bio->bi_rw & REQ_WRITE_SAME)
260 return 1;
261
Kent Overstreet458b76e2013-09-24 16:26:05 -0700262 bio_for_each_segment(bv, bio, iter)
263 segs++;
264
265 return segs;
266}
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/*
269 * get a reference to a bio, so it won't disappear. the intended use is
270 * something like:
271 *
272 * bio_get(bio);
273 * submit_bio(rw, bio);
274 * if (bio->bi_flags ...)
275 * do_something
276 * bio_put(bio);
277 *
278 * without the bio_get(), it could potentially complete I/O before submit_bio
279 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
280 * runs
281 */
Jens Axboedac56212015-04-17 16:23:59 -0600282static inline void bio_get(struct bio *bio)
283{
284 bio->bi_flags |= (1 << BIO_REFFED);
285 smp_mb__before_atomic();
286 atomic_inc(&bio->__bi_cnt);
287}
288
289static inline void bio_cnt_set(struct bio *bio, unsigned int count)
290{
291 if (count != 1) {
292 bio->bi_flags |= (1 << BIO_REFFED);
293 smp_mb__before_atomic();
294 }
295 atomic_set(&bio->__bi_cnt, count);
296}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600298static inline bool bio_flagged(struct bio *bio, unsigned int bit)
299{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600300 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600301}
302
303static inline void bio_set_flag(struct bio *bio, unsigned int bit)
304{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600305 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600306}
307
308static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
309{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600310 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600311}
312
Ming Lei7bcd79a2016-02-26 23:40:50 +0800313static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
314{
315 *bv = bio_iovec(bio);
316}
317
318static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
319{
320 struct bvec_iter iter = bio->bi_iter;
321 int idx;
322
Ming Lei7bcd79a2016-02-26 23:40:50 +0800323 if (unlikely(!bio_multiple_segments(bio))) {
324 *bv = bio_iovec(bio);
325 return;
326 }
327
328 bio_advance_iter(bio, &iter, iter.bi_size);
329
330 if (!iter.bi_bvec_done)
331 idx = iter.bi_idx - 1;
332 else /* in the middle of bvec */
333 idx = iter.bi_idx;
334
335 *bv = bio->bi_io_vec[idx];
336
337 /*
338 * iter.bi_bvec_done records actual length of the last bvec
339 * if this bio ends in the middle of one io vector
340 */
341 if (iter.bi_bvec_done)
342 bv->bv_len = iter.bi_bvec_done;
343}
344
Martin K. Petersenc6115292014-09-26 19:20:08 -0400345enum bip_flags {
346 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
347 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
348 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
349 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
350 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
351};
352
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200353/*
354 * bio integrity payload
355 */
356struct bio_integrity_payload {
357 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200358
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800359 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200360
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800361 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200362
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200363 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200364 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600365 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400366 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200367
368 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700369
370 struct bio_vec *bip_vec;
371 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200372};
Martin K. Petersen18593082014-09-26 19:20:01 -0400373
Keith Busch06c1e392015-12-03 09:32:21 -0700374#if defined(CONFIG_BLK_DEV_INTEGRITY)
375
376static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
377{
378 if (bio->bi_rw & REQ_INTEGRITY)
379 return bio->bi_integrity;
380
381 return NULL;
382}
383
Martin K. Petersenc6115292014-09-26 19:20:08 -0400384static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
385{
386 struct bio_integrity_payload *bip = bio_integrity(bio);
387
388 if (bip)
389 return bip->bip_flags & flag;
390
391 return false;
392}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400393
Martin K. Petersen18593082014-09-26 19:20:01 -0400394static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
395{
396 return bip->bip_iter.bi_sector;
397}
398
399static inline void bip_set_seed(struct bio_integrity_payload *bip,
400 sector_t seed)
401{
402 bip->bip_iter.bi_sector = seed;
403}
404
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200405#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Kent Overstreet6678d832013-08-07 11:14:32 -0700407extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800408extern struct bio *bio_split(struct bio *bio, int sectors,
409 gfp_t gfp, struct bio_set *bs);
410
411/**
412 * bio_next_split - get next @sectors from a bio, splitting if necessary
413 * @bio: bio to split
414 * @sectors: number of sectors to split from the front of @bio
415 * @gfp: gfp mask
416 * @bs: bio set to allocate from
417 *
418 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
419 * than @sectors, returns the original bio unchanged.
420 */
421static inline struct bio *bio_next_split(struct bio *bio, int sectors,
422 gfp_t gfp, struct bio_set *bs)
423{
424 if (sectors >= bio_sectors(bio))
425 return bio;
426
427 return bio_split(bio, sectors, gfp, bs);
428}
429
Jens Axboebb799ca2008-12-10 15:35:05 +0100430extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400431extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600433extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Al Virodd0fc662005-10-07 07:46:04 +0100435extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Kent Overstreet59d276f2013-11-23 18:19:27 -0800438extern void __bio_clone_fast(struct bio *, struct bio *);
439extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700440extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
441
Kent Overstreet3f86a822012-09-06 15:35:01 -0700442extern struct bio_set *fs_bio_set;
443
444static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
445{
446 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
447}
448
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700449static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
450{
451 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
452}
453
Kent Overstreet3f86a822012-09-06 15:35:01 -0700454static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
455{
456 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
457}
458
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700459static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
460{
461 return bio_clone_bioset(bio, gfp_mask, NULL);
462
463}
464
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200465extern void bio_endio(struct bio *);
466
467static inline void bio_io_error(struct bio *bio)
468{
469 bio->bi_error = -EIO;
470 bio_endio(bio);
471}
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473struct request_queue;
474extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Kent Overstreet9e882242012-09-10 14:41:12 -0700476extern int submit_bio_wait(int rw, struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700477extern void bio_advance(struct bio *, unsigned);
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479extern void bio_init(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700480extern void bio_reset(struct bio *);
Kent Overstreet196d38b2013-11-23 18:34:15 -0800481void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600484extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
485 unsigned int, unsigned int);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900486struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200487extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100488 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200490extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400491 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200492extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
493 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494extern void bio_set_pages_dirty(struct bio *bio);
495extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100496
Gu Zheng394ffa52014-11-24 11:05:22 +0800497void generic_start_io_acct(int rw, unsigned long sectors,
498 struct hd_struct *part);
499void generic_end_io_acct(int rw, struct hd_struct *part,
500 unsigned long start_time);
501
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100502#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
503# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
504#endif
505#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
506extern void bio_flush_dcache_pages(struct bio *bi);
507#else
508static inline void bio_flush_dcache_pages(struct bio *bi)
509{
510}
511#endif
512
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700513extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700514extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700515
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900516extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500517 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100518 const struct iov_iter *,
519 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520extern int bio_uncopy_user(struct bio *);
521void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700522extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
523extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200524extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200525
Tejun Heo852c7882012-03-05 13:15:27 -0800526#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400527int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800528int bio_associate_current(struct bio *bio);
529void bio_disassociate_task(struct bio *bio);
530#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400531static inline int bio_associate_blkcg(struct bio *bio,
532 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800533static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
534static inline void bio_disassociate_task(struct bio *bio) { }
535#endif /* CONFIG_BLK_CGROUP */
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537#ifdef CONFIG_HIGHMEM
538/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100539 * remember never ever reenable interrupts between a bvec_kmap_irq and
540 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100542static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 unsigned long addr;
545
546 /*
547 * might not be a highmem page, but the preempt/irq count
548 * balancing is a lot nicer this way
549 */
550 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800551 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553 BUG_ON(addr & ~PAGE_MASK);
554
555 return (char *) addr + bvec->bv_offset;
556}
557
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100558static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
560 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
561
Cong Wange8e3c3d2011-11-25 23:14:27 +0800562 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 local_irq_restore(*flags);
564}
565
566#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200567static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
568{
569 return page_address(bvec->bv_page) + bvec->bv_offset;
570}
571
572static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
573{
574 *flags = 0;
575}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576#endif
577
Kent Overstreetf619d252013-08-07 14:30:33 -0700578static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 unsigned long *flags)
580{
Kent Overstreetf619d252013-08-07 14:30:33 -0700581 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
583#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
584
585#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700586 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
588
Jens Axboe7a67f632008-08-08 11:17:12 +0200589/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200590 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200591 *
592 * A bio_list anchors a singly-linked list of bios chained through the bi_next
593 * member of the bio. The bio_list also caches the last list member to allow
594 * fast access to the tail.
595 */
596struct bio_list {
597 struct bio *head;
598 struct bio *tail;
599};
600
601static inline int bio_list_empty(const struct bio_list *bl)
602{
603 return bl->head == NULL;
604}
605
606static inline void bio_list_init(struct bio_list *bl)
607{
608 bl->head = bl->tail = NULL;
609}
610
Jens Axboe320ae512013-10-24 09:20:05 +0100611#define BIO_EMPTY_LIST { NULL, NULL }
612
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200613#define bio_list_for_each(bio, bl) \
614 for (bio = (bl)->head; bio; bio = bio->bi_next)
615
616static inline unsigned bio_list_size(const struct bio_list *bl)
617{
618 unsigned sz = 0;
619 struct bio *bio;
620
621 bio_list_for_each(bio, bl)
622 sz++;
623
624 return sz;
625}
626
627static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
628{
629 bio->bi_next = NULL;
630
631 if (bl->tail)
632 bl->tail->bi_next = bio;
633 else
634 bl->head = bio;
635
636 bl->tail = bio;
637}
638
639static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
640{
641 bio->bi_next = bl->head;
642
643 bl->head = bio;
644
645 if (!bl->tail)
646 bl->tail = bio;
647}
648
649static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
650{
651 if (!bl2->head)
652 return;
653
654 if (bl->tail)
655 bl->tail->bi_next = bl2->head;
656 else
657 bl->head = bl2->head;
658
659 bl->tail = bl2->tail;
660}
661
662static inline void bio_list_merge_head(struct bio_list *bl,
663 struct bio_list *bl2)
664{
665 if (!bl2->head)
666 return;
667
668 if (bl->head)
669 bl2->tail->bi_next = bl->head;
670 else
671 bl->tail = bl2->tail;
672
673 bl->head = bl2->head;
674}
675
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000676static inline struct bio *bio_list_peek(struct bio_list *bl)
677{
678 return bl->head;
679}
680
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200681static inline struct bio *bio_list_pop(struct bio_list *bl)
682{
683 struct bio *bio = bl->head;
684
685 if (bio) {
686 bl->head = bl->head->bi_next;
687 if (!bl->head)
688 bl->tail = NULL;
689
690 bio->bi_next = NULL;
691 }
692
693 return bio;
694}
695
696static inline struct bio *bio_list_get(struct bio_list *bl)
697{
698 struct bio *bio = bl->head;
699
700 bl->head = bl->tail = NULL;
701
702 return bio;
703}
704
Kent Overstreet57fb2332012-08-24 04:56:11 -0700705/*
706 * bio_set is used to allow other portions of the IO system to
707 * allocate their own private memory pools for bio and iovec structures.
708 * These memory pools in turn all allocate from the bio_slab
709 * and the bvec_slabs[].
710 */
711#define BIO_POOL_SIZE 2
712#define BIOVEC_NR_POOLS 6
713#define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
714
715struct bio_set {
716 struct kmem_cache *bio_slab;
717 unsigned int front_pad;
718
719 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700720 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700721#if defined(CONFIG_BLK_DEV_INTEGRITY)
722 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700723 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700724#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700725
726 /*
727 * Deadlock avoidance for stacking block drivers: see comments in
728 * bio_alloc_bioset() for details
729 */
730 spinlock_t rescue_lock;
731 struct bio_list rescue_list;
732 struct work_struct rescue_work;
733 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700734};
735
736struct biovec_slab {
737 int nr_vecs;
738 char *name;
739 struct kmem_cache *slab;
740};
741
742/*
743 * a small number of entries is fine, not going to be performance critical.
744 * basically we just need to survive
745 */
746#define BIO_SPLIT_ENTRIES 2
747
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200748#if defined(CONFIG_BLK_DEV_INTEGRITY)
749
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800750#define bip_for_each_vec(bvl, bip, iter) \
751 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200752
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200753#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
754 for_each_bio(_bio) \
755 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
756
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200757extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700758extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200759extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400760extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200761extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200762extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200763extern void bio_integrity_advance(struct bio *, unsigned int);
764extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700765extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200766extern int bioset_integrity_create(struct bio_set *, int);
767extern void bioset_integrity_free(struct bio_set *);
768extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200769
770#else /* CONFIG_BLK_DEV_INTEGRITY */
771
Martin K. Petersenc6115292014-09-26 19:20:08 -0400772static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100773{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400774 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100775}
776
Martin K. Petersene7258c12014-09-26 19:19:55 -0400777static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100778{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400779 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100780}
781
782static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
783{
784 return 0;
785}
786
787static inline void bioset_integrity_free (struct bio_set *bs)
788{
789 return;
790}
791
792static inline int bio_integrity_prep(struct bio *bio)
793{
794 return 0;
795}
796
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700797static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100798{
799 return;
800}
801
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100802static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700803 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100804{
805 return 0;
806}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100807
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100808static inline void bio_integrity_advance(struct bio *bio,
809 unsigned int bytes_done)
810{
811 return;
812}
813
814static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
815 unsigned int sectors)
816{
817 return;
818}
819
820static inline void bio_integrity_init(void)
821{
822 return;
823}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200824
Martin K. Petersenc6115292014-09-26 19:20:08 -0400825static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
826{
827 return false;
828}
829
Keith Busch06c1e392015-12-03 09:32:21 -0700830static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
831 unsigned int nr)
832{
833 return ERR_PTR(-EINVAL);
834}
835
836static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
837 unsigned int len, unsigned int offset)
838{
839 return 0;
840}
841
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200842#endif /* CONFIG_BLK_DEV_INTEGRITY */
843
David Howells02a5e0a2007-08-11 22:34:32 +0200844#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845#endif /* __LINUX_BIO_H */