Host.mm

Go to the documentation of this file.

//===-- Host.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/Host.h"
#include "PosixSpawnResponsible.h"
 
#include <AvailabilityMacros.h>
#include <TargetConditionals.h>
 
#if TARGET_OS_OSX
#define __XPC_PRIVATE_H__
#include <xpc/xpc.h>
 
#define LaunchUsingXPCRightName "com.apple.lldb.RootDebuggingXPCService"
 
// These XPC messaging keys are used for communication between Host.mm and the
// XPC service.
#define LauncherXPCServiceAuthKey "auth-key"
#define LauncherXPCServiceArgPrefxKey "arg"
#define LauncherXPCServiceEnvPrefxKey "env"
#define LauncherXPCServiceCPUTypeKey "cpuType"
#define LauncherXPCServicePosixspawnFlagsKey "posixspawnFlags"
#define LauncherXPCServiceStdInPathKeyKey "stdInPath"
#define LauncherXPCServiceStdOutPathKeyKey "stdOutPath"
#define LauncherXPCServiceStdErrPathKeyKey "stdErrPath"
#define LauncherXPCServiceChildPIDKey "childPID"
#define LauncherXPCServiceErrorTypeKey "errorType"
#define LauncherXPCServiceCodeTypeKey "errorCode"
 
#include <bsm/audit.h>
#include <bsm/audit_session.h>
#endif
 
#include "llvm/TargetParser/Host.h"
 
#include <asl.h>
#include <cassert>
#include <cerrno>
#include <crt_externs.h>
#include <cstdio>
#include <cstdlib>
#include <dlfcn.h>
#include <grp.h>
#include <libproc.h>
#include <pwd.h>
#include <spawn.h>
#include <sys/proc.h>
#include <sys/stat.h>
#include <sys/sysctl.h>
#include <sys/types.h>
#include <unistd.h>
 
#include "lldb/Host/ConnectionFileDescriptor.h"
#include "lldb/Host/FileSystem.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Host/ProcessLaunchInfo.h"
#include "lldb/Host/ThreadLauncher.h"
#include "lldb/Utility/ArchSpec.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "lldb/Utility/DataExtractor.h"
#include "lldb/Utility/Endian.h"
#include "lldb/Utility/FileSpec.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/NameMatches.h"
#include "lldb/Utility/ProcessInfo.h"
#include "lldb/Utility/StreamString.h"
#include "lldb/Utility/StructuredData.h"
#include "lldb/lldb-defines.h"
 
#include "llvm/ADT/ScopeExit.h"
#include "llvm/Support/Errno.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/ErrorExtras.h"
#include "llvm/Support/FileSystem.h"
 
#include "../cfcpp/CFCBundle.h"
#include "../cfcpp/CFCMutableArray.h"
#include "../cfcpp/CFCMutableDictionary.h"
#include "../cfcpp/CFCReleaser.h"
#include "../cfcpp/CFCString.h"
 
#include <objc/objc-auto.h>
#include <os/log.h>
 
#include <CoreFoundation/CoreFoundation.h>
#include <Foundation/Foundation.h>
 
#ifndef _POSIX_SPAWN_DISABLE_ASLR
#define _POSIX_SPAWN_DISABLE_ASLR 0x0100
#endif
 
extern "C" {
int __pthread_chdir(const char *path);
int __pthread_fchdir(int fildes);
}
 
using namespace lldb;
using namespace lldb_private;
 
static os_log_t g_os_log;
static std::once_flag g_os_log_once;
 
void Host::SystemLog(Severity severity, llvm::StringRef message) {
  if (__builtin_available(macos 10.12, iOS 10, tvOS 10, watchOS 3, *)) {
    std::call_once(g_os_log_once, []() {
      g_os_log = os_log_create("com.apple.dt.lldb", "lldb");
    });
    switch (severity) {
    case lldb::eSeverityInfo:
    case lldb::eSeverityWarning:
      os_log(g_os_log, "%{public}s", message.str().c_str());
      break;
    case lldb::eSeverityError:
      os_log_error(g_os_log, "%{public}s", message.str().c_str());
      break;
    }
  } else {
    llvm::errs() << message;
  }
}
 
bool Host::GetBundleDirectory(const FileSpec &file,
                              FileSpec &bundle_directory) {
#if defined(__APPLE__)
  if (FileSystem::Instance().IsDirectory(file)) {
    char path[PATH_MAX];
    if (file.GetPath(path, sizeof(path))) {
      CFCBundle bundle(path);
      if (bundle.GetPath(path, sizeof(path))) {
        bundle_directory.SetFile(path, FileSpec::Style::native);
        return true;
      }
    }
  }
#endif
  bundle_directory.Clear();
  return false;
}
 
bool Host::ResolveExecutableInBundle(FileSpec &file) {
#if defined(__APPLE__)
  if (FileSystem::Instance().IsDirectory(file)) {
    char path[PATH_MAX];
    if (file.GetPath(path, sizeof(path))) {
      CFCBundle bundle(path);
      CFCReleaser<CFURLRef> url(bundle.CopyExecutableURL());
      if (url.get()) {
        if (::CFURLGetFileSystemRepresentation(url.get(), YES, (UInt8 *)path,
                                               sizeof(path))) {
          file.SetFile(path, FileSpec::Style::native);
          return true;
        }
      }
    }
  }
#endif
  return false;
}
 
#if TARGET_OS_OSX
 
static void *AcceptPIDFromInferior(const char *connect_url) {
  ConnectionFileDescriptor file_conn;
  Status error;
  if (file_conn.Connect(connect_url, &error) == eConnectionStatusSuccess) {
    char pid_str[256];
    ::memset(pid_str, 0, sizeof(pid_str));
    ConnectionStatus status;
    const size_t pid_str_len = file_conn.Read(
        pid_str, sizeof(pid_str), std::chrono::seconds(0), status, NULL);
    if (pid_str_len > 0) {
      int pid = atoi(pid_str);
      return (void *)(intptr_t)pid;
    }
  }
  return NULL;
}
 
const char *applscript_in_new_tty = "tell application \"Terminal\"\n"
                                    "   activate\n"
                                    " do script \"/bin/bash -c '%s';exit\"\n"
                                    "end tell\n";
 
const char *applscript_in_existing_tty = "\
set the_shell_script to \"/bin/bash -c '%s';exit\"\n\
tell application \"Terminal\"\n\
  repeat with the_window in (get windows)\n\
    repeat with the_tab in tabs of the_window\n\
      set the_tty to tty in the_tab\n\
      if the_tty contains \"%s\" then\n\
        if the_tab is not busy then\n\
          set selected of the_tab to true\n\
          set frontmost of the_window to true\n\
          do script the_shell_script in the_tab\n\
          return\n\
        end if\n\
      end if\n\
    end repeat\n\
  end repeat\n\
  do script the_shell_script\n\
end tell\n";
 
