revng-revng/lib/PipelineC/PipelineC.cpp

//
// This file is distributed under the MIT License. See LICENSE.md for details.
//

#include <cstdint>
#include <cstdlib>
#include <cstring>
#include <iterator>
#include <optional>
#include <string>
#include <vector>

#include "llvm/ADT/STLExtras.h"
#include "llvm/Support/DynamicLibrary.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/raw_ostream.h"

#include "revng/Pipeline/AllRegistries.h"
#include "revng/Pipeline/Container.h"
#include "revng/Pipeline/Runner.h"
#include "revng/Pipeline/Target.h"
#include "revng/PipelineC/PipelineC.h"
#include "revng/Pipes/ModelGlobal.h"
#include "revng/Pipes/PipelineManager.h"
#include "revng/Support/Assert.h"
#include "revng/Support/InitRevng.h"
#include "revng/TupleTree/TupleTreeDiff.h"

using namespace pipeline;
using namespace ::revng::pipes;

void rp_set_custom_abort_hook(AbortHook Hook) {
  setAbortHook(Hook);
}

/// Used when we want to return a stack allocated string. Copies the string onto
/// the heap and gives ownership of to the caller
static char *copyString(llvm::StringRef str) {
  char *ToReturn = (char *) malloc(sizeof(char) * (str.size() + 1));
  strncpy(ToReturn, str.data(), str.size());
  ToReturn[str.size()] = 0;
  return ToReturn;
}

static bool Initialized = false;

static bool loadLibraryPermanently(const char *LibraryPath) {
  revng_check(not Initialized);
  revng_check(LibraryPath != nullptr);

  std::string Msg;
  return llvm::sys::DynamicLibrary::LoadLibraryPermanently(LibraryPath, &Msg);
}

static std::optional<revng::InitRevng> InitRevngInstance = std::nullopt;

bool rp_initialize(int argc,
                   char *argv[],
                   int libraries_count,
                   const char *libraries_path[]) {
  if (Initialized)
    return false;

  revng_check(not InitRevngInstance.has_value());
  InitRevngInstance.emplace(argc, argv);

  llvm::cl::ParseCommandLineOptions(argc, argv);
  for (int I = 0; I < libraries_count; I++)
    if (loadLibraryPermanently(libraries_path[I]))
      return false;

  Initialized = true;

  Registry::runAllInitializationRoutines();
  return true;
}

bool rp_shutdown() {
  if (InitRevngInstance.has_value()) {
    InitRevngInstance.reset();
    return true;
  }
  return false;
}

static rp_manager *rp_manager_create_impl(uint64_t pipelines_count,
                                          const char *pipelines_path[],
                                          uint64_t pipeline_flags_count,
                                          const char *pipeline_flags[],
                                          const char *execution_directory,
                                          bool is_path = true) {
  revng_check(Initialized);
  revng_check(pipelines_path != nullptr);
  if (pipeline_flags == nullptr)
    revng_check(pipeline_flags_count == 0);
  revng_check(execution_directory != nullptr);

  std::vector<std::string> FlagsVector;
  for (size_t I = 0; I < pipeline_flags_count; I++)
    FlagsVector.push_back(pipeline_flags[I]);

  std::vector<std::string> Pipelines;
  for (size_t I = 0; I < pipelines_count; I++)
    Pipelines.push_back(pipelines_path[I]);
  auto Pipeline = is_path ?
                    PipelineManager::create(Pipelines,
                                            FlagsVector,
                                            execution_directory) :
                    PipelineManager::createFromMemory(Pipelines,
                                                      FlagsVector,
                                                      execution_directory);
  if (not Pipeline) {
    auto Error = Pipeline.takeError();
    llvm::errs() << Error;
    llvm::consumeError(std::move(Error));
    return nullptr;
  }

  auto manager = new PipelineManager(std::move(*Pipeline));
  return manager;
}

rp_manager *rp_manager_create_from_string(uint64_t pipelines_count,
                                          const char *pipelines[],
                                          uint64_t pipeline_flags_count,
                                          const char *pipeline_flags[],
                                          const char *execution_directory) {
  return rp_manager_create_impl(pipelines_count,
                                pipelines,
                                pipeline_flags_count,
                                pipeline_flags,
                                execution_directory,
                                false);
}

