vm_map.h revision 128596
1193323Sed/* 2193323Sed * Copyright (c) 1991, 1993 3193323Sed * The Regents of the University of California. All rights reserved. 4193323Sed * 5193323Sed * This code is derived from software contributed to Berkeley by 6193323Sed * The Mach Operating System project at Carnegie-Mellon University. 7193323Sed * 8193323Sed * Redistribution and use in source and binary forms, with or without 9193323Sed * modification, are permitted provided that the following conditions 10193323Sed * are met: 11193323Sed * 1. Redistributions of source code must retain the above copyright 12193323Sed * notice, this list of conditions and the following disclaimer. 13193323Sed * 2. Redistributions in binary form must reproduce the above copyright 14193323Sed * notice, this list of conditions and the following disclaimer in the 15193323Sed * documentation and/or other materials provided with the distribution. 16193323Sed * 4. Neither the name of the University nor the names of its contributors 17193323Sed * may be used to endorse or promote products derived from this software 18193323Sed * without specific prior written permission. 19193323Sed * 20193323Sed * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21193323Sed * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22193323Sed * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23193323Sed * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24193323Sed * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25193323Sed * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26193323Sed * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27193323Sed * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28193323Sed * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29193323Sed * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30193323Sed * SUCH DAMAGE. 31193323Sed * 32193323Sed * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 33193323Sed * 34193323Sed * 35193323Sed * Copyright (c) 1987, 1990 Carnegie-Mellon University. 36193323Sed * All rights reserved. 37193323Sed * 38193323Sed * Authors: Avadis Tevanian, Jr., Michael Wayne Young 39193323Sed * 40193323Sed * Permission to use, copy, modify and distribute this software and 41193323Sed * its documentation is hereby granted, provided that both the copyright 42193323Sed * notice and this permission notice appear in all copies of the 43193323Sed * software, derivative works or modified versions, and any portions 44193323Sed * thereof, and that both notices appear in supporting documentation. 45193323Sed * 46193323Sed * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 47193323Sed * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 48193323Sed * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 49193323Sed * 50193323Sed * Carnegie Mellon requests users of this software to return to 51193323Sed * 52193323Sed * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 53193323Sed * School of Computer Science 54193323Sed * Carnegie Mellon University 55193323Sed * Pittsburgh PA 15213-3890 56193323Sed * 57193323Sed * any improvements or extensions that they make and grant Carnegie the 58193323Sed * rights to redistribute these changes. 59193323Sed * 60193323Sed * $FreeBSD: head/sys/vm/vm_map.h 128596 2004-04-24 03:46:44Z alc $ 61193323Sed */ 62193323Sed 63193323Sed/* 64193323Sed * Virtual memory map module definitions. 65193323Sed */ 66193323Sed#ifndef _VM_MAP_ 67193323Sed#define _VM_MAP_ 68193323Sed 69193323Sed#include <sys/lock.h> 70193323Sed#include <sys/lockmgr.h> 71193323Sed#include <sys/_mutex.h> 72193323Sed 73193323Sed/* 74193323Sed * Types defined: 75193323Sed * 76193323Sed * vm_map_t the high-level address map data structure. 77193323Sed * vm_map_entry_t an entry in an address map. 78193323Sed */ 79193323Sed 80193323Sedtypedef u_char vm_flags_t; 81193323Sedtypedef u_int vm_eflags_t; 82193323Sed 83193323Sed/* 84193323Sed * Objects which live in maps may be either VM objects, or 85193323Sed * another map (called a "sharing map") which denotes read-write 86193323Sed * sharing with other maps. 87193323Sed */ 88193323Sedunion vm_map_object { 89193323Sed struct vm_object *vm_object; /* object object */ 90193323Sed struct vm_map *sub_map; /* belongs to another map */ 91193323Sed}; 92193323Sed 93193323Sed/* 94193323Sed * Address map entries consist of start and end addresses, 95193323Sed * a VM object (or sharing map) and offset into that object, 96193323Sed * and user-exported inheritance and protection information. 97193323Sed * Also included is control information for virtual copy operations. 98193323Sed */ 99193323Sedstruct vm_map_entry { 100193323Sed struct vm_map_entry *prev; /* previous entry */ 101193323Sed struct vm_map_entry *next; /* next entry */ 102193323Sed struct vm_map_entry *left; /* left child in binary search tree */ 103193323Sed struct vm_map_entry *right; /* right child in binary search tree */ 104193323Sed vm_offset_t start; /* start address */ 105193323Sed vm_offset_t end; /* end address */ 106193323Sed vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 107193323Sed union vm_map_object object; /* object I point to */ 108193323Sed vm_ooffset_t offset; /* offset into object */ 109193323Sed vm_eflags_t eflags; /* map entry flags */ 110193323Sed /* Only in task maps: */ 111193323Sed vm_prot_t protection; /* protection code */ 112193323Sed vm_prot_t max_protection; /* maximum protection */ 113193323Sed vm_inherit_t inheritance; /* inheritance */ 114193323Sed int wired_count; /* can be paged if = 0 */ 115193323Sed vm_pindex_t lastr; /* last read */ 116193323Sed}; 117193323Sed 118193323Sed#define MAP_ENTRY_NOSYNC 0x0001 119193323Sed#define MAP_ENTRY_IS_SUB_MAP 0x0002 120193323Sed#define MAP_ENTRY_COW 0x0004 121193323Sed#define MAP_ENTRY_NEEDS_COPY 0x0008 122193323Sed#define MAP_ENTRY_NOFAULT 0x0010 123193323Sed#define MAP_ENTRY_USER_WIRED 0x0020 124193323Sed 125193323Sed#define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 126193323Sed#define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 127193323Sed#define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 128193323Sed#define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 129193323Sed 130193323Sed#define MAP_ENTRY_BEHAV_MASK 0x00C0 131193323Sed 132193323Sed#define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */ 133193323Sed#define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */ 134193323Sed#define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 135193323Sed 136193323Sed#define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */ 137193323Sed#define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */ 138193323Sed 139193323Sed#ifdef _KERNEL 140193323Sedstatic __inline u_char 141193323Sedvm_map_entry_behavior(vm_map_entry_t entry) 142193323Sed{ 143193323Sed return (entry->eflags & MAP_ENTRY_BEHAV_MASK); 144193323Sed} 145193323Sed#endif /* _KERNEL */ 146193323Sed 147193323Sed/* 148193323Sed * A map is a set of map entries. These map entries are 149193323Sed * organized both as a binary search tree and as a doubly-linked 150193323Sed * list. Both structures are ordered based upon the start and 151193323Sed * end addresses contained within each map entry. Sleator and 152193323Sed * Tarjan's top-down splay algorithm is employed to control 153193323Sed * height imbalance in the binary search tree. 154193323Sed * 155193323Sed * Note: the lock structure cannot be the first element of vm_map 156193323Sed * because this can result in a running lockup between two or more 157193323Sed * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait() 158193323Sed * and free tsleep/waking up 'map' and the underlying lockmgr also 159193323Sed * sleeping and waking up on 'map'. The lockup occurs when the map fills 160193323Sed * up. The 'exec' map, for example. 161193323Sed * 162193323Sed * List of locks 163193323Sed * (c) const until freed 164193323Sed */ 165193323Sedstruct vm_map { 166193323Sed struct vm_map_entry header; /* List of entries */ 167193323Sed struct lock lock; /* Lock for map data */ 168193323Sed struct mtx system_mtx; 169193323Sed int nentries; /* Number of entries */ 170193323Sed vm_size_t size; /* virtual size */ 171193323Sed u_int timestamp; /* Version number */ 172193323Sed u_char needs_wakeup; 173193323Sed u_char system_map; /* Am I a system map? */ 174193323Sed u_char infork; /* Am I in fork processing? */ 175193323Sed vm_flags_t flags; /* flags for this vm_map */ 176193323Sed vm_map_entry_t root; /* Root of a binary search tree */ 177193323Sed vm_map_entry_t first_free; /* First free space hint */ 178 pmap_t pmap; /* (c) Physical map */ 179#define min_offset header.start /* (c) */ 180#define max_offset header.end /* (c) */ 181}; 182 183/* 184 * vm_flags_t values 185 */ 186#define MAP_WIREFUTURE 0x01 /* wire all future pages */ 187 188#ifdef _KERNEL 189static __inline vm_offset_t 190vm_map_max(vm_map_t map) 191{ 192 return (map->max_offset); 193} 194 195static __inline vm_offset_t 196vm_map_min(vm_map_t map) 197{ 198 return (map->min_offset); 199} 200 201static __inline pmap_t 202vm_map_pmap(vm_map_t map) 203{ 204 return (map->pmap); 205} 206 207static __inline void 208vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 209{ 210 map->flags = (map->flags | set) & ~clear; 211} 212#endif /* _KERNEL */ 213 214/* 215 * Shareable process virtual address space. 216 * 217 * List of locks 218 * (c) const until freed 219 */ 220struct vmspace { 221 struct vm_map vm_map; /* VM address map */ 222 struct pmap vm_pmap; /* private physical map */ 223 int vm_refcnt; /* number of references */ 224 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 225/* we copy between vm_startcopy and vm_endcopy on fork */ 226#define vm_startcopy vm_rssize 227 segsz_t vm_rssize; /* current resident set size in pages */ 228 segsz_t vm_swrss; /* resident set size before last swap */ 229 segsz_t vm_tsize; /* text size (pages) XXX */ 230 segsz_t vm_dsize; /* data size (pages) XXX */ 231 segsz_t vm_ssize; /* stack size (pages) */ 232 caddr_t vm_taddr; /* (c) user virtual address of text */ 233 caddr_t vm_daddr; /* (c) user virtual address of data */ 234 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 235#define vm_endcopy vm_exitingcnt 236 int vm_exitingcnt; /* several processes zombied in exit1 */ 237}; 238 239#ifdef _KERNEL 240static __inline pmap_t 241vmspace_pmap(struct vmspace *vmspace) 242{ 243 return &vmspace->vm_pmap; 244} 245#endif /* _KERNEL */ 246 247#ifdef _KERNEL 248/* 249 * Macros: vm_map_lock, etc. 250 * Function: 251 * Perform locking on the data portion of a map. Note that 252 * these macros mimic procedure calls returning void. The 253 * semicolon is supplied by the user of these macros, not 254 * by the macros themselves. The macros can safely be used 255 * as unbraced elements in a higher level statement. 256 */ 257 258void _vm_map_lock(vm_map_t map, const char *file, int line); 259void _vm_map_unlock(vm_map_t map, const char *file, int line); 260void _vm_map_lock_read(vm_map_t map, const char *file, int line); 261void _vm_map_unlock_read(vm_map_t map, const char *file, int line); 262int _vm_map_trylock(vm_map_t map, const char *file, int line); 263int _vm_map_trylock_read(vm_map_t map, const char *file, int line); 264int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 265void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 266int vm_map_unlock_and_wait(vm_map_t map, boolean_t user_wait); 267void vm_map_wakeup(vm_map_t map); 268 269#define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 270#define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 271#define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 272#define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 273#define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 274#define vm_map_trylock_read(map) \ 275 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 276#define vm_map_lock_upgrade(map) \ 277 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 278#define vm_map_lock_downgrade(map) \ 279 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 280 281long vmspace_resident_count(struct vmspace *vmspace); 282long vmspace_wired_count(struct vmspace *vmspace); 283#endif /* _KERNEL */ 284 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_UNUSED_01 0x0001 295#define MAP_COPY_ON_WRITE 0x0002 296#define MAP_NOFAULT 0x0004 297#define MAP_PREFAULT 0x0008 298#define MAP_PREFAULT_PARTIAL 0x0010 299#define MAP_DISABLE_SYNCER 0x0020 300#define MAP_DISABLE_COREDUMP 0x0100 301#define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 302#define MAP_STACK_GROWS_DOWN 0x1000 303#define MAP_STACK_GROWS_UP 0x2000 304 305/* 306 * vm_fault option flags 307 */ 308#define VM_FAULT_NORMAL 0 /* Nothing special */ 309#define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 310#define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */ 311#define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 312#define VM_FAULT_DIRTY 8 /* Dirty the page */ 313 314/* 315 * vm_map_wire and vm_map_unwire option flags 316 */ 317#define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 318#define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 319 320#define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 321#define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 322 323#ifdef _KERNEL 324boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 325vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 326int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t); 327int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int); 328int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 329int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 330void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t); 331int vm_map_insert (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int); 332int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 333 vm_pindex_t *, vm_prot_t *, boolean_t *); 334void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 335boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 336void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot, 337 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags); 338int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 339int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 340void vm_map_startup (void); 341int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 342int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 343int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 344void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 345void vm_init2 (void); 346int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 347int vm_map_growstack (struct proc *p, vm_offset_t addr); 348int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 349 int flags); 350int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, 351 int flags); 352int vmspace_swap_count (struct vmspace *vmspace); 353#endif /* _KERNEL */ 354#endif /* _VM_MAP_ */ 355