1 //===- llvm/unittest/Transforms/Vectorize/VPlanHCFGTest.cpp ---------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "../lib/Transforms/Vectorize/VPlan.h" 10 #include "../lib/Transforms/Vectorize/VPlanTransforms.h" 11 #include "VPlanTestBase.h" 12 #include "llvm/Analysis/TargetLibraryInfo.h" 13 #include "llvm/TargetParser/Triple.h" 14 #include "gtest/gtest.h" 15 #include <string> 16 17 namespace llvm { 18 namespace { 19 20 class VPlanHCFGTest : public VPlanTestBase {}; 21 22 TEST_F(VPlanHCFGTest, testBuildHCFGInnerLoop) { 23 const char *ModuleString = 24 "define void @f(i32* %A, i64 %N) {\n" 25 "entry:\n" 26 " br label %for.body\n" 27 "for.body:\n" 28 " %indvars.iv = phi i64 [ 0, %entry ], [ %indvars.iv.next, %for.body ]\n" 29 " %arr.idx = getelementptr inbounds i32, i32* %A, i64 %indvars.iv\n" 30 " %l1 = load i32, i32* %arr.idx, align 4\n" 31 " %res = add i32 %l1, 10\n" 32 " store i32 %res, i32* %arr.idx, align 4\n" 33 " %indvars.iv.next = add i64 %indvars.iv, 1\n" 34 " %exitcond = icmp ne i64 %indvars.iv.next, %N\n" 35 " br i1 %exitcond, label %for.body, label %for.end\n" 36 "for.end:\n" 37 " ret void\n" 38 "}\n"; 39 40 Module &M = parseModule(ModuleString); 41 42 Function *F = M.getFunction("f"); 43 BasicBlock *LoopHeader = F->getEntryBlock().getSingleSuccessor(); 44 auto Plan = buildHCFG(LoopHeader); 45 46 VPBasicBlock *Entry = Plan->getEntry()->getEntryBasicBlock(); 47 EXPECT_NE(nullptr, Entry->getSingleSuccessor()); 48 EXPECT_EQ(0u, Entry->getNumPredecessors()); 49 EXPECT_EQ(1u, Entry->getNumSuccessors()); 50 51 // Check that the region following the preheader is a single basic-block 52 // region (loop). 53 VPBasicBlock *VecBB = Entry->getSingleSuccessor()->getEntryBasicBlock(); 54 EXPECT_EQ(8u, VecBB->size()); 55 EXPECT_EQ(0u, VecBB->getNumPredecessors()); 56 EXPECT_EQ(0u, VecBB->getNumSuccessors()); 57 EXPECT_EQ(VecBB->getParent()->getEntryBasicBlock(), VecBB); 58 EXPECT_EQ(VecBB->getParent()->getExitingBasicBlock(), VecBB); 59 EXPECT_EQ(&*Plan, VecBB->getPlan()); 60 61 auto Iter = VecBB->begin(); 62 VPWidenPHIRecipe *Phi = dyn_cast<VPWidenPHIRecipe>(&*Iter++); 63 EXPECT_NE(nullptr, Phi); 64 65 VPInstruction *Idx = dyn_cast<VPInstruction>(&*Iter++); 66 EXPECT_EQ(Instruction::GetElementPtr, Idx->getOpcode()); 67 EXPECT_EQ(2u, Idx->getNumOperands()); 68 EXPECT_EQ(Phi, Idx->getOperand(1)); 69 70 VPInstruction *Load = dyn_cast<VPInstruction>(&*Iter++); 71 EXPECT_EQ(Instruction::Load, Load->getOpcode()); 72 EXPECT_EQ(1u, Load->getNumOperands()); 73 EXPECT_EQ(Idx, Load->getOperand(0)); 74 75 VPInstruction *Add = dyn_cast<VPInstruction>(&*Iter++); 76 EXPECT_EQ(Instruction::Add, Add->getOpcode()); 77 EXPECT_EQ(2u, Add->getNumOperands()); 78 EXPECT_EQ(Load, Add->getOperand(0)); 79 80 VPInstruction *Store = dyn_cast<VPInstruction>(&*Iter++); 81 EXPECT_EQ(Instruction::Store, Store->getOpcode()); 82 EXPECT_EQ(2u, Store->getNumOperands()); 83 EXPECT_EQ(Add, Store->getOperand(0)); 84 EXPECT_EQ(Idx, Store->getOperand(1)); 85 86 VPInstruction *IndvarAdd = dyn_cast<VPInstruction>(&*Iter++); 87 EXPECT_EQ(Instruction::Add, IndvarAdd->getOpcode()); 88 EXPECT_EQ(2u, IndvarAdd->getNumOperands()); 89 EXPECT_EQ(Phi, IndvarAdd->getOperand(0)); 90 91 VPInstruction *ICmp = dyn_cast<VPInstruction>(&*Iter++); 92 EXPECT_EQ(Instruction::ICmp, ICmp->getOpcode()); 93 EXPECT_EQ(2u, ICmp->getNumOperands()); 94 EXPECT_EQ(IndvarAdd, ICmp->getOperand(0)); 95 96 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 97 // Add an external value to check we do not print the list of external values, 98 // as this is not required with the new printing. 99 Plan->getVPValueOrAddLiveIn(&*F->arg_begin()); 100 std::string FullDump; 101 raw_string_ostream OS(FullDump); 102 Plan->printDOT(OS); 103 const char *ExpectedStr = R"(digraph VPlan { 104 graph [labelloc=t, fontsize=30; label="Vectorization Plan\n for UF\>=1"] 105 node [shape=rect, fontname=Courier, fontsize=30] 106 edge [fontname=Courier, fontsize=30] 107 compound=true 108 N0 [label = 109 "vector.ph:\l" + 110 "Successor(s): for.body\l" 111 ] 112 N0 -> N1 [ label="" lhead=cluster_N2] 113 subgraph cluster_N2 { 114 fontname=Courier 115 label="\<x1\> for.body" 116 N1 [label = 117 "vector.body:\l" + 118 " WIDEN-PHI ir\<%indvars.iv\> = phi ir\<0\>, ir\<%indvars.iv.next\>\l" + 119 " EMIT ir\<%arr.idx\> = getelementptr ir\<%A\> ir\<%indvars.iv\>\l" + 120 " EMIT ir\<%l1\> = load ir\<%arr.idx\>\l" + 121 " EMIT ir\<%res\> = add ir\<%l1\> ir\<10\>\l" + 122 " EMIT store ir\<%res\> ir\<%arr.idx\>\l" + 123 " EMIT ir\<%indvars.iv.next\> = add ir\<%indvars.iv\> ir\<1\>\l" + 124 " EMIT ir\<%exitcond\> = icmp ir\<%indvars.iv.next\> ir\<%N\>\l" + 125 " EMIT branch-on-cond ir\<%exitcond\>\l" + 126 "No successors\l" 127 ] 128 } 129 N1 -> N3 [ label="" ltail=cluster_N2] 130 N3 [label = 131 "for.end:\l" + 132 "No successors\l" 133 ] 134 } 135 )"; 136 EXPECT_EQ(ExpectedStr, FullDump); 137 #endif 138 TargetLibraryInfoImpl TLII(Triple(M.getTargetTriple())); 139 TargetLibraryInfo TLI(TLII); 140 SmallPtrSet<Instruction *, 1> DeadInstructions; 141 VPlanTransforms::VPInstructionsToVPRecipes( 142 Plan, [](PHINode *P) { return nullptr; }, DeadInstructions, *SE, TLI); 143 } 144 145 TEST_F(VPlanHCFGTest, testVPInstructionToVPRecipesInner) { 146 const char *ModuleString = 147 "define void @f(i32* %A, i64 %N) {\n" 148 "entry:\n" 149 " br label %for.body\n" 150 "for.body:\n" 151 " %indvars.iv = phi i64 [ 0, %entry ], [ %indvars.iv.next, %for.body ]\n" 152 " %arr.idx = getelementptr inbounds i32, i32* %A, i64 %indvars.iv\n" 153 " %l1 = load i32, i32* %arr.idx, align 4\n" 154 " %res = add i32 %l1, 10\n" 155 " store i32 %res, i32* %arr.idx, align 4\n" 156 " %indvars.iv.next = add i64 %indvars.iv, 1\n" 157 " %exitcond = icmp ne i64 %indvars.iv.next, %N\n" 158 " br i1 %exitcond, label %for.body, label %for.end\n" 159 "for.end:\n" 160 " ret void\n" 161 "}\n"; 162 163 Module &M = parseModule(ModuleString); 164 165 Function *F = M.getFunction("f"); 166 BasicBlock *LoopHeader = F->getEntryBlock().getSingleSuccessor(); 167 auto Plan = buildHCFG(LoopHeader); 168 169 SmallPtrSet<Instruction *, 1> DeadInstructions; 170 TargetLibraryInfoImpl TLII(Triple(M.getTargetTriple())); 171 TargetLibraryInfo TLI(TLII); 172 VPlanTransforms::VPInstructionsToVPRecipes( 173 Plan, [](PHINode *P) { return nullptr; }, DeadInstructions, *SE, TLI); 174 175 VPBlockBase *Entry = Plan->getEntry()->getEntryBasicBlock(); 176 EXPECT_NE(nullptr, Entry->getSingleSuccessor()); 177 EXPECT_EQ(0u, Entry->getNumPredecessors()); 178 EXPECT_EQ(1u, Entry->getNumSuccessors()); 179 180 // Check that the region following the preheader is a single basic-block 181 // region (loop). 182 VPBasicBlock *VecBB = Entry->getSingleSuccessor()->getEntryBasicBlock(); 183 EXPECT_EQ(8u, VecBB->size()); 184 EXPECT_EQ(0u, VecBB->getNumPredecessors()); 185 EXPECT_EQ(0u, VecBB->getNumSuccessors()); 186 EXPECT_EQ(VecBB->getParent()->getEntryBasicBlock(), VecBB); 187 EXPECT_EQ(VecBB->getParent()->getExitingBasicBlock(), VecBB); 188 189 auto Iter = VecBB->begin(); 190 EXPECT_NE(nullptr, dyn_cast<VPWidenPHIRecipe>(&*Iter++)); 191 EXPECT_NE(nullptr, dyn_cast<VPWidenGEPRecipe>(&*Iter++)); 192 EXPECT_NE(nullptr, dyn_cast<VPWidenMemoryInstructionRecipe>(&*Iter++)); 193 EXPECT_NE(nullptr, dyn_cast<VPWidenRecipe>(&*Iter++)); 194 EXPECT_NE(nullptr, dyn_cast<VPWidenMemoryInstructionRecipe>(&*Iter++)); 195 EXPECT_NE(nullptr, dyn_cast<VPWidenRecipe>(&*Iter++)); 196 EXPECT_NE(nullptr, dyn_cast<VPWidenRecipe>(&*Iter++)); 197 EXPECT_NE(nullptr, dyn_cast<VPInstruction>(&*Iter++)); 198 EXPECT_EQ(VecBB->end(), Iter); 199 } 200 201 } // namespace 202 } // namespace llvm 203