[llvm-lit] copy CRT/STL DLLs into the output directory

[strega-nil]

Summary

It turns out that the STL requires you to place the DLLs into the
directory of the executable; else, msvcp140.dll will be taken from
C:\Windows\System32 (which is unsupported).

This was discovered because of the recent constexpr mutex change;
see [microsoft/STL#3824][]. Especially the fuzzer unit tests fail
completely with the mutex changes.

[microsoft/STL#3824]: https://github.com/microsoft/STL/issues/3824

[strega-nil]

llvm/utils/lit/lit/TestRunner.py

2081 ↗

(On Diff #551284)

This doesn't work with clang's version of lit, only with our msvc version of lit, since the output directory is shared; I'm going to need to figure out a better way to do this, that works with either.

[strega-nil]

Fix the code to work with built-in lit/main.py

The code in the first commit was designed to work with MSVC's internal
lit/msvc_main.py; the new code works with either.

[strega-nil]

oops, missed a commit (ignore)

[rnk]

I'm not that familiar with the typical compatibility requirements for DLLs in the Windows system folder, but it seems pretty disruptive to ship a DLL in the system folder, and then ship ABI incompatible changes without increasing the version number. Wouldn't this all work if the STL increased the version number of msvcp140.dll instead?

llvm/utils/lit/lit/run.py

73

This is typically quite a lot of directories, so this doesn't seem like a great solution. I looked at the DLL search path docs, and it looks like the system directory (C:\Windows\System32) precedes PATH, which is unfortunate. Is there no other way to inject a DLL search path *before* the system directory? SxS manifests seem like the most promising option, but that doesn't sound like fun either.

[strega-nil]

It turns out I misunderstood how this release process works; it is _only_ important inside our internal test harness, not inside the LLVM public test harness; I apologize for opening this non-useful PR.

llvm/utils/lit/lit/run.py

+import itertools
 import multiprocessing
 import os
+import pathlib
+import shutil
 import time
 
 import lit.Test
 import lit.util
 import lit.worker
 
 
 class MaxFailuresError(Exception):
def execute(self):
         self.failures = 0
 
         # Larger timeouts (one year, positive infinity) don't work on Windows.
         one_week = 7 * 24 * 60 * 60  # days * hours * minutes * seconds
         timeout = self.timeout or one_week
         deadline = time.time() + timeout
 
         try:
+            # On Windows, copy the required DLLs from PATH into the test directory
+            # This avoids the loader finding DLLs in C:\Windows\System32
+            if self.lit_config.isWindows:
+                def outputPath(path):
+                    # this handles both the unit test C:\...\TestCases\Windows\foo.cpp,
+                    # and also the regular test C:\...\X86_64WindowsDynamicConfig\Asan-x86_64-inline-Dynamic-Test.exe\16\18
+                    path = pathlib.Path(path)
+                    parent = path.parent
+                    while path.suffix == '':
+                        path, parent = parent, parent.parent
+                        assert(path != path.parent)
+                    return parent / 'Output'
+                outputDirectories = {outputPath(test.getExecPath()) for test in self.tests}
+                toolsetDirectory = pathlib.Path(lit.util.which("cl.exe")).parent
+                for outputDirectory in outputDirectories:
+                    lit.util.mkdir_p(outputDirectory)
+                    for dllToCopy in itertools.chain(\
+                            toolsetDirectory.glob('msvcp*.dll'),\
+                            toolsetDirectory.glob('vcruntime*.dll'),\
+                            toolsetDirectory.glob('ucrtbase*.dll')):
+                        shutil.copyfile(dllToCopy, outputDirectory / dllToCopy.name)
+
             self._execute(deadline)
         finally:
             skipped = lit.Test.Result(lit.Test.SKIPPED)
             for test in self.tests:
                 if test.result is None:
                     test.setResult(skipped)
 
     def _execute(self, deadline):

llvm/utils/lit/lit/util.py

if os.path.isabs(command) and os.path.isfile(command):
         return os.path.normcase(os.path.normpath(command))
 
     # Would be nice if Python had a lib function for this.
     if not paths:
         paths = os.defpath
 
     # Get suffixes to search.
     # On Cygwin, 'PATHEXT' may exist but it should not be used.
-    if os.pathsep == ";":
-        pathext = os.environ.get("PATHEXT", "").split(";")
+    if os.path.splitext(command)[-1] != '' or os.pathsep != ';':
+        pathext = ['']
     else:
-        pathext = [""]
+        pathext = os.environ.get('PATHEXT', '').split(';')
 
     # Search the paths...
     for path in paths.split(os.pathsep):
         for ext in pathext:
             p = os.path.join(path, command + ext)
             if os.path.exists(p) and not os.path.isdir(p):
                 return os.path.normcase(os.path.abspath(p))