Miscellaneous Utility Functions

Miscellaneous Utility Functions#

Rocprofiler SDK Developer API: Miscellaneous Utility Functions
Rocprofiler SDK Developer API 0.4.0
ROCm Profiling API and tools
Miscellaneous Utility Functions

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.
 

Detailed Description

Function Documentation

◆ rocprofiler_get_status_name()

const char * rocprofiler_get_status_name ( rocprofiler_status_t  status)

Return the string encoding of rocprofiler_status_t value.

Parameters
[in]statuserror code value
Returns
Will return a nullptr if invalid/unsupported rocprofiler_status_t value is provided.

◆ rocprofiler_get_status_string()

const char * rocprofiler_get_status_string ( rocprofiler_status_t  status)

Return the message associated with rocprofiler_status_t value.

Parameters
[in]statuserror code value
Returns
Will return a nullptr if invalid/unsupported rocprofiler_status_t value is provided.

◆ rocprofiler_get_thread_id()

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]tidOutput address of the rocprofiler thread id value
Examples
api_buffered_tracing/client.cpp.

◆ rocprofiler_get_timestamp()

rocprofiler_status_t rocprofiler_get_timestamp ( rocprofiler_timestamp_t ts)

Get the timestamp value that rocprofiler uses.

Parameters
[out]tsOutput address of the rocprofiler timestamp value