revng-revng/tests/unit/AutoEnforcer.cpp

/// \file AutoEnforcer.cpp
/// \brief Tests for Auto Enforcer

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

#include <memory>

#include "llvm/ADT/StringRef.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/Pass.h"
#include "llvm/Support/Casting.h"
#include "llvm/Transforms/Utils/Cloning.h"

#include "revng/AutoEnforcer/AutoEnforcer.h"
#include "revng/AutoEnforcer/AutoEnforcerErrors.h"
#include "revng/AutoEnforcer/AutoEnforcerTarget.h"
#include "revng/AutoEnforcer/BackingContainerRegistry.h"
#include "revng/AutoEnforcer/LLVMEnforcer.h"

#define BOOST_TEST_MODULE AutoEnforcer
bool init_unit_test();
#include "boost/test/unit_test.hpp"

#include "revng/UnitTestHelpers/UnitTestHelpers.h"

using namespace Model;
using namespace std;

static Granularity Root("Root");
static Granularity Function("Function", Root);
static Kind RootKind("RootKind", &Root);
static Kind RootKind2("RootKind2", RootKind, &Root);
static Kind FunctionKind("FunctionKind", &Function);

static std::string CName = "ContainerName";

class MapContainer : public BackingContainer<MapContainer> {
public:
  MapContainer(std::map<AutoEnforcerTarget, int> map) :
    BackingContainer<MapContainer>(), map(std::move(map)) {}
  MapContainer() = default;
  ~MapContainer() override = default;
  using TargertContainer = BackingContainersStatus::TargetContainer;

  unique_ptr<BackingContainerBase>
  cloneFiltered(const TargertContainer &Container) const final {
    return make_unique<MapContainer>(map);
  }

  bool contains(const AutoEnforcerTarget &Target) const final {
    if (Target.getQuantifiers().back().isAll())
      return map.count(AutoEnforcerTarget("f1", FunctionKind))
             and map.count(AutoEnforcerTarget("f2", FunctionKind));
    return map.count(Target);
  }

  void mergeBackDerived(MapContainer &Container) override {
    for (auto &Pair : Container.map)
      map.insert(std::move(Pair));
  }

  bool remove(const AutoEnforcerTarget &Target) override {
    if (map.find(Target) == map.end())
      return false;

    map.erase(Target);
    return true;
  }

  static char ID;

  auto &get(AutoEnforcerTarget Target) { return map[std::move(Target)]; }
  const auto &get(const AutoEnforcerTarget &Target) const {
    return map.find(std::move(Target))->second;
  }
  auto &getMap() const { return map; }
  auto &getMap() { return map; }

private:
  std::map<AutoEnforcerTarget, int> map;
};

char MapContainer::ID;

static const AutoEnforcerTarget Target = { "name", RootKind };

struct Fixture {
  Fixture() {
    RootKind.assign();
    Root.assign();
    FunctionKind.assign();
  }
};

BOOST_AUTO_TEST_SUITE(s, *boost::unit_test::fixture<Fixture>())

BOOST_AUTO_TEST_CASE(BackingContainerIsa) {
  std::map<AutoEnforcerTarget, int> Map;
  Map[Target] = 1;

  auto Ptr = make_unique<MapContainer>(move(Map));
  BackingContainerBase *BasePtr = Ptr.get();
  BOOST_TEST(llvm::isa<MapContainer>(BasePtr));
  BOOST_TEST(llvm::cast<MapContainer>(BasePtr) != nullptr);
  BOOST_TEST(Ptr->get(Target) == 1);
}

BOOST_AUTO_TEST_CASE(BackingContainersCanBeCreated) {
  BackingContainers Containers;
  Containers.add(CName, make_unique<MapContainer>());
  BOOST_TEST(Containers.contains(CName));
  Containers.get<MapContainer>(CName).get(Target) = 1;
  BOOST_TEST(Containers.get<MapContainer>(CName).get(Target) == 1);
}

class TestEnforcer {

public:
  static constexpr auto Name = "TestEnforcer";

  std::array<InputOutputContract, 1> getContract() const {
    return {
      InputOutputContract(RootKind, KindExactness::Exact, 0, RootKind2, 0)
    };
  }

  void run(const MapContainer &Source, MapContainer &Target) {
    for (const auto &Element : Source.getMap())
      if (Element.first.getKind() == RootKind) {
        AutoEnforcerTarget NewTar = { Element.first.getQuantifiers(),
                                      RootKind2 };
        Target.get(NewTar) = Element.second;
      }
  }
};

