xref: /linux-6.15/include/linux/mm_types.h (revision cce2d453)
1 #ifndef _LINUX_MM_TYPES_H
2 #define _LINUX_MM_TYPES_H
3 
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/prio_tree.h>
10 #include <linux/rbtree.h>
11 #include <linux/rwsem.h>
12 #include <linux/completion.h>
13 #include <linux/cpumask.h>
14 #include <asm/page.h>
15 #include <asm/mmu.h>
16 
17 #ifndef AT_VECTOR_SIZE_ARCH
18 #define AT_VECTOR_SIZE_ARCH 0
19 #endif
20 #define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
21 
22 struct address_space;
23 
24 #if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
25 typedef atomic_long_t mm_counter_t;
26 #else  /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */
27 typedef unsigned long mm_counter_t;
28 #endif /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */
29 
30 /*
31  * Each physical page in the system has a struct page associated with
32  * it to keep track of whatever it is we are using the page for at the
33  * moment. Note that we have no way to track which tasks are using
34  * a page, though if it is a pagecache page, rmap structures can tell us
35  * who is mapping it.
36  */
37 struct page {
38 	unsigned long flags;		/* Atomic flags, some possibly
39 					 * updated asynchronously */
40 	atomic_t _count;		/* Usage count, see below. */
41 	union {
42 		atomic_t _mapcount;	/* Count of ptes mapped in mms,
43 					 * to show when page is mapped
44 					 * & limit reverse map searches.
45 					 */
46 		struct {		/* SLUB */
47 			u16 inuse;
48 			u16 objects;
49 		};
50 	};
51 	union {
52 	    struct {
53 		unsigned long private;		/* Mapping-private opaque data:
54 					 	 * usually used for buffer_heads
55 						 * if PagePrivate set; used for
56 						 * swp_entry_t if PageSwapCache;
57 						 * indicates order in the buddy
58 						 * system if PG_buddy is set.
59 						 */
60 		struct address_space *mapping;	/* If low bit clear, points to
61 						 * inode address_space, or NULL.
62 						 * If page mapped as anonymous
63 						 * memory, low bit is set, and
64 						 * it points to anon_vma object:
65 						 * see PAGE_MAPPING_ANON below.
66 						 */
67 	    };
68 #if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
69 	    spinlock_t ptl;
70 #endif
71 	    struct kmem_cache *slab;	/* SLUB: Pointer to slab */
72 	    struct page *first_page;	/* Compound tail pages */
73 	};
74 	union {
75 		pgoff_t index;		/* Our offset within mapping. */
76 		void *freelist;		/* SLUB: freelist req. slab lock */
77 	};
78 	struct list_head lru;		/* Pageout list, eg. active_list
79 					 * protected by zone->lru_lock !
80 					 */
81 	/*
82 	 * On machines where all RAM is mapped into kernel address space,
83 	 * we can simply calculate the virtual address. On machines with
84 	 * highmem some memory is mapped into kernel virtual memory
85 	 * dynamically, so we need a place to store that address.
86 	 * Note that this field could be 16 bits on x86 ... ;)
87 	 *
88 	 * Architectures with slow multiplication can define
89 	 * WANT_PAGE_VIRTUAL in asm/page.h
90 	 */
91 #if defined(WANT_PAGE_VIRTUAL)
92 	void *virtual;			/* Kernel virtual address (NULL if
93 					   not kmapped, ie. highmem) */
94 #endif /* WANT_PAGE_VIRTUAL */
95 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
96 	unsigned long page_cgroup;
97 #endif
98 };
99 
100 /*
101  * This struct defines a memory VMM memory area. There is one of these
102  * per VM-area/task.  A VM area is any part of the process virtual memory
103  * space that has a special rule for the page-fault handlers (ie a shared
104  * library, the executable area etc).
105  */
106 struct vm_area_struct {
107 	struct mm_struct * vm_mm;	/* The address space we belong to. */
108 	unsigned long vm_start;		/* Our start address within vm_mm. */
109 	unsigned long vm_end;		/* The first byte after our end address
110 					   within vm_mm. */
111 
112 	/* linked list of VM areas per task, sorted by address */
113 	struct vm_area_struct *vm_next;
114 
115 	pgprot_t vm_page_prot;		/* Access permissions of this VMA. */
116 	unsigned long vm_flags;		/* Flags, listed below. */
117 
118 	struct rb_node vm_rb;
119 
120 	/*
121 	 * For areas with an address space and backing store,
122 	 * linkage into the address_space->i_mmap prio tree, or
123 	 * linkage to the list of like vmas hanging off its node, or
124 	 * linkage of vma in the address_space->i_mmap_nonlinear list.
125 	 */
126 	union {
127 		struct {
128 			struct list_head list;
129 			void *parent;	/* aligns with prio_tree_node parent */
130 			struct vm_area_struct *head;
131 		} vm_set;
132 
133 		struct raw_prio_tree_node prio_tree_node;
134 	} shared;
135 
136 	/*
137 	 * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
138 	 * list, after a COW of one of the file pages.	A MAP_SHARED vma
139 	 * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
140 	 * or brk vma (with NULL file) can only be in an anon_vma list.
141 	 */
142 	struct list_head anon_vma_node;	/* Serialized by anon_vma->lock */
143 	struct anon_vma *anon_vma;	/* Serialized by page_table_lock */
144 
145 	/* Function pointers to deal with this struct. */
146 	struct vm_operations_struct * vm_ops;
147 
148 	/* Information about our backing store: */
149 	unsigned long vm_pgoff;		/* Offset (within vm_file) in PAGE_SIZE
150 					   units, *not* PAGE_CACHE_SIZE */
151 	struct file * vm_file;		/* File we map to (can be NULL). */
152 	void * vm_private_data;		/* was vm_pte (shared mem) */
153 	unsigned long vm_truncate_count;/* truncate_count or restart_addr */
154 
155 #ifndef CONFIG_MMU
156 	atomic_t vm_usage;		/* refcount (VMAs shared if !MMU) */
157 #endif
158 #ifdef CONFIG_NUMA
159 	struct mempolicy *vm_policy;	/* NUMA policy for the VMA */
160 #endif
161 };
162 
163 struct core_thread {
164 	struct task_struct *task;
165 	struct core_thread *next;
166 };
167 
168 struct core_state {
169 	atomic_t nr_threads;
170 	struct core_thread dumper;
171 	struct completion startup;
172 };
173 
174 struct mm_struct {
175 	struct vm_area_struct * mmap;		/* list of VMAs */
176 	struct rb_root mm_rb;
177 	struct vm_area_struct * mmap_cache;	/* last find_vma result */
178 	unsigned long (*get_unmapped_area) (struct file *filp,
179 				unsigned long addr, unsigned long len,
180 				unsigned long pgoff, unsigned long flags);
181 	void (*unmap_area) (struct mm_struct *mm, unsigned long addr);
182 	unsigned long mmap_base;		/* base of mmap area */
183 	unsigned long task_size;		/* size of task vm space */
184 	unsigned long cached_hole_size; 	/* if non-zero, the largest hole below free_area_cache */
185 	unsigned long free_area_cache;		/* first hole of size cached_hole_size or larger */
186 	pgd_t * pgd;
187 	atomic_t mm_users;			/* How many users with user space? */
188 	atomic_t mm_count;			/* How many references to "struct mm_struct" (users count as 1) */
189 	int map_count;				/* number of VMAs */
190 	struct rw_semaphore mmap_sem;
191 	spinlock_t page_table_lock;		/* Protects page tables and some counters */
192 
193 	struct list_head mmlist;		/* List of maybe swapped mm's.	These are globally strung
194 						 * together off init_mm.mmlist, and are protected
195 						 * by mmlist_lock
196 						 */
197 
198 	/* Special counters, in some configurations protected by the
199 	 * page_table_lock, in other configurations by being atomic.
200 	 */
201 	mm_counter_t _file_rss;
202 	mm_counter_t _anon_rss;
203 
204 	unsigned long hiwater_rss;	/* High-watermark of RSS usage */
205 	unsigned long hiwater_vm;	/* High-water virtual memory usage */
206 
207 	unsigned long total_vm, locked_vm, shared_vm, exec_vm;
208 	unsigned long stack_vm, reserved_vm, def_flags, nr_ptes;
209 	unsigned long start_code, end_code, start_data, end_data;
210 	unsigned long start_brk, brk, start_stack;
211 	unsigned long arg_start, arg_end, env_start, env_end;
212 
213 	unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
214 
215 	cpumask_t cpu_vm_mask;
216 
217 	/* Architecture-specific MM context */
218 	mm_context_t context;
219 
220 	/* Swap token stuff */
221 	/*
222 	 * Last value of global fault stamp as seen by this process.
223 	 * In other words, this value gives an indication of how long
224 	 * it has been since this task got the token.
225 	 * Look at mm/thrash.c
226 	 */
227 	unsigned int faultstamp;
228 	unsigned int token_priority;
229 	unsigned int last_interval;
230 
231 	unsigned long flags; /* Must use atomic bitops to access the bits */
232 
233 	struct core_state *core_state; /* coredumping support */
234 
235 	/* aio bits */
236 	rwlock_t		ioctx_list_lock;	/* aio lock */
237 	struct kioctx		*ioctx_list;
238 #ifdef CONFIG_MM_OWNER
239 	/*
240 	 * "owner" points to a task that is regarded as the canonical
241 	 * user/owner of this mm. All of the following must be true in
242 	 * order for it to be changed:
243 	 *
244 	 * current == mm->owner
245 	 * current->mm != mm
246 	 * new_owner->mm == mm
247 	 * new_owner->alloc_lock is held
248 	 */
249 	struct task_struct *owner;
250 #endif
251 
252 #ifdef CONFIG_PROC_FS
253 	/* store ref to file /proc/<pid>/exe symlink points to */
254 	struct file *exe_file;
255 	unsigned long num_exe_file_vmas;
256 #endif
257 #ifdef CONFIG_MMU_NOTIFIER
258 	struct mmu_notifier_mm *mmu_notifier_mm;
259 #endif
260 };
261 
262 #endif /* _LINUX_MM_TYPES_H */
263