xref: /freebsd/sys/vm/vm_page.h (revision 8e6b01171e30297084bb0b4457c4183c2746aacc)
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  *	from: @(#)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  * $Id: vm_page.h,v 1.20 1995/09/03 20:11:26 dyson Exp $
65  */
66 
67 /*
68  *	Resident memory system definitions.
69  */
70 
71 #ifndef	_VM_PAGE_
72 #define	_VM_PAGE_
73 
74 #include <vm/pmap.h>
75 /*
76  *	Management of resident (logical) pages.
77  *
78  *	A small structure is kept for each resident
79  *	page, indexed by page number.  Each structure
80  *	is an element of several lists:
81  *
82  *		A hash table bucket used to quickly
83  *		perform object/offset lookups
84  *
85  *		A list of all pages for a given object,
86  *		so they can be quickly deactivated at
87  *		time of deallocation.
88  *
89  *		An ordered list of pages due for pageout.
90  *
91  *	In addition, the structure contains the object
92  *	and offset to which this page belongs (for pageout),
93  *	and sundry status bits.
94  *
95  *	Fields in this structure are locked either by the lock on the
96  *	object that the page belongs to (O) or by the lock on the page
97  *	queues (P).
98  */
99 
100 TAILQ_HEAD(pglist, vm_page);
101 
102 struct vm_page {
103 	TAILQ_ENTRY(vm_page) pageq;	/* queue info for FIFO queue or free list (P) */
104 	TAILQ_ENTRY(vm_page) hashq;	/* hash table links (O) */
105 	TAILQ_ENTRY(vm_page) listq;	/* pages in same object (O) */
106 
107 	vm_object_t object;		/* which object am I in (O,P) */
108 	vm_offset_t offset;		/* offset into object (O,P) */
109 	vm_offset_t phys_addr;		/* physical address of page */
110 
111 	u_short wire_count;		/* wired down maps refs (P) */
112 	u_short flags;			/* see below */
113 	short hold_count;		/* page hold count */
114 	u_short act_count;		/* page usage count */
115 	u_short bmapped;		/* number of buffers mapped */
116 	u_short busy;			/* page busy count */
117 	u_short valid;			/* map of valid DEV_BSIZE chunks */
118 	u_short dirty;			/* map of dirty DEV_BSIZE chunks */
119 };
120 
121 /*
122  * These are the flags defined for vm_page.
123  *
124  * Note: PG_FILLED and PG_DIRTY are added for the filesystems.
125  */
126 #define	PG_INACTIVE	0x0001		/* page is in inactive list (P) */
127 #define	PG_ACTIVE	0x0002		/* page is in active list (P) */
128 #define	PG_BUSY		0x0010		/* page is in transit (O) */
129 #define	PG_WANTED	0x0020		/* someone is waiting for page (O) */
130 #define	PG_TABLED	0x0040		/* page is in VP table (O) */
131 #define	PG_FICTITIOUS	0x0100		/* physical page doesn't exist (O) */
132 #define	PG_WRITEABLE	0x0200		/* page is mapped writeable */
133 #define PG_MAPPED	0x0400		/* page is mapped */
134 #define	PG_ZERO		0x0800		/* page is zeroed */
135 #define PG_REFERENCED	0x1000		/* page has been referenced */
136 #define	PG_CACHE	0x4000		/* On VMIO cache */
137 #define	PG_FREE		0x8000		/* page is in free list */
138 
139 /*
140  * Misc constants.
141  */
142 
143 #define ACT_DECLINE		1
144 #define ACT_ADVANCE		3
145 #define ACT_MAX			100
146 #define PFCLUSTER_BEHIND	3
147 #define PFCLUSTER_AHEAD		3
148 
149 #ifdef KERNEL
150 /*
151  * Each pageable resident page falls into one of four lists:
152  *
153  *	free
154  *		Available for allocation now.
155  *
156  * The following are all LRU sorted:
157  *
158  *	cache
159  *		Almost available for allocation. Still in an
160  *		object, but clean and immediately freeable at
161  *		non-interrupt times.
162  *
163  *	inactive
164  *		Low activity, candidates for reclaimation.
165  *		This is the list of pages that should be
166  *		paged out next.
167  *
168  *	active
169  *		Pages that are "active" i.e. they have been
170  *		recently referenced.
171  *
172  *	zero
173  *		Pages that are really free and have been pre-zeroed
174  *
175  */
176 
177 extern struct pglist vm_page_queue_free;	/* memory free queue */
178 extern struct pglist vm_page_queue_zero;	/* zeroed memory free queue */
179 extern struct pglist vm_page_queue_active;	/* active memory queue */
180 extern struct pglist vm_page_queue_inactive;	/* inactive memory queue */
181 extern struct pglist vm_page_queue_cache;	/* cache memory queue */
182 
183 extern vm_page_t vm_page_array;		/* First resident page in table */
184 extern long first_page;			/* first physical page number */
185 
186  /* ... represented in vm_page_array */
187 extern long last_page;			/* last physical page number */
188 
189  /* ... represented in vm_page_array */
190  /* [INCLUSIVE] */
191 extern vm_offset_t first_phys_addr;	/* physical address for first_page */
192 extern vm_offset_t last_phys_addr;	/* physical address for last_page */
193 
194 #define VM_PAGE_TO_PHYS(entry)	((entry)->phys_addr)
195 
196 #define IS_VM_PHYSADDR(pa) \
197 		((pa) >= first_phys_addr && (pa) <= last_phys_addr)
198 
199 #define PHYS_TO_VM_PAGE(pa) \
200 		(&vm_page_array[atop(pa) - first_page ])
201 
202 /*
203  *	Functions implemented as macros
204  */
205 
206 #define PAGE_ASSERT_WAIT(m, interruptible)	{ \
207 				(m)->flags |= PG_WANTED; \
208 				assert_wait((int) (m), (interruptible)); \
209 			}
210 
211 #define PAGE_WAKEUP(m)	{ \
212 				(m)->flags &= ~PG_BUSY; \
213 				if ((m)->flags & PG_WANTED) { \
214 					(m)->flags &= ~PG_WANTED; \
215 					wakeup((caddr_t) (m)); \
216 				} \
217 			}
218 
219 #if PAGE_SIZE == 4096
220 #define VM_PAGE_BITS_ALL 0xff
221 #endif
222 
223 #if PAGE_SIZE == 8192
224 #define VM_PAGE_BITS_ALL 0xffff
225 #endif
226 
227 #define VM_ALLOC_NORMAL 0
228 #define VM_ALLOC_INTERRUPT 1
229 #define VM_ALLOC_SYSTEM 2
230 #define	VM_ALLOC_ZERO	0x80
231 
232 void vm_page_activate __P((vm_page_t));
233 vm_page_t vm_page_alloc __P((vm_object_t, vm_offset_t, int));
234 void vm_page_cache __P((register vm_page_t));
235 void vm_page_copy __P((vm_page_t, vm_page_t));
236 void vm_page_deactivate __P((vm_page_t));
237 void vm_page_free __P((vm_page_t));
238 void vm_page_insert __P((vm_page_t, vm_object_t, vm_offset_t));
239 vm_page_t vm_page_lookup __P((vm_object_t, vm_offset_t));
240 void vm_page_remove __P((vm_page_t));
241 void vm_page_rename __P((vm_page_t, vm_object_t, vm_offset_t));
242 vm_offset_t vm_page_startup __P((vm_offset_t, vm_offset_t, vm_offset_t));
243 void vm_page_unwire __P((vm_page_t));
244 void vm_page_wire __P((vm_page_t));
245 boolean_t vm_page_zero_fill __P((vm_page_t));
246 void vm_page_set_dirty __P((vm_page_t, int, int));
247 void vm_page_set_clean __P((vm_page_t, int, int));
248 int vm_page_is_clean __P((vm_page_t, int, int));
249 void vm_page_set_valid __P((vm_page_t, int, int));
250 void vm_page_set_validclean __P((vm_page_t, int, int));
251 void vm_page_set_invalid __P((vm_page_t, int, int));
252 int vm_page_is_valid __P((vm_page_t, int, int));
253 void vm_page_test_dirty __P((vm_page_t));
254 void vm_page_unqueue __P((vm_page_t ));
255 int vm_page_bits __P((int, int));
256 
257 
258 /*
259  * Keep page from being freed by the page daemon
260  * much of the same effect as wiring, except much lower
261  * overhead and should be used only for *very* temporary
262  * holding ("wiring").
263  */
264 static __inline void
265 vm_page_hold(vm_page_t mem)
266 {
267 	mem->hold_count++;
268 }
269 
270 #ifdef DIAGNOSTIC
271 #include <sys/systm.h>		/* make GCC shut up */
272 #endif
273 
274 static __inline void
275 vm_page_unhold(vm_page_t mem)
276 {
277 #ifdef DIAGNOSTIC
278 	if (--mem->hold_count < 0)
279 		panic("vm_page_unhold: hold count < 0!!!");
280 #else
281 	--mem->hold_count;
282 #endif
283 }
284 
285 static __inline void
286 vm_page_protect(vm_page_t mem, int prot)
287 {
288 	if (prot == VM_PROT_NONE) {
289 		if (mem->flags & (PG_WRITEABLE|PG_MAPPED)) {
290 			pmap_page_protect(VM_PAGE_TO_PHYS(mem), prot);
291 			mem->flags &= ~(PG_WRITEABLE|PG_MAPPED);
292 		}
293 	} else if ((prot == VM_PROT_READ) && (mem->flags & PG_WRITEABLE)) {
294 		pmap_page_protect(VM_PAGE_TO_PHYS(mem), prot);
295 		mem->flags &= ~PG_WRITEABLE;
296 	}
297 }
298 
299 
300 #endif				/* KERNEL */
301 #endif				/* !_VM_PAGE_ */
302