[unix-history] / .ref-BSD-4_4_Lite1 / usr / src / sys / vm / vm_page.h

/* 
 * Copyright (c) 1991, 1993
 *	The 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.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)vm_page.h	8.2 (Berkeley) 12/13/93
 *
 *
 * 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.
 */

/*
 *	Resident memory system definitions.
 */

#ifndef	_VM_PAGE_
#define	_VM_PAGE_

/*
 *	Management of resident (logical) pages.
 *
 *	A small structure is kept for each resident
 *	page, indexed by page number.  Each structure
 *	is an element of several lists:
 *
 *		A hash table bucket used to quickly
 *		perform object/offset lookups
 *
 *		A list of all pages for a given object,
 *		so they can be quickly deactivated at
 *		time of deallocation.
 *
 *		An ordered list of pages due for pageout.
 *
 *	In addition, the structure contains the object
 *	and offset to which this page belongs (for pageout),
 *	and sundry status bits.
 *
 *	Fields in this structure are locked either by the lock on the
 *	object that the page belongs to (O) or by the lock on the page
 *	queues (P).
 */

TAILQ_HEAD(pglist, vm_page);

struct vm_page {
	TAILQ_ENTRY(vm_page)	pageq;		/* queue info for FIFO
						 * queue or free list (P) */
	TAILQ_ENTRY(vm_page)	hashq;		/* hash table links (O)*/
	TAILQ_ENTRY(vm_page)	listq;		/* pages in same object (O)*/

	vm_object_t		object;		/* which object am I in (O,P)*/
	vm_offset_t		offset;		/* offset into object (O,P) */

	u_short			wire_count;	/* wired down maps refs (P) */
	u_short			flags;		/* see below */

	vm_offset_t		phys_addr;	/* physical address of page */
};

/*
 * These are the flags defined for vm_page.
 *
 * Note: PG_FILLED and PG_DIRTY are added for the filesystems.
 */
#define	PG_INACTIVE	0x0001		/* page is in inactive list (P) */
#define	PG_ACTIVE	0x0002		/* page is in active list (P) */
#define	PG_LAUNDRY	0x0004		/* page is being cleaned now (P)*/
#define	PG_CLEAN	0x0008		/* page has not been modified */
#define	PG_BUSY		0x0010		/* page is in transit (O) */
#define	PG_WANTED	0x0020		/* someone is waiting for page (O) */
#define	PG_TABLED	0x0040		/* page is in VP table (O) */
#define	PG_COPYONWRITE	0x0080		/* must copy page before changing (O) */
#define	PG_FICTITIOUS	0x0100		/* physical page doesn't exist (O) */
#define	PG_FAKE		0x0200		/* page is placeholder for pagein (O) */
#define	PG_FILLED	0x0400		/* client flag to set when filled */
#define	PG_DIRTY	0x0800		/* client flag to set when dirty */
#define	PG_PAGEROWNED	0x4000		/* DEBUG: async paging op in progress */
#define	PG_PTPAGE	0x8000		/* DEBUG: is a user page table page */

#if	VM_PAGE_DEBUG
#define	VM_PAGE_CHECK(mem) { \
	if ((((unsigned int) mem) < ((unsigned int) &vm_page_array[0])) || \
	    (((unsigned int) mem) > \
		((unsigned int) &vm_page_array[last_page-first_page])) || \
	    ((mem->flags & (PG_ACTIVE | PG_INACTIVE)) == \
		(PG_ACTIVE | PG_INACTIVE))) \
		panic("vm_page_check: not valid!"); \
}
#else /* VM_PAGE_DEBUG */
#define	VM_PAGE_CHECK(mem)
#endif /* VM_PAGE_DEBUG */

#ifdef KERNEL
/*
 *	Each pageable resident page falls into one of three lists:
 *
 *	free	
 *		Available for allocation now.
 *	inactive
 *		Not referenced in any map, but still has an
 *		object/offset-page mapping, and may be dirty.
 *		This is the list of pages that should be
 *		paged out next.
 *	active
 *		A list of pages which have been placed in
 *		at least one physical map.  This list is
 *		ordered, in LRU-like fashion.
 */

extern
struct pglist	vm_page_queue_free;	/* memory free queue */
extern
struct pglist	vm_page_queue_active;	/* active memory queue */
extern
struct pglist	vm_page_queue_inactive;	/* inactive memory queue */

extern
vm_page_t	vm_page_array;		/* First resident page in table */
extern
long		first_page;		/* first physical page number */
					/* ... represented in vm_page_array */
