libamdgpu_top 0.11.3

A library for amdgpu_top
Documentation
use crate::{
    LibDrmAmdgpu,
    AMDGPU::{
        self,
        DeviceHandle,
        GfxTargetVersion,
    },
    PCI,
};
use crate::stat::ProcInfo;
use std::path::PathBuf;
use std::{fs, io};
use std::fmt;
use std::sync::{Arc, Mutex};
use std::os::unix::io::RawFd;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DeviceType {
    AMDGPU,
    AMDXDNA,
}

#[derive(Clone)]
pub struct DevicePath {
    pub libdrm_amdgpu: Option<LibDrmAmdgpu>,
    pub render: PathBuf,
    pub card: PathBuf,
    pub accel: PathBuf,
    pub pci: PCI::BUS_INFO,
    pub sysfs_path: PathBuf,
    pub device_id: Option<u32>,
    pub revision_id: Option<u32>,
    pub device_name: String,
    pub arc_proc_index: Arc<Mutex<Vec<ProcInfo>>>,
    pub config_pm: bool,
    pub device_type: DeviceType,
}

impl DevicePath {
    pub fn init(&self) -> Result<DeviceHandle, i32> {
        let (amdgpu_dev, _major, _minor) = {
            let libdrm_amdgpu = self.libdrm_amdgpu
                .as_ref()
                .expect("Error loading libdrm.so and libdrm_amdgpu.so");
            let fd = self.get_fd().unwrap_or_else(|err| {
                eprintln!("{err:#}");
                eprintln!("{:#X?}", self);
                panic!();
            });

            libdrm_amdgpu.init_device_handle(fd)?
        };

        Ok(amdgpu_dev)
    }

    pub fn get_fd(&self) -> io::Result<RawFd> {
        use std::os::unix::io::IntoRawFd;

        let device = if self.is_amdgpu() {
            &self.render
        } else {
            &self.accel
        };

        // need write option for GUI context
        // https://gitlab.freedesktop.org/mesa/mesa/-/issues/2424
        fs::OpenOptions::new()
            .read(true)
            .write(true)
            .open(device)
            .map(|f| f.into_raw_fd())
    }

    pub fn get_device_path_list() -> Vec<Self> {
        let libdrm_amdgpu = LibDrmAmdgpu::new().ok();
        let amdgpu_devices = fs::read_dir("/sys/bus/pci/drivers/amdgpu/").unwrap_or_else(|_| {
            eprintln!("The AMDGPU driver is not loaded.");
            panic!();
        });

        amdgpu_devices.flat_map(|v| {
            let name = v.ok()?.file_name();

            /* 0000:00:00.0 */
            if name.len() != 12 { return None; }

            let pci = name.into_string().ok()?.parse::<PCI::BUS_INFO>().ok()?;

            Self::try_from(pci).ok()
                .map(|mut v| {
                    v.libdrm_amdgpu = libdrm_amdgpu.clone();
                    v.fill_amdgpu_device_name();
                    v
                })
        }).collect()
    }

    pub fn fill_amdgpu_device_name(&mut self) {
        if let [Some(did), Some(rid)] = [self.device_id, self.revision_id] {
            self.device_name = AMDGPU::find_device_name(did, rid)
                .unwrap_or(AMDGPU::DEFAULT_DEVICE_NAME.to_string());
        }
    }

    pub fn get_gfx_target_version_from_kfd(&self) -> Option<GfxTargetVersion> {
        let drm_render_minor = {
            const PRE: &str = "/dev/dri/renderD";
            const PRE_LEN: usize = PRE.len();
            let render = self.render.to_str()?;
            if !render.starts_with(PRE) { return None }

            format!("drm_render_minor {}", &render.get(PRE_LEN..)?)
        };

        let dirs = fs::read_dir("/sys/class/kfd/kfd/topology/nodes/").ok()?;
        let mut gfx_target_version = String::new();

        'node: for dir_entry in dirs.flatten() {
            let Ok(s) = fs::read_to_string(dir_entry.path().join("properties")) else {
                continue
            };
            let mut lines = s.lines();
            let Some(ver_str) = lines
                .find(|&l| l.starts_with("gfx_target_version")) else { continue };

            if lines.any(|l| l.starts_with(&drm_render_minor)) {
                gfx_target_version = ver_str.to_string();
                break 'node;
            }
        }

        const PRE_GFX_VER_LEN: usize = "gfx_target_version ".len();
        let gfx_target_version: u32 = gfx_target_version.get(PRE_GFX_VER_LEN..)?.parse().ok()?;

        Some(GfxTargetVersion::from(gfx_target_version))
    }

    pub fn check_if_device_is_active(&self) -> bool {
        // for env where CONFIG_PM is disabled
        if !self.config_pm {
            return true;
        }

        let path = self.sysfs_path.join("power/runtime_status");
        let Ok(s) = std::fs::read_to_string(path) else { return false };

        s.starts_with("active")
    }

    pub fn menu_entry(&self) -> String {
        format!("{} ({})", self.device_name, self.pci)
    }

    pub fn is_amdgpu(&self) -> bool {
        self.device_type == DeviceType::AMDGPU
    }

    pub fn is_xdna(&self) -> bool {
        self.device_type == DeviceType::AMDXDNA
    }
}

impl TryFrom<PCI::BUS_INFO> for DevicePath {
    type Error = std::io::Error;

    fn try_from(pci: PCI::BUS_INFO) -> Result<Self, Self::Error> {
        let render = pci.get_drm_render_path()?;
        let card = pci.get_drm_card_path()?;
        let accel = PathBuf::new();
        let sysfs_path = pci.get_sysfs_path();
        let [device_id, revision_id] = [pci.get_device_id(), pci.get_revision_id()];
        let device_name = String::new();
        let arc_proc_index = Arc::new(Mutex::new(Vec::new()));
        let config_pm = sysfs_path.join("power").exists();

        Ok(Self {
            libdrm_amdgpu: None,
            render,
            card,
            accel,
            pci,
            sysfs_path,
            device_id,
            revision_id,
            device_name,
            arc_proc_index,
            config_pm,
            device_type: DeviceType::AMDGPU,
        })
    }
}

impl fmt::Debug for DevicePath {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("DevicePath")
            .field("render", &self.render)
            .field("card", &self.card)
            .field("accel", &self.accel)
            .field("pci", &self.pci.to_string())
            .field("sysfs_path", &self.sysfs_path)
            .field("device_id", &self.device_id)
            .field("revision_id", &self.revision_id)
            .field("device_name", &self.device_name)
            .field("device_type", &self.device_type)
            .finish()
    }
}