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 71 #ifndef _VM_MAP_ 72 #define _VM_MAP_ 73 74 /* 75 * Types defined: 76 * 77 * vm_map_t the high-level address map data structure. 78 * vm_map_entry_t an entry in an address map. 79 */ 80 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 89 union vm_map_object { 90 struct vm_object *vm_object; /* object object */ 91 struct vm_map *sub_map; /* belongs to another map */ 92 }; 93 94 /* 95 * Address map entries consist of start and end addresses, 96 * a VM object (or sharing map) and offset into that object, 97 * and user-exported inheritance and protection information. 98 * Also included is control information for virtual copy operations. 99 */ 100 struct vm_map_entry { 101 struct vm_map_entry *prev; /* previous entry */ 102 struct vm_map_entry *next; /* next entry */ 103 vm_offset_t start; /* start address */ 104 vm_offset_t end; /* end address */ 105 vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 106 union vm_map_object object; /* object I point to */ 107 vm_ooffset_t offset; /* offset into object */ 108 vm_eflags_t eflags; /* map entry flags */ 109 /* Only in task maps: */ 110 vm_prot_t protection; /* protection code */ 111 vm_prot_t max_protection; /* maximum protection */ 112 vm_inherit_t inheritance; /* inheritance */ 113 int wired_count; /* can be paged if = 0 */ 114 vm_pindex_t lastr; /* last read */ 115 }; 116 117 #define MAP_ENTRY_NOSYNC 0x0001 118 #define MAP_ENTRY_IS_SUB_MAP 0x0002 119 #define MAP_ENTRY_COW 0x0004 120 #define MAP_ENTRY_NEEDS_COPY 0x0008 121 #define MAP_ENTRY_NOFAULT 0x0010 122 #define MAP_ENTRY_USER_WIRED 0x0020 123 124 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 125 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 126 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 127 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 128 129 #define MAP_ENTRY_BEHAV_MASK 0x00C0 130 131 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 132 133 static __inline u_char 134 vm_map_entry_behavior(struct vm_map_entry *entry) 135 { 136 return entry->eflags & MAP_ENTRY_BEHAV_MASK; 137 } 138 139 static __inline void 140 vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior) 141 { 142 entry->eflags = (entry->eflags & ~MAP_ENTRY_BEHAV_MASK) | 143 (behavior & MAP_ENTRY_BEHAV_MASK); 144 } 145 146 /* 147 * Maps are doubly-linked lists of map entries, kept sorted 148 * by address. A single hint is provided to start 149 * searches again from the last successful search, 150 * insertion, or removal. 151 * 152 * Note: the lock structure cannot be the first element of vm_map 153 * because this can result in a running lockup between two or more 154 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait() 155 * and free tsleep/waking up 'map' and the underlying lockmgr also 156 * sleeping and waking up on 'map'. The lockup occurs when the map fills 157 * up. The 'exec' map, for example. 158 */ 159 struct vm_map { 160 struct vm_map_entry header; /* List of entries */ 161 struct lock lock; /* Lock for map data */ 162 int nentries; /* Number of entries */ 163 vm_size_t size; /* virtual size */ 164 u_char system_map; /* Am I a system map? */ 165 vm_map_entry_t hint; /* hint for quick lookups */ 166 unsigned int timestamp; /* Version number */ 167 vm_map_entry_t first_free; /* First free space hint */ 168 struct pmap *pmap; /* Physical map */ 169 #define min_offset header.start 170 #define max_offset header.end 171 }; 172 173 /* 174 * Shareable process virtual address space. 175 * May eventually be merged with vm_map. 176 * Several fields are temporary (text, data stuff). 177 */ 178 struct vmspace { 179 struct vm_map vm_map; /* VM address map */ 180 struct pmap vm_pmap; /* private physical map */ 181 int vm_refcnt; /* number of references */ 182 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 183 /* we copy from vm_startcopy to the end of the structure on fork */ 184 #define vm_startcopy vm_rssize 185 segsz_t vm_rssize; /* current resident set size in pages */ 186 segsz_t vm_swrss; /* resident set size before last swap */ 187 segsz_t vm_tsize; /* text size (pages) XXX */ 188 segsz_t vm_dsize; /* data size (pages) XXX */ 189 segsz_t vm_ssize; /* stack size (pages) */ 190 caddr_t vm_taddr; /* user virtual address of text XXX */ 191 caddr_t vm_daddr; /* user virtual address of data XXX */ 192 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 193 caddr_t vm_minsaddr; /* user VA at max stack growth */ 194 }; 195 196 /* 197 * Macros: vm_map_lock, etc. 198 * Function: 199 * Perform locking on the data portion of a map. Note that 200 * these macros mimic procedure calls returning void. The 201 * semicolon is supplied by the user of these macros, not 202 * by the macros themselves. The macros can safely be used 203 * as unbraced elements in a higher level statement. 204 */ 205 206 /* XXX This macro is not called anywhere, and (map)->ref_lock doesn't exist. */ 207 #define vm_map_lock_drain_interlock(map) \ 208 do { \ 209 lockmgr(&(map)->lock, LK_DRAIN|LK_INTERLOCK, \ 210 &(map)->ref_lock, curproc); \ 211 (map)->timestamp++; \ 212 } while(0) 213 214 #ifdef DIAGNOSTIC 215 /* #define MAP_LOCK_DIAGNOSTIC 1 */ 216 #ifdef MAP_LOCK_DIAGNOSTIC 217 #define vm_map_lock(map) \ 218 do { \ 219 printf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \ 220 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \ 221 panic("vm_map_lock: failed to get lock"); \ 222 } \ 223 (map)->timestamp++; \ 224 } while(0) 225 #else 226 #define vm_map_lock(map) \ 227 do { \ 228 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \ 229 panic("vm_map_lock: failed to get lock"); \ 230 } \ 231 (map)->timestamp++; \ 232 } while(0) 233 #endif 234 #else 235 #define vm_map_lock(map) \ 236 do { \ 237 lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc); \ 238 (map)->timestamp++; \ 239 } while(0) 240 #endif /* DIAGNOSTIC */ 241 242 #if defined(MAP_LOCK_DIAGNOSTIC) 243 #define vm_map_unlock(map) \ 244 do { \ 245 printf ("locking map LK_RELEASE: 0x%x\n", map); \ 246 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \ 247 } while (0) 248 #define vm_map_lock_read(map) \ 249 do { \ 250 printf ("locking map LK_SHARED: 0x%x\n", map); \ 251 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc); \ 252 } while (0) 253 #define vm_map_unlock_read(map) \ 254 do { \ 255 printf ("locking map LK_RELEASE: 0x%x\n", map); \ 256 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \ 257 } while (0) 258 #else 259 #define vm_map_unlock(map) \ 260 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc) 261 #define vm_map_lock_read(map) \ 262 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc) 263 #define vm_map_unlock_read(map) \ 264 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc) 265 #endif 266 267 static __inline__ int 268 _vm_map_lock_upgrade(vm_map_t map, struct proc *p) { 269 int error; 270 #if defined(MAP_LOCK_DIAGNOSTIC) 271 printf("locking map LK_EXCLUPGRADE: 0x%x\n", map); 272 #endif 273 error = lockmgr(&map->lock, LK_EXCLUPGRADE, (void *)0, p); 274 if (error == 0) 275 map->timestamp++; 276 return error; 277 } 278 279 #define vm_map_lock_upgrade(map) _vm_map_lock_upgrade(map, curproc) 280 281 #if defined(MAP_LOCK_DIAGNOSTIC) 282 #define vm_map_lock_downgrade(map) \ 283 do { \ 284 printf ("locking map LK_DOWNGRADE: 0x%x\n", map); \ 285 lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc); \ 286 } while (0) 287 #else 288 #define vm_map_lock_downgrade(map) \ 289 lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc) 290 #endif 291 292 #define vm_map_set_recursive(map) \ 293 do { \ 294 mtx_enter((map)->lock.lk_interlock, MTX_DEF); \ 295 (map)->lock.lk_flags |= LK_CANRECURSE; \ 296 mtx_exit((map)->lock.lk_interlock, MTX_DEF); \ 297 } while(0) 298 #define vm_map_clear_recursive(map) \ 299 do { \ 300 mtx_enter((map)->lock.lk_interlock, MTX_DEF); \ 301 (map)->lock.lk_flags &= ~LK_CANRECURSE; \ 302 mtx_exit((map)->lock.lk_interlock, MTX_DEF); \ 303 } while(0) 304 305 /* 306 * Functions implemented as macros 307 */ 308 #define vm_map_min(map) ((map)->min_offset) 309 #define vm_map_max(map) ((map)->max_offset) 310 #define vm_map_pmap(map) ((map)->pmap) 311 312 static __inline struct pmap * 313 vmspace_pmap(struct vmspace *vmspace) 314 { 315 return &vmspace->vm_pmap; 316 } 317 318 static __inline long 319 vmspace_resident_count(struct vmspace *vmspace) 320 { 321 return pmap_resident_count(vmspace_pmap(vmspace)); 322 } 323 324 /* XXX: number of kernel maps and entries to statically allocate */ 325 #define MAX_KMAP 10 326 #define MAX_KMAPENT 128 327 #define MAX_MAPENT 128 328 329 /* 330 * Copy-on-write flags for vm_map operations 331 */ 332 #define MAP_UNUSED_01 0x0001 333 #define MAP_COPY_ON_WRITE 0x0002 334 #define MAP_NOFAULT 0x0004 335 #define MAP_PREFAULT 0x0008 336 #define MAP_PREFAULT_PARTIAL 0x0010 337 #define MAP_DISABLE_SYNCER 0x0020 338 #define MAP_DISABLE_COREDUMP 0x0100 339 340 /* 341 * vm_fault option flags 342 */ 343 #define VM_FAULT_NORMAL 0 /* Nothing special */ 344 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 345 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */ 346 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 347 #define VM_FAULT_HOLD 4 /* Hold the page */ 348 #define VM_FAULT_DIRTY 8 /* Dirty the page */ 349 350 #ifdef _KERNEL 351 boolean_t vm_map_check_protection __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t)); 352 struct pmap; 353 vm_map_t vm_map_create __P((struct pmap *, vm_offset_t, vm_offset_t)); 354 int vm_map_delete __P((vm_map_t, vm_offset_t, vm_offset_t)); 355 int vm_map_find __P((vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int)); 356 int vm_map_findspace __P((vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *)); 357 int vm_map_inherit __P((vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t)); 358 void vm_map_init __P((struct vm_map *, vm_offset_t, vm_offset_t)); 359 void vm_map_destroy __P((struct vm_map *)); 360 int vm_map_insert __P((vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int)); 361 int vm_map_lookup __P((vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 362 vm_pindex_t *, vm_prot_t *, boolean_t *)); 363 void vm_map_lookup_done __P((vm_map_t, vm_map_entry_t)); 364 boolean_t vm_map_lookup_entry __P((vm_map_t, vm_offset_t, vm_map_entry_t *)); 365 int vm_map_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 366 int vm_map_user_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 367 int vm_map_clean __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t)); 368 int vm_map_protect __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t)); 369 int vm_map_remove __P((vm_map_t, vm_offset_t, vm_offset_t)); 370 void vm_map_startup __P((void)); 371 int vm_map_submap __P((vm_map_t, vm_offset_t, vm_offset_t, vm_map_t)); 372 int vm_map_madvise __P((vm_map_t, vm_offset_t, vm_offset_t, int)); 373 void vm_map_simplify_entry __P((vm_map_t, vm_map_entry_t)); 374 void vm_init2 __P((void)); 375 int vm_uiomove __P((vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *)); 376 void vm_freeze_copyopts __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 377 int vm_map_stack __P((vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int)); 378 int vm_map_growstack __P((struct proc *p, vm_offset_t addr)); 379 380 #endif 381 #endif /* _VM_MAP_ */ 382