[PTI-SDK] Add Version Header File (#6)

Add version header generated by CMake. This includes macros for
detecting the current version of PTI and a function for determining the
compiled version of PTI.

Move *toolchain.cmake files to a separate directory.

Remove -gline-tables-only because it is not needed and it prevents gcc
builds.

Signed-off-by: Schilling, Matthew <[email protected]>

Author: mschilling0

sdk/CMakeLists.txt

@@ -56,7 +56,6 @@ if(PTI_FUZZ)
       CACHE BOOL "" FORCE)
 endif()
 
-
 include(GNUInstallDirs)
 set(PTI_INSTALL_CMAKE_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/pti")
 set(PTI_INSTALL_INCLUDE_DIR "${CMAKE_INSTALL_INCLUDEDIR}/pti")
@@ -105,6 +104,9 @@ set(PTI_DEFINE_FLAGS_EXPR
     $<$<CXX_COMPILER_ID:GNU>:$<$<NOT:$<BOOL:${PTI_SANITIZE}>>:_FORTIFY_SOURCE=2>>
 )
 
+configure_file(${PROJECT_SOURCE_DIR}/include/pti_version.h.in
+               ${PROJECT_BINARY_DIR}/include/pti_version.h)
+
 # https://cmake.org/cmake/help/latest/guide/importing-exporting/index.html
 add_library(pti SHARED "${PROJECT_SOURCE_DIR}/src/pti.cc")
 add_library(Pti::pti ALIAS pti)
@@ -117,6 +119,7 @@ generate_export_header(pti)
 target_include_directories(
   pti
   PUBLIC "$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>"
+         "$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>"
          "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"
          "$<INSTALL_INTERFACE:${PTI_INSTALL_INCLUDE_DIR}>"
   PRIVATE "${PROJECT_SOURCE_DIR}/src" "${PROJECT_SOURCE_DIR}/src/levelzero"
@@ -133,13 +136,15 @@ target_compile_options(pti PRIVATE ${PTI_COMPILE_FLAGS_EXPR})
 target_link_options(pti PRIVATE ${PTI_LINK_FLAGS_EXPR})
 target_compile_definitions(pti PRIVATE ${PTI_DEFINE_FLAGS_EXPR})
 
-add_library(pti_view SHARED "${PROJECT_SOURCE_DIR}/src/pti_view.cc")
+add_library(pti_view SHARED "${PROJECT_SOURCE_DIR}/src/pti_view.cc"
+                            "${PROJECT_SOURCE_DIR}/src/pti_version.cc")
 add_library(Pti::pti_view ALIAS pti_view)
 # add_library(pti_callback SHARED "..") add_library(pti_event SHARED "..")
 # add_library(pti_metric SHARED "..") add_library(pti_profiling SHARED "..") ..
 target_include_directories(
   pti_view
   PUBLIC "$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>"
+         "$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>"
          "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"
          "$<INSTALL_INTERFACE:${PTI_INSTALL_INCLUDE_DIR}>"
   PRIVATE "${PROJECT_SOURCE_DIR}/src" "${PROJECT_SOURCE_DIR}/src/syclpi"
@@ -218,7 +223,7 @@ if(PTI_INSTALL)
   write_basic_package_version_file(
     "${PROJECT_BINARY_DIR}/PtiConfigVersion.cmake"
     VERSION "${PROJECT_VERSION}"
-    COMPATIBILITY SameMajorVersion)
+    COMPATIBILITY SameMinorVersion)
 
   install(FILES "${PROJECT_BINARY_DIR}/PtiConfig.cmake"
                 "${PROJECT_BINARY_DIR}/PtiConfigVersion.cmake"
@@ -239,9 +244,13 @@ if(PTI_INSTALL)
   install(FILES "${PROJECT_BINARY_DIR}/pti_export.h"
           DESTINATION "${PTI_INSTALL_INCLUDE_DIR}")
 
-  install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/"
+  install(FILES "${PROJECT_BINARY_DIR}/include/pti_version.h"
           DESTINATION "${PTI_INSTALL_INCLUDE_DIR}")
 
+  install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/"
+          DESTINATION "${PTI_INSTALL_INCLUDE_DIR}"
+          FILES_MATCHING PATTERN "*.h")
+
   install(
     EXPORT PtiTargets
     FILE PtiTargets.cmake

sdk/CMakePresets.json

@@ -9,7 +9,7 @@
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release",
-        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/icpx_toolchain.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/toolchains/icpx_toolchain.cmake"
       }
     },
     {
@@ -43,7 +43,7 @@
       "binaryDir": "${sourceDir}/build-${presetName}",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
-        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/icpx_asan_toolchain.cmake",
+        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/toolchains/icpx_asan_toolchain.cmake",
         "PTI_SANITIZE": true
       },
       "environment": {
@@ -62,7 +62,7 @@
       "binaryDir": "${sourceDir}/build-${presetName}",
       "cacheVariables": {
         "PTI_FUZZ": true,
-        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/icpx_fuzz_toolchain.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/toolchains/icpx_fuzz_toolchain.cmake"
       }
     },
     {
@@ -71,7 +71,7 @@
       "displayName": "ThreadSanitizer Test Config",
       "description": "Build configuration for thread sanitizer.",
       "cacheVariables": {
-        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/icpx_tsan_toolchain.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/toolchains/icpx_tsan_toolchain.cmake"
       }
     },
     {
@@ -81,7 +81,7 @@
       "description": "Build Configuration for building PTI without ICPX",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release",
-        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/clang_toolchain.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/cmake/toolchains/clang_toolchain.cmake"
       }
     }
   ],

