Add vcpkg mkl

talregev · talregev · commit cdd2c2f770ec · 2025-08-31T22:35:03.000+03:00
diff --git a/.github/workflows/vcpkg.yml b/.github/workflows/vcpkg.yml
@@ -31,6 +31,7 @@ jobs:
             # Exclude test_sumProduct and test_sumProduct_chain from pytest on windows.
             # These tests should be fixed for windows.
             pytest_extra_flags: -k "not test_sumProduct"
+            additional_vcpkg_ports: intel-mkl
           - os: ubuntu-latest
             triplet: x64-linux-release
             build_type: Release
@@ -40,6 +41,8 @@ jobs:
             # vcpkg compile external metis, while test are configured to use vendored metis.
             # Need to debug and fix it.
             ctest_extra_flags: -E "testFindSeparator"
+            additional_vcpkg_ports: intel-mkl
+            cxxflags: -DCMAKE_CXX_FLAGS="-Wno-error=maybe-uninitialized"
           - os: macos-latest
             triplet: arm64-osx-release
             build_type: Release
@@ -106,6 +109,7 @@ jobs:
           tbb
           pybind11
           geographiclib
+          ${{ matrix.additional_vcpkg_ports }}
 
       - name: copy files for hash
         shell: bash
@@ -136,7 +140,18 @@ jobs:
         if: success()
         shell: bash
         run: |
-          export CL=-openmp
+          # This is due an warning as error found in linux gtsam code:
+          # In file included from include/Eigen/Core:370,
+          #                  from include/Eigen/Dense:1,
+          #                  from gtsam/base/OptionalJacobian.h:24,
+          #                  from gtsam/base/Matrix.h:27,
+          #                  from gtsam/linear/GaussianFactor.h:24,
+          #                  from gtsam/linear/HessianFactor.h:21,
+          #                  from gtsam/linear/HessianFactor.cpp:18:
+          # In static member function ‘static void Eigen::internal::selfadjoint_matrix_vector_product<double, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs, 0>::run(Index, const double*, Index, const double*, double*, double) [with Index = long int; int StorageOrder = 1; int UpLo = 1; bool ConjugateLhs = false; bool ConjugateRhs = false]’,
+          #     inlined from ‘static void Eigen::internal::selfadjoint_product_impl<Lhs, LhsMode, false, Rhs, 0, true>::run(Dest&, const Lhs&, const Rhs&, const Scalar&) [with Dest = Eigen::Transpose<Eigen::Matrix<double, 1, -1> >; Lhs = Eigen::Transpose<const Eigen::Block<const Eigen::Matrix<double, -1, -1>, -1, -1, false> >; int LhsMode = 1; Rhs = Eigen::Transpose<const Eigen::Transpose<const Eigen::Matrix<double, -1, 1> > >]’ at include/Eigen/src/Core/products/SelfadjointMatrixVector.h:229:7:
+          # include/Eigen/src/Core/products/SelfadjointMatrixVector_BLAS.h:69:1: error: ‘result’ may be used uninitialized [-Werror=maybe-uninitialized]
+          #    69 | EIGEN_BLAS_SYMV_SPECIALIZE(double)
 
           cmake . -B build -G Ninja \
               -DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake \
@@ -155,8 +170,11 @@ jobs:
               -DGTSAM_USE_SYSTEM_METIS=ON \
               -DGTSAM_USE_SYSTEM_PYBIND=ON \
               -DGTSAM_SUPPORT_NESTED_DISSECTION=ON \
+              -DGTSAM_WITH_EIGEN_MKL=ON \
+              -DGTSAM_WITH_EIGEN_MKL_OPENMP=ON \
               -DCTEST_EXTRA_ARGS='${{ matrix.ctest_extra_flags }}' \
-              -DPYTEST_EXTRA_ARGS='${{ matrix.pytest_extra_flags }}'
+              -DPYTEST_EXTRA_ARGS='${{ matrix.pytest_extra_flags }}' \
+              ${{ matrix.cxxflags }}
 
       - name: cmake build
         shell: bash
@@ -174,4 +192,7 @@ jobs:
       - name: Run tests
         shell: bash
         run: |
+          VCPKG_BASH_PATH="${VCPKG_INSTALLATION_ROOT//\\//}"  # backslashes -> slashes
+          VCPKG_BASH_PATH="/${VCPKG_BASH_PATH/:/}"            # drop colon, add leading /
+          export PATH="$PATH:$VCPKG_BASH_PATH/installed/${{ matrix.triplet }}/bin"
           cmake --build build --config ${{ matrix.build_type }} --target check
diff --git a/cmake/FindMKL.cmake b/cmake/FindMKL.cmake
@@ -21,6 +21,18 @@
 # OPEN - Open MPI library
 # SGI - SGI MPT Library
 
