ROCTx Ranges

ROCTx Ranges#

ROCTx Developer API: ROCTx Ranges

ROCTx Developer API 0.6.0

ROCm Profiling API and tools

Functions
int	roctxRangePushA (const char *message) ROCTX_API ROCTX_NONNULL(1)

int	roctxRangePop () ROCTX_API

roctx_range_id_t	roctxRangeStartA (const char *message) ROCTX_API ROCTX_NONNULL(1)
	Starts a process range.

void	roctxRangeStop (roctx_range_id_t id) ROCTX_API

Detailed Description

Range annotations are used to describe events in a ROCm application.

Function Documentation

◆ roctxRangePop()

int roctxRangePop ( )

Stop the current nested range.

Stop the current nested range, and pop it from the stack. If a nested range was active before the last one was started, it becomes again the current nested range.

Returns: Returns the level the stopped nested range was started at, or a negative value if there was no nested range active.

◆ roctxRangePushA()

int roctxRangePushA ( const char * message )

Start a new nested range.

Nested ranges are stacked and local to the current CPU thread.

Parameters

[in] message The message associated with this range.

Returns: Returns the level this nested range is started at. Nested range levels are 0 based.

◆ roctxRangeStartA()

roctx_range_id_t roctxRangeStartA ( const char * message )

Starts a process range.

Start/stop ranges can be started and stopped in different threads. Each timespan is assigned a unique range ID.