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/hugetlb.h>
   7 #include <linux/mm.h>
   8 #include <linux/pagemap.h>
   9 #include <linux/rmap.h>
  10 #include <linux/swap.h>
  11 #include <linux/swapops.h>
  12
  13 #include "internal.h"
  14
  15 static struct page *no_page_table(struct vm_area_struct *vma,
  16                 unsigned int flags)
  17 {
  18         /*
  19          * When core dumping an enormous anonymous area that nobody
  20          * has touched so far, we don't want to allocate unnecessary pages or
  21          * page tables.  Return error instead of NULL to skip handle_mm_fault,
  22          * then get_dump_page() will return NULL to leave a hole in the dump.
  23          * But we can only make this optimization where a hole would surely
  24          * be zero-filled if handle_mm_fault() actually did handle it.
  25          */
  26         if ((flags & FOLL_DUMP) && (!vma->vm_ops || !vma->vm_ops->fault))
  27                 return ERR_PTR(-EFAULT);
  28         return NULL;
  29 }
  30
  31 static struct page *follow_page_pte(struct vm_area_struct *vma,
  32                 unsigned long address, pmd_t *pmd, unsigned int flags)
  33 {
  34         struct mm_struct *mm = vma->vm_mm;
  35         struct page *page;
  36         spinlock_t *ptl;
  37         pte_t *ptep, pte;
  38
  39 retry:
  40         if (unlikely(pmd_bad(*pmd)))
  41                 return no_page_table(vma, flags);
  42
  43         ptep = pte_offset_map_lock(mm, pmd, address, &ptl);
  44         pte = *ptep;
  45         if (!pte_present(pte)) {
  46                 swp_entry_t entry;
  47                 /*
  48                  * KSM's break_ksm() relies upon recognizing a ksm page
  49                  * even while it is being migrated, so for that case we
  50                  * need migration_entry_wait().
  51                  */
  52                 if (likely(!(flags & FOLL_MIGRATION)))
  53                         goto no_page;
  54                 if (pte_none(pte) || pte_file(pte))
  55                         goto no_page;
  56                 entry = pte_to_swp_entry(pte);
  57                 if (!is_migration_entry(entry))
  58                         goto no_page;
  59                 pte_unmap_unlock(ptep, ptl);
  60                 migration_entry_wait(mm, pmd, address);
  61                 goto retry;
  62         }
  63         if ((flags & FOLL_NUMA) && pte_numa(pte))
  64                 goto no_page;
  65         if ((flags & FOLL_WRITE) && !pte_write(pte)) {
  66                 pte_unmap_unlock(ptep, ptl);
  67                 return NULL;
  68         }
  69
  70         page = vm_normal_page(vma, address, pte);
  71         if (unlikely(!page)) {
  72                 if ((flags & FOLL_DUMP) ||
  73                     !is_zero_pfn(pte_pfn(pte)))
  74                         goto bad_page;
  75                 page = pte_page(pte);
  76         }
  77
  78         if (flags & FOLL_GET)
  79                 get_page_foll(page);
  80         if (flags & FOLL_TOUCH) {
  81                 if ((flags & FOLL_WRITE) &&
  82                     !pte_dirty(pte) && !PageDirty(page))
  83                         set_page_dirty(page);
  84                 /*
  85                  * pte_mkyoung() would be more correct here, but atomic care
  86                  * is needed to avoid losing the dirty bit: it is easier to use
  87                  * mark_page_accessed().
  88                  */
  89                 mark_page_accessed(page);
  90         }
  91         if ((flags & FOLL_MLOCK) && (vma->vm_flags & VM_LOCKED)) {
  92                 /*
  93                  * The preliminary mapping check is mainly to avoid the
  94                  * pointless overhead of lock_page on the ZERO_PAGE
  95                  * which might bounce very badly if there is contention.
  96                  *
  97                  * If the page is already locked, we don't need to
  98                  * handle it now - vmscan will handle it later if and
  99                  * when it attempts to reclaim the page.
 100                  */
 101                 if (page->mapping && trylock_page(page)) {
 102                         lru_add_drain();  /* push cached pages to LRU */
 103                         /*
 104                          * Because we lock page here, and migration is
 105                          * blocked by the pte's page reference, and we
 106                          * know the page is still mapped, we don't even
 107                          * need to check for file-cache page truncation.
 108                          */
 109                         mlock_vma_page(page);
 110                         unlock_page(page);
 111                 }
 112         }
 113         pte_unmap_unlock(ptep, ptl);
 114         return page;
 115 bad_page:
 116         pte_unmap_unlock(ptep, ptl);
 117         return ERR_PTR(-EFAULT);
 118
 119 no_page:
 120         pte_unmap_unlock(ptep, ptl);
 121         if (!pte_none(pte))
 122                 return NULL;
 123         return no_page_table(vma, flags);
 124 }
 125
 126 /**
 127  * follow_page_mask - look up a page descriptor from a user-virtual address
 128  * @vma: vm_area_struct mapping @address
 129  * @address: virtual address to look up
 130  * @flags: flags modifying lookup behaviour
 131  * @page_mask: on output, *page_mask is set according to the size of the page
 132  *
 133  * @flags can have FOLL_ flags set, defined in <linux/mm.h>
 134  *
 135  * Returns the mapped (struct page *), %NULL if no mapping exists, or
 136  * an error pointer if there is a mapping to something not represented
 137  * by a page descriptor (see also vm_normal_page()).
 138  */
 139 struct page *follow_page_mask(struct vm_area_struct *vma,
 140                               unsigned long address, unsigned int flags,
 141                               unsigned int *page_mask)
 142 {
 143         pgd_t *pgd;
 144         pud_t *pud;
 145         pmd_t *pmd;
 146         spinlock_t *ptl;
 147         struct page *page;
 148         struct mm_struct *mm = vma->vm_mm;
 149
 150         *page_mask = 0;
 151
 152         page = follow_huge_addr(mm, address, flags & FOLL_WRITE);
 153         if (!IS_ERR(page)) {
 154                 BUG_ON(flags & FOLL_GET);
 155                 return page;
 156         }
 157
 158         pgd = pgd_offset(mm, address);
 159         if (pgd_none(*pgd) || unlikely(pgd_bad(*pgd)))
 160                 return no_page_table(vma, flags);
 161
 162         pud = pud_offset(pgd, address);
 163         if (pud_none(*pud))
 164                 return no_page_table(vma, flags);
 165         if (pud_huge(*pud) && vma->vm_flags & VM_HUGETLB) {
 166                 if (flags & FOLL_GET)
 167                         return NULL;
 168                 page = follow_huge_pud(mm, address, pud, flags & FOLL_WRITE);
 169                 return page;
 170         }
 171         if (unlikely(pud_bad(*pud)))
 172                 return no_page_table(vma, flags);
 173
 174         pmd = pmd_offset(pud, address);
 175         if (pmd_none(*pmd))
 176                 return no_page_table(vma, flags);
 177         if (pmd_huge(*pmd) && vma->vm_flags & VM_HUGETLB) {
 178                 page = follow_huge_pmd(mm, address, pmd, flags & FOLL_WRITE);
 179                 if (flags & FOLL_GET) {
 180                         /*
 181                          * Refcount on tail pages are not well-defined and
 182                          * shouldn't be taken. The caller should handle a NULL
 183                          * return when trying to follow tail pages.
 184                          */
 185                         if (PageHead(page))
 186                                 get_page(page);
 187                         else
 188                                 page = NULL;
 189                 }
 190                 return page;
 191         }
 192         if ((flags & FOLL_NUMA) && pmd_numa(*pmd))
 193                 return no_page_table(vma, flags);
 194         if (pmd_trans_huge(*pmd)) {
 195                 if (flags & FOLL_SPLIT) {
 196                         split_huge_page_pmd(vma, address, pmd);
 197                         return follow_page_pte(vma, address, pmd, flags);
 198                 }
 199                 ptl = pmd_lock(mm, pmd);
 200                 if (likely(pmd_trans_huge(*pmd))) {
 201                         if (unlikely(pmd_trans_splitting(*pmd))) {
 202                                 spin_unlock(ptl);
 203                                 wait_split_huge_page(vma->anon_vma, pmd);
 204                         } else {
 205                                 page = follow_trans_huge_pmd(vma, address,
 206                                                              pmd, flags);
 207                                 spin_unlock(ptl);
 208                                 *page_mask = HPAGE_PMD_NR - 1;
 209                                 return page;
 210                         }
 211                 } else
 212                         spin_unlock(ptl);
 213         }
 214         return follow_page_pte(vma, address, pmd, flags);
 215 }
 216
 217 static int get_gate_page(struct mm_struct *mm, unsigned long address,
 218                 unsigned int gup_flags, struct vm_area_struct **vma,
 219                 struct page **page)
 220 {
 221         pgd_t *pgd;
 222         pud_t *pud;
 223         pmd_t *pmd;
 224         pte_t *pte;
 225         int ret = -EFAULT;
 226
 227         /* user gate pages are read-only */
 228         if (gup_flags & FOLL_WRITE)
 229                 return -EFAULT;
 230         if (address > TASK_SIZE)
 231                 pgd = pgd_offset_k(address);
 232         else
 233                 pgd = pgd_offset_gate(mm, address);
 234         BUG_ON(pgd_none(*pgd));
 235         pud = pud_offset(pgd, address);
 236         BUG_ON(pud_none(*pud));
 237         pmd = pmd_offset(pud, address);
 238         if (pmd_none(*pmd))
 239                 return -EFAULT;
 240         VM_BUG_ON(pmd_trans_huge(*pmd));
 241         pte = pte_offset_map(pmd, address);
 242         if (pte_none(*pte))
 243                 goto unmap;
 244         *vma = get_gate_vma(mm);
 245         if (!page)
 246                 goto out;
 247         *page = vm_normal_page(*vma, address, *pte);
 248         if (!*page) {
 249                 if ((gup_flags & FOLL_DUMP) || !is_zero_pfn(pte_pfn(*pte)))
 250                         goto unmap;
 251                 *page = pte_page(*pte);
 252         }
 253         get_page(*page);
 254 out:
 255         ret = 0;
 256 unmap:
 257         pte_unmap(pte);
 258         return ret;
 259 }
 260
 261 /*
 262  * mmap_sem must be held on entry.  If @nonblocking != NULL and
 263  * *@flags does not include FOLL_NOWAIT, the mmap_sem may be released.
 264  * If it is, *@nonblocking will be set to 0 and -EBUSY returned.
 265  */
 266 static int faultin_page(struct task_struct *tsk, struct vm_area_struct *vma,
 267                 unsigned long address, unsigned int *flags, int *nonblocking)
 268 {
 269         struct mm_struct *mm = vma->vm_mm;
 270         unsigned int fault_flags = 0;
 271         int ret;
 272
 273         /* For mlock, just skip the stack guard page. */
 274         if ((*flags & FOLL_MLOCK) &&
 275                         (stack_guard_page_start(vma, address) ||
 276                          stack_guard_page_end(vma, address + PAGE_SIZE)))
 277                 return -ENOENT;
 278         if (*flags & FOLL_WRITE)
 279                 fault_flags |= FAULT_FLAG_WRITE;
 280         if (nonblocking)
 281                 fault_flags |= FAULT_FLAG_ALLOW_RETRY;
 282         if (*flags & FOLL_NOWAIT)
 283                 fault_flags |= FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT;
 284         if (*flags & FOLL_TRIED) {
 285                 VM_WARN_ON_ONCE(fault_flags & FAULT_FLAG_ALLOW_RETRY);
 286                 fault_flags |= FAULT_FLAG_TRIED;
 287         }
 288
 289         ret = handle_mm_fault(mm, vma, address, fault_flags);
 290         if (ret & VM_FAULT_ERROR) {
 291                 if (ret & VM_FAULT_OOM)
 292                         return -ENOMEM;
 293                 if (ret & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
 294                         return *flags & FOLL_HWPOISON ? -EHWPOISON : -EFAULT;
 295                 if (ret & VM_FAULT_SIGBUS)
 296                         return -EFAULT;
 297                 BUG();
 298         }
 299
 300         if (tsk) {
 301                 if (ret & VM_FAULT_MAJOR)
 302                         tsk->maj_flt++;
 303                 else
 304                         tsk->min_flt++;
 305         }
 306
 307         if (ret & VM_FAULT_RETRY) {
 308                 if (nonblocking)
 309                         *nonblocking = 0;
 310                 return -EBUSY;
 311         }
 312
 313         /*
 314          * The VM_FAULT_WRITE bit tells us that do_wp_page has broken COW when
 315          * necessary, even if maybe_mkwrite decided not to set pte_write. We
 316          * can thus safely do subsequent page lookups as if they were reads.
 317          * But only do so when looping for pte_write is futile: in some cases
 318          * userspace may also be wanting to write to the gotten user page,
 319          * which a read fault here might prevent (a readonly page might get
 320          * reCOWed by userspace write).
 321          */
 322         if ((ret & VM_FAULT_WRITE) && !(vma->vm_flags & VM_WRITE))
 323                 *flags &= ~FOLL_WRITE;
 324         return 0;
 325 }
 326
 327 static int check_vma_flags(struct vm_area_struct *vma, unsigned long gup_flags)
 328 {
 329         vm_flags_t vm_flags = vma->vm_flags;
 330
 331         if (vm_flags & (VM_IO | VM_PFNMAP))
 332                 return -EFAULT;
 333
 334         if (gup_flags & FOLL_WRITE) {
 335                 if (!(vm_flags & VM_WRITE)) {
 336                         if (!(gup_flags & FOLL_FORCE))
 337                                 return -EFAULT;
 338                         /*
 339                          * We used to let the write,force case do COW in a
 340                          * VM_MAYWRITE VM_SHARED !VM_WRITE vma, so ptrace could
 341                          * set a breakpoint in a read-only mapping of an
 342                          * executable, without corrupting the file (yet only
 343                          * when that file had been opened for writing!).
 344                          * Anon pages in shared mappings are surprising: now
 345                          * just reject it.
 346                          */
 347                         if (!is_cow_mapping(vm_flags)) {
 348                                 WARN_ON_ONCE(vm_flags & VM_MAYWRITE);
 349                                 return -EFAULT;
 350                         }
 351                 }
 352         } else if (!(vm_flags & VM_READ)) {
 353                 if (!(gup_flags & FOLL_FORCE))
 354                         return -EFAULT;
 355                 /*
 356                  * Is there actually any vma we can reach here which does not
 357                  * have VM_MAYREAD set?
 358                  */
 359                 if (!(vm_flags & VM_MAYREAD))
 360                         return -EFAULT;
 361         }
 362         return 0;
 363 }
 364
 365 /**
 366  * __get_user_pages() - pin user pages in memory
 367  * @tsk:        task_struct of target task
 368  * @mm:         mm_struct of target mm
 369  * @start:      starting user address
 370  * @nr_pages:   number of pages from start to pin
 371  * @gup_flags:  flags modifying pin behaviour
 372  * @pages:      array that receives pointers to the pages pinned.
 373  *              Should be at least nr_pages long. Or NULL, if caller
 374  *              only intends to ensure the pages are faulted in.
 375  * @vmas:       array of pointers to vmas corresponding to each page.
 376  *              Or NULL if the caller does not require them.
 377  * @nonblocking: whether waiting for disk IO or mmap_sem contention
 378  *
 379  * Returns number of pages pinned. This may be fewer than the number
 380  * requested. If nr_pages is 0 or negative, returns 0. If no pages
 381  * were pinned, returns -errno. Each page returned must be released
 382  * with a put_page() call when it is finished with. vmas will only
 383  * remain valid while mmap_sem is held.
 384  *
 385  * Must be called with mmap_sem held.  It may be released.  See below.
 386  *
 387  * __get_user_pages walks a process's page tables and takes a reference to
 388  * each struct page that each user address corresponds to at a given
 389  * instant. That is, it takes the page that would be accessed if a user
 390  * thread accesses the given user virtual address at that instant.
 391  *
 392  * This does not guarantee that the page exists in the user mappings when
 393  * __get_user_pages returns, and there may even be a completely different
 394  * page there in some cases (eg. if mmapped pagecache has been invalidated
 395  * and subsequently re faulted). However it does guarantee that the page
 396  * won't be freed completely. And mostly callers simply care that the page
 397  * contains data that was valid *at some point in time*. Typically, an IO
 398  * or similar operation cannot guarantee anything stronger anyway because
 399  * locks can't be held over the syscall boundary.
 400  *
 401  * If @gup_flags & FOLL_WRITE == 0, the page must not be written to. If
 402  * the page is written to, set_page_dirty (or set_page_dirty_lock, as
 403  * appropriate) must be called after the page is finished with, and
 404  * before put_page is called.
 405  *
 406  * If @nonblocking != NULL, __get_user_pages will not wait for disk IO
 407  * or mmap_sem contention, and if waiting is needed to pin all pages,
 408  * *@nonblocking will be set to 0.  Further, if @gup_flags does not
 409  * include FOLL_NOWAIT, the mmap_sem will be released via up_read() in
 410  * this case.
 411  *
 412  * A caller using such a combination of @nonblocking and @gup_flags
 413  * must therefore hold the mmap_sem for reading only, and recognize
 414  * when it's been released.  Otherwise, it must be held for either
 415  * reading or writing and will not be released.
 416  *
 417  * In most cases, get_user_pages or get_user_pages_fast should be used
 418  * instead of __get_user_pages. __get_user_pages should be used only if
 419  * you need some special @gup_flags.
 420  */
 421 long __get_user_pages(struct task_struct *tsk, struct mm_struct *mm,
 422                 unsigned long start, unsigned long nr_pages,
 423                 unsigned int gup_flags, struct page **pages,
 424                 struct vm_area_struct **vmas, int *nonblocking)
 425 {
 426         long i = 0;
 427         unsigned int page_mask;
 428         struct vm_area_struct *vma = NULL;
 429
 430         if (!nr_pages)
 431                 return 0;
 432
 433         VM_BUG_ON(!!pages != !!(gup_flags & FOLL_GET));
 434
 435         /*
 436          * If FOLL_FORCE is set then do not force a full fault as the hinting
 437          * fault information is unrelated to the reference behaviour of a task
 438          * using the address space
 439          */
 440         if (!(gup_flags & FOLL_FORCE))
 441                 gup_flags |= FOLL_NUMA;
 442
 443         do {
 444                 struct page *page;
 445                 unsigned int foll_flags = gup_flags;
 446                 unsigned int page_increm;
 447
 448                 /* first iteration or cross vma bound */
 449                 if (!vma || start >= vma->vm_end) {
 450                         vma = find_extend_vma(mm, start);
 451                         if (!vma && in_gate_area(mm, start)) {
 452                                 int ret;
 453                                 ret = get_gate_page(mm, start & PAGE_MASK,
 454                                                 gup_flags, &vma,
 455                                                 pages ? &pages[i] : NULL);
 456                                 if (ret)
 457                                         return i ? : ret;
 458                                 page_mask = 0;
 459                                 goto next_page;
 460                         }
 461
 462                         if (!vma || check_vma_flags(vma, gup_flags))
 463                                 return i ? : -EFAULT;
 464                         if (is_vm_hugetlb_page(vma)) {
 465                                 i = follow_hugetlb_page(mm, vma, pages, vmas,
 466                                                 &start, &nr_pages, i,
 467                                                 gup_flags);
 468                                 continue;
 469                         }
 470                 }
 471 retry:
 472                 /*
 473                  * If we have a pending SIGKILL, don't keep faulting pages and
 474                  * potentially allocating memory.
 475                  */
 476                 if (unlikely(fatal_signal_pending(current)))
 477                         return i ? i : -ERESTARTSYS;
 478                 cond_resched();
 479                 page = follow_page_mask(vma, start, foll_flags, &page_mask);
 480                 if (!page) {
 481                         int ret;
 482                         ret = faultin_page(tsk, vma, start, &foll_flags,
 483                                         nonblocking);
 484                         switch (ret) {
 485                         case 0:
 486                                 goto retry;
 487                         case -EFAULT:
 488                         case -ENOMEM:
 489                         case -EHWPOISON:
 490                                 return i ? i : ret;
 491                         case -EBUSY:
 492                                 return i;
 493                         case -ENOENT:
 494                                 goto next_page;
 495                         }
 496                         BUG();
 497                 }
 498                 if (IS_ERR(page))
 499                         return i ? i : PTR_ERR(page);
 500                 if (pages) {
 501                         pages[i] = page;
 502                         flush_anon_page(vma, page, start);
 503                         flush_dcache_page(page);
 504                         page_mask = 0;
 505                 }
 506 next_page:
 507                 if (vmas) {
 508                         vmas[i] = vma;
 509                         page_mask = 0;
 510                 }
 511                 page_increm = 1 + (~(start >> PAGE_SHIFT) & page_mask);
 512                 if (page_increm > nr_pages)
 513                         page_increm = nr_pages;
 514                 i += page_increm;
 515                 start += page_increm * PAGE_SIZE;
 516                 nr_pages -= page_increm;
 517         } while (nr_pages);
 518         return i;
 519 }
 520 EXPORT_SYMBOL(__get_user_pages);
 521
 522 /*
 523  * fixup_user_fault() - manually resolve a user page fault
 524  * @tsk:        the task_struct to use for page fault accounting, or
 525  *              NULL if faults are not to be recorded.
 526  * @mm:         mm_struct of target mm
 527  * @address:    user address
 528  * @fault_flags:flags to pass down to handle_mm_fault()
 529  *
 530  * This is meant to be called in the specific scenario where for locking reasons
 531  * we try to access user memory in atomic context (within a pagefault_disable()
 532  * section), this returns -EFAULT, and we want to resolve the user fault before
 533  * trying again.
 534  *
 535  * Typically this is meant to be used by the futex code.
 536  *
 537  * The main difference with get_user_pages() is that this function will
 538  * unconditionally call handle_mm_fault() which will in turn perform all the
 539  * necessary SW fixup of the dirty and young bits in the PTE, while
 540  * handle_mm_fault() only guarantees to update these in the struct page.
 541  *
 542  * This is important for some architectures where those bits also gate the
 543  * access permission to the page because they are maintained in software.  On
 544  * such architectures, gup() will not be enough to make a subsequent access
 545  * succeed.
 546  *
 547  * This has the same semantics wrt the @mm->mmap_sem as does filemap_fault().
 548  */
 549 int fixup_user_fault(struct task_struct *tsk, struct mm_struct *mm,
 550                      unsigned long address, unsigned int fault_flags)
 551 {
 552         struct vm_area_struct *vma;
 553         vm_flags_t vm_flags;
 554         int ret;
 555
 556         vma = find_extend_vma(mm, address);
 557         if (!vma || address < vma->vm_start)
 558                 return -EFAULT;
 559
 560         vm_flags = (fault_flags & FAULT_FLAG_WRITE) ? VM_WRITE : VM_READ;
 561         if (!(vm_flags & vma->vm_flags))
 562                 return -EFAULT;
 563
 564         ret = handle_mm_fault(mm, vma, address, fault_flags);
 565         if (ret & VM_FAULT_ERROR) {
 566                 if (ret & VM_FAULT_OOM)
 567                         return -ENOMEM;
 568                 if (ret & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
 569                         return -EHWPOISON;
 570                 if (ret & VM_FAULT_SIGBUS)
 571                         return -EFAULT;
 572                 BUG();
 573         }
 574         if (tsk) {
 575                 if (ret & VM_FAULT_MAJOR)
 576                         tsk->maj_flt++;
 577                 else
 578                         tsk->min_flt++;
 579         }
 580         return 0;
 581 }
 582
 583 /*
 584  * get_user_pages() - pin user pages in memory
 585  * @tsk:        the task_struct to use for page fault accounting, or
 586  *              NULL if faults are not to be recorded.
 587  * @mm:         mm_struct of target mm
 588  * @start:      starting user address
 589  * @nr_pages:   number of pages from start to pin
 590  * @write:      whether pages will be written to by the caller
 591  * @force:      whether to force access even when user mapping is currently
 592  *              protected (but never forces write access to shared mapping).
 593  * @pages:      array that receives pointers to the pages pinned.
 594  *              Should be at least nr_pages long. Or NULL, if caller
 595  *              only intends to ensure the pages are faulted in.
 596  * @vmas:       array of pointers to vmas corresponding to each page.
 597  *              Or NULL if the caller does not require them.
 598  *
 599  * Returns number of pages pinned. This may be fewer than the number
 600  * requested. If nr_pages is 0 or negative, returns 0. If no pages
 601  * were pinned, returns -errno. Each page returned must be released
 602  * with a put_page() call when it is finished with. vmas will only
 603  * remain valid while mmap_sem is held.
 604  *
 605  * Must be called with mmap_sem held for read or write.
 606  *
 607  * get_user_pages walks a process's page tables and takes a reference to
 608  * each struct page that each user address corresponds to at a given
 609  * instant. That is, it takes the page that would be accessed if a user
 610  * thread accesses the given user virtual address at that instant.
 611  *
 612  * This does not guarantee that the page exists in the user mappings when
 613  * get_user_pages returns, and there may even be a completely different
 614  * page there in some cases (eg. if mmapped pagecache has been invalidated
 615  * and subsequently re faulted). However it does guarantee that the page
 616  * won't be freed completely. And mostly callers simply care that the page
 617  * contains data that was valid *at some point in time*. Typically, an IO
 618  * or similar operation cannot guarantee anything stronger anyway because
 619  * locks can't be held over the syscall boundary.
 620  *
 621  * If write=0, the page must not be written to. If the page is written to,
 622  * set_page_dirty (or set_page_dirty_lock, as appropriate) must be called
 623  * after the page is finished with, and before put_page is called.
 624  *
 625  * get_user_pages is typically used for fewer-copy IO operations, to get a
 626  * handle on the memory by some means other than accesses via the user virtual
 627  * addresses. The pages may be submitted for DMA to devices or accessed via
 628  * their kernel linear mapping (via the kmap APIs). Care should be taken to
 629  * use the correct cache flushing APIs.
 630  *
 631  * See also get_user_pages_fast, for performance critical applications.
 632  */
 633 long get_user_pages(struct task_struct *tsk, struct mm_struct *mm,
 634                 unsigned long start, unsigned long nr_pages, int write,
 635                 int force, struct page **pages, struct vm_area_struct **vmas)
 636 {
 637         int flags = FOLL_TOUCH;
 638
 639         if (pages)
 640                 flags |= FOLL_GET;
 641         if (write)
 642                 flags |= FOLL_WRITE;
 643         if (force)
 644                 flags |= FOLL_FORCE;
 645
 646         return __get_user_pages(tsk, mm, start, nr_pages, flags, pages, vmas,
 647                                 NULL);
 648 }
 649 EXPORT_SYMBOL(get_user_pages);
 650
 651 /**
 652  * get_dump_page() - pin user page in memory while writing it to core dump
 653  * @addr: user address
 654  *
 655  * Returns struct page pointer of user page pinned for dump,
 656  * to be freed afterwards by page_cache_release() or put_page().
 657  *
 658  * Returns NULL on any kind of failure - a hole must then be inserted into
 659  * the corefile, to preserve alignment with its headers; and also returns
 660  * NULL wherever the ZERO_PAGE, or an anonymous pte_none, has been found -
 661  * allowing a hole to be left in the corefile to save diskspace.
 662  *
 663  * Called without mmap_sem, but after all other threads have been killed.
 664  */
 665 #ifdef CONFIG_ELF_CORE
 666 struct page *get_dump_page(unsigned long addr)
 667 {
 668         struct vm_area_struct *vma;
 669         struct page *page;
 670
 671         if (__get_user_pages(current, current->mm, addr, 1,
 672                              FOLL_FORCE | FOLL_DUMP | FOLL_GET, &page, &vma,
 673                              NULL) < 1)
 674                 return NULL;
 675         flush_cache_page(vma, addr, page_to_pfn(page));
 676         return page;
 677 }
 678 #endif /* CONFIG_ELF_CORE */