rp_manager *rp_manager_create(uint64_t pipelines_count,
                              const char *pipelines_path[],
                              uint64_t pipeline_flags_count,
                              const char *pipeline_flags[],
                              const char *execution_directory) {
  return rp_manager_create_impl(pipelines_count,
                                pipelines_path,
                                pipeline_flags_count,
                                pipeline_flags,
                                execution_directory);
}

rp_manager *rp_manager_create_memory_only(const char *pipeline_path,
                                          uint64_t flags_count,
                                          const char *flags[]) {
  const char *paths[1] = { pipeline_path };
  return rp_manager_create(1, paths, flags_count, flags, "");
}

bool rp_manager_save(rp_manager *manager, const char *path) {
  revng_check(manager != nullptr);

  llvm::StringRef DirPath;
  if (path != nullptr)
    DirPath = llvm::StringRef(path);

  auto Error = manager->storeToDisk(DirPath);
  if (not Error)
    return true;

  llvm::consumeError(std::move(Error));
  return false;
}

bool rp_step_save(rp_step *step, const char *path) {
  revng_check(step != nullptr);
  revng_check(path != nullptr);

  auto Error = step->storeToDisk(path);
  if (not Error)
    return true;

  llvm::consumeError(std::move(Error));
  return false;
}

bool rp_manager_save_context(rp_manager *manager, const char *path) {
  revng_check(manager != nullptr);
  revng_check(path != nullptr);

  auto Error = manager->context().storeToDisk(path);
  if (not Error)
    return true;

  llvm::consumeError(std::move(Error));
  return false;
}

void rp_manager_destroy(rp_manager *manager) {
  revng_check(manager != nullptr);
  delete manager;
}

uint64_t rp_manager_steps_count(rp_manager *manager) {
  revng_check(manager != nullptr);
  return manager->getRunner().size();
}

uint64_t rp_manager_step_name_to_index(rp_manager *manager, const char *name) {
  revng_check(manager != nullptr);
  revng_check(name != nullptr);
  size_t I = 0;
  for (const auto &Step : manager->getRunner()) {
    if (Step.getName() == name)
      return I;
    I++;
  }

  return RP_STEP_NOT_FOUND;
}
rp_step *rp_manager_get_step(rp_manager *manager, uint64_t index) {
  revng_check(manager != nullptr);
  revng_check(index < manager->getRunner().size());
  return &(*(std::next(manager->getRunner().begin(), index)));
}

const char *rp_step_get_name(rp_step *step) {
  revng_check(step != nullptr);
  return step->getName().data();
}

int rp_step_get_analyses_count(rp_step *step) {
  return step->getAnalysesSize();
}

rp_analysis *rp_step_get_analysis(rp_step *step, int index) {
  revng_check(step != nullptr);
  if (index >= rp_step_get_analyses_count(step))
    return nullptr;

  return &*(std::next(step->analysesBegin(), index));
}

rp_container *
rp_step_get_container(rp_step *step, rp_container_identifier *container) {
  revng_check(step != nullptr);
  revng_check(container != nullptr);
  if (step->containers().isContainerRegistered(container->first())) {
    step->containers()[container->first()];
    return &*step->containers().find(container->first());
  } else {
    return nullptr;
  }
}

rp_kind *rp_step_get_artifacts_kind(rp_step *step) {
  revng_check(step != nullptr);
  return step->getArtifactsKind();
}

rp_container *rp_step_get_artifacts_container(rp_step *step) {
  revng_check(step != nullptr);
  return step->getArtifactsContainer();
}

const char *rp_step_get_artifacts_single_target_filename(rp_step *step) {
  revng_check(step != nullptr);
  return copyString(step->getArtifactsSingleTargetFilename());
}

uint64_t rp_targets_list_targets_count(rp_targets_list *targets_list) {
  revng_check(targets_list != nullptr);
  return targets_list->size();
}

