1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 2015 Red Hat, Inc.
9 #include <linux/sched/signal.h>
10 #include <linux/pagemap.h>
11 #include <linux/rmap.h>
12 #include <linux/swap.h>
13 #include <linux/swapops.h>
14 #include <linux/userfaultfd_k.h>
15 #include <linux/mmu_notifier.h>
16 #include <linux/hugetlb.h>
17 #include <linux/shmem_fs.h>
18 #include <asm/tlbflush.h>
22 static __always_inline
23 struct vm_area_struct *find_dst_vma(struct mm_struct *dst_mm,
24 unsigned long dst_start,
28 * Make sure that the dst range is both valid and fully within a
29 * single existing vma.
31 struct vm_area_struct *dst_vma;
33 dst_vma = find_vma(dst_mm, dst_start);
37 if (dst_start < dst_vma->vm_start ||
38 dst_start + len > dst_vma->vm_end)
42 * Check the vma is registered in uffd, this is required to
43 * enforce the VM_MAYWRITE check done at uffd registration
46 if (!dst_vma->vm_userfaultfd_ctx.ctx)
53 * Install PTEs, to map dst_addr (within dst_vma) to page.
55 * This function handles both MCOPY_ATOMIC_NORMAL and _CONTINUE for both shmem
56 * and anon, and for both shared and private VMAs.
58 int mfill_atomic_install_pte(struct mm_struct *dst_mm, pmd_t *dst_pmd,
59 struct vm_area_struct *dst_vma,
60 unsigned long dst_addr, struct page *page,
61 bool newly_allocated, bool wp_copy)
64 pte_t _dst_pte, *dst_pte;
65 bool writable = dst_vma->vm_flags & VM_WRITE;
66 bool vm_shared = dst_vma->vm_flags & VM_SHARED;
67 bool page_in_cache = page->mapping;
70 pgoff_t offset, max_off;
72 _dst_pte = mk_pte(page, dst_vma->vm_page_prot);
73 _dst_pte = pte_mkdirty(_dst_pte);
74 if (page_in_cache && !vm_shared)
78 * Always mark a PTE as write-protected when needed, regardless of
79 * VM_WRITE, which the user might change.
82 _dst_pte = pte_mkuffd_wp(_dst_pte);
87 _dst_pte = pte_mkwrite(_dst_pte);
90 * We need this to make sure write bit removed; as mk_pte()
91 * could return a pte with write bit set.
93 _dst_pte = pte_wrprotect(_dst_pte);
95 dst_pte = pte_offset_map_lock(dst_mm, dst_pmd, dst_addr, &ptl);
97 if (vma_is_shmem(dst_vma)) {
98 /* serialize against truncate with the page table lock */
99 inode = dst_vma->vm_file->f_inode;
100 offset = linear_page_index(dst_vma, dst_addr);
101 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
103 if (unlikely(offset >= max_off))
109 * We allow to overwrite a pte marker: consider when both MISSING|WP
110 * registered, we firstly wr-protect a none pte which has no page cache
111 * page backing it, then access the page.
113 if (!pte_none_mostly(*dst_pte))
117 /* Usually, cache pages are already added to LRU */
120 page_add_file_rmap(page, dst_vma, false);
122 page_add_new_anon_rmap(page, dst_vma, dst_addr);
123 lru_cache_add_inactive_or_unevictable(page, dst_vma);
127 * Must happen after rmap, as mm_counter() checks mapping (via
128 * PageAnon()), which is set by __page_set_anon_rmap().
130 inc_mm_counter(dst_mm, mm_counter(page));
132 set_pte_at(dst_mm, dst_addr, dst_pte, _dst_pte);
134 /* No need to invalidate - it was non-present before */
135 update_mmu_cache(dst_vma, dst_addr, dst_pte);
138 pte_unmap_unlock(dst_pte, ptl);
142 static int mcopy_atomic_pte(struct mm_struct *dst_mm,
144 struct vm_area_struct *dst_vma,
145 unsigned long dst_addr,
146 unsigned long src_addr,
156 page = alloc_page_vma(GFP_HIGHUSER_MOVABLE, dst_vma, dst_addr);
160 page_kaddr = kmap_atomic(page);
161 ret = copy_from_user(page_kaddr,
162 (const void __user *) src_addr,
164 kunmap_atomic(page_kaddr);
166 /* fallback to copy_from_user outside mmap_lock */
170 /* don't free the page */
174 flush_dcache_page(page);
181 * The memory barrier inside __SetPageUptodate makes sure that
182 * preceding stores to the page contents become visible before
183 * the set_pte_at() write.
185 __SetPageUptodate(page);
188 if (mem_cgroup_charge(page_folio(page), dst_mm, GFP_KERNEL))
191 ret = mfill_atomic_install_pte(dst_mm, dst_pmd, dst_vma, dst_addr,
192 page, true, wp_copy);
202 static int mfill_zeropage_pte(struct mm_struct *dst_mm,
204 struct vm_area_struct *dst_vma,
205 unsigned long dst_addr)
207 pte_t _dst_pte, *dst_pte;
210 pgoff_t offset, max_off;
213 _dst_pte = pte_mkspecial(pfn_pte(my_zero_pfn(dst_addr),
214 dst_vma->vm_page_prot));
215 dst_pte = pte_offset_map_lock(dst_mm, dst_pmd, dst_addr, &ptl);
216 if (dst_vma->vm_file) {
217 /* the shmem MAP_PRIVATE case requires checking the i_size */
218 inode = dst_vma->vm_file->f_inode;
219 offset = linear_page_index(dst_vma, dst_addr);
220 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
222 if (unlikely(offset >= max_off))
226 if (!pte_none(*dst_pte))
228 set_pte_at(dst_mm, dst_addr, dst_pte, _dst_pte);
229 /* No need to invalidate - it was non-present before */
230 update_mmu_cache(dst_vma, dst_addr, dst_pte);
233 pte_unmap_unlock(dst_pte, ptl);
237 /* Handles UFFDIO_CONTINUE for all shmem VMAs (shared or private). */
238 static int mcontinue_atomic_pte(struct mm_struct *dst_mm,
240 struct vm_area_struct *dst_vma,
241 unsigned long dst_addr,
244 struct inode *inode = file_inode(dst_vma->vm_file);
245 pgoff_t pgoff = linear_page_index(dst_vma, dst_addr);
250 ret = shmem_get_folio(inode, pgoff, &folio, SGP_NOALLOC);
251 /* Our caller expects us to return -EFAULT if we failed to find folio */
261 page = folio_file_page(folio, pgoff);
262 if (PageHWPoison(page)) {
267 ret = mfill_atomic_install_pte(dst_mm, dst_pmd, dst_vma, dst_addr,
268 page, false, wp_copy);
282 static pmd_t *mm_alloc_pmd(struct mm_struct *mm, unsigned long address)
288 pgd = pgd_offset(mm, address);
289 p4d = p4d_alloc(mm, pgd, address);
292 pud = pud_alloc(mm, p4d, address);
296 * Note that we didn't run this because the pmd was
297 * missing, the *pmd may be already established and in
298 * turn it may also be a trans_huge_pmd.
300 return pmd_alloc(mm, pud, address);
303 #ifdef CONFIG_HUGETLB_PAGE
305 * __mcopy_atomic processing for HUGETLB vmas. Note that this routine is
306 * called with mmap_lock held, it will release mmap_lock before returning.
308 static __always_inline ssize_t __mcopy_atomic_hugetlb(struct mm_struct *dst_mm,
309 struct vm_area_struct *dst_vma,
310 unsigned long dst_start,
311 unsigned long src_start,
313 enum mcopy_atomic_mode mode,
316 int vm_shared = dst_vma->vm_flags & VM_SHARED;
319 unsigned long src_addr, dst_addr;
322 unsigned long vma_hpagesize;
325 struct address_space *mapping;
328 * There is no default zero huge page for all huge page sizes as
329 * supported by hugetlb. A PMD_SIZE huge pages may exist as used
330 * by THP. Since we can not reliably insert a zero page, this
331 * feature is not supported.
333 if (mode == MCOPY_ATOMIC_ZEROPAGE) {
334 mmap_read_unlock(dst_mm);
338 src_addr = src_start;
339 dst_addr = dst_start;
342 vma_hpagesize = vma_kernel_pagesize(dst_vma);
345 * Validate alignment based on huge page size
348 if (dst_start & (vma_hpagesize - 1) || len & (vma_hpagesize - 1))
353 * On routine entry dst_vma is set. If we had to drop mmap_lock and
354 * retry, dst_vma will be set to NULL and we must lookup again.
358 dst_vma = find_dst_vma(dst_mm, dst_start, len);
359 if (!dst_vma || !is_vm_hugetlb_page(dst_vma))
363 if (vma_hpagesize != vma_kernel_pagesize(dst_vma))
366 vm_shared = dst_vma->vm_flags & VM_SHARED;
370 * If not shared, ensure the dst_vma has a anon_vma.
374 if (unlikely(anon_vma_prepare(dst_vma)))
378 while (src_addr < src_start + len) {
379 BUG_ON(dst_addr >= dst_start + len);
382 * Serialize via vma_lock and hugetlb_fault_mutex.
383 * vma_lock ensures the dst_pte remains valid even
384 * in the case of shared pmds. fault mutex prevents
385 * races with other faulting threads.
387 idx = linear_page_index(dst_vma, dst_addr);
388 mapping = dst_vma->vm_file->f_mapping;
389 hash = hugetlb_fault_mutex_hash(mapping, idx);
390 mutex_lock(&hugetlb_fault_mutex_table[hash]);
391 hugetlb_vma_lock_read(dst_vma);
394 dst_pte = huge_pte_alloc(dst_mm, dst_vma, dst_addr, vma_hpagesize);
396 hugetlb_vma_unlock_read(dst_vma);
397 mutex_unlock(&hugetlb_fault_mutex_table[hash]);
401 if (mode != MCOPY_ATOMIC_CONTINUE &&
402 !huge_pte_none_mostly(huge_ptep_get(dst_pte))) {
404 hugetlb_vma_unlock_read(dst_vma);
405 mutex_unlock(&hugetlb_fault_mutex_table[hash]);
409 err = hugetlb_mcopy_atomic_pte(dst_mm, dst_pte, dst_vma,
410 dst_addr, src_addr, mode, &page,
413 hugetlb_vma_unlock_read(dst_vma);
414 mutex_unlock(&hugetlb_fault_mutex_table[hash]);
418 if (unlikely(err == -ENOENT)) {
419 mmap_read_unlock(dst_mm);
422 err = copy_huge_page_from_user(page,
423 (const void __user *)src_addr,
424 vma_hpagesize / PAGE_SIZE,
430 mmap_read_lock(dst_mm);
438 dst_addr += vma_hpagesize;
439 src_addr += vma_hpagesize;
440 copied += vma_hpagesize;
442 if (fatal_signal_pending(current))
450 mmap_read_unlock(dst_mm);
456 BUG_ON(!copied && !err);
457 return copied ? copied : err;
459 #else /* !CONFIG_HUGETLB_PAGE */
460 /* fail at build time if gcc attempts to use this */
461 extern ssize_t __mcopy_atomic_hugetlb(struct mm_struct *dst_mm,
462 struct vm_area_struct *dst_vma,
463 unsigned long dst_start,
464 unsigned long src_start,
466 enum mcopy_atomic_mode mode,
468 #endif /* CONFIG_HUGETLB_PAGE */
470 static __always_inline ssize_t mfill_atomic_pte(struct mm_struct *dst_mm,
472 struct vm_area_struct *dst_vma,
473 unsigned long dst_addr,
474 unsigned long src_addr,
476 enum mcopy_atomic_mode mode,
481 if (mode == MCOPY_ATOMIC_CONTINUE) {
482 return mcontinue_atomic_pte(dst_mm, dst_pmd, dst_vma, dst_addr,
487 * The normal page fault path for a shmem will invoke the
488 * fault, fill the hole in the file and COW it right away. The
489 * result generates plain anonymous memory. So when we are
490 * asked to fill an hole in a MAP_PRIVATE shmem mapping, we'll
491 * generate anonymous memory directly without actually filling
492 * the hole. For the MAP_PRIVATE case the robustness check
493 * only happens in the pagetable (to verify it's still none)
494 * and not in the radix tree.
496 if (!(dst_vma->vm_flags & VM_SHARED)) {
497 if (mode == MCOPY_ATOMIC_NORMAL)
498 err = mcopy_atomic_pte(dst_mm, dst_pmd, dst_vma,
499 dst_addr, src_addr, page,
502 err = mfill_zeropage_pte(dst_mm, dst_pmd,
505 err = shmem_mfill_atomic_pte(dst_mm, dst_pmd, dst_vma,
507 mode != MCOPY_ATOMIC_NORMAL,
514 static __always_inline ssize_t __mcopy_atomic(struct mm_struct *dst_mm,
515 unsigned long dst_start,
516 unsigned long src_start,
518 enum mcopy_atomic_mode mcopy_mode,
519 atomic_t *mmap_changing,
522 struct vm_area_struct *dst_vma;
525 unsigned long src_addr, dst_addr;
531 * Sanitize the command parameters:
533 BUG_ON(dst_start & ~PAGE_MASK);
534 BUG_ON(len & ~PAGE_MASK);
536 /* Does the address range wrap, or is the span zero-sized? */
537 BUG_ON(src_start + len <= src_start);
538 BUG_ON(dst_start + len <= dst_start);
540 src_addr = src_start;
541 dst_addr = dst_start;
545 mmap_read_lock(dst_mm);
548 * If memory mappings are changing because of non-cooperative
549 * operation (e.g. mremap) running in parallel, bail out and
550 * request the user to retry later
553 if (mmap_changing && atomic_read(mmap_changing))
557 * Make sure the vma is not shared, that the dst range is
558 * both valid and fully within a single existing vma.
561 dst_vma = find_dst_vma(dst_mm, dst_start, len);
567 * shmem_zero_setup is invoked in mmap for MAP_ANONYMOUS|MAP_SHARED but
568 * it will overwrite vm_ops, so vma_is_anonymous must return false.
570 if (WARN_ON_ONCE(vma_is_anonymous(dst_vma) &&
571 dst_vma->vm_flags & VM_SHARED))
575 * validate 'mode' now that we know the dst_vma: don't allow
576 * a wrprotect copy if the userfaultfd didn't register as WP.
578 wp_copy = mode & UFFDIO_COPY_MODE_WP;
579 if (wp_copy && !(dst_vma->vm_flags & VM_UFFD_WP))
583 * If this is a HUGETLB vma, pass off to appropriate routine
585 if (is_vm_hugetlb_page(dst_vma))
586 return __mcopy_atomic_hugetlb(dst_mm, dst_vma, dst_start,
587 src_start, len, mcopy_mode,
590 if (!vma_is_anonymous(dst_vma) && !vma_is_shmem(dst_vma))
592 if (!vma_is_shmem(dst_vma) && mcopy_mode == MCOPY_ATOMIC_CONTINUE)
596 * Ensure the dst_vma has a anon_vma or this page
597 * would get a NULL anon_vma when moved in the
601 if (!(dst_vma->vm_flags & VM_SHARED) &&
602 unlikely(anon_vma_prepare(dst_vma)))
605 while (src_addr < src_start + len) {
608 BUG_ON(dst_addr >= dst_start + len);
610 dst_pmd = mm_alloc_pmd(dst_mm, dst_addr);
611 if (unlikely(!dst_pmd)) {
616 dst_pmdval = pmd_read_atomic(dst_pmd);
618 * If the dst_pmd is mapped as THP don't
619 * override it and just be strict.
621 if (unlikely(pmd_trans_huge(dst_pmdval))) {
625 if (unlikely(pmd_none(dst_pmdval)) &&
626 unlikely(__pte_alloc(dst_mm, dst_pmd))) {
630 /* If an huge pmd materialized from under us fail */
631 if (unlikely(pmd_trans_huge(*dst_pmd))) {
636 BUG_ON(pmd_none(*dst_pmd));
637 BUG_ON(pmd_trans_huge(*dst_pmd));
639 err = mfill_atomic_pte(dst_mm, dst_pmd, dst_vma, dst_addr,
640 src_addr, &page, mcopy_mode, wp_copy);
643 if (unlikely(err == -ENOENT)) {
646 mmap_read_unlock(dst_mm);
649 page_kaddr = kmap(page);
650 err = copy_from_user(page_kaddr,
651 (const void __user *) src_addr,
658 flush_dcache_page(page);
664 dst_addr += PAGE_SIZE;
665 src_addr += PAGE_SIZE;
668 if (fatal_signal_pending(current))
676 mmap_read_unlock(dst_mm);
682 BUG_ON(!copied && !err);
683 return copied ? copied : err;
686 ssize_t mcopy_atomic(struct mm_struct *dst_mm, unsigned long dst_start,
687 unsigned long src_start, unsigned long len,
688 atomic_t *mmap_changing, __u64 mode)
690 return __mcopy_atomic(dst_mm, dst_start, src_start, len,
691 MCOPY_ATOMIC_NORMAL, mmap_changing, mode);
694 ssize_t mfill_zeropage(struct mm_struct *dst_mm, unsigned long start,
695 unsigned long len, atomic_t *mmap_changing)
697 return __mcopy_atomic(dst_mm, start, 0, len, MCOPY_ATOMIC_ZEROPAGE,
701 ssize_t mcopy_continue(struct mm_struct *dst_mm, unsigned long start,
702 unsigned long len, atomic_t *mmap_changing)
704 return __mcopy_atomic(dst_mm, start, 0, len, MCOPY_ATOMIC_CONTINUE,
708 void uffd_wp_range(struct mm_struct *dst_mm, struct vm_area_struct *dst_vma,
709 unsigned long start, unsigned long len, bool enable_wp)
711 struct mmu_gather tlb;
715 newprot = vm_get_page_prot(dst_vma->vm_flags & ~(VM_WRITE));
717 newprot = vm_get_page_prot(dst_vma->vm_flags);
719 tlb_gather_mmu(&tlb, dst_mm);
720 change_protection(&tlb, dst_vma, start, start + len, newprot,
721 enable_wp ? MM_CP_UFFD_WP : MM_CP_UFFD_WP_RESOLVE);
722 tlb_finish_mmu(&tlb);
725 int mwriteprotect_range(struct mm_struct *dst_mm, unsigned long start,
726 unsigned long len, bool enable_wp,
727 atomic_t *mmap_changing)
729 struct vm_area_struct *dst_vma;
730 unsigned long page_mask;
734 * Sanitize the command parameters:
736 BUG_ON(start & ~PAGE_MASK);
737 BUG_ON(len & ~PAGE_MASK);
739 /* Does the address range wrap, or is the span zero-sized? */
740 BUG_ON(start + len <= start);
742 mmap_read_lock(dst_mm);
745 * If memory mappings are changing because of non-cooperative
746 * operation (e.g. mremap) running in parallel, bail out and
747 * request the user to retry later
750 if (mmap_changing && atomic_read(mmap_changing))
754 dst_vma = find_dst_vma(dst_mm, start, len);
758 if (!userfaultfd_wp(dst_vma))
760 if (!vma_can_userfault(dst_vma, dst_vma->vm_flags))
763 if (is_vm_hugetlb_page(dst_vma)) {
765 page_mask = vma_kernel_pagesize(dst_vma) - 1;
766 if ((start & page_mask) || (len & page_mask))
770 uffd_wp_range(dst_mm, dst_vma, start, len, enable_wp);
774 mmap_read_unlock(dst_mm);