API Description

API and implementation versions.

ODP API version is identified by ODP_VERSION_API_XXX preprocessor macros. In addition to these macros, API calls can be used to identify implementation and API version information at run time.

Macros
#define	ODP_VERSION_API_GENERATION 1
	ODP API generation version. More...

#define	ODP_VERSION_API_MAJOR 45
	ODP API major version. More...

#define	ODP_VERSION_API_MINOR 1
	ODP API minor version. More...

#define	ODP_VERSION_API_NUM(gen, ma, mi) ((gen) << 24 \| (ma) << 16 \| (mi) << 8)
	ODP API version number macro. More...

#define	ODP_VERSION_API
	ODP API version number. More...

Functions
const char *	odp_version_api_str (void)
	ODP API version string. More...

const char *	odp_version_impl_name (void)
	Implementation name string. More...

const char *	odp_version_impl_str (void)
	Implementation version string. More...

Macro Definition Documentation

◆ ODP_VERSION_API_GENERATION

#define ODP_VERSION_API_GENERATION 1

ODP API generation version.

Introduction of major new features or changes that make very significant changes to the API. APIs with different versions are likely not backward compatible.

Definition at line 37 of file api/spec/version.h.

◆ ODP_VERSION_API_MAJOR

#define ODP_VERSION_API_MAJOR 45

ODP API major version.

Introduction of major new features or changes. APIs with different major versions are likely not backward compatible.

Definition at line 45 of file api/spec/version.h.

◆ ODP_VERSION_API_MINOR

#define ODP_VERSION_API_MINOR 1

ODP API minor version.

Minor version is incremented when introducing backward compatible changes to the API. For an API with common generation and major version, but with different minor numbers the two versions are backward compatible.

Definition at line 54 of file api/spec/version.h.

◆ ODP_VERSION_API_NUM

#define ODP_VERSION_API_NUM	(	gen,
		ma,
		mi
	)	((gen) << 24 \| (ma) << 16 \| (mi) << 8)

ODP API version number macro.

Macro to build a version number for comparisons

Definition at line 61 of file api/spec/version.h.

◆ ODP_VERSION_API

#define ODP_VERSION_API

Value:

                        ODP_VERSION_API_NUM(ODP_VERSION_API_GENERATION, \
                        ODP_VERSION_API_MAJOR, \
                        ODP_VERSION_API_MINOR)

ODP API version number.

API version number for comparisons against ODP_VERSION_API_NUM() macro output.

Definition at line 69 of file api/spec/version.h.

Function Documentation

◆ odp_version_api_str()

const char* odp_version_api_str ( void )

ODP API version string.

The API version string defines ODP API version in this format:

<generation>.<major>.<minor>

The string is null terminated.

Returns: Pointer to API version string

Examples: odp_sysinfo.c.

◆ odp_version_impl_name()

const char* odp_version_impl_name ( void )

Implementation name string.

This is a free format string which identifies the implementation with a unique name. The string should be compact and remain constant over multiple API and implementation versions. Application can use this to identify the underlying implementation at run time. The string is null terminated.

Returns: Pointer to implementation name string

Examples: odp_sysinfo.c.

◆ odp_version_impl_str()

const char* odp_version_impl_str ( void )

Implementation version string.

This is a free format string which identifies the implementation with detailed version information. The string may include information about implementation version, bug fix level, version control tags, build number, etc details which exactly identify the implementation code base. User may include this information e.g. to bug reports. The string is null terminated.

See also: odp_version_api_str(), odp_version_impl_name()

Returns: Pointer to implementation specific version identifier string

Examples: odp_sysinfo.c.