2 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
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
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public Licens
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
19 #include <linux/swap.h>
20 #include <linux/bio.h>
21 #include <linux/blkdev.h>
22 #include <linux/slab.h>
23 #include <linux/init.h>
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/mempool.h>
27 #include <linux/workqueue.h>
28 #include <scsi/sg.h> /* for struct sg_iovec */
30 #include <trace/events/block.h>
33 * Test patch to inline a certain number of bi_io_vec's inside the bio
34 * itself, to shrink a bio data allocation from two mempool calls to one
36 #define BIO_INLINE_VECS 4
38 static mempool_t *bio_split_pool __read_mostly;
41 * if you change this list, also change bvec_alloc or things will
42 * break badly! cannot be bigger than what you can fit into an
45 #define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
46 struct biovec_slab bvec_slabs[BIOVEC_NR_POOLS] __read_mostly = {
47 BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
52 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
53 * IO code that does not need private memory pools.
55 struct bio_set *fs_bio_set;
58 * Our slab pool management
61 struct kmem_cache *slab;
62 unsigned int slab_ref;
63 unsigned int slab_size;
66 static DEFINE_MUTEX(bio_slab_lock);
67 static struct bio_slab *bio_slabs;
68 static unsigned int bio_slab_nr, bio_slab_max;
70 static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
72 unsigned int sz = sizeof(struct bio) + extra_size;
73 struct kmem_cache *slab = NULL;
74 struct bio_slab *bslab;
75 unsigned int i, entry = -1;
77 mutex_lock(&bio_slab_lock);
80 while (i < bio_slab_nr) {
81 struct bio_slab *bslab = &bio_slabs[i];
83 if (!bslab->slab && entry == -1)
85 else if (bslab->slab_size == sz) {
96 if (bio_slab_nr == bio_slab_max && entry == -1) {
98 bio_slabs = krealloc(bio_slabs,
99 bio_slab_max * sizeof(struct bio_slab),
105 entry = bio_slab_nr++;
107 bslab = &bio_slabs[entry];
109 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
110 slab = kmem_cache_create(bslab->name, sz, 0, SLAB_HWCACHE_ALIGN, NULL);
114 printk("bio: create slab <%s> at %d\n", bslab->name, entry);
117 bslab->slab_size = sz;
119 mutex_unlock(&bio_slab_lock);
123 static void bio_put_slab(struct bio_set *bs)
125 struct bio_slab *bslab = NULL;
128 mutex_lock(&bio_slab_lock);
130 for (i = 0; i < bio_slab_nr; i++) {
131 if (bs->bio_slab == bio_slabs[i].slab) {
132 bslab = &bio_slabs[i];
137 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
140 WARN_ON(!bslab->slab_ref);
142 if (--bslab->slab_ref)
145 kmem_cache_destroy(bslab->slab);
149 mutex_unlock(&bio_slab_lock);
152 unsigned int bvec_nr_vecs(unsigned short idx)
154 return bvec_slabs[idx].nr_vecs;
157 void bvec_free_bs(struct bio_set *bs, struct bio_vec *bv, unsigned int idx)
159 BIO_BUG_ON(idx >= BIOVEC_NR_POOLS);
161 if (idx == BIOVEC_MAX_IDX)
162 mempool_free(bv, bs->bvec_pool);
164 struct biovec_slab *bvs = bvec_slabs + idx;
166 kmem_cache_free(bvs->slab, bv);
170 struct bio_vec *bvec_alloc_bs(gfp_t gfp_mask, int nr, unsigned long *idx,
176 * see comment near bvec_array define!
194 case 129 ... BIO_MAX_PAGES:
202 * idx now points to the pool we want to allocate from. only the
203 * 1-vec entry pool is mempool backed.
205 if (*idx == BIOVEC_MAX_IDX) {
207 bvl = mempool_alloc(bs->bvec_pool, gfp_mask);
209 struct biovec_slab *bvs = bvec_slabs + *idx;
210 gfp_t __gfp_mask = gfp_mask & ~(__GFP_WAIT | __GFP_IO);
213 * Make this allocation restricted and don't dump info on
214 * allocation failures, since we'll fallback to the mempool
215 * in case of failure.
217 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
220 * Try a slab allocation. If this fails and __GFP_WAIT
221 * is set, retry with the 1-entry mempool
223 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
224 if (unlikely(!bvl && (gfp_mask & __GFP_WAIT))) {
225 *idx = BIOVEC_MAX_IDX;
233 void bio_free(struct bio *bio, struct bio_set *bs)
237 if (bio_has_allocated_vec(bio))
238 bvec_free_bs(bs, bio->bi_io_vec, BIO_POOL_IDX(bio));
240 if (bio_integrity(bio))
241 bio_integrity_free(bio);
244 * If we have front padding, adjust the bio pointer before freeing
250 mempool_free(p, bs->bio_pool);
253 void bio_init(struct bio *bio)
255 memset(bio, 0, sizeof(*bio));
256 bio->bi_flags = 1 << BIO_UPTODATE;
257 bio->bi_comp_cpu = -1;
258 atomic_set(&bio->bi_cnt, 1);
262 * bio_alloc_bioset - allocate a bio for I/O
263 * @gfp_mask: the GFP_ mask given to the slab allocator
264 * @nr_iovecs: number of iovecs to pre-allocate
265 * @bs: the bio_set to allocate from. If %NULL, just use kmalloc
268 * bio_alloc_bioset will first try its own mempool to satisfy the allocation.
269 * If %__GFP_WAIT is set then we will block on the internal pool waiting
270 * for a &struct bio to become free. If a %NULL @bs is passed in, we will
271 * fall back to just using @kmalloc to allocate the required memory.
273 * Note that the caller must set ->bi_destructor on succesful return
274 * of a bio, to do the appropriate freeing of the bio once the reference
275 * count drops to zero.
277 struct bio *bio_alloc_bioset(gfp_t gfp_mask, int nr_iovecs, struct bio_set *bs)
279 unsigned long idx = BIO_POOL_NONE;
280 struct bio_vec *bvl = NULL;
284 p = mempool_alloc(bs->bio_pool, gfp_mask);
287 bio = p + bs->front_pad;
291 if (unlikely(!nr_iovecs))
294 if (nr_iovecs <= BIO_INLINE_VECS) {
295 bvl = bio->bi_inline_vecs;
296 nr_iovecs = BIO_INLINE_VECS;
298 bvl = bvec_alloc_bs(gfp_mask, nr_iovecs, &idx, bs);
302 nr_iovecs = bvec_nr_vecs(idx);
305 bio->bi_flags |= idx << BIO_POOL_OFFSET;
306 bio->bi_max_vecs = nr_iovecs;
307 bio->bi_io_vec = bvl;
311 mempool_free(p, bs->bio_pool);
315 static void bio_fs_destructor(struct bio *bio)
317 bio_free(bio, fs_bio_set);
321 * bio_alloc - allocate a new bio, memory pool backed
322 * @gfp_mask: allocation mask to use
323 * @nr_iovecs: number of iovecs
325 * Allocate a new bio with @nr_iovecs bvecs. If @gfp_mask
326 * contains __GFP_WAIT, the allocation is guaranteed to succeed.
329 * Pointer to new bio on success, NULL on failure.
331 struct bio *bio_alloc(gfp_t gfp_mask, int nr_iovecs)
333 struct bio *bio = bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
336 bio->bi_destructor = bio_fs_destructor;
341 static void bio_kmalloc_destructor(struct bio *bio)
343 if (bio_integrity(bio))
344 bio_integrity_free(bio);
349 * bio_alloc - allocate a bio for I/O
350 * @gfp_mask: the GFP_ mask given to the slab allocator
351 * @nr_iovecs: number of iovecs to pre-allocate
354 * bio_alloc will allocate a bio and associated bio_vec array that can hold
355 * at least @nr_iovecs entries. Allocations will be done from the
356 * fs_bio_set. Also see @bio_alloc_bioset.
358 * If %__GFP_WAIT is set, then bio_alloc will always be able to allocate
359 * a bio. This is due to the mempool guarantees. To make this work, callers
360 * must never allocate more than 1 bio at a time from this pool. Callers
361 * that need to allocate more than 1 bio must always submit the previously
362 * allocated bio for IO before attempting to allocate a new one. Failure to
363 * do so can cause livelocks under memory pressure.
366 struct bio *bio_kmalloc(gfp_t gfp_mask, int nr_iovecs)
370 bio = kmalloc(sizeof(struct bio) + nr_iovecs * sizeof(struct bio_vec),
376 bio->bi_flags |= BIO_POOL_NONE << BIO_POOL_OFFSET;
377 bio->bi_max_vecs = nr_iovecs;
378 bio->bi_io_vec = bio->bi_inline_vecs;
379 bio->bi_destructor = bio_kmalloc_destructor;
384 void zero_fill_bio(struct bio *bio)
390 bio_for_each_segment(bv, bio, i) {
391 char *data = bvec_kmap_irq(bv, &flags);
392 memset(data, 0, bv->bv_len);
393 flush_dcache_page(bv->bv_page);
394 bvec_kunmap_irq(data, &flags);
397 EXPORT_SYMBOL(zero_fill_bio);
400 * bio_put - release a reference to a bio
401 * @bio: bio to release reference to
404 * Put a reference to a &struct bio, either one you have gotten with
405 * bio_alloc or bio_get. The last put of a bio will free it.
407 void bio_put(struct bio *bio)
409 BIO_BUG_ON(!atomic_read(&bio->bi_cnt));
414 if (atomic_dec_and_test(&bio->bi_cnt)) {
416 bio->bi_destructor(bio);
420 inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
422 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
423 blk_recount_segments(q, bio);
425 return bio->bi_phys_segments;
429 * __bio_clone - clone a bio
430 * @bio: destination bio
431 * @bio_src: bio to clone
433 * Clone a &bio. Caller will own the returned bio, but not
434 * the actual data it points to. Reference count of returned
437 void __bio_clone(struct bio *bio, struct bio *bio_src)
439 memcpy(bio->bi_io_vec, bio_src->bi_io_vec,
440 bio_src->bi_max_vecs * sizeof(struct bio_vec));
443 * most users will be overriding ->bi_bdev with a new target,
444 * so we don't set nor calculate new physical/hw segment counts here
446 bio->bi_sector = bio_src->bi_sector;
447 bio->bi_bdev = bio_src->bi_bdev;
448 bio->bi_flags |= 1 << BIO_CLONED;
449 bio->bi_rw = bio_src->bi_rw;
450 bio->bi_vcnt = bio_src->bi_vcnt;
451 bio->bi_size = bio_src->bi_size;
452 bio->bi_idx = bio_src->bi_idx;
456 * bio_clone - clone a bio
458 * @gfp_mask: allocation priority
460 * Like __bio_clone, only also allocates the returned bio
462 struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
464 struct bio *b = bio_alloc_bioset(gfp_mask, bio->bi_max_vecs, fs_bio_set);
469 b->bi_destructor = bio_fs_destructor;
472 if (bio_integrity(bio)) {
475 ret = bio_integrity_clone(b, bio, gfp_mask);
487 * bio_get_nr_vecs - return approx number of vecs
490 * Return the approximate number of pages we can send to this target.
491 * There's no guarantee that you will be able to fit this number of pages
492 * into a bio, it does not account for dynamic restrictions that vary
495 int bio_get_nr_vecs(struct block_device *bdev)
497 struct request_queue *q = bdev_get_queue(bdev);
500 nr_pages = ((queue_max_sectors(q) << 9) + PAGE_SIZE - 1) >> PAGE_SHIFT;
501 if (nr_pages > queue_max_phys_segments(q))
502 nr_pages = queue_max_phys_segments(q);
503 if (nr_pages > queue_max_hw_segments(q))
504 nr_pages = queue_max_hw_segments(q);
509 static int __bio_add_page(struct request_queue *q, struct bio *bio, struct page
510 *page, unsigned int len, unsigned int offset,
511 unsigned short max_sectors)
513 int retried_segments = 0;
514 struct bio_vec *bvec;
517 * cloned bio must not modify vec list
519 if (unlikely(bio_flagged(bio, BIO_CLONED)))
522 if (((bio->bi_size + len) >> 9) > max_sectors)
526 * For filesystems with a blocksize smaller than the pagesize
527 * we will often be called with the same page as last time and
528 * a consecutive offset. Optimize this special case.
530 if (bio->bi_vcnt > 0) {
531 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
533 if (page == prev->bv_page &&
534 offset == prev->bv_offset + prev->bv_len) {
537 if (q->merge_bvec_fn) {
538 struct bvec_merge_data bvm = {
539 .bi_bdev = bio->bi_bdev,
540 .bi_sector = bio->bi_sector,
541 .bi_size = bio->bi_size,
545 if (q->merge_bvec_fn(q, &bvm, prev) < len) {
555 if (bio->bi_vcnt >= bio->bi_max_vecs)
559 * we might lose a segment or two here, but rather that than
560 * make this too complex.
563 while (bio->bi_phys_segments >= queue_max_phys_segments(q)
564 || bio->bi_phys_segments >= queue_max_hw_segments(q)) {
566 if (retried_segments)
569 retried_segments = 1;
570 blk_recount_segments(q, bio);
574 * setup the new entry, we might clear it again later if we
575 * cannot add the page
577 bvec = &bio->bi_io_vec[bio->bi_vcnt];
578 bvec->bv_page = page;
580 bvec->bv_offset = offset;
583 * if queue has other restrictions (eg varying max sector size
584 * depending on offset), it can specify a merge_bvec_fn in the
585 * queue to get further control
587 if (q->merge_bvec_fn) {
588 struct bvec_merge_data bvm = {
589 .bi_bdev = bio->bi_bdev,
590 .bi_sector = bio->bi_sector,
591 .bi_size = bio->bi_size,
596 * merge_bvec_fn() returns number of bytes it can accept
599 if (q->merge_bvec_fn(q, &bvm, bvec) < len) {
600 bvec->bv_page = NULL;
607 /* If we may be able to merge these biovecs, force a recount */
608 if (bio->bi_vcnt && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
609 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
612 bio->bi_phys_segments++;
619 * bio_add_pc_page - attempt to add page to bio
620 * @q: the target queue
621 * @bio: destination bio
623 * @len: vec entry length
624 * @offset: vec entry offset
626 * Attempt to add a page to the bio_vec maplist. This can fail for a
627 * number of reasons, such as the bio being full or target block
628 * device limitations. The target block device must allow bio's
629 * smaller than PAGE_SIZE, so it is always possible to add a single
630 * page to an empty bio. This should only be used by REQ_PC bios.
632 int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page *page,
633 unsigned int len, unsigned int offset)
635 return __bio_add_page(q, bio, page, len, offset,
636 queue_max_hw_sectors(q));
640 * bio_add_page - attempt to add page to bio
641 * @bio: destination bio
643 * @len: vec entry length
644 * @offset: vec entry offset
646 * Attempt to add a page to the bio_vec maplist. This can fail for a
647 * number of reasons, such as the bio being full or target block
648 * device limitations. The target block device must allow bio's
649 * smaller than PAGE_SIZE, so it is always possible to add a single
650 * page to an empty bio.
652 int bio_add_page(struct bio *bio, struct page *page, unsigned int len,
655 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
656 return __bio_add_page(q, bio, page, len, offset, queue_max_sectors(q));
659 struct bio_map_data {
660 struct bio_vec *iovecs;
661 struct sg_iovec *sgvecs;
666 static void bio_set_map_data(struct bio_map_data *bmd, struct bio *bio,
667 struct sg_iovec *iov, int iov_count,
670 memcpy(bmd->iovecs, bio->bi_io_vec, sizeof(struct bio_vec) * bio->bi_vcnt);
671 memcpy(bmd->sgvecs, iov, sizeof(struct sg_iovec) * iov_count);
672 bmd->nr_sgvecs = iov_count;
673 bmd->is_our_pages = is_our_pages;
674 bio->bi_private = bmd;
677 static void bio_free_map_data(struct bio_map_data *bmd)
684 static struct bio_map_data *bio_alloc_map_data(int nr_segs, int iov_count,
687 struct bio_map_data *bmd = kmalloc(sizeof(*bmd), gfp_mask);
692 bmd->iovecs = kmalloc(sizeof(struct bio_vec) * nr_segs, gfp_mask);
698 bmd->sgvecs = kmalloc(sizeof(struct sg_iovec) * iov_count, gfp_mask);
707 static int __bio_copy_iov(struct bio *bio, struct bio_vec *iovecs,
708 struct sg_iovec *iov, int iov_count, int uncopy,
712 struct bio_vec *bvec;
714 unsigned int iov_off = 0;
715 int read = bio_data_dir(bio) == READ;
717 __bio_for_each_segment(bvec, bio, i, 0) {
718 char *bv_addr = page_address(bvec->bv_page);
719 unsigned int bv_len = iovecs[i].bv_len;
721 while (bv_len && iov_idx < iov_count) {
723 char __user *iov_addr;
725 bytes = min_t(unsigned int,
726 iov[iov_idx].iov_len - iov_off, bv_len);
727 iov_addr = iov[iov_idx].iov_base + iov_off;
730 if (!read && !uncopy)
731 ret = copy_from_user(bv_addr, iov_addr,
734 ret = copy_to_user(iov_addr, bv_addr,
746 if (iov[iov_idx].iov_len == iov_off) {
753 __free_page(bvec->bv_page);
760 * bio_uncopy_user - finish previously mapped bio
761 * @bio: bio being terminated
763 * Free pages allocated from bio_copy_user() and write back data
764 * to user space in case of a read.
766 int bio_uncopy_user(struct bio *bio)
768 struct bio_map_data *bmd = bio->bi_private;
771 if (!bio_flagged(bio, BIO_NULL_MAPPED))
772 ret = __bio_copy_iov(bio, bmd->iovecs, bmd->sgvecs,
773 bmd->nr_sgvecs, 1, bmd->is_our_pages);
774 bio_free_map_data(bmd);
780 * bio_copy_user_iov - copy user data to bio
781 * @q: destination block queue
782 * @map_data: pointer to the rq_map_data holding pages (if necessary)
784 * @iov_count: number of elements in the iovec
785 * @write_to_vm: bool indicating writing to pages or not
786 * @gfp_mask: memory allocation flags
788 * Prepares and returns a bio for indirect user io, bouncing data
789 * to/from kernel pages as necessary. Must be paired with
790 * call bio_uncopy_user() on io completion.
792 struct bio *bio_copy_user_iov(struct request_queue *q,
793 struct rq_map_data *map_data,
794 struct sg_iovec *iov, int iov_count,
795 int write_to_vm, gfp_t gfp_mask)
797 struct bio_map_data *bmd;
798 struct bio_vec *bvec;
803 unsigned int len = 0;
804 unsigned int offset = map_data ? map_data->offset & ~PAGE_MASK : 0;
806 for (i = 0; i < iov_count; i++) {
811 uaddr = (unsigned long)iov[i].iov_base;
812 end = (uaddr + iov[i].iov_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
813 start = uaddr >> PAGE_SHIFT;
815 nr_pages += end - start;
816 len += iov[i].iov_len;
822 bmd = bio_alloc_map_data(nr_pages, iov_count, gfp_mask);
824 return ERR_PTR(-ENOMEM);
827 bio = bio_kmalloc(gfp_mask, nr_pages);
831 bio->bi_rw |= (!write_to_vm << BIO_RW);
836 nr_pages = 1 << map_data->page_order;
837 i = map_data->offset / PAGE_SIZE;
840 unsigned int bytes = PAGE_SIZE;
848 if (i == map_data->nr_entries * nr_pages) {
853 page = map_data->pages[i / nr_pages];
854 page += (i % nr_pages);
858 page = alloc_page(q->bounce_gfp | gfp_mask);
865 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
878 if (!write_to_vm && (!map_data || !map_data->null_mapped)) {
879 ret = __bio_copy_iov(bio, bio->bi_io_vec, iov, iov_count, 0, 0);
884 bio_set_map_data(bmd, bio, iov, iov_count, map_data ? 0 : 1);
888 bio_for_each_segment(bvec, bio, i)
889 __free_page(bvec->bv_page);
893 bio_free_map_data(bmd);
898 * bio_copy_user - copy user data to bio
899 * @q: destination block queue
900 * @map_data: pointer to the rq_map_data holding pages (if necessary)
901 * @uaddr: start of user address
902 * @len: length in bytes
903 * @write_to_vm: bool indicating writing to pages or not
904 * @gfp_mask: memory allocation flags
906 * Prepares and returns a bio for indirect user io, bouncing data
907 * to/from kernel pages as necessary. Must be paired with
908 * call bio_uncopy_user() on io completion.
910 struct bio *bio_copy_user(struct request_queue *q, struct rq_map_data *map_data,
911 unsigned long uaddr, unsigned int len,
912 int write_to_vm, gfp_t gfp_mask)
916 iov.iov_base = (void __user *)uaddr;
919 return bio_copy_user_iov(q, map_data, &iov, 1, write_to_vm, gfp_mask);
922 static struct bio *__bio_map_user_iov(struct request_queue *q,
923 struct block_device *bdev,
924 struct sg_iovec *iov, int iov_count,
925 int write_to_vm, gfp_t gfp_mask)
934 for (i = 0; i < iov_count; i++) {
935 unsigned long uaddr = (unsigned long)iov[i].iov_base;
936 unsigned long len = iov[i].iov_len;
937 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
938 unsigned long start = uaddr >> PAGE_SHIFT;
940 nr_pages += end - start;
942 * buffer must be aligned to at least hardsector size for now
944 if (uaddr & queue_dma_alignment(q))
945 return ERR_PTR(-EINVAL);
949 return ERR_PTR(-EINVAL);
951 bio = bio_kmalloc(gfp_mask, nr_pages);
953 return ERR_PTR(-ENOMEM);
956 pages = kcalloc(nr_pages, sizeof(struct page *), gfp_mask);
960 for (i = 0; i < iov_count; i++) {
961 unsigned long uaddr = (unsigned long)iov[i].iov_base;
962 unsigned long len = iov[i].iov_len;
963 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
964 unsigned long start = uaddr >> PAGE_SHIFT;
965 const int local_nr_pages = end - start;
966 const int page_limit = cur_page + local_nr_pages;
968 ret = get_user_pages_fast(uaddr, local_nr_pages,
969 write_to_vm, &pages[cur_page]);
970 if (ret < local_nr_pages) {
975 offset = uaddr & ~PAGE_MASK;
976 for (j = cur_page; j < page_limit; j++) {
977 unsigned int bytes = PAGE_SIZE - offset;
988 if (bio_add_pc_page(q, bio, pages[j], bytes, offset) <
998 * release the pages we didn't map into the bio, if any
1000 while (j < page_limit)
1001 page_cache_release(pages[j++]);
1007 * set data direction, and check if mapped pages need bouncing
1010 bio->bi_rw |= (1 << BIO_RW);
1012 bio->bi_bdev = bdev;
1013 bio->bi_flags |= (1 << BIO_USER_MAPPED);
1017 for (i = 0; i < nr_pages; i++) {
1020 page_cache_release(pages[i]);
1025 return ERR_PTR(ret);
1029 * bio_map_user - map user address into bio
1030 * @q: the struct request_queue for the bio
1031 * @bdev: destination block device
1032 * @uaddr: start of user address
1033 * @len: length in bytes
1034 * @write_to_vm: bool indicating writing to pages or not
1035 * @gfp_mask: memory allocation flags
1037 * Map the user space address into a bio suitable for io to a block
1038 * device. Returns an error pointer in case of error.
1040 struct bio *bio_map_user(struct request_queue *q, struct block_device *bdev,
1041 unsigned long uaddr, unsigned int len, int write_to_vm,
1044 struct sg_iovec iov;
1046 iov.iov_base = (void __user *)uaddr;
1049 return bio_map_user_iov(q, bdev, &iov, 1, write_to_vm, gfp_mask);
1053 * bio_map_user_iov - map user sg_iovec table into bio
1054 * @q: the struct request_queue for the bio
1055 * @bdev: destination block device
1057 * @iov_count: number of elements in the iovec
1058 * @write_to_vm: bool indicating writing to pages or not
1059 * @gfp_mask: memory allocation flags
1061 * Map the user space address into a bio suitable for io to a block
1062 * device. Returns an error pointer in case of error.
1064 struct bio *bio_map_user_iov(struct request_queue *q, struct block_device *bdev,
1065 struct sg_iovec *iov, int iov_count,
1066 int write_to_vm, gfp_t gfp_mask)
1070 bio = __bio_map_user_iov(q, bdev, iov, iov_count, write_to_vm,
1076 * subtle -- if __bio_map_user() ended up bouncing a bio,
1077 * it would normally disappear when its bi_end_io is run.
1078 * however, we need it for the unmap, so grab an extra
1086 static void __bio_unmap_user(struct bio *bio)
1088 struct bio_vec *bvec;
1092 * make sure we dirty pages we wrote to
1094 __bio_for_each_segment(bvec, bio, i, 0) {
1095 if (bio_data_dir(bio) == READ)
1096 set_page_dirty_lock(bvec->bv_page);
1098 page_cache_release(bvec->bv_page);
1105 * bio_unmap_user - unmap a bio
1106 * @bio: the bio being unmapped
1108 * Unmap a bio previously mapped by bio_map_user(). Must be called with
1109 * a process context.
1111 * bio_unmap_user() may sleep.
1113 void bio_unmap_user(struct bio *bio)
1115 __bio_unmap_user(bio);
1119 static void bio_map_kern_endio(struct bio *bio, int err)
1125 static struct bio *__bio_map_kern(struct request_queue *q, void *data,
1126 unsigned int len, gfp_t gfp_mask)
1128 unsigned long kaddr = (unsigned long)data;
1129 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1130 unsigned long start = kaddr >> PAGE_SHIFT;
1131 const int nr_pages = end - start;
1135 bio = bio_kmalloc(gfp_mask, nr_pages);
1137 return ERR_PTR(-ENOMEM);
1139 offset = offset_in_page(kaddr);
1140 for (i = 0; i < nr_pages; i++) {
1141 unsigned int bytes = PAGE_SIZE - offset;
1149 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
1158 bio->bi_end_io = bio_map_kern_endio;
1163 * bio_map_kern - map kernel address into bio
1164 * @q: the struct request_queue for the bio
1165 * @data: pointer to buffer to map
1166 * @len: length in bytes
1167 * @gfp_mask: allocation flags for bio allocation
1169 * Map the kernel address into a bio suitable for io to a block
1170 * device. Returns an error pointer in case of error.
1172 struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1177 bio = __bio_map_kern(q, data, len, gfp_mask);
1181 if (bio->bi_size == len)
1185 * Don't support partial mappings.
1188 return ERR_PTR(-EINVAL);
1191 static void bio_copy_kern_endio(struct bio *bio, int err)
1193 struct bio_vec *bvec;
1194 const int read = bio_data_dir(bio) == READ;
1195 struct bio_map_data *bmd = bio->bi_private;
1197 char *p = bmd->sgvecs[0].iov_base;
1199 __bio_for_each_segment(bvec, bio, i, 0) {
1200 char *addr = page_address(bvec->bv_page);
1201 int len = bmd->iovecs[i].bv_len;
1204 memcpy(p, addr, len);
1206 __free_page(bvec->bv_page);
1210 bio_free_map_data(bmd);
1215 * bio_copy_kern - copy kernel address into bio
1216 * @q: the struct request_queue for the bio
1217 * @data: pointer to buffer to copy
1218 * @len: length in bytes
1219 * @gfp_mask: allocation flags for bio and page allocation
1220 * @reading: data direction is READ
1222 * copy the kernel address into a bio suitable for io to a block
1223 * device. Returns an error pointer in case of error.
1225 struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1226 gfp_t gfp_mask, int reading)
1229 struct bio_vec *bvec;
1232 bio = bio_copy_user(q, NULL, (unsigned long)data, len, 1, gfp_mask);
1239 bio_for_each_segment(bvec, bio, i) {
1240 char *addr = page_address(bvec->bv_page);
1242 memcpy(addr, p, bvec->bv_len);
1247 bio->bi_end_io = bio_copy_kern_endio;
1253 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1254 * for performing direct-IO in BIOs.
1256 * The problem is that we cannot run set_page_dirty() from interrupt context
1257 * because the required locks are not interrupt-safe. So what we can do is to
1258 * mark the pages dirty _before_ performing IO. And in interrupt context,
1259 * check that the pages are still dirty. If so, fine. If not, redirty them
1260 * in process context.
1262 * We special-case compound pages here: normally this means reads into hugetlb
1263 * pages. The logic in here doesn't really work right for compound pages
1264 * because the VM does not uniformly chase down the head page in all cases.
1265 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1266 * handle them at all. So we skip compound pages here at an early stage.
1268 * Note that this code is very hard to test under normal circumstances because
1269 * direct-io pins the pages with get_user_pages(). This makes
1270 * is_page_cache_freeable return false, and the VM will not clean the pages.
1271 * But other code (eg, pdflush) could clean the pages if they are mapped
1274 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1275 * deferred bio dirtying paths.
1279 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1281 void bio_set_pages_dirty(struct bio *bio)
1283 struct bio_vec *bvec = bio->bi_io_vec;
1286 for (i = 0; i < bio->bi_vcnt; i++) {
1287 struct page *page = bvec[i].bv_page;
1289 if (page && !PageCompound(page))
1290 set_page_dirty_lock(page);
1294 static void bio_release_pages(struct bio *bio)
1296 struct bio_vec *bvec = bio->bi_io_vec;
1299 for (i = 0; i < bio->bi_vcnt; i++) {
1300 struct page *page = bvec[i].bv_page;
1308 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1309 * If they are, then fine. If, however, some pages are clean then they must
1310 * have been written out during the direct-IO read. So we take another ref on
1311 * the BIO and the offending pages and re-dirty the pages in process context.
1313 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
1314 * here on. It will run one page_cache_release() against each page and will
1315 * run one bio_put() against the BIO.
1318 static void bio_dirty_fn(struct work_struct *work);
1320 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
1321 static DEFINE_SPINLOCK(bio_dirty_lock);
1322 static struct bio *bio_dirty_list;
1325 * This runs in process context
1327 static void bio_dirty_fn(struct work_struct *work)
1329 unsigned long flags;
1332 spin_lock_irqsave(&bio_dirty_lock, flags);
1333 bio = bio_dirty_list;
1334 bio_dirty_list = NULL;
1335 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1338 struct bio *next = bio->bi_private;
1340 bio_set_pages_dirty(bio);
1341 bio_release_pages(bio);
1347 void bio_check_pages_dirty(struct bio *bio)
1349 struct bio_vec *bvec = bio->bi_io_vec;
1350 int nr_clean_pages = 0;
1353 for (i = 0; i < bio->bi_vcnt; i++) {
1354 struct page *page = bvec[i].bv_page;
1356 if (PageDirty(page) || PageCompound(page)) {
1357 page_cache_release(page);
1358 bvec[i].bv_page = NULL;
1364 if (nr_clean_pages) {
1365 unsigned long flags;
1367 spin_lock_irqsave(&bio_dirty_lock, flags);
1368 bio->bi_private = bio_dirty_list;
1369 bio_dirty_list = bio;
1370 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1371 schedule_work(&bio_dirty_work);
1378 * bio_endio - end I/O on a bio
1380 * @error: error, if any
1383 * bio_endio() will end I/O on the whole bio. bio_endio() is the
1384 * preferred way to end I/O on a bio, it takes care of clearing
1385 * BIO_UPTODATE on error. @error is 0 on success, and and one of the
1386 * established -Exxxx (-EIO, for instance) error values in case
1387 * something went wrong. Noone should call bi_end_io() directly on a
1388 * bio unless they own it and thus know that it has an end_io
1391 void bio_endio(struct bio *bio, int error)
1394 clear_bit(BIO_UPTODATE, &bio->bi_flags);
1395 else if (!test_bit(BIO_UPTODATE, &bio->bi_flags))
1399 bio->bi_end_io(bio, error);
1402 void bio_pair_release(struct bio_pair *bp)
1404 if (atomic_dec_and_test(&bp->cnt)) {
1405 struct bio *master = bp->bio1.bi_private;
1407 bio_endio(master, bp->error);
1408 mempool_free(bp, bp->bio2.bi_private);
1412 static void bio_pair_end_1(struct bio *bi, int err)
1414 struct bio_pair *bp = container_of(bi, struct bio_pair, bio1);
1419 bio_pair_release(bp);
1422 static void bio_pair_end_2(struct bio *bi, int err)
1424 struct bio_pair *bp = container_of(bi, struct bio_pair, bio2);
1429 bio_pair_release(bp);
1433 * split a bio - only worry about a bio with a single page in its iovec
1435 struct bio_pair *bio_split(struct bio *bi, int first_sectors)
1437 struct bio_pair *bp = mempool_alloc(bio_split_pool, GFP_NOIO);
1442 trace_block_split(bdev_get_queue(bi->bi_bdev), bi,
1443 bi->bi_sector + first_sectors);
1445 BUG_ON(bi->bi_vcnt != 1);
1446 BUG_ON(bi->bi_idx != 0);
1447 atomic_set(&bp->cnt, 3);
1451 bp->bio2.bi_sector += first_sectors;
1452 bp->bio2.bi_size -= first_sectors << 9;
1453 bp->bio1.bi_size = first_sectors << 9;
1455 bp->bv1 = bi->bi_io_vec[0];
1456 bp->bv2 = bi->bi_io_vec[0];
1457 bp->bv2.bv_offset += first_sectors << 9;
1458 bp->bv2.bv_len -= first_sectors << 9;
1459 bp->bv1.bv_len = first_sectors << 9;
1461 bp->bio1.bi_io_vec = &bp->bv1;
1462 bp->bio2.bi_io_vec = &bp->bv2;
1464 bp->bio1.bi_max_vecs = 1;
1465 bp->bio2.bi_max_vecs = 1;
1467 bp->bio1.bi_end_io = bio_pair_end_1;
1468 bp->bio2.bi_end_io = bio_pair_end_2;
1470 bp->bio1.bi_private = bi;
1471 bp->bio2.bi_private = bio_split_pool;
1473 if (bio_integrity(bi))
1474 bio_integrity_split(bi, bp, first_sectors);
1480 * bio_sector_offset - Find hardware sector offset in bio
1481 * @bio: bio to inspect
1482 * @index: bio_vec index
1483 * @offset: offset in bv_page
1485 * Return the number of hardware sectors between beginning of bio
1486 * and an end point indicated by a bio_vec index and an offset
1487 * within that vector's page.
1489 sector_t bio_sector_offset(struct bio *bio, unsigned short index,
1490 unsigned int offset)
1492 unsigned int sector_sz;
1497 sector_sz = queue_logical_block_size(bio->bi_bdev->bd_disk->queue);
1500 if (index >= bio->bi_idx)
1501 index = bio->bi_vcnt - 1;
1503 __bio_for_each_segment(bv, bio, i, 0) {
1505 if (offset > bv->bv_offset)
1506 sectors += (offset - bv->bv_offset) / sector_sz;
1510 sectors += bv->bv_len / sector_sz;
1515 EXPORT_SYMBOL(bio_sector_offset);
1518 * create memory pools for biovec's in a bio_set.
1519 * use the global biovec slabs created for general use.
1521 static int biovec_create_pools(struct bio_set *bs, int pool_entries)
1523 struct biovec_slab *bp = bvec_slabs + BIOVEC_MAX_IDX;
1525 bs->bvec_pool = mempool_create_slab_pool(pool_entries, bp->slab);
1532 static void biovec_free_pools(struct bio_set *bs)
1534 mempool_destroy(bs->bvec_pool);
1537 void bioset_free(struct bio_set *bs)
1540 mempool_destroy(bs->bio_pool);
1542 biovec_free_pools(bs);
1549 * bioset_create - Create a bio_set
1550 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1551 * @front_pad: Number of bytes to allocate in front of the returned bio
1554 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1555 * to ask for a number of bytes to be allocated in front of the bio.
1556 * Front pad allocation is useful for embedding the bio inside
1557 * another structure, to avoid allocating extra data to go with the bio.
1558 * Note that the bio must be embedded at the END of that structure always,
1559 * or things will break badly.
1561 struct bio_set *bioset_create(unsigned int pool_size, unsigned int front_pad)
1563 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1566 bs = kzalloc(sizeof(*bs), GFP_KERNEL);
1570 bs->front_pad = front_pad;
1572 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
1573 if (!bs->bio_slab) {
1578 bs->bio_pool = mempool_create_slab_pool(pool_size, bs->bio_slab);
1582 if (!biovec_create_pools(bs, pool_size))
1590 static void __init biovec_init_slabs(void)
1594 for (i = 0; i < BIOVEC_NR_POOLS; i++) {
1596 struct biovec_slab *bvs = bvec_slabs + i;
1598 #ifndef CONFIG_BLK_DEV_INTEGRITY
1599 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
1605 size = bvs->nr_vecs * sizeof(struct bio_vec);
1606 bvs->slab = kmem_cache_create(bvs->name, size, 0,
1607 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
1611 static int __init init_bio(void)
1615 bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
1617 panic("bio: can't allocate bios\n");
1619 biovec_init_slabs();
1621 fs_bio_set = bioset_create(BIO_POOL_SIZE, 0);
1623 panic("bio: can't allocate bios\n");
1625 bio_split_pool = mempool_create_kmalloc_pool(BIO_SPLIT_ENTRIES,
1626 sizeof(struct bio_pair));
1627 if (!bio_split_pool)
1628 panic("bio: can't create split pool\n");
1633 subsys_initcall(init_bio);
1635 EXPORT_SYMBOL(bio_alloc);
1636 EXPORT_SYMBOL(bio_kmalloc);
1637 EXPORT_SYMBOL(bio_put);
1638 EXPORT_SYMBOL(bio_free);
1639 EXPORT_SYMBOL(bio_endio);
1640 EXPORT_SYMBOL(bio_init);
1641 EXPORT_SYMBOL(__bio_clone);
1642 EXPORT_SYMBOL(bio_clone);
1643 EXPORT_SYMBOL(bio_phys_segments);
1644 EXPORT_SYMBOL(bio_add_page);
1645 EXPORT_SYMBOL(bio_add_pc_page);
1646 EXPORT_SYMBOL(bio_get_nr_vecs);
1647 EXPORT_SYMBOL(bio_map_user);
1648 EXPORT_SYMBOL(bio_unmap_user);
1649 EXPORT_SYMBOL(bio_map_kern);
1650 EXPORT_SYMBOL(bio_copy_kern);
1651 EXPORT_SYMBOL(bio_pair_release);
1652 EXPORT_SYMBOL(bio_split);
1653 EXPORT_SYMBOL(bio_copy_user);
1654 EXPORT_SYMBOL(bio_uncopy_user);
1655 EXPORT_SYMBOL(bioset_create);
1656 EXPORT_SYMBOL(bioset_free);
1657 EXPORT_SYMBOL(bio_alloc_bioset);