Add options to build with system LIBXSMM/oneDNN/sleef/MKL/ideep/gtest

Signed-off-by: Sv. Lockal <lockalsash@gmail.com>
intel · Jul 3, 2024 · d0774c4 · d0774c4
1 parent f20a79e
commit d0774c4
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 35 deletions.
diff --git a/cmake/Modules/FindoneMKL.cmake b/cmake/Modules/FindoneMKL.cmake
@@ -72,6 +72,10 @@ endfunction()
 # IPEX CPU lib always download and install mkl-static lib and use static linker for mkl-static lib.
 # IPEX CPU lib can manual config to use the dynamic link for oneMKL lib.
 if(BUILD_MODULE_TYPE STREQUAL "GPU")
+  set(USE_SYSTEM_MKL ON)
+endif()
+
+if(USE_SYSTEM_MKL)
   get_mkl_from_env_var()
 else()
   if(BUILD_WITH_XPU)

diff --git a/cmake/cpu/Options.cmake b/cmake/cpu/Options.cmake
@@ -7,6 +7,13 @@ set(Options_CPU_cmake_included true)
 # The options to build cpu
 include(CMakeDependentOption)
 
+option(USE_SYSTEM_LIBXSMM "Use system LIBXSMM library" OFF)
+option(USE_SYSTEM_ONEDNN "Use system oneDNN library" OFF)
+option(USE_SYSTEM_SLEEF "Use system SLEEF library" OFF)
+option(USE_SYSTEM_MKL "Use system MKL library" OFF)
+option(USE_SYSTEM_IDEEP "Use system ideep library" OFF)
+option(USE_SYSTEM_GTEST "Use system GoogleTest library" OFF)
+
 option(BUILD_LIBXSMM_VIA_CMAKE "Build LIBXSMM via CMake" ON)
 option(USE_LIBXSMM "Enable LIBXSMM" ON)
 if(WIN32)

diff --git a/csrc/cpu/CMakeLists.txt b/csrc/cpu/CMakeLists.txt
@@ -33,8 +33,20 @@ if(DEFINED ENV{DNNL_GRAPH_BUILD_COMPILER_BACKEND})
 endif()
 
 set(THIRD_PARTY_BUILD_PATH_NAME "cpu_third_party")
-add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/mkl-dnn ${THIRD_PARTY_BUILD_PATH_NAME}/ideep/mkl-dnn EXCLUDE_FROM_ALL)
-# add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/mkl-dnn cpu_third_party/mkl-dnn)
+if(USE_SYSTEM_ONEDNN)
+  find_package(dnnl 3.4.1 CONFIG REQUIRED)
+  get_target_property(ONEDNN_INCLUDE_DIR DNNL::dnnl INTERFACE_INCLUDE_DIRECTORIES)
+  set(ONEDNN_LIBRARY DNNL::dnnl)
+  set(ONEDNN_GENERATED_INCLUDE ${ONEDNN_INCLUDE_DIR})
+else()
+  add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/mkl-dnn ${THIRD_PARTY_BUILD_PATH_NAME}/ideep/mkl-dnn EXCLUDE_FROM_ALL)
+  set(ONEDNN_INCLUDE_DIR ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/mkl-dnn/include)
+  set(ONEDNN_LIBRARY dnnl)
+
+  # path of oneDNN .h.in generated file
+  file(RELATIVE_PATH CUR_DIR_REL_PATH "${IPEX_ROOT_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}")
+  set(ONEDNN_GENERATED_INCLUDE "${CMAKE_BINARY_DIR}/${CUR_DIR_REL_PATH}/${THIRD_PARTY_BUILD_PATH_NAME}/ideep/mkl-dnn/include")
+endif()
 
 IF(IPEX_DISP_OP)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DIPEX_DISP_OP")
@@ -116,7 +128,7 @@ add_library(${PLUGIN_NAME_CPU} SHARED ${IPEX_CPU_CPP_SRCS})
 # For IPEX_API macro
 target_compile_definitions(${PLUGIN_NAME_CPU} PUBLIC "BUILD_IPEX_MAIN_LIB")
 
-set_target_properties(${PLUGIN_NAME_CPU} PROPERTIES ONEDNN_INCLUDE_DIR "${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/mkl-dnn/include")
+set_target_properties(${PLUGIN_NAME_CPU} PROPERTIES ONEDNN_INCLUDE_DIR ${ONEDNN_INCLUDE_DIR})
 
 # includes
 target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_ROOT_DIR})
