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_object.h 8.3 (Berkeley) 1/12/94 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: src/sys/vm/vm_object.h,v 1.63.2.3 2003/05/26 19:17:56 alc Exp $ 61 */ 62 63 /* 64 * Virtual memory object module definitions. 65 */ 66 67 #ifndef _VM_VM_OBJECT_H_ 68 #define _VM_VM_OBJECT_H_ 69 70 #ifndef _SYS_TYPES_H_ 71 #include <sys/types.h> 72 #endif 73 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_) 74 #include <sys/systm.h> 75 #endif 76 #ifndef _SYS_QUEUE_H_ 77 #include <sys/queue.h> 78 #endif 79 #ifndef _SYS_TREE_H_ 80 #include <sys/tree.h> 81 #endif 82 #ifndef _SYS_THREAD_H_ 83 #include <sys/thread.h> 84 #endif 85 #include <machine/atomic.h> 86 #ifndef _VM_VM_H_ 87 #include <vm/vm.h> 88 #endif 89 #ifndef _VM_VM_PAGE_H_ 90 #include <vm/vm_page.h> 91 #endif 92 93 #ifdef _KERNEL 94 95 #ifndef _SYS_THREAD_H_ 96 #include <sys/thread.h> 97 #endif 98 99 #ifndef _SYS_THREAD2_H_ 100 #include <sys/thread2.h> 101 #endif 102 103 #ifndef _SYS_REFCOUNT_H_ 104 #include <sys/refcount.h> 105 #endif 106 107 #endif 108 109 struct swblock; 110 struct swblock_rb_tree; 111 int rb_swblock_compare(struct swblock *, struct swblock *); 112 113 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare, 114 vm_pindex_t); 115 116 enum obj_type { 117 OBJT_DEFAULT, 118 OBJT_SWAP, /* object backed by swap blocks */ 119 OBJT_VNODE, /* object backed by file pages (vnode) */ 120 OBJT_DEVICE, /* object backed by device pages */ 121 OBJT_PHYS, /* object backed by physical pages */ 122 OBJT_DEAD, /* dead object */ 123 OBJT_MARKER /* marker object */ 124 }; 125 typedef u_char objtype_t; 126 127 /* 128 * vm_object A VM object which represents an arbitrarily sized 129 * data store. 130 * 131 * Locking requirements: vmobj_token for ref_count and object_list, and 132 * vm_token for everything else. 133 */ 134 struct vm_object { 135 TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */ 136 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 137 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 138 RB_HEAD(vm_page_rb_tree, vm_page) rb_memq; /* resident pages */ 139 int generation; /* generation ID */ 140 vm_pindex_t size; /* Object size */ 141 int ref_count; /* vmobj_token */ 142 int shadow_count; /* how many objects that this is a shadow for */ 143 objtype_t type; /* type of pager */ 144 u_short flags; /* see below */ 145 u_short pg_color; /* color of first page in obj */ 146 u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 147 int resident_page_count; /* number of resident pages */ 148 u_int agg_pv_list_count; /* aggregate pv list count */ 149 struct vm_object *backing_object; /* object that I'm a shadow of */ 150 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 151 void *handle; 152 int hold_count; /* refcount for object liveness */ 153 154 #if defined(DEBUG_LOCKS) 155 /* 156 * Record threads holding a vm_object 157 */ 158 159 #define VMOBJ_DEBUG_ARRAY_SIZE (32) 160 u_int debug_hold_bitmap; 161 thread_t debug_hold_thrs[VMOBJ_DEBUG_ARRAY_SIZE]; 162 char *debug_hold_file[VMOBJ_DEBUG_ARRAY_SIZE]; 163 int debug_hold_line[VMOBJ_DEBUG_ARRAY_SIZE]; 164 u_int debug_hold_ovfl; 165 #endif 166 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_UNUSED0040 0x0040 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, u_int i) 236 { 237 refcount_acquire_n(&object->paging_in_progress, (u_int)i); 238 } 239 240 static __inline void 241 vm_object_pip_wakeup_n(vm_object_t object, u_int i) 242 { 243 refcount_release_wakeup_n(&object->paging_in_progress, i); 244 } 245 246 static __inline void 247 vm_object_pip_wakeup(vm_object_t object) 248 { 249 vm_object_pip_wakeup_n(object, 1); 250 } 251 252 static __inline void 253 vm_object_pip_wait(vm_object_t object, char *waitid) 254 { 255 refcount_wait(&object->paging_in_progress, waitid); 256 } 257 258 static __inline lwkt_token_t 259 vm_object_token(vm_object_t obj) 260 { 261 return (lwkt_token_pool_lookup(obj)); 262 } 263 264 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 265 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t); 266 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t); 267 void vm_object_collapse (vm_object_t); 268 void vm_object_deallocate (vm_object_t); 269 void vm_object_deallocate_locked (vm_object_t); 270 void vm_object_terminate (vm_object_t); 271 void vm_object_set_writeable_dirty (vm_object_t); 272 void vm_object_init (void); 273 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 274 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 275 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t); 276 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t); 277 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t); 278 void vm_object_reference (vm_object_t); 279 void vm_object_reference_locked (vm_object_t); 280 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 281 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int); 282 void vm_object_init2 (void); 283 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t, vm_prot_t, int, int *); 284 void vm_object_dead_sleep(vm_object_t, const char *); 285 void vm_object_dead_wakeup(vm_object_t); 286 void vm_object_lock_swap(void); 287 void vm_object_lock(vm_object_t); 288 void vm_object_unlock(vm_object_t); 289 290 #ifndef DEBUG_LOCKS 291 void vm_object_hold(vm_object_t); 292 #else 293 #define vm_object_hold(obj) \ 294 debugvm_object_hold(obj, __FILE__, __LINE__) 295 void debugvm_object_hold(vm_object_t, char *, int); 296 #endif 297 298 void vm_object_drop(vm_object_t); 299 300 #endif /* _KERNEL */ 301 302 #endif /* _VM_VM_OBJECT_H_ */ 303