uvm_page.h revision 1.73.2.3
1 /* $NetBSD: uvm_page.h,v 1.73.2.3 2011/11/11 10:34:24 yamt 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. 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 7.3 (Berkeley) 4/21/91 37 * from: Id: uvm_page.h,v 1.1.2.6 1998/02/04 02:31:42 chuck Exp 38 * 39 * 40 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 41 * All rights reserved. 42 * 43 * Permission to use, copy, modify and distribute this software and 44 * its documentation is hereby granted, provided that both the copyright 45 * notice and this permission notice appear in all copies of the 46 * software, derivative works or modified versions, and any portions 47 * thereof, and that both notices appear in supporting documentation. 48 * 49 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 50 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 51 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 52 * 53 * Carnegie Mellon requests users of this software to return to 54 * 55 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU 56 * School of Computer Science 57 * Carnegie Mellon University 58 * Pittsburgh PA 15213-3890 59 * 60 * any improvements or extensions that they make and grant Carnegie the 61 * rights to redistribute these changes. 62 */ 63 64 #ifndef _UVM_UVM_PAGE_H_ 65 #define _UVM_UVM_PAGE_H_ 66 67 /* 68 * uvm_page.h 69 */ 70 71 /* 72 * Resident memory system definitions. 73 */ 74 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 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) [or both]. 95 */ 96 97 /* 98 * locking note: the mach version of this data structure had bit 99 * fields for the flags, and the bit fields were divided into two 100 * items (depending on who locked what). some time, in BSD, the bit 101 * fields were dumped and all the flags were lumped into one short. 102 * that is fine for a single threaded uniprocessor OS, but bad if you 103 * want to actual make use of locking. so, we've separated things 104 * back out again. 105 * 106 * note the page structure has no lock of its own. 107 */ 108 109 #include <uvm/uvm_extern.h> 110 #include <uvm/uvm_pglist.h> 111 112 struct vm_page { 113 union { 114 TAILQ_ENTRY(vm_page) queue; 115 LIST_ENTRY(vm_page) list; 116 } pageq; /* queue info for FIFO 117 * queue or free list (P) */ 118 119 union { 120 struct { 121 struct vm_anon *o_anon; /* anon (O,P) */ 122 struct uvm_object *o_object; /* object (O,P) */ 123 } owner; 124 #define uanon u.owner.o_anon 125 #define uobject u.owner.o_object 126 LIST_ENTRY(vm_page) cpulist; 127 } u; 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 * PG_RDONLY and PG_HOLE acts like a "read-only count". ie. either of 164 * them is set, the page should not be mapped writably. typically 165 * they are set by pgo_get to inform the fault handler. 166 * 167 * if you want to renumber PG_CLEAN and PG_DIRTY, check __CTASSERTs in 168 * uvm_page_status.c first. 169 */ 170 171 #define PG_CLEAN 0x0001 /* page is known clean */ 172 #define PG_DIRTY 0x0002 /* page is known dirty */ 173 #define PG_BUSY 0x0004 /* page is locked */ 174 #define PG_WANTED 0x0008 /* someone is waiting for page */ 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 #define PG_TABLED 0x0200 /* page is in VP table */ 181 #define PG_HOLE 0x0400 /* XXX */ 182 183 #define PG_PAGER1 0x1000 /* pager-specific flag */ 184 185 #define UVM_PGFLAGBITS \ 186 "\20\1CLEAN\2DIRTY\3BUSY\4WANTED" \ 187 "\5PAGEOUT\6RELEASED\7FAKE\10RDONLY" \ 188 "\11ZERO\12TABLED\13HOLE" 189 190 #define PQ_FREE 0x0001 /* page is on free list */ 191 #define PQ_ANON 0x0002 /* page is part of an anon, rather 192 than an uvm_object */ 193 #define PQ_AOBJ 0x0004 /* page is part of an anonymous 194 uvm_object */ 195 #define PQ_SWAPBACKED (PQ_ANON|PQ_AOBJ) 196 #define PQ_READAHEAD 0x0008 /* read-ahead but has not been "hit" yet */ 197 198 #define PQ_PRIVATE1 0x0100 199 #define PQ_PRIVATE2 0x0200 200 #define PQ_PRIVATE3 0x0400 201 #define PQ_PRIVATE4 0x0800 202 #define PQ_PRIVATE5 0x1000 203 #define PQ_PRIVATE6 0x2000 204 #define PQ_PRIVATE7 0x4000 205 #define PQ_PRIVATE8 0x8000 206 207 #define UVM_PQFLAGBITS \ 208 "\20\1FREE\2ANON\3AOBJ\4READAHEAD" \ 209 "\11PRIVATE1\12PRIVATE2\13PRIVATE3\14PRIVATE4" \ 210 "\15PRIVATE5\16PRIVATE6\17PRIVATE7\20PRIVATE8" 211 212 /* 213 * physical memory layout structure 214 * 215 * MD vmparam.h must #define: 216 * VM_PHYSEG_MAX = max number of physical memory segments we support 217 * (if this is "1" then we revert to a "contig" case) 218 * VM_PHYSSEG_STRAT: memory sort/search options (for VM_PHYSEG_MAX > 1) 219 * - VM_PSTRAT_RANDOM: linear search (random order) 220 * - VM_PSTRAT_BSEARCH: binary search (sorted by address) 221 * - VM_PSTRAT_BIGFIRST: linear search (sorted by largest segment first) 222 * - others? 223 * XXXCDC: eventually we should purge all left-over global variables... 224 */ 225 #define VM_PSTRAT_RANDOM 1 226 #define VM_PSTRAT_BSEARCH 2 227 #define VM_PSTRAT_BIGFIRST 3 228 229 /* 230 * vm_physseg: describes one segment of physical memory 231 */ 232 struct vm_physseg { 233 paddr_t start; /* PF# of first page in segment */ 234 paddr_t end; /* (PF# of last page in segment) + 1 */ 235 paddr_t avail_start; /* PF# of first free page in segment */ 236 paddr_t avail_end; /* (PF# of last free page in segment) +1 */ 237 struct vm_page *pgs; /* vm_page structures (from start) */ 238 struct vm_page *lastpg; /* vm_page structure for end */ 239 int free_list; /* which free list they belong on */ 240 u_int start_hint; /* start looking for free pages here */ 241 /* protected by uvm_fpageqlock */ 242 #ifdef __HAVE_PMAP_PHYSSEG 243 struct pmap_physseg pmseg; /* pmap specific (MD) data */ 244 #endif 245 }; 246 247 #ifdef _KERNEL 248 249 /* 250 * globals 251 */ 252 253 extern bool vm_page_zero_enable; 254 255 /* 256 * physical memory config is stored in vm_physmem. 257 */ 258 259 #define VM_PHYSMEM_PTR(i) (&vm_physmem[i]) 260 #define VM_PHYSMEM_PTR_SWAP(i, j) \ 261 do { vm_physmem[(i)] = vm_physmem[(j)]; } while (0) 262 263 extern struct vm_physseg vm_physmem[VM_PHYSSEG_MAX]; 264 extern int vm_nphysseg; 265 266 /* 267 * prototypes: the following prototypes define the interface to pages 268 */ 269 270 void uvm_page_init(vaddr_t *, vaddr_t *); 271 #if defined(UVM_PAGE_TRKOWN) 272 void uvm_page_own(struct vm_page *, const char *); 273 #endif 274 #if !defined(PMAP_STEAL_MEMORY) 275 bool uvm_page_physget(paddr_t *); 276 #endif 277 void uvm_page_recolor(int); 278 void uvm_pageidlezero(void); 279 280 void uvm_pageactivate(struct vm_page *); 281 vaddr_t uvm_pageboot_alloc(vsize_t); 282 void uvm_pagecopy(struct vm_page *, struct vm_page *); 283 void uvm_pagedeactivate(struct vm_page *); 284 void uvm_pagedequeue(struct vm_page *); 285 void uvm_pageenqueue(struct vm_page *); 286 void uvm_pagefree(struct vm_page *); 287 void uvm_page_unbusy(struct vm_page **, int); 288 struct vm_page *uvm_pagelookup(struct uvm_object *, voff_t); 289 void uvm_pageunwire(struct vm_page *); 290 void uvm_pagewire(struct vm_page *); 291 void uvm_pagezero(struct vm_page *); 292 bool uvm_pageismanaged(paddr_t); 293 unsigned int uvm_pagegetdirty(struct vm_page *); 294 void uvm_pagemarkdirty(struct vm_page *, unsigned int); 295 bool uvm_pagecheckdirty(struct vm_page *, bool); 296 bool uvm_pagereadonly_p(struct vm_page *); 297 bool uvm_page_locked_p(struct vm_page *); 298 bool uvm_page_samelock_p(struct vm_page *, struct vm_page *); 299 300 /* 301 * page dirtiness status for uvm_pagegetdirty and uvm_pagemarkdirty 302 * 303 * UNKNOWN means that we need to consult pmap to know if the page is 304 * dirty or not. 305 * basically, UVM_PAGE_STATUS_CLEAN implies that the page has no writable 306 * mapping. 307 * 308 * if you want to renumber these, check __CTASSERTs in 309 * uvm_page_status.c first. 310 */ 311 #define UVM_PAGE_STATUS_UNKNOWN 0 312 #define UVM_PAGE_STATUS_CLEAN 1 313 #define UVM_PAGE_STATUS_DIRTY 2 314 #define UVM_PAGE_NUM_STATUS 3 315 316 int uvm_page_lookup_freelist(struct vm_page *); 317 318 int vm_physseg_find(paddr_t, int *); 319 struct vm_page *uvm_phys_to_vm_page(paddr_t); 320 paddr_t uvm_vm_page_to_phys(const struct vm_page *); 321 322 /* 323 * macros 324 */ 325 326 #define UVM_PAGE_TREE_PENALTY 4 /* XXX: a guess */ 327 328 #define VM_PAGE_TO_PHYS(entry) uvm_vm_page_to_phys(entry) 329 330 #ifdef __HAVE_VM_PAGE_MD 331 #define VM_PAGE_TO_MD(pg) (&(pg)->mdpage) 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 Thu Oct 23 22:10:10 GMT 2025