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>
26 #include <linux/bug.h>
32 /* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
33 #include <linux/blk_types.h>
38 #define BIO_BUG_ON BUG_ON
43 #define BIO_MAX_PAGES 256
45 #define bio_prio(bio) (bio)->bi_ioprio
46 #define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
48 #define bio_iter_iovec(bio, iter) \
49 bvec_iter_bvec((bio)->bi_io_vec, (iter))
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))
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)
62 #define bio_multiple_segments(bio) \
63 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
64 #define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
65 #define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
68 * Check whether this bio carries any data or not. A NULL bio is allowed.
70 static inline bool bio_has_data(struct bio *bio)
73 bio->bi_iter.bi_size &&
74 bio_op(bio) != REQ_OP_DISCARD &&
75 bio_op(bio) != REQ_OP_SECURE_ERASE)
81 static inline bool bio_no_advance_iter(struct bio *bio)
83 return bio_op(bio) == REQ_OP_DISCARD ||
84 bio_op(bio) == REQ_OP_SECURE_ERASE ||
85 bio_op(bio) == REQ_OP_WRITE_SAME;
88 static inline bool bio_is_rw(struct bio *bio)
90 if (!bio_has_data(bio))
93 if (bio_no_advance_iter(bio))
99 static inline bool bio_mergeable(struct bio *bio)
101 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
107 static inline unsigned int bio_cur_bytes(struct bio *bio)
109 if (bio_has_data(bio))
110 return bio_iovec(bio).bv_len;
111 else /* dataless requests such as discard */
112 return bio->bi_iter.bi_size;
115 static inline void *bio_data(struct bio *bio)
117 if (bio_has_data(bio))
118 return page_address(bio_page(bio)) + bio_offset(bio);
126 #define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
127 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
130 * queues that have highmem support enabled may still need to revert to
131 * PIO transfers occasionally and thus map high pages temporarily. For
132 * permanent PIO fall back, user is probably better off disabling highmem
133 * I/O completely on that queue (see ide-dma for example)
135 #define __bio_kmap_atomic(bio, iter) \
136 (kmap_atomic(bio_iter_iovec((bio), (iter)).bv_page) + \
137 bio_iter_iovec((bio), (iter)).bv_offset)
139 #define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
145 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
146 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
147 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
150 * allow arch override, for eg virtualized architectures (put in asm/io.h)
152 #ifndef BIOVEC_PHYS_MERGEABLE
153 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
154 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
157 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
158 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
159 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
160 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
163 * drivers should _never_ use the all version - the bio may have been split
164 * before it got to the driver and the driver won't own all of it
166 #define bio_for_each_segment_all(bvl, bio, i) \
167 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
169 static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
172 iter->bi_sector += bytes >> 9;
174 if (bio_no_advance_iter(bio))
175 iter->bi_size -= bytes;
177 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
180 #define __bio_for_each_segment(bvl, bio, iter, start) \
181 for (iter = (start); \
183 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
184 bio_advance_iter((bio), &(iter), (bvl).bv_len))
186 #define bio_for_each_segment(bvl, bio, iter) \
187 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
189 #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
191 static inline unsigned bio_segments(struct bio *bio)
195 struct bvec_iter iter;
198 * We special case discard/write same, because they interpret bi_size
202 if (bio_op(bio) == REQ_OP_DISCARD)
205 if (bio_op(bio) == REQ_OP_SECURE_ERASE)
208 if (bio_op(bio) == REQ_OP_WRITE_SAME)
211 bio_for_each_segment(bv, bio, iter)
218 * get a reference to a bio, so it won't disappear. the intended use is
222 * submit_bio(rw, bio);
223 * if (bio->bi_flags ...)
227 * without the bio_get(), it could potentially complete I/O before submit_bio
228 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
231 static inline void bio_get(struct bio *bio)
233 bio->bi_flags |= (1 << BIO_REFFED);
234 smp_mb__before_atomic();
235 atomic_inc(&bio->__bi_cnt);
238 static inline void bio_cnt_set(struct bio *bio, unsigned int count)
241 bio->bi_flags |= (1 << BIO_REFFED);
242 smp_mb__before_atomic();
244 atomic_set(&bio->__bi_cnt, count);
247 static inline bool bio_flagged(struct bio *bio, unsigned int bit)
249 return (bio->bi_flags & (1U << bit)) != 0;
252 static inline void bio_set_flag(struct bio *bio, unsigned int bit)
254 bio->bi_flags |= (1U << bit);
257 static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
259 bio->bi_flags &= ~(1U << bit);
262 static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
264 *bv = bio_iovec(bio);
267 static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
269 struct bvec_iter iter = bio->bi_iter;
272 if (unlikely(!bio_multiple_segments(bio))) {
273 *bv = bio_iovec(bio);
277 bio_advance_iter(bio, &iter, iter.bi_size);
279 if (!iter.bi_bvec_done)
280 idx = iter.bi_idx - 1;
281 else /* in the middle of bvec */
284 *bv = bio->bi_io_vec[idx];
287 * iter.bi_bvec_done records actual length of the last bvec
288 * if this bio ends in the middle of one io vector
290 if (iter.bi_bvec_done)
291 bv->bv_len = iter.bi_bvec_done;
295 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
296 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
297 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
298 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
299 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
303 * bio integrity payload
305 struct bio_integrity_payload {
306 struct bio *bip_bio; /* parent bio */
308 struct bvec_iter bip_iter;
310 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
312 unsigned short bip_slab; /* slab the bip came from */
313 unsigned short bip_vcnt; /* # of integrity bio_vecs */
314 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
315 unsigned short bip_flags; /* control flags */
317 struct work_struct bip_work; /* I/O completion */
319 struct bio_vec *bip_vec;
320 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
323 #if defined(CONFIG_BLK_DEV_INTEGRITY)
325 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
327 if (bio->bi_opf & REQ_INTEGRITY)
328 return bio->bi_integrity;
333 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
335 struct bio_integrity_payload *bip = bio_integrity(bio);
338 return bip->bip_flags & flag;
343 static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
345 return bip->bip_iter.bi_sector;
348 static inline void bip_set_seed(struct bio_integrity_payload *bip,
351 bip->bip_iter.bi_sector = seed;
354 #endif /* CONFIG_BLK_DEV_INTEGRITY */
356 extern void bio_trim(struct bio *bio, int offset, int size);
357 extern struct bio *bio_split(struct bio *bio, int sectors,
358 gfp_t gfp, struct bio_set *bs);
361 * bio_next_split - get next @sectors from a bio, splitting if necessary
363 * @sectors: number of sectors to split from the front of @bio
365 * @bs: bio set to allocate from
367 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
368 * than @sectors, returns the original bio unchanged.
370 static inline struct bio *bio_next_split(struct bio *bio, int sectors,
371 gfp_t gfp, struct bio_set *bs)
373 if (sectors >= bio_sectors(bio))
376 return bio_split(bio, sectors, gfp, bs);
379 extern struct bio_set *bioset_create(unsigned int, unsigned int);
380 extern struct bio_set *bioset_create_nobvec(unsigned int, unsigned int);
381 extern void bioset_free(struct bio_set *);
382 extern mempool_t *biovec_create_pool(int pool_entries);
384 extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
385 extern void bio_put(struct bio *);
387 extern void __bio_clone_fast(struct bio *, struct bio *);
388 extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
389 extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
391 extern struct bio_set *fs_bio_set;
393 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
395 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
398 static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
400 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
403 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
405 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
408 static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
410 return bio_clone_bioset(bio, gfp_mask, NULL);
414 extern void bio_endio(struct bio *);
416 static inline void bio_io_error(struct bio *bio)
418 bio->bi_error = -EIO;
422 struct request_queue;
423 extern int bio_phys_segments(struct request_queue *, struct bio *);
425 extern int submit_bio_wait(struct bio *bio);
426 extern void bio_advance(struct bio *, unsigned);
428 extern void bio_init(struct bio *);
429 extern void bio_reset(struct bio *);
430 void bio_chain(struct bio *, struct bio *);
432 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
433 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
434 unsigned int, unsigned int);
436 extern struct bio *bio_map_user_iov(struct request_queue *,
437 const struct iov_iter *, gfp_t);
438 extern void bio_unmap_user(struct bio *);
439 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
441 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
443 extern void bio_set_pages_dirty(struct bio *bio);
444 extern void bio_check_pages_dirty(struct bio *bio);
446 void generic_start_io_acct(int rw, unsigned long sectors,
447 struct hd_struct *part);
448 void generic_end_io_acct(int rw, struct hd_struct *part,
449 unsigned long start_time);
451 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
452 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
454 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
455 extern void bio_flush_dcache_pages(struct bio *bi);
457 static inline void bio_flush_dcache_pages(struct bio *bi)
462 extern void bio_copy_data(struct bio *dst, struct bio *src);
463 extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
465 extern struct bio *bio_copy_user_iov(struct request_queue *,
466 struct rq_map_data *,
467 const struct iov_iter *,
469 extern int bio_uncopy_user(struct bio *);
470 void zero_fill_bio(struct bio *bio);
471 extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
472 extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
473 extern unsigned int bvec_nr_vecs(unsigned short idx);
475 #ifdef CONFIG_BLK_CGROUP
476 int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
477 int bio_associate_current(struct bio *bio);
478 void bio_disassociate_task(struct bio *bio);
479 void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
480 #else /* CONFIG_BLK_CGROUP */
481 static inline int bio_associate_blkcg(struct bio *bio,
482 struct cgroup_subsys_state *blkcg_css) { return 0; }
483 static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
484 static inline void bio_disassociate_task(struct bio *bio) { }
485 static inline void bio_clone_blkcg_association(struct bio *dst,
487 #endif /* CONFIG_BLK_CGROUP */
489 #ifdef CONFIG_HIGHMEM
491 * remember never ever reenable interrupts between a bvec_kmap_irq and
494 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
499 * might not be a highmem page, but the preempt/irq count
500 * balancing is a lot nicer this way
502 local_irq_save(*flags);
503 addr = (unsigned long) kmap_atomic(bvec->bv_page);
505 BUG_ON(addr & ~PAGE_MASK);
507 return (char *) addr + bvec->bv_offset;
510 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
512 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
514 kunmap_atomic((void *) ptr);
515 local_irq_restore(*flags);
519 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
521 return page_address(bvec->bv_page) + bvec->bv_offset;
524 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
530 static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
531 unsigned long *flags)
533 return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
535 #define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
537 #define bio_kmap_irq(bio, flags) \
538 __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
539 #define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
542 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
544 * A bio_list anchors a singly-linked list of bios chained through the bi_next
545 * member of the bio. The bio_list also caches the last list member to allow
546 * fast access to the tail.
553 static inline int bio_list_empty(const struct bio_list *bl)
555 return bl->head == NULL;
558 static inline void bio_list_init(struct bio_list *bl)
560 bl->head = bl->tail = NULL;
563 #define BIO_EMPTY_LIST { NULL, NULL }
565 #define bio_list_for_each(bio, bl) \
566 for (bio = (bl)->head; bio; bio = bio->bi_next)
568 static inline unsigned bio_list_size(const struct bio_list *bl)
573 bio_list_for_each(bio, bl)
579 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
584 bl->tail->bi_next = bio;
591 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
593 bio->bi_next = bl->head;
601 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
607 bl->tail->bi_next = bl2->head;
609 bl->head = bl2->head;
611 bl->tail = bl2->tail;
614 static inline void bio_list_merge_head(struct bio_list *bl,
615 struct bio_list *bl2)
621 bl2->tail->bi_next = bl->head;
623 bl->tail = bl2->tail;
625 bl->head = bl2->head;
628 static inline struct bio *bio_list_peek(struct bio_list *bl)
633 static inline struct bio *bio_list_pop(struct bio_list *bl)
635 struct bio *bio = bl->head;
638 bl->head = bl->head->bi_next;
648 static inline struct bio *bio_list_get(struct bio_list *bl)
650 struct bio *bio = bl->head;
652 bl->head = bl->tail = NULL;
658 * Increment chain count for the bio. Make sure the CHAIN flag update
659 * is visible before the raised count.
661 static inline void bio_inc_remaining(struct bio *bio)
663 bio_set_flag(bio, BIO_CHAIN);
664 smp_mb__before_atomic();
665 atomic_inc(&bio->__bi_remaining);
669 * bio_set is used to allow other portions of the IO system to
670 * allocate their own private memory pools for bio and iovec structures.
671 * These memory pools in turn all allocate from the bio_slab
672 * and the bvec_slabs[].
674 #define BIO_POOL_SIZE 2
677 struct kmem_cache *bio_slab;
678 unsigned int front_pad;
681 mempool_t *bvec_pool;
682 #if defined(CONFIG_BLK_DEV_INTEGRITY)
683 mempool_t *bio_integrity_pool;
684 mempool_t *bvec_integrity_pool;
688 * Deadlock avoidance for stacking block drivers: see comments in
689 * bio_alloc_bioset() for details
691 spinlock_t rescue_lock;
692 struct bio_list rescue_list;
693 struct work_struct rescue_work;
694 struct workqueue_struct *rescue_workqueue;
700 struct kmem_cache *slab;
704 * a small number of entries is fine, not going to be performance critical.
705 * basically we just need to survive
707 #define BIO_SPLIT_ENTRIES 2
709 #if defined(CONFIG_BLK_DEV_INTEGRITY)
711 #define bip_for_each_vec(bvl, bip, iter) \
712 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
714 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
716 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
718 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
719 extern void bio_integrity_free(struct bio *);
720 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
721 extern bool bio_integrity_enabled(struct bio *bio);
722 extern int bio_integrity_prep(struct bio *);
723 extern void bio_integrity_endio(struct bio *);
724 extern void bio_integrity_advance(struct bio *, unsigned int);
725 extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
726 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
727 extern int bioset_integrity_create(struct bio_set *, int);
728 extern void bioset_integrity_free(struct bio_set *);
729 extern void bio_integrity_init(void);
731 #else /* CONFIG_BLK_DEV_INTEGRITY */
733 static inline void *bio_integrity(struct bio *bio)
738 static inline bool bio_integrity_enabled(struct bio *bio)
743 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
748 static inline void bioset_integrity_free (struct bio_set *bs)
753 static inline int bio_integrity_prep(struct bio *bio)
758 static inline void bio_integrity_free(struct bio *bio)
763 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
769 static inline void bio_integrity_advance(struct bio *bio,
770 unsigned int bytes_done)
775 static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
776 unsigned int sectors)
781 static inline void bio_integrity_init(void)
786 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
791 static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
794 return ERR_PTR(-EINVAL);
797 static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
798 unsigned int len, unsigned int offset)
803 #endif /* CONFIG_BLK_DEV_INTEGRITY */
805 #endif /* CONFIG_BLOCK */
806 #endif /* __LINUX_BIO_H */