forked from OSchip/llvm-project
338 lines
9.2 KiB
C++
338 lines
9.2 KiB
C++
//===-- Reproducer.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/Utility/Reproducer.h"
|
|
#include "lldb/Utility/LLDBAssert.h"
|
|
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include "llvm/Support/Threading.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
using namespace lldb_private;
|
|
using namespace lldb_private::repro;
|
|
using namespace llvm;
|
|
using namespace llvm::yaml;
|
|
|
|
static llvm::Optional<bool> GetEnv(const char *var) {
|
|
std::string val = llvm::StringRef(getenv(var)).lower();
|
|
if (val == "0" || val == "off")
|
|
return false;
|
|
if (val == "1" || val == "on")
|
|
return true;
|
|
return {};
|
|
}
|
|
|
|
Reproducer &Reproducer::Instance() { return *InstanceImpl(); }
|
|
|
|
llvm::Error Reproducer::Initialize(ReproducerMode mode,
|
|
llvm::Optional<FileSpec> root) {
|
|
lldbassert(!InstanceImpl() && "Already initialized.");
|
|
InstanceImpl().emplace();
|
|
|
|
// The environment can override the capture mode.
|
|
if (mode != ReproducerMode::Replay) {
|
|
if (llvm::Optional<bool> override = GetEnv("LLDB_CAPTURE_REPRODUCER")) {
|
|
if (*override)
|
|
mode = ReproducerMode::Capture;
|
|
else
|
|
mode = ReproducerMode::Off;
|
|
}
|
|
}
|
|
|
|
switch (mode) {
|
|
case ReproducerMode::Capture: {
|
|
if (!root) {
|
|
SmallString<128> repro_dir;
|
|
auto ec = sys::fs::createUniqueDirectory("reproducer", repro_dir);
|
|
if (ec)
|
|
return make_error<StringError>(
|
|
"unable to create unique reproducer directory", ec);
|
|
root.emplace(repro_dir);
|
|
} else {
|
|
auto ec = sys::fs::create_directory(root->GetPath());
|
|
if (ec)
|
|
return make_error<StringError>("unable to create reproducer directory",
|
|
ec);
|
|
}
|
|
return Instance().SetCapture(root);
|
|
} break;
|
|
case ReproducerMode::Replay:
|
|
return Instance().SetReplay(root);
|
|
case ReproducerMode::Off:
|
|
break;
|
|
};
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
bool Reproducer::Initialized() { return InstanceImpl().operator bool(); }
|
|
|
|
void Reproducer::Terminate() {
|
|
lldbassert(InstanceImpl() && "Already terminated.");
|
|
InstanceImpl().reset();
|
|
}
|
|
|
|
Optional<Reproducer> &Reproducer::InstanceImpl() {
|
|
static Optional<Reproducer> g_reproducer;
|
|
return g_reproducer;
|
|
}
|
|
|
|
const Generator *Reproducer::GetGenerator() const {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
if (m_generator)
|
|
return &(*m_generator);
|
|
return nullptr;
|
|
}
|
|
|
|
const Loader *Reproducer::GetLoader() const {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
if (m_loader)
|
|
return &(*m_loader);
|
|
return nullptr;
|
|
}
|
|
|
|
Generator *Reproducer::GetGenerator() {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
if (m_generator)
|
|
return &(*m_generator);
|
|
return nullptr;
|
|
}
|
|
|
|
Loader *Reproducer::GetLoader() {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
if (m_loader)
|
|
return &(*m_loader);
|
|
return nullptr;
|
|
}
|
|
|
|
llvm::Error Reproducer::SetCapture(llvm::Optional<FileSpec> root) {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
|
|
if (root && m_loader)
|
|
return make_error<StringError>(
|
|
"cannot generate a reproducer when replay one",
|
|
inconvertibleErrorCode());
|
|
|
|
if (!root) {
|
|
m_generator.reset();
|
|
return Error::success();
|
|
}
|
|
|
|
m_generator.emplace(*root);
|
|
return Error::success();
|
|
}
|
|
|
|
llvm::Error Reproducer::SetReplay(llvm::Optional<FileSpec> root) {
|
|
std::lock_guard<std::mutex> guard(m_mutex);
|
|
|
|
if (root && m_generator)
|
|
return make_error<StringError>(
|
|
"cannot replay a reproducer when generating one",
|
|
inconvertibleErrorCode());
|
|
|
|
if (!root) {
|
|
m_loader.reset();
|
|
return Error::success();
|
|
}
|
|
|
|
m_loader.emplace(*root);
|
|
if (auto e = m_loader->LoadIndex())
|
|
return e;
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
FileSpec Reproducer::GetReproducerPath() const {
|
|
if (auto g = GetGenerator())
|
|
return g->GetRoot();
|
|
if (auto l = GetLoader())
|
|
return l->GetRoot();
|
|
return {};
|
|
}
|
|
|
|
static FileSpec MakeAbsolute(FileSpec file_spec) {
|
|
SmallString<128> path;
|
|
file_spec.GetPath(path, false);
|
|
llvm::sys::fs::make_absolute(path);
|
|
return FileSpec(path, file_spec.GetPathStyle());
|
|
}
|
|
|
|
Generator::Generator(FileSpec root) : m_root(MakeAbsolute(std::move(root))) {
|
|
GetOrCreate<repro::WorkingDirectoryProvider>();
|
|
}
|
|
|
|
Generator::~Generator() {
|
|
if (!m_done) {
|
|
if (m_auto_generate)
|
|
Keep();
|
|
else
|
|
Discard();
|
|
}
|
|
}
|
|
|
|
ProviderBase *Generator::Register(std::unique_ptr<ProviderBase> provider) {
|
|
std::lock_guard<std::mutex> lock(m_providers_mutex);
|
|
std::pair<const void *, std::unique_ptr<ProviderBase>> key_value(
|
|
provider->DynamicClassID(), std::move(provider));
|
|
auto e = m_providers.insert(std::move(key_value));
|
|
return e.first->getSecond().get();
|
|
}
|
|
|
|
void Generator::Keep() {
|
|
assert(!m_done);
|
|
m_done = true;
|
|
|
|
for (auto &provider : m_providers)
|
|
provider.second->Keep();
|
|
|
|
AddProvidersToIndex();
|
|
}
|
|
|
|
void Generator::Discard() {
|
|
assert(!m_done);
|
|
m_done = true;
|
|
|
|
for (auto &provider : m_providers)
|
|
provider.second->Discard();
|
|
|
|
llvm::sys::fs::remove_directories(m_root.GetPath());
|
|
}
|
|
|
|
void Generator::SetAutoGenerate(bool b) { m_auto_generate = b; }
|
|
|
|
bool Generator::IsAutoGenerate() const { return m_auto_generate; }
|
|
|
|
const FileSpec &Generator::GetRoot() const { return m_root; }
|
|
|
|
void Generator::AddProvidersToIndex() {
|
|
FileSpec index = m_root;
|
|
index.AppendPathComponent("index.yaml");
|
|
|
|
std::error_code EC;
|
|
auto strm = std::make_unique<raw_fd_ostream>(index.GetPath(), EC,
|
|
sys::fs::OpenFlags::OF_None);
|
|
yaml::Output yout(*strm);
|
|
|
|
std::vector<std::string> files;
|
|
files.reserve(m_providers.size());
|
|
for (auto &provider : m_providers) {
|
|
files.emplace_back(provider.second->GetFile());
|
|
}
|
|
|
|
yout << files;
|
|
}
|
|
|
|
Loader::Loader(FileSpec root)
|
|
: m_root(MakeAbsolute(std::move(root))), m_loaded(false) {}
|
|
|
|
llvm::Error Loader::LoadIndex() {
|
|
if (m_loaded)
|
|
return llvm::Error::success();
|
|
|
|
FileSpec index = m_root.CopyByAppendingPathComponent("index.yaml");
|
|
|
|
auto error_or_file = MemoryBuffer::getFile(index.GetPath());
|
|
if (auto err = error_or_file.getError())
|
|
return make_error<StringError>("unable to load reproducer index", err);
|
|
|
|
yaml::Input yin((*error_or_file)->getBuffer());
|
|
yin >> m_files;
|
|
if (auto err = yin.error())
|
|
return make_error<StringError>("unable to read reproducer index", err);
|
|
|
|
// Sort files to speed up search.
|
|
llvm::sort(m_files);
|
|
|
|
// Remember that we've loaded the index.
|
|
m_loaded = true;
|
|
|
|
return llvm::Error::success();
|
|
}
|
|
|
|
bool Loader::HasFile(StringRef file) {
|
|
assert(m_loaded);
|
|
auto it = std::lower_bound(m_files.begin(), m_files.end(), file.str());
|
|
return (it != m_files.end()) && (*it == file);
|
|
}
|
|
|
|
llvm::Expected<std::unique_ptr<DataRecorder>>
|
|
DataRecorder::Create(const FileSpec &filename) {
|
|
std::error_code ec;
|
|
auto recorder = std::make_unique<DataRecorder>(std::move(filename), ec);
|
|
if (ec)
|
|
return llvm::errorCodeToError(ec);
|
|
return std::move(recorder);
|
|
}
|
|
|
|
DataRecorder *CommandProvider::GetNewDataRecorder() {
|
|
std::size_t i = m_data_recorders.size() + 1;
|
|
std::string filename = (llvm::Twine(Info::name) + llvm::Twine("-") +
|
|
llvm::Twine(i) + llvm::Twine(".yaml"))
|
|
.str();
|
|
auto recorder_or_error =
|
|
DataRecorder::Create(GetRoot().CopyByAppendingPathComponent(filename));
|
|
if (!recorder_or_error) {
|
|
llvm::consumeError(recorder_or_error.takeError());
|
|
return nullptr;
|
|
}
|
|
|
|
m_data_recorders.push_back(std::move(*recorder_or_error));
|
|
return m_data_recorders.back().get();
|
|
}
|
|
|
|
void CommandProvider::Keep() {
|
|
std::vector<std::string> files;
|
|
for (auto &recorder : m_data_recorders) {
|
|
recorder->Stop();
|
|
files.push_back(recorder->GetFilename().GetPath());
|
|
}
|
|
|
|
FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
|
|
std::error_code ec;
|
|
llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
|
|
if (ec)
|
|
return;
|
|
yaml::Output yout(os);
|
|
yout << files;
|
|
}
|
|
|
|
void CommandProvider::Discard() { m_data_recorders.clear(); }
|
|
|
|
void VersionProvider::Keep() {
|
|
FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
|
|
std::error_code ec;
|
|
llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
|
|
if (ec)
|
|
return;
|
|
os << m_version << "\n";
|
|
}
|
|
|
|
void WorkingDirectoryProvider::Keep() {
|
|
FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
|
|
std::error_code ec;
|
|
llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
|
|
if (ec)
|
|
return;
|
|
os << m_cwd << "\n";
|
|
}
|
|
|
|
void ProviderBase::anchor() {}
|
|
char CommandProvider::ID = 0;
|
|
char FileProvider::ID = 0;
|
|
char ProviderBase::ID = 0;
|
|
char VersionProvider::ID = 0;
|
|
char WorkingDirectoryProvider::ID = 0;
|
|
const char *CommandProvider::Info::file = "command-interpreter.yaml";
|
|
const char *CommandProvider::Info::name = "command-interpreter";
|
|
const char *FileProvider::Info::file = "files.yaml";
|
|
const char *FileProvider::Info::name = "files";
|
|
const char *VersionProvider::Info::file = "version.txt";
|
|
const char *VersionProvider::Info::name = "version";
|
|
const char *WorkingDirectoryProvider::Info::file = "cwd.txt";
|
|
const char *WorkingDirectoryProvider::Info::name = "cwd";
|