hypervisor: Define a VM-Exit abstraction

In order to move the hypervisor specific parts of the VM exit handling
path, we're defining a generic, hypervisor agnostic VM exit enum.

This is what the hypervisor's Vcpu run() call should return when the VM
exit can not be completely handled through the hypervisor specific bits.
For KVM based hypervisors, this means directly forwarding the IO related
exits back to the VMM itself. For other hypervisors that e.g. rely on the
VMM to decode and emulate instructions, this means the decoding itself
would happen in the hypervisor crate exclusively, and the rest of the VM
exit handling would be handled through the VMM device model implementation.

Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>

Fix test_vm unit test by using the new abstraction and dropping some
dead code.

Signed-off-by: Wei Liu <liuwe@microsoft.com>

hypervisor/src/cpu.rs

@@ -10,7 +10,7 @@
 
 #[cfg(target_arch = "aarch64")]
 use crate::aarch64::VcpuInit;
-use crate::{CpuState, MpState, VcpuExit};
+use crate::{CpuState, MpState};
 
 #[cfg(target_arch = "x86_64")]
 use crate::x86_64::{
@@ -18,7 +18,6 @@ use crate::x86_64::{
     StandardRegisters, VcpuEvents, Xsave,
 };
 use thiserror::Error;
-use vmm_sys_util::errno::Error as RunError;
 
 #[derive(Error, Debug)]
 ///
@@ -151,6 +150,20 @@ pub enum HypervisorCpuError {
     NotifyGuestClockPaused(#[source] anyhow::Error),
 }
 
+#[derive(Debug)]
+pub enum VmExit<'a> {
+    #[cfg(target_arch = "x86_64")]
+    IoOut(u16 /* port */, &'a [u8] /* data */),
+    #[cfg(target_arch = "x86_64")]
+    IoIn(u16 /* port */, &'a mut [u8] /* data */),
+    #[cfg(target_arch = "x86_64")]
+    IoapicEoi(u8 /* vector */),
+    MmioRead(u64 /* address */, &'a mut [u8]),
+    MmioWrite(u64 /* address */, &'a [u8]),
+    Ignore,
+    Reset,
+}
+
 ///
 /// Result type for returning from a function
 ///
@@ -248,10 +261,6 @@ pub trait Vcpu: Send + Sync {
     /// X86 specific call that sets the vcpu's current "xcrs".
     ///
     fn set_xcrs(&self, xcrs: &ExtendedControlRegisters) -> Result<()>;
-    ///
-    /// Triggers the running of the current virtual CPU returning an exit reason.
-    ///
-    fn run(&self) -> std::result::Result<VcpuExit, RunError>;
     #[cfg(target_arch = "x86_64")]
     ///
     /// Returns currently pending exceptions, interrupts, and NMIs as well as related
@@ -295,4 +304,9 @@ pub trait Vcpu: Send + Sync {
     /// This function is required when restoring the VM
     ///
     fn set_state(&self, state: &CpuState) -> Result<()>;
+
+    ///
+    /// Triggers the running of the current virtual CPU returning an exit reason.
+    ///
+    fn run(&self) -> std::result::Result<VmExit, HypervisorCpuError>;
 }

hypervisor/src/kvm/mod.rs

@@ -564,8 +564,51 @@ impl cpu::Vcpu for KvmVcpu {
     ///
     /// Triggers the running of the current virtual CPU returning an exit reason.
     ///
-    fn run(&self) -> std::result::Result<VcpuExit, vmm_sys_util::errno::Error> {
-        self.fd.run()
+    fn run(&self) -> std::result::Result<cpu::VmExit, cpu::HypervisorCpuError> {
+        match self.fd.run() {
+            Ok(run) => match run {
+                #[cfg(target_arch = "x86_64")]
+                VcpuExit::IoIn(addr, data) => Ok(cpu::VmExit::IoIn(addr, data)),
+                #[cfg(target_arch = "x86_64")]
+                VcpuExit::IoOut(addr, data) => Ok(cpu::VmExit::IoOut(addr, data)),
+                #[cfg(target_arch = "x86_64")]
+                VcpuExit::IoapicEoi(vector) => Ok(cpu::VmExit::IoapicEoi(vector)),
+                #[cfg(target_arch = "x86_64")]
+                VcpuExit::Shutdown | VcpuExit::Hlt => Ok(cpu::VmExit::Reset),
+
+                #[cfg(target_arch = "aarch64")]
+                VcpuExit::SystemEvent(event_type, flags) => {
+                    use kvm_bindings::KVM_SYSTEM_EVENT_SHUTDOWN;
+                    // On Aarch64, when the VM is shutdown, run() returns
+                    // VcpuExit::SystemEvent with reason KVM_SYSTEM_EVENT_SHUTDOWN
+                    if event_type == KVM_SYSTEM_EVENT_SHUTDOWN {
+                        Ok(cpu::VmExit::Reset)
+                    } else {
+                        Err(cpu::HypervisorCpuError::RunVcpu(anyhow!(
+                            "Unexpected system event with type 0x{:x}, flags 0x{:x}",
+                            event_type,
+                            flags
+                        )))
+                    }
+                }
+
+                VcpuExit::MmioRead(addr, data) => Ok(cpu::VmExit::MmioRead(addr, data)),
+                VcpuExit::MmioWrite(addr, data) => Ok(cpu::VmExit::MmioWrite(addr, data)),
+
+                r => Err(cpu::HypervisorCpuError::RunVcpu(anyhow!(
+                    "Unexpected exit reason on vcpu run: {:?}",
+                    r
+                ))),
+            },
+
+            Err(ref e) => match e.errno() {
+                libc::EAGAIN | libc::EINTR => Ok(cpu::VmExit::Ignore),
+                _ => Err(cpu::HypervisorCpuError::RunVcpu(anyhow!(
+                    "VCPU error {:?}",
+                    e
+                ))),
+            },
+        }
     }
     #[cfg(target_arch = "x86_64")]
     ///

hypervisor/src/lib.rs

@@ -22,6 +22,8 @@ extern crate serde;
 extern crate serde_derive;
 extern crate serde_json;
 extern crate thiserror;
+#[macro_use]
+extern crate anyhow;
 
 /// KVM implementation module
 pub mod kvm;
@@ -39,6 +41,6 @@ pub mod arch;
 mod cpu;
 
 pub use crate::hypervisor::{Hypervisor, HypervisorError};
-pub use cpu::{HypervisorCpuError, Vcpu};
+pub use cpu::{HypervisorCpuError, Vcpu, VmExit};
 pub use kvm::*;
 pub use vm::{DataMatch, HypervisorVmError, Vm};