sys/platform/pc64/x86_64/pmap.c

   1 /*
   2  * Copyright (c) 1991 Regents of the University of California.
   3  * Copyright (c) 1994 John S. Dyson
   4  * Copyright (c) 1994 David Greenman
   5  * Copyright (c) 2003 Peter Wemm
   6  * Copyright (c) 2005-2008 Alan L. Cox <alc@cs.rice.edu>
   7  * Copyright (c) 2008, 2009 The DragonFly Project.
   8  * Copyright (c) 2008, 2009 Jordan Gordeev.
   9  * Copyright (c) 2011-2012 Matthew Dillon
  10  * All rights reserved.
  11  *
  12  * This code is derived from software contributed to Berkeley by
  13  * the Systems Programming Group of the University of Utah Computer
  14  * Science Department and William Jolitz of UUNET Technologies Inc.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  * 3. All advertising materials mentioning features or use of this software
  25  *    must display the following acknowledgement:
  26  *      This product includes software developed by the University of
  27  *      California, Berkeley and its contributors.
  28  * 4. Neither the name of the University nor the names of its contributors
  29  *    may be used to endorse or promote products derived from this software
  30  *    without specific prior written permission.
  31  *
  32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  42  * SUCH DAMAGE.
  43  */
  44 /*
  45  * Manage physical address maps for x86-64 systems.
  46  */
  47
  48 #if 0 /* JG */
  49 #include "opt_disable_pse.h"
  50 #include "opt_pmap.h"
  51 #endif
  52 #include "opt_msgbuf.h"
  53
  54 #include <sys/param.h>
  55 #include <sys/kernel.h>
  56 #include <sys/proc.h>
  57 #include <sys/msgbuf.h>
  58 #include <sys/vmmeter.h>
  59 #include <sys/mman.h>
  60 #include <sys/systm.h>
  61
  62 #include <vm/vm.h>
  63 #include <vm/vm_param.h>
  64 #include <sys/sysctl.h>
  65 #include <sys/lock.h>
  66 #include <vm/vm_kern.h>
  67 #include <vm/vm_page.h>
  68 #include <vm/vm_map.h>
  69 #include <vm/vm_object.h>
  70 #include <vm/vm_extern.h>
  71 #include <vm/vm_pageout.h>
  72 #include <vm/vm_pager.h>
  73 #include <vm/vm_zone.h>
  74
  75 #include <sys/user.h>
  76 #include <sys/thread2.h>
  77 #include <sys/sysref2.h>
  78 #include <sys/spinlock2.h>
  79 #include <vm/vm_page2.h>
  80
  81 #include <machine/cputypes.h>
  82 #include <machine/md_var.h>
  83 #include <machine/specialreg.h>
  84 #include <machine/smp.h>
  85 #include <machine_base/apic/apicreg.h>
  86 #include <machine/globaldata.h>
  87 #include <machine/pmap.h>
  88 #include <machine/pmap_inval.h>
  89 #include <machine/inttypes.h>
  90
  91 #include <ddb/ddb.h>
  92
  93 #define PMAP_KEEP_PDIRS
  94 #ifndef PMAP_SHPGPERPROC
  95 #define PMAP_SHPGPERPROC 2000
  96 #endif
  97
  98 #if defined(DIAGNOSTIC)
  99 #define PMAP_DIAGNOSTIC
 100 #endif
 101
 102 #define MINPV 2048
 103
 104 /*
 105  * pmap debugging will report who owns a pv lock when blocking.
 106  */
 107 #ifdef PMAP_DEBUG
 108
 109 #define PMAP_DEBUG_DECL         ,const char *func, int lineno
 110 #define PMAP_DEBUG_ARGS         , __func__, __LINE__
 111 #define PMAP_DEBUG_COPY         , func, lineno
 112
 113 #define pv_get(pmap, pindex)            _pv_get(pmap, pindex            \
 114                                                         PMAP_DEBUG_ARGS)
 115 #define pv_lock(pv)                     _pv_lock(pv                     \
 116                                                         PMAP_DEBUG_ARGS)
 117 #define pv_hold_try(pv)                 _pv_hold_try(pv                 \
 118                                                         PMAP_DEBUG_ARGS)
 119 #define pv_alloc(pmap, pindex, isnewp)  _pv_alloc(pmap, pindex, isnewp  \
 120                                                         PMAP_DEBUG_ARGS)
 121
 122 #else
 123
 124 #define PMAP_DEBUG_DECL
 125 #define PMAP_DEBUG_ARGS
 126 #define PMAP_DEBUG_COPY
 127
 128 #define pv_get(pmap, pindex)            _pv_get(pmap, pindex)
 129 #define pv_lock(pv)                     _pv_lock(pv)
 130 #define pv_hold_try(pv)                 _pv_hold_try(pv)
 131 #define pv_alloc(pmap, pindex, isnewp)  _pv_alloc(pmap, pindex, isnewp)
 132
 133 #endif
 134
 135 /*
 136  * Get PDEs and PTEs for user/kernel address space
 137  */
 138 #define pdir_pde(m, v) (m[(vm_offset_t)(v) >> PDRSHIFT])
 139
 140 #define pmap_pde_v(pmap, pte)           ((*(pd_entry_t *)pte & pmap->pmap_bits[PG_V_IDX]) != 0)
 141 #define pmap_pte_w(pmap, pte)           ((*(pt_entry_t *)pte & pmap->pmap_bits[PG_W_IDX]) != 0)
 142 #define pmap_pte_m(pmap, pte)           ((*(pt_entry_t *)pte & pmap->pmap_bits[PG_M_IDX]) != 0)
 143 #define pmap_pte_u(pmap, pte)           ((*(pt_entry_t *)pte & pmap->pmap_bits[PG_U_IDX]) != 0)
 144 #define pmap_pte_v(pmap, pte)           ((*(pt_entry_t *)pte & pmap->pmap_bits[PG_V_IDX]) != 0)
 145
 146 /*
 147  * Given a map and a machine independent protection code,
 148  * convert to a vax protection code.
 149  */
 150 #define pte_prot(m, p)          \
 151         (m->protection_codes[p & (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)])
 152 static int protection_codes[PROTECTION_CODES_SIZE];
 153
 154 struct pmap kernel_pmap;
 155 static TAILQ_HEAD(,pmap)        pmap_list = TAILQ_HEAD_INITIALIZER(pmap_list);
 156
 157 MALLOC_DEFINE(M_OBJPMAP, "objpmap", "pmaps associated with VM objects");
 158
 159 vm_paddr_t avail_start;         /* PA of first available physical page */
 160 vm_paddr_t avail_end;           /* PA of last available physical page */
 161 vm_offset_t virtual2_start;     /* cutout free area prior to kernel start */
 162 vm_offset_t virtual2_end;
 163 vm_offset_t virtual_start;      /* VA of first avail page (after kernel bss) */
 164 vm_offset_t virtual_end;        /* VA of last avail page (end of kernel AS) */
 165 vm_offset_t KvaStart;           /* VA start of KVA space */
 166 vm_offset_t KvaEnd;             /* VA end of KVA space (non-inclusive) */
 167 vm_offset_t KvaSize;            /* max size of kernel virtual address space */
 168 static boolean_t pmap_initialized = FALSE;      /* Has pmap_init completed? */
 169 //static int pgeflag;           /* PG_G or-in */
 170 //static int pseflag;           /* PG_PS or-in */
 171 uint64_t PatMsr;
 172
 173 static int ndmpdp;
 174 static vm_paddr_t dmaplimit;
 175 static int nkpt;
 176 vm_offset_t kernel_vm_end = VM_MIN_KERNEL_ADDRESS;
 177
 178 static pt_entry_t pat_pte_index[PAT_INDEX_SIZE];        /* PAT -> PG_ bits */
 179 /*static pt_entry_t pat_pde_index[PAT_INDEX_SIZE];*/    /* PAT -> PG_ bits */
 180
 181 static uint64_t KPTbase;
 182 static uint64_t KPTphys;
 183 static uint64_t KPDphys;        /* phys addr of kernel level 2 */
 184 static uint64_t KPDbase;        /* phys addr of kernel level 2 @ KERNBASE */
 185 uint64_t KPDPphys;      /* phys addr of kernel level 3 */
 186 uint64_t KPML4phys;     /* phys addr of kernel level 4 */
 187
 188 static uint64_t DMPDphys;       /* phys addr of direct mapped level 2 */
 189 static uint64_t DMPDPphys;      /* phys addr of direct mapped level 3 */
 190
 191 /*
 192  * Data for the pv entry allocation mechanism
 193  */
 194 static vm_zone_t pvzone;
 195 static struct vm_zone pvzone_store;
 196 static struct vm_object pvzone_obj;
 197 static int pv_entry_max=0, pv_entry_high_water=0;
 198 static int pmap_pagedaemon_waken = 0;
 199 static struct pv_entry *pvinit;
 200
 201 /*
 202  * All those kernel PT submaps that BSD is so fond of
 203  */
 204 pt_entry_t *CMAP1 = NULL, *ptmmap;
 205 caddr_t CADDR1 = NULL, ptvmmap = NULL;
 206 static pt_entry_t *msgbufmap;
 207 struct msgbuf *msgbufp=NULL;
 208
 209 /*
 210  * PMAP default PG_* bits. Needed to be able to add
 211  * EPT/NPT pagetable pmap_bits for the VMM module
 212  */
 213 uint64_t pmap_bits_default[] = {
 214                 REGULAR_PMAP,                                   /* TYPE_IDX             0 */
 215                 X86_PG_V,                                       /* PG_V_IDX             1 */
 216                 X86_PG_RW,                                      /* PG_RW_IDX            2 */
 217                 X86_PG_U,                                       /* PG_U_IDX             3 */
 218                 X86_PG_A,                                       /* PG_A_IDX             4 */
 219                 X86_PG_M,                                       /* PG_M_IDX             5 */
 220                 X86_PG_PS,                                      /* PG_PS_IDX3           6 */
 221                 X86_PG_G,                                       /* PG_G_IDX             7 */
 222                 X86_PG_AVAIL1,                                  /* PG_AVAIL1_IDX        8 */
 223                 X86_PG_AVAIL2,                                  /* PG_AVAIL2_IDX        9 */
 224                 X86_PG_AVAIL3,                                  /* PG_AVAIL3_IDX        10 */
 225                 X86_PG_NC_PWT | X86_PG_NC_PCD,                  /* PG_N_IDX     11 */
 226 };
 227 /*
 228  * Crashdump maps.
 229  */
 230 static pt_entry_t *pt_crashdumpmap;
 231 static caddr_t crashdumpmap;
 232
 233 #ifdef PMAP_DEBUG2
 234 static int pmap_enter_debug = 0;
 235 SYSCTL_INT(_machdep, OID_AUTO, pmap_enter_debug, CTLFLAG_RW,
 236     &pmap_enter_debug, 0, "Debug pmap_enter's");
 237 #endif
 238 static int pmap_yield_count = 64;
 239 SYSCTL_INT(_machdep, OID_AUTO, pmap_yield_count, CTLFLAG_RW,
 240     &pmap_yield_count, 0, "Yield during init_pt/release");
 241 static int pmap_mmu_optimize = 0;
 242 SYSCTL_INT(_machdep, OID_AUTO, pmap_mmu_optimize, CTLFLAG_RW,
 243     &pmap_mmu_optimize, 0, "Share page table pages when possible");
 244 int pmap_fast_kernel_cpusync = 0;
 245 SYSCTL_INT(_machdep, OID_AUTO, pmap_fast_kernel_cpusync, CTLFLAG_RW,
 246     &pmap_fast_kernel_cpusync, 0, "Share page table pages when possible");
 247
 248 #define DISABLE_PSE
 249
 250 /* Standard user access funtions */
 251 extern int std_copyinstr (const void *udaddr, void *kaddr, size_t len,
 252     size_t *lencopied);
 253 extern int std_copyin (const void *udaddr, void *kaddr, size_t len);
 254 extern int std_copyout (const void *kaddr, void *udaddr, size_t len);
 255 extern int std_fubyte (const void *base);
 256 extern int std_subyte (void *base, int byte);
 257 extern long std_fuword (const void *base);
 258 extern int std_suword (void *base, long word);
 259 extern int std_suword32 (void *base, int word);
 260
 261 static void pv_hold(pv_entry_t pv);
 262 static int _pv_hold_try(pv_entry_t pv
 263                                 PMAP_DEBUG_DECL);
 264 static void pv_drop(pv_entry_t pv);
 265 static void _pv_lock(pv_entry_t pv
 266                                 PMAP_DEBUG_DECL);
 267 static void pv_unlock(pv_entry_t pv);
 268 static pv_entry_t _pv_alloc(pmap_t pmap, vm_pindex_t pindex, int *isnew
 269                                 PMAP_DEBUG_DECL);
 270 static pv_entry_t _pv_get(pmap_t pmap, vm_pindex_t pindex
 271                                 PMAP_DEBUG_DECL);
 272 static pv_entry_t pv_get_try(pmap_t pmap, vm_pindex_t pindex, int *errorp);
 273 static pv_entry_t pv_find(pmap_t pmap, vm_pindex_t pindex);
 274 static void pv_put(pv_entry_t pv);
 275 static void pv_free(pv_entry_t pv);
 276 static void *pv_pte_lookup(pv_entry_t pv, vm_pindex_t pindex);
 277 static pv_entry_t pmap_allocpte(pmap_t pmap, vm_pindex_t ptepindex,
 278                       pv_entry_t *pvpp);
 279 static pv_entry_t pmap_allocpte_seg(pmap_t pmap, vm_pindex_t ptepindex,
 280                       pv_entry_t *pvpp, vm_map_entry_t entry, vm_offset_t va);
 281 static void pmap_remove_pv_pte(pv_entry_t pv, pv_entry_t pvp,
 282                         pmap_inval_bulk_t *bulk);
 283 static vm_page_t pmap_remove_pv_page(pv_entry_t pv);
 284 static int pmap_release_pv(pv_entry_t pv, pv_entry_t pvp,
 285                         pmap_inval_bulk_t *bulk);
 286
 287 struct pmap_scan_info;
 288 static void pmap_remove_callback(pmap_t pmap, struct pmap_scan_info *info,
 289                       pv_entry_t pte_pv, pv_entry_t pt_pv, int sharept,
 290                       vm_offset_t va, pt_entry_t *ptep, void *arg __unused);
 291 static void pmap_protect_callback(pmap_t pmap, struct pmap_scan_info *info,
 292                       pv_entry_t pte_pv, pv_entry_t pt_pv, int sharept,
 293                       vm_offset_t va, pt_entry_t *ptep, void *arg __unused);
 294
 295 static void i386_protection_init (void);
 296 static void create_pagetables(vm_paddr_t *firstaddr);
 297 static void pmap_remove_all (vm_page_t m);
 298 static boolean_t pmap_testbit (vm_page_t m, int bit);
 299
 300 static pt_entry_t * pmap_pte_quick (pmap_t pmap, vm_offset_t va);
 301 static vm_offset_t pmap_kmem_choose(vm_offset_t addr);
 302
 303 static void pmap_pinit_defaults(struct pmap *pmap);
 304
 305 static unsigned pdir4mb;
 306
 307 static int
 308 pv_entry_compare(pv_entry_t pv1, pv_entry_t pv2)
 309 {
 310         if (pv1->pv_pindex < pv2->pv_pindex)
 311                 return(-1);
 312         if (pv1->pv_pindex > pv2->pv_pindex)
 313                 return(1);
 314         return(0);
 315 }
 316
 317 RB_GENERATE2(pv_entry_rb_tree, pv_entry, pv_entry,
 318              pv_entry_compare, vm_pindex_t, pv_pindex);
 319
 320 static __inline
 321 void
 322 pmap_page_stats_adding(vm_page_t m)
 323 {
 324         globaldata_t gd = mycpu;
 325
 326         if (TAILQ_EMPTY(&m->md.pv_list)) {
 327                 ++gd->gd_vmtotal.t_arm;
 328         } else if (TAILQ_FIRST(&m->md.pv_list) ==
 329                    TAILQ_LAST(&m->md.pv_list, md_page_pv_list)) {
 330                 ++gd->gd_vmtotal.t_armshr;
 331                 ++gd->gd_vmtotal.t_avmshr;
 332         } else {
 333                 ++gd->gd_vmtotal.t_avmshr;
 334         }
 335 }
 336
 337 static __inline
 338 void
 339 pmap_page_stats_deleting(vm_page_t m)
 340 {
 341         globaldata_t gd = mycpu;
 342
 343         if (TAILQ_EMPTY(&m->md.pv_list)) {
 344                 --gd->gd_vmtotal.t_arm;
 345         } else if (TAILQ_FIRST(&m->md.pv_list) ==
 346                    TAILQ_LAST(&m->md.pv_list, md_page_pv_list)) {
 347                 --gd->gd_vmtotal.t_armshr;
 348                 --gd->gd_vmtotal.t_avmshr;
 349         } else {
 350                 --gd->gd_vmtotal.t_avmshr;
 351         }
 352 }
 353
 354 /*
 355  * Move the kernel virtual free pointer to the next
 356  * 2MB.  This is used to help improve performance
 357  * by using a large (2MB) page for much of the kernel
 358  * (.text, .data, .bss)
 359  */
 360 static
 361 vm_offset_t
 362 pmap_kmem_choose(vm_offset_t addr)
 363 {
 364         vm_offset_t newaddr = addr;
 365
 366         newaddr = roundup2(addr, NBPDR);
 367         return newaddr;
 368 }
 369
 370 /*
 371  * pmap_pte_quick:
 372  *
 373  *      Super fast pmap_pte routine best used when scanning the pv lists.
 374  *      This eliminates many course-grained invltlb calls.  Note that many of
 375  *      the pv list scans are across different pmaps and it is very wasteful
 376  *      to do an entire invltlb when checking a single mapping.
 377  */
 378 static __inline pt_entry_t *pmap_pte(pmap_t pmap, vm_offset_t va);
 379
 380 static
 381 pt_entry_t *
 382 pmap_pte_quick(pmap_t pmap, vm_offset_t va)
 383 {
 384         return pmap_pte(pmap, va);
 385 }
 386
 387 /*
 388  * Returns the pindex of a page table entry (representing a terminal page).
 389  * There are NUPTE_TOTAL page table entries possible (a huge number)
 390  *
 391  * x86-64 has a 48-bit address space, where bit 47 is sign-extended out.
 392  * We want to properly translate negative KVAs.
 393  */
 394 static __inline
 395 vm_pindex_t
 396 pmap_pte_pindex(vm_offset_t va)
 397 {
 398         return ((va >> PAGE_SHIFT) & (NUPTE_TOTAL - 1));
 399 }
 400
 401 /*
 402  * Returns the pindex of a page table.
 403  */
 404 static __inline
 405 vm_pindex_t
 406 pmap_pt_pindex(vm_offset_t va)
 407 {
 408         return (NUPTE_TOTAL + ((va >> PDRSHIFT) & (NUPT_TOTAL - 1)));
 409 }
 410
 411 /*
 412  * Returns the pindex of a page directory.
 413  */
 414 static __inline
 415 vm_pindex_t
 416 pmap_pd_pindex(vm_offset_t va)
 417 {
 418         return (NUPTE_TOTAL + NUPT_TOTAL +
 419                 ((va >> PDPSHIFT) & (NUPD_TOTAL - 1)));
 420 }
 421
 422 static __inline
 423 vm_pindex_t
 424 pmap_pdp_pindex(vm_offset_t va)
 425 {
 426         return (NUPTE_TOTAL + NUPT_TOTAL + NUPD_TOTAL +
 427                 ((va >> PML4SHIFT) & (NUPDP_TOTAL - 1)));
 428 }
 429
 430 static __inline
 431 vm_pindex_t
 432 pmap_pml4_pindex(void)
 433 {
 434         return (NUPTE_TOTAL + NUPT_TOTAL + NUPD_TOTAL + NUPDP_TOTAL);
 435 }
 436
 437 /*
 438  * Return various clipped indexes for a given VA
 439  *
 440  * Returns the index of a pte in a page table, representing a terminal
 441  * page.
 442  */
 443 static __inline
 444 vm_pindex_t
 445 pmap_pte_index(vm_offset_t va)
 446 {
 447         return ((va >> PAGE_SHIFT) & ((1ul << NPTEPGSHIFT) - 1));
 448 }
 449
 450 /*
 451  * Returns the index of a pt in a page directory, representing a page
 452  * table.
 453  */
 454 static __inline
 455 vm_pindex_t
 456 pmap_pt_index(vm_offset_t va)
 457 {
 458         return ((va >> PDRSHIFT) & ((1ul << NPDEPGSHIFT) - 1));
 459 }
 460
 461 /*
 462  * Returns the index of a pd in a page directory page, representing a page
 463  * directory.
 464  */
 465 static __inline
 466 vm_pindex_t
 467 pmap_pd_index(vm_offset_t va)
 468 {
 469         return ((va >> PDPSHIFT) & ((1ul << NPDPEPGSHIFT) - 1));
 470 }
 471
 472 /*
 473  * Returns the index of a pdp in the pml4 table, representing a page
 474  * directory page.
 475  */
 476 static __inline
 477 vm_pindex_t
 478 pmap_pdp_index(vm_offset_t va)
 479 {
 480         return ((va >> PML4SHIFT) & ((1ul << NPML4EPGSHIFT) - 1));
 481 }
 482
 483 /*
 484  * Generic procedure to index a pte from a pt, pd, or pdp.
 485  *
 486  * NOTE: Normally passed pindex as pmap_xx_index().  pmap_xx_pindex() is NOT
 487  *       a page table page index but is instead of PV lookup index.
 488  */
 489 static
 490 void *
 491 pv_pte_lookup(pv_entry_t pv, vm_pindex_t pindex)
 492 {
 493         pt_entry_t *pte;
 494
 495         pte = (pt_entry_t *)PHYS_TO_DMAP(VM_PAGE_TO_PHYS(pv->pv_m));
 496         return(&pte[pindex]);
 497 }
 498
 499 /*
 500  * Return pointer to PDP slot in the PML4
 501  */
 502 static __inline
 503 pml4_entry_t *
 504 pmap_pdp(pmap_t pmap, vm_offset_t va)
 505 {
 506         return (&pmap->pm_pml4[pmap_pdp_index(va)]);
 507 }
 508
 509 /*
 510  * Return pointer to PD slot in the PDP given a pointer to the PDP
 511  */
 512 static __inline
 513 pdp_entry_t *
 514 pmap_pdp_to_pd(pml4_entry_t pdp_pte, vm_offset_t va)
 515 {
 516         pdp_entry_t *pd;
 517
 518         pd = (pdp_entry_t *)PHYS_TO_DMAP(pdp_pte & PG_FRAME);
 519         return (&pd[pmap_pd_index(va)]);
 520 }
 521
 522 /*
 523  * Return pointer to PD slot in the PDP.
 524  */
 525 static __inline
 526 pdp_entry_t *
 527 pmap_pd(pmap_t pmap, vm_offset_t va)
 528 {
 529         pml4_entry_t *pdp;
 530
 531         pdp = pmap_pdp(pmap, va);
 532         if ((*pdp & pmap->pmap_bits[PG_V_IDX]) == 0)
 533                 return NULL;
 534         return (pmap_pdp_to_pd(*pdp, va));
 535 }
 536
 537 /*
 538  * Return pointer to PT slot in the PD given a pointer to the PD
 539  */
 540 static __inline
 541 pd_entry_t *
 542 pmap_pd_to_pt(pdp_entry_t pd_pte, vm_offset_t va)
 543 {
 544         pd_entry_t *pt;
 545
 546         pt = (pd_entry_t *)PHYS_TO_DMAP(pd_pte & PG_FRAME);
 547         return (&pt[pmap_pt_index(va)]);
 548 }
 549
 550 /*
 551  * Return pointer to PT slot in the PD
 552  *
 553  * SIMPLE PMAP NOTE: Simple pmaps (embedded in objects) do not have PDPs,
 554  *                   so we cannot lookup the PD via the PDP.  Instead we
 555  *                   must look it up via the pmap.
 556  */
 557 static __inline
 558 pd_entry_t *
 559 pmap_pt(pmap_t pmap, vm_offset_t va)
 560 {
 561         pdp_entry_t *pd;
 562         pv_entry_t pv;
 563         vm_pindex_t pd_pindex;
 564
 565         if (pmap->pm_flags & PMAP_FLAG_SIMPLE) {
 566                 pd_pindex = pmap_pd_pindex(va);
 567                 spin_lock(&pmap->pm_spin);
 568                 pv = pv_entry_rb_tree_RB_LOOKUP(&pmap->pm_pvroot, pd_pindex);
 569                 spin_unlock(&pmap->pm_spin);
 570                 if (pv == NULL || pv->pv_m == NULL)
 571                         return NULL;
 572                 return (pmap_pd_to_pt(VM_PAGE_TO_PHYS(pv->pv_m), va));
 573         } else {
 574                 pd = pmap_pd(pmap, va);
 575                 if (pd == NULL || (*pd & pmap->pmap_bits[PG_V_IDX]) == 0)
 576                          return NULL;
 577                 return (pmap_pd_to_pt(*pd, va));
 578         }
 579 }
 580
 581 /*
 582  * Return pointer to PTE slot in the PT given a pointer to the PT
 583  */
 584 static __inline
 585 pt_entry_t *
 586 pmap_pt_to_pte(pd_entry_t pt_pte, vm_offset_t va)
 587 {
 588         pt_entry_t *pte;
 589
 590         pte = (pt_entry_t *)PHYS_TO_DMAP(pt_pte & PG_FRAME);
 591         return (&pte[pmap_pte_index(va)]);
 592 }
 593
 594 /*
 595  * Return pointer to PTE slot in the PT
 596  */
 597 static __inline
 598 pt_entry_t *
 599 pmap_pte(pmap_t pmap, vm_offset_t va)
 600 {
 601         pd_entry_t *pt;
 602
 603         pt = pmap_pt(pmap, va);
 604         if (pt == NULL || (*pt & pmap->pmap_bits[PG_V_IDX]) == 0)
 605                  return NULL;
 606         if ((*pt & pmap->pmap_bits[PG_PS_IDX]) != 0)
 607                 return ((pt_entry_t *)pt);
 608         return (pmap_pt_to_pte(*pt, va));
 609 }
 610
 611 /*
 612  * Of all the layers (PTE, PT, PD, PDP, PML4) the best one to cache is
 613  * the PT layer.  This will speed up core pmap operations considerably.
 614  *
 615  * NOTE: The pmap spinlock does not need to be held but the passed-in pv
 616  *       must be in a known associated state (typically by being locked when
 617  *       the pmap spinlock isn't held).  We allow the race for that case.
 618  */
 619 static __inline
 620 void
 621 pv_cache(pv_entry_t pv, vm_pindex_t pindex)
 622 {
 623         if (pindex >= pmap_pt_pindex(0) && pindex <= pmap_pd_pindex(0))
 624                 pv->pv_pmap->pm_pvhint = pv;
 625 }
 626
 627
 628 /*
 629  * Return address of PT slot in PD (KVM only)
 630  *
 631  * Cannot be used for user page tables because it might interfere with
 632  * the shared page-table-page optimization (pmap_mmu_optimize).
 633  */
 634 static __inline
 635 pd_entry_t *
 636 vtopt(vm_offset_t va)
 637 {
 638         uint64_t mask = ((1ul << (NPDEPGSHIFT + NPDPEPGSHIFT +
 639                                   NPML4EPGSHIFT)) - 1);
 640
 641         return (PDmap + ((va >> PDRSHIFT) & mask));
 642 }
 643
 644 /*
 645  * KVM - return address of PTE slot in PT
 646  */
 647 static __inline
 648 pt_entry_t *
 649 vtopte(vm_offset_t va)
 650 {
 651         uint64_t mask = ((1ul << (NPTEPGSHIFT + NPDEPGSHIFT +
 652                                   NPDPEPGSHIFT + NPML4EPGSHIFT)) - 1);
 653
 654         return (PTmap + ((va >> PAGE_SHIFT) & mask));
 655 }
 656
 657 static uint64_t
 658 allocpages(vm_paddr_t *firstaddr, long n)
 659 {
 660         uint64_t ret;
 661
 662         ret = *firstaddr;
 663         bzero((void *)ret, n * PAGE_SIZE);
 664         *firstaddr += n * PAGE_SIZE;
 665         return (ret);
 666 }
 667
 668 static
 669 void
 670 create_pagetables(vm_paddr_t *firstaddr)
 671 {
 672         long i;         /* must be 64 bits */
 673         long nkpt_base;
 674         long nkpt_phys;
 675         int j;
 676
 677         /*
 678          * We are running (mostly) V=P at this point
 679          *
 680          * Calculate NKPT - number of kernel page tables.  We have to
 681          * accomodoate prealloction of the vm_page_array, dump bitmap,
 682          * MSGBUF_SIZE, and other stuff.  Be generous.
 683          *
 684          * Maxmem is in pages.
 685          *
 686          * ndmpdp is the number of 1GB pages we wish to map.
 687          */
 688         ndmpdp = (ptoa(Maxmem) + NBPDP - 1) >> PDPSHIFT;
 689         if (ndmpdp < 4)         /* Minimum 4GB of dirmap */
 690                 ndmpdp = 4;
 691         KKASSERT(ndmpdp <= NKPDPE * NPDEPG);
 692
 693         /*
 694          * Starting at the beginning of kvm (not KERNBASE).
 695          */
 696         nkpt_phys = (Maxmem * sizeof(struct vm_page) + NBPDR - 1) / NBPDR;
 697         nkpt_phys += (Maxmem * sizeof(struct pv_entry) + NBPDR - 1) / NBPDR;
 698         nkpt_phys += ((nkpt + nkpt + 1 + NKPML4E + NKPDPE + NDMPML4E +
 699                        ndmpdp) + 511) / 512;
 700         nkpt_phys += 128;
 701
 702         /*
 703          * Starting at KERNBASE - map 2G worth of page table pages.
 704          * KERNBASE is offset -2G from the end of kvm.
 705          */
 706         nkpt_base = (NPDPEPG - KPDPI) * NPTEPG; /* typically 2 x 512 */
 707
 708         /*
 709          * Allocate pages
 710          */
 711         KPTbase = allocpages(firstaddr, nkpt_base);
 712         KPTphys = allocpages(firstaddr, nkpt_phys);
 713         KPML4phys = allocpages(firstaddr, 1);
 714         KPDPphys = allocpages(firstaddr, NKPML4E);
 715         KPDphys = allocpages(firstaddr, NKPDPE);
 716
 717         /*
 718          * Calculate the page directory base for KERNBASE,
 719          * that is where we start populating the page table pages.
 720          * Basically this is the end - 2.
 721          */
 722         KPDbase = KPDphys + ((NKPDPE - (NPDPEPG - KPDPI)) << PAGE_SHIFT);
 723
 724         DMPDPphys = allocpages(firstaddr, NDMPML4E);
 725         if ((amd_feature & AMDID_PAGE1GB) == 0)
 726                 DMPDphys = allocpages(firstaddr, ndmpdp);
 727         dmaplimit = (vm_paddr_t)ndmpdp << PDPSHIFT;
 728
 729         /*
 730          * Fill in the underlying page table pages for the area around
 731          * KERNBASE.  This remaps low physical memory to KERNBASE.
 732          *
 733          * Read-only from zero to physfree
 734          * XXX not fully used, underneath 2M pages
 735          */
 736         for (i = 0; (i << PAGE_SHIFT) < *firstaddr; i++) {
 737                 ((pt_entry_t *)KPTbase)[i] = i << PAGE_SHIFT;
 738                 ((pt_entry_t *)KPTbase)[i] |=
 739                     pmap_bits_default[PG_RW_IDX] |
 740                     pmap_bits_default[PG_V_IDX] |
 741                     pmap_bits_default[PG_G_IDX];
 742         }
 743
 744         /*
 745          * Now map the initial kernel page tables.  One block of page
 746          * tables is placed at the beginning of kernel virtual memory,
 747          * and another block is placed at KERNBASE to map the kernel binary,
 748          * data, bss, and initial pre-allocations.
 749          */
 750         for (i = 0; i < nkpt_base; i++) {
 751                 ((pd_entry_t *)KPDbase)[i] = KPTbase + (i << PAGE_SHIFT);
 752                 ((pd_entry_t *)KPDbase)[i] |=
 753                     pmap_bits_default[PG_RW_IDX] |
 754                     pmap_bits_default[PG_V_IDX];
 755         }
 756         for (i = 0; i < nkpt_phys; i++) {
 757                 ((pd_entry_t *)KPDphys)[i] = KPTphys + (i << PAGE_SHIFT);
 758                 ((pd_entry_t *)KPDphys)[i] |=
 759                     pmap_bits_default[PG_RW_IDX] |
 760                     pmap_bits_default[PG_V_IDX];
 761         }
 762
 763         /*
 764          * Map from zero to end of allocations using 2M pages as an
 765          * optimization.  This will bypass some of the KPTBase pages
 766          * above in the KERNBASE area.
 767          */
 768         for (i = 0; (i << PDRSHIFT) < *firstaddr; i++) {
 769                 ((pd_entry_t *)KPDbase)[i] = i << PDRSHIFT;
 770                 ((pd_entry_t *)KPDbase)[i] |=
 771                     pmap_bits_default[PG_RW_IDX] |
 772                     pmap_bits_default[PG_V_IDX] |
 773                     pmap_bits_default[PG_PS_IDX] |
 774                     pmap_bits_default[PG_G_IDX];
 775         }
 776
 777         /*
 778          * And connect up the PD to the PDP.  The kernel pmap is expected
 779          * to pre-populate all of its PDs.  See NKPDPE in vmparam.h.
 780          */
 781         for (i = 0; i < NKPDPE; i++) {
 782                 ((pdp_entry_t *)KPDPphys)[NPDPEPG - NKPDPE + i] =
 783                                 KPDphys + (i << PAGE_SHIFT);
 784                 ((pdp_entry_t *)KPDPphys)[NPDPEPG - NKPDPE + i] |=
 785                     pmap_bits_default[PG_RW_IDX] |
 786                     pmap_bits_default[PG_V_IDX] |
 787                     pmap_bits_default[PG_U_IDX];
 788         }
 789
 790         /*
 791          * Now set up the direct map space using either 2MB or 1GB pages
 792          * Preset PG_M and PG_A because demotion expects it.
 793          *
 794          * When filling in entries in the PD pages make sure any excess
 795          * entries are set to zero as we allocated enough PD pages
 796          */
 797         if ((amd_feature & AMDID_PAGE1GB) == 0) {
 798                 for (i = 0; i < NPDEPG * ndmpdp; i++) {
 799                         ((pd_entry_t *)DMPDphys)[i] = i << PDRSHIFT;
 800                         ((pd_entry_t *)DMPDphys)[i] |=
 801                             pmap_bits_default[PG_RW_IDX] |
 802                             pmap_bits_default[PG_V_IDX] |
 803                             pmap_bits_default[PG_PS_IDX] |
 804                             pmap_bits_default[PG_G_IDX] |
 805                             pmap_bits_default[PG_M_IDX] |
 806                             pmap_bits_default[PG_A_IDX];
 807                 }
 808
 809                 /*
 810                  * And the direct map space's PDP
 811                  */
 812                 for (i = 0; i < ndmpdp; i++) {
 813                         ((pdp_entry_t *)DMPDPphys)[i] = DMPDphys +
 814                                                         (i << PAGE_SHIFT);
 815                         ((pdp_entry_t *)DMPDPphys)[i] |=
 816                             pmap_bits_default[PG_RW_IDX] |
 817                             pmap_bits_default[PG_V_IDX] |
 818                             pmap_bits_default[PG_U_IDX];
 819                 }
 820         } else {
 821                 for (i = 0; i < ndmpdp; i++) {
 822                         ((pdp_entry_t *)DMPDPphys)[i] =
 823                                                 (vm_paddr_t)i << PDPSHIFT;
 824                         ((pdp_entry_t *)DMPDPphys)[i] |=
 825                             pmap_bits_default[PG_RW_IDX] |
 826                             pmap_bits_default[PG_V_IDX] |
 827                             pmap_bits_default[PG_PS_IDX] |
 828                             pmap_bits_default[PG_G_IDX] |
 829                             pmap_bits_default[PG_M_IDX] |
 830                             pmap_bits_default[PG_A_IDX];
 831                 }
 832         }
 833
 834         /* And recursively map PML4 to itself in order to get PTmap */
 835         ((pdp_entry_t *)KPML4phys)[PML4PML4I] = KPML4phys;
 836         ((pdp_entry_t *)KPML4phys)[PML4PML4I] |=
 837             pmap_bits_default[PG_RW_IDX] |
 838             pmap_bits_default[PG_V_IDX] |
 839             pmap_bits_default[PG_U_IDX];
 840
 841         /*
 842          * Connect the Direct Map slots up to the PML4
 843          */
 844         for (j = 0; j < NDMPML4E; ++j) {
 845                 ((pdp_entry_t *)KPML4phys)[DMPML4I + j] =
 846                     (DMPDPphys + ((vm_paddr_t)j << PML4SHIFT)) |
 847                     pmap_bits_default[PG_RW_IDX] |
 848                     pmap_bits_default[PG_V_IDX] |
 849                     pmap_bits_default[PG_U_IDX];
 850         }
 851
 852         /*
 853          * Connect the KVA slot up to the PML4
 854          */
 855         ((pdp_entry_t *)KPML4phys)[KPML4I] = KPDPphys;
 856         ((pdp_entry_t *)KPML4phys)[KPML4I] |=
 857             pmap_bits_default[PG_RW_IDX] |
 858             pmap_bits_default[PG_V_IDX] |
 859             pmap_bits_default[PG_U_IDX];
 860 }
 861
 862 /*
 863  *      Bootstrap the system enough to run with virtual memory.
 864  *
 865  *      On the i386 this is called after mapping has already been enabled
 866  *      and just syncs the pmap module with what has already been done.
 867  *      [We can't call it easily with mapping off since the kernel is not
 868  *      mapped with PA == VA, hence we would have to relocate every address
 869  *      from the linked base (virtual) address "KERNBASE" to the actual
 870  *      (physical) address starting relative to 0]
 871  */
 872 void
 873 pmap_bootstrap(vm_paddr_t *firstaddr)
 874 {
 875         vm_offset_t va;
 876         pt_entry_t *pte;
 877
 878         KvaStart = VM_MIN_KERNEL_ADDRESS;
 879         KvaEnd = VM_MAX_KERNEL_ADDRESS;
 880         KvaSize = KvaEnd - KvaStart;
 881
 882         avail_start = *firstaddr;
 883
 884         /*
 885          * Create an initial set of page tables to run the kernel in.
 886          */
 887         create_pagetables(firstaddr);
 888
 889         virtual2_start = KvaStart;
 890         virtual2_end = PTOV_OFFSET;
 891
 892         virtual_start = (vm_offset_t) PTOV_OFFSET + *firstaddr;
 893         virtual_start = pmap_kmem_choose(virtual_start);
 894
 895         virtual_end = VM_MAX_KERNEL_ADDRESS;
 896
 897         /* XXX do %cr0 as well */
 898         load_cr4(rcr4() | CR4_PGE | CR4_PSE);
 899         load_cr3(KPML4phys);
 900
 901         /*
 902          * Initialize protection array.
 903          */
 904         i386_protection_init();
 905
 906         /*
 907          * The kernel's pmap is statically allocated so we don't have to use
 908          * pmap_create, which is unlikely to work correctly at this part of
 909          * the boot sequence (XXX and which no longer exists).
 910          */
 911         kernel_pmap.pm_pml4 = (pdp_entry_t *) (PTOV_OFFSET + KPML4phys);
 912         kernel_pmap.pm_count = 1;
 913         CPUMASK_ASSALLONES(kernel_pmap.pm_active);
 914         RB_INIT(&kernel_pmap.pm_pvroot);
 915         spin_init(&kernel_pmap.pm_spin, "pmapbootstrap");
 916         lwkt_token_init(&kernel_pmap.pm_token, "kpmap_tok");
 917
 918         /*
 919          * Reserve some special page table entries/VA space for temporary
 920          * mapping of pages.
 921          */
 922 #define SYSMAP(c, p, v, n)      \
 923         v = (c)va; va += ((n)*PAGE_SIZE); p = pte; pte += (n);
 924
 925         va = virtual_start;
 926         pte = vtopte(va);
 927
 928         /*
 929          * CMAP1/CMAP2 are used for zeroing and copying pages.
 930          */
 931         SYSMAP(caddr_t, CMAP1, CADDR1, 1)
 932
 933         /*
 934          * Crashdump maps.
 935          */
 936         SYSMAP(caddr_t, pt_crashdumpmap, crashdumpmap, MAXDUMPPGS);
 937
 938         /*
 939          * ptvmmap is used for reading arbitrary physical pages via
 940          * /dev/mem.
 941          */
 942         SYSMAP(caddr_t, ptmmap, ptvmmap, 1)
 943
 944         /*
 945          * msgbufp is used to map the system message buffer.
 946          * XXX msgbufmap is not used.
 947          */
 948         SYSMAP(struct msgbuf *, msgbufmap, msgbufp,
 949                atop(round_page(MSGBUF_SIZE)))
 950
 951         virtual_start = va;
 952         virtual_start = pmap_kmem_choose(virtual_start);
 953
 954         *CMAP1 = 0;
 955
 956         /*
 957          * PG_G is terribly broken on SMP because we IPI invltlb's in some
 958          * cases rather then invl1pg.  Actually, I don't even know why it
 959          * works under UP because self-referential page table mappings
 960          */
 961 //      pgeflag = 0;
 962
 963 /*
 964  * Initialize the 4MB page size flag
 965  */
 966 //      pseflag = 0;
 967 /*
 968  * The 4MB page version of the initial
 969  * kernel page mapping.
 970  */
 971         pdir4mb = 0;
 972
 973 #if !defined(DISABLE_PSE)
 974         if (cpu_feature & CPUID_PSE) {
 975                 pt_entry_t ptditmp;
 976                 /*
 977                  * Note that we have enabled PSE mode
 978                  */
 979 //              pseflag = kernel_pmap.pmap_bits[PG_PS_IDX];
 980                 ptditmp = *(PTmap + x86_64_btop(KERNBASE));
 981                 ptditmp &= ~(NBPDR - 1);
 982                 ptditmp |= pmap_bits_default[PG_V_IDX] |
 983                     pmap_bits_default[PG_RW_IDX] |
 984                     pmap_bits_default[PG_PS_IDX] |
 985                     pmap_bits_default[PG_U_IDX];
 986 //                  pgeflag;
 987                 pdir4mb = ptditmp;
 988         }
 989 #endif
 990         cpu_invltlb();
 991
 992         /* Initialize the PAT MSR */
 993         pmap_init_pat();
 994         pmap_pinit_defaults(&kernel_pmap);
 995
 996         TUNABLE_INT_FETCH("machdep.pmap_fast_kernel_cpusync",
 997                           &pmap_fast_kernel_cpusync);
 998
 999 }