static Status
LaunchInNewTerminalWithAppleScript(const char *exe_path,
                                   ProcessLaunchInfo &launch_info) {
  Status error;
  char unix_socket_name[PATH_MAX] = "/tmp/XXXXXX";
  if (::mktemp(unix_socket_name) == NULL) {
    error = Status::FromErrorString(
        "failed to make temporary path for a unix socket");
    return error;
  }
 
  StreamString command;
  FileSpec darwin_debug_file_spec = HostInfo::GetSupportExeDir();
  if (!darwin_debug_file_spec) {
    error =
        Status::FromErrorString("can't locate the 'darwin-debug' executable");
    return error;
  }
 
  darwin_debug_file_spec.SetFilename("darwin-debug");
 
  if (!FileSystem::Instance().Exists(darwin_debug_file_spec)) {
    error = Status::FromErrorStringWithFormat(
        "the 'darwin-debug' executable doesn't exists at '%s'",
        darwin_debug_file_spec.GetPath().c_str());
    return error;
  }
 
  char launcher_path[PATH_MAX];
  darwin_debug_file_spec.GetPath(launcher_path, sizeof(launcher_path));
 
  const ArchSpec &arch_spec = launch_info.GetArchitecture();
  // Only set the architecture if it is valid and if it isn't Haswell (x86_64h).
  if (arch_spec.IsValid() &&
      arch_spec.GetCore() != ArchSpec::eCore_x86_64_x86_64h)
    command.Printf("arch -arch %s ", arch_spec.GetArchitectureName());
 
  command.Printf(R"(\"%s\" --unix-socket=%s)", launcher_path, unix_socket_name);
 
  if (arch_spec.IsValid())
    command.Printf(" --arch=%s", arch_spec.GetArchitectureName());
 
  FileSpec working_dir{launch_info.GetWorkingDirectory()};
  if (working_dir)
    command.Printf(R"( --working-dir \"%s\")", working_dir.GetPath().c_str());
  else {
    char cwd[PATH_MAX];
    if (getcwd(cwd, PATH_MAX))
      command.Printf(R"( --working-dir \"%s\")", cwd);
  }
 
  if (launch_info.GetFlags().Test(eLaunchFlagDisableASLR))
    command.PutCString(" --disable-aslr");
 
  // We are launching on this host in a terminal. So compare the environment on
  // the host to what is supplied in the launch_info. Any items that aren't in
  // the host environment need to be sent to darwin-debug. If we send all
  // environment entries, we might blow the max command line length, so we only
  // send user modified entries.
  Environment host_env = Host::GetEnvironment();
 
  for (const auto &KV : launch_info.GetEnvironment()) {
    auto host_entry = host_env.find(KV.first());
    if (host_entry == host_env.end() || host_entry->second != KV.second)
      command.Format(R"( --env=\"{0}\")", Environment::compose(KV));
  }
 
  command.PutCString(" -- ");
 
  const char **argv = launch_info.GetArguments().GetConstArgumentVector();
  if (argv) {
    for (size_t i = 0; argv[i] != NULL; ++i) {
      if (i == 0)
        command.Printf(R"( \"%s\")", exe_path);
      else
        command.Printf(R"( \"%s\")", argv[i]);
    }
  } else {
    command.Printf(R"( \"%s\")", exe_path);
  }
  command.PutCString(" ; echo Process exited with status $?");
  if (launch_info.GetFlags().Test(lldb::eLaunchFlagCloseTTYOnExit))
    command.PutCString(" ; exit");
 
  StreamString applescript_source;
 
  applescript_source.Printf(applscript_in_new_tty,
                            command.GetString().str().c_str());
 
  NSAppleScript *applescript = [[NSAppleScript alloc]
      initWithSource:[NSString stringWithCString:applescript_source.GetString()
                                                     .str()
                                                     .c_str()
                                        encoding:NSUTF8StringEncoding]];
 
  lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
 
  Status lldb_error;
  // Sleep and wait a bit for debugserver to start to listen...
  ConnectionFileDescriptor file_conn;
  char connect_url[128];
  ::snprintf(connect_url, sizeof(connect_url), "unix-accept://%s",
             unix_socket_name);
 
  // Spawn a new thread to accept incoming connection on the connect_url
  // so we can grab the pid from the inferior. We have to do this because we
  // are sending an AppleScript that will launch a process in Terminal.app,
  // in a shell and the shell will fork/exec a couple of times before we get
  // to the process that we wanted to launch. So when our process actually
  // gets launched, we will handshake with it and get the process ID for it.
  llvm::Expected<HostThread> accept_thread = ThreadLauncher::LaunchThread(
      unix_socket_name, [&] { return AcceptPIDFromInferior(connect_url); });
 
  if (!accept_thread)
    return Status::FromError(accept_thread.takeError());
 
  [applescript executeAndReturnError:nil];
 
  thread_result_t accept_thread_result = NULL;
  lldb_error = accept_thread->Join(&accept_thread_result);
  if (lldb_error.Success() && accept_thread_result) {
    pid = (intptr_t)accept_thread_result;
  }
 
  llvm::sys::fs::remove(unix_socket_name);
  [applescript release];
  if (pid != LLDB_INVALID_PROCESS_ID)
    launch_info.SetProcessID(pid);
  return error;
}
 
#endif // TARGET_OS_OSX
 
llvm::Error Host::OpenFileInExternalEditor(llvm::StringRef editor,
                                           const FileSpec &file_spec,
                                           uint32_t line_no) {
#if !TARGET_OS_OSX
  return llvm::errorCodeToError(
      std::error_code(ENOTSUP, std::system_category()));
#else // !TARGET_OS_OSX
  Log *log = GetLog(LLDBLog::Host);
 
  const std::string file_path = file_spec.GetPath();
 
  LLDB_LOG(log, "Sending {0}:{1} to external editor",
           file_path.empty() ? "<invalid>" : file_path, line_no);
 
  if (file_path.empty())
    return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                   "no file specified");
 
  CFCString file_cfstr(file_path.c_str(), kCFStringEncodingUTF8);
  CFCReleaser<CFURLRef> file_URL = ::CFURLCreateWithFileSystemPath(
      /*allocator=*/NULL,
      /*filePath*/ file_cfstr.get(),
      /*pathStyle=*/kCFURLPOSIXPathStyle,
      /*isDirectory=*/false);
 
  if (!file_URL.get())
    return llvm::createStringError(
        llvm::inconvertibleErrorCode(),
        llvm::formatv("could not create CFURL from path \"{0}\"", file_path));
 
  // Create a new Apple Event descriptor.
  typedef struct {
    int16_t reserved0; // must be zero
    int16_t fLineNumber;
    int32_t fSelStart;
    int32_t fSelEnd;
    uint32_t reserved1; // must be zero
    uint32_t reserved2; // must be zero
  } BabelAESelInfo;
 
  // We attach this to an 'odoc' event to specify a particular selection.
  BabelAESelInfo file_and_line_info = {
      0,                      // reserved0
      (int16_t)(line_no - 1), // fLineNumber (zero based line number)
      1,                      // fSelStart
      1024,                   // fSelEnd
      0,                      // reserved1
      0                       // reserved2
  };
 
  AEKeyDesc file_and_line_desc;
  file_and_line_desc.descKey = keyAEPosition;
  long error = ::AECreateDesc(/*typeCode=*/typeUTF8Text,
                              /*dataPtr=*/&file_and_line_info,
                              /*dataSize=*/sizeof(file_and_line_info),
                              /*result=*/&(file_and_line_desc.descContent));
 
  if (error != noErr)
    return llvm::createStringError(
        llvm::inconvertibleErrorCode(),
        llvm::formatv("creating Apple Event descriptor failed: error {0}",
                      error));
 
  // Deallocate the descriptor on exit.
  llvm::scope_exit on_exit(
      [&]() { AEDisposeDesc(&(file_and_line_desc.descContent)); });
 
  if (editor.empty()) {
    if (const char *lldb_external_editor = ::getenv("LLDB_EXTERNAL_EDITOR"))
      editor = lldb_external_editor;
  }
 
  std::optional<FSRef> app_fsref;
  if (!editor.empty()) {
    LLDB_LOG(log, "Looking for external editor: {0}", editor);
 
    app_fsref.emplace();
    CFCString editor_name(editor.data(), kCFStringEncodingUTF8);
    long app_error = ::LSFindApplicationForInfo(
        /*inCreator=*/kLSUnknownCreator, /*inBundleID=*/NULL,
        /*inName=*/editor_name.get(), /*outAppRef=*/&(*app_fsref),
        /*outAppURL=*/NULL);
    if (app_error != noErr)
      return llvm::createStringError(
          llvm::inconvertibleErrorCode(),
          llvm::formatv("could not find external editor \"{0}\": "
                        "LSFindApplicationForInfo returned error {1}",
                        editor, app_error));
  }
 
  // Build app launch parameters.
  LSApplicationParameters app_params;
  ::memset(&app_params, 0, sizeof(app_params));
  app_params.flags =
      kLSLaunchDefaults | kLSLaunchDontAddToRecents | kLSLaunchDontSwitch;
  if (app_fsref)
    app_params.application = &(*app_fsref);
 
  ProcessSerialNumber psn;
  std::array<CFURLRef, 1> file_array = {file_URL.get()};
  CFCReleaser<CFArrayRef> cf_array(
      CFArrayCreate(/*allocator=*/NULL, /*values=*/(const void **)&file_array,
                    /*numValues*/ 1, /*callBacks=*/NULL));
  error = ::LSOpenURLsWithRole(
      /*inURLs=*/cf_array.get(), /*inRole=*/kLSRolesEditor,
      /*inAEParam=*/&file_and_line_desc,
      /*inAppParams=*/&app_params, /*outPSNs=*/&psn, /*inMaxPSNCount=*/1);
 
  if (error != noErr)
    return llvm::createStringError(
        llvm::inconvertibleErrorCode(),
        llvm::formatv("LSOpenURLsWithRole failed: error {0}", error));
 
  return llvm::Error::success();
