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  *
  11  * Authors:
  12  *   Yaniv Kamay  <yaniv@qumranet.com>
  13  *   Avi Kivity   <avi@qumranet.com>
  14  *
  15  * This work is licensed under the terms of the GNU GPL, version 2.  See
  16  * the COPYING file in the top-level directory.
  17  *
  18  */
  19
  20 /*
  21  * We need the mmu code to access both 32-bit and 64-bit guest ptes,
  22  * so the code in this file is compiled twice, once per pte size.
  23  */
  24
  25 #if PTTYPE == 64
  26         #define pt_element_t u64
  27         #define guest_walker guest_walker64
  28         #define shadow_walker shadow_walker64
  29         #define FNAME(name) paging##64_##name
  30         #define PT_BASE_ADDR_MASK PT64_BASE_ADDR_MASK
  31         #define PT_DIR_BASE_ADDR_MASK PT64_DIR_BASE_ADDR_MASK
  32         #define PT_INDEX(addr, level) PT64_INDEX(addr, level)
  33         #define PT_LEVEL_MASK(level) PT64_LEVEL_MASK(level)
  34         #define PT_LEVEL_BITS PT64_LEVEL_BITS
  35         #ifdef CONFIG_X86_64
  36         #define PT_MAX_FULL_LEVELS 4
  37         #define CMPXCHG cmpxchg
  38         #else
  39         #define CMPXCHG cmpxchg64
  40         #define PT_MAX_FULL_LEVELS 2
  41         #endif
  42 #elif PTTYPE == 32
  43         #define pt_element_t u32
  44         #define guest_walker guest_walker32
  45         #define shadow_walker shadow_walker32
  46         #define FNAME(name) paging##32_##name
  47         #define PT_BASE_ADDR_MASK PT32_BASE_ADDR_MASK
  48         #define PT_DIR_BASE_ADDR_MASK PT32_DIR_BASE_ADDR_MASK
  49         #define PT_INDEX(addr, level) PT32_INDEX(addr, level)
  50         #define PT_LEVEL_MASK(level) PT32_LEVEL_MASK(level)
  51         #define PT_LEVEL_BITS PT32_LEVEL_BITS
  52         #define PT_MAX_FULL_LEVELS 2
  53         #define CMPXCHG cmpxchg
  54 #else
  55         #error Invalid PTTYPE value
  56 #endif
  57
  58 #define gpte_to_gfn FNAME(gpte_to_gfn)
  59 #define gpte_to_gfn_pde FNAME(gpte_to_gfn_pde)
  60
  61 /*
  62  * The guest_walker structure emulates the behavior of the hardware page
  63  * table walker.
  64  */
  65 struct guest_walker {
  66         int level;
  67         gfn_t table_gfn[PT_MAX_FULL_LEVELS];
  68         pt_element_t ptes[PT_MAX_FULL_LEVELS];
  69         gpa_t pte_gpa[PT_MAX_FULL_LEVELS];
  70         unsigned pt_access;
  71         unsigned pte_access;
  72         gfn_t gfn;
  73         u32 error_code;
  74 };
  75
  76 struct shadow_walker {
  77         struct kvm_shadow_walk walker;
  78         struct guest_walker *guest_walker;
  79         int user_fault;
  80         int write_fault;
  81         int largepage;
  82         int *ptwrite;
  83         pfn_t pfn;
  84         u64 *sptep;
  85 };
  86
  87 static gfn_t gpte_to_gfn(pt_element_t gpte)
  88 {
  89         return (gpte & PT_BASE_ADDR_MASK) >> PAGE_SHIFT;
  90 }
  91
  92 static gfn_t gpte_to_gfn_pde(pt_element_t gpte)
  93 {
  94         return (gpte & PT_DIR_BASE_ADDR_MASK) >> PAGE_SHIFT;
  95 }
  96
  97 static bool FNAME(cmpxchg_gpte)(struct kvm *kvm,
  98                          gfn_t table_gfn, unsigned index,
  99                          pt_element_t orig_pte, pt_element_t new_pte)
 100 {
 101         pt_element_t ret;
 102         pt_element_t *table;
 103         struct page *page;
 104
 105         page = gfn_to_page(kvm, table_gfn);
 106
 107         table = kmap_atomic(page, KM_USER0);
 108         ret = CMPXCHG(&table[index], orig_pte, new_pte);
 109         kunmap_atomic(table, KM_USER0);
 110
 111         kvm_release_page_dirty(page);
 112
 113         return (ret != orig_pte);
 114 }
 115
 116 static unsigned FNAME(gpte_access)(struct kvm_vcpu *vcpu, pt_element_t gpte)
 117 {
 118         unsigned access;
 119
 120         access = (gpte & (PT_WRITABLE_MASK | PT_USER_MASK)) | ACC_EXEC_MASK;
 121 #if PTTYPE == 64
 122         if (is_nx(vcpu))
 123                 access &= ~(gpte >> PT64_NX_SHIFT);
 124 #endif
 125         return access;
 126 }
 127
 128 /*
 129  * Fetch a guest pte for a guest virtual address
 130  */
 131 static int FNAME(walk_addr)(struct guest_walker *walker,
 132                             struct kvm_vcpu *vcpu, gva_t addr,
 133                             int write_fault, int user_fault, int fetch_fault)
 134 {
 135         pt_element_t pte;
 136         gfn_t table_gfn;
 137         unsigned index, pt_access, pte_access;
 138         gpa_t pte_gpa;
 139
 140         pgprintk("%s: addr %lx\n", __func__, addr);
 141 walk:
 142         walker->level = vcpu->arch.mmu.root_level;
 143         pte = vcpu->arch.cr3;
 144 #if PTTYPE == 64
 145         if (!is_long_mode(vcpu)) {
 146                 pte = vcpu->arch.pdptrs[(addr >> 30) & 3];
 147                 if (!is_present_pte(pte))
 148                         goto not_present;
 149                 --walker->level;
 150         }
 151 #endif
 152         ASSERT((!is_long_mode(vcpu) && is_pae(vcpu)) ||
 153                (vcpu->arch.cr3 & CR3_NONPAE_RESERVED_BITS) == 0);
 154
 155         pt_access = ACC_ALL;
 156
 157         for (;;) {
 158                 index = PT_INDEX(addr, walker->level);
 159
 160                 table_gfn = gpte_to_gfn(pte);
 161                 pte_gpa = gfn_to_gpa(table_gfn);
 162                 pte_gpa += index * sizeof(pt_element_t);
 163                 walker->table_gfn[walker->level - 1] = table_gfn;
 164                 walker->pte_gpa[walker->level - 1] = pte_gpa;
 165                 pgprintk("%s: table_gfn[%d] %lx\n", __func__,
 166                          walker->level - 1, table_gfn);
 167
 168                 kvm_read_guest(vcpu->kvm, pte_gpa, &pte, sizeof(pte));
 169
 170                 if (!is_present_pte(pte))
 171                         goto not_present;
 172
 173                 if (write_fault && !is_writeble_pte(pte))
 174                         if (user_fault || is_write_protection(vcpu))
 175                                 goto access_error;
 176
 177                 if (user_fault && !(pte & PT_USER_MASK))
 178                         goto access_error;
 179
 180 #if PTTYPE == 64
 181                 if (fetch_fault && is_nx(vcpu) && (pte & PT64_NX_MASK))
 182                         goto access_error;
 183 #endif
 184
 185                 if (!(pte & PT_ACCESSED_MASK)) {
 186                         mark_page_dirty(vcpu->kvm, table_gfn);
 187                         if (FNAME(cmpxchg_gpte)(vcpu->kvm, table_gfn,
 188                             index, pte, pte|PT_ACCESSED_MASK))
 189                                 goto walk;
 190                         pte |= PT_ACCESSED_MASK;
 191                 }
 192
 193                 pte_access = pt_access & FNAME(gpte_access)(vcpu, pte);
 194
 195                 walker->ptes[walker->level - 1] = pte;
 196
 197                 if (walker->level == PT_PAGE_TABLE_LEVEL) {
 198                         walker->gfn = gpte_to_gfn(pte);
 199                         break;
 200                 }
 201
 202                 if (walker->level == PT_DIRECTORY_LEVEL
 203                     && (pte & PT_PAGE_SIZE_MASK)
 204                     && (PTTYPE == 64 || is_pse(vcpu))) {
 205                         walker->gfn = gpte_to_gfn_pde(pte);
 206                         walker->gfn += PT_INDEX(addr, PT_PAGE_TABLE_LEVEL);
 207                         if (PTTYPE == 32 && is_cpuid_PSE36())
 208                                 walker->gfn += pse36_gfn_delta(pte);
 209                         break;
 210                 }
 211
 212                 pt_access = pte_access;
 213                 --walker->level;
 214         }
 215
 216         if (write_fault && !is_dirty_pte(pte)) {
 217                 bool ret;
 218
 219                 mark_page_dirty(vcpu->kvm, table_gfn);
 220                 ret = FNAME(cmpxchg_gpte)(vcpu->kvm, table_gfn, index, pte,
 221                             pte|PT_DIRTY_MASK);
 222                 if (ret)
 223                         goto walk;
 224                 pte |= PT_DIRTY_MASK;
 225                 kvm_mmu_pte_write(vcpu, pte_gpa, (u8 *)&pte, sizeof(pte));
 226                 walker->ptes[walker->level - 1] = pte;
 227         }
 228
 229         walker->pt_access = pt_access;
 230         walker->pte_access = pte_access;
 231         pgprintk("%s: pte %llx pte_access %x pt_access %x\n",
 232                  __func__, (u64)pte, pt_access, pte_access);
 233         return 1;
 234
 235 not_present:
 236         walker->error_code = 0;
 237         goto err;
 238
 239 access_error:
 240         walker->error_code = PFERR_PRESENT_MASK;
 241
 242 err:
 243         if (write_fault)
 244                 walker->error_code |= PFERR_WRITE_MASK;
 245         if (user_fault)
 246                 walker->error_code |= PFERR_USER_MASK;
 247         if (fetch_fault)
 248                 walker->error_code |= PFERR_FETCH_MASK;
 249         return 0;
 250 }
 251
 252 static void FNAME(update_pte)(struct kvm_vcpu *vcpu, struct kvm_mmu_page *page,
 253                               u64 *spte, const void *pte)
 254 {
 255         pt_element_t gpte;
 256         unsigned pte_access;
 257         pfn_t pfn;
 258         int largepage = vcpu->arch.update_pte.largepage;
 259
 260         gpte = *(const pt_element_t *)pte;
 261         if (~gpte & (PT_PRESENT_MASK | PT_ACCESSED_MASK)) {
 262                 if (!is_present_pte(gpte))
 263                         set_shadow_pte(spte, shadow_notrap_nonpresent_pte);
 264                 return;
 265         }
 266         pgprintk("%s: gpte %llx spte %p\n", __func__, (u64)gpte, spte);
 267         pte_access = page->role.access & FNAME(gpte_access)(vcpu, gpte);
 268         if (gpte_to_gfn(gpte) != vcpu->arch.update_pte.gfn)
 269                 return;
 270         pfn = vcpu->arch.update_pte.pfn;
 271         if (is_error_pfn(pfn))
 272                 return;
 273         if (mmu_notifier_retry(vcpu, vcpu->arch.update_pte.mmu_seq))
 274                 return;
 275         kvm_get_pfn(pfn);
 276         mmu_set_spte(vcpu, spte, page->role.access, pte_access, 0, 0,
 277                      gpte & PT_DIRTY_MASK, NULL, largepage, gpte_to_gfn(gpte),
 278                      pfn, true);
 279 }
 280
 281 /*
 282  * Fetch a shadow pte for a specific level in the paging hierarchy.
 283  */
 284 static int FNAME(shadow_walk_entry)(struct kvm_shadow_walk *_sw,
 285                                     struct kvm_vcpu *vcpu, u64 addr,
 286                                     u64 *sptep, int level)
 287 {
 288         struct shadow_walker *sw =
 289                 container_of(_sw, struct shadow_walker, walker);
 290         struct guest_walker *gw = sw->guest_walker;
 291         unsigned access = gw->pt_access;
 292         struct kvm_mmu_page *shadow_page;
 293         u64 spte;
 294         int metaphysical;
 295         gfn_t table_gfn;
 296         int r;
 297         pt_element_t curr_pte;
 298
 299         if (level == PT_PAGE_TABLE_LEVEL
 300             || (sw->largepage && level == PT_DIRECTORY_LEVEL)) {
 301                 mmu_set_spte(vcpu, sptep, access, gw->pte_access & access,
 302                              sw->user_fault, sw->write_fault,
 303                              gw->ptes[gw->level-1] & PT_DIRTY_MASK,
 304                              sw->ptwrite, sw->largepage, gw->gfn, sw->pfn,
 305                              false);
 306                 sw->sptep = sptep;
 307                 return 1;
 308         }
 309
 310         if (is_shadow_present_pte(*sptep) && !is_large_pte(*sptep))
 311                 return 0;
 312
 313         if (is_large_pte(*sptep))
 314                 rmap_remove(vcpu->kvm, sptep);
 315
 316         if (level == PT_DIRECTORY_LEVEL && gw->level == PT_DIRECTORY_LEVEL) {
 317                 metaphysical = 1;
 318                 if (!is_dirty_pte(gw->ptes[level - 1]))
 319                         access &= ~ACC_WRITE_MASK;
 320                 table_gfn = gpte_to_gfn(gw->ptes[level - 1]);
 321         } else {
 322                 metaphysical = 0;
 323                 table_gfn = gw->table_gfn[level - 2];
 324         }
 325         shadow_page = kvm_mmu_get_page(vcpu, table_gfn, (gva_t)addr, level-1,
 326                                        metaphysical, access, sptep);
 327         if (!metaphysical) {
 328                 r = kvm_read_guest_atomic(vcpu->kvm, gw->pte_gpa[level - 2],
 329                                           &curr_pte, sizeof(curr_pte));
 330                 if (r || curr_pte != gw->ptes[level - 2]) {
 331                         kvm_release_pfn_clean(sw->pfn);
 332                         sw->sptep = NULL;
 333                         return 1;
 334                 }
 335         }
 336
 337         spte = __pa(shadow_page->spt) | PT_PRESENT_MASK | PT_ACCESSED_MASK
 338                 | PT_WRITABLE_MASK | PT_USER_MASK;
 339         *sptep = spte;
 340         return 0;
 341 }
 342
 343 static u64 *FNAME(fetch)(struct kvm_vcpu *vcpu, gva_t addr,
 344                          struct guest_walker *guest_walker,
 345                          int user_fault, int write_fault, int largepage,
 346                          int *ptwrite, pfn_t pfn)
 347 {
 348         struct shadow_walker walker = {
 349                 .walker = { .entry = FNAME(shadow_walk_entry), },
 350                 .guest_walker = guest_walker,
 351                 .user_fault = user_fault,
 352                 .write_fault = write_fault,
 353                 .largepage = largepage,
 354                 .ptwrite = ptwrite,
 355                 .pfn = pfn,
 356         };
 357
 358         if (!is_present_pte(guest_walker->ptes[guest_walker->level - 1]))
 359                 return NULL;
 360
 361         walk_shadow(&walker.walker, vcpu, addr);
 362
 363         return walker.sptep;
 364 }
 365
 366 /*
 367  * Page fault handler.  There are several causes for a page fault:
 368  *   - there is no shadow pte for the guest pte
 369  *   - write access through a shadow pte marked read only so that we can set
 370  *     the dirty bit
 371  *   - write access to a shadow pte marked read only so we can update the page
 372  *     dirty bitmap, when userspace requests it
 373  *   - mmio access; in this case we will never install a present shadow pte
 374  *   - normal guest page fault due to the guest pte marked not present, not
 375  *     writable, or not executable
 376  *
 377  *  Returns: 1 if we need to emulate the instruction, 0 otherwise, or
 378  *           a negative value on error.
 379  */
 380 static int FNAME(page_fault)(struct kvm_vcpu *vcpu, gva_t addr,
 381                                u32 error_code)
 382 {
 383         int write_fault = error_code & PFERR_WRITE_MASK;
 384         int user_fault = error_code & PFERR_USER_MASK;
 385         int fetch_fault = error_code & PFERR_FETCH_MASK;
 386         struct guest_walker walker;
 387         u64 *shadow_pte;
 388         int write_pt = 0;
 389         int r;
 390         pfn_t pfn;
 391         int largepage = 0;
 392         unsigned long mmu_seq;
 393
 394         pgprintk("%s: addr %lx err %x\n", __func__, addr, error_code);
 395         kvm_mmu_audit(vcpu, "pre page fault");
 396
 397         r = mmu_topup_memory_caches(vcpu);
 398         if (r)
 399                 return r;
 400
 401         /*
 402          * Look up the shadow pte for the faulting address.
 403          */
 404         r = FNAME(walk_addr)(&walker, vcpu, addr, write_fault, user_fault,
 405                              fetch_fault);
 406
 407         /*
 408          * The page is not mapped by the guest.  Let the guest handle it.
 409          */
 410         if (!r) {
 411                 pgprintk("%s: guest page fault\n", __func__);
 412                 inject_page_fault(vcpu, addr, walker.error_code);
 413                 vcpu->arch.last_pt_write_count = 0; /* reset fork detector */
 414                 return 0;
 415         }
 416
 417         if (walker.level == PT_DIRECTORY_LEVEL) {
 418                 gfn_t large_gfn;
 419                 large_gfn = walker.gfn & ~(KVM_PAGES_PER_HPAGE-1);
 420                 if (is_largepage_backed(vcpu, large_gfn)) {
 421                         walker.gfn = large_gfn;
 422                         largepage = 1;
 423                 }
 424         }
 425         mmu_seq = vcpu->kvm->mmu_notifier_seq;
 426         smp_rmb();
 427         pfn = gfn_to_pfn(vcpu->kvm, walker.gfn);
 428
 429         /* mmio */
 430         if (is_error_pfn(pfn)) {
 431                 pgprintk("gfn %lx is mmio\n", walker.gfn);
 432                 kvm_release_pfn_clean(pfn);
 433                 return 1;
 434         }
 435
 436         spin_lock(&vcpu->kvm->mmu_lock);
 437         if (mmu_notifier_retry(vcpu, mmu_seq))
 438                 goto out_unlock;
 439         kvm_mmu_free_some_pages(vcpu);
 440         shadow_pte = FNAME(fetch)(vcpu, addr, &walker, user_fault, write_fault,
 441                                   largepage, &write_pt, pfn);
 442
 443         pgprintk("%s: shadow pte %p %llx ptwrite %d\n", __func__,
 444                  shadow_pte, *shadow_pte, write_pt);
 445
 446         if (!write_pt)
 447                 vcpu->arch.last_pt_write_count = 0; /* reset fork detector */
 448
 449         ++vcpu->stat.pf_fixed;
 450         kvm_mmu_audit(vcpu, "post page fault (fixed)");
 451         spin_unlock(&vcpu->kvm->mmu_lock);
 452
 453         return write_pt;
 454
 455 out_unlock:
 456         spin_unlock(&vcpu->kvm->mmu_lock);
 457         kvm_release_pfn_clean(pfn);
 458         return 0;
 459 }
 460
 461 static gpa_t FNAME(gva_to_gpa)(struct kvm_vcpu *vcpu, gva_t vaddr)
 462 {
 463         struct guest_walker walker;
 464         gpa_t gpa = UNMAPPED_GVA;
 465         int r;
 466
 467         r = FNAME(walk_addr)(&walker, vcpu, vaddr, 0, 0, 0);
 468
 469         if (r) {
 470                 gpa = gfn_to_gpa(walker.gfn);
 471                 gpa |= vaddr & ~PAGE_MASK;
 472         }
 473
 474         return gpa;
 475 }
 476
 477 static void FNAME(prefetch_page)(struct kvm_vcpu *vcpu,
 478                                  struct kvm_mmu_page *sp)
 479 {
 480         int i, j, offset, r;
 481         pt_element_t pt[256 / sizeof(pt_element_t)];
 482         gpa_t pte_gpa;
 483
 484         if (sp->role.metaphysical
 485             || (PTTYPE == 32 && sp->role.level > PT_PAGE_TABLE_LEVEL)) {
 486                 nonpaging_prefetch_page(vcpu, sp);
 487                 return;
 488         }
 489
 490         pte_gpa = gfn_to_gpa(sp->gfn);
 491         if (PTTYPE == 32) {
 492                 offset = sp->role.quadrant << PT64_LEVEL_BITS;
 493                 pte_gpa += offset * sizeof(pt_element_t);
 494         }
 495
 496         for (i = 0; i < PT64_ENT_PER_PAGE; i += ARRAY_SIZE(pt)) {
 497                 r = kvm_read_guest_atomic(vcpu->kvm, pte_gpa, pt, sizeof pt);
 498                 pte_gpa += ARRAY_SIZE(pt) * sizeof(pt_element_t);
 499                 for (j = 0; j < ARRAY_SIZE(pt); ++j)
 500                         if (r || is_present_pte(pt[j]))
 501                                 sp->spt[i+j] = shadow_trap_nonpresent_pte;
 502                         else
 503                                 sp->spt[i+j] = shadow_notrap_nonpresent_pte;
 504         }
 505 }
 506
 507 #undef pt_element_t
 508 #undef guest_walker
 509 #undef shadow_walker
 510 #undef FNAME
 511 #undef PT_BASE_ADDR_MASK
 512 #undef PT_INDEX
 513 #undef PT_LEVEL_MASK
 514 #undef PT_DIR_BASE_ADDR_MASK
 515 #undef PT_LEVEL_BITS
 516 #undef PT_MAX_FULL_LEVELS
 517 #undef gpte_to_gfn
 518 #undef gpte_to_gfn_pde
 519 #undef CMPXCHG