1 /* $NetBSD: uvm_page.h,v 1.49 2007/07/21 19:21:55 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@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 (simple_lock's). so, we've 112 * separated things 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) pageq; /* queue info for FIFO 122 * queue or free list (P) */ 123 TAILQ_ENTRY(vm_page) hashq; /* hash table links (O)*/ 124 TAILQ_ENTRY(vm_page) listq; /* pages in same object (O)*/ 125 126 struct vm_anon *uanon; /* anon (O,P) */ 127 struct uvm_object *uobject; /* object (O,P) */ 128 voff_t offset; /* offset into object (O,P) */ 129 uint16_t flags; /* object flags [O] */ 130 uint16_t loan_count; /* number of active loans 131 * to read: [O or P] 132 * to modify: [O _and_ P] */ 133 uint16_t wire_count; /* wired down map refs [P] */ 134 uint16_t pqflags; /* page queue flags [P] */ 135 paddr_t phys_addr; /* physical address of page */ 136 137 #ifdef __HAVE_VM_PAGE_MD 138 struct vm_page_md mdpage; /* pmap-specific data */ 139 #endif 140 141 #if defined(UVM_PAGE_TRKOWN) 142 /* debugging fields to track page ownership */ 143 pid_t owner; /* proc that set PG_BUSY */ 144 lwpid_t lowner; /* lwp that set PG_BUSY */ 145 const char *owner_tag; /* why it was set busy */ 146 #endif 147 }; 148 149 /* 150 * These are the flags defined for vm_page. 151 */ 152 153 /* 154 * locking rules: 155 * PG_ ==> locked by object lock 156 * PQ_ ==> lock by page queue lock 157 * PQ_FREE is locked by free queue lock and is mutex with all other PQs 158 * 159 * PG_ZERO is used to indicate that a page has been pre-zero'd. This flag 160 * is only set when the page is on no queues, and is cleared when the page 161 * is placed on the free list. 162 */ 163 164 #define PG_BUSY 0x0001 /* page is locked */ 165 #define PG_WANTED 0x0002 /* someone is waiting for page */ 166 #define PG_TABLED 0x0004 /* page is in VP table */ 167 #define PG_CLEAN 0x0008 /* page has not been modified */ 168 #define PG_PAGEOUT 0x0010 /* page to be freed for pagedaemon */ 169 #define PG_RELEASED 0x0020 /* page to be freed when unbusied */ 170 #define PG_FAKE 0x0040 /* page is not yet initialized */ 171 #define PG_RDONLY 0x0080 /* page must be mapped read-only */ 172 #define PG_ZERO 0x0100 /* page is pre-zero'd */ 173 174 #define PG_PAGER1 0x1000 /* pager-specific flag */ 175 176 #define UVM_PGFLAGBITS \ 177 "\20\1BUSY\2WANTED\3TABLED\4CLEAN\5PAGEOUT\6RELEASED\7FAKE\10RDONLY" \ 178 "\11ZERO\15PAGER1" 179 180 #define PQ_FREE 0x0001 /* page is on free list */ 181 #define PQ_ANON 0x0002 /* page is part of an anon, rather 182 than an uvm_object */ 183 #define PQ_AOBJ 0x0004 /* page is part of an anonymous 184 uvm_object */ 185 #define PQ_SWAPBACKED (PQ_ANON|PQ_AOBJ) 186 #define PQ_READAHEAD 0x0008 /* read-ahead but has not been "hit" yet */ 187 188 #define PQ_PRIVATE1 0x0100 189 #define PQ_PRIVATE2 0x0200 190 #define PQ_PRIVATE3 0x0400 191 #define PQ_PRIVATE4 0x0800 192 #define PQ_PRIVATE5 0x1000 193 #define PQ_PRIVATE6 0x2000 194 #define PQ_PRIVATE7 0x4000 195 #define PQ_PRIVATE8 0x8000 196 197 #define UVM_PQFLAGBITS \ 198 "\20\1FREE\2ANON\3AOBJ\4READAHEAD" \ 199 "\11PRIVATE1\12PRIVATE2\13PRIVATE3\14PRIVATE4" \ 200 "\15PRIVATE5\16PRIVATE6\17PRIVATE7\20PRIVATE8" 201 202 /* 203 * physical memory layout structure 204 * 205 * MD vmparam.h must #define: 206 * VM_PHYSEG_MAX = max number of physical memory segments we support 207 * (if this is "1" then we revert to a "contig" case) 208 * VM_PHYSSEG_STRAT: memory sort/search options (for VM_PHYSEG_MAX > 1) 209 * - VM_PSTRAT_RANDOM: linear search (random order) 210 * - VM_PSTRAT_BSEARCH: binary search (sorted by address) 211 * - VM_PSTRAT_BIGFIRST: linear search (sorted by largest segment first) 212 * - others? 213 * XXXCDC: eventually we should purge all left-over global variables... 214 */ 215 #define VM_PSTRAT_RANDOM 1 216 #define VM_PSTRAT_BSEARCH 2 217 #define VM_PSTRAT_BIGFIRST 3 218 219 /* 220 * vm_physseg: describes one segment of physical memory 221 */ 222 struct vm_physseg { 223 paddr_t start; /* PF# of first page in segment */ 224 paddr_t end; /* (PF# of last page in segment) + 1 */ 225 paddr_t avail_start; /* PF# of first free page in segment */ 226 paddr_t avail_end; /* (PF# of last free page in segment) +1 */ 227 int free_list; /* which free list they belong on */ 228 struct vm_page *pgs; /* vm_page structures (from start) */ 229 struct vm_page *lastpg; /* vm_page structure for end */ 230 #ifdef __HAVE_PMAP_PHYSSEG 231 struct pmap_physseg pmseg; /* pmap specific (MD) data */ 232 #endif 233 }; 234 235 #ifdef _KERNEL 236 237 /* 238 * globals 239 */ 240 241 extern bool vm_page_zero_enable; 242 243 /* 244 * physical memory config is stored in vm_physmem. 245 */ 246 247 extern struct vm_physseg vm_physmem[VM_PHYSSEG_MAX]; 248 extern int vm_nphysseg; 249 250 /* 251 * prototypes: the following prototypes define the interface to pages 252 */ 253 254 void uvm_page_init(vaddr_t *, vaddr_t *); 255 #if defined(UVM_PAGE_TRKOWN) 256 void uvm_page_own(struct vm_page *, const char *); 257 #endif 258 #if !defined(PMAP_STEAL_MEMORY) 259 bool uvm_page_physget(paddr_t *); 260 #endif 261 void uvm_page_rehash(void); 262 void uvm_page_recolor(int); 263 void uvm_pageidlezero(void); 264 265 void uvm_pageactivate(struct vm_page *); 266 vaddr_t uvm_pageboot_alloc(vsize_t); 267 void uvm_pagecopy(struct vm_page *, struct vm_page *); 268 void uvm_pagedeactivate(struct vm_page *); 269 void uvm_pagedequeue(struct vm_page *); 270 void uvm_pageenqueue(struct vm_page *); 271 void uvm_pagefree(struct vm_page *); 272 void uvm_page_unbusy(struct vm_page **, int); 273 struct vm_page *uvm_pagelookup(struct uvm_object *, voff_t); 274 void uvm_pageunwire(struct vm_page *); 275 void uvm_pagewait(struct vm_page *, int); 276 void uvm_pagewake(struct vm_page *); 277 void uvm_pagewire(struct vm_page *); 278 void uvm_pagezero(struct vm_page *); 279 280 int uvm_page_lookup_freelist(struct vm_page *); 281 282 static struct vm_page *PHYS_TO_VM_PAGE(paddr_t); 283 static int vm_physseg_find(paddr_t, int *); 284 285 /* 286 * macros 287 */ 288 289 #define UVM_PAGE_HASH_PENALTY 4 /* XXX: a guess */ 290 291 #define uvm_lock_pageq() simple_lock(&uvm.pageqlock) 292 #define uvm_unlock_pageq() simple_unlock(&uvm.pageqlock) 293 #define UVM_LOCK_ASSERT_PAGEQ() LOCK_ASSERT(simple_lock_held(&uvm.pageqlock)) 294 295 #define uvm_pagehash(obj,off) \ 296 (((unsigned long)obj+(unsigned long)atop(off)) & uvm.page_hashmask) 297 298 #define UVM_PAGEZERO_TARGET (uvmexp.free) 299 300 #define VM_PAGE_TO_PHYS(entry) ((entry)->phys_addr) 301 302 /* 303 * Compute the page color bucket for a given page. 304 */ 305 #define VM_PGCOLOR_BUCKET(pg) \ 306 (atop(VM_PAGE_TO_PHYS((pg))) & uvmexp.colormask) 307 308 /* 309 * when VM_PHYSSEG_MAX is 1, we can simplify these functions 310 */ 311 312 /* 313 * vm_physseg_find: find vm_physseg structure that belongs to a PA 314 */ 315 static __inline int 316 vm_physseg_find(pframe, offp) 317 paddr_t pframe; 318 int *offp; 319 { 320 #if VM_PHYSSEG_MAX == 1 321 322 /* 'contig' case */ 323 if (pframe >= vm_physmem[0].start && pframe < vm_physmem[0].end) { 324 if (offp) 325 *offp = pframe - vm_physmem[0].start; 326 return(0); 327 } 328 return(-1); 329 330 #elif (VM_PHYSSEG_STRAT == VM_PSTRAT_BSEARCH) 331 /* binary search for it */ 332 u_int start, len, try; 333 334 /* 335 * if try is too large (thus target is less than try) we reduce 336 * the length to trunc(len/2) [i.e. everything smaller than "try"] 337 * 338 * if the try is too small (thus target is greater than try) then 339 * we set the new start to be (try + 1). this means we need to 340 * reduce the length to (round(len/2) - 1). 341 * 342 * note "adjust" below which takes advantage of the fact that 343 * (round(len/2) - 1) == trunc((len - 1) / 2) 344 * for any value of len we may have 345 */ 346 347 for (start = 0, len = vm_nphysseg ; len != 0 ; len = len / 2) { 348 try = start + (len / 2); /* try in the middle */ 349 350 /* start past our try? */ 351 if (pframe >= vm_physmem[try].start) { 352 /* was try correct? */ 353 if (pframe < vm_physmem[try].end) { 354 if (offp) 355 *offp = pframe - vm_physmem[try].start; 356 return(try); /* got it */ 357 } 358 start = try + 1; /* next time, start here */ 359 len--; /* "adjust" */ 360 } else { 361 /* 362 * pframe before try, just reduce length of 363 * region, done in "for" loop 364 */ 365 } 366 } 367 return(-1); 368 369 #else 370 /* linear search for it */ 371 int lcv; 372 373 for (lcv = 0; lcv < vm_nphysseg; lcv++) { 374 if (pframe >= vm_physmem[lcv].start && 375 pframe < vm_physmem[lcv].end) { 376 if (offp) 377 *offp = pframe - vm_physmem[lcv].start; 378 return(lcv); /* got it */ 379 } 380 } 381 return(-1); 382 383 #endif 384 } 385 386 387 /* 388 * IS_VM_PHYSADDR: only used my mips/pmax/pica trap/pmap. 389 */ 390 391 #define IS_VM_PHYSADDR(PA) (vm_physseg_find(atop(PA), NULL) != -1) 392 393 /* 394 * PHYS_TO_VM_PAGE: find vm_page for a PA. used by MI code to get vm_pages 395 * back from an I/O mapping (ugh!). used in some MD code as well. 396 */ 397 static __inline struct vm_page * 398 PHYS_TO_VM_PAGE(pa) 399 paddr_t pa; 400 { 401 paddr_t pf = atop(pa); 402 int off; 403 int psi; 404 405 psi = vm_physseg_find(pf, &off); 406 if (psi != -1) 407 return(&vm_physmem[psi].pgs[off]); 408 return(NULL); 409 } 410 411 #define VM_PAGE_IS_FREE(entry) ((entry)->pqflags & PQ_FREE) 412 413 #ifdef DEBUG 414 void uvm_pagezerocheck(struct vm_page *); 415 #endif /* DEBUG */ 416 417 #endif /* _KERNEL */ 418 419 #endif /* _UVM_UVM_PAGE_H_ */ 420