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"
20637bd631STobias Grosser #include "polly/Options.h"
213b11a16aSHongbin Zheng #include "polly/Support/GICHelper.h"
2297cb813cSSebastian Pop #include "polly/Support/SCEVValidator.h"
23ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
24e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
25f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
26e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
27030237d0STobias Grosser #include "llvm/IR/IntrinsicInst.h"
28c9895067STobias Grosser #include "llvm/IR/Module.h"
293b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
30f32d651dSJohannes Doerfert #include "isl/aff.h"
31f32d651dSJohannes Doerfert #include "isl/ast.h"
32f32d651dSJohannes Doerfert #include "isl/ast_build.h"
33ba0d0922STobias Grosser #include "isl/set.h"
34f32d651dSJohannes Doerfert #include <deque>
35f32d651dSJohannes Doerfert 
363b11a16aSHongbin Zheng using namespace llvm;
373b11a16aSHongbin Zheng using namespace polly;
383b11a16aSHongbin Zheng 
39878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
40878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
41878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
42878aba49STobias Grosser                              cl::cat(PollyCategory));
433b11a16aSHongbin Zheng 
44dcc3b435STobias Grosser bool polly::canSynthesize(const Value *V, const llvm::LoopInfo *LI,
45ecfe21b7STobias Grosser                           ScalarEvolution *SE, const Region *R) {
46dcc3b435STobias Grosser   if (!V || !SE->isSCEVable(V->getType()))
47ecfe21b7STobias Grosser     return false;
48ecfe21b7STobias Grosser 
49dcc3b435STobias Grosser   if (const SCEV *Scev = SE->getSCEV(const_cast<Value *>(V)))
50ecfe21b7STobias Grosser     if (!isa<SCEVCouldNotCompute>(Scev))
51ecfe21b7STobias Grosser       if (!hasScalarDepsInsideRegion(Scev, R))
52ecfe21b7STobias Grosser         return true;
53ecfe21b7STobias Grosser 
54ecfe21b7STobias Grosser   return false;
55ecfe21b7STobias Grosser }
56ecfe21b7STobias Grosser 
579e3a5db0SJohannes Doerfert bool polly::isIgnoredIntrinsic(const Value *V) {
589e3a5db0SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(V)) {
599e3a5db0SJohannes Doerfert     switch (IT->getIntrinsicID()) {
609e3a5db0SJohannes Doerfert     // Lifetime markers are supported/ignored.
619e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
629e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
639e3a5db0SJohannes Doerfert     // Invariant markers are supported/ignored.
649e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
659e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
669e3a5db0SJohannes Doerfert     // Some misc annotations are supported/ignored.
679e3a5db0SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
689e3a5db0SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
699e3a5db0SJohannes Doerfert     case llvm::Intrinsic::annotation:
709e3a5db0SJohannes Doerfert     case llvm::Intrinsic::donothing:
719e3a5db0SJohannes Doerfert     case llvm::Intrinsic::assume:
729e3a5db0SJohannes Doerfert     case llvm::Intrinsic::expect:
739e3a5db0SJohannes Doerfert       return true;
749e3a5db0SJohannes Doerfert     default:
759e3a5db0SJohannes Doerfert       break;
769e3a5db0SJohannes Doerfert     }
779e3a5db0SJohannes Doerfert   }
789e3a5db0SJohannes Doerfert   return false;
799e3a5db0SJohannes Doerfert }
809e3a5db0SJohannes Doerfert 
81b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
82b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
83ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
84ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
85ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
86b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
87ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
88ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
89ecff11dcSJohannes Doerfert       EscapeMap(EscapeMap) {}
90e71c6ab5STobias Grosser 
91be9c9117SJohannes Doerfert Value *BlockGenerator::getNewValue(ScopStmt &Stmt, const Value *Old,
92be9c9117SJohannes Doerfert                                    ValueMapT &BBMap, ValueMapT &GlobalMap,
93be9c9117SJohannes Doerfert                                    LoopToScevMapT &LTS, Loop *L) const {
943b11a16aSHongbin Zheng   // We assume constants never change.
953b11a16aSHongbin Zheng   // This avoids map lookups for many calls to this function.
963b11a16aSHongbin Zheng   if (isa<Constant>(Old))
973b11a16aSHongbin Zheng     return const_cast<Value *>(Old);
983b11a16aSHongbin Zheng 
99fe11e287SHongbin Zheng   if (Value *New = GlobalMap.lookup(Old)) {
100c14582f2STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
101c14582f2STobias Grosser         New->getType()->getScalarSizeInBits())
1023b11a16aSHongbin Zheng       New = Builder.CreateTruncOrBitCast(New, Old->getType());
1033b11a16aSHongbin Zheng 
1043b11a16aSHongbin Zheng     return New;
1053b11a16aSHongbin Zheng   }
1063b11a16aSHongbin Zheng 
107fe11e287SHongbin Zheng   if (Value *New = BBMap.lookup(Old))
108fe11e287SHongbin Zheng     return New;
1093b11a16aSHongbin Zheng 
110683b8e44STobias Grosser   if (SE.isSCEVable(Old->getType()))
111369430ffSTobias Grosser     if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
112e71c6ab5STobias Grosser       if (!isa<SCEVCouldNotCompute>(Scev)) {
113637b23dcSSebastian Pop         const SCEV *NewScev = apply(Scev, LTS, SE);
114637b23dcSSebastian Pop         ValueToValueMap VTV;
115637b23dcSSebastian Pop         VTV.insert(BBMap.begin(), BBMap.end());
116637b23dcSSebastian Pop         VTV.insert(GlobalMap.begin(), GlobalMap.end());
11747d4ee3eSSebastian Pop         NewScev = SCEVParameterRewriter::rewrite(NewScev, SE, VTV);
118e69e1141SJohannes Doerfert 
119e69e1141SJohannes Doerfert         Scop &S = *Stmt.getParent();
120e69e1141SJohannes Doerfert         const DataLayout &DL =
121e69e1141SJohannes Doerfert             S.getRegion().getEntry()->getParent()->getParent()->getDataLayout();
122e69e1141SJohannes Doerfert         auto IP = Builder.GetInsertPoint();
123e69e1141SJohannes Doerfert 
124e69e1141SJohannes Doerfert         assert(IP != Builder.GetInsertBlock()->end() &&
12545e7944bSTobias Grosser                "Only instructions can be insert points for SCEVExpander");
126e69e1141SJohannes Doerfert         Value *Expanded =
127e69e1141SJohannes Doerfert             expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), IP);
128e71c6ab5STobias Grosser 
129e71c6ab5STobias Grosser         BBMap[Old] = Expanded;
130e71c6ab5STobias Grosser         return Expanded;
131e71c6ab5STobias Grosser       }
132369430ffSTobias Grosser     }
133e71c6ab5STobias Grosser 
13416371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
13516371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
13616371acdSTobias Grosser     return const_cast<Value *>(Old);
13716371acdSTobias Grosser 
13816371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
13916371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
140be9c9117SJohannes Doerfert     if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
14116371acdSTobias Grosser       return const_cast<Value *>(Old);
14216371acdSTobias Grosser 
14316371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1445b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1455a56cbf4STobias Grosser   return nullptr;
1463b11a16aSHongbin Zheng }
1473b11a16aSHongbin Zheng 
148be9c9117SJohannes Doerfert void BlockGenerator::copyInstScalar(ScopStmt &Stmt, const Instruction *Inst,
149be9c9117SJohannes Doerfert                                     ValueMapT &BBMap, ValueMapT &GlobalMap,
150be9c9117SJohannes Doerfert                                     LoopToScevMapT &LTS) {
151030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
152030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
153030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
154030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
155030237d0STobias Grosser     return;
156030237d0STobias Grosser 
1573b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1583b11a16aSHongbin Zheng 
1593b11a16aSHongbin Zheng   // Replace old operands with the new ones.
16091f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
161be9c9117SJohannes Doerfert     Value *NewOperand = getNewValue(Stmt, OldOperand, BBMap, GlobalMap, LTS,
162be9c9117SJohannes Doerfert                                     getLoopForInst(Inst));
1633b11a16aSHongbin Zheng 
1643b11a16aSHongbin Zheng     if (!NewOperand) {
165c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
166c14582f2STobias Grosser              "Store instructions are always needed!");
1673b11a16aSHongbin Zheng       delete NewInst;
1683b11a16aSHongbin Zheng       return;
1693b11a16aSHongbin Zheng     }
1703b11a16aSHongbin Zheng 
1713b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1723b11a16aSHongbin Zheng   }
1733b11a16aSHongbin Zheng 
1743b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1753b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1763b11a16aSHongbin Zheng 
1773b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
1783b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
1793b11a16aSHongbin Zheng }
1803b11a16aSHongbin Zheng 
181be9c9117SJohannes Doerfert Value *BlockGenerator::generateLocationAccessed(
182be9c9117SJohannes Doerfert     ScopStmt &Stmt, const Instruction *Inst, const Value *Pointer,
1832d1ed0bfSTobias Grosser     ValueMapT &BBMap, ValueMapT &GlobalMap, LoopToScevMapT &LTS,
1842d1ed0bfSTobias Grosser     isl_id_to_ast_expr *NewAccesses) {
185be9c9117SJohannes Doerfert   const MemoryAccess &MA = Stmt.getAccessFor(Inst);
1863b11a16aSHongbin Zheng 
1872d1ed0bfSTobias Grosser   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
1883b11a16aSHongbin Zheng 
1892d1ed0bfSTobias Grosser   if (AccessExpr) {
1902d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
1912d1ed0bfSTobias Grosser     return ExprBuilder->create(AccessExpr);
1922d1ed0bfSTobias Grosser   }
1932d1ed0bfSTobias Grosser 
1942d1ed0bfSTobias Grosser   return getNewValue(Stmt, Pointer, BBMap, GlobalMap, LTS,
1952d1ed0bfSTobias Grosser                      getLoopForInst(Inst));
1963b11a16aSHongbin Zheng }
1973b11a16aSHongbin Zheng 
1984d96c8d7STobias Grosser Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
1992ef3f4fdSJohannes Doerfert   return LI.getLoopFor(Inst->getParent());
200369430ffSTobias Grosser }
201369430ffSTobias Grosser 
202be9c9117SJohannes Doerfert Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, const LoadInst *Load,
203e602a076STobias Grosser                                           ValueMapT &BBMap,
204e602a076STobias Grosser                                           ValueMapT &GlobalMap,
2052d1ed0bfSTobias Grosser                                           LoopToScevMapT &LTS,
2062d1ed0bfSTobias Grosser                                           isl_id_to_ast_expr *NewAccesses) {
2073b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
2082d1ed0bfSTobias Grosser   Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
2092d1ed0bfSTobias Grosser                                                GlobalMap, LTS, NewAccesses);
21087901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
21187901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
2123b11a16aSHongbin Zheng   return ScalarLoad;
2133b11a16aSHongbin Zheng }
2143b11a16aSHongbin Zheng 
215c186ac7aSTobias Grosser void BlockGenerator::generateScalarStore(ScopStmt &Stmt, const StoreInst *Store,
216c186ac7aSTobias Grosser                                          ValueMapT &BBMap, ValueMapT &GlobalMap,
2172d1ed0bfSTobias Grosser                                          LoopToScevMapT &LTS,
2182d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
2193b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
2202d1ed0bfSTobias Grosser   Value *NewPointer = generateLocationAccessed(Stmt, Store, Pointer, BBMap,
2212d1ed0bfSTobias Grosser                                                GlobalMap, LTS, NewAccesses);
222be9c9117SJohannes Doerfert   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap,
223be9c9117SJohannes Doerfert                                     GlobalMap, LTS, getLoopForInst(Store));
2243b11a16aSHongbin Zheng 
225c186ac7aSTobias Grosser   Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
2263b11a16aSHongbin Zheng }
2273b11a16aSHongbin Zheng 
228be9c9117SJohannes Doerfert void BlockGenerator::copyInstruction(ScopStmt &Stmt, const Instruction *Inst,
229be9c9117SJohannes Doerfert                                      ValueMapT &BBMap, ValueMapT &GlobalMap,
2302d1ed0bfSTobias Grosser                                      LoopToScevMapT &LTS,
2312d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
232ecff11dcSJohannes Doerfert 
233ecff11dcSJohannes Doerfert   // First check for possible scalar dependences for this instruction.
234ecff11dcSJohannes Doerfert   generateScalarLoads(Stmt, Inst, BBMap);
235ecff11dcSJohannes Doerfert 
2363b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2373b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2383b11a16aSHongbin Zheng   if (Inst->isTerminator())
2393b11a16aSHongbin Zheng     return;
2403b11a16aSHongbin Zheng 
241ecff11dcSJohannes Doerfert   Loop *L = getLoopForInst(Inst);
242ecff11dcSJohannes Doerfert   if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
243ecff11dcSJohannes Doerfert       canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
244ecff11dcSJohannes Doerfert     Value *NewValue = getNewValue(Stmt, Inst, BBMap, GlobalMap, LTS, L);
245ecff11dcSJohannes Doerfert     BBMap[Inst] = NewValue;
246e71c6ab5STobias Grosser     return;
247ecff11dcSJohannes Doerfert   }
248e71c6ab5STobias Grosser 
2493b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
2502d1ed0bfSTobias Grosser     Value *NewLoad =
2512d1ed0bfSTobias Grosser         generateScalarLoad(Stmt, Load, BBMap, GlobalMap, LTS, NewAccesses);
2523d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2533d94fedfSSebastian Pop     // deterministic.
254753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2553b11a16aSHongbin Zheng     return;
2563b11a16aSHongbin Zheng   }
2573b11a16aSHongbin Zheng 
2583b11a16aSHongbin Zheng   if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
2592d1ed0bfSTobias Grosser     generateScalarStore(Stmt, Store, BBMap, GlobalMap, LTS, NewAccesses);
2603b11a16aSHongbin Zheng     return;
2613b11a16aSHongbin Zheng   }
2623b11a16aSHongbin Zheng 
263ecff11dcSJohannes Doerfert   if (const PHINode *PHI = dyn_cast<PHINode>(Inst)) {
264ecff11dcSJohannes Doerfert     copyPHIInstruction(Stmt, PHI, BBMap, GlobalMap, LTS);
265ecff11dcSJohannes Doerfert     return;
266ecff11dcSJohannes Doerfert   }
267ecff11dcSJohannes Doerfert 
2683f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
2693f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
2703f500fa2SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(Inst)) {
2713f500fa2SJohannes Doerfert     switch (IT->getIntrinsicID()) {
2723f500fa2SJohannes Doerfert     // Lifetime markers are ignored.
2733f500fa2SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
2743f500fa2SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
2753f500fa2SJohannes Doerfert     // Invariant markers are ignored.
2763f500fa2SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
2773f500fa2SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
2783f500fa2SJohannes Doerfert     // Some misc annotations are ignored.
2793f500fa2SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
2803f500fa2SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
2813f500fa2SJohannes Doerfert     case llvm::Intrinsic::annotation:
2823f500fa2SJohannes Doerfert     case llvm::Intrinsic::donothing:
2833f500fa2SJohannes Doerfert     case llvm::Intrinsic::assume:
2843f500fa2SJohannes Doerfert     case llvm::Intrinsic::expect:
2853f500fa2SJohannes Doerfert       return;
2863f500fa2SJohannes Doerfert     default:
2873f500fa2SJohannes Doerfert       // Other intrinsics are copied.
2883f500fa2SJohannes Doerfert       break;
2893f500fa2SJohannes Doerfert     }
2903f500fa2SJohannes Doerfert   }
2913f500fa2SJohannes Doerfert 
292be9c9117SJohannes Doerfert   copyInstScalar(Stmt, Inst, BBMap, GlobalMap, LTS);
2933b11a16aSHongbin Zheng }
2943b11a16aSHongbin Zheng 
295275a1756SJohannes Doerfert void BlockGenerator::copyStmt(ScopStmt &Stmt, ValueMapT &GlobalMap,
2962d1ed0bfSTobias Grosser                               LoopToScevMapT &LTS,
2972d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
298275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
299275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
300275a1756SJohannes Doerfert 
301275a1756SJohannes Doerfert   ValueMapT BBMap;
302275a1756SJohannes Doerfert 
303be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
3042d1ed0bfSTobias Grosser   copyBB(Stmt, BB, BBMap, GlobalMap, LTS, NewAccesses);
305275a1756SJohannes Doerfert }
306275a1756SJohannes Doerfert 
307514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
308c14582f2STobias Grosser   BasicBlock *CopyBB =
309b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
3103b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
311514f6efaSJohannes Doerfert   return CopyBB;
312514f6efaSJohannes Doerfert }
3133b11a16aSHongbin Zheng 
314514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
315514f6efaSJohannes Doerfert                                    ValueMapT &BBMap, ValueMapT &GlobalMap,
3162d1ed0bfSTobias Grosser                                    LoopToScevMapT &LTS,
3172d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
318514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
3192d1ed0bfSTobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, GlobalMap, LTS, NewAccesses);
320514f6efaSJohannes Doerfert   return CopyBB;
321514f6efaSJohannes Doerfert }
322514f6efaSJohannes Doerfert 
323514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
324514f6efaSJohannes Doerfert                             ValueMapT &BBMap, ValueMapT &GlobalMap,
3252d1ed0bfSTobias Grosser                             LoopToScevMapT &LTS,
3262d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
327514f6efaSJohannes Doerfert   Builder.SetInsertPoint(CopyBB->begin());
328ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
329ecff11dcSJohannes Doerfert 
33091f5b262STobias Grosser   for (Instruction &Inst : *BB)
3312d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, BBMap, GlobalMap, LTS, NewAccesses);
332ecff11dcSJohannes Doerfert 
333ecff11dcSJohannes Doerfert   // After a basic block was copied store all scalars that escape this block
334ecff11dcSJohannes Doerfert   // in their alloca. First the scalars that have dependences inside the SCoP,
335ecff11dcSJohannes Doerfert   // then the ones that might escape the SCoP.
336ecff11dcSJohannes Doerfert   generateScalarStores(Stmt, BB, BBMap, GlobalMap);
337ecff11dcSJohannes Doerfert 
338ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
339ecff11dcSJohannes Doerfert   for (Instruction &Inst : *BB)
340ecff11dcSJohannes Doerfert     handleOutsideUsers(R, &Inst, BBMap[&Inst]);
341ecff11dcSJohannes Doerfert }
342ecff11dcSJohannes Doerfert 
3430164b8ffSTobias Grosser AllocaInst *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
344ecff11dcSJohannes Doerfert                                               ScalarAllocaMapTy &Map,
345ecff11dcSJohannes Doerfert                                               const char *NameExt,
346ecff11dcSJohannes Doerfert                                               bool *IsNew) {
347ecff11dcSJohannes Doerfert 
348ecff11dcSJohannes Doerfert   // Check if an alloca was cached for the base instruction.
349ecff11dcSJohannes Doerfert   AllocaInst *&Addr = Map[ScalarBase];
350ecff11dcSJohannes Doerfert 
351ecff11dcSJohannes Doerfert   // If needed indicate if it was found already or will be created.
352ecff11dcSJohannes Doerfert   if (IsNew)
353ecff11dcSJohannes Doerfert     *IsNew = (Addr == nullptr);
354ecff11dcSJohannes Doerfert 
355ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
356ecff11dcSJohannes Doerfert   if (!Addr) {
357ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
358ecff11dcSJohannes Doerfert     Addr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
359ecff11dcSJohannes Doerfert     Addr->insertBefore(EntryBB->getFirstInsertionPt());
360ecff11dcSJohannes Doerfert   }
361ecff11dcSJohannes Doerfert 
362ecff11dcSJohannes Doerfert   return Addr;
363ecff11dcSJohannes Doerfert }
364ecff11dcSJohannes Doerfert 
365*b79a67dfSTobias Grosser AllocaInst *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
366*b79a67dfSTobias Grosser   return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
367*b79a67dfSTobias Grosser }
368*b79a67dfSTobias Grosser 
369*b79a67dfSTobias Grosser AllocaInst *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
370*b79a67dfSTobias Grosser   return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
371*b79a67dfSTobias Grosser }
372*b79a67dfSTobias Grosser 
373ecff11dcSJohannes Doerfert void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
374ecff11dcSJohannes Doerfert                                         Value *InstCopy) {
375acb6ade7SMichael Kruse   // If there are escape users we get the alloca for this instruction and put
376acb6ade7SMichael Kruse   // it in the EscapeMap for later finalization. However, if the alloca was not
377acb6ade7SMichael Kruse   // created by an already handled scalar dependence we have to initialize it
378acb6ade7SMichael Kruse   // also. Lastly, if the instruction was copied multiple times we already did
379acb6ade7SMichael Kruse   // this and can exit.
380acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
381acb6ade7SMichael Kruse     return;
382e69e1141SJohannes Doerfert 
383ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
384ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
385ecff11dcSJohannes Doerfert 
386ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
387ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
388ecff11dcSJohannes Doerfert     if (!UI)
389ecff11dcSJohannes Doerfert       continue;
390ecff11dcSJohannes Doerfert 
391ddb83d0fSJohannes Doerfert     if (R.contains(UI))
392ecff11dcSJohannes Doerfert       continue;
393ecff11dcSJohannes Doerfert 
394ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
395ecff11dcSJohannes Doerfert   }
396ecff11dcSJohannes Doerfert 
397ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
398ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
399ecff11dcSJohannes Doerfert     return;
400ecff11dcSJohannes Doerfert 
401ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
402ecff11dcSJohannes Doerfert   bool IsNew;
403ecff11dcSJohannes Doerfert   AllocaInst *ScalarAddr =
404ecff11dcSJohannes Doerfert       getOrCreateAlloca(Inst, ScalarMap, ".escape", &IsNew);
405ecff11dcSJohannes Doerfert 
406ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
407ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
408ecff11dcSJohannes Doerfert 
409ecff11dcSJohannes Doerfert   // If the escape alloca was just created store the instruction in there,
410ecff11dcSJohannes Doerfert   // otherwise that happened already.
411ecff11dcSJohannes Doerfert   if (IsNew) {
412ecff11dcSJohannes Doerfert     assert(InstCopy && "Except PHIs every instruction should have a copy!");
413ecff11dcSJohannes Doerfert     Builder.CreateStore(InstCopy, ScalarAddr);
414ecff11dcSJohannes Doerfert   }
415ecff11dcSJohannes Doerfert }
416ecff11dcSJohannes Doerfert 
417ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarLoads(ScopStmt &Stmt,
418ecff11dcSJohannes Doerfert                                          const Instruction *Inst,
419ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap) {
420d4dd6ec7STobias Grosser   auto *MAL = Stmt.lookupAccessesFor(Inst);
421ecff11dcSJohannes Doerfert 
422d4dd6ec7STobias Grosser   if (!MAL)
423d4dd6ec7STobias Grosser     return;
424d4dd6ec7STobias Grosser 
425ecff11dcSJohannes Doerfert   for (MemoryAccess &MA : *MAL) {
426d4dd6ec7STobias Grosser     AllocaInst *Address;
427ecff11dcSJohannes Doerfert     if (!MA.isScalar() || !MA.isRead())
428ecff11dcSJohannes Doerfert       continue;
429ecff11dcSJohannes Doerfert 
4300164b8ffSTobias Grosser     auto Base = MA.getBaseAddr();
431ecff11dcSJohannes Doerfert 
43292245228STobias Grosser     if (MA.getScopArrayInfo()->isPHI())
433*b79a67dfSTobias Grosser       Address = getOrCreatePHIAlloca(Base);
434d4dd6ec7STobias Grosser     else
435*b79a67dfSTobias Grosser       Address = getOrCreateScalarAlloca(Base);
436d4dd6ec7STobias Grosser 
437d4dd6ec7STobias Grosser     BBMap[Base] = Builder.CreateLoad(Address, Address->getName() + ".reload");
438ecff11dcSJohannes Doerfert   }
439ecff11dcSJohannes Doerfert }
440ecff11dcSJohannes Doerfert 
441ecff11dcSJohannes Doerfert Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
442ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &ReloadMap,
443ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap,
444ecff11dcSJohannes Doerfert                                          ValueMapT &GlobalMap) {
445ecff11dcSJohannes Doerfert   // If the value we want to store is an instruction we might have demoted it
446ecff11dcSJohannes Doerfert   // in order to make it accessible here. In such a case a reload is
447ecff11dcSJohannes Doerfert   // necessary. If it is no instruction it will always be a value that
448ecff11dcSJohannes Doerfert   // dominates the current point and we can just use it. In total there are 4
449ecff11dcSJohannes Doerfert   // options:
450ecff11dcSJohannes Doerfert   //  (1) The value is no instruction ==> use the value.
451ecff11dcSJohannes Doerfert   //  (2) The value is an instruction that was split out of the region prior to
452ecff11dcSJohannes Doerfert   //      code generation  ==> use the instruction as it dominates the region.
453ecff11dcSJohannes Doerfert   //  (3) The value is an instruction:
454ecff11dcSJohannes Doerfert   //      (a) The value was defined in the current block, thus a copy is in
455ecff11dcSJohannes Doerfert   //          the BBMap ==> use the mapped value.
456ecff11dcSJohannes Doerfert   //      (b) The value was defined in a previous block, thus we demoted it
457ecff11dcSJohannes Doerfert   //          earlier ==> use the reloaded value.
458ecff11dcSJohannes Doerfert   Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
459ecff11dcSJohannes Doerfert   if (!ScalarValueInst)
460ecff11dcSJohannes Doerfert     return ScalarValue;
461ecff11dcSJohannes Doerfert 
462ecff11dcSJohannes Doerfert   if (!R.contains(ScalarValueInst)) {
463ecff11dcSJohannes Doerfert     if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
464ecff11dcSJohannes Doerfert       return /* Case (3a) */ ScalarValueCopy;
465ecff11dcSJohannes Doerfert     else
466ecff11dcSJohannes Doerfert       return /* Case 2 */ ScalarValue;
467ecff11dcSJohannes Doerfert   }
468ecff11dcSJohannes Doerfert 
469ecff11dcSJohannes Doerfert   if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
470ecff11dcSJohannes Doerfert     return /* Case (3a) */ ScalarValueCopy;
471ecff11dcSJohannes Doerfert 
472ecff11dcSJohannes Doerfert   // Case (3b)
473e1fa6da3SJohannes Doerfert   Value *ReloadAddr = getOrCreateAlloca(ScalarValueInst, ReloadMap, ".s2a");
474ecff11dcSJohannes Doerfert   ScalarValue =
475ecff11dcSJohannes Doerfert       Builder.CreateLoad(ReloadAddr, ReloadAddr->getName() + ".reload");
476ecff11dcSJohannes Doerfert 
477ecff11dcSJohannes Doerfert   return ScalarValue;
478ecff11dcSJohannes Doerfert }
479ecff11dcSJohannes Doerfert 
480ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
481ecff11dcSJohannes Doerfert                                           ValueMapT &BBMap,
482ecff11dcSJohannes Doerfert                                           ValueMapT &GlobalMap) {
483ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
484ecff11dcSJohannes Doerfert 
485ecff11dcSJohannes Doerfert   assert(Stmt.isBlockStmt() && BB == Stmt.getBasicBlock() &&
486ecff11dcSJohannes Doerfert          "Region statements need to use the generateScalarStores() "
487ecff11dcSJohannes Doerfert          "function in the RegionGenerator");
488ecff11dcSJohannes Doerfert 
489ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
490ecff11dcSJohannes Doerfert     if (!MA->isScalar() || MA->isRead())
491ecff11dcSJohannes Doerfert       continue;
492ecff11dcSJohannes Doerfert 
49392245228STobias Grosser     Instruction *Base = cast<Instruction>(MA->getBaseAddr());
494d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
495ecff11dcSJohannes Doerfert 
49692245228STobias Grosser     AllocaInst *Address = nullptr;
497d86f2157SJohannes Doerfert     if (MA->getScopArrayInfo()->isPHI())
498*b79a67dfSTobias Grosser       Address = getOrCreatePHIAlloca(Base);
499d86f2157SJohannes Doerfert     else
500*b79a67dfSTobias Grosser       Address = getOrCreateScalarAlloca(Base);
501d86f2157SJohannes Doerfert 
50292245228STobias Grosser     Val = getNewScalarValue(Val, R, ScalarMap, BBMap, GlobalMap);
50392245228STobias Grosser     Builder.CreateStore(Val, Address);
504ecff11dcSJohannes Doerfert   }
505ecff11dcSJohannes Doerfert }
506ecff11dcSJohannes Doerfert 
507ecff11dcSJohannes Doerfert void BlockGenerator::createScalarInitialization(Region &R,
508ecff11dcSJohannes Doerfert                                                 ValueMapT &GlobalMap) {
509ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
510ecff11dcSJohannes Doerfert   BasicBlock *SplitBB = R.getEnteringBlock();
511ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
512ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
513ecff11dcSJohannes Doerfert 
514ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
515ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
516ecff11dcSJohannes Doerfert   if (StartBB == R.getEntry())
517ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
518ecff11dcSJohannes Doerfert 
519ecff11dcSJohannes Doerfert   // For each PHI predecessor outside the region store the incoming operand
520ecff11dcSJohannes Doerfert   // value prior to entering the optimized region.
521ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
522ecff11dcSJohannes Doerfert 
523ecff11dcSJohannes Doerfert   ScalarAllocaMapTy EmptyMap;
524ecff11dcSJohannes Doerfert   for (const auto &PHIOpMapping : PHIOpMap) {
525ecff11dcSJohannes Doerfert     const PHINode *PHI = cast<PHINode>(PHIOpMapping.getFirst());
526ecff11dcSJohannes Doerfert 
527ecff11dcSJohannes Doerfert     // Check if this PHI has the split block as predecessor (that is the only
528ecff11dcSJohannes Doerfert     // possible predecessor outside the SCoP).
529ecff11dcSJohannes Doerfert     int idx = PHI->getBasicBlockIndex(SplitBB);
530ecff11dcSJohannes Doerfert     if (idx < 0)
531ecff11dcSJohannes Doerfert       continue;
532ecff11dcSJohannes Doerfert 
533ecff11dcSJohannes Doerfert     Value *ScalarValue = PHI->getIncomingValue(idx);
534ecff11dcSJohannes Doerfert     ScalarValue =
535ecff11dcSJohannes Doerfert         getNewScalarValue(ScalarValue, R, EmptyMap, GlobalMap, GlobalMap);
536ecff11dcSJohannes Doerfert 
537ecff11dcSJohannes Doerfert     // If the split block is the predecessor initialize the PHI operator alloca.
538ecff11dcSJohannes Doerfert     Builder.CreateStore(ScalarValue, PHIOpMapping.getSecond());
539ecff11dcSJohannes Doerfert   }
540ecff11dcSJohannes Doerfert }
541ecff11dcSJohannes Doerfert 
542ecff11dcSJohannes Doerfert void BlockGenerator::createScalarFinalization(Region &R) {
543ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
544ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExitingBlock();
545ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
546ecff11dcSJohannes Doerfert   BasicBlock *MergeBB = R.getExit();
547ecff11dcSJohannes Doerfert 
548ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
549ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
550ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
551ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
552ecff11dcSJohannes Doerfert 
553ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
554ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
555ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
556ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
557ecff11dcSJohannes Doerfert     Instruction *EscapeInst = EscapeMapping.getFirst();
558ecff11dcSJohannes Doerfert     const auto &EscapeMappingValue = EscapeMapping.getSecond();
559ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
560ecff11dcSJohannes Doerfert     AllocaInst *ScalarAddr = EscapeMappingValue.first;
561ecff11dcSJohannes Doerfert 
562ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
563ecff11dcSJohannes Doerfert     Instruction *EscapeInstReload =
564ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
565ecff11dcSJohannes Doerfert 
566ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
567ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
568ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
569ecff11dcSJohannes Doerfert     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
570ecff11dcSJohannes Doerfert 
571ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
572ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
573ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
574ecff11dcSJohannes Doerfert 
575ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
576ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
577ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
578ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
579ecff11dcSJohannes Doerfert 
580ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
581ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
582ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
583ecff11dcSJohannes Doerfert   }
584ecff11dcSJohannes Doerfert }
585ecff11dcSJohannes Doerfert 
586ecff11dcSJohannes Doerfert void BlockGenerator::finalizeSCoP(Scop &S, ValueMapT &GlobalMap) {
587ecff11dcSJohannes Doerfert   createScalarInitialization(S.getRegion(), GlobalMap);
588ecff11dcSJohannes Doerfert   createScalarFinalization(S.getRegion());
5893b11a16aSHongbin Zheng }
5903b11a16aSHongbin Zheng 
591be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
592be9c9117SJohannes Doerfert                                            VectorValueMapT &GlobalMaps,
593be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
594be9c9117SJohannes Doerfert                                            isl_map *Schedule)
595be9c9117SJohannes Doerfert     : BlockGenerator(BlockGen), GlobalMaps(GlobalMaps), VLTS(VLTS),
596be9c9117SJohannes Doerfert       Schedule(Schedule) {
5973b11a16aSHongbin Zheng   assert(GlobalMaps.size() > 1 && "Only one vector lane found");
598a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
5993b11a16aSHongbin Zheng }
6003b11a16aSHongbin Zheng 
601be9c9117SJohannes Doerfert Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, const Value *Old,
602e602a076STobias Grosser                                             ValueMapT &VectorMap,
603e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
604e602a076STobias Grosser                                             Loop *L) {
605fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
606fe11e287SHongbin Zheng     return NewValue;
6073b11a16aSHongbin Zheng 
6083b11a16aSHongbin Zheng   int Width = getVectorWidth();
6093b11a16aSHongbin Zheng 
6103b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6113b11a16aSHongbin Zheng 
6123b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
613c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
614be9c9117SJohannes Doerfert         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], GlobalMaps[Lane],
615be9c9117SJohannes Doerfert                             VLTS[Lane], L),
6167242ad92STobias Grosser         Builder.getInt32(Lane));
6173b11a16aSHongbin Zheng 
6183b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6193b11a16aSHongbin Zheng 
6203b11a16aSHongbin Zheng   return Vector;
6213b11a16aSHongbin Zheng }
6223b11a16aSHongbin Zheng 
6233b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6243b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6253b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6263b11a16aSHongbin Zheng 
6273b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6283b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6293b11a16aSHongbin Zheng 
6303b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6313b11a16aSHongbin Zheng }
6323b11a16aSHongbin Zheng 
633be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
634be9c9117SJohannes Doerfert     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
6352d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
6360dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
6373b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6380dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
6390dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
6400dd463faSTobias Grosser 
6415a56cbf4STobias Grosser   Value *NewPointer = nullptr;
6422d1ed0bfSTobias Grosser   NewPointer =
6432d1ed0bfSTobias Grosser       generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
6442d1ed0bfSTobias Grosser                                GlobalMaps[Offset], VLTS[Offset], NewAccesses);
645c14582f2STobias Grosser   Value *VectorPtr =
646c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
647c14582f2STobias Grosser   LoadInst *VecLoad =
648c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
6493b11a16aSHongbin Zheng   if (!Aligned)
6503b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
6513b11a16aSHongbin Zheng 
6520dd463faSTobias Grosser   if (NegativeStride) {
6530dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
6540dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
6550dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
6560dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
6570dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
6580dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
6590dd463faSTobias Grosser     return RevVecLoad;
6600dd463faSTobias Grosser   }
6610dd463faSTobias Grosser 
6623b11a16aSHongbin Zheng   return VecLoad;
6633b11a16aSHongbin Zheng }
6643b11a16aSHongbin Zheng 
6652d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
6662d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &BBMap,
6672d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
6683b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6693b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
6702d1ed0bfSTobias Grosser   Value *NewPointer = generateLocationAccessed(
6712d1ed0bfSTobias Grosser       Stmt, Load, Pointer, BBMap, GlobalMaps[0], VLTS[0], NewAccesses);
6723b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
6733b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
674c14582f2STobias Grosser   LoadInst *ScalarLoad =
675c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
6763b11a16aSHongbin Zheng 
6773b11a16aSHongbin Zheng   if (!Aligned)
6783b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
6793b11a16aSHongbin Zheng 
680c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
681c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
6823b11a16aSHongbin Zheng 
683c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
684c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
6853b11a16aSHongbin Zheng   return VectorLoad;
6863b11a16aSHongbin Zheng }
6873b11a16aSHongbin Zheng 
688be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
6892d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
6902d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses
6912d1ed0bfSTobias Grosser 
6922d1ed0bfSTobias Grosser     ) {
6933b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
6943b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6953b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
6963b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
6973b11a16aSHongbin Zheng 
6983b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
6993b11a16aSHongbin Zheng 
7003b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
7012d1ed0bfSTobias Grosser     Value *NewPointer =
7022d1ed0bfSTobias Grosser         generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[i],
7032d1ed0bfSTobias Grosser                                  GlobalMaps[i], VLTS[i], NewAccesses);
704c14582f2STobias Grosser     Value *ScalarLoad =
705c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
706c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
707c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7083b11a16aSHongbin Zheng   }
7093b11a16aSHongbin Zheng 
7103b11a16aSHongbin Zheng   return Vector;
7113b11a16aSHongbin Zheng }
7123b11a16aSHongbin Zheng 
7132d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
7142d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &VectorMap,
7152d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
7162873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7173b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
7182d1ed0bfSTobias Grosser       ScalarMaps[i][Load] = generateScalarLoad(
7192d1ed0bfSTobias Grosser           Stmt, Load, ScalarMaps[i], GlobalMaps[i], VLTS[i], NewAccesses);
7203b11a16aSHongbin Zheng     return;
7213b11a16aSHongbin Zheng   }
7223b11a16aSHongbin Zheng 
723be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Load);
7243b11a16aSHongbin Zheng 
72595493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
72695493984STobias Grosser   // the data location.
72795493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
72895493984STobias Grosser 
7293b11a16aSHongbin Zheng   Value *NewLoad;
730a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
7312d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
732a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
7332d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
7340dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
7352d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
7363b11a16aSHongbin Zheng   else
7372d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
7383b11a16aSHongbin Zheng 
7393b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
7403b11a16aSHongbin Zheng }
7413b11a16aSHongbin Zheng 
742be9c9117SJohannes Doerfert void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt,
743be9c9117SJohannes Doerfert                                          const UnaryInstruction *Inst,
7443b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
7453b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
7463b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
747be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
748be9c9117SJohannes Doerfert                                      ScalarMaps, getLoopForInst(Inst));
7493b11a16aSHongbin Zheng 
7503b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
7513b11a16aSHongbin Zheng 
7523b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
7533b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
7543b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
7553b11a16aSHongbin Zheng }
7563b11a16aSHongbin Zheng 
757be9c9117SJohannes Doerfert void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt,
758be9c9117SJohannes Doerfert                                           const BinaryOperator *Inst,
7593b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
7603b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
761369430ffSTobias Grosser   Loop *L = getLoopForInst(Inst);
7623b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
7633b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
7643b11a16aSHongbin Zheng 
7653b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
766be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
767be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
7683b11a16aSHongbin Zheng 
7691bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
7703b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
7713b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
7723b11a16aSHongbin Zheng }
7733b11a16aSHongbin Zheng 
7742d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
7752d1ed0bfSTobias Grosser     ScopStmt &Stmt, const StoreInst *Store, ValueMapT &VectorMap,
7762d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
777be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Store);
7783b11a16aSHongbin Zheng 
7793b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
780be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
781369430ffSTobias Grosser                                  ScalarMaps, getLoopForInst(Store));
7823b11a16aSHongbin Zheng 
78350fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
78450fd7010STobias Grosser   // the data location.
78550fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
78650fd7010STobias Grosser 
787a00a0291SSebastian Pop   if (Access.isStrideOne(isl_map_copy(Schedule))) {
7881947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
7892d1ed0bfSTobias Grosser     Value *NewPointer =
7902d1ed0bfSTobias Grosser         generateLocationAccessed(Stmt, Store, Pointer, ScalarMaps[0],
7912d1ed0bfSTobias Grosser                                  GlobalMaps[0], VLTS[0], NewAccesses);
7923b11a16aSHongbin Zheng 
793c14582f2STobias Grosser     Value *VectorPtr =
794c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
7953b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
7963b11a16aSHongbin Zheng 
7973b11a16aSHongbin Zheng     if (!Aligned)
7983b11a16aSHongbin Zheng       Store->setAlignment(8);
7993b11a16aSHongbin Zheng   } else {
8003b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
8011bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
8022d1ed0bfSTobias Grosser       Value *NewPointer =
8032d1ed0bfSTobias Grosser           generateLocationAccessed(Stmt, Store, Pointer, ScalarMaps[i],
8042d1ed0bfSTobias Grosser                                    GlobalMaps[i], VLTS[i], NewAccesses);
8053b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
8063b11a16aSHongbin Zheng     }
8073b11a16aSHongbin Zheng   }
8083b11a16aSHongbin Zheng }
8093b11a16aSHongbin Zheng 
8103b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
8113b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
81291f5b262STobias Grosser   for (Value *Operand : Inst->operands())
81391f5b262STobias Grosser     if (VectorMap.count(Operand))
8143b11a16aSHongbin Zheng       return true;
8153b11a16aSHongbin Zheng   return false;
8163b11a16aSHongbin Zheng }
8173b11a16aSHongbin Zheng 
8183b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
8193b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
8203b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
8213b11a16aSHongbin Zheng   bool HasVectorOperand = false;
8223b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8233b11a16aSHongbin Zheng 
82491f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
82591f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
8263b11a16aSHongbin Zheng 
8273b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
8283b11a16aSHongbin Zheng       continue;
8293b11a16aSHongbin Zheng 
8303b11a16aSHongbin Zheng     HasVectorOperand = true;
8313b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
8323b11a16aSHongbin Zheng 
8333b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
8343b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
8353b11a16aSHongbin Zheng 
8363b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
8373b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
8383b11a16aSHongbin Zheng       // existance of all of them.
83991f5b262STobias Grosser       if (SM.count(Operand))
8403b11a16aSHongbin Zheng         break;
8413b11a16aSHongbin Zheng 
84291f5b262STobias Grosser       SM[Operand] =
84391f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
8443b11a16aSHongbin Zheng     }
8453b11a16aSHongbin Zheng   }
8463b11a16aSHongbin Zheng 
8473b11a16aSHongbin Zheng   return HasVectorOperand;
8483b11a16aSHongbin Zheng }
8493b11a16aSHongbin Zheng 
8502d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
8512d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
8522d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
8533b11a16aSHongbin Zheng   bool HasVectorOperand;
8543b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8553b11a16aSHongbin Zheng 
8563b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
8573b11a16aSHongbin Zheng 
8583b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
859be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
8602d1ed0bfSTobias Grosser                                     GlobalMaps[VectorLane], VLTS[VectorLane],
8612d1ed0bfSTobias Grosser                                     NewAccesses);
8623b11a16aSHongbin Zheng 
8633b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
8643b11a16aSHongbin Zheng     return;
8653b11a16aSHongbin Zheng 
8663b11a16aSHongbin Zheng   // Make the result available as vector value.
8673b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
8683b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
8693b11a16aSHongbin Zheng 
8703b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
8713b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
8723b11a16aSHongbin Zheng                                          Builder.getInt32(i));
8733b11a16aSHongbin Zheng 
8743b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
8753b11a16aSHongbin Zheng }
8763b11a16aSHongbin Zheng 
877c14582f2STobias Grosser int VectorBlockGenerator::getVectorWidth() { return GlobalMaps.size(); }
8783b11a16aSHongbin Zheng 
8792d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
8802d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
8812d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
8823b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
8833b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
8843b11a16aSHongbin Zheng   if (Inst->isTerminator())
8853b11a16aSHongbin Zheng     return;
8863b11a16aSHongbin Zheng 
8871ef52333SJohannes Doerfert   if (canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion()))
888e71c6ab5STobias Grosser     return;
889e71c6ab5STobias Grosser 
8903b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
8912d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
8923b11a16aSHongbin Zheng     return;
8933b11a16aSHongbin Zheng   }
8943b11a16aSHongbin Zheng 
8953b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
8963b11a16aSHongbin Zheng     if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
8972d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
8983b11a16aSHongbin Zheng       return;
8993b11a16aSHongbin Zheng     }
9003b11a16aSHongbin Zheng 
9013b11a16aSHongbin Zheng     if (const UnaryInstruction *Unary = dyn_cast<UnaryInstruction>(Inst)) {
902be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9033b11a16aSHongbin Zheng       return;
9043b11a16aSHongbin Zheng     }
9053b11a16aSHongbin Zheng 
9063b11a16aSHongbin Zheng     if (const BinaryOperator *Binary = dyn_cast<BinaryOperator>(Inst)) {
907be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
9083b11a16aSHongbin Zheng       return;
9093b11a16aSHongbin Zheng     }
9103b11a16aSHongbin Zheng 
9113b11a16aSHongbin Zheng     // Falltrough: We generate scalar instructions, if we don't know how to
9123b11a16aSHongbin Zheng     // generate vector code.
9133b11a16aSHongbin Zheng   }
9143b11a16aSHongbin Zheng 
9152d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
9163b11a16aSHongbin Zheng }
9173b11a16aSHongbin Zheng 
9182d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
9192d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
920275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
921275a1756SJohannes Doerfert                                "the vector block generator");
922275a1756SJohannes Doerfert 
923be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
924c14582f2STobias Grosser   BasicBlock *CopyBB =
925b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
9263b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
9273b11a16aSHongbin Zheng   Builder.SetInsertPoint(CopyBB->begin());
9283b11a16aSHongbin Zheng 
9293b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
9303b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
9313b11a16aSHongbin Zheng   // are basic block local.
9323b11a16aSHongbin Zheng   //
9333b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
9343b11a16aSHongbin Zheng   // and one for vector values.
9353b11a16aSHongbin Zheng   //
9363b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
9373b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
9383b11a16aSHongbin Zheng   //
9393b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
9403b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
9413b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
9423b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
9433b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
9443b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
9453b11a16aSHongbin Zheng 
94691f5b262STobias Grosser   for (Instruction &Inst : *BB)
9472d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
9483b11a16aSHongbin Zheng }
949275a1756SJohannes Doerfert 
950ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
951ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
952514f6efaSJohannes Doerfert 
953514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
954514f6efaSJohannes Doerfert   BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
955514f6efaSJohannes Doerfert 
956514f6efaSJohannes Doerfert   if (BBCopyIDom)
957514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
958514f6efaSJohannes Doerfert 
959514f6efaSJohannes Doerfert   return BBCopyIDom;
960514f6efaSJohannes Doerfert }
961514f6efaSJohannes Doerfert 
962275a1756SJohannes Doerfert void RegionGenerator::copyStmt(ScopStmt &Stmt, ValueMapT &GlobalMap,
9632d1ed0bfSTobias Grosser                                LoopToScevMapT &LTS,
9642d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
965275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
966d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
967275a1756SJohannes Doerfert 
968ecff11dcSJohannes Doerfert   // Forget all old mappings.
969ecff11dcSJohannes Doerfert   BlockMap.clear();
970ecff11dcSJohannes Doerfert   RegionMaps.clear();
971ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
972ecff11dcSJohannes Doerfert 
973275a1756SJohannes Doerfert   // The region represented by the statement.
974275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
975275a1756SJohannes Doerfert 
976ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
977ecff11dcSJohannes Doerfert   // inputs.
978ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
979ecff11dcSJohannes Doerfert   BasicBlock *EntryBBCopy =
980ecff11dcSJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
981ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
982ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(EntryBBCopy->begin());
983514f6efaSJohannes Doerfert 
984ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
985ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
986ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
987275a1756SJohannes Doerfert 
988275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
989275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
990275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
991ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
992ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
993275a1756SJohannes Doerfert 
994275a1756SJohannes Doerfert   while (!Blocks.empty()) {
995275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
996275a1756SJohannes Doerfert     Blocks.pop_front();
997275a1756SJohannes Doerfert 
998514f6efaSJohannes Doerfert     // First split the block and update dominance information.
999514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1000ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1001ecff11dcSJohannes Doerfert 
1002ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1003ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1004514f6efaSJohannes Doerfert 
1005514f6efaSJohannes Doerfert     // Get the mapping for this block and initialize it with the mapping
1006514f6efaSJohannes Doerfert     // available at its immediate dominator (in the new region).
1007514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1008514f6efaSJohannes Doerfert     RegionMap = RegionMaps[BBCopyIDom];
1009514f6efaSJohannes Doerfert 
1010275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
10112d1ed0bfSTobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, GlobalMap, LTS, IdToAstExp);
1012275a1756SJohannes Doerfert 
1013ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1014ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1015ecff11dcSJohannes Doerfert 
1016ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1017ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1018ecff11dcSJohannes Doerfert       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB,
1019ecff11dcSJohannes Doerfert                       GlobalMap, LTS);
1020ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1021ecff11dcSJohannes Doerfert 
1022275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1023275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1024275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1025275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1026275a1756SJohannes Doerfert   }
1027275a1756SJohannes Doerfert 
1028275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1029514f6efaSJohannes Doerfert   BasicBlock *ExitBBCopy =
1030275a1756SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1031ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1032514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1033514f6efaSJohannes Doerfert 
1034ecff11dcSJohannes Doerfert   repairDominance(R->getExit(), ExitBBCopy);
1035275a1756SJohannes Doerfert 
1036275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1037275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1038275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1039275a1756SJohannes Doerfert 
1040275a1756SJohannes Doerfert     BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1041275a1756SJohannes Doerfert 
1042514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1043275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1044275a1756SJohannes Doerfert 
1045514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1046514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1047514f6efaSJohannes Doerfert 
104845e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
1049275a1756SJohannes Doerfert     copyInstScalar(Stmt, BI, RegionMap, GlobalMap, LTS);
1050275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1051275a1756SJohannes Doerfert   }
1052275a1756SJohannes Doerfert 
1053ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1054ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1055ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1056ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1057ecff11dcSJohannes Doerfert     if (L == nullptr || L->getHeader() != BB)
1058ecff11dcSJohannes Doerfert       continue;
1059ecff11dcSJohannes Doerfert 
1060ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1061ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1062ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1063ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1064ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1065ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1066ecff11dcSJohannes Doerfert     LoopPHI->insertBefore(BBCopy->begin());
1067ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1068ecff11dcSJohannes Doerfert 
1069ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1070ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1071ecff11dcSJohannes Doerfert         continue;
1072ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1073ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1074ecff11dcSJohannes Doerfert       else
1075ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1076ecff11dcSJohannes Doerfert     }
1077ecff11dcSJohannes Doerfert 
1078ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1079ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1080ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1081ecff11dcSJohannes Doerfert 
1082ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1083ecff11dcSJohannes Doerfert   }
1084ecff11dcSJohannes Doerfert 
1085ecff11dcSJohannes Doerfert   // Add all mappings from the region to the global map so outside uses will use
1086ecff11dcSJohannes Doerfert   // the copied instructions.
1087ecff11dcSJohannes Doerfert   for (auto &BBMap : RegionMaps)
1088ecff11dcSJohannes Doerfert     GlobalMap.insert(BBMap.second.begin(), BBMap.second.end());
1089ecff11dcSJohannes Doerfert 
1090275a1756SJohannes Doerfert   // Reset the old insert point for the build.
1091514f6efaSJohannes Doerfert   Builder.SetInsertPoint(ExitBBCopy->begin());
1092275a1756SJohannes Doerfert }
1093ecff11dcSJohannes Doerfert 
1094ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarLoads(ScopStmt &Stmt,
1095ecff11dcSJohannes Doerfert                                           const Instruction *Inst,
1096ecff11dcSJohannes Doerfert                                           ValueMapT &BBMap) {
1097ecff11dcSJohannes Doerfert 
1098ecff11dcSJohannes Doerfert   // Inside a non-affine region PHI nodes are copied not demoted. Once the
1099ecff11dcSJohannes Doerfert   // phi is copied it will reload all inputs from outside the region, hence
1100ecff11dcSJohannes Doerfert   // we do not need to generate code for the read access of the operands of a
1101ecff11dcSJohannes Doerfert   // PHI.
1102ecff11dcSJohannes Doerfert   if (isa<PHINode>(Inst))
1103ecff11dcSJohannes Doerfert     return;
1104ecff11dcSJohannes Doerfert 
1105ecff11dcSJohannes Doerfert   return BlockGenerator::generateScalarLoads(Stmt, Inst, BBMap);
1106ecff11dcSJohannes Doerfert }
1107ecff11dcSJohannes Doerfert 
1108ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
1109ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1110ecff11dcSJohannes Doerfert                                            ValueMapT &GlobalMap) {
1111ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
1112ecff11dcSJohannes Doerfert 
111375296901STobias Grosser   assert(Stmt.getRegion() &&
111475296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1115ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1116ecff11dcSJohannes Doerfert 
1117ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
1118ecff11dcSJohannes Doerfert 
1119ecff11dcSJohannes Doerfert     if (!MA->isScalar() || MA->isRead())
1120ecff11dcSJohannes Doerfert       continue;
1121ecff11dcSJohannes Doerfert 
1122ecff11dcSJohannes Doerfert     Instruction *ScalarBase = cast<Instruction>(MA->getBaseAddr());
1123ecff11dcSJohannes Doerfert     Instruction *ScalarInst = MA->getAccessInstruction();
1124ecff11dcSJohannes Doerfert 
112562139132STobias Grosser     // Only generate accesses that belong to this basic block.
112662139132STobias Grosser     if (ScalarInst->getParent() != BB)
112762139132STobias Grosser       continue;
112862139132STobias Grosser 
1129d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
1130ecff11dcSJohannes Doerfert     AllocaInst *ScalarAddr = nullptr;
1131ecff11dcSJohannes Doerfert 
1132d86f2157SJohannes Doerfert     if (MA->getScopArrayInfo()->isPHI())
1133*b79a67dfSTobias Grosser       ScalarAddr = getOrCreatePHIAlloca(ScalarBase);
1134d86f2157SJohannes Doerfert     else
1135*b79a67dfSTobias Grosser       ScalarAddr = getOrCreateScalarAlloca(ScalarBase);
1136ecff11dcSJohannes Doerfert 
113792245228STobias Grosser     Val = getNewScalarValue(Val, R, ScalarMap, BBMap, GlobalMap);
113892245228STobias Grosser     Builder.CreateStore(Val, ScalarAddr);
1139ecff11dcSJohannes Doerfert   }
1140ecff11dcSJohannes Doerfert }
1141ecff11dcSJohannes Doerfert 
1142ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1143ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1144ecff11dcSJohannes Doerfert                                       ValueMapT &GlobalMap,
1145ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1146ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1147ecff11dcSJohannes Doerfert 
1148ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1149ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1150ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1151ecff11dcSJohannes Doerfert   if (!BBCopy) {
1152ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1153ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1154ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1155ecff11dcSJohannes Doerfert     return;
1156ecff11dcSJohannes Doerfert   }
1157ecff11dcSJohannes Doerfert 
1158ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1159ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1160ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1161ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1162ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1163ecff11dcSJohannes Doerfert 
1164ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1165ecff11dcSJohannes Doerfert     OpCopy =
1166ecff11dcSJohannes Doerfert         getNewValue(Stmt, Op, BBCopyMap, GlobalMap, LTS, getLoopForInst(PHI));
1167ecff11dcSJohannes Doerfert   } else {
1168ecff11dcSJohannes Doerfert 
1169ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1170ecff11dcSJohannes Doerfert       return;
1171ecff11dcSJohannes Doerfert 
1172*b79a67dfSTobias Grosser     AllocaInst *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
1173ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1174ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1175ecff11dcSJohannes Doerfert   }
1176ecff11dcSJohannes Doerfert 
1177ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1178ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1179ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1180ecff11dcSJohannes Doerfert }
1181ecff11dcSJohannes Doerfert 
1182ecff11dcSJohannes Doerfert Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, const PHINode *PHI,
1183ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1184ecff11dcSJohannes Doerfert                                            ValueMapT &GlobalMap,
1185ecff11dcSJohannes Doerfert                                            LoopToScevMapT &LTS) {
1186ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1187ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1188ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1189ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1190ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1191ecff11dcSJohannes Doerfert 
1192ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1193ecff11dcSJohannes Doerfert     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), GlobalMap,
1194ecff11dcSJohannes Doerfert                     LTS);
1195ecff11dcSJohannes Doerfert   return PHICopy;
1196ecff11dcSJohannes Doerfert }
1197