@@ -129,19 +141,21 @@ target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_ROOT_DIR}/jit)
 target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_JIT_CPP_ROOT})
 target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_UTLIS_CPP_ROOT})
 
-target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/mkl-dnn/include)
+target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${ONEDNN_INCLUDE_DIR})
 
 if(USE_LIBXSMM)
   target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_ROOT_DIR}/tpp)
-  target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm/include)
+  target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${LIBXSMM_INCLUDE_DIRS})
 endif(USE_LIBXSMM)
 
-# path of oneDNN .h.in generated file
-file(RELATIVE_PATH CUR_DIR_REL_PATH "${IPEX_ROOT_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}")
-set(ONEDNN_GENERATED_INCLUDE "${CMAKE_BINARY_DIR}/${CUR_DIR_REL_PATH}/${THIRD_PARTY_BUILD_PATH_NAME}/ideep/mkl-dnn/include")
 target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${ONEDNN_GENERATED_INCLUDE})
 
-target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/include)
+if(USE_SYSTEM_IDEEP)
+  find_path(IDEEP_INCLUDE_DIR ideep.hpp REQUIRED)
+else()
+  set(IDEEP_INCLUDE_DIR ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/ideep/include)
+endif()
+target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IDEEP_INCLUDE_DIR})
 target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${PYTHON_INCLUDE_DIR})
 
 if(BUILD_CPU_WITH_ONECCL)
@@ -161,12 +175,17 @@ if(CLANG_FORMAT)
 endif()
 
 if(USE_LIBXSMM)
-  if(BUILD_LIBXSMM_VIA_CMAKE)
+  if(USE_SYSTEM_LIBXSMM)
+    find_package(PkgConfig REQUIRED)
+    pkg_check_modules(LIBXSMM REQUIRED libxsmm)
+    target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${LIBXSMM_INCLUDE_DIRS})
+    target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE ${LIBXSMM_LIBRARIES})
+  elseif(BUILD_LIBXSMM_VIA_CMAKE)
     add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm cpu_third_party/libxsmm EXCLUDE_FROM_ALL)
     add_definitions(-DLIBXSMM_DEFAULT_CONFIG)
-    target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm/include)
+    set(LIBXSMM_INCLUDE_DIRS ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm/include)
     target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE xsmm)
-  else(BUILD_LIBXSMM_VIA_CMAKE)
+  else()
     include(${CMAKE_ROOT}/Modules/ExternalProject.cmake)
     set(args
     CC=${CMAKE_C_COMPILER}
@@ -184,20 +203,31 @@ if(USE_LIBXSMM)
         ${args}
       INSTALL_COMMAND ""
       )
+    set(LIBXSMM_INCLUDE_DIRS ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm/include)
     target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE ${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/libxsmm/lib/libxsmm.a)
   endif(BUILD_LIBXSMM_VIA_CMAKE)
 endif(USE_LIBXSMM)
 
-# setup sleef options:
-set(SLEEF_BUILD_SHARED_LIBS OFF CACHE BOOL "Build sleef as static library" FORCE)
-set(SLEEF_BUILD_DFT OFF CACHE BOOL "Don't build sleef DFT lib" FORCE)
-set(SLEEF_BUILD_GNUABI_LIBS OFF CACHE BOOL "Don't build sleef gnuabi libs" FORCE)
-set(SLEEF_BUILD_TESTS OFF CACHE BOOL "Don't build sleef tests" FORCE)
-set(SLEEF_BUILD_SCALAR_LIB OFF CACHE BOOL "libsleefscalar will be built." FORCE)
-add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/sleef ${THIRD_PARTY_BUILD_PATH_NAME}/sleef EXCLUDE_FROM_ALL)
-target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE sleef)
+if(USE_SYSTEM_SLEEF)
+  find_package(PkgConfig REQUIRED)
+  pkg_check_modules(SLEEF REQUIRED sleef)
+  target_include_directories(${PLUGIN_NAME_CPU} PUBLIC ${SLEEF_INCLUDE_DIRS})
+  target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE ${SLEEF_LIBRARIES})
+else()
+  # setup sleef options:
+  set(SLEEF_BUILD_SHARED_LIBS OFF CACHE BOOL "Build sleef as static library" FORCE)
+  set(SLEEF_BUILD_DFT OFF CACHE BOOL "Don't build sleef DFT lib" FORCE)
+  set(SLEEF_BUILD_GNUABI_LIBS OFF CACHE BOOL "Don't build sleef gnuabi libs" FORCE)
+  set(SLEEF_BUILD_TESTS OFF CACHE BOOL "Don't build sleef tests" FORCE)
+  set(SLEEF_BUILD_SCALAR_LIB OFF CACHE BOOL "libsleefscalar will be built." FORCE)
+  add_subdirectory(${IPEX_CPU_CPP_THIRD_PARTY_ROOT}/sleef ${THIRD_PARTY_BUILD_PATH_NAME}/sleef EXCLUDE_FROM_ALL)
+  target_link_libraries(${PLUGIN_NAME_CPU} PRIVATE sleef)
+endif()
+
+if(NOT USE_SYSTEM_ONEDNN)
+  add_dependencies(${PLUGIN_NAME_CPU} dnnl)
+endif()
 