extern
long		last_page;		/* last physical page number */
					/* ... represented in vm_page_array */
					/* [INCLUSIVE] */
extern
vm_offset_t	first_phys_addr;	/* physical address for first_page */
extern
vm_offset_t	last_phys_addr;		/* physical address for last_page */

#define VM_PAGE_TO_PHYS(entry)	((entry)->phys_addr)

#define IS_VM_PHYSADDR(pa) \
		((pa) >= first_phys_addr && (pa) <= last_phys_addr)

#define PHYS_TO_VM_PAGE(pa) \
		(&vm_page_array[atop(pa) - first_page ])

extern
simple_lock_data_t	vm_page_queue_lock;	/* lock on active and inactive
						   page queues */
extern						/* lock on free page queue */
simple_lock_data_t	vm_page_queue_free_lock;

/*
 *	Functions implemented as macros
 */

#define PAGE_ASSERT_WAIT(m, interruptible)	{ \
				(m)->flags |= PG_WANTED; \
				assert_wait((int) (m), (interruptible)); \
			}

#define PAGE_WAKEUP(m)	{ \
				(m)->flags &= ~PG_BUSY; \
				if ((m)->flags & PG_WANTED) { \
					(m)->flags &= ~PG_WANTED; \
					thread_wakeup((int) (m)); \
				} \
			}

#define	vm_page_lock_queues()	simple_lock(&vm_page_queue_lock)
#define	vm_page_unlock_queues()	simple_unlock(&vm_page_queue_lock)

#define vm_page_set_modified(m)	{ (m)->flags &= ~PG_CLEAN; }

#define	VM_PAGE_INIT(mem, object, offset) { \
	(mem)->flags = PG_BUSY | PG_CLEAN | PG_FAKE; \
	vm_page_insert((mem), (object), (offset)); \
	(mem)->wire_count = 0; \
}

void		 vm_page_activate __P((vm_page_t));
vm_page_t	 vm_page_alloc __P((vm_object_t, vm_offset_t));
void		 vm_page_copy __P((vm_page_t, vm_page_t));
void		 vm_page_deactivate __P((vm_page_t));
void		 vm_page_free __P((vm_page_t));
void		 vm_page_insert __P((vm_page_t, vm_object_t, vm_offset_t));
vm_page_t	 vm_page_lookup __P((vm_object_t, vm_offset_t));
void		 vm_page_remove __P((vm_page_t));
void		 vm_page_rename __P((vm_page_t, vm_object_t, vm_offset_t));
void		 vm_page_startup __P((vm_offset_t *, vm_offset_t *));
void		 vm_page_unwire __P((vm_page_t));
void		 vm_page_wire __P((vm_page_t));
boolean_t	 vm_page_zero_fill __P((vm_page_t));

#endif /* KERNEL */
#endif /* !_VM_PAGE_ */
Commit	Line	Data
175f072e	1	/*
ad787160 C	2	* Copyright (c) 1991, 1993
ad787160 C	3	* The Regents of the University of California. All rights reserved.
175f072e KM	4	*
	5	* This code is derived from software contributed to Berkeley by
	6	* The Mach Operating System project at Carnegie-Mellon University.
	7	*
ad787160 C	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	* 3. All advertising materials mentioning features or use of this software
	17	* must display the following acknowledgement:
	18	* This product includes software developed by the University of
	19	* California, Berkeley and its contributors.
	20	* 4. Neither the name of the University nor the names of its contributors
	21	* may be used to endorse or promote products derived from this software
	22	* without specific prior written permission.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	* SUCH DAMAGE.
175f072e	35	*
ed554bc5	36	* @(#)vm_page.h 8.2 (Berkeley) 12/13/93
0e24ad83 KM	37	*
	38	*
	39	* Copyright (c) 1987, 1990 Carnegie-Mellon University.
	40	* All rights reserved.
	41	*
	42	* Authors: Avadis Tevanian, Jr., Michael Wayne Young
	43	*
	44	* Permission to use, copy, modify and distribute this software and
	45	* its documentation is hereby granted, provided that both the copyright
	46	* notice and this permission notice appear in all copies of the
	47	* software, derivative works or modified versions, and any portions
	48	* thereof, and that both notices appear in supporting documentation.
	49	*
	50	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	51	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
	52	* FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	53	*
	54	* Carnegie Mellon requests users of this software to return to
	55	*
	56	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	57	* School of Computer Science
	58	* Carnegie Mellon University
	59	* Pittsburgh PA 15213-3890
	60	*
	61	* any improvements or extensions that they make and grant Carnegie the
	62	* rights to redistribute these changes.
175f072e KM	63	*/
	64
	65	/*
	66	* Resident memory system definitions.
	67	*/
	68
	69	#ifndef _VM_PAGE_
	70	#define _VM_PAGE_
	71
