xref: /openbmc/linux/fs/userfaultfd.c (revision 51d3d5eb74ff53b92dcff48b30ae2ed8edd85a32)
120c8ccb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
286039bd3SAndrea Arcangeli /*
386039bd3SAndrea Arcangeli  *  fs/userfaultfd.c
486039bd3SAndrea Arcangeli  *
586039bd3SAndrea Arcangeli  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
686039bd3SAndrea Arcangeli  *  Copyright (C) 2008-2009 Red Hat, Inc.
786039bd3SAndrea Arcangeli  *  Copyright (C) 2015  Red Hat, Inc.
886039bd3SAndrea Arcangeli  *
986039bd3SAndrea Arcangeli  *  Some part derived from fs/eventfd.c (anon inode setup) and
1086039bd3SAndrea Arcangeli  *  mm/ksm.c (mm hashing).
1186039bd3SAndrea Arcangeli  */
1286039bd3SAndrea Arcangeli 
139cd75c3cSPavel Emelyanov #include <linux/list.h>
1486039bd3SAndrea Arcangeli #include <linux/hashtable.h>
15174cd4b1SIngo Molnar #include <linux/sched/signal.h>
166e84f315SIngo Molnar #include <linux/sched/mm.h>
1786039bd3SAndrea Arcangeli #include <linux/mm.h>
1817fca131SArnd Bergmann #include <linux/mm_inline.h>
196dfeaff9SPeter Xu #include <linux/mmu_notifier.h>
2086039bd3SAndrea Arcangeli #include <linux/poll.h>
2186039bd3SAndrea Arcangeli #include <linux/slab.h>
2286039bd3SAndrea Arcangeli #include <linux/seq_file.h>
2386039bd3SAndrea Arcangeli #include <linux/file.h>
2486039bd3SAndrea Arcangeli #include <linux/bug.h>
2586039bd3SAndrea Arcangeli #include <linux/anon_inodes.h>
2686039bd3SAndrea Arcangeli #include <linux/syscalls.h>
2786039bd3SAndrea Arcangeli #include <linux/userfaultfd_k.h>
2886039bd3SAndrea Arcangeli #include <linux/mempolicy.h>
2986039bd3SAndrea Arcangeli #include <linux/ioctl.h>
3086039bd3SAndrea Arcangeli #include <linux/security.h>
31cab350afSMike Kravetz #include <linux/hugetlb.h>
325c041f5dSPeter Xu #include <linux/swapops.h>
332d5de004SAxel Rasmussen #include <linux/miscdevice.h>
3486039bd3SAndrea Arcangeli 
35d0d4730aSLokesh Gidra int sysctl_unprivileged_userfaultfd __read_mostly;
36cefdca0aSPeter Xu 
373004ec9cSAndrea Arcangeli static struct kmem_cache *userfaultfd_ctx_cachep __read_mostly;
383004ec9cSAndrea Arcangeli 
393004ec9cSAndrea Arcangeli /*
403004ec9cSAndrea Arcangeli  * Start with fault_pending_wqh and fault_wqh so they're more likely
413004ec9cSAndrea Arcangeli  * to be in the same cacheline.
42cbcfa130SEric Biggers  *
43cbcfa130SEric Biggers  * Locking order:
44cbcfa130SEric Biggers  *	fd_wqh.lock
45cbcfa130SEric Biggers  *		fault_pending_wqh.lock
46cbcfa130SEric Biggers  *			fault_wqh.lock
47cbcfa130SEric Biggers  *		event_wqh.lock
48cbcfa130SEric Biggers  *
49cbcfa130SEric Biggers  * To avoid deadlocks, IRQs must be disabled when taking any of the above locks,
50cbcfa130SEric Biggers  * since fd_wqh.lock is taken by aio_poll() while it's holding a lock that's
51cbcfa130SEric Biggers  * also taken in IRQ context.
523004ec9cSAndrea Arcangeli  */
5386039bd3SAndrea Arcangeli struct userfaultfd_ctx {
5415b726efSAndrea Arcangeli 	/* waitqueue head for the pending (i.e. not read) userfaults */
5515b726efSAndrea Arcangeli 	wait_queue_head_t fault_pending_wqh;
5615b726efSAndrea Arcangeli 	/* waitqueue head for the userfaults */
5786039bd3SAndrea Arcangeli 	wait_queue_head_t fault_wqh;
5886039bd3SAndrea Arcangeli 	/* waitqueue head for the pseudo fd to wakeup poll/read */
5986039bd3SAndrea Arcangeli 	wait_queue_head_t fd_wqh;
609cd75c3cSPavel Emelyanov 	/* waitqueue head for events */
619cd75c3cSPavel Emelyanov 	wait_queue_head_t event_wqh;
622c5b7e1bSAndrea Arcangeli 	/* a refile sequence protected by fault_pending_wqh lock */
632ca97ac8SAhmed S. Darwish 	seqcount_spinlock_t refile_seq;
643004ec9cSAndrea Arcangeli 	/* pseudo fd refcounting */
65ca880420SEric Biggers 	refcount_t refcount;
6686039bd3SAndrea Arcangeli 	/* userfaultfd syscall flags */
6786039bd3SAndrea Arcangeli 	unsigned int flags;
689cd75c3cSPavel Emelyanov 	/* features requested from the userspace */
699cd75c3cSPavel Emelyanov 	unsigned int features;
7086039bd3SAndrea Arcangeli 	/* released */
7186039bd3SAndrea Arcangeli 	bool released;
72df2cc96eSMike Rapoport 	/* memory mappings are changing because of non-cooperative event */
73a759a909SNadav Amit 	atomic_t mmap_changing;
7486039bd3SAndrea Arcangeli 	/* mm with one ore more vmas attached to this userfaultfd_ctx */
7586039bd3SAndrea Arcangeli 	struct mm_struct *mm;
7686039bd3SAndrea Arcangeli };
7786039bd3SAndrea Arcangeli 
78893e26e6SPavel Emelyanov struct userfaultfd_fork_ctx {
79893e26e6SPavel Emelyanov 	struct userfaultfd_ctx *orig;
80893e26e6SPavel Emelyanov 	struct userfaultfd_ctx *new;
81893e26e6SPavel Emelyanov 	struct list_head list;
82893e26e6SPavel Emelyanov };
83893e26e6SPavel Emelyanov 
84897ab3e0SMike Rapoport struct userfaultfd_unmap_ctx {
85897ab3e0SMike Rapoport 	struct userfaultfd_ctx *ctx;
86897ab3e0SMike Rapoport 	unsigned long start;
87897ab3e0SMike Rapoport 	unsigned long end;
88897ab3e0SMike Rapoport 	struct list_head list;
89897ab3e0SMike Rapoport };
90897ab3e0SMike Rapoport 
9186039bd3SAndrea Arcangeli struct userfaultfd_wait_queue {
92a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
93ac6424b9SIngo Molnar 	wait_queue_entry_t wq;
9486039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
9515a77c6fSAndrea Arcangeli 	bool waken;
9686039bd3SAndrea Arcangeli };
9786039bd3SAndrea Arcangeli 
9886039bd3SAndrea Arcangeli struct userfaultfd_wake_range {
9986039bd3SAndrea Arcangeli 	unsigned long start;
10086039bd3SAndrea Arcangeli 	unsigned long len;
10186039bd3SAndrea Arcangeli };
10286039bd3SAndrea Arcangeli 
10322e5fe2aSNadav Amit /* internal indication that UFFD_API ioctl was successfully executed */
10422e5fe2aSNadav Amit #define UFFD_FEATURE_INITIALIZED		(1u << 31)
10522e5fe2aSNadav Amit 
10622e5fe2aSNadav Amit static bool userfaultfd_is_initialized(struct userfaultfd_ctx *ctx)
10722e5fe2aSNadav Amit {
10822e5fe2aSNadav Amit 	return ctx->features & UFFD_FEATURE_INITIALIZED;
10922e5fe2aSNadav Amit }
11022e5fe2aSNadav Amit 
111*51d3d5ebSDavid Hildenbrand static void userfaultfd_set_vm_flags(struct vm_area_struct *vma,
112*51d3d5ebSDavid Hildenbrand 				     vm_flags_t flags)
113*51d3d5ebSDavid Hildenbrand {
114*51d3d5ebSDavid Hildenbrand 	const bool uffd_wp_changed = (vma->vm_flags ^ flags) & VM_UFFD_WP;
115*51d3d5ebSDavid Hildenbrand 
116*51d3d5ebSDavid Hildenbrand 	vma->vm_flags = flags;
117*51d3d5ebSDavid Hildenbrand 	/*
118*51d3d5ebSDavid Hildenbrand 	 * For shared mappings, we want to enable writenotify while
119*51d3d5ebSDavid Hildenbrand 	 * userfaultfd-wp is enabled (see vma_wants_writenotify()). We'll simply
120*51d3d5ebSDavid Hildenbrand 	 * recalculate vma->vm_page_prot whenever userfaultfd-wp changes.
121*51d3d5ebSDavid Hildenbrand 	 */
122*51d3d5ebSDavid Hildenbrand 	if ((vma->vm_flags & VM_SHARED) && uffd_wp_changed)
123*51d3d5ebSDavid Hildenbrand 		vma_set_page_prot(vma);
124*51d3d5ebSDavid Hildenbrand }
125*51d3d5ebSDavid Hildenbrand 
126ac6424b9SIngo Molnar static int userfaultfd_wake_function(wait_queue_entry_t *wq, unsigned mode,
12786039bd3SAndrea Arcangeli 				     int wake_flags, void *key)
12886039bd3SAndrea Arcangeli {
12986039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range *range = key;
13086039bd3SAndrea Arcangeli 	int ret;
13186039bd3SAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
13286039bd3SAndrea Arcangeli 	unsigned long start, len;
13386039bd3SAndrea Arcangeli 
13486039bd3SAndrea Arcangeli 	uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
13586039bd3SAndrea Arcangeli 	ret = 0;
13686039bd3SAndrea Arcangeli 	/* len == 0 means wake all */
13786039bd3SAndrea Arcangeli 	start = range->start;
13886039bd3SAndrea Arcangeli 	len = range->len;
139a9b85f94SAndrea Arcangeli 	if (len && (start > uwq->msg.arg.pagefault.address ||
140a9b85f94SAndrea Arcangeli 		    start + len <= uwq->msg.arg.pagefault.address))
14186039bd3SAndrea Arcangeli 		goto out;
14215a77c6fSAndrea Arcangeli 	WRITE_ONCE(uwq->waken, true);
14315a77c6fSAndrea Arcangeli 	/*
144a9668cd6SPeter Zijlstra 	 * The Program-Order guarantees provided by the scheduler
145a9668cd6SPeter Zijlstra 	 * ensure uwq->waken is visible before the task is woken.
14615a77c6fSAndrea Arcangeli 	 */
14786039bd3SAndrea Arcangeli 	ret = wake_up_state(wq->private, mode);
148a9668cd6SPeter Zijlstra 	if (ret) {
14986039bd3SAndrea Arcangeli 		/*
15086039bd3SAndrea Arcangeli 		 * Wake only once, autoremove behavior.
15186039bd3SAndrea Arcangeli 		 *
152a9668cd6SPeter Zijlstra 		 * After the effect of list_del_init is visible to the other
153a9668cd6SPeter Zijlstra 		 * CPUs, the waitqueue may disappear from under us, see the
154a9668cd6SPeter Zijlstra 		 * !list_empty_careful() in handle_userfault().
155a9668cd6SPeter Zijlstra 		 *
156a9668cd6SPeter Zijlstra 		 * try_to_wake_up() has an implicit smp_mb(), and the
157a9668cd6SPeter Zijlstra 		 * wq->private is read before calling the extern function
158a9668cd6SPeter Zijlstra 		 * "wake_up_state" (which in turns calls try_to_wake_up).
15986039bd3SAndrea Arcangeli 		 */
1602055da97SIngo Molnar 		list_del_init(&wq->entry);
161a9668cd6SPeter Zijlstra 	}
16286039bd3SAndrea Arcangeli out:
16386039bd3SAndrea Arcangeli 	return ret;
16486039bd3SAndrea Arcangeli }
16586039bd3SAndrea Arcangeli 
16686039bd3SAndrea Arcangeli /**
16786039bd3SAndrea Arcangeli  * userfaultfd_ctx_get - Acquires a reference to the internal userfaultfd
16886039bd3SAndrea Arcangeli  * context.
16986039bd3SAndrea Arcangeli  * @ctx: [in] Pointer to the userfaultfd context.
17086039bd3SAndrea Arcangeli  */
17186039bd3SAndrea Arcangeli static void userfaultfd_ctx_get(struct userfaultfd_ctx *ctx)
17286039bd3SAndrea Arcangeli {
173ca880420SEric Biggers 	refcount_inc(&ctx->refcount);
17486039bd3SAndrea Arcangeli }
17586039bd3SAndrea Arcangeli 
17686039bd3SAndrea Arcangeli /**
17786039bd3SAndrea Arcangeli  * userfaultfd_ctx_put - Releases a reference to the internal userfaultfd
17886039bd3SAndrea Arcangeli  * context.
17986039bd3SAndrea Arcangeli  * @ctx: [in] Pointer to userfaultfd context.
18086039bd3SAndrea Arcangeli  *
18186039bd3SAndrea Arcangeli  * The userfaultfd context reference must have been previously acquired either
18286039bd3SAndrea Arcangeli  * with userfaultfd_ctx_get() or userfaultfd_ctx_fdget().
18386039bd3SAndrea Arcangeli  */
18486039bd3SAndrea Arcangeli static void userfaultfd_ctx_put(struct userfaultfd_ctx *ctx)
18586039bd3SAndrea Arcangeli {
186ca880420SEric Biggers 	if (refcount_dec_and_test(&ctx->refcount)) {
18786039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fault_pending_wqh.lock));
18886039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fault_pending_wqh));
18986039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fault_wqh.lock));
19086039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fault_wqh));
1919cd75c3cSPavel Emelyanov 		VM_BUG_ON(spin_is_locked(&ctx->event_wqh.lock));
1929cd75c3cSPavel Emelyanov 		VM_BUG_ON(waitqueue_active(&ctx->event_wqh));
19386039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fd_wqh.lock));
19486039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fd_wqh));
195d2005e3fSOleg Nesterov 		mmdrop(ctx->mm);
1963004ec9cSAndrea Arcangeli 		kmem_cache_free(userfaultfd_ctx_cachep, ctx);
19786039bd3SAndrea Arcangeli 	}
19886039bd3SAndrea Arcangeli }
19986039bd3SAndrea Arcangeli 
200a9b85f94SAndrea Arcangeli static inline void msg_init(struct uffd_msg *msg)
201a9b85f94SAndrea Arcangeli {
202a9b85f94SAndrea Arcangeli 	BUILD_BUG_ON(sizeof(struct uffd_msg) != 32);
203a9b85f94SAndrea Arcangeli 	/*
204a9b85f94SAndrea Arcangeli 	 * Must use memset to zero out the paddings or kernel data is
205a9b85f94SAndrea Arcangeli 	 * leaked to userland.
206a9b85f94SAndrea Arcangeli 	 */
207a9b85f94SAndrea Arcangeli 	memset(msg, 0, sizeof(struct uffd_msg));
208a9b85f94SAndrea Arcangeli }
209a9b85f94SAndrea Arcangeli 
210a9b85f94SAndrea Arcangeli static inline struct uffd_msg userfault_msg(unsigned long address,
211d172b1a3SNadav Amit 					    unsigned long real_address,
21286039bd3SAndrea Arcangeli 					    unsigned int flags,
2139d4ac934SAlexey Perevalov 					    unsigned long reason,
2149d4ac934SAlexey Perevalov 					    unsigned int features)
21586039bd3SAndrea Arcangeli {
216a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
217d172b1a3SNadav Amit 
218a9b85f94SAndrea Arcangeli 	msg_init(&msg);
219a9b85f94SAndrea Arcangeli 	msg.event = UFFD_EVENT_PAGEFAULT;
220824ddc60SNadav Amit 
221d172b1a3SNadav Amit 	msg.arg.pagefault.address = (features & UFFD_FEATURE_EXACT_ADDRESS) ?
222d172b1a3SNadav Amit 				    real_address : address;
223d172b1a3SNadav Amit 
22486039bd3SAndrea Arcangeli 	/*
2257677f7fdSAxel Rasmussen 	 * These flags indicate why the userfault occurred:
2267677f7fdSAxel Rasmussen 	 * - UFFD_PAGEFAULT_FLAG_WP indicates a write protect fault.
2277677f7fdSAxel Rasmussen 	 * - UFFD_PAGEFAULT_FLAG_MINOR indicates a minor fault.
2287677f7fdSAxel Rasmussen 	 * - Neither of these flags being set indicates a MISSING fault.
2297677f7fdSAxel Rasmussen 	 *
2307677f7fdSAxel Rasmussen 	 * Separately, UFFD_PAGEFAULT_FLAG_WRITE indicates it was a write
2317677f7fdSAxel Rasmussen 	 * fault. Otherwise, it was a read fault.
23286039bd3SAndrea Arcangeli 	 */
2337677f7fdSAxel Rasmussen 	if (flags & FAULT_FLAG_WRITE)
234a9b85f94SAndrea Arcangeli 		msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WRITE;
23586039bd3SAndrea Arcangeli 	if (reason & VM_UFFD_WP)
236a9b85f94SAndrea Arcangeli 		msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WP;
2377677f7fdSAxel Rasmussen 	if (reason & VM_UFFD_MINOR)
2387677f7fdSAxel Rasmussen 		msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_MINOR;
2399d4ac934SAlexey Perevalov 	if (features & UFFD_FEATURE_THREAD_ID)
240a36985d3SAndrea Arcangeli 		msg.arg.pagefault.feat.ptid = task_pid_vnr(current);
241a9b85f94SAndrea Arcangeli 	return msg;
24286039bd3SAndrea Arcangeli }
24386039bd3SAndrea Arcangeli 
244369cd212SMike Kravetz #ifdef CONFIG_HUGETLB_PAGE
245369cd212SMike Kravetz /*
246369cd212SMike Kravetz  * Same functionality as userfaultfd_must_wait below with modifications for
247369cd212SMike Kravetz  * hugepmd ranges.
248369cd212SMike Kravetz  */
249369cd212SMike Kravetz static inline bool userfaultfd_huge_must_wait(struct userfaultfd_ctx *ctx,
2507868a208SPunit Agrawal 					 struct vm_area_struct *vma,
251369cd212SMike Kravetz 					 unsigned long address,
252369cd212SMike Kravetz 					 unsigned long flags,
253369cd212SMike Kravetz 					 unsigned long reason)
254369cd212SMike Kravetz {
255369cd212SMike Kravetz 	struct mm_struct *mm = ctx->mm;
2561e2c0436SJanosch Frank 	pte_t *ptep, pte;
257369cd212SMike Kravetz 	bool ret = true;
258369cd212SMike Kravetz 
25942fc5414SMichel Lespinasse 	mmap_assert_locked(mm);
260369cd212SMike Kravetz 
2611e2c0436SJanosch Frank 	ptep = huge_pte_offset(mm, address, vma_mmu_pagesize(vma));
2621e2c0436SJanosch Frank 
2631e2c0436SJanosch Frank 	if (!ptep)
264369cd212SMike Kravetz 		goto out;
265369cd212SMike Kravetz 
266369cd212SMike Kravetz 	ret = false;
2671e2c0436SJanosch Frank 	pte = huge_ptep_get(ptep);
268369cd212SMike Kravetz 
269369cd212SMike Kravetz 	/*
270369cd212SMike Kravetz 	 * Lockless access: we're in a wait_event so it's ok if it
2715c041f5dSPeter Xu 	 * changes under us.  PTE markers should be handled the same as none
2725c041f5dSPeter Xu 	 * ptes here.
273369cd212SMike Kravetz 	 */
2745c041f5dSPeter Xu 	if (huge_pte_none_mostly(pte))
275369cd212SMike Kravetz 		ret = true;
2761e2c0436SJanosch Frank 	if (!huge_pte_write(pte) && (reason & VM_UFFD_WP))
277369cd212SMike Kravetz 		ret = true;
278369cd212SMike Kravetz out:
279369cd212SMike Kravetz 	return ret;
280369cd212SMike Kravetz }
281369cd212SMike Kravetz #else
282369cd212SMike Kravetz static inline bool userfaultfd_huge_must_wait(struct userfaultfd_ctx *ctx,
2837868a208SPunit Agrawal 					 struct vm_area_struct *vma,
284369cd212SMike Kravetz 					 unsigned long address,
285369cd212SMike Kravetz 					 unsigned long flags,
286369cd212SMike Kravetz 					 unsigned long reason)
287369cd212SMike Kravetz {
288369cd212SMike Kravetz 	return false;	/* should never get here */
289369cd212SMike Kravetz }
290369cd212SMike Kravetz #endif /* CONFIG_HUGETLB_PAGE */
291369cd212SMike Kravetz 
29286039bd3SAndrea Arcangeli /*
2938d2afd96SAndrea Arcangeli  * Verify the pagetables are still not ok after having reigstered into
2948d2afd96SAndrea Arcangeli  * the fault_pending_wqh to avoid userland having to UFFDIO_WAKE any
2958d2afd96SAndrea Arcangeli  * userfault that has already been resolved, if userfaultfd_read and
2968d2afd96SAndrea Arcangeli  * UFFDIO_COPY|ZEROPAGE are being run simultaneously on two different
2978d2afd96SAndrea Arcangeli  * threads.
2988d2afd96SAndrea Arcangeli  */
2998d2afd96SAndrea Arcangeli static inline bool userfaultfd_must_wait(struct userfaultfd_ctx *ctx,
3008d2afd96SAndrea Arcangeli 					 unsigned long address,
3018d2afd96SAndrea Arcangeli 					 unsigned long flags,
3028d2afd96SAndrea Arcangeli 					 unsigned long reason)
3038d2afd96SAndrea Arcangeli {
3048d2afd96SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
3058d2afd96SAndrea Arcangeli 	pgd_t *pgd;
306c2febafcSKirill A. Shutemov 	p4d_t *p4d;
3078d2afd96SAndrea Arcangeli 	pud_t *pud;
3088d2afd96SAndrea Arcangeli 	pmd_t *pmd, _pmd;
3098d2afd96SAndrea Arcangeli 	pte_t *pte;
3108d2afd96SAndrea Arcangeli 	bool ret = true;
3118d2afd96SAndrea Arcangeli 
31242fc5414SMichel Lespinasse 	mmap_assert_locked(mm);
3138d2afd96SAndrea Arcangeli 
3148d2afd96SAndrea Arcangeli 	pgd = pgd_offset(mm, address);
3158d2afd96SAndrea Arcangeli 	if (!pgd_present(*pgd))
3168d2afd96SAndrea Arcangeli 		goto out;
317c2febafcSKirill A. Shutemov 	p4d = p4d_offset(pgd, address);
318c2febafcSKirill A. Shutemov 	if (!p4d_present(*p4d))
319c2febafcSKirill A. Shutemov 		goto out;
320c2febafcSKirill A. Shutemov 	pud = pud_offset(p4d, address);
3218d2afd96SAndrea Arcangeli 	if (!pud_present(*pud))
3228d2afd96SAndrea Arcangeli 		goto out;
3238d2afd96SAndrea Arcangeli 	pmd = pmd_offset(pud, address);
3248d2afd96SAndrea Arcangeli 	/*
3258d2afd96SAndrea Arcangeli 	 * READ_ONCE must function as a barrier with narrower scope
3268d2afd96SAndrea Arcangeli 	 * and it must be equivalent to:
3278d2afd96SAndrea Arcangeli 	 *	_pmd = *pmd; barrier();
3288d2afd96SAndrea Arcangeli 	 *
3298d2afd96SAndrea Arcangeli 	 * This is to deal with the instability (as in
3308d2afd96SAndrea Arcangeli 	 * pmd_trans_unstable) of the pmd.
3318d2afd96SAndrea Arcangeli 	 */
3328d2afd96SAndrea Arcangeli 	_pmd = READ_ONCE(*pmd);
333a365ac09SHuang Ying 	if (pmd_none(_pmd))
3348d2afd96SAndrea Arcangeli 		goto out;
3358d2afd96SAndrea Arcangeli 
3368d2afd96SAndrea Arcangeli 	ret = false;
337a365ac09SHuang Ying 	if (!pmd_present(_pmd))
338a365ac09SHuang Ying 		goto out;
339a365ac09SHuang Ying 
34063b2d417SAndrea Arcangeli 	if (pmd_trans_huge(_pmd)) {
34163b2d417SAndrea Arcangeli 		if (!pmd_write(_pmd) && (reason & VM_UFFD_WP))
34263b2d417SAndrea Arcangeli 			ret = true;
3438d2afd96SAndrea Arcangeli 		goto out;
34463b2d417SAndrea Arcangeli 	}
3458d2afd96SAndrea Arcangeli 
3468d2afd96SAndrea Arcangeli 	/*
3478d2afd96SAndrea Arcangeli 	 * the pmd is stable (as in !pmd_trans_unstable) so we can re-read it
3488d2afd96SAndrea Arcangeli 	 * and use the standard pte_offset_map() instead of parsing _pmd.
3498d2afd96SAndrea Arcangeli 	 */
3508d2afd96SAndrea Arcangeli 	pte = pte_offset_map(pmd, address);
3518d2afd96SAndrea Arcangeli 	/*
3528d2afd96SAndrea Arcangeli 	 * Lockless access: we're in a wait_event so it's ok if it
3535c041f5dSPeter Xu 	 * changes under us.  PTE markers should be handled the same as none
3545c041f5dSPeter Xu 	 * ptes here.
3558d2afd96SAndrea Arcangeli 	 */
3565c041f5dSPeter Xu 	if (pte_none_mostly(*pte))
3578d2afd96SAndrea Arcangeli 		ret = true;
35863b2d417SAndrea Arcangeli 	if (!pte_write(*pte) && (reason & VM_UFFD_WP))
35963b2d417SAndrea Arcangeli 		ret = true;
3608d2afd96SAndrea Arcangeli 	pte_unmap(pte);
3618d2afd96SAndrea Arcangeli 
3628d2afd96SAndrea Arcangeli out:
3638d2afd96SAndrea Arcangeli 	return ret;
3648d2afd96SAndrea Arcangeli }
3658d2afd96SAndrea Arcangeli 
3662f064a59SPeter Zijlstra static inline unsigned int userfaultfd_get_blocking_state(unsigned int flags)
3673e69ad08SPeter Xu {
3683e69ad08SPeter Xu 	if (flags & FAULT_FLAG_INTERRUPTIBLE)
3693e69ad08SPeter Xu 		return TASK_INTERRUPTIBLE;
3703e69ad08SPeter Xu 
3713e69ad08SPeter Xu 	if (flags & FAULT_FLAG_KILLABLE)
3723e69ad08SPeter Xu 		return TASK_KILLABLE;
3733e69ad08SPeter Xu 
3743e69ad08SPeter Xu 	return TASK_UNINTERRUPTIBLE;
3753e69ad08SPeter Xu }
3763e69ad08SPeter Xu 
3778d2afd96SAndrea Arcangeli /*
37886039bd3SAndrea Arcangeli  * The locking rules involved in returning VM_FAULT_RETRY depending on
37986039bd3SAndrea Arcangeli  * FAULT_FLAG_ALLOW_RETRY, FAULT_FLAG_RETRY_NOWAIT and
38086039bd3SAndrea Arcangeli  * FAULT_FLAG_KILLABLE are not straightforward. The "Caution"
38186039bd3SAndrea Arcangeli  * recommendation in __lock_page_or_retry is not an understatement.
38286039bd3SAndrea Arcangeli  *
383c1e8d7c6SMichel Lespinasse  * If FAULT_FLAG_ALLOW_RETRY is set, the mmap_lock must be released
38486039bd3SAndrea Arcangeli  * before returning VM_FAULT_RETRY only if FAULT_FLAG_RETRY_NOWAIT is
38586039bd3SAndrea Arcangeli  * not set.
38686039bd3SAndrea Arcangeli  *
38786039bd3SAndrea Arcangeli  * If FAULT_FLAG_ALLOW_RETRY is set but FAULT_FLAG_KILLABLE is not
38886039bd3SAndrea Arcangeli  * set, VM_FAULT_RETRY can still be returned if and only if there are
389c1e8d7c6SMichel Lespinasse  * fatal_signal_pending()s, and the mmap_lock must be released before
39086039bd3SAndrea Arcangeli  * returning it.
39186039bd3SAndrea Arcangeli  */
3922b740303SSouptick Joarder vm_fault_t handle_userfault(struct vm_fault *vmf, unsigned long reason)
39386039bd3SAndrea Arcangeli {
39482b0f8c3SJan Kara 	struct mm_struct *mm = vmf->vma->vm_mm;
39586039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
39686039bd3SAndrea Arcangeli 	struct userfaultfd_wait_queue uwq;
3972b740303SSouptick Joarder 	vm_fault_t ret = VM_FAULT_SIGBUS;
3983e69ad08SPeter Xu 	bool must_wait;
3992f064a59SPeter Zijlstra 	unsigned int blocking_state;
40086039bd3SAndrea Arcangeli 
40164c2b203SAndrea Arcangeli 	/*
40264c2b203SAndrea Arcangeli 	 * We don't do userfault handling for the final child pid update.
40364c2b203SAndrea Arcangeli 	 *
40464c2b203SAndrea Arcangeli 	 * We also don't do userfault handling during
40564c2b203SAndrea Arcangeli 	 * coredumping. hugetlbfs has the special
40664c2b203SAndrea Arcangeli 	 * follow_hugetlb_page() to skip missing pages in the
40764c2b203SAndrea Arcangeli 	 * FOLL_DUMP case, anon memory also checks for FOLL_DUMP with
40864c2b203SAndrea Arcangeli 	 * the no_page_table() helper in follow_page_mask(), but the
40964c2b203SAndrea Arcangeli 	 * shmem_vm_ops->fault method is invoked even during
410c1e8d7c6SMichel Lespinasse 	 * coredumping without mmap_lock and it ends up here.
41164c2b203SAndrea Arcangeli 	 */
41264c2b203SAndrea Arcangeli 	if (current->flags & (PF_EXITING|PF_DUMPCORE))
41364c2b203SAndrea Arcangeli 		goto out;
41464c2b203SAndrea Arcangeli 
41564c2b203SAndrea Arcangeli 	/*
416c1e8d7c6SMichel Lespinasse 	 * Coredumping runs without mmap_lock so we can only check that
417c1e8d7c6SMichel Lespinasse 	 * the mmap_lock is held, if PF_DUMPCORE was not set.
41864c2b203SAndrea Arcangeli 	 */
41942fc5414SMichel Lespinasse 	mmap_assert_locked(mm);
42064c2b203SAndrea Arcangeli 
42182b0f8c3SJan Kara 	ctx = vmf->vma->vm_userfaultfd_ctx.ctx;
42286039bd3SAndrea Arcangeli 	if (!ctx)
423ba85c702SAndrea Arcangeli 		goto out;
42486039bd3SAndrea Arcangeli 
42586039bd3SAndrea Arcangeli 	BUG_ON(ctx->mm != mm);
42686039bd3SAndrea Arcangeli 
4277677f7fdSAxel Rasmussen 	/* Any unrecognized flag is a bug. */
4287677f7fdSAxel Rasmussen 	VM_BUG_ON(reason & ~__VM_UFFD_FLAGS);
4297677f7fdSAxel Rasmussen 	/* 0 or > 1 flags set is a bug; we expect exactly 1. */
4307677f7fdSAxel Rasmussen 	VM_BUG_ON(!reason || (reason & (reason - 1)));
43186039bd3SAndrea Arcangeli 
4322d6d6f5aSPrakash Sangappa 	if (ctx->features & UFFD_FEATURE_SIGBUS)
4332d6d6f5aSPrakash Sangappa 		goto out;
4342d5de004SAxel Rasmussen 	if (!(vmf->flags & FAULT_FLAG_USER) && (ctx->flags & UFFD_USER_MODE_ONLY))
43537cd0575SLokesh Gidra 		goto out;
4362d6d6f5aSPrakash Sangappa 
43786039bd3SAndrea Arcangeli 	/*
43886039bd3SAndrea Arcangeli 	 * If it's already released don't get it. This avoids to loop
43986039bd3SAndrea Arcangeli 	 * in __get_user_pages if userfaultfd_release waits on the
440c1e8d7c6SMichel Lespinasse 	 * caller of handle_userfault to release the mmap_lock.
44186039bd3SAndrea Arcangeli 	 */
4426aa7de05SMark Rutland 	if (unlikely(READ_ONCE(ctx->released))) {
443656710a6SAndrea Arcangeli 		/*
444656710a6SAndrea Arcangeli 		 * Don't return VM_FAULT_SIGBUS in this case, so a non
445656710a6SAndrea Arcangeli 		 * cooperative manager can close the uffd after the
446656710a6SAndrea Arcangeli 		 * last UFFDIO_COPY, without risking to trigger an
447656710a6SAndrea Arcangeli 		 * involuntary SIGBUS if the process was starting the
448656710a6SAndrea Arcangeli 		 * userfaultfd while the userfaultfd was still armed
449656710a6SAndrea Arcangeli 		 * (but after the last UFFDIO_COPY). If the uffd
450656710a6SAndrea Arcangeli 		 * wasn't already closed when the userfault reached
451656710a6SAndrea Arcangeli 		 * this point, that would normally be solved by
452656710a6SAndrea Arcangeli 		 * userfaultfd_must_wait returning 'false'.
453656710a6SAndrea Arcangeli 		 *
454656710a6SAndrea Arcangeli 		 * If we were to return VM_FAULT_SIGBUS here, the non
455656710a6SAndrea Arcangeli 		 * cooperative manager would be instead forced to
456656710a6SAndrea Arcangeli 		 * always call UFFDIO_UNREGISTER before it can safely
457656710a6SAndrea Arcangeli 		 * close the uffd.
458656710a6SAndrea Arcangeli 		 */
459656710a6SAndrea Arcangeli 		ret = VM_FAULT_NOPAGE;
460ba85c702SAndrea Arcangeli 		goto out;
461656710a6SAndrea Arcangeli 	}
46286039bd3SAndrea Arcangeli 
46386039bd3SAndrea Arcangeli 	/*
46486039bd3SAndrea Arcangeli 	 * Check that we can return VM_FAULT_RETRY.
46586039bd3SAndrea Arcangeli 	 *
46686039bd3SAndrea Arcangeli 	 * NOTE: it should become possible to return VM_FAULT_RETRY
46786039bd3SAndrea Arcangeli 	 * even if FAULT_FLAG_TRIED is set without leading to gup()
46886039bd3SAndrea Arcangeli 	 * -EBUSY failures, if the userfaultfd is to be extended for
46986039bd3SAndrea Arcangeli 	 * VM_UFFD_WP tracking and we intend to arm the userfault
47086039bd3SAndrea Arcangeli 	 * without first stopping userland access to the memory. For
47186039bd3SAndrea Arcangeli 	 * VM_UFFD_MISSING userfaults this is enough for now.
47286039bd3SAndrea Arcangeli 	 */
47382b0f8c3SJan Kara 	if (unlikely(!(vmf->flags & FAULT_FLAG_ALLOW_RETRY))) {
47486039bd3SAndrea Arcangeli 		/*
47586039bd3SAndrea Arcangeli 		 * Validate the invariant that nowait must allow retry
47686039bd3SAndrea Arcangeli 		 * to be sure not to return SIGBUS erroneously on
47786039bd3SAndrea Arcangeli 		 * nowait invocations.
47886039bd3SAndrea Arcangeli 		 */
47982b0f8c3SJan Kara 		BUG_ON(vmf->flags & FAULT_FLAG_RETRY_NOWAIT);
48086039bd3SAndrea Arcangeli #ifdef CONFIG_DEBUG_VM
48186039bd3SAndrea Arcangeli 		if (printk_ratelimit()) {
48286039bd3SAndrea Arcangeli 			printk(KERN_WARNING
48382b0f8c3SJan Kara 			       "FAULT_FLAG_ALLOW_RETRY missing %x\n",
48482b0f8c3SJan Kara 			       vmf->flags);
48586039bd3SAndrea Arcangeli 			dump_stack();
48686039bd3SAndrea Arcangeli 		}
48786039bd3SAndrea Arcangeli #endif
488ba85c702SAndrea Arcangeli 		goto out;
48986039bd3SAndrea Arcangeli 	}
49086039bd3SAndrea Arcangeli 
49186039bd3SAndrea Arcangeli 	/*
49286039bd3SAndrea Arcangeli 	 * Handle nowait, not much to do other than tell it to retry
49386039bd3SAndrea Arcangeli 	 * and wait.
49486039bd3SAndrea Arcangeli 	 */
495ba85c702SAndrea Arcangeli 	ret = VM_FAULT_RETRY;
49682b0f8c3SJan Kara 	if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
497ba85c702SAndrea Arcangeli 		goto out;
49886039bd3SAndrea Arcangeli 
499c1e8d7c6SMichel Lespinasse 	/* take the reference before dropping the mmap_lock */
50086039bd3SAndrea Arcangeli 	userfaultfd_ctx_get(ctx);
50186039bd3SAndrea Arcangeli 
50286039bd3SAndrea Arcangeli 	init_waitqueue_func_entry(&uwq.wq, userfaultfd_wake_function);
50386039bd3SAndrea Arcangeli 	uwq.wq.private = current;
504d172b1a3SNadav Amit 	uwq.msg = userfault_msg(vmf->address, vmf->real_address, vmf->flags,
505d172b1a3SNadav Amit 				reason, ctx->features);
50686039bd3SAndrea Arcangeli 	uwq.ctx = ctx;
50715a77c6fSAndrea Arcangeli 	uwq.waken = false;
50886039bd3SAndrea Arcangeli 
5093e69ad08SPeter Xu 	blocking_state = userfaultfd_get_blocking_state(vmf->flags);
510dfa37dc3SAndrea Arcangeli 
511cbcfa130SEric Biggers 	spin_lock_irq(&ctx->fault_pending_wqh.lock);
51286039bd3SAndrea Arcangeli 	/*
51386039bd3SAndrea Arcangeli 	 * After the __add_wait_queue the uwq is visible to userland
51486039bd3SAndrea Arcangeli 	 * through poll/read().
51586039bd3SAndrea Arcangeli 	 */
51615b726efSAndrea Arcangeli 	__add_wait_queue(&ctx->fault_pending_wqh, &uwq.wq);
51715b726efSAndrea Arcangeli 	/*
51815b726efSAndrea Arcangeli 	 * The smp_mb() after __set_current_state prevents the reads
51915b726efSAndrea Arcangeli 	 * following the spin_unlock to happen before the list_add in
52015b726efSAndrea Arcangeli 	 * __add_wait_queue.
52115b726efSAndrea Arcangeli 	 */
52215a77c6fSAndrea Arcangeli 	set_current_state(blocking_state);
523cbcfa130SEric Biggers 	spin_unlock_irq(&ctx->fault_pending_wqh.lock);
52486039bd3SAndrea Arcangeli 
525369cd212SMike Kravetz 	if (!is_vm_hugetlb_page(vmf->vma))
52682b0f8c3SJan Kara 		must_wait = userfaultfd_must_wait(ctx, vmf->address, vmf->flags,
52782b0f8c3SJan Kara 						  reason);
528369cd212SMike Kravetz 	else
5297868a208SPunit Agrawal 		must_wait = userfaultfd_huge_must_wait(ctx, vmf->vma,
5307868a208SPunit Agrawal 						       vmf->address,
531369cd212SMike Kravetz 						       vmf->flags, reason);
532d8ed45c5SMichel Lespinasse 	mmap_read_unlock(mm);
5338d2afd96SAndrea Arcangeli 
534f9bf3522SLinus Torvalds 	if (likely(must_wait && !READ_ONCE(ctx->released))) {
535a9a08845SLinus Torvalds 		wake_up_poll(&ctx->fd_wqh, EPOLLIN);
53686039bd3SAndrea Arcangeli 		schedule();
53786039bd3SAndrea Arcangeli 	}
538ba85c702SAndrea Arcangeli 
53986039bd3SAndrea Arcangeli 	__set_current_state(TASK_RUNNING);
54015b726efSAndrea Arcangeli 
54115b726efSAndrea Arcangeli 	/*
54215b726efSAndrea Arcangeli 	 * Here we race with the list_del; list_add in
54315b726efSAndrea Arcangeli 	 * userfaultfd_ctx_read(), however because we don't ever run
54415b726efSAndrea Arcangeli 	 * list_del_init() to refile across the two lists, the prev
54515b726efSAndrea Arcangeli 	 * and next pointers will never point to self. list_add also
54615b726efSAndrea Arcangeli 	 * would never let any of the two pointers to point to
54715b726efSAndrea Arcangeli 	 * self. So list_empty_careful won't risk to see both pointers
54815b726efSAndrea Arcangeli 	 * pointing to self at any time during the list refile. The
54915b726efSAndrea Arcangeli 	 * only case where list_del_init() is called is the full
55015b726efSAndrea Arcangeli 	 * removal in the wake function and there we don't re-list_add
55115b726efSAndrea Arcangeli 	 * and it's fine not to block on the spinlock. The uwq on this
55215b726efSAndrea Arcangeli 	 * kernel stack can be released after the list_del_init.
55315b726efSAndrea Arcangeli 	 */
5542055da97SIngo Molnar 	if (!list_empty_careful(&uwq.wq.entry)) {
555cbcfa130SEric Biggers 		spin_lock_irq(&ctx->fault_pending_wqh.lock);
55615b726efSAndrea Arcangeli 		/*
55715b726efSAndrea Arcangeli 		 * No need of list_del_init(), the uwq on the stack
55815b726efSAndrea Arcangeli 		 * will be freed shortly anyway.
55915b726efSAndrea Arcangeli 		 */
5602055da97SIngo Molnar 		list_del(&uwq.wq.entry);
561cbcfa130SEric Biggers 		spin_unlock_irq(&ctx->fault_pending_wqh.lock);
562ba85c702SAndrea Arcangeli 	}
56386039bd3SAndrea Arcangeli 
56486039bd3SAndrea Arcangeli 	/*
56586039bd3SAndrea Arcangeli 	 * ctx may go away after this if the userfault pseudo fd is
56686039bd3SAndrea Arcangeli 	 * already released.
56786039bd3SAndrea Arcangeli 	 */
56886039bd3SAndrea Arcangeli 	userfaultfd_ctx_put(ctx);
56986039bd3SAndrea Arcangeli 
570ba85c702SAndrea Arcangeli out:
571ba85c702SAndrea Arcangeli 	return ret;
57286039bd3SAndrea Arcangeli }
57386039bd3SAndrea Arcangeli 
5748c9e7bb7SAndrea Arcangeli static void userfaultfd_event_wait_completion(struct userfaultfd_ctx *ctx,
5759cd75c3cSPavel Emelyanov 					      struct userfaultfd_wait_queue *ewq)
5769cd75c3cSPavel Emelyanov {
5770cbb4b4fSAndrea Arcangeli 	struct userfaultfd_ctx *release_new_ctx;
5780cbb4b4fSAndrea Arcangeli 
5799a69a829SAndrea Arcangeli 	if (WARN_ON_ONCE(current->flags & PF_EXITING))
5809a69a829SAndrea Arcangeli 		goto out;
5819a69a829SAndrea Arcangeli 
5829cd75c3cSPavel Emelyanov 	ewq->ctx = ctx;
5839cd75c3cSPavel Emelyanov 	init_waitqueue_entry(&ewq->wq, current);
5840cbb4b4fSAndrea Arcangeli 	release_new_ctx = NULL;
5859cd75c3cSPavel Emelyanov 
586cbcfa130SEric Biggers 	spin_lock_irq(&ctx->event_wqh.lock);
5879cd75c3cSPavel Emelyanov 	/*
5889cd75c3cSPavel Emelyanov 	 * After the __add_wait_queue the uwq is visible to userland
5899cd75c3cSPavel Emelyanov 	 * through poll/read().
5909cd75c3cSPavel Emelyanov 	 */
5919cd75c3cSPavel Emelyanov 	__add_wait_queue(&ctx->event_wqh, &ewq->wq);
5929cd75c3cSPavel Emelyanov 	for (;;) {
5939cd75c3cSPavel Emelyanov 		set_current_state(TASK_KILLABLE);
5949cd75c3cSPavel Emelyanov 		if (ewq->msg.event == 0)
5959cd75c3cSPavel Emelyanov 			break;
5966aa7de05SMark Rutland 		if (READ_ONCE(ctx->released) ||
5979cd75c3cSPavel Emelyanov 		    fatal_signal_pending(current)) {
598384632e6SAndrea Arcangeli 			/*
599384632e6SAndrea Arcangeli 			 * &ewq->wq may be queued in fork_event, but
600384632e6SAndrea Arcangeli 			 * __remove_wait_queue ignores the head
601384632e6SAndrea Arcangeli 			 * parameter. It would be a problem if it
602384632e6SAndrea Arcangeli 			 * didn't.
603384632e6SAndrea Arcangeli 			 */
6049cd75c3cSPavel Emelyanov 			__remove_wait_queue(&ctx->event_wqh, &ewq->wq);
6057eb76d45SMike Rapoport 			if (ewq->msg.event == UFFD_EVENT_FORK) {
6067eb76d45SMike Rapoport 				struct userfaultfd_ctx *new;
6077eb76d45SMike Rapoport 
6087eb76d45SMike Rapoport 				new = (struct userfaultfd_ctx *)
6097eb76d45SMike Rapoport 					(unsigned long)
6107eb76d45SMike Rapoport 					ewq->msg.arg.reserved.reserved1;
6110cbb4b4fSAndrea Arcangeli 				release_new_ctx = new;
6127eb76d45SMike Rapoport 			}
6139cd75c3cSPavel Emelyanov 			break;
6149cd75c3cSPavel Emelyanov 		}
6159cd75c3cSPavel Emelyanov 
616cbcfa130SEric Biggers 		spin_unlock_irq(&ctx->event_wqh.lock);
6179cd75c3cSPavel Emelyanov 
618a9a08845SLinus Torvalds 		wake_up_poll(&ctx->fd_wqh, EPOLLIN);
6199cd75c3cSPavel Emelyanov 		schedule();
6209cd75c3cSPavel Emelyanov 
621cbcfa130SEric Biggers 		spin_lock_irq(&ctx->event_wqh.lock);
6229cd75c3cSPavel Emelyanov 	}
6239cd75c3cSPavel Emelyanov 	__set_current_state(TASK_RUNNING);
624cbcfa130SEric Biggers 	spin_unlock_irq(&ctx->event_wqh.lock);
6259cd75c3cSPavel Emelyanov 
6260cbb4b4fSAndrea Arcangeli 	if (release_new_ctx) {
6270cbb4b4fSAndrea Arcangeli 		struct vm_area_struct *vma;
6280cbb4b4fSAndrea Arcangeli 		struct mm_struct *mm = release_new_ctx->mm;
62969dbe6daSLiam R. Howlett 		VMA_ITERATOR(vmi, mm, 0);
6300cbb4b4fSAndrea Arcangeli 
6310cbb4b4fSAndrea Arcangeli 		/* the various vma->vm_userfaultfd_ctx still points to it */
632d8ed45c5SMichel Lespinasse 		mmap_write_lock(mm);
63369dbe6daSLiam R. Howlett 		for_each_vma(vmi, vma) {
63431e810aaSMike Rapoport 			if (vma->vm_userfaultfd_ctx.ctx == release_new_ctx) {
6350cbb4b4fSAndrea Arcangeli 				vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
636*51d3d5ebSDavid Hildenbrand 				userfaultfd_set_vm_flags(vma,
637*51d3d5ebSDavid Hildenbrand 							 vma->vm_flags & ~__VM_UFFD_FLAGS);
63831e810aaSMike Rapoport 			}
63969dbe6daSLiam R. Howlett 		}
640d8ed45c5SMichel Lespinasse 		mmap_write_unlock(mm);
6410cbb4b4fSAndrea Arcangeli 
6420cbb4b4fSAndrea Arcangeli 		userfaultfd_ctx_put(release_new_ctx);
6430cbb4b4fSAndrea Arcangeli 	}
6440cbb4b4fSAndrea Arcangeli 
6459cd75c3cSPavel Emelyanov 	/*
6469cd75c3cSPavel Emelyanov 	 * ctx may go away after this if the userfault pseudo fd is
6479cd75c3cSPavel Emelyanov 	 * already released.
6489cd75c3cSPavel Emelyanov 	 */
6499a69a829SAndrea Arcangeli out:
650a759a909SNadav Amit 	atomic_dec(&ctx->mmap_changing);
651a759a909SNadav Amit 	VM_BUG_ON(atomic_read(&ctx->mmap_changing) < 0);
6529cd75c3cSPavel Emelyanov 	userfaultfd_ctx_put(ctx);
6539cd75c3cSPavel Emelyanov }
6549cd75c3cSPavel Emelyanov 
6559cd75c3cSPavel Emelyanov static void userfaultfd_event_complete(struct userfaultfd_ctx *ctx,
6569cd75c3cSPavel Emelyanov 				       struct userfaultfd_wait_queue *ewq)
6579cd75c3cSPavel Emelyanov {
6589cd75c3cSPavel Emelyanov 	ewq->msg.event = 0;
6599cd75c3cSPavel Emelyanov 	wake_up_locked(&ctx->event_wqh);
6609cd75c3cSPavel Emelyanov 	__remove_wait_queue(&ctx->event_wqh, &ewq->wq);
6619cd75c3cSPavel Emelyanov }
6629cd75c3cSPavel Emelyanov 
663893e26e6SPavel Emelyanov int dup_userfaultfd(struct vm_area_struct *vma, struct list_head *fcs)
664893e26e6SPavel Emelyanov {
665893e26e6SPavel Emelyanov 	struct userfaultfd_ctx *ctx = NULL, *octx;
666893e26e6SPavel Emelyanov 	struct userfaultfd_fork_ctx *fctx;
667893e26e6SPavel Emelyanov 
668893e26e6SPavel Emelyanov 	octx = vma->vm_userfaultfd_ctx.ctx;
669893e26e6SPavel Emelyanov 	if (!octx || !(octx->features & UFFD_FEATURE_EVENT_FORK)) {
670893e26e6SPavel Emelyanov 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
671*51d3d5ebSDavid Hildenbrand 		userfaultfd_set_vm_flags(vma, vma->vm_flags & ~__VM_UFFD_FLAGS);
672893e26e6SPavel Emelyanov 		return 0;
673893e26e6SPavel Emelyanov 	}
674893e26e6SPavel Emelyanov 
675893e26e6SPavel Emelyanov 	list_for_each_entry(fctx, fcs, list)
676893e26e6SPavel Emelyanov 		if (fctx->orig == octx) {
677893e26e6SPavel Emelyanov 			ctx = fctx->new;
678893e26e6SPavel Emelyanov 			break;
679893e26e6SPavel Emelyanov 		}
680893e26e6SPavel Emelyanov 
681893e26e6SPavel Emelyanov 	if (!ctx) {
682893e26e6SPavel Emelyanov 		fctx = kmalloc(sizeof(*fctx), GFP_KERNEL);
683893e26e6SPavel Emelyanov 		if (!fctx)
684893e26e6SPavel Emelyanov 			return -ENOMEM;
685893e26e6SPavel Emelyanov 
686893e26e6SPavel Emelyanov 		ctx = kmem_cache_alloc(userfaultfd_ctx_cachep, GFP_KERNEL);
687893e26e6SPavel Emelyanov 		if (!ctx) {
688893e26e6SPavel Emelyanov 			kfree(fctx);
689893e26e6SPavel Emelyanov 			return -ENOMEM;
690893e26e6SPavel Emelyanov 		}
691893e26e6SPavel Emelyanov 
692ca880420SEric Biggers 		refcount_set(&ctx->refcount, 1);
693893e26e6SPavel Emelyanov 		ctx->flags = octx->flags;
694893e26e6SPavel Emelyanov 		ctx->features = octx->features;
695893e26e6SPavel Emelyanov 		ctx->released = false;
696a759a909SNadav Amit 		atomic_set(&ctx->mmap_changing, 0);
697893e26e6SPavel Emelyanov 		ctx->mm = vma->vm_mm;
69800bb31faSMike Rapoport 		mmgrab(ctx->mm);
699893e26e6SPavel Emelyanov 
700893e26e6SPavel Emelyanov 		userfaultfd_ctx_get(octx);
701a759a909SNadav Amit 		atomic_inc(&octx->mmap_changing);
702893e26e6SPavel Emelyanov 		fctx->orig = octx;
703893e26e6SPavel Emelyanov 		fctx->new = ctx;
704893e26e6SPavel Emelyanov 		list_add_tail(&fctx->list, fcs);
705893e26e6SPavel Emelyanov 	}
706893e26e6SPavel Emelyanov 
707893e26e6SPavel Emelyanov 	vma->vm_userfaultfd_ctx.ctx = ctx;
708893e26e6SPavel Emelyanov 	return 0;
709893e26e6SPavel Emelyanov }
710893e26e6SPavel Emelyanov 
7118c9e7bb7SAndrea Arcangeli static void dup_fctx(struct userfaultfd_fork_ctx *fctx)
712893e26e6SPavel Emelyanov {
713893e26e6SPavel Emelyanov 	struct userfaultfd_ctx *ctx = fctx->orig;
714893e26e6SPavel Emelyanov 	struct userfaultfd_wait_queue ewq;
715893e26e6SPavel Emelyanov 
716893e26e6SPavel Emelyanov 	msg_init(&ewq.msg);
717893e26e6SPavel Emelyanov 
718893e26e6SPavel Emelyanov 	ewq.msg.event = UFFD_EVENT_FORK;
719893e26e6SPavel Emelyanov 	ewq.msg.arg.reserved.reserved1 = (unsigned long)fctx->new;
720893e26e6SPavel Emelyanov 
7218c9e7bb7SAndrea Arcangeli 	userfaultfd_event_wait_completion(ctx, &ewq);
722893e26e6SPavel Emelyanov }
723893e26e6SPavel Emelyanov 
724893e26e6SPavel Emelyanov void dup_userfaultfd_complete(struct list_head *fcs)
725893e26e6SPavel Emelyanov {
726893e26e6SPavel Emelyanov 	struct userfaultfd_fork_ctx *fctx, *n;
727893e26e6SPavel Emelyanov 
728893e26e6SPavel Emelyanov 	list_for_each_entry_safe(fctx, n, fcs, list) {
7298c9e7bb7SAndrea Arcangeli 		dup_fctx(fctx);
730893e26e6SPavel Emelyanov 		list_del(&fctx->list);
731893e26e6SPavel Emelyanov 		kfree(fctx);
732893e26e6SPavel Emelyanov 	}
733893e26e6SPavel Emelyanov }
734893e26e6SPavel Emelyanov 
73572f87654SPavel Emelyanov void mremap_userfaultfd_prep(struct vm_area_struct *vma,
73672f87654SPavel Emelyanov 			     struct vm_userfaultfd_ctx *vm_ctx)
73772f87654SPavel Emelyanov {
73872f87654SPavel Emelyanov 	struct userfaultfd_ctx *ctx;
73972f87654SPavel Emelyanov 
74072f87654SPavel Emelyanov 	ctx = vma->vm_userfaultfd_ctx.ctx;
7413cfd22beSPeter Xu 
7423cfd22beSPeter Xu 	if (!ctx)
7433cfd22beSPeter Xu 		return;
7443cfd22beSPeter Xu 
7453cfd22beSPeter Xu 	if (ctx->features & UFFD_FEATURE_EVENT_REMAP) {
74672f87654SPavel Emelyanov 		vm_ctx->ctx = ctx;
74772f87654SPavel Emelyanov 		userfaultfd_ctx_get(ctx);
748a759a909SNadav Amit 		atomic_inc(&ctx->mmap_changing);
7493cfd22beSPeter Xu 	} else {
7503cfd22beSPeter Xu 		/* Drop uffd context if remap feature not enabled */
7513cfd22beSPeter Xu 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
752*51d3d5ebSDavid Hildenbrand 		userfaultfd_set_vm_flags(vma, vma->vm_flags & ~__VM_UFFD_FLAGS);
75372f87654SPavel Emelyanov 	}
75472f87654SPavel Emelyanov }
75572f87654SPavel Emelyanov 
75690794bf1SAndrea Arcangeli void mremap_userfaultfd_complete(struct vm_userfaultfd_ctx *vm_ctx,
75772f87654SPavel Emelyanov 				 unsigned long from, unsigned long to,
75872f87654SPavel Emelyanov 				 unsigned long len)
75972f87654SPavel Emelyanov {
76090794bf1SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = vm_ctx->ctx;
76172f87654SPavel Emelyanov 	struct userfaultfd_wait_queue ewq;
76272f87654SPavel Emelyanov 
76372f87654SPavel Emelyanov 	if (!ctx)
76472f87654SPavel Emelyanov 		return;
76572f87654SPavel Emelyanov 
76672f87654SPavel Emelyanov 	if (to & ~PAGE_MASK) {
76772f87654SPavel Emelyanov 		userfaultfd_ctx_put(ctx);
76872f87654SPavel Emelyanov 		return;
76972f87654SPavel Emelyanov 	}
77072f87654SPavel Emelyanov 
77172f87654SPavel Emelyanov 	msg_init(&ewq.msg);
77272f87654SPavel Emelyanov 
77372f87654SPavel Emelyanov 	ewq.msg.event = UFFD_EVENT_REMAP;
77472f87654SPavel Emelyanov 	ewq.msg.arg.remap.from = from;
77572f87654SPavel Emelyanov 	ewq.msg.arg.remap.to = to;
77672f87654SPavel Emelyanov 	ewq.msg.arg.remap.len = len;
77772f87654SPavel Emelyanov 
77872f87654SPavel Emelyanov 	userfaultfd_event_wait_completion(ctx, &ewq);
77972f87654SPavel Emelyanov }
78072f87654SPavel Emelyanov 
78170ccb92fSAndrea Arcangeli bool userfaultfd_remove(struct vm_area_struct *vma,
78205ce7724SPavel Emelyanov 			unsigned long start, unsigned long end)
78305ce7724SPavel Emelyanov {
78405ce7724SPavel Emelyanov 	struct mm_struct *mm = vma->vm_mm;
78505ce7724SPavel Emelyanov 	struct userfaultfd_ctx *ctx;
78605ce7724SPavel Emelyanov 	struct userfaultfd_wait_queue ewq;
78705ce7724SPavel Emelyanov 
78805ce7724SPavel Emelyanov 	ctx = vma->vm_userfaultfd_ctx.ctx;
789d811914dSMike Rapoport 	if (!ctx || !(ctx->features & UFFD_FEATURE_EVENT_REMOVE))
79070ccb92fSAndrea Arcangeli 		return true;
79105ce7724SPavel Emelyanov 
79205ce7724SPavel Emelyanov 	userfaultfd_ctx_get(ctx);
793a759a909SNadav Amit 	atomic_inc(&ctx->mmap_changing);
794d8ed45c5SMichel Lespinasse 	mmap_read_unlock(mm);
79505ce7724SPavel Emelyanov 
79605ce7724SPavel Emelyanov 	msg_init(&ewq.msg);
79705ce7724SPavel Emelyanov 
798d811914dSMike Rapoport 	ewq.msg.event = UFFD_EVENT_REMOVE;
799d811914dSMike Rapoport 	ewq.msg.arg.remove.start = start;
800d811914dSMike Rapoport 	ewq.msg.arg.remove.end = end;
80105ce7724SPavel Emelyanov 
80205ce7724SPavel Emelyanov 	userfaultfd_event_wait_completion(ctx, &ewq);
80305ce7724SPavel Emelyanov 
80470ccb92fSAndrea Arcangeli 	return false;
80505ce7724SPavel Emelyanov }
80605ce7724SPavel Emelyanov 
807897ab3e0SMike Rapoport static bool has_unmap_ctx(struct userfaultfd_ctx *ctx, struct list_head *unmaps,
808897ab3e0SMike Rapoport 			  unsigned long start, unsigned long end)
809897ab3e0SMike Rapoport {
810897ab3e0SMike Rapoport 	struct userfaultfd_unmap_ctx *unmap_ctx;
811897ab3e0SMike Rapoport 
812897ab3e0SMike Rapoport 	list_for_each_entry(unmap_ctx, unmaps, list)
813897ab3e0SMike Rapoport 		if (unmap_ctx->ctx == ctx && unmap_ctx->start == start &&
814897ab3e0SMike Rapoport 		    unmap_ctx->end == end)
815897ab3e0SMike Rapoport 			return true;
816897ab3e0SMike Rapoport 
817897ab3e0SMike Rapoport 	return false;
818897ab3e0SMike Rapoport }
819897ab3e0SMike Rapoport 
82069dbe6daSLiam R. Howlett int userfaultfd_unmap_prep(struct mm_struct *mm, unsigned long start,
82169dbe6daSLiam R. Howlett 			   unsigned long end, struct list_head *unmaps)
822897ab3e0SMike Rapoport {
82369dbe6daSLiam R. Howlett 	VMA_ITERATOR(vmi, mm, start);
82469dbe6daSLiam R. Howlett 	struct vm_area_struct *vma;
82569dbe6daSLiam R. Howlett 
82669dbe6daSLiam R. Howlett 	for_each_vma_range(vmi, vma, end) {
827897ab3e0SMike Rapoport 		struct userfaultfd_unmap_ctx *unmap_ctx;
828897ab3e0SMike Rapoport 		struct userfaultfd_ctx *ctx = vma->vm_userfaultfd_ctx.ctx;
829897ab3e0SMike Rapoport 
830897ab3e0SMike Rapoport 		if (!ctx || !(ctx->features & UFFD_FEATURE_EVENT_UNMAP) ||
831897ab3e0SMike Rapoport 		    has_unmap_ctx(ctx, unmaps, start, end))
832897ab3e0SMike Rapoport 			continue;
833897ab3e0SMike Rapoport 
834897ab3e0SMike Rapoport 		unmap_ctx = kzalloc(sizeof(*unmap_ctx), GFP_KERNEL);
835897ab3e0SMike Rapoport 		if (!unmap_ctx)
836897ab3e0SMike Rapoport 			return -ENOMEM;
837897ab3e0SMike Rapoport 
838897ab3e0SMike Rapoport 		userfaultfd_ctx_get(ctx);
839a759a909SNadav Amit 		atomic_inc(&ctx->mmap_changing);
840897ab3e0SMike Rapoport 		unmap_ctx->ctx = ctx;
841897ab3e0SMike Rapoport 		unmap_ctx->start = start;
842897ab3e0SMike Rapoport 		unmap_ctx->end = end;
843897ab3e0SMike Rapoport 		list_add_tail(&unmap_ctx->list, unmaps);
844897ab3e0SMike Rapoport 	}
845897ab3e0SMike Rapoport 
846897ab3e0SMike Rapoport 	return 0;
847897ab3e0SMike Rapoport }
848897ab3e0SMike Rapoport 
849897ab3e0SMike Rapoport void userfaultfd_unmap_complete(struct mm_struct *mm, struct list_head *uf)
850897ab3e0SMike Rapoport {
851897ab3e0SMike Rapoport 	struct userfaultfd_unmap_ctx *ctx, *n;
852897ab3e0SMike Rapoport 	struct userfaultfd_wait_queue ewq;
853897ab3e0SMike Rapoport 
854897ab3e0SMike Rapoport 	list_for_each_entry_safe(ctx, n, uf, list) {
855897ab3e0SMike Rapoport 		msg_init(&ewq.msg);
856897ab3e0SMike Rapoport 
857897ab3e0SMike Rapoport 		ewq.msg.event = UFFD_EVENT_UNMAP;
858897ab3e0SMike Rapoport 		ewq.msg.arg.remove.start = ctx->start;
859897ab3e0SMike Rapoport 		ewq.msg.arg.remove.end = ctx->end;
860897ab3e0SMike Rapoport 
861897ab3e0SMike Rapoport 		userfaultfd_event_wait_completion(ctx->ctx, &ewq);
862897ab3e0SMike Rapoport 
863897ab3e0SMike Rapoport 		list_del(&ctx->list);
864897ab3e0SMike Rapoport 		kfree(ctx);
865897ab3e0SMike Rapoport 	}
866897ab3e0SMike Rapoport }
867897ab3e0SMike Rapoport 
86886039bd3SAndrea Arcangeli static int userfaultfd_release(struct inode *inode, struct file *file)
86986039bd3SAndrea Arcangeli {
87086039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
87186039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
87286039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev;
87386039bd3SAndrea Arcangeli 	/* len == 0 means wake all */
87486039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range range = { .len = 0, };
87586039bd3SAndrea Arcangeli 	unsigned long new_flags;
87669dbe6daSLiam R. Howlett 	MA_STATE(mas, &mm->mm_mt, 0, 0);
87786039bd3SAndrea Arcangeli 
8786aa7de05SMark Rutland 	WRITE_ONCE(ctx->released, true);
87986039bd3SAndrea Arcangeli 
880d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
881d2005e3fSOleg Nesterov 		goto wakeup;
882d2005e3fSOleg Nesterov 
88386039bd3SAndrea Arcangeli 	/*
88486039bd3SAndrea Arcangeli 	 * Flush page faults out of all CPUs. NOTE: all page faults
88586039bd3SAndrea Arcangeli 	 * must be retried without returning VM_FAULT_SIGBUS if
88686039bd3SAndrea Arcangeli 	 * userfaultfd_ctx_get() succeeds but vma->vma_userfault_ctx
887c1e8d7c6SMichel Lespinasse 	 * changes while handle_userfault released the mmap_lock. So
88886039bd3SAndrea Arcangeli 	 * it's critical that released is set to true (above), before
889c1e8d7c6SMichel Lespinasse 	 * taking the mmap_lock for writing.
89086039bd3SAndrea Arcangeli 	 */
891d8ed45c5SMichel Lespinasse 	mmap_write_lock(mm);
89286039bd3SAndrea Arcangeli 	prev = NULL;
89369dbe6daSLiam R. Howlett 	mas_for_each(&mas, vma, ULONG_MAX) {
89486039bd3SAndrea Arcangeli 		cond_resched();
89586039bd3SAndrea Arcangeli 		BUG_ON(!!vma->vm_userfaultfd_ctx.ctx ^
8967677f7fdSAxel Rasmussen 		       !!(vma->vm_flags & __VM_UFFD_FLAGS));
89786039bd3SAndrea Arcangeli 		if (vma->vm_userfaultfd_ctx.ctx != ctx) {
89886039bd3SAndrea Arcangeli 			prev = vma;
89986039bd3SAndrea Arcangeli 			continue;
90086039bd3SAndrea Arcangeli 		}
9017677f7fdSAxel Rasmussen 		new_flags = vma->vm_flags & ~__VM_UFFD_FLAGS;
90286039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, vma->vm_start, vma->vm_end,
90386039bd3SAndrea Arcangeli 				 new_flags, vma->anon_vma,
90486039bd3SAndrea Arcangeli 				 vma->vm_file, vma->vm_pgoff,
90586039bd3SAndrea Arcangeli 				 vma_policy(vma),
9065c26f6acSSuren Baghdasaryan 				 NULL_VM_UFFD_CTX, anon_vma_name(vma));
90769dbe6daSLiam R. Howlett 		if (prev) {
90869dbe6daSLiam R. Howlett 			mas_pause(&mas);
90986039bd3SAndrea Arcangeli 			vma = prev;
91069dbe6daSLiam R. Howlett 		} else {
91186039bd3SAndrea Arcangeli 			prev = vma;
91269dbe6daSLiam R. Howlett 		}
91369dbe6daSLiam R. Howlett 
914*51d3d5ebSDavid Hildenbrand 		userfaultfd_set_vm_flags(vma, new_flags);
91586039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
91686039bd3SAndrea Arcangeli 	}
917d8ed45c5SMichel Lespinasse 	mmap_write_unlock(mm);
918d2005e3fSOleg Nesterov 	mmput(mm);
919d2005e3fSOleg Nesterov wakeup:
92086039bd3SAndrea Arcangeli 	/*
92115b726efSAndrea Arcangeli 	 * After no new page faults can wait on this fault_*wqh, flush
92286039bd3SAndrea Arcangeli 	 * the last page faults that may have been already waiting on
92315b726efSAndrea Arcangeli 	 * the fault_*wqh.
92486039bd3SAndrea Arcangeli 	 */
925cbcfa130SEric Biggers 	spin_lock_irq(&ctx->fault_pending_wqh.lock);
926ac5be6b4SAndrea Arcangeli 	__wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL, &range);
927c430d1e8SMatthew Wilcox 	__wake_up(&ctx->fault_wqh, TASK_NORMAL, 1, &range);
928cbcfa130SEric Biggers 	spin_unlock_irq(&ctx->fault_pending_wqh.lock);
92986039bd3SAndrea Arcangeli 
9305a18b64eSMike Rapoport 	/* Flush pending events that may still wait on event_wqh */
9315a18b64eSMike Rapoport 	wake_up_all(&ctx->event_wqh);
9325a18b64eSMike Rapoport 
933a9a08845SLinus Torvalds 	wake_up_poll(&ctx->fd_wqh, EPOLLHUP);
93486039bd3SAndrea Arcangeli 	userfaultfd_ctx_put(ctx);
93586039bd3SAndrea Arcangeli 	return 0;
93686039bd3SAndrea Arcangeli }
93786039bd3SAndrea Arcangeli 
93815b726efSAndrea Arcangeli /* fault_pending_wqh.lock must be hold by the caller */
9396dcc27fdSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault_in(
9406dcc27fdSPavel Emelyanov 		wait_queue_head_t *wqh)
94186039bd3SAndrea Arcangeli {
942ac6424b9SIngo Molnar 	wait_queue_entry_t *wq;
94315b726efSAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
94486039bd3SAndrea Arcangeli 
945456a7378SLance Roy 	lockdep_assert_held(&wqh->lock);
94686039bd3SAndrea Arcangeli 
94715b726efSAndrea Arcangeli 	uwq = NULL;
9486dcc27fdSPavel Emelyanov 	if (!waitqueue_active(wqh))
94915b726efSAndrea Arcangeli 		goto out;
95015b726efSAndrea Arcangeli 	/* walk in reverse to provide FIFO behavior to read userfaults */
9512055da97SIngo Molnar 	wq = list_last_entry(&wqh->head, typeof(*wq), entry);
95215b726efSAndrea Arcangeli 	uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
95315b726efSAndrea Arcangeli out:
95415b726efSAndrea Arcangeli 	return uwq;
95586039bd3SAndrea Arcangeli }
95686039bd3SAndrea Arcangeli 
9576dcc27fdSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault(
9586dcc27fdSPavel Emelyanov 		struct userfaultfd_ctx *ctx)
9596dcc27fdSPavel Emelyanov {
9606dcc27fdSPavel Emelyanov 	return find_userfault_in(&ctx->fault_pending_wqh);
9616dcc27fdSPavel Emelyanov }
9626dcc27fdSPavel Emelyanov 
9639cd75c3cSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault_evt(
9649cd75c3cSPavel Emelyanov 		struct userfaultfd_ctx *ctx)
9659cd75c3cSPavel Emelyanov {
9669cd75c3cSPavel Emelyanov 	return find_userfault_in(&ctx->event_wqh);
9679cd75c3cSPavel Emelyanov }
9689cd75c3cSPavel Emelyanov 
969076ccb76SAl Viro static __poll_t userfaultfd_poll(struct file *file, poll_table *wait)
97086039bd3SAndrea Arcangeli {
97186039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
972076ccb76SAl Viro 	__poll_t ret;
97386039bd3SAndrea Arcangeli 
97486039bd3SAndrea Arcangeli 	poll_wait(file, &ctx->fd_wqh, wait);
97586039bd3SAndrea Arcangeli 
97622e5fe2aSNadav Amit 	if (!userfaultfd_is_initialized(ctx))
977a9a08845SLinus Torvalds 		return EPOLLERR;
97822e5fe2aSNadav Amit 
979ba85c702SAndrea Arcangeli 	/*
980ba85c702SAndrea Arcangeli 	 * poll() never guarantees that read won't block.
981ba85c702SAndrea Arcangeli 	 * userfaults can be waken before they're read().
982ba85c702SAndrea Arcangeli 	 */
983ba85c702SAndrea Arcangeli 	if (unlikely(!(file->f_flags & O_NONBLOCK)))
984a9a08845SLinus Torvalds 		return EPOLLERR;
98515b726efSAndrea Arcangeli 	/*
98615b726efSAndrea Arcangeli 	 * lockless access to see if there are pending faults
98715b726efSAndrea Arcangeli 	 * __pollwait last action is the add_wait_queue but
98815b726efSAndrea Arcangeli 	 * the spin_unlock would allow the waitqueue_active to
98915b726efSAndrea Arcangeli 	 * pass above the actual list_add inside
99015b726efSAndrea Arcangeli 	 * add_wait_queue critical section. So use a full
99115b726efSAndrea Arcangeli 	 * memory barrier to serialize the list_add write of
99215b726efSAndrea Arcangeli 	 * add_wait_queue() with the waitqueue_active read
99315b726efSAndrea Arcangeli 	 * below.
99415b726efSAndrea Arcangeli 	 */
99515b726efSAndrea Arcangeli 	ret = 0;
99615b726efSAndrea Arcangeli 	smp_mb();
99715b726efSAndrea Arcangeli 	if (waitqueue_active(&ctx->fault_pending_wqh))
998a9a08845SLinus Torvalds 		ret = EPOLLIN;
9999cd75c3cSPavel Emelyanov 	else if (waitqueue_active(&ctx->event_wqh))
1000a9a08845SLinus Torvalds 		ret = EPOLLIN;
10019cd75c3cSPavel Emelyanov 
100286039bd3SAndrea Arcangeli 	return ret;
100386039bd3SAndrea Arcangeli }
100486039bd3SAndrea Arcangeli 
1005893e26e6SPavel Emelyanov static const struct file_operations userfaultfd_fops;
1006893e26e6SPavel Emelyanov 
1007b537900fSDaniel Colascione static int resolve_userfault_fork(struct userfaultfd_ctx *new,
1008b537900fSDaniel Colascione 				  struct inode *inode,
1009893e26e6SPavel Emelyanov 				  struct uffd_msg *msg)
1010893e26e6SPavel Emelyanov {
1011893e26e6SPavel Emelyanov 	int fd;
1012893e26e6SPavel Emelyanov 
1013b537900fSDaniel Colascione 	fd = anon_inode_getfd_secure("[userfaultfd]", &userfaultfd_fops, new,
1014abec3d01SOndrej Mosnacek 			O_RDONLY | (new->flags & UFFD_SHARED_FCNTL_FLAGS), inode);
1015893e26e6SPavel Emelyanov 	if (fd < 0)
1016893e26e6SPavel Emelyanov 		return fd;
1017893e26e6SPavel Emelyanov 
1018893e26e6SPavel Emelyanov 	msg->arg.reserved.reserved1 = 0;
1019893e26e6SPavel Emelyanov 	msg->arg.fork.ufd = fd;
1020893e26e6SPavel Emelyanov 	return 0;
1021893e26e6SPavel Emelyanov }
1022893e26e6SPavel Emelyanov 
102386039bd3SAndrea Arcangeli static ssize_t userfaultfd_ctx_read(struct userfaultfd_ctx *ctx, int no_wait,
1024b537900fSDaniel Colascione 				    struct uffd_msg *msg, struct inode *inode)
102586039bd3SAndrea Arcangeli {
102686039bd3SAndrea Arcangeli 	ssize_t ret;
102786039bd3SAndrea Arcangeli 	DECLARE_WAITQUEUE(wait, current);
102815b726efSAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
1029893e26e6SPavel Emelyanov 	/*
1030893e26e6SPavel Emelyanov 	 * Handling fork event requires sleeping operations, so
1031893e26e6SPavel Emelyanov 	 * we drop the event_wqh lock, then do these ops, then
1032893e26e6SPavel Emelyanov 	 * lock it back and wake up the waiter. While the lock is
1033893e26e6SPavel Emelyanov 	 * dropped the ewq may go away so we keep track of it
1034893e26e6SPavel Emelyanov 	 * carefully.
1035893e26e6SPavel Emelyanov 	 */
1036893e26e6SPavel Emelyanov 	LIST_HEAD(fork_event);
1037893e26e6SPavel Emelyanov 	struct userfaultfd_ctx *fork_nctx = NULL;
103886039bd3SAndrea Arcangeli 
103915b726efSAndrea Arcangeli 	/* always take the fd_wqh lock before the fault_pending_wqh lock */
1040ae62c16eSChristoph Hellwig 	spin_lock_irq(&ctx->fd_wqh.lock);
104186039bd3SAndrea Arcangeli 	__add_wait_queue(&ctx->fd_wqh, &wait);
104286039bd3SAndrea Arcangeli 	for (;;) {
104386039bd3SAndrea Arcangeli 		set_current_state(TASK_INTERRUPTIBLE);
104415b726efSAndrea Arcangeli 		spin_lock(&ctx->fault_pending_wqh.lock);
104515b726efSAndrea Arcangeli 		uwq = find_userfault(ctx);
104615b726efSAndrea Arcangeli 		if (uwq) {
104786039bd3SAndrea Arcangeli 			/*
10482c5b7e1bSAndrea Arcangeli 			 * Use a seqcount to repeat the lockless check
10492c5b7e1bSAndrea Arcangeli 			 * in wake_userfault() to avoid missing
10502c5b7e1bSAndrea Arcangeli 			 * wakeups because during the refile both
10512c5b7e1bSAndrea Arcangeli 			 * waitqueue could become empty if this is the
10522c5b7e1bSAndrea Arcangeli 			 * only userfault.
10532c5b7e1bSAndrea Arcangeli 			 */
10542c5b7e1bSAndrea Arcangeli 			write_seqcount_begin(&ctx->refile_seq);
10552c5b7e1bSAndrea Arcangeli 
10562c5b7e1bSAndrea Arcangeli 			/*
105715b726efSAndrea Arcangeli 			 * The fault_pending_wqh.lock prevents the uwq
105815b726efSAndrea Arcangeli 			 * to disappear from under us.
105915b726efSAndrea Arcangeli 			 *
106015b726efSAndrea Arcangeli 			 * Refile this userfault from
106115b726efSAndrea Arcangeli 			 * fault_pending_wqh to fault_wqh, it's not
106215b726efSAndrea Arcangeli 			 * pending anymore after we read it.
106315b726efSAndrea Arcangeli 			 *
106415b726efSAndrea Arcangeli 			 * Use list_del() by hand (as
106515b726efSAndrea Arcangeli 			 * userfaultfd_wake_function also uses
106615b726efSAndrea Arcangeli 			 * list_del_init() by hand) to be sure nobody
106715b726efSAndrea Arcangeli 			 * changes __remove_wait_queue() to use
106815b726efSAndrea Arcangeli 			 * list_del_init() in turn breaking the
106915b726efSAndrea Arcangeli 			 * !list_empty_careful() check in
10702055da97SIngo Molnar 			 * handle_userfault(). The uwq->wq.head list
107115b726efSAndrea Arcangeli 			 * must never be empty at any time during the
107215b726efSAndrea Arcangeli 			 * refile, or the waitqueue could disappear
107315b726efSAndrea Arcangeli 			 * from under us. The "wait_queue_head_t"
107415b726efSAndrea Arcangeli 			 * parameter of __remove_wait_queue() is unused
107515b726efSAndrea Arcangeli 			 * anyway.
107686039bd3SAndrea Arcangeli 			 */
10772055da97SIngo Molnar 			list_del(&uwq->wq.entry);
1078c430d1e8SMatthew Wilcox 			add_wait_queue(&ctx->fault_wqh, &uwq->wq);
107915b726efSAndrea Arcangeli 
10802c5b7e1bSAndrea Arcangeli 			write_seqcount_end(&ctx->refile_seq);
10812c5b7e1bSAndrea Arcangeli 
1082a9b85f94SAndrea Arcangeli 			/* careful to always initialize msg if ret == 0 */
1083a9b85f94SAndrea Arcangeli 			*msg = uwq->msg;
108415b726efSAndrea Arcangeli 			spin_unlock(&ctx->fault_pending_wqh.lock);
108586039bd3SAndrea Arcangeli 			ret = 0;
108686039bd3SAndrea Arcangeli 			break;
108786039bd3SAndrea Arcangeli 		}
108815b726efSAndrea Arcangeli 		spin_unlock(&ctx->fault_pending_wqh.lock);
10899cd75c3cSPavel Emelyanov 
10909cd75c3cSPavel Emelyanov 		spin_lock(&ctx->event_wqh.lock);
10919cd75c3cSPavel Emelyanov 		uwq = find_userfault_evt(ctx);
10929cd75c3cSPavel Emelyanov 		if (uwq) {
10939cd75c3cSPavel Emelyanov 			*msg = uwq->msg;
10949cd75c3cSPavel Emelyanov 
1095893e26e6SPavel Emelyanov 			if (uwq->msg.event == UFFD_EVENT_FORK) {
1096893e26e6SPavel Emelyanov 				fork_nctx = (struct userfaultfd_ctx *)
1097893e26e6SPavel Emelyanov 					(unsigned long)
1098893e26e6SPavel Emelyanov 					uwq->msg.arg.reserved.reserved1;
10992055da97SIngo Molnar 				list_move(&uwq->wq.entry, &fork_event);
1100384632e6SAndrea Arcangeli 				/*
1101384632e6SAndrea Arcangeli 				 * fork_nctx can be freed as soon as
1102384632e6SAndrea Arcangeli 				 * we drop the lock, unless we take a
1103384632e6SAndrea Arcangeli 				 * reference on it.
1104384632e6SAndrea Arcangeli 				 */
1105384632e6SAndrea Arcangeli 				userfaultfd_ctx_get(fork_nctx);
1106893e26e6SPavel Emelyanov 				spin_unlock(&ctx->event_wqh.lock);
1107893e26e6SPavel Emelyanov 				ret = 0;
1108893e26e6SPavel Emelyanov 				break;
1109893e26e6SPavel Emelyanov 			}
1110893e26e6SPavel Emelyanov 
11119cd75c3cSPavel Emelyanov 			userfaultfd_event_complete(ctx, uwq);
11129cd75c3cSPavel Emelyanov 			spin_unlock(&ctx->event_wqh.lock);
11139cd75c3cSPavel Emelyanov 			ret = 0;
11149cd75c3cSPavel Emelyanov 			break;
11159cd75c3cSPavel Emelyanov 		}
11169cd75c3cSPavel Emelyanov 		spin_unlock(&ctx->event_wqh.lock);
11179cd75c3cSPavel Emelyanov 
111886039bd3SAndrea Arcangeli 		if (signal_pending(current)) {
111986039bd3SAndrea Arcangeli 			ret = -ERESTARTSYS;
112086039bd3SAndrea Arcangeli 			break;
112186039bd3SAndrea Arcangeli 		}
112286039bd3SAndrea Arcangeli 		if (no_wait) {
112386039bd3SAndrea Arcangeli 			ret = -EAGAIN;
112486039bd3SAndrea Arcangeli 			break;
112586039bd3SAndrea Arcangeli 		}
1126ae62c16eSChristoph Hellwig 		spin_unlock_irq(&ctx->fd_wqh.lock);
112786039bd3SAndrea Arcangeli 		schedule();
1128ae62c16eSChristoph Hellwig 		spin_lock_irq(&ctx->fd_wqh.lock);
112986039bd3SAndrea Arcangeli 	}
113086039bd3SAndrea Arcangeli 	__remove_wait_queue(&ctx->fd_wqh, &wait);
113186039bd3SAndrea Arcangeli 	__set_current_state(TASK_RUNNING);
1132ae62c16eSChristoph Hellwig 	spin_unlock_irq(&ctx->fd_wqh.lock);
113386039bd3SAndrea Arcangeli 
1134893e26e6SPavel Emelyanov 	if (!ret && msg->event == UFFD_EVENT_FORK) {
1135b537900fSDaniel Colascione 		ret = resolve_userfault_fork(fork_nctx, inode, msg);
1136cbcfa130SEric Biggers 		spin_lock_irq(&ctx->event_wqh.lock);
1137893e26e6SPavel Emelyanov 		if (!list_empty(&fork_event)) {
1138384632e6SAndrea Arcangeli 			/*
1139384632e6SAndrea Arcangeli 			 * The fork thread didn't abort, so we can
1140384632e6SAndrea Arcangeli 			 * drop the temporary refcount.
1141384632e6SAndrea Arcangeli 			 */
1142384632e6SAndrea Arcangeli 			userfaultfd_ctx_put(fork_nctx);
1143384632e6SAndrea Arcangeli 
1144893e26e6SPavel Emelyanov 			uwq = list_first_entry(&fork_event,
1145893e26e6SPavel Emelyanov 					       typeof(*uwq),
11462055da97SIngo Molnar 					       wq.entry);
1147384632e6SAndrea Arcangeli 			/*
1148384632e6SAndrea Arcangeli 			 * If fork_event list wasn't empty and in turn
1149384632e6SAndrea Arcangeli 			 * the event wasn't already released by fork
1150384632e6SAndrea Arcangeli 			 * (the event is allocated on fork kernel
1151384632e6SAndrea Arcangeli 			 * stack), put the event back to its place in
1152384632e6SAndrea Arcangeli 			 * the event_wq. fork_event head will be freed
1153384632e6SAndrea Arcangeli 			 * as soon as we return so the event cannot
1154384632e6SAndrea Arcangeli 			 * stay queued there no matter the current
1155384632e6SAndrea Arcangeli 			 * "ret" value.
1156384632e6SAndrea Arcangeli 			 */
11572055da97SIngo Molnar 			list_del(&uwq->wq.entry);
1158893e26e6SPavel Emelyanov 			__add_wait_queue(&ctx->event_wqh, &uwq->wq);
1159384632e6SAndrea Arcangeli 
1160384632e6SAndrea Arcangeli 			/*
1161384632e6SAndrea Arcangeli 			 * Leave the event in the waitqueue and report
1162384632e6SAndrea Arcangeli 			 * error to userland if we failed to resolve
1163384632e6SAndrea Arcangeli 			 * the userfault fork.
1164384632e6SAndrea Arcangeli 			 */
1165384632e6SAndrea Arcangeli 			if (likely(!ret))
1166893e26e6SPavel Emelyanov 				userfaultfd_event_complete(ctx, uwq);
1167384632e6SAndrea Arcangeli 		} else {
1168384632e6SAndrea Arcangeli 			/*
1169384632e6SAndrea Arcangeli 			 * Here the fork thread aborted and the
1170384632e6SAndrea Arcangeli 			 * refcount from the fork thread on fork_nctx
1171384632e6SAndrea Arcangeli 			 * has already been released. We still hold
1172384632e6SAndrea Arcangeli 			 * the reference we took before releasing the
1173384632e6SAndrea Arcangeli 			 * lock above. If resolve_userfault_fork
1174384632e6SAndrea Arcangeli 			 * failed we've to drop it because the
1175384632e6SAndrea Arcangeli 			 * fork_nctx has to be freed in such case. If
1176384632e6SAndrea Arcangeli 			 * it succeeded we'll hold it because the new
1177384632e6SAndrea Arcangeli 			 * uffd references it.
1178384632e6SAndrea Arcangeli 			 */
1179384632e6SAndrea Arcangeli 			if (ret)
1180384632e6SAndrea Arcangeli 				userfaultfd_ctx_put(fork_nctx);
1181893e26e6SPavel Emelyanov 		}
1182cbcfa130SEric Biggers 		spin_unlock_irq(&ctx->event_wqh.lock);
1183893e26e6SPavel Emelyanov 	}
1184893e26e6SPavel Emelyanov 
118586039bd3SAndrea Arcangeli 	return ret;
118686039bd3SAndrea Arcangeli }
118786039bd3SAndrea Arcangeli 
118886039bd3SAndrea Arcangeli static ssize_t userfaultfd_read(struct file *file, char __user *buf,
118986039bd3SAndrea Arcangeli 				size_t count, loff_t *ppos)
119086039bd3SAndrea Arcangeli {
119186039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
119286039bd3SAndrea Arcangeli 	ssize_t _ret, ret = 0;
1193a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
119486039bd3SAndrea Arcangeli 	int no_wait = file->f_flags & O_NONBLOCK;
1195b537900fSDaniel Colascione 	struct inode *inode = file_inode(file);
119686039bd3SAndrea Arcangeli 
119722e5fe2aSNadav Amit 	if (!userfaultfd_is_initialized(ctx))
119886039bd3SAndrea Arcangeli 		return -EINVAL;
119986039bd3SAndrea Arcangeli 
120086039bd3SAndrea Arcangeli 	for (;;) {
1201a9b85f94SAndrea Arcangeli 		if (count < sizeof(msg))
120286039bd3SAndrea Arcangeli 			return ret ? ret : -EINVAL;
1203b537900fSDaniel Colascione 		_ret = userfaultfd_ctx_read(ctx, no_wait, &msg, inode);
120486039bd3SAndrea Arcangeli 		if (_ret < 0)
120586039bd3SAndrea Arcangeli 			return ret ? ret : _ret;
1206a9b85f94SAndrea Arcangeli 		if (copy_to_user((__u64 __user *) buf, &msg, sizeof(msg)))
120786039bd3SAndrea Arcangeli 			return ret ? ret : -EFAULT;
1208a9b85f94SAndrea Arcangeli 		ret += sizeof(msg);
1209a9b85f94SAndrea Arcangeli 		buf += sizeof(msg);
1210a9b85f94SAndrea Arcangeli 		count -= sizeof(msg);
121186039bd3SAndrea Arcangeli 		/*
121286039bd3SAndrea Arcangeli 		 * Allow to read more than one fault at time but only
121386039bd3SAndrea Arcangeli 		 * block if waiting for the very first one.
121486039bd3SAndrea Arcangeli 		 */
121586039bd3SAndrea Arcangeli 		no_wait = O_NONBLOCK;
121686039bd3SAndrea Arcangeli 	}
121786039bd3SAndrea Arcangeli }
121886039bd3SAndrea Arcangeli 
121986039bd3SAndrea Arcangeli static void __wake_userfault(struct userfaultfd_ctx *ctx,
122086039bd3SAndrea Arcangeli 			     struct userfaultfd_wake_range *range)
122186039bd3SAndrea Arcangeli {
1222cbcfa130SEric Biggers 	spin_lock_irq(&ctx->fault_pending_wqh.lock);
122386039bd3SAndrea Arcangeli 	/* wake all in the range and autoremove */
122415b726efSAndrea Arcangeli 	if (waitqueue_active(&ctx->fault_pending_wqh))
1225ac5be6b4SAndrea Arcangeli 		__wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL,
122615b726efSAndrea Arcangeli 				     range);
122715b726efSAndrea Arcangeli 	if (waitqueue_active(&ctx->fault_wqh))
1228c430d1e8SMatthew Wilcox 		__wake_up(&ctx->fault_wqh, TASK_NORMAL, 1, range);
1229cbcfa130SEric Biggers 	spin_unlock_irq(&ctx->fault_pending_wqh.lock);
123086039bd3SAndrea Arcangeli }
123186039bd3SAndrea Arcangeli 
123286039bd3SAndrea Arcangeli static __always_inline void wake_userfault(struct userfaultfd_ctx *ctx,
123386039bd3SAndrea Arcangeli 					   struct userfaultfd_wake_range *range)
123486039bd3SAndrea Arcangeli {
12352c5b7e1bSAndrea Arcangeli 	unsigned seq;
12362c5b7e1bSAndrea Arcangeli 	bool need_wakeup;
12372c5b7e1bSAndrea Arcangeli 
123886039bd3SAndrea Arcangeli 	/*
123986039bd3SAndrea Arcangeli 	 * To be sure waitqueue_active() is not reordered by the CPU
124086039bd3SAndrea Arcangeli 	 * before the pagetable update, use an explicit SMP memory
12413e4e28c5SMichel Lespinasse 	 * barrier here. PT lock release or mmap_read_unlock(mm) still
124286039bd3SAndrea Arcangeli 	 * have release semantics that can allow the
124386039bd3SAndrea Arcangeli 	 * waitqueue_active() to be reordered before the pte update.
124486039bd3SAndrea Arcangeli 	 */
124586039bd3SAndrea Arcangeli 	smp_mb();
124686039bd3SAndrea Arcangeli 
124786039bd3SAndrea Arcangeli 	/*
124886039bd3SAndrea Arcangeli 	 * Use waitqueue_active because it's very frequent to
124986039bd3SAndrea Arcangeli 	 * change the address space atomically even if there are no
125086039bd3SAndrea Arcangeli 	 * userfaults yet. So we take the spinlock only when we're
125186039bd3SAndrea Arcangeli 	 * sure we've userfaults to wake.
125286039bd3SAndrea Arcangeli 	 */
12532c5b7e1bSAndrea Arcangeli 	do {
12542c5b7e1bSAndrea Arcangeli 		seq = read_seqcount_begin(&ctx->refile_seq);
12552c5b7e1bSAndrea Arcangeli 		need_wakeup = waitqueue_active(&ctx->fault_pending_wqh) ||
12562c5b7e1bSAndrea Arcangeli 			waitqueue_active(&ctx->fault_wqh);
12572c5b7e1bSAndrea Arcangeli 		cond_resched();
12582c5b7e1bSAndrea Arcangeli 	} while (read_seqcount_retry(&ctx->refile_seq, seq));
12592c5b7e1bSAndrea Arcangeli 	if (need_wakeup)
126086039bd3SAndrea Arcangeli 		__wake_userfault(ctx, range);
126186039bd3SAndrea Arcangeli }
126286039bd3SAndrea Arcangeli 
126386039bd3SAndrea Arcangeli static __always_inline int validate_range(struct mm_struct *mm,
1264e71e2aceSPeter Collingbourne 					  __u64 start, __u64 len)
126586039bd3SAndrea Arcangeli {
126686039bd3SAndrea Arcangeli 	__u64 task_size = mm->task_size;
126786039bd3SAndrea Arcangeli 
1268e71e2aceSPeter Collingbourne 	if (start & ~PAGE_MASK)
126986039bd3SAndrea Arcangeli 		return -EINVAL;
127086039bd3SAndrea Arcangeli 	if (len & ~PAGE_MASK)
127186039bd3SAndrea Arcangeli 		return -EINVAL;
127286039bd3SAndrea Arcangeli 	if (!len)
127386039bd3SAndrea Arcangeli 		return -EINVAL;
1274e71e2aceSPeter Collingbourne 	if (start < mmap_min_addr)
127586039bd3SAndrea Arcangeli 		return -EINVAL;
1276e71e2aceSPeter Collingbourne 	if (start >= task_size)
127786039bd3SAndrea Arcangeli 		return -EINVAL;
1278e71e2aceSPeter Collingbourne 	if (len > task_size - start)
127986039bd3SAndrea Arcangeli 		return -EINVAL;
128086039bd3SAndrea Arcangeli 	return 0;
128186039bd3SAndrea Arcangeli }
128286039bd3SAndrea Arcangeli 
128386039bd3SAndrea Arcangeli static int userfaultfd_register(struct userfaultfd_ctx *ctx,
128486039bd3SAndrea Arcangeli 				unsigned long arg)
128586039bd3SAndrea Arcangeli {
128686039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
128786039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev, *cur;
128886039bd3SAndrea Arcangeli 	int ret;
128986039bd3SAndrea Arcangeli 	struct uffdio_register uffdio_register;
129086039bd3SAndrea Arcangeli 	struct uffdio_register __user *user_uffdio_register;
129186039bd3SAndrea Arcangeli 	unsigned long vm_flags, new_flags;
129286039bd3SAndrea Arcangeli 	bool found;
1293ce53e8e6SMike Rapoport 	bool basic_ioctls;
129486039bd3SAndrea Arcangeli 	unsigned long start, end, vma_end;
129569dbe6daSLiam R. Howlett 	MA_STATE(mas, &mm->mm_mt, 0, 0);
129686039bd3SAndrea Arcangeli 
129786039bd3SAndrea Arcangeli 	user_uffdio_register = (struct uffdio_register __user *) arg;
129886039bd3SAndrea Arcangeli 
129986039bd3SAndrea Arcangeli 	ret = -EFAULT;
130086039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_register, user_uffdio_register,
130186039bd3SAndrea Arcangeli 			   sizeof(uffdio_register)-sizeof(__u64)))
130286039bd3SAndrea Arcangeli 		goto out;
130386039bd3SAndrea Arcangeli 
130486039bd3SAndrea Arcangeli 	ret = -EINVAL;
130586039bd3SAndrea Arcangeli 	if (!uffdio_register.mode)
130686039bd3SAndrea Arcangeli 		goto out;
13077677f7fdSAxel Rasmussen 	if (uffdio_register.mode & ~UFFD_API_REGISTER_MODES)
130886039bd3SAndrea Arcangeli 		goto out;
130986039bd3SAndrea Arcangeli 	vm_flags = 0;
131086039bd3SAndrea Arcangeli 	if (uffdio_register.mode & UFFDIO_REGISTER_MODE_MISSING)
131186039bd3SAndrea Arcangeli 		vm_flags |= VM_UFFD_MISSING;
131200b151f2SPeter Xu 	if (uffdio_register.mode & UFFDIO_REGISTER_MODE_WP) {
131300b151f2SPeter Xu #ifndef CONFIG_HAVE_ARCH_USERFAULTFD_WP
131400b151f2SPeter Xu 		goto out;
131500b151f2SPeter Xu #endif
131686039bd3SAndrea Arcangeli 		vm_flags |= VM_UFFD_WP;
131700b151f2SPeter Xu 	}
13187677f7fdSAxel Rasmussen 	if (uffdio_register.mode & UFFDIO_REGISTER_MODE_MINOR) {
13197677f7fdSAxel Rasmussen #ifndef CONFIG_HAVE_ARCH_USERFAULTFD_MINOR
13207677f7fdSAxel Rasmussen 		goto out;
13217677f7fdSAxel Rasmussen #endif
13227677f7fdSAxel Rasmussen 		vm_flags |= VM_UFFD_MINOR;
13237677f7fdSAxel Rasmussen 	}
132486039bd3SAndrea Arcangeli 
1325e71e2aceSPeter Collingbourne 	ret = validate_range(mm, uffdio_register.range.start,
132686039bd3SAndrea Arcangeli 			     uffdio_register.range.len);
132786039bd3SAndrea Arcangeli 	if (ret)
132886039bd3SAndrea Arcangeli 		goto out;
132986039bd3SAndrea Arcangeli 
133086039bd3SAndrea Arcangeli 	start = uffdio_register.range.start;
133186039bd3SAndrea Arcangeli 	end = start + uffdio_register.range.len;
133286039bd3SAndrea Arcangeli 
1333d2005e3fSOleg Nesterov 	ret = -ENOMEM;
1334d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
1335d2005e3fSOleg Nesterov 		goto out;
1336d2005e3fSOleg Nesterov 
1337d8ed45c5SMichel Lespinasse 	mmap_write_lock(mm);
133869dbe6daSLiam R. Howlett 	mas_set(&mas, start);
133969dbe6daSLiam R. Howlett 	vma = mas_find(&mas, ULONG_MAX);
134086039bd3SAndrea Arcangeli 	if (!vma)
134186039bd3SAndrea Arcangeli 		goto out_unlock;
134286039bd3SAndrea Arcangeli 
134386039bd3SAndrea Arcangeli 	/* check that there's at least one vma in the range */
134486039bd3SAndrea Arcangeli 	ret = -EINVAL;
134586039bd3SAndrea Arcangeli 	if (vma->vm_start >= end)
134686039bd3SAndrea Arcangeli 		goto out_unlock;
134786039bd3SAndrea Arcangeli 
134886039bd3SAndrea Arcangeli 	/*
1349cab350afSMike Kravetz 	 * If the first vma contains huge pages, make sure start address
1350cab350afSMike Kravetz 	 * is aligned to huge page size.
1351cab350afSMike Kravetz 	 */
1352cab350afSMike Kravetz 	if (is_vm_hugetlb_page(vma)) {
1353cab350afSMike Kravetz 		unsigned long vma_hpagesize = vma_kernel_pagesize(vma);
1354cab350afSMike Kravetz 
1355cab350afSMike Kravetz 		if (start & (vma_hpagesize - 1))
1356cab350afSMike Kravetz 			goto out_unlock;
1357cab350afSMike Kravetz 	}
1358cab350afSMike Kravetz 
1359cab350afSMike Kravetz 	/*
136086039bd3SAndrea Arcangeli 	 * Search for not compatible vmas.
136186039bd3SAndrea Arcangeli 	 */
136286039bd3SAndrea Arcangeli 	found = false;
1363ce53e8e6SMike Rapoport 	basic_ioctls = false;
136469dbe6daSLiam R. Howlett 	for (cur = vma; cur; cur = mas_next(&mas, end - 1)) {
136586039bd3SAndrea Arcangeli 		cond_resched();
136686039bd3SAndrea Arcangeli 
136786039bd3SAndrea Arcangeli 		BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
13687677f7fdSAxel Rasmussen 		       !!(cur->vm_flags & __VM_UFFD_FLAGS));
136986039bd3SAndrea Arcangeli 
137086039bd3SAndrea Arcangeli 		/* check not compatible vmas */
137186039bd3SAndrea Arcangeli 		ret = -EINVAL;
137263b2d417SAndrea Arcangeli 		if (!vma_can_userfault(cur, vm_flags))
137386039bd3SAndrea Arcangeli 			goto out_unlock;
137429ec9066SAndrea Arcangeli 
137529ec9066SAndrea Arcangeli 		/*
137629ec9066SAndrea Arcangeli 		 * UFFDIO_COPY will fill file holes even without
137729ec9066SAndrea Arcangeli 		 * PROT_WRITE. This check enforces that if this is a
137829ec9066SAndrea Arcangeli 		 * MAP_SHARED, the process has write permission to the backing
137929ec9066SAndrea Arcangeli 		 * file. If VM_MAYWRITE is set it also enforces that on a
138029ec9066SAndrea Arcangeli 		 * MAP_SHARED vma: there is no F_WRITE_SEAL and no further
138129ec9066SAndrea Arcangeli 		 * F_WRITE_SEAL can be taken until the vma is destroyed.
138229ec9066SAndrea Arcangeli 		 */
138329ec9066SAndrea Arcangeli 		ret = -EPERM;
138429ec9066SAndrea Arcangeli 		if (unlikely(!(cur->vm_flags & VM_MAYWRITE)))
138529ec9066SAndrea Arcangeli 			goto out_unlock;
138629ec9066SAndrea Arcangeli 
1387cab350afSMike Kravetz 		/*
1388cab350afSMike Kravetz 		 * If this vma contains ending address, and huge pages
1389cab350afSMike Kravetz 		 * check alignment.
1390cab350afSMike Kravetz 		 */
1391cab350afSMike Kravetz 		if (is_vm_hugetlb_page(cur) && end <= cur->vm_end &&
1392cab350afSMike Kravetz 		    end > cur->vm_start) {
1393cab350afSMike Kravetz 			unsigned long vma_hpagesize = vma_kernel_pagesize(cur);
1394cab350afSMike Kravetz 
1395cab350afSMike Kravetz 			ret = -EINVAL;
1396cab350afSMike Kravetz 
1397cab350afSMike Kravetz 			if (end & (vma_hpagesize - 1))
1398cab350afSMike Kravetz 				goto out_unlock;
1399cab350afSMike Kravetz 		}
140063b2d417SAndrea Arcangeli 		if ((vm_flags & VM_UFFD_WP) && !(cur->vm_flags & VM_MAYWRITE))
140163b2d417SAndrea Arcangeli 			goto out_unlock;
140286039bd3SAndrea Arcangeli 
140386039bd3SAndrea Arcangeli 		/*
140486039bd3SAndrea Arcangeli 		 * Check that this vma isn't already owned by a
140586039bd3SAndrea Arcangeli 		 * different userfaultfd. We can't allow more than one
140686039bd3SAndrea Arcangeli 		 * userfaultfd to own a single vma simultaneously or we
140786039bd3SAndrea Arcangeli 		 * wouldn't know which one to deliver the userfaults to.
140886039bd3SAndrea Arcangeli 		 */
140986039bd3SAndrea Arcangeli 		ret = -EBUSY;
141086039bd3SAndrea Arcangeli 		if (cur->vm_userfaultfd_ctx.ctx &&
141186039bd3SAndrea Arcangeli 		    cur->vm_userfaultfd_ctx.ctx != ctx)
141286039bd3SAndrea Arcangeli 			goto out_unlock;
141386039bd3SAndrea Arcangeli 
1414cab350afSMike Kravetz 		/*
1415cab350afSMike Kravetz 		 * Note vmas containing huge pages
1416cab350afSMike Kravetz 		 */
1417ce53e8e6SMike Rapoport 		if (is_vm_hugetlb_page(cur))
1418ce53e8e6SMike Rapoport 			basic_ioctls = true;
1419cab350afSMike Kravetz 
142086039bd3SAndrea Arcangeli 		found = true;
142186039bd3SAndrea Arcangeli 	}
142286039bd3SAndrea Arcangeli 	BUG_ON(!found);
142386039bd3SAndrea Arcangeli 
142469dbe6daSLiam R. Howlett 	mas_set(&mas, start);
142569dbe6daSLiam R. Howlett 	prev = mas_prev(&mas, 0);
142669dbe6daSLiam R. Howlett 	if (prev != vma)
142769dbe6daSLiam R. Howlett 		mas_next(&mas, ULONG_MAX);
142886039bd3SAndrea Arcangeli 
142986039bd3SAndrea Arcangeli 	ret = 0;
143086039bd3SAndrea Arcangeli 	do {
143186039bd3SAndrea Arcangeli 		cond_resched();
143286039bd3SAndrea Arcangeli 
143363b2d417SAndrea Arcangeli 		BUG_ON(!vma_can_userfault(vma, vm_flags));
143486039bd3SAndrea Arcangeli 		BUG_ON(vma->vm_userfaultfd_ctx.ctx &&
143586039bd3SAndrea Arcangeli 		       vma->vm_userfaultfd_ctx.ctx != ctx);
143629ec9066SAndrea Arcangeli 		WARN_ON(!(vma->vm_flags & VM_MAYWRITE));
143786039bd3SAndrea Arcangeli 
143886039bd3SAndrea Arcangeli 		/*
143986039bd3SAndrea Arcangeli 		 * Nothing to do: this vma is already registered into this
144086039bd3SAndrea Arcangeli 		 * userfaultfd and with the right tracking mode too.
144186039bd3SAndrea Arcangeli 		 */
144286039bd3SAndrea Arcangeli 		if (vma->vm_userfaultfd_ctx.ctx == ctx &&
144386039bd3SAndrea Arcangeli 		    (vma->vm_flags & vm_flags) == vm_flags)
144486039bd3SAndrea Arcangeli 			goto skip;
144586039bd3SAndrea Arcangeli 
144686039bd3SAndrea Arcangeli 		if (vma->vm_start > start)
144786039bd3SAndrea Arcangeli 			start = vma->vm_start;
144886039bd3SAndrea Arcangeli 		vma_end = min(end, vma->vm_end);
144986039bd3SAndrea Arcangeli 
14507677f7fdSAxel Rasmussen 		new_flags = (vma->vm_flags & ~__VM_UFFD_FLAGS) | vm_flags;
145186039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, start, vma_end, new_flags,
145286039bd3SAndrea Arcangeli 				 vma->anon_vma, vma->vm_file, vma->vm_pgoff,
145386039bd3SAndrea Arcangeli 				 vma_policy(vma),
14549a10064fSColin Cross 				 ((struct vm_userfaultfd_ctx){ ctx }),
14555c26f6acSSuren Baghdasaryan 				 anon_vma_name(vma));
145686039bd3SAndrea Arcangeli 		if (prev) {
145769dbe6daSLiam R. Howlett 			/* vma_merge() invalidated the mas */
145869dbe6daSLiam R. Howlett 			mas_pause(&mas);
145986039bd3SAndrea Arcangeli 			vma = prev;
146086039bd3SAndrea Arcangeli 			goto next;
146186039bd3SAndrea Arcangeli 		}
146286039bd3SAndrea Arcangeli 		if (vma->vm_start < start) {
146386039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, start, 1);
146486039bd3SAndrea Arcangeli 			if (ret)
146586039bd3SAndrea Arcangeli 				break;
146669dbe6daSLiam R. Howlett 			/* split_vma() invalidated the mas */
146769dbe6daSLiam R. Howlett 			mas_pause(&mas);
146886039bd3SAndrea Arcangeli 		}
146986039bd3SAndrea Arcangeli 		if (vma->vm_end > end) {
147086039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, end, 0);
147186039bd3SAndrea Arcangeli 			if (ret)
147286039bd3SAndrea Arcangeli 				break;
147369dbe6daSLiam R. Howlett 			/* split_vma() invalidated the mas */
147469dbe6daSLiam R. Howlett 			mas_pause(&mas);
147586039bd3SAndrea Arcangeli 		}
147686039bd3SAndrea Arcangeli 	next:
147786039bd3SAndrea Arcangeli 		/*
147886039bd3SAndrea Arcangeli 		 * In the vma_merge() successful mprotect-like case 8:
147986039bd3SAndrea Arcangeli 		 * the next vma was merged into the current one and
148086039bd3SAndrea Arcangeli 		 * the current one has not been updated yet.
148186039bd3SAndrea Arcangeli 		 */
1482*51d3d5ebSDavid Hildenbrand 		userfaultfd_set_vm_flags(vma, new_flags);
148386039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx.ctx = ctx;
148486039bd3SAndrea Arcangeli 
14856dfeaff9SPeter Xu 		if (is_vm_hugetlb_page(vma) && uffd_disable_huge_pmd_share(vma))
14866dfeaff9SPeter Xu 			hugetlb_unshare_all_pmds(vma);
14876dfeaff9SPeter Xu 
148886039bd3SAndrea Arcangeli 	skip:
148986039bd3SAndrea Arcangeli 		prev = vma;
149086039bd3SAndrea Arcangeli 		start = vma->vm_end;
149169dbe6daSLiam R. Howlett 		vma = mas_next(&mas, end - 1);
149269dbe6daSLiam R. Howlett 	} while (vma);
149386039bd3SAndrea Arcangeli out_unlock:
1494d8ed45c5SMichel Lespinasse 	mmap_write_unlock(mm);
1495d2005e3fSOleg Nesterov 	mmput(mm);
149686039bd3SAndrea Arcangeli 	if (!ret) {
149714819305SPeter Xu 		__u64 ioctls_out;
149814819305SPeter Xu 
149914819305SPeter Xu 		ioctls_out = basic_ioctls ? UFFD_API_RANGE_IOCTLS_BASIC :
150014819305SPeter Xu 		    UFFD_API_RANGE_IOCTLS;
150114819305SPeter Xu 
150214819305SPeter Xu 		/*
150314819305SPeter Xu 		 * Declare the WP ioctl only if the WP mode is
150414819305SPeter Xu 		 * specified and all checks passed with the range
150514819305SPeter Xu 		 */
150614819305SPeter Xu 		if (!(uffdio_register.mode & UFFDIO_REGISTER_MODE_WP))
150714819305SPeter Xu 			ioctls_out &= ~((__u64)1 << _UFFDIO_WRITEPROTECT);
150814819305SPeter Xu 
1509f6191471SAxel Rasmussen 		/* CONTINUE ioctl is only supported for MINOR ranges. */
1510f6191471SAxel Rasmussen 		if (!(uffdio_register.mode & UFFDIO_REGISTER_MODE_MINOR))
1511f6191471SAxel Rasmussen 			ioctls_out &= ~((__u64)1 << _UFFDIO_CONTINUE);
1512f6191471SAxel Rasmussen 
151386039bd3SAndrea Arcangeli 		/*
151486039bd3SAndrea Arcangeli 		 * Now that we scanned all vmas we can already tell
151586039bd3SAndrea Arcangeli 		 * userland which ioctls methods are guaranteed to
151686039bd3SAndrea Arcangeli 		 * succeed on this range.
151786039bd3SAndrea Arcangeli 		 */
151814819305SPeter Xu 		if (put_user(ioctls_out, &user_uffdio_register->ioctls))
151986039bd3SAndrea Arcangeli 			ret = -EFAULT;
152086039bd3SAndrea Arcangeli 	}
152186039bd3SAndrea Arcangeli out:
152286039bd3SAndrea Arcangeli 	return ret;
152386039bd3SAndrea Arcangeli }
152486039bd3SAndrea Arcangeli 
152586039bd3SAndrea Arcangeli static int userfaultfd_unregister(struct userfaultfd_ctx *ctx,
152686039bd3SAndrea Arcangeli 				  unsigned long arg)
152786039bd3SAndrea Arcangeli {
152886039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
152986039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev, *cur;
153086039bd3SAndrea Arcangeli 	int ret;
153186039bd3SAndrea Arcangeli 	struct uffdio_range uffdio_unregister;
153286039bd3SAndrea Arcangeli 	unsigned long new_flags;
153386039bd3SAndrea Arcangeli 	bool found;
153486039bd3SAndrea Arcangeli 	unsigned long start, end, vma_end;
153586039bd3SAndrea Arcangeli 	const void __user *buf = (void __user *)arg;
153669dbe6daSLiam R. Howlett 	MA_STATE(mas, &mm->mm_mt, 0, 0);
153786039bd3SAndrea Arcangeli 
153886039bd3SAndrea Arcangeli 	ret = -EFAULT;
153986039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_unregister, buf, sizeof(uffdio_unregister)))
154086039bd3SAndrea Arcangeli 		goto out;
154186039bd3SAndrea Arcangeli 
1542e71e2aceSPeter Collingbourne 	ret = validate_range(mm, uffdio_unregister.start,
154386039bd3SAndrea Arcangeli 			     uffdio_unregister.len);
154486039bd3SAndrea Arcangeli 	if (ret)
154586039bd3SAndrea Arcangeli 		goto out;
154686039bd3SAndrea Arcangeli 
154786039bd3SAndrea Arcangeli 	start = uffdio_unregister.start;
154886039bd3SAndrea Arcangeli 	end = start + uffdio_unregister.len;
154986039bd3SAndrea Arcangeli 
1550d2005e3fSOleg Nesterov 	ret = -ENOMEM;
1551d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
1552d2005e3fSOleg Nesterov 		goto out;
1553d2005e3fSOleg Nesterov 
1554d8ed45c5SMichel Lespinasse 	mmap_write_lock(mm);
155569dbe6daSLiam R. Howlett 	mas_set(&mas, start);
155669dbe6daSLiam R. Howlett 	vma = mas_find(&mas, ULONG_MAX);
155786039bd3SAndrea Arcangeli 	if (!vma)
155886039bd3SAndrea Arcangeli 		goto out_unlock;
155986039bd3SAndrea Arcangeli 
156086039bd3SAndrea Arcangeli 	/* check that there's at least one vma in the range */
156186039bd3SAndrea Arcangeli 	ret = -EINVAL;
156286039bd3SAndrea Arcangeli 	if (vma->vm_start >= end)
156386039bd3SAndrea Arcangeli 		goto out_unlock;
156486039bd3SAndrea Arcangeli 
156586039bd3SAndrea Arcangeli 	/*
1566cab350afSMike Kravetz 	 * If the first vma contains huge pages, make sure start address
1567cab350afSMike Kravetz 	 * is aligned to huge page size.
1568cab350afSMike Kravetz 	 */
1569cab350afSMike Kravetz 	if (is_vm_hugetlb_page(vma)) {
1570cab350afSMike Kravetz 		unsigned long vma_hpagesize = vma_kernel_pagesize(vma);
1571cab350afSMike Kravetz 
1572cab350afSMike Kravetz 		if (start & (vma_hpagesize - 1))
1573cab350afSMike Kravetz 			goto out_unlock;
1574cab350afSMike Kravetz 	}
1575cab350afSMike Kravetz 
1576cab350afSMike Kravetz 	/*
157786039bd3SAndrea Arcangeli 	 * Search for not compatible vmas.
157886039bd3SAndrea Arcangeli 	 */
157986039bd3SAndrea Arcangeli 	found = false;
158086039bd3SAndrea Arcangeli 	ret = -EINVAL;
158169dbe6daSLiam R. Howlett 	for (cur = vma; cur; cur = mas_next(&mas, end - 1)) {
158286039bd3SAndrea Arcangeli 		cond_resched();
158386039bd3SAndrea Arcangeli 
158486039bd3SAndrea Arcangeli 		BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
15857677f7fdSAxel Rasmussen 		       !!(cur->vm_flags & __VM_UFFD_FLAGS));
158686039bd3SAndrea Arcangeli 
158786039bd3SAndrea Arcangeli 		/*
158886039bd3SAndrea Arcangeli 		 * Check not compatible vmas, not strictly required
158986039bd3SAndrea Arcangeli 		 * here as not compatible vmas cannot have an
159086039bd3SAndrea Arcangeli 		 * userfaultfd_ctx registered on them, but this
159186039bd3SAndrea Arcangeli 		 * provides for more strict behavior to notice
159286039bd3SAndrea Arcangeli 		 * unregistration errors.
159386039bd3SAndrea Arcangeli 		 */
159463b2d417SAndrea Arcangeli 		if (!vma_can_userfault(cur, cur->vm_flags))
159586039bd3SAndrea Arcangeli 			goto out_unlock;
159686039bd3SAndrea Arcangeli 
159786039bd3SAndrea Arcangeli 		found = true;
159886039bd3SAndrea Arcangeli 	}
159986039bd3SAndrea Arcangeli 	BUG_ON(!found);
160086039bd3SAndrea Arcangeli 
160169dbe6daSLiam R. Howlett 	mas_set(&mas, start);
160269dbe6daSLiam R. Howlett 	prev = mas_prev(&mas, 0);
160369dbe6daSLiam R. Howlett 	if (prev != vma)
160469dbe6daSLiam R. Howlett 		mas_next(&mas, ULONG_MAX);
160586039bd3SAndrea Arcangeli 
160686039bd3SAndrea Arcangeli 	ret = 0;
160786039bd3SAndrea Arcangeli 	do {
160886039bd3SAndrea Arcangeli 		cond_resched();
160986039bd3SAndrea Arcangeli 
161063b2d417SAndrea Arcangeli 		BUG_ON(!vma_can_userfault(vma, vma->vm_flags));
161186039bd3SAndrea Arcangeli 
161286039bd3SAndrea Arcangeli 		/*
161386039bd3SAndrea Arcangeli 		 * Nothing to do: this vma is already registered into this
161486039bd3SAndrea Arcangeli 		 * userfaultfd and with the right tracking mode too.
161586039bd3SAndrea Arcangeli 		 */
161686039bd3SAndrea Arcangeli 		if (!vma->vm_userfaultfd_ctx.ctx)
161786039bd3SAndrea Arcangeli 			goto skip;
161886039bd3SAndrea Arcangeli 
161901e881f5SAndrea Arcangeli 		WARN_ON(!(vma->vm_flags & VM_MAYWRITE));
162001e881f5SAndrea Arcangeli 
162186039bd3SAndrea Arcangeli 		if (vma->vm_start > start)
162286039bd3SAndrea Arcangeli 			start = vma->vm_start;
162386039bd3SAndrea Arcangeli 		vma_end = min(end, vma->vm_end);
162486039bd3SAndrea Arcangeli 
162509fa5296SAndrea Arcangeli 		if (userfaultfd_missing(vma)) {
162609fa5296SAndrea Arcangeli 			/*
162709fa5296SAndrea Arcangeli 			 * Wake any concurrent pending userfault while
162809fa5296SAndrea Arcangeli 			 * we unregister, so they will not hang
162909fa5296SAndrea Arcangeli 			 * permanently and it avoids userland to call
163009fa5296SAndrea Arcangeli 			 * UFFDIO_WAKE explicitly.
163109fa5296SAndrea Arcangeli 			 */
163209fa5296SAndrea Arcangeli 			struct userfaultfd_wake_range range;
163309fa5296SAndrea Arcangeli 			range.start = start;
163409fa5296SAndrea Arcangeli 			range.len = vma_end - start;
163509fa5296SAndrea Arcangeli 			wake_userfault(vma->vm_userfaultfd_ctx.ctx, &range);
163609fa5296SAndrea Arcangeli 		}
163709fa5296SAndrea Arcangeli 
1638f369b07cSPeter Xu 		/* Reset ptes for the whole vma range if wr-protected */
1639f369b07cSPeter Xu 		if (userfaultfd_wp(vma))
1640f369b07cSPeter Xu 			uffd_wp_range(mm, vma, start, vma_end - start, false);
1641f369b07cSPeter Xu 
16427677f7fdSAxel Rasmussen 		new_flags = vma->vm_flags & ~__VM_UFFD_FLAGS;
164386039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, start, vma_end, new_flags,
164486039bd3SAndrea Arcangeli 				 vma->anon_vma, vma->vm_file, vma->vm_pgoff,
164586039bd3SAndrea Arcangeli 				 vma_policy(vma),
16465c26f6acSSuren Baghdasaryan 				 NULL_VM_UFFD_CTX, anon_vma_name(vma));
164786039bd3SAndrea Arcangeli 		if (prev) {
164886039bd3SAndrea Arcangeli 			vma = prev;
164959f2f4b8SLiam Howlett 			mas_pause(&mas);
165086039bd3SAndrea Arcangeli 			goto next;
165186039bd3SAndrea Arcangeli 		}
165286039bd3SAndrea Arcangeli 		if (vma->vm_start < start) {
165386039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, start, 1);
165486039bd3SAndrea Arcangeli 			if (ret)
165586039bd3SAndrea Arcangeli 				break;
165659f2f4b8SLiam Howlett 			mas_pause(&mas);
165786039bd3SAndrea Arcangeli 		}
165886039bd3SAndrea Arcangeli 		if (vma->vm_end > end) {
165986039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, end, 0);
166086039bd3SAndrea Arcangeli 			if (ret)
166186039bd3SAndrea Arcangeli 				break;
166259f2f4b8SLiam Howlett 			mas_pause(&mas);
166386039bd3SAndrea Arcangeli 		}
166486039bd3SAndrea Arcangeli 	next:
166586039bd3SAndrea Arcangeli 		/*
166686039bd3SAndrea Arcangeli 		 * In the vma_merge() successful mprotect-like case 8:
166786039bd3SAndrea Arcangeli 		 * the next vma was merged into the current one and
166886039bd3SAndrea Arcangeli 		 * the current one has not been updated yet.
166986039bd3SAndrea Arcangeli 		 */
1670*51d3d5ebSDavid Hildenbrand 		userfaultfd_set_vm_flags(vma, new_flags);
167186039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
167286039bd3SAndrea Arcangeli 
167386039bd3SAndrea Arcangeli 	skip:
167486039bd3SAndrea Arcangeli 		prev = vma;
167586039bd3SAndrea Arcangeli 		start = vma->vm_end;
167669dbe6daSLiam R. Howlett 		vma = mas_next(&mas, end - 1);
167769dbe6daSLiam R. Howlett 	} while (vma);
167886039bd3SAndrea Arcangeli out_unlock:
1679d8ed45c5SMichel Lespinasse 	mmap_write_unlock(mm);
1680d2005e3fSOleg Nesterov 	mmput(mm);
168186039bd3SAndrea Arcangeli out:
168286039bd3SAndrea Arcangeli 	return ret;
168386039bd3SAndrea Arcangeli }
168486039bd3SAndrea Arcangeli 
168586039bd3SAndrea Arcangeli /*
1686ba85c702SAndrea Arcangeli  * userfaultfd_wake may be used in combination with the
1687ba85c702SAndrea Arcangeli  * UFFDIO_*_MODE_DONTWAKE to wakeup userfaults in batches.
168886039bd3SAndrea Arcangeli  */
168986039bd3SAndrea Arcangeli static int userfaultfd_wake(struct userfaultfd_ctx *ctx,
169086039bd3SAndrea Arcangeli 			    unsigned long arg)
169186039bd3SAndrea Arcangeli {
169286039bd3SAndrea Arcangeli 	int ret;
169386039bd3SAndrea Arcangeli 	struct uffdio_range uffdio_wake;
169486039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range range;
169586039bd3SAndrea Arcangeli 	const void __user *buf = (void __user *)arg;
169686039bd3SAndrea Arcangeli 
169786039bd3SAndrea Arcangeli 	ret = -EFAULT;
169886039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_wake, buf, sizeof(uffdio_wake)))
169986039bd3SAndrea Arcangeli 		goto out;
170086039bd3SAndrea Arcangeli 
1701e71e2aceSPeter Collingbourne 	ret = validate_range(ctx->mm, uffdio_wake.start, uffdio_wake.len);
170286039bd3SAndrea Arcangeli 	if (ret)
170386039bd3SAndrea Arcangeli 		goto out;
170486039bd3SAndrea Arcangeli 
170586039bd3SAndrea Arcangeli 	range.start = uffdio_wake.start;
170686039bd3SAndrea Arcangeli 	range.len = uffdio_wake.len;
170786039bd3SAndrea Arcangeli 
170886039bd3SAndrea Arcangeli 	/*
170986039bd3SAndrea Arcangeli 	 * len == 0 means wake all and we don't want to wake all here,
171086039bd3SAndrea Arcangeli 	 * so check it again to be sure.
171186039bd3SAndrea Arcangeli 	 */
171286039bd3SAndrea Arcangeli 	VM_BUG_ON(!range.len);
171386039bd3SAndrea Arcangeli 
171486039bd3SAndrea Arcangeli 	wake_userfault(ctx, &range);
171586039bd3SAndrea Arcangeli 	ret = 0;
171686039bd3SAndrea Arcangeli 
171786039bd3SAndrea Arcangeli out:
171886039bd3SAndrea Arcangeli 	return ret;
171986039bd3SAndrea Arcangeli }
172086039bd3SAndrea Arcangeli 
1721ad465caeSAndrea Arcangeli static int userfaultfd_copy(struct userfaultfd_ctx *ctx,
1722ad465caeSAndrea Arcangeli 			    unsigned long arg)
1723ad465caeSAndrea Arcangeli {
1724ad465caeSAndrea Arcangeli 	__s64 ret;
1725ad465caeSAndrea Arcangeli 	struct uffdio_copy uffdio_copy;
1726ad465caeSAndrea Arcangeli 	struct uffdio_copy __user *user_uffdio_copy;
1727ad465caeSAndrea Arcangeli 	struct userfaultfd_wake_range range;
1728ad465caeSAndrea Arcangeli 
1729ad465caeSAndrea Arcangeli 	user_uffdio_copy = (struct uffdio_copy __user *) arg;
1730ad465caeSAndrea Arcangeli 
1731df2cc96eSMike Rapoport 	ret = -EAGAIN;
1732a759a909SNadav Amit 	if (atomic_read(&ctx->mmap_changing))
1733df2cc96eSMike Rapoport 		goto out;
1734df2cc96eSMike Rapoport 
1735ad465caeSAndrea Arcangeli 	ret = -EFAULT;
1736ad465caeSAndrea Arcangeli 	if (copy_from_user(&uffdio_copy, user_uffdio_copy,
1737ad465caeSAndrea Arcangeli 			   /* don't copy "copy" last field */
1738ad465caeSAndrea Arcangeli 			   sizeof(uffdio_copy)-sizeof(__s64)))
1739ad465caeSAndrea Arcangeli 		goto out;
1740ad465caeSAndrea Arcangeli 
1741e71e2aceSPeter Collingbourne 	ret = validate_range(ctx->mm, uffdio_copy.dst, uffdio_copy.len);
1742ad465caeSAndrea Arcangeli 	if (ret)
1743ad465caeSAndrea Arcangeli 		goto out;
1744ad465caeSAndrea Arcangeli 	/*
1745ad465caeSAndrea Arcangeli 	 * double check for wraparound just in case. copy_from_user()
1746ad465caeSAndrea Arcangeli 	 * will later check uffdio_copy.src + uffdio_copy.len to fit
1747ad465caeSAndrea Arcangeli 	 * in the userland range.
1748ad465caeSAndrea Arcangeli 	 */
1749ad465caeSAndrea Arcangeli 	ret = -EINVAL;
1750ad465caeSAndrea Arcangeli 	if (uffdio_copy.src + uffdio_copy.len <= uffdio_copy.src)
1751ad465caeSAndrea Arcangeli 		goto out;
175272981e0eSAndrea Arcangeli 	if (uffdio_copy.mode & ~(UFFDIO_COPY_MODE_DONTWAKE|UFFDIO_COPY_MODE_WP))
1753ad465caeSAndrea Arcangeli 		goto out;
1754d2005e3fSOleg Nesterov 	if (mmget_not_zero(ctx->mm)) {
1755ad465caeSAndrea Arcangeli 		ret = mcopy_atomic(ctx->mm, uffdio_copy.dst, uffdio_copy.src,
175672981e0eSAndrea Arcangeli 				   uffdio_copy.len, &ctx->mmap_changing,
175772981e0eSAndrea Arcangeli 				   uffdio_copy.mode);
1758d2005e3fSOleg Nesterov 		mmput(ctx->mm);
175996333187SMike Rapoport 	} else {
1760e86b298bSMike Rapoport 		return -ESRCH;
1761d2005e3fSOleg Nesterov 	}
1762ad465caeSAndrea Arcangeli 	if (unlikely(put_user(ret, &user_uffdio_copy->copy)))
1763ad465caeSAndrea Arcangeli 		return -EFAULT;
1764ad465caeSAndrea Arcangeli 	if (ret < 0)
1765ad465caeSAndrea Arcangeli 		goto out;
1766ad465caeSAndrea Arcangeli 	BUG_ON(!ret);
1767ad465caeSAndrea Arcangeli 	/* len == 0 would wake all */
1768ad465caeSAndrea Arcangeli 	range.len = ret;
1769ad465caeSAndrea Arcangeli 	if (!(uffdio_copy.mode & UFFDIO_COPY_MODE_DONTWAKE)) {
1770ad465caeSAndrea Arcangeli 		range.start = uffdio_copy.dst;
1771ad465caeSAndrea Arcangeli 		wake_userfault(ctx, &range);
1772ad465caeSAndrea Arcangeli 	}
1773ad465caeSAndrea Arcangeli 	ret = range.len == uffdio_copy.len ? 0 : -EAGAIN;
1774ad465caeSAndrea Arcangeli out:
1775ad465caeSAndrea Arcangeli 	return ret;
1776ad465caeSAndrea Arcangeli }
1777ad465caeSAndrea Arcangeli 
1778ad465caeSAndrea Arcangeli static int userfaultfd_zeropage(struct userfaultfd_ctx *ctx,
1779ad465caeSAndrea Arcangeli 				unsigned long arg)
1780ad465caeSAndrea Arcangeli {
1781ad465caeSAndrea Arcangeli 	__s64 ret;
1782ad465caeSAndrea Arcangeli 	struct uffdio_zeropage uffdio_zeropage;
1783ad465caeSAndrea Arcangeli 	struct uffdio_zeropage __user *user_uffdio_zeropage;
1784ad465caeSAndrea Arcangeli 	struct userfaultfd_wake_range range;
1785ad465caeSAndrea Arcangeli 
1786ad465caeSAndrea Arcangeli 	user_uffdio_zeropage = (struct uffdio_zeropage __user *) arg;
1787ad465caeSAndrea Arcangeli 
1788df2cc96eSMike Rapoport 	ret = -EAGAIN;
1789a759a909SNadav Amit 	if (atomic_read(&ctx->mmap_changing))
1790df2cc96eSMike Rapoport 		goto out;
1791df2cc96eSMike Rapoport 
1792ad465caeSAndrea Arcangeli 	ret = -EFAULT;
1793ad465caeSAndrea Arcangeli 	if (copy_from_user(&uffdio_zeropage, user_uffdio_zeropage,
1794ad465caeSAndrea Arcangeli 			   /* don't copy "zeropage" last field */
1795ad465caeSAndrea Arcangeli 			   sizeof(uffdio_zeropage)-sizeof(__s64)))
1796ad465caeSAndrea Arcangeli 		goto out;
1797ad465caeSAndrea Arcangeli 
1798e71e2aceSPeter Collingbourne 	ret = validate_range(ctx->mm, uffdio_zeropage.range.start,
1799ad465caeSAndrea Arcangeli 			     uffdio_zeropage.range.len);
1800ad465caeSAndrea Arcangeli 	if (ret)
1801ad465caeSAndrea Arcangeli 		goto out;
1802ad465caeSAndrea Arcangeli 	ret = -EINVAL;
1803ad465caeSAndrea Arcangeli 	if (uffdio_zeropage.mode & ~UFFDIO_ZEROPAGE_MODE_DONTWAKE)
1804ad465caeSAndrea Arcangeli 		goto out;
1805ad465caeSAndrea Arcangeli 
1806d2005e3fSOleg Nesterov 	if (mmget_not_zero(ctx->mm)) {
1807ad465caeSAndrea Arcangeli 		ret = mfill_zeropage(ctx->mm, uffdio_zeropage.range.start,
1808df2cc96eSMike Rapoport 				     uffdio_zeropage.range.len,
1809df2cc96eSMike Rapoport 				     &ctx->mmap_changing);
1810d2005e3fSOleg Nesterov 		mmput(ctx->mm);
18119d95aa4bSMike Rapoport 	} else {
1812e86b298bSMike Rapoport 		return -ESRCH;
1813d2005e3fSOleg Nesterov 	}
1814ad465caeSAndrea Arcangeli 	if (unlikely(put_user(ret, &user_uffdio_zeropage->zeropage)))
1815ad465caeSAndrea Arcangeli 		return -EFAULT;
1816ad465caeSAndrea Arcangeli 	if (ret < 0)
1817ad465caeSAndrea Arcangeli 		goto out;
1818ad465caeSAndrea Arcangeli 	/* len == 0 would wake all */
1819ad465caeSAndrea Arcangeli 	BUG_ON(!ret);
1820ad465caeSAndrea Arcangeli 	range.len = ret;
1821ad465caeSAndrea Arcangeli 	if (!(uffdio_zeropage.mode & UFFDIO_ZEROPAGE_MODE_DONTWAKE)) {
1822ad465caeSAndrea Arcangeli 		range.start = uffdio_zeropage.range.start;
1823ad465caeSAndrea Arcangeli 		wake_userfault(ctx, &range);
1824ad465caeSAndrea Arcangeli 	}
1825ad465caeSAndrea Arcangeli 	ret = range.len == uffdio_zeropage.range.len ? 0 : -EAGAIN;
1826ad465caeSAndrea Arcangeli out:
1827ad465caeSAndrea Arcangeli 	return ret;
1828ad465caeSAndrea Arcangeli }
1829ad465caeSAndrea Arcangeli 
183063b2d417SAndrea Arcangeli static int userfaultfd_writeprotect(struct userfaultfd_ctx *ctx,
183163b2d417SAndrea Arcangeli 				    unsigned long arg)
183263b2d417SAndrea Arcangeli {
183363b2d417SAndrea Arcangeli 	int ret;
183463b2d417SAndrea Arcangeli 	struct uffdio_writeprotect uffdio_wp;
183563b2d417SAndrea Arcangeli 	struct uffdio_writeprotect __user *user_uffdio_wp;
183663b2d417SAndrea Arcangeli 	struct userfaultfd_wake_range range;
183723080e27SPeter Xu 	bool mode_wp, mode_dontwake;
183863b2d417SAndrea Arcangeli 
1839a759a909SNadav Amit 	if (atomic_read(&ctx->mmap_changing))
184063b2d417SAndrea Arcangeli 		return -EAGAIN;
184163b2d417SAndrea Arcangeli 
184263b2d417SAndrea Arcangeli 	user_uffdio_wp = (struct uffdio_writeprotect __user *) arg;
184363b2d417SAndrea Arcangeli 
184463b2d417SAndrea Arcangeli 	if (copy_from_user(&uffdio_wp, user_uffdio_wp,
184563b2d417SAndrea Arcangeli 			   sizeof(struct uffdio_writeprotect)))
184663b2d417SAndrea Arcangeli 		return -EFAULT;
184763b2d417SAndrea Arcangeli 
1848e71e2aceSPeter Collingbourne 	ret = validate_range(ctx->mm, uffdio_wp.range.start,
184963b2d417SAndrea Arcangeli 			     uffdio_wp.range.len);
185063b2d417SAndrea Arcangeli 	if (ret)
185163b2d417SAndrea Arcangeli 		return ret;
185263b2d417SAndrea Arcangeli 
185363b2d417SAndrea Arcangeli 	if (uffdio_wp.mode & ~(UFFDIO_WRITEPROTECT_MODE_DONTWAKE |
185463b2d417SAndrea Arcangeli 			       UFFDIO_WRITEPROTECT_MODE_WP))
185563b2d417SAndrea Arcangeli 		return -EINVAL;
185623080e27SPeter Xu 
185723080e27SPeter Xu 	mode_wp = uffdio_wp.mode & UFFDIO_WRITEPROTECT_MODE_WP;
185823080e27SPeter Xu 	mode_dontwake = uffdio_wp.mode & UFFDIO_WRITEPROTECT_MODE_DONTWAKE;
185923080e27SPeter Xu 
186023080e27SPeter Xu 	if (mode_wp && mode_dontwake)
186163b2d417SAndrea Arcangeli 		return -EINVAL;
186263b2d417SAndrea Arcangeli 
1863cb185d5fSNadav Amit 	if (mmget_not_zero(ctx->mm)) {
186463b2d417SAndrea Arcangeli 		ret = mwriteprotect_range(ctx->mm, uffdio_wp.range.start,
186523080e27SPeter Xu 					  uffdio_wp.range.len, mode_wp,
186663b2d417SAndrea Arcangeli 					  &ctx->mmap_changing);
1867cb185d5fSNadav Amit 		mmput(ctx->mm);
1868cb185d5fSNadav Amit 	} else {
1869cb185d5fSNadav Amit 		return -ESRCH;
1870cb185d5fSNadav Amit 	}
1871cb185d5fSNadav Amit 
187263b2d417SAndrea Arcangeli 	if (ret)
187363b2d417SAndrea Arcangeli 		return ret;
187463b2d417SAndrea Arcangeli 
187523080e27SPeter Xu 	if (!mode_wp && !mode_dontwake) {
187663b2d417SAndrea Arcangeli 		range.start = uffdio_wp.range.start;
187763b2d417SAndrea Arcangeli 		range.len = uffdio_wp.range.len;
187863b2d417SAndrea Arcangeli 		wake_userfault(ctx, &range);
187963b2d417SAndrea Arcangeli 	}
188063b2d417SAndrea Arcangeli 	return ret;
188163b2d417SAndrea Arcangeli }
188263b2d417SAndrea Arcangeli 
1883f6191471SAxel Rasmussen static int userfaultfd_continue(struct userfaultfd_ctx *ctx, unsigned long arg)
1884f6191471SAxel Rasmussen {
1885f6191471SAxel Rasmussen 	__s64 ret;
1886f6191471SAxel Rasmussen 	struct uffdio_continue uffdio_continue;
1887f6191471SAxel Rasmussen 	struct uffdio_continue __user *user_uffdio_continue;
1888f6191471SAxel Rasmussen 	struct userfaultfd_wake_range range;
1889f6191471SAxel Rasmussen 
1890f6191471SAxel Rasmussen 	user_uffdio_continue = (struct uffdio_continue __user *)arg;
1891f6191471SAxel Rasmussen 
1892f6191471SAxel Rasmussen 	ret = -EAGAIN;
1893a759a909SNadav Amit 	if (atomic_read(&ctx->mmap_changing))
1894f6191471SAxel Rasmussen 		goto out;
1895f6191471SAxel Rasmussen 
1896f6191471SAxel Rasmussen 	ret = -EFAULT;
1897f6191471SAxel Rasmussen 	if (copy_from_user(&uffdio_continue, user_uffdio_continue,
1898f6191471SAxel Rasmussen 			   /* don't copy the output fields */
1899f6191471SAxel Rasmussen 			   sizeof(uffdio_continue) - (sizeof(__s64))))
1900f6191471SAxel Rasmussen 		goto out;
1901f6191471SAxel Rasmussen 
1902e71e2aceSPeter Collingbourne 	ret = validate_range(ctx->mm, uffdio_continue.range.start,
1903f6191471SAxel Rasmussen 			     uffdio_continue.range.len);
1904f6191471SAxel Rasmussen 	if (ret)
1905f6191471SAxel Rasmussen 		goto out;
1906f6191471SAxel Rasmussen 
1907f6191471SAxel Rasmussen 	ret = -EINVAL;
1908f6191471SAxel Rasmussen 	/* double check for wraparound just in case. */
1909f6191471SAxel Rasmussen 	if (uffdio_continue.range.start + uffdio_continue.range.len <=
1910f6191471SAxel Rasmussen 	    uffdio_continue.range.start) {
1911f6191471SAxel Rasmussen 		goto out;
1912f6191471SAxel Rasmussen 	}
1913f6191471SAxel Rasmussen 	if (uffdio_continue.mode & ~UFFDIO_CONTINUE_MODE_DONTWAKE)
1914f6191471SAxel Rasmussen 		goto out;
1915f6191471SAxel Rasmussen 
1916f6191471SAxel Rasmussen 	if (mmget_not_zero(ctx->mm)) {
1917f6191471SAxel Rasmussen 		ret = mcopy_continue(ctx->mm, uffdio_continue.range.start,
1918f6191471SAxel Rasmussen 				     uffdio_continue.range.len,
1919f6191471SAxel Rasmussen 				     &ctx->mmap_changing);
1920f6191471SAxel Rasmussen 		mmput(ctx->mm);
1921f6191471SAxel Rasmussen 	} else {
1922f6191471SAxel Rasmussen 		return -ESRCH;
1923f6191471SAxel Rasmussen 	}
1924f6191471SAxel Rasmussen 
1925f6191471SAxel Rasmussen 	if (unlikely(put_user(ret, &user_uffdio_continue->mapped)))
1926f6191471SAxel Rasmussen 		return -EFAULT;
1927f6191471SAxel Rasmussen 	if (ret < 0)
1928f6191471SAxel Rasmussen 		goto out;
1929f6191471SAxel Rasmussen 
1930f6191471SAxel Rasmussen 	/* len == 0 would wake all */
1931f6191471SAxel Rasmussen 	BUG_ON(!ret);
1932f6191471SAxel Rasmussen 	range.len = ret;
1933f6191471SAxel Rasmussen 	if (!(uffdio_continue.mode & UFFDIO_CONTINUE_MODE_DONTWAKE)) {
1934f6191471SAxel Rasmussen 		range.start = uffdio_continue.range.start;
1935f6191471SAxel Rasmussen 		wake_userfault(ctx, &range);
1936f6191471SAxel Rasmussen 	}
1937f6191471SAxel Rasmussen 	ret = range.len == uffdio_continue.range.len ? 0 : -EAGAIN;
1938f6191471SAxel Rasmussen 
1939f6191471SAxel Rasmussen out:
1940f6191471SAxel Rasmussen 	return ret;
1941f6191471SAxel Rasmussen }
1942f6191471SAxel Rasmussen 
19439cd75c3cSPavel Emelyanov static inline unsigned int uffd_ctx_features(__u64 user_features)
19449cd75c3cSPavel Emelyanov {
19459cd75c3cSPavel Emelyanov 	/*
194622e5fe2aSNadav Amit 	 * For the current set of features the bits just coincide. Set
194722e5fe2aSNadav Amit 	 * UFFD_FEATURE_INITIALIZED to mark the features as enabled.
19489cd75c3cSPavel Emelyanov 	 */
194922e5fe2aSNadav Amit 	return (unsigned int)user_features | UFFD_FEATURE_INITIALIZED;
19509cd75c3cSPavel Emelyanov }
19519cd75c3cSPavel Emelyanov 
195286039bd3SAndrea Arcangeli /*
195386039bd3SAndrea Arcangeli  * userland asks for a certain API version and we return which bits
195486039bd3SAndrea Arcangeli  * and ioctl commands are implemented in this kernel for such API
195586039bd3SAndrea Arcangeli  * version or -EINVAL if unknown.
195686039bd3SAndrea Arcangeli  */
195786039bd3SAndrea Arcangeli static int userfaultfd_api(struct userfaultfd_ctx *ctx,
195886039bd3SAndrea Arcangeli 			   unsigned long arg)
195986039bd3SAndrea Arcangeli {
196086039bd3SAndrea Arcangeli 	struct uffdio_api uffdio_api;
196186039bd3SAndrea Arcangeli 	void __user *buf = (void __user *)arg;
196222e5fe2aSNadav Amit 	unsigned int ctx_features;
196386039bd3SAndrea Arcangeli 	int ret;
196465603144SAndrea Arcangeli 	__u64 features;
196586039bd3SAndrea Arcangeli 
196686039bd3SAndrea Arcangeli 	ret = -EFAULT;
1967a9b85f94SAndrea Arcangeli 	if (copy_from_user(&uffdio_api, buf, sizeof(uffdio_api)))
196886039bd3SAndrea Arcangeli 		goto out;
1969914eedcbSAxel Rasmussen 	/* Ignore unsupported features (userspace built against newer kernel) */
1970914eedcbSAxel Rasmussen 	features = uffdio_api.features & UFFD_API_FEATURES;
19713c1c24d9SMike Rapoport 	ret = -EPERM;
19723c1c24d9SMike Rapoport 	if ((features & UFFD_FEATURE_EVENT_FORK) && !capable(CAP_SYS_PTRACE))
19733c1c24d9SMike Rapoport 		goto err_out;
197465603144SAndrea Arcangeli 	/* report all available features and ioctls to userland */
197565603144SAndrea Arcangeli 	uffdio_api.features = UFFD_API_FEATURES;
19767677f7fdSAxel Rasmussen #ifndef CONFIG_HAVE_ARCH_USERFAULTFD_MINOR
1977964ab004SAxel Rasmussen 	uffdio_api.features &=
1978964ab004SAxel Rasmussen 		~(UFFD_FEATURE_MINOR_HUGETLBFS | UFFD_FEATURE_MINOR_SHMEM);
19797677f7fdSAxel Rasmussen #endif
198000b151f2SPeter Xu #ifndef CONFIG_HAVE_ARCH_USERFAULTFD_WP
198100b151f2SPeter Xu 	uffdio_api.features &= ~UFFD_FEATURE_PAGEFAULT_FLAG_WP;
198286039bd3SAndrea Arcangeli #endif
1983b1f9e876SPeter Xu #ifndef CONFIG_PTE_MARKER_UFFD_WP
1984b1f9e876SPeter Xu 	uffdio_api.features &= ~UFFD_FEATURE_WP_HUGETLBFS_SHMEM;
1985b1f9e876SPeter Xu #endif
198686039bd3SAndrea Arcangeli 	uffdio_api.ioctls = UFFD_API_IOCTLS;
198786039bd3SAndrea Arcangeli 	ret = -EFAULT;
198886039bd3SAndrea Arcangeli 	if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
198986039bd3SAndrea Arcangeli 		goto out;
199022e5fe2aSNadav Amit 
199186039bd3SAndrea Arcangeli 	/* only enable the requested features for this uffd context */
199222e5fe2aSNadav Amit 	ctx_features = uffd_ctx_features(features);
199322e5fe2aSNadav Amit 	ret = -EINVAL;
199422e5fe2aSNadav Amit 	if (cmpxchg(&ctx->features, 0, ctx_features) != 0)
199522e5fe2aSNadav Amit 		goto err_out;
199622e5fe2aSNadav Amit 
199786039bd3SAndrea Arcangeli 	ret = 0;
199886039bd3SAndrea Arcangeli out:
199986039bd3SAndrea Arcangeli 	return ret;
200086039bd3SAndrea Arcangeli err_out:
200186039bd3SAndrea Arcangeli 	memset(&uffdio_api, 0, sizeof(uffdio_api));
200286039bd3SAndrea Arcangeli 	if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
200386039bd3SAndrea Arcangeli 		ret = -EFAULT;
200486039bd3SAndrea Arcangeli 	goto out;
200586039bd3SAndrea Arcangeli }
200686039bd3SAndrea Arcangeli 
200786039bd3SAndrea Arcangeli static long userfaultfd_ioctl(struct file *file, unsigned cmd,
2008e6485a47SAndrea Arcangeli 			      unsigned long arg)
2009e6485a47SAndrea Arcangeli {
2010e6485a47SAndrea Arcangeli 	int ret = -EINVAL;
201186039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
201286039bd3SAndrea Arcangeli 
201322e5fe2aSNadav Amit 	if (cmd != UFFDIO_API && !userfaultfd_is_initialized(ctx))
201486039bd3SAndrea Arcangeli 		return -EINVAL;
201586039bd3SAndrea Arcangeli 
201686039bd3SAndrea Arcangeli 	switch(cmd) {
201786039bd3SAndrea Arcangeli 	case UFFDIO_API:
201886039bd3SAndrea Arcangeli 		ret = userfaultfd_api(ctx, arg);
201986039bd3SAndrea Arcangeli 		break;
202086039bd3SAndrea Arcangeli 	case UFFDIO_REGISTER:
202186039bd3SAndrea Arcangeli 		ret = userfaultfd_register(ctx, arg);
202286039bd3SAndrea Arcangeli 		break;
202386039bd3SAndrea Arcangeli 	case UFFDIO_UNREGISTER:
202486039bd3SAndrea Arcangeli 		ret = userfaultfd_unregister(ctx, arg);
202586039bd3SAndrea Arcangeli 		break;
202686039bd3SAndrea Arcangeli 	case UFFDIO_WAKE:
2027ad465caeSAndrea Arcangeli 		ret = userfaultfd_wake(ctx, arg);
2028ad465caeSAndrea Arcangeli 		break;
2029ad465caeSAndrea Arcangeli 	case UFFDIO_COPY:
2030ad465caeSAndrea Arcangeli 		ret = userfaultfd_copy(ctx, arg);
2031ad465caeSAndrea Arcangeli 		break;
2032ad465caeSAndrea Arcangeli 	case UFFDIO_ZEROPAGE:
203386039bd3SAndrea Arcangeli 		ret = userfaultfd_zeropage(ctx, arg);
203486039bd3SAndrea Arcangeli 		break;
203563b2d417SAndrea Arcangeli 	case UFFDIO_WRITEPROTECT:
203663b2d417SAndrea Arcangeli 		ret = userfaultfd_writeprotect(ctx, arg);
203763b2d417SAndrea Arcangeli 		break;
2038f6191471SAxel Rasmussen 	case UFFDIO_CONTINUE:
2039f6191471SAxel Rasmussen 		ret = userfaultfd_continue(ctx, arg);
2040f6191471SAxel Rasmussen 		break;
204186039bd3SAndrea Arcangeli 	}
204286039bd3SAndrea Arcangeli 	return ret;
204386039bd3SAndrea Arcangeli }
204486039bd3SAndrea Arcangeli 
204586039bd3SAndrea Arcangeli #ifdef CONFIG_PROC_FS
204686039bd3SAndrea Arcangeli static void userfaultfd_show_fdinfo(struct seq_file *m, struct file *f)
204786039bd3SAndrea Arcangeli {
204886039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = f->private_data;
2049ac6424b9SIngo Molnar 	wait_queue_entry_t *wq;
205086039bd3SAndrea Arcangeli 	unsigned long pending = 0, total = 0;
205186039bd3SAndrea Arcangeli 
2052cbcfa130SEric Biggers 	spin_lock_irq(&ctx->fault_pending_wqh.lock);
20532055da97SIngo Molnar 	list_for_each_entry(wq, &ctx->fault_pending_wqh.head, entry) {
205486039bd3SAndrea Arcangeli 		pending++;
205586039bd3SAndrea Arcangeli 		total++;
205686039bd3SAndrea Arcangeli 	}
20572055da97SIngo Molnar 	list_for_each_entry(wq, &ctx->fault_wqh.head, entry) {
205815b726efSAndrea Arcangeli 		total++;
205915b726efSAndrea Arcangeli 	}
2060cbcfa130SEric Biggers 	spin_unlock_irq(&ctx->fault_pending_wqh.lock);
206186039bd3SAndrea Arcangeli 
206286039bd3SAndrea Arcangeli 	/*
206386039bd3SAndrea Arcangeli 	 * If more protocols will be added, there will be all shown
206486039bd3SAndrea Arcangeli 	 * separated by a space. Like this:
206586039bd3SAndrea Arcangeli 	 *	protocols: aa:... bb:...
206686039bd3SAndrea Arcangeli 	 */
206786039bd3SAndrea Arcangeli 	seq_printf(m, "pending:\t%lu\ntotal:\t%lu\nAPI:\t%Lx:%x:%Lx\n",
2068045098e9SMike Rapoport 		   pending, total, UFFD_API, ctx->features,
206986039bd3SAndrea Arcangeli 		   UFFD_API_IOCTLS|UFFD_API_RANGE_IOCTLS);
207086039bd3SAndrea Arcangeli }
207186039bd3SAndrea Arcangeli #endif
207286039bd3SAndrea Arcangeli 
207386039bd3SAndrea Arcangeli static const struct file_operations userfaultfd_fops = {
207486039bd3SAndrea Arcangeli #ifdef CONFIG_PROC_FS
207586039bd3SAndrea Arcangeli 	.show_fdinfo	= userfaultfd_show_fdinfo,
207686039bd3SAndrea Arcangeli #endif
207786039bd3SAndrea Arcangeli 	.release	= userfaultfd_release,
207886039bd3SAndrea Arcangeli 	.poll		= userfaultfd_poll,
207986039bd3SAndrea Arcangeli 	.read		= userfaultfd_read,
208086039bd3SAndrea Arcangeli 	.unlocked_ioctl = userfaultfd_ioctl,
20811832f2d8SArnd Bergmann 	.compat_ioctl	= compat_ptr_ioctl,
208286039bd3SAndrea Arcangeli 	.llseek		= noop_llseek,
208386039bd3SAndrea Arcangeli };
208486039bd3SAndrea Arcangeli 
20853004ec9cSAndrea Arcangeli static void init_once_userfaultfd_ctx(void *mem)
20863004ec9cSAndrea Arcangeli {
20873004ec9cSAndrea Arcangeli 	struct userfaultfd_ctx *ctx = (struct userfaultfd_ctx *) mem;
20883004ec9cSAndrea Arcangeli 
20893004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fault_pending_wqh);
20903004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fault_wqh);
20919cd75c3cSPavel Emelyanov 	init_waitqueue_head(&ctx->event_wqh);
20923004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fd_wqh);
20932ca97ac8SAhmed S. Darwish 	seqcount_spinlock_init(&ctx->refile_seq, &ctx->fault_pending_wqh.lock);
20943004ec9cSAndrea Arcangeli }
20953004ec9cSAndrea Arcangeli 
20962d5de004SAxel Rasmussen static int new_userfaultfd(int flags)
209786039bd3SAndrea Arcangeli {
209886039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
2099284cd241SEric Biggers 	int fd;
210086039bd3SAndrea Arcangeli 
210186039bd3SAndrea Arcangeli 	BUG_ON(!current->mm);
210286039bd3SAndrea Arcangeli 
210386039bd3SAndrea Arcangeli 	/* Check the UFFD_* constants for consistency.  */
210437cd0575SLokesh Gidra 	BUILD_BUG_ON(UFFD_USER_MODE_ONLY & UFFD_SHARED_FCNTL_FLAGS);
210586039bd3SAndrea Arcangeli 	BUILD_BUG_ON(UFFD_CLOEXEC != O_CLOEXEC);
210686039bd3SAndrea Arcangeli 	BUILD_BUG_ON(UFFD_NONBLOCK != O_NONBLOCK);
210786039bd3SAndrea Arcangeli 
210837cd0575SLokesh Gidra 	if (flags & ~(UFFD_SHARED_FCNTL_FLAGS | UFFD_USER_MODE_ONLY))
2109284cd241SEric Biggers 		return -EINVAL;
211086039bd3SAndrea Arcangeli 
21113004ec9cSAndrea Arcangeli 	ctx = kmem_cache_alloc(userfaultfd_ctx_cachep, GFP_KERNEL);
211286039bd3SAndrea Arcangeli 	if (!ctx)
2113284cd241SEric Biggers 		return -ENOMEM;
211486039bd3SAndrea Arcangeli 
2115ca880420SEric Biggers 	refcount_set(&ctx->refcount, 1);
211686039bd3SAndrea Arcangeli 	ctx->flags = flags;
21179cd75c3cSPavel Emelyanov 	ctx->features = 0;
211886039bd3SAndrea Arcangeli 	ctx->released = false;
2119a759a909SNadav Amit 	atomic_set(&ctx->mmap_changing, 0);
212086039bd3SAndrea Arcangeli 	ctx->mm = current->mm;
212186039bd3SAndrea Arcangeli 	/* prevent the mm struct to be freed */
2122f1f10076SVegard Nossum 	mmgrab(ctx->mm);
212386039bd3SAndrea Arcangeli 
2124b537900fSDaniel Colascione 	fd = anon_inode_getfd_secure("[userfaultfd]", &userfaultfd_fops, ctx,
2125abec3d01SOndrej Mosnacek 			O_RDONLY | (flags & UFFD_SHARED_FCNTL_FLAGS), NULL);
2126284cd241SEric Biggers 	if (fd < 0) {
2127d2005e3fSOleg Nesterov 		mmdrop(ctx->mm);
21283004ec9cSAndrea Arcangeli 		kmem_cache_free(userfaultfd_ctx_cachep, ctx);
2129c03e946fSEric Biggers 	}
213086039bd3SAndrea Arcangeli 	return fd;
213186039bd3SAndrea Arcangeli }
21323004ec9cSAndrea Arcangeli 
21332d5de004SAxel Rasmussen static inline bool userfaultfd_syscall_allowed(int flags)
21342d5de004SAxel Rasmussen {
21352d5de004SAxel Rasmussen 	/* Userspace-only page faults are always allowed */
21362d5de004SAxel Rasmussen 	if (flags & UFFD_USER_MODE_ONLY)
21372d5de004SAxel Rasmussen 		return true;
21382d5de004SAxel Rasmussen 
21392d5de004SAxel Rasmussen 	/*
21402d5de004SAxel Rasmussen 	 * The user is requesting a userfaultfd which can handle kernel faults.
21412d5de004SAxel Rasmussen 	 * Privileged users are always allowed to do this.
21422d5de004SAxel Rasmussen 	 */
21432d5de004SAxel Rasmussen 	if (capable(CAP_SYS_PTRACE))
21442d5de004SAxel Rasmussen 		return true;
21452d5de004SAxel Rasmussen 
21462d5de004SAxel Rasmussen 	/* Otherwise, access to kernel fault handling is sysctl controlled. */
21472d5de004SAxel Rasmussen 	return sysctl_unprivileged_userfaultfd;
21482d5de004SAxel Rasmussen }
21492d5de004SAxel Rasmussen 
21502d5de004SAxel Rasmussen SYSCALL_DEFINE1(userfaultfd, int, flags)
21512d5de004SAxel Rasmussen {
21522d5de004SAxel Rasmussen 	if (!userfaultfd_syscall_allowed(flags))
21532d5de004SAxel Rasmussen 		return -EPERM;
21542d5de004SAxel Rasmussen 
21552d5de004SAxel Rasmussen 	return new_userfaultfd(flags);
21562d5de004SAxel Rasmussen }
21572d5de004SAxel Rasmussen 
21582d5de004SAxel Rasmussen static long userfaultfd_dev_ioctl(struct file *file, unsigned int cmd, unsigned long flags)
21592d5de004SAxel Rasmussen {
21602d5de004SAxel Rasmussen 	if (cmd != USERFAULTFD_IOC_NEW)
21612d5de004SAxel Rasmussen 		return -EINVAL;
21622d5de004SAxel Rasmussen 
21632d5de004SAxel Rasmussen 	return new_userfaultfd(flags);
21642d5de004SAxel Rasmussen }
21652d5de004SAxel Rasmussen 
21662d5de004SAxel Rasmussen static const struct file_operations userfaultfd_dev_fops = {
21672d5de004SAxel Rasmussen 	.unlocked_ioctl = userfaultfd_dev_ioctl,
21682d5de004SAxel Rasmussen 	.compat_ioctl = userfaultfd_dev_ioctl,
21692d5de004SAxel Rasmussen 	.owner = THIS_MODULE,
21702d5de004SAxel Rasmussen 	.llseek = noop_llseek,
21712d5de004SAxel Rasmussen };
21722d5de004SAxel Rasmussen 
21732d5de004SAxel Rasmussen static struct miscdevice userfaultfd_misc = {
21742d5de004SAxel Rasmussen 	.minor = MISC_DYNAMIC_MINOR,
21752d5de004SAxel Rasmussen 	.name = "userfaultfd",
21762d5de004SAxel Rasmussen 	.fops = &userfaultfd_dev_fops
21772d5de004SAxel Rasmussen };
21782d5de004SAxel Rasmussen 
21793004ec9cSAndrea Arcangeli static int __init userfaultfd_init(void)
21803004ec9cSAndrea Arcangeli {
21812d5de004SAxel Rasmussen 	int ret;
21822d5de004SAxel Rasmussen 
21832d5de004SAxel Rasmussen 	ret = misc_register(&userfaultfd_misc);
21842d5de004SAxel Rasmussen 	if (ret)
21852d5de004SAxel Rasmussen 		return ret;
21862d5de004SAxel Rasmussen 
21873004ec9cSAndrea Arcangeli 	userfaultfd_ctx_cachep = kmem_cache_create("userfaultfd_ctx_cache",
21883004ec9cSAndrea Arcangeli 						sizeof(struct userfaultfd_ctx),
21893004ec9cSAndrea Arcangeli 						0,
21903004ec9cSAndrea Arcangeli 						SLAB_HWCACHE_ALIGN|SLAB_PANIC,
21913004ec9cSAndrea Arcangeli 						init_once_userfaultfd_ctx);
21923004ec9cSAndrea Arcangeli 	return 0;
21933004ec9cSAndrea Arcangeli }
21943004ec9cSAndrea Arcangeli __initcall(userfaultfd_init);
2195