13b11a16aSHongbin Zheng //===--- BlockGenerators.cpp - Generate code for statements -----*- C++ -*-===//
23b11a16aSHongbin Zheng //
33b11a16aSHongbin Zheng //                     The LLVM Compiler Infrastructure
43b11a16aSHongbin Zheng //
53b11a16aSHongbin Zheng // This file is distributed under the University of Illinois Open Source
63b11a16aSHongbin Zheng // License. See LICENSE.TXT for details.
73b11a16aSHongbin Zheng //
83b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
93b11a16aSHongbin Zheng //
103b11a16aSHongbin Zheng // This file implements the BlockGenerator and VectorBlockGenerator classes,
113b11a16aSHongbin Zheng // which generate sequential code and vectorized code for a polyhedral
123b11a16aSHongbin Zheng // statement, respectively.
133b11a16aSHongbin Zheng //
143b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
153b11a16aSHongbin Zheng 
163b11a16aSHongbin Zheng #include "polly/ScopInfo.h"
178a846610SHongbin Zheng #include "polly/CodeGen/BlockGenerators.h"
1883628182STobias Grosser #include "polly/CodeGen/CodeGeneration.h"
19a63b2579SJohannes Doerfert #include "polly/CodeGen/IslExprBuilder.h"
2086bc93a9STobias Grosser #include "polly/CodeGen/RuntimeDebugBuilder.h"
21637bd631STobias Grosser #include "polly/Options.h"
223b11a16aSHongbin Zheng #include "polly/Support/GICHelper.h"
2397cb813cSSebastian Pop #include "polly/Support/SCEVValidator.h"
24ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
25e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
26f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
27e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
28030237d0STobias Grosser #include "llvm/IR/IntrinsicInst.h"
29c9895067STobias Grosser #include "llvm/IR/Module.h"
303b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
311b9d25a4STobias Grosser #include "llvm/Transforms/Utils/Local.h"
32f32d651dSJohannes Doerfert #include "isl/aff.h"
33f32d651dSJohannes Doerfert #include "isl/ast.h"
34f32d651dSJohannes Doerfert #include "isl/ast_build.h"
35ba0d0922STobias Grosser #include "isl/set.h"
36f32d651dSJohannes Doerfert #include <deque>
37f32d651dSJohannes Doerfert 
383b11a16aSHongbin Zheng using namespace llvm;
393b11a16aSHongbin Zheng using namespace polly;
403b11a16aSHongbin Zheng 
41878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
42878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
43878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
44878aba49STobias Grosser                              cl::cat(PollyCategory));
453b11a16aSHongbin Zheng 
4686bc93a9STobias Grosser static cl::opt<bool> DebugPrinting(
4786bc93a9STobias Grosser     "polly-codegen-add-debug-printing",
4886bc93a9STobias Grosser     cl::desc("Add printf calls that show the values loaded/stored."),
4986bc93a9STobias Grosser     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
5086bc93a9STobias Grosser 
51dcc3b435STobias Grosser bool polly::canSynthesize(const Value *V, const llvm::LoopInfo *LI,
52ecfe21b7STobias Grosser                           ScalarEvolution *SE, const Region *R) {
53dcc3b435STobias Grosser   if (!V || !SE->isSCEVable(V->getType()))
54ecfe21b7STobias Grosser     return false;
55ecfe21b7STobias Grosser 
56dcc3b435STobias Grosser   if (const SCEV *Scev = SE->getSCEV(const_cast<Value *>(V)))
57ecfe21b7STobias Grosser     if (!isa<SCEVCouldNotCompute>(Scev))
58ecfe21b7STobias Grosser       if (!hasScalarDepsInsideRegion(Scev, R))
59ecfe21b7STobias Grosser         return true;
60ecfe21b7STobias Grosser 
61ecfe21b7STobias Grosser   return false;
62ecfe21b7STobias Grosser }
63ecfe21b7STobias Grosser 
649e3a5db0SJohannes Doerfert bool polly::isIgnoredIntrinsic(const Value *V) {
659e3a5db0SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(V)) {
669e3a5db0SJohannes Doerfert     switch (IT->getIntrinsicID()) {
679e3a5db0SJohannes Doerfert     // Lifetime markers are supported/ignored.
689e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
699e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
709e3a5db0SJohannes Doerfert     // Invariant markers are supported/ignored.
719e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
729e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
739e3a5db0SJohannes Doerfert     // Some misc annotations are supported/ignored.
749e3a5db0SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
759e3a5db0SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
769e3a5db0SJohannes Doerfert     case llvm::Intrinsic::annotation:
779e3a5db0SJohannes Doerfert     case llvm::Intrinsic::donothing:
789e3a5db0SJohannes Doerfert     case llvm::Intrinsic::assume:
799e3a5db0SJohannes Doerfert     case llvm::Intrinsic::expect:
80e83a396bSTobias Grosser     // Some debug info intrisics are supported/ignored.
81e83a396bSTobias Grosser     case llvm::Intrinsic::dbg_value:
82e83a396bSTobias Grosser     case llvm::Intrinsic::dbg_declare:
839e3a5db0SJohannes Doerfert       return true;
849e3a5db0SJohannes Doerfert     default:
859e3a5db0SJohannes Doerfert       break;
869e3a5db0SJohannes Doerfert     }
879e3a5db0SJohannes Doerfert   }
889e3a5db0SJohannes Doerfert   return false;
899e3a5db0SJohannes Doerfert }
909e3a5db0SJohannes Doerfert 
91b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
92b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
93ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
94ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
95ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
96bc132607STobias Grosser                                ValueToValueMap &GlobalMap,
97b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
98ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
99ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
100bc132607STobias Grosser       EscapeMap(EscapeMap), GlobalMap(GlobalMap) {}
101e71c6ab5STobias Grosser 
102*33cb9f94STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, const Value *Old,
103*33cb9f94STobias Grosser                                              ValueMapT &BBMap,
104*33cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
105bc132607STobias Grosser                                              Loop *L) const {
106683b8e44STobias Grosser   if (SE.isSCEVable(Old->getType()))
107369430ffSTobias Grosser     if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
108e71c6ab5STobias Grosser       if (!isa<SCEVCouldNotCompute>(Scev)) {
109637b23dcSSebastian Pop         const SCEV *NewScev = apply(Scev, LTS, SE);
110637b23dcSSebastian Pop         ValueToValueMap VTV;
111637b23dcSSebastian Pop         VTV.insert(BBMap.begin(), BBMap.end());
112637b23dcSSebastian Pop         VTV.insert(GlobalMap.begin(), GlobalMap.end());
11347d4ee3eSSebastian Pop         NewScev = SCEVParameterRewriter::rewrite(NewScev, SE, VTV);
114e69e1141SJohannes Doerfert 
115e69e1141SJohannes Doerfert         Scop &S = *Stmt.getParent();
116e69e1141SJohannes Doerfert         const DataLayout &DL =
117e69e1141SJohannes Doerfert             S.getRegion().getEntry()->getParent()->getParent()->getDataLayout();
118e69e1141SJohannes Doerfert         auto IP = Builder.GetInsertPoint();
119e69e1141SJohannes Doerfert 
120e69e1141SJohannes Doerfert         assert(IP != Builder.GetInsertBlock()->end() &&
12145e7944bSTobias Grosser                "Only instructions can be insert points for SCEVExpander");
122e69e1141SJohannes Doerfert         Value *Expanded =
123e69e1141SJohannes Doerfert             expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), IP);
124e71c6ab5STobias Grosser 
125e71c6ab5STobias Grosser         BBMap[Old] = Expanded;
126e71c6ab5STobias Grosser         return Expanded;
127e71c6ab5STobias Grosser       }
128369430ffSTobias Grosser     }
129e71c6ab5STobias Grosser 
130*33cb9f94STobias Grosser   return nullptr;
131*33cb9f94STobias Grosser }
132*33cb9f94STobias Grosser 
133*33cb9f94STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, const Value *Old,
134*33cb9f94STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
135*33cb9f94STobias Grosser                                    Loop *L) const {
136*33cb9f94STobias Grosser   // We assume constants never change.
137*33cb9f94STobias Grosser   // This avoids map lookups for many calls to this function.
138*33cb9f94STobias Grosser   if (isa<Constant>(Old))
139*33cb9f94STobias Grosser     return const_cast<Value *>(Old);
140*33cb9f94STobias Grosser 
141*33cb9f94STobias Grosser   if (Value *New = GlobalMap.lookup(Old)) {
142*33cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
143*33cb9f94STobias Grosser       New = NewRemapped;
144*33cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
145*33cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
146*33cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
147*33cb9f94STobias Grosser 
148*33cb9f94STobias Grosser     return New;
149*33cb9f94STobias Grosser   }
150*33cb9f94STobias Grosser 
151*33cb9f94STobias Grosser   if (Value *New = BBMap.lookup(Old))
152*33cb9f94STobias Grosser     return New;
153*33cb9f94STobias Grosser 
154*33cb9f94STobias Grosser   if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
155*33cb9f94STobias Grosser     return New;
156*33cb9f94STobias Grosser 
15716371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
15816371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
15916371acdSTobias Grosser     return const_cast<Value *>(Old);
16016371acdSTobias Grosser 
16116371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
16216371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
163be9c9117SJohannes Doerfert     if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
16416371acdSTobias Grosser       return const_cast<Value *>(Old);
16516371acdSTobias Grosser 
16616371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1675b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1685a56cbf4STobias Grosser   return nullptr;
1693b11a16aSHongbin Zheng }
1703b11a16aSHongbin Zheng 
171be9c9117SJohannes Doerfert void BlockGenerator::copyInstScalar(ScopStmt &Stmt, const Instruction *Inst,
172bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
173030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
174030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
175030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
176030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
177030237d0STobias Grosser     return;
178030237d0STobias Grosser 
1793b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1803b11a16aSHongbin Zheng 
1813b11a16aSHongbin Zheng   // Replace old operands with the new ones.
18291f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
183bc132607STobias Grosser     Value *NewOperand =
184bc132607STobias Grosser         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForInst(Inst));
1853b11a16aSHongbin Zheng 
1863b11a16aSHongbin Zheng     if (!NewOperand) {
187c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
188c14582f2STobias Grosser              "Store instructions are always needed!");
1893b11a16aSHongbin Zheng       delete NewInst;
1903b11a16aSHongbin Zheng       return;
1913b11a16aSHongbin Zheng     }
1923b11a16aSHongbin Zheng 
1933b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1943b11a16aSHongbin Zheng   }
1953b11a16aSHongbin Zheng 
1963b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1973b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1983b11a16aSHongbin Zheng 
1993b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
2003b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
2013b11a16aSHongbin Zheng }
2023b11a16aSHongbin Zheng 
203be9c9117SJohannes Doerfert Value *BlockGenerator::generateLocationAccessed(
204be9c9117SJohannes Doerfert     ScopStmt &Stmt, const Instruction *Inst, const Value *Pointer,
205bc132607STobias Grosser     ValueMapT &BBMap, LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses) {
206be9c9117SJohannes Doerfert   const MemoryAccess &MA = Stmt.getAccessFor(Inst);
2073b11a16aSHongbin Zheng 
2082d1ed0bfSTobias Grosser   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
2093b11a16aSHongbin Zheng 
2102d1ed0bfSTobias Grosser   if (AccessExpr) {
2112d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
21298b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
21398b3ee50STobias Grosser 
21498b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
21598b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
21698b3ee50STobias Grosser     // the newly generated pointer.
21798b3ee50STobias Grosser     auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
21898b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
21998b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
22098b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
22198b3ee50STobias Grosser 
22298b3ee50STobias Grosser     if (OldPtrTy != NewPtrTy) {
22398b3ee50STobias Grosser       assert(OldPtrTy->getPointerElementType()->getPrimitiveSizeInBits() ==
22498b3ee50STobias Grosser                  NewPtrTy->getPointerElementType()->getPrimitiveSizeInBits() &&
22598b3ee50STobias Grosser              "Pointer types to elements with different size found");
22698b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
22798b3ee50STobias Grosser     }
22898b3ee50STobias Grosser     return Address;
2292d1ed0bfSTobias Grosser   }
2302d1ed0bfSTobias Grosser 
231bc132607STobias Grosser   return getNewValue(Stmt, Pointer, BBMap, LTS, getLoopForInst(Inst));
2323b11a16aSHongbin Zheng }
2333b11a16aSHongbin Zheng 
2344d96c8d7STobias Grosser Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
2352ef3f4fdSJohannes Doerfert   return LI.getLoopFor(Inst->getParent());
236369430ffSTobias Grosser }
237369430ffSTobias Grosser 
238be9c9117SJohannes Doerfert Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, const LoadInst *Load,
239bc132607STobias Grosser                                           ValueMapT &BBMap, LoopToScevMapT &LTS,
2402d1ed0bfSTobias Grosser                                           isl_id_to_ast_expr *NewAccesses) {
241c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
242c1db67e2SJohannes Doerfert     return PreloadLoad;
243c1db67e2SJohannes Doerfert 
2443b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
245bc132607STobias Grosser   Value *NewPointer =
246bc132607STobias Grosser       generateLocationAccessed(Stmt, Load, Pointer, BBMap, LTS, NewAccesses);
24787901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
24887901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
24986bc93a9STobias Grosser 
25086bc93a9STobias Grosser   if (DebugPrinting)
25186bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
25286bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
25386bc93a9STobias Grosser 
2543b11a16aSHongbin Zheng   return ScalarLoad;
2553b11a16aSHongbin Zheng }
2563b11a16aSHongbin Zheng 
257c186ac7aSTobias Grosser void BlockGenerator::generateScalarStore(ScopStmt &Stmt, const StoreInst *Store,
258bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
2592d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
2603b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
261bc132607STobias Grosser   Value *NewPointer =
262bc132607STobias Grosser       generateLocationAccessed(Stmt, Store, Pointer, BBMap, LTS, NewAccesses);
263bc132607STobias Grosser   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
264bc132607STobias Grosser                                     getLoopForInst(Store));
2653b11a16aSHongbin Zheng 
26686bc93a9STobias Grosser   if (DebugPrinting)
26786bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
26886bc93a9STobias Grosser                                           ": ", ValueOperand, "\n");
26986bc93a9STobias Grosser 
270c186ac7aSTobias Grosser   Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
2713b11a16aSHongbin Zheng }
2723b11a16aSHongbin Zheng 
273be9c9117SJohannes Doerfert void BlockGenerator::copyInstruction(ScopStmt &Stmt, const Instruction *Inst,
274bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
2752d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
276ecff11dcSJohannes Doerfert 
277ecff11dcSJohannes Doerfert   // First check for possible scalar dependences for this instruction.
278bc132607STobias Grosser   generateScalarLoads(Stmt, Inst, BBMap);
279ecff11dcSJohannes Doerfert 
2803b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2813b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2823b11a16aSHongbin Zheng   if (Inst->isTerminator())
2833b11a16aSHongbin Zheng     return;
2843b11a16aSHongbin Zheng 
285ecff11dcSJohannes Doerfert   Loop *L = getLoopForInst(Inst);
286ecff11dcSJohannes Doerfert   if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
287ecff11dcSJohannes Doerfert       canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
288f6343d74SJohannes Doerfert     Value *NewValue = getNewValue(Stmt, Inst, BBMap, LTS, L);
289f6343d74SJohannes Doerfert     BBMap[Inst] = NewValue;
290e71c6ab5STobias Grosser     return;
291ecff11dcSJohannes Doerfert   }
292e71c6ab5STobias Grosser 
2933b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
294bc132607STobias Grosser     Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
2953d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2963d94fedfSSebastian Pop     // deterministic.
297753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2983b11a16aSHongbin Zheng     return;
2993b11a16aSHongbin Zheng   }
3003b11a16aSHongbin Zheng 
3013b11a16aSHongbin Zheng   if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
302bc132607STobias Grosser     generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
3033b11a16aSHongbin Zheng     return;
3043b11a16aSHongbin Zheng   }
3053b11a16aSHongbin Zheng 
306ecff11dcSJohannes Doerfert   if (const PHINode *PHI = dyn_cast<PHINode>(Inst)) {
307bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
308ecff11dcSJohannes Doerfert     return;
309ecff11dcSJohannes Doerfert   }
310ecff11dcSJohannes Doerfert 
3113f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
3123f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
3139c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
3143f500fa2SJohannes Doerfert     return;
3153f500fa2SJohannes Doerfert 
316bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
3173b11a16aSHongbin Zheng }
3183b11a16aSHongbin Zheng 
319f6343d74SJohannes Doerfert /// @brief Remove trivially dead instructions from BB
320f6343d74SJohannes Doerfert ///
321f6343d74SJohannes Doerfert /// This function drops trivially dead instructions from a basic block. It
322f6343d74SJohannes Doerfert /// on purpose does _not_ recurse into other BBs even if the deletion of
323f6343d74SJohannes Doerfert /// instructions in this basic block can make instructions in other basic blocks
324f6343d74SJohannes Doerfert /// triviall dead.
325f6343d74SJohannes Doerfert static void simplifyInstsInBlockOnly(BasicBlock *BB) {
326f6343d74SJohannes Doerfert   auto BI = --BB->end(), BE = BB->begin();
327f6343d74SJohannes Doerfert   bool Exit = false;
328f6343d74SJohannes Doerfert   while (!Exit) {
329f6343d74SJohannes Doerfert     auto ToRemove = BI;
330f6343d74SJohannes Doerfert     if (BI != BE)
331f6343d74SJohannes Doerfert       BI--;
332f6343d74SJohannes Doerfert     else
333f6343d74SJohannes Doerfert       Exit = true;
334f6343d74SJohannes Doerfert 
335f6343d74SJohannes Doerfert     if (!isInstructionTriviallyDead(ToRemove))
336f6343d74SJohannes Doerfert       continue;
337f6343d74SJohannes Doerfert     ToRemove->eraseFromParent();
338f6343d74SJohannes Doerfert   }
339f6343d74SJohannes Doerfert }
340f6343d74SJohannes Doerfert 
341bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
3422d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
343275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
344275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
345275a1756SJohannes Doerfert 
346275a1756SJohannes Doerfert   ValueMapT BBMap;
347275a1756SJohannes Doerfert 
348be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
349bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
350f6343d74SJohannes Doerfert 
351f6343d74SJohannes Doerfert   auto CopyBB = Builder.GetInsertBlock();
352f6343d74SJohannes Doerfert   // Delete trivially dead instructions in CopyBB, but not in any other BB.
353f6343d74SJohannes Doerfert   // Only for copyBB we know that there will _never_ be any future uses of
354f6343d74SJohannes Doerfert   // instructions that have no use after copyBB has finished. Other instructions
355f6343d74SJohannes Doerfert   // in the AST that have been generated by IslNodeBuilder may look dead at
356f6343d74SJohannes Doerfert   // the moment, but may possibly still be referenced by GlobalMaps. If we
357f6343d74SJohannes Doerfert   // delete them now, later uses would break surprisingly.
358f6343d74SJohannes Doerfert   simplifyInstsInBlockOnly(CopyBB);
359f6343d74SJohannes Doerfert   Builder.SetInsertPoint(CopyBB->getTerminator());
360275a1756SJohannes Doerfert }
361275a1756SJohannes Doerfert 
362514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
363c14582f2STobias Grosser   BasicBlock *CopyBB =
364b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
3653b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
366514f6efaSJohannes Doerfert   return CopyBB;
367514f6efaSJohannes Doerfert }
3683b11a16aSHongbin Zheng 
369514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
370bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
3712d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
372514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
373bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
374514f6efaSJohannes Doerfert   return CopyBB;
375514f6efaSJohannes Doerfert }
376514f6efaSJohannes Doerfert 
377514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
378bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
3792d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
380514f6efaSJohannes Doerfert   Builder.SetInsertPoint(CopyBB->begin());
381ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
382ecff11dcSJohannes Doerfert 
38391f5b262STobias Grosser   for (Instruction &Inst : *BB)
384bc132607STobias Grosser     copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
385ecff11dcSJohannes Doerfert 
386ecff11dcSJohannes Doerfert   // After a basic block was copied store all scalars that escape this block
387ecff11dcSJohannes Doerfert   // in their alloca. First the scalars that have dependences inside the SCoP,
388ecff11dcSJohannes Doerfert   // then the ones that might escape the SCoP.
389bc132607STobias Grosser   generateScalarStores(Stmt, BB, BBMap);
390ecff11dcSJohannes Doerfert 
391ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
392ecff11dcSJohannes Doerfert   for (Instruction &Inst : *BB)
393bc132607STobias Grosser     handleOutsideUsers(R, &Inst, BBMap[&Inst]);
394ecff11dcSJohannes Doerfert }
395ecff11dcSJohannes Doerfert 
39664c0ff41STobias Grosser Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
397ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &Map,
3982985400aSTobias Grosser                                          const char *NameExt) {
399ecff11dcSJohannes Doerfert   // Check if an alloca was cached for the base instruction.
400b09455deSTobias Grosser   Value *&Addr = Map[ScalarBase];
401ecff11dcSJohannes Doerfert 
402ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
403ecff11dcSJohannes Doerfert   if (!Addr) {
404ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
405b09455deSTobias Grosser     auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
40664c0ff41STobias Grosser     EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
407b09455deSTobias Grosser     NewAddr->insertBefore(EntryBB->getFirstInsertionPt());
408b09455deSTobias Grosser     Addr = NewAddr;
409ecff11dcSJohannes Doerfert   }
410ecff11dcSJohannes Doerfert 
411bc132607STobias Grosser   if (GlobalMap.count(Addr))
412bc132607STobias Grosser     return GlobalMap[Addr];
41364c0ff41STobias Grosser 
414ecff11dcSJohannes Doerfert   return Addr;
415ecff11dcSJohannes Doerfert }
416ecff11dcSJohannes Doerfert 
417bc132607STobias Grosser Value *BlockGenerator::getOrCreateAlloca(MemoryAccess &Access) {
418f8d55f7eSTobias Grosser   if (Access.getScopArrayInfo()->isPHI())
419bc132607STobias Grosser     return getOrCreatePHIAlloca(Access.getBaseAddr());
420f8d55f7eSTobias Grosser   else
421bc132607STobias Grosser     return getOrCreateScalarAlloca(Access.getBaseAddr());
422f8d55f7eSTobias Grosser }
423f8d55f7eSTobias Grosser 
424bc132607STobias Grosser Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
425bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
426b79a67dfSTobias Grosser }
427b79a67dfSTobias Grosser 
428bc132607STobias Grosser Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
429bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
430b79a67dfSTobias Grosser }
431b79a67dfSTobias Grosser 
432bc132607STobias Grosser void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
433b09455deSTobias Grosser                                         Value *InstCopy, Value *Address) {
4342985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
4352985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
4362985400aSTobias Grosser   // copied multiple times we already did this and can exit.
437acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
438acb6ade7SMichael Kruse     return;
439e69e1141SJohannes Doerfert 
440ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
441ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
442ecff11dcSJohannes Doerfert 
443ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
444ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
445ecff11dcSJohannes Doerfert     if (!UI)
446ecff11dcSJohannes Doerfert       continue;
447ecff11dcSJohannes Doerfert 
448ddb83d0fSJohannes Doerfert     if (R.contains(UI))
449ecff11dcSJohannes Doerfert       continue;
450ecff11dcSJohannes Doerfert 
451ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
452ecff11dcSJohannes Doerfert   }
453ecff11dcSJohannes Doerfert 
454ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
455ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
456ecff11dcSJohannes Doerfert     return;
457ecff11dcSJohannes Doerfert 
458ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
459b09455deSTobias Grosser   auto *ScalarAddr = Address ? Address : getOrCreateScalarAlloca(Inst);
460ecff11dcSJohannes Doerfert 
461ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
462ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
463ecff11dcSJohannes Doerfert }
464ecff11dcSJohannes Doerfert 
465ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarLoads(ScopStmt &Stmt,
466ecff11dcSJohannes Doerfert                                          const Instruction *Inst,
467bc132607STobias Grosser                                          ValueMapT &BBMap) {
468d4dd6ec7STobias Grosser   auto *MAL = Stmt.lookupAccessesFor(Inst);
469ecff11dcSJohannes Doerfert 
470d4dd6ec7STobias Grosser   if (!MAL)
471d4dd6ec7STobias Grosser     return;
472d4dd6ec7STobias Grosser 
473e2bccbbfSMichael Kruse   for (MemoryAccess *MA : *MAL) {
4748d0b734eSMichael Kruse     if (MA->isExplicit() || !MA->isRead())
475ecff11dcSJohannes Doerfert       continue;
476ecff11dcSJohannes Doerfert 
477e2bccbbfSMichael Kruse     auto *Address = getOrCreateAlloca(*MA);
478e2bccbbfSMichael Kruse     BBMap[MA->getBaseAddr()] =
4792fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
480ecff11dcSJohannes Doerfert   }
481ecff11dcSJohannes Doerfert }
482ecff11dcSJohannes Doerfert 
483ecff11dcSJohannes Doerfert Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
484bc132607STobias Grosser                                          ValueMapT &BBMap) {
485ecff11dcSJohannes Doerfert   // If the value we want to store is an instruction we might have demoted it
486ecff11dcSJohannes Doerfert   // in order to make it accessible here. In such a case a reload is
487ecff11dcSJohannes Doerfert   // necessary. If it is no instruction it will always be a value that
488ecff11dcSJohannes Doerfert   // dominates the current point and we can just use it. In total there are 4
489ecff11dcSJohannes Doerfert   // options:
490ecff11dcSJohannes Doerfert   //  (1) The value is no instruction ==> use the value.
491ecff11dcSJohannes Doerfert   //  (2) The value is an instruction that was split out of the region prior to
492ecff11dcSJohannes Doerfert   //      code generation  ==> use the instruction as it dominates the region.
493ecff11dcSJohannes Doerfert   //  (3) The value is an instruction:
494ecff11dcSJohannes Doerfert   //      (a) The value was defined in the current block, thus a copy is in
495ecff11dcSJohannes Doerfert   //          the BBMap ==> use the mapped value.
496ecff11dcSJohannes Doerfert   //      (b) The value was defined in a previous block, thus we demoted it
497ecff11dcSJohannes Doerfert   //          earlier ==> use the reloaded value.
498ecff11dcSJohannes Doerfert   Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
499ecff11dcSJohannes Doerfert   if (!ScalarValueInst)
500ecff11dcSJohannes Doerfert     return ScalarValue;
501ecff11dcSJohannes Doerfert 
502ecff11dcSJohannes Doerfert   if (!R.contains(ScalarValueInst)) {
503ecff11dcSJohannes Doerfert     if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
504ecff11dcSJohannes Doerfert       return /* Case (3a) */ ScalarValueCopy;
505ecff11dcSJohannes Doerfert     else
506ecff11dcSJohannes Doerfert       return /* Case 2 */ ScalarValue;
507ecff11dcSJohannes Doerfert   }
508ecff11dcSJohannes Doerfert 
509ecff11dcSJohannes Doerfert   if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
510ecff11dcSJohannes Doerfert     return /* Case (3a) */ ScalarValueCopy;
511ecff11dcSJohannes Doerfert 
512ecff11dcSJohannes Doerfert   // Case (3b)
513bc132607STobias Grosser   Value *Address = getOrCreateScalarAlloca(ScalarValueInst);
514b649e26aSTobias Grosser   ScalarValue = Builder.CreateLoad(Address, Address->getName() + ".reload");
515ecff11dcSJohannes Doerfert 
516ecff11dcSJohannes Doerfert   return ScalarValue;
517ecff11dcSJohannes Doerfert }
518ecff11dcSJohannes Doerfert 
519ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
520bc132607STobias Grosser                                           ValueMapT &BBMap) {
521ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
522ecff11dcSJohannes Doerfert 
523ecff11dcSJohannes Doerfert   assert(Stmt.isBlockStmt() && BB == Stmt.getBasicBlock() &&
524ecff11dcSJohannes Doerfert          "Region statements need to use the generateScalarStores() "
525ecff11dcSJohannes Doerfert          "function in the RegionGenerator");
526ecff11dcSJohannes Doerfert 
527ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
5288d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
529ecff11dcSJohannes Doerfert       continue;
530ecff11dcSJohannes Doerfert 
531d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
532bc132607STobias Grosser     auto *Address = getOrCreateAlloca(*MA);
533d86f2157SJohannes Doerfert 
534bc132607STobias Grosser     Val = getNewScalarValue(Val, R, BBMap);
53592245228STobias Grosser     Builder.CreateStore(Val, Address);
536ecff11dcSJohannes Doerfert   }
537ecff11dcSJohannes Doerfert }
538ecff11dcSJohannes Doerfert 
539c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
540c0091a77STobias Grosser   Region &R = S.getRegion();
541ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
542ecff11dcSJohannes Doerfert   BasicBlock *SplitBB = R.getEnteringBlock();
543ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
544ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
545ecff11dcSJohannes Doerfert 
546ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
547ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
548ecff11dcSJohannes Doerfert   if (StartBB == R.getEntry())
549ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
550ecff11dcSJohannes Doerfert 
551fb19dd69SJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
552ecff11dcSJohannes Doerfert 
553c0091a77STobias Grosser   for (auto &Pair : S.arrays()) {
554c0091a77STobias Grosser     auto &Array = Pair.second;
555c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
556c0091a77STobias Grosser       continue;
557c0091a77STobias Grosser     if (Array->isPHI()) {
558c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
559c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
560c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
561c0091a77STobias Grosser       // 'SplitBB'.
562c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
563ecff11dcSJohannes Doerfert 
564c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
565c0091a77STobias Grosser         if (!R.contains(*BI) && *BI != SplitBB)
566c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
567c0091a77STobias Grosser                            "come from SplitBB");
568c0091a77STobias Grosser 
569c0091a77STobias Grosser       int Idx = PHI->getBasicBlockIndex(SplitBB);
570c0091a77STobias Grosser       if (Idx < 0)
571ecff11dcSJohannes Doerfert         continue;
572ecff11dcSJohannes Doerfert 
573c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
574ecff11dcSJohannes Doerfert 
575bc132607STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
576c0091a77STobias Grosser       continue;
577c0091a77STobias Grosser     }
578c0091a77STobias Grosser 
579c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
580c0091a77STobias Grosser 
581c0091a77STobias Grosser     if (Inst && R.contains(Inst))
582c0091a77STobias Grosser       continue;
583c0091a77STobias Grosser 
584717b8667SJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are exit PHI
585717b8667SJohannes Doerfert     // nodes we model as common scalars but do not need to initialize.
586717b8667SJohannes Doerfert     if (Inst && isa<PHINode>(Inst))
587717b8667SJohannes Doerfert       continue;
588717b8667SJohannes Doerfert 
58964c0ff41STobias Grosser     ValueMapT EmptyMap;
590c0091a77STobias Grosser     Builder.CreateStore(Array->getBasePtr(),
591bc132607STobias Grosser                         getOrCreateScalarAlloca(Array->getBasePtr()));
592ecff11dcSJohannes Doerfert   }
593ecff11dcSJohannes Doerfert }
594ecff11dcSJohannes Doerfert 
595ecff11dcSJohannes Doerfert void BlockGenerator::createScalarFinalization(Region &R) {
596ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
597ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExitingBlock();
598ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
599ecff11dcSJohannes Doerfert   BasicBlock *MergeBB = R.getExit();
600ecff11dcSJohannes Doerfert 
601ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
602ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
603ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
604ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
605ecff11dcSJohannes Doerfert 
606ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
607ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
608ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
609ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
610ecff11dcSJohannes Doerfert     Instruction *EscapeInst = EscapeMapping.getFirst();
611ecff11dcSJohannes Doerfert     const auto &EscapeMappingValue = EscapeMapping.getSecond();
612ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
61364c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
614ecff11dcSJohannes Doerfert 
615ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
616ecff11dcSJohannes Doerfert     Instruction *EscapeInstReload =
617ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
618ecff11dcSJohannes Doerfert 
619ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
620ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
621ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
622ecff11dcSJohannes Doerfert     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
623ecff11dcSJohannes Doerfert 
624ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
625ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
626ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
627ecff11dcSJohannes Doerfert 
628ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
629ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
630ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
631ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
632ecff11dcSJohannes Doerfert 
633ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
634ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
635ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
636ecff11dcSJohannes Doerfert   }
637ecff11dcSJohannes Doerfert }
638ecff11dcSJohannes Doerfert 
639655a4570STobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
640717b8667SJohannes Doerfert 
641717b8667SJohannes Doerfert   // Handle PHI nodes that were in the original exit and are now
642717b8667SJohannes Doerfert   // moved into the region exiting block.
643717b8667SJohannes Doerfert   if (!S.hasSingleExitEdge()) {
644717b8667SJohannes Doerfert     for (Instruction &I : *S.getRegion().getExitingBlock()) {
645717b8667SJohannes Doerfert       PHINode *PHI = dyn_cast<PHINode>(&I);
646717b8667SJohannes Doerfert       if (!PHI)
647717b8667SJohannes Doerfert         break;
648717b8667SJohannes Doerfert 
649717b8667SJohannes Doerfert       assert(PHI->getNumUses() == 1);
650717b8667SJohannes Doerfert       assert(ScalarMap.count(PHI->user_back()));
651717b8667SJohannes Doerfert 
652717b8667SJohannes Doerfert       handleOutsideUsers(S.getRegion(), PHI, nullptr,
653717b8667SJohannes Doerfert                          ScalarMap[PHI->user_back()]);
654717b8667SJohannes Doerfert     }
655717b8667SJohannes Doerfert   }
656717b8667SJohannes Doerfert 
657c0091a77STobias Grosser   createScalarInitialization(S);
658ecff11dcSJohannes Doerfert   createScalarFinalization(S.getRegion());
6593b11a16aSHongbin Zheng }
6603b11a16aSHongbin Zheng 
661be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
662be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
663be9c9117SJohannes Doerfert                                            isl_map *Schedule)
664bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
665a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
6663b11a16aSHongbin Zheng }
6673b11a16aSHongbin Zheng 
668be9c9117SJohannes Doerfert Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, const Value *Old,
669e602a076STobias Grosser                                             ValueMapT &VectorMap,
670e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
671e602a076STobias Grosser                                             Loop *L) {
672fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
673fe11e287SHongbin Zheng     return NewValue;
6743b11a16aSHongbin Zheng 
6753b11a16aSHongbin Zheng   int Width = getVectorWidth();
6763b11a16aSHongbin Zheng 
6773b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6783b11a16aSHongbin Zheng 
6793b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
680c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
681bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
6827242ad92STobias Grosser         Builder.getInt32(Lane));
6833b11a16aSHongbin Zheng 
6843b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6853b11a16aSHongbin Zheng 
6863b11a16aSHongbin Zheng   return Vector;
6873b11a16aSHongbin Zheng }
6883b11a16aSHongbin Zheng 
6893b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6903b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6913b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6923b11a16aSHongbin Zheng 
6933b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6943b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6953b11a16aSHongbin Zheng 
6963b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6973b11a16aSHongbin Zheng }
6983b11a16aSHongbin Zheng 
699be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
700be9c9117SJohannes Doerfert     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
7012d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
7020dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
7033b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7040dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
7050dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
7060dd463faSTobias Grosser 
7075a56cbf4STobias Grosser   Value *NewPointer = nullptr;
708bc132607STobias Grosser   NewPointer = generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
709bc132607STobias Grosser                                         VLTS[Offset], NewAccesses);
710c14582f2STobias Grosser   Value *VectorPtr =
711c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
712c14582f2STobias Grosser   LoadInst *VecLoad =
713c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
7143b11a16aSHongbin Zheng   if (!Aligned)
7153b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
7163b11a16aSHongbin Zheng 
7170dd463faSTobias Grosser   if (NegativeStride) {
7180dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
7190dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
7200dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
7210dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
7220dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
7230dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
7240dd463faSTobias Grosser     return RevVecLoad;
7250dd463faSTobias Grosser   }
7260dd463faSTobias Grosser 
7273b11a16aSHongbin Zheng   return VecLoad;
7283b11a16aSHongbin Zheng }
7293b11a16aSHongbin Zheng 
7302d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
7312d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &BBMap,
7322d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7333b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7343b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
735bc132607STobias Grosser   Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
736bc132607STobias Grosser                                                VLTS[0], NewAccesses);
7373b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
7383b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
739c14582f2STobias Grosser   LoadInst *ScalarLoad =
740c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
7413b11a16aSHongbin Zheng 
7423b11a16aSHongbin Zheng   if (!Aligned)
7433b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
7443b11a16aSHongbin Zheng 
745c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
746c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
7473b11a16aSHongbin Zheng 
748c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
749c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
7503b11a16aSHongbin Zheng   return VectorLoad;
7513b11a16aSHongbin Zheng }
7523b11a16aSHongbin Zheng 
753be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
7542d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
7552d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses
7562d1ed0bfSTobias Grosser 
7572d1ed0bfSTobias Grosser     ) {
7583b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
7593b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7603b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
7613b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
7623b11a16aSHongbin Zheng 
7633b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
7643b11a16aSHongbin Zheng 
7653b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
766bc132607STobias Grosser     Value *NewPointer = generateLocationAccessed(
767bc132607STobias Grosser         Stmt, Load, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
768c14582f2STobias Grosser     Value *ScalarLoad =
769c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
770c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
771c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7723b11a16aSHongbin Zheng   }
7733b11a16aSHongbin Zheng 
7743b11a16aSHongbin Zheng   return Vector;
7753b11a16aSHongbin Zheng }
7763b11a16aSHongbin Zheng 
7772d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
7782d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &VectorMap,
7792d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
780c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
781c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
782c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
783c1db67e2SJohannes Doerfert     return;
784c1db67e2SJohannes Doerfert   }
785c1db67e2SJohannes Doerfert 
7862873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7873b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
788bc132607STobias Grosser       ScalarMaps[i][Load] =
789bc132607STobias Grosser           generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
7903b11a16aSHongbin Zheng     return;
7913b11a16aSHongbin Zheng   }
7923b11a16aSHongbin Zheng 
793be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Load);
7943b11a16aSHongbin Zheng 
79595493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
79695493984STobias Grosser   // the data location.
79795493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
79895493984STobias Grosser 
7993b11a16aSHongbin Zheng   Value *NewLoad;
800a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
8012d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
802a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
8032d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
8040dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
8052d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
8063b11a16aSHongbin Zheng   else
8072d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
8083b11a16aSHongbin Zheng 
8093b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
8103b11a16aSHongbin Zheng }
8113b11a16aSHongbin Zheng 
812be9c9117SJohannes Doerfert void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt,
813be9c9117SJohannes Doerfert                                          const UnaryInstruction *Inst,
8143b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
8153b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
8163b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
817be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
818be9c9117SJohannes Doerfert                                      ScalarMaps, getLoopForInst(Inst));
8193b11a16aSHongbin Zheng 
8203b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
8213b11a16aSHongbin Zheng 
8223b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
8233b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
8243b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
8253b11a16aSHongbin Zheng }
8263b11a16aSHongbin Zheng 
827be9c9117SJohannes Doerfert void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt,
828be9c9117SJohannes Doerfert                                           const BinaryOperator *Inst,
8293b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
8303b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
831369430ffSTobias Grosser   Loop *L = getLoopForInst(Inst);
8323b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
8333b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
8343b11a16aSHongbin Zheng 
8353b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
836be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
837be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
8383b11a16aSHongbin Zheng 
8391bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
8403b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
8413b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
8423b11a16aSHongbin Zheng }
8433b11a16aSHongbin Zheng 
8442d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
8452d1ed0bfSTobias Grosser     ScopStmt &Stmt, const StoreInst *Store, ValueMapT &VectorMap,
8462d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
847be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Store);
8483b11a16aSHongbin Zheng 
8493b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
850be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
851369430ffSTobias Grosser                                  ScalarMaps, getLoopForInst(Store));
8523b11a16aSHongbin Zheng 
85350fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
85450fd7010STobias Grosser   // the data location.
85550fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
85650fd7010STobias Grosser 
857a00a0291SSebastian Pop   if (Access.isStrideOne(isl_map_copy(Schedule))) {
8581947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
859bc132607STobias Grosser     Value *NewPointer = generateLocationAccessed(
860bc132607STobias Grosser         Stmt, Store, Pointer, ScalarMaps[0], VLTS[0], NewAccesses);
8613b11a16aSHongbin Zheng 
862c14582f2STobias Grosser     Value *VectorPtr =
863c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
8643b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
8653b11a16aSHongbin Zheng 
8663b11a16aSHongbin Zheng     if (!Aligned)
8673b11a16aSHongbin Zheng       Store->setAlignment(8);
8683b11a16aSHongbin Zheng   } else {
8693b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
8701bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
871bc132607STobias Grosser       Value *NewPointer = generateLocationAccessed(
872bc132607STobias Grosser           Stmt, Store, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
8733b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
8743b11a16aSHongbin Zheng     }
8753b11a16aSHongbin Zheng   }
8763b11a16aSHongbin Zheng }
8773b11a16aSHongbin Zheng 
8783b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
8793b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
88091f5b262STobias Grosser   for (Value *Operand : Inst->operands())
88191f5b262STobias Grosser     if (VectorMap.count(Operand))
8823b11a16aSHongbin Zheng       return true;
8833b11a16aSHongbin Zheng   return false;
8843b11a16aSHongbin Zheng }
8853b11a16aSHongbin Zheng 
8863b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
8873b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
8883b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
8893b11a16aSHongbin Zheng   bool HasVectorOperand = false;
8903b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8913b11a16aSHongbin Zheng 
89291f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
89391f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
8943b11a16aSHongbin Zheng 
8953b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
8963b11a16aSHongbin Zheng       continue;
8973b11a16aSHongbin Zheng 
8983b11a16aSHongbin Zheng     HasVectorOperand = true;
8993b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
9003b11a16aSHongbin Zheng 
9013b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
9023b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
9033b11a16aSHongbin Zheng 
9043b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
9053b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
9063b11a16aSHongbin Zheng       // existance of all of them.
90791f5b262STobias Grosser       if (SM.count(Operand))
9083b11a16aSHongbin Zheng         break;
9093b11a16aSHongbin Zheng 
91091f5b262STobias Grosser       SM[Operand] =
91191f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
9123b11a16aSHongbin Zheng     }
9133b11a16aSHongbin Zheng   }
9143b11a16aSHongbin Zheng 
9153b11a16aSHongbin Zheng   return HasVectorOperand;
9163b11a16aSHongbin Zheng }
9173b11a16aSHongbin Zheng 
9182d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
9192d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
9202d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
9213b11a16aSHongbin Zheng   bool HasVectorOperand;
9223b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
9233b11a16aSHongbin Zheng 
9243b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
9253b11a16aSHongbin Zheng 
9263b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
927be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
928bc132607STobias Grosser                                     VLTS[VectorLane], NewAccesses);
9293b11a16aSHongbin Zheng 
9303b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
9313b11a16aSHongbin Zheng     return;
9323b11a16aSHongbin Zheng 
9333b11a16aSHongbin Zheng   // Make the result available as vector value.
9343b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
9353b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
9363b11a16aSHongbin Zheng 
9373b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
9383b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
9393b11a16aSHongbin Zheng                                          Builder.getInt32(i));
9403b11a16aSHongbin Zheng 
9413b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
9423b11a16aSHongbin Zheng }
9433b11a16aSHongbin Zheng 
944bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
9453b11a16aSHongbin Zheng 
9462d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
9472d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
9482d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
9493b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
9503b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
9513b11a16aSHongbin Zheng   if (Inst->isTerminator())
9523b11a16aSHongbin Zheng     return;
9533b11a16aSHongbin Zheng 
9541ef52333SJohannes Doerfert   if (canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion()))
955e71c6ab5STobias Grosser     return;
956e71c6ab5STobias Grosser 
9573b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
9582d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
9593b11a16aSHongbin Zheng     return;
9603b11a16aSHongbin Zheng   }
9613b11a16aSHongbin Zheng 
9623b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
9633b11a16aSHongbin Zheng     if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
9642d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
9653b11a16aSHongbin Zheng       return;
9663b11a16aSHongbin Zheng     }
9673b11a16aSHongbin Zheng 
9683b11a16aSHongbin Zheng     if (const UnaryInstruction *Unary = dyn_cast<UnaryInstruction>(Inst)) {
969be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9703b11a16aSHongbin Zheng       return;
9713b11a16aSHongbin Zheng     }
9723b11a16aSHongbin Zheng 
9733b11a16aSHongbin Zheng     if (const BinaryOperator *Binary = dyn_cast<BinaryOperator>(Inst)) {
974be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
9753b11a16aSHongbin Zheng       return;
9763b11a16aSHongbin Zheng     }
9773b11a16aSHongbin Zheng 
9783b11a16aSHongbin Zheng     // Falltrough: We generate scalar instructions, if we don't know how to
9793b11a16aSHongbin Zheng     // generate vector code.
9803b11a16aSHongbin Zheng   }
9813b11a16aSHongbin Zheng 
9822d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
9833b11a16aSHongbin Zheng }
9843b11a16aSHongbin Zheng 
9852d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
9862d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
987275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
988275a1756SJohannes Doerfert                                "the vector block generator");
989275a1756SJohannes Doerfert 
990be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
991c14582f2STobias Grosser   BasicBlock *CopyBB =
992b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
9933b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
9943b11a16aSHongbin Zheng   Builder.SetInsertPoint(CopyBB->begin());
9953b11a16aSHongbin Zheng 
9963b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
9973b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
9983b11a16aSHongbin Zheng   // are basic block local.
9993b11a16aSHongbin Zheng   //
10003b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
10013b11a16aSHongbin Zheng   // and one for vector values.
10023b11a16aSHongbin Zheng   //
10033b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
10043b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
10053b11a16aSHongbin Zheng   //
10063b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
10073b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
10083b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
10093b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
10103b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
10113b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
10123b11a16aSHongbin Zheng 
101391f5b262STobias Grosser   for (Instruction &Inst : *BB)
10142d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
10153b11a16aSHongbin Zheng }
1016275a1756SJohannes Doerfert 
1017ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1018ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
1019514f6efaSJohannes Doerfert 
1020514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1021514f6efaSJohannes Doerfert   BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
1022514f6efaSJohannes Doerfert 
1023514f6efaSJohannes Doerfert   if (BBCopyIDom)
1024514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1025514f6efaSJohannes Doerfert 
1026514f6efaSJohannes Doerfert   return BBCopyIDom;
1027514f6efaSJohannes Doerfert }
1028514f6efaSJohannes Doerfert 
1029bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
10302d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
1031275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
1032d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
1033275a1756SJohannes Doerfert 
1034ecff11dcSJohannes Doerfert   // Forget all old mappings.
1035ecff11dcSJohannes Doerfert   BlockMap.clear();
1036ecff11dcSJohannes Doerfert   RegionMaps.clear();
1037ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
1038ecff11dcSJohannes Doerfert 
1039275a1756SJohannes Doerfert   // The region represented by the statement.
1040275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1041275a1756SJohannes Doerfert 
1042ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1043ecff11dcSJohannes Doerfert   // inputs.
1044ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1045ecff11dcSJohannes Doerfert   BasicBlock *EntryBBCopy =
1046ecff11dcSJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1047ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1048ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(EntryBBCopy->begin());
1049514f6efaSJohannes Doerfert 
1050ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1051ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
1052ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
1053275a1756SJohannes Doerfert 
1054275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1055275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
1056275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
1057ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1058ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1059275a1756SJohannes Doerfert 
1060275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1061275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1062275a1756SJohannes Doerfert     Blocks.pop_front();
1063275a1756SJohannes Doerfert 
1064514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1065514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1066ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1067ecff11dcSJohannes Doerfert 
1068ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1069ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1070514f6efaSJohannes Doerfert 
1071514f6efaSJohannes Doerfert     // Get the mapping for this block and initialize it with the mapping
1072514f6efaSJohannes Doerfert     // available at its immediate dominator (in the new region).
1073514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1074514f6efaSJohannes Doerfert     RegionMap = RegionMaps[BBCopyIDom];
1075514f6efaSJohannes Doerfert 
1076275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1077bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1078275a1756SJohannes Doerfert 
1079ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1080ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1081ecff11dcSJohannes Doerfert 
1082ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1083ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1084bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1085ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1086ecff11dcSJohannes Doerfert 
1087275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1088275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1089275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1090275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1091275a1756SJohannes Doerfert   }
1092275a1756SJohannes Doerfert 
1093275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1094514f6efaSJohannes Doerfert   BasicBlock *ExitBBCopy =
1095275a1756SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1096ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1097514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1098514f6efaSJohannes Doerfert 
1099ecff11dcSJohannes Doerfert   repairDominance(R->getExit(), ExitBBCopy);
1100275a1756SJohannes Doerfert 
1101275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1102275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1103275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1104275a1756SJohannes Doerfert 
1105514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1106e114dc02SJohannes Doerfert     TerminatorInst *TI = BB->getTerminator();
1107e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1108e114dc02SJohannes Doerfert       while (!BBCopy->empty())
1109e114dc02SJohannes Doerfert         BBCopy->begin()->eraseFromParent();
1110e114dc02SJohannes Doerfert       new UnreachableInst(BBCopy->getContext(), BBCopy);
1111e114dc02SJohannes Doerfert       continue;
1112e114dc02SJohannes Doerfert     }
1113e114dc02SJohannes Doerfert 
1114275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1115275a1756SJohannes Doerfert 
1116514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1117514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1118514f6efaSJohannes Doerfert 
111945e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
11209a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1121275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1122275a1756SJohannes Doerfert   }
1123275a1756SJohannes Doerfert 
1124ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1125ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1126ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1127ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1128ecff11dcSJohannes Doerfert     if (L == nullptr || L->getHeader() != BB)
1129ecff11dcSJohannes Doerfert       continue;
1130ecff11dcSJohannes Doerfert 
1131ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1132ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1133ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1134ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1135ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1136ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1137ecff11dcSJohannes Doerfert     LoopPHI->insertBefore(BBCopy->begin());
1138ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1139ecff11dcSJohannes Doerfert 
1140ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1141ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1142ecff11dcSJohannes Doerfert         continue;
1143ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1144ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1145ecff11dcSJohannes Doerfert       else
1146ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1147ecff11dcSJohannes Doerfert     }
1148ecff11dcSJohannes Doerfert 
1149ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1150ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1151ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1152ecff11dcSJohannes Doerfert 
1153ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1154ecff11dcSJohannes Doerfert   }
1155ecff11dcSJohannes Doerfert 
1156f6343d74SJohannes Doerfert   // Delete trivially dead instructions in CopyBB, but not in any other BB.
1157f6343d74SJohannes Doerfert   // Only for copyBB we know that there will _never_ be any future uses of
1158f6343d74SJohannes Doerfert   // instructions that have no use after copyBB has finished. Other instructions
1159f6343d74SJohannes Doerfert   // in the AST that have been generated by IslNodeBuilder may look dead at
1160f6343d74SJohannes Doerfert   // the moment, but may possibly still be referenced by GlobalMaps. If we
1161f6343d74SJohannes Doerfert   // delete them now, later uses would break surprisingly.
1162f6343d74SJohannes Doerfert   for (auto *BB : SeenBlocks)
1163f6343d74SJohannes Doerfert     simplifyInstsInBlockOnly(BlockMap[BB]);
1164f6343d74SJohannes Doerfert 
1165275a1756SJohannes Doerfert   // Reset the old insert point for the build.
1166514f6efaSJohannes Doerfert   Builder.SetInsertPoint(ExitBBCopy->begin());
1167275a1756SJohannes Doerfert }
1168ecff11dcSJohannes Doerfert 
1169ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarLoads(ScopStmt &Stmt,
1170ecff11dcSJohannes Doerfert                                           const Instruction *Inst,
1171bc132607STobias Grosser                                           ValueMapT &BBMap) {
1172ecff11dcSJohannes Doerfert 
1173ecff11dcSJohannes Doerfert   // Inside a non-affine region PHI nodes are copied not demoted. Once the
1174ecff11dcSJohannes Doerfert   // phi is copied it will reload all inputs from outside the region, hence
1175ecff11dcSJohannes Doerfert   // we do not need to generate code for the read access of the operands of a
1176ecff11dcSJohannes Doerfert   // PHI.
1177ecff11dcSJohannes Doerfert   if (isa<PHINode>(Inst))
1178ecff11dcSJohannes Doerfert     return;
1179ecff11dcSJohannes Doerfert 
1180bc132607STobias Grosser   return BlockGenerator::generateScalarLoads(Stmt, Inst, BBMap);
1181ecff11dcSJohannes Doerfert }
1182ecff11dcSJohannes Doerfert 
1183ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
1184bc132607STobias Grosser                                            ValueMapT &BBMap) {
1185ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
1186ecff11dcSJohannes Doerfert 
118775296901STobias Grosser   assert(Stmt.getRegion() &&
118875296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1189ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1190ecff11dcSJohannes Doerfert 
1191ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
1192ecff11dcSJohannes Doerfert 
11938d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
1194ecff11dcSJohannes Doerfert       continue;
1195ecff11dcSJohannes Doerfert 
1196ecff11dcSJohannes Doerfert     Instruction *ScalarInst = MA->getAccessInstruction();
1197ecff11dcSJohannes Doerfert 
119862139132STobias Grosser     // Only generate accesses that belong to this basic block.
119962139132STobias Grosser     if (ScalarInst->getParent() != BB)
120062139132STobias Grosser       continue;
120162139132STobias Grosser 
1202d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
1203ecff11dcSJohannes Doerfert 
1204bc132607STobias Grosser     auto Address = getOrCreateAlloca(*MA);
1205ecff11dcSJohannes Doerfert 
1206bc132607STobias Grosser     Val = getNewScalarValue(Val, R, BBMap);
1207f8d55f7eSTobias Grosser     Builder.CreateStore(Val, Address);
1208ecff11dcSJohannes Doerfert   }
1209ecff11dcSJohannes Doerfert }
1210ecff11dcSJohannes Doerfert 
1211ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1212ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1213ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1214ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1215ecff11dcSJohannes Doerfert 
1216ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1217ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1218ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1219ecff11dcSJohannes Doerfert   if (!BBCopy) {
1220ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1221ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1222ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1223ecff11dcSJohannes Doerfert     return;
1224ecff11dcSJohannes Doerfert   }
1225ecff11dcSJohannes Doerfert 
1226ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1227ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1228ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1229ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1230ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1231ecff11dcSJohannes Doerfert 
1232ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1233bc132607STobias Grosser     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForInst(PHI));
1234ecff11dcSJohannes Doerfert   } else {
1235ecff11dcSJohannes Doerfert 
1236ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1237ecff11dcSJohannes Doerfert       return;
1238ecff11dcSJohannes Doerfert 
1239bc132607STobias Grosser     Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
1240ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1241ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1242ecff11dcSJohannes Doerfert   }
1243ecff11dcSJohannes Doerfert 
1244ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1245ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1246ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1247ecff11dcSJohannes Doerfert }
1248ecff11dcSJohannes Doerfert 
1249ecff11dcSJohannes Doerfert Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, const PHINode *PHI,
1250ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1251ecff11dcSJohannes Doerfert                                            LoopToScevMapT &LTS) {
1252ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1253ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1254ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1255ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1256ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1257ecff11dcSJohannes Doerfert 
1258ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1259bc132607STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
1260ecff11dcSJohannes Doerfert   return PHICopy;
1261ecff11dcSJohannes Doerfert }
1262