Skip to content

Buffer filling APIs #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swlynch99 merged 1 commit into from
Mar 5, 2026
Merged

Buffer filling APIs #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 26 additions & 48 deletions nvml-wrapper/src/device.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use crate::enums::device::{
BusType, DeviceArchitecture, FanControlPolicy, GpuLockedClocksSetting, PcieLinkMaxSpeed,
PowerSource,
};
use crate::error::nvml_try_count;
#[cfg(target_os = "linux")]
use crate::error::NvmlErrorWithSource;
use crate::error::{nvml_sym, nvml_try, Bits, NvmlError};
Expand Down Expand Up @@ -2217,11 +2218,8 @@ impl<'nvml> Device<'nvml> {
let mut count: c_uint = 0;

// Passing null doesn't indicate that we want the count. It's just allowed.
match sym(self.device, &mut count, ptr::null_mut()) {
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => Ok(count),
// If success, return 0; otherwise, return error
other => nvml_try(other).map(|_| 0),
}
nvml_try_count(sym(self.device, &mut count, ptr::null_mut()))?;
Ok(count)
}
}

Expand Down Expand Up @@ -2293,11 +2291,8 @@ impl<'nvml> Device<'nvml> {
let mut count: c_uint = 0;

// Passing null doesn't indicate that we want the count. It's just allowed.
match sym(self.device, &mut count, ptr::null_mut()) {
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => Ok(count),
// If success, return 0; otherwise, return error
other => nvml_try(other).map(|_| 0),
}
nvml_try_count(sym(self.device, &mut count, ptr::null_mut()))?;
Ok(count)
}
}

Expand Down Expand Up @@ -2365,16 +2360,13 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: c_uint = 0;

match sym(
nvml_try_count(sym(
self.device,
ptr::null_mut(),
&mut count,
last_seen_timestamp,
) {
// Despite being undocumented, this appears to be the correct behavior
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => Ok(count),
other => nvml_try(other).map(|_| 0),
}
))?;
Ok(count)
}
}

Expand Down Expand Up @@ -3454,7 +3446,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: c_uint = 0;

