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: src/sys/vm/vm_map.h,v 1.54.2.5 2003/01/13 22:51:17 dillon Exp $ 65 * $DragonFly: src/sys/vm/vm_map.h,v 1.30 2007/04/29 18:25:41 dillon Exp $ 66 */ 67 68 /* 69 * Virtual memory map module definitions. 70 */ 71 72 #ifndef _VM_VM_MAP_H_ 73 #define _VM_VM_MAP_H_ 74 75 #ifndef _SYS_TYPES_H_ 76 #include <sys/types.h> 77 #endif 78 #ifndef _SYS_TREE_H_ 79 #include <sys/tree.h> 80 #endif 81 #ifndef _SYS_SYSREF_H_ 82 #include <sys/sysref.h> 83 #endif 84 #ifndef _SYS_LOCK_H_ 85 #include <sys/lock.h> 86 #endif 87 #ifndef _SYS_VKERNEL_H_ 88 #include <sys/vkernel.h> 89 #endif 90 #ifndef _VM_VM_H_ 91 #include <vm/vm.h> 92 #endif 93 #ifndef _MACHINE_PMAP_H_ 94 #include <machine/pmap.h> 95 #endif 96 97 struct vm_map_rb_tree; 98 RB_PROTOTYPE(vm_map_rb_tree, vm_map_entry, rb_entry, rb_vm_map_compare); 99 100 /* 101 * Types defined: 102 * 103 * vm_map_t the high-level address map data structure. 104 * vm_map_entry_t an entry in an address map. 105 */ 106 107 typedef u_int vm_eflags_t; 108 109 /* 110 * Objects which live in maps may be either VM objects, or 111 * another map (called a "sharing map") which denotes read-write 112 * sharing with other maps. 113 */ 114 union vm_map_object { 115 struct vm_object *vm_object; /* object object */ 116 struct vm_map *sub_map; /* belongs to another map */ 117 }; 118 119 union vm_map_aux { 120 vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 121 vpte_t master_pde; /* virtual page table root */ 122 }; 123 124 /* 125 * Address map entries consist of start and end addresses, 126 * a VM object (or sharing map) and offset into that object, 127 * and user-exported inheritance and protection information. 128 * Also included is control information for virtual copy operations. 129 * 130 * When used with MAP_STACK, avail_ssize is used to determine the 131 * limits of stack growth. 132 * 133 * When used with VM_MAPTYPE_VPAGETABLE, avail_ssize stores the 134 * page directory index. 135 */ 136 struct vm_map_entry { 137 struct vm_map_entry *prev; /* previous entry */ 138 struct vm_map_entry *next; /* next entry */ 139 RB_ENTRY(vm_map_entry) rb_entry; 140 vm_offset_t start; /* start address */ 141 vm_offset_t end; /* end address */ 142 union vm_map_aux aux; /* auxillary data */ 143 union vm_map_object object; /* object I point to */ 144 vm_ooffset_t offset; /* offset into object */ 145 vm_eflags_t eflags; /* map entry flags */ 146 vm_maptype_t maptype; /* type of VM mapping */ 147 vm_prot_t protection; /* protection code */ 148 vm_prot_t max_protection; /* maximum protection */ 149 vm_inherit_t inheritance; /* inheritance */ 150 int wired_count; /* can be paged if = 0 */ 151 vm_pindex_t lastr; /* last read */ 152 }; 153 154 #define MAP_ENTRY_NOSYNC 0x0001 155 #define MAP_ENTRY_UNUSED0002 0x0002 156 #define MAP_ENTRY_COW 0x0004 157 #define MAP_ENTRY_NEEDS_COPY 0x0008 158 #define MAP_ENTRY_NOFAULT 0x0010 159 #define MAP_ENTRY_USER_WIRED 0x0020 160 161 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 162 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 163 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 164 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 165 166 #define MAP_ENTRY_BEHAV_MASK 0x00C0 167 168 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */ 169 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiter's in transition */ 170 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 171 172 /* 173 * flags for vm_map_[un]clip_range() 174 */ 175 #define MAP_CLIP_NO_HOLES 0x0001 176 177 /* 178 * This reserve count for vm_map_entry_reserve() should cover all nominal 179 * single-insertion operations, including any necessary clipping. 180 */ 181 #define MAP_RESERVE_COUNT 4 182 #define MAP_RESERVE_SLOP 32 183 184 static __inline u_char 185 vm_map_entry_behavior(struct vm_map_entry *entry) 186 { 187 return entry->eflags & MAP_ENTRY_BEHAV_MASK; 188 } 189 190 static __inline void 191 vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior) 192 { 193 entry->eflags = (entry->eflags & ~MAP_ENTRY_BEHAV_MASK) | 194 (behavior & MAP_ENTRY_BEHAV_MASK); 195 } 196 197 /* 198 * Maps are doubly-linked lists of map entries, kept sorted 199 * by address. A single hint is provided to start 200 * searches again from the last successful search, 201 * insertion, or removal. 202 * 203 * Note: the lock structure cannot be the first element of vm_map 204 * because this can result in a running lockup between two or more 205 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait() 206 * and free tsleep/waking up 'map' and the underlying lockmgr also 207 * sleeping and waking up on 'map'. The lockup occurs when the map fills 208 * up. The 'exec' map, for example. 209 */ 210 struct vm_map { 211 struct vm_map_entry header; /* List of entries */ 212 RB_HEAD(vm_map_rb_tree, vm_map_entry) rb_root; 213 struct lock lock; /* Lock for map data */ 214 int nentries; /* Number of entries */ 215 vm_size_t size; /* virtual size */ 216 u_char system_map; /* Am I a system map? */ 217 u_char infork; /* Am I in fork processing? */ 218 vm_map_entry_t hint; /* hint for quick lookups */ 219 unsigned int timestamp; /* Version number */ 220 vm_map_entry_t first_free; /* First free space hint */ 221 struct pmap *pmap; /* Physical map */ 222 #define min_offset header.start 223 #define max_offset header.end 224 }; 225 226 /* 227 * Registered upcall 228 */ 229 struct upcall; 230 231 struct vmupcall { 232 struct vmupcall *vu_next; 233 void *vu_func; /* user upcall function */ 234 void *vu_data; /* user data */ 235 void *vu_ctx; /* user context function */ 236 struct lwp *vu_lwp; /* process that registered upcall */ 237 int vu_id; /* upcall identifier */ 238 int vu_pending; /* upcall request pending */ 239 }; 240 241 /* 242 * Shareable process virtual address space. 243 * 244 * Refd pointers from vmresident, proc 245 */ 246 struct vmspace { 247 struct vm_map vm_map; /* VM address map */ 248 struct pmap vm_pmap; /* private physical map */ 249 int vm_unused01; 250 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 251 /* we copy from vm_startcopy to the end of the structure on fork */ 252 #define vm_startcopy vm_rssize 253 segsz_t vm_rssize; /* current resident set size in pages */ 254 segsz_t vm_swrss; /* resident set size before last swap */ 255 segsz_t vm_tsize; /* text size (pages) XXX */ 256 segsz_t vm_dsize; /* data size (pages) XXX */ 257 segsz_t vm_ssize; /* stack size (pages) */ 258 caddr_t vm_taddr; /* user virtual address of text XXX */ 259 caddr_t vm_daddr; /* user virtual address of data XXX */ 260 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 261 caddr_t vm_minsaddr; /* user VA at max stack growth */ 262 #define vm_endcopy vm_exitingcnt 263 int vm_exitingcnt; /* several procsses zombied in exit1 */ 264 int vm_upccount; /* number of registered upcalls */ 265 int vm_pagesupply; 266 struct vmupcall *vm_upcalls; /* registered upcalls */ 267 struct sysref vm_sysref; /* sysref, refcnt, etc */ 268 }; 269 270 /* 271 * Resident executable holding structure. A user program can take a snapshot 272 * of just its VM address space (typically done just after dynamic link 273 * libraries have completed loading) and register it as a resident 274 * executable associated with the program binary's vnode, which is also 275 * locked into memory. Future execs of the vnode will start with a copy 276 * of the resident vmspace instead of running the binary from scratch, 277 * avoiding both the kernel ELF loader *AND* all shared library mapping and 278 * relocation code, and will call a different entry point (the stack pointer 279 * is reset to the top of the stack) supplied when the vmspace was registered. 280 */ 281 struct vmresident { 282 struct vnode *vr_vnode; /* associated vnode */ 283 TAILQ_ENTRY(vmresident) vr_link; /* linked list of res sts */ 284 struct vmspace *vr_vmspace; /* vmspace to fork */ 285 intptr_t vr_entry_addr; /* registered entry point */ 286 struct sysentvec *vr_sysent; /* system call vects */ 287 int vr_id; /* registration id */ 288 }; 289 290 #ifdef _KERNEL 291 /* 292 * Macros: vm_map_lock, etc. 293 * Function: 294 * Perform locking on the data portion of a map. Note that 295 * these macros mimic procedure calls returning void. The 296 * semicolon is supplied by the user of these macros, not 297 * by the macros themselves. The macros can safely be used 298 * as unbraced elements in a higher level statement. 299 */ 300 301 #ifdef DIAGNOSTIC 302 /* #define MAP_LOCK_DIAGNOSTIC 1 */ 303 #ifdef MAP_LOCK_DIAGNOSTIC 304 #define vm_map_lock(map) \ 305 do { \ 306 kprintf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \ 307 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \ 308 panic("vm_map_lock: failed to get lock"); \ 309 } \ 310 (map)->timestamp++; \ 311 } while(0) 312 #else 313 #define vm_map_lock(map) \ 314 do { \ 315 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \ 316 panic("vm_map_lock: failed to get lock"); \ 317 } \ 318 (map)->timestamp++; \ 319 } while(0) 320 #endif 321 #else 322 #define vm_map_lock(map) \ 323 do { \ 324 lockmgr(&(map)->lock, LK_EXCLUSIVE); \ 325 (map)->timestamp++; \ 326 } while(0) 327 #endif /* DIAGNOSTIC */ 328 329 #if defined(MAP_LOCK_DIAGNOSTIC) 330 #define vm_map_unlock(map) \ 331 do { \ 332 kprintf ("locking map LK_RELEASE: 0x%x\n", map); \ 333 lockmgr(&(map)->lock, LK_RELEASE); \ 334 } while (0) 335 #define vm_map_lock_read(map) \ 336 do { \ 337 kprintf ("locking map LK_SHARED: 0x%x\n", map); \ 338 lockmgr(&(map)->lock, LK_SHARED); \ 339 } while (0) 340 #define vm_map_unlock_read(map) \ 341 do { \ 342 kprintf ("locking map LK_RELEASE: 0x%x\n", map); \ 343 lockmgr(&(map)->lock, LK_RELEASE); \ 344 } while (0) 345 #else 346 #define vm_map_unlock(map) \ 347 lockmgr(&(map)->lock, LK_RELEASE) 348 #define vm_map_lock_read(map) \ 349 lockmgr(&(map)->lock, LK_SHARED) 350 #define vm_map_unlock_read(map) \ 351 lockmgr(&(map)->lock, LK_RELEASE) 352 #endif 353 354 static __inline__ int 355 vm_map_lock_upgrade(vm_map_t map) { 356 int error; 357 #if defined(MAP_LOCK_DIAGNOSTIC) 358 kprintf("locking map LK_EXCLUPGRADE: 0x%x\n", map); 359 #endif 360 error = lockmgr(&map->lock, LK_EXCLUPGRADE); 361 if (error == 0) 362 map->timestamp++; 363 return error; 364 } 365 366 #if defined(MAP_LOCK_DIAGNOSTIC) 367 #define vm_map_lock_downgrade(map) \ 368 do { \ 369 kprintf ("locking map LK_DOWNGRADE: 0x%x\n", map); \ 370 lockmgr(&(map)->lock, LK_DOWNGRADE); \ 371 } while (0) 372 #else 373 #define vm_map_lock_downgrade(map) \ 374 lockmgr(&(map)->lock, LK_DOWNGRADE) 375 #endif 376 377 #endif /* _KERNEL */ 378 379 /* 380 * Functions implemented as macros 381 */ 382 #define vm_map_min(map) ((map)->min_offset) 383 #define vm_map_max(map) ((map)->max_offset) 384 #define vm_map_pmap(map) ((map)->pmap) 385 386 static __inline struct pmap * 387 vmspace_pmap(struct vmspace *vmspace) 388 { 389 return &vmspace->vm_pmap; 390 } 391 392 static __inline long 393 vmspace_resident_count(struct vmspace *vmspace) 394 { 395 return pmap_resident_count(vmspace_pmap(vmspace)); 396 } 397 398 /* 399 * Number of kernel maps and entries to statically allocate, required 400 * during boot to bootstrap the VM system. 401 */ 402 #define MAX_KMAP 10 403 #define MAX_MAPENT 256 404 405 /* 406 * Copy-on-write flags for vm_map operations 407 */ 408 #define MAP_UNUSED_01 0x0001 409 #define MAP_COPY_ON_WRITE 0x0002 410 #define MAP_NOFAULT 0x0004 411 #define MAP_PREFAULT 0x0008 412 #define MAP_PREFAULT_PARTIAL 0x0010 413 #define MAP_DISABLE_SYNCER 0x0020 414 #define MAP_DISABLE_COREDUMP 0x0100 415 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 416 417 /* 418 * vm_fault option flags 419 */ 420 #define VM_FAULT_NORMAL 0x00 /* Nothing special */ 421 #define VM_FAULT_CHANGE_WIRING 0x01 /* Change the wiring as appropriate */ 422 #define VM_FAULT_USER_WIRE 0x02 /* Likewise, but for user purposes */ 423 #define VM_FAULT_DIRTY 0x08 /* Dirty the page */ 424 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 425 426 #ifdef _KERNEL 427 428 extern struct sysref_class vmspace_sysref_class; 429 430 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 431 struct pmap; 432 struct globaldata; 433 void vm_map_entry_allocate_object(vm_map_entry_t); 434 void vm_map_entry_reserve_cpu_init(struct globaldata *gd); 435 int vm_map_entry_reserve(int); 436 int vm_map_entry_kreserve(int); 437 void vm_map_entry_release(int); 438 void vm_map_entry_krelease(int); 439 vm_map_t vm_map_create (vm_map_t, struct pmap *, vm_offset_t, vm_offset_t); 440 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t, int *); 441 int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t, 442 vm_offset_t *, vm_size_t, 443 boolean_t, 444 vm_maptype_t, 445 vm_prot_t, vm_prot_t, 446 int); 447 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t, vm_offset_t *); 448 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 449 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t, pmap_t); 450 int vm_map_insert (vm_map_t, int *, vm_object_t, vm_ooffset_t, 451 vm_offset_t, vm_offset_t, 452 vm_maptype_t, 453 vm_prot_t, vm_prot_t, 454 int); 455 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 456 vm_pindex_t *, vm_prot_t *, boolean_t *); 457 void vm_map_lookup_done (vm_map_t, vm_map_entry_t, int); 458 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 459 int vm_map_wire (vm_map_t, vm_offset_t, vm_offset_t, int); 460 int vm_map_unwire (vm_map_t, vm_offset_t, vm_offset_t, boolean_t); 461 int vm_map_clean (vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 462 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 463 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 464 void vm_map_startup (void); 465 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 466 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int, off_t); 467 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t, int *); 468 void vm_init2 (void); 469 int vm_uiomove (vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *); 470 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 471 int vm_map_growstack (struct proc *p, vm_offset_t addr); 472 int vmspace_swap_count (struct vmspace *vmspace); 473 void vm_map_set_wired_quick(vm_map_t map, vm_offset_t addr, vm_size_t size, int *); 474 475 #endif 476 #endif /* _VM_VM_MAP_H_ */ 477