xref: /openbmc/linux/arch/x86/kvm/vmx/nested.h (revision f125e2d4)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __KVM_X86_VMX_NESTED_H
3 #define __KVM_X86_VMX_NESTED_H
4 
5 #include "kvm_cache_regs.h"
6 #include "vmcs12.h"
7 #include "vmx.h"
8 
9 /*
10  * Status returned by nested_vmx_enter_non_root_mode():
11  */
12 enum nvmx_vmentry_status {
13 	NVMX_VMENTRY_SUCCESS,		/* Entered VMX non-root mode */
14 	NVMX_VMENTRY_VMFAIL,		/* Consistency check VMFail */
15 	NVMX_VMENTRY_VMEXIT,		/* Consistency check VMExit */
16 	NVMX_VMENTRY_KVM_INTERNAL_ERROR,/* KVM internal error */
17 };
18 
19 void vmx_leave_nested(struct kvm_vcpu *vcpu);
20 void nested_vmx_setup_ctls_msrs(struct nested_vmx_msrs *msrs, u32 ept_caps);
21 void nested_vmx_hardware_unsetup(void);
22 __init int nested_vmx_hardware_setup(int (*exit_handlers[])(struct kvm_vcpu *));
23 void nested_vmx_set_vmcs_shadowing_bitmap(void);
24 void nested_vmx_free_vcpu(struct kvm_vcpu *vcpu);
25 enum nvmx_vmentry_status nested_vmx_enter_non_root_mode(struct kvm_vcpu *vcpu,
26 						     bool from_vmentry);
27 bool nested_vmx_exit_reflected(struct kvm_vcpu *vcpu, u32 exit_reason);
28 void nested_vmx_vmexit(struct kvm_vcpu *vcpu, u32 exit_reason,
29 		       u32 exit_intr_info, unsigned long exit_qualification);
30 void nested_sync_vmcs12_to_shadow(struct kvm_vcpu *vcpu);
31 int vmx_set_vmx_msr(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
32 int vmx_get_vmx_msr(struct nested_vmx_msrs *msrs, u32 msr_index, u64 *pdata);
33 int get_vmx_mem_address(struct kvm_vcpu *vcpu, unsigned long exit_qualification,
34 			u32 vmx_instruction_info, bool wr, int len, gva_t *ret);
35 void nested_vmx_pmu_entry_exit_ctls_update(struct kvm_vcpu *vcpu);
36 bool nested_vmx_check_io_bitmaps(struct kvm_vcpu *vcpu, unsigned int port,
37 				 int size);
38 
39 static inline struct vmcs12 *get_vmcs12(struct kvm_vcpu *vcpu)
40 {
41 	return to_vmx(vcpu)->nested.cached_vmcs12;
42 }
43 
44 static inline struct vmcs12 *get_shadow_vmcs12(struct kvm_vcpu *vcpu)
45 {
46 	return to_vmx(vcpu)->nested.cached_shadow_vmcs12;
47 }
48 
49 static inline int vmx_has_valid_vmcs12(struct kvm_vcpu *vcpu)
50 {
51 	struct vcpu_vmx *vmx = to_vmx(vcpu);
52 
53 	/*
54 	 * In case we do two consecutive get/set_nested_state()s while L2 was
55 	 * running hv_evmcs may end up not being mapped (we map it from
56 	 * nested_vmx_run()/vmx_vcpu_run()). Check is_guest_mode() as we always
57 	 * have vmcs12 if it is true.
58 	 */
59 	return is_guest_mode(vcpu) || vmx->nested.current_vmptr != -1ull ||
60 		vmx->nested.hv_evmcs;
61 }
62 
63 static inline unsigned long nested_ept_get_cr3(struct kvm_vcpu *vcpu)
64 {
65 	/* return the page table to be shadowed - in our case, EPT12 */
66 	return get_vmcs12(vcpu)->ept_pointer;
67 }
68 
69 static inline bool nested_ept_ad_enabled(struct kvm_vcpu *vcpu)
70 {
71 	return nested_ept_get_cr3(vcpu) & VMX_EPTP_AD_ENABLE_BIT;
72 }
73 
74 /*
75  * Reflect a VM Exit into L1.
76  */
77 static inline int nested_vmx_reflect_vmexit(struct kvm_vcpu *vcpu,
78 					    u32 exit_reason)
79 {
80 	u32 exit_intr_info = vmcs_read32(VM_EXIT_INTR_INFO);
81 
82 	/*
83 	 * At this point, the exit interruption info in exit_intr_info
84 	 * is only valid for EXCEPTION_NMI exits.  For EXTERNAL_INTERRUPT
85 	 * we need to query the in-kernel LAPIC.
86 	 */
87 	WARN_ON(exit_reason == EXIT_REASON_EXTERNAL_INTERRUPT);
88 	if ((exit_intr_info &
89 	     (INTR_INFO_VALID_MASK | INTR_INFO_DELIVER_CODE_MASK)) ==
90 	    (INTR_INFO_VALID_MASK | INTR_INFO_DELIVER_CODE_MASK)) {
91 		struct vmcs12 *vmcs12 = get_vmcs12(vcpu);
92 
93 		vmcs12->vm_exit_intr_error_code =
94 			vmcs_read32(VM_EXIT_INTR_ERROR_CODE);
95 	}
96 
97 	nested_vmx_vmexit(vcpu, exit_reason, exit_intr_info,
98 			  vmcs_readl(EXIT_QUALIFICATION));
99 	return 1;
100 }
101 
102 /*
103  * Return the cr0 value that a nested guest would read. This is a combination
104  * of the real cr0 used to run the guest (guest_cr0), and the bits shadowed by
105  * its hypervisor (cr0_read_shadow).
106  */
107 static inline unsigned long nested_read_cr0(struct vmcs12 *fields)
108 {
109 	return (fields->guest_cr0 & ~fields->cr0_guest_host_mask) |
110 		(fields->cr0_read_shadow & fields->cr0_guest_host_mask);
111 }
112 static inline unsigned long nested_read_cr4(struct vmcs12 *fields)
113 {
114 	return (fields->guest_cr4 & ~fields->cr4_guest_host_mask) |
115 		(fields->cr4_read_shadow & fields->cr4_guest_host_mask);
116 }
117 
118 static inline unsigned nested_cpu_vmx_misc_cr3_count(struct kvm_vcpu *vcpu)
119 {
120 	return vmx_misc_cr3_count(to_vmx(vcpu)->nested.msrs.misc_low);
121 }
122 
123 /*
124  * Do the virtual VMX capability MSRs specify that L1 can use VMWRITE
125  * to modify any valid field of the VMCS, or are the VM-exit
126  * information fields read-only?
127  */
128 static inline bool nested_cpu_has_vmwrite_any_field(struct kvm_vcpu *vcpu)
129 {
130 	return to_vmx(vcpu)->nested.msrs.misc_low &
131 		MSR_IA32_VMX_MISC_VMWRITE_SHADOW_RO_FIELDS;
132 }
133 
134 static inline bool nested_cpu_has_zero_length_injection(struct kvm_vcpu *vcpu)
135 {
136 	return to_vmx(vcpu)->nested.msrs.misc_low & VMX_MISC_ZERO_LEN_INS;
137 }
138 
139 static inline bool nested_cpu_supports_monitor_trap_flag(struct kvm_vcpu *vcpu)
140 {
141 	return to_vmx(vcpu)->nested.msrs.procbased_ctls_high &
142 			CPU_BASED_MONITOR_TRAP_FLAG;
143 }
144 
145 static inline bool nested_cpu_has_vmx_shadow_vmcs(struct kvm_vcpu *vcpu)
146 {
147 	return to_vmx(vcpu)->nested.msrs.secondary_ctls_high &
148 		SECONDARY_EXEC_SHADOW_VMCS;
149 }
150 
151 static inline bool nested_cpu_has(struct vmcs12 *vmcs12, u32 bit)
152 {
153 	return vmcs12->cpu_based_vm_exec_control & bit;
154 }
155 
156 static inline bool nested_cpu_has2(struct vmcs12 *vmcs12, u32 bit)
157 {
158 	return (vmcs12->cpu_based_vm_exec_control &
159 			CPU_BASED_ACTIVATE_SECONDARY_CONTROLS) &&
160 		(vmcs12->secondary_vm_exec_control & bit);
161 }
162 
163 static inline bool nested_cpu_has_preemption_timer(struct vmcs12 *vmcs12)
164 {
165 	return vmcs12->pin_based_vm_exec_control &
166 		PIN_BASED_VMX_PREEMPTION_TIMER;
167 }
168 
169 static inline bool nested_cpu_has_nmi_exiting(struct vmcs12 *vmcs12)
170 {
171 	return vmcs12->pin_based_vm_exec_control & PIN_BASED_NMI_EXITING;
172 }
173 
174 static inline bool nested_cpu_has_virtual_nmis(struct vmcs12 *vmcs12)
175 {
176 	return vmcs12->pin_based_vm_exec_control & PIN_BASED_VIRTUAL_NMIS;
177 }
178 
179 static inline int nested_cpu_has_mtf(struct vmcs12 *vmcs12)
180 {
181 	return nested_cpu_has(vmcs12, CPU_BASED_MONITOR_TRAP_FLAG);
182 }
183 
184 static inline int nested_cpu_has_ept(struct vmcs12 *vmcs12)
185 {
186 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_ENABLE_EPT);
187 }
188 
189 static inline bool nested_cpu_has_xsaves(struct vmcs12 *vmcs12)
190 {
191 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_XSAVES);
192 }
193 
194 static inline bool nested_cpu_has_pml(struct vmcs12 *vmcs12)
195 {
196 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_ENABLE_PML);
197 }
198 
199 static inline bool nested_cpu_has_virt_x2apic_mode(struct vmcs12 *vmcs12)
200 {
201 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_VIRTUALIZE_X2APIC_MODE);
202 }
203 
204 static inline bool nested_cpu_has_vpid(struct vmcs12 *vmcs12)
205 {
206 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_ENABLE_VPID);
207 }
208 
209 static inline bool nested_cpu_has_apic_reg_virt(struct vmcs12 *vmcs12)
210 {
211 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_APIC_REGISTER_VIRT);
212 }
213 
214 static inline bool nested_cpu_has_vid(struct vmcs12 *vmcs12)
215 {
216 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_VIRTUAL_INTR_DELIVERY);
217 }
218 
219 static inline bool nested_cpu_has_posted_intr(struct vmcs12 *vmcs12)
220 {
221 	return vmcs12->pin_based_vm_exec_control & PIN_BASED_POSTED_INTR;
222 }
223 
224 static inline bool nested_cpu_has_vmfunc(struct vmcs12 *vmcs12)
225 {
226 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_ENABLE_VMFUNC);
227 }
228 
229 static inline bool nested_cpu_has_eptp_switching(struct vmcs12 *vmcs12)
230 {
231 	return nested_cpu_has_vmfunc(vmcs12) &&
232 		(vmcs12->vm_function_control &
233 		 VMX_VMFUNC_EPTP_SWITCHING);
234 }
235 
236 static inline bool nested_cpu_has_shadow_vmcs(struct vmcs12 *vmcs12)
237 {
238 	return nested_cpu_has2(vmcs12, SECONDARY_EXEC_SHADOW_VMCS);
239 }
240 
241 static inline bool nested_cpu_has_save_preemption_timer(struct vmcs12 *vmcs12)
242 {
243 	return vmcs12->vm_exit_controls &
244 	    VM_EXIT_SAVE_VMX_PREEMPTION_TIMER;
245 }
246 
247 /*
248  * In nested virtualization, check if L1 asked to exit on external interrupts.
249  * For most existing hypervisors, this will always return true.
250  */
251 static inline bool nested_exit_on_intr(struct kvm_vcpu *vcpu)
252 {
253 	return get_vmcs12(vcpu)->pin_based_vm_exec_control &
254 		PIN_BASED_EXT_INTR_MASK;
255 }
256 
257 /*
258  * if fixed0[i] == 1: val[i] must be 1
259  * if fixed1[i] == 0: val[i] must be 0
260  */
261 static inline bool fixed_bits_valid(u64 val, u64 fixed0, u64 fixed1)
262 {
263 	return ((val & fixed1) | fixed0) == val;
264 }
265 
266 static inline bool nested_guest_cr0_valid(struct kvm_vcpu *vcpu, unsigned long val)
267 {
268 	u64 fixed0 = to_vmx(vcpu)->nested.msrs.cr0_fixed0;
269 	u64 fixed1 = to_vmx(vcpu)->nested.msrs.cr0_fixed1;
270 	struct vmcs12 *vmcs12 = get_vmcs12(vcpu);
271 
272 	if (to_vmx(vcpu)->nested.msrs.secondary_ctls_high &
273 		SECONDARY_EXEC_UNRESTRICTED_GUEST &&
274 	    nested_cpu_has2(vmcs12, SECONDARY_EXEC_UNRESTRICTED_GUEST))
275 		fixed0 &= ~(X86_CR0_PE | X86_CR0_PG);
276 
277 	return fixed_bits_valid(val, fixed0, fixed1);
278 }
279 
280 static inline bool nested_host_cr0_valid(struct kvm_vcpu *vcpu, unsigned long val)
281 {
282 	u64 fixed0 = to_vmx(vcpu)->nested.msrs.cr0_fixed0;
283 	u64 fixed1 = to_vmx(vcpu)->nested.msrs.cr0_fixed1;
284 
285 	return fixed_bits_valid(val, fixed0, fixed1);
286 }
287 
288 static inline bool nested_cr4_valid(struct kvm_vcpu *vcpu, unsigned long val)
289 {
290 	u64 fixed0 = to_vmx(vcpu)->nested.msrs.cr4_fixed0;
291 	u64 fixed1 = to_vmx(vcpu)->nested.msrs.cr4_fixed1;
292 
293 	return fixed_bits_valid(val, fixed0, fixed1);
294 }
295 
296 /* No difference in the restrictions on guest and host CR4 in VMX operation. */
297 #define nested_guest_cr4_valid	nested_cr4_valid
298 #define nested_host_cr4_valid	nested_cr4_valid
299 
300 #endif /* __KVM_X86_VMX_NESTED_H */
301