vm_object.h revision 52568
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: head/sys/vm/vm_object.h 52568 1999-10-27 17:47:24Z alc $ 65 */ 66 67/* 68 * Virtual memory object module definitions. 69 */ 70 71#ifndef _VM_OBJECT_ 72#define _VM_OBJECT_ 73 74#include <sys/queue.h> 75#include <machine/atomic.h> 76 77enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_DEAD }; 78typedef u_char objtype_t; 79 80/* 81 * Types defined: 82 * 83 * vm_object_t Virtual memory object. 84 * 85 */ 86 87struct vm_object { 88 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 89 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 90 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 91 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 92 int generation; /* generation ID */ 93 vm_size_t size; /* Object size */ 94 int ref_count; /* How many refs?? */ 95 int shadow_count; /* how many objects that this is a shadow for */ 96 int hash_rand; /* vm hash table randomizer */ 97 objtype_t type; /* type of pager */ 98 u_short flags; /* see below */ 99 u_short pg_color; /* color of first page in obj */ 100 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 101 int resident_page_count; /* number of resident pages */ 102 struct vm_object *backing_object; /* object that I'm a shadow of */ 103 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 104 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 105 void *handle; 106 union { 107 /* 108 * VNode pager 109 * 110 * vnp_size - current size of file 111 */ 112 struct { 113 off_t vnp_size; 114 } vnp; 115 116 /* 117 * Device pager 118 * 119 * devp_pglist - list of allocated pages 120 */ 121 struct { 122 TAILQ_HEAD(, vm_page) devp_pglist; 123 } devp; 124 125 /* 126 * Swap pager 127 * 128 * swp_bcount - number of swap 'swblock' metablocks, each 129 * contains up to 16 swapblk assignments. 130 * see vm/swap_pager.h 131 */ 132 struct { 133 int swp_bcount; 134 } swp; 135 } un_pager; 136}; 137 138/* 139 * Flags 140 */ 141#define OBJ_ACTIVE 0x0004 /* active objects */ 142#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 143#define OBJ_NOSPLIT 0x0010 /* dont split this object */ 144#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 145#define OBJ_WRITEABLE 0x0080 /* object has been made writable */ 146#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */ 147#define OBJ_CLEANING 0x0200 148#define OBJ_OPT 0x1000 /* I/O optimization */ 149#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 150 151#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 152#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 153 154#ifdef KERNEL 155 156#define OBJPC_SYNC 0x1 /* sync I/O */ 157#define OBJPC_INVAL 0x2 /* invalidate */ 158 159TAILQ_HEAD(object_q, vm_object); 160 161extern struct object_q vm_object_list; /* list of allocated objects */ 162 163 /* lock for object list and count */ 164 165extern vm_object_t kernel_object; /* the single kernel object */ 166extern vm_object_t kmem_object; 167 168#endif /* KERNEL */ 169 170#ifdef KERNEL 171 172static __inline void 173vm_object_set_flag(vm_object_t object, u_int bits) 174{ 175 atomic_set_short(&object->flags, bits); 176} 177 178static __inline void 179vm_object_clear_flag(vm_object_t object, u_int bits) 180{ 181 atomic_clear_short(&object->flags, bits); 182} 183 184static __inline void 185vm_object_pip_add(vm_object_t object, int i) 186{ 187 atomic_add_short(&object->paging_in_progress, i); 188} 189 190static __inline void 191vm_object_pip_subtract(vm_object_t object, int i) 192{ 193 atomic_subtract_short(&object->paging_in_progress, i); 194} 195 196static __inline void 197vm_object_pip_wakeup(vm_object_t object) 198{ 199 atomic_subtract_short(&object->paging_in_progress, 1); 200 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) { 201 vm_object_clear_flag(object, OBJ_PIPWNT); 202 wakeup(object); 203 } 204} 205 206static __inline void 207vm_object_pip_wakeupn(vm_object_t object, int i) 208{ 209 if (i) 210 atomic_subtract_short(&object->paging_in_progress, i); 211 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) { 212 vm_object_clear_flag(object, OBJ_PIPWNT); 213 wakeup(object); 214 } 215} 216 217static __inline void 218vm_object_pip_sleep(vm_object_t object, char *waitid) 219{ 220 if (object->paging_in_progress) { 221 int s = splvm(); 222 if (object->paging_in_progress) { 223 vm_object_set_flag(object, OBJ_PIPWNT); 224 tsleep(object, PVM, waitid, 0); 225 } 226 splx(s); 227 } 228} 229 230static __inline void 231vm_object_pip_wait(vm_object_t object, char *waitid) 232{ 233 while (object->paging_in_progress) 234 vm_object_pip_sleep(object, waitid); 235} 236 237vm_object_t vm_object_allocate __P((objtype_t, vm_size_t)); 238void _vm_object_allocate __P((objtype_t, vm_size_t, vm_object_t)); 239boolean_t vm_object_coalesce __P((vm_object_t, vm_pindex_t, vm_size_t, vm_size_t)); 240void vm_object_collapse __P((vm_object_t)); 241void vm_object_deallocate __P((vm_object_t)); 242void vm_object_terminate __P((vm_object_t)); 243void vm_object_vndeallocate __P((vm_object_t)); 244void vm_object_init __P((void)); 245void vm_object_page_clean __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t)); 246void vm_object_page_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t)); 247void vm_object_pmap_copy __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 248void vm_object_pmap_copy_1 __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 249void vm_object_pmap_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 250void vm_object_reference __P((vm_object_t)); 251void vm_object_shadow __P((vm_object_t *, vm_ooffset_t *, vm_size_t)); 252void vm_object_madvise __P((vm_object_t, vm_pindex_t, int, int)); 253void vm_object_init2 __P((void)); 254#endif /* KERNEL */ 255 256#endif /* _VM_OBJECT_ */ 257