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.
17 #include <linux/types.h>
20 #include <linux/kvm.h>
21 #include <linux/kvm_para.h>
25 #define CR3_PAE_RESERVED_BITS ((X86_CR3_PWT | X86_CR3_PCD) - 1)
26 #define CR3_NONPAE_RESERVED_BITS ((PAGE_SIZE-1) & ~(X86_CR3_PWT | X86_CR3_PCD))
27 #define CR3_L_MODE_RESERVED_BITS (CR3_NONPAE_RESERVED_BITS|0xFFFFFF0000000000ULL)
29 #define KVM_GUEST_CR0_MASK \
30 (X86_CR0_PG | X86_CR0_PE | X86_CR0_WP | X86_CR0_NE \
31 | X86_CR0_NW | X86_CR0_CD)
32 #define KVM_VM_CR0_ALWAYS_ON \
33 (X86_CR0_PG | X86_CR0_PE | X86_CR0_WP | X86_CR0_NE | X86_CR0_TS \
35 #define KVM_GUEST_CR4_MASK \
36 (X86_CR4_VME | X86_CR4_PSE | X86_CR4_PAE | X86_CR4_PGE | X86_CR4_VMXE)
37 #define KVM_PMODE_VM_CR4_ALWAYS_ON (X86_CR4_PAE | X86_CR4_VMXE)
38 #define KVM_RMODE_VM_CR4_ALWAYS_ON (X86_CR4_VME | X86_CR4_PAE | X86_CR4_VMXE)
40 #define INVALID_PAGE (~(hpa_t)0)
41 #define UNMAPPED_GVA (~(gpa_t)0)
53 #define SELECTOR_TI_MASK (1 << 2)
54 #define SELECTOR_RPL_MASK 0x03
58 extern spinlock_t kvm_lock;
59 extern struct list_head vm_list;
94 #include "x86_emulate.h"
99 int interrupt_window_open;
100 unsigned long irq_summary; /* bit vector: 1 per word in irq_pending */
101 DECLARE_BITMAP(irq_pending, KVM_NR_INTERRUPTS);
102 unsigned long regs[NR_VCPU_REGS]; /* for rsp: vcpu_load_rsp_rip() */
103 unsigned long rip; /* needs vcpu_load_rsp_rip() */
110 u64 pdptrs[4]; /* pae */
113 struct kvm_lapic *apic; /* kernel irqchip context */
114 #define VCPU_MP_STATE_RUNNABLE 0
115 #define VCPU_MP_STATE_UNINITIALIZED 1
116 #define VCPU_MP_STATE_INIT_RECEIVED 2
117 #define VCPU_MP_STATE_SIPI_RECEIVED 3
118 #define VCPU_MP_STATE_HALTED 4
121 u64 ia32_misc_enable_msr;
125 struct kvm_mmu_memory_cache mmu_pte_chain_cache;
126 struct kvm_mmu_memory_cache mmu_rmap_desc_cache;
127 struct kvm_mmu_memory_cache mmu_page_cache;
128 struct kvm_mmu_memory_cache mmu_page_header_cache;
130 gfn_t last_pt_write_gfn;
131 int last_pt_write_count;
132 u64 *last_pte_updated;
135 struct i387_fxsave_struct host_fx_image;
136 struct i387_fxsave_struct guest_fx_image;
138 gva_t mmio_fault_cr2;
139 struct kvm_pio_request pio;
142 struct kvm_queued_exception {
152 struct kvm_save_segment {
157 } tr, es, ds, fs, gs;
159 int halt_request; /* real mode on Intel only */
162 struct kvm_cpuid_entry2 cpuid_entries[KVM_MAX_CPUID_ENTRIES];
164 /* emulate context */
166 struct x86_emulate_ctxt emulate_ctxt;
169 struct descriptor_table {
172 } __attribute__((packed));
175 int (*cpu_has_kvm_support)(void); /* __init */
176 int (*disabled_by_bios)(void); /* __init */
177 void (*hardware_enable)(void *dummy); /* __init */
178 void (*hardware_disable)(void *dummy);
179 void (*check_processor_compatibility)(void *rtn);
180 int (*hardware_setup)(void); /* __init */
181 void (*hardware_unsetup)(void); /* __exit */
183 /* Create, but do not attach this VCPU */
184 struct kvm_vcpu *(*vcpu_create)(struct kvm *kvm, unsigned id);
185 void (*vcpu_free)(struct kvm_vcpu *vcpu);
186 int (*vcpu_reset)(struct kvm_vcpu *vcpu);
188 void (*prepare_guest_switch)(struct kvm_vcpu *vcpu);
189 void (*vcpu_load)(struct kvm_vcpu *vcpu, int cpu);
190 void (*vcpu_put)(struct kvm_vcpu *vcpu);
191 void (*vcpu_decache)(struct kvm_vcpu *vcpu);
193 int (*set_guest_debug)(struct kvm_vcpu *vcpu,
194 struct kvm_debug_guest *dbg);
195 void (*guest_debug_pre)(struct kvm_vcpu *vcpu);
196 int (*get_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 *pdata);
197 int (*set_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
198 u64 (*get_segment_base)(struct kvm_vcpu *vcpu, int seg);
199 void (*get_segment)(struct kvm_vcpu *vcpu,
200 struct kvm_segment *var, int seg);
201 void (*set_segment)(struct kvm_vcpu *vcpu,
202 struct kvm_segment *var, int seg);
203 void (*get_cs_db_l_bits)(struct kvm_vcpu *vcpu, int *db, int *l);
204 void (*decache_cr4_guest_bits)(struct kvm_vcpu *vcpu);
205 void (*set_cr0)(struct kvm_vcpu *vcpu, unsigned long cr0);
206 void (*set_cr3)(struct kvm_vcpu *vcpu, unsigned long cr3);
207 void (*set_cr4)(struct kvm_vcpu *vcpu, unsigned long cr4);
208 void (*set_efer)(struct kvm_vcpu *vcpu, u64 efer);
209 void (*get_idt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
210 void (*set_idt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
211 void (*get_gdt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
212 void (*set_gdt)(struct kvm_vcpu *vcpu, struct descriptor_table *dt);
213 unsigned long (*get_dr)(struct kvm_vcpu *vcpu, int dr);
214 void (*set_dr)(struct kvm_vcpu *vcpu, int dr, unsigned long value,
216 void (*cache_regs)(struct kvm_vcpu *vcpu);
217 void (*decache_regs)(struct kvm_vcpu *vcpu);
218 unsigned long (*get_rflags)(struct kvm_vcpu *vcpu);
219 void (*set_rflags)(struct kvm_vcpu *vcpu, unsigned long rflags);
221 void (*tlb_flush)(struct kvm_vcpu *vcpu);
223 void (*run)(struct kvm_vcpu *vcpu, struct kvm_run *run);
224 int (*handle_exit)(struct kvm_run *run, struct kvm_vcpu *vcpu);
225 void (*skip_emulated_instruction)(struct kvm_vcpu *vcpu);
226 void (*patch_hypercall)(struct kvm_vcpu *vcpu,
227 unsigned char *hypercall_addr);
228 int (*get_irq)(struct kvm_vcpu *vcpu);
229 void (*set_irq)(struct kvm_vcpu *vcpu, int vec);
230 void (*queue_exception)(struct kvm_vcpu *vcpu, unsigned nr,
231 bool has_error_code, u32 error_code);
232 bool (*exception_injected)(struct kvm_vcpu *vcpu);
233 void (*inject_pending_irq)(struct kvm_vcpu *vcpu);
234 void (*inject_pending_vectors)(struct kvm_vcpu *vcpu,
235 struct kvm_run *run);
237 int (*set_tss_addr)(struct kvm *kvm, unsigned int addr);
240 extern struct kvm_x86_ops *kvm_x86_ops;
242 int kvm_mmu_module_init(void);
243 void kvm_mmu_module_exit(void);
245 void kvm_mmu_destroy(struct kvm_vcpu *vcpu);
246 int kvm_mmu_create(struct kvm_vcpu *vcpu);
247 int kvm_mmu_setup(struct kvm_vcpu *vcpu);
248 void kvm_mmu_set_nonpresent_ptes(u64 trap_pte, u64 notrap_pte);
250 int kvm_mmu_reset_context(struct kvm_vcpu *vcpu);
251 void kvm_mmu_slot_remove_write_access(struct kvm *kvm, int slot);
252 void kvm_mmu_zap_all(struct kvm *kvm);
253 unsigned int kvm_mmu_calculate_mmu_pages(struct kvm *kvm);
254 void kvm_mmu_change_mmu_pages(struct kvm *kvm, unsigned int kvm_nr_mmu_pages);
256 enum emulation_result {
257 EMULATE_DONE, /* no further processing */
258 EMULATE_DO_MMIO, /* kvm_run filled with mmio request */
259 EMULATE_FAIL, /* can't emulate this instruction */
262 int emulate_instruction(struct kvm_vcpu *vcpu, struct kvm_run *run,
263 unsigned long cr2, u16 error_code, int no_decode);
264 void kvm_report_emulation_failure(struct kvm_vcpu *cvpu, const char *context);
265 void realmode_lgdt(struct kvm_vcpu *vcpu, u16 size, unsigned long address);
266 void realmode_lidt(struct kvm_vcpu *vcpu, u16 size, unsigned long address);
267 void realmode_lmsw(struct kvm_vcpu *vcpu, unsigned long msw,
268 unsigned long *rflags);
270 unsigned long realmode_get_cr(struct kvm_vcpu *vcpu, int cr);
271 void realmode_set_cr(struct kvm_vcpu *vcpu, int cr, unsigned long value,
272 unsigned long *rflags);
273 int kvm_get_msr(struct kvm_vcpu *vcpu, u32 msr_index, u64 *data);
274 int kvm_set_msr(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
276 struct x86_emulate_ctxt;
278 int kvm_emulate_pio(struct kvm_vcpu *vcpu, struct kvm_run *run, int in,
279 int size, unsigned port);
280 int kvm_emulate_pio_string(struct kvm_vcpu *vcpu, struct kvm_run *run, int in,
281 int size, unsigned long count, int down,
282 gva_t address, int rep, unsigned port);
283 void kvm_emulate_cpuid(struct kvm_vcpu *vcpu);
284 int kvm_emulate_halt(struct kvm_vcpu *vcpu);
285 int emulate_invlpg(struct kvm_vcpu *vcpu, gva_t address);
286 int emulate_clts(struct kvm_vcpu *vcpu);
287 int emulator_get_dr(struct x86_emulate_ctxt *ctxt, int dr,
288 unsigned long *dest);
289 int emulator_set_dr(struct x86_emulate_ctxt *ctxt, int dr,
290 unsigned long value);
292 void set_cr0(struct kvm_vcpu *vcpu, unsigned long cr0);
293 void set_cr3(struct kvm_vcpu *vcpu, unsigned long cr0);
294 void set_cr4(struct kvm_vcpu *vcpu, unsigned long cr0);
295 void set_cr8(struct kvm_vcpu *vcpu, unsigned long cr0);
296 unsigned long get_cr8(struct kvm_vcpu *vcpu);
297 void lmsw(struct kvm_vcpu *vcpu, unsigned long msw);
298 void kvm_get_cs_db_l_bits(struct kvm_vcpu *vcpu, int *db, int *l);
300 int kvm_get_msr_common(struct kvm_vcpu *vcpu, u32 msr, u64 *pdata);
301 int kvm_set_msr_common(struct kvm_vcpu *vcpu, u32 msr, u64 data);
303 void kvm_queue_exception(struct kvm_vcpu *vcpu, unsigned nr);
304 void kvm_queue_exception_e(struct kvm_vcpu *vcpu, unsigned nr, u32 error_code);
305 void kvm_inject_page_fault(struct kvm_vcpu *vcpu, unsigned long cr2,
308 void fx_init(struct kvm_vcpu *vcpu);
310 int emulator_read_std(unsigned long addr,
313 struct kvm_vcpu *vcpu);
314 int emulator_write_emulated(unsigned long addr,
317 struct kvm_vcpu *vcpu);
319 unsigned long segment_base(u16 selector);
321 void kvm_mmu_flush_tlb(struct kvm_vcpu *vcpu);
322 void kvm_mmu_pte_write(struct kvm_vcpu *vcpu, gpa_t gpa,
323 const u8 *new, int bytes);
324 int kvm_mmu_unprotect_page_virt(struct kvm_vcpu *vcpu, gva_t gva);
325 void __kvm_mmu_free_some_pages(struct kvm_vcpu *vcpu);
326 int kvm_mmu_load(struct kvm_vcpu *vcpu);
327 void kvm_mmu_unload(struct kvm_vcpu *vcpu);
329 int kvm_emulate_hypercall(struct kvm_vcpu *vcpu);
331 int kvm_fix_hypercall(struct kvm_vcpu *vcpu);
333 int kvm_mmu_page_fault(struct kvm_vcpu *vcpu, gva_t gva, u32 error_code);
335 static inline void kvm_mmu_free_some_pages(struct kvm_vcpu *vcpu)
337 if (unlikely(vcpu->kvm->n_free_mmu_pages < KVM_MIN_FREE_MMU_PAGES))
338 __kvm_mmu_free_some_pages(vcpu);
341 static inline int kvm_mmu_reload(struct kvm_vcpu *vcpu)
343 if (likely(vcpu->mmu.root_hpa != INVALID_PAGE))
346 return kvm_mmu_load(vcpu);
349 static inline int is_long_mode(struct kvm_vcpu *vcpu)
352 return vcpu->shadow_efer & EFER_LME;
358 static inline int is_pae(struct kvm_vcpu *vcpu)
360 return vcpu->cr4 & X86_CR4_PAE;
363 static inline int is_pse(struct kvm_vcpu *vcpu)
365 return vcpu->cr4 & X86_CR4_PSE;
368 static inline int is_paging(struct kvm_vcpu *vcpu)
370 return vcpu->cr0 & X86_CR0_PG;
373 int load_pdptrs(struct kvm_vcpu *vcpu, unsigned long cr3);
374 int complete_pio(struct kvm_vcpu *vcpu);
376 static inline struct kvm_mmu_page *page_header(hpa_t shadow_page)
378 struct page *page = pfn_to_page(shadow_page >> PAGE_SHIFT);
380 return (struct kvm_mmu_page *)page_private(page);
383 static inline u16 read_fs(void)
386 asm("mov %%fs, %0" : "=g"(seg));
390 static inline u16 read_gs(void)
393 asm("mov %%gs, %0" : "=g"(seg));
397 static inline u16 read_ldt(void)
400 asm("sldt %0" : "=g"(ldt));
404 static inline void load_fs(u16 sel)
406 asm("mov %0, %%fs" : : "rm"(sel));
409 static inline void load_gs(u16 sel)
411 asm("mov %0, %%gs" : : "rm"(sel));
415 static inline void load_ldt(u16 sel)
417 asm("lldt %0" : : "rm"(sel));
421 static inline void get_idt(struct descriptor_table *table)
423 asm("sidt %0" : "=m"(*table));
426 static inline void get_gdt(struct descriptor_table *table)
428 asm("sgdt %0" : "=m"(*table));
431 static inline unsigned long read_tr_base(void)
434 asm("str %0" : "=g"(tr));
435 return segment_base(tr);
439 static inline unsigned long read_msr(unsigned long msr)
448 static inline void fx_save(struct i387_fxsave_struct *image)
450 asm("fxsave (%0)":: "r" (image));
453 static inline void fx_restore(struct i387_fxsave_struct *image)
455 asm("fxrstor (%0)":: "r" (image));
458 static inline void fpu_init(void)
463 static inline u32 get_rdx_init_val(void)
465 return 0x600; /* P6 family */
468 static inline void kvm_inject_gp(struct kvm_vcpu *vcpu, u32 error_code)
470 kvm_queue_exception_e(vcpu, GP_VECTOR, error_code);
473 #define ASM_VMX_VMCLEAR_RAX ".byte 0x66, 0x0f, 0xc7, 0x30"
474 #define ASM_VMX_VMLAUNCH ".byte 0x0f, 0x01, 0xc2"
475 #define ASM_VMX_VMRESUME ".byte 0x0f, 0x01, 0xc3"
476 #define ASM_VMX_VMPTRLD_RAX ".byte 0x0f, 0xc7, 0x30"
477 #define ASM_VMX_VMREAD_RDX_RAX ".byte 0x0f, 0x78, 0xd0"
478 #define ASM_VMX_VMWRITE_RAX_RDX ".byte 0x0f, 0x79, 0xd0"
479 #define ASM_VMX_VMWRITE_RSP_RDX ".byte 0x0f, 0x79, 0xd4"
480 #define ASM_VMX_VMXOFF ".byte 0x0f, 0x01, 0xc4"
481 #define ASM_VMX_VMXON_RAX ".byte 0xf3, 0x0f, 0xc7, 0x30"
483 #define MSR_IA32_TIME_STAMP_COUNTER 0x010
485 #define TSS_IOPB_BASE_OFFSET 0x66
486 #define TSS_BASE_SIZE 0x68
487 #define TSS_IOPB_SIZE (65536 / 8)
488 #define TSS_REDIRECTION_SIZE (256 / 8)
489 #define RMODE_TSS_SIZE (TSS_BASE_SIZE + TSS_REDIRECTION_SIZE + TSS_IOPB_SIZE + 1)
491 static inline int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu)
493 return vcpu->mp_state == VCPU_MP_STATE_RUNNABLE
494 || vcpu->mp_state == VCPU_MP_STATE_SIPI_RECEIVED;