1 // SPDX-License-Identifier: GPL-2.0+
3 * Buffer/page management specific to NILFS
5 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
7 * Written by Ryusuke Konishi and Seiji Kihara.
10 #include <linux/pagemap.h>
11 #include <linux/writeback.h>
12 #include <linux/swap.h>
13 #include <linux/bitops.h>
14 #include <linux/page-flags.h>
15 #include <linux/list.h>
16 #include <linux/highmem.h>
17 #include <linux/pagevec.h>
18 #include <linux/gfp.h>
24 #define NILFS_BUFFER_INHERENT_BITS \
25 (BIT(BH_Uptodate) | BIT(BH_Mapped) | BIT(BH_NILFS_Node) | \
26 BIT(BH_NILFS_Volatile) | BIT(BH_NILFS_Checked))
28 static struct buffer_head *
29 __nilfs_get_page_block(struct page *page, unsigned long block, pgoff_t index,
30 int blkbits, unsigned long b_state)
33 unsigned long first_block;
34 struct buffer_head *bh;
36 if (!page_has_buffers(page))
37 create_empty_buffers(page, 1 << blkbits, b_state);
39 first_block = (unsigned long)index << (PAGE_SHIFT - blkbits);
40 bh = nilfs_page_get_nth_block(page, block - first_block);
47 struct buffer_head *nilfs_grab_buffer(struct inode *inode,
48 struct address_space *mapping,
50 unsigned long b_state)
52 int blkbits = inode->i_blkbits;
53 pgoff_t index = blkoff >> (PAGE_SHIFT - blkbits);
55 struct buffer_head *bh;
57 page = grab_cache_page(mapping, index);
61 bh = __nilfs_get_page_block(page, blkoff, index, blkbits, b_state);
71 * nilfs_forget_buffer - discard dirty state
72 * @bh: buffer head of the buffer to be discarded
74 void nilfs_forget_buffer(struct buffer_head *bh)
76 struct page *page = bh->b_page;
77 const unsigned long clear_bits =
78 (BIT(BH_Uptodate) | BIT(BH_Dirty) | BIT(BH_Mapped) |
79 BIT(BH_Async_Write) | BIT(BH_NILFS_Volatile) |
80 BIT(BH_NILFS_Checked) | BIT(BH_NILFS_Redirected));
83 set_mask_bits(&bh->b_state, clear_bits, 0);
84 if (nilfs_page_buffers_clean(page))
85 __nilfs_clear_page_dirty(page);
88 ClearPageUptodate(page);
89 ClearPageMappedToDisk(page);
95 * nilfs_copy_buffer -- copy buffer data and flags
96 * @dbh: destination buffer
99 void nilfs_copy_buffer(struct buffer_head *dbh, struct buffer_head *sbh)
101 void *kaddr0, *kaddr1;
103 struct page *spage = sbh->b_page, *dpage = dbh->b_page;
104 struct buffer_head *bh;
106 kaddr0 = kmap_atomic(spage);
107 kaddr1 = kmap_atomic(dpage);
108 memcpy(kaddr1 + bh_offset(dbh), kaddr0 + bh_offset(sbh), sbh->b_size);
109 kunmap_atomic(kaddr1);
110 kunmap_atomic(kaddr0);
112 dbh->b_state = sbh->b_state & NILFS_BUFFER_INHERENT_BITS;
113 dbh->b_blocknr = sbh->b_blocknr;
114 dbh->b_bdev = sbh->b_bdev;
117 bits = sbh->b_state & (BIT(BH_Uptodate) | BIT(BH_Mapped));
118 while ((bh = bh->b_this_page) != dbh) {
123 if (bits & BIT(BH_Uptodate))
124 SetPageUptodate(dpage);
126 ClearPageUptodate(dpage);
127 if (bits & BIT(BH_Mapped))
128 SetPageMappedToDisk(dpage);
130 ClearPageMappedToDisk(dpage);
134 * nilfs_page_buffers_clean - check if a page has dirty buffers or not.
135 * @page: page to be checked
137 * nilfs_page_buffers_clean() returns zero if the page has dirty buffers.
138 * Otherwise, it returns non-zero value.
140 int nilfs_page_buffers_clean(struct page *page)
142 struct buffer_head *bh, *head;
144 bh = head = page_buffers(page);
146 if (buffer_dirty(bh))
148 bh = bh->b_this_page;
149 } while (bh != head);
153 void nilfs_page_bug(struct page *page)
155 struct address_space *m;
158 if (unlikely(!page)) {
159 printk(KERN_CRIT "NILFS_PAGE_BUG(NULL)\n");
164 ino = m ? m->host->i_ino : 0;
166 printk(KERN_CRIT "NILFS_PAGE_BUG(%p): cnt=%d index#=%llu flags=0x%lx "
167 "mapping=%p ino=%lu\n",
168 page, page_ref_count(page),
169 (unsigned long long)page->index, page->flags, m, ino);
171 if (page_has_buffers(page)) {
172 struct buffer_head *bh, *head;
175 bh = head = page_buffers(page);
178 " BH[%d] %p: cnt=%d block#=%llu state=0x%lx\n",
179 i++, bh, atomic_read(&bh->b_count),
180 (unsigned long long)bh->b_blocknr, bh->b_state);
181 bh = bh->b_this_page;
182 } while (bh != head);
187 * nilfs_copy_page -- copy the page with buffers
188 * @dst: destination page
190 * @copy_dirty: flag whether to copy dirty states on the page's buffer heads.
192 * This function is for both data pages and btnode pages. The dirty flag
193 * should be treated by caller. The page must not be under i/o.
194 * Both src and dst page must be locked
196 static void nilfs_copy_page(struct page *dst, struct page *src, int copy_dirty)
198 struct buffer_head *dbh, *dbufs, *sbh;
199 unsigned long mask = NILFS_BUFFER_INHERENT_BITS;
201 BUG_ON(PageWriteback(dst));
203 sbh = page_buffers(src);
204 if (!page_has_buffers(dst))
205 create_empty_buffers(dst, sbh->b_size, 0);
208 mask |= BIT(BH_Dirty);
210 dbh = dbufs = page_buffers(dst);
214 dbh->b_state = sbh->b_state & mask;
215 dbh->b_blocknr = sbh->b_blocknr;
216 dbh->b_bdev = sbh->b_bdev;
217 sbh = sbh->b_this_page;
218 dbh = dbh->b_this_page;
219 } while (dbh != dbufs);
221 copy_highpage(dst, src);
223 if (PageUptodate(src) && !PageUptodate(dst))
224 SetPageUptodate(dst);
225 else if (!PageUptodate(src) && PageUptodate(dst))
226 ClearPageUptodate(dst);
227 if (PageMappedToDisk(src) && !PageMappedToDisk(dst))
228 SetPageMappedToDisk(dst);
229 else if (!PageMappedToDisk(src) && PageMappedToDisk(dst))
230 ClearPageMappedToDisk(dst);
235 sbh = sbh->b_this_page;
236 dbh = dbh->b_this_page;
237 } while (dbh != dbufs);
240 int nilfs_copy_dirty_pages(struct address_space *dmap,
241 struct address_space *smap)
250 if (!pagevec_lookup_tag(&pvec, smap, &index, PAGECACHE_TAG_DIRTY))
253 for (i = 0; i < pagevec_count(&pvec); i++) {
254 struct page *page = pvec.pages[i], *dpage;
257 if (unlikely(!PageDirty(page)))
258 NILFS_PAGE_BUG(page, "inconsistent dirty state");
260 dpage = grab_cache_page(dmap, page->index);
261 if (unlikely(!dpage)) {
262 /* No empty page is added to the page cache */
267 if (unlikely(!page_has_buffers(page)))
269 "found empty page in dat page cache");
271 nilfs_copy_page(dpage, page, 1);
272 __set_page_dirty_nobuffers(dpage);
278 pagevec_release(&pvec);
287 * nilfs_copy_back_pages -- copy back pages to original cache from shadow cache
288 * @dmap: destination page cache
289 * @smap: source page cache
291 * No pages must be added to the cache during this process.
292 * This must be ensured by the caller.
294 void nilfs_copy_back_pages(struct address_space *dmap,
295 struct address_space *smap)
303 n = pagevec_lookup(&pvec, smap, &index);
307 for (i = 0; i < pagevec_count(&pvec); i++) {
308 struct page *page = pvec.pages[i], *dpage;
309 pgoff_t offset = page->index;
312 dpage = find_lock_page(dmap, offset);
314 /* overwrite existing page in the destination cache */
315 WARN_ON(PageDirty(dpage));
316 nilfs_copy_page(dpage, page, 0);
319 /* Do we not need to remove page from smap here? */
323 /* move the page to the destination cache */
324 xa_lock_irq(&smap->i_pages);
325 p = __xa_erase(&smap->i_pages, offset);
328 xa_unlock_irq(&smap->i_pages);
330 xa_lock_irq(&dmap->i_pages);
331 p = __xa_store(&dmap->i_pages, offset, page, GFP_NOFS);
333 /* Probably -ENOMEM */
334 page->mapping = NULL;
337 page->mapping = dmap;
340 __xa_set_mark(&dmap->i_pages, offset,
341 PAGECACHE_TAG_DIRTY);
343 xa_unlock_irq(&dmap->i_pages);
347 pagevec_release(&pvec);
354 * nilfs_clear_dirty_pages - discard dirty pages in address space
355 * @mapping: address space with dirty pages for discarding
356 * @silent: suppress [true] or print [false] warning messages
358 void nilfs_clear_dirty_pages(struct address_space *mapping, bool silent)
366 while (pagevec_lookup_tag(&pvec, mapping, &index,
367 PAGECACHE_TAG_DIRTY)) {
368 for (i = 0; i < pagevec_count(&pvec); i++) {
369 struct page *page = pvec.pages[i];
372 nilfs_clear_dirty_page(page, silent);
375 pagevec_release(&pvec);
381 * nilfs_clear_dirty_page - discard dirty page
382 * @page: dirty page that will be discarded
383 * @silent: suppress [true] or print [false] warning messages
385 void nilfs_clear_dirty_page(struct page *page, bool silent)
387 struct inode *inode = page->mapping->host;
388 struct super_block *sb = inode->i_sb;
390 BUG_ON(!PageLocked(page));
393 nilfs_warn(sb, "discard dirty page: offset=%lld, ino=%lu",
394 page_offset(page), inode->i_ino);
396 ClearPageUptodate(page);
397 ClearPageMappedToDisk(page);
399 if (page_has_buffers(page)) {
400 struct buffer_head *bh, *head;
401 const unsigned long clear_bits =
402 (BIT(BH_Uptodate) | BIT(BH_Dirty) | BIT(BH_Mapped) |
403 BIT(BH_Async_Write) | BIT(BH_NILFS_Volatile) |
404 BIT(BH_NILFS_Checked) | BIT(BH_NILFS_Redirected));
406 bh = head = page_buffers(page);
411 "discard dirty block: blocknr=%llu, size=%zu",
412 (u64)bh->b_blocknr, bh->b_size);
414 set_mask_bits(&bh->b_state, clear_bits, 0);
416 } while (bh = bh->b_this_page, bh != head);
419 __nilfs_clear_page_dirty(page);
422 unsigned int nilfs_page_count_clean_buffers(struct page *page,
423 unsigned int from, unsigned int to)
425 unsigned int block_start, block_end;
426 struct buffer_head *bh, *head;
429 for (bh = head = page_buffers(page), block_start = 0;
430 bh != head || !block_start;
431 block_start = block_end, bh = bh->b_this_page) {
432 block_end = block_start + bh->b_size;
433 if (block_end > from && block_start < to && !buffer_dirty(bh))
440 * NILFS2 needs clear_page_dirty() in the following two cases:
442 * 1) For B-tree node pages and data pages of DAT file, NILFS2 clears dirty
443 * flag of pages when it copies back pages from shadow cache to the
446 * 2) Some B-tree operations like insertion or deletion may dispose buffers
447 * in dirty state, and this needs to cancel the dirty state of their pages.
449 int __nilfs_clear_page_dirty(struct page *page)
451 struct address_space *mapping = page->mapping;
454 xa_lock_irq(&mapping->i_pages);
455 if (test_bit(PG_dirty, &page->flags)) {
456 __xa_clear_mark(&mapping->i_pages, page_index(page),
457 PAGECACHE_TAG_DIRTY);
458 xa_unlock_irq(&mapping->i_pages);
459 return clear_page_dirty_for_io(page);
461 xa_unlock_irq(&mapping->i_pages);
464 return TestClearPageDirty(page);
468 * nilfs_find_uncommitted_extent - find extent of uncommitted data
470 * @start_blk: start block offset (in)
471 * @blkoff: start offset of the found extent (out)
473 * This function searches an extent of buffers marked "delayed" which
474 * starts from a block offset equal to or larger than @start_blk. If
475 * such an extent was found, this will store the start offset in
476 * @blkoff and return its length in blocks. Otherwise, zero is
479 unsigned long nilfs_find_uncommitted_extent(struct inode *inode,
485 unsigned int nblocks_in_page;
486 unsigned long length = 0;
491 if (inode->i_mapping->nrpages == 0)
494 index = start_blk >> (PAGE_SHIFT - inode->i_blkbits);
495 nblocks_in_page = 1U << (PAGE_SHIFT - inode->i_blkbits);
500 pvec.nr = find_get_pages_contig(inode->i_mapping, index, PAGEVEC_SIZE,
505 if (length > 0 && pvec.pages[0]->index > index)
508 b = pvec.pages[0]->index << (PAGE_SHIFT - inode->i_blkbits);
511 page = pvec.pages[i];
514 if (page_has_buffers(page)) {
515 struct buffer_head *bh, *head;
517 bh = head = page_buffers(page);
521 if (buffer_delay(bh)) {
525 } else if (length > 0) {
528 } while (++b, bh = bh->b_this_page, bh != head);
533 b += nblocks_in_page;
537 } while (++i < pagevec_count(&pvec));
539 index = page->index + 1;
540 pagevec_release(&pvec);
547 pagevec_release(&pvec);