rocprofiler-sdk-roctx/version.h Source File

rocprofiler-sdk-roctx/version.h Source File#

ROCTx developer API: rocprofiler-sdk-roctx/version.h Source File
ROCTx developer API 1.0.0
ROCm Profiling API and tools
version.h
1// MIT License
2//
3// Copyright (c) 2023-2025 Advanced Micro Devices, Inc. All rights reserved.
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in all
13// copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21// SOFTWARE.
22
23#pragma once
24
25/**
26 * @def ROCTX_IS_ROCPROFILER_SDK
27 * @brief Preprocessor define indicating the roctx header is a rocprofiler-sdk project
28 * @addtogroup VERSIONING_GROUP
29 *
30 * @def ROCTX_VERSION_MAJOR
31 * @brief The major version of the interface as a macro so it can be used
32 * by the preprocessor.
33 * @addtogroup VERSIONING_GROUP
34 *
35 * @def ROCTX_VERSION_MINOR
36 * @brief The minor version of the interface as a macro so it can be used
37 * by the preprocessor.
38 * @addtogroup VERSIONING_GROUP
39 *
40 * @def ROCTX_VERSION_PATCH
41 * @brief The patch version of the interface as a macro so it can be used
42 * by the preprocessor.
43 * @addtogroup VERSIONING_GROUP
44 *
45 * @def ROCTX_VERSION
46 * @brief Numerically increasing version number encoding major, minor, and patch via
47 computing `((10000 * <MAJOR>) + (100 * <MINOR>) + <PATCH>)`.
48 * @addtogroup VERSIONING_GROUP
49 *
50 * @def ROCTX_SOVERSION
51 * @brief Shared object versioning value whose value is at least `(10000 * <MAJOR>)`.
52 * @addtogroup VERSIONING_GROUP
53 *
54 * @def ROCTX_VERSION_STRING
55 * @brief Version string in form: `<MAJOR>.<MINOR>.<PATCH>`.
56 * @addtogroup VERSIONING_GROUP
57 *
58 * @def ROCTX_GIT_DESCRIBE
59 * @brief String encoding of `git describe --tags` when rocprofiler was built.
60 * @addtogroup VERSIONING_GROUP
61 *
62 * @def ROCTX_GIT_REVISION
63 * @brief String encoding of `git rev-parse HEAD` when rocprofiler was built.
64 * @addtogroup VERSIONING_GROUP
65 *
66 * @def ROCTX_LIBRARY_ARCH
67 * @brief Architecture triplet of rocprofiler build.
68 * @addtogroup VERSIONING_GROUP
69 *
70 * @def ROCTX_SYSTEM_NAME
71 * @brief Target operating system for rocprofiler build, e.g. Linux.
72 * @addtogroup VERSIONING_GROUP
73 *
74 * @def ROCTX_SYSTEM_PROCESSOR
75 * @brief Target architecture for rocprofiler build.
76 * @addtogroup VERSIONING_GROUP
77 *
78 * @def ROCTX_SYSTEM_VERSION
79 * @brief Version of the operating system which built rocprofiler
80 * @addtogroup VERSIONING_GROUP
81 *
82 * @def ROCTX_COMPILER_ID
83 * @brief C++ compiler identifier which built rocprofiler, e.g., GNU
84 * @addtogroup VERSIONING_GROUP
85 *
86 * @def ROCTX_COMPILER_VERSION
87 * @brief C++ compiler version which built rocprofiler
88 * @addtogroup VERSIONING_GROUP
89 */
90
91#define ROCTX_IS_ROCPROFILER_SDK 1
92
93// clang-format off
94#define ROCTX_VERSION_MAJOR 1
95#define ROCTX_VERSION_MINOR 0
96#define ROCTX_VERSION_PATCH 0
97#define ROCTX_SOVERSION (10000 * 1)
98#define ROCTX_VERSION_STRING "1.0.0"
99#define ROCTX_GIT_DESCRIBE ""
100#define ROCTX_GIT_REVISION "f4cce0d2d40068162166e42f526c644df6ecd7b6"
101
102// system info during compilation
103#define ROCTX_LIBRARY_ARCH "x86_64-linux-gnu"
104#define ROCTX_SYSTEM_NAME "Linux"
105#define ROCTX_SYSTEM_PROCESSOR "x86_64"
106#define ROCTX_SYSTEM_VERSION "6.8.0-1021-aws"
107
108// compiler information
109#define ROCTX_COMPILER_ID "GNU"
110#define ROCTX_COMPILER_VERSION "11.4.0"
111
112// clang-format on
113
114#define ROCTX_VERSION \
115 ((10000 * ROCTX_VERSION_MAJOR) + (100 * ROCTX_VERSION_MINOR) + ROCTX_VERSION_PATCH)