lib/test_maple_tree: add testing for maple tree
[linux-block.git] / include / linux / mm.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_MM_H
3#define _LINUX_MM_H
4
1da177e4 5#include <linux/errno.h>
309381fe 6#include <linux/mmdebug.h>
1da177e4 7#include <linux/gfp.h>
187f1882 8#include <linux/bug.h>
1da177e4
LT
9#include <linux/list.h>
10#include <linux/mmzone.h>
11#include <linux/rbtree.h>
83aeeada 12#include <linux/atomic.h>
9a11b49a 13#include <linux/debug_locks.h>
5b99cd0e 14#include <linux/mm_types.h>
9740ca4e 15#include <linux/mmap_lock.h>
08677214 16#include <linux/range.h>
c6f6b596 17#include <linux/pfn.h>
3565fce3 18#include <linux/percpu-refcount.h>
e9da73d6 19#include <linux/bit_spinlock.h>
b0d40c92 20#include <linux/shrinker.h>
9c599024 21#include <linux/resource.h>
e30825f1 22#include <linux/page_ext.h>
8025e5dd 23#include <linux/err.h>
41901567 24#include <linux/page-flags.h>
fe896d18 25#include <linux/page_ref.h>
3b3b1a29 26#include <linux/overflow.h>
b5420237 27#include <linux/sizes.h>
7969f226 28#include <linux/sched.h>
65fddcfc 29#include <linux/pgtable.h>
34303244 30#include <linux/kasan.h>
f25cbb7a 31#include <linux/memremap.h>
1da177e4
LT
32
33struct mempolicy;
34struct anon_vma;
bf181b9f 35struct anon_vma_chain;
e8edc6e0 36struct user_struct;
bce617ed 37struct pt_regs;
1da177e4 38
5ef64cc8
LT
39extern int sysctl_page_lock_unfairness;
40
597b7305
MH
41void init_mm_internals(void);
42
a9ee6cf5 43#ifndef CONFIG_NUMA /* Don't use mapnrs, do it properly */
1da177e4 44extern unsigned long max_mapnr;
fccc9987
JL
45
46static inline void set_max_mapnr(unsigned long limit)
47{
48 max_mapnr = limit;
49}
50#else
51static inline void set_max_mapnr(unsigned long limit) { }
1da177e4
LT
52#endif
53
ca79b0c2
AK
54extern atomic_long_t _totalram_pages;
55static inline unsigned long totalram_pages(void)
56{
57 return (unsigned long)atomic_long_read(&_totalram_pages);
58}
59
60static inline void totalram_pages_inc(void)
61{
62 atomic_long_inc(&_totalram_pages);
63}
64
65static inline void totalram_pages_dec(void)
66{
67 atomic_long_dec(&_totalram_pages);
68}
69
70static inline void totalram_pages_add(long count)
71{
72 atomic_long_add(count, &_totalram_pages);
73}
74
1da177e4 75extern void * high_memory;
1da177e4
LT
76extern int page_cluster;
77
78#ifdef CONFIG_SYSCTL
79extern int sysctl_legacy_va_layout;
80#else
81#define sysctl_legacy_va_layout 0
82#endif
83
d07e2259
DC
84#ifdef CONFIG_HAVE_ARCH_MMAP_RND_BITS
85extern const int mmap_rnd_bits_min;
86extern const int mmap_rnd_bits_max;
87extern int mmap_rnd_bits __read_mostly;
88#endif
89#ifdef CONFIG_HAVE_ARCH_MMAP_RND_COMPAT_BITS
90extern const int mmap_rnd_compat_bits_min;
91extern const int mmap_rnd_compat_bits_max;
92extern int mmap_rnd_compat_bits __read_mostly;
93#endif
94
1da177e4 95#include <asm/page.h>
1da177e4 96#include <asm/processor.h>
1da177e4 97
d9344522
AK
98/*
99 * Architectures that support memory tagging (assigning tags to memory regions,
100 * embedding these tags into addresses that point to these memory regions, and
101 * checking that the memory and the pointer tags match on memory accesses)
102 * redefine this macro to strip tags from pointers.
f0953a1b 103 * It's defined as noop for architectures that don't support memory tagging.
d9344522
AK
104 */
105#ifndef untagged_addr
106#define untagged_addr(addr) (addr)
107#endif
108
79442ed1
TC
109#ifndef __pa_symbol
110#define __pa_symbol(x) __pa(RELOC_HIDE((unsigned long)(x), 0))
111#endif
112
1dff8083
AB
113#ifndef page_to_virt
114#define page_to_virt(x) __va(PFN_PHYS(page_to_pfn(x)))
115#endif
116
568c5fe5
LA
117#ifndef lm_alias
118#define lm_alias(x) __va(__pa_symbol(x))
119#endif
120
593befa6
DD
121/*
122 * To prevent common memory management code establishing
123 * a zero page mapping on a read fault.
124 * This macro should be defined within <asm/pgtable.h>.
125 * s390 does this to prevent multiplexing of hardware bits
126 * related to the physical page in case of virtualization.
127 */
128#ifndef mm_forbids_zeropage
129#define mm_forbids_zeropage(X) (0)
130#endif
131
a4a3ede2
PT
132/*
133 * On some architectures it is expensive to call memset() for small sizes.
5470dea4
AD
134 * If an architecture decides to implement their own version of
135 * mm_zero_struct_page they should wrap the defines below in a #ifndef and
136 * define their own version of this macro in <asm/pgtable.h>
a4a3ede2 137 */
5470dea4
AD
138#if BITS_PER_LONG == 64
139/* This function must be updated when the size of struct page grows above 80
140 * or reduces below 56. The idea that compiler optimizes out switch()
141 * statement, and only leaves move/store instructions. Also the compiler can
c4ffefd1 142 * combine write statements if they are both assignments and can be reordered,
5470dea4
AD
143 * this can result in several of the writes here being dropped.
144 */
145#define mm_zero_struct_page(pp) __mm_zero_struct_page(pp)
146static inline void __mm_zero_struct_page(struct page *page)
147{
148 unsigned long *_pp = (void *)page;
149
150 /* Check that struct page is either 56, 64, 72, or 80 bytes */
151 BUILD_BUG_ON(sizeof(struct page) & 7);
152 BUILD_BUG_ON(sizeof(struct page) < 56);
153 BUILD_BUG_ON(sizeof(struct page) > 80);
154
155 switch (sizeof(struct page)) {
156 case 80:
df561f66
GS
157 _pp[9] = 0;
158 fallthrough;
5470dea4 159 case 72:
df561f66
GS
160 _pp[8] = 0;
161 fallthrough;
5470dea4 162 case 64:
df561f66
GS
163 _pp[7] = 0;
164 fallthrough;
5470dea4
AD
165 case 56:
166 _pp[6] = 0;
167 _pp[5] = 0;
168 _pp[4] = 0;
169 _pp[3] = 0;
170 _pp[2] = 0;
171 _pp[1] = 0;
172 _pp[0] = 0;
173 }
174}
175#else
a4a3ede2
PT
176#define mm_zero_struct_page(pp) ((void)memset((pp), 0, sizeof(struct page)))
177#endif
178
ea606cf5
AR
179/*
180 * Default maximum number of active map areas, this limits the number of vmas
181 * per mm struct. Users can overwrite this number by sysctl but there is a
182 * problem.
183 *
184 * When a program's coredump is generated as ELF format, a section is created
185 * per a vma. In ELF, the number of sections is represented in unsigned short.
186 * This means the number of sections should be smaller than 65535 at coredump.
187 * Because the kernel adds some informative sections to a image of program at
188 * generating coredump, we need some margin. The number of extra sections is
189 * 1-3 now and depends on arch. We use "5" as safe margin, here.
190 *
191 * ELF extended numbering allows more than 65535 sections, so 16-bit bound is
192 * not a hard limit any more. Although some userspace tools can be surprised by
193 * that.
194 */
195#define MAPCOUNT_ELF_CORE_MARGIN (5)
196#define DEFAULT_MAX_MAP_COUNT (USHRT_MAX - MAPCOUNT_ELF_CORE_MARGIN)
197
198extern int sysctl_max_map_count;
199
c9b1d098 200extern unsigned long sysctl_user_reserve_kbytes;
4eeab4f5 201extern unsigned long sysctl_admin_reserve_kbytes;
c9b1d098 202
49f0ce5f
JM
203extern int sysctl_overcommit_memory;
204extern int sysctl_overcommit_ratio;
205extern unsigned long sysctl_overcommit_kbytes;
206
32927393
CH
207int overcommit_ratio_handler(struct ctl_table *, int, void *, size_t *,
208 loff_t *);
209int overcommit_kbytes_handler(struct ctl_table *, int, void *, size_t *,
210 loff_t *);
56f3547b
FT
211int overcommit_policy_handler(struct ctl_table *, int, void *, size_t *,
212 loff_t *);
49f0ce5f 213
1cfcee72 214#if defined(CONFIG_SPARSEMEM) && !defined(CONFIG_SPARSEMEM_VMEMMAP)
1da177e4 215#define nth_page(page,n) pfn_to_page(page_to_pfn((page)) + (n))
659508f9 216#define folio_page_idx(folio, p) (page_to_pfn(p) - folio_pfn(folio))
1cfcee72
MWO
217#else
218#define nth_page(page,n) ((page) + (n))
659508f9 219#define folio_page_idx(folio, p) ((p) - &(folio)->page)
1cfcee72 220#endif
1da177e4 221
27ac792c
AR
222/* to align the pointer to the (next) page boundary */
223#define PAGE_ALIGN(addr) ALIGN(addr, PAGE_SIZE)
224
335e52c2
DG
225/* to align the pointer to the (prev) page boundary */
226#define PAGE_ALIGN_DOWN(addr) ALIGN_DOWN(addr, PAGE_SIZE)
227
0fa73b86 228/* test whether an address (unsigned long or pointer) is aligned to PAGE_SIZE */
1061b0d2 229#define PAGE_ALIGNED(addr) IS_ALIGNED((unsigned long)(addr), PAGE_SIZE)
0fa73b86 230
f86196ea 231#define lru_to_page(head) (list_entry((head)->prev, struct page, lru))
06d20bdb
MWO
232static inline struct folio *lru_to_folio(struct list_head *head)
233{
234 return list_entry((head)->prev, struct folio, lru);
235}
f86196ea 236
5748fbc5
KW
237void setup_initial_init_mm(void *start_code, void *end_code,
238 void *end_data, void *brk);
239
1da177e4
LT
240/*
241 * Linux kernel virtual memory manager primitives.
242 * The idea being to have a "virtual" mm in the same way
243 * we have a virtual fs - giving a cleaner interface to the
244 * mm details, and allowing different kinds of memory mappings
245 * (from shared memory to executable loading to arbitrary
246 * mmap() functions).
247 */
248
490fc053 249struct vm_area_struct *vm_area_alloc(struct mm_struct *);
3928d4f5
LT
250struct vm_area_struct *vm_area_dup(struct vm_area_struct *);
251void vm_area_free(struct vm_area_struct *);
c43692e8 252
1da177e4 253#ifndef CONFIG_MMU
8feae131
DH
254extern struct rb_root nommu_region_tree;
255extern struct rw_semaphore nommu_region_sem;
1da177e4
LT
256
257extern unsigned int kobjsize(const void *objp);
258#endif
259
260/*
605d9288 261 * vm_flags in vm_area_struct, see mm_types.h.
bcf66917 262 * When changing, update also include/trace/events/mmflags.h
1da177e4 263 */
cc2383ec
KK
264#define VM_NONE 0x00000000
265
1da177e4
LT
266#define VM_READ 0x00000001 /* currently active flags */
267#define VM_WRITE 0x00000002
268#define VM_EXEC 0x00000004
269#define VM_SHARED 0x00000008
270
7e2cff42 271/* mprotect() hardcodes VM_MAYREAD >> 4 == VM_READ, and so for r/w/x bits. */
1da177e4
LT
272#define VM_MAYREAD 0x00000010 /* limits for mprotect() etc */
273#define VM_MAYWRITE 0x00000020
274#define VM_MAYEXEC 0x00000040
275#define VM_MAYSHARE 0x00000080
276
277#define VM_GROWSDOWN 0x00000100 /* general info on the segment */
16ba6f81 278#define VM_UFFD_MISSING 0x00000200 /* missing pages tracking */
6aab341e 279#define VM_PFNMAP 0x00000400 /* Page-ranges managed without "struct page", just pure PFN */
16ba6f81 280#define VM_UFFD_WP 0x00001000 /* wrprotect pages tracking */
1da177e4 281
1da177e4
LT
282#define VM_LOCKED 0x00002000
283#define VM_IO 0x00004000 /* Memory mapped I/O or similar */
284
285 /* Used by sys_madvise() */
286#define VM_SEQ_READ 0x00008000 /* App will access data sequentially */
287#define VM_RAND_READ 0x00010000 /* App will not benefit from clustered reads */
288
289#define VM_DONTCOPY 0x00020000 /* Do not copy this vma on fork */
290#define VM_DONTEXPAND 0x00040000 /* Cannot expand with mremap() */
de60f5f1 291#define VM_LOCKONFAULT 0x00080000 /* Lock the pages covered when they are faulted in */
1da177e4 292#define VM_ACCOUNT 0x00100000 /* Is a VM accounted object */
cdfd4325 293#define VM_NORESERVE 0x00200000 /* should the VM suppress accounting */
1da177e4 294#define VM_HUGETLB 0x00400000 /* Huge TLB Page VM */
b6fb293f 295#define VM_SYNC 0x00800000 /* Synchronous page faults */
cc2383ec 296#define VM_ARCH_1 0x01000000 /* Architecture-specific flag */
d2cd9ede 297#define VM_WIPEONFORK 0x02000000 /* Wipe VMA contents in child. */
0103bd16 298#define VM_DONTDUMP 0x04000000 /* Do not include in the core dump */
d00806b1 299
d9104d1c
CG
300#ifdef CONFIG_MEM_SOFT_DIRTY
301# define VM_SOFTDIRTY 0x08000000 /* Not soft dirty clean area */
302#else
303# define VM_SOFTDIRTY 0
304#endif
305
b379d790 306#define VM_MIXEDMAP 0x10000000 /* Can contain "struct page" and pure PFN pages */
cc2383ec
KK
307#define VM_HUGEPAGE 0x20000000 /* MADV_HUGEPAGE marked this vma */
308#define VM_NOHUGEPAGE 0x40000000 /* MADV_NOHUGEPAGE marked this vma */
f8af4da3 309#define VM_MERGEABLE 0x80000000 /* KSM may merge identical pages */
1da177e4 310
63c17fb8
DH
311#ifdef CONFIG_ARCH_USES_HIGH_VMA_FLAGS
312#define VM_HIGH_ARCH_BIT_0 32 /* bit only usable on 64-bit architectures */
313#define VM_HIGH_ARCH_BIT_1 33 /* bit only usable on 64-bit architectures */
314#define VM_HIGH_ARCH_BIT_2 34 /* bit only usable on 64-bit architectures */
315#define VM_HIGH_ARCH_BIT_3 35 /* bit only usable on 64-bit architectures */
df3735c5 316#define VM_HIGH_ARCH_BIT_4 36 /* bit only usable on 64-bit architectures */
63c17fb8
DH
317#define VM_HIGH_ARCH_0 BIT(VM_HIGH_ARCH_BIT_0)
318#define VM_HIGH_ARCH_1 BIT(VM_HIGH_ARCH_BIT_1)
319#define VM_HIGH_ARCH_2 BIT(VM_HIGH_ARCH_BIT_2)
320#define VM_HIGH_ARCH_3 BIT(VM_HIGH_ARCH_BIT_3)
df3735c5 321#define VM_HIGH_ARCH_4 BIT(VM_HIGH_ARCH_BIT_4)
63c17fb8
DH
322#endif /* CONFIG_ARCH_USES_HIGH_VMA_FLAGS */
323
5212213a 324#ifdef CONFIG_ARCH_HAS_PKEYS
8f62c883
DH
325# define VM_PKEY_SHIFT VM_HIGH_ARCH_BIT_0
326# define VM_PKEY_BIT0 VM_HIGH_ARCH_0 /* A protection key is a 4-bit value */
2c9e0a6f 327# define VM_PKEY_BIT1 VM_HIGH_ARCH_1 /* on x86 and 5-bit value on ppc64 */
8f62c883
DH
328# define VM_PKEY_BIT2 VM_HIGH_ARCH_2
329# define VM_PKEY_BIT3 VM_HIGH_ARCH_3
2c9e0a6f
RP
330#ifdef CONFIG_PPC
331# define VM_PKEY_BIT4 VM_HIGH_ARCH_4
332#else
333# define VM_PKEY_BIT4 0
8f62c883 334#endif
5212213a
RP
335#endif /* CONFIG_ARCH_HAS_PKEYS */
336
337#if defined(CONFIG_X86)
338# define VM_PAT VM_ARCH_1 /* PAT reserves whole VMA at once (x86) */
12564485
SA
339#elif defined(CONFIG_PPC)
340# define VM_SAO VM_ARCH_1 /* Strong Access Ordering (powerpc) */
cc2383ec
KK
341#elif defined(CONFIG_PARISC)
342# define VM_GROWSUP VM_ARCH_1
343#elif defined(CONFIG_IA64)
344# define VM_GROWSUP VM_ARCH_1
74a04967
KA
345#elif defined(CONFIG_SPARC64)
346# define VM_SPARC_ADI VM_ARCH_1 /* Uses ADI tag for access control */
347# define VM_ARCH_CLEAR VM_SPARC_ADI
8ef8f360
DM
348#elif defined(CONFIG_ARM64)
349# define VM_ARM64_BTI VM_ARCH_1 /* BTI guarded page, a.k.a. GP bit */
350# define VM_ARCH_CLEAR VM_ARM64_BTI
cc2383ec
KK
351#elif !defined(CONFIG_MMU)
352# define VM_MAPPED_COPY VM_ARCH_1 /* T if mapped copy of data (nommu mmap) */
353#endif
354
9f341931
CM
355#if defined(CONFIG_ARM64_MTE)
356# define VM_MTE VM_HIGH_ARCH_0 /* Use Tagged memory for access control */
357# define VM_MTE_ALLOWED VM_HIGH_ARCH_1 /* Tagged memory permitted */
358#else
359# define VM_MTE VM_NONE
360# define VM_MTE_ALLOWED VM_NONE
361#endif
362
cc2383ec
KK
363#ifndef VM_GROWSUP
364# define VM_GROWSUP VM_NONE
365#endif
366
7677f7fd
AR
367#ifdef CONFIG_HAVE_ARCH_USERFAULTFD_MINOR
368# define VM_UFFD_MINOR_BIT 37
369# define VM_UFFD_MINOR BIT(VM_UFFD_MINOR_BIT) /* UFFD minor faults */
370#else /* !CONFIG_HAVE_ARCH_USERFAULTFD_MINOR */
371# define VM_UFFD_MINOR VM_NONE
372#endif /* CONFIG_HAVE_ARCH_USERFAULTFD_MINOR */
373
a8bef8ff
MG
374/* Bits set in the VMA until the stack is in its final location */
375#define VM_STACK_INCOMPLETE_SETUP (VM_RAND_READ | VM_SEQ_READ)
376
c62da0c3
AK
377#define TASK_EXEC ((current->personality & READ_IMPLIES_EXEC) ? VM_EXEC : 0)
378
379/* Common data flag combinations */
380#define VM_DATA_FLAGS_TSK_EXEC (VM_READ | VM_WRITE | TASK_EXEC | \
381 VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC)
382#define VM_DATA_FLAGS_NON_EXEC (VM_READ | VM_WRITE | VM_MAYREAD | \
383 VM_MAYWRITE | VM_MAYEXEC)
384#define VM_DATA_FLAGS_EXEC (VM_READ | VM_WRITE | VM_EXEC | \
385 VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC)
386
387#ifndef VM_DATA_DEFAULT_FLAGS /* arch can override this */
388#define VM_DATA_DEFAULT_FLAGS VM_DATA_FLAGS_EXEC
389#endif
390
1da177e4
LT
391#ifndef VM_STACK_DEFAULT_FLAGS /* arch can override this */
392#define VM_STACK_DEFAULT_FLAGS VM_DATA_DEFAULT_FLAGS
393#endif
394
395#ifdef CONFIG_STACK_GROWSUP
30bdbb78 396#define VM_STACK VM_GROWSUP
1da177e4 397#else
30bdbb78 398#define VM_STACK VM_GROWSDOWN
1da177e4
LT
399#endif
400
30bdbb78
KK
401#define VM_STACK_FLAGS (VM_STACK | VM_STACK_DEFAULT_FLAGS | VM_ACCOUNT)
402
6cb4d9a2
AK
403/* VMA basic access permission flags */
404#define VM_ACCESS_FLAGS (VM_READ | VM_WRITE | VM_EXEC)
405
406
b291f000 407/*
78f11a25 408 * Special vmas that are non-mergable, non-mlock()able.
b291f000 409 */
9050d7eb 410#define VM_SPECIAL (VM_IO | VM_DONTEXPAND | VM_PFNMAP | VM_MIXEDMAP)
b291f000 411
b4443772
AK
412/* This mask prevents VMA from being scanned with khugepaged */
413#define VM_NO_KHUGEPAGED (VM_SPECIAL | VM_HUGETLB)
414
a0715cc2
AT
415/* This mask defines which mm->def_flags a process can inherit its parent */
416#define VM_INIT_DEF_MASK VM_NOHUGEPAGE
417
de60f5f1
EM
418/* This mask is used to clear all the VMA flags used by mlock */
419#define VM_LOCKED_CLEAR_MASK (~(VM_LOCKED | VM_LOCKONFAULT))
420
2c2d57b5
KA
421/* Arch-specific flags to clear when updating VM flags on protection change */
422#ifndef VM_ARCH_CLEAR
423# define VM_ARCH_CLEAR VM_NONE
424#endif
425#define VM_FLAGS_CLEAR (ARCH_VM_PKEY_FLAGS | VM_ARCH_CLEAR)
426
1da177e4
LT
427/*
428 * mapping from the currently active vm_flags protection bits (the
429 * low four bits) to a page protection mask..
430 */
1da177e4 431
dde16072
PX
432/*
433 * The default fault flags that should be used by most of the
434 * arch-specific page fault handlers.
435 */
436#define FAULT_FLAG_DEFAULT (FAULT_FLAG_ALLOW_RETRY | \
c270a7ee
PX
437 FAULT_FLAG_KILLABLE | \
438 FAULT_FLAG_INTERRUPTIBLE)
dde16072 439
4064b982
PX
440/**
441 * fault_flag_allow_retry_first - check ALLOW_RETRY the first time
78f4841e 442 * @flags: Fault flags.
4064b982
PX
443 *
444 * This is mostly used for places where we want to try to avoid taking
c1e8d7c6 445 * the mmap_lock for too long a time when waiting for another condition
4064b982 446 * to change, in which case we can try to be polite to release the
c1e8d7c6
ML
447 * mmap_lock in the first round to avoid potential starvation of other
448 * processes that would also want the mmap_lock.
4064b982
PX
449 *
450 * Return: true if the page fault allows retry and this is the first
451 * attempt of the fault handling; false otherwise.
452 */
da2f5eb3 453static inline bool fault_flag_allow_retry_first(enum fault_flag flags)
4064b982
PX
454{
455 return (flags & FAULT_FLAG_ALLOW_RETRY) &&
456 (!(flags & FAULT_FLAG_TRIED));
457}
458
282a8e03
RZ
459#define FAULT_FLAG_TRACE \
460 { FAULT_FLAG_WRITE, "WRITE" }, \
461 { FAULT_FLAG_MKWRITE, "MKWRITE" }, \
462 { FAULT_FLAG_ALLOW_RETRY, "ALLOW_RETRY" }, \
463 { FAULT_FLAG_RETRY_NOWAIT, "RETRY_NOWAIT" }, \
464 { FAULT_FLAG_KILLABLE, "KILLABLE" }, \
465 { FAULT_FLAG_TRIED, "TRIED" }, \
466 { FAULT_FLAG_USER, "USER" }, \
467 { FAULT_FLAG_REMOTE, "REMOTE" }, \
c270a7ee
PX
468 { FAULT_FLAG_INSTRUCTION, "INSTRUCTION" }, \
469 { FAULT_FLAG_INTERRUPTIBLE, "INTERRUPTIBLE" }
282a8e03 470
54cb8821 471/*
11192337 472 * vm_fault is filled by the pagefault handler and passed to the vma's
83c54070
NP
473 * ->fault function. The vma's ->fault is responsible for returning a bitmask
474 * of VM_FAULT_xxx flags that give details about how the fault was handled.
54cb8821 475 *
c20cd45e
MH
476 * MM layer fills up gfp_mask for page allocations but fault handler might
477 * alter it if its implementation requires a different allocation context.
478 *
9b4bdd2f 479 * pgoff should be used in favour of virtual_address, if possible.
54cb8821 480 */
d0217ac0 481struct vm_fault {
5857c920 482 const struct {
742d3372
WD
483 struct vm_area_struct *vma; /* Target VMA */
484 gfp_t gfp_mask; /* gfp mask to be used for allocations */
485 pgoff_t pgoff; /* Logical page offset based on vma */
824ddc60
NA
486 unsigned long address; /* Faulting virtual address - masked */
487 unsigned long real_address; /* Faulting virtual address - unmasked */
742d3372 488 };
da2f5eb3 489 enum fault_flag flags; /* FAULT_FLAG_xxx flags
742d3372 490 * XXX: should really be 'const' */
82b0f8c3 491 pmd_t *pmd; /* Pointer to pmd entry matching
2994302b 492 * the 'address' */
a2d58167
DJ
493 pud_t *pud; /* Pointer to pud entry matching
494 * the 'address'
495 */
5db4f15c
YS
496 union {
497 pte_t orig_pte; /* Value of PTE at the time of fault */
498 pmd_t orig_pmd; /* Value of PMD at the time of fault,
499 * used by PMD fault only.
500 */
501 };
d0217ac0 502
3917048d 503 struct page *cow_page; /* Page handler may use for COW fault */
d0217ac0 504 struct page *page; /* ->fault handlers should return a
83c54070 505 * page here, unless VM_FAULT_NOPAGE
d0217ac0 506 * is set (which is also implied by
83c54070 507 * VM_FAULT_ERROR).
d0217ac0 508 */
82b0f8c3 509 /* These three entries are valid only while holding ptl lock */
bae473a4
KS
510 pte_t *pte; /* Pointer to pte entry matching
511 * the 'address'. NULL if the page
512 * table hasn't been allocated.
513 */
514 spinlock_t *ptl; /* Page table lock.
515 * Protects pte page table if 'pte'
516 * is not NULL, otherwise pmd.
517 */
7267ec00 518 pgtable_t prealloc_pte; /* Pre-allocated pte page table.
f9ce0be7
KS
519 * vm_ops->map_pages() sets up a page
520 * table from atomic context.
7267ec00
KS
521 * do_fault_around() pre-allocates
522 * page table to avoid allocation from
523 * atomic context.
524 */
54cb8821 525};
1da177e4 526
c791ace1
DJ
527/* page entry size for vm->huge_fault() */
528enum page_entry_size {
529 PE_SIZE_PTE = 0,
530 PE_SIZE_PMD,
531 PE_SIZE_PUD,
532};
533
1da177e4
LT
534/*
535 * These are the virtual MM functions - opening of an area, closing and
536 * unmapping it (needed to keep files on disk up-to-date etc), pointer
27d036e3 537 * to the functions called when a no-page or a wp-page exception occurs.
1da177e4
LT
538 */
539struct vm_operations_struct {
540 void (*open)(struct vm_area_struct * area);
cc6dcfee
SB
541 /**
542 * @close: Called when the VMA is being removed from the MM.
543 * Context: User context. May sleep. Caller holds mmap_lock.
544 */
1da177e4 545 void (*close)(struct vm_area_struct * area);
dd3b614f
DS
546 /* Called any time before splitting to check if it's allowed */
547 int (*may_split)(struct vm_area_struct *area, unsigned long addr);
14d07113 548 int (*mremap)(struct vm_area_struct *area);
95bb7c42
SC
549 /*
550 * Called by mprotect() to make driver-specific permission
551 * checks before mprotect() is finalised. The VMA must not
552 * be modified. Returns 0 if eprotect() can proceed.
553 */
554 int (*mprotect)(struct vm_area_struct *vma, unsigned long start,
555 unsigned long end, unsigned long newflags);
1c8f4220
SJ
556 vm_fault_t (*fault)(struct vm_fault *vmf);
557 vm_fault_t (*huge_fault)(struct vm_fault *vmf,
558 enum page_entry_size pe_size);
f9ce0be7 559 vm_fault_t (*map_pages)(struct vm_fault *vmf,
bae473a4 560 pgoff_t start_pgoff, pgoff_t end_pgoff);
05ea8860 561 unsigned long (*pagesize)(struct vm_area_struct * area);
9637a5ef
DH
562
563 /* notification that a previously read-only page is about to become
564 * writable, if an error is returned it will cause a SIGBUS */
1c8f4220 565 vm_fault_t (*page_mkwrite)(struct vm_fault *vmf);
28b2ee20 566
dd906184 567 /* same as page_mkwrite when using VM_PFNMAP|VM_MIXEDMAP */
1c8f4220 568 vm_fault_t (*pfn_mkwrite)(struct vm_fault *vmf);
dd906184 569
28b2ee20 570 /* called by access_process_vm when get_user_pages() fails, typically
96667f8a
DV
571 * for use by special VMAs. See also generic_access_phys() for a generic
572 * implementation useful for any iomem mapping.
28b2ee20
RR
573 */
574 int (*access)(struct vm_area_struct *vma, unsigned long addr,
575 void *buf, int len, int write);
78d683e8
AL
576
577 /* Called by the /proc/PID/maps code to ask the vma whether it
578 * has a special name. Returning non-NULL will also cause this
579 * vma to be dumped unconditionally. */
580 const char *(*name)(struct vm_area_struct *vma);
581
1da177e4 582#ifdef CONFIG_NUMA
a6020ed7
LS
583 /*
584 * set_policy() op must add a reference to any non-NULL @new mempolicy
585 * to hold the policy upon return. Caller should pass NULL @new to
586 * remove a policy and fall back to surrounding context--i.e. do not
587 * install a MPOL_DEFAULT policy, nor the task or system default
588 * mempolicy.
589 */
1da177e4 590 int (*set_policy)(struct vm_area_struct *vma, struct mempolicy *new);
a6020ed7
LS
591
592 /*
593 * get_policy() op must add reference [mpol_get()] to any policy at
594 * (vma,addr) marked as MPOL_SHARED. The shared policy infrastructure
595 * in mm/mempolicy.c will do this automatically.
596 * get_policy() must NOT add a ref if the policy at (vma,addr) is not
c1e8d7c6 597 * marked as MPOL_SHARED. vma policies are protected by the mmap_lock.
a6020ed7
LS
598 * If no [shared/vma] mempolicy exists at the addr, get_policy() op
599 * must return NULL--i.e., do not "fallback" to task or system default
600 * policy.
601 */
1da177e4
LT
602 struct mempolicy *(*get_policy)(struct vm_area_struct *vma,
603 unsigned long addr);
604#endif
667a0a06
DV
605 /*
606 * Called by vm_normal_page() for special PTEs to find the
607 * page for @addr. This is useful if the default behavior
608 * (using pte_page()) would not find the correct page.
609 */
610 struct page *(*find_special_page)(struct vm_area_struct *vma,
611 unsigned long addr);
1da177e4
LT
612};
613
027232da
KS
614static inline void vma_init(struct vm_area_struct *vma, struct mm_struct *mm)
615{
bfd40eaf
KS
616 static const struct vm_operations_struct dummy_vm_ops = {};
617
a670468f 618 memset(vma, 0, sizeof(*vma));
027232da 619 vma->vm_mm = mm;
bfd40eaf 620 vma->vm_ops = &dummy_vm_ops;
027232da
KS
621 INIT_LIST_HEAD(&vma->anon_vma_chain);
622}
623
bfd40eaf
KS
624static inline void vma_set_anonymous(struct vm_area_struct *vma)
625{
626 vma->vm_ops = NULL;
627}
628
43675e6f
YS
629static inline bool vma_is_anonymous(struct vm_area_struct *vma)
630{
631 return !vma->vm_ops;
632}
633
222100ee
AK
634static inline bool vma_is_temporary_stack(struct vm_area_struct *vma)
635{
636 int maybe_stack = vma->vm_flags & (VM_GROWSDOWN | VM_GROWSUP);
637
638 if (!maybe_stack)
639 return false;
640
641 if ((vma->vm_flags & VM_STACK_INCOMPLETE_SETUP) ==
642 VM_STACK_INCOMPLETE_SETUP)
643 return true;
644
645 return false;
646}
647
7969f226
AK
648static inline bool vma_is_foreign(struct vm_area_struct *vma)
649{
650 if (!current->mm)
651 return true;
652
653 if (current->mm != vma->vm_mm)
654 return true;
655
656 return false;
657}
3122e80e
AK
658
659static inline bool vma_is_accessible(struct vm_area_struct *vma)
660{
6cb4d9a2 661 return vma->vm_flags & VM_ACCESS_FLAGS;
3122e80e
AK
662}
663
43675e6f
YS
664#ifdef CONFIG_SHMEM
665/*
666 * The vma_is_shmem is not inline because it is used only by slow
667 * paths in userfault.
668 */
669bool vma_is_shmem(struct vm_area_struct *vma);
670#else
671static inline bool vma_is_shmem(struct vm_area_struct *vma) { return false; }
672#endif
673
674int vma_is_stack_for_current(struct vm_area_struct *vma);
675
8b11ec1b
LT
676/* flush_tlb_range() takes a vma, not a mm, and can care about flags */
677#define TLB_FLUSH_VMA(mm,flags) { .vm_mm = (mm), .vm_flags = (flags) }
678
1da177e4
LT
679struct mmu_gather;
680struct inode;
681
5bf34d7c
MWO
682static inline unsigned int compound_order(struct page *page)
683{
684 if (!PageHead(page))
685 return 0;
686 return page[1].compound_order;
687}
688
689/**
690 * folio_order - The allocation order of a folio.
691 * @folio: The folio.
692 *
693 * A folio is composed of 2^order pages. See get_order() for the definition
694 * of order.
695 *
696 * Return: The order of the folio.
697 */
698static inline unsigned int folio_order(struct folio *folio)
699{
700 return compound_order(&folio->page);
701}
702
71e3aac0 703#include <linux/huge_mm.h>
1da177e4
LT
704
705/*
706 * Methods to modify the page usage count.
707 *
708 * What counts for a page usage:
709 * - cache mapping (page->mapping)
710 * - private data (page->private)
711 * - page mapped in a task's page tables, each mapping
712 * is counted separately
713 *
714 * Also, many kernel routines increase the page count before a critical
715 * routine so they can be sure the page doesn't go away from under them.
1da177e4
LT
716 */
717
718/*
da6052f7 719 * Drop a ref, return true if the refcount fell to zero (the page has no users)
1da177e4 720 */
7c8ee9a8
NP
721static inline int put_page_testzero(struct page *page)
722{
fe896d18
JK
723 VM_BUG_ON_PAGE(page_ref_count(page) == 0, page);
724 return page_ref_dec_and_test(page);
7c8ee9a8 725}
1da177e4 726
b620f633
MWO
727static inline int folio_put_testzero(struct folio *folio)
728{
729 return put_page_testzero(&folio->page);
730}
731
1da177e4 732/*
7c8ee9a8
NP
733 * Try to grab a ref unless the page has a refcount of zero, return false if
734 * that is the case.
8e0861fa
AK
735 * This can be called when MMU is off so it must not access
736 * any of the virtual mappings.
1da177e4 737 */
c2530328 738static inline bool get_page_unless_zero(struct page *page)
7c8ee9a8 739{
fe896d18 740 return page_ref_add_unless(page, 1, 0);
7c8ee9a8 741}
1da177e4 742
53df8fdc 743extern int page_is_ram(unsigned long pfn);
124fe20d
DW
744
745enum {
746 REGION_INTERSECTS,
747 REGION_DISJOINT,
748 REGION_MIXED,
749};
750
1c29f25b
TK
751int region_intersects(resource_size_t offset, size_t size, unsigned long flags,
752 unsigned long desc);
53df8fdc 753
48667e7a 754/* Support for virtually mapped pages */
b3bdda02
CL
755struct page *vmalloc_to_page(const void *addr);
756unsigned long vmalloc_to_pfn(const void *addr);
48667e7a 757
0738c4bb
PM
758/*
759 * Determine if an address is within the vmalloc range
760 *
761 * On nommu, vmalloc/vfree wrap through kmalloc/kfree directly, so there
762 * is no special casing required.
763 */
9bd3bb67
AK
764
765#ifndef is_ioremap_addr
766#define is_ioremap_addr(x) is_vmalloc_addr(x)
767#endif
768
81ac3ad9 769#ifdef CONFIG_MMU
186525bd 770extern bool is_vmalloc_addr(const void *x);
81ac3ad9
KH
771extern int is_vmalloc_or_module_addr(const void *x);
772#else
186525bd
IM
773static inline bool is_vmalloc_addr(const void *x)
774{
775 return false;
776}
934831d0 777static inline int is_vmalloc_or_module_addr(const void *x)
81ac3ad9
KH
778{
779 return 0;
780}
781#endif
9e2779fa 782
74e8ee47
MWO
783/*
784 * How many times the entire folio is mapped as a single unit (eg by a
785 * PMD or PUD entry). This is probably not what you want, except for
786 * debugging purposes; look at folio_mapcount() or page_mapcount()
787 * instead.
788 */
789static inline int folio_entire_mapcount(struct folio *folio)
6dc5ea16 790{
74e8ee47
MWO
791 VM_BUG_ON_FOLIO(!folio_test_large(folio), folio);
792 return atomic_read(folio_mapcount_ptr(folio)) + 1;
6dc5ea16
JH
793}
794
6988f31d
KK
795/*
796 * Mapcount of compound page as a whole, does not include mapped sub-pages.
797 *
74e8ee47 798 * Must be called only for compound pages.
6988f31d 799 */
53f9263b
KS
800static inline int compound_mapcount(struct page *page)
801{
74e8ee47 802 return folio_entire_mapcount(page_folio(page));
53f9263b
KS
803}
804
70b50f94
AA
805/*
806 * The atomic page->_mapcount, starts from -1: so that transitions
807 * both from it and to it can be tracked, using atomic_inc_and_test
808 * and atomic_add_negative(-1).
809 */
22b751c3 810static inline void page_mapcount_reset(struct page *page)
70b50f94
AA
811{
812 atomic_set(&(page)->_mapcount, -1);
813}
814
b20ce5e0
KS
815int __page_mapcount(struct page *page);
816
6988f31d
KK
817/*
818 * Mapcount of 0-order page; when compound sub-page, includes
819 * compound_mapcount().
820 *
821 * Result is undefined for pages which cannot be mapped into userspace.
822 * For example SLAB or special types of pages. See function page_has_type().
823 * They use this place in struct page differently.
824 */
70b50f94
AA
825static inline int page_mapcount(struct page *page)
826{
b20ce5e0
KS
827 if (unlikely(PageCompound(page)))
828 return __page_mapcount(page);
829 return atomic_read(&page->_mapcount) + 1;
830}
831
4ba1119c
MWO
832int folio_mapcount(struct folio *folio);
833
b20ce5e0 834#ifdef CONFIG_TRANSPARENT_HUGEPAGE
4ba1119c
MWO
835static inline int total_mapcount(struct page *page)
836{
837 return folio_mapcount(page_folio(page));
838}
839
b20ce5e0
KS
840#else
841static inline int total_mapcount(struct page *page)
842{
843 return page_mapcount(page);
70b50f94 844}
b20ce5e0 845#endif
70b50f94 846
b49af68f
CL
847static inline struct page *virt_to_head_page(const void *x)
848{
849 struct page *page = virt_to_page(x);
ccaafd7f 850
1d798ca3 851 return compound_head(page);
b49af68f
CL
852}
853
7d4203c1
VB
854static inline struct folio *virt_to_folio(const void *x)
855{
856 struct page *page = virt_to_page(x);
857
858 return page_folio(page);
859}
860
8d29c703 861void __folio_put(struct folio *folio);
ddc58f27 862
1d7ea732 863void put_pages_list(struct list_head *pages);
1da177e4 864
8dfcc9ba 865void split_page(struct page *page, unsigned int order);
715cbfd6 866void folio_copy(struct folio *dst, struct folio *src);
8dfcc9ba 867
a1554c00
ML
868unsigned long nr_free_buffer_pages(void);
869
33f2ef89
AW
870/*
871 * Compound pages have a destructor function. Provide a
872 * prototype for that function and accessor functions.
f1e61557 873 * These are _only_ valid on the head of a compound page.
33f2ef89 874 */
f1e61557
KS
875typedef void compound_page_dtor(struct page *);
876
877/* Keep the enum in sync with compound_page_dtors array in mm/page_alloc.c */
878enum compound_dtor_id {
879 NULL_COMPOUND_DTOR,
880 COMPOUND_PAGE_DTOR,
881#ifdef CONFIG_HUGETLB_PAGE
882 HUGETLB_PAGE_DTOR,
9a982250
KS
883#endif
884#ifdef CONFIG_TRANSPARENT_HUGEPAGE
885 TRANSHUGE_PAGE_DTOR,
f1e61557
KS
886#endif
887 NR_COMPOUND_DTORS,
888};
ae70eddd 889extern compound_page_dtor * const compound_page_dtors[NR_COMPOUND_DTORS];
33f2ef89
AW
890
891static inline void set_compound_page_dtor(struct page *page,
f1e61557 892 enum compound_dtor_id compound_dtor)
33f2ef89 893{
f1e61557
KS
894 VM_BUG_ON_PAGE(compound_dtor >= NR_COMPOUND_DTORS, page);
895 page[1].compound_dtor = compound_dtor;
33f2ef89
AW
896}
897
5375336c 898void destroy_large_folio(struct folio *folio);
33f2ef89 899
bac3cf4d 900static inline int head_compound_pincount(struct page *head)
6dc5ea16
JH
901{
902 return atomic_read(compound_pincount_ptr(head));
903}
904
f1e61557 905static inline void set_compound_order(struct page *page, unsigned int order)
d85f3385 906{
e4b294c2 907 page[1].compound_order = order;
5232c63f 908#ifdef CONFIG_64BIT
1378a5ee 909 page[1].compound_nr = 1U << order;
5232c63f 910#endif
d85f3385
CL
911}
912
d8c6546b
MWO
913/* Returns the number of pages in this potentially compound page. */
914static inline unsigned long compound_nr(struct page *page)
915{
1378a5ee
MWO
916 if (!PageHead(page))
917 return 1;
5232c63f 918#ifdef CONFIG_64BIT
1378a5ee 919 return page[1].compound_nr;
5232c63f
MWO
920#else
921 return 1UL << compound_order(page);
922#endif
d8c6546b
MWO
923}
924
a50b854e
MWO
925/* Returns the number of bytes in this potentially compound page. */
926static inline unsigned long page_size(struct page *page)
927{
928 return PAGE_SIZE << compound_order(page);
929}
930
94ad9338
MWO
931/* Returns the number of bits needed for the number of bytes in a page */
932static inline unsigned int page_shift(struct page *page)
933{
934 return PAGE_SHIFT + compound_order(page);
935}
936
18788cfa
MWO
937/**
938 * thp_order - Order of a transparent huge page.
939 * @page: Head page of a transparent huge page.
940 */
941static inline unsigned int thp_order(struct page *page)
942{
943 VM_BUG_ON_PGFLAGS(PageTail(page), page);
944 return compound_order(page);
945}
946
947/**
948 * thp_nr_pages - The number of regular pages in this huge page.
949 * @page: The head page of a huge page.
950 */
951static inline int thp_nr_pages(struct page *page)
952{
953 VM_BUG_ON_PGFLAGS(PageTail(page), page);
954 return compound_nr(page);
955}
956
957/**
958 * thp_size - Size of a transparent huge page.
959 * @page: Head page of a transparent huge page.
960 *
961 * Return: Number of bytes in this page.
962 */
963static inline unsigned long thp_size(struct page *page)
964{
965 return PAGE_SIZE << thp_order(page);
966}
967
9a982250
KS
968void free_compound_page(struct page *page);
969
3dece370 970#ifdef CONFIG_MMU
14fd403f
AA
971/*
972 * Do pte_mkwrite, but only if the vma says VM_WRITE. We do this when
973 * servicing faults for write access. In the normal case, do always want
974 * pte_mkwrite. But get_user_pages can cause write faults for mappings
975 * that do not have writing enabled, when used by access_process_vm.
976 */
977static inline pte_t maybe_mkwrite(pte_t pte, struct vm_area_struct *vma)
978{
979 if (likely(vma->vm_flags & VM_WRITE))
980 pte = pte_mkwrite(pte);
981 return pte;
982}
8c6e50b0 983
f9ce0be7 984vm_fault_t do_set_pmd(struct vm_fault *vmf, struct page *page);
9d3af4b4 985void do_set_pte(struct vm_fault *vmf, struct page *page, unsigned long addr);
f9ce0be7 986
2b740303
SJ
987vm_fault_t finish_fault(struct vm_fault *vmf);
988vm_fault_t finish_mkwrite_fault(struct vm_fault *vmf);
3dece370 989#endif
14fd403f 990
1da177e4
LT
991/*
992 * Multiple processes may "see" the same page. E.g. for untouched
993 * mappings of /dev/null, all processes see the same page full of
994 * zeroes, and text pages of executables and shared libraries have
995 * only one copy in memory, at most, normally.
996 *
997 * For the non-reserved pages, page_count(page) denotes a reference count.
7e871b6c
PBG
998 * page_count() == 0 means the page is free. page->lru is then used for
999 * freelist management in the buddy allocator.
da6052f7 1000 * page_count() > 0 means the page has been allocated.
1da177e4 1001 *
da6052f7
NP
1002 * Pages are allocated by the slab allocator in order to provide memory
1003 * to kmalloc and kmem_cache_alloc. In this case, the management of the
1004 * page, and the fields in 'struct page' are the responsibility of mm/slab.c
1005 * unless a particular usage is carefully commented. (the responsibility of
1006 * freeing the kmalloc memory is the caller's, of course).
1da177e4 1007 *
da6052f7
NP
1008 * A page may be used by anyone else who does a __get_free_page().
1009 * In this case, page_count still tracks the references, and should only
1010 * be used through the normal accessor functions. The top bits of page->flags
1011 * and page->virtual store page management information, but all other fields
1012 * are unused and could be used privately, carefully. The management of this
1013 * page is the responsibility of the one who allocated it, and those who have
1014 * subsequently been given references to it.
1015 *
1016 * The other pages (we may call them "pagecache pages") are completely
1da177e4
LT
1017 * managed by the Linux memory manager: I/O, buffers, swapping etc.
1018 * The following discussion applies only to them.
1019 *
da6052f7
NP
1020 * A pagecache page contains an opaque `private' member, which belongs to the
1021 * page's address_space. Usually, this is the address of a circular list of
1022 * the page's disk buffers. PG_private must be set to tell the VM to call
1023 * into the filesystem to release these pages.
1da177e4 1024 *
da6052f7
NP
1025 * A page may belong to an inode's memory mapping. In this case, page->mapping
1026 * is the pointer to the inode, and page->index is the file offset of the page,
ea1754a0 1027 * in units of PAGE_SIZE.
1da177e4 1028 *
da6052f7
NP
1029 * If pagecache pages are not associated with an inode, they are said to be
1030 * anonymous pages. These may become associated with the swapcache, and in that
1031 * case PG_swapcache is set, and page->private is an offset into the swapcache.
1da177e4 1032 *
da6052f7
NP
1033 * In either case (swapcache or inode backed), the pagecache itself holds one
1034 * reference to the page. Setting PG_private should also increment the
1035 * refcount. The each user mapping also has a reference to the page.
1da177e4 1036 *
da6052f7 1037 * The pagecache pages are stored in a per-mapping radix tree, which is
b93b0163 1038 * rooted at mapping->i_pages, and indexed by offset.
da6052f7
NP
1039 * Where 2.4 and early 2.6 kernels kept dirty/clean pages in per-address_space
1040 * lists, we instead now tag pages as dirty/writeback in the radix tree.
1da177e4 1041 *
da6052f7 1042 * All pagecache pages may be subject to I/O:
1da177e4
LT
1043 * - inode pages may need to be read from disk,
1044 * - inode pages which have been modified and are MAP_SHARED may need
da6052f7
NP
1045 * to be written back to the inode on disk,
1046 * - anonymous pages (including MAP_PRIVATE file mappings) which have been
1047 * modified may need to be swapped out to swap space and (later) to be read
1048 * back into memory.
1da177e4
LT
1049 */
1050
27674ef6 1051#if defined(CONFIG_ZONE_DEVICE) && defined(CONFIG_FS_DAX)
e7638488 1052DECLARE_STATIC_KEY_FALSE(devmap_managed_key);
07d80269 1053
f4f451a1
MS
1054bool __put_devmap_managed_page_refs(struct page *page, int refs);
1055static inline bool put_devmap_managed_page_refs(struct page *page, int refs)
e7638488
DW
1056{
1057 if (!static_branch_unlikely(&devmap_managed_key))
1058 return false;
1059 if (!is_zone_device_page(page))
1060 return false;
f4f451a1 1061 return __put_devmap_managed_page_refs(page, refs);
e7638488 1062}
27674ef6 1063#else /* CONFIG_ZONE_DEVICE && CONFIG_FS_DAX */
f4f451a1 1064static inline bool put_devmap_managed_page_refs(struct page *page, int refs)
e7638488
DW
1065{
1066 return false;
1067}
27674ef6 1068#endif /* CONFIG_ZONE_DEVICE && CONFIG_FS_DAX */
7b2d55d2 1069
f4f451a1
MS
1070static inline bool put_devmap_managed_page(struct page *page)
1071{
1072 return put_devmap_managed_page_refs(page, 1);
1073}
1074
f958d7b5 1075/* 127: arbitrary random number, small enough to assemble well */
86d234cb
MWO
1076#define folio_ref_zero_or_close_to_overflow(folio) \
1077 ((unsigned int) folio_ref_count(folio) + 127u <= 127u)
1078
1079/**
1080 * folio_get - Increment the reference count on a folio.
1081 * @folio: The folio.
1082 *
1083 * Context: May be called in any context, as long as you know that
1084 * you have a refcount on the folio. If you do not already have one,
1085 * folio_try_get() may be the right interface for you to use.
1086 */
1087static inline void folio_get(struct folio *folio)
1088{
1089 VM_BUG_ON_FOLIO(folio_ref_zero_or_close_to_overflow(folio), folio);
1090 folio_ref_inc(folio);
1091}
f958d7b5 1092
3565fce3
DW
1093static inline void get_page(struct page *page)
1094{
86d234cb 1095 folio_get(page_folio(page));
3565fce3
DW
1096}
1097
3faa52c0 1098bool __must_check try_grab_page(struct page *page, unsigned int flags);
cd1adf1b
LT
1099
1100static inline __must_check bool try_get_page(struct page *page)
1101{
1102 page = compound_head(page);
1103 if (WARN_ON_ONCE(page_ref_count(page) <= 0))
1104 return false;
1105 page_ref_inc(page);
1106 return true;
1107}
3565fce3 1108
b620f633
MWO
1109/**
1110 * folio_put - Decrement the reference count on a folio.
1111 * @folio: The folio.
1112 *
1113 * If the folio's reference count reaches zero, the memory will be
1114 * released back to the page allocator and may be used by another
1115 * allocation immediately. Do not access the memory or the struct folio
1116 * after calling folio_put() unless you can be sure that it wasn't the
1117 * last reference.
1118 *
1119 * Context: May be called in process or interrupt context, but not in NMI
1120 * context. May be called while holding a spinlock.
1121 */
1122static inline void folio_put(struct folio *folio)
1123{
1124 if (folio_put_testzero(folio))
8d29c703 1125 __folio_put(folio);
b620f633
MWO
1126}
1127
3fe7fa58
MWO
1128/**
1129 * folio_put_refs - Reduce the reference count on a folio.
1130 * @folio: The folio.
1131 * @refs: The amount to subtract from the folio's reference count.
1132 *
1133 * If the folio's reference count reaches zero, the memory will be
1134 * released back to the page allocator and may be used by another
1135 * allocation immediately. Do not access the memory or the struct folio
1136 * after calling folio_put_refs() unless you can be sure that these weren't
1137 * the last references.
1138 *
1139 * Context: May be called in process or interrupt context, but not in NMI
1140 * context. May be called while holding a spinlock.
1141 */
1142static inline void folio_put_refs(struct folio *folio, int refs)
1143{
1144 if (folio_ref_sub_and_test(folio, refs))
8d29c703 1145 __folio_put(folio);
3fe7fa58
MWO
1146}
1147
e3c4cebf
MWO
1148void release_pages(struct page **pages, int nr);
1149
1150/**
1151 * folios_put - Decrement the reference count on an array of folios.
1152 * @folios: The folios.
1153 * @nr: How many folios there are.
1154 *
1155 * Like folio_put(), but for an array of folios. This is more efficient
1156 * than writing the loop yourself as it will optimise the locks which
1157 * need to be taken if the folios are freed.
1158 *
1159 * Context: May be called in process or interrupt context, but not in NMI
1160 * context. May be called while holding a spinlock.
1161 */
1162static inline void folios_put(struct folio **folios, unsigned int nr)
1163{
1164 release_pages((struct page **)folios, nr);
3fe7fa58
MWO
1165}
1166
3565fce3
DW
1167static inline void put_page(struct page *page)
1168{
b620f633 1169 struct folio *folio = page_folio(page);
3565fce3 1170
7b2d55d2 1171 /*
89574945
CH
1172 * For some devmap managed pages we need to catch refcount transition
1173 * from 2 to 1:
7b2d55d2 1174 */
89574945 1175 if (put_devmap_managed_page(&folio->page))
7b2d55d2 1176 return;
b620f633 1177 folio_put(folio);
3565fce3
DW
1178}
1179
3faa52c0
JH
1180/*
1181 * GUP_PIN_COUNTING_BIAS, and the associated functions that use it, overload
1182 * the page's refcount so that two separate items are tracked: the original page
1183 * reference count, and also a new count of how many pin_user_pages() calls were
1184 * made against the page. ("gup-pinned" is another term for the latter).
1185 *
1186 * With this scheme, pin_user_pages() becomes special: such pages are marked as
1187 * distinct from normal pages. As such, the unpin_user_page() call (and its
1188 * variants) must be used in order to release gup-pinned pages.
1189 *
1190 * Choice of value:
1191 *
1192 * By making GUP_PIN_COUNTING_BIAS a power of two, debugging of page reference
1193 * counts with respect to pin_user_pages() and unpin_user_page() becomes
1194 * simpler, due to the fact that adding an even power of two to the page
1195 * refcount has the effect of using only the upper N bits, for the code that
1196 * counts up using the bias value. This means that the lower bits are left for
1197 * the exclusive use of the original code that increments and decrements by one
1198 * (or at least, by much smaller values than the bias value).
fc1d8e7c 1199 *
3faa52c0
JH
1200 * Of course, once the lower bits overflow into the upper bits (and this is
1201 * OK, because subtraction recovers the original values), then visual inspection
1202 * no longer suffices to directly view the separate counts. However, for normal
1203 * applications that don't have huge page reference counts, this won't be an
1204 * issue.
fc1d8e7c 1205 *
40fcc7fc
MWO
1206 * Locking: the lockless algorithm described in folio_try_get_rcu()
1207 * provides safe operation for get_user_pages(), page_mkclean() and
1208 * other calls that race to set up page table entries.
fc1d8e7c 1209 */
3faa52c0 1210#define GUP_PIN_COUNTING_BIAS (1U << 10)
fc1d8e7c 1211
3faa52c0 1212void unpin_user_page(struct page *page);
f1f6a7dd
JH
1213void unpin_user_pages_dirty_lock(struct page **pages, unsigned long npages,
1214 bool make_dirty);
458a4f78
JM
1215void unpin_user_page_range_dirty_lock(struct page *page, unsigned long npages,
1216 bool make_dirty);
f1f6a7dd 1217void unpin_user_pages(struct page **pages, unsigned long npages);
fc1d8e7c 1218
97a7e473
PX
1219static inline bool is_cow_mapping(vm_flags_t flags)
1220{
1221 return (flags & (VM_SHARED | VM_MAYWRITE)) == VM_MAYWRITE;
1222}
1223
9127ab4f
CS
1224#if defined(CONFIG_SPARSEMEM) && !defined(CONFIG_SPARSEMEM_VMEMMAP)
1225#define SECTION_IN_PAGE_FLAGS
1226#endif
1227
89689ae7 1228/*
7a8010cd
VB
1229 * The identification function is mainly used by the buddy allocator for
1230 * determining if two pages could be buddies. We are not really identifying
1231 * the zone since we could be using the section number id if we do not have
1232 * node id available in page flags.
1233 * We only guarantee that it will return the same value for two combinable
1234 * pages in a zone.
89689ae7 1235 */
cb2b95e1
AW
1236static inline int page_zone_id(struct page *page)
1237{
89689ae7 1238 return (page->flags >> ZONEID_PGSHIFT) & ZONEID_MASK;
348f8b6c
DH
1239}
1240
89689ae7 1241#ifdef NODE_NOT_IN_PAGE_FLAGS
33dd4e0e 1242extern int page_to_nid(const struct page *page);
89689ae7 1243#else
33dd4e0e 1244static inline int page_to_nid(const struct page *page)
d41dee36 1245{
f165b378
PT
1246 struct page *p = (struct page *)page;
1247
1248 return (PF_POISONED_CHECK(p)->flags >> NODES_PGSHIFT) & NODES_MASK;
d41dee36 1249}
89689ae7
CL
1250#endif
1251
874fd90c
MWO
1252static inline int folio_nid(const struct folio *folio)
1253{
1254 return page_to_nid(&folio->page);
1255}
1256
57e0a030 1257#ifdef CONFIG_NUMA_BALANCING
33024536
HY
1258/* page access time bits needs to hold at least 4 seconds */
1259#define PAGE_ACCESS_TIME_MIN_BITS 12
1260#if LAST_CPUPID_SHIFT < PAGE_ACCESS_TIME_MIN_BITS
1261#define PAGE_ACCESS_TIME_BUCKETS \
1262 (PAGE_ACCESS_TIME_MIN_BITS - LAST_CPUPID_SHIFT)
1263#else
1264#define PAGE_ACCESS_TIME_BUCKETS 0
1265#endif
1266
1267#define PAGE_ACCESS_TIME_MASK \
1268 (LAST_CPUPID_MASK << PAGE_ACCESS_TIME_BUCKETS)
1269
90572890 1270static inline int cpu_pid_to_cpupid(int cpu, int pid)
57e0a030 1271{
90572890 1272 return ((cpu & LAST__CPU_MASK) << LAST__PID_SHIFT) | (pid & LAST__PID_MASK);
57e0a030
MG
1273}
1274
90572890 1275static inline int cpupid_to_pid(int cpupid)
57e0a030 1276{
90572890 1277 return cpupid & LAST__PID_MASK;
57e0a030 1278}
b795854b 1279
90572890 1280static inline int cpupid_to_cpu(int cpupid)
b795854b 1281{
90572890 1282 return (cpupid >> LAST__PID_SHIFT) & LAST__CPU_MASK;
b795854b
MG
1283}
1284
90572890 1285static inline int cpupid_to_nid(int cpupid)
b795854b 1286{
90572890 1287 return cpu_to_node(cpupid_to_cpu(cpupid));
b795854b
MG
1288}
1289
90572890 1290static inline bool cpupid_pid_unset(int cpupid)
57e0a030 1291{
90572890 1292 return cpupid_to_pid(cpupid) == (-1 & LAST__PID_MASK);
b795854b
MG
1293}
1294
90572890 1295static inline bool cpupid_cpu_unset(int cpupid)
b795854b 1296{
90572890 1297 return cpupid_to_cpu(cpupid) == (-1 & LAST__CPU_MASK);
b795854b
MG
1298}
1299
8c8a743c
PZ
1300static inline bool __cpupid_match_pid(pid_t task_pid, int cpupid)
1301{
1302 return (task_pid & LAST__PID_MASK) == cpupid_to_pid(cpupid);
1303}
1304
1305#define cpupid_match_pid(task, cpupid) __cpupid_match_pid(task->pid, cpupid)
90572890
PZ
1306#ifdef LAST_CPUPID_NOT_IN_PAGE_FLAGS
1307static inline int page_cpupid_xchg_last(struct page *page, int cpupid)
b795854b 1308{
1ae71d03 1309 return xchg(&page->_last_cpupid, cpupid & LAST_CPUPID_MASK);
b795854b 1310}
90572890
PZ
1311
1312static inline int page_cpupid_last(struct page *page)
1313{
1314 return page->_last_cpupid;
1315}
1316static inline void page_cpupid_reset_last(struct page *page)
b795854b 1317{
1ae71d03 1318 page->_last_cpupid = -1 & LAST_CPUPID_MASK;
57e0a030
MG
1319}
1320#else
90572890 1321static inline int page_cpupid_last(struct page *page)
75980e97 1322{
90572890 1323 return (page->flags >> LAST_CPUPID_PGSHIFT) & LAST_CPUPID_MASK;
75980e97
PZ
1324}
1325
90572890 1326extern int page_cpupid_xchg_last(struct page *page, int cpupid);
75980e97 1327
90572890 1328static inline void page_cpupid_reset_last(struct page *page)
75980e97 1329{
09940a4f 1330 page->flags |= LAST_CPUPID_MASK << LAST_CPUPID_PGSHIFT;
75980e97 1331}
90572890 1332#endif /* LAST_CPUPID_NOT_IN_PAGE_FLAGS */
33024536
HY
1333
1334static inline int xchg_page_access_time(struct page *page, int time)
1335{
1336 int last_time;
1337
1338 last_time = page_cpupid_xchg_last(page, time >> PAGE_ACCESS_TIME_BUCKETS);
1339 return last_time << PAGE_ACCESS_TIME_BUCKETS;
1340}
90572890
PZ
1341#else /* !CONFIG_NUMA_BALANCING */
1342static inline int page_cpupid_xchg_last(struct page *page, int cpupid)
57e0a030 1343{
90572890 1344 return page_to_nid(page); /* XXX */
57e0a030
MG
1345}
1346
33024536
HY
1347static inline int xchg_page_access_time(struct page *page, int time)
1348{
1349 return 0;
1350}
1351
90572890 1352static inline int page_cpupid_last(struct page *page)
57e0a030 1353{
90572890 1354 return page_to_nid(page); /* XXX */
57e0a030
MG
1355}
1356
90572890 1357static inline int cpupid_to_nid(int cpupid)
b795854b
MG
1358{
1359 return -1;
1360}
1361
90572890 1362static inline int cpupid_to_pid(int cpupid)
b795854b
MG
1363{
1364 return -1;
1365}
1366
90572890 1367static inline int cpupid_to_cpu(int cpupid)
b795854b
MG
1368{
1369 return -1;
1370}
1371
90572890
PZ
1372static inline int cpu_pid_to_cpupid(int nid, int pid)
1373{
1374 return -1;
1375}
1376
1377static inline bool cpupid_pid_unset(int cpupid)
b795854b 1378{
2b787449 1379 return true;
b795854b
MG
1380}
1381
90572890 1382static inline void page_cpupid_reset_last(struct page *page)
57e0a030
MG
1383{
1384}
8c8a743c
PZ
1385
1386static inline bool cpupid_match_pid(struct task_struct *task, int cpupid)
1387{
1388 return false;
1389}
90572890 1390#endif /* CONFIG_NUMA_BALANCING */
57e0a030 1391
2e903b91 1392#if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
34303244 1393
cf10bd4c
AK
1394/*
1395 * KASAN per-page tags are stored xor'ed with 0xff. This allows to avoid
1396 * setting tags for all pages to native kernel tag value 0xff, as the default
1397 * value 0x00 maps to 0xff.
1398 */
1399
2813b9c0
AK
1400static inline u8 page_kasan_tag(const struct page *page)
1401{
cf10bd4c
AK
1402 u8 tag = 0xff;
1403
1404 if (kasan_enabled()) {
1405 tag = (page->flags >> KASAN_TAG_PGSHIFT) & KASAN_TAG_MASK;
1406 tag ^= 0xff;
1407 }
1408
1409 return tag;
2813b9c0
AK
1410}
1411
1412static inline void page_kasan_tag_set(struct page *page, u8 tag)
1413{
27fe7339
PC
1414 unsigned long old_flags, flags;
1415
1416 if (!kasan_enabled())
1417 return;
1418
1419 tag ^= 0xff;
1420 old_flags = READ_ONCE(page->flags);
1421 do {
1422 flags = old_flags;
1423 flags &= ~(KASAN_TAG_MASK << KASAN_TAG_PGSHIFT);
1424 flags |= (tag & KASAN_TAG_MASK) << KASAN_TAG_PGSHIFT;
1425 } while (unlikely(!try_cmpxchg(&page->flags, &old_flags, flags)));
2813b9c0
AK
1426}
1427
1428static inline void page_kasan_tag_reset(struct page *page)
1429{
34303244
AK
1430 if (kasan_enabled())
1431 page_kasan_tag_set(page, 0xff);
2813b9c0 1432}
34303244
AK
1433
1434#else /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */
1435
2813b9c0
AK
1436static inline u8 page_kasan_tag(const struct page *page)
1437{
1438 return 0xff;
1439}
1440
1441static inline void page_kasan_tag_set(struct page *page, u8 tag) { }
1442static inline void page_kasan_tag_reset(struct page *page) { }
34303244
AK
1443
1444#endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */
2813b9c0 1445
33dd4e0e 1446static inline struct zone *page_zone(const struct page *page)
89689ae7
CL
1447{
1448 return &NODE_DATA(page_to_nid(page))->node_zones[page_zonenum(page)];
1449}
1450
75ef7184
MG
1451static inline pg_data_t *page_pgdat(const struct page *page)
1452{
1453 return NODE_DATA(page_to_nid(page));
1454}
1455
32b8fc48
MWO
1456static inline struct zone *folio_zone(const struct folio *folio)
1457{
1458 return page_zone(&folio->page);
1459}
1460
1461static inline pg_data_t *folio_pgdat(const struct folio *folio)
1462{
1463 return page_pgdat(&folio->page);
1464}
1465
9127ab4f 1466#ifdef SECTION_IN_PAGE_FLAGS
bf4e8902
DK
1467static inline void set_page_section(struct page *page, unsigned long section)
1468{
1469 page->flags &= ~(SECTIONS_MASK << SECTIONS_PGSHIFT);
1470 page->flags |= (section & SECTIONS_MASK) << SECTIONS_PGSHIFT;
1471}
1472
aa462abe 1473static inline unsigned long page_to_section(const struct page *page)
d41dee36
AW
1474{
1475 return (page->flags >> SECTIONS_PGSHIFT) & SECTIONS_MASK;
1476}
308c05e3 1477#endif
d41dee36 1478
bf6bd276
MWO
1479/**
1480 * folio_pfn - Return the Page Frame Number of a folio.
1481 * @folio: The folio.
1482 *
1483 * A folio may contain multiple pages. The pages have consecutive
1484 * Page Frame Numbers.
1485 *
1486 * Return: The Page Frame Number of the first page in the folio.
1487 */
1488static inline unsigned long folio_pfn(struct folio *folio)
1489{
1490 return page_to_pfn(&folio->page);
1491}
1492
018ee47f
YZ
1493static inline struct folio *pfn_folio(unsigned long pfn)
1494{
1495 return page_folio(pfn_to_page(pfn));
1496}
1497
3d11b225
MWO
1498static inline atomic_t *folio_pincount_ptr(struct folio *folio)
1499{
1500 return &folio_page(folio, 1)->compound_pincount;
1501}
1502
0b90ddae
MWO
1503/**
1504 * folio_maybe_dma_pinned - Report if a folio may be pinned for DMA.
1505 * @folio: The folio.
1506 *
1507 * This function checks if a folio has been pinned via a call to
1508 * a function in the pin_user_pages() family.
1509 *
1510 * For small folios, the return value is partially fuzzy: false is not fuzzy,
1511 * because it means "definitely not pinned for DMA", but true means "probably
1512 * pinned for DMA, but possibly a false positive due to having at least
1513 * GUP_PIN_COUNTING_BIAS worth of normal folio references".
1514 *
1515 * False positives are OK, because: a) it's unlikely for a folio to
1516 * get that many refcounts, and b) all the callers of this routine are
1517 * expected to be able to deal gracefully with a false positive.
1518 *
1519 * For large folios, the result will be exactly correct. That's because
1520 * we have more tracking data available: the compound_pincount is used
1521 * instead of the GUP_PIN_COUNTING_BIAS scheme.
1522 *
1523 * For more information, please see Documentation/core-api/pin_user_pages.rst.
1524 *
1525 * Return: True, if it is likely that the page has been "dma-pinned".
1526 * False, if the page is definitely not dma-pinned.
1527 */
1528static inline bool folio_maybe_dma_pinned(struct folio *folio)
1529{
1530 if (folio_test_large(folio))
1531 return atomic_read(folio_pincount_ptr(folio)) > 0;
1532
1533 /*
1534 * folio_ref_count() is signed. If that refcount overflows, then
1535 * folio_ref_count() returns a negative value, and callers will avoid
1536 * further incrementing the refcount.
1537 *
1538 * Here, for that overflow case, use the sign bit to count a little
1539 * bit higher via unsigned math, and thus still get an accurate result.
1540 */
1541 return ((unsigned int)folio_ref_count(folio)) >=
1542 GUP_PIN_COUNTING_BIAS;
1543}
1544
1545static inline bool page_maybe_dma_pinned(struct page *page)
1546{
1547 return folio_maybe_dma_pinned(page_folio(page));
1548}
1549
1550/*
1551 * This should most likely only be called during fork() to see whether we
fb3d824d 1552 * should break the cow immediately for an anon page on the src mm.
623a1ddf
DH
1553 *
1554 * The caller has to hold the PT lock and the vma->vm_mm->->write_protect_seq.
0b90ddae
MWO
1555 */
1556static inline bool page_needs_cow_for_dma(struct vm_area_struct *vma,
1557 struct page *page)
1558{
623a1ddf 1559 VM_BUG_ON(!(raw_read_seqcount(&vma->vm_mm->write_protect_seq) & 1));
0b90ddae
MWO
1560
1561 if (!test_bit(MMF_HAS_PINNED, &vma->vm_mm->flags))
1562 return false;
1563
1564 return page_maybe_dma_pinned(page);
1565}
1566
8e3560d9
PT
1567/* MIGRATE_CMA and ZONE_MOVABLE do not allow pin pages */
1568#ifdef CONFIG_MIGRATION
6077c943 1569static inline bool is_longterm_pinnable_page(struct page *page)
8e3560d9 1570{
1c563432
MK
1571#ifdef CONFIG_CMA
1572 int mt = get_pageblock_migratetype(page);
1573
1574 if (mt == MIGRATE_CMA || mt == MIGRATE_ISOLATE)
1575 return false;
1576#endif
fcab34b4
AW
1577 /* The zero page may always be pinned */
1578 if (is_zero_pfn(page_to_pfn(page)))
1579 return true;
1580
1581 /* Coherent device memory must always allow eviction. */
1582 if (is_device_coherent_page(page))
1583 return false;
1584
1585 /* Otherwise, non-movable zone pages can be pinned. */
1586 return !is_zone_movable_page(page);
8e3560d9
PT
1587}
1588#else
6077c943 1589static inline bool is_longterm_pinnable_page(struct page *page)
8e3560d9
PT
1590{
1591 return true;
1592}
1593#endif
1594
6077c943 1595static inline bool folio_is_longterm_pinnable(struct folio *folio)
536939ff 1596{
6077c943 1597 return is_longterm_pinnable_page(&folio->page);
536939ff
MWO
1598}
1599
2f1b6248 1600static inline void set_page_zone(struct page *page, enum zone_type zone)
348f8b6c
DH
1601{
1602 page->flags &= ~(ZONES_MASK << ZONES_PGSHIFT);
1603 page->flags |= (zone & ZONES_MASK) << ZONES_PGSHIFT;
1604}
2f1b6248 1605
348f8b6c
DH
1606static inline void set_page_node(struct page *page, unsigned long node)
1607{
1608 page->flags &= ~(NODES_MASK << NODES_PGSHIFT);
1609 page->flags |= (node & NODES_MASK) << NODES_PGSHIFT;
1da177e4 1610}
89689ae7 1611
2f1b6248 1612static inline void set_page_links(struct page *page, enum zone_type zone,
d41dee36 1613 unsigned long node, unsigned long pfn)
1da177e4 1614{
348f8b6c
DH
1615 set_page_zone(page, zone);
1616 set_page_node(page, node);
9127ab4f 1617#ifdef SECTION_IN_PAGE_FLAGS
d41dee36 1618 set_page_section(page, pfn_to_section_nr(pfn));
bf4e8902 1619#endif
1da177e4
LT
1620}
1621
7b230db3
MWO
1622/**
1623 * folio_nr_pages - The number of pages in the folio.
1624 * @folio: The folio.
1625 *
1626 * Return: A positive power of two.
1627 */
1628static inline long folio_nr_pages(struct folio *folio)
1629{
1630 return compound_nr(&folio->page);
1631}
1632
1633/**
1634 * folio_next - Move to the next physical folio.
1635 * @folio: The folio we're currently operating on.
1636 *
1637 * If you have physically contiguous memory which may span more than
1638 * one folio (eg a &struct bio_vec), use this function to move from one
1639 * folio to the next. Do not use it if the memory is only virtually
1640 * contiguous as the folios are almost certainly not adjacent to each
1641 * other. This is the folio equivalent to writing ``page++``.
1642 *
1643 * Context: We assume that the folios are refcounted and/or locked at a
1644 * higher level and do not adjust the reference counts.
1645 * Return: The next struct folio.
1646 */
1647static inline struct folio *folio_next(struct folio *folio)
1648{
1649 return (struct folio *)folio_page(folio, folio_nr_pages(folio));
1650}
1651
1652/**
1653 * folio_shift - The size of the memory described by this folio.
1654 * @folio: The folio.
1655 *
1656 * A folio represents a number of bytes which is a power-of-two in size.
1657 * This function tells you which power-of-two the folio is. See also
1658 * folio_size() and folio_order().
1659 *
1660 * Context: The caller should have a reference on the folio to prevent
1661 * it from being split. It is not necessary for the folio to be locked.
1662 * Return: The base-2 logarithm of the size of this folio.
1663 */
1664static inline unsigned int folio_shift(struct folio *folio)
1665{
1666 return PAGE_SHIFT + folio_order(folio);
1667}
1668
1669/**
1670 * folio_size - The number of bytes in a folio.
1671 * @folio: The folio.
1672 *
1673 * Context: The caller should have a reference on the folio to prevent
1674 * it from being split. It is not necessary for the folio to be locked.
1675 * Return: The number of bytes in this folio.
1676 */
1677static inline size_t folio_size(struct folio *folio)
1678{
1679 return PAGE_SIZE << folio_order(folio);
1680}
1681
b424de33
MWO
1682#ifndef HAVE_ARCH_MAKE_PAGE_ACCESSIBLE
1683static inline int arch_make_page_accessible(struct page *page)
1684{
1685 return 0;
1686}
1687#endif
1688
1689#ifndef HAVE_ARCH_MAKE_FOLIO_ACCESSIBLE
1690static inline int arch_make_folio_accessible(struct folio *folio)
1691{
1692 int ret;
1693 long i, nr = folio_nr_pages(folio);
1694
1695 for (i = 0; i < nr; i++) {
1696 ret = arch_make_page_accessible(folio_page(folio, i));
1697 if (ret)
1698 break;
1699 }
1700
1701 return ret;
1702}
1703#endif
1704
f6ac2354
CL
1705/*
1706 * Some inline functions in vmstat.h depend on page_zone()
1707 */
1708#include <linux/vmstat.h>
1709
33dd4e0e 1710static __always_inline void *lowmem_page_address(const struct page *page)
1da177e4 1711{
1dff8083 1712 return page_to_virt(page);
1da177e4
LT
1713}
1714
1715#if defined(CONFIG_HIGHMEM) && !defined(WANT_PAGE_VIRTUAL)
1716#define HASHED_PAGE_VIRTUAL
1717#endif
1718
1719#if defined(WANT_PAGE_VIRTUAL)
f92f455f
GU
1720static inline void *page_address(const struct page *page)
1721{
1722 return page->virtual;
1723}
1724static inline void set_page_address(struct page *page, void *address)
1725{
1726 page->virtual = address;
1727}
1da177e4
LT
1728#define page_address_init() do { } while(0)
1729#endif
1730
1731#if defined(HASHED_PAGE_VIRTUAL)
f9918794 1732void *page_address(const struct page *page);
1da177e4
LT
1733void set_page_address(struct page *page, void *virtual);
1734void page_address_init(void);
1735#endif
1736
1737#if !defined(HASHED_PAGE_VIRTUAL) && !defined(WANT_PAGE_VIRTUAL)
1738#define page_address(page) lowmem_page_address(page)
1739#define set_page_address(page, address) do { } while(0)
1740#define page_address_init() do { } while(0)
1741#endif
1742
7d4203c1
VB
1743static inline void *folio_address(const struct folio *folio)
1744{
1745 return page_address(&folio->page);
1746}
1747
e39155ea 1748extern void *page_rmapping(struct page *page);
f6ab1f7f
HY
1749extern pgoff_t __page_file_index(struct page *page);
1750
1da177e4
LT
1751/*
1752 * Return the pagecache index of the passed page. Regular pagecache pages
f6ab1f7f 1753 * use ->index whereas swapcache pages use swp_offset(->private)
1da177e4
LT
1754 */
1755static inline pgoff_t page_index(struct page *page)
1756{
1757 if (unlikely(PageSwapCache(page)))
f6ab1f7f 1758 return __page_file_index(page);
1da177e4
LT
1759 return page->index;
1760}
1761
1aa8aea5 1762bool page_mapped(struct page *page);
dd10ab04 1763bool folio_mapped(struct folio *folio);
1da177e4 1764
2f064f34
MH
1765/*
1766 * Return true only if the page has been allocated with
1767 * ALLOC_NO_WATERMARKS and the low watermark was not
1768 * met implying that the system is under some pressure.
1769 */
1d7bab6a 1770static inline bool page_is_pfmemalloc(const struct page *page)
2f064f34
MH
1771{
1772 /*
c07aea3e
MC
1773 * lru.next has bit 1 set if the page is allocated from the
1774 * pfmemalloc reserves. Callers may simply overwrite it if
1775 * they do not need to preserve that information.
2f064f34 1776 */
c07aea3e 1777 return (uintptr_t)page->lru.next & BIT(1);
2f064f34
MH
1778}
1779
1780/*
1781 * Only to be called by the page allocator on a freshly allocated
1782 * page.
1783 */
1784static inline void set_page_pfmemalloc(struct page *page)
1785{
c07aea3e 1786 page->lru.next = (void *)BIT(1);
2f064f34
MH
1787}
1788
1789static inline void clear_page_pfmemalloc(struct page *page)
1790{
c07aea3e 1791 page->lru.next = NULL;
2f064f34
MH
1792}
1793
1c0fe6e3
NP
1794/*
1795 * Can be called by the pagefault handler when it gets a VM_FAULT_OOM.
1796 */
1797extern void pagefault_out_of_memory(void);
1798
1da177e4 1799#define offset_in_page(p) ((unsigned long)(p) & ~PAGE_MASK)
ee6c400f 1800#define offset_in_thp(page, p) ((unsigned long)(p) & (thp_size(page) - 1))
7b230db3 1801#define offset_in_folio(folio, p) ((unsigned long)(p) & (folio_size(folio) - 1))
1da177e4 1802
ddd588b5 1803/*
7bf02ea2 1804 * Flags passed to show_mem() and show_free_areas() to suppress output in
ddd588b5
DR
1805 * various contexts.
1806 */
4b59e6c4 1807#define SHOW_MEM_FILTER_NODES (0x0001u) /* disallowed nodes */
ddd588b5 1808
9af744d7 1809extern void show_free_areas(unsigned int flags, nodemask_t *nodemask);
1da177e4 1810
710ec38b 1811#ifdef CONFIG_MMU
7f43add4 1812extern bool can_do_mlock(void);
710ec38b
AB
1813#else
1814static inline bool can_do_mlock(void) { return false; }
1815#endif
d7c9e99a
AG
1816extern int user_shm_lock(size_t, struct ucounts *);
1817extern void user_shm_unlock(size_t, struct ucounts *);
1da177e4 1818
25b2995a
CH
1819struct page *vm_normal_page(struct vm_area_struct *vma, unsigned long addr,
1820 pte_t pte);
28093f9f
GS
1821struct page *vm_normal_page_pmd(struct vm_area_struct *vma, unsigned long addr,
1822 pmd_t pmd);
7e675137 1823
27d036e3
LR
1824void zap_vma_ptes(struct vm_area_struct *vma, unsigned long address,
1825 unsigned long size);
14f5ff5d 1826void zap_page_range(struct vm_area_struct *vma, unsigned long address,
27d036e3 1827 unsigned long size);
4f74d2c8
LT
1828void unmap_vmas(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
1829 unsigned long start, unsigned long end);
e6473092 1830
ac46d4f3
JG
1831struct mmu_notifier_range;
1832
42b77728 1833void free_pgd_range(struct mmu_gather *tlb, unsigned long addr,
3bf5ee95 1834 unsigned long end, unsigned long floor, unsigned long ceiling);
c78f4636
PX
1835int
1836copy_page_range(struct vm_area_struct *dst_vma, struct vm_area_struct *src_vma);
ff5c19ed 1837int follow_pte(struct mm_struct *mm, unsigned long address,
9fd6dad1 1838 pte_t **ptepp, spinlock_t **ptlp);
3b6748e2
JW
1839int follow_pfn(struct vm_area_struct *vma, unsigned long address,
1840 unsigned long *pfn);
d87fe660 1841int follow_phys(struct vm_area_struct *vma, unsigned long address,
1842 unsigned int flags, unsigned long *prot, resource_size_t *phys);
28b2ee20
RR
1843int generic_access_phys(struct vm_area_struct *vma, unsigned long addr,
1844 void *buf, int len, int write);
1da177e4 1845
7caef267 1846extern void truncate_pagecache(struct inode *inode, loff_t new);
2c27c65e 1847extern void truncate_setsize(struct inode *inode, loff_t newsize);
90a80202 1848void pagecache_isize_extended(struct inode *inode, loff_t from, loff_t to);
623e3db9 1849void truncate_pagecache_range(struct inode *inode, loff_t offset, loff_t end);
25718736 1850int generic_error_remove_page(struct address_space *mapping, struct page *page);
83f78668 1851
7ee1dd3f 1852#ifdef CONFIG_MMU
2b740303 1853extern vm_fault_t handle_mm_fault(struct vm_area_struct *vma,
bce617ed
PX
1854 unsigned long address, unsigned int flags,
1855 struct pt_regs *regs);
64019a2e 1856extern int fixup_user_fault(struct mm_struct *mm,
4a9e1cda
DD
1857 unsigned long address, unsigned int fault_flags,
1858 bool *unlocked);
977fbdcd
MW
1859void unmap_mapping_pages(struct address_space *mapping,
1860 pgoff_t start, pgoff_t nr, bool even_cows);
1861void unmap_mapping_range(struct address_space *mapping,
1862 loff_t const holebegin, loff_t const holelen, int even_cows);
7ee1dd3f 1863#else
2b740303 1864static inline vm_fault_t handle_mm_fault(struct vm_area_struct *vma,
bce617ed
PX
1865 unsigned long address, unsigned int flags,
1866 struct pt_regs *regs)
7ee1dd3f
DH
1867{
1868 /* should never happen if there's no MMU */
1869 BUG();
1870 return VM_FAULT_SIGBUS;
1871}
64019a2e 1872static inline int fixup_user_fault(struct mm_struct *mm, unsigned long address,
4a9e1cda 1873 unsigned int fault_flags, bool *unlocked)
5c723ba5
PZ
1874{
1875 /* should never happen if there's no MMU */
1876 BUG();
1877 return -EFAULT;
1878}
977fbdcd
MW
1879static inline void unmap_mapping_pages(struct address_space *mapping,
1880 pgoff_t start, pgoff_t nr, bool even_cows) { }
1881static inline void unmap_mapping_range(struct address_space *mapping,
1882 loff_t const holebegin, loff_t const holelen, int even_cows) { }
7ee1dd3f 1883#endif
f33ea7f4 1884
977fbdcd
MW
1885static inline void unmap_shared_mapping_range(struct address_space *mapping,
1886 loff_t const holebegin, loff_t const holelen)
1887{
1888 unmap_mapping_range(mapping, holebegin, holelen, 0);
1889}
1890
1891extern int access_process_vm(struct task_struct *tsk, unsigned long addr,
1892 void *buf, int len, unsigned int gup_flags);
5ddd36b9 1893extern int access_remote_vm(struct mm_struct *mm, unsigned long addr,
6347e8d5 1894 void *buf, int len, unsigned int gup_flags);
d3f5ffca
JH
1895extern int __access_remote_vm(struct mm_struct *mm, unsigned long addr,
1896 void *buf, int len, unsigned int gup_flags);
1da177e4 1897
64019a2e 1898long get_user_pages_remote(struct mm_struct *mm,
1e987790 1899 unsigned long start, unsigned long nr_pages,
9beae1ea 1900 unsigned int gup_flags, struct page **pages,
5b56d49f 1901 struct vm_area_struct **vmas, int *locked);
64019a2e 1902long pin_user_pages_remote(struct mm_struct *mm,
eddb1c22
JH
1903 unsigned long start, unsigned long nr_pages,
1904 unsigned int gup_flags, struct page **pages,
1905 struct vm_area_struct **vmas, int *locked);
c12d2da5 1906long get_user_pages(unsigned long start, unsigned long nr_pages,
768ae309 1907 unsigned int gup_flags, struct page **pages,
cde70140 1908 struct vm_area_struct **vmas);
eddb1c22
JH
1909long pin_user_pages(unsigned long start, unsigned long nr_pages,
1910 unsigned int gup_flags, struct page **pages,
1911 struct vm_area_struct **vmas);
c12d2da5 1912long get_user_pages_unlocked(unsigned long start, unsigned long nr_pages,
c164154f 1913 struct page **pages, unsigned int gup_flags);
91429023
JH
1914long pin_user_pages_unlocked(unsigned long start, unsigned long nr_pages,
1915 struct page **pages, unsigned int gup_flags);
9a4e9f3b 1916
73b0140b
IW
1917int get_user_pages_fast(unsigned long start, int nr_pages,
1918 unsigned int gup_flags, struct page **pages);
eddb1c22
JH
1919int pin_user_pages_fast(unsigned long start, int nr_pages,
1920 unsigned int gup_flags, struct page **pages);
8025e5dd 1921
79eb597c
DJ
1922int account_locked_vm(struct mm_struct *mm, unsigned long pages, bool inc);
1923int __account_locked_vm(struct mm_struct *mm, unsigned long pages, bool inc,
1924 struct task_struct *task, bool bypass_rlim);
1925
18022c5d
MG
1926struct kvec;
1927int get_kernel_pages(const struct kvec *iov, int nr_pages, int write,
1928 struct page **pages);
f3e8fccd 1929struct page *get_dump_page(unsigned long addr);
1da177e4 1930
b5e84594
MWO
1931bool folio_mark_dirty(struct folio *folio);
1932bool set_page_dirty(struct page *page);
1da177e4 1933int set_page_dirty_lock(struct page *page);
b9ea2515 1934
a9090253 1935int get_cmdline(struct task_struct *task, char *buffer, int buflen);
1da177e4 1936
b6a2fea3
OW
1937extern unsigned long move_page_tables(struct vm_area_struct *vma,
1938 unsigned long old_addr, struct vm_area_struct *new_vma,
38a76013
ML
1939 unsigned long new_addr, unsigned long len,
1940 bool need_rmap_locks);
58705444
PX
1941
1942/*
1943 * Flags used by change_protection(). For now we make it a bitmap so
1944 * that we can pass in multiple flags just like parameters. However
1945 * for now all the callers are only use one of the flags at the same
1946 * time.
1947 */
64fe24a3
DH
1948/*
1949 * Whether we should manually check if we can map individual PTEs writable,
1950 * because something (e.g., COW, uffd-wp) blocks that from happening for all
1951 * PTEs automatically in a writable mapping.
1952 */
1953#define MM_CP_TRY_CHANGE_WRITABLE (1UL << 0)
58705444
PX
1954/* Whether this protection change is for NUMA hints */
1955#define MM_CP_PROT_NUMA (1UL << 1)
292924b2
PX
1956/* Whether this change is for write protecting */
1957#define MM_CP_UFFD_WP (1UL << 2) /* do wp */
1958#define MM_CP_UFFD_WP_RESOLVE (1UL << 3) /* Resolve wp */
1959#define MM_CP_UFFD_WP_ALL (MM_CP_UFFD_WP | \
1960 MM_CP_UFFD_WP_RESOLVE)
58705444 1961
4a18419f
NA
1962extern unsigned long change_protection(struct mmu_gather *tlb,
1963 struct vm_area_struct *vma, unsigned long start,
7da4d641 1964 unsigned long end, pgprot_t newprot,
58705444 1965 unsigned long cp_flags);
4a18419f 1966extern int mprotect_fixup(struct mmu_gather *tlb, struct vm_area_struct *vma,
b6a2fea3
OW
1967 struct vm_area_struct **pprev, unsigned long start,
1968 unsigned long end, unsigned long newflags);
1da177e4 1969
465a454f
PZ
1970/*
1971 * doesn't attempt to fault and will return short.
1972 */
dadbb612
SJ
1973int get_user_pages_fast_only(unsigned long start, int nr_pages,
1974 unsigned int gup_flags, struct page **pages);
104acc32
JH
1975int pin_user_pages_fast_only(unsigned long start, int nr_pages,
1976 unsigned int gup_flags, struct page **pages);
dadbb612
SJ
1977
1978static inline bool get_user_page_fast_only(unsigned long addr,
1979 unsigned int gup_flags, struct page **pagep)
1980{
1981 return get_user_pages_fast_only(addr, 1, gup_flags, pagep) == 1;
1982}
d559db08
KH
1983/*
1984 * per-process(per-mm_struct) statistics.
1985 */
d559db08
KH
1986static inline unsigned long get_mm_counter(struct mm_struct *mm, int member)
1987{
69c97823
KK
1988 long val = atomic_long_read(&mm->rss_stat.count[member]);
1989
1990#ifdef SPLIT_RSS_COUNTING
1991 /*
1992 * counter is updated in asynchronous manner and may go to minus.
1993 * But it's never be expected number for users.
1994 */
1995 if (val < 0)
1996 val = 0;
172703b0 1997#endif
69c97823
KK
1998 return (unsigned long)val;
1999}
d559db08 2000
e4dcad20 2001void mm_trace_rss_stat(struct mm_struct *mm, int member, long count);
b3d1411b 2002
d559db08
KH
2003static inline void add_mm_counter(struct mm_struct *mm, int member, long value)
2004{
b3d1411b
JFG
2005 long count = atomic_long_add_return(value, &mm->rss_stat.count[member]);
2006
e4dcad20 2007 mm_trace_rss_stat(mm, member, count);
d559db08
KH
2008}
2009
2010static inline void inc_mm_counter(struct mm_struct *mm, int member)
2011{
b3d1411b
JFG
2012 long count = atomic_long_inc_return(&mm->rss_stat.count[member]);
2013
e4dcad20 2014 mm_trace_rss_stat(mm, member, count);
d559db08
KH
2015}
2016
2017static inline void dec_mm_counter(struct mm_struct *mm, int member)
2018{
b3d1411b
JFG
2019 long count = atomic_long_dec_return(&mm->rss_stat.count[member]);
2020
e4dcad20 2021 mm_trace_rss_stat(mm, member, count);
d559db08
KH
2022}
2023
eca56ff9
JM
2024/* Optimized variant when page is already known not to be PageAnon */
2025static inline int mm_counter_file(struct page *page)
2026{
2027 if (PageSwapBacked(page))
2028 return MM_SHMEMPAGES;
2029 return MM_FILEPAGES;
2030}
2031
2032static inline int mm_counter(struct page *page)
2033{
2034 if (PageAnon(page))
2035 return MM_ANONPAGES;
2036 return mm_counter_file(page);
2037}
2038
d559db08
KH
2039static inline unsigned long get_mm_rss(struct mm_struct *mm)
2040{
2041 return get_mm_counter(mm, MM_FILEPAGES) +
eca56ff9
JM
2042 get_mm_counter(mm, MM_ANONPAGES) +
2043 get_mm_counter(mm, MM_SHMEMPAGES);
d559db08
KH
2044}
2045
2046static inline unsigned long get_mm_hiwater_rss(struct mm_struct *mm)
2047{
2048 return max(mm->hiwater_rss, get_mm_rss(mm));
2049}
2050
2051static inline unsigned long get_mm_hiwater_vm(struct mm_struct *mm)
2052{
2053 return max(mm->hiwater_vm, mm->total_vm);
2054}
2055
2056static inline void update_hiwater_rss(struct mm_struct *mm)
2057{
2058 unsigned long _rss = get_mm_rss(mm);
2059
2060 if ((mm)->hiwater_rss < _rss)
2061 (mm)->hiwater_rss = _rss;
2062}
2063
2064static inline void update_hiwater_vm(struct mm_struct *mm)
2065{
2066 if (mm->hiwater_vm < mm->total_vm)
2067 mm->hiwater_vm = mm->total_vm;
2068}
2069
695f0559
PC
2070static inline void reset_mm_hiwater_rss(struct mm_struct *mm)
2071{
2072 mm->hiwater_rss = get_mm_rss(mm);
2073}
2074
d559db08
KH
2075static inline void setmax_mm_hiwater_rss(unsigned long *maxrss,
2076 struct mm_struct *mm)
2077{
2078 unsigned long hiwater_rss = get_mm_hiwater_rss(mm);
2079
2080 if (*maxrss < hiwater_rss)
2081 *maxrss = hiwater_rss;
2082}
2083
53bddb4e 2084#if defined(SPLIT_RSS_COUNTING)
05af2e10 2085void sync_mm_rss(struct mm_struct *mm);
53bddb4e 2086#else
05af2e10 2087static inline void sync_mm_rss(struct mm_struct *mm)
53bddb4e
KH
2088{
2089}
2090#endif
465a454f 2091
78e7c5af
AK
2092#ifndef CONFIG_ARCH_HAS_PTE_SPECIAL
2093static inline int pte_special(pte_t pte)
2094{
2095 return 0;
2096}
2097
2098static inline pte_t pte_mkspecial(pte_t pte)
2099{
2100 return pte;
2101}
2102#endif
2103
17596731 2104#ifndef CONFIG_ARCH_HAS_PTE_DEVMAP
3565fce3
DW
2105static inline int pte_devmap(pte_t pte)
2106{
2107 return 0;
2108}
2109#endif
2110
6d2329f8 2111int vma_wants_writenotify(struct vm_area_struct *vma, pgprot_t vm_page_prot);
d08b3851 2112
25ca1d6c
NK
2113extern pte_t *__get_locked_pte(struct mm_struct *mm, unsigned long addr,
2114 spinlock_t **ptl);
2115static inline pte_t *get_locked_pte(struct mm_struct *mm, unsigned long addr,
2116 spinlock_t **ptl)
2117{
2118 pte_t *ptep;
2119 __cond_lock(*ptl, ptep = __get_locked_pte(mm, addr, ptl));
2120 return ptep;
2121}
c9cfcddf 2122
c2febafc
KS
2123#ifdef __PAGETABLE_P4D_FOLDED
2124static inline int __p4d_alloc(struct mm_struct *mm, pgd_t *pgd,
2125 unsigned long address)
2126{
2127 return 0;
2128}
2129#else
2130int __p4d_alloc(struct mm_struct *mm, pgd_t *pgd, unsigned long address);
2131#endif
2132
b4e98d9a 2133#if defined(__PAGETABLE_PUD_FOLDED) || !defined(CONFIG_MMU)
c2febafc 2134static inline int __pud_alloc(struct mm_struct *mm, p4d_t *p4d,
5f22df00
NP
2135 unsigned long address)
2136{
2137 return 0;
2138}
b4e98d9a
KS
2139static inline void mm_inc_nr_puds(struct mm_struct *mm) {}
2140static inline void mm_dec_nr_puds(struct mm_struct *mm) {}
2141
5f22df00 2142#else
c2febafc 2143int __pud_alloc(struct mm_struct *mm, p4d_t *p4d, unsigned long address);
b4e98d9a 2144
b4e98d9a
KS
2145static inline void mm_inc_nr_puds(struct mm_struct *mm)
2146{
6d212db1
MS
2147 if (mm_pud_folded(mm))
2148 return;
af5b0f6a 2149 atomic_long_add(PTRS_PER_PUD * sizeof(pud_t), &mm->pgtables_bytes);
b4e98d9a
KS
2150}
2151
2152static inline void mm_dec_nr_puds(struct mm_struct *mm)
2153{
6d212db1
MS
2154 if (mm_pud_folded(mm))
2155 return;
af5b0f6a 2156 atomic_long_sub(PTRS_PER_PUD * sizeof(pud_t), &mm->pgtables_bytes);
b4e98d9a 2157}
5f22df00
NP
2158#endif
2159
2d2f5119 2160#if defined(__PAGETABLE_PMD_FOLDED) || !defined(CONFIG_MMU)
5f22df00
NP
2161static inline int __pmd_alloc(struct mm_struct *mm, pud_t *pud,
2162 unsigned long address)
2163{
2164 return 0;
2165}
dc6c9a35 2166
dc6c9a35
KS
2167static inline void mm_inc_nr_pmds(struct mm_struct *mm) {}
2168static inline void mm_dec_nr_pmds(struct mm_struct *mm) {}
2169
5f22df00 2170#else
1bb3630e 2171int __pmd_alloc(struct mm_struct *mm, pud_t *pud, unsigned long address);
dc6c9a35 2172
dc6c9a35
KS
2173static inline void mm_inc_nr_pmds(struct mm_struct *mm)
2174{
6d212db1
MS
2175 if (mm_pmd_folded(mm))
2176 return;
af5b0f6a 2177 atomic_long_add(PTRS_PER_PMD * sizeof(pmd_t), &mm->pgtables_bytes);
dc6c9a35
KS
2178}
2179
2180static inline void mm_dec_nr_pmds(struct mm_struct *mm)
2181{
6d212db1
MS
2182 if (mm_pmd_folded(mm))
2183 return;
af5b0f6a 2184 atomic_long_sub(PTRS_PER_PMD * sizeof(pmd_t), &mm->pgtables_bytes);
dc6c9a35 2185}
5f22df00
NP
2186#endif
2187
c4812909 2188#ifdef CONFIG_MMU
af5b0f6a 2189static inline void mm_pgtables_bytes_init(struct mm_struct *mm)
c4812909 2190{
af5b0f6a 2191 atomic_long_set(&mm->pgtables_bytes, 0);
c4812909
KS
2192}
2193
af5b0f6a 2194static inline unsigned long mm_pgtables_bytes(const struct mm_struct *mm)
c4812909 2195{
af5b0f6a 2196 return atomic_long_read(&mm->pgtables_bytes);
c4812909
KS
2197}
2198
2199static inline void mm_inc_nr_ptes(struct mm_struct *mm)
2200{
af5b0f6a 2201 atomic_long_add(PTRS_PER_PTE * sizeof(pte_t), &mm->pgtables_bytes);
c4812909
KS
2202}
2203
2204static inline void mm_dec_nr_ptes(struct mm_struct *mm)
2205{
af5b0f6a 2206 atomic_long_sub(PTRS_PER_PTE * sizeof(pte_t), &mm->pgtables_bytes);
c4812909
KS
2207}
2208#else
c4812909 2209
af5b0f6a
KS
2210static inline void mm_pgtables_bytes_init(struct mm_struct *mm) {}
2211static inline unsigned long mm_pgtables_bytes(const struct mm_struct *mm)
c4812909
KS
2212{
2213 return 0;
2214}
2215
2216static inline void mm_inc_nr_ptes(struct mm_struct *mm) {}
2217static inline void mm_dec_nr_ptes(struct mm_struct *mm) {}
2218#endif
2219
4cf58924
JFG
2220int __pte_alloc(struct mm_struct *mm, pmd_t *pmd);
2221int __pte_alloc_kernel(pmd_t *pmd);
1bb3630e 2222
f949286c
MR
2223#if defined(CONFIG_MMU)
2224
c2febafc
KS
2225static inline p4d_t *p4d_alloc(struct mm_struct *mm, pgd_t *pgd,
2226 unsigned long address)
2227{
2228 return (unlikely(pgd_none(*pgd)) && __p4d_alloc(mm, pgd, address)) ?
2229 NULL : p4d_offset(pgd, address);
2230}
2231
2232static inline pud_t *pud_alloc(struct mm_struct *mm, p4d_t *p4d,
2233 unsigned long address)
1da177e4 2234{
c2febafc
KS
2235 return (unlikely(p4d_none(*p4d)) && __pud_alloc(mm, p4d, address)) ?
2236 NULL : pud_offset(p4d, address);
1da177e4 2237}
d8626138 2238
1da177e4
LT
2239static inline pmd_t *pmd_alloc(struct mm_struct *mm, pud_t *pud, unsigned long address)
2240{
1bb3630e
HD
2241 return (unlikely(pud_none(*pud)) && __pmd_alloc(mm, pud, address))?
2242 NULL: pmd_offset(pud, address);
1da177e4 2243}
f949286c 2244#endif /* CONFIG_MMU */
1bb3630e 2245
57c1ffce 2246#if USE_SPLIT_PTE_PTLOCKS
597d795a 2247#if ALLOC_SPLIT_PTLOCKS
b35f1819 2248void __init ptlock_cache_init(void);
539edb58
PZ
2249extern bool ptlock_alloc(struct page *page);
2250extern void ptlock_free(struct page *page);
2251
2252static inline spinlock_t *ptlock_ptr(struct page *page)
2253{
2254 return page->ptl;
2255}
597d795a 2256#else /* ALLOC_SPLIT_PTLOCKS */
b35f1819
KS
2257static inline void ptlock_cache_init(void)
2258{
2259}
2260
49076ec2
KS
2261static inline bool ptlock_alloc(struct page *page)
2262{
49076ec2
KS
2263 return true;
2264}
539edb58 2265
49076ec2
KS
2266static inline void ptlock_free(struct page *page)
2267{
49076ec2
KS
2268}
2269
2270static inline spinlock_t *ptlock_ptr(struct page *page)
2271{
539edb58 2272 return &page->ptl;
49076ec2 2273}
597d795a 2274#endif /* ALLOC_SPLIT_PTLOCKS */
49076ec2
KS
2275
2276static inline spinlock_t *pte_lockptr(struct mm_struct *mm, pmd_t *pmd)
2277{
2278 return ptlock_ptr(pmd_page(*pmd));
2279}
2280
2281static inline bool ptlock_init(struct page *page)
2282{
2283 /*
2284 * prep_new_page() initialize page->private (and therefore page->ptl)
2285 * with 0. Make sure nobody took it in use in between.
2286 *
2287 * It can happen if arch try to use slab for page table allocation:
1d798ca3 2288 * slab code uses page->slab_cache, which share storage with page->ptl.
49076ec2 2289 */
309381fe 2290 VM_BUG_ON_PAGE(*(unsigned long *)&page->ptl, page);
49076ec2
KS
2291 if (!ptlock_alloc(page))
2292 return false;
2293 spin_lock_init(ptlock_ptr(page));
2294 return true;
2295}
2296
57c1ffce 2297#else /* !USE_SPLIT_PTE_PTLOCKS */
4c21e2f2
HD
2298/*
2299 * We use mm->page_table_lock to guard all pagetable pages of the mm.
2300 */
49076ec2
KS
2301static inline spinlock_t *pte_lockptr(struct mm_struct *mm, pmd_t *pmd)
2302{
2303 return &mm->page_table_lock;
2304}
b35f1819 2305static inline void ptlock_cache_init(void) {}
49076ec2 2306static inline bool ptlock_init(struct page *page) { return true; }
9e247bab 2307static inline void ptlock_free(struct page *page) {}
57c1ffce 2308#endif /* USE_SPLIT_PTE_PTLOCKS */
4c21e2f2 2309
b35f1819
KS
2310static inline void pgtable_init(void)
2311{
2312 ptlock_cache_init();
2313 pgtable_cache_init();
2314}
2315
b4ed71f5 2316static inline bool pgtable_pte_page_ctor(struct page *page)
2f569afd 2317{
706874e9
VD
2318 if (!ptlock_init(page))
2319 return false;
1d40a5ea 2320 __SetPageTable(page);
f0c0c115 2321 inc_lruvec_page_state(page, NR_PAGETABLE);
706874e9 2322 return true;
2f569afd
MS
2323}
2324
b4ed71f5 2325static inline void pgtable_pte_page_dtor(struct page *page)
2f569afd 2326{
9e247bab 2327 ptlock_free(page);
1d40a5ea 2328 __ClearPageTable(page);
f0c0c115 2329 dec_lruvec_page_state(page, NR_PAGETABLE);
2f569afd
MS
2330}
2331
c74df32c
HD
2332#define pte_offset_map_lock(mm, pmd, address, ptlp) \
2333({ \
4c21e2f2 2334 spinlock_t *__ptl = pte_lockptr(mm, pmd); \
c74df32c
HD
2335 pte_t *__pte = pte_offset_map(pmd, address); \
2336 *(ptlp) = __ptl; \
2337 spin_lock(__ptl); \
2338 __pte; \
2339})
2340
2341#define pte_unmap_unlock(pte, ptl) do { \
2342 spin_unlock(ptl); \
2343 pte_unmap(pte); \
2344} while (0)
2345
4cf58924 2346#define pte_alloc(mm, pmd) (unlikely(pmd_none(*(pmd))) && __pte_alloc(mm, pmd))
3ed3a4f0
KS
2347
2348#define pte_alloc_map(mm, pmd, address) \
4cf58924 2349 (pte_alloc(mm, pmd) ? NULL : pte_offset_map(pmd, address))
1bb3630e 2350
c74df32c 2351#define pte_alloc_map_lock(mm, pmd, address, ptlp) \
4cf58924 2352 (pte_alloc(mm, pmd) ? \
3ed3a4f0 2353 NULL : pte_offset_map_lock(mm, pmd, address, ptlp))
c74df32c 2354
1bb3630e 2355#define pte_alloc_kernel(pmd, address) \
4cf58924 2356 ((unlikely(pmd_none(*(pmd))) && __pte_alloc_kernel(pmd))? \
1bb3630e 2357 NULL: pte_offset_kernel(pmd, address))
1da177e4 2358
e009bb30
KS
2359#if USE_SPLIT_PMD_PTLOCKS
2360
634391ac
MS
2361static struct page *pmd_to_page(pmd_t *pmd)
2362{
2363 unsigned long mask = ~(PTRS_PER_PMD * sizeof(pmd_t) - 1);
2364 return virt_to_page((void *)((unsigned long) pmd & mask));
2365}
2366
e009bb30
KS
2367static inline spinlock_t *pmd_lockptr(struct mm_struct *mm, pmd_t *pmd)
2368{
634391ac 2369 return ptlock_ptr(pmd_to_page(pmd));
e009bb30
KS
2370}
2371
b2b29d6d 2372static inline bool pmd_ptlock_init(struct page *page)
e009bb30 2373{
e009bb30
KS
2374#ifdef CONFIG_TRANSPARENT_HUGEPAGE
2375 page->pmd_huge_pte = NULL;
2376#endif
49076ec2 2377 return ptlock_init(page);
e009bb30
KS
2378}
2379
b2b29d6d 2380static inline void pmd_ptlock_free(struct page *page)
e009bb30
KS
2381{
2382#ifdef CONFIG_TRANSPARENT_HUGEPAGE
309381fe 2383 VM_BUG_ON_PAGE(page->pmd_huge_pte, page);
e009bb30 2384#endif
49076ec2 2385 ptlock_free(page);
e009bb30
KS
2386}
2387
634391ac 2388#define pmd_huge_pte(mm, pmd) (pmd_to_page(pmd)->pmd_huge_pte)
e009bb30
KS
2389
2390#else
2391
9a86cb7b
KS
2392static inline spinlock_t *pmd_lockptr(struct mm_struct *mm, pmd_t *pmd)
2393{
2394 return &mm->page_table_lock;
2395}
2396
b2b29d6d
MW
2397static inline bool pmd_ptlock_init(struct page *page) { return true; }
2398static inline void pmd_ptlock_free(struct page *page) {}
e009bb30 2399
c389a250 2400#define pmd_huge_pte(mm, pmd) ((mm)->pmd_huge_pte)
9a86cb7b 2401
e009bb30
KS
2402#endif
2403
9a86cb7b
KS
2404static inline spinlock_t *pmd_lock(struct mm_struct *mm, pmd_t *pmd)
2405{
2406 spinlock_t *ptl = pmd_lockptr(mm, pmd);
2407 spin_lock(ptl);
2408 return ptl;
2409}
2410
b2b29d6d
MW
2411static inline bool pgtable_pmd_page_ctor(struct page *page)
2412{
2413 if (!pmd_ptlock_init(page))
2414 return false;
2415 __SetPageTable(page);
f0c0c115 2416 inc_lruvec_page_state(page, NR_PAGETABLE);
b2b29d6d
MW
2417 return true;
2418}
2419
2420static inline void pgtable_pmd_page_dtor(struct page *page)
2421{
2422 pmd_ptlock_free(page);
2423 __ClearPageTable(page);
f0c0c115 2424 dec_lruvec_page_state(page, NR_PAGETABLE);
b2b29d6d
MW
2425}
2426
a00cc7d9
MW
2427/*
2428 * No scalability reason to split PUD locks yet, but follow the same pattern
2429 * as the PMD locks to make it easier if we decide to. The VM should not be
2430 * considered ready to switch to split PUD locks yet; there may be places
2431 * which need to be converted from page_table_lock.
2432 */
2433static inline spinlock_t *pud_lockptr(struct mm_struct *mm, pud_t *pud)
2434{
2435 return &mm->page_table_lock;
2436}
2437
2438static inline spinlock_t *pud_lock(struct mm_struct *mm, pud_t *pud)
2439{
2440 spinlock_t *ptl = pud_lockptr(mm, pud);
2441
2442 spin_lock(ptl);
2443 return ptl;
2444}
62906027 2445
a00cc7d9 2446extern void __init pagecache_init(void);
49a7f04a
DH
2447extern void free_initmem(void);
2448
69afade7
JL
2449/*
2450 * Free reserved pages within range [PAGE_ALIGN(start), end & PAGE_MASK)
2451 * into the buddy system. The freed pages will be poisoned with pattern
dbe67df4 2452 * "poison" if it's within range [0, UCHAR_MAX].
69afade7
JL
2453 * Return pages freed into the buddy system.
2454 */
11199692 2455extern unsigned long free_reserved_area(void *start, void *end,
e5cb113f 2456 int poison, const char *s);
c3d5f5f0 2457
c3d5f5f0 2458extern void adjust_managed_page_count(struct page *page, long count);
1f9d03c5 2459extern void mem_init_print_info(void);
69afade7 2460
4b50bcc7 2461extern void reserve_bootmem_region(phys_addr_t start, phys_addr_t end);
92923ca3 2462
69afade7 2463/* Free the reserved page into the buddy system, so it gets managed. */
a0cd7a7c 2464static inline void free_reserved_page(struct page *page)
69afade7
JL
2465{
2466 ClearPageReserved(page);
2467 init_page_count(page);
2468 __free_page(page);
69afade7
JL
2469 adjust_managed_page_count(page, 1);
2470}
a0cd7a7c 2471#define free_highmem_page(page) free_reserved_page(page)
69afade7
JL
2472
2473static inline void mark_page_reserved(struct page *page)
2474{
2475 SetPageReserved(page);
2476 adjust_managed_page_count(page, -1);
2477}
2478
2479/*
2480 * Default method to free all the __init memory into the buddy system.
dbe67df4
JL
2481 * The freed pages will be poisoned with pattern "poison" if it's within
2482 * range [0, UCHAR_MAX].
2483 * Return pages freed into the buddy system.
69afade7
JL
2484 */
2485static inline unsigned long free_initmem_default(int poison)
2486{
2487 extern char __init_begin[], __init_end[];
2488
11199692 2489 return free_reserved_area(&__init_begin, &__init_end,
c5a54c70 2490 poison, "unused kernel image (initmem)");
69afade7
JL
2491}
2492
7ee3d4e8
JL
2493static inline unsigned long get_num_physpages(void)
2494{
2495 int nid;
2496 unsigned long phys_pages = 0;
2497
2498 for_each_online_node(nid)
2499 phys_pages += node_present_pages(nid);
2500
2501 return phys_pages;
2502}
2503
c713216d 2504/*
3f08a302 2505 * Using memblock node mappings, an architecture may initialise its
bc9331a1
MR
2506 * zones, allocate the backing mem_map and account for memory holes in an
2507 * architecture independent manner.
c713216d
MG
2508 *
2509 * An architecture is expected to register range of page frames backed by
0ee332c1 2510 * physical memory with memblock_add[_node]() before calling
9691a071 2511 * free_area_init() passing in the PFN each zone ends at. At a basic
c713216d
MG
2512 * usage, an architecture is expected to do something like
2513 *
2514 * unsigned long max_zone_pfns[MAX_NR_ZONES] = {max_dma, max_normal_pfn,
2515 * max_highmem_pfn};
2516 * for_each_valid_physical_page_range()
952eea9b 2517 * memblock_add_node(base, size, nid, MEMBLOCK_NONE)
9691a071 2518 * free_area_init(max_zone_pfns);
c713216d 2519 */
9691a071 2520void free_area_init(unsigned long *max_zone_pfn);
1e01979c 2521unsigned long node_map_pfn_alignment(void);
32996250
YL
2522unsigned long __absent_pages_in_range(int nid, unsigned long start_pfn,
2523 unsigned long end_pfn);
c713216d
MG
2524extern unsigned long absent_pages_in_range(unsigned long start_pfn,
2525 unsigned long end_pfn);
2526extern void get_pfn_range_for_nid(unsigned int nid,
2527 unsigned long *start_pfn, unsigned long *end_pfn);
f2dbcfa7 2528
a9ee6cf5 2529#ifndef CONFIG_NUMA
6f24fbd3 2530static inline int early_pfn_to_nid(unsigned long pfn)
f2dbcfa7
KH
2531{
2532 return 0;
2533}
2534#else
2535/* please see mm/page_alloc.c */
2536extern int __meminit early_pfn_to_nid(unsigned long pfn);
f2dbcfa7
KH
2537#endif
2538
0e0b864e 2539extern void set_dma_reserve(unsigned long new_dma_reserve);
ab28cb6e 2540extern void memmap_init_range(unsigned long, int, unsigned long,
dc2da7b4
BH
2541 unsigned long, unsigned long, enum meminit_context,
2542 struct vmem_altmap *, int migratetype);
bc75d33f 2543extern void setup_per_zone_wmarks(void);
bd3400ea 2544extern void calculate_min_free_kbytes(void);
1b79acc9 2545extern int __meminit init_per_zone_wmark_min(void);
1da177e4 2546extern void mem_init(void);
8feae131 2547extern void __init mmap_init(void);
9af744d7 2548extern void show_mem(unsigned int flags, nodemask_t *nodemask);
d02bd27b 2549extern long si_mem_available(void);
1da177e4
LT
2550extern void si_meminfo(struct sysinfo * val);
2551extern void si_meminfo_node(struct sysinfo *val, int nid);
f6f34b43
SD
2552#ifdef __HAVE_ARCH_RESERVED_KERNEL_PAGES
2553extern unsigned long arch_reserved_kernel_pages(void);
2554#endif
1da177e4 2555
a8e99259
MH
2556extern __printf(3, 4)
2557void warn_alloc(gfp_t gfp_mask, nodemask_t *nodemask, const char *fmt, ...);
a238ab5b 2558
e7c8d5c9 2559extern void setup_per_cpu_pageset(void);
e7c8d5c9 2560
75f7ad8e
PS
2561/* page_alloc.c */
2562extern int min_free_kbytes;
1c30844d 2563extern int watermark_boost_factor;
795ae7a0 2564extern int watermark_scale_factor;
51930df5 2565extern bool arch_has_descending_max_zone_pfns(void);
75f7ad8e 2566
8feae131 2567/* nommu.c */
33e5d769 2568extern atomic_long_t mmap_pages_allocated;
7e660872 2569extern int nommu_shrink_inode_mappings(struct inode *, size_t, size_t);
8feae131 2570
6b2dbba8 2571/* interval_tree.c */
6b2dbba8 2572void vma_interval_tree_insert(struct vm_area_struct *node,
f808c13f 2573 struct rb_root_cached *root);
9826a516
ML
2574void vma_interval_tree_insert_after(struct vm_area_struct *node,
2575 struct vm_area_struct *prev,
f808c13f 2576 struct rb_root_cached *root);
6b2dbba8 2577void vma_interval_tree_remove(struct vm_area_struct *node,
f808c13f
DB
2578 struct rb_root_cached *root);
2579struct vm_area_struct *vma_interval_tree_iter_first(struct rb_root_cached *root,
6b2dbba8
ML
2580 unsigned long start, unsigned long last);
2581struct vm_area_struct *vma_interval_tree_iter_next(struct vm_area_struct *node,
2582 unsigned long start, unsigned long last);
2583
2584#define vma_interval_tree_foreach(vma, root, start, last) \
2585 for (vma = vma_interval_tree_iter_first(root, start, last); \
2586 vma; vma = vma_interval_tree_iter_next(vma, start, last))
1da177e4 2587
bf181b9f 2588void anon_vma_interval_tree_insert(struct anon_vma_chain *node,
f808c13f 2589 struct rb_root_cached *root);
bf181b9f 2590void anon_vma_interval_tree_remove(struct anon_vma_chain *node,
f808c13f
DB
2591 struct rb_root_cached *root);
2592struct anon_vma_chain *
2593anon_vma_interval_tree_iter_first(struct rb_root_cached *root,
2594 unsigned long start, unsigned long last);
bf181b9f
ML
2595struct anon_vma_chain *anon_vma_interval_tree_iter_next(
2596 struct anon_vma_chain *node, unsigned long start, unsigned long last);
ed8ea815
ML
2597#ifdef CONFIG_DEBUG_VM_RB
2598void anon_vma_interval_tree_verify(struct anon_vma_chain *node);
2599#endif
bf181b9f
ML
2600
2601#define anon_vma_interval_tree_foreach(avc, root, start, last) \
2602 for (avc = anon_vma_interval_tree_iter_first(root, start, last); \
2603 avc; avc = anon_vma_interval_tree_iter_next(avc, start, last))
2604
1da177e4 2605/* mmap.c */
34b4e4aa 2606extern int __vm_enough_memory(struct mm_struct *mm, long pages, int cap_sys_admin);
e86f15ee
AA
2607extern int __vma_adjust(struct vm_area_struct *vma, unsigned long start,
2608 unsigned long end, pgoff_t pgoff, struct vm_area_struct *insert,
2609 struct vm_area_struct *expand);
2610static inline int vma_adjust(struct vm_area_struct *vma, unsigned long start,
2611 unsigned long end, pgoff_t pgoff, struct vm_area_struct *insert)
2612{
2613 return __vma_adjust(vma, start, end, pgoff, insert, NULL);
2614}
1da177e4
LT
2615extern struct vm_area_struct *vma_merge(struct mm_struct *,
2616 struct vm_area_struct *prev, unsigned long addr, unsigned long end,
2617 unsigned long vm_flags, struct anon_vma *, struct file *, pgoff_t,
5c26f6ac 2618 struct mempolicy *, struct vm_userfaultfd_ctx, struct anon_vma_name *);
1da177e4 2619extern struct anon_vma *find_mergeable_anon_vma(struct vm_area_struct *);
def5efe0
DR
2620extern int __split_vma(struct mm_struct *, struct vm_area_struct *,
2621 unsigned long addr, int new_below);
2622extern int split_vma(struct mm_struct *, struct vm_area_struct *,
2623 unsigned long addr, int new_below);
1da177e4
LT
2624extern int insert_vm_struct(struct mm_struct *, struct vm_area_struct *);
2625extern void __vma_link_rb(struct mm_struct *, struct vm_area_struct *,
2626 struct rb_node **, struct rb_node *);
a8fb5618 2627extern void unlink_file_vma(struct vm_area_struct *);
1da177e4 2628extern struct vm_area_struct *copy_vma(struct vm_area_struct **,
38a76013
ML
2629 unsigned long addr, unsigned long len, pgoff_t pgoff,
2630 bool *need_rmap_locks);
1da177e4 2631extern void exit_mmap(struct mm_struct *);
925d1c40 2632
9c599024
CG
2633static inline int check_data_rlimit(unsigned long rlim,
2634 unsigned long new,
2635 unsigned long start,
2636 unsigned long end_data,
2637 unsigned long start_data)
2638{
2639 if (rlim < RLIM_INFINITY) {
2640 if (((new - start) + (end_data - start_data)) > rlim)
2641 return -ENOSPC;
2642 }
2643
2644 return 0;
2645}
2646
7906d00c
AA
2647extern int mm_take_all_locks(struct mm_struct *mm);
2648extern void mm_drop_all_locks(struct mm_struct *mm);
2649
fe69d560 2650extern int set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
35d7bdc8 2651extern int replace_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
38646013 2652extern struct file *get_mm_exe_file(struct mm_struct *mm);
cd81a917 2653extern struct file *get_task_exe_file(struct task_struct *task);
925d1c40 2654
84638335
KK
2655extern bool may_expand_vm(struct mm_struct *, vm_flags_t, unsigned long npages);
2656extern void vm_stat_account(struct mm_struct *, vm_flags_t, long npages);
2657
2eefd878
DS
2658extern bool vma_is_special_mapping(const struct vm_area_struct *vma,
2659 const struct vm_special_mapping *sm);
3935ed6a
SS
2660extern struct vm_area_struct *_install_special_mapping(struct mm_struct *mm,
2661 unsigned long addr, unsigned long len,
a62c34bd
AL
2662 unsigned long flags,
2663 const struct vm_special_mapping *spec);
2664/* This is an obsolete alternative to _install_special_mapping. */
fa5dc22f
RM
2665extern int install_special_mapping(struct mm_struct *mm,
2666 unsigned long addr, unsigned long len,
2667 unsigned long flags, struct page **pages);
1da177e4 2668
649775be 2669unsigned long randomize_stack_top(unsigned long stack_top);
5ad7dd88 2670unsigned long randomize_page(unsigned long start, unsigned long range);
649775be 2671
1da177e4
LT
2672extern unsigned long get_unmapped_area(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
2673
0165ab44 2674extern unsigned long mmap_region(struct file *file, unsigned long addr,
897ab3e0
MR
2675 unsigned long len, vm_flags_t vm_flags, unsigned long pgoff,
2676 struct list_head *uf);
1fcfd8db 2677extern unsigned long do_mmap(struct file *file, unsigned long addr,
bebeb3d6 2678 unsigned long len, unsigned long prot, unsigned long flags,
45e55300 2679 unsigned long pgoff, unsigned long *populate, struct list_head *uf);
85a06835
YS
2680extern int __do_munmap(struct mm_struct *, unsigned long, size_t,
2681 struct list_head *uf, bool downgrade);
897ab3e0
MR
2682extern int do_munmap(struct mm_struct *, unsigned long, size_t,
2683 struct list_head *uf);
0726b01e 2684extern int do_madvise(struct mm_struct *mm, unsigned long start, size_t len_in, int behavior);
1da177e4 2685
bebeb3d6
ML
2686#ifdef CONFIG_MMU
2687extern int __mm_populate(unsigned long addr, unsigned long len,
2688 int ignore_errors);
2689static inline void mm_populate(unsigned long addr, unsigned long len)
2690{
2691 /* Ignore errors */
2692 (void) __mm_populate(addr, len, 1);
2693}
2694#else
2695static inline void mm_populate(unsigned long addr, unsigned long len) {}
2696#endif
2697
e4eb1ff6 2698/* These take the mm semaphore themselves */
5d22fc25 2699extern int __must_check vm_brk(unsigned long, unsigned long);
16e72e9b 2700extern int __must_check vm_brk_flags(unsigned long, unsigned long, unsigned long);
bfce281c 2701extern int vm_munmap(unsigned long, size_t);
9fbeb5ab 2702extern unsigned long __must_check vm_mmap(struct file *, unsigned long,
6be5ceb0
LT
2703 unsigned long, unsigned long,
2704 unsigned long, unsigned long);
1da177e4 2705
db4fbfb9
ML
2706struct vm_unmapped_area_info {
2707#define VM_UNMAPPED_AREA_TOPDOWN 1
2708 unsigned long flags;
2709 unsigned long length;
2710 unsigned long low_limit;
2711 unsigned long high_limit;
2712 unsigned long align_mask;
2713 unsigned long align_offset;
2714};
2715
baceaf1c 2716extern unsigned long vm_unmapped_area(struct vm_unmapped_area_info *info);
db4fbfb9 2717
85821aab 2718/* truncate.c */
1da177e4 2719extern void truncate_inode_pages(struct address_space *, loff_t);
d7339071
HR
2720extern void truncate_inode_pages_range(struct address_space *,
2721 loff_t lstart, loff_t lend);
91b0abe3 2722extern void truncate_inode_pages_final(struct address_space *);
1da177e4
LT
2723
2724/* generic vm_area_ops exported for stackable file systems */
2bcd6454 2725extern vm_fault_t filemap_fault(struct vm_fault *vmf);
f9ce0be7 2726extern vm_fault_t filemap_map_pages(struct vm_fault *vmf,
bae473a4 2727 pgoff_t start_pgoff, pgoff_t end_pgoff);
2bcd6454 2728extern vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf);
1da177e4 2729
1be7107f 2730extern unsigned long stack_guard_gap;
d05f3169 2731/* Generic expand stack which grows the stack according to GROWS{UP,DOWN} */
46dea3d0 2732extern int expand_stack(struct vm_area_struct *vma, unsigned long address);
d05f3169 2733
11192337 2734/* CONFIG_STACK_GROWSUP still needs to grow downwards at some places */
d05f3169
MH
2735extern int expand_downwards(struct vm_area_struct *vma,
2736 unsigned long address);
8ca3eb08 2737#if VM_GROWSUP
46dea3d0 2738extern int expand_upwards(struct vm_area_struct *vma, unsigned long address);
8ca3eb08 2739#else
fee7e49d 2740 #define expand_upwards(vma, address) (0)
9ab88515 2741#endif
1da177e4
LT
2742
2743/* Look up the first VMA which satisfies addr < vm_end, NULL if none. */
2744extern struct vm_area_struct * find_vma(struct mm_struct * mm, unsigned long addr);
2745extern struct vm_area_struct * find_vma_prev(struct mm_struct * mm, unsigned long addr,
2746 struct vm_area_struct **pprev);
2747
ce6d42f2
LH
2748/**
2749 * find_vma_intersection() - Look up the first VMA which intersects the interval
2750 * @mm: The process address space.
2751 * @start_addr: The inclusive start user address.
2752 * @end_addr: The exclusive end user address.
2753 *
2754 * Returns: The first VMA within the provided range, %NULL otherwise. Assumes
2755 * start_addr < end_addr.
2756 */
2757static inline
2758struct vm_area_struct *find_vma_intersection(struct mm_struct *mm,
2759 unsigned long start_addr,
2760 unsigned long end_addr)
1da177e4 2761{
ce6d42f2 2762 struct vm_area_struct *vma = find_vma(mm, start_addr);
1da177e4
LT
2763
2764 if (vma && end_addr <= vma->vm_start)
2765 vma = NULL;
2766 return vma;
2767}
2768
ce6d42f2
LH
2769/**
2770 * vma_lookup() - Find a VMA at a specific address
2771 * @mm: The process address space.
2772 * @addr: The user address.
2773 *
2774 * Return: The vm_area_struct at the given address, %NULL otherwise.
2775 */
2776static inline
2777struct vm_area_struct *vma_lookup(struct mm_struct *mm, unsigned long addr)
2778{
2779 struct vm_area_struct *vma = find_vma(mm, addr);
2780
2781 if (vma && addr < vma->vm_start)
2782 vma = NULL;
2783
2784 return vma;
2785}
2786
1be7107f
HD
2787static inline unsigned long vm_start_gap(struct vm_area_struct *vma)
2788{
2789 unsigned long vm_start = vma->vm_start;
2790
2791 if (vma->vm_flags & VM_GROWSDOWN) {
2792 vm_start -= stack_guard_gap;
2793 if (vm_start > vma->vm_start)
2794 vm_start = 0;
2795 }
2796 return vm_start;
2797}
2798
2799static inline unsigned long vm_end_gap(struct vm_area_struct *vma)
2800{
2801 unsigned long vm_end = vma->vm_end;
2802
2803 if (vma->vm_flags & VM_GROWSUP) {
2804 vm_end += stack_guard_gap;
2805 if (vm_end < vma->vm_end)
2806 vm_end = -PAGE_SIZE;
2807 }
2808 return vm_end;
2809}
2810
1da177e4
LT
2811static inline unsigned long vma_pages(struct vm_area_struct *vma)
2812{
2813 return (vma->vm_end - vma->vm_start) >> PAGE_SHIFT;
2814}
2815
640708a2
PE
2816/* Look up the first VMA which exactly match the interval vm_start ... vm_end */
2817static inline struct vm_area_struct *find_exact_vma(struct mm_struct *mm,
2818 unsigned long vm_start, unsigned long vm_end)
2819{
2820 struct vm_area_struct *vma = find_vma(mm, vm_start);
2821
2822 if (vma && (vma->vm_start != vm_start || vma->vm_end != vm_end))
2823 vma = NULL;
2824
2825 return vma;
2826}
2827
017b1660
MK
2828static inline bool range_in_vma(struct vm_area_struct *vma,
2829 unsigned long start, unsigned long end)
2830{
2831 return (vma && vma->vm_start <= start && end <= vma->vm_end);
2832}
2833
bad849b3 2834#ifdef CONFIG_MMU
804af2cf 2835pgprot_t vm_get_page_prot(unsigned long vm_flags);
64e45507 2836void vma_set_page_prot(struct vm_area_struct *vma);
bad849b3
DH
2837#else
2838static inline pgprot_t vm_get_page_prot(unsigned long vm_flags)
2839{
2840 return __pgprot(0);
2841}
64e45507
PF
2842static inline void vma_set_page_prot(struct vm_area_struct *vma)
2843{
2844 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
2845}
bad849b3
DH
2846#endif
2847
295992fb
CK
2848void vma_set_file(struct vm_area_struct *vma, struct file *file);
2849
5877231f 2850#ifdef CONFIG_NUMA_BALANCING
4b10e7d5 2851unsigned long change_prot_numa(struct vm_area_struct *vma,
b24f53a0
LS
2852 unsigned long start, unsigned long end);
2853#endif
2854
deceb6cd 2855struct vm_area_struct *find_extend_vma(struct mm_struct *, unsigned long addr);
deceb6cd
HD
2856int remap_pfn_range(struct vm_area_struct *, unsigned long addr,
2857 unsigned long pfn, unsigned long size, pgprot_t);
74ffa5a3
CH
2858int remap_pfn_range_notrack(struct vm_area_struct *vma, unsigned long addr,
2859 unsigned long pfn, unsigned long size, pgprot_t prot);
a145dd41 2860int vm_insert_page(struct vm_area_struct *, unsigned long addr, struct page *);
8cd3984d
AR
2861int vm_insert_pages(struct vm_area_struct *vma, unsigned long addr,
2862 struct page **pages, unsigned long *num);
a667d745
SJ
2863int vm_map_pages(struct vm_area_struct *vma, struct page **pages,
2864 unsigned long num);
2865int vm_map_pages_zero(struct vm_area_struct *vma, struct page **pages,
2866 unsigned long num);
ae2b01f3 2867vm_fault_t vmf_insert_pfn(struct vm_area_struct *vma, unsigned long addr,
e0dc0d8f 2868 unsigned long pfn);
f5e6d1d5
MW
2869vm_fault_t vmf_insert_pfn_prot(struct vm_area_struct *vma, unsigned long addr,
2870 unsigned long pfn, pgprot_t pgprot);
5d747637 2871vm_fault_t vmf_insert_mixed(struct vm_area_struct *vma, unsigned long addr,
01c8f1c4 2872 pfn_t pfn);
574c5b3d
TH
2873vm_fault_t vmf_insert_mixed_prot(struct vm_area_struct *vma, unsigned long addr,
2874 pfn_t pfn, pgprot_t pgprot);
ab77dab4
SJ
2875vm_fault_t vmf_insert_mixed_mkwrite(struct vm_area_struct *vma,
2876 unsigned long addr, pfn_t pfn);
b4cbb197
LT
2877int vm_iomap_memory(struct vm_area_struct *vma, phys_addr_t start, unsigned long len);
2878
1c8f4220
SJ
2879static inline vm_fault_t vmf_insert_page(struct vm_area_struct *vma,
2880 unsigned long addr, struct page *page)
2881{
2882 int err = vm_insert_page(vma, addr, page);
2883
2884 if (err == -ENOMEM)
2885 return VM_FAULT_OOM;
2886 if (err < 0 && err != -EBUSY)
2887 return VM_FAULT_SIGBUS;
2888
2889 return VM_FAULT_NOPAGE;
2890}
2891
f8f6ae5d
JG
2892#ifndef io_remap_pfn_range
2893static inline int io_remap_pfn_range(struct vm_area_struct *vma,
2894 unsigned long addr, unsigned long pfn,
2895 unsigned long size, pgprot_t prot)
2896{
2897 return remap_pfn_range(vma, addr, pfn, size, pgprot_decrypted(prot));
2898}
2899#endif
2900
d97baf94
SJ
2901static inline vm_fault_t vmf_error(int err)
2902{
2903 if (err == -ENOMEM)
2904 return VM_FAULT_OOM;
2905 return VM_FAULT_SIGBUS;
2906}
2907
df06b37f
KB
2908struct page *follow_page(struct vm_area_struct *vma, unsigned long address,
2909 unsigned int foll_flags);
240aadee 2910
deceb6cd
HD
2911#define FOLL_WRITE 0x01 /* check pte is writable */
2912#define FOLL_TOUCH 0x02 /* mark page accessed */
2913#define FOLL_GET 0x04 /* do get_page on page */
8e4b9a60 2914#define FOLL_DUMP 0x08 /* give error on hole if it would be zero */
58fa879e 2915#define FOLL_FORCE 0x10 /* get_user_pages read/write w/o permission */
318b275f
GN
2916#define FOLL_NOWAIT 0x20 /* if a disk transfer is needed, start the IO
2917 * and return without waiting upon it */
55b8fe70 2918#define FOLL_NOFAULT 0x80 /* do not fault in pages */
69ebb83e 2919#define FOLL_HWPOISON 0x100 /* check page is hwpoisoned */
0b9d7052 2920#define FOLL_NUMA 0x200 /* force NUMA hinting page fault */
5117b3b8 2921#define FOLL_MIGRATION 0x400 /* wait for page to replace migration entry */
234b239b 2922#define FOLL_TRIED 0x800 /* a retry, previous pass started an IO */
1e987790 2923#define FOLL_REMOTE 0x2000 /* we are working on non-current tsk/mm */
7f7ccc2c 2924#define FOLL_ANON 0x8000 /* don't do file mappings */
932f4a63 2925#define FOLL_LONGTERM 0x10000 /* mapping lifetime is indefinite: see below */
bfe7b00d 2926#define FOLL_SPLIT_PMD 0x20000 /* split huge pmd before returning */
f1f6a7dd 2927#define FOLL_PIN 0x40000 /* pages must be released via unpin_user_page */
376a34ef 2928#define FOLL_FAST_ONLY 0x80000 /* gup_fast: prevent fall-back to slow gup */
932f4a63
IW
2929
2930/*
eddb1c22
JH
2931 * FOLL_PIN and FOLL_LONGTERM may be used in various combinations with each
2932 * other. Here is what they mean, and how to use them:
932f4a63
IW
2933 *
2934 * FOLL_LONGTERM indicates that the page will be held for an indefinite time
eddb1c22
JH
2935 * period _often_ under userspace control. This is in contrast to
2936 * iov_iter_get_pages(), whose usages are transient.
932f4a63
IW
2937 *
2938 * FIXME: For pages which are part of a filesystem, mappings are subject to the
2939 * lifetime enforced by the filesystem and we need guarantees that longterm
2940 * users like RDMA and V4L2 only establish mappings which coordinate usage with
2941 * the filesystem. Ideas for this coordination include revoking the longterm
2942 * pin, delaying writeback, bounce buffer page writeback, etc. As FS DAX was
2943 * added after the problem with filesystems was found FS DAX VMAs are
2944 * specifically failed. Filesystem pages are still subject to bugs and use of
2945 * FOLL_LONGTERM should be avoided on those pages.
2946 *
2947 * FIXME: Also NOTE that FOLL_LONGTERM is not supported in every GUP call.
2948 * Currently only get_user_pages() and get_user_pages_fast() support this flag
2949 * and calls to get_user_pages_[un]locked are specifically not allowed. This
2950 * is due to an incompatibility with the FS DAX check and
eddb1c22 2951 * FAULT_FLAG_ALLOW_RETRY.
932f4a63 2952 *
eddb1c22
JH
2953 * In the CMA case: long term pins in a CMA region would unnecessarily fragment
2954 * that region. And so, CMA attempts to migrate the page before pinning, when
932f4a63 2955 * FOLL_LONGTERM is specified.
eddb1c22
JH
2956 *
2957 * FOLL_PIN indicates that a special kind of tracking (not just page->_refcount,
2958 * but an additional pin counting system) will be invoked. This is intended for
2959 * anything that gets a page reference and then touches page data (for example,
2960 * Direct IO). This lets the filesystem know that some non-file-system entity is
2961 * potentially changing the pages' data. In contrast to FOLL_GET (whose pages
2962 * are released via put_page()), FOLL_PIN pages must be released, ultimately, by
f1f6a7dd 2963 * a call to unpin_user_page().
eddb1c22
JH
2964 *
2965 * FOLL_PIN is similar to FOLL_GET: both of these pin pages. They use different
2966 * and separate refcounting mechanisms, however, and that means that each has
2967 * its own acquire and release mechanisms:
2968 *
2969 * FOLL_GET: get_user_pages*() to acquire, and put_page() to release.
2970 *
f1f6a7dd 2971 * FOLL_PIN: pin_user_pages*() to acquire, and unpin_user_pages to release.
eddb1c22
JH
2972 *
2973 * FOLL_PIN and FOLL_GET are mutually exclusive for a given function call.
2974 * (The underlying pages may experience both FOLL_GET-based and FOLL_PIN-based
2975 * calls applied to them, and that's perfectly OK. This is a constraint on the
2976 * callers, not on the pages.)
2977 *
2978 * FOLL_PIN should be set internally by the pin_user_pages*() APIs, never
2979 * directly by the caller. That's in order to help avoid mismatches when
2980 * releasing pages: get_user_pages*() pages must be released via put_page(),
f1f6a7dd 2981 * while pin_user_pages*() pages must be released via unpin_user_page().
eddb1c22 2982 *
72ef5e52 2983 * Please see Documentation/core-api/pin_user_pages.rst for more information.
932f4a63 2984 */
1da177e4 2985
2b740303 2986static inline int vm_fault_to_errno(vm_fault_t vm_fault, int foll_flags)
9a291a7c
JM
2987{
2988 if (vm_fault & VM_FAULT_OOM)
2989 return -ENOMEM;
2990 if (vm_fault & (VM_FAULT_HWPOISON | VM_FAULT_HWPOISON_LARGE))
2991 return (foll_flags & FOLL_HWPOISON) ? -EHWPOISON : -EFAULT;
2992 if (vm_fault & (VM_FAULT_SIGBUS | VM_FAULT_SIGSEGV))
2993 return -EFAULT;
2994 return 0;
2995}
2996
a7f22660
DH
2997/*
2998 * Indicates for which pages that are write-protected in the page table,
2999 * whether GUP has to trigger unsharing via FAULT_FLAG_UNSHARE such that the
3000 * GUP pin will remain consistent with the pages mapped into the page tables
3001 * of the MM.
3002 *
3003 * Temporary unmapping of PageAnonExclusive() pages or clearing of
3004 * PageAnonExclusive() has to protect against concurrent GUP:
3005 * * Ordinary GUP: Using the PT lock
3006 * * GUP-fast and fork(): mm->write_protect_seq
088b8aa5
DH
3007 * * GUP-fast and KSM or temporary unmapping (swap, migration): see
3008 * page_try_share_anon_rmap()
a7f22660
DH
3009 *
3010 * Must be called with the (sub)page that's actually referenced via the
3011 * page table entry, which might not necessarily be the head page for a
3012 * PTE-mapped THP.
3013 */
3014static inline bool gup_must_unshare(unsigned int flags, struct page *page)
3015{
3016 /*
3017 * FOLL_WRITE is implicitly handled correctly as the page table entry
3018 * has to be writable -- and if it references (part of) an anonymous
3019 * folio, that part is required to be marked exclusive.
3020 */
3021 if ((flags & (FOLL_WRITE | FOLL_PIN)) != FOLL_PIN)
3022 return false;
3023 /*
3024 * Note: PageAnon(page) is stable until the page is actually getting
3025 * freed.
3026 */
3027 if (!PageAnon(page))
3028 return false;
088b8aa5
DH
3029
3030 /* Paired with a memory barrier in page_try_share_anon_rmap(). */
3031 if (IS_ENABLED(CONFIG_HAVE_FAST_GUP))
3032 smp_rmb();
3033
a7f22660
DH
3034 /*
3035 * Note that PageKsm() pages cannot be exclusive, and consequently,
3036 * cannot get pinned.
3037 */
3038 return !PageAnonExclusive(page);
3039}
3040
8b1e0f81 3041typedef int (*pte_fn_t)(pte_t *pte, unsigned long addr, void *data);
aee16b3c
JF
3042extern int apply_to_page_range(struct mm_struct *mm, unsigned long address,
3043 unsigned long size, pte_fn_t fn, void *data);
be1db475
DA
3044extern int apply_to_existing_page_range(struct mm_struct *mm,
3045 unsigned long address, unsigned long size,
3046 pte_fn_t fn, void *data);
aee16b3c 3047
04013513 3048extern void init_mem_debugging_and_hardening(void);
8823b1db 3049#ifdef CONFIG_PAGE_POISONING
8db26a3d
VB
3050extern void __kernel_poison_pages(struct page *page, int numpages);
3051extern void __kernel_unpoison_pages(struct page *page, int numpages);
3052extern bool _page_poisoning_enabled_early;
3053DECLARE_STATIC_KEY_FALSE(_page_poisoning_enabled);
3054static inline bool page_poisoning_enabled(void)
3055{
3056 return _page_poisoning_enabled_early;
3057}
3058/*
3059 * For use in fast paths after init_mem_debugging() has run, or when a
3060 * false negative result is not harmful when called too early.
3061 */
3062static inline bool page_poisoning_enabled_static(void)
3063{
3064 return static_branch_unlikely(&_page_poisoning_enabled);
3065}
3066static inline void kernel_poison_pages(struct page *page, int numpages)
3067{
3068 if (page_poisoning_enabled_static())
3069 __kernel_poison_pages(page, numpages);
3070}
3071static inline void kernel_unpoison_pages(struct page *page, int numpages)
3072{
3073 if (page_poisoning_enabled_static())
3074 __kernel_unpoison_pages(page, numpages);
3075}
8823b1db
LA
3076#else
3077static inline bool page_poisoning_enabled(void) { return false; }
8db26a3d 3078static inline bool page_poisoning_enabled_static(void) { return false; }
03b6c9a3 3079static inline void __kernel_poison_pages(struct page *page, int nunmpages) { }
8db26a3d
VB
3080static inline void kernel_poison_pages(struct page *page, int numpages) { }
3081static inline void kernel_unpoison_pages(struct page *page, int numpages) { }
8823b1db
LA
3082#endif
3083
51cba1eb 3084DECLARE_STATIC_KEY_MAYBE(CONFIG_INIT_ON_ALLOC_DEFAULT_ON, init_on_alloc);
6471384a
AP
3085static inline bool want_init_on_alloc(gfp_t flags)
3086{
51cba1eb
KC
3087 if (static_branch_maybe(CONFIG_INIT_ON_ALLOC_DEFAULT_ON,
3088 &init_on_alloc))
6471384a
AP
3089 return true;
3090 return flags & __GFP_ZERO;
3091}
3092
51cba1eb 3093DECLARE_STATIC_KEY_MAYBE(CONFIG_INIT_ON_FREE_DEFAULT_ON, init_on_free);
6471384a
AP
3094static inline bool want_init_on_free(void)
3095{
51cba1eb
KC
3096 return static_branch_maybe(CONFIG_INIT_ON_FREE_DEFAULT_ON,
3097 &init_on_free);
6471384a
AP
3098}
3099
8e57f8ac
VB
3100extern bool _debug_pagealloc_enabled_early;
3101DECLARE_STATIC_KEY_FALSE(_debug_pagealloc_enabled);
031bc574
JK
3102
3103static inline bool debug_pagealloc_enabled(void)
8e57f8ac
VB
3104{
3105 return IS_ENABLED(CONFIG_DEBUG_PAGEALLOC) &&
3106 _debug_pagealloc_enabled_early;
3107}
3108
3109/*
3110 * For use in fast paths after init_debug_pagealloc() has run, or when a
3111 * false negative result is not harmful when called too early.
3112 */
3113static inline bool debug_pagealloc_enabled_static(void)
031bc574 3114{
96a2b03f
VB
3115 if (!IS_ENABLED(CONFIG_DEBUG_PAGEALLOC))
3116 return false;
3117
3118 return static_branch_unlikely(&_debug_pagealloc_enabled);
031bc574
JK
3119}
3120
5d6ad668 3121#ifdef CONFIG_DEBUG_PAGEALLOC
c87cbc1f 3122/*
5d6ad668
MR
3123 * To support DEBUG_PAGEALLOC architecture must ensure that
3124 * __kernel_map_pages() never fails
c87cbc1f 3125 */
d6332692
RE
3126extern void __kernel_map_pages(struct page *page, int numpages, int enable);
3127
77bc7fd6
MR
3128static inline void debug_pagealloc_map_pages(struct page *page, int numpages)
3129{
3130 if (debug_pagealloc_enabled_static())
3131 __kernel_map_pages(page, numpages, 1);
3132}
3133
3134static inline void debug_pagealloc_unmap_pages(struct page *page, int numpages)
3135{
3136 if (debug_pagealloc_enabled_static())
3137 __kernel_map_pages(page, numpages, 0);
3138}
5d6ad668 3139#else /* CONFIG_DEBUG_PAGEALLOC */
77bc7fd6
MR
3140static inline void debug_pagealloc_map_pages(struct page *page, int numpages) {}
3141static inline void debug_pagealloc_unmap_pages(struct page *page, int numpages) {}
5d6ad668 3142#endif /* CONFIG_DEBUG_PAGEALLOC */
1da177e4 3143
a6c19dfe 3144#ifdef __HAVE_ARCH_GATE_AREA
31db58b3 3145extern struct vm_area_struct *get_gate_vma(struct mm_struct *mm);
a6c19dfe
AL
3146extern int in_gate_area_no_mm(unsigned long addr);
3147extern int in_gate_area(struct mm_struct *mm, unsigned long addr);
1da177e4 3148#else
a6c19dfe
AL
3149static inline struct vm_area_struct *get_gate_vma(struct mm_struct *mm)
3150{
3151 return NULL;
3152}
3153static inline int in_gate_area_no_mm(unsigned long addr) { return 0; }
3154static inline int in_gate_area(struct mm_struct *mm, unsigned long addr)
3155{
3156 return 0;
3157}
1da177e4
LT
3158#endif /* __HAVE_ARCH_GATE_AREA */
3159
44a70ade
MH
3160extern bool process_shares_mm(struct task_struct *p, struct mm_struct *mm);
3161
146732ce
JT
3162#ifdef CONFIG_SYSCTL
3163extern int sysctl_drop_caches;
32927393
CH
3164int drop_caches_sysctl_handler(struct ctl_table *, int, void *, size_t *,
3165 loff_t *);
146732ce
JT
3166#endif
3167
cb731d6c 3168void drop_slab(void);
9d0243bc 3169
7a9166e3
LY
3170#ifndef CONFIG_MMU
3171#define randomize_va_space 0
3172#else
a62eaf15 3173extern int randomize_va_space;
7a9166e3 3174#endif
a62eaf15 3175
045e72ac 3176const char * arch_vma_name(struct vm_area_struct *vma);
89165b8b 3177#ifdef CONFIG_MMU
03252919 3178void print_vma_addr(char *prefix, unsigned long rip);
89165b8b
CH
3179#else
3180static inline void print_vma_addr(char *prefix, unsigned long rip)
3181{
3182}
3183#endif
e6e5494c 3184
35fd1eb1 3185void *sparse_buffer_alloc(unsigned long size);
e9c0a3f0 3186struct page * __populate_section_memmap(unsigned long pfn,
e3246d8f
JM
3187 unsigned long nr_pages, int nid, struct vmem_altmap *altmap,
3188 struct dev_pagemap *pgmap);
29c71111 3189pgd_t *vmemmap_pgd_populate(unsigned long addr, int node);
c2febafc
KS
3190p4d_t *vmemmap_p4d_populate(pgd_t *pgd, unsigned long addr, int node);
3191pud_t *vmemmap_pud_populate(p4d_t *p4d, unsigned long addr, int node);
29c71111 3192pmd_t *vmemmap_pmd_populate(pud_t *pud, unsigned long addr, int node);
1d9cfee7 3193pte_t *vmemmap_pte_populate(pmd_t *pmd, unsigned long addr, int node,
4917f55b 3194 struct vmem_altmap *altmap, struct page *reuse);
8f6aac41 3195void *vmemmap_alloc_block(unsigned long size, int node);
4b94ffdc 3196struct vmem_altmap;
56993b4e
AK
3197void *vmemmap_alloc_block_buf(unsigned long size, int node,
3198 struct vmem_altmap *altmap);
8f6aac41 3199void vmemmap_verify(pte_t *, int, unsigned long, unsigned long);
0aad818b 3200int vmemmap_populate_basepages(unsigned long start, unsigned long end,
1d9cfee7 3201 int node, struct vmem_altmap *altmap);
7b73d978
CH
3202int vmemmap_populate(unsigned long start, unsigned long end, int node,
3203 struct vmem_altmap *altmap);
c2b91e2e 3204void vmemmap_populate_print_last(void);
0197518c 3205#ifdef CONFIG_MEMORY_HOTPLUG
24b6d416
CH
3206void vmemmap_free(unsigned long start, unsigned long end,
3207 struct vmem_altmap *altmap);
0197518c 3208#endif
46723bfa 3209void register_page_bootmem_memmap(unsigned long section_nr, struct page *map,
15670bfe 3210 unsigned long nr_pages);
6a46079c 3211
82ba011b
AK
3212enum mf_flags {
3213 MF_COUNT_INCREASED = 1 << 0,
7329bbeb 3214 MF_ACTION_REQUIRED = 1 << 1,
6751ed65 3215 MF_MUST_KILL = 1 << 2,
cf870c70 3216 MF_SOFT_OFFLINE = 1 << 3,
bf181c58 3217 MF_UNPOISON = 1 << 4,
67f22ba7 3218 MF_SW_SIMULATED = 1 << 5,
38f6d293 3219 MF_NO_RETRY = 1 << 6,
82ba011b 3220};
c36e2024
SR
3221int mf_dax_kill_procs(struct address_space *mapping, pgoff_t index,
3222 unsigned long count, int mf_flags);
83b57531
EB
3223extern int memory_failure(unsigned long pfn, int flags);
3224extern void memory_failure_queue(unsigned long pfn, int flags);
06202231 3225extern void memory_failure_queue_kick(int cpu);
847ce401 3226extern int unpoison_memory(unsigned long pfn);
6a46079c
AK
3227extern int sysctl_memory_failure_early_kill;
3228extern int sysctl_memory_failure_recovery;
d0505e9f 3229extern void shake_page(struct page *p);
5844a486 3230extern atomic_long_t num_poisoned_pages __read_mostly;
feec24a6 3231extern int soft_offline_page(unsigned long pfn, int flags);
405ce051
NH
3232#ifdef CONFIG_MEMORY_FAILURE
3233extern int __get_huge_page_for_hwpoison(unsigned long pfn, int flags);
3234#else
3235static inline int __get_huge_page_for_hwpoison(unsigned long pfn, int flags)
3236{
3237 return 0;
3238}
3239#endif
6a46079c 3240
03b122da
TL
3241#ifndef arch_memory_failure
3242static inline int arch_memory_failure(unsigned long pfn, int flags)
3243{
3244 return -ENXIO;
3245}
3246#endif
3247
3248#ifndef arch_is_platform_page
3249static inline bool arch_is_platform_page(u64 paddr)
3250{
3251 return false;
3252}
3253#endif
cc637b17
XX
3254
3255/*
3256 * Error handlers for various types of pages.
3257 */
cc3e2af4 3258enum mf_result {
cc637b17
XX
3259 MF_IGNORED, /* Error: cannot be handled */
3260 MF_FAILED, /* Error: handling failed */
3261 MF_DELAYED, /* Will be handled later */
3262 MF_RECOVERED, /* Successfully recovered */
3263};
3264
3265enum mf_action_page_type {
3266 MF_MSG_KERNEL,
3267 MF_MSG_KERNEL_HIGH_ORDER,
3268 MF_MSG_SLAB,
3269 MF_MSG_DIFFERENT_COMPOUND,
cc637b17
XX
3270 MF_MSG_HUGE,
3271 MF_MSG_FREE_HUGE,
3272 MF_MSG_UNMAP_FAILED,
3273 MF_MSG_DIRTY_SWAPCACHE,
3274 MF_MSG_CLEAN_SWAPCACHE,
3275 MF_MSG_DIRTY_MLOCKED_LRU,
3276 MF_MSG_CLEAN_MLOCKED_LRU,
3277 MF_MSG_DIRTY_UNEVICTABLE_LRU,
3278 MF_MSG_CLEAN_UNEVICTABLE_LRU,
3279 MF_MSG_DIRTY_LRU,
3280 MF_MSG_CLEAN_LRU,
3281 MF_MSG_TRUNCATED_LRU,
3282 MF_MSG_BUDDY,
6100e34b 3283 MF_MSG_DAX,
5d1fd5dc 3284 MF_MSG_UNSPLIT_THP,
cc637b17
XX
3285 MF_MSG_UNKNOWN,
3286};
3287
47ad8475
AA
3288#if defined(CONFIG_TRANSPARENT_HUGEPAGE) || defined(CONFIG_HUGETLBFS)
3289extern void clear_huge_page(struct page *page,
c79b57e4 3290 unsigned long addr_hint,
47ad8475
AA
3291 unsigned int pages_per_huge_page);
3292extern void copy_user_huge_page(struct page *dst, struct page *src,
c9f4cd71
HY
3293 unsigned long addr_hint,
3294 struct vm_area_struct *vma,
47ad8475 3295 unsigned int pages_per_huge_page);
fa4d75c1
MK
3296extern long copy_huge_page_from_user(struct page *dst_page,
3297 const void __user *usr_src,
810a56b9
MK
3298 unsigned int pages_per_huge_page,
3299 bool allow_pagefault);
2484ca9b
THV
3300
3301/**
3302 * vma_is_special_huge - Are transhuge page-table entries considered special?
3303 * @vma: Pointer to the struct vm_area_struct to consider
3304 *
3305 * Whether transhuge page-table entries are considered "special" following
3306 * the definition in vm_normal_page().
3307 *
3308 * Return: true if transhuge page-table entries should be considered special,
3309 * false otherwise.
3310 */
3311static inline bool vma_is_special_huge(const struct vm_area_struct *vma)
3312{
3313 return vma_is_dax(vma) || (vma->vm_file &&
3314 (vma->vm_flags & (VM_PFNMAP | VM_MIXEDMAP)));
3315}
3316
47ad8475
AA
3317#endif /* CONFIG_TRANSPARENT_HUGEPAGE || CONFIG_HUGETLBFS */
3318
c0a32fc5
SG
3319#ifdef CONFIG_DEBUG_PAGEALLOC
3320extern unsigned int _debug_guardpage_minorder;
96a2b03f 3321DECLARE_STATIC_KEY_FALSE(_debug_guardpage_enabled);
c0a32fc5
SG
3322
3323static inline unsigned int debug_guardpage_minorder(void)
3324{
3325 return _debug_guardpage_minorder;
3326}
3327
e30825f1
JK
3328static inline bool debug_guardpage_enabled(void)
3329{
96a2b03f 3330 return static_branch_unlikely(&_debug_guardpage_enabled);
e30825f1
JK
3331}
3332
c0a32fc5
SG
3333static inline bool page_is_guard(struct page *page)
3334{
e30825f1
JK
3335 if (!debug_guardpage_enabled())
3336 return false;
3337
3972f6bb 3338 return PageGuard(page);
c0a32fc5
SG
3339}
3340#else
3341static inline unsigned int debug_guardpage_minorder(void) { return 0; }
e30825f1 3342static inline bool debug_guardpage_enabled(void) { return false; }
c0a32fc5
SG
3343static inline bool page_is_guard(struct page *page) { return false; }
3344#endif /* CONFIG_DEBUG_PAGEALLOC */
3345
f9872caf
CS
3346#if MAX_NUMNODES > 1
3347void __init setup_nr_node_ids(void);
3348#else
3349static inline void setup_nr_node_ids(void) {}
3350#endif
3351
010c164a
SL
3352extern int memcmp_pages(struct page *page1, struct page *page2);
3353
3354static inline int pages_identical(struct page *page1, struct page *page2)
3355{
3356 return !memcmp_pages(page1, page2);
3357}
3358
c5acad84
TH
3359#ifdef CONFIG_MAPPING_DIRTY_HELPERS
3360unsigned long clean_record_shared_mapping_range(struct address_space *mapping,
3361 pgoff_t first_index, pgoff_t nr,
3362 pgoff_t bitmap_pgoff,
3363 unsigned long *bitmap,
3364 pgoff_t *start,
3365 pgoff_t *end);
3366
3367unsigned long wp_shared_mapping_range(struct address_space *mapping,
3368 pgoff_t first_index, pgoff_t nr);
3369#endif
3370
2374c09b
CH
3371extern int sysctl_nr_trim_pages;
3372
5bb1bb35 3373#ifdef CONFIG_PRINTK
8e7f37f2 3374void mem_dump_obj(void *object);
5bb1bb35
PM
3375#else
3376static inline void mem_dump_obj(void *object) {}
3377#endif
8e7f37f2 3378
22247efd
PX
3379/**
3380 * seal_check_future_write - Check for F_SEAL_FUTURE_WRITE flag and handle it
3381 * @seals: the seals to check
3382 * @vma: the vma to operate on
3383 *
3384 * Check whether F_SEAL_FUTURE_WRITE is set; if so, do proper check/handling on
3385 * the vma flags. Return 0 if check pass, or <0 for errors.
3386 */
3387static inline int seal_check_future_write(int seals, struct vm_area_struct *vma)
3388{
3389 if (seals & F_SEAL_FUTURE_WRITE) {
3390 /*
3391 * New PROT_WRITE and MAP_SHARED mmaps are not allowed when
3392 * "future write" seal active.
3393 */
3394 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_WRITE))
3395 return -EPERM;
3396
3397 /*
3398 * Since an F_SEAL_FUTURE_WRITE sealed memfd can be mapped as
3399 * MAP_SHARED and read-only, take care to not allow mprotect to
3400 * revert protections on such mappings. Do this only for shared
3401 * mappings. For private mappings, don't need to mask
3402 * VM_MAYWRITE as we still want them to be COW-writable.
3403 */
3404 if (vma->vm_flags & VM_SHARED)
3405 vma->vm_flags &= ~(VM_MAYWRITE);
3406 }
3407
3408 return 0;
3409}
3410
9a10064f
CC
3411#ifdef CONFIG_ANON_VMA_NAME
3412int madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
5c26f6ac
SB
3413 unsigned long len_in,
3414 struct anon_vma_name *anon_name);
9a10064f
CC
3415#else
3416static inline int
3417madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
5c26f6ac 3418 unsigned long len_in, struct anon_vma_name *anon_name) {
9a10064f
CC
3419 return 0;
3420}
3421#endif
3422
999dad82
PX
3423/*
3424 * Whether to drop the pte markers, for example, the uffd-wp information for
3425 * file-backed memory. This should only be specified when we will completely
3426 * drop the page in the mm, either by truncation or unmapping of the vma. By
3427 * default, the flag is not set.
3428 */
3429#define ZAP_FLAG_DROP_MARKER ((__force zap_flags_t) BIT(0))
3430
1da177e4 3431#endif /* _LINUX_MM_H */