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 
51b4f08eb6SJohannes Doerfert BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
52b4f08eb6SJohannes Doerfert                                ScalarEvolution &SE, DominatorTree &DT,
53ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &ScalarMap,
54ecff11dcSJohannes Doerfert                                ScalarAllocaMapTy &PHIOpMap,
55ecff11dcSJohannes Doerfert                                EscapeUsersAllocaMapTy &EscapeMap,
56f4bb7a6aSTobias Grosser                                ValueMapT &GlobalMap,
57b4f08eb6SJohannes Doerfert                                IslExprBuilder *ExprBuilder)
58ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
59ecff11dcSJohannes Doerfert       EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
60bc132607STobias Grosser       EscapeMap(EscapeMap), GlobalMap(GlobalMap) {}
61e71c6ab5STobias Grosser 
622f1acac6STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
6333cb9f94STobias Grosser                                              ValueMapT &BBMap,
6433cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
65bc132607STobias Grosser                                              Loop *L) const {
66683b8e44STobias Grosser   if (SE.isSCEVable(Old->getType()))
67369430ffSTobias Grosser     if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
68e71c6ab5STobias Grosser       if (!isa<SCEVCouldNotCompute>(Scev)) {
69637b23dcSSebastian Pop         const SCEV *NewScev = apply(Scev, LTS, SE);
7009e3697fSJohannes Doerfert         ValueMapT VTV;
71637b23dcSSebastian Pop         VTV.insert(BBMap.begin(), BBMap.end());
72637b23dcSSebastian Pop         VTV.insert(GlobalMap.begin(), GlobalMap.end());
73e69e1141SJohannes Doerfert 
74e69e1141SJohannes Doerfert         Scop &S = *Stmt.getParent();
75e69e1141SJohannes Doerfert         const DataLayout &DL =
76e69e1141SJohannes Doerfert             S.getRegion().getEntry()->getParent()->getParent()->getDataLayout();
77e69e1141SJohannes Doerfert         auto IP = Builder.GetInsertPoint();
78e69e1141SJohannes Doerfert 
79e69e1141SJohannes Doerfert         assert(IP != Builder.GetInsertBlock()->end() &&
8045e7944bSTobias Grosser                "Only instructions can be insert points for SCEVExpander");
81c0729a32SJohannes Doerfert         Value *Expanded = expandCodeFor(S, SE, DL, "polly", NewScev,
82c0729a32SJohannes Doerfert                                         Old->getType(), IP, &VTV);
83e71c6ab5STobias Grosser 
84e71c6ab5STobias Grosser         BBMap[Old] = Expanded;
85e71c6ab5STobias Grosser         return Expanded;
86e71c6ab5STobias Grosser       }
87369430ffSTobias Grosser     }
88e71c6ab5STobias Grosser 
8933cb9f94STobias Grosser   return nullptr;
9033cb9f94STobias Grosser }
9133cb9f94STobias Grosser 
922f1acac6STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
932f1acac6STobias Grosser                                    LoopToScevMapT &LTS, Loop *L) const {
9433cb9f94STobias Grosser   // We assume constants never change.
9533cb9f94STobias Grosser   // This avoids map lookups for many calls to this function.
9633cb9f94STobias Grosser   if (isa<Constant>(Old))
9733cb9f94STobias Grosser     return const_cast<Value *>(Old);
9833cb9f94STobias Grosser 
9933cb9f94STobias Grosser   if (Value *New = GlobalMap.lookup(Old)) {
10033cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
10133cb9f94STobias Grosser       New = NewRemapped;
10233cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
10333cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
10433cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
10533cb9f94STobias Grosser 
10633cb9f94STobias Grosser     return New;
10733cb9f94STobias Grosser   }
10833cb9f94STobias Grosser 
10933cb9f94STobias Grosser   if (Value *New = BBMap.lookup(Old))
11033cb9f94STobias Grosser     return New;
11133cb9f94STobias Grosser 
11233cb9f94STobias Grosser   if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
11333cb9f94STobias Grosser     return New;
11433cb9f94STobias Grosser 
11516371acdSTobias Grosser   // A scop-constant value defined by a global or a function parameter.
11616371acdSTobias Grosser   if (isa<GlobalValue>(Old) || isa<Argument>(Old))
11716371acdSTobias Grosser     return const_cast<Value *>(Old);
11816371acdSTobias Grosser 
11916371acdSTobias Grosser   // A scop-constant value defined by an instruction executed outside the scop.
12016371acdSTobias Grosser   if (const Instruction *Inst = dyn_cast<Instruction>(Old))
121be9c9117SJohannes Doerfert     if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
12216371acdSTobias Grosser       return const_cast<Value *>(Old);
12316371acdSTobias Grosser 
12416371acdSTobias Grosser   // The scalar dependence is neither available nor SCEVCodegenable.
1255b463ceaSHongbin Zheng   llvm_unreachable("Unexpected scalar dependence in region!");
1265a56cbf4STobias Grosser   return nullptr;
1273b11a16aSHongbin Zheng }
1283b11a16aSHongbin Zheng 
1292f1acac6STobias Grosser void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
130bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
131030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
132030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
133030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
134030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
135030237d0STobias Grosser     return;
136030237d0STobias Grosser 
1373b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
1383b11a16aSHongbin Zheng 
1393b11a16aSHongbin Zheng   // Replace old operands with the new ones.
14091f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
141bc132607STobias Grosser     Value *NewOperand =
142bc132607STobias Grosser         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForInst(Inst));
1433b11a16aSHongbin Zheng 
1443b11a16aSHongbin Zheng     if (!NewOperand) {
145c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
146c14582f2STobias Grosser              "Store instructions are always needed!");
1473b11a16aSHongbin Zheng       delete NewInst;
1483b11a16aSHongbin Zheng       return;
1493b11a16aSHongbin Zheng     }
1503b11a16aSHongbin Zheng 
1513b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
1523b11a16aSHongbin Zheng   }
1533b11a16aSHongbin Zheng 
1543b11a16aSHongbin Zheng   Builder.Insert(NewInst);
1553b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
1563b11a16aSHongbin Zheng 
1573b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
1583b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
1593b11a16aSHongbin Zheng }
1603b11a16aSHongbin Zheng 
161be9c9117SJohannes Doerfert Value *BlockGenerator::generateLocationAccessed(
1622f1acac6STobias Grosser     ScopStmt &Stmt, const Instruction *Inst, Value *Pointer, ValueMapT &BBMap,
1632f1acac6STobias Grosser     LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses) {
164be9c9117SJohannes Doerfert   const MemoryAccess &MA = Stmt.getAccessFor(Inst);
1653b11a16aSHongbin Zheng 
1662d1ed0bfSTobias Grosser   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
1673b11a16aSHongbin Zheng 
1682d1ed0bfSTobias Grosser   if (AccessExpr) {
1692d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
17098b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
17198b3ee50STobias Grosser 
17298b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
17398b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
17498b3ee50STobias Grosser     // the newly generated pointer.
17598b3ee50STobias Grosser     auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
17698b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
17798b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
17898b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
17998b3ee50STobias Grosser 
18098b3ee50STobias Grosser     if (OldPtrTy != NewPtrTy) {
18198b3ee50STobias Grosser       assert(OldPtrTy->getPointerElementType()->getPrimitiveSizeInBits() ==
18298b3ee50STobias Grosser                  NewPtrTy->getPointerElementType()->getPrimitiveSizeInBits() &&
18398b3ee50STobias Grosser              "Pointer types to elements with different size found");
18498b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
18598b3ee50STobias Grosser     }
18698b3ee50STobias Grosser     return Address;
1872d1ed0bfSTobias Grosser   }
1882d1ed0bfSTobias Grosser 
189bc132607STobias Grosser   return getNewValue(Stmt, Pointer, BBMap, LTS, getLoopForInst(Inst));
1903b11a16aSHongbin Zheng }
1913b11a16aSHongbin Zheng 
1924d96c8d7STobias Grosser Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
1932ef3f4fdSJohannes Doerfert   return LI.getLoopFor(Inst->getParent());
194369430ffSTobias Grosser }
195369430ffSTobias Grosser 
1962f1acac6STobias Grosser Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, LoadInst *Load,
197bc132607STobias Grosser                                           ValueMapT &BBMap, LoopToScevMapT &LTS,
1982d1ed0bfSTobias Grosser                                           isl_id_to_ast_expr *NewAccesses) {
199c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
200c1db67e2SJohannes Doerfert     return PreloadLoad;
201c1db67e2SJohannes Doerfert 
2029646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
203bc132607STobias Grosser   Value *NewPointer =
204bc132607STobias Grosser       generateLocationAccessed(Stmt, Load, Pointer, BBMap, LTS, NewAccesses);
20587901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
20687901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
20786bc93a9STobias Grosser 
20886bc93a9STobias Grosser   if (DebugPrinting)
20986bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
21086bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
21186bc93a9STobias Grosser 
2123b11a16aSHongbin Zheng   return ScalarLoad;
2133b11a16aSHongbin Zheng }
2143b11a16aSHongbin Zheng 
2152f1acac6STobias Grosser void BlockGenerator::generateScalarStore(ScopStmt &Stmt, StoreInst *Store,
216bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
2172d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
2189646e3feSTobias Grosser   auto *Pointer = Store->getPointerOperand();
219bc132607STobias Grosser   Value *NewPointer =
220bc132607STobias Grosser       generateLocationAccessed(Stmt, Store, Pointer, BBMap, LTS, NewAccesses);
221bc132607STobias Grosser   Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
222bc132607STobias Grosser                                     getLoopForInst(Store));
2233b11a16aSHongbin Zheng 
22486bc93a9STobias Grosser   if (DebugPrinting)
22586bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
22686bc93a9STobias Grosser                                           ": ", ValueOperand, "\n");
22786bc93a9STobias Grosser 
228c186ac7aSTobias Grosser   Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
2293b11a16aSHongbin Zheng }
2303b11a16aSHongbin Zheng 
2312f1acac6STobias Grosser void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
232bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
2332d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
2343b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
2353b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
2363b11a16aSHongbin Zheng   if (Inst->isTerminator())
2373b11a16aSHongbin Zheng     return;
2383b11a16aSHongbin Zheng 
239ecff11dcSJohannes Doerfert   Loop *L = getLoopForInst(Inst);
240ecff11dcSJohannes Doerfert   if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
241ecff11dcSJohannes Doerfert       canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
242aff56c8aSTobias Grosser     // Synthesizable statements will be generated on-demand.
243e71c6ab5STobias Grosser     return;
244ecff11dcSJohannes Doerfert   }
245e71c6ab5STobias Grosser 
2469646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
247bc132607STobias Grosser     Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
2483d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
2493d94fedfSSebastian Pop     // deterministic.
250753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
2513b11a16aSHongbin Zheng     return;
2523b11a16aSHongbin Zheng   }
2533b11a16aSHongbin Zheng 
2549646e3feSTobias Grosser   if (auto *Store = dyn_cast<StoreInst>(Inst)) {
255bc132607STobias Grosser     generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
2563b11a16aSHongbin Zheng     return;
2573b11a16aSHongbin Zheng   }
2583b11a16aSHongbin Zheng 
2599646e3feSTobias Grosser   if (auto *PHI = dyn_cast<PHINode>(Inst)) {
260bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
261ecff11dcSJohannes Doerfert     return;
262ecff11dcSJohannes Doerfert   }
263ecff11dcSJohannes Doerfert 
2643f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
2653f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
2669c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
2673f500fa2SJohannes Doerfert     return;
2683f500fa2SJohannes Doerfert 
269bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
2703b11a16aSHongbin Zheng }
2713b11a16aSHongbin Zheng 
272bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
2732d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
274275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
275275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
276275a1756SJohannes Doerfert 
277275a1756SJohannes Doerfert   ValueMapT BBMap;
278275a1756SJohannes Doerfert 
279be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
280bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
281275a1756SJohannes Doerfert }
282275a1756SJohannes Doerfert 
283514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
284c14582f2STobias Grosser   BasicBlock *CopyBB =
285b4f08eb6SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
2863b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
287514f6efaSJohannes Doerfert   return CopyBB;
288514f6efaSJohannes Doerfert }
2893b11a16aSHongbin Zheng 
290514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
291bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
2922d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
293514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
294225f0d1eSMichael Kruse   Builder.SetInsertPoint(CopyBB->begin());
295225f0d1eSMichael Kruse   generateScalarLoads(Stmt, BBMap);
296225f0d1eSMichael Kruse 
297bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
298225f0d1eSMichael Kruse 
299225f0d1eSMichael Kruse   // After a basic block was copied store all scalars that escape this block in
300225f0d1eSMichael Kruse   // their alloca.
301225f0d1eSMichael Kruse   generateScalarStores(Stmt, LTS, BBMap);
302514f6efaSJohannes Doerfert   return CopyBB;
303514f6efaSJohannes Doerfert }
304514f6efaSJohannes Doerfert 
305514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
306bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
3072d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
308ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
309ecff11dcSJohannes Doerfert 
31091f5b262STobias Grosser   for (Instruction &Inst : *BB)
311bc132607STobias Grosser     copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
312ecff11dcSJohannes Doerfert }
313ecff11dcSJohannes Doerfert 
31464c0ff41STobias Grosser Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
315ecff11dcSJohannes Doerfert                                          ScalarAllocaMapTy &Map,
3162985400aSTobias Grosser                                          const char *NameExt) {
317ecff11dcSJohannes Doerfert   // If no alloca was found create one and insert it in the entry block.
318e9cb5a09STobias Grosser   if (!Map.count(ScalarBase)) {
319ecff11dcSJohannes Doerfert     auto *Ty = ScalarBase->getType();
320b09455deSTobias Grosser     auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
32164c0ff41STobias Grosser     EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
322b09455deSTobias Grosser     NewAddr->insertBefore(EntryBB->getFirstInsertionPt());
323e9cb5a09STobias Grosser     Map[ScalarBase] = NewAddr;
324ecff11dcSJohannes Doerfert   }
325ecff11dcSJohannes Doerfert 
326e9cb5a09STobias Grosser   auto Addr = Map[ScalarBase];
327e9cb5a09STobias Grosser 
328bc132607STobias Grosser   if (GlobalMap.count(Addr))
329bc132607STobias Grosser     return GlobalMap[Addr];
33064c0ff41STobias Grosser 
331ecff11dcSJohannes Doerfert   return Addr;
332ecff11dcSJohannes Doerfert }
333ecff11dcSJohannes Doerfert 
334bc132607STobias Grosser Value *BlockGenerator::getOrCreateAlloca(MemoryAccess &Access) {
335b8d27aabSTobias Grosser   if (Access.isPHI())
336b8d27aabSTobias Grosser     return getOrCreatePHIAlloca(Access.getBaseAddr());
337b8d27aabSTobias Grosser   else
338b8d27aabSTobias Grosser     return getOrCreateScalarAlloca(Access.getBaseAddr());
339a4f0988dSTobias Grosser }
340a4f0988dSTobias Grosser 
341a4f0988dSTobias Grosser Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
342a4f0988dSTobias Grosser   if (Array->isPHI())
343a4f0988dSTobias Grosser     return getOrCreatePHIAlloca(Array->getBasePtr());
344f8d55f7eSTobias Grosser   else
345a4f0988dSTobias Grosser     return getOrCreateScalarAlloca(Array->getBasePtr());
346f8d55f7eSTobias Grosser }
347f8d55f7eSTobias Grosser 
348bc132607STobias Grosser Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
349bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
350b79a67dfSTobias Grosser }
351b79a67dfSTobias Grosser 
352bc132607STobias Grosser Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
353bc132607STobias Grosser   return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
354b79a67dfSTobias Grosser }
355b79a67dfSTobias Grosser 
356bc132607STobias Grosser void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
35726e59ee7STobias Grosser                                         Value *Address) {
3582985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
3592985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
3602985400aSTobias Grosser   // copied multiple times we already did this and can exit.
361acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
362acb6ade7SMichael Kruse     return;
363e69e1141SJohannes Doerfert 
364ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
365ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
366ecff11dcSJohannes Doerfert 
367ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
368ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
369ecff11dcSJohannes Doerfert     if (!UI)
370ecff11dcSJohannes Doerfert       continue;
371ecff11dcSJohannes Doerfert 
372ddb83d0fSJohannes Doerfert     if (R.contains(UI))
373ecff11dcSJohannes Doerfert       continue;
374ecff11dcSJohannes Doerfert 
375ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
376ecff11dcSJohannes Doerfert   }
377ecff11dcSJohannes Doerfert 
378ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
379ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
380ecff11dcSJohannes Doerfert     return;
381ecff11dcSJohannes Doerfert 
382ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
383b09455deSTobias Grosser   auto *ScalarAddr = Address ? Address : getOrCreateScalarAlloca(Inst);
384ecff11dcSJohannes Doerfert 
385ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
386ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
387ecff11dcSJohannes Doerfert }
388ecff11dcSJohannes Doerfert 
389225f0d1eSMichael Kruse void BlockGenerator::generateScalarLoads(ScopStmt &Stmt, ValueMapT &BBMap) {
390225f0d1eSMichael Kruse   for (MemoryAccess *MA : Stmt) {
391225f0d1eSMichael Kruse     if (MA->isExplicit() || MA->isWrite())
392ecff11dcSJohannes Doerfert       continue;
393ecff11dcSJohannes Doerfert 
394e2bccbbfSMichael Kruse     auto *Address = getOrCreateAlloca(*MA);
395e2bccbbfSMichael Kruse     BBMap[MA->getBaseAddr()] =
3962fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
397ecff11dcSJohannes Doerfert   }
398ecff11dcSJohannes Doerfert }
399ecff11dcSJohannes Doerfert 
400ecff11dcSJohannes Doerfert Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
401aff56c8aSTobias Grosser                                          ScopStmt &Stmt, LoopToScevMapT &LTS,
402bc132607STobias Grosser                                          ValueMapT &BBMap) {
403ecff11dcSJohannes Doerfert   // If the value we want to store is an instruction we might have demoted it
404ecff11dcSJohannes Doerfert   // in order to make it accessible here. In such a case a reload is
405ecff11dcSJohannes Doerfert   // necessary. If it is no instruction it will always be a value that
406ecff11dcSJohannes Doerfert   // dominates the current point and we can just use it. In total there are 4
407ecff11dcSJohannes Doerfert   // options:
408ecff11dcSJohannes Doerfert   //  (1) The value is no instruction ==> use the value.
409ecff11dcSJohannes Doerfert   //  (2) The value is an instruction that was split out of the region prior to
410ecff11dcSJohannes Doerfert   //      code generation  ==> use the instruction as it dominates the region.
411ecff11dcSJohannes Doerfert   //  (3) The value is an instruction:
412ecff11dcSJohannes Doerfert   //      (a) The value was defined in the current block, thus a copy is in
413ecff11dcSJohannes Doerfert   //          the BBMap ==> use the mapped value.
414ecff11dcSJohannes Doerfert   //      (b) The value was defined in a previous block, thus we demoted it
415ecff11dcSJohannes Doerfert   //          earlier ==> use the reloaded value.
416ecff11dcSJohannes Doerfert   Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
417ecff11dcSJohannes Doerfert   if (!ScalarValueInst)
418ecff11dcSJohannes Doerfert     return ScalarValue;
419ecff11dcSJohannes Doerfert 
420ecff11dcSJohannes Doerfert   if (!R.contains(ScalarValueInst)) {
421ecff11dcSJohannes Doerfert     if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
422ecff11dcSJohannes Doerfert       return /* Case (3a) */ ScalarValueCopy;
423ecff11dcSJohannes Doerfert     else
424ecff11dcSJohannes Doerfert       return /* Case 2 */ ScalarValue;
425ecff11dcSJohannes Doerfert   }
426ecff11dcSJohannes Doerfert 
427ecff11dcSJohannes Doerfert   if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
428ecff11dcSJohannes Doerfert     return /* Case (3a) */ ScalarValueCopy;
429ecff11dcSJohannes Doerfert 
430aff56c8aSTobias Grosser   if ((Stmt.isBlockStmt() &&
431aff56c8aSTobias Grosser        Stmt.getBasicBlock() == ScalarValueInst->getParent()) ||
432aff56c8aSTobias Grosser       (Stmt.isRegionStmt() && Stmt.getRegion()->contains(ScalarValueInst))) {
433aff56c8aSTobias Grosser     auto SynthesizedValue = trySynthesizeNewValue(
434aff56c8aSTobias Grosser         Stmt, ScalarValueInst, BBMap, LTS, getLoopForInst(ScalarValueInst));
435aff56c8aSTobias Grosser 
436aff56c8aSTobias Grosser     if (SynthesizedValue)
437aff56c8aSTobias Grosser       return SynthesizedValue;
438aff56c8aSTobias Grosser   }
439aff56c8aSTobias Grosser 
440ecff11dcSJohannes Doerfert   // Case (3b)
441bc132607STobias Grosser   Value *Address = getOrCreateScalarAlloca(ScalarValueInst);
442b649e26aSTobias Grosser   ScalarValue = Builder.CreateLoad(Address, Address->getName() + ".reload");
443ecff11dcSJohannes Doerfert 
444ecff11dcSJohannes Doerfert   return ScalarValue;
445ecff11dcSJohannes Doerfert }
446ecff11dcSJohannes Doerfert 
447225f0d1eSMichael Kruse void BlockGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
448bc132607STobias Grosser                                           ValueMapT &BBMap) {
449ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
450ecff11dcSJohannes Doerfert 
451225f0d1eSMichael Kruse   assert(Stmt.isBlockStmt() && "Region statements need to use the "
452225f0d1eSMichael Kruse                                "generateScalarStores() function in the "
453225f0d1eSMichael Kruse                                "RegionGenerator");
454ecff11dcSJohannes Doerfert 
455ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
4568d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
457ecff11dcSJohannes Doerfert       continue;
458ecff11dcSJohannes Doerfert 
459d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
460bc132607STobias Grosser     auto *Address = getOrCreateAlloca(*MA);
461d86f2157SJohannes Doerfert 
462aff56c8aSTobias Grosser     Val = getNewScalarValue(Val, R, Stmt, LTS, BBMap);
46392245228STobias Grosser     Builder.CreateStore(Val, Address);
464ecff11dcSJohannes Doerfert   }
465ecff11dcSJohannes Doerfert }
466ecff11dcSJohannes Doerfert 
467c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
468c0091a77STobias Grosser   Region &R = S.getRegion();
469ecff11dcSJohannes Doerfert   // The split block __just before__ the region and optimized region.
470ecff11dcSJohannes Doerfert   BasicBlock *SplitBB = R.getEnteringBlock();
471ecff11dcSJohannes Doerfert   BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
472ecff11dcSJohannes Doerfert   assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
473ecff11dcSJohannes Doerfert 
474ecff11dcSJohannes Doerfert   // Get the start block of the __optimized__ region.
475ecff11dcSJohannes Doerfert   BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
476ecff11dcSJohannes Doerfert   if (StartBB == R.getEntry())
477ecff11dcSJohannes Doerfert     StartBB = SplitBBTerm->getSuccessor(1);
478ecff11dcSJohannes Doerfert 
479fb19dd69SJohannes Doerfert   Builder.SetInsertPoint(StartBB->getTerminator());
480ecff11dcSJohannes Doerfert 
481c0091a77STobias Grosser   for (auto &Pair : S.arrays()) {
482c0091a77STobias Grosser     auto &Array = Pair.second;
483c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
484c0091a77STobias Grosser       continue;
485c0091a77STobias Grosser     if (Array->isPHI()) {
486c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
487c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
488c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
489c0091a77STobias Grosser       // 'SplitBB'.
490c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
491ecff11dcSJohannes Doerfert 
492c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
493c0091a77STobias Grosser         if (!R.contains(*BI) && *BI != SplitBB)
494c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
495c0091a77STobias Grosser                            "come from SplitBB");
496c0091a77STobias Grosser 
497c0091a77STobias Grosser       int Idx = PHI->getBasicBlockIndex(SplitBB);
498c0091a77STobias Grosser       if (Idx < 0)
499ecff11dcSJohannes Doerfert         continue;
500ecff11dcSJohannes Doerfert 
501c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
502ecff11dcSJohannes Doerfert 
503bc132607STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
504c0091a77STobias Grosser       continue;
505c0091a77STobias Grosser     }
506c0091a77STobias Grosser 
507c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
508c0091a77STobias Grosser 
509c0091a77STobias Grosser     if (Inst && R.contains(Inst))
510c0091a77STobias Grosser       continue;
511c0091a77STobias Grosser 
512717b8667SJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are exit PHI
513717b8667SJohannes Doerfert     // nodes we model as common scalars but do not need to initialize.
514717b8667SJohannes Doerfert     if (Inst && isa<PHINode>(Inst))
515717b8667SJohannes Doerfert       continue;
516717b8667SJohannes Doerfert 
51764c0ff41STobias Grosser     ValueMapT EmptyMap;
518c0091a77STobias Grosser     Builder.CreateStore(Array->getBasePtr(),
519bc132607STobias Grosser                         getOrCreateScalarAlloca(Array->getBasePtr()));
520ecff11dcSJohannes Doerfert   }
521ecff11dcSJohannes Doerfert }
522ecff11dcSJohannes Doerfert 
523ecff11dcSJohannes Doerfert void BlockGenerator::createScalarFinalization(Region &R) {
524ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
525ecff11dcSJohannes Doerfert   BasicBlock *ExitBB = R.getExitingBlock();
526ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
527ecff11dcSJohannes Doerfert   BasicBlock *MergeBB = R.getExit();
528ecff11dcSJohannes Doerfert 
529ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
530ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
531ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
532ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
533ecff11dcSJohannes Doerfert 
534ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
535ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
536ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
537ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
538ecff11dcSJohannes Doerfert     Instruction *EscapeInst = EscapeMapping.getFirst();
539ecff11dcSJohannes Doerfert     const auto &EscapeMappingValue = EscapeMapping.getSecond();
540ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
54164c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
542ecff11dcSJohannes Doerfert 
543ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
544d8b6ad25SJohannes Doerfert     Value *EscapeInstReload =
545ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
546d8b6ad25SJohannes Doerfert     EscapeInstReload =
547d8b6ad25SJohannes Doerfert         Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
548ecff11dcSJohannes Doerfert 
549ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
550ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
551ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
552ecff11dcSJohannes Doerfert     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
553ecff11dcSJohannes Doerfert 
554ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
555ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
556ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
557ecff11dcSJohannes Doerfert 
558ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
559ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
560ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
561ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
562ecff11dcSJohannes Doerfert 
563ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
564ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
565ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
566ecff11dcSJohannes Doerfert   }
567ecff11dcSJohannes Doerfert }
568ecff11dcSJohannes Doerfert 
569ffa2446fSTobias Grosser void BlockGenerator::findOutsideUsers(Scop &S) {
570ffa2446fSTobias Grosser   auto &R = S.getRegion();
571ffa2446fSTobias Grosser   for (auto &Pair : S.arrays()) {
572ffa2446fSTobias Grosser     auto &Array = Pair.second;
573ffa2446fSTobias Grosser 
574ffa2446fSTobias Grosser     if (Array->getNumberOfDimensions() != 0)
575ffa2446fSTobias Grosser       continue;
576ffa2446fSTobias Grosser 
577ffa2446fSTobias Grosser     if (Array->isPHI())
578ffa2446fSTobias Grosser       continue;
579ffa2446fSTobias Grosser 
580ffa2446fSTobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
581ffa2446fSTobias Grosser 
582ffa2446fSTobias Grosser     if (!Inst)
583ffa2446fSTobias Grosser       continue;
584ffa2446fSTobias Grosser 
585ffa2446fSTobias Grosser     // Scop invariant hoisting moves some of the base pointers out of the scop.
586ffa2446fSTobias Grosser     // We can ignore these, as the invariant load hoisting already registers the
587ffa2446fSTobias Grosser     // relevant outside users.
588ffa2446fSTobias Grosser     if (!R.contains(Inst))
589ffa2446fSTobias Grosser       continue;
590ffa2446fSTobias Grosser 
591ffa2446fSTobias Grosser     handleOutsideUsers(R, Inst, nullptr);
592ffa2446fSTobias Grosser   }
593ffa2446fSTobias Grosser }
594ffa2446fSTobias Grosser 
59527d742daSTobias Grosser void BlockGenerator::createExitPHINodeMerges(Scop &S) {
59627d742daSTobias Grosser   if (S.hasSingleExitEdge())
59727d742daSTobias Grosser     return;
59827d742daSTobias Grosser 
59927d742daSTobias Grosser   Region &R = S.getRegion();
60027d742daSTobias Grosser 
60127d742daSTobias Grosser   auto *ExitBB = R.getExitingBlock();
60227d742daSTobias Grosser   auto *MergeBB = R.getExit();
60327d742daSTobias Grosser   auto *AfterMergeBB = MergeBB->getSingleSuccessor();
60427d742daSTobias Grosser   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
60527d742daSTobias Grosser   if (OptExitBB == ExitBB)
60627d742daSTobias Grosser     OptExitBB = *(++pred_begin(MergeBB));
60727d742daSTobias Grosser 
60827d742daSTobias Grosser   Builder.SetInsertPoint(OptExitBB->getTerminator());
60927d742daSTobias Grosser 
61027d742daSTobias Grosser   for (auto &Pair : S.arrays()) {
61127d742daSTobias Grosser     auto &SAI = Pair.second;
61227d742daSTobias Grosser     auto *Val = SAI->getBasePtr();
61327d742daSTobias Grosser 
61427d742daSTobias Grosser     PHINode *PHI = dyn_cast<PHINode>(Val);
61527d742daSTobias Grosser     if (!PHI)
61627d742daSTobias Grosser       continue;
61727d742daSTobias Grosser 
618*a3f6edaeSTobias Grosser     if (PHI->getParent() != AfterMergeBB)
61927d742daSTobias Grosser       continue;
62027d742daSTobias Grosser 
62127d742daSTobias Grosser     std::string Name = PHI->getName();
62227d742daSTobias Grosser     Value *ScalarAddr = getOrCreateScalarAlloca(PHI);
62327d742daSTobias Grosser     Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
62427d742daSTobias Grosser     Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
62527d742daSTobias Grosser     Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
62627d742daSTobias Grosser     auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
62727d742daSTobias Grosser     MergePHI->insertBefore(MergeBB->getFirstInsertionPt());
62827d742daSTobias Grosser     MergePHI->addIncoming(Reload, OptExitBB);
62927d742daSTobias Grosser     MergePHI->addIncoming(OriginalValue, ExitBB);
63027d742daSTobias Grosser     int Idx = PHI->getBasicBlockIndex(MergeBB);
63127d742daSTobias Grosser     PHI->setIncomingValue(Idx, MergePHI);
63227d742daSTobias Grosser   }
63327d742daSTobias Grosser }
63427d742daSTobias Grosser 
635ffa2446fSTobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
636ffa2446fSTobias Grosser   findOutsideUsers(S);
637c0091a77STobias Grosser   createScalarInitialization(S);
63827d742daSTobias Grosser   createExitPHINodeMerges(S);
639ecff11dcSJohannes Doerfert   createScalarFinalization(S.getRegion());
6403b11a16aSHongbin Zheng }
6413b11a16aSHongbin Zheng 
642be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
643be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
644be9c9117SJohannes Doerfert                                            isl_map *Schedule)
645bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
646a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
6473b11a16aSHongbin Zheng }
6483b11a16aSHongbin Zheng 
6492f1acac6STobias Grosser Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
650e602a076STobias Grosser                                             ValueMapT &VectorMap,
651e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
652e602a076STobias Grosser                                             Loop *L) {
653fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
654fe11e287SHongbin Zheng     return NewValue;
6553b11a16aSHongbin Zheng 
6563b11a16aSHongbin Zheng   int Width = getVectorWidth();
6573b11a16aSHongbin Zheng 
6583b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
6593b11a16aSHongbin Zheng 
6603b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
661c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
662bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
6637242ad92STobias Grosser         Builder.getInt32(Lane));
6643b11a16aSHongbin Zheng 
6653b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
6663b11a16aSHongbin Zheng 
6673b11a16aSHongbin Zheng   return Vector;
6683b11a16aSHongbin Zheng }
6693b11a16aSHongbin Zheng 
6703b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
6713b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
6723b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
6733b11a16aSHongbin Zheng 
6743b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
6753b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
6763b11a16aSHongbin Zheng 
6773b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
6783b11a16aSHongbin Zheng }
6793b11a16aSHongbin Zheng 
680be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
6812f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
6822d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
6830dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
6849646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
6850dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
6860dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
6870dd463faSTobias Grosser 
6885a56cbf4STobias Grosser   Value *NewPointer = nullptr;
689bc132607STobias Grosser   NewPointer = generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
690bc132607STobias Grosser                                         VLTS[Offset], NewAccesses);
691c14582f2STobias Grosser   Value *VectorPtr =
692c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
693c14582f2STobias Grosser   LoadInst *VecLoad =
694c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
6953b11a16aSHongbin Zheng   if (!Aligned)
6963b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
6973b11a16aSHongbin Zheng 
6980dd463faSTobias Grosser   if (NegativeStride) {
6990dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
7000dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
7010dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
7020dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
7030dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
7040dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
7050dd463faSTobias Grosser     return RevVecLoad;
7060dd463faSTobias Grosser   }
7070dd463faSTobias Grosser 
7083b11a16aSHongbin Zheng   return VecLoad;
7093b11a16aSHongbin Zheng }
7103b11a16aSHongbin Zheng 
7112d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
7122f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
7132d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7149646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
7153b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
716bc132607STobias Grosser   Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
717bc132607STobias Grosser                                                VLTS[0], NewAccesses);
7183b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
7193b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
720c14582f2STobias Grosser   LoadInst *ScalarLoad =
721c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
7223b11a16aSHongbin Zheng 
7233b11a16aSHongbin Zheng   if (!Aligned)
7243b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
7253b11a16aSHongbin Zheng 
726c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
727c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
7283b11a16aSHongbin Zheng 
729c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
730c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
7313b11a16aSHongbin Zheng   return VectorLoad;
7323b11a16aSHongbin Zheng }
7333b11a16aSHongbin Zheng 
734be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
7352f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
73609e3697fSJohannes Doerfert     __isl_keep isl_id_to_ast_expr *NewAccesses) {
7373b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
7389646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
7393b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
7403b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
7413b11a16aSHongbin Zheng 
7423b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
7433b11a16aSHongbin Zheng 
7443b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
745bc132607STobias Grosser     Value *NewPointer = generateLocationAccessed(
746bc132607STobias Grosser         Stmt, Load, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
747c14582f2STobias Grosser     Value *ScalarLoad =
748c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
749c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
750c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
7513b11a16aSHongbin Zheng   }
7523b11a16aSHongbin Zheng 
7533b11a16aSHongbin Zheng   return Vector;
7543b11a16aSHongbin Zheng }
7553b11a16aSHongbin Zheng 
7562d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
7572f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
7582d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
759c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
760c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
761c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
762c1db67e2SJohannes Doerfert     return;
763c1db67e2SJohannes Doerfert   }
764c1db67e2SJohannes Doerfert 
7652873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
7663b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
767bc132607STobias Grosser       ScalarMaps[i][Load] =
768bc132607STobias Grosser           generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
7693b11a16aSHongbin Zheng     return;
7703b11a16aSHongbin Zheng   }
7713b11a16aSHongbin Zheng 
772be9c9117SJohannes Doerfert   const MemoryAccess &Access = Stmt.getAccessFor(Load);
7733b11a16aSHongbin Zheng 
77495493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
77595493984STobias Grosser   // the data location.
77695493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
77795493984STobias Grosser 
7783b11a16aSHongbin Zheng   Value *NewLoad;
779a00a0291SSebastian Pop   if (Access.isStrideZero(isl_map_copy(Schedule)))
7802d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
781a00a0291SSebastian Pop   else if (Access.isStrideOne(isl_map_copy(Schedule)))
7822d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
7830dd463faSTobias Grosser   else if (Access.isStrideX(isl_map_copy(Schedule), -1))
7842d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
7853b11a16aSHongbin Zheng   else
7862d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
7873b11a16aSHongbin Zheng 
7883b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
7893b11a16aSHongbin Zheng }
7903b11a16aSHongbin Zheng 
7912f1acac6STobias Grosser void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
7923b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
7933b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
7943b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
795be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
796be9c9117SJohannes Doerfert                                      ScalarMaps, getLoopForInst(Inst));
7973b11a16aSHongbin Zheng 
7983b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
7993b11a16aSHongbin Zheng 
8003b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
8013b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
8023b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
8033b11a16aSHongbin Zheng }
8043b11a16aSHongbin Zheng 
8052f1acac6STobias Grosser void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, 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(
8222f1acac6STobias Grosser     ScopStmt &Stmt, 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 
8269646e3feSTobias Grosser   auto *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(
8962f1acac6STobias Grosser     ScopStmt &Stmt, 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(
9242f1acac6STobias Grosser     ScopStmt &Stmt, 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 
9349646e3feSTobias Grosser   if (auto *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)) {
9409646e3feSTobias Grosser     if (auto *Store = dyn_cast<StoreInst>(Inst)) {
9412d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
9423b11a16aSHongbin Zheng       return;
9433b11a16aSHongbin Zheng     }
9443b11a16aSHongbin Zheng 
9459646e3feSTobias Grosser     if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
946be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
9473b11a16aSHongbin Zheng       return;
9483b11a16aSHongbin Zheng     }
9493b11a16aSHongbin Zheng 
9509646e3feSTobias Grosser     if (auto *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 
1016225f0d1eSMichael Kruse   // Collection of all values related to this subregion.
1017225f0d1eSMichael Kruse   ValueMapT ValueMap;
1018225f0d1eSMichael Kruse 
1019275a1756SJohannes Doerfert   // The region represented by the statement.
1020275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1021275a1756SJohannes Doerfert 
1022ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1023ecff11dcSJohannes Doerfert   // inputs.
1024ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1025ecff11dcSJohannes Doerfert   BasicBlock *EntryBBCopy =
1026ecff11dcSJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1027ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1028ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(EntryBBCopy->begin());
1029514f6efaSJohannes Doerfert 
1030225f0d1eSMichael Kruse   generateScalarLoads(Stmt, RegionMaps[EntryBBCopy]);
1031225f0d1eSMichael Kruse 
1032ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1033ecff11dcSJohannes Doerfert     if (!R->contains(*PI))
1034ecff11dcSJohannes Doerfert       BlockMap[*PI] = EntryBBCopy;
1035275a1756SJohannes Doerfert 
1036275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1037275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
1038275a1756SJohannes Doerfert   SmallPtrSet<BasicBlock *, 8> SeenBlocks;
1039ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1040ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1041275a1756SJohannes Doerfert 
1042275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1043275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1044275a1756SJohannes Doerfert     Blocks.pop_front();
1045275a1756SJohannes Doerfert 
1046514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1047514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1048ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1049ecff11dcSJohannes Doerfert 
1050ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1051ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1052514f6efaSJohannes Doerfert 
1053514f6efaSJohannes Doerfert     // Get the mapping for this block and initialize it with the mapping
1054514f6efaSJohannes Doerfert     // available at its immediate dominator (in the new region).
1055514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1056225f0d1eSMichael Kruse     if (BBCopy != EntryBBCopy)
1057514f6efaSJohannes Doerfert       RegionMap = RegionMaps[BBCopyIDom];
1058514f6efaSJohannes Doerfert 
1059275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1060225f0d1eSMichael Kruse     Builder.SetInsertPoint(BBCopy->begin());
1061bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1062275a1756SJohannes Doerfert 
1063ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1064ecff11dcSJohannes Doerfert     BlockMap[BB] = BBCopy;
1065ecff11dcSJohannes Doerfert 
1066ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1067ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1068bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1069ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1070ecff11dcSJohannes Doerfert 
1071275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1072275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1073275a1756SJohannes Doerfert       if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1074275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1075225f0d1eSMichael Kruse 
1076225f0d1eSMichael Kruse     // Remember value in case it is visible after this subregion.
1077225f0d1eSMichael Kruse     ValueMap.insert(RegionMap.begin(), RegionMap.end());
1078275a1756SJohannes Doerfert   }
1079275a1756SJohannes Doerfert 
1080275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1081514f6efaSJohannes Doerfert   BasicBlock *ExitBBCopy =
1082275a1756SJohannes Doerfert       SplitBlock(Builder.GetInsertBlock(), Builder.GetInsertPoint(), &DT, &LI);
1083ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1084514f6efaSJohannes Doerfert   BlockMap[R->getExit()] = ExitBBCopy;
1085514f6efaSJohannes Doerfert 
1086ecff11dcSJohannes Doerfert   repairDominance(R->getExit(), ExitBBCopy);
1087275a1756SJohannes Doerfert 
1088275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1089275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1090275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1091275a1756SJohannes Doerfert 
1092514f6efaSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1093e114dc02SJohannes Doerfert     TerminatorInst *TI = BB->getTerminator();
1094e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1095e114dc02SJohannes Doerfert       while (!BBCopy->empty())
1096e114dc02SJohannes Doerfert         BBCopy->begin()->eraseFromParent();
1097e114dc02SJohannes Doerfert       new UnreachableInst(BBCopy->getContext(), BBCopy);
1098e114dc02SJohannes Doerfert       continue;
1099e114dc02SJohannes Doerfert     }
1100e114dc02SJohannes Doerfert 
1101275a1756SJohannes Doerfert     Instruction *BICopy = BBCopy->getTerminator();
1102275a1756SJohannes Doerfert 
1103514f6efaSJohannes Doerfert     ValueMapT &RegionMap = RegionMaps[BBCopy];
1104514f6efaSJohannes Doerfert     RegionMap.insert(BlockMap.begin(), BlockMap.end());
1105514f6efaSJohannes Doerfert 
110645e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
11079a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1108275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1109275a1756SJohannes Doerfert   }
1110275a1756SJohannes Doerfert 
1111ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1112ecff11dcSJohannes Doerfert   // replacement for SCEVs refering to the old loop.
1113ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1114ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1115ecff11dcSJohannes Doerfert     if (L == nullptr || L->getHeader() != BB)
1116ecff11dcSJohannes Doerfert       continue;
1117ecff11dcSJohannes Doerfert 
1118ecff11dcSJohannes Doerfert     BasicBlock *BBCopy = BlockMap[BB];
1119ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1120ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1121ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1122ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1123ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1124ecff11dcSJohannes Doerfert     LoopPHI->insertBefore(BBCopy->begin());
1125ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1126ecff11dcSJohannes Doerfert 
1127ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1128ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1129ecff11dcSJohannes Doerfert         continue;
1130ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1131ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1132ecff11dcSJohannes Doerfert       else
1133ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1134ecff11dcSJohannes Doerfert     }
1135ecff11dcSJohannes Doerfert 
1136ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1137ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1138ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1139ecff11dcSJohannes Doerfert 
1140ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1141ecff11dcSJohannes Doerfert   }
1142ecff11dcSJohannes Doerfert 
1143225f0d1eSMichael Kruse   // Continue generating code in the exit block.
1144225f0d1eSMichael Kruse   Builder.SetInsertPoint(ExitBBCopy->getFirstInsertionPt());
1145225f0d1eSMichael Kruse 
1146225f0d1eSMichael Kruse   // Write values visible to other statements.
1147225f0d1eSMichael Kruse   generateScalarStores(Stmt, LTS, ValueMap);
1148275a1756SJohannes Doerfert }
1149ecff11dcSJohannes Doerfert 
1150225f0d1eSMichael Kruse void RegionGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
1151bc132607STobias Grosser                                            ValueMapT &BBMap) {
1152ecff11dcSJohannes Doerfert   const Region &R = Stmt.getParent()->getRegion();
1153ecff11dcSJohannes Doerfert 
115475296901STobias Grosser   assert(Stmt.getRegion() &&
115575296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1156ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1157ecff11dcSJohannes Doerfert 
1158ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
11598d0b734eSMichael Kruse     if (MA->isExplicit() || MA->isRead())
1160ecff11dcSJohannes Doerfert       continue;
1161ecff11dcSJohannes Doerfert 
1162ecff11dcSJohannes Doerfert     Instruction *ScalarInst = MA->getAccessInstruction();
1163d86f2157SJohannes Doerfert     Value *Val = MA->getAccessValue();
1164ecff11dcSJohannes Doerfert 
1165225f0d1eSMichael Kruse     // In case we add the store into an exiting block, we need to restore the
1166225f0d1eSMichael Kruse     // position for stores in the exit node.
1167225f0d1eSMichael Kruse     auto SavedInsertionPoint = Builder.GetInsertPoint();
1168225f0d1eSMichael Kruse 
1169225f0d1eSMichael Kruse     // Implicit writes induced by PHIs must be written in the incoming blocks.
1170225f0d1eSMichael Kruse     if (isa<TerminatorInst>(ScalarInst)) {
1171225f0d1eSMichael Kruse       BasicBlock *ExitingBB = ScalarInst->getParent();
1172225f0d1eSMichael Kruse       BasicBlock *ExitingBBCopy = BlockMap[ExitingBB];
1173225f0d1eSMichael Kruse       Builder.SetInsertPoint(ExitingBBCopy->getTerminator());
1174225f0d1eSMichael Kruse     }
1175225f0d1eSMichael Kruse 
1176bc132607STobias Grosser     auto Address = getOrCreateAlloca(*MA);
1177ecff11dcSJohannes Doerfert 
1178aff56c8aSTobias Grosser     Val = getNewScalarValue(Val, R, Stmt, LTS, BBMap);
1179f8d55f7eSTobias Grosser     Builder.CreateStore(Val, Address);
1180225f0d1eSMichael Kruse 
1181225f0d1eSMichael Kruse     // Restore the insertion point if necessary.
1182225f0d1eSMichael Kruse     if (isa<TerminatorInst>(ScalarInst))
1183225f0d1eSMichael Kruse       Builder.SetInsertPoint(SavedInsertionPoint);
1184ecff11dcSJohannes Doerfert   }
1185ecff11dcSJohannes Doerfert }
1186ecff11dcSJohannes Doerfert 
1187ecff11dcSJohannes Doerfert void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1188ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1189ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1190ecff11dcSJohannes Doerfert   Region *StmtR = Stmt.getRegion();
1191ecff11dcSJohannes Doerfert 
1192ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1193ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1194ecff11dcSJohannes Doerfert   BasicBlock *BBCopy = BlockMap[IncomingBB];
1195ecff11dcSJohannes Doerfert   if (!BBCopy) {
1196ecff11dcSJohannes Doerfert     assert(StmtR->contains(IncomingBB) &&
1197ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1198ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1199ecff11dcSJohannes Doerfert     return;
1200ecff11dcSJohannes Doerfert   }
1201ecff11dcSJohannes Doerfert 
1202ecff11dcSJohannes Doerfert   Value *OpCopy = nullptr;
1203ecff11dcSJohannes Doerfert   if (StmtR->contains(IncomingBB)) {
1204ecff11dcSJohannes Doerfert     assert(RegionMaps.count(BBCopy) &&
1205ecff11dcSJohannes Doerfert            "Incoming PHI block did not have a BBMap");
1206ecff11dcSJohannes Doerfert     ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1207ecff11dcSJohannes Doerfert 
1208ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1209dc122222SMichael Kruse 
1210dc122222SMichael Kruse     auto OldIP = Builder.GetInsertPoint();
1211dc122222SMichael Kruse     Builder.SetInsertPoint(BBCopy->getTerminator());
1212bc132607STobias Grosser     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForInst(PHI));
1213dc122222SMichael Kruse     Builder.SetInsertPoint(OldIP);
1214ecff11dcSJohannes Doerfert   } else {
1215ecff11dcSJohannes Doerfert 
1216ecff11dcSJohannes Doerfert     if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1217ecff11dcSJohannes Doerfert       return;
1218ecff11dcSJohannes Doerfert 
1219bc132607STobias Grosser     Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
1220ecff11dcSJohannes Doerfert     OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1221ecff11dcSJohannes Doerfert                           BlockMap[IncomingBB]->getTerminator());
1222ecff11dcSJohannes Doerfert   }
1223ecff11dcSJohannes Doerfert 
1224ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1225ecff11dcSJohannes Doerfert   assert(BBCopy && "Incoming PHI block was not copied properly");
1226ecff11dcSJohannes Doerfert   PHICopy->addIncoming(OpCopy, BBCopy);
1227ecff11dcSJohannes Doerfert }
1228ecff11dcSJohannes Doerfert 
12292f1acac6STobias Grosser Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1230ecff11dcSJohannes Doerfert                                            ValueMapT &BBMap,
1231ecff11dcSJohannes Doerfert                                            LoopToScevMapT &LTS) {
1232ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1233ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1234ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1235ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1236ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1237ecff11dcSJohannes Doerfert 
1238ecff11dcSJohannes Doerfert   for (unsigned u = 0; u < NumIncoming; u++)
1239bc132607STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
1240ecff11dcSJohannes Doerfert   return PHICopy;
1241ecff11dcSJohannes Doerfert }
1242