1 /* 2 * Copyright (c) 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * The Mach Operating System project at Carnegie-Mellon University. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 37 * 38 * 39 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 40 * All rights reserved. 41 * 42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 43 * 44 * Permission to use, copy, modify and distribute this software and 45 * its documentation is hereby granted, provided that both the copyright 46 * notice and this permission notice appear in all copies of the 47 * software, derivative works or modified versions, and any portions 48 * thereof, and that both notices appear in supporting documentation. 49 * 50 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 51 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 52 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 53 * 54 * Carnegie Mellon requests users of this software to return to 55 * 56 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 57 * School of Computer Science 58 * Carnegie Mellon University 59 * Pittsburgh PA 15213-3890 60 * 61 * any improvements or extensions that they make and grant Carnegie the 62 * rights to redistribute these changes. 63 * 64 * $FreeBSD$ 65 */ 66 67 /* 68 * Virtual memory map module definitions. 69 */ 70 #ifndef _VM_MAP_ 71 #define _VM_MAP_ 72 73 #include <sys/lock.h> 74 #include <sys/lockmgr.h> 75 #include <sys/_mutex.h> 76 77 /* 78 * Types defined: 79 * 80 * vm_map_t the high-level address map data structure. 81 * vm_map_entry_t an entry in an address map. 82 */ 83 84 typedef u_char vm_flags_t; 85 typedef u_int vm_eflags_t; 86 87 /* 88 * Objects which live in maps may be either VM objects, or 89 * another map (called a "sharing map") which denotes read-write 90 * sharing with other maps. 91 */ 92 union vm_map_object { 93 struct vm_object *vm_object; /* object object */ 94 struct vm_map *sub_map; /* belongs to another map */ 95 }; 96 97 /* 98 * Address map entries consist of start and end addresses, 99 * a VM object (or sharing map) and offset into that object, 100 * and user-exported inheritance and protection information. 101 * Also included is control information for virtual copy operations. 102 */ 103 struct vm_map_entry { 104 struct vm_map_entry *prev; /* previous entry */ 105 struct vm_map_entry *next; /* next entry */ 106 struct vm_map_entry *left; /* left child in binary search tree */ 107 struct vm_map_entry *right; /* right child in binary search tree */ 108 vm_offset_t start; /* start address */ 109 vm_offset_t end; /* end address */ 110 vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 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 /* Only in task maps: */ 115 vm_prot_t protection; /* protection code */ 116 vm_prot_t max_protection; /* maximum protection */ 117 vm_inherit_t inheritance; /* inheritance */ 118 int wired_count; /* can be paged if = 0 */ 119 vm_pindex_t lastr; /* last read */ 120 }; 121 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 128 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 */ 133 134 #define MAP_ENTRY_BEHAV_MASK 0x00C0 135 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 */ 139 140 #define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */ 141 #define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */ 142 143 #ifdef _KERNEL 144 static __inline u_char 145 vm_map_entry_behavior(vm_map_entry_t entry) 146 { 147 return (entry->eflags & MAP_ENTRY_BEHAV_MASK); 148 } 149 #endif /* _KERNEL */ 150 151 /* 152 * A map is a set of map entries. These map entries are 153 * organized both as a binary search tree and as a doubly-linked 154 * list. Both structures are ordered based upon the start and 155 * end addresses contained within each map entry. Sleator and 156 * Tarjan's top-down splay algorithm is employed to control 157 * height imbalance in the binary search tree. 158 * 159 * Note: the lock structure cannot be the first element of vm_map 160 * because this can result in a running lockup between two or more 161 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait() 162 * and free tsleep/waking up 'map' and the underlying lockmgr also 163 * sleeping and waking up on 'map'. The lockup occurs when the map fills 164 * up. The 'exec' map, for example. 165 * 166 * List of locks 167 * (c) const until freed 168 */ 169 struct vm_map { 170 struct vm_map_entry header; /* List of entries */ 171 struct lock lock; /* Lock for map data */ 172 struct mtx system_mtx; 173 int nentries; /* Number of entries */ 174 vm_size_t size; /* virtual size */ 175 u_int timestamp; /* Version number */ 176 u_char needs_wakeup; 177 u_char system_map; /* Am I a system map? */ 178 u_char infork; /* Am I in fork processing? */ 179 vm_flags_t flags; /* flags for this vm_map */ 180 vm_map_entry_t root; /* Root of a binary search tree */ 181 vm_map_entry_t first_free; /* First free space hint */ 182 pmap_t pmap; /* (c) Physical map */ 183 #define min_offset header.start /* (c) */ 184 #define max_offset header.end /* (c) */ 185 }; 186 187 /* 188 * vm_flags_t values 189 */ 190 #define MAP_WIREFUTURE 0x01 /* wire all future pages */ 191 192 #ifdef _KERNEL 193 static __inline vm_offset_t 194 vm_map_max(vm_map_t map) 195 { 196 return (map->max_offset); 197 } 198 199 static __inline vm_offset_t 200 vm_map_min(vm_map_t map) 201 { 202 return (map->min_offset); 203 } 204 205 static __inline pmap_t 206 vm_map_pmap(vm_map_t map) 207 { 208 return (map->pmap); 209 } 210 211 static __inline void 212 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 213 { 214 map->flags = (map->flags | set) & ~clear; 215 } 216 #endif /* _KERNEL */ 217 218 /* 219 * Shareable process virtual address space. 220 * 221 * List of locks 222 * (c) const until freed 223 */ 224 struct vmspace { 225 struct vm_map vm_map; /* VM address map */ 226 struct pmap vm_pmap; /* private physical map */ 227 int vm_refcnt; /* number of references */ 228 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 229 /* we copy from vm_startcopy to the end of the structure on fork */ 230 #define vm_startcopy vm_rssize 231 segsz_t vm_rssize; /* current resident set size in pages */ 232 segsz_t vm_swrss; /* resident set size before last swap */ 233 segsz_t vm_tsize; /* text size (pages) XXX */ 234 segsz_t vm_dsize; /* data size (pages) XXX */ 235 segsz_t vm_ssize; /* stack size (pages) */ 236 caddr_t vm_taddr; /* (c) user virtual address of text */ 237 caddr_t vm_daddr; /* (c) user virtual address of data */ 238 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 239 #define vm_endcopy vm_exitingcnt 240 int vm_exitingcnt; /* several processes zombied in exit1 */ 241 }; 242 243 #ifdef _KERNEL 244 static __inline pmap_t 245 vmspace_pmap(struct vmspace *vmspace) 246 { 247 return &vmspace->vm_pmap; 248 } 249 #endif /* _KERNEL */ 250 251 #ifdef _KERNEL 252 /* 253 * Macros: vm_map_lock, etc. 254 * Function: 255 * Perform locking on the data portion of a map. Note that 256 * these macros mimic procedure calls returning void. The 257 * semicolon is supplied by the user of these macros, not 258 * by the macros themselves. The macros can safely be used 259 * as unbraced elements in a higher level statement. 260 */ 261 262 void _vm_map_lock(vm_map_t map, const char *file, int line); 263 void _vm_map_unlock(vm_map_t map, const char *file, int line); 264 void _vm_map_lock_read(vm_map_t map, const char *file, int line); 265 void _vm_map_unlock_read(vm_map_t map, const char *file, int line); 266 int _vm_map_trylock(vm_map_t map, const char *file, int line); 267 int _vm_map_trylock_read(vm_map_t map, const char *file, int line); 268 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 269 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 270 int vm_map_unlock_and_wait(vm_map_t map, boolean_t user_wait); 271 void vm_map_wakeup(vm_map_t map); 272 273 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 274 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 275 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 276 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 277 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 278 #define vm_map_trylock_read(map) \ 279 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 280 #define vm_map_lock_upgrade(map) \ 281 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 282 #define vm_map_lock_downgrade(map) \ 283 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 284 285 long vmspace_resident_count(struct vmspace *vmspace); 286 #endif /* _KERNEL */ 287 288 289 /* XXX: number of kernel maps and entries to statically allocate */ 290 #define MAX_KMAP 10 291 #define MAX_KMAPENT 128 292 #define MAX_MAPENT 128 293 294 /* 295 * Copy-on-write flags for vm_map operations 296 */ 297 #define MAP_UNUSED_01 0x0001 298 #define MAP_COPY_ON_WRITE 0x0002 299 #define MAP_NOFAULT 0x0004 300 #define MAP_PREFAULT 0x0008 301 #define MAP_PREFAULT_PARTIAL 0x0010 302 #define MAP_DISABLE_SYNCER 0x0020 303 #define MAP_DISABLE_COREDUMP 0x0100 304 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 305 306 /* 307 * vm_fault option flags 308 */ 309 #define VM_FAULT_NORMAL 0 /* Nothing special */ 310 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 311 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */ 312 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 313 #define VM_FAULT_DIRTY 8 /* Dirty the page */ 314 315 /* 316 * vm_map_wire and vm_map_unwire option flags 317 */ 318 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 319 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 320 321 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 322 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 323 324 #ifdef _KERNEL 325 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 326 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 327 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t); 328 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); 329 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 330 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 331 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t); 332 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); 333 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 334 vm_pindex_t *, vm_prot_t *, boolean_t *); 335 void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 336 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 337 int vm_map_clean (vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 338 void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, 339 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags); 340 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 341 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 342 void vm_map_startup (void); 343 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 344 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 345 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 346 void vm_init2 (void); 347 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 348 int vm_map_growstack (struct proc *p, vm_offset_t addr); 349 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 350 int flags); 351 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, 352 int flags); 353 int vmspace_swap_count (struct vmspace *vmspace); 354 #endif /* _KERNEL */ 355 #endif /* _VM_MAP_ */ 356