rp_kind *
rp_manager_get_kind_from_name(rp_manager *manager, const char *kind_name) {
  revng_check(manager != nullptr);
  revng_check(kind_name != nullptr);

  return manager->getKind(kind_name);
}

const char *rp_kind_get_name(rp_kind *kind) {
  revng_check(kind != nullptr);
  return kind->name().data();
}

rp_kind *rp_kind_get_parent(rp_kind *kind) {
  revng_check(kind != nullptr);
  return kind->parent();
}

rp_diff_map *rp_manager_run_analysis(rp_manager *manager,
                                     uint64_t targets_count,
                                     rp_target *targets[],
                                     const char *step_name,
                                     const char *analysis_name,
                                     rp_container *container) {
  revng_check(manager != nullptr);
  revng_check(targets_count != 0);
  revng_check(targets != nullptr);
  revng_check(analysis_name != nullptr);
  revng_check(container != nullptr);

  ContainerToTargetsMap Targets;
  for (size_t I = 0; I < targets_count; I++)
    Targets[container->second->name()].push_back(*targets[I]);

  auto MaybeDiffs = manager->runAnalysis(analysis_name, step_name, Targets);
  if (not MaybeDiffs) {
    llvm::consumeError(MaybeDiffs.takeError());
    return nullptr;
  }

  return new rp_diff_map(std::move(*MaybeDiffs));
}

void rp_diff_map_destroy(rp_diff_map *to_free) {
  delete to_free;
}

const char *rp_diff_map_get_diff(rp_diff_map *map, const char *global_name) {
  auto It = map->find(global_name);
  if (It == map->end())
    return nullptr;

  std::string S;
  llvm::raw_string_ostream OS(S);
  It->second.serialize(OS);
  OS.flush();
  return copyString(S);
}

const char *rp_manager_produce_targets(rp_manager *manager,
                                       uint64_t targets_count,
                                       rp_target *targets[],
                                       rp_step *step,
                                       rp_container *container) {
  revng_check(manager != nullptr);
  revng_check(targets_count != 0);
  revng_check(targets != nullptr);
  revng_check(step != nullptr);
  revng_check(container != nullptr);

  ContainerToTargetsMap Targets;
  for (size_t I = 0; I < targets_count; I++)
    Targets[container->second->name()].push_back(*targets[I]);

  auto Error = manager->getRunner().run(step->getName(), Targets);
  if (Error) {
    llvm::consumeError(std::move(Error));
    return nullptr;
  }

  std::string Out;
  llvm::raw_string_ostream Serialized(Out);
  const auto &ToFilter = Targets[container->second->name()];
  const auto &Cloned = container->second->cloneFiltered(ToFilter);
  llvm::cantFail(Cloned->serialize(Serialized));
  Serialized.flush();

  return copyString(Out);
}

rp_target *rp_target_create(rp_kind *kind,
                            int is_exact,
                            uint64_t path_components_count,
                            const char *path_components[]) {
  revng_check(kind != nullptr);
  revng_check(path_components != nullptr);
  revng_check(kind->rank().depth() == path_components_count);
  PathComponents List;
  for (size_t I = 0; I < path_components_count; I++) {

    llvm::StringRef Rank(path_components[I]);
    List.push_back(Rank == "*" ? PathComponent::all() :
                                 PathComponent(Rank.str()));
  }

  auto Exact = is_exact ? Exactness::Exact : Exactness::DerivedFrom;
  return new Target(std::move(List), *kind, Exact);
}

void rp_target_destroy(rp_target *target) {
  revng_check(target != nullptr);
  delete target;
}

uint64_t rp_manager_kinds_count(rp_manager *manager) {
  revng_check(manager != nullptr);
  return manager->getRunner().getKindsRegistry().size();
}

rp_kind *rp_manager_get_kind(rp_manager *manager, uint64_t index) {
  revng_check(manager != nullptr);
  revng_check(index < manager->getRunner().getKindsRegistry().size());
  return &*std::next(manager->getRunner().getKindsRegistry().begin(), index);
}