#endif // TARGET_OS_OSX
}
 
llvm::Error Host::OpenURL(llvm::StringRef url) {
#if !TARGET_OS_OSX
  return llvm::errorCodeToError(
      std::error_code(ENOTSUP, std::system_category()));
#else  // !TARGET_OS_OSX
  if (url.empty())
    return llvm::createStringError("cannot open empty URL");
 
  LLDB_LOG(GetLog(LLDBLog::Host), "Opening URL: {0}", url);
 
  CFCString url_cfstr(url.data(), kCFStringEncodingUTF8);
  CFCReleaser<CFURLRef> cfurl = ::CFURLCreateWithString(
      /*allocator=*/NULL,
      /*URLString*/ url_cfstr.get(),
      /*baseURL=*/NULL);
 
  if (!cfurl.get())
    return llvm::createStringError(
        llvm::formatv("could not create CFURL from URL \"{0}\"", url));
 
  OSStatus error = ::LSOpenCFURLRef(
      /*inURL=*/cfurl.get(),
      /*outLaunchedURL=*/NULL);
 
  if (error != noErr)
    return llvm::createStringError(
        llvm::formatv("LSOpenCFURLRef failed: error {0:x}", error));
 
  return llvm::Error::success();
#endif // TARGET_OS_OSX
}
 
bool Host::IsInteractiveGraphicSession() {
#if !TARGET_OS_OSX
  return false;
#else
  auditinfo_addr_t info;
  getaudit_addr(&info, sizeof(info));
  return info.ai_flags & AU_SESSION_FLAG_HAS_GRAPHIC_ACCESS;
#endif
}
 
Environment Host::GetEnvironment() { return Environment(*_NSGetEnviron()); }
 
static bool GetMacOSXProcessCPUType(ProcessInstanceInfo &process_info) {
  if (process_info.ProcessIDIsValid()) {
    // Make a new mib to stay thread safe
    int mib[CTL_MAXNAME] = {
        0,
    };
    size_t mib_len = CTL_MAXNAME;
    if (::sysctlnametomib("sysctl.proc_cputype", mib, &mib_len))
      return false;
 
    mib[mib_len] = process_info.GetProcessID();
    mib_len++;
 
    cpu_type_t cpu, sub = 0;
    size_t len = sizeof(cpu);
    if (::sysctl(mib, mib_len, &cpu, &len, 0, 0) == 0) {
      switch (cpu) {
      case CPU_TYPE_I386:
        sub = CPU_SUBTYPE_I386_ALL;
        break;
      case CPU_TYPE_X86_64:
        sub = CPU_SUBTYPE_X86_64_ALL;
        break;
 
#if defined(CPU_TYPE_ARM64) && defined(CPU_SUBTYPE_ARM64_ALL)
      case CPU_TYPE_ARM64:
        sub = CPU_SUBTYPE_ARM64_ALL;
        break;
#endif
 
#if defined(CPU_TYPE_ARM64_32) && defined(CPU_SUBTYPE_ARM64_32_ALL)
      case CPU_TYPE_ARM64_32:
        sub = CPU_SUBTYPE_ARM64_32_ALL;
        break;
#endif
 
      case CPU_TYPE_ARM: {
        // Note that we fetched the cpu type from the PROCESS but we can't get a
        // cpusubtype of the
        // process -- we can only get the host's cpu subtype.
        uint32_t cpusubtype = 0;
        len = sizeof(cpusubtype);
        if (::sysctlbyname("hw.cpusubtype", &cpusubtype, &len, NULL, 0) == 0)
          sub = cpusubtype;
 
        bool host_cpu_is_64bit;
        uint32_t is64bit_capable;
        size_t is64bit_capable_len = sizeof(is64bit_capable);
        host_cpu_is_64bit =
            sysctlbyname("hw.cpu64bit_capable", &is64bit_capable,
                         &is64bit_capable_len, NULL, 0) == 0;
 
        // if the host is an armv8 device, its cpusubtype will be in
        // CPU_SUBTYPE_ARM64 numbering
        // and we need to rewrite it to a reasonable CPU_SUBTYPE_ARM value
        // instead.
 
        if (host_cpu_is_64bit) {
          sub = CPU_SUBTYPE_ARM_V7;
        }
      } break;
 
      default:
        break;
      }
      process_info.GetArchitecture().SetArchitecture(eArchTypeMachO, cpu, sub);
      return true;
    }
  }
  process_info.GetArchitecture().Clear();
  return false;
}
 
static bool GetMacOSXProcessArgs(const ProcessInstanceInfoMatch *match_info_ptr,
                                 ProcessInstanceInfo &process_info) {
  if (process_info.ProcessIDIsValid()) {
    int proc_args_mib[3] = {CTL_KERN, KERN_PROCARGS2,
                            (int)process_info.GetProcessID()};
 
    size_t arg_data_size = 0;
    if (::sysctl(proc_args_mib, 3, nullptr, &arg_data_size, NULL, 0) ||
        arg_data_size == 0)
      arg_data_size = 8192;
 
    // Add a few bytes to the calculated length, I know we need to add at least
    // one byte
    // to this number otherwise we get junk back, so add 128 just in case...
    DataBufferHeap arg_data(arg_data_size + 128, 0);
    arg_data_size = arg_data.GetByteSize();
    if (::sysctl(proc_args_mib, 3, arg_data.GetBytes(), &arg_data_size, NULL,
                 0) == 0) {
      DataExtractor data(arg_data.GetBytes(), arg_data_size,
                         endian::InlHostByteOrder(), sizeof(void *));
      lldb::offset_t offset = 0;
      uint32_t argc = data.GetU32(&offset);
      llvm::Triple &triple = process_info.GetArchitecture().GetTriple();
      const llvm::Triple::ArchType triple_arch = triple.getArch();
      const bool check_for_ios_simulator =
          (triple_arch == llvm::Triple::x86 ||
           triple_arch == llvm::Triple::x86_64 ||
           triple_arch == llvm::Triple::aarch64);
 
      const char *cstr = data.GetCStr(&offset);
      if (cstr) {
        process_info.GetExecutableFile().SetFile(cstr, FileSpec::Style::native);
 
        if (match_info_ptr == NULL ||
            NameMatches(
                process_info.GetExecutableFile().GetFilename().GetCString(),
                match_info_ptr->GetNameMatchType(),
                match_info_ptr->GetProcessInfo().GetName())) {
          // Skip NULLs
          while (true) {
            const uint8_t *p = data.PeekData(offset, 1);
            if ((p == NULL) || (*p != '\0'))
              break;
            ++offset;
          }
 
          // Skip argv[0] as we already have the file name from the executable path.
          if (argc > 0)
            process_info.SetArg0(data.GetCStr(&offset));
 
          // Now extract the rest of the arguments.
          Args &proc_args = process_info.GetArguments();
          for (int i = 1; i < static_cast<int>(argc); ++i) {
            cstr = data.GetCStr(&offset);
            if (cstr)
              proc_args.AppendArgument(llvm::StringRef(cstr));
          }
 
          Environment &proc_env = process_info.GetEnvironment();
          bool is_simulator = false;
          llvm::StringRef env_var;
          while (!(env_var = data.GetCStr(&offset)).empty()) {
            if (check_for_ios_simulator &&
                env_var.starts_with("SIMULATOR_UDID="))
              is_simulator = true;
            proc_env.insert(env_var);
          }
          llvm::Triple &triple = process_info.GetArchitecture().GetTriple();
          if (is_simulator) {
            triple.setOS(llvm::Triple::IOS);
            triple.setEnvironment(llvm::Triple::Simulator);
          } else {
            triple.setOS(llvm::Triple::MacOSX);
          }
          return true;
        }
      }
    }
  }
  return false;
}
 
