Functions

nvmlReturn_t nvmlGpmMetricsGet ( nvmlGpmMetricsGet_t* metricsGet )

Parameters

metricsGet

IN/OUT: populated nvmlGpmMetricsGet_t struct

Returns

• NVML_SUCCESS on success
• Nonzero NVML_ERROR_? enum on error

Description

Calculate GPM metrics from two samples.

For Hopper or newer fully supported devices.

To retrieve metrics, the user must first allocate the two sample buffers at metricsGet->sample1 and metricsGet->sample2 by calling nvmlGpmSampleAlloc(). Next, the user should fill in the ID of each metric in metricsGet->metrics[i].metricId and specify the total number of metrics to retrieve in metricsGet->numMetrics, The version should be set to NVML_GPM_METRICS_GET_VERSION in metricsGet->version. The user then calls the nvmlGpmSampleGet() API twice to obtain 2 samples of counters.

Note:

that the interval between these two nvmlGpmSampleGet() calls should be greater than 100ms due to the internal sample refresh rate. Finally, the user calls nvmlGpmMetricsGet to retrieve the metrics, which will be stored at metricsGet->metrics

nvmlReturn_t nvmlGpmMigSampleGet ( nvmlDevice_t device, unsigned int  gpuInstanceId, nvmlGpmSample_t gpmSample )

Parameters

device

Device to get samples for

gpuInstanceId

MIG GPU Instance ID

gpmSample

Buffer to read samples into

Returns

• NVML_SUCCESS on success
• Nonzero NVML_ERROR_? enum on error

Description

Read a sample of GPM metrics into the provided gpmSample buffer for a MIG GPU Instance.

After two samples are gathered, you can call nvmlGpmMetricGet on those samples to retrive metrics

For Hopper or newer fully supported devices.

Note:

The interval between two nvmlGpmMigSampleGet() calls should be greater than 100ms due to the internal sample refresh rate.

nvmlReturn_t nvmlGpmQueryDeviceSupport ( nvmlDevice_t device, nvmlGpmSupport_t* gpmSupport )

Parameters

device

NVML device to query for

gpmSupport

Structure to indicate GPM support nvmlGpmSupport_t. Indicates GPM support per system for the supplied device

Returns

• NVML_SUCCESS on success
• Nonzero NVML_ERROR_? enum if there is an error in processing the query

Description

Indicate whether the supplied device supports GPM

For Hopper or newer fully supported devices.

nvmlReturn_t nvmlGpmQueryIfStreamingEnabled ( nvmlDevice_t device, unsigned int* state )

Parameters

device

The identifier of the target device

state

Returns GPM stream state NVML_FEATURE_DISABLED or NVML_FEATURE_ENABLED

Returns

• NVML_SUCCESS if current GPM stream state were successfully queried
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if device is invalid or state is NULL
• NVML_ERROR_NOT_SUPPORTED if this query is not supported by the device

Description

Get GPM stream state.

For Hopper or newer fully supported devices. Supported on Linux, Windows TCC.

nvmlReturn_t nvmlGpmSampleAlloc ( nvmlGpmSample_t* gpmSample )

Parameters

gpmSample

Where the allocated sample will be stored

Returns

• NVML_SUCCESS on success
• NVML_ERROR_INVALID_ARGUMENT if an invalid pointer is provided
• NVML_ERROR_MEMORY if system memory is insufficient

Description

Allocate a sample buffer to be used with NVML GPM . You will need to allocate at least two of these buffers to use with the NVML GPM feature

For Hopper or newer fully supported devices.

nvmlReturn_t nvmlGpmSampleFree ( nvmlGpmSample_t gpmSample )

Parameters

gpmSample

Sample to free

Returns

• NVML_SUCCESS on success
• NVML_ERROR_INVALID_ARGUMENT if an invalid pointer is provided

Description

Free an allocated sample buffer that was allocated with nvmlGpmSampleAlloc()

For Hopper or newer fully supported devices.

nvmlReturn_t nvmlGpmSampleGet ( nvmlDevice_t device, nvmlGpmSample_t gpmSample )

Parameters

device

Device to get samples for

gpmSample

Buffer to read samples into

Returns

• NVML_SUCCESS on success
• Nonzero NVML_ERROR_? enum on error

Description

Read a sample of GPM metrics into the provided gpmSample buffer. After two samples are gathered, you can call nvmlGpmMetricGet on those samples to retrive metrics

For Hopper or newer fully supported devices.

Note:

The interval between two nvmlGpmSampleGet() calls should be greater than 100ms due to the internal sample refresh rate.

nvmlReturn_t nvmlGpmSetStreamingEnabled ( nvmlDevice_t device, unsigned int  state )

Parameters

device

The identifier of the target device

state

GPM stream state, NVML_FEATURE_DISABLED or NVML_FEATURE_ENABLED

Returns

• NVML_SUCCESS if current GPM stream state is successfully set
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if device is invalid
• NVML_ERROR_NOT_SUPPORTED if this query is not supported by the device

Description

Set GPM stream state.

For Hopper or newer fully supported devices. Supported on Linux, Windows TCC.