xref: /freebsd/sys/vm/vm_page.h (revision afe61c15161c324a7af299a9b8457aba5afc92db)
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  * 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.
35  *
36  *	@(#)vm_page.h	8.2 (Berkeley) 12/13/93
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.
63  */
64 
65 /*
66  *	Resident memory system definitions.
67  */
68 
69 #ifndef	_VM_PAGE_
70 #define	_VM_PAGE_
71 
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 
97 TAILQ_HEAD(pglist, vm_page);
98 
99 struct vm_page {
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)*/
104 
105 	vm_object_t		object;		/* which object am I in (O,P)*/
106 	vm_offset_t		offset;		/* offset into object (O,P) */
107 
108 	u_short			wire_count;	/* wired down maps refs (P) */
109 	u_short			flags;		/* see below */
110 	short			hold_count;	/* page hold count */
111 	u_short			act_count;	/* page usage count */
112 
113 	vm_offset_t		phys_addr;	/* physical address of page */
114 };
115 
116 /*
117  * These are the flags defined for vm_page.
118  *
119  * Note: PG_FILLED and PG_DIRTY are added for the filesystems.
120  */
121 #define	PG_INACTIVE	0x0001		/* page is in inactive list (P) */
122 #define	PG_ACTIVE	0x0002		/* page is in active list (P) */
123 #define	PG_LAUNDRY	0x0004		/* page is being cleaned now (P)*/
124 #define	PG_CLEAN	0x0008		/* page has not been modified */
125 #define	PG_BUSY		0x0010		/* page is in transit (O) */
126 #define	PG_WANTED	0x0020		/* someone is waiting for page (O) */
127 #define	PG_TABLED	0x0040		/* page is in VP table (O) */
128 #define	PG_COPYONWRITE	0x0080		/* must copy page before changing (O) */
129 #define	PG_FICTITIOUS	0x0100		/* physical page doesn't exist (O) */
130 #define	PG_FAKE		0x0200		/* page is placeholder for pagein (O) */
131 #define	PG_FILLED	0x0400		/* client flag to set when filled */
132 #define	PG_DIRTY	0x0800		/* client flag to set when dirty */
133 #define	PG_PAGEROWNED	0x4000		/* DEBUG: async paging op in progress */
134 #define	PG_PTPAGE	0x8000		/* DEBUG: is a user page table page */
135 
136 #if	VM_PAGE_DEBUG
137 #define	VM_PAGE_CHECK(mem) { \
138 	if ((((unsigned int) mem) < ((unsigned int) &vm_page_array[0])) || \
139 	    (((unsigned int) mem) > \
140 		((unsigned int) &vm_page_array[last_page-first_page])) || \
141 	    ((mem->flags & (PG_ACTIVE | PG_INACTIVE)) == \
142 		(PG_ACTIVE | PG_INACTIVE))) \
143 		panic("vm_page_check: not valid!"); \
144 }
145 #else /* VM_PAGE_DEBUG */
146 #define	VM_PAGE_CHECK(mem)
147 #endif /* VM_PAGE_DEBUG */
148 
149 #ifdef KERNEL
150 /*
151  *	Each pageable resident page falls into one of three lists:
152  *
153  *	free
154  *		Available for allocation now.
155  *	inactive
156  *		Not referenced in any map, but still has an
157  *		object/offset-page mapping, and may be dirty.
158  *		This is the list of pages that should be
159  *		paged out next.
160  *	active
161  *		A list of pages which have been placed in
162  *		at least one physical map.  This list is
163  *		ordered, in LRU-like fashion.
164  */
165 
166 extern
167 struct pglist	vm_page_queue_free;	/* memory free queue */
168 extern
169 struct pglist	vm_page_queue_active;	/* active memory queue */
170 extern
171 struct pglist	vm_page_queue_inactive;	/* inactive memory queue */
172 
173 extern
174 vm_page_t	vm_page_array;		/* First resident page in table */
175 extern
176 long		first_page;		/* first physical page number */
177 					/* ... represented in vm_page_array */
178 extern
179 long		last_page;		/* last physical page number */
180 					/* ... represented in vm_page_array */
181 					/* [INCLUSIVE] */
182 extern
183 vm_offset_t	first_phys_addr;	/* physical address for first_page */
184 extern
185 vm_offset_t	last_phys_addr;		/* physical address for last_page */
186 
187 #define VM_PAGE_TO_PHYS(entry)	((entry)->phys_addr)
188 
189 #define IS_VM_PHYSADDR(pa) \
190 		((pa) >= first_phys_addr && (pa) <= last_phys_addr)
191 
192 #define PHYS_TO_VM_PAGE(pa) \
193 		(&vm_page_array[atop(pa) - first_page ])
194 
195 extern
196 simple_lock_data_t	vm_page_queue_lock;	/* lock on active and inactive
197 						   page queues */
198 extern						/* lock on free page queue */
199 simple_lock_data_t	vm_page_queue_free_lock;
200 
201 /*
202  *	Functions implemented as macros
203  */
204 
205 #define PAGE_ASSERT_WAIT(m, interruptible)	{ \
206 				(m)->flags |= PG_WANTED; \
207 				assert_wait((int) (m), (interruptible)); \
208 			}
209 
210 #define PAGE_WAKEUP(m)	{ \
211 				(m)->flags &= ~PG_BUSY; \
212 				if ((m)->flags & PG_WANTED) { \
213 					(m)->flags &= ~PG_WANTED; \
214 					wakeup((caddr_t) (m)); \
215 				} \
216 			}
217 
218 #define	vm_page_lock_queues()	simple_lock(&vm_page_queue_lock)
219 #define	vm_page_unlock_queues()	simple_unlock(&vm_page_queue_lock)
220 
221 #define vm_page_set_modified(m)	{ (m)->flags &= ~PG_CLEAN; }
222 
223 #define	VM_PAGE_INIT(mem, object, offset) { \
224 	(mem)->flags = PG_BUSY | PG_CLEAN | PG_FAKE; \
225 	vm_page_insert((mem), (object), (offset)); \
226 	(mem)->wire_count = 0; \
227 	(mem)->hold_count = 0; \
228 	(mem)->act_count = 0; \
229 }
230 
231 void		 vm_page_activate __P((vm_page_t));
232 vm_page_t	 vm_page_alloc __P((vm_object_t, vm_offset_t));
233 void		 vm_page_copy __P((vm_page_t, vm_page_t));
234 void		 vm_page_deactivate __P((vm_page_t));
235 void		 vm_page_free __P((vm_page_t));
236 void		 vm_page_insert __P((vm_page_t, vm_object_t, vm_offset_t));
237 vm_page_t	 vm_page_lookup __P((vm_object_t, vm_offset_t));
238 void		 vm_page_remove __P((vm_page_t));
239 void		 vm_page_rename __P((vm_page_t, vm_object_t, vm_offset_t));
240 vm_offset_t	 vm_page_startup __P((vm_offset_t, vm_offset_t, vm_offset_t));
241 void		 vm_page_unwire __P((vm_page_t));
242 void		 vm_page_wire __P((vm_page_t));
243 boolean_t	 vm_page_zero_fill __P((vm_page_t));
244 
245 
246 /*
247  * Keep page from being freed by the page daemon
248  * much of the same effect as wiring, except much lower
249  * overhead and should be used only for *very* temporary
250  * holding ("wiring").
251  */
252 static inline void
253 vm_page_hold(mem)
254 	vm_page_t mem;
255 {
256 	mem->hold_count++;
257 }
258 
259 static inline void
260 vm_page_unhold(mem)
261 	vm_page_t mem;
262 {
263 	if( --mem->hold_count < 0)
264 		panic("vm_page_unhold: hold count < 0!!!");
265 }
266 
267 #endif /* KERNEL */
268 #endif /* !_VM_PAGE_ */
269