sys/platform/pc64/include/pmap.h

   1 /*
   2  * Copyright (c) 1991 Regents of the University of California.
   3  * Copyright (c) 2003 Peter Wemm.
   4  * Copyright (c) 2008 The DragonFly Project.
   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. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  * Derived from hp300 version by Mike Hibler, this version by William
  40  * Jolitz uses a recursive map [a pde points to the page directory] to
  41  * map the page tables using the pagetables themselves. This is done to
  42  * reduce the impact on kernel virtual memory for lots of sparse address
  43  * space, and to reduce the cost of memory to each process.
  44  *
  45  * from: hp300: @(#)pmap.h      7.2 (Berkeley) 12/16/90
  46  * from: @(#)pmap.h     7.4 (Berkeley) 5/12/91
  47  * $FreeBSD: src/sys/i386/include/pmap.h,v 1.65.2.3 2001/10/03 07:15:37 peter Exp $
  48  * $DragonFly: src/sys/platform/pc64/include/pmap.h,v 1.1 2008/08/29 17:07:17 dillon Exp $
  49  */
  50
  51 #ifndef _MACHINE_PMAP_H_
  52 #define _MACHINE_PMAP_H_
  53
  54 #include <cpu/pmap.h>
  55
  56 /*
  57  * Size of Kernel address space.  This is the number of page table pages
  58  * (2GB each) to use for the kernel.  256 pages == 512 Gigabytes.
  59  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
  60  */
  61 #ifndef KVA_PAGES
  62 #define KVA_PAGES       256
  63 #endif
  64
  65 /*
  66  * Pte related macros.  This is complicated by having to deal with
  67  * the sign extension of the 48th bit.
  68  */
  69 #define KVADDR(l4, l3, l2, l1) ( \
  70         ((unsigned long)-1 << 47) | \
  71         ((unsigned long)(l4) << PML4SHIFT) | \
  72         ((unsigned long)(l3) << PDPSHIFT) | \
  73         ((unsigned long)(l2) << PDRSHIFT) | \
  74         ((unsigned long)(l1) << PAGE_SHIFT))
  75
  76 #define UVADDR(l4, l3, l2, l1) ( \
  77         ((unsigned long)(l4) << PML4SHIFT) | \
  78         ((unsigned long)(l3) << PDPSHIFT) | \
  79         ((unsigned long)(l2) << PDRSHIFT) | \
  80         ((unsigned long)(l1) << PAGE_SHIFT))
  81
  82 /*
  83  * NOTE: We no longer hardwire NKPT, it is calculated in create_pagetables()
  84  */
  85 #define NKPML4E         1               /* number of kernel PML4 slots */
  86 /* NKPDPE defined in vmparam.h */
  87
  88 /*
  89  * NUPDPs       512 (256 user)          number of PDPs in user page table
  90  * NUPDs        512 * 512               number of PDs in user page table
  91  * NUPTs        512 * 512 * 512         number of PTs in user page table
  92  * NUPTEs       512 * 512 * 512 * 512   number of PTEs in user page table
  93  *
  94  * NUPDP_USER   number of PDPs reserved for userland
  95  * NUPTE_USER   number of PTEs reserved for userland (big number)
  96  */
  97 #define NUPDP_USER      (NPML4EPG/2)
  98 #define NUPDP_TOTAL     (NPML4EPG)
  99 #define NUPD_TOTAL      (NPDPEPG * NUPDP_TOTAL)
 100 #define NUPT_TOTAL      (NPDEPG * NUPD_TOTAL)
 101 #define NUPTE_TOTAL     ((vm_pindex_t)NPTEPG * NUPT_TOTAL)
 102 #define NUPTE_USER      ((vm_pindex_t)NPTEPG * NPDEPG * NPDPEPG * NUPDP_USER)
 103
 104 /*
 105  * Number of 512G dmap PML4 slots (max ~254 or so but don't go over 64,
 106  * which gives us 32TB of ram).  Because we cache free, empty pmaps the
 107  * initialization overhead is minimal.
 108  *
 109  * It should be possible to bump this up to 255 (but not 256), which would
 110  * be able to address a maximum of ~127TB of physical ram.
 111  */
 112 #define NDMPML4E        64
 113
 114 /*
 115  * The *PML4I values control the layout of virtual memory.  Each PML4
 116  * entry represents 512G.
 117  */
 118 #define PML4PML4I       (NPML4EPG/2)    /* Index of recursive pml4 mapping */
 119
 120 #define KPML4I          (NPML4EPG-1)    /* Top 512GB for KVM */
 121 #define DMPML4I         (KPML4I-NDMPML4E) /* Next 512GBxN down for dmap */
 122
 123 /*
 124  * The location of KERNBASE in the last PD of the kernel's KVM (KPML4I)
 125  * space.  Each PD represents 1GB.  The kernel must be placed here
 126  * for the compile/link options to work properly so absolute 32-bit
 127  * addressing can be used to access stuff.
 128  */
 129 #define KPDPI           (NPDPEPG-2)     /* kernbase at -2GB */
 130
 131 /*
 132  * per-CPU data assume ~64K x SMP_MAXCPU, say up to 256 cpus
 133  * in the future or 16MB of space.  Each PD represents 2MB so
 134  * use NPDEPG-8 to place the per-CPU data.
 135  */
 136 #define MPPML4I         KPML4I
 137 #define MPPDPI          KPDPI
 138 #define MPPTDI          (NPDEPG-8)
 139
 140 /*
 141  * XXX doesn't really belong here I guess...
 142  */
 143 #define ISA_HOLE_START    0xa0000
 144 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
 145
 146 #ifndef LOCORE
 147
 148 #ifndef _SYS_TYPES_H_
 149 #include <sys/types.h>
 150 #endif
 151 #ifndef _SYS_QUEUE_H_
 152 #include <sys/queue.h>
 153 #endif
 154 #ifndef _SYS_TREE_H_
 155 #include <sys/tree.h>
 156 #endif
 157 #ifndef _SYS_SPINLOCK_H_
 158 #include <sys/spinlock.h>
 159 #endif
 160 #ifndef _SYS_THREAD_H_
 161 #include <sys/thread.h>
 162 #endif
 163 #ifndef _MACHINE_TYPES_H_
 164 #include <machine/types.h>
 165 #endif
 166 #ifndef _MACHINE_PARAM_H_
 167 #include <machine/param.h>
 168 #endif
 169
 170 /*
 171  * Address of current and alternate address space page table maps
 172  * and directories.
 173  */
 174 #ifdef _KERNEL
 175 #define addr_PTmap      (KVADDR(PML4PML4I, 0, 0, 0))
 176 #define addr_PDmap      (KVADDR(PML4PML4I, PML4PML4I, 0, 0))
 177 #define addr_PDPmap     (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, 0))
 178 #define addr_PML4map    (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, PML4PML4I))
 179 #define addr_PML4pml4e  (addr_PML4map + (PML4PML4I * sizeof(pml4_entry_t)))
 180 #define PTmap           ((pt_entry_t *)(addr_PTmap))
 181 #define PDmap           ((pd_entry_t *)(addr_PDmap))
 182 #define PDPmap          ((pd_entry_t *)(addr_PDPmap))
 183 #define PML4map         ((pd_entry_t *)(addr_PML4map))
 184 #define PML4pml4e       ((pd_entry_t *)(addr_PML4pml4e))
 185
 186 extern u_int64_t KPML4phys;     /* physical address of kernel level 4 */
 187 #endif
 188
 189 #ifdef _KERNEL
 190
 191 /*
 192  * XXX
 193  */
 194 #define vtophys(va)     pmap_kextract(((vm_offset_t)(va)))
 195 #define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
 196
 197 #endif
 198
 199 #define pte_load_clear(pte)     atomic_readandclear_long(pte)
 200
 201 static __inline void
 202 pte_store(pt_entry_t *ptep, pt_entry_t pte)
 203 {
 204         *ptep = pte;
 205 }
 206
 207 #define pde_store(pdep, pde)    pte_store((pdep), (pde))
 208
 209 /*
 210  * Pmap stuff
 211  */
 212 struct pmap;
 213 struct pv_entry;
 214 struct vm_page;
 215 struct vm_object;
 216 struct vmspace;
 217
 218 /*
 219  * vm_page structures embed a list of related pv_entry's
 220  */
 221 struct md_page {
 222         TAILQ_HEAD(,pv_entry)   pv_list;
 223 };
 224
 225 /*
 226  * vm_object's representing large mappings can contain embedded pmaps
 227  * to organize sharing at higher page table levels for PROT_READ and
 228  * PROT_READ|PROT_WRITE maps.
 229  */
 230 struct md_object {
 231         struct pmap *pmap_rw;
 232         struct pmap *pmap_ro;
 233 };
 234
 235 /*
 236  * Each machine dependent implementation is expected to
 237  * keep certain statistics.  They may do this anyway they
 238  * so choose, but are expected to return the statistics
 239  * in the following structure.
 240  *
 241  * NOTE: We try to match the size of the pc32 pmap with the vkernel pmap
 242  * so the same utilities (like 'ps') can be used on both.
 243  */
 244 struct pmap_statistics {
 245         long resident_count;    /* # of pages mapped (total) */
 246         long wired_count;       /* # of pages wired */
 247 };
 248 typedef struct pmap_statistics *pmap_statistics_t;
 249
 250 struct pv_entry_rb_tree;
 251 RB_PROTOTYPE2(pv_entry_rb_tree, pv_entry, pv_entry,
 252               pv_entry_compare, vm_pindex_t);
 253
 254 struct pmap {
 255         pml4_entry_t            *pm_pml4;       /* KVA of level 4 page table */
 256         struct pv_entry         *pm_pmlpv;      /* PV entry for pml4 */
 257         TAILQ_ENTRY(pmap)       pm_pmnode;      /* list of pmaps */
 258         RB_HEAD(pv_entry_rb_tree, pv_entry) pm_pvroot;
 259         int                     pm_count;       /* reference count */
 260         cpumask_t               pm_active;      /* active on cpus */
 261         int                     pm_flags;
 262         struct pmap_statistics  pm_stats;       /* pmap statistics */
 263         struct pv_entry         *pm_pvhint;     /* pv_entry lookup hint */
 264         int                     pm_generation;  /* detect pvlist deletions */
 265         struct spinlock         pm_spin;
 266         struct lwkt_token       pm_token;
 267 };
 268
 269 #define CPUMASK_LOCK            CPUMASK(SMP_MAXCPU)
 270 #define CPUMASK_BIT             SMP_MAXCPU      /* for 1LLU << SMP_MAXCPU */
 271
 272 #define PMAP_FLAG_SIMPLE        0x00000001
 273
 274 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
 275
 276 typedef struct pmap     *pmap_t;
 277
 278 #ifdef _KERNEL
 279 extern struct pmap      kernel_pmap;
 280 #endif
 281
 282 /*
 283  * For each vm_page_t, there is a list of all currently valid virtual
 284  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
 285  */
 286 typedef struct pv_entry {
 287         pmap_t          pv_pmap;        /* pmap where mapping lies */
 288         vm_pindex_t     pv_pindex;      /* PTE, PT, PD, PDP, or PML4 */
 289         TAILQ_ENTRY(pv_entry)   pv_list;
 290         RB_ENTRY(pv_entry)      pv_entry;
 291         struct vm_page  *pv_m;          /* page being mapped */
 292         u_int           pv_hold;        /* interlock action */
 293         u_int           pv_flags;
 294 #ifdef PMAP_DEBUG
 295         const char      *pv_func;
 296         int             pv_line;
 297 #endif
 298 } *pv_entry_t;
 299
 300 #define PV_HOLD_LOCKED          0x80000000U
 301 #define PV_HOLD_WAITING         0x40000000U
 302 #define PV_HOLD_DELETED         0x20000000U
 303 #define PV_HOLD_MASK            0x1FFFFFFFU
 304
 305 #define PV_FLAG_VMOBJECT        0x00000001U     /* shared pt in VM obj */
 306
 307 #ifdef  _KERNEL
 308
 309 #define NPPROVMTRR              8
 310 #define PPRO_VMTRRphysBase0     0x200
 311 #define PPRO_VMTRRphysMask0     0x201
 312 struct ppro_vmtrr {
 313         u_int64_t base, mask;
 314 };
 315 extern struct ppro_vmtrr PPro_vmtrr[NPPROVMTRR];
 316
 317 extern caddr_t  CADDR1;
 318 extern pt_entry_t *CMAP1;
 319 extern vm_paddr_t dump_avail[];
 320 extern vm_paddr_t avail_end;
 321 extern vm_paddr_t avail_start;
 322 extern vm_offset_t clean_eva;
 323 extern vm_offset_t clean_sva;
 324 extern char *ptvmmap;           /* poor name! */
 325
 326 void    pmap_release(struct pmap *pmap);
 327 void    pmap_interlock_wait (struct vmspace *);
 328 void    pmap_bootstrap (vm_paddr_t *);
 329 void    *pmap_mapdev (vm_paddr_t, vm_size_t);
 330 void    *pmap_mapdev_uncacheable(vm_paddr_t, vm_size_t);
 331 void    pmap_unmapdev (vm_offset_t, vm_size_t);
 332 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
 333 #ifdef SMP
 334 void    pmap_set_opt (void);
 335 #endif
 336 vm_paddr_t pmap_kextract(vm_offset_t);
 337
 338 #endif /* _KERNEL */
 339
 340 #endif /* !LOCORE */
 341
 342 #endif /* !_MACHINE_PMAP_H_ */