Tool registration for OpenMP Tools

Tool registration for OpenMP Tools#

ROCprofiler-SDK developer API: Tool registration for OpenMP Tools

ROCprofiler-SDK developer API 1.0.0

ROCm Profiling API and tools

Functions
rocprofiler_status_t	rocprofiler_ompt_is_initialized (int *status)
	(experimental) Query whether rocprofiler-sdk OMPT implementation has been initialized by OpenMP runtime.

rocprofiler_status_t	rocprofiler_ompt_is_finalized (int *status)
	(experimental) Query whether rocprofiler-sdk OMPT implementation has invoked ompt_finalize function.

ompt_start_tool_result_t *	rocprofiler_ompt_start_tool (unsigned int omp_version, const char *runtime_version)
	(experimental) If a tool which contains a "ompt_start_tool" function which is invoked by the OpenMP runtime but the tool wishes to defer to rocprofiler-sdk to be the OMPT tool, it should invoke this function from it's `ompt_start_tool` implementation.

Detailed Description

Functions for enabling OMPT support in tools which provide their own ompt_start_tool symbol but want to defer to rocprofiler-sdk for OMPT.

Function Documentation

◆ rocprofiler_ompt_is_finalized()

rocprofiler_status_t rocprofiler_ompt_is_finalized ( int * status )

#include <rocprofiler-sdk/ompt.h>

(experimental) Query whether rocprofiler-sdk OMPT implementation has invoked ompt_finalize function.

Parameters

[out] status Set to 0 if rocprofiler OMPT has not been finalized. Otherwise, set to 1.

Returns: rocprofiler_status_t

Return values

ROCPROFILER_STATUS_SUCCESS Always returns this value

◆ rocprofiler_ompt_is_initialized()

rocprofiler_status_t rocprofiler_ompt_is_initialized ( int * status )

#include <rocprofiler-sdk/ompt.h>

(experimental) Query whether rocprofiler-sdk OMPT implementation has been initialized by OpenMP runtime.

Parameters

[out] status Set to 0 if rocprofiler OMPT has not been initialized. Otherwise, set to 1.

Returns: rocprofiler_status_t

Return values

ROCPROFILER_STATUS_SUCCESS Always returns this value

◆ rocprofiler_ompt_start_tool()

ompt_start_tool_result_t * rocprofiler_ompt_start_tool	(	unsigned int	omp_version,
		const char *	runtime_version
	)

#include <rocprofiler-sdk/ompt.h>

(experimental) If a tool which contains a "ompt_start_tool" function which is invoked by the OpenMP runtime but the tool wishes to defer to rocprofiler-sdk to be the OMPT tool, it should invoke this function from it's ompt_start_tool implementation.

Parameters

[in]	omp_version	Refer to OpenMP OMPT docs for more information
[in]	runtime_version	Refer to OpenMP OMPT docs for more information

Returns: ompt_start_tool_result_t*