1 /*- 2 * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU) 3 * 4 * Copyright (c) 1991, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * The Mach Operating System project at Carnegie-Mellon University. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 35 * 36 * 37 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 38 * All rights reserved. 39 * 40 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 41 * 42 * Permission to use, copy, modify and distribute this software and 43 * its documentation is hereby granted, provided that both the copyright 44 * notice and this permission notice appear in all copies of the 45 * software, derivative works or modified versions, and any portions 46 * thereof, and that both notices appear in supporting documentation. 47 * 48 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 49 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 50 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 51 * 52 * Carnegie Mellon requests users of this software to return to 53 * 54 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 55 * School of Computer Science 56 * Carnegie Mellon University 57 * Pittsburgh PA 15213-3890 58 * 59 * any improvements or extensions that they make and grant Carnegie the 60 * rights to redistribute these changes. 61 * 62 * $FreeBSD$ 63 */ 64 65 /* 66 * Virtual memory map module definitions. 67 */ 68 #ifndef _VM_MAP_ 69 #define _VM_MAP_ 70 71 #include <sys/lock.h> 72 #include <sys/sx.h> 73 #include <sys/_mutex.h> 74 75 /* 76 * Types defined: 77 * 78 * vm_map_t the high-level address map data structure. 79 * vm_map_entry_t an entry in an address map. 80 */ 81 82 typedef u_char vm_flags_t; 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 *left; /* left child or previous entry */ 103 struct vm_map_entry *right; /* right child or next entry */ 104 vm_offset_t start; /* start address */ 105 vm_offset_t end; /* end address */ 106 vm_offset_t next_read; /* vaddr of the next sequential read */ 107 vm_size_t max_free; /* max free space in subtree */ 108 union vm_map_object object; /* object I point to */ 109 vm_ooffset_t offset; /* offset into object */ 110 vm_eflags_t eflags; /* map entry flags */ 111 vm_prot_t protection; /* protection code */ 112 vm_prot_t max_protection; /* maximum protection */ 113 vm_inherit_t inheritance; /* inheritance */ 114 uint8_t read_ahead; /* pages in the read-ahead window */ 115 int wired_count; /* can be paged if = 0 */ 116 struct ucred *cred; /* tmp storage for creator ref */ 117 struct thread *wiring_thread; 118 }; 119 120 #define MAP_ENTRY_NOSYNC 0x00000001 121 #define MAP_ENTRY_IS_SUB_MAP 0x00000002 122 #define MAP_ENTRY_COW 0x00000004 123 #define MAP_ENTRY_NEEDS_COPY 0x00000008 124 #define MAP_ENTRY_NOFAULT 0x00000010 125 #define MAP_ENTRY_USER_WIRED 0x00000020 126 127 #define MAP_ENTRY_BEHAV_NORMAL 0x00000000 /* default behavior */ 128 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x00000040 /* expect sequential 129 access */ 130 #define MAP_ENTRY_BEHAV_RANDOM 0x00000080 /* expect random 131 access */ 132 #define MAP_ENTRY_BEHAV_RESERVED 0x000000c0 /* future use */ 133 #define MAP_ENTRY_BEHAV_MASK 0x000000c0 134 #define MAP_ENTRY_IN_TRANSITION 0x00000100 /* entry being 135 changed */ 136 #define MAP_ENTRY_NEEDS_WAKEUP 0x00000200 /* waiters in 137 transition */ 138 #define MAP_ENTRY_NOCOREDUMP 0x00000400 /* don't include in 139 a core */ 140 #define MAP_ENTRY_VN_EXEC 0x00000800 /* text vnode mapping */ 141 #define MAP_ENTRY_GROWS_DOWN 0x00001000 /* top-down stacks */ 142 #define MAP_ENTRY_GROWS_UP 0x00002000 /* bottom-up stacks */ 143 144 #define MAP_ENTRY_WIRE_SKIPPED 0x00004000 145 #define MAP_ENTRY_WRITECNT 0x00008000 /* tracked writeable 146 mapping */ 147 #define MAP_ENTRY_GUARD 0x00010000 148 #define MAP_ENTRY_STACK_GAP_DN 0x00020000 149 #define MAP_ENTRY_STACK_GAP_UP 0x00040000 150 #define MAP_ENTRY_HEADER 0x00080000 151 152 #ifdef _KERNEL 153 static __inline u_char 154 vm_map_entry_behavior(vm_map_entry_t entry) 155 { 156 return (entry->eflags & MAP_ENTRY_BEHAV_MASK); 157 } 158 159 static __inline int 160 vm_map_entry_user_wired_count(vm_map_entry_t entry) 161 { 162 if (entry->eflags & MAP_ENTRY_USER_WIRED) 163 return (1); 164 return (0); 165 } 166 167 static __inline int 168 vm_map_entry_system_wired_count(vm_map_entry_t entry) 169 { 170 return (entry->wired_count - vm_map_entry_user_wired_count(entry)); 171 } 172 #endif /* _KERNEL */ 173 174 /* 175 * A map is a set of map entries. These map entries are 176 * organized as a threaded binary search tree. Both structures 177 * are ordered based upon the start and end addresses contained 178 * within each map entry. The largest gap between an entry in a 179 * subtree and one of its neighbors is saved in the max_free 180 * field, and that field is updated when the tree is 181 * restructured. 182 * 183 * Sleator and Tarjan's top-down splay algorithm is employed to 184 * control height imbalance in the binary search tree. 185 * 186 * The map's min offset value is stored in map->header.end, and 187 * its max offset value is stored in map->header.start. These 188 * values act as sentinels for any forward or backward address 189 * scan of the list. The right and left fields of the map 190 * header point to the first and list map entries. The map 191 * header has a special value for the eflags field, 192 * MAP_ENTRY_HEADER, that is set initially, is never changed, 193 * and prevents an eflags match of the header with any other map 194 * entry. 195 * 196 * List of locks 197 * (c) const until freed 198 */ 199 struct vm_map { 200 struct vm_map_entry header; /* List of entries */ 201 struct sx lock; /* Lock for map data */ 202 struct mtx system_mtx; 203 int nentries; /* Number of entries */ 204 vm_size_t size; /* virtual size */ 205 u_int timestamp; /* Version number */ 206 u_char needs_wakeup; 207 u_char system_map; /* (c) Am I a system map? */ 208 vm_flags_t flags; /* flags for this vm_map */ 209 vm_map_entry_t root; /* Root of a binary search tree */ 210 pmap_t pmap; /* (c) Physical map */ 211 vm_offset_t anon_loc; 212 int busy; 213 #ifdef DIAGNOSTIC 214 int nupdates; 215 #endif 216 }; 217 218 /* 219 * vm_flags_t values 220 */ 221 #define MAP_WIREFUTURE 0x01 /* wire all future pages */ 222 #define MAP_BUSY_WAKEUP 0x02 223 #define MAP_IS_SUB_MAP 0x04 /* has parent */ 224 #define MAP_ASLR 0x08 /* enabled ASLR */ 225 #define MAP_ASLR_IGNSTART 0x10 226 227 #ifdef _KERNEL 228 #if defined(KLD_MODULE) && !defined(KLD_TIED) 229 #define vm_map_max(map) vm_map_max_KBI((map)) 230 #define vm_map_min(map) vm_map_min_KBI((map)) 231 #define vm_map_pmap(map) vm_map_pmap_KBI((map)) 232 #define vm_map_range_valid(map, start, end) \ 233 vm_map_range_valid_KBI((map), (start), (end)) 234 #else 235 static __inline vm_offset_t 236 vm_map_max(const struct vm_map *map) 237 { 238 239 return (map->header.start); 240 } 241 242 static __inline vm_offset_t 243 vm_map_min(const struct vm_map *map) 244 { 245 246 return (map->header.end); 247 } 248 249 static __inline pmap_t 250 vm_map_pmap(vm_map_t map) 251 { 252 return (map->pmap); 253 } 254 255 static __inline void 256 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear) 257 { 258 map->flags = (map->flags | set) & ~clear; 259 } 260 261 static inline bool 262 vm_map_range_valid(vm_map_t map, vm_offset_t start, vm_offset_t end) 263 { 264 if (end < start) 265 return (false); 266 if (start < vm_map_min(map) || end > vm_map_max(map)) 267 return (false); 268 return (true); 269 } 270 271 #endif /* KLD_MODULE */ 272 #endif /* _KERNEL */ 273 274 /* 275 * Shareable process virtual address space. 276 * 277 * List of locks 278 * (c) const until freed 279 */ 280 struct vmspace { 281 struct vm_map vm_map; /* VM address map */ 282 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */ 283 segsz_t vm_swrss; /* resident set size before last swap */ 284 segsz_t vm_tsize; /* text size (pages) XXX */ 285 segsz_t vm_dsize; /* data size (pages) XXX */ 286 segsz_t vm_ssize; /* stack size (pages) */ 287 caddr_t vm_taddr; /* (c) user virtual address of text */ 288 caddr_t vm_daddr; /* (c) user virtual address of data */ 289 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 290 volatile int vm_refcnt; /* number of references */ 291 /* 292 * Keep the PMAP last, so that CPU-specific variations of that 293 * structure on a single architecture don't result in offset 294 * variations of the machine-independent fields in the vmspace. 295 */ 296 struct pmap vm_pmap; /* private physical map */ 297 }; 298 299 #ifdef _KERNEL 300 static __inline pmap_t 301 vmspace_pmap(struct vmspace *vmspace) 302 { 303 return &vmspace->vm_pmap; 304 } 305 #endif /* _KERNEL */ 306 307 #ifdef _KERNEL 308 /* 309 * Macros: vm_map_lock, etc. 310 * Function: 311 * Perform locking on the data portion of a map. Note that 312 * these macros mimic procedure calls returning void. The 313 * semicolon is supplied by the user of these macros, not 314 * by the macros themselves. The macros can safely be used 315 * as unbraced elements in a higher level statement. 316 */ 317 318 void _vm_map_lock(vm_map_t map, const char *file, int line); 319 void _vm_map_unlock(vm_map_t map, const char *file, int line); 320 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line); 321 void _vm_map_lock_read(vm_map_t map, const char *file, int line); 322 void _vm_map_unlock_read(vm_map_t map, const char *file, int line); 323 int _vm_map_trylock(vm_map_t map, const char *file, int line); 324 int _vm_map_trylock_read(vm_map_t map, const char *file, int line); 325 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line); 326 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line); 327 int vm_map_locked(vm_map_t map); 328 void vm_map_wakeup(vm_map_t map); 329 void vm_map_busy(vm_map_t map); 330 void vm_map_unbusy(vm_map_t map); 331 void vm_map_wait_busy(vm_map_t map); 332 vm_offset_t vm_map_max_KBI(const struct vm_map *map); 333 vm_offset_t vm_map_min_KBI(const struct vm_map *map); 334 pmap_t vm_map_pmap_KBI(vm_map_t map); 335 bool vm_map_range_valid_KBI(vm_map_t map, vm_offset_t start, vm_offset_t end); 336 337 #define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE) 338 #define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE) 339 #define vm_map_unlock_and_wait(map, timo) \ 340 _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE) 341 #define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE) 342 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE) 343 #define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE) 344 #define vm_map_trylock_read(map) \ 345 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE) 346 #define vm_map_lock_upgrade(map) \ 347 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE) 348 #define vm_map_lock_downgrade(map) \ 349 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE) 350 351 long vmspace_resident_count(struct vmspace *vmspace); 352 #endif /* _KERNEL */ 353 354 355 /* XXX: number of kernel maps to statically allocate */ 356 #define MAX_KMAP 10 357 358 /* 359 * Copy-on-write flags for vm_map operations 360 */ 361 #define MAP_INHERIT_SHARE 0x00000001 362 #define MAP_COPY_ON_WRITE 0x00000002 363 #define MAP_NOFAULT 0x00000004 364 #define MAP_PREFAULT 0x00000008 365 #define MAP_PREFAULT_PARTIAL 0x00000010 366 #define MAP_DISABLE_SYNCER 0x00000020 367 #define MAP_CHECK_EXCL 0x00000040 368 #define MAP_CREATE_GUARD 0x00000080 369 #define MAP_DISABLE_COREDUMP 0x00000100 370 #define MAP_PREFAULT_MADVISE 0x00000200 /* from (user) madvise request */ 371 #define MAP_WRITECOUNT 0x00000400 372 #define MAP_REMAP 0x00000800 373 #define MAP_STACK_GROWS_DOWN 0x00001000 374 #define MAP_STACK_GROWS_UP 0x00002000 375 #define MAP_ACC_CHARGED 0x00004000 376 #define MAP_ACC_NO_CHARGE 0x00008000 377 #define MAP_CREATE_STACK_GAP_UP 0x00010000 378 #define MAP_CREATE_STACK_GAP_DN 0x00020000 379 #define MAP_VN_EXEC 0x00040000 380 381 /* 382 * vm_fault option flags 383 */ 384 #define VM_FAULT_NORMAL 0 /* Nothing special */ 385 #define VM_FAULT_WIRE 1 /* Wire the mapped page */ 386 #define VM_FAULT_DIRTY 2 /* Dirty the page; use w/VM_PROT_COPY */ 387 388 /* 389 * Initially, mappings are slightly sequential. The maximum window size must 390 * account for the map entry's "read_ahead" field being defined as an uint8_t. 391 */ 392 #define VM_FAULT_READ_AHEAD_MIN 7 393 #define VM_FAULT_READ_AHEAD_INIT 15 394 #define VM_FAULT_READ_AHEAD_MAX min(atop(MAXPHYS) - 1, UINT8_MAX) 395 396 /* 397 * The following "find_space" options are supported by vm_map_find(). 398 * 399 * For VMFS_ALIGNED_SPACE, the desired alignment is specified to 400 * the macro argument as log base 2 of the desired alignment. 401 */ 402 #define VMFS_NO_SPACE 0 /* don't find; use the given range */ 403 #define VMFS_ANY_SPACE 1 /* find a range with any alignment */ 404 #define VMFS_OPTIMAL_SPACE 2 /* find a range with optimal alignment*/ 405 #define VMFS_SUPER_SPACE 3 /* find a superpage-aligned range */ 406 #define VMFS_ALIGNED_SPACE(x) ((x) << 8) /* find a range with fixed alignment */ 407 408 /* 409 * vm_map_wire and vm_map_unwire option flags 410 */ 411 #define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */ 412 #define VM_MAP_WIRE_USER 1 /* wiring in a user map */ 413 414 #define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */ 415 #define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */ 416 417 #define VM_MAP_WIRE_WRITE 4 /* Validate writable. */ 418 419 typedef int vm_map_entry_reader(void *token, vm_map_entry_t addr, 420 vm_map_entry_t dest); 421 422 #ifndef _KERNEL 423 /* 424 * Find the successor of a map_entry, using a reader to dereference pointers. 425 * '*clone' is a copy of a vm_map entry. 'reader' is used to copy a map entry 426 * at some address into '*clone'. Change *clone to a copy of the next map 427 * entry, and return the address of that entry, or NULL if copying has failed. 428 * 429 * This function is made available to user-space code that needs to traverse 430 * map entries. 431 */ 432 static inline vm_map_entry_t 433 vm_map_entry_read_succ(void *token, struct vm_map_entry *const clone, 434 vm_map_entry_reader reader) 435 { 436 vm_map_entry_t after, backup; 437 vm_offset_t start; 438 439 after = clone->right; 440 start = clone->start; 441 if (!reader(token, after, clone)) 442 return (NULL); 443 backup = clone->left; 444 if (!reader(token, backup, clone)) 445 return (NULL); 446 if (clone->start > start) { 447 do { 448 after = backup; 449 backup = clone->left; 450 if (!reader(token, backup, clone)) 451 return (NULL); 452 } while (clone->start != start); 453 } 454 if (!reader(token, after, clone)) 455 return (NULL); 456 return (after); 457 } 458 #endif /* ! _KERNEL */ 459 460 #ifdef _KERNEL 461 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t); 462 vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t); 463 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t); 464 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, 465 vm_offset_t, int, vm_prot_t, vm_prot_t, int); 466 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, 467 vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int); 468 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t, 469 vm_prot_t, vm_prot_t, int); 470 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t); 471 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t); 472 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t); 473 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); 474 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 475 vm_pindex_t *, vm_prot_t *, boolean_t *); 476 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 477 vm_pindex_t *, vm_prot_t *, boolean_t *); 478 void vm_map_lookup_done (vm_map_t, vm_map_entry_t); 479 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *); 480 481 static inline vm_map_entry_t 482 vm_map_entry_first(vm_map_t map) 483 { 484 485 return (map->header.right); 486 } 487 488 static inline vm_map_entry_t 489 vm_map_entry_succ(vm_map_entry_t entry) 490 { 491 vm_map_entry_t after; 492 493 after = entry->right; 494 if (after->left->start > entry->start) { 495 do 496 after = after->left; 497 while (after->left != entry); 498 } 499 return (after); 500 } 501 502 #define VM_MAP_ENTRY_FOREACH(it, map) \ 503 for ((it) = vm_map_entry_first(map); \ 504 (it) != &(map)->header; \ 505 (it) = vm_map_entry_succ(it)) 506 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t); 507 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t); 508 void vm_map_try_merge_entries(vm_map_t map, vm_map_entry_t prev, 509 vm_map_entry_t entry); 510 void vm_map_startup (void); 511 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t); 512 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t); 513 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int); 514 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int); 515 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end, 516 int flags); 517 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, int flags); 518 int vm_map_wire_locked(vm_map_t map, vm_offset_t start, vm_offset_t end, 519 int flags); 520 long vmspace_swap_count(struct vmspace *vmspace); 521 void vm_map_entry_set_vnode_text(vm_map_entry_t entry, bool add); 522 #endif /* _KERNEL */ 523 #endif /* _VM_MAP_ */ 524