sys/arch/x86/include/pmap.h

   1 /*      $NetBSD: pmap.h,v 1.55 2013/10/17 20:59:16 christos Exp $       */
   2
   3 /*
   4  * Copyright (c) 1997 Charles D. Cranor and Washington University.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /*
  29  * Copyright (c) 2001 Wasabi Systems, Inc.
  30  * All rights reserved.
  31  *
  32  * Written by Frank van der Linden for Wasabi Systems, Inc.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed for the NetBSD Project by
  45  *      Wasabi Systems, Inc.
  46  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
  47  *    or promote products derived from this software without specific prior
  48  *    written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  52  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  53  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  54  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  55  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  56  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  57  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  58  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  59  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  60  * POSSIBILITY OF SUCH DAMAGE.
  61  */
  62
  63 /*
  64  * pmap.h: see pmap.c for the history of this pmap module.
  65  */
  66
  67 #ifndef _X86_PMAP_H_
  68 #define _X86_PMAP_H_
  69
  70 /*
  71  * pl*_pi: index in the ptp page for a pde mapping a VA.
  72  * (pl*_i below is the index in the virtual array of all pdes per level)
  73  */
  74 #define pl1_pi(VA)      (((VA_SIGN_POS(VA)) & L1_MASK) >> L1_SHIFT)
  75 #define pl2_pi(VA)      (((VA_SIGN_POS(VA)) & L2_MASK) >> L2_SHIFT)
  76 #define pl3_pi(VA)      (((VA_SIGN_POS(VA)) & L3_MASK) >> L3_SHIFT)
  77 #define pl4_pi(VA)      (((VA_SIGN_POS(VA)) & L4_MASK) >> L4_SHIFT)
  78
  79 /*
  80  * pl*_i: generate index into pde/pte arrays in virtual space
  81  *
  82  * pl_i(va, X) == plX_i(va) <= pl_i_roundup(va, X)
  83  */
  84 #define pl1_i(VA)       (((VA_SIGN_POS(VA)) & L1_FRAME) >> L1_SHIFT)
  85 #define pl2_i(VA)       (((VA_SIGN_POS(VA)) & L2_FRAME) >> L2_SHIFT)
  86 #define pl3_i(VA)       (((VA_SIGN_POS(VA)) & L3_FRAME) >> L3_SHIFT)
  87 #define pl4_i(VA)       (((VA_SIGN_POS(VA)) & L4_FRAME) >> L4_SHIFT)
  88 #define pl_i(va, lvl) \
  89         (((VA_SIGN_POS(va)) & ptp_masks[(lvl)-1]) >> ptp_shifts[(lvl)-1])
  90
  91 #define pl_i_roundup(va, lvl)   pl_i((va)+ ~ptp_masks[(lvl)-1], (lvl))
  92
  93 /*
  94  * PTP macros:
  95  *   a PTP's index is the PD index of the PDE that points to it
  96  *   a PTP's offset is the byte-offset in the PTE space that this PTP is at
  97  *   a PTP's VA is the first VA mapped by that PTP
  98  */
  99
 100 #define ptp_va2o(va, lvl)       (pl_i(va, (lvl)+1) * PAGE_SIZE)
 101
 102 /* size of a PDP: usually one page, except for PAE */
 103 #ifdef PAE
 104 #define PDP_SIZE 4
 105 #else
 106 #define PDP_SIZE 1
 107 #endif
 108
 109
 110 #if defined(_KERNEL)
 111 #include <sys/kcpuset.h>
 112
 113 /*
 114  * pmap data structures: see pmap.c for details of locking.
 115  */
 116
 117 /*
 118  * we maintain a list of all non-kernel pmaps
 119  */
 120
 121 LIST_HEAD(pmap_head, pmap); /* struct pmap_head: head of a pmap list */
 122
 123 /*
 124  * linked list of all non-kernel pmaps
 125  */
 126 extern struct pmap_head pmaps;
 127 extern kmutex_t pmaps_lock;    /* protects pmaps */
 128
 129 /*
 130  * pool_cache(9) that PDPs are allocated from
 131  */
 132 extern struct pool_cache pmap_pdp_cache;
 133
 134 /*
 135  * the pmap structure
 136  *
 137  * note that the pm_obj contains the lock pointer, the reference count,
 138  * page list, and number of PTPs within the pmap.
 139  *
 140  * pm_lock is the same as the lock for vm object 0.  Changes to
 141  * the other objects may only be made if that lock has been taken
 142  * (the other object locks are only used when uvm_pagealloc is called)
 143  */
 144
 145 struct pmap {
 146         struct uvm_object pm_obj[PTP_LEVELS-1]; /* objects for lvl >= 1) */
 147 #define pm_lock pm_obj[0].vmobjlock
 148         kmutex_t pm_obj_lock[PTP_LEVELS-1];     /* locks for pm_objs */
 149         LIST_ENTRY(pmap) pm_list;       /* list (lck by pm_list lock) */
 150         pd_entry_t *pm_pdir;            /* VA of PD (lck by object lock) */
 151         paddr_t pm_pdirpa[PDP_SIZE];    /* PA of PDs (read-only after create) */
 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         size_t pm_ldt_len;              /* size of LDT in bytes */
 163         int pm_ldt_sel;                 /* LDT selector */
 164         kcpuset_t *pm_cpus;             /* mask of CPUs using pmap */
 165         kcpuset_t *pm_kernel_cpus;      /* mask of CPUs using kernel part
 166                                          of pmap */
 167         kcpuset_t *pm_xen_ptp_cpus;     /* mask of CPUs which have this pmap's
 168                                          ptp mapped */
 169         uint64_t pm_ncsw;               /* for assertions */
 170         struct vm_page *pm_gc_ptp;      /* pages from pmap g/c */
 171 };
 172
 173 /* macro to access pm_pdirpa slots */
 174 #ifdef PAE
 175 #define pmap_pdirpa(pmap, index) \
 176         ((pmap)->pm_pdirpa[l2tol3(index)] + l2tol2(index) * sizeof(pd_entry_t))
 177 #else
 178 #define pmap_pdirpa(pmap, index) \
 179         ((pmap)->pm_pdirpa[0] + (index) * sizeof(pd_entry_t))
 180 #endif
 181
 182 /*
 183  * flag to be used for kernel mappings: PG_u on Xen/amd64,
 184  * 0 otherwise.
 185  */
 186 #if defined(XEN) && defined(__x86_64__)
 187 #define PG_k PG_u
 188 #else
 189 #define PG_k 0
 190 #endif
 191
 192 /*
 193  * MD flags that we use for pmap_enter and pmap_kenter_pa:
 194  */
 195
 196 /*
 197  * global kernel variables
 198  */
 199
 200 /*
 201  * PDPpaddr is the physical address of the kernel's PDP.
 202  * - i386 non-PAE and amd64: PDPpaddr corresponds directly to the %cr3
 203  * value associated to the kernel process, proc0.
 204  * - i386 PAE: it still represents the PA of the kernel's PDP (L2). Due to
 205  * the L3 PD, it cannot be considered as the equivalent of a %cr3 any more.
 206  * - Xen: it corresponds to the PFN of the kernel's PDP.
 207  */
 208 extern u_long PDPpaddr;
 209
 210 extern int pmap_pg_g;                   /* do we support PG_G? */
 211 extern long nkptp[PTP_LEVELS];
 212
 213 /*
 214  * macros
 215  */
 216
 217 #define pmap_resident_count(pmap)       ((pmap)->pm_stats.resident_count)
 218 #define pmap_wired_count(pmap)          ((pmap)->pm_stats.wired_count)
 219
 220 #define pmap_clear_modify(pg)           pmap_clear_attrs(pg, PG_M)
 221 #define pmap_clear_reference(pg)        pmap_clear_attrs(pg, PG_U)
 222 #define pmap_copy(DP,SP,D,L,S)          __USE(L)
 223 #define pmap_is_modified(pg)            pmap_test_attrs(pg, PG_M)
 224 #define pmap_is_referenced(pg)          pmap_test_attrs(pg, PG_U)
 225 #define pmap_move(DP,SP,D,L,S)
 226 #define pmap_phys_address(ppn)          (x86_ptob(ppn) & ~X86_MMAP_FLAG_MASK)
 227 #define pmap_mmap_flags(ppn)            x86_mmap_flags(ppn)
 228 #define pmap_valid_entry(E)             ((E) & PG_V) /* is PDE or PTE valid? */
 229
 230 #if defined(__x86_64__) || defined(PAE)
 231 #define X86_MMAP_FLAG_SHIFT     (64 - PGSHIFT)
 232 #else
 233 #define X86_MMAP_FLAG_SHIFT     (32 - PGSHIFT)
 234 #endif
 235
 236 #define X86_MMAP_FLAG_MASK      0xf
 237 #define X86_MMAP_FLAG_PREFETCH  0x1
 238
 239 /*
 240  * prototypes
 241  */
 242
 243 void            pmap_activate(struct lwp *);
 244 void            pmap_bootstrap(vaddr_t);
 245 bool            pmap_clear_attrs(struct vm_page *, unsigned);
 246 void            pmap_deactivate(struct lwp *);
 247 void            pmap_page_remove (struct vm_page *);
 248 void            pmap_remove(struct pmap *, vaddr_t, vaddr_t);
 249 bool            pmap_test_attrs(struct vm_page *, unsigned);
 250 void            pmap_write_protect(struct pmap *, vaddr_t, vaddr_t, vm_prot_t);
 251 void            pmap_load(void);
 252 paddr_t         pmap_init_tmp_pgtbl(paddr_t);
 253 void            pmap_remove_all(struct pmap *);
 254 void            pmap_ldt_sync(struct pmap *);
 255 void            pmap_kremove_local(vaddr_t, vsize_t);
 256
 257 void            pmap_emap_enter(vaddr_t, paddr_t, vm_prot_t);
 258 void            pmap_emap_remove(vaddr_t, vsize_t);
 259 void            pmap_emap_sync(bool);
 260
 261 void            pmap_map_ptes(struct pmap *, struct pmap **, pd_entry_t **,
 262                     pd_entry_t * const **);
 263 void            pmap_unmap_ptes(struct pmap *, struct pmap *);
 264
 265 int             pmap_pdes_invalid(vaddr_t, pd_entry_t * const *, pd_entry_t *);
 266
 267 u_int           x86_mmap_flags(paddr_t);
 268
 269 bool            pmap_is_curpmap(struct pmap *);
 270
 271 vaddr_t reserve_dumppages(vaddr_t); /* XXX: not a pmap fn */
 272
 273 typedef enum tlbwhy {
 274         TLBSHOOT_APTE,
 275         TLBSHOOT_KENTER,
 276         TLBSHOOT_KREMOVE,
 277         TLBSHOOT_FREE_PTP1,
 278         TLBSHOOT_FREE_PTP2,
 279         TLBSHOOT_REMOVE_PTE,
 280         TLBSHOOT_REMOVE_PTES,
 281         TLBSHOOT_SYNC_PV1,
 282         TLBSHOOT_SYNC_PV2,
 283         TLBSHOOT_WRITE_PROTECT,
 284         TLBSHOOT_ENTER,
 285         TLBSHOOT_UPDATE,
 286         TLBSHOOT_BUS_DMA,
 287         TLBSHOOT_BUS_SPACE,
 288         TLBSHOOT__MAX,
 289 } tlbwhy_t;
 290
 291 void            pmap_tlb_init(void);
 292 void            pmap_tlb_cpu_init(struct cpu_info *);
 293 void            pmap_tlb_shootdown(pmap_t, vaddr_t, pt_entry_t, tlbwhy_t);
 294 void            pmap_tlb_shootnow(void);
 295 void            pmap_tlb_intr(void);
 296
 297 #define __HAVE_PMAP_EMAP
 298
 299 #define PMAP_GROWKERNEL         /* turn on pmap_growkernel interface */
 300 #define PMAP_FORK               /* turn on pmap_fork interface */
 301
 302 /*
 303  * Do idle page zero'ing uncached to avoid polluting the cache.
 304  */
 305 bool    pmap_pageidlezero(paddr_t);
 306 #define PMAP_PAGEIDLEZERO(pa)   pmap_pageidlezero((pa))
 307
 308 /*
 309  * inline functions
 310  */
 311
 312 __inline static bool __unused
 313 pmap_pdes_valid(vaddr_t va, pd_entry_t * const *pdes, pd_entry_t *lastpde)
 314 {
 315         return pmap_pdes_invalid(va, pdes, lastpde) == 0;
 316 }
 317
 318 /*
 319  * pmap_update_pg: flush one page from the TLB (or flush the whole thing
 320  *      if hardware doesn't support one-page flushing)
 321  */
 322
 323 __inline static void __unused
 324 pmap_update_pg(vaddr_t va)
 325 {
 326         invlpg(va);
 327 }
 328
 329 /*
 330  * pmap_update_2pg: flush two pages from the TLB
 331  */
 332
 333 __inline static void __unused
 334 pmap_update_2pg(vaddr_t va, vaddr_t vb)
 335 {
 336         invlpg(va);
 337         invlpg(vb);
 338 }
 339
 340 /*
 341  * pmap_page_protect: change the protection of all recorded mappings
 342  *      of a managed page
 343  *
 344  * => this function is a frontend for pmap_page_remove/pmap_clear_attrs
 345  * => we only have to worry about making the page more protected.
 346  *      unprotecting a page is done on-demand at fault time.
 347  */
 348
 349 __inline static void __unused
 350 pmap_page_protect(struct vm_page *pg, vm_prot_t prot)
 351 {
 352         if ((prot & VM_PROT_WRITE) == 0) {
 353                 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) {
 354                         (void) pmap_clear_attrs(pg, PG_RW);
 355                 } else {
 356                         pmap_page_remove(pg);
 357                 }
 358         }
 359 }
 360
 361 /*
 362  * pmap_protect: change the protection of pages in a pmap
 363  *
 364  * => this function is a frontend for pmap_remove/pmap_write_protect
 365  * => we only have to worry about making the page more protected.
 366  *      unprotecting a page is done on-demand at fault time.
 367  */
 368
 369 __inline static void __unused
 370 pmap_protect(struct pmap *pmap, vaddr_t sva, vaddr_t eva, vm_prot_t prot)
 371 {
 372         if ((prot & VM_PROT_WRITE) == 0) {
 373                 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) {
 374                         pmap_write_protect(pmap, sva, eva, prot);
 375                 } else {
 376                         pmap_remove(pmap, sva, eva);
 377                 }
 378         }
 379 }
 380
 381 /*
 382  * various address inlines
 383  *
 384  *  vtopte: return a pointer to the PTE mapping a VA, works only for
 385  *  user and PT addresses
 386  *
 387  *  kvtopte: return a pointer to the PTE mapping a kernel VA
 388  */
 389
 390 #include <lib/libkern/libkern.h>
 391
 392 static __inline pt_entry_t * __unused
 393 vtopte(vaddr_t va)
 394 {
 395
 396         KASSERT(va < VM_MIN_KERNEL_ADDRESS);
 397
 398         return (PTE_BASE + pl1_i(va));
 399 }
 400
 401 static __inline pt_entry_t * __unused
 402 kvtopte(vaddr_t va)
 403 {
 404         pd_entry_t *pde;
 405
 406         KASSERT(va >= VM_MIN_KERNEL_ADDRESS);
 407
 408         pde = L2_BASE + pl2_i(va);
 409         if (*pde & PG_PS)
 410                 return ((pt_entry_t *)pde);
 411
 412         return (PTE_BASE + pl1_i(va));
 413 }
 414
 415 paddr_t vtophys(vaddr_t);
 416 vaddr_t pmap_map(vaddr_t, paddr_t, paddr_t, vm_prot_t);
 417 void    pmap_cpu_init_late(struct cpu_info *);
 418 bool    sse2_idlezero_page(void *);
 419
 420 #ifdef XEN
 421 #include <sys/bitops.h>
 422
 423 #define XPTE_MASK       L1_FRAME
 424 /* Selects the index of a PTE in (A)PTE_BASE */
 425 #define XPTE_SHIFT      (L1_SHIFT - ilog2(sizeof(pt_entry_t)))
 426
 427 /* PTE access inline fuctions */
 428
 429 /*
 430  * Get the machine address of the pointed pte
 431  * We use hardware MMU to get value so works only for levels 1-3
 432  */
 433
 434 static __inline paddr_t
 435 xpmap_ptetomach(pt_entry_t *pte)
 436 {
 437         pt_entry_t *up_pte;
 438         vaddr_t va = (vaddr_t) pte;
 439
 440         va = ((va & XPTE_MASK) >> XPTE_SHIFT) | (vaddr_t) PTE_BASE;
 441         up_pte = (pt_entry_t *) va;
 442
 443         return (paddr_t) (((*up_pte) & PG_FRAME) + (((vaddr_t) pte) & (~PG_FRAME & ~VA_SIGN_MASK)));
 444 }
 445
 446 /* Xen helpers to change bits of a pte */
 447 #define XPMAP_UPDATE_DIRECT     1       /* Update direct map entry flags too */
 448
 449 paddr_t vtomach(vaddr_t);
 450 #define vtomfn(va) (vtomach(va) >> PAGE_SHIFT)
 451 #endif  /* XEN */
 452
 453 /* pmap functions with machine addresses */
 454 void    pmap_kenter_ma(vaddr_t, paddr_t, vm_prot_t, u_int);
 455 int     pmap_enter_ma(struct pmap *, vaddr_t, paddr_t, paddr_t,
 456             vm_prot_t, u_int, int);
 457 bool    pmap_extract_ma(pmap_t, vaddr_t, paddr_t *);
 458
 459 /*
 460  * Hooks for the pool allocator.
 461  */
 462 #define POOL_VTOPHYS(va)        vtophys((vaddr_t) (va))
 463
 464 #ifdef __HAVE_DIRECT_MAP
 465
 466 #define L4_SLOT_DIRECT          509
 467 #define PDIR_SLOT_DIRECT        L4_SLOT_DIRECT
 468
 469 #define PMAP_DIRECT_BASE        (VA_SIGN_NEG((L4_SLOT_DIRECT * NBPD_L4)))
 470 #define PMAP_DIRECT_END         (VA_SIGN_NEG(((L4_SLOT_DIRECT + 1) * NBPD_L4)))
 471
 472 #define PMAP_DIRECT_MAP(pa)     ((vaddr_t)PMAP_DIRECT_BASE + (pa))
 473 #define PMAP_DIRECT_UNMAP(va)   ((paddr_t)(va) - PMAP_DIRECT_BASE)
 474
 475 /*
 476  * Alternate mapping hooks for pool pages.
 477  */
 478 #define PMAP_MAP_POOLPAGE(pa)   PMAP_DIRECT_MAP((pa))
 479 #define PMAP_UNMAP_POOLPAGE(va) PMAP_DIRECT_UNMAP((va))
 480
 481 void    pagezero(vaddr_t);
 482
 483 #endif /* __HAVE_DIRECT_MAP */
 484
 485 #endif /* _KERNEL */
 486
 487 #endif /* _X86_PMAP_H_ */