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 unsafe fn from_handle(nvml: &'nvml Nvml, sample: nvmlGpmSample_t) -> Self

Wrap a raw sample handle.

The returned GpmSample takes ownership of the handle and will free it on drop.

Safety

• The handle must have been allocated by nvmlGpmSampleAlloc via the same loaded NVML library as nvml and must not already have been freed.
• Nothing else may free the handle afterward — neither another GpmSample wrapping the same handle nor a manual nvmlGpmSampleFree call — as that would result in a double-free. Use Self::into_handle to release ownership from an existing GpmSample before reconstructing it with this function.

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.

The handle is borrowed: this GpmSample still owns the sample and will free it on drop.

Safety

This is unsafe to prevent it from being used without care. In particular, you must avoid creating a new GpmSample from this handle (e.g. via Self::from_handle) and allowing both this GpmSample and the newly created one to drop (which would result in a double-free). To transfer ownership of the sample out of the wrapper, use Self::into_handle instead.

pub fn into_handle(self) -> nvmlGpmSample_t

Consume this GpmSample and return the raw sample handle without freeing it.

The caller takes ownership of the handle and is responsible for freeing it, either by calling nvmlGpmSampleFree manually or by reconstructing a GpmSample with Self::from_handle and letting that free it.

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.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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