HostInfoMacOSX.mm

Go to the documentation of this file.

//===-- HostInfoMacOSX.mm ---------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#include "lldb/Host/macosx/HostInfoMacOSX.h"
#include "lldb/Host/FileSystem.h"
#include "lldb/Host/Host.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Utility/Args.h"
#include "lldb/Utility/ConstString.h"
#include "lldb/Utility/DataBuffer.h"
#include "lldb/Utility/DataExtractor.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/Timer.h"
#include "lldb/Utility/VirtualDataExtractor.h"
 
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/RWMutex.h"
#include "llvm/Support/raw_ostream.h"
 
// C++ Includes
#include <optional>
#include <string>
 
// C inclues
#include <cstdlib>
#include <dlfcn.h>
#include <sys/sysctl.h>
#include <sys/syslimits.h>
#include <sys/types.h>
#include <uuid/uuid.h>
 
// Objective-C/C++ includes
#include <AvailabilityMacros.h>
#include <CoreFoundation/CoreFoundation.h>
#include <Foundation/Foundation.h>
#include <mach-o/dyld.h>
#if defined(MAC_OS_X_VERSION_MIN_REQUIRED) && \
    MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_VERSION_12_0
#if __has_include(<mach-o/dyld_introspection.h>)
#include <mach-o/dyld_introspection.h>
#define SDK_HAS_NEW_DYLD_INTROSPECTION_SPIS
#endif
#endif
#include <objc/objc-auto.h>
 
// These are needed when compiling on systems
// that do not yet have these definitions
#ifndef CPU_SUBTYPE_X86_64_H
#define CPU_SUBTYPE_X86_64_H ((cpu_subtype_t)8)
#endif
#ifndef CPU_TYPE_ARM64
#define CPU_TYPE_ARM64 (CPU_TYPE_ARM | CPU_ARCH_ABI64)
#endif
 
#ifndef CPU_TYPE_ARM64_32
#define CPU_ARCH_ABI64_32 0x02000000
#define CPU_TYPE_ARM64_32 (CPU_TYPE_ARM | CPU_ARCH_ABI64_32)
#endif
 
#include <TargetConditionals.h> // for TARGET_OS_TV, TARGET_OS_WATCH
 
using namespace lldb;
using namespace lldb_private;
 
std::optional<std::string> HostInfoMacOSX::GetOSBuildString() {
  int mib[2] = {CTL_KERN, KERN_OSVERSION};
  char cstr[PATH_MAX];
  size_t cstr_len = sizeof(cstr);
  if (::sysctl(mib, 2, cstr, &cstr_len, NULL, 0) == 0)
    return std::string(cstr, cstr_len - 1);
 
  return std::nullopt;
}
 
static void ParseOSVersion(llvm::VersionTuple &version, NSString *Key) {
  @autoreleasepool {
    NSDictionary *version_info =
        [NSDictionary dictionaryWithContentsOfFile:
                          @"/System/Library/CoreServices/SystemVersion.plist"];
    NSString *version_value = [version_info objectForKey: Key];
    const char *version_str = [version_value UTF8String];
    version.tryParse(version_str);
  }
}
 
llvm::VersionTuple HostInfoMacOSX::GetOSVersion() {
  static llvm::VersionTuple g_version;
  if (g_version.empty())
    ParseOSVersion(g_version, @"ProductVersion");
  return g_version;
}
 
llvm::VersionTuple HostInfoMacOSX::GetMacCatalystVersion() {
  static llvm::VersionTuple g_version;
  if (g_version.empty())
    ParseOSVersion(g_version, @"iOSSupportVersion");
  return g_version;
}
 
 
FileSpec HostInfoMacOSX::GetProgramFileSpec() {
  static FileSpec g_program_filespec;
  if (!g_program_filespec) {
    char program_fullpath[PATH_MAX];
    // If DST is NULL, then return the number of bytes needed.
    uint32_t len = sizeof(program_fullpath);
    int err = _NSGetExecutablePath(program_fullpath, &len);
    if (err == 0)
      g_program_filespec.SetFile(program_fullpath, FileSpec::Style::native);
    else if (err == -1) {
      char *large_program_fullpath = (char *)::malloc(len + 1);
 
      err = _NSGetExecutablePath(large_program_fullpath, &len);
      if (err == 0)
        g_program_filespec.SetFile(large_program_fullpath,
                                   FileSpec::Style::native);
 
      ::free(large_program_fullpath);
    }
  }
  return g_program_filespec;
}
 
/// Resolve the given candidate support dir and return true if it's valid.
static bool ResolveAndVerifyCandidateSupportDir(FileSpec &path) {
  FileSystem::Instance().Resolve(path);
  return FileSystem::Instance().IsDirectory(path);
}
 
