mm/mmap: free vm_area_struct without call_rcu in exit_mmap
[linux-block.git] / include / linux / mm.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_MM_H
3 #define _LINUX_MM_H
4
5 #include <linux/errno.h>
6 #include <linux/mmdebug.h>
7 #include <linux/gfp.h>
8 #include <linux/bug.h>
9 #include <linux/list.h>
10 #include <linux/mmzone.h>
11 #include <linux/rbtree.h>
12 #include <linux/atomic.h>
13 #include <linux/debug_locks.h>
14 #include <linux/mm_types.h>
15 #include <linux/mmap_lock.h>
16 #include <linux/range.h>
17 #include <linux/pfn.h>
18 #include <linux/percpu-refcount.h>
19 #include <linux/bit_spinlock.h>
20 #include <linux/shrinker.h>
21 #include <linux/resource.h>
22 #include <linux/page_ext.h>
23 #include <linux/err.h>
24 #include <linux/page-flags.h>
25 #include <linux/page_ref.h>
26 #include <linux/overflow.h>
27 #include <linux/sizes.h>
28 #include <linux/sched.h>
29 #include <linux/pgtable.h>
30 #include <linux/kasan.h>
31 #include <linux/memremap.h>
32
33 struct mempolicy;
34 struct anon_vma;
35 struct anon_vma_chain;
36 struct user_struct;
37 struct pt_regs;
38
39 extern int sysctl_page_lock_unfairness;
40
41 void mm_core_init(void);
42 void init_mm_internals(void);
43
44 #ifndef CONFIG_NUMA             /* Don't use mapnrs, do it properly */
45 extern unsigned long max_mapnr;
46
47 static inline void set_max_mapnr(unsigned long limit)
48 {
49         max_mapnr = limit;
50 }
51 #else
52 static inline void set_max_mapnr(unsigned long limit) { }
53 #endif
54
55 extern atomic_long_t _totalram_pages;
56 static inline unsigned long totalram_pages(void)
57 {
58         return (unsigned long)atomic_long_read(&_totalram_pages);
59 }
60
61 static inline void totalram_pages_inc(void)
62 {
63         atomic_long_inc(&_totalram_pages);
64 }
65
66 static inline void totalram_pages_dec(void)
67 {
68         atomic_long_dec(&_totalram_pages);
69 }
70
71 static inline void totalram_pages_add(long count)
72 {
73         atomic_long_add(count, &_totalram_pages);
74 }
75
76 extern void * high_memory;
77 extern int page_cluster;
78 extern const int page_cluster_max;
79
80 #ifdef CONFIG_SYSCTL
81 extern int sysctl_legacy_va_layout;
82 #else
83 #define sysctl_legacy_va_layout 0
84 #endif
85
86 #ifdef CONFIG_HAVE_ARCH_MMAP_RND_BITS
87 extern const int mmap_rnd_bits_min;
88 extern const int mmap_rnd_bits_max;
89 extern int mmap_rnd_bits __read_mostly;
90 #endif
91 #ifdef CONFIG_HAVE_ARCH_MMAP_RND_COMPAT_BITS
92 extern const int mmap_rnd_compat_bits_min;
93 extern const int mmap_rnd_compat_bits_max;
94 extern int mmap_rnd_compat_bits __read_mostly;
95 #endif
96
97 #include <asm/page.h>
98 #include <asm/processor.h>
99
100 /*
101  * Architectures that support memory tagging (assigning tags to memory regions,
102  * embedding these tags into addresses that point to these memory regions, and
103  * checking that the memory and the pointer tags match on memory accesses)
104  * redefine this macro to strip tags from pointers.
105  * It's defined as noop for architectures that don't support memory tagging.
106  */
107 #ifndef untagged_addr
108 #define untagged_addr(addr) (addr)
109 #endif
110
111 #ifndef __pa_symbol
112 #define __pa_symbol(x)  __pa(RELOC_HIDE((unsigned long)(x), 0))
113 #endif
114
115 #ifndef page_to_virt
116 #define page_to_virt(x) __va(PFN_PHYS(page_to_pfn(x)))
117 #endif
118
119 #ifndef lm_alias
120 #define lm_alias(x)     __va(__pa_symbol(x))
121 #endif
122
123 /*
124  * To prevent common memory management code establishing
125  * a zero page mapping on a read fault.
126  * This macro should be defined within <asm/pgtable.h>.
127  * s390 does this to prevent multiplexing of hardware bits
128  * related to the physical page in case of virtualization.
129  */
130 #ifndef mm_forbids_zeropage
131 #define mm_forbids_zeropage(X)  (0)
132 #endif
133
134 /*
135  * On some architectures it is expensive to call memset() for small sizes.
136  * If an architecture decides to implement their own version of
137  * mm_zero_struct_page they should wrap the defines below in a #ifndef and
138  * define their own version of this macro in <asm/pgtable.h>
139  */
140 #if BITS_PER_LONG == 64
141 /* This function must be updated when the size of struct page grows above 96
142  * or reduces below 56. The idea that compiler optimizes out switch()
143  * statement, and only leaves move/store instructions. Also the compiler can
144  * combine write statements if they are both assignments and can be reordered,
145  * this can result in several of the writes here being dropped.
146  */
147 #define mm_zero_struct_page(pp) __mm_zero_struct_page(pp)
148 static inline void __mm_zero_struct_page(struct page *page)
149 {
150         unsigned long *_pp = (void *)page;
151
152          /* Check that struct page is either 56, 64, 72, 80, 88 or 96 bytes */
153         BUILD_BUG_ON(sizeof(struct page) & 7);
154         BUILD_BUG_ON(sizeof(struct page) < 56);
155         BUILD_BUG_ON(sizeof(struct page) > 96);
156
157         switch (sizeof(struct page)) {
158         case 96:
159                 _pp[11] = 0;
160                 fallthrough;
161         case 88:
162                 _pp[10] = 0;
163                 fallthrough;
164         case 80:
165                 _pp[9] = 0;
166                 fallthrough;
167         case 72:
168                 _pp[8] = 0;
169                 fallthrough;
170         case 64:
171                 _pp[7] = 0;
172                 fallthrough;
173         case 56:
174                 _pp[6] = 0;
175                 _pp[5] = 0;
176                 _pp[4] = 0;
177                 _pp[3] = 0;
178                 _pp[2] = 0;
179                 _pp[1] = 0;
180                 _pp[0] = 0;
181         }
182 }
183 #else
184 #define mm_zero_struct_page(pp)  ((void)memset((pp), 0, sizeof(struct page)))
185 #endif
186
187 /*
188  * Default maximum number of active map areas, this limits the number of vmas
189  * per mm struct. Users can overwrite this number by sysctl but there is a
190  * problem.
191  *
192  * When a program's coredump is generated as ELF format, a section is created
193  * per a vma. In ELF, the number of sections is represented in unsigned short.
194  * This means the number of sections should be smaller than 65535 at coredump.
195  * Because the kernel adds some informative sections to a image of program at
196  * generating coredump, we need some margin. The number of extra sections is
197  * 1-3 now and depends on arch. We use "5" as safe margin, here.
198  *
199  * ELF extended numbering allows more than 65535 sections, so 16-bit bound is
200  * not a hard limit any more. Although some userspace tools can be surprised by
201  * that.
202  */
203 #define MAPCOUNT_ELF_CORE_MARGIN        (5)
204 #define DEFAULT_MAX_MAP_COUNT   (USHRT_MAX - MAPCOUNT_ELF_CORE_MARGIN)
205
206 extern int sysctl_max_map_count;
207
208 extern unsigned long sysctl_user_reserve_kbytes;
209 extern unsigned long sysctl_admin_reserve_kbytes;
210
211 extern int sysctl_overcommit_memory;
212 extern int sysctl_overcommit_ratio;
213 extern unsigned long sysctl_overcommit_kbytes;
214
215 int overcommit_ratio_handler(struct ctl_table *, int, void *, size_t *,
216                 loff_t *);
217 int overcommit_kbytes_handler(struct ctl_table *, int, void *, size_t *,
218                 loff_t *);
219 int overcommit_policy_handler(struct ctl_table *, int, void *, size_t *,
220                 loff_t *);
221
222 #if defined(CONFIG_SPARSEMEM) && !defined(CONFIG_SPARSEMEM_VMEMMAP)
223 #define nth_page(page,n) pfn_to_page(page_to_pfn((page)) + (n))
224 #define folio_page_idx(folio, p)        (page_to_pfn(p) - folio_pfn(folio))
225 #else
226 #define nth_page(page,n) ((page) + (n))
227 #define folio_page_idx(folio, p)        ((p) - &(folio)->page)
228 #endif
229
230 /* to align the pointer to the (next) page boundary */
231 #define PAGE_ALIGN(addr) ALIGN(addr, PAGE_SIZE)
232
233 /* to align the pointer to the (prev) page boundary */
234 #define PAGE_ALIGN_DOWN(addr) ALIGN_DOWN(addr, PAGE_SIZE)
235
236 /* test whether an address (unsigned long or pointer) is aligned to PAGE_SIZE */
237 #define PAGE_ALIGNED(addr)      IS_ALIGNED((unsigned long)(addr), PAGE_SIZE)
238
239 #define lru_to_page(head) (list_entry((head)->prev, struct page, lru))
240 static inline struct folio *lru_to_folio(struct list_head *head)
241 {
242         return list_entry((head)->prev, struct folio, lru);
243 }
244
245 void setup_initial_init_mm(void *start_code, void *end_code,
246                            void *end_data, void *brk);
247
248 /*
249  * Linux kernel virtual memory manager primitives.
250  * The idea being to have a "virtual" mm in the same way
251  * we have a virtual fs - giving a cleaner interface to the
252  * mm details, and allowing different kinds of memory mappings
253  * (from shared memory to executable loading to arbitrary
254  * mmap() functions).
255  */
256
257 struct vm_area_struct *vm_area_alloc(struct mm_struct *);
258 struct vm_area_struct *vm_area_dup(struct vm_area_struct *);
259 void vm_area_free(struct vm_area_struct *);
260 /* Use only if VMA has no other users */
261 void __vm_area_free(struct vm_area_struct *vma);
262
263 #ifndef CONFIG_MMU
264 extern struct rb_root nommu_region_tree;
265 extern struct rw_semaphore nommu_region_sem;
266
267 extern unsigned int kobjsize(const void *objp);
268 #endif
269
270 /*
271  * vm_flags in vm_area_struct, see mm_types.h.
272  * When changing, update also include/trace/events/mmflags.h
273  */
274 #define VM_NONE         0x00000000
275
276 #define VM_READ         0x00000001      /* currently active flags */
277 #define VM_WRITE        0x00000002
278 #define VM_EXEC         0x00000004
279 #define VM_SHARED       0x00000008
280
281 /* mprotect() hardcodes VM_MAYREAD >> 4 == VM_READ, and so for r/w/x bits. */
282 #define VM_MAYREAD      0x00000010      /* limits for mprotect() etc */
283 #define VM_MAYWRITE     0x00000020
284 #define VM_MAYEXEC      0x00000040
285 #define VM_MAYSHARE     0x00000080
286
287 #define VM_GROWSDOWN    0x00000100      /* general info on the segment */
288 #ifdef CONFIG_MMU
289 #define VM_UFFD_MISSING 0x00000200      /* missing pages tracking */
290 #else /* CONFIG_MMU */
291 #define VM_MAYOVERLAY   0x00000200      /* nommu: R/O MAP_PRIVATE mapping that might overlay a file mapping */
292 #define VM_UFFD_MISSING 0
293 #endif /* CONFIG_MMU */
294 #define VM_PFNMAP       0x00000400      /* Page-ranges managed without "struct page", just pure PFN */
295 #define VM_UFFD_WP      0x00001000      /* wrprotect pages tracking */
296
297 #define VM_LOCKED       0x00002000
298 #define VM_IO           0x00004000      /* Memory mapped I/O or similar */
299
300                                         /* Used by sys_madvise() */
301 #define VM_SEQ_READ     0x00008000      /* App will access data sequentially */
302 #define VM_RAND_READ    0x00010000      /* App will not benefit from clustered reads */
303
304 #define VM_DONTCOPY     0x00020000      /* Do not copy this vma on fork */
305 #define VM_DONTEXPAND   0x00040000      /* Cannot expand with mremap() */
306 #define VM_LOCKONFAULT  0x00080000      /* Lock the pages covered when they are faulted in */
307 #define VM_ACCOUNT      0x00100000      /* Is a VM accounted object */
308 #define VM_NORESERVE    0x00200000      /* should the VM suppress accounting */
309 #define VM_HUGETLB      0x00400000      /* Huge TLB Page VM */
310 #define VM_SYNC         0x00800000      /* Synchronous page faults */
311 #define VM_ARCH_1       0x01000000      /* Architecture-specific flag */
312 #define VM_WIPEONFORK   0x02000000      /* Wipe VMA contents in child. */
313 #define VM_DONTDUMP     0x04000000      /* Do not include in the core dump */
314
315 #ifdef CONFIG_MEM_SOFT_DIRTY
316 # define VM_SOFTDIRTY   0x08000000      /* Not soft dirty clean area */
317 #else
318 # define VM_SOFTDIRTY   0
319 #endif
320
321 #define VM_MIXEDMAP     0x10000000      /* Can contain "struct page" and pure PFN pages */
322 #define VM_HUGEPAGE     0x20000000      /* MADV_HUGEPAGE marked this vma */
323 #define VM_NOHUGEPAGE   0x40000000      /* MADV_NOHUGEPAGE marked this vma */
324 #define VM_MERGEABLE    0x80000000      /* KSM may merge identical pages */
325
326 #ifdef CONFIG_ARCH_USES_HIGH_VMA_FLAGS
327 #define VM_HIGH_ARCH_BIT_0      32      /* bit only usable on 64-bit architectures */
328 #define VM_HIGH_ARCH_BIT_1      33      /* bit only usable on 64-bit architectures */
329 #define VM_HIGH_ARCH_BIT_2      34      /* bit only usable on 64-bit architectures */
330 #define VM_HIGH_ARCH_BIT_3      35      /* bit only usable on 64-bit architectures */
331 #define VM_HIGH_ARCH_BIT_4      36      /* bit only usable on 64-bit architectures */
332 #define VM_HIGH_ARCH_0  BIT(VM_HIGH_ARCH_BIT_0)
333 #define VM_HIGH_ARCH_1  BIT(VM_HIGH_ARCH_BIT_1)
334 #define VM_HIGH_ARCH_2  BIT(VM_HIGH_ARCH_BIT_2)
335 #define VM_HIGH_ARCH_3  BIT(VM_HIGH_ARCH_BIT_3)
336 #define VM_HIGH_ARCH_4  BIT(VM_HIGH_ARCH_BIT_4)
337 #endif /* CONFIG_ARCH_USES_HIGH_VMA_FLAGS */
338
339 #ifdef CONFIG_ARCH_HAS_PKEYS
340 # define VM_PKEY_SHIFT  VM_HIGH_ARCH_BIT_0
341 # define VM_PKEY_BIT0   VM_HIGH_ARCH_0  /* A protection key is a 4-bit value */
342 # define VM_PKEY_BIT1   VM_HIGH_ARCH_1  /* on x86 and 5-bit value on ppc64   */
343 # define VM_PKEY_BIT2   VM_HIGH_ARCH_2
344 # define VM_PKEY_BIT3   VM_HIGH_ARCH_3
345 #ifdef CONFIG_PPC
346 # define VM_PKEY_BIT4  VM_HIGH_ARCH_4
347 #else
348 # define VM_PKEY_BIT4  0
349 #endif
350 #endif /* CONFIG_ARCH_HAS_PKEYS */
351
352 #if defined(CONFIG_X86)
353 # define VM_PAT         VM_ARCH_1       /* PAT reserves whole VMA at once (x86) */
354 #elif defined(CONFIG_PPC)
355 # define VM_SAO         VM_ARCH_1       /* Strong Access Ordering (powerpc) */
356 #elif defined(CONFIG_PARISC)
357 # define VM_GROWSUP     VM_ARCH_1
358 #elif defined(CONFIG_IA64)
359 # define VM_GROWSUP     VM_ARCH_1
360 #elif defined(CONFIG_SPARC64)
361 # define VM_SPARC_ADI   VM_ARCH_1       /* Uses ADI tag for access control */
362 # define VM_ARCH_CLEAR  VM_SPARC_ADI
363 #elif defined(CONFIG_ARM64)
364 # define VM_ARM64_BTI   VM_ARCH_1       /* BTI guarded page, a.k.a. GP bit */
365 # define VM_ARCH_CLEAR  VM_ARM64_BTI
366 #elif !defined(CONFIG_MMU)
367 # define VM_MAPPED_COPY VM_ARCH_1       /* T if mapped copy of data (nommu mmap) */
368 #endif
369
370 #if defined(CONFIG_ARM64_MTE)
371 # define VM_MTE         VM_HIGH_ARCH_0  /* Use Tagged memory for access control */
372 # define VM_MTE_ALLOWED VM_HIGH_ARCH_1  /* Tagged memory permitted */
373 #else
374 # define VM_MTE         VM_NONE
375 # define VM_MTE_ALLOWED VM_NONE
376 #endif
377
378 #ifndef VM_GROWSUP
379 # define VM_GROWSUP     VM_NONE
380 #endif
381
382 #ifdef CONFIG_HAVE_ARCH_USERFAULTFD_MINOR
383 # define VM_UFFD_MINOR_BIT      37
384 # define VM_UFFD_MINOR          BIT(VM_UFFD_MINOR_BIT)  /* UFFD minor faults */
385 #else /* !CONFIG_HAVE_ARCH_USERFAULTFD_MINOR */
386 # define VM_UFFD_MINOR          VM_NONE
387 #endif /* CONFIG_HAVE_ARCH_USERFAULTFD_MINOR */
388
389 /* Bits set in the VMA until the stack is in its final location */
390 #define VM_STACK_INCOMPLETE_SETUP       (VM_RAND_READ | VM_SEQ_READ)
391
392 #define TASK_EXEC ((current->personality & READ_IMPLIES_EXEC) ? VM_EXEC : 0)
393
394 /* Common data flag combinations */
395 #define VM_DATA_FLAGS_TSK_EXEC  (VM_READ | VM_WRITE | TASK_EXEC | \
396                                  VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC)
397 #define VM_DATA_FLAGS_NON_EXEC  (VM_READ | VM_WRITE | VM_MAYREAD | \
398                                  VM_MAYWRITE | VM_MAYEXEC)
399 #define VM_DATA_FLAGS_EXEC      (VM_READ | VM_WRITE | VM_EXEC | \
400                                  VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC)
401
402 #ifndef VM_DATA_DEFAULT_FLAGS           /* arch can override this */
403 #define VM_DATA_DEFAULT_FLAGS  VM_DATA_FLAGS_EXEC
404 #endif
405
406 #ifndef VM_STACK_DEFAULT_FLAGS          /* arch can override this */
407 #define VM_STACK_DEFAULT_FLAGS VM_DATA_DEFAULT_FLAGS
408 #endif
409
410 #ifdef CONFIG_STACK_GROWSUP
411 #define VM_STACK        VM_GROWSUP
412 #else
413 #define VM_STACK        VM_GROWSDOWN
414 #endif
415
416 #define VM_STACK_FLAGS  (VM_STACK | VM_STACK_DEFAULT_FLAGS | VM_ACCOUNT)
417
418 /* VMA basic access permission flags */
419 #define VM_ACCESS_FLAGS (VM_READ | VM_WRITE | VM_EXEC)
420
421
422 /*
423  * Special vmas that are non-mergable, non-mlock()able.
424  */
425 #define VM_SPECIAL (VM_IO | VM_DONTEXPAND | VM_PFNMAP | VM_MIXEDMAP)
426
427 /* This mask prevents VMA from being scanned with khugepaged */
428 #define VM_NO_KHUGEPAGED (VM_SPECIAL | VM_HUGETLB)
429
430 /* This mask defines which mm->def_flags a process can inherit its parent */
431 #define VM_INIT_DEF_MASK        VM_NOHUGEPAGE
432
433 /* This mask represents all the VMA flag bits used by mlock */
434 #define VM_LOCKED_MASK  (VM_LOCKED | VM_LOCKONFAULT)
435
436 /* Arch-specific flags to clear when updating VM flags on protection change */
437 #ifndef VM_ARCH_CLEAR
438 # define VM_ARCH_CLEAR  VM_NONE
439 #endif
440 #define VM_FLAGS_CLEAR  (ARCH_VM_PKEY_FLAGS | VM_ARCH_CLEAR)
441
442 /*
443  * mapping from the currently active vm_flags protection bits (the
444  * low four bits) to a page protection mask..
445  */
446
447 /*
448  * The default fault flags that should be used by most of the
449  * arch-specific page fault handlers.
450  */
451 #define FAULT_FLAG_DEFAULT  (FAULT_FLAG_ALLOW_RETRY | \
452                              FAULT_FLAG_KILLABLE | \
453                              FAULT_FLAG_INTERRUPTIBLE)
454
455 /**
456  * fault_flag_allow_retry_first - check ALLOW_RETRY the first time
457  * @flags: Fault flags.
458  *
459  * This is mostly used for places where we want to try to avoid taking
460  * the mmap_lock for too long a time when waiting for another condition
461  * to change, in which case we can try to be polite to release the
462  * mmap_lock in the first round to avoid potential starvation of other
463  * processes that would also want the mmap_lock.
464  *
465  * Return: true if the page fault allows retry and this is the first
466  * attempt of the fault handling; false otherwise.
467  */
468 static inline bool fault_flag_allow_retry_first(enum fault_flag flags)
469 {
470         return (flags & FAULT_FLAG_ALLOW_RETRY) &&
471             (!(flags & FAULT_FLAG_TRIED));
472 }
473
474 #define FAULT_FLAG_TRACE \
475         { FAULT_FLAG_WRITE,             "WRITE" }, \
476         { FAULT_FLAG_MKWRITE,           "MKWRITE" }, \
477         { FAULT_FLAG_ALLOW_RETRY,       "ALLOW_RETRY" }, \
478         { FAULT_FLAG_RETRY_NOWAIT,      "RETRY_NOWAIT" }, \
479         { FAULT_FLAG_KILLABLE,          "KILLABLE" }, \
480         { FAULT_FLAG_TRIED,             "TRIED" }, \
481         { FAULT_FLAG_USER,              "USER" }, \
482         { FAULT_FLAG_REMOTE,            "REMOTE" }, \
483         { FAULT_FLAG_INSTRUCTION,       "INSTRUCTION" }, \
484         { FAULT_FLAG_INTERRUPTIBLE,     "INTERRUPTIBLE" }, \
485         { FAULT_FLAG_VMA_LOCK,          "VMA_LOCK" }
486
487 /*
488  * vm_fault is filled by the pagefault handler and passed to the vma's
489  * ->fault function. The vma's ->fault is responsible for returning a bitmask
490  * of VM_FAULT_xxx flags that give details about how the fault was handled.
491  *
492  * MM layer fills up gfp_mask for page allocations but fault handler might
493  * alter it if its implementation requires a different allocation context.
494  *
495  * pgoff should be used in favour of virtual_address, if possible.
496  */
497 struct vm_fault {
498         const struct {
499                 struct vm_area_struct *vma;     /* Target VMA */
500                 gfp_t gfp_mask;                 /* gfp mask to be used for allocations */
501                 pgoff_t pgoff;                  /* Logical page offset based on vma */
502                 unsigned long address;          /* Faulting virtual address - masked */
503                 unsigned long real_address;     /* Faulting virtual address - unmasked */
504         };
505         enum fault_flag flags;          /* FAULT_FLAG_xxx flags
506                                          * XXX: should really be 'const' */
507         pmd_t *pmd;                     /* Pointer to pmd entry matching
508                                          * the 'address' */
509         pud_t *pud;                     /* Pointer to pud entry matching
510                                          * the 'address'
511                                          */
512         union {
513                 pte_t orig_pte;         /* Value of PTE at the time of fault */
514                 pmd_t orig_pmd;         /* Value of PMD at the time of fault,
515                                          * used by PMD fault only.
516                                          */
517         };
518
519         struct page *cow_page;          /* Page handler may use for COW fault */
520         struct page *page;              /* ->fault handlers should return a
521                                          * page here, unless VM_FAULT_NOPAGE
522                                          * is set (which is also implied by
523                                          * VM_FAULT_ERROR).
524                                          */
525         /* These three entries are valid only while holding ptl lock */
526         pte_t *pte;                     /* Pointer to pte entry matching
527                                          * the 'address'. NULL if the page
528                                          * table hasn't been allocated.
529                                          */
530         spinlock_t *ptl;                /* Page table lock.
531                                          * Protects pte page table if 'pte'
532                                          * is not NULL, otherwise pmd.
533                                          */
534         pgtable_t prealloc_pte;         /* Pre-allocated pte page table.
535                                          * vm_ops->map_pages() sets up a page
536                                          * table from atomic context.
537                                          * do_fault_around() pre-allocates
538                                          * page table to avoid allocation from
539                                          * atomic context.
540                                          */
541 };
542
543 /* page entry size for vm->huge_fault() */
544 enum page_entry_size {
545         PE_SIZE_PTE = 0,
546         PE_SIZE_PMD,
547         PE_SIZE_PUD,
548 };
549
550 /*
551  * These are the virtual MM functions - opening of an area, closing and
552  * unmapping it (needed to keep files on disk up-to-date etc), pointer
553  * to the functions called when a no-page or a wp-page exception occurs.
554  */
555 struct vm_operations_struct {
556         void (*open)(struct vm_area_struct * area);
557         /**
558          * @close: Called when the VMA is being removed from the MM.
559          * Context: User context.  May sleep.  Caller holds mmap_lock.
560          */
561         void (*close)(struct vm_area_struct * area);
562         /* Called any time before splitting to check if it's allowed */
563         int (*may_split)(struct vm_area_struct *area, unsigned long addr);
564         int (*mremap)(struct vm_area_struct *area);
565         /*
566          * Called by mprotect() to make driver-specific permission
567          * checks before mprotect() is finalised.   The VMA must not
568          * be modified.  Returns 0 if mprotect() can proceed.
569          */
570         int (*mprotect)(struct vm_area_struct *vma, unsigned long start,
571                         unsigned long end, unsigned long newflags);
572         vm_fault_t (*fault)(struct vm_fault *vmf);
573         vm_fault_t (*huge_fault)(struct vm_fault *vmf,
574                         enum page_entry_size pe_size);
575         vm_fault_t (*map_pages)(struct vm_fault *vmf,
576                         pgoff_t start_pgoff, pgoff_t end_pgoff);
577         unsigned long (*pagesize)(struct vm_area_struct * area);
578
579         /* notification that a previously read-only page is about to become
580          * writable, if an error is returned it will cause a SIGBUS */
581         vm_fault_t (*page_mkwrite)(struct vm_fault *vmf);
582
583         /* same as page_mkwrite when using VM_PFNMAP|VM_MIXEDMAP */
584         vm_fault_t (*pfn_mkwrite)(struct vm_fault *vmf);
585
586         /* called by access_process_vm when get_user_pages() fails, typically
587          * for use by special VMAs. See also generic_access_phys() for a generic
588          * implementation useful for any iomem mapping.
589          */
590         int (*access)(struct vm_area_struct *vma, unsigned long addr,
591                       void *buf, int len, int write);
592
593         /* Called by the /proc/PID/maps code to ask the vma whether it
594          * has a special name.  Returning non-NULL will also cause this
595          * vma to be dumped unconditionally. */
596         const char *(*name)(struct vm_area_struct *vma);
597
598 #ifdef CONFIG_NUMA
599         /*
600          * set_policy() op must add a reference to any non-NULL @new mempolicy
601          * to hold the policy upon return.  Caller should pass NULL @new to
602          * remove a policy and fall back to surrounding context--i.e. do not
603          * install a MPOL_DEFAULT policy, nor the task or system default
604          * mempolicy.
605          */
606         int (*set_policy)(struct vm_area_struct *vma, struct mempolicy *new);
607
608         /*
609          * get_policy() op must add reference [mpol_get()] to any policy at
610          * (vma,addr) marked as MPOL_SHARED.  The shared policy infrastructure
611          * in mm/mempolicy.c will do this automatically.
612          * get_policy() must NOT add a ref if the policy at (vma,addr) is not
613          * marked as MPOL_SHARED. vma policies are protected by the mmap_lock.
614          * If no [shared/vma] mempolicy exists at the addr, get_policy() op
615          * must return NULL--i.e., do not "fallback" to task or system default
616          * policy.
617          */
618         struct mempolicy *(*get_policy)(struct vm_area_struct *vma,
619                                         unsigned long addr);
620 #endif
621         /*
622          * Called by vm_normal_page() for special PTEs to find the
623          * page for @addr.  This is useful if the default behavior
624          * (using pte_page()) would not find the correct page.
625          */
626         struct page *(*find_special_page)(struct vm_area_struct *vma,
627                                           unsigned long addr);
628 };
629
630 #ifdef CONFIG_PER_VMA_LOCK
631 static inline void vma_init_lock(struct vm_area_struct *vma)
632 {
633         init_rwsem(&vma->lock);
634         vma->vm_lock_seq = -1;
635 }
636
637 /*
638  * Try to read-lock a vma. The function is allowed to occasionally yield false
639  * locked result to avoid performance overhead, in which case we fall back to
640  * using mmap_lock. The function should never yield false unlocked result.
641  */
642 static inline bool vma_start_read(struct vm_area_struct *vma)
643 {
644         /* Check before locking. A race might cause false locked result. */
645         if (vma->vm_lock_seq == READ_ONCE(vma->vm_mm->mm_lock_seq))
646                 return false;
647
648         if (unlikely(down_read_trylock(&vma->lock) == 0))
649                 return false;
650
651         /*
652          * Overflow might produce false locked result.
653          * False unlocked result is impossible because we modify and check
654          * vma->vm_lock_seq under vma->lock protection and mm->mm_lock_seq
655          * modification invalidates all existing locks.
656          */
657         if (unlikely(vma->vm_lock_seq == READ_ONCE(vma->vm_mm->mm_lock_seq))) {
658                 up_read(&vma->lock);
659                 return false;
660         }
661         return true;
662 }
663
664 static inline void vma_end_read(struct vm_area_struct *vma)
665 {
666         rcu_read_lock(); /* keeps vma alive till the end of up_read */
667         up_read(&vma->lock);
668         rcu_read_unlock();
669 }
670
671 static bool __is_vma_write_locked(struct vm_area_struct *vma, int *mm_lock_seq)
672 {
673         mmap_assert_write_locked(vma->vm_mm);
674
675         /*
676          * current task is holding mmap_write_lock, both vma->vm_lock_seq and
677          * mm->mm_lock_seq can't be concurrently modified.
678          */
679         *mm_lock_seq = READ_ONCE(vma->vm_mm->mm_lock_seq);
680         return (vma->vm_lock_seq == *mm_lock_seq);
681 }
682
683 static inline void vma_start_write(struct vm_area_struct *vma)
684 {
685         int mm_lock_seq;
686
687         if (__is_vma_write_locked(vma, &mm_lock_seq))
688                 return;
689
690         down_write(&vma->lock);
691         vma->vm_lock_seq = mm_lock_seq;
692         up_write(&vma->lock);
693 }
694
695 static inline bool vma_try_start_write(struct vm_area_struct *vma)
696 {
697         int mm_lock_seq;
698
699         if (__is_vma_write_locked(vma, &mm_lock_seq))
700                 return true;
701
702         if (!down_write_trylock(&vma->vm_lock->lock))
703                 return false;
704
705         vma->vm_lock_seq = mm_lock_seq;
706         up_write(&vma->vm_lock->lock);
707         return true;
708 }
709
710 static inline void vma_assert_write_locked(struct vm_area_struct *vma)
711 {
712         int mm_lock_seq;
713
714         VM_BUG_ON_VMA(!__is_vma_write_locked(vma, &mm_lock_seq), vma);
715 }
716
717 static inline void vma_mark_detached(struct vm_area_struct *vma, bool detached)
718 {
719         /* When detaching vma should be write-locked */
720         if (detached)
721                 vma_assert_write_locked(vma);
722         vma->detached = detached;
723 }
724
725 struct vm_area_struct *lock_vma_under_rcu(struct mm_struct *mm,
726                                           unsigned long address);
727
728 #else /* CONFIG_PER_VMA_LOCK */
729
730 static inline void vma_init_lock(struct vm_area_struct *vma) {}
731 static inline bool vma_start_read(struct vm_area_struct *vma)
732                 { return false; }
733 static inline void vma_end_read(struct vm_area_struct *vma) {}
734 static inline void vma_start_write(struct vm_area_struct *vma) {}
735 static inline bool vma_try_start_write(struct vm_area_struct *vma)
736                 { return true; }
737 static inline void vma_assert_write_locked(struct vm_area_struct *vma) {}
738 static inline void vma_mark_detached(struct vm_area_struct *vma,
739                                      bool detached) {}
740
741 #endif /* CONFIG_PER_VMA_LOCK */
742
743 static inline void vma_init(struct vm_area_struct *vma, struct mm_struct *mm)
744 {
745         static const struct vm_operations_struct dummy_vm_ops = {};
746
747         memset(vma, 0, sizeof(*vma));
748         vma->vm_mm = mm;
749         vma->vm_ops = &dummy_vm_ops;
750         INIT_LIST_HEAD(&vma->anon_vma_chain);
751         vma_mark_detached(vma, false);
752         vma_init_lock(vma);
753 }
754
755 /* Use when VMA is not part of the VMA tree and needs no locking */
756 static inline void vm_flags_init(struct vm_area_struct *vma,
757                                  vm_flags_t flags)
758 {
759         ACCESS_PRIVATE(vma, __vm_flags) = flags;
760 }
761
762 /* Use when VMA is part of the VMA tree and modifications need coordination */
763 static inline void vm_flags_reset(struct vm_area_struct *vma,
764                                   vm_flags_t flags)
765 {
766         vma_start_write(vma);
767         vm_flags_init(vma, flags);
768 }
769
770 static inline void vm_flags_reset_once(struct vm_area_struct *vma,
771                                        vm_flags_t flags)
772 {
773         vma_start_write(vma);
774         WRITE_ONCE(ACCESS_PRIVATE(vma, __vm_flags), flags);
775 }
776
777 static inline void vm_flags_set(struct vm_area_struct *vma,
778                                 vm_flags_t flags)
779 {
780         vma_start_write(vma);
781         ACCESS_PRIVATE(vma, __vm_flags) |= flags;
782 }
783
784 static inline void vm_flags_clear(struct vm_area_struct *vma,
785                                   vm_flags_t flags)
786 {
787         vma_start_write(vma);
788         ACCESS_PRIVATE(vma, __vm_flags) &= ~flags;
789 }
790
791 /*
792  * Use only if VMA is not part of the VMA tree or has no other users and
793  * therefore needs no locking.
794  */
795 static inline void __vm_flags_mod(struct vm_area_struct *vma,
796                                   vm_flags_t set, vm_flags_t clear)
797 {
798         vm_flags_init(vma, (vma->vm_flags | set) & ~clear);
799 }
800
801 /*
802  * Use only when the order of set/clear operations is unimportant, otherwise
803  * use vm_flags_{set|clear} explicitly.
804  */
805 static inline void vm_flags_mod(struct vm_area_struct *vma,
806                                 vm_flags_t set, vm_flags_t clear)
807 {
808         vma_start_write(vma);
809         __vm_flags_mod(vma, set, clear);
810 }
811
812 static inline void vma_set_anonymous(struct vm_area_struct *vma)
813 {
814         vma->vm_ops = NULL;
815 }
816
817 static inline bool vma_is_anonymous(struct vm_area_struct *vma)
818 {
819         return !vma->vm_ops;
820 }
821
822 static inline bool vma_is_temporary_stack(struct vm_area_struct *vma)
823 {
824         int maybe_stack = vma->vm_flags & (VM_GROWSDOWN | VM_GROWSUP);
825
826         if (!maybe_stack)
827                 return false;
828
829         if ((vma->vm_flags & VM_STACK_INCOMPLETE_SETUP) ==
830                                                 VM_STACK_INCOMPLETE_SETUP)
831                 return true;
832
833         return false;
834 }
835
836 static inline bool vma_is_foreign(struct vm_area_struct *vma)
837 {
838         if (!current->mm)
839                 return true;
840
841         if (current->mm != vma->vm_mm)
842                 return true;
843
844         return false;
845 }
846
847 static inline bool vma_is_accessible(struct vm_area_struct *vma)
848 {
849         return vma->vm_flags & VM_ACCESS_FLAGS;
850 }
851
852 static inline
853 struct vm_area_struct *vma_find(struct vma_iterator *vmi, unsigned long max)
854 {
855         return mas_find(&vmi->mas, max - 1);
856 }
857
858 static inline struct vm_area_struct *vma_next(struct vma_iterator *vmi)
859 {
860         /*
861          * Uses mas_find() to get the first VMA when the iterator starts.
862          * Calling mas_next() could skip the first entry.
863          */
864         return mas_find(&vmi->mas, ULONG_MAX);
865 }
866
867 static inline struct vm_area_struct *vma_prev(struct vma_iterator *vmi)
868 {
869         return mas_prev(&vmi->mas, 0);
870 }
871
872 static inline unsigned long vma_iter_addr(struct vma_iterator *vmi)
873 {
874         return vmi->mas.index;
875 }
876
877 static inline unsigned long vma_iter_end(struct vma_iterator *vmi)
878 {
879         return vmi->mas.last + 1;
880 }
881 static inline int vma_iter_bulk_alloc(struct vma_iterator *vmi,
882                                       unsigned long count)
883 {
884         return mas_expected_entries(&vmi->mas, count);
885 }
886
887 /* Free any unused preallocations */
888 static inline void vma_iter_free(struct vma_iterator *vmi)
889 {
890         mas_destroy(&vmi->mas);
891 }
892
893 static inline int vma_iter_bulk_store(struct vma_iterator *vmi,
894                                       struct vm_area_struct *vma)
895 {
896         vmi->mas.index = vma->vm_start;
897         vmi->mas.last = vma->vm_end - 1;
898         mas_store(&vmi->mas, vma);
899         if (unlikely(mas_is_err(&vmi->mas)))
900                 return -ENOMEM;
901
902         return 0;
903 }
904
905 static inline void vma_iter_invalidate(struct vma_iterator *vmi)
906 {
907         mas_pause(&vmi->mas);
908 }
909
910 static inline void vma_iter_set(struct vma_iterator *vmi, unsigned long addr)
911 {
912         mas_set(&vmi->mas, addr);
913 }
914
915 #define for_each_vma(__vmi, __vma)                                      \
916         while (((__vma) = vma_next(&(__vmi))) != NULL)
917
918 /* The MM code likes to work with exclusive end addresses */
919 #define for_each_vma_range(__vmi, __vma, __end)                         \
920         while (((__vma) = vma_find(&(__vmi), (__end))) != NULL)
921
922 #ifdef CONFIG_SHMEM
923 /*
924  * The vma_is_shmem is not inline because it is used only by slow
925  * paths in userfault.
926  */
927 bool vma_is_shmem(struct vm_area_struct *vma);
928 bool vma_is_anon_shmem(struct vm_area_struct *vma);
929 #else
930 static inline bool vma_is_shmem(struct vm_area_struct *vma) { return false; }
931 static inline bool vma_is_anon_shmem(struct vm_area_struct *vma) { return false; }
932 #endif
933
934 int vma_is_stack_for_current(struct vm_area_struct *vma);
935
936 /* flush_tlb_range() takes a vma, not a mm, and can care about flags */
937 #define TLB_FLUSH_VMA(mm,flags) { .vm_mm = (mm), .vm_flags = (flags) }
938
939 struct mmu_gather;
940 struct inode;
941
942 /*
943  * compound_order() can be called without holding a reference, which means
944  * that niceties like page_folio() don't work.  These callers should be
945  * prepared to handle wild return values.  For example, PG_head may be
946  * set before _folio_order is initialised, or this may be a tail page.
947  * See compaction.c for some good examples.
948  */
949 static inline unsigned int compound_order(struct page *page)
950 {
951         struct folio *folio = (struct folio *)page;
952
953         if (!test_bit(PG_head, &folio->flags))
954                 return 0;
955         return folio->_folio_order;
956 }
957
958 /**
959  * folio_order - The allocation order of a folio.
960  * @folio: The folio.
961  *
962  * A folio is composed of 2^order pages.  See get_order() for the definition
963  * of order.
964  *
965  * Return: The order of the folio.
966  */
967 static inline unsigned int folio_order(struct folio *folio)
968 {
969         if (!folio_test_large(folio))
970                 return 0;
971         return folio->_folio_order;
972 }
973
974 #include <linux/huge_mm.h>
975
976 /*
977  * Methods to modify the page usage count.
978  *
979  * What counts for a page usage:
980  * - cache mapping   (page->mapping)
981  * - private data    (page->private)
982  * - page mapped in a task's page tables, each mapping
983  *   is counted separately
984  *
985  * Also, many kernel routines increase the page count before a critical
986  * routine so they can be sure the page doesn't go away from under them.
987  */
988
989 /*
990  * Drop a ref, return true if the refcount fell to zero (the page has no users)
991  */
992 static inline int put_page_testzero(struct page *page)
993 {
994         VM_BUG_ON_PAGE(page_ref_count(page) == 0, page);
995         return page_ref_dec_and_test(page);
996 }
997
998 static inline int folio_put_testzero(struct folio *folio)
999 {
1000         return put_page_testzero(&folio->page);
1001 }
1002
1003 /*
1004  * Try to grab a ref unless the page has a refcount of zero, return false if
1005  * that is the case.
1006  * This can be called when MMU is off so it must not access
1007  * any of the virtual mappings.
1008  */
1009 static inline bool get_page_unless_zero(struct page *page)
1010 {
1011         return page_ref_add_unless(page, 1, 0);
1012 }
1013
1014 static inline struct folio *folio_get_nontail_page(struct page *page)
1015 {
1016         if (unlikely(!get_page_unless_zero(page)))
1017                 return NULL;
1018         return (struct folio *)page;
1019 }
1020
1021 extern int page_is_ram(unsigned long pfn);
1022
1023 enum {
1024         REGION_INTERSECTS,
1025         REGION_DISJOINT,
1026         REGION_MIXED,
1027 };
1028
1029 int region_intersects(resource_size_t offset, size_t size, unsigned long flags,
1030                       unsigned long desc);
1031
1032 /* Support for virtually mapped pages */
1033 struct page *vmalloc_to_page(const void *addr);
1034 unsigned long vmalloc_to_pfn(const void *addr);
1035
1036 /*
1037  * Determine if an address is within the vmalloc range
1038  *
1039  * On nommu, vmalloc/vfree wrap through kmalloc/kfree directly, so there
1040  * is no special casing required.
1041  */
1042
1043 #ifndef is_ioremap_addr
1044 #define is_ioremap_addr(x) is_vmalloc_addr(x)
1045 #endif
1046
1047 #ifdef CONFIG_MMU
1048 extern bool is_vmalloc_addr(const void *x);
1049 extern int is_vmalloc_or_module_addr(const void *x);
1050 #else
1051 static inline bool is_vmalloc_addr(const void *x)
1052 {
1053         return false;
1054 }
1055 static inline int is_vmalloc_or_module_addr(const void *x)
1056 {
1057         return 0;
1058 }
1059 #endif
1060
1061 /*
1062  * How many times the entire folio is mapped as a single unit (eg by a
1063  * PMD or PUD entry).  This is probably not what you want, except for
1064  * debugging purposes - it does not include PTE-mapped sub-pages; look
1065  * at folio_mapcount() or page_mapcount() or total_mapcount() instead.
1066  */
1067 static inline int folio_entire_mapcount(struct folio *folio)
1068 {
1069         VM_BUG_ON_FOLIO(!folio_test_large(folio), folio);
1070         return atomic_read(&folio->_entire_mapcount) + 1;
1071 }
1072
1073 /*
1074  * The atomic page->_mapcount, starts from -1: so that transitions
1075  * both from it and to it can be tracked, using atomic_inc_and_test
1076  * and atomic_add_negative(-1).
1077  */
1078 static inline void page_mapcount_reset(struct page *page)
1079 {
1080         atomic_set(&(page)->_mapcount, -1);
1081 }
1082
1083 /**
1084  * page_mapcount() - Number of times this precise page is mapped.
1085  * @page: The page.
1086  *
1087  * The number of times this page is mapped.  If this page is part of
1088  * a large folio, it includes the number of times this page is mapped
1089  * as part of that folio.
1090  *
1091  * The result is undefined for pages which cannot be mapped into userspace.
1092  * For example SLAB or special types of pages. See function page_has_type().
1093  * They use this field in struct page differently.
1094  */
1095 static inline int page_mapcount(struct page *page)
1096 {
1097         int mapcount = atomic_read(&page->_mapcount) + 1;
1098
1099         if (unlikely(PageCompound(page)))
1100                 mapcount += folio_entire_mapcount(page_folio(page));
1101
1102         return mapcount;
1103 }
1104
1105 int folio_total_mapcount(struct folio *folio);
1106
1107 /**
1108  * folio_mapcount() - Calculate the number of mappings of this folio.
1109  * @folio: The folio.
1110  *
1111  * A large folio tracks both how many times the entire folio is mapped,
1112  * and how many times each individual page in the folio is mapped.
1113  * This function calculates the total number of times the folio is
1114  * mapped.
1115  *
1116  * Return: The number of times this folio is mapped.
1117  */
1118 static inline int folio_mapcount(struct folio *folio)
1119 {
1120         if (likely(!folio_test_large(folio)))
1121                 return atomic_read(&folio->_mapcount) + 1;
1122         return folio_total_mapcount(folio);
1123 }
1124
1125 static inline int total_mapcount(struct page *page)
1126 {
1127         if (likely(!PageCompound(page)))
1128                 return atomic_read(&page->_mapcount) + 1;
1129         return folio_total_mapcount(page_folio(page));
1130 }
1131
1132 static inline bool folio_large_is_mapped(struct folio *folio)
1133 {
1134         /*
1135          * Reading _entire_mapcount below could be omitted if hugetlb
1136          * participated in incrementing nr_pages_mapped when compound mapped.
1137          */
1138         return atomic_read(&folio->_nr_pages_mapped) > 0 ||
1139                 atomic_read(&folio->_entire_mapcount) >= 0;
1140 }
1141
1142 /**
1143  * folio_mapped - Is this folio mapped into userspace?
1144  * @folio: The folio.
1145  *
1146  * Return: True if any page in this folio is referenced by user page tables.
1147  */
1148 static inline bool folio_mapped(struct folio *folio)
1149 {
1150         if (likely(!folio_test_large(folio)))
1151                 return atomic_read(&folio->_mapcount) >= 0;
1152         return folio_large_is_mapped(folio);
1153 }
1154
1155 /*
1156  * Return true if this page is mapped into pagetables.
1157  * For compound page it returns true if any sub-page of compound page is mapped,
1158  * even if this particular sub-page is not itself mapped by any PTE or PMD.
1159  */
1160 static inline bool page_mapped(struct page *page)
1161 {
1162         if (likely(!PageCompound(page)))
1163                 return atomic_read(&page->_mapcount) >= 0;
1164         return folio_large_is_mapped(page_folio(page));
1165 }
1166
1167 static inline struct page *virt_to_head_page(const void *x)
1168 {
1169         struct page *page = virt_to_page(x);
1170
1171         return compound_head(page);
1172 }
1173
1174 static inline struct folio *virt_to_folio(const void *x)
1175 {
1176         struct page *page = virt_to_page(x);
1177
1178         return page_folio(page);
1179 }
1180
1181 void __folio_put(struct folio *folio);
1182
1183 void put_pages_list(struct list_head *pages);
1184
1185 void split_page(struct page *page, unsigned int order);
1186 void folio_copy(struct folio *dst, struct folio *src);
1187
1188 unsigned long nr_free_buffer_pages(void);
1189
1190 /*
1191  * Compound pages have a destructor function.  Provide a
1192  * prototype for that function and accessor functions.
1193  * These are _only_ valid on the head of a compound page.
1194  */
1195 typedef void compound_page_dtor(struct page *);
1196
1197 /* Keep the enum in sync with compound_page_dtors array in mm/page_alloc.c */
1198 enum compound_dtor_id {
1199         NULL_COMPOUND_DTOR,
1200         COMPOUND_PAGE_DTOR,
1201 #ifdef CONFIG_HUGETLB_PAGE
1202         HUGETLB_PAGE_DTOR,
1203 #endif
1204 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1205         TRANSHUGE_PAGE_DTOR,
1206 #endif
1207         NR_COMPOUND_DTORS,
1208 };
1209 extern compound_page_dtor * const compound_page_dtors[NR_COMPOUND_DTORS];
1210
1211 static inline void set_compound_page_dtor(struct page *page,
1212                 enum compound_dtor_id compound_dtor)
1213 {
1214         struct folio *folio = (struct folio *)page;
1215
1216         VM_BUG_ON_PAGE(compound_dtor >= NR_COMPOUND_DTORS, page);
1217         VM_BUG_ON_PAGE(!PageHead(page), page);
1218         folio->_folio_dtor = compound_dtor;
1219 }
1220
1221 static inline void folio_set_compound_dtor(struct folio *folio,
1222                 enum compound_dtor_id compound_dtor)
1223 {
1224         VM_BUG_ON_FOLIO(compound_dtor >= NR_COMPOUND_DTORS, folio);
1225         folio->_folio_dtor = compound_dtor;
1226 }
1227
1228 void destroy_large_folio(struct folio *folio);
1229
1230 static inline void set_compound_order(struct page *page, unsigned int order)
1231 {
1232         struct folio *folio = (struct folio *)page;
1233
1234         folio->_folio_order = order;
1235 #ifdef CONFIG_64BIT
1236         folio->_folio_nr_pages = 1U << order;
1237 #endif
1238 }
1239
1240 /* Returns the number of bytes in this potentially compound page. */
1241 static inline unsigned long page_size(struct page *page)
1242 {
1243         return PAGE_SIZE << compound_order(page);
1244 }
1245
1246 /* Returns the number of bits needed for the number of bytes in a page */
1247 static inline unsigned int page_shift(struct page *page)
1248 {
1249         return PAGE_SHIFT + compound_order(page);
1250 }
1251
1252 /**
1253  * thp_order - Order of a transparent huge page.
1254  * @page: Head page of a transparent huge page.
1255  */
1256 static inline unsigned int thp_order(struct page *page)
1257 {
1258         VM_BUG_ON_PGFLAGS(PageTail(page), page);
1259         return compound_order(page);
1260 }
1261
1262 /**
1263  * thp_size - Size of a transparent huge page.
1264  * @page: Head page of a transparent huge page.
1265  *
1266  * Return: Number of bytes in this page.
1267  */
1268 static inline unsigned long thp_size(struct page *page)
1269 {
1270         return PAGE_SIZE << thp_order(page);
1271 }
1272
1273 void free_compound_page(struct page *page);
1274
1275 #ifdef CONFIG_MMU
1276 /*
1277  * Do pte_mkwrite, but only if the vma says VM_WRITE.  We do this when
1278  * servicing faults for write access.  In the normal case, do always want
1279  * pte_mkwrite.  But get_user_pages can cause write faults for mappings
1280  * that do not have writing enabled, when used by access_process_vm.
1281  */
1282 static inline pte_t maybe_mkwrite(pte_t pte, struct vm_area_struct *vma)
1283 {
1284         if (likely(vma->vm_flags & VM_WRITE))
1285                 pte = pte_mkwrite(pte);
1286         return pte;
1287 }
1288
1289 vm_fault_t do_set_pmd(struct vm_fault *vmf, struct page *page);
1290 void do_set_pte(struct vm_fault *vmf, struct page *page, unsigned long addr);
1291
1292 vm_fault_t finish_fault(struct vm_fault *vmf);
1293 vm_fault_t finish_mkwrite_fault(struct vm_fault *vmf);
1294 #endif
1295
1296 /*
1297  * Multiple processes may "see" the same page. E.g. for untouched
1298  * mappings of /dev/null, all processes see the same page full of
1299  * zeroes, and text pages of executables and shared libraries have
1300  * only one copy in memory, at most, normally.
1301  *
1302  * For the non-reserved pages, page_count(page) denotes a reference count.
1303  *   page_count() == 0 means the page is free. page->lru is then used for
1304  *   freelist management in the buddy allocator.
1305  *   page_count() > 0  means the page has been allocated.
1306  *
1307  * Pages are allocated by the slab allocator in order to provide memory
1308  * to kmalloc and kmem_cache_alloc. In this case, the management of the
1309  * page, and the fields in 'struct page' are the responsibility of mm/slab.c
1310  * unless a particular usage is carefully commented. (the responsibility of
1311  * freeing the kmalloc memory is the caller's, of course).
1312  *
1313  * A page may be used by anyone else who does a __get_free_page().
1314  * In this case, page_count still tracks the references, and should only
1315  * be used through the normal accessor functions. The top bits of page->flags
1316  * and page->virtual store page management information, but all other fields
1317  * are unused and could be used privately, carefully. The management of this
1318  * page is the responsibility of the one who allocated it, and those who have
1319  * subsequently been given references to it.
1320  *
1321  * The other pages (we may call them "pagecache pages") are completely
1322  * managed by the Linux memory manager: I/O, buffers, swapping etc.
1323  * The following discussion applies only to them.
1324  *
1325  * A pagecache page contains an opaque `private' member, which belongs to the
1326  * page's address_space. Usually, this is the address of a circular list of
1327  * the page's disk buffers. PG_private must be set to tell the VM to call
1328  * into the filesystem to release these pages.
1329  *
1330  * A page may belong to an inode's memory mapping. In this case, page->mapping
1331  * is the pointer to the inode, and page->index is the file offset of the page,
1332  * in units of PAGE_SIZE.
1333  *
1334  * If pagecache pages are not associated with an inode, they are said to be
1335  * anonymous pages. These may become associated with the swapcache, and in that
1336  * case PG_swapcache is set, and page->private is an offset into the swapcache.
1337  *
1338  * In either case (swapcache or inode backed), the pagecache itself holds one
1339  * reference to the page. Setting PG_private should also increment the
1340  * refcount. The each user mapping also has a reference to the page.
1341  *
1342  * The pagecache pages are stored in a per-mapping radix tree, which is
1343  * rooted at mapping->i_pages, and indexed by offset.
1344  * Where 2.4 and early 2.6 kernels kept dirty/clean pages in per-address_space
1345  * lists, we instead now tag pages as dirty/writeback in the radix tree.
1346  *
1347  * All pagecache pages may be subject to I/O:
1348  * - inode pages may need to be read from disk,
1349  * - inode pages which have been modified and are MAP_SHARED may need
1350  *   to be written back to the inode on disk,
1351  * - anonymous pages (including MAP_PRIVATE file mappings) which have been
1352  *   modified may need to be swapped out to swap space and (later) to be read
1353  *   back into memory.
1354  */
1355
1356 #if defined(CONFIG_ZONE_DEVICE) && defined(CONFIG_FS_DAX)
1357 DECLARE_STATIC_KEY_FALSE(devmap_managed_key);
1358
1359 bool __put_devmap_managed_page_refs(struct page *page, int refs);
1360 static inline bool put_devmap_managed_page_refs(struct page *page, int refs)
1361 {
1362         if (!static_branch_unlikely(&devmap_managed_key))
1363                 return false;
1364         if (!is_zone_device_page(page))
1365                 return false;
1366         return __put_devmap_managed_page_refs(page, refs);
1367 }
1368 #else /* CONFIG_ZONE_DEVICE && CONFIG_FS_DAX */
1369 static inline bool put_devmap_managed_page_refs(struct page *page, int refs)
1370 {
1371         return false;
1372 }
1373 #endif /* CONFIG_ZONE_DEVICE && CONFIG_FS_DAX */
1374
1375 static inline bool put_devmap_managed_page(struct page *page)
1376 {
1377         return put_devmap_managed_page_refs(page, 1);
1378 }
1379
1380 /* 127: arbitrary random number, small enough to assemble well */
1381 #define folio_ref_zero_or_close_to_overflow(folio) \
1382         ((unsigned int) folio_ref_count(folio) + 127u <= 127u)
1383
1384 /**
1385  * folio_get - Increment the reference count on a folio.
1386  * @folio: The folio.
1387  *
1388  * Context: May be called in any context, as long as you know that
1389  * you have a refcount on the folio.  If you do not already have one,
1390  * folio_try_get() may be the right interface for you to use.
1391  */
1392 static inline void folio_get(struct folio *folio)
1393 {
1394         VM_BUG_ON_FOLIO(folio_ref_zero_or_close_to_overflow(folio), folio);
1395         folio_ref_inc(folio);
1396 }
1397
1398 static inline void get_page(struct page *page)
1399 {
1400         folio_get(page_folio(page));
1401 }
1402
1403 static inline __must_check bool try_get_page(struct page *page)
1404 {
1405         page = compound_head(page);
1406         if (WARN_ON_ONCE(page_ref_count(page) <= 0))
1407                 return false;
1408         page_ref_inc(page);
1409         return true;
1410 }
1411
1412 /**
1413  * folio_put - Decrement the reference count on a folio.
1414  * @folio: The folio.
1415  *
1416  * If the folio's reference count reaches zero, the memory will be
1417  * released back to the page allocator and may be used by another
1418  * allocation immediately.  Do not access the memory or the struct folio
1419  * after calling folio_put() unless you can be sure that it wasn't the
1420  * last reference.
1421  *
1422  * Context: May be called in process or interrupt context, but not in NMI
1423  * context.  May be called while holding a spinlock.
1424  */
1425 static inline void folio_put(struct folio *folio)
1426 {
1427         if (folio_put_testzero(folio))
1428                 __folio_put(folio);
1429 }
1430
1431 /**
1432  * folio_put_refs - Reduce the reference count on a folio.
1433  * @folio: The folio.
1434  * @refs: The amount to subtract from the folio's reference count.
1435  *
1436  * If the folio's reference count reaches zero, the memory will be
1437  * released back to the page allocator and may be used by another
1438  * allocation immediately.  Do not access the memory or the struct folio
1439  * after calling folio_put_refs() unless you can be sure that these weren't
1440  * the last references.
1441  *
1442  * Context: May be called in process or interrupt context, but not in NMI
1443  * context.  May be called while holding a spinlock.
1444  */
1445 static inline void folio_put_refs(struct folio *folio, int refs)
1446 {
1447         if (folio_ref_sub_and_test(folio, refs))
1448                 __folio_put(folio);
1449 }
1450
1451 /*
1452  * union release_pages_arg - an array of pages or folios
1453  *
1454  * release_pages() releases a simple array of multiple pages, and
1455  * accepts various different forms of said page array: either
1456  * a regular old boring array of pages, an array of folios, or
1457  * an array of encoded page pointers.
1458  *
1459  * The transparent union syntax for this kind of "any of these
1460  * argument types" is all kinds of ugly, so look away.
1461  */
1462 typedef union {
1463         struct page **pages;
1464         struct folio **folios;
1465         struct encoded_page **encoded_pages;
1466 } release_pages_arg __attribute__ ((__transparent_union__));
1467
1468 void release_pages(release_pages_arg, int nr);
1469
1470 /**
1471  * folios_put - Decrement the reference count on an array of folios.
1472  * @folios: The folios.
1473  * @nr: How many folios there are.
1474  *
1475  * Like folio_put(), but for an array of folios.  This is more efficient
1476  * than writing the loop yourself as it will optimise the locks which
1477  * need to be taken if the folios are freed.
1478  *
1479  * Context: May be called in process or interrupt context, but not in NMI
1480  * context.  May be called while holding a spinlock.
1481  */
1482 static inline void folios_put(struct folio **folios, unsigned int nr)
1483 {
1484         release_pages(folios, nr);
1485 }
1486
1487 static inline void put_page(struct page *page)
1488 {
1489         struct folio *folio = page_folio(page);
1490
1491         /*
1492          * For some devmap managed pages we need to catch refcount transition
1493          * from 2 to 1:
1494          */
1495         if (put_devmap_managed_page(&folio->page))
1496                 return;
1497         folio_put(folio);
1498 }
1499
1500 /*
1501  * GUP_PIN_COUNTING_BIAS, and the associated functions that use it, overload
1502  * the page's refcount so that two separate items are tracked: the original page
1503  * reference count, and also a new count of how many pin_user_pages() calls were
1504  * made against the page. ("gup-pinned" is another term for the latter).
1505  *
1506  * With this scheme, pin_user_pages() becomes special: such pages are marked as
1507  * distinct from normal pages. As such, the unpin_user_page() call (and its
1508  * variants) must be used in order to release gup-pinned pages.
1509  *
1510  * Choice of value:
1511  *
1512  * By making GUP_PIN_COUNTING_BIAS a power of two, debugging of page reference
1513  * counts with respect to pin_user_pages() and unpin_user_page() becomes
1514  * simpler, due to the fact that adding an even power of two to the page
1515  * refcount has the effect of using only the upper N bits, for the code that
1516  * counts up using the bias value. This means that the lower bits are left for
1517  * the exclusive use of the original code that increments and decrements by one
1518  * (or at least, by much smaller values than the bias value).
1519  *
1520  * Of course, once the lower bits overflow into the upper bits (and this is
1521  * OK, because subtraction recovers the original values), then visual inspection
1522  * no longer suffices to directly view the separate counts. However, for normal
1523  * applications that don't have huge page reference counts, this won't be an
1524  * issue.
1525  *
1526  * Locking: the lockless algorithm described in folio_try_get_rcu()
1527  * provides safe operation for get_user_pages(), page_mkclean() and
1528  * other calls that race to set up page table entries.
1529  */
1530 #define GUP_PIN_COUNTING_BIAS (1U << 10)
1531
1532 void unpin_user_page(struct page *page);
1533 void unpin_user_pages_dirty_lock(struct page **pages, unsigned long npages,
1534                                  bool make_dirty);
1535 void unpin_user_page_range_dirty_lock(struct page *page, unsigned long npages,
1536                                       bool make_dirty);
1537 void unpin_user_pages(struct page **pages, unsigned long npages);
1538
1539 static inline bool is_cow_mapping(vm_flags_t flags)
1540 {
1541         return (flags & (VM_SHARED | VM_MAYWRITE)) == VM_MAYWRITE;
1542 }
1543
1544 #ifndef CONFIG_MMU
1545 static inline bool is_nommu_shared_mapping(vm_flags_t flags)
1546 {
1547         /*
1548          * NOMMU shared mappings are ordinary MAP_SHARED mappings and selected
1549          * R/O MAP_PRIVATE file mappings that are an effective R/O overlay of
1550          * a file mapping. R/O MAP_PRIVATE mappings might still modify
1551          * underlying memory if ptrace is active, so this is only possible if
1552          * ptrace does not apply. Note that there is no mprotect() to upgrade
1553          * write permissions later.
1554          */
1555         return flags & (VM_MAYSHARE | VM_MAYOVERLAY);
1556 }
1557 #endif
1558
1559 #if defined(CONFIG_SPARSEMEM) && !defined(CONFIG_SPARSEMEM_VMEMMAP)
1560 #define SECTION_IN_PAGE_FLAGS
1561 #endif
1562
1563 /*
1564  * The identification function is mainly used by the buddy allocator for
1565  * determining if two pages could be buddies. We are not really identifying
1566  * the zone since we could be using the section number id if we do not have
1567  * node id available in page flags.
1568  * We only guarantee that it will return the same value for two combinable
1569  * pages in a zone.
1570  */
1571 static inline int page_zone_id(struct page *page)
1572 {
1573         return (page->flags >> ZONEID_PGSHIFT) & ZONEID_MASK;
1574 }
1575
1576 #ifdef NODE_NOT_IN_PAGE_FLAGS
1577 extern int page_to_nid(const struct page *page);
1578 #else
1579 static inline int page_to_nid(const struct page *page)
1580 {
1581         struct page *p = (struct page *)page;
1582
1583         return (PF_POISONED_CHECK(p)->flags >> NODES_PGSHIFT) & NODES_MASK;
1584 }
1585 #endif
1586
1587 static inline int folio_nid(const struct folio *folio)
1588 {
1589         return page_to_nid(&folio->page);
1590 }
1591
1592 #ifdef CONFIG_NUMA_BALANCING
1593 /* page access time bits needs to hold at least 4 seconds */
1594 #define PAGE_ACCESS_TIME_MIN_BITS       12
1595 #if LAST_CPUPID_SHIFT < PAGE_ACCESS_TIME_MIN_BITS
1596 #define PAGE_ACCESS_TIME_BUCKETS                                \
1597         (PAGE_ACCESS_TIME_MIN_BITS - LAST_CPUPID_SHIFT)
1598 #else
1599 #define PAGE_ACCESS_TIME_BUCKETS        0
1600 #endif
1601
1602 #define PAGE_ACCESS_TIME_MASK                           \
1603         (LAST_CPUPID_MASK << PAGE_ACCESS_TIME_BUCKETS)
1604
1605 static inline int cpu_pid_to_cpupid(int cpu, int pid)
1606 {
1607         return ((cpu & LAST__CPU_MASK) << LAST__PID_SHIFT) | (pid & LAST__PID_MASK);
1608 }
1609
1610 static inline int cpupid_to_pid(int cpupid)
1611 {
1612         return cpupid & LAST__PID_MASK;
1613 }
1614
1615 static inline int cpupid_to_cpu(int cpupid)
1616 {
1617         return (cpupid >> LAST__PID_SHIFT) & LAST__CPU_MASK;
1618 }
1619
1620 static inline int cpupid_to_nid(int cpupid)
1621 {
1622         return cpu_to_node(cpupid_to_cpu(cpupid));
1623 }
1624
1625 static inline bool cpupid_pid_unset(int cpupid)
1626 {
1627         return cpupid_to_pid(cpupid) == (-1 & LAST__PID_MASK);
1628 }
1629
1630 static inline bool cpupid_cpu_unset(int cpupid)
1631 {
1632         return cpupid_to_cpu(cpupid) == (-1 & LAST__CPU_MASK);
1633 }
1634
1635 static inline bool __cpupid_match_pid(pid_t task_pid, int cpupid)
1636 {
1637         return (task_pid & LAST__PID_MASK) == cpupid_to_pid(cpupid);
1638 }
1639
1640 #define cpupid_match_pid(task, cpupid) __cpupid_match_pid(task->pid, cpupid)
1641 #ifdef LAST_CPUPID_NOT_IN_PAGE_FLAGS
1642 static inline int page_cpupid_xchg_last(struct page *page, int cpupid)
1643 {
1644         return xchg(&page->_last_cpupid, cpupid & LAST_CPUPID_MASK);
1645 }
1646
1647 static inline int page_cpupid_last(struct page *page)
1648 {
1649         return page->_last_cpupid;
1650 }
1651 static inline void page_cpupid_reset_last(struct page *page)
1652 {
1653         page->_last_cpupid = -1 & LAST_CPUPID_MASK;
1654 }
1655 #else
1656 static inline int page_cpupid_last(struct page *page)
1657 {
1658         return (page->flags >> LAST_CPUPID_PGSHIFT) & LAST_CPUPID_MASK;
1659 }
1660
1661 extern int page_cpupid_xchg_last(struct page *page, int cpupid);
1662
1663 static inline void page_cpupid_reset_last(struct page *page)
1664 {
1665         page->flags |= LAST_CPUPID_MASK << LAST_CPUPID_PGSHIFT;
1666 }
1667 #endif /* LAST_CPUPID_NOT_IN_PAGE_FLAGS */
1668
1669 static inline int xchg_page_access_time(struct page *page, int time)
1670 {
1671         int last_time;
1672
1673         last_time = page_cpupid_xchg_last(page, time >> PAGE_ACCESS_TIME_BUCKETS);
1674         return last_time << PAGE_ACCESS_TIME_BUCKETS;
1675 }
1676 #else /* !CONFIG_NUMA_BALANCING */
1677 static inline int page_cpupid_xchg_last(struct page *page, int cpupid)
1678 {
1679         return page_to_nid(page); /* XXX */
1680 }
1681
1682 static inline int xchg_page_access_time(struct page *page, int time)
1683 {
1684         return 0;
1685 }
1686
1687 static inline int page_cpupid_last(struct page *page)
1688 {
1689         return page_to_nid(page); /* XXX */
1690 }
1691
1692 static inline int cpupid_to_nid(int cpupid)
1693 {
1694         return -1;
1695 }
1696
1697 static inline int cpupid_to_pid(int cpupid)
1698 {
1699         return -1;
1700 }
1701
1702 static inline int cpupid_to_cpu(int cpupid)
1703 {
1704         return -1;
1705 }
1706
1707 static inline int cpu_pid_to_cpupid(int nid, int pid)
1708 {
1709         return -1;
1710 }
1711
1712 static inline bool cpupid_pid_unset(int cpupid)
1713 {
1714         return true;
1715 }
1716
1717 static inline void page_cpupid_reset_last(struct page *page)
1718 {
1719 }
1720
1721 static inline bool cpupid_match_pid(struct task_struct *task, int cpupid)
1722 {
1723         return false;
1724 }
1725 #endif /* CONFIG_NUMA_BALANCING */
1726
1727 #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
1728
1729 /*
1730  * KASAN per-page tags are stored xor'ed with 0xff. This allows to avoid
1731  * setting tags for all pages to native kernel tag value 0xff, as the default
1732  * value 0x00 maps to 0xff.
1733  */
1734
1735 static inline u8 page_kasan_tag(const struct page *page)
1736 {
1737         u8 tag = 0xff;
1738
1739         if (kasan_enabled()) {
1740                 tag = (page->flags >> KASAN_TAG_PGSHIFT) & KASAN_TAG_MASK;
1741                 tag ^= 0xff;
1742         }
1743
1744         return tag;
1745 }
1746
1747 static inline void page_kasan_tag_set(struct page *page, u8 tag)
1748 {
1749         unsigned long old_flags, flags;
1750
1751         if (!kasan_enabled())
1752                 return;
1753
1754         tag ^= 0xff;
1755         old_flags = READ_ONCE(page->flags);
1756         do {
1757                 flags = old_flags;
1758                 flags &= ~(KASAN_TAG_MASK << KASAN_TAG_PGSHIFT);
1759                 flags |= (tag & KASAN_TAG_MASK) << KASAN_TAG_PGSHIFT;
1760         } while (unlikely(!try_cmpxchg(&page->flags, &old_flags, flags)));
1761 }
1762
1763 static inline void page_kasan_tag_reset(struct page *page)
1764 {
1765         if (kasan_enabled())
1766                 page_kasan_tag_set(page, 0xff);
1767 }
1768
1769 #else /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */
1770
1771 static inline u8 page_kasan_tag(const struct page *page)
1772 {
1773         return 0xff;
1774 }
1775
1776 static inline void page_kasan_tag_set(struct page *page, u8 tag) { }
1777 static inline void page_kasan_tag_reset(struct page *page) { }
1778
1779 #endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */
1780
1781 static inline struct zone *page_zone(const struct page *page)
1782 {
1783         return &NODE_DATA(page_to_nid(page))->node_zones[page_zonenum(page)];
1784 }
1785
1786 static inline pg_data_t *page_pgdat(const struct page *page)
1787 {
1788         return NODE_DATA(page_to_nid(page));
1789 }
1790
1791 static inline struct zone *folio_zone(const struct folio *folio)
1792 {
1793         return page_zone(&folio->page);
1794 }
1795
1796 static inline pg_data_t *folio_pgdat(const struct folio *folio)
1797 {
1798         return page_pgdat(&folio->page);
1799 }
1800
1801 #ifdef SECTION_IN_PAGE_FLAGS
1802 static inline void set_page_section(struct page *page, unsigned long section)
1803 {
1804         page->flags &= ~(SECTIONS_MASK << SECTIONS_PGSHIFT);
1805         page->flags |= (section & SECTIONS_MASK) << SECTIONS_PGSHIFT;
1806 }
1807
1808 static inline unsigned long page_to_section(const struct page *page)
1809 {
1810         return (page->flags >> SECTIONS_PGSHIFT) & SECTIONS_MASK;
1811 }
1812 #endif
1813
1814 /**
1815  * folio_pfn - Return the Page Frame Number of a folio.
1816  * @folio: The folio.
1817  *
1818  * A folio may contain multiple pages.  The pages have consecutive
1819  * Page Frame Numbers.
1820  *
1821  * Return: The Page Frame Number of the first page in the folio.
1822  */
1823 static inline unsigned long folio_pfn(struct folio *folio)
1824 {
1825         return page_to_pfn(&folio->page);
1826 }
1827
1828 static inline struct folio *pfn_folio(unsigned long pfn)
1829 {
1830         return page_folio(pfn_to_page(pfn));
1831 }
1832
1833 /**
1834  * folio_maybe_dma_pinned - Report if a folio may be pinned for DMA.
1835  * @folio: The folio.
1836  *
1837  * This function checks if a folio has been pinned via a call to
1838  * a function in the pin_user_pages() family.
1839  *
1840  * For small folios, the return value is partially fuzzy: false is not fuzzy,
1841  * because it means "definitely not pinned for DMA", but true means "probably
1842  * pinned for DMA, but possibly a false positive due to having at least
1843  * GUP_PIN_COUNTING_BIAS worth of normal folio references".
1844  *
1845  * False positives are OK, because: a) it's unlikely for a folio to
1846  * get that many refcounts, and b) all the callers of this routine are
1847  * expected to be able to deal gracefully with a false positive.
1848  *
1849  * For large folios, the result will be exactly correct. That's because
1850  * we have more tracking data available: the _pincount field is used
1851  * instead of the GUP_PIN_COUNTING_BIAS scheme.
1852  *
1853  * For more information, please see Documentation/core-api/pin_user_pages.rst.
1854  *
1855  * Return: True, if it is likely that the page has been "dma-pinned".
1856  * False, if the page is definitely not dma-pinned.
1857  */
1858 static inline bool folio_maybe_dma_pinned(struct folio *folio)
1859 {
1860         if (folio_test_large(folio))
1861                 return atomic_read(&folio->_pincount) > 0;
1862
1863         /*
1864          * folio_ref_count() is signed. If that refcount overflows, then
1865          * folio_ref_count() returns a negative value, and callers will avoid
1866          * further incrementing the refcount.
1867          *
1868          * Here, for that overflow case, use the sign bit to count a little
1869          * bit higher via unsigned math, and thus still get an accurate result.
1870          */
1871         return ((unsigned int)folio_ref_count(folio)) >=
1872                 GUP_PIN_COUNTING_BIAS;
1873 }
1874
1875 static inline bool page_maybe_dma_pinned(struct page *page)
1876 {
1877         return folio_maybe_dma_pinned(page_folio(page));
1878 }
1879
1880 /*
1881  * This should most likely only be called during fork() to see whether we
1882  * should break the cow immediately for an anon page on the src mm.
1883  *
1884  * The caller has to hold the PT lock and the vma->vm_mm->->write_protect_seq.
1885  */
1886 static inline bool page_needs_cow_for_dma(struct vm_area_struct *vma,
1887                                           struct page *page)
1888 {
1889         VM_BUG_ON(!(raw_read_seqcount(&vma->vm_mm->write_protect_seq) & 1));
1890
1891         if (!test_bit(MMF_HAS_PINNED, &vma->vm_mm->flags))
1892                 return false;
1893
1894         return page_maybe_dma_pinned(page);
1895 }
1896
1897 /* MIGRATE_CMA and ZONE_MOVABLE do not allow pin pages */
1898 #ifdef CONFIG_MIGRATION
1899 static inline bool is_longterm_pinnable_page(struct page *page)
1900 {
1901 #ifdef CONFIG_CMA
1902         int mt = get_pageblock_migratetype(page);
1903
1904         if (mt == MIGRATE_CMA || mt == MIGRATE_ISOLATE)
1905                 return false;
1906 #endif
1907         /* The zero page may always be pinned */
1908         if (is_zero_pfn(page_to_pfn(page)))
1909                 return true;
1910
1911         /* Coherent device memory must always allow eviction. */
1912         if (is_device_coherent_page(page))
1913                 return false;
1914
1915         /* Otherwise, non-movable zone pages can be pinned. */
1916         return !is_zone_movable_page(page);
1917 }
1918 #else
1919 static inline bool is_longterm_pinnable_page(struct page *page)
1920 {
1921         return true;
1922 }
1923 #endif
1924
1925 static inline bool folio_is_longterm_pinnable(struct folio *folio)
1926 {
1927         return is_longterm_pinnable_page(&folio->page);
1928 }
1929
1930 static inline void set_page_zone(struct page *page, enum zone_type zone)
1931 {
1932         page->flags &= ~(ZONES_MASK << ZONES_PGSHIFT);
1933         page->flags |= (zone & ZONES_MASK) << ZONES_PGSHIFT;
1934 }
1935
1936 static inline void set_page_node(struct page *page, unsigned long node)
1937 {
1938         page->flags &= ~(NODES_MASK << NODES_PGSHIFT);
1939         page->flags |= (node & NODES_MASK) << NODES_PGSHIFT;
1940 }
1941
1942 static inline void set_page_links(struct page *page, enum zone_type zone,
1943         unsigned long node, unsigned long pfn)
1944 {
1945         set_page_zone(page, zone);
1946         set_page_node(page, node);
1947 #ifdef SECTION_IN_PAGE_FLAGS
1948         set_page_section(page, pfn_to_section_nr(pfn));
1949 #endif
1950 }
1951
1952 /**
1953  * folio_nr_pages - The number of pages in the folio.
1954  * @folio: The folio.
1955  *
1956  * Return: A positive power of two.
1957  */
1958 static inline long folio_nr_pages(struct folio *folio)
1959 {
1960         if (!folio_test_large(folio))
1961                 return 1;
1962 #ifdef CONFIG_64BIT
1963         return folio->_folio_nr_pages;
1964 #else
1965         return 1L << folio->_folio_order;
1966 #endif
1967 }
1968
1969 /*
1970  * compound_nr() returns the number of pages in this potentially compound
1971  * page.  compound_nr() can be called on a tail page, and is defined to
1972  * return 1 in that case.
1973  */
1974 static inline unsigned long compound_nr(struct page *page)
1975 {
1976         struct folio *folio = (struct folio *)page;
1977
1978         if (!test_bit(PG_head, &folio->flags))
1979                 return 1;
1980 #ifdef CONFIG_64BIT
1981         return folio->_folio_nr_pages;
1982 #else
1983         return 1L << folio->_folio_order;
1984 #endif
1985 }
1986
1987 /**
1988  * thp_nr_pages - The number of regular pages in this huge page.
1989  * @page: The head page of a huge page.
1990  */
1991 static inline int thp_nr_pages(struct page *page)
1992 {
1993         return folio_nr_pages((struct folio *)page);
1994 }
1995
1996 /**
1997  * folio_next - Move to the next physical folio.
1998  * @folio: The folio we're currently operating on.
1999  *
2000  * If you have physically contiguous memory which may span more than
2001  * one folio (eg a &struct bio_vec), use this function to move from one
2002  * folio to the next.  Do not use it if the memory is only virtually
2003  * contiguous as the folios are almost certainly not adjacent to each
2004  * other.  This is the folio equivalent to writing ``page++``.
2005  *
2006  * Context: We assume that the folios are refcounted and/or locked at a
2007  * higher level and do not adjust the reference counts.
2008  * Return: The next struct folio.
2009  */
2010 static inline struct folio *folio_next(struct folio *folio)
2011 {
2012         return (struct folio *)folio_page(folio, folio_nr_pages(folio));
2013 }
2014
2015 /**
2016  * folio_shift - The size of the memory described by this folio.
2017  * @folio: The folio.
2018  *
2019  * A folio represents a number of bytes which is a power-of-two in size.
2020  * This function tells you which power-of-two the folio is.  See also
2021  * folio_size() and folio_order().
2022  *
2023  * Context: The caller should have a reference on the folio to prevent
2024  * it from being split.  It is not necessary for the folio to be locked.
2025  * Return: The base-2 logarithm of the size of this folio.
2026  */
2027 static inline unsigned int folio_shift(struct folio *folio)
2028 {
2029         return PAGE_SHIFT + folio_order(folio);
2030 }
2031
2032 /**
2033  * folio_size - The number of bytes in a folio.
2034  * @folio: The folio.
2035  *
2036  * Context: The caller should have a reference on the folio to prevent
2037  * it from being split.  It is not necessary for the folio to be locked.
2038  * Return: The number of bytes in this folio.
2039  */
2040 static inline size_t folio_size(struct folio *folio)
2041 {
2042         return PAGE_SIZE << folio_order(folio);
2043 }
2044
2045 /**
2046  * folio_estimated_sharers - Estimate the number of sharers of a folio.
2047  * @folio: The folio.
2048  *
2049  * folio_estimated_sharers() aims to serve as a function to efficiently
2050  * estimate the number of processes sharing a folio. This is done by
2051  * looking at the precise mapcount of the first subpage in the folio, and
2052  * assuming the other subpages are the same. This may not be true for large
2053  * folios. If you want exact mapcounts for exact calculations, look at
2054  * page_mapcount() or folio_total_mapcount().
2055  *
2056  * Return: The estimated number of processes sharing a folio.
2057  */
2058 static inline int folio_estimated_sharers(struct folio *folio)
2059 {
2060         return page_mapcount(folio_page(folio, 0));
2061 }
2062
2063 #ifndef HAVE_ARCH_MAKE_PAGE_ACCESSIBLE
2064 static inline int arch_make_page_accessible(struct page *page)
2065 {
2066         return 0;
2067 }
2068 #endif
2069
2070 #ifndef HAVE_ARCH_MAKE_FOLIO_ACCESSIBLE
2071 static inline int arch_make_folio_accessible(struct folio *folio)
2072 {
2073         int ret;
2074         long i, nr = folio_nr_pages(folio);
2075
2076         for (i = 0; i < nr; i++) {
2077                 ret = arch_make_page_accessible(folio_page(folio, i));
2078                 if (ret)
2079                         break;
2080         }
2081
2082         return ret;
2083 }
2084 #endif
2085
2086 /*
2087  * Some inline functions in vmstat.h depend on page_zone()
2088  */
2089 #include <linux/vmstat.h>
2090
2091 static __always_inline void *lowmem_page_address(const struct page *page)
2092 {
2093         return page_to_virt(page);
2094 }
2095
2096 #if defined(CONFIG_HIGHMEM) && !defined(WANT_PAGE_VIRTUAL)
2097 #define HASHED_PAGE_VIRTUAL
2098 #endif
2099
2100 #if defined(WANT_PAGE_VIRTUAL)
2101 static inline void *page_address(const struct page *page)
2102 {
2103         return page->virtual;
2104 }
2105 static inline void set_page_address(struct page *page, void *address)
2106 {
2107         page->virtual = address;
2108 }
2109 #define page_address_init()  do { } while(0)
2110 #endif
2111
2112 #if defined(HASHED_PAGE_VIRTUAL)
2113 void *page_address(const struct page *page);
2114 void set_page_address(struct page *page, void *virtual);
2115 void page_address_init(void);
2116 #endif
2117
2118 #if !defined(HASHED_PAGE_VIRTUAL) && !defined(WANT_PAGE_VIRTUAL)
2119 #define page_address(page) lowmem_page_address(page)
2120 #define set_page_address(page, address)  do { } while(0)
2121 #define page_address_init()  do { } while(0)
2122 #endif
2123
2124 static inline void *folio_address(const struct folio *folio)
2125 {
2126         return page_address(&folio->page);
2127 }
2128
2129 extern void *page_rmapping(struct page *page);
2130 extern pgoff_t __page_file_index(struct page *page);
2131
2132 /*
2133  * Return the pagecache index of the passed page.  Regular pagecache pages
2134  * use ->index whereas swapcache pages use swp_offset(->private)
2135  */
2136 static inline pgoff_t page_index(struct page *page)
2137 {
2138         if (unlikely(PageSwapCache(page)))
2139                 return __page_file_index(page);
2140         return page->index;
2141 }
2142
2143 /*
2144  * Return true only if the page has been allocated with
2145  * ALLOC_NO_WATERMARKS and the low watermark was not
2146  * met implying that the system is under some pressure.
2147  */
2148 static inline bool page_is_pfmemalloc(const struct page *page)
2149 {
2150         /*
2151          * lru.next has bit 1 set if the page is allocated from the
2152          * pfmemalloc reserves.  Callers may simply overwrite it if
2153          * they do not need to preserve that information.
2154          */
2155         return (uintptr_t)page->lru.next & BIT(1);
2156 }
2157
2158 /*
2159  * Return true only if the folio has been allocated with
2160  * ALLOC_NO_WATERMARKS and the low watermark was not
2161  * met implying that the system is under some pressure.
2162  */
2163 static inline bool folio_is_pfmemalloc(const struct folio *folio)
2164 {
2165         /*
2166          * lru.next has bit 1 set if the page is allocated from the
2167          * pfmemalloc reserves.  Callers may simply overwrite it if
2168          * they do not need to preserve that information.
2169          */
2170         return (uintptr_t)folio->lru.next & BIT(1);
2171 }
2172
2173 /*
2174  * Only to be called by the page allocator on a freshly allocated
2175  * page.
2176  */
2177 static inline void set_page_pfmemalloc(struct page *page)
2178 {
2179         page->lru.next = (void *)BIT(1);
2180 }
2181
2182 static inline void clear_page_pfmemalloc(struct page *page)
2183 {
2184         page->lru.next = NULL;
2185 }
2186
2187 /*
2188  * Can be called by the pagefault handler when it gets a VM_FAULT_OOM.
2189  */
2190 extern void pagefault_out_of_memory(void);
2191
2192 #define offset_in_page(p)       ((unsigned long)(p) & ~PAGE_MASK)
2193 #define offset_in_thp(page, p)  ((unsigned long)(p) & (thp_size(page) - 1))
2194 #define offset_in_folio(folio, p) ((unsigned long)(p) & (folio_size(folio) - 1))
2195
2196 /*
2197  * Flags passed to show_mem() and show_free_areas() to suppress output in
2198  * various contexts.
2199  */
2200 #define SHOW_MEM_FILTER_NODES           (0x0001u)       /* disallowed nodes */
2201
2202 extern void __show_free_areas(unsigned int flags, nodemask_t *nodemask, int max_zone_idx);
2203 static void __maybe_unused show_free_areas(unsigned int flags, nodemask_t *nodemask)
2204 {
2205         __show_free_areas(flags, nodemask, MAX_NR_ZONES - 1);
2206 }
2207
2208 /*
2209  * Parameter block passed down to zap_pte_range in exceptional cases.
2210  */
2211 struct zap_details {
2212         struct folio *single_folio;     /* Locked folio to be unmapped */
2213         bool even_cows;                 /* Zap COWed private pages too? */
2214         zap_flags_t zap_flags;          /* Extra flags for zapping */
2215 };
2216
2217 /*
2218  * Whether to drop the pte markers, for example, the uffd-wp information for
2219  * file-backed memory.  This should only be specified when we will completely
2220  * drop the page in the mm, either by truncation or unmapping of the vma.  By
2221  * default, the flag is not set.
2222  */
2223 #define  ZAP_FLAG_DROP_MARKER        ((__force zap_flags_t) BIT(0))
2224 /* Set in unmap_vmas() to indicate a final unmap call.  Only used by hugetlb */
2225 #define  ZAP_FLAG_UNMAP              ((__force zap_flags_t) BIT(1))
2226
2227 #ifdef CONFIG_SCHED_MM_CID
2228 void sched_mm_cid_before_execve(struct task_struct *t);
2229 void sched_mm_cid_after_execve(struct task_struct *t);
2230 void sched_mm_cid_fork(struct task_struct *t);
2231 void sched_mm_cid_exit_signals(struct task_struct *t);
2232 static inline int task_mm_cid(struct task_struct *t)
2233 {
2234         return t->mm_cid;
2235 }
2236 #else
2237 static inline void sched_mm_cid_before_execve(struct task_struct *t) { }
2238 static inline void sched_mm_cid_after_execve(struct task_struct *t) { }
2239 static inline void sched_mm_cid_fork(struct task_struct *t) { }
2240 static inline void sched_mm_cid_exit_signals(struct task_struct *t) { }
2241 static inline int task_mm_cid(struct task_struct *t)
2242 {
2243         /*
2244          * Use the processor id as a fall-back when the mm cid feature is
2245          * disabled. This provides functional per-cpu data structure accesses
2246          * in user-space, althrough it won't provide the memory usage benefits.
2247          */
2248         return raw_smp_processor_id();
2249 }
2250 #endif
2251
2252 #ifdef CONFIG_MMU
2253 extern bool can_do_mlock(void);
2254 #else
2255 static inline bool can_do_mlock(void) { return false; }
2256 #endif
2257 extern int user_shm_lock(size_t, struct ucounts *);
2258 extern void user_shm_unlock(size_t, struct ucounts *);
2259
2260 struct folio *vm_normal_folio(struct vm_area_struct *vma, unsigned long addr,
2261                              pte_t pte);
2262 struct page *vm_normal_page(struct vm_area_struct *vma, unsigned long addr,
2263                              pte_t pte);
2264 struct page *vm_normal_page_pmd(struct vm_area_struct *vma, unsigned long addr,
2265                                 pmd_t pmd);
2266
2267 void zap_vma_ptes(struct vm_area_struct *vma, unsigned long address,
2268                   unsigned long size);
2269 void zap_page_range_single(struct vm_area_struct *vma, unsigned long address,
2270                            unsigned long size, struct zap_details *details);
2271 static inline void zap_vma_pages(struct vm_area_struct *vma)
2272 {
2273         zap_page_range_single(vma, vma->vm_start,
2274                               vma->vm_end - vma->vm_start, NULL);
2275 }
2276 void unmap_vmas(struct mmu_gather *tlb, struct maple_tree *mt,
2277                 struct vm_area_struct *start_vma, unsigned long start,
2278                 unsigned long end, bool mm_wr_locked);
2279
2280 struct mmu_notifier_range;
2281
2282 void free_pgd_range(struct mmu_gather *tlb, unsigned long addr,
2283                 unsigned long end, unsigned long floor, unsigned long ceiling);
2284 int
2285 copy_page_range(struct vm_area_struct *dst_vma, struct vm_area_struct *src_vma);
2286 int follow_pte(struct mm_struct *mm, unsigned long address,
2287                pte_t **ptepp, spinlock_t **ptlp);
2288 int follow_pfn(struct vm_area_struct *vma, unsigned long address,
2289         unsigned long *pfn);
2290 int follow_phys(struct vm_area_struct *vma, unsigned long address,
2291                 unsigned int flags, unsigned long *prot, resource_size_t *phys);
2292 int generic_access_phys(struct vm_area_struct *vma, unsigned long addr,
2293                         void *buf, int len, int write);
2294
2295 extern void truncate_pagecache(struct inode *inode, loff_t new);
2296 extern void truncate_setsize(struct inode *inode, loff_t newsize);
2297 void pagecache_isize_extended(struct inode *inode, loff_t from, loff_t to);
2298 void truncate_pagecache_range(struct inode *inode, loff_t offset, loff_t end);
2299 int generic_error_remove_page(struct address_space *mapping, struct page *page);
2300
2301 #ifdef CONFIG_MMU
2302 extern vm_fault_t handle_mm_fault(struct vm_area_struct *vma,
2303                                   unsigned long address, unsigned int flags,
2304                                   struct pt_regs *regs);
2305 extern int fixup_user_fault(struct mm_struct *mm,
2306                             unsigned long address, unsigned int fault_flags,
2307                             bool *unlocked);
2308 void unmap_mapping_pages(struct address_space *mapping,
2309                 pgoff_t start, pgoff_t nr, bool even_cows);
2310 void unmap_mapping_range(struct address_space *mapping,
2311                 loff_t const holebegin, loff_t const holelen, int even_cows);
2312 #else
2313 static inline vm_fault_t handle_mm_fault(struct vm_area_struct *vma,
2314                                          unsigned long address, unsigned int flags,
2315                                          struct pt_regs *regs)
2316 {
2317         /* should never happen if there's no MMU */
2318         BUG();
2319         return VM_FAULT_SIGBUS;
2320 }
2321 static inline int fixup_user_fault(struct mm_struct *mm, unsigned long address,
2322                 unsigned int fault_flags, bool *unlocked)
2323 {
2324         /* should never happen if there's no MMU */
2325         BUG();
2326         return -EFAULT;
2327 }
2328 static inline void unmap_mapping_pages(struct address_space *mapping,
2329                 pgoff_t start, pgoff_t nr, bool even_cows) { }
2330 static inline void unmap_mapping_range(struct address_space *mapping,
2331                 loff_t const holebegin, loff_t const holelen, int even_cows) { }
2332 #endif
2333
2334 static inline void unmap_shared_mapping_range(struct address_space *mapping,
2335                 loff_t const holebegin, loff_t const holelen)
2336 {
2337         unmap_mapping_range(mapping, holebegin, holelen, 0);
2338 }
2339
2340 extern int access_process_vm(struct task_struct *tsk, unsigned long addr,
2341                 void *buf, int len, unsigned int gup_flags);
2342 extern int access_remote_vm(struct mm_struct *mm, unsigned long addr,
2343                 void *buf, int len, unsigned int gup_flags);
2344 extern int __access_remote_vm(struct mm_struct *mm, unsigned long addr,
2345                               void *buf, int len, unsigned int gup_flags);
2346
2347 long get_user_pages_remote(struct mm_struct *mm,
2348                             unsigned long start, unsigned long nr_pages,
2349                             unsigned int gup_flags, struct page **pages,
2350                             struct vm_area_struct **vmas, int *locked);
2351 long pin_user_pages_remote(struct mm_struct *mm,
2352                            unsigned long start, unsigned long nr_pages,
2353                            unsigned int gup_flags, struct page **pages,
2354                            struct vm_area_struct **vmas, int *locked);
2355 long get_user_pages(unsigned long start, unsigned long nr_pages,
2356                             unsigned int gup_flags, struct page **pages,
2357                             struct vm_area_struct **vmas);
2358 long pin_user_pages(unsigned long start, unsigned long nr_pages,
2359                     unsigned int gup_flags, struct page **pages,
2360                     struct vm_area_struct **vmas);
2361 long get_user_pages_unlocked(unsigned long start, unsigned long nr_pages,
2362                     struct page **pages, unsigned int gup_flags);
2363 long pin_user_pages_unlocked(unsigned long start, unsigned long nr_pages,
2364                     struct page **pages, unsigned int gup_flags);
2365
2366 int get_user_pages_fast(unsigned long start, int nr_pages,
2367                         unsigned int gup_flags, struct page **pages);
2368 int pin_user_pages_fast(unsigned long start, int nr_pages,
2369                         unsigned int gup_flags, struct page **pages);
2370
2371 int account_locked_vm(struct mm_struct *mm, unsigned long pages, bool inc);
2372 int __account_locked_vm(struct mm_struct *mm, unsigned long pages, bool inc,
2373                         struct task_struct *task, bool bypass_rlim);
2374
2375 struct kvec;
2376 struct page *get_dump_page(unsigned long addr);
2377
2378 bool folio_mark_dirty(struct folio *folio);
2379 bool set_page_dirty(struct page *page);
2380 int set_page_dirty_lock(struct page *page);
2381
2382 int get_cmdline(struct task_struct *task, char *buffer, int buflen);
2383
2384 extern unsigned long move_page_tables(struct vm_area_struct *vma,
2385                 unsigned long old_addr, struct vm_area_struct *new_vma,
2386                 unsigned long new_addr, unsigned long len,
2387                 bool need_rmap_locks);
2388
2389 /*
2390  * Flags used by change_protection().  For now we make it a bitmap so
2391  * that we can pass in multiple flags just like parameters.  However
2392  * for now all the callers are only use one of the flags at the same
2393  * time.
2394  */
2395 /*
2396  * Whether we should manually check if we can map individual PTEs writable,
2397  * because something (e.g., COW, uffd-wp) blocks that from happening for all
2398  * PTEs automatically in a writable mapping.
2399  */
2400 #define  MM_CP_TRY_CHANGE_WRITABLE         (1UL << 0)
2401 /* Whether this protection change is for NUMA hints */
2402 #define  MM_CP_PROT_NUMA                   (1UL << 1)
2403 /* Whether this change is for write protecting */
2404 #define  MM_CP_UFFD_WP                     (1UL << 2) /* do wp */
2405 #define  MM_CP_UFFD_WP_RESOLVE             (1UL << 3) /* Resolve wp */
2406 #define  MM_CP_UFFD_WP_ALL                 (MM_CP_UFFD_WP | \
2407                                             MM_CP_UFFD_WP_RESOLVE)
2408
2409 int vma_wants_writenotify(struct vm_area_struct *vma, pgprot_t vm_page_prot);
2410 static inline bool vma_wants_manual_pte_write_upgrade(struct vm_area_struct *vma)
2411 {
2412         /*
2413          * We want to check manually if we can change individual PTEs writable
2414          * if we can't do that automatically for all PTEs in a mapping. For
2415          * private mappings, that's always the case when we have write
2416          * permissions as we properly have to handle COW.
2417          */
2418         if (vma->vm_flags & VM_SHARED)
2419                 return vma_wants_writenotify(vma, vma->vm_page_prot);
2420         return !!(vma->vm_flags & VM_WRITE);
2421
2422 }
2423 bool can_change_pte_writable(struct vm_area_struct *vma, unsigned long addr,
2424                              pte_t pte);
2425 extern long change_protection(struct mmu_gather *tlb,
2426                               struct vm_area_struct *vma, unsigned long start,
2427                               unsigned long end, unsigned long cp_flags);
2428 extern int mprotect_fixup(struct vma_iterator *vmi, struct mmu_gather *tlb,
2429           struct vm_area_struct *vma, struct vm_area_struct **pprev,
2430           unsigned long start, unsigned long end, unsigned long newflags);
2431
2432 /*
2433  * doesn't attempt to fault and will return short.
2434  */
2435 int get_user_pages_fast_only(unsigned long start, int nr_pages,
2436                              unsigned int gup_flags, struct page **pages);
2437
2438 static inline bool get_user_page_fast_only(unsigned long addr,
2439                         unsigned int gup_flags, struct page **pagep)
2440 {
2441         return get_user_pages_fast_only(addr, 1, gup_flags, pagep) == 1;
2442 }
2443 /*
2444  * per-process(per-mm_struct) statistics.
2445  */
2446 static inline unsigned long get_mm_counter(struct mm_struct *mm, int member)
2447 {
2448         return percpu_counter_read_positive(&mm->rss_stat[member]);
2449 }
2450
2451 void mm_trace_rss_stat(struct mm_struct *mm, int member);
2452
2453 static inline void add_mm_counter(struct mm_struct *mm, int member, long value)
2454 {
2455         percpu_counter_add(&mm->rss_stat[member], value);
2456
2457         mm_trace_rss_stat(mm, member);
2458 }
2459
2460 static inline void inc_mm_counter(struct mm_struct *mm, int member)
2461 {
2462         percpu_counter_inc(&mm->rss_stat[member]);
2463
2464         mm_trace_rss_stat(mm, member);
2465 }
2466
2467 static inline void dec_mm_counter(struct mm_struct *mm, int member)
2468 {
2469         percpu_counter_dec(&mm->rss_stat[member]);
2470
2471         mm_trace_rss_stat(mm, member);
2472 }
2473
2474 /* Optimized variant when page is already known not to be PageAnon */
2475 static inline int mm_counter_file(struct page *page)
2476 {
2477         if (PageSwapBacked(page))
2478                 return MM_SHMEMPAGES;
2479         return MM_FILEPAGES;
2480 }
2481
2482 static inline int mm_counter(struct page *page)
2483 {
2484         if (PageAnon(page))
2485                 return MM_ANONPAGES;
2486         return mm_counter_file(page);
2487 }
2488
2489 static inline unsigned long get_mm_rss(struct mm_struct *mm)
2490 {
2491         return get_mm_counter(mm, MM_FILEPAGES) +
2492                 get_mm_counter(mm, MM_ANONPAGES) +
2493                 get_mm_counter(mm, MM_SHMEMPAGES);
2494 }
2495
2496 static inline unsigned long get_mm_hiwater_rss(struct mm_struct *mm)
2497 {
2498         return max(mm->hiwater_rss, get_mm_rss(mm));
2499 }
2500
2501 static inline unsigned long get_mm_hiwater_vm(struct mm_struct *mm)
2502 {
2503         return max(mm->hiwater_vm, mm->total_vm);
2504 }
2505
2506 static inline void update_hiwater_rss(struct mm_struct *mm)
2507 {
2508         unsigned long _rss = get_mm_rss(mm);
2509
2510         if ((mm)->hiwater_rss < _rss)
2511                 (mm)->hiwater_rss = _rss;
2512 }
2513
2514 static inline void update_hiwater_vm(struct mm_struct *mm)
2515 {
2516         if (mm->hiwater_vm < mm->total_vm)
2517                 mm->hiwater_vm = mm->total_vm;
2518 }
2519
2520 static inline void reset_mm_hiwater_rss(struct mm_struct *mm)
2521 {
2522         mm->hiwater_rss = get_mm_rss(mm);
2523 }
2524
2525 static inline void setmax_mm_hiwater_rss(unsigned long *maxrss,
2526                                          struct mm_struct *mm)
2527 {
2528         unsigned long hiwater_rss = get_mm_hiwater_rss(mm);
2529
2530         if (*maxrss < hiwater_rss)
2531                 *maxrss = hiwater_rss;
2532 }
2533
2534 #if defined(SPLIT_RSS_COUNTING)
2535 void sync_mm_rss(struct mm_struct *mm);
2536 #else
2537 static inline void sync_mm_rss(struct mm_struct *mm)
2538 {
2539 }
2540 #endif
2541
2542 #ifndef CONFIG_ARCH_HAS_PTE_SPECIAL
2543 static inline int pte_special(pte_t pte)
2544 {
2545         return 0;
2546 }
2547
2548 static inline pte_t pte_mkspecial(pte_t pte)
2549 {
2550         return pte;
2551 }
2552 #endif
2553
2554 #ifndef CONFIG_ARCH_HAS_PTE_DEVMAP
2555 static inline int pte_devmap(pte_t pte)
2556 {
2557         return 0;
2558 }
2559 #endif
2560
2561 extern pte_t *__get_locked_pte(struct mm_struct *mm, unsigned long addr,
2562                                spinlock_t **ptl);
2563 static inline pte_t *get_locked_pte(struct mm_struct *mm, unsigned long addr,
2564                                     spinlock_t **ptl)
2565 {
2566         pte_t *ptep;
2567         __cond_lock(*ptl, ptep = __get_locked_pte(mm, addr, ptl));
2568         return ptep;
2569 }
2570
2571 #ifdef __PAGETABLE_P4D_FOLDED
2572 static inline int __p4d_alloc(struct mm_struct *mm, pgd_t *pgd,
2573                                                 unsigned long address)
2574 {
2575         return 0;
2576 }
2577 #else
2578 int __p4d_alloc(struct mm_struct *mm, pgd_t *pgd, unsigned long address);
2579 #endif
2580
2581 #if defined(__PAGETABLE_PUD_FOLDED) || !defined(CONFIG_MMU)
2582 static inline int __pud_alloc(struct mm_struct *mm, p4d_t *p4d,
2583                                                 unsigned long address)
2584 {
2585         return 0;
2586 }
2587 static inline void mm_inc_nr_puds(struct mm_struct *mm) {}
2588 static inline void mm_dec_nr_puds(struct mm_struct *mm) {}
2589
2590 #else
2591 int __pud_alloc(struct mm_struct *mm, p4d_t *p4d, unsigned long address);
2592
2593 static inline void mm_inc_nr_puds(struct mm_struct *mm)
2594 {
2595         if (mm_pud_folded(mm))
2596                 return;
2597         atomic_long_add(PTRS_PER_PUD * sizeof(pud_t), &mm->pgtables_bytes);
2598 }
2599
2600 static inline void mm_dec_nr_puds(struct mm_struct *mm)
2601 {
2602         if (mm_pud_folded(mm))
2603                 return;
2604         atomic_long_sub(PTRS_PER_PUD * sizeof(pud_t), &mm->pgtables_bytes);
2605 }
2606 #endif
2607
2608 #if defined(__PAGETABLE_PMD_FOLDED) || !defined(CONFIG_MMU)
2609 static inline int __pmd_alloc(struct mm_struct *mm, pud_t *pud,
2610                                                 unsigned long address)
2611 {
2612         return 0;
2613 }
2614
2615 static inline void mm_inc_nr_pmds(struct mm_struct *mm) {}
2616 static inline void mm_dec_nr_pmds(struct mm_struct *mm) {}
2617
2618 #else
2619 int __pmd_alloc(struct mm_struct *mm, pud_t *pud, unsigned long address);
2620
2621 static inline void mm_inc_nr_pmds(struct mm_struct *mm)
2622 {
2623         if (mm_pmd_folded(mm))
2624                 return;
2625         atomic_long_add(PTRS_PER_PMD * sizeof(pmd_t), &mm->pgtables_bytes);
2626 }
2627
2628 static inline void mm_dec_nr_pmds(struct mm_struct *mm)
2629 {
2630         if (mm_pmd_folded(mm))
2631                 return;
2632         atomic_long_sub(PTRS_PER_PMD * sizeof(pmd_t), &mm->pgtables_bytes);
2633 }
2634 #endif
2635
2636 #ifdef CONFIG_MMU
2637 static inline void mm_pgtables_bytes_init(struct mm_struct *mm)
2638 {
2639         atomic_long_set(&mm->pgtables_bytes, 0);
2640 }
2641
2642 static inline unsigned long mm_pgtables_bytes(const struct mm_struct *mm)
2643 {
2644         return atomic_long_read(&mm->pgtables_bytes);
2645 }
2646
2647 static inline void mm_inc_nr_ptes(struct mm_struct *mm)
2648 {
2649         atomic_long_add(PTRS_PER_PTE * sizeof(pte_t), &mm->pgtables_bytes);
2650 }
2651
2652 static inline void mm_dec_nr_ptes(struct mm_struct *mm)
2653 {
2654         atomic_long_sub(PTRS_PER_PTE * sizeof(pte_t), &mm->pgtables_bytes);
2655 }
2656 #else
2657
2658 static inline void mm_pgtables_bytes_init(struct mm_struct *mm) {}
2659 static inline unsigned long mm_pgtables_bytes(const struct mm_struct *mm)
2660 {
2661         return 0;
2662 }
2663
2664 static inline void mm_inc_nr_ptes(struct mm_struct *mm) {}
2665 static inline void mm_dec_nr_ptes(struct mm_struct *mm) {}
2666 #endif
2667
2668 int __pte_alloc(struct mm_struct *mm, pmd_t *pmd);
2669 int __pte_alloc_kernel(pmd_t *pmd);
2670
2671 #if defined(CONFIG_MMU)
2672
2673 static inline p4d_t *p4d_alloc(struct mm_struct *mm, pgd_t *pgd,
2674                 unsigned long address)
2675 {
2676         return (unlikely(pgd_none(*pgd)) && __p4d_alloc(mm, pgd, address)) ?
2677                 NULL : p4d_offset(pgd, address);
2678 }
2679
2680 static inline pud_t *pud_alloc(struct mm_struct *mm, p4d_t *p4d,
2681                 unsigned long address)
2682 {
2683         return (unlikely(p4d_none(*p4d)) && __pud_alloc(mm, p4d, address)) ?
2684                 NULL : pud_offset(p4d, address);
2685 }
2686
2687 static inline pmd_t *pmd_alloc(struct mm_struct *mm, pud_t *pud, unsigned long address)
2688 {
2689         return (unlikely(pud_none(*pud)) && __pmd_alloc(mm, pud, address))?
2690                 NULL: pmd_offset(pud, address);
2691 }
2692 #endif /* CONFIG_MMU */
2693
2694 #if USE_SPLIT_PTE_PTLOCKS
2695 #if ALLOC_SPLIT_PTLOCKS
2696 void __init ptlock_cache_init(void);
2697 extern bool ptlock_alloc(struct page *page);
2698 extern void ptlock_free(struct page *page);
2699
2700 static inline spinlock_t *ptlock_ptr(struct page *page)
2701 {
2702         return page->ptl;
2703 }
2704 #else /* ALLOC_SPLIT_PTLOCKS */
2705 static inline void ptlock_cache_init(void)
2706 {
2707 }
2708
2709 static inline bool ptlock_alloc(struct page *page)
2710 {
2711         return true;
2712 }
2713
2714 static inline void ptlock_free(struct page *page)
2715 {
2716 }
2717
2718 static inline spinlock_t *ptlock_ptr(struct page *page)
2719 {
2720         return &page->ptl;
2721 }
2722 #endif /* ALLOC_SPLIT_PTLOCKS */
2723
2724 static inline spinlock_t *pte_lockptr(struct mm_struct *mm, pmd_t *pmd)
2725 {
2726         return ptlock_ptr(pmd_page(*pmd));
2727 }
2728
2729 static inline bool ptlock_init(struct page *page)
2730 {
2731         /*
2732          * prep_new_page() initialize page->private (and therefore page->ptl)
2733          * with 0. Make sure nobody took it in use in between.
2734          *
2735          * It can happen if arch try to use slab for page table allocation:
2736          * slab code uses page->slab_cache, which share storage with page->ptl.
2737          */
2738         VM_BUG_ON_PAGE(*(unsigned long *)&page->ptl, page);
2739         if (!ptlock_alloc(page))
2740                 return false;
2741         spin_lock_init(ptlock_ptr(page));
2742         return true;
2743 }
2744
2745 #else   /* !USE_SPLIT_PTE_PTLOCKS */
2746 /*
2747  * We use mm->page_table_lock to guard all pagetable pages of the mm.
2748  */
2749 static inline spinlock_t *pte_lockptr(struct mm_struct *mm, pmd_t *pmd)
2750 {
2751         return &mm->page_table_lock;
2752 }
2753 static inline void ptlock_cache_init(void) {}
2754 static inline bool ptlock_init(struct page *page) { return true; }
2755 static inline void ptlock_free(struct page *page) {}
2756 #endif /* USE_SPLIT_PTE_PTLOCKS */
2757
2758 static inline bool pgtable_pte_page_ctor(struct page *page)
2759 {
2760         if (!ptlock_init(page))
2761                 return false;
2762         __SetPageTable(page);
2763         inc_lruvec_page_state(page, NR_PAGETABLE);
2764         return true;
2765 }
2766
2767 static inline void pgtable_pte_page_dtor(struct page *page)
2768 {
2769         ptlock_free(page);
2770         __ClearPageTable(page);
2771         dec_lruvec_page_state(page, NR_PAGETABLE);
2772 }
2773
2774 #define pte_offset_map_lock(mm, pmd, address, ptlp)     \
2775 ({                                                      \
2776         spinlock_t *__ptl = pte_lockptr(mm, pmd);       \
2777         pte_t *__pte = pte_offset_map(pmd, address);    \
2778         *(ptlp) = __ptl;                                \
2779         spin_lock(__ptl);                               \
2780         __pte;                                          \
2781 })
2782
2783 #define pte_unmap_unlock(pte, ptl)      do {            \
2784         spin_unlock(ptl);                               \
2785         pte_unmap(pte);                                 \
2786 } while (0)
2787
2788 #define pte_alloc(mm, pmd) (unlikely(pmd_none(*(pmd))) && __pte_alloc(mm, pmd))
2789
2790 #define pte_alloc_map(mm, pmd, address)                 \
2791         (pte_alloc(mm, pmd) ? NULL : pte_offset_map(pmd, address))
2792
2793 #define pte_alloc_map_lock(mm, pmd, address, ptlp)      \
2794         (pte_alloc(mm, pmd) ?                   \
2795                  NULL : pte_offset_map_lock(mm, pmd, address, ptlp))
2796
2797 #define pte_alloc_kernel(pmd, address)                  \
2798         ((unlikely(pmd_none(*(pmd))) && __pte_alloc_kernel(pmd))? \
2799                 NULL: pte_offset_kernel(pmd, address))
2800
2801 #if USE_SPLIT_PMD_PTLOCKS
2802
2803 static inline struct page *pmd_pgtable_page(pmd_t *pmd)
2804 {
2805         unsigned long mask = ~(PTRS_PER_PMD * sizeof(pmd_t) - 1);
2806         return virt_to_page((void *)((unsigned long) pmd & mask));
2807 }
2808
2809 static inline spinlock_t *pmd_lockptr(struct mm_struct *mm, pmd_t *pmd)
2810 {
2811         return ptlock_ptr(pmd_pgtable_page(pmd));
2812 }
2813
2814 static inline bool pmd_ptlock_init(struct page *page)
2815 {
2816 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
2817         page->pmd_huge_pte = NULL;
2818 #endif
2819         return ptlock_init(page);
2820 }
2821
2822 static inline void pmd_ptlock_free(struct page *page)
2823 {
2824 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
2825         VM_BUG_ON_PAGE(page->pmd_huge_pte, page);
2826 #endif
2827         ptlock_free(page);
2828 }
2829
2830 #define pmd_huge_pte(mm, pmd) (pmd_pgtable_page(pmd)->pmd_huge_pte)
2831
2832 #else
2833
2834 static inline spinlock_t *pmd_lockptr(struct mm_struct *mm, pmd_t *pmd)
2835 {
2836         return &mm->page_table_lock;
2837 }
2838
2839 static inline bool pmd_ptlock_init(struct page *page) { return true; }
2840 static inline void pmd_ptlock_free(struct page *page) {}
2841
2842 #define pmd_huge_pte(mm, pmd) ((mm)->pmd_huge_pte)
2843
2844 #endif
2845
2846 static inline spinlock_t *pmd_lock(struct mm_struct *mm, pmd_t *pmd)
2847 {
2848         spinlock_t *ptl = pmd_lockptr(mm, pmd);
2849         spin_lock(ptl);
2850         return ptl;
2851 }
2852
2853 static inline bool pgtable_pmd_page_ctor(struct page *page)
2854 {
2855         if (!pmd_ptlock_init(page))
2856                 return false;
2857         __SetPageTable(page);
2858         inc_lruvec_page_state(page, NR_PAGETABLE);
2859         return true;
2860 }
2861
2862 static inline void pgtable_pmd_page_dtor(struct page *page)
2863 {
2864         pmd_ptlock_free(page);
2865         __ClearPageTable(page);
2866         dec_lruvec_page_state(page, NR_PAGETABLE);
2867 }
2868
2869 /*
2870  * No scalability reason to split PUD locks yet, but follow the same pattern
2871  * as the PMD locks to make it easier if we decide to.  The VM should not be
2872  * considered ready to switch to split PUD locks yet; there may be places
2873  * which need to be converted from page_table_lock.
2874  */
2875 static inline spinlock_t *pud_lockptr(struct mm_struct *mm, pud_t *pud)
2876 {
2877         return &mm->page_table_lock;
2878 }
2879
2880 static inline spinlock_t *pud_lock(struct mm_struct *mm, pud_t *pud)
2881 {
2882         spinlock_t *ptl = pud_lockptr(mm, pud);
2883
2884         spin_lock(ptl);
2885         return ptl;
2886 }
2887
2888 extern void __init pagecache_init(void);
2889 extern void free_initmem(void);
2890
2891 /*
2892  * Free reserved pages within range [PAGE_ALIGN(start), end & PAGE_MASK)
2893  * into the buddy system. The freed pages will be poisoned with pattern
2894  * "poison" if it's within range [0, UCHAR_MAX].
2895  * Return pages freed into the buddy system.
2896  */
2897 extern unsigned long free_reserved_area(void *start, void *end,
2898                                         int poison, const char *s);
2899
2900 extern void adjust_managed_page_count(struct page *page, long count);
2901
2902 extern void reserve_bootmem_region(phys_addr_t start, phys_addr_t end);
2903
2904 /* Free the reserved page into the buddy system, so it gets managed. */
2905 static inline void free_reserved_page(struct page *page)
2906 {
2907         ClearPageReserved(page);
2908         init_page_count(page);
2909         __free_page(page);
2910         adjust_managed_page_count(page, 1);
2911 }
2912 #define free_highmem_page(page) free_reserved_page(page)
2913
2914 static inline void mark_page_reserved(struct page *page)
2915 {
2916         SetPageReserved(page);
2917         adjust_managed_page_count(page, -1);
2918 }
2919
2920 /*
2921  * Default method to free all the __init memory into the buddy system.
2922  * The freed pages will be poisoned with pattern "poison" if it's within
2923  * range [0, UCHAR_MAX].
2924  * Return pages freed into the buddy system.
2925  */
2926 static inline unsigned long free_initmem_default(int poison)
2927 {
2928         extern char __init_begin[], __init_end[];
2929
2930         return free_reserved_area(&__init_begin, &__init_end,
2931                                   poison, "unused kernel image (initmem)");
2932 }
2933
2934 static inline unsigned long get_num_physpages(void)
2935 {
2936         int nid;
2937         unsigned long phys_pages = 0;
2938
2939         for_each_online_node(nid)
2940                 phys_pages += node_present_pages(nid);
2941
2942         return phys_pages;
2943 }
2944
2945 /*
2946  * Using memblock node mappings, an architecture may initialise its
2947  * zones, allocate the backing mem_map and account for memory holes in an
2948  * architecture independent manner.
2949  *
2950  * An architecture is expected to register range of page frames backed by
2951  * physical memory with memblock_add[_node]() before calling
2952  * free_area_init() passing in the PFN each zone ends at. At a basic
2953  * usage, an architecture is expected to do something like
2954  *
2955  * unsigned long max_zone_pfns[MAX_NR_ZONES] = {max_dma, max_normal_pfn,
2956  *                                                       max_highmem_pfn};
2957  * for_each_valid_physical_page_range()
2958  *      memblock_add_node(base, size, nid, MEMBLOCK_NONE)
2959  * free_area_init(max_zone_pfns);
2960  */
2961 void free_area_init(unsigned long *max_zone_pfn);
2962 unsigned long node_map_pfn_alignment(void);
2963 unsigned long __absent_pages_in_range(int nid, unsigned long start_pfn,
2964                                                 unsigned long end_pfn);
2965 extern unsigned long absent_pages_in_range(unsigned long start_pfn,
2966                                                 unsigned long end_pfn);
2967 extern void get_pfn_range_for_nid(unsigned int nid,
2968                         unsigned long *start_pfn, unsigned long *end_pfn);
2969
2970 #ifndef CONFIG_NUMA
2971 static inline int early_pfn_to_nid(unsigned long pfn)
2972 {
2973         return 0;
2974 }
2975 #else
2976 /* please see mm/page_alloc.c */
2977 extern int __meminit early_pfn_to_nid(unsigned long pfn);
2978 #endif
2979
2980 extern void set_dma_reserve(unsigned long new_dma_reserve);
2981 extern void memmap_init_range(unsigned long, int, unsigned long,
2982                 unsigned long, unsigned long, enum meminit_context,
2983                 struct vmem_altmap *, int migratetype);
2984 extern void setup_per_zone_wmarks(void);
2985 extern void calculate_min_free_kbytes(void);
2986 extern int __meminit init_per_zone_wmark_min(void);
2987 extern void mem_init(void);
2988 extern void __init mmap_init(void);
2989
2990 extern void __show_mem(unsigned int flags, nodemask_t *nodemask, int max_zone_idx);
2991 static inline void show_mem(unsigned int flags, nodemask_t *nodemask)
2992 {
2993         __show_mem(flags, nodemask, MAX_NR_ZONES - 1);
2994 }
2995 extern long si_mem_available(void);
2996 extern void si_meminfo(struct sysinfo * val);
2997 extern void si_meminfo_node(struct sysinfo *val, int nid);
2998 #ifdef __HAVE_ARCH_RESERVED_KERNEL_PAGES
2999 extern unsigned long arch_reserved_kernel_pages(void);
3000 #endif
3001
3002 extern __printf(3, 4)
3003 void warn_alloc(gfp_t gfp_mask, nodemask_t *nodemask, const char *fmt, ...);
3004
3005 extern void setup_per_cpu_pageset(void);
3006
3007 /* page_alloc.c */
3008 extern int min_free_kbytes;
3009 extern int watermark_boost_factor;
3010 extern int watermark_scale_factor;
3011 extern bool arch_has_descending_max_zone_pfns(void);
3012
3013 /* nommu.c */
3014 extern atomic_long_t mmap_pages_allocated;
3015 extern int nommu_shrink_inode_mappings(struct inode *, size_t, size_t);
3016
3017 /* interval_tree.c */
3018 void vma_interval_tree_insert(struct vm_area_struct *node,
3019                               struct rb_root_cached *root);
3020 void vma_interval_tree_insert_after(struct vm_area_struct *node,
3021                                     struct vm_area_struct *prev,
3022                                     struct rb_root_cached *root);
3023 void vma_interval_tree_remove(struct vm_area_struct *node,
3024                               struct rb_root_cached *root);
3025 struct vm_area_struct *vma_interval_tree_iter_first(struct rb_root_cached *root,
3026                                 unsigned long start, unsigned long last);
3027 struct vm_area_struct *vma_interval_tree_iter_next(struct vm_area_struct *node,
3028                                 unsigned long start, unsigned long last);
3029
3030 #define vma_interval_tree_foreach(vma, root, start, last)               \
3031         for (vma = vma_interval_tree_iter_first(root, start, last);     \
3032              vma; vma = vma_interval_tree_iter_next(vma, start, last))
3033
3034 void anon_vma_interval_tree_insert(struct anon_vma_chain *node,
3035                                    struct rb_root_cached *root);
3036 void anon_vma_interval_tree_remove(struct anon_vma_chain *node,
3037                                    struct rb_root_cached *root);
3038 struct anon_vma_chain *
3039 anon_vma_interval_tree_iter_first(struct rb_root_cached *root,
3040                                   unsigned long start, unsigned long last);
3041 struct anon_vma_chain *anon_vma_interval_tree_iter_next(
3042         struct anon_vma_chain *node, unsigned long start, unsigned long last);
3043 #ifdef CONFIG_DEBUG_VM_RB
3044 void anon_vma_interval_tree_verify(struct anon_vma_chain *node);
3045 #endif
3046
3047 #define anon_vma_interval_tree_foreach(avc, root, start, last)           \
3048         for (avc = anon_vma_interval_tree_iter_first(root, start, last); \
3049              avc; avc = anon_vma_interval_tree_iter_next(avc, start, last))
3050
3051 /* mmap.c */
3052 extern int __vm_enough_memory(struct mm_struct *mm, long pages, int cap_sys_admin);
3053 extern int vma_expand(struct vma_iterator *vmi, struct vm_area_struct *vma,
3054                       unsigned long start, unsigned long end, pgoff_t pgoff,
3055                       struct vm_area_struct *next);
3056 extern int vma_shrink(struct vma_iterator *vmi, struct vm_area_struct *vma,
3057                        unsigned long start, unsigned long end, pgoff_t pgoff);
3058 extern struct vm_area_struct *vma_merge(struct vma_iterator *vmi,
3059         struct mm_struct *, struct vm_area_struct *prev, unsigned long addr,
3060         unsigned long end, unsigned long vm_flags, struct anon_vma *,
3061         struct file *, pgoff_t, struct mempolicy *, struct vm_userfaultfd_ctx,
3062         struct anon_vma_name *);
3063 extern struct anon_vma *find_mergeable_anon_vma(struct vm_area_struct *);
3064 extern int __split_vma(struct vma_iterator *vmi, struct vm_area_struct *,
3065                        unsigned long addr, int new_below);
3066 extern int split_vma(struct vma_iterator *vmi, struct vm_area_struct *,
3067                          unsigned long addr, int new_below);
3068 extern int insert_vm_struct(struct mm_struct *, struct vm_area_struct *);
3069 extern void unlink_file_vma(struct vm_area_struct *);
3070 extern struct vm_area_struct *copy_vma(struct vm_area_struct **,
3071         unsigned long addr, unsigned long len, pgoff_t pgoff,
3072         bool *need_rmap_locks);
3073 extern void exit_mmap(struct mm_struct *);
3074
3075 static inline int check_data_rlimit(unsigned long rlim,
3076                                     unsigned long new,
3077                                     unsigned long start,
3078                                     unsigned long end_data,
3079                                     unsigned long start_data)
3080 {
3081         if (rlim < RLIM_INFINITY) {
3082                 if (((new - start) + (end_data - start_data)) > rlim)
3083                         return -ENOSPC;
3084         }
3085
3086         return 0;
3087 }
3088
3089 extern int mm_take_all_locks(struct mm_struct *mm);
3090 extern void mm_drop_all_locks(struct mm_struct *mm);
3091
3092 extern int set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
3093 extern int replace_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
3094 extern struct file *get_mm_exe_file(struct mm_struct *mm);
3095 extern struct file *get_task_exe_file(struct task_struct *task);
3096
3097 extern bool may_expand_vm(struct mm_struct *, vm_flags_t, unsigned long npages);
3098 extern void vm_stat_account(struct mm_struct *, vm_flags_t, long npages);
3099
3100 extern bool vma_is_special_mapping(const struct vm_area_struct *vma,
3101                                    const struct vm_special_mapping *sm);
3102 extern struct vm_area_struct *_install_special_mapping(struct mm_struct *mm,
3103                                    unsigned long addr, unsigned long len,
3104                                    unsigned long flags,
3105                                    const struct vm_special_mapping *spec);
3106 /* This is an obsolete alternative to _install_special_mapping. */
3107 extern int install_special_mapping(struct mm_struct *mm,
3108                                    unsigned long addr, unsigned long len,
3109                                    unsigned long flags, struct page **pages);
3110
3111 unsigned long randomize_stack_top(unsigned long stack_top);
3112 unsigned long randomize_page(unsigned long start, unsigned long range);
3113
3114 extern unsigned long get_unmapped_area(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
3115
3116 extern unsigned long mmap_region(struct file *file, unsigned long addr,
3117         unsigned long len, vm_flags_t vm_flags, unsigned long pgoff,
3118         struct list_head *uf);
3119 extern unsigned long do_mmap(struct file *file, unsigned long addr,
3120         unsigned long len, unsigned long prot, unsigned long flags,
3121         unsigned long pgoff, unsigned long *populate, struct list_head *uf);
3122 extern int do_vmi_munmap(struct vma_iterator *vmi, struct mm_struct *mm,
3123                          unsigned long start, size_t len, struct list_head *uf,
3124                          bool downgrade);
3125 extern int do_munmap(struct mm_struct *, unsigned long, size_t,
3126                      struct list_head *uf);
3127 extern int do_madvise(struct mm_struct *mm, unsigned long start, size_t len_in, int behavior);
3128
3129 #ifdef CONFIG_MMU
3130 extern int do_vma_munmap(struct vma_iterator *vmi, struct vm_area_struct *vma,
3131                          unsigned long start, unsigned long end,
3132                          struct list_head *uf, bool downgrade);
3133 extern int __mm_populate(unsigned long addr, unsigned long len,
3134                          int ignore_errors);
3135 static inline void mm_populate(unsigned long addr, unsigned long len)
3136 {
3137         /* Ignore errors */
3138         (void) __mm_populate(addr, len, 1);
3139 }
3140 #else
3141 static inline void mm_populate(unsigned long addr, unsigned long len) {}
3142 #endif
3143
3144 /* These take the mm semaphore themselves */
3145 extern int __must_check vm_brk(unsigned long, unsigned long);
3146 extern int __must_check vm_brk_flags(unsigned long, unsigned long, unsigned long);
3147 extern int vm_munmap(unsigned long, size_t);
3148 extern unsigned long __must_check vm_mmap(struct file *, unsigned long,
3149         unsigned long, unsigned long,
3150         unsigned long, unsigned long);
3151
3152 struct vm_unmapped_area_info {
3153 #define VM_UNMAPPED_AREA_TOPDOWN 1
3154         unsigned long flags;
3155         unsigned long length;
3156         unsigned long low_limit;
3157         unsigned long high_limit;
3158         unsigned long align_mask;
3159         unsigned long align_offset;
3160 };
3161
3162 extern unsigned long vm_unmapped_area(struct vm_unmapped_area_info *info);
3163
3164 /* truncate.c */
3165 extern void truncate_inode_pages(struct address_space *, loff_t);
3166 extern void truncate_inode_pages_range(struct address_space *,
3167                                        loff_t lstart, loff_t lend);
3168 extern void truncate_inode_pages_final(struct address_space *);
3169
3170 /* generic vm_area_ops exported for stackable file systems */
3171 extern vm_fault_t filemap_fault(struct vm_fault *vmf);
3172 extern vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3173                 pgoff_t start_pgoff, pgoff_t end_pgoff);
3174 extern vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf);
3175
3176 extern unsigned long stack_guard_gap;
3177 /* Generic expand stack which grows the stack according to GROWS{UP,DOWN} */
3178 extern int expand_stack(struct vm_area_struct *vma, unsigned long address);
3179
3180 /* CONFIG_STACK_GROWSUP still needs to grow downwards at some places */
3181 extern int expand_downwards(struct vm_area_struct *vma,
3182                 unsigned long address);
3183 #if VM_GROWSUP
3184 extern int expand_upwards(struct vm_area_struct *vma, unsigned long address);
3185 #else
3186   #define expand_upwards(vma, address) (0)
3187 #endif
3188
3189 /* Look up the first VMA which satisfies  addr < vm_end,  NULL if none. */
3190 extern struct vm_area_struct * find_vma(struct mm_struct * mm, unsigned long addr);
3191 extern struct vm_area_struct * find_vma_prev(struct mm_struct * mm, unsigned long addr,
3192                                              struct vm_area_struct **pprev);
3193
3194 /*
3195  * Look up the first VMA which intersects the interval [start_addr, end_addr)
3196  * NULL if none.  Assume start_addr < end_addr.
3197  */
3198 struct vm_area_struct *find_vma_intersection(struct mm_struct *mm,
3199                         unsigned long start_addr, unsigned long end_addr);
3200
3201 /**
3202  * vma_lookup() - Find a VMA at a specific address
3203  * @mm: The process address space.
3204  * @addr: The user address.
3205  *
3206  * Return: The vm_area_struct at the given address, %NULL otherwise.
3207  */
3208 static inline
3209 struct vm_area_struct *vma_lookup(struct mm_struct *mm, unsigned long addr)
3210 {
3211         return mtree_load(&mm->mm_mt, addr);
3212 }
3213
3214 static inline unsigned long vm_start_gap(struct vm_area_struct *vma)
3215 {
3216         unsigned long vm_start = vma->vm_start;
3217
3218         if (vma->vm_flags & VM_GROWSDOWN) {
3219                 vm_start -= stack_guard_gap;
3220                 if (vm_start > vma->vm_start)
3221                         vm_start = 0;
3222         }
3223         return vm_start;
3224 }
3225
3226 static inline unsigned long vm_end_gap(struct vm_area_struct *vma)
3227 {
3228         unsigned long vm_end = vma->vm_end;
3229
3230         if (vma->vm_flags & VM_GROWSUP) {
3231                 vm_end += stack_guard_gap;
3232                 if (vm_end < vma->vm_end)
3233                         vm_end = -PAGE_SIZE;
3234         }
3235         return vm_end;
3236 }
3237
3238 static inline unsigned long vma_pages(struct vm_area_struct *vma)
3239 {
3240         return (vma->vm_end - vma->vm_start) >> PAGE_SHIFT;
3241 }
3242
3243 /* Look up the first VMA which exactly match the interval vm_start ... vm_end */
3244 static inline struct vm_area_struct *find_exact_vma(struct mm_struct *mm,
3245                                 unsigned long vm_start, unsigned long vm_end)
3246 {
3247         struct vm_area_struct *vma = vma_lookup(mm, vm_start);
3248
3249         if (vma && (vma->vm_start != vm_start || vma->vm_end != vm_end))
3250                 vma = NULL;
3251
3252         return vma;
3253 }
3254
3255 static inline bool range_in_vma(struct vm_area_struct *vma,
3256                                 unsigned long start, unsigned long end)
3257 {
3258         return (vma && vma->vm_start <= start && end <= vma->vm_end);
3259 }
3260
3261 #ifdef CONFIG_MMU
3262 pgprot_t vm_get_page_prot(unsigned long vm_flags);
3263 void vma_set_page_prot(struct vm_area_struct *vma);
3264 #else
3265 static inline pgprot_t vm_get_page_prot(unsigned long vm_flags)
3266 {
3267         return __pgprot(0);
3268 }
3269 static inline void vma_set_page_prot(struct vm_area_struct *vma)
3270 {
3271         vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
3272 }
3273 #endif
3274
3275 void vma_set_file(struct vm_area_struct *vma, struct file *file);
3276
3277 #ifdef CONFIG_NUMA_BALANCING
3278 unsigned long change_prot_numa(struct vm_area_struct *vma,
3279                         unsigned long start, unsigned long end);
3280 #endif
3281
3282 struct vm_area_struct *find_extend_vma(struct mm_struct *, unsigned long addr);
3283 int remap_pfn_range(struct vm_area_struct *, unsigned long addr,
3284                         unsigned long pfn, unsigned long size, pgprot_t);
3285 int remap_pfn_range_notrack(struct vm_area_struct *vma, unsigned long addr,
3286                 unsigned long pfn, unsigned long size, pgprot_t prot);
3287 int vm_insert_page(struct vm_area_struct *, unsigned long addr, struct page *);
3288 int vm_insert_pages(struct vm_area_struct *vma, unsigned long addr,
3289                         struct page **pages, unsigned long *num);
3290 int vm_map_pages(struct vm_area_struct *vma, struct page **pages,
3291                                 unsigned long num);
3292 int vm_map_pages_zero(struct vm_area_struct *vma, struct page **pages,
3293                                 unsigned long num);
3294 vm_fault_t vmf_insert_pfn(struct vm_area_struct *vma, unsigned long addr,
3295                         unsigned long pfn);
3296 vm_fault_t vmf_insert_pfn_prot(struct vm_area_struct *vma, unsigned long addr,
3297                         unsigned long pfn, pgprot_t pgprot);
3298 vm_fault_t vmf_insert_mixed(struct vm_area_struct *vma, unsigned long addr,
3299                         pfn_t pfn);
3300 vm_fault_t vmf_insert_mixed_mkwrite(struct vm_area_struct *vma,
3301                 unsigned long addr, pfn_t pfn);
3302 int vm_iomap_memory(struct vm_area_struct *vma, phys_addr_t start, unsigned long len);
3303
3304 static inline vm_fault_t vmf_insert_page(struct vm_area_struct *vma,
3305                                 unsigned long addr, struct page *page)
3306 {
3307         int err = vm_insert_page(vma, addr, page);
3308
3309         if (err == -ENOMEM)
3310                 return VM_FAULT_OOM;
3311         if (err < 0 && err != -EBUSY)
3312                 return VM_FAULT_SIGBUS;
3313
3314         return VM_FAULT_NOPAGE;
3315 }
3316
3317 #ifndef io_remap_pfn_range
3318 static inline int io_remap_pfn_range(struct vm_area_struct *vma,
3319                                      unsigned long addr, unsigned long pfn,
3320                                      unsigned long size, pgprot_t prot)
3321 {
3322         return remap_pfn_range(vma, addr, pfn, size, pgprot_decrypted(prot));
3323 }
3324 #endif
3325
3326 static inline vm_fault_t vmf_error(int err)
3327 {
3328         if (err == -ENOMEM)
3329                 return VM_FAULT_OOM;
3330         return VM_FAULT_SIGBUS;
3331 }
3332
3333 struct page *follow_page(struct vm_area_struct *vma, unsigned long address,
3334                          unsigned int foll_flags);
3335
3336 static inline int vm_fault_to_errno(vm_fault_t vm_fault, int foll_flags)
3337 {
3338         if (vm_fault & VM_FAULT_OOM)
3339                 return -ENOMEM;
3340         if (vm_fault & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
3341                 return (foll_flags & FOLL_HWPOISON) ? -EHWPOISON : -EFAULT;
3342         if (vm_fault & (VM_FAULT_SIGBUS | VM_FAULT_SIGSEGV))
3343                 return -EFAULT;
3344         return 0;
3345 }
3346
3347 /*
3348  * Indicates whether GUP can follow a PROT_NONE mapped page, or whether
3349  * a (NUMA hinting) fault is required.
3350  */
3351 static inline bool gup_can_follow_protnone(unsigned int flags)
3352 {
3353         /*
3354          * FOLL_FORCE has to be able to make progress even if the VMA is
3355          * inaccessible. Further, FOLL_FORCE access usually does not represent
3356          * application behaviour and we should avoid triggering NUMA hinting
3357          * faults.
3358          */
3359         return flags & FOLL_FORCE;
3360 }
3361
3362 typedef int (*pte_fn_t)(pte_t *pte, unsigned long addr, void *data);
3363 extern int apply_to_page_range(struct mm_struct *mm, unsigned long address,
3364                                unsigned long size, pte_fn_t fn, void *data);
3365 extern int apply_to_existing_page_range(struct mm_struct *mm,
3366                                    unsigned long address, unsigned long size,
3367                                    pte_fn_t fn, void *data);
3368
3369 #ifdef CONFIG_PAGE_POISONING
3370 extern void __kernel_poison_pages(struct page *page, int numpages);
3371 extern void __kernel_unpoison_pages(struct page *page, int numpages);
3372 extern bool _page_poisoning_enabled_early;
3373 DECLARE_STATIC_KEY_FALSE(_page_poisoning_enabled);
3374 static inline bool page_poisoning_enabled(void)
3375 {
3376         return _page_poisoning_enabled_early;
3377 }
3378 /*
3379  * For use in fast paths after init_mem_debugging() has run, or when a
3380  * false negative result is not harmful when called too early.
3381  */
3382 static inline bool page_poisoning_enabled_static(void)
3383 {
3384         return static_branch_unlikely(&_page_poisoning_enabled);
3385 }
3386 static inline void kernel_poison_pages(struct page *page, int numpages)
3387 {
3388         if (page_poisoning_enabled_static())
3389                 __kernel_poison_pages(page, numpages);
3390 }
3391 static inline void kernel_unpoison_pages(struct page *page, int numpages)
3392 {
3393         if (page_poisoning_enabled_static())
3394                 __kernel_unpoison_pages(page, numpages);
3395 }
3396 #else
3397 static inline bool page_poisoning_enabled(void) { return false; }
3398 static inline bool page_poisoning_enabled_static(void) { return false; }
3399 static inline void __kernel_poison_pages(struct page *page, int nunmpages) { }
3400 static inline void kernel_poison_pages(struct page *page, int numpages) { }
3401 static inline void kernel_unpoison_pages(struct page *page, int numpages) { }
3402 #endif
3403
3404 DECLARE_STATIC_KEY_MAYBE(CONFIG_INIT_ON_ALLOC_DEFAULT_ON, init_on_alloc);
3405 static inline bool want_init_on_alloc(gfp_t flags)
3406 {
3407         if (static_branch_maybe(CONFIG_INIT_ON_ALLOC_DEFAULT_ON,
3408                                 &init_on_alloc))
3409                 return true;
3410         return flags & __GFP_ZERO;
3411 }
3412
3413 DECLARE_STATIC_KEY_MAYBE(CONFIG_INIT_ON_FREE_DEFAULT_ON, init_on_free);
3414 static inline bool want_init_on_free(void)
3415 {
3416         return static_branch_maybe(CONFIG_INIT_ON_FREE_DEFAULT_ON,
3417                                    &init_on_free);
3418 }
3419
3420 extern bool _debug_pagealloc_enabled_early;
3421 DECLARE_STATIC_KEY_FALSE(_debug_pagealloc_enabled);
3422
3423 static inline bool debug_pagealloc_enabled(void)
3424 {
3425         return IS_ENABLED(CONFIG_DEBUG_PAGEALLOC) &&
3426                 _debug_pagealloc_enabled_early;
3427 }
3428
3429 /*
3430  * For use in fast paths after init_debug_pagealloc() has run, or when a
3431  * false negative result is not harmful when called too early.
3432  */
3433 static inline bool debug_pagealloc_enabled_static(void)
3434 {
3435         if (!IS_ENABLED(CONFIG_DEBUG_PAGEALLOC))
3436                 return false;
3437
3438         return static_branch_unlikely(&_debug_pagealloc_enabled);
3439 }
3440
3441 #ifdef CONFIG_DEBUG_PAGEALLOC
3442 /*
3443  * To support DEBUG_PAGEALLOC architecture must ensure that
3444  * __kernel_map_pages() never fails
3445  */
3446 extern void __kernel_map_pages(struct page *page, int numpages, int enable);
3447
3448 static inline void debug_pagealloc_map_pages(struct page *page, int numpages)
3449 {
3450         if (debug_pagealloc_enabled_static())
3451                 __kernel_map_pages(page, numpages, 1);
3452 }
3453
3454 static inline void debug_pagealloc_unmap_pages(struct page *page, int numpages)
3455 {
3456         if (debug_pagealloc_enabled_static())
3457                 __kernel_map_pages(page, numpages, 0);
3458 }
3459 #else   /* CONFIG_DEBUG_PAGEALLOC */
3460 static inline void debug_pagealloc_map_pages(struct page *page, int numpages) {}
3461 static inline void debug_pagealloc_unmap_pages(struct page *page, int numpages) {}
3462 #endif  /* CONFIG_DEBUG_PAGEALLOC */
3463
3464 #ifdef __HAVE_ARCH_GATE_AREA
3465 extern struct vm_area_struct *get_gate_vma(struct mm_struct *mm);
3466 extern int in_gate_area_no_mm(unsigned long addr);
3467 extern int in_gate_area(struct mm_struct *mm, unsigned long addr);
3468 #else
3469 static inline struct vm_area_struct *get_gate_vma(struct mm_struct *mm)
3470 {
3471         return NULL;
3472 }
3473 static inline int in_gate_area_no_mm(unsigned long addr) { return 0; }
3474 static inline int in_gate_area(struct mm_struct *mm, unsigned long addr)
3475 {
3476         return 0;
3477 }
3478 #endif  /* __HAVE_ARCH_GATE_AREA */
3479
3480 extern bool process_shares_mm(struct task_struct *p, struct mm_struct *mm);
3481
3482 #ifdef CONFIG_SYSCTL
3483 extern int sysctl_drop_caches;
3484 int drop_caches_sysctl_handler(struct ctl_table *, int, void *, size_t *,
3485                 loff_t *);
3486 #endif
3487
3488 void drop_slab(void);
3489
3490 #ifndef CONFIG_MMU
3491 #define randomize_va_space 0
3492 #else
3493 extern int randomize_va_space;
3494 #endif
3495
3496 const char * arch_vma_name(struct vm_area_struct *vma);
3497 #ifdef CONFIG_MMU
3498 void print_vma_addr(char *prefix, unsigned long rip);
3499 #else
3500 static inline void print_vma_addr(char *prefix, unsigned long rip)
3501 {
3502 }
3503 #endif
3504
3505 void *sparse_buffer_alloc(unsigned long size);
3506 struct page * __populate_section_memmap(unsigned long pfn,
3507                 unsigned long nr_pages, int nid, struct vmem_altmap *altmap,
3508                 struct dev_pagemap *pgmap);
3509 void pmd_init(void *addr);
3510 void pud_init(void *addr);
3511 pgd_t *vmemmap_pgd_populate(unsigned long addr, int node);
3512 p4d_t *vmemmap_p4d_populate(pgd_t *pgd, unsigned long addr, int node);
3513 pud_t *vmemmap_pud_populate(p4d_t *p4d, unsigned long addr, int node);
3514 pmd_t *vmemmap_pmd_populate(pud_t *pud, unsigned long addr, int node);
3515 pte_t *vmemmap_pte_populate(pmd_t *pmd, unsigned long addr, int node,
3516                             struct vmem_altmap *altmap, struct page *reuse);
3517 void *vmemmap_alloc_block(unsigned long size, int node);
3518 struct vmem_altmap;
3519 void *vmemmap_alloc_block_buf(unsigned long size, int node,
3520                               struct vmem_altmap *altmap);
3521 void vmemmap_verify(pte_t *, int, unsigned long, unsigned long);
3522 void vmemmap_set_pmd(pmd_t *pmd, void *p, int node,
3523                      unsigned long addr, unsigned long next);
3524 int vmemmap_check_pmd(pmd_t *pmd, int node,
3525                       unsigned long addr, unsigned long next);
3526 int vmemmap_populate_basepages(unsigned long start, unsigned long end,
3527                                int node, struct vmem_altmap *altmap);
3528 int vmemmap_populate_hugepages(unsigned long start, unsigned long end,
3529                                int node, struct vmem_altmap *altmap);
3530 int vmemmap_populate(unsigned long start, unsigned long end, int node,
3531                 struct vmem_altmap *altmap);
3532 void vmemmap_populate_print_last(void);
3533 #ifdef CONFIG_MEMORY_HOTPLUG
3534 void vmemmap_free(unsigned long start, unsigned long end,
3535                 struct vmem_altmap *altmap);
3536 #endif
3537 void register_page_bootmem_memmap(unsigned long section_nr, struct page *map,
3538                                   unsigned long nr_pages);
3539
3540 enum mf_flags {
3541         MF_COUNT_INCREASED = 1 << 0,
3542         MF_ACTION_REQUIRED = 1 << 1,
3543         MF_MUST_KILL = 1 << 2,
3544         MF_SOFT_OFFLINE = 1 << 3,
3545         MF_UNPOISON = 1 << 4,
3546         MF_SW_SIMULATED = 1 << 5,
3547         MF_NO_RETRY = 1 << 6,
3548 };
3549 int mf_dax_kill_procs(struct address_space *mapping, pgoff_t index,
3550                       unsigned long count, int mf_flags);
3551 extern int memory_failure(unsigned long pfn, int flags);
3552 extern void memory_failure_queue_kick(int cpu);
3553 extern int unpoison_memory(unsigned long pfn);
3554 extern int sysctl_memory_failure_early_kill;
3555 extern int sysctl_memory_failure_recovery;
3556 extern void shake_page(struct page *p);
3557 extern atomic_long_t num_poisoned_pages __read_mostly;
3558 extern int soft_offline_page(unsigned long pfn, int flags);
3559 #ifdef CONFIG_MEMORY_FAILURE
3560 extern void memory_failure_queue(unsigned long pfn, int flags);
3561 extern int __get_huge_page_for_hwpoison(unsigned long pfn, int flags,
3562                                         bool *migratable_cleared);
3563 void num_poisoned_pages_inc(unsigned long pfn);
3564 void num_poisoned_pages_sub(unsigned long pfn, long i);
3565 #else
3566 static inline void memory_failure_queue(unsigned long pfn, int flags)
3567 {
3568 }
3569
3570 static inline int __get_huge_page_for_hwpoison(unsigned long pfn, int flags,
3571                                         bool *migratable_cleared)
3572 {
3573         return 0;
3574 }
3575
3576 static inline void num_poisoned_pages_inc(unsigned long pfn)
3577 {
3578 }
3579
3580 static inline void num_poisoned_pages_sub(unsigned long pfn, long i)
3581 {
3582 }
3583 #endif
3584
3585 #if defined(CONFIG_MEMORY_FAILURE) && defined(CONFIG_MEMORY_HOTPLUG)
3586 extern void memblk_nr_poison_inc(unsigned long pfn);
3587 extern void memblk_nr_poison_sub(unsigned long pfn, long i);
3588 #else
3589 static inline void memblk_nr_poison_inc(unsigned long pfn)
3590 {
3591 }
3592
3593 static inline void memblk_nr_poison_sub(unsigned long pfn, long i)
3594 {
3595 }
3596 #endif
3597
3598 #ifndef arch_memory_failure
3599 static inline int arch_memory_failure(unsigned long pfn, int flags)
3600 {
3601         return -ENXIO;
3602 }
3603 #endif
3604
3605 #ifndef arch_is_platform_page
3606 static inline bool arch_is_platform_page(u64 paddr)
3607 {
3608         return false;
3609 }
3610 #endif
3611
3612 /*
3613  * Error handlers for various types of pages.
3614  */
3615 enum mf_result {
3616         MF_IGNORED,     /* Error: cannot be handled */
3617         MF_FAILED,      /* Error: handling failed */
3618         MF_DELAYED,     /* Will be handled later */
3619         MF_RECOVERED,   /* Successfully recovered */
3620 };
3621
3622 enum mf_action_page_type {
3623         MF_MSG_KERNEL,
3624         MF_MSG_KERNEL_HIGH_ORDER,
3625         MF_MSG_SLAB,
3626         MF_MSG_DIFFERENT_COMPOUND,
3627         MF_MSG_HUGE,
3628         MF_MSG_FREE_HUGE,
3629         MF_MSG_UNMAP_FAILED,
3630         MF_MSG_DIRTY_SWAPCACHE,
3631         MF_MSG_CLEAN_SWAPCACHE,
3632         MF_MSG_DIRTY_MLOCKED_LRU,
3633         MF_MSG_CLEAN_MLOCKED_LRU,
3634         MF_MSG_DIRTY_UNEVICTABLE_LRU,
3635         MF_MSG_CLEAN_UNEVICTABLE_LRU,
3636         MF_MSG_DIRTY_LRU,
3637         MF_MSG_CLEAN_LRU,
3638         MF_MSG_TRUNCATED_LRU,
3639         MF_MSG_BUDDY,
3640         MF_MSG_DAX,
3641         MF_MSG_UNSPLIT_THP,
3642         MF_MSG_UNKNOWN,
3643 };
3644
3645 /*
3646  * Sysfs entries for memory failure handling statistics.
3647  */
3648 extern const struct attribute_group memory_failure_attr_group;
3649
3650 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) || defined(CONFIG_HUGETLBFS)
3651 extern void clear_huge_page(struct page *page,
3652                             unsigned long addr_hint,
3653                             unsigned int pages_per_huge_page);
3654 extern void copy_user_huge_page(struct page *dst, struct page *src,
3655                                 unsigned long addr_hint,
3656                                 struct vm_area_struct *vma,
3657                                 unsigned int pages_per_huge_page);
3658 extern long copy_huge_page_from_user(struct page *dst_page,
3659                                 const void __user *usr_src,
3660                                 unsigned int pages_per_huge_page,
3661                                 bool allow_pagefault);
3662
3663 /**
3664  * vma_is_special_huge - Are transhuge page-table entries considered special?
3665  * @vma: Pointer to the struct vm_area_struct to consider
3666  *
3667  * Whether transhuge page-table entries are considered "special" following
3668  * the definition in vm_normal_page().
3669  *
3670  * Return: true if transhuge page-table entries should be considered special,
3671  * false otherwise.
3672  */
3673 static inline bool vma_is_special_huge(const struct vm_area_struct *vma)
3674 {
3675         return vma_is_dax(vma) || (vma->vm_file &&
3676                                    (vma->vm_flags & (VM_PFNMAP | VM_MIXEDMAP)));
3677 }
3678
3679 #endif /* CONFIG_TRANSPARENT_HUGEPAGE || CONFIG_HUGETLBFS */
3680
3681 #ifdef CONFIG_DEBUG_PAGEALLOC
3682 extern unsigned int _debug_guardpage_minorder;
3683 DECLARE_STATIC_KEY_FALSE(_debug_guardpage_enabled);
3684
3685 static inline unsigned int debug_guardpage_minorder(void)
3686 {
3687         return _debug_guardpage_minorder;
3688 }
3689
3690 static inline bool debug_guardpage_enabled(void)
3691 {
3692         return static_branch_unlikely(&_debug_guardpage_enabled);
3693 }
3694
3695 static inline bool page_is_guard(struct page *page)
3696 {
3697         if (!debug_guardpage_enabled())
3698                 return false;
3699
3700         return PageGuard(page);
3701 }
3702 #else
3703 static inline unsigned int debug_guardpage_minorder(void) { return 0; }
3704 static inline bool debug_guardpage_enabled(void) { return false; }
3705 static inline bool page_is_guard(struct page *page) { return false; }
3706 #endif /* CONFIG_DEBUG_PAGEALLOC */
3707
3708 #if MAX_NUMNODES > 1
3709 void __init setup_nr_node_ids(void);
3710 #else
3711 static inline void setup_nr_node_ids(void) {}
3712 #endif
3713
3714 extern int memcmp_pages(struct page *page1, struct page *page2);
3715
3716 static inline int pages_identical(struct page *page1, struct page *page2)
3717 {
3718         return !memcmp_pages(page1, page2);
3719 }
3720
3721 #ifdef CONFIG_MAPPING_DIRTY_HELPERS
3722 unsigned long clean_record_shared_mapping_range(struct address_space *mapping,
3723                                                 pgoff_t first_index, pgoff_t nr,
3724                                                 pgoff_t bitmap_pgoff,
3725                                                 unsigned long *bitmap,
3726                                                 pgoff_t *start,
3727                                                 pgoff_t *end);
3728
3729 unsigned long wp_shared_mapping_range(struct address_space *mapping,
3730                                       pgoff_t first_index, pgoff_t nr);
3731 #endif
3732
3733 extern int sysctl_nr_trim_pages;
3734
3735 #ifdef CONFIG_PRINTK
3736 void mem_dump_obj(void *object);
3737 #else
3738 static inline void mem_dump_obj(void *object) {}
3739 #endif
3740
3741 /**
3742  * seal_check_future_write - Check for F_SEAL_FUTURE_WRITE flag and handle it
3743  * @seals: the seals to check
3744  * @vma: the vma to operate on
3745  *
3746  * Check whether F_SEAL_FUTURE_WRITE is set; if so, do proper check/handling on
3747  * the vma flags.  Return 0 if check pass, or <0 for errors.
3748  */
3749 static inline int seal_check_future_write(int seals, struct vm_area_struct *vma)
3750 {
3751         if (seals & F_SEAL_FUTURE_WRITE) {
3752                 /*
3753                  * New PROT_WRITE and MAP_SHARED mmaps are not allowed when
3754                  * "future write" seal active.
3755                  */
3756                 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_WRITE))
3757                         return -EPERM;
3758
3759                 /*
3760                  * Since an F_SEAL_FUTURE_WRITE sealed memfd can be mapped as
3761                  * MAP_SHARED and read-only, take care to not allow mprotect to
3762                  * revert protections on such mappings. Do this only for shared
3763                  * mappings. For private mappings, don't need to mask
3764                  * VM_MAYWRITE as we still want them to be COW-writable.
3765                  */
3766                 if (vma->vm_flags & VM_SHARED)
3767                         vm_flags_clear(vma, VM_MAYWRITE);
3768         }
3769
3770         return 0;
3771 }
3772
3773 #ifdef CONFIG_ANON_VMA_NAME
3774 int madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
3775                           unsigned long len_in,
3776                           struct anon_vma_name *anon_name);
3777 #else
3778 static inline int
3779 madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
3780                       unsigned long len_in, struct anon_vma_name *anon_name) {
3781         return 0;
3782 }
3783 #endif
3784
3785 #endif /* _LINUX_MM_H */