1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __KVM_X86_VMX_H
3 #define __KVM_X86_VMX_H
5 #include <linux/kvm_host.h>
8 #include <asm/intel_pt.h>
10 #include "capabilities.h"
14 extern const u32 vmx_msr_index[];
21 #define X2APIC_MSR(r) (APIC_BASE_MSR + ((r) >> 4))
23 #define NR_AUTOLOAD_MSRS 8
27 struct vmx_msr_entry val[NR_AUTOLOAD_MSRS];
30 struct shared_msr_entry {
36 enum segment_cache_field {
45 /* Posted-Interrupt Descriptor */
47 u32 pir[8]; /* Posted interrupt requested */
50 /* bit 256 - Outstanding Notification */
52 /* bit 257 - Suppress Notification */
54 /* bit 271:258 - Reserved */
56 /* bit 279:272 - Notification Vector */
58 /* bit 287:280 - Reserved */
60 /* bit 319:288 - Notification Destination */
68 #define RTIT_ADDR_RANGE 4
76 u64 addr_a[RTIT_ADDR_RANGE];
77 u64 addr_b[RTIT_ADDR_RANGE];
83 u32 caps[PT_CPUID_REGS_NUM * PT_CPUID_LEAVES];
89 * The nested_vmx structure is part of vcpu_vmx, and holds information we need
90 * for correct emulation of VMX (i.e., nested VMX) on this vcpu.
93 /* Has the level1 guest done vmxon? */
98 /* The guest-physical address of the current VMCS L1 keeps for L2 */
101 * Cache of the guest's VMCS, existing outside of guest memory.
102 * Loaded from guest memory during VMPTRLD. Flushed to guest
103 * memory during VMCLEAR and VMPTRLD.
105 struct vmcs12 *cached_vmcs12;
107 * Cache of the guest's shadow VMCS, existing outside of guest
108 * memory. Loaded from guest memory during VM entry. Flushed
109 * to guest memory during VM exit.
111 struct vmcs12 *cached_shadow_vmcs12;
113 * Indicates if the shadow vmcs or enlightened vmcs must be updated
114 * with the data held by struct vmcs12.
116 bool need_vmcs12_sync;
120 * vmcs02 has been initialized, i.e. state that is constant for
121 * vmcs02 has been written to the backing VMCS. Initialization
122 * is delayed until L1 actually attempts to run a nested VM.
124 bool vmcs02_initialized;
126 bool change_vmcs01_virtual_apic_mode;
129 * Enlightened VMCS has been enabled. It does not mean that L1 has to
130 * use it. However, VMX features available to L1 will be limited based
131 * on what the enlightened VMCS supports.
133 bool enlightened_vmcs_enabled;
135 /* L2 must run next, and mustn't decide to exit to L1. */
136 bool nested_run_pending;
138 struct loaded_vmcs vmcs02;
141 * Guest pages referred to in the vmcs02 with host-physical
142 * pointers, so we must keep them pinned while L2 runs.
144 struct page *apic_access_page;
145 struct kvm_host_map virtual_apic_map;
146 struct kvm_host_map pi_desc_map;
148 struct kvm_host_map msr_bitmap_map;
150 struct pi_desc *pi_desc;
154 struct hrtimer preemption_timer;
155 bool preemption_timer_expired;
157 /* to migrate it to L2 if VM_ENTRY_LOAD_DEBUG_CONTROLS is off */
159 u64 vmcs01_guest_bndcfgs;
164 struct nested_vmx_msrs msrs;
166 /* SMM related state */
168 /* in VMX operation on SMM entry? */
170 /* in guest mode on SMM entry? */
174 gpa_t hv_evmcs_vmptr;
175 struct kvm_host_map hv_evmcs_map;
176 struct hv_enlightened_vmcs *hv_evmcs;
180 struct kvm_vcpu vcpu;
184 u32 idt_vectoring_info;
186 struct shared_msr_entry *guest_msrs;
189 bool guest_msrs_dirty;
190 unsigned long host_idt_base;
192 u64 msr_host_kernel_gs_base;
193 u64 msr_guest_kernel_gs_base;
198 u32 vm_entry_controls_shadow;
199 u32 vm_exit_controls_shadow;
200 u32 secondary_exec_control;
203 * loaded_vmcs points to the VMCS currently used in this vcpu. For a
204 * non-nested (L1) guest, it always points to vmcs01. For a nested
205 * guest (L2), it points to a different VMCS. loaded_cpu_state points
206 * to the VMCS whose state is loaded into the CPU registers that only
207 * need to be switched when transitioning to/from the kernel; a NULL
208 * value indicates that host state is loaded.
210 struct loaded_vmcs vmcs01;
211 struct loaded_vmcs *loaded_vmcs;
212 struct loaded_vmcs *loaded_cpu_state;
214 struct msr_autoload {
215 struct vmx_msrs guest;
216 struct vmx_msrs host;
222 struct kvm_segment segs[8];
225 u32 bitmask; /* 4 bits per segment (1 bit per field) */
226 struct kvm_save_segment {
234 bool emulation_required;
238 /* Posted interrupt descriptor */
239 struct pi_desc pi_desc;
241 /* Support for a guest hypervisor (nested VMX) */
242 struct nested_vmx nested;
244 /* Dynamic PLE window. */
246 bool ple_window_dirty;
248 bool req_immediate_exit;
250 /* Support for PML */
251 #define PML_ENTITY_NUM 512
254 /* apic deadline value in host tsc */
257 u64 current_tsc_ratio;
261 unsigned long host_debugctlmsr;
263 u64 msr_ia32_power_ctl;
266 * Only bits masked by msr_ia32_feature_control_valid_bits can be set in
267 * msr_ia32_feature_control. FEATURE_CONTROL_LOCKED is always included
268 * in msr_ia32_feature_control_valid_bits.
270 u64 msr_ia32_feature_control;
271 u64 msr_ia32_feature_control_valid_bits;
274 struct pt_desc pt_desc;
277 enum ept_pointers_status {
278 EPT_POINTERS_CHECK = 0,
279 EPT_POINTERS_MATCH = 1,
280 EPT_POINTERS_MISMATCH = 2
286 unsigned int tss_addr;
287 bool ept_identity_pagetable_done;
288 gpa_t ept_identity_map_addr;
290 enum ept_pointers_status ept_pointers_match;
291 spinlock_t ept_pointer_lock;
294 bool nested_vmx_allowed(struct kvm_vcpu *vcpu);
295 void vmx_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
296 void vmx_vcpu_put(struct kvm_vcpu *vcpu);
297 int allocate_vpid(void);
298 void free_vpid(int vpid);
299 void vmx_set_constant_host_state(struct vcpu_vmx *vmx);
300 void vmx_prepare_switch_to_guest(struct kvm_vcpu *vcpu);
301 int vmx_get_cpl(struct kvm_vcpu *vcpu);
302 unsigned long vmx_get_rflags(struct kvm_vcpu *vcpu);
303 void vmx_set_rflags(struct kvm_vcpu *vcpu, unsigned long rflags);
304 u32 vmx_get_interrupt_shadow(struct kvm_vcpu *vcpu);
305 void vmx_set_interrupt_shadow(struct kvm_vcpu *vcpu, int mask);
306 void vmx_set_efer(struct kvm_vcpu *vcpu, u64 efer);
307 void vmx_set_cr0(struct kvm_vcpu *vcpu, unsigned long cr0);
308 void vmx_set_cr3(struct kvm_vcpu *vcpu, unsigned long cr3);
309 int vmx_set_cr4(struct kvm_vcpu *vcpu, unsigned long cr4);
310 void set_cr4_guest_host_mask(struct vcpu_vmx *vmx);
311 void ept_save_pdptrs(struct kvm_vcpu *vcpu);
312 void vmx_get_segment(struct kvm_vcpu *vcpu, struct kvm_segment *var, int seg);
313 void vmx_set_segment(struct kvm_vcpu *vcpu, struct kvm_segment *var, int seg);
314 u64 construct_eptp(struct kvm_vcpu *vcpu, unsigned long root_hpa);
315 void update_exception_bitmap(struct kvm_vcpu *vcpu);
316 void vmx_update_msr_bitmap(struct kvm_vcpu *vcpu);
317 bool vmx_get_nmi_mask(struct kvm_vcpu *vcpu);
318 void vmx_set_nmi_mask(struct kvm_vcpu *vcpu, bool masked);
319 void vmx_set_virtual_apic_mode(struct kvm_vcpu *vcpu);
320 struct shared_msr_entry *find_msr_entry(struct vcpu_vmx *vmx, u32 msr);
321 void pt_update_intercept_for_msr(struct vcpu_vmx *vmx);
322 void vmx_update_host_rsp(struct vcpu_vmx *vmx, unsigned long host_rsp);
324 #define POSTED_INTR_ON 0
325 #define POSTED_INTR_SN 1
327 static inline bool pi_test_and_set_on(struct pi_desc *pi_desc)
329 return test_and_set_bit(POSTED_INTR_ON,
330 (unsigned long *)&pi_desc->control);
333 static inline bool pi_test_and_clear_on(struct pi_desc *pi_desc)
335 return test_and_clear_bit(POSTED_INTR_ON,
336 (unsigned long *)&pi_desc->control);
339 static inline int pi_test_and_set_pir(int vector, struct pi_desc *pi_desc)
341 return test_and_set_bit(vector, (unsigned long *)pi_desc->pir);
344 static inline void pi_set_sn(struct pi_desc *pi_desc)
346 set_bit(POSTED_INTR_SN,
347 (unsigned long *)&pi_desc->control);
350 static inline void pi_set_on(struct pi_desc *pi_desc)
352 set_bit(POSTED_INTR_ON,
353 (unsigned long *)&pi_desc->control);
356 static inline void pi_clear_on(struct pi_desc *pi_desc)
358 clear_bit(POSTED_INTR_ON,
359 (unsigned long *)&pi_desc->control);
362 static inline int pi_test_on(struct pi_desc *pi_desc)
364 return test_bit(POSTED_INTR_ON,
365 (unsigned long *)&pi_desc->control);
368 static inline int pi_test_sn(struct pi_desc *pi_desc)
370 return test_bit(POSTED_INTR_SN,
371 (unsigned long *)&pi_desc->control);
374 static inline u8 vmx_get_rvi(void)
376 return vmcs_read16(GUEST_INTR_STATUS) & 0xff;
379 static inline void vm_entry_controls_reset_shadow(struct vcpu_vmx *vmx)
381 vmx->vm_entry_controls_shadow = vmcs_read32(VM_ENTRY_CONTROLS);
384 static inline void vm_entry_controls_init(struct vcpu_vmx *vmx, u32 val)
386 vmcs_write32(VM_ENTRY_CONTROLS, val);
387 vmx->vm_entry_controls_shadow = val;
390 static inline void vm_entry_controls_set(struct vcpu_vmx *vmx, u32 val)
392 if (vmx->vm_entry_controls_shadow != val)
393 vm_entry_controls_init(vmx, val);
396 static inline u32 vm_entry_controls_get(struct vcpu_vmx *vmx)
398 return vmx->vm_entry_controls_shadow;
401 static inline void vm_entry_controls_setbit(struct vcpu_vmx *vmx, u32 val)
403 vm_entry_controls_set(vmx, vm_entry_controls_get(vmx) | val);
406 static inline void vm_entry_controls_clearbit(struct vcpu_vmx *vmx, u32 val)
408 vm_entry_controls_set(vmx, vm_entry_controls_get(vmx) & ~val);
411 static inline void vm_exit_controls_reset_shadow(struct vcpu_vmx *vmx)
413 vmx->vm_exit_controls_shadow = vmcs_read32(VM_EXIT_CONTROLS);
416 static inline void vm_exit_controls_init(struct vcpu_vmx *vmx, u32 val)
418 vmcs_write32(VM_EXIT_CONTROLS, val);
419 vmx->vm_exit_controls_shadow = val;
422 static inline void vm_exit_controls_set(struct vcpu_vmx *vmx, u32 val)
424 if (vmx->vm_exit_controls_shadow != val)
425 vm_exit_controls_init(vmx, val);
428 static inline u32 vm_exit_controls_get(struct vcpu_vmx *vmx)
430 return vmx->vm_exit_controls_shadow;
433 static inline void vm_exit_controls_setbit(struct vcpu_vmx *vmx, u32 val)
435 vm_exit_controls_set(vmx, vm_exit_controls_get(vmx) | val);
438 static inline void vm_exit_controls_clearbit(struct vcpu_vmx *vmx, u32 val)
440 vm_exit_controls_set(vmx, vm_exit_controls_get(vmx) & ~val);
443 static inline void vmx_segment_cache_clear(struct vcpu_vmx *vmx)
445 vmx->segment_cache.bitmask = 0;
448 static inline u32 vmx_vmentry_ctrl(void)
450 u32 vmentry_ctrl = vmcs_config.vmentry_ctrl;
451 if (pt_mode == PT_MODE_SYSTEM)
452 vmentry_ctrl &= ~(VM_ENTRY_PT_CONCEAL_PIP |
453 VM_ENTRY_LOAD_IA32_RTIT_CTL);
454 /* Loading of EFER and PERF_GLOBAL_CTRL are toggled dynamically */
455 return vmentry_ctrl &
456 ~(VM_ENTRY_LOAD_IA32_PERF_GLOBAL_CTRL | VM_ENTRY_LOAD_IA32_EFER);
459 static inline u32 vmx_vmexit_ctrl(void)
461 u32 vmexit_ctrl = vmcs_config.vmexit_ctrl;
462 if (pt_mode == PT_MODE_SYSTEM)
463 vmexit_ctrl &= ~(VM_EXIT_PT_CONCEAL_PIP |
464 VM_EXIT_CLEAR_IA32_RTIT_CTL);
465 /* Loading of EFER and PERF_GLOBAL_CTRL are toggled dynamically */
467 ~(VM_EXIT_LOAD_IA32_PERF_GLOBAL_CTRL | VM_EXIT_LOAD_IA32_EFER);
470 u32 vmx_exec_control(struct vcpu_vmx *vmx);
472 static inline struct kvm_vmx *to_kvm_vmx(struct kvm *kvm)
474 return container_of(kvm, struct kvm_vmx, kvm);
477 static inline struct vcpu_vmx *to_vmx(struct kvm_vcpu *vcpu)
479 return container_of(vcpu, struct vcpu_vmx, vcpu);
482 static inline struct pi_desc *vcpu_to_pi_desc(struct kvm_vcpu *vcpu)
484 return &(to_vmx(vcpu)->pi_desc);
487 struct vmcs *alloc_vmcs_cpu(bool shadow, int cpu, gfp_t flags);
488 void free_vmcs(struct vmcs *vmcs);
489 int alloc_loaded_vmcs(struct loaded_vmcs *loaded_vmcs);
490 void free_loaded_vmcs(struct loaded_vmcs *loaded_vmcs);
491 void loaded_vmcs_init(struct loaded_vmcs *loaded_vmcs);
492 void loaded_vmcs_clear(struct loaded_vmcs *loaded_vmcs);
494 static inline struct vmcs *alloc_vmcs(bool shadow)
496 return alloc_vmcs_cpu(shadow, raw_smp_processor_id(),
500 u64 construct_eptp(struct kvm_vcpu *vcpu, unsigned long root_hpa);
502 static inline void __vmx_flush_tlb(struct kvm_vcpu *vcpu, int vpid,
505 if (enable_ept && (invalidate_gpa || !enable_vpid)) {
506 if (!VALID_PAGE(vcpu->arch.mmu->root_hpa))
508 ept_sync_context(construct_eptp(vcpu,
509 vcpu->arch.mmu->root_hpa));
511 vpid_sync_context(vpid);
515 static inline void vmx_flush_tlb(struct kvm_vcpu *vcpu, bool invalidate_gpa)
517 __vmx_flush_tlb(vcpu, to_vmx(vcpu)->vpid, invalidate_gpa);
520 static inline void decache_tsc_multiplier(struct vcpu_vmx *vmx)
522 vmx->current_tsc_ratio = vmx->vcpu.arch.tsc_scaling_ratio;
523 vmcs_write64(TSC_MULTIPLIER, vmx->current_tsc_ratio);
526 void dump_vmcs(void);
528 #endif /* __KVM_X86_VMX_H */