1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2002, Linus Torvalds.
7 * Contains functions related to preparing and submitting BIOs which contain
8 * multiple pagecache pages.
10 * 15May2002 Andrew Morton
12 * 27Jun2002 axboe@suse.de
13 * use bio_add_page() to build bio's just the right size
16 #include <linux/kernel.h>
17 #include <linux/export.h>
19 #include <linux/kdev_t.h>
20 #include <linux/gfp.h>
21 #include <linux/bio.h>
23 #include <linux/buffer_head.h>
24 #include <linux/blkdev.h>
25 #include <linux/highmem.h>
26 #include <linux/prefetch.h>
27 #include <linux/mpage.h>
28 #include <linux/mm_inline.h>
29 #include <linux/writeback.h>
30 #include <linux/backing-dev.h>
31 #include <linux/pagevec.h>
35 * I/O completion handler for multipage BIOs.
37 * The mpage code never puts partial pages into a BIO (except for end-of-file).
38 * If a page does not map to a contiguous run of blocks then it simply falls
39 * back to block_read_full_page().
41 * Why is this? If a page's completion depends on a number of different BIOs
42 * which can complete in any order (or at the same time) then determining the
43 * status of that page is hard. See end_buffer_async_read() for the details.
44 * There is no point in duplicating all that complexity.
46 static void mpage_end_io(struct bio *bio)
49 struct bvec_iter_all iter_all;
51 bio_for_each_segment_all(bv, bio, iter_all) {
52 struct page *page = bv->bv_page;
53 page_endio(page, bio_op(bio),
54 blk_status_to_errno(bio->bi_status));
60 static struct bio *mpage_bio_submit(int op, int op_flags, struct bio *bio)
62 bio->bi_end_io = mpage_end_io;
63 bio_set_op_attrs(bio, op, op_flags);
70 mpage_alloc(struct block_device *bdev,
71 sector_t first_sector, int nr_vecs,
76 /* Restrict the given (page cache) mask for slab allocations */
77 gfp_flags &= GFP_KERNEL;
78 bio = bio_alloc(gfp_flags, nr_vecs);
80 if (bio == NULL && (current->flags & PF_MEMALLOC)) {
81 while (!bio && (nr_vecs /= 2))
82 bio = bio_alloc(gfp_flags, nr_vecs);
86 bio_set_dev(bio, bdev);
87 bio->bi_iter.bi_sector = first_sector;
93 * support function for mpage_readahead. The fs supplied get_block might
94 * return an up to date buffer. This is used to map that buffer into
95 * the page, which allows readpage to avoid triggering a duplicate call
98 * The idea is to avoid adding buffers to pages that don't already have
99 * them. So when the buffer is up to date and the page size == block size,
100 * this marks the page up to date instead of adding new buffers.
103 map_buffer_to_page(struct page *page, struct buffer_head *bh, int page_block)
105 struct inode *inode = page->mapping->host;
106 struct buffer_head *page_bh, *head;
109 if (!page_has_buffers(page)) {
111 * don't make any buffers if there is only one buffer on
112 * the page and the page just needs to be set up to date
114 if (inode->i_blkbits == PAGE_SHIFT &&
115 buffer_uptodate(bh)) {
116 SetPageUptodate(page);
119 create_empty_buffers(page, i_blocksize(inode), 0);
121 head = page_buffers(page);
124 if (block == page_block) {
125 page_bh->b_state = bh->b_state;
126 page_bh->b_bdev = bh->b_bdev;
127 page_bh->b_blocknr = bh->b_blocknr;
130 page_bh = page_bh->b_this_page;
132 } while (page_bh != head);
135 struct mpage_readpage_args {
138 unsigned int nr_pages;
140 sector_t last_block_in_bio;
141 struct buffer_head map_bh;
142 unsigned long first_logical_block;
143 get_block_t *get_block;
147 * This is the worker routine which does all the work of mapping the disk
148 * blocks and constructs largest possible bios, submits them for IO if the
149 * blocks are not contiguous on the disk.
151 * We pass a buffer_head back and forth and use its buffer_mapped() flag to
152 * represent the validity of its disk mapping and to decide when to do the next
155 static struct bio *do_mpage_readpage(struct mpage_readpage_args *args)
157 struct page *page = args->page;
158 struct inode *inode = page->mapping->host;
159 const unsigned blkbits = inode->i_blkbits;
160 const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
161 const unsigned blocksize = 1 << blkbits;
162 struct buffer_head *map_bh = &args->map_bh;
163 sector_t block_in_file;
165 sector_t last_block_in_file;
166 sector_t blocks[MAX_BUF_PER_PAGE];
168 unsigned first_hole = blocks_per_page;
169 struct block_device *bdev = NULL;
171 int fully_mapped = 1;
174 unsigned relative_block;
177 if (args->is_readahead) {
178 op_flags = REQ_RAHEAD;
179 gfp = readahead_gfp_mask(page->mapping);
182 gfp = mapping_gfp_constraint(page->mapping, GFP_KERNEL);
185 if (page_has_buffers(page))
188 block_in_file = (sector_t)page->index << (PAGE_SHIFT - blkbits);
189 last_block = block_in_file + args->nr_pages * blocks_per_page;
190 last_block_in_file = (i_size_read(inode) + blocksize - 1) >> blkbits;
191 if (last_block > last_block_in_file)
192 last_block = last_block_in_file;
196 * Map blocks using the result from the previous get_blocks call first.
198 nblocks = map_bh->b_size >> blkbits;
199 if (buffer_mapped(map_bh) &&
200 block_in_file > args->first_logical_block &&
201 block_in_file < (args->first_logical_block + nblocks)) {
202 unsigned map_offset = block_in_file - args->first_logical_block;
203 unsigned last = nblocks - map_offset;
205 for (relative_block = 0; ; relative_block++) {
206 if (relative_block == last) {
207 clear_buffer_mapped(map_bh);
210 if (page_block == blocks_per_page)
212 blocks[page_block] = map_bh->b_blocknr + map_offset +
217 bdev = map_bh->b_bdev;
221 * Then do more get_blocks calls until we are done with this page.
223 map_bh->b_page = page;
224 while (page_block < blocks_per_page) {
228 if (block_in_file < last_block) {
229 map_bh->b_size = (last_block-block_in_file) << blkbits;
230 if (args->get_block(inode, block_in_file, map_bh, 0))
232 args->first_logical_block = block_in_file;
235 if (!buffer_mapped(map_bh)) {
237 if (first_hole == blocks_per_page)
238 first_hole = page_block;
244 /* some filesystems will copy data into the page during
245 * the get_block call, in which case we don't want to
246 * read it again. map_buffer_to_page copies the data
247 * we just collected from get_block into the page's buffers
248 * so readpage doesn't have to repeat the get_block call
250 if (buffer_uptodate(map_bh)) {
251 map_buffer_to_page(page, map_bh, page_block);
255 if (first_hole != blocks_per_page)
256 goto confused; /* hole -> non-hole */
258 /* Contiguous blocks? */
259 if (page_block && blocks[page_block-1] != map_bh->b_blocknr-1)
261 nblocks = map_bh->b_size >> blkbits;
262 for (relative_block = 0; ; relative_block++) {
263 if (relative_block == nblocks) {
264 clear_buffer_mapped(map_bh);
266 } else if (page_block == blocks_per_page)
268 blocks[page_block] = map_bh->b_blocknr+relative_block;
272 bdev = map_bh->b_bdev;
275 if (first_hole != blocks_per_page) {
276 zero_user_segment(page, first_hole << blkbits, PAGE_SIZE);
277 if (first_hole == 0) {
278 SetPageUptodate(page);
282 } else if (fully_mapped) {
283 SetPageMappedToDisk(page);
287 * This page will go to BIO. Do we need to send this BIO off first?
289 if (args->bio && (args->last_block_in_bio != blocks[0] - 1))
290 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
293 if (args->bio == NULL) {
294 if (first_hole == blocks_per_page) {
295 if (!bdev_read_page(bdev, blocks[0] << (blkbits - 9),
299 args->bio = mpage_alloc(bdev, blocks[0] << (blkbits - 9),
300 bio_max_segs(args->nr_pages), gfp);
301 if (args->bio == NULL)
305 length = first_hole << blkbits;
306 if (bio_add_page(args->bio, page, length, 0) < length) {
307 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
311 relative_block = block_in_file - args->first_logical_block;
312 nblocks = map_bh->b_size >> blkbits;
313 if ((buffer_boundary(map_bh) && relative_block == nblocks) ||
314 (first_hole != blocks_per_page))
315 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
317 args->last_block_in_bio = blocks[blocks_per_page - 1];
323 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
324 if (!PageUptodate(page))
325 block_read_full_page(page, args->get_block);
332 * mpage_readahead - start reads against pages
333 * @rac: Describes which pages to read.
334 * @get_block: The filesystem's block mapper function.
336 * This function walks the pages and the blocks within each page, building and
337 * emitting large BIOs.
339 * If anything unusual happens, such as:
341 * - encountering a page which has buffers
342 * - encountering a page which has a non-hole after a hole
343 * - encountering a page with non-contiguous blocks
345 * then this code just gives up and calls the buffer_head-based read function.
346 * It does handle a page which has holes at the end - that is a common case:
347 * the end-of-file on blocksize < PAGE_SIZE setups.
349 * BH_Boundary explanation:
351 * There is a problem. The mpage read code assembles several pages, gets all
352 * their disk mappings, and then submits them all. That's fine, but obtaining
353 * the disk mappings may require I/O. Reads of indirect blocks, for example.
355 * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
356 * submitted in the following order:
358 * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
360 * because the indirect block has to be read to get the mappings of blocks
361 * 13,14,15,16. Obviously, this impacts performance.
363 * So what we do it to allow the filesystem's get_block() function to set
364 * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block
365 * after this one will require I/O against a block which is probably close to
366 * this one. So you should push what I/O you have currently accumulated.
368 * This all causes the disk requests to be issued in the correct order.
370 void mpage_readahead(struct readahead_control *rac, get_block_t get_block)
373 struct mpage_readpage_args args = {
374 .get_block = get_block,
375 .is_readahead = true,
378 while ((page = readahead_page(rac))) {
379 prefetchw(&page->flags);
381 args.nr_pages = readahead_count(rac);
382 args.bio = do_mpage_readpage(&args);
386 mpage_bio_submit(REQ_OP_READ, REQ_RAHEAD, args.bio);
388 EXPORT_SYMBOL(mpage_readahead);
391 * This isn't called much at all
393 int mpage_readpage(struct page *page, get_block_t get_block)
395 struct mpage_readpage_args args = {
398 .get_block = get_block,
401 args.bio = do_mpage_readpage(&args);
403 mpage_bio_submit(REQ_OP_READ, 0, args.bio);
406 EXPORT_SYMBOL(mpage_readpage);
409 * Writing is not so simple.
411 * If the page has buffers then they will be used for obtaining the disk
412 * mapping. We only support pages which are fully mapped-and-dirty, with a
413 * special case for pages which are unmapped at the end: end-of-file.
415 * If the page has no buffers (preferred) then the page is mapped here.
417 * If all blocks are found to be contiguous then the page can go into the
418 * BIO. Otherwise fall back to the mapping's writepage().
420 * FIXME: This code wants an estimate of how many pages are still to be
421 * written, so it can intelligently allocate a suitably-sized BIO. For now,
422 * just allocate full-size (16-page) BIOs.
427 sector_t last_block_in_bio;
428 get_block_t *get_block;
429 unsigned use_writepage;
433 * We have our BIO, so we can now mark the buffers clean. Make
434 * sure to only clean buffers which we know we'll be writing.
436 static void clean_buffers(struct page *page, unsigned first_unmapped)
438 unsigned buffer_counter = 0;
439 struct buffer_head *bh, *head;
440 if (!page_has_buffers(page))
442 head = page_buffers(page);
446 if (buffer_counter++ == first_unmapped)
448 clear_buffer_dirty(bh);
449 bh = bh->b_this_page;
450 } while (bh != head);
453 * we cannot drop the bh if the page is not uptodate or a concurrent
454 * readpage would fail to serialize with the bh and it would read from
455 * disk before we reach the platter.
457 if (buffer_heads_over_limit && PageUptodate(page))
458 try_to_free_buffers(page);
462 * For situations where we want to clean all buffers attached to a page.
463 * We don't need to calculate how many buffers are attached to the page,
464 * we just need to specify a number larger than the maximum number of buffers.
466 void clean_page_buffers(struct page *page)
468 clean_buffers(page, ~0U);
471 static int __mpage_writepage(struct page *page, struct writeback_control *wbc,
474 struct mpage_data *mpd = data;
475 struct bio *bio = mpd->bio;
476 struct address_space *mapping = page->mapping;
477 struct inode *inode = page->mapping->host;
478 const unsigned blkbits = inode->i_blkbits;
479 unsigned long end_index;
480 const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
482 sector_t block_in_file;
483 sector_t blocks[MAX_BUF_PER_PAGE];
485 unsigned first_unmapped = blocks_per_page;
486 struct block_device *bdev = NULL;
488 sector_t boundary_block = 0;
489 struct block_device *boundary_bdev = NULL;
491 struct buffer_head map_bh;
492 loff_t i_size = i_size_read(inode);
494 int op_flags = wbc_to_write_flags(wbc);
496 if (page_has_buffers(page)) {
497 struct buffer_head *head = page_buffers(page);
498 struct buffer_head *bh = head;
500 /* If they're all mapped and dirty, do it */
503 BUG_ON(buffer_locked(bh));
504 if (!buffer_mapped(bh)) {
506 * unmapped dirty buffers are created by
507 * __set_page_dirty_buffers -> mmapped data
509 if (buffer_dirty(bh))
511 if (first_unmapped == blocks_per_page)
512 first_unmapped = page_block;
516 if (first_unmapped != blocks_per_page)
517 goto confused; /* hole -> non-hole */
519 if (!buffer_dirty(bh) || !buffer_uptodate(bh))
522 if (bh->b_blocknr != blocks[page_block-1] + 1)
525 blocks[page_block++] = bh->b_blocknr;
526 boundary = buffer_boundary(bh);
528 boundary_block = bh->b_blocknr;
529 boundary_bdev = bh->b_bdev;
532 } while ((bh = bh->b_this_page) != head);
538 * Page has buffers, but they are all unmapped. The page was
539 * created by pagein or read over a hole which was handled by
540 * block_read_full_page(). If this address_space is also
541 * using mpage_readahead then this can rarely happen.
547 * The page has no buffers: map it to disk
549 BUG_ON(!PageUptodate(page));
550 block_in_file = (sector_t)page->index << (PAGE_SHIFT - blkbits);
551 last_block = (i_size - 1) >> blkbits;
552 map_bh.b_page = page;
553 for (page_block = 0; page_block < blocks_per_page; ) {
556 map_bh.b_size = 1 << blkbits;
557 if (mpd->get_block(inode, block_in_file, &map_bh, 1))
559 if (buffer_new(&map_bh))
560 clean_bdev_bh_alias(&map_bh);
561 if (buffer_boundary(&map_bh)) {
562 boundary_block = map_bh.b_blocknr;
563 boundary_bdev = map_bh.b_bdev;
566 if (map_bh.b_blocknr != blocks[page_block-1] + 1)
569 blocks[page_block++] = map_bh.b_blocknr;
570 boundary = buffer_boundary(&map_bh);
571 bdev = map_bh.b_bdev;
572 if (block_in_file == last_block)
576 BUG_ON(page_block == 0);
578 first_unmapped = page_block;
581 end_index = i_size >> PAGE_SHIFT;
582 if (page->index >= end_index) {
584 * The page straddles i_size. It must be zeroed out on each
585 * and every writepage invocation because it may be mmapped.
586 * "A file is mapped in multiples of the page size. For a file
587 * that is not a multiple of the page size, the remaining memory
588 * is zeroed when mapped, and writes to that region are not
589 * written out to the file."
591 unsigned offset = i_size & (PAGE_SIZE - 1);
593 if (page->index > end_index || !offset)
595 zero_user_segment(page, offset, PAGE_SIZE);
599 * This page will go to BIO. Do we need to send this BIO off first?
601 if (bio && mpd->last_block_in_bio != blocks[0] - 1)
602 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
606 if (first_unmapped == blocks_per_page) {
607 if (!bdev_write_page(bdev, blocks[0] << (blkbits - 9),
611 bio = mpage_alloc(bdev, blocks[0] << (blkbits - 9),
612 BIO_MAX_VECS, GFP_NOFS|__GFP_HIGH);
616 wbc_init_bio(wbc, bio);
617 bio->bi_write_hint = inode->i_write_hint;
621 * Must try to add the page before marking the buffer clean or
622 * the confused fail path above (OOM) will be very confused when
623 * it finds all bh marked clean (i.e. it will not write anything)
625 wbc_account_cgroup_owner(wbc, page, PAGE_SIZE);
626 length = first_unmapped << blkbits;
627 if (bio_add_page(bio, page, length, 0) < length) {
628 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
632 clean_buffers(page, first_unmapped);
634 BUG_ON(PageWriteback(page));
635 set_page_writeback(page);
637 if (boundary || (first_unmapped != blocks_per_page)) {
638 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
639 if (boundary_block) {
640 write_boundary_block(boundary_bdev,
641 boundary_block, 1 << blkbits);
644 mpd->last_block_in_bio = blocks[blocks_per_page - 1];
650 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
652 if (mpd->use_writepage) {
653 ret = mapping->a_ops->writepage(page, wbc);
659 * The caller has a ref on the inode, so *mapping is stable
661 mapping_set_error(mapping, ret);
668 * mpage_writepages - walk the list of dirty pages of the given address space & writepage() all of them
669 * @mapping: address space structure to write
670 * @wbc: subtract the number of written pages from *@wbc->nr_to_write
671 * @get_block: the filesystem's block mapper function.
672 * If this is NULL then use a_ops->writepage. Otherwise, go
675 * This is a library function, which implements the writepages()
676 * address_space_operation.
678 * If a page is already under I/O, generic_writepages() skips it, even
679 * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
680 * but it is INCORRECT for data-integrity system calls such as fsync(). fsync()
681 * and msync() need to guarantee that all the data which was dirty at the time
682 * the call was made get new I/O started against them. If wbc->sync_mode is
683 * WB_SYNC_ALL then we were called for data integrity and we must wait for
684 * existing IO to complete.
687 mpage_writepages(struct address_space *mapping,
688 struct writeback_control *wbc, get_block_t get_block)
690 struct blk_plug plug;
693 blk_start_plug(&plug);
696 ret = generic_writepages(mapping, wbc);
698 struct mpage_data mpd = {
700 .last_block_in_bio = 0,
701 .get_block = get_block,
705 ret = write_cache_pages(mapping, wbc, __mpage_writepage, &mpd);
707 int op_flags = (wbc->sync_mode == WB_SYNC_ALL ?
709 mpage_bio_submit(REQ_OP_WRITE, op_flags, mpd.bio);
712 blk_finish_plug(&plug);
715 EXPORT_SYMBOL(mpage_writepages);
717 int mpage_writepage(struct page *page, get_block_t get_block,
718 struct writeback_control *wbc)
720 struct mpage_data mpd = {
722 .last_block_in_bio = 0,
723 .get_block = get_block,
726 int ret = __mpage_writepage(page, wbc, &mpd);
728 int op_flags = (wbc->sync_mode == WB_SYNC_ALL ?
730 mpage_bio_submit(REQ_OP_WRITE, op_flags, mpd.bio);
734 EXPORT_SYMBOL(mpage_writepage);