cloud-hypervisor/arch/src/aarch64/gic.rs

// Copyright 2021 Arm Limited (or its affiliates). All rights reserved.

use hypervisor::{arch::aarch64::gic::Vgic, CpuState};
use std::result;
use std::sync::Arc;
use vm_migration::{
    Migratable, MigratableError, Pausable, Snapshot, Snapshottable, Transportable, VersionMapped,
};

/// Errors thrown while setting up the GIC.
#[derive(Debug)]
pub enum Error {
    CreateGic(hypervisor::HypervisorVmError),
}
type Result<T> = result::Result<T, Error>;

/// A wrapper around creating and using a hypervisor-agnostic vgic.
pub struct GicDevice {
    // The hypervisor abstracted GIC.
    vgic: Box<dyn Vgic>,
}

impl GicDevice {
    pub fn new(vm: &Arc<dyn hypervisor::Vm>, vcpu_count: u64) -> Result<GicDevice> {
        let vgic = vm
            .create_vgic(
                vcpu_count,
                layout::GIC_V3_DIST_START.raw_value(),
                layout::GIC_V3_DIST_SIZE,
                layout::GIC_V3_REDIST_SIZE,
                layout::GIC_V3_ITS_SIZE,
                layout::IRQ_NUM,
            )
            .unwrap();
        Ok(GicDevice { vgic })
    }

    pub fn set_gicr_typers(&mut self, vcpu_states: &[CpuState]) {}

    pub fn get_vgic(&self) -> &dyn Vgic {
        &*self.vgic
    }
}

pub const GIC_V3_ITS_SNAPSHOT_ID: &str = "gic-v3-its";
impl Snapshottable for GicDevice {
    fn id(&self) -> String {
        GIC_V3_ITS_SNAPSHOT_ID.to_string()
    }

    fn snapshot(&mut self) -> std::result::Result<Snapshot, MigratableError> {
        let state = self.vgic.state().unwrap();
        Snapshot::new_from_state(&self.id(), &state)
    }

    fn restore(&mut self, snapshot: Snapshot) -> std::result::Result<(), MigratableError> {
        self.vgic.set_state(&snapshot.to_state(&self.id())?)
            .map_err(|e| {
                MigratableError::Restore(anyhow!("Could not restore GICv3ITS state {:?}", e))
            })
        Ok(())
    }
}

impl Pausable for GicDevice {
    fn pause(&mut self) -> std::result::Result<(), MigratableError> {
        /*
                // Flush redistributors pending tables to guest RAM.
                KvmGicDevice::save_pending_tables(self.device()).map_err(|e| {
                    MigratableError::Pause(anyhow!(
                        "Could not save GICv3ITS GIC pending tables {:?}",
                        e
                    ))
                })?;
                // Flush ITS tables to guest RAM.
                gicv3_its_tables_access(self.its_device().unwrap(), true).map_err(|e| {
                    MigratableError::Pause(anyhow!("Could not save GICv3ITS ITS tables {:?}", e))
                })?;
        */
        Ok(())
    }
}
impl Transportable for GicDevice {}
impl Migratable for GicDevice {}