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
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 * support function for mpage_readahead. The fs supplied get_block might
71 * return an up to date buffer. This is used to map that buffer into
72 * the page, which allows readpage to avoid triggering a duplicate call
75 * The idea is to avoid adding buffers to pages that don't already have
76 * them. So when the buffer is up to date and the page size == block size,
77 * this marks the page up to date instead of adding new buffers.
80 map_buffer_to_page(struct page *page, struct buffer_head *bh, int page_block)
82 struct inode *inode = page->mapping->host;
83 struct buffer_head *page_bh, *head;
86 if (!page_has_buffers(page)) {
88 * don't make any buffers if there is only one buffer on
89 * the page and the page just needs to be set up to date
91 if (inode->i_blkbits == PAGE_SHIFT &&
92 buffer_uptodate(bh)) {
93 SetPageUptodate(page);
96 create_empty_buffers(page, i_blocksize(inode), 0);
98 head = page_buffers(page);
101 if (block == page_block) {
102 page_bh->b_state = bh->b_state;
103 page_bh->b_bdev = bh->b_bdev;
104 page_bh->b_blocknr = bh->b_blocknr;
107 page_bh = page_bh->b_this_page;
109 } while (page_bh != head);
112 struct mpage_readpage_args {
115 unsigned int nr_pages;
117 sector_t last_block_in_bio;
118 struct buffer_head map_bh;
119 unsigned long first_logical_block;
120 get_block_t *get_block;
124 * This is the worker routine which does all the work of mapping the disk
125 * blocks and constructs largest possible bios, submits them for IO if the
126 * blocks are not contiguous on the disk.
128 * We pass a buffer_head back and forth and use its buffer_mapped() flag to
129 * represent the validity of its disk mapping and to decide when to do the next
132 static struct bio *do_mpage_readpage(struct mpage_readpage_args *args)
134 struct page *page = args->page;
135 struct inode *inode = page->mapping->host;
136 const unsigned blkbits = inode->i_blkbits;
137 const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
138 const unsigned blocksize = 1 << blkbits;
139 struct buffer_head *map_bh = &args->map_bh;
140 sector_t block_in_file;
142 sector_t last_block_in_file;
143 sector_t blocks[MAX_BUF_PER_PAGE];
145 unsigned first_hole = blocks_per_page;
146 struct block_device *bdev = NULL;
148 int fully_mapped = 1;
151 unsigned relative_block;
154 if (args->is_readahead) {
155 op_flags = REQ_RAHEAD;
156 gfp = readahead_gfp_mask(page->mapping);
159 gfp = mapping_gfp_constraint(page->mapping, GFP_KERNEL);
162 if (page_has_buffers(page))
165 block_in_file = (sector_t)page->index << (PAGE_SHIFT - blkbits);
166 last_block = block_in_file + args->nr_pages * blocks_per_page;
167 last_block_in_file = (i_size_read(inode) + blocksize - 1) >> blkbits;
168 if (last_block > last_block_in_file)
169 last_block = last_block_in_file;
173 * Map blocks using the result from the previous get_blocks call first.
175 nblocks = map_bh->b_size >> blkbits;
176 if (buffer_mapped(map_bh) &&
177 block_in_file > args->first_logical_block &&
178 block_in_file < (args->first_logical_block + nblocks)) {
179 unsigned map_offset = block_in_file - args->first_logical_block;
180 unsigned last = nblocks - map_offset;
182 for (relative_block = 0; ; relative_block++) {
183 if (relative_block == last) {
184 clear_buffer_mapped(map_bh);
187 if (page_block == blocks_per_page)
189 blocks[page_block] = map_bh->b_blocknr + map_offset +
194 bdev = map_bh->b_bdev;
198 * Then do more get_blocks calls until we are done with this page.
200 map_bh->b_page = page;
201 while (page_block < blocks_per_page) {
205 if (block_in_file < last_block) {
206 map_bh->b_size = (last_block-block_in_file) << blkbits;
207 if (args->get_block(inode, block_in_file, map_bh, 0))
209 args->first_logical_block = block_in_file;
212 if (!buffer_mapped(map_bh)) {
214 if (first_hole == blocks_per_page)
215 first_hole = page_block;
221 /* some filesystems will copy data into the page during
222 * the get_block call, in which case we don't want to
223 * read it again. map_buffer_to_page copies the data
224 * we just collected from get_block into the page's buffers
225 * so readpage doesn't have to repeat the get_block call
227 if (buffer_uptodate(map_bh)) {
228 map_buffer_to_page(page, map_bh, page_block);
232 if (first_hole != blocks_per_page)
233 goto confused; /* hole -> non-hole */
235 /* Contiguous blocks? */
236 if (page_block && blocks[page_block-1] != map_bh->b_blocknr-1)
238 nblocks = map_bh->b_size >> blkbits;
239 for (relative_block = 0; ; relative_block++) {
240 if (relative_block == nblocks) {
241 clear_buffer_mapped(map_bh);
243 } else if (page_block == blocks_per_page)
245 blocks[page_block] = map_bh->b_blocknr+relative_block;
249 bdev = map_bh->b_bdev;
252 if (first_hole != blocks_per_page) {
253 zero_user_segment(page, first_hole << blkbits, PAGE_SIZE);
254 if (first_hole == 0) {
255 SetPageUptodate(page);
259 } else if (fully_mapped) {
260 SetPageMappedToDisk(page);
264 * This page will go to BIO. Do we need to send this BIO off first?
266 if (args->bio && (args->last_block_in_bio != blocks[0] - 1))
267 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
270 if (args->bio == NULL) {
271 if (first_hole == blocks_per_page) {
272 if (!bdev_read_page(bdev, blocks[0] << (blkbits - 9),
276 args->bio = bio_alloc(bdev, bio_max_segs(args->nr_pages), 0,
278 if (args->bio == NULL)
280 args->bio->bi_iter.bi_sector = blocks[0] << (blkbits - 9);
283 length = first_hole << blkbits;
284 if (bio_add_page(args->bio, page, length, 0) < length) {
285 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
289 relative_block = block_in_file - args->first_logical_block;
290 nblocks = map_bh->b_size >> blkbits;
291 if ((buffer_boundary(map_bh) && relative_block == nblocks) ||
292 (first_hole != blocks_per_page))
293 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
295 args->last_block_in_bio = blocks[blocks_per_page - 1];
301 args->bio = mpage_bio_submit(REQ_OP_READ, op_flags, args->bio);
302 if (!PageUptodate(page))
303 block_read_full_page(page, args->get_block);
310 * mpage_readahead - start reads against pages
311 * @rac: Describes which pages to read.
312 * @get_block: The filesystem's block mapper function.
314 * This function walks the pages and the blocks within each page, building and
315 * emitting large BIOs.
317 * If anything unusual happens, such as:
319 * - encountering a page which has buffers
320 * - encountering a page which has a non-hole after a hole
321 * - encountering a page with non-contiguous blocks
323 * then this code just gives up and calls the buffer_head-based read function.
324 * It does handle a page which has holes at the end - that is a common case:
325 * the end-of-file on blocksize < PAGE_SIZE setups.
327 * BH_Boundary explanation:
329 * There is a problem. The mpage read code assembles several pages, gets all
330 * their disk mappings, and then submits them all. That's fine, but obtaining
331 * the disk mappings may require I/O. Reads of indirect blocks, for example.
333 * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
334 * submitted in the following order:
336 * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
338 * because the indirect block has to be read to get the mappings of blocks
339 * 13,14,15,16. Obviously, this impacts performance.
341 * So what we do it to allow the filesystem's get_block() function to set
342 * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block
343 * after this one will require I/O against a block which is probably close to
344 * this one. So you should push what I/O you have currently accumulated.
346 * This all causes the disk requests to be issued in the correct order.
348 void mpage_readahead(struct readahead_control *rac, get_block_t get_block)
351 struct mpage_readpage_args args = {
352 .get_block = get_block,
353 .is_readahead = true,
356 while ((page = readahead_page(rac))) {
357 prefetchw(&page->flags);
359 args.nr_pages = readahead_count(rac);
360 args.bio = do_mpage_readpage(&args);
364 mpage_bio_submit(REQ_OP_READ, REQ_RAHEAD, args.bio);
366 EXPORT_SYMBOL(mpage_readahead);
369 * This isn't called much at all
371 int mpage_readpage(struct page *page, get_block_t get_block)
373 struct mpage_readpage_args args = {
376 .get_block = get_block,
379 args.bio = do_mpage_readpage(&args);
381 mpage_bio_submit(REQ_OP_READ, 0, args.bio);
384 EXPORT_SYMBOL(mpage_readpage);
387 * Writing is not so simple.
389 * If the page has buffers then they will be used for obtaining the disk
390 * mapping. We only support pages which are fully mapped-and-dirty, with a
391 * special case for pages which are unmapped at the end: end-of-file.
393 * If the page has no buffers (preferred) then the page is mapped here.
395 * If all blocks are found to be contiguous then the page can go into the
396 * BIO. Otherwise fall back to the mapping's writepage().
398 * FIXME: This code wants an estimate of how many pages are still to be
399 * written, so it can intelligently allocate a suitably-sized BIO. For now,
400 * just allocate full-size (16-page) BIOs.
405 sector_t last_block_in_bio;
406 get_block_t *get_block;
407 unsigned use_writepage;
411 * We have our BIO, so we can now mark the buffers clean. Make
412 * sure to only clean buffers which we know we'll be writing.
414 static void clean_buffers(struct page *page, unsigned first_unmapped)
416 unsigned buffer_counter = 0;
417 struct buffer_head *bh, *head;
418 if (!page_has_buffers(page))
420 head = page_buffers(page);
424 if (buffer_counter++ == first_unmapped)
426 clear_buffer_dirty(bh);
427 bh = bh->b_this_page;
428 } while (bh != head);
431 * we cannot drop the bh if the page is not uptodate or a concurrent
432 * readpage would fail to serialize with the bh and it would read from
433 * disk before we reach the platter.
435 if (buffer_heads_over_limit && PageUptodate(page))
436 try_to_free_buffers(page);
440 * For situations where we want to clean all buffers attached to a page.
441 * We don't need to calculate how many buffers are attached to the page,
442 * we just need to specify a number larger than the maximum number of buffers.
444 void clean_page_buffers(struct page *page)
446 clean_buffers(page, ~0U);
449 static int __mpage_writepage(struct page *page, struct writeback_control *wbc,
452 struct mpage_data *mpd = data;
453 struct bio *bio = mpd->bio;
454 struct address_space *mapping = page->mapping;
455 struct inode *inode = page->mapping->host;
456 const unsigned blkbits = inode->i_blkbits;
457 unsigned long end_index;
458 const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
460 sector_t block_in_file;
461 sector_t blocks[MAX_BUF_PER_PAGE];
463 unsigned first_unmapped = blocks_per_page;
464 struct block_device *bdev = NULL;
466 sector_t boundary_block = 0;
467 struct block_device *boundary_bdev = NULL;
469 struct buffer_head map_bh;
470 loff_t i_size = i_size_read(inode);
472 int op_flags = wbc_to_write_flags(wbc);
474 if (page_has_buffers(page)) {
475 struct buffer_head *head = page_buffers(page);
476 struct buffer_head *bh = head;
478 /* If they're all mapped and dirty, do it */
481 BUG_ON(buffer_locked(bh));
482 if (!buffer_mapped(bh)) {
484 * unmapped dirty buffers are created by
485 * __set_page_dirty_buffers -> mmapped data
487 if (buffer_dirty(bh))
489 if (first_unmapped == blocks_per_page)
490 first_unmapped = page_block;
494 if (first_unmapped != blocks_per_page)
495 goto confused; /* hole -> non-hole */
497 if (!buffer_dirty(bh) || !buffer_uptodate(bh))
500 if (bh->b_blocknr != blocks[page_block-1] + 1)
503 blocks[page_block++] = bh->b_blocknr;
504 boundary = buffer_boundary(bh);
506 boundary_block = bh->b_blocknr;
507 boundary_bdev = bh->b_bdev;
510 } while ((bh = bh->b_this_page) != head);
516 * Page has buffers, but they are all unmapped. The page was
517 * created by pagein or read over a hole which was handled by
518 * block_read_full_page(). If this address_space is also
519 * using mpage_readahead then this can rarely happen.
525 * The page has no buffers: map it to disk
527 BUG_ON(!PageUptodate(page));
528 block_in_file = (sector_t)page->index << (PAGE_SHIFT - blkbits);
529 last_block = (i_size - 1) >> blkbits;
530 map_bh.b_page = page;
531 for (page_block = 0; page_block < blocks_per_page; ) {
534 map_bh.b_size = 1 << blkbits;
535 if (mpd->get_block(inode, block_in_file, &map_bh, 1))
537 if (buffer_new(&map_bh))
538 clean_bdev_bh_alias(&map_bh);
539 if (buffer_boundary(&map_bh)) {
540 boundary_block = map_bh.b_blocknr;
541 boundary_bdev = map_bh.b_bdev;
544 if (map_bh.b_blocknr != blocks[page_block-1] + 1)
547 blocks[page_block++] = map_bh.b_blocknr;
548 boundary = buffer_boundary(&map_bh);
549 bdev = map_bh.b_bdev;
550 if (block_in_file == last_block)
554 BUG_ON(page_block == 0);
556 first_unmapped = page_block;
559 end_index = i_size >> PAGE_SHIFT;
560 if (page->index >= end_index) {
562 * The page straddles i_size. It must be zeroed out on each
563 * and every writepage invocation because it may be mmapped.
564 * "A file is mapped in multiples of the page size. For a file
565 * that is not a multiple of the page size, the remaining memory
566 * is zeroed when mapped, and writes to that region are not
567 * written out to the file."
569 unsigned offset = i_size & (PAGE_SIZE - 1);
571 if (page->index > end_index || !offset)
573 zero_user_segment(page, offset, PAGE_SIZE);
577 * This page will go to BIO. Do we need to send this BIO off first?
579 if (bio && mpd->last_block_in_bio != blocks[0] - 1)
580 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
584 if (first_unmapped == blocks_per_page) {
585 if (!bdev_write_page(bdev, blocks[0] << (blkbits - 9),
589 bio = bio_alloc(bdev, BIO_MAX_VECS, 0, GFP_NOFS);
590 bio->bi_iter.bi_sector = blocks[0] << (blkbits - 9);
592 wbc_init_bio(wbc, bio);
593 bio->bi_write_hint = inode->i_write_hint;
597 * Must try to add the page before marking the buffer clean or
598 * the confused fail path above (OOM) will be very confused when
599 * it finds all bh marked clean (i.e. it will not write anything)
601 wbc_account_cgroup_owner(wbc, page, PAGE_SIZE);
602 length = first_unmapped << blkbits;
603 if (bio_add_page(bio, page, length, 0) < length) {
604 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
608 clean_buffers(page, first_unmapped);
610 BUG_ON(PageWriteback(page));
611 set_page_writeback(page);
613 if (boundary || (first_unmapped != blocks_per_page)) {
614 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
615 if (boundary_block) {
616 write_boundary_block(boundary_bdev,
617 boundary_block, 1 << blkbits);
620 mpd->last_block_in_bio = blocks[blocks_per_page - 1];
626 bio = mpage_bio_submit(REQ_OP_WRITE, op_flags, bio);
628 if (mpd->use_writepage) {
629 ret = mapping->a_ops->writepage(page, wbc);
635 * The caller has a ref on the inode, so *mapping is stable
637 mapping_set_error(mapping, ret);
644 * mpage_writepages - walk the list of dirty pages of the given address space & writepage() all of them
645 * @mapping: address space structure to write
646 * @wbc: subtract the number of written pages from *@wbc->nr_to_write
647 * @get_block: the filesystem's block mapper function.
648 * If this is NULL then use a_ops->writepage. Otherwise, go
651 * This is a library function, which implements the writepages()
652 * address_space_operation.
654 * If a page is already under I/O, generic_writepages() skips it, even
655 * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
656 * but it is INCORRECT for data-integrity system calls such as fsync(). fsync()
657 * and msync() need to guarantee that all the data which was dirty at the time
658 * the call was made get new I/O started against them. If wbc->sync_mode is
659 * WB_SYNC_ALL then we were called for data integrity and we must wait for
660 * existing IO to complete.
663 mpage_writepages(struct address_space *mapping,
664 struct writeback_control *wbc, get_block_t get_block)
666 struct blk_plug plug;
669 blk_start_plug(&plug);
672 ret = generic_writepages(mapping, wbc);
674 struct mpage_data mpd = {
676 .last_block_in_bio = 0,
677 .get_block = get_block,
681 ret = write_cache_pages(mapping, wbc, __mpage_writepage, &mpd);
683 int op_flags = (wbc->sync_mode == WB_SYNC_ALL ?
685 mpage_bio_submit(REQ_OP_WRITE, op_flags, mpd.bio);
688 blk_finish_plug(&plug);
691 EXPORT_SYMBOL(mpage_writepages);
693 int mpage_writepage(struct page *page, get_block_t get_block,
694 struct writeback_control *wbc)
696 struct mpage_data mpd = {
698 .last_block_in_bio = 0,
699 .get_block = get_block,
702 int ret = __mpage_writepage(page, wbc, &mpd);
704 int op_flags = (wbc->sync_mode == WB_SYNC_ALL ?
706 mpage_bio_submit(REQ_OP_WRITE, op_flags, mpd.bio);
710 EXPORT_SYMBOL(mpage_writepage);