xref: /aosp_15_r20/external/crosvm/kvm_sys/src/lib.rs (revision bb4ee6a4ae7042d18b07a98463b9c8b875e44b39)
1 // Copyright 2017 The ChromiumOS Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 //! Bindings for the Linux KVM (Kernel Virtual Machine) API.
6 
7 #![cfg(any(target_os = "android", target_os = "linux"))]
8 #![allow(non_upper_case_globals)]
9 #![allow(non_camel_case_types)]
10 #![allow(non_snake_case)]
11 
12 use base::ioctl_io_nr;
13 use base::ioctl_ior_nr;
14 use base::ioctl_iow_nr;
15 use base::ioctl_iowr_nr;
16 
17 // Each of the below modules defines ioctls specific to their platform.
18 // Along with the common ioctls, we reexport the ioctls of the current
19 // platform.
20 
21 #[cfg(target_arch = "x86_64")]
22 pub mod x86 {
23     pub mod bindings;
24     use base::ioctl_ior_nr;
25     use base::ioctl_iow_nr;
26     use base::ioctl_iowr_nr;
27     use data_model::flexible_array_impl;
28 
29     pub use crate::bindings::*;
30 
31     flexible_array_impl!(kvm_cpuid2, kvm_cpuid_entry2, nent, entries);
32 
33     pub const KVM_MSR_FILTER_RANGE_MAX_BITS: usize = 0x2000;
34     pub const KVM_MSR_FILTER_RANGE_MAX_BYTES: usize = KVM_MSR_FILTER_RANGE_MAX_BITS / 8;
35 
36     ioctl_iowr_nr!(KVM_GET_MSR_INDEX_LIST, KVMIO, 0x02, kvm_msr_list);
37     ioctl_iowr_nr!(KVM_GET_SUPPORTED_CPUID, KVMIO, 0x05, kvm_cpuid2);
38     ioctl_iowr_nr!(KVM_GET_EMULATED_CPUID, KVMIO, 0x09, kvm_cpuid2);
39     ioctl_iow_nr!(KVM_XEN_HVM_CONFIG, KVMIO, 0x7a, kvm_xen_hvm_config);
40     ioctl_ior_nr!(KVM_GET_PIT2, KVMIO, 0x9f, kvm_pit_state2);
41     ioctl_iow_nr!(KVM_SET_PIT2, KVMIO, 0xa0, kvm_pit_state2);
42     ioctl_iowr_nr!(KVM_GET_MSRS, KVMIO, 0x88, kvm_msrs);
43     ioctl_iow_nr!(KVM_SET_MSRS, KVMIO, 0x89, kvm_msrs);
44     ioctl_iow_nr!(KVM_SET_CPUID, KVMIO, 0x8a, kvm_cpuid);
45     ioctl_ior_nr!(KVM_GET_LAPIC, KVMIO, 0x8e, kvm_lapic_state);
46     ioctl_iow_nr!(KVM_SET_LAPIC, KVMIO, 0x8f, kvm_lapic_state);
47     ioctl_iow_nr!(KVM_SET_CPUID2, KVMIO, 0x90, kvm_cpuid2);
48     ioctl_iowr_nr!(KVM_GET_CPUID2, KVMIO, 0x91, kvm_cpuid2);
49     ioctl_iow_nr!(KVM_X86_SETUP_MCE, KVMIO, 0x9c, u64);
50     ioctl_ior_nr!(KVM_X86_GET_MCE_CAP_SUPPORTED, KVMIO, 0x9d, u64);
51     ioctl_iow_nr!(KVM_X86_SET_MCE, KVMIO, 0x9e, kvm_x86_mce);
52     ioctl_ior_nr!(KVM_GET_VCPU_EVENTS, KVMIO, 0x9f, kvm_vcpu_events);
53     ioctl_iow_nr!(KVM_SET_VCPU_EVENTS, KVMIO, 0xa0, kvm_vcpu_events);
54     ioctl_ior_nr!(KVM_GET_DEBUGREGS, KVMIO, 0xa1, kvm_debugregs);
55     ioctl_iow_nr!(KVM_SET_DEBUGREGS, KVMIO, 0xa2, kvm_debugregs);
56     ioctl_ior_nr!(KVM_GET_XSAVE, KVMIO, 0xa4, kvm_xsave);
57     ioctl_iow_nr!(KVM_SET_XSAVE, KVMIO, 0xa5, kvm_xsave);
58     ioctl_ior_nr!(KVM_GET_XCRS, KVMIO, 0xa6, kvm_xcrs);
59     ioctl_iow_nr!(KVM_SET_XCRS, KVMIO, 0xa7, kvm_xcrs);
60     ioctl_iowr_nr!(KVM_GET_SUPPORTED_HV_CPUID, KVMIO, 0xc1, kvm_cpuid2);
61     ioctl_iow_nr!(KVM_X86_SET_MSR_FILTER, KVMIO, 0xc6, kvm_msr_filter);
62     ioctl_ior_nr!(KVM_GET_XSAVE2, KVMIO, 0xcf, kvm_xsave);
63 }
64 #[cfg(target_arch = "x86_64")]
65 pub use crate::x86::*;
66 
67 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
68 pub mod aarch64 {
69     pub mod bindings;
70     use base::ioctl_ior_nr;
71     use base::ioctl_iow_nr;
72     #[cfg(target_os = "android")]
73     use base::ioctl_iowr_nr;
74     pub use bindings::*;
75 
76     ioctl_iow_nr!(KVM_ARM_SET_DEVICE_ADDR, KVMIO, 0xab, kvm_arm_device_addr);
77     ioctl_iow_nr!(KVM_ARM_VCPU_INIT, KVMIO, 0xae, kvm_vcpu_init);
78     ioctl_ior_nr!(KVM_ARM_PREFERRED_TARGET, KVMIO, 0xaf, kvm_vcpu_init);
79     ioctl_iow_nr!(
80         KVM_ARM_SET_COUNTER_OFFSET,
81         KVMIO,
82         0xb5,
83         kvm_arm_counter_offset
84     );
85     ioctl_iow_nr!(KVM_ARM_VCPU_FINALIZE, KVMIO, 0xc2, libc::c_int);
86 
87     #[cfg(target_os = "android")]
88     ioctl_iowr_nr!(KVM_PVIOMMU_SET_CONFIG, KVMIO, 0x1, kvm_vfio_iommu_config);
89 }
90 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
91 pub use crate::aarch64::*;
92 
93 #[cfg(target_arch = "riscv64")]
94 pub mod riscv64 {
95     pub mod bindings;
96     pub use bindings::*;
97 }
98 #[cfg(target_arch = "riscv64")]
99 pub use crate::riscv64::*;
100 
101 // These ioctls are commonly defined on all/multiple platforms.
102 ioctl_io_nr!(KVM_GET_API_VERSION, KVMIO, 0x00);
103 ioctl_io_nr!(KVM_CREATE_VM, KVMIO, 0x01);
104 ioctl_io_nr!(KVM_CHECK_EXTENSION, KVMIO, 0x03);
105 ioctl_io_nr!(KVM_GET_VCPU_MMAP_SIZE, KVMIO, 0x04);
106 ioctl_io_nr!(KVM_CREATE_VCPU, KVMIO, 0x41);
107 ioctl_iow_nr!(KVM_GET_DIRTY_LOG, KVMIO, 0x42, kvm_dirty_log);
108 ioctl_io_nr!(KVM_SET_NR_MMU_PAGES, KVMIO, 0x44);
109 ioctl_io_nr!(KVM_GET_NR_MMU_PAGES, KVMIO, 0x45);
110 ioctl_iow_nr!(
111     KVM_SET_USER_MEMORY_REGION,
112     KVMIO,
113     0x46,
114     kvm_userspace_memory_region
115 );
116 ioctl_io_nr!(KVM_SET_TSS_ADDR, KVMIO, 0x47);
117 ioctl_iow_nr!(KVM_SET_IDENTITY_MAP_ADDR, KVMIO, 0x48, u64);
118 ioctl_io_nr!(KVM_CREATE_IRQCHIP, KVMIO, 0x60);
119 ioctl_iow_nr!(KVM_IRQ_LINE, KVMIO, 0x61, kvm_irq_level);
120 ioctl_iowr_nr!(KVM_GET_IRQCHIP, KVMIO, 0x62, kvm_irqchip);
121 ioctl_ior_nr!(KVM_SET_IRQCHIP, KVMIO, 0x63, kvm_irqchip);
122 ioctl_io_nr!(KVM_CREATE_PIT, KVMIO, 0x64);
123 ioctl_iowr_nr!(KVM_IRQ_LINE_STATUS, KVMIO, 0x67, kvm_irq_level);
124 ioctl_iow_nr!(
125     KVM_REGISTER_COALESCED_MMIO,
126     KVMIO,
127     0x67,
128     kvm_coalesced_mmio_zone
129 );
130 ioctl_iow_nr!(
131     KVM_UNREGISTER_COALESCED_MMIO,
132     KVMIO,
133     0x68,
134     kvm_coalesced_mmio_zone
135 );
136 ioctl_ior_nr!(KVM_ASSIGN_PCI_DEVICE, KVMIO, 0x69, kvm_assigned_pci_dev);
137 ioctl_iow_nr!(KVM_SET_GSI_ROUTING, KVMIO, 0x6a, kvm_irq_routing);
138 ioctl_iow_nr!(KVM_ASSIGN_DEV_IRQ, KVMIO, 0x70, kvm_assigned_irq);
139 ioctl_io_nr!(KVM_REINJECT_CONTROL, KVMIO, 0x71);
140 ioctl_iow_nr!(KVM_DEASSIGN_PCI_DEVICE, KVMIO, 0x72, kvm_assigned_pci_dev);
141 ioctl_iow_nr!(KVM_ASSIGN_SET_MSIX_NR, KVMIO, 0x73, kvm_assigned_msix_nr);
142 ioctl_iow_nr!(
143     KVM_ASSIGN_SET_MSIX_ENTRY,
144     KVMIO,
145     0x74,
146     kvm_assigned_msix_entry
147 );
148 ioctl_iow_nr!(KVM_DEASSIGN_DEV_IRQ, KVMIO, 0x75, kvm_assigned_irq);
149 ioctl_iow_nr!(KVM_IRQFD, KVMIO, 0x76, kvm_irqfd);
150 ioctl_iow_nr!(KVM_CREATE_PIT2, KVMIO, 0x77, kvm_pit_config);
151 ioctl_io_nr!(KVM_SET_BOOT_CPU_ID, KVMIO, 0x78);
152 ioctl_iow_nr!(KVM_IOEVENTFD, KVMIO, 0x79, kvm_ioeventfd);
153 ioctl_iow_nr!(KVM_SET_CLOCK, KVMIO, 0x7b, kvm_clock_data);
154 ioctl_ior_nr!(KVM_GET_CLOCK, KVMIO, 0x7c, kvm_clock_data);
155 ioctl_io_nr!(KVM_SET_TSC_KHZ, KVMIO, 0xa2);
156 ioctl_io_nr!(KVM_GET_TSC_KHZ, KVMIO, 0xa3);
157 ioctl_iow_nr!(KVM_ASSIGN_SET_INTX_MASK, KVMIO, 0xa4, kvm_assigned_pci_dev);
158 ioctl_iow_nr!(KVM_SIGNAL_MSI, KVMIO, 0xa5, kvm_msi);
159 ioctl_iowr_nr!(KVM_CREATE_DEVICE, KVMIO, 0xe0, kvm_create_device);
160 ioctl_iow_nr!(KVM_SET_DEVICE_ATTR, KVMIO, 0xe1, kvm_device_attr);
161 ioctl_iow_nr!(KVM_GET_DEVICE_ATTR, KVMIO, 0xe2, kvm_device_attr);
162 ioctl_iow_nr!(KVM_HAS_DEVICE_ATTR, KVMIO, 0xe3, kvm_device_attr);
163 ioctl_io_nr!(KVM_RUN, KVMIO, 0x80);
164 ioctl_ior_nr!(KVM_GET_REGS, KVMIO, 0x81, kvm_regs);
165 ioctl_iow_nr!(KVM_SET_REGS, KVMIO, 0x82, kvm_regs);
166 ioctl_ior_nr!(KVM_GET_SREGS, KVMIO, 0x83, kvm_sregs);
167 ioctl_iow_nr!(KVM_SET_SREGS, KVMIO, 0x84, kvm_sregs);
168 ioctl_iowr_nr!(KVM_TRANSLATE, KVMIO, 0x85, kvm_translation);
169 ioctl_iow_nr!(KVM_INTERRUPT, KVMIO, 0x86, kvm_interrupt);
170 ioctl_iow_nr!(KVM_SET_SIGNAL_MASK, KVMIO, 0x8b, kvm_signal_mask);
171 ioctl_ior_nr!(KVM_GET_FPU, KVMIO, 0x8c, kvm_fpu);
172 ioctl_iow_nr!(KVM_SET_FPU, KVMIO, 0x8d, kvm_fpu);
173 ioctl_iowr_nr!(KVM_TPR_ACCESS_REPORTING, KVMIO, 0x92, kvm_tpr_access_ctl);
174 ioctl_iow_nr!(KVM_SET_VAPIC_ADDR, KVMIO, 0x93, kvm_vapic_addr);
175 ioctl_ior_nr!(KVM_GET_MP_STATE, KVMIO, 0x98, kvm_mp_state);
176 ioctl_iow_nr!(KVM_SET_MP_STATE, KVMIO, 0x99, kvm_mp_state);
177 ioctl_io_nr!(KVM_NMI, KVMIO, 0x9a);
178 ioctl_iow_nr!(KVM_SET_GUEST_DEBUG, KVMIO, 0x9b, kvm_guest_debug);
179 ioctl_iow_nr!(KVM_ENABLE_CAP, KVMIO, 0xa3, kvm_enable_cap);
180 ioctl_iow_nr!(KVM_DIRTY_TLB, KVMIO, 0xaa, kvm_dirty_tlb);
181 ioctl_iow_nr!(KVM_GET_ONE_REG, KVMIO, 0xab, kvm_one_reg);
182 ioctl_iow_nr!(KVM_SET_ONE_REG, KVMIO, 0xac, kvm_one_reg);
183 ioctl_io_nr!(KVM_KVMCLOCK_CTRL, KVMIO, 0xad);
184 ioctl_iowr_nr!(KVM_GET_REG_LIST, KVMIO, 0xb0, kvm_reg_list);
185 ioctl_io_nr!(KVM_SMI, KVMIO, 0xb7);
186