+# vcpkg
+if(DEFINED VCPKG_INSTALLED_DIR)
+    find_package(MKL CONFIG)
+    if(MKL_FOUND)
+        add_library(mkl-gtsam-if INTERFACE)
+        target_link_libraries(mkl-gtsam-if INTERFACE MKL::MKL)
+        set(MKL_LIBRARIES mkl-gtsam-if)
+        list(APPEND GTSAM_EXPORTED_TARGETS mkl-gtsam-if)
+        install(TARGETS mkl-gtsam-if EXPORT GTSAM-exports ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})
+    endif()
+else()
+
 # linux
 IF(UNIX AND NOT APPLE)
     IF(${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "x86_64")
@@ -267,4 +279,6 @@ find_package_handle_standard_args(MKL DEFAULT_MSG MKL_INCLUDE_DIR MKL_LIBRARIES)
 #        LINK_DIRECTORIES(${MKL_ROOT_DIR}/lib/${MKL_ARCH_DIR}) # hack
 #endif()
 
+endif() # end of vcpkg
+
 MARK_AS_ADVANCED(MKL_INCLUDE_DIR MKL_LIBRARIES)
diff --git a/cmake/HandleMKL.cmake b/cmake/HandleMKL.cmake
@@ -4,7 +4,12 @@ find_package(MKL)
 
 if(MKL_FOUND AND GTSAM_WITH_EIGEN_MKL)
     set(GTSAM_USE_EIGEN_MKL 1) # This will go into config.h
-    set(EIGEN_USE_MKL_ALL 1) # This will go into config.h - it makes Eigen use MKL
+    if(VCPKG_INSTALLED_DIR)
+        set(EIGEN_USE_MKL_ALL 0)
+        add_compile_definitions(EIGEN_USE_BLAS EIGEN_USE_MKL EIGEN_USE_MKL_VML)
+    else()
+        set(EIGEN_USE_MKL_ALL 1) # This will go into config.h - it makes Eigen use MKL
+    endif()
     list(APPEND GTSAM_ADDITIONAL_LIBRARIES ${MKL_LIBRARIES})
 
     # --no-as-needed is required with gcc according to the MKL link advisor
@@ -15,3 +20,28 @@ else()
     set(GTSAM_USE_EIGEN_MKL 0)
     set(EIGEN_USE_MKL_ALL 0)
 endif()
+
+if(WIN32 AND GTSAM_USE_EIGEN_MKL AND DEFINED VCPKG_INSTALLED_DIR)
+    get_target_property(MKL_TARGETS "MKL::MKL" INTERFACE_LINK_LIBRARIES)
+    set(RUNTIME_DLL_DIRS "")
+    foreach(MKL_TARGET ${MKL_TARGETS})
+        if(TARGET ${MKL_TARGET})
+            get_target_property(MKL_DLL "${MKL_TARGET}" IMPORTED_LOCATION)
+            if(MKL_DLL)
+                cmake_path(GET MKL_DLL PARENT_PATH MKL_DLL_DIR)
+                list (APPEND RUNTIME_DLL_DIRS "${MKL_DLL_DIR}/mkl_*.dll")
+            endif()
+        endif()
+    endforeach()
+    list(REMOVE_DUPLICATES RUNTIME_DLL_DIRS)
+    file(GLOB MKL_DLLS CONFIGURE_DEPENDS ${RUNTIME_DLL_DIRS})
+    list(REMOVE_DUPLICATES MKL_DLLS)
+    add_custom_target(copy_mkl_dlls
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different
+        "${MKL_DLLS}"
+        "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}"
+        COMMAND_EXPAND_LISTS
+        VERBATIM
+    )
+endif()
+add_dependencies(check copy_mkl_dlls)
diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt
@@ -149,6 +149,15 @@ if(WIN32)
         COMMAND_EXPAND_LISTS
         VERBATIM
     )
+    if(GTSAM_USE_EIGEN_MKL AND DEFINED VCPKG_INSTALLED_DIR)
+        ADD_CUSTOM_COMMAND(TARGET ${GTSAM_PYTHON_TARGET} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy_if_different
+            "${MKL_DLLS}"
+            "${GTSAM_PYTHON_BUILD_DIRECTORY}/gtsam/"
+            COMMAND_EXPAND_LISTS
+            VERBATIM
+        )
+    endif()
 endif()
 
 # Set the path for the GTSAM python module
@@ -263,6 +272,15 @@ if(GTSAM_UNSTABLE_BUILD_PYTHON)
             COMMAND_EXPAND_LISTS
             VERBATIM
         )
+        if(GTSAM_USE_EIGEN_MKL AND DEFINED VCPKG_INSTALLED_DIR)
+            ADD_CUSTOM_COMMAND(TARGET ${GTSAM_PYTHON_UNSTABLE_TARGET} POST_BUILD
+                COMMAND ${CMAKE_COMMAND} -E copy_if_different
+                "${MKL_DLLS}"
+                "${GTSAM_PYTHON_BUILD_DIRECTORY}/gtsam_unstable/"
+                COMMAND_EXPAND_LISTS
+                VERBATIM
+            )
+        endif()
     endif()
 
     add_custom_target(