static bool GetMacOSXProcessUserAndGroup(ProcessInstanceInfo &process_info) {
  if (process_info.ProcessIDIsValid()) {
    int mib[4];
    mib[0] = CTL_KERN;
    mib[1] = KERN_PROC;
    mib[2] = KERN_PROC_PID;
    mib[3] = process_info.GetProcessID();
    struct kinfo_proc proc_kinfo;
    size_t proc_kinfo_size = sizeof(struct kinfo_proc);
 
    if (::sysctl(mib, 4, &proc_kinfo, &proc_kinfo_size, NULL, 0) == 0) {
      if (proc_kinfo_size > 0) {
        process_info.SetParentProcessID(proc_kinfo.kp_eproc.e_ppid);
        process_info.SetUserID(proc_kinfo.kp_eproc.e_pcred.p_ruid);
        process_info.SetGroupID(proc_kinfo.kp_eproc.e_pcred.p_rgid);
        process_info.SetEffectiveUserID(proc_kinfo.kp_eproc.e_ucred.cr_uid);
        if (proc_kinfo.kp_eproc.e_ucred.cr_ngroups > 0)
          process_info.SetEffectiveGroupID(
              proc_kinfo.kp_eproc.e_ucred.cr_groups[0]);
        else
          process_info.SetEffectiveGroupID(UINT32_MAX);
        return true;
      }
    }
  }
  process_info.SetParentProcessID(LLDB_INVALID_PROCESS_ID);
  process_info.SetUserID(UINT32_MAX);
  process_info.SetGroupID(UINT32_MAX);
  process_info.SetEffectiveUserID(UINT32_MAX);
  process_info.SetEffectiveGroupID(UINT32_MAX);
  return false;
}
 
/// Fetches the list of all processes into \p kinfos.
static llvm::Error GetProcessList(std::vector<struct kinfo_proc> &kinfos) {
  int mib[3] = {CTL_KERN, KERN_PROC, KERN_PROC_ALL};
 
  // How often we retry fetching the process list.
  static constexpr unsigned g_retry_count = 200;
  // The rate at which we increase the adjusted buffer size to
  // account for newly created processes between two sysctl calls.
  static constexpr unsigned g_expected_new_pids = 500;
  // We keep increasing the expected growth rate between the two
  // sysctl calls. Check that the last attempt does not create an
  // unreasonbly large buffer. It is unlikely we run on a system where
  // 100k processes are repeatedly created between each attempted sysctl
  // pair.
  static_assert(
      g_retry_count * g_expected_new_pids <= 100'000,
      "Final retry attempt assumes an unlikely amount of new processes.");
 
  // This is an inherently racy API. We have to first query the size for our
  // buffer and then pass it back to sysctl. If more processes spawn between the
  // size query and the actual call to fetch, then sysctl returns ENOMEM.
  // We keep retrying until we get a passing result.
  for (unsigned attempt = 1; attempt < g_retry_count; ++attempt) {
    // Fetch the buffer size sysctl would return.
    size_t current_pid_size = 0;
    if (::sysctl(mib, 3, nullptr, &current_pid_size, nullptr, 0) != 0)
      return llvm::errorCodeToError(
          std::error_code(errno, std::generic_category()));
 
    // Convert the byte length result to number of elements.
    const size_t current_num_processes =
        current_pid_size / sizeof(struct kinfo_proc);
 
    // Adjust the buffer for new processes that spawned between the
    // previous and next sysctl call. We increase this growth each attempt
    // to account for systems where a lot of new processes spawn between
    // these two calls.
    const size_t expected_growth = attempt * g_expected_new_pids;
 
    // Allocate the buffer for the sysctl result.
    kinfos.resize(current_num_processes + expected_growth);
 
    // Fetch the actual process list and let sysctl adjust actual_pid_size.
    size_t actual_pid_size = kinfos.size() * sizeof(struct kinfo_proc);
    if (::sysctl(mib, 3, &kinfos[0], &actual_pid_size, nullptr, 0) == 0) {
      // Shrink the buffer to the actual number of processes returned.
      kinfos.resize(actual_pid_size / sizeof(struct kinfo_proc));
      return llvm::Error::success();
    }
 
    // Errno is set to ENOMEM if our estimated_pid_size is too small, in which
    // case we retry with a bigger buffer. Any other error is unexpected.
    if (errno != ENOMEM)
      return llvm::errorCodeToError(
          std::error_code(errno, std::generic_category()));
  }
 
  // The only way to exit the loop above is by repeatedly hitting ENOMEM. The
  // only way this can happen is if the process list somehow grew extremely
  // large between the two sysctl calls.
  assert(errno == ENOMEM &&
         "loop should only be left via the ENOMEM retry path");
  return llvm::createStringErrorV(
      "Failed to read process list: sysctl kept returning ENOMEM after {0} "
      "attempts",
      g_retry_count);
}
 
uint32_t Host::FindProcessesImpl(const ProcessInstanceInfoMatch &match_info,
                                 ProcessInstanceInfoList &process_infos) {
  std::vector<struct kinfo_proc> kinfos;
  if (llvm::Error error = GetProcessList(kinfos)) {
    LLDB_LOG_ERROR(GetLog(LLDBLog::Host | LLDBLog::Process), std::move(error),
                   "failed to read process list: {0}");
    return 0;
  }
 
  bool all_users = match_info.GetMatchAllUsers();
  const lldb::pid_t our_pid = getpid();
  const uid_t our_uid = getuid();
  for (const struct kinfo_proc &kinfo : kinfos) {
    bool kinfo_user_matches = false;
    if (all_users)
      kinfo_user_matches = true;
    else
      kinfo_user_matches = kinfo.kp_eproc.e_pcred.p_ruid == our_uid;
 
    // Special case, if lldb is being run as root we can attach to anything.
    if (our_uid == 0)
      kinfo_user_matches = true;
 
    if (!kinfo_user_matches || // Make sure the user is acceptable
        static_cast<lldb::pid_t>(kinfo.kp_proc.p_pid) ==
            our_pid ||                   // Skip this process
        kinfo.kp_proc.p_pid == 0 ||      // Skip kernel (kernel pid is zero)
        kinfo.kp_proc.p_stat == SZOMB || // Zombies are bad, they like brains...
        kinfo.kp_proc.p_flag & P_TRACED ||   // Being debugged?
        kinfo.kp_proc.p_flag & P_WEXIT)
      continue;
 
    ProcessInstanceInfo process_info;
    process_info.SetProcessID(kinfo.kp_proc.p_pid);
    process_info.SetParentProcessID(kinfo.kp_eproc.e_ppid);
    process_info.SetUserID(kinfo.kp_eproc.e_pcred.p_ruid);
    process_info.SetGroupID(kinfo.kp_eproc.e_pcred.p_rgid);
    process_info.SetEffectiveUserID(kinfo.kp_eproc.e_ucred.cr_uid);
    if (kinfo.kp_eproc.e_ucred.cr_ngroups > 0)
      process_info.SetEffectiveGroupID(kinfo.kp_eproc.e_ucred.cr_groups[0]);
    else
      process_info.SetEffectiveGroupID(UINT32_MAX);
 
    // Make sure our info matches before we go fetch the name and cpu type
    if (!match_info.UserIDsMatch(process_info) ||
        !match_info.ProcessIDsMatch(process_info))
      continue;
 
    // Get CPU type first so we can know to look for iOS simulator if we have
    // a compatible type.
    if (GetMacOSXProcessCPUType(process_info)) {
      if (GetMacOSXProcessArgs(&match_info, process_info)) {
        if (match_info.Matches(process_info))
          process_infos.push_back(process_info);
      }
    }
  }
  return process_infos.size();
}
 
bool Host::GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &process_info) {
  process_info.SetProcessID(pid);
  bool success = false;
 
  // Get CPU type first so we can know to look for iOS simulator is we have x86
  // or x86_64
  if (GetMacOSXProcessCPUType(process_info))
    success = true;
 
  if (GetMacOSXProcessArgs(NULL, process_info))
    success = true;
 
  if (GetMacOSXProcessUserAndGroup(process_info))
    success = true;
 
  if (success)
    return true;
 
  process_info.Clear();
  return false;
}
 
#if TARGET_OS_OSX
static void PackageXPCArguments(xpc_object_t message, const char *prefix,
                                const Args &args) {
  size_t count = args.GetArgumentCount();
  char buf[50]; // long enough for 'argXXX'
  memset(buf, 0, sizeof(buf));
  snprintf(buf, sizeof(buf), "%sCount", prefix);
  xpc_dictionary_set_int64(message, buf, count);
  for (size_t i = 0; i < count; i++) {
    memset(buf, 0, sizeof(buf));
    snprintf(buf, sizeof(buf), "%s%zi", prefix, i);
    xpc_dictionary_set_string(message, buf, args.GetArgumentAtIndex(i));
  }
}
 
