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 * 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 61/* 62 * Virtual memory object module definitions. 63 */ 64 65#ifndef _VM_OBJECT_ 66#define _VM_OBJECT_ 67 68#include <sys/queue.h> 69#include <sys/_blockcount.h> 70#include <sys/_lock.h> 71#include <sys/_mutex.h> 72#include <sys/_pctrie.h> 73#include <sys/_rwlock.h> 74#include <sys/_domainset.h> 75 76#include <vm/_vm_radix.h> 77 78/* 79 * Types defined: 80 * 81 * vm_object_t Virtual memory object. 82 * 83 * List of locks 84 * (a) atomic 85 * (c) const until freed 86 * (o) per-object lock 87 * (f) free pages queue mutex 88 * 89 */ 90 91#ifndef VM_PAGE_HAVE_PGLIST 92TAILQ_HEAD(pglist, vm_page); 93#define VM_PAGE_HAVE_PGLIST 94#endif 95 96struct vm_object { 97 struct rwlock lock; 98 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 99 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 100 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 101 struct pglist memq; /* list of resident pages */ 102 struct vm_radix rtree; /* root of the resident page radix trie*/ 103 vm_pindex_t size; /* Object size */ 104 struct domainset_ref domain; /* NUMA policy. */ 105 volatile int generation; /* generation ID */ 106 int cleangeneration; /* Generation at clean time */ 107 volatile u_int ref_count; /* How many refs?? */ 108 int shadow_count; /* how many objects that this is a shadow for */ 109 vm_memattr_t memattr; /* default memory attribute for pages */ 110 objtype_t type; /* type of pager */ 111 u_short flags; /* see below */ 112 u_short pg_color; /* (c) color of first page in obj */ 113 blockcount_t paging_in_progress; /* (a) Paging (in or out) so don't collapse or destroy */ 114 blockcount_t busy; /* (a) object is busy, disallow page busy. */ 115 int resident_page_count; /* number of resident pages */ 116 struct vm_object *backing_object; /* object that I'm a shadow of */ 117 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 118 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 119 LIST_HEAD(, vm_reserv) rvq; /* list of reservations */ 120 void *handle; 121 union { 122 /* 123 * VNode pager 124 * 125 * vnp_size - current size of file 126 */ 127 struct { 128 off_t vnp_size; 129 vm_ooffset_t writemappings; 130 } vnp; 131 132 /* 133 * Device pager 134 * 135 * devp_pglist - list of allocated pages 136 */ 137 struct { 138 TAILQ_HEAD(, vm_page) devp_pglist; 139 const struct cdev_pager_ops *ops; 140 struct cdev *dev; 141 } devp; 142 143 /* 144 * SG pager 145 * 146 * sgp_pglist - list of allocated pages 147 */ 148 struct { 149 TAILQ_HEAD(, vm_page) sgp_pglist; 150 } sgp; 151 152 /* 153 * Swap pager 154 * 155 * swp_priv - pager-private. 156 * swp_blks - pc-trie of the allocated swap blocks. 157 * writemappings - count of bytes mapped for write 158 * 159 */ 160 struct { 161 void *swp_priv; 162 struct pctrie swp_blks; 163 vm_ooffset_t writemappings; 164 } swp; 165 166 /* 167 * Phys pager 168 */ 169 struct { 170 const struct phys_pager_ops *ops; 171 union { 172 void *data_ptr; 173 uintptr_t data_val; 174 }; 175 } phys; 176 } un_pager; 177 struct ucred *cred; 178 vm_ooffset_t charge; 179 void *umtx_data; 180}; 181 182/* 183 * Flags 184 */ 185#define OBJ_FICTITIOUS 0x0001 /* (c) contains fictitious pages */ 186#define OBJ_UNMANAGED 0x0002 /* (c) contains unmanaged pages */ 187#define OBJ_POPULATE 0x0004 /* pager implements populate() */ 188#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 189#define OBJ_ANON 0x0010 /* (c) contains anonymous memory */ 190#define OBJ_UMTXDEAD 0x0020 /* umtx pshared was terminated */ 191#define OBJ_SIZEVNLOCK 0x0040 /* lock vnode to check obj size */ 192#define OBJ_PG_DTOR 0x0080 /* dont reset object, leave that for dtor */ 193#define OBJ_SHADOWLIST 0x0100 /* Object is on the shadow list. */ 194#define OBJ_SWAP 0x0200 /* object swaps, type will be OBJT_SWAP 195 or dynamically registered */ 196#define OBJ_SPLIT 0x0400 /* object is being split */ 197#define OBJ_COLLAPSING 0x0800 /* Parent of collapse. */ 198#define OBJ_COLORED 0x1000 /* pg_color is defined */ 199#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 200#define OBJ_PAGERPRIV1 0x4000 /* Pager private */ 201#define OBJ_PAGERPRIV2 0x8000 /* Pager private */ 202 203/* 204 * Helpers to perform conversion between vm_object page indexes and offsets. 205 * IDX_TO_OFF() converts an index into an offset. 206 * OFF_TO_IDX() converts an offset into an index. 207 * OBJ_MAX_SIZE specifies the maximum page index corresponding to the 208 * maximum unsigned offset. 209 */ 210#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 211#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 212#define OBJ_MAX_SIZE (OFF_TO_IDX(UINT64_MAX) + 1) 213 214#ifdef _KERNEL 215 216#define OBJPC_SYNC 0x1 /* sync I/O */ 217#define OBJPC_INVAL 0x2 /* invalidate */ 218#define OBJPC_NOSYNC 0x4 /* skip if PGA_NOSYNC */ 219 220/* 221 * The following options are supported by vm_object_page_remove(). 222 */ 223#define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */ 224#define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */ 225#define OBJPR_VALIDONLY 0x4 /* Ignore invalid pages. */ 226 227TAILQ_HEAD(object_q, vm_object); 228 229extern struct object_q vm_object_list; /* list of allocated objects */ 230extern struct mtx vm_object_list_mtx; /* lock for object list and count */ 231 232extern struct vm_object kernel_object_store; 233 234/* kernel and kmem are aliased for backwards KPI compat. */ 235#define kernel_object (&kernel_object_store) 236#define kmem_object (&kernel_object_store) 237 238#define VM_OBJECT_ASSERT_LOCKED(object) \ 239 rw_assert(&(object)->lock, RA_LOCKED) 240#define VM_OBJECT_ASSERT_RLOCKED(object) \ 241 rw_assert(&(object)->lock, RA_RLOCKED) 242#define VM_OBJECT_ASSERT_WLOCKED(object) \ 243 rw_assert(&(object)->lock, RA_WLOCKED) 244#define VM_OBJECT_ASSERT_UNLOCKED(object) \ 245 rw_assert(&(object)->lock, RA_UNLOCKED) 246#define VM_OBJECT_LOCK_DOWNGRADE(object) \ 247 rw_downgrade(&(object)->lock) 248#define VM_OBJECT_RLOCK(object) \ 249 rw_rlock(&(object)->lock) 250#define VM_OBJECT_RUNLOCK(object) \ 251 rw_runlock(&(object)->lock) 252#define VM_OBJECT_SLEEP(object, wchan, pri, wmesg, timo) \ 253 rw_sleep((wchan), &(object)->lock, (pri), (wmesg), (timo)) 254#define VM_OBJECT_TRYRLOCK(object) \ 255 rw_try_rlock(&(object)->lock) 256#define VM_OBJECT_TRYWLOCK(object) \ 257 rw_try_wlock(&(object)->lock) 258#define VM_OBJECT_TRYUPGRADE(object) \ 259 rw_try_upgrade(&(object)->lock) 260#define VM_OBJECT_WLOCK(object) \ 261 rw_wlock(&(object)->lock) 262#define VM_OBJECT_WOWNED(object) \ 263 rw_wowned(&(object)->lock) 264#define VM_OBJECT_WUNLOCK(object) \ 265 rw_wunlock(&(object)->lock) 266#define VM_OBJECT_UNLOCK(object) \ 267 rw_unlock(&(object)->lock) 268#define VM_OBJECT_DROP(object) \ 269 lock_class_rw.lc_unlock(&(object)->lock.lock_object) 270#define VM_OBJECT_PICKUP(object, state) \ 271 lock_class_rw.lc_lock(&(object)->lock.lock_object, (state)) 272 273#define VM_OBJECT_ASSERT_PAGING(object) \ 274 KASSERT(blockcount_read(&(object)->paging_in_progress) != 0, \ 275 ("vm_object %p is not paging", object)) 276#define VM_OBJECT_ASSERT_REFERENCE(object) \ 277 KASSERT((object)->reference_count != 0, \ 278 ("vm_object %p is not referenced", object)) 279 280struct vnode; 281 282/* 283 * The object must be locked or thread private. 284 */ 285static __inline void 286vm_object_set_flag(vm_object_t object, u_short bits) 287{ 288 289 object->flags |= bits; 290} 291 292/* 293 * Conditionally set the object's color, which (1) enables the allocation 294 * of physical memory reservations for anonymous objects and larger-than- 295 * superpage-sized named objects and (2) determines the first page offset 296 * within the object at which a reservation may be allocated. In other 297 * words, the color determines the alignment of the object with respect 298 * to the largest superpage boundary. When mapping named objects, like 299 * files or POSIX shared memory objects, the color should be set to zero 300 * before a virtual address is selected for the mapping. In contrast, 301 * for anonymous objects, the color may be set after the virtual address 302 * is selected. 303 * 304 * The object must be locked. 305 */ 306static __inline void 307vm_object_color(vm_object_t object, u_short color) 308{ 309 310 if ((object->flags & OBJ_COLORED) == 0) { 311 object->pg_color = color; 312 vm_object_set_flag(object, OBJ_COLORED); 313 } 314} 315 316static __inline bool 317vm_object_reserv(vm_object_t object) 318{ 319 320 if (object != NULL && 321 (object->flags & (OBJ_COLORED | OBJ_FICTITIOUS)) == OBJ_COLORED) { 322 return (true); 323 } 324 return (false); 325} 326 327void vm_object_clear_flag(vm_object_t object, u_short bits); 328void vm_object_pip_add(vm_object_t object, short i); 329void vm_object_pip_wakeup(vm_object_t object); 330void vm_object_pip_wakeupn(vm_object_t object, short i); 331void vm_object_pip_wait(vm_object_t object, const char *waitid); 332void vm_object_pip_wait_unlocked(vm_object_t object, const char *waitid); 333 334void vm_object_busy(vm_object_t object); 335void vm_object_unbusy(vm_object_t object); 336void vm_object_busy_wait(vm_object_t object, const char *wmesg); 337 338static inline bool 339vm_object_busied(vm_object_t object) 340{ 341 342 return (blockcount_read(&object->busy) != 0); 343} 344#define VM_OBJECT_ASSERT_BUSY(object) MPASS(vm_object_busied((object))) 345 346void umtx_shm_object_init(vm_object_t object); 347void umtx_shm_object_terminated(vm_object_t object); 348extern int umtx_shm_vnobj_persistent; 349 350vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 351vm_object_t vm_object_allocate_anon(vm_pindex_t, vm_object_t, struct ucred *, 352 vm_size_t); 353vm_object_t vm_object_allocate_dyn(objtype_t, vm_pindex_t, u_short); 354boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t, 355 boolean_t); 356void vm_object_collapse (vm_object_t); 357void vm_object_deallocate (vm_object_t); 358void vm_object_destroy (vm_object_t); 359void vm_object_terminate (vm_object_t); 360void vm_object_set_writeable_dirty (vm_object_t); 361void vm_object_set_writeable_dirty_(vm_object_t object); 362bool vm_object_mightbedirty(vm_object_t object); 363bool vm_object_mightbedirty_(vm_object_t object); 364void vm_object_init (void); 365int vm_object_kvme_type(vm_object_t object, struct vnode **vpp); 366void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int); 367boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start, 368 vm_ooffset_t end, int flags); 369void vm_object_page_noreuse(vm_object_t object, vm_pindex_t start, 370 vm_pindex_t end); 371void vm_object_page_remove(vm_object_t object, vm_pindex_t start, 372 vm_pindex_t end, int options); 373boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t); 374void vm_object_print(long addr, boolean_t have_addr, long count, char *modif); 375void vm_object_reference (vm_object_t); 376void vm_object_reference_locked(vm_object_t); 377int vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr); 378void vm_object_shadow(vm_object_t *, vm_ooffset_t *, vm_size_t, struct ucred *, 379 bool); 380void vm_object_split(vm_map_entry_t); 381boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t, 382 boolean_t); 383void vm_object_unwire(vm_object_t object, vm_ooffset_t offset, 384 vm_size_t length, uint8_t queue); 385struct vnode *vm_object_vnode(vm_object_t object); 386bool vm_object_is_active(vm_object_t obj); 387#endif /* _KERNEL */ 388 389#endif /* _VM_OBJECT_ */ 390