xref: /csrg-svn/sys/vm/vm_object.h (revision 68161)
145748Smckusick /*
263379Sbostic  * Copyright (c) 1991, 1993
363379Sbostic  *	The Regents of the University of California.  All rights reserved.
445748Smckusick  *
545748Smckusick  * This code is derived from software contributed to Berkeley by
645748Smckusick  * The Mach Operating System project at Carnegie-Mellon University.
745748Smckusick  *
848493Smckusick  * %sccs.include.redist.c%
945748Smckusick  *
10*68161Scgd  *	@(#)vm_object.h	8.4 (Berkeley) 01/09/95
1148493Smckusick  *
1248493Smckusick  *
1348493Smckusick  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
1448493Smckusick  * All rights reserved.
1548493Smckusick  *
1648493Smckusick  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
1748493Smckusick  *
1848493Smckusick  * Permission to use, copy, modify and distribute this software and
1948493Smckusick  * its documentation is hereby granted, provided that both the copyright
2048493Smckusick  * notice and this permission notice appear in all copies of the
2148493Smckusick  * software, derivative works or modified versions, and any portions
2248493Smckusick  * thereof, and that both notices appear in supporting documentation.
2348493Smckusick  *
2448493Smckusick  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
2548493Smckusick  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
2648493Smckusick  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
2748493Smckusick  *
2848493Smckusick  * Carnegie Mellon requests users of this software to return to
2948493Smckusick  *
3048493Smckusick  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
3148493Smckusick  *  School of Computer Science
3248493Smckusick  *  Carnegie Mellon University
3348493Smckusick  *  Pittsburgh PA 15213-3890
3448493Smckusick  *
3548493Smckusick  * any improvements or extensions that they make and grant Carnegie the
3648493Smckusick  * rights to redistribute these changes.
3745748Smckusick  */
3845748Smckusick 
3945748Smckusick /*
4045748Smckusick  *	Virtual memory object module definitions.
4145748Smckusick  */
4245748Smckusick 
4345748Smckusick #ifndef	_VM_OBJECT_
4445748Smckusick #define	_VM_OBJECT_
4545748Smckusick 
4665126Smckusick #include <vm/vm_page.h>
4745748Smckusick #include <vm/vm_pager.h>
4845748Smckusick 
4945748Smckusick /*
5045748Smckusick  *	Types defined:
5145748Smckusick  *
5245748Smckusick  *	vm_object_t		Virtual memory object.
5345748Smckusick  */
5445748Smckusick 
5545748Smckusick struct vm_object {
5665126Smckusick 	struct pglist		memq;		/* Resident memory */
5765126Smckusick 	TAILQ_ENTRY(vm_object)	object_list;	/* list of all objects */
5850916Smckusick 	u_short			flags;		/* see below */
5950916Smckusick 	u_short			paging_in_progress; /* Paging (in or out) so
6050916Smckusick 						    don't collapse or destroy */
6145748Smckusick 	simple_lock_data_t	Lock;		/* Synchronization */
6245748Smckusick 	int			ref_count;	/* How many refs?? */
6345748Smckusick 	vm_size_t		size;		/* Object size */
6445748Smckusick 	int			resident_page_count;
6545748Smckusick 						/* number of resident pages */
6645748Smckusick 	struct vm_object	*copy;		/* Object that holds copies of
6745748Smckusick 						   my changed pages */
6845748Smckusick 	vm_pager_t		pager;		/* Where to get data */
6945748Smckusick 	vm_offset_t		paging_offset;	/* Offset into paging space */
7045748Smckusick 	struct vm_object	*shadow;	/* My shadow */
7145748Smckusick 	vm_offset_t		shadow_offset;	/* Offset in shadow */
7265126Smckusick 	TAILQ_ENTRY(vm_object)	cached_list;	/* for persistence */
7345748Smckusick };
7450916Smckusick /*
7550916Smckusick  * Flags
7650916Smckusick  */
7750916Smckusick #define OBJ_CANPERSIST	0x0001	/* allow to persist */
7850916Smckusick #define OBJ_INTERNAL	0x0002	/* internally created object */
7950916Smckusick #define OBJ_ACTIVE	0x0004	/* used to mark active objects */
8045748Smckusick 
8165126Smckusick TAILQ_HEAD(vm_object_hash_head, vm_object_hash_entry);
8265126Smckusick 
8345748Smckusick struct vm_object_hash_entry {
8465126Smckusick 	TAILQ_ENTRY(vm_object_hash_entry)  hash_links;	/* hash chain links */
85*68161Scgd 	vm_object_t			   object;	/* object represented */
8645748Smckusick };
8745748Smckusick 
8845748Smckusick typedef struct vm_object_hash_entry	*vm_object_hash_entry_t;
8945748Smckusick 
9045748Smckusick #ifdef	KERNEL
9165126Smckusick TAILQ_HEAD(object_q, vm_object);
9265126Smckusick 
9365126Smckusick struct object_q	vm_object_cached_list;	/* list of objects persisting */
9445748Smckusick int		vm_object_cached;	/* size of cached list */
9545748Smckusick simple_lock_data_t	vm_cache_lock;	/* lock for object cache */
9645748Smckusick 
9765126Smckusick struct object_q	vm_object_list;		/* list of allocated objects */
9845748Smckusick long		vm_object_count;	/* count of all objects */
9945748Smckusick simple_lock_data_t	vm_object_list_lock;
10045748Smckusick 					/* lock for object list and count */
10145748Smckusick 
10245748Smckusick vm_object_t	kernel_object;		/* the single kernel object */
10345748Smckusick vm_object_t	kmem_object;
10445748Smckusick 
10545748Smckusick #define	vm_object_cache_lock()		simple_lock(&vm_cache_lock)
10645748Smckusick #define	vm_object_cache_unlock()	simple_unlock(&vm_cache_lock)
10760337Storek #endif /* KERNEL */
10845748Smckusick 
10945748Smckusick #define	vm_object_lock_init(object)	simple_lock_init(&(object)->Lock)
11045748Smckusick #define	vm_object_lock(object)		simple_lock(&(object)->Lock)
11145748Smckusick #define	vm_object_unlock(object)	simple_unlock(&(object)->Lock)
11245748Smckusick #define	vm_object_lock_try(object)	simple_lock_try(&(object)->Lock)
11345748Smckusick #define	vm_object_sleep(event, object, interruptible) \
114*68161Scgd 			thread_sleep((event), &(object)->Lock, (interruptible))
11545748Smckusick 
11653331Sbostic #ifdef KERNEL
11753331Sbostic vm_object_t	 vm_object_allocate __P((vm_size_t));
11853331Sbostic void		 vm_object_cache_clear __P((void));
11953331Sbostic void		 vm_object_cache_trim __P((void));
12053331Sbostic boolean_t	 vm_object_coalesce __P((vm_object_t, vm_object_t,
12153331Sbostic 		    vm_offset_t, vm_offset_t, vm_offset_t, vm_size_t));
12253331Sbostic void		 vm_object_collapse __P((vm_object_t));
12353331Sbostic void		 vm_object_copy __P((vm_object_t, vm_offset_t, vm_size_t,
12453331Sbostic 		    vm_object_t *, vm_offset_t *, boolean_t *));
12553331Sbostic void		 vm_object_deactivate_pages __P((vm_object_t));
12653331Sbostic void		 vm_object_deallocate __P((vm_object_t));
12753331Sbostic void		 vm_object_enter __P((vm_object_t, vm_pager_t));
12853331Sbostic void		 vm_object_init __P((vm_size_t));
12953331Sbostic vm_object_t	 vm_object_lookup __P((vm_pager_t));
13065689Shibler boolean_t	 vm_object_page_clean __P((vm_object_t,
13165689Shibler 		    vm_offset_t, vm_offset_t, boolean_t, boolean_t));
13253331Sbostic void		 vm_object_page_remove __P((vm_object_t,
13353331Sbostic 		    vm_offset_t, vm_offset_t));
13453331Sbostic void		 vm_object_pmap_copy __P((vm_object_t,
13553331Sbostic 		    vm_offset_t, vm_offset_t));
13653331Sbostic void		 vm_object_pmap_remove __P((vm_object_t,
13753331Sbostic 		    vm_offset_t, vm_offset_t));
13853331Sbostic void		 vm_object_print __P((vm_object_t, boolean_t));
13953331Sbostic void		 vm_object_reference __P((vm_object_t));
14053331Sbostic void		 vm_object_remove __P((vm_pager_t));
14153331Sbostic void		 vm_object_setpager __P((vm_object_t,
14253331Sbostic 		    vm_pager_t, vm_offset_t, boolean_t));
14353331Sbostic void		 vm_object_shadow __P((vm_object_t *,
14453331Sbostic 		    vm_offset_t *, vm_size_t));
14553331Sbostic void		 vm_object_terminate __P((vm_object_t));
14653331Sbostic #endif
14760337Storek #endif /* _VM_OBJECT_ */
148