revng-revng/tools/pipeline/pipe/Main.cpp

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

#include <iostream>

#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/DynamicLibrary.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/PluginLoader.h"
#include "llvm/Support/raw_os_ostream.h"

#include "revng/Model/LoadModelPass.h"
#include "revng/Pipeline/AllRegistries.h"
#include "revng/Pipeline/ContainerSet.h"
#include "revng/Pipeline/CopyPipe.h"
#include "revng/Pipeline/GenericLLVMPipe.h"
#include "revng/Pipeline/LLVMContainerFactory.h"
#include "revng/Pipeline/LLVMKind.h"
#include "revng/Pipeline/Loader.h"
#include "revng/Pipeline/Target.h"
#include "revng/Pipes/ModelGlobal.h"
#include "revng/Pipes/PipelineManager.h"
#include "revng/Support/Debug.h"
#include "revng/Support/InitRevng.h"

namespace cl = llvm::cl;
using namespace pipeline;
using namespace ::revng::pipes;
using namespace ::revng;

static cl::list<std::string> Arguments(cl::Positional,
                                       cl::ZeroOrMore,
                                       cl::desc("<pipe> <containers>..."),
                                       cl::cat(MainCategory));

static cl::list<std::string>
  InputPipeline("P", cl::desc("<Pipeline>"), cl::cat(MainCategory));

static cl::list<std::string> EnablingFlags("f",
                                           cl::desc("list of pipeline enabling "
                                                    "flags"),
                                           cl::cat(MainCategory));

static cl::alias A1("l",
                    cl::desc("Alias for --load"),
                    cl::aliasopt(llvm::LoadOpt),
                    cl::cat(MainCategory));

static llvm::ExitOnError AbortOnError;

int main(int argc, char *argv[]) {
  using revng::FilePath;

  revng::InitRevng X(argc, argv, "", { &MainCategory });

  Registry::runAllInitializationRoutines();

  auto
    Manager = AbortOnError(revng::pipes::PipelineManager::create(InputPipeline,
                                                                 EnablingFlags,
                                                                 ""));
  const pipeline::Loader &Loader = Manager.getLoader();
  const llvm::StringMap<PipeWrapper> &PipesMap = Loader.getPipes();

  if (Arguments.size() < 2 or PipesMap.count(Arguments[0]) == 0) {
    llvm::outs() << "USAGE: revng-pipe [options] <pipe> <model> <args>...\n\n";
    llvm::outs() << "<pipe> can be one of:\n\n";

    for (auto &Pair : PipesMap) {
      llvm::outs() << "revng pipe " << Pair.first() << " <model> ";

      for (size_t I = 0; I < Pair.second.Pipe->getContainerArgumentsCount();
           I++) {
        llvm::outs() << "<" << Pair.second.Pipe->getContainerName(I) << "> ";
      }
      llvm::outs() << "\n";
    }

    return EXIT_SUCCESS;
  }

  llvm::StringRef PipeArgument = Arguments[0];
  llvm::StringRef ModelArgument = Arguments[1];

  auto ContainerArguments = llvm::ArrayRef<std::string>(Arguments)
                              .drop_front(2);

  const auto &Name = ModelGlobalName;
  auto *Model(cantFail(Manager.context().getGlobal<ModelGlobal>(Name)));
  FilePath InputFilePath = FilePath::fromLocalStorage(ModelArgument);
  AbortOnError(InputFilePath.check());
  AbortOnError(Model->load(InputFilePath));

  const auto &Pipe = PipesMap.find(PipeArgument)->second.Pipe;
  std::vector<std::string> DefaultNames;
  pipeline::ContainerSet Set;

  size_t PipeContainerCount = Pipe->getContainerArgumentsCount();

  llvm::SmallVector<llvm::StringRef> InputArguments;
  llvm::SmallVector<llvm::StringRef> OutputArguments;
  size_t ExpectedArgumentCount = PipeContainerCount;

  for (size_t I = 0, J = 0; I < Pipe->getContainerArgumentsCount(); ++I) {
    if (J < ContainerArguments.size())
      InputArguments.push_back(ContainerArguments[J++]);

    if (not Pipe->isContainerArgumentConst(I)) {
      if (J < ContainerArguments.size())
        OutputArguments.push_back(ContainerArguments[J++]);

      ++ExpectedArgumentCount;
    }

    DefaultNames.push_back((llvm::Twine("arg") + llvm::Twine(I)).str());
  }

  if (ContainerArguments.size() != ExpectedArgumentCount) {
    dbg << "Pipe " << PipeArgument.str() << " required "
        << ExpectedArgumentCount << " arguments\n";
    return EXIT_FAILURE;
  }

  PipeWrapper ClonedPipe(Pipe, DefaultNames);
  for (size_t I = 0; I < PipeContainerCount; I++) {
    llvm::StringRef Name = ClonedPipe.Pipe->getContainerName(I);
    auto &Factory = Loader.getContainerFactory(Name);
    Set.add(DefaultNames[I], Factory, Factory(DefaultNames[I]));
    FilePath Path = FilePath::fromLocalStorage(InputArguments[I]);
    AbortOnError(Path.check());
    AbortOnError(Set.at(DefaultNames[I]).load(Path));
  }

  auto Enumeration = Set.enumerate();
  ClonedPipe.Pipe->deduceResults(Manager.context(), Enumeration);

  ExecutionContext ExecutionContext(Manager.context(),
                                    &ClonedPipe,
                                    Enumeration);

  AbortOnError(ClonedPipe.Pipe->run(ExecutionContext, Set));

  for (size_t I = 0, J = 0; I < PipeContainerCount; I++) {
    if (not Pipe->isContainerArgumentConst(I)) {
      FilePath Path = FilePath::fromLocalStorage(OutputArguments[J++]);
      AbortOnError(Path.check());
      AbortOnError(Set.at(DefaultNames[I]).store(Path));
    }
  }

  return EXIT_SUCCESS;
}