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