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 * 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. 19 * 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 30 * SUCH DAMAGE. 31 * 32 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 33 * 34 * 35 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 36 * All rights reserved. 37 * 38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 39 * 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. 45 * 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. 49 * 50 * Carnegie Mellon requests users of this software to return to 51 * 52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 53 * School of Computer Science 54 * Carnegie Mellon University 55 * Pittsburgh PA 15213-3890 56 * 57 * any improvements or extensions that they make and grant Carnegie the 58 * rights to redistribute these changes. 59 * 60 * $FreeBSD$ 61 */ 62 63 /* 64 * Virtual memory map module definitions. 65 */ 66 #ifndef _VM_MAP_ 67 #define _VM_MAP_ 68 69 #include <sys/lock.h> 70 #include <sys/sx.h> 71 #include <sys/_mutex.h> 72 73 /* 74 * Types defined: 75 * 76 * vm_map_t the high-level address map data structure. 77 * vm_map_entry_t an entry in an address map. 78 */ 79 80 typedef u_char vm_flags_t; 81 typedef u_int vm_eflags_t; 82 83 /* 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. 87 */ 88 union vm_map_object { 89 struct vm_object *vm_object; /* object object */ 90 struct vm_map *sub_map; /* belongs to another map */ 91 }; 92 93 /* 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. 98 */ 99 struct vm_map_entry { 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 vm_size_t adj_free; /* amount of adjacent free space */ 108 vm_size_t max_free; /* max free space in subtree */ 109 union vm_map_object object; /* object I point to */ 110 vm_ooffset_t offset; /* offset into object */ 111 vm_eflags_t eflags; /* map entry flags */ 112 vm_prot_t protection; /* protection code */ 113 vm_prot_t max_protection; /* maximum protection */ 114 vm_inherit_t inheritance; /* inheritance */ 115 int wired_count; /* can be paged if = 0 */ 116 vm_pindex_t lastr; /* last read */ 117 struct uidinfo *uip; /* tmp storage for creator ref */ 118 }; 119 120 #define MAP_ENTRY_NOSYNC 0x0001 121 #define MAP_ENTRY_IS_SUB_MAP 0x0002 122 #define MAP_ENTRY_COW 0x0004 123 #define MAP_ENTRY_NEEDS_COPY 0x0008 124 #define MAP_ENTRY_NOFAULT 0x0010 125 #define MAP_ENTRY_USER_WIRED 0x0020 126 127 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 128 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 129 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 130 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 131 132 #define MAP_ENTRY_BEHAV_MASK 0x00C0 133 134 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */ 135 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */ 136 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 137 138 #define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */ 139 #define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */ 140 141 #define MAP_ENTRY_WIRE_SKIPPED 0x4000 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 150 static __inline int 151 vm_map_entry_user_wired_count(vm_map_entry_t entry) 152 { 153 if (entry->eflags & MAP_ENTRY_USER_WIRED) 154 return (1); 155 return (0); 156 } 157 158 static __inline int 159 vm_map_entry_system_wired_count(vm_map_entry_t entry) 160 { 161 return (entry->wired_count - vm_map_entry_user_wired_count(entry)); 162 } 163 #endif /* _KERNEL */ 164 165 /* 166 * A map is a set of map entries. These map entries are 167 * organized both as a binary search tree and as a doubly-linked 168 * list. Both structures are ordered based upon the start and 169 * end addresses contained within each map entry. Sleator and 170 * Tarjan's top-down splay algorithm is employed to control 171 * height imbalance in the binary search tree. 172 * 173 * List of locks 174 * (c) const until freed 175 */ 176 struct vm_map { 177 struct vm_map_entry header; /* List of entries */ 178 struct sx lock; /* Lock for map data */ 179 struct mtx system_mtx; 180 int nentries; /* Number of entries */ 181 vm_size_t size; /* virtual size */ 182 u_int timestamp; /* Version number */ 183 u_char needs_wakeup; 184 u_char system_map; /* (c) Am I a system map? */ 185 vm_flags_t flags; /* flags for this vm_map */ 186 vm_map_entry_t root; /* Root of a binary search tree */ 187 pmap_t pmap; /* (c) Physical map */ 188 #define min_offset header.start /* (c) */ 189 #define max_offset header.end /* (c) */ 190 }; 191 192 /* 193 * vm_flags_t values 194 */ 195 #define MAP_WIREFUTURE 0x01 /* wire all future pages */ 196 197 #ifdef _KERNEL 198 static __inline vm_offset_t 199 vm_map_max(vm_map_t map) 200 { 201 return (map->max_offset); 202 } 203 204 static __inline vm_offset_t 205 vm_map_min(vm_map_t map) 206 { 207 return (map->min_offset); 208 } 209 210 static __inline pmap_t 211 vm_map_pmap(vm_map_t map) 212 { 213 return (map->pmap); 214 } 215 216 static __inline void 217 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 218 { 219 map->flags = (map->flags | set) & ~clear; 220 } 221 #endif /* _KERNEL */ 222 223 /* 224 * Shareable process virtual address space. 225 * 226 * List of locks 227 * (c) const until freed 228 */ 229 struct vmspace { 230 struct vm_map vm_map; /* VM address map */ 231 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 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 volatile int vm_refcnt; /* number of references */ 240 /* 241 * Keep the PMAP last, so that CPU-specific variations of that 242 * structure on a single architecture don't result in offset 243 * variations of the machine-independent fields in the vmspace. 244 */ 245 struct pmap vm_pmap; /* private physical map */ 246 }; 247 248 #ifdef _KERNEL 249 static __inline pmap_t 250 vmspace_pmap(struct vmspace *vmspace) 251 { 252 return &vmspace->vm_pmap; 253 } 254 #endif /* _KERNEL */ 255 256 #ifdef _KERNEL 257 /* 258 * Macros: vm_map_lock, etc. 259 * Function: 260 * Perform locking on the data portion of a map. Note that 261 * these macros mimic procedure calls returning void. The 262 * semicolon is supplied by the user of these macros, not 263 * by the macros themselves. The macros can safely be used 264 * as unbraced elements in a higher level statement. 265 */ 266 267 void _vm_map_lock(vm_map_t map, const char *file, int line); 268 void _vm_map_unlock(vm_map_t map, const char *file, int line); 269 int _vm_map_unlock_and_wait(vm_map_t map, int timo, 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_locked(vm_map_t map); 277 void vm_map_wakeup(vm_map_t map); 278 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_unlock_and_wait(map, timo) \ 282 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE) 283 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 284 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 285 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 286 #define vm_map_trylock_read(map) \ 287 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 288 #define vm_map_lock_upgrade(map) \ 289 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 290 #define vm_map_lock_downgrade(map) \ 291 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 292 293 long vmspace_resident_count(struct vmspace *vmspace); 294 long vmspace_wired_count(struct vmspace *vmspace); 295 #endif /* _KERNEL */ 296 297 298 /* XXX: number of kernel maps and entries to statically allocate */ 299 #define MAX_KMAP 10 300 #define MAX_KMAPENT 128 301 302 /* 303 * Copy-on-write flags for vm_map operations 304 */ 305 #define MAP_UNUSED_01 0x0001 306 #define MAP_COPY_ON_WRITE 0x0002 307 #define MAP_NOFAULT 0x0004 308 #define MAP_PREFAULT 0x0008 309 #define MAP_PREFAULT_PARTIAL 0x0010 310 #define MAP_DISABLE_SYNCER 0x0020 311 #define MAP_DISABLE_COREDUMP 0x0100 312 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 313 #define MAP_STACK_GROWS_DOWN 0x1000 314 #define MAP_STACK_GROWS_UP 0x2000 315 #define MAP_ACC_CHARGED 0x4000 316 #define MAP_ACC_NO_CHARGE 0x8000 317 318 /* 319 * vm_fault option flags 320 */ 321 #define VM_FAULT_NORMAL 0 /* Nothing special */ 322 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 323 324 /* 325 * The following "find_space" options are supported by vm_map_find() 326 */ 327 #define VMFS_NO_SPACE 0 /* don't find; use the given range */ 328 #define VMFS_ANY_SPACE 1 /* find a range with any alignment */ 329 #define VMFS_ALIGNED_SPACE 2 /* find a superpage-aligned range */ 330 #if defined(__mips__) 331 #define VMFS_TLB_ALIGNED_SPACE 3 /* find a TLB entry aligned range */ 332 #endif 333 334 /* 335 * vm_map_wire and vm_map_unwire option flags 336 */ 337 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 338 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 339 340 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 341 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 342 343 #ifdef _KERNEL 344 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 345 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 346 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t); 347 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, 348 int, vm_prot_t, vm_prot_t, int); 349 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t, 350 vm_prot_t, vm_prot_t, int); 351 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 352 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 353 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t); 354 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); 355 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 356 vm_pindex_t *, vm_prot_t *, boolean_t *); 357 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 358 vm_pindex_t *, vm_prot_t *, boolean_t *); 359 void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 360 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 361 void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot, 362 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags); 363 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 364 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 365 void vm_map_startup (void); 366 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 367 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 368 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 369 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 370 void vm_init2 (void); 371 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 372 int vm_map_growstack (struct proc *p, vm_offset_t addr); 373 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 374 int flags); 375 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, 376 int flags); 377 int vmspace_swap_count (struct vmspace *vmspace); 378 #endif /* _KERNEL */ 379 #endif /* _VM_MAP_ */ 380