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