[lldb] Pass CMAKE_SYSROOT through to LLDB shell tests

[mysterymath]

Summary

This allows the LLDB Shell tests to succeed in (e.g. CI) environments where
system libraries are provided hermetically as a sysroot.

[mysterymath]

Update commit message.

[mysterymath]

More style fixes.

[mysterymath]

Restore accidentally removed flag.

[JDevlieghere]

The change itself looks fine, but isn't this an issue for the API tests too? If so, how is the sys root passed to dotest.py and can the shell tests do the same?

[mysterymath]

In D151269#4366484, @JDevlieghere wrote:

The change itself looks fine, but isn't this an issue for the API tests too? If so, how is the sys root passed to dotest.py and can the shell tests do the same?

Ah, thanks for the heads up. I couldn't find anything in the API tests that pass through a sysroot, so this may also be something to deal with there as well.
It's not very straightforward to reproduce this on our end though; the sysrooted builders we're working with don't yet have a suitable Python for LLDB, but we'll likely run into this the moment we try include one.

[mysterymath]

Restrict description to Shell tests.

[mysterymath]

Fixed commit message typo.

[JDevlieghere]

LGTM. I suspect you'll run into the same problem when you get the API tests working, but we can deal with that when the time comes.

[mysterymath]

Apply black formatting to resolve merge conflict.

lldb/test/Shell/helper/build.py

 parser.add_argument(
     "--objc-gnustep",
     dest="objc_gnustep",
     action="store_true",
     default=False,
     help="Include and link GNUstep libobjc2 (Windows and Linux only)",
 )
 
+parser.add_argument(
+    "--sysroot",
+    metavar="directory",
+    dest="sysroot",
+    required=False,
+    help="If specified, a sysroot to be passed via --sysroot",
+)
+
 if sys.platform == "darwin":
     parser.add_argument(
         "--apple-sdk",
         metavar="apple_sdk",
         dest="apple_sdk",
         default="macosx",
         help="Specify the name of the Apple SDK (macosx, macosx.internal, iphoneos, iphoneos.internal, or path to SDK) and use the appropriate tools from that SDK's toolchain.",
     )
def __init__(self, toolchain_type, args, obj_ext):
             if args.objc_gnustep_dir
             else None
         )
         self.objc_gnustep_lib = (
             os.path.join(args.objc_gnustep_dir, "lib")
             if args.objc_gnustep_dir
             else None
         )
+        self.sysroot = args.sysroot
 
     def _exe_file_name(self):
         assert self.mode != "compile"
         return self.output
 
     def _output_name(self, input, extension, with_executable=False):
         basename = os.path.splitext(os.path.basename(input))[0] + extension
         if with_executable:
def _get_compilation_command(self, source, obj):
             args.extend(["-isysroot", self.apple_sdk])
         elif self.objc_gnustep_inc:
             if source.endswith(".m") or source.endswith(".mm"):
                 args.extend(["-fobjc-runtime=gnustep-2.0", "-I", self.objc_gnustep_inc])
                 if sys.platform == "win32":
                     args.extend(
                         ["-Xclang", "-gcodeview", "-Xclang", "--dependent-lib=msvcrtd"]
                     )
+        elif self.sysroot:
+            args.extend(["--sysroot", self.sysroot])
 
         if self.std:
             args.append("-std={0}".format(self.std))
 
         args.extend(["-o", obj])
         args.append(source)
 
         return ("compiling", [source], obj, None, args)
def _get_link_command(self):
         elif self.objc_gnustep_lib:
             args.extend(["-L", self.objc_gnustep_lib, "-lobjc"])
             if sys.platform == "linux":
                 args.extend(["-Wl,-rpath," + self.objc_gnustep_lib])
             elif sys.platform == "win32":
                 args.extend(
                     ["-fuse-ld=lld-link", "-g", "-Xclang", "--dependent-lib=msvcrtd"]
                 )
