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 * $Id: vm_map.h,v 1.33 1999/01/06 23:05:42 julian Exp $ 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 * vm_map_version_t a timestamp of a map, for use with vm_map_lookup 80 */ 81 82 /* 83 * Objects which live in maps may be either VM objects, or 84 * another map (called a "sharing map") which denotes read-write 85 * sharing with other maps. 86 */ 87 88 union vm_map_object { 89 struct vm_object *vm_object; /* object object */ 90 struct vm_map *share_map; /* share map */ 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 u_char 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 }; 115 116 #define MAP_ENTRY_IS_A_MAP 0x1 117 #define MAP_ENTRY_IS_SUB_MAP 0x2 118 #define MAP_ENTRY_COW 0x4 119 #define MAP_ENTRY_NEEDS_COPY 0x8 120 #define MAP_ENTRY_NOFAULT 0x10 121 #define MAP_ENTRY_USER_WIRED 0x20 122 123 /* 124 * Maps are doubly-linked lists of map entries, kept sorted 125 * by address. A single hint is provided to start 126 * searches again from the last successful search, 127 * insertion, or removal. 128 */ 129 struct vm_map { 130 struct lock lock; /* Lock for map data */ 131 struct vm_map_entry header; /* List of entries */ 132 int nentries; /* Number of entries */ 133 vm_size_t size; /* virtual size */ 134 unsigned char is_main_map; /* Am I a main map? */ 135 unsigned char system_map; /* Am I a system map? */ 136 vm_map_entry_t hint; /* hint for quick lookups */ 137 unsigned int timestamp; /* Version number */ 138 vm_map_entry_t first_free; /* First free space hint */ 139 struct pmap *pmap; /* Physical map */ 140 #define min_offset header.start 141 #define max_offset header.end 142 }; 143 144 /* 145 * Shareable process virtual address space. 146 * May eventually be merged with vm_map. 147 * Several fields are temporary (text, data stuff). 148 */ 149 struct vmspace { 150 struct vm_map vm_map; /* VM address map */ 151 struct pmap vm_pmap; /* private physical map */ 152 int vm_refcnt; /* number of references */ 153 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 154 /* we copy from vm_startcopy to the end of the structure on fork */ 155 #define vm_startcopy vm_rssize 156 segsz_t vm_rssize; /* current resident set size in pages */ 157 segsz_t vm_swrss; /* resident set size before last swap */ 158 segsz_t vm_tsize; /* text size (pages) XXX */ 159 segsz_t vm_dsize; /* data size (pages) XXX */ 160 segsz_t vm_ssize; /* stack size (pages) */ 161 caddr_t vm_taddr; /* user virtual address of text XXX */ 162 caddr_t vm_daddr; /* user virtual address of data XXX */ 163 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 164 caddr_t vm_minsaddr; /* user VA at max stack growth */ 165 }; 166 167 168 /* 169 * Map versions are used to validate a previous lookup attempt. 170 * 171 * Since lookup operations may involve both a main map and 172 * a sharing map, it is necessary to have a timestamp from each. 173 * [If the main map timestamp has changed, the share_map and 174 * associated timestamp are no longer valid; the map version 175 * does not include a reference for the embedded share_map.] 176 */ 177 typedef struct { 178 int main_timestamp; 179 vm_map_t share_map; 180 int share_timestamp; 181 } vm_map_version_t; 182 183 /* 184 * Macros: vm_map_lock, etc. 185 * Function: 186 * Perform locking on the data portion of a map. 187 */ 188 189 #define vm_map_lock_drain_interlock(map) { \ 190 lockmgr(&(map)->lock, LK_DRAIN|LK_INTERLOCK, \ 191 &(map)->ref_lock, curproc); \ 192 (map)->timestamp++; \ 193 } 194 195 #ifdef DIAGNOSTIC 196 /* #define MAP_LOCK_DIAGNOSTIC 1 */ 197 #ifdef MAP_LOCK_DIAGNOSTIC 198 #define vm_map_lock(map) { \ 199 printf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \ 200 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \ 201 panic("vm_map_lock: failed to get lock"); \ 202 } \ 203 (map)->timestamp++; \ 204 } 205 #else 206 #define vm_map_lock(map) { \ 207 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \ 208 panic("vm_map_lock: failed to get lock"); \ 209 } \ 210 (map)->timestamp++; \ 211 } 212 #endif 213 #else 214 #define vm_map_lock(map) { \ 215 lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc); \ 216 (map)->timestamp++; \ 217 } 218 #endif /* DIAGNOSTIC */ 219 220 #if defined(MAP_LOCK_DIAGNOSTIC) 221 #define vm_map_unlock(map) \ 222 do { \ 223 printf ("locking map LK_RELEASE: 0x%x\n", map); \ 224 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \ 225 } while (0); 226 #define vm_map_lock_read(map) \ 227 do { \ 228 printf ("locking map LK_SHARED: 0x%x\n", map); \ 229 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc); \ 230 } while (0); 231 #define vm_map_unlock_read(map) \ 232 do { \ 233 printf ("locking map LK_RELEASE: 0x%x\n", map); \ 234 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \ 235 } while (0); 236 #else 237 #define vm_map_unlock(map) \ 238 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); 239 #define vm_map_lock_read(map) \ 240 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc); 241 #define vm_map_unlock_read(map) \ 242 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); 243 #endif 244 245 static __inline__ int 246 _vm_map_lock_upgrade(vm_map_t map, struct proc *p) { 247 #if defined(MAP_LOCK_DIAGNOSTIC) 248 printf("locking map LK_EXCLUPGRADE: 0x%x\n", map); 249 #endif 250 return lockmgr(&(map)->lock, LK_EXCLUPGRADE, (void *)0, p); 251 } 252 253 #define vm_map_lock_upgrade(map) _vm_map_lock_upgrade(map, curproc) 254 255 #if defined(MAP_LOCK_DIAGNOSTIC) 256 #define vm_map_lock_downgrade(map) \ 257 do { \ 258 printf ("locking map LK_DOWNGRADE: 0x%x\n", map); \ 259 lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc); \ 260 } while (0); 261 #else 262 #define vm_map_lock_downgrade(map) \ 263 lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc); 264 #endif 265 266 #define vm_map_set_recursive(map) { \ 267 simple_lock(&(map)->lock.lk_interlock); \ 268 (map)->lock.lk_flags |= LK_CANRECURSE; \ 269 simple_unlock(&(map)->lock.lk_interlock); \ 270 } 271 #define vm_map_clear_recursive(map) { \ 272 simple_lock(&(map)->lock.lk_interlock); \ 273 (map)->lock.lk_flags &= ~LK_CANRECURSE; \ 274 simple_unlock(&(map)->lock.lk_interlock); \ 275 } 276 277 /* 278 * Functions implemented as macros 279 */ 280 #define vm_map_min(map) ((map)->min_offset) 281 #define vm_map_max(map) ((map)->max_offset) 282 #define vm_map_pmap(map) ((map)->pmap) 283 284 /* XXX: number of kernel maps and entries to statically allocate */ 285 #define MAX_KMAP 10 286 #define MAX_KMAPENT 128 287 #define MAX_MAPENT 128 288 289 /* 290 * Copy-on-write flags for vm_map operations 291 */ 292 #define MAP_COPY_NEEDED 0x1 293 #define MAP_COPY_ON_WRITE 0x2 294 #define MAP_NOFAULT 0x4 295 296 /* 297 * vm_fault option flags 298 */ 299 #define VM_FAULT_NORMAL 0 /* Nothing special */ 300 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 301 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */ 302 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 303 #define VM_FAULT_HOLD 4 /* Hold the page */ 304 #define VM_FAULT_DIRTY 8 /* Dirty the page */ 305 306 #ifdef KERNEL 307 extern vm_offset_t kentry_data; 308 extern vm_size_t kentry_data_size; 309 310 boolean_t vm_map_check_protection __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t)); 311 int vm_map_copy __P((vm_map_t, vm_map_t, vm_offset_t, vm_size_t, vm_offset_t, boolean_t, boolean_t)); 312 struct pmap; 313 vm_map_t vm_map_create __P((struct pmap *, vm_offset_t, vm_offset_t)); 314 void vm_map_deallocate __P((vm_map_t)); 315 int vm_map_delete __P((vm_map_t, vm_offset_t, vm_offset_t)); 316 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)); 317 int vm_map_findspace __P((vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *)); 318 int vm_map_inherit __P((vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t)); 319 void vm_map_init __P((struct vm_map *, vm_offset_t, vm_offset_t)); 320 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)); 321 int vm_map_lookup __P((vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 322 vm_pindex_t *, vm_prot_t *, boolean_t *)); 323 void vm_map_lookup_done __P((vm_map_t, vm_map_entry_t)); 324 boolean_t vm_map_lookup_entry __P((vm_map_t, vm_offset_t, vm_map_entry_t *)); 325 int vm_map_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 326 int vm_map_user_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 327 int vm_map_clean __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t)); 328 int vm_map_protect __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t)); 329 void vm_map_reference __P((vm_map_t)); 330 int vm_map_remove __P((vm_map_t, vm_offset_t, vm_offset_t)); 331 void vm_map_simplify __P((vm_map_t, vm_offset_t)); 332 void vm_map_startup __P((void)); 333 int vm_map_submap __P((vm_map_t, vm_offset_t, vm_offset_t, vm_map_t)); 334 void vm_map_madvise __P((vm_map_t, pmap_t, vm_offset_t, vm_offset_t, int)); 335 void vm_map_simplify_entry __P((vm_map_t, vm_map_entry_t)); 336 void vm_init2 __P((void)); 337 int vm_uiomove __P((vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *)); 338 void vm_freeze_copyopts __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 339 int vm_map_stack __P((vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int)); 340 int vm_map_growstack __P((struct proc *p, vm_offset_t addr)); 341 342 #endif 343 #endif /* _VM_MAP_ */ 344