uvm_page.h revision 1.59.2.12
1 /* $NetBSD: uvm_page.h,v 1.59.2.12 2010/02/12 13:40:00 uebayasi 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 red-black tree rooted with the containing 88 * object is used to quickly perform object+ 89 * offset lookups 90 * 91 * A list of all pages for a given object, 92 * so they can be quickly deactivated at 93 * time of deallocation. 94 * 95 * An ordered list of pages due for pageout. 96 * 97 * In addition, the structure contains the object 98 * and offset to which this page belongs (for pageout), 99 * and sundry status bits. 100 * 101 * Fields in this structure are locked either by the lock on the 102 * object that the page belongs to (O) or by the lock on the page 103 * queues (P) [or both]. 104 */ 105 106 /* 107 * locking note: the mach version of this data structure had bit 108 * fields for the flags, and the bit fields were divided into two 109 * items (depending on who locked what). some time, in BSD, the bit 110 * fields were dumped and all the flags were lumped into one short. 111 * that is fine for a single threaded uniprocessor OS, but bad if you 112 * want to actual make use of locking. so, we've separated things 113 * back out again. 114 * 115 * note the page structure has no lock of its own. 116 */ 117 118 #include <uvm/uvm_extern.h> 119 #include <uvm/uvm_pglist.h> 120 121 #include <sys/rb.h> 122 123 struct vm_page { 124 struct rb_node rb_node; /* tree of pages in obj (O) */ 125 126 union { 127 TAILQ_ENTRY(vm_page) queue; 128 LIST_ENTRY(vm_page) list; 129 } pageq; /* queue info for FIFO 130 * queue or free list (P) */ 131 union { 132 TAILQ_ENTRY(vm_page) queue; 133 LIST_ENTRY(vm_page) list; 134 } listq; /* pages in same object (O)*/ 135 136 struct vm_anon *uanon; /* anon (O,P) */ 137 struct uvm_object *uobject; /* object (O,P) */ 138 voff_t offset; /* offset into object (O,P) */ 139 uint16_t flags; /* object flags [O] */ 140 uint16_t loan_count; /* number of active loans 141 * to read: [O or P] 142 * to modify: [O _and_ P] */ 143 uint16_t wire_count; /* wired down map refs [P] */ 144 uint16_t pqflags; /* page queue flags [P] */ 145 146 #ifdef __HAVE_VM_PAGE_MD 147 struct vm_page_md mdpage; /* pmap-specific data */ 148 #endif 149 150 #if defined(UVM_PAGE_TRKOWN) 151 /* debugging fields to track page ownership */ 152 pid_t owner; /* proc that set PG_BUSY */ 153 lwpid_t lowner; /* lwp that set PG_BUSY */ 154 const char *owner_tag; /* why it was set busy */ 155 #endif 156 }; 157 158 /* 159 * These are the flags defined for vm_page. 160 */ 161 162 /* 163 * locking rules: 164 * PG_ ==> locked by object lock 165 * PQ_ ==> lock by page queue lock 166 * PQ_FREE is locked by free queue lock and is mutex with all other PQs 167 * 168 * PG_ZERO is used to indicate that a page has been pre-zero'd. This flag 169 * is only set when the page is on no queues, and is cleared when the page 170 * is placed on the free list. 171 */ 172 173 #define PG_BUSY 0x0001 /* page is locked */ 174 #define PG_WANTED 0x0002 /* someone is waiting for page */ 175 #define PG_TABLED 0x0004 /* page is in VP table */ 176 #define PG_CLEAN 0x0008 /* page has not been modified */ 177 #define PG_PAGEOUT 0x0010 /* page to be freed for pagedaemon */ 178 #define PG_RELEASED 0x0020 /* page to be freed when unbusied */ 179 #define PG_FAKE 0x0040 /* page is not yet initialized */ 180 #define PG_RDONLY 0x0080 /* page must be mapped read-only */ 181 #define PG_ZERO 0x0100 /* page is pre-zero'd */ 182 183 #define PG_PAGER1 0x1000 /* pager-specific flag */ 184 185 #define UVM_PGFLAGBITS \ 186 "\20\1BUSY\2WANTED\3TABLED\4CLEAN\5PAGEOUT\6RELEASED\7FAKE\10RDONLY" \ 187 "\11ZERO\15PAGER1" 188 189 #define PQ_FREE 0x0001 /* page is on free list */ 190 #define PQ_ANON 0x0002 /* page is part of an anon, rather 191 than an uvm_object */ 192 #define PQ_AOBJ 0x0004 /* page is part of an anonymous 193 uvm_object */ 194 #define PQ_SWAPBACKED (PQ_ANON|PQ_AOBJ) 195 #define PQ_READAHEAD 0x0008 /* read-ahead but has not been "hit" yet */ 196 197 #define PQ_PRIVATE1 0x0100 198 #define PQ_PRIVATE2 0x0200 199 #define PQ_PRIVATE3 0x0400 200 #define PQ_PRIVATE4 0x0800 201 #define PQ_PRIVATE5 0x1000 202 #define PQ_PRIVATE6 0x2000 203 #define PQ_PRIVATE7 0x4000 204 #define PQ_PRIVATE8 0x8000 205 206 #define UVM_PQFLAGBITS \ 207 "\20\1FREE\2ANON\3AOBJ\4READAHEAD" \ 208 "\11PRIVATE1\12PRIVATE2\13PRIVATE3\14PRIVATE4" \ 209 "\15PRIVATE5\16PRIVATE6\17PRIVATE7\20PRIVATE8" 210 211 /* 212 * physical memory layout structure 213 * 214 * MD vmparam.h must #define: 215 * VM_PHYSEG_MAX = max number of physical memory segments we support 216 * (if this is "1" then we revert to a "contig" case) 217 * VM_PHYSSEG_STRAT: memory sort/search options (for VM_PHYSEG_MAX > 1) 218 * - VM_PSTRAT_RANDOM: linear search (random order) 219 * - VM_PSTRAT_BSEARCH: binary search (sorted by address) 220 * - VM_PSTRAT_BIGFIRST: linear search (sorted by largest segment first) 221 * - others? 222 * XXXCDC: eventually we should purge all left-over global variables... 223 */ 224 #define VM_PSTRAT_RANDOM 1 225 #define VM_PSTRAT_BSEARCH 2 226 #define VM_PSTRAT_BIGFIRST 3 227 228 /* 229 * vm_physseg: describes one segment of physical memory 230 */ 231 struct vm_physseg { 232 paddr_t start; /* PF# of first page in segment */ 233 paddr_t end; /* (PF# of last page in segment) + 1 */ 234 paddr_t avail_start; /* PF# of first free page in segment */ 235 paddr_t avail_end; /* (PF# of last free page in segment) +1 */ 236 int free_list; /* which free list they belong on */ 237 struct vm_page *pgs; /* vm_page structures (from start) */ 238 struct vm_page *endpg; /* vm_page structure for end */ 239 #ifdef __HAVE_PMAP_PHYSSEG 240 struct pmap_physseg pmseg; /* pmap specific (MD) data */ 241 #endif 242 }; 243 244 #ifdef _KERNEL 245 246 /* 247 * globals 248 */ 249 250 extern bool vm_page_zero_enable; 251 252 /* 253 * physical memory config is stored in vm_physmem. 254 */ 255 256 extern struct vm_physseg vm_physmem[VM_PHYSSEG_MAX]; 257 extern int vm_nphysmem; 258 #ifdef XIP 259 extern struct vm_physseg vm_physdev[VM_PHYSSEG_MAX]; 260 extern int vm_nphysdev; 261 #endif 262 263 #define vm_nphysseg vm_nphysmem /* XXX backward compat */ 264 265 /* 266 * prototypes: the following prototypes define the interface to pages 267 */ 268 269 void uvm_page_init(vaddr_t *, vaddr_t *); 270 #if defined(UVM_PAGE_TRKOWN) 271 void uvm_page_own(struct vm_page *, const char *); 272 #endif 273 #if !defined(PMAP_STEAL_MEMORY) 274 bool uvm_page_physget(paddr_t *); 275 #endif 276 void uvm_page_recolor(int); 277 void uvm_pageidlezero(void); 278 279 void uvm_pageactivate(struct vm_page *); 280 vaddr_t uvm_pageboot_alloc(vsize_t); 281 void uvm_pagecopy(struct vm_page *, struct vm_page *); 282 void uvm_pagedeactivate(struct vm_page *); 283 void uvm_pagedequeue(struct vm_page *); 284 void uvm_pageenqueue(struct vm_page *); 285 void uvm_pagefree(struct vm_page *); 286 void uvm_page_unbusy(struct vm_page **, int); 287 struct vm_page *uvm_pagelookup(struct uvm_object *, voff_t); 288 void uvm_pageunwire(struct vm_page *); 289 void uvm_pagewait(struct vm_page *, int); 290 void uvm_pagewake(struct vm_page *); 291 void uvm_pagewire(struct vm_page *); 292 void uvm_pagezero(struct vm_page *); 293 bool uvm_pageismanaged(paddr_t); 294 #ifdef DEVICE_PAGE 295 bool uvm_pageisdevice_p(const struct vm_page *); 296 #else 297 #define uvm_pageisdevice_p(x) false 298 #endif 299 300 int uvm_page_lookup_freelist(struct vm_page *); 301 302 int vm_physseg_find(paddr_t, int *); 303 struct vm_page *uvm_phys_to_vm_page(paddr_t); 304 paddr_t uvm_vm_page_to_phys(const struct vm_page *); 305 #ifdef XIP 306 int vm_physseg_find_device(paddr_t, int *); 307 struct vm_page *uvm_phys_to_vm_page_device(paddr_t); 308 paddr_t uvm_vm_page_to_phys_device(const struct vm_page *); 309 #endif 310 311 #ifdef XIP 312 void vm_page_device_mdpage_insert(struct vm_page *); 313 void vm_page_device_mdpage_remove(struct vm_page *); 314 struct vm_page_md *vm_page_device_mdpage_lookup(struct vm_page *); 315 #endif 316 317 /* 318 * macros 319 */ 320 321 #define UVM_PAGE_TREE_PENALTY 4 /* XXX: a guess */ 322 323 #define VM_PAGE_TO_PHYS(entry) uvm_vm_page_to_phys(entry) 324 325 #ifdef __HAVE_VM_PAGE_MD 326 #ifndef XIP 327 #define VM_PAGE_TO_MD(pg) (&(pg)->mdpage) 328 #else 329 #define VM_PAGE_TO_MD(pg) \ 330 (uvm_pageisdevice_p(pg) ? vm_page_device_mdpage_lookup(pg) : &(pg)->mdpage) 331 #endif 332 #endif 333 334 /* 335 * Compute the page color bucket for a given page. 336 */ 337 #define VM_PGCOLOR_BUCKET(pg) \ 338 (atop(VM_PAGE_TO_PHYS((pg))) & uvmexp.colormask) 339 340 #define PHYS_TO_VM_PAGE(pa) uvm_phys_to_vm_page(pa) 341 342 #define VM_PAGE_IS_FREE(entry) ((entry)->pqflags & PQ_FREE) 343 #define VM_FREE_PAGE_TO_CPU(pg) ((struct uvm_cpu *)((uintptr_t)pg->offset)) 344 345 #ifdef DEBUG 346 void uvm_pagezerocheck(struct vm_page *); 347 #endif /* DEBUG */ 348 349 #endif /* _KERNEL */ 350 351 #endif /* _UVM_UVM_PAGE_H_ */ 352
Indexes created Wed Oct 22 13:09:56 GMT 2025