xref: /linux/arch/x86/include/uapi/asm/kvm.h (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba)
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 	__DECLARE_FLEX_ARRAY(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 	__DECLARE_FLEX_ARRAY(__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 #ifndef __KERNEL__
227 #define KVM_MSR_FILTER_DEFAULT_ALLOW (0 << 0)
228 #endif
229 #define KVM_MSR_FILTER_DEFAULT_DENY  (1 << 0)
230 #define KVM_MSR_FILTER_VALID_MASK (KVM_MSR_FILTER_DEFAULT_DENY)
231 	__u32 flags;
232 	struct kvm_msr_filter_range ranges[KVM_MSR_FILTER_MAX_RANGES];
233 };
234 
235 struct kvm_cpuid_entry {
236 	__u32 function;
237 	__u32 eax;
238 	__u32 ebx;
239 	__u32 ecx;
240 	__u32 edx;
241 	__u32 padding;
242 };
243 
244 /* for KVM_SET_CPUID */
245 struct kvm_cpuid {
246 	__u32 nent;
247 	__u32 padding;
248 	__DECLARE_FLEX_ARRAY(struct kvm_cpuid_entry, entries);
249 };
250 
251 struct kvm_cpuid_entry2 {
252 	__u32 function;
253 	__u32 index;
254 	__u32 flags;
255 	__u32 eax;
256 	__u32 ebx;
257 	__u32 ecx;
258 	__u32 edx;
259 	__u32 padding[3];
260 };
261 
262 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX		(1 << 0)
263 #define KVM_CPUID_FLAG_STATEFUL_FUNC		(1 << 1)
264 #define KVM_CPUID_FLAG_STATE_READ_NEXT		(1 << 2)
265 
266 /* for KVM_SET_CPUID2 */
267 struct kvm_cpuid2 {
268 	__u32 nent;
269 	__u32 padding;
270 	__DECLARE_FLEX_ARRAY(struct kvm_cpuid_entry2, entries);
271 };
272 
273 /* for KVM_GET_PIT and KVM_SET_PIT */
274 struct kvm_pit_channel_state {
275 	__u32 count; /* can be 65536 */
276 	__u16 latched_count;
277 	__u8 count_latched;
278 	__u8 status_latched;
279 	__u8 status;
280 	__u8 read_state;
281 	__u8 write_state;
282 	__u8 write_latch;
283 	__u8 rw_mode;
284 	__u8 mode;
285 	__u8 bcd;
286 	__u8 gate;
287 	__s64 count_load_time;
288 };
289 
290 struct kvm_debug_exit_arch {
291 	__u32 exception;
292 	__u32 pad;
293 	__u64 pc;
294 	__u64 dr6;
295 	__u64 dr7;
296 };
297 
298 #define KVM_GUESTDBG_USE_SW_BP		0x00010000
299 #define KVM_GUESTDBG_USE_HW_BP		0x00020000
300 #define KVM_GUESTDBG_INJECT_DB		0x00040000
301 #define KVM_GUESTDBG_INJECT_BP		0x00080000
302 #define KVM_GUESTDBG_BLOCKIRQ		0x00100000
303 
304 /* for KVM_SET_GUEST_DEBUG */
305 struct kvm_guest_debug_arch {
306 	__u64 debugreg[8];
307 };
308 
309 struct kvm_pit_state {
310 	struct kvm_pit_channel_state channels[3];
311 };
312 
313 #define KVM_PIT_FLAGS_HPET_LEGACY     0x00000001
314 #define KVM_PIT_FLAGS_SPEAKER_DATA_ON 0x00000002
315 
316 struct kvm_pit_state2 {
317 	struct kvm_pit_channel_state channels[3];
318 	__u32 flags;
319 	__u32 reserved[9];
320 };
321 
322 struct kvm_reinject_control {
323 	__u8 pit_reinject;
324 	__u8 reserved[31];
325 };
326 
327 /* When set in flags, include corresponding fields on KVM_SET_VCPU_EVENTS */
328 #define KVM_VCPUEVENT_VALID_NMI_PENDING	0x00000001
329 #define KVM_VCPUEVENT_VALID_SIPI_VECTOR	0x00000002
330 #define KVM_VCPUEVENT_VALID_SHADOW	0x00000004
331 #define KVM_VCPUEVENT_VALID_SMM		0x00000008
332 #define KVM_VCPUEVENT_VALID_PAYLOAD	0x00000010
333 #define KVM_VCPUEVENT_VALID_TRIPLE_FAULT	0x00000020
334 
335 /* Interrupt shadow states */
336 #define KVM_X86_SHADOW_INT_MOV_SS	0x01
337 #define KVM_X86_SHADOW_INT_STI		0x02
338 
339 /* for KVM_GET/SET_VCPU_EVENTS */
340 struct kvm_vcpu_events {
341 	struct {
342 		__u8 injected;
343 		__u8 nr;
344 		__u8 has_error_code;
345 		__u8 pending;
346 		__u32 error_code;
347 	} exception;
348 	struct {
349 		__u8 injected;
350 		__u8 nr;
351 		__u8 soft;
352 		__u8 shadow;
353 	} interrupt;
354 	struct {
355 		__u8 injected;
356 		__u8 pending;
357 		__u8 masked;
358 		__u8 pad;
359 	} nmi;
360 	__u32 sipi_vector;
361 	__u32 flags;
362 	struct {
363 		__u8 smm;
364 		__u8 pending;
365 		__u8 smm_inside_nmi;
366 		__u8 latched_init;
367 	} smi;
368 	struct {
369 		__u8 pending;
370 	} triple_fault;
371 	__u8 reserved[26];
372 	__u8 exception_has_payload;
373 	__u64 exception_payload;
374 };
375 
376 /* for KVM_GET/SET_DEBUGREGS */
377 struct kvm_debugregs {
378 	__u64 db[4];
379 	__u64 dr6;
380 	__u64 dr7;
381 	__u64 flags;
382 	__u64 reserved[9];
383 };
384 
385 /* for KVM_CAP_XSAVE and KVM_CAP_XSAVE2 */
386 struct kvm_xsave {
387 	/*
388 	 * KVM_GET_XSAVE2 and KVM_SET_XSAVE write and read as many bytes
389 	 * as are returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
390 	 * respectively, when invoked on the vm file descriptor.
391 	 *
392 	 * The size value returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
393 	 * will always be at least 4096. Currently, it is only greater
394 	 * than 4096 if a dynamic feature has been enabled with
395 	 * ``arch_prctl()``, but this may change in the future.
396 	 *
397 	 * The offsets of the state save areas in struct kvm_xsave follow
398 	 * the contents of CPUID leaf 0xD on the host.
399 	 */
400 	__u32 region[1024];
401 	__DECLARE_FLEX_ARRAY(__u32, extra);
402 };
403 
404 #define KVM_MAX_XCRS	16
405 
406 struct kvm_xcr {
407 	__u32 xcr;
408 	__u32 reserved;
409 	__u64 value;
410 };
411 
412 struct kvm_xcrs {
413 	__u32 nr_xcrs;
414 	__u32 flags;
415 	struct kvm_xcr xcrs[KVM_MAX_XCRS];
416 	__u64 padding[16];
417 };
418 
419 #define KVM_X86_REG_TYPE_MSR		2
420 #define KVM_X86_REG_TYPE_KVM		3
421 
422 #define KVM_X86_KVM_REG_SIZE(reg)						\
423 ({										\
424 	reg == KVM_REG_GUEST_SSP ? KVM_REG_SIZE_U64 : 0;			\
425 })
426 
427 #define KVM_X86_REG_TYPE_SIZE(type, reg)					\
428 ({										\
429 	__u64 type_size = (__u64)type << 32;					\
430 										\
431 	type_size |= type == KVM_X86_REG_TYPE_MSR ? KVM_REG_SIZE_U64 :		\
432 		     type == KVM_X86_REG_TYPE_KVM ? KVM_X86_KVM_REG_SIZE(reg) :	\
433 		     0;								\
434 	type_size;								\
435 })
436 
437 #define KVM_X86_REG_ID(type, index)				\
438 	(KVM_REG_X86 | KVM_X86_REG_TYPE_SIZE(type, index) | index)
439 
440 #define KVM_X86_REG_MSR(index)					\
441 	KVM_X86_REG_ID(KVM_X86_REG_TYPE_MSR, index)
442 #define KVM_X86_REG_KVM(index)					\
443 	KVM_X86_REG_ID(KVM_X86_REG_TYPE_KVM, index)
444 
445 /* KVM-defined registers starting from 0 */
446 #define KVM_REG_GUEST_SSP	0
447 
448 #define KVM_SYNC_X86_REGS      (1UL << 0)
449 #define KVM_SYNC_X86_SREGS     (1UL << 1)
450 #define KVM_SYNC_X86_EVENTS    (1UL << 2)
451 
452 #define KVM_SYNC_X86_VALID_FIELDS \
453 	(KVM_SYNC_X86_REGS| \
454 	 KVM_SYNC_X86_SREGS| \
455 	 KVM_SYNC_X86_EVENTS)
456 
457 /* kvm_sync_regs struct included by kvm_run struct */
458 struct kvm_sync_regs {
459 	/* Members of this structure are potentially malicious.
460 	 * Care must be taken by code reading, esp. interpreting,
461 	 * data fields from them inside KVM to prevent TOCTOU and
462 	 * double-fetch types of vulnerabilities.
463 	 */
464 	struct kvm_regs regs;
465 	struct kvm_sregs sregs;
466 	struct kvm_vcpu_events events;
467 };
468 
469 #define KVM_X86_QUIRK_LINT0_REENABLED		(1 << 0)
470 #define KVM_X86_QUIRK_CD_NW_CLEARED		(1 << 1)
471 #define KVM_X86_QUIRK_LAPIC_MMIO_HOLE		(1 << 2)
472 #define KVM_X86_QUIRK_OUT_7E_INC_RIP		(1 << 3)
473 #define KVM_X86_QUIRK_MISC_ENABLE_NO_MWAIT	(1 << 4)
474 #define KVM_X86_QUIRK_FIX_HYPERCALL_INSN	(1 << 5)
475 #define KVM_X86_QUIRK_MWAIT_NEVER_UD_FAULTS	(1 << 6)
476 #define KVM_X86_QUIRK_SLOT_ZAP_ALL		(1 << 7)
477 #define KVM_X86_QUIRK_STUFF_FEATURE_MSRS	(1 << 8)
478 #define KVM_X86_QUIRK_IGNORE_GUEST_PAT		(1 << 9)
479 #define KVM_X86_QUIRK_VMCS12_ALLOW_FREEZE_IN_SMM (1 << 10)
480 #define KVM_X86_QUIRK_NESTED_SVM_SHARED_PAT	(1 << 11)
481 
482 #define KVM_STATE_NESTED_FORMAT_VMX	0
483 #define KVM_STATE_NESTED_FORMAT_SVM	1
484 
485 #define KVM_STATE_NESTED_GUEST_MODE	0x00000001
486 #define KVM_STATE_NESTED_RUN_PENDING	0x00000002
487 #define KVM_STATE_NESTED_EVMCS		0x00000004
488 #define KVM_STATE_NESTED_MTF_PENDING	0x00000008
489 #define KVM_STATE_NESTED_GIF_SET	0x00000100
490 
491 #define KVM_STATE_NESTED_SMM_GUEST_MODE	0x00000001
492 #define KVM_STATE_NESTED_SMM_VMXON	0x00000002
493 
494 #define KVM_STATE_NESTED_VMX_VMCS_SIZE	0x1000
495 
496 #define KVM_STATE_NESTED_SVM_VMCB_SIZE	0x1000
497 
498 #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE	0x00000001
499 
500 /* vendor-independent attributes for system fd (group 0) */
501 #define KVM_X86_GRP_SYSTEM		0
502 #  define KVM_X86_XCOMP_GUEST_SUPP	0
503 
504 /* vendor-specific groups and attributes for system fd */
505 #define KVM_X86_GRP_SEV			1
506 #  define KVM_X86_SEV_VMSA_FEATURES	0
507 #  define KVM_X86_SNP_POLICY_BITS	1
508 #  define KVM_X86_SEV_SNP_REQ_CERTS	2
509 
510 struct kvm_vmx_nested_state_data {
511 	__u8 vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
512 	__u8 shadow_vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
513 };
514 
515 struct kvm_vmx_nested_state_hdr {
516 	__u64 vmxon_pa;
517 	__u64 vmcs12_pa;
518 
519 	struct {
520 		__u16 flags;
521 	} smm;
522 
523 	__u16 pad;
524 
525 	__u32 flags;
526 	__u64 preemption_timer_deadline;
527 };
528 
529 struct kvm_svm_nested_state_data {
530 	/* Save area only used if KVM_STATE_NESTED_RUN_PENDING.  */
531 	__u8 vmcb12[KVM_STATE_NESTED_SVM_VMCB_SIZE];
532 };
533 
534 struct kvm_svm_nested_state_hdr {
535 	__u64 vmcb_pa;
536 	__u64 gpat;
537 };
538 
539 /* for KVM_CAP_NESTED_STATE */
540 struct kvm_nested_state {
541 	__u16 flags;
542 	__u16 format;
543 	__u32 size;
544 
545 	union {
546 		struct kvm_vmx_nested_state_hdr vmx;
547 		struct kvm_svm_nested_state_hdr svm;
548 
549 		/* Pad the header to 128 bytes.  */
550 		__u8 pad[120];
551 	} hdr;
552 
553 	/*
554 	 * Define data region as 0 bytes to preserve backwards-compatability
555 	 * to old definition of kvm_nested_state in order to avoid changing
556 	 * KVM_{GET,PUT}_NESTED_STATE ioctl values.
557 	 */
558 	union {
559 		__DECLARE_FLEX_ARRAY(struct kvm_vmx_nested_state_data, vmx);
560 		__DECLARE_FLEX_ARRAY(struct kvm_svm_nested_state_data, svm);
561 	} data;
562 };
563 
564 /* for KVM_CAP_PMU_EVENT_FILTER */
565 struct kvm_pmu_event_filter {
566 	__u32 action;
567 	__u32 nevents;
568 	__u32 fixed_counter_bitmap;
569 	__u32 flags;
570 	__u32 pad[4];
571 	__DECLARE_FLEX_ARRAY(__u64, events);
572 };
573 
574 #define KVM_PMU_EVENT_ALLOW 0
575 #define KVM_PMU_EVENT_DENY 1
576 
577 #define KVM_PMU_EVENT_FLAG_MASKED_EVENTS _BITUL(0)
578 #define KVM_PMU_EVENT_FLAGS_VALID_MASK (KVM_PMU_EVENT_FLAG_MASKED_EVENTS)
579 
580 /* for KVM_CAP_MCE */
581 struct kvm_x86_mce {
582 	__u64 status;
583 	__u64 addr;
584 	__u64 misc;
585 	__u64 mcg_status;
586 	__u8 bank;
587 	__u8 pad1[7];
588 	__u64 pad2[3];
589 };
590 
591 /* for KVM_CAP_XEN_HVM */
592 #define KVM_XEN_HVM_CONFIG_HYPERCALL_MSR	(1 << 0)
593 #define KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL	(1 << 1)
594 #define KVM_XEN_HVM_CONFIG_SHARED_INFO		(1 << 2)
595 #define KVM_XEN_HVM_CONFIG_RUNSTATE		(1 << 3)
596 #define KVM_XEN_HVM_CONFIG_EVTCHN_2LEVEL	(1 << 4)
597 #define KVM_XEN_HVM_CONFIG_EVTCHN_SEND		(1 << 5)
598 #define KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG	(1 << 6)
599 #define KVM_XEN_HVM_CONFIG_PVCLOCK_TSC_UNSTABLE	(1 << 7)
600 #define KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA	(1 << 8)
601 
602 #define KVM_XEN_MSR_MIN_INDEX			0x40000000u
603 #define KVM_XEN_MSR_MAX_INDEX			0x4fffffffu
604 
605 struct kvm_xen_hvm_config {
606 	__u32 flags;
607 	__u32 msr;
608 	__u64 blob_addr_32;
609 	__u64 blob_addr_64;
610 	__u8 blob_size_32;
611 	__u8 blob_size_64;
612 	__u8 pad2[30];
613 };
614 
615 struct kvm_xen_hvm_attr {
616 	__u16 type;
617 	__u16 pad[3];
618 	union {
619 		__u8 long_mode;
620 		__u8 vector;
621 		__u8 runstate_update_flag;
622 		union {
623 			__u64 gfn;
624 #define KVM_XEN_INVALID_GFN ((__u64)-1)
625 			__u64 hva;
626 		} shared_info;
627 		struct {
628 			__u32 send_port;
629 			__u32 type; /* EVTCHNSTAT_ipi / EVTCHNSTAT_interdomain */
630 			__u32 flags;
631 #define KVM_XEN_EVTCHN_DEASSIGN		(1 << 0)
632 #define KVM_XEN_EVTCHN_UPDATE		(1 << 1)
633 #define KVM_XEN_EVTCHN_RESET		(1 << 2)
634 			/*
635 			 * Events sent by the guest are either looped back to
636 			 * the guest itself (potentially on a different port#)
637 			 * or signalled via an eventfd.
638 			 */
639 			union {
640 				struct {
641 					__u32 port;
642 					__u32 vcpu;
643 					__u32 priority;
644 				} port;
645 				struct {
646 					__u32 port; /* Zero for eventfd */
647 					__s32 fd;
648 				} eventfd;
649 				__u32 padding[4];
650 			} deliver;
651 		} evtchn;
652 		__u32 xen_version;
653 		__u64 pad[8];
654 	} u;
655 };
656 
657 
658 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
659 #define KVM_XEN_ATTR_TYPE_LONG_MODE		0x0
660 #define KVM_XEN_ATTR_TYPE_SHARED_INFO		0x1
661 #define KVM_XEN_ATTR_TYPE_UPCALL_VECTOR		0x2
662 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
663 #define KVM_XEN_ATTR_TYPE_EVTCHN		0x3
664 #define KVM_XEN_ATTR_TYPE_XEN_VERSION		0x4
665 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG */
666 #define KVM_XEN_ATTR_TYPE_RUNSTATE_UPDATE_FLAG	0x5
667 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
668 #define KVM_XEN_ATTR_TYPE_SHARED_INFO_HVA	0x6
669 
670 struct kvm_xen_vcpu_attr {
671 	__u16 type;
672 	__u16 pad[3];
673 	union {
674 		__u64 gpa;
675 #define KVM_XEN_INVALID_GPA ((__u64)-1)
676 		__u64 hva;
677 		__u64 pad[8];
678 		struct {
679 			__u64 state;
680 			__u64 state_entry_time;
681 			__u64 time_running;
682 			__u64 time_runnable;
683 			__u64 time_blocked;
684 			__u64 time_offline;
685 		} runstate;
686 		__u32 vcpu_id;
687 		struct {
688 			__u32 port;
689 			__u32 priority;
690 			__u64 expires_ns;
691 		} timer;
692 		__u8 vector;
693 	} u;
694 };
695 
696 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
697 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO	0x0
698 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_TIME_INFO	0x1
699 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADDR	0x2
700 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_CURRENT	0x3
701 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_DATA	0x4
702 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST	0x5
703 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
704 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_ID		0x6
705 #define KVM_XEN_VCPU_ATTR_TYPE_TIMER		0x7
706 #define KVM_XEN_VCPU_ATTR_TYPE_UPCALL_VECTOR	0x8
707 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
708 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO_HVA	0x9
709 
710 /* Secure Encrypted Virtualization command */
711 enum sev_cmd_id {
712 	/* Guest initialization commands */
713 	KVM_SEV_INIT = 0,
714 	KVM_SEV_ES_INIT,
715 	/* Guest launch commands */
716 	KVM_SEV_LAUNCH_START,
717 	KVM_SEV_LAUNCH_UPDATE_DATA,
718 	KVM_SEV_LAUNCH_UPDATE_VMSA,
719 	KVM_SEV_LAUNCH_SECRET,
720 	KVM_SEV_LAUNCH_MEASURE,
721 	KVM_SEV_LAUNCH_FINISH,
722 	/* Guest migration commands (outgoing) */
723 	KVM_SEV_SEND_START,
724 	KVM_SEV_SEND_UPDATE_DATA,
725 	KVM_SEV_SEND_UPDATE_VMSA,
726 	KVM_SEV_SEND_FINISH,
727 	/* Guest migration commands (incoming) */
728 	KVM_SEV_RECEIVE_START,
729 	KVM_SEV_RECEIVE_UPDATE_DATA,
730 	KVM_SEV_RECEIVE_UPDATE_VMSA,
731 	KVM_SEV_RECEIVE_FINISH,
732 	/* Guest status and debug commands */
733 	KVM_SEV_GUEST_STATUS,
734 	KVM_SEV_DBG_DECRYPT,
735 	KVM_SEV_DBG_ENCRYPT,
736 	/* Guest certificates commands */
737 	KVM_SEV_CERT_EXPORT,
738 	/* Attestation report */
739 	KVM_SEV_GET_ATTESTATION_REPORT,
740 	/* Guest Migration Extension */
741 	KVM_SEV_SEND_CANCEL,
742 
743 	/* Second time is the charm; improved versions of the above ioctls.  */
744 	KVM_SEV_INIT2,
745 
746 	/* SNP-specific commands */
747 	KVM_SEV_SNP_LAUNCH_START = 100,
748 	KVM_SEV_SNP_LAUNCH_UPDATE,
749 	KVM_SEV_SNP_LAUNCH_FINISH,
750 	KVM_SEV_SNP_ENABLE_REQ_CERTS,
751 
752 	KVM_SEV_NR_MAX,
753 };
754 
755 struct kvm_sev_cmd {
756 	__u32 id;
757 	__u32 pad0;
758 	__u64 data;
759 	__u32 error;
760 	__u32 sev_fd;
761 };
762 
763 struct kvm_sev_init {
764 	__u64 vmsa_features;
765 	__u32 flags;
766 	__u16 ghcb_version;
767 	__u16 pad1;
768 	__u32 pad2[8];
769 };
770 
771 struct kvm_sev_launch_start {
772 	__u32 handle;
773 	__u32 policy;
774 	__u64 dh_uaddr;
775 	__u32 dh_len;
776 	__u32 pad0;
777 	__u64 session_uaddr;
778 	__u32 session_len;
779 	__u32 pad1;
780 };
781 
782 struct kvm_sev_launch_update_data {
783 	__u64 uaddr;
784 	__u32 len;
785 	__u32 pad0;
786 };
787 
788 
789 struct kvm_sev_launch_secret {
790 	__u64 hdr_uaddr;
791 	__u32 hdr_len;
792 	__u32 pad0;
793 	__u64 guest_uaddr;
794 	__u32 guest_len;
795 	__u32 pad1;
796 	__u64 trans_uaddr;
797 	__u32 trans_len;
798 	__u32 pad2;
799 };
800 
801 struct kvm_sev_launch_measure {
802 	__u64 uaddr;
803 	__u32 len;
804 	__u32 pad0;
805 };
806 
807 struct kvm_sev_guest_status {
808 	__u32 handle;
809 	__u32 policy;
810 	__u32 state;
811 };
812 
813 struct kvm_sev_dbg {
814 	__u64 src_uaddr;
815 	__u64 dst_uaddr;
816 	__u32 len;
817 	__u32 pad0;
818 };
819 
820 struct kvm_sev_attestation_report {
821 	__u8 mnonce[16];
822 	__u64 uaddr;
823 	__u32 len;
824 	__u32 pad0;
825 };
826 
827 struct kvm_sev_send_start {
828 	__u32 policy;
829 	__u32 pad0;
830 	__u64 pdh_cert_uaddr;
831 	__u32 pdh_cert_len;
832 	__u32 pad1;
833 	__u64 plat_certs_uaddr;
834 	__u32 plat_certs_len;
835 	__u32 pad2;
836 	__u64 amd_certs_uaddr;
837 	__u32 amd_certs_len;
838 	__u32 pad3;
839 	__u64 session_uaddr;
840 	__u32 session_len;
841 	__u32 pad4;
842 };
843 
844 struct kvm_sev_send_update_data {
845 	__u64 hdr_uaddr;
846 	__u32 hdr_len;
847 	__u32 pad0;
848 	__u64 guest_uaddr;
849 	__u32 guest_len;
850 	__u32 pad1;
851 	__u64 trans_uaddr;
852 	__u32 trans_len;
853 	__u32 pad2;
854 };
855 
856 struct kvm_sev_receive_start {
857 	__u32 handle;
858 	__u32 policy;
859 	__u64 pdh_uaddr;
860 	__u32 pdh_len;
861 	__u32 pad0;
862 	__u64 session_uaddr;
863 	__u32 session_len;
864 	__u32 pad1;
865 };
866 
867 struct kvm_sev_receive_update_data {
868 	__u64 hdr_uaddr;
869 	__u32 hdr_len;
870 	__u32 pad0;
871 	__u64 guest_uaddr;
872 	__u32 guest_len;
873 	__u32 pad1;
874 	__u64 trans_uaddr;
875 	__u32 trans_len;
876 	__u32 pad2;
877 };
878 
879 struct kvm_sev_snp_launch_start {
880 	__u64 policy;
881 	__u8 gosvw[16];
882 	__u16 flags;
883 	__u8 pad0[6];
884 	__u64 pad1[4];
885 };
886 
887 /* Kept in sync with firmware values for simplicity. */
888 #define KVM_SEV_PAGE_TYPE_INVALID		0x0
889 #define KVM_SEV_SNP_PAGE_TYPE_NORMAL		0x1
890 #define KVM_SEV_SNP_PAGE_TYPE_ZERO		0x3
891 #define KVM_SEV_SNP_PAGE_TYPE_UNMEASURED	0x4
892 #define KVM_SEV_SNP_PAGE_TYPE_SECRETS		0x5
893 #define KVM_SEV_SNP_PAGE_TYPE_CPUID		0x6
894 
895 struct kvm_sev_snp_launch_update {
896 	__u64 gfn_start;
897 	__u64 uaddr;
898 	__u64 len;
899 	__u8 type;
900 	__u8 pad0;
901 	__u16 flags;
902 	__u32 pad1;
903 	__u64 pad2[4];
904 };
905 
906 #define KVM_SEV_SNP_ID_BLOCK_SIZE	96
907 #define KVM_SEV_SNP_ID_AUTH_SIZE	4096
908 #define KVM_SEV_SNP_FINISH_DATA_SIZE	32
909 
910 struct kvm_sev_snp_launch_finish {
911 	__u64 id_block_uaddr;
912 	__u64 id_auth_uaddr;
913 	__u8 id_block_en;
914 	__u8 auth_key_en;
915 	__u8 vcek_disabled;
916 	__u8 host_data[KVM_SEV_SNP_FINISH_DATA_SIZE];
917 	__u8 pad0[3];
918 	__u16 flags;
919 	__u64 pad1[4];
920 };
921 
922 #define KVM_X2APIC_API_USE_32BIT_IDS			_BITULL(0)
923 #define KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK		_BITULL(1)
924 #define KVM_X2APIC_ENABLE_SUPPRESS_EOI_BROADCAST	_BITULL(2)
925 #define KVM_X2APIC_DISABLE_SUPPRESS_EOI_BROADCAST	_BITULL(3)
926 
927 struct kvm_hyperv_eventfd {
928 	__u32 conn_id;
929 	__s32 fd;
930 	__u32 flags;
931 	__u32 padding[3];
932 };
933 
934 #define KVM_HYPERV_CONN_ID_MASK		0x00ffffff
935 #define KVM_HYPERV_EVENTFD_DEASSIGN	(1 << 0)
936 
937 /*
938  * Masked event layout.
939  * Bits   Description
940  * ----   -----------
941  * 7:0    event select (low bits)
942  * 15:8   umask match
943  * 31:16  unused
944  * 35:32  event select (high bits)
945  * 36:54  unused
946  * 55     exclude bit
947  * 63:56  umask mask
948  */
949 
950 #define KVM_PMU_ENCODE_MASKED_ENTRY(event_select, mask, match, exclude) \
951 	(((event_select) & 0xFFULL) | (((event_select) & 0XF00ULL) << 24) | \
952 	(((mask) & 0xFFULL) << 56) | \
953 	(((match) & 0xFFULL) << 8) | \
954 	((__u64)(!!(exclude)) << 55))
955 
956 #define KVM_PMU_MASKED_ENTRY_EVENT_SELECT \
957 	(__GENMASK_ULL(7, 0) | __GENMASK_ULL(35, 32))
958 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK		(__GENMASK_ULL(63, 56))
959 #define KVM_PMU_MASKED_ENTRY_UMASK_MATCH	(__GENMASK_ULL(15, 8))
960 #define KVM_PMU_MASKED_ENTRY_EXCLUDE		(_BITULL(55))
961 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK_SHIFT	(56)
962 
963 /* for KVM_{GET,SET,HAS}_DEVICE_ATTR */
964 #define KVM_VCPU_TSC_CTRL 0 /* control group for the timestamp counter (TSC) */
965 #define   KVM_VCPU_TSC_OFFSET 0 /* attribute for the TSC offset */
966 
967 /* x86-specific KVM_EXIT_HYPERCALL flags. */
968 #define KVM_EXIT_HYPERCALL_LONG_MODE	_BITULL(0)
969 
970 #define KVM_X86_DEFAULT_VM	0
971 #define KVM_X86_SW_PROTECTED_VM	1
972 #define KVM_X86_SEV_VM		2
973 #define KVM_X86_SEV_ES_VM	3
974 #define KVM_X86_SNP_VM		4
975 #define KVM_X86_TDX_VM		5
976 
977 /* Trust Domain eXtension sub-ioctl() commands. */
978 enum kvm_tdx_cmd_id {
979 	KVM_TDX_CAPABILITIES = 0,
980 	KVM_TDX_INIT_VM,
981 	KVM_TDX_INIT_VCPU,
982 	KVM_TDX_INIT_MEM_REGION,
983 	KVM_TDX_FINALIZE_VM,
984 	KVM_TDX_GET_CPUID,
985 
986 	KVM_TDX_CMD_NR_MAX,
987 };
988 
989 struct kvm_tdx_cmd {
990 	/* enum kvm_tdx_cmd_id */
991 	__u32 id;
992 	/* flags for sub-commend. If sub-command doesn't use this, set zero. */
993 	__u32 flags;
994 	/*
995 	 * data for each sub-command. An immediate or a pointer to the actual
996 	 * data in process virtual address.  If sub-command doesn't use it,
997 	 * set zero.
998 	 */
999 	__u64 data;
1000 	/*
1001 	 * Auxiliary error code.  The sub-command may return TDX SEAMCALL
1002 	 * status code in addition to -Exxx.
1003 	 */
1004 	__u64 hw_error;
1005 };
1006 
1007 struct kvm_tdx_capabilities {
1008 	__u64 supported_attrs;
1009 	__u64 supported_xfam;
1010 
1011 	__u64 kernel_tdvmcallinfo_1_r11;
1012 	__u64 user_tdvmcallinfo_1_r11;
1013 	__u64 kernel_tdvmcallinfo_1_r12;
1014 	__u64 user_tdvmcallinfo_1_r12;
1015 
1016 	__u64 reserved[250];
1017 
1018 	/* Configurable CPUID bits for userspace */
1019 	struct kvm_cpuid2 cpuid;
1020 };
1021 
1022 struct kvm_tdx_init_vm {
1023 	__u64 attributes;
1024 	__u64 xfam;
1025 	__u64 mrconfigid[6];	/* sha384 digest */
1026 	__u64 mrowner[6];	/* sha384 digest */
1027 	__u64 mrownerconfig[6];	/* sha384 digest */
1028 
1029 	/* The total space for TD_PARAMS before the CPUIDs is 256 bytes */
1030 	__u64 reserved[12];
1031 
1032 	/*
1033 	 * Call KVM_TDX_INIT_VM before vcpu creation, thus before
1034 	 * KVM_SET_CPUID2.
1035 	 * This configuration supersedes KVM_SET_CPUID2s for VCPUs because the
1036 	 * TDX module directly virtualizes those CPUIDs without VMM.  The user
1037 	 * space VMM, e.g. qemu, should make KVM_SET_CPUID2 consistent with
1038 	 * those values.  If it doesn't, KVM may have wrong idea of vCPUIDs of
1039 	 * the guest, and KVM may wrongly emulate CPUIDs or MSRs that the TDX
1040 	 * module doesn't virtualize.
1041 	 */
1042 	struct kvm_cpuid2 cpuid;
1043 };
1044 
1045 #define KVM_TDX_MEASURE_MEMORY_REGION   _BITULL(0)
1046 
1047 struct kvm_tdx_init_mem_region {
1048 	__u64 source_addr;
1049 	__u64 gpa;
1050 	__u64 nr_pages;
1051 };
1052 
1053 #endif /* _ASM_X86_KVM_H */
1054