+        elif self.sysroot:
+            args.extend(["--sysroot", self.sysroot])
 
         return ("linking", self._obj_file_names(), self._exe_file_name(), None, args)
 
     def output_files(self):
         outputs = []
         if self.mode == "compile" or self.mode == "compile-and-link":
             outputs.extend(self._obj_file_names())
         if self.mode == "link" or self.mode == "compile-and-link":

lldb/test/Shell/helper/toolchain.py

def use_lldb_substitutions(config):
     if config.lldb_tools_dir:
         build_script_args.append("--tools-dir={0}".format(config.lldb_tools_dir))
     if config.llvm_libs_dir:
         build_script_args.append("--libs-dir={0}".format(config.llvm_libs_dir))
     if config.objc_gnustep_dir:
         build_script_args.append(
             '--objc-gnustep-dir="{0}"'.format(config.objc_gnustep_dir)
         )
+    if config.cmake_sysroot:
+        build_script_args.append("--sysroot={0}".format(config.cmake_sysroot))
 
     lldb_init = _get_lldb_init_path(config)
 
     primary_tools = [
         ToolSubst(
             "%lldb",
             command=FindTool("lldb"),
             extra_args=["--no-lldbinit", "-S", lldb_init],
if sys.platform.startswith("netbsd"):
         host_flags += [
             "-L" + config.llvm_libs_dir,
             "-Wl,-rpath," + config.llvm_libs_dir,
         ]
 
     # The clang module cache is used for building inferiors.
     host_flags += ["-fmodules-cache-path={}".format(config.clang_module_cache)]
 
+    if config.cmake_sysroot:
+        host_flags += ["--sysroot={}".format(config.cmake_sysroot)]
+
     host_flags = " ".join(host_flags)
     config.substitutions.append(("%clang_host", "%clang " + host_flags))
     config.substitutions.append(("%clangxx_host", "%clangxx " + host_flags))
     config.substitutions.append(
         ("%clang_cl_host", "%clang_cl --target=" + config.host_triple)
     )
 
     additional_tool_dirs = []

lldb/test/Shell/lit.site.cfg.py.in

 @LIT_SITE_CFG_IN_HEADER@
 
 config.llvm_src_root = "@LLVM_SOURCE_DIR@"
 config.llvm_obj_root = "@LLVM_BINARY_DIR@"
 config.llvm_tools_dir = lit_config.substitute("@LLVM_TOOLS_DIR@")
 config.llvm_libs_dir = lit_config.substitute("@LLVM_LIBS_DIR@")
 config.llvm_shlib_dir = lit_config.substitute("@SHLIBDIR@")
 config.lit_tools_dir = "@LLVM_LIT_TOOLS_DIR@"
 config.lldb_src_root = "@LLDB_SOURCE_DIR@"
 config.lldb_obj_root = "@LLDB_BINARY_DIR@"
 config.lldb_libs_dir = lit_config.substitute("@LLDB_LIBS_DIR@")
 config.lldb_tools_dir = lit_config.substitute("@LLDB_TOOLS_DIR@")
 # Since it comes from the command line, it may have backslashes which
 # should not need to be escaped.
 config.lldb_lit_tools_dir = lit_config.substitute(r"@LLDB_LIT_TOOLS_DIR@")
+config.cmake_sysroot = lit_config.substitute("@CMAKE_SYSROOT@")
 config.target_triple = "@LLVM_TARGET_TRIPLE@"
 config.python_executable = "@Python3_EXECUTABLE@"
 config.have_zlib = @LLVM_ENABLE_ZLIB@
 config.objc_gnustep_dir = "@LLDB_TEST_OBJC_GNUSTEP_DIR@"
 config.lldb_enable_lzma = @LLDB_ENABLE_LZMA@
 config.host_triple = "@LLVM_HOST_TRIPLE@"
 config.lldb_bitness = 64 if @LLDB_IS_64_BITS@ else 32
 config.lldb_enable_python = @LLDB_ENABLE_PYTHON@