[ESI][Runtime] Add Debug DLLs to wheels for Windows (#9687)

Windows applications in Debug mode crash when linking against the ESI Runtime wheel due to runtime library mismatches. Only Release DLLs were being packaged. Solution is to build and package both Release and Debug configurations of all C++ libraries and tools on Windows in a single wheel.

Author: Copilot

lib/Dialect/ESI/runtime/CMakeLists.txt

@@ -171,6 +171,11 @@ else()
 endif()
 add_library(esiaccel::ESICppRuntime ALIAS ESICppRuntime)
 
+# Set debug postfix for Windows libraries
+if(WIN32)
+  set_target_properties(ESICppRuntime PROPERTIES DEBUG_POSTFIX "_d")
+endif()
+
 target_include_directories(ESICppRuntime PUBLIC
   ${CMAKE_CURRENT_SOURCE_DIR}/cpp/include
 )
@@ -210,6 +215,15 @@ install(TARGETS ESICppRuntime
   COMPONENT ESIRuntime
 )
 
+# Install PDB files for Windows Debug builds
+if(WIN32 AND MSVC)
+  install(FILES $<TARGET_PDB_FILE:ESICppRuntime>
+    DESTINATION ${ESIRT_INSTALL_LIBDIR}
+    COMPONENT ESIRuntime
+    OPTIONAL
+  )
+endif()
+
 install(FILES ${ESICppRuntimeHeaders}
   DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/esi
   COMPONENT ESIRuntime
@@ -241,6 +255,10 @@ set(ESIRuntimePath "${CMAKE_CURRENT_BINARY_DIR}"
 add_executable(esiquery
   ${CMAKE_CURRENT_SOURCE_DIR}/cpp/tools/esiquery.cpp
 )
+# Set debug postfix for Windows executables
+if(WIN32)
+  set_target_properties(esiquery PROPERTIES DEBUG_POSTFIX "_d")
+endif()
 target_link_libraries(esiquery PRIVATE
   ESICppRuntime
   CLI11::CLI11
@@ -251,20 +269,40 @@ install(TARGETS esiquery
   DESTINATION ${ESIRT_INSTALL_BINDIR}
   COMPONENT ESIRuntime
 )
+# Install PDB files for Windows Debug builds
+if(WIN32 AND MSVC)
+  install(FILES $<TARGET_PDB_FILE:esiquery>
+    DESTINATION ${ESIRT_INSTALL_BINDIR}
+    COMPONENT ESIRuntime
+    OPTIONAL
+  )
+endif()
 
 ##===----------------------------------------------------------------------===//
 ## The esitester tool is both an example and test driver. As it is not intended
-## for production use, it is not installed.
+## for production use, it is not installed or included in wheels.
 ##===----------------------------------------------------------------------===//
 
 add_executable(esitester
   ${CMAKE_CURRENT_SOURCE_DIR}/cpp/tools/esitester.cpp
 )
+# Set debug postfix for Windows executables
+if(WIN32)
+  set_target_properties(esitester PROPERTIES DEBUG_POSTFIX "_d")
+endif()
 target_link_libraries(esitester PRIVATE
   ESICppRuntime
   CLI11::CLI11
 )
-add_dependencies(ESIRuntime esitester)
+# Install PDB files for Windows Debug builds
+if(WIN32 AND MSVC)
+  install(FILES $<TARGET_PDB_FILE:esitester>
+    DESTINATION ${ESIRT_INSTALL_BINDIR}
+    COMPONENT ESIRuntime
+    OPTIONAL
+  )
+endif()
+
 
 # Add the Python bindings.
 add_subdirectory(python)
@@ -301,6 +339,11 @@ if(ESI_COSIM)
     ${CMAKE_CURRENT_SOURCE_DIR}/cpp/include/esi/backends/RpcServer.h
   )
 
+  # Set debug postfix for Windows libraries
+  if(WIN32)
+    set_target_properties(CosimRpc PROPERTIES DEBUG_POSTFIX "_d")
+  endif()
+
   target_link_libraries(CosimRpc PUBLIC
     ESICppRuntime
     protobuf::libprotobuf
@@ -327,6 +370,11 @@ if(ESI_COSIM)
     ${CMAKE_CURRENT_SOURCE_DIR}/cpp/include/esi/backends/Cosim.h
   )
 
+  # Set debug postfix for Windows libraries
+  if(WIN32)
+    set_target_properties(CosimBackend PROPERTIES DEBUG_POSTFIX "_d")
+  endif()
+
   target_link_libraries(CosimBackend PUBLIC
     ESICppRuntime
     CosimRpc
@@ -345,6 +393,19 @@ if(ESI_COSIM)
         POST_EXCLUDE_REGEXES ".*system32/.*\\.dll"
       COMPONENT ESIRuntime
     )
+    # Install PDB files for Windows Debug builds
+    if(MSVC)
+      install(FILES $<TARGET_PDB_FILE:CosimRpc>
+        DESTINATION ${ESIRT_INSTALL_LIBDIR}
+        COMPONENT ESIRuntime
+        OPTIONAL
+      )
+      install(FILES $<TARGET_PDB_FILE:CosimBackend>
+        DESTINATION ${ESIRT_INSTALL_LIBDIR}
+        COMPONENT ESIRuntime
+        OPTIONAL
+      )
+    endif()
   else()
     install(TARGETS CosimRpc CosimBackend
       DESTINATION ${ESIRT_INSTALL_LIBDIR}

lib/Dialect/ESI/runtime/cpp/cmake/esiaccelConfig.cmake.in

@@ -4,10 +4,19 @@ set_target_properties(esiaccel::ESICppRuntime PROPERTIES
 )
 
 if(WIN32)
+  # Default to Release variant for single-config generators and as fallback.
+  # Multi-config generators (Visual Studio, Xcode) use the per-config
+  # IMPORTED_LOCATION_<CONFIG> properties set below.
   set_target_properties(esiaccel::ESICppRuntime PROPERTIES
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime.dll"
     IMPORTED_IMPLIB "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime.lib"
   )
+  set_target_properties(esiaccel::ESICppRuntime PROPERTIES
+    IMPORTED_LOCATION_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime.dll"
+    IMPORTED_IMPLIB_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime.lib"
+    IMPORTED_LOCATION_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime_d.dll"
+    IMPORTED_IMPLIB_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../ESICppRuntime_d.lib"
+  )
 else()
   set_target_properties(esiaccel::ESICppRuntime PROPERTIES
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../@ESIRT_INSTALL_LIBDIR@/libESICppRuntime.so"
@@ -25,6 +34,12 @@ if(WIN32)
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc.dll"
     IMPORTED_IMPLIB "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc.lib"
   )
+  set_target_properties(esiaccel::CosimRpc PROPERTIES
+    IMPORTED_LOCATION_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc.dll"
+    IMPORTED_IMPLIB_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc.lib"
+    IMPORTED_LOCATION_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc_d.dll"
+    IMPORTED_IMPLIB_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../CosimRpc_d.lib"
+  )
 else()
   set_target_properties(esiaccel::CosimRpc PROPERTIES
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../@ESIRT_INSTALL_LIBDIR@/libCosimRpc.so"
@@ -42,6 +57,12 @@ if(WIN32)
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend.dll"
     IMPORTED_IMPLIB "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend.lib"
   )
+  set_target_properties(esiaccel::CosimBackend PROPERTIES
+    IMPORTED_LOCATION_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend.dll"
+    IMPORTED_IMPLIB_RELEASE "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend.lib"
+    IMPORTED_LOCATION_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend_d.dll"
+    IMPORTED_IMPLIB_DEBUG "${CMAKE_CURRENT_LIST_DIR}/../CosimBackend_d.lib"
+  )
 else()
   set_target_properties(esiaccel::CosimBackend PROPERTIES
     IMPORTED_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../@ESIRT_INSTALL_LIBDIR@/libCosimBackend.so"

lib/Dialect/ESI/runtime/cpp/lib/Accelerator.cpp

@@ -194,9 +194,15 @@ static void loadBackend(Context &ctxt, std::string backend) {
 #ifdef __linux__
   std::string backendFileName = "lib" + backend + "Backend.so";
 #elif _WIN32
+  // In MSVC debug builds, load the debug variant of the plugin DLL (e.g.
+  // CosimBackend_d.dll) to ensure compatibility.
+#if defined(_MSC_VER) && defined(_DEBUG)
+  std::string backendFileName = backend + "Backend_d.dll";
+#else
   std::string backendFileName = backend + "Backend.dll";
+#endif
 #else
-#eror "Unsupported platform"
+#error "Unsupported platform"
 #endif
 
   // First, try the current directory.

lib/Dialect/ESI/runtime/python/CMakeLists.txt

@@ -48,6 +48,10 @@ if(Python3_FOUND)
     if (WHEEL_BUILD)
       message (FATAL_ERROR "nanobind is required for a wheel build.")
     endif()
+  elseif(MSVC AND CMAKE_BUILD_TYPE STREQUAL "Debug")
+    # On MSVC in Debug mode, nanobind's CRT mismatch causes linking issues
+    # with the Python import library. Disable the Python module entirely.
+    message(WARNING "Disabling ESI Python API in MSVC Debug mode due to nanobind CRT incompatibility.")
   else()
     # Compile nanobind module and copy to the correct python directory.
     nanobind_add_module(esiCppAccel