revng-revng/lib/CliftPipes/Headers.cpp

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

#include "mlir/IR/BuiltinOps.h"
#include "mlir/IR/MLIRContext.h"
#include "mlir/Support/LogicalResult.h"

#include "revng/ABI/Definition.h"
#include "revng/Clift/CliftTypeInterfaces.h"
#include "revng/CliftEmitC/CEmitter.h"
#include "revng/CliftEmitC/CSemantics.h"
#include "revng/CliftEmitC/Headers.h"
#include "revng/CliftImportModel/ImportModel.h"
#include "revng/CliftPipes/CliftContainer.h"
#include "revng/CliftPipes/Headers.h"
#include "revng/PTML/CTokenEmitter.h"
#include "revng/PTML/PTMLEmitter.h"
#include "revng/Pipeline/RegisterPipe.h"

#include "HeaderContainers.h"

//
// Shared logic
//

using EmissionMode = revng::pypeline::piperuns::EmissionMode;
using PipeConfiguration = revng::pypeline::piperuns::CEmissionPipeConfiguration;

static void emitTypeAndGlobalHeaderImpl(llvm::raw_ostream &Out,
                                        mlir::ModuleOp Module,
                                        PipeConfiguration *PipeCfg = nullptr) {
  TypeEmitterConfiguration Configuration = {
    .TypeToOmit = {},
    .EmitMaximumEnumValue = false,
    .ExplicitPadding = true,
  };

  if (PipeCfg) {
    switch (PipeCfg->Mode) {
    case EmissionMode::Editable:
      Configuration.EmitMaximumEnumValue = true;
      Configuration.ExplicitPadding = false;
      break;

    case EmissionMode::Recompilable:
      Configuration.EmitMaximumEnumValue = false;
      Configuration.ExplicitPadding = true;
      break;

    default:
      revng_abort("Unsupported emission style.");
    };
  }

  ptml::CTokenEmitter Tokens(Out,
                             PipeCfg && PipeCfg->DisableMarkup ?
                               ptml::Tagging::Disabled :
                               ptml::Tagging::Enabled);
  emitTypeAndGlobalHeader(Tokens, Module, Configuration);

  Out.flush();
}

static void
emitHelperHeaderImpl(llvm::raw_ostream &Out,
                     std::vector<mlir::ModuleOp> Modules,
                     const model::Binary &Binary,
                     ptml::Tagging Tagging = ptml::Tagging::Enabled) {
  ptml::CTokenEmitter Tokens(Out, Tagging);
  emitHelperHeader(Tokens, Modules, Binary);

  Out.flush();
}

static void emitTypeDefinitionImpl(llvm::raw_ostream &Out,
                                   mlir::ModuleOp Module,
                                   const CDataModel &DataModel,
                                   const model::TypeDefinition &Type,
                                   PipeConfiguration *PipeCfg = nullptr) {
  TypeEmitterConfiguration Configuration = {
    .TypeToOmit = {},
    .EmitMaximumEnumValue = true,
    .ExplicitPadding = false,
  };

  if (PipeCfg) {
    switch (PipeCfg->Mode) {
    case EmissionMode::Editable:
      Configuration.EmitMaximumEnumValue = true;
      Configuration.ExplicitPadding = false;
      break;

    case EmissionMode::Recompilable:
      Configuration.EmitMaximumEnumValue = false;
      Configuration.ExplicitPadding = true;
      break;

    default:
      revng_abort("Unsupported emission style.");
    };
  }

  ptml::CTokenEmitter Tokens(Out,
                             not PipeCfg || PipeCfg->DisableMarkup ?
                               ptml::Tagging::Disabled :
                               ptml::Tagging::Enabled);

  // TODO: Extend `importType` to be able to signal whether a type already
  //       exists or if it was reimported.
  auto CliftType = clift::importType(Module.getContext(), Type);
  revng_check(CliftType != nullptr);

  emitSingleTypeDefinition(Tokens, DataModel, CliftType, Configuration);

  Out.flush();
}

//
// Old style pipes
//

namespace {

class TypeAndGlobalHeaderPipe {
public:
  static constexpr auto Name = "emit-type-and-global-header";

