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 
168a846610SHongbin Zheng #include "polly/CodeGen/BlockGenerators.h"
1783628182STobias Grosser #include "polly/CodeGen/CodeGeneration.h"
18a63b2579SJohannes Doerfert #include "polly/CodeGen/IslExprBuilder.h"
1986bc93a9STobias Grosser #include "polly/CodeGen/RuntimeDebugBuilder.h"
20637bd631STobias Grosser #include "polly/Options.h"
215624d3c9STobias Grosser #include "polly/ScopInfo.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 
51b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
52b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
53ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
54ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
55ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
56f4bb7a6aSTobias Grosser                                ValueMapT &GlobalMap,
57b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
58ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
59ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
60bc132607STobias Grosser       EscapeMap(EscapeMap), GlobalMap(GlobalMap) {}
61e71c6ab5STobias Grosser 
622f1acac6STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
6333cb9f94STobias Grosser                                              ValueMapT &BBMap,
6433cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
65bc132607STobias Grosser                                              Loop *L) const {
6642df8d1dSJohannes Doerfert   if (!SE.isSCEVable(Old->getType()))
6742df8d1dSJohannes Doerfert     return nullptr;
6842df8d1dSJohannes Doerfert 
6942df8d1dSJohannes Doerfert   const SCEV *Scev = SE.getSCEVAtScope(Old, L);
7042df8d1dSJohannes Doerfert   if (!Scev)
7142df8d1dSJohannes Doerfert     return nullptr;
7242df8d1dSJohannes Doerfert 
7342df8d1dSJohannes Doerfert   if (isa<SCEVCouldNotCompute>(Scev))
7442df8d1dSJohannes Doerfert     return nullptr;
7542df8d1dSJohannes Doerfert 
7603bcb910SSanjoy Das   const SCEV *NewScev = SCEVLoopAddRecRewriter::rewrite(Scev, LTS, SE);
7709e3697fSJohannes Doerfert   ValueMapT VTV;
78637b23dcSSebastian Pop   VTV.insert(BBMap.begin(), BBMap.end());
79637b23dcSSebastian Pop   VTV.insert(GlobalMap.begin(), GlobalMap.end());
80e69e1141SJohannes Doerfert 
81e69e1141SJohannes Doerfert   Scop &S = *Stmt.getParent();
823f52e354SJohannes Doerfert   const DataLayout &DL = S.getFunction().getParent()->getDataLayout();
83e69e1141SJohannes Doerfert   auto IP = Builder.GetInsertPoint();
84e69e1141SJohannes Doerfert 
85e69e1141SJohannes Doerfert   assert(IP != Builder.GetInsertBlock()->end() &&
8645e7944bSTobias Grosser          "Only instructions can be insert points for SCEVExpander");
8742df8d1dSJohannes Doerfert   Value *Expanded =
8842df8d1dSJohannes Doerfert       expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), &*IP, &VTV);
89e71c6ab5STobias Grosser 
90e71c6ab5STobias Grosser   BBMap[Old] = Expanded;
91e71c6ab5STobias Grosser   return Expanded;
92e71c6ab5STobias Grosser }
9333cb9f94STobias Grosser 
942f1acac6STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
952f1acac6STobias Grosser                                    LoopToScevMapT &LTS, Loop *L) const {
969bd0dad9STobias Grosser   // Constants that do not reference any named value can always remain
975bbc0e18SMichael Kruse   // unchanged. Handle them early to avoid expensive map lookups. We do not take
989bd0dad9STobias Grosser   // the fast-path for external constants which are referenced through globals
999bd0dad9STobias Grosser   // as these may need to be rewritten when distributing code accross different
1009bd0dad9STobias Grosser   // LLVM modules.
1019bd0dad9STobias Grosser   if (isa<Constant>(Old) && !isa<GlobalValue>(Old))
1026f764bbdSTobias Grosser     return Old;
10333cb9f94STobias Grosser 
10428f8ac1dSJohannes Doerfert   // Inline asm is like a constant to us.
10528f8ac1dSJohannes Doerfert   if (isa<InlineAsm>(Old))
10628f8ac1dSJohannes Doerfert     return Old;
10728f8ac1dSJohannes Doerfert 
10833cb9f94STobias Grosser   if (Value *New = GlobalMap.lookup(Old)) {
10933cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
11033cb9f94STobias Grosser       New = NewRemapped;
11133cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
11233cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
11333cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
11433cb9f94STobias Grosser 
11533cb9f94STobias Grosser     return New;
11633cb9f94STobias Grosser   }
11733cb9f94STobias Grosser 
11833cb9f94STobias Grosser   if (Value *New = BBMap.lookup(Old))
11933cb9f94STobias Grosser     return New;
12033cb9f94STobias Grosser 
12133cb9f94STobias Grosser   if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
12233cb9f94STobias Grosser     return New;
12333cb9f94STobias Grosser 
12416371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
12516371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
1266f764bbdSTobias Grosser     return Old;
12716371acdSTobias Grosser 
12816371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
12916371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
130952b5304SJohannes Doerfert     if (!Stmt.getParent()->contains(Inst->getParent()))
1316f764bbdSTobias Grosser       return Old;
13216371acdSTobias Grosser 
13316371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1345b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1355a56cbf4STobias Grosser   return nullptr;
1363b11a16aSHongbin Zheng }
1373b11a16aSHongbin Zheng 
1382f1acac6STobias Grosser void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
139bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
140030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
141030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
142030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
143030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
144030237d0STobias Grosser     return;
145030237d0STobias Grosser 
1463b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1473b11a16aSHongbin Zheng 
1483b11a16aSHongbin Zheng   // Replace old operands with the new ones.
14991f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
150bc132607STobias Grosser     Value *NewOperand =
1512c3ffc04SJohannes Doerfert         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForStmt(Stmt));
1523b11a16aSHongbin Zheng 
1533b11a16aSHongbin Zheng     if (!NewOperand) {
154c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
155c14582f2STobias Grosser              "Store instructions are always needed!");
1563b11a16aSHongbin Zheng       delete NewInst;
1573b11a16aSHongbin Zheng       return;
1583b11a16aSHongbin Zheng     }
1593b11a16aSHongbin Zheng 
1603b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1613b11a16aSHongbin Zheng   }
1623b11a16aSHongbin Zheng 
1633b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1643b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1653b11a16aSHongbin Zheng 
1663b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
1673b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
1683b11a16aSHongbin Zheng }
1693b11a16aSHongbin Zheng 
17070131d34SMichael Kruse Value *
17170131d34SMichael Kruse BlockGenerator::generateLocationAccessed(ScopStmt &Stmt, MemAccInst Inst,
17270131d34SMichael Kruse                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
17370131d34SMichael Kruse                                          isl_id_to_ast_expr *NewAccesses) {
17409214772STobias Grosser   const MemoryAccess &MA = Stmt.getArrayAccessFor(Inst);
1753b11a16aSHongbin Zheng 
1762d1ed0bfSTobias Grosser   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
1773b11a16aSHongbin Zheng 
1782d1ed0bfSTobias Grosser   if (AccessExpr) {
1792d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
18098b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
18198b3ee50STobias Grosser 
18298b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
18398b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
18498b3ee50STobias Grosser     // the newly generated pointer.
18598b3ee50STobias Grosser     auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
18698b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
18798b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
18898b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
18998b3ee50STobias Grosser 
190d840fc72STobias Grosser     if (OldPtrTy != NewPtrTy)
19198b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
19298b3ee50STobias Grosser     return Address;
1932d1ed0bfSTobias Grosser   }
1942d1ed0bfSTobias Grosser 
19570131d34SMichael Kruse   return getNewValue(Stmt, Inst.getPointerOperand(), BBMap, LTS,
1962c3ffc04SJohannes Doerfert                      getLoopForStmt(Stmt));
1973b11a16aSHongbin Zheng }
1983b11a16aSHongbin Zheng 
1992c3ffc04SJohannes Doerfert Loop *BlockGenerator::getLoopForStmt(const ScopStmt &Stmt) const {
200375cb5feSMichael Kruse   auto *StmtBB = Stmt.getEntryBlock();
2012c3ffc04SJohannes Doerfert   return LI.getLoopFor(StmtBB);
202369430ffSTobias Grosser }
203369430ffSTobias Grosser 
2042f1acac6STobias Grosser Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, LoadInst *Load,
205bc132607STobias Grosser                                           ValueMapT &BBMap, LoopToScevMapT &LTS,
2062d1ed0bfSTobias Grosser                                           isl_id_to_ast_expr *NewAccesses) {
207c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
208c1db67e2SJohannes Doerfert     return PreloadLoad;
209c1db67e2SJohannes Doerfert 
210bc132607STobias Grosser   Value *NewPointer =
21170131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, LTS, NewAccesses);
21287901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
21387901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
21486bc93a9STobias Grosser 
21586bc93a9STobias Grosser   if (DebugPrinting)
21686bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
21786bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
21886bc93a9STobias Grosser 
2193b11a16aSHongbin Zheng   return ScalarLoad;
2203b11a16aSHongbin Zheng }
2213b11a16aSHongbin Zheng 
2222f1acac6STobias Grosser void BlockGenerator::generateScalarStore(ScopStmt &Stmt, StoreInst *Store,
223bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
2242d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
225bc132607STobias Grosser   Value *NewPointer =
22670131d34SMichael Kruse       generateLocationAccessed(Stmt, Store, BBMap, LTS, NewAccesses);
227bc132607STobias Grosser   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
2282c3ffc04SJohannes Doerfert                                     getLoopForStmt(Stmt));
2293b11a16aSHongbin Zheng 
23086bc93a9STobias Grosser   if (DebugPrinting)
23186bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
23286bc93a9STobias Grosser                                           ": ", ValueOperand, "\n");
23386bc93a9STobias Grosser 
234c186ac7aSTobias Grosser   Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
2353b11a16aSHongbin Zheng }
2363b11a16aSHongbin Zheng 
2375dced269SJohannes Doerfert bool BlockGenerator::canSyntheziseInStmt(ScopStmt &Stmt, Instruction *Inst) {
2382c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
2395dced269SJohannes Doerfert   return (Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
2400f0d209bSJohannes Doerfert          canSynthesize(Inst, *Stmt.getParent(), &LI, &SE, L);
2415dced269SJohannes Doerfert }
2425dced269SJohannes Doerfert 
2432f1acac6STobias Grosser void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
244bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
2452d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
2463b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2473b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2483b11a16aSHongbin Zheng   if (Inst->isTerminator())
2493b11a16aSHongbin Zheng     return;
2503b11a16aSHongbin Zheng 
251aff56c8aSTobias Grosser   // Synthesizable statements will be generated on-demand.
2525dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
253e71c6ab5STobias Grosser     return;
254e71c6ab5STobias Grosser 
2559646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
256bc132607STobias Grosser     Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
2573d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2583d94fedfSSebastian Pop     // deterministic.
259753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2603b11a16aSHongbin Zheng     return;
2613b11a16aSHongbin Zheng   }
2623b11a16aSHongbin Zheng 
2639646e3feSTobias Grosser   if (auto *Store = dyn_cast<StoreInst>(Inst)) {
264bc132607STobias Grosser     generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
2653b11a16aSHongbin Zheng     return;
2663b11a16aSHongbin Zheng   }
2673b11a16aSHongbin Zheng 
2689646e3feSTobias Grosser   if (auto *PHI = dyn_cast<PHINode>(Inst)) {
269bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
270ecff11dcSJohannes Doerfert     return;
271ecff11dcSJohannes Doerfert   }
272ecff11dcSJohannes Doerfert 
2733f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
2743f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
2759c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
2763f500fa2SJohannes Doerfert     return;
2773f500fa2SJohannes Doerfert 
278bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
2793b11a16aSHongbin Zheng }
2803b11a16aSHongbin Zheng 
2819d12d8adSTobias Grosser void BlockGenerator::removeDeadInstructions(BasicBlock *BB, ValueMapT &BBMap) {
2829d12d8adSTobias Grosser   for (auto I = BB->rbegin(), E = BB->rend(); I != E; I++) {
2839d12d8adSTobias Grosser     Instruction *Inst = &*I;
2849d12d8adSTobias Grosser     Value *NewVal = BBMap[Inst];
2859d12d8adSTobias Grosser 
2869d12d8adSTobias Grosser     if (!NewVal)
2879d12d8adSTobias Grosser       continue;
2889d12d8adSTobias Grosser 
2899d12d8adSTobias Grosser     Instruction *NewInst = dyn_cast<Instruction>(NewVal);
2909d12d8adSTobias Grosser 
2919d12d8adSTobias Grosser     if (!NewInst)
2929d12d8adSTobias Grosser       continue;
2939d12d8adSTobias Grosser 
2949d12d8adSTobias Grosser     if (!isInstructionTriviallyDead(NewInst))
2959d12d8adSTobias Grosser       continue;
2969d12d8adSTobias Grosser 
2979d12d8adSTobias Grosser     BBMap.erase(Inst);
2989d12d8adSTobias Grosser     NewInst->eraseFromParent();
2999d12d8adSTobias Grosser   }
3009d12d8adSTobias Grosser }
3019d12d8adSTobias Grosser 
302bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
3032d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
304275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
305275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
306275a1756SJohannes Doerfert 
307275a1756SJohannes Doerfert   ValueMapT BBMap;
308275a1756SJohannes Doerfert 
309be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
310bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
3119d12d8adSTobias Grosser   removeDeadInstructions(BB, BBMap);
312275a1756SJohannes Doerfert }
313275a1756SJohannes Doerfert 
314514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
315b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
316b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
3173b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
318514f6efaSJohannes Doerfert   return CopyBB;
319514f6efaSJohannes Doerfert }
3203b11a16aSHongbin Zheng 
321514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
322bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
3232d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
324514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
325b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
326225f0d1eSMichael Kruse   generateScalarLoads(Stmt, BBMap);
327225f0d1eSMichael Kruse 
328bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
329225f0d1eSMichael Kruse 
330225f0d1eSMichael Kruse   // After a basic block was copied store all scalars that escape this block in
331225f0d1eSMichael Kruse   // their alloca.
332225f0d1eSMichael Kruse   generateScalarStores(Stmt, LTS, BBMap);
333514f6efaSJohannes Doerfert   return CopyBB;
334514f6efaSJohannes Doerfert }
335514f6efaSJohannes Doerfert 
336514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
337bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
3382d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
339ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
340ecff11dcSJohannes Doerfert 
34191f5b262STobias Grosser   for (Instruction &Inst : *BB)
342bc132607STobias Grosser     copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
343ecff11dcSJohannes Doerfert }
344ecff11dcSJohannes Doerfert 
34564c0ff41STobias Grosser Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
346ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &Map,
3472985400aSTobias Grosser                                          const char *NameExt) {
348ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
349e9cb5a09STobias Grosser   if (!Map.count(ScalarBase)) {
350ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
351b09455deSTobias Grosser     auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
35264c0ff41STobias Grosser     EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
353b8f58b53SDuncan P. N. Exon Smith     NewAddr->insertBefore(&*EntryBB->getFirstInsertionPt());
354e9cb5a09STobias Grosser     Map[ScalarBase] = NewAddr;
355ecff11dcSJohannes Doerfert   }
356ecff11dcSJohannes Doerfert 
357e9cb5a09STobias Grosser   auto Addr = Map[ScalarBase];
358e9cb5a09STobias Grosser 
3595c7f16beSTobias Grosser   if (auto NewAddr = GlobalMap.lookup(Addr))
3605c7f16beSTobias Grosser     return NewAddr;
36164c0ff41STobias Grosser 
362ecff11dcSJohannes Doerfert   return Addr;
363ecff11dcSJohannes Doerfert }
364ecff11dcSJohannes Doerfert 
365800e17a7SJohannes Doerfert Value *BlockGenerator::getOrCreateAlloca(const MemoryAccess &Access) {
3663216f854STobias Grosser   assert(!Access.isArrayKind() && "Trying to get alloca for array kind");
3673216f854STobias Grosser 
368a535dff4STobias Grosser   if (Access.isPHIKind())
369b8d27aabSTobias Grosser     return getOrCreatePHIAlloca(Access.getBaseAddr());
370b8d27aabSTobias Grosser   else
371b8d27aabSTobias Grosser     return getOrCreateScalarAlloca(Access.getBaseAddr());
372a4f0988dSTobias Grosser }
373a4f0988dSTobias Grosser 
374a4f0988dSTobias Grosser Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
3753216f854STobias Grosser   assert(!Array->isArrayKind() && "Trying to get alloca for array kind");
3763216f854STobias Grosser 
377a535dff4STobias Grosser   if (Array->isPHIKind())
378a4f0988dSTobias Grosser     return getOrCreatePHIAlloca(Array->getBasePtr());
379f8d55f7eSTobias Grosser   else
380a4f0988dSTobias Grosser     return getOrCreateScalarAlloca(Array->getBasePtr());
381f8d55f7eSTobias Grosser }
382f8d55f7eSTobias Grosser 
383bc132607STobias Grosser Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
384bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
385b79a67dfSTobias Grosser }
386b79a67dfSTobias Grosser 
387bc132607STobias Grosser Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
388bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
389b79a67dfSTobias Grosser }
390b79a67dfSTobias Grosser 
39138a012c4SJohannes Doerfert void BlockGenerator::handleOutsideUsers(const Scop &S, Instruction *Inst) {
3922985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
3932985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
3942985400aSTobias Grosser   // copied multiple times we already did this and can exit.
395acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
396acb6ade7SMichael Kruse     return;
397e69e1141SJohannes Doerfert 
398ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
399ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
400ecff11dcSJohannes Doerfert 
401ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
402ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
403ecff11dcSJohannes Doerfert     if (!UI)
404ecff11dcSJohannes Doerfert       continue;
405ecff11dcSJohannes Doerfert 
406952b5304SJohannes Doerfert     if (S.contains(UI))
407ecff11dcSJohannes Doerfert       continue;
408ecff11dcSJohannes Doerfert 
409ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
410ecff11dcSJohannes Doerfert   }
411ecff11dcSJohannes Doerfert 
412ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
413ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
414ecff11dcSJohannes Doerfert     return;
415ecff11dcSJohannes Doerfert 
416ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
41738a012c4SJohannes Doerfert   auto *ScalarAddr = getOrCreateScalarAlloca(Inst);
418ecff11dcSJohannes Doerfert 
419ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
420ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
421ecff11dcSJohannes Doerfert }
422ecff11dcSJohannes Doerfert 
423225f0d1eSMichael Kruse void BlockGenerator::generateScalarLoads(ScopStmt &Stmt, ValueMapT &BBMap) {
424225f0d1eSMichael Kruse   for (MemoryAccess *MA : Stmt) {
425a535dff4STobias Grosser     if (MA->isArrayKind() || MA->isWrite())
426ecff11dcSJohannes Doerfert       continue;
427ecff11dcSJohannes Doerfert 
428e2bccbbfSMichael Kruse     auto *Address = getOrCreateAlloca(*MA);
429eac9726eSMichael Kruse     assert((!isa<Instruction>(Address) ||
430eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Address)->getParent(),
431eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
432eac9726eSMichael Kruse            "Domination violation");
433e2bccbbfSMichael Kruse     BBMap[MA->getBaseAddr()] =
4342fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
435ecff11dcSJohannes Doerfert   }
436ecff11dcSJohannes Doerfert }
437ecff11dcSJohannes Doerfert 
438225f0d1eSMichael Kruse void BlockGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
439bc132607STobias Grosser                                           ValueMapT &BBMap) {
440f2cdd144STobias Grosser   Loop *L = LI.getLoopFor(Stmt.getBasicBlock());
441ecff11dcSJohannes Doerfert 
442225f0d1eSMichael Kruse   assert(Stmt.isBlockStmt() && "Region statements need to use the "
443225f0d1eSMichael Kruse                                "generateScalarStores() function in the "
444225f0d1eSMichael Kruse                                "RegionGenerator");
445ecff11dcSJohannes Doerfert 
446ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
447a535dff4STobias Grosser     if (MA->isArrayKind() || MA->isRead())
448ecff11dcSJohannes Doerfert       continue;
449ecff11dcSJohannes Doerfert 
450d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
451ee6a4fc6SMichael Kruse     if (MA->isAnyPHIKind()) {
452ee6a4fc6SMichael Kruse       assert(MA->getIncoming().size() >= 1 &&
453ee6a4fc6SMichael Kruse              "Block statements have exactly one exiting block, or multiple but "
454ee6a4fc6SMichael Kruse              "with same incoming block and value");
455ee6a4fc6SMichael Kruse       assert(std::all_of(MA->getIncoming().begin(), MA->getIncoming().end(),
456ee6a4fc6SMichael Kruse                          [&](std::pair<BasicBlock *, Value *> p) -> bool {
457ee6a4fc6SMichael Kruse                            return p.first == Stmt.getBasicBlock();
458ee6a4fc6SMichael Kruse                          }) &&
459ee6a4fc6SMichael Kruse              "Incoming block must be statement's block");
460ee6a4fc6SMichael Kruse       Val = MA->getIncoming()[0].second;
461ee6a4fc6SMichael Kruse     }
462bc132607STobias Grosser     auto *Address = getOrCreateAlloca(*MA);
463d86f2157SJohannes Doerfert 
464f2cdd144STobias Grosser     Val = getNewValue(Stmt, Val, BBMap, LTS, L);
465eac9726eSMichael Kruse     assert((!isa<Instruction>(Val) ||
466eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Val)->getParent(),
467eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
468eac9726eSMichael Kruse            "Domination violation");
469eac9726eSMichael Kruse     assert((!isa<Instruction>(Address) ||
470eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Address)->getParent(),
471eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
472eac9726eSMichael Kruse            "Domination violation");
47392245228STobias Grosser     Builder.CreateStore(Val, Address);
474ecff11dcSJohannes Doerfert   }
475ecff11dcSJohannes Doerfert }
476ecff11dcSJohannes Doerfert 
477c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
478ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExit();
479188542fdSJohannes Doerfert 
480ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
481ef74443cSJohannes Doerfert   BasicBlock *SplitBB = S.getEnteringBlock();
482ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
483ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
484ecff11dcSJohannes Doerfert 
485ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
486ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
487ef74443cSJohannes Doerfert   if (StartBB == S.getEntry())
488ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
489ecff11dcSJohannes Doerfert 
490fb19dd69SJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
491ecff11dcSJohannes Doerfert 
492d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
493c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
494c0091a77STobias Grosser       continue;
495a535dff4STobias Grosser     if (Array->isPHIKind()) {
496c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
497c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
498c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
499c0091a77STobias Grosser       // 'SplitBB'.
500c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
501ecff11dcSJohannes Doerfert 
502c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
503952b5304SJohannes Doerfert         if (!S.contains(*BI) && *BI != SplitBB)
504c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
505c0091a77STobias Grosser                            "come from SplitBB");
506c0091a77STobias Grosser 
507c0091a77STobias Grosser       int Idx = PHI->getBasicBlockIndex(SplitBB);
508c0091a77STobias Grosser       if (Idx < 0)
509ecff11dcSJohannes Doerfert         continue;
510ecff11dcSJohannes Doerfert 
511c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
512ecff11dcSJohannes Doerfert 
513bc132607STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
514c0091a77STobias Grosser       continue;
515c0091a77STobias Grosser     }
516c0091a77STobias Grosser 
517c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
518c0091a77STobias Grosser 
519952b5304SJohannes Doerfert     if (Inst && S.contains(Inst))
520c0091a77STobias Grosser       continue;
521c0091a77STobias Grosser 
522188542fdSJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are either exit
523188542fdSJohannes Doerfert     // PHI nodes we model as common scalars but without initialization, or
524188542fdSJohannes Doerfert     // incoming phi nodes that need to be initialized. Check if the first is the
525188542fdSJohannes Doerfert     // case for Inst and do not create and initialize memory if so.
526188542fdSJohannes Doerfert     if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
527188542fdSJohannes Doerfert       if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
528717b8667SJohannes Doerfert         continue;
529717b8667SJohannes Doerfert 
530c0091a77STobias Grosser     Builder.CreateStore(Array->getBasePtr(),
531bc132607STobias Grosser                         getOrCreateScalarAlloca(Array->getBasePtr()));
532ecff11dcSJohannes Doerfert   }
533ecff11dcSJohannes Doerfert }
534ecff11dcSJohannes Doerfert 
535ef74443cSJohannes Doerfert void BlockGenerator::createScalarFinalization(Scop &S) {
536ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
537ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExitingBlock();
538ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
539ef74443cSJohannes Doerfert   BasicBlock *MergeBB = S.getExit();
540ecff11dcSJohannes Doerfert 
541ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
542ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
543ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
544ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
545ecff11dcSJohannes Doerfert 
546ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
547ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
548ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
549ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
550*fbde4355SMichael Kruse     Instruction *EscapeInst = EscapeMapping.first;
551*fbde4355SMichael Kruse     const auto &EscapeMappingValue = EscapeMapping.second;
552ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
55364c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
554ecff11dcSJohannes Doerfert 
555ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
556d8b6ad25SJohannes Doerfert     Value *EscapeInstReload =
557ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
558d8b6ad25SJohannes Doerfert     EscapeInstReload =
559d8b6ad25SJohannes Doerfert         Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
560ecff11dcSJohannes Doerfert 
561ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
562ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
563ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
564b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
565ecff11dcSJohannes Doerfert 
566ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
567ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
568ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
569ecff11dcSJohannes Doerfert 
570ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
571ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
572ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
573ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
574ecff11dcSJohannes Doerfert 
575ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
576ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
577ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
578ecff11dcSJohannes Doerfert   }
579ecff11dcSJohannes Doerfert }
580ecff11dcSJohannes Doerfert 
581ffa2446fSTobias Grosser void BlockGenerator::findOutsideUsers(Scop &S) {
582d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
583ffa2446fSTobias Grosser 
584ffa2446fSTobias Grosser     if (Array->getNumberOfDimensions() != 0)
585ffa2446fSTobias Grosser       continue;
586ffa2446fSTobias Grosser 
587a535dff4STobias Grosser     if (Array->isPHIKind())
588ffa2446fSTobias Grosser       continue;
589ffa2446fSTobias Grosser 
590ffa2446fSTobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
591ffa2446fSTobias Grosser 
592ffa2446fSTobias Grosser     if (!Inst)
593ffa2446fSTobias Grosser       continue;
594ffa2446fSTobias Grosser 
595ffa2446fSTobias Grosser     // Scop invariant hoisting moves some of the base pointers out of the scop.
596ffa2446fSTobias Grosser     // We can ignore these, as the invariant load hoisting already registers the
597ffa2446fSTobias Grosser     // relevant outside users.
598952b5304SJohannes Doerfert     if (!S.contains(Inst))
599ffa2446fSTobias Grosser       continue;
600ffa2446fSTobias Grosser 
60138a012c4SJohannes Doerfert     handleOutsideUsers(S, Inst);
602ffa2446fSTobias Grosser   }
603ffa2446fSTobias Grosser }
604ffa2446fSTobias Grosser 
60527d742daSTobias Grosser void BlockGenerator::createExitPHINodeMerges(Scop &S) {
60627d742daSTobias Grosser   if (S.hasSingleExitEdge())
60727d742daSTobias Grosser     return;
60827d742daSTobias Grosser 
609ef74443cSJohannes Doerfert   auto *ExitBB = S.getExitingBlock();
610ef74443cSJohannes Doerfert   auto *MergeBB = S.getExit();
61127d742daSTobias Grosser   auto *AfterMergeBB = MergeBB->getSingleSuccessor();
61227d742daSTobias Grosser   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
61327d742daSTobias Grosser   if (OptExitBB == ExitBB)
61427d742daSTobias Grosser     OptExitBB = *(++pred_begin(MergeBB));
61527d742daSTobias Grosser 
61627d742daSTobias Grosser   Builder.SetInsertPoint(OptExitBB->getTerminator());
61727d742daSTobias Grosser 
618d7754a12SRoman Gareev   for (auto &SAI : S.arrays()) {
61927d742daSTobias Grosser     auto *Val = SAI->getBasePtr();
62027d742daSTobias Grosser 
621faedfcbfSMichael Kruse     // Only Value-like scalars need a merge PHI. Exit block PHIs receive either
622faedfcbfSMichael Kruse     // the original PHI's value or the reloaded incoming values from the
623faedfcbfSMichael Kruse     // generated code. An llvm::Value is merged between the original code's
624faedfcbfSMichael Kruse     // value or the generated one.
625faedfcbfSMichael Kruse     if (!SAI->isValueKind() && !SAI->isExitPHIKind())
626faedfcbfSMichael Kruse       continue;
627faedfcbfSMichael Kruse 
62827d742daSTobias Grosser     PHINode *PHI = dyn_cast<PHINode>(Val);
62927d742daSTobias Grosser     if (!PHI)
63027d742daSTobias Grosser       continue;
63127d742daSTobias Grosser 
632a3f6edaeSTobias Grosser     if (PHI->getParent() != AfterMergeBB)
63327d742daSTobias Grosser       continue;
63427d742daSTobias Grosser 
63527d742daSTobias Grosser     std::string Name = PHI->getName();
63627d742daSTobias Grosser     Value *ScalarAddr = getOrCreateScalarAlloca(PHI);
63727d742daSTobias Grosser     Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
63827d742daSTobias Grosser     Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
63927d742daSTobias Grosser     Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
640faedfcbfSMichael Kruse     assert((!isa<Instruction>(OriginalValue) ||
641faedfcbfSMichael Kruse             cast<Instruction>(OriginalValue)->getParent() != MergeBB) &&
642faedfcbfSMichael Kruse            "Original value must no be one we just generated.");
64327d742daSTobias Grosser     auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
644b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
64527d742daSTobias Grosser     MergePHI->addIncoming(Reload, OptExitBB);
64627d742daSTobias Grosser     MergePHI->addIncoming(OriginalValue, ExitBB);
64727d742daSTobias Grosser     int Idx = PHI->getBasicBlockIndex(MergeBB);
64827d742daSTobias Grosser     PHI->setIncomingValue(Idx, MergePHI);
64927d742daSTobias Grosser   }
65027d742daSTobias Grosser }
65127d742daSTobias Grosser 
652ffa2446fSTobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
653ffa2446fSTobias Grosser   findOutsideUsers(S);
654c0091a77STobias Grosser   createScalarInitialization(S);
65527d742daSTobias Grosser   createExitPHINodeMerges(S);
656ef74443cSJohannes Doerfert   createScalarFinalization(S);
6573b11a16aSHongbin Zheng }
6583b11a16aSHongbin Zheng 
659be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
660be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
661be9c9117SJohannes Doerfert                                            isl_map *Schedule)
662bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
663a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
6643b11a16aSHongbin Zheng }
6653b11a16aSHongbin Zheng 
6662f1acac6STobias Grosser Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
667e602a076STobias Grosser                                             ValueMapT &VectorMap,
668e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
669e602a076STobias Grosser                                             Loop *L) {
670fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
671fe11e287SHongbin Zheng     return NewValue;
6723b11a16aSHongbin Zheng 
6733b11a16aSHongbin Zheng   int Width = getVectorWidth();
6743b11a16aSHongbin Zheng 
6753b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6763b11a16aSHongbin Zheng 
6773b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
678c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
679bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
6807242ad92STobias Grosser         Builder.getInt32(Lane));
6813b11a16aSHongbin Zheng 
6823b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6833b11a16aSHongbin Zheng 
6843b11a16aSHongbin Zheng   return Vector;
6853b11a16aSHongbin Zheng }
6863b11a16aSHongbin Zheng 
6873b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6883b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6893b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6903b11a16aSHongbin Zheng 
6913b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6923b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6933b11a16aSHongbin Zheng 
6943b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6953b11a16aSHongbin Zheng }
6963b11a16aSHongbin Zheng 
697be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
6982f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
6992d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
7000dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
7019646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
7020dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
7030dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
7040dd463faSTobias Grosser 
7058f25b0cbSMichael Kruse   Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[Offset],
706bc132607STobias Grosser                                                VLTS[Offset], NewAccesses);
707c14582f2STobias Grosser   Value *VectorPtr =
708c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
709c14582f2STobias Grosser   LoadInst *VecLoad =
710c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
7113b11a16aSHongbin Zheng   if (!Aligned)
7123b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
7133b11a16aSHongbin Zheng 
7140dd463faSTobias Grosser   if (NegativeStride) {
7150dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
7160dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
7170dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
7180dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
7190dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
7200dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
7210dd463faSTobias Grosser     return RevVecLoad;
7220dd463faSTobias Grosser   }
7230dd463faSTobias Grosser 
7243b11a16aSHongbin Zheng   return VecLoad;
7253b11a16aSHongbin Zheng }
7263b11a16aSHongbin Zheng 
7272d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
7282f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
7292d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7309646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
7313b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
73270131d34SMichael Kruse   Value *NewPointer =
73370131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, VLTS[0], NewAccesses);
7343b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
7353b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
736c14582f2STobias Grosser   LoadInst *ScalarLoad =
737c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
7383b11a16aSHongbin Zheng 
7393b11a16aSHongbin Zheng   if (!Aligned)
7403b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
7413b11a16aSHongbin Zheng 
742c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
743c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
7443b11a16aSHongbin Zheng 
745c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
746c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
7473b11a16aSHongbin Zheng   return VectorLoad;
7483b11a16aSHongbin Zheng }
7493b11a16aSHongbin Zheng 
750be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
7512f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
75209e3697fSJohannes Doerfert     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7533b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
7549646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
7553b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
7563b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
7573b11a16aSHongbin Zheng 
7583b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
7593b11a16aSHongbin Zheng 
7603b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
76170131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[i],
76270131d34SMichael Kruse                                                  VLTS[i], NewAccesses);
763c14582f2STobias Grosser     Value *ScalarLoad =
764c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
765c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
766c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7673b11a16aSHongbin Zheng   }
7683b11a16aSHongbin Zheng 
7693b11a16aSHongbin Zheng   return Vector;
7703b11a16aSHongbin Zheng }
7713b11a16aSHongbin Zheng 
7722d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
7732f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
7742d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
775c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
776c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
777c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
778c1db67e2SJohannes Doerfert     return;
779c1db67e2SJohannes Doerfert   }
780c1db67e2SJohannes Doerfert 
7812873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7823b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
783bc132607STobias Grosser       ScalarMaps[i][Load] =
784bc132607STobias Grosser           generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
7853b11a16aSHongbin Zheng     return;
7863b11a16aSHongbin Zheng   }
7873b11a16aSHongbin Zheng 
788184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Load);
7893b11a16aSHongbin Zheng 
79095493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
79195493984STobias Grosser   // the data location.
79295493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
79395493984STobias Grosser 
7943b11a16aSHongbin Zheng   Value *NewLoad;
795a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
7962d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
797a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
7982d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
7990dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
8002d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
8013b11a16aSHongbin Zheng   else
8022d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
8033b11a16aSHongbin Zheng 
8043b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
8053b11a16aSHongbin Zheng }
8063b11a16aSHongbin Zheng 
8072f1acac6STobias Grosser void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
8083b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
8093b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
8103b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
811be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
8122c3ffc04SJohannes Doerfert                                      ScalarMaps, getLoopForStmt(Stmt));
8133b11a16aSHongbin Zheng 
8143b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
8153b11a16aSHongbin Zheng 
8163b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
8173b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
8183b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
8193b11a16aSHongbin Zheng }
8203b11a16aSHongbin Zheng 
8212f1acac6STobias Grosser void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
8223b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
8233b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
8242c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
8253b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
8263b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
8273b11a16aSHongbin Zheng 
8283b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
829be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
830be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
8313b11a16aSHongbin Zheng 
8321bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
8333b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
8343b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
8353b11a16aSHongbin Zheng }
8363b11a16aSHongbin Zheng 
8372d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
8382f1acac6STobias Grosser     ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
8392d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
840184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Store);
8413b11a16aSHongbin Zheng 
8429646e3feSTobias Grosser   auto *Pointer = Store->getPointerOperand();
843be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
8442c3ffc04SJohannes Doerfert                                  ScalarMaps, getLoopForStmt(Stmt));
8453b11a16aSHongbin Zheng 
84650fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
84750fd7010STobias Grosser   // the data location.
84850fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
84950fd7010STobias Grosser 
850a00a0291SSebastian Pop   if (Access.isStrideOne(isl_map_copy(Schedule))) {
8511947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
85270131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[0],
85370131d34SMichael Kruse                                                  VLTS[0], NewAccesses);
8543b11a16aSHongbin Zheng 
855c14582f2STobias Grosser     Value *VectorPtr =
856c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
8573b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
8583b11a16aSHongbin Zheng 
8593b11a16aSHongbin Zheng     if (!Aligned)
8603b11a16aSHongbin Zheng       Store->setAlignment(8);
8613b11a16aSHongbin Zheng   } else {
8623b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
8631bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
86470131d34SMichael Kruse       Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[i],
86570131d34SMichael Kruse                                                    VLTS[i], NewAccesses);
8663b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
8673b11a16aSHongbin Zheng     }
8683b11a16aSHongbin Zheng   }
8693b11a16aSHongbin Zheng }
8703b11a16aSHongbin Zheng 
8713b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
8723b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
87391f5b262STobias Grosser   for (Value *Operand : Inst->operands())
87491f5b262STobias Grosser     if (VectorMap.count(Operand))
8753b11a16aSHongbin Zheng       return true;
8763b11a16aSHongbin Zheng   return false;
8773b11a16aSHongbin Zheng }
8783b11a16aSHongbin Zheng 
8793b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
8803b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
8813b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
8823b11a16aSHongbin Zheng   bool HasVectorOperand = false;
8833b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8843b11a16aSHongbin Zheng 
88591f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
88691f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
8873b11a16aSHongbin Zheng 
8883b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
8893b11a16aSHongbin Zheng       continue;
8903b11a16aSHongbin Zheng 
8913b11a16aSHongbin Zheng     HasVectorOperand = true;
8923b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
8933b11a16aSHongbin Zheng 
8943b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
8953b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
8963b11a16aSHongbin Zheng 
8973b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
8983b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
8992219d157STobias Grosser       // existence of all of them.
90091f5b262STobias Grosser       if (SM.count(Operand))
9013b11a16aSHongbin Zheng         break;
9023b11a16aSHongbin Zheng 
90391f5b262STobias Grosser       SM[Operand] =
90491f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
9053b11a16aSHongbin Zheng     }
9063b11a16aSHongbin Zheng   }
9073b11a16aSHongbin Zheng 
9083b11a16aSHongbin Zheng   return HasVectorOperand;
9093b11a16aSHongbin Zheng }
9103b11a16aSHongbin Zheng 
9112d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
9122f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
9132d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
9143b11a16aSHongbin Zheng   bool HasVectorOperand;
9153b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
9163b11a16aSHongbin Zheng 
9173b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
9183b11a16aSHongbin Zheng 
9193b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
920be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
921bc132607STobias Grosser                                     VLTS[VectorLane], NewAccesses);
9223b11a16aSHongbin Zheng 
9233b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
9243b11a16aSHongbin Zheng     return;
9253b11a16aSHongbin Zheng 
9263b11a16aSHongbin Zheng   // Make the result available as vector value.
9273b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
9283b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
9293b11a16aSHongbin Zheng 
9303b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
9313b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
9323b11a16aSHongbin Zheng                                          Builder.getInt32(i));
9333b11a16aSHongbin Zheng 
9343b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
9353b11a16aSHongbin Zheng }
9363b11a16aSHongbin Zheng 
937bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
9383b11a16aSHongbin Zheng 
9392d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
9402f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
9412d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
9423b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
9433b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
9443b11a16aSHongbin Zheng   if (Inst->isTerminator())
9453b11a16aSHongbin Zheng     return;
9463b11a16aSHongbin Zheng 
9475dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
948e71c6ab5STobias Grosser     return;
949e71c6ab5STobias Grosser 
9509646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
9512d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
9523b11a16aSHongbin Zheng     return;
9533b11a16aSHongbin Zheng   }
9543b11a16aSHongbin Zheng 
9553b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
9569646e3feSTobias Grosser     if (auto *Store = dyn_cast<StoreInst>(Inst)) {
9572d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
9583b11a16aSHongbin Zheng       return;
9593b11a16aSHongbin Zheng     }
9603b11a16aSHongbin Zheng 
9619646e3feSTobias Grosser     if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
962be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9633b11a16aSHongbin Zheng       return;
9643b11a16aSHongbin Zheng     }
9653b11a16aSHongbin Zheng 
9669646e3feSTobias Grosser     if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
967be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
9683b11a16aSHongbin Zheng       return;
9693b11a16aSHongbin Zheng     }
9703b11a16aSHongbin Zheng 
9713b11a16aSHongbin Zheng     // Falltrough: We generate scalar instructions, if we don't know how to
9723b11a16aSHongbin Zheng     // generate vector code.
9733b11a16aSHongbin Zheng   }
9743b11a16aSHongbin Zheng 
9752d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
9763b11a16aSHongbin Zheng }
9773b11a16aSHongbin Zheng 
978a69d4f0dSTobias Grosser void VectorBlockGenerator::generateScalarVectorLoads(
979a69d4f0dSTobias Grosser     ScopStmt &Stmt, ValueMapT &VectorBlockMap) {
980a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
981a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isWrite())
982a69d4f0dSTobias Grosser       continue;
983a69d4f0dSTobias Grosser 
984a69d4f0dSTobias Grosser     auto *Address = getOrCreateAlloca(*MA);
985a69d4f0dSTobias Grosser     Type *VectorPtrType = getVectorPtrTy(Address, 1);
986a69d4f0dSTobias Grosser     Value *VectorPtr = Builder.CreateBitCast(Address, VectorPtrType,
987a69d4f0dSTobias Grosser                                              Address->getName() + "_p_vec_p");
988a69d4f0dSTobias Grosser     auto *Val = Builder.CreateLoad(VectorPtr, Address->getName() + ".reload");
989a69d4f0dSTobias Grosser     Constant *SplatVector = Constant::getNullValue(
990a69d4f0dSTobias Grosser         VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
991a69d4f0dSTobias Grosser 
992a69d4f0dSTobias Grosser     Value *VectorVal = Builder.CreateShuffleVector(
993a69d4f0dSTobias Grosser         Val, Val, SplatVector, Address->getName() + "_p_splat");
994a69d4f0dSTobias Grosser     VectorBlockMap[MA->getBaseAddr()] = VectorVal;
995a69d4f0dSTobias Grosser   }
996a69d4f0dSTobias Grosser }
997a69d4f0dSTobias Grosser 
998a69d4f0dSTobias Grosser void VectorBlockGenerator::verifyNoScalarStores(ScopStmt &Stmt) {
999a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
1000a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isRead())
1001a69d4f0dSTobias Grosser       continue;
1002a69d4f0dSTobias Grosser 
1003a69d4f0dSTobias Grosser     llvm_unreachable("Scalar stores not expected in vector loop");
1004a69d4f0dSTobias Grosser   }
1005a69d4f0dSTobias Grosser }
1006a69d4f0dSTobias Grosser 
10072d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
10082d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1009275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
1010275a1756SJohannes Doerfert                                "the vector block generator");
1011275a1756SJohannes Doerfert 
1012be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
1013b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
1014b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
10153b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
1016b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
10173b11a16aSHongbin Zheng 
10183b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
10193b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
10203b11a16aSHongbin Zheng   // are basic block local.
10213b11a16aSHongbin Zheng   //
10223b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
10233b11a16aSHongbin Zheng   // and one for vector values.
10243b11a16aSHongbin Zheng   //
10253b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
10263b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
10273b11a16aSHongbin Zheng   //
10283b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
10293b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
10303b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
10313b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
10323b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
10333b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
10343b11a16aSHongbin Zheng 
1035a69d4f0dSTobias Grosser   generateScalarVectorLoads(Stmt, VectorBlockMap);
1036a69d4f0dSTobias Grosser 
103791f5b262STobias Grosser   for (Instruction &Inst : *BB)
10382d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
1039a69d4f0dSTobias Grosser 
1040a69d4f0dSTobias Grosser   verifyNoScalarStores(Stmt);
10413b11a16aSHongbin Zheng }
1042275a1756SJohannes Doerfert 
1043ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1044ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
1045514f6efaSJohannes Doerfert 
1046514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1047514f6efaSJohannes Doerfert   BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
1048514f6efaSJohannes Doerfert 
1049514f6efaSJohannes Doerfert   if (BBCopyIDom)
1050514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1051514f6efaSJohannes Doerfert 
1052514f6efaSJohannes Doerfert   return BBCopyIDom;
1053514f6efaSJohannes Doerfert }
1054514f6efaSJohannes Doerfert 
1055f33c125dSMichael Kruse // This is to determine whether an llvm::Value (defined in @p BB) is usable when
1056f33c125dSMichael Kruse // leaving a subregion. The straight-forward DT.dominates(BB, R->getExitBlock())
1057f33c125dSMichael Kruse // does not work in cases where the exit block has edges from outside the
1058f33c125dSMichael Kruse // region. In that case the llvm::Value would never be usable in in the exit
1059f33c125dSMichael Kruse // block. The RegionGenerator however creates an new exit block ('ExitBBCopy')
1060f33c125dSMichael Kruse // for the subregion's exiting edges only. We need to determine whether an
1061f33c125dSMichael Kruse // llvm::Value is usable in there. We do this by checking whether it dominates
1062f33c125dSMichael Kruse // all exiting blocks individually.
1063f33c125dSMichael Kruse static bool isDominatingSubregionExit(const DominatorTree &DT, Region *R,
1064f33c125dSMichael Kruse                                       BasicBlock *BB) {
1065f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1066f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1067f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1068f33c125dSMichael Kruse       continue;
1069f33c125dSMichael Kruse 
1070f33c125dSMichael Kruse     if (!DT.dominates(BB, ExitingBB))
1071f33c125dSMichael Kruse       return false;
1072f33c125dSMichael Kruse   }
1073f33c125dSMichael Kruse 
1074f33c125dSMichael Kruse   return true;
1075f33c125dSMichael Kruse }
1076f33c125dSMichael Kruse 
1077f33c125dSMichael Kruse // Find the direct dominator of the subregion's exit block if the subregion was
1078f33c125dSMichael Kruse // simplified.
1079f33c125dSMichael Kruse static BasicBlock *findExitDominator(DominatorTree &DT, Region *R) {
1080f33c125dSMichael Kruse   BasicBlock *Common = nullptr;
1081f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1082f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1083f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1084f33c125dSMichael Kruse       continue;
1085f33c125dSMichael Kruse 
1086f33c125dSMichael Kruse     // First exiting edge.
1087f33c125dSMichael Kruse     if (!Common) {
1088f33c125dSMichael Kruse       Common = ExitingBB;
1089f33c125dSMichael Kruse       continue;
1090f33c125dSMichael Kruse     }
1091f33c125dSMichael Kruse 
1092f33c125dSMichael Kruse     Common = DT.findNearestCommonDominator(Common, ExitingBB);
1093f33c125dSMichael Kruse   }
1094f33c125dSMichael Kruse 
1095f33c125dSMichael Kruse   assert(Common && R->contains(Common));
1096f33c125dSMichael Kruse   return Common;
1097f33c125dSMichael Kruse }
1098f33c125dSMichael Kruse 
1099bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
11002d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
1101275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
1102d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
1103275a1756SJohannes Doerfert 
1104ecff11dcSJohannes Doerfert   // Forget all old mappings.
1105ecff11dcSJohannes Doerfert   BlockMap.clear();
1106ecff11dcSJohannes Doerfert   RegionMaps.clear();
1107ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
1108ecff11dcSJohannes Doerfert 
1109225f0d1eSMichael Kruse   // Collection of all values related to this subregion.
1110225f0d1eSMichael Kruse   ValueMapT ValueMap;
1111225f0d1eSMichael Kruse 
1112275a1756SJohannes Doerfert   // The region represented by the statement.
1113275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1114275a1756SJohannes Doerfert 
1115ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1116ecff11dcSJohannes Doerfert   // inputs.
1117ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1118b8f58b53SDuncan P. N. Exon Smith   BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1119b8f58b53SDuncan P. N. Exon Smith                                        &*Builder.GetInsertPoint(), &DT, &LI);
1120ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1121b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&EntryBBCopy->front());
1122514f6efaSJohannes Doerfert 
1123c993739eSMichael Kruse   ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
1124c993739eSMichael Kruse   generateScalarLoads(Stmt, EntryBBMap);
1125225f0d1eSMichael Kruse 
1126ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1127ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
1128ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
1129275a1756SJohannes Doerfert 
1130275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1131275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
1132275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
1133ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1134ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1135275a1756SJohannes Doerfert 
1136275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1137275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1138275a1756SJohannes Doerfert     Blocks.pop_front();
1139275a1756SJohannes Doerfert 
1140514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1141514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1142ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1143ecff11dcSJohannes Doerfert 
1144c993739eSMichael Kruse     // Get the mapping for this block and initialize it with either the scalar
1145c993739eSMichael Kruse     // loads from the generated entering block (which dominates all blocks of
1146c993739eSMichael Kruse     // this subregion) or the maps of the immediate dominator, if part of the
1147c993739eSMichael Kruse     // subregion. The latter necessarily includes the former.
1148c993739eSMichael Kruse     ValueMapT *InitBBMap;
1149c993739eSMichael Kruse     if (BBCopyIDom) {
1150c993739eSMichael Kruse       assert(RegionMaps.count(BBCopyIDom));
1151c993739eSMichael Kruse       InitBBMap = &RegionMaps[BBCopyIDom];
1152c993739eSMichael Kruse     } else
1153c993739eSMichael Kruse       InitBBMap = &EntryBBMap;
1154c993739eSMichael Kruse     auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1155c993739eSMichael Kruse     ValueMapT &RegionMap = Inserted.first->second;
1156514f6efaSJohannes Doerfert 
1157275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1158b8f58b53SDuncan P. N. Exon Smith     Builder.SetInsertPoint(&BBCopy->front());
1159bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1160275a1756SJohannes Doerfert 
1161ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1162ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1163ecff11dcSJohannes Doerfert 
1164ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1165ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1166bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1167ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1168ecff11dcSJohannes Doerfert 
1169275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1170275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1171275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1172275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1173ebffcbeeSMichael Kruse 
1174ebffcbeeSMichael Kruse     // Remember value in case it is visible after this subregion.
1175f33c125dSMichael Kruse     if (isDominatingSubregionExit(DT, R, BB))
1176ebffcbeeSMichael Kruse       ValueMap.insert(RegionMap.begin(), RegionMap.end());
1177275a1756SJohannes Doerfert   }
1178275a1756SJohannes Doerfert 
1179275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1180b8f58b53SDuncan P. N. Exon Smith   BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1181b8f58b53SDuncan P. N. Exon Smith                                       &*Builder.GetInsertPoint(), &DT, &LI);
1182ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1183514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1184514f6efaSJohannes Doerfert 
1185f33c125dSMichael Kruse   BasicBlock *ExitDomBBCopy = BlockMap.lookup(findExitDominator(DT, R));
1186f33c125dSMichael Kruse   assert(ExitDomBBCopy && "Common exit dominator must be within region; at "
1187f33c125dSMichael Kruse                           "least the entry node must match");
1188f33c125dSMichael Kruse   DT.changeImmediateDominator(ExitBBCopy, ExitDomBBCopy);
1189275a1756SJohannes Doerfert 
1190275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1191275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1192275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1193275a1756SJohannes Doerfert 
1194514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1195e114dc02SJohannes Doerfert     TerminatorInst *TI = BB->getTerminator();
1196e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1197e114dc02SJohannes Doerfert       while (!BBCopy->empty())
1198e114dc02SJohannes Doerfert         BBCopy->begin()->eraseFromParent();
1199e114dc02SJohannes Doerfert       new UnreachableInst(BBCopy->getContext(), BBCopy);
1200e114dc02SJohannes Doerfert       continue;
1201e114dc02SJohannes Doerfert     }
1202e114dc02SJohannes Doerfert 
1203275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1204275a1756SJohannes Doerfert 
1205514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1206514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1207514f6efaSJohannes Doerfert 
120845e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
12099a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1210275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1211275a1756SJohannes Doerfert   }
1212275a1756SJohannes Doerfert 
1213ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1214ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1215ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1216ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1217bc29e0b2STobias Grosser     if (L == nullptr || L->getHeader() != BB || !R->contains(L))
1218ecff11dcSJohannes Doerfert       continue;
1219ecff11dcSJohannes Doerfert 
1220ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1221ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1222ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1223ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1224ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1225ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1226b8f58b53SDuncan P. N. Exon Smith     LoopPHI->insertBefore(&BBCopy->front());
1227ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1228ecff11dcSJohannes Doerfert 
1229ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1230ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1231ecff11dcSJohannes Doerfert         continue;
1232ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1233ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1234ecff11dcSJohannes Doerfert       else
1235ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1236ecff11dcSJohannes Doerfert     }
1237ecff11dcSJohannes Doerfert 
1238ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1239ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1240ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1241ecff11dcSJohannes Doerfert 
1242ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1243ecff11dcSJohannes Doerfert   }
1244ecff11dcSJohannes Doerfert 
1245225f0d1eSMichael Kruse   // Continue generating code in the exit block.
1246b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
1247225f0d1eSMichael Kruse 
1248225f0d1eSMichael Kruse   // Write values visible to other statements.
1249225f0d1eSMichael Kruse   generateScalarStores(Stmt, LTS, ValueMap);
12503e956020STobias Grosser   BlockMap.clear();
12513e956020STobias Grosser   RegionMaps.clear();
12523e956020STobias Grosser   IncompletePHINodeMap.clear();
1253275a1756SJohannes Doerfert }
1254ecff11dcSJohannes Doerfert 
1255ee6a4fc6SMichael Kruse PHINode *RegionGenerator::buildExitPHI(MemoryAccess *MA, LoopToScevMapT &LTS,
1256ee6a4fc6SMichael Kruse                                        ValueMapT &BBMap, Loop *L) {
1257ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1258ee6a4fc6SMichael Kruse   Region *SubR = Stmt->getRegion();
1259ee6a4fc6SMichael Kruse   auto Incoming = MA->getIncoming();
1260ee6a4fc6SMichael Kruse 
1261ee6a4fc6SMichael Kruse   PollyIRBuilder::InsertPointGuard IPGuard(Builder);
1262ee6a4fc6SMichael Kruse   PHINode *OrigPHI = cast<PHINode>(MA->getAccessInstruction());
1263ee6a4fc6SMichael Kruse   BasicBlock *NewSubregionExit = Builder.GetInsertBlock();
1264ee6a4fc6SMichael Kruse 
1265ee6a4fc6SMichael Kruse   // This can happen if the subregion is simplified after the ScopStmts
1266ee6a4fc6SMichael Kruse   // have been created; simplification happens as part of CodeGeneration.
1267ee6a4fc6SMichael Kruse   if (OrigPHI->getParent() != SubR->getExit()) {
1268ee6a4fc6SMichael Kruse     BasicBlock *FormerExit = SubR->getExitingBlock();
1269ee6a4fc6SMichael Kruse     if (FormerExit)
1270ee6a4fc6SMichael Kruse       NewSubregionExit = BlockMap.lookup(FormerExit);
1271ee6a4fc6SMichael Kruse   }
1272ee6a4fc6SMichael Kruse 
1273ee6a4fc6SMichael Kruse   PHINode *NewPHI = PHINode::Create(OrigPHI->getType(), Incoming.size(),
1274ee6a4fc6SMichael Kruse                                     "polly." + OrigPHI->getName(),
1275ee6a4fc6SMichael Kruse                                     NewSubregionExit->getFirstNonPHI());
1276ee6a4fc6SMichael Kruse 
1277ee6a4fc6SMichael Kruse   // Add the incoming values to the PHI.
1278ee6a4fc6SMichael Kruse   for (auto &Pair : Incoming) {
1279ee6a4fc6SMichael Kruse     BasicBlock *OrigIncomingBlock = Pair.first;
1280ee6a4fc6SMichael Kruse     BasicBlock *NewIncomingBlock = BlockMap.lookup(OrigIncomingBlock);
1281ee6a4fc6SMichael Kruse     Builder.SetInsertPoint(NewIncomingBlock->getTerminator());
1282ee6a4fc6SMichael Kruse     assert(RegionMaps.count(NewIncomingBlock));
1283ee6a4fc6SMichael Kruse     ValueMapT *LocalBBMap = &RegionMaps[NewIncomingBlock];
1284ee6a4fc6SMichael Kruse 
1285ee6a4fc6SMichael Kruse     Value *OrigIncomingValue = Pair.second;
1286ee6a4fc6SMichael Kruse     Value *NewIncomingValue =
1287ee6a4fc6SMichael Kruse         getNewValue(*Stmt, OrigIncomingValue, *LocalBBMap, LTS, L);
1288ee6a4fc6SMichael Kruse     NewPHI->addIncoming(NewIncomingValue, NewIncomingBlock);
1289ee6a4fc6SMichael Kruse   }
1290ee6a4fc6SMichael Kruse 
1291ee6a4fc6SMichael Kruse   return NewPHI;
1292ee6a4fc6SMichael Kruse }
1293ee6a4fc6SMichael Kruse 
1294ee6a4fc6SMichael Kruse Value *RegionGenerator::getExitScalar(MemoryAccess *MA, LoopToScevMapT &LTS,
1295ee6a4fc6SMichael Kruse                                       ValueMapT &BBMap) {
1296ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1297ee6a4fc6SMichael Kruse 
1298ee6a4fc6SMichael Kruse   // TODO: Add some test cases that ensure this is really the right choice.
1299ee6a4fc6SMichael Kruse   Loop *L = LI.getLoopFor(Stmt->getRegion()->getExit());
1300ee6a4fc6SMichael Kruse 
1301ee6a4fc6SMichael Kruse   if (MA->isAnyPHIKind()) {
1302ee6a4fc6SMichael Kruse     auto Incoming = MA->getIncoming();
1303ee6a4fc6SMichael Kruse     assert(!Incoming.empty() &&
1304ee6a4fc6SMichael Kruse            "PHI WRITEs must have originate from at least one incoming block");
1305ee6a4fc6SMichael Kruse 
1306ee6a4fc6SMichael Kruse     // If there is only one incoming value, we do not need to create a PHI.
1307ee6a4fc6SMichael Kruse     if (Incoming.size() == 1) {
1308ee6a4fc6SMichael Kruse       Value *OldVal = Incoming[0].second;
1309ee6a4fc6SMichael Kruse       return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1310ee6a4fc6SMichael Kruse     }
1311ee6a4fc6SMichael Kruse 
1312ee6a4fc6SMichael Kruse     return buildExitPHI(MA, LTS, BBMap, L);
1313ee6a4fc6SMichael Kruse   }
1314ee6a4fc6SMichael Kruse 
1315ee6a4fc6SMichael Kruse   // MK_Value accesses leaving the subregion must dominate the exit block; just
1316ee6a4fc6SMichael Kruse   // pass the copied value
1317ee6a4fc6SMichael Kruse   Value *OldVal = MA->getAccessValue();
1318ee6a4fc6SMichael Kruse   return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1319ee6a4fc6SMichael Kruse }
1320ee6a4fc6SMichael Kruse 
1321225f0d1eSMichael Kruse void RegionGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
1322bc132607STobias Grosser                                            ValueMapT &BBMap) {
132375296901STobias Grosser   assert(Stmt.getRegion() &&
132475296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1325ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1326ecff11dcSJohannes Doerfert 
1327ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
1328a535dff4STobias Grosser     if (MA->isArrayKind() || MA->isRead())
1329ecff11dcSJohannes Doerfert       continue;
1330ecff11dcSJohannes Doerfert 
1331ee6a4fc6SMichael Kruse     Value *NewVal = getExitScalar(MA, LTS, BBMap);
1332ee6a4fc6SMichael Kruse     Value *Address = getOrCreateAlloca(*MA);
1333eac9726eSMichael Kruse     assert((!isa<Instruction>(NewVal) ||
1334eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(NewVal)->getParent(),
1335eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
1336eac9726eSMichael Kruse            "Domination violation");
1337eac9726eSMichael Kruse     assert((!isa<Instruction>(Address) ||
1338eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Address)->getParent(),
1339eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
1340eac9726eSMichael Kruse            "Domination violation");
1341ee6a4fc6SMichael Kruse     Builder.CreateStore(NewVal, Address);
1342ecff11dcSJohannes Doerfert   }
1343ecff11dcSJohannes Doerfert }
1344ecff11dcSJohannes Doerfert 
1345ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1346ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1347ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1348ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1349ecff11dcSJohannes Doerfert 
1350ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1351ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1352ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1353ecff11dcSJohannes Doerfert   if (!BBCopy) {
1354ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1355ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1356ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1357ecff11dcSJohannes Doerfert     return;
1358ecff11dcSJohannes Doerfert   }
1359ecff11dcSJohannes Doerfert 
1360ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1361ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1362ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1363ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1364ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1365ecff11dcSJohannes Doerfert 
1366ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1367dc122222SMichael Kruse 
13686ba92714SJohannes Doerfert     // If the current insert block is different from the PHIs incoming block
13696ba92714SJohannes Doerfert     // change it, otherwise do not.
13706ba92714SJohannes Doerfert     auto IP = Builder.GetInsertPoint();
13716ba92714SJohannes Doerfert     if (IP->getParent() != BBCopy)
1372dc122222SMichael Kruse       Builder.SetInsertPoint(BBCopy->getTerminator());
13732c3ffc04SJohannes Doerfert     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForStmt(Stmt));
13746ba92714SJohannes Doerfert     if (IP->getParent() != BBCopy)
13756ba92714SJohannes Doerfert       Builder.SetInsertPoint(&*IP);
1376ecff11dcSJohannes Doerfert   } else {
1377ecff11dcSJohannes Doerfert 
1378ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1379ecff11dcSJohannes Doerfert       return;
1380ecff11dcSJohannes Doerfert 
1381bc132607STobias Grosser     Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
1382ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1383ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1384ecff11dcSJohannes Doerfert   }
1385ecff11dcSJohannes Doerfert 
1386ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1387ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1388ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1389ecff11dcSJohannes Doerfert }
1390ecff11dcSJohannes Doerfert 
13912b809d13STobias Grosser void RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1392ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap,
1393ecff11dcSJohannes Doerfert                                          LoopToScevMapT &LTS) {
1394ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1395ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1396ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1397ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1398ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1399ecff11dcSJohannes Doerfert 
1400ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1401bc132607STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
1402ecff11dcSJohannes Doerfert }
1403