Miscellaneous Utility Functions

Miscellaneous Utility Functions#

ROCprofiler-SDK developer API: Miscellaneous Utility Functions

ROCprofiler-SDK developer API 1.0.0

ROCm Profiling API and tools

utility functions for library More...

Functions
rocprofiler_status_t	rocprofiler_get_timestamp (rocprofiler_timestamp_t *ts)
	Get the timestamp value that rocprofiler uses.

rocprofiler_status_t	rocprofiler_get_thread_id (rocprofiler_thread_id_t *tid)
	Get the identifier value of the current thread that is used by rocprofiler.

const char *	rocprofiler_get_status_name (rocprofiler_status_t status)
	Return the string encoding of rocprofiler_status_t value.

const char *	rocprofiler_get_status_string (rocprofiler_status_t status)
	Return the message associated with rocprofiler_status_t value.

utility functions for library

const char * rocprofiler_get_status_name ( rocprofiler_status_t status )

Return the string encoding of rocprofiler_status_t value.

Parameters

[in] status error code value

Returns: Will return a nullptr if invalid/unsupported rocprofiler_status_t value is provided.

const char * rocprofiler_get_status_string ( rocprofiler_status_t status )

Return the message associated with rocprofiler_status_t value.

Parameters

[in] status error code value

Returns: Will return a nullptr if invalid/unsupported rocprofiler_status_t value is provided.

rocprofiler_status_t rocprofiler_get_thread_id ( rocprofiler_thread_id_t * tid )

Get the identifier value of the current thread that is used by rocprofiler.

Parameters

[out] tid Output address of the rocprofiler thread id value

Return values

ROCPROFILER_STATUS_SUCCESS Always returned

Examples: api_buffered_tracing/client.cpp, and samples/api_buffered_tracing/client.cpp.

rocprofiler_status_t rocprofiler_get_timestamp ( rocprofiler_timestamp_t * ts )

Get the timestamp value that rocprofiler uses.

Parameters

[out] ts Output address of the rocprofiler timestamp value

Return values

ROCPROFILER_STATUS_SUCCESS Always returned