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