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