blob: e09a8895fc31d1a348606a29dd06e46425270595 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * 2.5 block I/O model
3 *
4 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tejun Heo7cc01582010-08-03 13:14:58 +020012 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public Licens
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
19 */
20#ifndef __LINUX_BIO_H
21#define __LINUX_BIO_H
22
23#include <linux/highmem.h>
24#include <linux/mempool.h>
Jens Axboe22e2c502005-06-27 10:55:12 +020025#include <linux/ioprio.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050026#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
David Howells02a5e0a2007-08-11 22:34:32 +020028#ifdef CONFIG_BLOCK
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <asm/io.h>
31
Tejun Heo7cc01582010-08-03 13:14:58 +020032/* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
33#include <linux/blk_types.h>
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define BIO_DEBUG
36
37#ifdef BIO_DEBUG
38#define BIO_BUG_ON BUG_ON
39#else
40#define BIO_BUG_ON
41#endif
42
Alexey Dobriyand84a8472006-06-25 05:49:32 -070043#define BIO_MAX_PAGES 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Mike Christie43b62ce2016-06-05 14:32:20 -050045#define bio_prio(bio) (bio)->bi_ioprio
46#define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
Jens Axboe22e2c502005-06-27 10:55:12 +020047
Kent Overstreet4550dd62013-08-07 14:26:21 -070048#define bio_iter_iovec(bio, iter) \
49 bvec_iter_bvec((bio)->bi_io_vec, (iter))
50
51#define bio_iter_page(bio, iter) \
52 bvec_iter_page((bio)->bi_io_vec, (iter))
53#define bio_iter_len(bio, iter) \
54 bvec_iter_len((bio)->bi_io_vec, (iter))
55#define bio_iter_offset(bio, iter) \
56 bvec_iter_offset((bio)->bi_io_vec, (iter))
57
58#define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
59#define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
60#define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
Kent Overstreet79886132013-11-23 17:19:00 -080061
Kent Overstreet458b76e2013-09-24 16:26:05 -070062#define bio_multiple_segments(bio) \
63 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
Kent Overstreet4f024f32013-10-11 15:44:27 -070064#define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
65#define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
Jens Axboebf2de6f2007-09-27 13:01:25 +020066
Kent Overstreet458b76e2013-09-24 16:26:05 -070067/*
68 * Check whether this bio carries any data or not. A NULL bio is allowed.
69 */
70static inline bool bio_has_data(struct bio *bio)
71{
72 if (bio &&
73 bio->bi_iter.bi_size &&
Mike Christie95fe6c12016-06-05 14:31:48 -050074 bio_op(bio) != REQ_OP_DISCARD)
Kent Overstreet458b76e2013-09-24 16:26:05 -070075 return true;
76
77 return false;
78}
79
Mike Christie95fe6c12016-06-05 14:31:48 -050080static inline bool bio_no_advance_iter(struct bio *bio)
81{
82 return bio_op(bio) == REQ_OP_DISCARD || bio_op(bio) == REQ_OP_WRITE_SAME;
83}
84
Kent Overstreet458b76e2013-09-24 16:26:05 -070085static inline bool bio_is_rw(struct bio *bio)
86{
87 if (!bio_has_data(bio))
88 return false;
89
Mike Christie95fe6c12016-06-05 14:31:48 -050090 if (bio_no_advance_iter(bio))
Kent Overstreet458b76e2013-09-24 16:26:05 -070091 return false;
92
93 return true;
94}
95
96static inline bool bio_mergeable(struct bio *bio)
97{
98 if (bio->bi_rw & REQ_NOMERGE_FLAGS)
99 return false;
100
101 return true;
102}
103
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900104static inline unsigned int bio_cur_bytes(struct bio *bio)
Jens Axboebf2de6f2007-09-27 13:01:25 +0200105{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700106 if (bio_has_data(bio))
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700107 return bio_iovec(bio).bv_len;
David Woodhousefb2dce82008-08-05 18:01:53 +0100108 else /* dataless requests such as discard */
Kent Overstreet4f024f32013-10-11 15:44:27 -0700109 return bio->bi_iter.bi_size;
Jens Axboebf2de6f2007-09-27 13:01:25 +0200110}
111
112static inline void *bio_data(struct bio *bio)
113{
Kent Overstreet458b76e2013-09-24 16:26:05 -0700114 if (bio_has_data(bio))
Jens Axboebf2de6f2007-09-27 13:01:25 +0200115 return page_address(bio_page(bio)) + bio_offset(bio);
116
117 return NULL;
118}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120/*
121 * will die
122 */
123#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
124#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
125
126/*
127 * queues that have highmem support enabled may still need to revert to
128 * PIO transfers occasionally and thus map high pages temporarily. For
129 * permanent PIO fall back, user is probably better off disabling highmem
130 * I/O completely on that queue (see ide-dma for example)
131 */
Kent Overstreetf619d252013-08-07 14:30:33 -0700132#define __bio_kmap_atomic(bio, iter) \
133 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
134 bio_iter_iovec((bio), (iter)).bv_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Kent Overstreetf619d252013-08-07 14:30:33 -0700136#define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138/*
139 * merge helpers etc
140 */
141
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100142/* Default implementation of BIOVEC_PHYS_MERGEABLE */
143#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
144 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146/*
147 * allow arch override, for eg virtualized architectures (put in asm/io.h)
148 */
149#ifndef BIOVEC_PHYS_MERGEABLE
150#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
Jeremy Fitzhardingef92131c2008-10-29 14:10:51 +0100151 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#endif
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
155 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
156#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400157 __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 -0700158
Jens Axboe66cb45a2014-06-24 16:22:24 -0600159/*
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800160 * drivers should _never_ use the all version - the bio may have been split
161 * before it got to the driver and the driver won't own all of it
162 */
163#define bio_for_each_segment_all(bvl, bio, i) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700164 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
Kent Overstreetd74c6d52013-02-06 12:23:11 -0800165
Kent Overstreet4550dd62013-08-07 14:26:21 -0700166static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
167 unsigned bytes)
168{
169 iter->bi_sector += bytes >> 9;
170
Mike Christie95fe6c12016-06-05 14:31:48 -0500171 if (bio_no_advance_iter(bio))
Kent Overstreet4550dd62013-08-07 14:26:21 -0700172 iter->bi_size -= bytes;
173 else
174 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
175}
176
Kent Overstreet79886132013-11-23 17:19:00 -0800177#define __bio_for_each_segment(bvl, bio, iter, start) \
178 for (iter = (start); \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700179 (iter).bi_size && \
180 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
181 bio_advance_iter((bio), &(iter), (bvl).bv_len))
Kent Overstreet79886132013-11-23 17:19:00 -0800182
183#define bio_for_each_segment(bvl, bio, iter) \
184 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
185
Kent Overstreet4550dd62013-08-07 14:26:21 -0700186#define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Kent Overstreet458b76e2013-09-24 16:26:05 -0700188static inline unsigned bio_segments(struct bio *bio)
189{
190 unsigned segs = 0;
191 struct bio_vec bv;
192 struct bvec_iter iter;
193
Kent Overstreet8423ae32014-02-10 17:45:50 -0800194 /*
195 * We special case discard/write same, because they interpret bi_size
196 * differently:
197 */
198
Mike Christie95fe6c12016-06-05 14:31:48 -0500199 if (bio_op(bio) == REQ_OP_DISCARD)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800200 return 1;
201
Mike Christie95fe6c12016-06-05 14:31:48 -0500202 if (bio_op(bio) == REQ_OP_WRITE_SAME)
Kent Overstreet8423ae32014-02-10 17:45:50 -0800203 return 1;
204
Kent Overstreet458b76e2013-09-24 16:26:05 -0700205 bio_for_each_segment(bv, bio, iter)
206 segs++;
207
208 return segs;
209}
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/*
212 * get a reference to a bio, so it won't disappear. the intended use is
213 * something like:
214 *
215 * bio_get(bio);
216 * submit_bio(rw, bio);
217 * if (bio->bi_flags ...)
218 * do_something
219 * bio_put(bio);
220 *
221 * without the bio_get(), it could potentially complete I/O before submit_bio
222 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
223 * runs
224 */
Jens Axboedac56212015-04-17 16:23:59 -0600225static inline void bio_get(struct bio *bio)
226{
227 bio->bi_flags |= (1 << BIO_REFFED);
228 smp_mb__before_atomic();
229 atomic_inc(&bio->__bi_cnt);
230}
231
232static inline void bio_cnt_set(struct bio *bio, unsigned int count)
233{
234 if (count != 1) {
235 bio->bi_flags |= (1 << BIO_REFFED);
236 smp_mb__before_atomic();
237 }
238 atomic_set(&bio->__bi_cnt, count);
239}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600241static inline bool bio_flagged(struct bio *bio, unsigned int bit)
242{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600243 return (bio->bi_flags & (1U << bit)) != 0;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600244}
245
246static inline void bio_set_flag(struct bio *bio, unsigned int bit)
247{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600248 bio->bi_flags |= (1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600249}
250
251static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
252{
Jens Axboe2c68f6d2015-07-28 13:14:32 -0600253 bio->bi_flags &= ~(1U << bit);
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600254}
255
Ming Lei7bcd79a2016-02-26 23:40:50 +0800256static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
257{
258 *bv = bio_iovec(bio);
259}
260
261static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
262{
263 struct bvec_iter iter = bio->bi_iter;
264 int idx;
265
Ming Lei7bcd79a2016-02-26 23:40:50 +0800266 if (unlikely(!bio_multiple_segments(bio))) {
267 *bv = bio_iovec(bio);
268 return;
269 }
270
271 bio_advance_iter(bio, &iter, iter.bi_size);
272
273 if (!iter.bi_bvec_done)
274 idx = iter.bi_idx - 1;
275 else /* in the middle of bvec */
276 idx = iter.bi_idx;
277
278 *bv = bio->bi_io_vec[idx];
279
280 /*
281 * iter.bi_bvec_done records actual length of the last bvec
282 * if this bio ends in the middle of one io vector
283 */
284 if (iter.bi_bvec_done)
285 bv->bv_len = iter.bi_bvec_done;
286}
287
Martin K. Petersenc6115292014-09-26 19:20:08 -0400288enum bip_flags {
289 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
290 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
291 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
292 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
293 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
294};
295
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200296/*
297 * bio integrity payload
298 */
299struct bio_integrity_payload {
300 struct bio *bip_bio; /* parent bio */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200301
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800302 struct bvec_iter bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200303
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800304 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200306 unsigned short bip_slab; /* slab the bip came from */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200307 unsigned short bip_vcnt; /* # of integrity bio_vecs */
Gu Zhengcbcd10542014-07-01 10:36:47 -0600308 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400309 unsigned short bip_flags; /* control flags */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200310
311 struct work_struct bip_work; /* I/O completion */
Kent Overstreet6fda9812012-10-12 13:18:27 -0700312
313 struct bio_vec *bip_vec;
314 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200315};
Martin K. Petersen18593082014-09-26 19:20:01 -0400316
Keith Busch06c1e392015-12-03 09:32:21 -0700317#if defined(CONFIG_BLK_DEV_INTEGRITY)
318
319static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
320{
321 if (bio->bi_rw & REQ_INTEGRITY)
322 return bio->bi_integrity;
323
324 return NULL;
325}
326
Martin K. Petersenc6115292014-09-26 19:20:08 -0400327static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
328{
329 struct bio_integrity_payload *bip = bio_integrity(bio);
330
331 if (bip)
332 return bip->bip_flags & flag;
333
334 return false;
335}
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400336
Martin K. Petersen18593082014-09-26 19:20:01 -0400337static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
338{
339 return bip->bip_iter.bi_sector;
340}
341
342static inline void bip_set_seed(struct bio_integrity_payload *bip,
343 sector_t seed)
344{
345 bip->bip_iter.bi_sector = seed;
346}
347
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200348#endif /* CONFIG_BLK_DEV_INTEGRITY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Kent Overstreet6678d832013-08-07 11:14:32 -0700350extern void bio_trim(struct bio *bio, int offset, int size);
Kent Overstreet20d01892013-11-23 18:21:01 -0800351extern struct bio *bio_split(struct bio *bio, int sectors,
352 gfp_t gfp, struct bio_set *bs);
353
354/**
355 * bio_next_split - get next @sectors from a bio, splitting if necessary
356 * @bio: bio to split
357 * @sectors: number of sectors to split from the front of @bio
358 * @gfp: gfp mask
359 * @bs: bio set to allocate from
360 *
361 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
362 * than @sectors, returns the original bio unchanged.
363 */
364static inline struct bio *bio_next_split(struct bio *bio, int sectors,
365 gfp_t gfp, struct bio_set *bs)
366{
367 if (sectors >= bio_sectors(bio))
368 return bio;
369
370 return bio_split(bio, sectors, gfp, bs);
371}
372
Jens Axboebb799ca2008-12-10 15:35:05 +0100373extern struct bio_set *bioset_create(unsigned int, unsigned int);
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400374extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375extern void bioset_free(struct bio_set *);
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600376extern mempool_t *biovec_create_pool(int pool_entries);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Al Virodd0fc662005-10-07 07:46:04 +0100378extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379extern void bio_put(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Kent Overstreet59d276f2013-11-23 18:19:27 -0800381extern void __bio_clone_fast(struct bio *, struct bio *);
382extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700383extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
384
Kent Overstreet3f86a822012-09-06 15:35:01 -0700385extern struct bio_set *fs_bio_set;
386
387static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
388{
389 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
390}
391
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700392static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
393{
394 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
395}
396
Kent Overstreet3f86a822012-09-06 15:35:01 -0700397static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
398{
399 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
400}
401
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700402static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
403{
404 return bio_clone_bioset(bio, gfp_mask, NULL);
405
406}
407
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200408extern void bio_endio(struct bio *);
409
410static inline void bio_io_error(struct bio *bio)
411{
412 bio->bi_error = -EIO;
413 bio_endio(bio);
414}
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416struct request_queue;
417extern int bio_phys_segments(struct request_queue *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Mike Christie4e49ea42016-06-05 14:31:41 -0500419extern int submit_bio_wait(struct bio *bio);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700420extern void bio_advance(struct bio *, unsigned);
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422extern void bio_init(struct bio *);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700423extern void bio_reset(struct bio *);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800424void bio_chain(struct bio *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
Mike Christie6e68af62005-11-11 05:30:27 -0600427extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
428 unsigned int, unsigned int);
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900429struct rq_map_data;
James Bottomley f1970ba2005-06-20 14:06:52 +0200430extern struct bio *bio_map_user_iov(struct request_queue *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100431 const struct iov_iter *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432extern void bio_unmap_user(struct bio *);
Mike Christie df46b9a2005-06-20 14:04:44 +0200433extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
Al Viro27496a82005-10-21 03:20:48 -0400434 gfp_t);
FUJITA Tomonori68154e92008-04-25 12:47:50 +0200435extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
436 gfp_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437extern void bio_set_pages_dirty(struct bio *bio);
438extern void bio_check_pages_dirty(struct bio *bio);
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100439
Gu Zheng394ffa52014-11-24 11:05:22 +0800440void generic_start_io_acct(int rw, unsigned long sectors,
441 struct hd_struct *part);
442void generic_end_io_acct(int rw, struct hd_struct *part,
443 unsigned long start_time);
444
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100445#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
446# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
447#endif
448#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
449extern void bio_flush_dcache_pages(struct bio *bi);
450#else
451static inline void bio_flush_dcache_pages(struct bio *bi)
452{
453}
454#endif
455
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700456extern void bio_copy_data(struct bio *dst, struct bio *src);
Kent Overstreeta0787602012-09-10 14:03:28 -0700457extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700458
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900459extern struct bio *bio_copy_user_iov(struct request_queue *,
Al Viro86d564c2014-02-08 20:42:52 -0500460 struct rq_map_data *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100461 const struct iov_iter *,
462 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463extern int bio_uncopy_user(struct bio *);
464void zero_fill_bio(struct bio *bio);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700465extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
466extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200467extern unsigned int bvec_nr_vecs(unsigned short idx);
Martin K. Petersen51d654e2008-06-17 18:59:56 +0200468
Tejun Heo852c7882012-03-05 13:15:27 -0800469#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -0400470int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
Tejun Heo852c7882012-03-05 13:15:27 -0800471int bio_associate_current(struct bio *bio);
472void bio_disassociate_task(struct bio *bio);
Paolo Valente20bd7232016-07-27 07:22:05 +0200473void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
Tejun Heo852c7882012-03-05 13:15:27 -0800474#else /* CONFIG_BLK_CGROUP */
Tejun Heo1d933cf2015-05-22 17:13:24 -0400475static inline int bio_associate_blkcg(struct bio *bio,
476 struct cgroup_subsys_state *blkcg_css) { return 0; }
Tejun Heo852c7882012-03-05 13:15:27 -0800477static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
478static inline void bio_disassociate_task(struct bio *bio) { }
Paolo Valente20bd7232016-07-27 07:22:05 +0200479static inline void bio_clone_blkcg_association(struct bio *dst,
480 struct bio *src) { }
Tejun Heo852c7882012-03-05 13:15:27 -0800481#endif /* CONFIG_BLK_CGROUP */
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483#ifdef CONFIG_HIGHMEM
484/*
Alberto Bertogli20b636b2009-02-02 12:41:07 +0100485 * remember never ever reenable interrupts between a bvec_kmap_irq and
486 * bvec_kunmap_irq!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 */
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100488static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 unsigned long addr;
491
492 /*
493 * might not be a highmem page, but the preempt/irq count
494 * balancing is a lot nicer this way
495 */
496 local_irq_save(*flags);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800497 addr = (unsigned long) kmap_atomic(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499 BUG_ON(addr & ~PAGE_MASK);
500
501 return (char *) addr + bvec->bv_offset;
502}
503
Alberto Bertogli4f570f92009-11-02 11:40:16 +0100504static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
506 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
507
Cong Wange8e3c3d2011-11-25 23:14:27 +0800508 kunmap_atomic((void *) ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 local_irq_restore(*flags);
510}
511
512#else
Geert Uytterhoeven11a691b2010-10-21 10:32:29 +0200513static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
514{
515 return page_address(bvec->bv_page) + bvec->bv_offset;
516}
517
518static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
519{
520 *flags = 0;
521}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522#endif
523
Kent Overstreetf619d252013-08-07 14:30:33 -0700524static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 unsigned long *flags)
526{
Kent Overstreetf619d252013-08-07 14:30:33 -0700527 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
529#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
530
531#define bio_kmap_irq(bio, flags) \
Kent Overstreetf619d252013-08-07 14:30:33 -0700532 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
534
Jens Axboe7a67f632008-08-08 11:17:12 +0200535/*
Akinobu Mitae6863072009-04-17 08:41:21 +0200536 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200537 *
538 * A bio_list anchors a singly-linked list of bios chained through the bi_next
539 * member of the bio. The bio_list also caches the last list member to allow
540 * fast access to the tail.
541 */
542struct bio_list {
543 struct bio *head;
544 struct bio *tail;
545};
546
547static inline int bio_list_empty(const struct bio_list *bl)
548{
549 return bl->head == NULL;
550}
551
552static inline void bio_list_init(struct bio_list *bl)
553{
554 bl->head = bl->tail = NULL;
555}
556
Jens Axboe320ae512013-10-24 09:20:05 +0100557#define BIO_EMPTY_LIST { NULL, NULL }
558
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200559#define bio_list_for_each(bio, bl) \
560 for (bio = (bl)->head; bio; bio = bio->bi_next)
561
562static inline unsigned bio_list_size(const struct bio_list *bl)
563{
564 unsigned sz = 0;
565 struct bio *bio;
566
567 bio_list_for_each(bio, bl)
568 sz++;
569
570 return sz;
571}
572
573static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
574{
575 bio->bi_next = NULL;
576
577 if (bl->tail)
578 bl->tail->bi_next = bio;
579 else
580 bl->head = bio;
581
582 bl->tail = bio;
583}
584
585static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
586{
587 bio->bi_next = bl->head;
588
589 bl->head = bio;
590
591 if (!bl->tail)
592 bl->tail = bio;
593}
594
595static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
596{
597 if (!bl2->head)
598 return;
599
600 if (bl->tail)
601 bl->tail->bi_next = bl2->head;
602 else
603 bl->head = bl2->head;
604
605 bl->tail = bl2->tail;
606}
607
608static inline void bio_list_merge_head(struct bio_list *bl,
609 struct bio_list *bl2)
610{
611 if (!bl2->head)
612 return;
613
614 if (bl->head)
615 bl2->tail->bi_next = bl->head;
616 else
617 bl->tail = bl2->tail;
618
619 bl->head = bl2->head;
620}
621
Geert Uytterhoeven13685a12009-06-10 04:38:40 +0000622static inline struct bio *bio_list_peek(struct bio_list *bl)
623{
624 return bl->head;
625}
626
Christoph Hellwig8f3d8ba2009-04-07 19:55:13 +0200627static inline struct bio *bio_list_pop(struct bio_list *bl)
628{
629 struct bio *bio = bl->head;
630
631 if (bio) {
632 bl->head = bl->head->bi_next;
633 if (!bl->head)
634 bl->tail = NULL;
635
636 bio->bi_next = NULL;
637 }
638
639 return bio;
640}
641
642static inline struct bio *bio_list_get(struct bio_list *bl)
643{
644 struct bio *bio = bl->head;
645
646 bl->head = bl->tail = NULL;
647
648 return bio;
649}
650
Kent Overstreet57fb2332012-08-24 04:56:11 -0700651/*
Mike Snitzer0ef5a502016-05-05 11:54:22 -0400652 * Increment chain count for the bio. Make sure the CHAIN flag update
653 * is visible before the raised count.
654 */
655static inline void bio_inc_remaining(struct bio *bio)
656{
657 bio_set_flag(bio, BIO_CHAIN);
658 smp_mb__before_atomic();
659 atomic_inc(&bio->__bi_remaining);
660}
661
662/*
Kent Overstreet57fb2332012-08-24 04:56:11 -0700663 * bio_set is used to allow other portions of the IO system to
664 * allocate their own private memory pools for bio and iovec structures.
665 * These memory pools in turn all allocate from the bio_slab
666 * and the bvec_slabs[].
667 */
668#define BIO_POOL_SIZE 2
Kent Overstreet57fb2332012-08-24 04:56:11 -0700669
670struct bio_set {
671 struct kmem_cache *bio_slab;
672 unsigned int front_pad;
673
674 mempool_t *bio_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700675 mempool_t *bvec_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700676#if defined(CONFIG_BLK_DEV_INTEGRITY)
677 mempool_t *bio_integrity_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700678 mempool_t *bvec_integrity_pool;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700679#endif
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700680
681 /*
682 * Deadlock avoidance for stacking block drivers: see comments in
683 * bio_alloc_bioset() for details
684 */
685 spinlock_t rescue_lock;
686 struct bio_list rescue_list;
687 struct work_struct rescue_work;
688 struct workqueue_struct *rescue_workqueue;
Kent Overstreet57fb2332012-08-24 04:56:11 -0700689};
690
691struct biovec_slab {
692 int nr_vecs;
693 char *name;
694 struct kmem_cache *slab;
695};
696
697/*
698 * a small number of entries is fine, not going to be performance critical.
699 * basically we just need to survive
700 */
701#define BIO_SPLIT_ENTRIES 2
702
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200703#if defined(CONFIG_BLK_DEV_INTEGRITY)
704
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800705#define bip_for_each_vec(bvl, bip, iter) \
706 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200707
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200708#define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
709 for_each_bio(_bio) \
710 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
711
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200712extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700713extern void bio_integrity_free(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200714extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
Martin K. Petersene7258c12014-09-26 19:19:55 -0400715extern bool bio_integrity_enabled(struct bio *bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200716extern int bio_integrity_prep(struct bio *);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200717extern void bio_integrity_endio(struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200718extern void bio_integrity_advance(struct bio *, unsigned int);
719extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700720extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200721extern int bioset_integrity_create(struct bio_set *, int);
722extern void bioset_integrity_free(struct bio_set *);
723extern void bio_integrity_init(void);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200724
725#else /* CONFIG_BLK_DEV_INTEGRITY */
726
Martin K. Petersenc6115292014-09-26 19:20:08 -0400727static inline void *bio_integrity(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100728{
Martin K. Petersenc6115292014-09-26 19:20:08 -0400729 return NULL;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100730}
731
Martin K. Petersene7258c12014-09-26 19:19:55 -0400732static inline bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100733{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400734 return false;
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100735}
736
737static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
738{
739 return 0;
740}
741
742static inline void bioset_integrity_free (struct bio_set *bs)
743{
744 return;
745}
746
747static inline int bio_integrity_prep(struct bio *bio)
748{
749 return 0;
750}
751
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700752static inline void bio_integrity_free(struct bio *bio)
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100753{
754 return;
755}
756
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100757static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700758 gfp_t gfp_mask)
Stephen Rothwell0c614e22011-11-16 09:21:48 +0100759{
760 return 0;
761}
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100762
Martin K. Petersen6898e3b2012-01-13 08:15:33 +0100763static inline void bio_integrity_advance(struct bio *bio,
764 unsigned int bytes_done)
765{
766 return;
767}
768
769static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
770 unsigned int sectors)
771{
772 return;
773}
774
775static inline void bio_integrity_init(void)
776{
777 return;
778}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200779
Martin K. Petersenc6115292014-09-26 19:20:08 -0400780static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
781{
782 return false;
783}
784
Keith Busch06c1e392015-12-03 09:32:21 -0700785static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
786 unsigned int nr)
787{
788 return ERR_PTR(-EINVAL);
789}
790
791static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
792 unsigned int len, unsigned int offset)
793{
794 return 0;
795}
796
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200797#endif /* CONFIG_BLK_DEV_INTEGRITY */
798
David Howells02a5e0a2007-08-11 22:34:32 +0200799#endif /* CONFIG_BLOCK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800#endif /* __LINUX_BIO_H */