static void PackageXPCEnvironment(xpc_object_t message, llvm::StringRef prefix,
                                  const Environment &env) {
  xpc_dictionary_set_int64(message, (prefix + "Count").str().c_str(),
                           env.size());
  size_t i = 0;
  for (const auto &KV : env) {
    xpc_dictionary_set_string(message, (prefix + llvm::Twine(i)).str().c_str(),
                              Environment::compose(KV).c_str());
  }
}
 
/*
 A valid authorizationRef means that
    - there is the LaunchUsingXPCRightName rights in the /etc/authorization
    - we have successfully copied the rights to be send over the XPC wire
 Once obtained, it will be valid for as long as the process lives.
 */
static AuthorizationRef authorizationRef = NULL;
static Status getXPCAuthorization(ProcessLaunchInfo &launch_info) {
  Status error;
  Log *log(GetLog(LLDBLog::Host | LLDBLog::Process));
 
  if ((launch_info.GetUserID() == 0) && !authorizationRef) {
    OSStatus createStatus =
        AuthorizationCreate(NULL, kAuthorizationEmptyEnvironment,
                            kAuthorizationFlagDefaults, &authorizationRef);
    if (createStatus != errAuthorizationSuccess) {
      error = Status(1, eErrorTypeGeneric);
      error = Status::FromErrorString("Can't create authorizationRef.");
      LLDB_LOG(log, "error: {0}", error);
      return error;
    }
 
    OSStatus rightsStatus =
        AuthorizationRightGet(LaunchUsingXPCRightName, NULL);
    if (rightsStatus != errAuthorizationSuccess) {
      // No rights in the security database, Create it with the right prompt.
      CFStringRef prompt =
          CFSTR("Xcode is trying to take control of a root process.");
      CFStringRef keys[] = {CFSTR("en")};
      CFTypeRef values[] = {prompt};
      CFDictionaryRef promptDict = CFDictionaryCreate(
          kCFAllocatorDefault, (const void **)keys, (const void **)values, 1,
          &kCFCopyStringDictionaryKeyCallBacks,
          &kCFTypeDictionaryValueCallBacks);
 
      CFStringRef keys1[] = {CFSTR("class"), CFSTR("group"), CFSTR("comment"),
                             CFSTR("default-prompt"), CFSTR("shared")};
      CFTypeRef values1[] = {CFSTR("user"), CFSTR("admin"),
                             CFSTR(LaunchUsingXPCRightName), promptDict,
                             kCFBooleanFalse};
      CFDictionaryRef dict = CFDictionaryCreate(
          kCFAllocatorDefault, (const void **)keys1, (const void **)values1, 5,
          &kCFCopyStringDictionaryKeyCallBacks,
          &kCFTypeDictionaryValueCallBacks);
      rightsStatus = AuthorizationRightSet(
          authorizationRef, LaunchUsingXPCRightName, dict, NULL, NULL, NULL);
      CFRelease(promptDict);
      CFRelease(dict);
    }
 
    OSStatus copyRightStatus = errAuthorizationDenied;
    if (rightsStatus == errAuthorizationSuccess) {
      AuthorizationItem item1 = {LaunchUsingXPCRightName, 0, NULL, 0};
      AuthorizationItem items[] = {item1};
      AuthorizationRights requestedRights = {1, items};
      AuthorizationFlags authorizationFlags =
          kAuthorizationFlagInteractionAllowed | kAuthorizationFlagExtendRights;
      copyRightStatus = AuthorizationCopyRights(
          authorizationRef, &requestedRights, kAuthorizationEmptyEnvironment,
          authorizationFlags, NULL);
    }
 
    if (copyRightStatus != errAuthorizationSuccess) {
      // Eventually when the commandline supports running as root and the user
      // is not
      // logged in to the current audit session, we will need the trick in gdb
      // where
      // we ask the user to type in the root passwd in the terminal.
      error = Status(2, eErrorTypeGeneric);
      error = Status::FromErrorStringWithFormat(
          "Launching as root needs root authorization.");
      LLDB_LOG(log, "error: {0}", error);
 
      if (authorizationRef) {
        AuthorizationFree(authorizationRef, kAuthorizationFlagDefaults);
        authorizationRef = NULL;
      }
    }
  }
 
  return error;
}
#endif
 
static short GetPosixspawnFlags(const ProcessLaunchInfo &launch_info) {
  short flags = POSIX_SPAWN_SETSIGDEF | POSIX_SPAWN_SETSIGMASK;
 
  if (launch_info.GetFlags().Test(eLaunchFlagExec))
    flags |= POSIX_SPAWN_SETEXEC; // Darwin specific posix_spawn flag
 
  if (launch_info.GetFlags().Test(eLaunchFlagDebug))
    flags |= POSIX_SPAWN_START_SUSPENDED; // Darwin specific posix_spawn flag
 
  if (launch_info.GetFlags().Test(eLaunchFlagDisableASLR))
    flags |= _POSIX_SPAWN_DISABLE_ASLR; // Darwin specific posix_spawn flag
 
  if (launch_info.GetLaunchInSeparateProcessGroup())
    flags |= POSIX_SPAWN_SETPGROUP;
 
#ifdef POSIX_SPAWN_CLOEXEC_DEFAULT
#if defined(__x86_64__) || defined(__i386__)
  static LazyBool g_use_close_on_exec_flag = eLazyBoolCalculate;
  if (g_use_close_on_exec_flag == eLazyBoolCalculate) {
    g_use_close_on_exec_flag = eLazyBoolNo;
 
    llvm::VersionTuple version = HostInfo::GetOSVersion();
    if (version > llvm::VersionTuple(10, 7)) {
      // Kernel panic if we use the POSIX_SPAWN_CLOEXEC_DEFAULT on 10.7 or
      // earlier
      g_use_close_on_exec_flag = eLazyBoolYes;
    }
  }
#else
  static LazyBool g_use_close_on_exec_flag = eLazyBoolYes;
#endif // defined(__x86_64__) || defined(__i386__)
  // Close all files exception those with file actions if this is supported.
  if (g_use_close_on_exec_flag == eLazyBoolYes)
    flags |= POSIX_SPAWN_CLOEXEC_DEFAULT;
#endif // ifdef POSIX_SPAWN_CLOEXEC_DEFAULT
  return flags;
}
 
static void finalize_xpc(void *xpc_object) {
  xpc_release((xpc_object_t)xpc_object);
}
 
