Fix compilation on Windows

uxlfoundation · Nov 14, 2024 · a2de0e5 · a2de0e5
1 parent 463fe57
commit a2de0e5
Show file tree

Hide file tree

Showing 22 changed files with 57 additions and 51 deletions.
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -48,13 +48,23 @@ function(add_deprecated_library target_name)
 endfunction()
 
 
-# Due to using the same file name for different headers in this library and in
-# the Intel(R) oneAPI Math Kernel Library, the compiler may not include the
-# expected header. Using `-iquote` lets us include this project's headers when
-# double quotes are used and external headers when angle brackets are used.
-function(target_add_onemath_include target_name)
-  target_compile_options(${target_name}
-    BEFORE PRIVATE -iquote $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+# Due to using the same directory structure and file name for different headers
+# in this library and in the Intel(R) oneAPI Math Kernel Library, the compiler
+# may not include the expected headers.
+# Intel oneMKL include path is set as system include meaning it is always
+# searched last no matter the order the order of the include flag in the command
+# line argument.
+# Using the -iquote flag is not supported on Windows.
+# To avoid confusion the include paths are set up with a different "root" folder
+# i.e.:
+#   * the oneMath include path is `${PROJECT_SOURCE_DIR}/include` and its
+#     deprecated headers can be included using `#include "oneapi/mkl/mkl.hpp"`
+#     for instance.
+#   * the Intel oneMKL include path is `${MKL_INCLUDE}/include/oneapi` and its
+#     headers can be included using `#include "mkl/mkl.hpp"` for instance.
+function(target_add_intel_onemkl_include target_name)
+  target_include_directories(${target_name}
+    PRIVATE ${MKL_INCLUDE}/oneapi
   )
 endfunction()
 

diff --git a/src/blas/backends/mkl_common/mkl_blas_backend.hpp b/src/blas/backends/mkl_common/mkl_blas_backend.hpp
@@ -23,7 +23,7 @@
 
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
-#include <oneapi/mkl/blas.hpp>
+#include <mkl/blas.hpp>
 
 #include "common_onemkl_conversion.hpp"
 #include "oneapi/math/types.hpp"

diff --git a/src/blas/backends/mklcpu/CMakeLists.txt b/src/blas/backends/mklcpu/CMakeLists.txt
@@ -31,10 +31,9 @@ if (USE_ADD_SYCL_TO_TARGET_INTEGRATION)
   add_sycl_to_target(TARGET ${LIB_OBJ} SOURCES ${SOURCES})
 endif()
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
@@ -47,6 +46,7 @@ if(TARGET MKL::MKL_SYCL::BLAS)
 else()
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_DPCPP)
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/blas/backends/mklgpu/CMakeLists.txt b/src/blas/backends/mklgpu/CMakeLists.txt
@@ -28,10 +28,9 @@ add_library(${LIB_OBJ} OBJECT
 )
 add_dependencies(onemath_backend_libs_blas ${LIB_NAME})
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
@@ -44,6 +43,7 @@ if(TARGET MKL::MKL_SYCL::BLAS)
 else()
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_DPCPP)
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/dft/backends/mklgpu/CMakeLists.txt b/src/dft/backends/mklgpu/CMakeLists.txt
@@ -37,10 +37,9 @@ target_include_directories(${LIB_NAME}
   PUBLIC ${ONEMATH_INCLUDE_DIRS}
 )
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
@@ -61,6 +60,7 @@ else()
     PRIVATE onemath_warnings
   )
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/dft/backends/mklgpu/backward.cpp b/src/dft/backends/mklgpu/backward.cpp
@@ -34,9 +34,9 @@
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
 #if INTEL_MKL_VERSION < 20250000
-#include <oneapi/mkl/dfti.hpp>
+#include <mkl/dfti.hpp>
 #else
