blob: 24e4045788e2aed120056c40ac297ed264fd3272 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
3 *
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.
7 *
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.
12 *
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-
16 *
17 */
18#include <linux/mm.h>
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>
James Bottomley f1970ba2005-06-20 14:06:52 +020028#include <scsi/sg.h> /* for struct sg_iovec */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#define BIO_POOL_SIZE 256
31
32static kmem_cache_t *bio_slab;
33
34#define BIOVEC_NR_POOLS 6
35
36/*
37 * a small number of entries is fine, not going to be performance critical.
38 * basically we just need to survive
39 */
40#define BIO_SPLIT_ENTRIES 8
41mempool_t *bio_split_pool;
42
43struct biovec_slab {
44 int nr_vecs;
45 char *name;
46 kmem_cache_t *slab;
47};
48
49/*
50 * if you change this list, also change bvec_alloc or things will
51 * break badly! cannot be bigger than what you can fit into an
52 * unsigned short
53 */
54
55#define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
56static struct biovec_slab bvec_slabs[BIOVEC_NR_POOLS] = {
57 BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
58};
59#undef BV
60
61/*
62 * bio_set is used to allow other portions of the IO system to
63 * allocate their own private memory pools for bio and iovec structures.
64 * These memory pools in turn all allocate from the bio_slab
65 * and the bvec_slabs[].
66 */
67struct bio_set {
68 mempool_t *bio_pool;
69 mempool_t *bvec_pools[BIOVEC_NR_POOLS];
70};
71
72/*
73 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
74 * IO code that does not need private memory pools.
75 */
76static struct bio_set *fs_bio_set;
77
78static inline struct bio_vec *bvec_alloc_bs(unsigned int __nocast gfp_mask, int nr, unsigned long *idx, struct bio_set *bs)
79{
80 struct bio_vec *bvl;
81 struct biovec_slab *bp;
82
83 /*
84 * see comment near bvec_array define!
85 */
86 switch (nr) {
87 case 1 : *idx = 0; break;
88 case 2 ... 4: *idx = 1; break;
89 case 5 ... 16: *idx = 2; break;
90 case 17 ... 64: *idx = 3; break;
91 case 65 ... 128: *idx = 4; break;
92 case 129 ... BIO_MAX_PAGES: *idx = 5; break;
93 default:
94 return NULL;
95 }
96 /*
97 * idx now points to the pool we want to allocate from
98 */
99
100 bp = bvec_slabs + *idx;
101 bvl = mempool_alloc(bs->bvec_pools[*idx], gfp_mask);
102 if (bvl)
103 memset(bvl, 0, bp->nr_vecs * sizeof(struct bio_vec));
104
105 return bvl;
106}
107
108/*
109 * default destructor for a bio allocated with bio_alloc_bioset()
110 */
111static void bio_destructor(struct bio *bio)
112{
113 const int pool_idx = BIO_POOL_IDX(bio);
114 struct bio_set *bs = bio->bi_set;
115
116 BIO_BUG_ON(pool_idx >= BIOVEC_NR_POOLS);
117
118 mempool_free(bio->bi_io_vec, bs->bvec_pools[pool_idx]);
119 mempool_free(bio, bs->bio_pool);
120}
121
122inline void bio_init(struct bio *bio)
123{
124 bio->bi_next = NULL;
125 bio->bi_flags = 1 << BIO_UPTODATE;
126 bio->bi_rw = 0;
127 bio->bi_vcnt = 0;
128 bio->bi_idx = 0;
129 bio->bi_phys_segments = 0;
130 bio->bi_hw_segments = 0;
131 bio->bi_hw_front_size = 0;
132 bio->bi_hw_back_size = 0;
133 bio->bi_size = 0;
134 bio->bi_max_vecs = 0;
135 bio->bi_end_io = NULL;
136 atomic_set(&bio->bi_cnt, 1);
137 bio->bi_private = NULL;
138}
139
140/**
141 * bio_alloc_bioset - allocate a bio for I/O
142 * @gfp_mask: the GFP_ mask given to the slab allocator
143 * @nr_iovecs: number of iovecs to pre-allocate
Martin Waitz67be2dd2005-05-01 08:59:26 -0700144 * @bs: the bio_set to allocate from
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 *
146 * Description:
147 * bio_alloc_bioset will first try it's on mempool to satisfy the allocation.
148 * If %__GFP_WAIT is set then we will block on the internal pool waiting
149 * for a &struct bio to become free.
150 *
151 * allocate bio and iovecs from the memory pools specified by the
152 * bio_set structure.
153 **/
154struct bio *bio_alloc_bioset(unsigned int __nocast gfp_mask, int nr_iovecs, struct bio_set *bs)
155{
156 struct bio *bio = mempool_alloc(bs->bio_pool, gfp_mask);
157
158 if (likely(bio)) {
159 struct bio_vec *bvl = NULL;
160
161 bio_init(bio);
162 if (likely(nr_iovecs)) {
163 unsigned long idx;
164
165 bvl = bvec_alloc_bs(gfp_mask, nr_iovecs, &idx, bs);
166 if (unlikely(!bvl)) {
167 mempool_free(bio, bs->bio_pool);
168 bio = NULL;
169 goto out;
170 }
171 bio->bi_flags |= idx << BIO_POOL_OFFSET;
172 bio->bi_max_vecs = bvec_slabs[idx].nr_vecs;
173 }
174 bio->bi_io_vec = bvl;
175 bio->bi_destructor = bio_destructor;
176 bio->bi_set = bs;
177 }
178out:
179 return bio;
180}
181
182struct bio *bio_alloc(unsigned int __nocast gfp_mask, int nr_iovecs)
183{
184 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
185}
186
187void zero_fill_bio(struct bio *bio)
188{
189 unsigned long flags;
190 struct bio_vec *bv;
191 int i;
192
193 bio_for_each_segment(bv, bio, i) {
194 char *data = bvec_kmap_irq(bv, &flags);
195 memset(data, 0, bv->bv_len);
196 flush_dcache_page(bv->bv_page);
197 bvec_kunmap_irq(data, &flags);
198 }
199}
200EXPORT_SYMBOL(zero_fill_bio);
201
202/**
203 * bio_put - release a reference to a bio
204 * @bio: bio to release reference to
205 *
206 * Description:
207 * Put a reference to a &struct bio, either one you have gotten with
208 * bio_alloc or bio_get. The last put of a bio will free it.
209 **/
210void bio_put(struct bio *bio)
211{
212 BIO_BUG_ON(!atomic_read(&bio->bi_cnt));
213
214 /*
215 * last put frees it
216 */
217 if (atomic_dec_and_test(&bio->bi_cnt)) {
218 bio->bi_next = NULL;
219 bio->bi_destructor(bio);
220 }
221}
222
223inline int bio_phys_segments(request_queue_t *q, struct bio *bio)
224{
225 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
226 blk_recount_segments(q, bio);
227
228 return bio->bi_phys_segments;
229}
230
231inline int bio_hw_segments(request_queue_t *q, struct bio *bio)
232{
233 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
234 blk_recount_segments(q, bio);
235
236 return bio->bi_hw_segments;
237}
238
239/**
240 * __bio_clone - clone a bio
241 * @bio: destination bio
242 * @bio_src: bio to clone
243 *
244 * Clone a &bio. Caller will own the returned bio, but not
245 * the actual data it points to. Reference count of returned
246 * bio will be one.
247 */
248inline void __bio_clone(struct bio *bio, struct bio *bio_src)
249{
250 request_queue_t *q = bdev_get_queue(bio_src->bi_bdev);
251
252 memcpy(bio->bi_io_vec, bio_src->bi_io_vec, bio_src->bi_max_vecs * sizeof(struct bio_vec));
253
254 bio->bi_sector = bio_src->bi_sector;
255 bio->bi_bdev = bio_src->bi_bdev;
256 bio->bi_flags |= 1 << BIO_CLONED;
257 bio->bi_rw = bio_src->bi_rw;
258
259 /*
260 * notes -- maybe just leave bi_idx alone. assume identical mapping
261 * for the clone
262 */
263 bio->bi_vcnt = bio_src->bi_vcnt;
264 bio->bi_size = bio_src->bi_size;
265 bio_phys_segments(q, bio);
266 bio_hw_segments(q, bio);
267}
268
269/**
270 * bio_clone - clone a bio
271 * @bio: bio to clone
272 * @gfp_mask: allocation priority
273 *
274 * Like __bio_clone, only also allocates the returned bio
275 */
276struct bio *bio_clone(struct bio *bio, unsigned int __nocast gfp_mask)
277{
278 struct bio *b = bio_alloc_bioset(gfp_mask, bio->bi_max_vecs, fs_bio_set);
279
280 if (b)
281 __bio_clone(b, bio);
282
283 return b;
284}
285
286/**
287 * bio_get_nr_vecs - return approx number of vecs
288 * @bdev: I/O target
289 *
290 * Return the approximate number of pages we can send to this target.
291 * There's no guarantee that you will be able to fit this number of pages
292 * into a bio, it does not account for dynamic restrictions that vary
293 * on offset.
294 */
295int bio_get_nr_vecs(struct block_device *bdev)
296{
297 request_queue_t *q = bdev_get_queue(bdev);
298 int nr_pages;
299
300 nr_pages = ((q->max_sectors << 9) + PAGE_SIZE - 1) >> PAGE_SHIFT;
301 if (nr_pages > q->max_phys_segments)
302 nr_pages = q->max_phys_segments;
303 if (nr_pages > q->max_hw_segments)
304 nr_pages = q->max_hw_segments;
305
306 return nr_pages;
307}
308
309static int __bio_add_page(request_queue_t *q, struct bio *bio, struct page
310 *page, unsigned int len, unsigned int offset)
311{
312 int retried_segments = 0;
313 struct bio_vec *bvec;
314
315 /*
316 * cloned bio must not modify vec list
317 */
318 if (unlikely(bio_flagged(bio, BIO_CLONED)))
319 return 0;
320
321 if (bio->bi_vcnt >= bio->bi_max_vecs)
322 return 0;
323
324 if (((bio->bi_size + len) >> 9) > q->max_sectors)
325 return 0;
326
327 /*
328 * we might lose a segment or two here, but rather that than
329 * make this too complex.
330 */
331
332 while (bio->bi_phys_segments >= q->max_phys_segments
333 || bio->bi_hw_segments >= q->max_hw_segments
334 || BIOVEC_VIRT_OVERSIZE(bio->bi_size)) {
335
336 if (retried_segments)
337 return 0;
338
339 retried_segments = 1;
340 blk_recount_segments(q, bio);
341 }
342
343 /*
344 * setup the new entry, we might clear it again later if we
345 * cannot add the page
346 */
347 bvec = &bio->bi_io_vec[bio->bi_vcnt];
348 bvec->bv_page = page;
349 bvec->bv_len = len;
350 bvec->bv_offset = offset;
351
352 /*
353 * if queue has other restrictions (eg varying max sector size
354 * depending on offset), it can specify a merge_bvec_fn in the
355 * queue to get further control
356 */
357 if (q->merge_bvec_fn) {
358 /*
359 * merge_bvec_fn() returns number of bytes it can accept
360 * at this offset
361 */
362 if (q->merge_bvec_fn(q, bio, bvec) < len) {
363 bvec->bv_page = NULL;
364 bvec->bv_len = 0;
365 bvec->bv_offset = 0;
366 return 0;
367 }
368 }
369
370 /* If we may be able to merge these biovecs, force a recount */
371 if (bio->bi_vcnt && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec) ||
372 BIOVEC_VIRT_MERGEABLE(bvec-1, bvec)))
373 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
374
375 bio->bi_vcnt++;
376 bio->bi_phys_segments++;
377 bio->bi_hw_segments++;
378 bio->bi_size += len;
379 return len;
380}
381
382/**
383 * bio_add_page - attempt to add page to bio
384 * @bio: destination bio
385 * @page: page to add
386 * @len: vec entry length
387 * @offset: vec entry offset
388 *
389 * Attempt to add a page to the bio_vec maplist. This can fail for a
390 * number of reasons, such as the bio being full or target block
391 * device limitations. The target block device must allow bio's
392 * smaller than PAGE_SIZE, so it is always possible to add a single
393 * page to an empty bio.
394 */
395int bio_add_page(struct bio *bio, struct page *page, unsigned int len,
396 unsigned int offset)
397{
398 return __bio_add_page(bdev_get_queue(bio->bi_bdev), bio, page,
399 len, offset);
400}
401
402struct bio_map_data {
403 struct bio_vec *iovecs;
404 void __user *userptr;
405};
406
407static void bio_set_map_data(struct bio_map_data *bmd, struct bio *bio)
408{
409 memcpy(bmd->iovecs, bio->bi_io_vec, sizeof(struct bio_vec) * bio->bi_vcnt);
410 bio->bi_private = bmd;
411}
412
413static void bio_free_map_data(struct bio_map_data *bmd)
414{
415 kfree(bmd->iovecs);
416 kfree(bmd);
417}
418
419static struct bio_map_data *bio_alloc_map_data(int nr_segs)
420{
421 struct bio_map_data *bmd = kmalloc(sizeof(*bmd), GFP_KERNEL);
422
423 if (!bmd)
424 return NULL;
425
426 bmd->iovecs = kmalloc(sizeof(struct bio_vec) * nr_segs, GFP_KERNEL);
427 if (bmd->iovecs)
428 return bmd;
429
430 kfree(bmd);
431 return NULL;
432}
433
434/**
435 * bio_uncopy_user - finish previously mapped bio
436 * @bio: bio being terminated
437 *
438 * Free pages allocated from bio_copy_user() and write back data
439 * to user space in case of a read.
440 */
441int bio_uncopy_user(struct bio *bio)
442{
443 struct bio_map_data *bmd = bio->bi_private;
444 const int read = bio_data_dir(bio) == READ;
445 struct bio_vec *bvec;
446 int i, ret = 0;
447
448 __bio_for_each_segment(bvec, bio, i, 0) {
449 char *addr = page_address(bvec->bv_page);
450 unsigned int len = bmd->iovecs[i].bv_len;
451
452 if (read && !ret && copy_to_user(bmd->userptr, addr, len))
453 ret = -EFAULT;
454
455 __free_page(bvec->bv_page);
456 bmd->userptr += len;
457 }
458 bio_free_map_data(bmd);
459 bio_put(bio);
460 return ret;
461}
462
463/**
464 * bio_copy_user - copy user data to bio
465 * @q: destination block queue
466 * @uaddr: start of user address
467 * @len: length in bytes
468 * @write_to_vm: bool indicating writing to pages or not
469 *
470 * Prepares and returns a bio for indirect user io, bouncing data
471 * to/from kernel pages as necessary. Must be paired with
472 * call bio_uncopy_user() on io completion.
473 */
474struct bio *bio_copy_user(request_queue_t *q, unsigned long uaddr,
475 unsigned int len, int write_to_vm)
476{
477 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
478 unsigned long start = uaddr >> PAGE_SHIFT;
479 struct bio_map_data *bmd;
480 struct bio_vec *bvec;
481 struct page *page;
482 struct bio *bio;
483 int i, ret;
484
485 bmd = bio_alloc_map_data(end - start);
486 if (!bmd)
487 return ERR_PTR(-ENOMEM);
488
489 bmd->userptr = (void __user *) uaddr;
490
491 ret = -ENOMEM;
492 bio = bio_alloc(GFP_KERNEL, end - start);
493 if (!bio)
494 goto out_bmd;
495
496 bio->bi_rw |= (!write_to_vm << BIO_RW);
497
498 ret = 0;
499 while (len) {
500 unsigned int bytes = PAGE_SIZE;
501
502 if (bytes > len)
503 bytes = len;
504
505 page = alloc_page(q->bounce_gfp | GFP_KERNEL);
506 if (!page) {
507 ret = -ENOMEM;
508 break;
509 }
510
511 if (__bio_add_page(q, bio, page, bytes, 0) < bytes) {
512 ret = -EINVAL;
513 break;
514 }
515
516 len -= bytes;
517 }
518
519 if (ret)
520 goto cleanup;
521
522 /*
523 * success
524 */
525 if (!write_to_vm) {
526 char __user *p = (char __user *) uaddr;
527
528 /*
529 * for a write, copy in data to kernel pages
530 */
531 ret = -EFAULT;
532 bio_for_each_segment(bvec, bio, i) {
533 char *addr = page_address(bvec->bv_page);
534
535 if (copy_from_user(addr, p, bvec->bv_len))
536 goto cleanup;
537 p += bvec->bv_len;
538 }
539 }
540
541 bio_set_map_data(bmd, bio);
542 return bio;
543cleanup:
544 bio_for_each_segment(bvec, bio, i)
545 __free_page(bvec->bv_page);
546
547 bio_put(bio);
548out_bmd:
549 bio_free_map_data(bmd);
550 return ERR_PTR(ret);
551}
552
James Bottomley f1970ba2005-06-20 14:06:52 +0200553static struct bio *__bio_map_user_iov(request_queue_t *q,
554 struct block_device *bdev,
555 struct sg_iovec *iov, int iov_count,
556 int write_to_vm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557{
James Bottomley f1970ba2005-06-20 14:06:52 +0200558 int i, j;
559 int nr_pages = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 struct page **pages;
561 struct bio *bio;
James Bottomley f1970ba2005-06-20 14:06:52 +0200562 int cur_page = 0;
563 int ret, offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
James Bottomley f1970ba2005-06-20 14:06:52 +0200565 for (i = 0; i < iov_count; i++) {
566 unsigned long uaddr = (unsigned long)iov[i].iov_base;
567 unsigned long len = iov[i].iov_len;
568 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
569 unsigned long start = uaddr >> PAGE_SHIFT;
570
571 nr_pages += end - start;
572 /*
573 * transfer and buffer must be aligned to at least hardsector
574 * size for now, in the future we can relax this restriction
575 */
576 if ((uaddr & queue_dma_alignment(q)) || (len & queue_dma_alignment(q)))
577 return ERR_PTR(-EINVAL);
578 }
579
580 if (!nr_pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return ERR_PTR(-EINVAL);
582
583 bio = bio_alloc(GFP_KERNEL, nr_pages);
584 if (!bio)
585 return ERR_PTR(-ENOMEM);
586
587 ret = -ENOMEM;
588 pages = kmalloc(nr_pages * sizeof(struct page *), GFP_KERNEL);
589 if (!pages)
590 goto out;
591
James Bottomley f1970ba2005-06-20 14:06:52 +0200592 memset(pages, 0, nr_pages * sizeof(struct page *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
James Bottomley f1970ba2005-06-20 14:06:52 +0200594 for (i = 0; i < iov_count; i++) {
595 unsigned long uaddr = (unsigned long)iov[i].iov_base;
596 unsigned long len = iov[i].iov_len;
597 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
598 unsigned long start = uaddr >> PAGE_SHIFT;
599 const int local_nr_pages = end - start;
600 const int page_limit = cur_page + local_nr_pages;
601
602 down_read(&current->mm->mmap_sem);
603 ret = get_user_pages(current, current->mm, uaddr,
604 local_nr_pages,
605 write_to_vm, 0, &pages[cur_page], NULL);
606 up_read(&current->mm->mmap_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
James Bottomley f1970ba2005-06-20 14:06:52 +0200608 if (ret < local_nr_pages)
609 goto out_unmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
James Bottomley f1970ba2005-06-20 14:06:52 +0200612 offset = uaddr & ~PAGE_MASK;
613 for (j = cur_page; j < page_limit; j++) {
614 unsigned int bytes = PAGE_SIZE - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
James Bottomley f1970ba2005-06-20 14:06:52 +0200616 if (len <= 0)
617 break;
618
619 if (bytes > len)
620 bytes = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
James Bottomley f1970ba2005-06-20 14:06:52 +0200622 /*
623 * sorry...
624 */
625 if (__bio_add_page(q, bio, pages[j], bytes, offset) < bytes)
626 break;
627
628 len -= bytes;
629 offset = 0;
630 }
631
632 cur_page = j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 /*
James Bottomley f1970ba2005-06-20 14:06:52 +0200634 * release the pages we didn't map into the bio, if any
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
James Bottomley f1970ba2005-06-20 14:06:52 +0200636 while (j < page_limit)
637 page_cache_release(pages[j++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 }
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 kfree(pages);
641
642 /*
643 * set data direction, and check if mapped pages need bouncing
644 */
645 if (!write_to_vm)
646 bio->bi_rw |= (1 << BIO_RW);
647
James Bottomley f1970ba2005-06-20 14:06:52 +0200648 bio->bi_bdev = bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 bio->bi_flags |= (1 << BIO_USER_MAPPED);
650 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +0200651
652 out_unmap:
653 for (i = 0; i < nr_pages; i++) {
654 if(!pages[i])
655 break;
656 page_cache_release(pages[i]);
657 }
658 out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 kfree(pages);
660 bio_put(bio);
661 return ERR_PTR(ret);
662}
663
664/**
665 * bio_map_user - map user address into bio
Martin Waitz67be2dd2005-05-01 08:59:26 -0700666 * @q: the request_queue_t for the bio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 * @bdev: destination block device
668 * @uaddr: start of user address
669 * @len: length in bytes
670 * @write_to_vm: bool indicating writing to pages or not
671 *
672 * Map the user space address into a bio suitable for io to a block
673 * device. Returns an error pointer in case of error.
674 */
675struct bio *bio_map_user(request_queue_t *q, struct block_device *bdev,
676 unsigned long uaddr, unsigned int len, int write_to_vm)
677{
James Bottomley f1970ba2005-06-20 14:06:52 +0200678 struct sg_iovec iov;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
James Bottomley f1970ba2005-06-20 14:06:52 +0200680 iov.iov_base = (__user void *)uaddr;
681 iov.iov_len = len;
682
683 return bio_map_user_iov(q, bdev, &iov, 1, write_to_vm);
684}
685
686/**
687 * bio_map_user_iov - map user sg_iovec table into bio
688 * @q: the request_queue_t for the bio
689 * @bdev: destination block device
690 * @iov: the iovec.
691 * @iov_count: number of elements in the iovec
692 * @write_to_vm: bool indicating writing to pages or not
693 *
694 * Map the user space address into a bio suitable for io to a block
695 * device. Returns an error pointer in case of error.
696 */
697struct bio *bio_map_user_iov(request_queue_t *q, struct block_device *bdev,
698 struct sg_iovec *iov, int iov_count,
699 int write_to_vm)
700{
701 struct bio *bio;
702 int len = 0, i;
703
704 bio = __bio_map_user_iov(q, bdev, iov, iov_count, write_to_vm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706 if (IS_ERR(bio))
707 return bio;
708
709 /*
710 * subtle -- if __bio_map_user() ended up bouncing a bio,
711 * it would normally disappear when its bi_end_io is run.
712 * however, we need it for the unmap, so grab an extra
713 * reference to it
714 */
715 bio_get(bio);
716
James Bottomley f1970ba2005-06-20 14:06:52 +0200717 for (i = 0; i < iov_count; i++)
718 len += iov[i].iov_len;
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 if (bio->bi_size == len)
721 return bio;
722
723 /*
724 * don't support partial mappings
725 */
726 bio_endio(bio, bio->bi_size, 0);
727 bio_unmap_user(bio);
728 return ERR_PTR(-EINVAL);
729}
730
731static void __bio_unmap_user(struct bio *bio)
732{
733 struct bio_vec *bvec;
734 int i;
735
736 /*
737 * make sure we dirty pages we wrote to
738 */
739 __bio_for_each_segment(bvec, bio, i, 0) {
740 if (bio_data_dir(bio) == READ)
741 set_page_dirty_lock(bvec->bv_page);
742
743 page_cache_release(bvec->bv_page);
744 }
745
746 bio_put(bio);
747}
748
749/**
750 * bio_unmap_user - unmap a bio
751 * @bio: the bio being unmapped
752 *
753 * Unmap a bio previously mapped by bio_map_user(). Must be called with
754 * a process context.
755 *
756 * bio_unmap_user() may sleep.
757 */
758void bio_unmap_user(struct bio *bio)
759{
760 __bio_unmap_user(bio);
761 bio_put(bio);
762}
763
Jens Axboeb8238252005-06-20 14:05:27 +0200764static int bio_map_kern_endio(struct bio *bio, unsigned int bytes_done, int err)
765{
766 if (bio->bi_size)
767 return 1;
768
769 bio_put(bio);
770 return 0;
771}
772
773
Mike Christie df46b9a2005-06-20 14:04:44 +0200774static struct bio *__bio_map_kern(request_queue_t *q, void *data,
775 unsigned int len, unsigned int gfp_mask)
776{
777 unsigned long kaddr = (unsigned long)data;
778 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
779 unsigned long start = kaddr >> PAGE_SHIFT;
780 const int nr_pages = end - start;
781 int offset, i;
782 struct bio *bio;
783
784 bio = bio_alloc(gfp_mask, nr_pages);
785 if (!bio)
786 return ERR_PTR(-ENOMEM);
787
788 offset = offset_in_page(kaddr);
789 for (i = 0; i < nr_pages; i++) {
790 unsigned int bytes = PAGE_SIZE - offset;
791
792 if (len <= 0)
793 break;
794
795 if (bytes > len)
796 bytes = len;
797
798 if (__bio_add_page(q, bio, virt_to_page(data), bytes,
799 offset) < bytes)
800 break;
801
802 data += bytes;
803 len -= bytes;
804 offset = 0;
805 }
806
Jens Axboeb8238252005-06-20 14:05:27 +0200807 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +0200808 return bio;
809}
810
811/**
812 * bio_map_kern - map kernel address into bio
813 * @q: the request_queue_t for the bio
814 * @data: pointer to buffer to map
815 * @len: length in bytes
816 * @gfp_mask: allocation flags for bio allocation
817 *
818 * Map the kernel address into a bio suitable for io to a block
819 * device. Returns an error pointer in case of error.
820 */
821struct bio *bio_map_kern(request_queue_t *q, void *data, unsigned int len,
822 unsigned int gfp_mask)
823{
824 struct bio *bio;
825
826 bio = __bio_map_kern(q, data, len, gfp_mask);
827 if (IS_ERR(bio))
828 return bio;
829
830 if (bio->bi_size == len)
831 return bio;
832
833 /*
834 * Don't support partial mappings.
835 */
836 bio_put(bio);
837 return ERR_PTR(-EINVAL);
838}
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840/*
841 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
842 * for performing direct-IO in BIOs.
843 *
844 * The problem is that we cannot run set_page_dirty() from interrupt context
845 * because the required locks are not interrupt-safe. So what we can do is to
846 * mark the pages dirty _before_ performing IO. And in interrupt context,
847 * check that the pages are still dirty. If so, fine. If not, redirty them
848 * in process context.
849 *
850 * We special-case compound pages here: normally this means reads into hugetlb
851 * pages. The logic in here doesn't really work right for compound pages
852 * because the VM does not uniformly chase down the head page in all cases.
853 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
854 * handle them at all. So we skip compound pages here at an early stage.
855 *
856 * Note that this code is very hard to test under normal circumstances because
857 * direct-io pins the pages with get_user_pages(). This makes
858 * is_page_cache_freeable return false, and the VM will not clean the pages.
859 * But other code (eg, pdflush) could clean the pages if they are mapped
860 * pagecache.
861 *
862 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
863 * deferred bio dirtying paths.
864 */
865
866/*
867 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
868 */
869void bio_set_pages_dirty(struct bio *bio)
870{
871 struct bio_vec *bvec = bio->bi_io_vec;
872 int i;
873
874 for (i = 0; i < bio->bi_vcnt; i++) {
875 struct page *page = bvec[i].bv_page;
876
877 if (page && !PageCompound(page))
878 set_page_dirty_lock(page);
879 }
880}
881
882static void bio_release_pages(struct bio *bio)
883{
884 struct bio_vec *bvec = bio->bi_io_vec;
885 int i;
886
887 for (i = 0; i < bio->bi_vcnt; i++) {
888 struct page *page = bvec[i].bv_page;
889
890 if (page)
891 put_page(page);
892 }
893}
894
895/*
896 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
897 * If they are, then fine. If, however, some pages are clean then they must
898 * have been written out during the direct-IO read. So we take another ref on
899 * the BIO and the offending pages and re-dirty the pages in process context.
900 *
901 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
902 * here on. It will run one page_cache_release() against each page and will
903 * run one bio_put() against the BIO.
904 */
905
906static void bio_dirty_fn(void *data);
907
908static DECLARE_WORK(bio_dirty_work, bio_dirty_fn, NULL);
909static DEFINE_SPINLOCK(bio_dirty_lock);
910static struct bio *bio_dirty_list;
911
912/*
913 * This runs in process context
914 */
915static void bio_dirty_fn(void *data)
916{
917 unsigned long flags;
918 struct bio *bio;
919
920 spin_lock_irqsave(&bio_dirty_lock, flags);
921 bio = bio_dirty_list;
922 bio_dirty_list = NULL;
923 spin_unlock_irqrestore(&bio_dirty_lock, flags);
924
925 while (bio) {
926 struct bio *next = bio->bi_private;
927
928 bio_set_pages_dirty(bio);
929 bio_release_pages(bio);
930 bio_put(bio);
931 bio = next;
932 }
933}
934
935void bio_check_pages_dirty(struct bio *bio)
936{
937 struct bio_vec *bvec = bio->bi_io_vec;
938 int nr_clean_pages = 0;
939 int i;
940
941 for (i = 0; i < bio->bi_vcnt; i++) {
942 struct page *page = bvec[i].bv_page;
943
944 if (PageDirty(page) || PageCompound(page)) {
945 page_cache_release(page);
946 bvec[i].bv_page = NULL;
947 } else {
948 nr_clean_pages++;
949 }
950 }
951
952 if (nr_clean_pages) {
953 unsigned long flags;
954
955 spin_lock_irqsave(&bio_dirty_lock, flags);
956 bio->bi_private = bio_dirty_list;
957 bio_dirty_list = bio;
958 spin_unlock_irqrestore(&bio_dirty_lock, flags);
959 schedule_work(&bio_dirty_work);
960 } else {
961 bio_put(bio);
962 }
963}
964
965/**
966 * bio_endio - end I/O on a bio
967 * @bio: bio
968 * @bytes_done: number of bytes completed
969 * @error: error, if any
970 *
971 * Description:
972 * bio_endio() will end I/O on @bytes_done number of bytes. This may be
973 * just a partial part of the bio, or it may be the whole bio. bio_endio()
974 * is the preferred way to end I/O on a bio, it takes care of decrementing
975 * bi_size and clearing BIO_UPTODATE on error. @error is 0 on success, and
976 * and one of the established -Exxxx (-EIO, for instance) error values in
977 * case something went wrong. Noone should call bi_end_io() directly on
978 * a bio unless they own it and thus know that it has an end_io function.
979 **/
980void bio_endio(struct bio *bio, unsigned int bytes_done, int error)
981{
982 if (error)
983 clear_bit(BIO_UPTODATE, &bio->bi_flags);
984
985 if (unlikely(bytes_done > bio->bi_size)) {
986 printk("%s: want %u bytes done, only %u left\n", __FUNCTION__,
987 bytes_done, bio->bi_size);
988 bytes_done = bio->bi_size;
989 }
990
991 bio->bi_size -= bytes_done;
992 bio->bi_sector += (bytes_done >> 9);
993
994 if (bio->bi_end_io)
995 bio->bi_end_io(bio, bytes_done, error);
996}
997
998void bio_pair_release(struct bio_pair *bp)
999{
1000 if (atomic_dec_and_test(&bp->cnt)) {
1001 struct bio *master = bp->bio1.bi_private;
1002
1003 bio_endio(master, master->bi_size, bp->error);
1004 mempool_free(bp, bp->bio2.bi_private);
1005 }
1006}
1007
1008static int bio_pair_end_1(struct bio * bi, unsigned int done, int err)
1009{
1010 struct bio_pair *bp = container_of(bi, struct bio_pair, bio1);
1011
1012 if (err)
1013 bp->error = err;
1014
1015 if (bi->bi_size)
1016 return 1;
1017
1018 bio_pair_release(bp);
1019 return 0;
1020}
1021
1022static int bio_pair_end_2(struct bio * bi, unsigned int done, int err)
1023{
1024 struct bio_pair *bp = container_of(bi, struct bio_pair, bio2);
1025
1026 if (err)
1027 bp->error = err;
1028
1029 if (bi->bi_size)
1030 return 1;
1031
1032 bio_pair_release(bp);
1033 return 0;
1034}
1035
1036/*
1037 * split a bio - only worry about a bio with a single page
1038 * in it's iovec
1039 */
1040struct bio_pair *bio_split(struct bio *bi, mempool_t *pool, int first_sectors)
1041{
1042 struct bio_pair *bp = mempool_alloc(pool, GFP_NOIO);
1043
1044 if (!bp)
1045 return bp;
1046
1047 BUG_ON(bi->bi_vcnt != 1);
1048 BUG_ON(bi->bi_idx != 0);
1049 atomic_set(&bp->cnt, 3);
1050 bp->error = 0;
1051 bp->bio1 = *bi;
1052 bp->bio2 = *bi;
1053 bp->bio2.bi_sector += first_sectors;
1054 bp->bio2.bi_size -= first_sectors << 9;
1055 bp->bio1.bi_size = first_sectors << 9;
1056
1057 bp->bv1 = bi->bi_io_vec[0];
1058 bp->bv2 = bi->bi_io_vec[0];
1059 bp->bv2.bv_offset += first_sectors << 9;
1060 bp->bv2.bv_len -= first_sectors << 9;
1061 bp->bv1.bv_len = first_sectors << 9;
1062
1063 bp->bio1.bi_io_vec = &bp->bv1;
1064 bp->bio2.bi_io_vec = &bp->bv2;
1065
1066 bp->bio1.bi_end_io = bio_pair_end_1;
1067 bp->bio2.bi_end_io = bio_pair_end_2;
1068
1069 bp->bio1.bi_private = bi;
1070 bp->bio2.bi_private = pool;
1071
1072 return bp;
1073}
1074
1075static void *bio_pair_alloc(unsigned int __nocast gfp_flags, void *data)
1076{
1077 return kmalloc(sizeof(struct bio_pair), gfp_flags);
1078}
1079
1080static void bio_pair_free(void *bp, void *data)
1081{
1082 kfree(bp);
1083}
1084
1085
1086/*
1087 * create memory pools for biovec's in a bio_set.
1088 * use the global biovec slabs created for general use.
1089 */
1090static int biovec_create_pools(struct bio_set *bs, int pool_entries, int scale)
1091{
1092 int i;
1093
1094 for (i = 0; i < BIOVEC_NR_POOLS; i++) {
1095 struct biovec_slab *bp = bvec_slabs + i;
1096 mempool_t **bvp = bs->bvec_pools + i;
1097
1098 if (i >= scale)
1099 pool_entries >>= 1;
1100
1101 *bvp = mempool_create(pool_entries, mempool_alloc_slab,
1102 mempool_free_slab, bp->slab);
1103 if (!*bvp)
1104 return -ENOMEM;
1105 }
1106 return 0;
1107}
1108
1109static void biovec_free_pools(struct bio_set *bs)
1110{
1111 int i;
1112
1113 for (i = 0; i < BIOVEC_NR_POOLS; i++) {
1114 mempool_t *bvp = bs->bvec_pools[i];
1115
1116 if (bvp)
1117 mempool_destroy(bvp);
1118 }
1119
1120}
1121
1122void bioset_free(struct bio_set *bs)
1123{
1124 if (bs->bio_pool)
1125 mempool_destroy(bs->bio_pool);
1126
1127 biovec_free_pools(bs);
1128
1129 kfree(bs);
1130}
1131
1132struct bio_set *bioset_create(int bio_pool_size, int bvec_pool_size, int scale)
1133{
1134 struct bio_set *bs = kmalloc(sizeof(*bs), GFP_KERNEL);
1135
1136 if (!bs)
1137 return NULL;
1138
1139 memset(bs, 0, sizeof(*bs));
1140 bs->bio_pool = mempool_create(bio_pool_size, mempool_alloc_slab,
1141 mempool_free_slab, bio_slab);
1142
1143 if (!bs->bio_pool)
1144 goto bad;
1145
1146 if (!biovec_create_pools(bs, bvec_pool_size, scale))
1147 return bs;
1148
1149bad:
1150 bioset_free(bs);
1151 return NULL;
1152}
1153
1154static void __init biovec_init_slabs(void)
1155{
1156 int i;
1157
1158 for (i = 0; i < BIOVEC_NR_POOLS; i++) {
1159 int size;
1160 struct biovec_slab *bvs = bvec_slabs + i;
1161
1162 size = bvs->nr_vecs * sizeof(struct bio_vec);
1163 bvs->slab = kmem_cache_create(bvs->name, size, 0,
1164 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
1165 }
1166}
1167
1168static int __init init_bio(void)
1169{
1170 int megabytes, bvec_pool_entries;
1171 int scale = BIOVEC_NR_POOLS;
1172
1173 bio_slab = kmem_cache_create("bio", sizeof(struct bio), 0,
1174 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
1175
1176 biovec_init_slabs();
1177
1178 megabytes = nr_free_pages() >> (20 - PAGE_SHIFT);
1179
1180 /*
1181 * find out where to start scaling
1182 */
1183 if (megabytes <= 16)
1184 scale = 0;
1185 else if (megabytes <= 32)
1186 scale = 1;
1187 else if (megabytes <= 64)
1188 scale = 2;
1189 else if (megabytes <= 96)
1190 scale = 3;
1191 else if (megabytes <= 128)
1192 scale = 4;
1193
1194 /*
1195 * scale number of entries
1196 */
1197 bvec_pool_entries = megabytes * 2;
1198 if (bvec_pool_entries > 256)
1199 bvec_pool_entries = 256;
1200
1201 fs_bio_set = bioset_create(BIO_POOL_SIZE, bvec_pool_entries, scale);
1202 if (!fs_bio_set)
1203 panic("bio: can't allocate bios\n");
1204
1205 bio_split_pool = mempool_create(BIO_SPLIT_ENTRIES,
1206 bio_pair_alloc, bio_pair_free, NULL);
1207 if (!bio_split_pool)
1208 panic("bio: can't create split pool\n");
1209
1210 return 0;
1211}
1212
1213subsys_initcall(init_bio);
1214
1215EXPORT_SYMBOL(bio_alloc);
1216EXPORT_SYMBOL(bio_put);
1217EXPORT_SYMBOL(bio_endio);
1218EXPORT_SYMBOL(bio_init);
1219EXPORT_SYMBOL(__bio_clone);
1220EXPORT_SYMBOL(bio_clone);
1221EXPORT_SYMBOL(bio_phys_segments);
1222EXPORT_SYMBOL(bio_hw_segments);
1223EXPORT_SYMBOL(bio_add_page);
1224EXPORT_SYMBOL(bio_get_nr_vecs);
1225EXPORT_SYMBOL(bio_map_user);
1226EXPORT_SYMBOL(bio_unmap_user);
Mike Christie df46b9a2005-06-20 14:04:44 +02001227EXPORT_SYMBOL(bio_map_kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228EXPORT_SYMBOL(bio_pair_release);
1229EXPORT_SYMBOL(bio_split);
1230EXPORT_SYMBOL(bio_split_pool);
1231EXPORT_SYMBOL(bio_copy_user);
1232EXPORT_SYMBOL(bio_uncopy_user);
1233EXPORT_SYMBOL(bioset_create);
1234EXPORT_SYMBOL(bioset_free);
1235EXPORT_SYMBOL(bio_alloc_bioset);