kvm: refactor kvm and kvm_gen

- move autogenerated code from kvm_gen to kvm
- sanity.rs is now unit test inside a module of the kvm crate
- label x86 and x86_64 specific code
- remove x86 clasification inside kvm_gen since the bindings are common
  to all architectures

Signed-off-by: Diana Popa <[email protected]>

Author: dianpopa

kvm/src/ioctl_wrap.rs

@@ -0,0 +1,120 @@
+// Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+use kvm_gen::*;
+
+// Declares necessary ioctls specific to their platform.
+
+ioctl_io_nr!(KVM_GET_API_VERSION, KVMIO, 0x00);
+ioctl_io_nr!(KVM_CREATE_VM, KVMIO, 0x01);
+ioctl_io_nr!(KVM_CHECK_EXTENSION, KVMIO, 0x03);
+ioctl_io_nr!(KVM_GET_VCPU_MMAP_SIZE, KVMIO, 0x04);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iowr_nr!(KVM_GET_SUPPORTED_CPUID, KVMIO, 0x05, kvm_cpuid2);
+ioctl_io_nr!(KVM_CREATE_VCPU, KVMIO, 0x41);
+ioctl_iow_nr!(
+    KVM_SET_USER_MEMORY_REGION,
+    KVMIO,
+    0x46,
+    kvm_userspace_memory_region
+);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_io_nr!(KVM_SET_TSS_ADDR, KVMIO, 0x47);
+#[cfg(any(
+    target_arch = "x86",
+    target_arch = "x86_64",
+    target_arch = "arm",
+    target_arch = "aarch64",
+    target_arch = "s390"
+))]
+ioctl_io_nr!(KVM_CREATE_IRQCHIP, KVMIO, 0x60);
+#[cfg(any(
+    target_arch = "x86",
+    target_arch = "x86_64",
+    target_arch = "arm",
+    target_arch = "aarch64",
+    target_arch = "s390"
+))]
+ioctl_iow_nr!(KVM_IRQFD, KVMIO, 0x76, kvm_irqfd);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iow_nr!(KVM_CREATE_PIT2, KVMIO, 0x77, kvm_pit_config);
+ioctl_iow_nr!(KVM_IOEVENTFD, KVMIO, 0x79, kvm_ioeventfd);
+ioctl_io_nr!(KVM_RUN, KVMIO, 0x80);
+#[cfg(not(any(target_arch = "arm", target_arch = "aarch64")))]
+ioctl_ior_nr!(KVM_GET_REGS, KVMIO, 0x81, kvm_regs);
+#[cfg(not(any(target_arch = "arm", target_arch = "aarch64")))]
+ioctl_iow_nr!(KVM_SET_REGS, KVMIO, 0x82, kvm_regs);
+#[cfg(any(
+    target_arch = "x86",
+    target_arch = "x86_64",
+    target_arch = "powerpc",
+    target_arch = "powerpc64"
+))]
+ioctl_ior_nr!(KVM_GET_SREGS, KVMIO, 0x83, kvm_sregs);
+#[cfg(any(
+    target_arch = "x86",
+    target_arch = "x86_64",
+    target_arch = "powerpc",
+    target_arch = "powerpc64"
+))]
+ioctl_iow_nr!(KVM_SET_SREGS, KVMIO, 0x84, kvm_sregs);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iowr_nr!(KVM_GET_MSRS, KVMIO, 0x88, kvm_msrs);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iow_nr!(KVM_SET_MSRS, KVMIO, 0x89, kvm_msrs);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iow_nr!(KVM_SET_CPUID2, KVMIO, 0x90, kvm_cpuid2);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_ior_nr!(KVM_GET_FPU, KVMIO, 0x8c, kvm_fpu);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iow_nr!(KVM_SET_FPU, KVMIO, 0x8d, kvm_fpu);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_ior_nr!(KVM_GET_LAPIC, KVMIO, 0x8e, kvm_lapic_state);
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+ioctl_iow_nr!(KVM_SET_LAPIC, KVMIO, 0x8f, kvm_lapic_state);
+
+#[cfg(test)]
+mod tests {
+    use std::fs::File;
+    use std::os::unix::io::FromRawFd;
+
+    use libc::{c_char, open, O_RDWR};
+
+    use super::*;
+    use sys_util::{ioctl, ioctl_with_val};
+
+    const KVM_PATH: &'static str = "/dev/kvm\0";
+
+    #[test]
+    fn get_version() {
+        let sys_fd = unsafe { open(KVM_PATH.as_ptr() as *const c_char, O_RDWR) };
+        assert!(sys_fd >= 0);
+
+        let ret = unsafe { ioctl(&File::from_raw_fd(sys_fd), KVM_GET_API_VERSION()) };
+        assert_eq!(ret as u32, KVM_API_VERSION);
+    }
+
+    #[test]
+    fn create_vm_fd() {
+        let sys_fd = unsafe { open(KVM_PATH.as_ptr() as *const c_char, O_RDWR) };
+        assert!(sys_fd >= 0);
+
+        let vm_fd = unsafe { ioctl(&File::from_raw_fd(sys_fd), KVM_CREATE_VM()) };
+        assert!(vm_fd >= 0);
+    }
+
+    #[test]
+    fn check_vm_extension() {
+        let sys_fd = unsafe { open(KVM_PATH.as_ptr() as *const c_char, O_RDWR) };
+        assert!(sys_fd >= 0);
+
+        let has_user_memory = unsafe {
+            ioctl_with_val(
+                &File::from_raw_fd(sys_fd),
+                KVM_CHECK_EXTENSION(),
+                KVM_CAP_USER_MEMORY.into(),
+            )
+        };
+        assert_eq!(has_user_memory, 1);
+    }
+}