bool HostInfoMacOSX::ComputeSupportExeDirectory(FileSpec &file_spec) {
  FileSpec lldb_file_spec = GetShlibDir();
  if (!lldb_file_spec)
    return false;
 
  std::string raw_path = lldb_file_spec.GetPath();
 
  size_t framework_pos = raw_path.find("LLDB.framework");
  if (framework_pos != std::string::npos) {
    framework_pos += strlen("LLDB.framework");
#if TARGET_OS_IPHONE
    // Shallow bundle
    raw_path.resize(framework_pos);
#else
    // Normal bundle
    raw_path.resize(framework_pos);
    raw_path.append("/Resources");
#endif
  } else {
    // Find the bin path relative to the lib path where the cmake-based
    // OS X .dylib lives. We try looking first at a possible sibling `bin`
    // directory, and then at the `lib` directory itself. This last case is
    // useful for supporting build systems like Bazel which in many cases prefer
    // to place support binaries right next to dylibs.
    //
    // It is not going to work to do it by the executable path,
    // as in the case of a python script, the executable is python, not
    // the lldb driver.
    FileSpec support_dir_spec_lib(raw_path);
    FileSpec support_dir_spec_bin =
        support_dir_spec_lib.CopyByAppendingPathComponent("/../bin");
    FileSpec support_dir_spec;
 
    if (ResolveAndVerifyCandidateSupportDir(support_dir_spec_bin)) {
      support_dir_spec = support_dir_spec_bin;
    } else if (ResolveAndVerifyCandidateSupportDir(support_dir_spec_lib)) {
      support_dir_spec = support_dir_spec_lib;
    } else {
      Log *log = GetLog(LLDBLog::Host);
      LLDB_LOG(log, "failed to find support directory");
      return false;
    }
 
    // Get normalization from support_dir_spec.  Note the FileSpec resolve
    // does not remove '..' in the path.
    char *const dir_realpath =
        realpath(support_dir_spec.GetPath().c_str(), NULL);
    if (dir_realpath) {
      raw_path = dir_realpath;
      free(dir_realpath);
    } else {
      raw_path = support_dir_spec.GetPath();
    }
  }
 
  file_spec.SetDirectory(raw_path);
  return (bool)file_spec.GetDirectory();
}
 
bool HostInfoMacOSX::ComputeHeaderDirectory(FileSpec &file_spec) {
  FileSpec lldb_file_spec = GetShlibDir();
  if (!lldb_file_spec)
    return false;
 
  std::string raw_path = lldb_file_spec.GetPath();
 
  size_t framework_pos = raw_path.find("LLDB.framework");
  if (framework_pos != std::string::npos) {
    framework_pos += strlen("LLDB.framework");
    raw_path.resize(framework_pos);
    raw_path.append("/Headers");
  }
  file_spec.SetDirectory(raw_path);
  return true;
}
 
bool HostInfoMacOSX::ComputeSystemPluginsDirectory(FileSpec &file_spec) {
  FileSpec lldb_file_spec = GetShlibDir();
  if (!lldb_file_spec)
    return false;
 
  std::string raw_path = lldb_file_spec.GetPath();
 
  size_t framework_pos = raw_path.find("LLDB.framework");
  if (framework_pos == std::string::npos)
    return false;
 
  framework_pos += strlen("LLDB.framework");
  raw_path.resize(framework_pos);
  raw_path.append("/Resources/PlugIns");
  file_spec.SetDirectory(raw_path);
  return true;
}
 
bool HostInfoMacOSX::ComputeUserPluginsDirectory(FileSpec &file_spec) {
  FileSpec home_dir_spec = GetUserHomeDir();
  home_dir_spec.AppendPathComponent("Library/Application Support/LLDB/PlugIns");
  file_spec.SetDirectory(home_dir_spec.GetPathAsConstString());
  return true;
}
 
void HostInfoMacOSX::ComputeHostArchitectureSupport(ArchSpec &arch_32,
                                                    ArchSpec &arch_64) {
  // All apple systems support 32 bit execution.
  uint32_t cputype, cpusubtype;
  uint32_t is_64_bit_capable = false;
  size_t len = sizeof(cputype);
  ArchSpec host_arch;
  // These will tell us about the kernel architecture, which even on a 64
  // bit machine can be 32 bit...
  if (::sysctlbyname("hw.cputype", &cputype, &len, NULL, 0) == 0) {
    len = sizeof(cpusubtype);
    if (::sysctlbyname("hw.cpusubtype", &cpusubtype, &len, NULL, 0) != 0)
      cpusubtype = CPU_TYPE_ANY;
 
    len = sizeof(is_64_bit_capable);
    ::sysctlbyname("hw.cpu64bit_capable", &is_64_bit_capable, &len, NULL, 0);
 
    if (cputype == CPU_TYPE_ARM64 && cpusubtype == CPU_SUBTYPE_ARM64E) {
      // The arm64e architecture is a preview. Pretend the host architecture
      // is arm64.
      cpusubtype = CPU_SUBTYPE_ARM64_ALL;
    }
 
    if (is_64_bit_capable) {
      if (cputype & CPU_ARCH_ABI64) {
        // We have a 64 bit kernel on a 64 bit system
        arch_64.SetArchitecture(eArchTypeMachO, cputype, cpusubtype);
      } else {
        // We have a 64 bit kernel that is returning a 32 bit cputype, the
        // cpusubtype will be correct as if it were for a 64 bit architecture
        arch_64.SetArchitecture(eArchTypeMachO, cputype | CPU_ARCH_ABI64,
                                cpusubtype);
      }
 
      // Now we need modify the cpusubtype for the 32 bit slices.
      uint32_t cpusubtype32 = cpusubtype;
#if defined(__i386__) || defined(__x86_64__)
      if (cpusubtype == CPU_SUBTYPE_486 || cpusubtype == CPU_SUBTYPE_X86_64_H)
        cpusubtype32 = CPU_SUBTYPE_I386_ALL;
#elif defined(__arm__) || defined(__arm64__) || defined(__aarch64__)
      if (cputype == CPU_TYPE_ARM || cputype == CPU_TYPE_ARM64)
        cpusubtype32 = CPU_SUBTYPE_ARM_V7S;
#endif
      arch_32.SetArchitecture(eArchTypeMachO, cputype & ~(CPU_ARCH_MASK),
                              cpusubtype32);
 
      if (cputype == CPU_TYPE_ARM ||
          cputype == CPU_TYPE_ARM64 ||
          cputype == CPU_TYPE_ARM64_32) {
// When running on a watch or tv, report the host os correctly
#if defined(TARGET_OS_TV) && TARGET_OS_TV == 1
        arch_32.GetTriple().setOS(llvm::Triple::TvOS);
        arch_64.GetTriple().setOS(llvm::Triple::TvOS);
#elif defined(TARGET_OS_BRIDGE) && TARGET_OS_BRIDGE == 1
        arch_32.GetTriple().setOS(llvm::Triple::BridgeOS);
        arch_64.GetTriple().setOS(llvm::Triple::BridgeOS);
#elif defined(TARGET_OS_WATCHOS) && TARGET_OS_WATCHOS == 1
        arch_32.GetTriple().setOS(llvm::Triple::WatchOS);
        arch_64.GetTriple().setOS(llvm::Triple::WatchOS);
#elif defined(TARGET_OS_XR) && TARGET_OS_XR == 1
        arch_32.GetTriple().setOS(llvm::Triple::XROS);
        arch_64.GetTriple().setOS(llvm::Triple::XROS);
#elif defined(TARGET_OS_OSX) && TARGET_OS_OSX == 1
        arch_32.GetTriple().setOS(llvm::Triple::MacOSX);
        arch_64.GetTriple().setOS(llvm::Triple::MacOSX);
#else
        arch_32.GetTriple().setOS(llvm::Triple::IOS);
        arch_64.GetTriple().setOS(llvm::Triple::IOS);
#endif
      } else {
        arch_32.GetTriple().setOS(llvm::Triple::MacOSX);
        arch_64.GetTriple().setOS(llvm::Triple::MacOSX);
      }
    } else {
      // We have a 32 bit kernel on a 32 bit system
      arch_32.SetArchitecture(eArchTypeMachO, cputype, cpusubtype);
#if defined(TARGET_OS_WATCH) && TARGET_OS_WATCH == 1
      arch_32.GetTriple().setOS(llvm::Triple::WatchOS);
#else
      arch_32.GetTriple().setOS(llvm::Triple::IOS);
#endif
      arch_64.Clear();
    }
  }
}
 
