[unix-history] / usr / src / sys / vm / vm_object.h

/* 
 * Copyright (c) 1991 Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * The Mach Operating System project at Carnegie-Mellon University.
 *
 * %sccs.include.redist.c%
 *
 *	@(#)vm_object.h	7.6 (Berkeley) %G%
 *
 *
 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
 * 
 * Permission to use, copy, modify and distribute this software and
 * its documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

/*
 *	Virtual memory object module definitions.
 */

#ifndef	_VM_OBJECT_
#define	_VM_OBJECT_

#include <vm/vm_pager.h>

/*
 *	Types defined:
 *
 *	vm_object_t		Virtual memory object.
 */

struct vm_object {
	queue_chain_t		memq;		/* Resident memory */
	queue_chain_t		object_list;	/* list of all objects */
	u_short			flags;		/* see below */
	u_short			paging_in_progress; /* Paging (in or out) so
						    don't collapse or destroy */
	simple_lock_data_t	Lock;		/* Synchronization */
	int			LockHolder;
	int			ref_count;	/* How many refs?? */
	vm_size_t		size;		/* Object size */
	int			resident_page_count;
						/* number of resident pages */
	struct vm_object	*copy;		/* Object that holds copies of
						   my changed pages */
	vm_pager_t		pager;		/* Where to get data */
	vm_offset_t		paging_offset;	/* Offset into paging space */
	struct vm_object	*shadow;	/* My shadow */
	vm_offset_t		shadow_offset;	/* Offset in shadow */
	queue_chain_t		cached_list;	/* for persistence */
};
/*
 * Flags
 */
#define OBJ_CANPERSIST	0x0001	/* allow to persist */
#define OBJ_INTERNAL	0x0002	/* internally created object */
#define OBJ_ACTIVE	0x0004	/* used to mark active objects */

typedef struct vm_object	*vm_object_t;

struct vm_object_hash_entry {
	queue_chain_t		hash_links;	/* hash chain links */
	vm_object_t		object;		/* object we represent */
};

typedef struct vm_object_hash_entry	*vm_object_hash_entry_t;

#ifdef	KERNEL
queue_head_t	vm_object_cached_list;	/* list of objects persisting */
int		vm_object_cached;	/* size of cached list */
simple_lock_data_t	vm_cache_lock;	/* lock for object cache */

queue_head_t	vm_object_list;		/* list of allocated objects */
long		vm_object_count;	/* count of all objects */
simple_lock_data_t	vm_object_list_lock;
					/* lock for object list and count */

vm_object_t	kernel_object;		/* the single kernel object */
vm_object_t	kmem_object;

#define	vm_object_cache_lock()		simple_lock(&vm_cache_lock)
#define	vm_object_cache_unlock()	simple_unlock(&vm_cache_lock)
#endif	KERNEL

/*
 *	Declare procedures that operate on VM objects.
 */

void	vm_object_init __P((vm_size_t));
void	vm_object_terminate __P((vm_object_t));
vm_object_t	vm_object_allocate __P((vm_size_t));
void	vm_object_reference __P((vm_object_t));
void	vm_object_deallocate __P((vm_object_t));
void	vm_object_pmap_copy __P((vm_object_t, vm_offset_t, vm_offset_t));
void	vm_object_pmap_remove __P((vm_object_t, vm_offset_t, vm_offset_t));
void	vm_object_page_remove __P((vm_object_t, vm_offset_t, vm_offset_t));
void	vm_object_shadow __P((vm_object_t *, vm_offset_t *, vm_size_t));
void	vm_object_copy __P((vm_object_t, vm_offset_t, vm_size_t,
			    vm_object_t *, vm_offset_t *, boolean_t *));
void	vm_object_collapse __P((vm_object_t));
vm_object_t	vm_object_lookup __P((vm_pager_t));
void	vm_object_enter __P((vm_object_t, vm_pager_t));
void	vm_object_setpager __P((vm_object_t, vm_pager_t,
				vm_offset_t, boolean_t));
#define	vm_object_cache(pager)	 pager_cache(vm_object_lookup(pager),TRUE)
#define	vm_object_uncache(pager) pager_cache(vm_object_lookup(pager),FALSE)

void	vm_object_cache_clear __P((void));
void	vm_object_print __P((vm_object_t, boolean_t));

void	thread_sleep __P((int, simple_lock_t, boolean_t));
void	thread_wakeup __P((int));

#if	VM_OBJECT_DEBUG
#define	vm_object_lock_init(object)	{ simple_lock_init(&(object)->Lock); (object)->LockHolder = 0; }
#define	vm_object_lock(object)		{ simple_lock(&(object)->Lock); (object)->LockHolder = (int) current_thread(); }
#define	vm_object_unlock(object)	{ (object)->LockHolder = 0; simple_unlock(&(object)->Lock); }
#define	vm_object_lock_try(object)	(simple_lock_try(&(object)->Lock) ? ( ((object)->LockHolder = (int) current_thread()) , TRUE) : FALSE)
#define	vm_object_sleep(event, object, interruptible) \
					{ (object)->LockHolder = 0; thread_sleep((event), &(object)->Lock, (interruptible)); }
#else	VM_OBJECT_DEBUG
#define	vm_object_lock_init(object)	simple_lock_init(&(object)->Lock)
#define	vm_object_lock(object)		simple_lock(&(object)->Lock)
#define	vm_object_unlock(object)	simple_unlock(&(object)->Lock)
#define	vm_object_lock_try(object)	simple_lock_try(&(object)->Lock)
#define	vm_object_sleep(event, object, interruptible) \
					thread_sleep((event), &(object)->Lock, (interruptible))
#endif	VM_OBJECT_DEBUG

