Struct furiosa_device::Device

pub struct Device { /* private fields */ }

Abstraction for a single Furiosa NPU device.

About Furiosa NPU

A Furiosa NPU device contains a number of cores and offers several ways called DeviceMode to combine multiple cores to a single logical device, as following:

• Single: A logical device is composed of a single core.
• Fusion: Multiple cores work together as if they were one device. This mode is useful when a DNN model requires much computation power and large memory capacity.
• MultiCore: A logical device uses multiple cores, each of which communicates to one another through interconnect. In this mode, partitions of a model or multiple models can be pipelined. (See DeviceConfig and find_device_files).

Hence a Furiosa NPU device exposes several devfs files for each purpose above. They can be listed by calling dev_files method, which returns a list of DeviceFiles. Each DeviceFile again offers mode method to identify its DeviceMode.

Implementations

impl Device

pub fn name(&self) -> String

Returns the name of the device (e.g., npu0).

pub fn device_index(&self) -> u8

Returns the device index (e.g., 0 for npu0).

pub fn arch(&self) -> Arch

Returns Arch of the device(e.g., Warboy).

pub fn alive(&self) -> DeviceResult<bool>

Returns a liveness state of the device.

pub fn atr_error(&self) -> DeviceResult<HashMap<String, u32>>

Returns error states of the device.

pub fn busname(&self) -> DeviceResult<String>

Returns PCI bus number of the device.

pub fn pci_dev(&self) -> DeviceResult<String>

Returns PCI device ID of the device.

pub fn device_sn(&self) -> DeviceResult<String>

Returns serial number of the device.

pub fn device_uuid(&self) -> DeviceResult<String>

Returns UUID of the device.

pub fn firmware_version(&self) -> DeviceResult<String>

Retrieves firmware revision from the device.

pub fn driver_version(&self) -> DeviceResult<String>

Retrieves driver version for the device.

pub fn heartbeat(&self) -> DeviceResult<u32>

Returns uptime of the device.

pub fn clock_frequency(&self) -> DeviceResult<Vec<ClockFrequency>>

Returns clock frequencies of components in the device.

pub fn numa_node(&self) -> DeviceResult<NumaNode>

Retrieve NUMA node ID associated with the NPU’s PCI lane

pub fn core_num(&self) -> u8

Counts the number of cores.

pub fn cores(&self) -> &Vec<u8>

List the core indices.

pub fn dev_files(&self) -> &Vec<DeviceFile>

List device files under this device.

pub fn performance_counters(&self) -> Vec<(&DeviceFile, PerformanceCounter)>

List performance counters for each device files.

pub async fn get_status_core(&self, core: u8) -> DeviceResult<CoreStatus>

Examine a specific core of the device, whether it is available or not.

pub async fn get_status_all(&self) -> DeviceResult<HashMap<u8, CoreStatus>>

Examine each core of the device, whether it is available or not.

pub fn get_hwmon_fetcher(&self) -> &Fetcher

Returns Fetcher for hwmon metric of the device.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Device

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Device> for Device

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Device> for Device

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Device