Metric Query Pool

oneAPI Level Zero Specification - Version 1.18.31

Metric Query Pool Functions

zetMetricQueryPoolCreate

Added in version 1.0

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricQueryPoolCreate(zet_context_handle_t hContext, zet_device_handle_t hDevice, zet_metric_group_handle_t hMetricGroup, const zet_metric_query_pool_desc_t *desc, zet_metric_query_pool_handle_t *phMetricQueryPool)

Creates a pool of metric queries on the context.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

Parameters:

• hContext – [in] handle of the context object

• hDevice – [in] handle of the device

• hMetricGroup – [in] metric group associated with the query object.

• desc – [in] metric query pool descriptor

• phMetricQueryPool – [out] handle of metric query pool

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hContext

  • nullptr == hDevice

  • nullptr == hMetricGroup

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == desc

  • nullptr == phMetricQueryPool

• ZE_RESULT_ERROR_INVALID_ENUMERATION

  • ZET_METRIC_QUERY_POOL_TYPE_EXECUTION < desc->type

• ZE_RESULT_ERROR_UNSUPPORTED_ENUMERATION

zetMetricQueryPoolDestroy

Added in version 1.0

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricQueryPoolDestroy(zet_metric_query_pool_handle_t hMetricQueryPool)

Deletes a query pool object.

• The application must destroy all query handles created from the pool before destroying the pool itself.

• The application must ensure the device is not currently referencing the any query within the pool before it is deleted.

• The application must not call this function from simultaneous threads with the same query pool handle.

• The implementation of this function must be thread-safe.

Parameters:

hMetricQueryPool – [in][release] handle of the metric query pool

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hMetricQueryPool

• ZE_RESULT_ERROR_HANDLE_OBJECT_IN_USE

Metric Query Pool Enums

zet_metric_query_pool_type_t

Added in version 1.0

enum zet_metric_query_pool_type_t

Metric query pool types.

Values:

enumerator ZET_METRIC_QUERY_POOL_TYPE_PERFORMANCE

Performance metric query pool.

enumerator ZET_METRIC_QUERY_POOL_TYPE_EXECUTION

Skips workload execution between begin/end calls.

enumerator ZET_METRIC_QUERY_POOL_TYPE_FORCE_UINT32

Value marking end of ZET_METRIC_QUERY_POOL_TYPE_* ENUMs.

Metric Query Pool Structures

zet_metric_query_pool_desc_t

Added in version 1.0

struct zet_metric_query_pool_desc_t

Metric query pool description.

Public Members

zet_structure_type_t stype

[in] type of this structure

const void *pNext

[in][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

zet_metric_query_pool_type_t type

[in] Query pool type.

uint32_t count

[in] Internal slots count within query pool object.