13b11a16aSHongbin Zheng //===--- BlockGenerators.cpp - Generate code for statements -----*- C++ -*-===//
23b11a16aSHongbin Zheng //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
63b11a16aSHongbin Zheng //
73b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
83b11a16aSHongbin Zheng //
93b11a16aSHongbin Zheng // This file implements the BlockGenerator and VectorBlockGenerator classes,
103b11a16aSHongbin Zheng // which generate sequential code and vectorized code for a polyhedral
113b11a16aSHongbin Zheng // statement, respectively.
123b11a16aSHongbin Zheng //
133b11a16aSHongbin Zheng //===----------------------------------------------------------------------===//
143b11a16aSHongbin Zheng 
158a846610SHongbin Zheng #include "polly/CodeGen/BlockGenerators.h"
16a63b2579SJohannes Doerfert #include "polly/CodeGen/IslExprBuilder.h"
1786bc93a9STobias Grosser #include "polly/CodeGen/RuntimeDebugBuilder.h"
18637bd631STobias Grosser #include "polly/Options.h"
195624d3c9STobias Grosser #include "polly/ScopInfo.h"
20ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
21eedae763SMichael Kruse #include "polly/Support/VirtualInstruction.h"
22e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
23f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
24e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
253b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
26a998f98bSTobias Grosser #include "llvm/Transforms/Utils/Local.h"
27f32d651dSJohannes Doerfert #include "isl/ast.h"
28f32d651dSJohannes Doerfert #include <deque>
29f32d651dSJohannes Doerfert 
303b11a16aSHongbin Zheng using namespace llvm;
313b11a16aSHongbin Zheng using namespace polly;
323b11a16aSHongbin Zheng 
33878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
34878aba49STobias Grosser                              cl::desc("Assumed aligned memory accesses."),
35878aba49STobias Grosser                              cl::Hidden, cl::init(false), cl::ZeroOrMore,
36878aba49STobias Grosser                              cl::cat(PollyCategory));
373b11a16aSHongbin Zheng 
381be726a4STobias Grosser bool PollyDebugPrinting;
391be726a4STobias Grosser static cl::opt<bool, true> DebugPrintingX(
4086bc93a9STobias Grosser     "polly-codegen-add-debug-printing",
4186bc93a9STobias Grosser     cl::desc("Add printf calls that show the values loaded/stored."),
421be726a4STobias Grosser     cl::location(PollyDebugPrinting), cl::Hidden, cl::init(false),
431be726a4STobias Grosser     cl::ZeroOrMore, cl::cat(PollyCategory));
4486bc93a9STobias Grosser 
45e819fffeSMichael Kruse static cl::opt<bool> TraceStmts(
46e819fffeSMichael Kruse     "polly-codegen-trace-stmts",
47e819fffeSMichael Kruse     cl::desc("Add printf calls that print the statement being executed"),
48e819fffeSMichael Kruse     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
49e819fffeSMichael Kruse 
50e819fffeSMichael Kruse static cl::opt<bool> TraceScalars(
51e819fffeSMichael Kruse     "polly-codegen-trace-scalars",
52e819fffeSMichael Kruse     cl::desc("Add printf calls that print the values of all scalar values "
53e819fffeSMichael Kruse              "used in a statement. Requires -polly-codegen-trace-stmts."),
54e819fffeSMichael Kruse     cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
55e819fffeSMichael Kruse 
56acf80064SEli Friedman BlockGenerator::BlockGenerator(
57acf80064SEli Friedman     PollyIRBuilder &B, LoopInfo &LI, ScalarEvolution &SE, DominatorTree &DT,
58587f1f57STobias Grosser     AllocaMapTy &ScalarMap, EscapeUsersAllocaMapTy &EscapeMap,
59587f1f57STobias Grosser     ValueMapT &GlobalMap, IslExprBuilder *ExprBuilder, BasicBlock *StartBlock)
60ecff11dcSJohannes Doerfert     : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
61587f1f57STobias Grosser       EntryBB(nullptr), ScalarMap(ScalarMap), EscapeMap(EscapeMap),
62587f1f57STobias Grosser       GlobalMap(GlobalMap), StartBlock(StartBlock) {}
63e71c6ab5STobias Grosser 
642f1acac6STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
6533cb9f94STobias Grosser                                              ValueMapT &BBMap,
6633cb9f94STobias Grosser                                              LoopToScevMapT &LTS,
67bc132607STobias Grosser                                              Loop *L) const {
6842df8d1dSJohannes Doerfert   if (!SE.isSCEVable(Old->getType()))
6942df8d1dSJohannes Doerfert     return nullptr;
7042df8d1dSJohannes Doerfert 
7142df8d1dSJohannes Doerfert   const SCEV *Scev = SE.getSCEVAtScope(Old, L);
7242df8d1dSJohannes Doerfert   if (!Scev)
7342df8d1dSJohannes Doerfert     return nullptr;
7442df8d1dSJohannes Doerfert 
7542df8d1dSJohannes Doerfert   if (isa<SCEVCouldNotCompute>(Scev))
7642df8d1dSJohannes Doerfert     return nullptr;
7742df8d1dSJohannes Doerfert 
7803bcb910SSanjoy Das   const SCEV *NewScev = SCEVLoopAddRecRewriter::rewrite(Scev, LTS, SE);
7909e3697fSJohannes Doerfert   ValueMapT VTV;
80637b23dcSSebastian Pop   VTV.insert(BBMap.begin(), BBMap.end());
81637b23dcSSebastian Pop   VTV.insert(GlobalMap.begin(), GlobalMap.end());
82e69e1141SJohannes Doerfert 
83e69e1141SJohannes Doerfert   Scop &S = *Stmt.getParent();
843f52e354SJohannes Doerfert   const DataLayout &DL = S.getFunction().getParent()->getDataLayout();
85e69e1141SJohannes Doerfert   auto IP = Builder.GetInsertPoint();
86e69e1141SJohannes Doerfert 
87e69e1141SJohannes Doerfert   assert(IP != Builder.GetInsertBlock()->end() &&
8845e7944bSTobias Grosser          "Only instructions can be insert points for SCEVExpander");
8942df8d1dSJohannes Doerfert   Value *Expanded =
90acf80064SEli Friedman       expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), &*IP, &VTV,
91acf80064SEli Friedman                     StartBlock->getSinglePredecessor());
92e71c6ab5STobias Grosser 
93e71c6ab5STobias Grosser   BBMap[Old] = Expanded;
94e71c6ab5STobias Grosser   return Expanded;
95e71c6ab5STobias Grosser }
9633cb9f94STobias Grosser 
972f1acac6STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
982f1acac6STobias Grosser                                    LoopToScevMapT &LTS, Loop *L) const {
9933cb9f94STobias Grosser 
100eedae763SMichael Kruse   auto lookupGlobally = [this](Value *Old) -> Value * {
101eedae763SMichael Kruse     Value *New = GlobalMap.lookup(Old);
102eedae763SMichael Kruse     if (!New)
103eedae763SMichael Kruse       return nullptr;
10428f8ac1dSJohannes Doerfert 
105eedae763SMichael Kruse     // Required by:
106eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded.ll
107eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_different_bb.ll
108eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_pass_only_needed.ll
109eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/invariant_base_pointers_preloaded.ll
110eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
111eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/single_loop_with_loop_invariant_baseptr.ll
112eedae763SMichael Kruse     // GlobalMap should be a mapping from (value in original SCoP) to (copied
113eedae763SMichael Kruse     // value in generated SCoP), without intermediate mappings, which might
114eedae763SMichael Kruse     // easily require transitiveness as well.
11533cb9f94STobias Grosser     if (Value *NewRemapped = GlobalMap.lookup(New))
11633cb9f94STobias Grosser       New = NewRemapped;
117eedae763SMichael Kruse 
118eedae763SMichael Kruse     // No test case for this code.
11933cb9f94STobias Grosser     if (Old->getType()->getScalarSizeInBits() <
12033cb9f94STobias Grosser         New->getType()->getScalarSizeInBits())
12133cb9f94STobias Grosser       New = Builder.CreateTruncOrBitCast(New, Old->getType());
12233cb9f94STobias Grosser 
12333cb9f94STobias Grosser     return New;
124eedae763SMichael Kruse   };
125eedae763SMichael Kruse 
126eedae763SMichael Kruse   Value *New = nullptr;
127eedae763SMichael Kruse   auto VUse = VirtualUse::create(&Stmt, L, Old, true);
128eedae763SMichael Kruse   switch (VUse.getKind()) {
129eedae763SMichael Kruse   case VirtualUse::Block:
130eedae763SMichael Kruse     // BasicBlock are constants, but the BlockGenerator copies them.
131eedae763SMichael Kruse     New = BBMap.lookup(Old);
132eedae763SMichael Kruse     break;
133eedae763SMichael Kruse 
134eedae763SMichael Kruse   case VirtualUse::Constant:
135eedae763SMichael Kruse     // Used by:
136eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/reference-argument-from-non-affine-region.ll
137eedae763SMichael Kruse     // Constants should not be redefined. In this case, the GlobalMap just
138eedae763SMichael Kruse     // contains a mapping to the same constant, which is unnecessary, but
139eedae763SMichael Kruse     // harmless.
140eedae763SMichael Kruse     if ((New = lookupGlobally(Old)))
141eedae763SMichael Kruse       break;
142eedae763SMichael Kruse 
143eedae763SMichael Kruse     assert(!BBMap.count(Old));
144eedae763SMichael Kruse     New = Old;
145eedae763SMichael Kruse     break;
146eedae763SMichael Kruse 
147eedae763SMichael Kruse   case VirtualUse::ReadOnly:
148eedae763SMichael Kruse     assert(!GlobalMap.count(Old));
149eedae763SMichael Kruse 
150eedae763SMichael Kruse     // Required for:
151eedae763SMichael Kruse     // * Isl/CodeGen/MemAccess/create_arrays.ll
152eedae763SMichael Kruse     // * Isl/CodeGen/read-only-scalars.ll
153eedae763SMichael Kruse     // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
154eedae763SMichael Kruse     // For some reason these reload a read-only value. The reloaded value ends
155eedae763SMichael Kruse     // up in BBMap, buts its value should be identical.
156eedae763SMichael Kruse     //
157eedae763SMichael Kruse     // Required for:
158eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/single_loop_with_param.ll
159eedae763SMichael Kruse     // The parallel subfunctions need to reference the read-only value from the
160eedae763SMichael Kruse     // parent function, this is done by reloading them locally.
161eedae763SMichael Kruse     if ((New = BBMap.lookup(Old)))
162eedae763SMichael Kruse       break;
163eedae763SMichael Kruse 
164eedae763SMichael Kruse     New = Old;
165eedae763SMichael Kruse     break;
166eedae763SMichael Kruse 
167eedae763SMichael Kruse   case VirtualUse::Synthesizable:
168eedae763SMichael Kruse     // Used by:
169eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
170eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/recomputed-srem.ll
171eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/reference-other-bb.ll
172eedae763SMichael Kruse     // * Isl/CodeGen/OpenMP/two-parallel-loops-reference-outer-indvar.ll
173eedae763SMichael Kruse     // For some reason synthesizable values end up in GlobalMap. Their values
174eedae763SMichael Kruse     // are the same as trySynthesizeNewValue would return. The legacy
175eedae763SMichael Kruse     // implementation prioritized GlobalMap, so this is what we do here as well.
176eedae763SMichael Kruse     // Ideally, synthesizable values should not end up in GlobalMap.
177eedae763SMichael Kruse     if ((New = lookupGlobally(Old)))
178eedae763SMichael Kruse       break;
179eedae763SMichael Kruse 
180eedae763SMichael Kruse     // Required for:
181eedae763SMichael Kruse     // * Isl/CodeGen/RuntimeDebugBuilder/combine_different_values.ll
182eedae763SMichael Kruse     // * Isl/CodeGen/getNumberOfIterations.ll
183eedae763SMichael Kruse     // * Isl/CodeGen/non_affine_float_compare.ll
184eedae763SMichael Kruse     // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
185eedae763SMichael Kruse     // Ideally, synthesizable values are synthesized by trySynthesizeNewValue,
186eedae763SMichael Kruse     // not precomputed (SCEVExpander has its own caching mechanism).
187eedae763SMichael Kruse     // These tests fail without this, but I think trySynthesizeNewValue would
188eedae763SMichael Kruse     // just re-synthesize the same instructions.
189eedae763SMichael Kruse     if ((New = BBMap.lookup(Old)))
190eedae763SMichael Kruse       break;
191eedae763SMichael Kruse 
192eedae763SMichael Kruse     New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L);
193eedae763SMichael Kruse     break;
194eedae763SMichael Kruse 
195eedae763SMichael Kruse   case VirtualUse::Hoisted:
196eedae763SMichael Kruse     // TODO: Hoisted invariant loads should be found in GlobalMap only, but not
197eedae763SMichael Kruse     // redefined locally (which will be ignored anyway). That is, the following
198eedae763SMichael Kruse     // assertion should apply: assert(!BBMap.count(Old))
199eedae763SMichael Kruse 
200eedae763SMichael Kruse     New = lookupGlobally(Old);
201eedae763SMichael Kruse     break;
202eedae763SMichael Kruse 
203eedae763SMichael Kruse   case VirtualUse::Intra:
204eedae763SMichael Kruse   case VirtualUse::Inter:
205eedae763SMichael Kruse     assert(!GlobalMap.count(Old) &&
206eedae763SMichael Kruse            "Intra and inter-stmt values are never global");
207eedae763SMichael Kruse     New = BBMap.lookup(Old);
208eedae763SMichael Kruse     break;
20933cb9f94STobias Grosser   }
210eedae763SMichael Kruse   assert(New && "Unexpected scalar dependence in region!");
21133cb9f94STobias Grosser   return New;
2123b11a16aSHongbin Zheng }
2133b11a16aSHongbin Zheng 
2142f1acac6STobias Grosser void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
215bc132607STobias Grosser                                     ValueMapT &BBMap, LoopToScevMapT &LTS) {
216030237d0STobias Grosser   // We do not generate debug intrinsics as we did not investigate how to
217030237d0STobias Grosser   // copy them correctly. At the current state, they just crash the code
218030237d0STobias Grosser   // generation as the meta-data operands are not correctly copied.
219030237d0STobias Grosser   if (isa<DbgInfoIntrinsic>(Inst))
220030237d0STobias Grosser     return;
221030237d0STobias Grosser 
2223b11a16aSHongbin Zheng   Instruction *NewInst = Inst->clone();
2233b11a16aSHongbin Zheng 
2243b11a16aSHongbin Zheng   // Replace old operands with the new ones.
22591f5b262STobias Grosser   for (Value *OldOperand : Inst->operands()) {
226bc132607STobias Grosser     Value *NewOperand =
2272c3ffc04SJohannes Doerfert         getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForStmt(Stmt));
2283b11a16aSHongbin Zheng 
2293b11a16aSHongbin Zheng     if (!NewOperand) {
230c14582f2STobias Grosser       assert(!isa<StoreInst>(NewInst) &&
231c14582f2STobias Grosser              "Store instructions are always needed!");
23296ab8726SReid Kleckner       NewInst->deleteValue();
2333b11a16aSHongbin Zheng       return;
2343b11a16aSHongbin Zheng     }
2353b11a16aSHongbin Zheng 
2363b11a16aSHongbin Zheng     NewInst->replaceUsesOfWith(OldOperand, NewOperand);
2373b11a16aSHongbin Zheng   }
2383b11a16aSHongbin Zheng 
2393b11a16aSHongbin Zheng   Builder.Insert(NewInst);
2403b11a16aSHongbin Zheng   BBMap[Inst] = NewInst;
2413b11a16aSHongbin Zheng 
242188053afSSingapuram Sanjay Srivallabh   // When copying the instruction onto the Module meant for the GPU,
243188053afSSingapuram Sanjay Srivallabh   // debug metadata attached to an instruction causes all related
244188053afSSingapuram Sanjay Srivallabh   // metadata to be pulled into the Module. This includes the DICompileUnit,
245188053afSSingapuram Sanjay Srivallabh   // which will not be listed in llvm.dbg.cu of the Module since the Module
246188053afSSingapuram Sanjay Srivallabh   // doesn't contain one. This fails the verification of the Module and the
247188053afSSingapuram Sanjay Srivallabh   // subsequent generation of the ASM string.
248188053afSSingapuram Sanjay Srivallabh   if (NewInst->getModule() != Inst->getModule())
249188053afSSingapuram Sanjay Srivallabh     NewInst->setDebugLoc(llvm::DebugLoc());
250188053afSSingapuram Sanjay Srivallabh 
2513b11a16aSHongbin Zheng   if (!NewInst->getType()->isVoidTy())
2523b11a16aSHongbin Zheng     NewInst->setName("p_" + Inst->getName());
2533b11a16aSHongbin Zheng }
2543b11a16aSHongbin Zheng 
25570131d34SMichael Kruse Value *
25670131d34SMichael Kruse BlockGenerator::generateLocationAccessed(ScopStmt &Stmt, MemAccInst Inst,
25770131d34SMichael Kruse                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
25870131d34SMichael Kruse                                          isl_id_to_ast_expr *NewAccesses) {
25909214772STobias Grosser   const MemoryAccess &MA = Stmt.getArrayAccessFor(Inst);
2602fa35194SMichael Kruse   return generateLocationAccessed(
2612fa35194SMichael Kruse       Stmt, getLoopForStmt(Stmt),
2622fa35194SMichael Kruse       Inst.isNull() ? nullptr : Inst.getPointerOperand(), BBMap, LTS,
263fe46c3ffSTobias Grosser       NewAccesses, MA.getId().release(), MA.getAccessValue()->getType());
2642fa35194SMichael Kruse }
2653b11a16aSHongbin Zheng 
2662fa35194SMichael Kruse Value *BlockGenerator::generateLocationAccessed(
2672fa35194SMichael Kruse     ScopStmt &Stmt, Loop *L, Value *Pointer, ValueMapT &BBMap,
2682fa35194SMichael Kruse     LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses, __isl_take isl_id *Id,
2692fa35194SMichael Kruse     Type *ExpectedType) {
2702fa35194SMichael Kruse   isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, Id);
2713b11a16aSHongbin Zheng 
2722d1ed0bfSTobias Grosser   if (AccessExpr) {
2732d1ed0bfSTobias Grosser     AccessExpr = isl_ast_expr_address_of(AccessExpr);
27498b3ee50STobias Grosser     auto Address = ExprBuilder->create(AccessExpr);
27598b3ee50STobias Grosser 
27698b3ee50STobias Grosser     // Cast the address of this memory access to a pointer type that has the
27798b3ee50STobias Grosser     // same element type as the original access, but uses the address space of
27898b3ee50STobias Grosser     // the newly generated pointer.
2792fa35194SMichael Kruse     auto OldPtrTy = ExpectedType->getPointerTo();
28098b3ee50STobias Grosser     auto NewPtrTy = Address->getType();
28198b3ee50STobias Grosser     OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
28298b3ee50STobias Grosser                                 NewPtrTy->getPointerAddressSpace());
28398b3ee50STobias Grosser 
284d840fc72STobias Grosser     if (OldPtrTy != NewPtrTy)
28598b3ee50STobias Grosser       Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
28698b3ee50STobias Grosser     return Address;
2872d1ed0bfSTobias Grosser   }
2882fa35194SMichael Kruse   assert(
2892fa35194SMichael Kruse       Pointer &&
2902fa35194SMichael Kruse       "If expression was not generated, must use the original pointer value");
2912fa35194SMichael Kruse   return getNewValue(Stmt, Pointer, BBMap, LTS, L);
2922fa35194SMichael Kruse }
2932d1ed0bfSTobias Grosser 
2942fa35194SMichael Kruse Value *
2952fa35194SMichael Kruse BlockGenerator::getImplicitAddress(MemoryAccess &Access, Loop *L,
2962fa35194SMichael Kruse                                    LoopToScevMapT &LTS, ValueMapT &BBMap,
2972fa35194SMichael Kruse                                    __isl_keep isl_id_to_ast_expr *NewAccesses) {
2982fa35194SMichael Kruse   if (Access.isLatestArrayKind())
2992fa35194SMichael Kruse     return generateLocationAccessed(*Access.getStatement(), L, nullptr, BBMap,
300fe46c3ffSTobias Grosser                                     LTS, NewAccesses, Access.getId().release(),
3012fa35194SMichael Kruse                                     Access.getAccessValue()->getType());
3022fa35194SMichael Kruse 
303587f1f57STobias Grosser   return getOrCreateAlloca(Access);
3043b11a16aSHongbin Zheng }
3053b11a16aSHongbin Zheng 
3062c3ffc04SJohannes Doerfert Loop *BlockGenerator::getLoopForStmt(const ScopStmt &Stmt) const {
307375cb5feSMichael Kruse   auto *StmtBB = Stmt.getEntryBlock();
3082c3ffc04SJohannes Doerfert   return LI.getLoopFor(StmtBB);
309369430ffSTobias Grosser }
310369430ffSTobias Grosser 
311888ab551SMichael Kruse Value *BlockGenerator::generateArrayLoad(ScopStmt &Stmt, LoadInst *Load,
312bc132607STobias Grosser                                          ValueMapT &BBMap, LoopToScevMapT &LTS,
3132d1ed0bfSTobias Grosser                                          isl_id_to_ast_expr *NewAccesses) {
314c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load))
315c1db67e2SJohannes Doerfert     return PreloadLoad;
316c1db67e2SJohannes Doerfert 
317bc132607STobias Grosser   Value *NewPointer =
31870131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, LTS, NewAccesses);
31987901453SJohannes Doerfert   Value *ScalarLoad = Builder.CreateAlignedLoad(
32087901453SJohannes Doerfert       NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
32186bc93a9STobias Grosser 
3221be726a4STobias Grosser   if (PollyDebugPrinting)
32386bc93a9STobias Grosser     RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
32486bc93a9STobias Grosser                                           ": ", ScalarLoad, "\n");
32586bc93a9STobias Grosser 
3263b11a16aSHongbin Zheng   return ScalarLoad;
3273b11a16aSHongbin Zheng }
3283b11a16aSHongbin Zheng 
329888ab551SMichael Kruse void BlockGenerator::generateArrayStore(ScopStmt &Stmt, StoreInst *Store,
330bc132607STobias Grosser                                         ValueMapT &BBMap, LoopToScevMapT &LTS,
3312d1ed0bfSTobias Grosser                                         isl_id_to_ast_expr *NewAccesses) {
332706f79abSMichael Kruse   MemoryAccess &MA = Stmt.getArrayAccessFor(Store);
3331515f6b9STobias Grosser   isl::set AccDom = MA.getAccessRelation().domain();
334fe46c3ffSTobias Grosser   std::string Subject = MA.getId().get_name();
335706f79abSMichael Kruse 
336fe46c3ffSTobias Grosser   generateConditionalExecution(Stmt, AccDom, Subject.c_str(), [&, this]() {
337bc132607STobias Grosser     Value *NewPointer =
33870131d34SMichael Kruse         generateLocationAccessed(Stmt, Store, BBMap, LTS, NewAccesses);
339706f79abSMichael Kruse     Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap,
340706f79abSMichael Kruse                                       LTS, getLoopForStmt(Stmt));
3413b11a16aSHongbin Zheng 
3421be726a4STobias Grosser     if (PollyDebugPrinting)
34386bc93a9STobias Grosser       RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to  ", NewPointer,
34486bc93a9STobias Grosser                                             ": ", ValueOperand, "\n");
34586bc93a9STobias Grosser 
346c186ac7aSTobias Grosser     Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
347706f79abSMichael Kruse   });
3483b11a16aSHongbin Zheng }
3493b11a16aSHongbin Zheng 
3505dced269SJohannes Doerfert bool BlockGenerator::canSyntheziseInStmt(ScopStmt &Stmt, Instruction *Inst) {
3512c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
3525dced269SJohannes Doerfert   return (Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
35311c5e079SMichael Kruse          canSynthesize(Inst, *Stmt.getParent(), &SE, L);
3545dced269SJohannes Doerfert }
3555dced269SJohannes Doerfert 
3562f1acac6STobias Grosser void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
357bc132607STobias Grosser                                      ValueMapT &BBMap, LoopToScevMapT &LTS,
3582d1ed0bfSTobias Grosser                                      isl_id_to_ast_expr *NewAccesses) {
3593b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
3603b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
3613b11a16aSHongbin Zheng   if (Inst->isTerminator())
3623b11a16aSHongbin Zheng     return;
3633b11a16aSHongbin Zheng 
364aff56c8aSTobias Grosser   // Synthesizable statements will be generated on-demand.
3655dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
366e71c6ab5STobias Grosser     return;
367e71c6ab5STobias Grosser 
3689646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
369888ab551SMichael Kruse     Value *NewLoad = generateArrayLoad(Stmt, Load, BBMap, LTS, NewAccesses);
3703d94fedfSSebastian Pop     // Compute NewLoad before its insertion in BBMap to make the insertion
3713d94fedfSSebastian Pop     // deterministic.
372753d43f9SSebastian Pop     BBMap[Load] = NewLoad;
3733b11a16aSHongbin Zheng     return;
3743b11a16aSHongbin Zheng   }
3753b11a16aSHongbin Zheng 
3769646e3feSTobias Grosser   if (auto *Store = dyn_cast<StoreInst>(Inst)) {
3770446d81eSMichael Kruse     // Identified as redundant by -polly-simplify.
3780446d81eSMichael Kruse     if (!Stmt.getArrayAccessOrNULLFor(Store))
3790446d81eSMichael Kruse       return;
3800446d81eSMichael Kruse 
381888ab551SMichael Kruse     generateArrayStore(Stmt, Store, BBMap, LTS, NewAccesses);
3823b11a16aSHongbin Zheng     return;
3833b11a16aSHongbin Zheng   }
3843b11a16aSHongbin Zheng 
3859646e3feSTobias Grosser   if (auto *PHI = dyn_cast<PHINode>(Inst)) {
386bc132607STobias Grosser     copyPHIInstruction(Stmt, PHI, BBMap, LTS);
387ecff11dcSJohannes Doerfert     return;
388ecff11dcSJohannes Doerfert   }
389ecff11dcSJohannes Doerfert 
3903f500fa2SJohannes Doerfert   // Skip some special intrinsics for which we do not adjust the semantics to
3913f500fa2SJohannes Doerfert   // the new schedule. All others are handled like every other instruction.
3929c0ffe3aSTobias Grosser   if (isIgnoredIntrinsic(Inst))
3933f500fa2SJohannes Doerfert     return;
3943f500fa2SJohannes Doerfert 
395bc132607STobias Grosser   copyInstScalar(Stmt, Inst, BBMap, LTS);
3963b11a16aSHongbin Zheng }
3973b11a16aSHongbin Zheng 
3989d12d8adSTobias Grosser void BlockGenerator::removeDeadInstructions(BasicBlock *BB, ValueMapT &BBMap) {
399c59b3ce0STobias Grosser   auto NewBB = Builder.GetInsertBlock();
400c59b3ce0STobias Grosser   for (auto I = NewBB->rbegin(); I != NewBB->rend(); I++) {
401c59b3ce0STobias Grosser     Instruction *NewInst = &*I;
4029d12d8adSTobias Grosser 
4039d12d8adSTobias Grosser     if (!isInstructionTriviallyDead(NewInst))
4049d12d8adSTobias Grosser       continue;
4059d12d8adSTobias Grosser 
406c59b3ce0STobias Grosser     for (auto Pair : BBMap)
407c59b3ce0STobias Grosser       if (Pair.second == NewInst) {
408c59b3ce0STobias Grosser         BBMap.erase(Pair.first);
409c59b3ce0STobias Grosser       }
410c59b3ce0STobias Grosser 
4119d12d8adSTobias Grosser     NewInst->eraseFromParent();
412c59b3ce0STobias Grosser     I = NewBB->rbegin();
4139d12d8adSTobias Grosser   }
4149d12d8adSTobias Grosser }
4159d12d8adSTobias Grosser 
416bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
4172d1ed0bfSTobias Grosser                               isl_id_to_ast_expr *NewAccesses) {
418275a1756SJohannes Doerfert   assert(Stmt.isBlockStmt() &&
419275a1756SJohannes Doerfert          "Only block statements can be copied by the block generator");
420275a1756SJohannes Doerfert 
421275a1756SJohannes Doerfert   ValueMapT BBMap;
422275a1756SJohannes Doerfert 
423be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
424bc132607STobias Grosser   copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
4259d12d8adSTobias Grosser   removeDeadInstructions(BB, BBMap);
426275a1756SJohannes Doerfert }
427275a1756SJohannes Doerfert 
428514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
429b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
430b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
4313b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
432514f6efaSJohannes Doerfert   return CopyBB;
433514f6efaSJohannes Doerfert }
4343b11a16aSHongbin Zheng 
435514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
436bc132607STobias Grosser                                    ValueMapT &BBMap, LoopToScevMapT &LTS,
4372d1ed0bfSTobias Grosser                                    isl_id_to_ast_expr *NewAccesses) {
438514f6efaSJohannes Doerfert   BasicBlock *CopyBB = splitBB(BB);
439b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
4402fa35194SMichael Kruse   generateScalarLoads(Stmt, LTS, BBMap, NewAccesses);
441e819fffeSMichael Kruse   generateBeginStmtTrace(Stmt, LTS, BBMap);
442225f0d1eSMichael Kruse 
443bc132607STobias Grosser   copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
444225f0d1eSMichael Kruse 
445225f0d1eSMichael Kruse   // After a basic block was copied store all scalars that escape this block in
446225f0d1eSMichael Kruse   // their alloca.
4472fa35194SMichael Kruse   generateScalarStores(Stmt, LTS, BBMap, NewAccesses);
448514f6efaSJohannes Doerfert   return CopyBB;
449514f6efaSJohannes Doerfert }
450514f6efaSJohannes Doerfert 
451514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
452bc132607STobias Grosser                             ValueMapT &BBMap, LoopToScevMapT &LTS,
4532d1ed0bfSTobias Grosser                             isl_id_to_ast_expr *NewAccesses) {
454ecff11dcSJohannes Doerfert   EntryBB = &CopyBB->getParent()->getEntryBlock();
455ecff11dcSJohannes Doerfert 
456c43d0360STobias Grosser   // Block statements and the entry blocks of region statement are code
457c43d0360STobias Grosser   // generated from instruction lists. This allow us to optimize the
458c43d0360STobias Grosser   // instructions that belong to a certain scop statement. As the code
459c43d0360STobias Grosser   // structure of region statements might be arbitrary complex, optimizing the
460c43d0360STobias Grosser   // instruction list is not yet supported.
461c43d0360STobias Grosser   if (Stmt.isBlockStmt() || (Stmt.isRegionStmt() && Stmt.getEntryBlock() == BB))
4623bb48299SMichael Kruse     for (Instruction *Inst : Stmt.getInstructions())
4633bb48299SMichael Kruse       copyInstruction(Stmt, Inst, BBMap, LTS, NewAccesses);
4643bb48299SMichael Kruse   else
46591f5b262STobias Grosser     for (Instruction &Inst : *BB)
466bc132607STobias Grosser       copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
467ecff11dcSJohannes Doerfert }
468ecff11dcSJohannes Doerfert 
469800e17a7SJohannes Doerfert Value *BlockGenerator::getOrCreateAlloca(const MemoryAccess &Access) {
470587f1f57STobias Grosser   assert(!Access.isLatestArrayKind() && "Trying to get alloca for array kind");
4713216f854STobias Grosser 
472587f1f57STobias Grosser   return getOrCreateAlloca(Access.getLatestScopArrayInfo());
473a4f0988dSTobias Grosser }
474a4f0988dSTobias Grosser 
475a4f0988dSTobias Grosser Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
4763216f854STobias Grosser   assert(!Array->isArrayKind() && "Trying to get alloca for array kind");
4773216f854STobias Grosser 
478587f1f57STobias Grosser   auto &Addr = ScalarMap[Array];
479587f1f57STobias Grosser 
480587f1f57STobias Grosser   if (Addr) {
481587f1f57STobias Grosser     // Allow allocas to be (temporarily) redirected once by adding a new
482a6d48f59SMichael Kruse     // old-alloca-addr to new-addr mapping to GlobalMap. This functionality
483587f1f57STobias Grosser     // is used for example by the OpenMP code generation where a first use
484587f1f57STobias Grosser     // of a scalar while still in the host code allocates a normal alloca with
485587f1f57STobias Grosser     // getOrCreateAlloca. When the values of this scalar are accessed during
486587f1f57STobias Grosser     // the generation of the parallel subfunction, these values are copied over
487587f1f57STobias Grosser     // to the parallel subfunction and each request for a scalar alloca slot
488a6d48f59SMichael Kruse     // must be forwarded to the temporary in-subfunction slot. This mapping is
489587f1f57STobias Grosser     // removed when the subfunction has been generated and again normal host
490682c5114STobias Grosser     // code is generated. Due to the following reasons it is not possible to
491682c5114STobias Grosser     // perform the GlobalMap lookup right after creating the alloca below, but
492682c5114STobias Grosser     // instead we need to check GlobalMap at each call to getOrCreateAlloca:
493682c5114STobias Grosser     //
494682c5114STobias Grosser     //   1) GlobalMap may be changed multiple times (for each parallel loop),
495682c5114STobias Grosser     //   2) The temporary mapping is commonly only known after the initial
496682c5114STobias Grosser     //      alloca has already been generated, and
497682c5114STobias Grosser     //   3) The original alloca value must be restored after leaving the
498682c5114STobias Grosser     //      sub-function.
499587f1f57STobias Grosser     if (Value *NewAddr = GlobalMap.lookup(&*Addr))
500587f1f57STobias Grosser       return NewAddr;
501587f1f57STobias Grosser     return Addr;
502587f1f57STobias Grosser   }
503587f1f57STobias Grosser 
504587f1f57STobias Grosser   Type *Ty = Array->getElementType();
505587f1f57STobias Grosser   Value *ScalarBase = Array->getBasePtr();
506587f1f57STobias Grosser   std::string NameExt;
507a535dff4STobias Grosser   if (Array->isPHIKind())
508587f1f57STobias Grosser     NameExt = ".phiops";
509f8d55f7eSTobias Grosser   else
510587f1f57STobias Grosser     NameExt = ".s2a";
511587f1f57STobias Grosser 
5127b5a4dfdSTobias Grosser   const DataLayout &DL = Builder.GetInsertBlock()->getModule()->getDataLayout();
513b3e30c32SMatt Arsenault 
514b3e30c32SMatt Arsenault   Addr = new AllocaInst(Ty, DL.getAllocaAddrSpace(),
515b3e30c32SMatt Arsenault                         ScalarBase->getName() + NameExt);
516587f1f57STobias Grosser   EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
517587f1f57STobias Grosser   Addr->insertBefore(&*EntryBB->getFirstInsertionPt());
518587f1f57STobias Grosser 
519587f1f57STobias Grosser   return Addr;
520f8d55f7eSTobias Grosser }
521f8d55f7eSTobias Grosser 
522587f1f57STobias Grosser void BlockGenerator::handleOutsideUsers(const Scop &S, ScopArrayInfo *Array) {
523587f1f57STobias Grosser   Instruction *Inst = cast<Instruction>(Array->getBasePtr());
524b79a67dfSTobias Grosser 
5252985400aSTobias Grosser   // If there are escape users we get the alloca for this instruction and put it
5262985400aSTobias Grosser   // in the EscapeMap for later finalization. Lastly, if the instruction was
5272985400aSTobias Grosser   // copied multiple times we already did this and can exit.
528acb6ade7SMichael Kruse   if (EscapeMap.count(Inst))
529acb6ade7SMichael Kruse     return;
530e69e1141SJohannes Doerfert 
531ecff11dcSJohannes Doerfert   EscapeUserVectorTy EscapeUsers;
532ecff11dcSJohannes Doerfert   for (User *U : Inst->users()) {
533ecff11dcSJohannes Doerfert 
534ecff11dcSJohannes Doerfert     // Non-instruction user will never escape.
535ecff11dcSJohannes Doerfert     Instruction *UI = dyn_cast<Instruction>(U);
536ecff11dcSJohannes Doerfert     if (!UI)
537ecff11dcSJohannes Doerfert       continue;
538ecff11dcSJohannes Doerfert 
539952b5304SJohannes Doerfert     if (S.contains(UI))
540ecff11dcSJohannes Doerfert       continue;
541ecff11dcSJohannes Doerfert 
542ecff11dcSJohannes Doerfert     EscapeUsers.push_back(UI);
543ecff11dcSJohannes Doerfert   }
544ecff11dcSJohannes Doerfert 
545ecff11dcSJohannes Doerfert   // Exit if no escape uses were found.
546ecff11dcSJohannes Doerfert   if (EscapeUsers.empty())
547ecff11dcSJohannes Doerfert     return;
548ecff11dcSJohannes Doerfert 
549ecff11dcSJohannes Doerfert   // Get or create an escape alloca for this instruction.
550587f1f57STobias Grosser   auto *ScalarAddr = getOrCreateAlloca(Array);
551ecff11dcSJohannes Doerfert 
552ecff11dcSJohannes Doerfert   // Remember that this instruction has escape uses and the escape alloca.
553ecff11dcSJohannes Doerfert   EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
554ecff11dcSJohannes Doerfert }
555ecff11dcSJohannes Doerfert 
5562fa35194SMichael Kruse void BlockGenerator::generateScalarLoads(
5572fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
5582fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
559225f0d1eSMichael Kruse   for (MemoryAccess *MA : Stmt) {
5602fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isWrite())
561ecff11dcSJohannes Doerfert       continue;
562ecff11dcSJohannes Doerfert 
56377394f13SMichael Kruse #ifndef NDEBUG
5644485ae08SMichael Kruse     auto StmtDom =
5654485ae08SMichael Kruse         Stmt.getDomain().intersect_params(Stmt.getParent()->getContext());
566388730c9SMichael Kruse     auto AccDom = MA->getAccessRelation().domain();
567388730c9SMichael Kruse     assert(!StmtDom.is_subset(AccDom).is_false() &&
56877394f13SMichael Kruse            "Scalar must be loaded in all statement instances");
56977394f13SMichael Kruse #endif
57077394f13SMichael Kruse 
5712fa35194SMichael Kruse     auto *Address =
5722fa35194SMichael Kruse         getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS, BBMap, NewAccesses);
573eac9726eSMichael Kruse     assert((!isa<Instruction>(Address) ||
574eac9726eSMichael Kruse             DT.dominates(cast<Instruction>(Address)->getParent(),
575eac9726eSMichael Kruse                          Builder.GetInsertBlock())) &&
576eac9726eSMichael Kruse            "Domination violation");
577583be06fSTobias Grosser     BBMap[MA->getAccessValue()] =
5782fc50df9STobias Grosser         Builder.CreateLoad(Address, Address->getName() + ".reload");
579ecff11dcSJohannes Doerfert   }
580ecff11dcSJohannes Doerfert }
581ecff11dcSJohannes Doerfert 
582706f79abSMichael Kruse Value *BlockGenerator::buildContainsCondition(ScopStmt &Stmt,
583706f79abSMichael Kruse                                               const isl::set &Subdomain) {
584132860afSTobias Grosser   isl::ast_build AstBuild = Stmt.getAstBuild();
585dcf8d696STobias Grosser   isl::set Domain = Stmt.getDomain();
586706f79abSMichael Kruse 
5876b6ac900STobias Grosser   isl::union_map USchedule = AstBuild.get_schedule();
5886b6ac900STobias Grosser   USchedule = USchedule.intersect_domain(Domain);
589706f79abSMichael Kruse 
5906b6ac900STobias Grosser   assert(!USchedule.is_empty());
5916b6ac900STobias Grosser   isl::map Schedule = isl::map::from_union_map(USchedule);
592706f79abSMichael Kruse 
5936b6ac900STobias Grosser   isl::set ScheduledDomain = Schedule.range();
5946b6ac900STobias Grosser   isl::set ScheduledSet = Subdomain.apply(Schedule);
595706f79abSMichael Kruse 
5966b6ac900STobias Grosser   isl::ast_build RestrictedBuild = AstBuild.restrict(ScheduledDomain);
5976b6ac900STobias Grosser 
5986b6ac900STobias Grosser   isl::ast_expr IsInSet = RestrictedBuild.expr_from(ScheduledSet);
599706f79abSMichael Kruse   Value *IsInSetExpr = ExprBuilder->create(IsInSet.copy());
600706f79abSMichael Kruse   IsInSetExpr = Builder.CreateICmpNE(
601706f79abSMichael Kruse       IsInSetExpr, ConstantInt::get(IsInSetExpr->getType(), 0));
602706f79abSMichael Kruse 
603706f79abSMichael Kruse   return IsInSetExpr;
604706f79abSMichael Kruse }
605706f79abSMichael Kruse 
606706f79abSMichael Kruse void BlockGenerator::generateConditionalExecution(
607706f79abSMichael Kruse     ScopStmt &Stmt, const isl::set &Subdomain, StringRef Subject,
608706f79abSMichael Kruse     const std::function<void()> &GenThenFunc) {
609dcf8d696STobias Grosser   isl::set StmtDom = Stmt.getDomain();
610706f79abSMichael Kruse 
611706f79abSMichael Kruse   // If the condition is a tautology, don't generate a condition around the
612706f79abSMichael Kruse   // code.
613f51decb5STobias Grosser   bool IsPartialWrite =
6148ea1fc19STobias Grosser       !StmtDom.intersect_params(Stmt.getParent()->getContext())
615f51decb5STobias Grosser            .is_subset(Subdomain);
616f51decb5STobias Grosser   if (!IsPartialWrite) {
617706f79abSMichael Kruse     GenThenFunc();
618706f79abSMichael Kruse     return;
619706f79abSMichael Kruse   }
620706f79abSMichael Kruse 
621706f79abSMichael Kruse   // Generate the condition.
622706f79abSMichael Kruse   Value *Cond = buildContainsCondition(Stmt, Subdomain);
623b795bfc0SMichael Kruse 
624b795bfc0SMichael Kruse   // Don't call GenThenFunc if it is never executed. An ast index expression
625b795bfc0SMichael Kruse   // might not be defined in this case.
626b795bfc0SMichael Kruse   if (auto *Const = dyn_cast<ConstantInt>(Cond))
627b795bfc0SMichael Kruse     if (Const->isZero())
628b795bfc0SMichael Kruse       return;
629b795bfc0SMichael Kruse 
630706f79abSMichael Kruse   BasicBlock *HeadBlock = Builder.GetInsertBlock();
631706f79abSMichael Kruse   StringRef BlockName = HeadBlock->getName();
632706f79abSMichael Kruse 
633706f79abSMichael Kruse   // Generate the conditional block.
634706f79abSMichael Kruse   SplitBlockAndInsertIfThen(Cond, &*Builder.GetInsertPoint(), false, nullptr,
635706f79abSMichael Kruse                             &DT, &LI);
636706f79abSMichael Kruse   BranchInst *Branch = cast<BranchInst>(HeadBlock->getTerminator());
637706f79abSMichael Kruse   BasicBlock *ThenBlock = Branch->getSuccessor(0);
638706f79abSMichael Kruse   BasicBlock *TailBlock = Branch->getSuccessor(1);
639706f79abSMichael Kruse 
640706f79abSMichael Kruse   // Assign descriptive names.
641706f79abSMichael Kruse   if (auto *CondInst = dyn_cast<Instruction>(Cond))
642706f79abSMichael Kruse     CondInst->setName("polly." + Subject + ".cond");
643706f79abSMichael Kruse   ThenBlock->setName(BlockName + "." + Subject + ".partial");
644706f79abSMichael Kruse   TailBlock->setName(BlockName + ".cont");
645706f79abSMichael Kruse 
646706f79abSMichael Kruse   // Put the client code into the conditional block and continue in the merge
647706f79abSMichael Kruse   // block afterwards.
648706f79abSMichael Kruse   Builder.SetInsertPoint(ThenBlock, ThenBlock->getFirstInsertionPt());
649706f79abSMichael Kruse   GenThenFunc();
650706f79abSMichael Kruse   Builder.SetInsertPoint(TailBlock, TailBlock->getFirstInsertionPt());
651706f79abSMichael Kruse }
652706f79abSMichael Kruse 
653e819fffeSMichael Kruse static std::string getInstName(Value *Val) {
654e819fffeSMichael Kruse   std::string Result;
655e819fffeSMichael Kruse   raw_string_ostream OS(Result);
656e819fffeSMichael Kruse   Val->printAsOperand(OS, false);
657e819fffeSMichael Kruse   return OS.str();
658e819fffeSMichael Kruse }
659e819fffeSMichael Kruse 
660e819fffeSMichael Kruse void BlockGenerator::generateBeginStmtTrace(ScopStmt &Stmt, LoopToScevMapT &LTS,
661e819fffeSMichael Kruse                                             ValueMapT &BBMap) {
662e819fffeSMichael Kruse   if (!TraceStmts)
663e819fffeSMichael Kruse     return;
664e819fffeSMichael Kruse 
665e819fffeSMichael Kruse   Scop *S = Stmt.getParent();
666e819fffeSMichael Kruse   const char *BaseName = Stmt.getBaseName();
667e819fffeSMichael Kruse 
668e819fffeSMichael Kruse   isl::ast_build AstBuild = Stmt.getAstBuild();
669e819fffeSMichael Kruse   isl::set Domain = Stmt.getDomain();
670e819fffeSMichael Kruse 
671e819fffeSMichael Kruse   isl::union_map USchedule = AstBuild.get_schedule().intersect_domain(Domain);
672e819fffeSMichael Kruse   isl::map Schedule = isl::map::from_union_map(USchedule);
673e819fffeSMichael Kruse   assert(Schedule.is_empty().is_false() &&
674e819fffeSMichael Kruse          "The stmt must have a valid instance");
675e819fffeSMichael Kruse 
676e819fffeSMichael Kruse   isl::multi_pw_aff ScheduleMultiPwAff =
677e819fffeSMichael Kruse       isl::pw_multi_aff::from_map(Schedule.reverse());
678e819fffeSMichael Kruse   isl::ast_build RestrictedBuild = AstBuild.restrict(Schedule.range());
679e819fffeSMichael Kruse 
680e819fffeSMichael Kruse   // Sequence of strings to print.
681e819fffeSMichael Kruse   SmallVector<llvm::Value *, 8> Values;
682e819fffeSMichael Kruse 
683e819fffeSMichael Kruse   // Print the name of the statement.
684e819fffeSMichael Kruse   // TODO: Indent by the depth of the statement instance in the schedule tree.
685e819fffeSMichael Kruse   Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, BaseName));
686e819fffeSMichael Kruse   Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "("));
687e819fffeSMichael Kruse 
688e819fffeSMichael Kruse   // Add the coordinate of the statement instance.
689e819fffeSMichael Kruse   int DomDims = ScheduleMultiPwAff.dim(isl::dim::out);
690e819fffeSMichael Kruse   for (int i = 0; i < DomDims; i += 1) {
691e819fffeSMichael Kruse     if (i > 0)
692e819fffeSMichael Kruse       Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ","));
693e819fffeSMichael Kruse 
694e819fffeSMichael Kruse     isl::ast_expr IsInSet =
695e819fffeSMichael Kruse         RestrictedBuild.expr_from(ScheduleMultiPwAff.get_pw_aff(i));
696e819fffeSMichael Kruse     Values.push_back(ExprBuilder->create(IsInSet.copy()));
697e819fffeSMichael Kruse   }
698e819fffeSMichael Kruse 
699e819fffeSMichael Kruse   if (TraceScalars) {
700e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")"));
701e819fffeSMichael Kruse     DenseSet<Instruction *> Encountered;
702e819fffeSMichael Kruse 
703e819fffeSMichael Kruse     // Add the value of each scalar (and the result of PHIs) used in the
704e819fffeSMichael Kruse     // statement.
705e819fffeSMichael Kruse     // TODO: Values used in region-statements.
706e819fffeSMichael Kruse     for (Instruction *Inst : Stmt.insts()) {
707e819fffeSMichael Kruse       if (!RuntimeDebugBuilder::isPrintable(Inst->getType()))
708e819fffeSMichael Kruse         continue;
709e819fffeSMichael Kruse 
710e819fffeSMichael Kruse       if (isa<PHINode>(Inst)) {
711e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, " "));
712e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(
713e819fffeSMichael Kruse             Builder, getInstName(Inst)));
714e819fffeSMichael Kruse         Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "="));
715e819fffeSMichael Kruse         Values.push_back(getNewValue(Stmt, Inst, BBMap, LTS,
716e819fffeSMichael Kruse                                      LI.getLoopFor(Inst->getParent())));
717e819fffeSMichael Kruse       } else {
718e819fffeSMichael Kruse         for (Value *Op : Inst->operand_values()) {
719e819fffeSMichael Kruse           // Do not print values that cannot change during the execution of the
720e819fffeSMichael Kruse           // SCoP.
721e819fffeSMichael Kruse           auto *OpInst = dyn_cast<Instruction>(Op);
722e819fffeSMichael Kruse           if (!OpInst)
723e819fffeSMichael Kruse             continue;
724e819fffeSMichael Kruse           if (!S->contains(OpInst))
725e819fffeSMichael Kruse             continue;
726e819fffeSMichael Kruse 
727e819fffeSMichael Kruse           // Print each scalar at most once, and exclude values defined in the
728e819fffeSMichael Kruse           // statement itself.
729e819fffeSMichael Kruse           if (Encountered.count(OpInst))
730e819fffeSMichael Kruse             continue;
731e819fffeSMichael Kruse 
732e819fffeSMichael Kruse           Values.push_back(
733e819fffeSMichael Kruse               RuntimeDebugBuilder::getPrintableString(Builder, " "));
734e819fffeSMichael Kruse           Values.push_back(RuntimeDebugBuilder::getPrintableString(
735e819fffeSMichael Kruse               Builder, getInstName(OpInst)));
736e819fffeSMichael Kruse           Values.push_back(
737e819fffeSMichael Kruse               RuntimeDebugBuilder::getPrintableString(Builder, "="));
738e819fffeSMichael Kruse           Values.push_back(getNewValue(Stmt, OpInst, BBMap, LTS,
739e819fffeSMichael Kruse                                        LI.getLoopFor(Inst->getParent())));
740e819fffeSMichael Kruse           Encountered.insert(OpInst);
741e819fffeSMichael Kruse         }
742e819fffeSMichael Kruse       }
743e819fffeSMichael Kruse 
744e819fffeSMichael Kruse       Encountered.insert(Inst);
745e819fffeSMichael Kruse     }
746e819fffeSMichael Kruse 
747e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "\n"));
748e819fffeSMichael Kruse   } else {
749e819fffeSMichael Kruse     Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")\n"));
750e819fffeSMichael Kruse   }
751e819fffeSMichael Kruse 
752e819fffeSMichael Kruse   RuntimeDebugBuilder::createCPUPrinter(Builder, ArrayRef<Value *>(Values));
753e819fffeSMichael Kruse }
754e819fffeSMichael Kruse 
7552fa35194SMichael Kruse void BlockGenerator::generateScalarStores(
7562fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
7572fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
758f2cdd144STobias Grosser   Loop *L = LI.getLoopFor(Stmt.getBasicBlock());
759ecff11dcSJohannes Doerfert 
76021a059afSTobias Grosser   assert(Stmt.isBlockStmt() &&
76121a059afSTobias Grosser          "Region statements need to use the generateScalarStores() function in "
76221a059afSTobias Grosser          "the RegionGenerator");
763ecff11dcSJohannes Doerfert 
764ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
7652fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isRead())
766ecff11dcSJohannes Doerfert       continue;
767ecff11dcSJohannes Doerfert 
7681515f6b9STobias Grosser     isl::set AccDom = MA->getAccessRelation().domain();
769fe46c3ffSTobias Grosser     std::string Subject = MA->getId().get_name();
77077394f13SMichael Kruse 
771fe46c3ffSTobias Grosser     generateConditionalExecution(
772fe46c3ffSTobias Grosser         Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
773d86f2157SJohannes Doerfert           Value *Val = MA->getAccessValue();
774ee6a4fc6SMichael Kruse           if (MA->isAnyPHIKind()) {
775fe46c3ffSTobias Grosser             assert(MA->getIncoming().size() >= 1 &&
776fe46c3ffSTobias Grosser                    "Block statements have exactly one exiting block, or "
777fe46c3ffSTobias Grosser                    "multiple but "
778ee6a4fc6SMichael Kruse                    "with same incoming block and value");
779fe46c3ffSTobias Grosser             assert(std::all_of(MA->getIncoming().begin(),
780fe46c3ffSTobias Grosser                                MA->getIncoming().end(),
781ee6a4fc6SMichael Kruse                                [&](std::pair<BasicBlock *, Value *> p) -> bool {
782ee6a4fc6SMichael Kruse                                  return p.first == Stmt.getBasicBlock();
783ee6a4fc6SMichael Kruse                                }) &&
784ee6a4fc6SMichael Kruse                    "Incoming block must be statement's block");
785ee6a4fc6SMichael Kruse             Val = MA->getIncoming()[0].second;
786ee6a4fc6SMichael Kruse           }
787fe46c3ffSTobias Grosser           auto Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
788fe46c3ffSTobias Grosser                                             BBMap, NewAccesses);
789d86f2157SJohannes Doerfert 
790f2cdd144STobias Grosser           Val = getNewValue(Stmt, Val, BBMap, LTS, L);
791eac9726eSMichael Kruse           assert((!isa<Instruction>(Val) ||
792eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Val)->getParent(),
793eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
794eac9726eSMichael Kruse                  "Domination violation");
795eac9726eSMichael Kruse           assert((!isa<Instruction>(Address) ||
796eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Address)->getParent(),
797eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
798eac9726eSMichael Kruse                  "Domination violation");
7992f5cbc44SMichael Kruse 
8002f5cbc44SMichael Kruse           // The new Val might have a different type than the old Val due to
8012f5cbc44SMichael Kruse           // ScalarEvolution looking through bitcasts.
8022f5cbc44SMichael Kruse           if (Val->getType() != Address->getType()->getPointerElementType())
8032f5cbc44SMichael Kruse             Address = Builder.CreateBitOrPointerCast(
8042f5cbc44SMichael Kruse                 Address, Val->getType()->getPointerTo());
8052f5cbc44SMichael Kruse 
80692245228STobias Grosser           Builder.CreateStore(Val, Address);
807706f79abSMichael Kruse         });
808ecff11dcSJohannes Doerfert   }
809ecff11dcSJohannes Doerfert }
810ecff11dcSJohannes Doerfert 
811c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
812ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExit();
813acf80064SEli Friedman   BasicBlock *PreEntryBB = S.getEnteringBlock();
814188542fdSJohannes Doerfert 
815acf80064SEli Friedman   Builder.SetInsertPoint(&*StartBlock->begin());
816ecff11dcSJohannes Doerfert 
817d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
818c0091a77STobias Grosser     if (Array->getNumberOfDimensions() != 0)
819c0091a77STobias Grosser       continue;
820a535dff4STobias Grosser     if (Array->isPHIKind()) {
821c0091a77STobias Grosser       // For PHI nodes, the only values we need to store are the ones that
822c0091a77STobias Grosser       // reach the PHI node from outside the region. In general there should
823c0091a77STobias Grosser       // only be one such incoming edge and this edge should enter through
824acf80064SEli Friedman       // 'PreEntryBB'.
825c0091a77STobias Grosser       auto PHI = cast<PHINode>(Array->getBasePtr());
826ecff11dcSJohannes Doerfert 
827c0091a77STobias Grosser       for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
828acf80064SEli Friedman         if (!S.contains(*BI) && *BI != PreEntryBB)
829c0091a77STobias Grosser           llvm_unreachable("Incoming edges from outside the scop should always "
830acf80064SEli Friedman                            "come from PreEntryBB");
831c0091a77STobias Grosser 
832acf80064SEli Friedman       int Idx = PHI->getBasicBlockIndex(PreEntryBB);
833c0091a77STobias Grosser       if (Idx < 0)
834ecff11dcSJohannes Doerfert         continue;
835ecff11dcSJohannes Doerfert 
836c0091a77STobias Grosser       Value *ScalarValue = PHI->getIncomingValue(Idx);
837ecff11dcSJohannes Doerfert 
838587f1f57STobias Grosser       Builder.CreateStore(ScalarValue, getOrCreateAlloca(Array));
839c0091a77STobias Grosser       continue;
840c0091a77STobias Grosser     }
841c0091a77STobias Grosser 
842c0091a77STobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
843c0091a77STobias Grosser 
844952b5304SJohannes Doerfert     if (Inst && S.contains(Inst))
845c0091a77STobias Grosser       continue;
846c0091a77STobias Grosser 
847188542fdSJohannes Doerfert     // PHI nodes that are not marked as such in their SAI object are either exit
848188542fdSJohannes Doerfert     // PHI nodes we model as common scalars but without initialization, or
849188542fdSJohannes Doerfert     // incoming phi nodes that need to be initialized. Check if the first is the
850188542fdSJohannes Doerfert     // case for Inst and do not create and initialize memory if so.
851188542fdSJohannes Doerfert     if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
852188542fdSJohannes Doerfert       if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
853717b8667SJohannes Doerfert         continue;
854717b8667SJohannes Doerfert 
855587f1f57STobias Grosser     Builder.CreateStore(Array->getBasePtr(), getOrCreateAlloca(Array));
856ecff11dcSJohannes Doerfert   }
857ecff11dcSJohannes Doerfert }
858ecff11dcSJohannes Doerfert 
859ef74443cSJohannes Doerfert void BlockGenerator::createScalarFinalization(Scop &S) {
860ecff11dcSJohannes Doerfert   // The exit block of the __unoptimized__ region.
861ef74443cSJohannes Doerfert   BasicBlock *ExitBB = S.getExitingBlock();
862ecff11dcSJohannes Doerfert   // The merge block __just after__ the region and the optimized region.
863ef74443cSJohannes Doerfert   BasicBlock *MergeBB = S.getExit();
864ecff11dcSJohannes Doerfert 
865ecff11dcSJohannes Doerfert   // The exit block of the __optimized__ region.
866ecff11dcSJohannes Doerfert   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
867ecff11dcSJohannes Doerfert   if (OptExitBB == ExitBB)
868ecff11dcSJohannes Doerfert     OptExitBB = *(++pred_begin(MergeBB));
869ecff11dcSJohannes Doerfert 
870ecff11dcSJohannes Doerfert   Builder.SetInsertPoint(OptExitBB->getTerminator());
871ecff11dcSJohannes Doerfert   for (const auto &EscapeMapping : EscapeMap) {
872ecff11dcSJohannes Doerfert     // Extract the escaping instruction and the escaping users as well as the
873ecff11dcSJohannes Doerfert     // alloca the instruction was demoted to.
874fbde4355SMichael Kruse     Instruction *EscapeInst = EscapeMapping.first;
875fbde4355SMichael Kruse     const auto &EscapeMappingValue = EscapeMapping.second;
876ecff11dcSJohannes Doerfert     const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
87764c0ff41STobias Grosser     Value *ScalarAddr = EscapeMappingValue.first;
878ecff11dcSJohannes Doerfert 
879ecff11dcSJohannes Doerfert     // Reload the demoted instruction in the optimized version of the SCoP.
880d8b6ad25SJohannes Doerfert     Value *EscapeInstReload =
881ecff11dcSJohannes Doerfert         Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
882d8b6ad25SJohannes Doerfert     EscapeInstReload =
883d8b6ad25SJohannes Doerfert         Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
884ecff11dcSJohannes Doerfert 
885ecff11dcSJohannes Doerfert     // Create the merge PHI that merges the optimized and unoptimized version.
886ecff11dcSJohannes Doerfert     PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
887ecff11dcSJohannes Doerfert                                         EscapeInst->getName() + ".merge");
888b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
889ecff11dcSJohannes Doerfert 
890ecff11dcSJohannes Doerfert     // Add the respective values to the merge PHI.
891ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInstReload, OptExitBB);
892ecff11dcSJohannes Doerfert     MergePHI->addIncoming(EscapeInst, ExitBB);
893ecff11dcSJohannes Doerfert 
894ecff11dcSJohannes Doerfert     // The information of scalar evolution about the escaping instruction needs
895ecff11dcSJohannes Doerfert     // to be revoked so the new merged instruction will be used.
896ecff11dcSJohannes Doerfert     if (SE.isSCEVable(EscapeInst->getType()))
897ecff11dcSJohannes Doerfert       SE.forgetValue(EscapeInst);
898ecff11dcSJohannes Doerfert 
899ecff11dcSJohannes Doerfert     // Replace all uses of the demoted instruction with the merge PHI.
900ecff11dcSJohannes Doerfert     for (Instruction *EUser : EscapeUsers)
901ecff11dcSJohannes Doerfert       EUser->replaceUsesOfWith(EscapeInst, MergePHI);
902ecff11dcSJohannes Doerfert   }
903ecff11dcSJohannes Doerfert }
904ecff11dcSJohannes Doerfert 
905ffa2446fSTobias Grosser void BlockGenerator::findOutsideUsers(Scop &S) {
906d7754a12SRoman Gareev   for (auto &Array : S.arrays()) {
907ffa2446fSTobias Grosser 
908ffa2446fSTobias Grosser     if (Array->getNumberOfDimensions() != 0)
909ffa2446fSTobias Grosser       continue;
910ffa2446fSTobias Grosser 
911a535dff4STobias Grosser     if (Array->isPHIKind())
912ffa2446fSTobias Grosser       continue;
913ffa2446fSTobias Grosser 
914ffa2446fSTobias Grosser     auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
915ffa2446fSTobias Grosser 
916ffa2446fSTobias Grosser     if (!Inst)
917ffa2446fSTobias Grosser       continue;
918ffa2446fSTobias Grosser 
919ffa2446fSTobias Grosser     // Scop invariant hoisting moves some of the base pointers out of the scop.
920ffa2446fSTobias Grosser     // We can ignore these, as the invariant load hoisting already registers the
921ffa2446fSTobias Grosser     // relevant outside users.
922952b5304SJohannes Doerfert     if (!S.contains(Inst))
923ffa2446fSTobias Grosser       continue;
924ffa2446fSTobias Grosser 
925587f1f57STobias Grosser     handleOutsideUsers(S, Array);
926ffa2446fSTobias Grosser   }
927ffa2446fSTobias Grosser }
928ffa2446fSTobias Grosser 
92927d742daSTobias Grosser void BlockGenerator::createExitPHINodeMerges(Scop &S) {
93027d742daSTobias Grosser   if (S.hasSingleExitEdge())
93127d742daSTobias Grosser     return;
93227d742daSTobias Grosser 
933ef74443cSJohannes Doerfert   auto *ExitBB = S.getExitingBlock();
934ef74443cSJohannes Doerfert   auto *MergeBB = S.getExit();
93527d742daSTobias Grosser   auto *AfterMergeBB = MergeBB->getSingleSuccessor();
93627d742daSTobias Grosser   BasicBlock *OptExitBB = *(pred_begin(MergeBB));
93727d742daSTobias Grosser   if (OptExitBB == ExitBB)
93827d742daSTobias Grosser     OptExitBB = *(++pred_begin(MergeBB));
93927d742daSTobias Grosser 
94027d742daSTobias Grosser   Builder.SetInsertPoint(OptExitBB->getTerminator());
94127d742daSTobias Grosser 
942d7754a12SRoman Gareev   for (auto &SAI : S.arrays()) {
94327d742daSTobias Grosser     auto *Val = SAI->getBasePtr();
94427d742daSTobias Grosser 
945faedfcbfSMichael Kruse     // Only Value-like scalars need a merge PHI. Exit block PHIs receive either
946faedfcbfSMichael Kruse     // the original PHI's value or the reloaded incoming values from the
947faedfcbfSMichael Kruse     // generated code. An llvm::Value is merged between the original code's
948faedfcbfSMichael Kruse     // value or the generated one.
949fa53c86dSMichael Kruse     if (!SAI->isExitPHIKind())
950faedfcbfSMichael Kruse       continue;
951faedfcbfSMichael Kruse 
95227d742daSTobias Grosser     PHINode *PHI = dyn_cast<PHINode>(Val);
95327d742daSTobias Grosser     if (!PHI)
95427d742daSTobias Grosser       continue;
95527d742daSTobias Grosser 
956a3f6edaeSTobias Grosser     if (PHI->getParent() != AfterMergeBB)
95727d742daSTobias Grosser       continue;
95827d742daSTobias Grosser 
95927d742daSTobias Grosser     std::string Name = PHI->getName();
960587f1f57STobias Grosser     Value *ScalarAddr = getOrCreateAlloca(SAI);
96127d742daSTobias Grosser     Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
96227d742daSTobias Grosser     Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
96327d742daSTobias Grosser     Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
964faedfcbfSMichael Kruse     assert((!isa<Instruction>(OriginalValue) ||
965faedfcbfSMichael Kruse             cast<Instruction>(OriginalValue)->getParent() != MergeBB) &&
966faedfcbfSMichael Kruse            "Original value must no be one we just generated.");
96727d742daSTobias Grosser     auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
968b8f58b53SDuncan P. N. Exon Smith     MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
96927d742daSTobias Grosser     MergePHI->addIncoming(Reload, OptExitBB);
97027d742daSTobias Grosser     MergePHI->addIncoming(OriginalValue, ExitBB);
97127d742daSTobias Grosser     int Idx = PHI->getBasicBlockIndex(MergeBB);
97227d742daSTobias Grosser     PHI->setIncomingValue(Idx, MergePHI);
97327d742daSTobias Grosser   }
97427d742daSTobias Grosser }
97527d742daSTobias Grosser 
9761c184409STobias Grosser void BlockGenerator::invalidateScalarEvolution(Scop &S) {
9771c184409STobias Grosser   for (auto &Stmt : S)
978b3224adfSRoman Gareev     if (Stmt.isCopyStmt())
979b3224adfSRoman Gareev       continue;
980b3224adfSRoman Gareev     else if (Stmt.isBlockStmt())
9811c184409STobias Grosser       for (auto &Inst : *Stmt.getBasicBlock())
9821c184409STobias Grosser         SE.forgetValue(&Inst);
9831c184409STobias Grosser     else if (Stmt.isRegionStmt())
9841c184409STobias Grosser       for (auto *BB : Stmt.getRegion()->blocks())
9851c184409STobias Grosser         for (auto &Inst : *BB)
9861c184409STobias Grosser           SE.forgetValue(&Inst);
9871c184409STobias Grosser     else
9881c184409STobias Grosser       llvm_unreachable("Unexpected statement type found");
9891aad76c1SMichael Kruse 
9901aad76c1SMichael Kruse   // Invalidate SCEV of loops surrounding the EscapeUsers.
9911aad76c1SMichael Kruse   for (const auto &EscapeMapping : EscapeMap) {
9921aad76c1SMichael Kruse     const EscapeUserVectorTy &EscapeUsers = EscapeMapping.second.second;
9931aad76c1SMichael Kruse     for (Instruction *EUser : EscapeUsers) {
9941aad76c1SMichael Kruse       if (Loop *L = LI.getLoopFor(EUser->getParent()))
9951aad76c1SMichael Kruse         while (L) {
9961aad76c1SMichael Kruse           SE.forgetLoop(L);
9971aad76c1SMichael Kruse           L = L->getParentLoop();
9981aad76c1SMichael Kruse         }
9991aad76c1SMichael Kruse     }
10001aad76c1SMichael Kruse   }
10011c184409STobias Grosser }
10021c184409STobias Grosser 
1003ffa2446fSTobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
1004ffa2446fSTobias Grosser   findOutsideUsers(S);
1005c0091a77STobias Grosser   createScalarInitialization(S);
100627d742daSTobias Grosser   createExitPHINodeMerges(S);
1007ef74443cSJohannes Doerfert   createScalarFinalization(S);
10081c184409STobias Grosser   invalidateScalarEvolution(S);
10093b11a16aSHongbin Zheng }
10103b11a16aSHongbin Zheng 
1011be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
1012be9c9117SJohannes Doerfert                                            std::vector<LoopToScevMapT> &VLTS,
1013be9c9117SJohannes Doerfert                                            isl_map *Schedule)
1014bc132607STobias Grosser     : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
1015a00a0291SSebastian Pop   assert(Schedule && "No statement domain provided");
10163b11a16aSHongbin Zheng }
10173b11a16aSHongbin Zheng 
10182f1acac6STobias Grosser Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
1019e602a076STobias Grosser                                             ValueMapT &VectorMap,
1020e602a076STobias Grosser                                             VectorValueMapT &ScalarMaps,
1021e602a076STobias Grosser                                             Loop *L) {
1022fe11e287SHongbin Zheng   if (Value *NewValue = VectorMap.lookup(Old))
1023fe11e287SHongbin Zheng     return NewValue;
10243b11a16aSHongbin Zheng 
10253b11a16aSHongbin Zheng   int Width = getVectorWidth();
10263b11a16aSHongbin Zheng 
10273b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
10283b11a16aSHongbin Zheng 
10293b11a16aSHongbin Zheng   for (int Lane = 0; Lane < Width; Lane++)
1030c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
1031bc132607STobias Grosser         Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
10327242ad92STobias Grosser         Builder.getInt32(Lane));
10333b11a16aSHongbin Zheng 
10343b11a16aSHongbin Zheng   VectorMap[Old] = Vector;
10353b11a16aSHongbin Zheng 
10363b11a16aSHongbin Zheng   return Vector;
10373b11a16aSHongbin Zheng }
10383b11a16aSHongbin Zheng 
10393b11a16aSHongbin Zheng Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
10403b11a16aSHongbin Zheng   PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
10413b11a16aSHongbin Zheng   assert(PointerTy && "PointerType expected");
10423b11a16aSHongbin Zheng 
10433b11a16aSHongbin Zheng   Type *ScalarType = PointerTy->getElementType();
10443b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(ScalarType, Width);
10453b11a16aSHongbin Zheng 
10463b11a16aSHongbin Zheng   return PointerType::getUnqual(VectorType);
10473b11a16aSHongbin Zheng }
10483b11a16aSHongbin Zheng 
1049be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
10502f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
10512d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
10520dd463faSTobias Grosser   unsigned VectorWidth = getVectorWidth();
10539646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
10540dd463faSTobias Grosser   Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
10550dd463faSTobias Grosser   unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
10560dd463faSTobias Grosser 
10578f25b0cbSMichael Kruse   Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[Offset],
1058bc132607STobias Grosser                                                VLTS[Offset], NewAccesses);
1059c14582f2STobias Grosser   Value *VectorPtr =
1060c14582f2STobias Grosser       Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
1061c14582f2STobias Grosser   LoadInst *VecLoad =
1062c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
10633b11a16aSHongbin Zheng   if (!Aligned)
10643b11a16aSHongbin Zheng     VecLoad->setAlignment(8);
10653b11a16aSHongbin Zheng 
10660dd463faSTobias Grosser   if (NegativeStride) {
10670dd463faSTobias Grosser     SmallVector<Constant *, 16> Indices;
10680dd463faSTobias Grosser     for (int i = VectorWidth - 1; i >= 0; i--)
10690dd463faSTobias Grosser       Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
10700dd463faSTobias Grosser     Constant *SV = llvm::ConstantVector::get(Indices);
10710dd463faSTobias Grosser     Value *RevVecLoad = Builder.CreateShuffleVector(
10720dd463faSTobias Grosser         VecLoad, VecLoad, SV, Load->getName() + "_reverse");
10730dd463faSTobias Grosser     return RevVecLoad;
10740dd463faSTobias Grosser   }
10750dd463faSTobias Grosser 
10763b11a16aSHongbin Zheng   return VecLoad;
10773b11a16aSHongbin Zheng }
10783b11a16aSHongbin Zheng 
10792d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
10802f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
10812d1ed0bfSTobias Grosser     __isl_keep isl_id_to_ast_expr *NewAccesses) {
10829646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
10833b11a16aSHongbin Zheng   Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
108470131d34SMichael Kruse   Value *NewPointer =
108570131d34SMichael Kruse       generateLocationAccessed(Stmt, Load, BBMap, VLTS[0], NewAccesses);
10863b11a16aSHongbin Zheng   Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
10873b11a16aSHongbin Zheng                                            Load->getName() + "_p_vec_p");
1088c14582f2STobias Grosser   LoadInst *ScalarLoad =
1089c14582f2STobias Grosser       Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
10903b11a16aSHongbin Zheng 
10913b11a16aSHongbin Zheng   if (!Aligned)
10923b11a16aSHongbin Zheng     ScalarLoad->setAlignment(8);
10933b11a16aSHongbin Zheng 
1094c14582f2STobias Grosser   Constant *SplatVector = Constant::getNullValue(
1095c14582f2STobias Grosser       VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
10963b11a16aSHongbin Zheng 
1097c14582f2STobias Grosser   Value *VectorLoad = Builder.CreateShuffleVector(
1098c14582f2STobias Grosser       ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
10993b11a16aSHongbin Zheng   return VectorLoad;
11003b11a16aSHongbin Zheng }
11013b11a16aSHongbin Zheng 
1102be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
11032f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
110409e3697fSJohannes Doerfert     __isl_keep isl_id_to_ast_expr *NewAccesses) {
11053b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
11069646e3feSTobias Grosser   auto *Pointer = Load->getPointerOperand();
11073b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(
11083b11a16aSHongbin Zheng       dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
11093b11a16aSHongbin Zheng 
11103b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
11113b11a16aSHongbin Zheng 
11123b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++) {
111370131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[i],
111470131d34SMichael Kruse                                                  VLTS[i], NewAccesses);
1115c14582f2STobias Grosser     Value *ScalarLoad =
1116c14582f2STobias Grosser         Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
1117c14582f2STobias Grosser     Vector = Builder.CreateInsertElement(
1118c14582f2STobias Grosser         Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
11193b11a16aSHongbin Zheng   }
11203b11a16aSHongbin Zheng 
11213b11a16aSHongbin Zheng   return Vector;
11223b11a16aSHongbin Zheng }
11233b11a16aSHongbin Zheng 
11242d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
11252f1acac6STobias Grosser     ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
11262d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1127c1db67e2SJohannes Doerfert   if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
1128c1db67e2SJohannes Doerfert     VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
1129c1db67e2SJohannes Doerfert                                                 Load->getName() + "_p");
1130c1db67e2SJohannes Doerfert     return;
1131c1db67e2SJohannes Doerfert   }
1132c1db67e2SJohannes Doerfert 
11332873645cSTobias Grosser   if (!VectorType::isValidElementType(Load->getType())) {
11343b11a16aSHongbin Zheng     for (int i = 0; i < getVectorWidth(); i++)
1135bc132607STobias Grosser       ScalarMaps[i][Load] =
1136888ab551SMichael Kruse           generateArrayLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
11373b11a16aSHongbin Zheng     return;
11383b11a16aSHongbin Zheng   }
11393b11a16aSHongbin Zheng 
1140184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Load);
11413b11a16aSHongbin Zheng 
114295493984STobias Grosser   // Make sure we have scalar values available to access the pointer to
114395493984STobias Grosser   // the data location.
114495493984STobias Grosser   extractScalarValues(Load, VectorMap, ScalarMaps);
114595493984STobias Grosser 
11463b11a16aSHongbin Zheng   Value *NewLoad;
1147718d04c6STobias Grosser   if (Access.isStrideZero(isl::manage_copy(Schedule)))
11482d1ed0bfSTobias Grosser     NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
1149718d04c6STobias Grosser   else if (Access.isStrideOne(isl::manage_copy(Schedule)))
11502d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
1151718d04c6STobias Grosser   else if (Access.isStrideX(isl::manage_copy(Schedule), -1))
11522d1ed0bfSTobias Grosser     NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
11533b11a16aSHongbin Zheng   else
11542d1ed0bfSTobias Grosser     NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
11553b11a16aSHongbin Zheng 
11563b11a16aSHongbin Zheng   VectorMap[Load] = NewLoad;
11573b11a16aSHongbin Zheng }
11583b11a16aSHongbin Zheng 
11592f1acac6STobias Grosser void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
11603b11a16aSHongbin Zheng                                          ValueMapT &VectorMap,
11613b11a16aSHongbin Zheng                                          VectorValueMapT &ScalarMaps) {
11623b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
1163be9c9117SJohannes Doerfert   Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
11642c3ffc04SJohannes Doerfert                                      ScalarMaps, getLoopForStmt(Stmt));
11653b11a16aSHongbin Zheng 
11663b11a16aSHongbin Zheng   assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
11673b11a16aSHongbin Zheng 
11683b11a16aSHongbin Zheng   const CastInst *Cast = dyn_cast<CastInst>(Inst);
11693b11a16aSHongbin Zheng   VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
11703b11a16aSHongbin Zheng   VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
11713b11a16aSHongbin Zheng }
11723b11a16aSHongbin Zheng 
11732f1acac6STobias Grosser void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
11743b11a16aSHongbin Zheng                                           ValueMapT &VectorMap,
11753b11a16aSHongbin Zheng                                           VectorValueMapT &ScalarMaps) {
11762c3ffc04SJohannes Doerfert   Loop *L = getLoopForStmt(Stmt);
11773b11a16aSHongbin Zheng   Value *OpZero = Inst->getOperand(0);
11783b11a16aSHongbin Zheng   Value *OpOne = Inst->getOperand(1);
11793b11a16aSHongbin Zheng 
11803b11a16aSHongbin Zheng   Value *NewOpZero, *NewOpOne;
1181be9c9117SJohannes Doerfert   NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
1182be9c9117SJohannes Doerfert   NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
11833b11a16aSHongbin Zheng 
11841bb59b0dSTobias Grosser   Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
11853b11a16aSHongbin Zheng                                        Inst->getName() + "p_vec");
11863b11a16aSHongbin Zheng   VectorMap[Inst] = NewInst;
11873b11a16aSHongbin Zheng }
11883b11a16aSHongbin Zheng 
11892d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
11902f1acac6STobias Grosser     ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
11912d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1192184a4926STobias Grosser   const MemoryAccess &Access = Stmt.getArrayAccessFor(Store);
11933b11a16aSHongbin Zheng 
11949646e3feSTobias Grosser   auto *Pointer = Store->getPointerOperand();
1195be9c9117SJohannes Doerfert   Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
11962c3ffc04SJohannes Doerfert                                  ScalarMaps, getLoopForStmt(Stmt));
11973b11a16aSHongbin Zheng 
119850fd7010STobias Grosser   // Make sure we have scalar values available to access the pointer to
119950fd7010STobias Grosser   // the data location.
120050fd7010STobias Grosser   extractScalarValues(Store, VectorMap, ScalarMaps);
120150fd7010STobias Grosser 
1202718d04c6STobias Grosser   if (Access.isStrideOne(isl::manage_copy(Schedule))) {
12031947f863SJohannes Doerfert     Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
120470131d34SMichael Kruse     Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[0],
120570131d34SMichael Kruse                                                  VLTS[0], NewAccesses);
12063b11a16aSHongbin Zheng 
1207c14582f2STobias Grosser     Value *VectorPtr =
1208c14582f2STobias Grosser         Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
12093b11a16aSHongbin Zheng     StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
12103b11a16aSHongbin Zheng 
12113b11a16aSHongbin Zheng     if (!Aligned)
12123b11a16aSHongbin Zheng       Store->setAlignment(8);
12133b11a16aSHongbin Zheng   } else {
12143b11a16aSHongbin Zheng     for (unsigned i = 0; i < ScalarMaps.size(); i++) {
12151bb59b0dSTobias Grosser       Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
121670131d34SMichael Kruse       Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[i],
121770131d34SMichael Kruse                                                    VLTS[i], NewAccesses);
12183b11a16aSHongbin Zheng       Builder.CreateStore(Scalar, NewPointer);
12193b11a16aSHongbin Zheng     }
12203b11a16aSHongbin Zheng   }
12213b11a16aSHongbin Zheng }
12223b11a16aSHongbin Zheng 
12233b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
12243b11a16aSHongbin Zheng                                              ValueMapT &VectorMap) {
122591f5b262STobias Grosser   for (Value *Operand : Inst->operands())
122691f5b262STobias Grosser     if (VectorMap.count(Operand))
12273b11a16aSHongbin Zheng       return true;
12283b11a16aSHongbin Zheng   return false;
12293b11a16aSHongbin Zheng }
12303b11a16aSHongbin Zheng 
12313b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
12323b11a16aSHongbin Zheng                                                ValueMapT &VectorMap,
12333b11a16aSHongbin Zheng                                                VectorValueMapT &ScalarMaps) {
12343b11a16aSHongbin Zheng   bool HasVectorOperand = false;
12353b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
12363b11a16aSHongbin Zheng 
123791f5b262STobias Grosser   for (Value *Operand : Inst->operands()) {
123891f5b262STobias Grosser     ValueMapT::iterator VecOp = VectorMap.find(Operand);
12393b11a16aSHongbin Zheng 
12403b11a16aSHongbin Zheng     if (VecOp == VectorMap.end())
12413b11a16aSHongbin Zheng       continue;
12423b11a16aSHongbin Zheng 
12433b11a16aSHongbin Zheng     HasVectorOperand = true;
12443b11a16aSHongbin Zheng     Value *NewVector = VecOp->second;
12453b11a16aSHongbin Zheng 
12463b11a16aSHongbin Zheng     for (int i = 0; i < VectorWidth; ++i) {
12473b11a16aSHongbin Zheng       ValueMapT &SM = ScalarMaps[i];
12483b11a16aSHongbin Zheng 
12493b11a16aSHongbin Zheng       // If there is one scalar extracted, all scalar elements should have
12503b11a16aSHongbin Zheng       // already been extracted by the code here. So no need to check for the
12512219d157STobias Grosser       // existence of all of them.
125291f5b262STobias Grosser       if (SM.count(Operand))
12533b11a16aSHongbin Zheng         break;
12543b11a16aSHongbin Zheng 
125591f5b262STobias Grosser       SM[Operand] =
125691f5b262STobias Grosser           Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
12573b11a16aSHongbin Zheng     }
12583b11a16aSHongbin Zheng   }
12593b11a16aSHongbin Zheng 
12603b11a16aSHongbin Zheng   return HasVectorOperand;
12613b11a16aSHongbin Zheng }
12623b11a16aSHongbin Zheng 
12632d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
12642f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
12652d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
12663b11a16aSHongbin Zheng   bool HasVectorOperand;
12673b11a16aSHongbin Zheng   int VectorWidth = getVectorWidth();
12683b11a16aSHongbin Zheng 
12693b11a16aSHongbin Zheng   HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
12703b11a16aSHongbin Zheng 
12713b11a16aSHongbin Zheng   for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
1272be9c9117SJohannes Doerfert     BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
1273bc132607STobias Grosser                                     VLTS[VectorLane], NewAccesses);
12743b11a16aSHongbin Zheng 
12753b11a16aSHongbin Zheng   if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
12763b11a16aSHongbin Zheng     return;
12773b11a16aSHongbin Zheng 
12783b11a16aSHongbin Zheng   // Make the result available as vector value.
12793b11a16aSHongbin Zheng   VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
12803b11a16aSHongbin Zheng   Value *Vector = UndefValue::get(VectorType);
12813b11a16aSHongbin Zheng 
12823b11a16aSHongbin Zheng   for (int i = 0; i < VectorWidth; i++)
12833b11a16aSHongbin Zheng     Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
12843b11a16aSHongbin Zheng                                          Builder.getInt32(i));
12853b11a16aSHongbin Zheng 
12863b11a16aSHongbin Zheng   VectorMap[Inst] = Vector;
12873b11a16aSHongbin Zheng }
12883b11a16aSHongbin Zheng 
1289bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
12903b11a16aSHongbin Zheng 
12912d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
12922f1acac6STobias Grosser     ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
12932d1ed0bfSTobias Grosser     VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
12943b11a16aSHongbin Zheng   // Terminator instructions control the control flow. They are explicitly
12953b11a16aSHongbin Zheng   // expressed in the clast and do not need to be copied.
12963b11a16aSHongbin Zheng   if (Inst->isTerminator())
12973b11a16aSHongbin Zheng     return;
12983b11a16aSHongbin Zheng 
12995dced269SJohannes Doerfert   if (canSyntheziseInStmt(Stmt, Inst))
1300e71c6ab5STobias Grosser     return;
1301e71c6ab5STobias Grosser 
13029646e3feSTobias Grosser   if (auto *Load = dyn_cast<LoadInst>(Inst)) {
13032d1ed0bfSTobias Grosser     generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
13043b11a16aSHongbin Zheng     return;
13053b11a16aSHongbin Zheng   }
13063b11a16aSHongbin Zheng 
13073b11a16aSHongbin Zheng   if (hasVectorOperands(Inst, VectorMap)) {
13089646e3feSTobias Grosser     if (auto *Store = dyn_cast<StoreInst>(Inst)) {
13090446d81eSMichael Kruse       // Identified as redundant by -polly-simplify.
13100446d81eSMichael Kruse       if (!Stmt.getArrayAccessOrNULLFor(Store))
13110446d81eSMichael Kruse         return;
13120446d81eSMichael Kruse 
13132d1ed0bfSTobias Grosser       copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
13143b11a16aSHongbin Zheng       return;
13153b11a16aSHongbin Zheng     }
13163b11a16aSHongbin Zheng 
13179646e3feSTobias Grosser     if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
1318be9c9117SJohannes Doerfert       copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
13193b11a16aSHongbin Zheng       return;
13203b11a16aSHongbin Zheng     }
13213b11a16aSHongbin Zheng 
13229646e3feSTobias Grosser     if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
1323be9c9117SJohannes Doerfert       copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
13243b11a16aSHongbin Zheng       return;
13253b11a16aSHongbin Zheng     }
13263b11a16aSHongbin Zheng 
1327a6d48f59SMichael Kruse     // Fallthrough: We generate scalar instructions, if we don't know how to
13283b11a16aSHongbin Zheng     // generate vector code.
13293b11a16aSHongbin Zheng   }
13303b11a16aSHongbin Zheng 
13312d1ed0bfSTobias Grosser   copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
13323b11a16aSHongbin Zheng }
13333b11a16aSHongbin Zheng 
1334a69d4f0dSTobias Grosser void VectorBlockGenerator::generateScalarVectorLoads(
1335a69d4f0dSTobias Grosser     ScopStmt &Stmt, ValueMapT &VectorBlockMap) {
1336a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
1337a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isWrite())
1338a69d4f0dSTobias Grosser       continue;
1339a69d4f0dSTobias Grosser 
1340a69d4f0dSTobias Grosser     auto *Address = getOrCreateAlloca(*MA);
1341a69d4f0dSTobias Grosser     Type *VectorPtrType = getVectorPtrTy(Address, 1);
1342a69d4f0dSTobias Grosser     Value *VectorPtr = Builder.CreateBitCast(Address, VectorPtrType,
1343a69d4f0dSTobias Grosser                                              Address->getName() + "_p_vec_p");
1344a69d4f0dSTobias Grosser     auto *Val = Builder.CreateLoad(VectorPtr, Address->getName() + ".reload");
1345a69d4f0dSTobias Grosser     Constant *SplatVector = Constant::getNullValue(
1346a69d4f0dSTobias Grosser         VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
1347a69d4f0dSTobias Grosser 
1348a69d4f0dSTobias Grosser     Value *VectorVal = Builder.CreateShuffleVector(
1349a69d4f0dSTobias Grosser         Val, Val, SplatVector, Address->getName() + "_p_splat");
1350583be06fSTobias Grosser     VectorBlockMap[MA->getAccessValue()] = VectorVal;
1351a69d4f0dSTobias Grosser   }
1352a69d4f0dSTobias Grosser }
1353a69d4f0dSTobias Grosser 
1354a69d4f0dSTobias Grosser void VectorBlockGenerator::verifyNoScalarStores(ScopStmt &Stmt) {
1355a69d4f0dSTobias Grosser   for (MemoryAccess *MA : Stmt) {
1356a69d4f0dSTobias Grosser     if (MA->isArrayKind() || MA->isRead())
1357a69d4f0dSTobias Grosser       continue;
1358a69d4f0dSTobias Grosser 
1359a69d4f0dSTobias Grosser     llvm_unreachable("Scalar stores not expected in vector loop");
1360a69d4f0dSTobias Grosser   }
1361a69d4f0dSTobias Grosser }
1362a69d4f0dSTobias Grosser 
13632d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
13642d1ed0bfSTobias Grosser     ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
136521a059afSTobias Grosser   assert(Stmt.isBlockStmt() &&
136621a059afSTobias Grosser          "TODO: Only block statements can be copied by the vector block "
136721a059afSTobias Grosser          "generator");
1368275a1756SJohannes Doerfert 
1369be9c9117SJohannes Doerfert   BasicBlock *BB = Stmt.getBasicBlock();
1370b8f58b53SDuncan P. N. Exon Smith   BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
1371b8f58b53SDuncan P. N. Exon Smith                                   &*Builder.GetInsertPoint(), &DT, &LI);
13723b11a16aSHongbin Zheng   CopyBB->setName("polly.stmt." + BB->getName());
1373b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&CopyBB->front());
13743b11a16aSHongbin Zheng 
13753b11a16aSHongbin Zheng   // Create two maps that store the mapping from the original instructions of
13763b11a16aSHongbin Zheng   // the old basic block to their copies in the new basic block. Those maps
13773b11a16aSHongbin Zheng   // are basic block local.
13783b11a16aSHongbin Zheng   //
13793b11a16aSHongbin Zheng   // As vector code generation is supported there is one map for scalar values
13803b11a16aSHongbin Zheng   // and one for vector values.
13813b11a16aSHongbin Zheng   //
13823b11a16aSHongbin Zheng   // In case we just do scalar code generation, the vectorMap is not used and
13833b11a16aSHongbin Zheng   // the scalarMap has just one dimension, which contains the mapping.
13843b11a16aSHongbin Zheng   //
13853b11a16aSHongbin Zheng   // In case vector code generation is done, an instruction may either appear
13863b11a16aSHongbin Zheng   // in the vector map once (as it is calculating >vectorwidth< values at a
13873b11a16aSHongbin Zheng   // time. Or (if the values are calculated using scalar operations), it
13883b11a16aSHongbin Zheng   // appears once in every dimension of the scalarMap.
13893b11a16aSHongbin Zheng   VectorValueMapT ScalarBlockMap(getVectorWidth());
13903b11a16aSHongbin Zheng   ValueMapT VectorBlockMap;
13913b11a16aSHongbin Zheng 
1392a69d4f0dSTobias Grosser   generateScalarVectorLoads(Stmt, VectorBlockMap);
1393a69d4f0dSTobias Grosser 
139491f5b262STobias Grosser   for (Instruction &Inst : *BB)
13952d1ed0bfSTobias Grosser     copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
1396a69d4f0dSTobias Grosser 
1397a69d4f0dSTobias Grosser   verifyNoScalarStores(Stmt);
13983b11a16aSHongbin Zheng }
1399275a1756SJohannes Doerfert 
1400ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1401ecff11dcSJohannes Doerfert                                              BasicBlock *BBCopy) {
1402514f6efaSJohannes Doerfert 
1403514f6efaSJohannes Doerfert   BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1404deefbcedSTobias Grosser   BasicBlock *BBCopyIDom = EndBlockMap.lookup(BBIDom);
1405514f6efaSJohannes Doerfert 
1406514f6efaSJohannes Doerfert   if (BBCopyIDom)
1407514f6efaSJohannes Doerfert     DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1408514f6efaSJohannes Doerfert 
1409deefbcedSTobias Grosser   return StartBlockMap.lookup(BBIDom);
1410514f6efaSJohannes Doerfert }
1411514f6efaSJohannes Doerfert 
1412f33c125dSMichael Kruse // This is to determine whether an llvm::Value (defined in @p BB) is usable when
1413f33c125dSMichael Kruse // leaving a subregion. The straight-forward DT.dominates(BB, R->getExitBlock())
1414f33c125dSMichael Kruse // does not work in cases where the exit block has edges from outside the
1415f33c125dSMichael Kruse // region. In that case the llvm::Value would never be usable in in the exit
1416f33c125dSMichael Kruse // block. The RegionGenerator however creates an new exit block ('ExitBBCopy')
1417f33c125dSMichael Kruse // for the subregion's exiting edges only. We need to determine whether an
1418f33c125dSMichael Kruse // llvm::Value is usable in there. We do this by checking whether it dominates
1419f33c125dSMichael Kruse // all exiting blocks individually.
1420f33c125dSMichael Kruse static bool isDominatingSubregionExit(const DominatorTree &DT, Region *R,
1421f33c125dSMichael Kruse                                       BasicBlock *BB) {
1422f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1423f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1424f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1425f33c125dSMichael Kruse       continue;
1426f33c125dSMichael Kruse 
1427f33c125dSMichael Kruse     if (!DT.dominates(BB, ExitingBB))
1428f33c125dSMichael Kruse       return false;
1429f33c125dSMichael Kruse   }
1430f33c125dSMichael Kruse 
1431f33c125dSMichael Kruse   return true;
1432f33c125dSMichael Kruse }
1433f33c125dSMichael Kruse 
1434f33c125dSMichael Kruse // Find the direct dominator of the subregion's exit block if the subregion was
1435f33c125dSMichael Kruse // simplified.
1436f33c125dSMichael Kruse static BasicBlock *findExitDominator(DominatorTree &DT, Region *R) {
1437f33c125dSMichael Kruse   BasicBlock *Common = nullptr;
1438f33c125dSMichael Kruse   for (auto ExitingBB : predecessors(R->getExit())) {
1439f33c125dSMichael Kruse     // Check for non-subregion incoming edges.
1440f33c125dSMichael Kruse     if (!R->contains(ExitingBB))
1441f33c125dSMichael Kruse       continue;
1442f33c125dSMichael Kruse 
1443f33c125dSMichael Kruse     // First exiting edge.
1444f33c125dSMichael Kruse     if (!Common) {
1445f33c125dSMichael Kruse       Common = ExitingBB;
1446f33c125dSMichael Kruse       continue;
1447f33c125dSMichael Kruse     }
1448f33c125dSMichael Kruse 
1449f33c125dSMichael Kruse     Common = DT.findNearestCommonDominator(Common, ExitingBB);
1450f33c125dSMichael Kruse   }
1451f33c125dSMichael Kruse 
1452f33c125dSMichael Kruse   assert(Common && R->contains(Common));
1453f33c125dSMichael Kruse   return Common;
1454f33c125dSMichael Kruse }
1455f33c125dSMichael Kruse 
1456bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
14572d1ed0bfSTobias Grosser                                isl_id_to_ast_expr *IdToAstExp) {
1458275a1756SJohannes Doerfert   assert(Stmt.isRegionStmt() &&
1459d3f21833STobias Grosser          "Only region statements can be copied by the region generator");
1460275a1756SJohannes Doerfert 
1461ecff11dcSJohannes Doerfert   // Forget all old mappings.
1462deefbcedSTobias Grosser   StartBlockMap.clear();
1463deefbcedSTobias Grosser   EndBlockMap.clear();
1464ecff11dcSJohannes Doerfert   RegionMaps.clear();
1465ecff11dcSJohannes Doerfert   IncompletePHINodeMap.clear();
1466ecff11dcSJohannes Doerfert 
1467225f0d1eSMichael Kruse   // Collection of all values related to this subregion.
1468225f0d1eSMichael Kruse   ValueMapT ValueMap;
1469225f0d1eSMichael Kruse 
1470275a1756SJohannes Doerfert   // The region represented by the statement.
1471275a1756SJohannes Doerfert   Region *R = Stmt.getRegion();
1472275a1756SJohannes Doerfert 
1473ecff11dcSJohannes Doerfert   // Create a dedicated entry for the region where we can reload all demoted
1474ecff11dcSJohannes Doerfert   // inputs.
1475ecff11dcSJohannes Doerfert   BasicBlock *EntryBB = R->getEntry();
1476b8f58b53SDuncan P. N. Exon Smith   BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1477b8f58b53SDuncan P. N. Exon Smith                                        &*Builder.GetInsertPoint(), &DT, &LI);
1478ecff11dcSJohannes Doerfert   EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1479b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&EntryBBCopy->front());
1480514f6efaSJohannes Doerfert 
1481c993739eSMichael Kruse   ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
14822fa35194SMichael Kruse   generateScalarLoads(Stmt, LTS, EntryBBMap, IdToAstExp);
1483e819fffeSMichael Kruse   generateBeginStmtTrace(Stmt, LTS, EntryBBMap);
1484225f0d1eSMichael Kruse 
1485ecff11dcSJohannes Doerfert   for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1486deefbcedSTobias Grosser     if (!R->contains(*PI)) {
1487deefbcedSTobias Grosser       StartBlockMap[*PI] = EntryBBCopy;
1488deefbcedSTobias Grosser       EndBlockMap[*PI] = EntryBBCopy;
1489deefbcedSTobias Grosser     }
1490275a1756SJohannes Doerfert 
1491275a1756SJohannes Doerfert   // Iterate over all blocks in the region in a breadth-first search.
1492275a1756SJohannes Doerfert   std::deque<BasicBlock *> Blocks;
14935b1abfc8SMandeep Singh Grang   SmallSetVector<BasicBlock *, 8> SeenBlocks;
1494ecff11dcSJohannes Doerfert   Blocks.push_back(EntryBB);
1495ecff11dcSJohannes Doerfert   SeenBlocks.insert(EntryBB);
1496275a1756SJohannes Doerfert 
1497275a1756SJohannes Doerfert   while (!Blocks.empty()) {
1498275a1756SJohannes Doerfert     BasicBlock *BB = Blocks.front();
1499275a1756SJohannes Doerfert     Blocks.pop_front();
1500275a1756SJohannes Doerfert 
1501514f6efaSJohannes Doerfert     // First split the block and update dominance information.
1502514f6efaSJohannes Doerfert     BasicBlock *BBCopy = splitBB(BB);
1503ecff11dcSJohannes Doerfert     BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1504ecff11dcSJohannes Doerfert 
1505c993739eSMichael Kruse     // Get the mapping for this block and initialize it with either the scalar
1506c993739eSMichael Kruse     // loads from the generated entering block (which dominates all blocks of
1507c993739eSMichael Kruse     // this subregion) or the maps of the immediate dominator, if part of the
1508c993739eSMichael Kruse     // subregion. The latter necessarily includes the former.
1509c993739eSMichael Kruse     ValueMapT *InitBBMap;
1510c993739eSMichael Kruse     if (BBCopyIDom) {
1511c993739eSMichael Kruse       assert(RegionMaps.count(BBCopyIDom));
1512c993739eSMichael Kruse       InitBBMap = &RegionMaps[BBCopyIDom];
1513c993739eSMichael Kruse     } else
1514c993739eSMichael Kruse       InitBBMap = &EntryBBMap;
1515c993739eSMichael Kruse     auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1516c993739eSMichael Kruse     ValueMapT &RegionMap = Inserted.first->second;
1517514f6efaSJohannes Doerfert 
1518275a1756SJohannes Doerfert     // Copy the block with the BlockGenerator.
1519b8f58b53SDuncan P. N. Exon Smith     Builder.SetInsertPoint(&BBCopy->front());
1520bc132607STobias Grosser     copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1521275a1756SJohannes Doerfert 
1522ecff11dcSJohannes Doerfert     // In order to remap PHI nodes we store also basic block mappings.
1523deefbcedSTobias Grosser     StartBlockMap[BB] = BBCopy;
1524deefbcedSTobias Grosser     EndBlockMap[BB] = Builder.GetInsertBlock();
1525ecff11dcSJohannes Doerfert 
1526ecff11dcSJohannes Doerfert     // Add values to incomplete PHI nodes waiting for this block to be copied.
1527ecff11dcSJohannes Doerfert     for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1528bc132607STobias Grosser       addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1529ecff11dcSJohannes Doerfert     IncompletePHINodeMap[BB].clear();
1530ecff11dcSJohannes Doerfert 
1531275a1756SJohannes Doerfert     // And continue with new successors inside the region.
1532275a1756SJohannes Doerfert     for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
15335b1abfc8SMandeep Singh Grang       if (R->contains(*SI) && SeenBlocks.insert(*SI))
1534275a1756SJohannes Doerfert         Blocks.push_back(*SI);
1535ebffcbeeSMichael Kruse 
1536ebffcbeeSMichael Kruse     // Remember value in case it is visible after this subregion.
1537f33c125dSMichael Kruse     if (isDominatingSubregionExit(DT, R, BB))
1538ebffcbeeSMichael Kruse       ValueMap.insert(RegionMap.begin(), RegionMap.end());
1539275a1756SJohannes Doerfert   }
1540275a1756SJohannes Doerfert 
1541275a1756SJohannes Doerfert   // Now create a new dedicated region exit block and add it to the region map.
1542b8f58b53SDuncan P. N. Exon Smith   BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1543b8f58b53SDuncan P. N. Exon Smith                                       &*Builder.GetInsertPoint(), &DT, &LI);
1544ecff11dcSJohannes Doerfert   ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1545deefbcedSTobias Grosser   StartBlockMap[R->getExit()] = ExitBBCopy;
1546deefbcedSTobias Grosser   EndBlockMap[R->getExit()] = ExitBBCopy;
1547514f6efaSJohannes Doerfert 
1548deefbcedSTobias Grosser   BasicBlock *ExitDomBBCopy = EndBlockMap.lookup(findExitDominator(DT, R));
154921a059afSTobias Grosser   assert(ExitDomBBCopy &&
155021a059afSTobias Grosser          "Common exit dominator must be within region; at least the entry node "
155121a059afSTobias Grosser          "must match");
1552f33c125dSMichael Kruse   DT.changeImmediateDominator(ExitBBCopy, ExitDomBBCopy);
1553275a1756SJohannes Doerfert 
1554275a1756SJohannes Doerfert   // As the block generator doesn't handle control flow we need to add the
1555275a1756SJohannes Doerfert   // region control flow by hand after all blocks have been copied.
1556275a1756SJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1557275a1756SJohannes Doerfert 
1558deefbcedSTobias Grosser     BasicBlock *BBCopyStart = StartBlockMap[BB];
1559deefbcedSTobias Grosser     BasicBlock *BBCopyEnd = EndBlockMap[BB];
1560e303c87eSChandler Carruth     Instruction *TI = BB->getTerminator();
1561e114dc02SJohannes Doerfert     if (isa<UnreachableInst>(TI)) {
1562deefbcedSTobias Grosser       while (!BBCopyEnd->empty())
1563deefbcedSTobias Grosser         BBCopyEnd->begin()->eraseFromParent();
1564deefbcedSTobias Grosser       new UnreachableInst(BBCopyEnd->getContext(), BBCopyEnd);
1565e114dc02SJohannes Doerfert       continue;
1566e114dc02SJohannes Doerfert     }
1567e114dc02SJohannes Doerfert 
1568deefbcedSTobias Grosser     Instruction *BICopy = BBCopyEnd->getTerminator();
1569275a1756SJohannes Doerfert 
1570deefbcedSTobias Grosser     ValueMapT &RegionMap = RegionMaps[BBCopyStart];
1571deefbcedSTobias Grosser     RegionMap.insert(StartBlockMap.begin(), StartBlockMap.end());
1572514f6efaSJohannes Doerfert 
157345e7944bSTobias Grosser     Builder.SetInsertPoint(BICopy);
15749a132f36SJohannes Doerfert     copyInstScalar(Stmt, TI, RegionMap, LTS);
1575275a1756SJohannes Doerfert     BICopy->eraseFromParent();
1576275a1756SJohannes Doerfert   }
1577275a1756SJohannes Doerfert 
1578ecff11dcSJohannes Doerfert   // Add counting PHI nodes to all loops in the region that can be used as
1579a6d48f59SMichael Kruse   // replacement for SCEVs referring to the old loop.
1580ecff11dcSJohannes Doerfert   for (BasicBlock *BB : SeenBlocks) {
1581ecff11dcSJohannes Doerfert     Loop *L = LI.getLoopFor(BB);
1582bc29e0b2STobias Grosser     if (L == nullptr || L->getHeader() != BB || !R->contains(L))
1583ecff11dcSJohannes Doerfert       continue;
1584ecff11dcSJohannes Doerfert 
1585deefbcedSTobias Grosser     BasicBlock *BBCopy = StartBlockMap[BB];
1586ecff11dcSJohannes Doerfert     Value *NullVal = Builder.getInt32(0);
1587ecff11dcSJohannes Doerfert     PHINode *LoopPHI =
1588ecff11dcSJohannes Doerfert         PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1589ecff11dcSJohannes Doerfert     Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1590ecff11dcSJohannes Doerfert         LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1591b8f58b53SDuncan P. N. Exon Smith     LoopPHI->insertBefore(&BBCopy->front());
1592ecff11dcSJohannes Doerfert     LoopPHIInc->insertBefore(BBCopy->getTerminator());
1593ecff11dcSJohannes Doerfert 
1594ecff11dcSJohannes Doerfert     for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1595ecff11dcSJohannes Doerfert       if (!R->contains(PredBB))
1596ecff11dcSJohannes Doerfert         continue;
1597ecff11dcSJohannes Doerfert       if (L->contains(PredBB))
1598deefbcedSTobias Grosser         LoopPHI->addIncoming(LoopPHIInc, EndBlockMap[PredBB]);
1599ecff11dcSJohannes Doerfert       else
1600deefbcedSTobias Grosser         LoopPHI->addIncoming(NullVal, EndBlockMap[PredBB]);
1601ecff11dcSJohannes Doerfert     }
1602ecff11dcSJohannes Doerfert 
1603ecff11dcSJohannes Doerfert     for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1604ecff11dcSJohannes Doerfert       if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1605ecff11dcSJohannes Doerfert         LoopPHI->addIncoming(NullVal, PredBBCopy);
1606ecff11dcSJohannes Doerfert 
1607ecff11dcSJohannes Doerfert     LTS[L] = SE.getUnknown(LoopPHI);
1608ecff11dcSJohannes Doerfert   }
1609ecff11dcSJohannes Doerfert 
1610225f0d1eSMichael Kruse   // Continue generating code in the exit block.
1611b8f58b53SDuncan P. N. Exon Smith   Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
1612225f0d1eSMichael Kruse 
1613225f0d1eSMichael Kruse   // Write values visible to other statements.
16142fa35194SMichael Kruse   generateScalarStores(Stmt, LTS, ValueMap, IdToAstExp);
1615deefbcedSTobias Grosser   StartBlockMap.clear();
1616deefbcedSTobias Grosser   EndBlockMap.clear();
16173e956020STobias Grosser   RegionMaps.clear();
16183e956020STobias Grosser   IncompletePHINodeMap.clear();
1619275a1756SJohannes Doerfert }
1620ecff11dcSJohannes Doerfert 
1621ee6a4fc6SMichael Kruse PHINode *RegionGenerator::buildExitPHI(MemoryAccess *MA, LoopToScevMapT &LTS,
1622ee6a4fc6SMichael Kruse                                        ValueMapT &BBMap, Loop *L) {
1623ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1624ee6a4fc6SMichael Kruse   Region *SubR = Stmt->getRegion();
1625ee6a4fc6SMichael Kruse   auto Incoming = MA->getIncoming();
1626ee6a4fc6SMichael Kruse 
1627ee6a4fc6SMichael Kruse   PollyIRBuilder::InsertPointGuard IPGuard(Builder);
1628ee6a4fc6SMichael Kruse   PHINode *OrigPHI = cast<PHINode>(MA->getAccessInstruction());
1629ee6a4fc6SMichael Kruse   BasicBlock *NewSubregionExit = Builder.GetInsertBlock();
1630ee6a4fc6SMichael Kruse 
1631ee6a4fc6SMichael Kruse   // This can happen if the subregion is simplified after the ScopStmts
1632ee6a4fc6SMichael Kruse   // have been created; simplification happens as part of CodeGeneration.
1633ee6a4fc6SMichael Kruse   if (OrigPHI->getParent() != SubR->getExit()) {
1634ee6a4fc6SMichael Kruse     BasicBlock *FormerExit = SubR->getExitingBlock();
1635ee6a4fc6SMichael Kruse     if (FormerExit)
1636deefbcedSTobias Grosser       NewSubregionExit = StartBlockMap.lookup(FormerExit);
1637ee6a4fc6SMichael Kruse   }
1638ee6a4fc6SMichael Kruse 
1639ee6a4fc6SMichael Kruse   PHINode *NewPHI = PHINode::Create(OrigPHI->getType(), Incoming.size(),
1640ee6a4fc6SMichael Kruse                                     "polly." + OrigPHI->getName(),
1641ee6a4fc6SMichael Kruse                                     NewSubregionExit->getFirstNonPHI());
1642ee6a4fc6SMichael Kruse 
1643ee6a4fc6SMichael Kruse   // Add the incoming values to the PHI.
1644ee6a4fc6SMichael Kruse   for (auto &Pair : Incoming) {
1645ee6a4fc6SMichael Kruse     BasicBlock *OrigIncomingBlock = Pair.first;
1646deefbcedSTobias Grosser     BasicBlock *NewIncomingBlockStart = StartBlockMap.lookup(OrigIncomingBlock);
1647deefbcedSTobias Grosser     BasicBlock *NewIncomingBlockEnd = EndBlockMap.lookup(OrigIncomingBlock);
1648deefbcedSTobias Grosser     Builder.SetInsertPoint(NewIncomingBlockEnd->getTerminator());
1649deefbcedSTobias Grosser     assert(RegionMaps.count(NewIncomingBlockStart));
1650deefbcedSTobias Grosser     assert(RegionMaps.count(NewIncomingBlockEnd));
1651deefbcedSTobias Grosser     ValueMapT *LocalBBMap = &RegionMaps[NewIncomingBlockStart];
1652ee6a4fc6SMichael Kruse 
1653ee6a4fc6SMichael Kruse     Value *OrigIncomingValue = Pair.second;
1654ee6a4fc6SMichael Kruse     Value *NewIncomingValue =
1655ee6a4fc6SMichael Kruse         getNewValue(*Stmt, OrigIncomingValue, *LocalBBMap, LTS, L);
1656deefbcedSTobias Grosser     NewPHI->addIncoming(NewIncomingValue, NewIncomingBlockEnd);
1657ee6a4fc6SMichael Kruse   }
1658ee6a4fc6SMichael Kruse 
1659ee6a4fc6SMichael Kruse   return NewPHI;
1660ee6a4fc6SMichael Kruse }
1661ee6a4fc6SMichael Kruse 
1662ee6a4fc6SMichael Kruse Value *RegionGenerator::getExitScalar(MemoryAccess *MA, LoopToScevMapT &LTS,
1663ee6a4fc6SMichael Kruse                                       ValueMapT &BBMap) {
1664ee6a4fc6SMichael Kruse   ScopStmt *Stmt = MA->getStatement();
1665ee6a4fc6SMichael Kruse 
1666ee6a4fc6SMichael Kruse   // TODO: Add some test cases that ensure this is really the right choice.
1667ee6a4fc6SMichael Kruse   Loop *L = LI.getLoopFor(Stmt->getRegion()->getExit());
1668ee6a4fc6SMichael Kruse 
1669ee6a4fc6SMichael Kruse   if (MA->isAnyPHIKind()) {
1670ee6a4fc6SMichael Kruse     auto Incoming = MA->getIncoming();
1671ee6a4fc6SMichael Kruse     assert(!Incoming.empty() &&
1672ee6a4fc6SMichael Kruse            "PHI WRITEs must have originate from at least one incoming block");
1673ee6a4fc6SMichael Kruse 
1674ee6a4fc6SMichael Kruse     // If there is only one incoming value, we do not need to create a PHI.
1675ee6a4fc6SMichael Kruse     if (Incoming.size() == 1) {
1676ee6a4fc6SMichael Kruse       Value *OldVal = Incoming[0].second;
1677ee6a4fc6SMichael Kruse       return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1678ee6a4fc6SMichael Kruse     }
1679ee6a4fc6SMichael Kruse 
1680ee6a4fc6SMichael Kruse     return buildExitPHI(MA, LTS, BBMap, L);
1681ee6a4fc6SMichael Kruse   }
1682ee6a4fc6SMichael Kruse 
16834d5a9172STobias Grosser   // MemoryKind::Value accesses leaving the subregion must dominate the exit
16844d5a9172STobias Grosser   // block; just pass the copied value.
1685ee6a4fc6SMichael Kruse   Value *OldVal = MA->getAccessValue();
1686ee6a4fc6SMichael Kruse   return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1687ee6a4fc6SMichael Kruse }
1688ee6a4fc6SMichael Kruse 
16892fa35194SMichael Kruse void RegionGenerator::generateScalarStores(
16902fa35194SMichael Kruse     ScopStmt &Stmt, LoopToScevMapT &LTS, ValueMapT &BBMap,
16912fa35194SMichael Kruse     __isl_keep isl_id_to_ast_expr *NewAccesses) {
169275296901STobias Grosser   assert(Stmt.getRegion() &&
169375296901STobias Grosser          "Block statements need to use the generateScalarStores() "
1694ecff11dcSJohannes Doerfert          "function in the BlockGenerator");
1695ecff11dcSJohannes Doerfert 
1696*c4c679c2SMichael Kruse   // Get the exit scalar values before generating the writes.
1697*c4c679c2SMichael Kruse   // This is necessary because RegionGenerator::getExitScalar may insert
1698*c4c679c2SMichael Kruse   // PHINodes that depend on the region's exiting blocks. But
1699*c4c679c2SMichael Kruse   // BlockGenerator::generateConditionalExecution may insert a new basic block
1700*c4c679c2SMichael Kruse   // such that the current basic block is not a direct successor of the exiting
1701*c4c679c2SMichael Kruse   // blocks anymore. Hence, build the PHINodes while the current block is still
1702*c4c679c2SMichael Kruse   // the direct successor.
1703*c4c679c2SMichael Kruse   SmallDenseMap<MemoryAccess *, Value *> NewExitScalars;
1704*c4c679c2SMichael Kruse   for (MemoryAccess *MA : Stmt) {
1705*c4c679c2SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isRead())
1706*c4c679c2SMichael Kruse       continue;
1707*c4c679c2SMichael Kruse 
1708*c4c679c2SMichael Kruse     Value *NewVal = getExitScalar(MA, LTS, BBMap);
1709*c4c679c2SMichael Kruse     NewExitScalars[MA] = NewVal;
1710*c4c679c2SMichael Kruse   }
1711*c4c679c2SMichael Kruse 
1712ecff11dcSJohannes Doerfert   for (MemoryAccess *MA : Stmt) {
17132fa35194SMichael Kruse     if (MA->isOriginalArrayKind() || MA->isRead())
1714ecff11dcSJohannes Doerfert       continue;
1715ecff11dcSJohannes Doerfert 
17161515f6b9STobias Grosser     isl::set AccDom = MA->getAccessRelation().domain();
1717fe46c3ffSTobias Grosser     std::string Subject = MA->getId().get_name();
1718fe46c3ffSTobias Grosser     generateConditionalExecution(
1719fe46c3ffSTobias Grosser         Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
1720*c4c679c2SMichael Kruse           Value *NewVal = NewExitScalars.lookup(MA);
1721*c4c679c2SMichael Kruse           assert(NewVal && "The exit scalar must be determined before");
1722fe46c3ffSTobias Grosser           Value *Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
1723fe46c3ffSTobias Grosser                                               BBMap, NewAccesses);
1724eac9726eSMichael Kruse           assert((!isa<Instruction>(NewVal) ||
1725eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(NewVal)->getParent(),
1726eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
1727eac9726eSMichael Kruse                  "Domination violation");
1728eac9726eSMichael Kruse           assert((!isa<Instruction>(Address) ||
1729eac9726eSMichael Kruse                   DT.dominates(cast<Instruction>(Address)->getParent(),
1730eac9726eSMichael Kruse                                Builder.GetInsertBlock())) &&
1731eac9726eSMichael Kruse                  "Domination violation");
1732ee6a4fc6SMichael Kruse           Builder.CreateStore(NewVal, Address);
1733706f79abSMichael Kruse         });
1734ecff11dcSJohannes Doerfert   }
1735ecff11dcSJohannes Doerfert }
1736ecff11dcSJohannes Doerfert 
1737943c369cSTobias Grosser void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, PHINode *PHI,
1738ecff11dcSJohannes Doerfert                                       PHINode *PHICopy, BasicBlock *IncomingBB,
1739ecff11dcSJohannes Doerfert                                       LoopToScevMapT &LTS) {
1740ecff11dcSJohannes Doerfert   // If the incoming block was not yet copied mark this PHI as incomplete.
1741ecff11dcSJohannes Doerfert   // Once the block will be copied the incoming value will be added.
1742deefbcedSTobias Grosser   BasicBlock *BBCopyStart = StartBlockMap[IncomingBB];
1743deefbcedSTobias Grosser   BasicBlock *BBCopyEnd = EndBlockMap[IncomingBB];
1744deefbcedSTobias Grosser   if (!BBCopyStart) {
1745deefbcedSTobias Grosser     assert(!BBCopyEnd);
17468d89179eSMichael Kruse     assert(Stmt.represents(IncomingBB) &&
1747ecff11dcSJohannes Doerfert            "Bad incoming block for PHI in non-affine region");
1748ecff11dcSJohannes Doerfert     IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1749ecff11dcSJohannes Doerfert     return;
1750ecff11dcSJohannes Doerfert   }
1751ecff11dcSJohannes Doerfert 
1752deefbcedSTobias Grosser   assert(RegionMaps.count(BBCopyStart) &&
1753deefbcedSTobias Grosser          "Incoming PHI block did not have a BBMap");
1754deefbcedSTobias Grosser   ValueMapT &BBCopyMap = RegionMaps[BBCopyStart];
1755ecff11dcSJohannes Doerfert 
175675dfaa1dSTobias Grosser   Value *OpCopy = nullptr;
175775dfaa1dSTobias Grosser 
17588d89179eSMichael Kruse   if (Stmt.represents(IncomingBB)) {
1759ecff11dcSJohannes Doerfert     Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1760dc122222SMichael Kruse 
17616ba92714SJohannes Doerfert     // If the current insert block is different from the PHIs incoming block
17626ba92714SJohannes Doerfert     // change it, otherwise do not.
17636ba92714SJohannes Doerfert     auto IP = Builder.GetInsertPoint();
1764deefbcedSTobias Grosser     if (IP->getParent() != BBCopyEnd)
1765deefbcedSTobias Grosser       Builder.SetInsertPoint(BBCopyEnd->getTerminator());
17662c3ffc04SJohannes Doerfert     OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForStmt(Stmt));
1767deefbcedSTobias Grosser     if (IP->getParent() != BBCopyEnd)
17686ba92714SJohannes Doerfert       Builder.SetInsertPoint(&*IP);
1769ecff11dcSJohannes Doerfert   } else {
177075dfaa1dSTobias Grosser     // All edges from outside the non-affine region become a single edge
177175dfaa1dSTobias Grosser     // in the new copy of the non-affine region. Make sure to only add the
177275dfaa1dSTobias Grosser     // corresponding edge the first time we encounter a basic block from
177375dfaa1dSTobias Grosser     // outside the non-affine region.
1774deefbcedSTobias Grosser     if (PHICopy->getBasicBlockIndex(BBCopyEnd) >= 0)
1775ecff11dcSJohannes Doerfert       return;
1776ecff11dcSJohannes Doerfert 
177775dfaa1dSTobias Grosser     // Get the reloaded value.
177875dfaa1dSTobias Grosser     OpCopy = getNewValue(Stmt, PHI, BBCopyMap, LTS, getLoopForStmt(Stmt));
1779ecff11dcSJohannes Doerfert   }
1780ecff11dcSJohannes Doerfert 
1781ecff11dcSJohannes Doerfert   assert(OpCopy && "Incoming PHI value was not copied properly");
1782deefbcedSTobias Grosser   PHICopy->addIncoming(OpCopy, BBCopyEnd);
1783ecff11dcSJohannes Doerfert }
1784ecff11dcSJohannes Doerfert 
17852b809d13STobias Grosser void RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1786ecff11dcSJohannes Doerfert                                          ValueMapT &BBMap,
1787ecff11dcSJohannes Doerfert                                          LoopToScevMapT &LTS) {
1788ecff11dcSJohannes Doerfert   unsigned NumIncoming = PHI->getNumIncomingValues();
1789ecff11dcSJohannes Doerfert   PHINode *PHICopy =
1790ecff11dcSJohannes Doerfert       Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1791ecff11dcSJohannes Doerfert   PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1792ecff11dcSJohannes Doerfert   BBMap[PHI] = PHICopy;
1793ecff11dcSJohannes Doerfert 
179497b84909STobias Grosser   for (BasicBlock *IncomingBB : PHI->blocks())
179597b84909STobias Grosser     addOperandToPHI(Stmt, PHI, PHICopy, IncomingBB, LTS);
1796ecff11dcSJohannes Doerfert }
1797