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 #ifdef CONFIG_THP_SWAP
42 #if HPAGE_PMD_NR > 256
43 #define BIO_MAX_PAGES HPAGE_PMD_NR
45 #define BIO_MAX_PAGES 256
48 #define BIO_MAX_PAGES 256
51 #define bio_prio(bio) (bio)->bi_ioprio
52 #define bio_set_prio(bio, prio) ((bio)->bi_ioprio = prio)
54 #define bio_iter_iovec(bio, iter) \
55 bvec_iter_bvec((bio)->bi_io_vec, (iter))
57 #define bio_iter_page(bio, iter) \
58 bvec_iter_page((bio)->bi_io_vec, (iter))
59 #define bio_iter_len(bio, iter) \
60 bvec_iter_len((bio)->bi_io_vec, (iter))
61 #define bio_iter_offset(bio, iter) \
62 bvec_iter_offset((bio)->bi_io_vec, (iter))
64 #define bio_page(bio) bio_iter_page((bio), (bio)->bi_iter)
65 #define bio_offset(bio) bio_iter_offset((bio), (bio)->bi_iter)
66 #define bio_iovec(bio) bio_iter_iovec((bio), (bio)->bi_iter)
68 #define bio_multiple_segments(bio) \
69 ((bio)->bi_iter.bi_size != bio_iovec(bio).bv_len)
70 #define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
71 #define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
74 * Return the data direction, READ or WRITE.
76 #define bio_data_dir(bio) \
77 (op_is_write(bio_op(bio)) ? WRITE : READ)
80 * Check whether this bio carries any data or not. A NULL bio is allowed.
82 static inline bool bio_has_data(struct bio *bio)
85 bio->bi_iter.bi_size &&
86 bio_op(bio) != REQ_OP_DISCARD &&
87 bio_op(bio) != REQ_OP_SECURE_ERASE &&
88 bio_op(bio) != REQ_OP_WRITE_ZEROES)
94 static inline bool bio_no_advance_iter(struct bio *bio)
96 return bio_op(bio) == REQ_OP_DISCARD ||
97 bio_op(bio) == REQ_OP_SECURE_ERASE ||
98 bio_op(bio) == REQ_OP_WRITE_SAME ||
99 bio_op(bio) == REQ_OP_WRITE_ZEROES;
102 static inline bool bio_mergeable(struct bio *bio)
104 if (bio->bi_opf & REQ_NOMERGE_FLAGS)
110 static inline unsigned int bio_cur_bytes(struct bio *bio)
112 if (bio_has_data(bio))
113 return bio_iovec(bio).bv_len;
114 else /* dataless requests such as discard */
115 return bio->bi_iter.bi_size;
118 static inline void *bio_data(struct bio *bio)
120 if (bio_has_data(bio))
121 return page_address(bio_page(bio)) + bio_offset(bio);
129 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
135 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
136 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
137 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
140 * allow arch override, for eg virtualized architectures (put in asm/io.h)
142 #ifndef BIOVEC_PHYS_MERGEABLE
143 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
144 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
147 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
148 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
149 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
150 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
153 * drivers should _never_ use the all version - the bio may have been split
154 * before it got to the driver and the driver won't own all of it
156 #define bio_for_each_segment_all(bvl, bio, i) \
157 for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
159 static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
162 iter->bi_sector += bytes >> 9;
164 if (bio_no_advance_iter(bio)) {
165 iter->bi_size -= bytes;
166 iter->bi_done += bytes;
168 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
169 /* TODO: It is reasonable to complete bio with error here. */
173 static inline bool bio_rewind_iter(struct bio *bio, struct bvec_iter *iter,
176 iter->bi_sector -= bytes >> 9;
178 if (bio_no_advance_iter(bio)) {
179 iter->bi_size += bytes;
180 iter->bi_done -= bytes;
184 return bvec_iter_rewind(bio->bi_io_vec, iter, bytes);
187 #define __bio_for_each_segment(bvl, bio, iter, start) \
188 for (iter = (start); \
190 ((bvl = bio_iter_iovec((bio), (iter))), 1); \
191 bio_advance_iter((bio), &(iter), (bvl).bv_len))
193 #define bio_for_each_segment(bvl, bio, iter) \
194 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
196 #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
198 static inline unsigned bio_segments(struct bio *bio)
202 struct bvec_iter iter;
205 * We special case discard/write same/write zeroes, because they
206 * interpret bi_size differently:
209 switch (bio_op(bio)) {
211 case REQ_OP_SECURE_ERASE:
212 case REQ_OP_WRITE_ZEROES:
214 case REQ_OP_WRITE_SAME:
220 bio_for_each_segment(bv, bio, iter)
227 * get a reference to a bio, so it won't disappear. the intended use is
231 * submit_bio(rw, bio);
232 * if (bio->bi_flags ...)
236 * without the bio_get(), it could potentially complete I/O before submit_bio
237 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
240 static inline void bio_get(struct bio *bio)
242 bio->bi_flags |= (1 << BIO_REFFED);
243 smp_mb__before_atomic();
244 atomic_inc(&bio->__bi_cnt);
247 static inline void bio_cnt_set(struct bio *bio, unsigned int count)
250 bio->bi_flags |= (1 << BIO_REFFED);
251 smp_mb__before_atomic();
253 atomic_set(&bio->__bi_cnt, count);
256 static inline bool bio_flagged(struct bio *bio, unsigned int bit)
258 return (bio->bi_flags & (1U << bit)) != 0;
261 static inline void bio_set_flag(struct bio *bio, unsigned int bit)
263 bio->bi_flags |= (1U << bit);
266 static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
268 bio->bi_flags &= ~(1U << bit);
271 static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
273 *bv = bio_iovec(bio);
276 static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
278 struct bvec_iter iter = bio->bi_iter;
281 if (unlikely(!bio_multiple_segments(bio))) {
282 *bv = bio_iovec(bio);
286 bio_advance_iter(bio, &iter, iter.bi_size);
288 if (!iter.bi_bvec_done)
289 idx = iter.bi_idx - 1;
290 else /* in the middle of bvec */
293 *bv = bio->bi_io_vec[idx];
296 * iter.bi_bvec_done records actual length of the last bvec
297 * if this bio ends in the middle of one io vector
299 if (iter.bi_bvec_done)
300 bv->bv_len = iter.bi_bvec_done;
304 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
305 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
306 BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
307 BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
308 BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
312 * bio integrity payload
314 struct bio_integrity_payload {
315 struct bio *bip_bio; /* parent bio */
317 struct bvec_iter bip_iter;
319 unsigned short bip_slab; /* slab the bip came from */
320 unsigned short bip_vcnt; /* # of integrity bio_vecs */
321 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
322 unsigned short bip_flags; /* control flags */
324 struct work_struct bip_work; /* I/O completion */
326 struct bio_vec *bip_vec;
327 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
330 #if defined(CONFIG_BLK_DEV_INTEGRITY)
332 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
334 if (bio->bi_opf & REQ_INTEGRITY)
335 return bio->bi_integrity;
340 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
342 struct bio_integrity_payload *bip = bio_integrity(bio);
345 return bip->bip_flags & flag;
350 static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
352 return bip->bip_iter.bi_sector;
355 static inline void bip_set_seed(struct bio_integrity_payload *bip,
358 bip->bip_iter.bi_sector = seed;
361 #endif /* CONFIG_BLK_DEV_INTEGRITY */
363 extern void bio_trim(struct bio *bio, int offset, int size);
364 extern struct bio *bio_split(struct bio *bio, int sectors,
365 gfp_t gfp, struct bio_set *bs);
368 * bio_next_split - get next @sectors from a bio, splitting if necessary
370 * @sectors: number of sectors to split from the front of @bio
372 * @bs: bio set to allocate from
374 * Returns a bio representing the next @sectors of @bio - if the bio is smaller
375 * than @sectors, returns the original bio unchanged.
377 static inline struct bio *bio_next_split(struct bio *bio, int sectors,
378 gfp_t gfp, struct bio_set *bs)
380 if (sectors >= bio_sectors(bio))
383 return bio_split(bio, sectors, gfp, bs);
386 extern struct bio_set *bioset_create(unsigned int, unsigned int, int flags);
388 BIOSET_NEED_BVECS = BIT(0),
389 BIOSET_NEED_RESCUER = BIT(1),
391 extern void bioset_free(struct bio_set *);
392 extern mempool_t *biovec_create_pool(int pool_entries);
394 extern struct bio *bio_alloc_bioset(gfp_t, unsigned int, struct bio_set *);
395 extern void bio_put(struct bio *);
397 extern void __bio_clone_fast(struct bio *, struct bio *);
398 extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
399 extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
401 extern struct bio_set *fs_bio_set;
403 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
405 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
408 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
410 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
413 static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
415 return bio_clone_bioset(bio, gfp_mask, NULL);
419 extern blk_qc_t submit_bio(struct bio *);
421 extern void bio_endio(struct bio *);
423 static inline void bio_io_error(struct bio *bio)
425 bio->bi_status = BLK_STS_IOERR;
429 static inline void bio_wouldblock_error(struct bio *bio)
431 bio->bi_status = BLK_STS_AGAIN;
435 struct request_queue;
436 extern int bio_phys_segments(struct request_queue *, struct bio *);
438 extern int submit_bio_wait(struct bio *bio);
439 extern void bio_advance(struct bio *, unsigned);
441 extern void bio_init(struct bio *bio, struct bio_vec *table,
442 unsigned short max_vecs);
443 extern void bio_uninit(struct bio *);
444 extern void bio_reset(struct bio *);
445 void bio_chain(struct bio *, struct bio *);
447 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
448 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
449 unsigned int, unsigned int);
450 int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
452 extern struct bio *bio_map_user_iov(struct request_queue *,
453 struct iov_iter *, gfp_t);
454 extern void bio_unmap_user(struct bio *);
455 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
457 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
459 extern void bio_set_pages_dirty(struct bio *bio);
460 extern void bio_check_pages_dirty(struct bio *bio);
462 void generic_start_io_acct(struct request_queue *q, int rw,
463 unsigned long sectors, struct hd_struct *part);
464 void generic_end_io_acct(struct request_queue *q, int rw,
465 struct hd_struct *part,
466 unsigned long start_time);
468 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
469 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
471 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
472 extern void bio_flush_dcache_pages(struct bio *bi);
474 static inline void bio_flush_dcache_pages(struct bio *bi)
479 extern void bio_copy_data(struct bio *dst, struct bio *src);
480 extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
481 extern void bio_free_pages(struct bio *bio);
483 extern struct bio *bio_copy_user_iov(struct request_queue *,
484 struct rq_map_data *,
487 extern int bio_uncopy_user(struct bio *);
488 void zero_fill_bio(struct bio *bio);
489 extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
490 extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
491 extern unsigned int bvec_nr_vecs(unsigned short idx);
493 #define bio_set_dev(bio, bdev) \
495 (bio)->bi_disk = (bdev)->bd_disk; \
496 (bio)->bi_partno = (bdev)->bd_partno; \
499 #define bio_copy_dev(dst, src) \
501 (dst)->bi_disk = (src)->bi_disk; \
502 (dst)->bi_partno = (src)->bi_partno; \
505 #define bio_dev(bio) \
506 disk_devt((bio)->bi_disk)
508 #define bio_devname(bio, buf) \
509 __bdevname(bio_dev(bio), (buf))
511 #ifdef CONFIG_BLK_CGROUP
512 int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css);
513 void bio_disassociate_task(struct bio *bio);
514 void bio_clone_blkcg_association(struct bio *dst, struct bio *src);
515 #else /* CONFIG_BLK_CGROUP */
516 static inline int bio_associate_blkcg(struct bio *bio,
517 struct cgroup_subsys_state *blkcg_css) { return 0; }
518 static inline void bio_disassociate_task(struct bio *bio) { }
519 static inline void bio_clone_blkcg_association(struct bio *dst,
521 #endif /* CONFIG_BLK_CGROUP */
523 #ifdef CONFIG_HIGHMEM
525 * remember never ever reenable interrupts between a bvec_kmap_irq and
528 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
533 * might not be a highmem page, but the preempt/irq count
534 * balancing is a lot nicer this way
536 local_irq_save(*flags);
537 addr = (unsigned long) kmap_atomic(bvec->bv_page);
539 BUG_ON(addr & ~PAGE_MASK);
541 return (char *) addr + bvec->bv_offset;
544 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
546 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
548 kunmap_atomic((void *) ptr);
549 local_irq_restore(*flags);
553 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
555 return page_address(bvec->bv_page) + bvec->bv_offset;
558 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
565 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
567 * A bio_list anchors a singly-linked list of bios chained through the bi_next
568 * member of the bio. The bio_list also caches the last list member to allow
569 * fast access to the tail.
576 static inline int bio_list_empty(const struct bio_list *bl)
578 return bl->head == NULL;
581 static inline void bio_list_init(struct bio_list *bl)
583 bl->head = bl->tail = NULL;
586 #define BIO_EMPTY_LIST { NULL, NULL }
588 #define bio_list_for_each(bio, bl) \
589 for (bio = (bl)->head; bio; bio = bio->bi_next)
591 static inline unsigned bio_list_size(const struct bio_list *bl)
596 bio_list_for_each(bio, bl)
602 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
607 bl->tail->bi_next = bio;
614 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
616 bio->bi_next = bl->head;
624 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
630 bl->tail->bi_next = bl2->head;
632 bl->head = bl2->head;
634 bl->tail = bl2->tail;
637 static inline void bio_list_merge_head(struct bio_list *bl,
638 struct bio_list *bl2)
644 bl2->tail->bi_next = bl->head;
646 bl->tail = bl2->tail;
648 bl->head = bl2->head;
651 static inline struct bio *bio_list_peek(struct bio_list *bl)
656 static inline struct bio *bio_list_pop(struct bio_list *bl)
658 struct bio *bio = bl->head;
661 bl->head = bl->head->bi_next;
671 static inline struct bio *bio_list_get(struct bio_list *bl)
673 struct bio *bio = bl->head;
675 bl->head = bl->tail = NULL;
681 * Increment chain count for the bio. Make sure the CHAIN flag update
682 * is visible before the raised count.
684 static inline void bio_inc_remaining(struct bio *bio)
686 bio_set_flag(bio, BIO_CHAIN);
687 smp_mb__before_atomic();
688 atomic_inc(&bio->__bi_remaining);
692 * bio_set is used to allow other portions of the IO system to
693 * allocate their own private memory pools for bio and iovec structures.
694 * These memory pools in turn all allocate from the bio_slab
695 * and the bvec_slabs[].
697 #define BIO_POOL_SIZE 2
700 struct kmem_cache *bio_slab;
701 unsigned int front_pad;
704 mempool_t *bvec_pool;
705 #if defined(CONFIG_BLK_DEV_INTEGRITY)
706 mempool_t *bio_integrity_pool;
707 mempool_t *bvec_integrity_pool;
711 * Deadlock avoidance for stacking block drivers: see comments in
712 * bio_alloc_bioset() for details
714 spinlock_t rescue_lock;
715 struct bio_list rescue_list;
716 struct work_struct rescue_work;
717 struct workqueue_struct *rescue_workqueue;
723 struct kmem_cache *slab;
727 * a small number of entries is fine, not going to be performance critical.
728 * basically we just need to survive
730 #define BIO_SPLIT_ENTRIES 2
732 #if defined(CONFIG_BLK_DEV_INTEGRITY)
734 #define bip_for_each_vec(bvl, bip, iter) \
735 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
737 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
739 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
741 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
742 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
743 extern bool bio_integrity_prep(struct bio *);
744 extern void bio_integrity_advance(struct bio *, unsigned int);
745 extern void bio_integrity_trim(struct bio *);
746 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
747 extern int bioset_integrity_create(struct bio_set *, int);
748 extern void bioset_integrity_free(struct bio_set *);
749 extern void bio_integrity_init(void);
751 #else /* CONFIG_BLK_DEV_INTEGRITY */
753 static inline void *bio_integrity(struct bio *bio)
758 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
763 static inline void bioset_integrity_free (struct bio_set *bs)
768 static inline bool bio_integrity_prep(struct bio *bio)
773 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
779 static inline void bio_integrity_advance(struct bio *bio,
780 unsigned int bytes_done)
785 static inline void bio_integrity_trim(struct bio *bio)
790 static inline void bio_integrity_init(void)
795 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
800 static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
803 return ERR_PTR(-EINVAL);
806 static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
807 unsigned int len, unsigned int offset)
812 #endif /* CONFIG_BLK_DEV_INTEGRITY */
814 #endif /* CONFIG_BLOCK */
815 #endif /* __LINUX_BIO_H */