1 #ifndef _LINUX_MM_TYPES_H
2 #define _LINUX_MM_TYPES_H
4 #include <linux/auxvec.h>
5 #include <linux/types.h>
6 #include <linux/threads.h>
7 #include <linux/list.h>
8 #include <linux/spinlock.h>
9 #include <linux/rbtree.h>
10 #include <linux/rwsem.h>
11 #include <linux/completion.h>
12 #include <linux/cpumask.h>
13 #include <linux/uprobes.h>
14 #include <linux/page-flags-layout.h>
15 #include <linux/workqueue.h>
19 #ifndef AT_VECTOR_SIZE_ARCH
20 #define AT_VECTOR_SIZE_ARCH 0
22 #define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
27 #define USE_SPLIT_PTE_PTLOCKS (NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS)
28 #define USE_SPLIT_PMD_PTLOCKS (USE_SPLIT_PTE_PTLOCKS && \
29 IS_ENABLED(CONFIG_ARCH_ENABLE_SPLIT_PMD_PTLOCK))
30 #define ALLOC_SPLIT_PTLOCKS (SPINLOCK_SIZE > BITS_PER_LONG/8)
33 * Each physical page in the system has a struct page associated with
34 * it to keep track of whatever it is we are using the page for at the
35 * moment. Note that we have no way to track which tasks are using
36 * a page, though if it is a pagecache page, rmap structures can tell us
39 * The objects in struct page are organized in double word blocks in
40 * order to allows us to use atomic double word operations on portions
41 * of struct page. That is currently only used by slub but the arrangement
42 * allows the use of atomic double word operations on the flags/mapping
43 * and lru list pointers also.
46 /* First double word block */
47 unsigned long flags; /* Atomic flags, some possibly
48 * updated asynchronously */
50 struct address_space *mapping; /* If low bit clear, points to
51 * inode address_space, or NULL.
52 * If page mapped as anonymous
53 * memory, low bit is set, and
54 * it points to anon_vma object:
55 * see PAGE_MAPPING_ANON below.
57 void *s_mem; /* slab first object */
58 atomic_t compound_mapcount; /* first tail page */
59 /* page_deferred_list().next -- second tail page */
62 /* Second double word */
65 pgoff_t index; /* Our offset within mapping. */
66 void *freelist; /* sl[aou]b first free object */
67 /* page_deferred_list().prev -- second tail page */
71 #if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
72 defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
73 /* Used for cmpxchg_double in slub */
74 unsigned long counters;
77 * Keep _refcount separate from slub cmpxchg_double
78 * data. As the rest of the double word is protected by
79 * slab_lock but _refcount is not.
88 * Count of ptes mapped in mms, to show
89 * when page is mapped & limit reverse
102 * Usage count, *USE WRAPPER FUNCTION*
103 * when manual accounting. See page_ref.h
107 unsigned int active; /* SLAB */
112 * Third double word block
114 * WARNING: bit 0 of the first word encode PageTail(). That means
115 * the rest users of the storage space MUST NOT use the bit to
116 * avoid collision and false-positive PageTail().
119 struct list_head lru; /* Pageout list, eg. active_list
120 * protected by zone->lru_lock !
121 * Can be used as a generic list
124 struct dev_pagemap *pgmap; /* ZONE_DEVICE pages are never on an
125 * lru or handled by a slab
126 * allocator, this points to the
127 * hosting device page map.
129 struct { /* slub per cpu partial pages */
130 struct page *next; /* Next partial slab */
132 int pages; /* Nr of partial slabs left */
133 int pobjects; /* Approximate # of objects */
140 struct rcu_head rcu_head; /* Used by SLAB
141 * when destroying via RCU
143 /* Tail pages of compound page */
145 unsigned long compound_head; /* If bit zero is set */
147 /* First tail page only */
150 * On 64 bit system we have enough space in struct page
151 * to encode compound_dtor and compound_order with
152 * unsigned int. It can help compiler generate better or
153 * smaller code on some archtectures.
155 unsigned int compound_dtor;
156 unsigned int compound_order;
158 unsigned short int compound_dtor;
159 unsigned short int compound_order;
163 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) && USE_SPLIT_PMD_PTLOCKS
165 unsigned long __pad; /* do not overlay pmd_huge_pte
166 * with compound_head to avoid
167 * possible bit 0 collision.
169 pgtable_t pmd_huge_pte; /* protected by page->ptl */
174 /* Remainder is not double word aligned */
176 unsigned long private; /* Mapping-private opaque data:
177 * usually used for buffer_heads
178 * if PagePrivate set; used for
179 * swp_entry_t if PageSwapCache;
180 * indicates order in the buddy
181 * system if PG_buddy is set.
183 #if USE_SPLIT_PTE_PTLOCKS
184 #if ALLOC_SPLIT_PTLOCKS
190 struct kmem_cache *slab_cache; /* SL[AU]B: Pointer to slab */
194 struct mem_cgroup *mem_cgroup;
198 * On machines where all RAM is mapped into kernel address space,
199 * we can simply calculate the virtual address. On machines with
200 * highmem some memory is mapped into kernel virtual memory
201 * dynamically, so we need a place to store that address.
202 * Note that this field could be 16 bits on x86 ... ;)
204 * Architectures with slow multiplication can define
205 * WANT_PAGE_VIRTUAL in asm/page.h
207 #if defined(WANT_PAGE_VIRTUAL)
208 void *virtual; /* Kernel virtual address (NULL if
209 not kmapped, ie. highmem) */
210 #endif /* WANT_PAGE_VIRTUAL */
212 #ifdef CONFIG_KMEMCHECK
214 * kmemcheck wants to track the status of each byte in a page; this
215 * is a pointer to such a status block. NULL if not tracked.
220 #ifdef LAST_CPUPID_NOT_IN_PAGE_FLAGS
225 * The struct page can be forced to be double word aligned so that atomic ops
226 * on double words work. The SLUB allocator can make use of such a feature.
228 #ifdef CONFIG_HAVE_ALIGNED_STRUCT_PAGE
229 __aligned(2 * sizeof(unsigned long))
235 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
244 #define PAGE_FRAG_CACHE_MAX_SIZE __ALIGN_MASK(32768, ~PAGE_MASK)
245 #define PAGE_FRAG_CACHE_MAX_ORDER get_order(PAGE_FRAG_CACHE_MAX_SIZE)
247 struct page_frag_cache {
249 #if (PAGE_SIZE < PAGE_FRAG_CACHE_MAX_SIZE)
255 /* we maintain a pagecount bias, so that we dont dirty cache line
256 * containing page->_refcount every time we allocate a fragment.
258 unsigned int pagecnt_bias;
262 typedef unsigned long vm_flags_t;
265 * A region containing a mapping of a non-memory backed file under NOMMU
266 * conditions. These are held in a global tree and are pinned by the VMAs that
270 struct rb_node vm_rb; /* link in global region tree */
271 vm_flags_t vm_flags; /* VMA vm_flags */
272 unsigned long vm_start; /* start address of region */
273 unsigned long vm_end; /* region initialised to here */
274 unsigned long vm_top; /* region allocated to here */
275 unsigned long vm_pgoff; /* the offset in vm_file corresponding to vm_start */
276 struct file *vm_file; /* the backing file or NULL */
278 int vm_usage; /* region usage count (access under nommu_region_sem) */
279 bool vm_icache_flushed : 1; /* true if the icache has been flushed for
283 #ifdef CONFIG_USERFAULTFD
284 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) { NULL, })
285 struct vm_userfaultfd_ctx {
286 struct userfaultfd_ctx *ctx;
288 #else /* CONFIG_USERFAULTFD */
289 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) {})
290 struct vm_userfaultfd_ctx {};
291 #endif /* CONFIG_USERFAULTFD */
294 * This struct defines a memory VMM memory area. There is one of these
295 * per VM-area/task. A VM area is any part of the process virtual memory
296 * space that has a special rule for the page-fault handlers (ie a shared
297 * library, the executable area etc).
299 struct vm_area_struct {
300 /* The first cache line has the info for VMA tree walking. */
302 unsigned long vm_start; /* Our start address within vm_mm. */
303 unsigned long vm_end; /* The first byte after our end address
306 /* linked list of VM areas per task, sorted by address */
307 struct vm_area_struct *vm_next, *vm_prev;
309 struct rb_node vm_rb;
312 * Largest free memory gap in bytes to the left of this VMA.
313 * Either between this VMA and vma->vm_prev, or between one of the
314 * VMAs below us in the VMA rbtree and its ->vm_prev. This helps
315 * get_unmapped_area find a free area of the right size.
317 unsigned long rb_subtree_gap;
319 /* Second cache line starts here. */
321 struct mm_struct *vm_mm; /* The address space we belong to. */
322 pgprot_t vm_page_prot; /* Access permissions of this VMA. */
323 unsigned long vm_flags; /* Flags, see mm.h. */
326 * For areas with an address space and backing store,
327 * linkage into the address_space->i_mmap interval tree.
331 unsigned long rb_subtree_last;
335 * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
336 * list, after a COW of one of the file pages. A MAP_SHARED vma
337 * can only be in the i_mmap tree. An anonymous MAP_PRIVATE, stack
338 * or brk vma (with NULL file) can only be in an anon_vma list.
340 struct list_head anon_vma_chain; /* Serialized by mmap_sem &
342 struct anon_vma *anon_vma; /* Serialized by page_table_lock */
344 /* Function pointers to deal with this struct. */
345 const struct vm_operations_struct *vm_ops;
347 /* Information about our backing store: */
348 unsigned long vm_pgoff; /* Offset (within vm_file) in PAGE_SIZE
350 struct file * vm_file; /* File we map to (can be NULL). */
351 void * vm_private_data; /* was vm_pte (shared mem) */
354 struct vm_region *vm_region; /* NOMMU mapping region */
357 struct mempolicy *vm_policy; /* NUMA policy for the VMA */
359 struct vm_userfaultfd_ctx vm_userfaultfd_ctx;
363 struct task_struct *task;
364 struct core_thread *next;
369 struct core_thread dumper;
370 struct completion startup;
374 MM_FILEPAGES, /* Resident file mapping pages */
375 MM_ANONPAGES, /* Resident anonymous pages */
376 MM_SWAPENTS, /* Anonymous swap entries */
377 MM_SHMEMPAGES, /* Resident shared memory pages */
381 #if USE_SPLIT_PTE_PTLOCKS && defined(CONFIG_MMU)
382 #define SPLIT_RSS_COUNTING
383 /* per-thread cached information, */
384 struct task_rss_stat {
385 int events; /* for synchronization threshold */
386 int count[NR_MM_COUNTERS];
388 #endif /* USE_SPLIT_PTE_PTLOCKS */
391 atomic_long_t count[NR_MM_COUNTERS];
396 struct vm_area_struct *mmap; /* list of VMAs */
397 struct rb_root mm_rb;
398 u32 vmacache_seqnum; /* per-thread vmacache */
400 unsigned long (*get_unmapped_area) (struct file *filp,
401 unsigned long addr, unsigned long len,
402 unsigned long pgoff, unsigned long flags);
404 unsigned long mmap_base; /* base of mmap area */
405 unsigned long mmap_legacy_base; /* base of mmap area in bottom-up allocations */
406 unsigned long task_size; /* size of task vm space */
407 unsigned long highest_vm_end; /* highest vma end address */
409 atomic_t mm_users; /* How many users with user space? */
410 atomic_t mm_count; /* How many references to "struct mm_struct" (users count as 1) */
411 atomic_long_t nr_ptes; /* PTE page table pages */
412 #if CONFIG_PGTABLE_LEVELS > 2
413 atomic_long_t nr_pmds; /* PMD page table pages */
415 int map_count; /* number of VMAs */
417 spinlock_t page_table_lock; /* Protects page tables and some counters */
418 struct rw_semaphore mmap_sem;
420 struct list_head mmlist; /* List of maybe swapped mm's. These are globally strung
421 * together off init_mm.mmlist, and are protected
426 unsigned long hiwater_rss; /* High-watermark of RSS usage */
427 unsigned long hiwater_vm; /* High-water virtual memory usage */
429 unsigned long total_vm; /* Total pages mapped */
430 unsigned long locked_vm; /* Pages that have PG_mlocked set */
431 unsigned long pinned_vm; /* Refcount permanently increased */
432 unsigned long data_vm; /* VM_WRITE & ~VM_SHARED & ~VM_STACK */
433 unsigned long exec_vm; /* VM_EXEC & ~VM_WRITE & ~VM_STACK */
434 unsigned long stack_vm; /* VM_STACK */
435 unsigned long def_flags;
436 unsigned long start_code, end_code, start_data, end_data;
437 unsigned long start_brk, brk, start_stack;
438 unsigned long arg_start, arg_end, env_start, env_end;
440 unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
443 * Special counters, in some configurations protected by the
444 * page_table_lock, in other configurations by being atomic.
446 struct mm_rss_stat rss_stat;
448 struct linux_binfmt *binfmt;
450 cpumask_var_t cpu_vm_mask_var;
452 /* Architecture-specific MM context */
453 mm_context_t context;
455 unsigned long flags; /* Must use atomic bitops to access the bits */
457 struct core_state *core_state; /* coredumping support */
459 spinlock_t ioctx_lock;
460 struct kioctx_table __rcu *ioctx_table;
464 * "owner" points to a task that is regarded as the canonical
465 * user/owner of this mm. All of the following must be true in
466 * order for it to be changed:
468 * current == mm->owner
470 * new_owner->mm == mm
471 * new_owner->alloc_lock is held
473 struct task_struct __rcu *owner;
476 /* store ref to file /proc/<pid>/exe symlink points to */
477 struct file __rcu *exe_file;
478 #ifdef CONFIG_MMU_NOTIFIER
479 struct mmu_notifier_mm *mmu_notifier_mm;
481 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) && !USE_SPLIT_PMD_PTLOCKS
482 pgtable_t pmd_huge_pte; /* protected by page_table_lock */
484 #ifdef CONFIG_CPUMASK_OFFSTACK
485 struct cpumask cpumask_allocation;
487 #ifdef CONFIG_NUMA_BALANCING
489 * numa_next_scan is the next time that the PTEs will be marked
490 * pte_numa. NUMA hinting faults will gather statistics and migrate
491 * pages to new nodes if necessary.
493 unsigned long numa_next_scan;
495 /* Restart point for scanning and setting pte_numa */
496 unsigned long numa_scan_offset;
498 /* numa_scan_seq prevents two threads setting pte_numa */
501 #if defined(CONFIG_NUMA_BALANCING) || defined(CONFIG_COMPACTION)
503 * An operation with batched TLB flushing is going on. Anything that
504 * can move process memory needs to flush the TLB when moving a
505 * PROT_NONE or PROT_NUMA mapped page.
507 bool tlb_flush_pending;
509 struct uprobes_state uprobes_state;
510 #ifdef CONFIG_X86_INTEL_MPX
511 /* address of the bounds directory */
512 void __user *bd_addr;
514 #ifdef CONFIG_HUGETLB_PAGE
515 atomic_long_t hugetlb_usage;
517 struct work_struct async_put_work;
520 static inline void mm_init_cpumask(struct mm_struct *mm)
522 #ifdef CONFIG_CPUMASK_OFFSTACK
523 mm->cpu_vm_mask_var = &mm->cpumask_allocation;
525 cpumask_clear(mm->cpu_vm_mask_var);
528 /* Future-safe accessor for struct mm_struct's cpu_vm_mask. */
529 static inline cpumask_t *mm_cpumask(struct mm_struct *mm)
531 return mm->cpu_vm_mask_var;
534 #if defined(CONFIG_NUMA_BALANCING) || defined(CONFIG_COMPACTION)
536 * Memory barriers to keep this state in sync are graciously provided by
537 * the page table locks, outside of which no page table modifications happen.
538 * The barriers below prevent the compiler from re-ordering the instructions
539 * around the memory barriers that are already present in the code.
541 static inline bool mm_tlb_flush_pending(struct mm_struct *mm)
544 return mm->tlb_flush_pending;
546 static inline void set_tlb_flush_pending(struct mm_struct *mm)
548 mm->tlb_flush_pending = true;
551 * Guarantee that the tlb_flush_pending store does not leak into the
552 * critical section updating the page tables
554 smp_mb__before_spinlock();
556 /* Clearing is done after a TLB flush, which also provides a barrier. */
557 static inline void clear_tlb_flush_pending(struct mm_struct *mm)
560 mm->tlb_flush_pending = false;
563 static inline bool mm_tlb_flush_pending(struct mm_struct *mm)
567 static inline void set_tlb_flush_pending(struct mm_struct *mm)
570 static inline void clear_tlb_flush_pending(struct mm_struct *mm)
577 struct vm_special_mapping {
578 const char *name; /* The name, e.g. "[vdso]". */
581 * If .fault is not provided, this points to a
582 * NULL-terminated array of pages that back the special mapping.
584 * This must not be NULL unless .fault is provided.
589 * If non-NULL, then this is called to resolve page faults
590 * on the special mapping. If used, .pages is not checked.
592 int (*fault)(const struct vm_special_mapping *sm,
593 struct vm_area_struct *vma,
594 struct vm_fault *vmf);
597 enum tlb_flush_reason {
598 TLB_FLUSH_ON_TASK_SWITCH,
599 TLB_REMOTE_SHOOTDOWN,
601 TLB_LOCAL_MM_SHOOTDOWN,
603 NR_TLB_FLUSH_REASONS,
607 * A swap entry has to fit into a "unsigned long", as the entry is hidden
608 * in the "index" field of the swapper address space.
614 #endif /* _LINUX_MM_TYPES_H */