BOOST_AUTO_TEST_CASE(EnforcerCanBeWrapper) {
  MapContainer Map;
  Map.get({ "name", RootKind }) = 1;
  TestEnforcer Enf;
  Enf.run(Map, Map);
  BOOST_TEST(Map.get({ "name", RootKind2 }) == 1);
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactPassForward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind);

  InputOutputContract Contract1(RootKind, KindExactness::Exact);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactExactForward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::Exact,
                                0,
                                RootKind2,
                                0);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind2));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractDerivedPassForward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind, KindExactness::DerivedFrom);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind2));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractDerivedExactForward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind,
                                0);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactPassBackward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind);

  InputOutputContract Contract1(RootKind, KindExactness::Exact);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactExactBackward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind,
                                KindExactness::Exact,
                                0,
                                RootKind2,
                                0);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractDerivedPassBackward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind, KindExactness::DerivedFrom);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind2));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractDerivedExactBackward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind2,
                                0);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::DerivedFrom));
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactExactFineGrainedBackward) {
  BackingContainersStatus Targets;
  Targets.add(CName, { "root", "f1" }, FunctionKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::Exact,
                                0,
                                FunctionKind,
                                0);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
  BOOST_TEST((Targets[CName][0].getQuantifiers().size() == 1));
  BOOST_TEST((Targets[CName][0].getQuantifiers()[0].getName() == "root"));
}

BOOST_AUTO_TEST_CASE(InputOutputContractExactExactFineGrainedForward) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("root", RootKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::Exact,
                                0,
                                FunctionKind,
                                0);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == FunctionKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
  BOOST_TEST((Targets[CName][0].getQuantifiers().size() == 2));
  BOOST_TEST((Targets[CName][0].getQuantifiers()[0].getName() == "root"));
  BOOST_TEST((Targets[CName][0].getQuantifiers()[1].isAll()));
}

BOOST_AUTO_TEST_CASE(InputOutputContractMupltipleInputTest) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);
  Targets[CName].emplace_back("name2", RootKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind2,
                                0);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][1].getKind() == RootKind));
  BOOST_TEST((Targets[CName][1].kindExactness() == KindExactness::DerivedFrom));
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractPreserved) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);
  Targets[CName].emplace_back("name2", RootKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind2,
                                0,
                                true);
  Contract1.deduceResults(Targets, { CName });
  BOOST_TEST((Targets[CName][2].getKind() == RootKind2));
  BOOST_TEST((Targets[CName][2].kindExactness() == KindExactness::Exact));

  BOOST_TEST((Targets[CName][1].getKind() == RootKind));
  BOOST_TEST((Targets[CName][1].kindExactness() == KindExactness::Exact));

  BOOST_TEST((Targets[CName][0].getKind() == RootKind2));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(InputOutputContractPreservedBackwardMain) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind2,
                                0,
                                true);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::DerivedFrom));
}

BOOST_AUTO_TEST_CASE(InputOutputContractPreservedBackwardSecondary) {
  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind);

  InputOutputContract Contract1(RootKind,
                                KindExactness::DerivedFrom,
                                0,
                                RootKind2,
                                0,
                                true);
  Contract1.deduceRequirements(Targets, { CName });
  BOOST_TEST((Targets[CName][0].getKind() == RootKind));
  BOOST_TEST((Targets[CName][0].kindExactness() == KindExactness::Exact));
}

BOOST_AUTO_TEST_CASE(StepCanCloneAndRun) {
  Model::Pipeline Pip;

  BackingContainers Containers;
  Containers.add(CName, make_unique<MapContainer>());
  Containers.get<MapContainer>(CName).get({ "name", RootKind }) = 1;

  Step Step("first_step",
            move(Containers),
            bindEnforcer<TestEnforcer>(CName, CName));

  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);
  auto Result = Step.cloneAndRun({});
  BOOST_TEST(Result.get<MapContainer>(CName).get({ "name", RootKind2 }) == 1);
}

BOOST_AUTO_TEST_CASE(PipelineCanBeManuallyExectued) {
  BackingContainerRegistry Registry;
  Registry.addDefaultConstruibleFactory<MapContainer>(CName);

  Model::Pipeline Pip;
  Pip.add(Step("first_step",
               Registry.createEmpty(),
               bindEnforcer<TestEnforcer>(CName, CName)));

  Pip.getStartingContainer<MapContainer>(CName).get({ "name", RootKind }) = 1;

  Pip.add(Step("End", Registry.createEmpty()));

  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);

  auto Res = Pip[0].cloneAndRun({});
  BOOST_TEST(Res.get<MapContainer>(CName).get({ "name", RootKind2 }) == 1);
  Pip[0].mergeBackingContainers(std::move(Res));
  const auto &StartingContainer = Pip.getStartingContainer<MapContainer>(CName);
  auto Val = StartingContainer.get({ "name", RootKind2 });
  BOOST_TEST(Val == 1);
}