/// Return and cache $DEVELOPER_DIR if it is set and exists.
static std::string GetEnvDeveloperDir() {
  static std::string g_env_developer_dir;
  static std::once_flag g_once_flag;
  std::call_once(g_once_flag, [&]() {
    if (const char *developer_dir_env_var = getenv("DEVELOPER_DIR")) {
      FileSpec fspec(developer_dir_env_var);
      if (FileSystem::Instance().Exists(fspec))
        g_env_developer_dir = fspec.GetPath();
    }});
  return g_env_developer_dir;
}
 
FileSpec HostInfoMacOSX::GetXcodeContentsDirectory() {
  static FileSpec g_xcode_contents_path;
  static std::once_flag g_once_flag;
  std::call_once(g_once_flag, [&]() {
    // Try the shlib dir first.
    if (FileSpec fspec = HostInfo::GetShlibDir()) {
      if (FileSystem::Instance().Exists(fspec)) {
        std::string xcode_contents_dir =
            XcodeSDK::FindXcodeContentsDirectoryInPath(fspec.GetPath());
        if (!xcode_contents_dir.empty()) {
          g_xcode_contents_path = FileSpec(xcode_contents_dir);
          return;
        }
      }
    }
 
    llvm::SmallString<128> env_developer_dir(GetEnvDeveloperDir());
    if (!env_developer_dir.empty()) {
      llvm::sys::path::append(env_developer_dir, "Contents");
      std::string xcode_contents_dir =
          XcodeSDK::FindXcodeContentsDirectoryInPath(env_developer_dir);
      if (!xcode_contents_dir.empty()) {
        g_xcode_contents_path = FileSpec(xcode_contents_dir);
        return;
      }
    }
 
    auto sdk_path_or_err =
        HostInfo::GetSDKRoot(SDKOptions{XcodeSDK::GetAnyMacOS()});
    if (!sdk_path_or_err) {
      Log *log = GetLog(LLDBLog::Host);
      LLDB_LOG_ERROR(log, sdk_path_or_err.takeError(),
                     "Error while searching for Xcode SDK: {0}");
      return;
    }
    FileSpec fspec(*sdk_path_or_err);
    if (fspec) {
      if (FileSystem::Instance().Exists(fspec)) {
        std::string xcode_contents_dir =
            XcodeSDK::FindXcodeContentsDirectoryInPath(fspec.GetPath());
        if (!xcode_contents_dir.empty()) {
          g_xcode_contents_path = FileSpec(xcode_contents_dir);
          return;
        }
      }
    }
  });
  return g_xcode_contents_path;
}
 
lldb_private::FileSpec HostInfoMacOSX::GetXcodeDeveloperDirectory() {
  static lldb_private::FileSpec g_developer_directory;
  static llvm::once_flag g_once_flag;
  llvm::call_once(g_once_flag, []() {
    if (FileSpec fspec = GetXcodeContentsDirectory()) {
      fspec.AppendPathComponent("Developer");
      if (FileSystem::Instance().Exists(fspec))
        g_developer_directory = fspec;
    }
  });
  return g_developer_directory;
}
 
std::string HostInfoMacOSX::FindComponentInPath(llvm::StringRef path,
                                                llvm::StringRef component) {
  auto begin = llvm::sys::path::begin(path);
  auto end = llvm::sys::path::end(path);
  for (auto it = begin; it != end; ++it) {
    if (it->contains(component)) {
      llvm::SmallString<128> buffer;
      llvm::sys::path::append(buffer, begin, ++it,
                              llvm::sys::path::Style::posix);
      return buffer.str().str();
    }
  }
  return {};
}
 
FileSpec HostInfoMacOSX::GetCurrentXcodeToolchainDirectory() {
  if (FileSpec fspec = HostInfo::GetShlibDir())
    return FileSpec(FindComponentInPath(fspec.GetPath(), ".xctoolchain"));
  return {};
}
 
