blob: 4568647269a75ac205b6bccabb15dbbcf67ae2a2 [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
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030044#define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
46
Mike Christief2150822016-06-05 14:31:42 -050047#define bio_op(bio) (op_from_rq_bits((bio)->bi_rw))
48#define bio_set_op_attrs(bio, op, flags) ((bio)->bi_rw |= (op | flags))
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Jens Axboe22e2c502005-06-27 10:55:12 +020051 * upper 16 bits of bi_rw define the io priority of this bio
52 */
53#define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
54#define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
55#define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
56
57#define bio_set_prio(bio, prio) do { \
58 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
59 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
60 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
61} while (0)
62
63/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * various member access, note that bio_data should of course not be used
65 * on highmem page vectors
66 */
Kent Overstreet4550dd62013-08-07 14:26:21 -070067#define __bvec_iter_bvec(bvec, iter) (&(bvec)[(iter).bi_idx])
Kent Overstreeta4ad39b12013-08-07 14:24:32 -070068
Kent Overstreet4550dd62013-08-07 14:26:21 -070069#define bvec_iter_page(bvec, iter) \
70 (__bvec_iter_bvec((bvec), (iter))->bv_page)
71
72#define bvec_iter_len(bvec, iter) \
73 min((iter).bi_size, \
74 __bvec_iter_bvec((bvec), (iter))->bv_len - (iter).bi_bvec_done)
75
76#define bvec_iter_offset(bvec, iter) \
77 (__bvec_iter_bvec((bvec), (iter))->bv_offset + (iter).bi_bvec_done)
78
79#define bvec_iter_bvec(bvec, iter) \
80((struct bio_vec) { \
81 .bv_page = bvec_iter_page((bvec), (iter)), \
82 .bv_len = bvec_iter_len((bvec), (iter)), \
83 .bv_offset = bvec_iter_offset((bvec), (iter)), \
84})
85
86#define bio_iter_iovec(bio, iter) \
87 bvec_iter_bvec((bio)->bi_io_vec, (iter))
88
89#define bio_iter_page(bio, iter) \
90 bvec_iter_page((bio)->bi_io_vec, (iter))
91#define bio_iter_len(bio, iter) \
92 bvec_iter_len((bio)->bi_io_vec, (iter))
93#define bio_iter_offset(bio, iter) \
94 bvec_iter_offset((bio)->bi_io_vec, (iter))
95
96#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
97#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
98#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080099
Kent Overstreet458b76e2013-09-24 16:26:05 -0700100#define bio_multiple_segments(bio) \
101 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -0700102#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
103#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200104
Kent Overstreet458b76e2013-09-24 16:26:05 -0700105/*
106 * Check whether this bio carries any data or not. A NULL bio is allowed.
107 */
108static inline bool bio_has_data(struct bio *bio)
109{
110 if (bio &&
111 bio->bi_iter.bi_size &&
Mike Christie95fe6c12016-06-05 14:31:48 -0500112 bio_op(bio) != REQ_OP_DISCARD)
Kent Overstreet458b76e2013-09-24 16:26:05 -0700113 return true;
114
115 return false;
116}
117
Mike Christie95fe6c12016-06-05 14:31:48 -0500118static inline bool bio_no_advance_iter(struct bio *bio)
119{
120 return bio_op(bio) == REQ_OP_DISCARD || bio_op(bio) == REQ_OP_WRITE_SAME;
121}
122
Kent Overstreet458b76e2013-09-24 16:26:05 -0700123static inline bool bio_is_rw(struct bio *bio)
124{
125 if (!bio_has_data(bio))
126 return false;
127
Mike Christie95fe6c12016-06-05 14:31:48 -0500128 if (bio_no_advance_iter(bio))
Kent Overstreet458b76e2013-09-24 16:26:05 -0700129 return false;
130
131 return true;
132}
133
134static inline bool bio_mergeable(struct bio *bio)
135{
136 if (bio->bi_rw & REQ_NOMERGE_FLAGS)
137 return false;
138
139 return true;
140}
141
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900142static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200143{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700144 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700145 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100146 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700147 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200148}
149
150static inline void *bio_data(struct bio *bio)
151{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700152 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200153 return page_address(bio_page(bio)) + bio_offset(bio);
154
155 return NULL;
156}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158/*
159 * will die
160 */
161#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
162#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
163
164/*
165 * queues that have highmem support enabled may still need to revert to
166 * PIO transfers occasionally and thus map high pages temporarily. For
167 * permanent PIO fall back, user is probably better off disabling highmem
168 * I/O completely on that queue (see ide-dma for example)
169 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700170#define __bio_kmap_atomic(bio, iter) \
171 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
172 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Kent Overstreetf619d252013-08-07 14:30:33 -0700174#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176/*
177 * merge helpers etc
178 */
179
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100180/* Default implementation of BIOVEC_PHYS_MERGEABLE */
181#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
182 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/*
185 * allow arch override, for eg virtualized architectures (put in asm/io.h)
186 */
187#ifndef BIOVEC_PHYS_MERGEABLE
188#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100189 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190#endif
191
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
193 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
194#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400195 __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 -0700196
Jens Axboe66cb45a2014-06-24 16:22:24 -0600197/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800198 * drivers should _never_ use the all version - the bio may have been split
199 * before it got to the driver and the driver won't own all of it
200 */
201#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700202 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800203
Kent Overstreet4550dd62013-08-07 14:26:21 -0700204static inline void bvec_iter_advance(struct bio_vec *bv, struct bvec_iter *iter,
205 unsigned bytes)
206{
207 WARN_ONCE(bytes > iter->bi_size,
208 "Attempted to advance past end of bvec iter\n");
209
210 while (bytes) {
211 unsigned len = min(bytes, bvec_iter_len(bv, *iter));
212
213 bytes -= len;
214 iter->bi_size -= len;
215 iter->bi_bvec_done += len;
216
217 if (iter->bi_bvec_done == __bvec_iter_bvec(bv, *iter)->bv_len) {
218 iter->bi_bvec_done = 0;
219 iter->bi_idx++;
220 }
221 }
222}
223
224#define for_each_bvec(bvl, bio_vec, iter, start) \
Martin K. Petersenb7aa84d2014-04-08 22:43:43 -0400225 for (iter = (start); \
226 (iter).bi_size && \
227 ((bvl = bvec_iter_bvec((bio_vec), (iter))), 1); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700228 bvec_iter_advance((bio_vec), &(iter), (bvl).bv_len))
229
230
231static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
232 unsigned bytes)
233{
234 iter->bi_sector += bytes >> 9;
235
Mike Christie95fe6c12016-06-05 14:31:48 -0500236 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700237 iter->bi_size -= bytes;
238 else
239 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
240}
241
Kent Overstreet79886132013-11-23 17:19:00 -0800242#define __bio_for_each_segment(bvl, bio, iter, start) \
243 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700244 (iter).bi_size && \
245 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
246 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800247
248#define bio_for_each_segment(bvl, bio, iter) \
249 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
250
Kent Overstreet4550dd62013-08-07 14:26:21 -0700251#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Kent Overstreet458b76e2013-09-24 16:26:05 -0700253static inline unsigned bio_segments(struct bio *bio)
254{
255 unsigned segs = 0;
256 struct bio_vec bv;
257 struct bvec_iter iter;
258
Kent Overstreet8423ae32014-02-10 17:45:50 -0800259 /*
260 * We special case discard/write same, because they interpret bi_size
261 * differently:
262 */
263
Mike Christie95fe6c12016-06-05 14:31:48 -0500264 if (bio_op(bio) == REQ_OP_DISCARD)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800265 return 1;
266
Mike Christie95fe6c12016-06-05 14:31:48 -0500267 if (bio_op(bio) == REQ_OP_WRITE_SAME)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800268 return 1;
269
Kent Overstreet458b76e2013-09-24 16:26:05 -0700270 bio_for_each_segment(bv, bio, iter)
271 segs++;
272
273 return segs;
274}
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276/*
277 * get a reference to a bio, so it won't disappear. the intended use is
278 * something like:
279 *
280 * bio_get(bio);
281 * submit_bio(rw, bio);
282 * if (bio->bi_flags ...)
283 * do_something
284 * bio_put(bio);
285 *
286 * without the bio_get(), it could potentially complete I/O before submit_bio
287 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
288 * runs
289 */
Jens Axboedac56212015-04-17 16:23:59 -0600290static inline void bio_get(struct bio *bio)
291{
292 bio->bi_flags |= (1 << BIO_REFFED);
293 smp_mb__before_atomic();
294 atomic_inc(&bio->__bi_cnt);
295}
296
297static inline void bio_cnt_set(struct bio *bio, unsigned int count)
298{
299 if (count != 1) {
300 bio->bi_flags |= (1 << BIO_REFFED);
301 smp_mb__before_atomic();
302 }
303 atomic_set(&bio->__bi_cnt, count);
304}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600306static inline bool bio_flagged(struct bio *bio, unsigned int bit)
307{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600308 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600309}
310
311static inline void bio_set_flag(struct bio *bio, unsigned int bit)
312{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600313 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600314}
315
316static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
317{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600318 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600319}
320
Ming Lei7bcd79a2016-02-26 23:40:50 +0800321static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
322{
323 *bv = bio_iovec(bio);
324}
325
326static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
327{
328 struct bvec_iter iter = bio->bi_iter;
329 int idx;
330
Ming Lei7bcd79a2016-02-26 23:40:50 +0800331 if (unlikely(!bio_multiple_segments(bio))) {
332 *bv = bio_iovec(bio);
333 return;
334 }
335
336 bio_advance_iter(bio, &iter, iter.bi_size);
337
338 if (!iter.bi_bvec_done)
339 idx = iter.bi_idx - 1;
340 else /* in the middle of bvec */
341 idx = iter.bi_idx;
342
343 *bv = bio->bi_io_vec[idx];
344
345 /*
346 * iter.bi_bvec_done records actual length of the last bvec
347 * if this bio ends in the middle of one io vector
348 */
349 if (iter.bi_bvec_done)
350 bv->bv_len = iter.bi_bvec_done;
351}
352
Martin K. Petersenc6115292014-09-26 19:20:08 -0400353enum bip_flags {
354 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
355 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
356 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
357 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
358 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
359};
360
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200361/*
362 * bio integrity payload
363 */
364struct bio_integrity_payload {
365 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200366
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800367 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200368
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800369 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200370
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200371 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200372 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600373 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400374 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200375
376 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700377
378 struct bio_vec *bip_vec;
379 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200380};
Martin K. Petersen18593082014-09-26 19:20:01 -0400381
Keith Busch06c1e392015-12-03 09:32:21 -0700382#if defined(CONFIG_BLK_DEV_INTEGRITY)
383
384static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
385{
386 if (bio->bi_rw & REQ_INTEGRITY)
387 return bio->bi_integrity;
388
389 return NULL;
390}
391
Martin K. Petersenc6115292014-09-26 19:20:08 -0400392static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
393{
394 struct bio_integrity_payload *bip = bio_integrity(bio);
395
396 if (bip)
397 return bip->bip_flags & flag;
398
399 return false;
400}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400401
Martin K. Petersen18593082014-09-26 19:20:01 -0400402static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
403{
404 return bip->bip_iter.bi_sector;
405}
406
407static inline void bip_set_seed(struct bio_integrity_payload *bip,
408 sector_t seed)
409{
410 bip->bip_iter.bi_sector = seed;
411}
412
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200413#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Kent Overstreet6678d832013-08-07 11:14:32 -0700415extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800416extern struct bio *bio_split(struct bio *bio, int sectors,
417 gfp_t gfp, struct bio_set *bs);
418
419/**
420 * bio_next_split - get next @sectors from a bio, splitting if necessary
421 * @bio: bio to split
422 * @sectors: number of sectors to split from the front of @bio
423 * @gfp: gfp mask
424 * @bs: bio set to allocate from
425 *
426 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
427 * than @sectors, returns the original bio unchanged.
428 */
429static inline struct bio *bio_next_split(struct bio *bio, int sectors,
430 gfp_t gfp, struct bio_set *bs)
431{
432 if (sectors >= bio_sectors(bio))
433 return bio;
434
435 return bio_split(bio, sectors, gfp, bs);
436}
437
Jens Axboebb799ca2008-12-10 15:35:05 +0100438extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400439extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600441extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Al Virodd0fc662005-10-07 07:46:04 +0100443extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Kent Overstreet59d276f2013-11-23 18:19:27 -0800446extern void __bio_clone_fast(struct bio *, struct bio *);
447extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700448extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
449
Kent Overstreet3f86a822012-09-06 15:35:01 -0700450extern struct bio_set *fs_bio_set;
451
452static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
453{
454 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
455}
456
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700457static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
458{
459 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
460}
461
Kent Overstreet3f86a822012-09-06 15:35:01 -0700462static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
463{
464 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
465}
466
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700467static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
468{
469 return bio_clone_bioset(bio, gfp_mask, NULL);
470
471}
472
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200473extern void bio_endio(struct bio *);
474
475static inline void bio_io_error(struct bio *bio)
476{
477 bio->bi_error = -EIO;
478 bio_endio(bio);
479}
480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481struct request_queue;
482extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Mike Christie4e49ea42016-06-05 14:31:41 -0500484extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700485extern void bio_advance(struct bio *, unsigned);
486
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487extern void bio_init(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700488extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800489void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
491extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600492extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
493 unsigned int, unsigned int);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900494struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200495extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100496 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200498extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400499 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200500extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
501 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502extern void bio_set_pages_dirty(struct bio *bio);
503extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100504
Gu Zheng394ffa52014-11-24 11:05:22 +0800505void generic_start_io_acct(int rw, unsigned long sectors,
506 struct hd_struct *part);
507void generic_end_io_acct(int rw, struct hd_struct *part,
508 unsigned long start_time);
509
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100510#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
511# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
512#endif
513#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
514extern void bio_flush_dcache_pages(struct bio *bi);
515#else
516static inline void bio_flush_dcache_pages(struct bio *bi)
517{
518}
519#endif
520
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700521extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700522extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700523
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900524extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500525 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100526 const struct iov_iter *,
527 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528extern int bio_uncopy_user(struct bio *);
529void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700530extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
531extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200532extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200533
Tejun Heo852c7882012-03-05 13:15:27 -0800534#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400535int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800536int bio_associate_current(struct bio *bio);
537void bio_disassociate_task(struct bio *bio);
538#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400539static inline int bio_associate_blkcg(struct bio *bio,
540 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800541static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
542static inline void bio_disassociate_task(struct bio *bio) { }
543#endif /* CONFIG_BLK_CGROUP */
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545#ifdef CONFIG_HIGHMEM
546/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100547 * remember never ever reenable interrupts between a bvec_kmap_irq and
548 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100550static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
552 unsigned long addr;
553
554 /*
555 * might not be a highmem page, but the preempt/irq count
556 * balancing is a lot nicer this way
557 */
558 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800559 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561 BUG_ON(addr & ~PAGE_MASK);
562
563 return (char *) addr + bvec->bv_offset;
564}
565
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100566static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
568 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
569
Cong Wange8e3c3d2011-11-25 23:14:27 +0800570 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 local_irq_restore(*flags);
572}
573
574#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200575static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
576{
577 return page_address(bvec->bv_page) + bvec->bv_offset;
578}
579
580static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
581{
582 *flags = 0;
583}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#endif
585
Kent Overstreetf619d252013-08-07 14:30:33 -0700586static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 unsigned long *flags)
588{
Kent Overstreetf619d252013-08-07 14:30:33 -0700589 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
592
593#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700594 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
596
Jens Axboe7a67f632008-08-08 11:17:12 +0200597/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200598 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200599 *
600 * A bio_list anchors a singly-linked list of bios chained through the bi_next
601 * member of the bio. The bio_list also caches the last list member to allow
602 * fast access to the tail.
603 */
604struct bio_list {
605 struct bio *head;
606 struct bio *tail;
607};
608
609static inline int bio_list_empty(const struct bio_list *bl)
610{
611 return bl->head == NULL;
612}
613
614static inline void bio_list_init(struct bio_list *bl)
615{
616 bl->head = bl->tail = NULL;
617}
618
Jens Axboe320ae512013-10-24 09:20:05 +0100619#define BIO_EMPTY_LIST { NULL, NULL }
620
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200621#define bio_list_for_each(bio, bl) \
622 for (bio = (bl)->head; bio; bio = bio->bi_next)
623
624static inline unsigned bio_list_size(const struct bio_list *bl)
625{
626 unsigned sz = 0;
627 struct bio *bio;
628
629 bio_list_for_each(bio, bl)
630 sz++;
631
632 return sz;
633}
634
635static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
636{
637 bio->bi_next = NULL;
638
639 if (bl->tail)
640 bl->tail->bi_next = bio;
641 else
642 bl->head = bio;
643
644 bl->tail = bio;
645}
646
647static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
648{
649 bio->bi_next = bl->head;
650
651 bl->head = bio;
652
653 if (!bl->tail)
654 bl->tail = bio;
655}
656
657static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
658{
659 if (!bl2->head)
660 return;
661
662 if (bl->tail)
663 bl->tail->bi_next = bl2->head;
664 else
665 bl->head = bl2->head;
666
667 bl->tail = bl2->tail;
668}
669
670static inline void bio_list_merge_head(struct bio_list *bl,
671 struct bio_list *bl2)
672{
673 if (!bl2->head)
674 return;
675
676 if (bl->head)
677 bl2->tail->bi_next = bl->head;
678 else
679 bl->tail = bl2->tail;
680
681 bl->head = bl2->head;
682}
683
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000684static inline struct bio *bio_list_peek(struct bio_list *bl)
685{
686 return bl->head;
687}
688
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200689static inline struct bio *bio_list_pop(struct bio_list *bl)
690{
691 struct bio *bio = bl->head;
692
693 if (bio) {
694 bl->head = bl->head->bi_next;
695 if (!bl->head)
696 bl->tail = NULL;
697
698 bio->bi_next = NULL;
699 }
700
701 return bio;
702}
703
704static inline struct bio *bio_list_get(struct bio_list *bl)
705{
706 struct bio *bio = bl->head;
707
708 bl->head = bl->tail = NULL;
709
710 return bio;
711}
712
Kent Overstreet57fb2332012-08-24 04:56:11 -0700713/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400714 * Increment chain count for the bio. Make sure the CHAIN flag update
715 * is visible before the raised count.
716 */
717static inline void bio_inc_remaining(struct bio *bio)
718{
719 bio_set_flag(bio, BIO_CHAIN);
720 smp_mb__before_atomic();
721 atomic_inc(&bio->__bi_remaining);
722}
723
724/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700725 * bio_set is used to allow other portions of the IO system to
726 * allocate their own private memory pools for bio and iovec structures.
727 * These memory pools in turn all allocate from the bio_slab
728 * and the bvec_slabs[].
729 */
730#define BIO_POOL_SIZE 2
731#define BIOVEC_NR_POOLS 6
732#define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
733
734struct bio_set {
735 struct kmem_cache *bio_slab;
736 unsigned int front_pad;
737
738 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700739 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700740#if defined(CONFIG_BLK_DEV_INTEGRITY)
741 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700742 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700743#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700744
745 /*
746 * Deadlock avoidance for stacking block drivers: see comments in
747 * bio_alloc_bioset() for details
748 */
749 spinlock_t rescue_lock;
750 struct bio_list rescue_list;
751 struct work_struct rescue_work;
752 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700753};
754
755struct biovec_slab {
756 int nr_vecs;
757 char *name;
758 struct kmem_cache *slab;
759};
760
761/*
762 * a small number of entries is fine, not going to be performance critical.
763 * basically we just need to survive
764 */
765#define BIO_SPLIT_ENTRIES 2
766
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200767#if defined(CONFIG_BLK_DEV_INTEGRITY)
768
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800769#define bip_for_each_vec(bvl, bip, iter) \
770 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200771
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200772#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
773 for_each_bio(_bio) \
774 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
775
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200776extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700777extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200778extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400779extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200780extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200781extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200782extern void bio_integrity_advance(struct bio *, unsigned int);
783extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700784extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200785extern int bioset_integrity_create(struct bio_set *, int);
786extern void bioset_integrity_free(struct bio_set *);
787extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200788
789#else /* CONFIG_BLK_DEV_INTEGRITY */
790
Martin K. Petersenc6115292014-09-26 19:20:08 -0400791static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100792{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400793 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100794}
795
Martin K. Petersene7258c12014-09-26 19:19:55 -0400796static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100797{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400798 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100799}
800
801static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
802{
803 return 0;
804}
805
806static inline void bioset_integrity_free (struct bio_set *bs)
807{
808 return;
809}
810
811static inline int bio_integrity_prep(struct bio *bio)
812{
813 return 0;
814}
815
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700816static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100817{
818 return;
819}
820
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100821static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700822 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100823{
824 return 0;
825}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100826
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100827static inline void bio_integrity_advance(struct bio *bio,
828 unsigned int bytes_done)
829{
830 return;
831}
832
833static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
834 unsigned int sectors)
835{
836 return;
837}
838
839static inline void bio_integrity_init(void)
840{
841 return;
842}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200843
Martin K. Petersenc6115292014-09-26 19:20:08 -0400844static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
845{
846 return false;
847}
848
Keith Busch06c1e392015-12-03 09:32:21 -0700849static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
850 unsigned int nr)
851{
852 return ERR_PTR(-EINVAL);
853}
854
855static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
856 unsigned int len, unsigned int offset)
857{
858 return 0;
859}
860
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200861#endif /* CONFIG_BLK_DEV_INTEGRITY */
862
David Howells02a5e0a2007-08-11 22:34:32 +0200863#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864#endif /* __LINUX_BIO_H */