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"
27e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolutionExpander.h"
28030237d0STobias Grosser #include "llvm/IR/IntrinsicInst.h"
29c9895067STobias Grosser #include "llvm/IR/Module.h"
303b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
31f32d651dSJohannes Doerfert #include "isl/aff.h"
32f32d651dSJohannes Doerfert #include "isl/ast.h"
33f32d651dSJohannes Doerfert #include "isl/ast_build.h"
34ba0d0922STobias Grosser #include "isl/set.h"
35f32d651dSJohannes Doerfert #include <deque>
36f32d651dSJohannes Doerfert 
373b11a16aSHongbin Zheng using namespace llvm;
383b11a16aSHongbin Zheng using namespace polly;
393b11a16aSHongbin Zheng 
40878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
41878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
42878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
43878aba49STobias Grosser                              cl::cat(PollyCategory));
443b11a16aSHongbin Zheng 
45*dcc3b435STobias Grosser bool polly::canSynthesize(const Value *V, const llvm::LoopInfo *LI,
46ecfe21b7STobias Grosser                           ScalarEvolution *SE, const Region *R) {
47*dcc3b435STobias Grosser   if (!V || !SE->isSCEVable(V->getType()))
48ecfe21b7STobias Grosser     return false;
49ecfe21b7STobias Grosser 
50*dcc3b435STobias Grosser   if (const SCEV *Scev = SE->getSCEV(const_cast<Value *>(V)))
51ecfe21b7STobias Grosser     if (!isa<SCEVCouldNotCompute>(Scev))
52ecfe21b7STobias Grosser       if (!hasScalarDepsInsideRegion(Scev, R))
53ecfe21b7STobias Grosser         return true;
54ecfe21b7STobias Grosser 
55ecfe21b7STobias Grosser   return false;
56ecfe21b7STobias Grosser }
57ecfe21b7STobias Grosser 
589e3a5db0SJohannes Doerfert bool polly::isIgnoredIntrinsic(const Value *V) {
599e3a5db0SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(V)) {
609e3a5db0SJohannes Doerfert     switch (IT->getIntrinsicID()) {
619e3a5db0SJohannes Doerfert     // Lifetime markers are supported/ignored.
629e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
639e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
649e3a5db0SJohannes Doerfert     // Invariant markers are supported/ignored.
659e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
669e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
679e3a5db0SJohannes Doerfert     // Some misc annotations are supported/ignored.
689e3a5db0SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
699e3a5db0SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
709e3a5db0SJohannes Doerfert     case llvm::Intrinsic::annotation:
719e3a5db0SJohannes Doerfert     case llvm::Intrinsic::donothing:
729e3a5db0SJohannes Doerfert     case llvm::Intrinsic::assume:
739e3a5db0SJohannes Doerfert     case llvm::Intrinsic::expect:
749e3a5db0SJohannes Doerfert       return true;
759e3a5db0SJohannes Doerfert     default:
769e3a5db0SJohannes Doerfert       break;
779e3a5db0SJohannes Doerfert     }
789e3a5db0SJohannes Doerfert   }
799e3a5db0SJohannes Doerfert   return false;
809e3a5db0SJohannes Doerfert }
819e3a5db0SJohannes Doerfert 
82b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
83b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
84ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
85ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
86ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
87b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
88ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
89ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
90ecff11dcSJohannes Doerfert       EscapeMap(EscapeMap) {}
91e71c6ab5STobias Grosser 
92be9c9117SJohannes Doerfert Value *BlockGenerator::getNewValue(ScopStmt &Stmt, const Value *Old,
93be9c9117SJohannes Doerfert                                    ValueMapT &BBMap, ValueMapT &GlobalMap,
94be9c9117SJohannes Doerfert                                    LoopToScevMapT &LTS, Loop *L) const {
953b11a16aSHongbin Zheng   // We assume constants never change.
963b11a16aSHongbin Zheng   // This avoids map lookups for many calls to this function.
973b11a16aSHongbin Zheng   if (isa<Constant>(Old))
983b11a16aSHongbin Zheng     return const_cast<Value *>(Old);
993b11a16aSHongbin Zheng 
100fe11e287SHongbin Zheng   if (Value *New = GlobalMap.lookup(Old)) {
101c14582f2STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
102c14582f2STobias Grosser         New->getType()->getScalarSizeInBits())
1033b11a16aSHongbin Zheng       New = Builder.CreateTruncOrBitCast(New, Old->getType());
1043b11a16aSHongbin Zheng 
1053b11a16aSHongbin Zheng     return New;
1063b11a16aSHongbin Zheng   }
1073b11a16aSHongbin Zheng 
108fe11e287SHongbin Zheng   if (Value *New = BBMap.lookup(Old))
109fe11e287SHongbin Zheng     return New;
1103b11a16aSHongbin Zheng 
111683b8e44STobias Grosser   if (SE.isSCEVable(Old->getType()))
112369430ffSTobias Grosser     if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
113e71c6ab5STobias Grosser       if (!isa<SCEVCouldNotCompute>(Scev)) {
114637b23dcSSebastian Pop         const SCEV *NewScev = apply(Scev, LTS, SE);
115637b23dcSSebastian Pop         ValueToValueMap VTV;
116637b23dcSSebastian Pop         VTV.insert(BBMap.begin(), BBMap.end());
117637b23dcSSebastian Pop         VTV.insert(GlobalMap.begin(), GlobalMap.end());
11847d4ee3eSSebastian Pop         NewScev = SCEVParameterRewriter::rewrite(NewScev, SE, VTV);
119c9895067STobias Grosser         SCEVExpander Expander(SE, Stmt.getParent()
120c9895067STobias Grosser                                       ->getRegion()
121c9895067STobias Grosser                                       .getEntry()
122c9895067STobias Grosser                                       ->getParent()
123c9895067STobias Grosser                                       ->getParent()
124c9895067STobias Grosser                                       ->getDataLayout(),
125c9895067STobias Grosser                               "polly");
12645e7944bSTobias Grosser         assert(Builder.GetInsertPoint() != Builder.GetInsertBlock()->end() &&
12745e7944bSTobias Grosser                "Only instructions can be insert points for SCEVExpander");
128e71c6ab5STobias Grosser         Value *Expanded = Expander.expandCodeFor(NewScev, Old->getType(),
129e71c6ab5STobias Grosser                                                  Builder.GetInsertPoint());
130e71c6ab5STobias Grosser 
131e71c6ab5STobias Grosser         BBMap[Old] = Expanded;
132e71c6ab5STobias Grosser         return Expanded;
133e71c6ab5STobias Grosser       }
134369430ffSTobias Grosser     }
135e71c6ab5STobias Grosser 
13616371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
13716371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
13816371acdSTobias Grosser     return const_cast<Value *>(Old);
13916371acdSTobias Grosser 
14016371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
14116371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
142be9c9117SJohannes Doerfert     if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
14316371acdSTobias Grosser       return const_cast<Value *>(Old);
14416371acdSTobias Grosser 
14516371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1465b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1475a56cbf4STobias Grosser   return nullptr;
1483b11a16aSHongbin Zheng }
1493b11a16aSHongbin Zheng 
150be9c9117SJohannes Doerfert void BlockGenerator::copyInstScalar(ScopStmt &Stmt, const Instruction *Inst,
151be9c9117SJohannes Doerfert                                     ValueMapT &BBMap, ValueMapT &GlobalMap,
152be9c9117SJohannes Doerfert                                     LoopToScevMapT &LTS) {
153030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
154030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
155030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
156030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
157030237d0STobias Grosser     return;
158030237d0STobias Grosser 
1593b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1603b11a16aSHongbin Zheng 
1613b11a16aSHongbin Zheng   // Replace old operands with the new ones.
16291f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
163be9c9117SJohannes Doerfert     Value *NewOperand = getNewValue(Stmt, OldOperand, BBMap, GlobalMap, LTS,
164be9c9117SJohannes Doerfert                                     getLoopForInst(Inst));
1653b11a16aSHongbin Zheng 
1663b11a16aSHongbin Zheng     if (!NewOperand) {
167c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
168c14582f2STobias Grosser              "Store instructions are always needed!");
1693b11a16aSHongbin Zheng       delete NewInst;
1703b11a16aSHongbin Zheng       return;
1713b11a16aSHongbin Zheng     }
1723b11a16aSHongbin Zheng 
1733b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1743b11a16aSHongbin Zheng   }
1753b11a16aSHongbin Zheng 
1763b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1773b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1783b11a16aSHongbin Zheng 
1793b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
1803b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
1813b11a16aSHongbin Zheng }
1823b11a16aSHongbin Zheng 
183be9c9117SJohannes Doerfert Value *BlockGenerator::getNewAccessOperand(ScopStmt &Stmt,
184be9c9117SJohannes Doerfert                                            const MemoryAccess &MA) {
185a99130f0SJohannes Doerfert   isl_pw_multi_aff *PWAccRel;
186a99130f0SJohannes Doerfert   isl_union_map *Schedule;
187a63b2579SJohannes Doerfert   isl_ast_expr *Expr;
188be9c9117SJohannes Doerfert   isl_ast_build *Build = Stmt.getAstBuild();
1893b11a16aSHongbin Zheng 
190a63b2579SJohannes Doerfert   assert(ExprBuilder && Build &&
191a63b2579SJohannes Doerfert          "Cannot generate new value without IslExprBuilder!");
1923b11a16aSHongbin Zheng 
193a99130f0SJohannes Doerfert   Schedule = isl_ast_build_get_schedule(Build);
194a99130f0SJohannes Doerfert   PWAccRel = MA.applyScheduleToAccessRelation(Schedule);
1953b11a16aSHongbin Zheng 
196a63b2579SJohannes Doerfert   Expr = isl_ast_build_access_from_pw_multi_aff(Build, PWAccRel);
197dcb5f1dcSJohannes Doerfert   Expr = isl_ast_expr_address_of(Expr);
198a63b2579SJohannes Doerfert 
199a63b2579SJohannes Doerfert   return ExprBuilder->create(Expr);
2003b11a16aSHongbin Zheng }
2013b11a16aSHongbin Zheng 
202be9c9117SJohannes Doerfert Value *BlockGenerator::generateLocationAccessed(
203be9c9117SJohannes Doerfert     ScopStmt &Stmt, const Instruction *Inst, const Value *Pointer,
204be9c9117SJohannes Doerfert     ValueMapT &BBMap, ValueMapT &GlobalMap, LoopToScevMapT &LTS) {
205be9c9117SJohannes Doerfert   const MemoryAccess &MA = Stmt.getAccessFor(Inst);
2063b11a16aSHongbin Zheng 
2073b11a16aSHongbin Zheng   Value *NewPointer;
208a99130f0SJohannes Doerfert   if (MA.hasNewAccessRelation())
209be9c9117SJohannes Doerfert     NewPointer = getNewAccessOperand(Stmt, MA);
210a63b2579SJohannes Doerfert   else
211369430ffSTobias Grosser     NewPointer =
212be9c9117SJohannes Doerfert         getNewValue(Stmt, Pointer, BBMap, GlobalMap, LTS, getLoopForInst(Inst));
2133b11a16aSHongbin Zheng 
2143b11a16aSHongbin Zheng   return NewPointer;
2153b11a16aSHongbin Zheng }
2163b11a16aSHongbin Zheng 
2174d96c8d7STobias Grosser Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
2182ef3f4fdSJohannes Doerfert   return LI.getLoopFor(Inst->getParent());
219369430ffSTobias Grosser }
220369430ffSTobias Grosser 
221be9c9117SJohannes Doerfert Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, const LoadInst *Load,
222e602a076STobias Grosser                                           ValueMapT &BBMap,
223e602a076STobias Grosser                                           ValueMapT &GlobalMap,
224e602a076STobias Grosser                                           LoopToScevMapT &LTS) {
2253b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
2267242ad92STobias Grosser   Value *NewPointer =
227be9c9117SJohannes Doerfert       generateLocationAccessed(Stmt, Load, Pointer, BBMap, GlobalMap, LTS);
22887901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
22987901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
2303b11a16aSHongbin Zheng   return ScalarLoad;
2313b11a16aSHongbin Zheng }
2323b11a16aSHongbin Zheng 
233be9c9117SJohannes Doerfert Value *BlockGenerator::generateScalarStore(ScopStmt &Stmt,
234be9c9117SJohannes Doerfert                                            const StoreInst *Store,
235e602a076STobias Grosser                                            ValueMapT &BBMap,
236e602a076STobias Grosser                                            ValueMapT &GlobalMap,
237e602a076STobias Grosser                                            LoopToScevMapT &LTS) {
2383b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
239c14582f2STobias Grosser   Value *NewPointer =
240be9c9117SJohannes Doerfert       generateLocationAccessed(Stmt, Store, Pointer, BBMap, GlobalMap, LTS);
241be9c9117SJohannes Doerfert   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap,
242be9c9117SJohannes Doerfert                                     GlobalMap, LTS, getLoopForInst(Store));
2433b11a16aSHongbin Zheng 
24487901453SJohannes Doerfert   Value *NewStore = Builder.CreateAlignedStore(ValueOperand, NewPointer,
24587901453SJohannes Doerfert                                                Store->getAlignment());
24687901453SJohannes Doerfert   return NewStore;
2473b11a16aSHongbin Zheng }
2483b11a16aSHongbin Zheng 
249be9c9117SJohannes Doerfert void BlockGenerator::copyInstruction(ScopStmt &Stmt, const Instruction *Inst,
250be9c9117SJohannes Doerfert                                      ValueMapT &BBMap, ValueMapT &GlobalMap,
251e602a076STobias Grosser                                      LoopToScevMapT &LTS) {
252ecff11dcSJohannes Doerfert 
253ecff11dcSJohannes Doerfert   // First check for possible scalar dependences for this instruction.
254ecff11dcSJohannes Doerfert   generateScalarLoads(Stmt, Inst, BBMap);
255ecff11dcSJohannes Doerfert 
2563b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2573b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2583b11a16aSHongbin Zheng   if (Inst->isTerminator())
2593b11a16aSHongbin Zheng     return;
2603b11a16aSHongbin Zheng 
261ecff11dcSJohannes Doerfert   Loop *L = getLoopForInst(Inst);
262ecff11dcSJohannes Doerfert   if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
263ecff11dcSJohannes Doerfert       canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
264ecff11dcSJohannes Doerfert     Value *NewValue = getNewValue(Stmt, Inst, BBMap, GlobalMap, LTS, L);
265ecff11dcSJohannes Doerfert     BBMap[Inst] = NewValue;
266e71c6ab5STobias Grosser     return;
267ecff11dcSJohannes Doerfert   }
268e71c6ab5STobias Grosser 
2693b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
270be9c9117SJohannes Doerfert     Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, GlobalMap, LTS);
2713d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2723d94fedfSSebastian Pop     // deterministic.
273753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2743b11a16aSHongbin Zheng     return;
2753b11a16aSHongbin Zheng   }
2763b11a16aSHongbin Zheng 
2773b11a16aSHongbin Zheng   if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
278be9c9117SJohannes Doerfert     Value *NewStore = generateScalarStore(Stmt, Store, BBMap, GlobalMap, LTS);
2793d94fedfSSebastian Pop     // Compute NewStore before its insertion in BBMap to make the insertion
2803d94fedfSSebastian Pop     // deterministic.
281753d43f9SSebastian Pop     BBMap[Store] = NewStore;
2823b11a16aSHongbin Zheng     return;
2833b11a16aSHongbin Zheng   }
2843b11a16aSHongbin Zheng 
285ecff11dcSJohannes Doerfert   if (const PHINode *PHI = dyn_cast<PHINode>(Inst)) {
286ecff11dcSJohannes Doerfert     copyPHIInstruction(Stmt, PHI, BBMap, GlobalMap, LTS);
287ecff11dcSJohannes Doerfert     return;
288ecff11dcSJohannes Doerfert   }
289ecff11dcSJohannes Doerfert 
2903f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
2913f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
2923f500fa2SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(Inst)) {
2933f500fa2SJohannes Doerfert     switch (IT->getIntrinsicID()) {
2943f500fa2SJohannes Doerfert     // Lifetime markers are ignored.
2953f500fa2SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
2963f500fa2SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
2973f500fa2SJohannes Doerfert     // Invariant markers are ignored.
2983f500fa2SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
2993f500fa2SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
3003f500fa2SJohannes Doerfert     // Some misc annotations are ignored.
3013f500fa2SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
3023f500fa2SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
3033f500fa2SJohannes Doerfert     case llvm::Intrinsic::annotation:
3043f500fa2SJohannes Doerfert     case llvm::Intrinsic::donothing:
3053f500fa2SJohannes Doerfert     case llvm::Intrinsic::assume:
3063f500fa2SJohannes Doerfert     case llvm::Intrinsic::expect:
3073f500fa2SJohannes Doerfert       return;
3083f500fa2SJohannes Doerfert     default:
3093f500fa2SJohannes Doerfert       // Other intrinsics are copied.
3103f500fa2SJohannes Doerfert       break;
3113f500fa2SJohannes Doerfert     }
3123f500fa2SJohannes Doerfert   }
3133f500fa2SJohannes Doerfert 
314be9c9117SJohannes Doerfert   copyInstScalar(Stmt, Inst, BBMap, GlobalMap, LTS);
3153b11a16aSHongbin Zheng }
3163b11a16aSHongbin Zheng 
317275a1756SJohannes Doerfert void BlockGenerator::copyStmt(ScopStmt &Stmt, ValueMapT &GlobalMap,
318be9c9117SJohannes Doerfert                               LoopToScevMapT &LTS) {
319275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
320275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
321275a1756SJohannes Doerfert 
322275a1756SJohannes Doerfert   ValueMapT BBMap;
323275a1756SJohannes Doerfert 
324be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
325275a1756SJohannes Doerfert   copyBB(Stmt, BB, BBMap, GlobalMap, LTS);
326275a1756SJohannes Doerfert }
327275a1756SJohannes Doerfert 
328514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
329c14582f2STobias Grosser   BasicBlock *CopyBB =
330b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
3313b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
332514f6efaSJohannes Doerfert   return CopyBB;
333514f6efaSJohannes Doerfert }
3343b11a16aSHongbin Zheng 
335514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
336514f6efaSJohannes Doerfert                                    ValueMapT &BBMap, ValueMapT &GlobalMap,
337514f6efaSJohannes Doerfert                                    LoopToScevMapT &LTS) {
338514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
339514f6efaSJohannes Doerfert   copyBB(Stmt, BB, CopyBB, BBMap, GlobalMap, LTS);
340514f6efaSJohannes Doerfert   return CopyBB;
341514f6efaSJohannes Doerfert }
342514f6efaSJohannes Doerfert 
343514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
344514f6efaSJohannes Doerfert                             ValueMapT &BBMap, ValueMapT &GlobalMap,
345514f6efaSJohannes Doerfert                             LoopToScevMapT &LTS) {
346514f6efaSJohannes Doerfert   Builder.SetInsertPoint(CopyBB->begin());
347ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
348ecff11dcSJohannes Doerfert 
34991f5b262STobias Grosser   for (Instruction &Inst : *BB)
350be9c9117SJohannes Doerfert     copyInstruction(Stmt, &Inst, BBMap, GlobalMap, LTS);
351ecff11dcSJohannes Doerfert 
352ecff11dcSJohannes Doerfert   // After a basic block was copied store all scalars that escape this block
353ecff11dcSJohannes Doerfert   // in their alloca. First the scalars that have dependences inside the SCoP,
354ecff11dcSJohannes Doerfert   // then the ones that might escape the SCoP.
355ecff11dcSJohannes Doerfert   generateScalarStores(Stmt, BB, BBMap, GlobalMap);
356ecff11dcSJohannes Doerfert 
357ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
358ecff11dcSJohannes Doerfert   for (Instruction &Inst : *BB)
359ecff11dcSJohannes Doerfert     handleOutsideUsers(R, &Inst, BBMap[&Inst]);
360ecff11dcSJohannes Doerfert }
361ecff11dcSJohannes Doerfert 
362ecff11dcSJohannes Doerfert AllocaInst *BlockGenerator::getOrCreateAlloca(Instruction *ScalarBase,
363ecff11dcSJohannes Doerfert                                               ScalarAllocaMapTy &Map,
364ecff11dcSJohannes Doerfert                                               const char *NameExt,
365ecff11dcSJohannes Doerfert                                               bool *IsNew) {
366ecff11dcSJohannes Doerfert 
367ecff11dcSJohannes Doerfert   // Check if an alloca was cached for the base instruction.
368ecff11dcSJohannes Doerfert   AllocaInst *&Addr = Map[ScalarBase];
369ecff11dcSJohannes Doerfert 
370ecff11dcSJohannes Doerfert   // If needed indicate if it was found already or will be created.
371ecff11dcSJohannes Doerfert   if (IsNew)
372ecff11dcSJohannes Doerfert     *IsNew = (Addr == nullptr);
373ecff11dcSJohannes Doerfert 
374ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
375ecff11dcSJohannes Doerfert   if (!Addr) {
376ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
377ecff11dcSJohannes Doerfert     Addr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
378ecff11dcSJohannes Doerfert     Addr->insertBefore(EntryBB->getFirstInsertionPt());
379ecff11dcSJohannes Doerfert   }
380ecff11dcSJohannes Doerfert 
381ecff11dcSJohannes Doerfert   return Addr;
382ecff11dcSJohannes Doerfert }
383ecff11dcSJohannes Doerfert 
384ecff11dcSJohannes Doerfert void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
385ecff11dcSJohannes Doerfert                                         Value *InstCopy) {
386ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExit();
387ecff11dcSJohannes Doerfert 
388ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
389ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
390ecff11dcSJohannes Doerfert 
391ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
392ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
393ecff11dcSJohannes Doerfert     if (!UI)
394ecff11dcSJohannes Doerfert       continue;
395ecff11dcSJohannes Doerfert 
396ecff11dcSJohannes Doerfert     if (R.contains(UI) && ExitBB != UI->getParent())
397ecff11dcSJohannes Doerfert       continue;
398ecff11dcSJohannes Doerfert 
399ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
400ecff11dcSJohannes Doerfert   }
401ecff11dcSJohannes Doerfert 
402ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
403ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
404ecff11dcSJohannes Doerfert     return;
405ecff11dcSJohannes Doerfert 
406ecff11dcSJohannes Doerfert   // If there are escape users we get the alloca for this instruction and put
407ecff11dcSJohannes Doerfert   // it in the EscapeMap for later finalization. However, if the alloca was not
408ecff11dcSJohannes Doerfert   // created by an already handled scalar dependence we have to initialize it
409ecff11dcSJohannes Doerfert   // also. Lastly, if the instruction was copied multiple times we already did
410ecff11dcSJohannes Doerfert   // this and can exit.
411ecff11dcSJohannes Doerfert   if (EscapeMap.count(Inst))
412ecff11dcSJohannes Doerfert     return;
413ecff11dcSJohannes Doerfert 
414ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
415ecff11dcSJohannes Doerfert   bool IsNew;
416ecff11dcSJohannes Doerfert   AllocaInst *ScalarAddr =
417ecff11dcSJohannes Doerfert       getOrCreateAlloca(Inst, ScalarMap, ".escape", &IsNew);
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   // If the escape alloca was just created store the instruction in there,
423ecff11dcSJohannes Doerfert   // otherwise that happened already.
424ecff11dcSJohannes Doerfert   if (IsNew) {
425ecff11dcSJohannes Doerfert     assert(InstCopy && "Except PHIs every instruction should have a copy!");
426ecff11dcSJohannes Doerfert     Builder.CreateStore(InstCopy, ScalarAddr);
427ecff11dcSJohannes Doerfert   }
428ecff11dcSJohannes Doerfert }
429ecff11dcSJohannes Doerfert 
430ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarLoads(ScopStmt &Stmt,
431ecff11dcSJohannes Doerfert                                          const Instruction *Inst,
432ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap) {
433d4dd6ec7STobias Grosser   auto *MAL = Stmt.lookupAccessesFor(Inst);
434ecff11dcSJohannes Doerfert 
435d4dd6ec7STobias Grosser   if (!MAL)
436d4dd6ec7STobias Grosser     return;
437d4dd6ec7STobias Grosser 
438ecff11dcSJohannes Doerfert   for (MemoryAccess &MA : *MAL) {
439d4dd6ec7STobias Grosser     AllocaInst *Address;
440ecff11dcSJohannes Doerfert     if (!MA.isScalar() || !MA.isRead())
441ecff11dcSJohannes Doerfert       continue;
442ecff11dcSJohannes Doerfert 
443d4dd6ec7STobias Grosser     auto Base = cast<Instruction>(MA.getBaseAddr());
444ecff11dcSJohannes Doerfert 
44592245228STobias Grosser     if (MA.getScopArrayInfo()->isPHI())
446d4dd6ec7STobias Grosser       Address = getOrCreateAlloca(Base, PHIOpMap, ".phiops");
447d4dd6ec7STobias Grosser     else
448d4dd6ec7STobias Grosser       Address = getOrCreateAlloca(Base, ScalarMap, ".s2a");
449d4dd6ec7STobias Grosser 
450d4dd6ec7STobias Grosser     BBMap[Base] = Builder.CreateLoad(Address, Address->getName() + ".reload");
451ecff11dcSJohannes Doerfert   }
452ecff11dcSJohannes Doerfert }
453ecff11dcSJohannes Doerfert 
454ecff11dcSJohannes Doerfert Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
455ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &ReloadMap,
456ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap,
457ecff11dcSJohannes Doerfert                                          ValueMapT &GlobalMap) {
458ecff11dcSJohannes Doerfert   // If the value we want to store is an instruction we might have demoted it
459ecff11dcSJohannes Doerfert   // in order to make it accessible here. In such a case a reload is
460ecff11dcSJohannes Doerfert   // necessary. If it is no instruction it will always be a value that
461ecff11dcSJohannes Doerfert   // dominates the current point and we can just use it. In total there are 4
462ecff11dcSJohannes Doerfert   // options:
463ecff11dcSJohannes Doerfert   //  (1) The value is no instruction ==> use the value.
464ecff11dcSJohannes Doerfert   //  (2) The value is an instruction that was split out of the region prior to
465ecff11dcSJohannes Doerfert   //      code generation  ==> use the instruction as it dominates the region.
466ecff11dcSJohannes Doerfert   //  (3) The value is an instruction:
467ecff11dcSJohannes Doerfert   //      (a) The value was defined in the current block, thus a copy is in
468ecff11dcSJohannes Doerfert   //          the BBMap ==> use the mapped value.
469ecff11dcSJohannes Doerfert   //      (b) The value was defined in a previous block, thus we demoted it
470ecff11dcSJohannes Doerfert   //          earlier ==> use the reloaded value.
471ecff11dcSJohannes Doerfert   Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
472ecff11dcSJohannes Doerfert   if (!ScalarValueInst)
473ecff11dcSJohannes Doerfert     return ScalarValue;
474ecff11dcSJohannes Doerfert 
475ecff11dcSJohannes Doerfert   if (!R.contains(ScalarValueInst)) {
476ecff11dcSJohannes Doerfert     if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
477ecff11dcSJohannes Doerfert       return /* Case (3a) */ ScalarValueCopy;
478ecff11dcSJohannes Doerfert     else
479ecff11dcSJohannes Doerfert       return /* Case 2 */ ScalarValue;
480ecff11dcSJohannes Doerfert   }
481ecff11dcSJohannes Doerfert 
482ecff11dcSJohannes Doerfert   if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
483ecff11dcSJohannes Doerfert     return /* Case (3a) */ ScalarValueCopy;
484ecff11dcSJohannes Doerfert 
485ecff11dcSJohannes Doerfert   // Case (3b)
486ecff11dcSJohannes Doerfert   assert(ReloadMap.count(ScalarValueInst) &&
487ecff11dcSJohannes Doerfert          "ScalarInst not mapped in the block and not in the given reload map!");
488ecff11dcSJohannes Doerfert   Value *ReloadAddr = ReloadMap[ScalarValueInst];
489ecff11dcSJohannes Doerfert   ScalarValue =
490ecff11dcSJohannes Doerfert       Builder.CreateLoad(ReloadAddr, ReloadAddr->getName() + ".reload");
491ecff11dcSJohannes Doerfert 
492ecff11dcSJohannes Doerfert   return ScalarValue;
493ecff11dcSJohannes Doerfert }
494ecff11dcSJohannes Doerfert 
495ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
496ecff11dcSJohannes Doerfert                                           ValueMapT &BBMap,
497ecff11dcSJohannes Doerfert                                           ValueMapT &GlobalMap) {
498ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
499ecff11dcSJohannes Doerfert 
500ecff11dcSJohannes Doerfert   assert(Stmt.isBlockStmt() && BB == Stmt.getBasicBlock() &&
501ecff11dcSJohannes Doerfert          "Region statements need to use the generateScalarStores() "
502ecff11dcSJohannes Doerfert          "function in the RegionGenerator");
503ecff11dcSJohannes Doerfert 
504ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
505ecff11dcSJohannes Doerfert     if (!MA->isScalar() || MA->isRead())
506ecff11dcSJohannes Doerfert       continue;
507ecff11dcSJohannes Doerfert 
50892245228STobias Grosser     Instruction *Base = cast<Instruction>(MA->getBaseAddr());
50992245228STobias Grosser     Instruction *Inst = MA->getAccessInstruction();
510ecff11dcSJohannes Doerfert 
51192245228STobias Grosser     Value *Val = nullptr;
51292245228STobias Grosser     AllocaInst *Address = nullptr;
513ecff11dcSJohannes Doerfert 
51492245228STobias Grosser     if (MA->getScopArrayInfo()->isPHI()) {
51592245228STobias Grosser       PHINode *BasePHI = dyn_cast<PHINode>(Base);
51692245228STobias Grosser       int PHIIdx = BasePHI->getBasicBlockIndex(BB);
51792245228STobias Grosser       Address = getOrCreateAlloca(Base, PHIOpMap, ".phiops");
51892245228STobias Grosser       Val = BasePHI->getIncomingValue(PHIIdx);
519ecff11dcSJohannes Doerfert     } else {
52092245228STobias Grosser       Address = getOrCreateAlloca(Base, ScalarMap, ".s2a");
52192245228STobias Grosser       Val = Inst;
522ecff11dcSJohannes Doerfert     }
52392245228STobias Grosser     Val = getNewScalarValue(Val, R, ScalarMap, BBMap, GlobalMap);
52492245228STobias Grosser     Builder.CreateStore(Val, Address);
525ecff11dcSJohannes Doerfert   }
526ecff11dcSJohannes Doerfert }
527ecff11dcSJohannes Doerfert 
528ecff11dcSJohannes Doerfert void BlockGenerator::createScalarInitialization(Region &R,
529ecff11dcSJohannes Doerfert                                                 ValueMapT &GlobalMap) {
530ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
531ecff11dcSJohannes Doerfert   BasicBlock *SplitBB = R.getEnteringBlock();
532ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
533ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
534ecff11dcSJohannes Doerfert 
535ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
536ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
537ecff11dcSJohannes Doerfert   if (StartBB == R.getEntry())
538ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
539ecff11dcSJohannes Doerfert 
540ecff11dcSJohannes Doerfert   // For each PHI predecessor outside the region store the incoming operand
541ecff11dcSJohannes Doerfert   // value prior to entering the optimized region.
542ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
543ecff11dcSJohannes Doerfert 
544ecff11dcSJohannes Doerfert   ScalarAllocaMapTy EmptyMap;
545ecff11dcSJohannes Doerfert   for (const auto &PHIOpMapping : PHIOpMap) {
546ecff11dcSJohannes Doerfert     const PHINode *PHI = cast<PHINode>(PHIOpMapping.getFirst());
547ecff11dcSJohannes Doerfert 
548ecff11dcSJohannes Doerfert     // Check if this PHI has the split block as predecessor (that is the only
549ecff11dcSJohannes Doerfert     // possible predecessor outside the SCoP).
550ecff11dcSJohannes Doerfert     int idx = PHI->getBasicBlockIndex(SplitBB);
551ecff11dcSJohannes Doerfert     if (idx < 0)
552ecff11dcSJohannes Doerfert       continue;
553ecff11dcSJohannes Doerfert 
554ecff11dcSJohannes Doerfert     Value *ScalarValue = PHI->getIncomingValue(idx);
555ecff11dcSJohannes Doerfert     ScalarValue =
556ecff11dcSJohannes Doerfert         getNewScalarValue(ScalarValue, R, EmptyMap, GlobalMap, GlobalMap);
557ecff11dcSJohannes Doerfert 
558ecff11dcSJohannes Doerfert     // If the split block is the predecessor initialize the PHI operator alloca.
559ecff11dcSJohannes Doerfert     Builder.CreateStore(ScalarValue, PHIOpMapping.getSecond());
560ecff11dcSJohannes Doerfert   }
561ecff11dcSJohannes Doerfert }
562ecff11dcSJohannes Doerfert 
563ecff11dcSJohannes Doerfert void BlockGenerator::createScalarFinalization(Region &R) {
564ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
565ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExitingBlock();
566ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
567ecff11dcSJohannes Doerfert   BasicBlock *MergeBB = R.getExit();
568ecff11dcSJohannes Doerfert 
569ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
570ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
571ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
572ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
573ecff11dcSJohannes Doerfert 
574ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
575ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
576ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
577ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
578ecff11dcSJohannes Doerfert     Instruction *EscapeInst = EscapeMapping.getFirst();
579ecff11dcSJohannes Doerfert     const auto &EscapeMappingValue = EscapeMapping.getSecond();
580ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
581ecff11dcSJohannes Doerfert     AllocaInst *ScalarAddr = EscapeMappingValue.first;
582ecff11dcSJohannes Doerfert 
583ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
584ecff11dcSJohannes Doerfert     Instruction *EscapeInstReload =
585ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
586ecff11dcSJohannes Doerfert 
587ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
588ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
589ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
590ecff11dcSJohannes Doerfert     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
591ecff11dcSJohannes Doerfert 
592ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
593ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
594ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
595ecff11dcSJohannes Doerfert 
596ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
597ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
598ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
599ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
600ecff11dcSJohannes Doerfert 
601ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
602ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
603ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
604ecff11dcSJohannes Doerfert   }
605ecff11dcSJohannes Doerfert }
606ecff11dcSJohannes Doerfert 
607ecff11dcSJohannes Doerfert void BlockGenerator::finalizeSCoP(Scop &S, ValueMapT &GlobalMap) {
608ecff11dcSJohannes Doerfert   createScalarInitialization(S.getRegion(), GlobalMap);
609ecff11dcSJohannes Doerfert   createScalarFinalization(S.getRegion());
6103b11a16aSHongbin Zheng }
6113b11a16aSHongbin Zheng 
612be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
613be9c9117SJohannes Doerfert                                            VectorValueMapT &GlobalMaps,
614be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
615be9c9117SJohannes Doerfert                                            isl_map *Schedule)
616be9c9117SJohannes Doerfert     : BlockGenerator(BlockGen), GlobalMaps(GlobalMaps), VLTS(VLTS),
617be9c9117SJohannes Doerfert       Schedule(Schedule) {
6183b11a16aSHongbin Zheng   assert(GlobalMaps.size() > 1 && "Only one vector lane found");
619a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
6203b11a16aSHongbin Zheng }
6213b11a16aSHongbin Zheng 
622be9c9117SJohannes Doerfert Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, const Value *Old,
623e602a076STobias Grosser                                             ValueMapT &VectorMap,
624e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
625e602a076STobias Grosser                                             Loop *L) {
626fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
627fe11e287SHongbin Zheng     return NewValue;
6283b11a16aSHongbin Zheng 
6293b11a16aSHongbin Zheng   int Width = getVectorWidth();
6303b11a16aSHongbin Zheng 
6313b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6323b11a16aSHongbin Zheng 
6333b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
634c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
635be9c9117SJohannes Doerfert         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], GlobalMaps[Lane],
636be9c9117SJohannes Doerfert                             VLTS[Lane], L),
6377242ad92STobias Grosser         Builder.getInt32(Lane));
6383b11a16aSHongbin Zheng 
6393b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6403b11a16aSHongbin Zheng 
6413b11a16aSHongbin Zheng   return Vector;
6423b11a16aSHongbin Zheng }
6433b11a16aSHongbin Zheng 
6443b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6453b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6463b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6473b11a16aSHongbin Zheng 
6483b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6493b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6503b11a16aSHongbin Zheng 
6513b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6523b11a16aSHongbin Zheng }
6533b11a16aSHongbin Zheng 
654be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
655be9c9117SJohannes Doerfert     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
6560dd463faSTobias Grosser     bool NegativeStride = false) {
6570dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
6583b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6590dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
6600dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
6610dd463faSTobias Grosser 
6625a56cbf4STobias Grosser   Value *NewPointer = nullptr;
663be9c9117SJohannes Doerfert   NewPointer = generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
664731685e6SJohannes Doerfert                                         GlobalMaps[Offset], VLTS[Offset]);
665c14582f2STobias Grosser   Value *VectorPtr =
666c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
667c14582f2STobias Grosser   LoadInst *VecLoad =
668c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
6693b11a16aSHongbin Zheng   if (!Aligned)
6703b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
6713b11a16aSHongbin Zheng 
6720dd463faSTobias Grosser   if (NegativeStride) {
6730dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
6740dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
6750dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
6760dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
6770dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
6780dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
6790dd463faSTobias Grosser     return RevVecLoad;
6800dd463faSTobias Grosser   }
6810dd463faSTobias Grosser 
6823b11a16aSHongbin Zheng   return VecLoad;
6833b11a16aSHongbin Zheng }
6843b11a16aSHongbin Zheng 
685be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideZeroLoad(ScopStmt &Stmt,
686be9c9117SJohannes Doerfert                                                     const LoadInst *Load,
6873b11a16aSHongbin Zheng                                                     ValueMapT &BBMap) {
6883b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6893b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
690be9c9117SJohannes Doerfert   Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
691be9c9117SJohannes Doerfert                                                GlobalMaps[0], VLTS[0]);
6923b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
6933b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
694c14582f2STobias Grosser   LoadInst *ScalarLoad =
695c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
6963b11a16aSHongbin Zheng 
6973b11a16aSHongbin Zheng   if (!Aligned)
6983b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
6993b11a16aSHongbin Zheng 
700c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
701c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
7023b11a16aSHongbin Zheng 
703c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
704c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
7053b11a16aSHongbin Zheng   return VectorLoad;
7063b11a16aSHongbin Zheng }
7073b11a16aSHongbin Zheng 
708be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
709be9c9117SJohannes Doerfert     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps) {
7103b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
7113b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7123b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
7133b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
7143b11a16aSHongbin Zheng 
7153b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
7163b11a16aSHongbin Zheng 
7173b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
718be9c9117SJohannes Doerfert     Value *NewPointer = generateLocationAccessed(
719be9c9117SJohannes Doerfert         Stmt, Load, Pointer, ScalarMaps[i], GlobalMaps[i], VLTS[i]);
720c14582f2STobias Grosser     Value *ScalarLoad =
721c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
722c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
723c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7243b11a16aSHongbin Zheng   }
7253b11a16aSHongbin Zheng 
7263b11a16aSHongbin Zheng   return Vector;
7273b11a16aSHongbin Zheng }
7283b11a16aSHongbin Zheng 
729be9c9117SJohannes Doerfert void VectorBlockGenerator::generateLoad(ScopStmt &Stmt, const LoadInst *Load,
730e602a076STobias Grosser                                         ValueMapT &VectorMap,
731e602a076STobias Grosser                                         VectorValueMapT &ScalarMaps) {
7322873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7333b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
734c14582f2STobias Grosser       ScalarMaps[i][Load] =
735be9c9117SJohannes Doerfert           generateScalarLoad(Stmt, Load, ScalarMaps[i], GlobalMaps[i], VLTS[i]);
7363b11a16aSHongbin Zheng     return;
7373b11a16aSHongbin Zheng   }
7383b11a16aSHongbin Zheng 
739be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Load);
7403b11a16aSHongbin Zheng 
74195493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
74295493984STobias Grosser   // the data location.
74395493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
74495493984STobias Grosser 
7453b11a16aSHongbin Zheng   Value *NewLoad;
746a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
747be9c9117SJohannes Doerfert     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0]);
748a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
749be9c9117SJohannes Doerfert     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps);
7500dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
751be9c9117SJohannes Doerfert     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, true);
7523b11a16aSHongbin Zheng   else
753be9c9117SJohannes Doerfert     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps);
7543b11a16aSHongbin Zheng 
7553b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
7563b11a16aSHongbin Zheng }
7573b11a16aSHongbin Zheng 
758be9c9117SJohannes Doerfert void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt,
759be9c9117SJohannes Doerfert                                          const UnaryInstruction *Inst,
7603b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
7613b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
7623b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
763be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
764be9c9117SJohannes Doerfert                                      ScalarMaps, getLoopForInst(Inst));
7653b11a16aSHongbin Zheng 
7663b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
7673b11a16aSHongbin Zheng 
7683b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
7693b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
7703b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
7713b11a16aSHongbin Zheng }
7723b11a16aSHongbin Zheng 
773be9c9117SJohannes Doerfert void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt,
774be9c9117SJohannes Doerfert                                           const BinaryOperator *Inst,
7753b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
7763b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
777369430ffSTobias Grosser   Loop *L = getLoopForInst(Inst);
7783b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
7793b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
7803b11a16aSHongbin Zheng 
7813b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
782be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
783be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
7843b11a16aSHongbin Zheng 
7851bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
7863b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
7873b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
7883b11a16aSHongbin Zheng }
7893b11a16aSHongbin Zheng 
790be9c9117SJohannes Doerfert void VectorBlockGenerator::copyStore(ScopStmt &Stmt, const StoreInst *Store,
791e602a076STobias Grosser                                      ValueMapT &VectorMap,
792e602a076STobias Grosser                                      VectorValueMapT &ScalarMaps) {
793be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Store);
7943b11a16aSHongbin Zheng 
7953b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
796be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
797369430ffSTobias Grosser                                  ScalarMaps, getLoopForInst(Store));
7983b11a16aSHongbin Zheng 
79950fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
80050fd7010STobias Grosser   // the data location.
80150fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
80250fd7010STobias Grosser 
803a00a0291SSebastian Pop   if (Access.isStrideOne(isl_map_copy(Schedule))) {
8041947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
805be9c9117SJohannes Doerfert     Value *NewPointer = generateLocationAccessed(
806be9c9117SJohannes Doerfert         Stmt, Store, Pointer, ScalarMaps[0], GlobalMaps[0], VLTS[0]);
8073b11a16aSHongbin Zheng 
808c14582f2STobias Grosser     Value *VectorPtr =
809c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
8103b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
8113b11a16aSHongbin Zheng 
8123b11a16aSHongbin Zheng     if (!Aligned)
8133b11a16aSHongbin Zheng       Store->setAlignment(8);
8143b11a16aSHongbin Zheng   } else {
8153b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
8161bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
817731685e6SJohannes Doerfert       Value *NewPointer = generateLocationAccessed(
818be9c9117SJohannes Doerfert           Stmt, Store, Pointer, ScalarMaps[i], GlobalMaps[i], VLTS[i]);
8193b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
8203b11a16aSHongbin Zheng     }
8213b11a16aSHongbin Zheng   }
8223b11a16aSHongbin Zheng }
8233b11a16aSHongbin Zheng 
8243b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
8253b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
82691f5b262STobias Grosser   for (Value *Operand : Inst->operands())
82791f5b262STobias Grosser     if (VectorMap.count(Operand))
8283b11a16aSHongbin Zheng       return true;
8293b11a16aSHongbin Zheng   return false;
8303b11a16aSHongbin Zheng }
8313b11a16aSHongbin Zheng 
8323b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
8333b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
8343b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
8353b11a16aSHongbin Zheng   bool HasVectorOperand = false;
8363b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8373b11a16aSHongbin Zheng 
83891f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
83991f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
8403b11a16aSHongbin Zheng 
8413b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
8423b11a16aSHongbin Zheng       continue;
8433b11a16aSHongbin Zheng 
8443b11a16aSHongbin Zheng     HasVectorOperand = true;
8453b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
8463b11a16aSHongbin Zheng 
8473b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
8483b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
8493b11a16aSHongbin Zheng 
8503b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
8513b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
8523b11a16aSHongbin Zheng       // existance of all of them.
85391f5b262STobias Grosser       if (SM.count(Operand))
8543b11a16aSHongbin Zheng         break;
8553b11a16aSHongbin Zheng 
85691f5b262STobias Grosser       SM[Operand] =
85791f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
8583b11a16aSHongbin Zheng     }
8593b11a16aSHongbin Zheng   }
8603b11a16aSHongbin Zheng 
8613b11a16aSHongbin Zheng   return HasVectorOperand;
8623b11a16aSHongbin Zheng }
8633b11a16aSHongbin Zheng 
864be9c9117SJohannes Doerfert void VectorBlockGenerator::copyInstScalarized(ScopStmt &Stmt,
865be9c9117SJohannes Doerfert                                               const Instruction *Inst,
8663b11a16aSHongbin Zheng                                               ValueMapT &VectorMap,
8673b11a16aSHongbin Zheng                                               VectorValueMapT &ScalarMaps) {
8683b11a16aSHongbin Zheng   bool HasVectorOperand;
8693b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8703b11a16aSHongbin Zheng 
8713b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
8723b11a16aSHongbin Zheng 
8733b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
874be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
875731685e6SJohannes Doerfert                                     GlobalMaps[VectorLane], VLTS[VectorLane]);
8763b11a16aSHongbin Zheng 
8773b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
8783b11a16aSHongbin Zheng     return;
8793b11a16aSHongbin Zheng 
8803b11a16aSHongbin Zheng   // Make the result available as vector value.
8813b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
8823b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
8833b11a16aSHongbin Zheng 
8843b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
8853b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
8863b11a16aSHongbin Zheng                                          Builder.getInt32(i));
8873b11a16aSHongbin Zheng 
8883b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
8893b11a16aSHongbin Zheng }
8903b11a16aSHongbin Zheng 
891c14582f2STobias Grosser int VectorBlockGenerator::getVectorWidth() { return GlobalMaps.size(); }
8923b11a16aSHongbin Zheng 
893be9c9117SJohannes Doerfert void VectorBlockGenerator::copyInstruction(ScopStmt &Stmt,
894be9c9117SJohannes Doerfert                                            const Instruction *Inst,
8953b11a16aSHongbin Zheng                                            ValueMapT &VectorMap,
8963b11a16aSHongbin Zheng                                            VectorValueMapT &ScalarMaps) {
8973b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
8983b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
8993b11a16aSHongbin Zheng   if (Inst->isTerminator())
9003b11a16aSHongbin Zheng     return;
9013b11a16aSHongbin Zheng 
9021ef52333SJohannes Doerfert   if (canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion()))
903e71c6ab5STobias Grosser     return;
904e71c6ab5STobias Grosser 
9053b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
906be9c9117SJohannes Doerfert     generateLoad(Stmt, Load, VectorMap, ScalarMaps);
9073b11a16aSHongbin Zheng     return;
9083b11a16aSHongbin Zheng   }
9093b11a16aSHongbin Zheng 
9103b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
9113b11a16aSHongbin Zheng     if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
912be9c9117SJohannes Doerfert       copyStore(Stmt, Store, VectorMap, ScalarMaps);
9133b11a16aSHongbin Zheng       return;
9143b11a16aSHongbin Zheng     }
9153b11a16aSHongbin Zheng 
9163b11a16aSHongbin Zheng     if (const UnaryInstruction *Unary = dyn_cast<UnaryInstruction>(Inst)) {
917be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9183b11a16aSHongbin Zheng       return;
9193b11a16aSHongbin Zheng     }
9203b11a16aSHongbin Zheng 
9213b11a16aSHongbin Zheng     if (const BinaryOperator *Binary = dyn_cast<BinaryOperator>(Inst)) {
922be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
9233b11a16aSHongbin Zheng       return;
9243b11a16aSHongbin Zheng     }
9253b11a16aSHongbin Zheng 
9263b11a16aSHongbin Zheng     // Falltrough: We generate scalar instructions, if we don't know how to
9273b11a16aSHongbin Zheng     // generate vector code.
9283b11a16aSHongbin Zheng   }
9293b11a16aSHongbin Zheng 
930be9c9117SJohannes Doerfert   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps);
9313b11a16aSHongbin Zheng }
9323b11a16aSHongbin Zheng 
933275a1756SJohannes Doerfert void VectorBlockGenerator::copyStmt(ScopStmt &Stmt) {
934275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
935275a1756SJohannes Doerfert                                "the vector block generator");
936275a1756SJohannes Doerfert 
937be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
938c14582f2STobias Grosser   BasicBlock *CopyBB =
939b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
9403b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
9413b11a16aSHongbin Zheng   Builder.SetInsertPoint(CopyBB->begin());
9423b11a16aSHongbin Zheng 
9433b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
9443b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
9453b11a16aSHongbin Zheng   // are basic block local.
9463b11a16aSHongbin Zheng   //
9473b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
9483b11a16aSHongbin Zheng   // and one for vector values.
9493b11a16aSHongbin Zheng   //
9503b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
9513b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
9523b11a16aSHongbin Zheng   //
9533b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
9543b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
9553b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
9563b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
9573b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
9583b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
9593b11a16aSHongbin Zheng 
96091f5b262STobias Grosser   for (Instruction &Inst : *BB)
961be9c9117SJohannes Doerfert     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap);
9623b11a16aSHongbin Zheng }
963275a1756SJohannes Doerfert 
964ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
965ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
966514f6efaSJohannes Doerfert 
967514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
968514f6efaSJohannes Doerfert   BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
969514f6efaSJohannes Doerfert 
970514f6efaSJohannes Doerfert   if (BBCopyIDom)
971514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
972514f6efaSJohannes Doerfert 
973514f6efaSJohannes Doerfert   return BBCopyIDom;
974514f6efaSJohannes Doerfert }
975514f6efaSJohannes Doerfert 
976275a1756SJohannes Doerfert void RegionGenerator::copyStmt(ScopStmt &Stmt, ValueMapT &GlobalMap,
977275a1756SJohannes Doerfert                                LoopToScevMapT &LTS) {
978275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
979d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
980275a1756SJohannes Doerfert 
981ecff11dcSJohannes Doerfert   // Forget all old mappings.
982ecff11dcSJohannes Doerfert   BlockMap.clear();
983ecff11dcSJohannes Doerfert   RegionMaps.clear();
984ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
985ecff11dcSJohannes Doerfert 
986275a1756SJohannes Doerfert   // The region represented by the statement.
987275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
988275a1756SJohannes Doerfert 
989ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
990ecff11dcSJohannes Doerfert   // inputs.
991ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
992ecff11dcSJohannes Doerfert   BasicBlock *EntryBBCopy =
993ecff11dcSJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
994ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
995ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(EntryBBCopy->begin());
996514f6efaSJohannes Doerfert 
997ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
998ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
999ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
1000275a1756SJohannes Doerfert 
1001275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1002275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
1003275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
1004ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1005ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1006275a1756SJohannes Doerfert 
1007275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1008275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1009275a1756SJohannes Doerfert     Blocks.pop_front();
1010275a1756SJohannes Doerfert 
1011514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1012514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1013ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1014ecff11dcSJohannes Doerfert 
1015ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1016ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1017514f6efaSJohannes Doerfert 
1018514f6efaSJohannes Doerfert     // Get the mapping for this block and initialize it with the mapping
1019514f6efaSJohannes Doerfert     // available at its immediate dominator (in the new region).
1020514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1021514f6efaSJohannes Doerfert     RegionMap = RegionMaps[BBCopyIDom];
1022514f6efaSJohannes Doerfert 
1023275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1024514f6efaSJohannes Doerfert     copyBB(Stmt, BB, BBCopy, RegionMap, GlobalMap, LTS);
1025275a1756SJohannes Doerfert 
1026ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1027ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1028ecff11dcSJohannes Doerfert 
1029ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1030ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1031ecff11dcSJohannes Doerfert       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB,
1032ecff11dcSJohannes Doerfert                       GlobalMap, LTS);
1033ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1034ecff11dcSJohannes Doerfert 
1035275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1036275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1037275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1038275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1039275a1756SJohannes Doerfert   }
1040275a1756SJohannes Doerfert 
1041275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1042514f6efaSJohannes Doerfert   BasicBlock *ExitBBCopy =
1043275a1756SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1044ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1045514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1046514f6efaSJohannes Doerfert 
1047ecff11dcSJohannes Doerfert   repairDominance(R->getExit(), ExitBBCopy);
1048275a1756SJohannes Doerfert 
1049275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1050275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1051275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1052275a1756SJohannes Doerfert 
1053275a1756SJohannes Doerfert     BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1054275a1756SJohannes Doerfert 
1055514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1056275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1057275a1756SJohannes Doerfert 
1058514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1059514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1060514f6efaSJohannes Doerfert 
106145e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
1062275a1756SJohannes Doerfert     copyInstScalar(Stmt, BI, RegionMap, GlobalMap, LTS);
1063275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1064275a1756SJohannes Doerfert   }
1065275a1756SJohannes Doerfert 
1066ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1067ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1068ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1069ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1070ecff11dcSJohannes Doerfert     if (L == nullptr || L->getHeader() != BB)
1071ecff11dcSJohannes Doerfert       continue;
1072ecff11dcSJohannes Doerfert 
1073ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1074ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1075ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1076ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1077ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1078ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1079ecff11dcSJohannes Doerfert     LoopPHI->insertBefore(BBCopy->begin());
1080ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1081ecff11dcSJohannes Doerfert 
1082ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1083ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1084ecff11dcSJohannes Doerfert         continue;
1085ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1086ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1087ecff11dcSJohannes Doerfert       else
1088ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1089ecff11dcSJohannes Doerfert     }
1090ecff11dcSJohannes Doerfert 
1091ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1092ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1093ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1094ecff11dcSJohannes Doerfert 
1095ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1096ecff11dcSJohannes Doerfert   }
1097ecff11dcSJohannes Doerfert 
1098ecff11dcSJohannes Doerfert   // Add all mappings from the region to the global map so outside uses will use
1099ecff11dcSJohannes Doerfert   // the copied instructions.
1100ecff11dcSJohannes Doerfert   for (auto &BBMap : RegionMaps)
1101ecff11dcSJohannes Doerfert     GlobalMap.insert(BBMap.second.begin(), BBMap.second.end());
1102ecff11dcSJohannes Doerfert 
1103275a1756SJohannes Doerfert   // Reset the old insert point for the build.
1104514f6efaSJohannes Doerfert   Builder.SetInsertPoint(ExitBBCopy->begin());
1105275a1756SJohannes Doerfert }
1106ecff11dcSJohannes Doerfert 
1107ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarLoads(ScopStmt &Stmt,
1108ecff11dcSJohannes Doerfert                                           const Instruction *Inst,
1109ecff11dcSJohannes Doerfert                                           ValueMapT &BBMap) {
1110ecff11dcSJohannes Doerfert 
1111ecff11dcSJohannes Doerfert   // Inside a non-affine region PHI nodes are copied not demoted. Once the
1112ecff11dcSJohannes Doerfert   // phi is copied it will reload all inputs from outside the region, hence
1113ecff11dcSJohannes Doerfert   // we do not need to generate code for the read access of the operands of a
1114ecff11dcSJohannes Doerfert   // PHI.
1115ecff11dcSJohannes Doerfert   if (isa<PHINode>(Inst))
1116ecff11dcSJohannes Doerfert     return;
1117ecff11dcSJohannes Doerfert 
1118ecff11dcSJohannes Doerfert   return BlockGenerator::generateScalarLoads(Stmt, Inst, BBMap);
1119ecff11dcSJohannes Doerfert }
1120ecff11dcSJohannes Doerfert 
1121ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
1122ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1123ecff11dcSJohannes Doerfert                                            ValueMapT &GlobalMap) {
1124ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
1125ecff11dcSJohannes Doerfert 
1126ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1127ecff11dcSJohannes Doerfert   assert(StmtR && "Block statements need to use the generateScalarStores() "
1128ecff11dcSJohannes Doerfert                   "function in the BlockGenerator");
1129ecff11dcSJohannes Doerfert 
1130ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
1131ecff11dcSJohannes Doerfert 
1132ecff11dcSJohannes Doerfert     if (!MA->isScalar() || MA->isRead())
1133ecff11dcSJohannes Doerfert       continue;
1134ecff11dcSJohannes Doerfert 
1135ecff11dcSJohannes Doerfert     Instruction *ScalarBase = cast<Instruction>(MA->getBaseAddr());
1136ecff11dcSJohannes Doerfert     Instruction *ScalarInst = MA->getAccessInstruction();
1137ecff11dcSJohannes Doerfert     PHINode *ScalarBasePHI = dyn_cast<PHINode>(ScalarBase);
1138ecff11dcSJohannes Doerfert 
113962139132STobias Grosser     // Only generate accesses that belong to this basic block.
114062139132STobias Grosser     if (ScalarInst->getParent() != BB)
114162139132STobias Grosser       continue;
114262139132STobias Grosser 
114392245228STobias Grosser     Value *Val = nullptr;
1144ecff11dcSJohannes Doerfert     AllocaInst *ScalarAddr = nullptr;
1145ecff11dcSJohannes Doerfert 
114692245228STobias Grosser     if (MA->getScopArrayInfo()->isPHI()) {
1147ecff11dcSJohannes Doerfert       int PHIIdx = ScalarBasePHI->getBasicBlockIndex(BB);
1148ecff11dcSJohannes Doerfert       ScalarAddr = getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
114992245228STobias Grosser       Val = ScalarBasePHI->getIncomingValue(PHIIdx);
115092245228STobias Grosser     } else {
115192245228STobias Grosser       ScalarAddr = getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
115292245228STobias Grosser       Val = ScalarInst;
1153ecff11dcSJohannes Doerfert     }
1154ecff11dcSJohannes Doerfert 
115592245228STobias Grosser     Val = getNewScalarValue(Val, R, ScalarMap, BBMap, GlobalMap);
115692245228STobias Grosser     Builder.CreateStore(Val, ScalarAddr);
1157ecff11dcSJohannes Doerfert   }
1158ecff11dcSJohannes Doerfert }
1159ecff11dcSJohannes Doerfert 
1160ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1161ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1162ecff11dcSJohannes Doerfert                                       ValueMapT &GlobalMap,
1163ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1164ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1165ecff11dcSJohannes Doerfert 
1166ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1167ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1168ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1169ecff11dcSJohannes Doerfert   if (!BBCopy) {
1170ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1171ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1172ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1173ecff11dcSJohannes Doerfert     return;
1174ecff11dcSJohannes Doerfert   }
1175ecff11dcSJohannes Doerfert 
1176ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1177ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1178ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1179ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1180ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1181ecff11dcSJohannes Doerfert 
1182ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1183ecff11dcSJohannes Doerfert     OpCopy =
1184ecff11dcSJohannes Doerfert         getNewValue(Stmt, Op, BBCopyMap, GlobalMap, LTS, getLoopForInst(PHI));
1185ecff11dcSJohannes Doerfert   } else {
1186ecff11dcSJohannes Doerfert 
1187ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1188ecff11dcSJohannes Doerfert       return;
1189ecff11dcSJohannes Doerfert 
1190ecff11dcSJohannes Doerfert     AllocaInst *PHIOpAddr =
1191ecff11dcSJohannes Doerfert         getOrCreateAlloca(const_cast<PHINode *>(PHI), PHIOpMap, ".phiops");
1192ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1193ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1194ecff11dcSJohannes Doerfert   }
1195ecff11dcSJohannes Doerfert 
1196ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1197ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1198ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1199ecff11dcSJohannes Doerfert }
1200ecff11dcSJohannes Doerfert 
1201ecff11dcSJohannes Doerfert Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, const PHINode *PHI,
1202ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1203ecff11dcSJohannes Doerfert                                            ValueMapT &GlobalMap,
1204ecff11dcSJohannes Doerfert                                            LoopToScevMapT &LTS) {
1205ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1206ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1207ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1208ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1209ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1210ecff11dcSJohannes Doerfert 
1211ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1212ecff11dcSJohannes Doerfert     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), GlobalMap,
1213ecff11dcSJohannes Doerfert                     LTS);
1214ecff11dcSJohannes Doerfert   return PHICopy;
1215ecff11dcSJohannes Doerfert }
1216