FileSpec HostInfoMacOSX::GetCurrentCommandLineToolsDirectory() {
  if (FileSpec fspec = HostInfo::GetShlibDir())
    return FileSpec(FindComponentInPath(fspec.GetPath(), "CommandLineTools"));
  return {};
}
 
static llvm::Expected<std::string>
xcrun(const std::string &sdk, llvm::ArrayRef<llvm::StringRef> arguments,
      llvm::StringRef developer_dir = "") {
  Args args;
  if (!developer_dir.empty()) {
    args.AppendArgument("/usr/bin/env");
    args.AppendArgument("DEVELOPER_DIR=" + developer_dir.str());
  }
  args.AppendArgument("/usr/bin/xcrun");
  args.AppendArgument("--sdk");
  args.AppendArgument(sdk);
  for (auto arg: arguments)
    args.AppendArgument(arg);
 
  Log *log = GetLog(LLDBLog::Host);
  if (log) {
    std::string cmdstr;
    args.GetCommandString(cmdstr);
    LLDB_LOG(log, "GetXcodeSDK() running shell cmd '{0}'", cmdstr);
  }
 
  int status = 0;
  int signo = 0;
  std::string output_str;
  // The first time after Xcode was updated or freshly installed,
  // xcrun can take surprisingly long to build up its database.
  auto timeout = std::chrono::seconds(60);
  bool run_in_shell = false;
  lldb_private::Status error =
      Host::RunShellCommand(args, FileSpec(), &status, &signo, &output_str,
                            nullptr, timeout, run_in_shell);
 
  // Check that xcrun returned something useful.
  if (error.Fail()) {
    // Catastrophic error.
    LLDB_LOG(log, "xcrun failed to execute: {0}", error);
    return error.ToError();
  }
  if (status != 0) {
    // xcrun didn't find a matching SDK. Not an error, we'll try
    // different spellings.
    LLDB_LOG(log, "xcrun returned exit code {0}", status);
    if (!output_str.empty())
      LLDB_LOG(log, "xcrun output was:\n{0}", output_str);
    return "";
  }
  if (output_str.empty()) {
    LLDB_LOG(log, "xcrun returned no results");
    return "";
  }
 
  // Convert to a StringRef so we can manipulate the string without modifying
  // the underlying data.
  llvm::StringRef output(output_str);
 
  // Remove any trailing newline characters.
  output = output.rtrim();
 
  // Strip any leading newline characters and everything before them.
  const size_t last_newline = output.rfind('\n');
  if (last_newline != llvm::StringRef::npos)
    output = output.substr(last_newline + 1);
 
  return output.str();
}
 
static llvm::Expected<std::string> GetXcodeSDK(XcodeSDK sdk) {
  XcodeSDK::Info info = sdk.Parse();
  std::string sdk_name = XcodeSDK::GetCanonicalName(info);
  if (sdk_name.empty())
    return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                   "Unrecognized SDK type: " + sdk.GetString());
 
  Log *log = GetLog(LLDBLog::Host);
 
  auto find_sdk =
      [](const std::string &sdk_name) -> llvm::Expected<std::string> {
    llvm::SmallVector<llvm::StringRef, 1> show_sdk_path = {"--show-sdk-path"};
    // Invoke xcrun with the developer dir specified in the environment.
    std::string developer_dir = GetEnvDeveloperDir();
    if (!developer_dir.empty()) {
      // Don't fallback if DEVELOPER_DIR was set.
      return xcrun(sdk_name, show_sdk_path, developer_dir);
    }
 
    // Invoke xcrun with the shlib dir.
    if (FileSpec fspec = HostInfo::GetShlibDir()) {
      if (FileSystem::Instance().Exists(fspec)) {
        llvm::SmallString<0> shlib_developer_dir(
            XcodeSDK::FindXcodeContentsDirectoryInPath(fspec.GetPath()));
        llvm::sys::path::append(shlib_developer_dir, "Developer");
        if (FileSystem::Instance().Exists(shlib_developer_dir)) {
          auto sdk = xcrun(sdk_name, show_sdk_path, shlib_developer_dir);
          if (!sdk)
            return sdk.takeError();
          if (!sdk->empty())
            return sdk;
        }
      }
    }
 
    // Invoke xcrun without a developer dir as a last resort.
    return xcrun(sdk_name, show_sdk_path);
  };
 
  auto path_or_err = find_sdk(sdk_name);
  if (!path_or_err)
    return path_or_err.takeError();
  std::string path = *path_or_err;
  while (path.empty()) {
    // Try an alternate spelling of the name ("macosx10.9internal").
    if (info.type == XcodeSDK::Type::MacOSX && !info.version.empty() &&
        info.internal) {
      llvm::StringRef fixed(sdk_name);
      if (fixed.consume_back(".internal"))
        sdk_name = fixed.str() + "internal";
      path_or_err = find_sdk(sdk_name);
      if (!path_or_err)
        return path_or_err.takeError();
      path = *path_or_err;
      if (!path.empty())
        break;
    }
    LLDB_LOG(log, "Couldn't find SDK {0} on host", sdk_name);
 
    // Try without the version.
    if (!info.version.empty()) {
      info.version = {};
      sdk_name = XcodeSDK::GetCanonicalName(info);
      path_or_err = find_sdk(sdk_name);
      if (!path_or_err)
        return path_or_err.takeError();
      path = *path_or_err;
      if (!path.empty())
        break;
    }
 
    LLDB_LOG(log, "Couldn't find any matching SDK on host");
    return "";
  }
 
  // Whatever is left in output should be a valid path.
  if (!FileSystem::Instance().Exists(path)) {
    LLDB_LOG(log, "SDK returned by xcrun doesn't exist");
    return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                   "SDK returned by xcrun doesn't exist");
  }
  return path;
}
 
namespace {
struct ErrorOrPath {
  std::string str;
  bool is_error;
};
} // namespace
 
