fs/bio.c

   1 /*
   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>
  28
  29 #define BIO_POOL_SIZE 256
  30
  31 static mempool_t *bio_pool;
  32 static 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
  41 mempool_t *bio_split_pool;
  42
  43 struct biovec_pool {
  44         int nr_vecs;
  45         char *name;
  46         kmem_cache_t *slab;
  47         mempool_t *pool;
  48 };
  49
  50 /*
  51  * if you change this list, also change bvec_alloc or things will
  52  * break badly! cannot be bigger than what you can fit into an
  53  * unsigned short
  54  */
  55
  56 #define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
  57 static struct biovec_pool bvec_array[BIOVEC_NR_POOLS] = {
  58         BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
  59 };
  60 #undef BV
  61
  62 static inline struct bio_vec *bvec_alloc(int gfp_mask, int nr, unsigned long *idx)
  63 {
  64         struct biovec_pool *bp;
  65         struct bio_vec *bvl;
  66
  67         /*
  68          * see comment near bvec_array define!
  69          */
  70         switch (nr) {
  71                 case   1        : *idx = 0; break;
  72                 case   2 ...   4: *idx = 1; break;
  73                 case   5 ...  16: *idx = 2; break;
  74                 case  17 ...  64: *idx = 3; break;
  75                 case  65 ... 128: *idx = 4; break;
  76                 case 129 ... BIO_MAX_PAGES: *idx = 5; break;
  77                 default:
  78                         return NULL;
  79         }
  80         /*
  81          * idx now points to the pool we want to allocate from
  82          */
  83         bp = bvec_array + *idx;
  84
  85         bvl = mempool_alloc(bp->pool, gfp_mask);
  86         if (bvl)
  87                 memset(bvl, 0, bp->nr_vecs * sizeof(struct bio_vec));
  88         return bvl;
  89 }
  90
  91 /*
  92  * default destructor for a bio allocated with bio_alloc()
  93  */
  94 void bio_destructor(struct bio *bio)
  95 {
  96         const int pool_idx = BIO_POOL_IDX(bio);
  97         struct biovec_pool *bp = bvec_array + pool_idx;
  98
  99         BIO_BUG_ON(pool_idx >= BIOVEC_NR_POOLS);
 100
 101         /*
 102          * cloned bio doesn't own the veclist
 103          */
 104         if (!bio_flagged(bio, BIO_CLONED))
 105                 mempool_free(bio->bi_io_vec, bp->pool);
 106
 107         mempool_free(bio, bio_pool);
 108 }
 109
 110 inline void bio_init(struct bio *bio)
 111 {
 112         bio->bi_next = NULL;
 113         bio->bi_flags = 1 << BIO_UPTODATE;
 114         bio->bi_rw = 0;
 115         bio->bi_vcnt = 0;
 116         bio->bi_idx = 0;
 117         bio->bi_phys_segments = 0;
 118         bio->bi_hw_segments = 0;
 119         bio->bi_hw_front_size = 0;
 120         bio->bi_hw_back_size = 0;
 121         bio->bi_size = 0;
 122         bio->bi_max_vecs = 0;
 123         bio->bi_end_io = NULL;
 124         atomic_set(&bio->bi_cnt, 1);
 125         bio->bi_private = NULL;
 126 }
 127
 128 /**
 129  * bio_alloc - allocate a bio for I/O
 130  * @gfp_mask:   the GFP_ mask given to the slab allocator
 131  * @nr_iovecs:  number of iovecs to pre-allocate
 132  *
 133  * Description:
 134  *   bio_alloc will first try it's on mempool to satisfy the allocation.
 135  *   If %__GFP_WAIT is set then we will block on the internal pool waiting
 136  *   for a &struct bio to become free.
 137  **/
 138 struct bio *bio_alloc(int gfp_mask, int nr_iovecs)
 139 {
 140         struct bio *bio = mempool_alloc(bio_pool, gfp_mask);
 141
 142         if (likely(bio)) {
 143                 struct bio_vec *bvl = NULL;
 144
 145                 bio_init(bio);
 146                 if (likely(nr_iovecs)) {
 147                         unsigned long idx;
 148
 149                         bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx);
 150                         if (unlikely(!bvl)) {
 151                                 mempool_free(bio, bio_pool);
 152                                 bio = NULL;
 153                                 goto out;
 154                         }
 155                         bio->bi_flags |= idx << BIO_POOL_OFFSET;
 156                         bio->bi_max_vecs = bvec_array[idx].nr_vecs;
 157                 }
 158                 bio->bi_io_vec = bvl;
 159                 bio->bi_destructor = bio_destructor;
 160         }
 161 out:
 162         return bio;
 163 }
 164
 165 /**
 166  * bio_put - release a reference to a bio
 167  * @bio:   bio to release reference to
 168  *
 169  * Description:
 170  *   Put a reference to a &struct bio, either one you have gotten with
 171  *   bio_alloc or bio_get. The last put of a bio will free it.
 172  **/
 173 void bio_put(struct bio *bio)
 174 {
 175         BIO_BUG_ON(!atomic_read(&bio->bi_cnt));
 176
 177         /*
 178          * last put frees it
 179          */
 180         if (atomic_dec_and_test(&bio->bi_cnt)) {
 181                 bio->bi_next = NULL;
 182                 bio->bi_destructor(bio);
 183         }
 184 }
 185
 186 inline int bio_phys_segments(request_queue_t *q, struct bio *bio)
 187 {
 188         if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
 189                 blk_recount_segments(q, bio);
 190
 191         return bio->bi_phys_segments;
 192 }
 193
 194 inline int bio_hw_segments(request_queue_t *q, struct bio *bio)
 195 {
 196         if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
 197                 blk_recount_segments(q, bio);
 198
 199         return bio->bi_hw_segments;
 200 }
 201
 202 /**
 203  *      __bio_clone     -       clone a bio
 204  *      @bio: destination bio
 205  *      @bio_src: bio to clone
 206  *
 207  *      Clone a &bio. Caller will own the returned bio, but not
 208  *      the actual data it points to. Reference count of returned
 209  *      bio will be one.
 210  */
 211 inline void __bio_clone(struct bio *bio, struct bio *bio_src)
 212 {
 213         bio->bi_io_vec = bio_src->bi_io_vec;
 214
 215         bio->bi_sector = bio_src->bi_sector;
 216         bio->bi_bdev = bio_src->bi_bdev;
 217         bio->bi_flags |= 1 << BIO_CLONED;
 218         bio->bi_rw = bio_src->bi_rw;
 219
 220         /*
 221          * notes -- maybe just leave bi_idx alone. assume identical mapping
 222          * for the clone
 223          */
 224         bio->bi_vcnt = bio_src->bi_vcnt;
 225         bio->bi_idx = bio_src->bi_idx;
 226         if (bio_flagged(bio, BIO_SEG_VALID)) {
 227                 bio->bi_phys_segments = bio_src->bi_phys_segments;
 228                 bio->bi_hw_segments = bio_src->bi_hw_segments;
 229                 bio->bi_flags |= (1 << BIO_SEG_VALID);
 230         }
 231         bio->bi_size = bio_src->bi_size;
 232
 233         /*
 234          * cloned bio does not own the bio_vec, so users cannot fiddle with
 235          * it. clear bi_max_vecs and clear the BIO_POOL_BITS to make this
 236          * apparent
 237          */
 238         bio->bi_max_vecs = 0;
 239         bio->bi_flags &= (BIO_POOL_MASK - 1);
 240 }
 241
 242 /**
 243  *      bio_clone       -       clone a bio
 244  *      @bio: bio to clone
 245  *      @gfp_mask: allocation priority
 246  *
 247  *      Like __bio_clone, only also allocates the returned bio
 248  */
 249 struct bio *bio_clone(struct bio *bio, int gfp_mask)
 250 {
 251         struct bio *b = bio_alloc(gfp_mask, 0);
 252
 253         if (b)
 254                 __bio_clone(b, bio);
 255
 256         return b;
 257 }
 258
 259 /**
 260  *      bio_get_nr_vecs         - return approx number of vecs
 261  *      @bdev:  I/O target
 262  *
 263  *      Return the approximate number of pages we can send to this target.
 264  *      There's no guarantee that you will be able to fit this number of pages
 265  *      into a bio, it does not account for dynamic restrictions that vary
 266  *      on offset.
 267  */
 268 int bio_get_nr_vecs(struct block_device *bdev)
 269 {
 270         request_queue_t *q = bdev_get_queue(bdev);
 271         int nr_pages;
 272
 273         nr_pages = ((q->max_sectors << 9) + PAGE_SIZE - 1) >> PAGE_SHIFT;
 274         if (nr_pages > q->max_phys_segments)
 275                 nr_pages = q->max_phys_segments;
 276         if (nr_pages > q->max_hw_segments)
 277                 nr_pages = q->max_hw_segments;
 278
 279         return nr_pages;
 280 }
 281
 282 static int __bio_add_page(request_queue_t *q, struct bio *bio, struct page
 283                           *page, unsigned int len, unsigned int offset)
 284 {
 285         int retried_segments = 0;
 286         struct bio_vec *bvec;
 287
 288         /*
 289          * cloned bio must not modify vec list
 290          */
 291         if (unlikely(bio_flagged(bio, BIO_CLONED)))
 292                 return 0;
 293
 294         if (bio->bi_vcnt >= bio->bi_max_vecs)
 295                 return 0;
 296
 297         if (((bio->bi_size + len) >> 9) > q->max_sectors)
 298                 return 0;
 299
 300         /*
 301          * we might lose a segment or two here, but rather that than
 302          * make this too complex.
 303          */
 304
 305         while (bio->bi_phys_segments >= q->max_phys_segments
 306                || bio->bi_hw_segments >= q->max_hw_segments
 307                || BIOVEC_VIRT_OVERSIZE(bio->bi_size)) {
 308
 309                 if (retried_segments)
 310                         return 0;
 311
 312                 retried_segments = 1;
 313                 blk_recount_segments(q, bio);
 314         }
 315
 316         /*
 317          * setup the new entry, we might clear it again later if we
 318          * cannot add the page
 319          */
 320         bvec = &bio->bi_io_vec[bio->bi_vcnt];
 321         bvec->bv_page = page;
 322         bvec->bv_len = len;
 323         bvec->bv_offset = offset;
 324
 325         /*
 326          * if queue has other restrictions (eg varying max sector size
 327          * depending on offset), it can specify a merge_bvec_fn in the
 328          * queue to get further control
 329          */
 330         if (q->merge_bvec_fn) {
 331                 /*
 332                  * merge_bvec_fn() returns number of bytes it can accept
 333                  * at this offset
 334                  */
 335                 if (q->merge_bvec_fn(q, bio, bvec) < len) {
 336                         bvec->bv_page = NULL;
 337                         bvec->bv_len = 0;
 338                         bvec->bv_offset = 0;
 339                         return 0;
 340                 }
 341         }
 342
 343         /* If we may be able to merge these biovecs, force a recount */
 344         if (bio->bi_vcnt && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec) ||
 345             BIOVEC_VIRT_MERGEABLE(bvec-1, bvec)))
 346                 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
 347
 348         bio->bi_vcnt++;
 349         bio->bi_phys_segments++;
 350         bio->bi_hw_segments++;
 351         bio->bi_size += len;
 352         return len;
 353 }
 354
 355 /**
 356  *      bio_add_page    -       attempt to add page to bio
 357  *      @bio: destination bio
 358  *      @page: page to add
 359  *      @len: vec entry length
 360  *      @offset: vec entry offset
 361  *
 362  *      Attempt to add a page to the bio_vec maplist. This can fail for a
 363  *      number of reasons, such as the bio being full or target block
 364  *      device limitations. The target block device must allow bio's
 365  *      smaller than PAGE_SIZE, so it is always possible to add a single
 366  *      page to an empty bio.
 367  */
 368 int bio_add_page(struct bio *bio, struct page *page, unsigned int len,
 369                  unsigned int offset)
 370 {
 371         return __bio_add_page(bdev_get_queue(bio->bi_bdev), bio, page,
 372                               len, offset);
 373 }
 374
 375 struct bio_map_data {
 376         struct bio_vec *iovecs;
 377         void __user *userptr;
 378 };
 379
 380 static void bio_set_map_data(struct bio_map_data *bmd, struct bio *bio)
 381 {
 382         memcpy(bmd->iovecs, bio->bi_io_vec, sizeof(struct bio_vec) * bio->bi_vcnt);
 383         bio->bi_private = bmd;
 384 }
 385
 386 static void bio_free_map_data(struct bio_map_data *bmd)
 387 {
 388         kfree(bmd->iovecs);
 389         kfree(bmd);
 390 }
 391
 392 static struct bio_map_data *bio_alloc_map_data(int nr_segs)
 393 {
 394         struct bio_map_data *bmd = kmalloc(sizeof(*bmd), GFP_KERNEL);
 395
 396         if (!bmd)
 397                 return NULL;
 398
 399         bmd->iovecs = kmalloc(sizeof(struct bio_vec) * nr_segs, GFP_KERNEL);
 400         if (bmd->iovecs)
 401                 return bmd;
 402
 403         kfree(bmd);
 404         return NULL;
 405 }
 406
 407 /**
 408  *      bio_uncopy_user -       finish previously mapped bio
 409  *      @bio: bio being terminated
 410  *
 411  *      Free pages allocated from bio_copy_user() and write back data
 412  *      to user space in case of a read.
 413  */
 414 int bio_uncopy_user(struct bio *bio)
 415 {
 416         struct bio_map_data *bmd = bio->bi_private;
 417         const int read = bio_data_dir(bio) == READ;
 418         struct bio_vec *bvec;
 419         int i, ret = 0;
 420
 421         __bio_for_each_segment(bvec, bio, i, 0) {
 422                 char *addr = page_address(bvec->bv_page);
 423                 unsigned int len = bmd->iovecs[i].bv_len;
 424
 425                 if (read && !ret && copy_to_user(bmd->userptr, addr, len))
 426                         ret = -EFAULT;
 427
 428                 __free_page(bvec->bv_page);
 429                 bmd->userptr += len;
 430         }
 431         bio_free_map_data(bmd);
 432         bio_put(bio);
 433         return ret;
 434 }
 435
 436 /**
 437  *      bio_copy_user   -       copy user data to bio
 438  *      @q: destination block queue
 439  *      @uaddr: start of user address
 440  *      @len: length in bytes
 441  *      @write_to_vm: bool indicating writing to pages or not
 442  *
 443  *      Prepares and returns a bio for indirect user io, bouncing data
 444  *      to/from kernel pages as necessary. Must be paired with
 445  *      call bio_uncopy_user() on io completion.
 446  */
 447 struct bio *bio_copy_user(request_queue_t *q, unsigned long uaddr,
 448                           unsigned int len, int write_to_vm)
 449 {
 450         unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
 451         unsigned long start = uaddr >> PAGE_SHIFT;
 452         struct bio_map_data *bmd;
 453         struct bio_vec *bvec;
 454         struct page *page;
 455         struct bio *bio;
 456         int i, ret;
 457
 458         bmd = bio_alloc_map_data(end - start);
 459         if (!bmd)
 460                 return ERR_PTR(-ENOMEM);
 461
 462         bmd->userptr = (void __user *) uaddr;
 463
 464         ret = -ENOMEM;
 465         bio = bio_alloc(GFP_KERNEL, end - start);
 466         if (!bio)
 467                 goto out_bmd;
 468
 469         bio->bi_rw |= (!write_to_vm << BIO_RW);
 470
 471         ret = 0;
 472         while (len) {
 473                 unsigned int bytes = PAGE_SIZE;
 474
 475                 if (bytes > len)
 476                         bytes = len;
 477
 478                 page = alloc_page(q->bounce_gfp | GFP_KERNEL);
 479                 if (!page) {
 480                         ret = -ENOMEM;
 481                         break;
 482                 }
 483
 484                 if (__bio_add_page(q, bio, page, bytes, 0) < bytes) {
 485                         ret = -EINVAL;
 486                         break;
 487                 }
 488
 489                 len -= bytes;
 490         }
 491
 492         if (ret)
 493                 goto cleanup;
 494
 495         /*
 496          * success
 497          */
 498         if (!write_to_vm) {
 499                 char __user *p = (char __user *) uaddr;
 500
 501                 /*
 502                  * for a write, copy in data to kernel pages
 503                  */
 504                 ret = -EFAULT;
 505                 bio_for_each_segment(bvec, bio, i) {
 506                         char *addr = page_address(bvec->bv_page);
 507
 508                         if (copy_from_user(addr, p, bvec->bv_len))
 509                                 goto cleanup;
 510                         p += bvec->bv_len;
 511                 }
 512         }
 513
 514         bio_set_map_data(bmd, bio);
 515         return bio;
 516 cleanup:
 517         bio_for_each_segment(bvec, bio, i)
 518                 __free_page(bvec->bv_page);
 519
 520         bio_put(bio);
 521 out_bmd:
 522         bio_free_map_data(bmd);
 523         return ERR_PTR(ret);
 524 }
 525
 526 static struct bio *__bio_map_user(request_queue_t *q, struct block_device *bdev,
 527                                   unsigned long uaddr, unsigned int len,
 528                                   int write_to_vm)
 529 {
 530         unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
 531         unsigned long start = uaddr >> PAGE_SHIFT;
 532         const int nr_pages = end - start;
 533         int ret, offset, i;
 534         struct page **pages;
 535         struct bio *bio;
 536
 537         /*
 538          * transfer and buffer must be aligned to at least hardsector
 539          * size for now, in the future we can relax this restriction
 540          */
 541         if ((uaddr & queue_dma_alignment(q)) || (len & queue_dma_alignment(q)))
 542                 return ERR_PTR(-EINVAL);
 543
 544         bio = bio_alloc(GFP_KERNEL, nr_pages);
 545         if (!bio)
 546                 return ERR_PTR(-ENOMEM);
 547
 548         ret = -ENOMEM;
 549         pages = kmalloc(nr_pages * sizeof(struct page *), GFP_KERNEL);
 550         if (!pages)
 551                 goto out;
 552
 553         down_read(&current->mm->mmap_sem);
 554         ret = get_user_pages(current, current->mm, uaddr, nr_pages,
 555                                                 write_to_vm, 0, pages, NULL);
 556         up_read(&current->mm->mmap_sem);
 557
 558         if (ret < nr_pages)
 559                 goto out;
 560
 561         bio->bi_bdev = bdev;
 562
 563         offset = uaddr & ~PAGE_MASK;
 564         for (i = 0; i < nr_pages; i++) {
 565                 unsigned int bytes = PAGE_SIZE - offset;
 566
 567                 if (len <= 0)
 568                         break;
 569
 570                 if (bytes > len)
 571                         bytes = len;
 572
 573                 /*
 574                  * sorry...
 575                  */
 576                 if (__bio_add_page(q, bio, pages[i], bytes, offset) < bytes)
 577                         break;
 578
 579                 len -= bytes;
 580                 offset = 0;
 581         }
 582
 583         /*
 584          * release the pages we didn't map into the bio, if any
 585          */
 586         while (i < nr_pages)
 587                 page_cache_release(pages[i++]);
 588
 589         kfree(pages);
 590
 591         /*
 592          * set data direction, and check if mapped pages need bouncing
 593          */
 594         if (!write_to_vm)
 595                 bio->bi_rw |= (1 << BIO_RW);
 596
 597         bio->bi_flags |= (1 << BIO_USER_MAPPED);
 598         return bio;
 599 out:
 600         kfree(pages);
 601         bio_put(bio);
 602         return ERR_PTR(ret);
 603 }
 604
 605 /**
 606  *      bio_map_user    -       map user address into bio
 607  *      @bdev: destination block device
 608  *      @uaddr: start of user address
 609  *      @len: length in bytes
 610  *      @write_to_vm: bool indicating writing to pages or not
 611  *
 612  *      Map the user space address into a bio suitable for io to a block
 613  *      device. Returns an error pointer in case of error.
 614  */
 615 struct bio *bio_map_user(request_queue_t *q, struct block_device *bdev,
 616                          unsigned long uaddr, unsigned int len, int write_to_vm)
 617 {
 618         struct bio *bio;
 619
 620         bio = __bio_map_user(q, bdev, uaddr, len, write_to_vm);
 621
 622         if (IS_ERR(bio))
 623                 return bio;
 624
 625         /*
 626          * subtle -- if __bio_map_user() ended up bouncing a bio,
 627          * it would normally disappear when its bi_end_io is run.
 628          * however, we need it for the unmap, so grab an extra
 629          * reference to it
 630          */
 631         bio_get(bio);
 632
 633         if (bio->bi_size == len)
 634                 return bio;
 635
 636         /*
 637          * don't support partial mappings
 638          */
 639         bio_endio(bio, bio->bi_size, 0);
 640         bio_unmap_user(bio);
 641         return ERR_PTR(-EINVAL);
 642 }
 643
 644 static void __bio_unmap_user(struct bio *bio)
 645 {
 646         struct bio_vec *bvec;
 647         int i;
 648
 649         /*
 650          * make sure we dirty pages we wrote to
 651          */
 652         __bio_for_each_segment(bvec, bio, i, 0) {
 653                 if (bio_data_dir(bio) == READ)
 654                         set_page_dirty_lock(bvec->bv_page);
 655
 656                 page_cache_release(bvec->bv_page);
 657         }
 658
 659         bio_put(bio);
 660 }
 661
 662 /**
 663  *      bio_unmap_user  -       unmap a bio
 664  *      @bio:           the bio being unmapped
 665  *
 666  *      Unmap a bio previously mapped by bio_map_user(). Must be called with
 667  *      a process context.
 668  *
 669  *      bio_unmap_user() may sleep.
 670  */
 671 void bio_unmap_user(struct bio *bio)
 672 {
 673         __bio_unmap_user(bio);
 674         bio_put(bio);
 675 }
 676
 677 /*
 678  * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
 679  * for performing direct-IO in BIOs.
 680  *
 681  * The problem is that we cannot run set_page_dirty() from interrupt context
 682  * because the required locks are not interrupt-safe.  So what we can do is to
 683  * mark the pages dirty _before_ performing IO.  And in interrupt context,
 684  * check that the pages are still dirty.   If so, fine.  If not, redirty them
 685  * in process context.
 686  *
 687  * We special-case compound pages here: normally this means reads into hugetlb
 688  * pages.  The logic in here doesn't really work right for compound pages
 689  * because the VM does not uniformly chase down the head page in all cases.
 690  * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
 691  * handle them at all.  So we skip compound pages here at an early stage.
 692  *
 693  * Note that this code is very hard to test under normal circumstances because
 694  * direct-io pins the pages with get_user_pages().  This makes
 695  * is_page_cache_freeable return false, and the VM will not clean the pages.
 696  * But other code (eg, pdflush) could clean the pages if they are mapped
 697  * pagecache.
 698  *
 699  * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
 700  * deferred bio dirtying paths.
 701  */
 702
 703 /*
 704  * bio_set_pages_dirty() will mark all the bio's pages as dirty.
 705  */
 706 void bio_set_pages_dirty(struct bio *bio)
 707 {
 708         struct bio_vec *bvec = bio->bi_io_vec;
 709         int i;
 710
 711         for (i = 0; i < bio->bi_vcnt; i++) {
 712                 struct page *page = bvec[i].bv_page;
 713
 714                 if (page && !PageCompound(page))
 715                         set_page_dirty_lock(page);
 716         }
 717 }
 718
 719 static void bio_release_pages(struct bio *bio)
 720 {
 721         struct bio_vec *bvec = bio->bi_io_vec;
 722         int i;
 723
 724         for (i = 0; i < bio->bi_vcnt; i++) {
 725                 struct page *page = bvec[i].bv_page;
 726
 727                 if (page)
 728                         put_page(page);
 729         }
 730 }
 731
 732 /*
 733  * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
 734  * If they are, then fine.  If, however, some pages are clean then they must
 735  * have been written out during the direct-IO read.  So we take another ref on
 736  * the BIO and the offending pages and re-dirty the pages in process context.
 737  *
 738  * It is expected that bio_check_pages_dirty() will wholly own the BIO from
 739  * here on.  It will run one page_cache_release() against each page and will
 740  * run one bio_put() against the BIO.
 741  */
 742
 743 static void bio_dirty_fn(void *data);
 744
 745 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn, NULL);
 746 static spinlock_t bio_dirty_lock = SPIN_LOCK_UNLOCKED;
 747 static struct bio *bio_dirty_list;
 748
 749 /*
 750  * This runs in process context
 751  */
 752 static void bio_dirty_fn(void *data)
 753 {
 754         unsigned long flags;
 755         struct bio *bio;
 756
 757         spin_lock_irqsave(&bio_dirty_lock, flags);
 758         bio = bio_dirty_list;
 759         bio_dirty_list = NULL;
 760         spin_unlock_irqrestore(&bio_dirty_lock, flags);
 761
 762         while (bio) {
 763                 struct bio *next = bio->bi_private;
 764
 765                 bio_set_pages_dirty(bio);
 766                 bio_release_pages(bio);
 767                 bio_put(bio);
 768                 bio = next;
 769         }
 770 }
 771
 772 void bio_check_pages_dirty(struct bio *bio)
 773 {
 774         struct bio_vec *bvec = bio->bi_io_vec;
 775         int nr_clean_pages = 0;
 776         int i;
 777
 778         for (i = 0; i < bio->bi_vcnt; i++) {
 779                 struct page *page = bvec[i].bv_page;
 780
 781                 if (PageDirty(page) || PageCompound(page)) {
 782                         page_cache_release(page);
 783                         bvec[i].bv_page = NULL;
 784                 } else {
 785                         nr_clean_pages++;
 786                 }
 787         }
 788
 789         if (nr_clean_pages) {
 790                 unsigned long flags;
 791
 792                 spin_lock_irqsave(&bio_dirty_lock, flags);
 793                 bio->bi_private = bio_dirty_list;
 794                 bio_dirty_list = bio;
 795                 spin_unlock_irqrestore(&bio_dirty_lock, flags);
 796                 schedule_work(&bio_dirty_work);
 797         } else {
 798                 bio_put(bio);
 799         }
 800 }
 801
 802 /**
 803  * bio_endio - end I/O on a bio
 804  * @bio:        bio
 805  * @bytes_done: number of bytes completed
 806  * @error:      error, if any
 807  *
 808  * Description:
 809  *   bio_endio() will end I/O on @bytes_done number of bytes. This may be
 810  *   just a partial part of the bio, or it may be the whole bio. bio_endio()
 811  *   is the preferred way to end I/O on a bio, it takes care of decrementing
 812  *   bi_size and clearing BIO_UPTODATE on error. @error is 0 on success, and
 813  *   and one of the established -Exxxx (-EIO, for instance) error values in
 814  *   case something went wrong. Noone should call bi_end_io() directly on
 815  *   a bio unless they own it and thus know that it has an end_io function.
 816  **/
 817 void bio_endio(struct bio *bio, unsigned int bytes_done, int error)
 818 {
 819         if (error)
 820                 clear_bit(BIO_UPTODATE, &bio->bi_flags);
 821
 822         if (unlikely(bytes_done > bio->bi_size)) {
 823                 printk("%s: want %u bytes done, only %u left\n", __FUNCTION__,
 824                                                 bytes_done, bio->bi_size);
 825                 bytes_done = bio->bi_size;
 826         }
 827
 828         bio->bi_size -= bytes_done;
 829         bio->bi_sector += (bytes_done >> 9);
 830
 831         if (bio->bi_end_io)
 832                 bio->bi_end_io(bio, bytes_done, error);
 833 }
 834
 835 void bio_pair_release(struct bio_pair *bp)
 836 {
 837         if (atomic_dec_and_test(&bp->cnt)) {
 838                 struct bio *master = bp->bio1.bi_private;
 839
 840                 bio_endio(master, master->bi_size, bp->error);
 841                 mempool_free(bp, bp->bio2.bi_private);
 842         }
 843 }
 844
 845 static int bio_pair_end_1(struct bio * bi, unsigned int done, int err)
 846 {
 847         struct bio_pair *bp = container_of(bi, struct bio_pair, bio1);
 848
 849         if (err)
 850                 bp->error = err;
 851
 852         if (bi->bi_size)
 853                 return 1;
 854
 855         bio_pair_release(bp);
 856         return 0;
 857 }
 858
 859 static int bio_pair_end_2(struct bio * bi, unsigned int done, int err)
 860 {
 861         struct bio_pair *bp = container_of(bi, struct bio_pair, bio2);
 862
 863         if (err)
 864                 bp->error = err;
 865
 866         if (bi->bi_size)
 867                 return 1;
 868
 869         bio_pair_release(bp);
 870         return 0;
 871 }
 872
 873 /*
 874  * split a bio - only worry about a bio with a single page
 875  * in it's iovec
 876  */
 877 struct bio_pair *bio_split(struct bio *bi, mempool_t *pool, int first_sectors)
 878 {
 879         struct bio_pair *bp = mempool_alloc(pool, GFP_NOIO);
 880
 881         if (!bp)
 882                 return bp;
 883
 884         BUG_ON(bi->bi_vcnt != 1);
 885         BUG_ON(bi->bi_idx != 0);
 886         atomic_set(&bp->cnt, 3);
 887         bp->error = 0;
 888         bp->bio1 = *bi;
 889         bp->bio2 = *bi;
 890         bp->bio2.bi_sector += first_sectors;
 891         bp->bio2.bi_size -= first_sectors << 9;
 892         bp->bio1.bi_size = first_sectors << 9;
 893
 894         bp->bv1 = bi->bi_io_vec[0];
 895         bp->bv2 = bi->bi_io_vec[0];
 896         bp->bv2.bv_offset += first_sectors << 9;
 897         bp->bv2.bv_len -= first_sectors << 9;
 898         bp->bv1.bv_len = first_sectors << 9;
 899
 900         bp->bio1.bi_io_vec = &bp->bv1;
 901         bp->bio2.bi_io_vec = &bp->bv2;
 902
 903         bp->bio1.bi_end_io = bio_pair_end_1;
 904         bp->bio2.bi_end_io = bio_pair_end_2;
 905
 906         bp->bio1.bi_private = bi;
 907         bp->bio2.bi_private = pool;
 908
 909         return bp;
 910 }
 911
 912 static void *bio_pair_alloc(int gfp_flags, void *data)
 913 {
 914         return kmalloc(sizeof(struct bio_pair), gfp_flags);
 915 }
 916
 917 static void bio_pair_free(void *bp, void *data)
 918 {
 919         kfree(bp);
 920 }
 921
 922 static void __init biovec_init_pools(void)
 923 {
 924         int i, size, megabytes, pool_entries = BIO_POOL_SIZE;
 925         int scale = BIOVEC_NR_POOLS;
 926
 927         megabytes = nr_free_pages() >> (20 - PAGE_SHIFT);
 928
 929         /*
 930          * find out where to start scaling
 931          */
 932         if (megabytes <= 16)
 933                 scale = 0;
 934         else if (megabytes <= 32)
 935                 scale = 1;
 936         else if (megabytes <= 64)
 937                 scale = 2;
 938         else if (megabytes <= 96)
 939                 scale = 3;
 940         else if (megabytes <= 128)
 941                 scale = 4;
 942
 943         /*
 944          * scale number of entries
 945          */
 946         pool_entries = megabytes * 2;
 947         if (pool_entries > 256)
 948                 pool_entries = 256;
 949
 950         for (i = 0; i < BIOVEC_NR_POOLS; i++) {
 951                 struct biovec_pool *bp = bvec_array + i;
 952
 953                 size = bp->nr_vecs * sizeof(struct bio_vec);
 954
 955                 bp->slab = kmem_cache_create(bp->name, size, 0,
 956                                 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
 957
 958                 if (i >= scale)
 959                         pool_entries >>= 1;
 960
 961                 bp->pool = mempool_create(pool_entries, mempool_alloc_slab,
 962                                         mempool_free_slab, bp->slab);
 963                 if (!bp->pool)
 964                         panic("biovec: can't init mempool\n");
 965         }
 966 }
 967
 968 static int __init init_bio(void)
 969 {
 970         bio_slab = kmem_cache_create("bio", sizeof(struct bio), 0,
 971                                 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
 972         bio_pool = mempool_create(BIO_POOL_SIZE, mempool_alloc_slab,
 973                                 mempool_free_slab, bio_slab);
 974         if (!bio_pool)
 975                 panic("bio: can't create mempool\n");
 976
 977         biovec_init_pools();
 978
 979         bio_split_pool = mempool_create(BIO_SPLIT_ENTRIES,
 980                                 bio_pair_alloc, bio_pair_free, NULL);
 981         if (!bio_split_pool)
 982                 panic("bio: can't create split pool\n");
 983
 984         return 0;
 985 }
 986
 987 subsys_initcall(init_bio);
 988
 989 EXPORT_SYMBOL(bio_alloc);
 990 EXPORT_SYMBOL(bio_put);
 991 EXPORT_SYMBOL(bio_endio);
 992 EXPORT_SYMBOL(bio_init);
 993 EXPORT_SYMBOL(__bio_clone);
 994 EXPORT_SYMBOL(bio_clone);
 995 EXPORT_SYMBOL(bio_phys_segments);
 996 EXPORT_SYMBOL(bio_hw_segments);
 997 EXPORT_SYMBOL(bio_add_page);
 998 EXPORT_SYMBOL(bio_get_nr_vecs);
 999 EXPORT_SYMBOL(bio_map_user);
1000 EXPORT_SYMBOL(bio_unmap_user);
1001 EXPORT_SYMBOL(bio_pair_release);
1002 EXPORT_SYMBOL(bio_split);
1003 EXPORT_SYMBOL(bio_split_pool);
1004 EXPORT_SYMBOL(bio_copy_user);
1005 EXPORT_SYMBOL(bio_uncopy_user);