CallTests.cpp

Go to the documentation of this file.

/*
 * Copyright 2021 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#include <gtest/gtest.h>
 
#include <jlm/llvm/ir/operators/alloca.hpp>
#include <jlm/llvm/ir/operators/call.hpp>
#include <jlm/llvm/ir/operators/FunctionPointer.hpp>
#include <jlm/llvm/ir/operators/GetElementPtr.hpp>
#include <jlm/llvm/ir/operators/Load.hpp>
#include <jlm/llvm/ir/operators/Store.hpp>
#include <jlm/llvm/ir/RvsdgModule.hpp>
#include <jlm/rvsdg/bitstring/arithmetic.hpp>
#include <jlm/rvsdg/bitstring/comparison.hpp>
#include <jlm/rvsdg/bitstring/constant.hpp>
#include <jlm/rvsdg/gamma.hpp>
#include <jlm/rvsdg/TestOperations.hpp>
#include <jlm/rvsdg/TestType.hpp>
#include <jlm/rvsdg/theta.hpp>
#include <jlm/rvsdg/view.hpp>
#include <jlm/util/GraphWriter.hpp>
 
TEST(CallOperationTests, TestCopy)
{
  using namespace jlm::llvm;
 
  // Arrange
  auto valueType = jlm::rvsdg::TestType::createValueType();
  auto iOStateType = IOStateType::Create();
  auto memoryStateType = MemoryStateType::Create();
  auto functionType = jlm::rvsdg::FunctionType::Create(
      { valueType, IOStateType::Create(), MemoryStateType::Create() },
      { valueType, IOStateType::Create(), MemoryStateType::Create() });
 
  jlm::rvsdg::Graph rvsdg;
  auto function1 = &jlm::rvsdg::GraphImport::Create(rvsdg, functionType, "function1");
  auto value1 = &jlm::rvsdg::GraphImport::Create(rvsdg, valueType, "value1");
  auto iOState1 = &jlm::rvsdg::GraphImport::Create(rvsdg, iOStateType, "iOState1");
  auto memoryState1 = &jlm::rvsdg::GraphImport::Create(rvsdg, memoryStateType, "memoryState1");
 
  auto function2 = &jlm::rvsdg::GraphImport::Create(rvsdg, functionType, "function2");
  auto value2 = &jlm::rvsdg::GraphImport::Create(rvsdg, valueType, "value2");
  auto iOState2 = &jlm::rvsdg::GraphImport::Create(rvsdg, iOStateType, "iOState2");
  auto memoryState2 = &jlm::rvsdg::GraphImport::Create(rvsdg, memoryStateType, "memoryState2");
 
  auto callResults =
      CallOperation::Create(function1, functionType, { value1, iOState1, memoryState1 });
 
  // Act
  auto node = jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::SimpleNode>(*callResults[0]);
  auto copiedNode =
      node->copy(&rvsdg.GetRootRegion(), { function2, value2, iOState2, memoryState2 });
 
  // Assert
  EXPECT_EQ(
      node->GetOperation(),
      jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(copiedNode)->GetOperation());
}
 
TEST(CallOperationTests, TestCallNodeAccessors)
{
  using namespace jlm::llvm;
  using namespace jlm::rvsdg;
 
  // Arrange
  auto valueType = TestType::createValueType();
  auto iOStateType = IOStateType::Create();
  auto memoryStateType = MemoryStateType::Create();
  auto functionType = jlm::rvsdg::FunctionType::Create(
      { valueType, IOStateType::Create(), MemoryStateType::Create() },
      { valueType, IOStateType::Create(), MemoryStateType::Create() });
 
  jlm::rvsdg::Graph rvsdg;
  auto f = &jlm::rvsdg::GraphImport::Create(rvsdg, functionType, "function");
  auto v = &jlm::rvsdg::GraphImport::Create(rvsdg, valueType, "value");
  auto i = &jlm::rvsdg::GraphImport::Create(rvsdg, iOStateType, "IOState");
  auto m = &jlm::rvsdg::GraphImport::Create(rvsdg, memoryStateType, "memoryState");
 
  // Act
  auto results = CallOperation::Create(f, functionType, { v, i, m });
  auto & callNode =
      *jlm::util::assertedCast<SimpleNode>(jlm::rvsdg::TryGetOwnerNode<Node>(*results[0]));
 
  // Assert
  EXPECT_EQ(CallOperation::NumArguments(callNode), 3u);
  EXPECT_EQ(CallOperation::NumArguments(callNode), callNode.ninputs() - 1);
  EXPECT_EQ(CallOperation::Argument(callNode, 0)->origin(), v);
  EXPECT_EQ(CallOperation::Argument(callNode, 1)->origin(), i);
  EXPECT_EQ(CallOperation::Argument(callNode, 2)->origin(), m);
 
  EXPECT_EQ(callNode.noutputs(), 3u);
  EXPECT_EQ(*callNode.output(0)->Type(), *valueType);
  EXPECT_EQ(*callNode.output(1)->Type(), *iOStateType);
  EXPECT_EQ(*callNode.output(2)->Type(), *memoryStateType);
 
  EXPECT_EQ(CallOperation::GetFunctionInput(callNode).origin(), f);
  EXPECT_EQ(CallOperation::GetIOStateInput(callNode).origin(), i);
  EXPECT_EQ(CallOperation::GetMemoryStateInput(callNode).origin(), m);
 
  EXPECT_EQ(*CallOperation::GetIOStateOutput(callNode).Type(), *iOStateType);
  EXPECT_EQ(*CallOperation::GetMemoryStateOutput(callNode).Type(), *memoryStateType);
}
 
TEST(CallOperationTests, TestCallTypeClassifierIndirectCall)
{
  using namespace jlm::llvm;
 
  // Arrange
  auto vt = jlm::rvsdg::TestType::createValueType();
  auto iOStateType = IOStateType::Create();
  auto memoryStateType = MemoryStateType::Create();
  auto fcttype1 = jlm::rvsdg::FunctionType::Create(
      { IOStateType::Create(), MemoryStateType::Create() },
      { vt, IOStateType::Create(), MemoryStateType::Create() });
  auto fcttype2 = jlm::rvsdg::FunctionType::Create(
      { PointerType::Create(), IOStateType::Create(), MemoryStateType::Create() },
      { vt, IOStateType::Create(), MemoryStateType::Create() });
 
  auto module = LlvmRvsdgModule::Create(jlm::util::FilePath(""), "", "");
  auto graph = &module->Rvsdg();
 
  auto SetupFunction = [&]()
  {
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        graph->GetRootRegion(),
        LlvmLambdaOperation::Create(fcttype2, "fct", Linkage::externalLinkage));
    auto iOStateArgument = lambda->GetFunctionArguments()[1];
    auto memoryStateArgument = lambda->GetFunctionArguments()[2];
 
    auto one = &jlm::rvsdg::BitConstantOperation::create(*lambda->subregion(), { 32, 1 });
 
    auto alloca = AllocaOperation::create(PointerType::Create(), one, 8);
 
    auto store = StoreNonVolatileOperation::Create(
        alloca[0],
        lambda->GetFunctionArguments()[0],
        { alloca[1] },
        8);
 
    auto load = LoadNonVolatileOperation::Create(alloca[0], store, PointerType::Create(), 8);
    auto fn = jlm::rvsdg::CreateOpNode<PointerToFunctionOperation>({ load[0] }, fcttype1).output(0);
 
    auto callResults =
        CallOperation::Create(fn, fcttype1, { iOStateArgument, memoryStateArgument });
 
    lambda->finalize(callResults);
 
    jlm::rvsdg::GraphExport::Create(*lambda->output(), "f");
 
    return std::make_tuple(
        jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(
            jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::Node>(*callResults[0])),
        fn);
  };
 
  auto [callNode, loadOutput] = SetupFunction();
 
  // Act
  auto callTypeClassifier = CallOperation::ClassifyCall(*callNode);
 
  // Assert
  EXPECT_TRUE(callTypeClassifier->IsIndirectCall());
  EXPECT_EQ(loadOutput, &callTypeClassifier->GetFunctionOrigin());
}
 
TEST(CallOperationTests, TestCallTypeClassifierNonRecursiveDirectCall)
{
  // Arrange
  using namespace jlm::llvm;
  using namespace jlm::rvsdg;
 
  auto module = jlm::llvm::LlvmRvsdgModule::Create(jlm::util::FilePath(""), "", "");
  auto graph = &module->Rvsdg();
 
  auto vt = jlm::rvsdg::TestType::createValueType();
  auto iOStateType = IOStateType::Create();
  auto memoryStateType = MemoryStateType::Create();
 
  auto functionTypeG = jlm::rvsdg::FunctionType::Create(
      { IOStateType::Create(), MemoryStateType::Create() },
      { vt, IOStateType::Create(), MemoryStateType::Create() });
 
  auto SetupFunctionG = [&]()
  {
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        graph->GetRootRegion(),
        LlvmLambdaOperation::Create(functionTypeG, "g", Linkage::externalLinkage));
    auto iOStateArgument = lambda->GetFunctionArguments()[0];
    auto memoryStateArgument = lambda->GetFunctionArguments()[1];
 
    auto constant = TestOperation::createNode(lambda->subregion(), {}, { vt });
 
    auto lambdaOutput =
        lambda->finalize({ constant->output(0), iOStateArgument, memoryStateArgument });
 
    return lambdaOutput;
  };
 
  auto SetupFunctionF = [&](jlm::rvsdg::Output * g)
  {
    auto SetupOuterTheta = [](jlm::rvsdg::Region * region, jlm::rvsdg::Output * functionG)
    {
      auto outerTheta = jlm::rvsdg::ThetaNode::create(region);
      auto otf = outerTheta->AddLoopVar(functionG);
 
      auto innerTheta = jlm::rvsdg::ThetaNode::create(outerTheta->subregion());
      auto itf = innerTheta->AddLoopVar(otf.pre);
 
      auto predicate = &jlm::rvsdg::ControlConstantOperation::createFalse(*innerTheta->subregion());
      auto gamma = jlm::rvsdg::GammaNode::create(predicate, 2);
      auto ev = gamma->AddEntryVar(itf.pre);
      auto xv = gamma->AddExitVar(ev.branchArgument);
 
      itf.post->divert_to(xv.output);
      otf.post->divert_to(itf.output);
 
      return otf;
    };
 
    auto vt = jlm::rvsdg::TestType::createValueType();
    auto iOStateType = IOStateType::Create();
    auto memoryStateType = MemoryStateType::Create();
 
    auto functionType = jlm::rvsdg::FunctionType::Create(
        { IOStateType::Create(), MemoryStateType::Create() },
        { vt, IOStateType::Create(), MemoryStateType::Create() });
 
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        graph->GetRootRegion(),
        LlvmLambdaOperation::Create(functionType, "f", Linkage::externalLinkage));
    auto functionGArgument = lambda->AddContextVar(*g).inner;
    auto iOStateArgument = lambda->GetFunctionArguments()[0];
    auto memoryStateArgument = lambda->GetFunctionArguments()[1];
 
    auto functionG = SetupOuterTheta(lambda->subregion(), functionGArgument);
 
    auto callResults = CallOperation::Create(
        functionG.output,
        functionTypeG,
        { iOStateArgument, memoryStateArgument });
 
    lambda->finalize(callResults);
 
    return std::make_tuple(
        lambda,
        jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(
            jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::Node>(*callResults[0])));
  };
 
  auto g = SetupFunctionG();
  auto [f, callNode] = SetupFunctionF(g);
 
  jlm::rvsdg::GraphExport::Create(*f->output(), "f");
 
  //    jlm::rvsdg::view(&graph->GetRootRegion(), stdout);
 
  // Act
  auto callTypeClassifier = CallOperation::ClassifyCall(*callNode);
 
  // Assert
  EXPECT_TRUE(callTypeClassifier->IsNonRecursiveDirectCall());
  EXPECT_EQ(&callTypeClassifier->GetLambdaOutput(), g);
}
 
TEST(CallOperationTests, TestCallTypeClassifierNonRecursiveDirectCallTheta)
{
  using namespace jlm::llvm;
  using namespace jlm::rvsdg;
 
  // Arrange
  auto module = jlm::llvm::LlvmRvsdgModule::Create(jlm::util::FilePath(""), "", "");
  auto graph = &module->Rvsdg();
 
  auto vt = jlm::rvsdg::TestType::createValueType();
  auto iOStateType = IOStateType::Create();
  auto memoryStateType = MemoryStateType::Create();
 
  auto functionTypeG = jlm::rvsdg::FunctionType::Create(
      { IOStateType::Create(), MemoryStateType::Create() },
      { vt, IOStateType::Create(), MemoryStateType::Create() });
 
  auto SetupFunctionG = [&]()
  {
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        graph->GetRootRegion(),
        LlvmLambdaOperation::Create(functionTypeG, "g", Linkage::externalLinkage));
    auto iOStateArgument = lambda->GetFunctionArguments()[0];
    auto memoryStateArgument = lambda->GetFunctionArguments()[1];
 
    auto c1 = TestOperation::createNode(lambda->subregion(), {}, { vt });
 
    return lambda->finalize({ c1->output(0), iOStateArgument, memoryStateArgument });
  };
 
  auto SetupFunctionF = [&](jlm::rvsdg::Output * g)
  {
    auto SetupOuterTheta = [&](jlm::rvsdg::Region * region,
                               jlm::rvsdg::Output * g,
                               jlm::rvsdg::Output * value,
                               jlm::rvsdg::Output * iOState,
                               jlm::rvsdg::Output * memoryState)
    {
      auto SetupInnerTheta = [&](jlm::rvsdg::Region * region, jlm::rvsdg::Output * g)
      {
        auto innerTheta = jlm::rvsdg::ThetaNode::create(region);
        auto thetaOutputG = innerTheta->AddLoopVar(g);
 
        return thetaOutputG;
      };
 
      auto outerTheta = jlm::rvsdg::ThetaNode::create(region);
      auto thetaOutputG = outerTheta->AddLoopVar(g);
      auto thetaOutputValue = outerTheta->AddLoopVar(value);
      auto thetaOutputIoState = outerTheta->AddLoopVar(iOState);
      auto thetaOutputMemoryState = outerTheta->AddLoopVar(memoryState);
 
      auto functionG = SetupInnerTheta(outerTheta->subregion(), thetaOutputG.pre);
 
      auto callResults = CallOperation::Create(
          functionG.output,
          functionTypeG,
          { thetaOutputIoState.pre, thetaOutputMemoryState.pre });
 
      thetaOutputG.post->divert_to(functionG.output);
      thetaOutputValue.post->divert_to(callResults[0]);
      thetaOutputIoState.post->divert_to(callResults[1]);
      thetaOutputMemoryState.post->divert_to(callResults[2]);
 
      return std::make_tuple(
          thetaOutputValue,
          thetaOutputIoState,
          thetaOutputMemoryState,
          jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(
              jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::Node>(*callResults[0])));
    };
 
    auto vt = jlm::rvsdg::TestType::createValueType();
    auto iOStateType = IOStateType::Create();
    auto memoryStateType = MemoryStateType::Create();
 
    auto functionType = jlm::rvsdg::FunctionType::Create(
        { IOStateType::Create(), MemoryStateType::Create() },
        { vt, IOStateType::Create(), MemoryStateType::Create() });
 
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        graph->GetRootRegion(),
        LlvmLambdaOperation::Create(functionType, "f", Linkage::externalLinkage));
    auto functionG = lambda->AddContextVar(*g).inner;
    auto iOStateArgument = lambda->GetFunctionArguments()[0];
    auto memoryStateArgument = lambda->GetFunctionArguments()[1];
 
    auto value = TestOperation::createNode(lambda->subregion(), {}, { vt })->output(0);
 
    auto [loopValue, iOState, memoryState, callNode] = SetupOuterTheta(
        lambda->subregion(),
        functionG,
        value,
        iOStateArgument,
        memoryStateArgument);
 
    auto lambdaOutput = lambda->finalize({ loopValue.output, iOState.output, memoryState.output });
 
    return std::make_tuple(lambdaOutput, callNode);
  };
 
  auto g = SetupFunctionG();
  auto [f, callNode] = SetupFunctionF(g);
  jlm::rvsdg::GraphExport::Create(*f, "f");
 
  jlm::rvsdg::view(&graph->GetRootRegion(), stdout);
 
  // Act
  auto callTypeClassifier = CallOperation::ClassifyCall(*callNode);
 
  // Assert
  EXPECT_TRUE(callTypeClassifier->IsNonRecursiveDirectCall());
  EXPECT_EQ(&callTypeClassifier->GetLambdaOutput(), g);
}
 
TEST(CallOperationTests, TestCallTypeClassifierRecursiveDirectCall)
{
  // Arrange
  using namespace jlm::llvm;
 
  auto module = LlvmRvsdgModule::Create(jlm::util::FilePath(""), "", "");
  auto graph = &module->Rvsdg();
 
  auto SetupFib = [&]()
  {
    auto iOStateType = IOStateType::Create();
    auto memoryStateType = MemoryStateType::Create();
    auto functionType = jlm::rvsdg::FunctionType::Create(
        { jlm::rvsdg::BitType::Create(64),
          PointerType::Create(),
          IOStateType::Create(),
          MemoryStateType::Create() },
        { IOStateType::Create(), MemoryStateType::Create() });
    auto pt = PointerType::Create();
 
    jlm::rvsdg::PhiBuilder pb;
    pb.begin(&graph->GetRootRegion());
    auto fibrv = pb.AddFixVar(functionType);
 
    auto lambda = jlm::rvsdg::LambdaNode::Create(
        *pb.subregion(),
        LlvmLambdaOperation::Create(functionType, "fib", Linkage::externalLinkage));
    auto valueArgument = lambda->GetFunctionArguments()[0];
    auto pointerArgument = lambda->GetFunctionArguments()[1];
    auto iOStateArgument = lambda->GetFunctionArguments()[2];
    auto memoryStateArgument = lambda->GetFunctionArguments()[3];
    auto ctxVarFib = lambda->AddContextVar(*fibrv.recref).inner;
 
    auto two = &jlm::rvsdg::BitConstantOperation::create(*lambda->subregion(), { 64, 2 });
    auto bitult = jlm::rvsdg::bitult_op::create(64, valueArgument, two);
    auto & predicateNode = jlm::rvsdg::MatchOperation::CreateNode(*bitult, { { 0, 1 } }, 0, 2);
 
    auto gammaNode = jlm::rvsdg::GammaNode::create(predicateNode.output(0), 2);
    auto nev = gammaNode->AddEntryVar(valueArgument);
    auto resultev = gammaNode->AddEntryVar(pointerArgument);
    auto fibev = gammaNode->AddEntryVar(ctxVarFib);
    auto gIIoState = gammaNode->AddEntryVar(iOStateArgument);
    auto gIMemoryState = gammaNode->AddEntryVar(memoryStateArgument);
 
    /* gamma subregion 0 */
    auto one = &jlm::rvsdg::BitConstantOperation::create(*gammaNode->subregion(0), { 64, 1 });
    auto nm1 = jlm::rvsdg::bitsub_op::create(64, nev.branchArgument[0], one);
    auto callfibm1Results = CallOperation::Create(
        fibev.branchArgument[0],
        functionType,
        { nm1,
          resultev.branchArgument[0],
          gIIoState.branchArgument[0],
          gIMemoryState.branchArgument[0] });
 
    two = &jlm::rvsdg::BitConstantOperation::create(*gammaNode->subregion(0), { 64, 2 });
    auto nm2 = jlm::rvsdg::bitsub_op::create(64, nev.branchArgument[0], two);
    auto callfibm2Results = CallOperation::Create(
        fibev.branchArgument[0],
        functionType,
        { nm2, resultev.branchArgument[0], callfibm1Results[0], callfibm1Results[1] });
 
    auto gepnm1 = GetElementPtrOperation::create(
        resultev.branchArgument[0],
        { nm1 },
        jlm::rvsdg::BitType::Create(64));
    auto ldnm1 = LoadNonVolatileOperation::Create(
        gepnm1,
        { callfibm2Results[1] },
        jlm::rvsdg::BitType::Create(64),
        8);
 
    auto gepnm2 = GetElementPtrOperation::create(
        resultev.branchArgument[0],
        { nm2 },
        jlm::rvsdg::BitType::Create(64));
    auto ldnm2 =
        LoadNonVolatileOperation::Create(gepnm2, { ldnm1[1] }, jlm::rvsdg::BitType::Create(64), 8);
 
    auto sum = jlm::rvsdg::bitadd_op::create(64, ldnm1[0], ldnm2[0]);
 
    /* gamma subregion 1 */
    /* Nothing needs to be done */
 
    auto sumex = gammaNode->AddExitVar({ sum, nev.branchArgument[1] });
    auto gOIoState = gammaNode->AddExitVar({ callfibm2Results[0], gIIoState.branchArgument[1] });
    auto gOMemoryState = gammaNode->AddExitVar({ ldnm2[1], gIMemoryState.branchArgument[1] });
 
    auto gepn = GetElementPtrOperation::create(
        pointerArgument,
        { valueArgument },
        jlm::rvsdg::BitType::Create(64));
    auto store = StoreNonVolatileOperation::Create(gepn, sumex.output, { gOMemoryState.output }, 8);
 
    auto lambdaOutput = lambda->finalize({ gOIoState.output, store[0] });
 
    fibrv.result->divert_to(lambdaOutput);
    pb.end();
 
    jlm::rvsdg::GraphExport::Create(*fibrv.output, "fib");
 
    return std::make_tuple(
        lambdaOutput,
        jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(
            jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::Node>(*callfibm1Results[0])),
        jlm::util::assertedCast<jlm::rvsdg::SimpleNode>(
            jlm::rvsdg::TryGetOwnerNode<jlm::rvsdg::Node>(*callfibm2Results[0])));
  };
 
  auto [fibfct, callFib1, callFib2] = SetupFib();
 
  // Act
  auto callTypeClassifier1 = CallOperation::ClassifyCall(*callFib1);
  auto callTypeClassifier2 = CallOperation::ClassifyCall(*callFib2);
 
  // Assert
  EXPECT_TRUE(callTypeClassifier1->IsRecursiveDirectCall());
  EXPECT_EQ(&callTypeClassifier1->GetLambdaOutput(), fibfct);
 
  EXPECT_TRUE(callTypeClassifier2->IsRecursiveDirectCall());
  EXPECT_EQ(&callTypeClassifier2->GetLambdaOutput(), fibfct);
}