static llvm::Expected<llvm::StringRef>
find_cached_path(llvm::StringMap<ErrorOrPath> &cache, std::mutex &mutex,
                 llvm::StringRef key,
                 std::function<llvm::Expected<std::string>(void)> compute) {
  std::lock_guard<std::mutex> guard(mutex);
  LLDB_SCOPED_TIMER();
 
  auto it = cache.find(key);
  if (it != cache.end()) {
    if (it->second.is_error)
      return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                     it->second.str);
    return it->second.str;
  }
  auto path_or_err = compute();
  if (!path_or_err) {
    std::string error = toString(path_or_err.takeError());
    cache.insert({key, {error, true}});
    return llvm::createStringError(llvm::inconvertibleErrorCode(), error);
  }
  auto it_new = cache.insert({key, {*path_or_err, false}});
  return it_new.first->second.str;
}
 
llvm::Expected<llvm::StringRef> HostInfoMacOSX::GetSDKRoot(SDKOptions options) {
  static llvm::StringMap<ErrorOrPath> g_sdk_path;
  static std::mutex g_sdk_path_mutex;
  if (!options.XcodeSDKSelection)
    return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                   "XcodeSDK not specified");
  XcodeSDK sdk = *options.XcodeSDKSelection;
  auto key = sdk.GetString();
  return find_cached_path(g_sdk_path, g_sdk_path_mutex, key, [&](){
    return GetXcodeSDK(sdk);
  });
}
 
llvm::Expected<llvm::StringRef>
HostInfoMacOSX::FindSDKTool(XcodeSDK sdk, llvm::StringRef tool) {
  static llvm::StringMap<ErrorOrPath> g_tool_path;
  static std::mutex g_tool_path_mutex;
  std::string key;
  llvm::raw_string_ostream(key) << sdk.GetString() << ":" << tool;
  return find_cached_path(
      g_tool_path, g_tool_path_mutex, key,
      [&]() -> llvm::Expected<std::string> {
        std::string sdk_name = XcodeSDK::GetCanonicalName(sdk.Parse());
        if (sdk_name.empty())
          return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                         "Unrecognized SDK type: " +
                                             sdk.GetString());
        llvm::SmallVector<llvm::StringRef, 2> find = {"-find", tool};
        return xcrun(sdk_name, find);
      });
}
 
namespace {
struct dyld_shared_cache_dylib_text_info {
  uint64_t version; // current version 1
  // following fields all exist in version 1
  uint64_t loadAddressUnslid;
  uint64_t textSegmentSize;
  uuid_t dylibUuid;
  const char *path; // pointer invalid at end of iterations
  // following fields all exist in version 2
  uint64_t textSegmentOffset; // offset from start of cache
};
typedef struct dyld_shared_cache_dylib_text_info
    dyld_shared_cache_dylib_text_info;
}
 
// All available on at least macOS 12
extern "C" {
typedef struct dyld_process_s *dyld_process_t;
typedef struct dyld_process_snapshot_s *dyld_process_snapshot_t;
typedef struct dyld_shared_cache_s *dyld_shared_cache_t;
typedef struct dyld_image_s *dyld_image_t;
 
int dyld_shared_cache_iterate_text(
    const uuid_t cacheUuid,
    void (^callback)(const dyld_shared_cache_dylib_text_info *info));
uint8_t *_dyld_get_shared_cache_range(size_t *length);
bool _dyld_get_shared_cache_uuid(uuid_t uuid);
bool dyld_image_for_each_segment_info(dyld_image_t image,
                                      void (^)(const char *segmentName,
                                               uint64_t vmAddr, uint64_t vmSize,
                                               int perm));
const char *dyld_shared_cache_file_path(void);
bool dyld_shared_cache_for_file(const char *filePath,
                                void (^block)(dyld_shared_cache_t cache));
void dyld_shared_cache_copy_uuid(dyld_shared_cache_t cache, uuid_t *uuid);
uint64_t dyld_shared_cache_get_base_address(dyld_shared_cache_t cache);
void dyld_shared_cache_for_each_image(dyld_shared_cache_t cache,
                                      void (^block)(dyld_image_t image));
bool dyld_image_copy_uuid(dyld_image_t cache, uuid_t *uuid);
const char *dyld_image_get_installname(dyld_image_t image);
const char *dyld_image_get_file_path(dyld_image_t image);
}
 
namespace {
class SharedCacheInfo {
public:
  SharedCacheImageInfo GetByFilename(UUID sc_uuid, ConstString filename) {
    llvm::sys::ScopedReader guard(m_mutex);
    if (!sc_uuid)
      sc_uuid = m_host_uuid;
    if (!m_filename_map.contains(sc_uuid))
      return {};
    if (!m_filename_map[sc_uuid].contains(filename))
      return {};
    size_t idx = m_filename_map[sc_uuid][filename];
    return m_file_infos[sc_uuid][idx];
  }
 
  SharedCacheImageInfo GetByUUID(UUID sc_uuid, UUID file_uuid) {
    llvm::sys::ScopedReader guard(m_mutex);
    if (!sc_uuid)
      sc_uuid = m_host_uuid;
    if (!m_uuid_map.contains(sc_uuid))
      return {};
    if (!m_uuid_map[sc_uuid].contains(file_uuid))
      return {};
    size_t idx = m_uuid_map[sc_uuid][file_uuid];
    return m_file_infos[sc_uuid][idx];
  }
 
  /// Given the UUID and filepath to a shared cache on the local debug host
  /// system, open it and add all of the binary images to m_caches.
  bool CreateSharedCacheImageList(UUID uuid, std::string filepath);
 
  SharedCacheInfo(SymbolSharedCacheUse sc_mode);
 
private:
  bool CreateSharedCacheInfoWithInstrospectionSPIs();
  void CreateSharedCacheInfoLLDBsVirtualMemory();
  bool CreateHostSharedCacheImageList();
 