sdk/README.md

@@ -71,7 +71,7 @@ From `build` directory:
 ```console
 >> mkdir build
 >> cd build
->> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=../cmake/icpx_toolchain.cmake -DBUILD_TESTING=OFF ..
+>> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/icpx_toolchain.cmake -DBUILD_TESTING=OFF ..
 >> make -j
 >> cmake --install . --config Release --prefix "../out"
 ```

sdk/cmake/clang_toolchain.cmake renamed to sdk/cmake/toolchains/clang_toolchain.cmake

@@ -7,6 +7,7 @@
 #ifndef INCLUDE_PTI_H_
 #define INCLUDE_PTI_H_
 
+#include "pti_version.h"
 #include "pti_view.h"
 
 #endif  // INCLUDE_PTI_H_

sdk/cmake/icpx_asan_toolchain.cmake renamed to sdk/cmake/toolchains/icpx_asan_toolchain.cmake

@@ -0,0 +1,52 @@
+//==============================================================
+// Copyright (C) Intel Corporation
+//
+// SPDX-License-Identifier: MIT
+// =============================================================
+#ifndef INCLUDE_PTI_VERSION_H_
+#define INCLUDE_PTI_VERSION_H_
+
+#include <stdint.h>
+
+#include "pti_export.h"
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/* clang-format off */
+#if !defined(PTI_VERSION)
+#define PTI_VERSION @PTI_VERSION@
+#endif
+
+#define PTI_VERSION_STRING "@PTI_VERSION@"
+#define PTI_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
+#define PTI_VERSION_MINOR @PROJECT_VERSION_MINOR@
+#define PTI_VERSION_PATCH @PROJECT_VERSION_PATCH@
+/* clang-format on */
+
+typedef struct pti_version {
+  uint32_t _major;
+  uint32_t _minor;
+  uint32_t _patch;
+} pti_version;
+
+/**
+ * @brief Returns the compiled version of PTI
+ *
+ * @return c-string with compiled version of PTI
+ */
+const char* PTI_EXPORT ptiVersionString();
+
+/**
+ * @brief Returns the compiled version of PTI
+ *
+ * @return pti_version struct with compiled version of PTI
+ */
+pti_version PTI_EXPORT ptiVersion();
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif  // INCLUDE_PTI_VERSION_H_