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