bool rp_container_store(rp_container *container, const char *path) {
  revng_check(container != nullptr);
  revng_check(path != nullptr);
  auto Error = container->second->storeToDisk(path);
  if (not Error)
    return true;

  llvm::consumeError(std::move(Error));
  return false;
}

bool rp_manager_container_deserialize(rp_manager *manager,
                                      rp_step *step,
                                      const char *container_name,
                                      const char *content,
                                      uint64_t size) {
  revng_check(manager != nullptr);
  revng_check(step != nullptr);
  revng_check(container_name != nullptr);
  revng_check(content != nullptr);

  auto Buffer = llvm::MemoryBuffer::getMemBuffer(llvm::StringRef(content, size),
                                                 "",
                                                 false);
  auto Error = manager->deserializeContainer(*step, container_name, *Buffer);
  if (!!Error) {
    llvm::consumeError(std::move(Error));
    return false;
  }
  return true;
}

rp_kind *rp_target_get_kind(rp_target *target) {
  revng_check(target != nullptr);
  return &target->getKind();
}

bool rp_target_is_exact(rp_target *target) {
  revng_check(target != nullptr);
  return target->kindExactness() == Exactness::Exact;
}
uint64_t rp_target_path_components_count(rp_target *target) {
  revng_check(target != nullptr);
  return target->getPathComponents().size();
}
const char *rp_target_get_path_component(rp_target *target, uint64_t index) {
  revng_check(target != nullptr);
  auto &PathComponents = target->getPathComponents();
  revng_check(index < PathComponents.size());

  if (PathComponents[index].isAll())
    return "*";

  return PathComponents[index].getName().c_str();
}

char *rp_manager_create_container_path(rp_manager *manager,
                                       const char *step_name,
                                       const char *container_name) {
  revng_check(manager != nullptr);
  revng_check(step_name != nullptr);
  revng_check(container_name != nullptr);

  if (manager->executionDirectory().empty())
    return nullptr;

  llvm::SmallString<128> Path;
  llvm::sys::path::append(Path,
                          manager->executionDirectory(),
                          step_name,
                          container_name);
  return copyString(Path);
}

rp_targets_list *
rp_manager_get_container_targets_list(rp_manager *manager,
                                      rp_container *container) {
  revng_check(manager != nullptr);
  revng_check(container != nullptr);

  return manager->getTargetsAvailableFor(*container);
}

rp_target *
rp_targets_list_get_target(rp_targets_list *targets_list, uint64_t index) {
  revng_check(targets_list != nullptr);
  revng_check(index < targets_list->size());
  return &(*targets_list)[index];
}

void rp_string_destroy(char *string) {
  revng_check(string != nullptr);
  free(string);
}

uint64_t rp_manager_containers_count(rp_manager *manager) {
  revng_check(manager != nullptr);
  return manager->getRunner().registeredContainersCount();
}

rp_container_identifier *
rp_manager_get_container_identifier(rp_manager *manager, uint64_t index) {
  revng_check(manager != nullptr);
  const auto &ContainerRegistry = manager->getRunner().getContainerFactorySet();
  revng_check(index < ContainerRegistry.size());
  return &*std::next(ContainerRegistry.begin(), index);
}

const char *rp_container_get_name(rp_container *container) {
  revng_check(container != nullptr);
  return container->second->name().data();
}

const char *
rp_container_identifier_get_name(rp_container_identifier *identifier) {
  revng_check(identifier != nullptr);
  return identifier->first().data();
}

char *rp_target_create_serialized_string(rp_target *target) {
  revng_check(target != nullptr);
  return copyString(target->serialize());
}

rp_target *
rp_target_create_from_string(rp_manager *manager, const char *string) {
  revng_check(manager != nullptr);
  revng_check(string != nullptr);
  auto MaybeTarget = parseTarget(string, manager->context().getKindsRegistry());
  if (MaybeTarget)
    return new Target(std::move(*MaybeTarget));

  llvm::consumeError(MaybeTarget.takeError());
  return nullptr;
}

bool rp_target_is_ready(rp_target *target, rp_container *container) {
  revng_assert(target);
  revng_assert(container);
  return container->second->enumerate().contains(*target);
}

