Metric Functions

Metric Functions#

ROCmSMI: Metric Functions

Functions
rsmi_status_t	rsmi_dev_metrics_header_info_get (uint32_t dv_ind, metrics_table_header_t *header_value)
	Get the 'metrics_header_info' from the GPU metrics associated with the device. More...

rsmi_status_t	rsmi_dev_metrics_xcd_counter_get (uint32_t dv_ind, uint16_t *xcd_counter_value)
	Get the 'xcd_counter' from the GPU metrics associated with the device. More...

rsmi_status_t	rsmi_dev_metrics_log_get (uint32_t dv_ind)
	Get the log from the GPU metrics associated with the device. More...

Detailed Description

These functions are used to get granular information about all counters available in GPU Metrics.

Function Documentation

◆ rsmi_dev_metrics_header_info_get()

rsmi_status_t rsmi_dev_metrics_header_info_get	(	uint32_t	dv_ind,
		metrics_table_header_t *	header_value
	)

Get the 'metrics_header_info' from the GPU metrics associated with the device.

Given a device index dv_ind and a pointer to a metrics_table_header_t in which the 'metrics_header_info' will stored

Parameters

[in]	dv_ind	a device index
[in,out]	header_value	a pointer to metrics_table_header_t to which the device gpu metric unit will be stored

Return values

RSMI_STATUS_SUCCESS is returned upon successful call. RSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ rsmi_dev_metrics_xcd_counter_get()

rsmi_status_t rsmi_dev_metrics_xcd_counter_get	(	uint32_t	dv_ind,
		uint16_t *	xcd_counter_value
	)

Get the 'xcd_counter' from the GPU metrics associated with the device.

Given a device index dv_ind and a pointer to a uint16_t in which the 'xcd_counter' will stored

Parameters

[in]	dv_ind	a device index
[in,out]	xcd_counter_value	a pointer to uint16_t to which the device gpu metric unit will be stored

Return values

RSMI_STATUS_SUCCESS is returned upon successful call. RSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ rsmi_dev_metrics_log_get()

rsmi_status_t rsmi_dev_metrics_log_get ( uint32_t dv_ind )

Get the log from the GPU metrics associated with the device.

Given a device index dv_ind it will log all the gpu metric info related to the device. The 'logging' feature must be on.

Parameters

[in] dv_ind a device index

Return values

RSMI_STATUS_SUCCESS is returned upon successful call.