1000
1001 /*
1002  * Setup the PAT MSR.
1003  */
1004 void
1005 pmap_init_pat(void)
1006 {
1007         uint64_t pat_msr;
1008         u_long cr0, cr4;
1009
1010         /*
1011          * Default values mapping PATi,PCD,PWT bits at system reset.
1012          * The default values effectively ignore the PATi bit by
1013          * repeating the encodings for 0-3 in 4-7, and map the PCD
1014          * and PWT bit combinations to the expected PAT types.
1015          */
1016         pat_msr = PAT_VALUE(0, PAT_WRITE_BACK) |        /* 000 */
1017                   PAT_VALUE(1, PAT_WRITE_THROUGH) |     /* 001 */
1018                   PAT_VALUE(2, PAT_UNCACHED) |          /* 010 */
1019                   PAT_VALUE(3, PAT_UNCACHEABLE) |       /* 011 */
1020                   PAT_VALUE(4, PAT_WRITE_BACK) |        /* 100 */
1021                   PAT_VALUE(5, PAT_WRITE_THROUGH) |     /* 101 */
1022                   PAT_VALUE(6, PAT_UNCACHED) |          /* 110 */
1023                   PAT_VALUE(7, PAT_UNCACHEABLE);        /* 111 */
1024         pat_pte_index[PAT_WRITE_BACK]   = 0;
1025         pat_pte_index[PAT_WRITE_THROUGH]= 0         | X86_PG_NC_PWT;
1026         pat_pte_index[PAT_UNCACHED]     = X86_PG_NC_PCD;
1027         pat_pte_index[PAT_UNCACHEABLE]  = X86_PG_NC_PCD | X86_PG_NC_PWT;
1028         pat_pte_index[PAT_WRITE_PROTECTED] = pat_pte_index[PAT_UNCACHEABLE];
1029         pat_pte_index[PAT_WRITE_COMBINING] = pat_pte_index[PAT_UNCACHEABLE];
1030
1031         if (cpu_feature & CPUID_PAT) {
1032                 /*
1033                  * If we support the PAT then set-up entries for
1034                  * WRITE_PROTECTED and WRITE_COMBINING using bit patterns
1035                  * 4 and 5.
1036                  */
1037                 pat_msr = (pat_msr & ~PAT_MASK(4)) |
1038                           PAT_VALUE(4, PAT_WRITE_PROTECTED);
1039                 pat_msr = (pat_msr & ~PAT_MASK(5)) |
1040                           PAT_VALUE(5, PAT_WRITE_COMBINING);
1041                 pat_pte_index[PAT_WRITE_PROTECTED] = X86_PG_PTE_PAT | 0;
1042                 pat_pte_index[PAT_WRITE_COMBINING] = X86_PG_PTE_PAT | X86_PG_NC_PWT;
1043
1044                 /*
1045                  * Then enable the PAT
1046                  */
1047
1048                 /* Disable PGE. */
1049                 cr4 = rcr4();
1050                 load_cr4(cr4 & ~CR4_PGE);
1051
1052                 /* Disable caches (CD = 1, NW = 0). */
1053                 cr0 = rcr0();
1054                 load_cr0((cr0 & ~CR0_NW) | CR0_CD);
1055
1056                 /* Flushes caches and TLBs. */
1057                 wbinvd();
1058                 cpu_invltlb();
1059
1060                 /* Update PAT and index table. */
1061                 wrmsr(MSR_PAT, pat_msr);
1062
1063                 /* Flush caches and TLBs again. */
1064                 wbinvd();
1065                 cpu_invltlb();
1066
1067                 /* Restore caches and PGE. */
1068                 load_cr0(cr0);
1069                 load_cr4(cr4);
1070                 PatMsr = pat_msr;
1071         }
1072 }
1073
1074 /*
1075  * Set 4mb pdir for mp startup
1076  */
1077 void
1078 pmap_set_opt(void)
1079 {
1080         if (cpu_feature & CPUID_PSE) {
1081                 load_cr4(rcr4() | CR4_PSE);
1082                 if (pdir4mb && mycpu->gd_cpuid == 0) {  /* only on BSP */
1083                         cpu_invltlb();
1084                 }
1085         }
1086 }
1087
1088 /*
1089  *      Initialize the pmap module.
1090  *      Called by vm_init, to initialize any structures that the pmap
1091  *      system needs to map virtual memory.
1092  *      pmap_init has been enhanced to support in a fairly consistant
1093  *      way, discontiguous physical memory.
1094  */
1095 void
1096 pmap_init(void)
1097 {
1098         int i;
1099         int initial_pvs;
1100
1101         /*
1102          * Allocate memory for random pmap data structures.  Includes the
1103          * pv_head_table.
1104          */
1105
1106         for (i = 0; i < vm_page_array_size; i++) {
1107                 vm_page_t m;
1108
1109                 m = &vm_page_array[i];
1110                 TAILQ_INIT(&m->md.pv_list);
1111         }
1112
1113         /*
1114          * init the pv free list
1115          */
1116         initial_pvs = vm_page_array_size;
1117         if (initial_pvs < MINPV)
1118                 initial_pvs = MINPV;
1119         pvzone = &pvzone_store;
1120         pvinit = (void *)kmem_alloc(&kernel_map,
1121                                     initial_pvs * sizeof (struct pv_entry));
1122         zbootinit(pvzone, "PV ENTRY", sizeof (struct pv_entry),
1123                   pvinit, initial_pvs);
1124
1125         /*
1126          * Now it is safe to enable pv_table recording.
1127          */
1128         pmap_initialized = TRUE;
1129 }
1130
1131 /*
1132  * Initialize the address space (zone) for the pv_entries.  Set a
1133  * high water mark so that the system can recover from excessive
1134  * numbers of pv entries.
1135  */
1136 void
1137 pmap_init2(void)
1138 {
1139         int shpgperproc = PMAP_SHPGPERPROC;
1140         int entry_max;
1141
1142         TUNABLE_INT_FETCH("vm.pmap.shpgperproc", &shpgperproc);
1143         pv_entry_max = shpgperproc * maxproc + vm_page_array_size;
1144         TUNABLE_INT_FETCH("vm.pmap.pv_entries", &pv_entry_max);
1145         pv_entry_high_water = 9 * (pv_entry_max / 10);
1146
1147         /*
1148          * Subtract out pages already installed in the zone (hack)
1149          */
1150         entry_max = pv_entry_max - vm_page_array_size;
1151         if (entry_max <= 0)
1152                 entry_max = 1;
1153
1154         zinitna(pvzone, &pvzone_obj, NULL, 0, entry_max, ZONE_INTERRUPT, 1);
1155 }
1156
1157 /*
1158  * Typically used to initialize a fictitious page by vm/device_pager.c
1159  */
1160 void
1161 pmap_page_init(struct vm_page *m)
1162 {
1163         vm_page_init(m);
1164         TAILQ_INIT(&m->md.pv_list);
1165 }
1166
1167 /***************************************************
1168  * Low level helper routines.....
1169  ***************************************************/
1170
1171 /*
1172  * this routine defines the region(s) of memory that should
1173  * not be tested for the modified bit.
1174  */
1175 static __inline
1176 int
1177 pmap_track_modified(vm_pindex_t pindex)
1178 {
1179         vm_offset_t va = (vm_offset_t)pindex << PAGE_SHIFT;
1180         if ((va < clean_sva) || (va >= clean_eva))
1181                 return 1;
1182         else
1183                 return 0;
1184 }
1185
1186 /*
1187  * Extract the physical page address associated with the map/VA pair.
1188  * The page must be wired for this to work reliably.
1189  *
1190  * XXX for the moment we're using pv_find() instead of pv_get(), as
1191  *     callers might be expecting non-blocking operation.
1192  */
1193 vm_paddr_t
1194 pmap_extract(pmap_t pmap, vm_offset_t va)
1195 {
1196         vm_paddr_t rtval;
1197         pv_entry_t pt_pv;
1198         pt_entry_t *ptep;
1199
1200         rtval = 0;
1201         if (va >= VM_MAX_USER_ADDRESS) {
1202                 /*
1203                  * Kernel page directories might be direct-mapped and
1204                  * there is typically no PV tracking of pte's
1205                  */
1206                 pd_entry_t *pt;
1207
1208                 pt = pmap_pt(pmap, va);
1209                 if (pt && (*pt & pmap->pmap_bits[PG_V_IDX])) {
1210                         if (*pt & pmap->pmap_bits[PG_PS_IDX]) {
1211                                 rtval = *pt & PG_PS_FRAME;
1212                                 rtval |= va & PDRMASK;
1213                         } else {
1214                                 ptep = pmap_pt_to_pte(*pt, va);
1215                                 if (*pt & pmap->pmap_bits[PG_V_IDX]) {
1216                                         rtval = *ptep & PG_FRAME;
1217                                         rtval |= va & PAGE_MASK;
1218                                 }
1219                         }
1220                 }
1221         } else {
1222                 /*
1223                  * User pages currently do not direct-map the page directory
1224                  * and some pages might not used managed PVs.  But all PT's
1225                  * will have a PV.
1226                  */
1227                 pt_pv = pv_find(pmap, pmap_pt_pindex(va));
1228                 if (pt_pv) {
1229                         ptep = pv_pte_lookup(pt_pv, pmap_pte_index(va));
1230                         if (*ptep & pmap->pmap_bits[PG_V_IDX]) {
1231                                 rtval = *ptep & PG_FRAME;
1232                                 rtval |= va & PAGE_MASK;
1233                         }
1234                         pv_drop(pt_pv);
1235                 }
1236         }
1237         return rtval;
1238 }
1239
1240 /*
1241  * Similar to extract but checks protections, SMP-friendly short-cut for
1242  * vm_fault_page[_quick]().  Can return NULL to cause the caller to
1243  * fall-through to the real fault code.
1244  *
1245  * The returned page, if not NULL, is held (and not busied).
1246  */
1247 vm_page_t
1248 pmap_fault_page_quick(pmap_t pmap, vm_offset_t va, vm_prot_t prot)
1249 {
1250         if (pmap && va < VM_MAX_USER_ADDRESS) {
1251                 pv_entry_t pt_pv;
1252                 pv_entry_t pte_pv;
1253                 pt_entry_t *ptep;
1254                 pt_entry_t req;
1255                 vm_page_t m;
1256                 int error;
1257
1258                 req = pmap->pmap_bits[PG_V_IDX] |
1259                       pmap->pmap_bits[PG_U_IDX];
1260                 if (prot & VM_PROT_WRITE)
1261                         req |= pmap->pmap_bits[PG_RW_IDX];
1262
1263                 pt_pv = pv_find(pmap, pmap_pt_pindex(va));
1264                 if (pt_pv == NULL)
1265                         return (NULL);
1266                 ptep = pv_pte_lookup(pt_pv, pmap_pte_index(va));
1267                 if ((*ptep & req) != req) {
1268                         pv_drop(pt_pv);
1269                         return (NULL);
1270                 }
1271                 pte_pv = pv_get_try(pmap, pmap_pte_pindex(va), &error);
1272                 if (pte_pv && error == 0) {
1273                         m = pte_pv->pv_m;
1274                         vm_page_hold(m);
1275                         if (prot & VM_PROT_WRITE)
1276                                 vm_page_dirty(m);
1277                         pv_put(pte_pv);
1278                 } else if (pte_pv) {
1279                         pv_drop(pte_pv);
1280                         m = NULL;
1281                 } else {
1282                         m = NULL;
1283                 }
1284                 pv_drop(pt_pv);
1285                 return(m);
1286         } else {
1287                 return(NULL);
1288         }
1289 }
1290
1291 /*
1292  * Extract the physical page address associated kernel virtual address.
1293  */
1294 vm_paddr_t
1295 pmap_kextract(vm_offset_t va)
1296 {
1297         pd_entry_t pt;          /* pt entry in pd */
1298         vm_paddr_t pa;
1299
1300         if (va >= DMAP_MIN_ADDRESS && va < DMAP_MAX_ADDRESS) {
1301                 pa = DMAP_TO_PHYS(va);
1302         } else {
1303                 pt = *vtopt(va);
1304                 if (pt & kernel_pmap.pmap_bits[PG_PS_IDX]) {
1305                         pa = (pt & PG_PS_FRAME) | (va & PDRMASK);
1306                 } else {
1307                         /*
1308                          * Beware of a concurrent promotion that changes the
1309                          * PDE at this point!  For example, vtopte() must not
1310                          * be used to access the PTE because it would use the
1311                          * new PDE.  It is, however, safe to use the old PDE
1312                          * because the page table page is preserved by the
1313                          * promotion.
1314                          */
1315                         pa = *pmap_pt_to_pte(pt, va);
1316                         pa = (pa & PG_FRAME) | (va & PAGE_MASK);
1317                 }
1318         }
1319         return pa;
1320 }
1321
1322 /***************************************************
1323  * Low level mapping routines.....
1324  ***************************************************/
1325
1326 /*
1327  * Routine: pmap_kenter
1328  * Function:
1329  *      Add a wired page to the KVA
1330  *      NOTE! note that in order for the mapping to take effect -- you
1331  *      should do an invltlb after doing the pmap_kenter().
1332  */
1333 void
1334 pmap_kenter(vm_offset_t va, vm_paddr_t pa)
1335 {
1336         pt_entry_t *ptep;
1337         pt_entry_t npte;
1338
1339         npte = pa |
1340             kernel_pmap.pmap_bits[PG_RW_IDX] |
1341             kernel_pmap.pmap_bits[PG_V_IDX];
1342 //          pgeflag;
1343         ptep = vtopte(va);
1344 #if 1
1345         pmap_inval_smp(&kernel_pmap, va, 1, ptep, npte);
1346 #else
1347         /* FUTURE */
1348         if (*ptep)
1349                 pmap_inval_smp(&kernel_pmap, va, ptep, npte);
1350         else
1351                 *ptep = npte;
1352 #endif
1353 }
1354
1355 /*
1356  * Similar to pmap_kenter(), except we only invalidate the mapping on the
1357  * current CPU.  Returns 0 if the previous pte was 0, 1 if it wasn't
1358  * (caller can conditionalize calling smp_invltlb()).
1359  */
1360 int
1361 pmap_kenter_quick(vm_offset_t va, vm_paddr_t pa)
1362 {
1363         pt_entry_t *ptep;
1364         pt_entry_t npte;
1365         int res;
1366
1367         npte = pa |
1368             kernel_pmap.pmap_bits[PG_RW_IDX] |
1369             kernel_pmap.pmap_bits[PG_V_IDX];
1370 //          pgeflag;
1371         ptep = vtopte(va);
1372 #if 1
1373         res = 1;
1374 #else
1375         /* FUTURE */
1376         res = (*ptep != 0);
1377 #endif
1378         *ptep = npte;
1379         cpu_invlpg((void *)va);
1380
1381         return res;
1382 }
1383
1384 /*
1385  * Enter addresses into the kernel pmap but don't bother
1386  * doing any tlb invalidations.  Caller will do a rollup
1387  * invalidation via pmap_rollup_inval().
1388  */
1389 int
1390 pmap_kenter_noinval(vm_offset_t va, vm_paddr_t pa)
1391 {
1392         pt_entry_t *ptep;
1393         pt_entry_t npte;
1394         int res;
1395
1396         npte = pa |
1397             kernel_pmap.pmap_bits[PG_RW_IDX] |
1398             kernel_pmap.pmap_bits[PG_V_IDX];
1399 //          pgeflag;
1400         ptep = vtopte(va);
1401 #if 1
1402         res = 1;
1403 #else
1404         /* FUTURE */
1405         res = (*ptep != 0);
1406 #endif
1407         *ptep = npte;
1408         cpu_invlpg((void *)va);
1409
1410         return res;
1411 }
1412
1413 /*
1414  * remove a page from the kernel pagetables
1415  */
1416 void
1417 pmap_kremove(vm_offset_t va)
1418 {
1419         pt_entry_t *ptep;
1420
1421         ptep = vtopte(va);
1422         pmap_inval_smp(&kernel_pmap, va, 1, ptep, 0);
1423 }
1424
1425 void
1426 pmap_kremove_quick(vm_offset_t va)
1427 {
1428         pt_entry_t *ptep;
1429
1430         ptep = vtopte(va);
1431         (void)pte_load_clear(ptep);
1432         cpu_invlpg((void *)va);
1433 }
1434
1435 /*
1436  * Remove addresses from the kernel pmap but don't bother
1437  * doing any tlb invalidations.  Caller will do a rollup
1438  * invalidation via pmap_rollup_inval().
1439  */
1440 void
1441 pmap_kremove_noinval(vm_offset_t va)
1442 {
1443         pt_entry_t *ptep;
1444
1445         ptep = vtopte(va);
1446         (void)pte_load_clear(ptep);
1447 }
1448
1449 /*
1450  * XXX these need to be recoded.  They are not used in any critical path.
1451  */
1452 void
1453 pmap_kmodify_rw(vm_offset_t va)
1454 {
1455         atomic_set_long(vtopte(va), kernel_pmap.pmap_bits[PG_RW_IDX]);
1456         cpu_invlpg((void *)va);
1457 }
1458
1459 /* NOT USED
1460 void
1461 pmap_kmodify_nc(vm_offset_t va)
1462 {
1463         atomic_set_long(vtopte(va), PG_N);
1464         cpu_invlpg((void *)va);
1465 }
1466 */
1467
1468 /*
1469  * Used to map a range of physical addresses into kernel virtual
1470  * address space during the low level boot, typically to map the
1471  * dump bitmap, message buffer, and vm_page_array.
1472  *
1473  * These mappings are typically made at some pointer after the end of the
1474  * kernel text+data.
1475  *
1476  * We could return PHYS_TO_DMAP(start) here and not allocate any
1477  * via (*virtp), but then kmem from userland and kernel dumps won't
1478  * have access to the related pointers.
1479  */
1480 vm_offset_t
1481 pmap_map(vm_offset_t *virtp, vm_paddr_t start, vm_paddr_t end, int prot)
1482 {
1483         vm_offset_t va;
1484         vm_offset_t va_start;
1485
1486         /*return PHYS_TO_DMAP(start);*/
1487
1488         va_start = *virtp;
1489         va = va_start;
1490
1491         while (start < end) {
1492                 pmap_kenter_quick(va, start);
1493                 va += PAGE_SIZE;
1494                 start += PAGE_SIZE;
1495         }
1496         *virtp = va;
1497         return va_start;
1498 }
1499
1500 #define PMAP_CLFLUSH_THRESHOLD  (2 * 1024 * 1024)
1501
1502 /*
1503  * Remove the specified set of pages from the data and instruction caches.
1504  *
1505  * In contrast to pmap_invalidate_cache_range(), this function does not
1506  * rely on the CPU's self-snoop feature, because it is intended for use
1507  * when moving pages into a different cache domain.
1508  */
1509 void
1510 pmap_invalidate_cache_pages(vm_page_t *pages, int count)
1511 {
1512         vm_offset_t daddr, eva;
1513         int i;
1514
1515         if (count >= PMAP_CLFLUSH_THRESHOLD / PAGE_SIZE ||
1516             (cpu_feature & CPUID_CLFSH) == 0)
1517                 wbinvd();
1518         else {
1519                 cpu_mfence();
1520                 for (i = 0; i < count; i++) {
1521                         daddr = PHYS_TO_DMAP(VM_PAGE_TO_PHYS(pages[i]));
1522                         eva = daddr + PAGE_SIZE;
1523                         for (; daddr < eva; daddr += cpu_clflush_line_size)
1524                                 clflush(daddr);
1525                 }
1526                 cpu_mfence();
1527         }
1528 }
1529
1530 void
1531 pmap_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva)
1532 {
1533         KASSERT((sva & PAGE_MASK) == 0,
1534             ("pmap_invalidate_cache_range: sva not page-aligned"));
1535         KASSERT((eva & PAGE_MASK) == 0,
1536             ("pmap_invalidate_cache_range: eva not page-aligned"));
1537
1538         if (cpu_feature & CPUID_SS) {
1539                 ; /* If "Self Snoop" is supported, do nothing. */
1540         } else {
1541                 /* Globally invalidate caches */
1542                 cpu_wbinvd_on_all_cpus();
1543         }
1544 }
1545
1546 /*
1547  * Invalidate the specified range of virtual memory on all cpus associated
1548  * with the pmap.
1549  */
1550 void
1551 pmap_invalidate_range(pmap_t pmap, vm_offset_t sva, vm_offset_t eva)
1552 {
1553         pmap_inval_smp(pmap, sva, (eva - sva) >> PAGE_SHIFT, NULL, 0);
1554 }
1555
1556 /*
1557  * Add a list of wired pages to the kva
1558  * this routine is only used for temporary
1559  * kernel mappings that do not need to have
1560  * page modification or references recorded.
1561  * Note that old mappings are simply written
1562  * over.  The page *must* be wired.
1563  */
1564 void
1565 pmap_qenter(vm_offset_t beg_va, vm_page_t *m, int count)
1566 {
1567         vm_offset_t end_va;
1568         vm_offset_t va;
1569
1570         end_va = beg_va + count * PAGE_SIZE;
1571
1572         for (va = beg_va; va < end_va; va += PAGE_SIZE) {
1573                 pt_entry_t *pte;
1574
1575                 pte = vtopte(va);
1576                 *pte = VM_PAGE_TO_PHYS(*m) |
1577                     kernel_pmap.pmap_bits[PG_RW_IDX] |
1578                     kernel_pmap.pmap_bits[PG_V_IDX] |
1579                     kernel_pmap.pmap_cache_bits[(*m)->pat_mode];
1580 //              pgeflag;
1581                 m++;
1582         }
1583         pmap_invalidate_range(&kernel_pmap, beg_va, end_va);
1584 }
1585
1586 /*
1587  * This routine jerks page mappings from the
1588  * kernel -- it is meant only for temporary mappings.
1589  *
1590  * MPSAFE, INTERRUPT SAFE (cluster callback)
1591  */
1592 void
1593 pmap_qremove(vm_offset_t va, int count)
1594 {
1595         vm_offset_t end_va;
1596
1597         end_va = va + count * PAGE_SIZE;
1598
1599         while (va < end_va) {
1600                 pt_entry_t *pte;
1601
1602                 pte = vtopte(va);
1603                 (void)pte_load_clear(pte);
1604                 cpu_invlpg((void *)va);
1605                 va += PAGE_SIZE;
1606         }
1607         smp_invltlb();
1608 }
1609
1610 /*
1611  * Create a new thread and optionally associate it with a (new) process.
1612  * NOTE! the new thread's cpu may not equal the current cpu.
1613  */
1614 void
1615 pmap_init_thread(thread_t td)
1616 {
1617         /* enforce pcb placement & alignment */
1618         td->td_pcb = (struct pcb *)(td->td_kstack + td->td_kstack_size) - 1;
1619         td->td_pcb = (struct pcb *)((intptr_t)td->td_pcb & ~(intptr_t)0xF);
1620         td->td_savefpu = &td->td_pcb->pcb_save;
1621         td->td_sp = (char *)td->td_pcb; /* no -16 */
1622 }
1623
1624 /*
1625  * This routine directly affects the fork perf for a process.
1626  */
1627 void
1628 pmap_init_proc(struct proc *p)
1629 {
1630 }
1631
1632 static void
1633 pmap_pinit_defaults(struct pmap *pmap)
1634 {
1635         bcopy(pmap_bits_default, pmap->pmap_bits,
1636               sizeof(pmap_bits_default));
1637         bcopy(protection_codes, pmap->protection_codes,
1638               sizeof(protection_codes));
1639         bcopy(pat_pte_index, pmap->pmap_cache_bits,
1640               sizeof(pat_pte_index));
1641         pmap->pmap_cache_mask = X86_PG_NC_PWT | X86_PG_NC_PCD | X86_PG_PTE_PAT;
1642         pmap->copyinstr = std_copyinstr;
1643         pmap->copyin = std_copyin;
1644         pmap->copyout = std_copyout;
1645         pmap->fubyte = std_fubyte;
1646         pmap->subyte = std_subyte;
1647         pmap->fuword = std_fuword;
1648         pmap->suword = std_suword;
1649         pmap->suword32 = std_suword32;
1650 }
1651 /*
1652  * Initialize pmap0/vmspace0.  This pmap is not added to pmap_list because
1653  * it, and IdlePTD, represents the template used to update all other pmaps.
1654  *
1655  * On architectures where the kernel pmap is not integrated into the user
1656  * process pmap, this pmap represents the process pmap, not the kernel pmap.
1657  * kernel_pmap should be used to directly access the kernel_pmap.
1658  */
1659 void
1660 pmap_pinit0(struct pmap *pmap)
1661 {
1662         pmap->pm_pml4 = (pml4_entry_t *)(PTOV_OFFSET + KPML4phys);
1663         pmap->pm_count = 1;
1664         CPUMASK_ASSZERO(pmap->pm_active);
1665         pmap->pm_pvhint = NULL;
1666         RB_INIT(&pmap->pm_pvroot);
1667         spin_init(&pmap->pm_spin, "pmapinit0");
1668         lwkt_token_init(&pmap->pm_token, "pmap_tok");
1669         bzero(&pmap->pm_stats, sizeof pmap->pm_stats);
1670         pmap_pinit_defaults(pmap);
1671 }
1672
1673 /*
1674  * Initialize a preallocated and zeroed pmap structure,
1675  * such as one in a vmspace structure.
1676  */
1677 static void
1678 pmap_pinit_simple(struct pmap *pmap)
1679 {
1680         /*
1681          * Misc initialization
1682          */
1683         pmap->pm_count = 1;
1684         CPUMASK_ASSZERO(pmap->pm_active);
1685         pmap->pm_pvhint = NULL;
1686         pmap->pm_flags = PMAP_FLAG_SIMPLE;
1687
1688         pmap_pinit_defaults(pmap);
1689
1690         /*
1691          * Don't blow up locks/tokens on re-use (XXX fix/use drop code
1692          * for this).
1693          */
1694         if (pmap->pm_pmlpv == NULL) {
1695                 RB_INIT(&pmap->pm_pvroot);
1696                 bzero(&pmap->pm_stats, sizeof pmap->pm_stats);
1697                 spin_init(&pmap->pm_spin, "pmapinitsimple");
1698                 lwkt_token_init(&pmap->pm_token, "pmap_tok");
1699         }
1700 }
1701
1702 void
1703 pmap_pinit(struct pmap *pmap)
1704 {
1705         pv_entry_t pv;
1706         int j;
1707
1708         if (pmap->pm_pmlpv) {
1709                 if (pmap->pmap_bits[TYPE_IDX] != REGULAR_PMAP) {
1710                         pmap_puninit(pmap);
1711                 }
1712         }
1713
1714         pmap_pinit_simple(pmap);
1715         pmap->pm_flags &= ~PMAP_FLAG_SIMPLE;
1716
1717         /*
1718          * No need to allocate page table space yet but we do need a valid
1719          * page directory table.
1720          */
1721         if (pmap->pm_pml4 == NULL) {
1722                 pmap->pm_pml4 =
1723                     (pml4_entry_t *)kmem_alloc_pageable(&kernel_map, PAGE_SIZE);
1724         }
1725
1726         /*
1727          * Allocate the page directory page, which wires it even though
1728          * it isn't being entered into some higher level page table (it
1729          * being the highest level).  If one is already cached we don't
1730          * have to do anything.
1731          */
1732         if ((pv = pmap->pm_pmlpv) == NULL) {
1733                 pv = pmap_allocpte(pmap, pmap_pml4_pindex(), NULL);
1734                 pmap->pm_pmlpv = pv;
1735                 pmap_kenter((vm_offset_t)pmap->pm_pml4,
1736                             VM_PAGE_TO_PHYS(pv->pv_m));
1737                 pv_put(pv);
1738
1739                 /*
1740                  * Install DMAP and KMAP.
1741                  */
1742                 for (j = 0; j < NDMPML4E; ++j) {
1743                         pmap->pm_pml4[DMPML4I + j] =
1744                             (DMPDPphys + ((vm_paddr_t)j << PML4SHIFT)) |
1745                             pmap->pmap_bits[PG_RW_IDX] |
1746                             pmap->pmap_bits[PG_V_IDX] |
1747                             pmap->pmap_bits[PG_U_IDX];
1748                 }
1749                 pmap->pm_pml4[KPML4I] = KPDPphys |
1750                     pmap->pmap_bits[PG_RW_IDX] |
1751                     pmap->pmap_bits[PG_V_IDX] |
1752                     pmap->pmap_bits[PG_U_IDX];
1753
1754                 /*
1755                  * install self-referential address mapping entry
1756                  */
1757                 pmap->pm_pml4[PML4PML4I] = VM_PAGE_TO_PHYS(pv->pv_m) |
1758                     pmap->pmap_bits[PG_V_IDX] |
1759                     pmap->pmap_bits[PG_RW_IDX] |
1760                     pmap->pmap_bits[PG_A_IDX] |
1761                     pmap->pmap_bits[PG_M_IDX];
1762         } else {
1763                 KKASSERT(pv->pv_m->flags & PG_MAPPED);
1764                 KKASSERT(pv->pv_m->flags & PG_WRITEABLE);
1765         }
1766         KKASSERT(pmap->pm_pml4[255] == 0);
1767         KKASSERT(RB_ROOT(&pmap->pm_pvroot) == pv);
1768         KKASSERT(pv->pv_entry.rbe_left == NULL);
1769         KKASSERT(pv->pv_entry.rbe_right == NULL);
1770 }
1771
1772 /*
1773  * Clean up a pmap structure so it can be physically freed.  This routine
1774  * is called by the vmspace dtor function.  A great deal of pmap data is
1775  * left passively mapped to improve vmspace management so we have a bit
1776  * of cleanup work to do here.
1777  */
1778 void
1779 pmap_puninit(pmap_t pmap)
1780 {
1781         pv_entry_t pv;
1782         vm_page_t p;
1783
1784         KKASSERT(CPUMASK_TESTZERO(pmap->pm_active));
1785         if ((pv = pmap->pm_pmlpv) != NULL) {
1786                 if (pv_hold_try(pv) == 0)
1787                         pv_lock(pv);
1788                 KKASSERT(pv == pmap->pm_pmlpv);
1789                 p = pmap_remove_pv_page(pv);
1790                 pv_free(pv);
1791                 pmap_kremove((vm_offset_t)pmap->pm_pml4);
1792                 vm_page_busy_wait(p, FALSE, "pgpun");
1793                 KKASSERT(p->flags & (PG_FICTITIOUS|PG_UNMANAGED));
1794                 vm_page_unwire(p, 0);
1795                 vm_page_flag_clear(p, PG_MAPPED | PG_WRITEABLE);
1796
1797                 /*
1798                  * XXX eventually clean out PML4 static entries and
1799                  * use vm_page_free_zero()
1800                  */
1801                 vm_page_free(p);
1802                 pmap->pm_pmlpv = NULL;
1803         }
1804         if (pmap->pm_pml4) {
1805                 KKASSERT(pmap->pm_pml4 != (void *)(PTOV_OFFSET + KPML4phys));
1806                 kmem_free(&kernel_map, (vm_offset_t)pmap->pm_pml4, PAGE_SIZE);
1807                 pmap->pm_pml4 = NULL;
1808         }
1809         KKASSERT(pmap->pm_stats.resident_count == 0);
1810         KKASSERT(pmap->pm_stats.wired_count == 0);
1811 }
1812
1813 /*
1814  * Wire in kernel global address entries.  To avoid a race condition
1815  * between pmap initialization and pmap_growkernel, this procedure
1816  * adds the pmap to the master list (which growkernel scans to update),
1817  * then copies the template.
1818  */
1819 void
1820 pmap_pinit2(struct pmap *pmap)
1821 {
1822         spin_lock(&pmap_spin);
1823         TAILQ_INSERT_TAIL(&pmap_list, pmap, pm_pmnode);
1824         spin_unlock(&pmap_spin);
1825 }
1826
1827 /*
1828  * This routine is called when various levels in the page table need to
1829  * be populated.  This routine cannot fail.
1830  *
1831  * This function returns two locked pv_entry's, one representing the
1832  * requested pv and one representing the requested pv's parent pv.  If
1833  * the pv did not previously exist it will be mapped into its parent
1834  * and wired, otherwise no additional wire count will be added.
1835  */
1836 static
1837 pv_entry_t
1838 pmap_allocpte(pmap_t pmap, vm_pindex_t ptepindex, pv_entry_t *pvpp)
1839 {
1840         pt_entry_t *ptep;
1841         pv_entry_t pv;
1842         pv_entry_t pvp;
1843         vm_pindex_t pt_pindex;
1844         vm_page_t m;
1845         int isnew;
1846         int ispt;
1847
1848         /*
1849          * If the pv already exists and we aren't being asked for the
1850          * parent page table page we can just return it.  A locked+held pv
1851          * is returned.  The pv will also have a second hold related to the
1852          * pmap association that we don't have to worry about.
1853          */
1854         ispt = 0;
1855         pv = pv_alloc(pmap, ptepindex, &isnew);
1856         if (isnew == 0 && pvpp == NULL)
1857                 return(pv);
1858
1859         /*
1860          * Special case terminal PVs.  These are not page table pages so
1861          * no vm_page is allocated (the caller supplied the vm_page).  If
1862          * pvpp is non-NULL we are being asked to also removed the pt_pv
1863          * for this pv.
1864          *
1865          * Note that pt_pv's are only returned for user VAs. We assert that
1866          * a pt_pv is not being requested for kernel VAs.
1867          */
1868         if (ptepindex < pmap_pt_pindex(0)) {
1869                 if (ptepindex >= NUPTE_USER)
1870                         KKASSERT(pvpp == NULL);
1871                 else
1872                         KKASSERT(pvpp != NULL);
1873                 if (pvpp) {
1874                         pt_pindex = NUPTE_TOTAL + (ptepindex >> NPTEPGSHIFT);
1875                         pvp = pmap_allocpte(pmap, pt_pindex, NULL);
1876                         if (isnew)
1877                                 vm_page_wire_quick(pvp->pv_m);
1878                         *pvpp = pvp;
1879                 } else {
1880                         pvp = NULL;
1881                 }
1882                 return(pv);
1883         }
1884
1885         /*
1886          * Non-terminal PVs allocate a VM page to represent the page table,
1887          * so we have to resolve pvp and calculate ptepindex for the pvp
1888          * and then for the page table entry index in the pvp for
1889          * fall-through.
1890          */
1891         if (ptepindex < pmap_pd_pindex(0)) {
1892                 /*
1893                  * pv is PT, pvp is PD
1894                  */
1895                 ptepindex = (ptepindex - pmap_pt_pindex(0)) >> NPDEPGSHIFT;
1896                 ptepindex += NUPTE_TOTAL + NUPT_TOTAL;
1897                 pvp = pmap_allocpte(pmap, ptepindex, NULL);
1898                 if (!isnew)
1899                         goto notnew;
1900
1901                 /*
1902                  * PT index in PD
1903                  */
1904                 ptepindex = pv->pv_pindex - pmap_pt_pindex(0);
1905                 ptepindex &= ((1ul << NPDEPGSHIFT) - 1);
1906                 ispt = 1;
1907         } else if (ptepindex < pmap_pdp_pindex(0)) {
1908                 /*
1909                  * pv is PD, pvp is PDP
1910                  *
1911                  * SIMPLE PMAP NOTE: Simple pmaps do not allocate above
1912                  *                   the PD.
1913                  */
1914                 ptepindex = (ptepindex - pmap_pd_pindex(0)) >> NPDPEPGSHIFT;
1915                 ptepindex += NUPTE_TOTAL + NUPT_TOTAL + NUPD_TOTAL;
1916
1917                 if (pmap->pm_flags & PMAP_FLAG_SIMPLE) {
1918                         KKASSERT(pvpp == NULL);
1919                         pvp = NULL;
1920                 } else {
1921                         pvp = pmap_allocpte(pmap, ptepindex, NULL);
1922                 }
1923                 if (!isnew)
1924                         goto notnew;
1925
1926                 /*
1927                  * PD index in PDP
1928                  */
1929                 ptepindex = pv->pv_pindex - pmap_pd_pindex(0);
1930                 ptepindex &= ((1ul << NPDPEPGSHIFT) - 1);
1931         } else if (ptepindex < pmap_pml4_pindex()) {
1932                 /*
1933                  * pv is PDP, pvp is the root pml4 table
1934                  */
1935                 pvp = pmap_allocpte(pmap, pmap_pml4_pindex(), NULL);
1936                 if (!isnew)
1937                         goto notnew;
1938
1939                 /*
1940                  * PDP index in PML4
1941                  */
1942                 ptepindex = pv->pv_pindex - pmap_pdp_pindex(0);
1943                 ptepindex &= ((1ul << NPML4EPGSHIFT) - 1);
1944         } else {
1945                 /*
1946                  * pv represents the top-level PML4, there is no parent.
1947                  */
1948                 pvp = NULL;
1949                 if (!isnew)
1950                         goto notnew;
1951         }
1952
1953         /*
1954          * This code is only reached if isnew is TRUE and this is not a
1955          * terminal PV.  We need to allocate a vm_page for the page table
1956          * at this level and enter it into the parent page table.
1957          *
1958          * page table pages are marked PG_WRITEABLE and PG_MAPPED.
1959          */
1960         for (;;) {
1961                 m = vm_page_alloc(NULL, pv->pv_pindex,
1962                                   VM_ALLOC_NORMAL | VM_ALLOC_SYSTEM |
1963                                   VM_ALLOC_INTERRUPT);
1964                 if (m)
1965                         break;
1966                 vm_wait(0);
1967         }
1968         vm_page_spin_lock(m);
1969         pmap_page_stats_adding(m);
1970         TAILQ_INSERT_TAIL(&m->md.pv_list, pv, pv_list);
1971         pv->pv_m = m;
1972         vm_page_flag_set(m, PG_MAPPED | PG_WRITEABLE);
1973         vm_page_spin_unlock(m);
1974         vm_page_unmanage(m);    /* m must be spinunlocked */
1975
1976         if ((m->flags & PG_ZERO) == 0) {
1977                 pmap_zero_page(VM_PAGE_TO_PHYS(m));
1978         }
1979 #ifdef PMAP_DEBUG
1980         else {
1981                 pmap_page_assertzero(VM_PAGE_TO_PHYS(m));
1982         }
1983 #endif
1984         m->valid = VM_PAGE_BITS_ALL;
1985         vm_page_flag_clear(m, PG_ZERO);
1986         vm_page_wire(m);        /* wire for mapping in parent */
1987
1988         /*
1989          * Wire the page into pvp, bump the wire-count for pvp's page table
1990          * page.  Bump the resident_count for the pmap.  There is no pvp
1991          * for the top level, address the pm_pml4[] array directly.
1992          *
1993          * If the caller wants the parent we return it, otherwise
1994          * we just put it away.
1995          *
1996          * No interlock is needed for pte 0 -> non-zero.
1997          *
1998          * In the situation where *ptep is valid we might have an unmanaged
1999          * page table page shared from another page table which we need to
2000          * unshare before installing our private page table page.
2001          */
2002         if (pvp) {
2003                 ptep = pv_pte_lookup(pvp, ptepindex);
2004                 if (*ptep & pmap->pmap_bits[PG_V_IDX]) {
2005                         pt_entry_t pte;
2006
2007                         if (ispt == 0) {
2008                                 panic("pmap_allocpte: unexpected pte %p/%d",
2009                                       pvp, (int)ptepindex);
2010                         }
2011                         pte = pmap_inval_smp(pmap, (vm_offset_t)-1, 1, ptep, 0);
2012                         if (vm_page_unwire_quick(
2013                                         PHYS_TO_VM_PAGE(pte & PG_FRAME))) {
2014                                 panic("pmap_allocpte: shared pgtable "
2015                                       "pg bad wirecount");
2016                         }
2017                         atomic_add_long(&pmap->pm_stats.resident_count, -1);
2018                 } else {
2019                         vm_page_wire_quick(pvp->pv_m);
2020                 }
2021                 *ptep = VM_PAGE_TO_PHYS(m) |
2022                     (pmap->pmap_bits[PG_U_IDX] |
2023                     pmap->pmap_bits[PG_RW_IDX] |
2024                     pmap->pmap_bits[PG_V_IDX] |
2025                     pmap->pmap_bits[PG_A_IDX] |
2026                     pmap->pmap_bits[PG_M_IDX]);
2027         }
2028         vm_page_wakeup(m);
2029 notnew:
2030         if (pvpp)
2031                 *pvpp = pvp;
2032         else if (pvp)
2033                 pv_put(pvp);
2034         return (pv);
2035 }
2036
2037 /*
2038  * This version of pmap_allocpte() checks for possible segment optimizations
2039  * that would allow page-table sharing.  It can be called for terminal
2040  * page or page table page ptepindex's.
2041  *
2042  * The function is called with page table page ptepindex's for fictitious
2043  * and unmanaged terminal pages.  That is, we don't want to allocate a
2044  * terminal pv, we just want the pt_pv.  pvpp is usually passed as NULL
2045  * for this case.
2046  *
2047  * This function can return a pv and *pvpp associated with the passed in pmap
2048  * OR a pv and *pvpp associated with the shared pmap.  In the latter case
2049  * an unmanaged page table page will be entered into the pass in pmap.
2050  */
2051 static
2052 pv_entry_t
2053 pmap_allocpte_seg(pmap_t pmap, vm_pindex_t ptepindex, pv_entry_t *pvpp,
2054                   vm_map_entry_t entry, vm_offset_t va)
2055 {
2056         vm_object_t object;
2057         pmap_t obpmap;
2058         pmap_t *obpmapp;
2059         vm_offset_t b;
2060         pv_entry_t pte_pv;      /* in original or shared pmap */
2061         pv_entry_t pt_pv;       /* in original or shared pmap */
2062         pv_entry_t proc_pd_pv;  /* in original pmap */
2063         pv_entry_t proc_pt_pv;  /* in original pmap */
2064         pv_entry_t xpv;         /* PT in shared pmap */
2065         pd_entry_t *pt;         /* PT entry in PD of original pmap */
2066         pd_entry_t opte;        /* contents of *pt */
2067         pd_entry_t npte;        /* contents of *pt */
2068         vm_page_t m;
2069
2070 retry:
2071         /*
2072          * Basic tests, require a non-NULL vm_map_entry, require proper
2073          * alignment and type for the vm_map_entry, require that the
2074          * underlying object already be allocated.
2075          *
2076          * We allow almost any type of object to use this optimization.
2077          * The object itself does NOT have to be sized to a multiple of the
2078          * segment size, but the memory mapping does.
2079          *
2080          * XXX don't handle devices currently, because VM_PAGE_TO_PHYS()
2081          *     won't work as expected.
2082          */
2083         if (entry == NULL ||
2084             pmap_mmu_optimize == 0 ||                   /* not enabled */
2085             ptepindex >= pmap_pd_pindex(0) ||           /* not terminal or pt */
2086             entry->inheritance != VM_INHERIT_SHARE ||   /* not shared */
2087             entry->maptype != VM_MAPTYPE_NORMAL ||      /* weird map type */
2088             entry->object.vm_object == NULL ||          /* needs VM object */
2089             entry->object.vm_object->type == OBJT_DEVICE ||     /* ick */
2090             entry->object.vm_object->type == OBJT_MGTDEVICE ||  /* ick */
2091             (entry->offset & SEG_MASK) ||               /* must be aligned */
2092             (entry->start & SEG_MASK)) {
2093                 return(pmap_allocpte(pmap, ptepindex, pvpp));
2094         }
2095
2096         /*
2097          * Make sure the full segment can be represented.
2098          */
2099         b = va & ~(vm_offset_t)SEG_MASK;
2100         if (b < entry->start || b + SEG_SIZE > entry->end)
2101                 return(pmap_allocpte(pmap, ptepindex, pvpp));
2102
2103         /*
2104          * If the full segment can be represented dive the VM object's
2105          * shared pmap, allocating as required.
2106          */
2107         object = entry->object.vm_object;
2108
2109         if (entry->protection & VM_PROT_WRITE)
2110                 obpmapp = &object->md.pmap_rw;
2111         else
2112                 obpmapp = &object->md.pmap_ro;
2113
2114 #ifdef PMAP_DEBUG2
2115         if (pmap_enter_debug > 0) {
2116                 --pmap_enter_debug;
2117                 kprintf("pmap_allocpte_seg: va=%jx prot %08x o=%p "
2118                         "obpmapp %p %p\n",
2119                         va, entry->protection, object,
2120                         obpmapp, *obpmapp);
2121                 kprintf("pmap_allocpte_seg: entry %p %jx-%jx\n",
2122                         entry, entry->start, entry->end);
2123         }
2124 #endif
2125
2126         /*
2127          * We allocate what appears to be a normal pmap but because portions
2128          * of this pmap are shared with other unrelated pmaps we have to
2129          * set pm_active to point to all cpus.
2130          *
2131          * XXX Currently using pmap_spin to interlock the update, can't use
2132          *     vm_object_hold/drop because the token might already be held
2133          *     shared OR exclusive and we don't know.
2134          */
2135         while ((obpmap = *obpmapp) == NULL) {
2136                 obpmap = kmalloc(sizeof(*obpmap), M_OBJPMAP, M_WAITOK|M_ZERO);
2137                 pmap_pinit_simple(obpmap);
2138                 pmap_pinit2(obpmap);
2139                 spin_lock(&pmap_spin);
2140                 if (*obpmapp != NULL) {
2141                         /*
2142                          * Handle race
2143                          */
2144                         spin_unlock(&pmap_spin);
2145                         pmap_release(obpmap);
2146                         pmap_puninit(obpmap);
2147                         kfree(obpmap, M_OBJPMAP);
2148                         obpmap = *obpmapp; /* safety */
2149                 } else {
2150                         obpmap->pm_active = smp_active_mask;
2151                         *obpmapp = obpmap;
2152                         spin_unlock(&pmap_spin);
2153                 }
2154         }
2155
2156         /*
2157          * Layering is: PTE, PT, PD, PDP, PML4.  We have to return the
2158          * pte/pt using the shared pmap from the object but also adjust
2159          * the process pmap's page table page as a side effect.
2160          */
2161
2162         /*
2163          * Resolve the terminal PTE and PT in the shared pmap.  This is what
2164          * we will return.  This is true if ptepindex represents a terminal
2165          * page, otherwise pte_pv is actually the PT and pt_pv is actually
2166          * the PD.
2167          */
2168         pt_pv = NULL;
2169         pte_pv = pmap_allocpte(obpmap, ptepindex, &pt_pv);
2170         if (ptepindex >= pmap_pt_pindex(0))
2171                 xpv = pte_pv;
2172         else
2173                 xpv = pt_pv;
2174
2175         /*
2176          * Resolve the PD in the process pmap so we can properly share the
2177          * page table page.  Lock order is bottom-up (leaf first)!
2178          *
2179          * NOTE: proc_pt_pv can be NULL.
2180          */
2181         proc_pt_pv = pv_get(pmap, pmap_pt_pindex(b));
2182         proc_pd_pv = pmap_allocpte(pmap, pmap_pd_pindex(b), NULL);
2183 #ifdef PMAP_DEBUG2
2184         if (pmap_enter_debug > 0) {
2185                 --pmap_enter_debug;
2186                 kprintf("proc_pt_pv %p (wc %d) pd_pv %p va=%jx\n",
2187                         proc_pt_pv,
2188                         (proc_pt_pv ? proc_pt_pv->pv_m->wire_count : -1),
2189                         proc_pd_pv,
2190                         va);
2191         }
2192 #endif
2193
2194         /*
2195          * xpv is the page table page pv from the shared object
2196          * (for convenience), from above.
2197          *
2198          * Calculate the pte value for the PT to load into the process PD.
2199          * If we have to change it we must properly dispose of the previous
2200          * entry.
2201          */
2202         pt = pv_pte_lookup(proc_pd_pv, pmap_pt_index(b));
2203         npte = VM_PAGE_TO_PHYS(xpv->pv_m) |
2204             (pmap->pmap_bits[PG_U_IDX] |
2205             pmap->pmap_bits[PG_RW_IDX] |
2206             pmap->pmap_bits[PG_V_IDX] |
2207             pmap->pmap_bits[PG_A_IDX] |
2208             pmap->pmap_bits[PG_M_IDX]);
2209
2210         /*
2211          * Dispose of previous page table page if it was local to the
2212          * process pmap.  If the old pt is not empty we cannot dispose of it
2213          * until we clean it out.  This case should not arise very often so
2214          * it is not optimized.
2215          */
2216         if (proc_pt_pv) {
2217                 pmap_inval_bulk_t bulk;
2218
2219                 if (proc_pt_pv->pv_m->wire_count != 1) {
2220                         pv_put(proc_pd_pv);
2221                         pv_put(proc_pt_pv);
2222                         pv_put(pt_pv);
2223                         pv_put(pte_pv);
2224                         pmap_remove(pmap,
2225                                     va & ~(vm_offset_t)SEG_MASK,
2226                                     (va + SEG_SIZE) & ~(vm_offset_t)SEG_MASK);
2227                         goto retry;
2228                 }
2229
2230                 /*
2231                  * The release call will indirectly clean out *pt
2232                  */
2233                 pmap_inval_bulk_init(&bulk, proc_pt_pv->pv_pmap);
2234                 pmap_release_pv(proc_pt_pv, proc_pd_pv, &bulk);
2235                 pmap_inval_bulk_flush(&bulk);
2236                 proc_pt_pv = NULL;
2237                 /* relookup */
2238                 pt = pv_pte_lookup(proc_pd_pv, pmap_pt_index(b));
2239         }
2240
2241         /*
2242          * Handle remaining cases.
2243          */
2244         if (*pt == 0) {
2245                 *pt = npte;
2246                 vm_page_wire_quick(xpv->pv_m);
2247                 vm_page_wire_quick(proc_pd_pv->pv_m);
2248                 atomic_add_long(&pmap->pm_stats.resident_count, 1);
2249         } else if (*pt != npte) {
2250                 opte = pmap_inval_smp(pmap, (vm_offset_t)-1, 1, pt, npte);
2251
2252 #if 0
2253                 opte = pte_load_clear(pt);
2254                 KKASSERT(opte && opte != npte);
2255
2256                 *pt = npte;
2257 #endif
2258                 vm_page_wire_quick(xpv->pv_m);  /* pgtable pg that is npte */
2259
2260                 /*
2261                  * Clean up opte, bump the wire_count for the process
2262                  * PD page representing the new entry if it was
2263                  * previously empty.
2264                  *
2265                  * If the entry was not previously empty and we have
2266                  * a PT in the proc pmap then opte must match that
2267                  * pt.  The proc pt must be retired (this is done
2268                  * later on in this procedure).
2269                  *
2270                  * NOTE: replacing valid pte, wire_count on proc_pd_pv
2271                  * stays the same.
2272                  */
2273                 KKASSERT(opte & pmap->pmap_bits[PG_V_IDX]);
2274                 m = PHYS_TO_VM_PAGE(opte & PG_FRAME);
2275                 if (vm_page_unwire_quick(m)) {
2276                         panic("pmap_allocpte_seg: "
2277                               "bad wire count %p",
2278                               m);
2279                 }
2280         }
2281
2282         /*
2283          * The existing process page table was replaced and must be destroyed
2284          * here.
2285          */
2286         if (proc_pd_pv)
2287                 pv_put(proc_pd_pv);
2288         if (pvpp)
2289                 *pvpp = pt_pv;
2290         else
2291                 pv_put(pt_pv);
2292
2293         return (pte_pv);
2294 }
2295
2296 /*
2297  * Release any resources held by the given physical map.
2298  *
2299  * Called when a pmap initialized by pmap_pinit is being released.  Should
2300  * only be called if the map contains no valid mappings.
2301  *
2302  * Caller must hold pmap->pm_token
2303  */
2304 struct pmap_release_info {
2305         pmap_t  pmap;
2306         int     retry;
2307 };
2308
2309 static int pmap_release_callback(pv_entry_t pv, void *data);
2310
2311 void
2312 pmap_release(struct pmap *pmap)
2313 {
2314         struct pmap_release_info info;
2315
2316         KASSERT(CPUMASK_TESTZERO(pmap->pm_active),
2317                 ("pmap still active! %016jx",
2318                 (uintmax_t)CPUMASK_LOWMASK(pmap->pm_active)));
2319
2320         spin_lock(&pmap_spin);
2321         TAILQ_REMOVE(&pmap_list, pmap, pm_pmnode);
2322         spin_unlock(&pmap_spin);
2323
2324         /*
2325          * Pull pv's off the RB tree in order from low to high and release
2326          * each page.
2327          */
2328         info.pmap = pmap;
2329         do {
2330                 info.retry = 0;
2331                 spin_lock(&pmap->pm_spin);
2332                 RB_SCAN(pv_entry_rb_tree, &pmap->pm_pvroot, NULL,
2333                         pmap_release_callback, &info);
2334                 spin_unlock(&pmap->pm_spin);
2335         } while (info.retry);
2336
2337
2338         /*
2339          * One resident page (the pml4 page) should remain.
2340          * No wired pages should remain.
2341          */
2342         KKASSERT(pmap->pm_stats.resident_count ==
2343                  ((pmap->pm_flags & PMAP_FLAG_SIMPLE) ? 0 : 1));
2344
2345         KKASSERT(pmap->pm_stats.wired_count == 0);
2346 }
2347
2348 static int
2349 pmap_release_callback(pv_entry_t pv, void *data)
2350 {
2351         struct pmap_release_info *info = data;
2352         pmap_t pmap = info->pmap;
2353         int r;
2354
2355         if (pv_hold_try(pv)) {
2356                 spin_unlock(&pmap->pm_spin);
2357         } else {
2358                 spin_unlock(&pmap->pm_spin);
2359                 pv_lock(pv);
2360         }
2361         if (pv->pv_pmap != pmap) {
2362                 pv_put(pv);
2363                 spin_lock(&pmap->pm_spin);
2364                 info->retry = 1;
2365                 return(-1);
2366         }
2367         r = pmap_release_pv(pv, NULL, NULL);
2368         spin_lock(&pmap->pm_spin);
2369         return(r);
2370 }
2371
2372 /*
2373  * Called with held (i.e. also locked) pv.  This function will dispose of
2374  * the lock along with the pv.
2375  *
2376  * If the caller already holds the locked parent page table for pv it
2377  * must pass it as pvp, allowing us to avoid a deadlock, else it can
2378  * pass NULL for pvp.
2379  */
2380 static int
2381 pmap_release_pv(pv_entry_t pv, pv_entry_t pvp, pmap_inval_bulk_t *bulk)
2382 {
2383         vm_page_t p;
2384
2385         /*
2386          * The pmap is currently not spinlocked, pv is held+locked.
2387          * Remove the pv's page from its parent's page table.  The
2388          * parent's page table page's wire_count will be decremented.
2389          *
2390          * This will clean out the pte at any level of the page table.
2391          * If smp != 0 all cpus are affected.
2392          */
2393         pmap_remove_pv_pte(pv, pvp, bulk);
2394
2395         /*
2396          * Terminal pvs are unhooked from their vm_pages.  Because
2397          * terminal pages aren't page table pages they aren't wired
2398          * by us, so we have to be sure not to unwire them either.
2399          */
2400         if (pv->pv_pindex < pmap_pt_pindex(0)) {
2401                 pmap_remove_pv_page(pv);
2402                 goto skip;
2403         }
2404
2405         /*
2406          * We leave the top-level page table page cached, wired, and
2407          * mapped in the pmap until the dtor function (pmap_puninit())
2408          * gets called.
2409          *
2410          * Since we are leaving the top-level pv intact we need
2411          * to break out of what would otherwise be an infinite loop.
2412          */
2413         if (pv->pv_pindex == pmap_pml4_pindex()) {
2414                 pv_put(pv);
2415                 return(-1);
2416         }
2417
2418         /*
2419          * For page table pages (other than the top-level page),
2420          * remove and free the vm_page.  The representitive mapping
2421          * removed above by pmap_remove_pv_pte() did not undo the
2422          * last wire_count so we have to do that as well.
2423          */
2424         p = pmap_remove_pv_page(pv);
2425         vm_page_busy_wait(p, FALSE, "pmaprl");
2426         if (p->wire_count != 1) {
2427                 kprintf("p->wire_count was %016lx %d\n",
2428                         pv->pv_pindex, p->wire_count);
2429         }
2430         KKASSERT(p->wire_count == 1);
2431         KKASSERT(p->flags & PG_UNMANAGED);
2432
2433         vm_page_unwire(p, 0);
2434         KKASSERT(p->wire_count == 0);
2435
2436         /*
2437          * Theoretically this page, if not the pml4 page, should contain
2438          * all-zeros.  But its just too dangerous to mark it PG_ZERO.  Free
2439          * normally.
2440          */
2441         vm_page_free(p);
2442 skip:
2443         pv_free(pv);
2444         return 0;
2445 }
2446
2447 /*
2448  * This function will remove the pte associated with a pv from its parent.
2449  * Terminal pv's are supported.  All cpus are affected if smp != 0.
2450  *
2451  * The wire count will be dropped on the parent page table.  The wire
2452  * count on the page being removed (pv->pv_m) from the parent page table
2453  * is NOT touched.  Note that terminal pages will not have any additional
2454  * wire counts while page table pages will have at least one representing
2455  * the mapping, plus others representing sub-mappings.
2456  *
2457  * NOTE: Cannot be called on kernel page table pages, only KVM terminal
2458  *       pages and user page table and terminal pages.
2459  *
2460  * The pv must be locked.
2461  *
2462  * XXX must lock parent pv's if they exist to remove pte XXX
2463  */
2464 static
2465 void
2466 pmap_remove_pv_pte(pv_entry_t pv, pv_entry_t pvp, pmap_inval_bulk_t *bulk)
2467 {
2468         vm_pindex_t ptepindex = pv->pv_pindex;
2469         pmap_t pmap = pv->pv_pmap;
2470         vm_page_t p;
2471         int gotpvp = 0;
2472
2473         KKASSERT(pmap);
2474
2475         if (ptepindex == pmap_pml4_pindex()) {
2476                 /*
2477                  * We are the top level pml4 table, there is no parent.
2478                  */
2479                 p = pmap->pm_pmlpv->pv_m;
2480         } else if (ptepindex >= pmap_pdp_pindex(0)) {
2481                 /*
2482                  * Remove a PDP page from the pml4e.  This can only occur
2483                  * with user page tables.  We do not have to lock the
2484                  * pml4 PV so just ignore pvp.
2485                  */
2486                 vm_pindex_t pml4_pindex;
2487                 vm_pindex_t pdp_index;
2488                 pml4_entry_t *pdp;
2489
2490                 pdp_index = ptepindex - pmap_pdp_pindex(0);
2491                 if (pvp == NULL) {
2492                         pml4_pindex = pmap_pml4_pindex();
2493                         pvp = pv_get(pv->pv_pmap, pml4_pindex);
2494                         KKASSERT(pvp);
2495                         gotpvp = 1;
2496                 }
2497                 pdp = &pmap->pm_pml4[pdp_index & ((1ul << NPML4EPGSHIFT) - 1)];
2498                 KKASSERT((*pdp & pmap->pmap_bits[PG_V_IDX]) != 0);
2499                 p = PHYS_TO_VM_PAGE(*pdp & PG_FRAME);
2500                 pmap_inval_bulk(bulk, (vm_offset_t)-1, pdp, 0);
2501         } else if (ptepindex >= pmap_pd_pindex(0)) {
2502                 /*
2503                  * Remove a PD page from the pdp
2504                  *
2505                  * SIMPLE PMAP NOTE: Non-existant pvp's are ok in the case
2506                  *                   of a simple pmap because it stops at
2507                  *                   the PD page.
2508                  */
2509                 vm_pindex_t pdp_pindex;
2510                 vm_pindex_t pd_index;
2511                 pdp_entry_t *pd;
2512
2513                 pd_index = ptepindex - pmap_pd_pindex(0);
2514
2515                 if (pvp == NULL) {
2516                         pdp_pindex = NUPTE_TOTAL + NUPT_TOTAL + NUPD_TOTAL +
2517                                      (pd_index >> NPML4EPGSHIFT);
2518                         pvp = pv_get(pv->pv_pmap, pdp_pindex);
2519                         if (pvp)
2520                                 gotpvp = 1;
2521                 }
2522                 if (pvp) {
2523                         pd = pv_pte_lookup(pvp, pd_index &
2524                                                 ((1ul << NPDPEPGSHIFT) - 1));
2525                         KKASSERT((*pd & pmap->pmap_bits[PG_V_IDX]) != 0);
2526                         p = PHYS_TO_VM_PAGE(*pd & PG_FRAME);
2527                         pmap_inval_bulk(bulk, (vm_offset_t)-1, pd, 0);
2528                 } else {
2529                         KKASSERT(pmap->pm_flags & PMAP_FLAG_SIMPLE);
2530                         p = pv->pv_m;           /* degenerate test later */
2531                 }
2532         } else if (ptepindex >= pmap_pt_pindex(0)) {
2533                 /*
2534                  *  Remove a PT page from the pd
2535                  */
2536                 vm_pindex_t pd_pindex;
2537                 vm_pindex_t pt_index;
2538                 pd_entry_t *pt;
2539
2540                 pt_index = ptepindex - pmap_pt_pindex(0);
2541
2542                 if (pvp == NULL) {
2543                         pd_pindex = NUPTE_TOTAL + NUPT_TOTAL +
2544                                     (pt_index >> NPDPEPGSHIFT);
2545                         pvp = pv_get(pv->pv_pmap, pd_pindex);
2546                         KKASSERT(pvp);
2547                         gotpvp = 1;
2548                 }
2549                 pt = pv_pte_lookup(pvp, pt_index & ((1ul << NPDPEPGSHIFT) - 1));
2550                 KKASSERT((*pt & pmap->pmap_bits[PG_V_IDX]) != 0);
2551                 p = PHYS_TO_VM_PAGE(*pt & PG_FRAME);
2552                 pmap_inval_bulk(bulk, (vm_offset_t)-1, pt, 0);
2553         } else {
2554                 /*
2555                  * Remove a PTE from the PT page
2556                  *
2557                  * NOTE: pv's must be locked bottom-up to avoid deadlocking.
2558                  *       pv is a pte_pv so we can safely lock pt_pv.
2559                  *
2560                  * NOTE: FICTITIOUS pages may have multiple physical mappings
2561                  *       so PHYS_TO_VM_PAGE() will not necessarily work for
2562                  *       terminal ptes.
2563                  */
2564                 vm_pindex_t pt_pindex;
2565                 pt_entry_t *ptep;
2566                 pt_entry_t pte;
2567                 vm_offset_t va;
2568
2569                 pt_pindex = ptepindex >> NPTEPGSHIFT;
2570                 va = (vm_offset_t)ptepindex << PAGE_SHIFT;
2571
2572                 if (ptepindex >= NUPTE_USER) {
2573                         ptep = vtopte(ptepindex << PAGE_SHIFT);
2574                         KKASSERT(pvp == NULL);
2575                 } else {
2576                         if (pvp == NULL) {
2577                                 pt_pindex = NUPTE_TOTAL +
2578                                             (ptepindex >> NPDPEPGSHIFT);
2579                                 pvp = pv_get(pv->pv_pmap, pt_pindex);
2580                                 KKASSERT(pvp);
2581                                 gotpvp = 1;
2582                         }
2583                         ptep = pv_pte_lookup(pvp, ptepindex &
2584                                                   ((1ul << NPDPEPGSHIFT) - 1));
2585                 }
2586                 pte = pmap_inval_bulk(bulk, va, ptep, 0);
2587                 if (bulk == NULL)               /* XXX */
2588                         cpu_invlpg((void *)va); /* XXX */
2589
2590                 /*
2591                  * Now update the vm_page_t
2592                  */
2593                 if ((pte & (pmap->pmap_bits[PG_MANAGED_IDX] | pmap->pmap_bits[PG_V_IDX])) !=
2594                     (pmap->pmap_bits[PG_MANAGED_IDX]|pmap->pmap_bits[PG_V_IDX])) {
2595                         kprintf("remove_pte badpte %016lx %016lx %d\n",
2596                                 pte, pv->pv_pindex,
2597                                 pv->pv_pindex < pmap_pt_pindex(0));
2598                 }
2599                 /* PHYS_TO_VM_PAGE() will not work for FICTITIOUS pages */
2600                 /*KKASSERT((pte & (PG_MANAGED|PG_V)) == (PG_MANAGED|PG_V));*/
2601                 if (pte & pmap->pmap_bits[PG_DEVICE_IDX])
2602                         p = pv->pv_m;
2603                 else
2604                         p = PHYS_TO_VM_PAGE(pte & PG_FRAME);
2605                 /* p = pv->pv_m; */
2606
2607                 if (pte & pmap->pmap_bits[PG_M_IDX]) {
2608                         if (pmap_track_modified(ptepindex))
2609                                 vm_page_dirty(p);
2610                 }
2611                 if (pte & pmap->pmap_bits[PG_A_IDX]) {
2612                         vm_page_flag_set(p, PG_REFERENCED);
2613                 }
2614                 if (pte & pmap->pmap_bits[PG_W_IDX])
2615                         atomic_add_long(&pmap->pm_stats.wired_count, -1);
2616                 if (pte & pmap->pmap_bits[PG_G_IDX])
2617                         cpu_invlpg((void *)va);
2618         }
2619
2620         /*
2621          * Unwire the parent page table page.  The wire_count cannot go below
2622          * 1 here because the parent page table page is itself still mapped.
2623          *
2624          * XXX remove the assertions later.
2625          */
2626         KKASSERT(pv->pv_m == p);
2627         if (pvp && vm_page_unwire_quick(pvp->pv_m))
2628                 panic("pmap_remove_pv_pte: Insufficient wire_count");
2629
2630         if (gotpvp)
2631                 pv_put(pvp);
2632 }
2633
2634 /*
2635  * Remove the vm_page association to a pv.  The pv must be locked.
2636  */
2637 static
2638 vm_page_t
2639 pmap_remove_pv_page(pv_entry_t pv)
2640 {
2641         vm_page_t m;
2642
2643         m = pv->pv_m;
2644         KKASSERT(m);
2645         vm_page_spin_lock(m);
2646         pv->pv_m = NULL;
2647         TAILQ_REMOVE(&m->md.pv_list, pv, pv_list);
2648         pmap_page_stats_deleting(m);
2649         /*
2650         if (m->object)
2651                 atomic_add_int(&m->object->agg_pv_list_count, -1);
2652         */
2653         if (TAILQ_EMPTY(&m->md.pv_list))
2654                 vm_page_flag_clear(m, PG_MAPPED | PG_WRITEABLE);
2655         vm_page_spin_unlock(m);
2656         return(m);
2657 }
2658
2659 /*
2660  * Grow the number of kernel page table entries, if needed.
2661  *
2662  * This routine is always called to validate any address space
2663  * beyond KERNBASE (for kldloads).  kernel_vm_end only governs the address
2664  * space below KERNBASE.
2665  */
2666 void
2667 pmap_growkernel(vm_offset_t kstart, vm_offset_t kend)
2668 {
2669         vm_paddr_t paddr;
2670         vm_offset_t ptppaddr;
2671         vm_page_t nkpg;
2672         pd_entry_t *pt, newpt;
2673         pdp_entry_t newpd;
2674         int update_kernel_vm_end;
2675
2676         /*
2677          * bootstrap kernel_vm_end on first real VM use
2678          */
2679         if (kernel_vm_end == 0) {
2680                 kernel_vm_end = VM_MIN_KERNEL_ADDRESS;
2681                 nkpt = 0;
2682                 while ((*pmap_pt(&kernel_pmap, kernel_vm_end) & kernel_pmap.pmap_bits[PG_V_IDX]) != 0) {
2683                         kernel_vm_end = (kernel_vm_end + PAGE_SIZE * NPTEPG) &
2684                                         ~(PAGE_SIZE * NPTEPG - 1);
2685                         nkpt++;
2686                         if (kernel_vm_end - 1 >= kernel_map.max_offset) {
2687                                 kernel_vm_end = kernel_map.max_offset;
2688                                 break;
2689                         }
2690                 }
2691         }
2692
2693         /*
2694          * Fill in the gaps.  kernel_vm_end is only adjusted for ranges
2695          * below KERNBASE.  Ranges above KERNBASE are kldloaded and we
2696          * do not want to force-fill 128G worth of page tables.
2697          */
2698         if (kstart < KERNBASE) {
2699                 if (kstart > kernel_vm_end)
2700                         kstart = kernel_vm_end;
2701                 KKASSERT(kend <= KERNBASE);
2702                 update_kernel_vm_end = 1;
2703         } else {
2704                 update_kernel_vm_end = 0;
2705         }
2706
2707         kstart = rounddown2(kstart, PAGE_SIZE * NPTEPG);
2708         kend = roundup2(kend, PAGE_SIZE * NPTEPG);
2709
2710         if (kend - 1 >= kernel_map.max_offset)
2711                 kend = kernel_map.max_offset;
2712
2713         while (kstart < kend) {
2714                 pt = pmap_pt(&kernel_pmap, kstart);
2715                 if (pt == NULL) {
2716                         /* We need a new PDP entry */
2717                         nkpg = vm_page_alloc(NULL, nkpt,
2718                                              VM_ALLOC_NORMAL |
2719                                              VM_ALLOC_SYSTEM |
2720                                              VM_ALLOC_INTERRUPT);
2721                         if (nkpg == NULL) {
2722                                 panic("pmap_growkernel: no memory to grow "
2723                                       "kernel");
2724                         }
2725                         paddr = VM_PAGE_TO_PHYS(nkpg);
2726                         if ((nkpg->flags & PG_ZERO) == 0)
2727                                 pmap_zero_page(paddr);
2728                         vm_page_flag_clear(nkpg, PG_ZERO);
2729                         newpd = (pdp_entry_t)
2730                             (paddr |
2731                             kernel_pmap.pmap_bits[PG_V_IDX] |
2732                             kernel_pmap.pmap_bits[PG_RW_IDX] |
2733                             kernel_pmap.pmap_bits[PG_A_IDX] |
2734                             kernel_pmap.pmap_bits[PG_M_IDX]);
2735                         *pmap_pd(&kernel_pmap, kstart) = newpd;
2736                         nkpt++;
2737                         continue; /* try again */
2738                 }
2739                 if ((*pt & kernel_pmap.pmap_bits[PG_V_IDX]) != 0) {
2740                         kstart = (kstart + PAGE_SIZE * NPTEPG) &
2741                                  ~(PAGE_SIZE * NPTEPG - 1);
2742                         if (kstart - 1 >= kernel_map.max_offset) {
2743                                 kstart = kernel_map.max_offset;
2744                                 break;
2745                         }
2746                         continue;
2747                 }
2748
2749                 /*
2750                  * This index is bogus, but out of the way
2751                  */
2752                 nkpg = vm_page_alloc(NULL, nkpt,
2753                                      VM_ALLOC_NORMAL |
2754                                      VM_ALLOC_SYSTEM |
2755                                      VM_ALLOC_INTERRUPT);
2756                 if (nkpg == NULL)
2757                         panic("pmap_growkernel: no memory to grow kernel");
2758
2759                 vm_page_wire(nkpg);
2760                 ptppaddr = VM_PAGE_TO_PHYS(nkpg);
2761                 pmap_zero_page(ptppaddr);
2762                 vm_page_flag_clear(nkpg, PG_ZERO);
2763                 newpt = (pd_entry_t) (ptppaddr |
2764                     kernel_pmap.pmap_bits[PG_V_IDX] |
2765                     kernel_pmap.pmap_bits[PG_RW_IDX] |
2766                     kernel_pmap.pmap_bits[PG_A_IDX] |
2767                     kernel_pmap.pmap_bits[PG_M_IDX]);
2768                 *pmap_pt(&kernel_pmap, kstart) = newpt;
2769                 nkpt++;
2770
2771                 kstart = (kstart + PAGE_SIZE * NPTEPG) &
2772                           ~(PAGE_SIZE * NPTEPG - 1);
2773
2774                 if (kstart - 1 >= kernel_map.max_offset) {
2775                         kstart = kernel_map.max_offset;
2776                         break;
2777                 }
2778         }
2779
2780         /*
2781          * Only update kernel_vm_end for areas below KERNBASE.
2782          */
2783         if (update_kernel_vm_end && kernel_vm_end < kstart)
2784                 kernel_vm_end = kstart;
2785 }
2786
2787 /*
2788  *      Add a reference to the specified pmap.
2789  */
2790 void
2791 pmap_reference(pmap_t pmap)
2792 {
2793         if (pmap != NULL) {
2794                 lwkt_gettoken(&pmap->pm_token);
2795                 ++pmap->pm_count;
2796                 lwkt_reltoken(&pmap->pm_token);
2797         }
2798 }
2799
2800 /***************************************************
2801  * page management routines.
2802  ***************************************************/
2803
2804 /*
2805  * Hold a pv without locking it
2806  */
2807 static void
2808 pv_hold(pv_entry_t pv)
2809 {
2810         atomic_add_int(&pv->pv_hold, 1);
2811 }
2812
2813 /*
2814  * Hold a pv_entry, preventing its destruction.  TRUE is returned if the pv
2815  * was successfully locked, FALSE if it wasn't.  The caller must dispose of
2816  * the pv properly.
2817  *
2818  * Either the pmap->pm_spin or the related vm_page_spin (if traversing a
2819  * pv list via its page) must be held by the caller.
2820  */
2821 static int
2822 _pv_hold_try(pv_entry_t pv PMAP_DEBUG_DECL)
2823 {
2824         u_int count;
2825
2826         /*
2827          * Critical path shortcut expects pv to already have one ref
2828          * (for the pv->pv_pmap).
2829          */
2830         if (atomic_cmpset_int(&pv->pv_hold, 1, PV_HOLD_LOCKED | 2)) {
2831 #ifdef PMAP_DEBUG
2832                 pv->pv_func = func;
2833                 pv->pv_line = lineno;
2834 #endif
2835                 return TRUE;
2836         }
2837
2838         for (;;) {
2839                 count = pv->pv_hold;
2840                 cpu_ccfence();
2841                 if ((count & PV_HOLD_LOCKED) == 0) {
2842                         if (atomic_cmpset_int(&pv->pv_hold, count,
2843                                               (count + 1) | PV_HOLD_LOCKED)) {
2844 #ifdef PMAP_DEBUG
2845                                 pv->pv_func = func;
2846                                 pv->pv_line = lineno;
2847 #endif
2848                                 return TRUE;
2849                         }
2850                 } else {
2851                         if (atomic_cmpset_int(&pv->pv_hold, count, count + 1))
2852                                 return FALSE;
2853                 }
2854                 /* retry */
2855         }
2856 }
2857
2858 /*
2859  * Drop a previously held pv_entry which could not be locked, allowing its
2860  * destruction.
2861  *
2862  * Must not be called with a spinlock held as we might zfree() the pv if it
2863  * is no longer associated with a pmap and this was the last hold count.
2864  */
2865 static void
2866 pv_drop(pv_entry_t pv)
2867 {
2868         u_int count;
2869
2870         for (;;) {
2871                 count = pv->pv_hold;
2872                 cpu_ccfence();
2873                 KKASSERT((count & PV_HOLD_MASK) > 0);
2874                 KKASSERT((count & (PV_HOLD_LOCKED | PV_HOLD_MASK)) !=
2875                          (PV_HOLD_LOCKED | 1));
2876                 if (atomic_cmpset_int(&pv->pv_hold, count, count - 1)) {
2877                         if ((count & PV_HOLD_MASK) == 1) {
2878 #ifdef PMAP_DEBUG2
2879                                 if (pmap_enter_debug > 0) {
2880                                         --pmap_enter_debug;
2881                                         kprintf("pv_drop: free pv %p\n", pv);
2882                                 }
2883 #endif
2884                                 KKASSERT(count == 1);
2885                                 KKASSERT(pv->pv_pmap == NULL);
2886                                 zfree(pvzone, pv);
2887                         }
2888                         return;
2889                 }
2890                 /* retry */
2891         }
2892 }
2893
2894 /*
2895  * Find or allocate the requested PV entry, returning a locked, held pv.
2896  *
2897  * If (*isnew) is non-zero, the returned pv will have two hold counts, one
2898  * for the caller and one representing the pmap and vm_page association.
2899  *
2900  * If (*isnew) is zero, the returned pv will have only one hold count.
2901  *
2902  * Since both associations can only be adjusted while the pv is locked,
2903  * together they represent just one additional hold.
2904  */
2905 static
2906 pv_entry_t
2907 _pv_alloc(pmap_t pmap, vm_pindex_t pindex, int *isnew PMAP_DEBUG_DECL)
2908 {
2909         pv_entry_t pv;
2910         pv_entry_t pnew = NULL;
2911
2912         spin_lock(&pmap->pm_spin);
2913         for (;;) {
2914                 if ((pv = pmap->pm_pvhint) == NULL || pv->pv_pindex != pindex) {
2915                         pv = pv_entry_rb_tree_RB_LOOKUP(&pmap->pm_pvroot,
2916                                                         pindex);
2917                 }
2918                 if (pv == NULL) {
2919                         if (pnew == NULL) {
2920                                 spin_unlock(&pmap->pm_spin);
2921                                 pnew = zalloc(pvzone);
2922                                 spin_lock(&pmap->pm_spin);
2923                                 continue;
2924                         }
2925                         pnew->pv_pmap = pmap;
2926                         pnew->pv_pindex = pindex;
2927                         pnew->pv_hold = PV_HOLD_LOCKED | 2;
2928 #ifdef PMAP_DEBUG
2929                         pnew->pv_func = func;
2930                         pnew->pv_line = lineno;
2931 #endif
2932                         pv_entry_rb_tree_RB_INSERT(&pmap->pm_pvroot, pnew);
2933                         ++pmap->pm_generation;
2934                         atomic_add_long(&pmap->pm_stats.resident_count, 1);
2935                         spin_unlock(&pmap->pm_spin);
2936                         *isnew = 1;
2937                         return(pnew);
2938                 }
2939                 if (pnew) {
2940                         spin_unlock(&pmap->pm_spin);
2941                         zfree(pvzone, pnew);
2942                         pnew = NULL;
2943                         spin_lock(&pmap->pm_spin);
2944                         continue;
2945                 }
2946                 if (_pv_hold_try(pv PMAP_DEBUG_COPY)) {
2947                         spin_unlock(&pmap->pm_spin);
2948                 } else {
2949                         spin_unlock(&pmap->pm_spin);
2950                         _pv_lock(pv PMAP_DEBUG_COPY);
2951                 }
2952                 if (pv->pv_pmap == pmap && pv->pv_pindex == pindex) {
2953                         *isnew = 0;
2954                         return(pv);
2955                 }
2956                 pv_put(pv);
2957                 spin_lock(&pmap->pm_spin);
2958         }
2959 }
2960
2961 /*
2962  * Find the requested PV entry, returning a locked+held pv or NULL
2963  */
2964 static
2965 pv_entry_t
2966 _pv_get(pmap_t pmap, vm_pindex_t pindex PMAP_DEBUG_DECL)
2967 {
2968         pv_entry_t pv;
2969
2970         spin_lock(&pmap->pm_spin);
2971         for (;;) {
2972                 /*
2973                  * Shortcut cache
2974                  */
2975                 if ((pv = pmap->pm_pvhint) == NULL || pv->pv_pindex != pindex) {
2976                         pv = pv_entry_rb_tree_RB_LOOKUP(&pmap->pm_pvroot,
2977                                                         pindex);
2978                 }
2979                 if (pv == NULL) {
2980                         spin_unlock(&pmap->pm_spin);
2981                         return NULL;
2982                 }
2983                 if (_pv_hold_try(pv PMAP_DEBUG_COPY)) {
2984                         spin_unlock(&pmap->pm_spin);
2985                 } else {
2986                         spin_unlock(&pmap->pm_spin);
2987                         _pv_lock(pv PMAP_DEBUG_COPY);
2988                 }
2989                 if (pv->pv_pmap == pmap && pv->pv_pindex == pindex) {
2990                         pv_cache(pv, pindex);
2991                         return(pv);
2992                 }
2993                 pv_put(pv);
2994                 spin_lock(&pmap->pm_spin);
2995         }
2996 }
2997
2998 /*
2999  * Lookup, hold, and attempt to lock (pmap,pindex).
3000  *
3001  * If the entry does not exist NULL is returned and *errorp is set to 0
3002  *
3003  * If the entry exists and could be successfully locked it is returned and
3004  * errorp is set to 0.
3005  *
3006  * If the entry exists but could NOT be successfully locked it is returned
3007  * held and *errorp is set to 1.
3008  */
3009 static
3010 pv_entry_t
3011 pv_get_try(pmap_t pmap, vm_pindex_t pindex, int *errorp)
3012 {
3013         pv_entry_t pv;
3014
3015         spin_lock_shared(&pmap->pm_spin);
3016         if ((pv = pmap->pm_pvhint) == NULL || pv->pv_pindex != pindex)
3017                 pv = pv_entry_rb_tree_RB_LOOKUP(&pmap->pm_pvroot, pindex);
3018         if (pv == NULL) {
3019                 spin_unlock_shared(&pmap->pm_spin);
3020                 *errorp = 0;
3021                 return NULL;
3022         }
3023         if (pv_hold_try(pv)) {
3024                 pv_cache(pv, pindex);
3025                 spin_unlock_shared(&pmap->pm_spin);
3026                 *errorp = 0;
3027                 KKASSERT(pv->pv_pmap == pmap && pv->pv_pindex == pindex);
3028                 return(pv);     /* lock succeeded */
3029         }
3030         spin_unlock_shared(&pmap->pm_spin);
3031         *errorp = 1;
3032         return (pv);            /* lock failed */
3033 }
3034
3035 /*
3036  * Find the requested PV entry, returning a held pv or NULL
3037  */
3038 static
3039 pv_entry_t
3040 pv_find(pmap_t pmap, vm_pindex_t pindex)
3041 {
3042         pv_entry_t pv;
3043
3044         spin_lock_shared(&pmap->pm_spin);
3045
3046         if ((pv = pmap->pm_pvhint) == NULL || pv->pv_pindex != pindex)
3047                 pv = pv_entry_rb_tree_RB_LOOKUP(&pmap->pm_pvroot, pindex);
3048         if (pv == NULL) {
3049                 spin_unlock_shared(&pmap->pm_spin);
3050                 return NULL;
3051         }
3052         pv_hold(pv);
3053         pv_cache(pv, pindex);
3054         spin_unlock_shared(&pmap->pm_spin);
3055         return(pv);
3056 }
3057
3058 /*
3059  * Lock a held pv, keeping the hold count
3060  */
3061 static
3062 void
3063 _pv_lock(pv_entry_t pv PMAP_DEBUG_DECL)
3064 {
3065         u_int count;
3066
3067         for (;;) {
3068                 count = pv->pv_hold;
3069                 cpu_ccfence();
3070                 if ((count & PV_HOLD_LOCKED) == 0) {
3071                         if (atomic_cmpset_int(&pv->pv_hold, count,
3072                                               count | PV_HOLD_LOCKED)) {
3073 #ifdef PMAP_DEBUG
3074                                 pv->pv_func = func;
3075                                 pv->pv_line = lineno;
3076 #endif
3077                                 return;
3078                         }
3079                         continue;
3080                 }
3081                 tsleep_interlock(pv, 0);
3082                 if (atomic_cmpset_int(&pv->pv_hold, count,
3083                                       count | PV_HOLD_WAITING)) {
3084 #ifdef PMAP_DEBUG
3085                         kprintf("pv waiting on %s:%d\n",
3086                                         pv->pv_func, pv->pv_line);
3087 #endif
3088                         tsleep(pv, PINTERLOCKED, "pvwait", hz);
3089                 }
3090                 /* retry */
3091         }
3092 }
3093
3094 /*
3095  * Unlock a held and locked pv, keeping the hold count.
3096  */
3097 static
3098 void
3099 pv_unlock(pv_entry_t pv)
3100 {
3101         u_int count;
3102
3103         for (;;) {
3104                 count = pv->pv_hold;
3105                 cpu_ccfence();
3106                 KKASSERT((count & (PV_HOLD_LOCKED | PV_HOLD_MASK)) >=
3107                          (PV_HOLD_LOCKED | 1));
3108                 if (atomic_cmpset_int(&pv->pv_hold, count,
3109                                       count &
3110                                       ~(PV_HOLD_LOCKED | PV_HOLD_WAITING))) {
3111                         if (count & PV_HOLD_WAITING)
3112                                 wakeup(pv);
3113                         break;
3114                 }
3115         }
3116 }
3117
3118 /*
3119  * Unlock and drop a pv.  If the pv is no longer associated with a pmap
3120  * and the hold count drops to zero we will free it.
3121  *
3122  * Caller should not hold any spin locks.  We are protected from hold races
3123  * by virtue of holds only occuring only with a pmap_spin or vm_page_spin
3124  * lock held.  A pv cannot be located otherwise.
3125  */
3126 static
3127 void
3128 pv_put(pv_entry_t pv)
3129 {
3130 #ifdef PMAP_DEBUG2
3131         if (pmap_enter_debug > 0) {
3132                 --pmap_enter_debug;
3133                 kprintf("pv_put pv=%p hold=%08x\n", pv, pv->pv_hold);
3134         }
3135 #endif
3136
3137         /*
3138          * Fast - shortcut most common condition
3139          */
3140         if (atomic_cmpset_int(&pv->pv_hold, PV_HOLD_LOCKED | 2, 1))
3141                 return;
3142
3143         /*
3144          * Slow
3145          */
3146         pv_unlock(pv);
3147         pv_drop(pv);
3148 }
3149
3150 /*
3151  * Remove the pmap association from a pv, require that pv_m already be removed,
3152  * then unlock and drop the pv.  Any pte operations must have already been
3153  * completed.  This call may result in a last-drop which will physically free
3154  * the pv.
3155  *
3156  * Removing the pmap association entails an additional drop.
3157  *
3158  * pv must be exclusively locked on call and will be disposed of on return.
3159  */
3160 static
3161 void
3162 pv_free(pv_entry_t pv)
3163 {
3164         pmap_t pmap;
3165
3166         KKASSERT(pv->pv_m == NULL);
3167         KKASSERT((pv->pv_hold & PV_HOLD_MASK) >= 2);
3168         if ((pmap = pv->pv_pmap) != NULL) {
3169                 spin_lock(&pmap->pm_spin);
3170                 pv_entry_rb_tree_RB_REMOVE(&pmap->pm_pvroot, pv);
3171                 ++pmap->pm_generation;
3172                 if (pmap->pm_pvhint == pv)
3173                         pmap->pm_pvhint = NULL;
3174                 atomic_add_long(&pmap->pm_stats.resident_count, -1);
3175                 pv->pv_pmap = NULL;
3176                 pv->pv_pindex = 0;
3177                 spin_unlock(&pmap->pm_spin);
3178
3179                 /*
3180                  * Try to shortcut three atomic ops, otherwise fall through
3181                  * and do it normally.  Drop two refs and the lock all in
3182                  * one go.
3183                  */
3184                 if (atomic_cmpset_int(&pv->pv_hold, PV_HOLD_LOCKED | 2, 0)) {
3185 #ifdef PMAP_DEBUG2
3186                         if (pmap_enter_debug > 0) {
3187                                 --pmap_enter_debug;
3188                                 kprintf("pv_free: free pv %p\n", pv);
3189                         }
3190 #endif
3191                         zfree(pvzone, pv);
3192                         return;
3193                 }
3194                 pv_drop(pv);    /* ref for pv_pmap */
3195         }
3196         pv_put(pv);
3197 }
3198
3199 /*
3200  * This routine is very drastic, but can save the system
3201  * in a pinch.
3202  */
3203 void
3204 pmap_collect(void)
3205 {
3206         int i;
3207         vm_page_t m;
3208         static int warningdone=0;
3209
3210         if (pmap_pagedaemon_waken == 0)
3211                 return;
3212         pmap_pagedaemon_waken = 0;
3213         if (warningdone < 5) {
3214                 kprintf("pmap_collect: collecting pv entries -- "
3215                         "suggest increasing PMAP_SHPGPERPROC\n");
3216                 warningdone++;
3217         }
3218
3219         for (i = 0; i < vm_page_array_size; i++) {
3220                 m = &vm_page_array[i];
3221                 if (m->wire_count || m->hold_count)
3222                         continue;
3223                 if (vm_page_busy_try(m, TRUE) == 0) {
3224                         if (m->wire_count == 0 && m->hold_count == 0) {
3225                                 pmap_remove_all(m);
3226                         }
3227                         vm_page_wakeup(m);
3228                 }
3229         }
3230 }
3231
3232 /*
3233  * Scan the pmap for active page table entries and issue a callback.
3234  * The callback must dispose of pte_pv, whos PTE entry is at *ptep in
3235  * its parent page table.
3236  *
3237  * pte_pv will be NULL if the page or page table is unmanaged.
3238  * pt_pv will point to the page table page containing the pte for the page.
3239  *
3240  * NOTE! If we come across an unmanaged page TABLE (verses an unmanaged page),
3241  *       we pass a NULL pte_pv and we pass a pt_pv pointing to the passed
3242  *       process pmap's PD and page to the callback function.  This can be
3243  *       confusing because the pt_pv is really a pd_pv, and the target page
3244  *       table page is simply aliased by the pmap and not owned by it.
3245  *
3246  * It is assumed that the start and end are properly rounded to the page size.
3247  *
3248  * It is assumed that PD pages and above are managed and thus in the RB tree,
3249  * allowing us to use RB_SCAN from the PD pages down for ranged scans.
3250  */
3251 struct pmap_scan_info {
3252         struct pmap *pmap;
3253         vm_offset_t sva;
3254         vm_offset_t eva;
3255         vm_pindex_t sva_pd_pindex;
3256         vm_pindex_t eva_pd_pindex;
3257         void (*func)(pmap_t, struct pmap_scan_info *,
3258                      pv_entry_t, pv_entry_t, int, vm_offset_t,
3259                      pt_entry_t *, void *);
3260         void *arg;
3261         pmap_inval_bulk_t bulk_core;
3262         pmap_inval_bulk_t *bulk;
3263         int count;
3264 };
3265
3266 static int pmap_scan_cmp(pv_entry_t pv, void *data);
3267 static int pmap_scan_callback(pv_entry_t pv, void *data);
3268
3269 static void
3270 pmap_scan(struct pmap_scan_info *info, int smp_inval)
3271 {
3272         struct pmap *pmap = info->pmap;
3273         pv_entry_t pd_pv;       /* A page directory PV */
3274         pv_entry_t pt_pv;       /* A page table PV */
3275         pv_entry_t pte_pv;      /* A page table entry PV */
3276         pt_entry_t *ptep;
3277         pt_entry_t oldpte;
3278         struct pv_entry dummy_pv;
3279         int generation;
3280
3281         if (pmap == NULL)
3282                 return;
3283         if (smp_inval) {
3284                 info->bulk = &info->bulk_core;
3285                 pmap_inval_bulk_init(&info->bulk_core, pmap);
3286         } else {
3287                 info->bulk = NULL;
3288         }
3289
3290         /*
3291          * Hold the token for stability; if the pmap is empty we have nothing
3292          * to do.
3293          */
3294         lwkt_gettoken(&pmap->pm_token);
3295 #if 0
3296         if (pmap->pm_stats.resident_count == 0) {
3297                 lwkt_reltoken(&pmap->pm_token);
3298                 return;
3299         }
3300 #endif
3301
3302         info->count = 0;
3303
3304 again:
3305         /*
3306          * Special handling for scanning one page, which is a very common
3307          * operation (it is?).
3308          *
3309          * NOTE: Locks must be ordered bottom-up. pte,pt,pd,pdp,pml4
3310          */
3311         if (info->sva + PAGE_SIZE == info->eva) {
3312                 generation = pmap->pm_generation;
3313                 if (info->sva >= VM_MAX_USER_ADDRESS) {
3314                         /*
3315                          * Kernel mappings do not track wire counts on
3316                          * page table pages and only maintain pd_pv and
3317                          * pte_pv levels so pmap_scan() works.
3318                          */
3319                         pt_pv = NULL;
3320                         pte_pv = pv_get(pmap, pmap_pte_pindex(info->sva));
3321                         ptep = vtopte(info->sva);
3322                 } else {
3323                         /*
3324                          * User pages which are unmanaged will not have a
3325                          * pte_pv.  User page table pages which are unmanaged
3326                          * (shared from elsewhere) will also not have a pt_pv.
3327                          * The func() callback will pass both pte_pv and pt_pv
3328                          * as NULL in that case.
3329                          */
3330                         pte_pv = pv_get(pmap, pmap_pte_pindex(info->sva));
3331                         pt_pv = pv_get(pmap, pmap_pt_pindex(info->sva));
3332                         if (pt_pv == NULL) {
3333                                 KKASSERT(pte_pv == NULL);
3334                                 pd_pv = pv_get(pmap, pmap_pd_pindex(info->sva));
3335                                 if (pd_pv) {
3336                                         ptep = pv_pte_lookup(pd_pv,
3337                                                     pmap_pt_index(info->sva));
3338                                         if (*ptep) {
3339                                                 info->func(pmap, info,
3340                                                      NULL, pd_pv, 1,
3341                                                      info->sva, ptep,
3342                                                      info->arg);
3343                                         }
3344                                         pv_put(pd_pv);
3345                                 }
3346                                 goto fast_skip;
3347                         }
3348                         ptep = pv_pte_lookup(pt_pv, pmap_pte_index(info->sva));
3349                 }
3350
3351                 /*
3352                  * NOTE: *ptep can't be ripped out from under us if we hold
3353                  *       pte_pv locked, but bits can change.  However, there is
3354                  *       a race where another thread may be inserting pte_pv
3355                  *       and setting *ptep just after our pte_pv lookup fails.
3356                  *
3357                  *       In this situation we can end up with a NULL pte_pv
3358                  *       but find that we have a managed *ptep.  We explicitly
3359                  *       check for this race.
3360                  */
3361                 oldpte = *ptep;
3362                 cpu_ccfence();
3363                 if (oldpte == 0) {
3364                         /*
3365                          * Unlike the pv_find() case below we actually
3366                          * acquired a locked pv in this case so any
3367                          * race should have been resolved.  It is expected
3368                          * to not exist.
3369                          */
3370                         KKASSERT(pte_pv == NULL);
3371                 } else if (pte_pv) {
3372                         KASSERT((oldpte & (pmap->pmap_bits[PG_MANAGED_IDX] |
3373                                            pmap->pmap_bits[PG_V_IDX])) ==
3374                                 (pmap->pmap_bits[PG_MANAGED_IDX] |
3375                                  pmap->pmap_bits[PG_V_IDX]),
3376                             ("badA *ptep %016lx/%016lx sva %016lx pte_pv %p"
3377                              "generation %d/%d",
3378                             *ptep, oldpte, info->sva, pte_pv,
3379                             generation, pmap->pm_generation));
3380                         info->func(pmap, info, pte_pv, pt_pv, 0,
3381                                    info->sva, ptep, info->arg);
3382                 } else {
3383                         /*
3384                          * Check for insertion race
3385                          */
3386                         if ((oldpte & pmap->pmap_bits[PG_MANAGED_IDX]) &&
3387                             pt_pv) {
3388                                 pte_pv = pv_find(pmap,
3389                                                  pmap_pte_pindex(info->sva));
3390                                 if (pte_pv) {
3391                                         pv_drop(pte_pv);
3392                                         pv_put(pt_pv);
3393                                         kprintf("pmap_scan: RACE1 "
3394                                                 "%016jx, %016lx\n",
3395                                                 info->sva, oldpte);
3396                                         goto again;
3397                                 }
3398                         }
3399
3400                         /*
3401                          * Didn't race
3402                          */
3403                         KASSERT((oldpte & (pmap->pmap_bits[PG_MANAGED_IDX] |
3404                                            pmap->pmap_bits[PG_V_IDX])) ==
3405                             pmap->pmap_bits[PG_V_IDX],
3406                             ("badB *ptep %016lx/%016lx sva %016lx pte_pv NULL"
3407                              "generation %d/%d",
3408                             *ptep, oldpte, info->sva,
3409                             generation, pmap->pm_generation));
3410                         info->func(pmap, info, NULL, pt_pv, 0,
3411                             info->sva, ptep, info->arg);
3412                 }
3413                 if (pt_pv)
3414                         pv_put(pt_pv);
3415 fast_skip:
3416                 pmap_inval_bulk_flush(info->bulk);
3417                 lwkt_reltoken(&pmap->pm_token);
3418                 return;
3419         }
3420
3421         /*
3422          * Nominal scan case, RB_SCAN() for PD pages and iterate from
3423          * there.
3424          */
3425         info->sva_pd_pindex = pmap_pd_pindex(info->sva);
3426         info->eva_pd_pindex = pmap_pd_pindex(info->eva + NBPDP - 1);
3427
3428         if (info->sva >= VM_MAX_USER_ADDRESS) {
3429                 /*
3430                  * The kernel does not currently maintain any pv_entry's for
3431                  * higher-level page tables.
3432                  */
3433                 bzero(&dummy_pv, sizeof(dummy_pv));
3434                 dummy_pv.pv_pindex = info->sva_pd_pindex;
3435                 spin_lock(&pmap->pm_spin);
3436                 while (dummy_pv.pv_pindex < info->eva_pd_pindex) {
3437                         pmap_scan_callback(&dummy_pv, info);
3438                         ++dummy_pv.pv_pindex;
3439                 }
3440                 spin_unlock(&pmap->pm_spin);
3441         } else {
3442                 /*
3443                  * User page tables maintain local PML4, PDP, and PD
3444                  * pv_entry's at the very least.  PT pv's might be
3445                  * unmanaged and thus not exist.  PTE pv's might be
3446                  * unmanaged and thus not exist.
3447                  */
3448                 spin_lock(&pmap->pm_spin);
3449                 pv_entry_rb_tree_RB_SCAN(&pmap->pm_pvroot,
3450                         pmap_scan_cmp, pmap_scan_callback, info);
3451                 spin_unlock(&pmap->pm_spin);
3452         }
3453         pmap_inval_bulk_flush(info->bulk);
3454         lwkt_reltoken(&pmap->pm_token);
3455 }
3456
3457 /*
3458  * WARNING! pmap->pm_spin held
3459  */
3460 static int
3461 pmap_scan_cmp(pv_entry_t pv, void *data)
3462 {
3463         struct pmap_scan_info *info = data;
3464         if (pv->pv_pindex < info->sva_pd_pindex)
3465                 return(-1);
3466         if (pv->pv_pindex >= info->eva_pd_pindex)
3467                 return(1);
3468         return(0);
3469 }
3470
3471 /*
3472  * WARNING! pmap->pm_spin held
3473  */
3474 static int
3475 pmap_scan_callback(pv_entry_t pv, void *data)
3476 {
3477         struct pmap_scan_info *info = data;
3478         struct pmap *pmap = info->pmap;
3479         pv_entry_t pd_pv;       /* A page directory PV */
3480         pv_entry_t pt_pv;       /* A page table PV */
3481         pv_entry_t pte_pv;      /* A page table entry PV */
3482         pt_entry_t *ptep;
3483         pt_entry_t oldpte;
3484         vm_offset_t sva;
3485         vm_offset_t eva;
3486         vm_offset_t va_next;
3487         vm_pindex_t pd_pindex;
3488         int error;
3489         int generation;
3490
3491         /*
3492          * Pull the PD pindex from the pv before releasing the spinlock.
3493          *
3494          * WARNING: pv is faked for kernel pmap scans.
3495          */
3496         pd_pindex = pv->pv_pindex;
3497         spin_unlock(&pmap->pm_spin);
3498         pv = NULL;      /* invalid after spinlock unlocked */
3499
3500         /*
3501          * Calculate the page range within the PD.  SIMPLE pmaps are
3502          * direct-mapped for the entire 2^64 address space.  Normal pmaps
3503          * reflect the user and kernel address space which requires
3504          * cannonicalization w/regards to converting pd_pindex's back
3505          * into addresses.
3506          */
3507         sva = (pd_pindex - NUPTE_TOTAL - NUPT_TOTAL) << PDPSHIFT;
3508         if ((pmap->pm_flags & PMAP_FLAG_SIMPLE) == 0 &&
3509             (sva & PML4_SIGNMASK)) {
3510                 sva |= PML4_SIGNMASK;
3511         }
3512         eva = sva + NBPDP;      /* can overflow */
3513         if (sva < info->sva)
3514                 sva = info->sva;
3515         if (eva < info->sva || eva > info->eva)
3516                 eva = info->eva;
3517
3518         /*
3519          * NOTE: kernel mappings do not track page table pages, only
3520          *       terminal pages.
3521          *
3522          * NOTE: Locks must be ordered bottom-up. pte,pt,pd,pdp,pml4.
3523          *       However, for the scan to be efficient we try to
3524          *       cache items top-down.
3525          */
3526         pd_pv = NULL;
3527         pt_pv = NULL;
3528
3529         for (; sva < eva; sva = va_next) {
3530                 if (sva >= VM_MAX_USER_ADDRESS) {
3531                         if (pt_pv) {
3532                                 pv_put(pt_pv);
3533                                 pt_pv = NULL;
3534                         }
3535                         goto kernel_skip;
3536                 }
3537
3538                 /*
3539                  * PD cache (degenerate case if we skip).  It is possible
3540                  * for the PD to not exist due to races.  This is ok.
3541                  */
3542                 if (pd_pv == NULL) {
3543                         pd_pv = pv_get(pmap, pmap_pd_pindex(sva));
3544                 } else if (pd_pv->pv_pindex != pmap_pd_pindex(sva)) {
3545                         pv_put(pd_pv);
3546                         pd_pv = pv_get(pmap, pmap_pd_pindex(sva));
3547                 }
3548                 if (pd_pv == NULL) {
3549                         va_next = (sva + NBPDP) & ~PDPMASK;
3550                         if (va_next < sva)
3551                                 va_next = eva;
3552                         continue;
3553                 }
3554
3555                 /*
3556                  * PT cache
3557                  */
3558                 if (pt_pv == NULL) {
3559                         if (pd_pv) {
3560                                 pv_put(pd_pv);
3561                                 pd_pv = NULL;
3562                         }
3563                         pt_pv = pv_get(pmap, pmap_pt_pindex(sva));
3564                 } else if (pt_pv->pv_pindex != pmap_pt_pindex(sva)) {
3565                         if (pd_pv) {
3566                                 pv_put(pd_pv);
3567                                 pd_pv = NULL;
3568                         }
3569                         pv_put(pt_pv);
3570                         pt_pv = pv_get(pmap, pmap_pt_pindex(sva));
3571                 }
3572
3573                 /*
3574                  * If pt_pv is NULL we either have an shared page table
3575                  * page and must issue a callback specific to that case,
3576                  * or there is no page table page.
3577                  *
3578                  * Either way we can skip the page table page.
3579                  */
3580                 if (pt_pv == NULL) {
3581                         /*
3582                          * Possible unmanaged (shared from another pmap)
3583                          * page table page.
3584                          */
3585                         if (pd_pv == NULL)
3586                                 pd_pv = pv_get(pmap, pmap_pd_pindex(sva));
3587                         KKASSERT(pd_pv != NULL);
3588                         ptep = pv_pte_lookup(pd_pv, pmap_pt_index(sva));
3589                         if (*ptep & pmap->pmap_bits[PG_V_IDX]) {
3590                                 info->func(pmap, info, NULL, pd_pv, 1,
3591                                            sva, ptep, info->arg);
3592                         }
3593
3594                         /*
3595                          * Done, move to next page table page.
3596                          */
3597                         va_next = (sva + NBPDR) & ~PDRMASK;
3598                         if (va_next < sva)
3599                                 va_next = eva;
3600                         continue;
3601                 }
3602
3603                 /*
3604                  * From this point in the loop testing pt_pv for non-NULL
3605                  * means we are in UVM, else if it is NULL we are in KVM.
3606                  *
3607                  * Limit our scan to either the end of the va represented
3608                  * by the current page table page, or to the end of the
3609                  * range being removed.
3610                  */
3611 kernel_skip:
3612                 va_next = (sva + NBPDR) & ~PDRMASK;
3613                 if (va_next < sva)
3614                         va_next = eva;
3615                 if (va_next > eva)
3616                         va_next = eva;
3617
3618                 /*
3619                  * Scan the page table for pages.  Some pages may not be
3620                  * managed (might not have a pv_entry).
3621                  *
3622                  * There is no page table management for kernel pages so
3623                  * pt_pv will be NULL in that case, but otherwise pt_pv
3624                  * is non-NULL, locked, and referenced.
3625                  */
3626
3627                 /*
3628                  * At this point a non-NULL pt_pv means a UVA, and a NULL
3629                  * pt_pv means a KVA.
3630                  */
3631                 if (pt_pv)
3632                         ptep = pv_pte_lookup(pt_pv, pmap_pte_index(sva));
3633                 else
3634                         ptep = vtopte(sva);
3635
3636                 while (sva < va_next) {
3637                         /*
3638                          * Yield every 64 pages.
3639                          */
3640                         if ((++info->count & 63) == 0)
3641                                 lwkt_user_yield();
3642
3643                         /*
3644                          * Acquire the related pte_pv, if any.  If *ptep == 0
3645                          * the related pte_pv should not exist, but if *ptep
3646                          * is not zero the pte_pv may or may not exist (e.g.
3647                          * will not exist for an unmanaged page).
3648                          *
3649                          * However a multitude of races are possible here.
3650                          *
3651                          * In addition, the (pt_pv, pte_pv) lock order is
3652                          * backwards, so we have to be careful in aquiring
3653                          * a properly locked pte_pv.
3654                          */
3655                         generation = pmap->pm_generation;
3656                         if (pt_pv) {
3657                                 pte_pv = pv_get_try(pmap, pmap_pte_pindex(sva),
3658                                                     &error);
3659                                 if (error) {
3660                                         if (pd_pv) {
3661                                                 pv_put(pd_pv);
3662                                                 pd_pv = NULL;
3663                                         }
3664                                         pv_put(pt_pv);   /* must be non-NULL */
3665                                         pt_pv = NULL;
3666                                         pv_lock(pte_pv); /* safe to block now */
3667                                         pv_put(pte_pv);
3668                                         pte_pv = NULL;
3669                                         pt_pv = pv_get(pmap,
3670                                                        pmap_pt_pindex(sva));
3671                                         /*
3672                                          * pt_pv reloaded, need new ptep
3673                                          */
3674                                         KKASSERT(pt_pv != NULL);
3675                                         ptep = pv_pte_lookup(pt_pv,
3676                                                         pmap_pte_index(sva));
3677                                         continue;
3678                                 }
3679                         } else {
3680                                 pte_pv = pv_get(pmap, pmap_pte_pindex(sva));
3681                         }
3682
3683                         /*
3684                          * Ok, if *ptep == 0 we had better NOT have a pte_pv.
3685                          */
3686                         oldpte = *ptep;
3687                         if (oldpte == 0) {
3688                                 if (pte_pv) {
3689                                         kprintf("Unexpected non-NULL pte_pv "
3690                                                 "%p pt_pv %p "
3691                                                 "*ptep = %016lx/%016lx\n",
3692                                                 pte_pv, pt_pv, *ptep, oldpte);
3693                                         panic("Unexpected non-NULL pte_pv");
3694                                 }
3695                                 sva += PAGE_SIZE;
3696                                 ++ptep;
3697                                 continue;
3698                         }
3699
3700                         /*
3701                          * Ready for the callback.  The locked pte_pv (if any)
3702                          * is consumed by the callback.  pte_pv will exist if
3703                          *  the page is managed, and will not exist if it
3704                          * isn't.
3705                          */
3706                         if (pte_pv) {
3707                                 KASSERT((oldpte & (pmap->pmap_bits[PG_MANAGED_IDX] | pmap->pmap_bits[PG_V_IDX])) ==
3708                                     (pmap->pmap_bits[PG_MANAGED_IDX] | pmap->pmap_bits[PG_V_IDX]),
3709                                     ("badC *ptep %016lx/%016lx sva %016lx "
3710                                     "pte_pv %p pm_generation %d/%d",
3711                                     *ptep, oldpte, sva, pte_pv,
3712                                     generation, pmap->pm_generation));
3713                                 info->func(pmap, info, pte_pv, pt_pv, 0,
3714                                     sva, ptep, info->arg);
3715                         } else {
3716                                 /*
3717                                  * Check for insertion race.  Since there is no
3718                                  * pte_pv to guard us it is possible for us
3719                                  * to race another thread doing an insertion.
3720                                  * Our lookup misses the pte_pv but our *ptep
3721                                  * check sees the inserted pte.
3722                                  *
3723                                  * XXX panic case seems to occur within a
3724                                  * vm_fork() of /bin/sh, which frankly
3725                                  * shouldn't happen since no other threads
3726                                  * should be inserting to our pmap in that
3727                                  * situation.  Removing, possibly.  Inserting,
3728                                  * shouldn't happen.
3729                                  */
3730                                 if ((oldpte & pmap->pmap_bits[PG_MANAGED_IDX]) &&
3731                                     pt_pv) {
3732                                         pte_pv = pv_find(pmap,
3733                                                          pmap_pte_pindex(sva));
3734                                         if (pte_pv) {
3735                                                 pv_drop(pte_pv);
3736                                                 kprintf("pmap_scan: RACE2 "
3737                                                         "%016jx, %016lx\n",
3738                                                         sva, oldpte);
3739                                                 continue;
3740                                         }
3741                                 }
3742
3743                                 /*
3744                                  * Didn't race
3745                                  */
3746                                 KASSERT((oldpte & (pmap->pmap_bits[PG_MANAGED_IDX] | pmap->pmap_bits[PG_V_IDX])) ==
3747                                     pmap->pmap_bits[PG_V_IDX],
3748                                     ("badD *ptep %016lx/%016lx sva %016lx "
3749                                     "pte_pv NULL pm_generation %d/%d",
3750                                      *ptep, oldpte, sva,
3751                                      generation, pmap->pm_generation));
3752                                 info->func(pmap, info, NULL, pt_pv, 0,
3753                                     sva, ptep, info->arg);
3754                         }
3755                         pte_pv = NULL;
3756                         sva += PAGE_SIZE;
3757                         ++ptep;
3758                 }
3759         }
3760         if (pd_pv) {
3761                 pv_put(pd_pv);
3762                 pd_pv = NULL;
3763         }
3764         if (pt_pv) {
3765                 pv_put(pt_pv);
3766                 pt_pv = NULL;
3767         }
3768         if ((++info->count & 7) == 0)
3769                 lwkt_user_yield();
3770
3771         /*
3772          * Relock before returning.
3773          */
3774         spin_lock(&pmap->pm_spin);
3775         return (0);
3776 }
3777
3778 void
3779 pmap_remove(struct pmap *pmap, vm_offset_t sva, vm_offset_t eva)
3780 {
3781         struct pmap_scan_info info;
3782
3783         info.pmap = pmap;
3784         info.sva = sva;
3785         info.eva = eva;
3786         info.func = pmap_remove_callback;
3787         info.arg = NULL;
3788         pmap_scan(&info, 1);
3789 }
3790
3791 static void
3792 pmap_remove_noinval(struct pmap *pmap, vm_offset_t sva, vm_offset_t eva)
3793 {
3794         struct pmap_scan_info info;
3795
3796         info.pmap = pmap;
3797         info.sva = sva;
3798         info.eva = eva;
3799         info.func = pmap_remove_callback;
3800         info.arg = NULL;
3801         pmap_scan(&info, 0);
3802 }
3803
3804 static void
3805 pmap_remove_callback(pmap_t pmap, struct pmap_scan_info *info,
3806                      pv_entry_t pte_pv, pv_entry_t pt_pv, int sharept,
3807                      vm_offset_t va, pt_entry_t *ptep, void *arg __unused)
3808 {
3809         pt_entry_t pte;
3810
3811         if (pte_pv) {
3812                 /*
3813                  * This will also drop pt_pv's wire_count. Note that
3814                  * terminal pages are not wired based on mmu presence.
3815                  */
3816                 pmap_remove_pv_pte(pte_pv, pt_pv, info->bulk);
3817                 pmap_remove_pv_page(pte_pv);
3818                 pv_free(pte_pv);
3819         } else if (sharept == 0) {
3820                 /*
3821                  * Unmanaged page table (pt, pd, or pdp. Not pte).
3822                  *
3823                  * pt_pv's wire_count is still bumped by unmanaged pages
3824                  * so we must decrement it manually.
3825                  *
3826                  * We have to unwire the target page table page.
3827                  *
3828                  * It is unclear how we can invalidate a segment so we
3829                  * invalidate -1 which invlidates the tlb.
3830                  */
3831                 pte = pmap_inval_bulk(info->bulk, (vm_offset_t)-1, ptep, 0);
3832                 if (pte & pmap->pmap_bits[PG_W_IDX])
3833                         atomic_add_long(&pmap->pm_stats.wired_count, -1);
3834                 atomic_add_long(&pmap->pm_stats.resident_count, -1);
3835                 if (vm_page_unwire_quick(pt_pv->pv_m))
3836                         panic("pmap_remove: insufficient wirecount");
3837         } else {
3838                 /*
3839                  * Unmanaged page table (pt, pd, or pdp. Not pte) for
3840                  * a shared page table.
3841                  *
3842                  * pt_pv is actually the pd_pv for our pmap (not the shared
3843                  * object pmap).
3844                  *
3845                  * We have to unwire the target page table page and we
3846                  * have to unwire our page directory page.
3847                  *
3848                  * It is unclear how we can invalidate a segment so we
3849                  * invalidate -1 which invlidates the tlb.
3850                  */
3851                 pte = pmap_inval_bulk(info->bulk, (vm_offset_t)-1, ptep, 0);
3852                 atomic_add_long(&pmap->pm_stats.resident_count, -1);
3853                 KKASSERT((pte & pmap->pmap_bits[PG_DEVICE_IDX]) == 0);
3854                 if (vm_page_unwire_quick(PHYS_TO_VM_PAGE(pte & PG_FRAME)))
3855                         panic("pmap_remove: shared pgtable1 bad wirecount");
3856                 if (vm_page_unwire_quick(pt_pv->pv_m))
3857                         panic("pmap_remove: shared pgtable2 bad wirecount");
3858         }
3859 }
3860
3861 /*
3862  * Removes this physical page from all physical maps in which it resides.
3863  * Reflects back modify bits to the pager.
3864  *
3865  * This routine may not be called from an interrupt.
3866  */
3867 static
3868 void
3869 pmap_remove_all(vm_page_t m)
3870 {
3871         pv_entry_t pv;
3872         pmap_inval_bulk_t bulk;
3873
3874         if (!pmap_initialized /* || (m->flags & PG_FICTITIOUS)*/)
3875                 return;
3876
3877         vm_page_spin_lock(m);
3878         while ((pv = TAILQ_FIRST(&m->md.pv_list)) != NULL) {
3879                 KKASSERT(pv->pv_m == m);
3880                 if (pv_hold_try(pv)) {
3881                         vm_page_spin_unlock(m);
3882                 } else {
3883                         vm_page_spin_unlock(m);
3884                         pv_lock(pv);
3885                 }
3886                 if (pv->pv_m != m) {
3887                         pv_put(pv);
3888                         vm_page_spin_lock(m);
3889                         continue;
3890                 }
3891
3892                 /*
3893                  * Holding no spinlocks, pv is locked.
3894                  */
3895                 pmap_inval_bulk_init(&bulk, pv->pv_pmap);
3896                 pmap_remove_pv_pte(pv, NULL, &bulk);
3897                 pmap_inval_bulk_flush(&bulk);
3898                 pmap_remove_pv_page(pv);
3899                 pv_free(pv);
3900                 vm_page_spin_lock(m);
3901         }
3902         KKASSERT((m->flags & (PG_MAPPED|PG_WRITEABLE)) == 0);
3903         vm_page_spin_unlock(m);
3904 }
3905
3906 /*
3907  * Set the physical protection on the specified range of this map
3908  * as requested.  This function is typically only used for debug watchpoints
3909  * and COW pages.
3910  *
3911  * This function may not be called from an interrupt if the map is
3912  * not the kernel_pmap.
3913  *
3914  * NOTE!  For shared page table pages we just unmap the page.
3915  */
3916 void
3917 pmap_protect(pmap_t pmap, vm_offset_t sva, vm_offset_t eva, vm_prot_t prot)
3918 {
3919         struct pmap_scan_info info;
3920         /* JG review for NX */
3921
3922         if (pmap == NULL)
3923                 return;
3924         if ((prot & VM_PROT_READ) == VM_PROT_NONE) {
3925                 pmap_remove(pmap, sva, eva);
3926                 return;
3927         }
3928         if (prot & VM_PROT_WRITE)
3929                 return;
3930         info.pmap = pmap;
3931         info.sva = sva;
3932         info.eva = eva;
3933         info.func = pmap_protect_callback;
3934         info.arg = &prot;
3935         pmap_scan(&info, 1);
3936 }
3937
3938 static
3939 void
3940 pmap_protect_callback(pmap_t pmap, struct pmap_scan_info *info,
3941                       pv_entry_t pte_pv, pv_entry_t pt_pv, int sharept,
3942                       vm_offset_t va, pt_entry_t *ptep, void *arg __unused)
3943 {
3944         pt_entry_t pbits;
3945         pt_entry_t cbits;
3946         pt_entry_t pte;
3947         vm_page_t m;
3948
3949 again:
3950         pbits = *ptep;
3951         cbits = pbits;
3952         if (pte_pv) {
3953                 m = NULL;
3954                 if (pbits & pmap->pmap_bits[PG_A_IDX]) {
3955                         if ((pbits & pmap->pmap_bits[PG_DEVICE_IDX]) == 0) {
3956                                 m = PHYS_TO_VM_PAGE(pbits & PG_FRAME);
3957                                 KKASSERT(m == pte_pv->pv_m);
3958                                 vm_page_flag_set(m, PG_REFERENCED);
3959                         }
3960                         cbits &= ~pmap->pmap_bits[PG_A_IDX];
3961                 }
3962                 if (pbits & pmap->pmap_bits[PG_M_IDX]) {
3963                         if (pmap_track_modified(pte_pv->pv_pindex)) {
3964                                 if ((pbits & pmap->pmap_bits[PG_DEVICE_IDX]) == 0) {
3965                                         if (m == NULL) {
3966                                                 m = PHYS_TO_VM_PAGE(pbits &
3967                                                                     PG_FRAME);
3968                                         }
3969                                         vm_page_dirty(m);
3970                                 }
3971                                 cbits &= ~pmap->pmap_bits[PG_M_IDX];
3972                         }
3973                 }
3974         } else if (sharept) {
3975                 /*
3976                  * Unmanaged page table, pt_pv is actually the pd_pv
3977                  * for our pmap (not the object's shared pmap).
3978                  *
3979                  * When asked to protect something in a shared page table
3980                  * page we just unmap the page table page.  We have to
3981                  * invalidate the tlb in this situation.
3982                  *
3983                  * XXX Warning, shared page tables will not be used for
3984                  * OBJT_DEVICE or OBJT_MGTDEVICE (PG_FICTITIOUS) mappings
3985                  * so PHYS_TO_VM_PAGE() should be safe here.
3986                  */
3987                 pte = pmap_inval_smp(pmap, (vm_offset_t)-1, 1, ptep, 0);
3988                 if (vm_page_unwire_quick(PHYS_TO_VM_PAGE(pte & PG_FRAME)))
3989                         panic("pmap_protect: pgtable1 pg bad wirecount");
3990                 if (vm_page_unwire_quick(pt_pv->pv_m))
3991                         panic("pmap_protect: pgtable2 pg bad wirecount");
3992                 ptep = NULL;
3993         }
3994         /* else unmanaged page, adjust bits, no wire changes */
3995
3996         if (ptep) {
3997                 cbits &= ~pmap->pmap_bits[PG_RW_IDX];
3998 #ifdef PMAP_DEBUG2
3999                 if (pmap_enter_debug > 0) {
4000                         --pmap_enter_debug;
4001                         kprintf("pmap_protect va=%lx ptep=%p pte_pv=%p "
4002                                 "pt_pv=%p cbits=%08lx\n",
4003                                 va, ptep, pte_pv,
4004                                 pt_pv, cbits
4005                         );
4006                 }
4007 #endif
4008                 if (pbits != cbits) {
4009                         if (!pmap_inval_smp_cmpset(pmap, (vm_offset_t)-1,
4010                                                    ptep, pbits, cbits)) {
4011                                 goto again;
4012                         }
4013                 }
4014         }
4015         if (pte_pv)
4016                 pv_put(pte_pv);
4017 }
4018
4019 /*
4020  * Insert the vm_page (m) at the virtual address (va), replacing any prior
4021  * mapping at that address.  Set protection and wiring as requested.
4022  *
4023  * If entry is non-NULL we check to see if the SEG_SIZE optimization is
4024  * possible.  If it is we enter the page into the appropriate shared pmap
4025  * hanging off the related VM object instead of the passed pmap, then we
4026  * share the page table page from the VM object's pmap into the current pmap.
4027  *
4028  * NOTE: This routine MUST insert the page into the pmap now, it cannot
4029  *       lazy-evaluate.
4030  */
4031 void
4032 pmap_enter(pmap_t pmap, vm_offset_t va, vm_page_t m, vm_prot_t prot,
4033            boolean_t wired, vm_map_entry_t entry)
4034 {
4035         pv_entry_t pt_pv;       /* page table */
4036         pv_entry_t pte_pv;      /* page table entry */
4037         pt_entry_t *ptep;
4038         vm_paddr_t opa;
4039         pt_entry_t origpte, newpte;
4040         vm_paddr_t pa;
4041
4042         if (pmap == NULL)
4043                 return;
4044         va = trunc_page(va);
4045 #ifdef PMAP_DIAGNOSTIC
4046         if (va >= KvaEnd)
4047                 panic("pmap_enter: toobig");
4048         if ((va >= UPT_MIN_ADDRESS) && (va < UPT_MAX_ADDRESS))
4049                 panic("pmap_enter: invalid to pmap_enter page table "
4050                       "pages (va: 0x%lx)", va);
4051 #endif
4052         if (va < UPT_MAX_ADDRESS && pmap == &kernel_pmap) {
4053                 kprintf("Warning: pmap_enter called on UVA with "
4054                         "kernel_pmap\n");
4055 #ifdef DDB
4056                 db_print_backtrace();
4057 #endif
4058         }
4059         if (va >= UPT_MAX_ADDRESS && pmap != &kernel_pmap) {
4060                 kprintf("Warning: pmap_enter called on KVA without"
4061                         "kernel_pmap\n");
4062 #ifdef DDB
4063                 db_print_backtrace();
4064 #endif
4065         }
4066
4067         /*
4068          * Get locked PV entries for our new page table entry (pte_pv)
4069          * and for its parent page table (pt_pv).  We need the parent
4070          * so we can resolve the location of the ptep.
4071          *
4072          * Only hardware MMU actions can modify the ptep out from
4073          * under us.
4074          *
4075          * if (m) is fictitious or unmanaged we do not create a managing
4076          * pte_pv for it.  Any pre-existing page's management state must
4077          * match (avoiding code complexity).
4078          *
4079          * If the pmap is still being initialized we assume existing
4080          * page tables.
4081          *
4082          * Kernel mapppings do not track page table pages (i.e. pt_pv).
4083          */
4084         if (pmap_initialized == FALSE) {
4085                 pte_pv = NULL;
4086                 pt_pv = NULL;
4087                 ptep = vtopte(va);
4088                 origpte = *ptep;
4089         } else if (m->flags & (/*PG_FICTITIOUS |*/ PG_UNMANAGED)) { /* XXX */
4090                 pte_pv = NULL;
4091                 if (va >= VM_MAX_USER_ADDRESS) {
4092                         pt_pv = NULL;
4093                         ptep = vtopte(va);
4094                 } else {
4095                         pt_pv = pmap_allocpte_seg(pmap, pmap_pt_pindex(va),
4096                                                   NULL, entry, va);
4097                         ptep = pv_pte_lookup(pt_pv, pmap_pte_index(va));
4098                 }
4099                 origpte = *ptep;
4100                 cpu_ccfence();
4101                 KASSERT(origpte == 0 ||
4102                          (origpte & pmap->pmap_bits[PG_MANAGED_IDX]) == 0,
4103                          ("Invalid PTE 0x%016jx @ 0x%016jx\n", origpte, va));
4104         } else {
4105                 if (va >= VM_MAX_USER_ADDRESS) {
4106                         /*
4107                          * Kernel map, pv_entry-tracked.
4108                          */
4109                         pt_pv = NULL;
4110                         pte_pv = pmap_allocpte(pmap, pmap_pte_pindex(va), NULL);
4111                         ptep = vtopte(va);
4112                 } else {
4113                         /*
4114                          * User map
4115                          */
4116                         pte_pv = pmap_allocpte_seg(pmap, pmap_pte_pindex(va),
4117                                                    &pt_pv, entry, va);
4118                         ptep = pv_pte_lookup(pt_pv, pmap_pte_index(va));
4119                 }
4120                 origpte = *ptep;
4121                 cpu_ccfence();
4122                 KASSERT(origpte == 0 ||
4123                          (origpte & pmap->pmap_bits[PG_MANAGED_IDX]),
4124                          ("Invalid PTE 0x%016jx @ 0x%016jx\n", origpte, va));
4125         }
4126
4127         pa = VM_PAGE_TO_PHYS(m);
4128         opa = origpte & PG_FRAME;
4129
4130         newpte = (pt_entry_t)(pa | pte_prot(pmap, prot) |
4131                  pmap->pmap_bits[PG_V_IDX] | pmap->pmap_bits[PG_A_IDX]);
4132         if (wired)
4133                 newpte |= pmap->pmap_bits[PG_W_IDX];
4134         if (va < VM_MAX_USER_ADDRESS)
4135                 newpte |= pmap->pmap_bits[PG_U_IDX];
4136         if (pte_pv)
4137                 newpte |= pmap->pmap_bits[PG_MANAGED_IDX];
4138 //      if (pmap == &kernel_pmap)
4139 //              newpte |= pgeflag;
4140         newpte |= pmap->pmap_cache_bits[m->pat_mode];
4141         if (m->flags & PG_FICTITIOUS)
4142                 newpte |= pmap->pmap_bits[PG_DEVICE_IDX];
4143
4144         /*
4145          * It is possible for multiple faults to occur in threaded
4146          * environments, the existing pte might be correct.
4147          */
4148         if (((origpte ^ newpte) & ~(pt_entry_t)(pmap->pmap_bits[PG_M_IDX] |
4149             pmap->pmap_bits[PG_A_IDX])) == 0)
4150                 goto done;
4151
4152         /*
4153          * Ok, either the address changed or the protection or wiring
4154          * changed.
4155          *
4156          * Clear the current entry, interlocking the removal.  For managed
4157          * pte's this will also flush the modified state to the vm_page.
4158          * Atomic ops are mandatory in order to ensure that PG_M events are
4159          * not lost during any transition.
4160          *
4161          * WARNING: The caller has busied the new page but not the original
4162          *          vm_page which we are trying to replace.  Because we hold
4163          *          the pte_pv lock, but have not busied the page, PG bits
4164          *          can be cleared out from under us.
4165          */
4166         if (opa) {
4167                 if (pte_pv) {
4168                         /*
4169                          * pmap_remove_pv_pte() unwires pt_pv and assumes
4170                          * we will free pte_pv, but since we are reusing
4171                          * pte_pv we want to retain the wire count.
4172                          *
4173                          * pt_pv won't exist for a kernel page (managed or
4174                          * otherwise).
4175                          */
4176                         if (pt_pv)
4177                                 vm_page_wire_quick(pt_pv->pv_m);
4178                         if (prot & VM_PROT_NOSYNC) {
4179                                 pmap_remove_pv_pte(pte_pv, pt_pv, NULL);
4180                         } else {
4181                                 pmap_inval_bulk_t bulk;
4182
4183                                 pmap_inval_bulk_init(&bulk, pmap);
4184                                 pmap_remove_pv_pte(pte_pv, pt_pv, &bulk);
4185                                 pmap_inval_bulk_flush(&bulk);
4186                         }
4187                         if (pte_pv->pv_m)
4188                                 pmap_remove_pv_page(pte_pv);
4189                 } else if (prot & VM_PROT_NOSYNC) {
4190                         /*
4191                          * Unmanaged page, NOSYNC (no mmu sync) requested.
4192                          *
4193                          * Leave wire count on PT page intact.
4194                          */
4195                         (void)pte_load_clear(ptep);
4196                         cpu_invlpg((void *)va);
4197                         atomic_add_long(&pmap->pm_stats.resident_count, -1);
4198                 } else {
4199                         /*
4200                          * Unmanaged page, normal enter.
4201                          *
4202                          * Leave wire count on PT page intact.
4203                          */
4204                         pmap_inval_smp(pmap, va, 1, ptep, 0);
4205                         atomic_add_long(&pmap->pm_stats.resident_count, -1);
4206                 }
4207                 KKASSERT(*ptep == 0);
4208         }
4209
4210 #ifdef PMAP_DEBUG2
4211         if (pmap_enter_debug > 0) {
4212                 --pmap_enter_debug;
4213                 kprintf("pmap_enter: va=%lx m=%p origpte=%lx newpte=%lx ptep=%p"
4214                         " pte_pv=%p pt_pv=%p opa=%lx prot=%02x\n",
4215                         va, m,
4216                         origpte, newpte, ptep,
4217                         pte_pv, pt_pv, opa, prot);
4218         }
4219 #endif
4220
4221         if (pte_pv) {
4222                 /*
4223                  * Enter on the PV list if part of our managed memory.
4224                  * Wiring of the PT page is already handled.
4225                  */
4226                 KKASSERT(pte_pv->pv_m == NULL);
4227                 vm_page_spin_lock(m);
4228                 pte_pv->pv_m = m;
4229                 pmap_page_stats_adding(m);
4230                 TAILQ_INSERT_TAIL(&m->md.pv_list, pte_pv, pv_list);
4231                 vm_page_flag_set(m, PG_MAPPED);
4232                 vm_page_spin_unlock(m);
4233         } else if (pt_pv && opa == 0) {
4234                 /*
4235                  * We have to adjust the wire count on the PT page ourselves
4236                  * for unmanaged entries.  If opa was non-zero we retained
4237                  * the existing wire count from the removal.
4238                  */
4239                 vm_page_wire_quick(pt_pv->pv_m);
4240         }
4241
4242         /*
4243          * Kernel VMAs (pt_pv == NULL) require pmap invalidation interlocks.
4244          *
4245          * User VMAs do not because those will be zero->non-zero, so no
4246          * stale entries to worry about at this point.
4247          *
4248          * For KVM there appear to still be issues.  Theoretically we
4249          * should be able to scrap the interlocks entirely but we
4250          * get crashes.
4251          */
4252         if ((prot & VM_PROT_NOSYNC) == 0 && pt_pv == NULL) {
4253                 pmap_inval_smp(pmap, va, 1, ptep, newpte);
4254         } else {
4255                 *(volatile pt_entry_t *)ptep = newpte;
4256                 if (pt_pv == NULL)
4257                         cpu_invlpg((void *)va);
4258         }
4259
4260         if (wired) {
4261                 if (pte_pv) {
4262                         atomic_add_long(&pte_pv->pv_pmap->pm_stats.wired_count,
4263                                         1);
4264                 } else {
4265                         atomic_add_long(&pmap->pm_stats.wired_count, 1);
4266                 }
4267         }
4268         if (newpte & pmap->pmap_bits[PG_RW_IDX])
4269                 vm_page_flag_set(m, PG_WRITEABLE);
4270
4271         /*
4272          * Unmanaged pages need manual resident_count tracking.
4273          */
4274         if (pte_pv == NULL && pt_pv)
4275                 atomic_add_long(&pt_pv->pv_pmap->pm_stats.resident_count, 1);
4276
4277         /*
4278          * Cleanup
4279          */
4280 done:
4281         KKASSERT((newpte & pmap->pmap_bits[PG_MANAGED_IDX]) == 0 ||
4282                  (m->flags & PG_MAPPED));
4283
4284         /*
4285          * Cleanup the pv entry, allowing other accessors.
4286          */
4287         if (pte_pv)
4288                 pv_put(pte_pv);
4289         if (pt_pv)
4290                 pv_put(pt_pv);
4291 }
4292
4293 /*
4294  * This code works like pmap_enter() but assumes VM_PROT_READ and not-wired.
4295  * This code also assumes that the pmap has no pre-existing entry for this
4296  * VA.
4297  *
4298  * This code currently may only be used on user pmaps, not kernel_pmap.
4299  */
4300 void
4301 pmap_enter_quick(pmap_t pmap, vm_offset_t va, vm_page_t m)
4302 {
4303         pmap_enter(pmap, va, m, VM_PROT_READ, FALSE, NULL);
4304 }
4305
4306 /*
4307  * Make a temporary mapping for a physical address.  This is only intended
4308  * to be used for panic dumps.
4309  *
4310  * The caller is responsible for calling smp_invltlb().
4311  */
4312 void *
4313 pmap_kenter_temporary(vm_paddr_t pa, long i)
4314 {
4315         pmap_kenter_quick((vm_offset_t)crashdumpmap + (i * PAGE_SIZE), pa);
4316         return ((void *)crashdumpmap);
4317 }
4318
4319 #define MAX_INIT_PT (96)
4320
4321 /*
4322  * This routine preloads the ptes for a given object into the specified pmap.
4323  * This eliminates the blast of soft faults on process startup and
4324  * immediately after an mmap.
4325  */
4326 static int pmap_object_init_pt_callback(vm_page_t p, void *data);
4327
4328 void
4329 pmap_object_init_pt(pmap_t pmap, vm_offset_t addr, vm_prot_t prot,
4330                     vm_object_t object, vm_pindex_t pindex,
4331                     vm_size_t size, int limit)
4332 {
4333         struct rb_vm_page_scan_info info;
4334         struct lwp *lp;
4335         vm_size_t psize;
4336
4337         /*
4338          * We can't preinit if read access isn't set or there is no pmap
4339          * or object.
4340          */
4341         if ((prot & VM_PROT_READ) == 0 || pmap == NULL || object == NULL)
4342                 return;
4343
4344         /*
4345          * We can't preinit if the pmap is not the current pmap
4346          */
4347         lp = curthread->td_lwp;
4348         if (lp == NULL || pmap != vmspace_pmap(lp->lwp_vmspace))
4349                 return;
4350
4351         /*
4352          * Misc additional checks
4353          */
4354         psize = x86_64_btop(size);
4355
4356         if ((object->type != OBJT_VNODE) ||
4357                 ((limit & MAP_PREFAULT_PARTIAL) && (psize > MAX_INIT_PT) &&
4358                         (object->resident_page_count > MAX_INIT_PT))) {
4359                 return;
4360         }
4361
4362         if (pindex + psize > object->size) {
4363                 if (object->size < pindex)
4364                         return;
4365                 psize = object->size - pindex;
4366         }
4367
4368         if (psize == 0)
4369                 return;
4370
4371         /*
4372          * If everything is segment-aligned do not pre-init here.  Instead
4373          * allow the normal vm_fault path to pass a segment hint to
4374          * pmap_enter() which will then use an object-referenced shared
4375          * page table page.
4376          */
4377         if ((addr & SEG_MASK) == 0 &&
4378             (ctob(psize) & SEG_MASK) == 0 &&
4379             (ctob(pindex) & SEG_MASK) == 0) {
4380                 return;
4381         }
4382
4383         /*
4384          * Use a red-black scan to traverse the requested range and load
4385          * any valid pages found into the pmap.
4386          *
4387          * We cannot safely scan the object's memq without holding the
4388          * object token.
4389          */
4390         info.start_pindex = pindex;
4391         info.end_pindex = pindex + psize - 1;
4392         info.limit = limit;
4393         info.mpte = NULL;
4394         info.addr = addr;
4395         info.pmap = pmap;
4396
4397         vm_object_hold_shared(object);
4398         vm_page_rb_tree_RB_SCAN(&object->rb_memq, rb_vm_page_scancmp,
4399                                 pmap_object_init_pt_callback, &info);
4400         vm_object_drop(object);
4401 }
4402
4403 static
4404 int
4405 pmap_object_init_pt_callback(vm_page_t p, void *data)
4406 {
4407         struct rb_vm_page_scan_info *info = data;
4408         vm_pindex_t rel_index;
4409
4410         /*
4411          * don't allow an madvise to blow away our really
4412          * free pages allocating pv entries.
4413          */
4414         if ((info->limit & MAP_PREFAULT_MADVISE) &&
4415                 vmstats.v_free_count < vmstats.v_free_reserved) {
4416                     return(-1);
4417         }
4418
4419         /*
4420          * Ignore list markers and ignore pages we cannot instantly
4421          * busy (while holding the object token).
4422          */
4423         if (p->flags & PG_MARKER)
4424                 return 0;
4425         if (vm_page_busy_try(p, TRUE))
4426                 return 0;
4427         if (((p->valid & VM_PAGE_BITS_ALL) == VM_PAGE_BITS_ALL) &&
4428             (p->flags & PG_FICTITIOUS) == 0) {
4429                 if ((p->queue - p->pc) == PQ_CACHE)
4430                         vm_page_deactivate(p);
4431                 rel_index = p->pindex - info->start_pindex;
4432                 pmap_enter_quick(info->pmap,
4433                                  info->addr + x86_64_ptob(rel_index), p);
4434         }
4435         vm_page_wakeup(p);
4436         lwkt_yield();
4437         return(0);
4438 }
4439
4440 /*
4441  * Return TRUE if the pmap is in shape to trivially pre-fault the specified
4442  * address.
4443  *
4444  * Returns FALSE if it would be non-trivial or if a pte is already loaded
4445  * into the slot.
4446  *
4447  * XXX This is safe only because page table pages are not freed.
4448  */
4449 int
4450 pmap_prefault_ok(pmap_t pmap, vm_offset_t addr)
4451 {
4452         pt_entry_t *pte;
4453
4454         /*spin_lock(&pmap->pm_spin);*/
4455         if ((pte = pmap_pte(pmap, addr)) != NULL) {
4456                 if (*pte & pmap->pmap_bits[PG_V_IDX]) {
4457                         /*spin_unlock(&pmap->pm_spin);*/
4458                         return FALSE;
4459                 }
4460         }
4461         /*spin_unlock(&pmap->pm_spin);*/
4462         return TRUE;
4463 }
4464
4465 /*
4466  * Change the wiring attribute for a pmap/va pair.  The mapping must already
4467  * exist in the pmap.  The mapping may or may not be managed.
4468  */
4469 void
4470 pmap_change_wiring(pmap_t pmap, vm_offset_t va, boolean_t wired,
4471                    vm_map_entry_t entry)
4472 {
4473         pt_entry_t *ptep;
4474         pv_entry_t pv;
4475
4476         if (pmap == NULL)
4477                 return;
4478         lwkt_gettoken(&pmap->pm_token);
4479         pv = pmap_allocpte_seg(pmap, pmap_pt_pindex(va), NULL, entry, va);
4480         ptep = pv_pte_lookup(pv, pmap_pte_index(va));
4481
4482         if (wired && !pmap_pte_w(pmap, ptep))
4483                 atomic_add_long(&pv->pv_pmap->pm_stats.wired_count, 1);
4484         else if (!wired && pmap_pte_w(pmap, ptep))
4485                 atomic_add_long(&pv->pv_pmap->pm_stats.wired_count, -1);
4486
4487         /*
4488          * Wiring is not a hardware characteristic so there is no need to
4489          * invalidate TLB.  However, in an SMP environment we must use
4490          * a locked bus cycle to update the pte (if we are not using
4491          * the pmap_inval_*() API that is)... it's ok to do this for simple
4492          * wiring changes.
4493          */
4494         if (wired)
4495                 atomic_set_long(ptep, pmap->pmap_bits[PG_W_IDX]);
4496         else
4497                 atomic_clear_long(ptep, pmap->pmap_bits[PG_W_IDX]);
4498         pv_put(pv);
4499         lwkt_reltoken(&pmap->pm_token);
4500 }
4501
4502
4503
4504 /*
4505  * Copy the range specified by src_addr/len from the source map to
4506  * the range dst_addr/len in the destination map.
4507  *
4508  * This routine is only advisory and need not do anything.
4509  */
4510 void
4511 pmap_copy(pmap_t dst_pmap, pmap_t src_pmap, vm_offset_t dst_addr,
4512           vm_size_t len, vm_offset_t src_addr)
4513 {
4514 }
4515
4516 /*
4517  * pmap_zero_page:
4518  *
4519  *      Zero the specified physical page.
4520  *
4521  *      This function may be called from an interrupt and no locking is
4522  *      required.
4523  */
4524 void
4525 pmap_zero_page(vm_paddr_t phys)
4526 {
4527         vm_offset_t va = PHYS_TO_DMAP(phys);
4528
4529         pagezero((void *)va);
4530 }
4531
4532 /*
4533  * pmap_page_assertzero:
4534  *
4535  *      Assert that a page is empty, panic if it isn't.
4536  */
4537 void
4538 pmap_page_assertzero(vm_paddr_t phys)
4539 {
4540         vm_offset_t va = PHYS_TO_DMAP(phys);
4541         size_t i;
4542
4543         for (i = 0; i < PAGE_SIZE; i += sizeof(long)) {
4544                 if (*(long *)((char *)va + i) != 0) {
4545                         panic("pmap_page_assertzero() @ %p not zero!",
4546                               (void *)(intptr_t)va);
4547                 }
4548         }
4549 }
4550
4551 /*
4552  * pmap_zero_page:
4553  *
4554  *      Zero part of a physical page by mapping it into memory and clearing
4555  *      its contents with bzero.
4556  *
4557  *      off and size may not cover an area beyond a single hardware page.
4558  */
4559 void
4560 pmap_zero_page_area(vm_paddr_t phys, int off, int size)
4561 {
4562         vm_offset_t virt = PHYS_TO_DMAP(phys);
4563
4564         bzero((char *)virt + off, size);
4565 }
4566
4567 /*
4568  * pmap_copy_page:
4569  *
4570  *      Copy the physical page from the source PA to the target PA.
4571  *      This function may be called from an interrupt.  No locking
4572  *      is required.
4573  */
4574 void
4575 pmap_copy_page(vm_paddr_t src, vm_paddr_t dst)
4576 {
4577         vm_offset_t src_virt, dst_virt;
4578
4579         src_virt = PHYS_TO_DMAP(src);
4580         dst_virt = PHYS_TO_DMAP(dst);
4581         bcopy((void *)src_virt, (void *)dst_virt, PAGE_SIZE);
4582 }
4583
4584 /*
4585  * pmap_copy_page_frag:
4586  *
4587  *      Copy the physical page from the source PA to the target PA.
4588  *      This function may be called from an interrupt.  No locking
4589  *      is required.
4590  */
4591 void
4592 pmap_copy_page_frag(vm_paddr_t src, vm_paddr_t dst, size_t bytes)
4593 {
4594         vm_offset_t src_virt, dst_virt;
4595
4596         src_virt = PHYS_TO_DMAP(src);
4597         dst_virt = PHYS_TO_DMAP(dst);
4598
4599         bcopy((char *)src_virt + (src & PAGE_MASK),
4600               (char *)dst_virt + (dst & PAGE_MASK),
4601               bytes);
4602 }
4603
4604 /*
4605  * Returns true if the pmap's pv is one of the first 16 pvs linked to from
4606  * this page.  This count may be changed upwards or downwards in the future;
4607  * it is only necessary that true be returned for a small subset of pmaps
4608  * for proper page aging.
4609  */
4610 boolean_t
4611 pmap_page_exists_quick(pmap_t pmap, vm_page_t m)
4612 {
4613         pv_entry_t pv;
4614         int loops = 0;
4615
4616         if (!pmap_initialized || (m->flags & PG_FICTITIOUS))
4617                 return FALSE;
4618
4619         vm_page_spin_lock(m);
4620         TAILQ_FOREACH(pv, &m->md.pv_list, pv_list) {
4621                 if (pv->pv_pmap == pmap) {
4622                         vm_page_spin_unlock(m);
4623                         return TRUE;
4624                 }
4625                 loops++;
4626                 if (loops >= 16)
4627                         break;
4628         }
4629         vm_page_spin_unlock(m);
4630         return (FALSE);
4631 }
4632
4633 /*
4634  * Remove all pages from specified address space this aids process exit
4635  * speeds.  Also, this code may be special cased for the current process
4636  * only.
4637  */
4638 void
4639 pmap_remove_pages(pmap_t pmap, vm_offset_t sva, vm_offset_t eva)
4640 {
4641         pmap_remove_noinval(pmap, sva, eva);
4642         cpu_invltlb();
4643 }
4644
4645 /*
4646  * pmap_testbit tests bits in pte's note that the testbit/clearbit
4647  * routines are inline, and a lot of things compile-time evaluate.
4648  */
4649 static
4650 boolean_t
4651 pmap_testbit(vm_page_t m, int bit)
4652 {
4653         pv_entry_t pv;
4654         pt_entry_t *pte;
4655         pmap_t pmap;
4656
4657         if (!pmap_initialized || (m->flags & PG_FICTITIOUS))
4658                 return FALSE;
4659
4660         if (TAILQ_FIRST(&m->md.pv_list) == NULL)
4661                 return FALSE;
4662         vm_page_spin_lock(m);
4663         if (TAILQ_FIRST(&m->md.pv_list) == NULL) {
4664                 vm_page_spin_unlock(m);
4665                 return FALSE;
4666         }
4667
4668         TAILQ_FOREACH(pv, &m->md.pv_list, pv_list) {
4669
4670 #if defined(PMAP_DIAGNOSTIC)
4671                 if (pv->pv_pmap == NULL) {
4672                         kprintf("Null pmap (tb) at pindex: %"PRIu64"\n",
4673                             pv->pv_pindex);
4674                         continue;
4675                 }
4676 #endif
4677                 pmap = pv->pv_pmap;
4678
4679                 /*
4680                  * If the bit being tested is the modified bit, then
4681                  * mark clean_map and ptes as never
4682                  * modified.
4683                  *
4684                  * WARNING!  Because we do not lock the pv, *pte can be in a
4685                  *           state of flux.  Despite this the value of *pte
4686                  *           will still be related to the vm_page in some way
4687                  *           because the pv cannot be destroyed as long as we
4688                  *           hold the vm_page spin lock.
4689                  */
4690                 if (bit == PG_A_IDX || bit == PG_M_IDX) {
4691                                 //& (pmap->pmap_bits[PG_A_IDX] | pmap->pmap_bits[PG_M_IDX])) {
4692                         if (!pmap_track_modified(pv->pv_pindex))
4693                                 continue;
4694                 }
4695
4696                 pte = pmap_pte_quick(pv->pv_pmap, pv->pv_pindex << PAGE_SHIFT);
4697                 if (*pte & pmap->pmap_bits[bit]) {
4698                         vm_page_spin_unlock(m);
4699                         return TRUE;
4700                 }
4701         }
4702         vm_page_spin_unlock(m);
4703         return (FALSE);
4704 }
4705
4706 /*
4707  * This routine is used to modify bits in ptes.  Only one bit should be
4708  * specified.  PG_RW requires special handling.
4709  *
4710  * Caller must NOT hold any spin locks
4711  */
4712 static __inline
4713 void
4714 pmap_clearbit(vm_page_t m, int bit_index)
4715 {
4716         pv_entry_t pv;
4717         pt_entry_t *pte;
4718         pt_entry_t pbits;
4719         pmap_t pmap;
4720
4721         if (bit_index == PG_RW_IDX)
4722                 vm_page_flag_clear(m, PG_WRITEABLE);
4723         if (!pmap_initialized || (m->flags & PG_FICTITIOUS)) {
4724                 return;
4725         }
4726
4727         /*
4728          * PG_M or PG_A case
4729          *
4730          * Loop over all current mappings setting/clearing as appropos If
4731          * setting RO do we need to clear the VAC?
4732          *
4733          * NOTE: When clearing PG_M we could also (not implemented) drop
4734          *       through to the PG_RW code and clear PG_RW too, forcing
4735          *       a fault on write to redetect PG_M for virtual kernels, but
4736          *       it isn't necessary since virtual kernels invalidate the
4737          *       pte when they clear the VPTE_M bit in their virtual page
4738          *       tables.
4739          *
4740          * NOTE: Does not re-dirty the page when clearing only PG_M.
4741          *
4742          * NOTE: Because we do not lock the pv, *pte can be in a state of
4743          *       flux.  Despite this the value of *pte is still somewhat
4744          *       related while we hold the vm_page spin lock.
4745          *
4746          *       *pte can be zero due to this race.  Since we are clearing
4747          *       bits we basically do no harm when this race  ccurs.
4748          */
4749         if (bit_index != PG_RW_IDX) {
4750                 vm_page_spin_lock(m);
4751                 TAILQ_FOREACH(pv, &m->md.pv_list, pv_list) {
4752 #if defined(PMAP_DIAGNOSTIC)
4753                         if (pv->pv_pmap == NULL) {
4754                                 kprintf("Null pmap (cb) at pindex: %"PRIu64"\n",
4755                                     pv->pv_pindex);
4756                                 continue;
4757                         }
4758 #endif
4759                         pmap = pv->pv_pmap;
4760                         pte = pmap_pte_quick(pv->pv_pmap,
4761                                              pv->pv_pindex << PAGE_SHIFT);
4762                         pbits = *pte;
4763                         if (pbits & pmap->pmap_bits[bit_index])
4764                                 atomic_clear_long(pte, pmap->pmap_bits[bit_index]);
4765                 }
4766                 vm_page_spin_unlock(m);
4767                 return;
4768         }
4769
4770         /*
4771          * Clear PG_RW.  Also clears PG_M and marks the page dirty if PG_M
4772          * was set.
4773          */
4774 restart:
4775         vm_page_spin_lock(m);
4776         TAILQ_FOREACH(pv, &m->md.pv_list, pv_list) {
4777                 /*
4778                  * don't write protect pager mappings
4779                  */
4780                 if (!pmap_track_modified(pv->pv_pindex))
4781                         continue;
4782
4783 #if defined(PMAP_DIAGNOSTIC)
4784                 if (pv->pv_pmap == NULL) {
4785                         kprintf("Null pmap (cb) at pindex: %"PRIu64"\n",
4786                             pv->pv_pindex);
4787                         continue;
4788                 }
4789 #endif
4790                 pmap = pv->pv_pmap;
4791                 /*
4792                  * Skip pages which do not have PG_RW set.
4793                  */
4794                 pte = pmap_pte_quick(pv->pv_pmap, pv->pv_pindex << PAGE_SHIFT);
4795                 if ((*pte & pmap->pmap_bits[PG_RW_IDX]) == 0)
4796                         continue;
4797
4798                 /*
4799                  * Lock the PV
4800                  */
4801                 if (pv_hold_try(pv)) {
4802                         vm_page_spin_unlock(m);
4803                 } else {
4804                         vm_page_spin_unlock(m);
4805                         pv_lock(pv);    /* held, now do a blocking lock */
4806                 }
4807                 if (pv->pv_pmap != pmap || pv->pv_m != m) {
4808                         pv_put(pv);     /* and release */
4809                         goto restart;   /* anything could have happened */
4810                 }
4811                 KKASSERT(pv->pv_pmap == pmap);
4812                 for (;;) {
4813                         pt_entry_t nbits;
4814
4815                         pbits = *pte;
4816                         cpu_ccfence();
4817                         nbits = pbits & ~(pmap->pmap_bits[PG_RW_IDX] |
4818                                           pmap->pmap_bits[PG_M_IDX]);
4819                         if (pmap_inval_smp_cmpset(pmap,
4820                                      ((vm_offset_t)pv->pv_pindex << PAGE_SHIFT),
4821                                      pte, pbits, nbits)) {
4822                                 break;
4823                         }
4824                         cpu_pause();
4825                 }
4826                 vm_page_spin_lock(m);
4827
4828                 /*
4829                  * If PG_M was found to be set while we were clearing PG_RW
4830                  * we also clear PG_M (done above) and mark the page dirty.
4831                  * Callers expect this behavior.
4832                  */
4833                 if (pbits & pmap->pmap_bits[PG_M_IDX])
4834                         vm_page_dirty(m);
4835                 pv_put(pv);
4836         }
4837         vm_page_spin_unlock(m);
4838 }
4839
4840 /*
4841  * Lower the permission for all mappings to a given page.
4842  *
4843  * Page must be busied by caller.  Because page is busied by caller this
4844  * should not be able to race a pmap_enter().
4845  */
4846 void
4847 pmap_page_protect(vm_page_t m, vm_prot_t prot)
4848 {
4849         /* JG NX support? */
4850         if ((prot & VM_PROT_WRITE) == 0) {
4851                 if (prot & (VM_PROT_READ | VM_PROT_EXECUTE)) {
4852                         /*
4853                          * NOTE: pmap_clearbit(.. PG_RW) also clears
4854                          *       the PG_WRITEABLE flag in (m).
4855                          */
4856                         pmap_clearbit(m, PG_RW_IDX);
4857                 } else {
4858                         pmap_remove_all(m);
4859                 }
4860         }
4861 }
4862
4863 vm_paddr_t
4864 pmap_phys_address(vm_pindex_t ppn)
4865 {
4866         return (x86_64_ptob(ppn));
4867 }
4868
4869 /*
4870  * Return a count of reference bits for a page, clearing those bits.
4871  * It is not necessary for every reference bit to be cleared, but it
4872  * is necessary that 0 only be returned when there are truly no
4873  * reference bits set.
4874  *
4875  * XXX: The exact number of bits to check and clear is a matter that
4876  * should be tested and standardized at some point in the future for
4877  * optimal aging of shared pages.
4878  *
4879  * This routine may not block.
4880  */
4881 int
4882 pmap_ts_referenced(vm_page_t m)
4883 {
4884         pv_entry_t pv;
4885         pt_entry_t *pte;
4886         pmap_t pmap;
4887         int rtval = 0;
4888
4889         if (!pmap_initialized || (m->flags & PG_FICTITIOUS))
4890                 return (rtval);
4891
4892         vm_page_spin_lock(m);
4893         TAILQ_FOREACH(pv, &m->md.pv_list, pv_list) {
4894                 if (!pmap_track_modified(pv->pv_pindex))
4895                         continue;
4896                 pmap = pv->pv_pmap;
4897                 pte = pmap_pte_quick(pv->pv_pmap, pv->pv_pindex << PAGE_SHIFT);
4898                 if (pte && (*pte & pmap->pmap_bits[PG_A_IDX])) {
4899                         atomic_clear_long(pte, pmap->pmap_bits[PG_A_IDX]);
4900                         rtval++;
4901                         if (rtval > 4)
4902                                 break;
4903                 }
4904         }
4905         vm_page_spin_unlock(m);
4906         return (rtval);
4907 }
4908
4909 /*
4910  *      pmap_is_modified:
4911  *
4912  *      Return whether or not the specified physical page was modified
4913  *      in any physical maps.
4914  */
4915 boolean_t
4916 pmap_is_modified(vm_page_t m)
4917 {
4918         boolean_t res;
4919
4920         res = pmap_testbit(m, PG_M_IDX);
4921         return (res);
4922 }
4923
4924 /*
4925  *      Clear the modify bits on the specified physical page.
4926  */
4927 void
4928 pmap_clear_modify(vm_page_t m)
4929 {
4930         pmap_clearbit(m, PG_M_IDX);
4931 }
4932
4933 /*
4934  *      pmap_clear_reference:
4935  *
4936  *      Clear the reference bit on the specified physical page.
4937  */
4938 void
4939 pmap_clear_reference(vm_page_t m)
4940 {
4941         pmap_clearbit(m, PG_A_IDX);
4942 }
4943
4944 /*
4945  * Miscellaneous support routines follow
4946  */
4947
4948 static
4949 void
4950 i386_protection_init(void)
4951 {
4952         int *kp, prot;
4953
4954         /* JG NX support may go here; No VM_PROT_EXECUTE ==> set NX bit  */
4955         kp = protection_codes;
4956         for (prot = 0; prot < PROTECTION_CODES_SIZE; prot++) {
4957                 switch (prot) {
4958                 case VM_PROT_NONE | VM_PROT_NONE | VM_PROT_NONE:
4959                         /*
4960                          * Read access is also 0. There isn't any execute bit,
4961                          * so just make it readable.
4962                          */
4963                 case VM_PROT_READ | VM_PROT_NONE | VM_PROT_NONE:
4964                 case VM_PROT_READ | VM_PROT_NONE | VM_PROT_EXECUTE:
4965                 case VM_PROT_NONE | VM_PROT_NONE | VM_PROT_EXECUTE:
4966                         *kp++ = 0;
4967                         break;
4968                 case VM_PROT_NONE | VM_PROT_WRITE | VM_PROT_NONE:
4969                 case VM_PROT_NONE | VM_PROT_WRITE | VM_PROT_EXECUTE:
4970                 case VM_PROT_READ | VM_PROT_WRITE | VM_PROT_NONE:
4971                 case VM_PROT_READ | VM_PROT_WRITE | VM_PROT_EXECUTE:
4972                         *kp++ = pmap_bits_default[PG_RW_IDX];
4973                         break;
4974                 }
4975         }
4976 }
4977
4978 /*
4979  * Map a set of physical memory pages into the kernel virtual
4980  * address space. Return a pointer to where it is mapped. This
4981  * routine is intended to be used for mapping device memory,
4982  * NOT real memory.
4983  *
4984  * NOTE: We can't use pgeflag unless we invalidate the pages one at
4985  *       a time.
4986  *
4987  * NOTE: The PAT attributes {WRITE_BACK, WRITE_THROUGH, UNCACHED, UNCACHEABLE}
4988  *       work whether the cpu supports PAT or not.  The remaining PAT
4989  *       attributes {WRITE_PROTECTED, WRITE_COMBINING} only work if the cpu
4990  *       supports PAT.
4991  */
4992 void *
4993 pmap_mapdev(vm_paddr_t pa, vm_size_t size)
4994 {
4995         return(pmap_mapdev_attr(pa, size, PAT_WRITE_BACK));
4996 }
4997
4998 void *
4999 pmap_mapdev_uncacheable(vm_paddr_t pa, vm_size_t size)
5000 {
5001         return(pmap_mapdev_attr(pa, size, PAT_UNCACHEABLE));
5002 }
5003
5004 void *
5005 pmap_mapbios(vm_paddr_t pa, vm_size_t size)
5006 {
5007         return (pmap_mapdev_attr(pa, size, PAT_WRITE_BACK));
5008 }
5009
5010 /*
5011  * Map a set of physical memory pages into the kernel virtual
5012  * address space. Return a pointer to where it is mapped. This
5013  * routine is intended to be used for mapping device memory,
5014  * NOT real memory.
5015  */
5016 void *
5017 pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, int mode)
5018 {
5019         vm_offset_t va, tmpva, offset;
5020         pt_entry_t *pte;
5021         vm_size_t tmpsize;
5022
5023         offset = pa & PAGE_MASK;
5024         size = roundup(offset + size, PAGE_SIZE);
5025
5026         va = kmem_alloc_nofault(&kernel_map, size, PAGE_SIZE);
5027         if (va == 0)
5028                 panic("pmap_mapdev: Couldn't alloc kernel virtual memory");
5029
5030         pa = pa & ~PAGE_MASK;
5031         for (tmpva = va, tmpsize = size; tmpsize > 0;) {
5032                 pte = vtopte(tmpva);
5033                 *pte = pa |
5034                     kernel_pmap.pmap_bits[PG_RW_IDX] |
5035                     kernel_pmap.pmap_bits[PG_V_IDX] | /* pgeflag | */
5036                     kernel_pmap.pmap_cache_bits[mode];
5037                 tmpsize -= PAGE_SIZE;
5038                 tmpva += PAGE_SIZE;
5039                 pa += PAGE_SIZE;
5040         }
5041         pmap_invalidate_range(&kernel_pmap, va, va + size);
5042         pmap_invalidate_cache_range(va, va + size);
5043
5044         return ((void *)(va + offset));
5045 }
5046
5047 void
5048 pmap_unmapdev(vm_offset_t va, vm_size_t size)
5049 {
5050         vm_offset_t base, offset;
5051
5052         base = va & ~PAGE_MASK;
5053         offset = va & PAGE_MASK;
5054         size = roundup(offset + size, PAGE_SIZE);
5055         pmap_qremove(va, size >> PAGE_SHIFT);
5056         kmem_free(&kernel_map, base, size);
5057 }
5058
5059 /*
5060  * Sets the memory attribute for the specified page.
5061  */
5062 void
5063 pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma)
5064 {
5065
5066     m->pat_mode = ma;
5067
5068     /*
5069      * If "m" is a normal page, update its direct mapping.  This update
5070      * can be relied upon to perform any cache operations that are
5071      * required for data coherence.
5072      */
5073     if ((m->flags & PG_FICTITIOUS) == 0)
5074         pmap_change_attr(PHYS_TO_DMAP(VM_PAGE_TO_PHYS(m)), 1, m->pat_mode);
5075 }
5076
5077 /*
5078  * Change the PAT attribute on an existing kernel memory map.  Caller
5079  * must ensure that the virtual memory in question is not accessed
5080  * during the adjustment.
5081  */
5082 void
5083 pmap_change_attr(vm_offset_t va, vm_size_t count, int mode)
5084 {
5085         pt_entry_t *pte;
5086         vm_offset_t base;
5087         int changed = 0;
5088
5089         if (va == 0)
5090                 panic("pmap_change_attr: va is NULL");
5091         base = trunc_page(va);
5092
5093         while (count) {
5094                 pte = vtopte(va);
5095                 *pte = (*pte & ~(pt_entry_t)(kernel_pmap.pmap_cache_mask)) |
5096                        kernel_pmap.pmap_cache_bits[mode];
5097                 --count;
5098                 va += PAGE_SIZE;
5099         }
5100
5101         changed = 1;    /* XXX: not optimal */
5102
5103         /*
5104          * Flush CPU caches if required to make sure any data isn't cached that
5105          * shouldn't be, etc.
5106          */
5107         if (changed) {
5108                 pmap_invalidate_range(&kernel_pmap, base, va);
5109                 pmap_invalidate_cache_range(base, va);
5110         }
5111 }
5112
5113 /*
5114  * perform the pmap work for mincore
5115  */
5116 int
5117 pmap_mincore(pmap_t pmap, vm_offset_t addr)
5118 {
5119         pt_entry_t *ptep, pte;
5120         vm_page_t m;
5121         int val = 0;
5122
5123         lwkt_gettoken(&pmap->pm_token);
5124         ptep = pmap_pte(pmap, addr);
5125
5126         if (ptep && (pte = *ptep) != 0) {
5127                 vm_offset_t pa;
5128
5129                 val = MINCORE_INCORE;
5130                 if ((pte & pmap->pmap_bits[PG_MANAGED_IDX]) == 0)
5131                         goto done;
5132
5133                 pa = pte & PG_FRAME;
5134
5135                 if (pte & pmap->pmap_bits[PG_DEVICE_IDX])
5136                         m = NULL;
5137                 else
5138                         m = PHYS_TO_VM_PAGE(pa);
5139
5140                 /*
5141                  * Modified by us
5142                  */
5143                 if (pte & pmap->pmap_bits[PG_M_IDX])
5144                         val |= MINCORE_MODIFIED|MINCORE_MODIFIED_OTHER;
5145                 /*
5146                  * Modified by someone
5147                  */
5148                 else if (m && (m->dirty || pmap_is_modified(m)))
5149                         val |= MINCORE_MODIFIED_OTHER;
5150                 /*
5151                  * Referenced by us
5152                  */
5153                 if (pte & pmap->pmap_bits[PG_A_IDX])
5154                         val |= MINCORE_REFERENCED|MINCORE_REFERENCED_OTHER;
5155
5156                 /*
5157                  * Referenced by someone
5158                  */
5159                 else if (m && ((m->flags & PG_REFERENCED) ||
5160                                 pmap_ts_referenced(m))) {
5161                         val |= MINCORE_REFERENCED_OTHER;
5162                         vm_page_flag_set(m, PG_REFERENCED);
5163                 }
5164         }
5165 done:
5166         lwkt_reltoken(&pmap->pm_token);
5167
5168         return val;
5169 }
5170
5171 /*
5172  * Replace p->p_vmspace with a new one.  If adjrefs is non-zero the new
5173  * vmspace will be ref'd and the old one will be deref'd.
5174  *
5175  * The vmspace for all lwps associated with the process will be adjusted
5176  * and cr3 will be reloaded if any lwp is the current lwp.
5177  *
5178  * The process must hold the vmspace->vm_map.token for oldvm and newvm
5179  */
5180 void
5181 pmap_replacevm(struct proc *p, struct vmspace *newvm, int adjrefs)
5182 {
5183         struct vmspace *oldvm;
5184         struct lwp *lp;
5185
5186         oldvm = p->p_vmspace;
5187         if (oldvm != newvm) {
5188                 if (adjrefs)
5189                         vmspace_ref(newvm);
5190                 p->p_vmspace = newvm;
5191                 KKASSERT(p->p_nthreads == 1);
5192                 lp = RB_ROOT(&p->p_lwp_tree);
5193                 pmap_setlwpvm(lp, newvm);
5194                 if (adjrefs)
5195                         vmspace_rel(oldvm);
5196         }
5197 }
5198
5199 /*
5200  * Set the vmspace for a LWP.  The vmspace is almost universally set the
5201  * same as the process vmspace, but virtual kernels need to swap out contexts
5202  * on a per-lwp basis.
5203  *
5204  * Caller does not necessarily hold any vmspace tokens.  Caller must control
5205  * the lwp (typically be in the context of the lwp).  We use a critical
5206  * section to protect against statclock and hardclock (statistics collection).
5207  */
5208 void
5209 pmap_setlwpvm(struct lwp *lp, struct vmspace *newvm)
5210 {
5211         struct vmspace *oldvm;
5212         struct pmap *pmap;
5213
5214         oldvm = lp->lwp_vmspace;
5215
5216         if (oldvm != newvm) {
5217                 crit_enter();
5218                 lp->lwp_vmspace = newvm;
5219                 if (curthread->td_lwp == lp) {
5220                         pmap = vmspace_pmap(newvm);
5221                         ATOMIC_CPUMASK_ORBIT(pmap->pm_active, mycpu->gd_cpuid);
5222                         if (pmap->pm_active_lock & CPULOCK_EXCL)
5223                                 pmap_interlock_wait(newvm);
5224 #if defined(SWTCH_OPTIM_STATS)
5225                         tlb_flush_count++;
5226 #endif
5227                         if (pmap->pmap_bits[TYPE_IDX] == REGULAR_PMAP) {
5228                                 curthread->td_pcb->pcb_cr3 = vtophys(pmap->pm_pml4);
5229                         } else if (pmap->pmap_bits[TYPE_IDX] == EPT_PMAP) {
5230                                 curthread->td_pcb->pcb_cr3 = KPML4phys;
5231                         } else {
5232                                 panic("pmap_setlwpvm: unknown pmap type\n");
5233                         }
5234                         load_cr3(curthread->td_pcb->pcb_cr3);
5235                         pmap = vmspace_pmap(oldvm);
5236                         ATOMIC_CPUMASK_NANDBIT(pmap->pm_active,
5237                                                mycpu->gd_cpuid);
5238                 }
5239                 crit_exit();
5240         }
5241 }
5242
5243 /*
5244  * Called when switching to a locked pmap, used to interlock against pmaps
5245  * undergoing modifications to prevent us from activating the MMU for the
5246  * target pmap until all such modifications have completed.  We have to do
5247  * this because the thread making the modifications has already set up its
5248  * SMP synchronization mask.
5249  *
5250  * This function cannot sleep!
5251  *
5252  * No requirements.
5253  */
5254 void
5255 pmap_interlock_wait(struct vmspace *vm)
5256 {
5257         struct pmap *pmap = &vm->vm_pmap;
5258
5259         if (pmap->pm_active_lock & CPULOCK_EXCL) {
5260                 crit_enter();
5261                 KKASSERT(curthread->td_critcount >= 2);
5262                 DEBUG_PUSH_INFO("pmap_interlock_wait");
5263                 while (pmap->pm_active_lock & CPULOCK_EXCL) {
5264                         cpu_ccfence();
5265                         lwkt_process_ipiq();
5266                 }
5267                 DEBUG_POP_INFO();
5268                 crit_exit();
5269         }
5270 }
5271
5272 vm_offset_t
5273 pmap_addr_hint(vm_object_t obj, vm_offset_t addr, vm_size_t size)
5274 {
5275
5276         if ((obj == NULL) || (size < NBPDR) ||
5277             ((obj->type != OBJT_DEVICE) && (obj->type != OBJT_MGTDEVICE))) {
5278                 return addr;
5279         }
5280
5281         addr = roundup2(addr, NBPDR);
5282         return addr;
5283 }
5284
5285 /*
5286  * Used by kmalloc/kfree, page already exists at va
5287  */
5288 vm_page_t
5289 pmap_kvtom(vm_offset_t va)
5290 {
5291         pt_entry_t *ptep = vtopte(va);
5292
5293         KKASSERT((*ptep & kernel_pmap.pmap_bits[PG_DEVICE_IDX]) == 0);
5294         return(PHYS_TO_VM_PAGE(*ptep & PG_FRAME));
5295 }
5296
5297 /*
5298  * Initialize machine-specific shared page directory support.  This
5299  * is executed when a VM object is created.
5300  */
5301 void
5302 pmap_object_init(vm_object_t object)
5303 {
5304         object->md.pmap_rw = NULL;
5305         object->md.pmap_ro = NULL;
5306 }
5307
5308 /*
5309  * Clean up machine-specific shared page directory support.  This
5310  * is executed when a VM object is destroyed.
5311  */
5312 void
5313 pmap_object_free(vm_object_t object)
5314 {
5315         pmap_t pmap;
5316
5317         if ((pmap = object->md.pmap_rw) != NULL) {
5318                 object->md.pmap_rw = NULL;
5319                 pmap_remove_noinval(pmap,
5320                                   VM_MIN_USER_ADDRESS, VM_MAX_USER_ADDRESS);
5321                 CPUMASK_ASSZERO(pmap->pm_active);
5322                 pmap_release(pmap);
5323                 pmap_puninit(pmap);
5324                 kfree(pmap, M_OBJPMAP);
5325         }
5326         if ((pmap = object->md.pmap_ro) != NULL) {
5327                 object->md.pmap_ro = NULL;
5328                 pmap_remove_noinval(pmap,
5329                                   VM_MIN_USER_ADDRESS, VM_MAX_USER_ADDRESS);
5330                 CPUMASK_ASSZERO(pmap->pm_active);
5331                 pmap_release(pmap);
5332                 pmap_puninit(pmap);
5333                 kfree(pmap, M_OBJPMAP);
5334         }
5335 }