]>
git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/linux/bio.h
2 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public Licens
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
21 #include <linux/highmem.h>
22 #include <linux/mempool.h>
23 #include <linux/ioprio.h>
24 #include <linux/bug.h>
30 /* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
31 #include <linux/blk_types.h>
36 #define BIO_BUG_ON BUG_ON
41 #define BIO_MAX_PAGES 256
43 #define bio_prio(bio) (bio)->bi_ioprio
44 #define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
46 #define bio_iter_iovec(bio, iter) \
47 bvec_iter_bvec((bio)->bi_io_vec, (iter))
49 #define bio_iter_page(bio, iter) \
50 bvec_iter_page((bio)->bi_io_vec, (iter))
51 #define bio_iter_len(bio, iter) \
52 bvec_iter_len((bio)->bi_io_vec, (iter))
53 #define bio_iter_offset(bio, iter) \
54 bvec_iter_offset((bio)->bi_io_vec, (iter))
56 #define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
57 #define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
58 #define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
60 #define bio_multiple_segments(bio) \
61 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
62 #define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
63 #define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
66 * Return the data direction, READ or WRITE.
68 #define bio_data_dir(bio) \
69 (op_is_write(bio_op(bio)) ? WRITE : READ)
72 * Check whether this bio carries any data or not. A NULL bio is allowed.
74 static inline bool bio_has_data(struct bio
*bio
)
77 bio
->bi_iter
.bi_size
&&
78 bio_op(bio
) != REQ_OP_DISCARD
&&
79 bio_op(bio
) != REQ_OP_SECURE_ERASE
)
85 static inline bool bio_no_advance_iter(struct bio
*bio
)
87 return bio_op(bio
) == REQ_OP_DISCARD
||
88 bio_op(bio
) == REQ_OP_SECURE_ERASE
||
89 bio_op(bio
) == REQ_OP_WRITE_SAME
;
92 static inline bool bio_mergeable(struct bio
*bio
)
94 if (bio
->bi_opf
& REQ_NOMERGE_FLAGS
)
100 static inline unsigned int bio_cur_bytes(struct bio
*bio
)
102 if (bio_has_data(bio
))
103 return bio_iovec(bio
).bv_len
;
104 else /* dataless requests such as discard */
105 return bio
->bi_iter
.bi_size
;
108 static inline void *bio_data(struct bio
*bio
)
110 if (bio_has_data(bio
))
111 return page_address(bio_page(bio
)) + bio_offset(bio
);
119 #define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
120 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
123 * queues that have highmem support enabled may still need to revert to
124 * PIO transfers occasionally and thus map high pages temporarily. For
125 * permanent PIO fall back, user is probably better off disabling highmem
126 * I/O completely on that queue (see ide-dma for example)
128 #define __bio_kmap_atomic(bio, iter) \
129 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
130 bio_iter_iovec((bio), (iter)).bv_offset)
132 #define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
138 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
139 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
140 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
143 * allow arch override, for eg virtualized architectures (put in asm/io.h)
145 #ifndef BIOVEC_PHYS_MERGEABLE
146 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
147 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
150 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
151 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
152 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
153 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
156 * drivers should _never_ use the all version - the bio may have been split
157 * before it got to the driver and the driver won't own all of it
159 #define bio_for_each_segment_all(bvl, bio, i) \
160 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
162 static inline void bio_advance_iter(struct bio
*bio
, struct bvec_iter
*iter
,
165 iter
->bi_sector
+= bytes
>> 9;
167 if (bio_no_advance_iter(bio
))
168 iter
->bi_size
-= bytes
;
170 bvec_iter_advance(bio
->bi_io_vec
, iter
, bytes
);
173 #define __bio_for_each_segment(bvl, bio, iter, start) \
174 for (iter = (start); \
176 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
177 bio_advance_iter((bio), &(iter), (bvl).bv_len))
179 #define bio_for_each_segment(bvl, bio, iter) \
180 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
182 #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
184 static inline unsigned bio_segments(struct bio
*bio
)
188 struct bvec_iter iter
;
191 * We special case discard/write same, because they interpret bi_size
195 if (bio_op(bio
) == REQ_OP_DISCARD
)
198 if (bio_op(bio
) == REQ_OP_SECURE_ERASE
)
201 if (bio_op(bio
) == REQ_OP_WRITE_SAME
)
204 bio_for_each_segment(bv
, bio
, iter
)
211 * get a reference to a bio, so it won't disappear. the intended use is
215 * submit_bio(rw, bio);
216 * if (bio->bi_flags ...)
220 * without the bio_get(), it could potentially complete I/O before submit_bio
221 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
224 static inline void bio_get(struct bio
*bio
)
226 bio
->bi_flags
|= (1 << BIO_REFFED
);
227 smp_mb__before_atomic();
228 atomic_inc(&bio
->__bi_cnt
);
231 static inline void bio_cnt_set(struct bio
*bio
, unsigned int count
)
234 bio
->bi_flags
|= (1 << BIO_REFFED
);
235 smp_mb__before_atomic();
237 atomic_set(&bio
->__bi_cnt
, count
);
240 static inline bool bio_flagged(struct bio
*bio
, unsigned int bit
)
242 return (bio
->bi_flags
& (1U << bit
)) != 0;
245 static inline void bio_set_flag(struct bio
*bio
, unsigned int bit
)
247 bio
->bi_flags
|= (1U << bit
);
250 static inline void bio_clear_flag(struct bio
*bio
, unsigned int bit
)
252 bio
->bi_flags
&= ~(1U << bit
);
255 static inline void bio_get_first_bvec(struct bio
*bio
, struct bio_vec
*bv
)
257 *bv
= bio_iovec(bio
);
260 static inline void bio_get_last_bvec(struct bio
*bio
, struct bio_vec
*bv
)
262 struct bvec_iter iter
= bio
->bi_iter
;
265 if (unlikely(!bio_multiple_segments(bio
))) {
266 *bv
= bio_iovec(bio
);
270 bio_advance_iter(bio
, &iter
, iter
.bi_size
);
272 if (!iter
.bi_bvec_done
)
273 idx
= iter
.bi_idx
- 1;
274 else /* in the middle of bvec */
277 *bv
= bio
->bi_io_vec
[idx
];
280 * iter.bi_bvec_done records actual length of the last bvec
281 * if this bio ends in the middle of one io vector
283 if (iter
.bi_bvec_done
)
284 bv
->bv_len
= iter
.bi_bvec_done
;
288 BIP_BLOCK_INTEGRITY
= 1 << 0, /* block layer owns integrity data */
289 BIP_MAPPED_INTEGRITY
= 1 << 1, /* ref tag has been remapped */
290 BIP_CTRL_NOCHECK
= 1 << 2, /* disable HBA integrity checking */
291 BIP_DISK_NOCHECK
= 1 << 3, /* disable disk integrity checking */
292 BIP_IP_CHECKSUM
= 1 << 4, /* IP checksum */
296 * bio integrity payload
298 struct bio_integrity_payload
{
299 struct bio
*bip_bio
; /* parent bio */
301 struct bvec_iter bip_iter
;
303 bio_end_io_t
*bip_end_io
; /* saved I/O completion fn */
305 unsigned short bip_slab
; /* slab the bip came from */
306 unsigned short bip_vcnt
; /* # of integrity bio_vecs */
307 unsigned short bip_max_vcnt
; /* integrity bio_vec slots */
308 unsigned short bip_flags
; /* control flags */
310 struct work_struct bip_work
; /* I/O completion */
312 struct bio_vec
*bip_vec
;
313 struct bio_vec bip_inline_vecs
[0];/* embedded bvec array */
316 #if defined(CONFIG_BLK_DEV_INTEGRITY)
318 static inline struct bio_integrity_payload
*bio_integrity(struct bio
*bio
)
320 if (bio
->bi_opf
& REQ_INTEGRITY
)
321 return bio
->bi_integrity
;
326 static inline bool bio_integrity_flagged(struct bio
*bio
, enum bip_flags flag
)
328 struct bio_integrity_payload
*bip
= bio_integrity(bio
);
331 return bip
->bip_flags
& flag
;
336 static inline sector_t
bip_get_seed(struct bio_integrity_payload
*bip
)
338 return bip
->bip_iter
.bi_sector
;
341 static inline void bip_set_seed(struct bio_integrity_payload
*bip
,
344 bip
->bip_iter
.bi_sector
= seed
;
347 #endif /* CONFIG_BLK_DEV_INTEGRITY */
349 extern void bio_trim(struct bio
*bio
, int offset
, int size
);
350 extern struct bio
*bio_split(struct bio
*bio
, int sectors
,
351 gfp_t gfp
, struct bio_set
*bs
);
354 * bio_next_split - get next @sectors from a bio, splitting if necessary
356 * @sectors: number of sectors to split from the front of @bio
358 * @bs: bio set to allocate from
360 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
361 * than @sectors, returns the original bio unchanged.
363 static inline struct bio
*bio_next_split(struct bio
*bio
, int sectors
,
364 gfp_t gfp
, struct bio_set
*bs
)
366 if (sectors
>= bio_sectors(bio
))
369 return bio_split(bio
, sectors
, gfp
, bs
);
372 extern struct bio_set
*bioset_create(unsigned int, unsigned int);
373 extern struct bio_set
*bioset_create_nobvec(unsigned int, unsigned int);
374 extern void bioset_free(struct bio_set
*);
375 extern mempool_t
*biovec_create_pool(int pool_entries
);
377 extern struct bio
*bio_alloc_bioset(gfp_t
, int, struct bio_set
*);
378 extern void bio_put(struct bio
*);
380 extern void __bio_clone_fast(struct bio
*, struct bio
*);
381 extern struct bio
*bio_clone_fast(struct bio
*, gfp_t
, struct bio_set
*);
382 extern struct bio
*bio_clone_bioset(struct bio
*, gfp_t
, struct bio_set
*bs
);
384 extern struct bio_set
*fs_bio_set
;
386 static inline struct bio
*bio_alloc(gfp_t gfp_mask
, unsigned int nr_iovecs
)
388 return bio_alloc_bioset(gfp_mask
, nr_iovecs
, fs_bio_set
);
391 static inline struct bio
*bio_clone(struct bio
*bio
, gfp_t gfp_mask
)
393 return bio_clone_bioset(bio
, gfp_mask
, fs_bio_set
);
396 static inline struct bio
*bio_kmalloc(gfp_t gfp_mask
, unsigned int nr_iovecs
)
398 return bio_alloc_bioset(gfp_mask
, nr_iovecs
, NULL
);
401 static inline struct bio
*bio_clone_kmalloc(struct bio
*bio
, gfp_t gfp_mask
)
403 return bio_clone_bioset(bio
, gfp_mask
, NULL
);
407 extern blk_qc_t
submit_bio(struct bio
*);
409 extern void bio_endio(struct bio
*);
411 static inline void bio_io_error(struct bio
*bio
)
413 bio
->bi_error
= -EIO
;
417 struct request_queue
;
418 extern int bio_phys_segments(struct request_queue
*, struct bio
*);
420 extern int submit_bio_wait(struct bio
*bio
);
421 extern void bio_advance(struct bio
*, unsigned);
423 extern void bio_init(struct bio
*bio
, struct bio_vec
*table
,
424 unsigned short max_vecs
);
425 extern void bio_reset(struct bio
*);
426 void bio_chain(struct bio
*, struct bio
*);
428 extern int bio_add_page(struct bio
*, struct page
*, unsigned int,unsigned int);
429 extern int bio_add_pc_page(struct request_queue
*, struct bio
*, struct page
*,
430 unsigned int, unsigned int);
431 int bio_iov_iter_get_pages(struct bio
*bio
, struct iov_iter
*iter
);
433 extern struct bio
*bio_map_user_iov(struct request_queue
*,
434 const struct iov_iter
*, gfp_t
);
435 extern void bio_unmap_user(struct bio
*);
436 extern struct bio
*bio_map_kern(struct request_queue
*, void *, unsigned int,
438 extern struct bio
*bio_copy_kern(struct request_queue
*, void *, unsigned int,
440 extern void bio_set_pages_dirty(struct bio
*bio
);
441 extern void bio_check_pages_dirty(struct bio
*bio
);
443 void generic_start_io_acct(int rw
, unsigned long sectors
,
444 struct hd_struct
*part
);
445 void generic_end_io_acct(int rw
, struct hd_struct
*part
,
446 unsigned long start_time
);
448 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
449 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
451 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
452 extern void bio_flush_dcache_pages(struct bio
*bi
);
454 static inline void bio_flush_dcache_pages(struct bio
*bi
)
459 extern void bio_copy_data(struct bio
*dst
, struct bio
*src
);
460 extern int bio_alloc_pages(struct bio
*bio
, gfp_t gfp
);
461 extern void bio_free_pages(struct bio
*bio
);
463 extern struct bio
*bio_copy_user_iov(struct request_queue
*,
464 struct rq_map_data
*,
465 const struct iov_iter
*,
467 extern int bio_uncopy_user(struct bio
*);
468 void zero_fill_bio(struct bio
*bio
);
469 extern struct bio_vec
*bvec_alloc(gfp_t
, int, unsigned long *, mempool_t
*);
470 extern void bvec_free(mempool_t
*, struct bio_vec
*, unsigned int);
471 extern unsigned int bvec_nr_vecs(unsigned short idx
);
473 #ifdef CONFIG_BLK_CGROUP
474 int bio_associate_blkcg(struct bio
*bio
, struct cgroup_subsys_state
*blkcg_css
);
475 int bio_associate_current(struct bio
*bio
);
476 void bio_disassociate_task(struct bio
*bio
);
477 void bio_clone_blkcg_association(struct bio
*dst
, struct bio
*src
);
478 #else /* CONFIG_BLK_CGROUP */
479 static inline int bio_associate_blkcg(struct bio
*bio
,
480 struct cgroup_subsys_state
*blkcg_css
) { return 0; }
481 static inline int bio_associate_current(struct bio
*bio
) { return -ENOENT
; }
482 static inline void bio_disassociate_task(struct bio
*bio
) { }
483 static inline void bio_clone_blkcg_association(struct bio
*dst
,
485 #endif /* CONFIG_BLK_CGROUP */
487 #ifdef CONFIG_HIGHMEM
489 * remember never ever reenable interrupts between a bvec_kmap_irq and
492 static inline char *bvec_kmap_irq(struct bio_vec
*bvec
, unsigned long *flags
)
497 * might not be a highmem page, but the preempt/irq count
498 * balancing is a lot nicer this way
500 local_irq_save(*flags
);
501 addr
= (unsigned long) kmap_atomic(bvec
->bv_page
);
503 BUG_ON(addr
& ~PAGE_MASK
);
505 return (char *) addr
+ bvec
->bv_offset
;
508 static inline void bvec_kunmap_irq(char *buffer
, unsigned long *flags
)
510 unsigned long ptr
= (unsigned long) buffer
& PAGE_MASK
;
512 kunmap_atomic((void *) ptr
);
513 local_irq_restore(*flags
);
517 static inline char *bvec_kmap_irq(struct bio_vec
*bvec
, unsigned long *flags
)
519 return page_address(bvec
->bv_page
) + bvec
->bv_offset
;
522 static inline void bvec_kunmap_irq(char *buffer
, unsigned long *flags
)
528 static inline char *__bio_kmap_irq(struct bio
*bio
, struct bvec_iter iter
,
529 unsigned long *flags
)
531 return bvec_kmap_irq(&bio_iter_iovec(bio
, iter
), flags
);
533 #define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
535 #define bio_kmap_irq(bio, flags) \
536 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
537 #define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
540 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
542 * A bio_list anchors a singly-linked list of bios chained through the bi_next
543 * member of the bio. The bio_list also caches the last list member to allow
544 * fast access to the tail.
551 static inline int bio_list_empty(const struct bio_list
*bl
)
553 return bl
->head
== NULL
;
556 static inline void bio_list_init(struct bio_list
*bl
)
558 bl
->head
= bl
->tail
= NULL
;
561 #define BIO_EMPTY_LIST { NULL, NULL }
563 #define bio_list_for_each(bio, bl) \
564 for (bio = (bl)->head; bio; bio = bio->bi_next)
566 static inline unsigned bio_list_size(const struct bio_list
*bl
)
571 bio_list_for_each(bio
, bl
)
577 static inline void bio_list_add(struct bio_list
*bl
, struct bio
*bio
)
582 bl
->tail
->bi_next
= bio
;
589 static inline void bio_list_add_head(struct bio_list
*bl
, struct bio
*bio
)
591 bio
->bi_next
= bl
->head
;
599 static inline void bio_list_merge(struct bio_list
*bl
, struct bio_list
*bl2
)
605 bl
->tail
->bi_next
= bl2
->head
;
607 bl
->head
= bl2
->head
;
609 bl
->tail
= bl2
->tail
;
612 static inline void bio_list_merge_head(struct bio_list
*bl
,
613 struct bio_list
*bl2
)
619 bl2
->tail
->bi_next
= bl
->head
;
621 bl
->tail
= bl2
->tail
;
623 bl
->head
= bl2
->head
;
626 static inline struct bio
*bio_list_peek(struct bio_list
*bl
)
631 static inline struct bio
*bio_list_pop(struct bio_list
*bl
)
633 struct bio
*bio
= bl
->head
;
636 bl
->head
= bl
->head
->bi_next
;
646 static inline struct bio
*bio_list_get(struct bio_list
*bl
)
648 struct bio
*bio
= bl
->head
;
650 bl
->head
= bl
->tail
= NULL
;
656 * Increment chain count for the bio. Make sure the CHAIN flag update
657 * is visible before the raised count.
659 static inline void bio_inc_remaining(struct bio
*bio
)
661 bio_set_flag(bio
, BIO_CHAIN
);
662 smp_mb__before_atomic();
663 atomic_inc(&bio
->__bi_remaining
);
667 * bio_set is used to allow other portions of the IO system to
668 * allocate their own private memory pools for bio and iovec structures.
669 * These memory pools in turn all allocate from the bio_slab
670 * and the bvec_slabs[].
672 #define BIO_POOL_SIZE 2
675 struct kmem_cache
*bio_slab
;
676 unsigned int front_pad
;
679 mempool_t
*bvec_pool
;
680 #if defined(CONFIG_BLK_DEV_INTEGRITY)
681 mempool_t
*bio_integrity_pool
;
682 mempool_t
*bvec_integrity_pool
;
686 * Deadlock avoidance for stacking block drivers: see comments in
687 * bio_alloc_bioset() for details
689 spinlock_t rescue_lock
;
690 struct bio_list rescue_list
;
691 struct work_struct rescue_work
;
692 struct workqueue_struct
*rescue_workqueue
;
698 struct kmem_cache
*slab
;
702 * a small number of entries is fine, not going to be performance critical.
703 * basically we just need to survive
705 #define BIO_SPLIT_ENTRIES 2
707 #if defined(CONFIG_BLK_DEV_INTEGRITY)
709 #define bip_for_each_vec(bvl, bip, iter) \
710 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
712 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
714 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
716 extern struct bio_integrity_payload
*bio_integrity_alloc(struct bio
*, gfp_t
, unsigned int);
717 extern void bio_integrity_free(struct bio
*);
718 extern int bio_integrity_add_page(struct bio
*, struct page
*, unsigned int, unsigned int);
719 extern bool bio_integrity_enabled(struct bio
*bio
);
720 extern int bio_integrity_prep(struct bio
*);
721 extern void bio_integrity_endio(struct bio
*);
722 extern void bio_integrity_advance(struct bio
*, unsigned int);
723 extern void bio_integrity_trim(struct bio
*, unsigned int, unsigned int);
724 extern int bio_integrity_clone(struct bio
*, struct bio
*, gfp_t
);
725 extern int bioset_integrity_create(struct bio_set
*, int);
726 extern void bioset_integrity_free(struct bio_set
*);
727 extern void bio_integrity_init(void);
729 #else /* CONFIG_BLK_DEV_INTEGRITY */
731 static inline void *bio_integrity(struct bio
*bio
)
736 static inline bool bio_integrity_enabled(struct bio
*bio
)
741 static inline int bioset_integrity_create(struct bio_set
*bs
, int pool_size
)
746 static inline void bioset_integrity_free (struct bio_set
*bs
)
751 static inline int bio_integrity_prep(struct bio
*bio
)
756 static inline void bio_integrity_free(struct bio
*bio
)
761 static inline int bio_integrity_clone(struct bio
*bio
, struct bio
*bio_src
,
767 static inline void bio_integrity_advance(struct bio
*bio
,
768 unsigned int bytes_done
)
773 static inline void bio_integrity_trim(struct bio
*bio
, unsigned int offset
,
774 unsigned int sectors
)
779 static inline void bio_integrity_init(void)
784 static inline bool bio_integrity_flagged(struct bio
*bio
, enum bip_flags flag
)
789 static inline void *bio_integrity_alloc(struct bio
* bio
, gfp_t gfp
,
792 return ERR_PTR(-EINVAL
);
795 static inline int bio_integrity_add_page(struct bio
*bio
, struct page
*page
,
796 unsigned int len
, unsigned int offset
)
801 #endif /* CONFIG_BLK_DEV_INTEGRITY */
803 #endif /* CONFIG_BLOCK */
804 #endif /* __LINUX_BIO_H */