175f072e KM	72	/*
	73	* Management of resident (logical) pages.
	74	*
	75	* A small structure is kept for each resident
	76	* page, indexed by page number. Each structure
	77	* is an element of several lists:
	78	*
	79	* A hash table bucket used to quickly
	80	* perform object/offset lookups
	81	*
	82	* A list of all pages for a given object,
	83	* so they can be quickly deactivated at
	84	* time of deallocation.
	85	*
	86	* An ordered list of pages due for pageout.
	87	*
	88	* In addition, the structure contains the object
	89	* and offset to which this page belongs (for pageout),
	90	* and sundry status bits.
	91	*
	92	* Fields in this structure are locked either by the lock on the
	93	* object that the page belongs to (O) or by the lock on the page
	94	* queues (P).
	95	*/
	96
06d6efa9 KM	97	TAILQ_HEAD(pglist, vm_page);
06d6efa9 KM	98
175f072e	99	struct vm_page {
06d6efa9 KM	100	TAILQ_ENTRY(vm_page) pageq; /* queue info for FIFO
	101	* queue or free list (P) */
	102	TAILQ_ENTRY(vm_page) hashq; /* hash table links (O)*/
	103	TAILQ_ENTRY(vm_page) listq; /* pages in same object (O)*/
175f072e	104
06d6efa9 KM	105	vm_object_t object; /* which object am I in (O,P)*/
06d6efa9 KM	106	vm_offset_t offset; /* offset into object (O,P) */
175f072e	107
06d6efa9 KM	108	u_short wire_count; /* wired down maps refs (P) */
06d6efa9 KM	109	u_short flags; /* see below */
175f072e	110
06d6efa9	111	vm_offset_t phys_addr; /* physical address of page */
175f072e KM	112	};
175f072e KM	113
2cbf9af3 KM	114	/*
2cbf9af3 KM	115	* These are the flags defined for vm_page.
1362a707 KM	116	*
1362a707 KM	117	* Note: PG_FILLED and PG_DIRTY are added for the filesystems.
2cbf9af3 KM	118	*/
	119	#define PG_INACTIVE 0x0001 /* page is in inactive list (P) */
	120	#define PG_ACTIVE 0x0002 /* page is in active list (P) */
	121	#define PG_LAUNDRY 0x0004 /* page is being cleaned now (P)*/
	122	#define PG_CLEAN 0x0008 /* page has not been modified */
	123	#define PG_BUSY 0x0010 /* page is in transit (O) */
	124	#define PG_WANTED 0x0020 /* someone is waiting for page (O) */
	125	#define PG_TABLED 0x0040 /* page is in VP table (O) */
	126	#define PG_COPYONWRITE 0x0080 /* must copy page before changing (O) */
	127	#define PG_FICTITIOUS 0x0100 /* physical page doesn't exist (O) */
14f85227 MH	128	#define PG_FAKE 0x0200 /* page is placeholder for pagein (O) */
	129	#define PG_FILLED 0x0400 /* client flag to set when filled */
	130	#define PG_DIRTY 0x0800 /* client flag to set when dirty */
2cbf9af3 KM	131	#define PG_PAGEROWNED 0x4000 /* DEBUG: async paging op in progress */
	132	#define PG_PTPAGE 0x8000 /* DEBUG: is a user page table page */
	133
175f072e KM	134	#if VM_PAGE_DEBUG
175f072e KM	135	#define VM_PAGE_CHECK(mem) { \
2cbf9af3 KM	136	if ((((unsigned int) mem) < ((unsigned int) &vm_page_array[0])) \|\| \
	137	(((unsigned int) mem) > \
	138	((unsigned int) &vm_page_array[last_page-first_page])) \|\| \
	139	((mem->flags & (PG_ACTIVE \| PG_INACTIVE)) == \
	140	(PG_ACTIVE \| PG_INACTIVE))) \
	141	panic("vm_page_check: not valid!"); \
	142	}
