hippox-drivers 0.3.5

🦛All indivisible atomic driver units in Hippox.
//! GPU usage driver
//!
//! This driver provides functionality to get current GPU usage percentage.
use crate::{
    DriverCallback, DriverCategory, DriverContext, DriverError, DriverResult,
    types::{Driver, DriverParameter},
};
use serde_json::{Value, json};
use std::collections::HashMap;
use tracing::{debug, info};
/// Driver for getting GPU usage
#[derive(Debug)]
pub struct GpuUsageDriver;
#[async_trait::async_trait]
impl Driver for GpuUsageDriver {
    /// Returns the unique name of this driver
    fn name(&self) -> &str {
        "gpu_usage"
    }
    /// Returns a brief description of the driver's functionality
    fn description(&self) -> &str {
        "Get current GPU usage percentage"
    }
    /// Returns detailed usage guidance for LLMs
    fn usage_hint(&self) -> &str {
        "Use this skill to monitor GPU utilization for performance analysis"
    }
    /// Returns the parameter definitions for this driver
    fn parameters(&self) -> Vec<DriverParameter> {
        return vec![];
    }
    /// Returns an example call for this driver
    fn example_call(&self) -> DriverResult<Value> {
        return Ok(json!({
            "action": "gpu_usage",
            "parameters": {}
        }));
    }
    /// Returns an example output from this driver
    fn example_output(&self) -> String {
        return "GPU Usage: 67.5%".to_string();
    }
    /// Returns the category of this driver
    fn category(&self) -> DriverCategory {
        return DriverCategory::OperatingSystemGpu;
    }
    /// Executes the driver with the given parameters
    async fn execute(
        &self,
        _parameters: &HashMap<String, Value>,
        _callback: Option<&dyn DriverCallback>,
        _context: Option<&DriverContext>,
    ) -> DriverResult<String> {
        debug!("Executing gpu_usage driver");
        let usage = get_gpu_usage()?;
        info!("GPU usage: {:.1}%", usage);
        return Ok(format!("GPU Usage: {:.1}%", usage));
    }
}
/// Gets GPU usage from the system
fn get_gpu_usage() -> DriverResult<f32> {
    #[cfg(target_os = "linux")]
    {
        debug!("Getting GPU usage on Linux");
        // Try NVIDIA
        debug!("Trying NVIDIA nvidia-smi for usage");
        if let Ok(output) =
            crate::common::hidden_cmd("nvidia-smi").args(&["--query-gpu", "utilization.gpu"]).args(&["--format", "csv,noheader"]).output()
        {
            if output.status.success() {
                if let Ok(output_str) = String::from_utf8(output.stdout) {
                    if let Some(line) = output_str.lines().next() {
                        if let Ok(usage) = line.trim().trim_end_matches('%').parse::<f32>() {
                            info!("NVIDIA usage: {:.1}%", usage);
                            return Ok(usage);
                        }
                    }
                }
            }
        }
        // Try AMD via radeontop
        debug!("Trying AMD radeontop for usage");
        if let Ok(output) = crate::common::hidden_cmd("radeontop").args(&["--dump", "1"]).output() {
            if output.status.success() {
                if let Ok(output_str) = String::from_utf8(output.stdout) {
                    for line in output_str.lines() {
                        if line.starts_with("gpu") {
                            if let Some(percent) = line.split_whitespace().nth(1) {
                                if let Ok(usage) = percent.trim_end_matches('%').parse::<f32>() {
                                    info!("AMD radeontop usage: {:.1}%", usage);
                                    return Ok(usage);
                                }
                            }
                        }
                    }
                }
            }
        }
        // Try AMD via hwmon
        debug!("Trying AMD hwmon for usage");
        let hwmon_path = "/sys/class/hwmon";
        if let Ok(entries) = std::fs::read_dir(hwmon_path) {
            for entry in entries {
                if let Ok(entry) = entry {
                    let path = entry.path();
                    if let Ok(name) = std::fs::read_to_string(path.join("name")) {
                        let name_str = name.trim();
                        if name_str.contains("amdgpu") || name_str.contains("radeon") {
                            let load_path = path.join("device/gpu_busy_percent");
                            if let Ok(load_str) = std::fs::read_to_string(&load_path) {
                                if let Ok(usage) = load_str.trim().parse::<f32>() {
                                    info!("AMD hwmon usage: {:.1}%", usage);
                                    return Ok(usage);
                                }
                            }
                        }
                    }
                }
            }
        }
        // Try AMD via rocm-smi
        debug!("Trying AMD rocm-smi for usage");
        if let Ok(output) = crate::common::hidden_cmd("rocm-smi").args(&["--showuse"]).output() {
            if output.status.success() {
                if let Ok(output_str) = String::from_utf8(output.stdout) {
                    for line in output_str.lines() {
                        if line.contains("GPU") && line.contains("%") {
                            if let Some(usage) =
                                line.split_whitespace().find(|s| s.contains("%")).and_then(|s| s.trim_end_matches('%').parse::<f32>().ok())
                            {
                                info!("AMD rocm-smi usage: {:.1}%", usage);
                                return Ok(usage);
                            }
                        }
                    }
                }
            }
        }
        info!("GPU usage not found on Linux");
        return Ok(0.0);
    }
    #[cfg(target_os = "windows")]
    {
        debug!("Getting GPU usage on Windows");
        return get_windows_gpu_usage();
    }
    #[cfg(target_os = "macos")]
    {
        debug!("Getting GPU usage on macOS");
        if let Ok(output) = crate::common::hidden_cmd("sudo").args(&["powermetrics", "-n", "1", "--samplers", "gpu_power"]).output() {
            if output.status.success() {
                if let Ok(output_str) = String::from_utf8(output.stdout) {
                    for line in output_str.lines() {
                        if line.contains("GPU active residency") {
                            if let Some(percent) = line.split(':').nth(1) {
                                if let Ok(usage) = percent.trim().trim_end_matches('%').parse::<f32>() {
                                    info!("macOS usage: {:.1}%", usage);
                                    return Ok(usage);
                                }
                            }
                        }
                    }
                }
            }
        }
        info!("GPU usage not found on macOS");
        return Ok(0.0);
    }
    #[cfg(not(any(target_os = "linux", target_os = "windows", target_os = "macos")))]
    {
        debug!("GPU usage not supported on this platform");
        return Ok(0.0);
    }
}
/// Gets GPU usage on Windows
#[cfg(target_os = "windows")]
fn get_windows_gpu_usage() -> DriverResult<f32> {
    use std::process::Command;
    debug!("Getting GPU usage on Windows via WMI");
    let output = crate::common::hidden_cmd("powershell")
        .args(&[
            "-Command",
            "Get-CimInstance -Namespace root/cimv2 -ClassName Win32_PerfFormattedData_GPUPerformanceCounters | Select-Object -ExpandProperty GPUUsage"
        ])
        .output();
    if let Ok(output) = output {
        if output.status.success() {
            if let Ok(output_str) = String::from_utf8(output.stdout) {
                for line in output_str.lines() {
                    let trimmed = line.trim();
                    if !trimmed.is_empty() {
                        if let Ok(usage) = trimmed.parse::<f32>() {
                            if usage > 0.0 && usage <= 100.0 {
                                info!("Windows WMI usage: {:.1}%", usage);
                                return Ok(usage);
                            }
                        }
                    }
                }
            }
        }
    }
    #[cfg(feature = "nvml")]
    {
        debug!("Trying NVML for usage on Windows");
        use nvml_wrapper::Nvml;
        if let Ok(nvml) = Nvml::init() {
            if let Ok(device) = nvml.device_by_index(0) {
                if let Ok(utilization) = device.utilization_rates() {
                    info!("Windows NVML usage: {:.1}%", utilization.gpu as f32);
                    return Ok(utilization.gpu as f32);
                }
            }
        }
    }
    info!("GPU usage not found on Windows");
    return Ok(0.0);
}
#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_gpu_usage_metadata() {
        let driver = GpuUsageDriver;
        assert_eq!(driver.name(), "gpu_usage");
        assert_eq!(driver.category(), DriverCategory::OperatingSystemGpu);
    }
}