vm_object.h revision 248084
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: head/sys/vm/vm_object.h 248084 2013-03-09 02:32:23Z attilio $ 61 */ 62 63/* 64 * Virtual memory object module definitions. 65 */ 66 67#ifndef _VM_OBJECT_ 68#define _VM_OBJECT_ 69 70#include <sys/queue.h> 71#include <sys/_lock.h> 72#include <sys/_mutex.h> 73#include <sys/_rwlock.h> 74 75/* 76 * Types defined: 77 * 78 * vm_object_t Virtual memory object. 79 * 80 * The root of cached pages pool is protected by both the per-object lock 81 * and the free pages queue mutex. 82 * On insert in the cache splay tree, the per-object lock is expected 83 * to be already held and the free pages queue mutex will be 84 * acquired during the operation too. 85 * On remove and lookup from the cache splay tree, only the free 86 * pages queue mutex is expected to be locked. 87 * These rules allow for reliably checking for the presence of cached 88 * pages with only the per-object lock held, thereby reducing contention 89 * for the free pages queue mutex. 90 * 91 * List of locks 92 * (c) const until freed 93 * (o) per-object lock 94 * (f) free pages queue mutex 95 * 96 */ 97 98struct vm_object { 99 struct rwlock lock; 100 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 101 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 102 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 103 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 104 vm_page_t root; /* root of the resident page splay tree */ 105 vm_pindex_t size; /* Object size */ 106 int generation; /* generation ID */ 107 int ref_count; /* How many refs?? */ 108 int shadow_count; /* how many objects that this is a shadow for */ 109 vm_memattr_t memattr; /* default memory attribute for pages */ 110 objtype_t type; /* type of pager */ 111 u_short flags; /* see below */ 112 u_short pg_color; /* (c) color of first page in obj */ 113 u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 114 int resident_page_count; /* number of resident pages */ 115 struct vm_object *backing_object; /* object that I'm a shadow of */ 116 vm_ooffset_t backing_object_offset;/* Offset in backing object */ 117 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 118 LIST_HEAD(, vm_reserv) rvq; /* list of reservations */ 119 vm_page_t cache; /* (o + f) root of the cache page splay tree */ 120 void *handle; 121 union { 122 /* 123 * VNode pager 124 * 125 * vnp_size - current size of file 126 */ 127 struct { 128 off_t vnp_size; 129 vm_ooffset_t writemappings; 130 } vnp; 131 132 /* 133 * Device pager 134 * 135 * devp_pglist - list of allocated pages 136 */ 137 struct { 138 TAILQ_HEAD(, vm_page) devp_pglist; 139 struct cdev_pager_ops *ops; 140 struct cdev *dev; 141 } devp; 142 143 /* 144 * SG pager 145 * 146 * sgp_pglist - list of allocated pages 147 */ 148 struct { 149 TAILQ_HEAD(, vm_page) sgp_pglist; 150 } sgp; 151 152 /* 153 * Swap pager 154 * 155 * swp_bcount - number of swap 'swblock' metablocks, each 156 * contains up to 16 swapblk assignments. 157 * see vm/swap_pager.h 158 */ 159 struct { 160 int swp_bcount; 161 } swp; 162 } un_pager; 163 struct ucred *cred; 164 vm_ooffset_t charge; 165}; 166 167/* 168 * Flags 169 */ 170#define OBJ_FICTITIOUS 0x0001 /* (c) contains fictitious pages */ 171#define OBJ_UNMANAGED 0x0002 /* (c) contains unmanaged pages */ 172#define OBJ_ACTIVE 0x0004 /* active objects */ 173#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 174#define OBJ_NOSPLIT 0x0010 /* dont split this object */ 175#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 176#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty, only for vnode */ 177#define OBJ_COLORED 0x1000 /* pg_color is defined */ 178#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 179#define OBJ_DISCONNECTWNT 0x4000 /* disconnect from vnode wanted */ 180 181#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 182#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 183 184#ifdef _KERNEL 185 186#define OBJPC_SYNC 0x1 /* sync I/O */ 187#define OBJPC_INVAL 0x2 /* invalidate */ 188#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */ 189 190/* 191 * The following options are supported by vm_object_page_remove(). 192 */ 193#define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */ 194#define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */ 195 196TAILQ_HEAD(object_q, vm_object); 197 198extern struct object_q vm_object_list; /* list of allocated objects */ 199extern struct mtx vm_object_list_mtx; /* lock for object list and count */ 200 201extern struct vm_object kernel_object_store; 202extern struct vm_object kmem_object_store; 203 204#define kernel_object (&kernel_object_store) 205#define kmem_object (&kmem_object_store) 206 207#define VM_OBJECT_ASSERT_LOCKED(object) \ 208 rw_assert(&(object)->lock, RA_LOCKED) 209#define VM_OBJECT_ASSERT_RLOCKED(object) \ 210 rw_assert(&(object)->lock, RA_RLOCKED) 211#define VM_OBJECT_ASSERT_WLOCKED(object) \ 212 rw_assert(&(object)->lock, RA_WLOCKED) 213#define VM_OBJECT_RLOCK(object) \ 214 rw_rlock(&(object)->lock) 215#define VM_OBJECT_RUNLOCK(object) \ 216 rw_runlock(&(object)->lock) 217#define VM_OBJECT_SLEEP(object, wchan, pri, wmesg, timo) \ 218 rw_sleep((wchan), &(object)->lock, (pri), (wmesg), (timo)) 219#define VM_OBJECT_TRYRLOCK(object) \ 220 rw_try_rlock(&(object)->lock) 221#define VM_OBJECT_TRYWLOCK(object) \ 222 rw_try_wlock(&(object)->lock) 223#define VM_OBJECT_WLOCK(object) \ 224 rw_wlock(&(object)->lock) 225#define VM_OBJECT_WUNLOCK(object) \ 226 rw_wunlock(&(object)->lock) 227 228/* 229 * The object must be locked or thread private. 230 */ 231static __inline void 232vm_object_set_flag(vm_object_t object, u_short bits) 233{ 234 235 object->flags |= bits; 236} 237 238void vm_object_clear_flag(vm_object_t object, u_short bits); 239void vm_object_pip_add(vm_object_t object, short i); 240void vm_object_pip_subtract(vm_object_t object, short i); 241void vm_object_pip_wakeup(vm_object_t object); 242void vm_object_pip_wakeupn(vm_object_t object, short i); 243void vm_object_pip_wait(vm_object_t object, char *waitid); 244 245static __inline boolean_t 246vm_object_cache_is_empty(vm_object_t object) 247{ 248 249 return (object->cache == NULL); 250} 251 252vm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 253boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t, 254 boolean_t); 255void vm_object_collapse (vm_object_t); 256void vm_object_deallocate (vm_object_t); 257void vm_object_destroy (vm_object_t); 258void vm_object_terminate (vm_object_t); 259void vm_object_set_writeable_dirty (vm_object_t); 260void vm_object_init (void); 261void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int); 262void vm_object_page_cache(vm_object_t object, vm_pindex_t start, 263 vm_pindex_t end); 264boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start, 265 vm_ooffset_t end, int flags); 266void vm_object_page_remove(vm_object_t object, vm_pindex_t start, 267 vm_pindex_t end, int options); 268boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t); 269void vm_object_print(long addr, boolean_t have_addr, long count, char *modif); 270void vm_object_reference (vm_object_t); 271void vm_object_reference_locked(vm_object_t); 272int vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr); 273void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 274void vm_object_split(vm_map_entry_t); 275boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t, 276 boolean_t); 277#endif /* _KERNEL */ 278 279#endif /* _VM_OBJECT_ */ 280