diff --git a/src/runtime-rs/crates/hypervisor/src/ch/inner_device.rs b/src/runtime-rs/crates/hypervisor/src/ch/inner_device.rs index c4aa39e81..6b9cbff22 100644 --- a/src/runtime-rs/crates/hypervisor/src/ch/inner_device.rs +++ b/src/runtime-rs/crates/hypervisor/src/ch/inner_device.rs @@ -5,11 +5,11 @@ // SPDX-License-Identifier: Apache-2.0 use super::inner::CloudHypervisorInner; +use crate::device::pci_path::PciPath; use crate::device::DeviceType; use crate::HybridVsockDevice; use crate::NetworkConfig; use crate::NetworkDevice; -use crate::PciPath; use crate::ShareFsConfig; use crate::ShareFsDevice; use crate::VfioDevice; diff --git a/src/runtime-rs/crates/hypervisor/src/device/driver/mod.rs b/src/runtime-rs/crates/hypervisor/src/device/driver/mod.rs index 8ccc3dfc6..3e51d48a3 100644 --- a/src/runtime-rs/crates/hypervisor/src/device/driver/mod.rs +++ b/src/runtime-rs/crates/hypervisor/src/device/driver/mod.rs @@ -29,182 +29,3 @@ pub use virtio_vsock::{ pub mod vhost_user_blk; pub use vhost_user::{VhostUserConfig, VhostUserDevice, VhostUserType}; - -use anyhow::{anyhow, Context, Result}; - -// Tips: -// The Re-write `PciSlot` and `PciPath` with rust that it origins from `pcipath.go`: -// - -// The PCI spec reserves 5 bits for slot number (a.k.a. device -// number), giving slots 0..31 -const PCI_SLOT_BITS: u32 = 5; -const MAX_PCI_SLOTS: u32 = (1 << PCI_SLOT_BITS) - 1; - -// A PciSlot describes where a PCI device sits on a single bus -// -// This encapsulates the PCI slot number a.k.a device number, which is -// limited to a 5 bit value [0x00..0x1f] by the PCI specification -// -// To support multifunction device's, It's needed to extend -// this to include the PCI 3-bit function number as well. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct PciSlot(pub u8); - -impl PciSlot { - pub fn convert_from_string(s: &str) -> Result { - if s.is_empty() || s.len() > 2 { - return Err(anyhow!("string given is invalid.")); - } - - let base = 16; - let n = u64::from_str_radix(s, base).context("convert string to number failed")?; - if n >> PCI_SLOT_BITS > 0 { - return Err(anyhow!( - "number {:?} exceeds MAX:{:?}, failed.", - n, - MAX_PCI_SLOTS - )); - } - - Ok(PciSlot(n as u8)) - } - - pub fn convert_from_u32(v: u32) -> Result { - if v > MAX_PCI_SLOTS { - return Err(anyhow!("value {:?} exceeds MAX: {:?}", v, MAX_PCI_SLOTS)); - } - - Ok(PciSlot(v as u8)) - } - - pub fn convert_to_string(&self) -> String { - format!("{:02x}", self.0) - } -} - -// A PciPath describes where a PCI sits in a PCI hierarchy. -// -// Consists of a list of PCI slots, giving the slot of each bridge -// that must be traversed from the PCI root to reach the device, -// followed by the slot of the device itself. -// -// When formatted into a string is written as "xx/.../yy/zz". Here, -// zz is the slot of the device on its PCI bridge, yy is the slot of -// the bridge on its parent bridge and so forth until xx is the slot -// of the "most upstream" bridge on the root bus. -// -// If a device is directly connected to the root bus, which used in -// lightweight hypervisors, such as dragonball/firecracker/clh, and -// its PciPath.slots will contains only one PciSlot. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct PciPath { - // list of PCI slots - slots: Vec, -} - -impl PciPath { - // method to format the PciPath into a string - pub fn convert_to_string(&self) -> String { - self.slots - .iter() - .map(|pci_slot| format!("{:02x}", pci_slot.0)) - .collect::>() - .join("/") - } - - // method to parse a PciPath from a string - pub fn convert_from_string(path: &str) -> Result { - if path.is_empty() { - return Err(anyhow!("path given is empty.")); - } - - let mut pci_slots: Vec = Vec::new(); - let slots: Vec<&str> = path.split('/').collect(); - for slot in slots { - match PciSlot::convert_from_string(slot) { - Ok(s) => pci_slots.push(s), - Err(e) => return Err(anyhow!("slot is invalid with: {:?}", e)), - } - } - - Ok(PciPath { slots: pci_slots }) - } - - pub fn from_pci_slots(slots: Vec) -> Option { - if slots.is_empty() { - return None; - } - - Some(PciPath { slots }) - } - - // device_slot to get the slot of the device on its PCI bridge - pub fn get_device_slot(&self) -> Option { - self.slots.last().cloned() - } - - // root_slot to get the slot of the "most upstream" bridge on the root bus - pub fn get_root_slot(&self) -> Option { - self.slots.first().cloned() - } -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn test_pci_slot() { - // min - let pci_slot_01 = PciSlot::convert_from_string("00"); - assert!(pci_slot_01.is_ok()); - // max - let pci_slot_02 = PciSlot::convert_from_string("1f"); - assert!(pci_slot_02.is_ok()); - - // exceed - let pci_slot_03 = PciSlot::convert_from_string("20"); - assert!(pci_slot_03.is_err()); - - // valid number - let pci_slot_04 = PciSlot::convert_from_u32(1_u32); - assert!(pci_slot_04.is_ok()); - assert_eq!(pci_slot_04.as_ref().unwrap().0, 1_u8); - let pci_slot_str = pci_slot_04.as_ref().unwrap().convert_to_string(); - assert_eq!(pci_slot_str, format!("{:02x}", pci_slot_04.unwrap().0)); - - // max number - let pci_slot_05 = PciSlot::convert_from_u32(31_u32); - assert!(pci_slot_05.is_ok()); - assert_eq!(pci_slot_05.unwrap().0, 31_u8); - - // exceed and error - let pci_slot_06 = PciSlot::convert_from_u32(32_u32); - assert!(pci_slot_06.is_err()); - } - - #[test] - fn test_pci_patch() { - let pci_path_0 = PciPath::convert_from_string("01/0a/05"); - assert!(pci_path_0.is_ok()); - let pci_path_unwrap = pci_path_0.unwrap(); - assert_eq!(pci_path_unwrap.slots[0].0, 1); - assert_eq!(pci_path_unwrap.slots[1].0, 10); - assert_eq!(pci_path_unwrap.slots[2].0, 5); - - let pci_path_01 = PciPath::from_pci_slots(vec![PciSlot(1), PciSlot(10), PciSlot(5)]); - assert!(pci_path_01.is_some()); - let pci_path = pci_path_01.unwrap(); - let pci_path_02 = pci_path.convert_to_string(); - assert_eq!(pci_path_02, "01/0a/05".to_string()); - - let dev_slot = pci_path.get_device_slot(); - assert!(dev_slot.is_some()); - assert_eq!(dev_slot.unwrap().0, 5); - - let root_slot = pci_path.get_root_slot(); - assert!(root_slot.is_some()); - assert_eq!(root_slot.unwrap().0, 1); - } -} diff --git a/src/runtime-rs/crates/hypervisor/src/device/driver/vfio.rs b/src/runtime-rs/crates/hypervisor/src/device/driver/vfio.rs index be1eb3cb5..e48828184 100644 --- a/src/runtime-rs/crates/hypervisor/src/device/driver/vfio.rs +++ b/src/runtime-rs/crates/hypervisor/src/device/driver/vfio.rs @@ -20,12 +20,14 @@ use async_trait::async_trait; use lazy_static::lazy_static; use path_clean::PathClean; -use crate::{ - device::{hypervisor, Device, DeviceType}, - PciPath, PciSlot, -}; use kata_sys_util::fs::get_base_name; +use crate::device::{ + hypervisor, + pci_path::{PciPath, PciSlot}, + Device, DeviceType, +}; + pub const SYS_BUS_PCI_DRIVER_PROBE: &str = "/sys/bus/pci/drivers_probe"; pub const SYS_BUS_PCI_DEVICES: &str = "/sys/bus/pci/devices"; pub const SYS_KERN_IOMMU_GROUPS: &str = "/sys/kernel/iommu_groups"; diff --git a/src/runtime-rs/crates/hypervisor/src/device/driver/virtio_blk.rs b/src/runtime-rs/crates/hypervisor/src/device/driver/virtio_blk.rs index a93f8553d..f16fe8eb0 100644 --- a/src/runtime-rs/crates/hypervisor/src/device/driver/virtio_blk.rs +++ b/src/runtime-rs/crates/hypervisor/src/device/driver/virtio_blk.rs @@ -4,10 +4,10 @@ // SPDX-License-Identifier: Apache-2.0 // +use crate::device::pci_path::PciPath; use crate::device::Device; use crate::device::DeviceType; use crate::Hypervisor as hypervisor; -use crate::PciPath; use anyhow::{anyhow, Context, Result}; use async_trait::async_trait; diff --git a/src/runtime-rs/crates/hypervisor/src/device/mod.rs b/src/runtime-rs/crates/hypervisor/src/device/mod.rs index 71b9575db..7ad69b2e7 100644 --- a/src/runtime-rs/crates/hypervisor/src/device/mod.rs +++ b/src/runtime-rs/crates/hypervisor/src/device/mod.rs @@ -17,6 +17,7 @@ use async_trait::async_trait; pub mod device_manager; pub mod driver; +pub mod pci_path; pub mod util; #[derive(Debug)] diff --git a/src/runtime-rs/crates/hypervisor/src/device/pci_path.rs b/src/runtime-rs/crates/hypervisor/src/device/pci_path.rs new file mode 100644 index 000000000..dea8c0a43 --- /dev/null +++ b/src/runtime-rs/crates/hypervisor/src/device/pci_path.rs @@ -0,0 +1,184 @@ +// Copyright (c) 2019-2023 Alibaba Cloud +// Copyright (c) 2019-2023 Ant Group +// +// SPDX-License-Identifier: Apache-2.0 +// + +use anyhow::{anyhow, Context, Result}; + +// Tips: +// The Re-write `PciSlot` and `PciPath` with rust that it origins from `pcipath.go`: +// + +// The PCI spec reserves 5 bits for slot number (a.k.a. device +// number), giving slots 0..31 +const PCI_SLOT_BITS: u32 = 5; +const MAX_PCI_SLOTS: u32 = (1 << PCI_SLOT_BITS) - 1; + +// A PciSlot describes where a PCI device sits on a single bus +// +// This encapsulates the PCI slot number a.k.a device number, which is +// limited to a 5 bit value [0x00..0x1f] by the PCI specification +// +// To support multifunction device's, It's needed to extend +// this to include the PCI 3-bit function number as well. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct PciSlot(pub u8); + +impl PciSlot { + pub fn convert_from_string(s: &str) -> Result { + if s.is_empty() || s.len() > 2 { + return Err(anyhow!("string given is invalid.")); + } + + let base = 16; + let n = u64::from_str_radix(s, base).context("convert string to number failed")?; + if n >> PCI_SLOT_BITS > 0 { + return Err(anyhow!( + "number {:?} exceeds MAX:{:?}, failed.", + n, + MAX_PCI_SLOTS + )); + } + + Ok(PciSlot(n as u8)) + } + + pub fn convert_from_u32(v: u32) -> Result { + if v > MAX_PCI_SLOTS { + return Err(anyhow!("value {:?} exceeds MAX: {:?}", v, MAX_PCI_SLOTS)); + } + + Ok(PciSlot(v as u8)) + } + + pub fn convert_to_string(&self) -> String { + format!("{:02x}", self.0) + } +} + +// A PciPath describes where a PCI sits in a PCI hierarchy. +// +// Consists of a list of PCI slots, giving the slot of each bridge +// that must be traversed from the PCI root to reach the device, +// followed by the slot of the device itself. +// +// When formatted into a string is written as "xx/.../yy/zz". Here, +// zz is the slot of the device on its PCI bridge, yy is the slot of +// the bridge on its parent bridge and so forth until xx is the slot +// of the "most upstream" bridge on the root bus. +// +// If a device is directly connected to the root bus, which used in +// lightweight hypervisors, such as dragonball/firecracker/clh, and +// its PciPath.slots will contains only one PciSlot. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct PciPath { + // list of PCI slots + pub slots: Vec, +} + +impl PciPath { + // method to format the PciPath into a string + pub fn convert_to_string(&self) -> String { + self.slots + .iter() + .map(|pci_slot| format!("{:02x}", pci_slot.0)) + .collect::>() + .join("/") + } + + // method to parse a PciPath from a string + pub fn convert_from_string(path: &str) -> Result { + if path.is_empty() { + return Err(anyhow!("path given is empty.")); + } + + let mut pci_slots: Vec = Vec::new(); + let slots: Vec<&str> = path.split('/').collect(); + for slot in slots { + match PciSlot::convert_from_string(slot) { + Ok(s) => pci_slots.push(s), + Err(e) => return Err(anyhow!("slot is invalid with: {:?}", e)), + } + } + + Ok(PciPath { slots: pci_slots }) + } + + pub fn from_pci_slots(slots: Vec) -> Option { + if slots.is_empty() { + return None; + } + + Some(PciPath { slots }) + } + + // device_slot to get the slot of the device on its PCI bridge + pub fn get_device_slot(&self) -> Option { + self.slots.last().cloned() + } + + // root_slot to get the slot of the "most upstream" bridge on the root bus + pub fn get_root_slot(&self) -> Option { + self.slots.first().cloned() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_pci_slot() { + // min + let pci_slot_01 = PciSlot::convert_from_string("00"); + assert!(pci_slot_01.is_ok()); + // max + let pci_slot_02 = PciSlot::convert_from_string("1f"); + assert!(pci_slot_02.is_ok()); + + // exceed + let pci_slot_03 = PciSlot::convert_from_string("20"); + assert!(pci_slot_03.is_err()); + + // valid number + let pci_slot_04 = PciSlot::convert_from_u32(1_u32); + assert!(pci_slot_04.is_ok()); + assert_eq!(pci_slot_04.as_ref().unwrap().0, 1_u8); + let pci_slot_str = pci_slot_04.as_ref().unwrap().convert_to_string(); + assert_eq!(pci_slot_str, format!("{:02x}", pci_slot_04.unwrap().0)); + + // max number + let pci_slot_05 = PciSlot::convert_from_u32(31_u32); + assert!(pci_slot_05.is_ok()); + assert_eq!(pci_slot_05.unwrap().0, 31_u8); + + // exceed and error + let pci_slot_06 = PciSlot::convert_from_u32(32_u32); + assert!(pci_slot_06.is_err()); + } + + #[test] + fn test_pci_patch() { + let pci_path_0 = PciPath::convert_from_string("01/0a/05"); + assert!(pci_path_0.is_ok()); + let pci_path_unwrap = pci_path_0.unwrap(); + assert_eq!(pci_path_unwrap.slots[0].0, 1); + assert_eq!(pci_path_unwrap.slots[1].0, 10); + assert_eq!(pci_path_unwrap.slots[2].0, 5); + + let pci_path_01 = PciPath::from_pci_slots(vec![PciSlot(1), PciSlot(10), PciSlot(5)]); + assert!(pci_path_01.is_some()); + let pci_path = pci_path_01.unwrap(); + let pci_path_02 = pci_path.convert_to_string(); + assert_eq!(pci_path_02, "01/0a/05".to_string()); + + let dev_slot = pci_path.get_device_slot(); + assert!(dev_slot.is_some()); + assert_eq!(dev_slot.unwrap().0, 5); + + let root_slot = pci_path.get_root_slot(); + assert!(root_slot.is_some()); + assert_eq!(root_slot.unwrap().0, 1); + } +}