xref: /openbmc/qemu/linux-headers/asm-x86/kvm.h (revision 050b3d3630051fc4637d6c5078033680ec7c5f5e)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _ASM_X86_KVM_H
3 #define _ASM_X86_KVM_H
4 
5 /*
6  * KVM x86 specific structures and definitions
7  *
8  */
9 
10 #include <linux/const.h>
11 #include <linux/bits.h>
12 #include <linux/types.h>
13 #include <linux/ioctl.h>
14 #include <linux/stddef.h>
15 
16 #define KVM_PIO_PAGE_OFFSET 1
17 #define KVM_COALESCED_MMIO_PAGE_OFFSET 2
18 #define KVM_DIRTY_LOG_PAGE_OFFSET 64
19 
20 #define DE_VECTOR 0
21 #define DB_VECTOR 1
22 #define BP_VECTOR 3
23 #define OF_VECTOR 4
24 #define BR_VECTOR 5
25 #define UD_VECTOR 6
26 #define NM_VECTOR 7
27 #define DF_VECTOR 8
28 #define TS_VECTOR 10
29 #define NP_VECTOR 11
30 #define SS_VECTOR 12
31 #define GP_VECTOR 13
32 #define PF_VECTOR 14
33 #define MF_VECTOR 16
34 #define AC_VECTOR 17
35 #define MC_VECTOR 18
36 #define XM_VECTOR 19
37 #define VE_VECTOR 20
38 #define CP_VECTOR 21
39 
40 #define HV_VECTOR 28
41 #define VC_VECTOR 29
42 #define SX_VECTOR 30
43 
44 /* Select x86 specific features in <linux/kvm.h> */
45 #define __KVM_HAVE_PIT
46 #define __KVM_HAVE_IOAPIC
47 #define __KVM_HAVE_IRQ_LINE
48 #define __KVM_HAVE_MSI
49 #define __KVM_HAVE_USER_NMI
50 #define __KVM_HAVE_MSIX
51 #define __KVM_HAVE_MCE
52 #define __KVM_HAVE_PIT_STATE2
53 #define __KVM_HAVE_XEN_HVM
54 #define __KVM_HAVE_VCPU_EVENTS
55 #define __KVM_HAVE_DEBUGREGS
56 #define __KVM_HAVE_XSAVE
57 #define __KVM_HAVE_XCRS
58 
59 /* Architectural interrupt line count. */
60 #define KVM_NR_INTERRUPTS 256
61 
62 /* for KVM_GET_IRQCHIP and KVM_SET_IRQCHIP */
63 struct kvm_pic_state {
64 	__u8 last_irr;	/* edge detection */
65 	__u8 irr;		/* interrupt request register */
66 	__u8 imr;		/* interrupt mask register */
67 	__u8 isr;		/* interrupt service register */
68 	__u8 priority_add;	/* highest irq priority */
69 	__u8 irq_base;
70 	__u8 read_reg_select;
71 	__u8 poll;
72 	__u8 special_mask;
73 	__u8 init_state;
74 	__u8 auto_eoi;
75 	__u8 rotate_on_auto_eoi;
76 	__u8 special_fully_nested_mode;
77 	__u8 init4;		/* true if 4 byte init */
78 	__u8 elcr;		/* PIIX edge/trigger selection */
79 	__u8 elcr_mask;
80 };
81 
82 #define KVM_IOAPIC_NUM_PINS  24
83 struct kvm_ioapic_state {
84 	__u64 base_address;
85 	__u32 ioregsel;
86 	__u32 id;
87 	__u32 irr;
88 	__u32 pad;
89 	union {
90 		__u64 bits;
91 		struct {
92 			__u8 vector;
93 			__u8 delivery_mode:3;
94 			__u8 dest_mode:1;
95 			__u8 delivery_status:1;
96 			__u8 polarity:1;
97 			__u8 remote_irr:1;
98 			__u8 trig_mode:1;
99 			__u8 mask:1;
100 			__u8 reserve:7;
101 			__u8 reserved[4];
102 			__u8 dest_id;
103 		} fields;
104 	} redirtbl[KVM_IOAPIC_NUM_PINS];
105 };
106 
107 #define KVM_IRQCHIP_PIC_MASTER   0
108 #define KVM_IRQCHIP_PIC_SLAVE    1
109 #define KVM_IRQCHIP_IOAPIC       2
110 #define KVM_NR_IRQCHIPS          3
111 
112 #define KVM_RUN_X86_SMM		 (1 << 0)
113 #define KVM_RUN_X86_BUS_LOCK     (1 << 1)
114 #define KVM_RUN_X86_GUEST_MODE   (1 << 2)
115 
116 /* for KVM_GET_REGS and KVM_SET_REGS */
117 struct kvm_regs {
118 	/* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
119 	__u64 rax, rbx, rcx, rdx;
120 	__u64 rsi, rdi, rsp, rbp;
121 	__u64 r8,  r9,  r10, r11;
122 	__u64 r12, r13, r14, r15;
123 	__u64 rip, rflags;
124 };
125 
126 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
127 #define KVM_APIC_REG_SIZE 0x400
128 struct kvm_lapic_state {
129 	char regs[KVM_APIC_REG_SIZE];
130 };
131 
132 struct kvm_segment {
133 	__u64 base;
134 	__u32 limit;
135 	__u16 selector;
136 	__u8  type;
137 	__u8  present, dpl, db, s, l, g, avl;
138 	__u8  unusable;
139 	__u8  padding;
140 };
141 
142 struct kvm_dtable {
143 	__u64 base;
144 	__u16 limit;
145 	__u16 padding[3];
146 };
147 
148 
149 /* for KVM_GET_SREGS and KVM_SET_SREGS */
150 struct kvm_sregs {
151 	/* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
152 	struct kvm_segment cs, ds, es, fs, gs, ss;
153 	struct kvm_segment tr, ldt;
154 	struct kvm_dtable gdt, idt;
155 	__u64 cr0, cr2, cr3, cr4, cr8;
156 	__u64 efer;
157 	__u64 apic_base;
158 	__u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
159 };
160 
161 struct kvm_sregs2 {
162 	/* out (KVM_GET_SREGS2) / in (KVM_SET_SREGS2) */
163 	struct kvm_segment cs, ds, es, fs, gs, ss;
164 	struct kvm_segment tr, ldt;
165 	struct kvm_dtable gdt, idt;
166 	__u64 cr0, cr2, cr3, cr4, cr8;
167 	__u64 efer;
168 	__u64 apic_base;
169 	__u64 flags;
170 	__u64 pdptrs[4];
171 };
172 #define KVM_SREGS2_FLAGS_PDPTRS_VALID 1
173 
174 /* for KVM_GET_FPU and KVM_SET_FPU */
175 struct kvm_fpu {
176 	__u8  fpr[8][16];
177 	__u16 fcw;
178 	__u16 fsw;
179 	__u8  ftwx;  /* in fxsave format */
180 	__u8  pad1;
181 	__u16 last_opcode;
182 	__u64 last_ip;
183 	__u64 last_dp;
184 	__u8  xmm[16][16];
185 	__u32 mxcsr;
186 	__u32 pad2;
187 };
188 
189 struct kvm_msr_entry {
190 	__u32 index;
191 	__u32 reserved;
192 	__u64 data;
193 };
194 
195 /* for KVM_GET_MSRS and KVM_SET_MSRS */
196 struct kvm_msrs {
197 	__u32 nmsrs; /* number of msrs in entries */
198 	__u32 pad;
199 
200 	struct kvm_msr_entry entries[];
201 };
202 
203 /* for KVM_GET_MSR_INDEX_LIST */
204 struct kvm_msr_list {
205 	__u32 nmsrs; /* number of msrs in entries */
206 	__u32 indices[];
207 };
208 
209 /* Maximum size of any access bitmap in bytes */
210 #define KVM_MSR_FILTER_MAX_BITMAP_SIZE 0x600
211 
212 /* for KVM_X86_SET_MSR_FILTER */
213 struct kvm_msr_filter_range {
214 #define KVM_MSR_FILTER_READ  (1 << 0)
215 #define KVM_MSR_FILTER_WRITE (1 << 1)
216 #define KVM_MSR_FILTER_RANGE_VALID_MASK (KVM_MSR_FILTER_READ | \
217 					 KVM_MSR_FILTER_WRITE)
218 	__u32 flags;
219 	__u32 nmsrs; /* number of msrs in bitmap */
220 	__u32 base;  /* MSR index the bitmap starts at */
221 	__u8 *bitmap; /* a 1 bit allows the operations in flags, 0 denies */
222 };
223 
224 #define KVM_MSR_FILTER_MAX_RANGES 16
225 struct kvm_msr_filter {
226 #define KVM_MSR_FILTER_DEFAULT_ALLOW (0 << 0)
227 #define KVM_MSR_FILTER_DEFAULT_DENY  (1 << 0)
228 #define KVM_MSR_FILTER_VALID_MASK (KVM_MSR_FILTER_DEFAULT_DENY)
229 	__u32 flags;
230 	struct kvm_msr_filter_range ranges[KVM_MSR_FILTER_MAX_RANGES];
231 };
232 
233 struct kvm_cpuid_entry {
234 	__u32 function;
235 	__u32 eax;
236 	__u32 ebx;
237 	__u32 ecx;
238 	__u32 edx;
239 	__u32 padding;
240 };
241 
242 /* for KVM_SET_CPUID */
243 struct kvm_cpuid {
244 	__u32 nent;
245 	__u32 padding;
246 	struct kvm_cpuid_entry entries[];
247 };
248 
249 struct kvm_cpuid_entry2 {
250 	__u32 function;
251 	__u32 index;
252 	__u32 flags;
253 	__u32 eax;
254 	__u32 ebx;
255 	__u32 ecx;
256 	__u32 edx;
257 	__u32 padding[3];
258 };
259 
260 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX		(1 << 0)
261 #define KVM_CPUID_FLAG_STATEFUL_FUNC		(1 << 1)
262 #define KVM_CPUID_FLAG_STATE_READ_NEXT		(1 << 2)
263 
264 /* for KVM_SET_CPUID2 */
265 struct kvm_cpuid2 {
266 	__u32 nent;
267 	__u32 padding;
268 	struct kvm_cpuid_entry2 entries[];
269 };
270 
271 /* for KVM_GET_PIT and KVM_SET_PIT */
272 struct kvm_pit_channel_state {
273 	__u32 count; /* can be 65536 */
274 	__u16 latched_count;
275 	__u8 count_latched;
276 	__u8 status_latched;
277 	__u8 status;
278 	__u8 read_state;
279 	__u8 write_state;
280 	__u8 write_latch;
281 	__u8 rw_mode;
282 	__u8 mode;
283 	__u8 bcd;
284 	__u8 gate;
285 	__s64 count_load_time;
286 };
287 
288 struct kvm_debug_exit_arch {
289 	__u32 exception;
290 	__u32 pad;
291 	__u64 pc;
292 	__u64 dr6;
293 	__u64 dr7;
294 };
295 
296 #define KVM_GUESTDBG_USE_SW_BP		0x00010000
297 #define KVM_GUESTDBG_USE_HW_BP		0x00020000
298 #define KVM_GUESTDBG_INJECT_DB		0x00040000
299 #define KVM_GUESTDBG_INJECT_BP		0x00080000
300 #define KVM_GUESTDBG_BLOCKIRQ		0x00100000
301 
302 /* for KVM_SET_GUEST_DEBUG */
303 struct kvm_guest_debug_arch {
304 	__u64 debugreg[8];
305 };
306 
307 struct kvm_pit_state {
308 	struct kvm_pit_channel_state channels[3];
309 };
310 
311 #define KVM_PIT_FLAGS_HPET_LEGACY     0x00000001
312 #define KVM_PIT_FLAGS_SPEAKER_DATA_ON 0x00000002
313 
314 struct kvm_pit_state2 {
315 	struct kvm_pit_channel_state channels[3];
316 	__u32 flags;
317 	__u32 reserved[9];
318 };
319 
320 struct kvm_reinject_control {
321 	__u8 pit_reinject;
322 	__u8 reserved[31];
323 };
324 
325 /* When set in flags, include corresponding fields on KVM_SET_VCPU_EVENTS */
326 #define KVM_VCPUEVENT_VALID_NMI_PENDING	0x00000001
327 #define KVM_VCPUEVENT_VALID_SIPI_VECTOR	0x00000002
328 #define KVM_VCPUEVENT_VALID_SHADOW	0x00000004
329 #define KVM_VCPUEVENT_VALID_SMM		0x00000008
330 #define KVM_VCPUEVENT_VALID_PAYLOAD	0x00000010
331 #define KVM_VCPUEVENT_VALID_TRIPLE_FAULT	0x00000020
332 
333 /* Interrupt shadow states */
334 #define KVM_X86_SHADOW_INT_MOV_SS	0x01
335 #define KVM_X86_SHADOW_INT_STI		0x02
336 
337 /* for KVM_GET/SET_VCPU_EVENTS */
338 struct kvm_vcpu_events {
339 	struct {
340 		__u8 injected;
341 		__u8 nr;
342 		__u8 has_error_code;
343 		__u8 pending;
344 		__u32 error_code;
345 	} exception;
346 	struct {
347 		__u8 injected;
348 		__u8 nr;
349 		__u8 soft;
350 		__u8 shadow;
351 	} interrupt;
352 	struct {
353 		__u8 injected;
354 		__u8 pending;
355 		__u8 masked;
356 		__u8 pad;
357 	} nmi;
358 	__u32 sipi_vector;
359 	__u32 flags;
360 	struct {
361 		__u8 smm;
362 		__u8 pending;
363 		__u8 smm_inside_nmi;
364 		__u8 latched_init;
365 	} smi;
366 	struct {
367 		__u8 pending;
368 	} triple_fault;
369 	__u8 reserved[26];
370 	__u8 exception_has_payload;
371 	__u64 exception_payload;
372 };
373 
374 /* for KVM_GET/SET_DEBUGREGS */
375 struct kvm_debugregs {
376 	__u64 db[4];
377 	__u64 dr6;
378 	__u64 dr7;
379 	__u64 flags;
380 	__u64 reserved[9];
381 };
382 
383 /* for KVM_CAP_XSAVE and KVM_CAP_XSAVE2 */
384 struct kvm_xsave {
385 	/*
386 	 * KVM_GET_XSAVE2 and KVM_SET_XSAVE write and read as many bytes
387 	 * as are returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
388 	 * respectively, when invoked on the vm file descriptor.
389 	 *
390 	 * The size value returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
391 	 * will always be at least 4096. Currently, it is only greater
392 	 * than 4096 if a dynamic feature has been enabled with
393 	 * ``arch_prctl()``, but this may change in the future.
394 	 *
395 	 * The offsets of the state save areas in struct kvm_xsave follow
396 	 * the contents of CPUID leaf 0xD on the host.
397 	 */
398 	__u32 region[1024];
399 	__u32 extra[];
400 };
401 
402 #define KVM_MAX_XCRS	16
403 
404 struct kvm_xcr {
405 	__u32 xcr;
406 	__u32 reserved;
407 	__u64 value;
408 };
409 
410 struct kvm_xcrs {
411 	__u32 nr_xcrs;
412 	__u32 flags;
413 	struct kvm_xcr xcrs[KVM_MAX_XCRS];
414 	__u64 padding[16];
415 };
416 
417 #define KVM_X86_REG_TYPE_MSR		2
418 #define KVM_X86_REG_TYPE_KVM		3
419 
420 #define KVM_X86_KVM_REG_SIZE(reg)						\
421 ({										\
422 	reg == KVM_REG_GUEST_SSP ? KVM_REG_SIZE_U64 : 0;			\
423 })
424 
425 #define KVM_X86_REG_TYPE_SIZE(type, reg)					\
426 ({										\
427 	__u64 type_size = (__u64)type << 32;					\
428 										\
429 	type_size |= type == KVM_X86_REG_TYPE_MSR ? KVM_REG_SIZE_U64 :		\
430 		     type == KVM_X86_REG_TYPE_KVM ? KVM_X86_KVM_REG_SIZE(reg) :	\
431 		     0;								\
432 	type_size;								\
433 })
434 
435 #define KVM_X86_REG_ID(type, index)				\
436 	(KVM_REG_X86 | KVM_X86_REG_TYPE_SIZE(type, index) | index)
437 
438 #define KVM_X86_REG_MSR(index)					\
439 	KVM_X86_REG_ID(KVM_X86_REG_TYPE_MSR, index)
440 #define KVM_X86_REG_KVM(index)					\
441 	KVM_X86_REG_ID(KVM_X86_REG_TYPE_KVM, index)
442 
443 /* KVM-defined registers starting from 0 */
444 #define KVM_REG_GUEST_SSP	0
445 
446 #define KVM_SYNC_X86_REGS      (1UL << 0)
447 #define KVM_SYNC_X86_SREGS     (1UL << 1)
448 #define KVM_SYNC_X86_EVENTS    (1UL << 2)
449 
450 #define KVM_SYNC_X86_VALID_FIELDS \
451 	(KVM_SYNC_X86_REGS| \
452 	 KVM_SYNC_X86_SREGS| \
453 	 KVM_SYNC_X86_EVENTS)
454 
455 /* kvm_sync_regs struct included by kvm_run struct */
456 struct kvm_sync_regs {
457 	/* Members of this structure are potentially malicious.
458 	 * Care must be taken by code reading, esp. interpreting,
459 	 * data fields from them inside KVM to prevent TOCTOU and
460 	 * double-fetch types of vulnerabilities.
461 	 */
462 	struct kvm_regs regs;
463 	struct kvm_sregs sregs;
464 	struct kvm_vcpu_events events;
465 };
466 
467 #define KVM_X86_QUIRK_LINT0_REENABLED		(1 << 0)
468 #define KVM_X86_QUIRK_CD_NW_CLEARED		(1 << 1)
469 #define KVM_X86_QUIRK_LAPIC_MMIO_HOLE		(1 << 2)
470 #define KVM_X86_QUIRK_OUT_7E_INC_RIP		(1 << 3)
471 #define KVM_X86_QUIRK_MISC_ENABLE_NO_MWAIT	(1 << 4)
472 #define KVM_X86_QUIRK_FIX_HYPERCALL_INSN	(1 << 5)
473 #define KVM_X86_QUIRK_MWAIT_NEVER_UD_FAULTS	(1 << 6)
474 #define KVM_X86_QUIRK_SLOT_ZAP_ALL		(1 << 7)
475 #define KVM_X86_QUIRK_STUFF_FEATURE_MSRS	(1 << 8)
476 #define KVM_X86_QUIRK_IGNORE_GUEST_PAT		(1 << 9)
477 
478 #define KVM_STATE_NESTED_FORMAT_VMX	0
479 #define KVM_STATE_NESTED_FORMAT_SVM	1
480 
481 #define KVM_STATE_NESTED_GUEST_MODE	0x00000001
482 #define KVM_STATE_NESTED_RUN_PENDING	0x00000002
483 #define KVM_STATE_NESTED_EVMCS		0x00000004
484 #define KVM_STATE_NESTED_MTF_PENDING	0x00000008
485 #define KVM_STATE_NESTED_GIF_SET	0x00000100
486 
487 #define KVM_STATE_NESTED_SMM_GUEST_MODE	0x00000001
488 #define KVM_STATE_NESTED_SMM_VMXON	0x00000002
489 
490 #define KVM_STATE_NESTED_VMX_VMCS_SIZE	0x1000
491 
492 #define KVM_STATE_NESTED_SVM_VMCB_SIZE	0x1000
493 
494 #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE	0x00000001
495 
496 /* vendor-independent attributes for system fd (group 0) */
497 #define KVM_X86_GRP_SYSTEM		0
498 #  define KVM_X86_XCOMP_GUEST_SUPP	0
499 
500 /* vendor-specific groups and attributes for system fd */
501 #define KVM_X86_GRP_SEV			1
502 #  define KVM_X86_SEV_VMSA_FEATURES	0
503 
504 struct kvm_vmx_nested_state_data {
505 	__u8 vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
506 	__u8 shadow_vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
507 };
508 
509 struct kvm_vmx_nested_state_hdr {
510 	__u64 vmxon_pa;
511 	__u64 vmcs12_pa;
512 
513 	struct {
514 		__u16 flags;
515 	} smm;
516 
517 	__u16 pad;
518 
519 	__u32 flags;
520 	__u64 preemption_timer_deadline;
521 };
522 
523 struct kvm_svm_nested_state_data {
524 	/* Save area only used if KVM_STATE_NESTED_RUN_PENDING.  */
525 	__u8 vmcb12[KVM_STATE_NESTED_SVM_VMCB_SIZE];
526 };
527 
528 struct kvm_svm_nested_state_hdr {
529 	__u64 vmcb_pa;
530 };
531 
532 /* for KVM_CAP_NESTED_STATE */
533 struct kvm_nested_state {
534 	__u16 flags;
535 	__u16 format;
536 	__u32 size;
537 
538 	union {
539 		struct kvm_vmx_nested_state_hdr vmx;
540 		struct kvm_svm_nested_state_hdr svm;
541 
542 		/* Pad the header to 128 bytes.  */
543 		__u8 pad[120];
544 	} hdr;
545 
546 	/*
547 	 * Define data region as 0 bytes to preserve backwards-compatability
548 	 * to old definition of kvm_nested_state in order to avoid changing
549 	 * KVM_{GET,PUT}_NESTED_STATE ioctl values.
550 	 */
551 	union {
552 		__DECLARE_FLEX_ARRAY(struct kvm_vmx_nested_state_data, vmx);
553 		__DECLARE_FLEX_ARRAY(struct kvm_svm_nested_state_data, svm);
554 	} data;
555 };
556 
557 /* for KVM_CAP_PMU_EVENT_FILTER */
558 struct kvm_pmu_event_filter {
559 	__u32 action;
560 	__u32 nevents;
561 	__u32 fixed_counter_bitmap;
562 	__u32 flags;
563 	__u32 pad[4];
564 	__u64 events[];
565 };
566 
567 #define KVM_PMU_EVENT_ALLOW 0
568 #define KVM_PMU_EVENT_DENY 1
569 
570 #define KVM_PMU_EVENT_FLAG_MASKED_EVENTS _BITUL(0)
571 #define KVM_PMU_EVENT_FLAGS_VALID_MASK (KVM_PMU_EVENT_FLAG_MASKED_EVENTS)
572 
573 /* for KVM_CAP_MCE */
574 struct kvm_x86_mce {
575 	__u64 status;
576 	__u64 addr;
577 	__u64 misc;
578 	__u64 mcg_status;
579 	__u8 bank;
580 	__u8 pad1[7];
581 	__u64 pad2[3];
582 };
583 
584 /* for KVM_CAP_XEN_HVM */
585 #define KVM_XEN_HVM_CONFIG_HYPERCALL_MSR	(1 << 0)
586 #define KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL	(1 << 1)
587 #define KVM_XEN_HVM_CONFIG_SHARED_INFO		(1 << 2)
588 #define KVM_XEN_HVM_CONFIG_RUNSTATE		(1 << 3)
589 #define KVM_XEN_HVM_CONFIG_EVTCHN_2LEVEL	(1 << 4)
590 #define KVM_XEN_HVM_CONFIG_EVTCHN_SEND		(1 << 5)
591 #define KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG	(1 << 6)
592 #define KVM_XEN_HVM_CONFIG_PVCLOCK_TSC_UNSTABLE	(1 << 7)
593 #define KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA	(1 << 8)
594 
595 #define KVM_XEN_MSR_MIN_INDEX			0x40000000u
596 #define KVM_XEN_MSR_MAX_INDEX			0x4fffffffu
597 
598 struct kvm_xen_hvm_config {
599 	__u32 flags;
600 	__u32 msr;
601 	__u64 blob_addr_32;
602 	__u64 blob_addr_64;
603 	__u8 blob_size_32;
604 	__u8 blob_size_64;
605 	__u8 pad2[30];
606 };
607 
608 struct kvm_xen_hvm_attr {
609 	__u16 type;
610 	__u16 pad[3];
611 	union {
612 		__u8 long_mode;
613 		__u8 vector;
614 		__u8 runstate_update_flag;
615 		union {
616 			__u64 gfn;
617 #define KVM_XEN_INVALID_GFN ((__u64)-1)
618 			__u64 hva;
619 		} shared_info;
620 		struct {
621 			__u32 send_port;
622 			__u32 type; /* EVTCHNSTAT_ipi / EVTCHNSTAT_interdomain */
623 			__u32 flags;
624 #define KVM_XEN_EVTCHN_DEASSIGN		(1 << 0)
625 #define KVM_XEN_EVTCHN_UPDATE		(1 << 1)
626 #define KVM_XEN_EVTCHN_RESET		(1 << 2)
627 			/*
628 			 * Events sent by the guest are either looped back to
629 			 * the guest itself (potentially on a different port#)
630 			 * or signalled via an eventfd.
631 			 */
632 			union {
633 				struct {
634 					__u32 port;
635 					__u32 vcpu;
636 					__u32 priority;
637 				} port;
638 				struct {
639 					__u32 port; /* Zero for eventfd */
640 					__s32 fd;
641 				} eventfd;
642 				__u32 padding[4];
643 			} deliver;
644 		} evtchn;
645 		__u32 xen_version;
646 		__u64 pad[8];
647 	} u;
648 };
649 
650 
651 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
652 #define KVM_XEN_ATTR_TYPE_LONG_MODE		0x0
653 #define KVM_XEN_ATTR_TYPE_SHARED_INFO		0x1
654 #define KVM_XEN_ATTR_TYPE_UPCALL_VECTOR		0x2
655 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
656 #define KVM_XEN_ATTR_TYPE_EVTCHN		0x3
657 #define KVM_XEN_ATTR_TYPE_XEN_VERSION		0x4
658 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG */
659 #define KVM_XEN_ATTR_TYPE_RUNSTATE_UPDATE_FLAG	0x5
660 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
661 #define KVM_XEN_ATTR_TYPE_SHARED_INFO_HVA	0x6
662 
663 struct kvm_xen_vcpu_attr {
664 	__u16 type;
665 	__u16 pad[3];
666 	union {
667 		__u64 gpa;
668 #define KVM_XEN_INVALID_GPA ((__u64)-1)
669 		__u64 hva;
670 		__u64 pad[8];
671 		struct {
672 			__u64 state;
673 			__u64 state_entry_time;
674 			__u64 time_running;
675 			__u64 time_runnable;
676 			__u64 time_blocked;
677 			__u64 time_offline;
678 		} runstate;
679 		__u32 vcpu_id;
680 		struct {
681 			__u32 port;
682 			__u32 priority;
683 			__u64 expires_ns;
684 		} timer;
685 		__u8 vector;
686 	} u;
687 };
688 
689 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
690 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO	0x0
691 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_TIME_INFO	0x1
692 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADDR	0x2
693 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_CURRENT	0x3
694 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_DATA	0x4
695 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST	0x5
696 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
697 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_ID		0x6
698 #define KVM_XEN_VCPU_ATTR_TYPE_TIMER		0x7
699 #define KVM_XEN_VCPU_ATTR_TYPE_UPCALL_VECTOR	0x8
700 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
701 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO_HVA	0x9
702 
703 /* Secure Encrypted Virtualization command */
704 enum sev_cmd_id {
705 	/* Guest initialization commands */
706 	KVM_SEV_INIT = 0,
707 	KVM_SEV_ES_INIT,
708 	/* Guest launch commands */
709 	KVM_SEV_LAUNCH_START,
710 	KVM_SEV_LAUNCH_UPDATE_DATA,
711 	KVM_SEV_LAUNCH_UPDATE_VMSA,
712 	KVM_SEV_LAUNCH_SECRET,
713 	KVM_SEV_LAUNCH_MEASURE,
714 	KVM_SEV_LAUNCH_FINISH,
715 	/* Guest migration commands (outgoing) */
716 	KVM_SEV_SEND_START,
717 	KVM_SEV_SEND_UPDATE_DATA,
718 	KVM_SEV_SEND_UPDATE_VMSA,
719 	KVM_SEV_SEND_FINISH,
720 	/* Guest migration commands (incoming) */
721 	KVM_SEV_RECEIVE_START,
722 	KVM_SEV_RECEIVE_UPDATE_DATA,
723 	KVM_SEV_RECEIVE_UPDATE_VMSA,
724 	KVM_SEV_RECEIVE_FINISH,
725 	/* Guest status and debug commands */
726 	KVM_SEV_GUEST_STATUS,
727 	KVM_SEV_DBG_DECRYPT,
728 	KVM_SEV_DBG_ENCRYPT,
729 	/* Guest certificates commands */
730 	KVM_SEV_CERT_EXPORT,
731 	/* Attestation report */
732 	KVM_SEV_GET_ATTESTATION_REPORT,
733 	/* Guest Migration Extension */
734 	KVM_SEV_SEND_CANCEL,
735 
736 	/* Second time is the charm; improved versions of the above ioctls.  */
737 	KVM_SEV_INIT2,
738 
739 	/* SNP-specific commands */
740 	KVM_SEV_SNP_LAUNCH_START = 100,
741 	KVM_SEV_SNP_LAUNCH_UPDATE,
742 	KVM_SEV_SNP_LAUNCH_FINISH,
743 
744 	KVM_SEV_NR_MAX,
745 };
746 
747 struct kvm_sev_cmd {
748 	__u32 id;
749 	__u32 pad0;
750 	__u64 data;
751 	__u32 error;
752 	__u32 sev_fd;
753 };
754 
755 struct kvm_sev_init {
756 	__u64 vmsa_features;
757 	__u32 flags;
758 	__u16 ghcb_version;
759 	__u16 pad1;
760 	__u32 pad2[8];
761 };
762 
763 struct kvm_sev_launch_start {
764 	__u32 handle;
765 	__u32 policy;
766 	__u64 dh_uaddr;
767 	__u32 dh_len;
768 	__u32 pad0;
769 	__u64 session_uaddr;
770 	__u32 session_len;
771 	__u32 pad1;
772 };
773 
774 struct kvm_sev_launch_update_data {
775 	__u64 uaddr;
776 	__u32 len;
777 	__u32 pad0;
778 };
779 
780 
781 struct kvm_sev_launch_secret {
782 	__u64 hdr_uaddr;
783 	__u32 hdr_len;
784 	__u32 pad0;
785 	__u64 guest_uaddr;
786 	__u32 guest_len;
787 	__u32 pad1;
788 	__u64 trans_uaddr;
789 	__u32 trans_len;
790 	__u32 pad2;
791 };
792 
793 struct kvm_sev_launch_measure {
794 	__u64 uaddr;
795 	__u32 len;
796 	__u32 pad0;
797 };
798 
799 struct kvm_sev_guest_status {
800 	__u32 handle;
801 	__u32 policy;
802 	__u32 state;
803 };
804 
805 struct kvm_sev_dbg {
806 	__u64 src_uaddr;
807 	__u64 dst_uaddr;
808 	__u32 len;
809 	__u32 pad0;
810 };
811 
812 struct kvm_sev_attestation_report {
813 	__u8 mnonce[16];
814 	__u64 uaddr;
815 	__u32 len;
816 	__u32 pad0;
817 };
818 
819 struct kvm_sev_send_start {
820 	__u32 policy;
821 	__u32 pad0;
822 	__u64 pdh_cert_uaddr;
823 	__u32 pdh_cert_len;
824 	__u32 pad1;
825 	__u64 plat_certs_uaddr;
826 	__u32 plat_certs_len;
827 	__u32 pad2;
828 	__u64 amd_certs_uaddr;
829 	__u32 amd_certs_len;
830 	__u32 pad3;
831 	__u64 session_uaddr;
832 	__u32 session_len;
833 	__u32 pad4;
834 };
835 
836 struct kvm_sev_send_update_data {
837 	__u64 hdr_uaddr;
838 	__u32 hdr_len;
839 	__u32 pad0;
840 	__u64 guest_uaddr;
841 	__u32 guest_len;
842 	__u32 pad1;
843 	__u64 trans_uaddr;
844 	__u32 trans_len;
845 	__u32 pad2;
846 };
847 
848 struct kvm_sev_receive_start {
849 	__u32 handle;
850 	__u32 policy;
851 	__u64 pdh_uaddr;
852 	__u32 pdh_len;
853 	__u32 pad0;
854 	__u64 session_uaddr;
855 	__u32 session_len;
856 	__u32 pad1;
857 };
858 
859 struct kvm_sev_receive_update_data {
860 	__u64 hdr_uaddr;
861 	__u32 hdr_len;
862 	__u32 pad0;
863 	__u64 guest_uaddr;
864 	__u32 guest_len;
865 	__u32 pad1;
866 	__u64 trans_uaddr;
867 	__u32 trans_len;
868 	__u32 pad2;
869 };
870 
871 struct kvm_sev_snp_launch_start {
872 	__u64 policy;
873 	__u8 gosvw[16];
874 	__u16 flags;
875 	__u8 pad0[6];
876 	__u64 pad1[4];
877 };
878 
879 /* Kept in sync with firmware values for simplicity. */
880 #define KVM_SEV_PAGE_TYPE_INVALID		0x0
881 #define KVM_SEV_SNP_PAGE_TYPE_NORMAL		0x1
882 #define KVM_SEV_SNP_PAGE_TYPE_ZERO		0x3
883 #define KVM_SEV_SNP_PAGE_TYPE_UNMEASURED	0x4
884 #define KVM_SEV_SNP_PAGE_TYPE_SECRETS		0x5
885 #define KVM_SEV_SNP_PAGE_TYPE_CPUID		0x6
886 
887 struct kvm_sev_snp_launch_update {
888 	__u64 gfn_start;
889 	__u64 uaddr;
890 	__u64 len;
891 	__u8 type;
892 	__u8 pad0;
893 	__u16 flags;
894 	__u32 pad1;
895 	__u64 pad2[4];
896 };
897 
898 #define KVM_SEV_SNP_ID_BLOCK_SIZE	96
899 #define KVM_SEV_SNP_ID_AUTH_SIZE	4096
900 #define KVM_SEV_SNP_FINISH_DATA_SIZE	32
901 
902 struct kvm_sev_snp_launch_finish {
903 	__u64 id_block_uaddr;
904 	__u64 id_auth_uaddr;
905 	__u8 id_block_en;
906 	__u8 auth_key_en;
907 	__u8 vcek_disabled;
908 	__u8 host_data[KVM_SEV_SNP_FINISH_DATA_SIZE];
909 	__u8 pad0[3];
910 	__u16 flags;
911 	__u64 pad1[4];
912 };
913 
914 #define KVM_X2APIC_API_USE_32BIT_IDS            (1ULL << 0)
915 #define KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK  (1ULL << 1)
916 
917 struct kvm_hyperv_eventfd {
918 	__u32 conn_id;
919 	__s32 fd;
920 	__u32 flags;
921 	__u32 padding[3];
922 };
923 
924 #define KVM_HYPERV_CONN_ID_MASK		0x00ffffff
925 #define KVM_HYPERV_EVENTFD_DEASSIGN	(1 << 0)
926 
927 /*
928  * Masked event layout.
929  * Bits   Description
930  * ----   -----------
931  * 7:0    event select (low bits)
932  * 15:8   umask match
933  * 31:16  unused
934  * 35:32  event select (high bits)
935  * 36:54  unused
936  * 55     exclude bit
937  * 63:56  umask mask
938  */
939 
940 #define KVM_PMU_ENCODE_MASKED_ENTRY(event_select, mask, match, exclude) \
941 	(((event_select) & 0xFFULL) | (((event_select) & 0XF00ULL) << 24) | \
942 	(((mask) & 0xFFULL) << 56) | \
943 	(((match) & 0xFFULL) << 8) | \
944 	((__u64)(!!(exclude)) << 55))
945 
946 #define KVM_PMU_MASKED_ENTRY_EVENT_SELECT \
947 	(__GENMASK_ULL(7, 0) | __GENMASK_ULL(35, 32))
948 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK		(__GENMASK_ULL(63, 56))
949 #define KVM_PMU_MASKED_ENTRY_UMASK_MATCH	(__GENMASK_ULL(15, 8))
950 #define KVM_PMU_MASKED_ENTRY_EXCLUDE		(_BITULL(55))
951 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK_SHIFT	(56)
952 
953 /* for KVM_{GET,SET,HAS}_DEVICE_ATTR */
954 #define KVM_VCPU_TSC_CTRL 0 /* control group for the timestamp counter (TSC) */
955 #define   KVM_VCPU_TSC_OFFSET 0 /* attribute for the TSC offset */
956 
957 /* x86-specific KVM_EXIT_HYPERCALL flags. */
958 #define KVM_EXIT_HYPERCALL_LONG_MODE	_BITULL(0)
959 
960 #define KVM_X86_DEFAULT_VM	0
961 #define KVM_X86_SW_PROTECTED_VM	1
962 #define KVM_X86_SEV_VM		2
963 #define KVM_X86_SEV_ES_VM	3
964 #define KVM_X86_SNP_VM		4
965 #define KVM_X86_TDX_VM		5
966 
967 /* Trust Domain eXtension sub-ioctl() commands. */
968 enum kvm_tdx_cmd_id {
969 	KVM_TDX_CAPABILITIES = 0,
970 	KVM_TDX_INIT_VM,
971 	KVM_TDX_INIT_VCPU,
972 	KVM_TDX_INIT_MEM_REGION,
973 	KVM_TDX_FINALIZE_VM,
974 	KVM_TDX_GET_CPUID,
975 
976 	KVM_TDX_CMD_NR_MAX,
977 };
978 
979 struct kvm_tdx_cmd {
980 	/* enum kvm_tdx_cmd_id */
981 	__u32 id;
982 	/* flags for sub-commend. If sub-command doesn't use this, set zero. */
983 	__u32 flags;
984 	/*
985 	 * data for each sub-command. An immediate or a pointer to the actual
986 	 * data in process virtual address.  If sub-command doesn't use it,
987 	 * set zero.
988 	 */
989 	__u64 data;
990 	/*
991 	 * Auxiliary error code.  The sub-command may return TDX SEAMCALL
992 	 * status code in addition to -Exxx.
993 	 */
994 	__u64 hw_error;
995 };
996 
997 struct kvm_tdx_capabilities {
998 	__u64 supported_attrs;
999 	__u64 supported_xfam;
1000 
1001 	__u64 kernel_tdvmcallinfo_1_r11;
1002 	__u64 user_tdvmcallinfo_1_r11;
1003 	__u64 kernel_tdvmcallinfo_1_r12;
1004 	__u64 user_tdvmcallinfo_1_r12;
1005 
1006 	__u64 reserved[250];
1007 
1008 	/* Configurable CPUID bits for userspace */
1009 	struct kvm_cpuid2 cpuid;
1010 };
1011 
1012 struct kvm_tdx_init_vm {
1013 	__u64 attributes;
1014 	__u64 xfam;
1015 	__u64 mrconfigid[6];	/* sha384 digest */
1016 	__u64 mrowner[6];	/* sha384 digest */
1017 	__u64 mrownerconfig[6];	/* sha384 digest */
1018 
1019 	/* The total space for TD_PARAMS before the CPUIDs is 256 bytes */
1020 	__u64 reserved[12];
1021 
1022 	/*
1023 	 * Call KVM_TDX_INIT_VM before vcpu creation, thus before
1024 	 * KVM_SET_CPUID2.
1025 	 * This configuration supersedes KVM_SET_CPUID2s for VCPUs because the
1026 	 * TDX module directly virtualizes those CPUIDs without VMM.  The user
1027 	 * space VMM, e.g. qemu, should make KVM_SET_CPUID2 consistent with
1028 	 * those values.  If it doesn't, KVM may have wrong idea of vCPUIDs of
1029 	 * the guest, and KVM may wrongly emulate CPUIDs or MSRs that the TDX
1030 	 * module doesn't virtualize.
1031 	 */
1032 	struct kvm_cpuid2 cpuid;
1033 };
1034 
1035 #define KVM_TDX_MEASURE_MEMORY_REGION   _BITULL(0)
1036 
1037 struct kvm_tdx_init_mem_region {
1038 	__u64 source_addr;
1039 	__u64 gpa;
1040 	__u64 nr_pages;
1041 };
1042 
1043 #endif /* _ASM_X86_KVM_H */
1044