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"
2044596fe6SRiccardo Mori #include "polly/Support/ISLTools.h"
21ecfe21b7STobias Grosser #include "polly/Support/ScopHelper.h"
22eedae763SMichael Kruse #include "polly/Support/VirtualInstruction.h"
23e71c6ab5STobias Grosser #include "llvm/Analysis/LoopInfo.h"
24f32d651dSJohannes Doerfert #include "llvm/Analysis/RegionInfo.h"
25e71c6ab5STobias Grosser #include "llvm/Analysis/ScalarEvolution.h"
263b11a16aSHongbin Zheng #include "llvm/Transforms/Utils/BasicBlockUtils.h"
27a998f98bSTobias Grosser #include "llvm/Transforms/Utils/Local.h"
28f32d651dSJohannes Doerfert #include "isl/ast.h"
29f32d651dSJohannes Doerfert #include <deque>
30f32d651dSJohannes Doerfert
313b11a16aSHongbin Zheng using namespace llvm;
323b11a16aSHongbin Zheng using namespace polly;
333b11a16aSHongbin Zheng
34878aba49STobias Grosser static cl::opt<bool> Aligned("enable-polly-aligned",
35878aba49STobias Grosser cl::desc("Assumed aligned memory accesses."),
3636c7d79dSFangrui Song cl::Hidden, 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."),
4295a13425SFangrui Song cl::location(PollyDebugPrinting), cl::Hidden, cl::cat(PollyCategory));
4386bc93a9STobias Grosser
44e819fffeSMichael Kruse static cl::opt<bool> TraceStmts(
45e819fffeSMichael Kruse "polly-codegen-trace-stmts",
46e819fffeSMichael Kruse cl::desc("Add printf calls that print the statement being executed"),
4736c7d79dSFangrui Song cl::Hidden, cl::cat(PollyCategory));
48e819fffeSMichael Kruse
49e819fffeSMichael Kruse static cl::opt<bool> TraceScalars(
50e819fffeSMichael Kruse "polly-codegen-trace-scalars",
51e819fffeSMichael Kruse cl::desc("Add printf calls that print the values of all scalar values "
52e819fffeSMichael Kruse "used in a statement. Requires -polly-codegen-trace-stmts."),
5336c7d79dSFangrui Song cl::Hidden, cl::cat(PollyCategory));
54e819fffeSMichael Kruse
BlockGenerator(PollyIRBuilder & B,LoopInfo & LI,ScalarEvolution & SE,DominatorTree & DT,AllocaMapTy & ScalarMap,EscapeUsersAllocaMapTy & EscapeMap,ValueMapT & GlobalMap,IslExprBuilder * ExprBuilder,BasicBlock * StartBlock)55acf80064SEli Friedman BlockGenerator::BlockGenerator(
56acf80064SEli Friedman PollyIRBuilder &B, LoopInfo &LI, ScalarEvolution &SE, DominatorTree &DT,
57587f1f57STobias Grosser AllocaMapTy &ScalarMap, EscapeUsersAllocaMapTy &EscapeMap,
58587f1f57STobias Grosser ValueMapT &GlobalMap, IslExprBuilder *ExprBuilder, BasicBlock *StartBlock)
59ecff11dcSJohannes Doerfert : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
60587f1f57STobias Grosser EntryBB(nullptr), ScalarMap(ScalarMap), EscapeMap(EscapeMap),
61587f1f57STobias Grosser GlobalMap(GlobalMap), StartBlock(StartBlock) {}
62e71c6ab5STobias Grosser
trySynthesizeNewValue(ScopStmt & Stmt,Value * Old,ValueMapT & BBMap,LoopToScevMapT & LTS,Loop * L) const632f1acac6STobias Grosser Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
6433cb9f94STobias Grosser ValueMapT &BBMap,
6533cb9f94STobias Grosser LoopToScevMapT <S,
66bc132607STobias Grosser Loop *L) const {
6742df8d1dSJohannes Doerfert if (!SE.isSCEVable(Old->getType()))
6842df8d1dSJohannes Doerfert return nullptr;
6942df8d1dSJohannes Doerfert
7042df8d1dSJohannes Doerfert const SCEV *Scev = SE.getSCEVAtScope(Old, L);
7142df8d1dSJohannes Doerfert if (!Scev)
7242df8d1dSJohannes Doerfert return nullptr;
7342df8d1dSJohannes Doerfert
7442df8d1dSJohannes Doerfert if (isa<SCEVCouldNotCompute>(Scev))
7542df8d1dSJohannes Doerfert return nullptr;
7642df8d1dSJohannes Doerfert
7703bcb910SSanjoy Das const SCEV *NewScev = SCEVLoopAddRecRewriter::rewrite(Scev, LTS, SE);
7809e3697fSJohannes Doerfert ValueMapT VTV;
79637b23dcSSebastian Pop VTV.insert(BBMap.begin(), BBMap.end());
80637b23dcSSebastian Pop VTV.insert(GlobalMap.begin(), GlobalMap.end());
81e69e1141SJohannes Doerfert
82e69e1141SJohannes Doerfert Scop &S = *Stmt.getParent();
833f52e354SJohannes Doerfert const DataLayout &DL = S.getFunction().getParent()->getDataLayout();
84e69e1141SJohannes Doerfert auto IP = Builder.GetInsertPoint();
85e69e1141SJohannes Doerfert
86e69e1141SJohannes Doerfert assert(IP != Builder.GetInsertBlock()->end() &&
8745e7944bSTobias Grosser "Only instructions can be insert points for SCEVExpander");
8842df8d1dSJohannes Doerfert Value *Expanded =
89acf80064SEli Friedman expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), &*IP, &VTV,
90acf80064SEli Friedman StartBlock->getSinglePredecessor());
91e71c6ab5STobias Grosser
92e71c6ab5STobias Grosser BBMap[Old] = Expanded;
93e71c6ab5STobias Grosser return Expanded;
94e71c6ab5STobias Grosser }
9533cb9f94STobias Grosser
getNewValue(ScopStmt & Stmt,Value * Old,ValueMapT & BBMap,LoopToScevMapT & LTS,Loop * L) const962f1acac6STobias Grosser Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
972f1acac6STobias Grosser LoopToScevMapT <S, Loop *L) const {
9833cb9f94STobias Grosser
99eedae763SMichael Kruse auto lookupGlobally = [this](Value *Old) -> Value * {
100eedae763SMichael Kruse Value *New = GlobalMap.lookup(Old);
101eedae763SMichael Kruse if (!New)
102eedae763SMichael Kruse return nullptr;
10328f8ac1dSJohannes Doerfert
104eedae763SMichael Kruse // Required by:
105eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded.ll
106eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_different_bb.ll
107eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/invariant_base_pointer_preloaded_pass_only_needed.ll
108eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/invariant_base_pointers_preloaded.ll
109eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
110eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/single_loop_with_loop_invariant_baseptr.ll
111eedae763SMichael Kruse // GlobalMap should be a mapping from (value in original SCoP) to (copied
112eedae763SMichael Kruse // value in generated SCoP), without intermediate mappings, which might
113eedae763SMichael Kruse // easily require transitiveness as well.
11433cb9f94STobias Grosser if (Value *NewRemapped = GlobalMap.lookup(New))
11533cb9f94STobias Grosser New = NewRemapped;
116eedae763SMichael Kruse
117eedae763SMichael Kruse // No test case for this code.
11833cb9f94STobias Grosser if (Old->getType()->getScalarSizeInBits() <
11933cb9f94STobias Grosser New->getType()->getScalarSizeInBits())
12033cb9f94STobias Grosser New = Builder.CreateTruncOrBitCast(New, Old->getType());
12133cb9f94STobias Grosser
12233cb9f94STobias Grosser return New;
123eedae763SMichael Kruse };
124eedae763SMichael Kruse
125eedae763SMichael Kruse Value *New = nullptr;
126eedae763SMichael Kruse auto VUse = VirtualUse::create(&Stmt, L, Old, true);
127eedae763SMichael Kruse switch (VUse.getKind()) {
128eedae763SMichael Kruse case VirtualUse::Block:
129eedae763SMichael Kruse // BasicBlock are constants, but the BlockGenerator copies them.
130eedae763SMichael Kruse New = BBMap.lookup(Old);
131eedae763SMichael Kruse break;
132eedae763SMichael Kruse
133eedae763SMichael Kruse case VirtualUse::Constant:
134eedae763SMichael Kruse // Used by:
135eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/reference-argument-from-non-affine-region.ll
136eedae763SMichael Kruse // Constants should not be redefined. In this case, the GlobalMap just
137eedae763SMichael Kruse // contains a mapping to the same constant, which is unnecessary, but
138eedae763SMichael Kruse // harmless.
139eedae763SMichael Kruse if ((New = lookupGlobally(Old)))
140eedae763SMichael Kruse break;
141eedae763SMichael Kruse
142eedae763SMichael Kruse assert(!BBMap.count(Old));
143eedae763SMichael Kruse New = Old;
144eedae763SMichael Kruse break;
145eedae763SMichael Kruse
146eedae763SMichael Kruse case VirtualUse::ReadOnly:
147eedae763SMichael Kruse assert(!GlobalMap.count(Old));
148eedae763SMichael Kruse
149eedae763SMichael Kruse // Required for:
150eedae763SMichael Kruse // * Isl/CodeGen/MemAccess/create_arrays.ll
151eedae763SMichael Kruse // * Isl/CodeGen/read-only-scalars.ll
152eedae763SMichael Kruse // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
153eedae763SMichael Kruse // For some reason these reload a read-only value. The reloaded value ends
154eedae763SMichael Kruse // up in BBMap, buts its value should be identical.
155eedae763SMichael Kruse //
156eedae763SMichael Kruse // Required for:
157eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/single_loop_with_param.ll
158eedae763SMichael Kruse // The parallel subfunctions need to reference the read-only value from the
159eedae763SMichael Kruse // parent function, this is done by reloading them locally.
160eedae763SMichael Kruse if ((New = BBMap.lookup(Old)))
161eedae763SMichael Kruse break;
162eedae763SMichael Kruse
163eedae763SMichael Kruse New = Old;
164eedae763SMichael Kruse break;
165eedae763SMichael Kruse
166eedae763SMichael Kruse case VirtualUse::Synthesizable:
167eedae763SMichael Kruse // Used by:
168eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/loop-body-references-outer-values-3.ll
169eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/recomputed-srem.ll
170eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/reference-other-bb.ll
171eedae763SMichael Kruse // * Isl/CodeGen/OpenMP/two-parallel-loops-reference-outer-indvar.ll
172eedae763SMichael Kruse // For some reason synthesizable values end up in GlobalMap. Their values
173eedae763SMichael Kruse // are the same as trySynthesizeNewValue would return. The legacy
174eedae763SMichael Kruse // implementation prioritized GlobalMap, so this is what we do here as well.
175eedae763SMichael Kruse // Ideally, synthesizable values should not end up in GlobalMap.
176eedae763SMichael Kruse if ((New = lookupGlobally(Old)))
177eedae763SMichael Kruse break;
178eedae763SMichael Kruse
179eedae763SMichael Kruse // Required for:
180eedae763SMichael Kruse // * Isl/CodeGen/RuntimeDebugBuilder/combine_different_values.ll
181eedae763SMichael Kruse // * Isl/CodeGen/getNumberOfIterations.ll
182eedae763SMichael Kruse // * Isl/CodeGen/non_affine_float_compare.ll
183eedae763SMichael Kruse // * ScheduleOptimizer/pattern-matching-based-opts_10.ll
184eedae763SMichael Kruse // Ideally, synthesizable values are synthesized by trySynthesizeNewValue,
185eedae763SMichael Kruse // not precomputed (SCEVExpander has its own caching mechanism).
186eedae763SMichael Kruse // These tests fail without this, but I think trySynthesizeNewValue would
187eedae763SMichael Kruse // just re-synthesize the same instructions.
188eedae763SMichael Kruse if ((New = BBMap.lookup(Old)))
189eedae763SMichael Kruse break;
190eedae763SMichael Kruse
191eedae763SMichael Kruse New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L);
192eedae763SMichael Kruse break;
193eedae763SMichael Kruse
194eedae763SMichael Kruse case VirtualUse::Hoisted:
195eedae763SMichael Kruse // TODO: Hoisted invariant loads should be found in GlobalMap only, but not
196eedae763SMichael Kruse // redefined locally (which will be ignored anyway). That is, the following
197eedae763SMichael Kruse // assertion should apply: assert(!BBMap.count(Old))
198eedae763SMichael Kruse
199eedae763SMichael Kruse New = lookupGlobally(Old);
200eedae763SMichael Kruse break;
201eedae763SMichael Kruse
202eedae763SMichael Kruse case VirtualUse::Intra:
203eedae763SMichael Kruse case VirtualUse::Inter:
204eedae763SMichael Kruse assert(!GlobalMap.count(Old) &&
205eedae763SMichael Kruse "Intra and inter-stmt values are never global");
206eedae763SMichael Kruse New = BBMap.lookup(Old);
207eedae763SMichael Kruse break;
20833cb9f94STobias Grosser }
209eedae763SMichael Kruse assert(New && "Unexpected scalar dependence in region!");
21033cb9f94STobias Grosser return New;
2113b11a16aSHongbin Zheng }
2123b11a16aSHongbin Zheng
copyInstScalar(ScopStmt & Stmt,Instruction * Inst,ValueMapT & BBMap,LoopToScevMapT & LTS)2132f1acac6STobias Grosser void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
214bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S) {
215030237d0STobias Grosser // We do not generate debug intrinsics as we did not investigate how to
216030237d0STobias Grosser // copy them correctly. At the current state, they just crash the code
217030237d0STobias Grosser // generation as the meta-data operands are not correctly copied.
218030237d0STobias Grosser if (isa<DbgInfoIntrinsic>(Inst))
219030237d0STobias Grosser return;
220030237d0STobias Grosser
2213b11a16aSHongbin Zheng Instruction *NewInst = Inst->clone();
2223b11a16aSHongbin Zheng
2233b11a16aSHongbin Zheng // Replace old operands with the new ones.
22491f5b262STobias Grosser for (Value *OldOperand : Inst->operands()) {
225bc132607STobias Grosser Value *NewOperand =
2262c3ffc04SJohannes Doerfert getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForStmt(Stmt));
2273b11a16aSHongbin Zheng
2283b11a16aSHongbin Zheng if (!NewOperand) {
229c14582f2STobias Grosser assert(!isa<StoreInst>(NewInst) &&
230c14582f2STobias Grosser "Store instructions are always needed!");
23196ab8726SReid Kleckner NewInst->deleteValue();
2323b11a16aSHongbin Zheng return;
2333b11a16aSHongbin Zheng }
2343b11a16aSHongbin Zheng
2353b11a16aSHongbin Zheng NewInst->replaceUsesOfWith(OldOperand, NewOperand);
2363b11a16aSHongbin Zheng }
2373b11a16aSHongbin Zheng
2383b11a16aSHongbin Zheng Builder.Insert(NewInst);
2393b11a16aSHongbin Zheng BBMap[Inst] = NewInst;
2403b11a16aSHongbin Zheng
241188053afSSingapuram Sanjay Srivallabh // When copying the instruction onto the Module meant for the GPU,
242188053afSSingapuram Sanjay Srivallabh // debug metadata attached to an instruction causes all related
243188053afSSingapuram Sanjay Srivallabh // metadata to be pulled into the Module. This includes the DICompileUnit,
244188053afSSingapuram Sanjay Srivallabh // which will not be listed in llvm.dbg.cu of the Module since the Module
245188053afSSingapuram Sanjay Srivallabh // doesn't contain one. This fails the verification of the Module and the
246188053afSSingapuram Sanjay Srivallabh // subsequent generation of the ASM string.
247188053afSSingapuram Sanjay Srivallabh if (NewInst->getModule() != Inst->getModule())
248188053afSSingapuram Sanjay Srivallabh NewInst->setDebugLoc(llvm::DebugLoc());
249188053afSSingapuram Sanjay Srivallabh
2503b11a16aSHongbin Zheng if (!NewInst->getType()->isVoidTy())
2513b11a16aSHongbin Zheng NewInst->setName("p_" + Inst->getName());
2523b11a16aSHongbin Zheng }
2533b11a16aSHongbin Zheng
25470131d34SMichael Kruse Value *
generateLocationAccessed(ScopStmt & Stmt,MemAccInst Inst,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)25570131d34SMichael Kruse BlockGenerator::generateLocationAccessed(ScopStmt &Stmt, MemAccInst Inst,
25670131d34SMichael Kruse ValueMapT &BBMap, LoopToScevMapT <S,
25770131d34SMichael Kruse isl_id_to_ast_expr *NewAccesses) {
25809214772STobias Grosser const MemoryAccess &MA = Stmt.getArrayAccessFor(Inst);
2592fa35194SMichael Kruse return generateLocationAccessed(
2602fa35194SMichael Kruse Stmt, getLoopForStmt(Stmt),
2612fa35194SMichael Kruse Inst.isNull() ? nullptr : Inst.getPointerOperand(), BBMap, LTS,
262fe46c3ffSTobias Grosser NewAccesses, MA.getId().release(), MA.getAccessValue()->getType());
2632fa35194SMichael Kruse }
2643b11a16aSHongbin Zheng
generateLocationAccessed(ScopStmt & Stmt,Loop * L,Value * Pointer,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses,__isl_take isl_id * Id,Type * ExpectedType)2652fa35194SMichael Kruse Value *BlockGenerator::generateLocationAccessed(
2662fa35194SMichael Kruse ScopStmt &Stmt, Loop *L, Value *Pointer, ValueMapT &BBMap,
2672fa35194SMichael Kruse LoopToScevMapT <S, isl_id_to_ast_expr *NewAccesses, __isl_take isl_id *Id,
2682fa35194SMichael Kruse Type *ExpectedType) {
2692fa35194SMichael Kruse isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, Id);
2703b11a16aSHongbin Zheng
2712d1ed0bfSTobias Grosser if (AccessExpr) {
2722d1ed0bfSTobias Grosser AccessExpr = isl_ast_expr_address_of(AccessExpr);
27398b3ee50STobias Grosser auto Address = ExprBuilder->create(AccessExpr);
27498b3ee50STobias Grosser
27598b3ee50STobias Grosser // Cast the address of this memory access to a pointer type that has the
27698b3ee50STobias Grosser // same element type as the original access, but uses the address space of
27798b3ee50STobias Grosser // the newly generated pointer.
2782fa35194SMichael Kruse auto OldPtrTy = ExpectedType->getPointerTo();
27998b3ee50STobias Grosser auto NewPtrTy = Address->getType();
28043705149SEli Friedman OldPtrTy = PointerType::getWithSamePointeeType(
28143705149SEli Friedman OldPtrTy, NewPtrTy->getPointerAddressSpace());
28298b3ee50STobias Grosser
283d840fc72STobias Grosser if (OldPtrTy != NewPtrTy)
28498b3ee50STobias Grosser Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
28598b3ee50STobias Grosser return Address;
2862d1ed0bfSTobias Grosser }
2872fa35194SMichael Kruse assert(
2882fa35194SMichael Kruse Pointer &&
2892fa35194SMichael Kruse "If expression was not generated, must use the original pointer value");
2902fa35194SMichael Kruse return getNewValue(Stmt, Pointer, BBMap, LTS, L);
2912fa35194SMichael Kruse }
2922d1ed0bfSTobias Grosser
2932fa35194SMichael Kruse Value *
getImplicitAddress(MemoryAccess & Access,Loop * L,LoopToScevMapT & LTS,ValueMapT & BBMap,__isl_keep isl_id_to_ast_expr * NewAccesses)2942fa35194SMichael Kruse BlockGenerator::getImplicitAddress(MemoryAccess &Access, Loop *L,
2952fa35194SMichael Kruse LoopToScevMapT <S, ValueMapT &BBMap,
2962fa35194SMichael Kruse __isl_keep isl_id_to_ast_expr *NewAccesses) {
2972fa35194SMichael Kruse if (Access.isLatestArrayKind())
2982fa35194SMichael Kruse return generateLocationAccessed(*Access.getStatement(), L, nullptr, BBMap,
299fe46c3ffSTobias Grosser LTS, NewAccesses, Access.getId().release(),
3002fa35194SMichael Kruse Access.getAccessValue()->getType());
3012fa35194SMichael Kruse
302587f1f57STobias Grosser return getOrCreateAlloca(Access);
3033b11a16aSHongbin Zheng }
3043b11a16aSHongbin Zheng
getLoopForStmt(const ScopStmt & Stmt) const3052c3ffc04SJohannes Doerfert Loop *BlockGenerator::getLoopForStmt(const ScopStmt &Stmt) const {
306375cb5feSMichael Kruse auto *StmtBB = Stmt.getEntryBlock();
3072c3ffc04SJohannes Doerfert return LI.getLoopFor(StmtBB);
308369430ffSTobias Grosser }
309369430ffSTobias Grosser
generateArrayLoad(ScopStmt & Stmt,LoadInst * Load,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)310888ab551SMichael Kruse Value *BlockGenerator::generateArrayLoad(ScopStmt &Stmt, LoadInst *Load,
311bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S,
3122d1ed0bfSTobias Grosser isl_id_to_ast_expr *NewAccesses) {
313c1db67e2SJohannes Doerfert if (Value *PreloadLoad = GlobalMap.lookup(Load))
314c1db67e2SJohannes Doerfert return PreloadLoad;
315c1db67e2SJohannes Doerfert
316bc132607STobias Grosser Value *NewPointer =
31770131d34SMichael Kruse generateLocationAccessed(Stmt, Load, BBMap, LTS, NewAccesses);
318ff9b37e9SNikita Popov Value *ScalarLoad =
319ff9b37e9SNikita Popov Builder.CreateAlignedLoad(Load->getType(), NewPointer, Load->getAlign(),
32007c9d532SGuillaume Chatelet 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
generateArrayStore(ScopStmt & Stmt,StoreInst * Store,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)329888ab551SMichael Kruse void BlockGenerator::generateArrayStore(ScopStmt &Stmt, StoreInst *Store,
330bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S,
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
34659f95222SGuillaume Chatelet Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlign());
347706f79abSMichael Kruse });
3483b11a16aSHongbin Zheng }
3493b11a16aSHongbin Zheng
canSyntheziseInStmt(ScopStmt & Stmt,Instruction * Inst)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
copyInstruction(ScopStmt & Stmt,Instruction * Inst,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)3562f1acac6STobias Grosser void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
357bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S,
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
removeDeadInstructions(BasicBlock * BB,ValueMapT & BBMap)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
copyStmt(ScopStmt & Stmt,LoopToScevMapT & LTS,__isl_keep isl_id_to_ast_expr * NewAccesses)416bc132607STobias Grosser void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT <S,
417ad84c6f6SMichael Kruse __isl_keep 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
splitBB(BasicBlock * BB)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
copyBB(ScopStmt & Stmt,BasicBlock * BB,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)435514f6efaSJohannes Doerfert BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
436bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S,
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
copyBB(ScopStmt & Stmt,BasicBlock * BB,BasicBlock * CopyBB,ValueMapT & BBMap,LoopToScevMapT & LTS,isl_id_to_ast_expr * NewAccesses)451514f6efaSJohannes Doerfert void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
452bc132607STobias Grosser ValueMapT &BBMap, LoopToScevMapT <S,
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
getOrCreateAlloca(const MemoryAccess & Access)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
getOrCreateAlloca(const ScopArrayInfo * Array)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
5144f04db4bSEli Friedman Addr =
5154f04db4bSEli Friedman new AllocaInst(Ty, DL.getAllocaAddrSpace(), nullptr,
5164f04db4bSEli Friedman DL.getPrefTypeAlign(Ty), ScalarBase->getName() + NameExt);
517587f1f57STobias Grosser EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
518587f1f57STobias Grosser Addr->insertBefore(&*EntryBB->getFirstInsertionPt());
519587f1f57STobias Grosser
520587f1f57STobias Grosser return Addr;
521f8d55f7eSTobias Grosser }
522f8d55f7eSTobias Grosser
handleOutsideUsers(const Scop & S,ScopArrayInfo * Array)523587f1f57STobias Grosser void BlockGenerator::handleOutsideUsers(const Scop &S, ScopArrayInfo *Array) {
524587f1f57STobias Grosser Instruction *Inst = cast<Instruction>(Array->getBasePtr());
525b79a67dfSTobias Grosser
5262985400aSTobias Grosser // If there are escape users we get the alloca for this instruction and put it
5272985400aSTobias Grosser // in the EscapeMap for later finalization. Lastly, if the instruction was
5282985400aSTobias Grosser // copied multiple times we already did this and can exit.
529acb6ade7SMichael Kruse if (EscapeMap.count(Inst))
530acb6ade7SMichael Kruse return;
531e69e1141SJohannes Doerfert
532ecff11dcSJohannes Doerfert EscapeUserVectorTy EscapeUsers;
533ecff11dcSJohannes Doerfert for (User *U : Inst->users()) {
534ecff11dcSJohannes Doerfert
535ecff11dcSJohannes Doerfert // Non-instruction user will never escape.
536ecff11dcSJohannes Doerfert Instruction *UI = dyn_cast<Instruction>(U);
537ecff11dcSJohannes Doerfert if (!UI)
538ecff11dcSJohannes Doerfert continue;
539ecff11dcSJohannes Doerfert
540952b5304SJohannes Doerfert if (S.contains(UI))
541ecff11dcSJohannes Doerfert continue;
542ecff11dcSJohannes Doerfert
543ecff11dcSJohannes Doerfert EscapeUsers.push_back(UI);
544ecff11dcSJohannes Doerfert }
545ecff11dcSJohannes Doerfert
546ecff11dcSJohannes Doerfert // Exit if no escape uses were found.
547ecff11dcSJohannes Doerfert if (EscapeUsers.empty())
548ecff11dcSJohannes Doerfert return;
549ecff11dcSJohannes Doerfert
550ecff11dcSJohannes Doerfert // Get or create an escape alloca for this instruction.
551587f1f57STobias Grosser auto *ScalarAddr = getOrCreateAlloca(Array);
552ecff11dcSJohannes Doerfert
553ecff11dcSJohannes Doerfert // Remember that this instruction has escape uses and the escape alloca.
554ecff11dcSJohannes Doerfert EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
555ecff11dcSJohannes Doerfert }
556ecff11dcSJohannes Doerfert
generateScalarLoads(ScopStmt & Stmt,LoopToScevMapT & LTS,ValueMapT & BBMap,__isl_keep isl_id_to_ast_expr * NewAccesses)5572fa35194SMichael Kruse void BlockGenerator::generateScalarLoads(
5582fa35194SMichael Kruse ScopStmt &Stmt, LoopToScevMapT <S, ValueMapT &BBMap,
5592fa35194SMichael Kruse __isl_keep isl_id_to_ast_expr *NewAccesses) {
560225f0d1eSMichael Kruse for (MemoryAccess *MA : Stmt) {
5612fa35194SMichael Kruse if (MA->isOriginalArrayKind() || MA->isWrite())
562ecff11dcSJohannes Doerfert continue;
563ecff11dcSJohannes Doerfert
56477394f13SMichael Kruse #ifndef NDEBUG
5654485ae08SMichael Kruse auto StmtDom =
5664485ae08SMichael Kruse Stmt.getDomain().intersect_params(Stmt.getParent()->getContext());
567388730c9SMichael Kruse auto AccDom = MA->getAccessRelation().domain();
568388730c9SMichael Kruse assert(!StmtDom.is_subset(AccDom).is_false() &&
56977394f13SMichael Kruse "Scalar must be loaded in all statement instances");
57077394f13SMichael Kruse #endif
57177394f13SMichael Kruse
5722fa35194SMichael Kruse auto *Address =
5732fa35194SMichael Kruse getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS, BBMap, NewAccesses);
574eac9726eSMichael Kruse assert((!isa<Instruction>(Address) ||
575eac9726eSMichael Kruse DT.dominates(cast<Instruction>(Address)->getParent(),
576eac9726eSMichael Kruse Builder.GetInsertBlock())) &&
577eac9726eSMichael Kruse "Domination violation");
578ff9b37e9SNikita Popov BBMap[MA->getAccessValue()] = Builder.CreateLoad(
579ff9b37e9SNikita Popov MA->getElementType(), Address, Address->getName() + ".reload");
580ecff11dcSJohannes Doerfert }
581ecff11dcSJohannes Doerfert }
582ecff11dcSJohannes Doerfert
buildContainsCondition(ScopStmt & Stmt,const isl::set & Subdomain)583706f79abSMichael Kruse Value *BlockGenerator::buildContainsCondition(ScopStmt &Stmt,
584706f79abSMichael Kruse const isl::set &Subdomain) {
585132860afSTobias Grosser isl::ast_build AstBuild = Stmt.getAstBuild();
586dcf8d696STobias Grosser isl::set Domain = Stmt.getDomain();
587706f79abSMichael Kruse
5886b6ac900STobias Grosser isl::union_map USchedule = AstBuild.get_schedule();
5896b6ac900STobias Grosser USchedule = USchedule.intersect_domain(Domain);
590706f79abSMichael Kruse
5916b6ac900STobias Grosser assert(!USchedule.is_empty());
5926b6ac900STobias Grosser isl::map Schedule = isl::map::from_union_map(USchedule);
593706f79abSMichael Kruse
5946b6ac900STobias Grosser isl::set ScheduledDomain = Schedule.range();
5956b6ac900STobias Grosser isl::set ScheduledSet = Subdomain.apply(Schedule);
596706f79abSMichael Kruse
5976b6ac900STobias Grosser isl::ast_build RestrictedBuild = AstBuild.restrict(ScheduledDomain);
5986b6ac900STobias Grosser
5996b6ac900STobias Grosser isl::ast_expr IsInSet = RestrictedBuild.expr_from(ScheduledSet);
600706f79abSMichael Kruse Value *IsInSetExpr = ExprBuilder->create(IsInSet.copy());
601706f79abSMichael Kruse IsInSetExpr = Builder.CreateICmpNE(
602706f79abSMichael Kruse IsInSetExpr, ConstantInt::get(IsInSetExpr->getType(), 0));
603706f79abSMichael Kruse
604706f79abSMichael Kruse return IsInSetExpr;
605706f79abSMichael Kruse }
606706f79abSMichael Kruse
generateConditionalExecution(ScopStmt & Stmt,const isl::set & Subdomain,StringRef Subject,const std::function<void ()> & GenThenFunc)607706f79abSMichael Kruse void BlockGenerator::generateConditionalExecution(
608706f79abSMichael Kruse ScopStmt &Stmt, const isl::set &Subdomain, StringRef Subject,
609706f79abSMichael Kruse const std::function<void()> &GenThenFunc) {
610dcf8d696STobias Grosser isl::set StmtDom = Stmt.getDomain();
611706f79abSMichael Kruse
612706f79abSMichael Kruse // If the condition is a tautology, don't generate a condition around the
613706f79abSMichael Kruse // code.
614f51decb5STobias Grosser bool IsPartialWrite =
6158ea1fc19STobias Grosser !StmtDom.intersect_params(Stmt.getParent()->getContext())
616f51decb5STobias Grosser .is_subset(Subdomain);
617f51decb5STobias Grosser if (!IsPartialWrite) {
618706f79abSMichael Kruse GenThenFunc();
619706f79abSMichael Kruse return;
620706f79abSMichael Kruse }
621706f79abSMichael Kruse
622706f79abSMichael Kruse // Generate the condition.
623706f79abSMichael Kruse Value *Cond = buildContainsCondition(Stmt, Subdomain);
624b795bfc0SMichael Kruse
625b795bfc0SMichael Kruse // Don't call GenThenFunc if it is never executed. An ast index expression
626b795bfc0SMichael Kruse // might not be defined in this case.
627b795bfc0SMichael Kruse if (auto *Const = dyn_cast<ConstantInt>(Cond))
628b795bfc0SMichael Kruse if (Const->isZero())
629b795bfc0SMichael Kruse return;
630b795bfc0SMichael Kruse
631706f79abSMichael Kruse BasicBlock *HeadBlock = Builder.GetInsertBlock();
632706f79abSMichael Kruse StringRef BlockName = HeadBlock->getName();
633706f79abSMichael Kruse
634706f79abSMichael Kruse // Generate the conditional block.
635706f79abSMichael Kruse SplitBlockAndInsertIfThen(Cond, &*Builder.GetInsertPoint(), false, nullptr,
636706f79abSMichael Kruse &DT, &LI);
637706f79abSMichael Kruse BranchInst *Branch = cast<BranchInst>(HeadBlock->getTerminator());
638706f79abSMichael Kruse BasicBlock *ThenBlock = Branch->getSuccessor(0);
639706f79abSMichael Kruse BasicBlock *TailBlock = Branch->getSuccessor(1);
640706f79abSMichael Kruse
641706f79abSMichael Kruse // Assign descriptive names.
642706f79abSMichael Kruse if (auto *CondInst = dyn_cast<Instruction>(Cond))
643706f79abSMichael Kruse CondInst->setName("polly." + Subject + ".cond");
644706f79abSMichael Kruse ThenBlock->setName(BlockName + "." + Subject + ".partial");
645706f79abSMichael Kruse TailBlock->setName(BlockName + ".cont");
646706f79abSMichael Kruse
647706f79abSMichael Kruse // Put the client code into the conditional block and continue in the merge
648706f79abSMichael Kruse // block afterwards.
649706f79abSMichael Kruse Builder.SetInsertPoint(ThenBlock, ThenBlock->getFirstInsertionPt());
650706f79abSMichael Kruse GenThenFunc();
651706f79abSMichael Kruse Builder.SetInsertPoint(TailBlock, TailBlock->getFirstInsertionPt());
652706f79abSMichael Kruse }
653706f79abSMichael Kruse
getInstName(Value * Val)654e819fffeSMichael Kruse static std::string getInstName(Value *Val) {
655e819fffeSMichael Kruse std::string Result;
656e819fffeSMichael Kruse raw_string_ostream OS(Result);
657e819fffeSMichael Kruse Val->printAsOperand(OS, false);
658e819fffeSMichael Kruse return OS.str();
659e819fffeSMichael Kruse }
660e819fffeSMichael Kruse
generateBeginStmtTrace(ScopStmt & Stmt,LoopToScevMapT & LTS,ValueMapT & BBMap)661e819fffeSMichael Kruse void BlockGenerator::generateBeginStmtTrace(ScopStmt &Stmt, LoopToScevMapT <S,
662e819fffeSMichael Kruse ValueMapT &BBMap) {
663e819fffeSMichael Kruse if (!TraceStmts)
664e819fffeSMichael Kruse return;
665e819fffeSMichael Kruse
666e819fffeSMichael Kruse Scop *S = Stmt.getParent();
667e819fffeSMichael Kruse const char *BaseName = Stmt.getBaseName();
668e819fffeSMichael Kruse
669e819fffeSMichael Kruse isl::ast_build AstBuild = Stmt.getAstBuild();
670e819fffeSMichael Kruse isl::set Domain = Stmt.getDomain();
671e819fffeSMichael Kruse
672e819fffeSMichael Kruse isl::union_map USchedule = AstBuild.get_schedule().intersect_domain(Domain);
673e819fffeSMichael Kruse isl::map Schedule = isl::map::from_union_map(USchedule);
674e819fffeSMichael Kruse assert(Schedule.is_empty().is_false() &&
675e819fffeSMichael Kruse "The stmt must have a valid instance");
676e819fffeSMichael Kruse
677e819fffeSMichael Kruse isl::multi_pw_aff ScheduleMultiPwAff =
678e819fffeSMichael Kruse isl::pw_multi_aff::from_map(Schedule.reverse());
679e819fffeSMichael Kruse isl::ast_build RestrictedBuild = AstBuild.restrict(Schedule.range());
680e819fffeSMichael Kruse
681e819fffeSMichael Kruse // Sequence of strings to print.
682e819fffeSMichael Kruse SmallVector<llvm::Value *, 8> Values;
683e819fffeSMichael Kruse
684e819fffeSMichael Kruse // Print the name of the statement.
685e819fffeSMichael Kruse // TODO: Indent by the depth of the statement instance in the schedule tree.
686e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, BaseName));
687e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "("));
688e819fffeSMichael Kruse
689e819fffeSMichael Kruse // Add the coordinate of the statement instance.
69044596fe6SRiccardo Mori for (unsigned i : rangeIslSize(0, ScheduleMultiPwAff.dim(isl::dim::out))) {
691e819fffeSMichael Kruse if (i > 0)
692e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ","));
693e819fffeSMichael Kruse
694d3fdbda6SRiccardo Mori isl::ast_expr IsInSet = RestrictedBuild.expr_from(ScheduleMultiPwAff.at(i));
695e819fffeSMichael Kruse Values.push_back(ExprBuilder->create(IsInSet.copy()));
696e819fffeSMichael Kruse }
697e819fffeSMichael Kruse
698e819fffeSMichael Kruse if (TraceScalars) {
699e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")"));
700e819fffeSMichael Kruse DenseSet<Instruction *> Encountered;
701e819fffeSMichael Kruse
702e819fffeSMichael Kruse // Add the value of each scalar (and the result of PHIs) used in the
703e819fffeSMichael Kruse // statement.
704e819fffeSMichael Kruse // TODO: Values used in region-statements.
705e819fffeSMichael Kruse for (Instruction *Inst : Stmt.insts()) {
706e819fffeSMichael Kruse if (!RuntimeDebugBuilder::isPrintable(Inst->getType()))
707e819fffeSMichael Kruse continue;
708e819fffeSMichael Kruse
709e819fffeSMichael Kruse if (isa<PHINode>(Inst)) {
710e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, " "));
711e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(
712e819fffeSMichael Kruse Builder, getInstName(Inst)));
713e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "="));
714e819fffeSMichael Kruse Values.push_back(getNewValue(Stmt, Inst, BBMap, LTS,
715e819fffeSMichael Kruse LI.getLoopFor(Inst->getParent())));
716e819fffeSMichael Kruse } else {
717e819fffeSMichael Kruse for (Value *Op : Inst->operand_values()) {
718e819fffeSMichael Kruse // Do not print values that cannot change during the execution of the
719e819fffeSMichael Kruse // SCoP.
720e819fffeSMichael Kruse auto *OpInst = dyn_cast<Instruction>(Op);
721e819fffeSMichael Kruse if (!OpInst)
722e819fffeSMichael Kruse continue;
723e819fffeSMichael Kruse if (!S->contains(OpInst))
724e819fffeSMichael Kruse continue;
725e819fffeSMichael Kruse
726e819fffeSMichael Kruse // Print each scalar at most once, and exclude values defined in the
727e819fffeSMichael Kruse // statement itself.
728e819fffeSMichael Kruse if (Encountered.count(OpInst))
729e819fffeSMichael Kruse continue;
730e819fffeSMichael Kruse
731e819fffeSMichael Kruse Values.push_back(
732e819fffeSMichael Kruse RuntimeDebugBuilder::getPrintableString(Builder, " "));
733e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(
734e819fffeSMichael Kruse Builder, getInstName(OpInst)));
735e819fffeSMichael Kruse Values.push_back(
736e819fffeSMichael Kruse RuntimeDebugBuilder::getPrintableString(Builder, "="));
737e819fffeSMichael Kruse Values.push_back(getNewValue(Stmt, OpInst, BBMap, LTS,
738e819fffeSMichael Kruse LI.getLoopFor(Inst->getParent())));
739e819fffeSMichael Kruse Encountered.insert(OpInst);
740e819fffeSMichael Kruse }
741e819fffeSMichael Kruse }
742e819fffeSMichael Kruse
743e819fffeSMichael Kruse Encountered.insert(Inst);
744e819fffeSMichael Kruse }
745e819fffeSMichael Kruse
746e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, "\n"));
747e819fffeSMichael Kruse } else {
748e819fffeSMichael Kruse Values.push_back(RuntimeDebugBuilder::getPrintableString(Builder, ")\n"));
749e819fffeSMichael Kruse }
750e819fffeSMichael Kruse
751e819fffeSMichael Kruse RuntimeDebugBuilder::createCPUPrinter(Builder, ArrayRef<Value *>(Values));
752e819fffeSMichael Kruse }
753e819fffeSMichael Kruse
generateScalarStores(ScopStmt & Stmt,LoopToScevMapT & LTS,ValueMapT & BBMap,__isl_keep isl_id_to_ast_expr * NewAccesses)7542fa35194SMichael Kruse void BlockGenerator::generateScalarStores(
7552fa35194SMichael Kruse ScopStmt &Stmt, LoopToScevMapT <S, ValueMapT &BBMap,
7562fa35194SMichael Kruse __isl_keep isl_id_to_ast_expr *NewAccesses) {
757f2cdd144STobias Grosser Loop *L = LI.getLoopFor(Stmt.getBasicBlock());
758ecff11dcSJohannes Doerfert
75921a059afSTobias Grosser assert(Stmt.isBlockStmt() &&
76021a059afSTobias Grosser "Region statements need to use the generateScalarStores() function in "
76121a059afSTobias Grosser "the RegionGenerator");
762ecff11dcSJohannes Doerfert
763ecff11dcSJohannes Doerfert for (MemoryAccess *MA : Stmt) {
7642fa35194SMichael Kruse if (MA->isOriginalArrayKind() || MA->isRead())
765ecff11dcSJohannes Doerfert continue;
766ecff11dcSJohannes Doerfert
7671515f6b9STobias Grosser isl::set AccDom = MA->getAccessRelation().domain();
768fe46c3ffSTobias Grosser std::string Subject = MA->getId().get_name();
76977394f13SMichael Kruse
770fe46c3ffSTobias Grosser generateConditionalExecution(
771fe46c3ffSTobias Grosser Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
772d86f2157SJohannes Doerfert Value *Val = MA->getAccessValue();
773ee6a4fc6SMichael Kruse if (MA->isAnyPHIKind()) {
774fe46c3ffSTobias Grosser assert(MA->getIncoming().size() >= 1 &&
775fe46c3ffSTobias Grosser "Block statements have exactly one exiting block, or "
776fe46c3ffSTobias Grosser "multiple but "
777ee6a4fc6SMichael Kruse "with same incoming block and value");
778fe46c3ffSTobias Grosser assert(std::all_of(MA->getIncoming().begin(),
779fe46c3ffSTobias Grosser MA->getIncoming().end(),
780ee6a4fc6SMichael Kruse [&](std::pair<BasicBlock *, Value *> p) -> bool {
781ee6a4fc6SMichael Kruse return p.first == Stmt.getBasicBlock();
782ee6a4fc6SMichael Kruse }) &&
783ee6a4fc6SMichael Kruse "Incoming block must be statement's block");
784ee6a4fc6SMichael Kruse Val = MA->getIncoming()[0].second;
785ee6a4fc6SMichael Kruse }
786fe46c3ffSTobias Grosser auto Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
787fe46c3ffSTobias Grosser BBMap, NewAccesses);
788d86f2157SJohannes Doerfert
789f2cdd144STobias Grosser Val = getNewValue(Stmt, Val, BBMap, LTS, L);
790eac9726eSMichael Kruse assert((!isa<Instruction>(Val) ||
791eac9726eSMichael Kruse DT.dominates(cast<Instruction>(Val)->getParent(),
792eac9726eSMichael Kruse Builder.GetInsertBlock())) &&
793eac9726eSMichael Kruse "Domination violation");
794eac9726eSMichael Kruse assert((!isa<Instruction>(Address) ||
795eac9726eSMichael Kruse DT.dominates(cast<Instruction>(Address)->getParent(),
796eac9726eSMichael Kruse Builder.GetInsertBlock())) &&
797eac9726eSMichael Kruse "Domination violation");
7982f5cbc44SMichael Kruse
7992f5cbc44SMichael Kruse // The new Val might have a different type than the old Val due to
8002f5cbc44SMichael Kruse // ScalarEvolution looking through bitcasts.
8012f5cbc44SMichael Kruse Address = Builder.CreateBitOrPointerCast(
8028422bfa3SEli Friedman Address, Val->getType()->getPointerTo(
8038422bfa3SEli Friedman Address->getType()->getPointerAddressSpace()));
8042f5cbc44SMichael Kruse
80592245228STobias Grosser Builder.CreateStore(Val, Address);
806706f79abSMichael Kruse });
807ecff11dcSJohannes Doerfert }
808ecff11dcSJohannes Doerfert }
809ecff11dcSJohannes Doerfert
createScalarInitialization(Scop & S)810c0091a77STobias Grosser void BlockGenerator::createScalarInitialization(Scop &S) {
811ef74443cSJohannes Doerfert BasicBlock *ExitBB = S.getExit();
812acf80064SEli Friedman BasicBlock *PreEntryBB = S.getEnteringBlock();
813188542fdSJohannes Doerfert
814acf80064SEli Friedman Builder.SetInsertPoint(&*StartBlock->begin());
815ecff11dcSJohannes Doerfert
816d7754a12SRoman Gareev for (auto &Array : S.arrays()) {
817c0091a77STobias Grosser if (Array->getNumberOfDimensions() != 0)
818c0091a77STobias Grosser continue;
819a535dff4STobias Grosser if (Array->isPHIKind()) {
820c0091a77STobias Grosser // For PHI nodes, the only values we need to store are the ones that
821c0091a77STobias Grosser // reach the PHI node from outside the region. In general there should
822c0091a77STobias Grosser // only be one such incoming edge and this edge should enter through
823acf80064SEli Friedman // 'PreEntryBB'.
824c0091a77STobias Grosser auto PHI = cast<PHINode>(Array->getBasePtr());
825ecff11dcSJohannes Doerfert
826c0091a77STobias Grosser for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
827acf80064SEli Friedman if (!S.contains(*BI) && *BI != PreEntryBB)
828c0091a77STobias Grosser llvm_unreachable("Incoming edges from outside the scop should always "
829acf80064SEli Friedman "come from PreEntryBB");
830c0091a77STobias Grosser
831acf80064SEli Friedman int Idx = PHI->getBasicBlockIndex(PreEntryBB);
832c0091a77STobias Grosser if (Idx < 0)
833ecff11dcSJohannes Doerfert continue;
834ecff11dcSJohannes Doerfert
835c0091a77STobias Grosser Value *ScalarValue = PHI->getIncomingValue(Idx);
836ecff11dcSJohannes Doerfert
837587f1f57STobias Grosser Builder.CreateStore(ScalarValue, getOrCreateAlloca(Array));
838c0091a77STobias Grosser continue;
839c0091a77STobias Grosser }
840c0091a77STobias Grosser
841c0091a77STobias Grosser auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
842c0091a77STobias Grosser
843952b5304SJohannes Doerfert if (Inst && S.contains(Inst))
844c0091a77STobias Grosser continue;
845c0091a77STobias Grosser
846188542fdSJohannes Doerfert // PHI nodes that are not marked as such in their SAI object are either exit
847188542fdSJohannes Doerfert // PHI nodes we model as common scalars but without initialization, or
848188542fdSJohannes Doerfert // incoming phi nodes that need to be initialized. Check if the first is the
849188542fdSJohannes Doerfert // case for Inst and do not create and initialize memory if so.
850188542fdSJohannes Doerfert if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
851188542fdSJohannes Doerfert if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
852717b8667SJohannes Doerfert continue;
853717b8667SJohannes Doerfert
854587f1f57STobias Grosser Builder.CreateStore(Array->getBasePtr(), getOrCreateAlloca(Array));
855ecff11dcSJohannes Doerfert }
856ecff11dcSJohannes Doerfert }
857ecff11dcSJohannes Doerfert
createScalarFinalization(Scop & S)858ef74443cSJohannes Doerfert void BlockGenerator::createScalarFinalization(Scop &S) {
859ecff11dcSJohannes Doerfert // The exit block of the __unoptimized__ region.
860ef74443cSJohannes Doerfert BasicBlock *ExitBB = S.getExitingBlock();
861ecff11dcSJohannes Doerfert // The merge block __just after__ the region and the optimized region.
862ef74443cSJohannes Doerfert BasicBlock *MergeBB = S.getExit();
863ecff11dcSJohannes Doerfert
864ecff11dcSJohannes Doerfert // The exit block of the __optimized__ region.
865ecff11dcSJohannes Doerfert BasicBlock *OptExitBB = *(pred_begin(MergeBB));
866ecff11dcSJohannes Doerfert if (OptExitBB == ExitBB)
867ecff11dcSJohannes Doerfert OptExitBB = *(++pred_begin(MergeBB));
868ecff11dcSJohannes Doerfert
869ecff11dcSJohannes Doerfert Builder.SetInsertPoint(OptExitBB->getTerminator());
870ecff11dcSJohannes Doerfert for (const auto &EscapeMapping : EscapeMap) {
871ecff11dcSJohannes Doerfert // Extract the escaping instruction and the escaping users as well as the
872ecff11dcSJohannes Doerfert // alloca the instruction was demoted to.
873fbde4355SMichael Kruse Instruction *EscapeInst = EscapeMapping.first;
874fbde4355SMichael Kruse const auto &EscapeMappingValue = EscapeMapping.second;
875ecff11dcSJohannes Doerfert const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
876ff9b37e9SNikita Popov auto *ScalarAddr = cast<AllocaInst>(&*EscapeMappingValue.first);
877ecff11dcSJohannes Doerfert
878ecff11dcSJohannes Doerfert // Reload the demoted instruction in the optimized version of the SCoP.
879d8b6ad25SJohannes Doerfert Value *EscapeInstReload =
880ff9b37e9SNikita Popov Builder.CreateLoad(ScalarAddr->getAllocatedType(), ScalarAddr,
881ff9b37e9SNikita Popov 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
findOutsideUsers(Scop & S)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
createExitPHINodeMerges(Scop & S)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
9590257a921SEli Friedman std::string Name = PHI->getName().str();
960587f1f57STobias Grosser Value *ScalarAddr = getOrCreateAlloca(SAI);
961ff9b37e9SNikita Popov Value *Reload = Builder.CreateLoad(SAI->getElementType(), ScalarAddr,
962ff9b37e9SNikita Popov Name + ".ph.final_reload");
96327d742daSTobias Grosser Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
96427d742daSTobias Grosser Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
965faedfcbfSMichael Kruse assert((!isa<Instruction>(OriginalValue) ||
966faedfcbfSMichael Kruse cast<Instruction>(OriginalValue)->getParent() != MergeBB) &&
967faedfcbfSMichael Kruse "Original value must no be one we just generated.");
96827d742daSTobias Grosser auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
969b8f58b53SDuncan P. N. Exon Smith MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
97027d742daSTobias Grosser MergePHI->addIncoming(Reload, OptExitBB);
97127d742daSTobias Grosser MergePHI->addIncoming(OriginalValue, ExitBB);
97227d742daSTobias Grosser int Idx = PHI->getBasicBlockIndex(MergeBB);
97327d742daSTobias Grosser PHI->setIncomingValue(Idx, MergePHI);
97427d742daSTobias Grosser }
97527d742daSTobias Grosser }
97627d742daSTobias Grosser
invalidateScalarEvolution(Scop & S)9771c184409STobias Grosser void BlockGenerator::invalidateScalarEvolution(Scop &S) {
9781c184409STobias Grosser for (auto &Stmt : S)
979b3224adfSRoman Gareev if (Stmt.isCopyStmt())
980b3224adfSRoman Gareev continue;
981b3224adfSRoman Gareev else if (Stmt.isBlockStmt())
9821c184409STobias Grosser for (auto &Inst : *Stmt.getBasicBlock())
9831c184409STobias Grosser SE.forgetValue(&Inst);
9841c184409STobias Grosser else if (Stmt.isRegionStmt())
9851c184409STobias Grosser for (auto *BB : Stmt.getRegion()->blocks())
9861c184409STobias Grosser for (auto &Inst : *BB)
9871c184409STobias Grosser SE.forgetValue(&Inst);
9881c184409STobias Grosser else
9891c184409STobias Grosser llvm_unreachable("Unexpected statement type found");
9901aad76c1SMichael Kruse
9911aad76c1SMichael Kruse // Invalidate SCEV of loops surrounding the EscapeUsers.
9921aad76c1SMichael Kruse for (const auto &EscapeMapping : EscapeMap) {
9931aad76c1SMichael Kruse const EscapeUserVectorTy &EscapeUsers = EscapeMapping.second.second;
9941aad76c1SMichael Kruse for (Instruction *EUser : EscapeUsers) {
9951aad76c1SMichael Kruse if (Loop *L = LI.getLoopFor(EUser->getParent()))
9961aad76c1SMichael Kruse while (L) {
9971aad76c1SMichael Kruse SE.forgetLoop(L);
9981aad76c1SMichael Kruse L = L->getParentLoop();
9991aad76c1SMichael Kruse }
10001aad76c1SMichael Kruse }
10011aad76c1SMichael Kruse }
10021c184409STobias Grosser }
10031c184409STobias Grosser
finalizeSCoP(Scop & S)1004ffa2446fSTobias Grosser void BlockGenerator::finalizeSCoP(Scop &S) {
1005ffa2446fSTobias Grosser findOutsideUsers(S);
1006c0091a77STobias Grosser createScalarInitialization(S);
100727d742daSTobias Grosser createExitPHINodeMerges(S);
1008ef74443cSJohannes Doerfert createScalarFinalization(S);
10091c184409STobias Grosser invalidateScalarEvolution(S);
10103b11a16aSHongbin Zheng }
10113b11a16aSHongbin Zheng
VectorBlockGenerator(BlockGenerator & BlockGen,std::vector<LoopToScevMapT> & VLTS,isl_map * Schedule)1012be9c9117SJohannes Doerfert VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
1013be9c9117SJohannes Doerfert std::vector<LoopToScevMapT> &VLTS,
1014be9c9117SJohannes Doerfert isl_map *Schedule)
1015bc132607STobias Grosser : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
1016a00a0291SSebastian Pop assert(Schedule && "No statement domain provided");
10173b11a16aSHongbin Zheng }
10183b11a16aSHongbin Zheng
getVectorValue(ScopStmt & Stmt,Value * Old,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps,Loop * L)10192f1acac6STobias Grosser Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
1020e602a076STobias Grosser ValueMapT &VectorMap,
1021e602a076STobias Grosser VectorValueMapT &ScalarMaps,
1022e602a076STobias Grosser Loop *L) {
1023fe11e287SHongbin Zheng if (Value *NewValue = VectorMap.lookup(Old))
1024fe11e287SHongbin Zheng return NewValue;
10253b11a16aSHongbin Zheng
10263b11a16aSHongbin Zheng int Width = getVectorWidth();
10273b11a16aSHongbin Zheng
1028b82a95f8SChristopher Tetreault Value *Vector = UndefValue::get(FixedVectorType::get(Old->getType(), Width));
10293b11a16aSHongbin Zheng
10303b11a16aSHongbin Zheng for (int Lane = 0; Lane < Width; Lane++)
1031c14582f2STobias Grosser Vector = Builder.CreateInsertElement(
1032bc132607STobias Grosser Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
10337242ad92STobias Grosser Builder.getInt32(Lane));
10343b11a16aSHongbin Zheng
10353b11a16aSHongbin Zheng VectorMap[Old] = Vector;
10363b11a16aSHongbin Zheng
10373b11a16aSHongbin Zheng return Vector;
10383b11a16aSHongbin Zheng }
10393b11a16aSHongbin Zheng
generateStrideOneLoad(ScopStmt & Stmt,LoadInst * Load,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses,bool NegativeStride=false)1040be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateStrideOneLoad(
10412f1acac6STobias Grosser ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
10422d1ed0bfSTobias Grosser __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
10430dd463faSTobias Grosser unsigned VectorWidth = getVectorWidth();
1044ff9b37e9SNikita Popov Type *VectorType = FixedVectorType::get(Load->getType(), VectorWidth);
1045ff9b37e9SNikita Popov Type *VectorPtrType =
1046ff9b37e9SNikita Popov PointerType::get(VectorType, Load->getPointerAddressSpace());
10470dd463faSTobias Grosser unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
10480dd463faSTobias Grosser
10498f25b0cbSMichael Kruse Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[Offset],
1050bc132607STobias Grosser VLTS[Offset], NewAccesses);
1051c14582f2STobias Grosser Value *VectorPtr =
1052c14582f2STobias Grosser Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
1053ff9b37e9SNikita Popov LoadInst *VecLoad = Builder.CreateLoad(VectorType, VectorPtr,
1054ff9b37e9SNikita Popov Load->getName() + "_p_vec_full");
10553b11a16aSHongbin Zheng if (!Aligned)
1056725efb35SGuillaume Chatelet VecLoad->setAlignment(Align(8));
10573b11a16aSHongbin Zheng
10580dd463faSTobias Grosser if (NegativeStride) {
10590dd463faSTobias Grosser SmallVector<Constant *, 16> Indices;
10600dd463faSTobias Grosser for (int i = VectorWidth - 1; i >= 0; i--)
10610dd463faSTobias Grosser Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
10620dd463faSTobias Grosser Constant *SV = llvm::ConstantVector::get(Indices);
10630dd463faSTobias Grosser Value *RevVecLoad = Builder.CreateShuffleVector(
10640dd463faSTobias Grosser VecLoad, VecLoad, SV, Load->getName() + "_reverse");
10650dd463faSTobias Grosser return RevVecLoad;
10660dd463faSTobias Grosser }
10670dd463faSTobias Grosser
10683b11a16aSHongbin Zheng return VecLoad;
10693b11a16aSHongbin Zheng }
10703b11a16aSHongbin Zheng
generateStrideZeroLoad(ScopStmt & Stmt,LoadInst * Load,ValueMapT & BBMap,__isl_keep isl_id_to_ast_expr * NewAccesses)10712d1ed0bfSTobias Grosser Value *VectorBlockGenerator::generateStrideZeroLoad(
10722f1acac6STobias Grosser ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
10732d1ed0bfSTobias Grosser __isl_keep isl_id_to_ast_expr *NewAccesses) {
1074ff9b37e9SNikita Popov Type *VectorType = FixedVectorType::get(Load->getType(), 1);
1075ff9b37e9SNikita Popov Type *VectorPtrType =
1076ff9b37e9SNikita Popov PointerType::get(VectorType, Load->getPointerAddressSpace());
107770131d34SMichael Kruse Value *NewPointer =
107870131d34SMichael Kruse generateLocationAccessed(Stmt, Load, BBMap, VLTS[0], NewAccesses);
10793b11a16aSHongbin Zheng Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
10803b11a16aSHongbin Zheng Load->getName() + "_p_vec_p");
1081ff9b37e9SNikita Popov LoadInst *ScalarLoad = Builder.CreateLoad(VectorType, VectorPtr,
1082ff9b37e9SNikita Popov Load->getName() + "_p_splat_one");
10833b11a16aSHongbin Zheng
10843b11a16aSHongbin Zheng if (!Aligned)
1085725efb35SGuillaume Chatelet ScalarLoad->setAlignment(Align(8));
10863b11a16aSHongbin Zheng
1087c14582f2STobias Grosser Constant *SplatVector = Constant::getNullValue(
1088b82a95f8SChristopher Tetreault FixedVectorType::get(Builder.getInt32Ty(), getVectorWidth()));
10893b11a16aSHongbin Zheng
1090c14582f2STobias Grosser Value *VectorLoad = Builder.CreateShuffleVector(
1091c14582f2STobias Grosser ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
10923b11a16aSHongbin Zheng return VectorLoad;
10933b11a16aSHongbin Zheng }
10943b11a16aSHongbin Zheng
generateUnknownStrideLoad(ScopStmt & Stmt,LoadInst * Load,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses)1095be9c9117SJohannes Doerfert Value *VectorBlockGenerator::generateUnknownStrideLoad(
10962f1acac6STobias Grosser ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
109709e3697fSJohannes Doerfert __isl_keep isl_id_to_ast_expr *NewAccesses) {
10983b11a16aSHongbin Zheng int VectorWidth = getVectorWidth();
1099ff9b37e9SNikita Popov Type *ElemTy = Load->getType();
1100ff9b37e9SNikita Popov auto *FVTy = FixedVectorType::get(ElemTy, VectorWidth);
11013b11a16aSHongbin Zheng
1102b82a95f8SChristopher Tetreault Value *Vector = UndefValue::get(FVTy);
11033b11a16aSHongbin Zheng
11043b11a16aSHongbin Zheng for (int i = 0; i < VectorWidth; i++) {
110570131d34SMichael Kruse Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[i],
110670131d34SMichael Kruse VLTS[i], NewAccesses);
1107c14582f2STobias Grosser Value *ScalarLoad =
1108ff9b37e9SNikita Popov Builder.CreateLoad(ElemTy, NewPointer, Load->getName() + "_p_scalar_");
1109c14582f2STobias Grosser Vector = Builder.CreateInsertElement(
1110c14582f2STobias Grosser Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
11113b11a16aSHongbin Zheng }
11123b11a16aSHongbin Zheng
11133b11a16aSHongbin Zheng return Vector;
11143b11a16aSHongbin Zheng }
11153b11a16aSHongbin Zheng
generateLoad(ScopStmt & Stmt,LoadInst * Load,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses)11162d1ed0bfSTobias Grosser void VectorBlockGenerator::generateLoad(
11172f1acac6STobias Grosser ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
11182d1ed0bfSTobias Grosser VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1119c1db67e2SJohannes Doerfert if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
1120c1db67e2SJohannes Doerfert VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
1121c1db67e2SJohannes Doerfert Load->getName() + "_p");
1122c1db67e2SJohannes Doerfert return;
1123c1db67e2SJohannes Doerfert }
1124c1db67e2SJohannes Doerfert
11252873645cSTobias Grosser if (!VectorType::isValidElementType(Load->getType())) {
11263b11a16aSHongbin Zheng for (int i = 0; i < getVectorWidth(); i++)
1127bc132607STobias Grosser ScalarMaps[i][Load] =
1128888ab551SMichael Kruse generateArrayLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
11293b11a16aSHongbin Zheng return;
11303b11a16aSHongbin Zheng }
11313b11a16aSHongbin Zheng
1132184a4926STobias Grosser const MemoryAccess &Access = Stmt.getArrayAccessFor(Load);
11333b11a16aSHongbin Zheng
113495493984STobias Grosser // Make sure we have scalar values available to access the pointer to
113595493984STobias Grosser // the data location.
113695493984STobias Grosser extractScalarValues(Load, VectorMap, ScalarMaps);
113795493984STobias Grosser
11383b11a16aSHongbin Zheng Value *NewLoad;
1139718d04c6STobias Grosser if (Access.isStrideZero(isl::manage_copy(Schedule)))
11402d1ed0bfSTobias Grosser NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
1141718d04c6STobias Grosser else if (Access.isStrideOne(isl::manage_copy(Schedule)))
11422d1ed0bfSTobias Grosser NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
1143718d04c6STobias Grosser else if (Access.isStrideX(isl::manage_copy(Schedule), -1))
11442d1ed0bfSTobias Grosser NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
11453b11a16aSHongbin Zheng else
11462d1ed0bfSTobias Grosser NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
11473b11a16aSHongbin Zheng
11483b11a16aSHongbin Zheng VectorMap[Load] = NewLoad;
11493b11a16aSHongbin Zheng }
11503b11a16aSHongbin Zheng
copyUnaryInst(ScopStmt & Stmt,UnaryInstruction * Inst,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps)11512f1acac6STobias Grosser void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
11523b11a16aSHongbin Zheng ValueMapT &VectorMap,
11533b11a16aSHongbin Zheng VectorValueMapT &ScalarMaps) {
11543b11a16aSHongbin Zheng int VectorWidth = getVectorWidth();
1155be9c9117SJohannes Doerfert Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
11562c3ffc04SJohannes Doerfert ScalarMaps, getLoopForStmt(Stmt));
11573b11a16aSHongbin Zheng
11583b11a16aSHongbin Zheng assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
11593b11a16aSHongbin Zheng
11603b11a16aSHongbin Zheng const CastInst *Cast = dyn_cast<CastInst>(Inst);
1161b82a95f8SChristopher Tetreault auto *DestType = FixedVectorType::get(Inst->getType(), VectorWidth);
11623b11a16aSHongbin Zheng VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
11633b11a16aSHongbin Zheng }
11643b11a16aSHongbin Zheng
copyBinaryInst(ScopStmt & Stmt,BinaryOperator * Inst,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps)11652f1acac6STobias Grosser void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
11663b11a16aSHongbin Zheng ValueMapT &VectorMap,
11673b11a16aSHongbin Zheng VectorValueMapT &ScalarMaps) {
11682c3ffc04SJohannes Doerfert Loop *L = getLoopForStmt(Stmt);
11693b11a16aSHongbin Zheng Value *OpZero = Inst->getOperand(0);
11703b11a16aSHongbin Zheng Value *OpOne = Inst->getOperand(1);
11713b11a16aSHongbin Zheng
11723b11a16aSHongbin Zheng Value *NewOpZero, *NewOpOne;
1173be9c9117SJohannes Doerfert NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
1174be9c9117SJohannes Doerfert NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
11753b11a16aSHongbin Zheng
11761bb59b0dSTobias Grosser Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
11773b11a16aSHongbin Zheng Inst->getName() + "p_vec");
11783b11a16aSHongbin Zheng VectorMap[Inst] = NewInst;
11793b11a16aSHongbin Zheng }
11803b11a16aSHongbin Zheng
copyStore(ScopStmt & Stmt,StoreInst * Store,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses)11812d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStore(
11822f1acac6STobias Grosser ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
11832d1ed0bfSTobias Grosser VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
1184184a4926STobias Grosser const MemoryAccess &Access = Stmt.getArrayAccessFor(Store);
11853b11a16aSHongbin Zheng
1186be9c9117SJohannes Doerfert Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
11872c3ffc04SJohannes Doerfert ScalarMaps, getLoopForStmt(Stmt));
11883b11a16aSHongbin Zheng
118950fd7010STobias Grosser // Make sure we have scalar values available to access the pointer to
119050fd7010STobias Grosser // the data location.
119150fd7010STobias Grosser extractScalarValues(Store, VectorMap, ScalarMaps);
119250fd7010STobias Grosser
1193718d04c6STobias Grosser if (Access.isStrideOne(isl::manage_copy(Schedule))) {
1194ff9b37e9SNikita Popov Type *VectorType = FixedVectorType::get(Store->getValueOperand()->getType(),
1195ff9b37e9SNikita Popov getVectorWidth());
1196ff9b37e9SNikita Popov Type *VectorPtrType =
1197ff9b37e9SNikita Popov PointerType::get(VectorType, Store->getPointerAddressSpace());
119870131d34SMichael Kruse Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[0],
119970131d34SMichael Kruse VLTS[0], NewAccesses);
12003b11a16aSHongbin Zheng
1201c14582f2STobias Grosser Value *VectorPtr =
1202c14582f2STobias Grosser Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
12033b11a16aSHongbin Zheng StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
12043b11a16aSHongbin Zheng
12053b11a16aSHongbin Zheng if (!Aligned)
1206d400d451SGuillaume Chatelet Store->setAlignment(Align(8));
12073b11a16aSHongbin Zheng } else {
12083b11a16aSHongbin Zheng for (unsigned i = 0; i < ScalarMaps.size(); i++) {
12091bb59b0dSTobias Grosser Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
121070131d34SMichael Kruse Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[i],
121170131d34SMichael Kruse VLTS[i], NewAccesses);
12123b11a16aSHongbin Zheng Builder.CreateStore(Scalar, NewPointer);
12133b11a16aSHongbin Zheng }
12143b11a16aSHongbin Zheng }
12153b11a16aSHongbin Zheng }
12163b11a16aSHongbin Zheng
hasVectorOperands(const Instruction * Inst,ValueMapT & VectorMap)12173b11a16aSHongbin Zheng bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
12183b11a16aSHongbin Zheng ValueMapT &VectorMap) {
121991f5b262STobias Grosser for (Value *Operand : Inst->operands())
122091f5b262STobias Grosser if (VectorMap.count(Operand))
12213b11a16aSHongbin Zheng return true;
12223b11a16aSHongbin Zheng return false;
12233b11a16aSHongbin Zheng }
12243b11a16aSHongbin Zheng
extractScalarValues(const Instruction * Inst,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps)12253b11a16aSHongbin Zheng bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
12263b11a16aSHongbin Zheng ValueMapT &VectorMap,
12273b11a16aSHongbin Zheng VectorValueMapT &ScalarMaps) {
12283b11a16aSHongbin Zheng bool HasVectorOperand = false;
12293b11a16aSHongbin Zheng int VectorWidth = getVectorWidth();
12303b11a16aSHongbin Zheng
123191f5b262STobias Grosser for (Value *Operand : Inst->operands()) {
123291f5b262STobias Grosser ValueMapT::iterator VecOp = VectorMap.find(Operand);
12333b11a16aSHongbin Zheng
12343b11a16aSHongbin Zheng if (VecOp == VectorMap.end())
12353b11a16aSHongbin Zheng continue;
12363b11a16aSHongbin Zheng
12373b11a16aSHongbin Zheng HasVectorOperand = true;
12383b11a16aSHongbin Zheng Value *NewVector = VecOp->second;
12393b11a16aSHongbin Zheng
12403b11a16aSHongbin Zheng for (int i = 0; i < VectorWidth; ++i) {
12413b11a16aSHongbin Zheng ValueMapT &SM = ScalarMaps[i];
12423b11a16aSHongbin Zheng
12433b11a16aSHongbin Zheng // If there is one scalar extracted, all scalar elements should have
12443b11a16aSHongbin Zheng // already been extracted by the code here. So no need to check for the
12452219d157STobias Grosser // existence of all of them.
124691f5b262STobias Grosser if (SM.count(Operand))
12473b11a16aSHongbin Zheng break;
12483b11a16aSHongbin Zheng
124991f5b262STobias Grosser SM[Operand] =
125091f5b262STobias Grosser Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
12513b11a16aSHongbin Zheng }
12523b11a16aSHongbin Zheng }
12533b11a16aSHongbin Zheng
12543b11a16aSHongbin Zheng return HasVectorOperand;
12553b11a16aSHongbin Zheng }
12563b11a16aSHongbin Zheng
copyInstScalarized(ScopStmt & Stmt,Instruction * Inst,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses)12572d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstScalarized(
12582f1acac6STobias Grosser ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
12592d1ed0bfSTobias Grosser VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
12603b11a16aSHongbin Zheng bool HasVectorOperand;
12613b11a16aSHongbin Zheng int VectorWidth = getVectorWidth();
12623b11a16aSHongbin Zheng
12633b11a16aSHongbin Zheng HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
12643b11a16aSHongbin Zheng
12653b11a16aSHongbin Zheng for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
1266be9c9117SJohannes Doerfert BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
1267bc132607STobias Grosser VLTS[VectorLane], NewAccesses);
12683b11a16aSHongbin Zheng
12693b11a16aSHongbin Zheng if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
12703b11a16aSHongbin Zheng return;
12713b11a16aSHongbin Zheng
12723b11a16aSHongbin Zheng // Make the result available as vector value.
1273b82a95f8SChristopher Tetreault auto *FVTy = FixedVectorType::get(Inst->getType(), VectorWidth);
1274b82a95f8SChristopher Tetreault Value *Vector = UndefValue::get(FVTy);
12753b11a16aSHongbin Zheng
12763b11a16aSHongbin Zheng for (int i = 0; i < VectorWidth; i++)
12773b11a16aSHongbin Zheng Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
12783b11a16aSHongbin Zheng Builder.getInt32(i));
12793b11a16aSHongbin Zheng
12803b11a16aSHongbin Zheng VectorMap[Inst] = Vector;
12813b11a16aSHongbin Zheng }
12823b11a16aSHongbin Zheng
getVectorWidth()1283bc132607STobias Grosser int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
12843b11a16aSHongbin Zheng
copyInstruction(ScopStmt & Stmt,Instruction * Inst,ValueMapT & VectorMap,VectorValueMapT & ScalarMaps,__isl_keep isl_id_to_ast_expr * NewAccesses)12852d1ed0bfSTobias Grosser void VectorBlockGenerator::copyInstruction(
12862f1acac6STobias Grosser ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
12872d1ed0bfSTobias Grosser VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
12883b11a16aSHongbin Zheng // Terminator instructions control the control flow. They are explicitly
12893b11a16aSHongbin Zheng // expressed in the clast and do not need to be copied.
12903b11a16aSHongbin Zheng if (Inst->isTerminator())
12913b11a16aSHongbin Zheng return;
12923b11a16aSHongbin Zheng
12935dced269SJohannes Doerfert if (canSyntheziseInStmt(Stmt, Inst))
1294e71c6ab5STobias Grosser return;
1295e71c6ab5STobias Grosser
12969646e3feSTobias Grosser if (auto *Load = dyn_cast<LoadInst>(Inst)) {
12972d1ed0bfSTobias Grosser generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
12983b11a16aSHongbin Zheng return;
12993b11a16aSHongbin Zheng }
13003b11a16aSHongbin Zheng
13013b11a16aSHongbin Zheng if (hasVectorOperands(Inst, VectorMap)) {
13029646e3feSTobias Grosser if (auto *Store = dyn_cast<StoreInst>(Inst)) {
13030446d81eSMichael Kruse // Identified as redundant by -polly-simplify.
13040446d81eSMichael Kruse if (!Stmt.getArrayAccessOrNULLFor(Store))
13050446d81eSMichael Kruse return;
13060446d81eSMichael Kruse
13072d1ed0bfSTobias Grosser copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
13083b11a16aSHongbin Zheng return;
13093b11a16aSHongbin Zheng }
13103b11a16aSHongbin Zheng
13119646e3feSTobias Grosser if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
1312be9c9117SJohannes Doerfert copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
13133b11a16aSHongbin Zheng return;
13143b11a16aSHongbin Zheng }
13153b11a16aSHongbin Zheng
13169646e3feSTobias Grosser if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
1317be9c9117SJohannes Doerfert copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
13183b11a16aSHongbin Zheng return;
13193b11a16aSHongbin Zheng }
13203b11a16aSHongbin Zheng
1321a6d48f59SMichael Kruse // Fallthrough: We generate scalar instructions, if we don't know how to
13223b11a16aSHongbin Zheng // generate vector code.
13233b11a16aSHongbin Zheng }
13243b11a16aSHongbin Zheng
13252d1ed0bfSTobias Grosser copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
13263b11a16aSHongbin Zheng }
13273b11a16aSHongbin Zheng
generateScalarVectorLoads(ScopStmt & Stmt,ValueMapT & VectorBlockMap)1328a69d4f0dSTobias Grosser void VectorBlockGenerator::generateScalarVectorLoads(
1329a69d4f0dSTobias Grosser ScopStmt &Stmt, ValueMapT &VectorBlockMap) {
1330a69d4f0dSTobias Grosser for (MemoryAccess *MA : Stmt) {
1331a69d4f0dSTobias Grosser if (MA->isArrayKind() || MA->isWrite())
1332a69d4f0dSTobias Grosser continue;
1333a69d4f0dSTobias Grosser
1334a69d4f0dSTobias Grosser auto *Address = getOrCreateAlloca(*MA);
1335ff9b37e9SNikita Popov Type *VectorType = FixedVectorType::get(MA->getElementType(), 1);
1336ff9b37e9SNikita Popov Type *VectorPtrType = PointerType::get(
1337ff9b37e9SNikita Popov VectorType, Address->getType()->getPointerAddressSpace());
1338a69d4f0dSTobias Grosser Value *VectorPtr = Builder.CreateBitCast(Address, VectorPtrType,
1339a69d4f0dSTobias Grosser Address->getName() + "_p_vec_p");
1340ff9b37e9SNikita Popov auto *Val = Builder.CreateLoad(VectorType, VectorPtr,
1341ff9b37e9SNikita Popov Address->getName() + ".reload");
1342a69d4f0dSTobias Grosser Constant *SplatVector = Constant::getNullValue(
1343b82a95f8SChristopher Tetreault FixedVectorType::get(Builder.getInt32Ty(), getVectorWidth()));
1344a69d4f0dSTobias Grosser
1345a69d4f0dSTobias Grosser Value *VectorVal = Builder.CreateShuffleVector(
1346a69d4f0dSTobias Grosser Val, Val, SplatVector, Address->getName() + "_p_splat");
1347583be06fSTobias Grosser VectorBlockMap[MA->getAccessValue()] = VectorVal;
1348a69d4f0dSTobias Grosser }
1349a69d4f0dSTobias Grosser }
1350a69d4f0dSTobias Grosser
verifyNoScalarStores(ScopStmt & Stmt)1351a69d4f0dSTobias Grosser void VectorBlockGenerator::verifyNoScalarStores(ScopStmt &Stmt) {
1352a69d4f0dSTobias Grosser for (MemoryAccess *MA : Stmt) {
1353a69d4f0dSTobias Grosser if (MA->isArrayKind() || MA->isRead())
1354a69d4f0dSTobias Grosser continue;
1355a69d4f0dSTobias Grosser
1356a69d4f0dSTobias Grosser llvm_unreachable("Scalar stores not expected in vector loop");
1357a69d4f0dSTobias Grosser }
1358a69d4f0dSTobias Grosser }
1359a69d4f0dSTobias Grosser
copyStmt(ScopStmt & Stmt,__isl_keep isl_id_to_ast_expr * NewAccesses)13602d1ed0bfSTobias Grosser void VectorBlockGenerator::copyStmt(
13612d1ed0bfSTobias Grosser ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
136221a059afSTobias Grosser assert(Stmt.isBlockStmt() &&
136321a059afSTobias Grosser "TODO: Only block statements can be copied by the vector block "
136421a059afSTobias Grosser "generator");
1365275a1756SJohannes Doerfert
1366be9c9117SJohannes Doerfert BasicBlock *BB = Stmt.getBasicBlock();
1367b8f58b53SDuncan P. N. Exon Smith BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
1368b8f58b53SDuncan P. N. Exon Smith &*Builder.GetInsertPoint(), &DT, &LI);
13693b11a16aSHongbin Zheng CopyBB->setName("polly.stmt." + BB->getName());
1370b8f58b53SDuncan P. N. Exon Smith Builder.SetInsertPoint(&CopyBB->front());
13713b11a16aSHongbin Zheng
13723b11a16aSHongbin Zheng // Create two maps that store the mapping from the original instructions of
13733b11a16aSHongbin Zheng // the old basic block to their copies in the new basic block. Those maps
13743b11a16aSHongbin Zheng // are basic block local.
13753b11a16aSHongbin Zheng //
13763b11a16aSHongbin Zheng // As vector code generation is supported there is one map for scalar values
13773b11a16aSHongbin Zheng // and one for vector values.
13783b11a16aSHongbin Zheng //
13793b11a16aSHongbin Zheng // In case we just do scalar code generation, the vectorMap is not used and
13803b11a16aSHongbin Zheng // the scalarMap has just one dimension, which contains the mapping.
13813b11a16aSHongbin Zheng //
13823b11a16aSHongbin Zheng // In case vector code generation is done, an instruction may either appear
13833b11a16aSHongbin Zheng // in the vector map once (as it is calculating >vectorwidth< values at a
13843b11a16aSHongbin Zheng // time. Or (if the values are calculated using scalar operations), it
13853b11a16aSHongbin Zheng // appears once in every dimension of the scalarMap.
13863b11a16aSHongbin Zheng VectorValueMapT ScalarBlockMap(getVectorWidth());
13873b11a16aSHongbin Zheng ValueMapT VectorBlockMap;
13883b11a16aSHongbin Zheng
1389a69d4f0dSTobias Grosser generateScalarVectorLoads(Stmt, VectorBlockMap);
1390a69d4f0dSTobias Grosser
13910aff3174SMichael Kruse for (Instruction *Inst : Stmt.getInstructions())
13920aff3174SMichael Kruse copyInstruction(Stmt, Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
1393a69d4f0dSTobias Grosser
1394a69d4f0dSTobias Grosser verifyNoScalarStores(Stmt);
13953b11a16aSHongbin Zheng }
1396275a1756SJohannes Doerfert
repairDominance(BasicBlock * BB,BasicBlock * BBCopy)1397ecff11dcSJohannes Doerfert BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1398ecff11dcSJohannes Doerfert BasicBlock *BBCopy) {
1399514f6efaSJohannes Doerfert
1400514f6efaSJohannes Doerfert BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1401deefbcedSTobias Grosser BasicBlock *BBCopyIDom = EndBlockMap.lookup(BBIDom);
1402514f6efaSJohannes Doerfert
1403514f6efaSJohannes Doerfert if (BBCopyIDom)
1404514f6efaSJohannes Doerfert DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1405514f6efaSJohannes Doerfert
1406deefbcedSTobias Grosser return StartBlockMap.lookup(BBIDom);
1407514f6efaSJohannes Doerfert }
1408514f6efaSJohannes Doerfert
1409f33c125dSMichael Kruse // This is to determine whether an llvm::Value (defined in @p BB) is usable when
1410f33c125dSMichael Kruse // leaving a subregion. The straight-forward DT.dominates(BB, R->getExitBlock())
1411f33c125dSMichael Kruse // does not work in cases where the exit block has edges from outside the
1412f33c125dSMichael Kruse // region. In that case the llvm::Value would never be usable in in the exit
1413f33c125dSMichael Kruse // block. The RegionGenerator however creates an new exit block ('ExitBBCopy')
1414f33c125dSMichael Kruse // for the subregion's exiting edges only. We need to determine whether an
1415f33c125dSMichael Kruse // llvm::Value is usable in there. We do this by checking whether it dominates
1416f33c125dSMichael Kruse // all exiting blocks individually.
isDominatingSubregionExit(const DominatorTree & DT,Region * R,BasicBlock * BB)1417f33c125dSMichael Kruse static bool isDominatingSubregionExit(const DominatorTree &DT, Region *R,
1418f33c125dSMichael Kruse BasicBlock *BB) {
1419f33c125dSMichael Kruse for (auto ExitingBB : predecessors(R->getExit())) {
1420f33c125dSMichael Kruse // Check for non-subregion incoming edges.
1421f33c125dSMichael Kruse if (!R->contains(ExitingBB))
1422f33c125dSMichael Kruse continue;
1423f33c125dSMichael Kruse
1424f33c125dSMichael Kruse if (!DT.dominates(BB, ExitingBB))
1425f33c125dSMichael Kruse return false;
1426f33c125dSMichael Kruse }
1427f33c125dSMichael Kruse
1428f33c125dSMichael Kruse return true;
1429f33c125dSMichael Kruse }
1430f33c125dSMichael Kruse
1431f33c125dSMichael Kruse // Find the direct dominator of the subregion's exit block if the subregion was
1432f33c125dSMichael Kruse // simplified.
findExitDominator(DominatorTree & DT,Region * R)1433f33c125dSMichael Kruse static BasicBlock *findExitDominator(DominatorTree &DT, Region *R) {
1434f33c125dSMichael Kruse BasicBlock *Common = nullptr;
1435f33c125dSMichael Kruse for (auto ExitingBB : predecessors(R->getExit())) {
1436f33c125dSMichael Kruse // Check for non-subregion incoming edges.
1437f33c125dSMichael Kruse if (!R->contains(ExitingBB))
1438f33c125dSMichael Kruse continue;
1439f33c125dSMichael Kruse
1440f33c125dSMichael Kruse // First exiting edge.
1441f33c125dSMichael Kruse if (!Common) {
1442f33c125dSMichael Kruse Common = ExitingBB;
1443f33c125dSMichael Kruse continue;
1444f33c125dSMichael Kruse }
1445f33c125dSMichael Kruse
1446f33c125dSMichael Kruse Common = DT.findNearestCommonDominator(Common, ExitingBB);
1447f33c125dSMichael Kruse }
1448f33c125dSMichael Kruse
1449f33c125dSMichael Kruse assert(Common && R->contains(Common));
1450f33c125dSMichael Kruse return Common;
1451f33c125dSMichael Kruse }
1452f33c125dSMichael Kruse
copyStmt(ScopStmt & Stmt,LoopToScevMapT & LTS,__isl_keep isl_id_to_ast_expr * IdToAstExp)1453bc132607STobias Grosser void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT <S,
1454ad84c6f6SMichael Kruse __isl_keep isl_id_to_ast_expr *IdToAstExp) {
1455275a1756SJohannes Doerfert assert(Stmt.isRegionStmt() &&
1456d3f21833STobias Grosser "Only region statements can be copied by the region generator");
1457275a1756SJohannes Doerfert
1458ecff11dcSJohannes Doerfert // Forget all old mappings.
1459deefbcedSTobias Grosser StartBlockMap.clear();
1460deefbcedSTobias Grosser EndBlockMap.clear();
1461ecff11dcSJohannes Doerfert RegionMaps.clear();
1462ecff11dcSJohannes Doerfert IncompletePHINodeMap.clear();
1463ecff11dcSJohannes Doerfert
1464225f0d1eSMichael Kruse // Collection of all values related to this subregion.
1465225f0d1eSMichael Kruse ValueMapT ValueMap;
1466225f0d1eSMichael Kruse
1467275a1756SJohannes Doerfert // The region represented by the statement.
1468275a1756SJohannes Doerfert Region *R = Stmt.getRegion();
1469275a1756SJohannes Doerfert
1470ecff11dcSJohannes Doerfert // Create a dedicated entry for the region where we can reload all demoted
1471ecff11dcSJohannes Doerfert // inputs.
1472ecff11dcSJohannes Doerfert BasicBlock *EntryBB = R->getEntry();
1473b8f58b53SDuncan P. N. Exon Smith BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1474b8f58b53SDuncan P. N. Exon Smith &*Builder.GetInsertPoint(), &DT, &LI);
1475ecff11dcSJohannes Doerfert EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
1476b8f58b53SDuncan P. N. Exon Smith Builder.SetInsertPoint(&EntryBBCopy->front());
1477514f6efaSJohannes Doerfert
1478c993739eSMichael Kruse ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
14792fa35194SMichael Kruse generateScalarLoads(Stmt, LTS, EntryBBMap, IdToAstExp);
1480e819fffeSMichael Kruse generateBeginStmtTrace(Stmt, LTS, EntryBBMap);
1481225f0d1eSMichael Kruse
1482ecff11dcSJohannes Doerfert for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1483deefbcedSTobias Grosser if (!R->contains(*PI)) {
1484deefbcedSTobias Grosser StartBlockMap[*PI] = EntryBBCopy;
1485deefbcedSTobias Grosser EndBlockMap[*PI] = EntryBBCopy;
1486deefbcedSTobias Grosser }
1487275a1756SJohannes Doerfert
1488275a1756SJohannes Doerfert // Iterate over all blocks in the region in a breadth-first search.
1489275a1756SJohannes Doerfert std::deque<BasicBlock *> Blocks;
14905b1abfc8SMandeep Singh Grang SmallSetVector<BasicBlock *, 8> SeenBlocks;
1491ecff11dcSJohannes Doerfert Blocks.push_back(EntryBB);
1492ecff11dcSJohannes Doerfert SeenBlocks.insert(EntryBB);
1493275a1756SJohannes Doerfert
1494275a1756SJohannes Doerfert while (!Blocks.empty()) {
1495275a1756SJohannes Doerfert BasicBlock *BB = Blocks.front();
1496275a1756SJohannes Doerfert Blocks.pop_front();
1497275a1756SJohannes Doerfert
1498514f6efaSJohannes Doerfert // First split the block and update dominance information.
1499514f6efaSJohannes Doerfert BasicBlock *BBCopy = splitBB(BB);
1500ecff11dcSJohannes Doerfert BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1501ecff11dcSJohannes Doerfert
1502c993739eSMichael Kruse // Get the mapping for this block and initialize it with either the scalar
1503c993739eSMichael Kruse // loads from the generated entering block (which dominates all blocks of
1504c993739eSMichael Kruse // this subregion) or the maps of the immediate dominator, if part of the
1505c993739eSMichael Kruse // subregion. The latter necessarily includes the former.
1506c993739eSMichael Kruse ValueMapT *InitBBMap;
1507c993739eSMichael Kruse if (BBCopyIDom) {
1508c993739eSMichael Kruse assert(RegionMaps.count(BBCopyIDom));
1509c993739eSMichael Kruse InitBBMap = &RegionMaps[BBCopyIDom];
1510c993739eSMichael Kruse } else
1511c993739eSMichael Kruse InitBBMap = &EntryBBMap;
1512c993739eSMichael Kruse auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1513c993739eSMichael Kruse ValueMapT &RegionMap = Inserted.first->second;
1514514f6efaSJohannes Doerfert
1515275a1756SJohannes Doerfert // Copy the block with the BlockGenerator.
1516b8f58b53SDuncan P. N. Exon Smith Builder.SetInsertPoint(&BBCopy->front());
1517bc132607STobias Grosser copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
1518275a1756SJohannes Doerfert
1519ecff11dcSJohannes Doerfert // In order to remap PHI nodes we store also basic block mappings.
1520deefbcedSTobias Grosser StartBlockMap[BB] = BBCopy;
1521deefbcedSTobias Grosser EndBlockMap[BB] = Builder.GetInsertBlock();
1522ecff11dcSJohannes Doerfert
1523ecff11dcSJohannes Doerfert // Add values to incomplete PHI nodes waiting for this block to be copied.
1524ecff11dcSJohannes Doerfert for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
1525bc132607STobias Grosser addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
1526ecff11dcSJohannes Doerfert IncompletePHINodeMap[BB].clear();
1527ecff11dcSJohannes Doerfert
1528275a1756SJohannes Doerfert // And continue with new successors inside the region.
1529275a1756SJohannes Doerfert for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
15305b1abfc8SMandeep Singh Grang if (R->contains(*SI) && SeenBlocks.insert(*SI))
1531275a1756SJohannes Doerfert Blocks.push_back(*SI);
1532ebffcbeeSMichael Kruse
1533ebffcbeeSMichael Kruse // Remember value in case it is visible after this subregion.
1534f33c125dSMichael Kruse if (isDominatingSubregionExit(DT, R, BB))
1535ebffcbeeSMichael Kruse ValueMap.insert(RegionMap.begin(), RegionMap.end());
1536275a1756SJohannes Doerfert }
1537275a1756SJohannes Doerfert
1538275a1756SJohannes Doerfert // Now create a new dedicated region exit block and add it to the region map.
1539b8f58b53SDuncan P. N. Exon Smith BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1540b8f58b53SDuncan P. N. Exon Smith &*Builder.GetInsertPoint(), &DT, &LI);
1541ecff11dcSJohannes Doerfert ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
1542deefbcedSTobias Grosser StartBlockMap[R->getExit()] = ExitBBCopy;
1543deefbcedSTobias Grosser EndBlockMap[R->getExit()] = ExitBBCopy;
1544514f6efaSJohannes Doerfert
1545deefbcedSTobias Grosser BasicBlock *ExitDomBBCopy = EndBlockMap.lookup(findExitDominator(DT, R));
154621a059afSTobias Grosser assert(ExitDomBBCopy &&
154721a059afSTobias Grosser "Common exit dominator must be within region; at least the entry node "
154821a059afSTobias Grosser "must match");
1549f33c125dSMichael Kruse DT.changeImmediateDominator(ExitBBCopy, ExitDomBBCopy);
1550275a1756SJohannes Doerfert
1551275a1756SJohannes Doerfert // As the block generator doesn't handle control flow we need to add the
1552275a1756SJohannes Doerfert // region control flow by hand after all blocks have been copied.
1553275a1756SJohannes Doerfert for (BasicBlock *BB : SeenBlocks) {
1554275a1756SJohannes Doerfert
1555deefbcedSTobias Grosser BasicBlock *BBCopyStart = StartBlockMap[BB];
1556deefbcedSTobias Grosser BasicBlock *BBCopyEnd = EndBlockMap[BB];
1557e303c87eSChandler Carruth Instruction *TI = BB->getTerminator();
1558e114dc02SJohannes Doerfert if (isa<UnreachableInst>(TI)) {
1559deefbcedSTobias Grosser while (!BBCopyEnd->empty())
1560deefbcedSTobias Grosser BBCopyEnd->begin()->eraseFromParent();
1561deefbcedSTobias Grosser new UnreachableInst(BBCopyEnd->getContext(), BBCopyEnd);
1562e114dc02SJohannes Doerfert continue;
1563e114dc02SJohannes Doerfert }
1564e114dc02SJohannes Doerfert
1565deefbcedSTobias Grosser Instruction *BICopy = BBCopyEnd->getTerminator();
1566275a1756SJohannes Doerfert
1567deefbcedSTobias Grosser ValueMapT &RegionMap = RegionMaps[BBCopyStart];
1568deefbcedSTobias Grosser RegionMap.insert(StartBlockMap.begin(), StartBlockMap.end());
1569514f6efaSJohannes Doerfert
157045e7944bSTobias Grosser Builder.SetInsertPoint(BICopy);
15719a132f36SJohannes Doerfert copyInstScalar(Stmt, TI, RegionMap, LTS);
1572275a1756SJohannes Doerfert BICopy->eraseFromParent();
1573275a1756SJohannes Doerfert }
1574275a1756SJohannes Doerfert
1575ecff11dcSJohannes Doerfert // Add counting PHI nodes to all loops in the region that can be used as
1576a6d48f59SMichael Kruse // replacement for SCEVs referring to the old loop.
1577ecff11dcSJohannes Doerfert for (BasicBlock *BB : SeenBlocks) {
1578ecff11dcSJohannes Doerfert Loop *L = LI.getLoopFor(BB);
1579bc29e0b2STobias Grosser if (L == nullptr || L->getHeader() != BB || !R->contains(L))
1580ecff11dcSJohannes Doerfert continue;
1581ecff11dcSJohannes Doerfert
1582deefbcedSTobias Grosser BasicBlock *BBCopy = StartBlockMap[BB];
1583ecff11dcSJohannes Doerfert Value *NullVal = Builder.getInt32(0);
1584ecff11dcSJohannes Doerfert PHINode *LoopPHI =
1585ecff11dcSJohannes Doerfert PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1586ecff11dcSJohannes Doerfert Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1587ecff11dcSJohannes Doerfert LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
1588b8f58b53SDuncan P. N. Exon Smith LoopPHI->insertBefore(&BBCopy->front());
1589ecff11dcSJohannes Doerfert LoopPHIInc->insertBefore(BBCopy->getTerminator());
1590ecff11dcSJohannes Doerfert
1591*bed7d707Sjacquesguan for (auto *PredBB : predecessors(BB)) {
1592ecff11dcSJohannes Doerfert if (!R->contains(PredBB))
1593ecff11dcSJohannes Doerfert continue;
1594ecff11dcSJohannes Doerfert if (L->contains(PredBB))
1595deefbcedSTobias Grosser LoopPHI->addIncoming(LoopPHIInc, EndBlockMap[PredBB]);
1596ecff11dcSJohannes Doerfert else
1597deefbcedSTobias Grosser LoopPHI->addIncoming(NullVal, EndBlockMap[PredBB]);
1598ecff11dcSJohannes Doerfert }
1599ecff11dcSJohannes Doerfert
1600*bed7d707Sjacquesguan for (auto *PredBBCopy : predecessors(BBCopy))
1601ecff11dcSJohannes Doerfert if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1602ecff11dcSJohannes Doerfert LoopPHI->addIncoming(NullVal, PredBBCopy);
1603ecff11dcSJohannes Doerfert
1604ecff11dcSJohannes Doerfert LTS[L] = SE.getUnknown(LoopPHI);
1605ecff11dcSJohannes Doerfert }
1606ecff11dcSJohannes Doerfert
1607225f0d1eSMichael Kruse // Continue generating code in the exit block.
1608b8f58b53SDuncan P. N. Exon Smith Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
1609225f0d1eSMichael Kruse
1610225f0d1eSMichael Kruse // Write values visible to other statements.
16112fa35194SMichael Kruse generateScalarStores(Stmt, LTS, ValueMap, IdToAstExp);
1612deefbcedSTobias Grosser StartBlockMap.clear();
1613deefbcedSTobias Grosser EndBlockMap.clear();
16143e956020STobias Grosser RegionMaps.clear();
16153e956020STobias Grosser IncompletePHINodeMap.clear();
1616275a1756SJohannes Doerfert }
1617ecff11dcSJohannes Doerfert
buildExitPHI(MemoryAccess * MA,LoopToScevMapT & LTS,ValueMapT & BBMap,Loop * L)1618ee6a4fc6SMichael Kruse PHINode *RegionGenerator::buildExitPHI(MemoryAccess *MA, LoopToScevMapT <S,
1619ee6a4fc6SMichael Kruse ValueMapT &BBMap, Loop *L) {
1620ee6a4fc6SMichael Kruse ScopStmt *Stmt = MA->getStatement();
1621ee6a4fc6SMichael Kruse Region *SubR = Stmt->getRegion();
1622ee6a4fc6SMichael Kruse auto Incoming = MA->getIncoming();
1623ee6a4fc6SMichael Kruse
1624ee6a4fc6SMichael Kruse PollyIRBuilder::InsertPointGuard IPGuard(Builder);
1625ee6a4fc6SMichael Kruse PHINode *OrigPHI = cast<PHINode>(MA->getAccessInstruction());
1626ee6a4fc6SMichael Kruse BasicBlock *NewSubregionExit = Builder.GetInsertBlock();
1627ee6a4fc6SMichael Kruse
1628ee6a4fc6SMichael Kruse // This can happen if the subregion is simplified after the ScopStmts
1629ee6a4fc6SMichael Kruse // have been created; simplification happens as part of CodeGeneration.
1630ee6a4fc6SMichael Kruse if (OrigPHI->getParent() != SubR->getExit()) {
1631ee6a4fc6SMichael Kruse BasicBlock *FormerExit = SubR->getExitingBlock();
1632ee6a4fc6SMichael Kruse if (FormerExit)
1633deefbcedSTobias Grosser NewSubregionExit = StartBlockMap.lookup(FormerExit);
1634ee6a4fc6SMichael Kruse }
1635ee6a4fc6SMichael Kruse
1636ee6a4fc6SMichael Kruse PHINode *NewPHI = PHINode::Create(OrigPHI->getType(), Incoming.size(),
1637ee6a4fc6SMichael Kruse "polly." + OrigPHI->getName(),
1638ee6a4fc6SMichael Kruse NewSubregionExit->getFirstNonPHI());
1639ee6a4fc6SMichael Kruse
1640ee6a4fc6SMichael Kruse // Add the incoming values to the PHI.
1641ee6a4fc6SMichael Kruse for (auto &Pair : Incoming) {
1642ee6a4fc6SMichael Kruse BasicBlock *OrigIncomingBlock = Pair.first;
1643deefbcedSTobias Grosser BasicBlock *NewIncomingBlockStart = StartBlockMap.lookup(OrigIncomingBlock);
1644deefbcedSTobias Grosser BasicBlock *NewIncomingBlockEnd = EndBlockMap.lookup(OrigIncomingBlock);
1645deefbcedSTobias Grosser Builder.SetInsertPoint(NewIncomingBlockEnd->getTerminator());
1646deefbcedSTobias Grosser assert(RegionMaps.count(NewIncomingBlockStart));
1647deefbcedSTobias Grosser assert(RegionMaps.count(NewIncomingBlockEnd));
1648deefbcedSTobias Grosser ValueMapT *LocalBBMap = &RegionMaps[NewIncomingBlockStart];
1649ee6a4fc6SMichael Kruse
1650ee6a4fc6SMichael Kruse Value *OrigIncomingValue = Pair.second;
1651ee6a4fc6SMichael Kruse Value *NewIncomingValue =
1652ee6a4fc6SMichael Kruse getNewValue(*Stmt, OrigIncomingValue, *LocalBBMap, LTS, L);
1653deefbcedSTobias Grosser NewPHI->addIncoming(NewIncomingValue, NewIncomingBlockEnd);
1654ee6a4fc6SMichael Kruse }
1655ee6a4fc6SMichael Kruse
1656ee6a4fc6SMichael Kruse return NewPHI;
1657ee6a4fc6SMichael Kruse }
1658ee6a4fc6SMichael Kruse
getExitScalar(MemoryAccess * MA,LoopToScevMapT & LTS,ValueMapT & BBMap)1659ee6a4fc6SMichael Kruse Value *RegionGenerator::getExitScalar(MemoryAccess *MA, LoopToScevMapT <S,
1660ee6a4fc6SMichael Kruse ValueMapT &BBMap) {
1661ee6a4fc6SMichael Kruse ScopStmt *Stmt = MA->getStatement();
1662ee6a4fc6SMichael Kruse
1663ee6a4fc6SMichael Kruse // TODO: Add some test cases that ensure this is really the right choice.
1664ee6a4fc6SMichael Kruse Loop *L = LI.getLoopFor(Stmt->getRegion()->getExit());
1665ee6a4fc6SMichael Kruse
1666ee6a4fc6SMichael Kruse if (MA->isAnyPHIKind()) {
1667ee6a4fc6SMichael Kruse auto Incoming = MA->getIncoming();
1668ee6a4fc6SMichael Kruse assert(!Incoming.empty() &&
1669ee6a4fc6SMichael Kruse "PHI WRITEs must have originate from at least one incoming block");
1670ee6a4fc6SMichael Kruse
1671ee6a4fc6SMichael Kruse // If there is only one incoming value, we do not need to create a PHI.
1672ee6a4fc6SMichael Kruse if (Incoming.size() == 1) {
1673ee6a4fc6SMichael Kruse Value *OldVal = Incoming[0].second;
1674ee6a4fc6SMichael Kruse return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1675ee6a4fc6SMichael Kruse }
1676ee6a4fc6SMichael Kruse
1677ee6a4fc6SMichael Kruse return buildExitPHI(MA, LTS, BBMap, L);
1678ee6a4fc6SMichael Kruse }
1679ee6a4fc6SMichael Kruse
16804d5a9172STobias Grosser // MemoryKind::Value accesses leaving the subregion must dominate the exit
16814d5a9172STobias Grosser // block; just pass the copied value.
1682ee6a4fc6SMichael Kruse Value *OldVal = MA->getAccessValue();
1683ee6a4fc6SMichael Kruse return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1684ee6a4fc6SMichael Kruse }
1685ee6a4fc6SMichael Kruse
generateScalarStores(ScopStmt & Stmt,LoopToScevMapT & LTS,ValueMapT & BBMap,__isl_keep isl_id_to_ast_expr * NewAccesses)16862fa35194SMichael Kruse void RegionGenerator::generateScalarStores(
16872fa35194SMichael Kruse ScopStmt &Stmt, LoopToScevMapT <S, ValueMapT &BBMap,
16882fa35194SMichael Kruse __isl_keep isl_id_to_ast_expr *NewAccesses) {
168975296901STobias Grosser assert(Stmt.getRegion() &&
169075296901STobias Grosser "Block statements need to use the generateScalarStores() "
1691ecff11dcSJohannes Doerfert "function in the BlockGenerator");
1692ecff11dcSJohannes Doerfert
1693c4c679c2SMichael Kruse // Get the exit scalar values before generating the writes.
1694c4c679c2SMichael Kruse // This is necessary because RegionGenerator::getExitScalar may insert
1695c4c679c2SMichael Kruse // PHINodes that depend on the region's exiting blocks. But
1696c4c679c2SMichael Kruse // BlockGenerator::generateConditionalExecution may insert a new basic block
1697c4c679c2SMichael Kruse // such that the current basic block is not a direct successor of the exiting
1698c4c679c2SMichael Kruse // blocks anymore. Hence, build the PHINodes while the current block is still
1699c4c679c2SMichael Kruse // the direct successor.
1700c4c679c2SMichael Kruse SmallDenseMap<MemoryAccess *, Value *> NewExitScalars;
1701c4c679c2SMichael Kruse for (MemoryAccess *MA : Stmt) {
1702c4c679c2SMichael Kruse if (MA->isOriginalArrayKind() || MA->isRead())
1703c4c679c2SMichael Kruse continue;
1704c4c679c2SMichael Kruse
1705c4c679c2SMichael Kruse Value *NewVal = getExitScalar(MA, LTS, BBMap);
1706c4c679c2SMichael Kruse NewExitScalars[MA] = NewVal;
1707c4c679c2SMichael Kruse }
1708c4c679c2SMichael Kruse
1709ecff11dcSJohannes Doerfert for (MemoryAccess *MA : Stmt) {
17102fa35194SMichael Kruse if (MA->isOriginalArrayKind() || MA->isRead())
1711ecff11dcSJohannes Doerfert continue;
1712ecff11dcSJohannes Doerfert
17131515f6b9STobias Grosser isl::set AccDom = MA->getAccessRelation().domain();
1714fe46c3ffSTobias Grosser std::string Subject = MA->getId().get_name();
1715fe46c3ffSTobias Grosser generateConditionalExecution(
1716fe46c3ffSTobias Grosser Stmt, AccDom, Subject.c_str(), [&, this, MA]() {
1717c4c679c2SMichael Kruse Value *NewVal = NewExitScalars.lookup(MA);
1718c4c679c2SMichael Kruse assert(NewVal && "The exit scalar must be determined before");
1719fe46c3ffSTobias Grosser Value *Address = getImplicitAddress(*MA, getLoopForStmt(Stmt), LTS,
1720fe46c3ffSTobias Grosser BBMap, NewAccesses);
1721eac9726eSMichael Kruse assert((!isa<Instruction>(NewVal) ||
1722eac9726eSMichael Kruse DT.dominates(cast<Instruction>(NewVal)->getParent(),
1723eac9726eSMichael Kruse Builder.GetInsertBlock())) &&
1724eac9726eSMichael Kruse "Domination violation");
1725eac9726eSMichael Kruse assert((!isa<Instruction>(Address) ||
1726eac9726eSMichael Kruse DT.dominates(cast<Instruction>(Address)->getParent(),
1727eac9726eSMichael Kruse Builder.GetInsertBlock())) &&
1728eac9726eSMichael Kruse "Domination violation");
1729ee6a4fc6SMichael Kruse Builder.CreateStore(NewVal, Address);
1730706f79abSMichael Kruse });
1731ecff11dcSJohannes Doerfert }
1732ecff11dcSJohannes Doerfert }
1733ecff11dcSJohannes Doerfert
addOperandToPHI(ScopStmt & Stmt,PHINode * PHI,PHINode * PHICopy,BasicBlock * IncomingBB,LoopToScevMapT & LTS)1734943c369cSTobias Grosser void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, PHINode *PHI,
1735ecff11dcSJohannes Doerfert PHINode *PHICopy, BasicBlock *IncomingBB,
1736ecff11dcSJohannes Doerfert LoopToScevMapT <S) {
1737ecff11dcSJohannes Doerfert // If the incoming block was not yet copied mark this PHI as incomplete.
1738ecff11dcSJohannes Doerfert // Once the block will be copied the incoming value will be added.
1739deefbcedSTobias Grosser BasicBlock *BBCopyStart = StartBlockMap[IncomingBB];
1740deefbcedSTobias Grosser BasicBlock *BBCopyEnd = EndBlockMap[IncomingBB];
1741deefbcedSTobias Grosser if (!BBCopyStart) {
1742deefbcedSTobias Grosser assert(!BBCopyEnd);
17438d89179eSMichael Kruse assert(Stmt.represents(IncomingBB) &&
1744ecff11dcSJohannes Doerfert "Bad incoming block for PHI in non-affine region");
1745ecff11dcSJohannes Doerfert IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1746ecff11dcSJohannes Doerfert return;
1747ecff11dcSJohannes Doerfert }
1748ecff11dcSJohannes Doerfert
1749deefbcedSTobias Grosser assert(RegionMaps.count(BBCopyStart) &&
1750deefbcedSTobias Grosser "Incoming PHI block did not have a BBMap");
1751deefbcedSTobias Grosser ValueMapT &BBCopyMap = RegionMaps[BBCopyStart];
1752ecff11dcSJohannes Doerfert
175375dfaa1dSTobias Grosser Value *OpCopy = nullptr;
175475dfaa1dSTobias Grosser
17558d89179eSMichael Kruse if (Stmt.represents(IncomingBB)) {
1756ecff11dcSJohannes Doerfert Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
1757dc122222SMichael Kruse
17586ba92714SJohannes Doerfert // If the current insert block is different from the PHIs incoming block
17596ba92714SJohannes Doerfert // change it, otherwise do not.
17606ba92714SJohannes Doerfert auto IP = Builder.GetInsertPoint();
1761deefbcedSTobias Grosser if (IP->getParent() != BBCopyEnd)
1762deefbcedSTobias Grosser Builder.SetInsertPoint(BBCopyEnd->getTerminator());
17632c3ffc04SJohannes Doerfert OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForStmt(Stmt));
1764deefbcedSTobias Grosser if (IP->getParent() != BBCopyEnd)
17656ba92714SJohannes Doerfert Builder.SetInsertPoint(&*IP);
1766ecff11dcSJohannes Doerfert } else {
176775dfaa1dSTobias Grosser // All edges from outside the non-affine region become a single edge
176875dfaa1dSTobias Grosser // in the new copy of the non-affine region. Make sure to only add the
176975dfaa1dSTobias Grosser // corresponding edge the first time we encounter a basic block from
177075dfaa1dSTobias Grosser // outside the non-affine region.
1771deefbcedSTobias Grosser if (PHICopy->getBasicBlockIndex(BBCopyEnd) >= 0)
1772ecff11dcSJohannes Doerfert return;
1773ecff11dcSJohannes Doerfert
177475dfaa1dSTobias Grosser // Get the reloaded value.
177575dfaa1dSTobias Grosser OpCopy = getNewValue(Stmt, PHI, BBCopyMap, LTS, getLoopForStmt(Stmt));
1776ecff11dcSJohannes Doerfert }
1777ecff11dcSJohannes Doerfert
1778ecff11dcSJohannes Doerfert assert(OpCopy && "Incoming PHI value was not copied properly");
1779deefbcedSTobias Grosser PHICopy->addIncoming(OpCopy, BBCopyEnd);
1780ecff11dcSJohannes Doerfert }
1781ecff11dcSJohannes Doerfert
copyPHIInstruction(ScopStmt & Stmt,PHINode * PHI,ValueMapT & BBMap,LoopToScevMapT & LTS)17822b809d13STobias Grosser void RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1783ecff11dcSJohannes Doerfert ValueMapT &BBMap,
1784ecff11dcSJohannes Doerfert LoopToScevMapT <S) {
1785ecff11dcSJohannes Doerfert unsigned NumIncoming = PHI->getNumIncomingValues();
1786ecff11dcSJohannes Doerfert PHINode *PHICopy =
1787ecff11dcSJohannes Doerfert Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1788ecff11dcSJohannes Doerfert PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1789ecff11dcSJohannes Doerfert BBMap[PHI] = PHICopy;
1790ecff11dcSJohannes Doerfert
179197b84909STobias Grosser for (BasicBlock *IncomingBB : PHI->blocks())
179297b84909STobias Grosser addOperandToPHI(Stmt, PHI, PHICopy, IncomingBB, LTS);
1793ecff11dcSJohannes Doerfert }
1794