#endif	_VM_OBJECT_
Commit	Line	Data
175f072e	1	/*
175f072e KM	2	* Copyright (c) 1991 Regents of the University of California.
	3	* 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	*
0e24ad83	8	* %sccs.include.redist.c%
175f072e	9	*
0f4d1c8c	10	* @(#)vm_object.h 7.6 (Berkeley) %G%
0e24ad83 KM	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.
175f072e KM	37	*/
	38
	39	/*
	40	* Virtual memory object module definitions.
	41	*/
	42
	43	#ifndef _VM_OBJECT_
	44	#define _VM_OBJECT_
	45
175f072e	46	#include <vm/vm_pager.h>
175f072e KM	47
	48	/*
	49	* Types defined:
	50	*
	51	* vm_object_t Virtual memory object.
	52	*/
	53
	54	struct vm_object {
	55	queue_chain_t memq; /* Resident memory */
	56	queue_chain_t object_list; /* list of all objects */
ac29144a KM	57	u_short flags; /* see below */
	58	u_short paging_in_progress; /* Paging (in or out) so
	59	don't collapse or destroy */
175f072e KM	60	simple_lock_data_t Lock; /* Synchronization */
	61	int LockHolder;
	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 */
175f072e KM	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 */
175f072e KM	72	queue_chain_t cached_list; /* for persistence */
175f072e KM	73	};
ac29144a KM	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 */
175f072e KM	80
	81	typedef struct vm_object *vm_object_t;
	82
	83	struct vm_object_hash_entry {
	84	queue_chain_t hash_links; /* hash chain links */
	85	vm_object_t object; /* object we represent */
	86	};
	87
	88	typedef struct vm_object_hash_entry *vm_object_hash_entry_t;
	89
	90	#ifdef KERNEL
	91	queue_head_t vm_object_cached_list; /* list of objects persisting */
	92	int vm_object_cached; /* size of cached list */
	93	simple_lock_data_t vm_cache_lock; /* lock for object cache */
	94
	95	queue_head_t vm_object_list; /* list of allocated objects */
	96	long vm_object_count; /* count of all objects */
	97	simple_lock_data_t vm_object_list_lock;
	98	/* lock for object list and count */
	99
	100	vm_object_t kernel_object; /* the single kernel object */
	101	vm_object_t kmem_object;
	102
	103	#define vm_object_cache_lock() simple_lock(&vm_cache_lock)
	104	#define vm_object_cache_unlock() simple_unlock(&vm_cache_lock)
	105	#endif KERNEL
	106
175f072e KM	107	/*
	108	* Declare procedures that operate on VM objects.
	109	*/
	110
0f4d1c8c	111	void vm_object_init __P((vm_size_t));
702fe5f3 CT	112	void vm_object_terminate __P((vm_object_t));
	113	vm_object_t vm_object_allocate __P((vm_size_t));
	114	void vm_object_reference __P((vm_object_t));
	115	void vm_object_deallocate __P((vm_object_t));
	116	void vm_object_pmap_copy __P((vm_object_t, vm_offset_t, vm_offset_t));
	117	void vm_object_pmap_remove __P((vm_object_t, vm_offset_t, vm_offset_t));
	118	void vm_object_page_remove __P((vm_object_t, vm_offset_t, vm_offset_t));
	119	void vm_object_shadow __P((vm_object_t , vm_offset_t , vm_size_t));
	120	void vm_object_copy __P((vm_object_t, vm_offset_t, vm_size_t,
	121	vm_object_t , vm_offset_t , boolean_t *));
	122	void vm_object_collapse __P((vm_object_t));
	123	vm_object_t vm_object_lookup __P((vm_pager_t));
	124	void vm_object_enter __P((vm_object_t, vm_pager_t));
	125	void vm_object_setpager __P((vm_object_t, vm_pager_t,
	126	vm_offset_t, boolean_t));
	127	#define vm_object_cache(pager) pager_cache(vm_object_lookup(pager),TRUE)
	128	#define vm_object_uncache(pager) pager_cache(vm_object_lookup(pager),FALSE)
	129
	130	void vm_object_cache_clear __P((void));
	131	void vm_object_print __P((vm_object_t, boolean_t));
	132
	133	void thread_sleep __P((int, simple_lock_t, boolean_t));
	134	void thread_wakeup __P((int));
175f072e KM	135
	136	#if VM_OBJECT_DEBUG
	137	#define vm_object_lock_init(object) { simple_lock_init(&(object)->Lock); (object)->LockHolder = 0; }
	138	#define vm_object_lock(object) { simple_lock(&(object)->Lock); (object)->LockHolder = (int) current_thread(); }
	139	#define vm_object_unlock(object) { (object)->LockHolder = 0; simple_unlock(&(object)->Lock); }
	140	#define vm_object_lock_try(object) (simple_lock_try(&(object)->Lock) ? ( ((object)->LockHolder = (int) current_thread()) , TRUE) : FALSE)
	141	#define vm_object_sleep(event, object, interruptible) \
	142	{ (object)->LockHolder = 0; thread_sleep((event), &(object)->Lock, (interruptible)); }
	143	#else VM_OBJECT_DEBUG
	144	#define vm_object_lock_init(object) simple_lock_init(&(object)->Lock)
	145	#define vm_object_lock(object) simple_lock(&(object)->Lock)
	146	#define vm_object_unlock(object) simple_unlock(&(object)->Lock)
	147	#define vm_object_lock_try(object) simple_lock_try(&(object)->Lock)
	148	#define vm_object_sleep(event, object, interruptible) \
	149	thread_sleep((event), &(object)->Lock, (interruptible))
	150	#endif VM_OBJECT_DEBUG
	151
	152	#endif _VM_OBJECT_