  std::array<pipeline::ContractGroup, 1> getContract() const {
    using namespace pipeline;
    using namespace revng::kinds;

    return { ContractGroup({ Contract(CliftModule,
                                      0,
                                      TypeAndGlobalHeader,
                                      1,
                                      InputPreservation::Preserve) }) };
  }

  void run(pipeline::ExecutionContext &EC,
           const revng::pipes::CliftContainer &CliftContainer,
           TypeAndGlobalHeaderContainer &HeaderFile) {
    llvm::raw_string_ostream Stream = HeaderFile.asStream();
    emitTypeAndGlobalHeaderImpl(Stream, CliftContainer.getModule());
    EC.commitUniqueTarget(HeaderFile);
  }
};

static pipeline::RegisterPipe<TypeAndGlobalHeaderPipe> TypeAndGlobalHeader;

class HelperHeaderPipe {
public:
  static constexpr auto Name = "emit-helper-header";

  std::array<pipeline::ContractGroup, 1> getContract() const {
    using namespace pipeline;
    using namespace revng::kinds;

    return { ContractGroup({ Contract(CliftFunction,
                                      0,
                                      HelperHeader,
                                      1,
                                      InputPreservation::Preserve) }) };
  }

  void run(pipeline::ExecutionContext &EC,
           const revng::pipes::CliftFunctionContainer &CliftContainer,
           HelperHeaderContainer &HeaderFile) {
    llvm::raw_string_ostream Stream = HeaderFile.asStream();
    emitHelperHeaderImpl(Stream,
                         { CliftContainer.getModule() },
                         *revng::getModelFromContext(EC));
    EC.commitUniqueTarget(HeaderFile);
  }
};

static pipeline::RegisterPipe<HelperHeaderPipe> HelperHeader;

class SingleTypeDefinitionPipe {
public:
  static constexpr auto Name = "emit-single-type-definition";

  std::array<pipeline::ContractGroup, 1> getContract() const {
    using namespace pipeline;
    using namespace revng::kinds;

    return { ContractGroup({ Contract(CliftModule,
                                      0,
                                      SingleTypeDefinition,
                                      1,
                                      InputPreservation::Preserve) }) };
  }

  void run(pipeline::ExecutionContext &EC,
           const revng::pipes::CliftContainer &CliftContainer,
           TypeDefinitionContainer &ModelTypesContainer) {
    mlir::ModuleOp Module = CliftContainer.getModule();
    auto DataModel = abi::getDataModel(*revng::getModelFromContext(EC));

    for (const model::TypeDefinition &Type :
         revng::getTypeDefinitionsAndCommit(EC, ModelTypesContainer.name())) {
      std::string &Result = ModelTypesContainer[Type.key()];
      llvm::raw_string_ostream Out(Result);
      emitTypeDefinitionImpl(Out, Module, DataModel, Type);
    }
  }
};

static pipeline::RegisterPipe<SingleTypeDefinitionPipe> TypeDefinition;

} // namespace

//
// New style pipes
//

namespace revng::pypeline::piperuns {

void EmitTypeAndGlobalHeader::run() {
  std::unique_ptr<llvm::raw_ostream> Out = Output.getOStream(ObjectID());
  emitTypeAndGlobalHeaderImpl(*Out, Input.getModule(), &Configuration);
}

void EmitHelperHeader::run() {
  std::unique_ptr<llvm::raw_ostream> Out = Output.getOStream(ObjectID());

  std::vector<mlir::ModuleOp> FunctionModules;
  for (const auto &Object : Input.objects())
    FunctionModules.emplace_back(Input.getModule(Object));

  emitHelperHeaderImpl(*Out,
                       FunctionModules,
                       Binary,
                       Configuration.DisableMarkup ? ptml::Tagging::Disabled :
                                                     ptml::Tagging::Enabled);
}

using ESTD = EmitSingleTypeDefinition;
void ESTD::runOnTypeDefinition(const model::UpcastableTypeDefinition &Type) {
  revng_assert(Type);
  auto Stream = Output.getOStream(ObjectID(Type->key()));

  auto DataModel = abi::getDataModel(Binary);
  emitTypeDefinitionImpl(*Stream,
                         Input.getModule(),
                         DataModel,
                         *Type,
                         &Configuration);
}

} // namespace revng::pypeline::piperuns