sys/amd64/include/pmap.h

   1 /*-
   2  * Copyright (c) 2003 Peter Wemm.
   3  * Copyright (c) 1991 Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * the Systems Programming Group of the University of Utah Computer
   8  * Science Department and William Jolitz of UUNET Technologies Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * Derived from hp300 version by Mike Hibler, this version by William
  35  * Jolitz uses a recursive map [a pde points to the page directory] to
  36  * map the page tables using the pagetables themselves. This is done to
  37  * reduce the impact on kernel virtual memory for lots of sparse address
  38  * space, and to reduce the cost of memory to each process.
  39  *
  40  *      from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
  41  *      from: @(#)pmap.h        7.4 (Berkeley) 5/12/91
  42  * $FreeBSD$
  43  */
  44
  45 #ifndef _MACHINE_PMAP_H_
  46 #define _MACHINE_PMAP_H_
  47
  48 /*
  49  * Page-directory and page-table entries follow this format, with a few
  50  * of the fields not present here and there, depending on a lot of things.
  51  */
  52                                 /* ---- Intel Nomenclature ---- */
  53 #define PG_V            0x001   /* P    Valid                   */
  54 #define PG_RW           0x002   /* R/W  Read/Write              */
  55 #define PG_U            0x004   /* U/S  User/Supervisor         */
  56 #define PG_NC_PWT       0x008   /* PWT  Write through           */
  57 #define PG_NC_PCD       0x010   /* PCD  Cache disable           */
  58 #define PG_A            0x020   /* A    Accessed                */
  59 #define PG_M            0x040   /* D    Dirty                   */
  60 #define PG_PS           0x080   /* PS   Page size (0=4k,1=2M)   */
  61 #define PG_PTE_PAT      0x080   /* PAT  PAT index               */
  62 #define PG_G            0x100   /* G    Global                  */
  63 #define PG_AVAIL1       0x200   /*    / Available for system    */
  64 #define PG_AVAIL2       0x400   /*   <  programmers use         */
  65 #define PG_AVAIL3       0x800   /*    \                         */
  66 #define PG_PDE_PAT      0x1000  /* PAT  PAT index               */
  67 #define PG_NX           (1ul<<63) /* No-execute */
  68
  69
  70 /* Our various interpretations of the above */
  71 #define PG_W            PG_AVAIL1       /* "Wired" pseudoflag */
  72 #define PG_MANAGED      PG_AVAIL2
  73 #define PG_FRAME        (0x000ffffffffff000ul)
  74 #define PG_PS_FRAME     (0x000fffffffe00000ul)
  75 #define PG_PROT         (PG_RW|PG_U)    /* all protection bits . */
  76 #define PG_N            (PG_NC_PWT|PG_NC_PCD)   /* Non-cacheable */
  77
  78 /* Page level cache control fields used to determine the PAT type */
  79 #define PG_PDE_CACHE    (PG_PDE_PAT | PG_NC_PWT | PG_NC_PCD)
  80 #define PG_PTE_CACHE    (PG_PTE_PAT | PG_NC_PWT | PG_NC_PCD)
  81
  82 /*
  83  * Promotion to a 2MB (PDE) page mapping requires that the corresponding 4KB
  84  * (PTE) page mappings have identical settings for the following fields:
  85  */
  86 #define PG_PTE_PROMOTE  (PG_NX | PG_MANAGED | PG_W | PG_G | PG_PTE_PAT | \
  87             PG_M | PG_A | PG_NC_PCD | PG_NC_PWT | PG_U | PG_RW | PG_V)
  88
  89 /*
  90  * Page Protection Exception bits
  91  */
  92
  93 #define PGEX_P          0x01    /* Protection violation vs. not present */
  94 #define PGEX_W          0x02    /* during a Write cycle */
  95 #define PGEX_U          0x04    /* access from User mode (UPL) */
  96 #define PGEX_RSV        0x08    /* reserved PTE field is non-zero */
  97 #define PGEX_I          0x10    /* during an instruction fetch */
  98
  99 /*
 100  * Pte related macros.  This is complicated by having to deal with
 101  * the sign extension of the 48th bit.
 102  */
 103 #define KVADDR(l4, l3, l2, l1) ( \
 104         ((unsigned long)-1 << 47) | \
 105         ((unsigned long)(l4) << PML4SHIFT) | \
 106         ((unsigned long)(l3) << PDPSHIFT) | \
 107         ((unsigned long)(l2) << PDRSHIFT) | \
 108         ((unsigned long)(l1) << PAGE_SHIFT))
 109
 110 #define UVADDR(l4, l3, l2, l1) ( \
 111         ((unsigned long)(l4) << PML4SHIFT) | \
 112         ((unsigned long)(l3) << PDPSHIFT) | \
 113         ((unsigned long)(l2) << PDRSHIFT) | \
 114         ((unsigned long)(l1) << PAGE_SHIFT))
 115
 116 /* Initial number of kernel page tables. */
 117 #ifndef NKPT
 118 #define NKPT            32
 119 #endif
 120
 121 #define NKPML4E         1               /* number of kernel PML4 slots */
 122 #define NKPDPE          howmany(NKPT, NPDEPG)/* number of kernel PDP slots */
 123
 124 #define NUPML4E         (NPML4EPG/2)    /* number of userland PML4 pages */
 125 #define NUPDPE          (NUPML4E*NPDPEPG)/* number of userland PDP pages */
 126 #define NUPDE           (NUPDPE*NPDEPG) /* number of userland PD entries */
 127
 128 /*
 129  * NDMPML4E is the number of PML4 entries that are used to implement the
 130  * direct map.  It must be a power of two.
 131  */
 132 #define NDMPML4E        2
 133
 134 /*
 135  * The *PDI values control the layout of virtual memory.  The starting address
 136  * of the direct map, which is controlled by DMPML4I, must be a multiple of
 137  * its size.  (See the PHYS_TO_DMAP() and DMAP_TO_PHYS() macros.)
 138  */
 139 #define PML4PML4I       (NPML4EPG/2)    /* Index of recursive pml4 mapping */
 140
 141 #define KPML4I          (NPML4EPG-1)    /* Top 512GB for KVM */
 142 #define DMPML4I         rounddown(KPML4I - NDMPML4E, NDMPML4E) /* Below KVM */
 143
 144 #define KPDPI           (NPDPEPG-2)     /* kernbase at -2GB */
 145
 146 /*
 147  * XXX doesn't really belong here I guess...
 148  */
 149 #define ISA_HOLE_START    0xa0000
 150 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
 151
 152 #ifndef LOCORE
 153
 154 #include <sys/queue.h>
 155 #include <sys/_cpuset.h>
 156 #include <sys/_lock.h>
 157 #include <sys/_mutex.h>
 158
 159 typedef u_int64_t pd_entry_t;
 160 typedef u_int64_t pt_entry_t;
 161 typedef u_int64_t pdp_entry_t;
 162 typedef u_int64_t pml4_entry_t;
 163
 164 #define PML4ESHIFT      (3)
 165 #define PDPESHIFT       (3)
 166 #define PTESHIFT        (3)
 167 #define PDESHIFT        (3)
 168
 169 /*
 170  * Address of current address space page table maps and directories.
 171  */
 172 #ifdef _KERNEL
 173 #define addr_PTmap      (KVADDR(PML4PML4I, 0, 0, 0))
 174 #define addr_PDmap      (KVADDR(PML4PML4I, PML4PML4I, 0, 0))
 175 #define addr_PDPmap     (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, 0))
 176 #define addr_PML4map    (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, PML4PML4I))
 177 #define addr_PML4pml4e  (addr_PML4map + (PML4PML4I * sizeof(pml4_entry_t)))
 178 #define PTmap           ((pt_entry_t *)(addr_PTmap))
 179 #define PDmap           ((pd_entry_t *)(addr_PDmap))
 180 #define PDPmap          ((pd_entry_t *)(addr_PDPmap))
 181 #define PML4map         ((pd_entry_t *)(addr_PML4map))
 182 #define PML4pml4e       ((pd_entry_t *)(addr_PML4pml4e))
 183
 184 extern u_int64_t KPDPphys;      /* physical address of kernel level 3 */
 185 extern u_int64_t KPML4phys;     /* physical address of kernel level 4 */
 186
 187 /*
 188  * virtual address to page table entry and
 189  * to physical address.
 190  * Note: these work recursively, thus vtopte of a pte will give
 191  * the corresponding pde that in turn maps it.
 192  */
 193 pt_entry_t *vtopte(vm_offset_t);
 194 #define vtophys(va)     pmap_kextract(((vm_offset_t) (va)))
 195
 196 #define pte_load_store(ptep, pte)       atomic_swap_long(ptep, pte)
 197 #define pte_load_clear(ptep)            atomic_swap_long(ptep, 0)
 198 #define pte_store(ptep, pte) do { \
 199         *(u_long *)(ptep) = (u_long)(pte); \
 200 } while (0)
 201 #define pte_clear(ptep)                 pte_store(ptep, 0)
 202
 203 #define pde_store(pdep, pde)            pte_store(pdep, pde)
 204
 205 extern pt_entry_t pg_nx;
 206
 207 #endif /* _KERNEL */
 208
 209 /*
 210  * Pmap stuff
 211  */
 212 struct  pv_entry;
 213 struct  pv_chunk;
 214
 215 struct md_page {
 216         TAILQ_HEAD(,pv_entry)   pv_list;
 217         int                     pat_mode;
 218 };
 219
 220 /*
 221  * The kernel virtual address (KVA) of the level 4 page table page is always
 222  * within the direct map (DMAP) region.
 223  */
 224 struct pmap {
 225         struct mtx              pm_mtx;
 226         pml4_entry_t            *pm_pml4;       /* KVA of level 4 page table */
 227         TAILQ_HEAD(,pv_chunk)   pm_pvchunk;     /* list of mappings in pmap */
 228         cpuset_t                pm_active;      /* active on cpus */
 229         /* spare u_int here due to padding */
 230         struct pmap_statistics  pm_stats;       /* pmap statistics */
 231         vm_page_t               pm_root;        /* spare page table pages */
 232 };
 233
 234 typedef struct pmap     *pmap_t;
 235
 236 #ifdef _KERNEL
 237 extern struct pmap      kernel_pmap_store;
 238 #define kernel_pmap     (&kernel_pmap_store)
 239
 240 #define PMAP_LOCK(pmap)         mtx_lock(&(pmap)->pm_mtx)
 241 #define PMAP_LOCK_ASSERT(pmap, type) \
 242                                 mtx_assert(&(pmap)->pm_mtx, (type))
 243 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
 244 #define PMAP_LOCK_INIT(pmap)    mtx_init(&(pmap)->pm_mtx, "pmap", \
 245                                     NULL, MTX_DEF | MTX_DUPOK)
 246 #define PMAP_LOCKED(pmap)       mtx_owned(&(pmap)->pm_mtx)
 247 #define PMAP_MTX(pmap)          (&(pmap)->pm_mtx)
 248 #define PMAP_TRYLOCK(pmap)      mtx_trylock(&(pmap)->pm_mtx)
 249 #define PMAP_UNLOCK(pmap)       mtx_unlock(&(pmap)->pm_mtx)
 250 #endif
 251
 252 /*
 253  * For each vm_page_t, there is a list of all currently valid virtual
 254  * mappings of that page.  An entry is a pv_entry_t, the list is pv_list.
 255  */
 256 typedef struct pv_entry {
 257         vm_offset_t     pv_va;          /* virtual address for mapping */
 258         TAILQ_ENTRY(pv_entry)   pv_list;
 259 } *pv_entry_t;
 260
 261 /*
 262  * pv_entries are allocated in chunks per-process.  This avoids the
 263  * need to track per-pmap assignments.
 264  */
 265 #define _NPCM   3
 266 #define _NPCPV  168
 267 struct pv_chunk {
 268         pmap_t                  pc_pmap;
 269         TAILQ_ENTRY(pv_chunk)   pc_list;
 270         uint64_t                pc_map[_NPCM];  /* bitmap; 1 = free */
 271         TAILQ_ENTRY(pv_chunk)   pc_lru;
 272         struct pv_entry         pc_pventry[_NPCPV];
 273 };
 274
 275 #ifdef  _KERNEL
 276
 277 extern caddr_t  CADDR1;
 278 extern pt_entry_t *CMAP1;
 279 extern vm_paddr_t phys_avail[];
 280 extern vm_paddr_t dump_avail[];
 281 extern vm_offset_t virtual_avail;
 282 extern vm_offset_t virtual_end;
 283 extern vm_paddr_t dmaplimit;
 284
 285 #define pmap_page_get_memattr(m)        ((vm_memattr_t)(m)->md.pat_mode)
 286 #define pmap_page_is_write_mapped(m)    (((m)->aflags & PGA_WRITEABLE) != 0)
 287 #define pmap_unmapbios(va, sz)  pmap_unmapdev((va), (sz))
 288
 289 void    pmap_bootstrap(vm_paddr_t *);
 290 int     pmap_change_attr(vm_offset_t, vm_size_t, int);
 291 void    pmap_demote_DMAP(vm_paddr_t base, vm_size_t len, boolean_t invalidate);
 292 void    pmap_init_pat(void);
 293 void    pmap_kenter(vm_offset_t va, vm_paddr_t pa);
 294 void    *pmap_kenter_temporary(vm_paddr_t pa, int i);
 295 vm_paddr_t pmap_kextract(vm_offset_t);
 296 void    pmap_kremove(vm_offset_t);
 297 void    *pmap_mapbios(vm_paddr_t, vm_size_t);
 298 void    *pmap_mapdev(vm_paddr_t, vm_size_t);
 299 void    *pmap_mapdev_attr(vm_paddr_t, vm_size_t, int);
 300 boolean_t pmap_page_is_mapped(vm_page_t m);
 301 void    pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
 302 void    pmap_unmapdev(vm_offset_t, vm_size_t);
 303 void    pmap_invalidate_page(pmap_t, vm_offset_t);
 304 void    pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
 305 void    pmap_invalidate_all(pmap_t);
 306 void    pmap_invalidate_cache(void);
 307 void    pmap_invalidate_cache_pages(vm_page_t *pages, int count);
 308 void    pmap_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
 309
 310 #endif /* _KERNEL */
 311
 312 #endif /* !LOCORE */
 313
 314 #endif /* !_MACHINE_PMAP_H_ */