xref: /openbmc/linux/fs/userfaultfd.c (revision 656031445d5a855e1c13b291dedae32579d0f3f2)
186039bd3SAndrea Arcangeli /*
286039bd3SAndrea Arcangeli  *  fs/userfaultfd.c
386039bd3SAndrea Arcangeli  *
486039bd3SAndrea Arcangeli  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
586039bd3SAndrea Arcangeli  *  Copyright (C) 2008-2009 Red Hat, Inc.
686039bd3SAndrea Arcangeli  *  Copyright (C) 2015  Red Hat, Inc.
786039bd3SAndrea Arcangeli  *
886039bd3SAndrea Arcangeli  *  This work is licensed under the terms of the GNU GPL, version 2. See
986039bd3SAndrea Arcangeli  *  the COPYING file in the top-level directory.
1086039bd3SAndrea Arcangeli  *
1186039bd3SAndrea Arcangeli  *  Some part derived from fs/eventfd.c (anon inode setup) and
1286039bd3SAndrea Arcangeli  *  mm/ksm.c (mm hashing).
1386039bd3SAndrea Arcangeli  */
1486039bd3SAndrea Arcangeli 
159cd75c3cSPavel Emelyanov #include <linux/list.h>
1686039bd3SAndrea Arcangeli #include <linux/hashtable.h>
1786039bd3SAndrea Arcangeli #include <linux/sched.h>
1886039bd3SAndrea Arcangeli #include <linux/mm.h>
1986039bd3SAndrea Arcangeli #include <linux/poll.h>
2086039bd3SAndrea Arcangeli #include <linux/slab.h>
2186039bd3SAndrea Arcangeli #include <linux/seq_file.h>
2286039bd3SAndrea Arcangeli #include <linux/file.h>
2386039bd3SAndrea Arcangeli #include <linux/bug.h>
2486039bd3SAndrea Arcangeli #include <linux/anon_inodes.h>
2586039bd3SAndrea Arcangeli #include <linux/syscalls.h>
2686039bd3SAndrea Arcangeli #include <linux/userfaultfd_k.h>
2786039bd3SAndrea Arcangeli #include <linux/mempolicy.h>
2886039bd3SAndrea Arcangeli #include <linux/ioctl.h>
2986039bd3SAndrea Arcangeli #include <linux/security.h>
3086039bd3SAndrea Arcangeli 
313004ec9cSAndrea Arcangeli static struct kmem_cache *userfaultfd_ctx_cachep __read_mostly;
323004ec9cSAndrea Arcangeli 
3386039bd3SAndrea Arcangeli enum userfaultfd_state {
3486039bd3SAndrea Arcangeli 	UFFD_STATE_WAIT_API,
3586039bd3SAndrea Arcangeli 	UFFD_STATE_RUNNING,
3686039bd3SAndrea Arcangeli };
3786039bd3SAndrea Arcangeli 
383004ec9cSAndrea Arcangeli /*
393004ec9cSAndrea Arcangeli  * Start with fault_pending_wqh and fault_wqh so they're more likely
403004ec9cSAndrea Arcangeli  * to be in the same cacheline.
413004ec9cSAndrea Arcangeli  */
4286039bd3SAndrea Arcangeli struct userfaultfd_ctx {
4315b726efSAndrea Arcangeli 	/* waitqueue head for the pending (i.e. not read) userfaults */
4415b726efSAndrea Arcangeli 	wait_queue_head_t fault_pending_wqh;
4515b726efSAndrea Arcangeli 	/* waitqueue head for the userfaults */
4686039bd3SAndrea Arcangeli 	wait_queue_head_t fault_wqh;
4786039bd3SAndrea Arcangeli 	/* waitqueue head for the pseudo fd to wakeup poll/read */
4886039bd3SAndrea Arcangeli 	wait_queue_head_t fd_wqh;
499cd75c3cSPavel Emelyanov 	/* waitqueue head for events */
509cd75c3cSPavel Emelyanov 	wait_queue_head_t event_wqh;
512c5b7e1bSAndrea Arcangeli 	/* a refile sequence protected by fault_pending_wqh lock */
522c5b7e1bSAndrea Arcangeli 	struct seqcount refile_seq;
533004ec9cSAndrea Arcangeli 	/* pseudo fd refcounting */
543004ec9cSAndrea Arcangeli 	atomic_t refcount;
5586039bd3SAndrea Arcangeli 	/* userfaultfd syscall flags */
5686039bd3SAndrea Arcangeli 	unsigned int flags;
579cd75c3cSPavel Emelyanov 	/* features requested from the userspace */
589cd75c3cSPavel Emelyanov 	unsigned int features;
5986039bd3SAndrea Arcangeli 	/* state machine */
6086039bd3SAndrea Arcangeli 	enum userfaultfd_state state;
6186039bd3SAndrea Arcangeli 	/* released */
6286039bd3SAndrea Arcangeli 	bool released;
6386039bd3SAndrea Arcangeli 	/* mm with one ore more vmas attached to this userfaultfd_ctx */
6486039bd3SAndrea Arcangeli 	struct mm_struct *mm;
6586039bd3SAndrea Arcangeli };
6686039bd3SAndrea Arcangeli 
6786039bd3SAndrea Arcangeli struct userfaultfd_wait_queue {
68a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
6986039bd3SAndrea Arcangeli 	wait_queue_t wq;
7086039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
7115a77c6fSAndrea Arcangeli 	bool waken;
7286039bd3SAndrea Arcangeli };
7386039bd3SAndrea Arcangeli 
7486039bd3SAndrea Arcangeli struct userfaultfd_wake_range {
7586039bd3SAndrea Arcangeli 	unsigned long start;
7686039bd3SAndrea Arcangeli 	unsigned long len;
7786039bd3SAndrea Arcangeli };
7886039bd3SAndrea Arcangeli 
7986039bd3SAndrea Arcangeli static int userfaultfd_wake_function(wait_queue_t *wq, unsigned mode,
8086039bd3SAndrea Arcangeli 				     int wake_flags, void *key)
8186039bd3SAndrea Arcangeli {
8286039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range *range = key;
8386039bd3SAndrea Arcangeli 	int ret;
8486039bd3SAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
8586039bd3SAndrea Arcangeli 	unsigned long start, len;
8686039bd3SAndrea Arcangeli 
8786039bd3SAndrea Arcangeli 	uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
8886039bd3SAndrea Arcangeli 	ret = 0;
8986039bd3SAndrea Arcangeli 	/* len == 0 means wake all */
9086039bd3SAndrea Arcangeli 	start = range->start;
9186039bd3SAndrea Arcangeli 	len = range->len;
92a9b85f94SAndrea Arcangeli 	if (len && (start > uwq->msg.arg.pagefault.address ||
93a9b85f94SAndrea Arcangeli 		    start + len <= uwq->msg.arg.pagefault.address))
9486039bd3SAndrea Arcangeli 		goto out;
9515a77c6fSAndrea Arcangeli 	WRITE_ONCE(uwq->waken, true);
9615a77c6fSAndrea Arcangeli 	/*
9715a77c6fSAndrea Arcangeli 	 * The implicit smp_mb__before_spinlock in try_to_wake_up()
9815a77c6fSAndrea Arcangeli 	 * renders uwq->waken visible to other CPUs before the task is
9915a77c6fSAndrea Arcangeli 	 * waken.
10015a77c6fSAndrea Arcangeli 	 */
10186039bd3SAndrea Arcangeli 	ret = wake_up_state(wq->private, mode);
10286039bd3SAndrea Arcangeli 	if (ret)
10386039bd3SAndrea Arcangeli 		/*
10486039bd3SAndrea Arcangeli 		 * Wake only once, autoremove behavior.
10586039bd3SAndrea Arcangeli 		 *
10686039bd3SAndrea Arcangeli 		 * After the effect of list_del_init is visible to the
10786039bd3SAndrea Arcangeli 		 * other CPUs, the waitqueue may disappear from under
10886039bd3SAndrea Arcangeli 		 * us, see the !list_empty_careful() in
10986039bd3SAndrea Arcangeli 		 * handle_userfault(). try_to_wake_up() has an
11086039bd3SAndrea Arcangeli 		 * implicit smp_mb__before_spinlock, and the
11186039bd3SAndrea Arcangeli 		 * wq->private is read before calling the extern
11286039bd3SAndrea Arcangeli 		 * function "wake_up_state" (which in turns calls
11386039bd3SAndrea Arcangeli 		 * try_to_wake_up). While the spin_lock;spin_unlock;
11486039bd3SAndrea Arcangeli 		 * wouldn't be enough, the smp_mb__before_spinlock is
11586039bd3SAndrea Arcangeli 		 * enough to avoid an explicit smp_mb() here.
11686039bd3SAndrea Arcangeli 		 */
11786039bd3SAndrea Arcangeli 		list_del_init(&wq->task_list);
11886039bd3SAndrea Arcangeli out:
11986039bd3SAndrea Arcangeli 	return ret;
12086039bd3SAndrea Arcangeli }
12186039bd3SAndrea Arcangeli 
12286039bd3SAndrea Arcangeli /**
12386039bd3SAndrea Arcangeli  * userfaultfd_ctx_get - Acquires a reference to the internal userfaultfd
12486039bd3SAndrea Arcangeli  * context.
12586039bd3SAndrea Arcangeli  * @ctx: [in] Pointer to the userfaultfd context.
12686039bd3SAndrea Arcangeli  *
12786039bd3SAndrea Arcangeli  * Returns: In case of success, returns not zero.
12886039bd3SAndrea Arcangeli  */
12986039bd3SAndrea Arcangeli static void userfaultfd_ctx_get(struct userfaultfd_ctx *ctx)
13086039bd3SAndrea Arcangeli {
13186039bd3SAndrea Arcangeli 	if (!atomic_inc_not_zero(&ctx->refcount))
13286039bd3SAndrea Arcangeli 		BUG();
13386039bd3SAndrea Arcangeli }
13486039bd3SAndrea Arcangeli 
13586039bd3SAndrea Arcangeli /**
13686039bd3SAndrea Arcangeli  * userfaultfd_ctx_put - Releases a reference to the internal userfaultfd
13786039bd3SAndrea Arcangeli  * context.
13886039bd3SAndrea Arcangeli  * @ctx: [in] Pointer to userfaultfd context.
13986039bd3SAndrea Arcangeli  *
14086039bd3SAndrea Arcangeli  * The userfaultfd context reference must have been previously acquired either
14186039bd3SAndrea Arcangeli  * with userfaultfd_ctx_get() or userfaultfd_ctx_fdget().
14286039bd3SAndrea Arcangeli  */
14386039bd3SAndrea Arcangeli static void userfaultfd_ctx_put(struct userfaultfd_ctx *ctx)
14486039bd3SAndrea Arcangeli {
14586039bd3SAndrea Arcangeli 	if (atomic_dec_and_test(&ctx->refcount)) {
14686039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fault_pending_wqh.lock));
14786039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fault_pending_wqh));
14886039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fault_wqh.lock));
14986039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fault_wqh));
1509cd75c3cSPavel Emelyanov 		VM_BUG_ON(spin_is_locked(&ctx->event_wqh.lock));
1519cd75c3cSPavel Emelyanov 		VM_BUG_ON(waitqueue_active(&ctx->event_wqh));
15286039bd3SAndrea Arcangeli 		VM_BUG_ON(spin_is_locked(&ctx->fd_wqh.lock));
15386039bd3SAndrea Arcangeli 		VM_BUG_ON(waitqueue_active(&ctx->fd_wqh));
154d2005e3fSOleg Nesterov 		mmdrop(ctx->mm);
1553004ec9cSAndrea Arcangeli 		kmem_cache_free(userfaultfd_ctx_cachep, ctx);
15686039bd3SAndrea Arcangeli 	}
15786039bd3SAndrea Arcangeli }
15886039bd3SAndrea Arcangeli 
159a9b85f94SAndrea Arcangeli static inline void msg_init(struct uffd_msg *msg)
160a9b85f94SAndrea Arcangeli {
161a9b85f94SAndrea Arcangeli 	BUILD_BUG_ON(sizeof(struct uffd_msg) != 32);
162a9b85f94SAndrea Arcangeli 	/*
163a9b85f94SAndrea Arcangeli 	 * Must use memset to zero out the paddings or kernel data is
164a9b85f94SAndrea Arcangeli 	 * leaked to userland.
165a9b85f94SAndrea Arcangeli 	 */
166a9b85f94SAndrea Arcangeli 	memset(msg, 0, sizeof(struct uffd_msg));
167a9b85f94SAndrea Arcangeli }
168a9b85f94SAndrea Arcangeli 
169a9b85f94SAndrea Arcangeli static inline struct uffd_msg userfault_msg(unsigned long address,
17086039bd3SAndrea Arcangeli 					    unsigned int flags,
17186039bd3SAndrea Arcangeli 					    unsigned long reason)
17286039bd3SAndrea Arcangeli {
173a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
174a9b85f94SAndrea Arcangeli 	msg_init(&msg);
175a9b85f94SAndrea Arcangeli 	msg.event = UFFD_EVENT_PAGEFAULT;
176a9b85f94SAndrea Arcangeli 	msg.arg.pagefault.address = address;
17786039bd3SAndrea Arcangeli 	if (flags & FAULT_FLAG_WRITE)
17886039bd3SAndrea Arcangeli 		/*
179a4605a61SAndrea Arcangeli 		 * If UFFD_FEATURE_PAGEFAULT_FLAG_WP was set in the
180a9b85f94SAndrea Arcangeli 		 * uffdio_api.features and UFFD_PAGEFAULT_FLAG_WRITE
181a9b85f94SAndrea Arcangeli 		 * was not set in a UFFD_EVENT_PAGEFAULT, it means it
182a9b85f94SAndrea Arcangeli 		 * was a read fault, otherwise if set it means it's
183a9b85f94SAndrea Arcangeli 		 * a write fault.
18486039bd3SAndrea Arcangeli 		 */
185a9b85f94SAndrea Arcangeli 		msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WRITE;
18686039bd3SAndrea Arcangeli 	if (reason & VM_UFFD_WP)
18786039bd3SAndrea Arcangeli 		/*
188a9b85f94SAndrea Arcangeli 		 * If UFFD_FEATURE_PAGEFAULT_FLAG_WP was set in the
189a9b85f94SAndrea Arcangeli 		 * uffdio_api.features and UFFD_PAGEFAULT_FLAG_WP was
190a9b85f94SAndrea Arcangeli 		 * not set in a UFFD_EVENT_PAGEFAULT, it means it was
191a9b85f94SAndrea Arcangeli 		 * a missing fault, otherwise if set it means it's a
192a9b85f94SAndrea Arcangeli 		 * write protect fault.
19386039bd3SAndrea Arcangeli 		 */
194a9b85f94SAndrea Arcangeli 		msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WP;
195a9b85f94SAndrea Arcangeli 	return msg;
19686039bd3SAndrea Arcangeli }
19786039bd3SAndrea Arcangeli 
19886039bd3SAndrea Arcangeli /*
1998d2afd96SAndrea Arcangeli  * Verify the pagetables are still not ok after having reigstered into
2008d2afd96SAndrea Arcangeli  * the fault_pending_wqh to avoid userland having to UFFDIO_WAKE any
2018d2afd96SAndrea Arcangeli  * userfault that has already been resolved, if userfaultfd_read and
2028d2afd96SAndrea Arcangeli  * UFFDIO_COPY|ZEROPAGE are being run simultaneously on two different
2038d2afd96SAndrea Arcangeli  * threads.
2048d2afd96SAndrea Arcangeli  */
2058d2afd96SAndrea Arcangeli static inline bool userfaultfd_must_wait(struct userfaultfd_ctx *ctx,
2068d2afd96SAndrea Arcangeli 					 unsigned long address,
2078d2afd96SAndrea Arcangeli 					 unsigned long flags,
2088d2afd96SAndrea Arcangeli 					 unsigned long reason)
2098d2afd96SAndrea Arcangeli {
2108d2afd96SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
2118d2afd96SAndrea Arcangeli 	pgd_t *pgd;
2128d2afd96SAndrea Arcangeli 	pud_t *pud;
2138d2afd96SAndrea Arcangeli 	pmd_t *pmd, _pmd;
2148d2afd96SAndrea Arcangeli 	pte_t *pte;
2158d2afd96SAndrea Arcangeli 	bool ret = true;
2168d2afd96SAndrea Arcangeli 
2178d2afd96SAndrea Arcangeli 	VM_BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
2188d2afd96SAndrea Arcangeli 
2198d2afd96SAndrea Arcangeli 	pgd = pgd_offset(mm, address);
2208d2afd96SAndrea Arcangeli 	if (!pgd_present(*pgd))
2218d2afd96SAndrea Arcangeli 		goto out;
2228d2afd96SAndrea Arcangeli 	pud = pud_offset(pgd, address);
2238d2afd96SAndrea Arcangeli 	if (!pud_present(*pud))
2248d2afd96SAndrea Arcangeli 		goto out;
2258d2afd96SAndrea Arcangeli 	pmd = pmd_offset(pud, address);
2268d2afd96SAndrea Arcangeli 	/*
2278d2afd96SAndrea Arcangeli 	 * READ_ONCE must function as a barrier with narrower scope
2288d2afd96SAndrea Arcangeli 	 * and it must be equivalent to:
2298d2afd96SAndrea Arcangeli 	 *	_pmd = *pmd; barrier();
2308d2afd96SAndrea Arcangeli 	 *
2318d2afd96SAndrea Arcangeli 	 * This is to deal with the instability (as in
2328d2afd96SAndrea Arcangeli 	 * pmd_trans_unstable) of the pmd.
2338d2afd96SAndrea Arcangeli 	 */
2348d2afd96SAndrea Arcangeli 	_pmd = READ_ONCE(*pmd);
2358d2afd96SAndrea Arcangeli 	if (!pmd_present(_pmd))
2368d2afd96SAndrea Arcangeli 		goto out;
2378d2afd96SAndrea Arcangeli 
2388d2afd96SAndrea Arcangeli 	ret = false;
2398d2afd96SAndrea Arcangeli 	if (pmd_trans_huge(_pmd))
2408d2afd96SAndrea Arcangeli 		goto out;
2418d2afd96SAndrea Arcangeli 
2428d2afd96SAndrea Arcangeli 	/*
2438d2afd96SAndrea Arcangeli 	 * the pmd is stable (as in !pmd_trans_unstable) so we can re-read it
2448d2afd96SAndrea Arcangeli 	 * and use the standard pte_offset_map() instead of parsing _pmd.
2458d2afd96SAndrea Arcangeli 	 */
2468d2afd96SAndrea Arcangeli 	pte = pte_offset_map(pmd, address);
2478d2afd96SAndrea Arcangeli 	/*
2488d2afd96SAndrea Arcangeli 	 * Lockless access: we're in a wait_event so it's ok if it
2498d2afd96SAndrea Arcangeli 	 * changes under us.
2508d2afd96SAndrea Arcangeli 	 */
2518d2afd96SAndrea Arcangeli 	if (pte_none(*pte))
2528d2afd96SAndrea Arcangeli 		ret = true;
2538d2afd96SAndrea Arcangeli 	pte_unmap(pte);
2548d2afd96SAndrea Arcangeli 
2558d2afd96SAndrea Arcangeli out:
2568d2afd96SAndrea Arcangeli 	return ret;
2578d2afd96SAndrea Arcangeli }
2588d2afd96SAndrea Arcangeli 
2598d2afd96SAndrea Arcangeli /*
26086039bd3SAndrea Arcangeli  * The locking rules involved in returning VM_FAULT_RETRY depending on
26186039bd3SAndrea Arcangeli  * FAULT_FLAG_ALLOW_RETRY, FAULT_FLAG_RETRY_NOWAIT and
26286039bd3SAndrea Arcangeli  * FAULT_FLAG_KILLABLE are not straightforward. The "Caution"
26386039bd3SAndrea Arcangeli  * recommendation in __lock_page_or_retry is not an understatement.
26486039bd3SAndrea Arcangeli  *
26586039bd3SAndrea Arcangeli  * If FAULT_FLAG_ALLOW_RETRY is set, the mmap_sem must be released
26686039bd3SAndrea Arcangeli  * before returning VM_FAULT_RETRY only if FAULT_FLAG_RETRY_NOWAIT is
26786039bd3SAndrea Arcangeli  * not set.
26886039bd3SAndrea Arcangeli  *
26986039bd3SAndrea Arcangeli  * If FAULT_FLAG_ALLOW_RETRY is set but FAULT_FLAG_KILLABLE is not
27086039bd3SAndrea Arcangeli  * set, VM_FAULT_RETRY can still be returned if and only if there are
27186039bd3SAndrea Arcangeli  * fatal_signal_pending()s, and the mmap_sem must be released before
27286039bd3SAndrea Arcangeli  * returning it.
27386039bd3SAndrea Arcangeli  */
27482b0f8c3SJan Kara int handle_userfault(struct vm_fault *vmf, unsigned long reason)
27586039bd3SAndrea Arcangeli {
27682b0f8c3SJan Kara 	struct mm_struct *mm = vmf->vma->vm_mm;
27786039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
27886039bd3SAndrea Arcangeli 	struct userfaultfd_wait_queue uwq;
279ba85c702SAndrea Arcangeli 	int ret;
280dfa37dc3SAndrea Arcangeli 	bool must_wait, return_to_userland;
28115a77c6fSAndrea Arcangeli 	long blocking_state;
28286039bd3SAndrea Arcangeli 
28386039bd3SAndrea Arcangeli 	BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
28486039bd3SAndrea Arcangeli 
285ba85c702SAndrea Arcangeli 	ret = VM_FAULT_SIGBUS;
28682b0f8c3SJan Kara 	ctx = vmf->vma->vm_userfaultfd_ctx.ctx;
28786039bd3SAndrea Arcangeli 	if (!ctx)
288ba85c702SAndrea Arcangeli 		goto out;
28986039bd3SAndrea Arcangeli 
29086039bd3SAndrea Arcangeli 	BUG_ON(ctx->mm != mm);
29186039bd3SAndrea Arcangeli 
29286039bd3SAndrea Arcangeli 	VM_BUG_ON(reason & ~(VM_UFFD_MISSING|VM_UFFD_WP));
29386039bd3SAndrea Arcangeli 	VM_BUG_ON(!(reason & VM_UFFD_MISSING) ^ !!(reason & VM_UFFD_WP));
29486039bd3SAndrea Arcangeli 
29586039bd3SAndrea Arcangeli 	/*
29686039bd3SAndrea Arcangeli 	 * If it's already released don't get it. This avoids to loop
29786039bd3SAndrea Arcangeli 	 * in __get_user_pages if userfaultfd_release waits on the
29886039bd3SAndrea Arcangeli 	 * caller of handle_userfault to release the mmap_sem.
29986039bd3SAndrea Arcangeli 	 */
30086039bd3SAndrea Arcangeli 	if (unlikely(ACCESS_ONCE(ctx->released)))
301ba85c702SAndrea Arcangeli 		goto out;
30286039bd3SAndrea Arcangeli 
30386039bd3SAndrea Arcangeli 	/*
30439680f50SLinus Torvalds 	 * We don't do userfault handling for the final child pid update.
30539680f50SLinus Torvalds 	 */
30639680f50SLinus Torvalds 	if (current->flags & PF_EXITING)
30739680f50SLinus Torvalds 		goto out;
30839680f50SLinus Torvalds 
30939680f50SLinus Torvalds 	/*
31086039bd3SAndrea Arcangeli 	 * Check that we can return VM_FAULT_RETRY.
31186039bd3SAndrea Arcangeli 	 *
31286039bd3SAndrea Arcangeli 	 * NOTE: it should become possible to return VM_FAULT_RETRY
31386039bd3SAndrea Arcangeli 	 * even if FAULT_FLAG_TRIED is set without leading to gup()
31486039bd3SAndrea Arcangeli 	 * -EBUSY failures, if the userfaultfd is to be extended for
31586039bd3SAndrea Arcangeli 	 * VM_UFFD_WP tracking and we intend to arm the userfault
31686039bd3SAndrea Arcangeli 	 * without first stopping userland access to the memory. For
31786039bd3SAndrea Arcangeli 	 * VM_UFFD_MISSING userfaults this is enough for now.
31886039bd3SAndrea Arcangeli 	 */
31982b0f8c3SJan Kara 	if (unlikely(!(vmf->flags & FAULT_FLAG_ALLOW_RETRY))) {
32086039bd3SAndrea Arcangeli 		/*
32186039bd3SAndrea Arcangeli 		 * Validate the invariant that nowait must allow retry
32286039bd3SAndrea Arcangeli 		 * to be sure not to return SIGBUS erroneously on
32386039bd3SAndrea Arcangeli 		 * nowait invocations.
32486039bd3SAndrea Arcangeli 		 */
32582b0f8c3SJan Kara 		BUG_ON(vmf->flags & FAULT_FLAG_RETRY_NOWAIT);
32686039bd3SAndrea Arcangeli #ifdef CONFIG_DEBUG_VM
32786039bd3SAndrea Arcangeli 		if (printk_ratelimit()) {
32886039bd3SAndrea Arcangeli 			printk(KERN_WARNING
32982b0f8c3SJan Kara 			       "FAULT_FLAG_ALLOW_RETRY missing %x\n",
33082b0f8c3SJan Kara 			       vmf->flags);
33186039bd3SAndrea Arcangeli 			dump_stack();
33286039bd3SAndrea Arcangeli 		}
33386039bd3SAndrea Arcangeli #endif
334ba85c702SAndrea Arcangeli 		goto out;
33586039bd3SAndrea Arcangeli 	}
33686039bd3SAndrea Arcangeli 
33786039bd3SAndrea Arcangeli 	/*
33886039bd3SAndrea Arcangeli 	 * Handle nowait, not much to do other than tell it to retry
33986039bd3SAndrea Arcangeli 	 * and wait.
34086039bd3SAndrea Arcangeli 	 */
341ba85c702SAndrea Arcangeli 	ret = VM_FAULT_RETRY;
34282b0f8c3SJan Kara 	if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
343ba85c702SAndrea Arcangeli 		goto out;
34486039bd3SAndrea Arcangeli 
34586039bd3SAndrea Arcangeli 	/* take the reference before dropping the mmap_sem */
34686039bd3SAndrea Arcangeli 	userfaultfd_ctx_get(ctx);
34786039bd3SAndrea Arcangeli 
34886039bd3SAndrea Arcangeli 	init_waitqueue_func_entry(&uwq.wq, userfaultfd_wake_function);
34986039bd3SAndrea Arcangeli 	uwq.wq.private = current;
35082b0f8c3SJan Kara 	uwq.msg = userfault_msg(vmf->address, vmf->flags, reason);
35186039bd3SAndrea Arcangeli 	uwq.ctx = ctx;
35215a77c6fSAndrea Arcangeli 	uwq.waken = false;
35386039bd3SAndrea Arcangeli 
354bae473a4SKirill A. Shutemov 	return_to_userland =
35582b0f8c3SJan Kara 		(vmf->flags & (FAULT_FLAG_USER|FAULT_FLAG_KILLABLE)) ==
356dfa37dc3SAndrea Arcangeli 		(FAULT_FLAG_USER|FAULT_FLAG_KILLABLE);
35715a77c6fSAndrea Arcangeli 	blocking_state = return_to_userland ? TASK_INTERRUPTIBLE :
35815a77c6fSAndrea Arcangeli 			 TASK_KILLABLE;
359dfa37dc3SAndrea Arcangeli 
36015b726efSAndrea Arcangeli 	spin_lock(&ctx->fault_pending_wqh.lock);
36186039bd3SAndrea Arcangeli 	/*
36286039bd3SAndrea Arcangeli 	 * After the __add_wait_queue the uwq is visible to userland
36386039bd3SAndrea Arcangeli 	 * through poll/read().
36486039bd3SAndrea Arcangeli 	 */
36515b726efSAndrea Arcangeli 	__add_wait_queue(&ctx->fault_pending_wqh, &uwq.wq);
36615b726efSAndrea Arcangeli 	/*
36715b726efSAndrea Arcangeli 	 * The smp_mb() after __set_current_state prevents the reads
36815b726efSAndrea Arcangeli 	 * following the spin_unlock to happen before the list_add in
36915b726efSAndrea Arcangeli 	 * __add_wait_queue.
37015b726efSAndrea Arcangeli 	 */
37115a77c6fSAndrea Arcangeli 	set_current_state(blocking_state);
37215b726efSAndrea Arcangeli 	spin_unlock(&ctx->fault_pending_wqh.lock);
37386039bd3SAndrea Arcangeli 
37482b0f8c3SJan Kara 	must_wait = userfaultfd_must_wait(ctx, vmf->address, vmf->flags,
37582b0f8c3SJan Kara 					  reason);
3768d2afd96SAndrea Arcangeli 	up_read(&mm->mmap_sem);
3778d2afd96SAndrea Arcangeli 
3788d2afd96SAndrea Arcangeli 	if (likely(must_wait && !ACCESS_ONCE(ctx->released) &&
379dfa37dc3SAndrea Arcangeli 		   (return_to_userland ? !signal_pending(current) :
380dfa37dc3SAndrea Arcangeli 		    !fatal_signal_pending(current)))) {
38186039bd3SAndrea Arcangeli 		wake_up_poll(&ctx->fd_wqh, POLLIN);
38286039bd3SAndrea Arcangeli 		schedule();
383ba85c702SAndrea Arcangeli 		ret |= VM_FAULT_MAJOR;
38415a77c6fSAndrea Arcangeli 
38515a77c6fSAndrea Arcangeli 		/*
38615a77c6fSAndrea Arcangeli 		 * False wakeups can orginate even from rwsem before
38715a77c6fSAndrea Arcangeli 		 * up_read() however userfaults will wait either for a
38815a77c6fSAndrea Arcangeli 		 * targeted wakeup on the specific uwq waitqueue from
38915a77c6fSAndrea Arcangeli 		 * wake_userfault() or for signals or for uffd
39015a77c6fSAndrea Arcangeli 		 * release.
39115a77c6fSAndrea Arcangeli 		 */
39215a77c6fSAndrea Arcangeli 		while (!READ_ONCE(uwq.waken)) {
39315a77c6fSAndrea Arcangeli 			/*
39415a77c6fSAndrea Arcangeli 			 * This needs the full smp_store_mb()
39515a77c6fSAndrea Arcangeli 			 * guarantee as the state write must be
39615a77c6fSAndrea Arcangeli 			 * visible to other CPUs before reading
39715a77c6fSAndrea Arcangeli 			 * uwq.waken from other CPUs.
39815a77c6fSAndrea Arcangeli 			 */
39915a77c6fSAndrea Arcangeli 			set_current_state(blocking_state);
40015a77c6fSAndrea Arcangeli 			if (READ_ONCE(uwq.waken) ||
40115a77c6fSAndrea Arcangeli 			    READ_ONCE(ctx->released) ||
40215a77c6fSAndrea Arcangeli 			    (return_to_userland ? signal_pending(current) :
40315a77c6fSAndrea Arcangeli 			     fatal_signal_pending(current)))
40415a77c6fSAndrea Arcangeli 				break;
40515a77c6fSAndrea Arcangeli 			schedule();
40615a77c6fSAndrea Arcangeli 		}
40786039bd3SAndrea Arcangeli 	}
408ba85c702SAndrea Arcangeli 
40986039bd3SAndrea Arcangeli 	__set_current_state(TASK_RUNNING);
41015b726efSAndrea Arcangeli 
411dfa37dc3SAndrea Arcangeli 	if (return_to_userland) {
412dfa37dc3SAndrea Arcangeli 		if (signal_pending(current) &&
413dfa37dc3SAndrea Arcangeli 		    !fatal_signal_pending(current)) {
414dfa37dc3SAndrea Arcangeli 			/*
415dfa37dc3SAndrea Arcangeli 			 * If we got a SIGSTOP or SIGCONT and this is
416dfa37dc3SAndrea Arcangeli 			 * a normal userland page fault, just let
417dfa37dc3SAndrea Arcangeli 			 * userland return so the signal will be
418dfa37dc3SAndrea Arcangeli 			 * handled and gdb debugging works.  The page
419dfa37dc3SAndrea Arcangeli 			 * fault code immediately after we return from
420dfa37dc3SAndrea Arcangeli 			 * this function is going to release the
421dfa37dc3SAndrea Arcangeli 			 * mmap_sem and it's not depending on it
422dfa37dc3SAndrea Arcangeli 			 * (unlike gup would if we were not to return
423dfa37dc3SAndrea Arcangeli 			 * VM_FAULT_RETRY).
424dfa37dc3SAndrea Arcangeli 			 *
425dfa37dc3SAndrea Arcangeli 			 * If a fatal signal is pending we still take
426dfa37dc3SAndrea Arcangeli 			 * the streamlined VM_FAULT_RETRY failure path
427dfa37dc3SAndrea Arcangeli 			 * and there's no need to retake the mmap_sem
428dfa37dc3SAndrea Arcangeli 			 * in such case.
429dfa37dc3SAndrea Arcangeli 			 */
430dfa37dc3SAndrea Arcangeli 			down_read(&mm->mmap_sem);
431dfa37dc3SAndrea Arcangeli 			ret = 0;
432dfa37dc3SAndrea Arcangeli 		}
433dfa37dc3SAndrea Arcangeli 	}
434dfa37dc3SAndrea Arcangeli 
43515b726efSAndrea Arcangeli 	/*
43615b726efSAndrea Arcangeli 	 * Here we race with the list_del; list_add in
43715b726efSAndrea Arcangeli 	 * userfaultfd_ctx_read(), however because we don't ever run
43815b726efSAndrea Arcangeli 	 * list_del_init() to refile across the two lists, the prev
43915b726efSAndrea Arcangeli 	 * and next pointers will never point to self. list_add also
44015b726efSAndrea Arcangeli 	 * would never let any of the two pointers to point to
44115b726efSAndrea Arcangeli 	 * self. So list_empty_careful won't risk to see both pointers
44215b726efSAndrea Arcangeli 	 * pointing to self at any time during the list refile. The
44315b726efSAndrea Arcangeli 	 * only case where list_del_init() is called is the full
44415b726efSAndrea Arcangeli 	 * removal in the wake function and there we don't re-list_add
44515b726efSAndrea Arcangeli 	 * and it's fine not to block on the spinlock. The uwq on this
44615b726efSAndrea Arcangeli 	 * kernel stack can be released after the list_del_init.
44715b726efSAndrea Arcangeli 	 */
448ba85c702SAndrea Arcangeli 	if (!list_empty_careful(&uwq.wq.task_list)) {
44915b726efSAndrea Arcangeli 		spin_lock(&ctx->fault_pending_wqh.lock);
45015b726efSAndrea Arcangeli 		/*
45115b726efSAndrea Arcangeli 		 * No need of list_del_init(), the uwq on the stack
45215b726efSAndrea Arcangeli 		 * will be freed shortly anyway.
45315b726efSAndrea Arcangeli 		 */
45415b726efSAndrea Arcangeli 		list_del(&uwq.wq.task_list);
45515b726efSAndrea Arcangeli 		spin_unlock(&ctx->fault_pending_wqh.lock);
456ba85c702SAndrea Arcangeli 	}
45786039bd3SAndrea Arcangeli 
45886039bd3SAndrea Arcangeli 	/*
45986039bd3SAndrea Arcangeli 	 * ctx may go away after this if the userfault pseudo fd is
46086039bd3SAndrea Arcangeli 	 * already released.
46186039bd3SAndrea Arcangeli 	 */
46286039bd3SAndrea Arcangeli 	userfaultfd_ctx_put(ctx);
46386039bd3SAndrea Arcangeli 
464ba85c702SAndrea Arcangeli out:
465ba85c702SAndrea Arcangeli 	return ret;
46686039bd3SAndrea Arcangeli }
46786039bd3SAndrea Arcangeli 
4689cd75c3cSPavel Emelyanov static int __maybe_unused userfaultfd_event_wait_completion(
4699cd75c3cSPavel Emelyanov 		struct userfaultfd_ctx *ctx,
4709cd75c3cSPavel Emelyanov 		struct userfaultfd_wait_queue *ewq)
4719cd75c3cSPavel Emelyanov {
4729cd75c3cSPavel Emelyanov 	int ret = 0;
4739cd75c3cSPavel Emelyanov 
4749cd75c3cSPavel Emelyanov 	ewq->ctx = ctx;
4759cd75c3cSPavel Emelyanov 	init_waitqueue_entry(&ewq->wq, current);
4769cd75c3cSPavel Emelyanov 
4779cd75c3cSPavel Emelyanov 	spin_lock(&ctx->event_wqh.lock);
4789cd75c3cSPavel Emelyanov 	/*
4799cd75c3cSPavel Emelyanov 	 * After the __add_wait_queue the uwq is visible to userland
4809cd75c3cSPavel Emelyanov 	 * through poll/read().
4819cd75c3cSPavel Emelyanov 	 */
4829cd75c3cSPavel Emelyanov 	__add_wait_queue(&ctx->event_wqh, &ewq->wq);
4839cd75c3cSPavel Emelyanov 	for (;;) {
4849cd75c3cSPavel Emelyanov 		set_current_state(TASK_KILLABLE);
4859cd75c3cSPavel Emelyanov 		if (ewq->msg.event == 0)
4869cd75c3cSPavel Emelyanov 			break;
4879cd75c3cSPavel Emelyanov 		if (ACCESS_ONCE(ctx->released) ||
4889cd75c3cSPavel Emelyanov 		    fatal_signal_pending(current)) {
4899cd75c3cSPavel Emelyanov 			ret = -1;
4909cd75c3cSPavel Emelyanov 			__remove_wait_queue(&ctx->event_wqh, &ewq->wq);
4919cd75c3cSPavel Emelyanov 			break;
4929cd75c3cSPavel Emelyanov 		}
4939cd75c3cSPavel Emelyanov 
4949cd75c3cSPavel Emelyanov 		spin_unlock(&ctx->event_wqh.lock);
4959cd75c3cSPavel Emelyanov 
4969cd75c3cSPavel Emelyanov 		wake_up_poll(&ctx->fd_wqh, POLLIN);
4979cd75c3cSPavel Emelyanov 		schedule();
4989cd75c3cSPavel Emelyanov 
4999cd75c3cSPavel Emelyanov 		spin_lock(&ctx->event_wqh.lock);
5009cd75c3cSPavel Emelyanov 	}
5019cd75c3cSPavel Emelyanov 	__set_current_state(TASK_RUNNING);
5029cd75c3cSPavel Emelyanov 	spin_unlock(&ctx->event_wqh.lock);
5039cd75c3cSPavel Emelyanov 
5049cd75c3cSPavel Emelyanov 	/*
5059cd75c3cSPavel Emelyanov 	 * ctx may go away after this if the userfault pseudo fd is
5069cd75c3cSPavel Emelyanov 	 * already released.
5079cd75c3cSPavel Emelyanov 	 */
5089cd75c3cSPavel Emelyanov 
5099cd75c3cSPavel Emelyanov 	userfaultfd_ctx_put(ctx);
5109cd75c3cSPavel Emelyanov 	return ret;
5119cd75c3cSPavel Emelyanov }
5129cd75c3cSPavel Emelyanov 
5139cd75c3cSPavel Emelyanov static void userfaultfd_event_complete(struct userfaultfd_ctx *ctx,
5149cd75c3cSPavel Emelyanov 				       struct userfaultfd_wait_queue *ewq)
5159cd75c3cSPavel Emelyanov {
5169cd75c3cSPavel Emelyanov 	ewq->msg.event = 0;
5179cd75c3cSPavel Emelyanov 	wake_up_locked(&ctx->event_wqh);
5189cd75c3cSPavel Emelyanov 	__remove_wait_queue(&ctx->event_wqh, &ewq->wq);
5199cd75c3cSPavel Emelyanov }
5209cd75c3cSPavel Emelyanov 
52186039bd3SAndrea Arcangeli static int userfaultfd_release(struct inode *inode, struct file *file)
52286039bd3SAndrea Arcangeli {
52386039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
52486039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
52586039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev;
52686039bd3SAndrea Arcangeli 	/* len == 0 means wake all */
52786039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range range = { .len = 0, };
52886039bd3SAndrea Arcangeli 	unsigned long new_flags;
52986039bd3SAndrea Arcangeli 
53086039bd3SAndrea Arcangeli 	ACCESS_ONCE(ctx->released) = true;
53186039bd3SAndrea Arcangeli 
532d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
533d2005e3fSOleg Nesterov 		goto wakeup;
534d2005e3fSOleg Nesterov 
53586039bd3SAndrea Arcangeli 	/*
53686039bd3SAndrea Arcangeli 	 * Flush page faults out of all CPUs. NOTE: all page faults
53786039bd3SAndrea Arcangeli 	 * must be retried without returning VM_FAULT_SIGBUS if
53886039bd3SAndrea Arcangeli 	 * userfaultfd_ctx_get() succeeds but vma->vma_userfault_ctx
53986039bd3SAndrea Arcangeli 	 * changes while handle_userfault released the mmap_sem. So
54086039bd3SAndrea Arcangeli 	 * it's critical that released is set to true (above), before
54186039bd3SAndrea Arcangeli 	 * taking the mmap_sem for writing.
54286039bd3SAndrea Arcangeli 	 */
54386039bd3SAndrea Arcangeli 	down_write(&mm->mmap_sem);
54486039bd3SAndrea Arcangeli 	prev = NULL;
54586039bd3SAndrea Arcangeli 	for (vma = mm->mmap; vma; vma = vma->vm_next) {
54686039bd3SAndrea Arcangeli 		cond_resched();
54786039bd3SAndrea Arcangeli 		BUG_ON(!!vma->vm_userfaultfd_ctx.ctx ^
54886039bd3SAndrea Arcangeli 		       !!(vma->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
54986039bd3SAndrea Arcangeli 		if (vma->vm_userfaultfd_ctx.ctx != ctx) {
55086039bd3SAndrea Arcangeli 			prev = vma;
55186039bd3SAndrea Arcangeli 			continue;
55286039bd3SAndrea Arcangeli 		}
55386039bd3SAndrea Arcangeli 		new_flags = vma->vm_flags & ~(VM_UFFD_MISSING | VM_UFFD_WP);
55486039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, vma->vm_start, vma->vm_end,
55586039bd3SAndrea Arcangeli 				 new_flags, vma->anon_vma,
55686039bd3SAndrea Arcangeli 				 vma->vm_file, vma->vm_pgoff,
55786039bd3SAndrea Arcangeli 				 vma_policy(vma),
55886039bd3SAndrea Arcangeli 				 NULL_VM_UFFD_CTX);
55986039bd3SAndrea Arcangeli 		if (prev)
56086039bd3SAndrea Arcangeli 			vma = prev;
56186039bd3SAndrea Arcangeli 		else
56286039bd3SAndrea Arcangeli 			prev = vma;
56386039bd3SAndrea Arcangeli 		vma->vm_flags = new_flags;
56486039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
56586039bd3SAndrea Arcangeli 	}
56686039bd3SAndrea Arcangeli 	up_write(&mm->mmap_sem);
567d2005e3fSOleg Nesterov 	mmput(mm);
568d2005e3fSOleg Nesterov wakeup:
56986039bd3SAndrea Arcangeli 	/*
57015b726efSAndrea Arcangeli 	 * After no new page faults can wait on this fault_*wqh, flush
57186039bd3SAndrea Arcangeli 	 * the last page faults that may have been already waiting on
57215b726efSAndrea Arcangeli 	 * the fault_*wqh.
57386039bd3SAndrea Arcangeli 	 */
57415b726efSAndrea Arcangeli 	spin_lock(&ctx->fault_pending_wqh.lock);
575ac5be6b4SAndrea Arcangeli 	__wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL, &range);
576ac5be6b4SAndrea Arcangeli 	__wake_up_locked_key(&ctx->fault_wqh, TASK_NORMAL, &range);
57715b726efSAndrea Arcangeli 	spin_unlock(&ctx->fault_pending_wqh.lock);
57886039bd3SAndrea Arcangeli 
57986039bd3SAndrea Arcangeli 	wake_up_poll(&ctx->fd_wqh, POLLHUP);
58086039bd3SAndrea Arcangeli 	userfaultfd_ctx_put(ctx);
58186039bd3SAndrea Arcangeli 	return 0;
58286039bd3SAndrea Arcangeli }
58386039bd3SAndrea Arcangeli 
58415b726efSAndrea Arcangeli /* fault_pending_wqh.lock must be hold by the caller */
5856dcc27fdSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault_in(
5866dcc27fdSPavel Emelyanov 		wait_queue_head_t *wqh)
58786039bd3SAndrea Arcangeli {
58886039bd3SAndrea Arcangeli 	wait_queue_t *wq;
58915b726efSAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
59086039bd3SAndrea Arcangeli 
5916dcc27fdSPavel Emelyanov 	VM_BUG_ON(!spin_is_locked(&wqh->lock));
59286039bd3SAndrea Arcangeli 
59315b726efSAndrea Arcangeli 	uwq = NULL;
5946dcc27fdSPavel Emelyanov 	if (!waitqueue_active(wqh))
59515b726efSAndrea Arcangeli 		goto out;
59615b726efSAndrea Arcangeli 	/* walk in reverse to provide FIFO behavior to read userfaults */
5976dcc27fdSPavel Emelyanov 	wq = list_last_entry(&wqh->task_list, typeof(*wq), task_list);
59815b726efSAndrea Arcangeli 	uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
59915b726efSAndrea Arcangeli out:
60015b726efSAndrea Arcangeli 	return uwq;
60186039bd3SAndrea Arcangeli }
60286039bd3SAndrea Arcangeli 
6036dcc27fdSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault(
6046dcc27fdSPavel Emelyanov 		struct userfaultfd_ctx *ctx)
6056dcc27fdSPavel Emelyanov {
6066dcc27fdSPavel Emelyanov 	return find_userfault_in(&ctx->fault_pending_wqh);
6076dcc27fdSPavel Emelyanov }
6086dcc27fdSPavel Emelyanov 
6099cd75c3cSPavel Emelyanov static inline struct userfaultfd_wait_queue *find_userfault_evt(
6109cd75c3cSPavel Emelyanov 		struct userfaultfd_ctx *ctx)
6119cd75c3cSPavel Emelyanov {
6129cd75c3cSPavel Emelyanov 	return find_userfault_in(&ctx->event_wqh);
6139cd75c3cSPavel Emelyanov }
6149cd75c3cSPavel Emelyanov 
61586039bd3SAndrea Arcangeli static unsigned int userfaultfd_poll(struct file *file, poll_table *wait)
61686039bd3SAndrea Arcangeli {
61786039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
61886039bd3SAndrea Arcangeli 	unsigned int ret;
61986039bd3SAndrea Arcangeli 
62086039bd3SAndrea Arcangeli 	poll_wait(file, &ctx->fd_wqh, wait);
62186039bd3SAndrea Arcangeli 
62286039bd3SAndrea Arcangeli 	switch (ctx->state) {
62386039bd3SAndrea Arcangeli 	case UFFD_STATE_WAIT_API:
62486039bd3SAndrea Arcangeli 		return POLLERR;
62586039bd3SAndrea Arcangeli 	case UFFD_STATE_RUNNING:
626ba85c702SAndrea Arcangeli 		/*
627ba85c702SAndrea Arcangeli 		 * poll() never guarantees that read won't block.
628ba85c702SAndrea Arcangeli 		 * userfaults can be waken before they're read().
629ba85c702SAndrea Arcangeli 		 */
630ba85c702SAndrea Arcangeli 		if (unlikely(!(file->f_flags & O_NONBLOCK)))
631ba85c702SAndrea Arcangeli 			return POLLERR;
63215b726efSAndrea Arcangeli 		/*
63315b726efSAndrea Arcangeli 		 * lockless access to see if there are pending faults
63415b726efSAndrea Arcangeli 		 * __pollwait last action is the add_wait_queue but
63515b726efSAndrea Arcangeli 		 * the spin_unlock would allow the waitqueue_active to
63615b726efSAndrea Arcangeli 		 * pass above the actual list_add inside
63715b726efSAndrea Arcangeli 		 * add_wait_queue critical section. So use a full
63815b726efSAndrea Arcangeli 		 * memory barrier to serialize the list_add write of
63915b726efSAndrea Arcangeli 		 * add_wait_queue() with the waitqueue_active read
64015b726efSAndrea Arcangeli 		 * below.
64115b726efSAndrea Arcangeli 		 */
64215b726efSAndrea Arcangeli 		ret = 0;
64315b726efSAndrea Arcangeli 		smp_mb();
64415b726efSAndrea Arcangeli 		if (waitqueue_active(&ctx->fault_pending_wqh))
64515b726efSAndrea Arcangeli 			ret = POLLIN;
6469cd75c3cSPavel Emelyanov 		else if (waitqueue_active(&ctx->event_wqh))
6479cd75c3cSPavel Emelyanov 			ret = POLLIN;
6489cd75c3cSPavel Emelyanov 
64986039bd3SAndrea Arcangeli 		return ret;
65086039bd3SAndrea Arcangeli 	default:
6518474901aSAndrea Arcangeli 		WARN_ON_ONCE(1);
6528474901aSAndrea Arcangeli 		return POLLERR;
65386039bd3SAndrea Arcangeli 	}
65486039bd3SAndrea Arcangeli }
65586039bd3SAndrea Arcangeli 
65686039bd3SAndrea Arcangeli static ssize_t userfaultfd_ctx_read(struct userfaultfd_ctx *ctx, int no_wait,
657a9b85f94SAndrea Arcangeli 				    struct uffd_msg *msg)
65886039bd3SAndrea Arcangeli {
65986039bd3SAndrea Arcangeli 	ssize_t ret;
66086039bd3SAndrea Arcangeli 	DECLARE_WAITQUEUE(wait, current);
66115b726efSAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
66286039bd3SAndrea Arcangeli 
66315b726efSAndrea Arcangeli 	/* always take the fd_wqh lock before the fault_pending_wqh lock */
66486039bd3SAndrea Arcangeli 	spin_lock(&ctx->fd_wqh.lock);
66586039bd3SAndrea Arcangeli 	__add_wait_queue(&ctx->fd_wqh, &wait);
66686039bd3SAndrea Arcangeli 	for (;;) {
66786039bd3SAndrea Arcangeli 		set_current_state(TASK_INTERRUPTIBLE);
66815b726efSAndrea Arcangeli 		spin_lock(&ctx->fault_pending_wqh.lock);
66915b726efSAndrea Arcangeli 		uwq = find_userfault(ctx);
67015b726efSAndrea Arcangeli 		if (uwq) {
67186039bd3SAndrea Arcangeli 			/*
6722c5b7e1bSAndrea Arcangeli 			 * Use a seqcount to repeat the lockless check
6732c5b7e1bSAndrea Arcangeli 			 * in wake_userfault() to avoid missing
6742c5b7e1bSAndrea Arcangeli 			 * wakeups because during the refile both
6752c5b7e1bSAndrea Arcangeli 			 * waitqueue could become empty if this is the
6762c5b7e1bSAndrea Arcangeli 			 * only userfault.
6772c5b7e1bSAndrea Arcangeli 			 */
6782c5b7e1bSAndrea Arcangeli 			write_seqcount_begin(&ctx->refile_seq);
6792c5b7e1bSAndrea Arcangeli 
6802c5b7e1bSAndrea Arcangeli 			/*
68115b726efSAndrea Arcangeli 			 * The fault_pending_wqh.lock prevents the uwq
68215b726efSAndrea Arcangeli 			 * to disappear from under us.
68315b726efSAndrea Arcangeli 			 *
68415b726efSAndrea Arcangeli 			 * Refile this userfault from
68515b726efSAndrea Arcangeli 			 * fault_pending_wqh to fault_wqh, it's not
68615b726efSAndrea Arcangeli 			 * pending anymore after we read it.
68715b726efSAndrea Arcangeli 			 *
68815b726efSAndrea Arcangeli 			 * Use list_del() by hand (as
68915b726efSAndrea Arcangeli 			 * userfaultfd_wake_function also uses
69015b726efSAndrea Arcangeli 			 * list_del_init() by hand) to be sure nobody
69115b726efSAndrea Arcangeli 			 * changes __remove_wait_queue() to use
69215b726efSAndrea Arcangeli 			 * list_del_init() in turn breaking the
69315b726efSAndrea Arcangeli 			 * !list_empty_careful() check in
69415b726efSAndrea Arcangeli 			 * handle_userfault(). The uwq->wq.task_list
69515b726efSAndrea Arcangeli 			 * must never be empty at any time during the
69615b726efSAndrea Arcangeli 			 * refile, or the waitqueue could disappear
69715b726efSAndrea Arcangeli 			 * from under us. The "wait_queue_head_t"
69815b726efSAndrea Arcangeli 			 * parameter of __remove_wait_queue() is unused
69915b726efSAndrea Arcangeli 			 * anyway.
70086039bd3SAndrea Arcangeli 			 */
70115b726efSAndrea Arcangeli 			list_del(&uwq->wq.task_list);
70215b726efSAndrea Arcangeli 			__add_wait_queue(&ctx->fault_wqh, &uwq->wq);
70315b726efSAndrea Arcangeli 
7042c5b7e1bSAndrea Arcangeli 			write_seqcount_end(&ctx->refile_seq);
7052c5b7e1bSAndrea Arcangeli 
706a9b85f94SAndrea Arcangeli 			/* careful to always initialize msg if ret == 0 */
707a9b85f94SAndrea Arcangeli 			*msg = uwq->msg;
70815b726efSAndrea Arcangeli 			spin_unlock(&ctx->fault_pending_wqh.lock);
70986039bd3SAndrea Arcangeli 			ret = 0;
71086039bd3SAndrea Arcangeli 			break;
71186039bd3SAndrea Arcangeli 		}
71215b726efSAndrea Arcangeli 		spin_unlock(&ctx->fault_pending_wqh.lock);
7139cd75c3cSPavel Emelyanov 
7149cd75c3cSPavel Emelyanov 		spin_lock(&ctx->event_wqh.lock);
7159cd75c3cSPavel Emelyanov 		uwq = find_userfault_evt(ctx);
7169cd75c3cSPavel Emelyanov 		if (uwq) {
7179cd75c3cSPavel Emelyanov 			*msg = uwq->msg;
7189cd75c3cSPavel Emelyanov 
7199cd75c3cSPavel Emelyanov 			userfaultfd_event_complete(ctx, uwq);
7209cd75c3cSPavel Emelyanov 			spin_unlock(&ctx->event_wqh.lock);
7219cd75c3cSPavel Emelyanov 			ret = 0;
7229cd75c3cSPavel Emelyanov 			break;
7239cd75c3cSPavel Emelyanov 		}
7249cd75c3cSPavel Emelyanov 		spin_unlock(&ctx->event_wqh.lock);
7259cd75c3cSPavel Emelyanov 
72686039bd3SAndrea Arcangeli 		if (signal_pending(current)) {
72786039bd3SAndrea Arcangeli 			ret = -ERESTARTSYS;
72886039bd3SAndrea Arcangeli 			break;
72986039bd3SAndrea Arcangeli 		}
73086039bd3SAndrea Arcangeli 		if (no_wait) {
73186039bd3SAndrea Arcangeli 			ret = -EAGAIN;
73286039bd3SAndrea Arcangeli 			break;
73386039bd3SAndrea Arcangeli 		}
73486039bd3SAndrea Arcangeli 		spin_unlock(&ctx->fd_wqh.lock);
73586039bd3SAndrea Arcangeli 		schedule();
73686039bd3SAndrea Arcangeli 		spin_lock(&ctx->fd_wqh.lock);
73786039bd3SAndrea Arcangeli 	}
73886039bd3SAndrea Arcangeli 	__remove_wait_queue(&ctx->fd_wqh, &wait);
73986039bd3SAndrea Arcangeli 	__set_current_state(TASK_RUNNING);
74086039bd3SAndrea Arcangeli 	spin_unlock(&ctx->fd_wqh.lock);
74186039bd3SAndrea Arcangeli 
74286039bd3SAndrea Arcangeli 	return ret;
74386039bd3SAndrea Arcangeli }
74486039bd3SAndrea Arcangeli 
74586039bd3SAndrea Arcangeli static ssize_t userfaultfd_read(struct file *file, char __user *buf,
74686039bd3SAndrea Arcangeli 				size_t count, loff_t *ppos)
74786039bd3SAndrea Arcangeli {
74886039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
74986039bd3SAndrea Arcangeli 	ssize_t _ret, ret = 0;
750a9b85f94SAndrea Arcangeli 	struct uffd_msg msg;
75186039bd3SAndrea Arcangeli 	int no_wait = file->f_flags & O_NONBLOCK;
75286039bd3SAndrea Arcangeli 
75386039bd3SAndrea Arcangeli 	if (ctx->state == UFFD_STATE_WAIT_API)
75486039bd3SAndrea Arcangeli 		return -EINVAL;
75586039bd3SAndrea Arcangeli 
75686039bd3SAndrea Arcangeli 	for (;;) {
757a9b85f94SAndrea Arcangeli 		if (count < sizeof(msg))
75886039bd3SAndrea Arcangeli 			return ret ? ret : -EINVAL;
759a9b85f94SAndrea Arcangeli 		_ret = userfaultfd_ctx_read(ctx, no_wait, &msg);
76086039bd3SAndrea Arcangeli 		if (_ret < 0)
76186039bd3SAndrea Arcangeli 			return ret ? ret : _ret;
762a9b85f94SAndrea Arcangeli 		if (copy_to_user((__u64 __user *) buf, &msg, sizeof(msg)))
76386039bd3SAndrea Arcangeli 			return ret ? ret : -EFAULT;
764a9b85f94SAndrea Arcangeli 		ret += sizeof(msg);
765a9b85f94SAndrea Arcangeli 		buf += sizeof(msg);
766a9b85f94SAndrea Arcangeli 		count -= sizeof(msg);
76786039bd3SAndrea Arcangeli 		/*
76886039bd3SAndrea Arcangeli 		 * Allow to read more than one fault at time but only
76986039bd3SAndrea Arcangeli 		 * block if waiting for the very first one.
77086039bd3SAndrea Arcangeli 		 */
77186039bd3SAndrea Arcangeli 		no_wait = O_NONBLOCK;
77286039bd3SAndrea Arcangeli 	}
77386039bd3SAndrea Arcangeli }
77486039bd3SAndrea Arcangeli 
77586039bd3SAndrea Arcangeli static void __wake_userfault(struct userfaultfd_ctx *ctx,
77686039bd3SAndrea Arcangeli 			     struct userfaultfd_wake_range *range)
77786039bd3SAndrea Arcangeli {
77886039bd3SAndrea Arcangeli 	unsigned long start, end;
77986039bd3SAndrea Arcangeli 
78086039bd3SAndrea Arcangeli 	start = range->start;
78186039bd3SAndrea Arcangeli 	end = range->start + range->len;
78286039bd3SAndrea Arcangeli 
78315b726efSAndrea Arcangeli 	spin_lock(&ctx->fault_pending_wqh.lock);
78486039bd3SAndrea Arcangeli 	/* wake all in the range and autoremove */
78515b726efSAndrea Arcangeli 	if (waitqueue_active(&ctx->fault_pending_wqh))
786ac5be6b4SAndrea Arcangeli 		__wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL,
78715b726efSAndrea Arcangeli 				     range);
78815b726efSAndrea Arcangeli 	if (waitqueue_active(&ctx->fault_wqh))
789ac5be6b4SAndrea Arcangeli 		__wake_up_locked_key(&ctx->fault_wqh, TASK_NORMAL, range);
79015b726efSAndrea Arcangeli 	spin_unlock(&ctx->fault_pending_wqh.lock);
79186039bd3SAndrea Arcangeli }
79286039bd3SAndrea Arcangeli 
79386039bd3SAndrea Arcangeli static __always_inline void wake_userfault(struct userfaultfd_ctx *ctx,
79486039bd3SAndrea Arcangeli 					   struct userfaultfd_wake_range *range)
79586039bd3SAndrea Arcangeli {
7962c5b7e1bSAndrea Arcangeli 	unsigned seq;
7972c5b7e1bSAndrea Arcangeli 	bool need_wakeup;
7982c5b7e1bSAndrea Arcangeli 
79986039bd3SAndrea Arcangeli 	/*
80086039bd3SAndrea Arcangeli 	 * To be sure waitqueue_active() is not reordered by the CPU
80186039bd3SAndrea Arcangeli 	 * before the pagetable update, use an explicit SMP memory
80286039bd3SAndrea Arcangeli 	 * barrier here. PT lock release or up_read(mmap_sem) still
80386039bd3SAndrea Arcangeli 	 * have release semantics that can allow the
80486039bd3SAndrea Arcangeli 	 * waitqueue_active() to be reordered before the pte update.
80586039bd3SAndrea Arcangeli 	 */
80686039bd3SAndrea Arcangeli 	smp_mb();
80786039bd3SAndrea Arcangeli 
80886039bd3SAndrea Arcangeli 	/*
80986039bd3SAndrea Arcangeli 	 * Use waitqueue_active because it's very frequent to
81086039bd3SAndrea Arcangeli 	 * change the address space atomically even if there are no
81186039bd3SAndrea Arcangeli 	 * userfaults yet. So we take the spinlock only when we're
81286039bd3SAndrea Arcangeli 	 * sure we've userfaults to wake.
81386039bd3SAndrea Arcangeli 	 */
8142c5b7e1bSAndrea Arcangeli 	do {
8152c5b7e1bSAndrea Arcangeli 		seq = read_seqcount_begin(&ctx->refile_seq);
8162c5b7e1bSAndrea Arcangeli 		need_wakeup = waitqueue_active(&ctx->fault_pending_wqh) ||
8172c5b7e1bSAndrea Arcangeli 			waitqueue_active(&ctx->fault_wqh);
8182c5b7e1bSAndrea Arcangeli 		cond_resched();
8192c5b7e1bSAndrea Arcangeli 	} while (read_seqcount_retry(&ctx->refile_seq, seq));
8202c5b7e1bSAndrea Arcangeli 	if (need_wakeup)
82186039bd3SAndrea Arcangeli 		__wake_userfault(ctx, range);
82286039bd3SAndrea Arcangeli }
82386039bd3SAndrea Arcangeli 
82486039bd3SAndrea Arcangeli static __always_inline int validate_range(struct mm_struct *mm,
82586039bd3SAndrea Arcangeli 					  __u64 start, __u64 len)
82686039bd3SAndrea Arcangeli {
82786039bd3SAndrea Arcangeli 	__u64 task_size = mm->task_size;
82886039bd3SAndrea Arcangeli 
82986039bd3SAndrea Arcangeli 	if (start & ~PAGE_MASK)
83086039bd3SAndrea Arcangeli 		return -EINVAL;
83186039bd3SAndrea Arcangeli 	if (len & ~PAGE_MASK)
83286039bd3SAndrea Arcangeli 		return -EINVAL;
83386039bd3SAndrea Arcangeli 	if (!len)
83486039bd3SAndrea Arcangeli 		return -EINVAL;
83586039bd3SAndrea Arcangeli 	if (start < mmap_min_addr)
83686039bd3SAndrea Arcangeli 		return -EINVAL;
83786039bd3SAndrea Arcangeli 	if (start >= task_size)
83886039bd3SAndrea Arcangeli 		return -EINVAL;
83986039bd3SAndrea Arcangeli 	if (len > task_size - start)
84086039bd3SAndrea Arcangeli 		return -EINVAL;
84186039bd3SAndrea Arcangeli 	return 0;
84286039bd3SAndrea Arcangeli }
84386039bd3SAndrea Arcangeli 
84486039bd3SAndrea Arcangeli static int userfaultfd_register(struct userfaultfd_ctx *ctx,
84586039bd3SAndrea Arcangeli 				unsigned long arg)
84686039bd3SAndrea Arcangeli {
84786039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
84886039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev, *cur;
84986039bd3SAndrea Arcangeli 	int ret;
85086039bd3SAndrea Arcangeli 	struct uffdio_register uffdio_register;
85186039bd3SAndrea Arcangeli 	struct uffdio_register __user *user_uffdio_register;
85286039bd3SAndrea Arcangeli 	unsigned long vm_flags, new_flags;
85386039bd3SAndrea Arcangeli 	bool found;
85486039bd3SAndrea Arcangeli 	unsigned long start, end, vma_end;
85586039bd3SAndrea Arcangeli 
85686039bd3SAndrea Arcangeli 	user_uffdio_register = (struct uffdio_register __user *) arg;
85786039bd3SAndrea Arcangeli 
85886039bd3SAndrea Arcangeli 	ret = -EFAULT;
85986039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_register, user_uffdio_register,
86086039bd3SAndrea Arcangeli 			   sizeof(uffdio_register)-sizeof(__u64)))
86186039bd3SAndrea Arcangeli 		goto out;
86286039bd3SAndrea Arcangeli 
86386039bd3SAndrea Arcangeli 	ret = -EINVAL;
86486039bd3SAndrea Arcangeli 	if (!uffdio_register.mode)
86586039bd3SAndrea Arcangeli 		goto out;
86686039bd3SAndrea Arcangeli 	if (uffdio_register.mode & ~(UFFDIO_REGISTER_MODE_MISSING|
86786039bd3SAndrea Arcangeli 				     UFFDIO_REGISTER_MODE_WP))
86886039bd3SAndrea Arcangeli 		goto out;
86986039bd3SAndrea Arcangeli 	vm_flags = 0;
87086039bd3SAndrea Arcangeli 	if (uffdio_register.mode & UFFDIO_REGISTER_MODE_MISSING)
87186039bd3SAndrea Arcangeli 		vm_flags |= VM_UFFD_MISSING;
87286039bd3SAndrea Arcangeli 	if (uffdio_register.mode & UFFDIO_REGISTER_MODE_WP) {
87386039bd3SAndrea Arcangeli 		vm_flags |= VM_UFFD_WP;
87486039bd3SAndrea Arcangeli 		/*
87586039bd3SAndrea Arcangeli 		 * FIXME: remove the below error constraint by
87686039bd3SAndrea Arcangeli 		 * implementing the wprotect tracking mode.
87786039bd3SAndrea Arcangeli 		 */
87886039bd3SAndrea Arcangeli 		ret = -EINVAL;
87986039bd3SAndrea Arcangeli 		goto out;
88086039bd3SAndrea Arcangeli 	}
88186039bd3SAndrea Arcangeli 
88286039bd3SAndrea Arcangeli 	ret = validate_range(mm, uffdio_register.range.start,
88386039bd3SAndrea Arcangeli 			     uffdio_register.range.len);
88486039bd3SAndrea Arcangeli 	if (ret)
88586039bd3SAndrea Arcangeli 		goto out;
88686039bd3SAndrea Arcangeli 
88786039bd3SAndrea Arcangeli 	start = uffdio_register.range.start;
88886039bd3SAndrea Arcangeli 	end = start + uffdio_register.range.len;
88986039bd3SAndrea Arcangeli 
890d2005e3fSOleg Nesterov 	ret = -ENOMEM;
891d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
892d2005e3fSOleg Nesterov 		goto out;
893d2005e3fSOleg Nesterov 
89486039bd3SAndrea Arcangeli 	down_write(&mm->mmap_sem);
89586039bd3SAndrea Arcangeli 	vma = find_vma_prev(mm, start, &prev);
89686039bd3SAndrea Arcangeli 	if (!vma)
89786039bd3SAndrea Arcangeli 		goto out_unlock;
89886039bd3SAndrea Arcangeli 
89986039bd3SAndrea Arcangeli 	/* check that there's at least one vma in the range */
90086039bd3SAndrea Arcangeli 	ret = -EINVAL;
90186039bd3SAndrea Arcangeli 	if (vma->vm_start >= end)
90286039bd3SAndrea Arcangeli 		goto out_unlock;
90386039bd3SAndrea Arcangeli 
90486039bd3SAndrea Arcangeli 	/*
90586039bd3SAndrea Arcangeli 	 * Search for not compatible vmas.
90686039bd3SAndrea Arcangeli 	 *
90786039bd3SAndrea Arcangeli 	 * FIXME: this shall be relaxed later so that it doesn't fail
90886039bd3SAndrea Arcangeli 	 * on tmpfs backed vmas (in addition to the current allowance
90986039bd3SAndrea Arcangeli 	 * on anonymous vmas).
91086039bd3SAndrea Arcangeli 	 */
91186039bd3SAndrea Arcangeli 	found = false;
91286039bd3SAndrea Arcangeli 	for (cur = vma; cur && cur->vm_start < end; cur = cur->vm_next) {
91386039bd3SAndrea Arcangeli 		cond_resched();
91486039bd3SAndrea Arcangeli 
91586039bd3SAndrea Arcangeli 		BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
91686039bd3SAndrea Arcangeli 		       !!(cur->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
91786039bd3SAndrea Arcangeli 
91886039bd3SAndrea Arcangeli 		/* check not compatible vmas */
91986039bd3SAndrea Arcangeli 		ret = -EINVAL;
920a94720bfSAndrea Arcangeli 		if (!vma_is_anonymous(cur))
92186039bd3SAndrea Arcangeli 			goto out_unlock;
92286039bd3SAndrea Arcangeli 
92386039bd3SAndrea Arcangeli 		/*
92486039bd3SAndrea Arcangeli 		 * Check that this vma isn't already owned by a
92586039bd3SAndrea Arcangeli 		 * different userfaultfd. We can't allow more than one
92686039bd3SAndrea Arcangeli 		 * userfaultfd to own a single vma simultaneously or we
92786039bd3SAndrea Arcangeli 		 * wouldn't know which one to deliver the userfaults to.
92886039bd3SAndrea Arcangeli 		 */
92986039bd3SAndrea Arcangeli 		ret = -EBUSY;
93086039bd3SAndrea Arcangeli 		if (cur->vm_userfaultfd_ctx.ctx &&
93186039bd3SAndrea Arcangeli 		    cur->vm_userfaultfd_ctx.ctx != ctx)
93286039bd3SAndrea Arcangeli 			goto out_unlock;
93386039bd3SAndrea Arcangeli 
93486039bd3SAndrea Arcangeli 		found = true;
93586039bd3SAndrea Arcangeli 	}
93686039bd3SAndrea Arcangeli 	BUG_ON(!found);
93786039bd3SAndrea Arcangeli 
93886039bd3SAndrea Arcangeli 	if (vma->vm_start < start)
93986039bd3SAndrea Arcangeli 		prev = vma;
94086039bd3SAndrea Arcangeli 
94186039bd3SAndrea Arcangeli 	ret = 0;
94286039bd3SAndrea Arcangeli 	do {
94386039bd3SAndrea Arcangeli 		cond_resched();
94486039bd3SAndrea Arcangeli 
945a94720bfSAndrea Arcangeli 		BUG_ON(!vma_is_anonymous(vma));
94686039bd3SAndrea Arcangeli 		BUG_ON(vma->vm_userfaultfd_ctx.ctx &&
94786039bd3SAndrea Arcangeli 		       vma->vm_userfaultfd_ctx.ctx != ctx);
94886039bd3SAndrea Arcangeli 
94986039bd3SAndrea Arcangeli 		/*
95086039bd3SAndrea Arcangeli 		 * Nothing to do: this vma is already registered into this
95186039bd3SAndrea Arcangeli 		 * userfaultfd and with the right tracking mode too.
95286039bd3SAndrea Arcangeli 		 */
95386039bd3SAndrea Arcangeli 		if (vma->vm_userfaultfd_ctx.ctx == ctx &&
95486039bd3SAndrea Arcangeli 		    (vma->vm_flags & vm_flags) == vm_flags)
95586039bd3SAndrea Arcangeli 			goto skip;
95686039bd3SAndrea Arcangeli 
95786039bd3SAndrea Arcangeli 		if (vma->vm_start > start)
95886039bd3SAndrea Arcangeli 			start = vma->vm_start;
95986039bd3SAndrea Arcangeli 		vma_end = min(end, vma->vm_end);
96086039bd3SAndrea Arcangeli 
96186039bd3SAndrea Arcangeli 		new_flags = (vma->vm_flags & ~vm_flags) | vm_flags;
96286039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, start, vma_end, new_flags,
96386039bd3SAndrea Arcangeli 				 vma->anon_vma, vma->vm_file, vma->vm_pgoff,
96486039bd3SAndrea Arcangeli 				 vma_policy(vma),
96586039bd3SAndrea Arcangeli 				 ((struct vm_userfaultfd_ctx){ ctx }));
96686039bd3SAndrea Arcangeli 		if (prev) {
96786039bd3SAndrea Arcangeli 			vma = prev;
96886039bd3SAndrea Arcangeli 			goto next;
96986039bd3SAndrea Arcangeli 		}
97086039bd3SAndrea Arcangeli 		if (vma->vm_start < start) {
97186039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, start, 1);
97286039bd3SAndrea Arcangeli 			if (ret)
97386039bd3SAndrea Arcangeli 				break;
97486039bd3SAndrea Arcangeli 		}
97586039bd3SAndrea Arcangeli 		if (vma->vm_end > end) {
97686039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, end, 0);
97786039bd3SAndrea Arcangeli 			if (ret)
97886039bd3SAndrea Arcangeli 				break;
97986039bd3SAndrea Arcangeli 		}
98086039bd3SAndrea Arcangeli 	next:
98186039bd3SAndrea Arcangeli 		/*
98286039bd3SAndrea Arcangeli 		 * In the vma_merge() successful mprotect-like case 8:
98386039bd3SAndrea Arcangeli 		 * the next vma was merged into the current one and
98486039bd3SAndrea Arcangeli 		 * the current one has not been updated yet.
98586039bd3SAndrea Arcangeli 		 */
98686039bd3SAndrea Arcangeli 		vma->vm_flags = new_flags;
98786039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx.ctx = ctx;
98886039bd3SAndrea Arcangeli 
98986039bd3SAndrea Arcangeli 	skip:
99086039bd3SAndrea Arcangeli 		prev = vma;
99186039bd3SAndrea Arcangeli 		start = vma->vm_end;
99286039bd3SAndrea Arcangeli 		vma = vma->vm_next;
99386039bd3SAndrea Arcangeli 	} while (vma && vma->vm_start < end);
99486039bd3SAndrea Arcangeli out_unlock:
99586039bd3SAndrea Arcangeli 	up_write(&mm->mmap_sem);
996d2005e3fSOleg Nesterov 	mmput(mm);
99786039bd3SAndrea Arcangeli 	if (!ret) {
99886039bd3SAndrea Arcangeli 		/*
99986039bd3SAndrea Arcangeli 		 * Now that we scanned all vmas we can already tell
100086039bd3SAndrea Arcangeli 		 * userland which ioctls methods are guaranteed to
100186039bd3SAndrea Arcangeli 		 * succeed on this range.
100286039bd3SAndrea Arcangeli 		 */
100386039bd3SAndrea Arcangeli 		if (put_user(UFFD_API_RANGE_IOCTLS,
100486039bd3SAndrea Arcangeli 			     &user_uffdio_register->ioctls))
100586039bd3SAndrea Arcangeli 			ret = -EFAULT;
100686039bd3SAndrea Arcangeli 	}
100786039bd3SAndrea Arcangeli out:
100886039bd3SAndrea Arcangeli 	return ret;
100986039bd3SAndrea Arcangeli }
101086039bd3SAndrea Arcangeli 
101186039bd3SAndrea Arcangeli static int userfaultfd_unregister(struct userfaultfd_ctx *ctx,
101286039bd3SAndrea Arcangeli 				  unsigned long arg)
101386039bd3SAndrea Arcangeli {
101486039bd3SAndrea Arcangeli 	struct mm_struct *mm = ctx->mm;
101586039bd3SAndrea Arcangeli 	struct vm_area_struct *vma, *prev, *cur;
101686039bd3SAndrea Arcangeli 	int ret;
101786039bd3SAndrea Arcangeli 	struct uffdio_range uffdio_unregister;
101886039bd3SAndrea Arcangeli 	unsigned long new_flags;
101986039bd3SAndrea Arcangeli 	bool found;
102086039bd3SAndrea Arcangeli 	unsigned long start, end, vma_end;
102186039bd3SAndrea Arcangeli 	const void __user *buf = (void __user *)arg;
102286039bd3SAndrea Arcangeli 
102386039bd3SAndrea Arcangeli 	ret = -EFAULT;
102486039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_unregister, buf, sizeof(uffdio_unregister)))
102586039bd3SAndrea Arcangeli 		goto out;
102686039bd3SAndrea Arcangeli 
102786039bd3SAndrea Arcangeli 	ret = validate_range(mm, uffdio_unregister.start,
102886039bd3SAndrea Arcangeli 			     uffdio_unregister.len);
102986039bd3SAndrea Arcangeli 	if (ret)
103086039bd3SAndrea Arcangeli 		goto out;
103186039bd3SAndrea Arcangeli 
103286039bd3SAndrea Arcangeli 	start = uffdio_unregister.start;
103386039bd3SAndrea Arcangeli 	end = start + uffdio_unregister.len;
103486039bd3SAndrea Arcangeli 
1035d2005e3fSOleg Nesterov 	ret = -ENOMEM;
1036d2005e3fSOleg Nesterov 	if (!mmget_not_zero(mm))
1037d2005e3fSOleg Nesterov 		goto out;
1038d2005e3fSOleg Nesterov 
103986039bd3SAndrea Arcangeli 	down_write(&mm->mmap_sem);
104086039bd3SAndrea Arcangeli 	vma = find_vma_prev(mm, start, &prev);
104186039bd3SAndrea Arcangeli 	if (!vma)
104286039bd3SAndrea Arcangeli 		goto out_unlock;
104386039bd3SAndrea Arcangeli 
104486039bd3SAndrea Arcangeli 	/* check that there's at least one vma in the range */
104586039bd3SAndrea Arcangeli 	ret = -EINVAL;
104686039bd3SAndrea Arcangeli 	if (vma->vm_start >= end)
104786039bd3SAndrea Arcangeli 		goto out_unlock;
104886039bd3SAndrea Arcangeli 
104986039bd3SAndrea Arcangeli 	/*
105086039bd3SAndrea Arcangeli 	 * Search for not compatible vmas.
105186039bd3SAndrea Arcangeli 	 *
105286039bd3SAndrea Arcangeli 	 * FIXME: this shall be relaxed later so that it doesn't fail
105386039bd3SAndrea Arcangeli 	 * on tmpfs backed vmas (in addition to the current allowance
105486039bd3SAndrea Arcangeli 	 * on anonymous vmas).
105586039bd3SAndrea Arcangeli 	 */
105686039bd3SAndrea Arcangeli 	found = false;
105786039bd3SAndrea Arcangeli 	ret = -EINVAL;
105886039bd3SAndrea Arcangeli 	for (cur = vma; cur && cur->vm_start < end; cur = cur->vm_next) {
105986039bd3SAndrea Arcangeli 		cond_resched();
106086039bd3SAndrea Arcangeli 
106186039bd3SAndrea Arcangeli 		BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
106286039bd3SAndrea Arcangeli 		       !!(cur->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
106386039bd3SAndrea Arcangeli 
106486039bd3SAndrea Arcangeli 		/*
106586039bd3SAndrea Arcangeli 		 * Check not compatible vmas, not strictly required
106686039bd3SAndrea Arcangeli 		 * here as not compatible vmas cannot have an
106786039bd3SAndrea Arcangeli 		 * userfaultfd_ctx registered on them, but this
106886039bd3SAndrea Arcangeli 		 * provides for more strict behavior to notice
106986039bd3SAndrea Arcangeli 		 * unregistration errors.
107086039bd3SAndrea Arcangeli 		 */
1071a94720bfSAndrea Arcangeli 		if (!vma_is_anonymous(cur))
107286039bd3SAndrea Arcangeli 			goto out_unlock;
107386039bd3SAndrea Arcangeli 
107486039bd3SAndrea Arcangeli 		found = true;
107586039bd3SAndrea Arcangeli 	}
107686039bd3SAndrea Arcangeli 	BUG_ON(!found);
107786039bd3SAndrea Arcangeli 
107886039bd3SAndrea Arcangeli 	if (vma->vm_start < start)
107986039bd3SAndrea Arcangeli 		prev = vma;
108086039bd3SAndrea Arcangeli 
108186039bd3SAndrea Arcangeli 	ret = 0;
108286039bd3SAndrea Arcangeli 	do {
108386039bd3SAndrea Arcangeli 		cond_resched();
108486039bd3SAndrea Arcangeli 
1085a94720bfSAndrea Arcangeli 		BUG_ON(!vma_is_anonymous(vma));
108686039bd3SAndrea Arcangeli 
108786039bd3SAndrea Arcangeli 		/*
108886039bd3SAndrea Arcangeli 		 * Nothing to do: this vma is already registered into this
108986039bd3SAndrea Arcangeli 		 * userfaultfd and with the right tracking mode too.
109086039bd3SAndrea Arcangeli 		 */
109186039bd3SAndrea Arcangeli 		if (!vma->vm_userfaultfd_ctx.ctx)
109286039bd3SAndrea Arcangeli 			goto skip;
109386039bd3SAndrea Arcangeli 
109486039bd3SAndrea Arcangeli 		if (vma->vm_start > start)
109586039bd3SAndrea Arcangeli 			start = vma->vm_start;
109686039bd3SAndrea Arcangeli 		vma_end = min(end, vma->vm_end);
109786039bd3SAndrea Arcangeli 
109886039bd3SAndrea Arcangeli 		new_flags = vma->vm_flags & ~(VM_UFFD_MISSING | VM_UFFD_WP);
109986039bd3SAndrea Arcangeli 		prev = vma_merge(mm, prev, start, vma_end, new_flags,
110086039bd3SAndrea Arcangeli 				 vma->anon_vma, vma->vm_file, vma->vm_pgoff,
110186039bd3SAndrea Arcangeli 				 vma_policy(vma),
110286039bd3SAndrea Arcangeli 				 NULL_VM_UFFD_CTX);
110386039bd3SAndrea Arcangeli 		if (prev) {
110486039bd3SAndrea Arcangeli 			vma = prev;
110586039bd3SAndrea Arcangeli 			goto next;
110686039bd3SAndrea Arcangeli 		}
110786039bd3SAndrea Arcangeli 		if (vma->vm_start < start) {
110886039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, start, 1);
110986039bd3SAndrea Arcangeli 			if (ret)
111086039bd3SAndrea Arcangeli 				break;
111186039bd3SAndrea Arcangeli 		}
111286039bd3SAndrea Arcangeli 		if (vma->vm_end > end) {
111386039bd3SAndrea Arcangeli 			ret = split_vma(mm, vma, end, 0);
111486039bd3SAndrea Arcangeli 			if (ret)
111586039bd3SAndrea Arcangeli 				break;
111686039bd3SAndrea Arcangeli 		}
111786039bd3SAndrea Arcangeli 	next:
111886039bd3SAndrea Arcangeli 		/*
111986039bd3SAndrea Arcangeli 		 * In the vma_merge() successful mprotect-like case 8:
112086039bd3SAndrea Arcangeli 		 * the next vma was merged into the current one and
112186039bd3SAndrea Arcangeli 		 * the current one has not been updated yet.
112286039bd3SAndrea Arcangeli 		 */
112386039bd3SAndrea Arcangeli 		vma->vm_flags = new_flags;
112486039bd3SAndrea Arcangeli 		vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
112586039bd3SAndrea Arcangeli 
112686039bd3SAndrea Arcangeli 	skip:
112786039bd3SAndrea Arcangeli 		prev = vma;
112886039bd3SAndrea Arcangeli 		start = vma->vm_end;
112986039bd3SAndrea Arcangeli 		vma = vma->vm_next;
113086039bd3SAndrea Arcangeli 	} while (vma && vma->vm_start < end);
113186039bd3SAndrea Arcangeli out_unlock:
113286039bd3SAndrea Arcangeli 	up_write(&mm->mmap_sem);
1133d2005e3fSOleg Nesterov 	mmput(mm);
113486039bd3SAndrea Arcangeli out:
113586039bd3SAndrea Arcangeli 	return ret;
113686039bd3SAndrea Arcangeli }
113786039bd3SAndrea Arcangeli 
113886039bd3SAndrea Arcangeli /*
1139ba85c702SAndrea Arcangeli  * userfaultfd_wake may be used in combination with the
1140ba85c702SAndrea Arcangeli  * UFFDIO_*_MODE_DONTWAKE to wakeup userfaults in batches.
114186039bd3SAndrea Arcangeli  */
114286039bd3SAndrea Arcangeli static int userfaultfd_wake(struct userfaultfd_ctx *ctx,
114386039bd3SAndrea Arcangeli 			    unsigned long arg)
114486039bd3SAndrea Arcangeli {
114586039bd3SAndrea Arcangeli 	int ret;
114686039bd3SAndrea Arcangeli 	struct uffdio_range uffdio_wake;
114786039bd3SAndrea Arcangeli 	struct userfaultfd_wake_range range;
114886039bd3SAndrea Arcangeli 	const void __user *buf = (void __user *)arg;
114986039bd3SAndrea Arcangeli 
115086039bd3SAndrea Arcangeli 	ret = -EFAULT;
115186039bd3SAndrea Arcangeli 	if (copy_from_user(&uffdio_wake, buf, sizeof(uffdio_wake)))
115286039bd3SAndrea Arcangeli 		goto out;
115386039bd3SAndrea Arcangeli 
115486039bd3SAndrea Arcangeli 	ret = validate_range(ctx->mm, uffdio_wake.start, uffdio_wake.len);
115586039bd3SAndrea Arcangeli 	if (ret)
115686039bd3SAndrea Arcangeli 		goto out;
115786039bd3SAndrea Arcangeli 
115886039bd3SAndrea Arcangeli 	range.start = uffdio_wake.start;
115986039bd3SAndrea Arcangeli 	range.len = uffdio_wake.len;
116086039bd3SAndrea Arcangeli 
116186039bd3SAndrea Arcangeli 	/*
116286039bd3SAndrea Arcangeli 	 * len == 0 means wake all and we don't want to wake all here,
116386039bd3SAndrea Arcangeli 	 * so check it again to be sure.
116486039bd3SAndrea Arcangeli 	 */
116586039bd3SAndrea Arcangeli 	VM_BUG_ON(!range.len);
116686039bd3SAndrea Arcangeli 
116786039bd3SAndrea Arcangeli 	wake_userfault(ctx, &range);
116886039bd3SAndrea Arcangeli 	ret = 0;
116986039bd3SAndrea Arcangeli 
117086039bd3SAndrea Arcangeli out:
117186039bd3SAndrea Arcangeli 	return ret;
117286039bd3SAndrea Arcangeli }
117386039bd3SAndrea Arcangeli 
1174ad465caeSAndrea Arcangeli static int userfaultfd_copy(struct userfaultfd_ctx *ctx,
1175ad465caeSAndrea Arcangeli 			    unsigned long arg)
1176ad465caeSAndrea Arcangeli {
1177ad465caeSAndrea Arcangeli 	__s64 ret;
1178ad465caeSAndrea Arcangeli 	struct uffdio_copy uffdio_copy;
1179ad465caeSAndrea Arcangeli 	struct uffdio_copy __user *user_uffdio_copy;
1180ad465caeSAndrea Arcangeli 	struct userfaultfd_wake_range range;
1181ad465caeSAndrea Arcangeli 
1182ad465caeSAndrea Arcangeli 	user_uffdio_copy = (struct uffdio_copy __user *) arg;
1183ad465caeSAndrea Arcangeli 
1184ad465caeSAndrea Arcangeli 	ret = -EFAULT;
1185ad465caeSAndrea Arcangeli 	if (copy_from_user(&uffdio_copy, user_uffdio_copy,
1186ad465caeSAndrea Arcangeli 			   /* don't copy "copy" last field */
1187ad465caeSAndrea Arcangeli 			   sizeof(uffdio_copy)-sizeof(__s64)))
1188ad465caeSAndrea Arcangeli 		goto out;
1189ad465caeSAndrea Arcangeli 
1190ad465caeSAndrea Arcangeli 	ret = validate_range(ctx->mm, uffdio_copy.dst, uffdio_copy.len);
1191ad465caeSAndrea Arcangeli 	if (ret)
1192ad465caeSAndrea Arcangeli 		goto out;
1193ad465caeSAndrea Arcangeli 	/*
1194ad465caeSAndrea Arcangeli 	 * double check for wraparound just in case. copy_from_user()
1195ad465caeSAndrea Arcangeli 	 * will later check uffdio_copy.src + uffdio_copy.len to fit
1196ad465caeSAndrea Arcangeli 	 * in the userland range.
1197ad465caeSAndrea Arcangeli 	 */
1198ad465caeSAndrea Arcangeli 	ret = -EINVAL;
1199ad465caeSAndrea Arcangeli 	if (uffdio_copy.src + uffdio_copy.len <= uffdio_copy.src)
1200ad465caeSAndrea Arcangeli 		goto out;
1201ad465caeSAndrea Arcangeli 	if (uffdio_copy.mode & ~UFFDIO_COPY_MODE_DONTWAKE)
1202ad465caeSAndrea Arcangeli 		goto out;
1203d2005e3fSOleg Nesterov 	if (mmget_not_zero(ctx->mm)) {
1204ad465caeSAndrea Arcangeli 		ret = mcopy_atomic(ctx->mm, uffdio_copy.dst, uffdio_copy.src,
1205ad465caeSAndrea Arcangeli 				   uffdio_copy.len);
1206d2005e3fSOleg Nesterov 		mmput(ctx->mm);
1207d2005e3fSOleg Nesterov 	}
1208ad465caeSAndrea Arcangeli 	if (unlikely(put_user(ret, &user_uffdio_copy->copy)))
1209ad465caeSAndrea Arcangeli 		return -EFAULT;
1210ad465caeSAndrea Arcangeli 	if (ret < 0)
1211ad465caeSAndrea Arcangeli 		goto out;
1212ad465caeSAndrea Arcangeli 	BUG_ON(!ret);
1213ad465caeSAndrea Arcangeli 	/* len == 0 would wake all */
1214ad465caeSAndrea Arcangeli 	range.len = ret;
1215ad465caeSAndrea Arcangeli 	if (!(uffdio_copy.mode & UFFDIO_COPY_MODE_DONTWAKE)) {
1216ad465caeSAndrea Arcangeli 		range.start = uffdio_copy.dst;
1217ad465caeSAndrea Arcangeli 		wake_userfault(ctx, &range);
1218ad465caeSAndrea Arcangeli 	}
1219ad465caeSAndrea Arcangeli 	ret = range.len == uffdio_copy.len ? 0 : -EAGAIN;
1220ad465caeSAndrea Arcangeli out:
1221ad465caeSAndrea Arcangeli 	return ret;
1222ad465caeSAndrea Arcangeli }
1223ad465caeSAndrea Arcangeli 
1224ad465caeSAndrea Arcangeli static int userfaultfd_zeropage(struct userfaultfd_ctx *ctx,
1225ad465caeSAndrea Arcangeli 				unsigned long arg)
1226ad465caeSAndrea Arcangeli {
1227ad465caeSAndrea Arcangeli 	__s64 ret;
1228ad465caeSAndrea Arcangeli 	struct uffdio_zeropage uffdio_zeropage;
1229ad465caeSAndrea Arcangeli 	struct uffdio_zeropage __user *user_uffdio_zeropage;
1230ad465caeSAndrea Arcangeli 	struct userfaultfd_wake_range range;
1231ad465caeSAndrea Arcangeli 
1232ad465caeSAndrea Arcangeli 	user_uffdio_zeropage = (struct uffdio_zeropage __user *) arg;
1233ad465caeSAndrea Arcangeli 
1234ad465caeSAndrea Arcangeli 	ret = -EFAULT;
1235ad465caeSAndrea Arcangeli 	if (copy_from_user(&uffdio_zeropage, user_uffdio_zeropage,
1236ad465caeSAndrea Arcangeli 			   /* don't copy "zeropage" last field */
1237ad465caeSAndrea Arcangeli 			   sizeof(uffdio_zeropage)-sizeof(__s64)))
1238ad465caeSAndrea Arcangeli 		goto out;
1239ad465caeSAndrea Arcangeli 
1240ad465caeSAndrea Arcangeli 	ret = validate_range(ctx->mm, uffdio_zeropage.range.start,
1241ad465caeSAndrea Arcangeli 			     uffdio_zeropage.range.len);
1242ad465caeSAndrea Arcangeli 	if (ret)
1243ad465caeSAndrea Arcangeli 		goto out;
1244ad465caeSAndrea Arcangeli 	ret = -EINVAL;
1245ad465caeSAndrea Arcangeli 	if (uffdio_zeropage.mode & ~UFFDIO_ZEROPAGE_MODE_DONTWAKE)
1246ad465caeSAndrea Arcangeli 		goto out;
1247ad465caeSAndrea Arcangeli 
1248d2005e3fSOleg Nesterov 	if (mmget_not_zero(ctx->mm)) {
1249ad465caeSAndrea Arcangeli 		ret = mfill_zeropage(ctx->mm, uffdio_zeropage.range.start,
1250ad465caeSAndrea Arcangeli 				     uffdio_zeropage.range.len);
1251d2005e3fSOleg Nesterov 		mmput(ctx->mm);
1252d2005e3fSOleg Nesterov 	}
1253ad465caeSAndrea Arcangeli 	if (unlikely(put_user(ret, &user_uffdio_zeropage->zeropage)))
1254ad465caeSAndrea Arcangeli 		return -EFAULT;
1255ad465caeSAndrea Arcangeli 	if (ret < 0)
1256ad465caeSAndrea Arcangeli 		goto out;
1257ad465caeSAndrea Arcangeli 	/* len == 0 would wake all */
1258ad465caeSAndrea Arcangeli 	BUG_ON(!ret);
1259ad465caeSAndrea Arcangeli 	range.len = ret;
1260ad465caeSAndrea Arcangeli 	if (!(uffdio_zeropage.mode & UFFDIO_ZEROPAGE_MODE_DONTWAKE)) {
1261ad465caeSAndrea Arcangeli 		range.start = uffdio_zeropage.range.start;
1262ad465caeSAndrea Arcangeli 		wake_userfault(ctx, &range);
1263ad465caeSAndrea Arcangeli 	}
1264ad465caeSAndrea Arcangeli 	ret = range.len == uffdio_zeropage.range.len ? 0 : -EAGAIN;
1265ad465caeSAndrea Arcangeli out:
1266ad465caeSAndrea Arcangeli 	return ret;
1267ad465caeSAndrea Arcangeli }
1268ad465caeSAndrea Arcangeli 
12699cd75c3cSPavel Emelyanov static inline unsigned int uffd_ctx_features(__u64 user_features)
12709cd75c3cSPavel Emelyanov {
12719cd75c3cSPavel Emelyanov 	/*
12729cd75c3cSPavel Emelyanov 	 * For the current set of features the bits just coincide
12739cd75c3cSPavel Emelyanov 	 */
12749cd75c3cSPavel Emelyanov 	return (unsigned int)user_features;
12759cd75c3cSPavel Emelyanov }
12769cd75c3cSPavel Emelyanov 
127786039bd3SAndrea Arcangeli /*
127886039bd3SAndrea Arcangeli  * userland asks for a certain API version and we return which bits
127986039bd3SAndrea Arcangeli  * and ioctl commands are implemented in this kernel for such API
128086039bd3SAndrea Arcangeli  * version or -EINVAL if unknown.
128186039bd3SAndrea Arcangeli  */
128286039bd3SAndrea Arcangeli static int userfaultfd_api(struct userfaultfd_ctx *ctx,
128386039bd3SAndrea Arcangeli 			   unsigned long arg)
128486039bd3SAndrea Arcangeli {
128586039bd3SAndrea Arcangeli 	struct uffdio_api uffdio_api;
128686039bd3SAndrea Arcangeli 	void __user *buf = (void __user *)arg;
128786039bd3SAndrea Arcangeli 	int ret;
1288*65603144SAndrea Arcangeli 	__u64 features;
128986039bd3SAndrea Arcangeli 
129086039bd3SAndrea Arcangeli 	ret = -EINVAL;
129186039bd3SAndrea Arcangeli 	if (ctx->state != UFFD_STATE_WAIT_API)
129286039bd3SAndrea Arcangeli 		goto out;
129386039bd3SAndrea Arcangeli 	ret = -EFAULT;
1294a9b85f94SAndrea Arcangeli 	if (copy_from_user(&uffdio_api, buf, sizeof(uffdio_api)))
129586039bd3SAndrea Arcangeli 		goto out;
1296*65603144SAndrea Arcangeli 	features = uffdio_api.features;
1297*65603144SAndrea Arcangeli 	if (uffdio_api.api != UFFD_API || (features & ~UFFD_API_FEATURES)) {
129886039bd3SAndrea Arcangeli 		memset(&uffdio_api, 0, sizeof(uffdio_api));
129986039bd3SAndrea Arcangeli 		if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
130086039bd3SAndrea Arcangeli 			goto out;
130186039bd3SAndrea Arcangeli 		ret = -EINVAL;
130286039bd3SAndrea Arcangeli 		goto out;
130386039bd3SAndrea Arcangeli 	}
1304*65603144SAndrea Arcangeli 	/* report all available features and ioctls to userland */
1305*65603144SAndrea Arcangeli 	uffdio_api.features = UFFD_API_FEATURES;
130686039bd3SAndrea Arcangeli 	uffdio_api.ioctls = UFFD_API_IOCTLS;
130786039bd3SAndrea Arcangeli 	ret = -EFAULT;
130886039bd3SAndrea Arcangeli 	if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
130986039bd3SAndrea Arcangeli 		goto out;
131086039bd3SAndrea Arcangeli 	ctx->state = UFFD_STATE_RUNNING;
1311*65603144SAndrea Arcangeli 	/* only enable the requested features for this uffd context */
1312*65603144SAndrea Arcangeli 	ctx->features = uffd_ctx_features(features);
131386039bd3SAndrea Arcangeli 	ret = 0;
131486039bd3SAndrea Arcangeli out:
131586039bd3SAndrea Arcangeli 	return ret;
131686039bd3SAndrea Arcangeli }
131786039bd3SAndrea Arcangeli 
131886039bd3SAndrea Arcangeli static long userfaultfd_ioctl(struct file *file, unsigned cmd,
131986039bd3SAndrea Arcangeli 			      unsigned long arg)
132086039bd3SAndrea Arcangeli {
132186039bd3SAndrea Arcangeli 	int ret = -EINVAL;
132286039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = file->private_data;
132386039bd3SAndrea Arcangeli 
1324e6485a47SAndrea Arcangeli 	if (cmd != UFFDIO_API && ctx->state == UFFD_STATE_WAIT_API)
1325e6485a47SAndrea Arcangeli 		return -EINVAL;
1326e6485a47SAndrea Arcangeli 
132786039bd3SAndrea Arcangeli 	switch(cmd) {
132886039bd3SAndrea Arcangeli 	case UFFDIO_API:
132986039bd3SAndrea Arcangeli 		ret = userfaultfd_api(ctx, arg);
133086039bd3SAndrea Arcangeli 		break;
133186039bd3SAndrea Arcangeli 	case UFFDIO_REGISTER:
133286039bd3SAndrea Arcangeli 		ret = userfaultfd_register(ctx, arg);
133386039bd3SAndrea Arcangeli 		break;
133486039bd3SAndrea Arcangeli 	case UFFDIO_UNREGISTER:
133586039bd3SAndrea Arcangeli 		ret = userfaultfd_unregister(ctx, arg);
133686039bd3SAndrea Arcangeli 		break;
133786039bd3SAndrea Arcangeli 	case UFFDIO_WAKE:
133886039bd3SAndrea Arcangeli 		ret = userfaultfd_wake(ctx, arg);
133986039bd3SAndrea Arcangeli 		break;
1340ad465caeSAndrea Arcangeli 	case UFFDIO_COPY:
1341ad465caeSAndrea Arcangeli 		ret = userfaultfd_copy(ctx, arg);
1342ad465caeSAndrea Arcangeli 		break;
1343ad465caeSAndrea Arcangeli 	case UFFDIO_ZEROPAGE:
1344ad465caeSAndrea Arcangeli 		ret = userfaultfd_zeropage(ctx, arg);
1345ad465caeSAndrea Arcangeli 		break;
134686039bd3SAndrea Arcangeli 	}
134786039bd3SAndrea Arcangeli 	return ret;
134886039bd3SAndrea Arcangeli }
134986039bd3SAndrea Arcangeli 
135086039bd3SAndrea Arcangeli #ifdef CONFIG_PROC_FS
135186039bd3SAndrea Arcangeli static void userfaultfd_show_fdinfo(struct seq_file *m, struct file *f)
135286039bd3SAndrea Arcangeli {
135386039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx = f->private_data;
135486039bd3SAndrea Arcangeli 	wait_queue_t *wq;
135586039bd3SAndrea Arcangeli 	struct userfaultfd_wait_queue *uwq;
135686039bd3SAndrea Arcangeli 	unsigned long pending = 0, total = 0;
135786039bd3SAndrea Arcangeli 
135815b726efSAndrea Arcangeli 	spin_lock(&ctx->fault_pending_wqh.lock);
135915b726efSAndrea Arcangeli 	list_for_each_entry(wq, &ctx->fault_pending_wqh.task_list, task_list) {
136086039bd3SAndrea Arcangeli 		uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
136186039bd3SAndrea Arcangeli 		pending++;
136286039bd3SAndrea Arcangeli 		total++;
136386039bd3SAndrea Arcangeli 	}
136415b726efSAndrea Arcangeli 	list_for_each_entry(wq, &ctx->fault_wqh.task_list, task_list) {
136515b726efSAndrea Arcangeli 		uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
136615b726efSAndrea Arcangeli 		total++;
136715b726efSAndrea Arcangeli 	}
136815b726efSAndrea Arcangeli 	spin_unlock(&ctx->fault_pending_wqh.lock);
136986039bd3SAndrea Arcangeli 
137086039bd3SAndrea Arcangeli 	/*
137186039bd3SAndrea Arcangeli 	 * If more protocols will be added, there will be all shown
137286039bd3SAndrea Arcangeli 	 * separated by a space. Like this:
137386039bd3SAndrea Arcangeli 	 *	protocols: aa:... bb:...
137486039bd3SAndrea Arcangeli 	 */
137586039bd3SAndrea Arcangeli 	seq_printf(m, "pending:\t%lu\ntotal:\t%lu\nAPI:\t%Lx:%x:%Lx\n",
13763f602d27SPavel Emelyanov 		   pending, total, UFFD_API, UFFD_API_FEATURES,
137786039bd3SAndrea Arcangeli 		   UFFD_API_IOCTLS|UFFD_API_RANGE_IOCTLS);
137886039bd3SAndrea Arcangeli }
137986039bd3SAndrea Arcangeli #endif
138086039bd3SAndrea Arcangeli 
138186039bd3SAndrea Arcangeli static const struct file_operations userfaultfd_fops = {
138286039bd3SAndrea Arcangeli #ifdef CONFIG_PROC_FS
138386039bd3SAndrea Arcangeli 	.show_fdinfo	= userfaultfd_show_fdinfo,
138486039bd3SAndrea Arcangeli #endif
138586039bd3SAndrea Arcangeli 	.release	= userfaultfd_release,
138686039bd3SAndrea Arcangeli 	.poll		= userfaultfd_poll,
138786039bd3SAndrea Arcangeli 	.read		= userfaultfd_read,
138886039bd3SAndrea Arcangeli 	.unlocked_ioctl = userfaultfd_ioctl,
138986039bd3SAndrea Arcangeli 	.compat_ioctl	= userfaultfd_ioctl,
139086039bd3SAndrea Arcangeli 	.llseek		= noop_llseek,
139186039bd3SAndrea Arcangeli };
139286039bd3SAndrea Arcangeli 
13933004ec9cSAndrea Arcangeli static void init_once_userfaultfd_ctx(void *mem)
13943004ec9cSAndrea Arcangeli {
13953004ec9cSAndrea Arcangeli 	struct userfaultfd_ctx *ctx = (struct userfaultfd_ctx *) mem;
13963004ec9cSAndrea Arcangeli 
13973004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fault_pending_wqh);
13983004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fault_wqh);
13999cd75c3cSPavel Emelyanov 	init_waitqueue_head(&ctx->event_wqh);
14003004ec9cSAndrea Arcangeli 	init_waitqueue_head(&ctx->fd_wqh);
14012c5b7e1bSAndrea Arcangeli 	seqcount_init(&ctx->refile_seq);
14023004ec9cSAndrea Arcangeli }
14033004ec9cSAndrea Arcangeli 
140486039bd3SAndrea Arcangeli /**
140586039bd3SAndrea Arcangeli  * userfaultfd_file_create - Creates an userfaultfd file pointer.
140686039bd3SAndrea Arcangeli  * @flags: Flags for the userfaultfd file.
140786039bd3SAndrea Arcangeli  *
140886039bd3SAndrea Arcangeli  * This function creates an userfaultfd file pointer, w/out installing
140986039bd3SAndrea Arcangeli  * it into the fd table. This is useful when the userfaultfd file is
141086039bd3SAndrea Arcangeli  * used during the initialization of data structures that require
141186039bd3SAndrea Arcangeli  * extra setup after the userfaultfd creation. So the userfaultfd
141286039bd3SAndrea Arcangeli  * creation is split into the file pointer creation phase, and the
141386039bd3SAndrea Arcangeli  * file descriptor installation phase.  In this way races with
141486039bd3SAndrea Arcangeli  * userspace closing the newly installed file descriptor can be
141586039bd3SAndrea Arcangeli  * avoided.  Returns an userfaultfd file pointer, or a proper error
141686039bd3SAndrea Arcangeli  * pointer.
141786039bd3SAndrea Arcangeli  */
141886039bd3SAndrea Arcangeli static struct file *userfaultfd_file_create(int flags)
141986039bd3SAndrea Arcangeli {
142086039bd3SAndrea Arcangeli 	struct file *file;
142186039bd3SAndrea Arcangeli 	struct userfaultfd_ctx *ctx;
142286039bd3SAndrea Arcangeli 
142386039bd3SAndrea Arcangeli 	BUG_ON(!current->mm);
142486039bd3SAndrea Arcangeli 
142586039bd3SAndrea Arcangeli 	/* Check the UFFD_* constants for consistency.  */
142686039bd3SAndrea Arcangeli 	BUILD_BUG_ON(UFFD_CLOEXEC != O_CLOEXEC);
142786039bd3SAndrea Arcangeli 	BUILD_BUG_ON(UFFD_NONBLOCK != O_NONBLOCK);
142886039bd3SAndrea Arcangeli 
142986039bd3SAndrea Arcangeli 	file = ERR_PTR(-EINVAL);
143086039bd3SAndrea Arcangeli 	if (flags & ~UFFD_SHARED_FCNTL_FLAGS)
143186039bd3SAndrea Arcangeli 		goto out;
143286039bd3SAndrea Arcangeli 
143386039bd3SAndrea Arcangeli 	file = ERR_PTR(-ENOMEM);
14343004ec9cSAndrea Arcangeli 	ctx = kmem_cache_alloc(userfaultfd_ctx_cachep, GFP_KERNEL);
143586039bd3SAndrea Arcangeli 	if (!ctx)
143686039bd3SAndrea Arcangeli 		goto out;
143786039bd3SAndrea Arcangeli 
143886039bd3SAndrea Arcangeli 	atomic_set(&ctx->refcount, 1);
143986039bd3SAndrea Arcangeli 	ctx->flags = flags;
14409cd75c3cSPavel Emelyanov 	ctx->features = 0;
144186039bd3SAndrea Arcangeli 	ctx->state = UFFD_STATE_WAIT_API;
144286039bd3SAndrea Arcangeli 	ctx->released = false;
144386039bd3SAndrea Arcangeli 	ctx->mm = current->mm;
144486039bd3SAndrea Arcangeli 	/* prevent the mm struct to be freed */
1445d2005e3fSOleg Nesterov 	atomic_inc(&ctx->mm->mm_count);
144686039bd3SAndrea Arcangeli 
144786039bd3SAndrea Arcangeli 	file = anon_inode_getfile("[userfaultfd]", &userfaultfd_fops, ctx,
144886039bd3SAndrea Arcangeli 				  O_RDWR | (flags & UFFD_SHARED_FCNTL_FLAGS));
1449c03e946fSEric Biggers 	if (IS_ERR(file)) {
1450d2005e3fSOleg Nesterov 		mmdrop(ctx->mm);
14513004ec9cSAndrea Arcangeli 		kmem_cache_free(userfaultfd_ctx_cachep, ctx);
1452c03e946fSEric Biggers 	}
145386039bd3SAndrea Arcangeli out:
145486039bd3SAndrea Arcangeli 	return file;
145586039bd3SAndrea Arcangeli }
145686039bd3SAndrea Arcangeli 
145786039bd3SAndrea Arcangeli SYSCALL_DEFINE1(userfaultfd, int, flags)
145886039bd3SAndrea Arcangeli {
145986039bd3SAndrea Arcangeli 	int fd, error;
146086039bd3SAndrea Arcangeli 	struct file *file;
146186039bd3SAndrea Arcangeli 
146286039bd3SAndrea Arcangeli 	error = get_unused_fd_flags(flags & UFFD_SHARED_FCNTL_FLAGS);
146386039bd3SAndrea Arcangeli 	if (error < 0)
146486039bd3SAndrea Arcangeli 		return error;
146586039bd3SAndrea Arcangeli 	fd = error;
146686039bd3SAndrea Arcangeli 
146786039bd3SAndrea Arcangeli 	file = userfaultfd_file_create(flags);
146886039bd3SAndrea Arcangeli 	if (IS_ERR(file)) {
146986039bd3SAndrea Arcangeli 		error = PTR_ERR(file);
147086039bd3SAndrea Arcangeli 		goto err_put_unused_fd;
147186039bd3SAndrea Arcangeli 	}
147286039bd3SAndrea Arcangeli 	fd_install(fd, file);
147386039bd3SAndrea Arcangeli 
147486039bd3SAndrea Arcangeli 	return fd;
147586039bd3SAndrea Arcangeli 
147686039bd3SAndrea Arcangeli err_put_unused_fd:
147786039bd3SAndrea Arcangeli 	put_unused_fd(fd);
147886039bd3SAndrea Arcangeli 
147986039bd3SAndrea Arcangeli 	return error;
148086039bd3SAndrea Arcangeli }
14813004ec9cSAndrea Arcangeli 
14823004ec9cSAndrea Arcangeli static int __init userfaultfd_init(void)
14833004ec9cSAndrea Arcangeli {
14843004ec9cSAndrea Arcangeli 	userfaultfd_ctx_cachep = kmem_cache_create("userfaultfd_ctx_cache",
14853004ec9cSAndrea Arcangeli 						sizeof(struct userfaultfd_ctx),
14863004ec9cSAndrea Arcangeli 						0,
14873004ec9cSAndrea Arcangeli 						SLAB_HWCACHE_ALIGN|SLAB_PANIC,
14883004ec9cSAndrea Arcangeli 						init_once_userfaultfd_ctx);
14893004ec9cSAndrea Arcangeli 	return 0;
14903004ec9cSAndrea Arcangeli }
14913004ec9cSAndrea Arcangeli __initcall(userfaultfd_init);
1492