kvm_sys/
lib.rs

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
12use base::ioctl_io_nr;
13use base::ioctl_ior_nr;
14use base::ioctl_iow_nr;
15use 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")]
22pub 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_NESTED_STATE, KVMIO, 0xbe, kvm_nested_state);
61    ioctl_iow_nr!(KVM_SET_NESTED_STATE, KVMIO, 0xbf, kvm_nested_state);
62    ioctl_iowr_nr!(KVM_GET_SUPPORTED_HV_CPUID, KVMIO, 0xc1, kvm_cpuid2);
63    ioctl_iow_nr!(KVM_X86_SET_MSR_FILTER, KVMIO, 0xc6, kvm_msr_filter);
64    ioctl_ior_nr!(KVM_GET_XSAVE2, KVMIO, 0xcf, kvm_xsave);
65}
66#[cfg(target_arch = "x86_64")]
67pub use crate::x86::*;
68
69#[cfg(target_arch = "aarch64")]
70pub mod aarch64 {
71    pub mod bindings;
72    use base::ioctl_ior_nr;
73    use base::ioctl_iow_nr;
74    #[cfg(target_os = "android")]
75    use base::ioctl_iowr_nr;
76    pub use bindings::*;
77
78    ioctl_iow_nr!(KVM_ARM_SET_DEVICE_ADDR, KVMIO, 0xab, kvm_arm_device_addr);
79    ioctl_iow_nr!(KVM_ARM_VCPU_INIT, KVMIO, 0xae, kvm_vcpu_init);
80    ioctl_ior_nr!(KVM_ARM_PREFERRED_TARGET, KVMIO, 0xaf, kvm_vcpu_init);
81    ioctl_iow_nr!(
82        KVM_ARM_SET_COUNTER_OFFSET,
83        KVMIO,
84        0xb5,
85        kvm_arm_counter_offset
86    );
87    ioctl_iow_nr!(KVM_ARM_VCPU_FINALIZE, KVMIO, 0xc2, libc::c_int);
88
89    #[cfg(target_os = "android")]
90    ioctl_iowr_nr!(KVM_PVIOMMU_SET_CONFIG, KVMIO, 0x1, kvm_vfio_iommu_config);
91}
92#[cfg(target_arch = "aarch64")]
93pub use crate::aarch64::*;
94
95#[cfg(target_arch = "riscv64")]
96pub mod riscv64 {
97    pub mod bindings;
98    pub use bindings::*;
99}
100#[cfg(target_arch = "riscv64")]
101pub use crate::riscv64::*;
102
103// These ioctls are commonly defined on all/multiple platforms.
104ioctl_io_nr!(KVM_GET_API_VERSION, KVMIO, 0x00);
105ioctl_io_nr!(KVM_CREATE_VM, KVMIO, 0x01);
106ioctl_io_nr!(KVM_CHECK_EXTENSION, KVMIO, 0x03);
107ioctl_io_nr!(KVM_GET_VCPU_MMAP_SIZE, KVMIO, 0x04);
108ioctl_io_nr!(KVM_CREATE_VCPU, KVMIO, 0x41);
109ioctl_iow_nr!(KVM_GET_DIRTY_LOG, KVMIO, 0x42, kvm_dirty_log);
110ioctl_io_nr!(KVM_SET_NR_MMU_PAGES, KVMIO, 0x44);
111ioctl_io_nr!(KVM_GET_NR_MMU_PAGES, KVMIO, 0x45);
112ioctl_iow_nr!(
113    KVM_SET_USER_MEMORY_REGION,
114    KVMIO,
115    0x46,
116    kvm_userspace_memory_region
117);
118ioctl_io_nr!(KVM_SET_TSS_ADDR, KVMIO, 0x47);
119ioctl_iow_nr!(KVM_SET_IDENTITY_MAP_ADDR, KVMIO, 0x48, u64);
120ioctl_iow_nr!(
121    KVM_SET_USER_MEMORY_REGION2,
122    KVMIO,
123    0x49,
124    kvm_userspace_memory_region2
125);
126ioctl_io_nr!(KVM_CREATE_IRQCHIP, KVMIO, 0x60);
127ioctl_iow_nr!(KVM_IRQ_LINE, KVMIO, 0x61, kvm_irq_level);
128ioctl_iowr_nr!(KVM_GET_IRQCHIP, KVMIO, 0x62, kvm_irqchip);
129ioctl_ior_nr!(KVM_SET_IRQCHIP, KVMIO, 0x63, kvm_irqchip);
130ioctl_io_nr!(KVM_CREATE_PIT, KVMIO, 0x64);
131ioctl_iowr_nr!(KVM_IRQ_LINE_STATUS, KVMIO, 0x67, kvm_irq_level);
132ioctl_iow_nr!(
133    KVM_REGISTER_COALESCED_MMIO,
134    KVMIO,
135    0x67,
136    kvm_coalesced_mmio_zone
137);
138ioctl_iow_nr!(
139    KVM_UNREGISTER_COALESCED_MMIO,
140    KVMIO,
141    0x68,
142    kvm_coalesced_mmio_zone
143);
144ioctl_iow_nr!(KVM_SET_GSI_ROUTING, KVMIO, 0x6a, kvm_irq_routing);
145ioctl_io_nr!(KVM_REINJECT_CONTROL, KVMIO, 0x71);
146ioctl_iow_nr!(KVM_IRQFD, KVMIO, 0x76, kvm_irqfd);
147ioctl_iow_nr!(KVM_CREATE_PIT2, KVMIO, 0x77, kvm_pit_config);
148ioctl_io_nr!(KVM_SET_BOOT_CPU_ID, KVMIO, 0x78);
149ioctl_iow_nr!(KVM_IOEVENTFD, KVMIO, 0x79, kvm_ioeventfd);
150ioctl_iow_nr!(KVM_SET_CLOCK, KVMIO, 0x7b, kvm_clock_data);
151ioctl_ior_nr!(KVM_GET_CLOCK, KVMIO, 0x7c, kvm_clock_data);
152ioctl_io_nr!(KVM_SET_TSC_KHZ, KVMIO, 0xa2);
153ioctl_io_nr!(KVM_GET_TSC_KHZ, KVMIO, 0xa3);
154ioctl_iow_nr!(KVM_SIGNAL_MSI, KVMIO, 0xa5, kvm_msi);
155ioctl_iowr_nr!(KVM_CREATE_DEVICE, KVMIO, 0xe0, kvm_create_device);
156ioctl_iow_nr!(KVM_SET_DEVICE_ATTR, KVMIO, 0xe1, kvm_device_attr);
157ioctl_iow_nr!(KVM_GET_DEVICE_ATTR, KVMIO, 0xe2, kvm_device_attr);
158ioctl_iow_nr!(KVM_HAS_DEVICE_ATTR, KVMIO, 0xe3, kvm_device_attr);
159ioctl_io_nr!(KVM_RUN, KVMIO, 0x80);
160ioctl_ior_nr!(KVM_GET_REGS, KVMIO, 0x81, kvm_regs);
161ioctl_iow_nr!(KVM_SET_REGS, KVMIO, 0x82, kvm_regs);
162ioctl_ior_nr!(KVM_GET_SREGS, KVMIO, 0x83, kvm_sregs);
163ioctl_iow_nr!(KVM_SET_SREGS, KVMIO, 0x84, kvm_sregs);
164ioctl_iowr_nr!(KVM_TRANSLATE, KVMIO, 0x85, kvm_translation);
165ioctl_iow_nr!(KVM_INTERRUPT, KVMIO, 0x86, kvm_interrupt);
166ioctl_iow_nr!(KVM_SET_SIGNAL_MASK, KVMIO, 0x8b, kvm_signal_mask);
167ioctl_ior_nr!(KVM_GET_FPU, KVMIO, 0x8c, kvm_fpu);
168ioctl_iow_nr!(KVM_SET_FPU, KVMIO, 0x8d, kvm_fpu);
169ioctl_iowr_nr!(KVM_TPR_ACCESS_REPORTING, KVMIO, 0x92, kvm_tpr_access_ctl);
170ioctl_iow_nr!(KVM_SET_VAPIC_ADDR, KVMIO, 0x93, kvm_vapic_addr);
171ioctl_ior_nr!(KVM_GET_MP_STATE, KVMIO, 0x98, kvm_mp_state);
172ioctl_iow_nr!(KVM_SET_MP_STATE, KVMIO, 0x99, kvm_mp_state);
173ioctl_io_nr!(KVM_NMI, KVMIO, 0x9a);
174ioctl_iow_nr!(KVM_SET_GUEST_DEBUG, KVMIO, 0x9b, kvm_guest_debug);
175ioctl_iow_nr!(KVM_ENABLE_CAP, KVMIO, 0xa3, kvm_enable_cap);
176ioctl_iow_nr!(KVM_DIRTY_TLB, KVMIO, 0xaa, kvm_dirty_tlb);
177ioctl_iow_nr!(KVM_GET_ONE_REG, KVMIO, 0xab, kvm_one_reg);
178ioctl_iow_nr!(KVM_SET_ONE_REG, KVMIO, 0xac, kvm_one_reg);
179ioctl_io_nr!(KVM_KVMCLOCK_CTRL, KVMIO, 0xad);
180ioctl_iowr_nr!(KVM_GET_REG_LIST, KVMIO, 0xb0, kvm_reg_list);
181ioctl_io_nr!(KVM_SMI, KVMIO, 0xb7);