Metric Decoder - Experimental

Metric Decoder - Experimental#

oneAPI Level Zero Specification - Version 1.18.31

Metric Decoder - Experimental Functions#

zetMetricDecoderCreateExp#

Added in version 1.10

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricDecoderCreateExp(zet_metric_tracer_exp_handle_t hMetricTracer, zet_metric_decoder_exp_handle_t *phMetricDecoder)#

Create a metric decoder for a given metric tracer.

Parameters:

  • hMetricTracer – [in] handle of the metric tracer

  • phMetricDecoder – [out] handle of the metric decoder object

Returns:

zetMetricDecoderDestroyExp#

Added in version 1.10

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricDecoderDestroyExp(zet_metric_decoder_exp_handle_t phMetricDecoder)#

Destroy a metric decoder.

Parameters:

phMetricDecoder – [in] handle of the metric decoder object

Returns:

zetMetricDecoderGetDecodableMetricsExp#

Added in version 1.10

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricDecoderGetDecodableMetricsExp(zet_metric_decoder_exp_handle_t hMetricDecoder, uint32_t *pCount, zet_metric_handle_t *phMetrics)#

Return the list of the decodable metrics from the decoder.

  • The decodable metrics handles returned by this API are defined by the metric groups in the tracer on which the decoder was created.

  • The decodable metrics handles returned by this API are only valid to decode metrics raw data with zetMetricTracerDecodeExp(). Decodable metric handles are not valid to compare with metrics handles included in metric groups.

Parameters:

  • hMetricDecoder – [in] handle of the metric decoder object

  • pCount – [in,out] pointer to number of decodable metric in the hMetricDecoder handle. If count is zero, then the driver shall update the value with the total number of decodable metrics available in the decoder. if count is greater than zero but less than the total number of decodable metrics available in the decoder, then only that number will be returned. if count is greater than the number of decodable metrics available in the decoder, then the driver shall update the value with the actual number of decodable metrics available.

  • phMetrics – [in,out] [range(0, *pCount)] array of handles of decodable metrics in the hMetricDecoder handle provided.

Returns:

In this class