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