[PTI-SDK] Use find_package to build samples (#3)

Instead of using environmental variables set by oneAPI, use the CMake
`find_package` commands. This is one of the primary ways of adding a
pre-built dependency to a CMake project. Also, I found sporadic build
failures with the "manual" way of including dependencies.

Fixes a task in the code comments.

Improves documentation on existing custom "Find" modules. It also
includes the copyright for CMake inside the third-party-programs.txt
file.

Fixes syntax error in `sdk/cmake/Modules/macros.cmake`. This causes a
build error on machines where `spdlog` is pre-installed.

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

Author: mschilling0

sdk/CMakeLists.txt

@@ -260,75 +260,41 @@ endif()
 
 if(PTI_BUILD_SAMPLES)
   if(HAVE_SYCL)
+    find_package(MKL CONFIG PATHS $ENV{MKLROOT} NO_DEFAULT_PATH)
+    message(STATUS "Imported oneMKL targets: ${MKL_IMPORTED_TARGETS}")
+    find_package(dnnl)
+    find_package(oneDPL)
+    find_package(TBB)
+    find_package(DevUtilities)
+
     add_subdirectory(samples/dpc_gemm)
     add_subdirectory(samples/dpc_gemm_threaded)
     add_subdirectory(samples/vector_sq_add)
-    # TODO([email protected]): A better way to do this is to write
-    # Find modules for each dependency. MKL, DNNL, DPL, etc..
-    if(DEFINED ENV{MKLROOT})
-      set(ONEMKL_IS_AVAILABLE TRUE)
-    else()
-      message(
-        WARNING
-          "Unable to detect oneMKL installation. All samples will not be built."
-      )
-    endif()
-
-    find_package(dnnl REQUIRED)
 
-    if(TARGET DNNL::dnnl)
-      set(ONEDNNL_IS_AVAILABLE TRUE)
-    else()
-      message(
-        WARNING
-          "Unable to detect oneDNNL installation. All samples will not be built."
-      )
+    if(TARGET DevUtilities::utils)
+      add_subdirectory(samples/iso3dfd_dpcpp)
     endif()
 
-    find_package(oneDPL)
-
-    if(TARGET oneDPL)
-      set(ONEDPL_IS_AVAILABLE TRUE)
+    if(TARGET MKL::MKL)
+      add_subdirectory(samples/onemkl_gemm)
     else()
       message(
         WARNING
-          "Unable to detect oneDPL installation. All samples will not be built."
+        "Unable to build onemkl_gemm sample due to missing MKL installation"
       )
     endif()
 
-    find_package(TBB)
-
-    if(TARGET TBB::tbb)
-      set(TBB_IS_AVAILABLE TRUE)
-    else()
-      message(
-        WARNING
-          "Unable to detect tbb installation. All samples will not be built.")
-    endif()
-
-    if(DEFINED ENV{ONEAPI_ROOT})
-      set(ONEAPI_IS_AVAILABLE TRUE)
+    if(TARGET MKL::MKL
+       AND TARGET DNNL::dnnl
+       AND TARGET oneDPL
+       AND TARGET TBB::tbb)
+      add_subdirectory(samples/dlworkloads)
     else()
       message(
         WARNING
-          "Unable to detect oneAPI installation. All samples will not be built."
+        "Unable to build dlworkloads sample due to missing oneAPI component(s)"
       )
     endif()
-
-    if(DEFINED ONEMKL_IS_AVAILABLE)
-      add_subdirectory(samples/onemkl_gemm)
-    endif()
-
-    if(DEFINED ONEMKL_IS_AVAILABLE
-       AND DEFINED ONEDNNL_IS_AVAILABLE
-       AND DEFINED ONEDPL_IS_AVAILABLE
-       AND DEFINED TBB_IS_AVAILABLE)
-      add_subdirectory(samples/dlworkloads)
-    endif()
-
-    if(DEFINED ONEAPI_IS_AVAILABLE)
-      add_subdirectory(samples/iso3dfd_dpcpp)
-    endif()
   endif()
 endif()
 

sdk/cmake/Modules/FindDevUtilities.cmake

@@ -0,0 +1,69 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+FindDevUtilities
+-------
+
+Finds the dpc_common library. This is a library that is part of the standard
+oneAPI installation but is not part of a oneAPI component.
+
+It is a header-only library. This module just finds its include path.
+
+It is primarily used in the
+`oneAPI samples <https://github.com/oneapi-src/oneAPI-samples>`_
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module provides the following imported targets, if found:
+
+``DevUtilities::utils``
+  Common samples include path
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This will define the following variables:
+
+``DevUtilities_FOUND``
+  True if the system has the DevUtilities library.
+``DevUtilities_INCLUDE_DIRS``
+  Include directories needed to use DevUtilities.
+
+Cache Variables
+^^^^^^^^^^^^^^^
+
+The following cache variables may also be set:
+
+``DevUtilities_INCLUDE_DIR``
+  The directory containing ``dpc_common.hpp``.
+
+#]=======================================================================]
+
+# Based on tutorial found in CMake manual:
+# https://cmake.org/cmake/help/latest/manual/cmake-developer.7.html
+if(UNIX)
+  find_path(
+    DevUtilities_INCLUDE_DIR
+    NAMES dpc_common.hpp
+    HINTS ENV CPATH ENV LD_LIBRARY_PATH ENV CMPLR_ROOT
+    PATHS /opt/intel/oneapi/dev-utilities /opt/intel/oneapi/dev-utilities/latest
+          /opt/intel/oneapi/dev-utilities/linux
+    PATH_SUFFIXES include linux/include)
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(
+  DevUtilities
+  FOUND_VAR DevUtilities_FOUND
+  REQUIRED_VARS DevUtilities_INCLUDE_DIR)
+
+if(DevUtilities_FOUND AND NOT TARGET DevUtilities::utils)
+  add_library(DevUtilities::utils INTERFACE IMPORTED)
+  set_target_properties(
+    DevUtilities::utils PROPERTIES INTERFACE_INCLUDE_DIRECTORIES
+                                   "${DevUtilities_INCLUDE_DIR}")
+endif()
+
+mark_as_advanced(DevUtilities_INCLUDE_DIR)

sdk/cmake/Modules/FindXpti.cmake

@@ -5,7 +5,13 @@
 FindXpti
 -------
 
-Finds the Xpti library.
+Finds the Xpti library. Xpti is part of the Intel/LLVM project. It is also
+included as part of the standard oneAPI installation.
+
+`Intel/LLVM <https://github.com/intel/llvm>`_
+
+Further documentation on linking and using XPTI can be found here:
+https://github.com/intel/llvm/blob/sycl/xptifw/doc/XPTI_Framework.md.
 
 Imported Targets
 ^^^^^^^^^^^^^^^^
@@ -43,7 +49,6 @@ The following cache variables may also be set:
 
 # Based on tutorial found in CMake manual:
 # https://cmake.org/cmake/help/latest/manual/cmake-developer.7.html
-# TODO: Change the copyright?
 if(UNIX)
   find_path(
     Xpti_INCLUDE_DIR

sdk/cmake/Modules/macros.cmake

@@ -767,7 +767,7 @@ endmacro()
 macro(GetSpdlog)
   find_package(spdlog 1.6.0 QUIET)
 
-  if(NOT spdlog::spdlog OR NOT spdlog::spdlog_header_only)
+  if(NOT TARGET spdlog::spdlog OR NOT TARGET spdlog::spdlog_header_only)
     include(FetchContent)
     FetchContent_Declare(
       fmt
@@ -803,7 +803,7 @@ macro(GetSpdlog)
 endmacro()
 
 macro(GetGTest)
-  if(NOT GTest::gtest OR NOT GTest::gtest_main)
+  if(NOT TARGET GTest::gtest OR NOT TARGET GTest::gtest_main)
     include(FetchContent)
     FetchContent_Declare(
       googletest

sdk/samples/dlworkloads/CMakeLists.txt

@@ -17,18 +17,22 @@ add_link_options(-fsycl -gline-tables-only)
 add_executable(dlworkload ${SOURCES})
 target_include_directories(dlworkload PRIVATE ../samples_utilities)
 
-find_package(oneDPL REQUIRED)
-
 # Allow building in-source and out-of-source
 if (NOT TARGET Pti::pti_view)
   find_package(Pti REQUIRED)
 endif()
 
+if (NOT TARGET oneDPL)
+  find_package(oneDPL REQUIRED)
+endif()
+
 if (NOT TARGET DNNL::dnnl)
   find_package(dnnl REQUIRED)
 endif()
 
-target_include_directories(dlworkload SYSTEM PUBLIC $ENV{MKLROOT}/include)
-
-target_link_libraries(dlworkload PUBLIC DNNL::dnnl -lmkl_sycl -lmkl_intel_ilp64 -lmkl_core -lmkl_tbb_thread oneDPL Pti::pti_view)
+if (NOT TARGET MKL::MKL)
+  find_package(MKL REQUIRED)
+endif()
 
+target_include_directories(dlworkload SYSTEM PUBLIC $<TARGET_PROPERTY:MKL::MKL,INTERFACE_INCLUDE_DIRECTORIES>)
+target_link_libraries(dlworkload DNNL::dnnl -lmkl_sycl -lmkl_intel_ilp64 -lmkl_core -lmkl_tbb_thread oneDPL Pti::pti_view)

sdk/samples/iso3dfd_dpcpp/CMakeLists.txt

@@ -28,4 +28,9 @@ if (NOT TARGET Pti::pti_view)
   find_package(Pti REQUIRED)
 endif()
 
+if (NOT TARGET DevUtilities::utils)
+  find_package(DevUtilities REQUIRED)
+endif()
+
+
 add_subdirectory (src)

sdk/samples/iso3dfd_dpcpp/src/CMakeLists.txt

@@ -18,7 +18,7 @@ target_link_options(iso3dfd.exe PUBLIC -O3 -fsycl --std=c++17)
 target_include_directories(
   iso3dfd.exe PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../samples_utilities
                       ${CMAKE_CURRENT_SOURCE_DIR}/../include)
-target_link_libraries(iso3dfd.exe PUBLIC Pti::pti_view sycl)
+target_link_libraries(iso3dfd.exe PUBLIC Pti::pti_view sycl DevUtilities::utils)
 
 if(SHARED_KERNEL)
   target_compile_definitions(iso3dfd.exe PUBLIC USED_SHARED)

sdk/samples/iso3dfd_dpcpp/src/iso3dfd.cpp

@@ -34,7 +34,7 @@
 #include <iostream>
 #include <string>
 #include "device_selector.hpp"
-#include "dpc_common.hpp"
+#include <dpc_common.hpp>
 #include "pti_view.h"
 #include "samples_utils.h"
 namespace oneapi {}

sdk/samples/onemkl_gemm/CMakeLists.txt

@@ -16,20 +16,21 @@ if(NOT has_sycl)
   message(FATAL_ERROR "${PROJECT_NAME} requres a sycl compatible compiler")
 endif()
 
-add_compile_options(-fsycl -gline-tables-only -mkl -I$MKLROOT/include/)
-add_link_options(-fsycl -gline-tables-only -mkl -L$MKLROOT/lib -lmkl_intel_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl -lmkl_sycl)
-
 add_executable(onemkl_gemm_exe onemkl_gemm.cpp)
-target_include_directories(onemkl_gemm_exe PRIVATE ../samples_utilities)
 
 if (NOT TARGET Pti::pti_view)
   find_package(Pti REQUIRED)
 endif()
 
-target_link_libraries(onemkl_gemm_exe PUBLIC Pti::pti_view)
+if (NOT TARGET MKL::MKL)
+  find_package(MKL REQUIRED)
+endif()
+
+target_compile_options(onemkl_gemm_exe PUBLIC "-fsycl" "-mkl" "-gline-tables-only")
+target_link_options(onemkl_gemm_exe PUBLIC "-fsycl" "-mkl" "-gline-tables-only")
 
+target_link_libraries(onemkl_gemm_exe PUBLIC mkl_intel_lp64 mkl_sequential mkl_core mkl_sycl Pti::pti_view)
+target_include_directories(onemkl_gemm_exe SYSTEM PUBLIC $<TARGET_PROPERTY:MKL::MKL,INTERFACE_INCLUDE_DIRECTORIES>)
 target_include_directories(onemkl_gemm_exe
-                           PRIVATE "${PROJECT_SOURCE_DIR}/../../src/utils")
-if(CMAKE_INCLUDE_PATH)
-  target_include_directories(onemkl_gemm_exe PUBLIC "${CMAKE_INCLUDE_PATH}")
-endif()
+                           PRIVATE "${PROJECT_SOURCE_DIR}/../../src/utils"
+                           "${PROJECT_SOURCE_DIR}/../samples_utilities")