  // These three ivars have an initial key of a shared cache UUID.
  // All of the entries for a given shared cache are in m_file_infos.
  // m_filename_map and m_uuid_map have pointers into those entries.
  llvm::SmallDenseMap<UUID, std::vector<SharedCacheImageInfo>> m_file_infos;
  llvm::SmallDenseMap<UUID, llvm::DenseMap<ConstString, size_t>> m_filename_map;
  llvm::SmallDenseMap<UUID, llvm::DenseMap<UUID, size_t>> m_uuid_map;
 
  UUID m_host_uuid;
 
  llvm::sys::RWMutex m_mutex;
 
  // macOS 26.4 and newer
  void (*m_dyld_image_retain_4HWTrace)(void *image);
  void (*m_dyld_image_release_4HWTrace)(void *image);
  dispatch_data_t (*m_dyld_image_segment_data_4HWTrace)(
      void *image, const char *segmentName);
};
 
} // namespace
 
SharedCacheInfo::SharedCacheInfo(SymbolSharedCacheUse sc_mode) {
  // macOS 26.4 and newer
  m_dyld_image_retain_4HWTrace =
      (void (*)(void *))dlsym(RTLD_DEFAULT, "dyld_image_retain_4HWTrace");
  m_dyld_image_release_4HWTrace =
      (void (*)(void *))dlsym(RTLD_DEFAULT, "dyld_image_release_4HWTrace");
  m_dyld_image_segment_data_4HWTrace =
      (dispatch_data_t(*)(void *image, const char *segmentName))dlsym(
          RTLD_DEFAULT, "dyld_image_segment_data_4HWTrace");
 
  uuid_t dsc_uuid;
  _dyld_get_shared_cache_uuid(dsc_uuid);
  m_host_uuid = UUID(dsc_uuid);
 
  // Don't scan/index lldb's own shared cache at all, in-memory or
  // via libdyld SPI.
  if (sc_mode == eSymbolSharedCacheUseInferiorSharedCacheOnly)
    return;
 
  // Check if the settings allow the use of the libdyld SPI.
  bool use_libdyld_spi =
      sc_mode == eSymbolSharedCacheUseHostSharedCache ||
      sc_mode == eSymbolSharedCacheUseHostAndInferiorSharedCache;
  if (use_libdyld_spi && CreateHostSharedCacheImageList())
    return;
 
  // Scan lldb's shared cache memory if we're built against the
  // internal SDK and have those headers.
  if (CreateSharedCacheInfoWithInstrospectionSPIs())
    return;
 
  // Scan lldb's shared cache memory if we're built against the public
  // SDK.
  CreateSharedCacheInfoLLDBsVirtualMemory();
}
 
struct segment {
  std::string name;
  uint64_t vmaddr;
  size_t vmsize;
 
  // Mapped into lldb's own address space via libdispatch:
  const void *data;
  size_t size;
};
 
static DataExtractorSP map_shared_cache_binary_segments(void *image) {
  // dyld_image_segment_data_4HWTrace can't be called on
  // multiple threads simultaneously.
  static std::mutex g_mutex;
  std::lock_guard<std::mutex> guard(g_mutex);
 
  static dispatch_data_t (*g_dyld_image_segment_data_4HWTrace)(
      void *image, const char *segmentName);
  static std::once_flag g_once_flag;
  std::call_once(g_once_flag, [&]() {
    g_dyld_image_segment_data_4HWTrace =
        (dispatch_data_t(*)(void *, const char *))dlsym(
            RTLD_DEFAULT, "dyld_image_segment_data_4HWTrace");
  });
  if (!g_dyld_image_segment_data_4HWTrace)
    return {};
 
  __block std::vector<segment> segments;
  __block dyld_image_t image_copy = (dyld_image_t)image;
  dyld_image_for_each_segment_info(
      (dyld_image_t)image,
      ^(const char *segmentName, uint64_t vmAddr, uint64_t vmSize, int perm) {
        segment seg;
        seg.name = segmentName;
        seg.vmaddr = vmAddr;
        seg.vmsize = vmSize;
 
        dispatch_data_t data_from_libdyld =
            g_dyld_image_segment_data_4HWTrace(image_copy, segmentName);
        (void)dispatch_data_create_map(data_from_libdyld, &seg.data, &seg.size);
 
        if (seg.size > 0 && seg.data != 0)
          segments.push_back(seg);
      });
 
  if (!segments.size())
    return {};
 
  Log *log = GetLog(LLDBLog::Modules);
  LLDB_LOGF(log,
            "map_shared_cache_binary_segments() mapping segments of "
            "dyld_image_t %p into lldb address space",
            image);
  bool log_verbosely = log && log->GetVerbose();
  for (const segment &seg : segments) {
    if (log_verbosely)
      LLDB_LOGF(
          log,
          "image %p %s vmaddr 0x%llx vmsize 0x%zx mapped to lldb vm addr %p",
          image, seg.name.c_str(), seg.vmaddr, seg.vmsize, seg.data);
  }
 
  // Calculate the virtual address range in lldb's
  // address space (lowest memory address to highest) so
  // we can contain the entire range in an unowned data buffer.
  uint64_t min_lldb_vm_addr = UINT64_MAX;
  uint64_t max_lldb_vm_addr = 0;
  // Calculate the minimum shared cache address seen; we want the first
  // segment, __TEXT, at "vm offset" 0 in our DataExtractor.
  // A __DATA segment which is at the __TEXT vm addr + 0x1000 needs to be
  // listed as offset 0x1000.
  uint64_t min_file_vm_addr = UINT64_MAX;
  for (const segment &seg : segments) {
    min_lldb_vm_addr = std::min(min_lldb_vm_addr, (uint64_t)seg.data);
    max_lldb_vm_addr =
        std::max(max_lldb_vm_addr, (uint64_t)seg.data + seg.vmsize);
    min_file_vm_addr = std::min(min_file_vm_addr, (uint64_t)seg.vmaddr);
  }
  DataBufferSP data_sp = std::make_shared<DataBufferUnowned>(
      (uint8_t *)min_lldb_vm_addr, max_lldb_vm_addr - min_lldb_vm_addr);
  VirtualDataExtractor::LookupTable remap_table;
  for (const segment &seg : segments)
    remap_table.Append(VirtualDataExtractor::LookupTable::Entry(
        (uint64_t)seg.vmaddr - min_file_vm_addr, (uint64_t)seg.vmsize,
        (uint64_t)seg.data - (uint64_t)min_lldb_vm_addr));
 
  return std::make_shared<VirtualDataExtractor>(data_sp, remap_table);
}
 
