revng-revng/include/revng/Model/LoadModelPass.h

#pragma once

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

#include <variant>

#include "llvm/IR/PassManager.h"
#include "llvm/Pass.h"

#include "revng/Model/Binary.h"

inline const char *ModelMetadataName = "revng.model";

TupleTree<model::Binary> loadModel(const llvm::Module &M);

bool hasModel(const llvm::Module &M);

class ModelWrapper {
private:
  TupleTree<model::Binary> TheBinary;
  bool HasChanged = false;

public:
  ModelWrapper(TupleTree<model::Binary> &&TheBinary) :
    TheBinary(std::move(TheBinary)) {}

  ModelWrapper() = default;

public:
  const model::Binary &getReadOnlyModel() const { return *TheBinary; }
  const TupleTree<model::Binary> &getReadOnlyTreeModel() const {
    return TheBinary;
  }

  TupleTree<model::Binary> &getWriteableModel() {
    HasChanged = true;
    return TheBinary;
  }

  bool hasChanged() const { return HasChanged; }

  template<typename IRUnitT, typename PreservedAnalysesT, typename InvalidatorT>
  bool invalidate(IRUnitT &, const PreservedAnalysesT &, InvalidatorT &) {
    return false;
  }
};

class LoadModelWrapperPass : public llvm::ImmutablePass {
public:
  static char ID;

private:
  std::variant<ModelWrapper *, ModelWrapper> Wrapper;

public:
  LoadModelWrapperPass() : llvm::ImmutablePass(ID), Wrapper(ModelWrapper()) {}
  LoadModelWrapperPass(ModelWrapper &Wrapper) :
    llvm::ImmutablePass(ID), Wrapper(&Wrapper) {}

public:
  bool doInitialization(llvm::Module &M) override final;
  bool doFinalization(llvm::Module &M) override final;

public:
  ModelWrapper &get() {
    if (isModelExternal())
      return *std::get<ModelWrapper *>(Wrapper);
    else
      return std::get<ModelWrapper>(Wrapper);
  }

private:
  bool isModelExternal() {
    return std::holds_alternative<ModelWrapper *>(Wrapper);
  }
};

class LoadModelAnalysis : public llvm::AnalysisInfoMixin<LoadModelAnalysis> {
  friend llvm::AnalysisInfoMixin<LoadModelAnalysis>;
  static llvm::AnalysisKey Key;

public:
  using Result = ModelWrapper;

  Result run(llvm::Module &M, llvm::ModuleAnalysisManager &);
  Result run(llvm::Function &F, llvm::FunctionAnalysisManager &);
};