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