2 * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
4 * Copyright (c) 1991, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * The Mach Operating System project at Carnegie-Mellon University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95
37 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38 * All rights reserved.
40 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
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.
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.
52 * Carnegie Mellon requests users of this software to return to
54 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
55 * School of Computer Science
56 * Carnegie Mellon University
57 * Pittsburgh PA 15213-3890
59 * any improvements or extensions that they make and grant Carnegie the
60 * rights to redistribute these changes.
66 * Virtual memory map module definitions.
73 #include <sys/_mutex.h>
78 * vm_map_t the high-level address map data structure.
79 * vm_map_entry_t an entry in an address map.
82 typedef u_char vm_flags_t;
83 typedef u_int vm_eflags_t;
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.
91 struct vm_object *vm_object; /* object object */
92 struct vm_map *sub_map; /* belongs to another map */
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.
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 max_free; /* max free space in subtree */
110 union vm_map_object object; /* object I point to */
111 vm_ooffset_t offset; /* offset into object */
112 vm_eflags_t eflags; /* map entry flags */
113 vm_prot_t protection; /* protection code */
114 vm_prot_t max_protection; /* maximum protection */
115 vm_inherit_t inheritance; /* inheritance */
116 uint8_t read_ahead; /* pages in the read-ahead window */
117 int wired_count; /* can be paged if = 0 */
118 struct ucred *cred; /* tmp storage for creator ref */
119 struct thread *wiring_thread;
122 #define MAP_ENTRY_NOSYNC 0x0001
123 #define MAP_ENTRY_IS_SUB_MAP 0x0002
124 #define MAP_ENTRY_COW 0x0004
125 #define MAP_ENTRY_NEEDS_COPY 0x0008
126 #define MAP_ENTRY_NOFAULT 0x0010
127 #define MAP_ENTRY_USER_WIRED 0x0020
129 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */
130 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */
131 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */
132 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */
134 #define MAP_ENTRY_BEHAV_MASK 0x00C0
136 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */
137 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */
138 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */
140 #define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */
141 #define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */
143 #define MAP_ENTRY_WIRE_SKIPPED 0x4000
144 #define MAP_ENTRY_VN_WRITECNT 0x8000 /* writeable vnode mapping */
145 #define MAP_ENTRY_GUARD 0x10000
146 #define MAP_ENTRY_STACK_GAP_DN 0x20000
147 #define MAP_ENTRY_STACK_GAP_UP 0x40000
148 #define MAP_ENTRY_HEADER 0x80000
151 static __inline u_char
152 vm_map_entry_behavior(vm_map_entry_t entry)
154 return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
158 vm_map_entry_user_wired_count(vm_map_entry_t entry)
160 if (entry->eflags & MAP_ENTRY_USER_WIRED)
166 vm_map_entry_system_wired_count(vm_map_entry_t entry)
168 return (entry->wired_count - vm_map_entry_user_wired_count(entry));
173 * A map is a set of map entries. These map entries are
174 * organized both as a binary search tree and as a doubly-linked
175 * list. Both structures are ordered based upon the start and
176 * end addresses contained within each map entry.
178 * Sleator and Tarjan's top-down splay algorithm is employed to
179 * control height imbalance in the binary search tree.
181 * The map's min offset value is stored in map->header.end, and
182 * its max offset value is stored in map->header.start. These
183 * values act as sentinels for any forward or backward address
184 * scan of the list. The map header has a special value for the
185 * eflags field, MAP_ENTRY_HEADER, that is set initially, is
186 * never changed, and prevents an eflags match of the header
187 * with any other map entry.
190 * (c) const until freed
193 struct vm_map_entry header; /* List of entries */
194 struct sx lock; /* Lock for map data */
195 struct mtx system_mtx;
196 int nentries; /* Number of entries */
197 vm_size_t size; /* virtual size */
198 u_int timestamp; /* Version number */
200 u_char system_map; /* (c) Am I a system map? */
201 vm_flags_t flags; /* flags for this vm_map */
202 vm_map_entry_t root; /* Root of a binary search tree */
203 pmap_t pmap; /* (c) Physical map */
204 vm_offset_t anon_loc;
211 #define MAP_WIREFUTURE 0x01 /* wire all future pages */
212 #define MAP_BUSY_WAKEUP 0x02
213 #define MAP_IS_SUB_MAP 0x04 /* has parent */
214 #define MAP_ASLR 0x08 /* enabled ASLR */
215 #define MAP_ASLR_IGNSTART 0x10
218 #if defined(KLD_MODULE) && !defined(KLD_TIED)
219 #define vm_map_max(map) vm_map_max_KBI((map))
220 #define vm_map_min(map) vm_map_min_KBI((map))
221 #define vm_map_pmap(map) vm_map_pmap_KBI((map))
223 static __inline vm_offset_t
224 vm_map_max(const struct vm_map *map)
227 return (map->header.start);
230 static __inline vm_offset_t
231 vm_map_min(const struct vm_map *map)
234 return (map->header.end);
237 static __inline pmap_t
238 vm_map_pmap(vm_map_t map)
244 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
246 map->flags = (map->flags | set) & ~clear;
248 #endif /* KLD_MODULE */
252 * Shareable process virtual address space.
255 * (c) const until freed
258 struct vm_map vm_map; /* VM address map */
259 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */
260 segsz_t vm_swrss; /* resident set size before last swap */
261 segsz_t vm_tsize; /* text size (pages) XXX */
262 segsz_t vm_dsize; /* data size (pages) XXX */
263 segsz_t vm_ssize; /* stack size (pages) */
264 caddr_t vm_taddr; /* (c) user virtual address of text */
265 caddr_t vm_daddr; /* (c) user virtual address of data */
266 caddr_t vm_maxsaddr; /* user VA at max stack growth */
267 volatile int vm_refcnt; /* number of references */
269 * Keep the PMAP last, so that CPU-specific variations of that
270 * structure on a single architecture don't result in offset
271 * variations of the machine-independent fields in the vmspace.
273 struct pmap vm_pmap; /* private physical map */
277 static __inline pmap_t
278 vmspace_pmap(struct vmspace *vmspace)
280 return &vmspace->vm_pmap;
286 * Macros: vm_map_lock, etc.
288 * Perform locking on the data portion of a map. Note that
289 * these macros mimic procedure calls returning void. The
290 * semicolon is supplied by the user of these macros, not
291 * by the macros themselves. The macros can safely be used
292 * as unbraced elements in a higher level statement.
295 void _vm_map_lock(vm_map_t map, const char *file, int line);
296 void _vm_map_unlock(vm_map_t map, const char *file, int line);
297 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line);
298 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
299 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
300 int _vm_map_trylock(vm_map_t map, const char *file, int line);
301 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
302 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
303 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
304 int vm_map_locked(vm_map_t map);
305 void vm_map_wakeup(vm_map_t map);
306 void vm_map_busy(vm_map_t map);
307 void vm_map_unbusy(vm_map_t map);
308 void vm_map_wait_busy(vm_map_t map);
309 vm_offset_t vm_map_max_KBI(const struct vm_map *map);
310 vm_offset_t vm_map_min_KBI(const struct vm_map *map);
311 pmap_t vm_map_pmap_KBI(vm_map_t map);
313 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE)
314 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
315 #define vm_map_unlock_and_wait(map, timo) \
316 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE)
317 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
318 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
319 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
320 #define vm_map_trylock_read(map) \
321 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
322 #define vm_map_lock_upgrade(map) \
323 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
324 #define vm_map_lock_downgrade(map) \
325 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
327 long vmspace_resident_count(struct vmspace *vmspace);
331 /* XXX: number of kernel maps to statically allocate */
335 * Copy-on-write flags for vm_map operations
337 #define MAP_INHERIT_SHARE 0x0001
338 #define MAP_COPY_ON_WRITE 0x0002
339 #define MAP_NOFAULT 0x0004
340 #define MAP_PREFAULT 0x0008
341 #define MAP_PREFAULT_PARTIAL 0x0010
342 #define MAP_DISABLE_SYNCER 0x0020
343 #define MAP_CHECK_EXCL 0x0040
344 #define MAP_CREATE_GUARD 0x0080
345 #define MAP_DISABLE_COREDUMP 0x0100
346 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */
347 #define MAP_VN_WRITECOUNT 0x0400
348 #define MAP_REMAP 0x0800
349 #define MAP_STACK_GROWS_DOWN 0x1000
350 #define MAP_STACK_GROWS_UP 0x2000
351 #define MAP_ACC_CHARGED 0x4000
352 #define MAP_ACC_NO_CHARGE 0x8000
353 #define MAP_CREATE_STACK_GAP_UP 0x10000
354 #define MAP_CREATE_STACK_GAP_DN 0x20000
357 * vm_fault option flags
359 #define VM_FAULT_NORMAL 0 /* Nothing special */
360 #define VM_FAULT_WIRE 1 /* Wire the mapped page */
361 #define VM_FAULT_DIRTY 2 /* Dirty the page; use w/VM_PROT_COPY */
364 * Initially, mappings are slightly sequential. The maximum window size must
365 * account for the map entry's "read_ahead" field being defined as an uint8_t.
367 #define VM_FAULT_READ_AHEAD_MIN 7
368 #define VM_FAULT_READ_AHEAD_INIT 15
369 #define VM_FAULT_READ_AHEAD_MAX min(atop(MAXPHYS) - 1, UINT8_MAX)
372 * The following "find_space" options are supported by vm_map_find().
374 * For VMFS_ALIGNED_SPACE, the desired alignment is specified to
375 * the macro argument as log base 2 of the desired alignment.
377 #define VMFS_NO_SPACE 0 /* don't find; use the given range */
378 #define VMFS_ANY_SPACE 1 /* find a range with any alignment */
379 #define VMFS_OPTIMAL_SPACE 2 /* find a range with optimal alignment*/
380 #define VMFS_SUPER_SPACE 3 /* find a superpage-aligned range */
381 #define VMFS_ALIGNED_SPACE(x) ((x) << 8) /* find a range with fixed alignment */
384 * vm_map_wire and vm_map_unwire option flags
386 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */
387 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */
389 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */
390 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */
392 #define VM_MAP_WIRE_WRITE 4 /* Validate writable. */
395 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
396 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t);
397 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t);
398 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t,
399 vm_offset_t, int, vm_prot_t, vm_prot_t, int);
400 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
401 vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
402 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t,
403 vm_prot_t, vm_prot_t, int);
404 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t);
405 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
406 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t);
407 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);
408 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
409 vm_pindex_t *, vm_prot_t *, boolean_t *);
410 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
411 vm_pindex_t *, vm_prot_t *, boolean_t *);
412 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
413 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
414 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
415 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
416 void vm_map_simplify_entry(vm_map_t map, vm_map_entry_t entry);
417 void vm_map_startup (void);
418 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
419 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
420 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
421 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
422 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
424 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end,
426 long vmspace_swap_count(struct vmspace *vmspace);
428 #endif /* _VM_MAP_ */