rocprofiler-sdk/version.h Source File

rocprofiler-sdk/version.h Source File#

Rocprofiler SDK Developer API: rocprofiler-sdk/version.h Source File
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
version.h
Go to the documentation of this file.
1// MIT License
2//
3// Copyright (c) 2023 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 ROCPROFILER_IS_ROCPROFILER_SDK
27 * @brief Preprocessor define indicating the rocprofiler header is a rocprofiler-sdk project
28 * @addtogroup VERSIONING_GROUP
29 *
30 * @def ROCPROFILER_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 ROCPROFILER_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 ROCPROFILER_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 ROCPROFILER_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 ROCPROFILER_SOVERSION
51 * @brief Shared object versioning value whose value is at least `(10000 * <MAJOR>)`.
52 * @addtogroup VERSIONING_GROUP
53 *
54 * @def ROCPROFILER_VERSION_STRING
55 * @brief Version string in form: `<MAJOR>.<MINOR>.<PATCH>`.
56 * @addtogroup VERSIONING_GROUP
57 *
58 * @def ROCPROFILER_GIT_DESCRIBE
59 * @brief String encoding of `git describe --tags` when rocprofiler was built.
60 * @addtogroup VERSIONING_GROUP
61 *
62 * @def ROCPROFILER_GIT_REVISION
63 * @brief String encoding of `git rev-parse HEAD` when rocprofiler was built.
64 * @addtogroup VERSIONING_GROUP
65 *
66 * @def ROCPROFILER_LIBRARY_ARCH
67 * @brief Architecture triplet of rocprofiler build.
68 * @addtogroup VERSIONING_GROUP
69 *
70 * @def ROCPROFILER_SYSTEM_NAME
71 * @brief Target operating system for rocprofiler build, e.g. Linux.
72 * @addtogroup VERSIONING_GROUP
73 *
74 * @def ROCPROFILER_SYSTEM_PROCESSOR
75 * @brief Target architecture for rocprofiler build.
76 * @addtogroup VERSIONING_GROUP
77 *
78 * @def ROCPROFILER_SYSTEM_VERSION
79 * @brief Version of the operating system which built rocprofiler
80 * @addtogroup VERSIONING_GROUP
81 *
82 * @def ROCPROFILER_COMPILER_ID
83 * @brief C++ compiler identifier which built rocprofiler, e.g., GNU
84 * @addtogroup VERSIONING_GROUP
85 *
86 * @def ROCPROFILER_COMPILER_VERSION
87 * @brief C++ compiler version which built rocprofiler
88 * @addtogroup VERSIONING_GROUP
89 */
90
91#define ROCPROFILER_IS_ROCPROFILER_SDK 1
92
93// clang-format off
94#define ROCPROFILER_VERSION_MAJOR
95#define ROCPROFILER_VERSION_MINOR
96#define ROCPROFILER_VERSION_PATCH
97#define ROCPROFILER_SOVERSION (10000 * )
98#define ROCPROFILER_VERSION_STRING ""
99#define ROCPROFILER_GIT_DESCRIBE ""
100#define ROCPROFILER_GIT_REVISION ""
101
102// system info during compilation
103#define ROCPROFILER_LIBRARY_ARCH "x86_64-linux-gnu"
104#define ROCPROFILER_SYSTEM_NAME "Linux"
105#define ROCPROFILER_SYSTEM_PROCESSOR "x86_64"
106#define ROCPROFILER_SYSTEM_VERSION "5.19.0-1028-aws"
107
108// compiler information
109#define ROCPROFILER_COMPILER_ID "GNU"
110#define ROCPROFILER_COMPILER_VERSION "11.4.0"
111
112#define ROCPROFILER_HSA_RUNTIME_VERSION_MAJOR
113#define ROCPROFILER_HSA_RUNTIME_VERSION_MINOR
114
115/* #undef ROCPROFILER_HSA_API_TABLE_MAJOR_VERSION */
116/* #undef ROCPROFILER_HSA_CORE_API_TABLE_MAJOR_VERSION */
117/* #undef ROCPROFILER_HSA_AMD_EXT_API_TABLE_MAJOR_VERSION */
118/* #undef ROCPROFILER_HSA_FINALIZER_API_TABLE_MAJOR_VERSION */
119/* #undef ROCPROFILER_HSA_IMAGE_API_TABLE_MAJOR_VERSION */
120/* #undef ROCPROFILER_HSA_AQLPROFILE_API_TABLE_MAJOR_VERSION */
121/* #undef ROCPROFILER_HSA_TOOLS_API_TABLE_MAJOR_VERSION */
122
123/* #undef ROCPROFILER_HSA_API_TABLE_STEP_VERSION */
124/* #undef ROCPROFILER_HSA_CORE_API_TABLE_STEP_VERSION */
125/* #undef ROCPROFILER_HSA_AMD_EXT_API_TABLE_STEP_VERSION */
126/* #undef ROCPROFILER_HSA_FINALIZER_API_TABLE_STEP_VERSION */
127/* #undef ROCPROFILER_HSA_IMAGE_API_TABLE_STEP_VERSION */
128/* #undef ROCPROFILER_HSA_AQLPROFILE_API_TABLE_STEP_VERSION */
129/* #undef ROCPROFILER_HSA_TOOLS_API_TABLE_STEP_VERSION */
130// clang-format on
131
132#define ROCPROFILER_VERSION \
133 ((10000 * ROCPROFILER_VERSION_MAJOR) + (100 * ROCPROFILER_VERSION_MINOR) + \
134 ROCPROFILER_VERSION_PATCH)
135
136// latest hsa-runtime version supported
137#define ROCPROFILER_HSA_RUNTIME_VERSION \
138 ((10000 * ROCPROFILER_HSA_RUNTIME_VERSION_MAJOR) + \
139 (100 * ROCPROFILER_HSA_RUNTIME_VERSION_MINOR))
Generated by doxygen 1.9.8