1 // SPDX-License-Identifier: GPL-2.0
5 * (C) Copyright 1994 Linus Torvalds
6 * (C) Copyright 2002 Christoph Hellwig
8 * Address space accounting code <alan@lxorguk.ukuu.org.uk>
9 * (C) Copyright 2002 Red Hat Inc, All Rights Reserved
12 #include <linux/pagewalk.h>
13 #include <linux/hugetlb.h>
14 #include <linux/shm.h>
15 #include <linux/mman.h>
17 #include <linux/highmem.h>
18 #include <linux/security.h>
19 #include <linux/mempolicy.h>
20 #include <linux/personality.h>
21 #include <linux/syscalls.h>
22 #include <linux/swap.h>
23 #include <linux/swapops.h>
24 #include <linux/mmu_notifier.h>
25 #include <linux/migrate.h>
26 #include <linux/perf_event.h>
27 #include <linux/pkeys.h>
28 #include <linux/ksm.h>
29 #include <linux/uaccess.h>
30 #include <linux/mm_inline.h>
31 #include <linux/pgtable.h>
32 #include <linux/sched/sysctl.h>
33 #include <linux/userfaultfd_k.h>
34 #include <linux/memory-tiers.h>
35 #include <asm/cacheflush.h>
36 #include <asm/mmu_context.h>
37 #include <asm/tlbflush.h>
42 bool can_change_pte_writable(struct vm_area_struct *vma, unsigned long addr,
47 if (WARN_ON_ONCE(!(vma->vm_flags & VM_WRITE)))
50 /* Don't touch entries that are not even readable. */
51 if (pte_protnone(pte))
54 /* Do we need write faults for softdirty tracking? */
55 if (vma_soft_dirty_enabled(vma) && !pte_soft_dirty(pte))
58 /* Do we need write faults for uffd-wp tracking? */
59 if (userfaultfd_pte_wp(vma, pte))
62 if (!(vma->vm_flags & VM_SHARED)) {
64 * Writable MAP_PRIVATE mapping: We can only special-case on
65 * exclusive anonymous pages, because we know that our
66 * write-fault handler similarly would map them writable without
67 * any additional checks while holding the PT lock.
69 page = vm_normal_page(vma, addr, pte);
70 return page && PageAnon(page) && PageAnonExclusive(page);
74 * Writable MAP_SHARED mapping: "clean" might indicate that the FS still
75 * needs a real write-fault for writenotify
76 * (see vma_wants_writenotify()). If "dirty", the assumption is that the
77 * FS was already notified and we can simply mark the PTE writable
78 * just like the write-fault handler would do.
80 return pte_dirty(pte);
83 static long change_pte_range(struct mmu_gather *tlb,
84 struct vm_area_struct *vma, pmd_t *pmd, unsigned long addr,
85 unsigned long end, pgprot_t newprot, unsigned long cp_flags)
90 int target_node = NUMA_NO_NODE;
91 bool prot_numa = cp_flags & MM_CP_PROT_NUMA;
92 bool uffd_wp = cp_flags & MM_CP_UFFD_WP;
93 bool uffd_wp_resolve = cp_flags & MM_CP_UFFD_WP_RESOLVE;
95 tlb_change_page_size(tlb, PAGE_SIZE);
98 * Can be called with only the mmap_lock for reading by
99 * prot_numa so we must check the pmd isn't constantly
100 * changing from under us from pmd_none to pmd_trans_huge
101 * and/or the other way around.
103 if (pmd_trans_unstable(pmd))
107 * The pmd points to a regular pte so the pmd can't change
108 * from under us even if the mmap_lock is only hold for
111 pte = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
113 /* Get target node for single threaded private VMAs */
114 if (prot_numa && !(vma->vm_flags & VM_SHARED) &&
115 atomic_read(&vma->vm_mm->mm_users) == 1)
116 target_node = numa_node_id();
118 flush_tlb_batched_pending(vma->vm_mm);
119 arch_enter_lazy_mmu_mode();
122 if (pte_present(oldpte)) {
126 * Avoid trapping faults against the zero or KSM
127 * pages. See similar comment in change_huge_pmd.
134 /* Avoid TLB flush if possible */
135 if (pte_protnone(oldpte))
138 page = vm_normal_page(vma, addr, oldpte);
139 if (!page || is_zone_device_page(page) || PageKsm(page))
142 /* Also skip shared copy-on-write pages */
143 if (is_cow_mapping(vma->vm_flags) &&
144 page_count(page) != 1)
148 * While migration can move some dirty pages,
149 * it cannot move them all from MIGRATE_ASYNC
152 if (page_is_file_lru(page) && PageDirty(page))
156 * Don't mess with PTEs if page is already on the node
157 * a single-threaded process is running on.
159 nid = page_to_nid(page);
160 if (target_node == nid)
162 toptier = node_is_toptier(nid);
165 * Skip scanning top tier node if normal numa
166 * balancing is disabled
168 if (!(sysctl_numa_balancing_mode & NUMA_BALANCING_NORMAL) &&
171 if (sysctl_numa_balancing_mode & NUMA_BALANCING_MEMORY_TIERING &&
173 xchg_page_access_time(page,
174 jiffies_to_msecs(jiffies));
177 oldpte = ptep_modify_prot_start(vma, addr, pte);
178 ptent = pte_modify(oldpte, newprot);
181 ptent = pte_mkuffd_wp(ptent);
182 else if (uffd_wp_resolve)
183 ptent = pte_clear_uffd_wp(ptent);
186 * In some writable, shared mappings, we might want
187 * to catch actual write access -- see
188 * vma_wants_writenotify().
190 * In all writable, private mappings, we have to
191 * properly handle COW.
193 * In both cases, we can sometimes still change PTEs
194 * writable and avoid the write-fault handler, for
195 * example, if a PTE is already dirty and no other
196 * COW or special handling is required.
198 if ((cp_flags & MM_CP_TRY_CHANGE_WRITABLE) &&
200 can_change_pte_writable(vma, addr, ptent))
201 ptent = pte_mkwrite(ptent);
203 ptep_modify_prot_commit(vma, addr, pte, oldpte, ptent);
204 if (pte_needs_flush(oldpte, ptent))
205 tlb_flush_pte_range(tlb, addr, PAGE_SIZE);
207 } else if (is_swap_pte(oldpte)) {
208 swp_entry_t entry = pte_to_swp_entry(oldpte);
211 if (is_writable_migration_entry(entry)) {
212 struct page *page = pfn_swap_entry_to_page(entry);
215 * A protection check is difficult so
216 * just be safe and disable write
219 entry = make_readable_exclusive_migration_entry(
222 entry = make_readable_migration_entry(swp_offset(entry));
223 newpte = swp_entry_to_pte(entry);
224 if (pte_swp_soft_dirty(oldpte))
225 newpte = pte_swp_mksoft_dirty(newpte);
226 if (pte_swp_uffd_wp(oldpte))
227 newpte = pte_swp_mkuffd_wp(newpte);
228 } else if (is_writable_device_private_entry(entry)) {
230 * We do not preserve soft-dirtiness. See
231 * copy_one_pte() for explanation.
233 entry = make_readable_device_private_entry(
235 newpte = swp_entry_to_pte(entry);
236 if (pte_swp_uffd_wp(oldpte))
237 newpte = pte_swp_mkuffd_wp(newpte);
238 } else if (is_writable_device_exclusive_entry(entry)) {
239 entry = make_readable_device_exclusive_entry(
241 newpte = swp_entry_to_pte(entry);
242 if (pte_swp_soft_dirty(oldpte))
243 newpte = pte_swp_mksoft_dirty(newpte);
244 if (pte_swp_uffd_wp(oldpte))
245 newpte = pte_swp_mkuffd_wp(newpte);
246 } else if (is_pte_marker_entry(entry)) {
248 * Ignore swapin errors unconditionally,
249 * because any access should sigbus anyway.
251 if (is_swapin_error_entry(entry))
254 * If this is uffd-wp pte marker and we'd like
255 * to unprotect it, drop it; the next page
256 * fault will trigger without uffd trapping.
258 if (uffd_wp_resolve) {
259 pte_clear(vma->vm_mm, addr, pte);
268 newpte = pte_swp_mkuffd_wp(newpte);
269 else if (uffd_wp_resolve)
270 newpte = pte_swp_clear_uffd_wp(newpte);
272 if (!pte_same(oldpte, newpte)) {
273 set_pte_at(vma->vm_mm, addr, pte, newpte);
277 /* It must be an none page, or what else?.. */
278 WARN_ON_ONCE(!pte_none(oldpte));
279 if (unlikely(uffd_wp && !vma_is_anonymous(vma))) {
281 * For file-backed mem, we need to be able to
282 * wr-protect a none pte, because even if the
283 * pte is none, the page/swap cache could
284 * exist. Doing that by install a marker.
286 set_pte_at(vma->vm_mm, addr, pte,
287 make_pte_marker(PTE_MARKER_UFFD_WP));
291 } while (pte++, addr += PAGE_SIZE, addr != end);
292 arch_leave_lazy_mmu_mode();
293 pte_unmap_unlock(pte - 1, ptl);
299 * Used when setting automatic NUMA hinting protection where it is
300 * critical that a numa hinting PMD is not confused with a bad PMD.
302 static inline int pmd_none_or_clear_bad_unless_trans_huge(pmd_t *pmd)
304 pmd_t pmdval = pmdp_get_lockless(pmd);
306 /* See pmd_none_or_trans_huge_or_clear_bad for info on barrier */
307 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
311 if (pmd_none(pmdval))
313 if (pmd_trans_huge(pmdval))
315 if (unlikely(pmd_bad(pmdval))) {
323 /* Return true if we're uffd wr-protecting file-backed memory, or false */
325 uffd_wp_protect_file(struct vm_area_struct *vma, unsigned long cp_flags)
327 return (cp_flags & MM_CP_UFFD_WP) && !vma_is_anonymous(vma);
331 * If wr-protecting the range for file-backed, populate pgtable for the case
332 * when pgtable is empty but page cache exists. When {pte|pmd|...}_alloc()
333 * failed we treat it the same way as pgtable allocation failures during
334 * page faults by kicking OOM and returning error.
336 #define change_pmd_prepare(vma, pmd, cp_flags) \
339 if (unlikely(uffd_wp_protect_file(vma, cp_flags))) { \
340 if (pte_alloc(vma->vm_mm, pmd)) \
347 * This is the general pud/p4d/pgd version of change_pmd_prepare(). We need to
348 * have separate change_pmd_prepare() because pte_alloc() returns 0 on success,
349 * while {pmd|pud|p4d}_alloc() returns the valid pointer on success.
351 #define change_prepare(vma, high, low, addr, cp_flags) \
354 if (unlikely(uffd_wp_protect_file(vma, cp_flags))) { \
355 low##_t *p = low##_alloc(vma->vm_mm, high, addr); \
362 static inline long change_pmd_range(struct mmu_gather *tlb,
363 struct vm_area_struct *vma, pud_t *pud, unsigned long addr,
364 unsigned long end, pgprot_t newprot, unsigned long cp_flags)
369 unsigned long nr_huge_updates = 0;
370 struct mmu_notifier_range range;
374 pmd = pmd_offset(pud, addr);
378 next = pmd_addr_end(addr, end);
380 ret = change_pmd_prepare(vma, pmd, cp_flags);
386 * Automatic NUMA balancing walks the tables with mmap_lock
387 * held for read. It's possible a parallel update to occur
388 * between pmd_trans_huge() and a pmd_none_or_clear_bad()
389 * check leading to a false positive and clearing.
390 * Hence, it's necessary to atomically read the PMD value
391 * for all the checks.
393 if (!is_swap_pmd(*pmd) && !pmd_devmap(*pmd) &&
394 pmd_none_or_clear_bad_unless_trans_huge(pmd))
397 /* invoke the mmu notifier if the pmd is populated */
399 mmu_notifier_range_init(&range,
400 MMU_NOTIFY_PROTECTION_VMA, 0,
401 vma->vm_mm, addr, end);
402 mmu_notifier_invalidate_range_start(&range);
405 if (is_swap_pmd(*pmd) || pmd_trans_huge(*pmd) || pmd_devmap(*pmd)) {
406 if ((next - addr != HPAGE_PMD_SIZE) ||
407 uffd_wp_protect_file(vma, cp_flags)) {
408 __split_huge_pmd(vma, pmd, addr, false, NULL);
410 * For file-backed, the pmd could have been
411 * cleared; make sure pmd populated if
412 * necessary, then fall-through to pte level.
414 ret = change_pmd_prepare(vma, pmd, cp_flags);
421 * change_huge_pmd() does not defer TLB flushes,
422 * so no need to propagate the tlb argument.
424 int nr_ptes = change_huge_pmd(tlb, vma, pmd,
425 addr, newprot, cp_flags);
428 if (nr_ptes == HPAGE_PMD_NR) {
429 pages += HPAGE_PMD_NR;
433 /* huge pmd was handled */
437 /* fall through, the trans huge pmd just split */
439 pages += change_pte_range(tlb, vma, pmd, addr, next,
443 } while (pmd++, addr = next, addr != end);
446 mmu_notifier_invalidate_range_end(&range);
449 count_vm_numa_events(NUMA_HUGE_PTE_UPDATES, nr_huge_updates);
453 static inline long change_pud_range(struct mmu_gather *tlb,
454 struct vm_area_struct *vma, p4d_t *p4d, unsigned long addr,
455 unsigned long end, pgprot_t newprot, unsigned long cp_flags)
461 pud = pud_offset(p4d, addr);
463 next = pud_addr_end(addr, end);
464 ret = change_prepare(vma, pud, pmd, addr, cp_flags);
467 if (pud_none_or_clear_bad(pud))
469 pages += change_pmd_range(tlb, vma, pud, addr, next, newprot,
471 } while (pud++, addr = next, addr != end);
476 static inline long change_p4d_range(struct mmu_gather *tlb,
477 struct vm_area_struct *vma, pgd_t *pgd, unsigned long addr,
478 unsigned long end, pgprot_t newprot, unsigned long cp_flags)
484 p4d = p4d_offset(pgd, addr);
486 next = p4d_addr_end(addr, end);
487 ret = change_prepare(vma, p4d, pud, addr, cp_flags);
490 if (p4d_none_or_clear_bad(p4d))
492 pages += change_pud_range(tlb, vma, p4d, addr, next, newprot,
494 } while (p4d++, addr = next, addr != end);
499 static long change_protection_range(struct mmu_gather *tlb,
500 struct vm_area_struct *vma, unsigned long addr,
501 unsigned long end, pgprot_t newprot, unsigned long cp_flags)
503 struct mm_struct *mm = vma->vm_mm;
509 pgd = pgd_offset(mm, addr);
510 tlb_start_vma(tlb, vma);
512 next = pgd_addr_end(addr, end);
513 ret = change_prepare(vma, pgd, p4d, addr, cp_flags);
518 if (pgd_none_or_clear_bad(pgd))
520 pages += change_p4d_range(tlb, vma, pgd, addr, next, newprot,
522 } while (pgd++, addr = next, addr != end);
524 tlb_end_vma(tlb, vma);
529 long change_protection(struct mmu_gather *tlb,
530 struct vm_area_struct *vma, unsigned long start,
531 unsigned long end, unsigned long cp_flags)
533 pgprot_t newprot = vma->vm_page_prot;
536 BUG_ON((cp_flags & MM_CP_UFFD_WP_ALL) == MM_CP_UFFD_WP_ALL);
538 #ifdef CONFIG_NUMA_BALANCING
540 * Ordinary protection updates (mprotect, uffd-wp, softdirty tracking)
541 * are expected to reflect their requirements via VMA flags such that
542 * vma_set_page_prot() will adjust vma->vm_page_prot accordingly.
544 if (cp_flags & MM_CP_PROT_NUMA)
547 WARN_ON_ONCE(cp_flags & MM_CP_PROT_NUMA);
550 if (is_vm_hugetlb_page(vma))
551 pages = hugetlb_change_protection(vma, start, end, newprot,
554 pages = change_protection_range(tlb, vma, start, end, newprot,
560 static int prot_none_pte_entry(pte_t *pte, unsigned long addr,
561 unsigned long next, struct mm_walk *walk)
563 return pfn_modify_allowed(pte_pfn(*pte), *(pgprot_t *)(walk->private)) ?
567 static int prot_none_hugetlb_entry(pte_t *pte, unsigned long hmask,
568 unsigned long addr, unsigned long next,
569 struct mm_walk *walk)
571 return pfn_modify_allowed(pte_pfn(*pte), *(pgprot_t *)(walk->private)) ?
575 static int prot_none_test(unsigned long addr, unsigned long next,
576 struct mm_walk *walk)
581 static const struct mm_walk_ops prot_none_walk_ops = {
582 .pte_entry = prot_none_pte_entry,
583 .hugetlb_entry = prot_none_hugetlb_entry,
584 .test_walk = prot_none_test,
588 mprotect_fixup(struct vma_iterator *vmi, struct mmu_gather *tlb,
589 struct vm_area_struct *vma, struct vm_area_struct **pprev,
590 unsigned long start, unsigned long end, unsigned long newflags)
592 struct mm_struct *mm = vma->vm_mm;
593 unsigned long oldflags = vma->vm_flags;
594 long nrpages = (end - start) >> PAGE_SHIFT;
595 unsigned int mm_cp_flags = 0;
596 unsigned long charged = 0;
600 if (newflags == oldflags) {
606 * Do PROT_NONE PFN permission checks here when we can still
607 * bail out without undoing a lot of state. This is a rather
608 * uncommon case, so doesn't need to be very optimized.
610 if (arch_has_pfn_modify_check() &&
611 (vma->vm_flags & (VM_PFNMAP|VM_MIXEDMAP)) &&
612 (newflags & VM_ACCESS_FLAGS) == 0) {
613 pgprot_t new_pgprot = vm_get_page_prot(newflags);
615 error = walk_page_range(current->mm, start, end,
616 &prot_none_walk_ops, &new_pgprot);
622 * If we make a private mapping writable we increase our commit;
623 * but (without finer accounting) cannot reduce our commit if we
624 * make it unwritable again. hugetlb mapping were accounted for
625 * even if read-only so there is no need to account for them here
627 if (newflags & VM_WRITE) {
628 /* Check space limits when area turns into data. */
629 if (!may_expand_vm(mm, newflags, nrpages) &&
630 may_expand_vm(mm, oldflags, nrpages))
632 if (!(oldflags & (VM_ACCOUNT|VM_WRITE|VM_HUGETLB|
633 VM_SHARED|VM_NORESERVE))) {
635 if (security_vm_enough_memory_mm(mm, charged))
637 newflags |= VM_ACCOUNT;
642 * First try to merge with previous and/or next vma.
644 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
645 *pprev = vma_merge(vmi, mm, *pprev, start, end, newflags,
646 vma->anon_vma, vma->vm_file, pgoff, vma_policy(vma),
647 vma->vm_userfaultfd_ctx, anon_vma_name(vma));
650 VM_WARN_ON((vma->vm_flags ^ newflags) & ~VM_SOFTDIRTY);
656 if (start != vma->vm_start) {
657 error = split_vma(vmi, vma, start, 1);
662 if (end != vma->vm_end) {
663 error = split_vma(vmi, vma, end, 0);
670 * vm_flags and vm_page_prot are protected by the mmap_lock
671 * held in write mode.
673 vm_flags_reset(vma, newflags);
674 if (vma_wants_manual_pte_write_upgrade(vma))
675 mm_cp_flags |= MM_CP_TRY_CHANGE_WRITABLE;
676 vma_set_page_prot(vma);
678 change_protection(tlb, vma, start, end, mm_cp_flags);
681 * Private VM_LOCKED VMA becoming writable: trigger COW to avoid major
684 if ((oldflags & (VM_WRITE | VM_SHARED | VM_LOCKED)) == VM_LOCKED &&
685 (newflags & VM_WRITE)) {
686 populate_vma_page_range(vma, start, end, NULL);
689 vm_stat_account(mm, oldflags, -nrpages);
690 vm_stat_account(mm, newflags, nrpages);
691 perf_event_mmap(vma);
695 vm_unacct_memory(charged);
700 * pkey==-1 when doing a legacy mprotect()
702 static int do_mprotect_pkey(unsigned long start, size_t len,
703 unsigned long prot, int pkey)
705 unsigned long nstart, end, tmp, reqprot;
706 struct vm_area_struct *vma, *prev;
708 const int grows = prot & (PROT_GROWSDOWN|PROT_GROWSUP);
709 const bool rier = (current->personality & READ_IMPLIES_EXEC) &&
711 struct mmu_gather tlb;
712 struct vma_iterator vmi;
714 start = untagged_addr(start);
716 prot &= ~(PROT_GROWSDOWN|PROT_GROWSUP);
717 if (grows == (PROT_GROWSDOWN|PROT_GROWSUP)) /* can't be both */
720 if (start & ~PAGE_MASK)
724 len = PAGE_ALIGN(len);
728 if (!arch_validate_prot(prot, start))
733 if (mmap_write_lock_killable(current->mm))
737 * If userspace did not allocate the pkey, do not let
741 if ((pkey != -1) && !mm_pkey_is_allocated(current->mm, pkey))
744 vma_iter_init(&vmi, current->mm, start);
745 vma = vma_find(&vmi, end);
750 if (unlikely(grows & PROT_GROWSDOWN)) {
751 if (vma->vm_start >= end)
753 start = vma->vm_start;
755 if (!(vma->vm_flags & VM_GROWSDOWN))
758 if (vma->vm_start > start)
760 if (unlikely(grows & PROT_GROWSUP)) {
763 if (!(vma->vm_flags & VM_GROWSUP))
768 prev = vma_prev(&vmi);
769 if (start > vma->vm_start)
772 tlb_gather_mmu(&tlb, current->mm);
775 for_each_vma_range(vmi, vma, end) {
776 unsigned long mask_off_old_flags;
777 unsigned long newflags;
780 if (vma->vm_start != tmp) {
785 /* Does the application expect PROT_READ to imply PROT_EXEC */
786 if (rier && (vma->vm_flags & VM_MAYEXEC))
790 * Each mprotect() call explicitly passes r/w/x permissions.
791 * If a permission is not passed to mprotect(), it must be
792 * cleared from the VMA.
794 mask_off_old_flags = VM_ACCESS_FLAGS | VM_FLAGS_CLEAR;
796 new_vma_pkey = arch_override_mprotect_pkey(vma, prot, pkey);
797 newflags = calc_vm_prot_bits(prot, new_vma_pkey);
798 newflags |= (vma->vm_flags & ~mask_off_old_flags);
800 /* newflags >> 4 shift VM_MAY% in place of VM_% */
801 if ((newflags & ~(newflags >> 4)) & VM_ACCESS_FLAGS) {
806 if (map_deny_write_exec(vma, newflags)) {
811 /* Allow architectures to sanity-check the new flags */
812 if (!arch_validate_flags(newflags)) {
817 error = security_file_mprotect(vma, reqprot, prot);
825 if (vma->vm_ops && vma->vm_ops->mprotect) {
826 error = vma->vm_ops->mprotect(vma, nstart, tmp, newflags);
831 error = mprotect_fixup(&vmi, &tlb, vma, &prev, nstart, tmp, newflags);
835 tmp = vma_iter_end(&vmi);
839 tlb_finish_mmu(&tlb);
841 if (!error && vma_iter_end(&vmi) < end)
845 mmap_write_unlock(current->mm);
849 SYSCALL_DEFINE3(mprotect, unsigned long, start, size_t, len,
852 return do_mprotect_pkey(start, len, prot, -1);
855 #ifdef CONFIG_ARCH_HAS_PKEYS
857 SYSCALL_DEFINE4(pkey_mprotect, unsigned long, start, size_t, len,
858 unsigned long, prot, int, pkey)
860 return do_mprotect_pkey(start, len, prot, pkey);
863 SYSCALL_DEFINE2(pkey_alloc, unsigned long, flags, unsigned long, init_val)
868 /* No flags supported yet. */
871 /* check for unsupported init values */
872 if (init_val & ~PKEY_ACCESS_MASK)
875 mmap_write_lock(current->mm);
876 pkey = mm_pkey_alloc(current->mm);
882 ret = arch_set_user_pkey_access(current, pkey, init_val);
884 mm_pkey_free(current->mm, pkey);
889 mmap_write_unlock(current->mm);
893 SYSCALL_DEFINE1(pkey_free, int, pkey)
897 mmap_write_lock(current->mm);
898 ret = mm_pkey_free(current->mm, pkey);
899 mmap_write_unlock(current->mm);
902 * We could provide warnings or errors if any VMA still
903 * has the pkey set here.
908 #endif /* CONFIG_ARCH_HAS_PKEYS */