2 * mm/truncate.c - code for taking down pages from address_spaces
4 * Copyright (C) 2002, Linus Torvalds
6 * 10Sep2002 Andrew Morton
10 #include <linux/kernel.h>
11 #include <linux/backing-dev.h>
12 #include <linux/dax.h>
13 #include <linux/gfp.h>
15 #include <linux/swap.h>
16 #include <linux/export.h>
17 #include <linux/pagemap.h>
18 #include <linux/highmem.h>
19 #include <linux/pagevec.h>
20 #include <linux/task_io_accounting_ops.h>
21 #include <linux/buffer_head.h> /* grr. try_to_release_page,
23 #include <linux/cleancache.h>
24 #include <linux/rmap.h>
27 static void clear_exceptional_entry(struct address_space *mapping,
28 pgoff_t index, void *entry)
30 struct radix_tree_node *node;
33 /* Handled by shmem itself */
34 if (shmem_mapping(mapping))
37 if (dax_mapping(mapping)) {
38 dax_delete_mapping_entry(mapping, index);
41 spin_lock_irq(&mapping->tree_lock);
43 * Regular page slots are stabilized by the page lock even
44 * without the tree itself locked. These unlocked entries
45 * need verification under the tree lock.
47 if (!__radix_tree_lookup(&mapping->page_tree, index, &node,
52 radix_tree_replace_slot(slot, NULL);
53 mapping->nrexceptional--;
56 workingset_node_shadows_dec(node);
58 * Don't track node without shadow entries.
60 * Avoid acquiring the list_lru lock if already untracked.
61 * The list_empty() test is safe as node->private_list is
62 * protected by mapping->tree_lock.
64 if (!workingset_node_shadows(node) &&
65 !list_empty(&node->private_list))
66 list_lru_del(&workingset_shadow_nodes,
68 __radix_tree_delete_node(&mapping->page_tree, node);
70 spin_unlock_irq(&mapping->tree_lock);
74 * do_invalidatepage - invalidate part or all of a page
75 * @page: the page which is affected
76 * @offset: start of the range to invalidate
77 * @length: length of the range to invalidate
79 * do_invalidatepage() is called when all or part of the page has become
80 * invalidated by a truncate operation.
82 * do_invalidatepage() does not have to release all buffers, but it must
83 * ensure that no dirty buffer is left outside @offset and that no I/O
84 * is underway against any of the blocks which are outside the truncation
85 * point. Because the caller is about to free (and possibly reuse) those
88 void do_invalidatepage(struct page *page, unsigned int offset,
91 void (*invalidatepage)(struct page *, unsigned int, unsigned int);
93 invalidatepage = page->mapping->a_ops->invalidatepage;
96 invalidatepage = block_invalidatepage;
99 (*invalidatepage)(page, offset, length);
103 * If truncate cannot remove the fs-private metadata from the page, the page
104 * becomes orphaned. It will be left on the LRU and may even be mapped into
105 * user pagetables if we're racing with filemap_fault().
107 * We need to bale out if page->mapping is no longer equal to the original
108 * mapping. This happens a) when the VM reclaimed the page while we waited on
109 * its lock, b) when a concurrent invalidate_mapping_pages got there first and
110 * c) when tmpfs swizzles a page between a tmpfs inode and swapper_space.
113 truncate_complete_page(struct address_space *mapping, struct page *page)
115 if (page->mapping != mapping)
118 if (page_has_private(page))
119 do_invalidatepage(page, 0, PAGE_SIZE);
122 * Some filesystems seem to re-dirty the page even after
123 * the VM has canceled the dirty bit (eg ext3 journaling).
124 * Hence dirty accounting check is placed after invalidation.
126 cancel_dirty_page(page);
127 ClearPageMappedToDisk(page);
128 delete_from_page_cache(page);
133 * This is for invalidate_mapping_pages(). That function can be called at
134 * any time, and is not supposed to throw away dirty pages. But pages can
135 * be marked dirty at any time too, so use remove_mapping which safely
136 * discards clean, unused pages.
138 * Returns non-zero if the page was successfully invalidated.
141 invalidate_complete_page(struct address_space *mapping, struct page *page)
145 if (page->mapping != mapping)
148 if (page_has_private(page) && !try_to_release_page(page, 0))
151 ret = remove_mapping(mapping, page);
156 int truncate_inode_page(struct address_space *mapping, struct page *page)
159 VM_BUG_ON_PAGE(PageTail(page), page);
161 holelen = PageTransHuge(page) ? HPAGE_PMD_SIZE : PAGE_SIZE;
162 if (page_mapped(page)) {
163 unmap_mapping_range(mapping,
164 (loff_t)page->index << PAGE_SHIFT,
167 return truncate_complete_page(mapping, page);
171 * Used to get rid of pages on hardware memory corruption.
173 int generic_error_remove_page(struct address_space *mapping, struct page *page)
178 * Only punch for normal data pages for now.
179 * Handling other types like directories would need more auditing.
181 if (!S_ISREG(mapping->host->i_mode))
183 return truncate_inode_page(mapping, page);
185 EXPORT_SYMBOL(generic_error_remove_page);
188 * Safely invalidate one page from its pagecache mapping.
189 * It only drops clean, unused pages. The page must be locked.
191 * Returns 1 if the page is successfully invalidated, otherwise 0.
193 int invalidate_inode_page(struct page *page)
195 struct address_space *mapping = page_mapping(page);
198 if (PageDirty(page) || PageWriteback(page))
200 if (page_mapped(page))
202 return invalidate_complete_page(mapping, page);
206 * truncate_inode_pages_range - truncate range of pages specified by start & end byte offsets
207 * @mapping: mapping to truncate
208 * @lstart: offset from which to truncate
209 * @lend: offset to which to truncate (inclusive)
211 * Truncate the page cache, removing the pages that are between
212 * specified offsets (and zeroing out partial pages
213 * if lstart or lend + 1 is not page aligned).
215 * Truncate takes two passes - the first pass is nonblocking. It will not
216 * block on page locks and it will not block on writeback. The second pass
217 * will wait. This is to prevent as much IO as possible in the affected region.
218 * The first pass will remove most pages, so the search cost of the second pass
221 * We pass down the cache-hot hint to the page freeing code. Even if the
222 * mapping is large, it is probably the case that the final pages are the most
223 * recently touched, and freeing happens in ascending file offset order.
225 * Note that since ->invalidatepage() accepts range to invalidate
226 * truncate_inode_pages_range is able to handle cases where lend + 1 is not
227 * page aligned properly.
229 void truncate_inode_pages_range(struct address_space *mapping,
230 loff_t lstart, loff_t lend)
232 pgoff_t start; /* inclusive */
233 pgoff_t end; /* exclusive */
234 unsigned int partial_start; /* inclusive */
235 unsigned int partial_end; /* exclusive */
237 pgoff_t indices[PAGEVEC_SIZE];
241 cleancache_invalidate_inode(mapping);
242 if (mapping->nrpages == 0 && mapping->nrexceptional == 0)
245 /* Offsets within partial pages */
246 partial_start = lstart & (PAGE_SIZE - 1);
247 partial_end = (lend + 1) & (PAGE_SIZE - 1);
250 * 'start' and 'end' always covers the range of pages to be fully
251 * truncated. Partial pages are covered with 'partial_start' at the
252 * start of the range and 'partial_end' at the end of the range.
253 * Note that 'end' is exclusive while 'lend' is inclusive.
255 start = (lstart + PAGE_SIZE - 1) >> PAGE_SHIFT;
258 * lend == -1 indicates end-of-file so we have to set 'end'
259 * to the highest possible pgoff_t and since the type is
260 * unsigned we're using -1.
264 end = (lend + 1) >> PAGE_SHIFT;
266 pagevec_init(&pvec, 0);
268 while (index < end && pagevec_lookup_entries(&pvec, mapping, index,
269 min(end - index, (pgoff_t)PAGEVEC_SIZE),
271 for (i = 0; i < pagevec_count(&pvec); i++) {
272 struct page *page = pvec.pages[i];
274 /* We rely upon deletion not changing page->index */
279 if (radix_tree_exceptional_entry(page)) {
280 clear_exceptional_entry(mapping, index, page);
284 if (!trylock_page(page))
286 WARN_ON(page_to_index(page) != index);
287 if (PageWriteback(page)) {
291 truncate_inode_page(mapping, page);
294 pagevec_remove_exceptionals(&pvec);
295 pagevec_release(&pvec);
301 struct page *page = find_lock_page(mapping, start - 1);
303 unsigned int top = PAGE_SIZE;
305 /* Truncation within a single page */
309 wait_on_page_writeback(page);
310 zero_user_segment(page, partial_start, top);
311 cleancache_invalidate_page(mapping, page);
312 if (page_has_private(page))
313 do_invalidatepage(page, partial_start,
314 top - partial_start);
320 struct page *page = find_lock_page(mapping, end);
322 wait_on_page_writeback(page);
323 zero_user_segment(page, 0, partial_end);
324 cleancache_invalidate_page(mapping, page);
325 if (page_has_private(page))
326 do_invalidatepage(page, 0,
333 * If the truncation happened within a single page no pages
334 * will be released, just zeroed, so we can bail out now.
342 if (!pagevec_lookup_entries(&pvec, mapping, index,
343 min(end - index, (pgoff_t)PAGEVEC_SIZE), indices)) {
344 /* If all gone from start onwards, we're done */
347 /* Otherwise restart to make sure all gone */
351 if (index == start && indices[0] >= end) {
352 /* All gone out of hole to be punched, we're done */
353 pagevec_remove_exceptionals(&pvec);
354 pagevec_release(&pvec);
357 for (i = 0; i < pagevec_count(&pvec); i++) {
358 struct page *page = pvec.pages[i];
360 /* We rely upon deletion not changing page->index */
363 /* Restart punch to make sure all gone */
368 if (radix_tree_exceptional_entry(page)) {
369 clear_exceptional_entry(mapping, index, page);
374 WARN_ON(page_to_index(page) != index);
375 wait_on_page_writeback(page);
376 truncate_inode_page(mapping, page);
379 pagevec_remove_exceptionals(&pvec);
380 pagevec_release(&pvec);
383 cleancache_invalidate_inode(mapping);
385 EXPORT_SYMBOL(truncate_inode_pages_range);
388 * truncate_inode_pages - truncate *all* the pages from an offset
389 * @mapping: mapping to truncate
390 * @lstart: offset from which to truncate
392 * Called under (and serialised by) inode->i_mutex.
394 * Note: When this function returns, there can be a page in the process of
395 * deletion (inside __delete_from_page_cache()) in the specified range. Thus
396 * mapping->nrpages can be non-zero when this function returns even after
397 * truncation of the whole mapping.
399 void truncate_inode_pages(struct address_space *mapping, loff_t lstart)
401 truncate_inode_pages_range(mapping, lstart, (loff_t)-1);
403 EXPORT_SYMBOL(truncate_inode_pages);
406 * truncate_inode_pages_final - truncate *all* pages before inode dies
407 * @mapping: mapping to truncate
409 * Called under (and serialized by) inode->i_mutex.
411 * Filesystems have to use this in the .evict_inode path to inform the
412 * VM that this is the final truncate and the inode is going away.
414 void truncate_inode_pages_final(struct address_space *mapping)
416 unsigned long nrexceptional;
417 unsigned long nrpages;
420 * Page reclaim can not participate in regular inode lifetime
421 * management (can't call iput()) and thus can race with the
422 * inode teardown. Tell it when the address space is exiting,
423 * so that it does not install eviction information after the
424 * final truncate has begun.
426 mapping_set_exiting(mapping);
429 * When reclaim installs eviction entries, it increases
430 * nrexceptional first, then decreases nrpages. Make sure we see
431 * this in the right order or we might miss an entry.
433 nrpages = mapping->nrpages;
435 nrexceptional = mapping->nrexceptional;
437 if (nrpages || nrexceptional) {
439 * As truncation uses a lockless tree lookup, cycle
440 * the tree lock to make sure any ongoing tree
441 * modification that does not see AS_EXITING is
442 * completed before starting the final truncate.
444 spin_lock_irq(&mapping->tree_lock);
445 spin_unlock_irq(&mapping->tree_lock);
447 truncate_inode_pages(mapping, 0);
450 EXPORT_SYMBOL(truncate_inode_pages_final);
453 * invalidate_mapping_pages - Invalidate all the unlocked pages of one inode
454 * @mapping: the address_space which holds the pages to invalidate
455 * @start: the offset 'from' which to invalidate
456 * @end: the offset 'to' which to invalidate (inclusive)
458 * This function only removes the unlocked pages, if you want to
459 * remove all the pages of one inode, you must call truncate_inode_pages.
461 * invalidate_mapping_pages() will not block on IO activity. It will not
462 * invalidate pages which are dirty, locked, under writeback or mapped into
465 unsigned long invalidate_mapping_pages(struct address_space *mapping,
466 pgoff_t start, pgoff_t end)
468 pgoff_t indices[PAGEVEC_SIZE];
470 pgoff_t index = start;
472 unsigned long count = 0;
475 pagevec_init(&pvec, 0);
476 while (index <= end && pagevec_lookup_entries(&pvec, mapping, index,
477 min(end - index, (pgoff_t)PAGEVEC_SIZE - 1) + 1,
479 for (i = 0; i < pagevec_count(&pvec); i++) {
480 struct page *page = pvec.pages[i];
482 /* We rely upon deletion not changing page->index */
487 if (radix_tree_exceptional_entry(page)) {
488 clear_exceptional_entry(mapping, index, page);
492 if (!trylock_page(page))
495 WARN_ON(page_to_index(page) != index);
497 /* Middle of THP: skip */
498 if (PageTransTail(page)) {
501 } else if (PageTransHuge(page)) {
502 index += HPAGE_PMD_NR - 1;
503 i += HPAGE_PMD_NR - 1;
504 /* 'end' is in the middle of THP */
505 if (index == round_down(end, HPAGE_PMD_NR))
509 ret = invalidate_inode_page(page);
512 * Invalidation is a hint that the page is no longer
513 * of interest and try to speed up its reclaim.
516 deactivate_file_page(page);
519 pagevec_remove_exceptionals(&pvec);
520 pagevec_release(&pvec);
526 EXPORT_SYMBOL(invalidate_mapping_pages);
529 * This is like invalidate_complete_page(), except it ignores the page's
530 * refcount. We do this because invalidate_inode_pages2() needs stronger
531 * invalidation guarantees, and cannot afford to leave pages behind because
532 * shrink_page_list() has a temp ref on them, or because they're transiently
533 * sitting in the lru_cache_add() pagevecs.
536 invalidate_complete_page2(struct address_space *mapping, struct page *page)
540 if (page->mapping != mapping)
543 if (page_has_private(page) && !try_to_release_page(page, GFP_KERNEL))
546 spin_lock_irqsave(&mapping->tree_lock, flags);
550 BUG_ON(page_has_private(page));
551 __delete_from_page_cache(page, NULL);
552 spin_unlock_irqrestore(&mapping->tree_lock, flags);
554 if (mapping->a_ops->freepage)
555 mapping->a_ops->freepage(page);
557 put_page(page); /* pagecache ref */
560 spin_unlock_irqrestore(&mapping->tree_lock, flags);
564 static int do_launder_page(struct address_space *mapping, struct page *page)
566 if (!PageDirty(page))
568 if (page->mapping != mapping || mapping->a_ops->launder_page == NULL)
570 return mapping->a_ops->launder_page(page);
574 * invalidate_inode_pages2_range - remove range of pages from an address_space
575 * @mapping: the address_space
576 * @start: the page offset 'from' which to invalidate
577 * @end: the page offset 'to' which to invalidate (inclusive)
579 * Any pages which are found to be mapped into pagetables are unmapped prior to
582 * Returns -EBUSY if any pages could not be invalidated.
584 int invalidate_inode_pages2_range(struct address_space *mapping,
585 pgoff_t start, pgoff_t end)
587 pgoff_t indices[PAGEVEC_SIZE];
593 int did_range_unmap = 0;
595 cleancache_invalidate_inode(mapping);
596 pagevec_init(&pvec, 0);
598 while (index <= end && pagevec_lookup_entries(&pvec, mapping, index,
599 min(end - index, (pgoff_t)PAGEVEC_SIZE - 1) + 1,
601 for (i = 0; i < pagevec_count(&pvec); i++) {
602 struct page *page = pvec.pages[i];
604 /* We rely upon deletion not changing page->index */
609 if (radix_tree_exceptional_entry(page)) {
610 clear_exceptional_entry(mapping, index, page);
615 WARN_ON(page_to_index(page) != index);
616 if (page->mapping != mapping) {
620 wait_on_page_writeback(page);
621 if (page_mapped(page)) {
622 if (!did_range_unmap) {
624 * Zap the rest of the file in one hit.
626 unmap_mapping_range(mapping,
627 (loff_t)index << PAGE_SHIFT,
628 (loff_t)(1 + end - index)
636 unmap_mapping_range(mapping,
637 (loff_t)index << PAGE_SHIFT,
641 BUG_ON(page_mapped(page));
642 ret2 = do_launder_page(mapping, page);
644 if (!invalidate_complete_page2(mapping, page))
651 pagevec_remove_exceptionals(&pvec);
652 pagevec_release(&pvec);
656 cleancache_invalidate_inode(mapping);
659 EXPORT_SYMBOL_GPL(invalidate_inode_pages2_range);
662 * invalidate_inode_pages2 - remove all pages from an address_space
663 * @mapping: the address_space
665 * Any pages which are found to be mapped into pagetables are unmapped prior to
668 * Returns -EBUSY if any pages could not be invalidated.
670 int invalidate_inode_pages2(struct address_space *mapping)
672 return invalidate_inode_pages2_range(mapping, 0, -1);
674 EXPORT_SYMBOL_GPL(invalidate_inode_pages2);
677 * truncate_pagecache - unmap and remove pagecache that has been truncated
679 * @newsize: new file size
681 * inode's new i_size must already be written before truncate_pagecache
684 * This function should typically be called before the filesystem
685 * releases resources associated with the freed range (eg. deallocates
686 * blocks). This way, pagecache will always stay logically coherent
687 * with on-disk format, and the filesystem would not have to deal with
688 * situations such as writepage being called for a page that has already
689 * had its underlying blocks deallocated.
691 void truncate_pagecache(struct inode *inode, loff_t newsize)
693 struct address_space *mapping = inode->i_mapping;
694 loff_t holebegin = round_up(newsize, PAGE_SIZE);
697 * unmap_mapping_range is called twice, first simply for
698 * efficiency so that truncate_inode_pages does fewer
699 * single-page unmaps. However after this first call, and
700 * before truncate_inode_pages finishes, it is possible for
701 * private pages to be COWed, which remain after
702 * truncate_inode_pages finishes, hence the second
703 * unmap_mapping_range call must be made for correctness.
705 unmap_mapping_range(mapping, holebegin, 0, 1);
706 truncate_inode_pages(mapping, newsize);
707 unmap_mapping_range(mapping, holebegin, 0, 1);
709 EXPORT_SYMBOL(truncate_pagecache);
712 * truncate_setsize - update inode and pagecache for a new file size
714 * @newsize: new file size
716 * truncate_setsize updates i_size and performs pagecache truncation (if
717 * necessary) to @newsize. It will be typically be called from the filesystem's
718 * setattr function when ATTR_SIZE is passed in.
720 * Must be called with a lock serializing truncates and writes (generally
721 * i_mutex but e.g. xfs uses a different lock) and before all filesystem
722 * specific block truncation has been performed.
724 void truncate_setsize(struct inode *inode, loff_t newsize)
726 loff_t oldsize = inode->i_size;
728 i_size_write(inode, newsize);
729 if (newsize > oldsize)
730 pagecache_isize_extended(inode, oldsize, newsize);
731 truncate_pagecache(inode, newsize);
733 EXPORT_SYMBOL(truncate_setsize);
736 * pagecache_isize_extended - update pagecache after extension of i_size
737 * @inode: inode for which i_size was extended
738 * @from: original inode size
739 * @to: new inode size
741 * Handle extension of inode size either caused by extending truncate or by
742 * write starting after current i_size. We mark the page straddling current
743 * i_size RO so that page_mkwrite() is called on the nearest write access to
744 * the page. This way filesystem can be sure that page_mkwrite() is called on
745 * the page before user writes to the page via mmap after the i_size has been
748 * The function must be called after i_size is updated so that page fault
749 * coming after we unlock the page will already see the new i_size.
750 * The function must be called while we still hold i_mutex - this not only
751 * makes sure i_size is stable but also that userspace cannot observe new
752 * i_size value before we are prepared to store mmap writes at new inode size.
754 void pagecache_isize_extended(struct inode *inode, loff_t from, loff_t to)
756 int bsize = 1 << inode->i_blkbits;
761 WARN_ON(to > inode->i_size);
763 if (from >= to || bsize == PAGE_SIZE)
765 /* Page straddling @from will not have any hole block created? */
766 rounded_from = round_up(from, bsize);
767 if (to <= rounded_from || !(rounded_from & (PAGE_SIZE - 1)))
770 index = from >> PAGE_SHIFT;
771 page = find_lock_page(inode->i_mapping, index);
772 /* Page not cached? Nothing to do */
776 * See clear_page_dirty_for_io() for details why set_page_dirty()
779 if (page_mkclean(page))
780 set_page_dirty(page);
784 EXPORT_SYMBOL(pagecache_isize_extended);
787 * truncate_pagecache_range - unmap and remove pagecache that is hole-punched
789 * @lstart: offset of beginning of hole
790 * @lend: offset of last byte of hole
792 * This function should typically be called before the filesystem
793 * releases resources associated with the freed range (eg. deallocates
794 * blocks). This way, pagecache will always stay logically coherent
795 * with on-disk format, and the filesystem would not have to deal with
796 * situations such as writepage being called for a page that has already
797 * had its underlying blocks deallocated.
799 void truncate_pagecache_range(struct inode *inode, loff_t lstart, loff_t lend)
801 struct address_space *mapping = inode->i_mapping;
802 loff_t unmap_start = round_up(lstart, PAGE_SIZE);
803 loff_t unmap_end = round_down(1 + lend, PAGE_SIZE) - 1;
805 * This rounding is currently just for example: unmap_mapping_range
806 * expands its hole outwards, whereas we want it to contract the hole
807 * inwards. However, existing callers of truncate_pagecache_range are
808 * doing their own page rounding first. Note that unmap_mapping_range
809 * allows holelen 0 for all, and we allow lend -1 for end of file.
813 * Unlike in truncate_pagecache, unmap_mapping_range is called only
814 * once (before truncating pagecache), and without "even_cows" flag:
815 * hole-punching should not remove private COWed pages from the hole.
817 if ((u64)unmap_end > (u64)unmap_start)
818 unmap_mapping_range(mapping, unmap_start,
819 1 + unmap_end - unmap_start, 0);
820 truncate_inode_pages_range(mapping, lstart, lend);
822 EXPORT_SYMBOL(truncate_pagecache_range);