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