[Windows build] Use "DIA SDK" in sysroot

[thakis]

Summary

This updates llvm/utils/sysroot.py to include the "DIA SDK" folder in the sysroot.

It also updates the build to look for the DIA SDK there if a sysroot is set.

This requires moving LLVM_WINSYSROOT to config-ix.cmake.

For the GN build, I chose to pass a qualified path to diaguids in libs instead of pushing
a config with a /libpath: flag. The former requires a GN with
https://gn-review.googlesource.com/c/gn/+/12200, the latter requires D109624. The former is
more like the cmake build, arguably a bit simpler, and it's easier to check
for the wrong GN revision and easier to update GN.

[thakis]

regenerate diff with more context lines

[hans]

lgtm

compiler-rt/cmake/config-ix.cmake

573

ultra nit: Indentation of the string looks off here and in the else branch. Same for the llvm/cmake/config-ix.cmake file.

[thakis]

Thanks!

Turns out there was an existing tab character in llvm/cmake/config-ix.cmake too. I replaced that with spaces that in a preparatory commit.

compiler-rt/cmake/config-ix.cmake

573

It looks off in phab, but looks good in the raw diff…oh whoops, that's because the line starts with a tab. My bad, fixed.

(In addition to fixing my editor config, TIL about git config core.whitespace tab-in-indent.)

[saghir]

Hi, this patch is likely causing a failure on one of our bots:
https://lab.llvm.org/buildbot/#/builders/76/builds/3841

Can you please take a look at your convenience?
Thanks!

[saghir]

In D109708#3000526, @saghir wrote:

Hi, this patch is likely causing a failure on one of our bots:
https://lab.llvm.org/buildbot/#/builders/76/builds/3841

Can you please take a look at your convenience?
Thanks!

On taking a closer look, this did not look related to your change (I got tripped since your changes were the only ones that were built in that build.).
Restarting the bot seems to have fixed the error. The bot is passing now. Sorry for the false alarm.
Thanks!

compiler-rt/cmake/config-ix.cmake

else()
   filter_available_targets(XRAY_SUPPORTED_ARCH ${ALL_XRAY_SUPPORTED_ARCH})
   filter_available_targets(SHADOWCALLSTACK_SUPPORTED_ARCH
     ${ALL_SHADOWCALLSTACK_SUPPORTED_ARCH})
   filter_available_targets(GWP_ASAN_SUPPORTED_ARCH ${ALL_GWP_ASAN_SUPPORTED_ARCH})
   filter_available_targets(ORC_SUPPORTED_ARCH ${ALL_ORC_SUPPORTED_ARCH})
 endif()
 
 if (MSVC)
+  # Allow setting clang-cl's /winsysroot flag.
+  set(LLVM_WINSYSROOT "" CACHE STRING
+    "If set, argument to clang-cl's /winsysroot")
+
+  if (LLVM_WINSYSROOT)
+    set(MSVC_DIA_SDK_DIR "${LLVM_WINSYSROOT}/DIA SDK" CACHE PATH
+  "Path to the DIA SDK")
+  else()
+    set(MSVC_DIA_SDK_DIR "$ENV{VSINSTALLDIR}DIA SDK" CACHE PATH
+  "Path to the DIA SDK")
+  endif()
+
   # See if the DIA SDK is available and usable.
-  set(MSVC_DIA_SDK_DIR "$ENV{VSINSTALLDIR}DIA SDK")
   if (IS_DIRECTORY ${MSVC_DIA_SDK_DIR})
     set(CAN_SYMBOLIZE 1)
   else()
     set(CAN_SYMBOLIZE 0)
   endif()
 else()
   set(CAN_SYMBOLIZE 1)
 endif()

llvm/cmake/config-ix.cmake

else ()
   endif ()
 endif ()
 
 if( MSVC )
   set(SHLIBEXT ".lib")
   set(stricmp "_stricmp")
   set(strdup "_strdup")
 
-  # See if the DIA SDK is available and usable.
+  # Allow setting clang-cl's /winsysroot flag.
+  set(LLVM_WINSYSROOT "" CACHE STRING
+    "If set, argument to clang-cl's /winsysroot")
+
+  if (LLVM_WINSYSROOT)
+    set(MSVC_DIA_SDK_DIR "${LLVM_WINSYSROOT}/DIA SDK" CACHE PATH
+  "Path to the DIA SDK")
+  else()
     set(MSVC_DIA_SDK_DIR "$ENV{VSINSTALLDIR}DIA SDK" CACHE PATH
-      "Path to the DIA SDK")
+  "Path to the DIA SDK")
+  endif()
 
+  # See if the DIA SDK is available and usable.
   # Due to a bug in MSVC 2013's installation software, it is possible
   # for MSVC 2013 to write the DIA SDK into the Visual Studio 2012
   # install directory.  If this happens, the installation is corrupt
   # and there's nothing we can do.  It happens with enough frequency
   # though that we should handle it.  We do so by simply checking that
   # the DIA SDK folder exists.  Should this happen you will need to
   # uninstall VS 2012 and then re-install VS 2013.
   if (IS_DIRECTORY "${MSVC_DIA_SDK_DIR}")

llvm/cmake/modules/HandleLLVMOptions.cmake

add_definitions(
     )
 
   # Tell MSVC to use the Unicode version of the Win32 APIs instead of ANSI.
   add_definitions(
     -DUNICODE
     -D_UNICODE
   )
 