static Status LaunchProcessXPC(const char *exe_path,
                               ProcessLaunchInfo &launch_info,
                               lldb::pid_t &pid) {
#if TARGET_OS_OSX
  Status error = getXPCAuthorization(launch_info);
  if (error.Fail())
    return error;
 
  Log *log(GetLog(LLDBLog::Host | LLDBLog::Process));
 
  uid_t requested_uid = launch_info.GetUserID();
  const char *xpc_service = nil;
  bool send_auth = false;
  AuthorizationExternalForm extForm;
  if (requested_uid == 0) {
    if (AuthorizationMakeExternalForm(authorizationRef, &extForm) ==
        errAuthorizationSuccess) {
      send_auth = true;
    } else {
      error = Status(3, eErrorTypeGeneric);
      error = Status::FromErrorStringWithFormat(
          "Launching root via XPC needs to "
          "externalize authorization reference.");
      LLDB_LOG(log, "error: {0}", error);
      return error;
    }
    xpc_service = LaunchUsingXPCRightName;
  } else {
    error = Status(4, eErrorTypeGeneric);
    error = Status::FromErrorStringWithFormat(
        "Launching via XPC is only currently available for root.");
    LLDB_LOG(log, "error: {0}", error);
    return error;
  }
 
  xpc_connection_t conn = xpc_connection_create(xpc_service, NULL);
 
  xpc_connection_set_event_handler(conn, ^(xpc_object_t event) {
    xpc_type_t type = xpc_get_type(event);
 
    if (type == XPC_TYPE_ERROR) {
      if (event == XPC_ERROR_CONNECTION_INTERRUPTED) {
        // The service has either canceled itself, crashed, or been terminated.
        // The XPC connection is still valid and sending a message to it will
        // re-launch the service.
        // If the service is state-full, this is the time to initialize the new
        // service.
        return;
      } else if (event == XPC_ERROR_CONNECTION_INVALID) {
        // The service is invalid. Either the service name supplied to
        // xpc_connection_create() is incorrect
        // or we (this process) have canceled the service; we can do any cleanup
        // of application state at this point.
        // printf("Service disconnected");
        return;
      } else {
        // printf("Unexpected error from service: %s",
        // xpc_dictionary_get_string(event, XPC_ERROR_KEY_DESCRIPTION));
      }
 
    } else {
      // printf("Received unexpected event in handler");
    }
  });
 
  xpc_connection_set_finalizer_f(conn, finalize_xpc);
  xpc_connection_resume(conn);
  xpc_object_t message = xpc_dictionary_create(nil, nil, 0);
 
  if (send_auth) {
    xpc_dictionary_set_data(message, LauncherXPCServiceAuthKey, extForm.bytes,
                            sizeof(AuthorizationExternalForm));
  }
 
  PackageXPCArguments(message, LauncherXPCServiceArgPrefxKey,
                      launch_info.GetArguments());
  PackageXPCEnvironment(message, LauncherXPCServiceEnvPrefxKey,
                        launch_info.GetEnvironment());
 
  // Posix spawn stuff.
  xpc_dictionary_set_int64(message, LauncherXPCServiceCPUTypeKey,
                           launch_info.GetArchitecture().GetMachOCPUType());
  xpc_dictionary_set_int64(message, LauncherXPCServicePosixspawnFlagsKey,
                           GetPosixspawnFlags(launch_info));
  const FileAction *file_action = launch_info.GetFileActionForFD(STDIN_FILENO);
  std::string file_action_path;
  if (file_action)
    file_action_path = file_action->GetFileSpec().GetPath();
 
  if (!file_action_path.empty())
    xpc_dictionary_set_string(message, LauncherXPCServiceStdInPathKeyKey,
                              file_action_path.c_str());
 
  file_action = launch_info.GetFileActionForFD(STDOUT_FILENO);
  if (file_action)
    file_action_path = file_action->GetFileSpec().GetPath();
 
  if (!file_action_path.empty())
    xpc_dictionary_set_string(message, LauncherXPCServiceStdOutPathKeyKey,
                              file_action_path.c_str());
 
  file_action = launch_info.GetFileActionForFD(STDERR_FILENO);
  if (file_action)
    file_action_path = file_action->GetFileSpec().GetPath();
 
  if (!file_action_path.empty())
    xpc_dictionary_set_string(message, LauncherXPCServiceStdErrPathKeyKey,
                              file_action_path.c_str());
 
  xpc_object_t reply =
      xpc_connection_send_message_with_reply_sync(conn, message);
  xpc_type_t returnType = xpc_get_type(reply);
  if (returnType == XPC_TYPE_DICTIONARY) {
    pid = xpc_dictionary_get_int64(reply, LauncherXPCServiceChildPIDKey);
    if (pid == 0) {
      int errorType =
          xpc_dictionary_get_int64(reply, LauncherXPCServiceErrorTypeKey);
      int errorCode =
          xpc_dictionary_get_int64(reply, LauncherXPCServiceCodeTypeKey);
 
      error = Status(errorCode, eErrorTypeGeneric);
      error = Status::FromErrorStringWithFormat(
          "Problems with launching via XPC. Error type : %i, code : %i",
          errorType, errorCode);
      LLDB_LOG(log, "error: {0}", error);
 
      if (authorizationRef) {
        AuthorizationFree(authorizationRef, kAuthorizationFlagDefaults);
        authorizationRef = NULL;
      }
    }
  } else if (returnType == XPC_TYPE_ERROR) {
    error = Status(5, eErrorTypeGeneric);
    error = Status::FromErrorStringWithFormat(
        "Problems with launching via XPC. XPC error : %s",
        xpc_dictionary_get_string(reply, XPC_ERROR_KEY_DESCRIPTION));
    LLDB_LOG(log, "error: {0}", error);
  }
 
  return error;
#else
  Status error;
  return error;
#endif
}
 
static bool AddPosixSpawnFileAction(void *_file_actions, const FileAction *info,
                                    Log *log, Status &error) {
  if (info == NULL)
    return false;
 
  posix_spawn_file_actions_t *file_actions =
      static_cast<posix_spawn_file_actions_t *>(_file_actions);
 
  switch (info->GetAction()) {
  case FileAction::eFileActionNone:
    error.Clear();
    break;
 
  case FileAction::eFileActionClose:
    if (info->GetFD() == -1)
      error = Status::FromErrorString(
          "invalid fd for posix_spawn_file_actions_addclose(...)");
    else {
      error = Status(
          ::posix_spawn_file_actions_addclose(file_actions, info->GetFD()),
          eErrorTypePOSIX);
      if (error.Fail())
        LLDB_LOG(log,
                 "error: {0}, posix_spawn_file_actions_addclose "
                 "(action={1}, fd={2})",
                 error, file_actions, info->GetFD());
    }
    break;
 
  case FileAction::eFileActionDuplicate:
    if (info->GetFD() == -1)
      error = Status::FromErrorString(
          "invalid fd for posix_spawn_file_actions_adddup2(...)");
    else if (info->GetActionArgument() == -1)
      error = Status::FromErrorString(
          "invalid duplicate fd for posix_spawn_file_actions_adddup2(...)");
    else if (info->GetFD() != info->GetActionArgument()) {
      error =
          Status(::posix_spawn_file_actions_adddup2(file_actions, info->GetFD(),
                                                    info->GetActionArgument()),
                 eErrorTypePOSIX);
      if (error.Fail())
        LLDB_LOG(log,
                 "error: {0}, posix_spawn_file_actions_adddup2 "
                 "(action={1}, fd={2}, dup_fd={3})",
                 error, file_actions, info->GetFD(), info->GetActionArgument());
    } else {
      error =
          Status(::posix_spawn_file_actions_addinherit_np(file_actions, info->GetFD()),
                 eErrorTypePOSIX);
      if (error.Fail())
        LLDB_LOG(log,
                 "error: {0}, posix_spawn_file_actions_addinherit_np "
                 "(action={1}, fd={2})",
                 error, file_actions, info->GetFD());
    }
    break;
 
  case FileAction::eFileActionOpen:
    if (info->GetFD() == -1)
      error = Status::FromErrorString(
          "invalid fd in posix_spawn_file_actions_addopen(...)");
    else {
      int oflag = info->GetActionArgument();
 
      mode_t mode = 0;
 
      if (oflag & O_CREAT)
        mode = 0640;
 
      const std::string file_path(info->GetFileSpec().GetPath());
      error = Status(
          ::posix_spawn_file_actions_addopen(file_actions, info->GetFD(),
                                             file_path.c_str(), oflag, mode),
          eErrorTypePOSIX);
      if (error.Fail())
        LLDB_LOG(log,
                 "error: {0}, posix_spawn_file_actions_addopen (action={1}, "
                 "fd={2}, path='{3}', oflag={4}, mode={5})",
                 error, file_actions, info->GetFD(), file_path, oflag, mode);
    }
    break;
  }
  return error.Success();
}
 
