xref: /original-bsd/sys/vm/vm_object.h (revision b8508f95)
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  * %sccs.include.redist.c%
9  *
10  *	@(#)vm_object.h	8.4 (Berkeley) 01/09/95
11  *
12  *
13  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
14  * All rights reserved.
15  *
16  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
17  *
18  * Permission to use, copy, modify and distribute this software and
19  * its documentation is hereby granted, provided that both the copyright
20  * notice and this permission notice appear in all copies of the
21  * software, derivative works or modified versions, and any portions
22  * thereof, and that both notices appear in supporting documentation.
23  *
24  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
25  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
26  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
27  *
28  * Carnegie Mellon requests users of this software to return to
29  *
30  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
31  *  School of Computer Science
32  *  Carnegie Mellon University
33  *  Pittsburgh PA 15213-3890
34  *
35  * any improvements or extensions that they make and grant Carnegie the
36  * rights to redistribute these changes.
37  */
38 
39 /*
40  *	Virtual memory object module definitions.
41  */
42 
43 #ifndef	_VM_OBJECT_
44 #define	_VM_OBJECT_
45 
46 #include <vm/vm_page.h>
47 #include <vm/vm_pager.h>
48 
49 /*
50  *	Types defined:
51  *
52  *	vm_object_t		Virtual memory object.
53  */
54 
55 struct vm_object {
56 	struct pglist		memq;		/* Resident memory */
57 	TAILQ_ENTRY(vm_object)	object_list;	/* list of all objects */
58 	u_short			flags;		/* see below */
59 	u_short			paging_in_progress; /* Paging (in or out) so
60 						    don't collapse or destroy */
61 	simple_lock_data_t	Lock;		/* Synchronization */
62 	int			ref_count;	/* How many refs?? */
63 	vm_size_t		size;		/* Object size */
64 	int			resident_page_count;
65 						/* number of resident pages */
66 	struct vm_object	*copy;		/* Object that holds copies of
67 						   my changed pages */
68 	vm_pager_t		pager;		/* Where to get data */
69 	vm_offset_t		paging_offset;	/* Offset into paging space */
70 	struct vm_object	*shadow;	/* My shadow */
71 	vm_offset_t		shadow_offset;	/* Offset in shadow */
72 	TAILQ_ENTRY(vm_object)	cached_list;	/* for persistence */
73 };
74 /*
75  * Flags
76  */
77 #define OBJ_CANPERSIST	0x0001	/* allow to persist */
78 #define OBJ_INTERNAL	0x0002	/* internally created object */
79 #define OBJ_ACTIVE	0x0004	/* used to mark active objects */
80 
81 TAILQ_HEAD(vm_object_hash_head, vm_object_hash_entry);
82 
83 struct vm_object_hash_entry {
84 	TAILQ_ENTRY(vm_object_hash_entry)  hash_links;	/* hash chain links */
85 	vm_object_t			   object;	/* object represented */
86 };
87 
88 typedef struct vm_object_hash_entry	*vm_object_hash_entry_t;
89 
90 #ifdef	KERNEL
91 TAILQ_HEAD(object_q, vm_object);
92 
93 struct object_q	vm_object_cached_list;	/* list of objects persisting */
94 int		vm_object_cached;	/* size of cached list */
95 simple_lock_data_t	vm_cache_lock;	/* lock for object cache */
96 
97 struct object_q	vm_object_list;		/* list of allocated objects */
98 long		vm_object_count;	/* count of all objects */
99 simple_lock_data_t	vm_object_list_lock;
100 					/* lock for object list and count */
101 
102 vm_object_t	kernel_object;		/* the single kernel object */
103 vm_object_t	kmem_object;
104 
105 #define	vm_object_cache_lock()		simple_lock(&vm_cache_lock)
106 #define	vm_object_cache_unlock()	simple_unlock(&vm_cache_lock)
107 #endif /* KERNEL */
108 
109 #define	vm_object_lock_init(object)	simple_lock_init(&(object)->Lock)
110 #define	vm_object_lock(object)		simple_lock(&(object)->Lock)
111 #define	vm_object_unlock(object)	simple_unlock(&(object)->Lock)
112 #define	vm_object_lock_try(object)	simple_lock_try(&(object)->Lock)
113 #define	vm_object_sleep(event, object, interruptible) \
114 			thread_sleep((event), &(object)->Lock, (interruptible))
115 
116 #ifdef KERNEL
117 vm_object_t	 vm_object_allocate __P((vm_size_t));
118 void		 vm_object_cache_clear __P((void));
119 void		 vm_object_cache_trim __P((void));
120 boolean_t	 vm_object_coalesce __P((vm_object_t, vm_object_t,
121 		    vm_offset_t, vm_offset_t, vm_offset_t, vm_size_t));
122 void		 vm_object_collapse __P((vm_object_t));
123 void		 vm_object_copy __P((vm_object_t, vm_offset_t, vm_size_t,
124 		    vm_object_t *, vm_offset_t *, boolean_t *));
125 void		 vm_object_deactivate_pages __P((vm_object_t));
126 void		 vm_object_deallocate __P((vm_object_t));
127 void		 vm_object_enter __P((vm_object_t, vm_pager_t));
128 void		 vm_object_init __P((vm_size_t));
129 vm_object_t	 vm_object_lookup __P((vm_pager_t));
130 boolean_t	 vm_object_page_clean __P((vm_object_t,
131 		    vm_offset_t, vm_offset_t, boolean_t, boolean_t));
132 void		 vm_object_page_remove __P((vm_object_t,
133 		    vm_offset_t, vm_offset_t));
134 void		 vm_object_pmap_copy __P((vm_object_t,
135 		    vm_offset_t, vm_offset_t));
136 void		 vm_object_pmap_remove __P((vm_object_t,
137 		    vm_offset_t, vm_offset_t));
138 void		 vm_object_print __P((vm_object_t, boolean_t));
139 void		 vm_object_reference __P((vm_object_t));
140 void		 vm_object_remove __P((vm_pager_t));
141 void		 vm_object_setpager __P((vm_object_t,
142 		    vm_pager_t, vm_offset_t, boolean_t));
143 void		 vm_object_shadow __P((vm_object_t *,
144 		    vm_offset_t *, vm_size_t));
145 void		 vm_object_terminate __P((vm_object_t));
146 #endif
147 #endif /* _VM_OBJECT_ */
148