Struct GpmSample 

pub struct GpmSample<'nvml> { /* private fields */ }

Handle to a GPM (GPU Performance Monitoring) sample.

GPM enables collecting fine-grained GPU performance metrics (SM occupancy, tensor utilization, PCIe/NVLink bandwidth, etc.) on Hopper+ GPUs. Metrics are computed by taking two time-separated samples and comparing them via gpm_metrics_get.

Operations on a sample are not thread-safe. It does not, therefore, implement Sync.

You can obtain a GpmSample via crate::Device::gpm_sample() or crate::Device::gpm_mig_sample().

Lifetimes are used to enforce that each GpmSample instance cannot be used after the Nvml instance it was obtained from is dropped.

Implementations

impl<'nvml> GpmSample<'nvml>

pub fn free(self) -> Result<(), NvmlError>

Use this to free the sample if you care about handling potential errors (the Drop implementation ignores errors!).

Errors

• Uninitialized, if the library has not been successfully initialized
• Unknown, on any unexpected error

pub unsafe fn handle(&self) -> nvmlGpmSample_t

Get the raw sample handle.

Safety

This is unsafe to prevent it from being used without care. In particular, you must avoid creating a new GpmSample from this handle and allowing both this GpmSample and the newly created one to drop (which would result in a double-free).

pub fn nvml(&self) -> &'nvml Nvml

Get a reference to the Nvml instance this sample was created from.

Trait Implementations

impl<'nvml> Debug for GpmSample<'nvml>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'nvml> Drop for GpmSample<'nvml>

This Drop implementation ignores errors! Use the .free() method on the GpmSample struct if you care about handling them.

fn drop(&mut self)

Executes the destructor for this type.

impl<'nvml> Send for GpmSample<'nvml>