2 * Kernel-based Virtual Machine driver for Linux
4 * This header defines architecture specific interfaces, x86 version
6 * This work is licensed under the terms of the GNU GPL, version 2. See
7 * the COPYING file in the top-level directory.
11 #ifndef ASM_KVM_HOST_H
12 #define ASM_KVM_HOST_H
14 #include <linux/types.h>
17 #include <linux/kvm.h>
18 #include <linux/kvm_para.h>
19 #include <linux/kvm_types.h>
23 #define KVM_MAX_VCPUS 16
24 #define KVM_MEMORY_SLOTS 32
25 /* memory slots that does not exposed to userspace */
26 #define KVM_PRIVATE_MEM_SLOTS 4
28 #define KVM_PIO_PAGE_OFFSET 1
30 #define CR3_PAE_RESERVED_BITS ((X86_CR3_PWT | X86_CR3_PCD) - 1)
31 #define CR3_NONPAE_RESERVED_BITS ((PAGE_SIZE-1) & ~(X86_CR3_PWT | X86_CR3_PCD))
32 #define CR3_L_MODE_RESERVED_BITS (CR3_NONPAE_RESERVED_BITS | \
33 0xFFFFFF0000000000ULL)
35 #define KVM_GUEST_CR0_MASK \
36 (X86_CR0_PG | X86_CR0_PE | X86_CR0_WP | X86_CR0_NE \
37 | X86_CR0_NW | X86_CR0_CD)
38 #define KVM_VM_CR0_ALWAYS_ON \
39 (X86_CR0_PG | X86_CR0_PE | X86_CR0_WP | X86_CR0_NE | X86_CR0_TS \
41 #define KVM_GUEST_CR4_MASK \
42 (X86_CR4_VME | X86_CR4_PSE | X86_CR4_PAE | X86_CR4_PGE | X86_CR4_VMXE)
43 #define KVM_PMODE_VM_CR4_ALWAYS_ON (X86_CR4_PAE | X86_CR4_VMXE)
44 #define KVM_RMODE_VM_CR4_ALWAYS_ON (X86_CR4_VME | X86_CR4_PAE | X86_CR4_VMXE)
46 #define INVALID_PAGE (~(hpa_t)0)
47 #define UNMAPPED_GVA (~(gpa_t)0)
49 /* shadow tables are PAE even on non-PAE hosts */
50 #define KVM_HPAGE_SHIFT 21
51 #define KVM_HPAGE_SIZE (1UL << KVM_HPAGE_SHIFT)
52 #define KVM_HPAGE_MASK (~(KVM_HPAGE_SIZE - 1))
54 #define KVM_PAGES_PER_HPAGE (KVM_HPAGE_SIZE / PAGE_SIZE)
67 #define SELECTOR_TI_MASK (1 << 2)
68 #define SELECTOR_RPL_MASK 0x03
72 #define KVM_ALIAS_SLOTS 4
74 #define KVM_PERMILLE_MMU_PAGES 20
75 #define KVM_MIN_ALLOC_MMU_PAGES 64
76 #define KVM_MMU_HASH_SHIFT 10
77 #define KVM_NUM_MMU_PAGES (1 << KVM_MMU_HASH_SHIFT)
78 #define KVM_MIN_FREE_MMU_PAGES 5
79 #define KVM_REFILL_PAGES 25
80 #define KVM_MAX_CPUID_ENTRIES 40
82 extern spinlock_t kvm_lock;
83 extern struct list_head vm_list;
121 #include <asm/kvm_x86_emulate.h>
123 #define KVM_NR_MEM_OBJS 40
125 struct kvm_guest_debug {
132 * We don't want allocation failures within the mmu code, so we preallocate
133 * enough memory for a single page fault in a cache.
135 struct kvm_mmu_memory_cache {
137 void *objects[KVM_NR_MEM_OBJS];
140 #define NR_PTE_CHAIN_ENTRIES 5
142 struct kvm_pte_chain {
143 u64 *parent_ptes[NR_PTE_CHAIN_ENTRIES];
144 struct hlist_node link;
148 * kvm_mmu_page_role, below, is defined as:
150 * bits 0:3 - total guest paging levels (2-4, or zero for real mode)
151 * bits 4:7 - page table level for this shadow (1-4)
152 * bits 8:9 - page table quadrant for 2-level guests
153 * bit 16 - "metaphysical" - gfn is not a real page (huge page/real mode)
154 * bits 17:19 - common access permissions for all ptes in this shadow page
156 union kvm_mmu_page_role {
162 unsigned pad_for_nice_hex_output:6;
163 unsigned metaphysical:1;
169 struct kvm_mmu_page {
170 struct list_head link;
171 struct hlist_node hash_link;
174 * The following two entries are used to key the shadow page in the
178 union kvm_mmu_page_role role;
181 /* hold the gfn of each spte inside spt */
183 unsigned long slot_bitmap; /* One bit set per slot which has memory
184 * in this shadow page.
186 int multimapped; /* More than one parent_pte? */
187 int root_count; /* Currently serving as active root */
189 u64 *parent_pte; /* !multimapped */
190 struct hlist_head parent_ptes; /* multimapped, kvm_pte_chain */
195 * x86 supports 3 paging modes (4-level 64-bit, 3-level 64-bit, and 2-level
196 * 32-bit). The kvm_mmu structure abstracts the details of the current mmu
200 void (*new_cr3)(struct kvm_vcpu *vcpu);
201 int (*page_fault)(struct kvm_vcpu *vcpu, gva_t gva, u32 err);
202 void (*free)(struct kvm_vcpu *vcpu);
203 gpa_t (*gva_to_gpa)(struct kvm_vcpu *vcpu, gva_t gva);
204 void (*prefetch_page)(struct kvm_vcpu *vcpu,
205 struct kvm_mmu_page *page);
208 int shadow_root_level;
213 struct kvm_vcpu_arch {
215 int interrupt_window_open;
216 unsigned long irq_summary; /* bit vector: 1 per word in irq_pending */
217 DECLARE_BITMAP(irq_pending, KVM_NR_INTERRUPTS);
218 unsigned long regs[NR_VCPU_REGS]; /* for rsp: vcpu_load_rsp_rip() */
219 unsigned long rip; /* needs vcpu_load_rsp_rip() */
226 u64 pdptrs[4]; /* pae */
229 struct kvm_lapic *apic; /* kernel irqchip context */
232 u64 ia32_misc_enable_msr;
233 bool tpr_access_reporting;
237 struct kvm_mmu_memory_cache mmu_pte_chain_cache;
238 struct kvm_mmu_memory_cache mmu_rmap_desc_cache;
239 struct kvm_mmu_memory_cache mmu_page_cache;
240 struct kvm_mmu_memory_cache mmu_page_header_cache;
242 gfn_t last_pt_write_gfn;
243 int last_pt_write_count;
244 u64 *last_pte_updated;
247 gfn_t gfn; /* presumed gfn during guest pte update */
248 pfn_t pfn; /* pfn corresponding to that gfn */
252 struct i387_fxsave_struct host_fx_image;
253 struct i387_fxsave_struct guest_fx_image;
255 gva_t mmio_fault_cr2;
256 struct kvm_pio_request pio;
259 struct kvm_queued_exception {
269 struct kvm_save_segment {
274 } tr, es, ds, fs, gs;
276 int halt_request; /* real mode on Intel only */
279 struct kvm_cpuid_entry2 cpuid_entries[KVM_MAX_CPUID_ENTRIES];
280 /* emulate context */
282 struct x86_emulate_ctxt emulate_ctxt;
285 struct kvm_vcpu_time_info hv_clock;
286 unsigned int time_offset;
287 struct page *time_page;
290 struct kvm_mem_alias {
292 unsigned long npages;
298 struct kvm_mem_alias aliases[KVM_ALIAS_SLOTS];
300 unsigned int n_free_mmu_pages;
301 unsigned int n_requested_mmu_pages;
302 unsigned int n_alloc_mmu_pages;
303 struct hlist_head mmu_page_hash[KVM_NUM_MMU_PAGES];
305 * Hash table of struct kvm_mmu_page.
307 struct list_head active_mmu_pages;
308 struct kvm_pic *vpic;
309 struct kvm_ioapic *vioapic;
310 struct kvm_pit *vpit;
312 int round_robin_prev_vcpu;
313 unsigned int tss_addr;
314 struct page *apic_access_page;
320 u32 mmu_shadow_zapped;
327 u32 remote_tlb_flush;
331 struct kvm_vcpu_stat {
341 u32 irq_window_exits;
344 u32 request_irq_exits;
346 u32 host_state_reload;
350 u32 insn_emulation_fail;
354 struct descriptor_table {
357 } __attribute__((packed));
360 int (*cpu_has_kvm_support)(void); /* __init */
361 int (*disabled_by_bios)(void); /* __init */
362 void (*hardware_enable)(void *dummy); /* __init */
363 void (*hardware_disable)(void *dummy);
364 void (*check_processor_compatibility)(void *rtn);
365 int (*hardware_setup)(void); /* __init */
366 void (*hardware_unsetup)(void); /* __exit */
367 bool (*cpu_has_accelerated_tpr)(void);
369 /* Create, but do not attach this VCPU */
370 struct kvm_vcpu *(*vcpu_create)(struct kvm *kvm, unsigned id);
371 void (*vcpu_free)(struct kvm_vcpu *vcpu);
372 int (*vcpu_reset)(struct kvm_vcpu *vcpu);
374 void (*prepare_guest_switch)(struct kvm_vcpu *vcpu);
375 void (*vcpu_load)(struct kvm_vcpu *vcpu, int cpu);
376 void (*vcpu_put)(struct kvm_vcpu *vcpu);
377 void (*vcpu_decache)(struct kvm_vcpu *vcpu);
379 int (*set_guest_debug)(struct kvm_vcpu *vcpu,
380 struct kvm_debug_guest *dbg);
381 void (*guest_debug_pre)(struct kvm_vcpu *vcpu);
382 int (*get_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 *pdata);
383 int (*set_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
384 u64 (*get_segment_base)(struct kvm_vcpu *vcpu, int seg);
385 void (*get_segment)(struct kvm_vcpu *vcpu,
386 struct kvm_segment *var, int seg);
387 int (*get_cpl)(struct kvm_vcpu *vcpu);
388 void (*set_segment)(struct kvm_vcpu *vcpu,
389 struct kvm_segment *var, int seg);
390 void (*get_cs_db_l_bits)(struct kvm_vcpu *vcpu, int *db, int *l);
391 void (*decache_cr4_guest_bits)(struct kvm_vcpu *vcpu);
392 void (*set_cr0)(struct kvm_vcpu *vcpu, unsigned long cr0);
393 void (*set_cr3)(struct kvm_vcpu *vcpu, unsigned long cr3);
394 void (*set_cr4)(struct kvm_vcpu *vcpu, unsigned long cr4);
395 void (*set_efer)(struct kvm_vcpu *vcpu, u64 efer);
396 void (*get_idt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
397 void (*set_idt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
398 void (*get_gdt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
399 void (*set_gdt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
400 unsigned long (*get_dr)(struct kvm_vcpu *vcpu, int dr);
401 void (*set_dr)(struct kvm_vcpu *vcpu, int dr, unsigned long value,
403 void (*cache_regs)(struct kvm_vcpu *vcpu);
404 void (*decache_regs)(struct kvm_vcpu *vcpu);
405 unsigned long (*get_rflags)(struct kvm_vcpu *vcpu);
406 void (*set_rflags)(struct kvm_vcpu *vcpu, unsigned long rflags);
408 void (*tlb_flush)(struct kvm_vcpu *vcpu);
410 void (*run)(struct kvm_vcpu *vcpu, struct kvm_run *run);
411 int (*handle_exit)(struct kvm_run *run, struct kvm_vcpu *vcpu);
412 void (*skip_emulated_instruction)(struct kvm_vcpu *vcpu);
413 void (*patch_hypercall)(struct kvm_vcpu *vcpu,
414 unsigned char *hypercall_addr);
415 int (*get_irq)(struct kvm_vcpu *vcpu);
416 void (*set_irq)(struct kvm_vcpu *vcpu, int vec);
417 void (*queue_exception)(struct kvm_vcpu *vcpu, unsigned nr,
418 bool has_error_code, u32 error_code);
419 bool (*exception_injected)(struct kvm_vcpu *vcpu);
420 void (*inject_pending_irq)(struct kvm_vcpu *vcpu);
421 void (*inject_pending_vectors)(struct kvm_vcpu *vcpu,
422 struct kvm_run *run);
424 int (*set_tss_addr)(struct kvm *kvm, unsigned int addr);
427 extern struct kvm_x86_ops *kvm_x86_ops;
429 int kvm_mmu_module_init(void);
430 void kvm_mmu_module_exit(void);
432 void kvm_mmu_destroy(struct kvm_vcpu *vcpu);
433 int kvm_mmu_create(struct kvm_vcpu *vcpu);
434 int kvm_mmu_setup(struct kvm_vcpu *vcpu);
435 void kvm_mmu_set_nonpresent_ptes(u64 trap_pte, u64 notrap_pte);
437 int kvm_mmu_reset_context(struct kvm_vcpu *vcpu);
438 void kvm_mmu_slot_remove_write_access(struct kvm *kvm, int slot);
439 void kvm_mmu_zap_all(struct kvm *kvm);
440 unsigned int kvm_mmu_calculate_mmu_pages(struct kvm *kvm);
441 void kvm_mmu_change_mmu_pages(struct kvm *kvm, unsigned int kvm_nr_mmu_pages);
443 int load_pdptrs(struct kvm_vcpu *vcpu, unsigned long cr3);
445 int emulator_write_phys(struct kvm_vcpu *vcpu, gpa_t gpa,
446 const void *val, int bytes);
447 int kvm_pv_mmu_op(struct kvm_vcpu *vcpu, unsigned long bytes,
448 gpa_t addr, unsigned long *ret);
450 extern bool tdp_enabled;
452 enum emulation_result {
453 EMULATE_DONE, /* no further processing */
454 EMULATE_DO_MMIO, /* kvm_run filled with mmio request */
455 EMULATE_FAIL, /* can't emulate this instruction */
458 #define EMULTYPE_NO_DECODE (1 << 0)
459 #define EMULTYPE_TRAP_UD (1 << 1)
460 int emulate_instruction(struct kvm_vcpu *vcpu, struct kvm_run *run,
461 unsigned long cr2, u16 error_code, int emulation_type);
462 void kvm_report_emulation_failure(struct kvm_vcpu *cvpu, const char *context);
463 void realmode_lgdt(struct kvm_vcpu *vcpu, u16 size, unsigned long address);
464 void realmode_lidt(struct kvm_vcpu *vcpu, u16 size, unsigned long address);
465 void realmode_lmsw(struct kvm_vcpu *vcpu, unsigned long msw,
466 unsigned long *rflags);
468 unsigned long realmode_get_cr(struct kvm_vcpu *vcpu, int cr);
469 void realmode_set_cr(struct kvm_vcpu *vcpu, int cr, unsigned long value,
470 unsigned long *rflags);
471 void kvm_enable_efer_bits(u64);
472 int kvm_get_msr(struct kvm_vcpu *vcpu, u32 msr_index, u64 *data);
473 int kvm_set_msr(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
475 struct x86_emulate_ctxt;
477 int kvm_emulate_pio(struct kvm_vcpu *vcpu, struct kvm_run *run, int in,
478 int size, unsigned port);
479 int kvm_emulate_pio_string(struct kvm_vcpu *vcpu, struct kvm_run *run, int in,
480 int size, unsigned long count, int down,
481 gva_t address, int rep, unsigned port);
482 void kvm_emulate_cpuid(struct kvm_vcpu *vcpu);
483 int kvm_emulate_halt(struct kvm_vcpu *vcpu);
484 int emulate_invlpg(struct kvm_vcpu *vcpu, gva_t address);
485 int emulate_clts(struct kvm_vcpu *vcpu);
486 int emulator_get_dr(struct x86_emulate_ctxt *ctxt, int dr,
487 unsigned long *dest);
488 int emulator_set_dr(struct x86_emulate_ctxt *ctxt, int dr,
489 unsigned long value);
491 int kvm_task_switch(struct kvm_vcpu *vcpu, u16 tss_selector, int reason);
493 void kvm_set_cr0(struct kvm_vcpu *vcpu, unsigned long cr0);
494 void kvm_set_cr3(struct kvm_vcpu *vcpu, unsigned long cr3);
495 void kvm_set_cr4(struct kvm_vcpu *vcpu, unsigned long cr4);
496 void kvm_set_cr8(struct kvm_vcpu *vcpu, unsigned long cr8);
497 unsigned long kvm_get_cr8(struct kvm_vcpu *vcpu);
498 void kvm_lmsw(struct kvm_vcpu *vcpu, unsigned long msw);
499 void kvm_get_cs_db_l_bits(struct kvm_vcpu *vcpu, int *db, int *l);
501 int kvm_get_msr_common(struct kvm_vcpu *vcpu, u32 msr, u64 *pdata);
502 int kvm_set_msr_common(struct kvm_vcpu *vcpu, u32 msr, u64 data);
504 void kvm_queue_exception(struct kvm_vcpu *vcpu, unsigned nr);
505 void kvm_queue_exception_e(struct kvm_vcpu *vcpu, unsigned nr, u32 error_code);
506 void kvm_inject_page_fault(struct kvm_vcpu *vcpu, unsigned long cr2,
509 void fx_init(struct kvm_vcpu *vcpu);
511 int emulator_read_std(unsigned long addr,
514 struct kvm_vcpu *vcpu);
515 int emulator_write_emulated(unsigned long addr,
518 struct kvm_vcpu *vcpu);
520 unsigned long segment_base(u16 selector);
522 void kvm_mmu_flush_tlb(struct kvm_vcpu *vcpu);
523 void kvm_mmu_pte_write(struct kvm_vcpu *vcpu, gpa_t gpa,
524 const u8 *new, int bytes);
525 int kvm_mmu_unprotect_page_virt(struct kvm_vcpu *vcpu, gva_t gva);
526 void __kvm_mmu_free_some_pages(struct kvm_vcpu *vcpu);
527 int kvm_mmu_load(struct kvm_vcpu *vcpu);
528 void kvm_mmu_unload(struct kvm_vcpu *vcpu);
530 int kvm_emulate_hypercall(struct kvm_vcpu *vcpu);
532 int kvm_fix_hypercall(struct kvm_vcpu *vcpu);
534 int kvm_mmu_page_fault(struct kvm_vcpu *vcpu, gva_t gva, u32 error_code);
536 void kvm_enable_tdp(void);
538 int load_pdptrs(struct kvm_vcpu *vcpu, unsigned long cr3);
539 int complete_pio(struct kvm_vcpu *vcpu);
541 static inline struct kvm_mmu_page *page_header(hpa_t shadow_page)
543 struct page *page = pfn_to_page(shadow_page >> PAGE_SHIFT);
545 return (struct kvm_mmu_page *)page_private(page);
548 static inline u16 read_fs(void)
551 asm("mov %%fs, %0" : "=g"(seg));
555 static inline u16 read_gs(void)
558 asm("mov %%gs, %0" : "=g"(seg));
562 static inline u16 read_ldt(void)
565 asm("sldt %0" : "=g"(ldt));
569 static inline void load_fs(u16 sel)
571 asm("mov %0, %%fs" : : "rm"(sel));
574 static inline void load_gs(u16 sel)
576 asm("mov %0, %%gs" : : "rm"(sel));
580 static inline void load_ldt(u16 sel)
582 asm("lldt %0" : : "rm"(sel));
586 static inline void get_idt(struct descriptor_table *table)
588 asm("sidt %0" : "=m"(*table));
591 static inline void get_gdt(struct descriptor_table *table)
593 asm("sgdt %0" : "=m"(*table));
596 static inline unsigned long read_tr_base(void)
599 asm("str %0" : "=g"(tr));
600 return segment_base(tr);
604 static inline unsigned long read_msr(unsigned long msr)
613 static inline void fx_save(struct i387_fxsave_struct *image)
615 asm("fxsave (%0)":: "r" (image));
618 static inline void fx_restore(struct i387_fxsave_struct *image)
620 asm("fxrstor (%0)":: "r" (image));
623 static inline void fpu_init(void)
628 static inline u32 get_rdx_init_val(void)
630 return 0x600; /* P6 family */
633 static inline void kvm_inject_gp(struct kvm_vcpu *vcpu, u32 error_code)
635 kvm_queue_exception_e(vcpu, GP_VECTOR, error_code);
638 #define ASM_VMX_VMCLEAR_RAX ".byte 0x66, 0x0f, 0xc7, 0x30"
639 #define ASM_VMX_VMLAUNCH ".byte 0x0f, 0x01, 0xc2"
640 #define ASM_VMX_VMRESUME ".byte 0x0f, 0x01, 0xc3"
641 #define ASM_VMX_VMPTRLD_RAX ".byte 0x0f, 0xc7, 0x30"
642 #define ASM_VMX_VMREAD_RDX_RAX ".byte 0x0f, 0x78, 0xd0"
643 #define ASM_VMX_VMWRITE_RAX_RDX ".byte 0x0f, 0x79, 0xd0"
644 #define ASM_VMX_VMWRITE_RSP_RDX ".byte 0x0f, 0x79, 0xd4"
645 #define ASM_VMX_VMXOFF ".byte 0x0f, 0x01, 0xc4"
646 #define ASM_VMX_VMXON_RAX ".byte 0xf3, 0x0f, 0xc7, 0x30"
647 #define ASM_VMX_INVVPID ".byte 0x66, 0x0f, 0x38, 0x81, 0x08"
649 #define MSR_IA32_TIME_STAMP_COUNTER 0x010
651 #define TSS_IOPB_BASE_OFFSET 0x66
652 #define TSS_BASE_SIZE 0x68
653 #define TSS_IOPB_SIZE (65536 / 8)
654 #define TSS_REDIRECTION_SIZE (256 / 8)
655 #define RMODE_TSS_SIZE \
656 (TSS_BASE_SIZE + TSS_REDIRECTION_SIZE + TSS_IOPB_SIZE + 1)
659 TASK_SWITCH_CALL = 0,
660 TASK_SWITCH_IRET = 1,
662 TASK_SWITCH_GATE = 3,
665 #define KVMTRACE_5D(evt, vcpu, d1, d2, d3, d4, d5, name) \
666 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
667 vcpu, 5, d1, d2, d3, d4, d5)
668 #define KVMTRACE_4D(evt, vcpu, d1, d2, d3, d4, name) \
669 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
670 vcpu, 4, d1, d2, d3, d4, 0)
671 #define KVMTRACE_3D(evt, vcpu, d1, d2, d3, name) \
672 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
673 vcpu, 3, d1, d2, d3, 0, 0)
674 #define KVMTRACE_2D(evt, vcpu, d1, d2, name) \
675 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
676 vcpu, 2, d1, d2, 0, 0, 0)
677 #define KVMTRACE_1D(evt, vcpu, d1, name) \
678 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
679 vcpu, 1, d1, 0, 0, 0, 0)
680 #define KVMTRACE_0D(evt, vcpu, name) \
681 trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
682 vcpu, 0, 0, 0, 0, 0, 0)