[VPlan] Add VPlanTestBase.h with helper class to build VPlan for tests.

fhahn · fhahn · commit 8263975c3294 · 2018-07-10T10:45:46.000Z
Reviewers: dcaballe, hsaito, rengolin Reviewed By: dcaballe Differential Revision: https://reviews.llvm.org/D49032 llvm-svn: 336653
diff --git a/llvm/unittests/Transforms/Vectorize/VPlanHCFGTest.cpp b/llvm/unittests/Transforms/Vectorize/VPlanHCFGTest.cpp
@@ -8,35 +8,16 @@
 //===----------------------------------------------------------------------===//
 
 #include "../lib/Transforms/Vectorize/VPlan.h"
-#include "../lib/Transforms/Vectorize/VPlanHCFGBuilder.h"
 #include "../lib/Transforms/Vectorize/VPlanHCFGTransforms.h"
-#include "llvm/AsmParser/Parser.h"
-#include "llvm/IR/Dominators.h"
+#include "VPlanTestBase.h"
 #include "gtest/gtest.h"
 
 namespace llvm {
 namespace {
 
-class VPlanHCFGTest : public testing::Test {
-protected:
-  std::unique_ptr<DominatorTree> DT;
-  std::unique_ptr<LoopInfo> LI;
-
-  VPlanHCFGTest() {}
-
-  VPlanPtr doBuildPlan(BasicBlock *LoopHeader) {
-    DT.reset(new DominatorTree(*LoopHeader->getParent()));
-    LI.reset(new LoopInfo(*DT));
-
-    auto Plan = llvm::make_unique<VPlan>();
-    VPlanHCFGBuilder HCFGBuilder(LI->getLoopFor(LoopHeader), LI.get());
-    HCFGBuilder.buildHierarchicalCFG(*Plan.get());
-    return Plan;
-  }
-};
+class VPlanHCFGTest : public VPlanTestBase {};
 
 TEST_F(VPlanHCFGTest, testBuildHCFGInnerLoop) {
-  LLVMContext Ctx;
   const char *ModuleString =
       "define void @f(i32* %A, i64 %N) {\n"
       "entry:\n"
@@ -54,12 +35,11 @@ TEST_F(VPlanHCFGTest, testBuildHCFGInnerLoop) {
       "  ret void\n"
       "}\n";
 
-  SMDiagnostic Err;
-  std::unique_ptr<Module> M = parseAssemblyString(ModuleString, Err, Ctx);
+  Module &M = parseModule(ModuleString);
 
-  Function *F = M->getFunction("f");
+  Function *F = M.getFunction("f");
   BasicBlock *LoopHeader = F->getEntryBlock().getSingleSuccessor();
-  auto Plan = doBuildPlan(LoopHeader);
+  auto Plan = buildHCFG(LoopHeader);
 
   VPBasicBlock *Entry = Plan->getEntry()->getEntryBasicBlock();
   EXPECT_NE(nullptr, Entry->getSingleSuccessor());
@@ -115,7 +95,6 @@ TEST_F(VPlanHCFGTest, testBuildHCFGInnerLoop) {
 }
 
 TEST_F(VPlanHCFGTest, testVPInstructionToVPRecipesInner) {
-  LLVMContext Ctx;
   const char *ModuleString =
       "define void @f(i32* %A, i64 %N) {\n"
       "entry:\n"
@@ -133,12 +112,11 @@ TEST_F(VPlanHCFGTest, testVPInstructionToVPRecipesInner) {
       "  ret void\n"
       "}\n";
 
-  SMDiagnostic Err;
-  std::unique_ptr<Module> M = parseAssemblyString(ModuleString, Err, Ctx);
+  Module &M = parseModule(ModuleString);
 
-  Function *F = M->getFunction("f");
+  Function *F = M.getFunction("f");
   BasicBlock *LoopHeader = F->getEntryBlock().getSingleSuccessor();
-  auto Plan = doBuildPlan(LoopHeader);
+  auto Plan = buildHCFG(LoopHeader);
 
   LoopVectorizationLegality::InductionList Inductions;
   SmallPtrSet<Instruction *, 1> DeadInstructions;
diff --git a/llvm/unittests/Transforms/Vectorize/VPlanTestBase.h b/llvm/unittests/Transforms/Vectorize/VPlanTestBase.h
@@ -0,0 +1,68 @@
+//===- llvm/unittest/Transforms/Vectorize/VPlanTestBase.h -----------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+/// \file
+/// This file defines a VPlanTestBase class, which provides helpers to parse
+/// a LLVM IR string and create VPlans given a loop entry block.
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_UNITTESTS_TRANSFORMS_VECTORIZE_VPLANTESTBASE_H
+#define LLVM_UNITTESTS_TRANSFORMS_VECTORIZE_VPLANTESTBASE_H
+
+#include "../lib/Transforms/Vectorize/VPlan.h"
+#include "../lib/Transforms/Vectorize/VPlanHCFGBuilder.h"
+#include "llvm/Analysis/LoopInfo.h"
+#include "llvm/AsmParser/Parser.h"
+#include "llvm/IR/Dominators.h"
+#include "llvm/Support/SourceMgr.h"
+#include "gtest/gtest.h"
+
+namespace llvm {
+
+/// Helper class to create a module from an assembly string and VPlans for a
+/// given loop entry block.
+class VPlanTestBase : public testing::Test {
+protected:
+  std::unique_ptr<DominatorTree> DT;
+  std::unique_ptr<LoopInfo> LI;
+  std::unique_ptr<Module> M;
+  std::unique_ptr<LLVMContext> Ctx;
+
+  VPlanTestBase() : Ctx(new LLVMContext) {}
+  ~VPlanTestBase() {
+    LI.release();
+    DT.release();
+    M.release();
+    // We need to release objects depending on Ctx first.
+    Ctx.release();
+  }
+
+  Module &parseModule(const char *ModuleString) {
+    SMDiagnostic Err;
+    M = parseAssemblyString(ModuleString, Err, *Ctx);
+    EXPECT_TRUE(M);
+    return *M;
+  }
+
+  void doAnalysis(Function &F) {
+    DT.reset(new DominatorTree(F));
+    LI.reset(new LoopInfo(*DT));
+	}
+
+  VPlanPtr buildHCFG(BasicBlock *LoopHeader) {
+		doAnalysis(*LoopHeader->getParent());
+
+    auto Plan = llvm::make_unique<VPlan>();
+    VPlanHCFGBuilder HCFGBuilder(LI->getLoopFor(LoopHeader), LI.get());
+    HCFGBuilder.buildHierarchicalCFG(*Plan.get());
+    return Plan;
+  }
+};
+
+} // namespace llvm
+
+#endif // LLVM_UNITTESTS_TRANSFORMS_VECTORIZE_VPLANTESTBASE_H
