arch/x86/kvm/paging_tmpl.h

   1 /*
   2  * Kernel-based Virtual Machine driver for Linux
   3  *
   4  * This module enables machines with Intel VT-x extensions to run virtual
   5  * machines without emulation or binary translation.
   6  *
   7  * MMU support
   8  *
   9  * Copyright (C) 2006 Qumranet, Inc.
  10  * Copyright 2010 Red Hat, Inc. and/or its affiliates.
  11  *
  12  * Authors:
  13  *   Yaniv Kamay  <yaniv@qumranet.com>
  14  *   Avi Kivity   <avi@qumranet.com>
  15  *
  16  * This work is licensed under the terms of the GNU GPL, version 2.  See
  17  * the COPYING file in the top-level directory.
  18  *
  19  */
  20
  21 /*
  22  * We need the mmu code to access both 32-bit and 64-bit guest ptes,
  23  * so the code in this file is compiled twice, once per pte size.
  24  */
  25
  26 #if PTTYPE == 64
  27         #define pt_element_t u64
  28         #define guest_walker guest_walker64
  29         #define FNAME(name) paging##64_##name
  30         #define PT_BASE_ADDR_MASK PT64_BASE_ADDR_MASK
  31         #define PT_LVL_ADDR_MASK(lvl) PT64_LVL_ADDR_MASK(lvl)
  32         #define PT_LVL_OFFSET_MASK(lvl) PT64_LVL_OFFSET_MASK(lvl)
  33         #define PT_INDEX(addr, level) PT64_INDEX(addr, level)
  34         #define PT_LEVEL_BITS PT64_LEVEL_BITS
  35         #define PT_GUEST_DIRTY_SHIFT PT_DIRTY_SHIFT
  36         #define PT_GUEST_ACCESSED_SHIFT PT_ACCESSED_SHIFT
  37         #define PT_HAVE_ACCESSED_DIRTY(mmu) true
  38         #ifdef CONFIG_X86_64
  39         #define PT_MAX_FULL_LEVELS 4
  40         #define CMPXCHG cmpxchg
  41         #else
  42         #define CMPXCHG cmpxchg64
  43         #define PT_MAX_FULL_LEVELS 2
  44         #endif
  45 #elif PTTYPE == 32
  46         #define pt_element_t u32
  47         #define guest_walker guest_walker32
  48         #define FNAME(name) paging##32_##name
  49         #define PT_BASE_ADDR_MASK PT32_BASE_ADDR_MASK
  50         #define PT_LVL_ADDR_MASK(lvl) PT32_LVL_ADDR_MASK(lvl)
  51         #define PT_LVL_OFFSET_MASK(lvl) PT32_LVL_OFFSET_MASK(lvl)
  52         #define PT_INDEX(addr, level) PT32_INDEX(addr, level)
  53         #define PT_LEVEL_BITS PT32_LEVEL_BITS
  54         #define PT_MAX_FULL_LEVELS 2
  55         #define PT_GUEST_DIRTY_SHIFT PT_DIRTY_SHIFT
  56         #define PT_GUEST_ACCESSED_SHIFT PT_ACCESSED_SHIFT
  57         #define PT_HAVE_ACCESSED_DIRTY(mmu) true
  58         #define CMPXCHG cmpxchg
  59 #elif PTTYPE == PTTYPE_EPT
  60         #define pt_element_t u64
  61         #define guest_walker guest_walkerEPT
  62         #define FNAME(name) ept_##name
  63         #define PT_BASE_ADDR_MASK PT64_BASE_ADDR_MASK
  64         #define PT_LVL_ADDR_MASK(lvl) PT64_LVL_ADDR_MASK(lvl)
  65         #define PT_LVL_OFFSET_MASK(lvl) PT64_LVL_OFFSET_MASK(lvl)
  66         #define PT_INDEX(addr, level) PT64_INDEX(addr, level)
  67         #define PT_LEVEL_BITS PT64_LEVEL_BITS
  68         #define PT_GUEST_DIRTY_SHIFT 9
  69         #define PT_GUEST_ACCESSED_SHIFT 8
  70         #define PT_HAVE_ACCESSED_DIRTY(mmu) ((mmu)->ept_ad)
  71         #define CMPXCHG cmpxchg64
  72         #define PT_MAX_FULL_LEVELS 4
  73 #else
  74         #error Invalid PTTYPE value
  75 #endif
  76
  77 #define PT_GUEST_DIRTY_MASK    (1 << PT_GUEST_DIRTY_SHIFT)
  78 #define PT_GUEST_ACCESSED_MASK (1 << PT_GUEST_ACCESSED_SHIFT)
  79
  80 #define gpte_to_gfn_lvl FNAME(gpte_to_gfn_lvl)
  81 #define gpte_to_gfn(pte) gpte_to_gfn_lvl((pte), PT_PAGE_TABLE_LEVEL)
  82
  83 /*
  84  * The guest_walker structure emulates the behavior of the hardware page
  85  * table walker.
  86  */
  87 struct guest_walker {
  88         int level;
  89         unsigned max_level;
  90         gfn_t table_gfn[PT_MAX_FULL_LEVELS];
  91         pt_element_t ptes[PT_MAX_FULL_LEVELS];
  92         pt_element_t prefetch_ptes[PTE_PREFETCH_NUM];
  93         gpa_t pte_gpa[PT_MAX_FULL_LEVELS];
  94         pt_element_t __user *ptep_user[PT_MAX_FULL_LEVELS];
  95         bool pte_writable[PT_MAX_FULL_LEVELS];
  96         unsigned pt_access;
  97         unsigned pte_access;
  98         gfn_t gfn;
  99         struct x86_exception fault;
 100 };
 101
 102 static gfn_t gpte_to_gfn_lvl(pt_element_t gpte, int lvl)
 103 {
 104         return (gpte & PT_LVL_ADDR_MASK(lvl)) >> PAGE_SHIFT;
 105 }
 106
 107 static inline void FNAME(protect_clean_gpte)(struct kvm_mmu *mmu, unsigned *access,
 108                                              unsigned gpte)
 109 {
 110         unsigned mask;
 111
 112         /* dirty bit is not supported, so no need to track it */
 113         if (!PT_HAVE_ACCESSED_DIRTY(mmu))
 114                 return;
 115
 116         BUILD_BUG_ON(PT_WRITABLE_MASK != ACC_WRITE_MASK);
 117
 118         mask = (unsigned)~ACC_WRITE_MASK;
 119         /* Allow write access to dirty gptes */
 120         mask |= (gpte >> (PT_GUEST_DIRTY_SHIFT - PT_WRITABLE_SHIFT)) &
 121                 PT_WRITABLE_MASK;
 122         *access &= mask;
 123 }
 124
 125 static inline int FNAME(is_present_gpte)(unsigned long pte)
 126 {
 127 #if PTTYPE != PTTYPE_EPT
 128         return pte & PT_PRESENT_MASK;
 129 #else
 130         return pte & 7;
 131 #endif
 132 }
 133
 134 static int FNAME(cmpxchg_gpte)(struct kvm_vcpu *vcpu, struct kvm_mmu *mmu,
 135                                pt_element_t __user *ptep_user, unsigned index,
 136                                pt_element_t orig_pte, pt_element_t new_pte)
 137 {
 138         int npages;
 139         pt_element_t ret;
 140         pt_element_t *table;
 141         struct page *page;
 142
 143         npages = get_user_pages_fast((unsigned long)ptep_user, 1, 1, &page);
 144         /* Check if the user is doing something meaningless. */
 145         if (unlikely(npages != 1))
 146                 return -EFAULT;
 147
 148         table = kmap_atomic(page);
 149         ret = CMPXCHG(&table[index], orig_pte, new_pte);
 150         kunmap_atomic(table);
 151
 152         kvm_release_page_dirty(page);
 153
 154         return (ret != orig_pte);
 155 }
 156
 157 static bool FNAME(prefetch_invalid_gpte)(struct kvm_vcpu *vcpu,
 158                                   struct kvm_mmu_page *sp, u64 *spte,
 159                                   u64 gpte)
 160 {
 161         if (is_rsvd_bits_set(&vcpu->arch.mmu, gpte, PT_PAGE_TABLE_LEVEL))
 162                 goto no_present;
 163
 164         if (!FNAME(is_present_gpte)(gpte))
 165                 goto no_present;
 166
 167         /* if accessed bit is not supported prefetch non accessed gpte */
 168         if (PT_HAVE_ACCESSED_DIRTY(&vcpu->arch.mmu) && !(gpte & PT_GUEST_ACCESSED_MASK))
 169                 goto no_present;
 170
 171         return false;
 172
 173 no_present:
 174         drop_spte(vcpu->kvm, spte);
 175         return true;
 176 }
 177
 178 /*
 179  * For PTTYPE_EPT, a page table can be executable but not readable
 180  * on supported processors. Therefore, set_spte does not automatically
 181  * set bit 0 if execute only is supported. Here, we repurpose ACC_USER_MASK
 182  * to signify readability since it isn't used in the EPT case
 183  */
 184 static inline unsigned FNAME(gpte_access)(struct kvm_vcpu *vcpu, u64 gpte)
 185 {
 186         unsigned access;
 187 #if PTTYPE == PTTYPE_EPT
 188         access = ((gpte & VMX_EPT_WRITABLE_MASK) ? ACC_WRITE_MASK : 0) |
 189                 ((gpte & VMX_EPT_EXECUTABLE_MASK) ? ACC_EXEC_MASK : 0) |
 190                 ((gpte & VMX_EPT_READABLE_MASK) ? ACC_USER_MASK : 0);
 191 #else
 192         BUILD_BUG_ON(ACC_EXEC_MASK != PT_PRESENT_MASK);
 193         BUILD_BUG_ON(ACC_EXEC_MASK != 1);
 194         access = gpte & (PT_WRITABLE_MASK | PT_USER_MASK | PT_PRESENT_MASK);
 195         /* Combine NX with P (which is set here) to get ACC_EXEC_MASK.  */
 196         access ^= (gpte >> PT64_NX_SHIFT);
 197 #endif
 198
 199         return access;
 200 }
 201
 202 static int FNAME(update_accessed_dirty_bits)(struct kvm_vcpu *vcpu,
 203                                              struct kvm_mmu *mmu,
 204                                              struct guest_walker *walker,
 205                                              int write_fault)
 206 {
 207         unsigned level, index;
 208         pt_element_t pte, orig_pte;
 209         pt_element_t __user *ptep_user;
 210         gfn_t table_gfn;
 211         int ret;
 212
 213         /* dirty/accessed bits are not supported, so no need to update them */
 214         if (!PT_HAVE_ACCESSED_DIRTY(mmu))
 215                 return 0;
 216
 217         for (level = walker->max_level; level >= walker->level; --level) {
 218                 pte = orig_pte = walker->ptes[level - 1];
 219                 table_gfn = walker->table_gfn[level - 1];
 220                 ptep_user = walker->ptep_user[level - 1];
 221                 index = offset_in_page(ptep_user) / sizeof(pt_element_t);
 222                 if (!(pte & PT_GUEST_ACCESSED_MASK)) {
 223                         trace_kvm_mmu_set_accessed_bit(table_gfn, index, sizeof(pte));
 224                         pte |= PT_GUEST_ACCESSED_MASK;
 225                 }
 226                 if (level == walker->level && write_fault &&
 227                                 !(pte & PT_GUEST_DIRTY_MASK)) {
 228                         trace_kvm_mmu_set_dirty_bit(table_gfn, index, sizeof(pte));
 229 #if PTTYPE == PTTYPE_EPT
 230                         if (kvm_arch_write_log_dirty(vcpu))
 231                                 return -EINVAL;
 232 #endif
 233                         pte |= PT_GUEST_DIRTY_MASK;
 234                 }
 235                 if (pte == orig_pte)
 236                         continue;
 237
 238                 /*
 239                  * If the slot is read-only, simply do not process the accessed
 240                  * and dirty bits.  This is the correct thing to do if the slot
 241                  * is ROM, and page tables in read-as-ROM/write-as-MMIO slots
 242                  * are only supported if the accessed and dirty bits are already
 243                  * set in the ROM (so that MMIO writes are never needed).
 244                  *
 245                  * Note that NPT does not allow this at all and faults, since
 246                  * it always wants nested page table entries for the guest
 247                  * page tables to be writable.  And EPT works but will simply
 248                  * overwrite the read-only memory to set the accessed and dirty
 249                  * bits.
 250                  */
 251                 if (unlikely(!walker->pte_writable[level - 1]))
 252                         continue;
 253
 254                 ret = FNAME(cmpxchg_gpte)(vcpu, mmu, ptep_user, index, orig_pte, pte);
 255                 if (ret)
 256                         return ret;
 257
 258                 kvm_vcpu_mark_page_dirty(vcpu, table_gfn);
 259                 walker->ptes[level - 1] = pte;
 260         }
 261         return 0;
 262 }
 263
 264 static inline unsigned FNAME(gpte_pkeys)(struct kvm_vcpu *vcpu, u64 gpte)
 265 {
 266         unsigned pkeys = 0;
 267 #if PTTYPE == 64
 268         pte_t pte = {.pte = gpte};
 269
 270         pkeys = pte_flags_pkey(pte_flags(pte));
 271 #endif
 272         return pkeys;
 273 }
 274
 275 /*
 276  * Fetch a guest pte for a guest virtual address
 277  */
 278 static int FNAME(walk_addr_generic)(struct guest_walker *walker,
 279                                     struct kvm_vcpu *vcpu, struct kvm_mmu *mmu,
 280                                     gva_t addr, u32 access)
 281 {
 282         int ret;
 283         pt_element_t pte;
 284         pt_element_t __user *uninitialized_var(ptep_user);
 285         gfn_t table_gfn;
 286         u64 pt_access, pte_access;
 287         unsigned index, accessed_dirty, pte_pkey;
 288         unsigned nested_access;
 289         gpa_t pte_gpa;
 290         bool have_ad;
 291         int offset;
 292         u64 walk_nx_mask = 0;
 293         const int write_fault = access & PFERR_WRITE_MASK;
 294         const int user_fault  = access & PFERR_USER_MASK;
 295         const int fetch_fault = access & PFERR_FETCH_MASK;
 296         u16 errcode = 0;
 297         gpa_t real_gpa;
 298         gfn_t gfn;
 299
 300         trace_kvm_mmu_pagetable_walk(addr, access);
 301 retry_walk:
 302         walker->level = mmu->root_level;
 303         pte           = mmu->get_cr3(vcpu);
 304         have_ad       = PT_HAVE_ACCESSED_DIRTY(mmu);
 305
 306 #if PTTYPE == 64
 307         walk_nx_mask = 1ULL << PT64_NX_SHIFT;
 308         if (walker->level == PT32E_ROOT_LEVEL) {
 309                 pte = mmu->get_pdptr(vcpu, (addr >> 30) & 3);
 310                 trace_kvm_mmu_paging_element(pte, walker->level);
 311                 if (!FNAME(is_present_gpte)(pte))
 312                         goto error;
 313                 --walker->level;
 314         }
 315 #endif
 316         walker->max_level = walker->level;
 317         ASSERT(!(is_long_mode(vcpu) && !is_pae(vcpu)));
 318
 319         /*
 320          * FIXME: on Intel processors, loads of the PDPTE registers for PAE paging
 321          * by the MOV to CR instruction are treated as reads and do not cause the
 322          * processor to set the dirty flag in any EPT paging-structure entry.
 323          */
 324         nested_access = (have_ad ? PFERR_WRITE_MASK : 0) | PFERR_USER_MASK;
 325
 326         pte_access = ~0;
 327         ++walker->level;
 328
 329         do {
 330                 gfn_t real_gfn;
 331                 unsigned long host_addr;
 332
 333                 pt_access = pte_access;
 334                 --walker->level;
 335
 336                 index = PT_INDEX(addr, walker->level);
 337
 338                 table_gfn = gpte_to_gfn(pte);
 339                 offset    = index * sizeof(pt_element_t);
 340                 pte_gpa   = gfn_to_gpa(table_gfn) + offset;
 341                 walker->table_gfn[walker->level - 1] = table_gfn;
 342                 walker->pte_gpa[walker->level - 1] = pte_gpa;
 343
 344                 real_gfn = mmu->translate_gpa(vcpu, gfn_to_gpa(table_gfn),
 345                                               nested_access,
 346                                               &walker->fault);
 347
 348                 /*
 349                  * FIXME: This can happen if emulation (for of an INS/OUTS
 350                  * instruction) triggers a nested page fault.  The exit
 351                  * qualification / exit info field will incorrectly have
 352                  * "guest page access" as the nested page fault's cause,
 353                  * instead of "guest page structure access".  To fix this,
 354                  * the x86_exception struct should be augmented with enough
 355                  * information to fix the exit_qualification or exit_info_1
 356                  * fields.
 357                  */
 358                 if (unlikely(real_gfn == UNMAPPED_GVA))
 359                         return 0;
 360
 361                 real_gfn = gpa_to_gfn(real_gfn);
 362
 363                 host_addr = kvm_vcpu_gfn_to_hva_prot(vcpu, real_gfn,
 364                                             &walker->pte_writable[walker->level - 1]);
 365                 if (unlikely(kvm_is_error_hva(host_addr)))
 366                         goto error;
 367
 368                 ptep_user = (pt_element_t __user *)((void *)host_addr + offset);
 369                 if (unlikely(__copy_from_user(&pte, ptep_user, sizeof(pte))))
 370                         goto error;
 371                 walker->ptep_user[walker->level - 1] = ptep_user;
 372
 373                 trace_kvm_mmu_paging_element(pte, walker->level);
 374
 375                 /*
 376                  * Inverting the NX it lets us AND it like other
 377                  * permission bits.
 378                  */
 379                 pte_access = pt_access & (pte ^ walk_nx_mask);
 380
 381                 if (unlikely(!FNAME(is_present_gpte)(pte)))
 382                         goto error;
 383
 384                 if (unlikely(is_rsvd_bits_set(mmu, pte, walker->level))) {
 385                         errcode = PFERR_RSVD_MASK | PFERR_PRESENT_MASK;
 386                         goto error;
 387                 }
 388
 389                 walker->ptes[walker->level - 1] = pte;
 390         } while (!is_last_gpte(mmu, walker->level, pte));
 391
 392         pte_pkey = FNAME(gpte_pkeys)(vcpu, pte);
 393         accessed_dirty = have_ad ? pte_access & PT_GUEST_ACCESSED_MASK : 0;
 394
 395         /* Convert to ACC_*_MASK flags for struct guest_walker.  */
 396         walker->pt_access = FNAME(gpte_access)(vcpu, pt_access ^ walk_nx_mask);
 397         walker->pte_access = FNAME(gpte_access)(vcpu, pte_access ^ walk_nx_mask);
 398         errcode = permission_fault(vcpu, mmu, walker->pte_access, pte_pkey, access);
 399         if (unlikely(errcode))
 400                 goto error;
 401
 402         gfn = gpte_to_gfn_lvl(pte, walker->level);
 403         gfn += (addr & PT_LVL_OFFSET_MASK(walker->level)) >> PAGE_SHIFT;
 404
 405         if (PTTYPE == 32 && walker->level == PT_DIRECTORY_LEVEL && is_cpuid_PSE36())
 406                 gfn += pse36_gfn_delta(pte);
 407
 408         real_gpa = mmu->translate_gpa(vcpu, gfn_to_gpa(gfn), access, &walker->fault);
 409         if (real_gpa == UNMAPPED_GVA)
 410                 return 0;
 411
 412         walker->gfn = real_gpa >> PAGE_SHIFT;
 413
 414         if (!write_fault)
 415                 FNAME(protect_clean_gpte)(mmu, &walker->pte_access, pte);
 416         else
 417                 /*
 418                  * On a write fault, fold the dirty bit into accessed_dirty.
 419                  * For modes without A/D bits support accessed_dirty will be
 420                  * always clear.
 421                  */
 422                 accessed_dirty &= pte >>
 423                         (PT_GUEST_DIRTY_SHIFT - PT_GUEST_ACCESSED_SHIFT);
 424
 425         if (unlikely(!accessed_dirty)) {
 426                 ret = FNAME(update_accessed_dirty_bits)(vcpu, mmu, walker, write_fault);
 427                 if (unlikely(ret < 0))
 428                         goto error;
 429                 else if (ret)
 430                         goto retry_walk;
 431         }
 432
 433         pgprintk("%s: pte %llx pte_access %x pt_access %x\n",
 434                  __func__, (u64)pte, walker->pte_access, walker->pt_access);
 435         return 1;
 436
 437 error:
 438         errcode |= write_fault | user_fault;
 439         if (fetch_fault && (mmu->nx ||
 440                             kvm_read_cr4_bits(vcpu, X86_CR4_SMEP)))
 441                 errcode |= PFERR_FETCH_MASK;
 442
 443         walker->fault.vector = PF_VECTOR;
 444         walker->fault.error_code_valid = true;
 445         walker->fault.error_code = errcode;
 446
 447 #if PTTYPE == PTTYPE_EPT
 448         /*
 449          * Use PFERR_RSVD_MASK in error_code to to tell if EPT
 450          * misconfiguration requires to be injected. The detection is
 451          * done by is_rsvd_bits_set() above.
 452          *
 453          * We set up the value of exit_qualification to inject:
 454          * [2:0] - Derive from [2:0] of real exit_qualification at EPT violation
 455          * [5:3] - Calculated by the page walk of the guest EPT page tables
 456          * [7:8] - Derived from [7:8] of real exit_qualification
 457          *
 458          * The other bits are set to 0.
 459          */
 460         if (!(errcode & PFERR_RSVD_MASK)) {
 461                 vcpu->arch.exit_qualification &= 0x187;
 462                 vcpu->arch.exit_qualification |= (pte_access & 0x7) << 3;
 463         }
 464 #endif
 465         walker->fault.address = addr;
 466         walker->fault.nested_page_fault = mmu != vcpu->arch.walk_mmu;
 467
 468         trace_kvm_mmu_walker_error(walker->fault.error_code);
 469         return 0;
 470 }
 471
 472 static int FNAME(walk_addr)(struct guest_walker *walker,
 473                             struct kvm_vcpu *vcpu, gva_t addr, u32 access)
 474 {
 475         return FNAME(walk_addr_generic)(walker, vcpu, &vcpu->arch.mmu, addr,
 476                                         access);
 477 }
 478
 479 #if PTTYPE != PTTYPE_EPT
 480 static int FNAME(walk_addr_nested)(struct guest_walker *walker,
 481                                    struct kvm_vcpu *vcpu, gva_t addr,
 482                                    u32 access)
 483 {
 484         return FNAME(walk_addr_generic)(walker, vcpu, &vcpu->arch.nested_mmu,
 485                                         addr, access);
 486 }
 487 #endif
 488
 489 static bool
 490 FNAME(prefetch_gpte)(struct kvm_vcpu *vcpu, struct kvm_mmu_page *sp,
 491                      u64 *spte, pt_element_t gpte, bool no_dirty_log)
 492 {
 493         unsigned pte_access;
 494         gfn_t gfn;
 495         kvm_pfn_t pfn;
 496
 497         if (FNAME(prefetch_invalid_gpte)(vcpu, sp, spte, gpte))
 498                 return false;
 499
 500         pgprintk("%s: gpte %llx spte %p\n", __func__, (u64)gpte, spte);
 501
 502         gfn = gpte_to_gfn(gpte);
 503         pte_access = sp->role.access & FNAME(gpte_access)(vcpu, gpte);
 504         FNAME(protect_clean_gpte)(&vcpu->arch.mmu, &pte_access, gpte);
 505         pfn = pte_prefetch_gfn_to_pfn(vcpu, gfn,
 506                         no_dirty_log && (pte_access & ACC_WRITE_MASK));
 507         if (is_error_pfn(pfn))
 508                 return false;
 509
 510         /*
 511          * we call mmu_set_spte() with host_writable = true because
 512          * pte_prefetch_gfn_to_pfn always gets a writable pfn.
 513          */
 514         mmu_set_spte(vcpu, spte, pte_access, 0, PT_PAGE_TABLE_LEVEL, gfn, pfn,
 515                      true, true);
 516
 517         return true;
 518 }
 519
 520 static void FNAME(update_pte)(struct kvm_vcpu *vcpu, struct kvm_mmu_page *sp,
 521                               u64 *spte, const void *pte)
 522 {
 523         pt_element_t gpte = *(const pt_element_t *)pte;
 524
 525         FNAME(prefetch_gpte)(vcpu, sp, spte, gpte, false);
 526 }
 527
 528 static bool FNAME(gpte_changed)(struct kvm_vcpu *vcpu,
 529                                 struct guest_walker *gw, int level)
 530 {
 531         pt_element_t curr_pte;
 532         gpa_t base_gpa, pte_gpa = gw->pte_gpa[level - 1];
 533         u64 mask;
 534         int r, index;
 535
 536         if (level == PT_PAGE_TABLE_LEVEL) {
 537                 mask = PTE_PREFETCH_NUM * sizeof(pt_element_t) - 1;
 538                 base_gpa = pte_gpa & ~mask;
 539                 index = (pte_gpa - base_gpa) / sizeof(pt_element_t);
 540
 541                 r = kvm_vcpu_read_guest_atomic(vcpu, base_gpa,
 542                                 gw->prefetch_ptes, sizeof(gw->prefetch_ptes));
 543                 curr_pte = gw->prefetch_ptes[index];
 544         } else
 545                 r = kvm_vcpu_read_guest_atomic(vcpu, pte_gpa,
 546                                   &curr_pte, sizeof(curr_pte));
 547
 548         return r || curr_pte != gw->ptes[level - 1];
 549 }
 550
 551 static void FNAME(pte_prefetch)(struct kvm_vcpu *vcpu, struct guest_walker *gw,
 552                                 u64 *sptep)
 553 {
 554         struct kvm_mmu_page *sp;
 555         pt_element_t *gptep = gw->prefetch_ptes;
 556         u64 *spte;
 557         int i;
 558
 559         sp = page_header(__pa(sptep));
 560
 561         if (sp->role.level > PT_PAGE_TABLE_LEVEL)
 562                 return;
 563
 564         if (sp->role.direct)
 565                 return __direct_pte_prefetch(vcpu, sp, sptep);
 566
 567         i = (sptep - sp->spt) & ~(PTE_PREFETCH_NUM - 1);
 568         spte = sp->spt + i;
 569
 570         for (i = 0; i < PTE_PREFETCH_NUM; i++, spte++) {
 571                 if (spte == sptep)
 572                         continue;
 573
 574                 if (is_shadow_present_pte(*spte))
 575                         continue;
 576
 577                 if (!FNAME(prefetch_gpte)(vcpu, sp, spte, gptep[i], true))
 578                         break;
 579         }
 580 }
 581
 582 /*
 583  * Fetch a shadow pte for a specific level in the paging hierarchy.
 584  * If the guest tries to write a write-protected page, we need to
 585  * emulate this operation, return 1 to indicate this case.
 586  */
 587 static int FNAME(fetch)(struct kvm_vcpu *vcpu, gva_t addr,
 588                          struct guest_walker *gw,
 589                          int write_fault, int hlevel,
 590                          kvm_pfn_t pfn, bool map_writable, bool prefault)
 591 {
 592         struct kvm_mmu_page *sp = NULL;
 593         struct kvm_shadow_walk_iterator it;
 594         unsigned direct_access, access = gw->pt_access;
 595         int top_level, emulate;
 596
 597         direct_access = gw->pte_access;
 598
 599         top_level = vcpu->arch.mmu.root_level;
 600         if (top_level == PT32E_ROOT_LEVEL)
 601                 top_level = PT32_ROOT_LEVEL;
 602         /*
 603          * Verify that the top-level gpte is still there.  Since the page
 604          * is a root page, it is either write protected (and cannot be
 605          * changed from now on) or it is invalid (in which case, we don't
 606          * really care if it changes underneath us after this point).
 607          */
 608         if (FNAME(gpte_changed)(vcpu, gw, top_level))
 609                 goto out_gpte_changed;
 610
 611         if (!VALID_PAGE(vcpu->arch.mmu.root_hpa))
 612                 goto out_gpte_changed;
 613
 614         for (shadow_walk_init(&it, vcpu, addr);
 615              shadow_walk_okay(&it) && it.level > gw->level;
 616              shadow_walk_next(&it)) {
 617                 gfn_t table_gfn;
 618
 619                 clear_sp_write_flooding_count(it.sptep);
 620                 drop_large_spte(vcpu, it.sptep);
 621
 622                 sp = NULL;
 623                 if (!is_shadow_present_pte(*it.sptep)) {
 624                         table_gfn = gw->table_gfn[it.level - 2];
 625                         sp = kvm_mmu_get_page(vcpu, table_gfn, addr, it.level-1,
 626                                               false, access);
 627                 }
 628
 629                 /*
 630                  * Verify that the gpte in the page we've just write
 631                  * protected is still there.
 632                  */
 633                 if (FNAME(gpte_changed)(vcpu, gw, it.level - 1))
 634                         goto out_gpte_changed;
 635
 636                 if (sp)
 637                         link_shadow_page(vcpu, it.sptep, sp);
 638         }
 639
 640         for (;
 641              shadow_walk_okay(&it) && it.level > hlevel;
 642              shadow_walk_next(&it)) {
 643                 gfn_t direct_gfn;
 644
 645                 clear_sp_write_flooding_count(it.sptep);
 646                 validate_direct_spte(vcpu, it.sptep, direct_access);
 647
 648                 drop_large_spte(vcpu, it.sptep);
 649
 650                 if (is_shadow_present_pte(*it.sptep))
 651                         continue;
 652
 653                 direct_gfn = gw->gfn & ~(KVM_PAGES_PER_HPAGE(it.level) - 1);
 654
 655                 sp = kvm_mmu_get_page(vcpu, direct_gfn, addr, it.level-1,
 656                                       true, direct_access);
 657                 link_shadow_page(vcpu, it.sptep, sp);
 658         }
 659
 660         clear_sp_write_flooding_count(it.sptep);
 661         emulate = mmu_set_spte(vcpu, it.sptep, gw->pte_access, write_fault,
 662                                it.level, gw->gfn, pfn, prefault, map_writable);
 663         FNAME(pte_prefetch)(vcpu, gw, it.sptep);
 664
 665         return emulate;
 666
 667 out_gpte_changed:
 668         kvm_release_pfn_clean(pfn);
 669         return 0;
 670 }
 671
 672  /*
 673  * To see whether the mapped gfn can write its page table in the current
 674  * mapping.
 675  *
 676  * It is the helper function of FNAME(page_fault). When guest uses large page
 677  * size to map the writable gfn which is used as current page table, we should
 678  * force kvm to use small page size to map it because new shadow page will be
 679  * created when kvm establishes shadow page table that stop kvm using large
 680  * page size. Do it early can avoid unnecessary #PF and emulation.
 681  *
 682  * @write_fault_to_shadow_pgtable will return true if the fault gfn is
 683  * currently used as its page table.
 684  *
 685  * Note: the PDPT page table is not checked for PAE-32 bit guest. It is ok
 686  * since the PDPT is always shadowed, that means, we can not use large page
 687  * size to map the gfn which is used as PDPT.
 688  */
 689 static bool
 690 FNAME(is_self_change_mapping)(struct kvm_vcpu *vcpu,
 691                               struct guest_walker *walker, int user_fault,
 692                               bool *write_fault_to_shadow_pgtable)
 693 {
 694         int level;
 695         gfn_t mask = ~(KVM_PAGES_PER_HPAGE(walker->level) - 1);
 696         bool self_changed = false;
 697
 698         if (!(walker->pte_access & ACC_WRITE_MASK ||
 699               (!is_write_protection(vcpu) && !user_fault)))
 700                 return false;
 701
 702         for (level = walker->level; level <= walker->max_level; level++) {
 703                 gfn_t gfn = walker->gfn ^ walker->table_gfn[level - 1];
 704
 705                 self_changed |= !(gfn & mask);
 706                 *write_fault_to_shadow_pgtable |= !gfn;
 707         }
 708
 709         return self_changed;
 710 }
 711
 712 /*
 713  * Page fault handler.  There are several causes for a page fault:
 714  *   - there is no shadow pte for the guest pte
 715  *   - write access through a shadow pte marked read only so that we can set
 716  *     the dirty bit
 717  *   - write access to a shadow pte marked read only so we can update the page
 718  *     dirty bitmap, when userspace requests it
 719  *   - mmio access; in this case we will never install a present shadow pte
 720  *   - normal guest page fault due to the guest pte marked not present, not
 721  *     writable, or not executable
 722  *
 723  *  Returns: 1 if we need to emulate the instruction, 0 otherwise, or
 724  *           a negative value on error.
 725  */
 726 static int FNAME(page_fault)(struct kvm_vcpu *vcpu, gva_t addr, u32 error_code,
 727                              bool prefault)
 728 {
 729         int write_fault = error_code & PFERR_WRITE_MASK;
 730         int user_fault = error_code & PFERR_USER_MASK;
 731         struct guest_walker walker;
 732         int r;
 733         kvm_pfn_t pfn;
 734         int level = PT_PAGE_TABLE_LEVEL;
 735         bool force_pt_level = false;
 736         unsigned long mmu_seq;
 737         bool map_writable, is_self_change_mapping;
 738
 739         pgprintk("%s: addr %lx err %x\n", __func__, addr, error_code);
 740
 741         r = mmu_topup_memory_caches(vcpu);
 742         if (r)
 743                 return r;
 744
 745         /*
 746          * If PFEC.RSVD is set, this is a shadow page fault.
 747          * The bit needs to be cleared before walking guest page tables.
 748          */
 749         error_code &= ~PFERR_RSVD_MASK;
 750
 751         /*
 752          * Look up the guest pte for the faulting address.
 753          */
 754         r = FNAME(walk_addr)(&walker, vcpu, addr, error_code);
 755
 756         /*
 757          * The page is not mapped by the guest.  Let the guest handle it.
 758          */
 759         if (!r) {
 760                 pgprintk("%s: guest page fault\n", __func__);
 761                 if (!prefault)
 762                         inject_page_fault(vcpu, &walker.fault);
 763
 764                 return 0;
 765         }
 766
 767         if (page_fault_handle_page_track(vcpu, error_code, walker.gfn)) {
 768                 shadow_page_table_clear_flood(vcpu, addr);
 769                 return 1;
 770         }
 771
 772         vcpu->arch.write_fault_to_shadow_pgtable = false;
 773
 774         is_self_change_mapping = FNAME(is_self_change_mapping)(vcpu,
 775               &walker, user_fault, &vcpu->arch.write_fault_to_shadow_pgtable);
 776
 777         if (walker.level >= PT_DIRECTORY_LEVEL && !is_self_change_mapping) {
 778                 level = mapping_level(vcpu, walker.gfn, &force_pt_level);
 779                 if (likely(!force_pt_level)) {
 780                         level = min(walker.level, level);
 781                         walker.gfn = walker.gfn & ~(KVM_PAGES_PER_HPAGE(level) - 1);
 782                 }
 783         } else
 784                 force_pt_level = true;
 785
 786         mmu_seq = vcpu->kvm->mmu_notifier_seq;
 787         smp_rmb();
 788
 789         if (try_async_pf(vcpu, prefault, walker.gfn, addr, &pfn, write_fault,
 790                          &map_writable))
 791                 return 0;
 792
 793         if (handle_abnormal_pfn(vcpu, mmu_is_nested(vcpu) ? 0 : addr,
 794                                 walker.gfn, pfn, walker.pte_access, &r))
 795                 return r;
 796
 797         /*
 798          * Do not change pte_access if the pfn is a mmio page, otherwise
 799          * we will cache the incorrect access into mmio spte.
 800          */
 801         if (write_fault && !(walker.pte_access & ACC_WRITE_MASK) &&
 802              !is_write_protection(vcpu) && !user_fault &&
 803               !is_noslot_pfn(pfn)) {
 804                 walker.pte_access |= ACC_WRITE_MASK;
 805                 walker.pte_access &= ~ACC_USER_MASK;
 806
 807                 /*
 808                  * If we converted a user page to a kernel page,
 809                  * so that the kernel can write to it when cr0.wp=0,
 810                  * then we should prevent the kernel from executing it
 811                  * if SMEP is enabled.
 812                  */
 813                 if (kvm_read_cr4_bits(vcpu, X86_CR4_SMEP))
 814                         walker.pte_access &= ~ACC_EXEC_MASK;
 815         }
 816
 817         spin_lock(&vcpu->kvm->mmu_lock);
 818         if (mmu_notifier_retry(vcpu->kvm, mmu_seq))
 819                 goto out_unlock;
 820
 821         kvm_mmu_audit(vcpu, AUDIT_PRE_PAGE_FAULT);
 822         make_mmu_pages_available(vcpu);
 823         if (!force_pt_level)
 824                 transparent_hugepage_adjust(vcpu, &walker.gfn, &pfn, &level);
 825         r = FNAME(fetch)(vcpu, addr, &walker, write_fault,
 826                          level, pfn, map_writable, prefault);
 827         ++vcpu->stat.pf_fixed;
 828         kvm_mmu_audit(vcpu, AUDIT_POST_PAGE_FAULT);
 829         spin_unlock(&vcpu->kvm->mmu_lock);
 830
 831         return r;
 832
 833 out_unlock:
 834         spin_unlock(&vcpu->kvm->mmu_lock);
 835         kvm_release_pfn_clean(pfn);
 836         return 0;
 837 }
 838
 839 static gpa_t FNAME(get_level1_sp_gpa)(struct kvm_mmu_page *sp)
 840 {
 841         int offset = 0;
 842
 843         WARN_ON(sp->role.level != PT_PAGE_TABLE_LEVEL);
 844
 845         if (PTTYPE == 32)
 846                 offset = sp->role.quadrant << PT64_LEVEL_BITS;
 847
 848         return gfn_to_gpa(sp->gfn) + offset * sizeof(pt_element_t);
 849 }
 850
 851 static void FNAME(invlpg)(struct kvm_vcpu *vcpu, gva_t gva)
 852 {
 853         struct kvm_shadow_walk_iterator iterator;
 854         struct kvm_mmu_page *sp;
 855         int level;
 856         u64 *sptep;
 857
 858         vcpu_clear_mmio_info(vcpu, gva);
 859
 860         /*
 861          * No need to check return value here, rmap_can_add() can
 862          * help us to skip pte prefetch later.
 863          */
 864         mmu_topup_memory_caches(vcpu);
 865
 866         if (!VALID_PAGE(vcpu->arch.mmu.root_hpa)) {
 867                 WARN_ON(1);
 868                 return;
 869         }
 870
 871         spin_lock(&vcpu->kvm->mmu_lock);
 872         for_each_shadow_entry(vcpu, gva, iterator) {
 873                 level = iterator.level;
 874                 sptep = iterator.sptep;
 875
 876                 sp = page_header(__pa(sptep));
 877                 if (is_last_spte(*sptep, level)) {
 878                         pt_element_t gpte;
 879                         gpa_t pte_gpa;
 880
 881                         if (!sp->unsync)
 882                                 break;
 883
 884                         pte_gpa = FNAME(get_level1_sp_gpa)(sp);
 885                         pte_gpa += (sptep - sp->spt) * sizeof(pt_element_t);
 886
 887                         if (mmu_page_zap_pte(vcpu->kvm, sp, sptep))
 888                                 kvm_flush_remote_tlbs(vcpu->kvm);
 889
 890                         if (!rmap_can_add(vcpu))
 891                                 break;
 892
 893                         if (kvm_vcpu_read_guest_atomic(vcpu, pte_gpa, &gpte,
 894                                                        sizeof(pt_element_t)))
 895                                 break;
 896
 897                         FNAME(update_pte)(vcpu, sp, sptep, &gpte);
 898                 }
 899
 900                 if (!is_shadow_present_pte(*sptep) || !sp->unsync_children)
 901                         break;
 902         }
 903         spin_unlock(&vcpu->kvm->mmu_lock);
 904 }
 905
 906 static gpa_t FNAME(gva_to_gpa)(struct kvm_vcpu *vcpu, gva_t vaddr, u32 access,
 907                                struct x86_exception *exception)
 908 {
 909         struct guest_walker walker;
 910         gpa_t gpa = UNMAPPED_GVA;
 911         int r;
 912
 913         r = FNAME(walk_addr)(&walker, vcpu, vaddr, access);
 914
 915         if (r) {
 916                 gpa = gfn_to_gpa(walker.gfn);
 917                 gpa |= vaddr & ~PAGE_MASK;
 918         } else if (exception)
 919                 *exception = walker.fault;
 920
 921         return gpa;
 922 }
 923
 924 #if PTTYPE != PTTYPE_EPT
 925 static gpa_t FNAME(gva_to_gpa_nested)(struct kvm_vcpu *vcpu, gva_t vaddr,
 926                                       u32 access,
 927                                       struct x86_exception *exception)
 928 {
 929         struct guest_walker walker;
 930         gpa_t gpa = UNMAPPED_GVA;
 931         int r;
 932
 933         r = FNAME(walk_addr_nested)(&walker, vcpu, vaddr, access);
 934
 935         if (r) {
 936                 gpa = gfn_to_gpa(walker.gfn);
 937                 gpa |= vaddr & ~PAGE_MASK;
 938         } else if (exception)
 939                 *exception = walker.fault;
 940
 941         return gpa;
 942 }
 943 #endif
 944
 945 /*
 946  * Using the cached information from sp->gfns is safe because:
 947  * - The spte has a reference to the struct page, so the pfn for a given gfn
 948  *   can't change unless all sptes pointing to it are nuked first.
 949  *
 950  * Note:
 951  *   We should flush all tlbs if spte is dropped even though guest is
 952  *   responsible for it. Since if we don't, kvm_mmu_notifier_invalidate_page
 953  *   and kvm_mmu_notifier_invalidate_range_start detect the mapping page isn't
 954  *   used by guest then tlbs are not flushed, so guest is allowed to access the
 955  *   freed pages.
 956  *   And we increase kvm->tlbs_dirty to delay tlbs flush in this case.
 957  */
 958 static int FNAME(sync_page)(struct kvm_vcpu *vcpu, struct kvm_mmu_page *sp)
 959 {
 960         int i, nr_present = 0;
 961         bool host_writable;
 962         gpa_t first_pte_gpa;
 963
 964         /* direct kvm_mmu_page can not be unsync. */
 965         BUG_ON(sp->role.direct);
 966
 967         first_pte_gpa = FNAME(get_level1_sp_gpa)(sp);
 968
 969         for (i = 0; i < PT64_ENT_PER_PAGE; i++) {
 970                 unsigned pte_access;
 971                 pt_element_t gpte;
 972                 gpa_t pte_gpa;
 973                 gfn_t gfn;
 974
 975                 if (!sp->spt[i])
 976                         continue;
 977
 978                 pte_gpa = first_pte_gpa + i * sizeof(pt_element_t);
 979
 980                 if (kvm_vcpu_read_guest_atomic(vcpu, pte_gpa, &gpte,
 981                                                sizeof(pt_element_t)))
 982                         return 0;
 983
 984                 if (FNAME(prefetch_invalid_gpte)(vcpu, sp, &sp->spt[i], gpte)) {
 985                         /*
 986                          * Update spte before increasing tlbs_dirty to make
 987                          * sure no tlb flush is lost after spte is zapped; see
 988                          * the comments in kvm_flush_remote_tlbs().
 989                          */
 990                         smp_wmb();
 991                         vcpu->kvm->tlbs_dirty++;
 992                         continue;
 993                 }
 994
 995                 gfn = gpte_to_gfn(gpte);
 996                 pte_access = sp->role.access;
 997                 pte_access &= FNAME(gpte_access)(vcpu, gpte);
 998                 FNAME(protect_clean_gpte)(&vcpu->arch.mmu, &pte_access, gpte);
 999
1000                 if (sync_mmio_spte(vcpu, &sp->spt[i], gfn, pte_access,
1001                       &nr_present))
1002                         continue;
1003
1004                 if (gfn != sp->gfns[i]) {
1005                         drop_spte(vcpu->kvm, &sp->spt[i]);
1006                         /*
1007                          * The same as above where we are doing
1008                          * prefetch_invalid_gpte().
1009                          */
1010                         smp_wmb();
1011                         vcpu->kvm->tlbs_dirty++;
1012                         continue;
1013                 }
1014
1015                 nr_present++;
1016
1017                 host_writable = sp->spt[i] & SPTE_HOST_WRITEABLE;
1018
1019                 set_spte(vcpu, &sp->spt[i], pte_access,
1020                          PT_PAGE_TABLE_LEVEL, gfn,
1021                          spte_to_pfn(sp->spt[i]), true, false,
1022                          host_writable);
1023         }
1024
1025         return nr_present;
1026 }
1027
1028 #undef pt_element_t
1029 #undef guest_walker
1030 #undef FNAME
1031 #undef PT_BASE_ADDR_MASK
1032 #undef PT_INDEX
1033 #undef PT_LVL_ADDR_MASK
1034 #undef PT_LVL_OFFSET_MASK
1035 #undef PT_LEVEL_BITS
1036 #undef PT_MAX_FULL_LEVELS
1037 #undef gpte_to_gfn
1038 #undef gpte_to_gfn_lvl
1039 #undef CMPXCHG
1040 #undef PT_GUEST_ACCESSED_MASK
1041 #undef PT_GUEST_DIRTY_MASK
1042 #undef PT_GUEST_DIRTY_SHIFT
1043 #undef PT_GUEST_ACCESSED_SHIFT
1044 #undef PT_HAVE_ACCESSED_DIRTY