static Status LaunchProcessPosixSpawn(const char *exe_path,
                                      const ProcessLaunchInfo &launch_info,
                                      lldb::pid_t &pid) {
  Status error;
  Log *log(GetLog(LLDBLog::Host | LLDBLog::Process));
 
  posix_spawnattr_t attr;
  error = Status(::posix_spawnattr_init(&attr), eErrorTypePOSIX);
 
  if (error.Fail()) {
    LLDB_LOG(log, "error: {0}, ::posix_spawnattr_init ( &attr )", error);
    return error;
  }
 
  // Make sure we clean up the posix spawn attributes before exiting this scope.
  llvm::scope_exit cleanup_attr([&]() { posix_spawnattr_destroy(&attr); });
 
  sigset_t no_signals;
  sigset_t all_signals;
  sigemptyset(&no_signals);
  sigfillset(&all_signals);
  ::posix_spawnattr_setsigmask(&attr, &no_signals);
  ::posix_spawnattr_setsigdefault(&attr, &all_signals);
 
  short flags = GetPosixspawnFlags(launch_info);
 
  error = Status(::posix_spawnattr_setflags(&attr, flags), eErrorTypePOSIX);
  if (error.Fail()) {
    LLDB_LOG(log,
             "error: {0}, ::posix_spawnattr_setflags ( &attr, flags={1:x} )",
             error, flags);
    return error;
  }
 
  bool is_graphical = true;
 
#if TARGET_OS_OSX
  SecuritySessionId session_id;
  SessionAttributeBits session_attributes;
  OSStatus status =
      SessionGetInfo(callerSecuritySession, &session_id, &session_attributes);
  if (status == errSessionSuccess)
    is_graphical = session_attributes & sessionHasGraphicAccess;
#endif
 
  //  When lldb is ran through a graphical session, make the debuggee process
  //  responsible for its own TCC permissions instead of inheriting them from
  //  its parent.
  if (is_graphical && launch_info.GetFlags().Test(eLaunchFlagDebug) &&
      !launch_info.GetFlags().Test(eLaunchFlagInheritTCCFromParent)) {
    error = Status(setup_posix_spawn_responsible_flag(&attr), eErrorTypePOSIX);
    if (error.Fail()) {
      LLDB_LOG(log, "error: {0}, setup_posix_spawn_responsible_flag(&attr)",
               error);
      return error;
    }
  }
 
  if (launch_info.GetFlags().Test(eLaunchFlagMemoryTagging)) {
    // The following function configures the spawn attributes to launch the
    // process with memory tagging explicitly enabled.  We look it up
    // dynamically since it is only available on newer OS.  Does nothing on
    // hardware which does not support MTE.
    //
    //   int posix_spawnattr_set_use_sec_transition_shims_np(
    //       posix_spawnattr_t *attr, uint32_t flags);
    //
    using posix_spawnattr_set_use_sec_transition_shims_np_t =
        int (*)(posix_spawnattr_t *attr, uint32_t flags);
    auto posix_spawnattr_enable_memory_tagging_fn =
        (posix_spawnattr_set_use_sec_transition_shims_np_t)dlsym(
            RTLD_DEFAULT, "posix_spawnattr_set_use_sec_transition_shims_np");
    if (posix_spawnattr_enable_memory_tagging_fn) {
      error = Status(posix_spawnattr_enable_memory_tagging_fn(&attr, 0),
                     eErrorTypePOSIX);
      if (error.Fail()) {
        LLDB_LOG(log,
                 "error: {}, "
                 "posix_spawnattr_set_use_sec_transition_shims_np(&attr, 0)",
                 error);
        return error;
      }
    } else {
      LLDB_LOG(log,
               "error: {}, posix_spawnattr_set_use_sec_transition_shims_np "
               "not available",
               error);
    }
  }
 
  // Don't set the binpref if a shell was provided. After all, that's only
  // going to affect what version of the shell is launched, not what fork of
  // the binary is launched.  We insert "arch --arch <ARCH> as part of the
  // shell invocation to do that job on OSX.
  if (launch_info.GetShell() == FileSpec()) {
    const ArchSpec &arch_spec = launch_info.GetArchitecture();
    cpu_type_t cpu_type = arch_spec.GetMachOCPUType();
    cpu_type_t cpu_subtype = arch_spec.GetMachOCPUSubType();
    const bool set_cpu_type =
        cpu_type != 0 && cpu_type != static_cast<cpu_type_t>(UINT32_MAX) &&
        cpu_type != static_cast<cpu_type_t>(LLDB_INVALID_CPUTYPE);
    const bool set_cpu_subtype =
        cpu_subtype != 0 &&
        cpu_subtype != static_cast<cpu_subtype_t>(UINT32_MAX) &&
        cpu_subtype != CPU_SUBTYPE_X86_64_H;
    if (set_cpu_type) {
      size_t ocount = 0;
      typedef int (*posix_spawnattr_setarchpref_np_t)(
          posix_spawnattr_t *, size_t, cpu_type_t *, cpu_subtype_t *, size_t *);
      posix_spawnattr_setarchpref_np_t posix_spawnattr_setarchpref_np_fn =
          (posix_spawnattr_setarchpref_np_t)dlsym(
              RTLD_DEFAULT, "posix_spawnattr_setarchpref_np");
      if (set_cpu_subtype && posix_spawnattr_setarchpref_np_fn) {
        error = Status((*posix_spawnattr_setarchpref_np_fn)(
                           &attr, 1, &cpu_type, &cpu_subtype, &ocount),
                       eErrorTypePOSIX);
        if (error.Fail())
          LLDB_LOG(log,
                   "error: {}, ::posix_spawnattr_setarchpref_np ( &attr, 1, "
                   "cpu_type = {:x}, cpu_subtype = {:x}, count => {} )",
                   error, cpu_type, cpu_subtype, ocount);
 
        if (error.Fail() || ocount != 1)
          return error;
      } else {
        error = Status(
            ::posix_spawnattr_setbinpref_np(&attr, 1, &cpu_type, &ocount),
            eErrorTypePOSIX);
        if (error.Fail())
          LLDB_LOG(log,
                   "error: {0}, ::posix_spawnattr_setbinpref_np ( &attr, 1, "
                   "cpu_type = {1:x}, count => {2} )",
                   error, cpu_type, ocount);
        if (error.Fail() || ocount != 1)
          return error;
      }
    }
  }
 
  const char *tmp_argv[2];
  char *const *argv = const_cast<char *const *>(
      launch_info.GetArguments().GetConstArgumentVector());
  Environment::Envp envp = launch_info.GetEnvironment().getEnvp();
  if (argv == NULL) {
    // posix_spawn gets very unhappy if it doesn't have at least the program
    // name in argv[0]. One of the side affects I have noticed is the
    // environment
    // variables don't make it into the child process if "argv == NULL"!!!
    tmp_argv[0] = exe_path;
    tmp_argv[1] = NULL;
    argv = const_cast<char *const *>(tmp_argv);
  }
 
  FileSpec working_dir{launch_info.GetWorkingDirectory()};
  if (working_dir) {
    // Set the working directory on this thread only
    std::string working_dir_path = working_dir.GetPath();
    if (__pthread_chdir(working_dir_path.c_str()) < 0) {
      if (errno == ENOENT) {
        error = Status::FromErrorStringWithFormat(
            "No such file or directory: %s", working_dir_path.c_str());
      } else if (errno == ENOTDIR) {
        error = Status::FromErrorStringWithFormat(
            "Path doesn't name a directory: %s", working_dir_path.c_str());
      } else {
        error =
            Status::FromErrorStringWithFormat("An unknown error occurred when "
                                              "changing directory for process "
                                              "execution.");
      }
      return error;
    }
  }
 
  ::pid_t result_pid = LLDB_INVALID_PROCESS_ID;
  const size_t num_file_actions = launch_info.GetNumFileActions();
  if (num_file_actions > 0) {
    posix_spawn_file_actions_t file_actions;
    error =
        Status(::posix_spawn_file_actions_init(&file_actions), eErrorTypePOSIX);
    if (error.Fail()) {
      LLDB_LOG(log,
               "error: {0}, ::posix_spawn_file_actions_init ( &file_actions )",
               error);
      return error;
    }
 
    // Make sure we clean up the posix file actions before exiting this scope.
    llvm::scope_exit cleanup_fileact(
        [&]() { posix_spawn_file_actions_destroy(&file_actions); });
 
    for (size_t i = 0; i < num_file_actions; ++i) {
      const FileAction *launch_file_action =
          launch_info.GetFileActionAtIndex(i);
      if (launch_file_action) {
        if (!AddPosixSpawnFileAction(&file_actions, launch_file_action, log,
                                     error))
          return error;
      }
    }
 
    error = Status(
        ::posix_spawnp(&result_pid, exe_path, &file_actions, &attr, argv, envp),
        eErrorTypePOSIX);
 
    if (error.Fail()) {
      LLDB_LOG(log,
               "error: {0}, ::posix_spawnp(pid => {1}, path = '{2}', "
               "file_actions = {3}, "
               "attr = {4}, argv = {5}, envp = {6} )",
               error, result_pid, exe_path, &file_actions, &attr, argv,
               envp.get());
      if (log) {
        for (int ii = 0; argv[ii]; ++ii)
          LLDB_LOG(log, "argv[{0}] = '{1}'", ii, argv[ii]);
      }
    }
 
  } else {
    error =
        Status(::posix_spawnp(&result_pid, exe_path, NULL, &attr, argv, envp),
               eErrorTypePOSIX);
 
    if (error.Fail()) {
      LLDB_LOG(log,
               "error: {0}, ::posix_spawnp ( pid => {1}, path = '{2}', "
               "file_actions = NULL, attr = {3}, argv = {4}, envp = {5} )",
               error, result_pid, exe_path, &attr, argv, envp.get());
      if (log) {
        for (int ii = 0; argv[ii]; ++ii)
          LLDB_LOG(log, "argv[{0}] = '{1}'", ii, argv[ii]);
      }
    }
  }
  pid = result_pid;
 
  if (working_dir) {
    // No more thread specific current working directory
    __pthread_fchdir(-1);
  }
 
  return error;
}
 
