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 * 3. 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 _CPU_ATOMIC_H_
89 #include <machine/atomic.h>
94 #ifndef _VM_VM_PAGE_H_
95 #include <vm/vm_page.h>
100 #ifndef _SYS_THREAD2_H_
101 #include <sys/thread2.h>
104 #ifndef _SYS_REFCOUNT_H_
105 #include <sys/refcount.h>
111 struct swblock_rb_tree
;
112 int rb_swblock_compare(struct swblock
*, struct swblock
*);
114 RB_PROTOTYPE2(swblock_rb_tree
, swblock
, swb_entry
, rb_swblock_compare
,
119 OBJT_SWAP
, /* object backed by swap blocks */
120 OBJT_VNODE
, /* object backed by file pages (vnode) */
121 OBJT_DEVICE
, /* object backed by device pages */
123 OBJT_PHYS
, /* object backed by physical pages */
124 OBJT_DEAD
, /* dead object */
125 OBJT_MARKER
/* marker object */
127 typedef u_char objtype_t
;
130 * A VM object which represents an arbitrarily sized data store.
133 * shadow_head is only used by OBJT_DEFAULT or OBJT_SWAP objects.
134 * OBJT_VNODE objects explicitly do not keep track of who is shadowing
138 * vmobj_tokens[n] for object_list, hashed by address.
140 * vm_object_hold/drop() for most vm_object related operations.
141 * OBJ_CHAINLOCK to avoid chain/shadow object collisions.
144 TAILQ_ENTRY(vm_object
) object_list
; /* locked by vmobj_tokens[n] */
145 LIST_HEAD(, vm_object
) shadow_head
; /* objects we are a shadow for */
146 LIST_ENTRY(vm_object
) shadow_list
; /* chain of shadow objects */
147 RB_HEAD(vm_page_rb_tree
, vm_page
) rb_memq
; /* resident pages */
148 int generation
; /* generation ID */
149 vm_pindex_t size
; /* Object size */
151 int shadow_count
; /* count of objs we are a shadow for */
152 vm_memattr_t memattr
; /* default memory attribute for pages */
153 objtype_t type
; /* type of pager */
154 u_short flags
; /* see below */
155 u_short pg_color
; /* color of first page in obj */
156 u_int paging_in_progress
; /* Paging (in or out) so don't collapse or destroy */
157 long resident_page_count
; /* number of resident pages */
159 struct vm_object
*backing_object
; /* object that I'm a shadow of */
160 vm_ooffset_t backing_object_offset
;/* Offset in backing object */
161 TAILQ_ENTRY(vm_object
) pager_object_list
; /* list of all objects of this pager type */
162 void *handle
; /* control handle: vp, etc */
163 int hold_count
; /* count prevents destruction */
165 #if defined(DEBUG_LOCKS)
167 * Record threads holding a vm_object
170 #define VMOBJ_DEBUG_ARRAY_SIZE (32)
171 char debug_hold_thrs
[VMOBJ_DEBUG_ARRAY_SIZE
][64];
172 const char *debug_hold_file
[VMOBJ_DEBUG_ARRAY_SIZE
];
173 int debug_hold_line
[VMOBJ_DEBUG_ARRAY_SIZE
];
181 * devp_pglist - list of allocated pages
184 TAILQ_HEAD(, vm_page
) devp_pglist
;
185 struct cdev_pager_ops
*ops
;
191 * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
192 * store. For vnodes the swap backing store acts as a fast
193 * data cache but the vnode contains the official data.
195 RB_HEAD(swblock_rb_tree
, swblock
) swblock_root
;
197 struct lwkt_token token
;
198 struct md_object md
; /* machine specific (typ pmap) */
199 uint32_t chainlk
;/* chaining lock */
205 * OBJ_ONEMAPPING - Only applies to DEFAULT and SWAP objects. It may be
206 * gratuitously re-cleared in other cases but will already
207 * be clear in those cases. It might not be set on other
208 * object types (particularly OBJT_VNODE).
210 * This flag indicates that any given page index within the
211 * object is only mapped to a single vm_map_entry. Split
212 * vm_map_entry's (denoting distinct non-overlapping page
213 * ranges) do not clear this flag. This flag is typically
216 * OBJ_NOPAGEIN - vn and tmpfs set this flag, indicating to swapoff
217 * that the objects aren't intended to have any vm_page's,
218 * only swap blocks. vn and tmpfs don't know how to deal
219 * with any actual pages.
221 #define OBJ_UNUSED0001 0x0001 /* backing_object/shadow changing */
222 #define OBJ_ONSHADOW 0x0002 /* backing_object on shadow list */
223 #define OBJ_ACTIVE 0x0004 /* active objects */
224 #define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
225 #define OBJ_NOSPLIT 0x0010 /* dont split this object */
226 #define OBJ_NOPAGEIN 0x0040 /* special OBJT_SWAP */
227 #define OBJ_WRITEABLE 0x0080 /* object has been made writable */
228 #define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
229 #define OBJ_CLEANING 0x0200
230 #define OBJ_DEADWNT 0x1000 /* waiting because object is dead */
231 #define OBJ_ONEMAPPING 0x2000
232 #define OBJ_NOMSYNC 0x4000 /* disable msync() system call */
234 #define CHAINLK_EXCL 0x80000000
235 #define CHAINLK_WAIT 0x40000000
236 #define CHAINLK_EXCLREQ 0x20000000
237 #define CHAINLK_MASK 0x1FFFFFFF
239 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
240 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
242 #define VMOBJ_HSIZE 64
243 #define VMOBJ_HMASK (VMOBJ_HSIZE - 1)
244 #define VMOBJ_HASH(obj) (&vm_object_hash[((intptr_t)(obj) >> 8) & VMOBJ_HMASK])
248 #define OBJPC_SYNC 0x1 /* sync I/O */
249 #define OBJPC_INVAL 0x2 /* invalidate */
250 #define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
253 * Used to chain vm_object deallocations
255 struct vm_object_dealloc_list
{
256 struct vm_object_dealloc_list
*next
;
260 TAILQ_HEAD(object_q
, vm_object
);
262 struct vm_object_hash
{
263 struct object_q list
;
264 struct lwkt_token token
;
267 extern struct vm_object_hash vm_object_hash
[VMOBJ_HSIZE
];
269 /* lock for object list and count */
271 extern struct vm_object kernel_object
; /* the single kernel object */
272 extern int vm_shared_fault
;
278 #define VM_OBJECT_LOCK(object) vm_object_hold(object)
279 #define VM_OBJECT_UNLOCK(object) vm_object_drop(object)
282 vm_object_set_flag(vm_object_t object
, u_int bits
)
284 atomic_set_short(&object
->flags
, bits
);
288 vm_object_clear_flag(vm_object_t object
, u_int bits
)
290 atomic_clear_short(&object
->flags
, bits
);
294 vm_object_pip_add(vm_object_t object
, u_int i
)
296 refcount_acquire_n(&object
->paging_in_progress
, i
);
300 vm_object_pip_wakeup_n(vm_object_t object
, u_int i
)
302 refcount_release_wakeup_n(&object
->paging_in_progress
, i
);
306 vm_object_pip_wakeup(vm_object_t object
)
308 vm_object_pip_wakeup_n(object
, 1);
312 vm_object_pip_wait(vm_object_t object
, char *waitid
)
314 refcount_wait(&object
->paging_in_progress
, waitid
);
317 static __inline lwkt_token_t
318 vm_object_token(vm_object_t obj
)
320 return (&obj
->token
);
323 vm_object_t
vm_object_allocate (objtype_t
, vm_pindex_t
);
324 vm_object_t
vm_object_allocate_hold (objtype_t
, vm_pindex_t
);
325 void _vm_object_allocate (objtype_t
, vm_pindex_t
, vm_object_t
);
326 boolean_t
vm_object_coalesce (vm_object_t
, vm_pindex_t
, vm_size_t
, vm_size_t
);
327 void vm_object_collapse (vm_object_t
, struct vm_object_dealloc_list
**);
328 void vm_object_deallocate_list(struct vm_object_dealloc_list
**);
329 void vm_object_terminate (vm_object_t
);
330 void vm_object_set_writeable_dirty (vm_object_t
);
331 void vm_object_init(vm_object_t
, vm_pindex_t
);
332 void vm_object_init1 (void);
333 void vm_object_page_clean (vm_object_t
, vm_pindex_t
, vm_pindex_t
, int);
334 void vm_object_page_remove (vm_object_t
, vm_pindex_t
, vm_pindex_t
, boolean_t
);
335 void vm_object_pmap_copy (vm_object_t
, vm_pindex_t
, vm_pindex_t
);
336 void vm_object_pmap_copy_1 (vm_object_t
, vm_pindex_t
, vm_pindex_t
);
337 void vm_object_pmap_remove (vm_object_t
, vm_pindex_t
, vm_pindex_t
);
338 void vm_object_chain_wait (vm_object_t object
, int shared
);
339 void vm_object_chain_acquire(vm_object_t object
, int shared
);
340 void vm_object_chain_release(vm_object_t object
);
341 void vm_object_chain_release_all(vm_object_t object
, vm_object_t stopobj
);
342 void vm_object_shadow (vm_object_t
*, vm_ooffset_t
*, vm_size_t
, int);
343 void vm_object_madvise (vm_object_t
, vm_pindex_t
, vm_pindex_t
, int);
344 void vm_object_init2 (void);
345 vm_page_t
vm_fault_object_page(vm_object_t
, vm_ooffset_t
,
346 vm_prot_t
, int, int *, int *);
347 void vm_object_lock_swap(void);
348 void vm_object_lock(vm_object_t
);
349 void vm_object_lock_shared(vm_object_t
);
350 void vm_object_unlock(vm_object_t
);
352 #if defined(DEBUG_LOCKS)
354 #define VMOBJDEBUG(x) debug ## x
355 #define VMOBJDBARGS , char *file, int line
356 #define VMOBJDBFWD , file, line
358 #define vm_object_hold(obj) \
359 debugvm_object_hold(obj, __FILE__, __LINE__)
360 #define vm_object_hold_try(obj) \
361 debugvm_object_hold_try(obj, __FILE__, __LINE__)
362 #define vm_object_hold_shared(obj) \
363 debugvm_object_hold_shared(obj, __FILE__, __LINE__)
364 #define vm_object_drop(obj) \
365 debugvm_object_drop(obj, __FILE__, __LINE__)
366 #define vm_object_reference_quick(obj) \
367 debugvm_object_reference_quick(obj, __FILE__, __LINE__)
368 #define vm_object_reference_locked(obj) \
369 debugvm_object_reference_locked(obj, __FILE__, __LINE__)
370 #define vm_object_reference_locked_chain_held(obj) \
371 debugvm_object_reference_locked_chain_held( \
372 obj, __FILE__, __LINE__)
373 #define vm_object_deallocate(obj) \
374 debugvm_object_deallocate(obj, __FILE__, __LINE__)
375 #define vm_object_deallocate_locked(obj) \
376 debugvm_object_deallocate_locked(obj, __FILE__, __LINE__)
380 #define VMOBJDEBUG(x) x
386 void VMOBJDEBUG(vm_object_hold
)(vm_object_t object VMOBJDBARGS
);
387 int VMOBJDEBUG(vm_object_hold_try
)(vm_object_t object VMOBJDBARGS
);
388 void VMOBJDEBUG(vm_object_hold_shared
)(vm_object_t object VMOBJDBARGS
);
389 void VMOBJDEBUG(vm_object_drop
)(vm_object_t object VMOBJDBARGS
);
390 void VMOBJDEBUG(vm_object_reference_quick
)(vm_object_t object VMOBJDBARGS
);
391 void VMOBJDEBUG(vm_object_reference_locked
)(vm_object_t object VMOBJDBARGS
);
392 void VMOBJDEBUG(vm_object_reference_locked_chain_held
)(
393 vm_object_t object VMOBJDBARGS
);
394 void VMOBJDEBUG(vm_object_deallocate
)(vm_object_t object VMOBJDBARGS
);
395 void VMOBJDEBUG(vm_object_deallocate_locked
)(vm_object_t object VMOBJDBARGS
);
397 void vm_object_upgrade(vm_object_t
);
398 void vm_object_downgrade(vm_object_t
);
402 #endif /* _VM_VM_OBJECT_H_ */