13b11a16aSHongbin Zheng //===--- BlockGenerators.cpp - Generate code for statements -----*- C++ -*-===//
23b11a16aSHongbin Zheng //
33b11a16aSHongbin Zheng //                     The LLVM Compiler Infrastructure
43b11a16aSHongbin Zheng //
53b11a16aSHongbin Zheng // This file is distributed under the University of Illinois Open Source
63b11a16aSHongbin Zheng // License. See LICENSE.TXT for details.
73b11a16aSHongbin Zheng //
83b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
93b11a16aSHongbin Zheng //
103b11a16aSHongbin Zheng // This file implements the BlockGenerator and VectorBlockGenerator classes,
113b11a16aSHongbin Zheng // which generate sequential code and vectorized code for a polyhedral
123b11a16aSHongbin Zheng // statement, respectively.
133b11a16aSHongbin Zheng //
143b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
153b11a16aSHongbin Zheng 
163b11a16aSHongbin Zheng #include "polly/ScopInfo.h"
178a846610SHongbin Zheng #include "polly/CodeGen/BlockGenerators.h"
1883628182STobias Grosser #include "polly/CodeGen/CodeGeneration.h"
19a63b2579SJohannes Doerfert #include "polly/CodeGen/IslExprBuilder.h"
2086bc93a9STobias Grosser #include "polly/CodeGen/RuntimeDebugBuilder.h"
21637bd631STobias Grosser #include "polly/Options.h"
223b11a16aSHongbin Zheng #include "polly/Support/GICHelper.h"
2397cb813cSSebastian Pop #include "polly/Support/SCEVValidator.h"
24ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
25e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
26f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
27e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
28030237d0STobias Grosser #include "llvm/IR/IntrinsicInst.h"
29c9895067STobias Grosser #include "llvm/IR/Module.h"
303b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
311b9d25a4STobias Grosser #include "llvm/Transforms/Utils/Local.h"
32f32d651dSJohannes Doerfert #include "isl/aff.h"
33f32d651dSJohannes Doerfert #include "isl/ast.h"
34f32d651dSJohannes Doerfert #include "isl/ast_build.h"
35ba0d0922STobias Grosser #include "isl/set.h"
36f32d651dSJohannes Doerfert #include <deque>
37f32d651dSJohannes Doerfert 
383b11a16aSHongbin Zheng using namespace llvm;
393b11a16aSHongbin Zheng using namespace polly;
403b11a16aSHongbin Zheng 
41878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
42878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
43878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
44878aba49STobias Grosser                              cl::cat(PollyCategory));
453b11a16aSHongbin Zheng 
4686bc93a9STobias Grosser static cl::opt<bool> DebugPrinting(
4786bc93a9STobias Grosser     "polly-codegen-add-debug-printing",
4886bc93a9STobias Grosser     cl::desc("Add printf calls that show the values loaded/stored."),
4986bc93a9STobias Grosser     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
5086bc93a9STobias Grosser 
51dcc3b435STobias Grosser bool polly::canSynthesize(const Value *V, const llvm::LoopInfo *LI,
52ecfe21b7STobias Grosser                           ScalarEvolution *SE, const Region *R) {
53dcc3b435STobias Grosser   if (!V || !SE->isSCEVable(V->getType()))
54ecfe21b7STobias Grosser     return false;
55ecfe21b7STobias Grosser 
56dcc3b435STobias Grosser   if (const SCEV *Scev = SE->getSCEV(const_cast<Value *>(V)))
57ecfe21b7STobias Grosser     if (!isa<SCEVCouldNotCompute>(Scev))
58ecfe21b7STobias Grosser       if (!hasScalarDepsInsideRegion(Scev, R))
59ecfe21b7STobias Grosser         return true;
60ecfe21b7STobias Grosser 
61ecfe21b7STobias Grosser   return false;
62ecfe21b7STobias Grosser }
63ecfe21b7STobias Grosser 
649e3a5db0SJohannes Doerfert bool polly::isIgnoredIntrinsic(const Value *V) {
659e3a5db0SJohannes Doerfert   if (auto *IT = dyn_cast<IntrinsicInst>(V)) {
669e3a5db0SJohannes Doerfert     switch (IT->getIntrinsicID()) {
679e3a5db0SJohannes Doerfert     // Lifetime markers are supported/ignored.
689e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_start:
699e3a5db0SJohannes Doerfert     case llvm::Intrinsic::lifetime_end:
709e3a5db0SJohannes Doerfert     // Invariant markers are supported/ignored.
719e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_start:
729e3a5db0SJohannes Doerfert     case llvm::Intrinsic::invariant_end:
739e3a5db0SJohannes Doerfert     // Some misc annotations are supported/ignored.
749e3a5db0SJohannes Doerfert     case llvm::Intrinsic::var_annotation:
759e3a5db0SJohannes Doerfert     case llvm::Intrinsic::ptr_annotation:
769e3a5db0SJohannes Doerfert     case llvm::Intrinsic::annotation:
779e3a5db0SJohannes Doerfert     case llvm::Intrinsic::donothing:
789e3a5db0SJohannes Doerfert     case llvm::Intrinsic::assume:
799e3a5db0SJohannes Doerfert     case llvm::Intrinsic::expect:
80e83a396bSTobias Grosser     // Some debug info intrisics are supported/ignored.
81e83a396bSTobias Grosser     case llvm::Intrinsic::dbg_value:
82e83a396bSTobias Grosser     case llvm::Intrinsic::dbg_declare:
839e3a5db0SJohannes Doerfert       return true;
849e3a5db0SJohannes Doerfert     default:
859e3a5db0SJohannes Doerfert       break;
869e3a5db0SJohannes Doerfert     }
879e3a5db0SJohannes Doerfert   }
889e3a5db0SJohannes Doerfert   return false;
899e3a5db0SJohannes Doerfert }
909e3a5db0SJohannes Doerfert 
91b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
92b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
93ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
94ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
95ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
96*f4bb7a6aSTobias Grosser                                ValueMapT &GlobalMap,
97b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
98ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
99ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
100bc132607STobias Grosser       EscapeMap(EscapeMap), GlobalMap(GlobalMap) {}
101e71c6ab5STobias Grosser 
10233cb9f94STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, const Value *Old,
10333cb9f94STobias Grosser                                              ValueMapT &BBMap,
10433cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
105bc132607STobias Grosser                                              Loop *L) const {
106683b8e44STobias Grosser   if (SE.isSCEVable(Old->getType()))
107369430ffSTobias Grosser     if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
108e71c6ab5STobias Grosser       if (!isa<SCEVCouldNotCompute>(Scev)) {
109637b23dcSSebastian Pop         const SCEV *NewScev = apply(Scev, LTS, SE);
110*f4bb7a6aSTobias Grosser         llvm::ValueToValueMap VTV;
111637b23dcSSebastian Pop         VTV.insert(BBMap.begin(), BBMap.end());
112637b23dcSSebastian Pop         VTV.insert(GlobalMap.begin(), GlobalMap.end());
113e69e1141SJohannes Doerfert 
114e69e1141SJohannes Doerfert         Scop &S = *Stmt.getParent();
115e69e1141SJohannes Doerfert         const DataLayout &DL =
116e69e1141SJohannes Doerfert             S.getRegion().getEntry()->getParent()->getParent()->getDataLayout();
117e69e1141SJohannes Doerfert         auto IP = Builder.GetInsertPoint();
118e69e1141SJohannes Doerfert 
119e69e1141SJohannes Doerfert         assert(IP != Builder.GetInsertBlock()->end() &&
12045e7944bSTobias Grosser                "Only instructions can be insert points for SCEVExpander");
121c0729a32SJohannes Doerfert         Value *Expanded = expandCodeFor(S, SE, DL, "polly", NewScev,
122c0729a32SJohannes Doerfert                                         Old->getType(), IP, &VTV);
123e71c6ab5STobias Grosser 
124e71c6ab5STobias Grosser         BBMap[Old] = Expanded;
125e71c6ab5STobias Grosser         return Expanded;
126e71c6ab5STobias Grosser       }
127369430ffSTobias Grosser     }
128e71c6ab5STobias Grosser 
12933cb9f94STobias Grosser   return nullptr;
13033cb9f94STobias Grosser }
13133cb9f94STobias Grosser 
13233cb9f94STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, const Value *Old,
13333cb9f94STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
13433cb9f94STobias Grosser                                    Loop *L) const {
13533cb9f94STobias Grosser   // We assume constants never change.
13633cb9f94STobias Grosser   // This avoids map lookups for many calls to this function.
13733cb9f94STobias Grosser   if (isa<Constant>(Old))
13833cb9f94STobias Grosser     return const_cast<Value *>(Old);
13933cb9f94STobias Grosser 
14033cb9f94STobias Grosser   if (Value *New = GlobalMap.lookup(Old)) {
14133cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
14233cb9f94STobias Grosser       New = NewRemapped;
14333cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
14433cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
14533cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
14633cb9f94STobias Grosser 
14733cb9f94STobias Grosser     return New;
14833cb9f94STobias Grosser   }
14933cb9f94STobias Grosser 
15033cb9f94STobias Grosser   if (Value *New = BBMap.lookup(Old))
15133cb9f94STobias Grosser     return New;
15233cb9f94STobias Grosser 
15333cb9f94STobias Grosser   if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
15433cb9f94STobias Grosser     return New;
15533cb9f94STobias Grosser 
15616371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
15716371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
15816371acdSTobias Grosser     return const_cast<Value *>(Old);
15916371acdSTobias Grosser 
16016371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
16116371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
162be9c9117SJohannes Doerfert     if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
16316371acdSTobias Grosser       return const_cast<Value *>(Old);
16416371acdSTobias Grosser 
16516371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1665b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1675a56cbf4STobias Grosser   return nullptr;
1683b11a16aSHongbin Zheng }
1693b11a16aSHongbin Zheng 
170be9c9117SJohannes Doerfert void BlockGenerator::copyInstScalar(ScopStmt &Stmt, const Instruction *Inst,
171bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
172030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
173030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
174030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
175030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
176030237d0STobias Grosser     return;
177030237d0STobias Grosser 
1783b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1793b11a16aSHongbin Zheng 
1803b11a16aSHongbin Zheng   // Replace old operands with the new ones.
18191f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
182bc132607STobias Grosser     Value *NewOperand =
183bc132607STobias Grosser         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForInst(Inst));
1843b11a16aSHongbin Zheng 
1853b11a16aSHongbin Zheng     if (!NewOperand) {
186c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
187c14582f2STobias Grosser              "Store instructions are always needed!");
1883b11a16aSHongbin Zheng       delete NewInst;
1893b11a16aSHongbin Zheng       return;
1903b11a16aSHongbin Zheng     }
1913b11a16aSHongbin Zheng 
1923b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1933b11a16aSHongbin Zheng   }
1943b11a16aSHongbin Zheng 
1953b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1963b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1973b11a16aSHongbin Zheng 
1983b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
1993b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
2003b11a16aSHongbin Zheng }
2013b11a16aSHongbin Zheng 
202be9c9117SJohannes Doerfert Value *BlockGenerator::generateLocationAccessed(
203be9c9117SJohannes Doerfert     ScopStmt &Stmt, const Instruction *Inst, const Value *Pointer,
204bc132607STobias Grosser     ValueMapT &BBMap, LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses) {
205be9c9117SJohannes Doerfert   const MemoryAccess &MA = Stmt.getAccessFor(Inst);
2063b11a16aSHongbin Zheng 
2072d1ed0bfSTobias Grosser   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
2083b11a16aSHongbin Zheng 
2092d1ed0bfSTobias Grosser   if (AccessExpr) {
2102d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
21198b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
21298b3ee50STobias Grosser 
21398b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
21498b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
21598b3ee50STobias Grosser     // the newly generated pointer.
21698b3ee50STobias Grosser     auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
21798b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
21898b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
21998b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
22098b3ee50STobias Grosser 
22198b3ee50STobias Grosser     if (OldPtrTy != NewPtrTy) {
22298b3ee50STobias Grosser       assert(OldPtrTy->getPointerElementType()->getPrimitiveSizeInBits() ==
22398b3ee50STobias Grosser                  NewPtrTy->getPointerElementType()->getPrimitiveSizeInBits() &&
22498b3ee50STobias Grosser              "Pointer types to elements with different size found");
22598b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
22698b3ee50STobias Grosser     }
22798b3ee50STobias Grosser     return Address;
2282d1ed0bfSTobias Grosser   }
2292d1ed0bfSTobias Grosser 
230bc132607STobias Grosser   return getNewValue(Stmt, Pointer, BBMap, LTS, getLoopForInst(Inst));
2313b11a16aSHongbin Zheng }
2323b11a16aSHongbin Zheng 
2334d96c8d7STobias Grosser Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
2342ef3f4fdSJohannes Doerfert   return LI.getLoopFor(Inst->getParent());
235369430ffSTobias Grosser }
236369430ffSTobias Grosser 
237be9c9117SJohannes Doerfert Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, const LoadInst *Load,
238bc132607STobias Grosser                                           ValueMapT &BBMap, LoopToScevMapT &LTS,
2392d1ed0bfSTobias Grosser                                           isl_id_to_ast_expr *NewAccesses) {
240c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
241c1db67e2SJohannes Doerfert     return PreloadLoad;
242c1db67e2SJohannes Doerfert 
2433b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
244bc132607STobias Grosser   Value *NewPointer =
245bc132607STobias Grosser       generateLocationAccessed(Stmt, Load, Pointer, BBMap, LTS, NewAccesses);
24687901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
24787901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
24886bc93a9STobias Grosser 
24986bc93a9STobias Grosser   if (DebugPrinting)
25086bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
25186bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
25286bc93a9STobias Grosser 
2533b11a16aSHongbin Zheng   return ScalarLoad;
2543b11a16aSHongbin Zheng }
2553b11a16aSHongbin Zheng 
256c186ac7aSTobias Grosser void BlockGenerator::generateScalarStore(ScopStmt &Stmt, const StoreInst *Store,
257bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
2582d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
2593b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
260bc132607STobias Grosser   Value *NewPointer =
261bc132607STobias Grosser       generateLocationAccessed(Stmt, Store, Pointer, BBMap, LTS, NewAccesses);
262bc132607STobias Grosser   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
263bc132607STobias Grosser                                     getLoopForInst(Store));
2643b11a16aSHongbin Zheng 
26586bc93a9STobias Grosser   if (DebugPrinting)
26686bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
26786bc93a9STobias Grosser                                           ": ", ValueOperand, "\n");
26886bc93a9STobias Grosser 
269c186ac7aSTobias Grosser   Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
2703b11a16aSHongbin Zheng }
2713b11a16aSHongbin Zheng 
272be9c9117SJohannes Doerfert void BlockGenerator::copyInstruction(ScopStmt &Stmt, const Instruction *Inst,
273bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
2742d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
275ecff11dcSJohannes Doerfert 
276ecff11dcSJohannes Doerfert   // First check for possible scalar dependences for this instruction.
277bc132607STobias Grosser   generateScalarLoads(Stmt, Inst, BBMap);
278ecff11dcSJohannes Doerfert 
2793b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2803b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2813b11a16aSHongbin Zheng   if (Inst->isTerminator())
2823b11a16aSHongbin Zheng     return;
2833b11a16aSHongbin Zheng 
284ecff11dcSJohannes Doerfert   Loop *L = getLoopForInst(Inst);
285ecff11dcSJohannes Doerfert   if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
286ecff11dcSJohannes Doerfert       canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
287aff56c8aSTobias Grosser     // Synthesizable statements will be generated on-demand.
288e71c6ab5STobias Grosser     return;
289ecff11dcSJohannes Doerfert   }
290e71c6ab5STobias Grosser 
2913b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
292bc132607STobias Grosser     Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
2933d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2943d94fedfSSebastian Pop     // deterministic.
295753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2963b11a16aSHongbin Zheng     return;
2973b11a16aSHongbin Zheng   }
2983b11a16aSHongbin Zheng 
2993b11a16aSHongbin Zheng   if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
300bc132607STobias Grosser     generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
3013b11a16aSHongbin Zheng     return;
3023b11a16aSHongbin Zheng   }
3033b11a16aSHongbin Zheng 
304ecff11dcSJohannes Doerfert   if (const PHINode *PHI = dyn_cast<PHINode>(Inst)) {
305bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
306ecff11dcSJohannes Doerfert     return;
307ecff11dcSJohannes Doerfert   }
308ecff11dcSJohannes Doerfert 
3093f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
3103f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
3119c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
3123f500fa2SJohannes Doerfert     return;
3133f500fa2SJohannes Doerfert 
314bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
3153b11a16aSHongbin Zheng }
3163b11a16aSHongbin Zheng 
317bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
3182d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
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();
325bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
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,
336bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
3372d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
338514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
339bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
340514f6efaSJohannes Doerfert   return CopyBB;
341514f6efaSJohannes Doerfert }
342514f6efaSJohannes Doerfert 
343514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
344bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
3452d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
346514f6efaSJohannes Doerfert   Builder.SetInsertPoint(CopyBB->begin());
347ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
348ecff11dcSJohannes Doerfert 
34991f5b262STobias Grosser   for (Instruction &Inst : *BB)
350bc132607STobias Grosser     copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
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.
355aff56c8aSTobias Grosser   generateScalarStores(Stmt, BB, LTS, BBMap);
356ecff11dcSJohannes Doerfert 
357ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
358ecff11dcSJohannes Doerfert   for (Instruction &Inst : *BB)
359bc132607STobias Grosser     handleOutsideUsers(R, &Inst, BBMap[&Inst]);
360ecff11dcSJohannes Doerfert }
361ecff11dcSJohannes Doerfert 
36264c0ff41STobias Grosser Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
363ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &Map,
3642985400aSTobias Grosser                                          const char *NameExt) {
365ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
366e9cb5a09STobias Grosser   if (!Map.count(ScalarBase)) {
367ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
368b09455deSTobias Grosser     auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
36964c0ff41STobias Grosser     EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
370b09455deSTobias Grosser     NewAddr->insertBefore(EntryBB->getFirstInsertionPt());
371e9cb5a09STobias Grosser     Map[ScalarBase] = NewAddr;
372ecff11dcSJohannes Doerfert   }
373ecff11dcSJohannes Doerfert 
374e9cb5a09STobias Grosser   auto Addr = Map[ScalarBase];
375e9cb5a09STobias Grosser 
376bc132607STobias Grosser   if (GlobalMap.count(Addr))
377bc132607STobias Grosser     return GlobalMap[Addr];
37864c0ff41STobias Grosser 
379ecff11dcSJohannes Doerfert   return Addr;
380ecff11dcSJohannes Doerfert }
381ecff11dcSJohannes Doerfert 
382bc132607STobias Grosser Value *BlockGenerator::getOrCreateAlloca(MemoryAccess &Access) {
383f8d55f7eSTobias Grosser   if (Access.getScopArrayInfo()->isPHI())
384bc132607STobias Grosser     return getOrCreatePHIAlloca(Access.getBaseAddr());
385f8d55f7eSTobias Grosser   else
386bc132607STobias Grosser     return getOrCreateScalarAlloca(Access.getBaseAddr());
387f8d55f7eSTobias Grosser }
388f8d55f7eSTobias Grosser 
389bc132607STobias Grosser Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
390bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
391b79a67dfSTobias Grosser }
392b79a67dfSTobias Grosser 
393bc132607STobias Grosser Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
394bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
395b79a67dfSTobias Grosser }
396b79a67dfSTobias Grosser 
397bc132607STobias Grosser void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
398b09455deSTobias Grosser                                         Value *InstCopy, Value *Address) {
3992985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
4002985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
4012985400aSTobias Grosser   // copied multiple times we already did this and can exit.
402acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
403acb6ade7SMichael Kruse     return;
404e69e1141SJohannes Doerfert 
405ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
406ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
407ecff11dcSJohannes Doerfert 
408ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
409ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
410ecff11dcSJohannes Doerfert     if (!UI)
411ecff11dcSJohannes Doerfert       continue;
412ecff11dcSJohannes Doerfert 
413ddb83d0fSJohannes Doerfert     if (R.contains(UI))
414ecff11dcSJohannes Doerfert       continue;
415ecff11dcSJohannes Doerfert 
416ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
417ecff11dcSJohannes Doerfert   }
418ecff11dcSJohannes Doerfert 
419ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
420ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
421ecff11dcSJohannes Doerfert     return;
422ecff11dcSJohannes Doerfert 
423ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
424b09455deSTobias Grosser   auto *ScalarAddr = Address ? Address : getOrCreateScalarAlloca(Inst);
425ecff11dcSJohannes Doerfert 
426ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
427ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
428ecff11dcSJohannes Doerfert }
429ecff11dcSJohannes Doerfert 
430ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarLoads(ScopStmt &Stmt,
431ecff11dcSJohannes Doerfert                                          const Instruction *Inst,
432bc132607STobias Grosser                                          ValueMapT &BBMap) {
433d4dd6ec7STobias Grosser   auto *MAL = Stmt.lookupAccessesFor(Inst);
434ecff11dcSJohannes Doerfert 
435d4dd6ec7STobias Grosser   if (!MAL)
436d4dd6ec7STobias Grosser     return;
437d4dd6ec7STobias Grosser 
438e2bccbbfSMichael Kruse   for (MemoryAccess *MA : *MAL) {
4398d0b734eSMichael Kruse     if (MA->isExplicit() || !MA->isRead())
440ecff11dcSJohannes Doerfert       continue;
441ecff11dcSJohannes Doerfert 
442e2bccbbfSMichael Kruse     auto *Address = getOrCreateAlloca(*MA);
443e2bccbbfSMichael Kruse     BBMap[MA->getBaseAddr()] =
4442fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
445ecff11dcSJohannes Doerfert   }
446ecff11dcSJohannes Doerfert }
447ecff11dcSJohannes Doerfert 
448ecff11dcSJohannes Doerfert Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
449aff56c8aSTobias Grosser                                          ScopStmt &Stmt, LoopToScevMapT &LTS,
450bc132607STobias Grosser                                          ValueMapT &BBMap) {
451ecff11dcSJohannes Doerfert   // If the value we want to store is an instruction we might have demoted it
452ecff11dcSJohannes Doerfert   // in order to make it accessible here. In such a case a reload is
453ecff11dcSJohannes Doerfert   // necessary. If it is no instruction it will always be a value that
454ecff11dcSJohannes Doerfert   // dominates the current point and we can just use it. In total there are 4
455ecff11dcSJohannes Doerfert   // options:
456ecff11dcSJohannes Doerfert   //  (1) The value is no instruction ==> use the value.
457ecff11dcSJohannes Doerfert   //  (2) The value is an instruction that was split out of the region prior to
458ecff11dcSJohannes Doerfert   //      code generation  ==> use the instruction as it dominates the region.
459ecff11dcSJohannes Doerfert   //  (3) The value is an instruction:
460ecff11dcSJohannes Doerfert   //      (a) The value was defined in the current block, thus a copy is in
461ecff11dcSJohannes Doerfert   //          the BBMap ==> use the mapped value.
462ecff11dcSJohannes Doerfert   //      (b) The value was defined in a previous block, thus we demoted it
463ecff11dcSJohannes Doerfert   //          earlier ==> use the reloaded value.
464ecff11dcSJohannes Doerfert   Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
465ecff11dcSJohannes Doerfert   if (!ScalarValueInst)
466ecff11dcSJohannes Doerfert     return ScalarValue;
467ecff11dcSJohannes Doerfert 
468ecff11dcSJohannes Doerfert   if (!R.contains(ScalarValueInst)) {
469ecff11dcSJohannes Doerfert     if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
470ecff11dcSJohannes Doerfert       return /* Case (3a) */ ScalarValueCopy;
471ecff11dcSJohannes Doerfert     else
472ecff11dcSJohannes Doerfert       return /* Case 2 */ ScalarValue;
473ecff11dcSJohannes Doerfert   }
474ecff11dcSJohannes Doerfert 
475ecff11dcSJohannes Doerfert   if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
476ecff11dcSJohannes Doerfert     return /* Case (3a) */ ScalarValueCopy;
477ecff11dcSJohannes Doerfert 
478aff56c8aSTobias Grosser   if ((Stmt.isBlockStmt() &&
479aff56c8aSTobias Grosser        Stmt.getBasicBlock() == ScalarValueInst->getParent()) ||
480aff56c8aSTobias Grosser       (Stmt.isRegionStmt() && Stmt.getRegion()->contains(ScalarValueInst))) {
481aff56c8aSTobias Grosser     auto SynthesizedValue = trySynthesizeNewValue(
482aff56c8aSTobias Grosser         Stmt, ScalarValueInst, BBMap, LTS, getLoopForInst(ScalarValueInst));
483aff56c8aSTobias Grosser 
484aff56c8aSTobias Grosser     if (SynthesizedValue)
485aff56c8aSTobias Grosser       return SynthesizedValue;
486aff56c8aSTobias Grosser   }
487aff56c8aSTobias Grosser 
488ecff11dcSJohannes Doerfert   // Case (3b)
489bc132607STobias Grosser   Value *Address = getOrCreateScalarAlloca(ScalarValueInst);
490b649e26aSTobias Grosser   ScalarValue = Builder.CreateLoad(Address, Address->getName() + ".reload");
491ecff11dcSJohannes Doerfert 
492ecff11dcSJohannes Doerfert   return ScalarValue;
493ecff11dcSJohannes Doerfert }
494ecff11dcSJohannes Doerfert 
495ecff11dcSJohannes Doerfert void BlockGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
496aff56c8aSTobias Grosser                                           LoopToScevMapT &LTS,
497bc132607STobias Grosser                                           ValueMapT &BBMap) {
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) {
5058d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
506ecff11dcSJohannes Doerfert       continue;
507ecff11dcSJohannes Doerfert 
508d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
509bc132607STobias Grosser     auto *Address = getOrCreateAlloca(*MA);
510d86f2157SJohannes Doerfert 
511aff56c8aSTobias Grosser     Val = getNewScalarValue(Val, R, Stmt, LTS, BBMap);
51292245228STobias Grosser     Builder.CreateStore(Val, Address);
513ecff11dcSJohannes Doerfert   }
514ecff11dcSJohannes Doerfert }
515ecff11dcSJohannes Doerfert 
516c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
517c0091a77STobias Grosser   Region &R = S.getRegion();
518ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
519ecff11dcSJohannes Doerfert   BasicBlock *SplitBB = R.getEnteringBlock();
520ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
521ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
522ecff11dcSJohannes Doerfert 
523ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
524ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
525ecff11dcSJohannes Doerfert   if (StartBB == R.getEntry())
526ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
527ecff11dcSJohannes Doerfert 
528fb19dd69SJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
529ecff11dcSJohannes Doerfert 
530c0091a77STobias Grosser   for (auto &Pair : S.arrays()) {
531c0091a77STobias Grosser     auto &Array = Pair.second;
532c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
533c0091a77STobias Grosser       continue;
534c0091a77STobias Grosser     if (Array->isPHI()) {
535c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
536c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
537c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
538c0091a77STobias Grosser       // 'SplitBB'.
539c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
540ecff11dcSJohannes Doerfert 
541c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
542c0091a77STobias Grosser         if (!R.contains(*BI) && *BI != SplitBB)
543c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
544c0091a77STobias Grosser                            "come from SplitBB");
545c0091a77STobias Grosser 
546c0091a77STobias Grosser       int Idx = PHI->getBasicBlockIndex(SplitBB);
547c0091a77STobias Grosser       if (Idx < 0)
548ecff11dcSJohannes Doerfert         continue;
549ecff11dcSJohannes Doerfert 
550c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
551ecff11dcSJohannes Doerfert 
552bc132607STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
553c0091a77STobias Grosser       continue;
554c0091a77STobias Grosser     }
555c0091a77STobias Grosser 
556c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
557c0091a77STobias Grosser 
558c0091a77STobias Grosser     if (Inst && R.contains(Inst))
559c0091a77STobias Grosser       continue;
560c0091a77STobias Grosser 
561717b8667SJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are exit PHI
562717b8667SJohannes Doerfert     // nodes we model as common scalars but do not need to initialize.
563717b8667SJohannes Doerfert     if (Inst && isa<PHINode>(Inst))
564717b8667SJohannes Doerfert       continue;
565717b8667SJohannes Doerfert 
56664c0ff41STobias Grosser     ValueMapT EmptyMap;
567c0091a77STobias Grosser     Builder.CreateStore(Array->getBasePtr(),
568bc132607STobias Grosser                         getOrCreateScalarAlloca(Array->getBasePtr()));
569ecff11dcSJohannes Doerfert   }
570ecff11dcSJohannes Doerfert }
571ecff11dcSJohannes Doerfert 
572ecff11dcSJohannes Doerfert void BlockGenerator::createScalarFinalization(Region &R) {
573ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
574ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExitingBlock();
575ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
576ecff11dcSJohannes Doerfert   BasicBlock *MergeBB = R.getExit();
577ecff11dcSJohannes Doerfert 
578ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
579ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
580ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
581ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
582ecff11dcSJohannes Doerfert 
583ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
584ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
585ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
586ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
587ecff11dcSJohannes Doerfert     Instruction *EscapeInst = EscapeMapping.getFirst();
588ecff11dcSJohannes Doerfert     const auto &EscapeMappingValue = EscapeMapping.getSecond();
589ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
59064c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
591ecff11dcSJohannes Doerfert 
592ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
593ecff11dcSJohannes Doerfert     Instruction *EscapeInstReload =
594ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
595ecff11dcSJohannes Doerfert 
596ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
597ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
598ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
599ecff11dcSJohannes Doerfert     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
600ecff11dcSJohannes Doerfert 
601ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
602ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
603ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
604ecff11dcSJohannes Doerfert 
605ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
606ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
607ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
608ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
609ecff11dcSJohannes Doerfert 
610ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
611ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
612ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
613ecff11dcSJohannes Doerfert   }
614ecff11dcSJohannes Doerfert }
615ecff11dcSJohannes Doerfert 
616655a4570STobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
617717b8667SJohannes Doerfert 
618717b8667SJohannes Doerfert   // Handle PHI nodes that were in the original exit and are now
619717b8667SJohannes Doerfert   // moved into the region exiting block.
620717b8667SJohannes Doerfert   if (!S.hasSingleExitEdge()) {
621717b8667SJohannes Doerfert     for (Instruction &I : *S.getRegion().getExitingBlock()) {
622717b8667SJohannes Doerfert       PHINode *PHI = dyn_cast<PHINode>(&I);
623717b8667SJohannes Doerfert       if (!PHI)
624717b8667SJohannes Doerfert         break;
625717b8667SJohannes Doerfert 
626717b8667SJohannes Doerfert       assert(PHI->getNumUses() == 1);
627717b8667SJohannes Doerfert       assert(ScalarMap.count(PHI->user_back()));
628717b8667SJohannes Doerfert 
629717b8667SJohannes Doerfert       handleOutsideUsers(S.getRegion(), PHI, nullptr,
630717b8667SJohannes Doerfert                          ScalarMap[PHI->user_back()]);
631717b8667SJohannes Doerfert     }
632717b8667SJohannes Doerfert   }
633717b8667SJohannes Doerfert 
634c0091a77STobias Grosser   createScalarInitialization(S);
635ecff11dcSJohannes Doerfert   createScalarFinalization(S.getRegion());
6363b11a16aSHongbin Zheng }
6373b11a16aSHongbin Zheng 
638be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
639be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
640be9c9117SJohannes Doerfert                                            isl_map *Schedule)
641bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
642a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
6433b11a16aSHongbin Zheng }
6443b11a16aSHongbin Zheng 
645be9c9117SJohannes Doerfert Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, const Value *Old,
646e602a076STobias Grosser                                             ValueMapT &VectorMap,
647e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
648e602a076STobias Grosser                                             Loop *L) {
649fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
650fe11e287SHongbin Zheng     return NewValue;
6513b11a16aSHongbin Zheng 
6523b11a16aSHongbin Zheng   int Width = getVectorWidth();
6533b11a16aSHongbin Zheng 
6543b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6553b11a16aSHongbin Zheng 
6563b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
657c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
658bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
6597242ad92STobias Grosser         Builder.getInt32(Lane));
6603b11a16aSHongbin Zheng 
6613b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6623b11a16aSHongbin Zheng 
6633b11a16aSHongbin Zheng   return Vector;
6643b11a16aSHongbin Zheng }
6653b11a16aSHongbin Zheng 
6663b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6673b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6683b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6693b11a16aSHongbin Zheng 
6703b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6713b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6723b11a16aSHongbin Zheng 
6733b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6743b11a16aSHongbin Zheng }
6753b11a16aSHongbin Zheng 
676be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
677be9c9117SJohannes Doerfert     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
6782d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
6790dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
6803b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
6810dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
6820dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
6830dd463faSTobias Grosser 
6845a56cbf4STobias Grosser   Value *NewPointer = nullptr;
685bc132607STobias Grosser   NewPointer = generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
686bc132607STobias Grosser                                         VLTS[Offset], NewAccesses);
687c14582f2STobias Grosser   Value *VectorPtr =
688c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
689c14582f2STobias Grosser   LoadInst *VecLoad =
690c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
6913b11a16aSHongbin Zheng   if (!Aligned)
6923b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
6933b11a16aSHongbin Zheng 
6940dd463faSTobias Grosser   if (NegativeStride) {
6950dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
6960dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
6970dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
6980dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
6990dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
7000dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
7010dd463faSTobias Grosser     return RevVecLoad;
7020dd463faSTobias Grosser   }
7030dd463faSTobias Grosser 
7043b11a16aSHongbin Zheng   return VecLoad;
7053b11a16aSHongbin Zheng }
7063b11a16aSHongbin Zheng 
7072d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
7082d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &BBMap,
7092d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7103b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7113b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
712bc132607STobias Grosser   Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
713bc132607STobias Grosser                                                VLTS[0], NewAccesses);
7143b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
7153b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
716c14582f2STobias Grosser   LoadInst *ScalarLoad =
717c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
7183b11a16aSHongbin Zheng 
7193b11a16aSHongbin Zheng   if (!Aligned)
7203b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
7213b11a16aSHongbin Zheng 
722c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
723c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
7243b11a16aSHongbin Zheng 
725c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
726c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
7273b11a16aSHongbin Zheng   return VectorLoad;
7283b11a16aSHongbin Zheng }
7293b11a16aSHongbin Zheng 
730be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
7312d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, VectorValueMapT &ScalarMaps,
7322d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses
7332d1ed0bfSTobias Grosser 
7342d1ed0bfSTobias Grosser     ) {
7353b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
7363b11a16aSHongbin Zheng   const Value *Pointer = Load->getPointerOperand();
7373b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
7383b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
7393b11a16aSHongbin Zheng 
7403b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
7413b11a16aSHongbin Zheng 
7423b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
743bc132607STobias Grosser     Value *NewPointer = generateLocationAccessed(
744bc132607STobias Grosser         Stmt, Load, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
745c14582f2STobias Grosser     Value *ScalarLoad =
746c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
747c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
748c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7493b11a16aSHongbin Zheng   }
7503b11a16aSHongbin Zheng 
7513b11a16aSHongbin Zheng   return Vector;
7523b11a16aSHongbin Zheng }
7533b11a16aSHongbin Zheng 
7542d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
7552d1ed0bfSTobias Grosser     ScopStmt &Stmt, const LoadInst *Load, ValueMapT &VectorMap,
7562d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
757c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
758c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
759c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
760c1db67e2SJohannes Doerfert     return;
761c1db67e2SJohannes Doerfert   }
762c1db67e2SJohannes Doerfert 
7632873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7643b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
765bc132607STobias Grosser       ScalarMaps[i][Load] =
766bc132607STobias Grosser           generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
7673b11a16aSHongbin Zheng     return;
7683b11a16aSHongbin Zheng   }
7693b11a16aSHongbin Zheng 
770be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Load);
7713b11a16aSHongbin Zheng 
77295493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
77395493984STobias Grosser   // the data location.
77495493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
77595493984STobias Grosser 
7763b11a16aSHongbin Zheng   Value *NewLoad;
777a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
7782d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
779a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
7802d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
7810dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
7822d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
7833b11a16aSHongbin Zheng   else
7842d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
7853b11a16aSHongbin Zheng 
7863b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
7873b11a16aSHongbin Zheng }
7883b11a16aSHongbin Zheng 
789be9c9117SJohannes Doerfert void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt,
790be9c9117SJohannes Doerfert                                          const UnaryInstruction *Inst,
7913b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
7923b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
7933b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
794be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
795be9c9117SJohannes Doerfert                                      ScalarMaps, getLoopForInst(Inst));
7963b11a16aSHongbin Zheng 
7973b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
7983b11a16aSHongbin Zheng 
7993b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
8003b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
8013b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
8023b11a16aSHongbin Zheng }
8033b11a16aSHongbin Zheng 
804be9c9117SJohannes Doerfert void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt,
805be9c9117SJohannes Doerfert                                           const BinaryOperator *Inst,
8063b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
8073b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
808369430ffSTobias Grosser   Loop *L = getLoopForInst(Inst);
8093b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
8103b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
8113b11a16aSHongbin Zheng 
8123b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
813be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
814be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
8153b11a16aSHongbin Zheng 
8161bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
8173b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
8183b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
8193b11a16aSHongbin Zheng }
8203b11a16aSHongbin Zheng 
8212d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
8222d1ed0bfSTobias Grosser     ScopStmt &Stmt, const StoreInst *Store, ValueMapT &VectorMap,
8232d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
824be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Store);
8253b11a16aSHongbin Zheng 
8263b11a16aSHongbin Zheng   const Value *Pointer = Store->getPointerOperand();
827be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
828369430ffSTobias Grosser                                  ScalarMaps, getLoopForInst(Store));
8293b11a16aSHongbin Zheng 
83050fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
83150fd7010STobias Grosser   // the data location.
83250fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
83350fd7010STobias Grosser 
834a00a0291SSebastian Pop   if (Access.isStrideOne(isl_map_copy(Schedule))) {
8351947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
836bc132607STobias Grosser     Value *NewPointer = generateLocationAccessed(
837bc132607STobias Grosser         Stmt, Store, Pointer, ScalarMaps[0], VLTS[0], NewAccesses);
8383b11a16aSHongbin Zheng 
839c14582f2STobias Grosser     Value *VectorPtr =
840c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
8413b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
8423b11a16aSHongbin Zheng 
8433b11a16aSHongbin Zheng     if (!Aligned)
8443b11a16aSHongbin Zheng       Store->setAlignment(8);
8453b11a16aSHongbin Zheng   } else {
8463b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
8471bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
848bc132607STobias Grosser       Value *NewPointer = generateLocationAccessed(
849bc132607STobias Grosser           Stmt, Store, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
8503b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
8513b11a16aSHongbin Zheng     }
8523b11a16aSHongbin Zheng   }
8533b11a16aSHongbin Zheng }
8543b11a16aSHongbin Zheng 
8553b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
8563b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
85791f5b262STobias Grosser   for (Value *Operand : Inst->operands())
85891f5b262STobias Grosser     if (VectorMap.count(Operand))
8593b11a16aSHongbin Zheng       return true;
8603b11a16aSHongbin Zheng   return false;
8613b11a16aSHongbin Zheng }
8623b11a16aSHongbin Zheng 
8633b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
8643b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
8653b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
8663b11a16aSHongbin Zheng   bool HasVectorOperand = false;
8673b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
8683b11a16aSHongbin Zheng 
86991f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
87091f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
8713b11a16aSHongbin Zheng 
8723b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
8733b11a16aSHongbin Zheng       continue;
8743b11a16aSHongbin Zheng 
8753b11a16aSHongbin Zheng     HasVectorOperand = true;
8763b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
8773b11a16aSHongbin Zheng 
8783b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
8793b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
8803b11a16aSHongbin Zheng 
8813b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
8823b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
8833b11a16aSHongbin Zheng       // existance of all of them.
88491f5b262STobias Grosser       if (SM.count(Operand))
8853b11a16aSHongbin Zheng         break;
8863b11a16aSHongbin Zheng 
88791f5b262STobias Grosser       SM[Operand] =
88891f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
8893b11a16aSHongbin Zheng     }
8903b11a16aSHongbin Zheng   }
8913b11a16aSHongbin Zheng 
8923b11a16aSHongbin Zheng   return HasVectorOperand;
8933b11a16aSHongbin Zheng }
8943b11a16aSHongbin Zheng 
8952d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
8962d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
8972d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
8983b11a16aSHongbin Zheng   bool HasVectorOperand;
8993b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
9003b11a16aSHongbin Zheng 
9013b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
9023b11a16aSHongbin Zheng 
9033b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
904be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
905bc132607STobias Grosser                                     VLTS[VectorLane], NewAccesses);
9063b11a16aSHongbin Zheng 
9073b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
9083b11a16aSHongbin Zheng     return;
9093b11a16aSHongbin Zheng 
9103b11a16aSHongbin Zheng   // Make the result available as vector value.
9113b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
9123b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
9133b11a16aSHongbin Zheng 
9143b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
9153b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
9163b11a16aSHongbin Zheng                                          Builder.getInt32(i));
9173b11a16aSHongbin Zheng 
9183b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
9193b11a16aSHongbin Zheng }
9203b11a16aSHongbin Zheng 
921bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
9223b11a16aSHongbin Zheng 
9232d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
9242d1ed0bfSTobias Grosser     ScopStmt &Stmt, const Instruction *Inst, ValueMapT &VectorMap,
9252d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
9263b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
9273b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
9283b11a16aSHongbin Zheng   if (Inst->isTerminator())
9293b11a16aSHongbin Zheng     return;
9303b11a16aSHongbin Zheng 
9311ef52333SJohannes Doerfert   if (canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion()))
932e71c6ab5STobias Grosser     return;
933e71c6ab5STobias Grosser 
9343b11a16aSHongbin Zheng   if (const LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
9352d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
9363b11a16aSHongbin Zheng     return;
9373b11a16aSHongbin Zheng   }
9383b11a16aSHongbin Zheng 
9393b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
9403b11a16aSHongbin Zheng     if (const StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
9412d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
9423b11a16aSHongbin Zheng       return;
9433b11a16aSHongbin Zheng     }
9443b11a16aSHongbin Zheng 
9453b11a16aSHongbin Zheng     if (const UnaryInstruction *Unary = dyn_cast<UnaryInstruction>(Inst)) {
946be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9473b11a16aSHongbin Zheng       return;
9483b11a16aSHongbin Zheng     }
9493b11a16aSHongbin Zheng 
9503b11a16aSHongbin Zheng     if (const BinaryOperator *Binary = dyn_cast<BinaryOperator>(Inst)) {
951be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
9523b11a16aSHongbin Zheng       return;
9533b11a16aSHongbin Zheng     }
9543b11a16aSHongbin Zheng 
9553b11a16aSHongbin Zheng     // Falltrough: We generate scalar instructions, if we don't know how to
9563b11a16aSHongbin Zheng     // generate vector code.
9573b11a16aSHongbin Zheng   }
9583b11a16aSHongbin Zheng 
9592d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
9603b11a16aSHongbin Zheng }
9613b11a16aSHongbin Zheng 
9622d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
9632d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
964275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
965275a1756SJohannes Doerfert                                "the vector block generator");
966275a1756SJohannes Doerfert 
967be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
968c14582f2STobias Grosser   BasicBlock *CopyBB =
969b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
9703b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
9713b11a16aSHongbin Zheng   Builder.SetInsertPoint(CopyBB->begin());
9723b11a16aSHongbin Zheng 
9733b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
9743b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
9753b11a16aSHongbin Zheng   // are basic block local.
9763b11a16aSHongbin Zheng   //
9773b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
9783b11a16aSHongbin Zheng   // and one for vector values.
9793b11a16aSHongbin Zheng   //
9803b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
9813b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
9823b11a16aSHongbin Zheng   //
9833b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
9843b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
9853b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
9863b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
9873b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
9883b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
9893b11a16aSHongbin Zheng 
99091f5b262STobias Grosser   for (Instruction &Inst : *BB)
9912d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
9923b11a16aSHongbin Zheng }
993275a1756SJohannes Doerfert 
994ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
995ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
996514f6efaSJohannes Doerfert 
997514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
998514f6efaSJohannes Doerfert   BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
999514f6efaSJohannes Doerfert 
1000514f6efaSJohannes Doerfert   if (BBCopyIDom)
1001514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1002514f6efaSJohannes Doerfert 
1003514f6efaSJohannes Doerfert   return BBCopyIDom;
1004514f6efaSJohannes Doerfert }
1005514f6efaSJohannes Doerfert 
1006bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
10072d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
1008275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
1009d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
1010275a1756SJohannes Doerfert 
1011ecff11dcSJohannes Doerfert   // Forget all old mappings.
1012ecff11dcSJohannes Doerfert   BlockMap.clear();
1013ecff11dcSJohannes Doerfert   RegionMaps.clear();
1014ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
1015ecff11dcSJohannes Doerfert 
1016275a1756SJohannes Doerfert   // The region represented by the statement.
1017275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1018275a1756SJohannes Doerfert 
1019ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1020ecff11dcSJohannes Doerfert   // inputs.
1021ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1022ecff11dcSJohannes Doerfert   BasicBlock *EntryBBCopy =
1023ecff11dcSJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1024ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1025ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(EntryBBCopy->begin());
1026514f6efaSJohannes Doerfert 
1027ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1028ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
1029ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
1030275a1756SJohannes Doerfert 
1031275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1032275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
1033275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
1034ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1035ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1036275a1756SJohannes Doerfert 
1037275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1038275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1039275a1756SJohannes Doerfert     Blocks.pop_front();
1040275a1756SJohannes Doerfert 
1041514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1042514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1043ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1044ecff11dcSJohannes Doerfert 
1045ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1046ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1047514f6efaSJohannes Doerfert 
1048514f6efaSJohannes Doerfert     // Get the mapping for this block and initialize it with the mapping
1049514f6efaSJohannes Doerfert     // available at its immediate dominator (in the new region).
1050514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1051514f6efaSJohannes Doerfert     RegionMap = RegionMaps[BBCopyIDom];
1052514f6efaSJohannes Doerfert 
1053275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1054bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1055275a1756SJohannes Doerfert 
1056ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1057ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1058ecff11dcSJohannes Doerfert 
1059ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1060ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1061bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1062ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1063ecff11dcSJohannes Doerfert 
1064275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1065275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1066275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1067275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1068275a1756SJohannes Doerfert   }
1069275a1756SJohannes Doerfert 
1070275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1071514f6efaSJohannes Doerfert   BasicBlock *ExitBBCopy =
1072275a1756SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1073ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1074514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1075514f6efaSJohannes Doerfert 
1076ecff11dcSJohannes Doerfert   repairDominance(R->getExit(), ExitBBCopy);
1077275a1756SJohannes Doerfert 
1078275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1079275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1080275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1081275a1756SJohannes Doerfert 
1082514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1083e114dc02SJohannes Doerfert     TerminatorInst *TI = BB->getTerminator();
1084e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1085e114dc02SJohannes Doerfert       while (!BBCopy->empty())
1086e114dc02SJohannes Doerfert         BBCopy->begin()->eraseFromParent();
1087e114dc02SJohannes Doerfert       new UnreachableInst(BBCopy->getContext(), BBCopy);
1088e114dc02SJohannes Doerfert       continue;
1089e114dc02SJohannes Doerfert     }
1090e114dc02SJohannes Doerfert 
1091275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1092275a1756SJohannes Doerfert 
1093514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1094514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1095514f6efaSJohannes Doerfert 
109645e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
10979a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1098275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1099275a1756SJohannes Doerfert   }
1100275a1756SJohannes Doerfert 
1101ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1102ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1103ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1104ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1105ecff11dcSJohannes Doerfert     if (L == nullptr || L->getHeader() != BB)
1106ecff11dcSJohannes Doerfert       continue;
1107ecff11dcSJohannes Doerfert 
1108ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1109ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1110ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1111ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1112ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1113ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1114ecff11dcSJohannes Doerfert     LoopPHI->insertBefore(BBCopy->begin());
1115ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1116ecff11dcSJohannes Doerfert 
1117ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1118ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1119ecff11dcSJohannes Doerfert         continue;
1120ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1121ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1122ecff11dcSJohannes Doerfert       else
1123ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1124ecff11dcSJohannes Doerfert     }
1125ecff11dcSJohannes Doerfert 
1126ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1127ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1128ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1129ecff11dcSJohannes Doerfert 
1130ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1131ecff11dcSJohannes Doerfert   }
1132ecff11dcSJohannes Doerfert 
1133275a1756SJohannes Doerfert   // Reset the old insert point for the build.
1134514f6efaSJohannes Doerfert   Builder.SetInsertPoint(ExitBBCopy->begin());
1135275a1756SJohannes Doerfert }
1136ecff11dcSJohannes Doerfert 
1137ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarLoads(ScopStmt &Stmt,
1138ecff11dcSJohannes Doerfert                                           const Instruction *Inst,
1139bc132607STobias Grosser                                           ValueMapT &BBMap) {
1140ecff11dcSJohannes Doerfert 
1141ecff11dcSJohannes Doerfert   // Inside a non-affine region PHI nodes are copied not demoted. Once the
1142ecff11dcSJohannes Doerfert   // phi is copied it will reload all inputs from outside the region, hence
1143ecff11dcSJohannes Doerfert   // we do not need to generate code for the read access of the operands of a
1144ecff11dcSJohannes Doerfert   // PHI.
1145ecff11dcSJohannes Doerfert   if (isa<PHINode>(Inst))
1146ecff11dcSJohannes Doerfert     return;
1147ecff11dcSJohannes Doerfert 
1148bc132607STobias Grosser   return BlockGenerator::generateScalarLoads(Stmt, Inst, BBMap);
1149ecff11dcSJohannes Doerfert }
1150ecff11dcSJohannes Doerfert 
1151ecff11dcSJohannes Doerfert void RegionGenerator::generateScalarStores(ScopStmt &Stmt, BasicBlock *BB,
1152aff56c8aSTobias Grosser                                            LoopToScevMapT &LTS,
1153bc132607STobias Grosser                                            ValueMapT &BBMap) {
1154ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
1155ecff11dcSJohannes Doerfert 
115675296901STobias Grosser   assert(Stmt.getRegion() &&
115775296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1158ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1159ecff11dcSJohannes Doerfert 
1160ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
1161ecff11dcSJohannes Doerfert 
11628d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
1163ecff11dcSJohannes Doerfert       continue;
1164ecff11dcSJohannes Doerfert 
1165ecff11dcSJohannes Doerfert     Instruction *ScalarInst = MA->getAccessInstruction();
1166ecff11dcSJohannes Doerfert 
116762139132STobias Grosser     // Only generate accesses that belong to this basic block.
116862139132STobias Grosser     if (ScalarInst->getParent() != BB)
116962139132STobias Grosser       continue;
117062139132STobias Grosser 
1171d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
1172ecff11dcSJohannes Doerfert 
1173bc132607STobias Grosser     auto Address = getOrCreateAlloca(*MA);
1174ecff11dcSJohannes Doerfert 
1175aff56c8aSTobias Grosser     Val = getNewScalarValue(Val, R, Stmt, LTS, BBMap);
1176f8d55f7eSTobias Grosser     Builder.CreateStore(Val, Address);
1177ecff11dcSJohannes Doerfert   }
1178ecff11dcSJohannes Doerfert }
1179ecff11dcSJohannes Doerfert 
1180ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1181ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1182ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1183ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1184ecff11dcSJohannes Doerfert 
1185ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1186ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1187ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1188ecff11dcSJohannes Doerfert   if (!BBCopy) {
1189ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1190ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1191ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1192ecff11dcSJohannes Doerfert     return;
1193ecff11dcSJohannes Doerfert   }
1194ecff11dcSJohannes Doerfert 
1195ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1196ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1197ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1198ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1199ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1200ecff11dcSJohannes Doerfert 
1201ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1202bc132607STobias Grosser     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForInst(PHI));
1203ecff11dcSJohannes Doerfert   } else {
1204ecff11dcSJohannes Doerfert 
1205ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1206ecff11dcSJohannes Doerfert       return;
1207ecff11dcSJohannes Doerfert 
1208bc132607STobias Grosser     Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
1209ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1210ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1211ecff11dcSJohannes Doerfert   }
1212ecff11dcSJohannes Doerfert 
1213ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1214ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1215ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1216ecff11dcSJohannes Doerfert }
1217ecff11dcSJohannes Doerfert 
1218ecff11dcSJohannes Doerfert Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, const PHINode *PHI,
1219ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1220ecff11dcSJohannes Doerfert                                            LoopToScevMapT &LTS) {
1221ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1222ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1223ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1224ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1225ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1226ecff11dcSJohannes Doerfert 
1227ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1228bc132607STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
1229ecff11dcSJohannes Doerfert   return PHICopy;
1230ecff11dcSJohannes Doerfert }
1231