Blame view

mm/gup.c 67.2 KB
457c89965   Thomas Gleixner   treewide: Add SPD...
1
  // SPDX-License-Identifier: GPL-2.0-only
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
2
3
4
5
  #include <linux/kernel.h>
  #include <linux/errno.h>
  #include <linux/err.h>
  #include <linux/spinlock.h>
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
6
  #include <linux/mm.h>
3565fce3a   Dan Williams   mm, x86: get_user...
7
  #include <linux/memremap.h>
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
8
9
10
11
  #include <linux/pagemap.h>
  #include <linux/rmap.h>
  #include <linux/swap.h>
  #include <linux/swapops.h>
174cd4b1e   Ingo Molnar   sched/headers: Pr...
12
  #include <linux/sched/signal.h>
2667f50e8   Steve Capper   mm: introduce a g...
13
  #include <linux/rwsem.h>
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
14
  #include <linux/hugetlb.h>
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
15
16
17
  #include <linux/migrate.h>
  #include <linux/mm_inline.h>
  #include <linux/sched/mm.h>
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
18

33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
19
  #include <asm/mmu_context.h>
2667f50e8   Steve Capper   mm: introduce a g...
20
  #include <asm/pgtable.h>
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
21
  #include <asm/tlbflush.h>
2667f50e8   Steve Capper   mm: introduce a g...
22

4bbd4c776   Kirill A. Shutemov   mm: move get_user...
23
  #include "internal.h"
df06b37ff   Keith Busch   mm/gup: cache dev...
24
25
26
27
  struct follow_page_context {
  	struct dev_pagemap *pgmap;
  	unsigned int page_mask;
  };
fc1d8e7cc   John Hubbard   mm: introduce put...
28
  /**
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
29
30
   * put_user_pages_dirty_lock() - release and optionally dirty gup-pinned pages
   * @pages:  array of pages to be maybe marked dirty, and definitely released.
fc1d8e7cc   John Hubbard   mm: introduce put...
31
   * @npages: number of pages in the @pages array.
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
32
   * @make_dirty: whether to mark the pages dirty
fc1d8e7cc   John Hubbard   mm: introduce put...
33
34
35
36
37
   *
   * "gup-pinned page" refers to a page that has had one of the get_user_pages()
   * variants called on that page.
   *
   * For each page in the @pages array, make that page (or its head page, if a
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
38
39
40
   * compound page) dirty, if @make_dirty is true, and if the page was previously
   * listed as clean. In any case, releases all pages using put_user_page(),
   * possibly via put_user_pages(), for the non-dirty case.
fc1d8e7cc   John Hubbard   mm: introduce put...
41
42
43
   *
   * Please see the put_user_page() documentation for details.
   *
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
44
45
46
47
   * set_page_dirty_lock() is used internally. If instead, set_page_dirty() is
   * required, then the caller should a) verify that this is really correct,
   * because _lock() is usually required, and b) hand code it:
   * set_page_dirty_lock(), put_user_page().
fc1d8e7cc   John Hubbard   mm: introduce put...
48
49
   *
   */
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
50
51
  void put_user_pages_dirty_lock(struct page **pages, unsigned long npages,
  			       bool make_dirty)
fc1d8e7cc   John Hubbard   mm: introduce put...
52
  {
2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
53
  	unsigned long index;
fc1d8e7cc   John Hubbard   mm: introduce put...
54

2d15eb31b   akpm@linux-foundation.org   mm/gup: add make_...
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  	/*
  	 * TODO: this can be optimized for huge pages: if a series of pages is
  	 * physically contiguous and part of the same compound page, then a
  	 * single operation to the head page should suffice.
  	 */
  
  	if (!make_dirty) {
  		put_user_pages(pages, npages);
  		return;
  	}
  
  	for (index = 0; index < npages; index++) {
  		struct page *page = compound_head(pages[index]);
  		/*
  		 * Checking PageDirty at this point may race with
  		 * clear_page_dirty_for_io(), but that's OK. Two key
  		 * cases:
  		 *
  		 * 1) This code sees the page as already dirty, so it
  		 * skips the call to set_page_dirty(). That could happen
  		 * because clear_page_dirty_for_io() called
  		 * page_mkclean(), followed by set_page_dirty().
  		 * However, now the page is going to get written back,
  		 * which meets the original intention of setting it
  		 * dirty, so all is well: clear_page_dirty_for_io() goes
  		 * on to call TestClearPageDirty(), and write the page
  		 * back.
  		 *
  		 * 2) This code sees the page as clean, so it calls
  		 * set_page_dirty(). The page stays dirty, despite being
  		 * written back, so it gets written back again in the
  		 * next writeback cycle. This is harmless.
  		 */
  		if (!PageDirty(page))
  			set_page_dirty_lock(page);
  		put_user_page(page);
  	}
fc1d8e7cc   John Hubbard   mm: introduce put...
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
  }
  EXPORT_SYMBOL(put_user_pages_dirty_lock);
  
  /**
   * put_user_pages() - release an array of gup-pinned pages.
   * @pages:  array of pages to be marked dirty and released.
   * @npages: number of pages in the @pages array.
   *
   * For each page in the @pages array, release the page using put_user_page().
   *
   * Please see the put_user_page() documentation for details.
   */
  void put_user_pages(struct page **pages, unsigned long npages)
  {
  	unsigned long index;
  
  	/*
  	 * TODO: this can be optimized for huge pages: if a series of pages is
  	 * physically contiguous and part of the same compound page, then a
  	 * single operation to the head page should suffice.
  	 */
  	for (index = 0; index < npages; index++)
  		put_user_page(pages[index]);
  }
  EXPORT_SYMBOL(put_user_pages);
050a9adc6   Christoph Hellwig   mm: consolidate t...
117
  #ifdef CONFIG_MMU
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
118
119
  static struct page *no_page_table(struct vm_area_struct *vma,
  		unsigned int flags)
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
120
  {
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
121
122
123
124
125
126
127
128
129
130
131
132
  	/*
  	 * When core dumping an enormous anonymous area that nobody
  	 * has touched so far, we don't want to allocate unnecessary pages or
  	 * page tables.  Return error instead of NULL to skip handle_mm_fault,
  	 * then get_dump_page() will return NULL to leave a hole in the dump.
  	 * But we can only make this optimization where a hole would surely
  	 * be zero-filled if handle_mm_fault() actually did handle it.
  	 */
  	if ((flags & FOLL_DUMP) && (!vma->vm_ops || !vma->vm_ops->fault))
  		return ERR_PTR(-EFAULT);
  	return NULL;
  }
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
133

1027e4436   Kirill A. Shutemov   mm: make GUP hand...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
  static int follow_pfn_pte(struct vm_area_struct *vma, unsigned long address,
  		pte_t *pte, unsigned int flags)
  {
  	/* No page to get reference */
  	if (flags & FOLL_GET)
  		return -EFAULT;
  
  	if (flags & FOLL_TOUCH) {
  		pte_t entry = *pte;
  
  		if (flags & FOLL_WRITE)
  			entry = pte_mkdirty(entry);
  		entry = pte_mkyoung(entry);
  
  		if (!pte_same(*pte, entry)) {
  			set_pte_at(vma->vm_mm, address, pte, entry);
  			update_mmu_cache(vma, address, pte);
  		}
  	}
  
  	/* Proper page table entry exists, but no corresponding struct page */
  	return -EEXIST;
  }
