4 * Copyright (C) 2002, Linus Torvalds.
6 * Contains functions related to preparing and submitting BIOs which contain
7 * multiple pagecache pages.
9 * 15May2002 akpm@zip.com.au
11 * 27Jun2002 axboe@suse.de
12 * use bio_add_page() to build bio's just the right size
15 #include <linux/kernel.h>
16 #include <linux/module.h>
18 #include <linux/kdev_t.h>
19 #include <linux/bio.h>
21 #include <linux/buffer_head.h>
22 #include <linux/blkdev.h>
23 #include <linux/highmem.h>
24 #include <linux/prefetch.h>
25 #include <linux/mpage.h>
26 #include <linux/writeback.h>
27 #include <linux/backing-dev.h>
28 #include <linux/pagevec.h>
31 * I/O completion handler for multipage BIOs.
33 * The mpage code never puts partial pages into a BIO (except for end-of-file).
34 * If a page does not map to a contiguous run of blocks then it simply falls
35 * back to block_read_full_page().
37 * Why is this? If a page's completion depends on a number of different BIOs
38 * which can complete in any order (or at the same time) then determining the
39 * status of that page is hard. See end_buffer_async_read() for the details.
40 * There is no point in duplicating all that complexity.
42 static int mpage_end_io_read(struct bio
*bio
, unsigned int bytes_done
, int err
)
44 const int uptodate
= test_bit(BIO_UPTODATE
, &bio
->bi_flags
);
45 struct bio_vec
*bvec
= bio
->bi_io_vec
+ bio
->bi_vcnt
- 1;
51 struct page
*page
= bvec
->bv_page
;
53 if (--bvec
>= bio
->bi_io_vec
)
54 prefetchw(&bvec
->bv_page
->flags
);
57 SetPageUptodate(page
);
59 ClearPageUptodate(page
);
63 } while (bvec
>= bio
->bi_io_vec
);
68 static int mpage_end_io_write(struct bio
*bio
, unsigned int bytes_done
, int err
)
70 const int uptodate
= test_bit(BIO_UPTODATE
, &bio
->bi_flags
);
71 struct bio_vec
*bvec
= bio
->bi_io_vec
+ bio
->bi_vcnt
- 1;
77 struct page
*page
= bvec
->bv_page
;
79 if (--bvec
>= bio
->bi_io_vec
)
80 prefetchw(&bvec
->bv_page
->flags
);
85 set_bit(AS_EIO
, &page
->mapping
->flags
);
87 end_page_writeback(page
);
88 } while (bvec
>= bio
->bi_io_vec
);
93 static struct bio
*mpage_bio_submit(int rw
, struct bio
*bio
)
95 bio
->bi_end_io
= mpage_end_io_read
;
97 bio
->bi_end_io
= mpage_end_io_write
;
103 mpage_alloc(struct block_device
*bdev
,
104 sector_t first_sector
, int nr_vecs
,
109 bio
= bio_alloc(gfp_flags
, nr_vecs
);
111 if (bio
== NULL
&& (current
->flags
& PF_MEMALLOC
)) {
112 while (!bio
&& (nr_vecs
/= 2))
113 bio
= bio_alloc(gfp_flags
, nr_vecs
);
118 bio
->bi_sector
= first_sector
;
124 * support function for mpage_readpages. The fs supplied get_block might
125 * return an up to date buffer. This is used to map that buffer into
126 * the page, which allows readpage to avoid triggering a duplicate call
129 * The idea is to avoid adding buffers to pages that don't already have
130 * them. So when the buffer is up to date and the page size == block size,
131 * this marks the page up to date instead of adding new buffers.
134 map_buffer_to_page(struct page
*page
, struct buffer_head
*bh
, int page_block
)
136 struct inode
*inode
= page
->mapping
->host
;
137 struct buffer_head
*page_bh
, *head
;
140 if (!page_has_buffers(page
)) {
142 * don't make any buffers if there is only one buffer on
143 * the page and the page just needs to be set up to date
145 if (inode
->i_blkbits
== PAGE_CACHE_SHIFT
&&
146 buffer_uptodate(bh
)) {
147 SetPageUptodate(page
);
150 create_empty_buffers(page
, 1 << inode
->i_blkbits
, 0);
152 head
= page_buffers(page
);
155 if (block
== page_block
) {
156 page_bh
->b_state
= bh
->b_state
;
157 page_bh
->b_bdev
= bh
->b_bdev
;
158 page_bh
->b_blocknr
= bh
->b_blocknr
;
161 page_bh
= page_bh
->b_this_page
;
163 } while (page_bh
!= head
);
167 * This is the worker routine which does all the work of mapping the disk
168 * blocks and constructs largest possible bios, submits them for IO if the
169 * blocks are not contiguous on the disk.
171 * We pass a buffer_head back and forth and use its buffer_mapped() flag to
172 * represent the validity of its disk mapping and to decide when to do the next
176 do_mpage_readpage(struct bio
*bio
, struct page
*page
, unsigned nr_pages
,
177 sector_t
*last_block_in_bio
, struct buffer_head
*map_bh
,
178 unsigned long *first_logical_block
, get_block_t get_block
)
180 struct inode
*inode
= page
->mapping
->host
;
181 const unsigned blkbits
= inode
->i_blkbits
;
182 const unsigned blocks_per_page
= PAGE_CACHE_SIZE
>> blkbits
;
183 const unsigned blocksize
= 1 << blkbits
;
184 sector_t block_in_file
;
186 sector_t last_block_in_file
;
187 sector_t blocks
[MAX_BUF_PER_PAGE
];
189 unsigned first_hole
= blocks_per_page
;
190 struct block_device
*bdev
= NULL
;
192 int fully_mapped
= 1;
194 unsigned relative_block
;
196 if (page_has_buffers(page
))
199 block_in_file
= (sector_t
)page
->index
<< (PAGE_CACHE_SHIFT
- blkbits
);
200 last_block
= block_in_file
+ nr_pages
* blocks_per_page
;
201 last_block_in_file
= (i_size_read(inode
) + blocksize
- 1) >> blkbits
;
202 if (last_block
> last_block_in_file
)
203 last_block
= last_block_in_file
;
207 * Map blocks using the result from the previous get_blocks call first.
209 nblocks
= map_bh
->b_size
>> blkbits
;
210 if (buffer_mapped(map_bh
) && block_in_file
> *first_logical_block
&&
211 block_in_file
< (*first_logical_block
+ nblocks
)) {
212 unsigned map_offset
= block_in_file
- *first_logical_block
;
213 unsigned last
= nblocks
- map_offset
;
215 for (relative_block
= 0; ; relative_block
++) {
216 if (relative_block
== last
) {
217 clear_buffer_mapped(map_bh
);
220 if (page_block
== blocks_per_page
)
222 blocks
[page_block
] = map_bh
->b_blocknr
+ map_offset
+
227 bdev
= map_bh
->b_bdev
;
231 * Then do more get_blocks calls until we are done with this page.
233 map_bh
->b_page
= page
;
234 while (page_block
< blocks_per_page
) {
238 if (block_in_file
< last_block
) {
239 map_bh
->b_size
= (last_block
-block_in_file
) << blkbits
;
240 if (get_block(inode
, block_in_file
, map_bh
, 0))
242 *first_logical_block
= block_in_file
;
245 if (!buffer_mapped(map_bh
)) {
247 if (first_hole
== blocks_per_page
)
248 first_hole
= page_block
;
251 clear_buffer_mapped(map_bh
);
255 /* some filesystems will copy data into the page during
256 * the get_block call, in which case we don't want to
257 * read it again. map_buffer_to_page copies the data
258 * we just collected from get_block into the page's buffers
259 * so readpage doesn't have to repeat the get_block call
261 if (buffer_uptodate(map_bh
)) {
262 map_buffer_to_page(page
, map_bh
, page_block
);
266 if (first_hole
!= blocks_per_page
)
267 goto confused
; /* hole -> non-hole */
269 /* Contiguous blocks? */
270 if (page_block
&& blocks
[page_block
-1] != map_bh
->b_blocknr
-1)
272 nblocks
= map_bh
->b_size
>> blkbits
;
273 for (relative_block
= 0; ; relative_block
++) {
274 if (relative_block
== nblocks
) {
275 clear_buffer_mapped(map_bh
);
277 } else if (page_block
== blocks_per_page
)
279 blocks
[page_block
] = map_bh
->b_blocknr
+relative_block
;
283 bdev
= map_bh
->b_bdev
;
286 if (first_hole
!= blocks_per_page
) {
287 char *kaddr
= kmap_atomic(page
, KM_USER0
);
288 memset(kaddr
+ (first_hole
<< blkbits
), 0,
289 PAGE_CACHE_SIZE
- (first_hole
<< blkbits
));
290 flush_dcache_page(page
);
291 kunmap_atomic(kaddr
, KM_USER0
);
292 if (first_hole
== 0) {
293 SetPageUptodate(page
);
297 } else if (fully_mapped
) {
298 SetPageMappedToDisk(page
);
302 * This page will go to BIO. Do we need to send this BIO off first?
304 if (bio
&& (*last_block_in_bio
!= blocks
[0] - 1))
305 bio
= mpage_bio_submit(READ
, bio
);
309 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
310 min_t(int, nr_pages
, bio_get_nr_vecs(bdev
)),
316 length
= first_hole
<< blkbits
;
317 if (bio_add_page(bio
, page
, length
, 0) < length
) {
318 bio
= mpage_bio_submit(READ
, bio
);
322 if (buffer_boundary(map_bh
) || (first_hole
!= blocks_per_page
))
323 bio
= mpage_bio_submit(READ
, bio
);
325 *last_block_in_bio
= blocks
[blocks_per_page
- 1];
331 bio
= mpage_bio_submit(READ
, bio
);
332 if (!PageUptodate(page
))
333 block_read_full_page(page
, get_block
);
340 * mpage_readpages - populate an address space with some pages, and
341 * start reads against them.
343 * @mapping: the address_space
344 * @pages: The address of a list_head which contains the target pages. These
345 * pages have their ->index populated and are otherwise uninitialised.
347 * The page at @pages->prev has the lowest file offset, and reads should be
348 * issued in @pages->prev to @pages->next order.
350 * @nr_pages: The number of pages at *@pages
351 * @get_block: The filesystem's block mapper function.
353 * This function walks the pages and the blocks within each page, building and
354 * emitting large BIOs.
356 * If anything unusual happens, such as:
358 * - encountering a page which has buffers
359 * - encountering a page which has a non-hole after a hole
360 * - encountering a page with non-contiguous blocks
362 * then this code just gives up and calls the buffer_head-based read function.
363 * It does handle a page which has holes at the end - that is a common case:
364 * the end-of-file on blocksize < PAGE_CACHE_SIZE setups.
366 * BH_Boundary explanation:
368 * There is a problem. The mpage read code assembles several pages, gets all
369 * their disk mappings, and then submits them all. That's fine, but obtaining
370 * the disk mappings may require I/O. Reads of indirect blocks, for example.
372 * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
373 * submitted in the following order:
374 * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
375 * because the indirect block has to be read to get the mappings of blocks
376 * 13,14,15,16. Obviously, this impacts performance.
378 * So what we do it to allow the filesystem's get_block() function to set
379 * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block
380 * after this one will require I/O against a block which is probably close to
381 * this one. So you should push what I/O you have currently accumulated.
383 * This all causes the disk requests to be issued in the correct order.
386 mpage_readpages(struct address_space
*mapping
, struct list_head
*pages
,
387 unsigned nr_pages
, get_block_t get_block
)
389 struct bio
*bio
= NULL
;
391 sector_t last_block_in_bio
= 0;
392 struct pagevec lru_pvec
;
393 struct buffer_head map_bh
;
394 unsigned long first_logical_block
= 0;
396 clear_buffer_mapped(&map_bh
);
397 pagevec_init(&lru_pvec
, 0);
398 for (page_idx
= 0; page_idx
< nr_pages
; page_idx
++) {
399 struct page
*page
= list_entry(pages
->prev
, struct page
, lru
);
401 prefetchw(&page
->flags
);
402 list_del(&page
->lru
);
403 if (!add_to_page_cache(page
, mapping
,
404 page
->index
, GFP_KERNEL
)) {
405 bio
= do_mpage_readpage(bio
, page
,
407 &last_block_in_bio
, &map_bh
,
408 &first_logical_block
,
410 if (!pagevec_add(&lru_pvec
, page
))
411 __pagevec_lru_add(&lru_pvec
);
413 page_cache_release(page
);
416 pagevec_lru_add(&lru_pvec
);
417 BUG_ON(!list_empty(pages
));
419 mpage_bio_submit(READ
, bio
);
422 EXPORT_SYMBOL(mpage_readpages
);
425 * This isn't called much at all
427 int mpage_readpage(struct page
*page
, get_block_t get_block
)
429 struct bio
*bio
= NULL
;
430 sector_t last_block_in_bio
= 0;
431 struct buffer_head map_bh
;
432 unsigned long first_logical_block
= 0;
434 clear_buffer_mapped(&map_bh
);
435 bio
= do_mpage_readpage(bio
, page
, 1, &last_block_in_bio
,
436 &map_bh
, &first_logical_block
, get_block
);
438 mpage_bio_submit(READ
, bio
);
441 EXPORT_SYMBOL(mpage_readpage
);
444 * Writing is not so simple.
446 * If the page has buffers then they will be used for obtaining the disk
447 * mapping. We only support pages which are fully mapped-and-dirty, with a
448 * special case for pages which are unmapped at the end: end-of-file.
450 * If the page has no buffers (preferred) then the page is mapped here.
452 * If all blocks are found to be contiguous then the page can go into the
453 * BIO. Otherwise fall back to the mapping's writepage().
455 * FIXME: This code wants an estimate of how many pages are still to be
456 * written, so it can intelligently allocate a suitably-sized BIO. For now,
457 * just allocate full-size (16-page) BIOs.
460 __mpage_writepage(struct bio
*bio
, struct page
*page
, get_block_t get_block
,
461 sector_t
*last_block_in_bio
, int *ret
, struct writeback_control
*wbc
,
462 writepage_t writepage_fn
)
464 struct address_space
*mapping
= page
->mapping
;
465 struct inode
*inode
= page
->mapping
->host
;
466 const unsigned blkbits
= inode
->i_blkbits
;
467 unsigned long end_index
;
468 const unsigned blocks_per_page
= PAGE_CACHE_SIZE
>> blkbits
;
470 sector_t block_in_file
;
471 sector_t blocks
[MAX_BUF_PER_PAGE
];
473 unsigned first_unmapped
= blocks_per_page
;
474 struct block_device
*bdev
= NULL
;
476 sector_t boundary_block
= 0;
477 struct block_device
*boundary_bdev
= NULL
;
479 struct buffer_head map_bh
;
480 loff_t i_size
= i_size_read(inode
);
482 if (page_has_buffers(page
)) {
483 struct buffer_head
*head
= page_buffers(page
);
484 struct buffer_head
*bh
= head
;
486 /* If they're all mapped and dirty, do it */
489 BUG_ON(buffer_locked(bh
));
490 if (!buffer_mapped(bh
)) {
492 * unmapped dirty buffers are created by
493 * __set_page_dirty_buffers -> mmapped data
495 if (buffer_dirty(bh
))
497 if (first_unmapped
== blocks_per_page
)
498 first_unmapped
= page_block
;
502 if (first_unmapped
!= blocks_per_page
)
503 goto confused
; /* hole -> non-hole */
505 if (!buffer_dirty(bh
) || !buffer_uptodate(bh
))
508 if (bh
->b_blocknr
!= blocks
[page_block
-1] + 1)
511 blocks
[page_block
++] = bh
->b_blocknr
;
512 boundary
= buffer_boundary(bh
);
514 boundary_block
= bh
->b_blocknr
;
515 boundary_bdev
= bh
->b_bdev
;
518 } while ((bh
= bh
->b_this_page
) != head
);
524 * Page has buffers, but they are all unmapped. The page was
525 * created by pagein or read over a hole which was handled by
526 * block_read_full_page(). If this address_space is also
527 * using mpage_readpages then this can rarely happen.
533 * The page has no buffers: map it to disk
535 BUG_ON(!PageUptodate(page
));
536 block_in_file
= (sector_t
)page
->index
<< (PAGE_CACHE_SHIFT
- blkbits
);
537 last_block
= (i_size
- 1) >> blkbits
;
538 map_bh
.b_page
= page
;
539 for (page_block
= 0; page_block
< blocks_per_page
; ) {
542 map_bh
.b_size
= 1 << blkbits
;
543 if (get_block(inode
, block_in_file
, &map_bh
, 1))
545 if (buffer_new(&map_bh
))
546 unmap_underlying_metadata(map_bh
.b_bdev
,
548 if (buffer_boundary(&map_bh
)) {
549 boundary_block
= map_bh
.b_blocknr
;
550 boundary_bdev
= map_bh
.b_bdev
;
553 if (map_bh
.b_blocknr
!= blocks
[page_block
-1] + 1)
556 blocks
[page_block
++] = map_bh
.b_blocknr
;
557 boundary
= buffer_boundary(&map_bh
);
558 bdev
= map_bh
.b_bdev
;
559 if (block_in_file
== last_block
)
563 BUG_ON(page_block
== 0);
565 first_unmapped
= page_block
;
568 end_index
= i_size
>> PAGE_CACHE_SHIFT
;
569 if (page
->index
>= end_index
) {
571 * The page straddles i_size. It must be zeroed out on each
572 * and every writepage invokation because it may be mmapped.
573 * "A file is mapped in multiples of the page size. For a file
574 * that is not a multiple of the page size, the remaining memory
575 * is zeroed when mapped, and writes to that region are not
576 * written out to the file."
578 unsigned offset
= i_size
& (PAGE_CACHE_SIZE
- 1);
581 if (page
->index
> end_index
|| !offset
)
583 kaddr
= kmap_atomic(page
, KM_USER0
);
584 memset(kaddr
+ offset
, 0, PAGE_CACHE_SIZE
- offset
);
585 flush_dcache_page(page
);
586 kunmap_atomic(kaddr
, KM_USER0
);
590 * This page will go to BIO. Do we need to send this BIO off first?
592 if (bio
&& *last_block_in_bio
!= blocks
[0] - 1)
593 bio
= mpage_bio_submit(WRITE
, bio
);
597 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
598 bio_get_nr_vecs(bdev
), GFP_NOFS
|__GFP_HIGH
);
604 * Must try to add the page before marking the buffer clean or
605 * the confused fail path above (OOM) will be very confused when
606 * it finds all bh marked clean (i.e. it will not write anything)
608 length
= first_unmapped
<< blkbits
;
609 if (bio_add_page(bio
, page
, length
, 0) < length
) {
610 bio
= mpage_bio_submit(WRITE
, bio
);
615 * OK, we have our BIO, so we can now mark the buffers clean. Make
616 * sure to only clean buffers which we know we'll be writing.
618 if (page_has_buffers(page
)) {
619 struct buffer_head
*head
= page_buffers(page
);
620 struct buffer_head
*bh
= head
;
621 unsigned buffer_counter
= 0;
624 if (buffer_counter
++ == first_unmapped
)
626 clear_buffer_dirty(bh
);
627 bh
= bh
->b_this_page
;
628 } while (bh
!= head
);
631 * we cannot drop the bh if the page is not uptodate
632 * or a concurrent readpage would fail to serialize with the bh
633 * and it would read from disk before we reach the platter.
635 if (buffer_heads_over_limit
&& PageUptodate(page
))
636 try_to_free_buffers(page
);
639 BUG_ON(PageWriteback(page
));
640 set_page_writeback(page
);
642 if (boundary
|| (first_unmapped
!= blocks_per_page
)) {
643 bio
= mpage_bio_submit(WRITE
, bio
);
644 if (boundary_block
) {
645 write_boundary_block(boundary_bdev
,
646 boundary_block
, 1 << blkbits
);
649 *last_block_in_bio
= blocks
[blocks_per_page
- 1];
655 bio
= mpage_bio_submit(WRITE
, bio
);
658 *ret
= (*writepage_fn
)(page
, wbc
);
664 * The caller has a ref on the inode, so *mapping is stable
668 set_bit(AS_ENOSPC
, &mapping
->flags
);
670 set_bit(AS_EIO
, &mapping
->flags
);
677 * mpage_writepages - walk the list of dirty pages of the given
678 * address space and writepage() all of them.
680 * @mapping: address space structure to write
681 * @wbc: subtract the number of written pages from *@wbc->nr_to_write
682 * @get_block: the filesystem's block mapper function.
683 * If this is NULL then use a_ops->writepage. Otherwise, go
686 * This is a library function, which implements the writepages()
687 * address_space_operation.
689 * If a page is already under I/O, generic_writepages() skips it, even
690 * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
691 * but it is INCORRECT for data-integrity system calls such as fsync(). fsync()
692 * and msync() need to guarantee that all the data which was dirty at the time
693 * the call was made get new I/O started against them. If wbc->sync_mode is
694 * WB_SYNC_ALL then we were called for data integrity and we must wait for
695 * existing IO to complete.
697 * If you fix this you should check generic_writepages() also!
700 mpage_writepages(struct address_space
*mapping
,
701 struct writeback_control
*wbc
, get_block_t get_block
)
703 struct backing_dev_info
*bdi
= mapping
->backing_dev_info
;
704 struct bio
*bio
= NULL
;
705 sector_t last_block_in_bio
= 0;
708 int (*writepage
)(struct page
*page
, struct writeback_control
*wbc
);
712 pgoff_t end
; /* Inclusive */
716 if (wbc
->nonblocking
&& bdi_write_congested(bdi
)) {
717 wbc
->encountered_congestion
= 1;
722 if (get_block
== NULL
)
723 writepage
= mapping
->a_ops
->writepage
;
725 pagevec_init(&pvec
, 0);
726 if (wbc
->range_cyclic
) {
727 index
= mapping
->writeback_index
; /* Start from prev offset */
730 index
= wbc
->range_start
>> PAGE_CACHE_SHIFT
;
731 end
= wbc
->range_end
>> PAGE_CACHE_SHIFT
;
732 if (wbc
->range_start
== 0 && wbc
->range_end
== LLONG_MAX
)
737 while (!done
&& (index
<= end
) &&
738 (nr_pages
= pagevec_lookup_tag(&pvec
, mapping
, &index
,
740 min(end
- index
, (pgoff_t
)PAGEVEC_SIZE
-1) + 1))) {
744 for (i
= 0; i
< nr_pages
; i
++) {
745 struct page
*page
= pvec
.pages
[i
];
748 * At this point we hold neither mapping->tree_lock nor
749 * lock on the page itself: the page may be truncated or
750 * invalidated (changing page->mapping to NULL), or even
751 * swizzled back from swapper_space to tmpfs file
757 if (unlikely(page
->mapping
!= mapping
)) {
762 if (!wbc
->range_cyclic
&& page
->index
> end
) {
768 if (wbc
->sync_mode
!= WB_SYNC_NONE
)
769 wait_on_page_writeback(page
);
771 if (PageWriteback(page
) ||
772 !clear_page_dirty_for_io(page
)) {
778 ret
= (*writepage
)(page
, wbc
);
788 bio
= __mpage_writepage(bio
, page
, get_block
,
789 &last_block_in_bio
, &ret
, wbc
,
790 page
->mapping
->a_ops
->writepage
);
792 if (unlikely(ret
== AOP_WRITEPAGE_ACTIVATE
))
794 if (ret
|| (--(wbc
->nr_to_write
) <= 0))
796 if (wbc
->nonblocking
&& bdi_write_congested(bdi
)) {
797 wbc
->encountered_congestion
= 1;
801 pagevec_release(&pvec
);
804 if (!scanned
&& !done
) {
806 * We hit the last page and there is more work to be done: wrap
807 * back to the start of the file
813 if (wbc
->range_cyclic
|| (range_whole
&& wbc
->nr_to_write
> 0))
814 mapping
->writeback_index
= index
;
816 mpage_bio_submit(WRITE
, bio
);
819 EXPORT_SYMBOL(mpage_writepages
);
821 int mpage_writepage(struct page
*page
, get_block_t get_block
,
822 struct writeback_control
*wbc
)
826 sector_t last_block_in_bio
= 0;
828 bio
= __mpage_writepage(NULL
, page
, get_block
,
829 &last_block_in_bio
, &ret
, wbc
, NULL
);
831 mpage_bio_submit(WRITE
, bio
);
835 EXPORT_SYMBOL(mpage_writepage
);