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/export.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>
30 #include <linux/cleancache.h>
33 * I/O completion handler for multipage BIOs.
35 * The mpage code never puts partial pages into a BIO (except for end-of-file).
36 * If a page does not map to a contiguous run of blocks then it simply falls
37 * back to block_read_full_page().
39 * Why is this? If a page's completion depends on a number of different BIOs
40 * which can complete in any order (or at the same time) then determining the
41 * status of that page is hard. See end_buffer_async_read() for the details.
42 * There is no point in duplicating all that complexity.
44 static void mpage_end_io(struct bio
*bio
, int err
)
49 bio_for_each_segment_all(bv
, bio
, i
) {
50 struct page
*page
= bv
->bv_page
;
52 if (bio_data_dir(bio
) == READ
) {
54 SetPageUptodate(page
);
56 ClearPageUptodate(page
);
60 } else { /* bio_data_dir(bio) == WRITE */
64 set_bit(AS_EIO
, &page
->mapping
->flags
);
66 end_page_writeback(page
);
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_iter
.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
);
274 if (fully_mapped
&& blocks_per_page
== 1 && !PageUptodate(page
) &&
275 cleancache_get_page(page
) == 0) {
276 SetPageUptodate(page
);
281 * This page will go to BIO. Do we need to send this BIO off first?
283 if (bio
&& (*last_block_in_bio
!= blocks
[0] - 1))
284 bio
= mpage_bio_submit(READ
, bio
);
288 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
289 min_t(int, nr_pages
, bio_get_nr_vecs(bdev
)),
295 length
= first_hole
<< blkbits
;
296 if (bio_add_page(bio
, page
, length
, 0) < length
) {
297 bio
= mpage_bio_submit(READ
, bio
);
301 relative_block
= block_in_file
- *first_logical_block
;
302 nblocks
= map_bh
->b_size
>> blkbits
;
303 if ((buffer_boundary(map_bh
) && relative_block
== nblocks
) ||
304 (first_hole
!= blocks_per_page
))
305 bio
= mpage_bio_submit(READ
, bio
);
307 *last_block_in_bio
= blocks
[blocks_per_page
- 1];
313 bio
= mpage_bio_submit(READ
, bio
);
314 if (!PageUptodate(page
))
315 block_read_full_page(page
, get_block
);
322 * mpage_readpages - populate an address space with some pages & start reads against them
323 * @mapping: the address_space
324 * @pages: The address of a list_head which contains the target pages. These
325 * pages have their ->index populated and are otherwise uninitialised.
326 * The page at @pages->prev has the lowest file offset, and reads should be
327 * issued in @pages->prev to @pages->next order.
328 * @nr_pages: The number of pages at *@pages
329 * @get_block: The filesystem's block mapper function.
331 * This function walks the pages and the blocks within each page, building and
332 * emitting large BIOs.
334 * If anything unusual happens, such as:
336 * - encountering a page which has buffers
337 * - encountering a page which has a non-hole after a hole
338 * - encountering a page with non-contiguous blocks
340 * then this code just gives up and calls the buffer_head-based read function.
341 * It does handle a page which has holes at the end - that is a common case:
342 * the end-of-file on blocksize < PAGE_CACHE_SIZE setups.
344 * BH_Boundary explanation:
346 * There is a problem. The mpage read code assembles several pages, gets all
347 * their disk mappings, and then submits them all. That's fine, but obtaining
348 * the disk mappings may require I/O. Reads of indirect blocks, for example.
350 * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
351 * submitted in the following order:
352 * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
354 * because the indirect block has to be read to get the mappings of blocks
355 * 13,14,15,16. Obviously, this impacts performance.
357 * So what we do it to allow the filesystem's get_block() function to set
358 * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block
359 * after this one will require I/O against a block which is probably close to
360 * this one. So you should push what I/O you have currently accumulated.
362 * This all causes the disk requests to be issued in the correct order.
365 mpage_readpages(struct address_space
*mapping
, struct list_head
*pages
,
366 unsigned nr_pages
, get_block_t get_block
)
368 struct bio
*bio
= NULL
;
370 sector_t last_block_in_bio
= 0;
371 struct buffer_head map_bh
;
372 unsigned long first_logical_block
= 0;
376 for (page_idx
= 0; page_idx
< nr_pages
; page_idx
++) {
377 struct page
*page
= list_entry(pages
->prev
, struct page
, lru
);
379 prefetchw(&page
->flags
);
380 list_del(&page
->lru
);
381 if (!add_to_page_cache_lru(page
, mapping
,
382 page
->index
, GFP_KERNEL
)) {
383 bio
= do_mpage_readpage(bio
, page
,
385 &last_block_in_bio
, &map_bh
,
386 &first_logical_block
,
389 page_cache_release(page
);
391 BUG_ON(!list_empty(pages
));
393 mpage_bio_submit(READ
, bio
);
396 EXPORT_SYMBOL(mpage_readpages
);
399 * This isn't called much at all
401 int mpage_readpage(struct page
*page
, get_block_t get_block
)
403 struct bio
*bio
= NULL
;
404 sector_t last_block_in_bio
= 0;
405 struct buffer_head map_bh
;
406 unsigned long first_logical_block
= 0;
410 bio
= do_mpage_readpage(bio
, page
, 1, &last_block_in_bio
,
411 &map_bh
, &first_logical_block
, get_block
);
413 mpage_bio_submit(READ
, bio
);
416 EXPORT_SYMBOL(mpage_readpage
);
419 * Writing is not so simple.
421 * If the page has buffers then they will be used for obtaining the disk
422 * mapping. We only support pages which are fully mapped-and-dirty, with a
423 * special case for pages which are unmapped at the end: end-of-file.
425 * If the page has no buffers (preferred) then the page is mapped here.
427 * If all blocks are found to be contiguous then the page can go into the
428 * BIO. Otherwise fall back to the mapping's writepage().
430 * FIXME: This code wants an estimate of how many pages are still to be
431 * written, so it can intelligently allocate a suitably-sized BIO. For now,
432 * just allocate full-size (16-page) BIOs.
437 sector_t last_block_in_bio
;
438 get_block_t
*get_block
;
439 unsigned use_writepage
;
442 static int __mpage_writepage(struct page
*page
, struct writeback_control
*wbc
,
445 struct mpage_data
*mpd
= data
;
446 struct bio
*bio
= mpd
->bio
;
447 struct address_space
*mapping
= page
->mapping
;
448 struct inode
*inode
= page
->mapping
->host
;
449 const unsigned blkbits
= inode
->i_blkbits
;
450 unsigned long end_index
;
451 const unsigned blocks_per_page
= PAGE_CACHE_SIZE
>> blkbits
;
453 sector_t block_in_file
;
454 sector_t blocks
[MAX_BUF_PER_PAGE
];
456 unsigned first_unmapped
= blocks_per_page
;
457 struct block_device
*bdev
= NULL
;
459 sector_t boundary_block
= 0;
460 struct block_device
*boundary_bdev
= NULL
;
462 struct buffer_head map_bh
;
463 loff_t i_size
= i_size_read(inode
);
466 if (page_has_buffers(page
)) {
467 struct buffer_head
*head
= page_buffers(page
);
468 struct buffer_head
*bh
= head
;
470 /* If they're all mapped and dirty, do it */
473 BUG_ON(buffer_locked(bh
));
474 if (!buffer_mapped(bh
)) {
476 * unmapped dirty buffers are created by
477 * __set_page_dirty_buffers -> mmapped data
479 if (buffer_dirty(bh
))
481 if (first_unmapped
== blocks_per_page
)
482 first_unmapped
= page_block
;
486 if (first_unmapped
!= blocks_per_page
)
487 goto confused
; /* hole -> non-hole */
489 if (!buffer_dirty(bh
) || !buffer_uptodate(bh
))
492 if (bh
->b_blocknr
!= blocks
[page_block
-1] + 1)
495 blocks
[page_block
++] = bh
->b_blocknr
;
496 boundary
= buffer_boundary(bh
);
498 boundary_block
= bh
->b_blocknr
;
499 boundary_bdev
= bh
->b_bdev
;
502 } while ((bh
= bh
->b_this_page
) != head
);
508 * Page has buffers, but they are all unmapped. The page was
509 * created by pagein or read over a hole which was handled by
510 * block_read_full_page(). If this address_space is also
511 * using mpage_readpages then this can rarely happen.
517 * The page has no buffers: map it to disk
519 BUG_ON(!PageUptodate(page
));
520 block_in_file
= (sector_t
)page
->index
<< (PAGE_CACHE_SHIFT
- blkbits
);
521 last_block
= (i_size
- 1) >> blkbits
;
522 map_bh
.b_page
= page
;
523 for (page_block
= 0; page_block
< blocks_per_page
; ) {
526 map_bh
.b_size
= 1 << blkbits
;
527 if (mpd
->get_block(inode
, block_in_file
, &map_bh
, 1))
529 if (buffer_new(&map_bh
))
530 unmap_underlying_metadata(map_bh
.b_bdev
,
532 if (buffer_boundary(&map_bh
)) {
533 boundary_block
= map_bh
.b_blocknr
;
534 boundary_bdev
= map_bh
.b_bdev
;
537 if (map_bh
.b_blocknr
!= blocks
[page_block
-1] + 1)
540 blocks
[page_block
++] = map_bh
.b_blocknr
;
541 boundary
= buffer_boundary(&map_bh
);
542 bdev
= map_bh
.b_bdev
;
543 if (block_in_file
== last_block
)
547 BUG_ON(page_block
== 0);
549 first_unmapped
= page_block
;
552 end_index
= i_size
>> PAGE_CACHE_SHIFT
;
553 if (page
->index
>= end_index
) {
555 * The page straddles i_size. It must be zeroed out on each
556 * and every writepage invocation because it may be mmapped.
557 * "A file is mapped in multiples of the page size. For a file
558 * that is not a multiple of the page size, the remaining memory
559 * is zeroed when mapped, and writes to that region are not
560 * written out to the file."
562 unsigned offset
= i_size
& (PAGE_CACHE_SIZE
- 1);
564 if (page
->index
> end_index
|| !offset
)
566 zero_user_segment(page
, offset
, PAGE_CACHE_SIZE
);
570 * This page will go to BIO. Do we need to send this BIO off first?
572 if (bio
&& mpd
->last_block_in_bio
!= blocks
[0] - 1)
573 bio
= mpage_bio_submit(WRITE
, bio
);
577 bio
= mpage_alloc(bdev
, blocks
[0] << (blkbits
- 9),
578 bio_get_nr_vecs(bdev
), GFP_NOFS
|__GFP_HIGH
);
584 * Must try to add the page before marking the buffer clean or
585 * the confused fail path above (OOM) will be very confused when
586 * it finds all bh marked clean (i.e. it will not write anything)
588 length
= first_unmapped
<< blkbits
;
589 if (bio_add_page(bio
, page
, length
, 0) < length
) {
590 bio
= mpage_bio_submit(WRITE
, bio
);
595 * OK, we have our BIO, so we can now mark the buffers clean. Make
596 * sure to only clean buffers which we know we'll be writing.
598 if (page_has_buffers(page
)) {
599 struct buffer_head
*head
= page_buffers(page
);
600 struct buffer_head
*bh
= head
;
601 unsigned buffer_counter
= 0;
604 if (buffer_counter
++ == first_unmapped
)
606 clear_buffer_dirty(bh
);
607 bh
= bh
->b_this_page
;
608 } while (bh
!= head
);
611 * we cannot drop the bh if the page is not uptodate
612 * or a concurrent readpage would fail to serialize with the bh
613 * and it would read from disk before we reach the platter.
615 if (buffer_heads_over_limit
&& PageUptodate(page
))
616 try_to_free_buffers(page
);
619 BUG_ON(PageWriteback(page
));
620 set_page_writeback(page
);
622 if (boundary
|| (first_unmapped
!= blocks_per_page
)) {
623 bio
= mpage_bio_submit(WRITE
, bio
);
624 if (boundary_block
) {
625 write_boundary_block(boundary_bdev
,
626 boundary_block
, 1 << blkbits
);
629 mpd
->last_block_in_bio
= blocks
[blocks_per_page
- 1];
635 bio
= mpage_bio_submit(WRITE
, bio
);
637 if (mpd
->use_writepage
) {
638 ret
= mapping
->a_ops
->writepage(page
, wbc
);
644 * The caller has a ref on the inode, so *mapping is stable
646 mapping_set_error(mapping
, ret
);
653 * mpage_writepages - walk the list of dirty pages of the given address space & writepage() all of them
654 * @mapping: address space structure to write
655 * @wbc: subtract the number of written pages from *@wbc->nr_to_write
656 * @get_block: the filesystem's block mapper function.
657 * If this is NULL then use a_ops->writepage. Otherwise, go
660 * This is a library function, which implements the writepages()
661 * address_space_operation.
663 * If a page is already under I/O, generic_writepages() skips it, even
664 * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
665 * but it is INCORRECT for data-integrity system calls such as fsync(). fsync()
666 * and msync() need to guarantee that all the data which was dirty at the time
667 * the call was made get new I/O started against them. If wbc->sync_mode is
668 * WB_SYNC_ALL then we were called for data integrity and we must wait for
669 * existing IO to complete.
672 mpage_writepages(struct address_space
*mapping
,
673 struct writeback_control
*wbc
, get_block_t get_block
)
675 struct blk_plug plug
;
678 blk_start_plug(&plug
);
681 ret
= generic_writepages(mapping
, wbc
);
683 struct mpage_data mpd
= {
685 .last_block_in_bio
= 0,
686 .get_block
= get_block
,
690 ret
= write_cache_pages(mapping
, wbc
, __mpage_writepage
, &mpd
);
692 mpage_bio_submit(WRITE
, mpd
.bio
);
694 blk_finish_plug(&plug
);
697 EXPORT_SYMBOL(mpage_writepages
);
699 int mpage_writepage(struct page
*page
, get_block_t get_block
,
700 struct writeback_control
*wbc
)
702 struct mpage_data mpd
= {
704 .last_block_in_bio
= 0,
705 .get_block
= get_block
,
708 int ret
= __mpage_writepage(page
, wbc
, &mpd
);
710 mpage_bio_submit(WRITE
, mpd
.bio
);
713 EXPORT_SYMBOL(mpage_writepage
);