1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1999 Linus Torvalds
6 * Copyright (C) 2002 Christoph Hellwig
9 #include <linux/mman.h>
10 #include <linux/pagemap.h>
11 #include <linux/syscalls.h>
12 #include <linux/mempolicy.h>
13 #include <linux/page-isolation.h>
14 #include <linux/page_idle.h>
15 #include <linux/userfaultfd_k.h>
16 #include <linux/hugetlb.h>
17 #include <linux/falloc.h>
18 #include <linux/fadvise.h>
19 #include <linux/sched.h>
20 #include <linux/sched/mm.h>
21 #include <linux/mm_inline.h>
22 #include <linux/string.h>
23 #include <linux/uio.h>
24 #include <linux/ksm.h>
26 #include <linux/file.h>
27 #include <linux/blkdev.h>
28 #include <linux/backing-dev.h>
29 #include <linux/pagewalk.h>
30 #include <linux/swap.h>
31 #include <linux/swapops.h>
32 #include <linux/shmem_fs.h>
33 #include <linux/mmu_notifier.h>
40 struct madvise_walk_private {
41 struct mmu_gather *tlb;
46 * Any behaviour which results in changes to the vma->vm_flags needs to
47 * take mmap_lock for writing. Others, which simply traverse vmas, need
48 * to only take it for reading.
50 static int madvise_need_mmap_write(int behavior)
56 case MADV_DONTNEED_LOCKED:
60 case MADV_POPULATE_READ:
61 case MADV_POPULATE_WRITE:
65 /* be safe, default to 1. list exceptions explicitly */
70 #ifdef CONFIG_ANON_VMA_NAME
71 struct anon_vma_name *anon_vma_name_alloc(const char *name)
73 struct anon_vma_name *anon_name;
76 /* Add 1 for NUL terminator at the end of the anon_name->name */
77 count = strlen(name) + 1;
78 anon_name = kmalloc(struct_size(anon_name, name, count), GFP_KERNEL);
80 kref_init(&anon_name->kref);
81 memcpy(anon_name->name, name, count);
87 void anon_vma_name_free(struct kref *kref)
89 struct anon_vma_name *anon_name =
90 container_of(kref, struct anon_vma_name, kref);
94 struct anon_vma_name *anon_vma_name(struct vm_area_struct *vma)
96 mmap_assert_locked(vma->vm_mm);
98 return vma->anon_name;
101 /* mmap_lock should be write-locked */
102 static int replace_anon_vma_name(struct vm_area_struct *vma,
103 struct anon_vma_name *anon_name)
105 struct anon_vma_name *orig_name = anon_vma_name(vma);
108 vma->anon_name = NULL;
109 anon_vma_name_put(orig_name);
113 if (anon_vma_name_eq(orig_name, anon_name))
116 vma->anon_name = anon_vma_name_reuse(anon_name);
117 anon_vma_name_put(orig_name);
121 #else /* CONFIG_ANON_VMA_NAME */
122 static int replace_anon_vma_name(struct vm_area_struct *vma,
123 struct anon_vma_name *anon_name)
130 #endif /* CONFIG_ANON_VMA_NAME */
132 * Update the vm_flags on region of a vma, splitting it or merging it as
133 * necessary. Must be called with mmap_lock held for writing;
134 * Caller should ensure anon_name stability by raising its refcount even when
135 * anon_name belongs to a valid vma because this function might free that vma.
137 static int madvise_update_vma(struct vm_area_struct *vma,
138 struct vm_area_struct **prev, unsigned long start,
139 unsigned long end, unsigned long new_flags,
140 struct anon_vma_name *anon_name)
142 struct mm_struct *mm = vma->vm_mm;
146 if (new_flags == vma->vm_flags && anon_vma_name_eq(anon_vma_name(vma), anon_name)) {
151 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
152 *prev = vma_merge(mm, *prev, start, end, new_flags, vma->anon_vma,
153 vma->vm_file, pgoff, vma_policy(vma),
154 vma->vm_userfaultfd_ctx, anon_name);
162 if (start != vma->vm_start) {
163 if (unlikely(mm->map_count >= sysctl_max_map_count))
165 error = __split_vma(mm, vma, start, 1);
170 if (end != vma->vm_end) {
171 if (unlikely(mm->map_count >= sysctl_max_map_count))
173 error = __split_vma(mm, vma, end, 0);
180 * vm_flags is protected by the mmap_lock held in write mode.
182 vma->vm_flags = new_flags;
183 if (!vma->vm_file || vma_is_anon_shmem(vma)) {
184 error = replace_anon_vma_name(vma, anon_name);
193 static int swapin_walk_pmd_entry(pmd_t *pmd, unsigned long start,
194 unsigned long end, struct mm_walk *walk)
196 struct vm_area_struct *vma = walk->private;
198 struct swap_iocb *splug = NULL;
200 if (pmd_none_or_trans_huge_or_clear_bad(pmd))
203 for (index = start; index != end; index += PAGE_SIZE) {
210 ptep = pte_offset_map_lock(vma->vm_mm, pmd, index, &ptl);
212 pte_unmap_unlock(ptep, ptl);
214 if (!is_swap_pte(pte))
216 entry = pte_to_swp_entry(pte);
217 if (unlikely(non_swap_entry(entry)))
220 page = read_swap_cache_async(entry, GFP_HIGHUSER_MOVABLE,
221 vma, index, false, &splug);
225 swap_read_unplug(splug);
231 static const struct mm_walk_ops swapin_walk_ops = {
232 .pmd_entry = swapin_walk_pmd_entry,
235 static void force_shm_swapin_readahead(struct vm_area_struct *vma,
236 unsigned long start, unsigned long end,
237 struct address_space *mapping)
239 XA_STATE(xas, &mapping->i_pages, linear_page_index(vma, start));
240 pgoff_t end_index = linear_page_index(vma, end + PAGE_SIZE - 1);
242 struct swap_iocb *splug = NULL;
245 xas_for_each(&xas, page, end_index) {
248 if (!xa_is_value(page))
250 swap = radix_to_swp_entry(page);
251 /* There might be swapin error entries in shmem mapping. */
252 if (non_swap_entry(swap))
257 page = read_swap_cache_async(swap, GFP_HIGHUSER_MOVABLE,
258 NULL, 0, false, &splug);
265 swap_read_unplug(splug);
267 lru_add_drain(); /* Push any new pages onto the LRU now */
269 #endif /* CONFIG_SWAP */
272 * Schedule all required I/O operations. Do not wait for completion.
274 static long madvise_willneed(struct vm_area_struct *vma,
275 struct vm_area_struct **prev,
276 unsigned long start, unsigned long end)
278 struct mm_struct *mm = vma->vm_mm;
279 struct file *file = vma->vm_file;
285 walk_page_range(vma->vm_mm, start, end, &swapin_walk_ops, vma);
286 lru_add_drain(); /* Push any new pages onto the LRU now */
290 if (shmem_mapping(file->f_mapping)) {
291 force_shm_swapin_readahead(vma, start, end,
300 if (IS_DAX(file_inode(file))) {
301 /* no bad return value, but ignore advice */
306 * Filesystem's fadvise may need to take various locks. We need to
307 * explicitly grab a reference because the vma (and hence the
308 * vma's reference to the file) can go away as soon as we drop
311 *prev = NULL; /* tell sys_madvise we drop mmap_lock */
313 offset = (loff_t)(start - vma->vm_start)
314 + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
315 mmap_read_unlock(mm);
316 vfs_fadvise(file, offset, end - start, POSIX_FADV_WILLNEED);
322 static inline bool can_do_file_pageout(struct vm_area_struct *vma)
327 * paging out pagecache only for non-anonymous mappings that correspond
328 * to the files the calling process could (if tried) open for writing;
329 * otherwise we'd be including shared non-exclusive mappings, which
330 * opens a side channel.
332 return inode_owner_or_capable(&init_user_ns,
333 file_inode(vma->vm_file)) ||
334 file_permission(vma->vm_file, MAY_WRITE) == 0;
337 static int madvise_cold_or_pageout_pte_range(pmd_t *pmd,
338 unsigned long addr, unsigned long end,
339 struct mm_walk *walk)
341 struct madvise_walk_private *private = walk->private;
342 struct mmu_gather *tlb = private->tlb;
343 bool pageout = private->pageout;
344 struct mm_struct *mm = tlb->mm;
345 struct vm_area_struct *vma = walk->vma;
346 pte_t *orig_pte, *pte, ptent;
348 struct page *page = NULL;
349 LIST_HEAD(page_list);
350 bool pageout_anon_only_filter;
352 if (fatal_signal_pending(current))
355 pageout_anon_only_filter = pageout && !vma_is_anonymous(vma) &&
356 !can_do_file_pageout(vma);
358 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
359 if (pmd_trans_huge(*pmd)) {
361 unsigned long next = pmd_addr_end(addr, end);
363 tlb_change_page_size(tlb, HPAGE_PMD_SIZE);
364 ptl = pmd_trans_huge_lock(pmd, vma);
369 if (is_huge_zero_pmd(orig_pmd))
372 if (unlikely(!pmd_present(orig_pmd))) {
373 VM_BUG_ON(thp_migration_supported() &&
374 !is_pmd_migration_entry(orig_pmd));
378 page = pmd_page(orig_pmd);
380 /* Do not interfere with other mappings of this page */
381 if (page_mapcount(page) != 1)
384 if (pageout_anon_only_filter && !PageAnon(page))
387 if (next - addr != HPAGE_PMD_SIZE) {
393 err = split_huge_page(page);
401 if (pmd_young(orig_pmd)) {
402 pmdp_invalidate(vma, addr, pmd);
403 orig_pmd = pmd_mkold(orig_pmd);
405 set_pmd_at(mm, addr, pmd, orig_pmd);
406 tlb_remove_pmd_tlb_entry(tlb, pmd, addr);
409 ClearPageReferenced(page);
410 test_and_clear_page_young(page);
412 if (!isolate_lru_page(page)) {
413 if (PageUnevictable(page))
414 putback_lru_page(page);
416 list_add(&page->lru, &page_list);
419 deactivate_page(page);
423 reclaim_pages(&page_list);
428 if (pmd_trans_unstable(pmd))
431 tlb_change_page_size(tlb, PAGE_SIZE);
432 orig_pte = pte = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
433 flush_tlb_batched_pending(mm);
434 arch_enter_lazy_mmu_mode();
435 for (; addr < end; pte++, addr += PAGE_SIZE) {
441 if (!pte_present(ptent))
444 page = vm_normal_page(vma, addr, ptent);
445 if (!page || is_zone_device_page(page))
449 * Creating a THP page is expensive so split it only if we
450 * are sure it's worth. Split it if we are only owner.
452 if (PageTransCompound(page)) {
453 if (page_mapcount(page) != 1)
455 if (pageout_anon_only_filter && !PageAnon(page))
458 if (!trylock_page(page)) {
462 pte_unmap_unlock(orig_pte, ptl);
463 if (split_huge_page(page)) {
466 orig_pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
471 orig_pte = pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
478 * Do not interfere with other mappings of this page and
481 if (!PageLRU(page) || page_mapcount(page) != 1)
484 if (pageout_anon_only_filter && !PageAnon(page))
487 VM_BUG_ON_PAGE(PageTransCompound(page), page);
489 if (pte_young(ptent)) {
490 ptent = ptep_get_and_clear_full(mm, addr, pte,
492 ptent = pte_mkold(ptent);
493 set_pte_at(mm, addr, pte, ptent);
494 tlb_remove_tlb_entry(tlb, pte, addr);
498 * We are deactivating a page for accelerating reclaiming.
499 * VM couldn't reclaim the page unless we clear PG_young.
500 * As a side effect, it makes confuse idle-page tracking
501 * because they will miss recent referenced history.
503 ClearPageReferenced(page);
504 test_and_clear_page_young(page);
506 if (!isolate_lru_page(page)) {
507 if (PageUnevictable(page))
508 putback_lru_page(page);
510 list_add(&page->lru, &page_list);
513 deactivate_page(page);
516 arch_leave_lazy_mmu_mode();
517 pte_unmap_unlock(orig_pte, ptl);
519 reclaim_pages(&page_list);
525 static const struct mm_walk_ops cold_walk_ops = {
526 .pmd_entry = madvise_cold_or_pageout_pte_range,
529 static void madvise_cold_page_range(struct mmu_gather *tlb,
530 struct vm_area_struct *vma,
531 unsigned long addr, unsigned long end)
533 struct madvise_walk_private walk_private = {
538 tlb_start_vma(tlb, vma);
539 walk_page_range(vma->vm_mm, addr, end, &cold_walk_ops, &walk_private);
540 tlb_end_vma(tlb, vma);
543 static inline bool can_madv_lru_vma(struct vm_area_struct *vma)
545 return !(vma->vm_flags & (VM_LOCKED|VM_PFNMAP|VM_HUGETLB));
548 static long madvise_cold(struct vm_area_struct *vma,
549 struct vm_area_struct **prev,
550 unsigned long start_addr, unsigned long end_addr)
552 struct mm_struct *mm = vma->vm_mm;
553 struct mmu_gather tlb;
556 if (!can_madv_lru_vma(vma))
560 tlb_gather_mmu(&tlb, mm);
561 madvise_cold_page_range(&tlb, vma, start_addr, end_addr);
562 tlb_finish_mmu(&tlb);
567 static void madvise_pageout_page_range(struct mmu_gather *tlb,
568 struct vm_area_struct *vma,
569 unsigned long addr, unsigned long end)
571 struct madvise_walk_private walk_private = {
576 tlb_start_vma(tlb, vma);
577 walk_page_range(vma->vm_mm, addr, end, &cold_walk_ops, &walk_private);
578 tlb_end_vma(tlb, vma);
581 static long madvise_pageout(struct vm_area_struct *vma,
582 struct vm_area_struct **prev,
583 unsigned long start_addr, unsigned long end_addr)
585 struct mm_struct *mm = vma->vm_mm;
586 struct mmu_gather tlb;
589 if (!can_madv_lru_vma(vma))
593 * If the VMA belongs to a private file mapping, there can be private
594 * dirty pages which can be paged out if even this process is neither
595 * owner nor write capable of the file. We allow private file mappings
596 * further to pageout dirty anon pages.
598 if (!vma_is_anonymous(vma) && (!can_do_file_pageout(vma) &&
599 (vma->vm_flags & VM_MAYSHARE)))
603 tlb_gather_mmu(&tlb, mm);
604 madvise_pageout_page_range(&tlb, vma, start_addr, end_addr);
605 tlb_finish_mmu(&tlb);
610 static int madvise_free_pte_range(pmd_t *pmd, unsigned long addr,
611 unsigned long end, struct mm_walk *walk)
614 struct mmu_gather *tlb = walk->private;
615 struct mm_struct *mm = tlb->mm;
616 struct vm_area_struct *vma = walk->vma;
618 pte_t *orig_pte, *pte, ptent;
624 next = pmd_addr_end(addr, end);
625 if (pmd_trans_huge(*pmd))
626 if (madvise_free_huge_pmd(tlb, vma, pmd, addr, next))
629 if (pmd_trans_unstable(pmd))
632 tlb_change_page_size(tlb, PAGE_SIZE);
633 orig_pte = pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
634 flush_tlb_batched_pending(mm);
635 arch_enter_lazy_mmu_mode();
636 for (; addr != end; pte++, addr += PAGE_SIZE) {
642 * If the pte has swp_entry, just clear page table to
643 * prevent swap-in which is more expensive rather than
644 * (page allocation + zeroing).
646 if (!pte_present(ptent)) {
649 entry = pte_to_swp_entry(ptent);
650 if (!non_swap_entry(entry)) {
652 free_swap_and_cache(entry);
653 pte_clear_not_present_full(mm, addr, pte, tlb->fullmm);
654 } else if (is_hwpoison_entry(entry) ||
655 is_swapin_error_entry(entry)) {
656 pte_clear_not_present_full(mm, addr, pte, tlb->fullmm);
661 page = vm_normal_page(vma, addr, ptent);
662 if (!page || is_zone_device_page(page))
664 folio = page_folio(page);
667 * If pmd isn't transhuge but the folio is large and
668 * is owned by only this process, split it and
669 * deactivate all pages.
671 if (folio_test_large(folio)) {
672 if (folio_mapcount(folio) != 1)
675 if (!folio_trylock(folio)) {
679 pte_unmap_unlock(orig_pte, ptl);
680 if (split_folio(folio)) {
683 orig_pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
688 orig_pte = pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
694 if (folio_test_swapcache(folio) || folio_test_dirty(folio)) {
695 if (!folio_trylock(folio))
698 * If folio is shared with others, we mustn't clear
699 * the folio's dirty flag.
701 if (folio_mapcount(folio) != 1) {
706 if (folio_test_swapcache(folio) &&
707 !folio_free_swap(folio)) {
712 folio_clear_dirty(folio);
716 if (pte_young(ptent) || pte_dirty(ptent)) {
718 * Some of architecture(ex, PPC) don't update TLB
719 * with set_pte_at and tlb_remove_tlb_entry so for
720 * the portability, remap the pte with old|clean
721 * after pte clearing.
723 ptent = ptep_get_and_clear_full(mm, addr, pte,
726 ptent = pte_mkold(ptent);
727 ptent = pte_mkclean(ptent);
728 set_pte_at(mm, addr, pte, ptent);
729 tlb_remove_tlb_entry(tlb, pte, addr);
731 mark_page_lazyfree(&folio->page);
735 if (current->mm == mm)
738 add_mm_counter(mm, MM_SWAPENTS, nr_swap);
740 arch_leave_lazy_mmu_mode();
741 pte_unmap_unlock(orig_pte, ptl);
747 static const struct mm_walk_ops madvise_free_walk_ops = {
748 .pmd_entry = madvise_free_pte_range,
751 static int madvise_free_single_vma(struct vm_area_struct *vma,
752 unsigned long start_addr, unsigned long end_addr)
754 struct mm_struct *mm = vma->vm_mm;
755 struct mmu_notifier_range range;
756 struct mmu_gather tlb;
758 /* MADV_FREE works for only anon vma at the moment */
759 if (!vma_is_anonymous(vma))
762 range.start = max(vma->vm_start, start_addr);
763 if (range.start >= vma->vm_end)
765 range.end = min(vma->vm_end, end_addr);
766 if (range.end <= vma->vm_start)
768 mmu_notifier_range_init(&range, MMU_NOTIFY_CLEAR, 0, vma, mm,
769 range.start, range.end);
772 tlb_gather_mmu(&tlb, mm);
773 update_hiwater_rss(mm);
775 mmu_notifier_invalidate_range_start(&range);
776 tlb_start_vma(&tlb, vma);
777 walk_page_range(vma->vm_mm, range.start, range.end,
778 &madvise_free_walk_ops, &tlb);
779 tlb_end_vma(&tlb, vma);
780 mmu_notifier_invalidate_range_end(&range);
781 tlb_finish_mmu(&tlb);
787 * Application no longer needs these pages. If the pages are dirty,
788 * it's OK to just throw them away. The app will be more careful about
789 * data it wants to keep. Be sure to free swap resources too. The
790 * zap_page_range_single call sets things up for shrink_active_list to actually
791 * free these pages later if no one else has touched them in the meantime,
792 * although we could add these pages to a global reuse list for
793 * shrink_active_list to pick up before reclaiming other pages.
795 * NB: This interface discards data rather than pushes it out to swap,
796 * as some implementations do. This has performance implications for
797 * applications like large transactional databases which want to discard
798 * pages in anonymous maps after committing to backing store the data
799 * that was kept in them. There is no reason to write this data out to
800 * the swap area if the application is discarding it.
802 * An interface that causes the system to free clean pages and flush
803 * dirty pages is already available as msync(MS_INVALIDATE).
805 static long madvise_dontneed_single_vma(struct vm_area_struct *vma,
806 unsigned long start, unsigned long end)
808 zap_page_range_single(vma, start, end - start, NULL);
812 static bool madvise_dontneed_free_valid_vma(struct vm_area_struct *vma,
817 if (!is_vm_hugetlb_page(vma)) {
818 unsigned int forbidden = VM_PFNMAP;
820 if (behavior != MADV_DONTNEED_LOCKED)
821 forbidden |= VM_LOCKED;
823 return !(vma->vm_flags & forbidden);
826 if (behavior != MADV_DONTNEED && behavior != MADV_DONTNEED_LOCKED)
828 if (start & ~huge_page_mask(hstate_vma(vma)))
832 * Madvise callers expect the length to be rounded up to PAGE_SIZE
833 * boundaries, and may be unaware that this VMA uses huge pages.
834 * Avoid unexpected data loss by rounding down the number of
837 *end = ALIGN_DOWN(*end, huge_page_size(hstate_vma(vma)));
842 static long madvise_dontneed_free(struct vm_area_struct *vma,
843 struct vm_area_struct **prev,
844 unsigned long start, unsigned long end,
847 struct mm_struct *mm = vma->vm_mm;
850 if (!madvise_dontneed_free_valid_vma(vma, start, &end, behavior))
856 if (!userfaultfd_remove(vma, start, end)) {
857 *prev = NULL; /* mmap_lock has been dropped, prev is stale */
860 vma = find_vma(mm, start);
863 if (start < vma->vm_start) {
865 * This "vma" under revalidation is the one
866 * with the lowest vma->vm_start where start
867 * is also < vma->vm_end. If start <
868 * vma->vm_start it means an hole materialized
869 * in the user address space within the
870 * virtual range passed to MADV_DONTNEED
876 * Potential end adjustment for hugetlb vma is OK as
877 * the check below keeps end within vma.
879 if (!madvise_dontneed_free_valid_vma(vma, start, &end,
882 if (end > vma->vm_end) {
884 * Don't fail if end > vma->vm_end. If the old
885 * vma was split while the mmap_lock was
886 * released the effect of the concurrent
887 * operation may not cause madvise() to
888 * have an undefined result. There may be an
889 * adjacent next vma that we'll walk
890 * next. userfaultfd_remove() will generate an
891 * UFFD_EVENT_REMOVE repetition on the
892 * end-vma->vm_end range, but the manager can
893 * handle a repetition fine.
897 VM_WARN_ON(start >= end);
900 if (behavior == MADV_DONTNEED || behavior == MADV_DONTNEED_LOCKED)
901 return madvise_dontneed_single_vma(vma, start, end);
902 else if (behavior == MADV_FREE)
903 return madvise_free_single_vma(vma, start, end);
908 static long madvise_populate(struct vm_area_struct *vma,
909 struct vm_area_struct **prev,
910 unsigned long start, unsigned long end,
913 const bool write = behavior == MADV_POPULATE_WRITE;
914 struct mm_struct *mm = vma->vm_mm;
915 unsigned long tmp_end;
921 while (start < end) {
923 * We might have temporarily dropped the lock. For example,
924 * our VMA might have been split.
926 if (!vma || start >= vma->vm_end) {
927 vma = vma_lookup(mm, start);
932 tmp_end = min_t(unsigned long, end, vma->vm_end);
933 /* Populate (prefault) page tables readable/writable. */
934 pages = faultin_vma_page_range(vma, start, tmp_end, write,
946 case -EINVAL: /* Incompatible mappings / permissions. */
950 case -EFAULT: /* VM_FAULT_SIGBUS or VM_FAULT_SIGSEGV */
953 pr_warn_once("%s: unhandled return value: %ld\n",
960 start += pages * PAGE_SIZE;
966 * Application wants to free up the pages and associated backing store.
967 * This is effectively punching a hole into the middle of a file.
969 static long madvise_remove(struct vm_area_struct *vma,
970 struct vm_area_struct **prev,
971 unsigned long start, unsigned long end)
976 struct mm_struct *mm = vma->vm_mm;
978 *prev = NULL; /* tell sys_madvise we drop mmap_lock */
980 if (vma->vm_flags & VM_LOCKED)
985 if (!f || !f->f_mapping || !f->f_mapping->host) {
989 if ((vma->vm_flags & (VM_SHARED|VM_WRITE)) != (VM_SHARED|VM_WRITE))
992 offset = (loff_t)(start - vma->vm_start)
993 + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
996 * Filesystem's fallocate may need to take i_rwsem. We need to
997 * explicitly grab a reference because the vma (and hence the
998 * vma's reference to the file) can go away as soon as we drop
1002 if (userfaultfd_remove(vma, start, end)) {
1003 /* mmap_lock was not released by userfaultfd_remove() */
1004 mmap_read_unlock(mm);
1006 error = vfs_fallocate(f,
1007 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1008 offset, end - start);
1015 * Apply an madvise behavior to a region of a vma. madvise_update_vma
1016 * will handle splitting a vm area into separate areas, each area with its own
1019 static int madvise_vma_behavior(struct vm_area_struct *vma,
1020 struct vm_area_struct **prev,
1021 unsigned long start, unsigned long end,
1022 unsigned long behavior)
1025 struct anon_vma_name *anon_name;
1026 unsigned long new_flags = vma->vm_flags;
1030 return madvise_remove(vma, prev, start, end);
1032 return madvise_willneed(vma, prev, start, end);
1034 return madvise_cold(vma, prev, start, end);
1036 return madvise_pageout(vma, prev, start, end);
1039 case MADV_DONTNEED_LOCKED:
1040 return madvise_dontneed_free(vma, prev, start, end, behavior);
1041 case MADV_POPULATE_READ:
1042 case MADV_POPULATE_WRITE:
1043 return madvise_populate(vma, prev, start, end, behavior);
1045 new_flags = new_flags & ~VM_RAND_READ & ~VM_SEQ_READ;
1047 case MADV_SEQUENTIAL:
1048 new_flags = (new_flags & ~VM_RAND_READ) | VM_SEQ_READ;
1051 new_flags = (new_flags & ~VM_SEQ_READ) | VM_RAND_READ;
1054 new_flags |= VM_DONTCOPY;
1057 if (vma->vm_flags & VM_IO)
1059 new_flags &= ~VM_DONTCOPY;
1061 case MADV_WIPEONFORK:
1062 /* MADV_WIPEONFORK is only supported on anonymous memory. */
1063 if (vma->vm_file || vma->vm_flags & VM_SHARED)
1065 new_flags |= VM_WIPEONFORK;
1067 case MADV_KEEPONFORK:
1068 new_flags &= ~VM_WIPEONFORK;
1071 new_flags |= VM_DONTDUMP;
1074 if (!is_vm_hugetlb_page(vma) && new_flags & VM_SPECIAL)
1076 new_flags &= ~VM_DONTDUMP;
1078 case MADV_MERGEABLE:
1079 case MADV_UNMERGEABLE:
1080 error = ksm_madvise(vma, start, end, behavior, &new_flags);
1085 case MADV_NOHUGEPAGE:
1086 error = hugepage_madvise(vma, &new_flags, behavior);
1091 return madvise_collapse(vma, prev, start, end);
1094 anon_name = anon_vma_name(vma);
1095 anon_vma_name_get(anon_name);
1096 error = madvise_update_vma(vma, prev, start, end, new_flags,
1098 anon_vma_name_put(anon_name);
1102 * madvise() returns EAGAIN if kernel resources, such as
1103 * slab, are temporarily unavailable.
1105 if (error == -ENOMEM)
1110 #ifdef CONFIG_MEMORY_FAILURE
1112 * Error injection support for memory error handling.
1114 static int madvise_inject_error(int behavior,
1115 unsigned long start, unsigned long end)
1119 if (!capable(CAP_SYS_ADMIN))
1123 for (; start < end; start += size) {
1128 ret = get_user_pages_fast(start, 1, 0, &page);
1131 pfn = page_to_pfn(page);
1134 * When soft offlining hugepages, after migrating the page
1135 * we dissolve it, therefore in the second loop "page" will
1136 * no longer be a compound page.
1138 size = page_size(compound_head(page));
1140 if (behavior == MADV_SOFT_OFFLINE) {
1141 pr_info("Soft offlining pfn %#lx at process virtual address %#lx\n",
1143 ret = soft_offline_page(pfn, MF_COUNT_INCREASED);
1145 pr_info("Injecting memory failure for pfn %#lx at process virtual address %#lx\n",
1147 ret = memory_failure(pfn, MF_COUNT_INCREASED | MF_SW_SIMULATED);
1148 if (ret == -EOPNOTSUPP)
1161 madvise_behavior_valid(int behavior)
1167 case MADV_SEQUENTIAL:
1172 case MADV_DONTNEED_LOCKED:
1176 case MADV_POPULATE_READ:
1177 case MADV_POPULATE_WRITE:
1179 case MADV_MERGEABLE:
1180 case MADV_UNMERGEABLE:
1182 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1184 case MADV_NOHUGEPAGE:
1189 case MADV_WIPEONFORK:
1190 case MADV_KEEPONFORK:
1191 #ifdef CONFIG_MEMORY_FAILURE
1192 case MADV_SOFT_OFFLINE:
1202 static bool process_madvise_behavior_valid(int behavior)
1216 * Walk the vmas in range [start,end), and call the visit function on each one.
1217 * The visit function will get start and end parameters that cover the overlap
1218 * between the current vma and the original range. Any unmapped regions in the
1219 * original range will result in this function returning -ENOMEM while still
1220 * calling the visit function on all of the existing vmas in the range.
1221 * Must be called with the mmap_lock held for reading or writing.
1224 int madvise_walk_vmas(struct mm_struct *mm, unsigned long start,
1225 unsigned long end, unsigned long arg,
1226 int (*visit)(struct vm_area_struct *vma,
1227 struct vm_area_struct **prev, unsigned long start,
1228 unsigned long end, unsigned long arg))
1230 struct vm_area_struct *vma;
1231 struct vm_area_struct *prev;
1233 int unmapped_error = 0;
1236 * If the interval [start,end) covers some unmapped address
1237 * ranges, just ignore them, but return -ENOMEM at the end.
1238 * - different from the way of handling in mlock etc.
1240 vma = find_vma_prev(mm, start, &prev);
1241 if (vma && start > vma->vm_start)
1247 /* Still start < end. */
1251 /* Here start < (end|vma->vm_end). */
1252 if (start < vma->vm_start) {
1253 unmapped_error = -ENOMEM;
1254 start = vma->vm_start;
1259 /* Here vma->vm_start <= start < (end|vma->vm_end) */
1264 /* Here vma->vm_start <= start < tmp <= (end|vma->vm_end). */
1265 error = visit(vma, &prev, start, tmp, arg);
1269 if (prev && start < prev->vm_end)
1270 start = prev->vm_end;
1274 vma = find_vma(mm, prev->vm_end);
1275 else /* madvise_remove dropped mmap_lock */
1276 vma = find_vma(mm, start);
1279 return unmapped_error;
1282 #ifdef CONFIG_ANON_VMA_NAME
1283 static int madvise_vma_anon_name(struct vm_area_struct *vma,
1284 struct vm_area_struct **prev,
1285 unsigned long start, unsigned long end,
1286 unsigned long anon_name)
1290 /* Only anonymous mappings can be named */
1291 if (vma->vm_file && !vma_is_anon_shmem(vma))
1294 error = madvise_update_vma(vma, prev, start, end, vma->vm_flags,
1295 (struct anon_vma_name *)anon_name);
1298 * madvise() returns EAGAIN if kernel resources, such as
1299 * slab, are temporarily unavailable.
1301 if (error == -ENOMEM)
1306 int madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
1307 unsigned long len_in, struct anon_vma_name *anon_name)
1312 if (start & ~PAGE_MASK)
1314 len = (len_in + ~PAGE_MASK) & PAGE_MASK;
1316 /* Check to see whether len was rounded up from small -ve to zero */
1327 return madvise_walk_vmas(mm, start, end, (unsigned long)anon_name,
1328 madvise_vma_anon_name);
1330 #endif /* CONFIG_ANON_VMA_NAME */
1332 * The madvise(2) system call.
1334 * Applications can use madvise() to advise the kernel how it should
1335 * handle paging I/O in this VM area. The idea is to help the kernel
1336 * use appropriate read-ahead and caching techniques. The information
1337 * provided is advisory only, and can be safely disregarded by the
1338 * kernel without affecting the correct operation of the application.
1341 * MADV_NORMAL - the default behavior is to read clusters. This
1342 * results in some read-ahead and read-behind.
1343 * MADV_RANDOM - the system should read the minimum amount of data
1344 * on any access, since it is unlikely that the appli-
1345 * cation will need more than what it asks for.
1346 * MADV_SEQUENTIAL - pages in the given range will probably be accessed
1347 * once, so they can be aggressively read ahead, and
1348 * can be freed soon after they are accessed.
1349 * MADV_WILLNEED - the application is notifying the system to read
1351 * MADV_DONTNEED - the application is finished with the given range,
1352 * so the kernel can free resources associated with it.
1353 * MADV_FREE - the application marks pages in the given range as lazy free,
1354 * where actual purges are postponed until memory pressure happens.
1355 * MADV_REMOVE - the application wants to free up the given range of
1356 * pages and associated backing store.
1357 * MADV_DONTFORK - omit this area from child's address space when forking:
1358 * typically, to avoid COWing pages pinned by get_user_pages().
1359 * MADV_DOFORK - cancel MADV_DONTFORK: no longer omit this area when forking.
1360 * MADV_WIPEONFORK - present the child process with zero-filled memory in this
1361 * range after a fork.
1362 * MADV_KEEPONFORK - undo the effect of MADV_WIPEONFORK
1363 * MADV_HWPOISON - trigger memory error handler as if the given memory range
1364 * were corrupted by unrecoverable hardware memory failure.
1365 * MADV_SOFT_OFFLINE - try to soft-offline the given range of memory.
1366 * MADV_MERGEABLE - the application recommends that KSM try to merge pages in
1367 * this area with pages of identical content from other such areas.
1368 * MADV_UNMERGEABLE- cancel MADV_MERGEABLE: no longer merge pages with others.
1369 * MADV_HUGEPAGE - the application wants to back the given range by transparent
1370 * huge pages in the future. Existing pages might be coalesced and
1371 * new pages might be allocated as THP.
1372 * MADV_NOHUGEPAGE - mark the given range as not worth being backed by
1373 * transparent huge pages so the existing pages will not be
1374 * coalesced into THP and new pages will not be allocated as THP.
1375 * MADV_COLLAPSE - synchronously coalesce pages into new THP.
1376 * MADV_DONTDUMP - the application wants to prevent pages in the given range
1377 * from being included in its core dump.
1378 * MADV_DODUMP - cancel MADV_DONTDUMP: no longer exclude from core dump.
1379 * MADV_COLD - the application is not expected to use this memory soon,
1380 * deactivate pages in this range so that they can be reclaimed
1381 * easily if memory pressure happens.
1382 * MADV_PAGEOUT - the application is not expected to use this memory soon,
1383 * page out the pages in this range immediately.
1384 * MADV_POPULATE_READ - populate (prefault) page tables readable by
1385 * triggering read faults if required
1386 * MADV_POPULATE_WRITE - populate (prefault) page tables writable by
1387 * triggering write faults if required
1391 * -EINVAL - start + len < 0, start is not page-aligned,
1392 * "behavior" is not a valid value, or application
1393 * is attempting to release locked or shared pages,
1394 * or the specified address range includes file, Huge TLB,
1395 * MAP_SHARED or VMPFNMAP range.
1396 * -ENOMEM - addresses in the specified range are not currently
1397 * mapped, or are outside the AS of the process.
1398 * -EIO - an I/O error occurred while paging in data.
1399 * -EBADF - map exists, but area maps something that isn't a file.
1400 * -EAGAIN - a kernel resource was temporarily unavailable.
1402 int do_madvise(struct mm_struct *mm, unsigned long start, size_t len_in, int behavior)
1408 struct blk_plug plug;
1410 start = untagged_addr(start);
1412 if (!madvise_behavior_valid(behavior))
1415 if (!PAGE_ALIGNED(start))
1417 len = PAGE_ALIGN(len_in);
1419 /* Check to see whether len was rounded up from small -ve to zero */
1430 #ifdef CONFIG_MEMORY_FAILURE
1431 if (behavior == MADV_HWPOISON || behavior == MADV_SOFT_OFFLINE)
1432 return madvise_inject_error(behavior, start, start + len_in);
1435 write = madvise_need_mmap_write(behavior);
1437 if (mmap_write_lock_killable(mm))
1443 blk_start_plug(&plug);
1444 error = madvise_walk_vmas(mm, start, end, behavior,
1445 madvise_vma_behavior);
1446 blk_finish_plug(&plug);
1448 mmap_write_unlock(mm);
1450 mmap_read_unlock(mm);
1455 SYSCALL_DEFINE3(madvise, unsigned long, start, size_t, len_in, int, behavior)
1457 return do_madvise(current->mm, start, len_in, behavior);
1460 SYSCALL_DEFINE5(process_madvise, int, pidfd, const struct iovec __user *, vec,
1461 size_t, vlen, int, behavior, unsigned int, flags)
1464 struct iovec iovstack[UIO_FASTIOV], iovec;
1465 struct iovec *iov = iovstack;
1466 struct iov_iter iter;
1467 struct task_struct *task;
1468 struct mm_struct *mm;
1470 unsigned int f_flags;
1477 ret = import_iovec(ITER_DEST, vec, vlen, ARRAY_SIZE(iovstack), &iov, &iter);
1481 task = pidfd_get_task(pidfd, &f_flags);
1483 ret = PTR_ERR(task);
1487 if (!process_madvise_behavior_valid(behavior)) {
1492 /* Require PTRACE_MODE_READ to avoid leaking ASLR metadata. */
1493 mm = mm_access(task, PTRACE_MODE_READ_FSCREDS);
1494 if (IS_ERR_OR_NULL(mm)) {
1495 ret = IS_ERR(mm) ? PTR_ERR(mm) : -ESRCH;
1500 * Require CAP_SYS_NICE for influencing process performance. Note that
1501 * only non-destructive hints are currently supported.
1503 if (!capable(CAP_SYS_NICE)) {
1508 total_len = iov_iter_count(&iter);
1510 while (iov_iter_count(&iter)) {
1511 iovec = iov_iter_iovec(&iter);
1512 ret = do_madvise(mm, (unsigned long)iovec.iov_base,
1513 iovec.iov_len, behavior);
1516 iov_iter_advance(&iter, iovec.iov_len);
1519 ret = (total_len - iov_iter_count(&iter)) ? : ret;
1524 put_task_struct(task);