4 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
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.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
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-
23 #include <linux/highmem.h>
24 #include <linux/mempool.h>
25 #include <linux/ioprio.h>
34 #define BIO_BUG_ON BUG_ON
39 #define BIO_MAX_PAGES 256
40 #define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_CACHE_SHIFT)
41 #define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
44 * was unsigned short, but we might as well be ready for > 64kB I/O pages
49 unsigned int bv_offset
;
54 struct bio_integrity_payload
;
55 typedef void (bio_end_io_t
) (struct bio
*, int);
56 typedef void (bio_destructor_t
) (struct bio
*);
59 * main unit of I/O for the block layer and lower layers (ie drivers and
63 sector_t bi_sector
; /* device address in 512 byte
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,
72 unsigned short bi_vcnt
; /* how many bio_vec's */
73 unsigned short bi_idx
; /* current index into bvl_vec */
75 /* Number of segments in this BIO after
76 * physical address coalescing is performed.
78 unsigned int bi_phys_segments
;
80 unsigned int bi_size
; /* residual I/O count */
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.
86 unsigned int bi_seg_front_size
;
87 unsigned int bi_seg_back_size
;
89 unsigned int bi_max_vecs
; /* max bvl_vecs we can hold */
91 unsigned int bi_comp_cpu
; /* completion CPU */
93 atomic_t bi_cnt
; /* pin count */
95 struct bio_vec
*bi_io_vec
; /* the actual vec list */
97 bio_end_io_t
*bi_end_io
;
100 #if defined(CONFIG_BLK_DEV_INTEGRITY)
101 struct bio_integrity_payload
*bi_integrity
; /* data integrity */
104 bio_destructor_t
*bi_destructor
; /* destructor */
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.
111 struct bio_vec bi_inline_vecs
[0];
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 */
120 #define BIO_SEG_VALID 3 /* bi_phys_segments valid */
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 */
125 #define BIO_CPU_AFFINE 8 /* complete bio on same CPU as submitted */
126 #define BIO_NULL_MAPPED 9 /* contains invalid user pages */
127 #define BIO_FS_INTEGRITY 10 /* fs owns integrity data, not block layer */
128 #define BIO_QUIET 11 /* Make BIO Quiet */
129 #define bio_flagged(bio, flag) ((bio)->bi_flags & (1 << (flag)))
132 * top 4 bits of bio flags indicate the pool this bio came from
134 #define BIO_POOL_BITS (4)
135 #define BIO_POOL_OFFSET (BITS_PER_LONG - BIO_POOL_BITS)
136 #define BIO_POOL_MASK (1UL << BIO_POOL_OFFSET)
137 #define BIO_POOL_IDX(bio) ((bio)->bi_flags >> BIO_POOL_OFFSET)
142 * bit 0 -- data direction
143 * If not set, bio is a read from device. If set, it's a write to device.
144 * bit 1 -- rw-ahead when set
146 * Insert a serialization point in the IO queue, forcing previously
147 * submitted IO to be completed before this one is issued.
148 * bit 3 -- synchronous I/O hint: the block layer will unplug immediately
149 * Note that this does NOT indicate that the IO itself is sync, just
150 * that the block layer will not postpone issue of this IO by plugging.
151 * bit 4 -- metadata request
152 * Used for tracing to differentiate metadata and data IO. May also
153 * get some preferential treatment in the IO scheduler
154 * bit 5 -- discard sectors
155 * Informs the lower level device that this range of sectors is no longer
156 * used by the file system and may thus be freed by the device. Used
157 * for flash based storage.
158 * bit 6 -- fail fast device errors
159 * bit 7 -- fail fast transport errors
160 * bit 8 -- fail fast driver errors
161 * Don't want driver retries for any fast fail whatever the reason.
163 #define BIO_RW 0 /* Must match RW in req flags (blkdev.h) */
164 #define BIO_RW_AHEAD 1 /* Must match FAILFAST in req flags */
165 #define BIO_RW_BARRIER 2
166 #define BIO_RW_SYNCIO 3
167 #define BIO_RW_UNPLUG 4
168 #define BIO_RW_META 5
169 #define BIO_RW_DISCARD 6
170 #define BIO_RW_FAILFAST_DEV 7
171 #define BIO_RW_FAILFAST_TRANSPORT 8
172 #define BIO_RW_FAILFAST_DRIVER 9
174 #define BIO_RW_SYNC (BIO_RW_SYNCIO | BIO_RW_UNPLUG)
176 #define bio_rw_flagged(bio, flag) ((bio)->bi_rw & (1 << (flag)))
179 * Old defines, these should eventually be replaced by direct usage of
182 #define bio_barrier(bio) bio_rw_flagged(bio, BIO_RW_BARRIER)
183 #define bio_sync(bio) bio_rw_flagged(bio, BIO_RW_SYNCIO)
184 #define bio_unplug(bio) bio_rw_flagged(bio, BIO_RW_UNPLUG)
185 #define bio_failfast_dev(bio) bio_rw_flagged(bio, BIO_RW_FAILFAST_DEV)
186 #define bio_failfast_transport(bio) \
187 bio_rw_flagged(bio, BIO_RW_FAILFAST_TRANSPORT)
188 #define bio_failfast_driver(bio) \
189 bio_rw_flagged(bio, BIO_RW_FAILFAST_DRIVER)
190 #define bio_rw_ahead(bio) bio_rw_flagged(bio, BIO_RW_AHEAD)
191 #define bio_rw_meta(bio) bio_rw_flagged(bio, BIO_RW_META)
192 #define bio_discard(bio) bio_rw_flagged(bio, BIO_RW_DISCARD)
195 * upper 16 bits of bi_rw define the io priority of this bio
197 #define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
198 #define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
199 #define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
201 #define bio_set_prio(bio, prio) do { \
202 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
203 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
204 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
208 * various member access, note that bio_data should of course not be used
209 * on highmem page vectors
211 #define bio_iovec_idx(bio, idx) (&((bio)->bi_io_vec[(idx)]))
212 #define bio_iovec(bio) bio_iovec_idx((bio), (bio)->bi_idx)
213 #define bio_page(bio) bio_iovec((bio))->bv_page
214 #define bio_offset(bio) bio_iovec((bio))->bv_offset
215 #define bio_segments(bio) ((bio)->bi_vcnt - (bio)->bi_idx)
216 #define bio_sectors(bio) ((bio)->bi_size >> 9)
217 #define bio_empty_barrier(bio) (bio_barrier(bio) && !bio_has_data(bio) && !bio_discard(bio))
219 static inline unsigned int bio_cur_sectors(struct bio
*bio
)
222 return bio_iovec(bio
)->bv_len
>> 9;
223 else /* dataless requests such as discard */
224 return bio
->bi_size
>> 9;
227 static inline void *bio_data(struct bio
*bio
)
230 return page_address(bio_page(bio
)) + bio_offset(bio
);
235 static inline int bio_has_allocated_vec(struct bio
*bio
)
237 return bio
->bi_io_vec
&& bio
->bi_io_vec
!= bio
->bi_inline_vecs
;
243 #define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
244 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
247 * queues that have highmem support enabled may still need to revert to
248 * PIO transfers occasionally and thus map high pages temporarily. For
249 * permanent PIO fall back, user is probably better off disabling highmem
250 * I/O completely on that queue (see ide-dma for example)
252 #define __bio_kmap_atomic(bio, idx, kmtype) \
253 (kmap_atomic(bio_iovec_idx((bio), (idx))->bv_page, kmtype) + \
254 bio_iovec_idx((bio), (idx))->bv_offset)
256 #define __bio_kunmap_atomic(addr, kmtype) kunmap_atomic(addr, kmtype)
262 #define __BVEC_END(bio) bio_iovec_idx((bio), (bio)->bi_vcnt - 1)
263 #define __BVEC_START(bio) bio_iovec_idx((bio), (bio)->bi_idx)
265 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
266 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
267 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
270 * allow arch override, for eg virtualized architectures (put in asm/io.h)
272 #ifndef BIOVEC_PHYS_MERGEABLE
273 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
274 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
277 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
278 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
279 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
280 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, (q)->seg_boundary_mask)
281 #define BIO_SEG_BOUNDARY(q, b1, b2) \
282 BIOVEC_SEG_BOUNDARY((q), __BVEC_END((b1)), __BVEC_START((b2)))
284 #define bio_io_error(bio) bio_endio((bio), -EIO)
287 * drivers should not use the __ version unless they _really_ want to
288 * run through the entire bio and not just pending pieces
290 #define __bio_for_each_segment(bvl, bio, i, start_idx) \
291 for (bvl = bio_iovec_idx((bio), (start_idx)), i = (start_idx); \
292 i < (bio)->bi_vcnt; \
295 #define bio_for_each_segment(bvl, bio, i) \
296 __bio_for_each_segment(bvl, bio, i, (bio)->bi_idx)
299 * get a reference to a bio, so it won't disappear. the intended use is
303 * submit_bio(rw, bio);
304 * if (bio->bi_flags ...)
308 * without the bio_get(), it could potentially complete I/O before submit_bio
309 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
312 #define bio_get(bio) atomic_inc(&(bio)->bi_cnt)
314 #if defined(CONFIG_BLK_DEV_INTEGRITY)
316 * bio integrity payload
318 struct bio_integrity_payload
{
319 struct bio
*bip_bio
; /* parent bio */
320 struct bio_vec
*bip_vec
; /* integrity data vector */
322 sector_t bip_sector
; /* virtual start sector */
324 void *bip_buf
; /* generated integrity data */
325 bio_end_io_t
*bip_end_io
; /* saved I/O completion fn */
327 unsigned int bip_size
;
329 unsigned short bip_pool
; /* pool the ivec came from */
330 unsigned short bip_vcnt
; /* # of integrity bio_vecs */
331 unsigned short bip_idx
; /* current bip_vec index */
333 struct work_struct bip_work
; /* I/O completion */
335 #endif /* CONFIG_BLK_DEV_INTEGRITY */
338 * A bio_pair is used when we need to split a bio.
339 * This can only happen for a bio that refers to just one
340 * page of data, and in the unusual situation when the
341 * page crosses a chunk/device boundary
343 * The address of the master bio is stored in bio1.bi_private
344 * The address of the pool the pair was allocated from is stored
348 struct bio bio1
, bio2
;
349 struct bio_vec bv1
, bv2
;
350 #if defined(CONFIG_BLK_DEV_INTEGRITY)
351 struct bio_integrity_payload bip1
, bip2
;
352 struct bio_vec iv1
, iv2
;
357 extern struct bio_pair
*bio_split(struct bio
*bi
, int first_sectors
);
358 extern void bio_pair_release(struct bio_pair
*dbio
);
360 extern struct bio_set
*bioset_create(unsigned int, unsigned int);
361 extern void bioset_free(struct bio_set
*);
363 extern struct bio
*bio_alloc(gfp_t
, int);
364 extern struct bio
*bio_kmalloc(gfp_t
, int);
365 extern struct bio
*bio_alloc_bioset(gfp_t
, int, struct bio_set
*);
366 extern void bio_put(struct bio
*);
367 extern void bio_free(struct bio
*, struct bio_set
*);
369 extern void bio_endio(struct bio
*, int);
370 struct request_queue
;
371 extern int bio_phys_segments(struct request_queue
*, struct bio
*);
373 extern void __bio_clone(struct bio
*, struct bio
*);
374 extern struct bio
*bio_clone(struct bio
*, gfp_t
);
376 extern void bio_init(struct bio
*);
378 extern int bio_add_page(struct bio
*, struct page
*, unsigned int,unsigned int);
379 extern int bio_add_pc_page(struct request_queue
*, struct bio
*, struct page
*,
380 unsigned int, unsigned int);
381 extern int bio_get_nr_vecs(struct block_device
*);
382 extern sector_t
bio_sector_offset(struct bio
*, unsigned short, unsigned int);
383 extern struct bio
*bio_map_user(struct request_queue
*, struct block_device
*,
384 unsigned long, unsigned int, int, gfp_t
);
387 extern struct bio
*bio_map_user_iov(struct request_queue
*,
388 struct block_device
*,
389 struct sg_iovec
*, int, int, gfp_t
);
390 extern void bio_unmap_user(struct bio
*);
391 extern struct bio
*bio_map_kern(struct request_queue
*, void *, unsigned int,
393 extern struct bio
*bio_copy_kern(struct request_queue
*, void *, unsigned int,
395 extern void bio_set_pages_dirty(struct bio
*bio
);
396 extern void bio_check_pages_dirty(struct bio
*bio
);
397 extern struct bio
*bio_copy_user(struct request_queue
*, struct rq_map_data
*,
398 unsigned long, unsigned int, int, gfp_t
);
399 extern struct bio
*bio_copy_user_iov(struct request_queue
*,
400 struct rq_map_data
*, struct sg_iovec
*,
402 extern int bio_uncopy_user(struct bio
*);
403 void zero_fill_bio(struct bio
*bio
);
404 extern struct bio_vec
*bvec_alloc_bs(gfp_t
, int, unsigned long *, struct bio_set
*);
405 extern void bvec_free_bs(struct bio_set
*, struct bio_vec
*, unsigned int);
406 extern unsigned int bvec_nr_vecs(unsigned short idx
);
409 * Allow queuer to specify a completion CPU for this bio
411 static inline void bio_set_completion_cpu(struct bio
*bio
, unsigned int cpu
)
413 bio
->bi_comp_cpu
= cpu
;
417 * bio_set is used to allow other portions of the IO system to
418 * allocate their own private memory pools for bio and iovec structures.
419 * These memory pools in turn all allocate from the bio_slab
420 * and the bvec_slabs[].
422 #define BIO_POOL_SIZE 2
423 #define BIOVEC_NR_POOLS 6
424 #define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
427 struct kmem_cache
*bio_slab
;
428 unsigned int front_pad
;
431 #if defined(CONFIG_BLK_DEV_INTEGRITY)
432 mempool_t
*bio_integrity_pool
;
434 mempool_t
*bvec_pool
;
440 struct kmem_cache
*slab
;
443 extern struct bio_set
*fs_bio_set
;
444 extern struct biovec_slab bvec_slabs
[BIOVEC_NR_POOLS
] __read_mostly
;
447 * a small number of entries is fine, not going to be performance critical.
448 * basically we just need to survive
450 #define BIO_SPLIT_ENTRIES 2
452 #ifdef CONFIG_HIGHMEM
454 * remember never ever reenable interrupts between a bvec_kmap_irq and
457 * This function MUST be inlined - it plays with the CPU interrupt flags.
459 static __always_inline
char *bvec_kmap_irq(struct bio_vec
*bvec
,
460 unsigned long *flags
)
465 * might not be a highmem page, but the preempt/irq count
466 * balancing is a lot nicer this way
468 local_irq_save(*flags
);
469 addr
= (unsigned long) kmap_atomic(bvec
->bv_page
, KM_BIO_SRC_IRQ
);
471 BUG_ON(addr
& ~PAGE_MASK
);
473 return (char *) addr
+ bvec
->bv_offset
;
476 static __always_inline
void bvec_kunmap_irq(char *buffer
,
477 unsigned long *flags
)
479 unsigned long ptr
= (unsigned long) buffer
& PAGE_MASK
;
481 kunmap_atomic((void *) ptr
, KM_BIO_SRC_IRQ
);
482 local_irq_restore(*flags
);
486 #define bvec_kmap_irq(bvec, flags) (page_address((bvec)->bv_page) + (bvec)->bv_offset)
487 #define bvec_kunmap_irq(buf, flags) do { *(flags) = 0; } while (0)
490 static inline char *__bio_kmap_irq(struct bio
*bio
, unsigned short idx
,
491 unsigned long *flags
)
493 return bvec_kmap_irq(bio_iovec_idx(bio
, idx
), flags
);
495 #define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
497 #define bio_kmap_irq(bio, flags) \
498 __bio_kmap_irq((bio), (bio)->bi_idx, (flags))
499 #define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
502 * Check whether this bio carries any data or not. A NULL bio is allowed.
504 static inline int bio_has_data(struct bio
*bio
)
506 return bio
&& bio
->bi_io_vec
!= NULL
;
509 #if defined(CONFIG_BLK_DEV_INTEGRITY)
511 #define bip_vec_idx(bip, idx) (&(bip->bip_vec[(idx)]))
512 #define bip_vec(bip) bip_vec_idx(bip, 0)
514 #define __bip_for_each_vec(bvl, bip, i, start_idx) \
515 for (bvl = bip_vec_idx((bip), (start_idx)), i = (start_idx); \
516 i < (bip)->bip_vcnt; \
519 #define bip_for_each_vec(bvl, bip, i) \
520 __bip_for_each_vec(bvl, bip, i, (bip)->bip_idx)
522 #define bio_integrity(bio) (bio->bi_integrity != NULL)
524 extern struct bio_integrity_payload
*bio_integrity_alloc_bioset(struct bio
*, gfp_t
, unsigned int, struct bio_set
*);
525 extern struct bio_integrity_payload
*bio_integrity_alloc(struct bio
*, gfp_t
, unsigned int);
526 extern void bio_integrity_free(struct bio
*, struct bio_set
*);
527 extern int bio_integrity_add_page(struct bio
*, struct page
*, unsigned int, unsigned int);
528 extern int bio_integrity_enabled(struct bio
*bio
);
529 extern int bio_integrity_set_tag(struct bio
*, void *, unsigned int);
530 extern int bio_integrity_get_tag(struct bio
*, void *, unsigned int);
531 extern int bio_integrity_prep(struct bio
*);
532 extern void bio_integrity_endio(struct bio
*, int);
533 extern void bio_integrity_advance(struct bio
*, unsigned int);
534 extern void bio_integrity_trim(struct bio
*, unsigned int, unsigned int);
535 extern void bio_integrity_split(struct bio
*, struct bio_pair
*, int);
536 extern int bio_integrity_clone(struct bio
*, struct bio
*, struct bio_set
*);
537 extern int bioset_integrity_create(struct bio_set
*, int);
538 extern void bioset_integrity_free(struct bio_set
*);
539 extern void bio_integrity_init_slab(void);
541 #else /* CONFIG_BLK_DEV_INTEGRITY */
543 #define bio_integrity(a) (0)
544 #define bioset_integrity_create(a, b) (0)
545 #define bio_integrity_prep(a) (0)
546 #define bio_integrity_enabled(a) (0)
547 #define bio_integrity_clone(a, b, c) (0)
548 #define bioset_integrity_free(a) do { } while (0)
549 #define bio_integrity_free(a, b) do { } while (0)
550 #define bio_integrity_endio(a, b) do { } while (0)
551 #define bio_integrity_advance(a, b) do { } while (0)
552 #define bio_integrity_trim(a, b, c) do { } while (0)
553 #define bio_integrity_split(a, b, c) do { } while (0)
554 #define bio_integrity_set_tag(a, b, c) do { } while (0)
555 #define bio_integrity_get_tag(a, b, c) do { } while (0)
556 #define bio_integrity_init_slab(a) do { } while (0)
558 #endif /* CONFIG_BLK_DEV_INTEGRITY */
560 #endif /* CONFIG_BLOCK */
561 #endif /* __LINUX_BIO_H */