[Windows build] Use "DIA SDK" in sysroot

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.

Differential Revision: https://reviews.llvm.org/D109708

Author: nico

compiler-rt/cmake/config-ix.cmake

@@ -564,8 +564,19 @@ else()
 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()

llvm/cmake/config-ix.cmake

@@ -503,10 +503,19 @@ if( MSVC )
   set(stricmp "_stricmp")
   set(strdup "_strdup")
 
-  # See if the DIA SDK is available and usable.
-  set(MSVC_DIA_SDK_DIR "$ENV{VSINSTALLDIR}DIA SDK" CACHE PATH
-      "Path to the DIA SDK")
+  # 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.
   # 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

llvm/cmake/modules/HandleLLVMOptions.cmake

@@ -458,9 +458,6 @@ if( MSVC )
     -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")

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

@@ -1,4 +1,5 @@
 import("//llvm/lib/DebugInfo/PDB/enable_dia.gni")
+import("//llvm/utils/gn/build/sysroot.gni")
 
 static_library("PDB") {
   output_name = "LLVMDebugInfoPDB"
@@ -122,6 +123,22 @@ static_library("PDB") {
       "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

@@ -1,6 +1,7 @@
 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

@@ -13,13 +13,19 @@ 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')
@@ -28,13 +34,12 @@ def cmdout(cmd):
                 [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.