vm_object.h revision 95112
1296177Sjhibbits/* 2296177Sjhibbits * Copyright (c) 1991, 1993 3296177Sjhibbits * The Regents of the University of California. All rights reserved. 4296177Sjhibbits * 5296177Sjhibbits * This code is derived from software contributed to Berkeley by 6296177Sjhibbits * The Mach Operating System project at Carnegie-Mellon University. 7296177Sjhibbits * 8296177Sjhibbits * Redistribution and use in source and binary forms, with or without 9296177Sjhibbits * modification, are permitted provided that the following conditions 10296177Sjhibbits * are met: 11296177Sjhibbits * 1. Redistributions of source code must retain the above copyright 12296177Sjhibbits * notice, this list of conditions and the following disclaimer. 13296177Sjhibbits * 2. Redistributions in binary form must reproduce the above copyright 14296177Sjhibbits * notice, this list of conditions and the following disclaimer in the 15296177Sjhibbits * documentation and/or other materials provided with the distribution. 16296177Sjhibbits * 3. All advertising materials mentioning features or use of this software 17296177Sjhibbits * must display the following acknowledgement: 18296177Sjhibbits * This product includes software developed by the University of 19296177Sjhibbits * California, Berkeley and its contributors. 20296177Sjhibbits * 4. Neither the name of the University nor the names of its contributors 21296177Sjhibbits * may be used to endorse or promote products derived from this software 22296177Sjhibbits * without specific prior written permission. 23296177Sjhibbits * 24296177Sjhibbits * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25296177Sjhibbits * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26296177Sjhibbits * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27296177Sjhibbits * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28296177Sjhibbits * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29296177Sjhibbits * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30296177Sjhibbits * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31296177Sjhibbits * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32296177Sjhibbits * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33296177Sjhibbits * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34296177Sjhibbits * SUCH DAMAGE. 35296177Sjhibbits * 36296177Sjhibbits * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 37296177Sjhibbits * 38296177Sjhibbits * 39296177Sjhibbits * Copyright (c) 1987, 1990 Carnegie-Mellon University. 40296177Sjhibbits * All rights reserved. 41296177Sjhibbits * 42296177Sjhibbits * Authors: Avadis Tevanian, Jr., Michael Wayne Young 43296177Sjhibbits * 44296177Sjhibbits * Permission to use, copy, modify and distribute this software and 45296177Sjhibbits * its documentation is hereby granted, provided that both the copyright 46296177Sjhibbits * notice and this permission notice appear in all copies of the 47296177Sjhibbits * software, derivative works or modified versions, and any portions 48296177Sjhibbits * thereof, and that both notices appear in supporting documentation. 49296177Sjhibbits * 50296177Sjhibbits * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 51296177Sjhibbits * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 52296177Sjhibbits * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 53296177Sjhibbits * 54296177Sjhibbits * Carnegie Mellon requests users of this software to return to 55296177Sjhibbits * 56296177Sjhibbits * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 57296177Sjhibbits * School of Computer Science 58296177Sjhibbits * Carnegie Mellon University 59296177Sjhibbits * Pittsburgh PA 15213-3890 60296177Sjhibbits * 61296177Sjhibbits * any improvements or extensions that they make and grant Carnegie the 62296177Sjhibbits * rights to redistribute these changes. 63296177Sjhibbits * 64296177Sjhibbits * $FreeBSD: head/sys/vm/vm_object.h 95112 2002-04-20 07:23:22Z alc $ 65296177Sjhibbits */ 66296177Sjhibbits 67296177Sjhibbits/* 68296177Sjhibbits * Virtual memory object module definitions. 69296177Sjhibbits */ 70296177Sjhibbits 71296177Sjhibbits#ifndef _VM_OBJECT_ 72296177Sjhibbits#define _VM_OBJECT_ 73296177Sjhibbits 74296177Sjhibbits#include <sys/queue.h> 75296177Sjhibbits 76296177Sjhibbitsenum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS, 77296177Sjhibbits OBJT_DEAD }; 78296177Sjhibbitstypedef u_char objtype_t; 79296177Sjhibbits 80296177Sjhibbits/* 81296177Sjhibbits * Types defined: 82296177Sjhibbits * 83296177Sjhibbits * vm_object_t Virtual memory object. 84296177Sjhibbits * 85296177Sjhibbits */ 86296177Sjhibbits 87296177Sjhibbitsstruct vm_object { 88296177Sjhibbits TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 89296177Sjhibbits TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 90296177Sjhibbits TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 91296177Sjhibbits TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 92296177Sjhibbits int generation; /* generation ID */ 93296177Sjhibbits vm_size_t size; /* Object size */ 94296177Sjhibbits int ref_count; /* How many refs?? */ 95296177Sjhibbits int shadow_count; /* how many objects that this is a shadow for */ 96296177Sjhibbits int hash_rand; /* vm hash table randomizer */ 97296177Sjhibbits objtype_t type; /* type of pager */ 98296177Sjhibbits u_short flags; /* see below */ 99296177Sjhibbits u_short pg_color; /* color of first page in obj */ 100296177Sjhibbits u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 101296177Sjhibbits int resident_page_count; /* number of resident pages */ 102296177Sjhibbits struct vm_object *backing_object; /* object that I'm a shadow of */ 103296177Sjhibbits vm_ooffset_t backing_object_offset;/* Offset in backing object */ 104296177Sjhibbits TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 105296177Sjhibbits void *handle; 106296177Sjhibbits union { 107296177Sjhibbits /* 108296177Sjhibbits * VNode pager 109296177Sjhibbits * 110296177Sjhibbits * vnp_size - current size of file 111296177Sjhibbits */ 112296177Sjhibbits struct { 113296177Sjhibbits off_t vnp_size; 114296177Sjhibbits } vnp; 115296177Sjhibbits 116296177Sjhibbits /* 117296177Sjhibbits * Device pager 118296177Sjhibbits * 119296177Sjhibbits * devp_pglist - list of allocated pages 120296177Sjhibbits */ 121296177Sjhibbits struct { 122296177Sjhibbits TAILQ_HEAD(, vm_page) devp_pglist; 123296177Sjhibbits } devp; 124296177Sjhibbits 125296177Sjhibbits /* 126296177Sjhibbits * Swap pager 127296177Sjhibbits * 128296177Sjhibbits * swp_bcount - number of swap 'swblock' metablocks, each 129296177Sjhibbits * contains up to 16 swapblk assignments. 130296177Sjhibbits * see vm/swap_pager.h 131296177Sjhibbits */ 132296177Sjhibbits struct { 133296177Sjhibbits int swp_bcount; 134296177Sjhibbits } swp; 135296177Sjhibbits } un_pager; 136296177Sjhibbits}; 137296177Sjhibbits 138296177Sjhibbits/* 139296177Sjhibbits * Flags 140296177Sjhibbits */ 141296177Sjhibbits#define OBJ_ACTIVE 0x0004 /* active objects */ 142296177Sjhibbits#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 143296177Sjhibbits#define OBJ_NOSPLIT 0x0010 /* dont split this object */ 144296177Sjhibbits#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 145296177Sjhibbits#define OBJ_WRITEABLE 0x0080 /* object has been made writable */ 146296177Sjhibbits#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */ 147296177Sjhibbits#define OBJ_CLEANING 0x0200 148296177Sjhibbits#define OBJ_OPT 0x1000 /* I/O optimization */ 149296177Sjhibbits#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 150296177Sjhibbits 151296177Sjhibbits#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 152296177Sjhibbits#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 153296177Sjhibbits 154296177Sjhibbits#ifdef _KERNEL 155296177Sjhibbits 156296177Sjhibbits#define OBJPC_SYNC 0x1 /* sync I/O */ 157296177Sjhibbits#define OBJPC_INVAL 0x2 /* invalidate */ 158296177Sjhibbits#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */ 159296177Sjhibbits 160296177SjhibbitsTAILQ_HEAD(object_q, vm_object); 161296177Sjhibbits 162296177Sjhibbitsextern struct object_q vm_object_list; /* list of allocated objects */ 163296177Sjhibbitsextern struct mtx vm_object_list_mtx; /* lock for object list and count */ 164296177Sjhibbits 165296177Sjhibbitsextern vm_object_t kernel_object; /* the single kernel object */ 166296177Sjhibbitsextern vm_object_t kmem_object; 167296177Sjhibbits 168296177Sjhibbits#endif /* _KERNEL */ 169296177Sjhibbits 170296177Sjhibbits#ifdef _KERNEL 171296177Sjhibbits 172296177Sjhibbitsvoid vm_object_set_flag(vm_object_t object, u_short bits); 173296177Sjhibbitsvoid vm_object_clear_flag(vm_object_t object, u_short bits); 174296177Sjhibbitsvoid vm_object_pip_add(vm_object_t object, short i); 175296177Sjhibbitsvoid vm_object_pip_subtract(vm_object_t object, short i); 176296177Sjhibbitsvoid vm_object_pip_wakeup(vm_object_t object); 177296177Sjhibbitsvoid vm_object_pip_wakeupn(vm_object_t object, short i); 178296177Sjhibbitsvoid vm_object_pip_sleep(vm_object_t object, char *waitid); 179296177Sjhibbitsvoid vm_object_pip_wait(vm_object_t object, char *waitid); 180296177Sjhibbits 181296177Sjhibbitsvm_object_t vm_object_allocate (objtype_t, vm_size_t); 182296177Sjhibbitsvoid _vm_object_allocate (objtype_t, vm_size_t, vm_object_t); 183296177Sjhibbitsboolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t); 184296177Sjhibbitsvoid vm_object_collapse (vm_object_t); 185296177Sjhibbitsvoid vm_object_deallocate (vm_object_t); 186296177Sjhibbitsvoid vm_object_terminate (vm_object_t); 187296177Sjhibbitsvoid vm_object_vndeallocate (vm_object_t); 188296177Sjhibbitsvoid vm_object_set_writeable_dirty (vm_object_t); 189296177Sjhibbitsvoid vm_object_init (void); 190296177Sjhibbitsvoid vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 191296177Sjhibbitsvoid vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t); 192296177Sjhibbitsvoid vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t); 193296177Sjhibbitsvoid vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t); 194296177Sjhibbitsvoid vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t); 195296177Sjhibbitsvoid vm_object_reference (vm_object_t); 196296177Sjhibbitsvoid vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 197296177Sjhibbitsvoid vm_object_madvise (vm_object_t, vm_pindex_t, int, int); 198296177Sjhibbitsvoid vm_object_init2 (void); 199296177Sjhibbits#endif /* _KERNEL */ 200296177Sjhibbits 201296177Sjhibbits#endif /* _VM_OBJECT_ */ 202296177Sjhibbits