4 * Copyright (C) 2002, Linus Torvalds.
6 * Contains functions related to preparing and submitting BIOs which contain
7 * multiple pagecache pages.
9 * 15May2002 Andrew Morton
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/gfp.h>
20 #include <linux/bio.h>
22 #include <linux/buffer_head.h>
23 #include <linux/blkdev.h>
24 #include <linux/highmem.h>
25 #include <linux/prefetch.h>
26 #include <linux/mpage.h>
27 #include <linux/writeback.h>
28 #include <linux/backing-dev.h>
29 #include <linux/pagevec.h>
32 * I/O completion handler for multipage BIOs.
34 * The mpage code never puts partial pages into a BIO (except for end-of-file).
35 * If a page does not map to a contiguous run of blocks then it simply falls
36 * back to block_read_full_page().
38 * Why is this? If a page's completion depends on a number of different BIOs
39 * which can complete in any order (or at the same time) then determining the
40 * status of that page is hard. See end_buffer_async_read() for the details.
41 * There is no point in duplicating all that complexity.
43 static void mpage_end_io(struct bio
*bio
, int err
)
45 const int uptodate
= test_bit(BIO_UPTODATE
, &bio
->bi_flags
);
46 struct bio_vec
*bvec
= bio
->bi_io_vec
+ bio
->bi_vcnt
- 1;
49 struct page
*page
= bvec
->bv_page
;
51 if (--bvec
>= bio
->bi_io_vec
)
52 prefetchw(&bvec
->bv_page
->flags
);
53 if (bio_data_dir(bio
) == READ
) {
55 SetPageUptodate(page
);
57 ClearPageUptodate(page
);
61 } else { /* bio_data_dir(bio) == WRITE */
65 set_bit(AS_EIO
, &page
->mapping
->flags
);
67 end_page_writeback(page
);
69 } while (bvec
>= bio
->bi_io_vec
);
73 static struct bio
*mpage_bio_submit(int rw
, struct bio
*bio
)
75 bio
->bi_end_io
= mpage_end_io
;
81 mpage_alloc(struct block_device
*bdev
,
82 sector_t first_sector
, int nr_vecs
,
87 bio
= bio_alloc(gfp_flags
, nr_vecs
);
89 if (bio
== NULL
&& (current
->flags
& PF_MEMALLOC
)) {
90 while (!bio
&& (nr_vecs
/= 2))
91 bio
= bio_alloc(gfp_flags
, nr_vecs
);
96 bio
->bi_sector
= first_sector
;
102 * support function for mpage_readpages. The fs supplied get_block might
103 * return an up to date buffer. This is used to map that buffer into
104 * the page, which allows readpage to avoid triggering a duplicate call
107 * The idea is to avoid adding buffers to pages that don't already have
108 * them. So when the buffer is up to date and the page size == block size,
109 * this marks the page up to date instead of adding new buffers.
112 map_buffer_to_page(struct page
*page
, struct buffer_head
*bh
, int page_block
)
114 struct inode
*inode
= page
->mapping
->host
;
115 struct buffer_head
*page_bh
, *head
;
118 if (!page_has_buffers(page
)) {
120 * don't make any buffers if there is only one buffer on
121 * the page and the page just needs to be set up to date
123 if (inode
->i_blkbits
== PAGE_CACHE_SHIFT
&&
124 buffer_uptodate(bh
)) {
125 SetPageUptodate(page
);
128 create_empty_buffers(page
, 1 << inode
->i_blkbits
, 0);
130 head
= page_buffers(page
);
133 if (block
== page_block
) {
134 page_bh
->b_state
= bh
->b_state
;
135 page_bh
->b_bdev
= bh
->b_bdev
;
136 page_bh
->b_blocknr
= bh
->b_blocknr
;
139 page_bh
= page_bh
->b_this_page
;
141 } while (page_bh
!= head
);
145 * This is the worker routine which does all the work of mapping the disk
146 * blocks and constructs largest possible bios, submits them for IO if the
147 * blocks are not contiguous on the disk.
149 * We pass a buffer_head back and forth and use its buffer_mapped() flag to
150 * represent the validity of its disk mapping and to decide when to do the next
154 do_mpage_readpage(struct bio
*bio
, struct page
*page
, unsigned nr_pages
,
155 sector_t
*last_block_in_bio
, struct buffer_head
*map_bh
,
156 unsigned long *first_logical_block
, get_block_t get_block
)
158 struct inode
*inode
= page
->mapping
->host
;
159 const unsigned blkbits
= inode
->i_blkbits
;
160 const unsigned blocks_per_page
= PAGE_CACHE_SIZE
>> blkbits
;
161 const unsigned blocksize
= 1 << blkbits
;
162 sector_t block_in_file
;
164 sector_t last_block_in_file
;
165 sector_t blocks
[MAX_BUF_PER_PAGE
];
167 unsigned first_hole
= blocks_per_page
;
168 struct block_device
*bdev
= NULL
;
170 int fully_mapped
= 1;
172 unsigned relative_block
;
174 if (page_has_buffers(page
))
177 block_in_file
= (sector_t
)page
->index
<< (PAGE_CACHE_SHIFT
- blkbits
);
178 last_block
= block_in_file
+ nr_pages
* blocks_per_page
;
179 last_block_in_file
= (i_size_read(inode
) + blocksize
- 1) >> blkbits
;
180 if (last_block
> last_block_in_file
)
181 last_block
= last_block_in_file
;
185 * Map blocks using the result from the previous get_blocks call first.
187 nblocks
= map_bh
->b_size
>> blkbits
;
188 if (buffer_mapped(map_bh
) && block_in_file
> *first_logical_block
&&
189 block_in_file
< (*first_logical_block
+ nblocks
)) {
190 unsigned map_offset
= block_in_file
- *first_logical_block
;
191 unsigned last
= nblocks
- map_offset
;
193 for (relative_block
= 0; ; relative_block
++) {
194 if (relative_block
== last
) {
195 clear_buffer_mapped(map_bh
);
198 if (page_block
== blocks_per_page
)
200 blocks
[page_block
] = map_bh
->b_blocknr
+ map_offset
+
205 bdev
= map_bh
->b_bdev
;
209 * Then do more get_blocks calls until we are done with this page.
211 map_bh
->b_page
= page
;
212 while (page_block
< blocks_per_page
) {
216 if (block_in_file
< last_block
) {
217 map_bh
->b_size
= (last_block
-block_in_file
) << blkbits
;
218 if (get_block(inode
, block_in_file
, map_bh
, 0))
220 *first_logical_block
= block_in_file
;
223 if (!buffer_mapped(map_bh
)) {
225 if (first_hole
== blocks_per_page
)
226 first_hole
= page_block
;
232 /* some filesystems will copy data into the page during
233 * the get_block call, in which case we don't want to
234 * read it again. map_buffer_to_page copies the data
235 * we just collected from get_block into the page's buffers
236 * so readpage doesn't have to repeat the get_block call
238 if (buffer_uptodate(map_bh
)) {
239 map_buffer_to_page(page
, map_bh
, page_block
);
243 if (first_hole
!= blocks_per_page
)
244 goto confused
; /* hole -> non-hole */
246 /* Contiguous blocks? */
247 if (page_block
&& blocks
[page_block
-1] != map_bh
->b_blocknr
-1)
249 nblocks
= map_bh
->b_size
>> blkbits
;
250 for (relative_block
= 0; ; relative_block
++) {
251 if (relative_block
== nblocks
) {
252 clear_buffer_mapped(map_bh
);
254 } else if (page_block
== blocks_per_page
)
256 blocks
[page_block
] = map_bh
->b_blocknr
+relative_block
;
260 bdev
= map_bh
->b_bdev
;
263 if (first_hole
!= blocks_per_page
) {
264 zero_user_segment(page
, first_hole
<< blkbits
, PAGE_CACHE_SIZE
);
265 if (first_hole
== 0) {
266 SetPageUptodate(page
);
270 } else if (fully_mapped
) {
271 SetPageMappedToDisk(page
);
275 * This page will go to BIO. Do we need to send this BIO off first?
277 if (bio
&& (*last_block_in_bio
!= blocks
[0] - 1))
278 bio
= mpage_bio_submit(READ
, bio
);
282 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
283 min_t(int, nr_pages
, bio_get_nr_vecs(bdev
)),
289 length
= first_hole
<< blkbits
;
290 if (bio_add_page(bio
, page
, length
, 0) < length
) {
291 bio
= mpage_bio_submit(READ
, bio
);
295 relative_block
= block_in_file
- *first_logical_block
;
296 nblocks
= map_bh
->b_size
>> blkbits
;
297 if ((buffer_boundary(map_bh
) && relative_block
== nblocks
) ||
298 (first_hole
!= blocks_per_page
))
299 bio
= mpage_bio_submit(READ
, bio
);
301 *last_block_in_bio
= blocks
[blocks_per_page
- 1];
307 bio
= mpage_bio_submit(READ
, bio
);
308 if (!PageUptodate(page
))
309 block_read_full_page(page
, get_block
);
316 * mpage_readpages - populate an address space with some pages & start reads against them
317 * @mapping: the address_space
318 * @pages: The address of a list_head which contains the target pages. These
319 * pages have their ->index populated and are otherwise uninitialised.
320 * The page at @pages->prev has the lowest file offset, and reads should be
321 * issued in @pages->prev to @pages->next order.
322 * @nr_pages: The number of pages at *@pages
323 * @get_block: The filesystem's block mapper function.
325 * This function walks the pages and the blocks within each page, building and
326 * emitting large BIOs.
328 * If anything unusual happens, such as:
330 * - encountering a page which has buffers
331 * - encountering a page which has a non-hole after a hole
332 * - encountering a page with non-contiguous blocks
334 * then this code just gives up and calls the buffer_head-based read function.
335 * It does handle a page which has holes at the end - that is a common case:
336 * the end-of-file on blocksize < PAGE_CACHE_SIZE setups.
338 * BH_Boundary explanation:
340 * There is a problem. The mpage read code assembles several pages, gets all
341 * their disk mappings, and then submits them all. That's fine, but obtaining
342 * the disk mappings may require I/O. Reads of indirect blocks, for example.
344 * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
345 * submitted in the following order:
346 * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
348 * because the indirect block has to be read to get the mappings of blocks
349 * 13,14,15,16. Obviously, this impacts performance.
351 * So what we do it to allow the filesystem's get_block() function to set
352 * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block
353 * after this one will require I/O against a block which is probably close to
354 * this one. So you should push what I/O you have currently accumulated.
356 * This all causes the disk requests to be issued in the correct order.
359 mpage_readpages(struct address_space
*mapping
, struct list_head
*pages
,
360 unsigned nr_pages
, get_block_t get_block
)
362 struct bio
*bio
= NULL
;
364 sector_t last_block_in_bio
= 0;
365 struct buffer_head map_bh
;
366 unsigned long first_logical_block
= 0;
367 struct blk_plug plug
;
369 blk_start_plug(&plug
);
373 for (page_idx
= 0; page_idx
< nr_pages
; page_idx
++) {
374 struct page
*page
= list_entry(pages
->prev
, struct page
, lru
);
376 prefetchw(&page
->flags
);
377 list_del(&page
->lru
);
378 if (!add_to_page_cache_lru(page
, mapping
,
379 page
->index
, GFP_KERNEL
)) {
380 bio
= do_mpage_readpage(bio
, page
,
382 &last_block_in_bio
, &map_bh
,
383 &first_logical_block
,
386 page_cache_release(page
);
388 BUG_ON(!list_empty(pages
));
390 mpage_bio_submit(READ
, bio
);
391 blk_finish_plug(&plug
);
394 EXPORT_SYMBOL(mpage_readpages
);
397 * This isn't called much at all
399 int mpage_readpage(struct page
*page
, get_block_t get_block
)
401 struct bio
*bio
= NULL
;
402 sector_t last_block_in_bio
= 0;
403 struct buffer_head map_bh
;
404 unsigned long first_logical_block
= 0;
408 bio
= do_mpage_readpage(bio
, page
, 1, &last_block_in_bio
,
409 &map_bh
, &first_logical_block
, get_block
);
411 mpage_bio_submit(READ
, bio
);
414 EXPORT_SYMBOL(mpage_readpage
);
417 * Writing is not so simple.
419 * If the page has buffers then they will be used for obtaining the disk
420 * mapping. We only support pages which are fully mapped-and-dirty, with a
421 * special case for pages which are unmapped at the end: end-of-file.
423 * If the page has no buffers (preferred) then the page is mapped here.
425 * If all blocks are found to be contiguous then the page can go into the
426 * BIO. Otherwise fall back to the mapping's writepage().
428 * FIXME: This code wants an estimate of how many pages are still to be
429 * written, so it can intelligently allocate a suitably-sized BIO. For now,
430 * just allocate full-size (16-page) BIOs.
435 sector_t last_block_in_bio
;
436 get_block_t
*get_block
;
437 unsigned use_writepage
;
440 static int __mpage_writepage(struct page
*page
, struct writeback_control
*wbc
,
443 struct mpage_data
*mpd
= data
;
444 struct bio
*bio
= mpd
->bio
;
445 struct address_space
*mapping
= page
->mapping
;
446 struct inode
*inode
= page
->mapping
->host
;
447 const unsigned blkbits
= inode
->i_blkbits
;
448 unsigned long end_index
;
449 const unsigned blocks_per_page
= PAGE_CACHE_SIZE
>> blkbits
;
451 sector_t block_in_file
;
452 sector_t blocks
[MAX_BUF_PER_PAGE
];
454 unsigned first_unmapped
= blocks_per_page
;
455 struct block_device
*bdev
= NULL
;
457 sector_t boundary_block
= 0;
458 struct block_device
*boundary_bdev
= NULL
;
460 struct buffer_head map_bh
;
461 loff_t i_size
= i_size_read(inode
);
464 if (page_has_buffers(page
)) {
465 struct buffer_head
*head
= page_buffers(page
);
466 struct buffer_head
*bh
= head
;
468 /* If they're all mapped and dirty, do it */
471 BUG_ON(buffer_locked(bh
));
472 if (!buffer_mapped(bh
)) {
474 * unmapped dirty buffers are created by
475 * __set_page_dirty_buffers -> mmapped data
477 if (buffer_dirty(bh
))
479 if (first_unmapped
== blocks_per_page
)
480 first_unmapped
= page_block
;
484 if (first_unmapped
!= blocks_per_page
)
485 goto confused
; /* hole -> non-hole */
487 if (!buffer_dirty(bh
) || !buffer_uptodate(bh
))
490 if (bh
->b_blocknr
!= blocks
[page_block
-1] + 1)
493 blocks
[page_block
++] = bh
->b_blocknr
;
494 boundary
= buffer_boundary(bh
);
496 boundary_block
= bh
->b_blocknr
;
497 boundary_bdev
= bh
->b_bdev
;
500 } while ((bh
= bh
->b_this_page
) != head
);
506 * Page has buffers, but they are all unmapped. The page was
507 * created by pagein or read over a hole which was handled by
508 * block_read_full_page(). If this address_space is also
509 * using mpage_readpages then this can rarely happen.
515 * The page has no buffers: map it to disk
517 BUG_ON(!PageUptodate(page
));
518 block_in_file
= (sector_t
)page
->index
<< (PAGE_CACHE_SHIFT
- blkbits
);
519 last_block
= (i_size
- 1) >> blkbits
;
520 map_bh
.b_page
= page
;
521 for (page_block
= 0; page_block
< blocks_per_page
; ) {
524 map_bh
.b_size
= 1 << blkbits
;
525 if (mpd
->get_block(inode
, block_in_file
, &map_bh
, 1))
527 if (buffer_new(&map_bh
))
528 unmap_underlying_metadata(map_bh
.b_bdev
,
530 if (buffer_boundary(&map_bh
)) {
531 boundary_block
= map_bh
.b_blocknr
;
532 boundary_bdev
= map_bh
.b_bdev
;
535 if (map_bh
.b_blocknr
!= blocks
[page_block
-1] + 1)
538 blocks
[page_block
++] = map_bh
.b_blocknr
;
539 boundary
= buffer_boundary(&map_bh
);
540 bdev
= map_bh
.b_bdev
;
541 if (block_in_file
== last_block
)
545 BUG_ON(page_block
== 0);
547 first_unmapped
= page_block
;
550 end_index
= i_size
>> PAGE_CACHE_SHIFT
;
551 if (page
->index
>= end_index
) {
553 * The page straddles i_size. It must be zeroed out on each
554 * and every writepage invocation because it may be mmapped.
555 * "A file is mapped in multiples of the page size. For a file
556 * that is not a multiple of the page size, the remaining memory
557 * is zeroed when mapped, and writes to that region are not
558 * written out to the file."
560 unsigned offset
= i_size
& (PAGE_CACHE_SIZE
- 1);
562 if (page
->index
> end_index
|| !offset
)
564 zero_user_segment(page
, offset
, PAGE_CACHE_SIZE
);
568 * This page will go to BIO. Do we need to send this BIO off first?
570 if (bio
&& mpd
->last_block_in_bio
!= blocks
[0] - 1)
571 bio
= mpage_bio_submit(WRITE
, bio
);
575 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
576 bio_get_nr_vecs(bdev
), GFP_NOFS
|__GFP_HIGH
);
582 * Must try to add the page before marking the buffer clean or
583 * the confused fail path above (OOM) will be very confused when
584 * it finds all bh marked clean (i.e. it will not write anything)
586 length
= first_unmapped
<< blkbits
;
587 if (bio_add_page(bio
, page
, length
, 0) < length
) {
588 bio
= mpage_bio_submit(WRITE
, bio
);
593 * OK, we have our BIO, so we can now mark the buffers clean. Make
594 * sure to only clean buffers which we know we'll be writing.
596 if (page_has_buffers(page
)) {
597 struct buffer_head
*head
= page_buffers(page
);
598 struct buffer_head
*bh
= head
;
599 unsigned buffer_counter
= 0;
602 if (buffer_counter
++ == first_unmapped
)
604 clear_buffer_dirty(bh
);
605 bh
= bh
->b_this_page
;
606 } while (bh
!= head
);
609 * we cannot drop the bh if the page is not uptodate
610 * or a concurrent readpage would fail to serialize with the bh
611 * and it would read from disk before we reach the platter.
613 if (buffer_heads_over_limit
&& PageUptodate(page
))
614 try_to_free_buffers(page
);
617 BUG_ON(PageWriteback(page
));
618 set_page_writeback(page
);
620 if (boundary
|| (first_unmapped
!= blocks_per_page
)) {
621 bio
= mpage_bio_submit(WRITE
, bio
);
622 if (boundary_block
) {
623 write_boundary_block(boundary_bdev
,
624 boundary_block
, 1 << blkbits
);
627 mpd
->last_block_in_bio
= blocks
[blocks_per_page
- 1];
633 bio
= mpage_bio_submit(WRITE
, bio
);
635 if (mpd
->use_writepage
) {
636 ret
= mapping
->a_ops
->writepage(page
, wbc
);
642 * The caller has a ref on the inode, so *mapping is stable
644 mapping_set_error(mapping
, ret
);
651 * mpage_writepages - walk the list of dirty pages of the given address space & writepage() all of them
652 * @mapping: address space structure to write
653 * @wbc: subtract the number of written pages from *@wbc->nr_to_write
654 * @get_block: the filesystem's block mapper function.
655 * If this is NULL then use a_ops->writepage. Otherwise, go
658 * This is a library function, which implements the writepages()
659 * address_space_operation.
661 * If a page is already under I/O, generic_writepages() skips it, even
662 * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
663 * but it is INCORRECT for data-integrity system calls such as fsync(). fsync()
664 * and msync() need to guarantee that all the data which was dirty at the time
665 * the call was made get new I/O started against them. If wbc->sync_mode is
666 * WB_SYNC_ALL then we were called for data integrity and we must wait for
667 * existing IO to complete.
670 mpage_writepages(struct address_space
*mapping
,
671 struct writeback_control
*wbc
, get_block_t get_block
)
673 struct blk_plug plug
;
676 blk_start_plug(&plug
);
679 ret
= generic_writepages(mapping
, wbc
);
681 struct mpage_data mpd
= {
683 .last_block_in_bio
= 0,
684 .get_block
= get_block
,
688 ret
= write_cache_pages(mapping
, wbc
, __mpage_writepage
, &mpd
);
690 mpage_bio_submit(WRITE
, mpd
.bio
);
692 blk_finish_plug(&plug
);
695 EXPORT_SYMBOL(mpage_writepages
);
697 int mpage_writepage(struct page
*page
, get_block_t get_block
,
698 struct writeback_control
*wbc
)
700 struct mpage_data mpd
= {
702 .last_block_in_bio
= 0,
703 .get_block
= get_block
,
706 int ret
= __mpage_writepage(page
, wbc
, &mpd
);
708 mpage_bio_submit(WRITE
, mpd
.bio
);
711 EXPORT_SYMBOL(mpage_writepage
);