BOOST_AUTO_TEST_CASE(SingleElementPipelineCanBeRunned) {
  Model::Pipeline Pip;

  BackingContainers Containers;
  Containers.add(CName, make_unique<MapContainer>());
  Containers.get<MapContainer>(CName).get({ "name", RootKind }) = 1;

  Pip.add(Step("first_step",
               move(Containers),
               bindEnforcer<TestEnforcer>(CName, CName)));
  BackingContainers &BCI = Pip.back().getBackingContainers();
  BOOST_TEST(BCI.get<MapContainer>(CName).get({ "name", RootKind }) == 1);

  BackingContainers Containers2;
  Containers2.add(CName, make_unique<MapContainer>());
  Pip.add(Step("End", move(Containers2)));

  BackingContainersStatus Targets;
  Targets[CName].emplace_back("name", RootKind2);
  auto Error = Pip.run(Targets);
  BOOST_TEST(!Error);
  BackingContainers &BC = Pip.back().getBackingContainers();
  BOOST_TEST(BC.get<MapContainer>(CName).get({ "name", RootKind2 }) == 1);
}

class FineGranerEnforcer {

public:
  static constexpr auto Name = "FinedGranedEnforcer";
  std::vector<InputOutputContract> getContract() const {
    return {
      InputOutputContract(RootKind, KindExactness::Exact, 0, FunctionKind, 1)
    };
  }

  void run(const MapContainer &Source, MapContainer &Target) {
    for (const auto &Element : Source.getMap()) {

      if (Element.first.getKind() != RootKind)
        continue;

      auto Quantifiers = Element.first.getQuantifiers();
      Quantifiers.emplace_back("f1");
      Target.get({ move(Quantifiers), FunctionKind }) = Element.second;

      Quantifiers = Element.first.getQuantifiers();
      Quantifiers.emplace_back("f2");
      Target.get({ move(Quantifiers), FunctionKind }) = Element.second;
    }
  }
};

BOOST_AUTO_TEST_CASE(SingleElementPipelineBackwardFinedGrained) {
  AutoEnforcer AE;
  AE.addDefaultConstruibleFactory<MapContainer>(CName);

  AE.addStep("first_step", bindEnforcer<FineGranerEnforcer>(CName, CName));
  AE.addStep("End");

  AE.getStartingContainer<MapContainer>(CName).get({ "Root", RootKind }) = 1;

  BackingContainersStatus Targets;
  Targets.add(CName, { "Root", "f1" }, FunctionKind);

  auto Error = AE.run(Targets);
  BOOST_TEST(!Error);
  const auto &FinalContainer = AE.getFinalContainer<MapContainer>(CName);
  AutoEnforcerTarget FinalTarget({ "Root", "f1" }, FunctionKind);
  auto Val = FinalContainer.get(FinalTarget);

  BOOST_TEST(Val == 1);
}

BOOST_AUTO_TEST_CASE(SingleElementPipelineFailure) {
  AutoEnforcer AE;
  AE.addDefaultConstruibleFactory<MapContainer>(CName);

  AE.addStep("first_step", bindEnforcer<FineGranerEnforcer>(CName, CName));
  AE.addStep("End");

  AE.getStartingContainer<MapContainer>(CName).get({ "Root", RootKind }) = 1;

  BackingContainersStatus Targets;
  Targets.add(CName, { "RootWRONG", "f1" }, FunctionKind);

  auto Error = AE.run(Targets);
  BOOST_TEST(!!Error);
  consumeError(std::move(Error));
}

static void makeF(llvm::Module &M, llvm::StringRef FName) {

  auto VoidType = llvm::Type::getVoidTy(M.getContext());
  auto *FType = llvm::FunctionType::get(VoidType, {});
  auto F = M.getOrInsertFunction(FName, FType);
  auto *Fun = llvm::dyn_cast<llvm::Function>(F.getCallee());
  auto *BB = llvm::BasicBlock::Create(M.getContext(), "bb", Fun);
  llvm::IRBuilder<> Builder(BB);
  Builder.SetInsertPoint(BB);
  Builder.CreateRet(nullptr);
}

struct FunctionInserterPass : public llvm::ModulePass {
  static char ID;
  FunctionInserterPass() : llvm::ModulePass(ID) {}

  bool runOnModule(llvm::Module &M) override {
    makeF(M, "f1");
    return true;
  }
};
char FunctionInserterPass::ID = '_';

struct IdentityPass : public llvm::ModulePass {
  static char ID;

  IdentityPass() : llvm::ModulePass(ID) {}

  bool runOnModule(llvm::Module &M) override { return true; }
};

char IdentityPass::ID = '_';

struct LLVMEnforcerPassFunctionCreator {
  static constexpr auto Name = "Function Creator";

  std::array<InputOutputContract, 1> getContract() const {
    return {
      InputOutputContract(RootKind, KindExactness::Exact, 0, FunctionKind)
    };
  }

