1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
6 * KVM x86 specific structures and definitions
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>
16 #define KVM_PIO_PAGE_OFFSET 1
17 #define KVM_COALESCED_MMIO_PAGE_OFFSET 2
18 #define KVM_DIRTY_LOG_PAGE_OFFSET 64
39 /* Select x86 specific features in <linux/kvm.h> */
40 #define __KVM_HAVE_PIT
41 #define __KVM_HAVE_IOAPIC
42 #define __KVM_HAVE_IRQ_LINE
43 #define __KVM_HAVE_MSI
44 #define __KVM_HAVE_USER_NMI
45 #define __KVM_HAVE_MSIX
46 #define __KVM_HAVE_MCE
47 #define __KVM_HAVE_PIT_STATE2
48 #define __KVM_HAVE_XEN_HVM
49 #define __KVM_HAVE_VCPU_EVENTS
50 #define __KVM_HAVE_DEBUGREGS
51 #define __KVM_HAVE_XSAVE
52 #define __KVM_HAVE_XCRS
54 /* Architectural interrupt line count. */
55 #define KVM_NR_INTERRUPTS 256
57 /* for KVM_GET_IRQCHIP and KVM_SET_IRQCHIP */
58 struct kvm_pic_state {
59 __u8 last_irr; /* edge detection */
60 __u8 irr; /* interrupt request register */
61 __u8 imr; /* interrupt mask register */
62 __u8 isr; /* interrupt service register */
63 __u8 priority_add; /* highest irq priority */
70 __u8 rotate_on_auto_eoi;
71 __u8 special_fully_nested_mode;
72 __u8 init4; /* true if 4 byte init */
73 __u8 elcr; /* PIIX edge/trigger selection */
77 #define KVM_IOAPIC_NUM_PINS 24
78 struct kvm_ioapic_state {
90 __u8 delivery_status:1;
99 } redirtbl[KVM_IOAPIC_NUM_PINS];
102 #define KVM_IRQCHIP_PIC_MASTER 0
103 #define KVM_IRQCHIP_PIC_SLAVE 1
104 #define KVM_IRQCHIP_IOAPIC 2
105 #define KVM_NR_IRQCHIPS 3
107 #define KVM_RUN_X86_SMM (1 << 0)
108 #define KVM_RUN_X86_BUS_LOCK (1 << 1)
109 #define KVM_RUN_X86_GUEST_MODE (1 << 2)
111 /* for KVM_GET_REGS and KVM_SET_REGS */
113 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
114 __u64 rax, rbx, rcx, rdx;
115 __u64 rsi, rdi, rsp, rbp;
116 __u64 r8, r9, r10, r11;
117 __u64 r12, r13, r14, r15;
121 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
122 #define KVM_APIC_REG_SIZE 0x400
123 struct kvm_lapic_state {
124 char regs[KVM_APIC_REG_SIZE];
132 __u8 present, dpl, db, s, l, g, avl;
144 /* for KVM_GET_SREGS and KVM_SET_SREGS */
146 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
147 struct kvm_segment cs, ds, es, fs, gs, ss;
148 struct kvm_segment tr, ldt;
149 struct kvm_dtable gdt, idt;
150 __u64 cr0, cr2, cr3, cr4, cr8;
153 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
157 /* out (KVM_GET_SREGS2) / in (KVM_SET_SREGS2) */
158 struct kvm_segment cs, ds, es, fs, gs, ss;
159 struct kvm_segment tr, ldt;
160 struct kvm_dtable gdt, idt;
161 __u64 cr0, cr2, cr3, cr4, cr8;
167 #define KVM_SREGS2_FLAGS_PDPTRS_VALID 1
169 /* for KVM_GET_FPU and KVM_SET_FPU */
174 __u8 ftwx; /* in fxsave format */
184 struct kvm_msr_entry {
190 /* for KVM_GET_MSRS and KVM_SET_MSRS */
192 __u32 nmsrs; /* number of msrs in entries */
195 struct kvm_msr_entry entries[];
198 /* for KVM_GET_MSR_INDEX_LIST */
199 struct kvm_msr_list {
200 __u32 nmsrs; /* number of msrs in entries */
204 /* Maximum size of any access bitmap in bytes */
205 #define KVM_MSR_FILTER_MAX_BITMAP_SIZE 0x600
207 /* for KVM_X86_SET_MSR_FILTER */
208 struct kvm_msr_filter_range {
209 #define KVM_MSR_FILTER_READ (1 << 0)
210 #define KVM_MSR_FILTER_WRITE (1 << 1)
211 #define KVM_MSR_FILTER_RANGE_VALID_MASK (KVM_MSR_FILTER_READ | \
212 KVM_MSR_FILTER_WRITE)
214 __u32 nmsrs; /* number of msrs in bitmap */
215 __u32 base; /* MSR index the bitmap starts at */
216 __u8 *bitmap; /* a 1 bit allows the operations in flags, 0 denies */
219 #define KVM_MSR_FILTER_MAX_RANGES 16
220 struct kvm_msr_filter {
222 #define KVM_MSR_FILTER_DEFAULT_ALLOW (0 << 0)
224 #define KVM_MSR_FILTER_DEFAULT_DENY (1 << 0)
225 #define KVM_MSR_FILTER_VALID_MASK (KVM_MSR_FILTER_DEFAULT_DENY)
227 struct kvm_msr_filter_range ranges[KVM_MSR_FILTER_MAX_RANGES];
230 struct kvm_cpuid_entry {
239 /* for KVM_SET_CPUID */
243 struct kvm_cpuid_entry entries[];
246 struct kvm_cpuid_entry2 {
257 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX (1 << 0)
258 #define KVM_CPUID_FLAG_STATEFUL_FUNC (1 << 1)
259 #define KVM_CPUID_FLAG_STATE_READ_NEXT (1 << 2)
261 /* for KVM_SET_CPUID2 */
265 struct kvm_cpuid_entry2 entries[];
268 /* for KVM_GET_PIT and KVM_SET_PIT */
269 struct kvm_pit_channel_state {
270 __u32 count; /* can be 65536 */
282 __s64 count_load_time;
285 struct kvm_debug_exit_arch {
293 #define KVM_GUESTDBG_USE_SW_BP 0x00010000
294 #define KVM_GUESTDBG_USE_HW_BP 0x00020000
295 #define KVM_GUESTDBG_INJECT_DB 0x00040000
296 #define KVM_GUESTDBG_INJECT_BP 0x00080000
297 #define KVM_GUESTDBG_BLOCKIRQ 0x00100000
299 /* for KVM_SET_GUEST_DEBUG */
300 struct kvm_guest_debug_arch {
304 struct kvm_pit_state {
305 struct kvm_pit_channel_state channels[3];
308 #define KVM_PIT_FLAGS_HPET_LEGACY 0x00000001
309 #define KVM_PIT_FLAGS_SPEAKER_DATA_ON 0x00000002
311 struct kvm_pit_state2 {
312 struct kvm_pit_channel_state channels[3];
317 struct kvm_reinject_control {
322 /* When set in flags, include corresponding fields on KVM_SET_VCPU_EVENTS */
323 #define KVM_VCPUEVENT_VALID_NMI_PENDING 0x00000001
324 #define KVM_VCPUEVENT_VALID_SIPI_VECTOR 0x00000002
325 #define KVM_VCPUEVENT_VALID_SHADOW 0x00000004
326 #define KVM_VCPUEVENT_VALID_SMM 0x00000008
327 #define KVM_VCPUEVENT_VALID_PAYLOAD 0x00000010
328 #define KVM_VCPUEVENT_VALID_TRIPLE_FAULT 0x00000020
330 /* Interrupt shadow states */
331 #define KVM_X86_SHADOW_INT_MOV_SS 0x01
332 #define KVM_X86_SHADOW_INT_STI 0x02
334 /* for KVM_GET/SET_VCPU_EVENTS */
335 struct kvm_vcpu_events {
367 __u8 exception_has_payload;
368 __u64 exception_payload;
371 /* for KVM_GET/SET_DEBUGREGS */
372 struct kvm_debugregs {
380 /* for KVM_CAP_XSAVE and KVM_CAP_XSAVE2 */
383 * KVM_GET_XSAVE2 and KVM_SET_XSAVE write and read as many bytes
384 * as are returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
385 * respectively, when invoked on the vm file descriptor.
387 * The size value returned by KVM_CHECK_EXTENSION(KVM_CAP_XSAVE2)
388 * will always be at least 4096. Currently, it is only greater
389 * than 4096 if a dynamic feature has been enabled with
390 * ``arch_prctl()``, but this may change in the future.
392 * The offsets of the state save areas in struct kvm_xsave follow
393 * the contents of CPUID leaf 0xD on the host.
399 #define KVM_MAX_XCRS 16
410 struct kvm_xcr xcrs[KVM_MAX_XCRS];
414 #define KVM_SYNC_X86_REGS (1UL << 0)
415 #define KVM_SYNC_X86_SREGS (1UL << 1)
416 #define KVM_SYNC_X86_EVENTS (1UL << 2)
418 #define KVM_SYNC_X86_VALID_FIELDS \
419 (KVM_SYNC_X86_REGS| \
420 KVM_SYNC_X86_SREGS| \
423 /* kvm_sync_regs struct included by kvm_run struct */
424 struct kvm_sync_regs {
425 /* Members of this structure are potentially malicious.
426 * Care must be taken by code reading, esp. interpreting,
427 * data fields from them inside KVM to prevent TOCTOU and
428 * double-fetch types of vulnerabilities.
430 struct kvm_regs regs;
431 struct kvm_sregs sregs;
432 struct kvm_vcpu_events events;
435 #define KVM_X86_QUIRK_LINT0_REENABLED (1 << 0)
436 #define KVM_X86_QUIRK_CD_NW_CLEARED (1 << 1)
437 #define KVM_X86_QUIRK_LAPIC_MMIO_HOLE (1 << 2)
438 #define KVM_X86_QUIRK_OUT_7E_INC_RIP (1 << 3)
439 #define KVM_X86_QUIRK_MISC_ENABLE_NO_MWAIT (1 << 4)
440 #define KVM_X86_QUIRK_FIX_HYPERCALL_INSN (1 << 5)
441 #define KVM_X86_QUIRK_MWAIT_NEVER_UD_FAULTS (1 << 6)
442 #define KVM_X86_QUIRK_SLOT_ZAP_ALL (1 << 7)
443 #define KVM_X86_QUIRK_STUFF_FEATURE_MSRS (1 << 8)
445 #define KVM_STATE_NESTED_FORMAT_VMX 0
446 #define KVM_STATE_NESTED_FORMAT_SVM 1
448 #define KVM_STATE_NESTED_GUEST_MODE 0x00000001
449 #define KVM_STATE_NESTED_RUN_PENDING 0x00000002
450 #define KVM_STATE_NESTED_EVMCS 0x00000004
451 #define KVM_STATE_NESTED_MTF_PENDING 0x00000008
452 #define KVM_STATE_NESTED_GIF_SET 0x00000100
454 #define KVM_STATE_NESTED_SMM_GUEST_MODE 0x00000001
455 #define KVM_STATE_NESTED_SMM_VMXON 0x00000002
457 #define KVM_STATE_NESTED_VMX_VMCS_SIZE 0x1000
459 #define KVM_STATE_NESTED_SVM_VMCB_SIZE 0x1000
461 #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
463 /* vendor-independent attributes for system fd (group 0) */
464 #define KVM_X86_GRP_SYSTEM 0
465 # define KVM_X86_XCOMP_GUEST_SUPP 0
467 /* vendor-specific groups and attributes for system fd */
468 #define KVM_X86_GRP_SEV 1
469 # define KVM_X86_SEV_VMSA_FEATURES 0
471 struct kvm_vmx_nested_state_data {
472 __u8 vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
473 __u8 shadow_vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
476 struct kvm_vmx_nested_state_hdr {
487 __u64 preemption_timer_deadline;
490 struct kvm_svm_nested_state_data {
491 /* Save area only used if KVM_STATE_NESTED_RUN_PENDING. */
492 __u8 vmcb12[KVM_STATE_NESTED_SVM_VMCB_SIZE];
495 struct kvm_svm_nested_state_hdr {
499 /* for KVM_CAP_NESTED_STATE */
500 struct kvm_nested_state {
506 struct kvm_vmx_nested_state_hdr vmx;
507 struct kvm_svm_nested_state_hdr svm;
509 /* Pad the header to 128 bytes. */
514 * Define data region as 0 bytes to preserve backwards-compatability
515 * to old definition of kvm_nested_state in order to avoid changing
516 * KVM_{GET,PUT}_NESTED_STATE ioctl values.
519 __DECLARE_FLEX_ARRAY(struct kvm_vmx_nested_state_data, vmx);
520 __DECLARE_FLEX_ARRAY(struct kvm_svm_nested_state_data, svm);
524 /* for KVM_CAP_PMU_EVENT_FILTER */
525 struct kvm_pmu_event_filter {
528 __u32 fixed_counter_bitmap;
534 #define KVM_PMU_EVENT_ALLOW 0
535 #define KVM_PMU_EVENT_DENY 1
537 #define KVM_PMU_EVENT_FLAG_MASKED_EVENTS _BITUL(0)
538 #define KVM_PMU_EVENT_FLAGS_VALID_MASK (KVM_PMU_EVENT_FLAG_MASKED_EVENTS)
540 /* for KVM_CAP_MCE */
551 /* for KVM_CAP_XEN_HVM */
552 #define KVM_XEN_HVM_CONFIG_HYPERCALL_MSR (1 << 0)
553 #define KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL (1 << 1)
554 #define KVM_XEN_HVM_CONFIG_SHARED_INFO (1 << 2)
555 #define KVM_XEN_HVM_CONFIG_RUNSTATE (1 << 3)
556 #define KVM_XEN_HVM_CONFIG_EVTCHN_2LEVEL (1 << 4)
557 #define KVM_XEN_HVM_CONFIG_EVTCHN_SEND (1 << 5)
558 #define KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG (1 << 6)
559 #define KVM_XEN_HVM_CONFIG_PVCLOCK_TSC_UNSTABLE (1 << 7)
560 #define KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA (1 << 8)
562 struct kvm_xen_hvm_config {
572 struct kvm_xen_hvm_attr {
578 __u8 runstate_update_flag;
581 #define KVM_XEN_INVALID_GFN ((__u64)-1)
586 __u32 type; /* EVTCHNSTAT_ipi / EVTCHNSTAT_interdomain */
588 #define KVM_XEN_EVTCHN_DEASSIGN (1 << 0)
589 #define KVM_XEN_EVTCHN_UPDATE (1 << 1)
590 #define KVM_XEN_EVTCHN_RESET (1 << 2)
592 * Events sent by the guest are either looped back to
593 * the guest itself (potentially on a different port#)
594 * or signalled via an eventfd.
603 __u32 port; /* Zero for eventfd */
615 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
616 #define KVM_XEN_ATTR_TYPE_LONG_MODE 0x0
617 #define KVM_XEN_ATTR_TYPE_SHARED_INFO 0x1
618 #define KVM_XEN_ATTR_TYPE_UPCALL_VECTOR 0x2
619 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
620 #define KVM_XEN_ATTR_TYPE_EVTCHN 0x3
621 #define KVM_XEN_ATTR_TYPE_XEN_VERSION 0x4
622 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_RUNSTATE_UPDATE_FLAG */
623 #define KVM_XEN_ATTR_TYPE_RUNSTATE_UPDATE_FLAG 0x5
624 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
625 #define KVM_XEN_ATTR_TYPE_SHARED_INFO_HVA 0x6
627 struct kvm_xen_vcpu_attr {
632 #define KVM_XEN_INVALID_GPA ((__u64)-1)
637 __u64 state_entry_time;
653 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO */
654 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO 0x0
655 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_TIME_INFO 0x1
656 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADDR 0x2
657 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_CURRENT 0x3
658 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_DATA 0x4
659 #define KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST 0x5
660 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
661 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_ID 0x6
662 #define KVM_XEN_VCPU_ATTR_TYPE_TIMER 0x7
663 #define KVM_XEN_VCPU_ATTR_TYPE_UPCALL_VECTOR 0x8
664 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO_HVA */
665 #define KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO_HVA 0x9
667 /* Secure Encrypted Virtualization command */
669 /* Guest initialization commands */
672 /* Guest launch commands */
673 KVM_SEV_LAUNCH_START,
674 KVM_SEV_LAUNCH_UPDATE_DATA,
675 KVM_SEV_LAUNCH_UPDATE_VMSA,
676 KVM_SEV_LAUNCH_SECRET,
677 KVM_SEV_LAUNCH_MEASURE,
678 KVM_SEV_LAUNCH_FINISH,
679 /* Guest migration commands (outgoing) */
681 KVM_SEV_SEND_UPDATE_DATA,
682 KVM_SEV_SEND_UPDATE_VMSA,
684 /* Guest migration commands (incoming) */
685 KVM_SEV_RECEIVE_START,
686 KVM_SEV_RECEIVE_UPDATE_DATA,
687 KVM_SEV_RECEIVE_UPDATE_VMSA,
688 KVM_SEV_RECEIVE_FINISH,
689 /* Guest status and debug commands */
690 KVM_SEV_GUEST_STATUS,
693 /* Guest certificates commands */
695 /* Attestation report */
696 KVM_SEV_GET_ATTESTATION_REPORT,
697 /* Guest Migration Extension */
700 /* Second time is the charm; improved versions of the above ioctls. */
703 /* SNP-specific commands */
704 KVM_SEV_SNP_LAUNCH_START = 100,
705 KVM_SEV_SNP_LAUNCH_UPDATE,
706 KVM_SEV_SNP_LAUNCH_FINISH,
719 struct kvm_sev_init {
727 struct kvm_sev_launch_start {
738 struct kvm_sev_launch_update_data {
745 struct kvm_sev_launch_secret {
757 struct kvm_sev_launch_measure {
763 struct kvm_sev_guest_status {
776 struct kvm_sev_attestation_report {
783 struct kvm_sev_send_start {
786 __u64 pdh_cert_uaddr;
789 __u64 plat_certs_uaddr;
790 __u32 plat_certs_len;
792 __u64 amd_certs_uaddr;
800 struct kvm_sev_send_update_data {
812 struct kvm_sev_receive_start {
823 struct kvm_sev_receive_update_data {
835 struct kvm_sev_snp_launch_start {
843 /* Kept in sync with firmware values for simplicity. */
844 #define KVM_SEV_SNP_PAGE_TYPE_NORMAL 0x1
845 #define KVM_SEV_SNP_PAGE_TYPE_ZERO 0x3
846 #define KVM_SEV_SNP_PAGE_TYPE_UNMEASURED 0x4
847 #define KVM_SEV_SNP_PAGE_TYPE_SECRETS 0x5
848 #define KVM_SEV_SNP_PAGE_TYPE_CPUID 0x6
850 struct kvm_sev_snp_launch_update {
861 #define KVM_SEV_SNP_ID_BLOCK_SIZE 96
862 #define KVM_SEV_SNP_ID_AUTH_SIZE 4096
863 #define KVM_SEV_SNP_FINISH_DATA_SIZE 32
865 struct kvm_sev_snp_launch_finish {
866 __u64 id_block_uaddr;
871 __u8 host_data[KVM_SEV_SNP_FINISH_DATA_SIZE];
877 #define KVM_X2APIC_API_USE_32BIT_IDS (1ULL << 0)
878 #define KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK (1ULL << 1)
880 struct kvm_hyperv_eventfd {
887 #define KVM_HYPERV_CONN_ID_MASK 0x00ffffff
888 #define KVM_HYPERV_EVENTFD_DEASSIGN (1 << 0)
891 * Masked event layout.
894 * 7:0 event select (low bits)
897 * 35:32 event select (high bits)
903 #define KVM_PMU_ENCODE_MASKED_ENTRY(event_select, mask, match, exclude) \
904 (((event_select) & 0xFFULL) | (((event_select) & 0XF00ULL) << 24) | \
905 (((mask) & 0xFFULL) << 56) | \
906 (((match) & 0xFFULL) << 8) | \
907 ((__u64)(!!(exclude)) << 55))
909 #define KVM_PMU_MASKED_ENTRY_EVENT_SELECT \
910 (__GENMASK_ULL(7, 0) | __GENMASK_ULL(35, 32))
911 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK (__GENMASK_ULL(63, 56))
912 #define KVM_PMU_MASKED_ENTRY_UMASK_MATCH (__GENMASK_ULL(15, 8))
913 #define KVM_PMU_MASKED_ENTRY_EXCLUDE (_BITULL(55))
914 #define KVM_PMU_MASKED_ENTRY_UMASK_MASK_SHIFT (56)
916 /* for KVM_{GET,SET,HAS}_DEVICE_ATTR */
917 #define KVM_VCPU_TSC_CTRL 0 /* control group for the timestamp counter (TSC) */
918 #define KVM_VCPU_TSC_OFFSET 0 /* attribute for the TSC offset */
920 /* x86-specific KVM_EXIT_HYPERCALL flags. */
921 #define KVM_EXIT_HYPERCALL_LONG_MODE _BITULL(0)
923 #define KVM_X86_DEFAULT_VM 0
924 #define KVM_X86_SW_PROTECTED_VM 1
925 #define KVM_X86_SEV_VM 2
926 #define KVM_X86_SEV_ES_VM 3
927 #define KVM_X86_SNP_VM 4
928 #define KVM_X86_TDX_VM 5
930 #endif /* _ASM_X86_KVM_H */