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 #ifndef _MACHINE_PMAP_H_
86 #include <machine/pmap.h>
88 #ifndef _MACHINE_ATOMIC_H_
89 #include <machine/atomic.h>
94 #ifndef _VM_VM_PAGE_H_
95 #include <vm/vm_page.h>
97 #ifndef _SYS_THREAD_H_
98 #include <sys/thread.h>
103 #ifndef _SYS_THREAD2_H_
104 #include <sys/thread2.h>
107 #ifndef _SYS_REFCOUNT_H_
108 #include <sys/refcount.h>
114 struct swblock_rb_tree;
115 int rb_swblock_compare(struct swblock *, struct swblock *);
117 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare,
122 OBJT_SWAP, /* object backed by swap blocks */
123 OBJT_VNODE, /* object backed by file pages (vnode) */
124 OBJT_DEVICE, /* object backed by device pages */
125 OBJT_PHYS, /* object backed by physical pages */
126 OBJT_DEAD, /* dead object */
127 OBJT_MARKER /* marker object */
129 typedef u_char objtype_t;
132 * vm_object A VM object which represents an arbitrarily sized
135 * Locking requirements:
136 * vmobj_token for object_list
138 * vm_object_hold/drop() for most vm_object related operations.
140 * OBJ_CHAINLOCK to avoid chain/shadow object collisions
143 TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */
144 LIST_HEAD(, vm_object) shadow_head; /* objects we are a shadow for */
145 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
146 RB_HEAD(vm_page_rb_tree, vm_page) rb_memq; /* resident pages */
147 int generation; /* generation ID */
148 vm_pindex_t size; /* Object size */
150 int shadow_count; /* count of objs we are a shadow for */
151 objtype_t type; /* type of pager */
152 u_short flags; /* see below */
153 u_short pg_color; /* color of first page in obj */
154 u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
155 int resident_page_count; /* number of resident pages */
156 u_int agg_pv_list_count; /* aggregate pv list count */
157 struct vm_object *backing_object; /* object that I'm a shadow of */
158 vm_ooffset_t backing_object_offset;/* Offset in backing object */
159 void *handle; /* control handle: vp, etc */
160 int hold_count; /* count prevents destruction */
162 #if defined(DEBUG_LOCKS)
164 * Record threads holding a vm_object
167 #define VMOBJ_DEBUG_ARRAY_SIZE (32)
168 u_int debug_hold_bitmap;
169 thread_t debug_hold_thrs[VMOBJ_DEBUG_ARRAY_SIZE];
170 char *debug_hold_file[VMOBJ_DEBUG_ARRAY_SIZE];
171 int debug_hold_line[VMOBJ_DEBUG_ARRAY_SIZE];
172 u_int debug_hold_ovfl;
179 * devp_pglist - list of allocated pages
182 TAILQ_HEAD(, vm_page) devp_pglist;
187 * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
188 * store. For vnodes the swap backing store acts as a fast
189 * data cache but the vnode contains the official data.
191 RB_HEAD(swblock_rb_tree, swblock) swblock_root;
193 struct lwkt_token token;
194 struct md_object md; /* machine specific (typ pmap) */
200 * NOTE: OBJ_ONEMAPPING only applies to DEFAULT and SWAP objects. It
201 * may be gratuitously re-cleared in other cases but will already be
202 * clear in those cases.
204 #define OBJ_CHAINLOCK 0x0001 /* backing_object/shadow changing */
205 #define OBJ_CHAINWANT 0x0002
206 #define OBJ_ACTIVE 0x0004 /* active objects */
207 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
208 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
209 #define OBJ_UNUSED0040 0x0040
210 #define OBJ_WRITEABLE 0x0080 /* object has been made writable */
211 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
212 #define OBJ_CLEANING 0x0200
213 #define OBJ_DEADWNT 0x1000 /* waiting because object is dead */
214 #define OBJ_ONEMAPPING 0x2000 /* flag single vm_map_entry mapping */
215 #define OBJ_NOMSYNC 0x4000 /* disable msync() system call */
217 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
218 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
222 #define OBJPC_SYNC 0x1 /* sync I/O */
223 #define OBJPC_INVAL 0x2 /* invalidate */
224 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
227 * Used to chain vm_object deallocations
229 struct vm_object_dealloc_list {
230 struct vm_object_dealloc_list *next;
234 TAILQ_HEAD(object_q, vm_object);
236 extern struct object_q vm_object_list; /* list of allocated objects */
238 /* lock for object list and count */
240 extern struct vm_object kernel_object; /* the single kernel object */
241 extern int vm_shared_fault;
247 #define VM_OBJECT_LOCK(object) vm_object_hold(object)
248 #define VM_OBJECT_UNLOCK(object) vm_object_drop(object)
251 vm_object_set_flag(vm_object_t object, u_int bits)
253 atomic_set_short(&object->flags, bits);
257 vm_object_clear_flag(vm_object_t object, u_int bits)
259 atomic_clear_short(&object->flags, bits);
263 vm_object_pip_add(vm_object_t object, u_int i)
265 refcount_acquire_n(&object->paging_in_progress, i);
269 vm_object_pip_wakeup_n(vm_object_t object, u_int i)
271 refcount_release_wakeup_n(&object->paging_in_progress, i);
275 vm_object_pip_wakeup(vm_object_t object)
277 vm_object_pip_wakeup_n(object, 1);
281 vm_object_pip_wait(vm_object_t object, char *waitid)
283 refcount_wait(&object->paging_in_progress, waitid);
286 static __inline lwkt_token_t
287 vm_object_token(vm_object_t obj)
289 return (&obj->token);
292 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
293 vm_object_t vm_object_allocate_hold (objtype_t, vm_pindex_t);
294 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
295 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
296 void vm_object_collapse (vm_object_t, struct vm_object_dealloc_list **);
297 void vm_object_deallocate (vm_object_t);
298 void vm_object_deallocate_locked (vm_object_t);
299 void vm_object_deallocate_list(struct vm_object_dealloc_list **);
300 void vm_object_terminate (vm_object_t);
301 void vm_object_set_writeable_dirty (vm_object_t);
302 void vm_object_init (void);
303 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
304 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
305 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
306 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
307 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
308 void vm_object_reference_locked (vm_object_t);
309 void vm_object_chain_wait (vm_object_t);
310 void vm_object_chain_acquire(vm_object_t object);
311 void vm_object_chain_release(vm_object_t object);
312 void vm_object_chain_release_all(vm_object_t object, vm_object_t stopobj);
313 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t, int);
314 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
315 void vm_object_init2 (void);
316 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t,
317 vm_prot_t, int, int, int *);
318 void vm_object_dead_sleep(vm_object_t, const char *);
319 void vm_object_dead_wakeup(vm_object_t);
320 void vm_object_lock_swap(void);
321 void vm_object_lock(vm_object_t);
322 void vm_object_lock_shared(vm_object_t);
323 void vm_object_unlock(vm_object_t);
326 void vm_object_hold(vm_object_t);
327 int vm_object_hold_maybe_shared(vm_object_t);
328 int vm_object_hold_try(vm_object_t);
329 void vm_object_hold_shared(vm_object_t);
331 #define vm_object_hold_maybe_shared(obj) \
332 debugvm_object_hold_maybe_shared(obj, __FILE__, __LINE__)
333 int debugvm_object_hold_maybe_shared(vm_object_t, char *, int);
334 #define vm_object_hold(obj) \
335 debugvm_object_hold(obj, __FILE__, __LINE__)
336 void debugvm_object_hold(vm_object_t, char *, int);
337 #define vm_object_hold_try(obj) \
338 debugvm_object_hold_try(obj, __FILE__, __LINE__)
339 int debugvm_object_hold_try(vm_object_t, char *, int);
340 #define vm_object_hold_shared(obj) \
341 debugvm_object_hold_shared(obj, __FILE__, __LINE__)
342 void debugvm_object_hold_shared(vm_object_t, char *, int);
345 void vm_object_drop(vm_object_t);
349 #endif /* _VM_VM_OBJECT_H_ */