vm_object.h revision 108117
1311116Sdim/* 2311116Sdim * Copyright (c) 1991, 1993 3311116Sdim * The Regents of the University of California. All rights reserved. 4311116Sdim * 5311116Sdim * This code is derived from software contributed to Berkeley by 6311116Sdim * The Mach Operating System project at Carnegie-Mellon University. 7311116Sdim * 8311116Sdim * Redistribution and use in source and binary forms, with or without 9311116Sdim * modification, are permitted provided that the following conditions 10311116Sdim * are met: 11311116Sdim * 1. Redistributions of source code must retain the above copyright 12311116Sdim * notice, this list of conditions and the following disclaimer. 13311116Sdim * 2. Redistributions in binary form must reproduce the above copyright 14311116Sdim * notice, this list of conditions and the following disclaimer in the 15311116Sdim * documentation and/or other materials provided with the distribution. 16311116Sdim * 3. All advertising materials mentioning features or use of this software 17311116Sdim * must display the following acknowledgement: 18311116Sdim * This product includes software developed by the University of 19311116Sdim * California, Berkeley and its contributors. 20311116Sdim * 4. Neither the name of the University nor the names of its contributors 21311116Sdim * may be used to endorse or promote products derived from this software 22311116Sdim * without specific prior written permission. 23311116Sdim * 24311116Sdim * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25311116Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26311116Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27311116Sdim * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28311116Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29311116Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30311116Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31311116Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32311116Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33311116Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34311116Sdim * SUCH DAMAGE. 35311116Sdim * 36311116Sdim * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 37311116Sdim * 38311116Sdim * 39311116Sdim * Copyright (c) 1987, 1990 Carnegie-Mellon University. 40311116Sdim * All rights reserved. 41311116Sdim * 42311116Sdim * Authors: Avadis Tevanian, Jr., Michael Wayne Young 43311116Sdim * 44311116Sdim * Permission to use, copy, modify and distribute this software and 45311116Sdim * its documentation is hereby granted, provided that both the copyright 46311116Sdim * notice and this permission notice appear in all copies of the 47311116Sdim * software, derivative works or modified versions, and any portions 48311116Sdim * thereof, and that both notices appear in supporting documentation. 49311116Sdim * 50311116Sdim * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 51311116Sdim * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 52311116Sdim * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 53311116Sdim * 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 108117 2002-12-20 05:10:32Z 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 <sys/_lock.h> 76#include <sys/_mutex.h> 77 78enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS, 79 OBJT_DEAD }; 80typedef u_char objtype_t; 81 82/* 83 * Types defined: 84 * 85 * vm_object_t Virtual memory object. 86 * 87 * List of locks 88 * (c) const until freed 89 * 90 */ 91 92struct vm_object { 93 struct mtx mtx; 94 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 95 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 96 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 97 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 98 vm_page_t root; /* root of the resident page splay tree */ 99 int generation; /* generation ID */ 100 vm_pindex_t size; /* Object size */ 101 int ref_count; /* How many refs?? */ 102 int shadow_count; /* how many objects that this is a shadow for */ 103 objtype_t type; /* type of pager */ 104 u_short flags; /* see below */ 105 u_short pg_color; /* (c) color of first page in obj */ 106 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 107 int resident_page_count; /* number of resident pages */ 108 struct vm_object *backing_object; /* object that I'm a shadow of */ 109 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 110 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 111 void *handle; 112 union { 113 /* 114 * VNode pager 115 * 116 * vnp_size - current size of file 117 */ 118 struct { 119 off_t vnp_size; 120 } vnp; 121 122 /* 123 * Device pager 124 * 125 * devp_pglist - list of allocated pages 126 */ 127 struct { 128 TAILQ_HEAD(, vm_page) devp_pglist; 129 } devp; 130 131 /* 132 * Swap pager 133 * 134 * swp_bcount - number of swap 'swblock' metablocks, each 135 * contains up to 16 swapblk assignments. 136 * see vm/swap_pager.h 137 */ 138 struct { 139 int swp_bcount; 140 } swp; 141 } un_pager; 142}; 143 144/* 145 * Flags 146 */ 147#define OBJ_ACTIVE 0x0004 /* active objects */ 148#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 149#define OBJ_NOSPLIT 0x0010 /* dont split this object */ 150#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 151#define OBJ_WRITEABLE 0x0080 /* object has been made writable */ 152#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */ 153#define OBJ_CLEANING 0x0200 154#define OBJ_OPT 0x1000 /* I/O optimization */ 155#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 156 157#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 158#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 159 160#ifdef _KERNEL 161 162#define OBJPC_SYNC 0x1 /* sync I/O */ 163#define OBJPC_INVAL 0x2 /* invalidate */ 164#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */ 165 166TAILQ_HEAD(object_q, vm_object); 167 168extern struct object_q vm_object_list; /* list of allocated objects */ 169extern struct mtx vm_object_list_mtx; /* lock for object list and count */ 170 171extern vm_object_t kernel_object; /* the single kernel object */ 172extern vm_object_t kmem_object; 173 174#endif /* _KERNEL */ 175 176#ifdef _KERNEL 177#define vm_object_lock(object) \ 178 mtx_lock((object) == kmem_object ? &kmem_object->mtx : &Giant) 179#define vm_object_unlock(object) \ 180 mtx_unlock((object) == kmem_object ? &kmem_object->mtx : &Giant) 181 182void vm_freeze_copyopts(vm_object_t, vm_pindex_t, vm_pindex_t); 183 184void vm_object_set_flag(vm_object_t object, u_short bits); 185void vm_object_clear_flag(vm_object_t object, u_short bits); 186void vm_object_pip_add(vm_object_t object, short i); 187void vm_object_pip_subtract(vm_object_t object, short i); 188void vm_object_pip_wakeup(vm_object_t object); 189void vm_object_pip_wakeupn(vm_object_t object, short i); 190void vm_object_pip_sleep(vm_object_t object, char *waitid); 191void vm_object_pip_wait(vm_object_t object, char *waitid); 192 193vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 194vm_object_t vm_object_allocate_wait (objtype_t, vm_pindex_t, int); 195void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t); 196boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t); 197void vm_object_collapse (vm_object_t); 198void vm_object_deallocate (vm_object_t); 199void vm_object_terminate (vm_object_t); 200void vm_object_vndeallocate (vm_object_t); 201void vm_object_set_writeable_dirty (vm_object_t); 202void vm_object_init (void); 203void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 204void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 205void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t); 206void vm_object_reference (vm_object_t); 207void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 208void vm_object_split(vm_map_entry_t); 209void vm_object_madvise (vm_object_t, vm_pindex_t, int, int); 210void vm_object_init2 (void); 211#endif /* _KERNEL */ 212 213#endif /* _VM_OBJECT_ */ 214