projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
bio, fs: update RWA_MASK, READA and SWRITE to match the corresponding BIO_RW_* bits
[linux-block.git] / include / linux / bio.h
CommitLineData
1da177e4
LT		 1/*
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
12
13 * 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>
22e2c507 25#include <linux/ioprio.h>
1da177e4 26
02a5e0ac
DH		 27#ifdef CONFIG_BLOCK
28
1da177e4
LT		 29#include <asm/io.h>
30
1da177e4
LT		 31#define BIO_DEBUG
32
33#ifdef BIO_DEBUG
34#define BIO_BUG_ON BUG_ON
35#else
36#define BIO_BUG_ON
37#endif
38
d84a8477 39#define BIO_MAX_PAGES 256
1da177e4
LT		 40#define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_CACHE_SHIFT)
41#define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
42
43/*
44 * was unsigned short, but we might as well be ready for > 64kB I/O pages
45 */
46struct bio_vec {
47 struct page *bv_page;
48 unsigned int bv_len;
49 unsigned int bv_offset;
50};
51
52struct bio_set;
53struct bio;
7ba1ba12 54struct bio_integrity_payload;
6712ecf8 55typedef void (bio_end_io_t) (struct bio *, int);
1da177e4
LT		 56typedef void (bio_destructor_t) (struct bio *);
57
58/*
59 * main unit of I/O for the block layer and lower layers (ie drivers and
60 * stacking drivers)
61 */
62struct bio {
2c2345c2
RG		 63 sector_t bi_sector; /* device address in 512 byte
64 sectors */
1da177e4
LT		 65 struct bio *bi_next; /* request queue link */
66 struct block_device *bi_bdev;
67 unsigned long bi_flags; /* status, command, etc */
68 unsigned long bi_rw; /* bottom bits READ/WRITE,
69 * top bits priority
70 */
71
72 unsigned short bi_vcnt; /* how many bio_vec's */
73 unsigned short bi_idx; /* current index into bvl_vec */
74
75 /* Number of segments in this BIO after
76 * physical address coalescing is performed.
77 */
5b99c2ff 78 unsigned int bi_phys_segments;
1da177e4 79
1da177e4
LT		 80 unsigned int bi_size; /* residual I/O count */
81
86771427
FT		 82 /*
83 * To keep track of the max segment size, we account for the
84 * sizes of the first and last mergeable segments in this bio.
85 */
86 unsigned int bi_seg_front_size;
87 unsigned int bi_seg_back_size;
88
1da177e4
LT		 89 unsigned int bi_max_vecs; /* max bvl_vecs we can hold */
90
c7c22e4d
JA		 91 unsigned int bi_comp_cpu; /* completion CPU */
92
ba744d5e
RK		 93 atomic_t bi_cnt; /* pin count */
94
1da177e4
LT		 95 struct bio_vec *bi_io_vec; /* the actual vec list */
96
97 bio_end_io_t *bi_end_io;
1da177e4
LT		 98
99 void *bi_private;
7ba1ba12
MP		 100#if defined(CONFIG_BLK_DEV_INTEGRITY)
101 struct bio_integrity_payload *bi_integrity; /* data integrity */
102#endif
1da177e4
LT		 103
104 bio_destructor_t *bi_destructor; /* destructor */
392ddc32
JA		 105
106 /*
107 * We can inline a number of vecs at the end of the bio, to avoid
108 * double allocations for a small number of bio_vecs. This member
109 * MUST obviously be kept at the very end of the bio.
110 */
111 struct bio_vec bi_inline_vecs[0];
1da177e4
LT		 112};
113
114/*
115 * bio flags
116 */
117#define BIO_UPTODATE 0 /* ok after I/O completion */
118#define BIO_RW_BLOCK 1 /* RW_AHEAD set, and read/write would block */
119#define BIO_EOF 2 /* out-out-bounds error */
5df97b91 120#define BIO_SEG_VALID 3 /* bi_phys_segments valid */
1da177e4
LT		 121#define BIO_CLONED 4 /* doesn't own data */
122#define BIO_BOUNCED 5 /* bio is a bounce bio */
123#define BIO_USER_MAPPED 6 /* contains user pages */
124#define BIO_EOPNOTSUPP 7 /* not supported */
c7c22e4d 125#define BIO_CPU_AFFINE 8 /* complete bio on same CPU as submitted */
81882766 126#define BIO_NULL_MAPPED 9 /* contains invalid user pages */
74aa8c2c 127#define BIO_FS_INTEGRITY 10 /* fs owns integrity data, not block layer */
08bafc03 128#define BIO_QUIET 11 /* Make BIO Quiet */
1da177e4
LT		 129#define bio_flagged(bio, flag) ((bio)->bi_flags & (1 << (flag)))
130
131/*
132 * top 4 bits of bio flags indicate the pool this bio came from
133 */
134#define BIO_POOL_BITS (4)
451a9ebf 135#define BIO_POOL_NONE ((1UL << BIO_POOL_BITS) - 1)
1da177e4
LT		 136#define BIO_POOL_OFFSET (BITS_PER_LONG - BIO_POOL_BITS)
137#define BIO_POOL_MASK (1UL << BIO_POOL_OFFSET)
138#define BIO_POOL_IDX(bio) ((bio)->bi_flags >> BIO_POOL_OFFSET)
139
140/*
7b6d91da
CH		 141 * Request flags. For use in the cmd_flags field of struct request, and in
142 * bi_rw of struct bio. Note that some flags are only valid in either one.
1da177e4 143 */
7b6d91da
CH		 144enum rq_flag_bits {
145 /* common flags */
146 __REQ_WRITE, /* not set, read. set, write */
147 __REQ_FAILFAST_DEV, /* no driver retries of device errors */
148 __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */
149 __REQ_FAILFAST_DRIVER, /* no driver retries of driver errors */
150
151 __REQ_HARDBARRIER, /* may not be passed by drive either */
152 __REQ_SYNC, /* request is sync (sync write or read) */
153 __REQ_META, /* metadata io request */
154 __REQ_DISCARD, /* request to discard sectors */
155 __REQ_NOIDLE, /* don't anticipate more IO after this one */
156
157 /* bio only flags */
158 __REQ_UNPLUG, /* unplug the immediately after submission */
159 __REQ_RAHEAD, /* read ahead, can fail anytime */
160
161 /* request only flags */
162 __REQ_SORTED, /* elevator knows about this request */
163 __REQ_SOFTBARRIER, /* may not be passed by ioscheduler */
164 __REQ_FUA, /* forced unit access */
165 __REQ_NOMERGE, /* don't touch this for merging */
166 __REQ_STARTED, /* drive already may have started this one */
167 __REQ_DONTPREP, /* don't call prep for this one */
168 __REQ_QUEUED, /* uses queueing */
169 __REQ_ELVPRIV, /* elevator private data attached */
170 __REQ_FAILED, /* set if the request failed */
171 __REQ_QUIET, /* don't worry about errors */
172 __REQ_PREEMPT, /* set for "ide_preempt" requests */
173 __REQ_ORDERED_COLOR, /* is before or after barrier */
174 __REQ_ALLOCED, /* request came from our alloc pool */
175 __REQ_COPY_USER, /* contains copies of user pages */
176 __REQ_INTEGRITY, /* integrity metadata has been remapped */
8749534f 177 __REQ_FLUSH, /* request for cache flush */
7b6d91da
CH		 178 __REQ_IO_STAT, /* account I/O stat */
179 __REQ_MIXED_MERGE, /* merge of different types, fail separately */
180 __REQ_NR_BITS, /* stops here */
a82afdfc 181};
213d9417 182
7b6d91da
CH		 183#define REQ_WRITE (1 << __REQ_WRITE)
184#define REQ_FAILFAST_DEV (1 << __REQ_FAILFAST_DEV)
185#define REQ_FAILFAST_TRANSPORT (1 << __REQ_FAILFAST_TRANSPORT)
186#define REQ_FAILFAST_DRIVER (1 << __REQ_FAILFAST_DRIVER)
187#define REQ_HARDBARRIER (1 << __REQ_HARDBARRIER)
188#define REQ_SYNC (1 << __REQ_SYNC)
189#define REQ_META (1 << __REQ_META)
190#define REQ_DISCARD (1 << __REQ_DISCARD)
191#define REQ_NOIDLE (1 << __REQ_NOIDLE)
192
193#define REQ_FAILFAST_MASK \
194 (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER)
195#define REQ_COMMON_MASK \
196 (REQ_WRITE | REQ_FAILFAST_MASK | REQ_HARDBARRIER | REQ_SYNC | \
197 REQ_META| REQ_DISCARD | REQ_NOIDLE)
198
199#define REQ_UNPLUG (1 << __REQ_UNPLUG)
200#define REQ_RAHEAD (1 << __REQ_RAHEAD)
201
202#define REQ_SORTED (1 << __REQ_SORTED)
203#define REQ_SOFTBARRIER (1 << __REQ_SOFTBARRIER)
204#define REQ_FUA (1 << __REQ_FUA)
205#define REQ_NOMERGE (1 << __REQ_NOMERGE)
206#define REQ_STARTED (1 << __REQ_STARTED)
207#define REQ_DONTPREP (1 << __REQ_DONTPREP)
208#define REQ_QUEUED (1 << __REQ_QUEUED)
209#define REQ_ELVPRIV (1 << __REQ_ELVPRIV)
210#define REQ_FAILED (1 << __REQ_FAILED)
211#define REQ_QUIET (1 << __REQ_QUIET)
212#define REQ_PREEMPT (1 << __REQ_PREEMPT)
213#define REQ_ORDERED_COLOR (1 << __REQ_ORDERED_COLOR)
214#define REQ_ALLOCED (1 << __REQ_ALLOCED)
215#define REQ_COPY_USER (1 << __REQ_COPY_USER)
216#define REQ_INTEGRITY (1 << __REQ_INTEGRITY)
8749534f 217#define REQ_FLUSH (1 << __REQ_FLUSH)
7b6d91da
CH		 218#define REQ_IO_STAT (1 << __REQ_IO_STAT)
219#define REQ_MIXED_MERGE (1 << __REQ_MIXED_MERGE)
1dfa17f4 220
22e2c507
JA		 221/*
222 * upper 16 bits of bi_rw define the io priority of this bio
223 */
224#define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
225#define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
226#define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
227
228#define bio_set_prio(bio, prio) do { \
229 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
230 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
231 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
232} while (0)
233
1da177e4
LT		 234/*
235 * various member access, note that bio_data should of course not be used
236 * on highmem page vectors
237 */
238#define bio_iovec_idx(bio, idx) (&((bio)->bi_io_vec[(idx)]))
239#define bio_iovec(bio) bio_iovec_idx((bio), (bio)->bi_idx)
240#define bio_page(bio) bio_iovec((bio))->bv_page
241#define bio_offset(bio) bio_iovec((bio))->bv_offset
242#define bio_segments(bio) ((bio)->bi_vcnt - (bio)->bi_idx)
243#define bio_sectors(bio) ((bio)->bi_size >> 9)
7b6d91da
CH		 244#define bio_empty_barrier(bio) \
245 ((bio->bi_rw & REQ_HARDBARRIER) && \
246 !bio_has_data(bio) && \
247 !(bio->bi_rw & REQ_DISCARD))
bf2de6f5 248
2e46e8b2 249static inline unsigned int bio_cur_bytes(struct bio *bio)
bf2de6f5
JA		 250{
251 if (bio->bi_vcnt)
2e46e8b2 252 return bio_iovec(bio)->bv_len;
fb2dce86 253 else /* dataless requests such as discard */
2e46e8b2 254 return bio->bi_size;
bf2de6f5
JA		 255}
256
257static inline void *bio_data(struct bio *bio)
258{
259 if (bio->bi_vcnt)
260 return page_address(bio_page(bio)) + bio_offset(bio);
261
262 return NULL;
263}
1da177e4 264
392ddc32
JA		 265static inline int bio_has_allocated_vec(struct bio *bio)
266{
267 return bio->bi_io_vec && bio->bi_io_vec != bio->bi_inline_vecs;
268}
269
1da177e4
LT		 270/*
271 * will die
272 */
273#define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
274#define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
275
276/*
277 * queues that have highmem support enabled may still need to revert to
278 * PIO transfers occasionally and thus map high pages temporarily. For
279 * permanent PIO fall back, user is probably better off disabling highmem
280 * I/O completely on that queue (see ide-dma for example)
281 */
282#define __bio_kmap_atomic(bio, idx, kmtype) \
283 (kmap_atomic(bio_iovec_idx((bio), (idx))->bv_page, kmtype) + \
284 bio_iovec_idx((bio), (idx))->bv_offset)
285
286#define __bio_kunmap_atomic(addr, kmtype) kunmap_atomic(addr, kmtype)
287
288/*
289 * merge helpers etc
290 */
291
292#define __BVEC_END(bio) bio_iovec_idx((bio), (bio)->bi_vcnt - 1)
293#define __BVEC_START(bio) bio_iovec_idx((bio), (bio)->bi_idx)
294
f92131c3
JF		 295/* Default implementation of BIOVEC_PHYS_MERGEABLE */
296#define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
297 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
298
1da177e4
LT		 299/*
300 * allow arch override, for eg virtualized architectures (put in asm/io.h)
301 */
302#ifndef BIOVEC_PHYS_MERGEABLE
303#define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
f92131c3 304 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
1da177e4
LT		 305#endif
306
1da177e4
LT		 307#define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
308 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
309#define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
ae03bf63 310 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
1da177e4
LT		 311#define BIO_SEG_BOUNDARY(q, b1, b2) \
312 BIOVEC_SEG_BOUNDARY((q), __BVEC_END((b1)), __BVEC_START((b2)))
313
6712ecf8 314#define bio_io_error(bio) bio_endio((bio), -EIO)
1da177e4
LT		 315
316/*
317 * drivers should not use the __ version unless they _really_ want to
318 * run through the entire bio and not just pending pieces
319 */
320#define __bio_for_each_segment(bvl, bio, i, start_idx) \
321 for (bvl = bio_iovec_idx((bio), (start_idx)), i = (start_idx); \
322 i < (bio)->bi_vcnt; \
323 bvl++, i++)
324
325#define bio_for_each_segment(bvl, bio, i) \
326 __bio_for_each_segment(bvl, bio, i, (bio)->bi_idx)
327
328/*
329 * get a reference to a bio, so it won't disappear. the intended use is
330 * something like:
331 *
332 * bio_get(bio);
333 * submit_bio(rw, bio);
334 * if (bio->bi_flags ...)
335 * do_something
336 * bio_put(bio);
337 *
338 * without the bio_get(), it could potentially complete I/O before submit_bio
339 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
340 * runs
341 */
342#define bio_get(bio) atomic_inc(&(bio)->bi_cnt)
343
7ba1ba12
MP		 344#if defined(CONFIG_BLK_DEV_INTEGRITY)
345/*
346 * bio integrity payload
347 */
348struct bio_integrity_payload {
349 struct bio *bip_bio; /* parent bio */
7ba1ba12
MP		 350
351 sector_t bip_sector; /* virtual start sector */
352
353 void *bip_buf; /* generated integrity data */
354 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
355
7ba1ba12
MP		 356 unsigned int bip_size;
357
7878cba9 358 unsigned short bip_slab; /* slab the bip came from */
7ba1ba12
MP		 359 unsigned short bip_vcnt; /* # of integrity bio_vecs */
360 unsigned short bip_idx; /* current bip_vec index */
361
362 struct work_struct bip_work; /* I/O completion */
7878cba9 363 struct bio_vec bip_vec[0]; /* embedded bvec array */
7ba1ba12
MP		 364};
365#endif /* CONFIG_BLK_DEV_INTEGRITY */
1da177e4
LT		 366
367/*
368 * A bio_pair is used when we need to split a bio.
369 * This can only happen for a bio that refers to just one
370 * page of data, and in the unusual situation when the
371 * page crosses a chunk/device boundary
372 *
373 * The address of the master bio is stored in bio1.bi_private
374 * The address of the pool the pair was allocated from is stored
375 * in bio2.bi_private
376 */
377struct bio_pair {
7ba1ba12
MP		 378 struct bio bio1, bio2;
379 struct bio_vec bv1, bv2;
380#if defined(CONFIG_BLK_DEV_INTEGRITY)
381 struct bio_integrity_payload bip1, bip2;
382 struct bio_vec iv1, iv2;
383#endif
384 atomic_t cnt;
385 int error;
1da177e4 386};
6feef531 387extern struct bio_pair *bio_split(struct bio *bi, int first_sectors);
1da177e4
LT		 388extern void bio_pair_release(struct bio_pair *dbio);
389
bb799ca0 390extern struct bio_set *bioset_create(unsigned int, unsigned int);
1da177e4
LT		 391extern void bioset_free(struct bio_set *);
392
dd0fc66f 393extern struct bio *bio_alloc(gfp_t, int);
0a0d96b0 394extern struct bio *bio_kmalloc(gfp_t, int);
dd0fc66f 395extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
1da177e4 396extern void bio_put(struct bio *);
3676347a 397extern void bio_free(struct bio *, struct bio_set *);
1da177e4 398
6712ecf8 399extern void bio_endio(struct bio *, int);
1da177e4
LT		 400struct request_queue;
401extern int bio_phys_segments(struct request_queue *, struct bio *);
1da177e4
LT		 402
403extern void __bio_clone(struct bio *, struct bio *);
dd0fc66f 404extern struct bio *bio_clone(struct bio *, gfp_t);
1da177e4
LT		 405
406extern void bio_init(struct bio *);
407
408extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
6e68af66
MC		 409extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
410 unsigned int, unsigned int);
1da177e4 411extern int bio_get_nr_vecs(struct block_device *);
ad3316bf 412extern sector_t bio_sector_offset(struct bio *, unsigned short, unsigned int);
1da177e4 413extern struct bio *bio_map_user(struct request_queue *, struct block_device *,
a3bce90e 414 unsigned long, unsigned int, int, gfp_t);
f1970baf 415struct sg_iovec;
152e283f 416struct rq_map_data;
f1970baf
JB		 417extern struct bio *bio_map_user_iov(struct request_queue *,
418 struct block_device *,
a3bce90e 419 struct sg_iovec *, int, int, gfp_t);
1da177e4 420extern void bio_unmap_user(struct bio *);
df46b9a4 421extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
27496a8c 422 gfp_t);
68154e90
FT		 423extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
424 gfp_t, int);
1da177e4
LT		 425extern void bio_set_pages_dirty(struct bio *bio);
426extern void bio_check_pages_dirty(struct bio *bio);
2d4dc890
IL		 427
428#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
429# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
430#endif
431#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
432extern void bio_flush_dcache_pages(struct bio *bi);
433#else
434static inline void bio_flush_dcache_pages(struct bio *bi)
435{
436}
437#endif
438
152e283f
FT		 439extern struct bio *bio_copy_user(struct request_queue *, struct rq_map_data *,
440 unsigned long, unsigned int, int, gfp_t);
441extern struct bio *bio_copy_user_iov(struct request_queue *,
442 struct rq_map_data *, struct sg_iovec *,
a3bce90e 443 int, int, gfp_t);
1da177e4
LT		 444extern int bio_uncopy_user(struct bio *);
445void zero_fill_bio(struct bio *bio);
51d654e1 446extern struct bio_vec *bvec_alloc_bs(gfp_t, int, unsigned long *, struct bio_set *);
bb799ca0 447extern void bvec_free_bs(struct bio_set *, struct bio_vec *, unsigned int);
7ba1ba12 448extern unsigned int bvec_nr_vecs(unsigned short idx);
51d654e1 449
c7c22e4d
JA		 450/*
451 * Allow queuer to specify a completion CPU for this bio
452 */
453static inline void bio_set_completion_cpu(struct bio *bio, unsigned int cpu)
454{
455 bio->bi_comp_cpu = cpu;
456}
457
51d654e1
MP		 458/*
459 * bio_set is used to allow other portions of the IO system to
460 * allocate their own private memory pools for bio and iovec structures.
461 * These memory pools in turn all allocate from the bio_slab
462 * and the bvec_slabs[].
463 */
464#define BIO_POOL_SIZE 2
465#define BIOVEC_NR_POOLS 6
7ff9345f 466#define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
51d654e1
MP		 467
468struct bio_set {
1b434498 469 struct kmem_cache *bio_slab;
bb799ca0
JA		 470 unsigned int front_pad;
471
51d654e1 472 mempool_t *bio_pool;
7878cba9
MP		 473#if defined(CONFIG_BLK_DEV_INTEGRITY)
474 mempool_t *bio_integrity_pool;
475#endif
7ff9345f 476 mempool_t *bvec_pool;
51d654e1
MP		 477};
478
479struct biovec_slab {
480 int nr_vecs;
481 char *name;
482 struct kmem_cache *slab;
483};
484
485extern struct bio_set *fs_bio_set;
bb799ca0 486extern struct biovec_slab bvec_slabs[BIOVEC_NR_POOLS] __read_mostly;
51d654e1
MP		 487
488/*
489 * a small number of entries is fine, not going to be performance critical.
490 * basically we just need to survive
491 */
492#define BIO_SPLIT_ENTRIES 2
1da177e4
LT		 493
494#ifdef CONFIG_HIGHMEM
495/*
20b636bf
AB		 496 * remember never ever reenable interrupts between a bvec_kmap_irq and
497 * bvec_kunmap_irq!
1da177e4 498 */
4f570f99 499static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
1da177e4
LT		 500{
501 unsigned long addr;
502
503 /*
504 * might not be a highmem page, but the preempt/irq count
505 * balancing is a lot nicer this way
506 */
507 local_irq_save(*flags);
508 addr = (unsigned long) kmap_atomic(bvec->bv_page, KM_BIO_SRC_IRQ);
509
510 BUG_ON(addr & ~PAGE_MASK);
511
512 return (char *) addr + bvec->bv_offset;
513}
514
4f570f99 515static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
1da177e4
LT		 516{
517 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
518
519 kunmap_atomic((void *) ptr, KM_BIO_SRC_IRQ);
520 local_irq_restore(*flags);
521}
522
523#else
524#define bvec_kmap_irq(bvec, flags) (page_address((bvec)->bv_page) + (bvec)->bv_offset)
525#define bvec_kunmap_irq(buf, flags) do { *(flags) = 0; } while (0)
526#endif
527
c2d08dad 528static inline char *__bio_kmap_irq(struct bio *bio, unsigned short idx,
1da177e4
LT		 529 unsigned long *flags)
530{
531 return bvec_kmap_irq(bio_iovec_idx(bio, idx), flags);
532}
533#define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
534
535#define bio_kmap_irq(bio, flags) \
536 __bio_kmap_irq((bio), (bio)->bi_idx, (flags))
537#define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
538
7a67f63b
JA		 539/*
540 * Check whether this bio carries any data or not. A NULL bio is allowed.
541 */
542static inline int bio_has_data(struct bio *bio)
543{
544 return bio && bio->bi_io_vec != NULL;
545}
546
8f3d8ba2 547/*
e686307f 548 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
8f3d8ba2
CH		 549 *
550 * A bio_list anchors a singly-linked list of bios chained through the bi_next
551 * member of the bio. The bio_list also caches the last list member to allow
552 * fast access to the tail.
553 */
554struct bio_list {
555 struct bio *head;
556 struct bio *tail;
557};
558
559static inline int bio_list_empty(const struct bio_list *bl)
560{
561 return bl->head == NULL;
562}
563
564static inline void bio_list_init(struct bio_list *bl)
565{
566 bl->head = bl->tail = NULL;
567}
568
569#define bio_list_for_each(bio, bl) \
570 for (bio = (bl)->head; bio; bio = bio->bi_next)
571
572static inline unsigned bio_list_size(const struct bio_list *bl)
573{
574 unsigned sz = 0;
575 struct bio *bio;
576
577 bio_list_for_each(bio, bl)
578 sz++;
579
580 return sz;
581}
582
583static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
584{
585 bio->bi_next = NULL;
586
587 if (bl->tail)
588 bl->tail->bi_next = bio;
589 else
590 bl->head = bio;
591
592 bl->tail = bio;
593}
594
595static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
596{
597 bio->bi_next = bl->head;
598
599 bl->head = bio;
600
601 if (!bl->tail)
602 bl->tail = bio;
603}
604
605static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
606{
607 if (!bl2->head)
608 return;
609
610 if (bl->tail)
611 bl->tail->bi_next = bl2->head;
612 else
613 bl->head = bl2->head;
614
615 bl->tail = bl2->tail;
616}
617
618static inline void bio_list_merge_head(struct bio_list *bl,
619 struct bio_list *bl2)
620{
621 if (!bl2->head)
622 return;
623
624 if (bl->head)
625 bl2->tail->bi_next = bl->head;
626 else
627 bl->tail = bl2->tail;
628
629 bl->head = bl2->head;
630}
631
13685a16
GU		 632static inline struct bio *bio_list_peek(struct bio_list *bl)
633{
634 return bl->head;
635}
636
8f3d8ba2
CH		 637static inline struct bio *bio_list_pop(struct bio_list *bl)
638{
639 struct bio *bio = bl->head;
640
641 if (bio) {
642 bl->head = bl->head->bi_next;
643 if (!bl->head)
644 bl->tail = NULL;
645
646 bio->bi_next = NULL;
647 }
648
649 return bio;
650}
651
652static inline struct bio *bio_list_get(struct bio_list *bl)
653{
654 struct bio *bio = bl->head;
655
656 bl->head = bl->tail = NULL;
657
658 return bio;
659}
660
7ba1ba12
MP		 661#if defined(CONFIG_BLK_DEV_INTEGRITY)
662
663#define bip_vec_idx(bip, idx) (&(bip->bip_vec[(idx)]))
664#define bip_vec(bip) bip_vec_idx(bip, 0)
665
666#define __bip_for_each_vec(bvl, bip, i, start_idx) \
667 for (bvl = bip_vec_idx((bip), (start_idx)), i = (start_idx); \
668 i < (bip)->bip_vcnt; \
669 bvl++, i++)
670
671#define bip_for_each_vec(bvl, bip, i) \
672 __bip_for_each_vec(bvl, bip, i, (bip)->bip_idx)
673
8deaf721 674#define bio_integrity(bio) (bio->bi_integrity != NULL)
7ba1ba12 675
7878cba9 676extern struct bio_integrity_payload *bio_integrity_alloc_bioset(struct bio *, gfp_t, unsigned int, struct bio_set *);
7ba1ba12 677extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
7878cba9 678extern void bio_integrity_free(struct bio *, struct bio_set *);
7ba1ba12
MP		 679extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
680extern int bio_integrity_enabled(struct bio *bio);
681extern int bio_integrity_set_tag(struct bio *, void *, unsigned int);
682extern int bio_integrity_get_tag(struct bio *, void *, unsigned int);
683extern int bio_integrity_prep(struct bio *);
684extern void bio_integrity_endio(struct bio *, int);
685extern void bio_integrity_advance(struct bio *, unsigned int);
686extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
687extern void bio_integrity_split(struct bio *, struct bio_pair *, int);
7878cba9
MP		 688extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t, struct bio_set *);
689extern int bioset_integrity_create(struct bio_set *, int);
690extern void bioset_integrity_free(struct bio_set *);
691extern void bio_integrity_init(void);
7ba1ba12
MP		 692
693#else /* CONFIG_BLK_DEV_INTEGRITY */
694
695#define bio_integrity(a) (0)
7878cba9 696#define bioset_integrity_create(a, b) (0)
7ba1ba12
MP		 697#define bio_integrity_prep(a) (0)
698#define bio_integrity_enabled(a) (0)
7878cba9
MP		 699#define bio_integrity_clone(a, b, c, d) (0)
700#define bioset_integrity_free(a) do { } while (0)
701#define bio_integrity_free(a, b) do { } while (0)
7ba1ba12
MP		 702#define bio_integrity_endio(a, b) do { } while (0)
703#define bio_integrity_advance(a, b) do { } while (0)
704#define bio_integrity_trim(a, b, c) do { } while (0)
705#define bio_integrity_split(a, b, c) do { } while (0)
706#define bio_integrity_set_tag(a, b, c) do { } while (0)
707#define bio_integrity_get_tag(a, b, c) do { } while (0)
7878cba9 708#define bio_integrity_init(a) do { } while (0)
7ba1ba12
MP		 709
710#endif /* CONFIG_BLK_DEV_INTEGRITY */
711
02a5e0ac 712#endif /* CONFIG_BLOCK */
1da177e4 713#endif /* __LINUX_BIO_H */
Linux 6.x block layer and io_uring tree(s)