13b11a16aSHongbin Zheng //===--- BlockGenerators.cpp - Generate code for statements -----*- C++ -*-===//
23b11a16aSHongbin Zheng //
33b11a16aSHongbin Zheng //                     The LLVM Compiler Infrastructure
43b11a16aSHongbin Zheng //
53b11a16aSHongbin Zheng // This file is distributed under the University of Illinois Open Source
63b11a16aSHongbin Zheng // License. See LICENSE.TXT for details.
73b11a16aSHongbin Zheng //
83b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
93b11a16aSHongbin Zheng //
103b11a16aSHongbin Zheng // This file implements the BlockGenerator and VectorBlockGenerator classes,
113b11a16aSHongbin Zheng // which generate sequential code and vectorized code for a polyhedral
123b11a16aSHongbin Zheng // statement, respectively.
133b11a16aSHongbin Zheng //
143b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
153b11a16aSHongbin Zheng 
168a846610SHongbin Zheng #include "polly/CodeGen/BlockGenerators.h"
1783628182STobias Grosser #include "polly/CodeGen/CodeGeneration.h"
18a63b2579SJohannes Doerfert #include "polly/CodeGen/IslExprBuilder.h"
1986bc93a9STobias Grosser #include "polly/CodeGen/RuntimeDebugBuilder.h"
20637bd631STobias Grosser #include "polly/Options.h"
215624d3c9STobias Grosser #include "polly/ScopInfo.h"
223b11a16aSHongbin Zheng #include "polly/Support/GICHelper.h"
2397cb813cSSebastian Pop #include "polly/Support/SCEVValidator.h"
24ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
25eedae763SMichael Kruse #include "polly/Support/VirtualInstruction.h"
26e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
27f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
28e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
29fd94eee3SDavid Blaikie #include "llvm/Analysis/Utils/Local.h"
30030237d0STobias Grosser #include "llvm/IR/IntrinsicInst.h"
31c9895067STobias Grosser #include "llvm/IR/Module.h"
323b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
33f32d651dSJohannes Doerfert #include "isl/aff.h"
34f32d651dSJohannes Doerfert #include "isl/ast.h"
35f32d651dSJohannes Doerfert #include "isl/ast_build.h"
36ba0d0922STobias Grosser #include "isl/set.h"
37f32d651dSJohannes Doerfert #include <deque>
38f32d651dSJohannes Doerfert 
393b11a16aSHongbin Zheng using namespace llvm;
403b11a16aSHongbin Zheng using namespace polly;
413b11a16aSHongbin Zheng 
42878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
43878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
44878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
45878aba49STobias Grosser                              cl::cat(PollyCategory));
463b11a16aSHongbin Zheng 
471be726a4STobias Grosser bool PollyDebugPrinting;
481be726a4STobias Grosser static cl::opt<bool, true> DebugPrintingX(
4986bc93a9STobias Grosser     "polly-codegen-add-debug-printing",
5086bc93a9STobias Grosser     cl::desc("Add printf calls that show the values loaded/stored."),
511be726a4STobias Grosser     cl::location(PollyDebugPrinting), cl::Hidden, cl::init(false),
521be726a4STobias Grosser     cl::ZeroOrMore, cl::cat(PollyCategory));
5386bc93a9STobias Grosser 
54*e819fffeSMichael Kruse static cl::opt<bool> TraceStmts(
55*e819fffeSMichael Kruse     "polly-codegen-trace-stmts",
56*e819fffeSMichael Kruse     cl::desc("Add printf calls that print the statement being executed"),
57*e819fffeSMichael Kruse     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
58*e819fffeSMichael Kruse 
59*e819fffeSMichael Kruse static cl::opt<bool> TraceScalars(
60*e819fffeSMichael Kruse     "polly-codegen-trace-scalars",
61*e819fffeSMichael Kruse     cl::desc("Add printf calls that print the values of all scalar values "
62*e819fffeSMichael Kruse              "used in a statement. Requires -polly-codegen-trace-stmts."),
63*e819fffeSMichael Kruse     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
64*e819fffeSMichael Kruse 
65acf80064SEli Friedman BlockGenerator::BlockGenerator(
66acf80064SEli Friedman     PollyIRBuilder &B, LoopInfo &LI, ScalarEvolution &SE, DominatorTree &DT,
67587f1f57STobias Grosser     AllocaMapTy &ScalarMap, EscapeUsersAllocaMapTy &EscapeMap,
68587f1f57STobias Grosser     ValueMapT &GlobalMap, IslExprBuilder *ExprBuilder, BasicBlock *StartBlock)
69ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
70587f1f57STobias Grosser       EntryBB(nullptr), ScalarMap(ScalarMap), EscapeMap(EscapeMap),
71587f1f57STobias Grosser       GlobalMap(GlobalMap), StartBlock(StartBlock) {}
72e71c6ab5STobias Grosser 
732f1acac6STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
7433cb9f94STobias Grosser                                              ValueMapT &BBMap,
7533cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
76bc132607STobias Grosser                                              Loop *L) const {
7742df8d1dSJohannes Doerfert   if (!SE.isSCEVable(Old->getType()))
7842df8d1dSJohannes Doerfert     return nullptr;
7942df8d1dSJohannes Doerfert 
8042df8d1dSJohannes Doerfert   const SCEV *Scev = SE.getSCEVAtScope(Old, L);
8142df8d1dSJohannes Doerfert   if (!Scev)
8242df8d1dSJohannes Doerfert     return nullptr;
8342df8d1dSJohannes Doerfert 
8442df8d1dSJohannes Doerfert   if (isa<SCEVCouldNotCompute>(Scev))
8542df8d1dSJohannes Doerfert     return nullptr;
8642df8d1dSJohannes Doerfert 
8703bcb910SSanjoy Das   const SCEV *NewScev = SCEVLoopAddRecRewriter::rewrite(Scev, LTS, SE);
8809e3697fSJohannes Doerfert   ValueMapT VTV;
89637b23dcSSebastian Pop   VTV.insert(BBMap.begin(), BBMap.end());
90637b23dcSSebastian Pop   VTV.insert(GlobalMap.begin(), GlobalMap.end());
91e69e1141SJohannes Doerfert 
92e69e1141SJohannes Doerfert   Scop &S = *Stmt.getParent();
933f52e354SJohannes Doerfert   const DataLayout &DL = S.getFunction().getParent()->getDataLayout();
94e69e1141SJohannes Doerfert   auto IP = Builder.GetInsertPoint();
95e69e1141SJohannes Doerfert 
96e69e1141SJohannes Doerfert   assert(IP != Builder.GetInsertBlock()->end() &&
9745e7944bSTobias Grosser          "Only instructions can be insert points for SCEVExpander");
9842df8d1dSJohannes Doerfert   Value *Expanded =
99acf80064SEli Friedman       expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), &*IP, &VTV,
100acf80064SEli Friedman                     StartBlock->getSinglePredecessor());
101e71c6ab5STobias Grosser 
102e71c6ab5STobias Grosser   BBMap[Old] = Expanded;
103e71c6ab5STobias Grosser   return Expanded;
104e71c6ab5STobias Grosser }
10533cb9f94STobias Grosser 
1062f1acac6STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
1072f1acac6STobias Grosser                                    LoopToScevMapT &LTS, Loop *L) const {
10833cb9f94STobias Grosser 
109eedae763SMichael Kruse   auto lookupGlobally = [this](Value *Old) -> Value * {
110eedae763SMichael Kruse     Value *New = GlobalMap.lookup(Old);
111eedae763SMichael Kruse     if (!New)
112eedae763SMichael Kruse       return nullptr;
11328f8ac1dSJohannes Doerfert 
114eedae763SMichael Kruse     // Required by:
115eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded.ll
116eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_different_bb.ll
117eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_pass_only_needed.ll
118eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointers_preloaded.ll
119eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
120eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/single_loop_with_loop_invariant_baseptr.ll
121eedae763SMichael Kruse     // GlobalMap should be a mapping from (value in original SCoP) to (copied
122eedae763SMichael Kruse     // value in generated SCoP), without intermediate mappings, which might
123eedae763SMichael Kruse     // easily require transitiveness as well.
12433cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
12533cb9f94STobias Grosser       New = NewRemapped;
126eedae763SMichael Kruse 
127eedae763SMichael Kruse     // No test case for this code.
12833cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
12933cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
13033cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
13133cb9f94STobias Grosser 
13233cb9f94STobias Grosser     return New;
133eedae763SMichael Kruse   };
134eedae763SMichael Kruse 
135eedae763SMichael Kruse   Value *New = nullptr;
136eedae763SMichael Kruse   auto VUse = VirtualUse::create(&Stmt, L, Old, true);
137eedae763SMichael Kruse   switch (VUse.getKind()) {
138eedae763SMichael Kruse   case VirtualUse::Block:
139eedae763SMichael Kruse     // BasicBlock are constants, but the BlockGenerator copies them.
140eedae763SMichael Kruse     New = BBMap.lookup(Old);
141eedae763SMichael Kruse     break;
142eedae763SMichael Kruse 
143eedae763SMichael Kruse   case VirtualUse::Constant:
144eedae763SMichael Kruse     // Used by:
145eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/reference-argument-from-non-affine-region.ll
146eedae763SMichael Kruse     // Constants should not be redefined. In this case, the GlobalMap just
147eedae763SMichael Kruse     // contains a mapping to the same constant, which is unnecessary, but
148eedae763SMichael Kruse     // harmless.
149eedae763SMichael Kruse     if ((New = lookupGlobally(Old)))
150eedae763SMichael Kruse       break;
151eedae763SMichael Kruse 
152eedae763SMichael Kruse     assert(!BBMap.count(Old));
153eedae763SMichael Kruse     New = Old;
154eedae763SMichael Kruse     break;
155eedae763SMichael Kruse 
156eedae763SMichael Kruse   case VirtualUse::ReadOnly:
157eedae763SMichael Kruse     assert(!GlobalMap.count(Old));
158eedae763SMichael Kruse 
159eedae763SMichael Kruse     // Required for:
160eedae763SMichael Kruse     // * Isl/CodeGen/MemAccess/create_arrays.ll
161eedae763SMichael Kruse     // * Isl/CodeGen/read-only-scalars.ll
162eedae763SMichael Kruse     // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
163eedae763SMichael Kruse     // For some reason these reload a read-only value. The reloaded value ends
164eedae763SMichael Kruse     // up in BBMap, buts its value should be identical.
165eedae763SMichael Kruse     //
166eedae763SMichael Kruse     // Required for:
167eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/single_loop_with_param.ll
168eedae763SMichael Kruse     // The parallel subfunctions need to reference the read-only value from the
169eedae763SMichael Kruse     // parent function, this is done by reloading them locally.
170eedae763SMichael Kruse     if ((New = BBMap.lookup(Old)))
171eedae763SMichael Kruse       break;
172eedae763SMichael Kruse 
173eedae763SMichael Kruse     New = Old;
174eedae763SMichael Kruse     break;
175eedae763SMichael Kruse 
176eedae763SMichael Kruse   case VirtualUse::Synthesizable:
177eedae763SMichael Kruse     // Used by:
178eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
179eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/recomputed-srem.ll
180eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/reference-other-bb.ll
181eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/two-parallel-loops-reference-outer-indvar.ll
182eedae763SMichael Kruse     // For some reason synthesizable values end up in GlobalMap. Their values
183eedae763SMichael Kruse     // are the same as trySynthesizeNewValue would return. The legacy
184eedae763SMichael Kruse     // implementation prioritized GlobalMap, so this is what we do here as well.
185eedae763SMichael Kruse     // Ideally, synthesizable values should not end up in GlobalMap.
186eedae763SMichael Kruse     if ((New = lookupGlobally(Old)))
187eedae763SMichael Kruse       break;
188eedae763SMichael Kruse 
189eedae763SMichael Kruse     // Required for:
190eedae763SMichael Kruse     // * Isl/CodeGen/RuntimeDebugBuilder/combine_different_values.ll
191eedae763SMichael Kruse     // * Isl/CodeGen/getNumberOfIterations.ll
192eedae763SMichael Kruse     // * Isl/CodeGen/non_affine_float_compare.ll
193eedae763SMichael Kruse     // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
194eedae763SMichael Kruse     // Ideally, synthesizable values are synthesized by trySynthesizeNewValue,
195eedae763SMichael Kruse     // not precomputed (SCEVExpander has its own caching mechanism).
196eedae763SMichael Kruse     // These tests fail without this, but I think trySynthesizeNewValue would
197eedae763SMichael Kruse     // just re-synthesize the same instructions.
198eedae763SMichael Kruse     if ((New = BBMap.lookup(Old)))
199eedae763SMichael Kruse       break;
200eedae763SMichael Kruse 
201eedae763SMichael Kruse     New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L);
202eedae763SMichael Kruse     break;
203eedae763SMichael Kruse 
204eedae763SMichael Kruse   case VirtualUse::Hoisted:
205eedae763SMichael Kruse     // TODO: Hoisted invariant loads should be found in GlobalMap only, but not
206eedae763SMichael Kruse     // redefined locally (which will be ignored anyway). That is, the following
207eedae763SMichael Kruse     // assertion should apply: assert(!BBMap.count(Old))
208eedae763SMichael Kruse 
209eedae763SMichael Kruse     New = lookupGlobally(Old);
210eedae763SMichael Kruse     break;
211eedae763SMichael Kruse 
212eedae763SMichael Kruse   case VirtualUse::Intra:
213eedae763SMichael Kruse   case VirtualUse::Inter:
214eedae763SMichael Kruse     assert(!GlobalMap.count(Old) &&
215eedae763SMichael Kruse            "Intra and inter-stmt values are never global");
216eedae763SMichael Kruse     New = BBMap.lookup(Old);
217eedae763SMichael Kruse     break;
21833cb9f94STobias Grosser   }
219eedae763SMichael Kruse   assert(New && "Unexpected scalar dependence in region!");
22033cb9f94STobias Grosser   return New;
2213b11a16aSHongbin Zheng }
2223b11a16aSHongbin Zheng 
2232f1acac6STobias Grosser void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
224bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
225030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
226030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
227030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
228030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
229030237d0STobias Grosser     return;
230030237d0STobias Grosser 
2313b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
2323b11a16aSHongbin Zheng 
2333b11a16aSHongbin Zheng   // Replace old operands with the new ones.
23491f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
235bc132607STobias Grosser     Value *NewOperand =
2362c3ffc04SJohannes Doerfert         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForStmt(Stmt));
2373b11a16aSHongbin Zheng 
2383b11a16aSHongbin Zheng     if (!NewOperand) {
239c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
240c14582f2STobias Grosser              "Store instructions are always needed!");
24196ab8726SReid Kleckner       NewInst->deleteValue();
2423b11a16aSHongbin Zheng       return;
2433b11a16aSHongbin Zheng     }
2443b11a16aSHongbin Zheng 
2453b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
2463b11a16aSHongbin Zheng   }
2473b11a16aSHongbin Zheng 
2483b11a16aSHongbin Zheng   Builder.Insert(NewInst);
2493b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
2503b11a16aSHongbin Zheng 
251188053afSSingapuram Sanjay Srivallabh   // When copying the instruction onto the Module meant for the GPU,
252188053afSSingapuram Sanjay Srivallabh   // debug metadata attached to an instruction causes all related
253188053afSSingapuram Sanjay Srivallabh   // metadata to be pulled into the Module. This includes the DICompileUnit,
254188053afSSingapuram Sanjay Srivallabh   // which will not be listed in llvm.dbg.cu of the Module since the Module
255188053afSSingapuram Sanjay Srivallabh   // doesn't contain one. This fails the verification of the Module and the
256188053afSSingapuram Sanjay Srivallabh   // subsequent generation of the ASM string.
257188053afSSingapuram Sanjay Srivallabh   if (NewInst->getModule() != Inst->getModule())
258188053afSSingapuram Sanjay Srivallabh     NewInst->setDebugLoc(llvm::DebugLoc());
259188053afSSingapuram Sanjay Srivallabh 
2603b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
2613b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
2623b11a16aSHongbin Zheng }
2633b11a16aSHongbin Zheng 
26470131d34SMichael Kruse Value *
26570131d34SMichael Kruse BlockGenerator::generateLocationAccessed(ScopStmt &Stmt, MemAccInst Inst,
26670131d34SMichael Kruse                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
26770131d34SMichael Kruse                                          isl_id_to_ast_expr *NewAccesses) {
26809214772STobias Grosser   const MemoryAccess &MA = Stmt.getArrayAccessFor(Inst);
2692fa35194SMichael Kruse   return generateLocationAccessed(
2702fa35194SMichael Kruse       Stmt, getLoopForStmt(Stmt),
2712fa35194SMichael Kruse       Inst.isNull() ? nullptr : Inst.getPointerOperand(), BBMap, LTS,
272fe46c3ffSTobias Grosser       NewAccesses, MA.getId().release(), MA.getAccessValue()->getType());
2732fa35194SMichael Kruse }
2743b11a16aSHongbin Zheng 
2752fa35194SMichael Kruse Value *BlockGenerator::generateLocationAccessed(
2762fa35194SMichael Kruse     ScopStmt &Stmt, Loop *L, Value *Pointer, ValueMapT &BBMap,
2772fa35194SMichael Kruse     LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses, __isl_take isl_id *Id,
2782fa35194SMichael Kruse     Type *ExpectedType) {
2792fa35194SMichael Kruse   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, Id);
2803b11a16aSHongbin Zheng 
2812d1ed0bfSTobias Grosser   if (AccessExpr) {
2822d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
28398b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
28498b3ee50STobias Grosser 
28598b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
28698b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
28798b3ee50STobias Grosser     // the newly generated pointer.
2882fa35194SMichael Kruse     auto OldPtrTy = ExpectedType->getPointerTo();
28998b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
29098b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
29198b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
29298b3ee50STobias Grosser 
293d840fc72STobias Grosser     if (OldPtrTy != NewPtrTy)
29498b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
29598b3ee50STobias Grosser     return Address;
2962d1ed0bfSTobias Grosser   }
2972fa35194SMichael Kruse   assert(
2982fa35194SMichael Kruse       Pointer &&
2992fa35194SMichael Kruse       "If expression was not generated, must use the original pointer value");
3002fa35194SMichael Kruse   return getNewValue(Stmt, Pointer, BBMap, LTS, L);
3012fa35194SMichael Kruse }
3022d1ed0bfSTobias Grosser 
3032fa35194SMichael Kruse Value *
3042fa35194SMichael Kruse BlockGenerator::getImplicitAddress(MemoryAccess &Access, Loop *L,
3052fa35194SMichael Kruse                                    LoopToScevMapT &LTS, ValueMapT &BBMap,
3062fa35194SMichael Kruse                                    __isl_keep isl_id_to_ast_expr *NewAccesses) {
3072fa35194SMichael Kruse   if (Access.isLatestArrayKind())
3082fa35194SMichael Kruse     return generateLocationAccessed(*Access.getStatement(), L, nullptr, BBMap,
309fe46c3ffSTobias Grosser                                     LTS, NewAccesses, Access.getId().release(),
3102fa35194SMichael Kruse                                     Access.getAccessValue()->getType());
3112fa35194SMichael Kruse 
312587f1f57STobias Grosser   return getOrCreateAlloca(Access);
3133b11a16aSHongbin Zheng }
3143b11a16aSHongbin Zheng 
3152c3ffc04SJohannes Doerfert Loop *BlockGenerator::getLoopForStmt(const ScopStmt &Stmt) const {
316375cb5feSMichael Kruse   auto *StmtBB = Stmt.getEntryBlock();
3172c3ffc04SJohannes Doerfert   return LI.getLoopFor(StmtBB);
318369430ffSTobias Grosser }
319369430ffSTobias Grosser 
320888ab551SMichael Kruse Value *BlockGenerator::generateArrayLoad(ScopStmt &Stmt, LoadInst *Load,
321bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
3222d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
323c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
324c1db67e2SJohannes Doerfert     return PreloadLoad;
325c1db67e2SJohannes Doerfert 
326bc132607STobias Grosser   Value *NewPointer =
32770131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, LTS, NewAccesses);
32887901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
32987901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
33086bc93a9STobias Grosser 
3311be726a4STobias Grosser   if (PollyDebugPrinting)
33286bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
33386bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
33486bc93a9STobias Grosser 
3353b11a16aSHongbin Zheng   return ScalarLoad;
3363b11a16aSHongbin Zheng }
3373b11a16aSHongbin Zheng 
338888ab551SMichael Kruse void BlockGenerator::generateArrayStore(ScopStmt &Stmt, StoreInst *Store,
339bc132607STobias Grosser                                         ValueMapT &BBMap, LoopToScevMapT &LTS,
3402d1ed0bfSTobias Grosser                                         isl_id_to_ast_expr *NewAccesses) {
341706f79abSMichael Kruse   MemoryAccess &MA = Stmt.getArrayAccessFor(Store);
3421515f6b9STobias Grosser   isl::set AccDom = MA.getAccessRelation().domain();
343fe46c3ffSTobias Grosser   std::string Subject = MA.getId().get_name();
344706f79abSMichael Kruse 
345fe46c3ffSTobias Grosser   generateConditionalExecution(Stmt, AccDom, Subject.c_str(), [&, this]() {
346bc132607STobias Grosser     Value *NewPointer =
34770131d34SMichael Kruse         generateLocationAccessed(Stmt, Store, BBMap, LTS, NewAccesses);
348706f79abSMichael Kruse     Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap,
349706f79abSMichael Kruse                                       LTS, getLoopForStmt(Stmt));
3503b11a16aSHongbin Zheng 
3511be726a4STobias Grosser     if (PollyDebugPrinting)
35286bc93a9STobias Grosser       RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
35386bc93a9STobias Grosser                                             ": ", ValueOperand, "\n");
35486bc93a9STobias Grosser 
355c186ac7aSTobias Grosser     Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
356706f79abSMichael Kruse   });
3573b11a16aSHongbin Zheng }
3583b11a16aSHongbin Zheng 
3595dced269SJohannes Doerfert bool BlockGenerator::canSyntheziseInStmt(ScopStmt &Stmt, Instruction *Inst) {
3602c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
3615dced269SJohannes Doerfert   return (Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
36211c5e079SMichael Kruse          canSynthesize(Inst, *Stmt.getParent(), &SE, L);
3635dced269SJohannes Doerfert }
3645dced269SJohannes Doerfert 
3652f1acac6STobias Grosser void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
366bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
3672d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
3683b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
3693b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
3703b11a16aSHongbin Zheng   if (Inst->isTerminator())
3713b11a16aSHongbin Zheng     return;
3723b11a16aSHongbin Zheng 
373aff56c8aSTobias Grosser   // Synthesizable statements will be generated on-demand.
3745dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
375e71c6ab5STobias Grosser     return;
376e71c6ab5STobias Grosser 
3779646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
378888ab551SMichael Kruse     Value *NewLoad = generateArrayLoad(Stmt, Load, BBMap, LTS, NewAccesses);
3793d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
3803d94fedfSSebastian Pop     // deterministic.
381753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
3823b11a16aSHongbin Zheng     return;
3833b11a16aSHongbin Zheng   }
3843b11a16aSHongbin Zheng 
3859646e3feSTobias Grosser   if (auto *Store = dyn_cast<StoreInst>(Inst)) {
3860446d81eSMichael Kruse     // Identified as redundant by -polly-simplify.
3870446d81eSMichael Kruse     if (!Stmt.getArrayAccessOrNULLFor(Store))
3880446d81eSMichael Kruse       return;
3890446d81eSMichael Kruse 
390888ab551SMichael Kruse     generateArrayStore(Stmt, Store, BBMap, LTS, NewAccesses);
3913b11a16aSHongbin Zheng     return;
3923b11a16aSHongbin Zheng   }
3933b11a16aSHongbin Zheng 
3949646e3feSTobias Grosser   if (auto *PHI = dyn_cast<PHINode>(Inst)) {
395bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
396ecff11dcSJohannes Doerfert     return;
397ecff11dcSJohannes Doerfert   }
398ecff11dcSJohannes Doerfert 
3993f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
4003f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
4019c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
4023f500fa2SJohannes Doerfert     return;
4033f500fa2SJohannes Doerfert 
404bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
4053b11a16aSHongbin Zheng }
4063b11a16aSHongbin Zheng 
4079d12d8adSTobias Grosser void BlockGenerator::removeDeadInstructions(BasicBlock *BB, ValueMapT &BBMap) {
408c59b3ce0STobias Grosser   auto NewBB = Builder.GetInsertBlock();
409c59b3ce0STobias Grosser   for (auto I = NewBB->rbegin(); I != NewBB->rend(); I++) {
410c59b3ce0STobias Grosser     Instruction *NewInst = &*I;
4119d12d8adSTobias Grosser 
4129d12d8adSTobias Grosser     if (!isInstructionTriviallyDead(NewInst))
4139d12d8adSTobias Grosser       continue;
4149d12d8adSTobias Grosser 
415c59b3ce0STobias Grosser     for (auto Pair : BBMap)
416c59b3ce0STobias Grosser       if (Pair.second == NewInst) {
417c59b3ce0STobias Grosser         BBMap.erase(Pair.first);
418c59b3ce0STobias Grosser       }
419c59b3ce0STobias Grosser 
4209d12d8adSTobias Grosser     NewInst->eraseFromParent();
421c59b3ce0STobias Grosser     I = NewBB->rbegin();
4229d12d8adSTobias Grosser   }
4239d12d8adSTobias Grosser }
4249d12d8adSTobias Grosser 
425bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
4262d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
427275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
428275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
429275a1756SJohannes Doerfert 
430275a1756SJohannes Doerfert   ValueMapT BBMap;
431275a1756SJohannes Doerfert 
432be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
433bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
4349d12d8adSTobias Grosser   removeDeadInstructions(BB, BBMap);
435275a1756SJohannes Doerfert }
436275a1756SJohannes Doerfert 
437514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
438b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
439b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
4403b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
441514f6efaSJohannes Doerfert   return CopyBB;
442514f6efaSJohannes Doerfert }
4433b11a16aSHongbin Zheng 
444514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
445bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
4462d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
447514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
448b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
4492fa35194SMichael Kruse   generateScalarLoads(Stmt, LTS, BBMap, NewAccesses);
450*e819fffeSMichael Kruse   generateBeginStmtTrace(Stmt, LTS, BBMap);
451225f0d1eSMichael Kruse 
452bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
453225f0d1eSMichael Kruse 
454225f0d1eSMichael Kruse   // After a basic block was copied store all scalars that escape this block in
455225f0d1eSMichael Kruse   // their alloca.
4562fa35194SMichael Kruse   generateScalarStores(Stmt, LTS, BBMap, NewAccesses);
457514f6efaSJohannes Doerfert   return CopyBB;
458514f6efaSJohannes Doerfert }
459514f6efaSJohannes Doerfert 
460514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
461bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
4622d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
463ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
464ecff11dcSJohannes Doerfert 
465c43d0360STobias Grosser   // Block statements and the entry blocks of region statement are code
466c43d0360STobias Grosser   // generated from instruction lists. This allow us to optimize the
467c43d0360STobias Grosser   // instructions that belong to a certain scop statement. As the code
468c43d0360STobias Grosser   // structure of region statements might be arbitrary complex, optimizing the
469c43d0360STobias Grosser   // instruction list is not yet supported.
470c43d0360STobias Grosser   if (Stmt.isBlockStmt() || (Stmt.isRegionStmt() && Stmt.getEntryBlock() == BB))
4713bb48299SMichael Kruse     for (Instruction *Inst : Stmt.getInstructions())
4723bb48299SMichael Kruse       copyInstruction(Stmt, Inst, BBMap, LTS, NewAccesses);
4733bb48299SMichael Kruse   else
47491f5b262STobias Grosser     for (Instruction &Inst : *BB)
475bc132607STobias Grosser       copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
476ecff11dcSJohannes Doerfert }
477ecff11dcSJohannes Doerfert 
478800e17a7SJohannes Doerfert Value *BlockGenerator::getOrCreateAlloca(const MemoryAccess &Access) {
479587f1f57STobias Grosser   assert(!Access.isLatestArrayKind() && "Trying to get alloca for array kind");
4803216f854STobias Grosser 
481587f1f57STobias Grosser   return getOrCreateAlloca(Access.getLatestScopArrayInfo());
482a4f0988dSTobias Grosser }
483a4f0988dSTobias Grosser 
484a4f0988dSTobias Grosser Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
4853216f854STobias Grosser   assert(!Array->isArrayKind() && "Trying to get alloca for array kind");
4863216f854STobias Grosser 
487587f1f57STobias Grosser   auto &Addr = ScalarMap[Array];
488587f1f57STobias Grosser 
489587f1f57STobias Grosser   if (Addr) {
490587f1f57STobias Grosser     // Allow allocas to be (temporarily) redirected once by adding a new
491a6d48f59SMichael Kruse     // old-alloca-addr to new-addr mapping to GlobalMap. This functionality
492587f1f57STobias Grosser     // is used for example by the OpenMP code generation where a first use
493587f1f57STobias Grosser     // of a scalar while still in the host code allocates a normal alloca with
494587f1f57STobias Grosser     // getOrCreateAlloca. When the values of this scalar are accessed during
495587f1f57STobias Grosser     // the generation of the parallel subfunction, these values are copied over
496587f1f57STobias Grosser     // to the parallel subfunction and each request for a scalar alloca slot
497a6d48f59SMichael Kruse     // must be forwarded to the temporary in-subfunction slot. This mapping is
498587f1f57STobias Grosser     // removed when the subfunction has been generated and again normal host
499682c5114STobias Grosser     // code is generated. Due to the following reasons it is not possible to
500682c5114STobias Grosser     // perform the GlobalMap lookup right after creating the alloca below, but
501682c5114STobias Grosser     // instead we need to check GlobalMap at each call to getOrCreateAlloca:
502682c5114STobias Grosser     //
503682c5114STobias Grosser     //   1) GlobalMap may be changed multiple times (for each parallel loop),
504682c5114STobias Grosser     //   2) The temporary mapping is commonly only known after the initial
505682c5114STobias Grosser     //      alloca has already been generated, and
506682c5114STobias Grosser     //   3) The original alloca value must be restored after leaving the
507682c5114STobias Grosser     //      sub-function.
508587f1f57STobias Grosser     if (Value *NewAddr = GlobalMap.lookup(&*Addr))
509587f1f57STobias Grosser       return NewAddr;
510587f1f57STobias Grosser     return Addr;
511587f1f57STobias Grosser   }
512587f1f57STobias Grosser 
513587f1f57STobias Grosser   Type *Ty = Array->getElementType();
514587f1f57STobias Grosser   Value *ScalarBase = Array->getBasePtr();
515587f1f57STobias Grosser   std::string NameExt;
516a535dff4STobias Grosser   if (Array->isPHIKind())
517587f1f57STobias Grosser     NameExt = ".phiops";
518f8d55f7eSTobias Grosser   else
519587f1f57STobias Grosser     NameExt = ".s2a";
520587f1f57STobias Grosser 
5217b5a4dfdSTobias Grosser   const DataLayout &DL = Builder.GetInsertBlock()->getModule()->getDataLayout();
522b3e30c32SMatt Arsenault 
523b3e30c32SMatt Arsenault   Addr = new AllocaInst(Ty, DL.getAllocaAddrSpace(),
524b3e30c32SMatt Arsenault                         ScalarBase->getName() + NameExt);
525587f1f57STobias Grosser   EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
526587f1f57STobias Grosser   Addr->insertBefore(&*EntryBB->getFirstInsertionPt());
527587f1f57STobias Grosser 
528587f1f57STobias Grosser   return Addr;
529f8d55f7eSTobias Grosser }
530f8d55f7eSTobias Grosser 
531587f1f57STobias Grosser void BlockGenerator::handleOutsideUsers(const Scop &S, ScopArrayInfo *Array) {
532587f1f57STobias Grosser   Instruction *Inst = cast<Instruction>(Array->getBasePtr());
533b79a67dfSTobias Grosser 
5342985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
5352985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
5362985400aSTobias Grosser   // copied multiple times we already did this and can exit.
537acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
538acb6ade7SMichael Kruse     return;
539e69e1141SJohannes Doerfert 
540ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
541ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
542ecff11dcSJohannes Doerfert 
543ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
544ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
545ecff11dcSJohannes Doerfert     if (!UI)
546ecff11dcSJohannes Doerfert       continue;
547ecff11dcSJohannes Doerfert 
548952b5304SJohannes Doerfert     if (S.contains(UI))
549ecff11dcSJohannes Doerfert       continue;
550ecff11dcSJohannes Doerfert 
551ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
552ecff11dcSJohannes Doerfert   }
553ecff11dcSJohannes Doerfert 
554ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
555ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
556ecff11dcSJohannes Doerfert     return;
557ecff11dcSJohannes Doerfert 
558ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
559587f1f57STobias Grosser   auto *ScalarAddr = getOrCreateAlloca(Array);
560ecff11dcSJohannes Doerfert 
561ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
562ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
563ecff11dcSJohannes Doerfert }
564ecff11dcSJohannes Doerfert 
5652fa35194SMichael Kruse void BlockGenerator::generateScalarLoads(
5662fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
5672fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
568225f0d1eSMichael Kruse   for (MemoryAccess *MA : Stmt) {
5692fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isWrite())
570ecff11dcSJohannes Doerfert       continue;
571ecff11dcSJohannes Doerfert 
57277394f13SMichael Kruse #ifndef NDEBUG
5734485ae08SMichael Kruse     auto StmtDom =
5744485ae08SMichael Kruse         Stmt.getDomain().intersect_params(Stmt.getParent()->getContext());
575388730c9SMichael Kruse     auto AccDom = MA->getAccessRelation().domain();
576388730c9SMichael Kruse     assert(!StmtDom.is_subset(AccDom).is_false() &&
57777394f13SMichael Kruse            "Scalar must be loaded in all statement instances");
57877394f13SMichael Kruse #endif
57977394f13SMichael Kruse 
5802fa35194SMichael Kruse     auto *Address =
5812fa35194SMichael Kruse         getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS, BBMap, NewAccesses);
582eac9726eSMichael Kruse     assert((!isa<Instruction>(Address) ||
583eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Address)->getParent(),
584eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
585eac9726eSMichael Kruse            "Domination violation");
586583be06fSTobias Grosser     BBMap[MA->getAccessValue()] =
5872fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
588ecff11dcSJohannes Doerfert   }
589ecff11dcSJohannes Doerfert }
590ecff11dcSJohannes Doerfert 
591706f79abSMichael Kruse Value *BlockGenerator::buildContainsCondition(ScopStmt &Stmt,
592706f79abSMichael Kruse                                               const isl::set &Subdomain) {
593132860afSTobias Grosser   isl::ast_build AstBuild = Stmt.getAstBuild();
594dcf8d696STobias Grosser   isl::set Domain = Stmt.getDomain();
595706f79abSMichael Kruse 
5966b6ac900STobias Grosser   isl::union_map USchedule = AstBuild.get_schedule();
5976b6ac900STobias Grosser   USchedule = USchedule.intersect_domain(Domain);
598706f79abSMichael Kruse 
5996b6ac900STobias Grosser   assert(!USchedule.is_empty());
6006b6ac900STobias Grosser   isl::map Schedule = isl::map::from_union_map(USchedule);
601706f79abSMichael Kruse 
6026b6ac900STobias Grosser   isl::set ScheduledDomain = Schedule.range();
6036b6ac900STobias Grosser   isl::set ScheduledSet = Subdomain.apply(Schedule);
604706f79abSMichael Kruse 
6056b6ac900STobias Grosser   isl::ast_build RestrictedBuild = AstBuild.restrict(ScheduledDomain);
6066b6ac900STobias Grosser 
6076b6ac900STobias Grosser   isl::ast_expr IsInSet = RestrictedBuild.expr_from(ScheduledSet);
608706f79abSMichael Kruse   Value *IsInSetExpr = ExprBuilder->create(IsInSet.copy());
609706f79abSMichael Kruse   IsInSetExpr = Builder.CreateICmpNE(
610706f79abSMichael Kruse       IsInSetExpr, ConstantInt::get(IsInSetExpr->getType(), 0));
611706f79abSMichael Kruse 
612706f79abSMichael Kruse   return IsInSetExpr;
613706f79abSMichael Kruse }
614706f79abSMichael Kruse 
615706f79abSMichael Kruse void BlockGenerator::generateConditionalExecution(
616706f79abSMichael Kruse     ScopStmt &Stmt, const isl::set &Subdomain, StringRef Subject,
617706f79abSMichael Kruse     const std::function<void()> &GenThenFunc) {
618dcf8d696STobias Grosser   isl::set StmtDom = Stmt.getDomain();
619706f79abSMichael Kruse 
620706f79abSMichael Kruse   // If the condition is a tautology, don't generate a condition around the
621706f79abSMichael Kruse   // code.
622f51decb5STobias Grosser   bool IsPartialWrite =
6238ea1fc19STobias Grosser       !StmtDom.intersect_params(Stmt.getParent()->getContext())
624f51decb5STobias Grosser            .is_subset(Subdomain);
625f51decb5STobias Grosser   if (!IsPartialWrite) {
626706f79abSMichael Kruse     GenThenFunc();
627706f79abSMichael Kruse     return;
628706f79abSMichael Kruse   }
629706f79abSMichael Kruse 
630706f79abSMichael Kruse   // Generate the condition.
631706f79abSMichael Kruse   Value *Cond = buildContainsCondition(Stmt, Subdomain);
632b795bfc0SMichael Kruse 
633b795bfc0SMichael Kruse   // Don't call GenThenFunc if it is never executed. An ast index expression
634b795bfc0SMichael Kruse   // might not be defined in this case.
635b795bfc0SMichael Kruse   if (auto *Const = dyn_cast<ConstantInt>(Cond))
636b795bfc0SMichael Kruse     if (Const->isZero())
637b795bfc0SMichael Kruse       return;
638b795bfc0SMichael Kruse 
639706f79abSMichael Kruse   BasicBlock *HeadBlock = Builder.GetInsertBlock();
640706f79abSMichael Kruse   StringRef BlockName = HeadBlock->getName();
641706f79abSMichael Kruse 
642706f79abSMichael Kruse   // Generate the conditional block.
643706f79abSMichael Kruse   SplitBlockAndInsertIfThen(Cond, &*Builder.GetInsertPoint(), false, nullptr,
644706f79abSMichael Kruse                             &DT, &LI);
645706f79abSMichael Kruse   BranchInst *Branch = cast<BranchInst>(HeadBlock->getTerminator());
646706f79abSMichael Kruse   BasicBlock *ThenBlock = Branch->getSuccessor(0);
647706f79abSMichael Kruse   BasicBlock *TailBlock = Branch->getSuccessor(1);
648706f79abSMichael Kruse 
649706f79abSMichael Kruse   // Assign descriptive names.
650706f79abSMichael Kruse   if (auto *CondInst = dyn_cast<Instruction>(Cond))
651706f79abSMichael Kruse     CondInst->setName("polly." + Subject + ".cond");
652706f79abSMichael Kruse   ThenBlock->setName(BlockName + "." + Subject + ".partial");
653706f79abSMichael Kruse   TailBlock->setName(BlockName + ".cont");
654706f79abSMichael Kruse 
655706f79abSMichael Kruse   // Put the client code into the conditional block and continue in the merge
656706f79abSMichael Kruse   // block afterwards.
657706f79abSMichael Kruse   Builder.SetInsertPoint(ThenBlock, ThenBlock->getFirstInsertionPt());
658706f79abSMichael Kruse   GenThenFunc();
659706f79abSMichael Kruse   Builder.SetInsertPoint(TailBlock, TailBlock->getFirstInsertionPt());
660706f79abSMichael Kruse }
661706f79abSMichael Kruse 
662*e819fffeSMichael Kruse static std::string getInstName(Value *Val) {
663*e819fffeSMichael Kruse   std::string Result;
664*e819fffeSMichael Kruse   raw_string_ostream OS(Result);
665*e819fffeSMichael Kruse   Val->printAsOperand(OS, false);
666*e819fffeSMichael Kruse   return OS.str();
667*e819fffeSMichael Kruse }
668*e819fffeSMichael Kruse 
669*e819fffeSMichael Kruse void BlockGenerator::generateBeginStmtTrace(ScopStmt &Stmt, LoopToScevMapT &LTS,
670*e819fffeSMichael Kruse                                             ValueMapT &BBMap) {
671*e819fffeSMichael Kruse   if (!TraceStmts)
672*e819fffeSMichael Kruse     return;
673*e819fffeSMichael Kruse 
674*e819fffeSMichael Kruse   Scop *S = Stmt.getParent();
675*e819fffeSMichael Kruse   const char *BaseName = Stmt.getBaseName();
676*e819fffeSMichael Kruse 
677*e819fffeSMichael Kruse   isl::ast_build AstBuild = Stmt.getAstBuild();
678*e819fffeSMichael Kruse   isl::set Domain = Stmt.getDomain();
679*e819fffeSMichael Kruse 
680*e819fffeSMichael Kruse   isl::union_map USchedule = AstBuild.get_schedule().intersect_domain(Domain);
681*e819fffeSMichael Kruse   isl::map Schedule = isl::map::from_union_map(USchedule);
682*e819fffeSMichael Kruse   assert(Schedule.is_empty().is_false() &&
683*e819fffeSMichael Kruse          "The stmt must have a valid instance");
684*e819fffeSMichael Kruse 
685*e819fffeSMichael Kruse   isl::multi_pw_aff ScheduleMultiPwAff =
686*e819fffeSMichael Kruse       isl::pw_multi_aff::from_map(Schedule.reverse());
687*e819fffeSMichael Kruse   isl::ast_build RestrictedBuild = AstBuild.restrict(Schedule.range());
688*e819fffeSMichael Kruse 
689*e819fffeSMichael Kruse   // Sequence of strings to print.
690*e819fffeSMichael Kruse   SmallVector<llvm::Value *, 8> Values;
691*e819fffeSMichael Kruse 
692*e819fffeSMichael Kruse   // Print the name of the statement.
693*e819fffeSMichael Kruse   // TODO: Indent by the depth of the statement instance in the schedule tree.
694*e819fffeSMichael Kruse   Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, BaseName));
695*e819fffeSMichael Kruse   Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "("));
696*e819fffeSMichael Kruse 
697*e819fffeSMichael Kruse   // Add the coordinate of the statement instance.
698*e819fffeSMichael Kruse   int DomDims = ScheduleMultiPwAff.dim(isl::dim::out);
699*e819fffeSMichael Kruse   for (int i = 0; i < DomDims; i += 1) {
700*e819fffeSMichael Kruse     if (i > 0)
701*e819fffeSMichael Kruse       Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ","));
702*e819fffeSMichael Kruse 
703*e819fffeSMichael Kruse     isl::ast_expr IsInSet =
704*e819fffeSMichael Kruse         RestrictedBuild.expr_from(ScheduleMultiPwAff.get_pw_aff(i));
705*e819fffeSMichael Kruse     Values.push_back(ExprBuilder->create(IsInSet.copy()));
706*e819fffeSMichael Kruse   }
707*e819fffeSMichael Kruse 
708*e819fffeSMichael Kruse   if (TraceScalars) {
709*e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")"));
710*e819fffeSMichael Kruse     DenseSet<Instruction *> Encountered;
711*e819fffeSMichael Kruse 
712*e819fffeSMichael Kruse     // Add the value of each scalar (and the result of PHIs) used in the
713*e819fffeSMichael Kruse     // statement.
714*e819fffeSMichael Kruse     // TODO: Values used in region-statements.
715*e819fffeSMichael Kruse     for (Instruction *Inst : Stmt.insts()) {
716*e819fffeSMichael Kruse       if (!RuntimeDebugBuilder::isPrintable(Inst->getType()))
717*e819fffeSMichael Kruse         continue;
718*e819fffeSMichael Kruse 
719*e819fffeSMichael Kruse       if (isa<PHINode>(Inst)) {
720*e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, " "));
721*e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(
722*e819fffeSMichael Kruse             Builder, getInstName(Inst)));
723*e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "="));
724*e819fffeSMichael Kruse         Values.push_back(getNewValue(Stmt, Inst, BBMap, LTS,
725*e819fffeSMichael Kruse                                      LI.getLoopFor(Inst->getParent())));
726*e819fffeSMichael Kruse       } else {
727*e819fffeSMichael Kruse         for (Value *Op : Inst->operand_values()) {
728*e819fffeSMichael Kruse           // Do not print values that cannot change during the execution of the
729*e819fffeSMichael Kruse           // SCoP.
730*e819fffeSMichael Kruse           auto *OpInst = dyn_cast<Instruction>(Op);
731*e819fffeSMichael Kruse           if (!OpInst)
732*e819fffeSMichael Kruse             continue;
733*e819fffeSMichael Kruse           if (!S->contains(OpInst))
734*e819fffeSMichael Kruse             continue;
735*e819fffeSMichael Kruse 
736*e819fffeSMichael Kruse           // Print each scalar at most once, and exclude values defined in the
737*e819fffeSMichael Kruse           // statement itself.
738*e819fffeSMichael Kruse           if (Encountered.count(OpInst))
739*e819fffeSMichael Kruse             continue;
740*e819fffeSMichael Kruse 
741*e819fffeSMichael Kruse           Values.push_back(
742*e819fffeSMichael Kruse               RuntimeDebugBuilder::getPrintableString(Builder, " "));
743*e819fffeSMichael Kruse           Values.push_back(RuntimeDebugBuilder::getPrintableString(
744*e819fffeSMichael Kruse               Builder, getInstName(OpInst)));
745*e819fffeSMichael Kruse           Values.push_back(
746*e819fffeSMichael Kruse               RuntimeDebugBuilder::getPrintableString(Builder, "="));
747*e819fffeSMichael Kruse           Values.push_back(getNewValue(Stmt, OpInst, BBMap, LTS,
748*e819fffeSMichael Kruse                                        LI.getLoopFor(Inst->getParent())));
749*e819fffeSMichael Kruse           Encountered.insert(OpInst);
750*e819fffeSMichael Kruse         }
751*e819fffeSMichael Kruse       }
752*e819fffeSMichael Kruse 
753*e819fffeSMichael Kruse       Encountered.insert(Inst);
754*e819fffeSMichael Kruse     }
755*e819fffeSMichael Kruse 
756*e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "\n"));
757*e819fffeSMichael Kruse   } else {
758*e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")\n"));
759*e819fffeSMichael Kruse   }
760*e819fffeSMichael Kruse 
761*e819fffeSMichael Kruse   RuntimeDebugBuilder::createCPUPrinter(Builder, ArrayRef<Value *>(Values));
762*e819fffeSMichael Kruse }
763*e819fffeSMichael Kruse 
7642fa35194SMichael Kruse void BlockGenerator::generateScalarStores(
7652fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
7662fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
767f2cdd144STobias Grosser   Loop *L = LI.getLoopFor(Stmt.getBasicBlock());
768ecff11dcSJohannes Doerfert 
76921a059afSTobias Grosser   assert(Stmt.isBlockStmt() &&
77021a059afSTobias Grosser          "Region statements need to use the generateScalarStores() function in "
77121a059afSTobias Grosser          "the RegionGenerator");
772ecff11dcSJohannes Doerfert 
773ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
7742fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isRead())
775ecff11dcSJohannes Doerfert       continue;
776ecff11dcSJohannes Doerfert 
7771515f6b9STobias Grosser     isl::set AccDom = MA->getAccessRelation().domain();
778fe46c3ffSTobias Grosser     std::string Subject = MA->getId().get_name();
77977394f13SMichael Kruse 
780fe46c3ffSTobias Grosser     generateConditionalExecution(
781fe46c3ffSTobias Grosser         Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
782d86f2157SJohannes Doerfert           Value *Val = MA->getAccessValue();
783ee6a4fc6SMichael Kruse           if (MA->isAnyPHIKind()) {
784fe46c3ffSTobias Grosser             assert(MA->getIncoming().size() >= 1 &&
785fe46c3ffSTobias Grosser                    "Block statements have exactly one exiting block, or "
786fe46c3ffSTobias Grosser                    "multiple but "
787ee6a4fc6SMichael Kruse                    "with same incoming block and value");
788fe46c3ffSTobias Grosser             assert(std::all_of(MA->getIncoming().begin(),
789fe46c3ffSTobias Grosser                                MA->getIncoming().end(),
790ee6a4fc6SMichael Kruse                                [&](std::pair<BasicBlock *, Value *> p) -> bool {
791ee6a4fc6SMichael Kruse                                  return p.first == Stmt.getBasicBlock();
792ee6a4fc6SMichael Kruse                                }) &&
793ee6a4fc6SMichael Kruse                    "Incoming block must be statement's block");
794ee6a4fc6SMichael Kruse             Val = MA->getIncoming()[0].second;
795ee6a4fc6SMichael Kruse           }
796fe46c3ffSTobias Grosser           auto Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
797fe46c3ffSTobias Grosser                                             BBMap, NewAccesses);
798d86f2157SJohannes Doerfert 
799f2cdd144STobias Grosser           Val = getNewValue(Stmt, Val, BBMap, LTS, L);
800eac9726eSMichael Kruse           assert((!isa<Instruction>(Val) ||
801eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Val)->getParent(),
802eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
803eac9726eSMichael Kruse                  "Domination violation");
804eac9726eSMichael Kruse           assert((!isa<Instruction>(Address) ||
805eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Address)->getParent(),
806eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
807eac9726eSMichael Kruse                  "Domination violation");
8082f5cbc44SMichael Kruse 
8092f5cbc44SMichael Kruse           // The new Val might have a different type than the old Val due to
8102f5cbc44SMichael Kruse           // ScalarEvolution looking through bitcasts.
8112f5cbc44SMichael Kruse           if (Val->getType() != Address->getType()->getPointerElementType())
8122f5cbc44SMichael Kruse             Address = Builder.CreateBitOrPointerCast(
8132f5cbc44SMichael Kruse                 Address, Val->getType()->getPointerTo());
8142f5cbc44SMichael Kruse 
81592245228STobias Grosser           Builder.CreateStore(Val, Address);
816706f79abSMichael Kruse         });
817ecff11dcSJohannes Doerfert   }
818ecff11dcSJohannes Doerfert }
819ecff11dcSJohannes Doerfert 
820c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
821ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExit();
822acf80064SEli Friedman   BasicBlock *PreEntryBB = S.getEnteringBlock();
823188542fdSJohannes Doerfert 
824acf80064SEli Friedman   Builder.SetInsertPoint(&*StartBlock->begin());
825ecff11dcSJohannes Doerfert 
826d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
827c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
828c0091a77STobias Grosser       continue;
829a535dff4STobias Grosser     if (Array->isPHIKind()) {
830c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
831c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
832c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
833acf80064SEli Friedman       // 'PreEntryBB'.
834c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
835ecff11dcSJohannes Doerfert 
836c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
837acf80064SEli Friedman         if (!S.contains(*BI) && *BI != PreEntryBB)
838c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
839acf80064SEli Friedman                            "come from PreEntryBB");
840c0091a77STobias Grosser 
841acf80064SEli Friedman       int Idx = PHI->getBasicBlockIndex(PreEntryBB);
842c0091a77STobias Grosser       if (Idx < 0)
843ecff11dcSJohannes Doerfert         continue;
844ecff11dcSJohannes Doerfert 
845c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
846ecff11dcSJohannes Doerfert 
847587f1f57STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreateAlloca(Array));
848c0091a77STobias Grosser       continue;
849c0091a77STobias Grosser     }
850c0091a77STobias Grosser 
851c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
852c0091a77STobias Grosser 
853952b5304SJohannes Doerfert     if (Inst && S.contains(Inst))
854c0091a77STobias Grosser       continue;
855c0091a77STobias Grosser 
856188542fdSJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are either exit
857188542fdSJohannes Doerfert     // PHI nodes we model as common scalars but without initialization, or
858188542fdSJohannes Doerfert     // incoming phi nodes that need to be initialized. Check if the first is the
859188542fdSJohannes Doerfert     // case for Inst and do not create and initialize memory if so.
860188542fdSJohannes Doerfert     if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
861188542fdSJohannes Doerfert       if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
862717b8667SJohannes Doerfert         continue;
863717b8667SJohannes Doerfert 
864587f1f57STobias Grosser     Builder.CreateStore(Array->getBasePtr(), getOrCreateAlloca(Array));
865ecff11dcSJohannes Doerfert   }
866ecff11dcSJohannes Doerfert }
867ecff11dcSJohannes Doerfert 
868ef74443cSJohannes Doerfert void BlockGenerator::createScalarFinalization(Scop &S) {
869ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
870ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExitingBlock();
871ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
872ef74443cSJohannes Doerfert   BasicBlock *MergeBB = S.getExit();
873ecff11dcSJohannes Doerfert 
874ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
875ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
876ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
877ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
878ecff11dcSJohannes Doerfert 
879ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
880ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
881ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
882ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
883fbde4355SMichael Kruse     Instruction *EscapeInst = EscapeMapping.first;
884fbde4355SMichael Kruse     const auto &EscapeMappingValue = EscapeMapping.second;
885ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
88664c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
887ecff11dcSJohannes Doerfert 
888ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
889d8b6ad25SJohannes Doerfert     Value *EscapeInstReload =
890ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
891d8b6ad25SJohannes Doerfert     EscapeInstReload =
892d8b6ad25SJohannes Doerfert         Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
893ecff11dcSJohannes Doerfert 
894ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
895ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
896ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
897b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
898ecff11dcSJohannes Doerfert 
899ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
900ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
901ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
902ecff11dcSJohannes Doerfert 
903ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
904ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
905ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
906ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
907ecff11dcSJohannes Doerfert 
908ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
909ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
910ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
911ecff11dcSJohannes Doerfert   }
912ecff11dcSJohannes Doerfert }
913ecff11dcSJohannes Doerfert 
914ffa2446fSTobias Grosser void BlockGenerator::findOutsideUsers(Scop &S) {
915d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
916ffa2446fSTobias Grosser 
917ffa2446fSTobias Grosser     if (Array->getNumberOfDimensions() != 0)
918ffa2446fSTobias Grosser       continue;
919ffa2446fSTobias Grosser 
920a535dff4STobias Grosser     if (Array->isPHIKind())
921ffa2446fSTobias Grosser       continue;
922ffa2446fSTobias Grosser 
923ffa2446fSTobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
924ffa2446fSTobias Grosser 
925ffa2446fSTobias Grosser     if (!Inst)
926ffa2446fSTobias Grosser       continue;
927ffa2446fSTobias Grosser 
928ffa2446fSTobias Grosser     // Scop invariant hoisting moves some of the base pointers out of the scop.
929ffa2446fSTobias Grosser     // We can ignore these, as the invariant load hoisting already registers the
930ffa2446fSTobias Grosser     // relevant outside users.
931952b5304SJohannes Doerfert     if (!S.contains(Inst))
932ffa2446fSTobias Grosser       continue;
933ffa2446fSTobias Grosser 
934587f1f57STobias Grosser     handleOutsideUsers(S, Array);
935ffa2446fSTobias Grosser   }
936ffa2446fSTobias Grosser }
937ffa2446fSTobias Grosser 
93827d742daSTobias Grosser void BlockGenerator::createExitPHINodeMerges(Scop &S) {
93927d742daSTobias Grosser   if (S.hasSingleExitEdge())
94027d742daSTobias Grosser     return;
94127d742daSTobias Grosser 
942ef74443cSJohannes Doerfert   auto *ExitBB = S.getExitingBlock();
943ef74443cSJohannes Doerfert   auto *MergeBB = S.getExit();
94427d742daSTobias Grosser   auto *AfterMergeBB = MergeBB->getSingleSuccessor();
94527d742daSTobias Grosser   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
94627d742daSTobias Grosser   if (OptExitBB == ExitBB)
94727d742daSTobias Grosser     OptExitBB = *(++pred_begin(MergeBB));
94827d742daSTobias Grosser 
94927d742daSTobias Grosser   Builder.SetInsertPoint(OptExitBB->getTerminator());
95027d742daSTobias Grosser 
951d7754a12SRoman Gareev   for (auto &SAI : S.arrays()) {
95227d742daSTobias Grosser     auto *Val = SAI->getBasePtr();
95327d742daSTobias Grosser 
954faedfcbfSMichael Kruse     // Only Value-like scalars need a merge PHI. Exit block PHIs receive either
955faedfcbfSMichael Kruse     // the original PHI's value or the reloaded incoming values from the
956faedfcbfSMichael Kruse     // generated code. An llvm::Value is merged between the original code's
957faedfcbfSMichael Kruse     // value or the generated one.
958fa53c86dSMichael Kruse     if (!SAI->isExitPHIKind())
959faedfcbfSMichael Kruse       continue;
960faedfcbfSMichael Kruse 
96127d742daSTobias Grosser     PHINode *PHI = dyn_cast<PHINode>(Val);
96227d742daSTobias Grosser     if (!PHI)
96327d742daSTobias Grosser       continue;
96427d742daSTobias Grosser 
965a3f6edaeSTobias Grosser     if (PHI->getParent() != AfterMergeBB)
96627d742daSTobias Grosser       continue;
96727d742daSTobias Grosser 
96827d742daSTobias Grosser     std::string Name = PHI->getName();
969587f1f57STobias Grosser     Value *ScalarAddr = getOrCreateAlloca(SAI);
97027d742daSTobias Grosser     Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
97127d742daSTobias Grosser     Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
97227d742daSTobias Grosser     Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
973faedfcbfSMichael Kruse     assert((!isa<Instruction>(OriginalValue) ||
974faedfcbfSMichael Kruse             cast<Instruction>(OriginalValue)->getParent() != MergeBB) &&
975faedfcbfSMichael Kruse            "Original value must no be one we just generated.");
97627d742daSTobias Grosser     auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
977b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
97827d742daSTobias Grosser     MergePHI->addIncoming(Reload, OptExitBB);
97927d742daSTobias Grosser     MergePHI->addIncoming(OriginalValue, ExitBB);
98027d742daSTobias Grosser     int Idx = PHI->getBasicBlockIndex(MergeBB);
98127d742daSTobias Grosser     PHI->setIncomingValue(Idx, MergePHI);
98227d742daSTobias Grosser   }
98327d742daSTobias Grosser }
98427d742daSTobias Grosser 
9851c184409STobias Grosser void BlockGenerator::invalidateScalarEvolution(Scop &S) {
9861c184409STobias Grosser   for (auto &Stmt : S)
987b3224adfSRoman Gareev     if (Stmt.isCopyStmt())
988b3224adfSRoman Gareev       continue;
989b3224adfSRoman Gareev     else if (Stmt.isBlockStmt())
9901c184409STobias Grosser       for (auto &Inst : *Stmt.getBasicBlock())
9911c184409STobias Grosser         SE.forgetValue(&Inst);
9921c184409STobias Grosser     else if (Stmt.isRegionStmt())
9931c184409STobias Grosser       for (auto *BB : Stmt.getRegion()->blocks())
9941c184409STobias Grosser         for (auto &Inst : *BB)
9951c184409STobias Grosser           SE.forgetValue(&Inst);
9961c184409STobias Grosser     else
9971c184409STobias Grosser       llvm_unreachable("Unexpected statement type found");
9981aad76c1SMichael Kruse 
9991aad76c1SMichael Kruse   // Invalidate SCEV of loops surrounding the EscapeUsers.
10001aad76c1SMichael Kruse   for (const auto &EscapeMapping : EscapeMap) {
10011aad76c1SMichael Kruse     const EscapeUserVectorTy &EscapeUsers = EscapeMapping.second.second;
10021aad76c1SMichael Kruse     for (Instruction *EUser : EscapeUsers) {
10031aad76c1SMichael Kruse       if (Loop *L = LI.getLoopFor(EUser->getParent()))
10041aad76c1SMichael Kruse         while (L) {
10051aad76c1SMichael Kruse           SE.forgetLoop(L);
10061aad76c1SMichael Kruse           L = L->getParentLoop();
10071aad76c1SMichael Kruse         }
10081aad76c1SMichael Kruse     }
10091aad76c1SMichael Kruse   }
10101c184409STobias Grosser }
10111c184409STobias Grosser 
1012ffa2446fSTobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
1013ffa2446fSTobias Grosser   findOutsideUsers(S);
1014c0091a77STobias Grosser   createScalarInitialization(S);
101527d742daSTobias Grosser   createExitPHINodeMerges(S);
1016ef74443cSJohannes Doerfert   createScalarFinalization(S);
10171c184409STobias Grosser   invalidateScalarEvolution(S);
10183b11a16aSHongbin Zheng }
10193b11a16aSHongbin Zheng 
1020be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
1021be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
1022be9c9117SJohannes Doerfert                                            isl_map *Schedule)
1023bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
1024a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
10253b11a16aSHongbin Zheng }
10263b11a16aSHongbin Zheng 
10272f1acac6STobias Grosser Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
1028e602a076STobias Grosser                                             ValueMapT &VectorMap,
1029e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
1030e602a076STobias Grosser                                             Loop *L) {
1031fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
1032fe11e287SHongbin Zheng     return NewValue;
10333b11a16aSHongbin Zheng 
10343b11a16aSHongbin Zheng   int Width = getVectorWidth();
10353b11a16aSHongbin Zheng 
10363b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
10373b11a16aSHongbin Zheng 
10383b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
1039c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
1040bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
10417242ad92STobias Grosser         Builder.getInt32(Lane));
10423b11a16aSHongbin Zheng 
10433b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
10443b11a16aSHongbin Zheng 
10453b11a16aSHongbin Zheng   return Vector;
10463b11a16aSHongbin Zheng }
10473b11a16aSHongbin Zheng 
10483b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
10493b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
10503b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
10513b11a16aSHongbin Zheng 
10523b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
10533b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
10543b11a16aSHongbin Zheng 
10553b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
10563b11a16aSHongbin Zheng }
10573b11a16aSHongbin Zheng 
1058be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
10592f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
10602d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
10610dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
10629646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
10630dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
10640dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
10650dd463faSTobias Grosser 
10668f25b0cbSMichael Kruse   Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[Offset],
1067bc132607STobias Grosser                                                VLTS[Offset], NewAccesses);
1068c14582f2STobias Grosser   Value *VectorPtr =
1069c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
1070c14582f2STobias Grosser   LoadInst *VecLoad =
1071c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
10723b11a16aSHongbin Zheng   if (!Aligned)
10733b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
10743b11a16aSHongbin Zheng 
10750dd463faSTobias Grosser   if (NegativeStride) {
10760dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
10770dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
10780dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
10790dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
10800dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
10810dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
10820dd463faSTobias Grosser     return RevVecLoad;
10830dd463faSTobias Grosser   }
10840dd463faSTobias Grosser 
10853b11a16aSHongbin Zheng   return VecLoad;
10863b11a16aSHongbin Zheng }
10873b11a16aSHongbin Zheng 
10882d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
10892f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
10902d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
10919646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
10923b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
109370131d34SMichael Kruse   Value *NewPointer =
109470131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, VLTS[0], NewAccesses);
10953b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
10963b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
1097c14582f2STobias Grosser   LoadInst *ScalarLoad =
1098c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
10993b11a16aSHongbin Zheng 
11003b11a16aSHongbin Zheng   if (!Aligned)
11013b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
11023b11a16aSHongbin Zheng 
1103c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
1104c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
11053b11a16aSHongbin Zheng 
1106c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
1107c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
11083b11a16aSHongbin Zheng   return VectorLoad;
11093b11a16aSHongbin Zheng }
11103b11a16aSHongbin Zheng 
1111be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
11122f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
111309e3697fSJohannes Doerfert     __isl_keep isl_id_to_ast_expr *NewAccesses) {
11143b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
11159646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
11163b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
11173b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
11183b11a16aSHongbin Zheng 
11193b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
11203b11a16aSHongbin Zheng 
11213b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
112270131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[i],
112370131d34SMichael Kruse                                                  VLTS[i], NewAccesses);
1124c14582f2STobias Grosser     Value *ScalarLoad =
1125c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
1126c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
1127c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
11283b11a16aSHongbin Zheng   }
11293b11a16aSHongbin Zheng 
11303b11a16aSHongbin Zheng   return Vector;
11313b11a16aSHongbin Zheng }
11323b11a16aSHongbin Zheng 
11332d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
11342f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
11352d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1136c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
1137c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
1138c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
1139c1db67e2SJohannes Doerfert     return;
1140c1db67e2SJohannes Doerfert   }
1141c1db67e2SJohannes Doerfert 
11422873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
11433b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
1144bc132607STobias Grosser       ScalarMaps[i][Load] =
1145888ab551SMichael Kruse           generateArrayLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
11463b11a16aSHongbin Zheng     return;
11473b11a16aSHongbin Zheng   }
11483b11a16aSHongbin Zheng 
1149184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Load);
11503b11a16aSHongbin Zheng 
115195493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
115295493984STobias Grosser   // the data location.
115395493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
115495493984STobias Grosser 
11553b11a16aSHongbin Zheng   Value *NewLoad;
1156718d04c6STobias Grosser   if (Access.isStrideZero(isl::manage_copy(Schedule)))
11572d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
1158718d04c6STobias Grosser   else if (Access.isStrideOne(isl::manage_copy(Schedule)))
11592d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
1160718d04c6STobias Grosser   else if (Access.isStrideX(isl::manage_copy(Schedule), -1))
11612d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
11623b11a16aSHongbin Zheng   else
11632d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
11643b11a16aSHongbin Zheng 
11653b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
11663b11a16aSHongbin Zheng }
11673b11a16aSHongbin Zheng 
11682f1acac6STobias Grosser void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
11693b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
11703b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
11713b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
1172be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
11732c3ffc04SJohannes Doerfert                                      ScalarMaps, getLoopForStmt(Stmt));
11743b11a16aSHongbin Zheng 
11753b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
11763b11a16aSHongbin Zheng 
11773b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
11783b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
11793b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
11803b11a16aSHongbin Zheng }
11813b11a16aSHongbin Zheng 
11822f1acac6STobias Grosser void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
11833b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
11843b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
11852c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
11863b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
11873b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
11883b11a16aSHongbin Zheng 
11893b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
1190be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
1191be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
11923b11a16aSHongbin Zheng 
11931bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
11943b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
11953b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
11963b11a16aSHongbin Zheng }
11973b11a16aSHongbin Zheng 
11982d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
11992f1acac6STobias Grosser     ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
12002d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1201184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Store);
12023b11a16aSHongbin Zheng 
12039646e3feSTobias Grosser   auto *Pointer = Store->getPointerOperand();
1204be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
12052c3ffc04SJohannes Doerfert                                  ScalarMaps, getLoopForStmt(Stmt));
12063b11a16aSHongbin Zheng 
120750fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
120850fd7010STobias Grosser   // the data location.
120950fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
121050fd7010STobias Grosser 
1211718d04c6STobias Grosser   if (Access.isStrideOne(isl::manage_copy(Schedule))) {
12121947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
121370131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[0],
121470131d34SMichael Kruse                                                  VLTS[0], NewAccesses);
12153b11a16aSHongbin Zheng 
1216c14582f2STobias Grosser     Value *VectorPtr =
1217c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
12183b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
12193b11a16aSHongbin Zheng 
12203b11a16aSHongbin Zheng     if (!Aligned)
12213b11a16aSHongbin Zheng       Store->setAlignment(8);
12223b11a16aSHongbin Zheng   } else {
12233b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
12241bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
122570131d34SMichael Kruse       Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[i],
122670131d34SMichael Kruse                                                    VLTS[i], NewAccesses);
12273b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
12283b11a16aSHongbin Zheng     }
12293b11a16aSHongbin Zheng   }
12303b11a16aSHongbin Zheng }
12313b11a16aSHongbin Zheng 
12323b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
12333b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
123491f5b262STobias Grosser   for (Value *Operand : Inst->operands())
123591f5b262STobias Grosser     if (VectorMap.count(Operand))
12363b11a16aSHongbin Zheng       return true;
12373b11a16aSHongbin Zheng   return false;
12383b11a16aSHongbin Zheng }
12393b11a16aSHongbin Zheng 
12403b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
12413b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
12423b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
12433b11a16aSHongbin Zheng   bool HasVectorOperand = false;
12443b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
12453b11a16aSHongbin Zheng 
124691f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
124791f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
12483b11a16aSHongbin Zheng 
12493b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
12503b11a16aSHongbin Zheng       continue;
12513b11a16aSHongbin Zheng 
12523b11a16aSHongbin Zheng     HasVectorOperand = true;
12533b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
12543b11a16aSHongbin Zheng 
12553b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
12563b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
12573b11a16aSHongbin Zheng 
12583b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
12593b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
12602219d157STobias Grosser       // existence of all of them.
126191f5b262STobias Grosser       if (SM.count(Operand))
12623b11a16aSHongbin Zheng         break;
12633b11a16aSHongbin Zheng 
126491f5b262STobias Grosser       SM[Operand] =
126591f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
12663b11a16aSHongbin Zheng     }
12673b11a16aSHongbin Zheng   }
12683b11a16aSHongbin Zheng 
12693b11a16aSHongbin Zheng   return HasVectorOperand;
12703b11a16aSHongbin Zheng }
12713b11a16aSHongbin Zheng 
12722d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
12732f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
12742d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
12753b11a16aSHongbin Zheng   bool HasVectorOperand;
12763b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
12773b11a16aSHongbin Zheng 
12783b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
12793b11a16aSHongbin Zheng 
12803b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
1281be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
1282bc132607STobias Grosser                                     VLTS[VectorLane], NewAccesses);
12833b11a16aSHongbin Zheng 
12843b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
12853b11a16aSHongbin Zheng     return;
12863b11a16aSHongbin Zheng 
12873b11a16aSHongbin Zheng   // Make the result available as vector value.
12883b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
12893b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
12903b11a16aSHongbin Zheng 
12913b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
12923b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
12933b11a16aSHongbin Zheng                                          Builder.getInt32(i));
12943b11a16aSHongbin Zheng 
12953b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
12963b11a16aSHongbin Zheng }
12973b11a16aSHongbin Zheng 
1298bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
12993b11a16aSHongbin Zheng 
13002d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
13012f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
13022d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
13033b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
13043b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
13053b11a16aSHongbin Zheng   if (Inst->isTerminator())
13063b11a16aSHongbin Zheng     return;
13073b11a16aSHongbin Zheng 
13085dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
1309e71c6ab5STobias Grosser     return;
1310e71c6ab5STobias Grosser 
13119646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
13122d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
13133b11a16aSHongbin Zheng     return;
13143b11a16aSHongbin Zheng   }
13153b11a16aSHongbin Zheng 
13163b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
13179646e3feSTobias Grosser     if (auto *Store = dyn_cast<StoreInst>(Inst)) {
13180446d81eSMichael Kruse       // Identified as redundant by -polly-simplify.
13190446d81eSMichael Kruse       if (!Stmt.getArrayAccessOrNULLFor(Store))
13200446d81eSMichael Kruse         return;
13210446d81eSMichael Kruse 
13222d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
13233b11a16aSHongbin Zheng       return;
13243b11a16aSHongbin Zheng     }
13253b11a16aSHongbin Zheng 
13269646e3feSTobias Grosser     if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
1327be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
13283b11a16aSHongbin Zheng       return;
13293b11a16aSHongbin Zheng     }
13303b11a16aSHongbin Zheng 
13319646e3feSTobias Grosser     if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
1332be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
13333b11a16aSHongbin Zheng       return;
13343b11a16aSHongbin Zheng     }
13353b11a16aSHongbin Zheng 
1336a6d48f59SMichael Kruse     // Fallthrough: We generate scalar instructions, if we don't know how to
13373b11a16aSHongbin Zheng     // generate vector code.
13383b11a16aSHongbin Zheng   }
13393b11a16aSHongbin Zheng 
13402d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
13413b11a16aSHongbin Zheng }
13423b11a16aSHongbin Zheng 
1343a69d4f0dSTobias Grosser void VectorBlockGenerator::generateScalarVectorLoads(
1344a69d4f0dSTobias Grosser     ScopStmt &Stmt, ValueMapT &VectorBlockMap) {
1345a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
1346a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isWrite())
1347a69d4f0dSTobias Grosser       continue;
1348a69d4f0dSTobias Grosser 
1349a69d4f0dSTobias Grosser     auto *Address = getOrCreateAlloca(*MA);
1350a69d4f0dSTobias Grosser     Type *VectorPtrType = getVectorPtrTy(Address, 1);
1351a69d4f0dSTobias Grosser     Value *VectorPtr = Builder.CreateBitCast(Address, VectorPtrType,
1352a69d4f0dSTobias Grosser                                              Address->getName() + "_p_vec_p");
1353a69d4f0dSTobias Grosser     auto *Val = Builder.CreateLoad(VectorPtr, Address->getName() + ".reload");
1354a69d4f0dSTobias Grosser     Constant *SplatVector = Constant::getNullValue(
1355a69d4f0dSTobias Grosser         VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
1356a69d4f0dSTobias Grosser 
1357a69d4f0dSTobias Grosser     Value *VectorVal = Builder.CreateShuffleVector(
1358a69d4f0dSTobias Grosser         Val, Val, SplatVector, Address->getName() + "_p_splat");
1359583be06fSTobias Grosser     VectorBlockMap[MA->getAccessValue()] = VectorVal;
1360a69d4f0dSTobias Grosser   }
1361a69d4f0dSTobias Grosser }
1362a69d4f0dSTobias Grosser 
1363a69d4f0dSTobias Grosser void VectorBlockGenerator::verifyNoScalarStores(ScopStmt &Stmt) {
1364a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
1365a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isRead())
1366a69d4f0dSTobias Grosser       continue;
1367a69d4f0dSTobias Grosser 
1368a69d4f0dSTobias Grosser     llvm_unreachable("Scalar stores not expected in vector loop");
1369a69d4f0dSTobias Grosser   }
1370a69d4f0dSTobias Grosser }
1371a69d4f0dSTobias Grosser 
13722d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
13732d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
137421a059afSTobias Grosser   assert(Stmt.isBlockStmt() &&
137521a059afSTobias Grosser          "TODO: Only block statements can be copied by the vector block "
137621a059afSTobias Grosser          "generator");
1377275a1756SJohannes Doerfert 
1378be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
1379b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
1380b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
13813b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
1382b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
13833b11a16aSHongbin Zheng 
13843b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
13853b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
13863b11a16aSHongbin Zheng   // are basic block local.
13873b11a16aSHongbin Zheng   //
13883b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
13893b11a16aSHongbin Zheng   // and one for vector values.
13903b11a16aSHongbin Zheng   //
13913b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
13923b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
13933b11a16aSHongbin Zheng   //
13943b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
13953b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
13963b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
13973b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
13983b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
13993b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
14003b11a16aSHongbin Zheng 
1401a69d4f0dSTobias Grosser   generateScalarVectorLoads(Stmt, VectorBlockMap);
1402a69d4f0dSTobias Grosser 
140391f5b262STobias Grosser   for (Instruction &Inst : *BB)
14042d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
1405a69d4f0dSTobias Grosser 
1406a69d4f0dSTobias Grosser   verifyNoScalarStores(Stmt);
14073b11a16aSHongbin Zheng }
1408275a1756SJohannes Doerfert 
1409ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1410ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
1411514f6efaSJohannes Doerfert 
1412514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1413deefbcedSTobias Grosser   BasicBlock *BBCopyIDom = EndBlockMap.lookup(BBIDom);
1414514f6efaSJohannes Doerfert 
1415514f6efaSJohannes Doerfert   if (BBCopyIDom)
1416514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1417514f6efaSJohannes Doerfert 
1418deefbcedSTobias Grosser   return StartBlockMap.lookup(BBIDom);
1419514f6efaSJohannes Doerfert }
1420514f6efaSJohannes Doerfert 
1421f33c125dSMichael Kruse // This is to determine whether an llvm::Value (defined in @p BB) is usable when
1422f33c125dSMichael Kruse // leaving a subregion. The straight-forward DT.dominates(BB, R->getExitBlock())
1423f33c125dSMichael Kruse // does not work in cases where the exit block has edges from outside the
1424f33c125dSMichael Kruse // region. In that case the llvm::Value would never be usable in in the exit
1425f33c125dSMichael Kruse // block. The RegionGenerator however creates an new exit block ('ExitBBCopy')
1426f33c125dSMichael Kruse // for the subregion's exiting edges only. We need to determine whether an
1427f33c125dSMichael Kruse // llvm::Value is usable in there. We do this by checking whether it dominates
1428f33c125dSMichael Kruse // all exiting blocks individually.
1429f33c125dSMichael Kruse static bool isDominatingSubregionExit(const DominatorTree &DT, Region *R,
1430f33c125dSMichael Kruse                                       BasicBlock *BB) {
1431f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1432f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1433f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1434f33c125dSMichael Kruse       continue;
1435f33c125dSMichael Kruse 
1436f33c125dSMichael Kruse     if (!DT.dominates(BB, ExitingBB))
1437f33c125dSMichael Kruse       return false;
1438f33c125dSMichael Kruse   }
1439f33c125dSMichael Kruse 
1440f33c125dSMichael Kruse   return true;
1441f33c125dSMichael Kruse }
1442f33c125dSMichael Kruse 
1443f33c125dSMichael Kruse // Find the direct dominator of the subregion's exit block if the subregion was
1444f33c125dSMichael Kruse // simplified.
1445f33c125dSMichael Kruse static BasicBlock *findExitDominator(DominatorTree &DT, Region *R) {
1446f33c125dSMichael Kruse   BasicBlock *Common = nullptr;
1447f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1448f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1449f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1450f33c125dSMichael Kruse       continue;
1451f33c125dSMichael Kruse 
1452f33c125dSMichael Kruse     // First exiting edge.
1453f33c125dSMichael Kruse     if (!Common) {
1454f33c125dSMichael Kruse       Common = ExitingBB;
1455f33c125dSMichael Kruse       continue;
1456f33c125dSMichael Kruse     }
1457f33c125dSMichael Kruse 
1458f33c125dSMichael Kruse     Common = DT.findNearestCommonDominator(Common, ExitingBB);
1459f33c125dSMichael Kruse   }
1460f33c125dSMichael Kruse 
1461f33c125dSMichael Kruse   assert(Common && R->contains(Common));
1462f33c125dSMichael Kruse   return Common;
1463f33c125dSMichael Kruse }
1464f33c125dSMichael Kruse 
1465bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
14662d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
1467275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
1468d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
1469275a1756SJohannes Doerfert 
1470ecff11dcSJohannes Doerfert   // Forget all old mappings.
1471deefbcedSTobias Grosser   StartBlockMap.clear();
1472deefbcedSTobias Grosser   EndBlockMap.clear();
1473ecff11dcSJohannes Doerfert   RegionMaps.clear();
1474ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
1475ecff11dcSJohannes Doerfert 
1476225f0d1eSMichael Kruse   // Collection of all values related to this subregion.
1477225f0d1eSMichael Kruse   ValueMapT ValueMap;
1478225f0d1eSMichael Kruse 
1479275a1756SJohannes Doerfert   // The region represented by the statement.
1480275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1481275a1756SJohannes Doerfert 
1482ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1483ecff11dcSJohannes Doerfert   // inputs.
1484ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1485b8f58b53SDuncan P. N. Exon Smith   BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1486b8f58b53SDuncan P. N. Exon Smith                                        &*Builder.GetInsertPoint(), &DT, &LI);
1487ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1488b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&EntryBBCopy->front());
1489514f6efaSJohannes Doerfert 
1490c993739eSMichael Kruse   ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
14912fa35194SMichael Kruse   generateScalarLoads(Stmt, LTS, EntryBBMap, IdToAstExp);
1492*e819fffeSMichael Kruse   generateBeginStmtTrace(Stmt, LTS, EntryBBMap);
1493225f0d1eSMichael Kruse 
1494ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1495deefbcedSTobias Grosser     if (!R->contains(*PI)) {
1496deefbcedSTobias Grosser       StartBlockMap[*PI] = EntryBBCopy;
1497deefbcedSTobias Grosser       EndBlockMap[*PI] = EntryBBCopy;
1498deefbcedSTobias Grosser     }
1499275a1756SJohannes Doerfert 
1500275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1501275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
15025b1abfc8SMandeep Singh Grang   SmallSetVector<BasicBlock *, 8> SeenBlocks;
1503ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1504ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1505275a1756SJohannes Doerfert 
1506275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1507275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1508275a1756SJohannes Doerfert     Blocks.pop_front();
1509275a1756SJohannes Doerfert 
1510514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1511514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1512ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1513ecff11dcSJohannes Doerfert 
1514c993739eSMichael Kruse     // Get the mapping for this block and initialize it with either the scalar
1515c993739eSMichael Kruse     // loads from the generated entering block (which dominates all blocks of
1516c993739eSMichael Kruse     // this subregion) or the maps of the immediate dominator, if part of the
1517c993739eSMichael Kruse     // subregion. The latter necessarily includes the former.
1518c993739eSMichael Kruse     ValueMapT *InitBBMap;
1519c993739eSMichael Kruse     if (BBCopyIDom) {
1520c993739eSMichael Kruse       assert(RegionMaps.count(BBCopyIDom));
1521c993739eSMichael Kruse       InitBBMap = &RegionMaps[BBCopyIDom];
1522c993739eSMichael Kruse     } else
1523c993739eSMichael Kruse       InitBBMap = &EntryBBMap;
1524c993739eSMichael Kruse     auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1525c993739eSMichael Kruse     ValueMapT &RegionMap = Inserted.first->second;
1526514f6efaSJohannes Doerfert 
1527275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1528b8f58b53SDuncan P. N. Exon Smith     Builder.SetInsertPoint(&BBCopy->front());
1529bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1530275a1756SJohannes Doerfert 
1531ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1532deefbcedSTobias Grosser     StartBlockMap[BB] = BBCopy;
1533deefbcedSTobias Grosser     EndBlockMap[BB] = Builder.GetInsertBlock();
1534ecff11dcSJohannes Doerfert 
1535ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1536ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1537bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1538ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1539ecff11dcSJohannes Doerfert 
1540275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1541275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
15425b1abfc8SMandeep Singh Grang       if (R->contains(*SI) && SeenBlocks.insert(*SI))
1543275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1544ebffcbeeSMichael Kruse 
1545ebffcbeeSMichael Kruse     // Remember value in case it is visible after this subregion.
1546f33c125dSMichael Kruse     if (isDominatingSubregionExit(DT, R, BB))
1547ebffcbeeSMichael Kruse       ValueMap.insert(RegionMap.begin(), RegionMap.end());
1548275a1756SJohannes Doerfert   }
1549275a1756SJohannes Doerfert 
1550275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1551b8f58b53SDuncan P. N. Exon Smith   BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1552b8f58b53SDuncan P. N. Exon Smith                                       &*Builder.GetInsertPoint(), &DT, &LI);
1553ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1554deefbcedSTobias Grosser   StartBlockMap[R->getExit()] = ExitBBCopy;
1555deefbcedSTobias Grosser   EndBlockMap[R->getExit()] = ExitBBCopy;
1556514f6efaSJohannes Doerfert 
1557deefbcedSTobias Grosser   BasicBlock *ExitDomBBCopy = EndBlockMap.lookup(findExitDominator(DT, R));
155821a059afSTobias Grosser   assert(ExitDomBBCopy &&
155921a059afSTobias Grosser          "Common exit dominator must be within region; at least the entry node "
156021a059afSTobias Grosser          "must match");
1561f33c125dSMichael Kruse   DT.changeImmediateDominator(ExitBBCopy, ExitDomBBCopy);
1562275a1756SJohannes Doerfert 
1563275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1564275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1565275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1566275a1756SJohannes Doerfert 
1567deefbcedSTobias Grosser     BasicBlock *BBCopyStart = StartBlockMap[BB];
1568deefbcedSTobias Grosser     BasicBlock *BBCopyEnd = EndBlockMap[BB];
1569e114dc02SJohannes Doerfert     TerminatorInst *TI = BB->getTerminator();
1570e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1571deefbcedSTobias Grosser       while (!BBCopyEnd->empty())
1572deefbcedSTobias Grosser         BBCopyEnd->begin()->eraseFromParent();
1573deefbcedSTobias Grosser       new UnreachableInst(BBCopyEnd->getContext(), BBCopyEnd);
1574e114dc02SJohannes Doerfert       continue;
1575e114dc02SJohannes Doerfert     }
1576e114dc02SJohannes Doerfert 
1577deefbcedSTobias Grosser     Instruction *BICopy = BBCopyEnd->getTerminator();
1578275a1756SJohannes Doerfert 
1579deefbcedSTobias Grosser     ValueMapT &RegionMap = RegionMaps[BBCopyStart];
1580deefbcedSTobias Grosser     RegionMap.insert(StartBlockMap.begin(), StartBlockMap.end());
1581514f6efaSJohannes Doerfert 
158245e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
15839a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1584275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1585275a1756SJohannes Doerfert   }
1586275a1756SJohannes Doerfert 
1587ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1588a6d48f59SMichael Kruse   // replacement for SCEVs referring to the old loop.
1589ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1590ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1591bc29e0b2STobias Grosser     if (L == nullptr || L->getHeader() != BB || !R->contains(L))
1592ecff11dcSJohannes Doerfert       continue;
1593ecff11dcSJohannes Doerfert 
1594deefbcedSTobias Grosser     BasicBlock *BBCopy = StartBlockMap[BB];
1595ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1596ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1597ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1598ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1599ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1600b8f58b53SDuncan P. N. Exon Smith     LoopPHI->insertBefore(&BBCopy->front());
1601ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1602ecff11dcSJohannes Doerfert 
1603ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1604ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1605ecff11dcSJohannes Doerfert         continue;
1606ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1607deefbcedSTobias Grosser         LoopPHI->addIncoming(LoopPHIInc, EndBlockMap[PredBB]);
1608ecff11dcSJohannes Doerfert       else
1609deefbcedSTobias Grosser         LoopPHI->addIncoming(NullVal, EndBlockMap[PredBB]);
1610ecff11dcSJohannes Doerfert     }
1611ecff11dcSJohannes Doerfert 
1612ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1613ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1614ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1615ecff11dcSJohannes Doerfert 
1616ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1617ecff11dcSJohannes Doerfert   }
1618ecff11dcSJohannes Doerfert 
1619225f0d1eSMichael Kruse   // Continue generating code in the exit block.
1620b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
1621225f0d1eSMichael Kruse 
1622225f0d1eSMichael Kruse   // Write values visible to other statements.
16232fa35194SMichael Kruse   generateScalarStores(Stmt, LTS, ValueMap, IdToAstExp);
1624deefbcedSTobias Grosser   StartBlockMap.clear();
1625deefbcedSTobias Grosser   EndBlockMap.clear();
16263e956020STobias Grosser   RegionMaps.clear();
16273e956020STobias Grosser   IncompletePHINodeMap.clear();
1628275a1756SJohannes Doerfert }
1629ecff11dcSJohannes Doerfert 
1630ee6a4fc6SMichael Kruse PHINode *RegionGenerator::buildExitPHI(MemoryAccess *MA, LoopToScevMapT &LTS,
1631ee6a4fc6SMichael Kruse                                        ValueMapT &BBMap, Loop *L) {
1632ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1633ee6a4fc6SMichael Kruse   Region *SubR = Stmt->getRegion();
1634ee6a4fc6SMichael Kruse   auto Incoming = MA->getIncoming();
1635ee6a4fc6SMichael Kruse 
1636ee6a4fc6SMichael Kruse   PollyIRBuilder::InsertPointGuard IPGuard(Builder);
1637ee6a4fc6SMichael Kruse   PHINode *OrigPHI = cast<PHINode>(MA->getAccessInstruction());
1638ee6a4fc6SMichael Kruse   BasicBlock *NewSubregionExit = Builder.GetInsertBlock();
1639ee6a4fc6SMichael Kruse 
1640ee6a4fc6SMichael Kruse   // This can happen if the subregion is simplified after the ScopStmts
1641ee6a4fc6SMichael Kruse   // have been created; simplification happens as part of CodeGeneration.
1642ee6a4fc6SMichael Kruse   if (OrigPHI->getParent() != SubR->getExit()) {
1643ee6a4fc6SMichael Kruse     BasicBlock *FormerExit = SubR->getExitingBlock();
1644ee6a4fc6SMichael Kruse     if (FormerExit)
1645deefbcedSTobias Grosser       NewSubregionExit = StartBlockMap.lookup(FormerExit);
1646ee6a4fc6SMichael Kruse   }
1647ee6a4fc6SMichael Kruse 
1648ee6a4fc6SMichael Kruse   PHINode *NewPHI = PHINode::Create(OrigPHI->getType(), Incoming.size(),
1649ee6a4fc6SMichael Kruse                                     "polly." + OrigPHI->getName(),
1650ee6a4fc6SMichael Kruse                                     NewSubregionExit->getFirstNonPHI());
1651ee6a4fc6SMichael Kruse 
1652ee6a4fc6SMichael Kruse   // Add the incoming values to the PHI.
1653ee6a4fc6SMichael Kruse   for (auto &Pair : Incoming) {
1654ee6a4fc6SMichael Kruse     BasicBlock *OrigIncomingBlock = Pair.first;
1655deefbcedSTobias Grosser     BasicBlock *NewIncomingBlockStart = StartBlockMap.lookup(OrigIncomingBlock);
1656deefbcedSTobias Grosser     BasicBlock *NewIncomingBlockEnd = EndBlockMap.lookup(OrigIncomingBlock);
1657deefbcedSTobias Grosser     Builder.SetInsertPoint(NewIncomingBlockEnd->getTerminator());
1658deefbcedSTobias Grosser     assert(RegionMaps.count(NewIncomingBlockStart));
1659deefbcedSTobias Grosser     assert(RegionMaps.count(NewIncomingBlockEnd));
1660deefbcedSTobias Grosser     ValueMapT *LocalBBMap = &RegionMaps[NewIncomingBlockStart];
1661ee6a4fc6SMichael Kruse 
1662ee6a4fc6SMichael Kruse     Value *OrigIncomingValue = Pair.second;
1663ee6a4fc6SMichael Kruse     Value *NewIncomingValue =
1664ee6a4fc6SMichael Kruse         getNewValue(*Stmt, OrigIncomingValue, *LocalBBMap, LTS, L);
1665deefbcedSTobias Grosser     NewPHI->addIncoming(NewIncomingValue, NewIncomingBlockEnd);
1666ee6a4fc6SMichael Kruse   }
1667ee6a4fc6SMichael Kruse 
1668ee6a4fc6SMichael Kruse   return NewPHI;
1669ee6a4fc6SMichael Kruse }
1670ee6a4fc6SMichael Kruse 
1671ee6a4fc6SMichael Kruse Value *RegionGenerator::getExitScalar(MemoryAccess *MA, LoopToScevMapT &LTS,
1672ee6a4fc6SMichael Kruse                                       ValueMapT &BBMap) {
1673ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1674ee6a4fc6SMichael Kruse 
1675ee6a4fc6SMichael Kruse   // TODO: Add some test cases that ensure this is really the right choice.
1676ee6a4fc6SMichael Kruse   Loop *L = LI.getLoopFor(Stmt->getRegion()->getExit());
1677ee6a4fc6SMichael Kruse 
1678ee6a4fc6SMichael Kruse   if (MA->isAnyPHIKind()) {
1679ee6a4fc6SMichael Kruse     auto Incoming = MA->getIncoming();
1680ee6a4fc6SMichael Kruse     assert(!Incoming.empty() &&
1681ee6a4fc6SMichael Kruse            "PHI WRITEs must have originate from at least one incoming block");
1682ee6a4fc6SMichael Kruse 
1683ee6a4fc6SMichael Kruse     // If there is only one incoming value, we do not need to create a PHI.
1684ee6a4fc6SMichael Kruse     if (Incoming.size() == 1) {
1685ee6a4fc6SMichael Kruse       Value *OldVal = Incoming[0].second;
1686ee6a4fc6SMichael Kruse       return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1687ee6a4fc6SMichael Kruse     }
1688ee6a4fc6SMichael Kruse 
1689ee6a4fc6SMichael Kruse     return buildExitPHI(MA, LTS, BBMap, L);
1690ee6a4fc6SMichael Kruse   }
1691ee6a4fc6SMichael Kruse 
16924d5a9172STobias Grosser   // MemoryKind::Value accesses leaving the subregion must dominate the exit
16934d5a9172STobias Grosser   // block; just pass the copied value.
1694ee6a4fc6SMichael Kruse   Value *OldVal = MA->getAccessValue();
1695ee6a4fc6SMichael Kruse   return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1696ee6a4fc6SMichael Kruse }
1697ee6a4fc6SMichael Kruse 
16982fa35194SMichael Kruse void RegionGenerator::generateScalarStores(
16992fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
17002fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
170175296901STobias Grosser   assert(Stmt.getRegion() &&
170275296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1703ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1704ecff11dcSJohannes Doerfert 
1705ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
17062fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isRead())
1707ecff11dcSJohannes Doerfert       continue;
1708ecff11dcSJohannes Doerfert 
17091515f6b9STobias Grosser     isl::set AccDom = MA->getAccessRelation().domain();
1710fe46c3ffSTobias Grosser     std::string Subject = MA->getId().get_name();
1711fe46c3ffSTobias Grosser     generateConditionalExecution(
1712fe46c3ffSTobias Grosser         Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
1713ee6a4fc6SMichael Kruse           Value *NewVal = getExitScalar(MA, LTS, BBMap);
1714fe46c3ffSTobias Grosser           Value *Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
1715fe46c3ffSTobias Grosser                                               BBMap, NewAccesses);
1716eac9726eSMichael Kruse           assert((!isa<Instruction>(NewVal) ||
1717eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(NewVal)->getParent(),
1718eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
1719eac9726eSMichael Kruse                  "Domination violation");
1720eac9726eSMichael Kruse           assert((!isa<Instruction>(Address) ||
1721eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Address)->getParent(),
1722eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
1723eac9726eSMichael Kruse                  "Domination violation");
1724ee6a4fc6SMichael Kruse           Builder.CreateStore(NewVal, Address);
1725706f79abSMichael Kruse         });
1726ecff11dcSJohannes Doerfert   }
1727ecff11dcSJohannes Doerfert }
1728ecff11dcSJohannes Doerfert 
1729943c369cSTobias Grosser void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, PHINode *PHI,
1730ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1731ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1732ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1733ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1734deefbcedSTobias Grosser   BasicBlock *BBCopyStart = StartBlockMap[IncomingBB];
1735deefbcedSTobias Grosser   BasicBlock *BBCopyEnd = EndBlockMap[IncomingBB];
1736deefbcedSTobias Grosser   if (!BBCopyStart) {
1737deefbcedSTobias Grosser     assert(!BBCopyEnd);
17388d89179eSMichael Kruse     assert(Stmt.represents(IncomingBB) &&
1739ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1740ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1741ecff11dcSJohannes Doerfert     return;
1742ecff11dcSJohannes Doerfert   }
1743ecff11dcSJohannes Doerfert 
1744deefbcedSTobias Grosser   assert(RegionMaps.count(BBCopyStart) &&
1745deefbcedSTobias Grosser          "Incoming PHI block did not have a BBMap");
1746deefbcedSTobias Grosser   ValueMapT &BBCopyMap = RegionMaps[BBCopyStart];
1747ecff11dcSJohannes Doerfert 
174875dfaa1dSTobias Grosser   Value *OpCopy = nullptr;
174975dfaa1dSTobias Grosser 
17508d89179eSMichael Kruse   if (Stmt.represents(IncomingBB)) {
1751ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1752dc122222SMichael Kruse 
17536ba92714SJohannes Doerfert     // If the current insert block is different from the PHIs incoming block
17546ba92714SJohannes Doerfert     // change it, otherwise do not.
17556ba92714SJohannes Doerfert     auto IP = Builder.GetInsertPoint();
1756deefbcedSTobias Grosser     if (IP->getParent() != BBCopyEnd)
1757deefbcedSTobias Grosser       Builder.SetInsertPoint(BBCopyEnd->getTerminator());
17582c3ffc04SJohannes Doerfert     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForStmt(Stmt));
1759deefbcedSTobias Grosser     if (IP->getParent() != BBCopyEnd)
17606ba92714SJohannes Doerfert       Builder.SetInsertPoint(&*IP);
1761ecff11dcSJohannes Doerfert   } else {
176275dfaa1dSTobias Grosser     // All edges from outside the non-affine region become a single edge
176375dfaa1dSTobias Grosser     // in the new copy of the non-affine region. Make sure to only add the
176475dfaa1dSTobias Grosser     // corresponding edge the first time we encounter a basic block from
176575dfaa1dSTobias Grosser     // outside the non-affine region.
1766deefbcedSTobias Grosser     if (PHICopy->getBasicBlockIndex(BBCopyEnd) >= 0)
1767ecff11dcSJohannes Doerfert       return;
1768ecff11dcSJohannes Doerfert 
176975dfaa1dSTobias Grosser     // Get the reloaded value.
177075dfaa1dSTobias Grosser     OpCopy = getNewValue(Stmt, PHI, BBCopyMap, LTS, getLoopForStmt(Stmt));
1771ecff11dcSJohannes Doerfert   }
1772ecff11dcSJohannes Doerfert 
1773ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1774deefbcedSTobias Grosser   PHICopy->addIncoming(OpCopy, BBCopyEnd);
1775ecff11dcSJohannes Doerfert }
1776ecff11dcSJohannes Doerfert 
17772b809d13STobias Grosser void RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1778ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap,
1779ecff11dcSJohannes Doerfert                                          LoopToScevMapT &LTS) {
1780ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1781ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1782ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1783ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1784ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1785ecff11dcSJohannes Doerfert 
178697b84909STobias Grosser   for (BasicBlock *IncomingBB : PHI->blocks())
178797b84909STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, IncomingBB, LTS);
1788ecff11dcSJohannes Doerfert }
1789