vm_object.h revision 32702
1274116Sdteske/* 2274116Sdteske * Copyright (c) 1991, 1993 3274116Sdteske * The Regents of the University of California. All rights reserved. 4274116Sdteske * 5274116Sdteske * This code is derived from software contributed to Berkeley by 6274116Sdteske * The Mach Operating System project at Carnegie-Mellon University. 7274116Sdteske * 8274116Sdteske * Redistribution and use in source and binary forms, with or without 9274116Sdteske * modification, are permitted provided that the following conditions 10274116Sdteske * are met: 11274116Sdteske * 1. Redistributions of source code must retain the above copyright 12274116Sdteske * notice, this list of conditions and the following disclaimer. 13274116Sdteske * 2. Redistributions in binary form must reproduce the above copyright 14274116Sdteske * notice, this list of conditions and the following disclaimer in the 15274116Sdteske * documentation and/or other materials provided with the distribution. 16274116Sdteske * 3. All advertising materials mentioning features or use of this software 17274116Sdteske * must display the following acknowledgement: 18274116Sdteske * This product includes software developed by the University of 19274116Sdteske * California, Berkeley and its contributors. 20274116Sdteske * 4. Neither the name of the University nor the names of its contributors 21274116Sdteske * may be used to endorse or promote products derived from this software 22274116Sdteske * without specific prior written permission. 23274116Sdteske * 24274116Sdteske * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25274116Sdteske * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26274116Sdteske * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27274116Sdteske * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28274116Sdteske * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29274116Sdteske * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30274116Sdteske * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31274116Sdteske * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32274116Sdteske * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33274116Sdteske * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34274116Sdteske * SUCH DAMAGE. 35274116Sdteske * 36274116Sdteske * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 37274116Sdteske * 38274116Sdteske * 39274116Sdteske * Copyright (c) 1987, 1990 Carnegie-Mellon University. 40274116Sdteske * All rights reserved. 41274116Sdteske * 42274116Sdteske * Authors: Avadis Tevanian, Jr., Michael Wayne Young 43274116Sdteske * 44274116Sdteske * Permission to use, copy, modify and distribute this software and 45274116Sdteske * its documentation is hereby granted, provided that both the copyright 46274116Sdteske * notice and this permission notice appear in all copies of the 47274116Sdteske * software, derivative works or modified versions, and any portions 48274116Sdteske * thereof, and that both notices appear in supporting documentation. 49274116Sdteske * 50274116Sdteske * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 51274116Sdteske * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 52274116Sdteske * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 53274116Sdteske * 54274116Sdteske * Carnegie Mellon requests users of this software to return to 55274116Sdteske * 56274116Sdteske * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 57274116Sdteske * School of Computer Science 58274116Sdteske * Carnegie Mellon University 59274116Sdteske * Pittsburgh PA 15213-3890 60274116Sdteske * 61274116Sdteske * any improvements or extensions that they make and grant Carnegie the 62274116Sdteske * rights to redistribute these changes. 63274116Sdteske * 64274116Sdteske * $Id: vm_object.h,v 1.42 1998/01/17 09:16:56 dyson Exp $ 65274116Sdteske */ 66274116Sdteske 67274116Sdteske/* 68274116Sdteske * Virtual memory object module definitions. 69274116Sdteske */ 70274116Sdteske 71274116Sdteske#ifndef _VM_OBJECT_ 72274116Sdteske#define _VM_OBJECT_ 73 74#include <sys/queue.h> 75 76enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_DEAD }; 77typedef enum obj_type objtype_t; 78 79/* 80 * Types defined: 81 * 82 * vm_object_t Virtual memory object. 83 */ 84 85struct vm_object { 86 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 87 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 88 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 89 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 90 int generation; /* generation ID */ 91 objtype_t type; /* type of pager */ 92 vm_size_t size; /* Object size */ 93 int ref_count; /* How many refs?? */ 94 int shadow_count; /* how many objects that this is a shadow for */ 95 int pg_color; /* color of first page in obj */ 96 u_short flags; /* see below */ 97 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 98 u_short behavior; /* see below */ 99 int resident_page_count; /* number of resident pages */ 100 vm_ooffset_t paging_offset; /* Offset into paging space */ 101 struct vm_object *backing_object; /* object that I'm a shadow of */ 102 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 103 vm_offset_t last_read; /* last read in object -- detect seq behavior */ 104 vm_page_t page_hint; /* hint for last looked-up or allocated page */ 105 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 106 void *handle; 107 union { 108 struct { 109 off_t vnp_size; /* Current size of file */ 110 } vnp; 111 struct { 112 TAILQ_HEAD(, vm_page) devp_pglist; /* list of pages allocated */ 113 } devp; 114 struct { 115 int swp_nblocks; 116 int swp_allocsize; 117 struct swblock *swp_blocks; 118 short swp_poip; 119 } swp; 120 } un_pager; 121}; 122 123/* 124 * Flags 125 */ 126#define OBJ_ACTIVE 0x0004 /* active objects */ 127#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 128#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 129#define OBJ_WRITEABLE 0x0080 /* object has been made writable */ 130#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */ 131#define OBJ_CLEANING 0x0200 132#define OBJ_OPT 0x1000 /* I/O optimization */ 133 134#define OBJ_NORMAL 0x0 /* default behavior */ 135#define OBJ_SEQUENTIAL 0x1 /* expect sequential accesses */ 136#define OBJ_RANDOM 0x2 /* expect random accesses */ 137 138#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 139#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 140 141#ifdef KERNEL 142 143TAILQ_HEAD(object_q, vm_object); 144 145extern struct object_q vm_object_list; /* list of allocated objects */ 146 147 /* lock for object list and count */ 148 149extern vm_object_t kernel_object; /* the single kernel object */ 150extern vm_object_t kmem_object; 151 152#endif /* KERNEL */ 153 154#ifdef KERNEL 155static __inline void 156vm_object_pip_wakeup(vm_object_t object) 157{ 158 object->paging_in_progress--; 159 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) { 160 object->flags &= ~OBJ_PIPWNT; 161 wakeup(object); 162 } 163} 164 165vm_object_t vm_object_allocate __P((objtype_t, vm_size_t)); 166void _vm_object_allocate __P((objtype_t, vm_size_t, vm_object_t)); 167boolean_t vm_object_coalesce __P((vm_object_t, vm_pindex_t, vm_size_t, vm_size_t)); 168void vm_object_collapse __P((vm_object_t)); 169void vm_object_copy __P((vm_object_t, vm_pindex_t, vm_object_t *, vm_pindex_t *, boolean_t *)); 170void vm_object_deallocate __P((vm_object_t)); 171void vm_object_terminate __P((vm_object_t)); 172void vm_object_dispose __P((vm_object_t)); 173void vm_object_vndeallocate __P((vm_object_t)); 174void vm_object_init __P((void)); 175void vm_object_page_clean __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t)); 176void vm_object_page_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t)); 177void vm_object_pmap_copy __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 178void vm_object_pmap_copy_1 __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 179void vm_object_pmap_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t)); 180void vm_object_reference __P((vm_object_t)); 181void vm_object_shadow __P((vm_object_t *, vm_ooffset_t *, vm_size_t)); 182void vm_object_madvise __P((vm_object_t, vm_pindex_t, int, int)); 183void vm_object_init2 __P((void)); 184#endif /* KERNEL */ 185 186#endif /* _VM_OBJECT_ */ 187