1 /*-
2 * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
3 *
4 * Copyright (c) 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * The Mach Operating System project at Carnegie-Mellon University.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95
35 *
36 *
37 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38 * All rights reserved.
39 *
40 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
41 *
42 * Permission to use, copy, modify and distribute this software and
43 * its documentation is hereby granted, provided that both the copyright
44 * notice and this permission notice appear in all copies of the
45 * software, derivative works or modified versions, and any portions
46 * thereof, and that both notices appear in supporting documentation.
47 *
48 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
49 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
50 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
51 *
52 * Carnegie Mellon requests users of this software to return to
53 *
54 * Software Distribution Coordinator or [email protected]
55 * School of Computer Science
56 * Carnegie Mellon University
57 * Pittsburgh PA 15213-3890
58 *
59 * any improvements or extensions that they make and grant Carnegie the
60 * rights to redistribute these changes.
61 *
62 * $FreeBSD$
63 */
64
65 /*
66 * Virtual memory map module definitions.
67 */
68 #ifndef _VM_MAP_
69 #define _VM_MAP_
70
71 #include <sys/lock.h>
72 #include <sys/sx.h>
73 #include <sys/_mutex.h>
74
75 /*
76 * Types defined:
77 *
78 * vm_map_t the high-level address map data structure.
79 * vm_map_entry_t an entry in an address map.
80 */
81
82 typedef u_char vm_flags_t;
83 typedef u_int vm_eflags_t;
84
85 /*
86 * Objects which live in maps may be either VM objects, or
87 * another map (called a "sharing map") which denotes read-write
88 * sharing with other maps.
89 */
90 union vm_map_object {
91 struct vm_object *vm_object; /* object object */
92 struct vm_map *sub_map; /* belongs to another map */
93 };
94
95 /*
96 * Address map entries consist of start and end addresses,
97 * a VM object (or sharing map) and offset into that object,
98 * and user-exported inheritance and protection information.
99 * Also included is control information for virtual copy operations.
100 */
101 struct vm_map_entry {
102 struct vm_map_entry *prev; /* previous entry */
103 struct vm_map_entry *next; /* next entry */
104 struct vm_map_entry *left; /* left child in binary search tree */
105 struct vm_map_entry *right; /* right child in binary search tree */
106 vm_offset_t start; /* start address */
107 vm_offset_t end; /* end address */
108 vm_offset_t next_read; /* vaddr of the next sequential read */
109 vm_size_t pad_adj_free; /* pad */
110 vm_size_t max_free; /* max free space in subtree */
111 union vm_map_object object; /* object I point to */
112 vm_ooffset_t offset; /* offset into object */
113 vm_eflags_t eflags; /* map entry flags */
114 vm_prot_t protection; /* protection code */
115 vm_prot_t max_protection; /* maximum protection */
116 vm_inherit_t inheritance; /* inheritance */
117 uint8_t read_ahead; /* pages in the read-ahead window */
118 int wired_count; /* can be paged if = 0 */
119 struct ucred *cred; /* tmp storage for creator ref */
120 struct thread *wiring_thread;
121 };
122
123 #define MAP_ENTRY_NOSYNC 0x00000001
124 #define MAP_ENTRY_IS_SUB_MAP 0x00000002
125 #define MAP_ENTRY_COW 0x00000004
126 #define MAP_ENTRY_NEEDS_COPY 0x00000008
127 #define MAP_ENTRY_NOFAULT 0x00000010
128 #define MAP_ENTRY_USER_WIRED 0x00000020
129
130 #define MAP_ENTRY_BEHAV_NORMAL 0x00000000 /* default behavior */
131 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x00000040 /* expect sequential
132 access */
133 #define MAP_ENTRY_BEHAV_RANDOM 0x00000080 /* expect random
134 access */
135 #define MAP_ENTRY_BEHAV_RESERVED 0x000000c0 /* future use */
136 #define MAP_ENTRY_BEHAV_MASK 0x000000c0
137 #define MAP_ENTRY_IN_TRANSITION 0x00000100 /* entry being
138 changed */
139 #define MAP_ENTRY_NEEDS_WAKEUP 0x00000200 /* waiters in
140 transition */
141 #define MAP_ENTRY_NOCOREDUMP 0x00000400 /* don't include in
142 a core */
143 #define MAP_ENTRY_VN_EXEC 0x00000800 /* text vnode mapping */
144 #define MAP_ENTRY_GROWS_DOWN 0x00001000 /* top-down stacks */
145 #define MAP_ENTRY_GROWS_UP 0x00002000 /* bottom-up stacks */
146
147 #define MAP_ENTRY_WIRE_SKIPPED 0x00004000
148 #define MAP_ENTRY_VN_WRITECNT 0x00008000 /* writeable vnode
149 mapping */
150 #define MAP_ENTRY_GUARD 0x00010000
151 #define MAP_ENTRY_STACK_GAP_DN 0x00020000
152 #define MAP_ENTRY_STACK_GAP_UP 0x00040000
153 #define MAP_ENTRY_HEADER 0x00080000
154
155 #ifdef _KERNEL
156 static __inline u_char
vm_map_entry_behavior(vm_map_entry_t entry)157 vm_map_entry_behavior(vm_map_entry_t entry)
158 {
159 return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
160 }
161
162 static __inline int
vm_map_entry_user_wired_count(vm_map_entry_t entry)163 vm_map_entry_user_wired_count(vm_map_entry_t entry)
164 {
165 if (entry->eflags & MAP_ENTRY_USER_WIRED)
166 return (1);
167 return (0);
168 }
169
170 static __inline int
vm_map_entry_system_wired_count(vm_map_entry_t entry)171 vm_map_entry_system_wired_count(vm_map_entry_t entry)
172 {
173 return (entry->wired_count - vm_map_entry_user_wired_count(entry));
174 }
175 #endif /* _KERNEL */
176
177 /*
178 * A map is a set of map entries. These map entries are
179 * organized both as a binary search tree and as a doubly-linked
180 * list. Both structures are ordered based upon the start and
181 * end addresses contained within each map entry.
182 *
183 * Sleator and Tarjan's top-down splay algorithm is employed to
184 * control height imbalance in the binary search tree.
185 *
186 * The map's min offset value is stored in map->header.end, and
187 * its max offset value is stored in map->header.start. These
188 * values act as sentinels for any forward or backward address
189 * scan of the list. The map header has a special value for the
190 * eflags field, MAP_ENTRY_HEADER, that is set initially, is
191 * never changed, and prevents an eflags match of the header
192 * with any other map entry.
193 *
194 * List of locks
195 * (c) const until freed
196 */
197 struct vm_map {
198 struct vm_map_entry header; /* List of entries */
199 struct sx lock; /* Lock for map data */
200 struct mtx system_mtx;
201 int nentries; /* Number of entries */
202 vm_size_t size; /* virtual size */
203 u_int timestamp; /* Version number */
204 u_char needs_wakeup;
205 u_char system_map; /* (c) Am I a system map? */
206 vm_flags_t flags; /* flags for this vm_map */
207 vm_map_entry_t root; /* Root of a binary search tree */
208 pmap_t pmap; /* (c) Physical map */
209 vm_offset_t anon_loc;
210 int busy;
211 };
212
213 /*
214 * vm_flags_t values
215 */
216 #define MAP_WIREFUTURE 0x01 /* wire all future pages */
217 #define MAP_BUSY_WAKEUP 0x02
218 #define MAP_IS_SUB_MAP 0x04 /* has parent */
219 #define MAP_ASLR 0x08 /* enabled ASLR */
220 #define MAP_ASLR_IGNSTART 0x10
221
222 #ifdef _KERNEL
223 #if defined(KLD_MODULE) && !defined(KLD_TIED)
224 #define vm_map_max(map) vm_map_max_KBI((map))
225 #define vm_map_min(map) vm_map_min_KBI((map))
226 #define vm_map_pmap(map) vm_map_pmap_KBI((map))
227 #else
228 static __inline vm_offset_t
vm_map_max(const struct vm_map * map)229 vm_map_max(const struct vm_map *map)
230 {
231
232 return (map->header.start);
233 }
234
235 static __inline vm_offset_t
vm_map_min(const struct vm_map * map)236 vm_map_min(const struct vm_map *map)
237 {
238
239 return (map->header.end);
240 }
241
242 static __inline pmap_t
vm_map_pmap(vm_map_t map)243 vm_map_pmap(vm_map_t map)
244 {
245 return (map->pmap);
246 }
247
248 static __inline void
vm_map_modflags(vm_map_t map,vm_flags_t set,vm_flags_t clear)249 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
250 {
251 map->flags = (map->flags | set) & ~clear;
252 }
253 #endif /* KLD_MODULE */
254 #endif /* _KERNEL */
255
256 /*
257 * Shareable process virtual address space.
258 *
259 * List of locks
260 * (c) const until freed
261 */
262 struct vmspace {
263 struct vm_map vm_map; /* VM address map */
264 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */
265 segsz_t vm_swrss; /* resident set size before last swap */
266 segsz_t vm_tsize; /* text size (pages) XXX */
267 segsz_t vm_dsize; /* data size (pages) XXX */
268 segsz_t vm_ssize; /* stack size (pages) */
269 caddr_t vm_taddr; /* (c) user virtual address of text */
270 caddr_t vm_daddr; /* (c) user virtual address of data */
271 caddr_t vm_maxsaddr; /* user VA at max stack growth */
272 volatile int vm_refcnt; /* number of references */
273 /*
274 * Keep the PMAP last, so that CPU-specific variations of that
275 * structure on a single architecture don't result in offset
276 * variations of the machine-independent fields in the vmspace.
277 */
278 struct pmap vm_pmap; /* private physical map */
279 };
280
281 #ifdef _KERNEL
282 static __inline pmap_t
vmspace_pmap(struct vmspace * vmspace)283 vmspace_pmap(struct vmspace *vmspace)
284 {
285 return &vmspace->vm_pmap;
286 }
287 #endif /* _KERNEL */
288
289 #ifdef _KERNEL
290 /*
291 * Macros: vm_map_lock, etc.
292 * Function:
293 * Perform locking on the data portion of a map. Note that
294 * these macros mimic procedure calls returning void. The
295 * semicolon is supplied by the user of these macros, not
296 * by the macros themselves. The macros can safely be used
297 * as unbraced elements in a higher level statement.
298 */
299
300 void _vm_map_lock(vm_map_t map, const char *file, int line);
301 void _vm_map_unlock(vm_map_t map, const char *file, int line);
302 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line);
303 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
304 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
305 int _vm_map_trylock(vm_map_t map, const char *file, int line);
306 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
307 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
308 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
309 int vm_map_locked(vm_map_t map);
310 void vm_map_wakeup(vm_map_t map);
311 void vm_map_busy(vm_map_t map);
312 void vm_map_unbusy(vm_map_t map);
313 void vm_map_wait_busy(vm_map_t map);
314 vm_offset_t vm_map_max_KBI(const struct vm_map *map);
315 vm_offset_t vm_map_min_KBI(const struct vm_map *map);
316 pmap_t vm_map_pmap_KBI(vm_map_t map);
317
318 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE)
319 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
320 #define vm_map_unlock_and_wait(map, timo) \
321 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE)
322 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
323 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
324 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
325 #define vm_map_trylock_read(map) \
326 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
327 #define vm_map_lock_upgrade(map) \
328 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
329 #define vm_map_lock_downgrade(map) \
330 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
331
332 long vmspace_resident_count(struct vmspace *vmspace);
333 #endif /* _KERNEL */
334
335
336 /* XXX: number of kernel maps to statically allocate */
337 #define MAX_KMAP 10
338
339 /*
340 * Copy-on-write flags for vm_map operations
341 */
342 #define MAP_INHERIT_SHARE 0x00000001
343 #define MAP_COPY_ON_WRITE 0x00000002
344 #define MAP_NOFAULT 0x00000004
345 #define MAP_PREFAULT 0x00000008
346 #define MAP_PREFAULT_PARTIAL 0x00000010
347 #define MAP_DISABLE_SYNCER 0x00000020
348 #define MAP_CHECK_EXCL 0x00000040
349 #define MAP_CREATE_GUARD 0x00000080
350 #define MAP_DISABLE_COREDUMP 0x00000100
351 #define MAP_PREFAULT_MADVISE 0x00000200 /* from (user) madvise request */
352 #define MAP_VN_WRITECOUNT 0x00000400
353 #define MAP_REMAP 0x00000800
354 #define MAP_STACK_GROWS_DOWN 0x00001000
355 #define MAP_STACK_GROWS_UP 0x00002000
356 #define MAP_ACC_CHARGED 0x00004000
357 #define MAP_ACC_NO_CHARGE 0x00008000
358 #define MAP_CREATE_STACK_GAP_UP 0x00010000
359 #define MAP_CREATE_STACK_GAP_DN 0x00020000
360 #define MAP_VN_EXEC 0x00040000
361
362 /*
363 * vm_fault option flags
364 */
365 #define VM_FAULT_NORMAL 0 /* Nothing special */
366 #define VM_FAULT_WIRE 1 /* Wire the mapped page */
367 #define VM_FAULT_DIRTY 2 /* Dirty the page; use w/VM_PROT_COPY */
368
369 /*
370 * Initially, mappings are slightly sequential. The maximum window size must
371 * account for the map entry's "read_ahead" field being defined as an uint8_t.
372 */
373 #define VM_FAULT_READ_AHEAD_MIN 7
374 #define VM_FAULT_READ_AHEAD_INIT 15
375 #define VM_FAULT_READ_AHEAD_MAX min(atop(MAXPHYS) - 1, UINT8_MAX)
376
377 /*
378 * The following "find_space" options are supported by vm_map_find().
379 *
380 * For VMFS_ALIGNED_SPACE, the desired alignment is specified to
381 * the macro argument as log base 2 of the desired alignment.
382 */
383 #define VMFS_NO_SPACE 0 /* don't find; use the given range */
384 #define VMFS_ANY_SPACE 1 /* find a range with any alignment */
385 #define VMFS_OPTIMAL_SPACE 2 /* find a range with optimal alignment*/
386 #define VMFS_SUPER_SPACE 3 /* find a superpage-aligned range */
387 #define VMFS_ALIGNED_SPACE(x) ((x) << 8) /* find a range with fixed alignment */
388
389 /*
390 * vm_map_wire and vm_map_unwire option flags
391 */
392 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */
393 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */
394
395 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */
396 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */
397
398 #define VM_MAP_WIRE_WRITE 4 /* Validate writable. */
399
400 #ifdef _KERNEL
401 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
402 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t);
403 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t);
404 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t,
405 vm_offset_t, int, vm_prot_t, vm_prot_t, int);
406 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
407 vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
408 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t,
409 vm_prot_t, vm_prot_t, int);
410 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t);
411 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
412 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t);
413 int vm_map_insert (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int);
414 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
415 vm_pindex_t *, vm_prot_t *, boolean_t *);
416 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
417 vm_pindex_t *, vm_prot_t *, boolean_t *);
418 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
419 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
420 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
421 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
422 void vm_map_simplify_entry(vm_map_t map, vm_map_entry_t entry);
423 void vm_map_startup (void);
424 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
425 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
426 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
427 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
428 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
429 int flags);
430 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end,
431 int flags);
432 long vmspace_swap_count(struct vmspace *vmspace);
433 void vm_map_entry_set_vnode_text(vm_map_entry_t entry, bool add);
434 #endif /* _KERNEL */
435 #endif /* _VM_MAP_ */
436