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 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 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 object module definitions. 67 */ 68 69 #ifndef _VM_OBJECT_ 70 #define _VM_OBJECT_ 71 72 #include <sys/queue.h> 73 #include <sys/_lock.h> 74 #include <sys/_mutex.h> 75 #include <sys/_pctrie.h> 76 #include <sys/_rwlock.h> 77 78 #include <vm/_vm_radix.h> 79 80 /* 81 * Types defined: 82 * 83 * vm_object_t Virtual memory object. 84 * 85 * List of locks 86 * (c) const until freed 87 * (o) per-object lock 88 * (f) free pages queue mutex 89 * 90 */ 91 92 #ifndef VM_PAGE_HAVE_PGLIST 93 TAILQ_HEAD(pglist, vm_page); 94 #define VM_PAGE_HAVE_PGLIST 95 #endif 96 97 struct vm_object { 98 struct rwlock lock; 99 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 100 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 101 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 102 struct pglist memq; /* list of resident pages */ 103 struct vm_radix rtree; /* root of the resident page radix trie*/ 104 vm_pindex_t size; /* Object size */ 105 int generation; /* generation ID */ 106 int ref_count; /* How many refs?? */ 107 int shadow_count; /* how many objects that this is a shadow for */ 108 vm_memattr_t memattr; /* default memory attribute for pages */ 109 objtype_t type; /* type of pager */ 110 u_short flags; /* see below */ 111 u_short pg_color; /* (c) color of first page in obj */ 112 u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 113 int resident_page_count; /* number of resident pages */ 114 struct vm_object *backing_object; /* object that I'm a shadow of */ 115 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 116 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 117 LIST_HEAD(, vm_reserv) rvq; /* list of reservations */ 118 void *handle; 119 union { 120 /* 121 * VNode pager 122 * 123 * vnp_size - current size of file 124 */ 125 struct { 126 off_t vnp_size; 127 vm_ooffset_t writemappings; 128 } vnp; 129 130 /* 131 * Device pager 132 * 133 * devp_pglist - list of allocated pages 134 */ 135 struct { 136 TAILQ_HEAD(, vm_page) devp_pglist; 137 struct cdev_pager_ops *ops; 138 struct cdev *dev; 139 } devp; 140 141 /* 142 * SG pager 143 * 144 * sgp_pglist - list of allocated pages 145 */ 146 struct { 147 TAILQ_HEAD(, vm_page) sgp_pglist; 148 } sgp; 149 150 /* 151 * Swap pager 152 * 153 * swp_tmpfs - back-pointer to the tmpfs vnode, 154 * if any, which uses the vm object 155 * as backing store. The handle 156 * cannot be reused for linking, 157 * because the vnode can be 158 * reclaimed and recreated, making 159 * the handle changed and hash-chain 160 * invalid. 161 * 162 * swp_blks - pc-trie of the allocated swap blocks. 163 * 164 */ 165 struct { 166 void *swp_tmpfs; 167 struct pctrie swp_blks; 168 } swp; 169 } un_pager; 170 struct ucred *cred; 171 vm_ooffset_t charge; 172 void *umtx_data; 173 }; 174 175 /* 176 * Flags 177 */ 178 #define OBJ_FICTITIOUS 0x0001 /* (c) contains fictitious pages */ 179 #define OBJ_UNMANAGED 0x0002 /* (c) contains unmanaged pages */ 180 #define OBJ_POPULATE 0x0004 /* pager implements populate() */ 181 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 182 #define OBJ_NOSPLIT 0x0010 /* dont split this object */ 183 #define OBJ_UMTXDEAD 0x0020 /* umtx pshared was terminated */ 184 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 185 #define OBJ_PG_DTOR 0x0080 /* dont reset object, leave that for dtor */ 186 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty, only for vnode */ 187 #define OBJ_TMPFS_NODE 0x0200 /* object belongs to tmpfs VREG node */ 188 #define OBJ_TMPFS_DIRTY 0x0400 /* dirty tmpfs obj */ 189 #define OBJ_COLORED 0x1000 /* pg_color is defined */ 190 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 191 #define OBJ_DISCONNECTWNT 0x4000 /* disconnect from vnode wanted */ 192 #define OBJ_TMPFS 0x8000 /* has tmpfs vnode allocated */ 193 194 /* 195 * Helpers to perform conversion between vm_object page indexes and offsets. 196 * IDX_TO_OFF() converts an index into an offset. 197 * OFF_TO_IDX() converts an offset into an index. Since offsets are signed 198 * by default, the sign propagation in OFF_TO_IDX(), when applied to 199 * negative offsets, is intentional and returns a vm_object page index 200 * that cannot be created by a userspace mapping. 201 * UOFF_TO_IDX() treats the offset as an unsigned value and converts it 202 * into an index accordingly. Use it only when the full range of offset 203 * values are allowed. Currently, this only applies to device mappings. 204 * OBJ_MAX_SIZE specifies the maximum page index corresponding to the 205 * maximum unsigned offset. 206 */ 207 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 208 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 209 #define UOFF_TO_IDX(off) (((vm_pindex_t)(off)) >> PAGE_SHIFT) 210 #define OBJ_MAX_SIZE (UOFF_TO_IDX(UINT64_MAX) + 1) 211 212 #ifdef _KERNEL 213 214 #define OBJPC_SYNC 0x1 /* sync I/O */ 215 #define OBJPC_INVAL 0x2 /* invalidate */ 216 #define OBJPC_NOSYNC 0x4 /* skip if VPO_NOSYNC */ 217 218 /* 219 * The following options are supported by vm_object_page_remove(). 220 */ 221 #define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */ 222 #define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */ 223 224 TAILQ_HEAD(object_q, vm_object); 225 226 extern struct object_q vm_object_list; /* list of allocated objects */ 227 extern struct mtx vm_object_list_mtx; /* lock for object list and count */ 228 229 extern struct vm_object kernel_object_store; 230 231 /* kernel and kmem are aliased for backwards KPI compat. */ 232 #define kernel_object (&kernel_object_store) 233 #define kmem_object (&kernel_object_store) 234 235 #define VM_OBJECT_ASSERT_LOCKED(object) \ 236 rw_assert(&(object)->lock, RA_LOCKED) 237 #define VM_OBJECT_ASSERT_RLOCKED(object) \ 238 rw_assert(&(object)->lock, RA_RLOCKED) 239 #define VM_OBJECT_ASSERT_WLOCKED(object) \ 240 rw_assert(&(object)->lock, RA_WLOCKED) 241 #define VM_OBJECT_ASSERT_UNLOCKED(object) \ 242 rw_assert(&(object)->lock, RA_UNLOCKED) 243 #define VM_OBJECT_LOCK_DOWNGRADE(object) \ 244 rw_downgrade(&(object)->lock) 245 #define VM_OBJECT_RLOCK(object) \ 246 rw_rlock(&(object)->lock) 247 #define VM_OBJECT_RUNLOCK(object) \ 248 rw_runlock(&(object)->lock) 249 #define VM_OBJECT_SLEEP(object, wchan, pri, wmesg, timo) \ 250 rw_sleep((wchan), &(object)->lock, (pri), (wmesg), (timo)) 251 #define VM_OBJECT_TRYRLOCK(object) \ 252 rw_try_rlock(&(object)->lock) 253 #define VM_OBJECT_TRYWLOCK(object) \ 254 rw_try_wlock(&(object)->lock) 255 #define VM_OBJECT_TRYUPGRADE(object) \ 256 rw_try_upgrade(&(object)->lock) 257 #define VM_OBJECT_WLOCK(object) \ 258 rw_wlock(&(object)->lock) 259 #define VM_OBJECT_WOWNED(object) \ 260 rw_wowned(&(object)->lock) 261 #define VM_OBJECT_WUNLOCK(object) \ 262 rw_wunlock(&(object)->lock) 263 264 /* 265 * The object must be locked or thread private. 266 */ 267 static __inline void 268 vm_object_set_flag(vm_object_t object, u_short bits) 269 { 270 271 object->flags |= bits; 272 } 273 274 /* 275 * Conditionally set the object's color, which (1) enables the allocation 276 * of physical memory reservations for anonymous objects and larger-than- 277 * superpage-sized named objects and (2) determines the first page offset 278 * within the object at which a reservation may be allocated. In other 279 * words, the color determines the alignment of the object with respect 280 * to the largest superpage boundary. When mapping named objects, like 281 * files or POSIX shared memory objects, the color should be set to zero 282 * before a virtual address is selected for the mapping. In contrast, 283 * for anonymous objects, the color may be set after the virtual address 284 * is selected. 285 * 286 * The object must be locked. 287 */ 288 static __inline void 289 vm_object_color(vm_object_t object, u_short color) 290 { 291 292 if ((object->flags & OBJ_COLORED) == 0) { 293 object->pg_color = color; 294 object->flags |= OBJ_COLORED; 295 } 296 } 297 298 void vm_object_clear_flag(vm_object_t object, u_short bits); 299 void vm_object_pip_add(vm_object_t object, short i); 300 void vm_object_pip_subtract(vm_object_t object, short i); 301 void vm_object_pip_wakeup(vm_object_t object); 302 void vm_object_pip_wakeupn(vm_object_t object, short i); 303 void vm_object_pip_wait(vm_object_t object, char *waitid); 304 305 void umtx_shm_object_init(vm_object_t object); 306 void umtx_shm_object_terminated(vm_object_t object); 307 extern int umtx_shm_vnobj_persistent; 308 309 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 310 boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t, 311 boolean_t); 312 void vm_object_collapse (vm_object_t); 313 void vm_object_deallocate (vm_object_t); 314 void vm_object_destroy (vm_object_t); 315 void vm_object_terminate (vm_object_t); 316 void vm_object_set_writeable_dirty (vm_object_t); 317 void vm_object_init (void); 318 void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int); 319 boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start, 320 vm_ooffset_t end, int flags); 321 void vm_object_page_noreuse(vm_object_t object, vm_pindex_t start, 322 vm_pindex_t end); 323 void vm_object_page_remove(vm_object_t object, vm_pindex_t start, 324 vm_pindex_t end, int options); 325 boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t); 326 void vm_object_print(long addr, boolean_t have_addr, long count, char *modif); 327 void vm_object_reference (vm_object_t); 328 void vm_object_reference_locked(vm_object_t); 329 int vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr); 330 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 331 void vm_object_split(vm_map_entry_t); 332 boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t, 333 boolean_t); 334 void vm_object_unwire(vm_object_t object, vm_ooffset_t offset, 335 vm_size_t length, uint8_t queue); 336 struct vnode *vm_object_vnode(vm_object_t object); 337 #endif /* _KERNEL */ 338 339 #endif /* _VM_OBJECT_ */ 340