-#include <oneapi/mkl/dft.hpp>
+#include <mkl/dft.hpp>
 #endif
 
 namespace oneapi::math::dft::mklgpu {

diff --git a/src/dft/backends/mklgpu/commit.cpp b/src/dft/backends/mklgpu/commit.cpp
@@ -39,9 +39,9 @@
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
 #if INTEL_MKL_VERSION < 20250000
-#include <oneapi/mkl/dfti.hpp>
+#include <mkl/dfti.hpp>
 #else
-#include <oneapi/mkl/dft.hpp>
+#include <mkl/dft.hpp>
 #endif
 
 // Intel oneMKL 2024.1 deprecates input/output strides.

diff --git a/src/dft/backends/mklgpu/forward.cpp b/src/dft/backends/mklgpu/forward.cpp
@@ -35,9 +35,9 @@
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
 #if INTEL_MKL_VERSION < 20250000
-#include <oneapi/mkl/dfti.hpp>
+#include <mkl/dfti.hpp>
 #else
-#include <oneapi/mkl/dft.hpp>
+#include <mkl/dft.hpp>
 #endif
 
 /**

diff --git a/src/dft/backends/mklgpu/mklgpu_helpers.hpp b/src/dft/backends/mklgpu/mklgpu_helpers.hpp
@@ -26,9 +26,9 @@
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
 #if INTEL_MKL_VERSION < 20250000
-#include <oneapi/mkl/dfti.hpp>
+#include <mkl/dfti.hpp>
 #else
-#include <oneapi/mkl/dft.hpp>
+#include <mkl/dft.hpp>
 #endif
 
 namespace oneapi {

diff --git a/src/include/common_onemkl_conversion.hpp b/src/include/common_onemkl_conversion.hpp
@@ -23,8 +23,8 @@
 // The file is used to convert oneMath types to Intel(R) oneMKL types for all the common types shared across domains.
 // The file assumes that the common types are identical between the 2 libraries, except for their namespace.
 
-#include <oneapi/mkl/exceptions.hpp>
-#include <oneapi/mkl/types.hpp>
+#include <mkl/exceptions.hpp>
+#include <mkl/types.hpp>
 
 #include "oneapi/math/types.hpp"
 #include "oneapi/math/exceptions.hpp"

diff --git a/src/lapack/backends/mklcpu/CMakeLists.txt b/src/lapack/backends/mklcpu/CMakeLists.txt
@@ -29,27 +29,21 @@ add_library(${LIB_OBJ} OBJECT
 add_dependencies(onemath_backend_libs_lapack ${LIB_NAME})
 
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
 )
 
-# Due to using the same file name for different headers in this library and in
-# the Intel(R) oneAPI Math Kernel Library, we force the compiler to follow C++
-# Core Guideline SF.12 using the flag "-iquote" to avoid conflicts and find the
-# correct header.
-target_compile_options(${LIB_OBJ}
-  BEFORE PRIVATE -iquote $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-)
-
 target_compile_options(${LIB_OBJ} PRIVATE ${ONEMATH_BUILD_COPT})
 
 if(TARGET MKL::MKL_SYCL::LAPACK)
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_SYCL::LAPACK)
 else()
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_DPCPP)
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/lapack/backends/mklcpu/mkl_lapack.cpp b/src/lapack/backends/mklcpu/mkl_lapack.cpp
@@ -24,7 +24,7 @@
 #endif
 
 // Intel(R) oneMKL header
-#include <oneapi/mkl/lapack.hpp>
+#include <mkl/lapack.hpp>
 
 #include "oneapi/math/types.hpp"
 #include "oneapi/math/lapack/types.hpp"

diff --git a/src/lapack/backends/mklgpu/CMakeLists.txt b/src/lapack/backends/mklgpu/CMakeLists.txt
@@ -29,21 +29,21 @@ add_library(${LIB_OBJ} OBJECT
 add_dependencies(onemath_backend_libs_lapack ${LIB_NAME})
 
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
 )
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_compile_options(${LIB_OBJ} PRIVATE ${ONEMATH_BUILD_COPT})
 
 if(TARGET MKL::MKL_SYCL::LAPACK)
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_SYCL::LAPACK)
 else()
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_DPCPP)
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/lapack/backends/mklgpu/mkl_lapack.cpp b/src/lapack/backends/mklgpu/mkl_lapack.cpp
@@ -24,7 +24,7 @@
 #endif
 
 // Intel(R) oneMKL header
-#include <oneapi/mkl/lapack.hpp>
+#include <mkl/lapack.hpp>
 
 #include "oneapi/math/types.hpp"
 #include "oneapi/math/lapack/types.hpp"

diff --git a/src/rng/backends/mklcpu/CMakeLists.txt b/src/rng/backends/mklcpu/CMakeLists.txt
@@ -31,18 +31,18 @@ add_deprecated_library(${LIB_NAME})
 add_library(${LIB_OBJ} OBJECT ${SOURCES})
 add_dependencies(onemath_backend_libs_rng ${LIB_NAME})
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
 )
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_compile_options(${LIB_OBJ} PRIVATE ${ONEMATH_BUILD_COPT})
 if (USE_ADD_SYCL_TO_TARGET_INTEGRATION)
   add_sycl_to_target(TARGET ${LIB_OBJ} SOURCES ${SOURCES})
 endif()
 target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL)
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/rng/backends/mklgpu/CMakeLists.txt b/src/rng/backends/mklgpu/CMakeLists.txt
@@ -30,21 +30,21 @@ add_library(${LIB_OBJ} OBJECT
 add_dependencies(onemath_backend_libs_rng ${LIB_NAME})
 
 target_include_directories(${LIB_OBJ}
-  PRIVATE ${PROJECT_SOURCE_DIR}/src
+  PRIVATE ${PROJECT_SOURCE_DIR}/include
+          ${PROJECT_SOURCE_DIR}/src
           ${PROJECT_SOURCE_DIR}/src/include
           ${CMAKE_BINARY_DIR}/bin
           ${ONEMATH_GENERATED_INCLUDE_PATH}
 )
 
-target_add_onemath_include(${LIB_OBJ})
-
 target_compile_options(${LIB_OBJ} PRIVATE ${ONEMATH_BUILD_COPT})
 
 if(TARGET MKL::MKL_SYCL::RNG)
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_SYCL::RNG)
 else()
   target_link_libraries(${LIB_OBJ} PUBLIC ONEMATH::SYCL::SYCL MKL::MKL_DPCPP)
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/rng/backends/mklgpu/mrg32k3a.cpp b/src/rng/backends/mklgpu/mrg32k3a.cpp
@@ -26,7 +26,7 @@
 
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
-#include <oneapi/mkl/rng.hpp>
+#include <mkl/rng.hpp>
 
 #include "oneapi/math/rng/detail/engine_impl.hpp"
 #include "oneapi/math/rng/engines.hpp"

diff --git a/src/rng/backends/mklgpu/onemkl_distribution_conversion.hpp b/src/rng/backends/mklgpu/onemkl_distribution_conversion.hpp
@@ -22,7 +22,7 @@
 
 // Convert oneMath RNG distribution types to Intel(R) oneMKL equivalents
 
-#include <oneapi/mkl/rng.hpp>
+#include <mkl/rng.hpp>
 
 #include "common_onemkl_conversion.hpp"
 #include "oneapi/math/rng/distributions.hpp"

diff --git a/src/rng/backends/mklgpu/philox4x32x10.cpp b/src/rng/backends/mklgpu/philox4x32x10.cpp
@@ -26,7 +26,7 @@
 
 // Intel(R) oneMKL headers
 #include <mkl_version.h>
-#include <oneapi/mkl/rng.hpp>
+#include <mkl/rng.hpp>
 
 #include "oneapi/math/rng/detail/engine_impl.hpp"
 #include "oneapi/math/rng/engines.hpp"

diff --git a/src/sparse_blas/backends/mkl_common/mkl_handles.hpp b/src/sparse_blas/backends/mkl_common/mkl_handles.hpp
@@ -21,7 +21,7 @@
 #define _ONEMATH_SRC_SPARSE_BLAS_BACKENDS_MKL_COMMON_MKL_HANDLES_HPP_
 
 // Intel(R) oneMKL header
-#include <oneapi/mkl/spblas.hpp>
+#include <mkl/spblas.hpp>
 
 #include "sparse_blas/generic_container.hpp"
 #include "sparse_blas/macros.hpp"

diff --git a/src/sparse_blas/backends/mklcpu/CMakeLists.txt b/src/sparse_blas/backends/mklcpu/CMakeLists.txt
@@ -54,6 +54,7 @@ else()
     PRIVATE onemath_warnings
   )
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON

diff --git a/src/sparse_blas/backends/mklgpu/CMakeLists.txt b/src/sparse_blas/backends/mklgpu/CMakeLists.txt
@@ -54,6 +54,7 @@ else()
     PRIVATE onemath_warnings
   )
 endif()
+target_add_intel_onemkl_include(${LIB_OBJ})
 
 set_target_properties(${LIB_OBJ} PROPERTIES
   POSITION_INDEPENDENT_CODE ON