-add_dependencies(${PLUGIN_NAME_CPU} dnnl)
 # If Graph Compiler is built, then it should link to its LLVM dependencies,
 # and not the LLVM symbols exposed by PyTorch.
 if (DEFINED ENV{DNNL_GRAPH_BUILD_COMPILER_BACKEND})
@@ -209,7 +239,7 @@ if (DEFINED ENV{DNNL_GRAPH_BUILD_COMPILER_BACKEND})
     set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--exclude-libs=${DNNL_GRAPHCOMPILER_LLVM_LIB_EXCLUDE}")
   endif()
 else()
-  target_link_libraries(${PLUGIN_NAME_CPU} PUBLIC dnnl)
+  target_link_libraries(${PLUGIN_NAME_CPU} PUBLIC ${ONEDNN_LIBRARY})
 endif()
 find_package(oneMKL QUIET)
 if (ONEMKL_FOUND)

diff --git a/tests/cpu/cpp/CMakeLists.txt b/tests/cpu/cpp/CMakeLists.txt
@@ -31,24 +31,33 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TORCH_CXX_FLAGS}")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wl,-Bsymbolic-functions")
 
 # Set the include dir
-include_directories(${PYTORCH_INSTALL_DIR}/include)
-include_directories(${PYTORCH_INSTALL_DIR}/include/torch/csrc/api/include/)
-include_directories(${THIRD_PARTY_ROOT}/googletest/googletest/include)
+include_directories(${TORCH_INCLUDE_DIRS})
 include_directories(${IPEX_PROJECT_TOP_DIR})
 include_directories(${IPEX_PROJECT_TOP_DIR}/csrc/include)
 
 link_directories(${PYTORCH_INSTALL_DIR}/lib)
 # search the lib directory for gtest
 link_directories(${CPP_TEST_BUILD_DIR}/lib)
 
-# add gtest cmake path
-add_subdirectory(${THIRD_PARTY_ROOT}/googletest ${CPP_TEST_BUILD_DIR}/third_party/googletest EXCLUDE_FROM_ALL)
-
 # Add the Test Files
 set(IPEX_CPP_TEST_SOURCES test_runtime_api.cpp test_dyndisp_and_isa_api.cpp)
 
 add_executable(${CPU_CPP_TEST_NAME} ${IPEX_CPP_TEST_SOURCES})
 
+if(USE_SYSTEM_GTEST)
+  find_package(GTest REQUIRED)
+  target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC GTest::gtest GTest::gtest_main)
+else()
+  # add gtest cmake path
+  add_subdirectory(${THIRD_PARTY_ROOT}/googletest ${CPP_TEST_BUILD_DIR}/third_party/googletest EXCLUDE_FROM_ALL)
+
+  # Link GTest
+  target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC gtest_main)
+  target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC gtest)
+
+  target_include_directories(${CPU_CPP_TEST_NAME} PRIVATE ${THIRD_PARTY_ROOT}/googletest/googletest/include)
+endif()
+
 set(BUILD_STATIC_ONEMKL ON)
 find_package(oneMKL QUIET)
 if (ONEMKL_FOUND)
@@ -57,14 +66,8 @@ endif()
 
 target_link_directories(${CPU_CPP_TEST_NAME} PRIVATE ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/)
 
-# Link GTest
-target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC gtest_main)
-target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC gtest)
-
 # Link Pytorch
-target_link_directories(${CPU_CPP_TEST_NAME} PRIVATE ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR})
-target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC torch_cpu)
-target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC c10)
+target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC ${TORCH_LIBRARIES})
 
 # Link IPEX
 target_link_libraries(${CPU_CPP_TEST_NAME} PUBLIC intel-ext-pt-cpu)