FreeBSD/Linux Kernel Cross Reference
sys/vm/vm_object.h
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 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94
37 *
38 *
39 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40 * All rights reserved.
41 *
42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43 *
44 * Permission to use, copy, modify and distribute this software and
45 * its documentation is hereby granted, provided that both the copyright
46 * notice and this permission notice appear in all copies of the
47 * software, derivative works or modified versions, and any portions
48 * thereof, and that both notices appear in supporting documentation.
49 *
50 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53 *
54 * Carnegie Mellon requests users of this software to return to
55 *
56 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
57 * School of Computer Science
58 * Carnegie Mellon University
59 * Pittsburgh PA 15213-3890
60 *
61 * any improvements or extensions that they make and grant Carnegie the
62 * rights to redistribute these changes.
63 *
64 * $FreeBSD: releng/5.2/sys/vm/vm_object.h 122349 2003-11-09 05:25:35Z alc $
65 */
66
67 /*
68 * Virtual memory object module definitions.
69 */
70
71 #ifndef _VM_OBJECT_
72 #define _VM_OBJECT_
73
74 #include <sys/queue.h>
75 #include <sys/_lock.h>
76 #include <sys/_mutex.h>
77
78 enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
79 OBJT_DEAD };
80 typedef u_char objtype_t;
81
82 /*
83 * Types defined:
84 *
85 * vm_object_t Virtual memory object.
86 *
87 * List of locks
88 * (c) const until freed
89 *
90 */
91
92 struct vm_object {
93 struct mtx mtx;
94 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
95 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
96 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
97 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
98 vm_page_t root; /* root of the resident page splay tree */
99 vm_pindex_t size; /* Object size */
100 int generation; /* generation ID */
101 int ref_count; /* How many refs?? */
102 int shadow_count; /* how many objects that this is a shadow for */
103 objtype_t type; /* type of pager */
104 u_short flags; /* see below */
105 u_short pg_color; /* (c) color of first page in obj */
106 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
107 int resident_page_count; /* number of resident pages */
108 struct vm_object *backing_object; /* object that I'm a shadow of */
109 vm_ooffset_t backing_object_offset;/* Offset in backing object */
110 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
111 void *handle;
112 union {
113 /*
114 * VNode pager
115 *
116 * vnp_size - current size of file
117 */
118 struct {
119 off_t vnp_size;
120 } vnp;
121
122 /*
123 * Device pager
124 *
125 * devp_pglist - list of allocated pages
126 */
127 struct {
128 TAILQ_HEAD(, vm_page) devp_pglist;
129 } devp;
130
131 /*
132 * Swap pager
133 *
134 * swp_bcount - number of swap 'swblock' metablocks, each
135 * contains up to 16 swapblk assignments.
136 * see vm/swap_pager.h
137 */
138 struct {
139 int swp_bcount;
140 } swp;
141 } un_pager;
142 };
143
144 /*
145 * Flags
146 */
147 #define OBJ_ACTIVE 0x0004 /* active objects */
148 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
149 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
150 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
151 #define OBJ_WRITEABLE 0x0080 /* object has been made writable */
152 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
153 #define OBJ_CLEANING 0x0200
154 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
155
156 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
157 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
158
159 #ifdef _KERNEL
160
161 #define OBJPC_SYNC 0x1 /* sync I/O */
162 #define OBJPC_INVAL 0x2 /* invalidate */
163 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
164
165 TAILQ_HEAD(object_q, vm_object);
166
167 extern struct object_q vm_object_list; /* list of allocated objects */
168 extern struct mtx vm_object_list_mtx; /* lock for object list and count */
169
170 extern struct vm_object kernel_object_store;
171 extern struct vm_object kmem_object_store;
172
173 #define kernel_object (&kernel_object_store)
174 #define kmem_object (&kmem_object_store)
175
176 #define VM_OBJECT_LOCK(object) mtx_lock(&(object)->mtx)
177 #define VM_OBJECT_LOCK_ASSERT(object, type) \
178 mtx_assert(&(object)->mtx, (type))
179 #define VM_OBJECT_LOCK_INIT(object) mtx_init(&(object)->mtx, "vm object", \
180 NULL, MTX_DEF | MTX_DUPOK)
181 #define VM_OBJECT_LOCKED(object) mtx_owned(&(object)->mtx)
182 #define VM_OBJECT_MTX(object) (&(object)->mtx)
183 #define VM_OBJECT_TRYLOCK(object) mtx_trylock(&(object)->mtx)
184 #define VM_OBJECT_UNLOCK(object) mtx_unlock(&(object)->mtx)
185
186 /*
187 * The object must be locked or thread private.
188 */
189 static __inline void
190 vm_object_set_flag(vm_object_t object, u_short bits)
191 {
192
193 object->flags |= bits;
194 }
195
196 void vm_object_clear_flag(vm_object_t object, u_short bits);
197 void vm_object_pip_add(vm_object_t object, short i);
198 void vm_object_pip_subtract(vm_object_t object, short i);
199 void vm_object_pip_wakeup(vm_object_t object);
200 void vm_object_pip_wakeupn(vm_object_t object, short i);
201 void vm_object_pip_wait(vm_object_t object, char *waitid);
202
203 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
204 vm_object_t vm_object_allocate_wait (objtype_t, vm_pindex_t, int);
205 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
206 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
207 void vm_object_collapse (vm_object_t);
208 void vm_object_deallocate (vm_object_t);
209 void vm_object_terminate (vm_object_t);
210 void vm_object_vndeallocate (vm_object_t);
211 void vm_object_set_writeable_dirty (vm_object_t);
212 void vm_object_init (void);
213 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
214 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
215 void vm_object_reference (vm_object_t);
216 void vm_object_reference_locked(vm_object_t);
217 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
218 void vm_object_split(vm_map_entry_t);
219 void vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t,
220 boolean_t);
221 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
222 #endif /* _KERNEL */
223
224 #endif /* _VM_OBJECT_ */
Cache object: 9806805bbb2079da70eecf6596e11744
|