/// TODO Remove the redundant copy by writing a custom string stream that writes
/// direclty to a buffer to return.
const char *
rp_manager_create_global_copy(rp_manager *manager, const char *global_name) {
  std::string Out;
  llvm::raw_string_ostream Serialized(Out);
  auto &GlobalsMap = manager->context().getGlobals();
  if (auto Error = GlobalsMap.serialize(global_name, Serialized); Error) {
    llvm::consumeError(std::move(Error));
    return nullptr;
  }
  Serialized.flush();
  return copyString(Out);
}

int rp_manager_get_globals_count(rp_manager *manager) {
  return manager->context().getGlobals().size();
}

const char *rp_manager_get_global_name(rp_manager *manager, int index) {
  if (index < rp_manager_get_globals_count(manager))
    return copyString(manager->context().getGlobals().getName(index).str());
  return nullptr;
}

template<bool commit>
inline bool rp_manager_set_global_impl(rp_manager *manager,
                                       const char *serialized,
                                       const char *global_name,
                                       rp_error_list *error_list) {
  revng_check(manager != nullptr);
  revng_check(serialized != nullptr);
  revng_check(global_name != nullptr);
  ErrorListWrapper EL(error_list);
  revng_check(EL->empty());

  auto &GlobalsMap = manager->context().getGlobals();
  auto Buffer = llvm::MemoryBuffer::getMemBuffer(serialized);

  auto MaybeNewGlobal = GlobalsMap.createNew(global_name, *Buffer);
  if (!MaybeNewGlobal)
    return EL->fail(MaybeNewGlobal.takeError(), false);

  if (MaybeNewGlobal->get()->verify(*EL); *EL)
    return false;

  if constexpr (commit) {
    auto &NewGlobal = MaybeNewGlobal.get();
    return EL->failIf(GlobalsMap.replace(global_name, std::move(NewGlobal)));
  }

  return true;
}

bool rp_manager_set_global(rp_manager *manager,
                           const char *serialized,
                           const char *global_name,
                           rp_error_list *error_list) {
  return rp_manager_set_global_impl<true>(manager,
                                          serialized,
                                          global_name,
                                          error_list);
}

bool rp_manager_verify_global(rp_manager *manager,
                              const char *serialized,
                              const char *global_name,
                              rp_error_list *error_list) {
  return rp_manager_set_global_impl<false>(manager,
                                           serialized,
                                           global_name,
                                           error_list);
}

template<bool commit>
inline bool rp_manager_apply_diff_impl(rp_manager *manager,
                                       const char *diff,
                                       const char *global_name,
                                       rp_error_list *error_list) {
  revng_check(manager != nullptr);
  revng_check(diff != nullptr);
  revng_check(global_name != nullptr);
  ErrorListWrapper EL(error_list);
  revng_check(EL->empty());

  auto &GlobalsMap = manager->context().getGlobals();
  auto Buffer = llvm::MemoryBuffer::getMemBuffer(diff);

  auto GlobalCloneOrError = GlobalsMap.clone(global_name);
  if (!GlobalCloneOrError)
    return EL->fail(GlobalCloneOrError.takeError(), false);

  auto &GlobalClone = GlobalCloneOrError.get();

  if (auto DiffError = GlobalClone->applyDiff(*Buffer); DiffError)
    return EL->fail(std::move(DiffError), false);

  if (GlobalClone->verify(*EL); *EL)
    return false;

  if constexpr (commit)
    return EL->failIf(GlobalsMap.replace(global_name, std::move(GlobalClone)));

  return true;
}

bool rp_manager_apply_diff(rp_manager *manager,
                           const char *diff,
                           const char *global_name,
                           rp_error_list *error_list) {
  return rp_manager_apply_diff_impl<true>(manager,
                                          diff,
                                          global_name,
                                          error_list);
}

bool rp_manager_verify_diff(rp_manager *manager,
                            const char *diff,
                            const char *global_name,
                            rp_error_list *error_list) {
  return rp_manager_apply_diff_impl<false>(manager,
                                           diff,
                                           global_name,
                                           error_list);
}

