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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
//! Display the stats of your NVidia GPU
//!
//! By default `show_temperature` shows the used memory. Clicking the left mouse on the
//! "temperature" part of the block will alternate it between showing used or total available
//! memory.
//!
//! Clicking the left mouse button on the "fan speed" part of the block will cause it to enter into
//! a fan speed setting mode. In this mode you can scroll the mouse wheel over the block to change
//! the fan speeds, and left click to exit the mode.
//!
//! Requires `nvidia-smi` for displaying info and `nvidia_settings` for setting fan speed.
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `gpu_id` | GPU id in system. | `0`
//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $utilization $memory $temperature "`
//! `interval` | Update interval in seconds. | `1`
//! `idle` | Maximum temperature, below which state is set to idle | `50`
//! `good` | Maximum temperature, below which state is set to good | `70`
//! `info` | Maximum temperature, below which state is set to info | `75`
//! `warning` | Maximum temperature, below which state is set to warning | `80`
//!
//! Placeholder | Type | Unit
//! --------------|--------|---------------
//! `icon` | Icon | -
//! `name` | Text | -
//! `utilization` | Number | Percents
//! `memory` | Number | Bytes
//! `temperature` | Number | Degrees
//! `fan_speed` | Number | Percents
//! `clocks` | Number | Hertz
//! `power` | Number | Watts
//!
//! Action | Default button
//! ------------------------|----------------
//! `toggle_mem_total` | Left on `$memory`
//! `toggle_fan_controlled` | Left on `$fan_speed`
//! `fan_speed_up` | Wheel Up on `$fan_speed`
//! `fan_speed_down` | Wheel Down on `$fan_speed`
//!
//! # Example
//!
//! ```toml
//! [[block]]
//! block = "nvidia_gpu"
//! interval = 1
//! format = " $icon GT 1030 $utilization $temperature $clocks "
//! ```
//!
//! # Icons Used
//! - `gpu`
//!
//! # TODO
//! - Provide a `mappings` option similar to `keyboard_layout`'s to map GPU names to labels?
use std::process::Stdio;
use std::str::FromStr;
use tokio::io::{BufReader, Lines};
use tokio::process::Command;
const MEM_BTN: &str = "mem_btn";
const FAN_BTN: &str = "fan_btn";
const QUERY: &str = "--query-gpu=name,memory.total,utilization.gpu,memory.used,temperature.gpu,fan.speed,clocks.current.graphics,power.draw,";
const FORMAT: &str = "--format=csv,noheader,nounits";
use super::prelude::*;
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
pub format: FormatConfig,
#[default(1.into())]
pub interval: Seconds,
#[default(0)]
pub gpu_id: u64,
#[default(50)]
pub idle: u32,
#[default(70)]
pub good: u32,
#[default(75)]
pub info: u32,
#[default(80)]
pub warning: u32,
}
pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
let mut actions = api.get_actions()?;
api.set_default_actions(&[
(MouseButton::Left, Some(MEM_BTN), "toggle_mem_total"),
(MouseButton::Left, Some(FAN_BTN), "toggle_fan_controlled"),
(MouseButton::WheelUp, Some(FAN_BTN), "fan_speed_up"),
(MouseButton::WheelDown, Some(FAN_BTN), "fan_speed_down"),
])?;
let format = config
.format
.with_default(" $icon $utilization $memory $temperature ")?;
// Run `nvidia-smi` command
let mut child = Command::new("nvidia-smi")
.args([
"-l",
&config.interval.seconds().to_string(),
"-i",
&config.gpu_id.to_string(),
QUERY,
FORMAT,
])
.stdout(Stdio::piped())
.kill_on_drop(true)
.spawn()
.error("Failed to execute nvidia-smi")?;
let mut reader = BufReader::new(child.stdout.take().unwrap()).lines();
// Read the initial info
let mut info = GpuInfo::from_reader(&mut reader).await?;
let mut show_mem_total = false;
let mut fan_controlled = false;
loop {
let mut widget = Widget::new().with_format(format.clone());
widget.state = match info.temperature {
t if t <= config.idle => State::Idle,
t if t <= config.good => State::Good,
t if t <= config.info => State::Info,
t if t <= config.warning => State::Warning,
_ => State::Critical,
};
widget.set_values(map! {
"icon" => Value::icon("gpu"),
"name" => Value::text(info.name.clone()),
"utilization" => Value::percents(info.utilization),
"memory" => Value::bytes(if show_mem_total {info.mem_total} else {info.mem_used}).with_instance(MEM_BTN),
"temperature" => Value::degrees(info.temperature),
"fan_speed" => Value::percents(info.fan_speed).with_instance(FAN_BTN).underline(fan_controlled).italic(fan_controlled),
"clocks" => Value::hertz(info.clocks),
"power" => Value::watts(info.power_draw),
});
api.set_widget(widget)?;
select! {
new_info = GpuInfo::from_reader(&mut reader) => {
info = new_info?;
}
code = child.wait() => {
let code = code.error("failed to check nvidia-smi exit code")?;
return Err(Error::new(format!("nvidia-smi exited with code {code}")));
}
Some(action) = actions.recv() => match action.as_ref() {
"toggle_mem_total" => {
show_mem_total = !show_mem_total;
}
"toggle_fan_controlled" => {
fan_controlled = !fan_controlled;
set_fan_speed(config.gpu_id, fan_controlled.then_some(info.fan_speed)).await?;
}
"fan_speed_up" if fan_controlled && info.fan_speed < 100 => {
info.fan_speed += 1;
set_fan_speed(config.gpu_id, Some(info.fan_speed)).await?;
}
"fan_speed_down" if fan_controlled && info.fan_speed > 0 => {
info.fan_speed -= 1;
set_fan_speed(config.gpu_id, Some(info.fan_speed)).await?;
}
_ => (),
}
}
}
}
#[derive(Debug)]
struct GpuInfo {
name: String,
mem_total: f64, // bytes
mem_used: f64, // bytes
utilization: f64, // percents
temperature: u32, // degrees
fan_speed: u32, // percents
clocks: f64, // hertz
power_draw: f64, // watts
}
impl GpuInfo {
/// Read a line from provided reader and parse it
///
/// # Cancel safety
///
/// This method should be cancellation safe, because it has only one `.await` and it is on `next_line`, which is cancellation safe.
async fn from_reader<B: AsyncBufRead + Unpin>(reader: &mut Lines<B>) -> Result<Self> {
const ERR_MSG: &str = "failed to read from nvidia-smi";
reader
.next_line()
.await
.error(ERR_MSG)?
.error(ERR_MSG)?
.parse::<GpuInfo>()
.error("failed to parse nvidia-smi output")
}
}
impl FromStr for GpuInfo {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
macro_rules! parse {
($s:ident -> $($part:ident : $t:ident $(* $mul:expr)?),*) => {{
let mut parts = $s.trim().split(", ");
let info = GpuInfo {
$(
$part: {
let $part = parts
.next()
.error(concat!("missing property: ", stringify!($part)))?
.parse::<$t>()
.unwrap_or_default();
$(let $part = $part * $mul;)?
$part
},
)*
};
Ok(info)
}}
}
// `memory` and `clocks` are initially in MB and MHz, so we have to multiply them by 1_000_000
parse!(s -> name: String, mem_total: f64 * 1e6, utilization: f64, mem_used: f64 * 1e6, temperature: u32, fan_speed: u32, clocks: f64 * 1e6, power_draw: f64)
}
}
async fn set_fan_speed(id: u64, speed: Option<u32>) -> Result<()> {
const ERR_MSG: &str = "Failed to execute nvidia-settings";
let mut cmd = Command::new("nvidia-settings");
if let Some(speed) = speed {
cmd.args([
"-a",
&format!("[gpu:{id}]/GPUFanControlState=1"),
"-a",
&format!("[fan:{id}]/GPUTargetFanSpeed={speed}"),
]);
} else {
cmd.args(["-a", &format!("[gpu:{id}]/GPUFanControlState=0")]);
}
if cmd
.spawn()
.error(ERR_MSG)?
.wait()
.await
.error(ERR_MSG)?
.success()
{
Ok(())
} else {
Err(Error::new(ERR_MSG))
}
}