mm/gup.c

   1 #include <linux/kernel.h>
   2 #include <linux/errno.h>
   3 #include <linux/err.h>
   4 #include <linux/spinlock.h>
   5
   6 #include <linux/mm.h>
   7 #include <linux/pagemap.h>
   8 #include <linux/rmap.h>
   9 #include <linux/swap.h>
  10 #include <linux/swapops.h>
  11
  12 #include <linux/sched.h>
  13 #include <linux/rwsem.h>
  14 #include <linux/hugetlb.h>
  15
  16 #include <asm/pgtable.h>
  17 #include <asm/tlbflush.h>
  18
  19 #include "internal.h"
  20
  21 static struct page *no_page_table(struct vm_area_struct *vma,
  22                 unsigned int flags)
  23 {
  24         /*
  25          * When core dumping an enormous anonymous area that nobody
  26          * has touched so far, we don't want to allocate unnecessary pages or
  27          * page tables.  Return error instead of NULL to skip handle_mm_fault,
  28          * then get_dump_page() will return NULL to leave a hole in the dump.
  29          * But we can only make this optimization where a hole would surely
  30          * be zero-filled if handle_mm_fault() actually did handle it.
  31          */
  32         if ((flags & FOLL_DUMP) && (!vma->vm_ops || !vma->vm_ops->fault))
  33                 return ERR_PTR(-EFAULT);
  34         return NULL;
  35 }
  36
  37 static int follow_pfn_pte(struct vm_area_struct *vma, unsigned long address,
  38                 pte_t *pte, unsigned int flags)
  39 {
  40         /* No page to get reference */
  41         if (flags & FOLL_GET)
  42                 return -EFAULT;
  43
  44         if (flags & FOLL_TOUCH) {
  45                 pte_t entry = *pte;
  46
  47                 if (flags & FOLL_WRITE)
  48                         entry = pte_mkdirty(entry);
  49                 entry = pte_mkyoung(entry);
  50
  51                 if (!pte_same(*pte, entry)) {
  52                         set_pte_at(vma->vm_mm, address, pte, entry);
  53                         update_mmu_cache(vma, address, pte);
  54                 }
  55         }
  56
  57         /* Proper page table entry exists, but no corresponding struct page */
  58         return -EEXIST;
  59 }
  60
  61 /*
  62  * FOLL_FORCE can write to even unwritable pte's, but only
  63  * after we've gone through a COW cycle and they are dirty.
  64  */
  65 static inline bool can_follow_write_pte(pte_t pte, unsigned int flags)
  66 {
  67         return pte_write(pte) ||
  68                 ((flags & FOLL_FORCE) && (flags & FOLL_COW) && pte_dirty(pte));
  69 }
  70
  71 static struct page *follow_page_pte(struct vm_area_struct *vma,
  72                 unsigned long address, pmd_t *pmd, unsigned int flags)
  73 {
  74         struct mm_struct *mm = vma->vm_mm;
  75         struct page *page;
  76         spinlock_t *ptl;
  77         pte_t *ptep, pte;
  78
  79 retry:
  80         if (unlikely(pmd_bad(*pmd)))
  81                 return no_page_table(vma, flags);
  82
  83         ptep = pte_offset_map_lock(mm, pmd, address, &ptl);
  84         pte = *ptep;
  85         if (!pte_present(pte)) {
  86                 swp_entry_t entry;
  87                 /*
  88                  * KSM's break_ksm() relies upon recognizing a ksm page
  89                  * even while it is being migrated, so for that case we
  90                  * need migration_entry_wait().
  91                  */
  92                 if (likely(!(flags & FOLL_MIGRATION)))
  93                         goto no_page;
  94                 if (pte_none(pte))
  95                         goto no_page;
  96                 entry = pte_to_swp_entry(pte);
  97                 if (!is_migration_entry(entry))
  98                         goto no_page;
  99                 pte_unmap_unlock(ptep, ptl);
 100                 migration_entry_wait(mm, pmd, address);
 101                 goto retry;
 102         }
 103         if ((flags & FOLL_NUMA) && pte_protnone(pte))
 104                 goto no_page;
 105         if ((flags & FOLL_WRITE) && !can_follow_write_pte(pte, flags)) {
 106                 pte_unmap_unlock(ptep, ptl);
 107                 return NULL;
 108         }
 109
 110         page = vm_normal_page(vma, address, pte);
 111         if (unlikely(!page)) {
 112                 if (flags & FOLL_DUMP) {
 113                         /* Avoid special (like zero) pages in core dumps */
 114                         page = ERR_PTR(-EFAULT);
 115                         goto out;
 116                 }
 117
 118                 if (is_zero_pfn(pte_pfn(pte))) {
 119                         page = pte_page(pte);
 120                 } else {
 121                         int ret;
 122
 123                         ret = follow_pfn_pte(vma, address, ptep, flags);
 124                         page = ERR_PTR(ret);
 125                         goto out;
 126                 }
 127         }
 128
 129         if (flags & FOLL_GET)
 130                 get_page_foll(page);
 131         if (flags & FOLL_TOUCH) {
 132                 if ((flags & FOLL_WRITE) &&
 133                     !pte_dirty(pte) && !PageDirty(page))
 134                         set_page_dirty(page);
 135                 /*
 136                  * pte_mkyoung() would be more correct here, but atomic care
 137                  * is needed to avoid losing the dirty bit: it is easier to use
 138                  * mark_page_accessed().
 139                  */
 140                 mark_page_accessed(page);
 141         }
 142         if ((flags & FOLL_MLOCK) && (vma->vm_flags & VM_LOCKED)) {
 143                 /*
 144                  * The preliminary mapping check is mainly to avoid the
 145                  * pointless overhead of lock_page on the ZERO_PAGE
 146                  * which might bounce very badly if there is contention.
 147                  *
 148                  * If the page is already locked, we don't need to
 149                  * handle it now - vmscan will handle it later if and
 150                  * when it attempts to reclaim the page.
 151                  */
 152                 if (page->mapping && trylock_page(page)) {
 153                         lru_add_drain();  /* push cached pages to LRU */
 154                         /*
 155                          * Because we lock page here, and migration is
 156                          * blocked by the pte's page reference, and we
 157                          * know the page is still mapped, we don't even
 158                          * need to check for file-cache page truncation.
 159                          */
 160                         mlock_vma_page(page);
 161                         unlock_page(page);
 162                 }
 163         }
 164 out:
 165         pte_unmap_unlock(ptep, ptl);
 166         return page;
 167 no_page:
 168         pte_unmap_unlock(ptep, ptl);
 169         if (!pte_none(pte))
 170                 return NULL;
 171         return no_page_table(vma, flags);
 172 }
 173
 174 /**
 175  * follow_page_mask - look up a page descriptor from a user-virtual address
 176  * @vma: vm_area_struct mapping @address
 177  * @address: virtual address to look up
 178  * @flags: flags modifying lookup behaviour
 179  * @page_mask: on output, *page_mask is set according to the size of the page
 180  *
 181  * @flags can have FOLL_ flags set, defined in <linux/mm.h>
 182  *
 183  * Returns the mapped (struct page *), %NULL if no mapping exists, or
 184  * an error pointer if there is a mapping to something not represented
 185  * by a page descriptor (see also vm_normal_page()).
 186  */
 187 struct page *follow_page_mask(struct vm_area_struct *vma,
 188                               unsigned long address, unsigned int flags,
 189                               unsigned int *page_mask)
 190 {
 191         pgd_t *pgd;
 192         pud_t *pud;
 193         pmd_t *pmd;
 194         spinlock_t *ptl;
 195         struct page *page;
 196         struct mm_struct *mm = vma->vm_mm;
 197
 198         *page_mask = 0;
 199
 200         page = follow_huge_addr(mm, address, flags & FOLL_WRITE);
 201         if (!IS_ERR(page)) {
 202                 BUG_ON(flags & FOLL_GET);
 203                 return page;
 204         }
 205
 206         pgd = pgd_offset(mm, address);
 207         if (pgd_none(*pgd) || unlikely(pgd_bad(*pgd)))
 208                 return no_page_table(vma, flags);
 209
 210         pud = pud_offset(pgd, address);
 211         if (pud_none(*pud))
 212                 return no_page_table(vma, flags);
 213         if (pud_huge(*pud) && vma->vm_flags & VM_HUGETLB) {
 214                 page = follow_huge_pud(mm, address, pud, flags);
 215                 if (page)
 216                         return page;
 217                 return no_page_table(vma, flags);
 218         }
 219         if (unlikely(pud_bad(*pud)))
 220                 return no_page_table(vma, flags);
 221
 222         pmd = pmd_offset(pud, address);
 223         if (pmd_none(*pmd))
 224                 return no_page_table(vma, flags);
 225         if (pmd_huge(*pmd) && vma->vm_flags & VM_HUGETLB) {
 226                 page = follow_huge_pmd(mm, address, pmd, flags);
 227                 if (page)
 228                         return page;
 229                 return no_page_table(vma, flags);
 230         }
 231         if ((flags & FOLL_NUMA) && pmd_protnone(*pmd))
 232                 return no_page_table(vma, flags);
 233         if (pmd_trans_huge(*pmd)) {
 234                 if (flags & FOLL_SPLIT) {
 235                         split_huge_page_pmd(vma, address, pmd);
 236                         return follow_page_pte(vma, address, pmd, flags);
 237                 }
 238                 ptl = pmd_lock(mm, pmd);
 239                 if (likely(pmd_trans_huge(*pmd))) {
 240                         if (unlikely(pmd_trans_splitting(*pmd))) {
 241                                 spin_unlock(ptl);
 242                                 wait_split_huge_page(vma->anon_vma, pmd);
 243                         } else {
 244                                 page = follow_trans_huge_pmd(vma, address,
 245                                                              pmd, flags);
 246                                 spin_unlock(ptl);
 247                                 *page_mask = HPAGE_PMD_NR - 1;
 248                                 return page;
 249                         }
 250                 } else
 251                         spin_unlock(ptl);
 252         }
 253         return follow_page_pte(vma, address, pmd, flags);
 254 }
 255
 256 static int get_gate_page(struct mm_struct *mm, unsigned long address,
 257                 unsigned int gup_flags, struct vm_area_struct **vma,
 258                 struct page **page)
 259 {
 260         pgd_t *pgd;
 261         pud_t *pud;
 262         pmd_t *pmd;
 263         pte_t *pte;
 264         int ret = -EFAULT;
 265
 266         /* user gate pages are read-only */
 267         if (gup_flags & FOLL_WRITE)
 268                 return -EFAULT;
 269         if (address > TASK_SIZE)
 270                 pgd = pgd_offset_k(address);
 271         else
 272                 pgd = pgd_offset_gate(mm, address);
 273         BUG_ON(pgd_none(*pgd));
 274         pud = pud_offset(pgd, address);
 275         BUG_ON(pud_none(*pud));
 276         pmd = pmd_offset(pud, address);
 277         if (pmd_none(*pmd))
 278                 return -EFAULT;
 279         VM_BUG_ON(pmd_trans_huge(*pmd));
 280         pte = pte_offset_map(pmd, address);
 281         if (pte_none(*pte))
 282                 goto unmap;
 283         *vma = get_gate_vma(mm);
 284         if (!page)
 285                 goto out;
 286         *page = vm_normal_page(*vma, address, *pte);
 287         if (!*page) {
 288                 if ((gup_flags & FOLL_DUMP) || !is_zero_pfn(pte_pfn(*pte)))
 289                         goto unmap;
 290                 *page = pte_page(*pte);
 291         }
 292         get_page(*page);
 293 out:
 294         ret = 0;
 295 unmap:
 296         pte_unmap(pte);
 297         return ret;
 298 }
 299
 300 /*
 301  * mmap_sem must be held on entry.  If @nonblocking != NULL and
 302  * *@flags does not include FOLL_NOWAIT, the mmap_sem may be released.
 303  * If it is, *@nonblocking will be set to 0 and -EBUSY returned.
 304  */
 305 static int faultin_page(struct task_struct *tsk, struct vm_area_struct *vma,
 306                 unsigned long address, unsigned int *flags, int *nonblocking)
 307 {
 308         struct mm_struct *mm = vma->vm_mm;
 309         unsigned int fault_flags = 0;
 310         int ret;
 311
 312         /* mlock all present pages, but do not fault in new pages */
 313         if ((*flags & (FOLL_POPULATE | FOLL_MLOCK)) == FOLL_MLOCK)
 314                 return -ENOENT;
 315         if (*flags & FOLL_WRITE)
 316                 fault_flags |= FAULT_FLAG_WRITE;
 317         if (nonblocking)
 318                 fault_flags |= FAULT_FLAG_ALLOW_RETRY;
 319         if (*flags & FOLL_NOWAIT)
 320                 fault_flags |= FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT;
 321         if (*flags & FOLL_TRIED) {
 322                 VM_WARN_ON_ONCE(fault_flags & FAULT_FLAG_ALLOW_RETRY);
 323                 fault_flags |= FAULT_FLAG_TRIED;
 324         }
 325
 326         ret = handle_mm_fault(mm, vma, address, fault_flags);
 327         if (ret & VM_FAULT_ERROR) {
 328                 if (ret & VM_FAULT_OOM)
 329                         return -ENOMEM;
 330                 if (ret & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
 331                         return *flags & FOLL_HWPOISON ? -EHWPOISON : -EFAULT;
 332                 if (ret & (VM_FAULT_SIGBUS | VM_FAULT_SIGSEGV))
 333                         return -EFAULT;
 334                 BUG();
 335         }
 336
 337         if (tsk) {
 338                 if (ret & VM_FAULT_MAJOR)
 339                         tsk->maj_flt++;
 340                 else
 341                         tsk->min_flt++;
 342         }
 343
 344         if (ret & VM_FAULT_RETRY) {
 345                 if (nonblocking)
 346                         *nonblocking = 0;
 347                 return -EBUSY;
 348         }
 349
 350         /*
 351          * The VM_FAULT_WRITE bit tells us that do_wp_page has broken COW when
 352          * necessary, even if maybe_mkwrite decided not to set pte_write. We
 353          * can thus safely do subsequent page lookups as if they were reads.
 354          * But only do so when looping for pte_write is futile: in some cases
 355          * userspace may also be wanting to write to the gotten user page,
 356          * which a read fault here might prevent (a readonly page might get
 357          * reCOWed by userspace write).
 358          */
 359         if ((ret & VM_FAULT_WRITE) && !(vma->vm_flags & VM_WRITE))
 360                 *flags |= FOLL_COW;
 361         return 0;
 362 }
 363
 364 static int check_vma_flags(struct vm_area_struct *vma, unsigned long gup_flags)
 365 {
 366         vm_flags_t vm_flags = vma->vm_flags;
 367
 368         if (vm_flags & (VM_IO | VM_PFNMAP))
 369                 return -EFAULT;
 370
 371         if (gup_flags & FOLL_WRITE) {
 372                 if (!(vm_flags & VM_WRITE)) {
 373                         if (!(gup_flags & FOLL_FORCE))
 374                                 return -EFAULT;
 375                         /*
 376                          * We used to let the write,force case do COW in a
 377                          * VM_MAYWRITE VM_SHARED !VM_WRITE vma, so ptrace could
 378                          * set a breakpoint in a read-only mapping of an
 379                          * executable, without corrupting the file (yet only
 380                          * when that file had been opened for writing!).
 381                          * Anon pages in shared mappings are surprising: now
 382                          * just reject it.
 383                          */
 384                         if (!is_cow_mapping(vm_flags)) {
 385                                 WARN_ON_ONCE(vm_flags & VM_MAYWRITE);
 386                                 return -EFAULT;
 387                         }
 388                 }
 389         } else if (!(vm_flags & VM_READ)) {
 390                 if (!(gup_flags & FOLL_FORCE))
 391                         return -EFAULT;
 392                 /*
 393                  * Is there actually any vma we can reach here which does not
 394                  * have VM_MAYREAD set?
 395                  */
 396                 if (!(vm_flags & VM_MAYREAD))
 397                         return -EFAULT;
 398         }
 399         return 0;
 400 }
 401
 402 /**
 403  * __get_user_pages() - pin user pages in memory
 404  * @tsk:        task_struct of target task
 405  * @mm:         mm_struct of target mm
 406  * @start:      starting user address
 407  * @nr_pages:   number of pages from start to pin
 408  * @gup_flags:  flags modifying pin behaviour
 409  * @pages:      array that receives pointers to the pages pinned.
 410  *              Should be at least nr_pages long. Or NULL, if caller
 411  *              only intends to ensure the pages are faulted in.
 412  * @vmas:       array of pointers to vmas corresponding to each page.
 413  *              Or NULL if the caller does not require them.
 414  * @nonblocking: whether waiting for disk IO or mmap_sem contention
 415  *
 416  * Returns number of pages pinned. This may be fewer than the number
 417  * requested. If nr_pages is 0 or negative, returns 0. If no pages
 418  * were pinned, returns -errno. Each page returned must be released
 419  * with a put_page() call when it is finished with. vmas will only
 420  * remain valid while mmap_sem is held.
 421  *
 422  * Must be called with mmap_sem held.  It may be released.  See below.
 423  *
 424  * __get_user_pages walks a process's page tables and takes a reference to
 425  * each struct page that each user address corresponds to at a given
 426  * instant. That is, it takes the page that would be accessed if a user
 427  * thread accesses the given user virtual address at that instant.
 428  *
 429  * This does not guarantee that the page exists in the user mappings when
 430  * __get_user_pages returns, and there may even be a completely different
 431  * page there in some cases (eg. if mmapped pagecache has been invalidated
 432  * and subsequently re faulted). However it does guarantee that the page
 433  * won't be freed completely. And mostly callers simply care that the page
 434  * contains data that was valid *at some point in time*. Typically, an IO
 435  * or similar operation cannot guarantee anything stronger anyway because
 436  * locks can't be held over the syscall boundary.
 437  *
 438  * If @gup_flags & FOLL_WRITE == 0, the page must not be written to. If
 439  * the page is written to, set_page_dirty (or set_page_dirty_lock, as
 440  * appropriate) must be called after the page is finished with, and
 441  * before put_page is called.
 442  *
 443  * If @nonblocking != NULL, __get_user_pages will not wait for disk IO
 444  * or mmap_sem contention, and if waiting is needed to pin all pages,
 445  * *@nonblocking will be set to 0.  Further, if @gup_flags does not
 446  * include FOLL_NOWAIT, the mmap_sem will be released via up_read() in
 447  * this case.
 448  *
 449  * A caller using such a combination of @nonblocking and @gup_flags
 450  * must therefore hold the mmap_sem for reading only, and recognize
 451  * when it's been released.  Otherwise, it must be held for either
 452  * reading or writing and will not be released.
 453  *
 454  * In most cases, get_user_pages or get_user_pages_fast should be used
 455  * instead of __get_user_pages. __get_user_pages should be used only if
 456  * you need some special @gup_flags.
 457  */
 458 long __get_user_pages(struct task_struct *tsk, struct mm_struct *mm,
 459                 unsigned long start, unsigned long nr_pages,
 460                 unsigned int gup_flags, struct page **pages,
 461                 struct vm_area_struct **vmas, int *nonblocking)
 462 {
 463         long i = 0;
 464         unsigned int page_mask;
 465         struct vm_area_struct *vma = NULL;
 466
 467         if (!nr_pages)
 468                 return 0;
 469
 470         VM_BUG_ON(!!pages != !!(gup_flags & FOLL_GET));
 471
 472         /*
 473          * If FOLL_FORCE is set then do not force a full fault as the hinting
 474          * fault information is unrelated to the reference behaviour of a task
 475          * using the address space
 476          */
 477         if (!(gup_flags & FOLL_FORCE))
 478                 gup_flags |= FOLL_NUMA;
 479
 480         do {
 481                 struct page *page;
 482                 unsigned int foll_flags = gup_flags;
 483                 unsigned int page_increm;
 484
 485                 /* first iteration or cross vma bound */
 486                 if (!vma || start >= vma->vm_end) {
 487                         vma = find_extend_vma(mm, start);
 488                         if (!vma && in_gate_area(mm, start)) {
 489                                 int ret;
 490                                 ret = get_gate_page(mm, start & PAGE_MASK,
 491                                                 gup_flags, &vma,
 492                                                 pages ? &pages[i] : NULL);
 493                                 if (ret)
 494                                         return i ? : ret;
 495                                 page_mask = 0;
 496                                 goto next_page;
 497                         }
 498
 499                         if (!vma || check_vma_flags(vma, gup_flags))
 500                                 return i ? : -EFAULT;
 501                         if (is_vm_hugetlb_page(vma)) {
 502                                 i = follow_hugetlb_page(mm, vma, pages, vmas,
 503                                                 &start, &nr_pages, i,
 504                                                 gup_flags);
 505                                 continue;
 506                         }
 507                 }
 508 retry:
 509                 /*
 510                  * If we have a pending SIGKILL, don't keep faulting pages and
 511                  * potentially allocating memory.
 512                  */
 513                 if (unlikely(fatal_signal_pending(current)))
 514                         return i ? i : -ERESTARTSYS;
 515                 cond_resched();
 516                 page = follow_page_mask(vma, start, foll_flags, &page_mask);
 517                 if (!page) {
 518                         int ret;
 519                         ret = faultin_page(tsk, vma, start, &foll_flags,
 520                                         nonblocking);
 521                         switch (ret) {
 522                         case 0:
 523                                 goto retry;
 524                         case -EFAULT:
 525                         case -ENOMEM:
 526                         case -EHWPOISON:
 527                                 return i ? i : ret;
 528                         case -EBUSY:
 529                                 return i;
 530                         case -ENOENT:
 531                                 goto next_page;
 532                         }
 533                         BUG();
 534                 } else if (PTR_ERR(page) == -EEXIST) {
 535                         /*
 536                          * Proper page table entry exists, but no corresponding
 537                          * struct page.
 538                          */
 539                         goto next_page;
 540                 } else if (IS_ERR(page)) {
 541                         return i ? i : PTR_ERR(page);
 542                 }
 543                 if (pages) {
 544                         pages[i] = page;
 545                         flush_anon_page(vma, page, start);
 546                         flush_dcache_page(page);
 547                         page_mask = 0;
 548                 }
 549 next_page:
 550                 if (vmas) {
 551                         vmas[i] = vma;
 552                         page_mask = 0;
 553                 }
 554                 page_increm = 1 + (~(start >> PAGE_SHIFT) & page_mask);
 555                 if (page_increm > nr_pages)
 556                         page_increm = nr_pages;
 557                 i += page_increm;
 558                 start += page_increm * PAGE_SIZE;
 559                 nr_pages -= page_increm;
 560         } while (nr_pages);
 561         return i;
 562 }
 563 EXPORT_SYMBOL(__get_user_pages);
 564
 565 /*
 566  * fixup_user_fault() - manually resolve a user page fault
 567  * @tsk:        the task_struct to use for page fault accounting, or
 568  *              NULL if faults are not to be recorded.
 569  * @mm:         mm_struct of target mm
 570  * @address:    user address
 571  * @fault_flags:flags to pass down to handle_mm_fault()
 572  *
 573  * This is meant to be called in the specific scenario where for locking reasons
 574  * we try to access user memory in atomic context (within a pagefault_disable()
 575  * section), this returns -EFAULT, and we want to resolve the user fault before
 576  * trying again.
 577  *
 578  * Typically this is meant to be used by the futex code.
 579  *
 580  * The main difference with get_user_pages() is that this function will
 581  * unconditionally call handle_mm_fault() which will in turn perform all the
 582  * necessary SW fixup of the dirty and young bits in the PTE, while
 583  * handle_mm_fault() only guarantees to update these in the struct page.
 584  *
 585  * This is important for some architectures where those bits also gate the
 586  * access permission to the page because they are maintained in software.  On
 587  * such architectures, gup() will not be enough to make a subsequent access
 588  * succeed.
 589  *
 590  * This has the same semantics wrt the @mm->mmap_sem as does filemap_fault().
 591  */
 592 int fixup_user_fault(struct task_struct *tsk, struct mm_struct *mm,
 593                      unsigned long address, unsigned int fault_flags)
 594 {
 595         struct vm_area_struct *vma;
 596         vm_flags_t vm_flags;
 597         int ret;
 598
 599         vma = find_extend_vma(mm, address);
 600         if (!vma || address < vma->vm_start)
 601                 return -EFAULT;
 602
 603         vm_flags = (fault_flags & FAULT_FLAG_WRITE) ? VM_WRITE : VM_READ;
 604         if (!(vm_flags & vma->vm_flags))
 605                 return -EFAULT;
 606
 607         ret = handle_mm_fault(mm, vma, address, fault_flags);
 608         if (ret & VM_FAULT_ERROR) {
 609                 if (ret & VM_FAULT_OOM)
 610                         return -ENOMEM;
 611                 if (ret & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
 612                         return -EHWPOISON;
 613                 if (ret & (VM_FAULT_SIGBUS | VM_FAULT_SIGSEGV))
 614                         return -EFAULT;
 615                 BUG();
 616         }
 617         if (tsk) {
 618                 if (ret & VM_FAULT_MAJOR)
 619                         tsk->maj_flt++;
 620                 else
 621                         tsk->min_flt++;
 622         }
 623         return 0;
 624 }
 625
 626 static __always_inline long __get_user_pages_locked(struct task_struct *tsk,
 627                                                 struct mm_struct *mm,
 628                                                 unsigned long start,
 629                                                 unsigned long nr_pages,
 630                                                 struct page **pages,
 631                                                 struct vm_area_struct **vmas,
 632                                                 int *locked, bool notify_drop,
 633                                                 unsigned int flags)
 634 {
 635         long ret, pages_done;
 636         bool lock_dropped;
 637
 638         if (locked) {
 639                 /* if VM_FAULT_RETRY can be returned, vmas become invalid */
 640                 BUG_ON(vmas);
 641                 /* check caller initialized locked */
 642                 BUG_ON(*locked != 1);
 643         }
 644
 645         if (pages)
 646                 flags |= FOLL_GET;
 647
 648         pages_done = 0;
 649         lock_dropped = false;
 650         for (;;) {
 651                 ret = __get_user_pages(tsk, mm, start, nr_pages, flags, pages,
 652                                        vmas, locked);
 653                 if (!locked)
 654                         /* VM_FAULT_RETRY couldn't trigger, bypass */
 655                         return ret;
 656
 657                 /* VM_FAULT_RETRY cannot return errors */
 658                 if (!*locked) {
 659                         BUG_ON(ret < 0);
 660                         BUG_ON(ret >= nr_pages);
 661                 }
 662
 663                 if (!pages)
 664                         /* If it's a prefault don't insist harder */
 665                         return ret;
 666
 667                 if (ret > 0) {
 668                         nr_pages -= ret;
 669                         pages_done += ret;
 670                         if (!nr_pages)
 671                                 break;
 672                 }
 673                 if (*locked) {
 674                         /* VM_FAULT_RETRY didn't trigger */
 675                         if (!pages_done)
 676                                 pages_done = ret;
 677                         break;
 678                 }
 679                 /* VM_FAULT_RETRY triggered, so seek to the faulting offset */
 680                 pages += ret;
 681                 start += ret << PAGE_SHIFT;
 682
 683                 /*
 684                  * Repeat on the address that fired VM_FAULT_RETRY
 685                  * without FAULT_FLAG_ALLOW_RETRY but with
 686                  * FAULT_FLAG_TRIED.
 687                  */
 688                 *locked = 1;
 689                 lock_dropped = true;
 690                 down_read(&mm->mmap_sem);
 691                 ret = __get_user_pages(tsk, mm, start, 1, flags | FOLL_TRIED,
 692                                        pages, NULL, NULL);
 693                 if (ret != 1) {
 694                         BUG_ON(ret > 1);
 695                         if (!pages_done)
 696                                 pages_done = ret;
 697                         break;
 698                 }
 699                 nr_pages--;
 700                 pages_done++;
 701                 if (!nr_pages)
 702                         break;
 703                 pages++;
 704                 start += PAGE_SIZE;
 705         }
 706         if (notify_drop && lock_dropped && *locked) {
 707                 /*
 708                  * We must let the caller know we temporarily dropped the lock
 709                  * and so the critical section protected by it was lost.
 710                  */
 711                 up_read(&mm->mmap_sem);
 712                 *locked = 0;
 713         }
 714         return pages_done;
 715 }
 716
 717 /*
 718  * We can leverage the VM_FAULT_RETRY functionality in the page fault
 719  * paths better by using either get_user_pages_locked() or
 720  * get_user_pages_unlocked().
 721  *
 722  * get_user_pages_locked() is suitable to replace the form:
 723  *
 724  *      down_read(&mm->mmap_sem);
 725  *      do_something()
 726  *      get_user_pages(tsk, mm, ..., pages, NULL);
 727  *      up_read(&mm->mmap_sem);
 728  *
 729  *  to:
 730  *
 731  *      int locked = 1;
 732  *      down_read(&mm->mmap_sem);
 733  *      do_something()
 734  *      get_user_pages_locked(tsk, mm, ..., pages, &locked);
 735  *      if (locked)
 736  *          up_read(&mm->mmap_sem);
 737  */
 738 long get_user_pages_locked(struct task_struct *tsk, struct mm_struct *mm,
 739                            unsigned long start, unsigned long nr_pages,
 740                            int write, int force, struct page **pages,
 741                            int *locked)
 742 {
 743         unsigned int flags = FOLL_TOUCH;
 744
 745         if (write)
 746                 flags |= FOLL_WRITE;
 747         if (force)
 748                 flags |= FOLL_FORCE;
 749
 750         return __get_user_pages_locked(tsk, mm, start, nr_pages,
 751                                        pages, NULL, locked, true, flags);
 752 }
 753 EXPORT_SYMBOL(get_user_pages_locked);
 754
 755 /*
 756  * Same as get_user_pages_unlocked(...., FOLL_TOUCH) but it allows to
 757  * pass additional gup_flags as last parameter (like FOLL_HWPOISON).
 758  *
 759  * NOTE: here FOLL_TOUCH is not set implicitly and must be set by the
 760  * caller if required (just like with __get_user_pages). "FOLL_GET",
 761  * "FOLL_WRITE" and "FOLL_FORCE" are set implicitly as needed
 762  * according to the parameters "pages", "write", "force"
 763  * respectively.
 764  */
 765 __always_inline long __get_user_pages_unlocked(struct task_struct *tsk, struct mm_struct *mm,
 766                                                unsigned long start, unsigned long nr_pages,
 767                                                struct page **pages, unsigned int gup_flags)
 768 {
 769         long ret;
 770         int locked = 1;
 771
 772         down_read(&mm->mmap_sem);
 773         ret = __get_user_pages_locked(tsk, mm, start, nr_pages, pages, NULL,
 774                                       &locked, false, gup_flags);
 775         if (locked)
 776                 up_read(&mm->mmap_sem);
 777         return ret;
 778 }
 779 EXPORT_SYMBOL(__get_user_pages_unlocked);
 780
 781 /*
 782  * get_user_pages_unlocked() is suitable to replace the form:
 783  *
 784  *      down_read(&mm->mmap_sem);
 785  *      get_user_pages(tsk, mm, ..., pages, NULL);
 786  *      up_read(&mm->mmap_sem);
 787  *
 788  *  with:
 789  *
 790  *      get_user_pages_unlocked(tsk, mm, ..., pages);
 791  *
 792  * It is functionally equivalent to get_user_pages_fast so
 793  * get_user_pages_fast should be used instead, if the two parameters
 794  * "tsk" and "mm" are respectively equal to current and current->mm,
 795  * or if "force" shall be set to 1 (get_user_pages_fast misses the
 796  * "force" parameter).
 797  */
 798 long get_user_pages_unlocked(struct task_struct *tsk, struct mm_struct *mm,
 799                              unsigned long start, unsigned long nr_pages,
 800                              int write, int force, struct page **pages)
 801 {
 802         unsigned int flags = FOLL_TOUCH;
 803
 804         if (write)
 805                 flags |= FOLL_WRITE;
 806         if (force)
 807                 flags |= FOLL_FORCE;
 808
 809         return __get_user_pages_unlocked(tsk, mm, start, nr_pages,
 810                                          pages, flags);
 811 }
 812 EXPORT_SYMBOL(get_user_pages_unlocked);
 813
 814 /*
 815  * get_user_pages() - pin user pages in memory
 816  * @tsk:        the task_struct to use for page fault accounting, or
 817  *              NULL if faults are not to be recorded.
 818  * @mm:         mm_struct of target mm
 819  * @start:      starting user address
 820  * @nr_pages:   number of pages from start to pin
 821  * @write:      whether pages will be written to by the caller
 822  * @force:      whether to force access even when user mapping is currently
 823  *              protected (but never forces write access to shared mapping).
 824  * @pages:      array that receives pointers to the pages pinned.
 825  *              Should be at least nr_pages long. Or NULL, if caller
 826  *              only intends to ensure the pages are faulted in.
 827  * @vmas:       array of pointers to vmas corresponding to each page.
 828  *              Or NULL if the caller does not require them.
 829  *
 830  * Returns number of pages pinned. This may be fewer than the number
 831  * requested. If nr_pages is 0 or negative, returns 0. If no pages
 832  * were pinned, returns -errno. Each page returned must be released
 833  * with a put_page() call when it is finished with. vmas will only
 834  * remain valid while mmap_sem is held.
 835  *
 836  * Must be called with mmap_sem held for read or write.
 837  *
 838  * get_user_pages walks a process's page tables and takes a reference to
 839  * each struct page that each user address corresponds to at a given
 840  * instant. That is, it takes the page that would be accessed if a user
 841  * thread accesses the given user virtual address at that instant.
 842  *
 843  * This does not guarantee that the page exists in the user mappings when
 844  * get_user_pages returns, and there may even be a completely different
 845  * page there in some cases (eg. if mmapped pagecache has been invalidated
 846  * and subsequently re faulted). However it does guarantee that the page
 847  * won't be freed completely. And mostly callers simply care that the page
 848  * contains data that was valid *at some point in time*. Typically, an IO
 849  * or similar operation cannot guarantee anything stronger anyway because
 850  * locks can't be held over the syscall boundary.
 851  *
 852  * If write=0, the page must not be written to. If the page is written to,
 853  * set_page_dirty (or set_page_dirty_lock, as appropriate) must be called
 854  * after the page is finished with, and before put_page is called.
 855  *
 856  * get_user_pages is typically used for fewer-copy IO operations, to get a
 857  * handle on the memory by some means other than accesses via the user virtual
 858  * addresses. The pages may be submitted for DMA to devices or accessed via
 859  * their kernel linear mapping (via the kmap APIs). Care should be taken to
 860  * use the correct cache flushing APIs.
 861  *
 862  * See also get_user_pages_fast, for performance critical applications.
 863  *
 864  * get_user_pages should be phased out in favor of
 865  * get_user_pages_locked|unlocked or get_user_pages_fast. Nothing
 866  * should use get_user_pages because it cannot pass
 867  * FAULT_FLAG_ALLOW_RETRY to handle_mm_fault.
 868  */
 869 long get_user_pages(struct task_struct *tsk, struct mm_struct *mm,
 870                 unsigned long start, unsigned long nr_pages, int write,
 871                 int force, struct page **pages, struct vm_area_struct **vmas)
 872 {
 873         unsigned int flags = FOLL_TOUCH;
 874
 875         if (write)
 876                 flags |= FOLL_WRITE;
 877         if (force)
 878                 flags |= FOLL_FORCE;
 879
 880         return __get_user_pages_locked(tsk, mm, start, nr_pages,
 881                                        pages, vmas, NULL, false, flags);
 882 }
 883 EXPORT_SYMBOL(get_user_pages);
 884
 885 /**
 886  * populate_vma_page_range() -  populate a range of pages in the vma.
 887  * @vma:   target vma
 888  * @start: start address
 889  * @end:   end address
 890  * @nonblocking:
 891  *
 892  * This takes care of mlocking the pages too if VM_LOCKED is set.
 893  *
 894  * return 0 on success, negative error code on error.
 895  *
 896  * vma->vm_mm->mmap_sem must be held.
 897  *
 898  * If @nonblocking is NULL, it may be held for read or write and will
 899  * be unperturbed.
 900  *
 901  * If @nonblocking is non-NULL, it must held for read only and may be
 902  * released.  If it's released, *@nonblocking will be set to 0.
 903  */
 904 long populate_vma_page_range(struct vm_area_struct *vma,
 905                 unsigned long start, unsigned long end, int *nonblocking)
 906 {
 907         struct mm_struct *mm = vma->vm_mm;
 908         unsigned long nr_pages = (end - start) / PAGE_SIZE;
 909         int gup_flags;
 910
 911         VM_BUG_ON(start & ~PAGE_MASK);
 912         VM_BUG_ON(end   & ~PAGE_MASK);
 913         VM_BUG_ON_VMA(start < vma->vm_start, vma);
 914         VM_BUG_ON_VMA(end   > vma->vm_end, vma);
 915         VM_BUG_ON_MM(!rwsem_is_locked(&mm->mmap_sem), mm);
 916
 917         gup_flags = FOLL_TOUCH | FOLL_POPULATE | FOLL_MLOCK;
 918         if (vma->vm_flags & VM_LOCKONFAULT)
 919                 gup_flags &= ~FOLL_POPULATE;
 920
 921         /*
 922          * We want to touch writable mappings with a write fault in order
 923          * to break COW, except for shared mappings because these don't COW
 924          * and we would not want to dirty them for nothing.
 925          */
 926         if ((vma->vm_flags & (VM_WRITE | VM_SHARED)) == VM_WRITE)
 927                 gup_flags |= FOLL_WRITE;
 928
 929         /*
 930          * We want mlock to succeed for regions that have any permissions
 931          * other than PROT_NONE.
 932          */
 933         if (vma->vm_flags & (VM_READ | VM_WRITE | VM_EXEC))
 934                 gup_flags |= FOLL_FORCE;
 935
 936         /*
 937          * We made sure addr is within a VMA, so the following will
 938          * not result in a stack expansion that recurses back here.
 939          */
 940         return __get_user_pages(current, mm, start, nr_pages, gup_flags,
 941                                 NULL, NULL, nonblocking);
 942 }
 943
 944 /*
 945  * __mm_populate - populate and/or mlock pages within a range of address space.
 946  *
 947  * This is used to implement mlock() and the MAP_POPULATE / MAP_LOCKED mmap
 948  * flags. VMAs must be already marked with the desired vm_flags, and
 949  * mmap_sem must not be held.
 950  */
 951 int __mm_populate(unsigned long start, unsigned long len, int ignore_errors)
 952 {
 953         struct mm_struct *mm = current->mm;
 954         unsigned long end, nstart, nend;
 955         struct vm_area_struct *vma = NULL;
 956         int locked = 0;
 957         long ret = 0;
 958
 959         end = start + len;
 960
 961         for (nstart = start; nstart < end; nstart = nend) {
 962                 /*
 963                  * We want to fault in pages for [nstart; end) address range.
 964                  * Find first corresponding VMA.
 965                  */
 966                 if (!locked) {
 967                         locked = 1;
 968                         down_read(&mm->mmap_sem);
 969                         vma = find_vma(mm, nstart);
 970                 } else if (nstart >= vma->vm_end)
 971                         vma = vma->vm_next;
 972                 if (!vma || vma->vm_start >= end)
 973                         break;
 974                 /*
 975                  * Set [nstart; nend) to intersection of desired address
 976                  * range with the first VMA. Also, skip undesirable VMA types.
 977                  */
 978                 nend = min(end, vma->vm_end);
 979                 if (vma->vm_flags & (VM_IO | VM_PFNMAP))
 980                         continue;
 981                 if (nstart < vma->vm_start)
 982                         nstart = vma->vm_start;
 983                 /*
 984                  * Now fault in a range of pages. populate_vma_page_range()
 985                  * double checks the vma flags, so that it won't mlock pages
 986                  * if the vma was already munlocked.
 987                  */
 988                 ret = populate_vma_page_range(vma, nstart, nend, &locked);
 989                 if (ret < 0) {
 990                         if (ignore_errors) {
 991                                 ret = 0;
 992                                 continue;       /* continue at next VMA */
 993                         }
 994                         break;
 995                 }
 996                 nend = nstart + ret * PAGE_SIZE;
 997                 ret = 0;
 998         }
 999         if (locked)
1000                 up_read(&mm->mmap_sem);
1001         return ret;     /* 0 or negative error code */
1002 }
1003
1004 /**
1005  * get_dump_page() - pin user page in memory while writing it to core dump
1006  * @addr: user address
1007  *
1008  * Returns struct page pointer of user page pinned for dump,
1009  * to be freed afterwards by page_cache_release() or put_page().
1010  *
1011  * Returns NULL on any kind of failure - a hole must then be inserted into
1012  * the corefile, to preserve alignment with its headers; and also returns
1013  * NULL wherever the ZERO_PAGE, or an anonymous pte_none, has been found -
1014  * allowing a hole to be left in the corefile to save diskspace.
1015  *
1016  * Called without mmap_sem, but after all other threads have been killed.
1017  */
1018 #ifdef CONFIG_ELF_CORE
1019 struct page *get_dump_page(unsigned long addr)
1020 {
1021         struct vm_area_struct *vma;
1022         struct page *page;
1023
1024         if (__get_user_pages(current, current->mm, addr, 1,
1025                              FOLL_FORCE | FOLL_DUMP | FOLL_GET, &page, &vma,
1026                              NULL) < 1)
1027                 return NULL;
1028         flush_cache_page(vma, addr, page_to_pfn(page));
1029         return page;
1030 }
1031 #endif /* CONFIG_ELF_CORE */
1032
1033 /*
1034  * Generic RCU Fast GUP
1035  *
1036  * get_user_pages_fast attempts to pin user pages by walking the page
1037  * tables directly and avoids taking locks. Thus the walker needs to be
1038  * protected from page table pages being freed from under it, and should
1039  * block any THP splits.
1040  *
1041  * One way to achieve this is to have the walker disable interrupts, and
1042  * rely on IPIs from the TLB flushing code blocking before the page table
1043  * pages are freed. This is unsuitable for architectures that do not need
1044  * to broadcast an IPI when invalidating TLBs.
1045  *
1046  * Another way to achieve this is to batch up page table containing pages
1047  * belonging to more than one mm_user, then rcu_sched a callback to free those
1048  * pages. Disabling interrupts will allow the fast_gup walker to both block
1049  * the rcu_sched callback, and an IPI that we broadcast for splitting THPs
1050  * (which is a relatively rare event). The code below adopts this strategy.
1051  *
1052  * Before activating this code, please be aware that the following assumptions
1053  * are currently made:
1054  *
1055  *  *) HAVE_RCU_TABLE_FREE is enabled, and tlb_remove_table is used to free
1056  *      pages containing page tables.
1057  *
1058  *  *) THP splits will broadcast an IPI, this can be achieved by overriding
1059  *      pmdp_splitting_flush.
1060  *
1061  *  *) ptes can be read atomically by the architecture.
1062  *
1063  *  *) access_ok is sufficient to validate userspace address ranges.
1064  *
1065  * The last two assumptions can be relaxed by the addition of helper functions.
1066  *
1067  * This code is based heavily on the PowerPC implementation by Nick Piggin.
1068  */
1069 #ifdef CONFIG_HAVE_GENERIC_RCU_GUP
1070
1071 #ifdef __HAVE_ARCH_PTE_SPECIAL
1072 static int gup_pte_range(pmd_t pmd, unsigned long addr, unsigned long end,
1073                          int write, struct page **pages, int *nr)
1074 {
1075         pte_t *ptep, *ptem;
1076         int ret = 0;
1077
1078         ptem = ptep = pte_offset_map(&pmd, addr);
1079         do {
1080                 /*
1081                  * In the line below we are assuming that the pte can be read
1082                  * atomically. If this is not the case for your architecture,
1083                  * please wrap this in a helper function!
1084                  *
1085                  * for an example see gup_get_pte in arch/x86/mm/gup.c
1086                  */
1087                 pte_t pte = READ_ONCE(*ptep);
1088                 struct page *page;
1089
1090                 /*
1091                  * Similar to the PMD case below, NUMA hinting must take slow
1092                  * path using the pte_protnone check.
1093                  */
1094                 if (!pte_present(pte) || pte_special(pte) ||
1095                         pte_protnone(pte) || (write && !pte_write(pte)))
1096                         goto pte_unmap;
1097
1098                 VM_BUG_ON(!pfn_valid(pte_pfn(pte)));
1099                 page = pte_page(pte);
1100
1101                 if (!page_cache_get_speculative(page))
1102                         goto pte_unmap;
1103
1104                 if (unlikely(pte_val(pte) != pte_val(*ptep))) {
1105                         put_page(page);
1106                         goto pte_unmap;
1107                 }
1108
1109                 pages[*nr] = page;
1110                 (*nr)++;
1111
1112         } while (ptep++, addr += PAGE_SIZE, addr != end);
1113
1114         ret = 1;
1115
1116 pte_unmap:
1117         pte_unmap(ptem);
1118         return ret;
1119 }
1120 #else
1121
1122 /*
1123  * If we can't determine whether or not a pte is special, then fail immediately
1124  * for ptes. Note, we can still pin HugeTLB and THP as these are guaranteed not
1125  * to be special.
1126  *
1127  * For a futex to be placed on a THP tail page, get_futex_key requires a
1128  * __get_user_pages_fast implementation that can pin pages. Thus it's still
1129  * useful to have gup_huge_pmd even if we can't operate on ptes.
1130  */
1131 static int gup_pte_range(pmd_t pmd, unsigned long addr, unsigned long end,
1132                          int write, struct page **pages, int *nr)
1133 {
1134         return 0;
1135 }
1136 #endif /* __HAVE_ARCH_PTE_SPECIAL */
1137
1138 static int gup_huge_pmd(pmd_t orig, pmd_t *pmdp, unsigned long addr,
1139                 unsigned long end, int write, struct page **pages, int *nr)
1140 {
1141         struct page *head, *page, *tail;
1142         int refs;
1143
1144         if (write && !pmd_write(orig))
1145                 return 0;
1146
1147         refs = 0;
1148         head = pmd_page(orig);
1149         page = head + ((addr & ~PMD_MASK) >> PAGE_SHIFT);
1150         tail = page;
1151         do {
1152                 VM_BUG_ON_PAGE(compound_head(page) != head, page);
1153                 pages[*nr] = page;
1154                 (*nr)++;
1155                 page++;
1156                 refs++;
1157         } while (addr += PAGE_SIZE, addr != end);
1158
1159         if (!page_cache_add_speculative(head, refs)) {
1160                 *nr -= refs;
1161                 return 0;
1162         }
1163
1164         if (unlikely(pmd_val(orig) != pmd_val(*pmdp))) {
1165                 *nr -= refs;
1166                 while (refs--)
1167                         put_page(head);
1168                 return 0;
1169         }
1170
1171         /*
1172          * Any tail pages need their mapcount reference taken before we
1173          * return. (This allows the THP code to bump their ref count when
1174          * they are split into base pages).
1175          */
1176         while (refs--) {
1177                 if (PageTail(tail))
1178                         get_huge_page_tail(tail);
1179                 tail++;
1180         }
1181
1182         return 1;
1183 }
1184
1185 static int gup_huge_pud(pud_t orig, pud_t *pudp, unsigned long addr,
1186                 unsigned long end, int write, struct page **pages, int *nr)
1187 {
1188         struct page *head, *page, *tail;
1189         int refs;
1190
1191         if (write && !pud_write(orig))
1192                 return 0;
1193
1194         refs = 0;
1195         head = pud_page(orig);
1196         page = head + ((addr & ~PUD_MASK) >> PAGE_SHIFT);
1197         tail = page;
1198         do {
1199                 VM_BUG_ON_PAGE(compound_head(page) != head, page);
1200                 pages[*nr] = page;
1201                 (*nr)++;
1202                 page++;
1203                 refs++;
1204         } while (addr += PAGE_SIZE, addr != end);
1205
1206         if (!page_cache_add_speculative(head, refs)) {
1207                 *nr -= refs;
1208                 return 0;
1209         }
1210
1211         if (unlikely(pud_val(orig) != pud_val(*pudp))) {
1212                 *nr -= refs;
1213                 while (refs--)
1214                         put_page(head);
1215                 return 0;
1216         }
1217
1218         while (refs--) {
1219                 if (PageTail(tail))
1220                         get_huge_page_tail(tail);
1221                 tail++;
1222         }
1223
1224         return 1;
1225 }
1226
1227 static int gup_huge_pgd(pgd_t orig, pgd_t *pgdp, unsigned long addr,
1228                         unsigned long end, int write,
1229                         struct page **pages, int *nr)
1230 {
1231         int refs;
1232         struct page *head, *page, *tail;
1233
1234         if (write && !pgd_write(orig))
1235                 return 0;
1236
1237         refs = 0;
1238         head = pgd_page(orig);
1239         page = head + ((addr & ~PGDIR_MASK) >> PAGE_SHIFT);
1240         tail = page;
1241         do {
1242                 VM_BUG_ON_PAGE(compound_head(page) != head, page);
1243                 pages[*nr] = page;
1244                 (*nr)++;
1245                 page++;
1246                 refs++;
1247         } while (addr += PAGE_SIZE, addr != end);
1248
1249         if (!page_cache_add_speculative(head, refs)) {
1250                 *nr -= refs;
1251                 return 0;
1252         }
1253
1254         if (unlikely(pgd_val(orig) != pgd_val(*pgdp))) {
1255                 *nr -= refs;
1256                 while (refs--)
1257                         put_page(head);
1258                 return 0;
1259         }
1260
1261         while (refs--) {
1262                 if (PageTail(tail))
1263                         get_huge_page_tail(tail);
1264                 tail++;
1265         }
1266
1267         return 1;
1268 }
1269
1270 static int gup_pmd_range(pud_t pud, unsigned long addr, unsigned long end,
1271                 int write, struct page **pages, int *nr)
1272 {
1273         unsigned long next;
1274         pmd_t *pmdp;
1275
1276         pmdp = pmd_offset(&pud, addr);
1277         do {
1278                 pmd_t pmd = READ_ONCE(*pmdp);
1279
1280                 next = pmd_addr_end(addr, end);
1281                 if (pmd_none(pmd) || pmd_trans_splitting(pmd))
1282                         return 0;
1283
1284                 if (unlikely(pmd_trans_huge(pmd) || pmd_huge(pmd))) {
1285                         /*
1286                          * NUMA hinting faults need to be handled in the GUP
1287                          * slowpath for accounting purposes and so that they
1288                          * can be serialised against THP migration.
1289                          */
1290                         if (pmd_protnone(pmd))
1291                                 return 0;
1292
1293                         if (!gup_huge_pmd(pmd, pmdp, addr, next, write,
1294                                 pages, nr))
1295                                 return 0;
1296
1297                 } else if (unlikely(is_hugepd(__hugepd(pmd_val(pmd))))) {
1298                         /*
1299                          * architecture have different format for hugetlbfs
1300                          * pmd format and THP pmd format
1301                          */
1302                         if (!gup_huge_pd(__hugepd(pmd_val(pmd)), addr,
1303                                          PMD_SHIFT, next, write, pages, nr))
1304                                 return 0;
1305                 } else if (!gup_pte_range(pmd, addr, next, write, pages, nr))
1306                                 return 0;
1307         } while (pmdp++, addr = next, addr != end);
1308
1309         return 1;
1310 }
1311
1312 static int gup_pud_range(pgd_t pgd, unsigned long addr, unsigned long end,
1313                          int write, struct page **pages, int *nr)
1314 {
1315         unsigned long next;
1316         pud_t *pudp;
1317
1318         pudp = pud_offset(&pgd, addr);
1319         do {
1320                 pud_t pud = READ_ONCE(*pudp);
1321
1322                 next = pud_addr_end(addr, end);
1323                 if (pud_none(pud))
1324                         return 0;
1325                 if (unlikely(pud_huge(pud))) {
1326                         if (!gup_huge_pud(pud, pudp, addr, next, write,
1327                                           pages, nr))
1328                                 return 0;
1329                 } else if (unlikely(is_hugepd(__hugepd(pud_val(pud))))) {
1330                         if (!gup_huge_pd(__hugepd(pud_val(pud)), addr,
1331                                          PUD_SHIFT, next, write, pages, nr))
1332                                 return 0;
1333                 } else if (!gup_pmd_range(pud, addr, next, write, pages, nr))
1334                         return 0;
1335         } while (pudp++, addr = next, addr != end);
1336
1337         return 1;
1338 }
1339
1340 /*
1341  * Like get_user_pages_fast() except it's IRQ-safe in that it won't fall back to
1342  * the regular GUP. It will only return non-negative values.
1343  */
1344 int __get_user_pages_fast(unsigned long start, int nr_pages, int write,
1345                           struct page **pages)
1346 {
1347         struct mm_struct *mm = current->mm;
1348         unsigned long addr, len, end;
1349         unsigned long next, flags;
1350         pgd_t *pgdp;
1351         int nr = 0;
1352
1353         start &= PAGE_MASK;
1354         addr = start;
1355         len = (unsigned long) nr_pages << PAGE_SHIFT;
1356         end = start + len;
1357
1358         if (unlikely(!access_ok(write ? VERIFY_WRITE : VERIFY_READ,
1359                                         start, len)))
1360                 return 0;
1361
1362         /*
1363          * Disable interrupts.  We use the nested form as we can already have
1364          * interrupts disabled by get_futex_key.
1365          *
1366          * With interrupts disabled, we block page table pages from being
1367          * freed from under us. See mmu_gather_tlb in asm-generic/tlb.h
1368          * for more details.
1369          *
1370          * We do not adopt an rcu_read_lock(.) here as we also want to
1371          * block IPIs that come from THPs splitting.
1372          */
1373
1374         local_irq_save(flags);
1375         pgdp = pgd_offset(mm, addr);
1376         do {
1377                 pgd_t pgd = READ_ONCE(*pgdp);
1378
1379                 next = pgd_addr_end(addr, end);
1380                 if (pgd_none(pgd))
1381                         break;
1382                 if (unlikely(pgd_huge(pgd))) {
1383                         if (!gup_huge_pgd(pgd, pgdp, addr, next, write,
1384                                           pages, &nr))
1385                                 break;
1386                 } else if (unlikely(is_hugepd(__hugepd(pgd_val(pgd))))) {
1387                         if (!gup_huge_pd(__hugepd(pgd_val(pgd)), addr,
1388                                          PGDIR_SHIFT, next, write, pages, &nr))
1389                                 break;
1390                 } else if (!gup_pud_range(pgd, addr, next, write, pages, &nr))
1391                         break;
1392         } while (pgdp++, addr = next, addr != end);
1393         local_irq_restore(flags);
1394
1395         return nr;
1396 }
1397
1398 /**
1399  * get_user_pages_fast() - pin user pages in memory
1400  * @start:      starting user address
1401  * @nr_pages:   number of pages from start to pin
1402  * @write:      whether pages will be written to
1403  * @pages:      array that receives pointers to the pages pinned.
1404  *              Should be at least nr_pages long.
1405  *
1406  * Attempt to pin user pages in memory without taking mm->mmap_sem.
1407  * If not successful, it will fall back to taking the lock and
1408  * calling get_user_pages().
1409  *
1410  * Returns number of pages pinned. This may be fewer than the number
1411  * requested. If nr_pages is 0 or negative, returns 0. If no pages
1412  * were pinned, returns -errno.
1413  */
1414 int get_user_pages_fast(unsigned long start, int nr_pages, int write,
1415                         struct page **pages)
1416 {
1417         struct mm_struct *mm = current->mm;
1418         int nr, ret;
1419
1420         start &= PAGE_MASK;
1421         nr = __get_user_pages_fast(start, nr_pages, write, pages);
1422         ret = nr;
1423
1424         if (nr < nr_pages) {
1425                 /* Try to get the remaining pages with get_user_pages */
1426                 start += nr << PAGE_SHIFT;
1427                 pages += nr;
1428
1429                 ret = get_user_pages_unlocked(current, mm, start,
1430                                               nr_pages - nr, write, 0, pages);
1431
1432                 /* Have to be a bit careful with return values */
1433                 if (nr > 0) {
1434                         if (ret < 0)
1435                                 ret = nr;
1436                         else
1437                                 ret += nr;
1438                 }
1439         }
1440
1441         return ret;
1442 }
1443
1444 #endif /* CONFIG_HAVE_GENERIC_RCU_GUP */