-  # Allow setting clang-cl's /winsysroot flag.
-  set(LLVM_WINSYSROOT "" CACHE STRING
-    "If set, argument to clang-cl's /winsysroot")
   if (LLVM_WINSYSROOT)
     if (NOT CLANG_CL)
       message(ERROR "LLVM_WINSYSROOT requires clang-cl")
     endif()
     append("/winsysroot${LLVM_WINSYSROOT}" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
   endif()
 
   if (LLVM_ENABLE_WERROR)

llvm/utils/gn/secondary/llvm/lib/DebugInfo/PDB/BUILD.gn

 import("//llvm/lib/DebugInfo/PDB/enable_dia.gni")
+import("//llvm/utils/gn/build/sysroot.gni")
 
 static_library("PDB") {
   output_name = "LLVMDebugInfoPDB"
   deps = [
     "//llvm/include/llvm/Config:config",
     "//llvm/lib/DebugInfo/CodeView",
     "//llvm/lib/DebugInfo/MSF",
     "//llvm/lib/Object",
sources += [
       "DIA/DIAInjectedSource.cpp",
       "DIA/DIALineNumber.cpp",
       "DIA/DIARawSymbol.cpp",
       "DIA/DIASectionContrib.cpp",
       "DIA/DIASession.cpp",
       "DIA/DIASourceFile.cpp",
       "DIA/DIATable.cpp",
     ]
-    libs = [ "diaguids.lib" ]
+
+    dia_lib_path = ""
+    if (sysroot != "") {
+      assert(gn_version >= 1937,
+             "Building with sysroot and DIA requires a newer GN. " +
+                 "Run `python3 llvm\utils\gn\get.py` to update.")
+      include_dirs = [ "$sysroot/DIA SDK/include" ]
+      dia_lib_path = "$sysroot/DIA SDK/lib/"  # x86 .lib file is here.
+      if (current_cpu == "arm") {
+        dia_lib_path += "arm/"
+      } else if (current_cpu == "arm64") {
+        dia_lib_path += "arm64/"
+      } else if (current_cpu == "x64") {
+        dia_lib_path += "amd64/"
+      }
+    }
+    libs = [ "${dia_lib_path}diaguids.lib" ]
   }
 }

llvm/utils/gn/secondary/llvm/lib/DebugInfo/PDB/enable_dia.gni

 declare_args() {
   # Whether to build code that requires the Microsoft DIA SDK.
   # If this is set, %INCLUDE% must contain ".../DIA SDK/include"
-  # and %LIB% must contain ".../DIA SDK/lib/amd64".
+  # and %LIB% must contain ".../DIA SDK/lib/amd64". Or use
+  # llvm/utils/sysroot.py and set sysroot in args.gn.
   llvm_enable_dia_sdk = false
 }

llvm/utils/sysroot.py

 #!/usr/bin/env python3
 
 """Helps manage sysroots."""
 
 import argparse
 import os
 import subprocess
 import sys
 
 
 def make_fake_sysroot(out_dir):
     def cmdout(cmd):
         return subprocess.check_output(cmd).decode(sys.stdout.encoding).strip()
 
     if sys.platform == 'win32':
+        def mkjunction(dst, src):
+            subprocess.check_call(['mklink', '/j', dst, src], shell=True)
+
+        os.mkdir(out_dir)
         p = os.getenv('ProgramFiles(x86)', 'C:\\Program Files (x86)')
 
         winsdk = os.getenv('WindowsSdkDir')
         if not winsdk:
             winsdk = os.path.join(p, 'Windows Kits', '10')
             print('%WindowsSdkDir% not set. You might want to run this from')
             print('a Visual Studio cmd prompt. Defaulting to', winsdk)
+        os.mkdir(os.path.join(out_dir, 'Windows Kits'))
+        mkjunction(os.path.join(out_dir, 'Windows Kits', '10'), winsdk)
 
         vswhere = os.path.join(
                 p, 'Microsoft Visual Studio', 'Installer', 'vswhere')
         vcid = 'Microsoft.VisualStudio.Component.VC.Tools.x86.x64'
         vsinstalldir = cmdout(
                 [vswhere, '-latest', '-products', '*', '-requires', vcid,
                     '-property', 'installationPath'])
 
-        def mkjunction(dst, src):
-            subprocess.check_call(['mklink', '/j', dst, src], shell=True)
-        os.mkdir(out_dir)
         mkjunction(os.path.join(out_dir, 'VC'),
                    os.path.join(vsinstalldir, 'VC'))
-        os.mkdir(os.path.join(out_dir, 'Windows Kits'))
-        mkjunction(os.path.join(out_dir, 'Windows Kits', '10'), winsdk)
+        # Not all MSVC versions ship the DIA SDK, so the junction destination
+        # might not exist. That's fine.
+        mkjunction(os.path.join(out_dir, 'DIA SDK'),
+                   os.path.join(vsinstalldir, 'DIA SDK'))
     elif sys.platform == 'darwin':
         # The SDKs used by default in compiler-rt/cmake/base-config-ix.cmake.
         # COMPILER_RT_ENABLE_IOS defaults to on.
         # COMPILER_RT_ENABLE_WATCHOS and COMPILER_RT_ENABLE_TV default to off.
         # compiler-rt/cmake/config-ix.cmake sets DARWIN_EMBEDDED_PLATFORMS
         # depending on these.
         sdks = ['macosx', 'iphoneos', 'iphonesimulator']
         os.mkdir(out_dir)