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.
64 * Virtual memory object module definitions.
70 #include <sys/queue.h>
71 #include <sys/_lock.h>
72 #include <sys/_mutex.h>
77 * vm_object_t Virtual memory object.
80 * (c) const until freed
86 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
87 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
88 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
89 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
90 vm_page_t root; /* root of the resident page splay tree */
91 vm_pindex_t size; /* Object size */
92 int generation; /* generation ID */
93 int ref_count; /* How many refs?? */
94 int shadow_count; /* how many objects that this is a shadow for */
95 vm_memattr_t memattr; /* default memory attribute for pages */
96 objtype_t type; /* type of pager */
97 u_short flags; /* see below */
98 u_short pg_color; /* (c) color of first page in obj */
99 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
100 int resident_page_count; /* number of resident pages */
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 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
104 LIST_HEAD(, vm_reserv) rvq; /* list of reservations */
105 vm_page_t cache; /* root of the cache page splay tree */
111 * vnp_size - current size of file
120 * devp_pglist - list of allocated pages
123 TAILQ_HEAD(, vm_page) devp_pglist;
129 * sgp_pglist - list of allocated pages
132 TAILQ_HEAD(, vm_page) sgp_pglist;
138 * swp_bcount - number of swap 'swblock' metablocks, each
139 * contains up to 16 swapblk assignments.
140 * see vm/swap_pager.h
153 #define OBJ_ACTIVE 0x0004 /* active objects */
154 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
155 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
156 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
157 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty, only for vnode */
158 #define OBJ_COLORED 0x1000 /* pg_color is defined */
159 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
160 #define OBJ_DISCONNECTWNT 0x4000 /* disconnect from vnode wanted */
162 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
163 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
167 #define OBJPC_SYNC 0x1 /* sync I/O */
168 #define OBJPC_INVAL 0x2 /* invalidate */
169 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
172 * The following options are supported by vm_object_page_remove().
174 #define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */
175 #define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */
177 TAILQ_HEAD(object_q, vm_object);
179 extern struct object_q vm_object_list; /* list of allocated objects */
180 extern struct mtx vm_object_list_mtx; /* lock for object list and count */
182 extern struct vm_object kernel_object_store;
183 extern struct vm_object kmem_object_store;
185 #define kernel_object (&kernel_object_store)
186 #define kmem_object (&kmem_object_store)
188 #define VM_OBJECT_LOCK(object) mtx_lock(&(object)->mtx)
189 #define VM_OBJECT_LOCK_ASSERT(object, type) \
190 mtx_assert(&(object)->mtx, (type))
191 #define VM_OBJECT_LOCK_INIT(object, type) \
192 mtx_init(&(object)->mtx, "vm object", \
193 (type), MTX_DEF | MTX_DUPOK)
194 #define VM_OBJECT_LOCKED(object) mtx_owned(&(object)->mtx)
195 #define VM_OBJECT_MTX(object) (&(object)->mtx)
196 #define VM_OBJECT_TRYLOCK(object) mtx_trylock(&(object)->mtx)
197 #define VM_OBJECT_UNLOCK(object) mtx_unlock(&(object)->mtx)
200 * The object must be locked or thread private.
203 vm_object_set_flag(vm_object_t object, u_short bits)
206 object->flags |= bits;
209 void vm_object_clear_flag(vm_object_t object, u_short bits);
210 void vm_object_pip_add(vm_object_t object, short i);
211 void vm_object_pip_subtract(vm_object_t object, short i);
212 void vm_object_pip_wakeup(vm_object_t object);
213 void vm_object_pip_wakeupn(vm_object_t object, short i);
214 void vm_object_pip_wait(vm_object_t object, char *waitid);
216 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
217 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
218 boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t,
220 void vm_object_collapse (vm_object_t);
221 void vm_object_deallocate (vm_object_t);
222 void vm_object_destroy (vm_object_t);
223 void vm_object_terminate (vm_object_t);
224 void vm_object_set_writeable_dirty (vm_object_t);
225 void vm_object_init (void);
226 void vm_object_page_clean(vm_object_t object, vm_ooffset_t start,
227 vm_ooffset_t end, int flags);
228 void vm_object_page_remove(vm_object_t object, vm_pindex_t start,
229 vm_pindex_t end, int options);
230 boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t);
231 void vm_object_print(long addr, boolean_t have_addr, long count, char *modif);
232 void vm_object_reference (vm_object_t);
233 void vm_object_reference_locked(vm_object_t);
234 int vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr);
235 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
236 void vm_object_split(vm_map_entry_t);
237 void vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t,
239 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
242 #endif /* _VM_OBJECT_ */