// Scan the binaries in the specified shared cache filepath
// if the UUID matches, using the macOS 26.4 libdyld SPI,
// create a new entry in m_caches.
bool SharedCacheInfo::CreateSharedCacheImageList(UUID sc_uuid,
                                                 std::string filepath) {
  llvm::sys::ScopedWriter guard(m_mutex);
  if (!m_dyld_image_retain_4HWTrace || !m_dyld_image_release_4HWTrace ||
      !m_dyld_image_segment_data_4HWTrace)
    return false;
 
  if (filepath.empty())
    return false;
 
  Log *log = GetLog(LLDBLog::Modules);
 
  // Have we already indexed this shared cache.
  if (m_file_infos.contains(sc_uuid)) {
    LLDB_LOGF(log, "Have already indexed shared cache UUID %s",
              sc_uuid.GetAsString().c_str());
    return true;
  }
 
  LLDB_LOGF(log, "Opening shared cache at %s to check for matching UUID %s",
            filepath.c_str(), sc_uuid.GetAsString().c_str());
 
  __block bool return_failed = false;
  dyld_shared_cache_for_file(filepath.c_str(), ^(dyld_shared_cache_t cache) {
    uuid_t uuid;
    dyld_shared_cache_copy_uuid(cache, &uuid);
    UUID this_cache(uuid, sizeof(uuid_t));
    if (this_cache != sc_uuid) {
      return_failed = true;
      return;
    }
 
    // In macOS 26, a shared cache has around 3500 files.
    m_file_infos[sc_uuid].reserve(4000);
 
    dyld_shared_cache_for_each_image(cache, ^(dyld_image_t image) {
      uuid_t uuid_tmp;
      if (!dyld_image_copy_uuid(image, &uuid_tmp))
        return;
      UUID image_uuid(uuid_tmp, sizeof(uuid_t));
 
      // Copy the filename into the const string pool to
      // ensure lifetime.
      ConstString installname(dyld_image_get_installname(image));
      Log *log = GetLog(LLDBLog::Modules);
      if (log && log->GetVerbose())
        LLDB_LOGF(log, "sc file %s image %p", installname.GetCString(),
                  (void *)image);
 
      m_dyld_image_retain_4HWTrace(image);
      m_file_infos[sc_uuid].push_back(SharedCacheImageInfo(
          installname, image_uuid, map_shared_cache_binary_segments, image));
    });
  });
  if (return_failed)
    return false;
 
  // Vector of SharedCacheImageInfos has been fully populated, we can
  // take pointers to the objects now.
  size_t file_info_size = m_file_infos[sc_uuid].size();
  for (size_t i = 0; i < file_info_size; i++) {
    SharedCacheImageInfo *entry = &m_file_infos[sc_uuid][i];
    m_filename_map[sc_uuid][entry->GetFilename()] = i;
    m_uuid_map[sc_uuid][entry->GetUUID()] = i;
  }
 
  return true;
}
 
// Get the filename and uuid of lldb's own shared cache, scan
// the files in it using the macOS 26.4 and newer libdyld SPI.
bool SharedCacheInfo::CreateHostSharedCacheImageList() {
  std::string host_shared_cache_file = dyld_shared_cache_file_path();
  __block UUID host_sc_uuid;
  dyld_shared_cache_for_file(host_shared_cache_file.c_str(),
                             ^(dyld_shared_cache_t cache) {
                               uuid_t sc_uuid;
                               dyld_shared_cache_copy_uuid(cache, &sc_uuid);
                               host_sc_uuid = UUID(sc_uuid, sizeof(uuid_t));
                             });
 
  if (host_sc_uuid.IsValid())
    return CreateSharedCacheImageList(host_sc_uuid, host_shared_cache_file);
 
  return false;
}
 
