lldb/unittests/Host/HostTest.cpp

//===-- HostTest.cpp ------------------------------------------------------===//
//
// 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 "TestingSupport/SubsystemRAII.h"
#include "lldb/Host/FileSystem.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Host/Pipe.h"
#include "lldb/Host/ProcessLaunchInfo.h"
#include "lldb/Utility/ProcessInfo.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Testing/Support/Error.h"
#include "gtest/gtest.h"
#include <future>
#include <thread>

using namespace lldb_private;
using namespace llvm;

// From TestMain.cpp.
extern const char *TestMainArgv0;

static cl::opt<uint64_t> test_arg("test-arg");

TEST(Host, WaitStatusFormat) {
  EXPECT_EQ("W01", formatv("{0:g}", WaitStatus{WaitStatus::Exit, 1}).str());
  EXPECT_EQ("X02", formatv("{0:g}", WaitStatus{WaitStatus::Signal, 2}).str());
  EXPECT_EQ("S03", formatv("{0:g}", WaitStatus{WaitStatus::Stop, 3}).str());
  EXPECT_EQ("Exited with status 4",
            formatv("{0}", WaitStatus{WaitStatus::Exit, 4}).str());
}

TEST(Host, GetEnvironment) {
  putenv(const_cast<char *>("LLDB_TEST_ENVIRONMENT_VAR=Host::GetEnvironment"));
  ASSERT_EQ("Host::GetEnvironment",
            Host::GetEnvironment().lookup("LLDB_TEST_ENVIRONMENT_VAR"));
}

TEST(Host, ProcessInstanceInfoCumulativeUserTimeIsValid) {
  ProcessInstanceInfo info;
  info.SetCumulativeUserTime(ProcessInstanceInfo::timespec{0, 0});
  EXPECT_FALSE(info.CumulativeUserTimeIsValid());
  info.SetCumulativeUserTime(ProcessInstanceInfo::timespec{0, 1});
  EXPECT_TRUE(info.CumulativeUserTimeIsValid());
  info.SetCumulativeUserTime(ProcessInstanceInfo::timespec{1, 0});
  EXPECT_TRUE(info.CumulativeUserTimeIsValid());
}

TEST(Host, ProcessInstanceInfoCumulativeSystemTimeIsValid) {
  ProcessInstanceInfo info;
  info.SetCumulativeSystemTime(ProcessInstanceInfo::timespec{0, 0});
  EXPECT_FALSE(info.CumulativeSystemTimeIsValid());
  info.SetCumulativeSystemTime(ProcessInstanceInfo::timespec{0, 1});
  EXPECT_TRUE(info.CumulativeSystemTimeIsValid());
  info.SetCumulativeSystemTime(ProcessInstanceInfo::timespec{1, 0});
  EXPECT_TRUE(info.CumulativeSystemTimeIsValid());
}

TEST(Host, LaunchProcessSetsArgv0) {
  SubsystemRAII<FileSystem> subsystems;

  static constexpr StringLiteral TestArgv0 = "HelloArgv0";
  if (test_arg != 0) {
    // In subprocess
    if (TestMainArgv0 != TestArgv0) {
      errs() << formatv("Got '{0}' for argv[0]\n", TestMainArgv0);
      exit(1);
    }
    exit(0);
  }

  ProcessLaunchInfo info;
  info.SetExecutableFile(
      FileSpec(llvm::sys::fs::getMainExecutable(TestMainArgv0, &test_arg)),
      /*add_exe_file_as_first_arg=*/false);
  info.GetArguments().AppendArgument("HelloArgv0");
  info.GetArguments().AppendArgument(
      "--gtest_filter=Host.LaunchProcessSetsArgv0");
  info.GetArguments().AppendArgument("--test-arg=47");
  std::promise<int> exit_status;
  info.SetMonitorProcessCallback([&](lldb::pid_t pid, int signal, int status) {
    exit_status.set_value(status);
  });
  ASSERT_THAT_ERROR(Host::LaunchProcess(info).takeError(), Succeeded());
  ASSERT_THAT(exit_status.get_future().get(), 0);
}

