vm_map.h revision 267901
1160581Sobrien/*- 2160581Sobrien * Copyright (c) 1991, 1993 3160581Sobrien * The Regents of the University of California. All rights reserved. 4160581Sobrien * 5160581Sobrien * This code is derived from software contributed to Berkeley by 6160581Sobrien * The Mach Operating System project at Carnegie-Mellon University. 7160581Sobrien * 8160581Sobrien * Redistribution and use in source and binary forms, with or without 9160581Sobrien * modification, are permitted provided that the following conditions 10160581Sobrien * are met: 11160581Sobrien * 1. Redistributions of source code must retain the above copyright 12160581Sobrien * notice, this list of conditions and the following disclaimer. 13160581Sobrien * 2. Redistributions in binary form must reproduce the above copyright 14160581Sobrien * notice, this list of conditions and the following disclaimer in the 15160581Sobrien * documentation and/or other materials provided with the distribution. 16160581Sobrien * 4. Neither the name of the University nor the names of its contributors 17160581Sobrien * may be used to endorse or promote products derived from this software 18160581Sobrien * without specific prior written permission. 19160581Sobrien * 20160581Sobrien * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21160581Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22160581Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23160581Sobrien * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24160581Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25160581Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26160581Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27160581Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28160581Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29160581Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30160581Sobrien * SUCH DAMAGE. 31162303Simp * 32160581Sobrien * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 33160581Sobrien * 34162303Simp * 35162303Simp * Copyright (c) 1987, 1990 Carnegie-Mellon University. 36160581Sobrien * All rights reserved. 37160581Sobrien * 38160581Sobrien * Authors: Avadis Tevanian, Jr., Michael Wayne Young 39160581Sobrien * 40160581Sobrien * Permission to use, copy, modify and distribute this software and 41160581Sobrien * its documentation is hereby granted, provided that both the copyright 42160581Sobrien * notice and this permission notice appear in all copies of the 43160581Sobrien * software, derivative works or modified versions, and any portions 44160581Sobrien * thereof, and that both notices appear in supporting documentation. 45160581Sobrien * 46160581Sobrien * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 47160581Sobrien * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 48160581Sobrien * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 49160581Sobrien * 50246893Smarcel * Carnegie Mellon requests users of this software to return to 51246893Smarcel * 52246893Smarcel * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 53261788Sjmg * School of Computer Science 54246893Smarcel * Carnegie Mellon University 55261788Sjmg * Pittsburgh PA 15213-3890 56261788Sjmg * 57261788Sjmg * any improvements or extensions that they make and grant Carnegie the 58246893Smarcel * rights to redistribute these changes. 59246893Smarcel * 60160581Sobrien * $FreeBSD: stable/10/sys/vm/vm_map.h 267901 2014-06-26 08:30:08Z kib $ 61160581Sobrien */ 62160581Sobrien 63162303Simp/* 64160581Sobrien * Virtual memory map module definitions. 65160581Sobrien */ 66290193Szbb#ifndef _VM_MAP_ 67163440Sjhb#define _VM_MAP_ 68178713Sjhb 69160581Sobrien#include <sys/lock.h> 70160581Sobrien#include <sys/sx.h> 71160581Sobrien#include <sys/_mutex.h> 72160581Sobrien 73160581Sobrien/* 74160581Sobrien * Types defined: 75276190Sian * 76276190Sian * vm_map_t the high-level address map data structure. 77276190Sian * vm_map_entry_t an entry in an address map. 78160581Sobrien */ 79290193Szbb 80290193Szbbtypedef u_char vm_flags_t; 81162303Simptypedef u_int vm_eflags_t; 82160581Sobrien 83160581Sobrien/* 84160581Sobrien * Objects which live in maps may be either VM objects, or 85160581Sobrien * another map (called a "sharing map") which denotes read-write 86160581Sobrien * sharing with other maps. 87160581Sobrien */ 88160581Sobrienunion vm_map_object { 89160581Sobrien struct vm_object *vm_object; /* object object */ 90178670Sjhb struct vm_map *sub_map; /* belongs to another map */ 91178670Sjhb}; 92178670Sjhb 93178670Sjhb/* 94178670Sjhb * Address map entries consist of start and end addresses, 95162303Simp * a VM object (or sharing map) and offset into that object, 96160581Sobrien * and user-exported inheritance and protection information. 97160581Sobrien * Also included is control information for virtual copy operations. 98160581Sobrien */ 99298358Swmastruct vm_map_entry { 100160581Sobrien struct vm_map_entry *prev; /* previous entry */ 101160581Sobrien struct vm_map_entry *next; /* next entry */ 102160581Sobrien struct vm_map_entry *left; /* left child in binary search tree */ 103160581Sobrien struct vm_map_entry *right; /* right child in binary search tree */ 104160581Sobrien vm_offset_t start; /* start address */ 105160581Sobrien vm_offset_t end; /* end address */ 106160581Sobrien vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 107160581Sobrien vm_size_t adj_free; /* amount of adjacent free space */ 108160581Sobrien vm_size_t max_free; /* max free space in subtree */ 109160581Sobrien union vm_map_object object; /* object I point to */ 110160581Sobrien vm_ooffset_t offset; /* offset into object */ 111160581Sobrien vm_eflags_t eflags; /* map entry flags */ 112160581Sobrien vm_prot_t protection; /* protection code */ 113160581Sobrien vm_prot_t max_protection; /* maximum protection */ 114160581Sobrien vm_inherit_t inheritance; /* inheritance */ 115160581Sobrien uint8_t read_ahead; /* pages in the read-ahead window */ 116160581Sobrien int wired_count; /* can be paged if = 0 */ 117160581Sobrien vm_pindex_t next_read; /* index of the next sequential read */ 118160581Sobrien struct ucred *cred; /* tmp storage for creator ref */ 119160581Sobrien struct thread *wiring_thread; 120160581Sobrien}; 121160581Sobrien 122160581Sobrien#define MAP_ENTRY_NOSYNC 0x0001 123160581Sobrien#define MAP_ENTRY_IS_SUB_MAP 0x0002 124160581Sobrien#define MAP_ENTRY_COW 0x0004 125160581Sobrien#define MAP_ENTRY_NEEDS_COPY 0x0008 126160581Sobrien#define MAP_ENTRY_NOFAULT 0x0010 127160581Sobrien#define MAP_ENTRY_USER_WIRED 0x0020 128160581Sobrien 129160581Sobrien#define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 130160581Sobrien#define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 131160581Sobrien#define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 132160581Sobrien#define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 133160581Sobrien 134160581Sobrien#define MAP_ENTRY_BEHAV_MASK 0x00C0 135160581Sobrien 136160581Sobrien#define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */ 137160581Sobrien#define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */ 138160581Sobrien#define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 139298358Swma 140160581Sobrien#define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */ 141160581Sobrien#define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */ 142160581Sobrien 143160581Sobrien#define MAP_ENTRY_WIRE_SKIPPED 0x4000 144162303Simp#define MAP_ENTRY_VN_WRITECNT 0x8000 /* writeable vnode mapping */ 145162303Simp 146160581Sobrien#ifdef _KERNEL 147160581Sobrienstatic __inline u_char 148160581Sobrienvm_map_entry_behavior(vm_map_entry_t entry) 149160581Sobrien{ 150160581Sobrien return (entry->eflags & MAP_ENTRY_BEHAV_MASK); 151160581Sobrien} 152160581Sobrien 153298358Swmastatic __inline int 154160581Sobrienvm_map_entry_user_wired_count(vm_map_entry_t entry) 155160581Sobrien{ 156160581Sobrien if (entry->eflags & MAP_ENTRY_USER_WIRED) 157160581Sobrien return (1); 158160581Sobrien return (0); 159160581Sobrien} 160160581Sobrien 161160581Sobrienstatic __inline int 162160581Sobrienvm_map_entry_system_wired_count(vm_map_entry_t entry) 163160581Sobrien{ 164298358Swma return (entry->wired_count - vm_map_entry_user_wired_count(entry)); 165160581Sobrien} 166160581Sobrien#endif /* _KERNEL */ 167160581Sobrien 168160581Sobrien/* 169160581Sobrien * A map is a set of map entries. These map entries are 170160581Sobrien * organized both as a binary search tree and as a doubly-linked 171160581Sobrien * list. Both structures are ordered based upon the start and 172160581Sobrien * end addresses contained within each map entry. Sleator and 173160581Sobrien * Tarjan's top-down splay algorithm is employed to control 174160581Sobrien * height imbalance in the binary search tree. 175160581Sobrien * 176160581Sobrien * List of locks 177160581Sobrien * (c) const until freed 178160581Sobrien */ 179160581Sobrienstruct vm_map { 180160581Sobrien struct vm_map_entry header; /* List of entries */ 181160581Sobrien struct sx lock; /* Lock for map data */ 182298358Swma struct mtx system_mtx; 183163440Sjhb int nentries; /* Number of entries */ 184298358Swma vm_size_t size; /* virtual size */ 185298358Swma u_int timestamp; /* Version number */ 186160581Sobrien u_char needs_wakeup; 187160581Sobrien u_char system_map; /* (c) Am I a system map? */ 188160581Sobrien vm_flags_t flags; /* flags for this vm_map */ 189160581Sobrien vm_map_entry_t root; /* Root of a binary search tree */ 190160581Sobrien pmap_t pmap; /* (c) Physical map */ 191160581Sobrien#define min_offset header.start /* (c) */ 192160581Sobrien#define max_offset header.end /* (c) */ 193160581Sobrien int busy; 194160581Sobrien}; 195162303Simp 196160581Sobrien/* 197160581Sobrien * vm_flags_t values 198160581Sobrien */ 199160581Sobrien#define MAP_WIREFUTURE 0x01 /* wire all future pages */ 200162303Simp#define MAP_BUSY_WAKEUP 0x02 201160581Sobrien 202160581Sobrien#ifdef _KERNEL 203160581Sobrienstatic __inline vm_offset_t 204160581Sobrienvm_map_max(const struct vm_map *map) 205160581Sobrien{ 206160581Sobrien return (map->max_offset); 207162303Simp} 208162303Simp 209160581Sobrienstatic __inline vm_offset_t 210162303Simpvm_map_min(const struct vm_map *map) 211162303Simp{ 212162303Simp return (map->min_offset); 213160581Sobrien} 214160581Sobrien 215160581Sobrienstatic __inline pmap_t 216162303Simpvm_map_pmap(vm_map_t map) 217160581Sobrien{ 218160581Sobrien return (map->pmap); 219162303Simp} 220162303Simp 221162303Simpstatic __inline void 222162303Simpvm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 223162303Simp{ 224160581Sobrien map->flags = (map->flags | set) & ~clear; 225160581Sobrien} 226298358Swma#endif /* _KERNEL */ 227298358Swma 228298358Swma/* 229298358Swma * Shareable process virtual address space. 230298358Swma * 231298358Swma * List of locks 232298358Swma * (c) const until freed 233298358Swma */ 234298358Swmastruct vmspace { 235298358Swma struct vm_map vm_map; /* VM address map */ 236298358Swma struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 237298358Swma segsz_t vm_swrss; /* resident set size before last swap */ 238298358Swma segsz_t vm_tsize; /* text size (pages) XXX */ 239298358Swma segsz_t vm_dsize; /* data size (pages) XXX */ 240298358Swma segsz_t vm_ssize; /* stack size (pages) */ 241298358Swma caddr_t vm_taddr; /* (c) user virtual address of text */ 242298358Swma caddr_t vm_daddr; /* (c) user virtual address of data */ 243298358Swma caddr_t vm_maxsaddr; /* user VA at max stack growth */ 244298358Swma volatile int vm_refcnt; /* number of references */ 245298358Swma /* 246298358Swma * Keep the PMAP last, so that CPU-specific variations of that 247298358Swma * structure on a single architecture don't result in offset 248298358Swma * variations of the machine-independent fields in the vmspace. 249298358Swma */ 250298358Swma struct pmap vm_pmap; /* private physical map */ 251298358Swma}; 252298358Swma 253298358Swma#ifdef _KERNEL 254298358Swmastatic __inline pmap_t 255298358Swmavmspace_pmap(struct vmspace *vmspace) 256298358Swma{ 257298358Swma return &vmspace->vm_pmap; 258298358Swma} 259298358Swma#endif /* _KERNEL */ 260298358Swma 261298358Swma#ifdef _KERNEL 262298358Swma/* 263298358Swma * Macros: vm_map_lock, etc. 264298358Swma * Function: 265298358Swma * Perform locking on the data portion of a map. Note that 266298358Swma * these macros mimic procedure calls returning void. The 267298358Swma * semicolon is supplied by the user of these macros, not 268298358Swma * by the macros themselves. The macros can safely be used 269298358Swma * as unbraced elements in a higher level statement. 270298358Swma */ 271298358Swma 272298358Swmavoid _vm_map_lock(vm_map_t map, const char *file, int line); 273298358Swmavoid _vm_map_unlock(vm_map_t map, const char *file, int line); 274298358Swmaint _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line); 275298358Swmavoid _vm_map_lock_read(vm_map_t map, const char *file, int line); 276298358Swmavoid _vm_map_unlock_read(vm_map_t map, const char *file, int line); 277298358Swmaint _vm_map_trylock(vm_map_t map, const char *file, int line); 278298358Swmaint _vm_map_trylock_read(vm_map_t map, const char *file, int line); 279298358Swmaint _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 280298358Swmavoid _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 281298358Swmaint vm_map_locked(vm_map_t map); 282298358Swmavoid vm_map_wakeup(vm_map_t map); 283298358Swmavoid vm_map_busy(vm_map_t map); 284298358Swmavoid vm_map_unbusy(vm_map_t map); 285298358Swmavoid vm_map_wait_busy(vm_map_t map); 286298358Swma 287#define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 288#define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 289#define vm_map_unlock_and_wait(map, timo) \ 290 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE) 291#define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 292#define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 293#define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 294#define vm_map_trylock_read(map) \ 295 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 296#define vm_map_lock_upgrade(map) \ 297 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 298#define vm_map_lock_downgrade(map) \ 299 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 300 301long vmspace_resident_count(struct vmspace *vmspace); 302#endif /* _KERNEL */ 303 304 305/* XXX: number of kernel maps and entries to statically allocate */ 306#define MAX_KMAP 10 307#define MAX_KMAPENT 128 308 309/* 310 * Copy-on-write flags for vm_map operations 311 */ 312#define MAP_INHERIT_SHARE 0x0001 313#define MAP_COPY_ON_WRITE 0x0002 314#define MAP_NOFAULT 0x0004 315#define MAP_PREFAULT 0x0008 316#define MAP_PREFAULT_PARTIAL 0x0010 317#define MAP_DISABLE_SYNCER 0x0020 318#define MAP_CHECK_EXCL 0x0040 319#define MAP_DISABLE_COREDUMP 0x0100 320#define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 321#define MAP_VN_WRITECOUNT 0x0400 322#define MAP_STACK_GROWS_DOWN 0x1000 323#define MAP_STACK_GROWS_UP 0x2000 324#define MAP_ACC_CHARGED 0x4000 325#define MAP_ACC_NO_CHARGE 0x8000 326 327/* 328 * vm_fault option flags 329 */ 330#define VM_FAULT_NORMAL 0 /* Nothing special */ 331#define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 332#define VM_FAULT_DIRTY 2 /* Dirty the page; use w/VM_PROT_COPY */ 333 334/* 335 * Initially, mappings are slightly sequential. The maximum window size must 336 * account for the map entry's "read_ahead" field being defined as an uint8_t. 337 */ 338#define VM_FAULT_READ_AHEAD_MIN 7 339#define VM_FAULT_READ_AHEAD_INIT 15 340#define VM_FAULT_READ_AHEAD_MAX min(atop(MAXPHYS) - 1, UINT8_MAX) 341 342/* 343 * The following "find_space" options are supported by vm_map_find(). 344 * 345 * For VMFS_ALIGNED_SPACE, the desired alignment is specified to 346 * the macro argument as log base 2 of the desired alignment. 347 */ 348#define VMFS_NO_SPACE 0 /* don't find; use the given range */ 349#define VMFS_ANY_SPACE 1 /* find a range with any alignment */ 350#define VMFS_OPTIMAL_SPACE 2 /* find a range with optimal alignment*/ 351#define VMFS_SUPER_SPACE 3 /* find a superpage-aligned range */ 352#define VMFS_ALIGNED_SPACE(x) ((x) << 8) /* find a range with fixed alignment */ 353 354/* 355 * vm_map_wire and vm_map_unwire option flags 356 */ 357#define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 358#define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 359 360#define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 361#define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 362 363#define VM_MAP_WIRE_WRITE 4 /* Validate writable. */ 364 365#ifdef _KERNEL 366boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 367vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 368int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t); 369int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, 370 vm_offset_t, int, vm_prot_t, vm_prot_t, int); 371int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t, 372 vm_prot_t, vm_prot_t, int); 373int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 374int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 375void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t); 376int 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); 377int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 378 vm_pindex_t *, vm_prot_t *, boolean_t *); 379int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 380 vm_pindex_t *, vm_prot_t *, boolean_t *); 381void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 382boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 383void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot, 384 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags); 385int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 386int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 387void vm_map_startup (void); 388int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 389int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 390int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 391void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 392int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 393int vm_map_growstack (struct proc *p, vm_offset_t addr); 394int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 395 int flags); 396int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, 397 int flags); 398long vmspace_swap_count(struct vmspace *vmspace); 399#endif /* _KERNEL */ 400#endif /* _VM_MAP_ */ 401