nvml_try(sym(
nvml_try_count(sym(
self.device,
cause.as_c(),
&mut count,
Expand Down Expand Up @@ -3606,7 +3598,7 @@ impl<'nvml> Device<'nvml> {
let mut val_type: nvmlValueType_t = mem::zeroed();
let mut count: c_uint = mem::zeroed();

nvml_try(sym(
nvml_try_count(sym(
self.device,
sample_type.as_c(),
timestamp,
Expand Down Expand Up @@ -3947,13 +3939,12 @@ impl<'nvml> Device<'nvml> {
let sym = nvml_sym(self.nvml.lib.nvmlDeviceGetSupportedGraphicsClocks.as_ref())?;

unsafe {
match sym(self.device, for_mem_clock, &mut count, items.as_mut_ptr()) {
// `count` is now the size that is required. Return it in the error.
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => {
return Err(NvmlError::InsufficientSize(Some(count as usize)))
}
value => nvml_try(value)?,
}
nvml_try_count(sym(
self.device,
for_mem_clock,
&mut count,
items.as_mut_ptr(),
))?;
}

items.truncate(count as usize);
Expand Down Expand Up @@ -3995,7 +3986,7 @@ impl<'nvml> Device<'nvml> {
let mut count = size as c_uint;

let sym = nvml_sym(self.nvml.lib.nvmlDeviceGetSupportedMemoryClocks.as_ref())?;

// TODO: should this fn call `sym` twice, first to populate `count` and second to fill the vec?
unsafe {
match sym(self.device, &mut count, items.as_mut_ptr()) {
// `count` is now the size that is required. Return it in the error.
Expand Down Expand Up @@ -4186,7 +4177,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: c_uint = 0;

nvml_try(sym(
nvml_try_count(sym(
self.device,
level.as_c(),
&mut count,
Expand Down Expand Up @@ -5034,20 +5025,13 @@ impl<'nvml> Device<'nvml> {
fn accounting_pids_count(&self) -> Result<c_uint, NvmlError> {
let sym = nvml_sym(self.nvml.lib.nvmlDeviceGetAccountingPids.as_ref())?;

// Indicates that we want the count
let mut count: c_uint = 0;
unsafe {
// Indicates that we want the count
let mut count: c_uint = 0;

// Null also indicates that we want the count
match sym(self.device, &mut count, ptr::null_mut()) {
// List is empty
nvmlReturn_enum_NVML_SUCCESS => Ok(0),
// Count is set to pids count
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => Ok(count),
// We know this is an error
other => nvml_try(other).map(|_| 0),
}
nvml_try_count(sym(self.device, &mut count, ptr::null_mut()))?;
}
Ok(count)
}

/**
Expand Down Expand Up @@ -6196,7 +6180,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: u32 = 0;

nvml_try(sym(self.device, &mut count, std::ptr::null_mut()))?;
nvml_try_count(sym(self.device, &mut count, std::ptr::null_mut()))?;
let mut arr: Vec<nvmlVgpuInstance_t> = vec![0; count as usize];
nvml_try(sym(self.device, &mut count, arr.as_mut_ptr()))?;

Expand Down Expand Up @@ -6228,7 +6212,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: u32 = 0;

nvml_try(sym(instance, &mut count, std::ptr::null_mut()))?;
nvml_try_count(sym(instance, &mut count, std::ptr::null_mut()))?;
let mut pids: Vec<u32> = vec![0; count as usize];
nvml_try(sym(instance, &mut count, pids.as_mut_ptr()))?;

Expand Down Expand Up @@ -6529,10 +6513,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: c_uint = 0;

match nvml_try(sym(self.device, &mut count, ids.as_mut_ptr())) {
Ok(()) | Err(NvmlError::InsufficientSize(_)) => {}
Err(err) => return Err(err),
}
nvml_try_count(sym(self.device, &mut count, ids.as_mut_ptr()))?;

ids.resize(count as usize, 0);
nvml_try(sym(self.device, &mut count, ids.as_mut_ptr()))?;
Expand All @@ -6549,10 +6530,7 @@ impl<'nvml> Device<'nvml> {
unsafe {
let mut count: c_uint = 0;

match nvml_try(sym(self.device, &mut count, ids.as_mut_ptr())) {
Ok(()) | Err(NvmlError::InsufficientSize(_)) => {}
Err(err) => return Err(err),
}
nvml_try_count(sym(self.device, &mut count, ids.as_mut_ptr()))?;

ids.resize(count as usize, 0);
nvml_try(sym(self.device, &mut count, ids.as_mut_ptr()))?;
Expand Down
76 changes: 47 additions & 29 deletions nvml-wrapper/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#[error("{error}")]
pub struct NvmlErrorWithSource {
pub error: NvmlError,
pub source: Option<NvmlError>,

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Clippy 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (ubuntu-latest, stable) 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (ubuntu-latest, stable) 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (macos-latest, stable) 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (macos-latest, stable) 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (windows-latest, stable) 

value assigned to `source` is never read

Check warning on line 18 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Check (windows-latest, stable) 

value assigned to `source` is never read
}

impl From<NvmlError> for NvmlErrorWithSource {
Expand All @@ -32,7 +32,7 @@
#[error("could not interpret string as utf-8")]
Utf8Error(#[from] std::str::Utf8Error),
#[error("nul byte inside string")]
NulError(#[from] std::ffi::NulError),

Check warning on line 35 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Clippy 

current MSRV (Minimum Supported Rust Version) is `1.60.0` but this item is stable since `1.64.0`

Check warning on line 35 in nvml-wrapper/src/error.rs

View workflow job for this annotation

GitHub Actions / Clippy 

current MSRV (Minimum Supported Rust Version) is `1.60.0` but this item is stable since `1.64.0`
#[error("a libloading error occurred: {0}")]
LibloadingError(#[from] libloading::Error),

Expand Down Expand Up @@ -166,36 +166,54 @@
}

/// Converts an `nvmlReturn_t` type into a `Result<(), NvmlError>`.
#[allow(deprecated)]
pub fn nvml_try(code: nvmlReturn_t) -> Result<(), NvmlError> {
use NvmlError::*;

match code {
nvmlReturn_enum_NVML_SUCCESS => Ok(()),
nvmlReturn_enum_NVML_ERROR_UNINITIALIZED => Err(Uninitialized),
nvmlReturn_enum_NVML_ERROR_INVALID_ARGUMENT => Err(InvalidArg),
nvmlReturn_enum_NVML_ERROR_NOT_SUPPORTED => Err(NotSupported),
nvmlReturn_enum_NVML_ERROR_NO_PERMISSION => Err(NoPermission),
nvmlReturn_enum_NVML_ERROR_ALREADY_INITIALIZED => Err(AlreadyInitialized),
nvmlReturn_enum_NVML_ERROR_NOT_FOUND => Err(NotFound),
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => Err(InsufficientSize(None)),
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_POWER => Err(InsufficientPower),
nvmlReturn_enum_NVML_ERROR_DRIVER_NOT_LOADED => Err(DriverNotLoaded),
nvmlReturn_enum_NVML_ERROR_TIMEOUT => Err(Timeout),
nvmlReturn_enum_NVML_ERROR_IRQ_ISSUE => Err(IrqIssue),
nvmlReturn_enum_NVML_ERROR_LIBRARY_NOT_FOUND => Err(LibraryNotFound),
nvmlReturn_enum_NVML_ERROR_FUNCTION_NOT_FOUND => Err(FunctionNotFound),
nvmlReturn_enum_NVML_ERROR_CORRUPTED_INFOROM => Err(CorruptedInfoROM),
nvmlReturn_enum_NVML_ERROR_GPU_IS_LOST => Err(GpuLost),
nvmlReturn_enum_NVML_ERROR_RESET_REQUIRED => Err(ResetRequired),
nvmlReturn_enum_NVML_ERROR_OPERATING_SYSTEM => Err(OperatingSystem),
nvmlReturn_enum_NVML_ERROR_LIB_RM_VERSION_MISMATCH => Err(LibRmVersionMismatch),
nvmlReturn_enum_NVML_ERROR_IN_USE => Err(InUse),
nvmlReturn_enum_NVML_ERROR_MEMORY => Err(InsufficientMemory),
nvmlReturn_enum_NVML_ERROR_NO_DATA => Err(NoData),
nvmlReturn_enum_NVML_ERROR_VGPU_ECC_NOT_SUPPORTED => Err(VgpuEccNotSupported),
nvmlReturn_enum_NVML_ERROR_UNKNOWN => Err(Unknown),
_ => Err(UnexpectedVariant(code)),
if code == nvmlReturn_enum_NVML_SUCCESS {
return Ok(());
}
Err(code.into())
}

/// Converts an `nvmlReturn_t` type into a `Result<(), NvmlError>`, allowing for the call to return the
/// value `nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE` which is a common return value when using an
/// in/out parameter that provides the size of a buffer needed to complete that call
pub fn nvml_try_count(code: nvmlReturn_t) -> Result<(), NvmlError> {
if code == nvmlReturn_enum_NVML_SUCCESS || code == nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE
{
return Ok(());
}
Err(code.into())
}

#[allow(deprecated)]
impl From<nvmlReturn_t> for NvmlError {
fn from(value: nvmlReturn_t) -> Self {
use NvmlError::*;
match value {
nvmlReturn_enum_NVML_ERROR_UNINITIALIZED => Uninitialized,
nvmlReturn_enum_NVML_ERROR_INVALID_ARGUMENT => InvalidArg,
nvmlReturn_enum_NVML_ERROR_NOT_SUPPORTED => NotSupported,
nvmlReturn_enum_NVML_ERROR_NO_PERMISSION => NoPermission,
nvmlReturn_enum_NVML_ERROR_ALREADY_INITIALIZED => AlreadyInitialized,
nvmlReturn_enum_NVML_ERROR_NOT_FOUND => NotFound,
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => InsufficientSize(None),
nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_POWER => InsufficientPower,
nvmlReturn_enum_NVML_ERROR_DRIVER_NOT_LOADED => DriverNotLoaded,
nvmlReturn_enum_NVML_ERROR_TIMEOUT => Timeout,
nvmlReturn_enum_NVML_ERROR_IRQ_ISSUE => IrqIssue,
nvmlReturn_enum_NVML_ERROR_LIBRARY_NOT_FOUND => LibraryNotFound,
nvmlReturn_enum_NVML_ERROR_FUNCTION_NOT_FOUND => FunctionNotFound,
nvmlReturn_enum_NVML_ERROR_CORRUPTED_INFOROM => CorruptedInfoROM,
nvmlReturn_enum_NVML_ERROR_GPU_IS_LOST => GpuLost,
nvmlReturn_enum_NVML_ERROR_RESET_REQUIRED => ResetRequired,
nvmlReturn_enum_NVML_ERROR_OPERATING_SYSTEM => OperatingSystem,
nvmlReturn_enum_NVML_ERROR_LIB_RM_VERSION_MISMATCH => LibRmVersionMismatch,
nvmlReturn_enum_NVML_ERROR_IN_USE => InUse,
nvmlReturn_enum_NVML_ERROR_MEMORY => InsufficientMemory,
nvmlReturn_enum_NVML_ERROR_NO_DATA => NoData,
nvmlReturn_enum_NVML_ERROR_VGPU_ECC_NOT_SUPPORTED => VgpuEccNotSupported,
nvmlReturn_enum_NVML_ERROR_UNKNOWN => Unknown,
_ => UnexpectedVariant(value),
}
}
}

Expand Down
34 changes: 10 additions & 24 deletions nvml-wrapper/src/unit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::device::Device;
use crate::enum_wrappers::unit::LedColor;
use crate::enums::unit::{LedState, TemperatureReading};
use crate::error::{nvml_sym, nvml_try, NvmlError};
use crate::error::{nvml_sym, nvml_try, nvml_try_count, NvmlError};
use crate::ffi::bindings::*;
use crate::struct_wrappers::unit::{FansInfo, PsuInfo, UnitInfo};
use crate::Nvml;
Expand Down Expand Up @@ -145,31 +145,17 @@ impl<'nvml> Unit<'nvml> {
pub fn device_count(&self) -> Result<u32, NvmlError> {
let sym = nvml_sym(self.nvml.lib.nvmlUnitGetDevices.as_ref())?;

/*
From the docs:
deviceCount
Reference in which to provide the devices array size,
and to return the number of attached GPU devices
*/
let mut count: c_uint = 0;
unsafe {
/*
NVIDIA doesn't even say that `count` will be set to the count if
`InsufficientSize` is returned. But we can assume sanity, right?

The idea here is:
If there are 0 devices, NVML_SUCCESS is returned, `count` is set
to 0. We return count, all good.
If there is 1 device, NVML_SUCCESS is returned, `count` is set to
1. We return count, all good.
If there are >= 2 devices, NVML_INSUFFICIENT_SIZE is returned.
`count` is theoretically set to the actual count, and we
return it.
*/
let mut count: c_uint = 1;
let mut devices: [nvmlDevice_t; 1] = [mem::zeroed()];

match sym(self.unit, &mut count, devices.as_mut_ptr()) {
nvmlReturn_enum_NVML_SUCCESS | nvmlReturn_enum_NVML_ERROR_INSUFFICIENT_SIZE => {
Ok(count)
}
// We know that this will be an error
other => nvml_try(other).map(|_| 0),
}
nvml_try_count(sym(self.unit, &mut count, std::ptr::null_mut()))?;
}
Ok(count)
}

/**
Expand Down
Loading