uint64_t rp_ranks_count() {
  return Rank::getAll().size();
}

rp_rank *rp_rank_get(uint64_t index) {
  revng_check(index < Rank::getAll().size());
  return Rank::getAll()[index];
}

rp_rank *rp_rank_get_from_name(const char *rank_name) {
  revng_check(rank_name != nullptr);
  for (auto rank : Rank::getAll()) {
    if (rank->name() == rank_name) {
      return rank;
    }
  }
  return nullptr;
}

const char *rp_rank_get_name(rp_rank *rank) {
  revng_check(rank != nullptr);
  return rank->name().data();
}

uint64_t rp_rank_get_depth(rp_rank *rank) {
  revng_check(rank != nullptr);
  return rank->depth();
}

rp_rank *rp_rank_get_parent(rp_rank *rank) {
  revng_check(rank != nullptr);
  return rank->parent();
}

rp_rank *rp_kind_get_rank(rp_kind *kind) {
  revng_check(kind != nullptr);
  return &kind->rank();
}

rp_step *rp_step_get_parent(rp_step *step) {
  revng_check(step != nullptr);
  if (step->hasPredecessor()) {
    return &step->getPredecessor();
  } else {
    return nullptr;
  }
}

const char *rp_container_get_mime(rp_container *container) {
  revng_check(container != nullptr);
  return container->getValue()->mimeType().c_str();
}

const char *
rp_container_extract_one(rp_container *container, rp_target *target) {
  revng_check(container->second->enumerate().contains(*target));

  std::string Out;
  llvm::raw_string_ostream Serialized(Out);
  llvm::cantFail(container->second->extractOne(Serialized, *target));
  Serialized.flush();

  return copyString(Out);
}

const char *rp_analysis_get_name(rp_analysis *analysis) {
  return analysis->second->getUserBoundName().c_str();
}

int rp_analysis_get_arguments_count(rp_analysis *analysis) {
  return analysis->second->getRunningContainersNames().size();
}

const char *rp_analysis_get_argument_name(rp_analysis *analysis, int index) {
  revng_check(index < rp_analysis_get_arguments_count(analysis));
  std::string Name = analysis->second->getRunningContainersNames()[index];

  return copyString(Name);
}

int rp_analysis_get_argument_acceptable_kinds_count(rp_analysis *analysis,
                                                    int argument_index) {
  return analysis->second->getAcceptedKinds(argument_index).size();
}

const rp_kind *rp_analysis_get_argument_acceptable_kind(rp_analysis *analysis,
                                                        int argument_index,
                                                        int kind_index) {
  const auto &Accepted = analysis->second->getAcceptedKinds(argument_index);
  if (static_cast<size_t>(kind_index) >= Accepted.size())
    return nullptr;
  return Accepted[kind_index];
}

rp_diff_map *rp_manager_run_all_analyses(rp_manager *manager) {
  auto MaybeDiffs = manager->runAllAnalyses();
  if (not MaybeDiffs) {
    llvm::consumeError(MaybeDiffs.takeError());
    return nullptr;
  }

  return new rp_diff_map(std::move(*MaybeDiffs));
}

bool rp_diff_map_is_empty(rp_diff_map *map) {
  for (auto &Entry : *map) {
    if (!Entry.second.isEmpty()) {
      return false;
    }
  }
  return true;
}

rp_error_list *rp_make_error_list() {
  return new ErrorList();
}

bool rp_error_list_is_empty(rp_error_list *error_list) {
  revng_check(error_list != nullptr);
  return error_list->empty();
}

uint64_t rp_error_list_size(rp_error_list *error_list) {
  revng_check(error_list != nullptr);
  return error_list->size();
}

const char *
rp_error_list_get_error_message(rp_error_list *error_list, uint64_t index) {
  revng_check(error_list != nullptr);
  std::string Out;
  llvm::raw_string_ostream Serialized(Out);
  Serialized << *error_list->get(index);
  Serialized.flush();

  return copyString(Out);
}

void rp_error_list_destroy(rp_error_list *error_list) {
  revng_check(error_list != nullptr);
  delete error_list;
}