Use explicit static VC runtime on Windows (#851)

* Use explicit static VC runtime on Windows

This change updates the QIR runtime to use an explicit path to the Spectre-mitigated, static VC runtime on Windows. Using a full path here overrides the selection logic and ensures the chosen libcmt[d] and vcruntime[d] are loaded.

* Add "-sort" flag

* Include version number in find pattern

* Include libcpmt library as well

* Use spectre component name

Author: swernli

src/Qir/Runtime/CMakeLists.txt

@@ -17,6 +17,47 @@ if (NOT APPLE)
 endif()
 
 if (WIN32)
+    # Enforce use of static runtime (avoids target machine needing msvcrt installed).
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+
+    # Locate the vswhere application, which will provide paths to any installed Visual Studio instances.
+    # By invoking it with "-find **/lib/spectre/x64" we will find any Spectre mitigated libaries that
+    # have been installed.
+    find_program(_vswhere_tool
+        NAMES vswhere
+        PATHS "$ENV{ProgramFiles\(x86\)}/Microsoft Visual Studio/Installer")
+    if (NOT ${vswhere})
+        message(FATAL_ERROR "Could not locate vswhere.exe - unable to source vc redistributable")
+    endif()
+    execute_process(
+        COMMAND "${_vswhere_tool}" -latest -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -find **/14.29.*/**/lib/spectre/x64 -sort
+        OUTPUT_VARIABLE _vs_install_loc_out
+        RESULT_VARIABLE _vs_where_exitcode
+        OUTPUT_STRIP_TRAILING_WHITESPACE)
+    file(TO_CMAKE_PATH "${_vs_install_loc_out}" SPECTRE_LIB_PATH_OUT)
+    string(REGEX REPLACE "[\r\n]+" ";" SPECTRE_LIB_PATH ${SPECTRE_LIB_PATH_OUT})
+    message(INFO "*** install loc: ${SPECTRE_LIB_PATH}")
+
+    # Locate the spectre mitigated runtime libraries and fail if they can't be found. Targets in this
+    # cmake project can use the variables to explicitly link these libraries rather than using the 
+    # non-mitigated libraries that are found by default.
+    find_library(LIBCMT_SPECTRE_REL libcmt PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    find_library(LIBCMT_SPECTRE_DEB libcmtd PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    set(LIBCMT_SPECTRE debug ${LIBCMT_SPECTRE_DEB} optimized ${LIBCMT_SPECTRE_REL})
+    message(INFO "*** using spectre lib: ${LIBCMT_SPECTRE}")
+    find_library(LIBCPMT_SPECTRE_REL libcpmt PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    find_library(LIBCPMT_SPECTRE_DEB libcpmtd PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    set(LIBCPMT_SPECTRE debug ${LIBCPMT_SPECTRE_DEB} optimized ${LIBCPMT_SPECTRE_REL})
+    message(INFO "*** using spectre lib: ${LIBCPMT_SPECTRE}")
+    find_library(LIBVCRUNTIME_SPECTRE_REL libvcruntime PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    find_library(LIBVCRUNTIME_SPECTRE_DEB libvcruntimed PATHS ${SPECTRE_LIB_PATH} REQUIRED)
+    set(LIBVCRUNTIME_SPECTRE debug ${LIBVCRUNTIME_SPECTRE_DEB} optimized ${LIBVCRUNTIME_SPECTRE_REL})
+    message(INFO "*** using spectre lib: ${LIBVCRUNTIME_SPECTRE}")
+    set(SPECTRE_LIBS
+        ${LIBCMT_SPECTRE}
+        ${LIBCPMT_SPECTRE}
+        ${LIBVCRUNTIME_SPECTRE})
+
     add_link_options("LINKER:/guard:cf")
 endif()
 

src/Qir/Runtime/lib/QIR/CMakeLists.txt

@@ -43,6 +43,7 @@ add_library(Microsoft.Quantum.Qir.Runtime SHARED)
 target_link_libraries(Microsoft.Quantum.Qir.Runtime
   ${CMAKE_DL_LIBS}
   qir-rt-support-obj
+  ${SPECTRE_LIBS}
 )
 
 target_include_directories(Microsoft.Quantum.Qir.Runtime PUBLIC ${public_includes})

src/Qir/Runtime/lib/QSharpCore/CMakeLists.txt

@@ -27,6 +27,7 @@ target_link_libraries(Microsoft.Quantum.Qir.QSharp.Core
   simulators-obj
   "-L${CMAKE_BINARY_DIR}/lib/QIR"
   -lMicrosoft.Quantum.Qir.Runtime
+  ${SPECTRE_LIBS}
 )
 add_dependencies(Microsoft.Quantum.Qir.QSharp.Core Microsoft.Quantum.Qir.Runtime)
 

src/Qir/Runtime/lib/QSharpFoundation/CMakeLists.txt

@@ -30,6 +30,7 @@ target_link_libraries(Microsoft.Quantum.Qir.QSharp.Foundation
   qsharp-foundation-qis-support-obj
   "-L${CMAKE_BINARY_DIR}/lib/QIR"
   -lMicrosoft.Quantum.Qir.Runtime
+  ${SPECTRE_LIBS}
 )
 add_dependencies(Microsoft.Quantum.Qir.QSharp.Foundation Microsoft.Quantum.Qir.Runtime)
 

src/Qir/Runtime/lib/Tracer/CMakeLists.txt

@@ -25,6 +25,7 @@ target_link_libraries(Microsoft.Quantum.Qir.Tracer
   tracer-obj
   "-L${CMAKE_BINARY_DIR}/lib/QIR"
   -lMicrosoft.Quantum.Qir.Runtime
+  ${SPECTRE_LIBS}
 )
 add_dependencies(Microsoft.Quantum.Qir.QSharp.Foundation Microsoft.Quantum.Qir.Runtime)