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$ 65 */ 66 67 /* 68 * Virtual memory map module definitions. 69 */ 70 #ifndef _VM_MAP_ 71 #define _VM_MAP_ 72 73 #include <sys/lock.h> 74 #include <sys/lockmgr.h> 75 76 /* 77 * Types defined: 78 * 79 * vm_map_t the high-level address map data structure. 80 * vm_map_entry_t an entry in an address map. 81 */ 82 83 typedef u_int vm_eflags_t; 84 85 /* 86 * Objects which live in maps may be either VM objects, or 87 * another map (called a "sharing map") which denotes read-write 88 * sharing with other maps. 89 */ 90 union vm_map_object { 91 struct vm_object *vm_object; /* object object */ 92 struct vm_map *sub_map; /* belongs to another map */ 93 }; 94 95 /* 96 * Address map entries consist of start and end addresses, 97 * a VM object (or sharing map) and offset into that object, 98 * and user-exported inheritance and protection information. 99 * Also included is control information for virtual copy operations. 100 */ 101 struct vm_map_entry { 102 struct vm_map_entry *prev; /* previous entry */ 103 struct vm_map_entry *next; /* next entry */ 104 vm_offset_t start; /* start address */ 105 vm_offset_t end; /* end address */ 106 vm_offset_t avail_ssize; /* amt can grow if this is a stack */ 107 union vm_map_object object; /* object I point to */ 108 vm_ooffset_t offset; /* offset into object */ 109 vm_eflags_t eflags; /* map entry flags */ 110 /* Only in task maps: */ 111 vm_prot_t protection; /* protection code */ 112 vm_prot_t max_protection; /* maximum protection */ 113 vm_inherit_t inheritance; /* inheritance */ 114 int wired_count; /* can be paged if = 0 */ 115 vm_pindex_t lastr; /* last read */ 116 }; 117 118 #define MAP_ENTRY_NOSYNC 0x0001 119 #define MAP_ENTRY_IS_SUB_MAP 0x0002 120 #define MAP_ENTRY_COW 0x0004 121 #define MAP_ENTRY_NEEDS_COPY 0x0008 122 #define MAP_ENTRY_NOFAULT 0x0010 123 #define MAP_ENTRY_USER_WIRED 0x0020 124 125 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */ 126 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */ 127 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */ 128 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */ 129 130 #define MAP_ENTRY_BEHAV_MASK 0x00C0 131 132 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */ 133 134 /* 135 * Maps are doubly-linked lists of map entries, kept sorted 136 * by address. A single hint is provided to start 137 * searches again from the last successful search, 138 * insertion, or removal. 139 * 140 * Note: the lock structure cannot be the first element of vm_map 141 * because this can result in a running lockup between two or more 142 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait() 143 * and free tsleep/waking up 'map' and the underlying lockmgr also 144 * sleeping and waking up on 'map'. The lockup occurs when the map fills 145 * up. The 'exec' map, for example. 146 * 147 * List of locks 148 * (c) const until freed 149 */ 150 struct vm_map { 151 struct vm_map_entry header; /* List of entries */ 152 struct lock lock; /* Lock for map data */ 153 int nentries; /* Number of entries */ 154 vm_size_t size; /* virtual size */ 155 u_char system_map; /* Am I a system map? */ 156 u_char infork; /* Am I in fork processing? */ 157 vm_map_entry_t hint; /* hint for quick lookups */ 158 unsigned int timestamp; /* Version number */ 159 vm_map_entry_t first_free; /* First free space hint */ 160 pmap_t pmap; /* (c) Physical map */ 161 #define min_offset header.start /* (c) */ 162 #define max_offset header.end /* (c) */ 163 }; 164 165 #ifdef _KERNEL 166 static __inline vm_offset_t 167 vm_map_max(vm_map_t map) 168 { 169 return (map->max_offset); 170 } 171 172 static __inline vm_offset_t 173 vm_map_min(vm_map_t map) 174 { 175 return (map->min_offset); 176 } 177 178 static __inline pmap_t 179 vm_map_pmap(vm_map_t map) 180 { 181 return (map->pmap); 182 } 183 #endif /* _KERNEL */ 184 185 /* 186 * Shareable process virtual address space. 187 * May eventually be merged with vm_map. 188 * Several fields are temporary (text, data stuff). 189 */ 190 struct vmspace { 191 struct vm_map vm_map; /* VM address map */ 192 struct pmap vm_pmap; /* private physical map */ 193 int vm_refcnt; /* number of references */ 194 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 195 /* we copy from vm_startcopy to the end of the structure on fork */ 196 #define vm_startcopy vm_rssize 197 segsz_t vm_rssize; /* current resident set size in pages */ 198 segsz_t vm_swrss; /* resident set size before last swap */ 199 segsz_t vm_tsize; /* text size (pages) XXX */ 200 segsz_t vm_dsize; /* data size (pages) XXX */ 201 segsz_t vm_ssize; /* stack size (pages) */ 202 caddr_t vm_taddr; /* user virtual address of text XXX */ 203 caddr_t vm_daddr; /* user virtual address of data XXX */ 204 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 205 caddr_t vm_minsaddr; /* user VA at max stack growth */ 206 #define vm_endcopy vm_freer 207 struct proc *vm_freer; /* vm freed on whose behalf */ 208 }; 209 210 #ifdef _KERNEL 211 u_char vm_map_entry_behavior(struct vm_map_entry *entry); 212 void vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior); 213 214 /* 215 * Macros: vm_map_lock, etc. 216 * Function: 217 * Perform locking on the data portion of a map. Note that 218 * these macros mimic procedure calls returning void. The 219 * semicolon is supplied by the user of these macros, not 220 * by the macros themselves. The macros can safely be used 221 * as unbraced elements in a higher level statement. 222 */ 223 224 void _vm_map_lock(vm_map_t map, const char *file, int line); 225 void _vm_map_unlock(vm_map_t map, const char *file, int line); 226 void _vm_map_lock_read(vm_map_t map, const char *file, int line); 227 void _vm_map_unlock_read(vm_map_t map, const char *file, int line); 228 int _vm_map_trylock(vm_map_t map, const char *file, int line); 229 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 230 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 231 void _vm_map_set_recursive(vm_map_t map, const char *file, int line); 232 void _vm_map_clear_recursive(vm_map_t map, const char *file, int line); 233 234 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 235 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 236 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 237 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 238 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 239 #define vm_map_lock_upgrade(map) \ 240 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 241 #define vm_map_lock_downgrade(map) \ 242 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 243 #define vm_map_set_recursive(map) \ 244 _vm_map_set_recursive(map, LOCK_FILE, LOCK_LINE) 245 #define vm_map_clear_recursive(map) \ 246 _vm_map_clear_recursive(map, LOCK_FILE, LOCK_LINE) 247 248 struct pmap *vmspace_pmap(struct vmspace *vmspace); 249 long vmspace_resident_count(struct vmspace *vmspace); 250 #endif /* _KERNEL */ 251 252 253 /* XXX: number of kernel maps and entries to statically allocate */ 254 #define MAX_KMAP 10 255 #define MAX_KMAPENT 128 256 #define MAX_MAPENT 128 257 258 /* 259 * Copy-on-write flags for vm_map operations 260 */ 261 #define MAP_UNUSED_01 0x0001 262 #define MAP_COPY_ON_WRITE 0x0002 263 #define MAP_NOFAULT 0x0004 264 #define MAP_PREFAULT 0x0008 265 #define MAP_PREFAULT_PARTIAL 0x0010 266 #define MAP_DISABLE_SYNCER 0x0020 267 #define MAP_DISABLE_COREDUMP 0x0100 268 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */ 269 270 /* 271 * vm_fault option flags 272 */ 273 #define VM_FAULT_NORMAL 0 /* Nothing special */ 274 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */ 275 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */ 276 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE) 277 #define VM_FAULT_DIRTY 8 /* Dirty the page */ 278 279 #ifdef _KERNEL 280 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 281 struct pmap; 282 vm_map_t vm_map_create (struct pmap *, vm_offset_t, vm_offset_t); 283 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t); 284 int 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); 285 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *); 286 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 287 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t); 288 int 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); 289 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 290 vm_pindex_t *, vm_prot_t *, boolean_t *); 291 void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 292 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 293 int vm_map_pageable (vm_map_t, vm_offset_t, vm_offset_t, boolean_t); 294 int vm_map_user_pageable (vm_map_t, vm_offset_t, vm_offset_t, boolean_t); 295 int vm_map_clean (vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 296 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 297 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 298 void vm_map_startup (void); 299 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 300 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 301 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t); 302 void vm_init2 (void); 303 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 304 int vm_map_growstack (struct proc *p, vm_offset_t addr); 305 int vmspace_swap_count (struct vmspace *vmspace); 306 int vm_uiomove(vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *); 307 #endif /* _KERNEL */ 308 #endif /* _VM_MAP_ */ 309