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;
145 VMA_ITERATOR(vmi, mm, start);
147 if (new_flags == vma->vm_flags && anon_vma_name_eq(anon_vma_name(vma), anon_name)) {
152 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
153 *prev = vma_merge(&vmi, mm, *prev, start, end, new_flags,
154 vma->anon_vma, vma->vm_file, pgoff, vma_policy(vma),
155 vma->vm_userfaultfd_ctx, anon_name);
163 if (start != vma->vm_start) {
164 error = split_vma(&vmi, vma, start, 1);
169 if (end != vma->vm_end) {
170 error = split_vma(&vmi, vma, end, 0);
177 * vm_flags is protected by the mmap_lock held in write mode.
179 vm_flags_reset(vma, new_flags);
180 if (!vma->vm_file || vma_is_anon_shmem(vma)) {
181 error = replace_anon_vma_name(vma, anon_name);
190 static int swapin_walk_pmd_entry(pmd_t *pmd, unsigned long start,
191 unsigned long end, struct mm_walk *walk)
193 struct vm_area_struct *vma = walk->private;
194 struct swap_iocb *splug = NULL;
199 for (addr = start; addr < end; addr += PAGE_SIZE) {
205 ptep = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
210 pte = ptep_get(ptep);
211 if (!is_swap_pte(pte))
213 entry = pte_to_swp_entry(pte);
214 if (unlikely(non_swap_entry(entry)))
217 pte_unmap_unlock(ptep, ptl);
220 page = read_swap_cache_async(entry, GFP_HIGHUSER_MOVABLE,
221 vma, addr, false, &splug);
227 pte_unmap_unlock(ptep, ptl);
228 swap_read_unplug(splug);
234 static const struct mm_walk_ops swapin_walk_ops = {
235 .pmd_entry = swapin_walk_pmd_entry,
238 static void shmem_swapin_range(struct vm_area_struct *vma,
239 unsigned long start, unsigned long end,
240 struct address_space *mapping)
242 XA_STATE(xas, &mapping->i_pages, linear_page_index(vma, start));
243 pgoff_t end_index = linear_page_index(vma, end) - 1;
245 struct swap_iocb *splug = NULL;
248 xas_for_each(&xas, page, end_index) {
252 if (!xa_is_value(page))
254 entry = radix_to_swp_entry(page);
255 /* There might be swapin error entries in shmem mapping. */
256 if (non_swap_entry(entry))
259 addr = vma->vm_start +
260 ((xas.xa_index - vma->vm_pgoff) << PAGE_SHIFT);
264 page = read_swap_cache_async(entry, mapping_gfp_mask(mapping),
265 vma, addr, false, &splug);
272 swap_read_unplug(splug);
274 #endif /* CONFIG_SWAP */
277 * Schedule all required I/O operations. Do not wait for completion.
279 static long madvise_willneed(struct vm_area_struct *vma,
280 struct vm_area_struct **prev,
281 unsigned long start, unsigned long end)
283 struct mm_struct *mm = vma->vm_mm;
284 struct file *file = vma->vm_file;
290 walk_page_range(vma->vm_mm, start, end, &swapin_walk_ops, vma);
291 lru_add_drain(); /* Push any new pages onto the LRU now */
295 if (shmem_mapping(file->f_mapping)) {
296 shmem_swapin_range(vma, start, end, file->f_mapping);
297 lru_add_drain(); /* Push any new pages onto the LRU now */
305 if (IS_DAX(file_inode(file))) {
306 /* no bad return value, but ignore advice */
311 * Filesystem's fadvise may need to take various locks. We need to
312 * explicitly grab a reference because the vma (and hence the
313 * vma's reference to the file) can go away as soon as we drop
316 *prev = NULL; /* tell sys_madvise we drop mmap_lock */
318 offset = (loff_t)(start - vma->vm_start)
319 + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
320 mmap_read_unlock(mm);
321 vfs_fadvise(file, offset, end - start, POSIX_FADV_WILLNEED);
327 static inline bool can_do_file_pageout(struct vm_area_struct *vma)
332 * paging out pagecache only for non-anonymous mappings that correspond
333 * to the files the calling process could (if tried) open for writing;
334 * otherwise we'd be including shared non-exclusive mappings, which
335 * opens a side channel.
337 return inode_owner_or_capable(&nop_mnt_idmap,
338 file_inode(vma->vm_file)) ||
339 file_permission(vma->vm_file, MAY_WRITE) == 0;
342 static int madvise_cold_or_pageout_pte_range(pmd_t *pmd,
343 unsigned long addr, unsigned long end,
344 struct mm_walk *walk)
346 struct madvise_walk_private *private = walk->private;
347 struct mmu_gather *tlb = private->tlb;
348 bool pageout = private->pageout;
349 struct mm_struct *mm = tlb->mm;
350 struct vm_area_struct *vma = walk->vma;
351 pte_t *start_pte, *pte, ptent;
353 struct folio *folio = NULL;
354 LIST_HEAD(folio_list);
355 bool pageout_anon_only_filter;
357 if (fatal_signal_pending(current))
360 pageout_anon_only_filter = pageout && !vma_is_anonymous(vma) &&
361 !can_do_file_pageout(vma);
363 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
364 if (pmd_trans_huge(*pmd)) {
366 unsigned long next = pmd_addr_end(addr, end);
368 tlb_change_page_size(tlb, HPAGE_PMD_SIZE);
369 ptl = pmd_trans_huge_lock(pmd, vma);
374 if (is_huge_zero_pmd(orig_pmd))
377 if (unlikely(!pmd_present(orig_pmd))) {
378 VM_BUG_ON(thp_migration_supported() &&
379 !is_pmd_migration_entry(orig_pmd));
383 folio = pfn_folio(pmd_pfn(orig_pmd));
385 /* Do not interfere with other mappings of this folio */
386 if (folio_mapcount(folio) != 1)
389 if (pageout_anon_only_filter && !folio_test_anon(folio))
392 if (next - addr != HPAGE_PMD_SIZE) {
398 err = split_folio(folio);
406 if (pmd_young(orig_pmd)) {
407 pmdp_invalidate(vma, addr, pmd);
408 orig_pmd = pmd_mkold(orig_pmd);
410 set_pmd_at(mm, addr, pmd, orig_pmd);
411 tlb_remove_pmd_tlb_entry(tlb, pmd, addr);
414 folio_clear_referenced(folio);
415 folio_test_clear_young(folio);
416 if (folio_test_active(folio))
417 folio_set_workingset(folio);
419 if (folio_isolate_lru(folio)) {
420 if (folio_test_unevictable(folio))
421 folio_putback_lru(folio);
423 list_add(&folio->lru, &folio_list);
426 folio_deactivate(folio);
430 reclaim_pages(&folio_list);
436 tlb_change_page_size(tlb, PAGE_SIZE);
437 start_pte = pte = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
440 flush_tlb_batched_pending(mm);
441 arch_enter_lazy_mmu_mode();
442 for (; addr < end; pte++, addr += PAGE_SIZE) {
443 ptent = ptep_get(pte);
448 if (!pte_present(ptent))
451 folio = vm_normal_folio(vma, addr, ptent);
452 if (!folio || folio_is_zone_device(folio))
456 * Creating a THP page is expensive so split it only if we
457 * are sure it's worth. Split it if we are only owner.
459 if (folio_test_large(folio)) {
462 if (folio_mapcount(folio) != 1)
464 if (pageout_anon_only_filter && !folio_test_anon(folio))
466 if (!folio_trylock(folio))
469 arch_leave_lazy_mmu_mode();
470 pte_unmap_unlock(start_pte, ptl);
472 err = split_folio(folio);
478 pte_offset_map_lock(mm, pmd, addr, &ptl);
481 arch_enter_lazy_mmu_mode();
488 * Do not interfere with other mappings of this folio and
491 if (!folio_test_lru(folio) || folio_mapcount(folio) != 1)
494 if (pageout_anon_only_filter && !folio_test_anon(folio))
497 VM_BUG_ON_FOLIO(folio_test_large(folio), folio);
499 if (pte_young(ptent)) {
500 ptent = ptep_get_and_clear_full(mm, addr, pte,
502 ptent = pte_mkold(ptent);
503 set_pte_at(mm, addr, pte, ptent);
504 tlb_remove_tlb_entry(tlb, pte, addr);
508 * We are deactivating a folio for accelerating reclaiming.
509 * VM couldn't reclaim the folio unless we clear PG_young.
510 * As a side effect, it makes confuse idle-page tracking
511 * because they will miss recent referenced history.
513 folio_clear_referenced(folio);
514 folio_test_clear_young(folio);
515 if (folio_test_active(folio))
516 folio_set_workingset(folio);
518 if (folio_isolate_lru(folio)) {
519 if (folio_test_unevictable(folio))
520 folio_putback_lru(folio);
522 list_add(&folio->lru, &folio_list);
525 folio_deactivate(folio);
529 arch_leave_lazy_mmu_mode();
530 pte_unmap_unlock(start_pte, ptl);
533 reclaim_pages(&folio_list);
539 static const struct mm_walk_ops cold_walk_ops = {
540 .pmd_entry = madvise_cold_or_pageout_pte_range,
543 static void madvise_cold_page_range(struct mmu_gather *tlb,
544 struct vm_area_struct *vma,
545 unsigned long addr, unsigned long end)
547 struct madvise_walk_private walk_private = {
552 tlb_start_vma(tlb, vma);
553 walk_page_range(vma->vm_mm, addr, end, &cold_walk_ops, &walk_private);
554 tlb_end_vma(tlb, vma);
557 static inline bool can_madv_lru_vma(struct vm_area_struct *vma)
559 return !(vma->vm_flags & (VM_LOCKED|VM_PFNMAP|VM_HUGETLB));
562 static long madvise_cold(struct vm_area_struct *vma,
563 struct vm_area_struct **prev,
564 unsigned long start_addr, unsigned long end_addr)
566 struct mm_struct *mm = vma->vm_mm;
567 struct mmu_gather tlb;
570 if (!can_madv_lru_vma(vma))
574 tlb_gather_mmu(&tlb, mm);
575 madvise_cold_page_range(&tlb, vma, start_addr, end_addr);
576 tlb_finish_mmu(&tlb);
581 static void madvise_pageout_page_range(struct mmu_gather *tlb,
582 struct vm_area_struct *vma,
583 unsigned long addr, unsigned long end)
585 struct madvise_walk_private walk_private = {
590 tlb_start_vma(tlb, vma);
591 walk_page_range(vma->vm_mm, addr, end, &cold_walk_ops, &walk_private);
592 tlb_end_vma(tlb, vma);
595 static long madvise_pageout(struct vm_area_struct *vma,
596 struct vm_area_struct **prev,
597 unsigned long start_addr, unsigned long end_addr)
599 struct mm_struct *mm = vma->vm_mm;
600 struct mmu_gather tlb;
603 if (!can_madv_lru_vma(vma))
607 * If the VMA belongs to a private file mapping, there can be private
608 * dirty pages which can be paged out if even this process is neither
609 * owner nor write capable of the file. We allow private file mappings
610 * further to pageout dirty anon pages.
612 if (!vma_is_anonymous(vma) && (!can_do_file_pageout(vma) &&
613 (vma->vm_flags & VM_MAYSHARE)))
617 tlb_gather_mmu(&tlb, mm);
618 madvise_pageout_page_range(&tlb, vma, start_addr, end_addr);
619 tlb_finish_mmu(&tlb);
624 static int madvise_free_pte_range(pmd_t *pmd, unsigned long addr,
625 unsigned long end, struct mm_walk *walk)
628 struct mmu_gather *tlb = walk->private;
629 struct mm_struct *mm = tlb->mm;
630 struct vm_area_struct *vma = walk->vma;
632 pte_t *start_pte, *pte, ptent;
637 next = pmd_addr_end(addr, end);
638 if (pmd_trans_huge(*pmd))
639 if (madvise_free_huge_pmd(tlb, vma, pmd, addr, next))
642 tlb_change_page_size(tlb, PAGE_SIZE);
643 start_pte = pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
646 flush_tlb_batched_pending(mm);
647 arch_enter_lazy_mmu_mode();
648 for (; addr != end; pte++, addr += PAGE_SIZE) {
649 ptent = ptep_get(pte);
654 * If the pte has swp_entry, just clear page table to
655 * prevent swap-in which is more expensive rather than
656 * (page allocation + zeroing).
658 if (!pte_present(ptent)) {
661 entry = pte_to_swp_entry(ptent);
662 if (!non_swap_entry(entry)) {
664 free_swap_and_cache(entry);
665 pte_clear_not_present_full(mm, addr, pte, tlb->fullmm);
666 } else if (is_hwpoison_entry(entry) ||
667 is_poisoned_swp_entry(entry)) {
668 pte_clear_not_present_full(mm, addr, pte, tlb->fullmm);
673 folio = vm_normal_folio(vma, addr, ptent);
674 if (!folio || folio_is_zone_device(folio))
678 * If pmd isn't transhuge but the folio is large and
679 * is owned by only this process, split it and
680 * deactivate all pages.
682 if (folio_test_large(folio)) {
685 if (folio_mapcount(folio) != 1)
687 if (!folio_trylock(folio))
690 arch_leave_lazy_mmu_mode();
691 pte_unmap_unlock(start_pte, ptl);
693 err = split_folio(folio);
699 pte_offset_map_lock(mm, pmd, addr, &ptl);
702 arch_enter_lazy_mmu_mode();
708 if (folio_test_swapcache(folio) || folio_test_dirty(folio)) {
709 if (!folio_trylock(folio))
712 * If folio is shared with others, we mustn't clear
713 * the folio's dirty flag.
715 if (folio_mapcount(folio) != 1) {
720 if (folio_test_swapcache(folio) &&
721 !folio_free_swap(folio)) {
726 folio_clear_dirty(folio);
730 if (pte_young(ptent) || pte_dirty(ptent)) {
732 * Some of architecture(ex, PPC) don't update TLB
733 * with set_pte_at and tlb_remove_tlb_entry so for
734 * the portability, remap the pte with old|clean
735 * after pte clearing.
737 ptent = ptep_get_and_clear_full(mm, addr, pte,
740 ptent = pte_mkold(ptent);
741 ptent = pte_mkclean(ptent);
742 set_pte_at(mm, addr, pte, ptent);
743 tlb_remove_tlb_entry(tlb, pte, addr);
745 folio_mark_lazyfree(folio);
749 if (current->mm == mm)
751 add_mm_counter(mm, MM_SWAPENTS, nr_swap);
754 arch_leave_lazy_mmu_mode();
755 pte_unmap_unlock(start_pte, ptl);
762 static const struct mm_walk_ops madvise_free_walk_ops = {
763 .pmd_entry = madvise_free_pte_range,
766 static int madvise_free_single_vma(struct vm_area_struct *vma,
767 unsigned long start_addr, unsigned long end_addr)
769 struct mm_struct *mm = vma->vm_mm;
770 struct mmu_notifier_range range;
771 struct mmu_gather tlb;
773 /* MADV_FREE works for only anon vma at the moment */
774 if (!vma_is_anonymous(vma))
777 range.start = max(vma->vm_start, start_addr);
778 if (range.start >= vma->vm_end)
780 range.end = min(vma->vm_end, end_addr);
781 if (range.end <= vma->vm_start)
783 mmu_notifier_range_init(&range, MMU_NOTIFY_CLEAR, 0, mm,
784 range.start, range.end);
787 tlb_gather_mmu(&tlb, mm);
788 update_hiwater_rss(mm);
790 mmu_notifier_invalidate_range_start(&range);
791 tlb_start_vma(&tlb, vma);
792 walk_page_range(vma->vm_mm, range.start, range.end,
793 &madvise_free_walk_ops, &tlb);
794 tlb_end_vma(&tlb, vma);
795 mmu_notifier_invalidate_range_end(&range);
796 tlb_finish_mmu(&tlb);
802 * Application no longer needs these pages. If the pages are dirty,
803 * it's OK to just throw them away. The app will be more careful about
804 * data it wants to keep. Be sure to free swap resources too. The
805 * zap_page_range_single call sets things up for shrink_active_list to actually
806 * free these pages later if no one else has touched them in the meantime,
807 * although we could add these pages to a global reuse list for
808 * shrink_active_list to pick up before reclaiming other pages.
810 * NB: This interface discards data rather than pushes it out to swap,
811 * as some implementations do. This has performance implications for
812 * applications like large transactional databases which want to discard
813 * pages in anonymous maps after committing to backing store the data
814 * that was kept in them. There is no reason to write this data out to
815 * the swap area if the application is discarding it.
817 * An interface that causes the system to free clean pages and flush
818 * dirty pages is already available as msync(MS_INVALIDATE).
820 static long madvise_dontneed_single_vma(struct vm_area_struct *vma,
821 unsigned long start, unsigned long end)
823 zap_page_range_single(vma, start, end - start, NULL);
827 static bool madvise_dontneed_free_valid_vma(struct vm_area_struct *vma,
832 if (!is_vm_hugetlb_page(vma)) {
833 unsigned int forbidden = VM_PFNMAP;
835 if (behavior != MADV_DONTNEED_LOCKED)
836 forbidden |= VM_LOCKED;
838 return !(vma->vm_flags & forbidden);
841 if (behavior != MADV_DONTNEED && behavior != MADV_DONTNEED_LOCKED)
843 if (start & ~huge_page_mask(hstate_vma(vma)))
847 * Madvise callers expect the length to be rounded up to PAGE_SIZE
848 * boundaries, and may be unaware that this VMA uses huge pages.
849 * Avoid unexpected data loss by rounding down the number of
852 *end = ALIGN_DOWN(*end, huge_page_size(hstate_vma(vma)));
857 static long madvise_dontneed_free(struct vm_area_struct *vma,
858 struct vm_area_struct **prev,
859 unsigned long start, unsigned long end,
862 struct mm_struct *mm = vma->vm_mm;
865 if (!madvise_dontneed_free_valid_vma(vma, start, &end, behavior))
871 if (!userfaultfd_remove(vma, start, end)) {
872 *prev = NULL; /* mmap_lock has been dropped, prev is stale */
875 vma = vma_lookup(mm, start);
879 * Potential end adjustment for hugetlb vma is OK as
880 * the check below keeps end within vma.
882 if (!madvise_dontneed_free_valid_vma(vma, start, &end,
885 if (end > vma->vm_end) {
887 * Don't fail if end > vma->vm_end. If the old
888 * vma was split while the mmap_lock was
889 * released the effect of the concurrent
890 * operation may not cause madvise() to
891 * have an undefined result. There may be an
892 * adjacent next vma that we'll walk
893 * next. userfaultfd_remove() will generate an
894 * UFFD_EVENT_REMOVE repetition on the
895 * end-vma->vm_end range, but the manager can
896 * handle a repetition fine.
900 VM_WARN_ON(start >= end);
903 if (behavior == MADV_DONTNEED || behavior == MADV_DONTNEED_LOCKED)
904 return madvise_dontneed_single_vma(vma, start, end);
905 else if (behavior == MADV_FREE)
906 return madvise_free_single_vma(vma, start, end);
911 static long madvise_populate(struct vm_area_struct *vma,
912 struct vm_area_struct **prev,
913 unsigned long start, unsigned long end,
916 const bool write = behavior == MADV_POPULATE_WRITE;
917 struct mm_struct *mm = vma->vm_mm;
918 unsigned long tmp_end;
924 while (start < end) {
926 * We might have temporarily dropped the lock. For example,
927 * our VMA might have been split.
929 if (!vma || start >= vma->vm_end) {
930 vma = vma_lookup(mm, start);
935 tmp_end = min_t(unsigned long, end, vma->vm_end);
936 /* Populate (prefault) page tables readable/writable. */
937 pages = faultin_vma_page_range(vma, start, tmp_end, write,
949 case -EINVAL: /* Incompatible mappings / permissions. */
953 case -EFAULT: /* VM_FAULT_SIGBUS or VM_FAULT_SIGSEGV */
956 pr_warn_once("%s: unhandled return value: %ld\n",
963 start += pages * PAGE_SIZE;
969 * Application wants to free up the pages and associated backing store.
970 * This is effectively punching a hole into the middle of a file.
972 static long madvise_remove(struct vm_area_struct *vma,
973 struct vm_area_struct **prev,
974 unsigned long start, unsigned long end)
979 struct mm_struct *mm = vma->vm_mm;
981 *prev = NULL; /* tell sys_madvise we drop mmap_lock */
983 if (vma->vm_flags & VM_LOCKED)
988 if (!f || !f->f_mapping || !f->f_mapping->host) {
992 if ((vma->vm_flags & (VM_SHARED|VM_WRITE)) != (VM_SHARED|VM_WRITE))
995 offset = (loff_t)(start - vma->vm_start)
996 + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
999 * Filesystem's fallocate may need to take i_rwsem. We need to
1000 * explicitly grab a reference because the vma (and hence the
1001 * vma's reference to the file) can go away as soon as we drop
1005 if (userfaultfd_remove(vma, start, end)) {
1006 /* mmap_lock was not released by userfaultfd_remove() */
1007 mmap_read_unlock(mm);
1009 error = vfs_fallocate(f,
1010 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1011 offset, end - start);
1018 * Apply an madvise behavior to a region of a vma. madvise_update_vma
1019 * will handle splitting a vm area into separate areas, each area with its own
1022 static int madvise_vma_behavior(struct vm_area_struct *vma,
1023 struct vm_area_struct **prev,
1024 unsigned long start, unsigned long end,
1025 unsigned long behavior)
1028 struct anon_vma_name *anon_name;
1029 unsigned long new_flags = vma->vm_flags;
1033 return madvise_remove(vma, prev, start, end);
1035 return madvise_willneed(vma, prev, start, end);
1037 return madvise_cold(vma, prev, start, end);
1039 return madvise_pageout(vma, prev, start, end);
1042 case MADV_DONTNEED_LOCKED:
1043 return madvise_dontneed_free(vma, prev, start, end, behavior);
1044 case MADV_POPULATE_READ:
1045 case MADV_POPULATE_WRITE:
1046 return madvise_populate(vma, prev, start, end, behavior);
1048 new_flags = new_flags & ~VM_RAND_READ & ~VM_SEQ_READ;
1050 case MADV_SEQUENTIAL:
1051 new_flags = (new_flags & ~VM_RAND_READ) | VM_SEQ_READ;
1054 new_flags = (new_flags & ~VM_SEQ_READ) | VM_RAND_READ;
1057 new_flags |= VM_DONTCOPY;
1060 if (vma->vm_flags & VM_IO)
1062 new_flags &= ~VM_DONTCOPY;
1064 case MADV_WIPEONFORK:
1065 /* MADV_WIPEONFORK is only supported on anonymous memory. */
1066 if (vma->vm_file || vma->vm_flags & VM_SHARED)
1068 new_flags |= VM_WIPEONFORK;
1070 case MADV_KEEPONFORK:
1071 new_flags &= ~VM_WIPEONFORK;
1074 new_flags |= VM_DONTDUMP;
1077 if (!is_vm_hugetlb_page(vma) && new_flags & VM_SPECIAL)
1079 new_flags &= ~VM_DONTDUMP;
1081 case MADV_MERGEABLE:
1082 case MADV_UNMERGEABLE:
1083 error = ksm_madvise(vma, start, end, behavior, &new_flags);
1088 case MADV_NOHUGEPAGE:
1089 error = hugepage_madvise(vma, &new_flags, behavior);
1094 return madvise_collapse(vma, prev, start, end);
1097 anon_name = anon_vma_name(vma);
1098 anon_vma_name_get(anon_name);
1099 error = madvise_update_vma(vma, prev, start, end, new_flags,
1101 anon_vma_name_put(anon_name);
1105 * madvise() returns EAGAIN if kernel resources, such as
1106 * slab, are temporarily unavailable.
1108 if (error == -ENOMEM)
1113 #ifdef CONFIG_MEMORY_FAILURE
1115 * Error injection support for memory error handling.
1117 static int madvise_inject_error(int behavior,
1118 unsigned long start, unsigned long end)
1122 if (!capable(CAP_SYS_ADMIN))
1126 for (; start < end; start += size) {
1131 ret = get_user_pages_fast(start, 1, 0, &page);
1134 pfn = page_to_pfn(page);
1137 * When soft offlining hugepages, after migrating the page
1138 * we dissolve it, therefore in the second loop "page" will
1139 * no longer be a compound page.
1141 size = page_size(compound_head(page));
1143 if (behavior == MADV_SOFT_OFFLINE) {
1144 pr_info("Soft offlining pfn %#lx at process virtual address %#lx\n",
1146 ret = soft_offline_page(pfn, MF_COUNT_INCREASED);
1148 pr_info("Injecting memory failure for pfn %#lx at process virtual address %#lx\n",
1150 ret = memory_failure(pfn, MF_COUNT_INCREASED | MF_SW_SIMULATED);
1151 if (ret == -EOPNOTSUPP)
1164 madvise_behavior_valid(int behavior)
1170 case MADV_SEQUENTIAL:
1175 case MADV_DONTNEED_LOCKED:
1179 case MADV_POPULATE_READ:
1180 case MADV_POPULATE_WRITE:
1182 case MADV_MERGEABLE:
1183 case MADV_UNMERGEABLE:
1185 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1187 case MADV_NOHUGEPAGE:
1192 case MADV_WIPEONFORK:
1193 case MADV_KEEPONFORK:
1194 #ifdef CONFIG_MEMORY_FAILURE
1195 case MADV_SOFT_OFFLINE:
1205 static bool process_madvise_behavior_valid(int behavior)
1219 * Walk the vmas in range [start,end), and call the visit function on each one.
1220 * The visit function will get start and end parameters that cover the overlap
1221 * between the current vma and the original range. Any unmapped regions in the
1222 * original range will result in this function returning -ENOMEM while still
1223 * calling the visit function on all of the existing vmas in the range.
1224 * Must be called with the mmap_lock held for reading or writing.
1227 int madvise_walk_vmas(struct mm_struct *mm, unsigned long start,
1228 unsigned long end, unsigned long arg,
1229 int (*visit)(struct vm_area_struct *vma,
1230 struct vm_area_struct **prev, unsigned long start,
1231 unsigned long end, unsigned long arg))
1233 struct vm_area_struct *vma;
1234 struct vm_area_struct *prev;
1236 int unmapped_error = 0;
1239 * If the interval [start,end) covers some unmapped address
1240 * ranges, just ignore them, but return -ENOMEM at the end.
1241 * - different from the way of handling in mlock etc.
1243 vma = find_vma_prev(mm, start, &prev);
1244 if (vma && start > vma->vm_start)
1250 /* Still start < end. */
1254 /* Here start < (end|vma->vm_end). */
1255 if (start < vma->vm_start) {
1256 unmapped_error = -ENOMEM;
1257 start = vma->vm_start;
1262 /* Here vma->vm_start <= start < (end|vma->vm_end) */
1267 /* Here vma->vm_start <= start < tmp <= (end|vma->vm_end). */
1268 error = visit(vma, &prev, start, tmp, arg);
1272 if (prev && start < prev->vm_end)
1273 start = prev->vm_end;
1277 vma = find_vma(mm, prev->vm_end);
1278 else /* madvise_remove dropped mmap_lock */
1279 vma = find_vma(mm, start);
1282 return unmapped_error;
1285 #ifdef CONFIG_ANON_VMA_NAME
1286 static int madvise_vma_anon_name(struct vm_area_struct *vma,
1287 struct vm_area_struct **prev,
1288 unsigned long start, unsigned long end,
1289 unsigned long anon_name)
1293 /* Only anonymous mappings can be named */
1294 if (vma->vm_file && !vma_is_anon_shmem(vma))
1297 error = madvise_update_vma(vma, prev, start, end, vma->vm_flags,
1298 (struct anon_vma_name *)anon_name);
1301 * madvise() returns EAGAIN if kernel resources, such as
1302 * slab, are temporarily unavailable.
1304 if (error == -ENOMEM)
1309 int madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
1310 unsigned long len_in, struct anon_vma_name *anon_name)
1315 if (start & ~PAGE_MASK)
1317 len = (len_in + ~PAGE_MASK) & PAGE_MASK;
1319 /* Check to see whether len was rounded up from small -ve to zero */
1330 return madvise_walk_vmas(mm, start, end, (unsigned long)anon_name,
1331 madvise_vma_anon_name);
1333 #endif /* CONFIG_ANON_VMA_NAME */
1335 * The madvise(2) system call.
1337 * Applications can use madvise() to advise the kernel how it should
1338 * handle paging I/O in this VM area. The idea is to help the kernel
1339 * use appropriate read-ahead and caching techniques. The information
1340 * provided is advisory only, and can be safely disregarded by the
1341 * kernel without affecting the correct operation of the application.
1344 * MADV_NORMAL - the default behavior is to read clusters. This
1345 * results in some read-ahead and read-behind.
1346 * MADV_RANDOM - the system should read the minimum amount of data
1347 * on any access, since it is unlikely that the appli-
1348 * cation will need more than what it asks for.
1349 * MADV_SEQUENTIAL - pages in the given range will probably be accessed
1350 * once, so they can be aggressively read ahead, and
1351 * can be freed soon after they are accessed.
1352 * MADV_WILLNEED - the application is notifying the system to read
1354 * MADV_DONTNEED - the application is finished with the given range,
1355 * so the kernel can free resources associated with it.
1356 * MADV_FREE - the application marks pages in the given range as lazy free,
1357 * where actual purges are postponed until memory pressure happens.
1358 * MADV_REMOVE - the application wants to free up the given range of
1359 * pages and associated backing store.
1360 * MADV_DONTFORK - omit this area from child's address space when forking:
1361 * typically, to avoid COWing pages pinned by get_user_pages().
1362 * MADV_DOFORK - cancel MADV_DONTFORK: no longer omit this area when forking.
1363 * MADV_WIPEONFORK - present the child process with zero-filled memory in this
1364 * range after a fork.
1365 * MADV_KEEPONFORK - undo the effect of MADV_WIPEONFORK
1366 * MADV_HWPOISON - trigger memory error handler as if the given memory range
1367 * were corrupted by unrecoverable hardware memory failure.
1368 * MADV_SOFT_OFFLINE - try to soft-offline the given range of memory.
1369 * MADV_MERGEABLE - the application recommends that KSM try to merge pages in
1370 * this area with pages of identical content from other such areas.
1371 * MADV_UNMERGEABLE- cancel MADV_MERGEABLE: no longer merge pages with others.
1372 * MADV_HUGEPAGE - the application wants to back the given range by transparent
1373 * huge pages in the future. Existing pages might be coalesced and
1374 * new pages might be allocated as THP.
1375 * MADV_NOHUGEPAGE - mark the given range as not worth being backed by
1376 * transparent huge pages so the existing pages will not be
1377 * coalesced into THP and new pages will not be allocated as THP.
1378 * MADV_COLLAPSE - synchronously coalesce pages into new THP.
1379 * MADV_DONTDUMP - the application wants to prevent pages in the given range
1380 * from being included in its core dump.
1381 * MADV_DODUMP - cancel MADV_DONTDUMP: no longer exclude from core dump.
1382 * MADV_COLD - the application is not expected to use this memory soon,
1383 * deactivate pages in this range so that they can be reclaimed
1384 * easily if memory pressure happens.
1385 * MADV_PAGEOUT - the application is not expected to use this memory soon,
1386 * page out the pages in this range immediately.
1387 * MADV_POPULATE_READ - populate (prefault) page tables readable by
1388 * triggering read faults if required
1389 * MADV_POPULATE_WRITE - populate (prefault) page tables writable by
1390 * triggering write faults if required
1394 * -EINVAL - start + len < 0, start is not page-aligned,
1395 * "behavior" is not a valid value, or application
1396 * is attempting to release locked or shared pages,
1397 * or the specified address range includes file, Huge TLB,
1398 * MAP_SHARED or VMPFNMAP range.
1399 * -ENOMEM - addresses in the specified range are not currently
1400 * mapped, or are outside the AS of the process.
1401 * -EIO - an I/O error occurred while paging in data.
1402 * -EBADF - map exists, but area maps something that isn't a file.
1403 * -EAGAIN - a kernel resource was temporarily unavailable.
1405 int do_madvise(struct mm_struct *mm, unsigned long start, size_t len_in, int behavior)
1411 struct blk_plug plug;
1413 if (!madvise_behavior_valid(behavior))
1416 if (!PAGE_ALIGNED(start))
1418 len = PAGE_ALIGN(len_in);
1420 /* Check to see whether len was rounded up from small -ve to zero */
1431 #ifdef CONFIG_MEMORY_FAILURE
1432 if (behavior == MADV_HWPOISON || behavior == MADV_SOFT_OFFLINE)
1433 return madvise_inject_error(behavior, start, start + len_in);
1436 write = madvise_need_mmap_write(behavior);
1438 if (mmap_write_lock_killable(mm))
1444 start = untagged_addr_remote(mm, start);
1447 blk_start_plug(&plug);
1448 error = madvise_walk_vmas(mm, start, end, behavior,
1449 madvise_vma_behavior);
1450 blk_finish_plug(&plug);
1452 mmap_write_unlock(mm);
1454 mmap_read_unlock(mm);
1459 SYSCALL_DEFINE3(madvise, unsigned long, start, size_t, len_in, int, behavior)
1461 return do_madvise(current->mm, start, len_in, behavior);
1464 SYSCALL_DEFINE5(process_madvise, int, pidfd, const struct iovec __user *, vec,
1465 size_t, vlen, int, behavior, unsigned int, flags)
1468 struct iovec iovstack[UIO_FASTIOV];
1469 struct iovec *iov = iovstack;
1470 struct iov_iter iter;
1471 struct task_struct *task;
1472 struct mm_struct *mm;
1474 unsigned int f_flags;
1481 ret = import_iovec(ITER_DEST, vec, vlen, ARRAY_SIZE(iovstack), &iov, &iter);
1485 task = pidfd_get_task(pidfd, &f_flags);
1487 ret = PTR_ERR(task);
1491 if (!process_madvise_behavior_valid(behavior)) {
1496 /* Require PTRACE_MODE_READ to avoid leaking ASLR metadata. */
1497 mm = mm_access(task, PTRACE_MODE_READ_FSCREDS);
1498 if (IS_ERR_OR_NULL(mm)) {
1499 ret = IS_ERR(mm) ? PTR_ERR(mm) : -ESRCH;
1504 * Require CAP_SYS_NICE for influencing process performance. Note that
1505 * only non-destructive hints are currently supported.
1507 if (!capable(CAP_SYS_NICE)) {
1512 total_len = iov_iter_count(&iter);
1514 while (iov_iter_count(&iter)) {
1515 ret = do_madvise(mm, (unsigned long)iter_iov_addr(&iter),
1516 iter_iov_len(&iter), behavior);
1519 iov_iter_advance(&iter, iter_iov_len(&iter));
1522 ret = (total_len - iov_iter_count(&iter)) ? : ret;
1527 put_task_struct(task);