2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94
35 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36 * All rights reserved.
38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
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.
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.
50 * Carnegie Mellon requests users of this software to return to
52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
53 * School of Computer Science
54 * Carnegie Mellon University
55 * Pittsburgh PA 15213-3890
57 * any improvements or extensions that they make and grant Carnegie the
58 * rights to redistribute these changes.
60 * $FreeBSD: src/sys/vm/vm_object.h,v 1.63.2.3 2003/05/26 19:17:56 alc Exp $
64 * Virtual memory object module definitions.
67 #ifndef _VM_VM_OBJECT_H_
68 #define _VM_VM_OBJECT_H_
71 #include <sys/types.h>
73 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
74 #include <sys/systm.h>
77 #include <sys/queue.h>
82 #ifndef _SYS_THREAD_H_
83 #include <sys/thread.h>
85 #include <machine/atomic.h>
89 #ifndef _VM_VM_PAGE_H_
90 #include <vm/vm_page.h>
96 #include <sys/thread.h>
99 #ifndef _SYS_THREAD2_H_
100 #include <sys/thread2.h>
106 struct swblock_rb_tree;
107 int rb_swblock_compare(struct swblock *, struct swblock *);
109 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare,
114 OBJT_SWAP, /* object backed by swap blocks */
115 OBJT_VNODE, /* object backed by file pages (vnode) */
116 OBJT_DEVICE, /* object backed by device pages */
117 OBJT_PHYS, /* object backed by physical pages */
118 OBJT_DEAD, /* dead object */
119 OBJT_MARKER /* marker object */
121 typedef u_char objtype_t;
124 * vm_object A VM object which represents an arbitrarily sized
127 * Locking requirements: vmobj_token for ref_count and object_list, and
128 * vm_token for everything else.
131 TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */
132 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
133 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
134 RB_HEAD(vm_page_rb_tree, vm_page) rb_memq; /* resident pages */
135 int generation; /* generation ID */
136 vm_pindex_t size; /* Object size */
137 int ref_count; /* vmobj_token */
138 int shadow_count; /* how many objects that this is a shadow for */
139 objtype_t type; /* type of pager */
140 u_short flags; /* see below */
141 u_short pg_color; /* color of first page in obj */
142 int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
143 int resident_page_count; /* number of resident pages */
144 u_int agg_pv_list_count; /* aggregate pv list count */
145 struct vm_object *backing_object; /* object that I'm a shadow of */
146 vm_ooffset_t backing_object_offset;/* Offset in backing object */
148 int hold_count; /* refcount for object liveness */
150 #if defined(DEBUG_LOCKS)
152 * Record threads holding a vm_object
155 #define VMOBJ_DEBUG_ARRAY_SIZE (32)
156 u_int debug_hold_bitmap;
157 thread_t debug_hold_thrs[VMOBJ_DEBUG_ARRAY_SIZE];
158 u_int debug_hold_ovfl;
165 * devp_pglist - list of allocated pages
168 TAILQ_HEAD(, vm_page) devp_pglist;
173 * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
174 * store. For vnodes the swap backing store acts as a fast
175 * data cache but the vnode contains the official data.
177 RB_HEAD(swblock_rb_tree, swblock) swblock_root;
184 #define OBJ_ACTIVE 0x0004 /* active objects */
185 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
186 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
187 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
188 #define OBJ_WRITEABLE 0x0080 /* object has been made writable */
189 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
190 #define OBJ_CLEANING 0x0200
191 #define OBJ_DEADWNT 0x1000 /* waiting because object is dead */
192 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
193 #define OBJ_NOMSYNC 0x4000 /* disable msync() system call */
195 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
196 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
200 #define OBJPC_SYNC 0x1 /* sync I/O */
201 #define OBJPC_INVAL 0x2 /* invalidate */
202 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
204 TAILQ_HEAD(object_q, vm_object);
206 extern struct object_q vm_object_list; /* list of allocated objects */
208 /* lock for object list and count */
210 extern struct vm_object kernel_object; /* the single kernel object */
217 vm_object_set_flag(vm_object_t object, u_int bits)
219 atomic_set_short(&object->flags, bits);
223 vm_object_clear_flag(vm_object_t object, u_int bits)
225 atomic_clear_short(&object->flags, bits);
229 vm_object_pip_add(vm_object_t object, int i)
231 atomic_add_int(&object->paging_in_progress, i);
235 vm_object_pip_subtract(vm_object_t object, int i)
237 atomic_subtract_int(&object->paging_in_progress, i);
241 vm_object_pip_wakeupn(vm_object_t object, int i)
244 atomic_subtract_int(&object->paging_in_progress, i);
245 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
246 vm_object_clear_flag(object, OBJ_PIPWNT);
252 vm_object_pip_wakeup(vm_object_t object)
254 vm_object_pip_wakeupn(object, 1);
258 vm_object_pip_sleep(vm_object_t object, char *waitid)
260 if (object->paging_in_progress) {
262 if (object->paging_in_progress) {
263 vm_object_set_flag(object, OBJ_PIPWNT);
264 tsleep(object, 0, waitid, 0);
271 vm_object_pip_wait(vm_object_t object, char *waitid)
273 while (object->paging_in_progress)
274 vm_object_pip_sleep(object, waitid);
277 static __inline lwkt_token_t
278 vm_object_token(vm_object_t obj)
280 return (lwkt_token_pool_lookup(obj));
283 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
284 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
285 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
286 void vm_object_collapse (vm_object_t);
287 void vm_object_deallocate (vm_object_t);
288 void vm_object_deallocate_locked (vm_object_t);
289 void vm_object_terminate (vm_object_t);
290 void vm_object_set_writeable_dirty (vm_object_t);
291 void vm_object_init (void);
292 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
293 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
294 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
295 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
296 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
297 void vm_object_reference (vm_object_t);
298 void vm_object_reference_locked (vm_object_t);
299 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
300 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
301 void vm_object_init2 (void);
302 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t, vm_prot_t, int, int *);
303 void vm_object_dead_sleep(vm_object_t, const char *);
304 void vm_object_dead_wakeup(vm_object_t);
305 void vm_object_lock(vm_object_t);
306 void vm_object_unlock(vm_object_t);
307 void vm_object_hold(vm_object_t);
308 void vm_object_drop(vm_object_t);
312 #endif /* _VM_VM_OBJECT_H_ */