  void registerPassess(llvm::legacy::PassManager &Manager) {
    Manager.add(new FunctionInserterPass());
  }
};

struct LLVMEnforcerPassFunctionIdentity {
  static constexpr auto Name = "Identity";

  std::array<InputOutputContract, 1> getContract() const {
    return { InputOutputContract(FunctionKind, KindExactness::Exact) };
  }

  void registerPassess(llvm::legacy::PassManager &Manager) {
    Manager.add(new IdentityPass());
  }
};

BOOST_AUTO_TEST_CASE(SingleElementLLVMPipelineBackwardFinedGrained) {
  llvm::LLVMContext C;

  AutoEnforcer AE;
  AE.addContainerFactory<DefaultLLVMContainerFactory>(CName, C);

  AE.addStep("first_step",
             wrapLLVMPassess(CName,
                             LLVMEnforcerPassFunctionCreator(),
                             LLVMEnforcerPassFunctionIdentity()));
  AE.addStep("End");

  makeF(AE.getStartingContainer<DefaultLLVMContainer>(CName).getModule(),
        "root");

  BackingContainersStatus Targets;
  Targets.add(CName,
              AutoEnforcerTarget({ AutoEnforcerQuantifier("root"),
                                   AutoEnforcerQuantifier("f1") },
                                 FunctionKind));

  auto Error = AE.run(Targets);
  BOOST_TEST(!Error);

  const auto &Final = AE.getFinalContainer<DefaultLLVMContainer>(CName);
  const auto *F = Final.getModule().getFunction("f1");

  BOOST_TEST(F != nullptr);
}

BOOST_AUTO_TEST_CASE(SingleElementPipelineForwardFinedGrained) {
  AutoEnforcer AE;
  AE.addDefaultConstruibleFactory<MapContainer>(CName);

  AE.addStep("first_step", bindEnforcer<FineGranerEnforcer>(CName, CName));
  AE.addStep("End");

  AE.getStartingContainer<MapContainer>(CName).get({ "Root", RootKind }) = 1;
  AE.getFinalContainer<MapContainer>(CName).get({ "f1", FunctionKind }) = 1;
  AE.getFinalContainer<MapContainer>(CName).get({ "f2", FunctionKind }) = 1;

  llvm::StringMap<BackingContainersStatus> Invalidations;
  Invalidations["first_step"].add(CName, { "Root" }, RootKind);

  auto Error = AE.deduceInvalidations(Invalidations);
  BOOST_TEST(!Error);
  Invalidations["End"].dump();
  const auto &
    QuantifOfInvalidated = Invalidations["End"][CName].front().getQuantifiers();
  BOOST_TEST((QuantifOfInvalidated.back().isAll()));
  BOOST_TEST((QuantifOfInvalidated.front().getName() == "Root"));
}

BOOST_AUTO_TEST_CASE(SingleElementPipelineInvalidation) {
  AutoEnforcer AE;
  AE.addDefaultConstruibleFactory<MapContainer>(CName);

  AE.addStep("first_step", bindEnforcer<FineGranerEnforcer>(CName, CName));
  AE.addStep("End");

  AE.getStartingContainer<MapContainer>(CName).get({ "Root", RootKind }) = 1;
  AE.getFinalContainer<MapContainer>(CName).get({ "f1", FunctionKind }) = 1;
  AE.getFinalContainer<MapContainer>(CName).get({ "f2", FunctionKind }) = 1;

  AutoEnforcerTarget ToKill({ "Root" }, RootKind);
  auto ExpectedInvalidation = AE.getInvalidations(ToKill);
  BOOST_TEST(!!ExpectedInvalidation);
  auto &Invalidations = *ExpectedInvalidation;
  const auto &
    QuantifOfInvalidated = Invalidations["End"][CName].front().getQuantifiers();
  BOOST_TEST((QuantifOfInvalidated.back().isAll()));
  BOOST_TEST((QuantifOfInvalidated.front().getName() == "Root"));
}

BOOST_AUTO_TEST_CASE(SingleElementPipelineWithRemove) {
  AutoEnforcer AE;
  AE.addDefaultConstruibleFactory<MapContainer>(CName);

  AE.addStep("first_step", bindEnforcer<FineGranerEnforcer>(CName, CName));
  AE.addStep("End");

  AE.getStartingContainer<MapContainer>(CName).get({ "Root", RootKind }) = 1;

  AutoEnforcerTarget ToKill({ "Root" }, RootKind);
  auto Error = AE.invalidate(ToKill);
  BOOST_TEST(!Error);
  auto IsIn = AE.getStartingContainer<MapContainer>(CName).contains(ToKill);
  BOOST_TEST(IsIn == false);
}

BOOST_AUTO_TEST_SUITE_END()