rocprofiler-sdk/registration.h Source File#
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
|
registration.h
Go to the documentation of this file.
39 * services. e.g: any third party tool like PAPI or any internal tool (Omnitrace). A pointer to this
40 * data structure is provided to the client tool initialization function. The name member can be set
41 * by the client to assist with debugging (e.g. rocprofiler cannot start your context because there
42 * is a conflicting context started by `<name>` -- at least that is the plan). The handle member is
43 * a unique identifer assigned by rocprofiler for the client and the client can store it and pass it
44 * to the @ref rocprofiler_client_finalize_t function to force finalization (i.e. deactivate all of
85 * After rocprofiler has retrieved all instances of ::rocprofiler_tool_configure_result_t from the
105 * rocprofiler_configure (or is currently scanning). If rocprofiler has completed it's scan, clients
109 * indicates rocprofiler has been initialized, -1 indicates rocprofiler is currently initializing.
119 * @param [out] status 0 indicates rocprofiler has not been finalized, 1 indicates rocprofiler has
132 * necessary) which will be invoked when rocprofiler shutdown and, (3) a pointer to any data that
133 * the tool wants communicated between the @ref rocprofiler_tool_configure_result_t::initialize and
137 * @param [in] runtime_version String descriptor of the rocprofiler version and other relevant info.
232 * @param [in] runtime_version String descriptor of the rocprofiler version and other relevant info.
243 * @brief Function for explicitly registering a configuration with rocprofiler. This can be invoked
244 * before any ROCm runtimes (lazily) initialize and context(s) can be started before the runtimes
250 * @retval ::ROCPROFILER_STATUS_ERROR_CONFIGURATION_LOCKED Returned if rocprofiler has already been
void(* rocprofiler_tool_finalize_t)(void *tool_data)
Prototype for the finalize function where a tool does any cleanup or output operations once it has fi...
Definition registration.h:80
void(* rocprofiler_client_finalize_t)(rocprofiler_client_id_t)
Prototype for the function pointer provided to tool in rocprofiler_tool_initialize_t....
Definition registration.h:61
int(* rocprofiler_tool_initialize_t)(rocprofiler_client_finalize_t finalize_func, void *tool_data)
Prototype for the initialize function where a tool creates contexts for the set of rocprofiler servic...
Definition registration.h:71
rocprofiler_tool_configure_result_t *(* rocprofiler_configure_func_t)(uint32_t version, const char *runtime_version, uint32_t priority, rocprofiler_client_id_t *client_id)
Function pointer typedef for rocprofiler_configure function.
Definition registration.h:236
rocprofiler_tool_configure_result_t * rocprofiler_configure(uint32_t version, const char *runtime_version, uint32_t priority, rocprofiler_client_id_t *client_id)
This is the special function that tools define to enable rocprofiler support. The tool should return ...
rocprofiler_status_t rocprofiler_is_initialized(int *status)
Query whether rocprofiler has already scanned the binary for all the instances of rocprofiler_configu...
rocprofiler_status_t rocprofiler_force_configure(rocprofiler_configure_func_t configure_func)
Function for explicitly registering a configuration with rocprofiler. This can be invoked before any ...
rocprofiler_status_t rocprofiler_is_finalized(int *status)
Query rocprofiler finalization status.
A client refers to an individual or entity engaged in the configuration of ROCprofiler services....
Definition registration.h:48
Data structure containing a initialization, finalization, and data.
Definition registration.h:96
Generated by 1.9.8