mirror of
https://github.com/cloud-hypervisor/cloud-hypervisor.git
synced 2024-09-17 20:44:55 +00:00
145 lines
4.6 KiB
Rust
145 lines
4.6 KiB
Rust
|
// Copyright © 2019 Intel Corporation
|
||
|
//
|
||
|
// SPDX-License-Identifier: Apache-2.0
|
||
|
//
|
||
|
// Copyright © 2020, Microsoft Corporation
|
||
|
//
|
||
|
// Copyright 2018-2019 CrowdStrike, Inc.
|
||
|
//
|
||
|
//
|
||
|
|
||
|
#[cfg(target_arch = "aarch64")]
|
||
|
use crate::aarch64::VcpuInit;
|
||
|
use crate::cpu::Vcpu;
|
||
|
use crate::{CreateDevice, DeviceFd, IoEventAddress, IrqRouting, MemoryRegion};
|
||
|
use std::sync::Arc;
|
||
|
use thiserror::Error;
|
||
|
use vmm_sys_util::eventfd::EventFd;
|
||
|
|
||
|
///
|
||
|
/// I/O events data matches (32 or 64 bits).
|
||
|
///
|
||
|
pub enum DataMatch {
|
||
|
DataMatch32(u32),
|
||
|
DataMatch64(u64),
|
||
|
}
|
||
|
|
||
|
impl Into<u64> for DataMatch {
|
||
|
fn into(self) -> u64 {
|
||
|
match self {
|
||
|
DataMatch::DataMatch32(dm) => dm.into(),
|
||
|
DataMatch::DataMatch64(dm) => dm,
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
#[derive(Error, Debug)]
|
||
|
///
|
||
|
/// Enum for VM error
|
||
|
pub enum HypervisorVmError {
|
||
|
///
|
||
|
/// Create Vcpu error
|
||
|
///
|
||
|
#[error("Failed to create Vcpu: {0}")]
|
||
|
CreateVcpu(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// TSS address error
|
||
|
///
|
||
|
#[error("Failed to set TSS address: {0}")]
|
||
|
SetTssAddress(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Create interrupt controller error
|
||
|
///
|
||
|
#[error("Failed to create interrupt controller: {0}")]
|
||
|
CreateIrq(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Register interrupt event error
|
||
|
///
|
||
|
#[error("Failed to register interrupt event: {0}")]
|
||
|
RegisterIrqFd(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Un register interrupt event error
|
||
|
///
|
||
|
#[error("Failed to unregister interrupt event: {0}")]
|
||
|
UnregisterIrqFd(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Register IO event error
|
||
|
///
|
||
|
#[error("Failed to register IO event: {0}")]
|
||
|
RegisterIoEvent(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Unregister IO event error
|
||
|
///
|
||
|
#[error("Failed to unregister IO event: {0}")]
|
||
|
UnregisterIoEvent(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Set GSI routing error
|
||
|
///
|
||
|
#[error("Failed to set GSI routing: {0}")]
|
||
|
SetGsiRouting(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Set user memory error
|
||
|
///
|
||
|
#[error("Failed to set user memory: {0}")]
|
||
|
SetUserMemory(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Create device error
|
||
|
///
|
||
|
#[error("Failed to set GSI routing: {0}")]
|
||
|
CreateDevice(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Get preferred target error
|
||
|
///
|
||
|
#[error("Failed to get preferred target: {0}")]
|
||
|
GetPreferredTarget(#[source] anyhow::Error),
|
||
|
///
|
||
|
/// Enable split Irq error
|
||
|
///
|
||
|
#[error("Failed to enable split Irq: {0}")]
|
||
|
EnableSplitIrq(#[source] anyhow::Error),
|
||
|
}
|
||
|
///
|
||
|
/// Result type for returning from a function
|
||
|
///
|
||
|
pub type Result<T> = std::result::Result<T, HypervisorVmError>;
|
||
|
|
||
|
///
|
||
|
/// Trait to represent a Vm
|
||
|
///
|
||
|
/// This crate provides a hypervisor-agnostic interfaces for Vm
|
||
|
///
|
||
|
pub trait Vm: Send + Sync {
|
||
|
#[cfg(target_arch = "x86_64")]
|
||
|
/// Sets the address of the three-page region in the VM's address space.
|
||
|
fn set_tss_address(&self, offset: usize) -> Result<()>;
|
||
|
/// Creates an in-kernel interrupt controller.
|
||
|
fn create_irq_chip(&self) -> Result<()>;
|
||
|
/// Registers an event that will, when signaled, trigger the `gsi` IRQ.
|
||
|
fn register_irqfd(&self, fd: &EventFd, gsi: u32) -> Result<()>;
|
||
|
/// Unregister an event that will, when signaled, trigger the `gsi` IRQ.
|
||
|
fn unregister_irqfd(&self, fd: &EventFd, gsi: u32) -> Result<()>;
|
||
|
/// Creates a new KVM vCPU file descriptor and maps the memory corresponding
|
||
|
fn create_vcpu(&self, id: u8) -> Result<Arc<dyn Vcpu>>;
|
||
|
/// Registers an event to be signaled whenever a certain address is written to.
|
||
|
fn register_ioevent(
|
||
|
&self,
|
||
|
fd: &EventFd,
|
||
|
addr: &IoEventAddress,
|
||
|
datamatch: Option<DataMatch>,
|
||
|
) -> Result<()>;
|
||
|
/// Unregister an event from a certain address it has been previously registered to.
|
||
|
fn unregister_ioevent(&self, fd: &EventFd, addr: &IoEventAddress) -> Result<()>;
|
||
|
/// Sets the GSI routing table entries, overwriting any previously set
|
||
|
fn set_gsi_routing(&self, irq_routing: &IrqRouting) -> Result<()>;
|
||
|
/// Creates/modifies a guest physical memory slot.
|
||
|
fn set_user_memory_region(&self, user_memory_region: MemoryRegion) -> Result<()>;
|
||
|
/// Creates an emulated device in the kernel.
|
||
|
fn create_device(&self, device: &mut CreateDevice) -> Result<DeviceFd>;
|
||
|
/// Returns the preferred CPU target type which can be emulated by KVM on underlying host.
|
||
|
#[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
|
||
|
fn get_preferred_target(&self, kvi: &mut VcpuInit) -> Result<()>;
|
||
|
/// Enable split Irq capability
|
||
|
#[cfg(target_arch = "x86_64")]
|
||
|
fn enable_split_irq(&self) -> Result<()>;
|
||
|
}
|