1 /* $NetBSD: pmap.h,v 1.21 2008/12/09 20:45:46 pooka Exp $ */ 2 3 /* 4 * 5 * Copyright (c) 1997 Charles D. Cranor and Washington University. 6 * All rights reserved. 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 acknowledgment: 18 * This product includes software developed by Charles D. Cranor and 19 * Washington University. 20 * 4. The name of the author may not be used to endorse or promote products 21 * derived from this software without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 /* 36 * Copyright (c) 2001 Wasabi Systems, Inc. 37 * All rights reserved. 38 * 39 * Written by Frank van der Linden for Wasabi Systems, Inc. 40 * 41 * Redistribution and use in source and binary forms, with or without 42 * modification, are permitted provided that the following conditions 43 * are met: 44 * 1. Redistributions of source code must retain the above copyright 45 * notice, this list of conditions and the following disclaimer. 46 * 2. Redistributions in binary form must reproduce the above copyright 47 * notice, this list of conditions and the following disclaimer in the 48 * documentation and/or other materials provided with the distribution. 49 * 3. All advertising materials mentioning features or use of this software 50 * must display the following acknowledgement: 51 * This product includes software developed for the NetBSD Project by 52 * Wasabi Systems, Inc. 53 * 4. The name of Wasabi Systems, Inc. may not be used to endorse 54 * or promote products derived from this software without specific prior 55 * written permission. 56 * 57 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND 58 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 59 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 60 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC 61 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 62 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 63 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 64 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 65 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 66 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 67 * POSSIBILITY OF SUCH DAMAGE. 68 */ 69 70 /* 71 * pmap.h: see pmap.c for the history of this pmap module. 72 */ 73 74 #ifndef _X86_PMAP_H_ 75 #define _X86_PMAP_H_ 76 77 #define ptei(VA) (((VA_SIGN_POS(VA)) & L1_MASK) >> L1_SHIFT) 78 79 /* 80 * pl*_pi: index in the ptp page for a pde mapping a VA. 81 * (pl*_i below is the index in the virtual array of all pdes per level) 82 */ 83 #define pl1_pi(VA) (((VA_SIGN_POS(VA)) & L1_MASK) >> L1_SHIFT) 84 #define pl2_pi(VA) (((VA_SIGN_POS(VA)) & L2_MASK) >> L2_SHIFT) 85 #define pl3_pi(VA) (((VA_SIGN_POS(VA)) & L3_MASK) >> L3_SHIFT) 86 #define pl4_pi(VA) (((VA_SIGN_POS(VA)) & L4_MASK) >> L4_SHIFT) 87 88 /* 89 * pl*_i: generate index into pde/pte arrays in virtual space 90 */ 91 #define pl1_i(VA) (((VA_SIGN_POS(VA)) & L1_FRAME) >> L1_SHIFT) 92 #define pl2_i(VA) (((VA_SIGN_POS(VA)) & L2_FRAME) >> L2_SHIFT) 93 #define pl3_i(VA) (((VA_SIGN_POS(VA)) & L3_FRAME) >> L3_SHIFT) 94 #define pl4_i(VA) (((VA_SIGN_POS(VA)) & L4_FRAME) >> L4_SHIFT) 95 #define pl_i(va, lvl) \ 96 (((VA_SIGN_POS(va)) & ptp_masks[(lvl)-1]) >> ptp_shifts[(lvl)-1]) 97 98 #define pl_i_roundup(va, lvl) pl_i((va)+ ~ptp_masks[(lvl)-1], (lvl)) 99 100 /* 101 * PTP macros: 102 * a PTP's index is the PD index of the PDE that points to it 103 * a PTP's offset is the byte-offset in the PTE space that this PTP is at 104 * a PTP's VA is the first VA mapped by that PTP 105 */ 106 107 #define ptp_va2o(va, lvl) (pl_i(va, (lvl)+1) * PAGE_SIZE) 108 109 /* size of a PDP: usually one page, exept for PAE */ 110 #ifdef PAE 111 #define PDP_SIZE 4 112 #else 113 #define PDP_SIZE 1 114 #endif 115 116 117 #if defined(_KERNEL) 118 /* 119 * pmap data structures: see pmap.c for details of locking. 120 */ 121 122 /* 123 * we maintain a list of all non-kernel pmaps 124 */ 125 126 LIST_HEAD(pmap_head, pmap); /* struct pmap_head: head of a pmap list */ 127 128 /* 129 * the pmap structure 130 * 131 * note that the pm_obj contains the simple_lock, the reference count, 132 * page list, and number of PTPs within the pmap. 133 * 134 * pm_lock is the same as the spinlock for vm object 0. Changes to 135 * the other objects may only be made if that lock has been taken 136 * (the other object locks are only used when uvm_pagealloc is called) 137 * 138 * XXX If we ever support processor numbers higher than 31, we'll have 139 * XXX to rethink the CPU mask. 140 */ 141 142 struct pmap { 143 struct uvm_object pm_obj[PTP_LEVELS-1]; /* objects for lvl >= 1) */ 144 #define pm_lock pm_obj[0].vmobjlock 145 LIST_ENTRY(pmap) pm_list; /* list (lck by pm_list lock) */ 146 pd_entry_t *pm_pdir; /* VA of PD (lck by object lock) */ 147 #ifdef PAE 148 paddr_t pm_pdirpa[PDP_SIZE]; 149 #else 150 paddr_t pm_pdirpa; /* PA of PD (read-only after create) */ 151 #endif 152 struct vm_page *pm_ptphint[PTP_LEVELS-1]; 153 /* pointer to a PTP in our pmap */ 154 struct pmap_statistics pm_stats; /* pmap stats (lck by object lock) */ 155 156 #if !defined(__x86_64__) 157 vaddr_t pm_hiexec; /* highest executable mapping */ 158 #endif /* !defined(__x86_64__) */ 159 int pm_flags; /* see below */ 160 161 union descriptor *pm_ldt; /* user-set LDT */ 162 int pm_ldt_len; /* number of LDT entries */ 163 int pm_ldt_sel; /* LDT selector */ 164 uint32_t pm_cpus; /* mask of CPUs using pmap */ 165 uint32_t pm_kernel_cpus; /* mask of CPUs using kernel part 166 of pmap */ 167 }; 168 169 /* pm_flags */ 170 #define PMF_USER_LDT 0x01 /* pmap has user-set LDT */ 171 172 /* macro to access pm_pdirpa */ 173 #ifdef PAE 174 #define pmap_pdirpa(pmap, index) \ 175 ((pmap)->pm_pdirpa[l2tol3(index)] + l2tol2(index) * sizeof(pd_entry_t)) 176 #else 177 #define pmap_pdirpa(pmap, index) \ 178 ((pmap)->pm_pdirpa + (index) * sizeof(pd_entry_t)) 179 #endif 180 181 /* 182 * global kernel variables 183 */ 184 185 /* PDPpaddr: is the physical address of the kernel's PDP */ 186 extern u_long PDPpaddr; 187 188 extern int pmap_pg_g; /* do we support PG_G? */ 189 extern long nkptp[PTP_LEVELS]; 190 191 /* 192 * macros 193 */ 194 195 #define pmap_resident_count(pmap) ((pmap)->pm_stats.resident_count) 196 #define pmap_wired_count(pmap) ((pmap)->pm_stats.wired_count) 197 198 #define pmap_clear_modify(pg) pmap_clear_attrs(pg, PG_M) 199 #define pmap_clear_reference(pg) pmap_clear_attrs(pg, PG_U) 200 #define pmap_copy(DP,SP,D,L,S) 201 #define pmap_is_modified(pg) pmap_test_attrs(pg, PG_M) 202 #define pmap_is_referenced(pg) pmap_test_attrs(pg, PG_U) 203 #define pmap_move(DP,SP,D,L,S) 204 #define pmap_phys_address(ppn) x86_ptob(ppn) 205 #define pmap_valid_entry(E) ((E) & PG_V) /* is PDE or PTE valid? */ 206 207 208 /* 209 * prototypes 210 */ 211 212 void pmap_activate(struct lwp *); 213 void pmap_bootstrap(vaddr_t); 214 bool pmap_clear_attrs(struct vm_page *, unsigned); 215 void pmap_deactivate(struct lwp *); 216 void pmap_page_remove (struct vm_page *); 217 void pmap_remove(struct pmap *, vaddr_t, vaddr_t); 218 bool pmap_test_attrs(struct vm_page *, unsigned); 219 void pmap_write_protect(struct pmap *, vaddr_t, vaddr_t, vm_prot_t); 220 void pmap_load(void); 221 paddr_t pmap_init_tmp_pgtbl(paddr_t); 222 void pmap_remove_all(struct pmap *); 223 224 vaddr_t reserve_dumppages(vaddr_t); /* XXX: not a pmap fn */ 225 226 void pmap_tlb_shootdown(pmap_t, vaddr_t, vaddr_t, pt_entry_t); 227 void pmap_tlb_shootwait(void); 228 229 #define PMAP_GROWKERNEL /* turn on pmap_growkernel interface */ 230 #define PMAP_FORK /* turn on pmap_fork interface */ 231 232 /* 233 * Do idle page zero'ing uncached to avoid polluting the cache. 234 */ 235 bool pmap_pageidlezero(paddr_t); 236 #define PMAP_PAGEIDLEZERO(pa) pmap_pageidlezero((pa)) 237 238 /* 239 * inline functions 240 */ 241 242 /* 243 * pmap_update_pg: flush one page from the TLB (or flush the whole thing 244 * if hardware doesn't support one-page flushing) 245 */ 246 247 __inline static void __unused 248 pmap_update_pg(vaddr_t va) 249 { 250 invlpg(va); 251 } 252 253 /* 254 * pmap_update_2pg: flush two pages from the TLB 255 */ 256 257 __inline static void __unused 258 pmap_update_2pg(vaddr_t va, vaddr_t vb) 259 { 260 invlpg(va); 261 invlpg(vb); 262 } 263 264 /* 265 * pmap_page_protect: change the protection of all recorded mappings 266 * of a managed page 267 * 268 * => this function is a frontend for pmap_page_remove/pmap_clear_attrs 269 * => we only have to worry about making the page more protected. 270 * unprotecting a page is done on-demand at fault time. 271 */ 272 273 __inline static void __unused 274 pmap_page_protect(struct vm_page *pg, vm_prot_t prot) 275 { 276 if ((prot & VM_PROT_WRITE) == 0) { 277 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) { 278 (void) pmap_clear_attrs(pg, PG_RW); 279 } else { 280 pmap_page_remove(pg); 281 } 282 } 283 } 284 285 /* 286 * pmap_protect: change the protection of pages in a pmap 287 * 288 * => this function is a frontend for pmap_remove/pmap_write_protect 289 * => we only have to worry about making the page more protected. 290 * unprotecting a page is done on-demand at fault time. 291 */ 292 293 __inline static void __unused 294 pmap_protect(struct pmap *pmap, vaddr_t sva, vaddr_t eva, vm_prot_t prot) 295 { 296 if ((prot & VM_PROT_WRITE) == 0) { 297 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) { 298 pmap_write_protect(pmap, sva, eva, prot); 299 } else { 300 pmap_remove(pmap, sva, eva); 301 } 302 } 303 } 304 305 /* 306 * various address inlines 307 * 308 * vtopte: return a pointer to the PTE mapping a VA, works only for 309 * user and PT addresses 310 * 311 * kvtopte: return a pointer to the PTE mapping a kernel VA 312 */ 313 314 #include <lib/libkern/libkern.h> 315 316 static __inline pt_entry_t * __unused 317 vtopte(vaddr_t va) 318 { 319 320 KASSERT(va < VM_MIN_KERNEL_ADDRESS); 321 322 return (PTE_BASE + pl1_i(va)); 323 } 324 325 static __inline pt_entry_t * __unused 326 kvtopte(vaddr_t va) 327 { 328 pd_entry_t *pde; 329 330 KASSERT(va >= VM_MIN_KERNEL_ADDRESS); 331 332 pde = L2_BASE + pl2_i(va); 333 if (*pde & PG_PS) 334 return ((pt_entry_t *)pde); 335 336 return (PTE_BASE + pl1_i(va)); 337 } 338 339 paddr_t vtophys(vaddr_t); 340 vaddr_t pmap_map(vaddr_t, paddr_t, paddr_t, vm_prot_t); 341 void pmap_cpu_init_early(struct cpu_info *); 342 void pmap_cpu_init_late(struct cpu_info *); 343 bool sse2_idlezero_page(void *); 344 345 346 #ifdef XEN 347 348 #define XPTE_MASK L1_FRAME 349 /* XPTE_SHIFT = L1_SHIFT - log2(sizeof(pt_entry_t)) */ 350 #if defined(__x86_64__) || defined(PAE) 351 #define XPTE_SHIFT 9 352 #else 353 #define XPTE_SHIFT 10 354 #endif 355 356 /* PTE access inline fuctions */ 357 358 /* 359 * Get the machine address of the pointed pte 360 * We use hardware MMU to get value so works only for levels 1-3 361 */ 362 363 static __inline paddr_t 364 xpmap_ptetomach(pt_entry_t *pte) 365 { 366 pt_entry_t *up_pte; 367 vaddr_t va = (vaddr_t) pte; 368 369 va = ((va & XPTE_MASK) >> XPTE_SHIFT) | (vaddr_t) PTE_BASE; 370 up_pte = (pt_entry_t *) va; 371 372 return (paddr_t) (((*up_pte) & PG_FRAME) + (((vaddr_t) pte) & (~PG_FRAME & ~VA_SIGN_MASK))); 373 } 374 375 /* 376 * xpmap_update() 377 * Update an active pt entry with Xen 378 * Equivalent to *pte = npte 379 */ 380 381 static __inline void 382 xpmap_update (pt_entry_t *pte, pt_entry_t npte) 383 { 384 int s = splvm(); 385 386 xpq_queue_pte_update(xpmap_ptetomach(pte), npte); 387 xpq_flush_queue(); 388 splx(s); 389 } 390 391 392 /* Xen helpers to change bits of a pte */ 393 #define XPMAP_UPDATE_DIRECT 1 /* Update direct map entry flags too */ 394 395 /* pmap functions with machine addresses */ 396 void pmap_kenter_ma(vaddr_t, paddr_t, vm_prot_t); 397 int pmap_enter_ma(struct pmap *, vaddr_t, paddr_t, paddr_t, 398 vm_prot_t, int, int); 399 bool pmap_extract_ma(pmap_t, vaddr_t, paddr_t *); 400 401 paddr_t vtomach(vaddr_t); 402 #define vtomfn(va) (vtomach(va) >> PAGE_SHIFT) 403 404 #endif /* XEN */ 405 406 /* 407 * Hooks for the pool allocator. 408 */ 409 #define POOL_VTOPHYS(va) vtophys((vaddr_t) (va)) 410 411 /* 412 * TLB shootdown mailbox. 413 */ 414 415 struct pmap_mbox { 416 volatile void *mb_pointer; 417 volatile uintptr_t mb_addr1; 418 volatile uintptr_t mb_addr2; 419 volatile uintptr_t mb_head; 420 volatile uintptr_t mb_tail; 421 volatile uintptr_t mb_global; 422 }; 423 424 #endif /* _KERNEL */ 425 426 #endif /* _X86_PMAP_H_ */ 427