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 ucred *cred; /* 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 int busy; 191 }; 192 193 /* 194 * vm_flags_t values 195 */ 196 #define MAP_WIREFUTURE 0x01 /* wire all future pages */ 197 #define MAP_BUSY_WAKEUP 0x02 198 199 #ifdef _KERNEL 200 static __inline vm_offset_t 201 vm_map_max(vm_map_t map) 202 { 203 return (map->max_offset); 204 } 205 206 static __inline vm_offset_t 207 vm_map_min(vm_map_t map) 208 { 209 return (map->min_offset); 210 } 211 212 static __inline pmap_t 213 vm_map_pmap(vm_map_t map) 214 { 215 return (map->pmap); 216 } 217 218 static __inline void 219 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 220 { 221 map->flags = (map->flags | set) & ~clear; 222 } 223 #endif /* _KERNEL */ 224 225 /* 226 * Shareable process virtual address space. 227 * 228 * List of locks 229 * (c) const until freed 230 */ 231 struct vmspace { 232 struct vm_map vm_map; /* VM address map */ 233 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 234 segsz_t vm_swrss; /* resident set size before last swap */ 235 segsz_t vm_tsize; /* text size (pages) XXX */ 236 segsz_t vm_dsize; /* data size (pages) XXX */ 237 segsz_t vm_ssize; /* stack size (pages) */ 238 caddr_t vm_taddr; /* (c) user virtual address of text */ 239 caddr_t vm_daddr; /* (c) user virtual address of data */ 240 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 241 volatile int vm_refcnt; /* number of references */ 242 /* 243 * Keep the PMAP last, so that CPU-specific variations of that 244 * structure on a single architecture don't result in offset 245 * variations of the machine-independent fields in the vmspace. 246 */ 247 struct pmap vm_pmap; /* private physical map */ 248 }; 249 250 #ifdef _KERNEL 251 static __inline pmap_t 252 vmspace_pmap(struct vmspace *vmspace) 253 { 254 return &vmspace->vm_pmap; 255 } 256 #endif /* _KERNEL */ 257 258 #ifdef _KERNEL 259 /* 260 * Macros: vm_map_lock, etc. 261 * Function: 262 * Perform locking on the data portion of a map. Note that 263 * these macros mimic procedure calls returning void. The 264 * semicolon is supplied by the user of these macros, not 265 * by the macros themselves. The macros can safely be used 266 * as unbraced elements in a higher level statement. 267 */ 268 269 void _vm_map_lock(vm_map_t map, const char *file, int line); 270 void _vm_map_unlock(vm_map_t map, const char *file, int line); 271 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line); 272 void _vm_map_lock_read(vm_map_t map, const char *file, int line); 273 void _vm_map_unlock_read(vm_map_t map, const char *file, int line); 274 int _vm_map_trylock(vm_map_t map, const char *file, int line); 275 int _vm_map_trylock_read(vm_map_t map, const char *file, int line); 276 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 277 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 278 int vm_map_locked(vm_map_t map); 279 void vm_map_wakeup(vm_map_t map); 280 void vm_map_busy(vm_map_t map); 281 void vm_map_unbusy(vm_map_t map); 282 void vm_map_wait_busy(vm_map_t map); 283 284 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 285 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 286 #define vm_map_unlock_and_wait(map, timo) \ 287 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE) 288 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 289 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 290 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 291 #define vm_map_trylock_read(map) \ 292 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 293 #define vm_map_lock_upgrade(map) \ 294 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 295 #define vm_map_lock_downgrade(map) \ 296 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 297 298 long vmspace_resident_count(struct vmspace *vmspace); 299 long vmspace_wired_count(struct vmspace *vmspace); 300 #endif /* _KERNEL */ 301 302 303 /* XXX: number of kernel maps and entries to statically allocate */ 304 #define MAX_KMAP 10 305 #define MAX_KMAPENT 128 306 307 /* 308 * Copy-on-write flags for vm_map operations 309 */ 310 #define MAP_UNUSED_01 0x0001 311 #define MAP_COPY_ON_WRITE 0x0002 312 #define MAP_NOFAULT 0x0004 313 #define MAP_PREFAULT 0x0008 314 #define MAP_PREFAULT_PARTIAL 0x0010 315 #define MAP_DISABLE_SYNCER 0x0020 316 #define MAP_DISABLE_COREDUMP 0x0100 317 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 318 #define MAP_STACK_GROWS_DOWN 0x1000 319 #define MAP_STACK_GROWS_UP 0x2000 320 #define MAP_ACC_CHARGED 0x4000 321 #define MAP_ACC_NO_CHARGE 0x8000 322 323 /* 324 * vm_fault option flags 325 */ 326 #define VM_FAULT_NORMAL 0 /* Nothing special */ 327 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 328 #define VM_FAULT_DIRTY 2 /* Dirty the page; use w/VM_PROT_COPY */ 329 330 /* 331 * The following "find_space" options are supported by vm_map_find() 332 */ 333 #define VMFS_NO_SPACE 0 /* don't find; use the given range */ 334 #define VMFS_ANY_SPACE 1 /* find a range with any alignment */ 335 #define VMFS_ALIGNED_SPACE 2 /* find a superpage-aligned range */ 336 #if defined(__mips__) 337 #define VMFS_TLB_ALIGNED_SPACE 3 /* find a TLB entry aligned range */ 338 #endif 339 340 /* 341 * vm_map_wire and vm_map_unwire option flags 342 */ 343 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 344 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 345 346 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 347 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 348 349 #define VM_MAP_WIRE_WRITE 4 /* Validate writable. */ 350 351 #ifdef _KERNEL 352 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 353 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 354 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t); 355 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, 356 int, vm_prot_t, vm_prot_t, int); 357 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t, 358 vm_prot_t, vm_prot_t, int); 359 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 360 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 361 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t); 362 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); 363 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 364 vm_pindex_t *, vm_prot_t *, boolean_t *); 365 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 366 vm_pindex_t *, vm_prot_t *, boolean_t *); 367 void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 368 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 369 void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot, 370 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags); 371 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 372 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 373 void vm_map_startup (void); 374 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 375 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 376 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 377 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 378 void vm_init2 (void); 379 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 380 int vm_map_growstack (struct proc *p, vm_offset_t addr); 381 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 382 int flags); 383 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, 384 int flags); 385 long vmspace_swap_count(struct vmspace *vmspace); 386 #endif /* _KERNEL */ 387 #endif /* _VM_MAP_ */ 388