Library Versioning

Library Versioning#

ROCprofiler-SDK developer API: Library Versioning

ROCprofiler-SDK developer API 1.0.0

ROCm Profiling API and tools

Version information about the interface and the associated installed library. More...

Functions
rocprofiler_status_t	rocprofiler_get_version (uint32_t major, uint32_t minor, uint32_t *patch)
	Query the version of the installed library.

rocprofiler_status_t	rocprofiler_get_version_triplet (rocprofiler_version_triplet_t *info)
	Simplified alternative to rocprofiler_get_version.

Detailed Description

Version information about the interface and the associated installed library.

The semantic version of the interface following semver.org rules. A context that uses this interface is only compatible with the installed library if the major version numbers match and the interface minor version number is less than or equal to the installed library minor version number.

Function Documentation

◆ rocprofiler_get_version()

rocprofiler_status_t rocprofiler_get_version	(	uint32_t *	major,
		uint32_t *	minor,
		uint32_t *	patch
	)

#include <rocprofiler-sdk/rocprofiler.h>

Query the version of the installed library.

Returns the version of the rocprofiler-sdk library loaded at runtime. This can be used to check if the runtime version is equal to or compatible with the version of rocprofiler-sdk used during compilation time. This function can be invoked before tool initialization.

Parameters

[out]	major	The major version number is stored if non-NULL.
[out]	minor	The minor version number is stored if non-NULL.
[out]	patch	The patch version number is stored if non-NULL.

Returns: rocprofiler_status_t

Return values

ROCPROFILER_STATUS_SUCCESS Always returned

Examples: intercept_table/client.cpp.

◆ rocprofiler_get_version_triplet()

rocprofiler_status_t rocprofiler_get_version_triplet ( rocprofiler_version_triplet_t * info )