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 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * from: @(#)vm_page.h 8.2 (Berkeley) 12/13/93 33 * 34 * 35 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 36 * All rights reserved. 37 * 38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 39 * 40 * Permission to use, copy, modify and distribute this software and 41 * its documentation is hereby granted, provided that both the copyright 42 * notice and this permission notice appear in all copies of the 43 * software, derivative works or modified versions, and any portions 44 * thereof, and that both notices appear in supporting documentation. 45 * 46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 49 * 50 * Carnegie Mellon requests users of this software to return to 51 * 52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 53 * School of Computer Science 54 * Carnegie Mellon University 55 * Pittsburgh PA 15213-3890 56 * 57 * any improvements or extensions that they make and grant Carnegie the 58 * rights to redistribute these changes. 59 * 60 * $FreeBSD$ 61 */ 62 63 /* 64 * Resident memory system definitions. 65 */ 66 67 #ifndef _VM_PAGE_ 68 #define _VM_PAGE_ 69 70 #include <vm/pmap.h> 71 72 /* 73 * Management of resident (logical) pages. 74 * 75 * A small structure is kept for each resident 76 * page, indexed by page number. Each structure 77 * is an element of several collections: 78 * 79 * A radix tree used to quickly 80 * perform object/offset lookups 81 * 82 * A list of all pages for a given object, 83 * so they can be quickly deactivated at 84 * time of deallocation. 85 * 86 * An ordered list of pages due for pageout. 87 * 88 * In addition, the structure contains the object 89 * and offset to which this page belongs (for pageout), 90 * and sundry status bits. 91 * 92 * In general, operations on this structure's mutable fields are 93 * synchronized using either one of or a combination of the lock on the 94 * object that the page belongs to (O), the pool lock for the page (P), 95 * or the lock for either the free or paging queue (Q). If a field is 96 * annotated below with two of these locks, then holding either lock is 97 * sufficient for read access, but both locks are required for write 98 * access. 99 * 100 * In contrast, the synchronization of accesses to the page's 101 * dirty field is machine dependent (M). In the 102 * machine-independent layer, the lock on the object that the 103 * page belongs to must be held in order to operate on the field. 104 * However, the pmap layer is permitted to set all bits within 105 * the field without holding that lock. If the underlying 106 * architecture does not support atomic read-modify-write 107 * operations on the field's type, then the machine-independent 108 * layer uses a 32-bit atomic on the aligned 32-bit word that 109 * contains the dirty field. In the machine-independent layer, 110 * the implementation of read-modify-write operations on the 111 * field is encapsulated in vm_page_clear_dirty_mask(). 112 */ 113 114 #if PAGE_SIZE == 4096 115 #define VM_PAGE_BITS_ALL 0xffu 116 typedef uint8_t vm_page_bits_t; 117 #elif PAGE_SIZE == 8192 118 #define VM_PAGE_BITS_ALL 0xffffu 119 typedef uint16_t vm_page_bits_t; 120 #elif PAGE_SIZE == 16384 121 #define VM_PAGE_BITS_ALL 0xffffffffu 122 typedef uint32_t vm_page_bits_t; 123 #elif PAGE_SIZE == 32768 124 #define VM_PAGE_BITS_ALL 0xfffffffffffffffflu 125 typedef uint64_t vm_page_bits_t; 126 #endif 127 128 struct vm_page { 129 union { 130 TAILQ_ENTRY(vm_page) q; /* page queue or free list (Q) */ 131 struct { 132 SLIST_ENTRY(vm_page) ss; /* private slists */ 133 void *pv; 134 } s; 135 struct { 136 u_long p; 137 u_long v; 138 } memguard; 139 } plinks; 140 TAILQ_ENTRY(vm_page) listq; /* pages in same object (O) */ 141 vm_object_t object; /* which object am I in (O,P) */ 142 vm_pindex_t pindex; /* offset into object (O,P) */ 143 vm_paddr_t phys_addr; /* physical address of page */ 144 struct md_page md; /* machine dependant stuff */ 145 u_int wire_count; /* wired down maps refs (P) */ 146 volatile u_int busy_lock; /* busy owners lock */ 147 uint16_t hold_count; /* page hold count (P) */ 148 uint16_t flags; /* page PG_* flags (P) */ 149 uint8_t aflags; /* access is atomic */ 150 uint8_t oflags; /* page VPO_* flags (O) */ 151 uint8_t queue; /* page queue index (P,Q) */ 152 int8_t psind; /* pagesizes[] index (O) */ 153 int8_t segind; 154 uint8_t order; /* index of the buddy queue */ 155 uint8_t pool; 156 u_char act_count; /* page usage count (P) */ 157 /* NOTE that these must support one bit per DEV_BSIZE in a page */ 158 /* so, on normal X86 kernels, they must be at least 8 bits wide */ 159 vm_page_bits_t valid; /* map of valid DEV_BSIZE chunks (O) */ 160 vm_page_bits_t dirty; /* map of dirty DEV_BSIZE chunks (M) */ 161 }; 162 163 /* 164 * Page flags stored in oflags: 165 * 166 * Access to these page flags is synchronized by the lock on the object 167 * containing the page (O). 168 * 169 * Note: VPO_UNMANAGED (used by OBJT_DEVICE, OBJT_PHYS and OBJT_SG) 170 * indicates that the page is not under PV management but 171 * otherwise should be treated as a normal page. Pages not 172 * under PV management cannot be paged out via the 173 * object/vm_page_t because there is no knowledge of their pte 174 * mappings, and such pages are also not on any PQ queue. 175 * 176 */ 177 #define VPO_UNUSED01 0x01 /* --available-- */ 178 #define VPO_SWAPSLEEP 0x02 /* waiting for swap to finish */ 179 #define VPO_UNMANAGED 0x04 /* no PV management for page */ 180 #define VPO_SWAPINPROG 0x08 /* swap I/O in progress on page */ 181 #define VPO_NOSYNC 0x10 /* do not collect for syncer */ 182 183 /* 184 * Busy page implementation details. 185 * The algorithm is taken mostly by rwlock(9) and sx(9) locks implementation, 186 * even if the support for owner identity is removed because of size 187 * constraints. Checks on lock recursion are then not possible, while the 188 * lock assertions effectiveness is someway reduced. 189 */ 190 #define VPB_BIT_SHARED 0x01 191 #define VPB_BIT_EXCLUSIVE 0x02 192 #define VPB_BIT_WAITERS 0x04 193 #define VPB_BIT_FLAGMASK \ 194 (VPB_BIT_SHARED | VPB_BIT_EXCLUSIVE | VPB_BIT_WAITERS) 195 196 #define VPB_SHARERS_SHIFT 3 197 #define VPB_SHARERS(x) \ 198 (((x) & ~VPB_BIT_FLAGMASK) >> VPB_SHARERS_SHIFT) 199 #define VPB_SHARERS_WORD(x) ((x) << VPB_SHARERS_SHIFT | VPB_BIT_SHARED) 200 #define VPB_ONE_SHARER (1 << VPB_SHARERS_SHIFT) 201 202 #define VPB_SINGLE_EXCLUSIVER VPB_BIT_EXCLUSIVE 203 204 #define VPB_UNBUSIED VPB_SHARERS_WORD(0) 205 206 #define PQ_NONE 255 207 #define PQ_INACTIVE 0 208 #define PQ_ACTIVE 1 209 #define PQ_COUNT 2 210 211 TAILQ_HEAD(pglist, vm_page); 212 SLIST_HEAD(spglist, vm_page); 213 214 struct vm_pagequeue { 215 struct mtx pq_mutex; 216 struct pglist pq_pl; 217 int pq_cnt; 218 int * const pq_vcnt; 219 const char * const pq_name; 220 } __aligned(CACHE_LINE_SIZE); 221 222 223 struct vm_domain { 224 struct vm_pagequeue vmd_pagequeues[PQ_COUNT]; 225 u_int vmd_page_count; 226 u_int vmd_free_count; 227 long vmd_segs; /* bitmask of the segments */ 228 boolean_t vmd_oom; 229 int vmd_pass; /* local pagedaemon pass */ 230 int vmd_last_active_scan; 231 struct vm_page vmd_marker; /* marker for pagedaemon private use */ 232 }; 233 234 extern struct vm_domain vm_dom[MAXMEMDOM]; 235 236 #define vm_pagequeue_assert_locked(pq) mtx_assert(&(pq)->pq_mutex, MA_OWNED) 237 #define vm_pagequeue_lock(pq) mtx_lock(&(pq)->pq_mutex) 238 #define vm_pagequeue_unlock(pq) mtx_unlock(&(pq)->pq_mutex) 239 240 #ifdef _KERNEL 241 static __inline void 242 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend) 243 { 244 245 #ifdef notyet 246 vm_pagequeue_assert_locked(pq); 247 #endif 248 pq->pq_cnt += addend; 249 atomic_add_int(pq->pq_vcnt, addend); 250 } 251 #define vm_pagequeue_cnt_inc(pq) vm_pagequeue_cnt_add((pq), 1) 252 #define vm_pagequeue_cnt_dec(pq) vm_pagequeue_cnt_add((pq), -1) 253 #endif /* _KERNEL */ 254 255 extern struct mtx_padalign vm_page_queue_free_mtx; 256 extern struct mtx_padalign pa_lock[]; 257 258 #if defined(__arm__) 259 #define PDRSHIFT PDR_SHIFT 260 #elif !defined(PDRSHIFT) 261 #define PDRSHIFT 21 262 #endif 263 264 #define pa_index(pa) ((pa) >> PDRSHIFT) 265 #define PA_LOCKPTR(pa) ((struct mtx *)(&pa_lock[pa_index(pa) % PA_LOCK_COUNT])) 266 #define PA_LOCKOBJPTR(pa) ((struct lock_object *)PA_LOCKPTR((pa))) 267 #define PA_LOCK(pa) mtx_lock(PA_LOCKPTR(pa)) 268 #define PA_TRYLOCK(pa) mtx_trylock(PA_LOCKPTR(pa)) 269 #define PA_UNLOCK(pa) mtx_unlock(PA_LOCKPTR(pa)) 270 #define PA_UNLOCK_COND(pa) \ 271 do { \ 272 if ((pa) != 0) { \ 273 PA_UNLOCK((pa)); \ 274 (pa) = 0; \ 275 } \ 276 } while (0) 277 278 #define PA_LOCK_ASSERT(pa, a) mtx_assert(PA_LOCKPTR(pa), (a)) 279 280 #ifdef KLD_MODULE 281 #define vm_page_lock(m) vm_page_lock_KBI((m), LOCK_FILE, LOCK_LINE) 282 #define vm_page_unlock(m) vm_page_unlock_KBI((m), LOCK_FILE, LOCK_LINE) 283 #define vm_page_trylock(m) vm_page_trylock_KBI((m), LOCK_FILE, LOCK_LINE) 284 #else /* !KLD_MODULE */ 285 #define vm_page_lockptr(m) (PA_LOCKPTR(VM_PAGE_TO_PHYS((m)))) 286 #define vm_page_lock(m) mtx_lock(vm_page_lockptr((m))) 287 #define vm_page_unlock(m) mtx_unlock(vm_page_lockptr((m))) 288 #define vm_page_trylock(m) mtx_trylock(vm_page_lockptr((m))) 289 #endif 290 #if defined(INVARIANTS) 291 #define vm_page_assert_locked(m) \ 292 vm_page_assert_locked_KBI((m), __FILE__, __LINE__) 293 #define vm_page_lock_assert(m, a) \ 294 vm_page_lock_assert_KBI((m), (a), __FILE__, __LINE__) 295 #else 296 #define vm_page_assert_locked(m) 297 #define vm_page_lock_assert(m, a) 298 #endif 299 300 /* 301 * The vm_page's aflags are updated using atomic operations. To set or clear 302 * these flags, the functions vm_page_aflag_set() and vm_page_aflag_clear() 303 * must be used. Neither these flags nor these functions are part of the KBI. 304 * 305 * PGA_REFERENCED may be cleared only if the page is locked. It is set by 306 * both the MI and MD VM layers. However, kernel loadable modules should not 307 * directly set this flag. They should call vm_page_reference() instead. 308 * 309 * PGA_WRITEABLE is set exclusively on managed pages by pmap_enter(). 310 * When it does so, the object must be locked, or the page must be 311 * exclusive busied. The MI VM layer must never access this flag 312 * directly. Instead, it should call pmap_page_is_write_mapped(). 313 * 314 * PGA_EXECUTABLE may be set by pmap routines, and indicates that a page has 315 * at least one executable mapping. It is not consumed by the MI VM layer. 316 */ 317 #define PGA_WRITEABLE 0x01 /* page may be mapped writeable */ 318 #define PGA_REFERENCED 0x02 /* page has been referenced */ 319 #define PGA_EXECUTABLE 0x04 /* page may be mapped executable */ 320 321 /* 322 * Page flags. If changed at any other time than page allocation or 323 * freeing, the modification must be protected by the vm_page lock. 324 */ 325 #define PG_CACHED 0x0001 /* page is cached */ 326 #define PG_FICTITIOUS 0x0004 /* physical page doesn't exist */ 327 #define PG_ZERO 0x0008 /* page is zeroed */ 328 #define PG_MARKER 0x0010 /* special queue marker page */ 329 #define PG_WINATCFLS 0x0040 /* flush dirty page on inactive q */ 330 #define PG_NODUMP 0x0080 /* don't include this page in a dump */ 331 #define PG_UNHOLDFREE 0x0100 /* delayed free of a held page */ 332 333 /* 334 * Misc constants. 335 */ 336 #define ACT_DECLINE 1 337 #define ACT_ADVANCE 3 338 #define ACT_INIT 5 339 #define ACT_MAX 64 340 341 #ifdef _KERNEL 342 343 #include <sys/systm.h> 344 345 #include <machine/atomic.h> 346 347 /* 348 * Each pageable resident page falls into one of four lists: 349 * 350 * free 351 * Available for allocation now. 352 * 353 * cache 354 * Almost available for allocation. Still associated with 355 * an object, but clean and immediately freeable. 356 * 357 * The following lists are LRU sorted: 358 * 359 * inactive 360 * Low activity, candidates for reclamation. 361 * This is the list of pages that should be 362 * paged out next. 363 * 364 * active 365 * Pages that are "active" i.e. they have been 366 * recently referenced. 367 * 368 */ 369 370 extern int vm_page_zero_count; 371 372 extern vm_page_t vm_page_array; /* First resident page in table */ 373 extern long vm_page_array_size; /* number of vm_page_t's */ 374 extern long first_page; /* first physical page number */ 375 376 #define VM_PAGE_TO_PHYS(entry) ((entry)->phys_addr) 377 378 /* 379 * PHYS_TO_VM_PAGE() returns the vm_page_t object that represents a memory 380 * page to which the given physical address belongs. The correct vm_page_t 381 * object is returned for addresses that are not page-aligned. 382 */ 383 vm_page_t PHYS_TO_VM_PAGE(vm_paddr_t pa); 384 385 /* 386 * Page allocation parameters for vm_page for the functions 387 * vm_page_alloc(), vm_page_grab(), vm_page_alloc_contig() and 388 * vm_page_alloc_freelist(). Some functions support only a subset 389 * of the flags, and ignore others, see the flags legend. 390 * 391 * Bits 0 - 1 define class. 392 * Bits 2 - 15 dedicated for flags. 393 * Legend: 394 * (a) - vm_page_alloc() supports the flag. 395 * (c) - vm_page_alloc_contig() supports the flag. 396 * (f) - vm_page_alloc_freelist() supports the flag. 397 * (g) - vm_page_grab() supports the flag. 398 * Bits above 15 define the count of additional pages that the caller 399 * intends to allocate. 400 */ 401 #define VM_ALLOC_NORMAL 0 402 #define VM_ALLOC_INTERRUPT 1 403 #define VM_ALLOC_SYSTEM 2 404 #define VM_ALLOC_CLASS_MASK 3 405 #define VM_ALLOC_WIRED 0x0020 /* (acfg) Allocate non pageable page */ 406 #define VM_ALLOC_ZERO 0x0040 /* (acfg) Try to obtain a zeroed page */ 407 #define VM_ALLOC_NOOBJ 0x0100 /* (acg) No associated object */ 408 #define VM_ALLOC_NOBUSY 0x0200 /* (acg) Do not busy the page */ 409 #define VM_ALLOC_IFCACHED 0x0400 /* (ag) Fail if page is not cached */ 410 #define VM_ALLOC_IFNOTCACHED 0x0800 /* (ag) Fail if page is cached */ 411 #define VM_ALLOC_IGN_SBUSY 0x1000 /* (g) Ignore shared busy flag */ 412 #define VM_ALLOC_NODUMP 0x2000 /* (ag) don't include in dump */ 413 #define VM_ALLOC_SBUSY 0x4000 /* (acg) Shared busy the page */ 414 #define VM_ALLOC_NOWAIT 0x8000 /* (g) Do not sleep, return NULL */ 415 #define VM_ALLOC_COUNT_SHIFT 16 416 #define VM_ALLOC_COUNT(count) ((count) << VM_ALLOC_COUNT_SHIFT) 417 418 #ifdef M_NOWAIT 419 static inline int 420 malloc2vm_flags(int malloc_flags) 421 { 422 int pflags; 423 424 KASSERT((malloc_flags & M_USE_RESERVE) == 0 || 425 (malloc_flags & M_NOWAIT) != 0, 426 ("M_USE_RESERVE requires M_NOWAIT")); 427 pflags = (malloc_flags & M_USE_RESERVE) != 0 ? VM_ALLOC_INTERRUPT : 428 VM_ALLOC_SYSTEM; 429 if ((malloc_flags & M_ZERO) != 0) 430 pflags |= VM_ALLOC_ZERO; 431 if ((malloc_flags & M_NODUMP) != 0) 432 pflags |= VM_ALLOC_NODUMP; 433 return (pflags); 434 } 435 #endif 436 437 void vm_page_busy_downgrade(vm_page_t m); 438 void vm_page_busy_sleep(vm_page_t m, const char *msg); 439 void vm_page_flash(vm_page_t m); 440 void vm_page_hold(vm_page_t mem); 441 void vm_page_unhold(vm_page_t mem); 442 void vm_page_free(vm_page_t m); 443 void vm_page_free_zero(vm_page_t m); 444 445 void vm_page_activate (vm_page_t); 446 void vm_page_advise(vm_page_t m, int advice); 447 vm_page_t vm_page_alloc (vm_object_t, vm_pindex_t, int); 448 vm_page_t vm_page_alloc_contig(vm_object_t object, vm_pindex_t pindex, int req, 449 u_long npages, vm_paddr_t low, vm_paddr_t high, u_long alignment, 450 vm_paddr_t boundary, vm_memattr_t memattr); 451 vm_page_t vm_page_alloc_freelist(int, int); 452 vm_page_t vm_page_grab (vm_object_t, vm_pindex_t, int); 453 void vm_page_cache(vm_page_t); 454 void vm_page_cache_free(vm_object_t, vm_pindex_t, vm_pindex_t); 455 void vm_page_cache_transfer(vm_object_t, vm_pindex_t, vm_object_t); 456 int vm_page_try_to_cache (vm_page_t); 457 int vm_page_try_to_free (vm_page_t); 458 void vm_page_deactivate (vm_page_t); 459 void vm_page_deactivate_noreuse(vm_page_t); 460 void vm_page_dequeue(vm_page_t m); 461 void vm_page_dequeue_locked(vm_page_t m); 462 vm_page_t vm_page_find_least(vm_object_t, vm_pindex_t); 463 vm_page_t vm_page_getfake(vm_paddr_t paddr, vm_memattr_t memattr); 464 void vm_page_initfake(vm_page_t m, vm_paddr_t paddr, vm_memattr_t memattr); 465 int vm_page_insert (vm_page_t, vm_object_t, vm_pindex_t); 466 boolean_t vm_page_is_cached(vm_object_t object, vm_pindex_t pindex); 467 vm_page_t vm_page_lookup (vm_object_t, vm_pindex_t); 468 vm_page_t vm_page_next(vm_page_t m); 469 int vm_page_pa_tryrelock(pmap_t, vm_paddr_t, vm_paddr_t *); 470 struct vm_pagequeue *vm_page_pagequeue(vm_page_t m); 471 vm_page_t vm_page_prev(vm_page_t m); 472 boolean_t vm_page_ps_is_valid(vm_page_t m); 473 void vm_page_putfake(vm_page_t m); 474 void vm_page_readahead_finish(vm_page_t m); 475 void vm_page_reference(vm_page_t m); 476 void vm_page_remove (vm_page_t); 477 int vm_page_rename (vm_page_t, vm_object_t, vm_pindex_t); 478 vm_page_t vm_page_replace(vm_page_t mnew, vm_object_t object, 479 vm_pindex_t pindex); 480 void vm_page_requeue(vm_page_t m); 481 void vm_page_requeue_locked(vm_page_t m); 482 int vm_page_sbusied(vm_page_t m); 483 void vm_page_set_valid_range(vm_page_t m, int base, int size); 484 int vm_page_sleep_if_busy(vm_page_t m, const char *msg); 485 vm_offset_t vm_page_startup(vm_offset_t vaddr); 486 void vm_page_sunbusy(vm_page_t m); 487 int vm_page_trysbusy(vm_page_t m); 488 void vm_page_unhold_pages(vm_page_t *ma, int count); 489 boolean_t vm_page_unwire(vm_page_t m, uint8_t queue); 490 void vm_page_updatefake(vm_page_t m, vm_paddr_t paddr, vm_memattr_t memattr); 491 void vm_page_wire (vm_page_t); 492 void vm_page_xunbusy_hard(vm_page_t m); 493 void vm_page_set_validclean (vm_page_t, int, int); 494 void vm_page_clear_dirty (vm_page_t, int, int); 495 void vm_page_set_invalid (vm_page_t, int, int); 496 int vm_page_is_valid (vm_page_t, int, int); 497 void vm_page_test_dirty (vm_page_t); 498 vm_page_bits_t vm_page_bits(int base, int size); 499 void vm_page_zero_invalid(vm_page_t m, boolean_t setvalid); 500 void vm_page_free_toq(vm_page_t m); 501 void vm_page_zero_idle_wakeup(void); 502 503 void vm_page_dirty_KBI(vm_page_t m); 504 void vm_page_lock_KBI(vm_page_t m, const char *file, int line); 505 void vm_page_unlock_KBI(vm_page_t m, const char *file, int line); 506 int vm_page_trylock_KBI(vm_page_t m, const char *file, int line); 507 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT) 508 void vm_page_assert_locked_KBI(vm_page_t m, const char *file, int line); 509 void vm_page_lock_assert_KBI(vm_page_t m, int a, const char *file, int line); 510 #endif 511 512 #define vm_page_assert_sbusied(m) \ 513 KASSERT(vm_page_sbusied(m), \ 514 ("vm_page_assert_sbusied: page %p not shared busy @ %s:%d", \ 515 (void *)m, __FILE__, __LINE__)); 516 517 #define vm_page_assert_unbusied(m) \ 518 KASSERT(!vm_page_busied(m), \ 519 ("vm_page_assert_unbusied: page %p busy @ %s:%d", \ 520 (void *)m, __FILE__, __LINE__)); 521 522 #define vm_page_assert_xbusied(m) \ 523 KASSERT(vm_page_xbusied(m), \ 524 ("vm_page_assert_xbusied: page %p not exclusive busy @ %s:%d", \ 525 (void *)m, __FILE__, __LINE__)); 526 527 #define vm_page_busied(m) \ 528 ((m)->busy_lock != VPB_UNBUSIED) 529 530 #define vm_page_sbusy(m) do { \ 531 if (!vm_page_trysbusy(m)) \ 532 panic("%s: page %p failed shared busing", __func__, m); \ 533 } while (0) 534 535 #define vm_page_tryxbusy(m) \ 536 (atomic_cmpset_acq_int(&m->busy_lock, VPB_UNBUSIED, \ 537 VPB_SINGLE_EXCLUSIVER)) 538 539 #define vm_page_xbusied(m) \ 540 ((m->busy_lock & VPB_SINGLE_EXCLUSIVER) != 0) 541 542 #define vm_page_xbusy(m) do { \ 543 if (!vm_page_tryxbusy(m)) \ 544 panic("%s: page %p failed exclusive busing", __func__, \ 545 m); \ 546 } while (0) 547 548 #define vm_page_xunbusy(m) do { \ 549 if (!atomic_cmpset_rel_int(&(m)->busy_lock, \ 550 VPB_SINGLE_EXCLUSIVER, VPB_UNBUSIED)) \ 551 vm_page_xunbusy_hard(m); \ 552 } while (0) 553 554 #ifdef INVARIANTS 555 void vm_page_object_lock_assert(vm_page_t m); 556 #define VM_PAGE_OBJECT_LOCK_ASSERT(m) vm_page_object_lock_assert(m) 557 void vm_page_assert_pga_writeable(vm_page_t m, uint8_t bits); 558 #define VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits) \ 559 vm_page_assert_pga_writeable(m, bits) 560 #else 561 #define VM_PAGE_OBJECT_LOCK_ASSERT(m) (void)0 562 #define VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits) (void)0 563 #endif 564 565 /* 566 * We want to use atomic updates for the aflags field, which is 8 bits wide. 567 * However, not all architectures support atomic operations on 8-bit 568 * destinations. In order that we can easily use a 32-bit operation, we 569 * require that the aflags field be 32-bit aligned. 570 */ 571 CTASSERT(offsetof(struct vm_page, aflags) % sizeof(uint32_t) == 0); 572 573 /* 574 * Clear the given bits in the specified page. 575 */ 576 static inline void 577 vm_page_aflag_clear(vm_page_t m, uint8_t bits) 578 { 579 uint32_t *addr, val; 580 581 /* 582 * The PGA_REFERENCED flag can only be cleared if the page is locked. 583 */ 584 if ((bits & PGA_REFERENCED) != 0) 585 vm_page_assert_locked(m); 586 587 /* 588 * Access the whole 32-bit word containing the aflags field with an 589 * atomic update. Parallel non-atomic updates to the other fields 590 * within this word are handled properly by the atomic update. 591 */ 592 addr = (void *)&m->aflags; 593 KASSERT(((uintptr_t)addr & (sizeof(uint32_t) - 1)) == 0, 594 ("vm_page_aflag_clear: aflags is misaligned")); 595 val = bits; 596 #if BYTE_ORDER == BIG_ENDIAN 597 val <<= 24; 598 #endif 599 atomic_clear_32(addr, val); 600 } 601 602 /* 603 * Set the given bits in the specified page. 604 */ 605 static inline void 606 vm_page_aflag_set(vm_page_t m, uint8_t bits) 607 { 608 uint32_t *addr, val; 609 610 VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits); 611 612 /* 613 * Access the whole 32-bit word containing the aflags field with an 614 * atomic update. Parallel non-atomic updates to the other fields 615 * within this word are handled properly by the atomic update. 616 */ 617 addr = (void *)&m->aflags; 618 KASSERT(((uintptr_t)addr & (sizeof(uint32_t) - 1)) == 0, 619 ("vm_page_aflag_set: aflags is misaligned")); 620 val = bits; 621 #if BYTE_ORDER == BIG_ENDIAN 622 val <<= 24; 623 #endif 624 atomic_set_32(addr, val); 625 } 626 627 /* 628 * vm_page_dirty: 629 * 630 * Set all bits in the page's dirty field. 631 * 632 * The object containing the specified page must be locked if the 633 * call is made from the machine-independent layer. 634 * 635 * See vm_page_clear_dirty_mask(). 636 */ 637 static __inline void 638 vm_page_dirty(vm_page_t m) 639 { 640 641 /* Use vm_page_dirty_KBI() under INVARIANTS to save memory. */ 642 #if defined(KLD_MODULE) || defined(INVARIANTS) 643 vm_page_dirty_KBI(m); 644 #else 645 m->dirty = VM_PAGE_BITS_ALL; 646 #endif 647 } 648 649 /* 650 * vm_page_remque: 651 * 652 * If the given page is in a page queue, then remove it from that page 653 * queue. 654 * 655 * The page must be locked. 656 */ 657 static inline void 658 vm_page_remque(vm_page_t m) 659 { 660 661 if (m->queue != PQ_NONE) 662 vm_page_dequeue(m); 663 } 664 665 /* 666 * vm_page_undirty: 667 * 668 * Set page to not be dirty. Note: does not clear pmap modify bits 669 */ 670 static __inline void 671 vm_page_undirty(vm_page_t m) 672 { 673 674 VM_PAGE_OBJECT_LOCK_ASSERT(m); 675 m->dirty = 0; 676 } 677 678 #endif /* _KERNEL */ 679 #endif /* !_VM_PAGE_ */ 680