1524bcb8	143	#else /* VM_PAGE_DEBUG */
175f072e	144	#define VM_PAGE_CHECK(mem)
1524bcb8	145	#endif /* VM_PAGE_DEBUG */
175f072e	146
5fddb4f9	147	#ifdef KERNEL
175f072e KM	148	/*
	149	* Each pageable resident page falls into one of three lists:
	150	*
	151	* free
	152	* Available for allocation now.
	153	* inactive
	154	* Not referenced in any map, but still has an
	155	* object/offset-page mapping, and may be dirty.
	156	* This is the list of pages that should be
	157	* paged out next.
	158	* active
	159	* A list of pages which have been placed in
	160	* at least one physical map. This list is
	161	* ordered, in LRU-like fashion.
	162	*/
	163
	164	extern
06d6efa9	165	struct pglist vm_page_queue_free; /* memory free queue */
175f072e	166	extern
06d6efa9	167	struct pglist vm_page_queue_active; /* active memory queue */
175f072e	168	extern
06d6efa9	169	struct pglist vm_page_queue_inactive; /* inactive memory queue */
175f072e KM	170
	171	extern
	172	vm_page_t vm_page_array; /* First resident page in table */
	173	extern
	174	long first_page; /* first physical page number */
	175	/* ... represented in vm_page_array */
	176	extern
	177	long last_page; /* last physical page number */
	178	/* ... represented in vm_page_array */
	179	/* [INCLUSIVE] */
	180	extern
	181	vm_offset_t first_phys_addr; /* physical address for first_page */
	182	extern
	183	vm_offset_t last_phys_addr; /* physical address for last_page */
	184
175f072e KM	185	#define VM_PAGE_TO_PHYS(entry) ((entry)->phys_addr)
	186
	187	#define IS_VM_PHYSADDR(pa) \
	188	((pa) >= first_phys_addr && (pa) <= last_phys_addr)
	189
	190	#define PHYS_TO_VM_PAGE(pa) \
	191	(&vm_page_array[atop(pa) - first_page ])
	192
	193	extern
	194	simple_lock_data_t vm_page_queue_lock; /* lock on active and inactive
	195	page queues */
5fddb4f9	196	extern /* lock on free page queue */
175f072e	197	simple_lock_data_t vm_page_queue_free_lock;
175f072e KM	198
	199	/*
	200	* Functions implemented as macros
	201	*/
	202
	203	#define PAGE_ASSERT_WAIT(m, interruptible) { \
2cbf9af3	204	(m)->flags \|= PG_WANTED; \
175f072e KM	205	assert_wait((int) (m), (interruptible)); \
	206	}
	207
	208	#define PAGE_WAKEUP(m) { \
2cbf9af3 KM	209	(m)->flags &= ~PG_BUSY; \
	210	if ((m)->flags & PG_WANTED) { \
	211	(m)->flags &= ~PG_WANTED; \
175f072e KM	212	thread_wakeup((int) (m)); \
	213	} \
	214	}
	215
	216	#define vm_page_lock_queues() simple_lock(&vm_page_queue_lock)
	217	#define vm_page_unlock_queues() simple_unlock(&vm_page_queue_lock)
	218
2cbf9af3	219	#define vm_page_set_modified(m) { (m)->flags &= ~PG_CLEAN; }
e9afc330	220
e9afc330	221	#define VM_PAGE_INIT(mem, object, offset) { \
2cbf9af3	222	(mem)->flags = PG_BUSY \| PG_CLEAN \| PG_FAKE; \
e9afc330	223	vm_page_insert((mem), (object), (offset)); \
e9afc330	224	(mem)->wire_count = 0; \
e9afc330 CT	225	}
e9afc330 CT	226
5fddb4f9 KB	227	void vm_page_activate __P((vm_page_t));
	228	vm_page_t vm_page_alloc __P((vm_object_t, vm_offset_t));
	229	void vm_page_copy __P((vm_page_t, vm_page_t));
	230	void vm_page_deactivate __P((vm_page_t));
	231	void vm_page_free __P((vm_page_t));
	232	void vm_page_insert __P((vm_page_t, vm_object_t, vm_offset_t));
	233	vm_page_t vm_page_lookup __P((vm_object_t, vm_offset_t));
	234	void vm_page_remove __P((vm_page_t));
	235	void vm_page_rename __P((vm_page_t, vm_object_t, vm_offset_t));
	236	void vm_page_startup __P((vm_offset_t , vm_offset_t ));
	237	void vm_page_unwire __P((vm_page_t));
	238	void vm_page_wire __P((vm_page_t));
	239	boolean_t vm_page_zero_fill __P((vm_page_t));
	240
	241	#endif /* KERNEL */
	242	#endif /* !_VM_PAGE_ */