TEST(Host, FindProcesses) {
  SubsystemRAII<FileSystem, HostInfo> subsystems;

  if (test_arg != 0) {
    // Give the parent time to retrieve information about self.
    // It will kill self when it is done.
    std::this_thread::sleep_for(std::chrono::seconds(10));
    exit(0);
  }

  bool foundPID = false;
  ProcessLaunchInfo info;
  ProcessInstanceInfoList processes;
  ProcessInstanceInfoMatch match(TestMainArgv0, NameMatch::Equals);
  info.SetExecutableFile(FileSpec(TestMainArgv0),
                         /*add_exe_file_as_first_arg=*/true);
  info.GetArguments().AppendArgument("--gtest_filter=Host.FindProcesses");
  info.GetArguments().AppendArgument("--test-arg=48");
  std::promise<int> exit_status;
  info.SetMonitorProcessCallback([&](lldb::pid_t pid, int signal, int status) {
    exit_status.set_value(status);
  });
  ASSERT_THAT_ERROR(Host::LaunchProcess(info).takeError(), Succeeded());
  ASSERT_TRUE(Host::FindProcesses(match, processes));
  for (const auto &process : processes) {
    if (process.GetProcessID() == info.GetProcessID()) {
      ASSERT_EQ(process.GetExecutableFile().GetFilename(),
                info.GetExecutableFile().GetFilename());
      foundPID = true;
    }
  }
  ASSERT_TRUE(foundPID);
  auto clean_up = llvm::make_scope_exit([&] {
    Host::Kill(info.GetProcessID(), SIGKILL);
    exit_status.get_future().get();
  });
}

TEST(Host, LaunchProcessDuplicatesHandle) {
  static constexpr llvm::StringLiteral test_msg("Hello subprocess!");

  SubsystemRAII<FileSystem> subsystems;

  if (test_arg) {
    Pipe pipe(LLDB_INVALID_PIPE, (lldb::pipe_t)test_arg.getValue());
    llvm::Expected<size_t> bytes_written =
        pipe.Write(test_msg.data(), test_msg.size());
    if (bytes_written && *bytes_written == test_msg.size())
      exit(0);
    exit(1);
  }
  Pipe pipe;
  ASSERT_THAT_ERROR(pipe.CreateNew(/*child_process_inherit=*/false).takeError(),
                    llvm::Succeeded());
  SCOPED_TRACE(llvm::formatv("Pipe handles are: {0}/{1}",
                             (uint64_t)pipe.GetReadPipe(),
                             (uint64_t)pipe.GetWritePipe())
                   .str());
  ProcessLaunchInfo info;
  info.SetExecutableFile(FileSpec(TestMainArgv0),
                         /*add_exe_file_as_first_arg=*/true);
  info.GetArguments().AppendArgument(
      "--gtest_filter=Host.LaunchProcessDuplicatesHandle");
  info.GetArguments().AppendArgument(
      ("--test-arg=" + llvm::Twine((uint64_t)pipe.GetWritePipe())).str());
  info.AppendDuplicateFileAction((uint64_t)pipe.GetWritePipe(),
                                 (uint64_t)pipe.GetWritePipe());
  info.SetMonitorProcessCallback(&ProcessLaunchInfo::NoOpMonitorCallback);
  ASSERT_THAT_ERROR(Host::LaunchProcess(info).takeError(), llvm::Succeeded());
  pipe.CloseWriteFileDescriptor();

  char msg[100];
  llvm::Expected<size_t> bytes_read =
      pipe.Read(msg, sizeof(msg), std::chrono::seconds(10));
  ASSERT_THAT_EXPECTED(bytes_read, llvm::Succeeded());
  ASSERT_EQ(llvm::StringRef(msg, *bytes_read), test_msg);
}