sys/i386/include/pmap.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1991 Regents of the University of California.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * the Systems Programming Group of the University of Utah Computer
   9  * Science Department and William Jolitz of UUNET Technologies Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * Derived from hp300 version by Mike Hibler, this version by William
  36  * Jolitz uses a recursive map [a pde points to the page directory] to
  37  * map the page tables using the pagetables themselves. This is done to
  38  * reduce the impact on kernel virtual memory for lots of sparse address
  39  * space, and to reduce the cost of memory to each process.
  40  *
  41  *      from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
  42  *      from: @(#)pmap.h        7.4 (Berkeley) 5/12/91
  43  * $FreeBSD$
  44  */
  45
  46 #ifndef _MACHINE_PMAP_H_
  47 #define _MACHINE_PMAP_H_
  48
  49 /*
  50  * Page-directory and page-table entries follow this format, with a few
  51  * of the fields not present here and there, depending on a lot of things.
  52  */
  53                                 /* ---- Intel Nomenclature ---- */
  54 #define PG_V            0x001   /* P    Valid                   */
  55 #define PG_RW           0x002   /* R/W  Read/Write              */
  56 #define PG_U            0x004   /* U/S  User/Supervisor         */
  57 #define PG_NC_PWT       0x008   /* PWT  Write through           */
  58 #define PG_NC_PCD       0x010   /* PCD  Cache disable           */
  59 #define PG_A            0x020   /* A    Accessed                */
  60 #define PG_M            0x040   /* D    Dirty                   */
  61 #define PG_PS           0x080   /* PS   Page size (0=4k,1=4M)   */
  62 #define PG_PTE_PAT      0x080   /* PAT  PAT index               */
  63 #define PG_G            0x100   /* G    Global                  */
  64 #define PG_AVAIL1       0x200   /*    / Available for system    */
  65 #define PG_AVAIL2       0x400   /*   <  programmers use         */
  66 #define PG_AVAIL3       0x800   /*    \                         */
  67 #define PG_PDE_PAT      0x1000  /* PAT  PAT index               */
  68 #define PG_NX           (1ull<<63) /* No-execute */
  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_PROMOTED     PG_AVAIL3       /* PDE only */
  74
  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 2 or 4MB (PDE) page mapping requires that the corresponding
  84  * 4KB (PTE) page mappings have identical settings for the following fields:
  85  */
  86 #define PG_PTE_PROMOTE  (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
 101  */
 102 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
 103
 104 #ifndef NKPDE
 105 #define NKPDE   (KVA_PAGES)     /* number of page tables/pde's */
 106 #endif
 107
 108 #define PDRSHIFT_PAE            21              /* LOG2(NBPDR) */
 109 #define PG_FRAME_PAE            (0x000ffffffffff000ull)
 110 #define PG_PS_FRAME_PAE         (0x000fffffffe00000ull)
 111
 112 #define PDRSHIFT_NOPAE          22
 113 #define PG_FRAME_NOPAE          (~PAGE_MASK)
 114 #define PG_PS_FRAME_NOPAE       (0xffc00000)
 115
 116 /*
 117  * The *PTDI values control the layout of virtual memory
 118  */
 119 #define KPTDI           0               /* start of kernel virtual pde's */
 120 /* ptd entry that points to ptd */
 121 #define PTDPTDI         (NPDEPTD - NTRPPTD - NPGPTD)
 122 #define TRPTDI          (NPDEPTD - NTRPPTD)     /* u/k trampoline ptd */
 123
 124 /*
 125  * XXX doesn't really belong here I guess...
 126  */
 127 #define ISA_HOLE_START    0xa0000
 128 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
 129
 130 #ifndef LOCORE
 131
 132 #include <sys/queue.h>
 133 #include <sys/_cpuset.h>
 134 #include <sys/_lock.h>
 135 #include <sys/_mutex.h>
 136 #include <sys/_pv_entry.h>
 137
 138 #include <vm/_vm_radix.h>
 139
 140 /*
 141  * Address of current address space page table maps and directories.
 142  */
 143 #ifdef _KERNEL
 144
 145 /*
 146  * Translate a virtual address to its physical address.
 147  *
 148  * This macro may be used before pmap_bootstrap() is called.
 149  */
 150 #define vtophys(va)     pmap_kextract((vm_offset_t)(va))
 151
 152 #define pte_clear(ptep)                 pte_store(ptep, 0)
 153
 154 #define pde_store(pdep, pde)            pte_store(pdep, pde)
 155
 156 #endif /* _KERNEL */
 157
 158 /*
 159  * Pmap stuff
 160  */
 161 struct md_page {
 162         TAILQ_HEAD(,pv_entry)   pv_list;
 163         int                     pat_mode;
 164 };
 165
 166 struct pmap {
 167         cpuset_t                pm_active;      /* active on cpus */
 168         struct mtx              pm_mtx;
 169         struct pmap_statistics  pm_stats;       /* pmap statistics */
 170         uint32_t                *pm_pdir_nopae; /* KVA of page directory */
 171         uint64_t                *pm_pdir_pae;
 172         TAILQ_HEAD(,pv_chunk)   pm_pvchunk;     /* list of mappings in pmap */
 173         LIST_ENTRY(pmap)        pm_list;        /* List of all pmaps */
 174         uint64_t                *pm_pdpt_pae;
 175         struct vm_radix         pm_root;        /* spare page table pages */
 176         vm_page_t               pm_ptdpg[4];    /* PAE NPGPTD */
 177 };
 178
 179 typedef struct pmap     *pmap_t;
 180
 181 #ifdef _KERNEL
 182 extern struct pmap      kernel_pmap_store;
 183 #define kernel_pmap     (&kernel_pmap_store)
 184
 185 #define PMAP_LOCK(pmap)         mtx_lock(&(pmap)->pm_mtx)
 186 #define PMAP_LOCK_ASSERT(pmap, type) \
 187                                 mtx_assert(&(pmap)->pm_mtx, (type))
 188 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
 189 #define PMAP_LOCK_INIT(pmap)    mtx_init(&(pmap)->pm_mtx, "pmap", \
 190                                     NULL, MTX_DEF | MTX_DUPOK)
 191 #define PMAP_LOCKED(pmap)       mtx_owned(&(pmap)->pm_mtx)
 192 #define PMAP_MTX(pmap)          (&(pmap)->pm_mtx)
 193 #define PMAP_TRYLOCK(pmap)      mtx_trylock(&(pmap)->pm_mtx)
 194 #define PMAP_UNLOCK(pmap)       mtx_unlock(&(pmap)->pm_mtx)
 195
 196 extern char *ptvmmap;           /* poor name! */
 197 extern vm_offset_t virtual_avail;
 198 extern vm_offset_t virtual_end;
 199
 200 #define pmap_page_get_memattr(m)        ((vm_memattr_t)(m)->md.pat_mode)
 201 #define pmap_page_is_write_mapped(m)    (((m)->a.flags & PGA_WRITEABLE) != 0)
 202 #define pmap_unmapbios(va, sz)  pmap_unmapdev((va), (sz))
 203
 204 static inline int
 205 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
 206 {
 207
 208         return (0);
 209 }
 210
 211 struct sf_buf;
 212
 213 #define pmap_vm_page_alloc_check(m)
 214
 215 /*
 216  * Only the following functions or macros may be used before pmap_bootstrap()
 217  * is called: pmap_kenter(), pmap_kextract(), pmap_kremove(), vtophys(), and
 218  * vtopte().
 219  */
 220 void    pmap_activate_boot(pmap_t pmap);
 221 void    pmap_basemem_setup(u_int basemem);
 222 void    *pmap_bios16_enter(void);
 223 void    pmap_bios16_leave(void *handle);
 224 void    pmap_bootstrap(vm_paddr_t);
 225 int     pmap_cache_bits(pmap_t, int mode, boolean_t is_pde);
 226 int     pmap_change_attr(vm_offset_t, vm_size_t, int);
 227 caddr_t pmap_cmap3(vm_paddr_t pa, u_int pte_bits);
 228 void    pmap_cp_slow0_map(vm_offset_t kaddr, int plen, vm_page_t *ma);
 229 void    pmap_flush_page(vm_page_t m);
 230 u_int   pmap_get_kcr3(void);
 231 u_int   pmap_get_cr3(pmap_t);
 232 vm_offset_t pmap_get_map_low(void);
 233 vm_offset_t pmap_get_vm_maxuser_address(void);
 234 void    pmap_init_pat(void);
 235 void    pmap_kenter(vm_offset_t va, vm_paddr_t pa);
 236 void    *pmap_kenter_temporary(vm_paddr_t pa, int i);
 237 vm_paddr_t pmap_kextract(vm_offset_t va);
 238 void    pmap_kremove(vm_offset_t);
 239 void    pmap_ksetrw(vm_offset_t va);
 240 void    *pmap_mapbios(vm_paddr_t, vm_size_t);
 241 void    *pmap_mapdev(vm_paddr_t, vm_size_t);
 242 void    *pmap_mapdev_attr(vm_paddr_t, vm_size_t, int);
 243 boolean_t pmap_page_is_mapped(vm_page_t m);
 244 void    pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
 245 vm_paddr_t pmap_pg_frame(vm_paddr_t pa);
 246 bool    pmap_ps_enabled(pmap_t pmap);
 247 void    pmap_remap_lower(bool);
 248 void    pmap_remap_lowptdi(bool);
 249 void    pmap_set_nx(void);
 250 void    pmap_sf_buf_map(struct sf_buf *sf);
 251 void    pmap_unmapdev(void *, vm_size_t);
 252 void    pmap_invalidate_page(pmap_t, vm_offset_t);
 253 void    pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
 254 void    pmap_invalidate_all(pmap_t);
 255 void    pmap_invalidate_cache(void);
 256 void    pmap_invalidate_cache_pages(vm_page_t *pages, int count);
 257 void    pmap_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
 258 void    pmap_force_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
 259 void    *pmap_trm_alloc(size_t size, int flags);
 260 void    pmap_trm_free(void *addr, size_t size);
 261
 262 void    invltlb_glob(void);
 263
 264 struct thread;
 265
 266 extern int pae_mode;
 267 extern int i386_pmap_VM_NFREEORDER;
 268 extern int i386_pmap_VM_LEVEL_0_ORDER;
 269 extern int i386_pmap_PDRSHIFT;
 270
 271 #endif /* _KERNEL */
 272
 273 #endif /* !LOCORE */
 274
 275 #endif /* !_MACHINE_PMAP_H_ */