// Index the binaries in lldb's own shared cache memory, using
// libdyld SPI present on macOS 12 and newer, when building against
// the internal SDK, and add an entry to the m_caches map.
bool SharedCacheInfo::CreateSharedCacheInfoWithInstrospectionSPIs() {
  llvm::sys::ScopedWriter guard(m_mutex);
#if defined(SDK_HAS_NEW_DYLD_INTROSPECTION_SPIS)
  dyld_process_t dyld_process = dyld_process_create_for_current_task();
  if (!dyld_process)
    return false;
 
  llvm::scope_exit cleanup_process_on_exit(
      [&]() { dyld_process_dispose(dyld_process); });
 
  dyld_process_snapshot_t snapshot =
      dyld_process_snapshot_create_for_process(dyld_process, nullptr);
  if (!snapshot)
    return false;
 
  llvm::scope_exit cleanup_snapshot_on_exit(
      [&]() { dyld_process_snapshot_dispose(snapshot); });
 
  dyld_shared_cache_t shared_cache =
      dyld_process_snapshot_get_shared_cache(snapshot);
  if (!shared_cache)
    return false;
 
  // In macOS 26, a shared cache has around 3500 files.
  m_file_infos[m_host_uuid].reserve(4000);
 
  dyld_shared_cache_for_each_image(shared_cache, ^(dyld_image_t image) {
    __block uint64_t minVmAddr = UINT64_MAX;
    __block uint64_t maxVmAddr = 0;
    uuid_t uuidStore;
    __block uuid_t *uuid = &uuidStore;
 
    dyld_image_for_each_segment_info(
        image,
        ^(const char *segmentName, uint64_t vmAddr, uint64_t vmSize, int perm) {
          minVmAddr = std::min(minVmAddr, vmAddr);
          maxVmAddr = std::max(maxVmAddr, vmAddr + vmSize);
          dyld_image_copy_uuid(image, uuid);
        });
    assert(minVmAddr != UINT_MAX);
    assert(maxVmAddr != 0);
    lldb::DataBufferSP data_sp = std::make_shared<DataBufferUnowned>(
        (uint8_t *)minVmAddr, maxVmAddr - minVmAddr);
    lldb::DataExtractorSP extractor_sp = std::make_shared<DataExtractor>(data_sp);
    // Copy the filename into the const string pool to
    // ensure lifetime.
    ConstString installname(dyld_image_get_installname(image));
    m_file_infos[m_host_uuid].push_back(
        SharedCacheImageInfo(installname, UUID(uuid, 16), extractor_sp));
  });
 
  // std::vector of SharedCacheImageInfos has been fully populated, we can
  // take pointers to the objects now.
  size_t file_info_size = m_file_infos[m_host_uuid].size();
  for (size_t i = 0; i < file_info_size; i++) {
    SharedCacheImageInfo *entry = &m_file_infos[m_host_uuid][i];
    m_filename_map[m_host_uuid][entry->GetFilename()] = i;
    m_uuid_map[m_host_uuid][entry->GetUUID()] = i;
  }
  return true;
#endif
  return false;
}
 
// Index the binaries in lldb's own shared cache memory using
// libdyld SPI available on macOS 10.13 or newer, add an entry to
// m_caches.
void SharedCacheInfo::CreateSharedCacheInfoLLDBsVirtualMemory() {
  llvm::sys::ScopedWriter guard(m_mutex);
  size_t shared_cache_size;
  uint8_t *shared_cache_start =
      _dyld_get_shared_cache_range(&shared_cache_size);
 
  // In macOS 26, a shared cache has around 3500 files.
  m_file_infos[m_host_uuid].reserve(4000);
 
  dyld_shared_cache_iterate_text(
      m_host_uuid.GetBytes().data(),
      ^(const dyld_shared_cache_dylib_text_info *info) {
        lldb::DataBufferSP buffer_sp = std::make_shared<DataBufferUnowned>(
            shared_cache_start + info->textSegmentOffset,
            shared_cache_size - info->textSegmentOffset);
        lldb::DataExtractorSP extractor_sp =
            std::make_shared<DataExtractor>(buffer_sp);
        ConstString filepath(info->path);
        m_file_infos[m_host_uuid].push_back(SharedCacheImageInfo(
            filepath, UUID(info->dylibUuid, 16), extractor_sp));
      });
 
  // std::vector of SharedCacheImageInfos has been fully populated, we can
  // take pointers to the objects now.
  size_t file_info_size = m_file_infos[m_host_uuid].size();
  for (size_t i = 0; i < file_info_size; i++) {
    SharedCacheImageInfo *entry = &m_file_infos[m_host_uuid][i];
    m_filename_map[m_host_uuid][entry->GetFilename()] = i;
    m_uuid_map[m_host_uuid][entry->GetUUID()] = i;
  }
}
 
SharedCacheInfo &GetSharedCacheSingleton(SymbolSharedCacheUse sc_mode) {
  static SharedCacheInfo g_shared_cache_info(sc_mode);
  return g_shared_cache_info;
}
 
SharedCacheImageInfo
HostInfoMacOSX::GetSharedCacheImageInfo(ConstString filepath,
                                        SymbolSharedCacheUse sc_mode) {
  return GetSharedCacheSingleton(sc_mode).GetByFilename(UUID(), filepath);
}
 
SharedCacheImageInfo
HostInfoMacOSX::GetSharedCacheImageInfo(const UUID &file_uuid,
                                        SymbolSharedCacheUse sc_mode) {
  return GetSharedCacheSingleton(sc_mode).GetByUUID(UUID(), file_uuid);
}
 
SharedCacheImageInfo HostInfoMacOSX::GetSharedCacheImageInfo(
    ConstString filepath, const UUID &sc_uuid, SymbolSharedCacheUse sc_mode) {
  return GetSharedCacheSingleton(sc_mode).GetByFilename(sc_uuid, filepath);
}
 
SharedCacheImageInfo HostInfoMacOSX::GetSharedCacheImageInfo(
    const UUID &file_uuid, const UUID &sc_uuid, SymbolSharedCacheUse sc_mode) {
  return GetSharedCacheSingleton(sc_mode).GetByUUID(sc_uuid, file_uuid);
}
 
bool HostInfoMacOSX::SharedCacheIndexFiles(FileSpec &filepath, UUID &uuid,
                                           SymbolSharedCacheUse sc_mode) {
  if (sc_mode == eSymbolSharedCacheUseHostLLDBMemory)
    return false;
 
  // There is a libdyld SPI to iterate over all installed shared caches,
  // but it can have performance problems if an older Simulator SDK shared
  // cache is installed.  So require that we are given a filepath of
  // the shared cache.
  if (FileSystem::Instance().Exists(filepath))
    return GetSharedCacheSingleton(sc_mode).CreateSharedCacheImageList(
        uuid, filepath.GetPath());
  return false;
}