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