Device realtime metrics

Overview

These APIs are for realtime metrics More…

// global functions

XPUM_API xpum_result_t xpumGetRealtimeMetrics(
    xpum_device_id_t deviceId,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    );

XPUM_API xpum_result_t xpumGetRealtimeMetricsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    );

Detailed Documentation

These APIs are for realtime metrics

Global Functions

XPUM_API xpum_result_t xpumGetRealtimeMetrics(
    xpum_device_id_t deviceId,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    )

Get realtime metrics (not including per engine utilization) by device.

Support Platform: Linux, Windows

Parameters:

deviceId

IN: Device id

dataList

OUT: The array to store realtime metrics for device deviceId. First pass NULL to query realtime metrics count. Then pass array with desired length to store realtime metrics.

count

IN/OUT: When dataList is NULL, count will be filled with the number of available entries, and return. When dataList is not NULL, count denotes the length of dataList, count should be equal to or larger than the number of available entries, when return, the count will store real number of entries returned by dataList

Returns:

xpum_result_t

XPUM_API xpum_result_t xpumGetRealtimeMetricsEx(
    xpum_device_id_t deviceIdList[],
    uint32_t deviceCount,
    xpum_device_realtime_metrics_t dataList[],
    uint32_t* count
    )

Get realtime metrics (not including per engine utilization) by device list.

Support Platform: Linux, Windows

Parameters:

deviceIdList

IN: Device id list

deviceCount

IN: Device id count

dataList

OUT: The arry to store realtime metrics for device list deviceIdList. First pass NULL to query realtime metrics count. Then pass array with desired length to store realtime metrics.

count

IN/OUT: When dataList is NULL, count will be filled with the number of available entries, and return. When dataList is not NULL, count denotes the length of dataList, count should be equal to or larger than the number of available entries, when return, the count will store real number of entries returned by dataList

Returns:

xpum_result_t