Struct amdgpu_sysfs::gpu_handle::GpuHandle

pub struct GpuHandle {
    pub hw_monitors: Vec<HwMon>,
    /* private fields */
}

A GpuHandle represents a handle over a single GPU device, as exposed in the Linux SysFS.

Fields

hw_monitors: Vec<HwMon>

A collection of all HwMons bound to this GPU. They are used to expose real-time data.

Implementations

impl GpuHandle

pub async fn new_from_path(sysfs_path: PathBuf) -> Result<Self, GpuHandleError>

Initializes a new GpuHandle from a given SysFS device path.

Normally, the path should look akin to /sys/class/drm/card0/device, and it needs to at least contain a uevent file.

pub async fn get_driver(&self) -> &str

Gets the kernel driver used.

pub fn get_pci_id(&self) -> Option<(&str, &str)>

Gets the GPU’s PCI vendor and ID. This is the ID of your GPU chip, e.g. AMD Radeon RX 580.

pub fn get_pci_subsys_id(&self) -> Option<(&str, &str)>

Gets the Card’s PCI vendor and ID. This is the ID of your card model, e.g. Sapphire RX 580 Pulse.

pub fn get_pci_slot_name(&self) -> Option<&str>

pub async fn get_current_link_speed(&self) -> Option<String>

pub async fn get_current_link_width(&self) -> Option<String>

pub async fn get_max_link_speed(&self) -> Option<String>

pub async fn get_max_link_width(&self) -> Option<String>

pub async fn get_total_vram(&self) -> Option<u64>

Gets total VRAM size in bytes. May not be reported on some devices, such as integrated GPUs.

pub async fn get_used_vram(&self) -> Option<u64>

Gets how much VRAM is currently used, in bytes. May not be reported on some devices, such as integrated GPUs.

pub async fn get_busy_percent(&self) -> Option<u8>

Returns the GPU busy percentage.

pub async fn get_vbios_version(&self) -> Option<String>

Returns the GPU VBIOS version. Empty if the GPU doesn’t report one.

pub async fn get_power_force_performance_level(
    &self
) -> Option<PerformanceLevel>

Returns the currently forced performance level.

pub async fn set_power_force_performance_level(
    &self,
    level: PerformanceLevel
) -> Result<(), GpuHandleError>

Forces a given performance level.

pub async fn get_power_levels(
    &self,
    kind: PowerStateKind
) -> Option<(Vec<String>, u8)>

Retuns the list of power levels and index of the currently active level for a given kind of power state.

pub async fn set_enabled_power_levels(
    &self,
    kind: PowerStateKind,
    levels: &[u8]
) -> Result<(), GpuHandleError>

Sets the enabled power levels for a power state kind to a given list of levels. This means that only the given power levels will be allowed.

Can only be used if power_force_performance_level is set to manual.

Trait Implementations

impl Clone for GpuHandle

fn clone(&self) -> GpuHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GpuHandle

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

Formats the value using the given formatter.

impl SysFS for GpuHandle

fn get_path(&self) -> &Path

fn read_file<'life0, 'life1, 'async_trait>(
    &'life0 self,
    file: &'life1 str
) -> Pin<Box<dyn Future<Output = Option<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Reads the content of a file in the SysFS.

fn write_file<'life0, 'life1, 'async_trait, C>(
    &'life0 self,
    file: &'life1 str,
    contents: C
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    C: 'async_trait + AsRef<[u8]> + Send,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Write to a file in the SysFS.