uvm_page.h revision 1.54 1 /* $NetBSD: uvm_page.h,v 1.54 2008/06/04 12:45:28 ad Exp $ */
2
3 /*
4 * Copyright (c) 1997 Charles D. Cranor and Washington University.
5 * Copyright (c) 1991, 1993, The Regents of the University of California.
6 *
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to Berkeley by
10 * The Mach Operating System project at Carnegie-Mellon University.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by Charles D. Cranor,
23 * Washington University, the University of California, Berkeley and
24 * its contributors.
25 * 4. Neither the name of the University nor the names of its contributors
26 * may be used to endorse or promote products derived from this software
27 * without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * SUCH DAMAGE.
40 *
41 * @(#)vm_page.h 7.3 (Berkeley) 4/21/91
42 * from: Id: uvm_page.h,v 1.1.2.6 1998/02/04 02:31:42 chuck Exp
43 *
44 *
45 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
46 * All rights reserved.
47 *
48 * Permission to use, copy, modify and distribute this software and
49 * its documentation is hereby granted, provided that both the copyright
50 * notice and this permission notice appear in all copies of the
51 * software, derivative works or modified versions, and any portions
52 * thereof, and that both notices appear in supporting documentation.
53 *
54 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
55 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
56 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
57 *
58 * Carnegie Mellon requests users of this software to return to
59 *
60 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
61 * School of Computer Science
62 * Carnegie Mellon University
63 * Pittsburgh PA 15213-3890
64 *
65 * any improvements or extensions that they make and grant Carnegie the
66 * rights to redistribute these changes.
67 */
68
69 #ifndef _UVM_UVM_PAGE_H_
70 #define _UVM_UVM_PAGE_H_
71
72 /*
73 * uvm_page.h
74 */
75
76 /*
77 * Resident memory system definitions.
78 */
79
80 /*
81 * Management of resident (logical) pages.
82 *
83 * A small structure is kept for each resident
84 * page, indexed by page number. Each structure
85 * is an element of several lists:
86 *
87 * A hash table bucket used to quickly
88 * perform object/offset lookups
89 *
90 * A list of all pages for a given object,
91 * so they can be quickly deactivated at
92 * time of deallocation.
93 *
94 * An ordered list of pages due for pageout.
95 *
96 * In addition, the structure contains the object
97 * and offset to which this page belongs (for pageout),
98 * and sundry status bits.
99 *
100 * Fields in this structure are locked either by the lock on the
101 * object that the page belongs to (O) or by the lock on the page
102 * queues (P) [or both].
103 */
104
105 /*
106 * locking note: the mach version of this data structure had bit
107 * fields for the flags, and the bit fields were divided into two
108 * items (depending on who locked what). some time, in BSD, the bit
109 * fields were dumped and all the flags were lumped into one short.
110 * that is fine for a single threaded uniprocessor OS, but bad if you
111 * want to actual make use of locking. so, we've separated things
112 * back out again.
113 *
114 * note the page structure has no lock of its own.
115 */
116
117 #include <uvm/uvm_extern.h>
118 #include <uvm/uvm_pglist.h>
119
120 struct vm_page {
121 TAILQ_ENTRY(vm_page) hashq; /* hash table links (O)*/
122
123 union {
124 TAILQ_ENTRY(vm_page) queue;
125 LIST_ENTRY(vm_page) list;
126 } pageq; /* queue info for FIFO
127 * queue or free list (P) */
128 union {
129 TAILQ_ENTRY(vm_page) queue;
130 LIST_ENTRY(vm_page) list;
131 } listq; /* pages in same object (O)*/
132
133 struct vm_anon *uanon; /* anon (O,P) */
134 struct uvm_object *uobject; /* object (O,P) */
135 voff_t offset; /* offset into object (O,P) */
136 uint16_t flags; /* object flags [O] */
137 uint16_t loan_count; /* number of active loans
138 * to read: [O or P]
139 * to modify: [O _and_ P] */
140 uint16_t wire_count; /* wired down map refs [P] */
141 uint16_t pqflags; /* page queue flags [P] */
142 paddr_t phys_addr; /* physical address of page */
143
144 #ifdef __HAVE_VM_PAGE_MD
145 struct vm_page_md mdpage; /* pmap-specific data */
146 #endif
147
148 #if defined(UVM_PAGE_TRKOWN)
149 /* debugging fields to track page ownership */
150 pid_t owner; /* proc that set PG_BUSY */
151 lwpid_t lowner; /* lwp that set PG_BUSY */
152 const char *owner_tag; /* why it was set busy */
153 #endif
154 };
155
156 /*
157 * These are the flags defined for vm_page.
158 */
159
160 /*
161 * locking rules:
162 * PG_ ==> locked by object lock
163 * PQ_ ==> lock by page queue lock
164 * PQ_FREE is locked by free queue lock and is mutex with all other PQs
165 *
166 * PG_ZERO is used to indicate that a page has been pre-zero'd. This flag
167 * is only set when the page is on no queues, and is cleared when the page
168 * is placed on the free list.
169 */
170
171 #define PG_BUSY 0x0001 /* page is locked */
172 #define PG_WANTED 0x0002 /* someone is waiting for page */
173 #define PG_TABLED 0x0004 /* page is in VP table */
174 #define PG_CLEAN 0x0008 /* page has not been modified */
175 #define PG_PAGEOUT 0x0010 /* page to be freed for pagedaemon */
176 #define PG_RELEASED 0x0020 /* page to be freed when unbusied */
177 #define PG_FAKE 0x0040 /* page is not yet initialized */
178 #define PG_RDONLY 0x0080 /* page must be mapped read-only */
179 #define PG_ZERO 0x0100 /* page is pre-zero'd */
180
181 #define PG_PAGER1 0x1000 /* pager-specific flag */
182
183 #define UVM_PGFLAGBITS \
184 "\20\1BUSY\2WANTED\3TABLED\4CLEAN\5PAGEOUT\6RELEASED\7FAKE\10RDONLY" \
185 "\11ZERO\15PAGER1"
186
187 #define PQ_FREE 0x0001 /* page is on free list */
188 #define PQ_ANON 0x0002 /* page is part of an anon, rather
189 than an uvm_object */
190 #define PQ_AOBJ 0x0004 /* page is part of an anonymous
191 uvm_object */
192 #define PQ_SWAPBACKED (PQ_ANON|PQ_AOBJ)
193 #define PQ_READAHEAD 0x0008 /* read-ahead but has not been "hit" yet */
194
195 #define PQ_PRIVATE1 0x0100
196 #define PQ_PRIVATE2 0x0200
197 #define PQ_PRIVATE3 0x0400
198 #define PQ_PRIVATE4 0x0800
199 #define PQ_PRIVATE5 0x1000
200 #define PQ_PRIVATE6 0x2000
201 #define PQ_PRIVATE7 0x4000
202 #define PQ_PRIVATE8 0x8000
203
204 #define UVM_PQFLAGBITS \
205 "\20\1FREE\2ANON\3AOBJ\4READAHEAD" \
206 "\11PRIVATE1\12PRIVATE2\13PRIVATE3\14PRIVATE4" \
207 "\15PRIVATE5\16PRIVATE6\17PRIVATE7\20PRIVATE8"
208
209 /*
210 * physical memory layout structure
211 *
212 * MD vmparam.h must #define:
213 * VM_PHYSEG_MAX = max number of physical memory segments we support
214 * (if this is "1" then we revert to a "contig" case)
215 * VM_PHYSSEG_STRAT: memory sort/search options (for VM_PHYSEG_MAX > 1)
216 * - VM_PSTRAT_RANDOM: linear search (random order)
217 * - VM_PSTRAT_BSEARCH: binary search (sorted by address)
218 * - VM_PSTRAT_BIGFIRST: linear search (sorted by largest segment first)
219 * - others?
220 * XXXCDC: eventually we should purge all left-over global variables...
221 */
222 #define VM_PSTRAT_RANDOM 1
223 #define VM_PSTRAT_BSEARCH 2
224 #define VM_PSTRAT_BIGFIRST 3
225
226 /*
227 * vm_physseg: describes one segment of physical memory
228 */
229 struct vm_physseg {
230 paddr_t start; /* PF# of first page in segment */
231 paddr_t end; /* (PF# of last page in segment) + 1 */
232 paddr_t avail_start; /* PF# of first free page in segment */
233 paddr_t avail_end; /* (PF# of last free page in segment) +1 */
234 int free_list; /* which free list they belong on */
235 struct vm_page *pgs; /* vm_page structures (from start) */
236 struct vm_page *lastpg; /* vm_page structure for end */
237 #ifdef __HAVE_PMAP_PHYSSEG
238 struct pmap_physseg pmseg; /* pmap specific (MD) data */
239 #endif
240 };
241
242 #ifdef _KERNEL
243
244 /*
245 * globals
246 */
247
248 extern bool vm_page_zero_enable;
249
250 /*
251 * physical memory config is stored in vm_physmem.
252 */
253
254 extern struct vm_physseg vm_physmem[VM_PHYSSEG_MAX];
255 extern int vm_nphysseg;
256
257 /*
258 * prototypes: the following prototypes define the interface to pages
259 */
260
261 void uvm_page_init(vaddr_t *, vaddr_t *);
262 #if defined(UVM_PAGE_TRKOWN)
263 void uvm_page_own(struct vm_page *, const char *);
264 #endif
265 #if !defined(PMAP_STEAL_MEMORY)
266 bool uvm_page_physget(paddr_t *);
267 #endif
268 void uvm_page_rehash(void);
269 void uvm_page_recolor(int);
270 void uvm_pageidlezero(void);
271
272 void uvm_pageactivate(struct vm_page *);
273 vaddr_t uvm_pageboot_alloc(vsize_t);
274 void uvm_pagecopy(struct vm_page *, struct vm_page *);
275 void uvm_pagedeactivate(struct vm_page *);
276 void uvm_pagedequeue(struct vm_page *);
277 void uvm_pageenqueue(struct vm_page *);
278 void uvm_pagefree(struct vm_page *);
279 void uvm_page_unbusy(struct vm_page **, int);
280 struct vm_page *uvm_pagelookup(struct uvm_object *, voff_t);
281 void uvm_pageunwire(struct vm_page *);
282 void uvm_pagewait(struct vm_page *, int);
283 void uvm_pagewake(struct vm_page *);
284 void uvm_pagewire(struct vm_page *);
285 void uvm_pagezero(struct vm_page *);
286
287 int uvm_page_lookup_freelist(struct vm_page *);
288
289 static struct vm_page *PHYS_TO_VM_PAGE(paddr_t);
290 static int vm_physseg_find(paddr_t, int *);
291
292 /*
293 * macros
294 */
295
296 #define UVM_PAGE_HASH_PENALTY 4 /* XXX: a guess */
297
298 #define uvm_pagehash(obj,off) \
299 (((unsigned long)obj+(unsigned long)atop(off)) & uvm.page_hashmask)
300
301 #define VM_PAGE_TO_PHYS(entry) ((entry)->phys_addr)
302
303 /*
304 * Compute the page color bucket for a given page.
305 */
306 #define VM_PGCOLOR_BUCKET(pg) \
307 (atop(VM_PAGE_TO_PHYS((pg))) & uvmexp.colormask)
308
309 /*
310 * when VM_PHYSSEG_MAX is 1, we can simplify these functions
311 */
312
313 /*
314 * vm_physseg_find: find vm_physseg structure that belongs to a PA
315 */
316 static __inline int
317 vm_physseg_find(paddr_t pframe, int *offp)
318 {
319 #if VM_PHYSSEG_MAX == 1
320
321 /* 'contig' case */
322 if (pframe >= vm_physmem[0].start && pframe < vm_physmem[0].end) {
323 if (offp)
324 *offp = pframe - vm_physmem[0].start;
325 return(0);
326 }
327 return(-1);
328
329 #elif (VM_PHYSSEG_STRAT == VM_PSTRAT_BSEARCH)
330 /* binary search for it */
331 u_int start, len, try;
332
333 /*
334 * if try is too large (thus target is less than try) we reduce
335 * the length to trunc(len/2) [i.e. everything smaller than "try"]
336 *
337 * if the try is too small (thus target is greater than try) then
338 * we set the new start to be (try + 1). this means we need to
339 * reduce the length to (round(len/2) - 1).
340 *
341 * note "adjust" below which takes advantage of the fact that
342 * (round(len/2) - 1) == trunc((len - 1) / 2)
343 * for any value of len we may have
344 */
345
346 for (start = 0, len = vm_nphysseg ; len != 0 ; len = len / 2) {
347 try = start + (len / 2); /* try in the middle */
348
349 /* start past our try? */
350 if (pframe >= vm_physmem[try].start) {
351 /* was try correct? */
352 if (pframe < vm_physmem[try].end) {
353 if (offp)
354 *offp = pframe - vm_physmem[try].start;
355 return(try); /* got it */
356 }
357 start = try + 1; /* next time, start here */
358 len--; /* "adjust" */
359 } else {
360 /*
361 * pframe before try, just reduce length of
362 * region, done in "for" loop
363 */
364 }
365 }
366 return(-1);
367
368 #else
369 /* linear search for it */
370 int lcv;
371
372 for (lcv = 0; lcv < vm_nphysseg; lcv++) {
373 if (pframe >= vm_physmem[lcv].start &&
374 pframe < vm_physmem[lcv].end) {
375 if (offp)
376 *offp = pframe - vm_physmem[lcv].start;
377 return(lcv); /* got it */
378 }
379 }
380 return(-1);
381
382 #endif
383 }
384
385
386 /*
387 * IS_VM_PHYSADDR: only used my mips/pmax/pica trap/pmap.
388 */
389
390 #define IS_VM_PHYSADDR(PA) (vm_physseg_find(atop(PA), NULL) != -1)
391
392 /*
393 * PHYS_TO_VM_PAGE: find vm_page for a PA. used by MI code to get vm_pages
394 * back from an I/O mapping (ugh!). used in some MD code as well.
395 */
396 static __inline struct vm_page *
397 PHYS_TO_VM_PAGE(paddr_t pa)
398 {
399 paddr_t pf = atop(pa);
400 int off;
401 int psi;
402
403 psi = vm_physseg_find(pf, &off);
404 if (psi != -1)
405 return(&vm_physmem[psi].pgs[off]);
406 return(NULL);
407 }
408
409 #define VM_PAGE_IS_FREE(entry) ((entry)->pqflags & PQ_FREE)
410 #define VM_FREE_PAGE_TO_CPU(pg) ((struct uvm_cpu *)((uintptr_t)pg->offset))
411
412 #ifdef DEBUG
413 void uvm_pagezerocheck(struct vm_page *);
414 #endif /* DEBUG */
415
416 #endif /* _KERNEL */
417
418 #endif /* _UVM_UVM_PAGE_H_ */
419