2023-06-14 09:26:09 +00:00
|
|
|
// Copyright © 2023 Tencent Corporation
|
|
|
|
//
|
|
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
//
|
|
|
|
|
2023-06-15 02:27:30 +00:00
|
|
|
use anyhow::anyhow;
|
2023-06-14 13:04:07 +00:00
|
|
|
use pci::{
|
|
|
|
BarReprogrammingParams, PciBarConfiguration, PciBarPrefetchable, PciBarRegionType,
|
|
|
|
PciClassCode, PciConfiguration, PciDevice, PciDeviceError, PciHeaderType, PciSubclass,
|
2023-06-15 02:27:30 +00:00
|
|
|
PCI_CONFIGURATION_ID,
|
2023-06-14 13:04:07 +00:00
|
|
|
};
|
|
|
|
use std::any::Any;
|
|
|
|
use std::result;
|
|
|
|
use std::sync::{Arc, Barrier, Mutex};
|
2023-06-15 02:27:30 +00:00
|
|
|
use thiserror::Error;
|
|
|
|
use versionize::{VersionMap, Versionize, VersionizeResult};
|
|
|
|
use versionize_derive::Versionize;
|
2023-06-14 13:04:07 +00:00
|
|
|
use vm_allocator::{AddressAllocator, SystemAllocator};
|
|
|
|
use vm_device::{BusDevice, Resource};
|
|
|
|
use vm_memory::{Address, GuestAddress};
|
2023-06-15 02:27:30 +00:00
|
|
|
use vm_migration::{
|
|
|
|
Migratable, MigratableError, Pausable, Snapshot, Snapshottable, Transportable, VersionMapped,
|
|
|
|
};
|
2023-06-14 13:04:07 +00:00
|
|
|
|
|
|
|
const PVPANIC_VENDOR_ID: u16 = 0x1b36;
|
|
|
|
const PVPANIC_DEVICE_ID: u16 = 0x0011;
|
|
|
|
|
|
|
|
pub const PVPANIC_DEVICE_MMIO_SIZE: u64 = 0x2;
|
|
|
|
|
2023-06-14 09:26:09 +00:00
|
|
|
const PVPANIC_PANICKED: u8 = 1 << 0;
|
|
|
|
const PVPANIC_CRASH_LOADED: u8 = 1 << 1;
|
|
|
|
|
2023-06-15 02:27:30 +00:00
|
|
|
#[derive(Debug, Error)]
|
|
|
|
pub enum PvPanicError {
|
|
|
|
#[error("Failed creating PvPanicDevice: {0}")]
|
|
|
|
CreatePvPanicDevice(#[source] anyhow::Error),
|
|
|
|
#[error("Failed to retrieve PciConfigurationState: {0}")]
|
|
|
|
RetrievePciConfigurationState(#[source] anyhow::Error),
|
|
|
|
}
|
|
|
|
|
2023-06-14 13:04:07 +00:00
|
|
|
#[allow(dead_code)]
|
|
|
|
#[derive(Copy, Clone)]
|
|
|
|
pub enum PvPanicSubclass {
|
|
|
|
Other = 0x80,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl PciSubclass for PvPanicSubclass {
|
|
|
|
fn get_register_value(&self) -> u8 {
|
|
|
|
*self as u8
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-06-14 09:26:09 +00:00
|
|
|
/// A device for handling guest panic event
|
|
|
|
pub struct PvPanicDevice {
|
2023-06-14 13:04:07 +00:00
|
|
|
id: String,
|
|
|
|
events: u8,
|
|
|
|
|
|
|
|
// PCI configuration registers.
|
|
|
|
configuration: PciConfiguration,
|
|
|
|
bar_regions: Vec<PciBarConfiguration>,
|
2023-06-14 09:26:09 +00:00
|
|
|
}
|
|
|
|
|
2023-06-15 02:27:30 +00:00
|
|
|
#[derive(Versionize)]
|
|
|
|
pub struct PvPanicDeviceState {
|
|
|
|
events: u8,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl VersionMapped for PvPanicDeviceState {}
|
|
|
|
|
2023-06-14 09:26:09 +00:00
|
|
|
impl PvPanicDevice {
|
2023-06-15 02:27:30 +00:00
|
|
|
pub fn new(id: String, snapshot: Option<Snapshot>) -> Result<Self, PvPanicError> {
|
|
|
|
let pci_configuration_state =
|
|
|
|
vm_migration::versioned_state_from_id(snapshot.as_ref(), PCI_CONFIGURATION_ID)
|
|
|
|
.map_err(|e| {
|
|
|
|
PvPanicError::RetrievePciConfigurationState(anyhow!(
|
|
|
|
"Failed to get PciConfigurationState from Snapshot: {}",
|
|
|
|
e
|
|
|
|
))
|
|
|
|
})?;
|
|
|
|
|
2023-06-14 13:04:07 +00:00
|
|
|
let mut configuration = PciConfiguration::new(
|
|
|
|
PVPANIC_VENDOR_ID,
|
|
|
|
PVPANIC_DEVICE_ID,
|
|
|
|
0x1, // modern pci devices
|
|
|
|
PciClassCode::BaseSystemPeripheral,
|
|
|
|
&PvPanicSubclass::Other,
|
|
|
|
None,
|
|
|
|
PciHeaderType::Device,
|
|
|
|
0,
|
|
|
|
0,
|
|
|
|
None,
|
2023-06-15 02:27:30 +00:00
|
|
|
pci_configuration_state,
|
2023-06-14 13:04:07 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
let command: [u8; 2] = [0x03, 0x01];
|
|
|
|
configuration.write_config_register(1, 0, &command);
|
|
|
|
|
2023-06-15 02:27:30 +00:00
|
|
|
let state: Option<PvPanicDeviceState> = snapshot
|
|
|
|
.as_ref()
|
|
|
|
.map(|s| s.to_versioned_state())
|
|
|
|
.transpose()
|
|
|
|
.map_err(|e| {
|
|
|
|
PvPanicError::CreatePvPanicDevice(anyhow!(
|
|
|
|
"Failed to get PvPanicDeviceState from Snapshot: {}",
|
|
|
|
e
|
|
|
|
))
|
|
|
|
})?;
|
|
|
|
let events = if let Some(state) = state {
|
|
|
|
state.events
|
|
|
|
} else {
|
|
|
|
PVPANIC_PANICKED | PVPANIC_CRASH_LOADED
|
|
|
|
};
|
2023-06-14 09:26:09 +00:00
|
|
|
|
2023-06-15 02:27:30 +00:00
|
|
|
let pvpanic_device = PvPanicDevice {
|
2023-06-14 13:04:07 +00:00
|
|
|
id,
|
|
|
|
events,
|
|
|
|
configuration,
|
|
|
|
bar_regions: vec![],
|
2023-06-15 02:27:30 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
Ok(pvpanic_device)
|
2023-06-14 09:26:09 +00:00
|
|
|
}
|
2023-06-14 13:04:07 +00:00
|
|
|
|
|
|
|
pub fn event_to_string(&self, event: u8) -> String {
|
|
|
|
if event == PVPANIC_PANICKED {
|
|
|
|
"panic".to_string()
|
|
|
|
} else if event == PVPANIC_CRASH_LOADED {
|
|
|
|
"crash_loaded".to_string()
|
|
|
|
} else {
|
|
|
|
"unknown_event".to_string()
|
|
|
|
}
|
|
|
|
}
|
2023-06-15 02:27:30 +00:00
|
|
|
|
|
|
|
fn state(&self) -> PvPanicDeviceState {
|
|
|
|
PvPanicDeviceState {
|
|
|
|
events: self.events,
|
|
|
|
}
|
|
|
|
}
|
2023-06-15 04:02:45 +00:00
|
|
|
|
|
|
|
pub fn config_bar_addr(&self) -> u64 {
|
|
|
|
self.configuration.get_bar_addr(0)
|
|
|
|
}
|
2023-06-14 13:04:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl BusDevice for PvPanicDevice {
|
|
|
|
fn read(&mut self, base: u64, offset: u64, data: &mut [u8]) {
|
|
|
|
self.read_bar(base, offset, data)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn write(&mut self, _base: u64, _offset: u64, data: &[u8]) -> Option<Arc<Barrier>> {
|
|
|
|
let event = self.event_to_string(data[0]);
|
|
|
|
info!("pvpanic got guest event {}", event);
|
|
|
|
event!("guest", "panic", "event", &event);
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl PciDevice for PvPanicDevice {
|
|
|
|
fn write_config_register(
|
|
|
|
&mut self,
|
|
|
|
reg_idx: usize,
|
|
|
|
offset: u64,
|
|
|
|
data: &[u8],
|
|
|
|
) -> Option<Arc<Barrier>> {
|
|
|
|
self.configuration
|
|
|
|
.write_config_register(reg_idx, offset, data);
|
|
|
|
None
|
|
|
|
}
|
|
|
|
|
|
|
|
fn read_config_register(&mut self, reg_idx: usize) -> u32 {
|
|
|
|
self.configuration.read_reg(reg_idx)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn detect_bar_reprogramming(
|
|
|
|
&mut self,
|
|
|
|
reg_idx: usize,
|
|
|
|
data: &[u8],
|
|
|
|
) -> Option<BarReprogrammingParams> {
|
|
|
|
self.configuration.detect_bar_reprogramming(reg_idx, data)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn allocate_bars(
|
|
|
|
&mut self,
|
|
|
|
allocator: &Arc<Mutex<SystemAllocator>>,
|
|
|
|
_mmio_allocator: &mut AddressAllocator,
|
2023-06-15 02:27:30 +00:00
|
|
|
resources: Option<Vec<Resource>>,
|
2023-06-14 13:04:07 +00:00
|
|
|
) -> std::result::Result<Vec<PciBarConfiguration>, PciDeviceError> {
|
|
|
|
let mut bars = Vec::new();
|
|
|
|
let region_type = PciBarRegionType::Memory32BitRegion;
|
|
|
|
let bar_id = 0;
|
|
|
|
let region_size = PVPANIC_DEVICE_MMIO_SIZE;
|
2023-06-15 02:27:30 +00:00
|
|
|
let restoring = resources.is_some();
|
2023-06-14 13:04:07 +00:00
|
|
|
let bar_addr = allocator
|
|
|
|
.lock()
|
|
|
|
.unwrap()
|
|
|
|
.allocate_mmio_hole_addresses(None, region_size, None)
|
|
|
|
.ok_or(PciDeviceError::IoAllocationFailed(region_size))?;
|
|
|
|
|
|
|
|
let bar = PciBarConfiguration::default()
|
|
|
|
.set_index(bar_id as usize)
|
|
|
|
.set_address(bar_addr.raw_value())
|
|
|
|
.set_size(region_size)
|
|
|
|
.set_region_type(region_type)
|
|
|
|
.set_prefetchable(PciBarPrefetchable::NotPrefetchable);
|
|
|
|
|
|
|
|
debug!("pvpanic bar address 0x{:x}", bar_addr.0);
|
2023-06-15 02:27:30 +00:00
|
|
|
if !restoring {
|
|
|
|
self.configuration
|
|
|
|
.add_pci_bar(&bar)
|
|
|
|
.map_err(|e| PciDeviceError::IoRegistrationFailed(bar_addr.raw_value(), e))?;
|
|
|
|
}
|
|
|
|
|
2023-06-14 13:04:07 +00:00
|
|
|
bars.push(bar);
|
|
|
|
self.bar_regions = bars.clone();
|
|
|
|
|
|
|
|
Ok(bars)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn free_bars(
|
|
|
|
&mut self,
|
|
|
|
allocator: &mut SystemAllocator,
|
|
|
|
_mmio_allocator: &mut AddressAllocator,
|
|
|
|
) -> std::result::Result<(), PciDeviceError> {
|
|
|
|
for bar in self.bar_regions.drain(..) {
|
|
|
|
allocator.free_mmio_hole_addresses(GuestAddress(bar.addr()), bar.size());
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
fn move_bar(&mut self, old_base: u64, new_base: u64) -> result::Result<(), std::io::Error> {
|
|
|
|
for bar in self.bar_regions.iter_mut() {
|
|
|
|
if bar.addr() == old_base {
|
|
|
|
*bar = bar.set_address(new_base);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
fn read_bar(&mut self, _base: u64, _offset: u64, data: &mut [u8]) {
|
|
|
|
data[0] = self.events;
|
|
|
|
}
|
|
|
|
|
|
|
|
fn as_any(&mut self) -> &mut dyn Any {
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
fn id(&self) -> Option<String> {
|
|
|
|
Some(self.id.clone())
|
|
|
|
}
|
2023-06-14 09:26:09 +00:00
|
|
|
}
|
2023-06-15 02:27:30 +00:00
|
|
|
|
|
|
|
impl Pausable for PvPanicDevice {}
|
|
|
|
|
|
|
|
impl Snapshottable for PvPanicDevice {
|
|
|
|
fn id(&self) -> String {
|
|
|
|
self.id.clone()
|
|
|
|
}
|
|
|
|
|
|
|
|
fn snapshot(&mut self) -> std::result::Result<Snapshot, MigratableError> {
|
|
|
|
let mut snapshot = Snapshot::new_from_versioned_state(&self.state())?;
|
|
|
|
|
|
|
|
// Snapshot PciConfiguration
|
|
|
|
snapshot.add_snapshot(self.configuration.id(), self.configuration.snapshot()?);
|
|
|
|
|
|
|
|
Ok(snapshot)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Transportable for PvPanicDevice {}
|
|
|
|
impl Migratable for PvPanicDevice {}
|