kvm/src/lib.rs

@@ -13,9 +13,11 @@ extern crate libc;
 
 extern crate kvm_gen;
 extern crate memory_model;
+#[macro_use]
 extern crate sys_util;
 
 mod cap;
+mod ioctl_wrap;
 
 use std::fs::File;
 use std::os::raw::*;
@@ -26,11 +28,12 @@ use libc::{open, EINVAL, ENOSPC, O_RDWR};
 use kvm_gen::*;
 use memory_model::MemoryMapping;
 use sys_util::{errno_result, Error, EventFd, Result};
-use sys_util::{
-    ioctl, ioctl_with_mut_ptr, ioctl_with_mut_ref, ioctl_with_ptr, ioctl_with_ref, ioctl_with_val,
-};
+use sys_util::{ioctl, ioctl_with_ref, ioctl_with_val};
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+use sys_util::{ioctl_with_mut_ptr, ioctl_with_mut_ref, ioctl_with_ptr};
 
 pub use cap::*;
+use ioctl_wrap::*;
 pub use kvm_gen::KVM_API_VERSION;
 
 /// Taken from Linux Kernel v4.14.13 (arch/x86/include/asm/kvm_host.h)
@@ -161,9 +164,11 @@ impl Kvm {
             // Safe because we verify the value of ret and we are the owners of the fd.
             let vm_file = unsafe { File::from_raw_fd(ret) };
             let run_mmap_size = self.get_vcpu_mmap_size()?;
+            #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
             let kvm_cpuid: CpuId = self.get_supported_cpuid(MAX_KVM_CPUID_ENTRIES)?;
             Ok(VmFd {
                 vm: vm_file,
+                #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
                 supported_cpuid: kvm_cpuid,
                 run_size: run_mmap_size,
             })
@@ -197,11 +202,13 @@ impl Into<u64> for NoDatamatch {
 /// A wrapper around creating and using a VM.
 pub struct VmFd {
     vm: File,
+    #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
     supported_cpuid: CpuId,
     run_size: usize,
 }
 
 impl VmFd {
+    #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
     /// Returns a clone of the system supported CPUID values associated with this VmFd
     pub fn get_supported_cpuid(&self) -> CpuId {
         self.supported_cpuid.clone()

kvm_gen/src/x86/bindings.rs renamed to kvm_gen/src/bindings.rs

@@ -1,65 +1,8 @@
 // Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-//
-// Portions Copyright 2017 The Chromium OS Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the THIRD-PARTY file.
 
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-
-#[macro_use]
-extern crate sys_util;
-
-// Each of the below modules defines ioctls specific to their platform (currently, x86 and x86_64).
-
-#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
-pub mod x86 {
-    // generated with:
-    // bindgen include/uapi/linux/kvm.h -o bindings.rs
-    //        --no-rustfmt-bindings
-    //        --with-derive-default
-    //        -- -Iinclude -Iarch/x86/include/
-    pub mod bindings;
-    pub use bindings::*;
-
-    ioctl_iowr_nr!(KVM_GET_SUPPORTED_CPUID, KVMIO, 0x05, kvm_cpuid2);
-    ioctl_iowr_nr!(KVM_GET_MSRS, KVMIO, 0x88, kvm_msrs);
-    ioctl_iow_nr!(KVM_SET_MSRS, KVMIO, 0x89, kvm_msrs);
-    ioctl_ior_nr!(KVM_GET_LAPIC, KVMIO, 0x8e, kvm_lapic_state);
-    ioctl_iow_nr!(KVM_SET_LAPIC, KVMIO, 0x8f, kvm_lapic_state);
-    ioctl_iow_nr!(KVM_SET_CPUID2, KVMIO, 0x90, kvm_cpuid2);
-    // we do use KVM_SET_CPUID2, however KVM_GET_CPUID2 is never used
-    // should be used to unit test the SET!!!
-    ioctl_iowr_nr!(KVM_GET_CPUID2, KVMIO, 0x91, kvm_cpuid2);
-}
-
-// These ioctls are commonly defined on all/multiple platforms.
-ioctl_io_nr!(KVM_GET_API_VERSION, KVMIO, 0x00);
-ioctl_io_nr!(KVM_CREATE_VM, KVMIO, 0x01);
-ioctl_io_nr!(KVM_CHECK_EXTENSION, KVMIO, 0x03);
-ioctl_io_nr!(KVM_GET_VCPU_MMAP_SIZE, KVMIO, 0x04);
-ioctl_io_nr!(KVM_CREATE_VCPU, KVMIO, 0x41);
-ioctl_iow_nr!(
-    KVM_SET_USER_MEMORY_REGION,
-    KVMIO,
-    0x46,
-    kvm_userspace_memory_region
-);
-ioctl_io_nr!(KVM_SET_TSS_ADDR, KVMIO, 0x47);
-ioctl_io_nr!(KVM_CREATE_IRQCHIP, KVMIO, 0x60);
-ioctl_iow_nr!(KVM_IRQFD, KVMIO, 0x76, kvm_irqfd);
-ioctl_iow_nr!(KVM_CREATE_PIT2, KVMIO, 0x77, kvm_pit_config);
-ioctl_iow_nr!(KVM_IOEVENTFD, KVMIO, 0x79, kvm_ioeventfd);
-ioctl_io_nr!(KVM_RUN, KVMIO, 0x80);
-ioctl_ior_nr!(KVM_GET_REGS, KVMIO, 0x81, kvm_regs);
-ioctl_iow_nr!(KVM_SET_REGS, KVMIO, 0x82, kvm_regs);
-ioctl_ior_nr!(KVM_GET_SREGS, KVMIO, 0x83, kvm_sregs);
-ioctl_iow_nr!(KVM_SET_SREGS, KVMIO, 0x84, kvm_sregs);
-ioctl_ior_nr!(KVM_GET_FPU, KVMIO, 0x8c, kvm_fpu);
-ioctl_iow_nr!(KVM_SET_FPU, KVMIO, 0x8d, kvm_fpu);
-
-// Along with the common ioctls, we reexport the ioctls of the current
-// platform.
-pub use x86::*;
+mod bindings;
+pub use bindings::*;