gfxinfo 0.1.1

Rust library for querying GPU information
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use std::{error::Error, rc::Rc};

use nvml_wrapper::{
  Nvml,
  enum_wrappers::device::{Brand, TemperatureSensor},
};

use crate::{Gpu, GpuInfo};

#[derive(Debug)]
pub struct NvidiaGpu {
  nvml: Rc<Nvml>,

  vendor: String,
  model: String,
  family: String,
  device_id: u32,
}

impl Gpu for NvidiaGpu {
  fn vendor(&self) -> &str {
    &self.vendor
  }

  fn model(&self) -> &str {
    &self.model
  }

  fn family(&self) -> &str {
    &self.family
  }

  fn device_id(&self) -> &u32 {
    &self.device_id
  }

  #[cfg(feature = "gpu_info")]
  fn info(&self) -> Box<dyn GpuInfo> {
    Box::new(NvidiaGpuInfo {
      nvml: self.nvml.clone(),
    })
  }
}

#[cfg(feature = "gpu_info")]
struct NvidiaGpuInfo {
  nvml: Rc<Nvml>,
}

#[cfg(feature = "gpu_info")]
impl GpuInfo for NvidiaGpuInfo {
  fn total_vram(&self) -> u64 {
    let meminfo = match self
      .nvml
      .device_by_index(0)
      .and_then(|device| device.memory_info())
    {
      Ok(meminfo) => meminfo,
      Err(_) => return 0,
    };

    meminfo.total
  }

  fn used_vram(&self) -> u64 {
    let meminfo = match self
      .nvml
      .device_by_index(0)
      .and_then(|device| device.memory_info())
    {
      Ok(meminfo) => meminfo,
      Err(_) => return 0,
    };

    meminfo.used
  }

  fn load_pct(&self) -> u32 {
    let util = match self
      .nvml
      .device_by_index(0)
      .and_then(|device| device.utilization_rates())
    {
      Ok(u) => u,
      Err(_) => return 0,
    };

    util.gpu
  }

  fn temperature(&self) -> u32 {
    let temp = match self
      .nvml
      .device_by_index(0)
      .and_then(|device| device.temperature(TemperatureSensor::Gpu))
    {
      Ok(u) => u,
      Err(_) => return 0,
    };

    // This one returns as celsius, so we need to make it consistent
    temp * 1000
  }
}

pub fn active_gpu() -> Result<NvidiaGpu, Box<dyn Error>> {
  let nvml = Nvml::init()?;

  let vendor;
  let model;
  let family;
  let device_id;

  {
    // TODO: first device may not always be the active one
    let device = nvml.device_by_index(0)?;

    vendor = "Nvidia".to_string();
    model = device.name()?;
    family = brand_to_string(device.brand()?);
    device_id = device.pci_info()?.pci_device_id;
  }

  Ok(NvidiaGpu {
    nvml: Rc::new(nvml),

    vendor,
    model,
    family,
    device_id,
  })
}

fn brand_to_string(brand: Brand) -> String {
  match brand {
    Brand::GeForce => "GeForce".to_string(),
    Brand::Nvidia => "Nvidia".to_string(),
    Brand::NvidiaRTX => "NvidiaRTX".to_string(),
    Brand::Tesla => "Tesla".to_string(),
    Brand::Unknown => "Unknown".to_string(),
    Brand::NVS => "NVS".to_string(),
    Brand::GRID => "GRID".to_string(),
    Brand::Quadro => "Quadro".to_string(),
    Brand::QuadroRTX => "QuadroRTX".to_string(),
    Brand::GeForceRTX => "GeForceRTX".to_string(),
    Brand::Titan => "Titan".to_string(),
    Brand::TitanRTX => "TitanRTX".to_string(),
    Brand::VApps => "VApps".to_string(),
    Brand::VPC => "VPC".to_string(),
    Brand::VCS => "VCS".to_string(),
    Brand::VWS => "VWS".to_string(),
    Brand::CloudGaming => "CloudGaming".to_string(),
    Brand::VGaming => "VGaming".to_string(),
  }
}