Install Windows debug libraries with postfix

Co-authored-by: Kenneth Benzie (Benie) <[email protected]>

Author: PatKamin

CMakeLists.txt

@@ -89,7 +89,8 @@ set(UMF_INSTALL_RPATH
         "Set the runtime search path to the directory with dependencies (e.g. hwloc)"
 )
 
-umf_option(UMF_USE_DEBUG_POSTFIX "Add a 'd' postfix to Windows debug libraries" OFF)
+umf_option(UMF_USE_DEBUG_POSTFIX "Add a 'd' postfix to Windows debug libraries"
+           OFF)
 umf_option(UMF_DEVELOPER_MODE "Enable additional developer checks" OFF)
 umf_option(
     UMF_FORMAT_CODE_STYLE
@@ -427,6 +428,57 @@ elseif(UMF_BUILD_CUDA_PROVIDER)
     message(STATUS "CUDA_INCLUDE_DIRS = ${CUDA_INCLUDE_DIRS}")
 endif()
 
+if(WINDOWS)
+    # Build debug libraries with the d suffix that are compiled with /MDd so
+    # users can link against these in debug builds.
+    include(ExternalProject)
+    set(UMFD_BINARY_DIR ${CMAKE_BINARY_DIR}/umfd)
+    set(UMFD_INSTALL_DIR ${UMFD_BINARY_DIR}/install)
+
+    ExternalProject_Add(
+        umfd
+        SOURCE_DIR ${PROJECT_SOURCE_DIR}
+        BINARY_DIR ${UMFD_BINARY_DIR}
+        INSTALL_DIR ${UMFD_INSTALL_DIR}
+        INSTALL_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --target
+                        install-umf-libraries
+        CMAKE_CACHE_ARGS
+            -DCMAKE_BUILD_TYPE=DEBUG
+            -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+            # Enable d suffix on libraries
+            -DUMF_USE_DEBUG_POSTFIX=ON
+            # Don't build unnecessary targets in subbuild.
+            -DUMF_BUILD_EXAMPLES=OFF
+            -DUMF_BUILD_TESTS=OFF
+            # Inherit settings from parent build.
+            -DUMF_BUILD_SHARED_LIBRARY=${UMF_BUILD_SHARED_LIBRARY}
+            -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${UMF_BUILD_LEVEL_ZERO_PROVIDER}
+            -DUMF_BUILD_CUDA_PROVIDER=${UMF_BUILD_CUDA_PROVIDER}
+            -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=${UMF_BUILD_LIBUMF_POOL_JEMALLOC}
+            -DUMF_DISABLE_HWLOC=${UMF_DISABLE_HWLOC}
+            -DUMF_LINK_HWLOC_STATICALLY=${UMF_LINK_HWLOC_STATICALLY}
+            -DUMF_HWLOC_NAME=${UMF_HWLOC_NAME}
+            -DUMF_INSTALL_RPATH=${UMF_INSTALL_RPATH})
+
+    # Copy debug runtime libraries to the parent build directory
+    set(UMFD_FILES_TO_COPY)
+    list(APPEND UMFD_COPY_FILES ${PROJECT_BINARY_DIR}/bin/umfd.dll
+         ${PROJECT_BINARY_DIR}/lib/umfd.lib)
+    add_custom_command(
+        OUTPUT ${PROJECT_BINARY_DIR}/bin/umfd.dll
+               ${PROJECT_BINARY_DIR}/lib/umfd.lib
+        COMMAND ${CMAKE_COMMAND} -E copy ${UMFD_INSTALL_DIR}/bin/umfd.dll
+                ${PROJECT_BINARY_DIR}/bin/umfd.dll
+        COMMAND ${CMAKE_COMMAND} -E copy ${UMFD_INSTALL_DIR}/lib/umfd.lib
+                ${PROJECT_BINARY_DIR}/lib/umfd.lib)
+
+    add_custom_target(copy-umfd-files DEPENDS ${UMFD_COPY_FILES})
+    add_dependencies(copy-umfd-files umfd)
+endif()
+
+# Target with all UMF libraries added with add_umf_library()
+add_custom_target(umf-libraries)
+
 # This build type check is not possible on Windows when CMAKE_BUILD_TYPE is not
 # set, because in this case the build type is determined after a CMake
 # configuration is done (at the build time)
@@ -859,6 +911,12 @@ install(FILES ${PROJECT_BINARY_DIR}/cmake/${PROJECT_NAME}-config.cmake
               ${PROJECT_BINARY_DIR}/cmake/${PROJECT_NAME}-config-version.cmake
         DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
 
+# Install Windows debug libraries
+add_custom_target(
+    install-umf-libraries
+    COMMAND ${CMAKE_COMMAND} --install ${UMFD_INSTALL_DIR}
+    DEPENDS umf-libraries)
+
 # Configure uninstall commands
 configure_file("${PROJECT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
                "${PROJECT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY)

cmake/helpers.cmake

@@ -395,6 +395,7 @@ function(add_umf_library)
     if(WINDOWS AND UMF_USE_DEBUG_POSTFIX)
         set_target_properties(${ARG_NAME} PROPERTIES DEBUG_POSTFIX d)
     endif()
+    add_dependencies(umf-libraries ${ARG_NAME})
 endfunction()
 
 # Add sanitizer ${flag}, if it is supported, for both C and C++ compiler