static bool ShouldLaunchUsingXPC(ProcessLaunchInfo &launch_info) {
  bool result = false;
 
#if TARGET_OS_OSX
  bool launchingAsRoot = launch_info.GetUserID() == 0;
  bool currentUserIsRoot = HostInfo::GetEffectiveUserID() == 0;
 
  if (launchingAsRoot && !currentUserIsRoot) {
    // If current user is already root, we don't need XPC's help.
    result = true;
  }
#endif
 
  return result;
}
 
Status Host::LaunchProcess(ProcessLaunchInfo &launch_info) {
  Status error;
 
  FileSystem &fs = FileSystem::Instance();
  FileSpec exe_spec(launch_info.GetExecutableFile());
 
  if (!fs.Exists(exe_spec))
    FileSystem::Instance().Resolve(exe_spec);
 
  if (!fs.Exists(exe_spec))
    FileSystem::Instance().ResolveExecutableLocation(exe_spec);
 
  if (!fs.Exists(exe_spec)) {
    error = Status::FromErrorStringWithFormatv(
        "executable doesn't exist: '{0}'", exe_spec);
    return error;
  }
 
  if (launch_info.GetFlags().Test(eLaunchFlagLaunchInTTY)) {
#if TARGET_OS_OSX
    return LaunchInNewTerminalWithAppleScript(exe_spec.GetPath().c_str(),
                                              launch_info);
#else
    error =
        Status::FromErrorString("launching a process in a new terminal is not "
                                "supported on iOS devices");
    return error;
#endif
  }
 
  lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
 
  auto exe_path = exe_spec.GetPath();
 
  if (ShouldLaunchUsingXPC(launch_info))
    error = LaunchProcessXPC(exe_path.c_str(), launch_info, pid);
  else
    error = LaunchProcessPosixSpawn(exe_path.c_str(), launch_info, pid);
 
  if (pid != LLDB_INVALID_PROCESS_ID) {
    // If all went well, then set the process ID into the launch info
    launch_info.SetProcessID(pid);
 
    // Make sure we reap any processes we spawn or we will have zombies.
    bool monitoring = launch_info.MonitorProcess();
    UNUSED_IF_ASSERT_DISABLED(monitoring);
    assert(monitoring);
  } else {
    // Invalid process ID, something didn't go well
    if (error.Success())
      error =
          Status::FromErrorString("process launch failed for unknown reasons");
  }
  return error;
}
 
Status Host::ShellExpandArguments(ProcessLaunchInfo &launch_info) {
  Status error;
  if (launch_info.GetFlags().Test(eLaunchFlagShellExpandArguments)) {
    FileSpec expand_tool_spec;
    Environment host_env = Host::GetEnvironment();
    std::string env_argdumper_path = host_env.lookup("LLDB_ARGDUMPER_PATH");
    if (!env_argdumper_path.empty()) {
      expand_tool_spec.SetFile(env_argdumper_path, FileSpec::Style::native);
      Log *log(GetLog(LLDBLog::Host | LLDBLog::Process));
      LLDB_LOGF(log,
                "lldb-argdumper exe path set from environment variable: %s",
                env_argdumper_path.c_str());
    }
    bool argdumper_exists = FileSystem::Instance().Exists(env_argdumper_path);
    if (!argdumper_exists) {
      expand_tool_spec = HostInfo::GetSupportExeDir();
      if (!expand_tool_spec) {
        error = Status::FromErrorString(
            "could not get support executable directory for "
            "lldb-argdumper tool");
        return error;
      }
      expand_tool_spec.AppendPathComponent("lldb-argdumper");
      if (!FileSystem::Instance().Exists(expand_tool_spec)) {
        error = Status::FromErrorStringWithFormat(
            "could not find the lldb-argdumper tool: %s",
            expand_tool_spec.GetPath().c_str());
        return error;
      }
    }
 
    StreamString expand_tool_spec_stream;
    expand_tool_spec_stream.Printf("\"%s\"",
                                   expand_tool_spec.GetPath().c_str());
 
    Args expand_command(expand_tool_spec_stream.GetData());
    expand_command.AppendArguments(launch_info.GetArguments());
 
    int status;
    std::string output;
    FileSpec cwd(launch_info.GetWorkingDirectory());
    if (!FileSystem::Instance().Exists(cwd)) {
      char *wd = getcwd(nullptr, 0);
      if (wd == nullptr) {
        error = Status::FromErrorStringWithFormat(
            "cwd does not exist: Cannot launch with shell argument expansion");
        return error;
      } else {
        FileSpec working_dir(wd);
        free(wd);
        launch_info.SetWorkingDirectory(working_dir);
      }
    }
    bool run_in_shell = true;
    std::string error_output; // Pass stderr string arg so it is not mixed with
                              // stdout.
    Status e =
        RunShellCommand(expand_command, cwd, &status, nullptr, &output,
                        &error_output, std::chrono::seconds(10), run_in_shell);
 
    if (e.Fail())
      return e;
 
    if (status != 0) {
      error = Status::FromErrorStringWithFormat(
          "lldb-argdumper exited with error %d", status);
      return error;
    }
 
    auto data_sp = StructuredData::ParseJSON(output);
    if (!data_sp) {
      error = Status::FromErrorString("invalid JSON");
      return error;
    }
 
    auto dict_sp = data_sp->GetAsDictionary();
    if (!data_sp) {
      error = Status::FromErrorString("invalid JSON");
      return error;
    }
 
    auto args_sp = dict_sp->GetObjectForDotSeparatedPath("arguments");
    if (!args_sp) {
      error = Status::FromErrorString("invalid JSON");
      return error;
    }
 
    auto args_array_sp = args_sp->GetAsArray();
    if (!args_array_sp) {
      error = Status::FromErrorString("invalid JSON");
      return error;
    }
 
    launch_info.GetArguments().Clear();
 
    for (size_t i = 0; i < args_array_sp->GetSize(); i++) {
      auto item_sp = args_array_sp->GetItemAtIndex(i);
      if (!item_sp)
        continue;
      auto str_sp = item_sp->GetAsString();
      if (!str_sp)
        continue;
 
      launch_info.GetArguments().AppendArgument(str_sp->GetValue());
    }
  }
 
  return error;
}
 
llvm::Expected<HostThread> Host::StartMonitoringChildProcess(
    const Host::MonitorChildProcessCallback &callback, lldb::pid_t pid) {
  unsigned long mask = DISPATCH_PROC_EXIT;
 
  Log *log(GetLog(LLDBLog::Host | LLDBLog::Process));
 
  dispatch_source_t source = ::dispatch_source_create(
      DISPATCH_SOURCE_TYPE_PROC, pid, mask,
      ::dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0));
 
  LLDB_LOGF(log,
            "Host::StartMonitoringChildProcess(callback, pid=%i) source = %p\n",
            static_cast<int>(pid), static_cast<void *>(source));
 
  if (source) {
    Host::MonitorChildProcessCallback callback_copy = callback;
    ::dispatch_source_set_cancel_handler(source, ^{
      dispatch_release(source);
    });
    ::dispatch_source_set_event_handler(source, ^{
 
      int status = 0;
      int wait_pid = 0;
      wait_pid = llvm::sys::RetryAfterSignal(-1, ::waitpid, pid, &status, 0);
      if (wait_pid >= 0) {
        int signal = 0;
        int exit_status = 0;
        const char *status_cstr = NULL;
        if (WIFEXITED(status)) {
          exit_status = WEXITSTATUS(status);
          status_cstr = "EXITED";
        } else if (WIFSIGNALED(status)) {
          signal = WTERMSIG(status);
          status_cstr = "SIGNALED";
          exit_status = -1;
        } else {
          llvm_unreachable("Unknown status");
        }
 
        LLDB_LOGF(log,
                  "::waitpid (pid = %llu, &status, 0) => pid = %i, status "
                  "= 0x%8.8x (%s), signal = %i, exit_status = %i",
                  pid, wait_pid, status, status_cstr, signal, exit_status);
 
        if (callback_copy)
          callback_copy(pid, signal, exit_status);
 
        ::dispatch_source_cancel(source);
      }
    });
 
    ::dispatch_resume(source);
  }
  return HostThread();
}