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$
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 #include <vm/_vm_radix.h>
76
77 /*
78 * Types defined:
79 *
80 * vm_object_t Virtual memory object.
81 *
82 *
83 * List of locks
84 * (c) const until freed
85 * (o) per-object lock
86 * (f) free pages queue mutex
87 *
88 */
89
90 struct vm_object {
91 struct rwlock lock;
92 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
93 LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
94 LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
95 TAILQ_HEAD(respgs, vm_page) memq; /* list of resident pages */
96 struct vm_radix rtree; /* root of the resident page radix trie*/
97 vm_pindex_t size; /* Object size */
98 int generation; /* generation ID */
99 int ref_count; /* How many refs?? */
100 int shadow_count; /* how many objects that this is a shadow for */
101 vm_memattr_t memattr; /* default memory attribute for pages */
102 objtype_t type; /* type of pager */
103 u_short flags; /* see below */
104 u_short pg_color; /* (c) color of first page in obj */
105 u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
106 int resident_page_count; /* number of resident pages */
107 struct vm_object *backing_object; /* object that I'm a shadow of */
108 vm_ooffset_t backing_object_offset;/* Offset in backing object */
109 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
110 LIST_HEAD(, vm_reserv) rvq; /* list of reservations */
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 vm_ooffset_t writemappings;
121 } vnp;
122
123 /*
124 * Device pager
125 *
126 * devp_pglist - list of allocated pages
127 */
128 struct {
129 TAILQ_HEAD(, vm_page) devp_pglist;
130 struct cdev_pager_ops *ops;
131 struct cdev *dev;
132 } devp;
133
134 /*
135 * SG pager
136 *
137 * sgp_pglist - list of allocated pages
138 */
139 struct {
140 TAILQ_HEAD(, vm_page) sgp_pglist;
141 } sgp;
142
143 /*
144 * Swap pager
145 *
146 * swp_tmpfs - back-pointer to the tmpfs vnode,
147 * if any, which uses the vm object
148 * as backing store. The handle
149 * cannot be reused for linking,
150 * because the vnode can be
151 * reclaimed and recreated, making
152 * the handle changed and hash-chain
153 * invalid.
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 void *swp_tmpfs;
161 int swp_bcount;
162 } swp;
163 } un_pager;
164 struct ucred *cred;
165 vm_ooffset_t charge;
166 };
167
168 /*
169 * Flags
170 */
171 #define OBJ_FICTITIOUS 0x0001 /* (c) contains fictitious pages */
172 #define OBJ_UNMANAGED 0x0002 /* (c) contains unmanaged pages */
173 #define OBJ_ACTIVE 0x0004 /* active objects */
174 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
175 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
176 #define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
177 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty, only for vnode */
178 #define OBJ_TMPFS_NODE 0x0200 /* object belongs to tmpfs VREG node */
179 #define OBJ_TMPFS_DIRTY 0x0400 /* dirty tmpfs obj */
180 #define OBJ_COLORED 0x1000 /* pg_color is defined */
181 #define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
182 #define OBJ_DISCONNECTWNT 0x4000 /* disconnect from vnode wanted */
183 #define OBJ_TMPFS 0x8000 /* has tmpfs vnode allocated */
184
185 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
186 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
187
188 #ifdef _KERNEL
189
190 #define OBJPC_SYNC 0x1 /* sync I/O */
191 #define OBJPC_INVAL 0x2 /* invalidate */
192 #define OBJPC_NOSYNC 0x4 /* skip if VPO_NOSYNC */
193
194 /*
195 * The following options are supported by vm_object_page_remove().
196 */
197 #define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */
198 #define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */
199
200 TAILQ_HEAD(object_q, vm_object);
201
202 extern struct object_q vm_object_list; /* list of allocated objects */
203 extern struct mtx vm_object_list_mtx; /* lock for object list and count */
204
205 extern struct vm_object kernel_object_store;
206 extern struct vm_object kmem_object_store;
207
208 #define kernel_object (&kernel_object_store)
209 #define kmem_object (&kmem_object_store)
210
211 #define VM_OBJECT_ASSERT_LOCKED(object) \
212 rw_assert(&(object)->lock, RA_LOCKED)
213 #define VM_OBJECT_ASSERT_RLOCKED(object) \
214 rw_assert(&(object)->lock, RA_RLOCKED)
215 #define VM_OBJECT_ASSERT_WLOCKED(object) \
216 rw_assert(&(object)->lock, RA_WLOCKED)
217 #define VM_OBJECT_ASSERT_UNLOCKED(object) \
218 rw_assert(&(object)->lock, RA_UNLOCKED)
219 #define VM_OBJECT_LOCK_DOWNGRADE(object) \
220 rw_downgrade(&(object)->lock)
221 #define VM_OBJECT_RLOCK(object) \
222 rw_rlock(&(object)->lock)
223 #define VM_OBJECT_RUNLOCK(object) \
224 rw_runlock(&(object)->lock)
225 #define VM_OBJECT_SLEEP(object, wchan, pri, wmesg, timo) \
226 rw_sleep((wchan), &(object)->lock, (pri), (wmesg), (timo))
227 #define VM_OBJECT_TRYRLOCK(object) \
228 rw_try_rlock(&(object)->lock)
229 #define VM_OBJECT_TRYWLOCK(object) \
230 rw_try_wlock(&(object)->lock)
231 #define VM_OBJECT_TRYUPGRADE(object) \
232 rw_try_upgrade(&(object)->lock)
233 #define VM_OBJECT_WLOCK(object) \
234 rw_wlock(&(object)->lock)
235 #define VM_OBJECT_WOWNED(object) \
236 rw_wowned(&(object)->lock)
237 #define VM_OBJECT_WUNLOCK(object) \
238 rw_wunlock(&(object)->lock)
239
240 /*
241 * The object must be locked or thread private.
242 */
243 static __inline void
vm_object_set_flag(vm_object_t object,u_short bits)244 vm_object_set_flag(vm_object_t object, u_short bits)
245 {
246
247 object->flags |= bits;
248 }
249
250 /*
251 * Conditionally set the object's color, which (1) enables the allocation
252 * of physical memory reservations for anonymous objects and larger-than-
253 * superpage-sized named objects and (2) determines the first page offset
254 * within the object at which a reservation may be allocated. In other
255 * words, the color determines the alignment of the object with respect
256 * to the largest superpage boundary. When mapping named objects, like
257 * files or POSIX shared memory objects, the color should be set to zero
258 * before a virtual address is selected for the mapping. In contrast,
259 * for anonymous objects, the color may be set after the virtual address
260 * is selected.
261 *
262 * The object must be locked.
263 */
264 static __inline void
vm_object_color(vm_object_t object,u_short color)265 vm_object_color(vm_object_t object, u_short color)
266 {
267
268 if ((object->flags & OBJ_COLORED) == 0) {
269 object->pg_color = color;
270 object->flags |= OBJ_COLORED;
271 }
272 }
273
274 void vm_object_clear_flag(vm_object_t object, u_short bits);
275 void vm_object_pip_add(vm_object_t object, short i);
276 void vm_object_pip_subtract(vm_object_t object, short i);
277 void vm_object_pip_wakeup(vm_object_t object);
278 void vm_object_pip_wakeupn(vm_object_t object, short i);
279 void vm_object_pip_wait(vm_object_t object, char *waitid);
280
281 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
282 boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t,
283 boolean_t);
284 void vm_object_collapse (vm_object_t);
285 void vm_object_deallocate (vm_object_t);
286 void vm_object_destroy (vm_object_t);
287 void vm_object_terminate (vm_object_t);
288 void vm_object_set_writeable_dirty (vm_object_t);
289 void vm_object_init (void);
290 void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int);
291 boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start,
292 vm_ooffset_t end, int flags);
293 void vm_object_page_noreuse(vm_object_t object, vm_pindex_t start,
294 vm_pindex_t end);
295 void vm_object_page_remove(vm_object_t object, vm_pindex_t start,
296 vm_pindex_t end, int options);
297 boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t);
298 void vm_object_print(long addr, boolean_t have_addr, long count, char *modif);
299 void vm_object_reference (vm_object_t);
300 void vm_object_reference_locked(vm_object_t);
301 int vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr);
302 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
303 void vm_object_split(vm_map_entry_t);
304 boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t,
305 boolean_t);
306 void vm_object_unwire(vm_object_t object, vm_ooffset_t offset,
307 vm_size_t length, uint8_t queue);
308 struct vnode *vm_object_vnode(vm_object_t object);
309 #endif /* _KERNEL */
310
311 #endif /* _VM_OBJECT_ */
312