2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95
35 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36 * All rights reserved.
38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
40 * Permission to use, copy, modify and distribute this software and
41 * its documentation is hereby granted, provided that both the copyright
42 * notice and this permission notice appear in all copies of the
43 * software, derivative works or modified versions, and any portions
44 * thereof, and that both notices appear in supporting documentation.
46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
50 * Carnegie Mellon requests users of this software to return to
52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
53 * School of Computer Science
54 * Carnegie Mellon University
55 * Pittsburgh PA 15213-3890
57 * any improvements or extensions that they make and grant Carnegie the
58 * rights to redistribute these changes.
64 * Virtual memory map module definitions.
71 #include <sys/_mutex.h>
76 * vm_map_t the high-level address map data structure.
77 * vm_map_entry_t an entry in an address map.
80 typedef u_char vm_flags_t;
81 typedef u_int vm_eflags_t;
84 * Objects which live in maps may be either VM objects, or
85 * another map (called a "sharing map") which denotes read-write
86 * sharing with other maps.
89 struct vm_object *vm_object; /* object object */
90 struct vm_map *sub_map; /* belongs to another map */
94 * Address map entries consist of start and end addresses,
95 * a VM object (or sharing map) and offset into that object,
96 * and user-exported inheritance and protection information.
97 * Also included is control information for virtual copy operations.
100 struct vm_map_entry *prev; /* previous entry */
101 struct vm_map_entry *next; /* next entry */
102 struct vm_map_entry *left; /* left child in binary search tree */
103 struct vm_map_entry *right; /* right child in binary search tree */
104 vm_offset_t start; /* start address */
105 vm_offset_t end; /* end address */
106 vm_offset_t avail_ssize; /* amt can grow if this is a stack */
107 union vm_map_object object; /* object I point to */
108 vm_ooffset_t offset; /* offset into object */
109 vm_eflags_t eflags; /* map entry flags */
110 /* Only in task maps: */
111 vm_prot_t protection; /* protection code */
112 vm_prot_t max_protection; /* maximum protection */
113 vm_inherit_t inheritance; /* inheritance */
114 int wired_count; /* can be paged if = 0 */
115 vm_pindex_t lastr; /* last read */
118 #define MAP_ENTRY_NOSYNC 0x0001
119 #define MAP_ENTRY_IS_SUB_MAP 0x0002
120 #define MAP_ENTRY_COW 0x0004
121 #define MAP_ENTRY_NEEDS_COPY 0x0008
122 #define MAP_ENTRY_NOFAULT 0x0010
123 #define MAP_ENTRY_USER_WIRED 0x0020
125 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */
126 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */
127 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */
128 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */
130 #define MAP_ENTRY_BEHAV_MASK 0x00C0
132 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */
133 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */
134 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */
136 #define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */
137 #define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */
140 static __inline u_char
141 vm_map_entry_behavior(vm_map_entry_t entry)
143 return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
147 vm_map_entry_user_wired_count(vm_map_entry_t entry)
149 if (entry->eflags & MAP_ENTRY_USER_WIRED)
155 vm_map_entry_system_wired_count(vm_map_entry_t entry)
157 return (entry->wired_count - vm_map_entry_user_wired_count(entry));
162 * A map is a set of map entries. These map entries are
163 * organized both as a binary search tree and as a doubly-linked
164 * list. Both structures are ordered based upon the start and
165 * end addresses contained within each map entry. Sleator and
166 * Tarjan's top-down splay algorithm is employed to control
167 * height imbalance in the binary search tree.
169 * Note: the lock structure cannot be the first element of vm_map
170 * because this can result in a running lockup between two or more
171 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
172 * and free tsleep/waking up 'map' and the underlying lockmgr also
173 * sleeping and waking up on 'map'. The lockup occurs when the map fills
174 * up. The 'exec' map, for example.
177 * (c) const until freed
180 struct vm_map_entry header; /* List of entries */
181 struct sx lock; /* Lock for map data */
182 struct mtx system_mtx;
183 int nentries; /* Number of entries */
184 vm_size_t size; /* virtual size */
185 u_int timestamp; /* Version number */
187 u_char system_map; /* Am I a system map? */
188 u_char infork; /* Am I in fork processing? */
189 vm_flags_t flags; /* flags for this vm_map */
190 vm_map_entry_t root; /* Root of a binary search tree */
191 vm_map_entry_t first_free; /* First free space hint */
192 pmap_t pmap; /* (c) Physical map */
193 #define min_offset header.start /* (c) */
194 #define max_offset header.end /* (c) */
200 #define MAP_WIREFUTURE 0x01 /* wire all future pages */
203 static __inline vm_offset_t
204 vm_map_max(vm_map_t map)
206 return (map->max_offset);
209 static __inline vm_offset_t
210 vm_map_min(vm_map_t map)
212 return (map->min_offset);
215 static __inline pmap_t
216 vm_map_pmap(vm_map_t map)
222 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
224 map->flags = (map->flags | set) & ~clear;
229 * Shareable process virtual address space.
232 * (c) const until freed
235 struct vm_map vm_map; /* VM address map */
236 struct pmap vm_pmap; /* private physical map */
237 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */
238 segsz_t vm_swrss; /* resident set size before last swap */
239 segsz_t vm_tsize; /* text size (pages) XXX */
240 segsz_t vm_dsize; /* data size (pages) XXX */
241 segsz_t vm_ssize; /* stack size (pages) */
242 caddr_t vm_taddr; /* (c) user virtual address of text */
243 caddr_t vm_daddr; /* (c) user virtual address of data */
244 caddr_t vm_maxsaddr; /* user VA at max stack growth */
245 int vm_exitingcnt; /* several processes zombied in exit1 */
246 int vm_refcnt; /* number of references */
250 static __inline pmap_t
251 vmspace_pmap(struct vmspace *vmspace)
253 return &vmspace->vm_pmap;
259 * Macros: vm_map_lock, etc.
261 * Perform locking on the data portion of a map. Note that
262 * these macros mimic procedure calls returning void. The
263 * semicolon is supplied by the user of these macros, not
264 * by the macros themselves. The macros can safely be used
265 * as unbraced elements in a higher level statement.
268 void _vm_map_lock(vm_map_t map, const char *file, int line);
269 void _vm_map_unlock(vm_map_t map, const char *file, int line);
270 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
271 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
272 int _vm_map_trylock(vm_map_t map, const char *file, int line);
273 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
274 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
275 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
276 int vm_map_unlock_and_wait(vm_map_t map, boolean_t user_wait);
277 void vm_map_wakeup(vm_map_t map);
279 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE)
280 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
281 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
282 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
283 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
284 #define vm_map_trylock_read(map) \
285 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
286 #define vm_map_lock_upgrade(map) \
287 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
288 #define vm_map_lock_downgrade(map) \
289 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
291 long vmspace_resident_count(struct vmspace *vmspace);
292 long vmspace_wired_count(struct vmspace *vmspace);
296 /* XXX: number of kernel maps and entries to statically allocate */
298 #define MAX_KMAPENT 128
299 #define MAX_MAPENT 128
302 * Copy-on-write flags for vm_map operations
304 #define MAP_UNUSED_01 0x0001
305 #define MAP_COPY_ON_WRITE 0x0002
306 #define MAP_NOFAULT 0x0004
307 #define MAP_PREFAULT 0x0008
308 #define MAP_PREFAULT_PARTIAL 0x0010
309 #define MAP_DISABLE_SYNCER 0x0020
310 #define MAP_DISABLE_COREDUMP 0x0100
311 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */
312 #define MAP_STACK_GROWS_DOWN 0x1000
313 #define MAP_STACK_GROWS_UP 0x2000
316 * vm_fault option flags
318 #define VM_FAULT_NORMAL 0 /* Nothing special */
319 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */
320 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */
321 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
322 #define VM_FAULT_DIRTY 8 /* Dirty the page */
325 * vm_map_wire and vm_map_unwire option flags
327 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */
328 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */
330 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */
331 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */
334 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
335 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t);
336 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t);
337 int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int);
338 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *);
339 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
340 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t);
341 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);
342 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
343 vm_pindex_t *, vm_prot_t *, boolean_t *);
344 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
345 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
346 void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot,
347 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags);
348 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
349 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
350 void vm_map_startup (void);
351 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
352 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
353 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
354 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t);
355 void vm_init2 (void);
356 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
357 int vm_map_growstack (struct proc *p, vm_offset_t addr);
358 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
360 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end,
362 int vmspace_swap_count (struct vmspace *vmspace);
364 #endif /* _VM_MAP_ */