19be0eaff   Linus Torvalds   mm: remove gup_fl...
157
  /*
1027dc04f   Linus Torvalds   gup: document and...
158
159
   * FOLL_FORCE or a forced COW break can write even to unwritable pte's,
   * but only after we've gone through a COW cycle and they are dirty.
19be0eaff   Linus Torvalds   mm: remove gup_fl...
160
161
162
   */
  static inline bool can_follow_write_pte(pte_t pte, unsigned int flags)
  {
1027dc04f   Linus Torvalds   gup: document and...
163
164
165
166
167
168
169
170
171
172
173
  	return pte_write(pte) || ((flags & FOLL_COW) && pte_dirty(pte));
  }
  
  /*
   * A (separate) COW fault might break the page the other way and
   * get_user_pages() would return the page from what is now the wrong
   * VM. So we need to force a COW break at GUP time even for reads.
   */
  static inline bool should_force_cow_break(struct vm_area_struct *vma, unsigned int flags)
  {
  	return is_cow_mapping(vma->vm_flags) && (flags & FOLL_GET);
19be0eaff   Linus Torvalds   mm: remove gup_fl...
174
  }
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
175
  static struct page *follow_page_pte(struct vm_area_struct *vma,
df06b37ff   Keith Busch   mm/gup: cache dev...
176
177
  		unsigned long address, pmd_t *pmd, unsigned int flags,
  		struct dev_pagemap **pgmap)
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
178
179
180
181
182
  {
  	struct mm_struct *mm = vma->vm_mm;
  	struct page *page;
  	spinlock_t *ptl;
  	pte_t *ptep, pte;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
183

69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
184
  retry:
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
185
  	if (unlikely(pmd_bad(*pmd)))
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
186
  		return no_page_table(vma, flags);
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
187
188
  
  	ptep = pte_offset_map_lock(mm, pmd, address, &ptl);
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
189
190
191
192
193
194
195
196
197
198
  	pte = *ptep;
  	if (!pte_present(pte)) {
  		swp_entry_t entry;
  		/*
  		 * KSM's break_ksm() relies upon recognizing a ksm page
  		 * even while it is being migrated, so for that case we
  		 * need migration_entry_wait().
  		 */
  		if (likely(!(flags & FOLL_MIGRATION)))
  			goto no_page;
0661a3361   Kirill A. Shutemov   mm: remove rest u...
199
  		if (pte_none(pte))
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
200
201
202
203
204
205
  			goto no_page;
  		entry = pte_to_swp_entry(pte);
  		if (!is_migration_entry(entry))
  			goto no_page;
  		pte_unmap_unlock(ptep, ptl);
  		migration_entry_wait(mm, pmd, address);
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
206
  		goto retry;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
207
  	}
8a0516ed8   Mel Gorman   mm: convert p[te|...
208
  	if ((flags & FOLL_NUMA) && pte_protnone(pte))
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
209
  		goto no_page;
19be0eaff   Linus Torvalds   mm: remove gup_fl...
210
  	if ((flags & FOLL_WRITE) && !can_follow_write_pte(pte, flags)) {
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
211
212
213
  		pte_unmap_unlock(ptep, ptl);
  		return NULL;
  	}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
214
215
  
  	page = vm_normal_page(vma, address, pte);
3565fce3a   Dan Williams   mm, x86: get_user...
216
217
218
219
220
  	if (!page && pte_devmap(pte) && (flags & FOLL_GET)) {
  		/*
  		 * Only return device mapping pages in the FOLL_GET case since
  		 * they are only valid while holding the pgmap reference.
  		 */
df06b37ff   Keith Busch   mm/gup: cache dev...
221
222
  		*pgmap = get_dev_pagemap(pte_pfn(pte), *pgmap);
  		if (*pgmap)
3565fce3a   Dan Williams   mm, x86: get_user...
223
224
225
226
  			page = pte_page(pte);
  		else
  			goto no_page;
  	} else if (unlikely(!page)) {
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
  		if (flags & FOLL_DUMP) {
  			/* Avoid special (like zero) pages in core dumps */
  			page = ERR_PTR(-EFAULT);
  			goto out;
  		}
  
  		if (is_zero_pfn(pte_pfn(pte))) {
  			page = pte_page(pte);
  		} else {
  			int ret;
  
  			ret = follow_pfn_pte(vma, address, ptep, flags);
  			page = ERR_PTR(ret);
  			goto out;
  		}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
242
  	}
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
243
244
245
246
247
248
249
250
251
252
253
254
  	if (flags & FOLL_SPLIT && PageTransCompound(page)) {
  		int ret;
  		get_page(page);
  		pte_unmap_unlock(ptep, ptl);
  		lock_page(page);
  		ret = split_huge_page(page);
  		unlock_page(page);
  		put_page(page);
  		if (ret)
  			return ERR_PTR(ret);
  		goto retry;
  	}
8fde12ca7   Linus Torvalds   mm: prevent get_u...
255
256
257
258
259
260
  	if (flags & FOLL_GET) {
  		if (unlikely(!try_get_page(page))) {
  			page = ERR_PTR(-ENOMEM);
  			goto out;
  		}
  	}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
261
262
263
264
265
266
267
268
269
270
271
  	if (flags & FOLL_TOUCH) {
  		if ((flags & FOLL_WRITE) &&
  		    !pte_dirty(pte) && !PageDirty(page))
  			set_page_dirty(page);
  		/*
  		 * pte_mkyoung() would be more correct here, but atomic care
  		 * is needed to avoid losing the dirty bit: it is easier to use
  		 * mark_page_accessed().
  		 */
  		mark_page_accessed(page);
  	}
de60f5f10   Eric B Munson   mm: introduce VM_...
272
  	if ((flags & FOLL_MLOCK) && (vma->vm_flags & VM_LOCKED)) {
e90309c9f   Kirill A. Shutemov   thp: allow mlocke...
273
274
275
  		/* Do not mlock pte-mapped THP */
  		if (PageTransCompound(page))
  			goto out;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
  		/*
  		 * The preliminary mapping check is mainly to avoid the
  		 * pointless overhead of lock_page on the ZERO_PAGE
  		 * which might bounce very badly if there is contention.
  		 *
  		 * If the page is already locked, we don't need to
  		 * handle it now - vmscan will handle it later if and
  		 * when it attempts to reclaim the page.
  		 */
  		if (page->mapping && trylock_page(page)) {
  			lru_add_drain();  /* push cached pages to LRU */
  			/*
  			 * Because we lock page here, and migration is
  			 * blocked by the pte's page reference, and we
  			 * know the page is still mapped, we don't even
  			 * need to check for file-cache page truncation.
  			 */
  			mlock_vma_page(page);
  			unlock_page(page);
  		}
  	}
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
297
  out:
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
298
  	pte_unmap_unlock(ptep, ptl);
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
299
  	return page;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
300
301
302
  no_page:
  	pte_unmap_unlock(ptep, ptl);
  	if (!pte_none(pte))
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
303
304
305
  		return NULL;
  	return no_page_table(vma, flags);
  }
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
306
307
  static struct page *follow_pmd_mask(struct vm_area_struct *vma,
  				    unsigned long address, pud_t *pudp,
df06b37ff   Keith Busch   mm/gup: cache dev...
308
309
  				    unsigned int flags,
  				    struct follow_page_context *ctx)
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
310
  {
688272809   Huang Ying   mm, gup: prevent ...
311
  	pmd_t *pmd, pmdval;
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
312
313
314
  	spinlock_t *ptl;
  	struct page *page;
  	struct mm_struct *mm = vma->vm_mm;
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
315
  	pmd = pmd_offset(pudp, address);
688272809   Huang Ying   mm, gup: prevent ...
316
317
318
319
320
321
  	/*
  	 * The READ_ONCE() will stabilize the pmdval in a register or
  	 * on the stack so that it will stop changing under the code.
  	 */
  	pmdval = READ_ONCE(*pmd);
  	if (pmd_none(pmdval))
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
322
  		return no_page_table(vma, flags);
688272809   Huang Ying   mm, gup: prevent ...
323
  	if (pmd_huge(pmdval) && vma->vm_flags & VM_HUGETLB) {
e66f17ff7   Naoya Horiguchi   mm/hugetlb: take ...
324
325
326
327
  		page = follow_huge_pmd(mm, address, pmd, flags);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
328
  	}
688272809   Huang Ying   mm, gup: prevent ...
329
  	if (is_hugepd(__hugepd(pmd_val(pmdval)))) {
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
330
  		page = follow_huge_pd(vma, address,
688272809   Huang Ying   mm, gup: prevent ...
331
  				      __hugepd(pmd_val(pmdval)), flags,
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
332
333
334
335
336
  				      PMD_SHIFT);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
84c3fc4e9   Zi Yan   mm: thp: check pm...
337
  retry:
688272809   Huang Ying   mm, gup: prevent ...
338
  	if (!pmd_present(pmdval)) {
84c3fc4e9   Zi Yan   mm: thp: check pm...
339
340
341
  		if (likely(!(flags & FOLL_MIGRATION)))
  			return no_page_table(vma, flags);
  		VM_BUG_ON(thp_migration_supported() &&
688272809   Huang Ying   mm, gup: prevent ...
342
343
  				  !is_pmd_migration_entry(pmdval));
  		if (is_pmd_migration_entry(pmdval))
84c3fc4e9   Zi Yan   mm: thp: check pm...
344
  			pmd_migration_entry_wait(mm, pmd);
688272809   Huang Ying   mm, gup: prevent ...
345
346
347
348
349
350
351
  		pmdval = READ_ONCE(*pmd);
  		/*
  		 * MADV_DONTNEED may convert the pmd to null because
  		 * mmap_sem is held in read mode
  		 */
  		if (pmd_none(pmdval))
  			return no_page_table(vma, flags);
84c3fc4e9   Zi Yan   mm: thp: check pm...
352
353
  		goto retry;
  	}
688272809   Huang Ying   mm, gup: prevent ...
354
  	if (pmd_devmap(pmdval)) {
3565fce3a   Dan Williams   mm, x86: get_user...
355
  		ptl = pmd_lock(mm, pmd);
df06b37ff   Keith Busch   mm/gup: cache dev...
356
  		page = follow_devmap_pmd(vma, address, pmd, flags, &ctx->pgmap);
3565fce3a   Dan Williams   mm, x86: get_user...
357
358
359
360
  		spin_unlock(ptl);
  		if (page)
  			return page;
  	}
688272809   Huang Ying   mm, gup: prevent ...
361
  	if (likely(!pmd_trans_huge(pmdval)))
df06b37ff   Keith Busch   mm/gup: cache dev...
362
  		return follow_page_pte(vma, address, pmd, flags, &ctx->pgmap);
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
363

688272809   Huang Ying   mm, gup: prevent ...
364
  	if ((flags & FOLL_NUMA) && pmd_protnone(pmdval))
db08f2030   Aneesh Kumar K.V   mm/gup: check for...
365
  		return no_page_table(vma, flags);
84c3fc4e9   Zi Yan   mm: thp: check pm...
366
  retry_locked:
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
367
  	ptl = pmd_lock(mm, pmd);
688272809   Huang Ying   mm, gup: prevent ...
368
369
370
371
  	if (unlikely(pmd_none(*pmd))) {
  		spin_unlock(ptl);
  		return no_page_table(vma, flags);
  	}
84c3fc4e9   Zi Yan   mm: thp: check pm...
372
373
374
375
376
377
378
  	if (unlikely(!pmd_present(*pmd))) {
  		spin_unlock(ptl);
  		if (likely(!(flags & FOLL_MIGRATION)))
  			return no_page_table(vma, flags);
  		pmd_migration_entry_wait(mm, pmd);
  		goto retry_locked;
  	}
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
379
380
  	if (unlikely(!pmd_trans_huge(*pmd))) {
  		spin_unlock(ptl);
df06b37ff   Keith Busch   mm/gup: cache dev...
381
  		return follow_page_pte(vma, address, pmd, flags, &ctx->pgmap);
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
382
  	}
bfe7b00de   Song Liu   mm, thp: introduc...
383
  	if (flags & (FOLL_SPLIT | FOLL_SPLIT_PMD)) {
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
384
385
386
387
388
  		int ret;
  		page = pmd_page(*pmd);
  		if (is_huge_zero_page(page)) {
  			spin_unlock(ptl);
  			ret = 0;
78ddc5347   Kirill A. Shutemov   thp: rename split...
389
  			split_huge_pmd(vma, pmd, address);
337d9abf1   Naoya Horiguchi   mm: thp: check pm...
390
391
  			if (pmd_trans_unstable(pmd))
  				ret = -EBUSY;
bfe7b00de   Song Liu   mm, thp: introduc...
392
  		} else if (flags & FOLL_SPLIT) {
8fde12ca7   Linus Torvalds   mm: prevent get_u...
393
394
395
396
  			if (unlikely(!try_get_page(page))) {
  				spin_unlock(ptl);
  				return ERR_PTR(-ENOMEM);
  			}
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
397
  			spin_unlock(ptl);
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
398
399
400
401
  			lock_page(page);
  			ret = split_huge_page(page);
  			unlock_page(page);
  			put_page(page);
baa355fd3   Kirill A. Shutemov   thp: file pages s...
402
403
  			if (pmd_none(*pmd))
  				return no_page_table(vma, flags);
bfe7b00de   Song Liu   mm, thp: introduc...
404
405
406
407
  		} else {  /* flags & FOLL_SPLIT_PMD */
  			spin_unlock(ptl);
  			split_huge_pmd(vma, pmd, address);
  			ret = pte_alloc(mm, pmd) ? -ENOMEM : 0;
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
408
409
410
  		}
  
  		return ret ? ERR_PTR(ret) :
df06b37ff   Keith Busch   mm/gup: cache dev...
411
  			follow_page_pte(vma, address, pmd, flags, &ctx->pgmap);
69e68b4f0   Kirill A. Shutemov   mm: cleanup follo...
412
  	}
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
413
414
  	page = follow_trans_huge_pmd(vma, address, pmd, flags);
  	spin_unlock(ptl);
df06b37ff   Keith Busch   mm/gup: cache dev...
415
  	ctx->page_mask = HPAGE_PMD_NR - 1;
6742d293c   Kirill A. Shutemov   mm: adjust FOLL_S...
416
  	return page;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
417
  }
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
418
419
  static struct page *follow_pud_mask(struct vm_area_struct *vma,
  				    unsigned long address, p4d_t *p4dp,
df06b37ff   Keith Busch   mm/gup: cache dev...
420
421
  				    unsigned int flags,
  				    struct follow_page_context *ctx)
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
  {
  	pud_t *pud;
  	spinlock_t *ptl;
  	struct page *page;
  	struct mm_struct *mm = vma->vm_mm;
  
  	pud = pud_offset(p4dp, address);
  	if (pud_none(*pud))
  		return no_page_table(vma, flags);
  	if (pud_huge(*pud) && vma->vm_flags & VM_HUGETLB) {
  		page = follow_huge_pud(mm, address, pud, flags);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
437
438
439
440
441
442
443
444
  	if (is_hugepd(__hugepd(pud_val(*pud)))) {
  		page = follow_huge_pd(vma, address,
  				      __hugepd(pud_val(*pud)), flags,
  				      PUD_SHIFT);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
445
446
  	if (pud_devmap(*pud)) {
  		ptl = pud_lock(mm, pud);
df06b37ff   Keith Busch   mm/gup: cache dev...
447
  		page = follow_devmap_pud(vma, address, pud, flags, &ctx->pgmap);
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
448
449
450
451
452
453
  		spin_unlock(ptl);
  		if (page)
  			return page;
  	}
  	if (unlikely(pud_bad(*pud)))
  		return no_page_table(vma, flags);
df06b37ff   Keith Busch   mm/gup: cache dev...
454
  	return follow_pmd_mask(vma, address, pud, flags, ctx);
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
455
  }
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
456
457
  static struct page *follow_p4d_mask(struct vm_area_struct *vma,
  				    unsigned long address, pgd_t *pgdp,
df06b37ff   Keith Busch   mm/gup: cache dev...
458
459
  				    unsigned int flags,
  				    struct follow_page_context *ctx)
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
460
461
  {
  	p4d_t *p4d;
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
462
  	struct page *page;
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
463
464
465
466
467
468
469
  
  	p4d = p4d_offset(pgdp, address);
  	if (p4d_none(*p4d))
  		return no_page_table(vma, flags);
  	BUILD_BUG_ON(p4d_huge(*p4d));
  	if (unlikely(p4d_bad(*p4d)))
  		return no_page_table(vma, flags);
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
470
471
472
473
474
475
476
477
  	if (is_hugepd(__hugepd(p4d_val(*p4d)))) {
  		page = follow_huge_pd(vma, address,
  				      __hugepd(p4d_val(*p4d)), flags,
  				      P4D_SHIFT);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
df06b37ff   Keith Busch   mm/gup: cache dev...
478
  	return follow_pud_mask(vma, address, p4d, flags, ctx);
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
479
480
481
482
483
484
485
  }
  
  /**
   * follow_page_mask - look up a page descriptor from a user-virtual address
   * @vma: vm_area_struct mapping @address
   * @address: virtual address to look up
   * @flags: flags modifying lookup behaviour
78179556e   Mike Rapoport   mm/gup.c: fix fol...
486
487
   * @ctx: contains dev_pagemap for %ZONE_DEVICE memory pinning and a
   *       pointer to output page_mask
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
488
489
490
   *
   * @flags can have FOLL_ flags set, defined in <linux/mm.h>
   *
78179556e   Mike Rapoport   mm/gup.c: fix fol...
491
492
493
494
495
496
   * When getting pages from ZONE_DEVICE memory, the @ctx->pgmap caches
   * the device's dev_pagemap metadata to avoid repeating expensive lookups.
   *
   * On output, the @ctx->page_mask is set according to the size of the page.
   *
   * Return: the mapped (struct page *), %NULL if no mapping exists, or
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
497
498
499
   * an error pointer if there is a mapping to something not represented
   * by a page descriptor (see also vm_normal_page()).
   */
a7030aea2   Bharath Vedartham   mm/gup.c: make fo...
500
  static struct page *follow_page_mask(struct vm_area_struct *vma,
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
501
  			      unsigned long address, unsigned int flags,
df06b37ff   Keith Busch   mm/gup: cache dev...
502
  			      struct follow_page_context *ctx)
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
503
504
505
506
  {
  	pgd_t *pgd;
  	struct page *page;
  	struct mm_struct *mm = vma->vm_mm;
df06b37ff   Keith Busch   mm/gup: cache dev...
507
  	ctx->page_mask = 0;
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
508
509
510
511
512
513
514
515
516
517
518
519
  
  	/* make this handle hugepd */
  	page = follow_huge_addr(mm, address, flags & FOLL_WRITE);
  	if (!IS_ERR(page)) {
  		BUG_ON(flags & FOLL_GET);
  		return page;
  	}
  
  	pgd = pgd_offset(mm, address);
  
  	if (pgd_none(*pgd) || unlikely(pgd_bad(*pgd)))
  		return no_page_table(vma, flags);
faaa5b62d   Anshuman Khandual   mm/follow_page_ma...
520
521
522
523
524
525
  	if (pgd_huge(*pgd)) {
  		page = follow_huge_pgd(mm, address, pgd, flags);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
4dc71451a   Aneesh Kumar K.V   mm/follow_page_ma...
526
527
528
529
530
531
532
533
  	if (is_hugepd(__hugepd(pgd_val(*pgd)))) {
  		page = follow_huge_pd(vma, address,
  				      __hugepd(pgd_val(*pgd)), flags,
  				      PGDIR_SHIFT);
  		if (page)
  			return page;
  		return no_page_table(vma, flags);
  	}
faaa5b62d   Anshuman Khandual   mm/follow_page_ma...
534

df06b37ff   Keith Busch   mm/gup: cache dev...
535
536
537
538
539
540
541
542
543
544
545
546
547
  	return follow_p4d_mask(vma, address, pgd, flags, ctx);
  }
  
  struct page *follow_page(struct vm_area_struct *vma, unsigned long address,
  			 unsigned int foll_flags)
  {
  	struct follow_page_context ctx = { NULL };
  	struct page *page;
  
  	page = follow_page_mask(vma, address, foll_flags, &ctx);
  	if (ctx.pgmap)
  		put_dev_pagemap(ctx.pgmap);
  	return page;
080dbb618   Aneesh Kumar K.V   mm/follow_page_ma...
548
  }
f2b495ca8   Kirill A. Shutemov   mm: extract in_ga...
549
550
551
552
553
  static int get_gate_page(struct mm_struct *mm, unsigned long address,
  		unsigned int gup_flags, struct vm_area_struct **vma,
  		struct page **page)
  {
  	pgd_t *pgd;
c2febafc6   Kirill A. Shutemov   mm: convert gener...
554
  	p4d_t *p4d;
f2b495ca8   Kirill A. Shutemov   mm: extract in_ga...
555
556
557
558
559
560
561
562
563
564
565
566
  	pud_t *pud;
  	pmd_t *pmd;
  	pte_t *pte;
  	int ret = -EFAULT;
  
  	/* user gate pages are read-only */
  	if (gup_flags & FOLL_WRITE)
  		return -EFAULT;
  	if (address > TASK_SIZE)
  		pgd = pgd_offset_k(address);
  	else
  		pgd = pgd_offset_gate(mm, address);
b5d1c39f3   Andy Lutomirski   mm/gup.c: remove ...
567
568
  	if (pgd_none(*pgd))
  		return -EFAULT;
c2febafc6   Kirill A. Shutemov   mm: convert gener...
569
  	p4d = p4d_offset(pgd, address);
b5d1c39f3   Andy Lutomirski   mm/gup.c: remove ...
570
571
  	if (p4d_none(*p4d))
  		return -EFAULT;
c2febafc6   Kirill A. Shutemov   mm: convert gener...
572
  	pud = pud_offset(p4d, address);
b5d1c39f3   Andy Lutomirski   mm/gup.c: remove ...
573
574
  	if (pud_none(*pud))
  		return -EFAULT;
f2b495ca8   Kirill A. Shutemov   mm: extract in_ga...
575
  	pmd = pmd_offset(pud, address);
84c3fc4e9   Zi Yan   mm: thp: check pm...
576
  	if (!pmd_present(*pmd))
f2b495ca8   Kirill A. Shutemov   mm: extract in_ga...
577
578
579
580
581
582
583
584
585
586
587
588
589
590
  		return -EFAULT;
  	VM_BUG_ON(pmd_trans_huge(*pmd));
  	pte = pte_offset_map(pmd, address);
  	if (pte_none(*pte))
  		goto unmap;
  	*vma = get_gate_vma(mm);
  	if (!page)
  		goto out;
  	*page = vm_normal_page(*vma, address, *pte);
  	if (!*page) {
  		if ((gup_flags & FOLL_DUMP) || !is_zero_pfn(pte_pfn(*pte)))
  			goto unmap;
  		*page = pte_page(*pte);
  	}
8fde12ca7   Linus Torvalds   mm: prevent get_u...
591
592
593
594
  	if (unlikely(!try_get_page(*page))) {
  		ret = -ENOMEM;
  		goto unmap;
  	}
f2b495ca8   Kirill A. Shutemov   mm: extract in_ga...
595
596
597
598
599
600
  out:
  	ret = 0;
  unmap:
  	pte_unmap(pte);
  	return ret;
  }
9a95f3cf7   Paul Cassella   mm: describe mmap...
601
602
603
604
605
  /*
   * mmap_sem must be held on entry.  If @nonblocking != NULL and
   * *@flags does not include FOLL_NOWAIT, the mmap_sem may be released.
   * If it is, *@nonblocking will be set to 0 and -EBUSY returned.
   */
167444834   Kirill A. Shutemov   mm: extract code ...
606
607
608
  static int faultin_page(struct task_struct *tsk, struct vm_area_struct *vma,
  		unsigned long address, unsigned int *flags, int *nonblocking)
  {
167444834   Kirill A. Shutemov   mm: extract code ...
609
  	unsigned int fault_flags = 0;
2b7403035   Souptick Joarder   mm: Change return...
610
  	vm_fault_t ret;
167444834   Kirill A. Shutemov   mm: extract code ...
611

de60f5f10   Eric B Munson   mm: introduce VM_...
612
613
614
  	/* mlock all present pages, but do not fault in new pages */
  	if ((*flags & (FOLL_POPULATE | FOLL_MLOCK)) == FOLL_MLOCK)
  		return -ENOENT;
167444834   Kirill A. Shutemov   mm: extract code ...
615
616
  	if (*flags & FOLL_WRITE)
  		fault_flags |= FAULT_FLAG_WRITE;
1b2ee1266   Dave Hansen   mm/core: Do not e...
617
618
  	if (*flags & FOLL_REMOTE)
  		fault_flags |= FAULT_FLAG_REMOTE;
167444834   Kirill A. Shutemov   mm: extract code ...
619
620
621
622
  	if (nonblocking)
  		fault_flags |= FAULT_FLAG_ALLOW_RETRY;
  	if (*flags & FOLL_NOWAIT)
  		fault_flags |= FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT;
234b239be   Andres Lagar-Cavilla   kvm: Faults which...
623
624
625
626
  	if (*flags & FOLL_TRIED) {
  		VM_WARN_ON_ONCE(fault_flags & FAULT_FLAG_ALLOW_RETRY);
  		fault_flags |= FAULT_FLAG_TRIED;
  	}
167444834   Kirill A. Shutemov   mm: extract code ...
627

dcddffd41   Kirill A. Shutemov   mm: do not pass m...
628
  	ret = handle_mm_fault(vma, address, fault_flags);
167444834   Kirill A. Shutemov   mm: extract code ...
629
  	if (ret & VM_FAULT_ERROR) {
9a291a7c9   James Morse   mm/hugetlb: repor...
630
631
632
633
  		int err = vm_fault_to_errno(ret, *flags);
  
  		if (err)
  			return err;
167444834   Kirill A. Shutemov   mm: extract code ...
634
635
636
637
638
639
640
641
642
643
644
  		BUG();
  	}
  
  	if (tsk) {
  		if (ret & VM_FAULT_MAJOR)
  			tsk->maj_flt++;
  		else
  			tsk->min_flt++;
  	}
  
  	if (ret & VM_FAULT_RETRY) {
96312e612   Andrea Arcangeli   mm/gup.c: teach g...
645
  		if (nonblocking && !(fault_flags & FAULT_FLAG_RETRY_NOWAIT))
167444834   Kirill A. Shutemov   mm: extract code ...
646
647
648
649
650
651
652
653
654
655
656
657
658
659
  			*nonblocking = 0;
  		return -EBUSY;
  	}
  
  	/*
  	 * The VM_FAULT_WRITE bit tells us that do_wp_page has broken COW when
  	 * necessary, even if maybe_mkwrite decided not to set pte_write. We
  	 * can thus safely do subsequent page lookups as if they were reads.
  	 * But only do so when looping for pte_write is futile: in some cases
  	 * userspace may also be wanting to write to the gotten user page,
  	 * which a read fault here might prevent (a readonly page might get
  	 * reCOWed by userspace write).
  	 */
  	if ((ret & VM_FAULT_WRITE) && !(vma->vm_flags & VM_WRITE))
2923117b7   Mario Leinweber   mm/gup.c: fix cod...
660
  		*flags |= FOLL_COW;
167444834   Kirill A. Shutemov   mm: extract code ...
661
662
  	return 0;
  }
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
663
664
665
  static int check_vma_flags(struct vm_area_struct *vma, unsigned long gup_flags)
  {
  	vm_flags_t vm_flags = vma->vm_flags;
1b2ee1266   Dave Hansen   mm/core: Do not e...
666
667
  	int write = (gup_flags & FOLL_WRITE);
  	int foreign = (gup_flags & FOLL_REMOTE);
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
668
669
670
  
  	if (vm_flags & (VM_IO | VM_PFNMAP))
  		return -EFAULT;
7f7ccc2cc   Willy Tarreau   proc: do not acce...
671
672
  	if (gup_flags & FOLL_ANON && !vma_is_anonymous(vma))
  		return -EFAULT;
1b2ee1266   Dave Hansen   mm/core: Do not e...
673
  	if (write) {
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
674
675
676
677
678
679
680
681
682
683
684
685
  		if (!(vm_flags & VM_WRITE)) {
  			if (!(gup_flags & FOLL_FORCE))
  				return -EFAULT;
  			/*
  			 * We used to let the write,force case do COW in a
  			 * VM_MAYWRITE VM_SHARED !VM_WRITE vma, so ptrace could
  			 * set a breakpoint in a read-only mapping of an
  			 * executable, without corrupting the file (yet only
  			 * when that file had been opened for writing!).
  			 * Anon pages in shared mappings are surprising: now
  			 * just reject it.
  			 */
464353647   Hugh Dickins   mm: retire GUP WA...
686
  			if (!is_cow_mapping(vm_flags))
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
687
  				return -EFAULT;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
688
689
690
691
692
693
694
695
696
697
698
  		}
  	} else if (!(vm_flags & VM_READ)) {
  		if (!(gup_flags & FOLL_FORCE))
  			return -EFAULT;
  		/*
  		 * Is there actually any vma we can reach here which does not
  		 * have VM_MAYREAD set?
  		 */
  		if (!(vm_flags & VM_MAYREAD))
  			return -EFAULT;
  	}
d61172b4b   Dave Hansen   mm/core, x86/mm/p...
699
700
701
702
703
  	/*
  	 * gups are always data accesses, not instruction
  	 * fetches, so execute=false here
  	 */
  	if (!arch_vma_access_permitted(vma, write, false, foreign))
33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
704
  		return -EFAULT;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
705
706
  	return 0;
  }
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
  /**
   * __get_user_pages() - pin user pages in memory
   * @tsk:	task_struct of target task
   * @mm:		mm_struct of target mm
   * @start:	starting user address
   * @nr_pages:	number of pages from start to pin
   * @gup_flags:	flags modifying pin behaviour
   * @pages:	array that receives pointers to the pages pinned.
   *		Should be at least nr_pages long. Or NULL, if caller
   *		only intends to ensure the pages are faulted in.
   * @vmas:	array of pointers to vmas corresponding to each page.
   *		Or NULL if the caller does not require them.
   * @nonblocking: whether waiting for disk IO or mmap_sem contention
   *
   * Returns number of pages pinned. This may be fewer than the number
   * requested. If nr_pages is 0 or negative, returns 0. If no pages
   * were pinned, returns -errno. Each page returned must be released
   * with a put_page() call when it is finished with. vmas will only
   * remain valid while mmap_sem is held.
   *
9a95f3cf7   Paul Cassella   mm: describe mmap...
727
   * Must be called with mmap_sem held.  It may be released.  See below.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
   *
   * __get_user_pages walks a process's page tables and takes a reference to
   * each struct page that each user address corresponds to at a given
   * instant. That is, it takes the page that would be accessed if a user
   * thread accesses the given user virtual address at that instant.
   *
   * This does not guarantee that the page exists in the user mappings when
   * __get_user_pages returns, and there may even be a completely different
   * page there in some cases (eg. if mmapped pagecache has been invalidated
   * and subsequently re faulted). However it does guarantee that the page
   * won't be freed completely. And mostly callers simply care that the page
   * contains data that was valid *at some point in time*. Typically, an IO
   * or similar operation cannot guarantee anything stronger anyway because
   * locks can't be held over the syscall boundary.
   *
   * If @gup_flags & FOLL_WRITE == 0, the page must not be written to. If
   * the page is written to, set_page_dirty (or set_page_dirty_lock, as
   * appropriate) must be called after the page is finished with, and
   * before put_page is called.
   *
   * If @nonblocking != NULL, __get_user_pages will not wait for disk IO
   * or mmap_sem contention, and if waiting is needed to pin all pages,
9a95f3cf7   Paul Cassella   mm: describe mmap...
750
751
752
753
754
755
756
757
   * *@nonblocking will be set to 0.  Further, if @gup_flags does not
   * include FOLL_NOWAIT, the mmap_sem will be released via up_read() in
   * this case.
   *
   * A caller using such a combination of @nonblocking and @gup_flags
   * must therefore hold the mmap_sem for reading only, and recognize
   * when it's been released.  Otherwise, it must be held for either
   * reading or writing and will not be released.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
758
759
760
761
762
   *
   * In most cases, get_user_pages or get_user_pages_fast should be used
   * instead of __get_user_pages. __get_user_pages should be used only if
   * you need some special @gup_flags.
   */
0d7317598   Lorenzo Stoakes   mm: unexport __ge...
763
  static long __get_user_pages(struct task_struct *tsk, struct mm_struct *mm,
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
764
765
766
767
  		unsigned long start, unsigned long nr_pages,
  		unsigned int gup_flags, struct page **pages,
  		struct vm_area_struct **vmas, int *nonblocking)
  {
df06b37ff   Keith Busch   mm/gup: cache dev...
768
  	long ret = 0, i = 0;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
769
  	struct vm_area_struct *vma = NULL;
df06b37ff   Keith Busch   mm/gup: cache dev...
770
  	struct follow_page_context ctx = { NULL };
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
771
772
773
  
  	if (!nr_pages)
  		return 0;
f96525941   Andrey Konovalov   mm: untag user po...
774
  	start = untagged_addr(start);
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
775
776
777
778
779
780
781
782
783
  	VM_BUG_ON(!!pages != !!(gup_flags & FOLL_GET));
  
  	/*
  	 * If FOLL_FORCE is set then do not force a full fault as the hinting
  	 * fault information is unrelated to the reference behaviour of a task
  	 * using the address space
  	 */
  	if (!(gup_flags & FOLL_FORCE))
  		gup_flags |= FOLL_NUMA;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
784
  	do {
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
785
786
787
788
789
790
791
792
  		struct page *page;
  		unsigned int foll_flags = gup_flags;
  		unsigned int page_increm;
  
  		/* first iteration or cross vma bound */
  		if (!vma || start >= vma->vm_end) {
  			vma = find_extend_vma(mm, start);
  			if (!vma && in_gate_area(mm, start)) {
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
793
794
795
796
  				ret = get_gate_page(mm, start & PAGE_MASK,
  						gup_flags, &vma,
  						pages ? &pages[i] : NULL);
  				if (ret)
08be37b79   John Hubbard   mm/gup: finish co...
797
  					goto out;
df06b37ff   Keith Busch   mm/gup: cache dev...
798
  				ctx.page_mask = 0;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
799
800
  				goto next_page;
  			}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
801

df06b37ff   Keith Busch   mm/gup: cache dev...
802
803
804
805
  			if (!vma || check_vma_flags(vma, gup_flags)) {
  				ret = -EFAULT;
  				goto out;
  			}
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
806
  			if (is_vm_hugetlb_page(vma)) {
1027dc04f   Linus Torvalds   gup: document and...
807
808
  				if (should_force_cow_break(vma, foll_flags))
  					foll_flags |= FOLL_WRITE;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
809
810
  				i = follow_hugetlb_page(mm, vma, pages, vmas,
  						&start, &nr_pages, i,
1027dc04f   Linus Torvalds   gup: document and...
811
  						foll_flags, nonblocking);
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
812
  				continue;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
813
  			}
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
814
  		}
1027dc04f   Linus Torvalds   gup: document and...
815
816
817
  
  		if (should_force_cow_break(vma, foll_flags))
  			foll_flags |= FOLL_WRITE;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
818
819
820
821
822
  retry:
  		/*
  		 * If we have a pending SIGKILL, don't keep faulting pages and
  		 * potentially allocating memory.
  		 */
fa45f1162   Davidlohr Bueso   mm/: remove calle...
823
  		if (fatal_signal_pending(current)) {
df06b37ff   Keith Busch   mm/gup: cache dev...
824
825
826
  			ret = -ERESTARTSYS;
  			goto out;
  		}
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
827
  		cond_resched();
df06b37ff   Keith Busch   mm/gup: cache dev...
828
829
  
  		page = follow_page_mask(vma, start, foll_flags, &ctx);
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
830
  		if (!page) {
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
831
832
833
834
835
  			ret = faultin_page(tsk, vma, start, &foll_flags,
  					nonblocking);
  			switch (ret) {
  			case 0:
  				goto retry;
df06b37ff   Keith Busch   mm/gup: cache dev...
836
837
838
  			case -EBUSY:
  				ret = 0;
  				/* FALLTHRU */
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
839
840
841
  			case -EFAULT:
  			case -ENOMEM:
  			case -EHWPOISON:
df06b37ff   Keith Busch   mm/gup: cache dev...
842
  				goto out;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
843
844
  			case -ENOENT:
  				goto next_page;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
845
  			}
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
846
  			BUG();
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
847
848
849
850
851
852
853
  		} else if (PTR_ERR(page) == -EEXIST) {
  			/*
  			 * Proper page table entry exists, but no corresponding
  			 * struct page.
  			 */
  			goto next_page;
  		} else if (IS_ERR(page)) {
df06b37ff   Keith Busch   mm/gup: cache dev...
854
855
  			ret = PTR_ERR(page);
  			goto out;
1027e4436   Kirill A. Shutemov   mm: make GUP hand...
856
  		}
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
857
858
859
860
  		if (pages) {
  			pages[i] = page;
  			flush_anon_page(vma, page, start);
  			flush_dcache_page(page);
df06b37ff   Keith Busch   mm/gup: cache dev...
861
  			ctx.page_mask = 0;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
862
  		}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
863
  next_page:
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
864
865
  		if (vmas) {
  			vmas[i] = vma;
df06b37ff   Keith Busch   mm/gup: cache dev...
866
  			ctx.page_mask = 0;
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
867
  		}
df06b37ff   Keith Busch   mm/gup: cache dev...
868
  		page_increm = 1 + (~(start >> PAGE_SHIFT) & ctx.page_mask);
fa5bb2093   Kirill A. Shutemov   mm: cleanup __get...
869
870
871
872
873
  		if (page_increm > nr_pages)
  			page_increm = nr_pages;
  		i += page_increm;
  		start += page_increm * PAGE_SIZE;
  		nr_pages -= page_increm;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
874
  	} while (nr_pages);
df06b37ff   Keith Busch   mm/gup: cache dev...
875
876
877
878
  out:
  	if (ctx.pgmap)
  		put_dev_pagemap(ctx.pgmap);
  	return i ? i : ret;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
879
  }
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
880

771ab4302   Tobias Klauser   mm/gup.c: make un...
881
882
  static bool vma_permits_fault(struct vm_area_struct *vma,
  			      unsigned int fault_flags)
d4925e00d   Dave Hansen   mm/gup: Factor ou...
883
  {
1b2ee1266   Dave Hansen   mm/core: Do not e...
884
885
  	bool write   = !!(fault_flags & FAULT_FLAG_WRITE);
  	bool foreign = !!(fault_flags & FAULT_FLAG_REMOTE);
33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
886
  	vm_flags_t vm_flags = write ? VM_WRITE : VM_READ;
d4925e00d   Dave Hansen   mm/gup: Factor ou...
887
888
889
  
  	if (!(vm_flags & vma->vm_flags))
  		return false;
33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
890
891
  	/*
  	 * The architecture might have a hardware protection
1b2ee1266   Dave Hansen   mm/core: Do not e...
892
  	 * mechanism other than read/write that can deny access.
d61172b4b   Dave Hansen   mm/core, x86/mm/p...
893
894
895
  	 *
  	 * gup always represents data access, not instruction
  	 * fetches, so execute=false here:
33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
896
  	 */
d61172b4b   Dave Hansen   mm/core, x86/mm/p...
897
  	if (!arch_vma_access_permitted(vma, write, false, foreign))
33a709b25   Dave Hansen   mm/gup, x86/mm/pk...
898
  		return false;
d4925e00d   Dave Hansen   mm/gup: Factor ou...
899
900
  	return true;
  }
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
901
902
903
904
905
906
907
  /*
   * fixup_user_fault() - manually resolve a user page fault
   * @tsk:	the task_struct to use for page fault accounting, or
   *		NULL if faults are not to be recorded.
   * @mm:		mm_struct of target mm
   * @address:	user address
   * @fault_flags:flags to pass down to handle_mm_fault()
4a9e1cda2   Dominik Dingel   mm: bring in addi...
908
909
   * @unlocked:	did we unlock the mmap_sem while retrying, maybe NULL if caller
   *		does not allow retry
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
910
911
912
913
914
915
916
917
918
919
920
   *
   * This is meant to be called in the specific scenario where for locking reasons
   * we try to access user memory in atomic context (within a pagefault_disable()
   * section), this returns -EFAULT, and we want to resolve the user fault before
   * trying again.
   *
   * Typically this is meant to be used by the futex code.
   *
   * The main difference with get_user_pages() is that this function will
   * unconditionally call handle_mm_fault() which will in turn perform all the
   * necessary SW fixup of the dirty and young bits in the PTE, while
4a9e1cda2   Dominik Dingel   mm: bring in addi...
921
   * get_user_pages() only guarantees to update these in the struct page.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
922
923
924
925
926
927
   *
   * This is important for some architectures where those bits also gate the
   * access permission to the page because they are maintained in software.  On
   * such architectures, gup() will not be enough to make a subsequent access
   * succeed.
   *
4a9e1cda2   Dominik Dingel   mm: bring in addi...
928
929
   * This function will not return with an unlocked mmap_sem. So it has not the
   * same semantics wrt the @mm->mmap_sem as does filemap_fault().
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
930
931
   */
  int fixup_user_fault(struct task_struct *tsk, struct mm_struct *mm,
4a9e1cda2   Dominik Dingel   mm: bring in addi...
932
933
  		     unsigned long address, unsigned int fault_flags,
  		     bool *unlocked)
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
934
935
  {
  	struct vm_area_struct *vma;
2b7403035   Souptick Joarder   mm: Change return...
936
  	vm_fault_t ret, major = 0;
4a9e1cda2   Dominik Dingel   mm: bring in addi...
937

f96525941   Andrey Konovalov   mm: untag user po...
938
  	address = untagged_addr(address);
4a9e1cda2   Dominik Dingel   mm: bring in addi...
939
940
  	if (unlocked)
  		fault_flags |= FAULT_FLAG_ALLOW_RETRY;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
941

4a9e1cda2   Dominik Dingel   mm: bring in addi...
942
  retry:
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
943
944
945
  	vma = find_extend_vma(mm, address);
  	if (!vma || address < vma->vm_start)
  		return -EFAULT;
d4925e00d   Dave Hansen   mm/gup: Factor ou...
946
  	if (!vma_permits_fault(vma, fault_flags))
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
947
  		return -EFAULT;
dcddffd41   Kirill A. Shutemov   mm: do not pass m...
948
  	ret = handle_mm_fault(vma, address, fault_flags);
4a9e1cda2   Dominik Dingel   mm: bring in addi...
949
  	major |= ret & VM_FAULT_MAJOR;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
950
  	if (ret & VM_FAULT_ERROR) {
9a291a7c9   James Morse   mm/hugetlb: repor...
951
952
953
954
  		int err = vm_fault_to_errno(ret, 0);
  
  		if (err)
  			return err;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
955
956
  		BUG();
  	}
4a9e1cda2   Dominik Dingel   mm: bring in addi...
957
958
959
960
961
962
963
964
965
966
  
  	if (ret & VM_FAULT_RETRY) {
  		down_read(&mm->mmap_sem);
  		if (!(fault_flags & FAULT_FLAG_TRIED)) {
  			*unlocked = true;
  			fault_flags &= ~FAULT_FLAG_ALLOW_RETRY;
  			fault_flags |= FAULT_FLAG_TRIED;
  			goto retry;
  		}
  	}
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
967
  	if (tsk) {
4a9e1cda2   Dominik Dingel   mm: bring in addi...
968
  		if (major)
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
969
970
971
972
973
974
  			tsk->maj_flt++;
  		else
  			tsk->min_flt++;
  	}
  	return 0;
  }
add6a0cd1   Paolo Bonzini   KVM: MMU: try to ...
975
  EXPORT_SYMBOL_GPL(fixup_user_fault);
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
976

f0818f472   Andrea Arcangeli   mm: gup: add get_...
977
978
979
980
  static __always_inline long __get_user_pages_locked(struct task_struct *tsk,
  						struct mm_struct *mm,
  						unsigned long start,
  						unsigned long nr_pages,
f0818f472   Andrea Arcangeli   mm: gup: add get_...
981
982
  						struct page **pages,
  						struct vm_area_struct **vmas,
e716712f8   Al Viro   __get_user_pages_...
983
  						int *locked,
0fd71a56f   Andrea Arcangeli   mm: gup: add __ge...
984
  						unsigned int flags)
f0818f472   Andrea Arcangeli   mm: gup: add get_...
985
  {
f0818f472   Andrea Arcangeli   mm: gup: add get_...
986
987
988
989
990
991
992
993
994
995
996
997
  	long ret, pages_done;
  	bool lock_dropped;
  
  	if (locked) {
  		/* if VM_FAULT_RETRY can be returned, vmas become invalid */
  		BUG_ON(vmas);
  		/* check caller initialized locked */
  		BUG_ON(*locked != 1);
  	}
  
  	if (pages)
  		flags |= FOLL_GET;
f0818f472   Andrea Arcangeli   mm: gup: add get_...
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
  
  	pages_done = 0;
  	lock_dropped = false;
  	for (;;) {
  		ret = __get_user_pages(tsk, mm, start, nr_pages, flags, pages,
  				       vmas, locked);
  		if (!locked)
  			/* VM_FAULT_RETRY couldn't trigger, bypass */
  			return ret;
  
  		/* VM_FAULT_RETRY cannot return errors */
  		if (!*locked) {
  			BUG_ON(ret < 0);
  			BUG_ON(ret >= nr_pages);
  		}
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1013
1014
1015
1016
1017
1018
1019
  		if (ret > 0) {
  			nr_pages -= ret;
  			pages_done += ret;
  			if (!nr_pages)
  				break;
  		}
  		if (*locked) {
96312e612   Andrea Arcangeli   mm/gup.c: teach g...
1020
1021
1022
1023
  			/*
  			 * VM_FAULT_RETRY didn't trigger or it was a
  			 * FOLL_NOWAIT.
  			 */
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1024
1025
1026
1027
  			if (!pages_done)
  				pages_done = ret;
  			break;
  		}
df17277b2   Mike Rapoport   mm/gup: continue ...
1028
1029
1030
1031
1032
1033
  		/*
  		 * VM_FAULT_RETRY triggered, so seek to the faulting offset.
  		 * For the prefault case (!pages) we only update counts.
  		 */
  		if (likely(pages))
  			pages += ret;
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
  		start += ret << PAGE_SHIFT;
  
  		/*
  		 * Repeat on the address that fired VM_FAULT_RETRY
  		 * without FAULT_FLAG_ALLOW_RETRY but with
  		 * FAULT_FLAG_TRIED.
  		 */
  		*locked = 1;
  		lock_dropped = true;
  		down_read(&mm->mmap_sem);
  		ret = __get_user_pages(tsk, mm, start, 1, flags | FOLL_TRIED,
  				       pages, NULL, NULL);
  		if (ret != 1) {
  			BUG_ON(ret > 1);
  			if (!pages_done)
  				pages_done = ret;
  			break;
  		}
  		nr_pages--;
  		pages_done++;
  		if (!nr_pages)
  			break;
df17277b2   Mike Rapoport   mm/gup: continue ...
1056
1057
  		if (likely(pages))
  			pages++;
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1058
1059
  		start += PAGE_SIZE;
  	}
e716712f8   Al Viro   __get_user_pages_...
1060
  	if (lock_dropped && *locked) {
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
  		/*
  		 * We must let the caller know we temporarily dropped the lock
  		 * and so the critical section protected by it was lost.
  		 */
  		up_read(&mm->mmap_sem);
  		*locked = 0;
  	}
  	return pages_done;
  }
  
  /*
1e9877902   Dave Hansen   mm/gup: Introduce...
1072
   * get_user_pages_remote() - pin user pages in memory
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1073
1074
1075
1076
1077
   * @tsk:	the task_struct to use for page fault accounting, or
   *		NULL if faults are not to be recorded.
   * @mm:		mm_struct of target mm
   * @start:	starting user address
   * @nr_pages:	number of pages from start to pin
9beae1ea8   Lorenzo Stoakes   mm: replace get_u...
1078
   * @gup_flags:	flags modifying lookup behaviour
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1079
1080
1081
1082
1083
   * @pages:	array that receives pointers to the pages pinned.
   *		Should be at least nr_pages long. Or NULL, if caller
   *		only intends to ensure the pages are faulted in.
   * @vmas:	array of pointers to vmas corresponding to each page.
   *		Or NULL if the caller does not require them.
5b56d49fc   Lorenzo Stoakes   mm: add locked pa...
1084
1085
1086
   * @locked:	pointer to lock flag indicating whether lock is held and
   *		subsequently whether VM_FAULT_RETRY functionality can be
   *		utilised. Lock must initially be held.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
   *
   * Returns number of pages pinned. This may be fewer than the number
   * requested. If nr_pages is 0 or negative, returns 0. If no pages
   * were pinned, returns -errno. Each page returned must be released
   * with a put_page() call when it is finished with. vmas will only
   * remain valid while mmap_sem is held.
   *
   * Must be called with mmap_sem held for read or write.
   *
   * get_user_pages walks a process's page tables and takes a reference to
   * each struct page that each user address corresponds to at a given
   * instant. That is, it takes the page that would be accessed if a user
   * thread accesses the given user virtual address at that instant.
   *
   * This does not guarantee that the page exists in the user mappings when
   * get_user_pages returns, and there may even be a completely different
   * page there in some cases (eg. if mmapped pagecache has been invalidated
   * and subsequently re faulted). However it does guarantee that the page
   * won't be freed completely. And mostly callers simply care that the page
   * contains data that was valid *at some point in time*. Typically, an IO
   * or similar operation cannot guarantee anything stronger anyway because
   * locks can't be held over the syscall boundary.
   *
9beae1ea8   Lorenzo Stoakes   mm: replace get_u...
1110
1111
1112
   * If gup_flags & FOLL_WRITE == 0, the page must not be written to. If the page
   * is written to, set_page_dirty (or set_page_dirty_lock, as appropriate) must
   * be called after the page is finished with, and before put_page is called.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1113
1114
1115
1116
1117
1118
1119
1120
   *
   * get_user_pages is typically used for fewer-copy IO operations, to get a
   * handle on the memory by some means other than accesses via the user virtual
   * addresses. The pages may be submitted for DMA to devices or accessed via
   * their kernel linear mapping (via the kmap APIs). Care should be taken to
   * use the correct cache flushing APIs.
   *
   * See also get_user_pages_fast, for performance critical applications.
f0818f472   Andrea Arcangeli   mm: gup: add get_...
1121
1122
1123
1124
1125
   *
   * get_user_pages should be phased out in favor of
   * get_user_pages_locked|unlocked or get_user_pages_fast. Nothing
   * should use get_user_pages because it cannot pass
   * FAULT_FLAG_ALLOW_RETRY to handle_mm_fault.
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1126
   */
1e9877902   Dave Hansen   mm/gup: Introduce...
1127
1128
  long get_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
  		unsigned long start, unsigned long nr_pages,
9beae1ea8   Lorenzo Stoakes   mm: replace get_u...
1129
  		unsigned int gup_flags, struct page **pages,
5b56d49fc   Lorenzo Stoakes   mm: add locked pa...
1130
  		struct vm_area_struct **vmas, int *locked)
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1131
  {
932f4a630   Ira Weiny   mm/gup: replace g...
1132
1133
1134
1135
1136
1137
1138
1139
  	/*
  	 * FIXME: Current FOLL_LONGTERM behavior is incompatible with
  	 * FAULT_FLAG_ALLOW_RETRY because of the FS DAX check requirement on
  	 * vmas.  As there are no users of this flag in this call we simply
  	 * disallow this option for now.
  	 */
  	if (WARN_ON_ONCE(gup_flags & FOLL_LONGTERM))
  		return -EINVAL;
859110d74   Lorenzo Stoakes   mm: remove write/...
1140
  	return __get_user_pages_locked(tsk, mm, start, nr_pages, pages, vmas,
e716712f8   Al Viro   __get_user_pages_...
1141
  				       locked,
9beae1ea8   Lorenzo Stoakes   mm: replace get_u...
1142
  				       gup_flags | FOLL_TOUCH | FOLL_REMOTE);
1e9877902   Dave Hansen   mm/gup: Introduce...
1143
1144
  }
  EXPORT_SYMBOL(get_user_pages_remote);
d3649f68b   Christoph Hellwig   mm: reorder code ...
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
  /**
   * populate_vma_page_range() -  populate a range of pages in the vma.
   * @vma:   target vma
   * @start: start address
   * @end:   end address
   * @nonblocking:
   *
   * This takes care of mlocking the pages too if VM_LOCKED is set.
   *
   * return 0 on success, negative error code on error.
   *
   * vma->vm_mm->mmap_sem must be held.
   *
   * If @nonblocking is NULL, it may be held for read or write and will
   * be unperturbed.
   *
   * If @nonblocking is non-NULL, it must held for read only and may be
   * released.  If it's released, *@nonblocking will be set to 0.
   */
  long populate_vma_page_range(struct vm_area_struct *vma,
  		unsigned long start, unsigned long end, int *nonblocking)
  {
  	struct mm_struct *mm = vma->vm_mm;
  	unsigned long nr_pages = (end - start) / PAGE_SIZE;
  	int gup_flags;
  
  	VM_BUG_ON(start & ~PAGE_MASK);
  	VM_BUG_ON(end   & ~PAGE_MASK);
  	VM_BUG_ON_VMA(start < vma->vm_start, vma);
  	VM_BUG_ON_VMA(end   > vma->vm_end, vma);
  	VM_BUG_ON_MM(!rwsem_is_locked(&mm->mmap_sem), mm);
  
  	gup_flags = FOLL_TOUCH | FOLL_POPULATE | FOLL_MLOCK;
  	if (vma->vm_flags & VM_LOCKONFAULT)
  		gup_flags &= ~FOLL_POPULATE;
  	/*
  	 * We want to touch writable mappings with a write fault in order
  	 * to break COW, except for shared mappings because these don't COW
  	 * and we would not want to dirty them for nothing.
  	 */
  	if ((vma->vm_flags & (VM_WRITE | VM_SHARED)) == VM_WRITE)
  		gup_flags |= FOLL_WRITE;
  
  	/*
  	 * We want mlock to succeed for regions that have any permissions
  	 * other than PROT_NONE.
  	 */
  	if (vma->vm_flags & (VM_READ | VM_WRITE | VM_EXEC))
  		gup_flags |= FOLL_FORCE;
  
  	/*
  	 * We made sure addr is within a VMA, so the following will
  	 * not result in a stack expansion that recurses back here.
  	 */
  	return __get_user_pages(current, mm, start, nr_pages, gup_flags,
  				NULL, NULL, nonblocking);
  }
  
  /*
   * __mm_populate - populate and/or mlock pages within a range of address space.
   *
   * This is used to implement mlock() and the MAP_POPULATE / MAP_LOCKED mmap
   * flags. VMAs must be already marked with the desired vm_flags, and
   * mmap_sem must not be held.
   */
  int __mm_populate(unsigned long start, unsigned long len, int ignore_errors)
  {
  	struct mm_struct *mm = current->mm;
  	unsigned long end, nstart, nend;
  	struct vm_area_struct *vma = NULL;
  	int locked = 0;
  	long ret = 0;
  
  	end = start + len;
  
  	for (nstart = start; nstart < end; nstart = nend) {
  		/*
  		 * We want to fault in pages for [nstart; end) address range.
  		 * Find first corresponding VMA.
  		 */
  		if (!locked) {
  			locked = 1;
  			down_read(&mm->mmap_sem);
  			vma = find_vma(mm, nstart);
  		} else if (nstart >= vma->vm_end)
  			vma = vma->vm_next;
  		if (!vma || vma->vm_start >= end)
  			break;
  		/*
  		 * Set [nstart; nend) to intersection of desired address
  		 * range with the first VMA. Also, skip undesirable VMA types.
  		 */
  		nend = min(end, vma->vm_end);
  		if (vma->vm_flags & (VM_IO | VM_PFNMAP))
  			continue;
  		if (nstart < vma->vm_start)
  			nstart = vma->vm_start;
  		/*
  		 * Now fault in a range of pages. populate_vma_page_range()
  		 * double checks the vma flags, so that it won't mlock pages
  		 * if the vma was already munlocked.
  		 */
  		ret = populate_vma_page_range(vma, nstart, nend, &locked);
  		if (ret < 0) {
  			if (ignore_errors) {
  				ret = 0;
  				continue;	/* continue at next VMA */
  			}
  			break;
  		}
  		nend = nstart + ret * PAGE_SIZE;
  		ret = 0;
  	}
  	if (locked)
  		up_read(&mm->mmap_sem);
  	return ret;	/* 0 or negative error code */
  }
  
  /**
   * get_dump_page() - pin user page in memory while writing it to core dump
   * @addr: user address
   *
   * Returns struct page pointer of user page pinned for dump,
   * to be freed afterwards by put_page().
   *
   * Returns NULL on any kind of failure - a hole must then be inserted into
   * the corefile, to preserve alignment with its headers; and also returns
   * NULL wherever the ZERO_PAGE, or an anonymous pte_none, has been found -
   * allowing a hole to be left in the corefile to save diskspace.
   *
   * Called without mmap_sem, but after all other threads have been killed.
   */
  #ifdef CONFIG_ELF_CORE
  struct page *get_dump_page(unsigned long addr)
  {
  	struct vm_area_struct *vma;
  	struct page *page;
  
  	if (__get_user_pages(current, current->mm, addr, 1,
  			     FOLL_FORCE | FOLL_DUMP | FOLL_GET, &page, &vma,
  			     NULL) < 1)
  		return NULL;
  	flush_cache_page(vma, addr, page_to_pfn(page));
  	return page;
  }
  #endif /* CONFIG_ELF_CORE */
050a9adc6   Christoph Hellwig   mm: consolidate t...
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
  #else /* CONFIG_MMU */
  static long __get_user_pages_locked(struct task_struct *tsk,
  		struct mm_struct *mm, unsigned long start,
  		unsigned long nr_pages, struct page **pages,
  		struct vm_area_struct **vmas, int *locked,
  		unsigned int foll_flags)
  {
  	struct vm_area_struct *vma;
  	unsigned long vm_flags;
  	int i;
  
  	/* calculate required read or write permissions.
  	 * If FOLL_FORCE is set, we only require the "MAY" flags.
  	 */
  	vm_flags  = (foll_flags & FOLL_WRITE) ?
  			(VM_WRITE | VM_MAYWRITE) : (VM_READ | VM_MAYREAD);
  	vm_flags &= (foll_flags & FOLL_FORCE) ?
  			(VM_MAYREAD | VM_MAYWRITE) : (VM_READ | VM_WRITE);
  
  	for (i = 0; i < nr_pages; i++) {
  		vma = find_vma(mm, start);
  		if (!vma)
  			goto finish_or_fault;
  
  		/* protect what we can, including chardevs */
  		if ((vma->vm_flags & (VM_IO | VM_PFNMAP)) ||
  		    !(vm_flags & vma->vm_flags))
  			goto finish_or_fault;
  
  		if (pages) {
  			pages[i] = virt_to_page(start);
  			if (pages[i])
  				get_page(pages[i]);
  		}
  		if (vmas)
  			vmas[i] = vma;
  		start = (start + PAGE_SIZE) & PAGE_MASK;
  	}
  
  	return i;
  
  finish_or_fault:
  	return i ? : -EFAULT;
  }
  #endif /* !CONFIG_MMU */
d3649f68b   Christoph Hellwig   mm: reorder code ...
1336

9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1337
  #if defined(CONFIG_FS_DAX) || defined (CONFIG_CMA)
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
  static bool check_dax_vmas(struct vm_area_struct **vmas, long nr_pages)
  {
  	long i;
  	struct vm_area_struct *vma_prev = NULL;
  
  	for (i = 0; i < nr_pages; i++) {
  		struct vm_area_struct *vma = vmas[i];
  
  		if (vma == vma_prev)
  			continue;
  
  		vma_prev = vma;
  
  		if (vma_is_fsdax(vma))
  			return true;
  	}
  	return false;
  }
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
  
  #ifdef CONFIG_CMA
  static struct page *new_non_cma_page(struct page *page, unsigned long private)
  {
  	/*
  	 * We want to make sure we allocate the new page from the same node
  	 * as the source page.
  	 */
  	int nid = page_to_nid(page);
  	/*
  	 * Trying to allocate a page for migration. Ignore allocation
  	 * failure warnings. We don't force __GFP_THISNODE here because
  	 * this node here is the node where we have CMA reservation and
  	 * in some case these nodes will have really less non movable
  	 * allocation memory.
  	 */
  	gfp_t gfp_mask = GFP_USER | __GFP_NOWARN;
  
  	if (PageHighMem(page))
  		gfp_mask |= __GFP_HIGHMEM;
  
  #ifdef CONFIG_HUGETLB_PAGE
  	if (PageHuge(page)) {
  		struct hstate *h = page_hstate(page);
  		/*
  		 * We don't want to dequeue from the pool because pool pages will
  		 * mostly be from the CMA region.
  		 */
  		return alloc_migrate_huge_page(h, gfp_mask, nid, NULL);
  	}
  #endif
  	if (PageTransHuge(page)) {
  		struct page *thp;
  		/*
  		 * ignore allocation failure warnings
  		 */
  		gfp_t thp_gfpmask = GFP_TRANSHUGE | __GFP_NOWARN;
  
  		/*
  		 * Remove the movable mask so that we don't allocate from
  		 * CMA area again.
  		 */
  		thp_gfpmask &= ~__GFP_MOVABLE;
  		thp = __alloc_pages_node(nid, thp_gfpmask, HPAGE_PMD_ORDER);
  		if (!thp)
  			return NULL;
  		prep_transhuge_page(thp);
  		return thp;
  	}
  
  	return __alloc_pages_node(nid, gfp_mask, 0);
  }
932f4a630   Ira Weiny   mm/gup: replace g...
1408
1409
1410
1411
  static long check_and_migrate_cma_pages(struct task_struct *tsk,
  					struct mm_struct *mm,
  					unsigned long start,
  					unsigned long nr_pages,
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1412
  					struct page **pages,
932f4a630   Ira Weiny   mm/gup: replace g...
1413
1414
  					struct vm_area_struct **vmas,
  					unsigned int gup_flags)
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1415
  {
aa712399c   Pingfan Liu   mm/gup: speed up ...
1416
1417
  	unsigned long i;
  	unsigned long step;
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1418
1419
1420
1421
1422
  	bool drain_allow = true;
  	bool migrate_allow = true;
  	LIST_HEAD(cma_page_list);
  
  check_again:
aa712399c   Pingfan Liu   mm/gup: speed up ...
1423
1424
1425
1426
1427
1428
1429
1430
  	for (i = 0; i < nr_pages;) {
  
  		struct page *head = compound_head(pages[i]);
  
  		/*
  		 * gup may start from a tail page. Advance step by the left
  		 * part.
  		 */
d8c6546b1   Matthew Wilcox (Oracle)   mm: introduce com...
1431
  		step = compound_nr(head) - (pages[i] - head);
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1432
1433
1434
1435
1436
  		/*
  		 * If we get a page from the CMA zone, since we are going to
  		 * be pinning these entries, we might as well move them out
  		 * of the CMA zone if possible.
  		 */
aa712399c   Pingfan Liu   mm/gup: speed up ...
1437
1438
  		if (is_migrate_cma_page(head)) {
  			if (PageHuge(head))
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1439
  				isolate_huge_page(head, &cma_page_list);
aa712399c   Pingfan Liu   mm/gup: speed up ...
1440
  			else {
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
  				if (!PageLRU(head) && drain_allow) {
  					lru_add_drain_all();
  					drain_allow = false;
  				}
  
  				if (!isolate_lru_page(head)) {
  					list_add_tail(&head->lru, &cma_page_list);
  					mod_node_page_state(page_pgdat(head),
  							    NR_ISOLATED_ANON +
  							    page_is_file_cache(head),
  							    hpage_nr_pages(head));
  				}
  			}
  		}
aa712399c   Pingfan Liu   mm/gup: speed up ...
1455
1456
  
  		i += step;
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
  	}
  
  	if (!list_empty(&cma_page_list)) {
  		/*
  		 * drop the above get_user_pages reference.
  		 */
  		for (i = 0; i < nr_pages; i++)
  			put_page(pages[i]);
  
  		if (migrate_pages(&cma_page_list, new_non_cma_page,
  				  NULL, 0, MIGRATE_SYNC, MR_CONTIG_RANGE)) {
  			/*
  			 * some of the pages failed migration. Do get_user_pages
  			 * without migration.
  			 */
  			migrate_allow = false;
  
  			if (!list_empty(&cma_page_list))
  				putback_movable_pages(&cma_page_list);
  		}
  		/*
932f4a630   Ira Weiny   mm/gup: replace g...
1478
1479
1480
  		 * We did migrate all the pages, Try to get the page references
  		 * again migrating any new CMA pages which we failed to isolate
  		 * earlier.
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1481
  		 */
932f4a630   Ira Weiny   mm/gup: replace g...
1482
1483
1484
  		nr_pages = __get_user_pages_locked(tsk, mm, start, nr_pages,
  						   pages, vmas, NULL,
  						   gup_flags);
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1485
1486
1487
1488
1489
1490
1491
1492
1493
  		if ((nr_pages > 0) && migrate_allow) {
  			drain_allow = true;
  			goto check_again;
  		}
  	}
  
  	return nr_pages;
  }
  #else
932f4a630   Ira Weiny   mm/gup: replace g...
1494
1495
1496
1497
1498
1499
1500
  static long check_and_migrate_cma_pages(struct task_struct *tsk,
  					struct mm_struct *mm,
  					unsigned long start,
  					unsigned long nr_pages,
  					struct page **pages,
  					struct vm_area_struct **vmas,
  					unsigned int gup_flags)
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1501
1502
1503
  {
  	return nr_pages;
  }
050a9adc6   Christoph Hellwig   mm: consolidate t...
1504
  #endif /* CONFIG_CMA */
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1505

2bb6d2837   Dan Williams   mm: introduce get...
1506
  /*
932f4a630   Ira Weiny   mm/gup: replace g...
1507
1508
   * __gup_longterm_locked() is a wrapper for __get_user_pages_locked which
   * allows us to process the FOLL_LONGTERM flag.
2bb6d2837   Dan Williams   mm: introduce get...
1509
   */
932f4a630   Ira Weiny   mm/gup: replace g...
1510
1511
1512
1513
1514
1515
1516
  static long __gup_longterm_locked(struct task_struct *tsk,
  				  struct mm_struct *mm,
  				  unsigned long start,
  				  unsigned long nr_pages,
  				  struct page **pages,
  				  struct vm_area_struct **vmas,
  				  unsigned int gup_flags)
2bb6d2837   Dan Williams   mm: introduce get...
1517
  {
932f4a630   Ira Weiny   mm/gup: replace g...
1518
1519
  	struct vm_area_struct **vmas_tmp = vmas;
  	unsigned long flags = 0;
2bb6d2837   Dan Williams   mm: introduce get...
1520
  	long rc, i;
932f4a630   Ira Weiny   mm/gup: replace g...
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
  	if (gup_flags & FOLL_LONGTERM) {
  		if (!pages)
  			return -EINVAL;
  
  		if (!vmas_tmp) {
  			vmas_tmp = kcalloc(nr_pages,
  					   sizeof(struct vm_area_struct *),
  					   GFP_KERNEL);
  			if (!vmas_tmp)
  				return -ENOMEM;
  		}
  		flags = memalloc_nocma_save();
2bb6d2837   Dan Williams   mm: introduce get...
1533
  	}
932f4a630   Ira Weiny   mm/gup: replace g...
1534
1535
  	rc = __get_user_pages_locked(tsk, mm, start, nr_pages, pages,
  				     vmas_tmp, NULL, gup_flags);
2bb6d2837   Dan Williams   mm: introduce get...
1536

932f4a630   Ira Weiny   mm/gup: replace g...
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
  	if (gup_flags & FOLL_LONGTERM) {
  		memalloc_nocma_restore(flags);
  		if (rc < 0)
  			goto out;
  
  		if (check_dax_vmas(vmas_tmp, rc)) {
  			for (i = 0; i < rc; i++)
  				put_page(pages[i]);
  			rc = -EOPNOTSUPP;
  			goto out;
  		}
  
  		rc = check_and_migrate_cma_pages(tsk, mm, start, rc, pages,
  						 vmas_tmp, gup_flags);
9a4e9f3b2   Aneesh Kumar K.V   mm: update get_us...
1551
  	}
2bb6d2837   Dan Williams   mm: introduce get...
1552

2bb6d2837   Dan Williams   mm: introduce get...
1553
  out:
932f4a630   Ira Weiny   mm/gup: replace g...
1554
1555
  	if (vmas_tmp != vmas)
  		kfree(vmas_tmp);
2bb6d2837   Dan Williams   mm: introduce get...
1556
1557
  	return rc;
  }
932f4a630   Ira Weiny   mm/gup: replace g...
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
  #else /* !CONFIG_FS_DAX && !CONFIG_CMA */
  static __always_inline long __gup_longterm_locked(struct task_struct *tsk,
  						  struct mm_struct *mm,
  						  unsigned long start,
  						  unsigned long nr_pages,
  						  struct page **pages,
  						  struct vm_area_struct **vmas,
  						  unsigned int flags)
  {
  	return __get_user_pages_locked(tsk, mm, start, nr_pages, pages, vmas,
  				       NULL, flags);
  }
  #endif /* CONFIG_FS_DAX || CONFIG_CMA */
  
  /*
   * This is the same as get_user_pages_remote(), just with a
   * less-flexible calling convention where we assume that the task
   * and mm being operated on are the current task's and don't allow
   * passing of a locked parameter.  We also obviously don't pass
   * FOLL_REMOTE in here.
   */
  long get_user_pages(unsigned long start, unsigned long nr_pages,
  		unsigned int gup_flags, struct page **pages,
  		struct vm_area_struct **vmas)
  {
  	return __gup_longterm_locked(current, current->mm, start, nr_pages,
  				     pages, vmas, gup_flags | FOLL_TOUCH);
  }
  EXPORT_SYMBOL(get_user_pages);
2bb6d2837   Dan Williams   mm: introduce get...
1587

d3649f68b   Christoph Hellwig   mm: reorder code ...
1588
1589
1590
1591
  /*
   * We can leverage the VM_FAULT_RETRY functionality in the page fault
   * paths better by using either get_user_pages_locked() or
   * get_user_pages_unlocked().
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1592
   *
d3649f68b   Christoph Hellwig   mm: reorder code ...
1593
   * get_user_pages_locked() is suitable to replace the form:
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1594
   *
d3649f68b   Christoph Hellwig   mm: reorder code ...
1595
1596
1597
1598
   *      down_read(&mm->mmap_sem);
   *      do_something()
   *      get_user_pages(tsk, mm, ..., pages, NULL);
   *      up_read(&mm->mmap_sem);
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1599
   *
d3649f68b   Christoph Hellwig   mm: reorder code ...
1600
   *  to:
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1601
   *
d3649f68b   Christoph Hellwig   mm: reorder code ...
1602
1603
1604
1605
1606
1607
   *      int locked = 1;
   *      down_read(&mm->mmap_sem);
   *      do_something()
   *      get_user_pages_locked(tsk, mm, ..., pages, &locked);
   *      if (locked)
   *          up_read(&mm->mmap_sem);
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1608
   */
d3649f68b   Christoph Hellwig   mm: reorder code ...
1609
1610
1611
  long get_user_pages_locked(unsigned long start, unsigned long nr_pages,
  			   unsigned int gup_flags, struct page **pages,
  			   int *locked)
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1612
  {
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1613
  	/*
d3649f68b   Christoph Hellwig   mm: reorder code ...
1614
1615
1616
1617
  	 * FIXME: Current FOLL_LONGTERM behavior is incompatible with
  	 * FAULT_FLAG_ALLOW_RETRY because of the FS DAX check requirement on
  	 * vmas.  As there are no users of this flag in this call we simply
  	 * disallow this option for now.
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1618
  	 */
d3649f68b   Christoph Hellwig   mm: reorder code ...
1619
1620
  	if (WARN_ON_ONCE(gup_flags & FOLL_LONGTERM))
  		return -EINVAL;
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1621

d3649f68b   Christoph Hellwig   mm: reorder code ...
1622
1623
1624
  	return __get_user_pages_locked(current, current->mm, start, nr_pages,
  				       pages, NULL, locked,
  				       gup_flags | FOLL_TOUCH);
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1625
  }
d3649f68b   Christoph Hellwig   mm: reorder code ...
1626
  EXPORT_SYMBOL(get_user_pages_locked);
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1627
1628
  
  /*
d3649f68b   Christoph Hellwig   mm: reorder code ...
1629
   * get_user_pages_unlocked() is suitable to replace the form:
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1630
   *
d3649f68b   Christoph Hellwig   mm: reorder code ...
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
   *      down_read(&mm->mmap_sem);
   *      get_user_pages(tsk, mm, ..., pages, NULL);
   *      up_read(&mm->mmap_sem);
   *
   *  with:
   *
   *      get_user_pages_unlocked(tsk, mm, ..., pages);
   *
   * It is functionally equivalent to get_user_pages_fast so
   * get_user_pages_fast should be used instead if specific gup_flags
   * (e.g. FOLL_FORCE) are not required.
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1642
   */
d3649f68b   Christoph Hellwig   mm: reorder code ...
1643
1644
  long get_user_pages_unlocked(unsigned long start, unsigned long nr_pages,
  			     struct page **pages, unsigned int gup_flags)
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1645
1646
  {
  	struct mm_struct *mm = current->mm;
d3649f68b   Christoph Hellwig   mm: reorder code ...
1647
1648
  	int locked = 1;
  	long ret;
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1649

d3649f68b   Christoph Hellwig   mm: reorder code ...
1650
1651
1652
1653
1654
1655
1656
1657
  	/*
  	 * FIXME: Current FOLL_LONGTERM behavior is incompatible with
  	 * FAULT_FLAG_ALLOW_RETRY because of the FS DAX check requirement on
  	 * vmas.  As there are no users of this flag in this call we simply
  	 * disallow this option for now.
  	 */
  	if (WARN_ON_ONCE(gup_flags & FOLL_LONGTERM))
  		return -EINVAL;
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1658

d3649f68b   Christoph Hellwig   mm: reorder code ...
1659
1660
1661
  	down_read(&mm->mmap_sem);
  	ret = __get_user_pages_locked(current, mm, start, nr_pages, pages, NULL,
  				      &locked, gup_flags | FOLL_TOUCH);
acc3c8d15   Kirill A. Shutemov   mm: move mm_popul...
1662
1663
  	if (locked)
  		up_read(&mm->mmap_sem);
d3649f68b   Christoph Hellwig   mm: reorder code ...
1664
  	return ret;
4bbd4c776   Kirill A. Shutemov   mm: move get_user...
1665
  }
d3649f68b   Christoph Hellwig   mm: reorder code ...
1666
  EXPORT_SYMBOL(get_user_pages_unlocked);
2667f50e8   Steve Capper   mm: introduce a g...
1667
1668
  
  /*
67a929e09   Christoph Hellwig   mm: rename CONFIG...
1669
   * Fast GUP
2667f50e8   Steve Capper   mm: introduce a g...
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
   *
   * get_user_pages_fast attempts to pin user pages by walking the page
   * tables directly and avoids taking locks. Thus the walker needs to be
   * protected from page table pages being freed from under it, and should
   * block any THP splits.
   *
   * One way to achieve this is to have the walker disable interrupts, and
   * rely on IPIs from the TLB flushing code blocking before the page table
   * pages are freed. This is unsuitable for architectures that do not need
   * to broadcast an IPI when invalidating TLBs.
   *
   * Another way to achieve this is to batch up page table containing pages
   * belonging to more than one mm_user, then rcu_sched a callback to free those
   * pages. Disabling interrupts will allow the fast_gup walker to both block
   * the rcu_sched callback, and an IPI that we broadcast for splitting THPs
   * (which is a relatively rare event). The code below adopts this strategy.
   *
   * Before activating this code, please be aware that the following assumptions
   * are currently made:
   *
e585513b7   Kirill A. Shutemov   x86/mm/gup: Switc...
1690
1691
   *  *) Either HAVE_RCU_TABLE_FREE is enabled, and tlb_remove_table() is used to
   *  free pages containing page tables or TLB flushing requires IPI broadcast.
2667f50e8   Steve Capper   mm: introduce a g...
1692
   *
2667f50e8   Steve Capper   mm: introduce a g...
1693
1694
1695
1696
1697
1698
1699
1700
   *  *) ptes can be read atomically by the architecture.
   *
   *  *) access_ok is sufficient to validate userspace address ranges.
   *
   * The last two assumptions can be relaxed by the addition of helper functions.
   *
   * This code is based heavily on the PowerPC implementation by Nick Piggin.
   */
67a929e09   Christoph Hellwig   mm: rename CONFIG...
1701
  #ifdef CONFIG_HAVE_FAST_GUP
39656e83d   Christoph Hellwig   mm: lift the x86_...
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
  #ifdef CONFIG_GUP_GET_PTE_LOW_HIGH
  /*
   * WARNING: only to be used in the get_user_pages_fast() implementation.
   *
   * With get_user_pages_fast(), we walk down the pagetables without taking any
   * locks.  For this we would like to load the pointers atomically, but sometimes
   * that is not possible (e.g. without expensive cmpxchg8b on x86_32 PAE).  What
   * we do have is the guarantee that a PTE will only either go from not present
   * to present, or present to not present or both -- it will not switch to a
   * completely different present page without a TLB flush in between; something
   * that we are blocking by holding interrupts off.
   *
   * Setting ptes from not present to present goes:
   *
   *   ptep->pte_high = h;
   *   smp_wmb();
   *   ptep->pte_low = l;
   *
   * And present to not present goes:
   *
   *   ptep->pte_low = 0;
   *   smp_wmb();
   *   ptep->pte_high = 0;
   *
   * We must ensure here that the load of pte_low sees 'l' IFF pte_high sees 'h'.
   * We load pte_high *after* loading pte_low, which ensures we don't see an older
   * value of pte_high.  *Then* we recheck pte_low, which ensures that we haven't
   * picked up a changed pte high. We might have gotten rubbish values from
   * pte_low and pte_high, but we are guaranteed that pte_low will not have the
   * present bit set *unless* it is 'l'. Because get_user_pages_fast() only
   * operates on present ptes we're safe.
   */
  static inline pte_t gup_get_pte(pte_t *ptep)
  {
  	pte_t pte;
2667f50e8   Steve Capper   mm: introduce a g...
1737

39656e83d   Christoph Hellwig   mm: lift the x86_...
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
  	do {
  		pte.pte_low = ptep->pte_low;
  		smp_rmb();
  		pte.pte_high = ptep->pte_high;
  		smp_rmb();
  	} while (unlikely(pte.pte_low != ptep->pte_low));
  
  	return pte;
  }
  #else /* CONFIG_GUP_GET_PTE_LOW_HIGH */
0005d20b2   Kirill A. Shutemov   mm/gup: Move page...
1748
  /*
39656e83d   Christoph Hellwig   mm: lift the x86_...
1749
   * We require that the PTE can be read atomically.
0005d20b2   Kirill A. Shutemov   mm/gup: Move page...
1750
1751
1752
1753
1754
   */
  static inline pte_t gup_get_pte(pte_t *ptep)
  {
  	return READ_ONCE(*ptep);
  }
39656e83d   Christoph Hellwig   mm: lift the x86_...
1755
  #endif /* CONFIG_GUP_GET_PTE_LOW_HIGH */
0005d20b2   Kirill A. Shutemov   mm/gup: Move page...
1756

790c73690   Guenter Roeck   mm/gup.c: mark un...
1757
1758
  static void __maybe_unused undo_dev_pagemap(int *nr, int nr_start,
  					    struct page **pages)
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1759
1760
1761
1762
1763
1764
1765
1766
  {
  	while ((*nr) - nr_start) {
  		struct page *page = pages[--(*nr)];
  
  		ClearPageReferenced(page);
  		put_page(page);
  	}
  }
8fde12ca7   Linus Torvalds   mm: prevent get_u...
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
  /*
   * Return the compund head page with ref appropriately incremented,
   * or NULL if that failed.
   */
  static inline struct page *try_get_compound_head(struct page *page, int refs)
  {
  	struct page *head = compound_head(page);
  	if (WARN_ON_ONCE(page_ref_count(head) < 0))
  		return NULL;
  	if (unlikely(!page_cache_add_speculative(head, refs)))
  		return NULL;
  	return head;
  }
3010a5ea6   Laurent Dufour   mm: introduce ARC...
1780
  #ifdef CONFIG_ARCH_HAS_PTE_SPECIAL
2667f50e8   Steve Capper   mm: introduce a g...
1781
  static int gup_pte_range(pmd_t pmd, unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
1782
  			 unsigned int flags, struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
1783
  {
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1784
1785
  	struct dev_pagemap *pgmap = NULL;
  	int nr_start = *nr, ret = 0;
2667f50e8   Steve Capper   mm: introduce a g...
1786
  	pte_t *ptep, *ptem;
2667f50e8   Steve Capper   mm: introduce a g...
1787
1788
1789
  
  	ptem = ptep = pte_offset_map(&pmd, addr);
  	do {
0005d20b2   Kirill A. Shutemov   mm/gup: Move page...
1790
  		pte_t pte = gup_get_pte(ptep);
7aef4172c   Kirill A. Shutemov   mm: handle PTE-ma...
1791
  		struct page *head, *page;
2667f50e8   Steve Capper   mm: introduce a g...
1792
1793
1794
  
  		/*
  		 * Similar to the PMD case below, NUMA hinting must take slow
8a0516ed8   Mel Gorman   mm: convert p[te|...
1795
  		 * path using the pte_protnone check.
2667f50e8   Steve Capper   mm: introduce a g...
1796
  		 */
e7884f8ea   Kirill A. Shutemov   mm/gup: Move perm...
1797
1798
  		if (pte_protnone(pte))
  			goto pte_unmap;
b798bec47   Ira Weiny   mm/gup: change wr...
1799
  		if (!pte_access_permitted(pte, flags & FOLL_WRITE))
e7884f8ea   Kirill A. Shutemov   mm/gup: Move perm...
1800
  			goto pte_unmap;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1801
  		if (pte_devmap(pte)) {
7af75561e   Ira Weiny   mm/gup: add FOLL_...
1802
1803
  			if (unlikely(flags & FOLL_LONGTERM))
  				goto pte_unmap;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1804
1805
1806
1807
1808
1809
  			pgmap = get_dev_pagemap(pte_pfn(pte), pgmap);
  			if (unlikely(!pgmap)) {
  				undo_dev_pagemap(nr, nr_start, pages);
  				goto pte_unmap;
  			}
  		} else if (pte_special(pte))
2667f50e8   Steve Capper   mm: introduce a g...
1810
1811
1812
1813
  			goto pte_unmap;
  
  		VM_BUG_ON(!pfn_valid(pte_pfn(pte)));
  		page = pte_page(pte);
8fde12ca7   Linus Torvalds   mm: prevent get_u...
1814
1815
  		head = try_get_compound_head(page, 1);
  		if (!head)
2667f50e8   Steve Capper   mm: introduce a g...
1816
1817
1818
  			goto pte_unmap;
  
  		if (unlikely(pte_val(pte) != pte_val(*ptep))) {
7aef4172c   Kirill A. Shutemov   mm: handle PTE-ma...
1819
  			put_page(head);
2667f50e8   Steve Capper   mm: introduce a g...
1820
1821
  			goto pte_unmap;
  		}
7aef4172c   Kirill A. Shutemov   mm: handle PTE-ma...
1822
  		VM_BUG_ON_PAGE(compound_head(page) != head, page);
e93480537   Kirill A. Shutemov   mm/gup: Mark all ...
1823
1824
  
  		SetPageReferenced(page);
2667f50e8   Steve Capper   mm: introduce a g...
1825
1826
1827
1828
1829
1830
1831
1832
  		pages[*nr] = page;
  		(*nr)++;
  
  	} while (ptep++, addr += PAGE_SIZE, addr != end);
  
  	ret = 1;
  
  pte_unmap:
832d7aa05   Christoph Hellwig   mm: optimize dev_...
1833
1834
  	if (pgmap)
  		put_dev_pagemap(pgmap);
2667f50e8   Steve Capper   mm: introduce a g...
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
  	pte_unmap(ptem);
  	return ret;
  }
  #else
  
  /*
   * If we can't determine whether or not a pte is special, then fail immediately
   * for ptes. Note, we can still pin HugeTLB and THP as these are guaranteed not
   * to be special.
   *
   * For a futex to be placed on a THP tail page, get_futex_key requires a
   * __get_user_pages_fast implementation that can pin pages. Thus it's still
   * useful to have gup_huge_pmd even if we can't operate on ptes.
   */
  static int gup_pte_range(pmd_t pmd, unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
1850
  			 unsigned int flags, struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
1851
1852
1853
  {
  	return 0;
  }
3010a5ea6   Laurent Dufour   mm: introduce ARC...
1854
  #endif /* CONFIG_ARCH_HAS_PTE_SPECIAL */
2667f50e8   Steve Capper   mm: introduce a g...
1855

175967318   Robin Murphy   mm: introduce ARC...
1856
  #if defined(CONFIG_ARCH_HAS_PTE_DEVMAP) && defined(CONFIG_TRANSPARENT_HUGEPAGE)
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
  static int __gup_device_huge(unsigned long pfn, unsigned long addr,
  		unsigned long end, struct page **pages, int *nr)
  {
  	int nr_start = *nr;
  	struct dev_pagemap *pgmap = NULL;
  
  	do {
  		struct page *page = pfn_to_page(pfn);
  
  		pgmap = get_dev_pagemap(pfn, pgmap);
  		if (unlikely(!pgmap)) {
  			undo_dev_pagemap(nr, nr_start, pages);
  			return 0;
  		}
  		SetPageReferenced(page);
  		pages[*nr] = page;
  		get_page(page);
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1874
1875
1876
  		(*nr)++;
  		pfn++;
  	} while (addr += PAGE_SIZE, addr != end);
832d7aa05   Christoph Hellwig   mm: optimize dev_...
1877
1878
1879
  
  	if (pgmap)
  		put_dev_pagemap(pgmap);
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1880
1881
  	return 1;
  }
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1882
  static int __gup_device_huge_pmd(pmd_t orig, pmd_t *pmdp, unsigned long addr,
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1883
1884
1885
  		unsigned long end, struct page **pages, int *nr)
  {
  	unsigned long fault_pfn;
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1886
1887
1888
1889
1890
  	int nr_start = *nr;
  
  	fault_pfn = pmd_pfn(orig) + ((addr & ~PMD_MASK) >> PAGE_SHIFT);
  	if (!__gup_device_huge(fault_pfn, addr, end, pages, nr))
  		return 0;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1891

a9b6de77b   Dan Williams   mm: fix __gup_dev...
1892
1893
1894
1895
1896
  	if (unlikely(pmd_val(orig) != pmd_val(*pmdp))) {
  		undo_dev_pagemap(nr, nr_start, pages);
  		return 0;
  	}
  	return 1;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1897
  }
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1898
  static int __gup_device_huge_pud(pud_t orig, pud_t *pudp, unsigned long addr,
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1899
1900
1901
  		unsigned long end, struct page **pages, int *nr)
  {
  	unsigned long fault_pfn;
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1902
1903
1904
1905
1906
  	int nr_start = *nr;
  
  	fault_pfn = pud_pfn(orig) + ((addr & ~PUD_MASK) >> PAGE_SHIFT);
  	if (!__gup_device_huge(fault_pfn, addr, end, pages, nr))
  		return 0;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1907

a9b6de77b   Dan Williams   mm: fix __gup_dev...
1908
1909
1910
1911
1912
  	if (unlikely(pud_val(orig) != pud_val(*pudp))) {
  		undo_dev_pagemap(nr, nr_start, pages);
  		return 0;
  	}
  	return 1;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1913
1914
  }
  #else
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1915
  static int __gup_device_huge_pmd(pmd_t orig, pmd_t *pmdp, unsigned long addr,
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1916
1917
1918
1919
1920
  		unsigned long end, struct page **pages, int *nr)
  {
  	BUILD_BUG();
  	return 0;
  }
a9b6de77b   Dan Williams   mm: fix __gup_dev...
1921
  static int __gup_device_huge_pud(pud_t pud, pud_t *pudp, unsigned long addr,
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
1922
1923
1924
1925
1926
1927
  		unsigned long end, struct page **pages, int *nr)
  {
  	BUILD_BUG();
  	return 0;
  }
  #endif
cbd34da7d   Christoph Hellwig   mm: move the powe...
1928
1929
1930
1931
1932
1933
1934
1935
1936
  #ifdef CONFIG_ARCH_HAS_HUGEPD
  static unsigned long hugepte_addr_end(unsigned long addr, unsigned long end,
  				      unsigned long sz)
  {
  	unsigned long __boundary = (addr + sz) & ~(sz-1);
  	return (__boundary - 1 < end - 1) ? __boundary : end;
  }
  
  static int gup_hugepte(pte_t *ptep, unsigned long sz, unsigned long addr,
0cd22afdc   John Hubbard   mm/gup: fix a mis...
1937
1938
  		       unsigned long end, unsigned int flags,
  		       struct page **pages, int *nr)
cbd34da7d   Christoph Hellwig   mm: move the powe...
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
  {
  	unsigned long pte_end;
  	struct page *head, *page;
  	pte_t pte;
  	int refs;
  
  	pte_end = (addr + sz) & ~(sz-1);
  	if (pte_end < end)
  		end = pte_end;
  
  	pte = READ_ONCE(*ptep);
0cd22afdc   John Hubbard   mm/gup: fix a mis...
1950
  	if (!pte_access_permitted(pte, flags & FOLL_WRITE))
cbd34da7d   Christoph Hellwig   mm: move the powe...
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
  		return 0;
  
  	/* hugepages are never "special" */
  	VM_BUG_ON(!pfn_valid(pte_pfn(pte)));
  
  	refs = 0;
  	head = pte_page(pte);
  
  	page = head + ((addr & (sz-1)) >> PAGE_SHIFT);
  	do {
  		VM_BUG_ON(compound_head(page) != head);
  		pages[*nr] = page;
  		(*nr)++;
  		page++;
  		refs++;
  	} while (addr += PAGE_SIZE, addr != end);
01a369160   Christoph Hellwig   mm: switch gup_hu...
1967
1968
  	head = try_get_compound_head(head, refs);
  	if (!head) {
cbd34da7d   Christoph Hellwig   mm: move the powe...
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
  		*nr -= refs;
  		return 0;
  	}
  
  	if (unlikely(pte_val(pte) != pte_val(*ptep))) {
  		/* Could be optimized better */
  		*nr -= refs;
  		while (refs--)
  			put_page(head);
  		return 0;
  	}
520b4a449   Christoph Hellwig   mm: mark the page...
1980
  	SetPageReferenced(head);
cbd34da7d   Christoph Hellwig   mm: move the powe...
1981
1982
1983
1984
  	return 1;
  }
  
  static int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
0cd22afdc   John Hubbard   mm/gup: fix a mis...
1985
  		unsigned int pdshift, unsigned long end, unsigned int flags,
cbd34da7d   Christoph Hellwig   mm: move the powe...
1986
1987
1988
1989
1990
1991
1992
1993
1994
  		struct page **pages, int *nr)
  {
  	pte_t *ptep;
  	unsigned long sz = 1UL << hugepd_shift(hugepd);
  	unsigned long next;
  
  	ptep = hugepte_offset(hugepd, addr, pdshift);
  	do {
  		next = hugepte_addr_end(addr, end, sz);
0cd22afdc   John Hubbard   mm/gup: fix a mis...
1995
  		if (!gup_hugepte(ptep, sz, addr, end, flags, pages, nr))
cbd34da7d   Christoph Hellwig   mm: move the powe...
1996
1997
1998
1999
2000
2001
2002
  			return 0;
  	} while (ptep++, addr = next, addr != end);
  
  	return 1;
  }
  #else
  static inline int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
0cd22afdc   John Hubbard   mm/gup: fix a mis...
2003
  		unsigned int pdshift, unsigned long end, unsigned int flags,
cbd34da7d   Christoph Hellwig   mm: move the powe...
2004
2005
2006
2007
2008
  		struct page **pages, int *nr)
  {
  	return 0;
  }
  #endif /* CONFIG_ARCH_HAS_HUGEPD */
2667f50e8   Steve Capper   mm: introduce a g...
2009
  static int gup_huge_pmd(pmd_t orig, pmd_t *pmdp, unsigned long addr,
0cd22afdc   John Hubbard   mm/gup: fix a mis...
2010
2011
  			unsigned long end, unsigned int flags,
  			struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
2012
  {
ddc58f27f   Kirill A. Shutemov   mm: drop tail pag...
2013
  	struct page *head, *page;
2667f50e8   Steve Capper   mm: introduce a g...
2014
  	int refs;
b798bec47   Ira Weiny   mm/gup: change wr...
2015
  	if (!pmd_access_permitted(orig, flags & FOLL_WRITE))
2667f50e8   Steve Capper   mm: introduce a g...
2016
  		return 0;
7af75561e   Ira Weiny   mm/gup: add FOLL_...
2017
2018
2019
  	if (pmd_devmap(orig)) {
  		if (unlikely(flags & FOLL_LONGTERM))
  			return 0;
a9b6de77b   Dan Williams   mm: fix __gup_dev...
2020
  		return __gup_device_huge_pmd(orig, pmdp, addr, end, pages, nr);
7af75561e   Ira Weiny   mm/gup: add FOLL_...
2021
  	}
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
2022

2667f50e8   Steve Capper   mm: introduce a g...
2023
  	refs = 0;
d63206ee3   Punit Agrawal   mm, gup: ensure r...
2024
  	page = pmd_page(orig) + ((addr & ~PMD_MASK) >> PAGE_SHIFT);
2667f50e8   Steve Capper   mm: introduce a g...
2025
  	do {
2667f50e8   Steve Capper   mm: introduce a g...
2026
2027
2028
2029
2030
  		pages[*nr] = page;
  		(*nr)++;
  		page++;
  		refs++;
  	} while (addr += PAGE_SIZE, addr != end);
8fde12ca7   Linus Torvalds   mm: prevent get_u...
2031
2032
  	head = try_get_compound_head(pmd_page(orig), refs);
  	if (!head) {
2667f50e8   Steve Capper   mm: introduce a g...
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
  		*nr -= refs;
  		return 0;
  	}
  
  	if (unlikely(pmd_val(orig) != pmd_val(*pmdp))) {
  		*nr -= refs;
  		while (refs--)
  			put_page(head);
  		return 0;
  	}
e93480537   Kirill A. Shutemov   mm/gup: Mark all ...
2043
  	SetPageReferenced(head);
2667f50e8   Steve Capper   mm: introduce a g...
2044
2045
2046
2047
  	return 1;
  }
  
  static int gup_huge_pud(pud_t orig, pud_t *pudp, unsigned long addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2048
  		unsigned long end, unsigned int flags, struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
2049
  {
ddc58f27f   Kirill A. Shutemov   mm: drop tail pag...
2050
  	struct page *head, *page;
2667f50e8   Steve Capper   mm: introduce a g...
2051
  	int refs;
b798bec47   Ira Weiny   mm/gup: change wr...
2052
  	if (!pud_access_permitted(orig, flags & FOLL_WRITE))
2667f50e8   Steve Capper   mm: introduce a g...
2053
  		return 0;
7af75561e   Ira Weiny   mm/gup: add FOLL_...
2054
2055
2056
  	if (pud_devmap(orig)) {
  		if (unlikely(flags & FOLL_LONGTERM))
  			return 0;
a9b6de77b   Dan Williams   mm: fix __gup_dev...
2057
  		return __gup_device_huge_pud(orig, pudp, addr, end, pages, nr);
7af75561e   Ira Weiny   mm/gup: add FOLL_...
2058
  	}
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
2059

2667f50e8   Steve Capper   mm: introduce a g...
2060
  	refs = 0;
d63206ee3   Punit Agrawal   mm, gup: ensure r...
2061
  	page = pud_page(orig) + ((addr & ~PUD_MASK) >> PAGE_SHIFT);
2667f50e8   Steve Capper   mm: introduce a g...
2062
  	do {
2667f50e8   Steve Capper   mm: introduce a g...
2063
2064
2065
2066
2067
  		pages[*nr] = page;
  		(*nr)++;
  		page++;
  		refs++;
  	} while (addr += PAGE_SIZE, addr != end);
8fde12ca7   Linus Torvalds   mm: prevent get_u...
2068
2069
  	head = try_get_compound_head(pud_page(orig), refs);
  	if (!head) {
2667f50e8   Steve Capper   mm: introduce a g...
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
  		*nr -= refs;
  		return 0;
  	}
  
  	if (unlikely(pud_val(orig) != pud_val(*pudp))) {
  		*nr -= refs;
  		while (refs--)
  			put_page(head);
  		return 0;
  	}
e93480537   Kirill A. Shutemov   mm/gup: Mark all ...
2080
  	SetPageReferenced(head);
2667f50e8   Steve Capper   mm: introduce a g...
2081
2082
  	return 1;
  }
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2083
  static int gup_huge_pgd(pgd_t orig, pgd_t *pgdp, unsigned long addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2084
  			unsigned long end, unsigned int flags,
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2085
2086
2087
  			struct page **pages, int *nr)
  {
  	int refs;
ddc58f27f   Kirill A. Shutemov   mm: drop tail pag...
2088
  	struct page *head, *page;
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2089

b798bec47   Ira Weiny   mm/gup: change wr...
2090
  	if (!pgd_access_permitted(orig, flags & FOLL_WRITE))
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2091
  		return 0;
b59f65fa0   Kirill A. Shutemov   mm/gup: Implement...
2092
  	BUILD_BUG_ON(pgd_devmap(orig));
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2093
  	refs = 0;
d63206ee3   Punit Agrawal   mm, gup: ensure r...
2094
  	page = pgd_page(orig) + ((addr & ~PGDIR_MASK) >> PAGE_SHIFT);
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2095
  	do {
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2096
2097
2098
2099
2100
  		pages[*nr] = page;
  		(*nr)++;
  		page++;
  		refs++;
  	} while (addr += PAGE_SIZE, addr != end);
8fde12ca7   Linus Torvalds   mm: prevent get_u...
2101
2102
  	head = try_get_compound_head(pgd_page(orig), refs);
  	if (!head) {
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
  		*nr -= refs;
  		return 0;
  	}
  
  	if (unlikely(pgd_val(orig) != pgd_val(*pgdp))) {
  		*nr -= refs;
  		while (refs--)
  			put_page(head);
  		return 0;
  	}
e93480537   Kirill A. Shutemov   mm/gup: Mark all ...
2113
  	SetPageReferenced(head);
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2114
2115
  	return 1;
  }
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2116
  static int gup_pmd_range(pud_t *pudp, pud_t pud, unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
2117
  		unsigned int flags, struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
2118
2119
2120
  {
  	unsigned long next;
  	pmd_t *pmdp;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2121
  	pmdp = pmd_offset_lockless(pudp, pud, addr);
2667f50e8   Steve Capper   mm: introduce a g...
2122
  	do {
38c5ce936   Christian Borntraeger   mm/gup: Replace A...
2123
  		pmd_t pmd = READ_ONCE(*pmdp);
2667f50e8   Steve Capper   mm: introduce a g...
2124
2125
  
  		next = pmd_addr_end(addr, end);
84c3fc4e9   Zi Yan   mm: thp: check pm...
2126
  		if (!pmd_present(pmd))
2667f50e8   Steve Capper   mm: introduce a g...
2127
  			return 0;
414fd080d   Yu Zhao   mm/gup: fix gup_p...
2128
2129
  		if (unlikely(pmd_trans_huge(pmd) || pmd_huge(pmd) ||
  			     pmd_devmap(pmd))) {
2667f50e8   Steve Capper   mm: introduce a g...
2130
2131
2132
2133
2134
  			/*
  			 * NUMA hinting faults need to be handled in the GUP
  			 * slowpath for accounting purposes and so that they
  			 * can be serialised against THP migration.
  			 */
8a0516ed8   Mel Gorman   mm: convert p[te|...
2135
  			if (pmd_protnone(pmd))
2667f50e8   Steve Capper   mm: introduce a g...
2136
  				return 0;
b798bec47   Ira Weiny   mm/gup: change wr...
2137
  			if (!gup_huge_pmd(pmd, pmdp, addr, next, flags,
2667f50e8   Steve Capper   mm: introduce a g...
2138
2139
  				pages, nr))
  				return 0;
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2140
2141
2142
2143
2144
2145
  		} else if (unlikely(is_hugepd(__hugepd(pmd_val(pmd))))) {
  			/*
  			 * architecture have different format for hugetlbfs
  			 * pmd format and THP pmd format
  			 */
  			if (!gup_huge_pd(__hugepd(pmd_val(pmd)), addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2146
  					 PMD_SHIFT, next, flags, pages, nr))
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2147
  				return 0;
b798bec47   Ira Weiny   mm/gup: change wr...
2148
  		} else if (!gup_pte_range(pmd, addr, next, flags, pages, nr))
2923117b7   Mario Leinweber   mm/gup.c: fix cod...
2149
  			return 0;
2667f50e8   Steve Capper   mm: introduce a g...
2150
2151
2152
2153
  	} while (pmdp++, addr = next, addr != end);
  
  	return 1;
  }
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2154
  static int gup_pud_range(p4d_t *p4dp, p4d_t p4d, unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
2155
  			 unsigned int flags, struct page **pages, int *nr)
2667f50e8   Steve Capper   mm: introduce a g...
2156
2157
2158
  {
  	unsigned long next;
  	pud_t *pudp;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2159
  	pudp = pud_offset_lockless(p4dp, p4d, addr);
2667f50e8   Steve Capper   mm: introduce a g...
2160
  	do {
e37c69827   Christian Borntraeger   mm: replace ACCES...
2161
  		pud_t pud = READ_ONCE(*pudp);
2667f50e8   Steve Capper   mm: introduce a g...
2162
2163
2164
2165
  
  		next = pud_addr_end(addr, end);
  		if (pud_none(pud))
  			return 0;
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2166
  		if (unlikely(pud_huge(pud))) {
b798bec47   Ira Weiny   mm/gup: change wr...
2167
  			if (!gup_huge_pud(pud, pudp, addr, next, flags,
f30c59e92   Aneesh Kumar K.V   mm: Update generi...
2168
2169
2170
2171
  					  pages, nr))
  				return 0;
  		} else if (unlikely(is_hugepd(__hugepd(pud_val(pud))))) {
  			if (!gup_huge_pd(__hugepd(pud_val(pud)), addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2172
  					 PUD_SHIFT, next, flags, pages, nr))
2667f50e8   Steve Capper   mm: introduce a g...
2173
  				return 0;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2174
  		} else if (!gup_pmd_range(pudp, pud, addr, next, flags, pages, nr))
2667f50e8   Steve Capper   mm: introduce a g...
2175
2176
2177
2178
2179
  			return 0;
  	} while (pudp++, addr = next, addr != end);
  
  	return 1;
  }
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2180
  static int gup_p4d_range(pgd_t *pgdp, pgd_t pgd, unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
2181
  			 unsigned int flags, struct page **pages, int *nr)
c2febafc6   Kirill A. Shutemov   mm: convert gener...
2182
2183
2184
  {
  	unsigned long next;
  	p4d_t *p4dp;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2185
  	p4dp = p4d_offset_lockless(pgdp, pgd, addr);
c2febafc6   Kirill A. Shutemov   mm: convert gener...
2186
2187
2188
2189
2190
2191
2192
2193
2194
  	do {
  		p4d_t p4d = READ_ONCE(*p4dp);
  
  		next = p4d_addr_end(addr, end);
  		if (p4d_none(p4d))
  			return 0;
  		BUILD_BUG_ON(p4d_huge(p4d));
  		if (unlikely(is_hugepd(__hugepd(p4d_val(p4d))))) {
  			if (!gup_huge_pd(__hugepd(p4d_val(p4d)), addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2195
  					 P4D_SHIFT, next, flags, pages, nr))
c2febafc6   Kirill A. Shutemov   mm: convert gener...
2196
  				return 0;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2197
  		} else if (!gup_pud_range(p4dp, p4d, addr, next, flags, pages, nr))
c2febafc6   Kirill A. Shutemov   mm: convert gener...
2198
2199
2200
2201
2202
  			return 0;
  	} while (p4dp++, addr = next, addr != end);
  
  	return 1;
  }
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2203
  static void gup_pgd_range(unsigned long addr, unsigned long end,
b798bec47   Ira Weiny   mm/gup: change wr...
2204
  		unsigned int flags, struct page **pages, int *nr)
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
  {
  	unsigned long next;
  	pgd_t *pgdp;
  
  	pgdp = pgd_offset(current->mm, addr);
  	do {
  		pgd_t pgd = READ_ONCE(*pgdp);
  
  		next = pgd_addr_end(addr, end);
  		if (pgd_none(pgd))
  			return;
  		if (unlikely(pgd_huge(pgd))) {
b798bec47   Ira Weiny   mm/gup: change wr...
2217
  			if (!gup_huge_pgd(pgd, pgdp, addr, next, flags,
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2218
2219
2220
2221
  					  pages, nr))
  				return;
  		} else if (unlikely(is_hugepd(__hugepd(pgd_val(pgd))))) {
  			if (!gup_huge_pd(__hugepd(pgd_val(pgd)), addr,
b798bec47   Ira Weiny   mm/gup: change wr...
2222
  					 PGDIR_SHIFT, next, flags, pages, nr))
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2223
  				return;
4f5260ee0   Vasily Gorbik   mm/gup: fix gup_f...
2224
  		} else if (!gup_p4d_range(pgdp, pgd, addr, next, flags, pages, nr))
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2225
2226
2227
  			return;
  	} while (pgdp++, addr = next, addr != end);
  }
050a9adc6   Christoph Hellwig   mm: consolidate t...
2228
2229
2230
2231
2232
2233
  #else
  static inline void gup_pgd_range(unsigned long addr, unsigned long end,
  		unsigned int flags, struct page **pages, int *nr)
  {
  }
  #endif /* CONFIG_HAVE_FAST_GUP */
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2234
2235
2236
2237
2238
2239
  
  #ifndef gup_fast_permitted
  /*
   * Check if it's allowed to use __get_user_pages_fast() for the range, or
   * we need to fall back to the slow version:
   */
26f4c3280   Christoph Hellwig   mm: simplify gup_...
2240
  static bool gup_fast_permitted(unsigned long start, unsigned long end)
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2241
  {
26f4c3280   Christoph Hellwig   mm: simplify gup_...
2242
  	return true;
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2243
2244
  }
  #endif
2667f50e8   Steve Capper   mm: introduce a g...
2245
2246
  /*
   * Like get_user_pages_fast() except it's IRQ-safe in that it won't fall back to
d08110786   Michael S. Tsirkin   mm/gup.c: documen...
2247
2248
2249
   * the regular GUP.
   * Note a difference with get_user_pages_fast: this always returns the
   * number of pages pinned, 0 if no pages were pinned.
050a9adc6   Christoph Hellwig   mm: consolidate t...
2250
2251
2252
   *
   * If the architecture does not support this function, simply return with no
   * pages pinned.
1027dc04f   Linus Torvalds   gup: document and...
2253
2254
2255
2256
   *
   * Careful, careful! COW breaking can go either way, so a non-write
   * access can get ambiguous page results. If you call this function without
   * 'write' set, you'd better be sure that you're ok with that ambiguity.
2667f50e8   Steve Capper   mm: introduce a g...
2257
2258
2259
2260
   */
  int __get_user_pages_fast(unsigned long start, int nr_pages, int write,
  			  struct page **pages)
  {
d4faa4025   Wei Yang   mm: remove unnece...
2261
  	unsigned long len, end;
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2262
  	unsigned long flags;
2667f50e8   Steve Capper   mm: introduce a g...
2263
  	int nr = 0;
f455c8548   Christoph Hellwig   mm: use untagged_...
2264
  	start = untagged_addr(start) & PAGE_MASK;
2667f50e8   Steve Capper   mm: introduce a g...
2265
2266
  	len = (unsigned long) nr_pages << PAGE_SHIFT;
  	end = start + len;
26f4c3280   Christoph Hellwig   mm: simplify gup_...
2267
2268
  	if (end <= start)
  		return 0;
96d4f267e   Linus Torvalds   Remove 'type' arg...
2269
  	if (unlikely(!access_ok((void __user *)start, len)))
2667f50e8   Steve Capper   mm: introduce a g...
2270
2271
2272
2273
2274
2275
2276
  		return 0;
  
  	/*
  	 * Disable interrupts.  We use the nested form as we can already have
  	 * interrupts disabled by get_futex_key.
  	 *
  	 * With interrupts disabled, we block page table pages from being
2ebe82288   Fengguang Wu   mm/gup.c: fix __g...
2277
2278
  	 * freed from under us. See struct mmu_table_batch comments in
  	 * include/asm-generic/tlb.h for more details.
2667f50e8   Steve Capper   mm: introduce a g...
2279
2280
2281
  	 *
  	 * We do not adopt an rcu_read_lock(.) here as we also want to
  	 * block IPIs that come from THPs splitting.
1027dc04f   Linus Torvalds   gup: document and...
2282
2283
2284
2285
2286
2287
  	 *
  	 * NOTE! We allow read-only gup_fast() here, but you'd better be
  	 * careful about possible COW pages. You'll get _a_ COW page, but
  	 * not necessarily the one you intended to get depending on what
  	 * COW event happens after this. COW may break the page copy in a
  	 * random direction.
2667f50e8   Steve Capper   mm: introduce a g...
2288
  	 */
050a9adc6   Christoph Hellwig   mm: consolidate t...
2289
2290
  	if (IS_ENABLED(CONFIG_HAVE_FAST_GUP) &&
  	    gup_fast_permitted(start, end)) {
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2291
  		local_irq_save(flags);
b798bec47   Ira Weiny   mm/gup: change wr...
2292
  		gup_pgd_range(start, end, write ? FOLL_WRITE : 0, pages, &nr);
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2293
2294
  		local_irq_restore(flags);
  	}
2667f50e8   Steve Capper   mm: introduce a g...
2295
2296
2297
  
  	return nr;
  }
050a9adc6   Christoph Hellwig   mm: consolidate t...
2298
  EXPORT_SYMBOL_GPL(__get_user_pages_fast);
2667f50e8   Steve Capper   mm: introduce a g...
2299

7af75561e   Ira Weiny   mm/gup: add FOLL_...
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
  static int __gup_longterm_unlocked(unsigned long start, int nr_pages,
  				   unsigned int gup_flags, struct page **pages)
  {
  	int ret;
  
  	/*
  	 * FIXME: FOLL_LONGTERM does not work with
  	 * get_user_pages_unlocked() (see comments in that function)
  	 */
  	if (gup_flags & FOLL_LONGTERM) {
  		down_read(&current->mm->mmap_sem);
  		ret = __gup_longterm_locked(current, current->mm,
  					    start, nr_pages,
  					    pages, NULL, gup_flags);
  		up_read(&current->mm->mmap_sem);
  	} else {
  		ret = get_user_pages_unlocked(start, nr_pages,
  					      pages, gup_flags);
  	}
  
  	return ret;
  }
2667f50e8   Steve Capper   mm: introduce a g...
2322
2323
2324
2325
  /**
   * get_user_pages_fast() - pin user pages in memory
   * @start:	starting user address
   * @nr_pages:	number of pages from start to pin
73b0140bf   Ira Weiny   mm/gup: change GU...
2326
   * @gup_flags:	flags modifying pin behaviour
2667f50e8   Steve Capper   mm: introduce a g...
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
   * @pages:	array that receives pointers to the pages pinned.
   *		Should be at least nr_pages long.
   *
   * Attempt to pin user pages in memory without taking mm->mmap_sem.
   * If not successful, it will fall back to taking the lock and
   * calling get_user_pages().
   *
   * Returns number of pages pinned. This may be fewer than the number
   * requested. If nr_pages is 0 or negative, returns 0. If no pages
   * were pinned, returns -errno.
   */
73b0140bf   Ira Weiny   mm/gup: change GU...
2338
2339
  int get_user_pages_fast(unsigned long start, int nr_pages,
  			unsigned int gup_flags, struct page **pages)
2667f50e8   Steve Capper   mm: introduce a g...
2340
  {
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2341
  	unsigned long addr, len, end;
73e10a618   Kirill A. Shutemov   mm/gup: Provide c...
2342
  	int nr = 0, ret = 0;
2667f50e8   Steve Capper   mm: introduce a g...
2343

8cb5db61a   John Hubbard   mm/gup: allow FOL...
2344
2345
  	if (WARN_ON_ONCE(gup_flags & ~(FOLL_WRITE | FOLL_LONGTERM |
  				       FOLL_FORCE)))
817be129e   Christoph Hellwig   mm: validate get_...
2346
  		return -EINVAL;
f455c8548   Christoph Hellwig   mm: use untagged_...
2347
  	start = untagged_addr(start) & PAGE_MASK;
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2348
2349
2350
  	addr = start;
  	len = (unsigned long) nr_pages << PAGE_SHIFT;
  	end = start + len;
26f4c3280   Christoph Hellwig   mm: simplify gup_...
2351
  	if (end <= start)
c61611f70   Michael S. Tsirkin   get_user_pages_fa...
2352
  		return 0;
96d4f267e   Linus Torvalds   Remove 'type' arg...
2353
  	if (unlikely(!access_ok((void __user *)start, len)))
c61611f70   Michael S. Tsirkin   get_user_pages_fa...
2354
  		return -EFAULT;
73e10a618   Kirill A. Shutemov   mm/gup: Provide c...
2355

1027dc04f   Linus Torvalds   gup: document and...
2356
2357
2358
2359
2360
2361
2362
  	/*
  	 * The FAST_GUP case requires FOLL_WRITE even for pure reads,
  	 * because get_user_pages() may need to cause an early COW in
  	 * order to avoid confusing the normal COW routines. So only
  	 * targets that are already writable are safe to do by just
  	 * looking at the page tables.
  	 */
050a9adc6   Christoph Hellwig   mm: consolidate t...
2363
2364
  	if (IS_ENABLED(CONFIG_HAVE_FAST_GUP) &&
  	    gup_fast_permitted(start, end)) {
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2365
  		local_irq_disable();
1027dc04f   Linus Torvalds   gup: document and...
2366
  		gup_pgd_range(addr, end, gup_flags | FOLL_WRITE, pages, &nr);
5b65c4677   Kirill A. Shutemov   mm, x86/mm: Fix p...
2367
  		local_irq_enable();
73e10a618   Kirill A. Shutemov   mm/gup: Provide c...
2368
2369
  		ret = nr;
  	}
2667f50e8   Steve Capper   mm: introduce a g...
2370
2371
2372
2373
2374
  
  	if (nr < nr_pages) {
  		/* Try to get the remaining pages with get_user_pages */
  		start += nr << PAGE_SHIFT;
  		pages += nr;
7af75561e   Ira Weiny   mm/gup: add FOLL_...
2375
2376
  		ret = __gup_longterm_unlocked(start, nr_pages - nr,
  					      gup_flags, pages);
2667f50e8   Steve Capper   mm: introduce a g...
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
  
  		/* Have to be a bit careful with return values */
  		if (nr > 0) {
  			if (ret < 0)
  				ret = nr;
  			else
  				ret += nr;
  		}
  	}
  
  	return ret;
  }
050a9adc6   Christoph Hellwig   mm: consolidate t...
2389
  EXPORT_SYMBOL_GPL(get_user_pages_fast);