xref: /linux/arch/x86/include/asm/kvm_host.h (revision f694f30e81c4ade358eb8c75273bac1a48f0cb8f)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Kernel-based Virtual Machine driver for Linux
4  *
5  * This header defines architecture specific interfaces, x86 version
6  */
7 
8 #ifndef _ASM_X86_KVM_HOST_H
9 #define _ASM_X86_KVM_HOST_H
10 
11 #include <linux/types.h>
12 #include <linux/mm.h>
13 #include <linux/mmu_notifier.h>
14 #include <linux/tracepoint.h>
15 #include <linux/cpumask.h>
16 #include <linux/irq_work.h>
17 #include <linux/irq.h>
18 #include <linux/workqueue.h>
19 
20 #include <linux/kvm.h>
21 #include <linux/kvm_para.h>
22 #include <linux/kvm_types.h>
23 #include <linux/perf_event.h>
24 #include <linux/pvclock_gtod.h>
25 #include <linux/clocksource.h>
26 #include <linux/irqbypass.h>
27 #include <linux/kfifo.h>
28 #include <linux/sched/vhost_task.h>
29 #include <linux/call_once.h>
30 #include <linux/atomic.h>
31 
32 #include <asm/apic.h>
33 #include <asm/pvclock-abi.h>
34 #include <asm/desc.h>
35 #include <asm/mtrr.h>
36 #include <asm/msr-index.h>
37 #include <asm/asm.h>
38 #include <asm/irq_remapping.h>
39 #include <asm/kvm_page_track.h>
40 #include <asm/kvm_vcpu_regs.h>
41 #include <asm/reboot.h>
42 #include <hyperv/hvhdk.h>
43 
44 #define __KVM_HAVE_ARCH_VCPU_DEBUGFS
45 
46 /*
47  * CONFIG_KVM_MAX_NR_VCPUS is defined iff CONFIG_KVM!=n, provide a dummy max if
48  * KVM is disabled (arbitrarily use the default from CONFIG_KVM_MAX_NR_VCPUS).
49  */
50 #ifdef CONFIG_KVM_MAX_NR_VCPUS
51 #define KVM_MAX_VCPUS CONFIG_KVM_MAX_NR_VCPUS
52 #else
53 #define KVM_MAX_VCPUS 1024
54 #endif
55 
56 /*
57  * In x86, the VCPU ID corresponds to the APIC ID, and APIC IDs
58  * might be larger than the actual number of VCPUs because the
59  * APIC ID encodes CPU topology information.
60  *
61  * In the worst case, we'll need less than one extra bit for the
62  * Core ID, and less than one extra bit for the Package (Die) ID,
63  * so ratio of 4 should be enough.
64  */
65 #define KVM_VCPU_ID_RATIO 4
66 #define KVM_MAX_VCPU_IDS (KVM_MAX_VCPUS * KVM_VCPU_ID_RATIO)
67 
68 /* memory slots that are not exposed to userspace */
69 #define KVM_INTERNAL_MEM_SLOTS 3
70 
71 #define KVM_HALT_POLL_NS_DEFAULT 200000
72 
73 #define KVM_IRQCHIP_NUM_PINS  KVM_IOAPIC_NUM_PINS
74 
75 #define KVM_DIRTY_LOG_MANUAL_CAPS   (KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE | \
76 					KVM_DIRTY_LOG_INITIALLY_SET)
77 
78 #define KVM_BUS_LOCK_DETECTION_VALID_MODE	(KVM_BUS_LOCK_DETECTION_OFF | \
79 						 KVM_BUS_LOCK_DETECTION_EXIT)
80 
81 #define KVM_X86_NOTIFY_VMEXIT_VALID_BITS	(KVM_X86_NOTIFY_VMEXIT_ENABLED | \
82 						 KVM_X86_NOTIFY_VMEXIT_USER)
83 
84 /* x86-specific vcpu->requests bit members */
85 #define KVM_REQ_MIGRATE_TIMER		KVM_ARCH_REQ(0)
86 #define KVM_REQ_REPORT_TPR_ACCESS	KVM_ARCH_REQ(1)
87 #define KVM_REQ_TRIPLE_FAULT		KVM_ARCH_REQ(2)
88 #define KVM_REQ_MMU_SYNC		KVM_ARCH_REQ(3)
89 #define KVM_REQ_CLOCK_UPDATE		KVM_ARCH_REQ(4)
90 #define KVM_REQ_LOAD_MMU_PGD		KVM_ARCH_REQ(5)
91 #define KVM_REQ_EVENT			KVM_ARCH_REQ(6)
92 #define KVM_REQ_APF_HALT		KVM_ARCH_REQ(7)
93 #define KVM_REQ_STEAL_UPDATE		KVM_ARCH_REQ(8)
94 #define KVM_REQ_NMI			KVM_ARCH_REQ(9)
95 #define KVM_REQ_PMU			KVM_ARCH_REQ(10)
96 #define KVM_REQ_PMI			KVM_ARCH_REQ(11)
97 #ifdef CONFIG_KVM_SMM
98 #define KVM_REQ_SMI			KVM_ARCH_REQ(12)
99 #endif
100 #define KVM_REQ_MASTERCLOCK_UPDATE	KVM_ARCH_REQ(13)
101 #define KVM_REQ_MCLOCK_INPROGRESS \
102 	KVM_ARCH_REQ_FLAGS(14, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
103 #define KVM_REQ_SCAN_IOAPIC \
104 	KVM_ARCH_REQ_FLAGS(15, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
105 #define KVM_REQ_GLOBAL_CLOCK_UPDATE	KVM_ARCH_REQ(16)
106 #define KVM_REQ_APIC_PAGE_RELOAD \
107 	KVM_ARCH_REQ_FLAGS(17, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
108 #define KVM_REQ_HV_CRASH		KVM_ARCH_REQ(18)
109 #define KVM_REQ_IOAPIC_EOI_EXIT		KVM_ARCH_REQ(19)
110 #define KVM_REQ_HV_RESET		KVM_ARCH_REQ(20)
111 #define KVM_REQ_HV_EXIT			KVM_ARCH_REQ(21)
112 #define KVM_REQ_HV_STIMER		KVM_ARCH_REQ(22)
113 #define KVM_REQ_LOAD_EOI_EXITMAP	KVM_ARCH_REQ(23)
114 #define KVM_REQ_GET_NESTED_STATE_PAGES	KVM_ARCH_REQ(24)
115 #define KVM_REQ_APICV_UPDATE \
116 	KVM_ARCH_REQ_FLAGS(25, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
117 #define KVM_REQ_TLB_FLUSH_CURRENT	KVM_ARCH_REQ(26)
118 #define KVM_REQ_TLB_FLUSH_GUEST \
119 	KVM_ARCH_REQ_FLAGS(27, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
120 #define KVM_REQ_APF_READY		KVM_ARCH_REQ(28)
121 #define KVM_REQ_MSR_FILTER_CHANGED	KVM_ARCH_REQ(29)
122 #define KVM_REQ_UPDATE_CPU_DIRTY_LOGGING \
123 	KVM_ARCH_REQ_FLAGS(30, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
124 #define KVM_REQ_MMU_FREE_OBSOLETE_ROOTS \
125 	KVM_ARCH_REQ_FLAGS(31, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
126 #define KVM_REQ_HV_TLB_FLUSH \
127 	KVM_ARCH_REQ_FLAGS(32, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
128 #define KVM_REQ_UPDATE_PROTECTED_GUEST_STATE	KVM_ARCH_REQ(34)
129 
130 #define CR0_RESERVED_BITS                                               \
131 	(~(unsigned long)(X86_CR0_PE | X86_CR0_MP | X86_CR0_EM | X86_CR0_TS \
132 			  | X86_CR0_ET | X86_CR0_NE | X86_CR0_WP | X86_CR0_AM \
133 			  | X86_CR0_NW | X86_CR0_CD | X86_CR0_PG))
134 
135 #define CR4_RESERVED_BITS                                               \
136 	(~(unsigned long)(X86_CR4_VME | X86_CR4_PVI | X86_CR4_TSD | X86_CR4_DE\
137 			  | X86_CR4_PSE | X86_CR4_PAE | X86_CR4_MCE     \
138 			  | X86_CR4_PGE | X86_CR4_PCE | X86_CR4_OSFXSR | X86_CR4_PCIDE \
139 			  | X86_CR4_OSXSAVE | X86_CR4_SMEP | X86_CR4_FSGSBASE \
140 			  | X86_CR4_OSXMMEXCPT | X86_CR4_LA57 | X86_CR4_VMXE \
141 			  | X86_CR4_SMAP | X86_CR4_PKE | X86_CR4_UMIP \
142 			  | X86_CR4_LAM_SUP))
143 
144 #define CR8_RESERVED_BITS (~(unsigned long)X86_CR8_TPR)
145 
146 
147 
148 #define INVALID_PAGE (~(hpa_t)0)
149 #define VALID_PAGE(x) ((x) != INVALID_PAGE)
150 
151 /* KVM Hugepage definitions for x86 */
152 #define KVM_MAX_HUGEPAGE_LEVEL	PG_LEVEL_1G
153 #define KVM_NR_PAGE_SIZES	(KVM_MAX_HUGEPAGE_LEVEL - PG_LEVEL_4K + 1)
154 #define KVM_HPAGE_GFN_SHIFT(x)	(((x) - 1) * 9)
155 #define KVM_HPAGE_SHIFT(x)	(PAGE_SHIFT + KVM_HPAGE_GFN_SHIFT(x))
156 #define KVM_HPAGE_SIZE(x)	(1UL << KVM_HPAGE_SHIFT(x))
157 #define KVM_HPAGE_MASK(x)	(~(KVM_HPAGE_SIZE(x) - 1))
158 #define KVM_PAGES_PER_HPAGE(x)	(KVM_HPAGE_SIZE(x) / PAGE_SIZE)
159 
160 #define KVM_MEMSLOT_PAGES_TO_MMU_PAGES_RATIO 50
161 #define KVM_MIN_ALLOC_MMU_PAGES 64UL
162 #define KVM_MMU_HASH_SHIFT 12
163 #define KVM_NUM_MMU_PAGES (1 << KVM_MMU_HASH_SHIFT)
164 #define KVM_MIN_FREE_MMU_PAGES 5
165 #define KVM_REFILL_PAGES 25
166 #define KVM_MAX_CPUID_ENTRIES 256
167 #define KVM_NR_VAR_MTRR 8
168 
169 #define ASYNC_PF_PER_VCPU 64
170 
171 enum kvm_reg {
172 	VCPU_REGS_RAX = __VCPU_REGS_RAX,
173 	VCPU_REGS_RCX = __VCPU_REGS_RCX,
174 	VCPU_REGS_RDX = __VCPU_REGS_RDX,
175 	VCPU_REGS_RBX = __VCPU_REGS_RBX,
176 	VCPU_REGS_RSP = __VCPU_REGS_RSP,
177 	VCPU_REGS_RBP = __VCPU_REGS_RBP,
178 	VCPU_REGS_RSI = __VCPU_REGS_RSI,
179 	VCPU_REGS_RDI = __VCPU_REGS_RDI,
180 #ifdef CONFIG_X86_64
181 	VCPU_REGS_R8  = __VCPU_REGS_R8,
182 	VCPU_REGS_R9  = __VCPU_REGS_R9,
183 	VCPU_REGS_R10 = __VCPU_REGS_R10,
184 	VCPU_REGS_R11 = __VCPU_REGS_R11,
185 	VCPU_REGS_R12 = __VCPU_REGS_R12,
186 	VCPU_REGS_R13 = __VCPU_REGS_R13,
187 	VCPU_REGS_R14 = __VCPU_REGS_R14,
188 	VCPU_REGS_R15 = __VCPU_REGS_R15,
189 #endif
190 	VCPU_REGS_RIP,
191 	NR_VCPU_REGS,
192 
193 	VCPU_EXREG_PDPTR = NR_VCPU_REGS,
194 	VCPU_EXREG_CR0,
195 	VCPU_EXREG_CR3,
196 	VCPU_EXREG_CR4,
197 	VCPU_EXREG_RFLAGS,
198 	VCPU_EXREG_SEGMENTS,
199 	VCPU_EXREG_EXIT_INFO_1,
200 	VCPU_EXREG_EXIT_INFO_2,
201 };
202 
203 enum {
204 	VCPU_SREG_ES,
205 	VCPU_SREG_CS,
206 	VCPU_SREG_SS,
207 	VCPU_SREG_DS,
208 	VCPU_SREG_FS,
209 	VCPU_SREG_GS,
210 	VCPU_SREG_TR,
211 	VCPU_SREG_LDTR,
212 };
213 
214 enum exit_fastpath_completion {
215 	EXIT_FASTPATH_NONE,
216 	EXIT_FASTPATH_REENTER_GUEST,
217 	EXIT_FASTPATH_EXIT_HANDLED,
218 	EXIT_FASTPATH_EXIT_USERSPACE,
219 };
220 typedef enum exit_fastpath_completion fastpath_t;
221 
222 struct x86_emulate_ctxt;
223 struct x86_exception;
224 union kvm_smram;
225 enum x86_intercept;
226 enum x86_intercept_stage;
227 
228 #define KVM_NR_DB_REGS	4
229 
230 #define DR6_BUS_LOCK   (1 << 11)
231 #define DR6_BD		(1 << 13)
232 #define DR6_BS		(1 << 14)
233 #define DR6_BT		(1 << 15)
234 #define DR6_RTM		(1 << 16)
235 /*
236  * DR6_ACTIVE_LOW combines fixed-1 and active-low bits.
237  * We can regard all the bits in DR6_FIXED_1 as active_low bits;
238  * they will never be 0 for now, but when they are defined
239  * in the future it will require no code change.
240  *
241  * DR6_ACTIVE_LOW is also used as the init/reset value for DR6.
242  */
243 #define DR6_ACTIVE_LOW	0xffff0ff0
244 #define DR6_VOLATILE	0x0001e80f
245 #define DR6_FIXED_1	(DR6_ACTIVE_LOW & ~DR6_VOLATILE)
246 
247 #define DR7_BP_EN_MASK	0x000000ff
248 #define DR7_GE		(1 << 9)
249 #define DR7_GD		(1 << 13)
250 #define DR7_FIXED_1	0x00000400
251 #define DR7_VOLATILE	0xffff2bff
252 
253 #define KVM_GUESTDBG_VALID_MASK \
254 	(KVM_GUESTDBG_ENABLE | \
255 	KVM_GUESTDBG_SINGLESTEP | \
256 	KVM_GUESTDBG_USE_HW_BP | \
257 	KVM_GUESTDBG_USE_SW_BP | \
258 	KVM_GUESTDBG_INJECT_BP | \
259 	KVM_GUESTDBG_INJECT_DB | \
260 	KVM_GUESTDBG_BLOCKIRQ)
261 
262 #define PFERR_PRESENT_MASK	BIT(0)
263 #define PFERR_WRITE_MASK	BIT(1)
264 #define PFERR_USER_MASK		BIT(2)
265 #define PFERR_RSVD_MASK		BIT(3)
266 #define PFERR_FETCH_MASK	BIT(4)
267 #define PFERR_PK_MASK		BIT(5)
268 #define PFERR_SGX_MASK		BIT(15)
269 #define PFERR_GUEST_RMP_MASK	BIT_ULL(31)
270 #define PFERR_GUEST_FINAL_MASK	BIT_ULL(32)
271 #define PFERR_GUEST_PAGE_MASK	BIT_ULL(33)
272 #define PFERR_GUEST_ENC_MASK	BIT_ULL(34)
273 #define PFERR_GUEST_SIZEM_MASK	BIT_ULL(35)
274 #define PFERR_GUEST_VMPL_MASK	BIT_ULL(36)
275 
276 /*
277  * IMPLICIT_ACCESS is a KVM-defined flag used to correctly perform SMAP checks
278  * when emulating instructions that triggers implicit access.
279  */
280 #define PFERR_IMPLICIT_ACCESS	BIT_ULL(48)
281 /*
282  * PRIVATE_ACCESS is a KVM-defined flag us to indicate that a fault occurred
283  * when the guest was accessing private memory.
284  */
285 #define PFERR_PRIVATE_ACCESS   BIT_ULL(49)
286 #define PFERR_SYNTHETIC_MASK   (PFERR_IMPLICIT_ACCESS | PFERR_PRIVATE_ACCESS)
287 
288 /* apic attention bits */
289 #define KVM_APIC_CHECK_VAPIC	0
290 /*
291  * The following bit is set with PV-EOI, unset on EOI.
292  * We detect PV-EOI changes by guest by comparing
293  * this bit with PV-EOI in guest memory.
294  * See the implementation in apic_update_pv_eoi.
295  */
296 #define KVM_APIC_PV_EOI_PENDING	1
297 
298 struct kvm_kernel_irq_routing_entry;
299 
300 /*
301  * kvm_mmu_page_role tracks the properties of a shadow page (where shadow page
302  * also includes TDP pages) to determine whether or not a page can be used in
303  * the given MMU context.  This is a subset of the overall kvm_cpu_role to
304  * minimize the size of kvm_memory_slot.arch.gfn_write_track, i.e. allows
305  * allocating 2 bytes per gfn instead of 4 bytes per gfn.
306  *
307  * Upper-level shadow pages having gptes are tracked for write-protection via
308  * gfn_write_track.  As above, gfn_write_track is a 16 bit counter, so KVM must
309  * not create more than 2^16-1 upper-level shadow pages at a single gfn,
310  * otherwise gfn_write_track will overflow and explosions will ensue.
311  *
312  * A unique shadow page (SP) for a gfn is created if and only if an existing SP
313  * cannot be reused.  The ability to reuse a SP is tracked by its role, which
314  * incorporates various mode bits and properties of the SP.  Roughly speaking,
315  * the number of unique SPs that can theoretically be created is 2^n, where n
316  * is the number of bits that are used to compute the role.
317  *
318  * But, even though there are 20 bits in the mask below, not all combinations
319  * of modes and flags are possible:
320  *
321  *   - invalid shadow pages are not accounted, mirror pages are not shadowed,
322  *     so the bits are effectively 18.
323  *
324  *   - quadrant will only be used if has_4_byte_gpte=1 (non-PAE paging);
325  *     execonly and ad_disabled are only used for nested EPT which has
326  *     has_4_byte_gpte=0.  Therefore, 2 bits are always unused.
327  *
328  *   - the 4 bits of level are effectively limited to the values 2/3/4/5,
329  *     as 4k SPs are not tracked (allowed to go unsync).  In addition non-PAE
330  *     paging has exactly one upper level, making level completely redundant
331  *     when has_4_byte_gpte=1.
332  *
333  *   - on top of this, smep_andnot_wp and smap_andnot_wp are only set if
334  *     cr0_wp=0, therefore these three bits only give rise to 5 possibilities.
335  *
336  * Therefore, the maximum number of possible upper-level shadow pages for a
337  * single gfn is a bit less than 2^13.
338  */
339 union kvm_mmu_page_role {
340 	u32 word;
341 	struct {
342 		unsigned level:4;
343 		unsigned has_4_byte_gpte:1;
344 		unsigned quadrant:2;
345 		unsigned direct:1;
346 		unsigned access:3;
347 		unsigned invalid:1;
348 		unsigned efer_nx:1;
349 		unsigned cr0_wp:1;
350 		unsigned smep_andnot_wp:1;
351 		unsigned smap_andnot_wp:1;
352 		unsigned ad_disabled:1;
353 		unsigned guest_mode:1;
354 		unsigned passthrough:1;
355 		unsigned is_mirror:1;
356 		unsigned :4;
357 
358 		/*
359 		 * This is left at the top of the word so that
360 		 * kvm_memslots_for_spte_role can extract it with a
361 		 * simple shift.  While there is room, give it a whole
362 		 * byte so it is also faster to load it from memory.
363 		 */
364 		unsigned smm:8;
365 	};
366 };
367 
368 /*
369  * kvm_mmu_extended_role complements kvm_mmu_page_role, tracking properties
370  * relevant to the current MMU configuration.   When loading CR0, CR4, or EFER,
371  * including on nested transitions, if nothing in the full role changes then
372  * MMU re-configuration can be skipped. @valid bit is set on first usage so we
373  * don't treat all-zero structure as valid data.
374  *
375  * The properties that are tracked in the extended role but not the page role
376  * are for things that either (a) do not affect the validity of the shadow page
377  * or (b) are indirectly reflected in the shadow page's role.  For example,
378  * CR4.PKE only affects permission checks for software walks of the guest page
379  * tables (because KVM doesn't support Protection Keys with shadow paging), and
380  * CR0.PG, CR4.PAE, and CR4.PSE are indirectly reflected in role.level.
381  *
382  * Note, SMEP and SMAP are not redundant with sm*p_andnot_wp in the page role.
383  * If CR0.WP=1, KVM can reuse shadow pages for the guest regardless of SMEP and
384  * SMAP, but the MMU's permission checks for software walks need to be SMEP and
385  * SMAP aware regardless of CR0.WP.
386  */
387 union kvm_mmu_extended_role {
388 	u32 word;
389 	struct {
390 		unsigned int valid:1;
391 		unsigned int execonly:1;
392 		unsigned int cr4_pse:1;
393 		unsigned int cr4_pke:1;
394 		unsigned int cr4_smap:1;
395 		unsigned int cr4_smep:1;
396 		unsigned int cr4_la57:1;
397 		unsigned int efer_lma:1;
398 	};
399 };
400 
401 union kvm_cpu_role {
402 	u64 as_u64;
403 	struct {
404 		union kvm_mmu_page_role base;
405 		union kvm_mmu_extended_role ext;
406 	};
407 };
408 
409 struct kvm_rmap_head {
410 	atomic_long_t val;
411 };
412 
413 struct kvm_pio_request {
414 	unsigned long linear_rip;
415 	unsigned long count;
416 	int in;
417 	int port;
418 	int size;
419 };
420 
421 #define PT64_ROOT_MAX_LEVEL 5
422 
423 struct rsvd_bits_validate {
424 	u64 rsvd_bits_mask[2][PT64_ROOT_MAX_LEVEL];
425 	u64 bad_mt_xwr;
426 };
427 
428 struct kvm_mmu_root_info {
429 	gpa_t pgd;
430 	hpa_t hpa;
431 };
432 
433 #define KVM_MMU_ROOT_INFO_INVALID \
434 	((struct kvm_mmu_root_info) { .pgd = INVALID_PAGE, .hpa = INVALID_PAGE })
435 
436 #define KVM_MMU_NUM_PREV_ROOTS 3
437 
438 #define KVM_MMU_ROOT_CURRENT		BIT(0)
439 #define KVM_MMU_ROOT_PREVIOUS(i)	BIT(1+i)
440 #define KVM_MMU_ROOTS_ALL		(BIT(1 + KVM_MMU_NUM_PREV_ROOTS) - 1)
441 
442 #define KVM_HAVE_MMU_RWLOCK
443 
444 struct kvm_mmu_page;
445 struct kvm_page_fault;
446 
447 /*
448  * x86 supports 4 paging modes (5-level 64-bit, 4-level 64-bit, 3-level 32-bit,
449  * and 2-level 32-bit).  The kvm_mmu structure abstracts the details of the
450  * current mmu mode.
451  */
452 struct kvm_mmu {
453 	unsigned long (*get_guest_pgd)(struct kvm_vcpu *vcpu);
454 	u64 (*get_pdptr)(struct kvm_vcpu *vcpu, int index);
455 	int (*page_fault)(struct kvm_vcpu *vcpu, struct kvm_page_fault *fault);
456 	void (*inject_page_fault)(struct kvm_vcpu *vcpu,
457 				  struct x86_exception *fault);
458 	gpa_t (*gva_to_gpa)(struct kvm_vcpu *vcpu, struct kvm_mmu *mmu,
459 			    gpa_t gva_or_gpa, u64 access,
460 			    struct x86_exception *exception);
461 	int (*sync_spte)(struct kvm_vcpu *vcpu,
462 			 struct kvm_mmu_page *sp, int i);
463 	struct kvm_mmu_root_info root;
464 	hpa_t mirror_root_hpa;
465 	union kvm_cpu_role cpu_role;
466 	union kvm_mmu_page_role root_role;
467 
468 	/*
469 	* The pkru_mask indicates if protection key checks are needed.  It
470 	* consists of 16 domains indexed by page fault error code bits [4:1],
471 	* with PFEC.RSVD replaced by ACC_USER_MASK from the page tables.
472 	* Each domain has 2 bits which are ANDed with AD and WD from PKRU.
473 	*/
474 	u32 pkru_mask;
475 
476 	struct kvm_mmu_root_info prev_roots[KVM_MMU_NUM_PREV_ROOTS];
477 
478 	/*
479 	 * Bitmap; bit set = permission fault
480 	 * Byte index: page fault error code [4:1]
481 	 * Bit index: pte permissions in ACC_* format
482 	 */
483 	u8 permissions[16];
484 
485 	u64 *pae_root;
486 	u64 *pml4_root;
487 	u64 *pml5_root;
488 
489 	/*
490 	 * check zero bits on shadow page table entries, these
491 	 * bits include not only hardware reserved bits but also
492 	 * the bits spte never used.
493 	 */
494 	struct rsvd_bits_validate shadow_zero_check;
495 
496 	struct rsvd_bits_validate guest_rsvd_check;
497 
498 	u64 pdptrs[4]; /* pae */
499 };
500 
501 enum pmc_type {
502 	KVM_PMC_GP = 0,
503 	KVM_PMC_FIXED,
504 };
505 
506 struct kvm_pmc {
507 	enum pmc_type type;
508 	u8 idx;
509 	bool is_paused;
510 	bool intr;
511 	/*
512 	 * Base value of the PMC counter, relative to the *consumed* count in
513 	 * the associated perf_event.  This value includes counter updates from
514 	 * the perf_event and emulated_count since the last time the counter
515 	 * was reprogrammed, but it is *not* the current value as seen by the
516 	 * guest or userspace.
517 	 *
518 	 * The count is relative to the associated perf_event so that KVM
519 	 * doesn't need to reprogram the perf_event every time the guest writes
520 	 * to the counter.
521 	 */
522 	u64 counter;
523 	/*
524 	 * PMC events triggered by KVM emulation that haven't been fully
525 	 * processed, i.e. haven't undergone overflow detection.
526 	 */
527 	u64 emulated_counter;
528 	u64 eventsel;
529 	struct perf_event *perf_event;
530 	struct kvm_vcpu *vcpu;
531 	/*
532 	 * only for creating or reusing perf_event,
533 	 * eventsel value for general purpose counters,
534 	 * ctrl value for fixed counters.
535 	 */
536 	u64 current_config;
537 };
538 
539 /* More counters may conflict with other existing Architectural MSRs */
540 #define KVM_MAX(a, b)	((a) >= (b) ? (a) : (b))
541 #define KVM_MAX_NR_INTEL_GP_COUNTERS	8
542 #define KVM_MAX_NR_AMD_GP_COUNTERS	6
543 #define KVM_MAX_NR_GP_COUNTERS		KVM_MAX(KVM_MAX_NR_INTEL_GP_COUNTERS, \
544 						KVM_MAX_NR_AMD_GP_COUNTERS)
545 
546 #define KVM_MAX_NR_INTEL_FIXED_COUTNERS	3
547 #define KVM_MAX_NR_AMD_FIXED_COUTNERS	0
548 #define KVM_MAX_NR_FIXED_COUNTERS	KVM_MAX(KVM_MAX_NR_INTEL_FIXED_COUTNERS, \
549 						KVM_MAX_NR_AMD_FIXED_COUTNERS)
550 
551 struct kvm_pmu {
552 	u8 version;
553 	unsigned nr_arch_gp_counters;
554 	unsigned nr_arch_fixed_counters;
555 	unsigned available_event_types;
556 	u64 fixed_ctr_ctrl;
557 	u64 fixed_ctr_ctrl_rsvd;
558 	u64 global_ctrl;
559 	u64 global_status;
560 	u64 counter_bitmask[2];
561 	u64 global_ctrl_rsvd;
562 	u64 global_status_rsvd;
563 	u64 reserved_bits;
564 	u64 raw_event_mask;
565 	struct kvm_pmc gp_counters[KVM_MAX_NR_GP_COUNTERS];
566 	struct kvm_pmc fixed_counters[KVM_MAX_NR_FIXED_COUNTERS];
567 
568 	/*
569 	 * Overlay the bitmap with a 64-bit atomic so that all bits can be
570 	 * set in a single access, e.g. to reprogram all counters when the PMU
571 	 * filter changes.
572 	 */
573 	union {
574 		DECLARE_BITMAP(reprogram_pmi, X86_PMC_IDX_MAX);
575 		atomic64_t __reprogram_pmi;
576 	};
577 	DECLARE_BITMAP(all_valid_pmc_idx, X86_PMC_IDX_MAX);
578 	DECLARE_BITMAP(pmc_in_use, X86_PMC_IDX_MAX);
579 
580 	u64 ds_area;
581 	u64 pebs_enable;
582 	u64 pebs_enable_rsvd;
583 	u64 pebs_data_cfg;
584 	u64 pebs_data_cfg_rsvd;
585 
586 	/*
587 	 * If a guest counter is cross-mapped to host counter with different
588 	 * index, its PEBS capability will be temporarily disabled.
589 	 *
590 	 * The user should make sure that this mask is updated
591 	 * after disabling interrupts and before perf_guest_get_msrs();
592 	 */
593 	u64 host_cross_mapped_mask;
594 
595 	/*
596 	 * The gate to release perf_events not marked in
597 	 * pmc_in_use only once in a vcpu time slice.
598 	 */
599 	bool need_cleanup;
600 
601 	/*
602 	 * The total number of programmed perf_events and it helps to avoid
603 	 * redundant check before cleanup if guest don't use vPMU at all.
604 	 */
605 	u8 event_count;
606 };
607 
608 struct kvm_pmu_ops;
609 
610 enum {
611 	KVM_DEBUGREG_BP_ENABLED		= BIT(0),
612 	KVM_DEBUGREG_WONT_EXIT		= BIT(1),
613 	/*
614 	 * Guest debug registers (DR0-3, DR6 and DR7) are saved/restored by
615 	 * hardware on exit from or enter to guest. KVM needn't switch them.
616 	 * DR0-3, DR6 and DR7 are set to their architectural INIT value on VM
617 	 * exit, host values need to be restored.
618 	 */
619 	KVM_DEBUGREG_AUTO_SWITCH	= BIT(2),
620 };
621 
622 struct kvm_mtrr {
623 	u64 var[KVM_NR_VAR_MTRR * 2];
624 	u64 fixed_64k;
625 	u64 fixed_16k[2];
626 	u64 fixed_4k[8];
627 	u64 deftype;
628 };
629 
630 /* Hyper-V SynIC timer */
631 struct kvm_vcpu_hv_stimer {
632 	struct hrtimer timer;
633 	int index;
634 	union hv_stimer_config config;
635 	u64 count;
636 	u64 exp_time;
637 	struct hv_message msg;
638 	bool msg_pending;
639 };
640 
641 /* Hyper-V synthetic interrupt controller (SynIC)*/
642 struct kvm_vcpu_hv_synic {
643 	u64 version;
644 	u64 control;
645 	u64 msg_page;
646 	u64 evt_page;
647 	atomic64_t sint[HV_SYNIC_SINT_COUNT];
648 	atomic_t sint_to_gsi[HV_SYNIC_SINT_COUNT];
649 	DECLARE_BITMAP(auto_eoi_bitmap, 256);
650 	DECLARE_BITMAP(vec_bitmap, 256);
651 	bool active;
652 	bool dont_zero_synic_pages;
653 };
654 
655 /* The maximum number of entries on the TLB flush fifo. */
656 #define KVM_HV_TLB_FLUSH_FIFO_SIZE (16)
657 /*
658  * Note: the following 'magic' entry is made up by KVM to avoid putting
659  * anything besides GVA on the TLB flush fifo. It is theoretically possible
660  * to observe a request to flush 4095 PFNs starting from 0xfffffffffffff000
661  * which will look identical. KVM's action to 'flush everything' instead of
662  * flushing these particular addresses is, however, fully legitimate as
663  * flushing more than requested is always OK.
664  */
665 #define KVM_HV_TLB_FLUSHALL_ENTRY  ((u64)-1)
666 
667 enum hv_tlb_flush_fifos {
668 	HV_L1_TLB_FLUSH_FIFO,
669 	HV_L2_TLB_FLUSH_FIFO,
670 	HV_NR_TLB_FLUSH_FIFOS,
671 };
672 
673 struct kvm_vcpu_hv_tlb_flush_fifo {
674 	spinlock_t write_lock;
675 	DECLARE_KFIFO(entries, u64, KVM_HV_TLB_FLUSH_FIFO_SIZE);
676 };
677 
678 /* Hyper-V per vcpu emulation context */
679 struct kvm_vcpu_hv {
680 	struct kvm_vcpu *vcpu;
681 	u32 vp_index;
682 	u64 hv_vapic;
683 	s64 runtime_offset;
684 	struct kvm_vcpu_hv_synic synic;
685 	struct kvm_hyperv_exit exit;
686 	struct kvm_vcpu_hv_stimer stimer[HV_SYNIC_STIMER_COUNT];
687 	DECLARE_BITMAP(stimer_pending_bitmap, HV_SYNIC_STIMER_COUNT);
688 	bool enforce_cpuid;
689 	struct {
690 		u32 features_eax; /* HYPERV_CPUID_FEATURES.EAX */
691 		u32 features_ebx; /* HYPERV_CPUID_FEATURES.EBX */
692 		u32 features_edx; /* HYPERV_CPUID_FEATURES.EDX */
693 		u32 enlightenments_eax; /* HYPERV_CPUID_ENLIGHTMENT_INFO.EAX */
694 		u32 enlightenments_ebx; /* HYPERV_CPUID_ENLIGHTMENT_INFO.EBX */
695 		u32 syndbg_cap_eax; /* HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES.EAX */
696 		u32 nested_eax; /* HYPERV_CPUID_NESTED_FEATURES.EAX */
697 		u32 nested_ebx; /* HYPERV_CPUID_NESTED_FEATURES.EBX */
698 	} cpuid_cache;
699 
700 	struct kvm_vcpu_hv_tlb_flush_fifo tlb_flush_fifo[HV_NR_TLB_FLUSH_FIFOS];
701 
702 	/* Preallocated buffer for handling hypercalls passing sparse vCPU set */
703 	u64 sparse_banks[HV_MAX_SPARSE_VCPU_BANKS];
704 
705 	struct hv_vp_assist_page vp_assist_page;
706 
707 	struct {
708 		u64 pa_page_gpa;
709 		u64 vm_id;
710 		u32 vp_id;
711 	} nested;
712 };
713 
714 struct kvm_hypervisor_cpuid {
715 	u32 base;
716 	u32 limit;
717 };
718 
719 #ifdef CONFIG_KVM_XEN
720 /* Xen HVM per vcpu emulation context */
721 struct kvm_vcpu_xen {
722 	u64 hypercall_rip;
723 	u32 current_runstate;
724 	u8 upcall_vector;
725 	struct gfn_to_pfn_cache vcpu_info_cache;
726 	struct gfn_to_pfn_cache vcpu_time_info_cache;
727 	struct gfn_to_pfn_cache runstate_cache;
728 	struct gfn_to_pfn_cache runstate2_cache;
729 	u64 last_steal;
730 	u64 runstate_entry_time;
731 	u64 runstate_times[4];
732 	unsigned long evtchn_pending_sel;
733 	u32 vcpu_id; /* The Xen / ACPI vCPU ID */
734 	u32 timer_virq;
735 	u64 timer_expires; /* In guest epoch */
736 	atomic_t timer_pending;
737 	struct hrtimer timer;
738 	int poll_evtchn;
739 	struct timer_list poll_timer;
740 	struct kvm_hypervisor_cpuid cpuid;
741 };
742 #endif
743 
744 struct kvm_queued_exception {
745 	bool pending;
746 	bool injected;
747 	bool has_error_code;
748 	u8 vector;
749 	u32 error_code;
750 	unsigned long payload;
751 	bool has_payload;
752 };
753 
754 /*
755  * Hardware-defined CPUID leafs that are either scattered by the kernel or are
756  * unknown to the kernel, but need to be directly used by KVM.  Note, these
757  * word values conflict with the kernel's "bug" caps, but KVM doesn't use those.
758  */
759 enum kvm_only_cpuid_leafs {
760 	CPUID_12_EAX	 = NCAPINTS,
761 	CPUID_7_1_EDX,
762 	CPUID_8000_0007_EDX,
763 	CPUID_8000_0022_EAX,
764 	CPUID_7_2_EDX,
765 	CPUID_24_0_EBX,
766 	NR_KVM_CPU_CAPS,
767 
768 	NKVMCAPINTS = NR_KVM_CPU_CAPS - NCAPINTS,
769 };
770 
771 struct kvm_vcpu_arch {
772 	/*
773 	 * rip and regs accesses must go through
774 	 * kvm_{register,rip}_{read,write} functions.
775 	 */
776 	unsigned long regs[NR_VCPU_REGS];
777 	u32 regs_avail;
778 	u32 regs_dirty;
779 
780 	unsigned long cr0;
781 	unsigned long cr0_guest_owned_bits;
782 	unsigned long cr2;
783 	unsigned long cr3;
784 	unsigned long cr4;
785 	unsigned long cr4_guest_owned_bits;
786 	unsigned long cr4_guest_rsvd_bits;
787 	unsigned long cr8;
788 	u32 host_pkru;
789 	u32 pkru;
790 	u32 hflags;
791 	u64 efer;
792 	u64 host_debugctl;
793 	u64 apic_base;
794 	struct kvm_lapic *apic;    /* kernel irqchip context */
795 	bool load_eoi_exitmap_pending;
796 	DECLARE_BITMAP(ioapic_handled_vectors, 256);
797 	unsigned long apic_attention;
798 	int32_t apic_arb_prio;
799 	int mp_state;
800 	u64 ia32_misc_enable_msr;
801 	u64 smbase;
802 	u64 smi_count;
803 	bool at_instruction_boundary;
804 	bool tpr_access_reporting;
805 	bool xfd_no_write_intercept;
806 	u64 ia32_xss;
807 	u64 microcode_version;
808 	u64 arch_capabilities;
809 	u64 perf_capabilities;
810 
811 	/*
812 	 * Paging state of the vcpu
813 	 *
814 	 * If the vcpu runs in guest mode with two level paging this still saves
815 	 * the paging mode of the l1 guest. This context is always used to
816 	 * handle faults.
817 	 */
818 	struct kvm_mmu *mmu;
819 
820 	/* Non-nested MMU for L1 */
821 	struct kvm_mmu root_mmu;
822 
823 	/* L1 MMU when running nested */
824 	struct kvm_mmu guest_mmu;
825 
826 	/*
827 	 * Paging state of an L2 guest (used for nested npt)
828 	 *
829 	 * This context will save all necessary information to walk page tables
830 	 * of an L2 guest. This context is only initialized for page table
831 	 * walking and not for faulting since we never handle l2 page faults on
832 	 * the host.
833 	 */
834 	struct kvm_mmu nested_mmu;
835 
836 	/*
837 	 * Pointer to the mmu context currently used for
838 	 * gva_to_gpa translations.
839 	 */
840 	struct kvm_mmu *walk_mmu;
841 
842 	struct kvm_mmu_memory_cache mmu_pte_list_desc_cache;
843 	struct kvm_mmu_memory_cache mmu_shadow_page_cache;
844 	struct kvm_mmu_memory_cache mmu_shadowed_info_cache;
845 	struct kvm_mmu_memory_cache mmu_page_header_cache;
846 	/*
847 	 * This cache is to allocate external page table. E.g. private EPT used
848 	 * by the TDX module.
849 	 */
850 	struct kvm_mmu_memory_cache mmu_external_spt_cache;
851 
852 	/*
853 	 * QEMU userspace and the guest each have their own FPU state.
854 	 * In vcpu_run, we switch between the user and guest FPU contexts.
855 	 * While running a VCPU, the VCPU thread will have the guest FPU
856 	 * context.
857 	 *
858 	 * Note that while the PKRU state lives inside the fpu registers,
859 	 * it is switched out separately at VMENTER and VMEXIT time. The
860 	 * "guest_fpstate" state here contains the guest FPU context, with the
861 	 * host PRKU bits.
862 	 */
863 	struct fpu_guest guest_fpu;
864 
865 	u64 xcr0;
866 	u64 guest_supported_xcr0;
867 
868 	struct kvm_pio_request pio;
869 	void *pio_data;
870 	void *sev_pio_data;
871 	unsigned sev_pio_count;
872 
873 	u8 event_exit_inst_len;
874 
875 	bool exception_from_userspace;
876 
877 	/* Exceptions to be injected to the guest. */
878 	struct kvm_queued_exception exception;
879 	/* Exception VM-Exits to be synthesized to L1. */
880 	struct kvm_queued_exception exception_vmexit;
881 
882 	struct kvm_queued_interrupt {
883 		bool injected;
884 		bool soft;
885 		u8 nr;
886 	} interrupt;
887 
888 	int halt_request; /* real mode on Intel only */
889 
890 	int cpuid_nent;
891 	struct kvm_cpuid_entry2 *cpuid_entries;
892 	bool cpuid_dynamic_bits_dirty;
893 	bool is_amd_compatible;
894 
895 	/*
896 	 * cpu_caps holds the effective guest capabilities, i.e. the features
897 	 * the vCPU is allowed to use.  Typically, but not always, features can
898 	 * be used by the guest if and only if both KVM and userspace want to
899 	 * expose the feature to the guest.
900 	 *
901 	 * A common exception is for virtualization holes, i.e. when KVM can't
902 	 * prevent the guest from using a feature, in which case the vCPU "has"
903 	 * the feature regardless of what KVM or userspace desires.
904 	 *
905 	 * Note, features that don't require KVM involvement in any way are
906 	 * NOT enforced/sanitized by KVM, i.e. are taken verbatim from the
907 	 * guest CPUID provided by userspace.
908 	 */
909 	u32 cpu_caps[NR_KVM_CPU_CAPS];
910 
911 	u64 reserved_gpa_bits;
912 	int maxphyaddr;
913 
914 	/* emulate context */
915 
916 	struct x86_emulate_ctxt *emulate_ctxt;
917 	bool emulate_regs_need_sync_to_vcpu;
918 	bool emulate_regs_need_sync_from_vcpu;
919 	int (*complete_userspace_io)(struct kvm_vcpu *vcpu);
920 
921 	gpa_t time;
922 	s8  pvclock_tsc_shift;
923 	u32 pvclock_tsc_mul;
924 	unsigned int hw_tsc_khz;
925 	struct gfn_to_pfn_cache pv_time;
926 	/* set guest stopped flag in pvclock flags field */
927 	bool pvclock_set_guest_stopped_request;
928 
929 	struct {
930 		u8 preempted;
931 		u64 msr_val;
932 		u64 last_steal;
933 		struct gfn_to_hva_cache cache;
934 	} st;
935 
936 	u64 l1_tsc_offset;
937 	u64 tsc_offset; /* current tsc offset */
938 	u64 last_guest_tsc;
939 	u64 last_host_tsc;
940 	u64 tsc_offset_adjustment;
941 	u64 this_tsc_nsec;
942 	u64 this_tsc_write;
943 	u64 this_tsc_generation;
944 	bool tsc_catchup;
945 	bool tsc_always_catchup;
946 	s8 virtual_tsc_shift;
947 	u32 virtual_tsc_mult;
948 	u32 virtual_tsc_khz;
949 	s64 ia32_tsc_adjust_msr;
950 	u64 msr_ia32_power_ctl;
951 	u64 l1_tsc_scaling_ratio;
952 	u64 tsc_scaling_ratio; /* current scaling ratio */
953 
954 	atomic_t nmi_queued;  /* unprocessed asynchronous NMIs */
955 	/* Number of NMIs pending injection, not including hardware vNMIs. */
956 	unsigned int nmi_pending;
957 	bool nmi_injected;    /* Trying to inject an NMI this entry */
958 	bool smi_pending;    /* SMI queued after currently running handler */
959 	u8 handling_intr_from_guest;
960 
961 	struct kvm_mtrr mtrr_state;
962 	u64 pat;
963 
964 	unsigned switch_db_regs;
965 	unsigned long db[KVM_NR_DB_REGS];
966 	unsigned long dr6;
967 	unsigned long dr7;
968 	unsigned long eff_db[KVM_NR_DB_REGS];
969 	unsigned long guest_debug_dr7;
970 	u64 msr_platform_info;
971 	u64 msr_misc_features_enables;
972 
973 	u64 mcg_cap;
974 	u64 mcg_status;
975 	u64 mcg_ctl;
976 	u64 mcg_ext_ctl;
977 	u64 *mce_banks;
978 	u64 *mci_ctl2_banks;
979 
980 	/* Cache MMIO info */
981 	u64 mmio_gva;
982 	unsigned mmio_access;
983 	gfn_t mmio_gfn;
984 	u64 mmio_gen;
985 
986 	struct kvm_pmu pmu;
987 
988 	/* used for guest single stepping over the given code position */
989 	unsigned long singlestep_rip;
990 
991 #ifdef CONFIG_KVM_HYPERV
992 	bool hyperv_enabled;
993 	struct kvm_vcpu_hv *hyperv;
994 #endif
995 #ifdef CONFIG_KVM_XEN
996 	struct kvm_vcpu_xen xen;
997 #endif
998 	cpumask_var_t wbinvd_dirty_mask;
999 
1000 	unsigned long last_retry_eip;
1001 	unsigned long last_retry_addr;
1002 
1003 	struct {
1004 		bool halted;
1005 		gfn_t gfns[ASYNC_PF_PER_VCPU];
1006 		struct gfn_to_hva_cache data;
1007 		u64 msr_en_val; /* MSR_KVM_ASYNC_PF_EN */
1008 		u64 msr_int_val; /* MSR_KVM_ASYNC_PF_INT */
1009 		u16 vec;
1010 		u32 id;
1011 		u32 host_apf_flags;
1012 		bool send_always;
1013 		bool delivery_as_pf_vmexit;
1014 		bool pageready_pending;
1015 	} apf;
1016 
1017 	/* OSVW MSRs (AMD only) */
1018 	struct {
1019 		u64 length;
1020 		u64 status;
1021 	} osvw;
1022 
1023 	struct {
1024 		u64 msr_val;
1025 		struct gfn_to_hva_cache data;
1026 	} pv_eoi;
1027 
1028 	u64 msr_kvm_poll_control;
1029 
1030 	/* pv related host specific info */
1031 	struct {
1032 		bool pv_unhalted;
1033 	} pv;
1034 
1035 	int pending_ioapic_eoi;
1036 	int pending_external_vector;
1037 
1038 	/* be preempted when it's in kernel-mode(cpl=0) */
1039 	bool preempted_in_kernel;
1040 
1041 	/* Flush the L1 Data cache for L1TF mitigation on VMENTER */
1042 	bool l1tf_flush_l1d;
1043 
1044 	/* Host CPU on which VM-entry was most recently attempted */
1045 	int last_vmentry_cpu;
1046 
1047 	/* AMD MSRC001_0015 Hardware Configuration */
1048 	u64 msr_hwcr;
1049 
1050 	/* pv related cpuid info */
1051 	struct {
1052 		/*
1053 		 * value of the eax register in the KVM_CPUID_FEATURES CPUID
1054 		 * leaf.
1055 		 */
1056 		u32 features;
1057 
1058 		/*
1059 		 * indicates whether pv emulation should be disabled if features
1060 		 * are not present in the guest's cpuid
1061 		 */
1062 		bool enforce;
1063 	} pv_cpuid;
1064 
1065 	/* Protected Guests */
1066 	bool guest_state_protected;
1067 	bool guest_tsc_protected;
1068 
1069 	/*
1070 	 * Set when PDPTS were loaded directly by the userspace without
1071 	 * reading the guest memory
1072 	 */
1073 	bool pdptrs_from_userspace;
1074 
1075 #if IS_ENABLED(CONFIG_HYPERV)
1076 	hpa_t hv_root_tdp;
1077 #endif
1078 };
1079 
1080 struct kvm_lpage_info {
1081 	int disallow_lpage;
1082 };
1083 
1084 struct kvm_arch_memory_slot {
1085 	struct kvm_rmap_head *rmap[KVM_NR_PAGE_SIZES];
1086 	struct kvm_lpage_info *lpage_info[KVM_NR_PAGE_SIZES - 1];
1087 	unsigned short *gfn_write_track;
1088 };
1089 
1090 /*
1091  * Track the mode of the optimized logical map, as the rules for decoding the
1092  * destination vary per mode.  Enabling the optimized logical map requires all
1093  * software-enabled local APIs to be in the same mode, each addressable APIC to
1094  * be mapped to only one MDA, and each MDA to map to at most one APIC.
1095  */
1096 enum kvm_apic_logical_mode {
1097 	/* All local APICs are software disabled. */
1098 	KVM_APIC_MODE_SW_DISABLED,
1099 	/* All software enabled local APICs in xAPIC cluster addressing mode. */
1100 	KVM_APIC_MODE_XAPIC_CLUSTER,
1101 	/* All software enabled local APICs in xAPIC flat addressing mode. */
1102 	KVM_APIC_MODE_XAPIC_FLAT,
1103 	/* All software enabled local APICs in x2APIC mode. */
1104 	KVM_APIC_MODE_X2APIC,
1105 	/*
1106 	 * Optimized map disabled, e.g. not all local APICs in the same logical
1107 	 * mode, same logical ID assigned to multiple APICs, etc.
1108 	 */
1109 	KVM_APIC_MODE_MAP_DISABLED,
1110 };
1111 
1112 struct kvm_apic_map {
1113 	struct rcu_head rcu;
1114 	enum kvm_apic_logical_mode logical_mode;
1115 	u32 max_apic_id;
1116 	union {
1117 		struct kvm_lapic *xapic_flat_map[8];
1118 		struct kvm_lapic *xapic_cluster_map[16][4];
1119 	};
1120 	struct kvm_lapic *phys_map[];
1121 };
1122 
1123 /* Hyper-V synthetic debugger (SynDbg)*/
1124 struct kvm_hv_syndbg {
1125 	struct {
1126 		u64 control;
1127 		u64 status;
1128 		u64 send_page;
1129 		u64 recv_page;
1130 		u64 pending_page;
1131 	} control;
1132 	u64 options;
1133 };
1134 
1135 /* Current state of Hyper-V TSC page clocksource */
1136 enum hv_tsc_page_status {
1137 	/* TSC page was not set up or disabled */
1138 	HV_TSC_PAGE_UNSET = 0,
1139 	/* TSC page MSR was written by the guest, update pending */
1140 	HV_TSC_PAGE_GUEST_CHANGED,
1141 	/* TSC page update was triggered from the host side */
1142 	HV_TSC_PAGE_HOST_CHANGED,
1143 	/* TSC page was properly set up and is currently active  */
1144 	HV_TSC_PAGE_SET,
1145 	/* TSC page was set up with an inaccessible GPA */
1146 	HV_TSC_PAGE_BROKEN,
1147 };
1148 
1149 #ifdef CONFIG_KVM_HYPERV
1150 /* Hyper-V emulation context */
1151 struct kvm_hv {
1152 	struct mutex hv_lock;
1153 	u64 hv_guest_os_id;
1154 	u64 hv_hypercall;
1155 	u64 hv_tsc_page;
1156 	enum hv_tsc_page_status hv_tsc_page_status;
1157 
1158 	/* Hyper-v based guest crash (NT kernel bugcheck) parameters */
1159 	u64 hv_crash_param[HV_X64_MSR_CRASH_PARAMS];
1160 	u64 hv_crash_ctl;
1161 
1162 	struct ms_hyperv_tsc_page tsc_ref;
1163 
1164 	struct idr conn_to_evt;
1165 
1166 	u64 hv_reenlightenment_control;
1167 	u64 hv_tsc_emulation_control;
1168 	u64 hv_tsc_emulation_status;
1169 	u64 hv_invtsc_control;
1170 
1171 	/* How many vCPUs have VP index != vCPU index */
1172 	atomic_t num_mismatched_vp_indexes;
1173 
1174 	/*
1175 	 * How many SynICs use 'AutoEOI' feature
1176 	 * (protected by arch.apicv_update_lock)
1177 	 */
1178 	unsigned int synic_auto_eoi_used;
1179 
1180 	struct kvm_hv_syndbg hv_syndbg;
1181 
1182 	bool xsaves_xsavec_checked;
1183 };
1184 #endif
1185 
1186 struct msr_bitmap_range {
1187 	u32 flags;
1188 	u32 nmsrs;
1189 	u32 base;
1190 	unsigned long *bitmap;
1191 };
1192 
1193 #ifdef CONFIG_KVM_XEN
1194 /* Xen emulation context */
1195 struct kvm_xen {
1196 	struct mutex xen_lock;
1197 	u32 xen_version;
1198 	bool long_mode;
1199 	bool runstate_update_flag;
1200 	u8 upcall_vector;
1201 	struct gfn_to_pfn_cache shinfo_cache;
1202 	struct idr evtchn_ports;
1203 	unsigned long poll_mask[BITS_TO_LONGS(KVM_MAX_VCPUS)];
1204 
1205 	struct kvm_xen_hvm_config hvm_config;
1206 };
1207 #endif
1208 
1209 enum kvm_irqchip_mode {
1210 	KVM_IRQCHIP_NONE,
1211 	KVM_IRQCHIP_KERNEL,       /* created with KVM_CREATE_IRQCHIP */
1212 	KVM_IRQCHIP_SPLIT,        /* created with KVM_CAP_SPLIT_IRQCHIP */
1213 };
1214 
1215 struct kvm_x86_msr_filter {
1216 	u8 count;
1217 	bool default_allow:1;
1218 	struct msr_bitmap_range ranges[16];
1219 };
1220 
1221 struct kvm_x86_pmu_event_filter {
1222 	__u32 action;
1223 	__u32 nevents;
1224 	__u32 fixed_counter_bitmap;
1225 	__u32 flags;
1226 	__u32 nr_includes;
1227 	__u32 nr_excludes;
1228 	__u64 *includes;
1229 	__u64 *excludes;
1230 	__u64 events[];
1231 };
1232 
1233 enum kvm_apicv_inhibit {
1234 
1235 	/********************************************************************/
1236 	/* INHIBITs that are relevant to both Intel's APICv and AMD's AVIC. */
1237 	/********************************************************************/
1238 
1239 	/*
1240 	 * APIC acceleration is disabled by a module parameter
1241 	 * and/or not supported in hardware.
1242 	 */
1243 	APICV_INHIBIT_REASON_DISABLED,
1244 
1245 	/*
1246 	 * APIC acceleration is inhibited because AutoEOI feature is
1247 	 * being used by a HyperV guest.
1248 	 */
1249 	APICV_INHIBIT_REASON_HYPERV,
1250 
1251 	/*
1252 	 * APIC acceleration is inhibited because the userspace didn't yet
1253 	 * enable the kernel/split irqchip.
1254 	 */
1255 	APICV_INHIBIT_REASON_ABSENT,
1256 
1257 	/* APIC acceleration is inhibited because KVM_GUESTDBG_BLOCKIRQ
1258 	 * (out of band, debug measure of blocking all interrupts on this vCPU)
1259 	 * was enabled, to avoid AVIC/APICv bypassing it.
1260 	 */
1261 	APICV_INHIBIT_REASON_BLOCKIRQ,
1262 
1263 	/*
1264 	 * APICv is disabled because not all vCPUs have a 1:1 mapping between
1265 	 * APIC ID and vCPU, _and_ KVM is not applying its x2APIC hotplug hack.
1266 	 */
1267 	APICV_INHIBIT_REASON_PHYSICAL_ID_ALIASED,
1268 
1269 	/*
1270 	 * For simplicity, the APIC acceleration is inhibited
1271 	 * first time either APIC ID or APIC base are changed by the guest
1272 	 * from their reset values.
1273 	 */
1274 	APICV_INHIBIT_REASON_APIC_ID_MODIFIED,
1275 	APICV_INHIBIT_REASON_APIC_BASE_MODIFIED,
1276 
1277 	/******************************************************/
1278 	/* INHIBITs that are relevant only to the AMD's AVIC. */
1279 	/******************************************************/
1280 
1281 	/*
1282 	 * AVIC is inhibited on a vCPU because it runs a nested guest.
1283 	 *
1284 	 * This is needed because unlike APICv, the peers of this vCPU
1285 	 * cannot use the doorbell mechanism to signal interrupts via AVIC when
1286 	 * a vCPU runs nested.
1287 	 */
1288 	APICV_INHIBIT_REASON_NESTED,
1289 
1290 	/*
1291 	 * On SVM, the wait for the IRQ window is implemented with pending vIRQ,
1292 	 * which cannot be injected when the AVIC is enabled, thus AVIC
1293 	 * is inhibited while KVM waits for IRQ window.
1294 	 */
1295 	APICV_INHIBIT_REASON_IRQWIN,
1296 
1297 	/*
1298 	 * PIT (i8254) 're-inject' mode, relies on EOI intercept,
1299 	 * which AVIC doesn't support for edge triggered interrupts.
1300 	 */
1301 	APICV_INHIBIT_REASON_PIT_REINJ,
1302 
1303 	/*
1304 	 * AVIC is disabled because SEV doesn't support it.
1305 	 */
1306 	APICV_INHIBIT_REASON_SEV,
1307 
1308 	/*
1309 	 * AVIC is disabled because not all vCPUs with a valid LDR have a 1:1
1310 	 * mapping between logical ID and vCPU.
1311 	 */
1312 	APICV_INHIBIT_REASON_LOGICAL_ID_ALIASED,
1313 
1314 	NR_APICV_INHIBIT_REASONS,
1315 };
1316 
1317 #define __APICV_INHIBIT_REASON(reason)			\
1318 	{ BIT(APICV_INHIBIT_REASON_##reason), #reason }
1319 
1320 #define APICV_INHIBIT_REASONS				\
1321 	__APICV_INHIBIT_REASON(DISABLED),		\
1322 	__APICV_INHIBIT_REASON(HYPERV),			\
1323 	__APICV_INHIBIT_REASON(ABSENT),			\
1324 	__APICV_INHIBIT_REASON(BLOCKIRQ),		\
1325 	__APICV_INHIBIT_REASON(PHYSICAL_ID_ALIASED),	\
1326 	__APICV_INHIBIT_REASON(APIC_ID_MODIFIED),	\
1327 	__APICV_INHIBIT_REASON(APIC_BASE_MODIFIED),	\
1328 	__APICV_INHIBIT_REASON(NESTED),			\
1329 	__APICV_INHIBIT_REASON(IRQWIN),			\
1330 	__APICV_INHIBIT_REASON(PIT_REINJ),		\
1331 	__APICV_INHIBIT_REASON(SEV),			\
1332 	__APICV_INHIBIT_REASON(LOGICAL_ID_ALIASED)
1333 
1334 struct kvm_arch {
1335 	unsigned long n_used_mmu_pages;
1336 	unsigned long n_requested_mmu_pages;
1337 	unsigned long n_max_mmu_pages;
1338 	unsigned int indirect_shadow_pages;
1339 	u8 mmu_valid_gen;
1340 	u8 vm_type;
1341 	bool has_private_mem;
1342 	bool has_protected_state;
1343 	bool pre_fault_allowed;
1344 	struct hlist_head mmu_page_hash[KVM_NUM_MMU_PAGES];
1345 	struct list_head active_mmu_pages;
1346 	/*
1347 	 * A list of kvm_mmu_page structs that, if zapped, could possibly be
1348 	 * replaced by an NX huge page.  A shadow page is on this list if its
1349 	 * existence disallows an NX huge page (nx_huge_page_disallowed is set)
1350 	 * and there are no other conditions that prevent a huge page, e.g.
1351 	 * the backing host page is huge, dirtly logging is not enabled for its
1352 	 * memslot, etc...  Note, zapping shadow pages on this list doesn't
1353 	 * guarantee an NX huge page will be created in its stead, e.g. if the
1354 	 * guest attempts to execute from the region then KVM obviously can't
1355 	 * create an NX huge page (without hanging the guest).
1356 	 */
1357 	struct list_head possible_nx_huge_pages;
1358 #ifdef CONFIG_KVM_EXTERNAL_WRITE_TRACKING
1359 	struct kvm_page_track_notifier_head track_notifier_head;
1360 #endif
1361 	/*
1362 	 * Protects marking pages unsync during page faults, as TDP MMU page
1363 	 * faults only take mmu_lock for read.  For simplicity, the unsync
1364 	 * pages lock is always taken when marking pages unsync regardless of
1365 	 * whether mmu_lock is held for read or write.
1366 	 */
1367 	spinlock_t mmu_unsync_pages_lock;
1368 
1369 	u64 shadow_mmio_value;
1370 
1371 #define __KVM_HAVE_ARCH_NONCOHERENT_DMA
1372 	atomic_t noncoherent_dma_count;
1373 #define __KVM_HAVE_ARCH_ASSIGNED_DEVICE
1374 	atomic_t assigned_device_count;
1375 	struct kvm_pic *vpic;
1376 	struct kvm_ioapic *vioapic;
1377 	struct kvm_pit *vpit;
1378 	atomic_t vapics_in_nmi_mode;
1379 	struct mutex apic_map_lock;
1380 	struct kvm_apic_map __rcu *apic_map;
1381 	atomic_t apic_map_dirty;
1382 
1383 	bool apic_access_memslot_enabled;
1384 	bool apic_access_memslot_inhibited;
1385 
1386 	/* Protects apicv_inhibit_reasons */
1387 	struct rw_semaphore apicv_update_lock;
1388 	unsigned long apicv_inhibit_reasons;
1389 
1390 	gpa_t wall_clock;
1391 
1392 	bool mwait_in_guest;
1393 	bool hlt_in_guest;
1394 	bool pause_in_guest;
1395 	bool cstate_in_guest;
1396 
1397 	unsigned long irq_sources_bitmap;
1398 	s64 kvmclock_offset;
1399 
1400 	/*
1401 	 * This also protects nr_vcpus_matched_tsc which is read from a
1402 	 * preemption-disabled region, so it must be a raw spinlock.
1403 	 */
1404 	raw_spinlock_t tsc_write_lock;
1405 	u64 last_tsc_nsec;
1406 	u64 last_tsc_write;
1407 	u32 last_tsc_khz;
1408 	u64 last_tsc_offset;
1409 	u64 cur_tsc_nsec;
1410 	u64 cur_tsc_write;
1411 	u64 cur_tsc_offset;
1412 	u64 cur_tsc_generation;
1413 	int nr_vcpus_matched_tsc;
1414 
1415 	u32 default_tsc_khz;
1416 	bool user_set_tsc;
1417 	u64 apic_bus_cycle_ns;
1418 
1419 	seqcount_raw_spinlock_t pvclock_sc;
1420 	bool use_master_clock;
1421 	u64 master_kernel_ns;
1422 	u64 master_cycle_now;
1423 	struct delayed_work kvmclock_update_work;
1424 	struct delayed_work kvmclock_sync_work;
1425 
1426 	/* reads protected by irq_srcu, writes by irq_lock */
1427 	struct hlist_head mask_notifier_list;
1428 
1429 #ifdef CONFIG_KVM_HYPERV
1430 	struct kvm_hv hyperv;
1431 #endif
1432 
1433 #ifdef CONFIG_KVM_XEN
1434 	struct kvm_xen xen;
1435 #endif
1436 
1437 	bool backwards_tsc_observed;
1438 	bool boot_vcpu_runs_old_kvmclock;
1439 	u32 bsp_vcpu_id;
1440 
1441 	u64 disabled_quirks;
1442 
1443 	enum kvm_irqchip_mode irqchip_mode;
1444 	u8 nr_reserved_ioapic_pins;
1445 
1446 	bool disabled_lapic_found;
1447 
1448 	bool x2apic_format;
1449 	bool x2apic_broadcast_quirk_disabled;
1450 
1451 	bool guest_can_read_msr_platform_info;
1452 	bool exception_payload_enabled;
1453 
1454 	bool triple_fault_event;
1455 
1456 	bool bus_lock_detection_enabled;
1457 	bool enable_pmu;
1458 
1459 	u32 notify_window;
1460 	u32 notify_vmexit_flags;
1461 	/*
1462 	 * If exit_on_emulation_error is set, and the in-kernel instruction
1463 	 * emulator fails to emulate an instruction, allow userspace
1464 	 * the opportunity to look at it.
1465 	 */
1466 	bool exit_on_emulation_error;
1467 
1468 	/* Deflect RDMSR and WRMSR to user space when they trigger a #GP */
1469 	u32 user_space_msr_mask;
1470 	struct kvm_x86_msr_filter __rcu *msr_filter;
1471 
1472 	u32 hypercall_exit_enabled;
1473 
1474 	/* Guest can access the SGX PROVISIONKEY. */
1475 	bool sgx_provisioning_allowed;
1476 
1477 	struct kvm_x86_pmu_event_filter __rcu *pmu_event_filter;
1478 	struct vhost_task *nx_huge_page_recovery_thread;
1479 	u64 nx_huge_page_last;
1480 	struct once nx_once;
1481 
1482 #ifdef CONFIG_X86_64
1483 #ifdef CONFIG_KVM_PROVE_MMU
1484 	/*
1485 	 * The number of TDP MMU pages across all roots.  Used only to sanity
1486 	 * check that KVM isn't leaking TDP MMU pages.
1487 	 */
1488 	atomic64_t tdp_mmu_pages;
1489 #endif
1490 
1491 	/*
1492 	 * List of struct kvm_mmu_pages being used as roots.
1493 	 * All struct kvm_mmu_pages in the list should have
1494 	 * tdp_mmu_page set.
1495 	 *
1496 	 * For reads, this list is protected by:
1497 	 *	RCU alone or
1498 	 *	the MMU lock in read mode + RCU or
1499 	 *	the MMU lock in write mode
1500 	 *
1501 	 * For writes, this list is protected by tdp_mmu_pages_lock; see
1502 	 * below for the details.
1503 	 *
1504 	 * Roots will remain in the list until their tdp_mmu_root_count
1505 	 * drops to zero, at which point the thread that decremented the
1506 	 * count to zero should removed the root from the list and clean
1507 	 * it up, freeing the root after an RCU grace period.
1508 	 */
1509 	struct list_head tdp_mmu_roots;
1510 
1511 	/*
1512 	 * Protects accesses to the following fields when the MMU lock
1513 	 * is held in read mode:
1514 	 *  - tdp_mmu_roots (above)
1515 	 *  - the link field of kvm_mmu_page structs used by the TDP MMU
1516 	 *  - possible_nx_huge_pages;
1517 	 *  - the possible_nx_huge_page_link field of kvm_mmu_page structs used
1518 	 *    by the TDP MMU
1519 	 * Because the lock is only taken within the MMU lock, strictly
1520 	 * speaking it is redundant to acquire this lock when the thread
1521 	 * holds the MMU lock in write mode.  However it often simplifies
1522 	 * the code to do so.
1523 	 */
1524 	spinlock_t tdp_mmu_pages_lock;
1525 #endif /* CONFIG_X86_64 */
1526 
1527 	/*
1528 	 * If set, at least one shadow root has been allocated. This flag
1529 	 * is used as one input when determining whether certain memslot
1530 	 * related allocations are necessary.
1531 	 */
1532 	bool shadow_root_allocated;
1533 
1534 #ifdef CONFIG_KVM_EXTERNAL_WRITE_TRACKING
1535 	/*
1536 	 * If set, the VM has (or had) an external write tracking user, and
1537 	 * thus all write tracking metadata has been allocated, even if KVM
1538 	 * itself isn't using write tracking.
1539 	 */
1540 	bool external_write_tracking_enabled;
1541 #endif
1542 
1543 #if IS_ENABLED(CONFIG_HYPERV)
1544 	hpa_t	hv_root_tdp;
1545 	spinlock_t hv_root_tdp_lock;
1546 	struct hv_partition_assist_pg *hv_pa_pg;
1547 #endif
1548 	/*
1549 	 * VM-scope maximum vCPU ID. Used to determine the size of structures
1550 	 * that increase along with the maximum vCPU ID, in which case, using
1551 	 * the global KVM_MAX_VCPU_IDS may lead to significant memory waste.
1552 	 */
1553 	u32 max_vcpu_ids;
1554 
1555 	bool disable_nx_huge_pages;
1556 
1557 	/*
1558 	 * Memory caches used to allocate shadow pages when performing eager
1559 	 * page splitting. No need for a shadowed_info_cache since eager page
1560 	 * splitting only allocates direct shadow pages.
1561 	 *
1562 	 * Protected by kvm->slots_lock.
1563 	 */
1564 	struct kvm_mmu_memory_cache split_shadow_page_cache;
1565 	struct kvm_mmu_memory_cache split_page_header_cache;
1566 
1567 	/*
1568 	 * Memory cache used to allocate pte_list_desc structs while splitting
1569 	 * huge pages. In the worst case, to split one huge page, 512
1570 	 * pte_list_desc structs are needed to add each lower level leaf sptep
1571 	 * to the rmap plus 1 to extend the parent_ptes rmap of the lower level
1572 	 * page table.
1573 	 *
1574 	 * Protected by kvm->slots_lock.
1575 	 */
1576 #define SPLIT_DESC_CACHE_MIN_NR_OBJECTS (SPTE_ENT_PER_PAGE + 1)
1577 	struct kvm_mmu_memory_cache split_desc_cache;
1578 
1579 	gfn_t gfn_direct_bits;
1580 
1581 	/*
1582 	 * Size of the CPU's dirty log buffer, i.e. VMX's PML buffer. A Zero
1583 	 * value indicates CPU dirty logging is unsupported or disabled in
1584 	 * current VM.
1585 	 */
1586 	int cpu_dirty_log_size;
1587 };
1588 
1589 struct kvm_vm_stat {
1590 	struct kvm_vm_stat_generic generic;
1591 	u64 mmu_shadow_zapped;
1592 	u64 mmu_pte_write;
1593 	u64 mmu_pde_zapped;
1594 	u64 mmu_flooded;
1595 	u64 mmu_recycled;
1596 	u64 mmu_cache_miss;
1597 	u64 mmu_unsync;
1598 	union {
1599 		struct {
1600 			atomic64_t pages_4k;
1601 			atomic64_t pages_2m;
1602 			atomic64_t pages_1g;
1603 		};
1604 		atomic64_t pages[KVM_NR_PAGE_SIZES];
1605 	};
1606 	u64 nx_lpage_splits;
1607 	u64 max_mmu_page_hash_collisions;
1608 	u64 max_mmu_rmap_size;
1609 };
1610 
1611 struct kvm_vcpu_stat {
1612 	struct kvm_vcpu_stat_generic generic;
1613 	u64 pf_taken;
1614 	u64 pf_fixed;
1615 	u64 pf_emulate;
1616 	u64 pf_spurious;
1617 	u64 pf_fast;
1618 	u64 pf_mmio_spte_created;
1619 	u64 pf_guest;
1620 	u64 tlb_flush;
1621 	u64 invlpg;
1622 
1623 	u64 exits;
1624 	u64 io_exits;
1625 	u64 mmio_exits;
1626 	u64 signal_exits;
1627 	u64 irq_window_exits;
1628 	u64 nmi_window_exits;
1629 	u64 l1d_flush;
1630 	u64 halt_exits;
1631 	u64 request_irq_exits;
1632 	u64 irq_exits;
1633 	u64 host_state_reload;
1634 	u64 fpu_reload;
1635 	u64 insn_emulation;
1636 	u64 insn_emulation_fail;
1637 	u64 hypercalls;
1638 	u64 irq_injections;
1639 	u64 nmi_injections;
1640 	u64 req_event;
1641 	u64 nested_run;
1642 	u64 directed_yield_attempted;
1643 	u64 directed_yield_successful;
1644 	u64 preemption_reported;
1645 	u64 preemption_other;
1646 	u64 guest_mode;
1647 	u64 notify_window_exits;
1648 };
1649 
1650 struct x86_instruction_info;
1651 
1652 struct msr_data {
1653 	bool host_initiated;
1654 	u32 index;
1655 	u64 data;
1656 };
1657 
1658 struct kvm_lapic_irq {
1659 	u32 vector;
1660 	u16 delivery_mode;
1661 	u16 dest_mode;
1662 	bool level;
1663 	u16 trig_mode;
1664 	u32 shorthand;
1665 	u32 dest_id;
1666 	bool msi_redir_hint;
1667 };
1668 
1669 static inline u16 kvm_lapic_irq_dest_mode(bool dest_mode_logical)
1670 {
1671 	return dest_mode_logical ? APIC_DEST_LOGICAL : APIC_DEST_PHYSICAL;
1672 }
1673 
1674 struct kvm_x86_ops {
1675 	const char *name;
1676 
1677 	int (*check_processor_compatibility)(void);
1678 
1679 	int (*enable_virtualization_cpu)(void);
1680 	void (*disable_virtualization_cpu)(void);
1681 	cpu_emergency_virt_cb *emergency_disable_virtualization_cpu;
1682 
1683 	void (*hardware_unsetup)(void);
1684 	bool (*has_emulated_msr)(struct kvm *kvm, u32 index);
1685 	void (*vcpu_after_set_cpuid)(struct kvm_vcpu *vcpu);
1686 
1687 	unsigned int vm_size;
1688 	int (*vm_init)(struct kvm *kvm);
1689 	void (*vm_destroy)(struct kvm *kvm);
1690 	void (*vm_pre_destroy)(struct kvm *kvm);
1691 
1692 	/* Create, but do not attach this VCPU */
1693 	int (*vcpu_precreate)(struct kvm *kvm);
1694 	int (*vcpu_create)(struct kvm_vcpu *vcpu);
1695 	void (*vcpu_free)(struct kvm_vcpu *vcpu);
1696 	void (*vcpu_reset)(struct kvm_vcpu *vcpu, bool init_event);
1697 
1698 	void (*prepare_switch_to_guest)(struct kvm_vcpu *vcpu);
1699 	void (*vcpu_load)(struct kvm_vcpu *vcpu, int cpu);
1700 	void (*vcpu_put)(struct kvm_vcpu *vcpu);
1701 
1702 	void (*update_exception_bitmap)(struct kvm_vcpu *vcpu);
1703 	int (*get_msr)(struct kvm_vcpu *vcpu, struct msr_data *msr);
1704 	int (*set_msr)(struct kvm_vcpu *vcpu, struct msr_data *msr);
1705 	u64 (*get_segment_base)(struct kvm_vcpu *vcpu, int seg);
1706 	void (*get_segment)(struct kvm_vcpu *vcpu,
1707 			    struct kvm_segment *var, int seg);
1708 	int (*get_cpl)(struct kvm_vcpu *vcpu);
1709 	int (*get_cpl_no_cache)(struct kvm_vcpu *vcpu);
1710 	void (*set_segment)(struct kvm_vcpu *vcpu,
1711 			    struct kvm_segment *var, int seg);
1712 	void (*get_cs_db_l_bits)(struct kvm_vcpu *vcpu, int *db, int *l);
1713 	bool (*is_valid_cr0)(struct kvm_vcpu *vcpu, unsigned long cr0);
1714 	void (*set_cr0)(struct kvm_vcpu *vcpu, unsigned long cr0);
1715 	void (*post_set_cr3)(struct kvm_vcpu *vcpu, unsigned long cr3);
1716 	bool (*is_valid_cr4)(struct kvm_vcpu *vcpu, unsigned long cr4);
1717 	void (*set_cr4)(struct kvm_vcpu *vcpu, unsigned long cr4);
1718 	int (*set_efer)(struct kvm_vcpu *vcpu, u64 efer);
1719 	void (*get_idt)(struct kvm_vcpu *vcpu, struct desc_ptr *dt);
1720 	void (*set_idt)(struct kvm_vcpu *vcpu, struct desc_ptr *dt);
1721 	void (*get_gdt)(struct kvm_vcpu *vcpu, struct desc_ptr *dt);
1722 	void (*set_gdt)(struct kvm_vcpu *vcpu, struct desc_ptr *dt);
1723 	void (*sync_dirty_debug_regs)(struct kvm_vcpu *vcpu);
1724 	void (*set_dr6)(struct kvm_vcpu *vcpu, unsigned long value);
1725 	void (*set_dr7)(struct kvm_vcpu *vcpu, unsigned long value);
1726 	void (*cache_reg)(struct kvm_vcpu *vcpu, enum kvm_reg reg);
1727 	unsigned long (*get_rflags)(struct kvm_vcpu *vcpu);
1728 	void (*set_rflags)(struct kvm_vcpu *vcpu, unsigned long rflags);
1729 	bool (*get_if_flag)(struct kvm_vcpu *vcpu);
1730 
1731 	void (*flush_tlb_all)(struct kvm_vcpu *vcpu);
1732 	void (*flush_tlb_current)(struct kvm_vcpu *vcpu);
1733 #if IS_ENABLED(CONFIG_HYPERV)
1734 	int  (*flush_remote_tlbs)(struct kvm *kvm);
1735 	int  (*flush_remote_tlbs_range)(struct kvm *kvm, gfn_t gfn,
1736 					gfn_t nr_pages);
1737 #endif
1738 
1739 	/*
1740 	 * Flush any TLB entries associated with the given GVA.
1741 	 * Does not need to flush GPA->HPA mappings.
1742 	 * Can potentially get non-canonical addresses through INVLPGs, which
1743 	 * the implementation may choose to ignore if appropriate.
1744 	 */
1745 	void (*flush_tlb_gva)(struct kvm_vcpu *vcpu, gva_t addr);
1746 
1747 	/*
1748 	 * Flush any TLB entries created by the guest.  Like tlb_flush_gva(),
1749 	 * does not need to flush GPA->HPA mappings.
1750 	 */
1751 	void (*flush_tlb_guest)(struct kvm_vcpu *vcpu);
1752 
1753 	int (*vcpu_pre_run)(struct kvm_vcpu *vcpu);
1754 	enum exit_fastpath_completion (*vcpu_run)(struct kvm_vcpu *vcpu,
1755 						  bool force_immediate_exit);
1756 	int (*handle_exit)(struct kvm_vcpu *vcpu,
1757 		enum exit_fastpath_completion exit_fastpath);
1758 	int (*skip_emulated_instruction)(struct kvm_vcpu *vcpu);
1759 	void (*update_emulated_instruction)(struct kvm_vcpu *vcpu);
1760 	void (*set_interrupt_shadow)(struct kvm_vcpu *vcpu, int mask);
1761 	u32 (*get_interrupt_shadow)(struct kvm_vcpu *vcpu);
1762 	void (*patch_hypercall)(struct kvm_vcpu *vcpu,
1763 				unsigned char *hypercall_addr);
1764 	void (*inject_irq)(struct kvm_vcpu *vcpu, bool reinjected);
1765 	void (*inject_nmi)(struct kvm_vcpu *vcpu);
1766 	void (*inject_exception)(struct kvm_vcpu *vcpu);
1767 	void (*cancel_injection)(struct kvm_vcpu *vcpu);
1768 	int (*interrupt_allowed)(struct kvm_vcpu *vcpu, bool for_injection);
1769 	int (*nmi_allowed)(struct kvm_vcpu *vcpu, bool for_injection);
1770 	bool (*get_nmi_mask)(struct kvm_vcpu *vcpu);
1771 	void (*set_nmi_mask)(struct kvm_vcpu *vcpu, bool masked);
1772 	/* Whether or not a virtual NMI is pending in hardware. */
1773 	bool (*is_vnmi_pending)(struct kvm_vcpu *vcpu);
1774 	/*
1775 	 * Attempt to pend a virtual NMI in hardware.  Returns %true on success
1776 	 * to allow using static_call_ret0 as the fallback.
1777 	 */
1778 	bool (*set_vnmi_pending)(struct kvm_vcpu *vcpu);
1779 	void (*enable_nmi_window)(struct kvm_vcpu *vcpu);
1780 	void (*enable_irq_window)(struct kvm_vcpu *vcpu);
1781 	void (*update_cr8_intercept)(struct kvm_vcpu *vcpu, int tpr, int irr);
1782 
1783 	const bool x2apic_icr_is_split;
1784 	const unsigned long required_apicv_inhibits;
1785 	bool allow_apicv_in_x2apic_without_x2apic_virtualization;
1786 	void (*refresh_apicv_exec_ctrl)(struct kvm_vcpu *vcpu);
1787 	void (*hwapic_isr_update)(struct kvm_vcpu *vcpu, int isr);
1788 	void (*load_eoi_exitmap)(struct kvm_vcpu *vcpu, u64 *eoi_exit_bitmap);
1789 	void (*set_virtual_apic_mode)(struct kvm_vcpu *vcpu);
1790 	void (*set_apic_access_page_addr)(struct kvm_vcpu *vcpu);
1791 	void (*deliver_interrupt)(struct kvm_lapic *apic, int delivery_mode,
1792 				  int trig_mode, int vector);
1793 	int (*sync_pir_to_irr)(struct kvm_vcpu *vcpu);
1794 	int (*set_tss_addr)(struct kvm *kvm, unsigned int addr);
1795 	int (*set_identity_map_addr)(struct kvm *kvm, u64 ident_addr);
1796 	u8 (*get_mt_mask)(struct kvm_vcpu *vcpu, gfn_t gfn, bool is_mmio);
1797 
1798 	void (*load_mmu_pgd)(struct kvm_vcpu *vcpu, hpa_t root_hpa,
1799 			     int root_level);
1800 
1801 	/* Update external mapping with page table link. */
1802 	int (*link_external_spt)(struct kvm *kvm, gfn_t gfn, enum pg_level level,
1803 				void *external_spt);
1804 	/* Update the external page table from spte getting set. */
1805 	int (*set_external_spte)(struct kvm *kvm, gfn_t gfn, enum pg_level level,
1806 				 kvm_pfn_t pfn_for_gfn);
1807 
1808 	/* Update external page tables for page table about to be freed. */
1809 	int (*free_external_spt)(struct kvm *kvm, gfn_t gfn, enum pg_level level,
1810 				 void *external_spt);
1811 
1812 	/* Update external page table from spte getting removed, and flush TLB. */
1813 	int (*remove_external_spte)(struct kvm *kvm, gfn_t gfn, enum pg_level level,
1814 				    kvm_pfn_t pfn_for_gfn);
1815 
1816 	bool (*has_wbinvd_exit)(void);
1817 
1818 	u64 (*get_l2_tsc_offset)(struct kvm_vcpu *vcpu);
1819 	u64 (*get_l2_tsc_multiplier)(struct kvm_vcpu *vcpu);
1820 	void (*write_tsc_offset)(struct kvm_vcpu *vcpu);
1821 	void (*write_tsc_multiplier)(struct kvm_vcpu *vcpu);
1822 
1823 	/*
1824 	 * Retrieve somewhat arbitrary exit/entry information.  Intended to
1825 	 * be used only from within tracepoints or error paths.
1826 	 */
1827 	void (*get_exit_info)(struct kvm_vcpu *vcpu, u32 *reason,
1828 			      u64 *info1, u64 *info2,
1829 			      u32 *intr_info, u32 *error_code);
1830 
1831 	void (*get_entry_info)(struct kvm_vcpu *vcpu,
1832 			       u32 *intr_info, u32 *error_code);
1833 
1834 	int (*check_intercept)(struct kvm_vcpu *vcpu,
1835 			       struct x86_instruction_info *info,
1836 			       enum x86_intercept_stage stage,
1837 			       struct x86_exception *exception);
1838 	void (*handle_exit_irqoff)(struct kvm_vcpu *vcpu);
1839 
1840 	void (*update_cpu_dirty_logging)(struct kvm_vcpu *vcpu);
1841 
1842 	const struct kvm_x86_nested_ops *nested_ops;
1843 
1844 	void (*vcpu_blocking)(struct kvm_vcpu *vcpu);
1845 	void (*vcpu_unblocking)(struct kvm_vcpu *vcpu);
1846 
1847 	int (*pi_update_irte)(struct kvm *kvm, unsigned int host_irq,
1848 			      uint32_t guest_irq, bool set);
1849 	void (*pi_start_assignment)(struct kvm *kvm);
1850 	void (*apicv_pre_state_restore)(struct kvm_vcpu *vcpu);
1851 	void (*apicv_post_state_restore)(struct kvm_vcpu *vcpu);
1852 	bool (*dy_apicv_has_pending_interrupt)(struct kvm_vcpu *vcpu);
1853 	bool (*protected_apic_has_interrupt)(struct kvm_vcpu *vcpu);
1854 
1855 	int (*set_hv_timer)(struct kvm_vcpu *vcpu, u64 guest_deadline_tsc,
1856 			    bool *expired);
1857 	void (*cancel_hv_timer)(struct kvm_vcpu *vcpu);
1858 
1859 	void (*setup_mce)(struct kvm_vcpu *vcpu);
1860 
1861 #ifdef CONFIG_KVM_SMM
1862 	int (*smi_allowed)(struct kvm_vcpu *vcpu, bool for_injection);
1863 	int (*enter_smm)(struct kvm_vcpu *vcpu, union kvm_smram *smram);
1864 	int (*leave_smm)(struct kvm_vcpu *vcpu, const union kvm_smram *smram);
1865 	void (*enable_smi_window)(struct kvm_vcpu *vcpu);
1866 #endif
1867 
1868 	int (*dev_get_attr)(u32 group, u64 attr, u64 *val);
1869 	int (*mem_enc_ioctl)(struct kvm *kvm, void __user *argp);
1870 	int (*vcpu_mem_enc_ioctl)(struct kvm_vcpu *vcpu, void __user *argp);
1871 	int (*mem_enc_register_region)(struct kvm *kvm, struct kvm_enc_region *argp);
1872 	int (*mem_enc_unregister_region)(struct kvm *kvm, struct kvm_enc_region *argp);
1873 	int (*vm_copy_enc_context_from)(struct kvm *kvm, unsigned int source_fd);
1874 	int (*vm_move_enc_context_from)(struct kvm *kvm, unsigned int source_fd);
1875 	void (*guest_memory_reclaimed)(struct kvm *kvm);
1876 
1877 	int (*get_feature_msr)(u32 msr, u64 *data);
1878 
1879 	int (*check_emulate_instruction)(struct kvm_vcpu *vcpu, int emul_type,
1880 					 void *insn, int insn_len);
1881 
1882 	bool (*apic_init_signal_blocked)(struct kvm_vcpu *vcpu);
1883 	int (*enable_l2_tlb_flush)(struct kvm_vcpu *vcpu);
1884 
1885 	void (*migrate_timers)(struct kvm_vcpu *vcpu);
1886 	void (*msr_filter_changed)(struct kvm_vcpu *vcpu);
1887 	int (*complete_emulated_msr)(struct kvm_vcpu *vcpu, int err);
1888 
1889 	void (*vcpu_deliver_sipi_vector)(struct kvm_vcpu *vcpu, u8 vector);
1890 
1891 	/*
1892 	 * Returns vCPU specific APICv inhibit reasons
1893 	 */
1894 	unsigned long (*vcpu_get_apicv_inhibit_reasons)(struct kvm_vcpu *vcpu);
1895 
1896 	gva_t (*get_untagged_addr)(struct kvm_vcpu *vcpu, gva_t gva, unsigned int flags);
1897 	void *(*alloc_apic_backing_page)(struct kvm_vcpu *vcpu);
1898 	int (*gmem_prepare)(struct kvm *kvm, kvm_pfn_t pfn, gfn_t gfn, int max_order);
1899 	void (*gmem_invalidate)(kvm_pfn_t start, kvm_pfn_t end);
1900 	int (*private_max_mapping_level)(struct kvm *kvm, kvm_pfn_t pfn);
1901 };
1902 
1903 struct kvm_x86_nested_ops {
1904 	void (*leave_nested)(struct kvm_vcpu *vcpu);
1905 	bool (*is_exception_vmexit)(struct kvm_vcpu *vcpu, u8 vector,
1906 				    u32 error_code);
1907 	int (*check_events)(struct kvm_vcpu *vcpu);
1908 	bool (*has_events)(struct kvm_vcpu *vcpu, bool for_injection);
1909 	void (*triple_fault)(struct kvm_vcpu *vcpu);
1910 	int (*get_state)(struct kvm_vcpu *vcpu,
1911 			 struct kvm_nested_state __user *user_kvm_nested_state,
1912 			 unsigned user_data_size);
1913 	int (*set_state)(struct kvm_vcpu *vcpu,
1914 			 struct kvm_nested_state __user *user_kvm_nested_state,
1915 			 struct kvm_nested_state *kvm_state);
1916 	bool (*get_nested_state_pages)(struct kvm_vcpu *vcpu);
1917 	int (*write_log_dirty)(struct kvm_vcpu *vcpu, gpa_t l2_gpa);
1918 
1919 	int (*enable_evmcs)(struct kvm_vcpu *vcpu,
1920 			    uint16_t *vmcs_version);
1921 	uint16_t (*get_evmcs_version)(struct kvm_vcpu *vcpu);
1922 	void (*hv_inject_synthetic_vmexit_post_tlb_flush)(struct kvm_vcpu *vcpu);
1923 };
1924 
1925 struct kvm_x86_init_ops {
1926 	int (*hardware_setup)(void);
1927 	unsigned int (*handle_intel_pt_intr)(void);
1928 
1929 	struct kvm_x86_ops *runtime_ops;
1930 	struct kvm_pmu_ops *pmu_ops;
1931 };
1932 
1933 struct kvm_arch_async_pf {
1934 	u32 token;
1935 	gfn_t gfn;
1936 	unsigned long cr3;
1937 	bool direct_map;
1938 	u64 error_code;
1939 };
1940 
1941 extern u32 __read_mostly kvm_nr_uret_msrs;
1942 extern bool __read_mostly allow_smaller_maxphyaddr;
1943 extern bool __read_mostly enable_apicv;
1944 extern struct kvm_x86_ops kvm_x86_ops;
1945 
1946 #define kvm_x86_call(func) static_call(kvm_x86_##func)
1947 #define kvm_pmu_call(func) static_call(kvm_x86_pmu_##func)
1948 
1949 #define KVM_X86_OP(func) \
1950 	DECLARE_STATIC_CALL(kvm_x86_##func, *(((struct kvm_x86_ops *)0)->func));
1951 #define KVM_X86_OP_OPTIONAL KVM_X86_OP
1952 #define KVM_X86_OP_OPTIONAL_RET0 KVM_X86_OP
1953 #include <asm/kvm-x86-ops.h>
1954 
1955 int kvm_x86_vendor_init(struct kvm_x86_init_ops *ops);
1956 void kvm_x86_vendor_exit(void);
1957 
1958 #define __KVM_HAVE_ARCH_VM_ALLOC
1959 static inline struct kvm *kvm_arch_alloc_vm(void)
1960 {
1961 	return __vmalloc(kvm_x86_ops.vm_size, GFP_KERNEL_ACCOUNT | __GFP_ZERO);
1962 }
1963 
1964 #define __KVM_HAVE_ARCH_VM_FREE
1965 void kvm_arch_free_vm(struct kvm *kvm);
1966 
1967 #if IS_ENABLED(CONFIG_HYPERV)
1968 #define __KVM_HAVE_ARCH_FLUSH_REMOTE_TLBS
1969 static inline int kvm_arch_flush_remote_tlbs(struct kvm *kvm)
1970 {
1971 	if (kvm_x86_ops.flush_remote_tlbs &&
1972 	    !kvm_x86_call(flush_remote_tlbs)(kvm))
1973 		return 0;
1974 	else
1975 		return -ENOTSUPP;
1976 }
1977 
1978 #define __KVM_HAVE_ARCH_FLUSH_REMOTE_TLBS_RANGE
1979 static inline int kvm_arch_flush_remote_tlbs_range(struct kvm *kvm, gfn_t gfn,
1980 						   u64 nr_pages)
1981 {
1982 	if (!kvm_x86_ops.flush_remote_tlbs_range)
1983 		return -EOPNOTSUPP;
1984 
1985 	return kvm_x86_call(flush_remote_tlbs_range)(kvm, gfn, nr_pages);
1986 }
1987 #endif /* CONFIG_HYPERV */
1988 
1989 enum kvm_intr_type {
1990 	/* Values are arbitrary, but must be non-zero. */
1991 	KVM_HANDLING_IRQ = 1,
1992 	KVM_HANDLING_NMI,
1993 };
1994 
1995 /* Enable perf NMI and timer modes to work, and minimise false positives. */
1996 #define kvm_arch_pmi_in_guest(vcpu) \
1997 	((vcpu) && (vcpu)->arch.handling_intr_from_guest && \
1998 	 (!!in_nmi() == ((vcpu)->arch.handling_intr_from_guest == KVM_HANDLING_NMI)))
1999 
2000 void __init kvm_mmu_x86_module_init(void);
2001 int kvm_mmu_vendor_module_init(void);
2002 void kvm_mmu_vendor_module_exit(void);
2003 
2004 void kvm_mmu_destroy(struct kvm_vcpu *vcpu);
2005 int kvm_mmu_create(struct kvm_vcpu *vcpu);
2006 void kvm_mmu_init_vm(struct kvm *kvm);
2007 void kvm_mmu_uninit_vm(struct kvm *kvm);
2008 
2009 void kvm_mmu_init_memslot_memory_attributes(struct kvm *kvm,
2010 					    struct kvm_memory_slot *slot);
2011 
2012 void kvm_mmu_after_set_cpuid(struct kvm_vcpu *vcpu);
2013 void kvm_mmu_reset_context(struct kvm_vcpu *vcpu);
2014 void kvm_mmu_slot_remove_write_access(struct kvm *kvm,
2015 				      const struct kvm_memory_slot *memslot,
2016 				      int start_level);
2017 void kvm_mmu_slot_try_split_huge_pages(struct kvm *kvm,
2018 				       const struct kvm_memory_slot *memslot,
2019 				       int target_level);
2020 void kvm_mmu_try_split_huge_pages(struct kvm *kvm,
2021 				  const struct kvm_memory_slot *memslot,
2022 				  u64 start, u64 end,
2023 				  int target_level);
2024 void kvm_mmu_recover_huge_pages(struct kvm *kvm,
2025 				const struct kvm_memory_slot *memslot);
2026 void kvm_mmu_slot_leaf_clear_dirty(struct kvm *kvm,
2027 				   const struct kvm_memory_slot *memslot);
2028 void kvm_mmu_invalidate_mmio_sptes(struct kvm *kvm, u64 gen);
2029 void kvm_mmu_change_mmu_pages(struct kvm *kvm, unsigned long kvm_nr_mmu_pages);
2030 void kvm_zap_gfn_range(struct kvm *kvm, gfn_t gfn_start, gfn_t gfn_end);
2031 
2032 int load_pdptrs(struct kvm_vcpu *vcpu, unsigned long cr3);
2033 
2034 int emulator_write_phys(struct kvm_vcpu *vcpu, gpa_t gpa,
2035 			  const void *val, int bytes);
2036 
2037 struct kvm_irq_mask_notifier {
2038 	void (*func)(struct kvm_irq_mask_notifier *kimn, bool masked);
2039 	int irq;
2040 	struct hlist_node link;
2041 };
2042 
2043 void kvm_register_irq_mask_notifier(struct kvm *kvm, int irq,
2044 				    struct kvm_irq_mask_notifier *kimn);
2045 void kvm_unregister_irq_mask_notifier(struct kvm *kvm, int irq,
2046 				      struct kvm_irq_mask_notifier *kimn);
2047 void kvm_fire_mask_notifiers(struct kvm *kvm, unsigned irqchip, unsigned pin,
2048 			     bool mask);
2049 
2050 extern bool tdp_enabled;
2051 
2052 u64 vcpu_tsc_khz(struct kvm_vcpu *vcpu);
2053 
2054 /*
2055  * EMULTYPE_NO_DECODE - Set when re-emulating an instruction (after completing
2056  *			userspace I/O) to indicate that the emulation context
2057  *			should be reused as is, i.e. skip initialization of
2058  *			emulation context, instruction fetch and decode.
2059  *
2060  * EMULTYPE_TRAP_UD - Set when emulating an intercepted #UD from hardware.
2061  *		      Indicates that only select instructions (tagged with
2062  *		      EmulateOnUD) should be emulated (to minimize the emulator
2063  *		      attack surface).  See also EMULTYPE_TRAP_UD_FORCED.
2064  *
2065  * EMULTYPE_SKIP - Set when emulating solely to skip an instruction, i.e. to
2066  *		   decode the instruction length.  For use *only* by
2067  *		   kvm_x86_ops.skip_emulated_instruction() implementations if
2068  *		   EMULTYPE_COMPLETE_USER_EXIT is not set.
2069  *
2070  * EMULTYPE_ALLOW_RETRY_PF - Set when the emulator should resume the guest to
2071  *			     retry native execution under certain conditions,
2072  *			     Can only be set in conjunction with EMULTYPE_PF.
2073  *
2074  * EMULTYPE_TRAP_UD_FORCED - Set when emulating an intercepted #UD that was
2075  *			     triggered by KVM's magic "force emulation" prefix,
2076  *			     which is opt in via module param (off by default).
2077  *			     Bypasses EmulateOnUD restriction despite emulating
2078  *			     due to an intercepted #UD (see EMULTYPE_TRAP_UD).
2079  *			     Used to test the full emulator from userspace.
2080  *
2081  * EMULTYPE_VMWARE_GP - Set when emulating an intercepted #GP for VMware
2082  *			backdoor emulation, which is opt in via module param.
2083  *			VMware backdoor emulation handles select instructions
2084  *			and reinjects the #GP for all other cases.
2085  *
2086  * EMULTYPE_PF - Set when an intercepted #PF triggers the emulation, in which case
2087  *		 the CR2/GPA value pass on the stack is valid.
2088  *
2089  * EMULTYPE_COMPLETE_USER_EXIT - Set when the emulator should update interruptibility
2090  *				 state and inject single-step #DBs after skipping
2091  *				 an instruction (after completing userspace I/O).
2092  *
2093  * EMULTYPE_WRITE_PF_TO_SP - Set when emulating an intercepted page fault that
2094  *			     is attempting to write a gfn that contains one or
2095  *			     more of the PTEs used to translate the write itself,
2096  *			     and the owning page table is being shadowed by KVM.
2097  *			     If emulation of the faulting instruction fails and
2098  *			     this flag is set, KVM will exit to userspace instead
2099  *			     of retrying emulation as KVM cannot make forward
2100  *			     progress.
2101  *
2102  *			     If emulation fails for a write to guest page tables,
2103  *			     KVM unprotects (zaps) the shadow page for the target
2104  *			     gfn and resumes the guest to retry the non-emulatable
2105  *			     instruction (on hardware).  Unprotecting the gfn
2106  *			     doesn't allow forward progress for a self-changing
2107  *			     access because doing so also zaps the translation for
2108  *			     the gfn, i.e. retrying the instruction will hit a
2109  *			     !PRESENT fault, which results in a new shadow page
2110  *			     and sends KVM back to square one.
2111  */
2112 #define EMULTYPE_NO_DECODE	    (1 << 0)
2113 #define EMULTYPE_TRAP_UD	    (1 << 1)
2114 #define EMULTYPE_SKIP		    (1 << 2)
2115 #define EMULTYPE_ALLOW_RETRY_PF	    (1 << 3)
2116 #define EMULTYPE_TRAP_UD_FORCED	    (1 << 4)
2117 #define EMULTYPE_VMWARE_GP	    (1 << 5)
2118 #define EMULTYPE_PF		    (1 << 6)
2119 #define EMULTYPE_COMPLETE_USER_EXIT (1 << 7)
2120 #define EMULTYPE_WRITE_PF_TO_SP	    (1 << 8)
2121 
2122 static inline bool kvm_can_emulate_event_vectoring(int emul_type)
2123 {
2124 	return !(emul_type & EMULTYPE_PF);
2125 }
2126 
2127 int kvm_emulate_instruction(struct kvm_vcpu *vcpu, int emulation_type);
2128 int kvm_emulate_instruction_from_buffer(struct kvm_vcpu *vcpu,
2129 					void *insn, int insn_len);
2130 void __kvm_prepare_emulation_failure_exit(struct kvm_vcpu *vcpu,
2131 					  u64 *data, u8 ndata);
2132 void kvm_prepare_emulation_failure_exit(struct kvm_vcpu *vcpu);
2133 
2134 void kvm_prepare_event_vectoring_exit(struct kvm_vcpu *vcpu, gpa_t gpa);
2135 
2136 void kvm_enable_efer_bits(u64);
2137 bool kvm_valid_efer(struct kvm_vcpu *vcpu, u64 efer);
2138 int kvm_get_msr_with_filter(struct kvm_vcpu *vcpu, u32 index, u64 *data);
2139 int kvm_set_msr_with_filter(struct kvm_vcpu *vcpu, u32 index, u64 data);
2140 int __kvm_get_msr(struct kvm_vcpu *vcpu, u32 index, u64 *data, bool host_initiated);
2141 int kvm_get_msr(struct kvm_vcpu *vcpu, u32 index, u64 *data);
2142 int kvm_set_msr(struct kvm_vcpu *vcpu, u32 index, u64 data);
2143 int kvm_emulate_rdmsr(struct kvm_vcpu *vcpu);
2144 int kvm_emulate_wrmsr(struct kvm_vcpu *vcpu);
2145 int kvm_emulate_as_nop(struct kvm_vcpu *vcpu);
2146 int kvm_emulate_invd(struct kvm_vcpu *vcpu);
2147 int kvm_emulate_mwait(struct kvm_vcpu *vcpu);
2148 int kvm_handle_invalid_op(struct kvm_vcpu *vcpu);
2149 int kvm_emulate_monitor(struct kvm_vcpu *vcpu);
2150 
2151 int kvm_fast_pio(struct kvm_vcpu *vcpu, int size, unsigned short port, int in);
2152 int kvm_emulate_cpuid(struct kvm_vcpu *vcpu);
2153 int kvm_emulate_halt(struct kvm_vcpu *vcpu);
2154 int kvm_emulate_halt_noskip(struct kvm_vcpu *vcpu);
2155 int kvm_emulate_ap_reset_hold(struct kvm_vcpu *vcpu);
2156 int kvm_emulate_wbinvd(struct kvm_vcpu *vcpu);
2157 
2158 void kvm_get_segment(struct kvm_vcpu *vcpu, struct kvm_segment *var, int seg);
2159 void kvm_set_segment(struct kvm_vcpu *vcpu, struct kvm_segment *var, int seg);
2160 int kvm_load_segment_descriptor(struct kvm_vcpu *vcpu, u16 selector, int seg);
2161 void kvm_vcpu_deliver_sipi_vector(struct kvm_vcpu *vcpu, u8 vector);
2162 
2163 int kvm_task_switch(struct kvm_vcpu *vcpu, u16 tss_selector, int idt_index,
2164 		    int reason, bool has_error_code, u32 error_code);
2165 
2166 void kvm_post_set_cr0(struct kvm_vcpu *vcpu, unsigned long old_cr0, unsigned long cr0);
2167 void kvm_post_set_cr4(struct kvm_vcpu *vcpu, unsigned long old_cr4, unsigned long cr4);
2168 int kvm_set_cr0(struct kvm_vcpu *vcpu, unsigned long cr0);
2169 int kvm_set_cr3(struct kvm_vcpu *vcpu, unsigned long cr3);
2170 int kvm_set_cr4(struct kvm_vcpu *vcpu, unsigned long cr4);
2171 int kvm_set_cr8(struct kvm_vcpu *vcpu, unsigned long cr8);
2172 int kvm_set_dr(struct kvm_vcpu *vcpu, int dr, unsigned long val);
2173 unsigned long kvm_get_dr(struct kvm_vcpu *vcpu, int dr);
2174 unsigned long kvm_get_cr8(struct kvm_vcpu *vcpu);
2175 void kvm_lmsw(struct kvm_vcpu *vcpu, unsigned long msw);
2176 int kvm_emulate_xsetbv(struct kvm_vcpu *vcpu);
2177 
2178 int kvm_get_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr);
2179 int kvm_set_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr);
2180 
2181 unsigned long kvm_get_rflags(struct kvm_vcpu *vcpu);
2182 void kvm_set_rflags(struct kvm_vcpu *vcpu, unsigned long rflags);
2183 int kvm_emulate_rdpmc(struct kvm_vcpu *vcpu);
2184 
2185 void kvm_queue_exception(struct kvm_vcpu *vcpu, unsigned nr);
2186 void kvm_queue_exception_e(struct kvm_vcpu *vcpu, unsigned nr, u32 error_code);
2187 void kvm_queue_exception_p(struct kvm_vcpu *vcpu, unsigned nr, unsigned long payload);
2188 void kvm_requeue_exception(struct kvm_vcpu *vcpu, unsigned int nr,
2189 			   bool has_error_code, u32 error_code);
2190 void kvm_inject_page_fault(struct kvm_vcpu *vcpu, struct x86_exception *fault);
2191 void kvm_inject_emulated_page_fault(struct kvm_vcpu *vcpu,
2192 				    struct x86_exception *fault);
2193 bool kvm_require_cpl(struct kvm_vcpu *vcpu, int required_cpl);
2194 bool kvm_require_dr(struct kvm_vcpu *vcpu, int dr);
2195 
2196 static inline int __kvm_irq_line_state(unsigned long *irq_state,
2197 				       int irq_source_id, int level)
2198 {
2199 	/* Logical OR for level trig interrupt */
2200 	if (level)
2201 		__set_bit(irq_source_id, irq_state);
2202 	else
2203 		__clear_bit(irq_source_id, irq_state);
2204 
2205 	return !!(*irq_state);
2206 }
2207 
2208 int kvm_pic_set_irq(struct kvm_pic *pic, int irq, int irq_source_id, int level);
2209 void kvm_pic_clear_all(struct kvm_pic *pic, int irq_source_id);
2210 
2211 void kvm_inject_nmi(struct kvm_vcpu *vcpu);
2212 int kvm_get_nr_pending_nmis(struct kvm_vcpu *vcpu);
2213 
2214 void kvm_update_dr7(struct kvm_vcpu *vcpu);
2215 
2216 bool __kvm_mmu_unprotect_gfn_and_retry(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
2217 				       bool always_retry);
2218 
2219 static inline bool kvm_mmu_unprotect_gfn_and_retry(struct kvm_vcpu *vcpu,
2220 						   gpa_t cr2_or_gpa)
2221 {
2222 	return __kvm_mmu_unprotect_gfn_and_retry(vcpu, cr2_or_gpa, false);
2223 }
2224 
2225 void kvm_mmu_free_roots(struct kvm *kvm, struct kvm_mmu *mmu,
2226 			ulong roots_to_free);
2227 void kvm_mmu_free_guest_mode_roots(struct kvm *kvm, struct kvm_mmu *mmu);
2228 gpa_t kvm_mmu_gva_to_gpa_read(struct kvm_vcpu *vcpu, gva_t gva,
2229 			      struct x86_exception *exception);
2230 gpa_t kvm_mmu_gva_to_gpa_write(struct kvm_vcpu *vcpu, gva_t gva,
2231 			       struct x86_exception *exception);
2232 gpa_t kvm_mmu_gva_to_gpa_system(struct kvm_vcpu *vcpu, gva_t gva,
2233 				struct x86_exception *exception);
2234 
2235 bool kvm_apicv_activated(struct kvm *kvm);
2236 bool kvm_vcpu_apicv_activated(struct kvm_vcpu *vcpu);
2237 void __kvm_vcpu_update_apicv(struct kvm_vcpu *vcpu);
2238 void __kvm_set_or_clear_apicv_inhibit(struct kvm *kvm,
2239 				      enum kvm_apicv_inhibit reason, bool set);
2240 void kvm_set_or_clear_apicv_inhibit(struct kvm *kvm,
2241 				    enum kvm_apicv_inhibit reason, bool set);
2242 
2243 static inline void kvm_set_apicv_inhibit(struct kvm *kvm,
2244 					 enum kvm_apicv_inhibit reason)
2245 {
2246 	kvm_set_or_clear_apicv_inhibit(kvm, reason, true);
2247 }
2248 
2249 static inline void kvm_clear_apicv_inhibit(struct kvm *kvm,
2250 					   enum kvm_apicv_inhibit reason)
2251 {
2252 	kvm_set_or_clear_apicv_inhibit(kvm, reason, false);
2253 }
2254 
2255 int kvm_mmu_page_fault(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa, u64 error_code,
2256 		       void *insn, int insn_len);
2257 void kvm_mmu_print_sptes(struct kvm_vcpu *vcpu, gpa_t gpa, const char *msg);
2258 void kvm_mmu_invlpg(struct kvm_vcpu *vcpu, gva_t gva);
2259 void kvm_mmu_invalidate_addr(struct kvm_vcpu *vcpu, struct kvm_mmu *mmu,
2260 			     u64 addr, unsigned long roots);
2261 void kvm_mmu_invpcid_gva(struct kvm_vcpu *vcpu, gva_t gva, unsigned long pcid);
2262 void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd);
2263 
2264 void kvm_configure_mmu(bool enable_tdp, int tdp_forced_root_level,
2265 		       int tdp_max_root_level, int tdp_huge_page_level);
2266 
2267 
2268 #ifdef CONFIG_KVM_PRIVATE_MEM
2269 #define kvm_arch_has_private_mem(kvm) ((kvm)->arch.has_private_mem)
2270 #else
2271 #define kvm_arch_has_private_mem(kvm) false
2272 #endif
2273 
2274 #define kvm_arch_has_readonly_mem(kvm) (!(kvm)->arch.has_protected_state)
2275 
2276 static inline u16 kvm_read_ldt(void)
2277 {
2278 	u16 ldt;
2279 	asm("sldt %0" : "=g"(ldt));
2280 	return ldt;
2281 }
2282 
2283 static inline void kvm_load_ldt(u16 sel)
2284 {
2285 	asm("lldt %0" : : "rm"(sel));
2286 }
2287 
2288 #ifdef CONFIG_X86_64
2289 static inline unsigned long read_msr(unsigned long msr)
2290 {
2291 	u64 value;
2292 
2293 	rdmsrl(msr, value);
2294 	return value;
2295 }
2296 #endif
2297 
2298 static inline void kvm_inject_gp(struct kvm_vcpu *vcpu, u32 error_code)
2299 {
2300 	kvm_queue_exception_e(vcpu, GP_VECTOR, error_code);
2301 }
2302 
2303 #define TSS_IOPB_BASE_OFFSET 0x66
2304 #define TSS_BASE_SIZE 0x68
2305 #define TSS_IOPB_SIZE (65536 / 8)
2306 #define TSS_REDIRECTION_SIZE (256 / 8)
2307 #define RMODE_TSS_SIZE							\
2308 	(TSS_BASE_SIZE + TSS_REDIRECTION_SIZE + TSS_IOPB_SIZE + 1)
2309 
2310 enum {
2311 	TASK_SWITCH_CALL = 0,
2312 	TASK_SWITCH_IRET = 1,
2313 	TASK_SWITCH_JMP = 2,
2314 	TASK_SWITCH_GATE = 3,
2315 };
2316 
2317 #define HF_GUEST_MASK		(1 << 0) /* VCPU is in guest-mode */
2318 
2319 #ifdef CONFIG_KVM_SMM
2320 #define HF_SMM_MASK		(1 << 1)
2321 #define HF_SMM_INSIDE_NMI_MASK	(1 << 2)
2322 
2323 # define KVM_MAX_NR_ADDRESS_SPACES	2
2324 /* SMM is currently unsupported for guests with private memory. */
2325 # define kvm_arch_nr_memslot_as_ids(kvm) (kvm_arch_has_private_mem(kvm) ? 1 : 2)
2326 # define kvm_arch_vcpu_memslots_id(vcpu) ((vcpu)->arch.hflags & HF_SMM_MASK ? 1 : 0)
2327 # define kvm_memslots_for_spte_role(kvm, role) __kvm_memslots(kvm, (role).smm)
2328 #else
2329 # define kvm_memslots_for_spte_role(kvm, role) __kvm_memslots(kvm, 0)
2330 #endif
2331 
2332 int kvm_cpu_has_injectable_intr(struct kvm_vcpu *v);
2333 int kvm_cpu_has_interrupt(struct kvm_vcpu *vcpu);
2334 int kvm_cpu_has_extint(struct kvm_vcpu *v);
2335 int kvm_arch_interrupt_allowed(struct kvm_vcpu *vcpu);
2336 int kvm_cpu_get_extint(struct kvm_vcpu *v);
2337 int kvm_cpu_get_interrupt(struct kvm_vcpu *v);
2338 void kvm_vcpu_reset(struct kvm_vcpu *vcpu, bool init_event);
2339 
2340 int kvm_pv_send_ipi(struct kvm *kvm, unsigned long ipi_bitmap_low,
2341 		    unsigned long ipi_bitmap_high, u32 min,
2342 		    unsigned long icr, int op_64_bit);
2343 
2344 int kvm_add_user_return_msr(u32 msr);
2345 int kvm_find_user_return_msr(u32 msr);
2346 int kvm_set_user_return_msr(unsigned index, u64 val, u64 mask);
2347 void kvm_user_return_msr_update_cache(unsigned int index, u64 val);
2348 
2349 static inline bool kvm_is_supported_user_return_msr(u32 msr)
2350 {
2351 	return kvm_find_user_return_msr(msr) >= 0;
2352 }
2353 
2354 u64 kvm_scale_tsc(u64 tsc, u64 ratio);
2355 u64 kvm_read_l1_tsc(struct kvm_vcpu *vcpu, u64 host_tsc);
2356 u64 kvm_calc_nested_tsc_offset(u64 l1_offset, u64 l2_offset, u64 l2_multiplier);
2357 u64 kvm_calc_nested_tsc_multiplier(u64 l1_multiplier, u64 l2_multiplier);
2358 
2359 unsigned long kvm_get_linear_rip(struct kvm_vcpu *vcpu);
2360 bool kvm_is_linear_rip(struct kvm_vcpu *vcpu, unsigned long linear_rip);
2361 
2362 void kvm_make_scan_ioapic_request(struct kvm *kvm);
2363 void kvm_make_scan_ioapic_request_mask(struct kvm *kvm,
2364 				       unsigned long *vcpu_bitmap);
2365 
2366 bool kvm_arch_async_page_not_present(struct kvm_vcpu *vcpu,
2367 				     struct kvm_async_pf *work);
2368 void kvm_arch_async_page_present(struct kvm_vcpu *vcpu,
2369 				 struct kvm_async_pf *work);
2370 void kvm_arch_async_page_ready(struct kvm_vcpu *vcpu,
2371 			       struct kvm_async_pf *work);
2372 void kvm_arch_async_page_present_queued(struct kvm_vcpu *vcpu);
2373 bool kvm_arch_can_dequeue_async_page_present(struct kvm_vcpu *vcpu);
2374 extern bool kvm_find_async_pf_gfn(struct kvm_vcpu *vcpu, gfn_t gfn);
2375 
2376 int kvm_skip_emulated_instruction(struct kvm_vcpu *vcpu);
2377 int kvm_complete_insn_gp(struct kvm_vcpu *vcpu, int err);
2378 
2379 void __user *__x86_set_memory_region(struct kvm *kvm, int id, gpa_t gpa,
2380 				     u32 size);
2381 bool kvm_vcpu_is_reset_bsp(struct kvm_vcpu *vcpu);
2382 bool kvm_vcpu_is_bsp(struct kvm_vcpu *vcpu);
2383 
2384 bool kvm_intr_is_single_vcpu(struct kvm *kvm, struct kvm_lapic_irq *irq,
2385 			     struct kvm_vcpu **dest_vcpu);
2386 
2387 void kvm_set_msi_irq(struct kvm *kvm, struct kvm_kernel_irq_routing_entry *e,
2388 		     struct kvm_lapic_irq *irq);
2389 
2390 static inline bool kvm_irq_is_postable(struct kvm_lapic_irq *irq)
2391 {
2392 	/* We can only post Fixed and LowPrio IRQs */
2393 	return (irq->delivery_mode == APIC_DM_FIXED ||
2394 		irq->delivery_mode == APIC_DM_LOWEST);
2395 }
2396 
2397 static inline void kvm_arch_vcpu_blocking(struct kvm_vcpu *vcpu)
2398 {
2399 	kvm_x86_call(vcpu_blocking)(vcpu);
2400 }
2401 
2402 static inline void kvm_arch_vcpu_unblocking(struct kvm_vcpu *vcpu)
2403 {
2404 	kvm_x86_call(vcpu_unblocking)(vcpu);
2405 }
2406 
2407 static inline int kvm_cpu_get_apicid(int mps_cpu)
2408 {
2409 #ifdef CONFIG_X86_LOCAL_APIC
2410 	return default_cpu_present_to_apicid(mps_cpu);
2411 #else
2412 	WARN_ON_ONCE(1);
2413 	return BAD_APICID;
2414 #endif
2415 }
2416 
2417 int memslot_rmap_alloc(struct kvm_memory_slot *slot, unsigned long npages);
2418 
2419 #define KVM_CLOCK_VALID_FLAGS						\
2420 	(KVM_CLOCK_TSC_STABLE | KVM_CLOCK_REALTIME | KVM_CLOCK_HOST_TSC)
2421 
2422 #define KVM_X86_VALID_QUIRKS			\
2423 	(KVM_X86_QUIRK_LINT0_REENABLED |	\
2424 	 KVM_X86_QUIRK_CD_NW_CLEARED |		\
2425 	 KVM_X86_QUIRK_LAPIC_MMIO_HOLE |	\
2426 	 KVM_X86_QUIRK_OUT_7E_INC_RIP |		\
2427 	 KVM_X86_QUIRK_MISC_ENABLE_NO_MWAIT |	\
2428 	 KVM_X86_QUIRK_FIX_HYPERCALL_INSN |	\
2429 	 KVM_X86_QUIRK_MWAIT_NEVER_UD_FAULTS |	\
2430 	 KVM_X86_QUIRK_SLOT_ZAP_ALL |		\
2431 	 KVM_X86_QUIRK_STUFF_FEATURE_MSRS |	\
2432 	 KVM_X86_QUIRK_IGNORE_GUEST_PAT)
2433 
2434 #define KVM_X86_CONDITIONAL_QUIRKS		\
2435 	(KVM_X86_QUIRK_CD_NW_CLEARED |		\
2436 	 KVM_X86_QUIRK_IGNORE_GUEST_PAT)
2437 
2438 /*
2439  * KVM previously used a u32 field in kvm_run to indicate the hypercall was
2440  * initiated from long mode. KVM now sets bit 0 to indicate long mode, but the
2441  * remaining 31 lower bits must be 0 to preserve ABI.
2442  */
2443 #define KVM_EXIT_HYPERCALL_MBZ		GENMASK_ULL(31, 1)
2444 
2445 static inline bool kvm_arch_has_irq_bypass(void)
2446 {
2447 	return enable_apicv && irq_remapping_cap(IRQ_POSTING_CAP);
2448 }
2449 
2450 #endif /* _ASM_X86_KVM_HOST_H */
2451