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