Tracer ROCTX API Data

Tracer ROCTX API Data#

ROCProfilerV1 API: Tracer ROCTX API Data

Enumerations
enum	rocprofiler_tracer_roctx_api_data_info_t { ROCPROFILER_ROCTX_MESSAGE = 0 , ROCPROFILER_ROCTX_ID = 1 }
	ROCTX Tracer Data Information Kinds. More...

Functions
ROCPROFILER_API rocprofiler_status_t	rocprofiler_query_roctx_tracer_api_data_info_size (rocprofiler_session_id_t session_id, rocprofiler_tracer_roctx_api_data_info_t kind, rocprofiler_tracer_api_data_handle_t api_data_id, rocprofiler_tracer_operation_id_t operation_id, size_t *data_size) ROCPROFILER_VERSION_9_0
	Query Tracer API Call Data Information size to allow the user to allocate the right size for the information data requested, the information will be collected using ::rocprofiler_tracer_api_data_id_t by using ::rocprofiler_query_tracer_api_data_info and the user need to identify one type of information available in ::rocprofiler_query_tracer_api_data_info. More...

ROCPROFILER_API rocprofiler_status_t	rocprofiler_query_roctx_tracer_api_data_info (rocprofiler_session_id_t session_id, rocprofiler_tracer_roctx_api_data_info_t kind, rocprofiler_tracer_api_data_handle_t api_data_id, rocprofiler_tracer_operation_id_t operation_id, char **data) ROCPROFILER_VERSION_9_0
	Query API Data Information using an allocated data pointer by the user, user can get the size of the data using ::rocprofiler_query_tracer_api_data_info_length, the user can get the data using ::rocprofiler_tracer_api_data_id_t and the user need to identify one type of information available in ::rocprofiler_tracer_api_data_info_t. More...

Detailed Description

Enumeration Type Documentation

◆ rocprofiler_tracer_roctx_api_data_info_t

enum rocprofiler_tracer_roctx_api_data_info_t

ROCTX Tracer Data Information Kinds.

Enumerator
ROCPROFILER_ROCTX_MESSAGE	ROCTX Tracer Data kind that can be used to return ROCTX message.
ROCPROFILER_ROCTX_ID	ROCTX Tracer Data kind that can be used to return ROCTX id.

Function Documentation

◆ rocprofiler_query_roctx_tracer_api_data_info()

ROCPROFILER_API rocprofiler_status_t rocprofiler_query_roctx_tracer_api_data_info	(	rocprofiler_session_id_t	session_id,
		rocprofiler_tracer_roctx_api_data_info_t	kind,
		rocprofiler_tracer_api_data_handle_t	api_data_id,
		rocprofiler_tracer_operation_id_t	operation_id,
		char **	data
	)

Query API Data Information using an allocated data pointer by the user, user can get the size of the data using ::rocprofiler_query_tracer_api_data_info_length, the user can get the data using ::rocprofiler_tracer_api_data_id_t and the user need to identify one type of information available in ::rocprofiler_tracer_api_data_info_t.

Parameters

[in]	session_id	Session id where this data was collected
[in]	kind	Information kind requested by the user
[in]	api_data_id	API Data ID
[in]	operation_id	API Operation ID
[out]	data	API Data Data

Return values

ROCPROFILER_STATUS_SUCCESS,if	the information was found
ROCPROFILER_STATUS_ERROR_NOT_INITIALIZED,if	rocprofiler_initialize wasn't called before or if rocprofiler_finalize is called
ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_NOT_FOUND,if	the api data was not found in the saved api data
ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_INFORMATION_MISSING,if	the api data was found in the saved data but the required information is missing
ROCPROFILER_STATUS_ERROR_INCORRECT_DOMAIN	if the user sent a handle that is not related to the requested domain

◆ rocprofiler_query_roctx_tracer_api_data_info_size()

ROCPROFILER_API rocprofiler_status_t rocprofiler_query_roctx_tracer_api_data_info_size	(	rocprofiler_session_id_t	session_id,
		rocprofiler_tracer_roctx_api_data_info_t	kind,
		rocprofiler_tracer_api_data_handle_t	api_data_id,
		rocprofiler_tracer_operation_id_t	operation_id,
		size_t *	data_size
	)

Query Tracer API Call Data Information size to allow the user to allocate the right size for the information data requested, the information will be collected using ::rocprofiler_tracer_api_data_id_t by using ::rocprofiler_query_tracer_api_data_info and the user need to identify one type of information available in ::rocprofiler_query_tracer_api_data_info.