fs/userfaultfd.c

   1 /*
   2  *  fs/userfaultfd.c
   3  *
   4  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
   5  *  Copyright (C) 2008-2009 Red Hat, Inc.
   6  *  Copyright (C) 2015  Red Hat, Inc.
   7  *
   8  *  This work is licensed under the terms of the GNU GPL, version 2. See
   9  *  the COPYING file in the top-level directory.
  10  *
  11  *  Some part derived from fs/eventfd.c (anon inode setup) and
  12  *  mm/ksm.c (mm hashing).
  13  */
  14
  15 #include <linux/hashtable.h>
  16 #include <linux/sched.h>
  17 #include <linux/mm.h>
  18 #include <linux/poll.h>
  19 #include <linux/slab.h>
  20 #include <linux/seq_file.h>
  21 #include <linux/file.h>
  22 #include <linux/bug.h>
  23 #include <linux/anon_inodes.h>
  24 #include <linux/syscalls.h>
  25 #include <linux/userfaultfd_k.h>
  26 #include <linux/mempolicy.h>
  27 #include <linux/ioctl.h>
  28 #include <linux/security.h>
  29
  30 static struct kmem_cache *userfaultfd_ctx_cachep __read_mostly;
  31
  32 enum userfaultfd_state {
  33         UFFD_STATE_WAIT_API,
  34         UFFD_STATE_RUNNING,
  35 };
  36
  37 /*
  38  * Start with fault_pending_wqh and fault_wqh so they're more likely
  39  * to be in the same cacheline.
  40  */
  41 struct userfaultfd_ctx {
  42         /* waitqueue head for the pending (i.e. not read) userfaults */
  43         wait_queue_head_t fault_pending_wqh;
  44         /* waitqueue head for the userfaults */
  45         wait_queue_head_t fault_wqh;
  46         /* waitqueue head for the pseudo fd to wakeup poll/read */
  47         wait_queue_head_t fd_wqh;
  48         /* a refile sequence protected by fault_pending_wqh lock */
  49         struct seqcount refile_seq;
  50         /* pseudo fd refcounting */
  51         atomic_t refcount;
  52         /* userfaultfd syscall flags */
  53         unsigned int flags;
  54         /* state machine */
  55         enum userfaultfd_state state;
  56         /* released */
  57         bool released;
  58         /* mm with one ore more vmas attached to this userfaultfd_ctx */
  59         struct mm_struct *mm;
  60 };
  61
  62 struct userfaultfd_wait_queue {
  63         struct uffd_msg msg;
  64         wait_queue_t wq;
  65         struct userfaultfd_ctx *ctx;
  66 };
  67
  68 struct userfaultfd_wake_range {
  69         unsigned long start;
  70         unsigned long len;
  71 };
  72
  73 static int userfaultfd_wake_function(wait_queue_t *wq, unsigned mode,
  74                                      int wake_flags, void *key)
  75 {
  76         struct userfaultfd_wake_range *range = key;
  77         int ret;
  78         struct userfaultfd_wait_queue *uwq;
  79         unsigned long start, len;
  80
  81         uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
  82         ret = 0;
  83         /* len == 0 means wake all */
  84         start = range->start;
  85         len = range->len;
  86         if (len && (start > uwq->msg.arg.pagefault.address ||
  87                     start + len <= uwq->msg.arg.pagefault.address))
  88                 goto out;
  89         ret = wake_up_state(wq->private, mode);
  90         if (ret)
  91                 /*
  92                  * Wake only once, autoremove behavior.
  93                  *
  94                  * After the effect of list_del_init is visible to the
  95                  * other CPUs, the waitqueue may disappear from under
  96                  * us, see the !list_empty_careful() in
  97                  * handle_userfault(). try_to_wake_up() has an
  98                  * implicit smp_mb__before_spinlock, and the
  99                  * wq->private is read before calling the extern
 100                  * function "wake_up_state" (which in turns calls
 101                  * try_to_wake_up). While the spin_lock;spin_unlock;
 102                  * wouldn't be enough, the smp_mb__before_spinlock is
 103                  * enough to avoid an explicit smp_mb() here.
 104                  */
 105                 list_del_init(&wq->task_list);
 106 out:
 107         return ret;
 108 }
 109
 110 /**
 111  * userfaultfd_ctx_get - Acquires a reference to the internal userfaultfd
 112  * context.
 113  * @ctx: [in] Pointer to the userfaultfd context.
 114  *
 115  * Returns: In case of success, returns not zero.
 116  */
 117 static void userfaultfd_ctx_get(struct userfaultfd_ctx *ctx)
 118 {
 119         if (!atomic_inc_not_zero(&ctx->refcount))
 120                 BUG();
 121 }
 122
 123 /**
 124  * userfaultfd_ctx_put - Releases a reference to the internal userfaultfd
 125  * context.
 126  * @ctx: [in] Pointer to userfaultfd context.
 127  *
 128  * The userfaultfd context reference must have been previously acquired either
 129  * with userfaultfd_ctx_get() or userfaultfd_ctx_fdget().
 130  */
 131 static void userfaultfd_ctx_put(struct userfaultfd_ctx *ctx)
 132 {
 133         if (atomic_dec_and_test(&ctx->refcount)) {
 134                 VM_BUG_ON(spin_is_locked(&ctx->fault_pending_wqh.lock));
 135                 VM_BUG_ON(waitqueue_active(&ctx->fault_pending_wqh));
 136                 VM_BUG_ON(spin_is_locked(&ctx->fault_wqh.lock));
 137                 VM_BUG_ON(waitqueue_active(&ctx->fault_wqh));
 138                 VM_BUG_ON(spin_is_locked(&ctx->fd_wqh.lock));
 139                 VM_BUG_ON(waitqueue_active(&ctx->fd_wqh));
 140                 mmdrop(ctx->mm);
 141                 kmem_cache_free(userfaultfd_ctx_cachep, ctx);
 142         }
 143 }
 144
 145 static inline void msg_init(struct uffd_msg *msg)
 146 {
 147         BUILD_BUG_ON(sizeof(struct uffd_msg) != 32);
 148         /*
 149          * Must use memset to zero out the paddings or kernel data is
 150          * leaked to userland.
 151          */
 152         memset(msg, 0, sizeof(struct uffd_msg));
 153 }
 154
 155 static inline struct uffd_msg userfault_msg(unsigned long address,
 156                                             unsigned int flags,
 157                                             unsigned long reason)
 158 {
 159         struct uffd_msg msg;
 160         msg_init(&msg);
 161         msg.event = UFFD_EVENT_PAGEFAULT;
 162         msg.arg.pagefault.address = address;
 163         if (flags & FAULT_FLAG_WRITE)
 164                 /*
 165                  * If UFFD_FEATURE_PAGEFAULT_FLAG_WRITE was set in the
 166                  * uffdio_api.features and UFFD_PAGEFAULT_FLAG_WRITE
 167                  * was not set in a UFFD_EVENT_PAGEFAULT, it means it
 168                  * was a read fault, otherwise if set it means it's
 169                  * a write fault.
 170                  */
 171                 msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WRITE;
 172         if (reason & VM_UFFD_WP)
 173                 /*
 174                  * If UFFD_FEATURE_PAGEFAULT_FLAG_WP was set in the
 175                  * uffdio_api.features and UFFD_PAGEFAULT_FLAG_WP was
 176                  * not set in a UFFD_EVENT_PAGEFAULT, it means it was
 177                  * a missing fault, otherwise if set it means it's a
 178                  * write protect fault.
 179                  */
 180                 msg.arg.pagefault.flags |= UFFD_PAGEFAULT_FLAG_WP;
 181         return msg;
 182 }
 183
 184 /*
 185  * Verify the pagetables are still not ok after having reigstered into
 186  * the fault_pending_wqh to avoid userland having to UFFDIO_WAKE any
 187  * userfault that has already been resolved, if userfaultfd_read and
 188  * UFFDIO_COPY|ZEROPAGE are being run simultaneously on two different
 189  * threads.
 190  */
 191 static inline bool userfaultfd_must_wait(struct userfaultfd_ctx *ctx,
 192                                          unsigned long address,
 193                                          unsigned long flags,
 194                                          unsigned long reason)
 195 {
 196         struct mm_struct *mm = ctx->mm;
 197         pgd_t *pgd;
 198         pud_t *pud;
 199         pmd_t *pmd, _pmd;
 200         pte_t *pte;
 201         bool ret = true;
 202
 203         VM_BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
 204
 205         pgd = pgd_offset(mm, address);
 206         if (!pgd_present(*pgd))
 207                 goto out;
 208         pud = pud_offset(pgd, address);
 209         if (!pud_present(*pud))
 210                 goto out;
 211         pmd = pmd_offset(pud, address);
 212         /*
 213          * READ_ONCE must function as a barrier with narrower scope
 214          * and it must be equivalent to:
 215          *      _pmd = *pmd; barrier();
 216          *
 217          * This is to deal with the instability (as in
 218          * pmd_trans_unstable) of the pmd.
 219          */
 220         _pmd = READ_ONCE(*pmd);
 221         if (!pmd_present(_pmd))
 222                 goto out;
 223
 224         ret = false;
 225         if (pmd_trans_huge(_pmd))
 226                 goto out;
 227
 228         /*
 229          * the pmd is stable (as in !pmd_trans_unstable) so we can re-read it
 230          * and use the standard pte_offset_map() instead of parsing _pmd.
 231          */
 232         pte = pte_offset_map(pmd, address);
 233         /*
 234          * Lockless access: we're in a wait_event so it's ok if it
 235          * changes under us.
 236          */
 237         if (pte_none(*pte))
 238                 ret = true;
 239         pte_unmap(pte);
 240
 241 out:
 242         return ret;
 243 }
 244
 245 /*
 246  * The locking rules involved in returning VM_FAULT_RETRY depending on
 247  * FAULT_FLAG_ALLOW_RETRY, FAULT_FLAG_RETRY_NOWAIT and
 248  * FAULT_FLAG_KILLABLE are not straightforward. The "Caution"
 249  * recommendation in __lock_page_or_retry is not an understatement.
 250  *
 251  * If FAULT_FLAG_ALLOW_RETRY is set, the mmap_sem must be released
 252  * before returning VM_FAULT_RETRY only if FAULT_FLAG_RETRY_NOWAIT is
 253  * not set.
 254  *
 255  * If FAULT_FLAG_ALLOW_RETRY is set but FAULT_FLAG_KILLABLE is not
 256  * set, VM_FAULT_RETRY can still be returned if and only if there are
 257  * fatal_signal_pending()s, and the mmap_sem must be released before
 258  * returning it.
 259  */
 260 int handle_userfault(struct vm_area_struct *vma, unsigned long address,
 261                      unsigned int flags, unsigned long reason)
 262 {
 263         struct mm_struct *mm = vma->vm_mm;
 264         struct userfaultfd_ctx *ctx;
 265         struct userfaultfd_wait_queue uwq;
 266         int ret;
 267         bool must_wait, return_to_userland;
 268
 269         BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
 270
 271         ret = VM_FAULT_SIGBUS;
 272         ctx = vma->vm_userfaultfd_ctx.ctx;
 273         if (!ctx)
 274                 goto out;
 275
 276         BUG_ON(ctx->mm != mm);
 277
 278         VM_BUG_ON(reason & ~(VM_UFFD_MISSING|VM_UFFD_WP));
 279         VM_BUG_ON(!(reason & VM_UFFD_MISSING) ^ !!(reason & VM_UFFD_WP));
 280
 281         /*
 282          * If it's already released don't get it. This avoids to loop
 283          * in __get_user_pages if userfaultfd_release waits on the
 284          * caller of handle_userfault to release the mmap_sem.
 285          */
 286         if (unlikely(ACCESS_ONCE(ctx->released)))
 287                 goto out;
 288
 289         /*
 290          * We don't do userfault handling for the final child pid update.
 291          */
 292         if (current->flags & PF_EXITING)
 293                 goto out;
 294
 295         /*
 296          * Check that we can return VM_FAULT_RETRY.
 297          *
 298          * NOTE: it should become possible to return VM_FAULT_RETRY
 299          * even if FAULT_FLAG_TRIED is set without leading to gup()
 300          * -EBUSY failures, if the userfaultfd is to be extended for
 301          * VM_UFFD_WP tracking and we intend to arm the userfault
 302          * without first stopping userland access to the memory. For
 303          * VM_UFFD_MISSING userfaults this is enough for now.
 304          */
 305         if (unlikely(!(flags & FAULT_FLAG_ALLOW_RETRY))) {
 306                 /*
 307                  * Validate the invariant that nowait must allow retry
 308                  * to be sure not to return SIGBUS erroneously on
 309                  * nowait invocations.
 310                  */
 311                 BUG_ON(flags & FAULT_FLAG_RETRY_NOWAIT);
 312 #ifdef CONFIG_DEBUG_VM
 313                 if (printk_ratelimit()) {
 314                         printk(KERN_WARNING
 315                                "FAULT_FLAG_ALLOW_RETRY missing %x\n", flags);
 316                         dump_stack();
 317                 }
 318 #endif
 319                 goto out;
 320         }
 321
 322         /*
 323          * Handle nowait, not much to do other than tell it to retry
 324          * and wait.
 325          */
 326         ret = VM_FAULT_RETRY;
 327         if (flags & FAULT_FLAG_RETRY_NOWAIT)
 328                 goto out;
 329
 330         /* take the reference before dropping the mmap_sem */
 331         userfaultfd_ctx_get(ctx);
 332
 333         init_waitqueue_func_entry(&uwq.wq, userfaultfd_wake_function);
 334         uwq.wq.private = current;
 335         uwq.msg = userfault_msg(address, flags, reason);
 336         uwq.ctx = ctx;
 337
 338         return_to_userland = (flags & (FAULT_FLAG_USER|FAULT_FLAG_KILLABLE)) ==
 339                 (FAULT_FLAG_USER|FAULT_FLAG_KILLABLE);
 340
 341         spin_lock(&ctx->fault_pending_wqh.lock);
 342         /*
 343          * After the __add_wait_queue the uwq is visible to userland
 344          * through poll/read().
 345          */
 346         __add_wait_queue(&ctx->fault_pending_wqh, &uwq.wq);
 347         /*
 348          * The smp_mb() after __set_current_state prevents the reads
 349          * following the spin_unlock to happen before the list_add in
 350          * __add_wait_queue.
 351          */
 352         set_current_state(return_to_userland ? TASK_INTERRUPTIBLE :
 353                           TASK_KILLABLE);
 354         spin_unlock(&ctx->fault_pending_wqh.lock);
 355
 356         must_wait = userfaultfd_must_wait(ctx, address, flags, reason);
 357         up_read(&mm->mmap_sem);
 358
 359         if (likely(must_wait && !ACCESS_ONCE(ctx->released) &&
 360                    (return_to_userland ? !signal_pending(current) :
 361                     !fatal_signal_pending(current)))) {
 362                 wake_up_poll(&ctx->fd_wqh, POLLIN);
 363                 schedule();
 364                 ret |= VM_FAULT_MAJOR;
 365         }
 366
 367         __set_current_state(TASK_RUNNING);
 368
 369         if (return_to_userland) {
 370                 if (signal_pending(current) &&
 371                     !fatal_signal_pending(current)) {
 372                         /*
 373                          * If we got a SIGSTOP or SIGCONT and this is
 374                          * a normal userland page fault, just let
 375                          * userland return so the signal will be
 376                          * handled and gdb debugging works.  The page
 377                          * fault code immediately after we return from
 378                          * this function is going to release the
 379                          * mmap_sem and it's not depending on it
 380                          * (unlike gup would if we were not to return
 381                          * VM_FAULT_RETRY).
 382                          *
 383                          * If a fatal signal is pending we still take
 384                          * the streamlined VM_FAULT_RETRY failure path
 385                          * and there's no need to retake the mmap_sem
 386                          * in such case.
 387                          */
 388                         down_read(&mm->mmap_sem);
 389                         ret = VM_FAULT_NOPAGE;
 390                 }
 391         }
 392
 393         /*
 394          * Here we race with the list_del; list_add in
 395          * userfaultfd_ctx_read(), however because we don't ever run
 396          * list_del_init() to refile across the two lists, the prev
 397          * and next pointers will never point to self. list_add also
 398          * would never let any of the two pointers to point to
 399          * self. So list_empty_careful won't risk to see both pointers
 400          * pointing to self at any time during the list refile. The
 401          * only case where list_del_init() is called is the full
 402          * removal in the wake function and there we don't re-list_add
 403          * and it's fine not to block on the spinlock. The uwq on this
 404          * kernel stack can be released after the list_del_init.
 405          */
 406         if (!list_empty_careful(&uwq.wq.task_list)) {
 407                 spin_lock(&ctx->fault_pending_wqh.lock);
 408                 /*
 409                  * No need of list_del_init(), the uwq on the stack
 410                  * will be freed shortly anyway.
 411                  */
 412                 list_del(&uwq.wq.task_list);
 413                 spin_unlock(&ctx->fault_pending_wqh.lock);
 414         }
 415
 416         /*
 417          * ctx may go away after this if the userfault pseudo fd is
 418          * already released.
 419          */
 420         userfaultfd_ctx_put(ctx);
 421
 422 out:
 423         return ret;
 424 }
 425
 426 static int userfaultfd_release(struct inode *inode, struct file *file)
 427 {
 428         struct userfaultfd_ctx *ctx = file->private_data;
 429         struct mm_struct *mm = ctx->mm;
 430         struct vm_area_struct *vma, *prev;
 431         /* len == 0 means wake all */
 432         struct userfaultfd_wake_range range = { .len = 0, };
 433         unsigned long new_flags;
 434
 435         ACCESS_ONCE(ctx->released) = true;
 436
 437         if (!mmget_not_zero(mm))
 438                 goto wakeup;
 439
 440         /*
 441          * Flush page faults out of all CPUs. NOTE: all page faults
 442          * must be retried without returning VM_FAULT_SIGBUS if
 443          * userfaultfd_ctx_get() succeeds but vma->vma_userfault_ctx
 444          * changes while handle_userfault released the mmap_sem. So
 445          * it's critical that released is set to true (above), before
 446          * taking the mmap_sem for writing.
 447          */
 448         down_write(&mm->mmap_sem);
 449         prev = NULL;
 450         for (vma = mm->mmap; vma; vma = vma->vm_next) {
 451                 cond_resched();
 452                 BUG_ON(!!vma->vm_userfaultfd_ctx.ctx ^
 453                        !!(vma->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
 454                 if (vma->vm_userfaultfd_ctx.ctx != ctx) {
 455                         prev = vma;
 456                         continue;
 457                 }
 458                 new_flags = vma->vm_flags & ~(VM_UFFD_MISSING | VM_UFFD_WP);
 459                 prev = vma_merge(mm, prev, vma->vm_start, vma->vm_end,
 460                                  new_flags, vma->anon_vma,
 461                                  vma->vm_file, vma->vm_pgoff,
 462                                  vma_policy(vma),
 463                                  NULL_VM_UFFD_CTX,
 464                                  vma_get_anon_name(vma));
 465                 if (prev)
 466                         vma = prev;
 467                 else
 468                         prev = vma;
 469                 vma->vm_flags = new_flags;
 470                 vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
 471         }
 472         up_write(&mm->mmap_sem);
 473         mmput(mm);
 474 wakeup:
 475         /*
 476          * After no new page faults can wait on this fault_*wqh, flush
 477          * the last page faults that may have been already waiting on
 478          * the fault_*wqh.
 479          */
 480         spin_lock(&ctx->fault_pending_wqh.lock);
 481         __wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL, &range);
 482         __wake_up_locked_key(&ctx->fault_wqh, TASK_NORMAL, &range);
 483         spin_unlock(&ctx->fault_pending_wqh.lock);
 484
 485         wake_up_poll(&ctx->fd_wqh, POLLHUP);
 486         userfaultfd_ctx_put(ctx);
 487         return 0;
 488 }
 489
 490 /* fault_pending_wqh.lock must be hold by the caller */
 491 static inline struct userfaultfd_wait_queue *find_userfault(
 492         struct userfaultfd_ctx *ctx)
 493 {
 494         wait_queue_t *wq;
 495         struct userfaultfd_wait_queue *uwq;
 496
 497         VM_BUG_ON(!spin_is_locked(&ctx->fault_pending_wqh.lock));
 498
 499         uwq = NULL;
 500         if (!waitqueue_active(&ctx->fault_pending_wqh))
 501                 goto out;
 502         /* walk in reverse to provide FIFO behavior to read userfaults */
 503         wq = list_last_entry(&ctx->fault_pending_wqh.task_list,
 504                              typeof(*wq), task_list);
 505         uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
 506 out:
 507         return uwq;
 508 }
 509
 510 static unsigned int userfaultfd_poll(struct file *file, poll_table *wait)
 511 {
 512         struct userfaultfd_ctx *ctx = file->private_data;
 513         unsigned int ret;
 514
 515         poll_wait(file, &ctx->fd_wqh, wait);
 516
 517         switch (ctx->state) {
 518         case UFFD_STATE_WAIT_API:
 519                 return POLLERR;
 520         case UFFD_STATE_RUNNING:
 521                 /*
 522                  * poll() never guarantees that read won't block.
 523                  * userfaults can be waken before they're read().
 524                  */
 525                 if (unlikely(!(file->f_flags & O_NONBLOCK)))
 526                         return POLLERR;
 527                 /*
 528                  * lockless access to see if there are pending faults
 529                  * __pollwait last action is the add_wait_queue but
 530                  * the spin_unlock would allow the waitqueue_active to
 531                  * pass above the actual list_add inside
 532                  * add_wait_queue critical section. So use a full
 533                  * memory barrier to serialize the list_add write of
 534                  * add_wait_queue() with the waitqueue_active read
 535                  * below.
 536                  */
 537                 ret = 0;
 538                 smp_mb();
 539                 if (waitqueue_active(&ctx->fault_pending_wqh))
 540                         ret = POLLIN;
 541                 return ret;
 542         default:
 543                 BUG();
 544         }
 545 }
 546
 547 static ssize_t userfaultfd_ctx_read(struct userfaultfd_ctx *ctx, int no_wait,
 548                                     struct uffd_msg *msg)
 549 {
 550         ssize_t ret;
 551         DECLARE_WAITQUEUE(wait, current);
 552         struct userfaultfd_wait_queue *uwq;
 553
 554         /* always take the fd_wqh lock before the fault_pending_wqh lock */
 555         spin_lock(&ctx->fd_wqh.lock);
 556         __add_wait_queue(&ctx->fd_wqh, &wait);
 557         for (;;) {
 558                 set_current_state(TASK_INTERRUPTIBLE);
 559                 spin_lock(&ctx->fault_pending_wqh.lock);
 560                 uwq = find_userfault(ctx);
 561                 if (uwq) {
 562                         /*
 563                          * Use a seqcount to repeat the lockless check
 564                          * in wake_userfault() to avoid missing
 565                          * wakeups because during the refile both
 566                          * waitqueue could become empty if this is the
 567                          * only userfault.
 568                          */
 569                         write_seqcount_begin(&ctx->refile_seq);
 570
 571                         /*
 572                          * The fault_pending_wqh.lock prevents the uwq
 573                          * to disappear from under us.
 574                          *
 575                          * Refile this userfault from
 576                          * fault_pending_wqh to fault_wqh, it's not
 577                          * pending anymore after we read it.
 578                          *
 579                          * Use list_del() by hand (as
 580                          * userfaultfd_wake_function also uses
 581                          * list_del_init() by hand) to be sure nobody
 582                          * changes __remove_wait_queue() to use
 583                          * list_del_init() in turn breaking the
 584                          * !list_empty_careful() check in
 585                          * handle_userfault(). The uwq->wq.task_list
 586                          * must never be empty at any time during the
 587                          * refile, or the waitqueue could disappear
 588                          * from under us. The "wait_queue_head_t"
 589                          * parameter of __remove_wait_queue() is unused
 590                          * anyway.
 591                          */
 592                         list_del(&uwq->wq.task_list);
 593                         __add_wait_queue(&ctx->fault_wqh, &uwq->wq);
 594
 595                         write_seqcount_end(&ctx->refile_seq);
 596
 597                         /* careful to always initialize msg if ret == 0 */
 598                         *msg = uwq->msg;
 599                         spin_unlock(&ctx->fault_pending_wqh.lock);
 600                         ret = 0;
 601                         break;
 602                 }
 603                 spin_unlock(&ctx->fault_pending_wqh.lock);
 604                 if (signal_pending(current)) {
 605                         ret = -ERESTARTSYS;
 606                         break;
 607                 }
 608                 if (no_wait) {
 609                         ret = -EAGAIN;
 610                         break;
 611                 }
 612                 spin_unlock(&ctx->fd_wqh.lock);
 613                 schedule();
 614                 spin_lock(&ctx->fd_wqh.lock);
 615         }
 616         __remove_wait_queue(&ctx->fd_wqh, &wait);
 617         __set_current_state(TASK_RUNNING);
 618         spin_unlock(&ctx->fd_wqh.lock);
 619
 620         return ret;
 621 }
 622
 623 static ssize_t userfaultfd_read(struct file *file, char __user *buf,
 624                                 size_t count, loff_t *ppos)
 625 {
 626         struct userfaultfd_ctx *ctx = file->private_data;
 627         ssize_t _ret, ret = 0;
 628         struct uffd_msg msg;
 629         int no_wait = file->f_flags & O_NONBLOCK;
 630
 631         if (ctx->state == UFFD_STATE_WAIT_API)
 632                 return -EINVAL;
 633
 634         for (;;) {
 635                 if (count < sizeof(msg))
 636                         return ret ? ret : -EINVAL;
 637                 _ret = userfaultfd_ctx_read(ctx, no_wait, &msg);
 638                 if (_ret < 0)
 639                         return ret ? ret : _ret;
 640                 if (copy_to_user((__u64 __user *) buf, &msg, sizeof(msg)))
 641                         return ret ? ret : -EFAULT;
 642                 ret += sizeof(msg);
 643                 buf += sizeof(msg);
 644                 count -= sizeof(msg);
 645                 /*
 646                  * Allow to read more than one fault at time but only
 647                  * block if waiting for the very first one.
 648                  */
 649                 no_wait = O_NONBLOCK;
 650         }
 651 }
 652
 653 static void __wake_userfault(struct userfaultfd_ctx *ctx,
 654                              struct userfaultfd_wake_range *range)
 655 {
 656         unsigned long start, end;
 657
 658         start = range->start;
 659         end = range->start + range->len;
 660
 661         spin_lock(&ctx->fault_pending_wqh.lock);
 662         /* wake all in the range and autoremove */
 663         if (waitqueue_active(&ctx->fault_pending_wqh))
 664                 __wake_up_locked_key(&ctx->fault_pending_wqh, TASK_NORMAL,
 665                                      range);
 666         if (waitqueue_active(&ctx->fault_wqh))
 667                 __wake_up_locked_key(&ctx->fault_wqh, TASK_NORMAL, range);
 668         spin_unlock(&ctx->fault_pending_wqh.lock);
 669 }
 670
 671 static __always_inline void wake_userfault(struct userfaultfd_ctx *ctx,
 672                                            struct userfaultfd_wake_range *range)
 673 {
 674         unsigned seq;
 675         bool need_wakeup;
 676
 677         /*
 678          * To be sure waitqueue_active() is not reordered by the CPU
 679          * before the pagetable update, use an explicit SMP memory
 680          * barrier here. PT lock release or up_read(mmap_sem) still
 681          * have release semantics that can allow the
 682          * waitqueue_active() to be reordered before the pte update.
 683          */
 684         smp_mb();
 685
 686         /*
 687          * Use waitqueue_active because it's very frequent to
 688          * change the address space atomically even if there are no
 689          * userfaults yet. So we take the spinlock only when we're
 690          * sure we've userfaults to wake.
 691          */
 692         do {
 693                 seq = read_seqcount_begin(&ctx->refile_seq);
 694                 need_wakeup = waitqueue_active(&ctx->fault_pending_wqh) ||
 695                         waitqueue_active(&ctx->fault_wqh);
 696                 cond_resched();
 697         } while (read_seqcount_retry(&ctx->refile_seq, seq));
 698         if (need_wakeup)
 699                 __wake_userfault(ctx, range);
 700 }
 701
 702 static __always_inline int validate_range(struct mm_struct *mm,
 703                                           __u64 start, __u64 len)
 704 {
 705         __u64 task_size = mm->task_size;
 706
 707         if (start & ~PAGE_MASK)
 708                 return -EINVAL;
 709         if (len & ~PAGE_MASK)
 710                 return -EINVAL;
 711         if (!len)
 712                 return -EINVAL;
 713         if (start < mmap_min_addr)
 714                 return -EINVAL;
 715         if (start >= task_size)
 716                 return -EINVAL;
 717         if (len > task_size - start)
 718                 return -EINVAL;
 719         return 0;
 720 }
 721
 722 static int userfaultfd_register(struct userfaultfd_ctx *ctx,
 723                                 unsigned long arg)
 724 {
 725         struct mm_struct *mm = ctx->mm;
 726         struct vm_area_struct *vma, *prev, *cur;
 727         int ret;
 728         struct uffdio_register uffdio_register;
 729         struct uffdio_register __user *user_uffdio_register;
 730         unsigned long vm_flags, new_flags;
 731         bool found;
 732         unsigned long start, end, vma_end;
 733
 734         user_uffdio_register = (struct uffdio_register __user *) arg;
 735
 736         ret = -EFAULT;
 737         if (copy_from_user(&uffdio_register, user_uffdio_register,
 738                            sizeof(uffdio_register)-sizeof(__u64)))
 739                 goto out;
 740
 741         ret = -EINVAL;
 742         if (!uffdio_register.mode)
 743                 goto out;
 744         if (uffdio_register.mode & ~(UFFDIO_REGISTER_MODE_MISSING|
 745                                      UFFDIO_REGISTER_MODE_WP))
 746                 goto out;
 747         vm_flags = 0;
 748         if (uffdio_register.mode & UFFDIO_REGISTER_MODE_MISSING)
 749                 vm_flags |= VM_UFFD_MISSING;
 750         if (uffdio_register.mode & UFFDIO_REGISTER_MODE_WP) {
 751                 vm_flags |= VM_UFFD_WP;
 752                 /*
 753                  * FIXME: remove the below error constraint by
 754                  * implementing the wprotect tracking mode.
 755                  */
 756                 ret = -EINVAL;
 757                 goto out;
 758         }
 759
 760         ret = validate_range(mm, uffdio_register.range.start,
 761                              uffdio_register.range.len);
 762         if (ret)
 763                 goto out;
 764
 765         start = uffdio_register.range.start;
 766         end = start + uffdio_register.range.len;
 767
 768         ret = -ENOMEM;
 769         if (!mmget_not_zero(mm))
 770                 goto out;
 771
 772         down_write(&mm->mmap_sem);
 773         vma = find_vma_prev(mm, start, &prev);
 774         if (!vma)
 775                 goto out_unlock;
 776
 777         /* check that there's at least one vma in the range */
 778         ret = -EINVAL;
 779         if (vma->vm_start >= end)
 780                 goto out_unlock;
 781
 782         /*
 783          * Search for not compatible vmas.
 784          *
 785          * FIXME: this shall be relaxed later so that it doesn't fail
 786          * on tmpfs backed vmas (in addition to the current allowance
 787          * on anonymous vmas).
 788          */
 789         found = false;
 790         for (cur = vma; cur && cur->vm_start < end; cur = cur->vm_next) {
 791                 cond_resched();
 792
 793                 BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
 794                        !!(cur->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
 795
 796                 /* check not compatible vmas */
 797                 ret = -EINVAL;
 798                 if (cur->vm_ops)
 799                         goto out_unlock;
 800
 801                 /*
 802                  * UFFDIO_COPY will fill file holes even without
 803                  * PROT_WRITE. This check enforces that if this is a
 804                  * MAP_SHARED, the process has write permission to the backing
 805                  * file. If VM_MAYWRITE is set it also enforces that on a
 806                  * MAP_SHARED vma: there is no F_WRITE_SEAL and no further
 807                  * F_WRITE_SEAL can be taken until the vma is destroyed.
 808                  */
 809                 ret = -EPERM;
 810                 if (unlikely(!(cur->vm_flags & VM_MAYWRITE)))
 811                         goto out_unlock;
 812
 813                 /*
 814                  * Check that this vma isn't already owned by a
 815                  * different userfaultfd. We can't allow more than one
 816                  * userfaultfd to own a single vma simultaneously or we
 817                  * wouldn't know which one to deliver the userfaults to.
 818                  */
 819                 ret = -EBUSY;
 820                 if (cur->vm_userfaultfd_ctx.ctx &&
 821                     cur->vm_userfaultfd_ctx.ctx != ctx)
 822                         goto out_unlock;
 823
 824                 found = true;
 825         }
 826         BUG_ON(!found);
 827
 828         if (vma->vm_start < start)
 829                 prev = vma;
 830
 831         ret = 0;
 832         do {
 833                 cond_resched();
 834
 835                 BUG_ON(vma->vm_ops);
 836                 BUG_ON(vma->vm_userfaultfd_ctx.ctx &&
 837                        vma->vm_userfaultfd_ctx.ctx != ctx);
 838                 WARN_ON(!(vma->vm_flags & VM_MAYWRITE));
 839
 840                 /*
 841                  * Nothing to do: this vma is already registered into this
 842                  * userfaultfd and with the right tracking mode too.
 843                  */
 844                 if (vma->vm_userfaultfd_ctx.ctx == ctx &&
 845                     (vma->vm_flags & vm_flags) == vm_flags)
 846                         goto skip;
 847
 848                 if (vma->vm_start > start)
 849                         start = vma->vm_start;
 850                 vma_end = min(end, vma->vm_end);
 851
 852                 new_flags = (vma->vm_flags & ~vm_flags) | vm_flags;
 853                 prev = vma_merge(mm, prev, start, vma_end, new_flags,
 854                                  vma->anon_vma, vma->vm_file, vma->vm_pgoff,
 855                                  vma_policy(vma),
 856                                  ((struct vm_userfaultfd_ctx){ ctx }),
 857                                  vma_get_anon_name(vma));
 858                 if (prev) {
 859                         vma = prev;
 860                         goto next;
 861                 }
 862                 if (vma->vm_start < start) {
 863                         ret = split_vma(mm, vma, start, 1);
 864                         if (ret)
 865                                 break;
 866                 }
 867                 if (vma->vm_end > end) {
 868                         ret = split_vma(mm, vma, end, 0);
 869                         if (ret)
 870                                 break;
 871                 }
 872         next:
 873                 /*
 874                  * In the vma_merge() successful mprotect-like case 8:
 875                  * the next vma was merged into the current one and
 876                  * the current one has not been updated yet.
 877                  */
 878                 vma->vm_flags = new_flags;
 879                 vma->vm_userfaultfd_ctx.ctx = ctx;
 880
 881         skip:
 882                 prev = vma;
 883                 start = vma->vm_end;
 884                 vma = vma->vm_next;
 885         } while (vma && vma->vm_start < end);
 886 out_unlock:
 887         up_write(&mm->mmap_sem);
 888         mmput(mm);
 889         if (!ret) {
 890                 /*
 891                  * Now that we scanned all vmas we can already tell
 892                  * userland which ioctls methods are guaranteed to
 893                  * succeed on this range.
 894                  */
 895                 if (put_user(UFFD_API_RANGE_IOCTLS,
 896                              &user_uffdio_register->ioctls))
 897                         ret = -EFAULT;
 898         }
 899 out:
 900         return ret;
 901 }
 902
 903 static int userfaultfd_unregister(struct userfaultfd_ctx *ctx,
 904                                   unsigned long arg)
 905 {
 906         struct mm_struct *mm = ctx->mm;
 907         struct vm_area_struct *vma, *prev, *cur;
 908         int ret;
 909         struct uffdio_range uffdio_unregister;
 910         unsigned long new_flags;
 911         bool found;
 912         unsigned long start, end, vma_end;
 913         const void __user *buf = (void __user *)arg;
 914
 915         ret = -EFAULT;
 916         if (copy_from_user(&uffdio_unregister, buf, sizeof(uffdio_unregister)))
 917                 goto out;
 918
 919         ret = validate_range(mm, uffdio_unregister.start,
 920                              uffdio_unregister.len);
 921         if (ret)
 922                 goto out;
 923
 924         start = uffdio_unregister.start;
 925         end = start + uffdio_unregister.len;
 926
 927         ret = -ENOMEM;
 928         if (!mmget_not_zero(mm))
 929                 goto out;
 930
 931         down_write(&mm->mmap_sem);
 932         vma = find_vma_prev(mm, start, &prev);
 933         if (!vma)
 934                 goto out_unlock;
 935
 936         /* check that there's at least one vma in the range */
 937         ret = -EINVAL;
 938         if (vma->vm_start >= end)
 939                 goto out_unlock;
 940
 941         /*
 942          * Search for not compatible vmas.
 943          *
 944          * FIXME: this shall be relaxed later so that it doesn't fail
 945          * on tmpfs backed vmas (in addition to the current allowance
 946          * on anonymous vmas).
 947          */
 948         found = false;
 949         ret = -EINVAL;
 950         for (cur = vma; cur && cur->vm_start < end; cur = cur->vm_next) {
 951                 cond_resched();
 952
 953                 BUG_ON(!!cur->vm_userfaultfd_ctx.ctx ^
 954                        !!(cur->vm_flags & (VM_UFFD_MISSING | VM_UFFD_WP)));
 955
 956                 /*
 957                  * Check not compatible vmas, not strictly required
 958                  * here as not compatible vmas cannot have an
 959                  * userfaultfd_ctx registered on them, but this
 960                  * provides for more strict behavior to notice
 961                  * unregistration errors.
 962                  */
 963                 if (cur->vm_ops)
 964                         goto out_unlock;
 965
 966                 found = true;
 967         }
 968         BUG_ON(!found);
 969
 970         if (vma->vm_start < start)
 971                 prev = vma;
 972
 973         ret = 0;
 974         do {
 975                 cond_resched();
 976
 977                 BUG_ON(vma->vm_ops);
 978                 WARN_ON(!(vma->vm_flags & VM_MAYWRITE));
 979
 980                 /*
 981                  * Nothing to do: this vma is already registered into this
 982                  * userfaultfd and with the right tracking mode too.
 983                  */
 984                 if (!vma->vm_userfaultfd_ctx.ctx)
 985                         goto skip;
 986
 987                 if (vma->vm_start > start)
 988                         start = vma->vm_start;
 989                 vma_end = min(end, vma->vm_end);
 990
 991                 new_flags = vma->vm_flags & ~(VM_UFFD_MISSING | VM_UFFD_WP);
 992                 prev = vma_merge(mm, prev, start, vma_end, new_flags,
 993                                  vma->anon_vma, vma->vm_file, vma->vm_pgoff,
 994                                  vma_policy(vma),
 995                                  NULL_VM_UFFD_CTX,
 996                                  vma_get_anon_name(vma));
 997                 if (prev) {
 998                         vma = prev;
 999                         goto next;
1000                 }
1001                 if (vma->vm_start < start) {
1002                         ret = split_vma(mm, vma, start, 1);
1003                         if (ret)
1004                                 break;
1005                 }
1006                 if (vma->vm_end > end) {
1007                         ret = split_vma(mm, vma, end, 0);
1008                         if (ret)
1009                                 break;
1010                 }
1011         next:
1012                 /*
1013                  * In the vma_merge() successful mprotect-like case 8:
1014                  * the next vma was merged into the current one and
1015                  * the current one has not been updated yet.
1016                  */
1017                 vma->vm_flags = new_flags;
1018                 vma->vm_userfaultfd_ctx = NULL_VM_UFFD_CTX;
1019
1020         skip:
1021                 prev = vma;
1022                 start = vma->vm_end;
1023                 vma = vma->vm_next;
1024         } while (vma && vma->vm_start < end);
1025 out_unlock:
1026         up_write(&mm->mmap_sem);
1027         mmput(mm);
1028 out:
1029         return ret;
1030 }
1031
1032 /*
1033  * userfaultfd_wake may be used in combination with the
1034  * UFFDIO_*_MODE_DONTWAKE to wakeup userfaults in batches.
1035  */
1036 static int userfaultfd_wake(struct userfaultfd_ctx *ctx,
1037                             unsigned long arg)
1038 {
1039         int ret;
1040         struct uffdio_range uffdio_wake;
1041         struct userfaultfd_wake_range range;
1042         const void __user *buf = (void __user *)arg;
1043
1044         ret = -EFAULT;
1045         if (copy_from_user(&uffdio_wake, buf, sizeof(uffdio_wake)))
1046                 goto out;
1047
1048         ret = validate_range(ctx->mm, uffdio_wake.start, uffdio_wake.len);
1049         if (ret)
1050                 goto out;
1051
1052         range.start = uffdio_wake.start;
1053         range.len = uffdio_wake.len;
1054
1055         /*
1056          * len == 0 means wake all and we don't want to wake all here,
1057          * so check it again to be sure.
1058          */
1059         VM_BUG_ON(!range.len);
1060
1061         wake_userfault(ctx, &range);
1062         ret = 0;
1063
1064 out:
1065         return ret;
1066 }
1067
1068 static int userfaultfd_copy(struct userfaultfd_ctx *ctx,
1069                             unsigned long arg)
1070 {
1071         __s64 ret;
1072         struct uffdio_copy uffdio_copy;
1073         struct uffdio_copy __user *user_uffdio_copy;
1074         struct userfaultfd_wake_range range;
1075
1076         user_uffdio_copy = (struct uffdio_copy __user *) arg;
1077
1078         ret = -EFAULT;
1079         if (copy_from_user(&uffdio_copy, user_uffdio_copy,
1080                            /* don't copy "copy" last field */
1081                            sizeof(uffdio_copy)-sizeof(__s64)))
1082                 goto out;
1083
1084         ret = validate_range(ctx->mm, uffdio_copy.dst, uffdio_copy.len);
1085         if (ret)
1086                 goto out;
1087         /*
1088          * double check for wraparound just in case. copy_from_user()
1089          * will later check uffdio_copy.src + uffdio_copy.len to fit
1090          * in the userland range.
1091          */
1092         ret = -EINVAL;
1093         if (uffdio_copy.src + uffdio_copy.len <= uffdio_copy.src)
1094                 goto out;
1095         if (uffdio_copy.mode & ~UFFDIO_COPY_MODE_DONTWAKE)
1096                 goto out;
1097         if (mmget_not_zero(ctx->mm)) {
1098                 ret = mcopy_atomic(ctx->mm, uffdio_copy.dst, uffdio_copy.src,
1099                                    uffdio_copy.len);
1100                 mmput(ctx->mm);
1101         }
1102         if (unlikely(put_user(ret, &user_uffdio_copy->copy)))
1103                 return -EFAULT;
1104         if (ret < 0)
1105                 goto out;
1106         BUG_ON(!ret);
1107         /* len == 0 would wake all */
1108         range.len = ret;
1109         if (!(uffdio_copy.mode & UFFDIO_COPY_MODE_DONTWAKE)) {
1110                 range.start = uffdio_copy.dst;
1111                 wake_userfault(ctx, &range);
1112         }
1113         ret = range.len == uffdio_copy.len ? 0 : -EAGAIN;
1114 out:
1115         return ret;
1116 }
1117
1118 static int userfaultfd_zeropage(struct userfaultfd_ctx *ctx,
1119                                 unsigned long arg)
1120 {
1121         __s64 ret;
1122         struct uffdio_zeropage uffdio_zeropage;
1123         struct uffdio_zeropage __user *user_uffdio_zeropage;
1124         struct userfaultfd_wake_range range;
1125
1126         user_uffdio_zeropage = (struct uffdio_zeropage __user *) arg;
1127
1128         ret = -EFAULT;
1129         if (copy_from_user(&uffdio_zeropage, user_uffdio_zeropage,
1130                            /* don't copy "zeropage" last field */
1131                            sizeof(uffdio_zeropage)-sizeof(__s64)))
1132                 goto out;
1133
1134         ret = validate_range(ctx->mm, uffdio_zeropage.range.start,
1135                              uffdio_zeropage.range.len);
1136         if (ret)
1137                 goto out;
1138         ret = -EINVAL;
1139         if (uffdio_zeropage.mode & ~UFFDIO_ZEROPAGE_MODE_DONTWAKE)
1140                 goto out;
1141
1142         if (mmget_not_zero(ctx->mm)) {
1143                 ret = mfill_zeropage(ctx->mm, uffdio_zeropage.range.start,
1144                                      uffdio_zeropage.range.len);
1145                 mmput(ctx->mm);
1146         }
1147         if (unlikely(put_user(ret, &user_uffdio_zeropage->zeropage)))
1148                 return -EFAULT;
1149         if (ret < 0)
1150                 goto out;
1151         /* len == 0 would wake all */
1152         BUG_ON(!ret);
1153         range.len = ret;
1154         if (!(uffdio_zeropage.mode & UFFDIO_ZEROPAGE_MODE_DONTWAKE)) {
1155                 range.start = uffdio_zeropage.range.start;
1156                 wake_userfault(ctx, &range);
1157         }
1158         ret = range.len == uffdio_zeropage.range.len ? 0 : -EAGAIN;
1159 out:
1160         return ret;
1161 }
1162
1163 /*
1164  * userland asks for a certain API version and we return which bits
1165  * and ioctl commands are implemented in this kernel for such API
1166  * version or -EINVAL if unknown.
1167  */
1168 static int userfaultfd_api(struct userfaultfd_ctx *ctx,
1169                            unsigned long arg)
1170 {
1171         struct uffdio_api uffdio_api;
1172         void __user *buf = (void __user *)arg;
1173         int ret;
1174
1175         ret = -EINVAL;
1176         if (ctx->state != UFFD_STATE_WAIT_API)
1177                 goto out;
1178         ret = -EFAULT;
1179         if (copy_from_user(&uffdio_api, buf, sizeof(uffdio_api)))
1180                 goto out;
1181         if (uffdio_api.api != UFFD_API || uffdio_api.features) {
1182                 memset(&uffdio_api, 0, sizeof(uffdio_api));
1183                 if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
1184                         goto out;
1185                 ret = -EINVAL;
1186                 goto out;
1187         }
1188         uffdio_api.features = UFFD_API_FEATURES;
1189         uffdio_api.ioctls = UFFD_API_IOCTLS;
1190         ret = -EFAULT;
1191         if (copy_to_user(buf, &uffdio_api, sizeof(uffdio_api)))
1192                 goto out;
1193         ctx->state = UFFD_STATE_RUNNING;
1194         ret = 0;
1195 out:
1196         return ret;
1197 }
1198
1199 static long userfaultfd_ioctl(struct file *file, unsigned cmd,
1200                               unsigned long arg)
1201 {
1202         int ret = -EINVAL;
1203         struct userfaultfd_ctx *ctx = file->private_data;
1204
1205         if (cmd != UFFDIO_API && ctx->state == UFFD_STATE_WAIT_API)
1206                 return -EINVAL;
1207
1208         switch(cmd) {
1209         case UFFDIO_API:
1210                 ret = userfaultfd_api(ctx, arg);
1211                 break;
1212         case UFFDIO_REGISTER:
1213                 ret = userfaultfd_register(ctx, arg);
1214                 break;
1215         case UFFDIO_UNREGISTER:
1216                 ret = userfaultfd_unregister(ctx, arg);
1217                 break;
1218         case UFFDIO_WAKE:
1219                 ret = userfaultfd_wake(ctx, arg);
1220                 break;
1221         case UFFDIO_COPY:
1222                 ret = userfaultfd_copy(ctx, arg);
1223                 break;
1224         case UFFDIO_ZEROPAGE:
1225                 ret = userfaultfd_zeropage(ctx, arg);
1226                 break;
1227         }
1228         return ret;
1229 }
1230
1231 #ifdef CONFIG_PROC_FS
1232 static void userfaultfd_show_fdinfo(struct seq_file *m, struct file *f)
1233 {
1234         struct userfaultfd_ctx *ctx = f->private_data;
1235         wait_queue_t *wq;
1236         struct userfaultfd_wait_queue *uwq;
1237         unsigned long pending = 0, total = 0;
1238
1239         spin_lock(&ctx->fault_pending_wqh.lock);
1240         list_for_each_entry(wq, &ctx->fault_pending_wqh.task_list, task_list) {
1241                 uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
1242                 pending++;
1243                 total++;
1244         }
1245         list_for_each_entry(wq, &ctx->fault_wqh.task_list, task_list) {
1246                 uwq = container_of(wq, struct userfaultfd_wait_queue, wq);
1247                 total++;
1248         }
1249         spin_unlock(&ctx->fault_pending_wqh.lock);
1250
1251         /*
1252          * If more protocols will be added, there will be all shown
1253          * separated by a space. Like this:
1254          *      protocols: aa:... bb:...
1255          */
1256         seq_printf(m, "pending:\t%lu\ntotal:\t%lu\nAPI:\t%Lx:%x:%Lx\n",
1257                    pending, total, UFFD_API, UFFD_API_FEATURES,
1258                    UFFD_API_IOCTLS|UFFD_API_RANGE_IOCTLS);
1259 }
1260 #endif
1261
1262 static const struct file_operations userfaultfd_fops = {
1263 #ifdef CONFIG_PROC_FS
1264         .show_fdinfo    = userfaultfd_show_fdinfo,
1265 #endif
1266         .release        = userfaultfd_release,
1267         .poll           = userfaultfd_poll,
1268         .read           = userfaultfd_read,
1269         .unlocked_ioctl = userfaultfd_ioctl,
1270         .compat_ioctl   = userfaultfd_ioctl,
1271         .llseek         = noop_llseek,
1272 };
1273
1274 static void init_once_userfaultfd_ctx(void *mem)
1275 {
1276         struct userfaultfd_ctx *ctx = (struct userfaultfd_ctx *) mem;
1277
1278         init_waitqueue_head(&ctx->fault_pending_wqh);
1279         init_waitqueue_head(&ctx->fault_wqh);
1280         init_waitqueue_head(&ctx->fd_wqh);
1281         seqcount_init(&ctx->refile_seq);
1282 }
1283
1284 /**
1285  * userfaultfd_file_create - Creates an userfaultfd file pointer.
1286  * @flags: Flags for the userfaultfd file.
1287  *
1288  * This function creates an userfaultfd file pointer, w/out installing
1289  * it into the fd table. This is useful when the userfaultfd file is
1290  * used during the initialization of data structures that require
1291  * extra setup after the userfaultfd creation. So the userfaultfd
1292  * creation is split into the file pointer creation phase, and the
1293  * file descriptor installation phase.  In this way races with
1294  * userspace closing the newly installed file descriptor can be
1295  * avoided.  Returns an userfaultfd file pointer, or a proper error
1296  * pointer.
1297  */
1298 static struct file *userfaultfd_file_create(int flags)
1299 {
1300         struct file *file;
1301         struct userfaultfd_ctx *ctx;
1302
1303         BUG_ON(!current->mm);
1304
1305         /* Check the UFFD_* constants for consistency.  */
1306         BUILD_BUG_ON(UFFD_CLOEXEC != O_CLOEXEC);
1307         BUILD_BUG_ON(UFFD_NONBLOCK != O_NONBLOCK);
1308
1309         file = ERR_PTR(-EINVAL);
1310         if (flags & ~UFFD_SHARED_FCNTL_FLAGS)
1311                 goto out;
1312
1313         file = ERR_PTR(-ENOMEM);
1314         ctx = kmem_cache_alloc(userfaultfd_ctx_cachep, GFP_KERNEL);
1315         if (!ctx)
1316                 goto out;
1317
1318         atomic_set(&ctx->refcount, 1);
1319         ctx->flags = flags;
1320         ctx->state = UFFD_STATE_WAIT_API;
1321         ctx->released = false;
1322         ctx->mm = current->mm;
1323         /* prevent the mm struct to be freed */
1324         atomic_inc(&ctx->mm->mm_count);
1325
1326         file = anon_inode_getfile("[userfaultfd]", &userfaultfd_fops, ctx,
1327                                   O_RDWR | (flags & UFFD_SHARED_FCNTL_FLAGS));
1328         if (IS_ERR(file)) {
1329                 mmdrop(ctx->mm);
1330                 kmem_cache_free(userfaultfd_ctx_cachep, ctx);
1331         }
1332 out:
1333         return file;
1334 }
1335
1336 SYSCALL_DEFINE1(userfaultfd, int, flags)
1337 {
1338         int fd, error;
1339         struct file *file;
1340
1341         error = get_unused_fd_flags(flags & UFFD_SHARED_FCNTL_FLAGS);
1342         if (error < 0)
1343                 return error;
1344         fd = error;
1345
1346         file = userfaultfd_file_create(flags);
1347         if (IS_ERR(file)) {
1348                 error = PTR_ERR(file);
1349                 goto err_put_unused_fd;
1350         }
1351         fd_install(fd, file);
1352
1353         return fd;
1354
1355 err_put_unused_fd:
1356         put_unused_fd(fd);
1357
1358         return error;
1359 }
1360
1361 static int __init userfaultfd_init(void)
1362 {
1363         userfaultfd_ctx_cachep = kmem_cache_create("userfaultfd_ctx_cache",
1364                                                 sizeof(struct userfaultfd_ctx),
1365                                                 0,
1366                                                 SLAB_HWCACHE_ALIGN|SLAB_PANIC,
1367                                                 init_once_userfaultfd_ctx);
1368         return 0;
1369 }
1370 __initcall(userfaultfd_init);