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 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 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: src/sys/vm/vm_object.h,v 1.63.2.3 2003/05/26 19:17:56 alc Exp $ 65 */ 66 67 /* 68 * Virtual memory object module definitions. 69 */ 70 71 #ifndef _VM_VM_OBJECT_H_ 72 #define _VM_VM_OBJECT_H_ 73 74 #ifndef _SYS_TYPES_H_ 75 #include <sys/types.h> 76 #endif 77 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_) 78 #include <sys/systm.h> 79 #endif 80 #ifndef _SYS_QUEUE_H_ 81 #include <sys/queue.h> 82 #endif 83 #ifndef _SYS_TREE_H_ 84 #include <sys/tree.h> 85 #endif 86 #ifndef _SYS_THREAD_H_ 87 #include <sys/thread.h> 88 #endif 89 #include <machine/atomic.h> 90 #ifndef _VM_VM_H_ 91 #include <vm/vm.h> 92 #endif 93 #ifndef _VM_VM_PAGE_H_ 94 #include <vm/vm_page.h> 95 #endif 96 97 #ifdef _KERNEL 98 99 #ifndef _SYS_THREAD2_H_ 100 #include <sys/thread2.h> 101 #endif 102 103 #endif 104 105 struct swblock; 106 struct swblock_rb_tree; 107 int rb_swblock_compare(struct swblock *, struct swblock *); 108 109 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare, 110 vm_pindex_t); 111 112 enum obj_type { 113 OBJT_DEFAULT, 114 OBJT_SWAP, /* object backed by swap blocks */ 115 OBJT_VNODE, /* object backed by file pages (vnode) */ 116 OBJT_DEVICE, /* object backed by device pages */ 117 OBJT_PHYS, /* object backed by physical pages */ 118 OBJT_DEAD, /* dead object */ 119 OBJT_MARKER /* marker object */ 120 }; 121 typedef u_char objtype_t; 122 123 /* 124 * vm_object_lock A lock covering byte ranges within a VM object 125 * 126 */ 127 struct vm_object_lock { 128 struct vm_object_lock *next; 129 int type; /* type of lock */ 130 int waiting; /* someone is waiting on the lock */ 131 off_t base; /* byte offset into object */ 132 off_t bytes; /* extent in bytes */ 133 }; 134 135 #define VMOBJ_LOCK_SHARED 1 136 #define VMOBJ_LOCK_EXCL 2 137 138 /* 139 * vm_object A VM object which represents an arbitrarily sized 140 * data store. 141 * 142 * Locking requirements: vmobj_token for ref_count and object_list, and 143 * vm_token for everything else. 144 */ 145 struct vm_object { 146 TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */ 147 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 148 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 149 RB_HEAD(vm_page_rb_tree, vm_page) rb_memq; /* resident pages */ 150 int generation; /* generation ID */ 151 vm_pindex_t size; /* Object size */ 152 int ref_count; /* vmobj_token */ 153 int shadow_count; /* how many objects that this is a shadow for */ 154 int hash_rand; /* vm hash table randomizer */ 155 objtype_t type; /* type of pager */ 156 u_short flags; /* see below */ 157 u_short pg_color; /* color of first page in obj */ 158 u_short unused01; 159 int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 160 int resident_page_count; /* number of resident pages */ 161 u_int agg_pv_list_count; /* aggregate pv list count */ 162 struct vm_object *backing_object; /* object that I'm a shadow of */ 163 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 164 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 165 void *handle; 166 vm_object_lock_t range_locks; 167 union { 168 /* 169 * Device pager 170 * 171 * devp_pglist - list of allocated pages 172 */ 173 struct { 174 TAILQ_HEAD(, vm_page) devp_pglist; 175 } devp; 176 } un_pager; 177 178 /* 179 * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing 180 * store. For vnodes the swap backing store acts as a fast 181 * data cache but the vnode contains the official data. 182 */ 183 RB_HEAD(swblock_rb_tree, swblock) swblock_root; 184 int swblock_count; 185 }; 186 187 /* 188 * Flags 189 */ 190 #define OBJ_ACTIVE 0x0004 /* active objects */ 191 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 192 #define OBJ_NOSPLIT 0x0010 /* dont split this object */ 193 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 194 #define OBJ_WRITEABLE 0x0080 /* object has been made writable */ 195 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */ 196 #define OBJ_CLEANING 0x0200 197 #define OBJ_DEADWNT 0x1000 /* waiting because object is dead */ 198 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 199 #define OBJ_NOMSYNC 0x4000 /* disable msync() system call */ 200 201 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 202 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 203 204 #ifdef _KERNEL 205 206 #define OBJPC_SYNC 0x1 /* sync I/O */ 207 #define OBJPC_INVAL 0x2 /* invalidate */ 208 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */ 209 210 TAILQ_HEAD(object_q, vm_object); 211 212 extern struct object_q vm_object_list; /* list of allocated objects */ 213 214 /* lock for object list and count */ 215 216 extern struct vm_object kernel_object; /* the single kernel object */ 217 218 #endif /* _KERNEL */ 219 220 #ifdef _KERNEL 221 222 static __inline void 223 vm_object_set_flag(vm_object_t object, u_int bits) 224 { 225 atomic_set_short(&object->flags, bits); 226 } 227 228 static __inline void 229 vm_object_clear_flag(vm_object_t object, u_int bits) 230 { 231 atomic_clear_short(&object->flags, bits); 232 } 233 234 static __inline void 235 vm_object_pip_add(vm_object_t object, int i) 236 { 237 atomic_add_int(&object->paging_in_progress, i); 238 } 239 240 static __inline void 241 vm_object_pip_subtract(vm_object_t object, int i) 242 { 243 atomic_subtract_int(&object->paging_in_progress, i); 244 } 245 246 static __inline void 247 vm_object_pip_wakeup(vm_object_t object) 248 { 249 atomic_subtract_int(&object->paging_in_progress, 1); 250 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) { 251 vm_object_clear_flag(object, OBJ_PIPWNT); 252 wakeup(object); 253 } 254 } 255 256 static __inline void 257 vm_object_pip_wakeupn(vm_object_t object, int i) 258 { 259 if (i) 260 atomic_subtract_int(&object->paging_in_progress, i); 261 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) { 262 vm_object_clear_flag(object, OBJ_PIPWNT); 263 wakeup(object); 264 } 265 } 266 267 static __inline void 268 vm_object_pip_sleep(vm_object_t object, char *waitid) 269 { 270 if (object->paging_in_progress) { 271 crit_enter(); 272 if (object->paging_in_progress) { 273 vm_object_set_flag(object, OBJ_PIPWNT); 274 tsleep(object, 0, waitid, 0); 275 } 276 crit_exit(); 277 } 278 } 279 280 static __inline void 281 vm_object_pip_wait(vm_object_t object, char *waitid) 282 { 283 while (object->paging_in_progress) 284 vm_object_pip_sleep(object, waitid); 285 } 286 287 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 288 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t); 289 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t); 290 void vm_object_collapse (vm_object_t); 291 void vm_object_deallocate (vm_object_t); 292 void vm_object_deallocate_locked (vm_object_t); 293 void vm_object_terminate (vm_object_t); 294 void vm_object_set_writeable_dirty (vm_object_t); 295 void vm_object_init (void); 296 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 297 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 298 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t); 299 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t); 300 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t); 301 void vm_object_reference (vm_object_t); 302 void vm_object_reference_locked (vm_object_t); 303 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 304 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int); 305 void vm_object_init2 (void); 306 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t, vm_prot_t, int, int *); 307 void vm_object_dead_sleep(vm_object_t, const char *); 308 void vm_object_dead_wakeup(vm_object_t); 309 310 #endif /* _KERNEL */ 311 312 #endif /* _VM_VM_OBJECT_H_ */ 313