blob: 569279b85ead73475fe8b0e95173ab2cbb799650 [file] [log] [blame]
Hongbin Zheng3b11a162012-04-25 13:16:49 +00001//===--- BlockGenerators.cpp - Generate code for statements -----*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the BlockGenerator and VectorBlockGenerator classes,
11// which generate sequential code and vectorized code for a polyhedral
12// statement, respectively.
13//
14//===----------------------------------------------------------------------===//
15
Hongbin Zheng8a846612012-04-25 13:18:28 +000016#include "polly/CodeGen/BlockGenerators.h"
Tobias Grosser83628182013-05-07 08:11:54 +000017#include "polly/CodeGen/CodeGeneration.h"
Johannes Doerferta63b2572014-08-03 01:51:59 +000018#include "polly/CodeGen/IslExprBuilder.h"
Tobias Grosser86bc93a2015-09-06 08:47:57 +000019#include "polly/CodeGen/RuntimeDebugBuilder.h"
Tobias Grosser637bd632013-05-07 07:31:10 +000020#include "polly/Options.h"
Tobias Grosser5624d3c2015-12-21 12:38:56 +000021#include "polly/ScopInfo.h"
Hongbin Zheng3b11a162012-04-25 13:16:49 +000022#include "polly/Support/GICHelper.h"
Sebastian Pop97cb8132013-03-18 20:21:13 +000023#include "polly/Support/SCEVValidator.h"
Tobias Grosserecfe21b2013-03-20 18:03:18 +000024#include "polly/Support/ScopHelper.h"
Tobias Grossere71c6ab2012-04-27 16:36:14 +000025#include "llvm/Analysis/LoopInfo.h"
Johannes Doerfertf32d6512015-03-01 18:45:58 +000026#include "llvm/Analysis/RegionInfo.h"
Tobias Grossere71c6ab2012-04-27 16:36:14 +000027#include "llvm/Analysis/ScalarEvolution.h"
Tobias Grosser030237d2014-02-21 15:06:05 +000028#include "llvm/IR/IntrinsicInst.h"
Tobias Grosserc9895062015-03-10 15:24:33 +000029#include "llvm/IR/Module.h"
Hongbin Zheng3b11a162012-04-25 13:16:49 +000030#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Tobias Grosser1b9d25a2015-09-27 11:17:22 +000031#include "llvm/Transforms/Utils/Local.h"
Johannes Doerfertf32d6512015-03-01 18:45:58 +000032#include "isl/aff.h"
33#include "isl/ast.h"
Johannes Doerfertf32d6512015-03-01 18:45:58 +000034#include "isl/ast_build.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000035#include "isl/set.h"
Johannes Doerfertf32d6512015-03-01 18:45:58 +000036#include <deque>
37
Hongbin Zheng3b11a162012-04-25 13:16:49 +000038using namespace llvm;
39using namespace polly;
40
Tobias Grosser878aba42014-10-22 23:22:41 +000041static cl::opt<bool> Aligned("enable-polly-aligned",
42 cl::desc("Assumed aligned memory accesses."),
43 cl::Hidden, cl::init(false), cl::ZeroOrMore,
44 cl::cat(PollyCategory));
Hongbin Zheng3b11a162012-04-25 13:16:49 +000045
Tobias Grosser86bc93a2015-09-06 08:47:57 +000046static cl::opt<bool> DebugPrinting(
47 "polly-codegen-add-debug-printing",
48 cl::desc("Add printf calls that show the values loaded/stored."),
49 cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
50
Johannes Doerfertb4f08eb2015-02-23 13:51:35 +000051BlockGenerator::BlockGenerator(PollyIRBuilder &B, LoopInfo &LI,
52 ScalarEvolution &SE, DominatorTree &DT,
Johannes Doerfertecff11d2015-05-22 23:43:58 +000053 ScalarAllocaMapTy &ScalarMap,
54 ScalarAllocaMapTy &PHIOpMap,
55 EscapeUsersAllocaMapTy &EscapeMap,
Tobias Grosserf4bb7a62015-10-04 10:18:32 +000056 ValueMapT &GlobalMap,
Johannes Doerfertb4f08eb2015-02-23 13:51:35 +000057 IslExprBuilder *ExprBuilder)
Johannes Doerfertecff11d2015-05-22 23:43:58 +000058 : Builder(B), LI(LI), SE(SE), ExprBuilder(ExprBuilder), DT(DT),
59 EntryBB(nullptr), PHIOpMap(PHIOpMap), ScalarMap(ScalarMap),
Tobias Grosserbc132602015-09-05 09:56:54 +000060 EscapeMap(EscapeMap), GlobalMap(GlobalMap) {}
Tobias Grossere71c6ab2012-04-27 16:36:14 +000061
Tobias Grosser2f1acac2015-10-04 10:18:45 +000062Value *BlockGenerator::trySynthesizeNewValue(ScopStmt &Stmt, Value *Old,
Tobias Grosser33cb9f92015-09-30 11:56:19 +000063 ValueMapT &BBMap,
64 LoopToScevMapT &LTS,
65 Loop *L) const {
Johannes Doerfert42df8d12015-12-22 19:08:01 +000066 if (!SE.isSCEVable(Old->getType()))
67 return nullptr;
Johannes Doerferte69e1142015-08-18 11:56:00 +000068
Johannes Doerfert42df8d12015-12-22 19:08:01 +000069 const SCEV *Scev = SE.getSCEVAtScope(Old, L);
70 if (!Scev)
71 return nullptr;
Johannes Doerferte69e1142015-08-18 11:56:00 +000072
Johannes Doerfert42df8d12015-12-22 19:08:01 +000073 if (isa<SCEVCouldNotCompute>(Scev))
74 return nullptr;
Tobias Grossere71c6ab2012-04-27 16:36:14 +000075
Johannes Doerfert42df8d12015-12-22 19:08:01 +000076 const SCEV *NewScev = apply(Scev, LTS, SE);
77 ValueMapT VTV;
78 VTV.insert(BBMap.begin(), BBMap.end());
79 VTV.insert(GlobalMap.begin(), GlobalMap.end());
Tobias Grossere71c6ab2012-04-27 16:36:14 +000080
Johannes Doerfert42df8d12015-12-22 19:08:01 +000081 Scop &S = *Stmt.getParent();
Johannes Doerfert3f52e352016-05-23 12:38:05 +000082 const DataLayout &DL = S.getFunction().getParent()->getDataLayout();
Johannes Doerfert42df8d12015-12-22 19:08:01 +000083 auto IP = Builder.GetInsertPoint();
84
85 assert(IP != Builder.GetInsertBlock()->end() &&
86 "Only instructions can be insert points for SCEVExpander");
87 Value *Expanded =
88 expandCodeFor(S, SE, DL, "polly", NewScev, Old->getType(), &*IP, &VTV);
89
90 BBMap[Old] = Expanded;
91 return Expanded;
Tobias Grosser33cb9f92015-09-30 11:56:19 +000092}
93
Tobias Grosser2f1acac2015-10-04 10:18:45 +000094Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
95 LoopToScevMapT &LTS, Loop *L) const {
Tobias Grosser9bd0dad2015-12-14 16:19:59 +000096 // Constants that do not reference any named value can always remain
Michael Kruse5bbc0e12015-12-14 23:41:32 +000097 // unchanged. Handle them early to avoid expensive map lookups. We do not take
Tobias Grosser9bd0dad2015-12-14 16:19:59 +000098 // the fast-path for external constants which are referenced through globals
99 // as these may need to be rewritten when distributing code accross different
100 // LLVM modules.
101 if (isa<Constant>(Old) && !isa<GlobalValue>(Old))
Tobias Grosser6f764bb2015-12-14 16:19:54 +0000102 return Old;
Tobias Grosser33cb9f92015-09-30 11:56:19 +0000103
Johannes Doerfert28f8ac12015-12-22 19:08:24 +0000104 // Inline asm is like a constant to us.
105 if (isa<InlineAsm>(Old))
106 return Old;
107
Tobias Grosser33cb9f92015-09-30 11:56:19 +0000108 if (Value *New = GlobalMap.lookup(Old)) {
109 if (Value *NewRemapped = GlobalMap.lookup(New))
110 New = NewRemapped;
111 if (Old->getType()->getScalarSizeInBits() <
112 New->getType()->getScalarSizeInBits())
113 New = Builder.CreateTruncOrBitCast(New, Old->getType());
114
115 return New;
116 }
117
118 if (Value *New = BBMap.lookup(Old))
119 return New;
120
121 if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
122 return New;
123
Tobias Grosser16371ac2014-11-05 20:48:56 +0000124 // A scop-constant value defined by a global or a function parameter.
125 if (isa<GlobalValue>(Old) || isa<Argument>(Old))
Tobias Grosser6f764bb2015-12-14 16:19:54 +0000126 return Old;
Tobias Grosser16371ac2014-11-05 20:48:56 +0000127
128 // A scop-constant value defined by an instruction executed outside the scop.
129 if (const Instruction *Inst = dyn_cast<Instruction>(Old))
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000130 if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
Tobias Grosser6f764bb2015-12-14 16:19:54 +0000131 return Old;
Tobias Grosser16371ac2014-11-05 20:48:56 +0000132
133 // The scalar dependence is neither available nor SCEVCodegenable.
Hongbin Zheng5b463ce2013-07-25 09:12:07 +0000134 llvm_unreachable("Unexpected scalar dependence in region!");
Tobias Grosser5a56cbf2014-04-16 07:33:47 +0000135 return nullptr;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000136}
137
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000138void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
Tobias Grosserbc132602015-09-05 09:56:54 +0000139 ValueMapT &BBMap, LoopToScevMapT &LTS) {
Tobias Grosser030237d2014-02-21 15:06:05 +0000140 // We do not generate debug intrinsics as we did not investigate how to
141 // copy them correctly. At the current state, they just crash the code
142 // generation as the meta-data operands are not correctly copied.
143 if (isa<DbgInfoIntrinsic>(Inst))
144 return;
145
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000146 Instruction *NewInst = Inst->clone();
147
148 // Replace old operands with the new ones.
Tobias Grosser91f5b262014-06-04 08:06:40 +0000149 for (Value *OldOperand : Inst->operands()) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000150 Value *NewOperand =
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000151 getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForStmt(Stmt));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000152
153 if (!NewOperand) {
Tobias Grosserc14582f2013-02-05 18:01:29 +0000154 assert(!isa<StoreInst>(NewInst) &&
155 "Store instructions are always needed!");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000156 delete NewInst;
157 return;
158 }
159
160 NewInst->replaceUsesOfWith(OldOperand, NewOperand);
161 }
162
163 Builder.Insert(NewInst);
164 BBMap[Inst] = NewInst;
165
166 if (!NewInst->getType()->isVoidTy())
167 NewInst->setName("p_" + Inst->getName());
168}
169
Michael Kruse70131d32016-01-27 17:09:17 +0000170Value *
171BlockGenerator::generateLocationAccessed(ScopStmt &Stmt, MemAccInst Inst,
172 ValueMapT &BBMap, LoopToScevMapT &LTS,
173 isl_id_to_ast_expr *NewAccesses) {
Tobias Grosser09214772015-12-15 23:49:53 +0000174 const MemoryAccess &MA = Stmt.getArrayAccessFor(Inst);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000175
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000176 isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000177
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000178 if (AccessExpr) {
179 AccessExpr = isl_ast_expr_address_of(AccessExpr);
Tobias Grosser98b3ee52015-09-29 06:44:38 +0000180 auto Address = ExprBuilder->create(AccessExpr);
181
182 // Cast the address of this memory access to a pointer type that has the
183 // same element type as the original access, but uses the address space of
184 // the newly generated pointer.
185 auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
186 auto NewPtrTy = Address->getType();
187 OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
188 NewPtrTy->getPointerAddressSpace());
189
Tobias Grosserd840fc72016-02-04 13:18:42 +0000190 if (OldPtrTy != NewPtrTy)
Tobias Grosser98b3ee52015-09-29 06:44:38 +0000191 Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
Tobias Grosser98b3ee52015-09-29 06:44:38 +0000192 return Address;
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000193 }
194
Michael Kruse70131d32016-01-27 17:09:17 +0000195 return getNewValue(Stmt, Inst.getPointerOperand(), BBMap, LTS,
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000196 getLoopForStmt(Stmt));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000197}
198
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000199Loop *BlockGenerator::getLoopForStmt(const ScopStmt &Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +0000200 auto *StmtBB = Stmt.getEntryBlock();
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000201 return LI.getLoopFor(StmtBB);
Tobias Grosser369430f2013-03-22 23:42:53 +0000202}
203
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000204Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, LoadInst *Load,
Tobias Grosserbc132602015-09-05 09:56:54 +0000205 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000206 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +0000207 if (Value *PreloadLoad = GlobalMap.lookup(Load))
208 return PreloadLoad;
209
Tobias Grosserbc132602015-09-05 09:56:54 +0000210 Value *NewPointer =
Michael Kruse70131d32016-01-27 17:09:17 +0000211 generateLocationAccessed(Stmt, Load, BBMap, LTS, NewAccesses);
Johannes Doerfert87901452014-10-02 16:22:19 +0000212 Value *ScalarLoad = Builder.CreateAlignedLoad(
213 NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
Tobias Grosser86bc93a2015-09-06 08:47:57 +0000214
215 if (DebugPrinting)
216 RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
217 ": ", ScalarLoad, "\n");
218
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000219 return ScalarLoad;
220}
221
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000222void BlockGenerator::generateScalarStore(ScopStmt &Stmt, StoreInst *Store,
Tobias Grosserbc132602015-09-05 09:56:54 +0000223 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000224 isl_id_to_ast_expr *NewAccesses) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000225 Value *NewPointer =
Michael Kruse70131d32016-01-27 17:09:17 +0000226 generateLocationAccessed(Stmt, Store, BBMap, LTS, NewAccesses);
Tobias Grosserbc132602015-09-05 09:56:54 +0000227 Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000228 getLoopForStmt(Stmt));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000229
Tobias Grosser86bc93a2015-09-06 08:47:57 +0000230 if (DebugPrinting)
231 RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to ", NewPointer,
232 ": ", ValueOperand, "\n");
233
Tobias Grosserc186ac72015-08-11 08:13:15 +0000234 Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000235}
236
Johannes Doerfert5dced262015-12-22 19:08:49 +0000237bool BlockGenerator::canSyntheziseInStmt(ScopStmt &Stmt, Instruction *Inst) {
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000238 Loop *L = getLoopForStmt(Stmt);
Johannes Doerfert5dced262015-12-22 19:08:49 +0000239 return (Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
Michael Krusec7e0d9c2016-03-01 21:44:06 +0000240 canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion(), L);
Johannes Doerfert5dced262015-12-22 19:08:49 +0000241}
242
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000243void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
Tobias Grosserbc132602015-09-05 09:56:54 +0000244 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000245 isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000246 // Terminator instructions control the control flow. They are explicitly
247 // expressed in the clast and do not need to be copied.
248 if (Inst->isTerminator())
249 return;
250
Johannes Doerfert5dced262015-12-22 19:08:49 +0000251 // Synthesizable statements will be generated on-demand.
252 if (canSyntheziseInStmt(Stmt, Inst))
Tobias Grossere71c6ab2012-04-27 16:36:14 +0000253 return;
254
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000255 if (auto *Load = dyn_cast<LoadInst>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000256 Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
Sebastian Pop3d94fed2013-05-24 18:46:02 +0000257 // Compute NewLoad before its insertion in BBMap to make the insertion
258 // deterministic.
Sebastian Pop753d43f2013-05-24 17:16:02 +0000259 BBMap[Load] = NewLoad;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000260 return;
261 }
262
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000263 if (auto *Store = dyn_cast<StoreInst>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000264 generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000265 return;
266 }
267
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000268 if (auto *PHI = dyn_cast<PHINode>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000269 copyPHIInstruction(Stmt, PHI, BBMap, LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000270 return;
271 }
272
Johannes Doerfert3f500fa2015-01-25 18:07:30 +0000273 // Skip some special intrinsics for which we do not adjust the semantics to
274 // the new schedule. All others are handled like every other instruction.
Tobias Grosser9c0ffe32015-08-30 16:57:15 +0000275 if (isIgnoredIntrinsic(Inst))
276 return;
Johannes Doerfert3f500fa2015-01-25 18:07:30 +0000277
Tobias Grosserbc132602015-09-05 09:56:54 +0000278 copyInstScalar(Stmt, Inst, BBMap, LTS);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000279}
280
Tobias Grosserbc132602015-09-05 09:56:54 +0000281void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000282 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert275a1752015-02-24 16:16:32 +0000283 assert(Stmt.isBlockStmt() &&
284 "Only block statements can be copied by the block generator");
285
286 ValueMapT BBMap;
287
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000288 BasicBlock *BB = Stmt.getBasicBlock();
Tobias Grosserbc132602015-09-05 09:56:54 +0000289 copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
Johannes Doerfert275a1752015-02-24 16:16:32 +0000290}
291
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000292BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000293 BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
294 &*Builder.GetInsertPoint(), &DT, &LI);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000295 CopyBB->setName("polly.stmt." + BB->getName());
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000296 return CopyBB;
297}
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000298
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000299BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
Tobias Grosserbc132602015-09-05 09:56:54 +0000300 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000301 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000302 BasicBlock *CopyBB = splitBB(BB);
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000303 Builder.SetInsertPoint(&CopyBB->front());
Michael Kruse225f0d12015-10-17 21:36:00 +0000304 generateScalarLoads(Stmt, BBMap);
305
Tobias Grosserbc132602015-09-05 09:56:54 +0000306 copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
Michael Kruse225f0d12015-10-17 21:36:00 +0000307
308 // After a basic block was copied store all scalars that escape this block in
309 // their alloca.
310 generateScalarStores(Stmt, LTS, BBMap);
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000311 return CopyBB;
312}
313
314void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
Tobias Grosserbc132602015-09-05 09:56:54 +0000315 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000316 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000317 EntryBB = &CopyBB->getParent()->getEntryBlock();
318
Tobias Grosser91f5b262014-06-04 08:06:40 +0000319 for (Instruction &Inst : *BB)
Tobias Grosserbc132602015-09-05 09:56:54 +0000320 copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000321}
322
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000323Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
324 ScalarAllocaMapTy &Map,
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000325 const char *NameExt) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000326 // If no alloca was found create one and insert it in the entry block.
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000327 if (!Map.count(ScalarBase)) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000328 auto *Ty = ScalarBase->getType();
Tobias Grosserb09455d2015-09-18 06:01:11 +0000329 auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000330 EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000331 NewAddr->insertBefore(&*EntryBB->getFirstInsertionPt());
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000332 Map[ScalarBase] = NewAddr;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000333 }
334
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000335 auto Addr = Map[ScalarBase];
336
Tobias Grosser5c7f16b2016-01-24 14:16:59 +0000337 if (auto NewAddr = GlobalMap.lookup(Addr))
338 return NewAddr;
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000339
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000340 return Addr;
341}
342
Johannes Doerfert800e17a2016-02-02 14:16:01 +0000343Value *BlockGenerator::getOrCreateAlloca(const MemoryAccess &Access) {
Tobias Grossera535dff2015-12-13 19:59:01 +0000344 if (Access.isPHIKind())
Tobias Grosserb8d27aa2015-10-18 00:51:13 +0000345 return getOrCreatePHIAlloca(Access.getBaseAddr());
346 else
347 return getOrCreateScalarAlloca(Access.getBaseAddr());
Tobias Grossera4f09882015-10-17 22:16:00 +0000348}
349
350Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
Tobias Grossera535dff2015-12-13 19:59:01 +0000351 if (Array->isPHIKind())
Tobias Grossera4f09882015-10-17 22:16:00 +0000352 return getOrCreatePHIAlloca(Array->getBasePtr());
Tobias Grosserf8d55f72015-08-29 18:12:03 +0000353 else
Tobias Grossera4f09882015-10-17 22:16:00 +0000354 return getOrCreateScalarAlloca(Array->getBasePtr());
Tobias Grosserf8d55f72015-08-29 18:12:03 +0000355}
356
Tobias Grosserbc132602015-09-05 09:56:54 +0000357Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
358 return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
Tobias Grosserb79a67d2015-08-28 08:23:35 +0000359}
360
Tobias Grosserbc132602015-09-05 09:56:54 +0000361Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
362 return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
Tobias Grosserb79a67d2015-08-28 08:23:35 +0000363}
364
Johannes Doerfert38a012c2016-05-23 09:14:07 +0000365void BlockGenerator::handleOutsideUsers(const Scop &S, Instruction *Inst) {
Tobias Grosser29854002015-08-30 15:03:59 +0000366 // If there are escape users we get the alloca for this instruction and put it
367 // in the EscapeMap for later finalization. Lastly, if the instruction was
368 // copied multiple times we already did this and can exit.
Michael Kruseacb6ade2015-08-18 17:25:48 +0000369 if (EscapeMap.count(Inst))
370 return;
Johannes Doerferte69e1142015-08-18 11:56:00 +0000371
Johannes Doerfert38a012c2016-05-23 09:14:07 +0000372 const auto &R = S.getRegion();
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000373 EscapeUserVectorTy EscapeUsers;
374 for (User *U : Inst->users()) {
375
376 // Non-instruction user will never escape.
377 Instruction *UI = dyn_cast<Instruction>(U);
378 if (!UI)
379 continue;
380
Johannes Doerfertddb83d02015-08-16 08:35:40 +0000381 if (R.contains(UI))
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000382 continue;
383
384 EscapeUsers.push_back(UI);
385 }
386
387 // Exit if no escape uses were found.
388 if (EscapeUsers.empty())
389 return;
390
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000391 // Get or create an escape alloca for this instruction.
Johannes Doerfert38a012c2016-05-23 09:14:07 +0000392 auto *ScalarAddr = getOrCreateScalarAlloca(Inst);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000393
394 // Remember that this instruction has escape uses and the escape alloca.
395 EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000396}
397
Michael Kruse225f0d12015-10-17 21:36:00 +0000398void BlockGenerator::generateScalarLoads(ScopStmt &Stmt, ValueMapT &BBMap) {
399 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +0000400 if (MA->isArrayKind() || MA->isWrite())
Tobias Grosserd4dd6ec2015-07-27 17:57:58 +0000401 continue;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000402
Michael Krusee2bccbb2015-09-18 19:59:43 +0000403 auto *Address = getOrCreateAlloca(*MA);
Michael Kruseeac97262016-02-24 22:08:14 +0000404 assert((!isa<Instruction>(Address) ||
405 DT.dominates(cast<Instruction>(Address)->getParent(),
406 Builder.GetInsertBlock())) &&
407 "Domination violation");
Michael Krusee2bccbb2015-09-18 19:59:43 +0000408 BBMap[MA->getBaseAddr()] =
Tobias Grosser2fc50df2015-08-30 19:51:01 +0000409 Builder.CreateLoad(Address, Address->getName() + ".reload");
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000410 }
411}
412
Michael Kruse225f0d12015-10-17 21:36:00 +0000413void BlockGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosserbc132602015-09-05 09:56:54 +0000414 ValueMapT &BBMap) {
Tobias Grosserf2cdd142016-01-26 10:01:35 +0000415 Loop *L = LI.getLoopFor(Stmt.getBasicBlock());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000416
Michael Kruse225f0d12015-10-17 21:36:00 +0000417 assert(Stmt.isBlockStmt() && "Region statements need to use the "
418 "generateScalarStores() function in the "
419 "RegionGenerator");
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000420
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000421 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +0000422 if (MA->isArrayKind() || MA->isRead())
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000423 continue;
424
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000425 Value *Val = MA->getAccessValue();
Michael Kruseee6a4fc2016-01-26 13:33:27 +0000426 if (MA->isAnyPHIKind()) {
427 assert(MA->getIncoming().size() >= 1 &&
428 "Block statements have exactly one exiting block, or multiple but "
429 "with same incoming block and value");
430 assert(std::all_of(MA->getIncoming().begin(), MA->getIncoming().end(),
431 [&](std::pair<BasicBlock *, Value *> p) -> bool {
432 return p.first == Stmt.getBasicBlock();
433 }) &&
434 "Incoming block must be statement's block");
435 Val = MA->getIncoming()[0].second;
436 }
Tobias Grosserbc132602015-09-05 09:56:54 +0000437 auto *Address = getOrCreateAlloca(*MA);
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000438
Tobias Grosserf2cdd142016-01-26 10:01:35 +0000439 Val = getNewValue(Stmt, Val, BBMap, LTS, L);
Michael Kruseeac97262016-02-24 22:08:14 +0000440 assert((!isa<Instruction>(Val) ||
441 DT.dominates(cast<Instruction>(Val)->getParent(),
442 Builder.GetInsertBlock())) &&
443 "Domination violation");
444 assert((!isa<Instruction>(Address) ||
445 DT.dominates(cast<Instruction>(Address)->getParent(),
446 Builder.GetInsertBlock())) &&
447 "Domination violation");
Tobias Grosser92245222015-07-28 14:53:44 +0000448 Builder.CreateStore(Val, Address);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000449 }
450}
451
Tobias Grosserc0091a72015-08-30 19:19:34 +0000452void BlockGenerator::createScalarInitialization(Scop &S) {
453 Region &R = S.getRegion();
Johannes Doerfert188542f2015-11-09 00:21:21 +0000454 BasicBlock *ExitBB = R.getExit();
455
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000456 // The split block __just before__ the region and optimized region.
457 BasicBlock *SplitBB = R.getEnteringBlock();
458 BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
459 assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
460
461 // Get the start block of the __optimized__ region.
462 BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
463 if (StartBB == R.getEntry())
464 StartBB = SplitBBTerm->getSuccessor(1);
465
Johannes Doerfertfb19dd62015-09-26 20:57:59 +0000466 Builder.SetInsertPoint(StartBB->getTerminator());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000467
Tobias Grosserc0091a72015-08-30 19:19:34 +0000468 for (auto &Pair : S.arrays()) {
469 auto &Array = Pair.second;
470 if (Array->getNumberOfDimensions() != 0)
471 continue;
Tobias Grossera535dff2015-12-13 19:59:01 +0000472 if (Array->isPHIKind()) {
Tobias Grosserc0091a72015-08-30 19:19:34 +0000473 // For PHI nodes, the only values we need to store are the ones that
474 // reach the PHI node from outside the region. In general there should
475 // only be one such incoming edge and this edge should enter through
476 // 'SplitBB'.
477 auto PHI = cast<PHINode>(Array->getBasePtr());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000478
Tobias Grosserc0091a72015-08-30 19:19:34 +0000479 for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
480 if (!R.contains(*BI) && *BI != SplitBB)
481 llvm_unreachable("Incoming edges from outside the scop should always "
482 "come from SplitBB");
483
484 int Idx = PHI->getBasicBlockIndex(SplitBB);
485 if (Idx < 0)
486 continue;
487
488 Value *ScalarValue = PHI->getIncomingValue(Idx);
489
Tobias Grosserbc132602015-09-05 09:56:54 +0000490 Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
Tobias Grosserc0091a72015-08-30 19:19:34 +0000491 continue;
492 }
493
494 auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
495
496 if (Inst && R.contains(Inst))
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000497 continue;
498
Johannes Doerfert188542f2015-11-09 00:21:21 +0000499 // PHI nodes that are not marked as such in their SAI object are either exit
500 // PHI nodes we model as common scalars but without initialization, or
501 // incoming phi nodes that need to be initialized. Check if the first is the
502 // case for Inst and do not create and initialize memory if so.
503 if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
504 if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
505 continue;
Johannes Doerfert717b8662015-09-08 21:44:27 +0000506
Tobias Grosserc0091a72015-08-30 19:19:34 +0000507 Builder.CreateStore(Array->getBasePtr(),
Tobias Grosserbc132602015-09-05 09:56:54 +0000508 getOrCreateScalarAlloca(Array->getBasePtr()));
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000509 }
510}
511
512void BlockGenerator::createScalarFinalization(Region &R) {
513 // The exit block of the __unoptimized__ region.
514 BasicBlock *ExitBB = R.getExitingBlock();
515 // The merge block __just after__ the region and the optimized region.
516 BasicBlock *MergeBB = R.getExit();
517
518 // The exit block of the __optimized__ region.
519 BasicBlock *OptExitBB = *(pred_begin(MergeBB));
520 if (OptExitBB == ExitBB)
521 OptExitBB = *(++pred_begin(MergeBB));
522
523 Builder.SetInsertPoint(OptExitBB->getTerminator());
524 for (const auto &EscapeMapping : EscapeMap) {
525 // Extract the escaping instruction and the escaping users as well as the
526 // alloca the instruction was demoted to.
527 Instruction *EscapeInst = EscapeMapping.getFirst();
528 const auto &EscapeMappingValue = EscapeMapping.getSecond();
529 const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000530 Value *ScalarAddr = EscapeMappingValue.first;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000531
532 // Reload the demoted instruction in the optimized version of the SCoP.
Johannes Doerfertd8b6ad22015-10-18 12:36:42 +0000533 Value *EscapeInstReload =
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000534 Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
Johannes Doerfertd8b6ad22015-10-18 12:36:42 +0000535 EscapeInstReload =
536 Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000537
538 // Create the merge PHI that merges the optimized and unoptimized version.
539 PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
540 EscapeInst->getName() + ".merge");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000541 MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000542
543 // Add the respective values to the merge PHI.
544 MergePHI->addIncoming(EscapeInstReload, OptExitBB);
545 MergePHI->addIncoming(EscapeInst, ExitBB);
546
547 // The information of scalar evolution about the escaping instruction needs
548 // to be revoked so the new merged instruction will be used.
549 if (SE.isSCEVable(EscapeInst->getType()))
550 SE.forgetValue(EscapeInst);
551
552 // Replace all uses of the demoted instruction with the merge PHI.
553 for (Instruction *EUser : EscapeUsers)
554 EUser->replaceUsesOfWith(EscapeInst, MergePHI);
555 }
556}
557
Tobias Grosserffa24462015-10-17 08:54:13 +0000558void BlockGenerator::findOutsideUsers(Scop &S) {
559 auto &R = S.getRegion();
Tobias Grosserffa24462015-10-17 08:54:13 +0000560 for (auto &Pair : S.arrays()) {
561 auto &Array = Pair.second;
562
563 if (Array->getNumberOfDimensions() != 0)
564 continue;
565
Tobias Grossera535dff2015-12-13 19:59:01 +0000566 if (Array->isPHIKind())
Tobias Grosserffa24462015-10-17 08:54:13 +0000567 continue;
568
569 auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
570
571 if (!Inst)
572 continue;
573
574 // Scop invariant hoisting moves some of the base pointers out of the scop.
575 // We can ignore these, as the invariant load hoisting already registers the
576 // relevant outside users.
577 if (!R.contains(Inst))
578 continue;
579
Johannes Doerfert38a012c2016-05-23 09:14:07 +0000580 handleOutsideUsers(S, Inst);
Tobias Grosserffa24462015-10-17 08:54:13 +0000581 }
582}
583
Tobias Grosser27d742d2015-10-24 17:41:29 +0000584void BlockGenerator::createExitPHINodeMerges(Scop &S) {
585 if (S.hasSingleExitEdge())
586 return;
587
588 Region &R = S.getRegion();
589
590 auto *ExitBB = R.getExitingBlock();
591 auto *MergeBB = R.getExit();
592 auto *AfterMergeBB = MergeBB->getSingleSuccessor();
593 BasicBlock *OptExitBB = *(pred_begin(MergeBB));
594 if (OptExitBB == ExitBB)
595 OptExitBB = *(++pred_begin(MergeBB));
596
597 Builder.SetInsertPoint(OptExitBB->getTerminator());
598
599 for (auto &Pair : S.arrays()) {
600 auto &SAI = Pair.second;
601 auto *Val = SAI->getBasePtr();
602
Michael Krusefaedfcb2016-03-03 17:20:43 +0000603 // Only Value-like scalars need a merge PHI. Exit block PHIs receive either
604 // the original PHI's value or the reloaded incoming values from the
605 // generated code. An llvm::Value is merged between the original code's
606 // value or the generated one.
607 if (!SAI->isValueKind() && !SAI->isExitPHIKind())
608 continue;
609
Tobias Grosser27d742d2015-10-24 17:41:29 +0000610 PHINode *PHI = dyn_cast<PHINode>(Val);
611 if (!PHI)
612 continue;
613
Tobias Grossera3f6eda2015-10-24 19:01:09 +0000614 if (PHI->getParent() != AfterMergeBB)
Tobias Grosser27d742d2015-10-24 17:41:29 +0000615 continue;
Tobias Grosser27d742d2015-10-24 17:41:29 +0000616
617 std::string Name = PHI->getName();
618 Value *ScalarAddr = getOrCreateScalarAlloca(PHI);
619 Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
620 Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
621 Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
Michael Krusefaedfcb2016-03-03 17:20:43 +0000622 assert((!isa<Instruction>(OriginalValue) ||
623 cast<Instruction>(OriginalValue)->getParent() != MergeBB) &&
624 "Original value must no be one we just generated.");
Tobias Grosser27d742d2015-10-24 17:41:29 +0000625 auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000626 MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
Tobias Grosser27d742d2015-10-24 17:41:29 +0000627 MergePHI->addIncoming(Reload, OptExitBB);
628 MergePHI->addIncoming(OriginalValue, ExitBB);
629 int Idx = PHI->getBasicBlockIndex(MergeBB);
630 PHI->setIncomingValue(Idx, MergePHI);
631 }
632}
633
Tobias Grosserffa24462015-10-17 08:54:13 +0000634void BlockGenerator::finalizeSCoP(Scop &S) {
635 findOutsideUsers(S);
Tobias Grosserc0091a72015-08-30 19:19:34 +0000636 createScalarInitialization(S);
Tobias Grosser27d742d2015-10-24 17:41:29 +0000637 createExitPHINodeMerges(S);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000638 createScalarFinalization(S.getRegion());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000639}
640
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000641VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000642 std::vector<LoopToScevMapT> &VLTS,
643 isl_map *Schedule)
Tobias Grosserbc132602015-09-05 09:56:54 +0000644 : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
Sebastian Popa00a0292012-12-18 07:46:06 +0000645 assert(Schedule && "No statement domain provided");
646}
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000647
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000648Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
Tobias Grossere602a072013-05-07 07:30:56 +0000649 ValueMapT &VectorMap,
650 VectorValueMapT &ScalarMaps,
651 Loop *L) {
Hongbin Zhengfe11e282013-06-29 13:22:15 +0000652 if (Value *NewValue = VectorMap.lookup(Old))
653 return NewValue;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000654
655 int Width = getVectorWidth();
656
657 Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
658
659 for (int Lane = 0; Lane < Width; Lane++)
Tobias Grosserc14582f2013-02-05 18:01:29 +0000660 Vector = Builder.CreateInsertElement(
Tobias Grosserbc132602015-09-05 09:56:54 +0000661 Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
Tobias Grosser7242ad92013-02-22 08:07:06 +0000662 Builder.getInt32(Lane));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000663
664 VectorMap[Old] = Vector;
665
666 return Vector;
667}
668
669Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
670 PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
671 assert(PointerTy && "PointerType expected");
672
673 Type *ScalarType = PointerTy->getElementType();
674 VectorType *VectorType = VectorType::get(ScalarType, Width);
675
676 return PointerType::getUnqual(VectorType);
677}
678
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000679Value *VectorBlockGenerator::generateStrideOneLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000680 ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000681 __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000682 unsigned VectorWidth = getVectorWidth();
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000683 auto *Pointer = Load->getPointerOperand();
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000684 Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
685 unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
686
Michael Kruse8f25b0c2016-02-25 15:52:43 +0000687 Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[Offset],
688 VLTS[Offset], NewAccesses);
Tobias Grosserc14582f2013-02-05 18:01:29 +0000689 Value *VectorPtr =
690 Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
691 LoadInst *VecLoad =
692 Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000693 if (!Aligned)
694 VecLoad->setAlignment(8);
695
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000696 if (NegativeStride) {
697 SmallVector<Constant *, 16> Indices;
698 for (int i = VectorWidth - 1; i >= 0; i--)
699 Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
700 Constant *SV = llvm::ConstantVector::get(Indices);
701 Value *RevVecLoad = Builder.CreateShuffleVector(
702 VecLoad, VecLoad, SV, Load->getName() + "_reverse");
703 return RevVecLoad;
704 }
705
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000706 return VecLoad;
707}
708
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000709Value *VectorBlockGenerator::generateStrideZeroLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000710 ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000711 __isl_keep isl_id_to_ast_expr *NewAccesses) {
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000712 auto *Pointer = Load->getPointerOperand();
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000713 Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
Michael Kruse70131d32016-01-27 17:09:17 +0000714 Value *NewPointer =
715 generateLocationAccessed(Stmt, Load, BBMap, VLTS[0], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000716 Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
717 Load->getName() + "_p_vec_p");
Tobias Grosserc14582f2013-02-05 18:01:29 +0000718 LoadInst *ScalarLoad =
719 Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000720
721 if (!Aligned)
722 ScalarLoad->setAlignment(8);
723
Tobias Grosserc14582f2013-02-05 18:01:29 +0000724 Constant *SplatVector = Constant::getNullValue(
725 VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000726
Tobias Grosserc14582f2013-02-05 18:01:29 +0000727 Value *VectorLoad = Builder.CreateShuffleVector(
728 ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000729 return VectorLoad;
730}
731
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000732Value *VectorBlockGenerator::generateUnknownStrideLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000733 ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
Johannes Doerfert09e36972015-10-07 20:17:36 +0000734 __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000735 int VectorWidth = getVectorWidth();
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000736 auto *Pointer = Load->getPointerOperand();
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000737 VectorType *VectorType = VectorType::get(
Tobias Grosserc14582f2013-02-05 18:01:29 +0000738 dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000739
740 Value *Vector = UndefValue::get(VectorType);
741
742 for (int i = 0; i < VectorWidth; i++) {
Michael Kruse70131d32016-01-27 17:09:17 +0000743 Value *NewPointer = generateLocationAccessed(Stmt, Load, ScalarMaps[i],
744 VLTS[i], NewAccesses);
Tobias Grosserc14582f2013-02-05 18:01:29 +0000745 Value *ScalarLoad =
746 Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
747 Vector = Builder.CreateInsertElement(
748 Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000749 }
750
751 return Vector;
752}
753
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000754void VectorBlockGenerator::generateLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000755 ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000756 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +0000757 if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
758 VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
759 Load->getName() + "_p");
760 return;
761 }
762
Tobias Grosser28736452015-03-23 07:00:36 +0000763 if (!VectorType::isValidElementType(Load->getType())) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000764 for (int i = 0; i < getVectorWidth(); i++)
Tobias Grosserbc132602015-09-05 09:56:54 +0000765 ScalarMaps[i][Load] =
766 generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000767 return;
768 }
769
Tobias Grosser184a4922015-12-15 23:50:01 +0000770 const MemoryAccess &Access = Stmt.getArrayAccessFor(Load);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000771
Tobias Grosser95493982014-04-18 09:46:35 +0000772 // Make sure we have scalar values available to access the pointer to
773 // the data location.
774 extractScalarValues(Load, VectorMap, ScalarMaps);
775
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000776 Value *NewLoad;
Sebastian Popa00a0292012-12-18 07:46:06 +0000777 if (Access.isStrideZero(isl_map_copy(Schedule)))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000778 NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
Sebastian Popa00a0292012-12-18 07:46:06 +0000779 else if (Access.isStrideOne(isl_map_copy(Schedule)))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000780 NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000781 else if (Access.isStrideX(isl_map_copy(Schedule), -1))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000782 NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000783 else
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000784 NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000785
786 VectorMap[Load] = NewLoad;
787}
788
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000789void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000790 ValueMapT &VectorMap,
791 VectorValueMapT &ScalarMaps) {
792 int VectorWidth = getVectorWidth();
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000793 Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000794 ScalarMaps, getLoopForStmt(Stmt));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000795
796 assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
797
798 const CastInst *Cast = dyn_cast<CastInst>(Inst);
799 VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
800 VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
801}
802
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000803void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000804 ValueMapT &VectorMap,
805 VectorValueMapT &ScalarMaps) {
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000806 Loop *L = getLoopForStmt(Stmt);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000807 Value *OpZero = Inst->getOperand(0);
808 Value *OpOne = Inst->getOperand(1);
809
810 Value *NewOpZero, *NewOpOne;
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000811 NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
812 NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000813
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000814 Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000815 Inst->getName() + "p_vec");
816 VectorMap[Inst] = NewInst;
817}
818
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000819void VectorBlockGenerator::copyStore(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000820 ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000821 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Tobias Grosser184a4922015-12-15 23:50:01 +0000822 const MemoryAccess &Access = Stmt.getArrayAccessFor(Store);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000823
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000824 auto *Pointer = Store->getPointerOperand();
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000825 Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +0000826 ScalarMaps, getLoopForStmt(Stmt));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000827
Tobias Grosser50fd7012014-04-17 23:13:49 +0000828 // Make sure we have scalar values available to access the pointer to
829 // the data location.
830 extractScalarValues(Store, VectorMap, ScalarMaps);
831
Sebastian Popa00a0292012-12-18 07:46:06 +0000832 if (Access.isStrideOne(isl_map_copy(Schedule))) {
Johannes Doerfert1947f862014-10-08 20:18:32 +0000833 Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
Michael Kruse70131d32016-01-27 17:09:17 +0000834 Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[0],
835 VLTS[0], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000836
Tobias Grosserc14582f2013-02-05 18:01:29 +0000837 Value *VectorPtr =
838 Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000839 StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
840
841 if (!Aligned)
842 Store->setAlignment(8);
843 } else {
844 for (unsigned i = 0; i < ScalarMaps.size(); i++) {
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000845 Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
Michael Kruse70131d32016-01-27 17:09:17 +0000846 Value *NewPointer = generateLocationAccessed(Stmt, Store, ScalarMaps[i],
847 VLTS[i], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000848 Builder.CreateStore(Scalar, NewPointer);
849 }
850 }
851}
852
853bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
854 ValueMapT &VectorMap) {
Tobias Grosser91f5b262014-06-04 08:06:40 +0000855 for (Value *Operand : Inst->operands())
856 if (VectorMap.count(Operand))
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000857 return true;
858 return false;
859}
860
861bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
862 ValueMapT &VectorMap,
863 VectorValueMapT &ScalarMaps) {
864 bool HasVectorOperand = false;
865 int VectorWidth = getVectorWidth();
866
Tobias Grosser91f5b262014-06-04 08:06:40 +0000867 for (Value *Operand : Inst->operands()) {
868 ValueMapT::iterator VecOp = VectorMap.find(Operand);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000869
870 if (VecOp == VectorMap.end())
871 continue;
872
873 HasVectorOperand = true;
874 Value *NewVector = VecOp->second;
875
876 for (int i = 0; i < VectorWidth; ++i) {
877 ValueMapT &SM = ScalarMaps[i];
878
879 // If there is one scalar extracted, all scalar elements should have
880 // already been extracted by the code here. So no need to check for the
881 // existance of all of them.
Tobias Grosser91f5b262014-06-04 08:06:40 +0000882 if (SM.count(Operand))
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000883 break;
884
Tobias Grosser91f5b262014-06-04 08:06:40 +0000885 SM[Operand] =
886 Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000887 }
888 }
889
890 return HasVectorOperand;
891}
892
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000893void VectorBlockGenerator::copyInstScalarized(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000894 ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000895 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000896 bool HasVectorOperand;
897 int VectorWidth = getVectorWidth();
898
899 HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
900
901 for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000902 BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
Tobias Grosserbc132602015-09-05 09:56:54 +0000903 VLTS[VectorLane], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000904
905 if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
906 return;
907
908 // Make the result available as vector value.
909 VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
910 Value *Vector = UndefValue::get(VectorType);
911
912 for (int i = 0; i < VectorWidth; i++)
913 Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
914 Builder.getInt32(i));
915
916 VectorMap[Inst] = Vector;
917}
918
Tobias Grosserbc132602015-09-05 09:56:54 +0000919int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000920
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000921void VectorBlockGenerator::copyInstruction(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000922 ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000923 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000924 // Terminator instructions control the control flow. They are explicitly
925 // expressed in the clast and do not need to be copied.
926 if (Inst->isTerminator())
927 return;
928
Johannes Doerfert5dced262015-12-22 19:08:49 +0000929 if (canSyntheziseInStmt(Stmt, Inst))
Tobias Grossere71c6ab2012-04-27 16:36:14 +0000930 return;
931
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000932 if (auto *Load = dyn_cast<LoadInst>(Inst)) {
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000933 generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000934 return;
935 }
936
937 if (hasVectorOperands(Inst, VectorMap)) {
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000938 if (auto *Store = dyn_cast<StoreInst>(Inst)) {
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000939 copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000940 return;
941 }
942
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000943 if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000944 copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000945 return;
946 }
947
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000948 if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000949 copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000950 return;
951 }
952
953 // Falltrough: We generate scalar instructions, if we don't know how to
954 // generate vector code.
955 }
956
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000957 copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000958}
959
Tobias Grossera69d4f02015-12-15 23:49:58 +0000960void VectorBlockGenerator::generateScalarVectorLoads(
961 ScopStmt &Stmt, ValueMapT &VectorBlockMap) {
962 for (MemoryAccess *MA : Stmt) {
963 if (MA->isArrayKind() || MA->isWrite())
964 continue;
965
966 auto *Address = getOrCreateAlloca(*MA);
967 Type *VectorPtrType = getVectorPtrTy(Address, 1);
968 Value *VectorPtr = Builder.CreateBitCast(Address, VectorPtrType,
969 Address->getName() + "_p_vec_p");
970 auto *Val = Builder.CreateLoad(VectorPtr, Address->getName() + ".reload");
971 Constant *SplatVector = Constant::getNullValue(
972 VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
973
974 Value *VectorVal = Builder.CreateShuffleVector(
975 Val, Val, SplatVector, Address->getName() + "_p_splat");
976 VectorBlockMap[MA->getBaseAddr()] = VectorVal;
Tobias Grossera69d4f02015-12-15 23:49:58 +0000977 }
978}
979
980void VectorBlockGenerator::verifyNoScalarStores(ScopStmt &Stmt) {
981 for (MemoryAccess *MA : Stmt) {
982 if (MA->isArrayKind() || MA->isRead())
983 continue;
984
985 llvm_unreachable("Scalar stores not expected in vector loop");
986 }
987}
988
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000989void VectorBlockGenerator::copyStmt(
990 ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert275a1752015-02-24 16:16:32 +0000991 assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
992 "the vector block generator");
993
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000994 BasicBlock *BB = Stmt.getBasicBlock();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000995 BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
996 &*Builder.GetInsertPoint(), &DT, &LI);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000997 CopyBB->setName("polly.stmt." + BB->getName());
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000998 Builder.SetInsertPoint(&CopyBB->front());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000999
1000 // Create two maps that store the mapping from the original instructions of
1001 // the old basic block to their copies in the new basic block. Those maps
1002 // are basic block local.
1003 //
1004 // As vector code generation is supported there is one map for scalar values
1005 // and one for vector values.
1006 //
1007 // In case we just do scalar code generation, the vectorMap is not used and
1008 // the scalarMap has just one dimension, which contains the mapping.
1009 //
1010 // In case vector code generation is done, an instruction may either appear
1011 // in the vector map once (as it is calculating >vectorwidth< values at a
1012 // time. Or (if the values are calculated using scalar operations), it
1013 // appears once in every dimension of the scalarMap.
1014 VectorValueMapT ScalarBlockMap(getVectorWidth());
1015 ValueMapT VectorBlockMap;
1016
Tobias Grossera69d4f02015-12-15 23:49:58 +00001017 generateScalarVectorLoads(Stmt, VectorBlockMap);
1018
Tobias Grosser91f5b262014-06-04 08:06:40 +00001019 for (Instruction &Inst : *BB)
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +00001020 copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
Tobias Grossera69d4f02015-12-15 23:49:58 +00001021
1022 verifyNoScalarStores(Stmt);
Hongbin Zheng3b11a162012-04-25 13:16:49 +00001023}
Johannes Doerfert275a1752015-02-24 16:16:32 +00001024
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001025BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
1026 BasicBlock *BBCopy) {
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001027
1028 BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1029 BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
1030
1031 if (BBCopyIDom)
1032 DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1033
1034 return BBCopyIDom;
1035}
1036
Michael Krusef33c1252016-02-25 14:08:48 +00001037// This is to determine whether an llvm::Value (defined in @p BB) is usable when
1038// leaving a subregion. The straight-forward DT.dominates(BB, R->getExitBlock())
1039// does not work in cases where the exit block has edges from outside the
1040// region. In that case the llvm::Value would never be usable in in the exit
1041// block. The RegionGenerator however creates an new exit block ('ExitBBCopy')
1042// for the subregion's exiting edges only. We need to determine whether an
1043// llvm::Value is usable in there. We do this by checking whether it dominates
1044// all exiting blocks individually.
1045static bool isDominatingSubregionExit(const DominatorTree &DT, Region *R,
1046 BasicBlock *BB) {
1047 for (auto ExitingBB : predecessors(R->getExit())) {
1048 // Check for non-subregion incoming edges.
1049 if (!R->contains(ExitingBB))
1050 continue;
1051
1052 if (!DT.dominates(BB, ExitingBB))
1053 return false;
1054 }
1055
1056 return true;
1057}
1058
1059// Find the direct dominator of the subregion's exit block if the subregion was
1060// simplified.
1061static BasicBlock *findExitDominator(DominatorTree &DT, Region *R) {
1062 BasicBlock *Common = nullptr;
1063 for (auto ExitingBB : predecessors(R->getExit())) {
1064 // Check for non-subregion incoming edges.
1065 if (!R->contains(ExitingBB))
1066 continue;
1067
1068 // First exiting edge.
1069 if (!Common) {
1070 Common = ExitingBB;
1071 continue;
1072 }
1073
1074 Common = DT.findNearestCommonDominator(Common, ExitingBB);
1075 }
1076
1077 assert(Common && R->contains(Common));
1078 return Common;
1079}
1080
Tobias Grosserbc132602015-09-05 09:56:54 +00001081void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +00001082 isl_id_to_ast_expr *IdToAstExp) {
Johannes Doerfert275a1752015-02-24 16:16:32 +00001083 assert(Stmt.isRegionStmt() &&
Tobias Grosserd3f21832015-08-01 06:26:51 +00001084 "Only region statements can be copied by the region generator");
Johannes Doerfert275a1752015-02-24 16:16:32 +00001085
Michael Krused6fb6f12015-11-09 23:07:38 +00001086 Scop *S = Stmt.getParent();
1087
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001088 // Forget all old mappings.
1089 BlockMap.clear();
1090 RegionMaps.clear();
1091 IncompletePHINodeMap.clear();
1092
Michael Kruse225f0d12015-10-17 21:36:00 +00001093 // Collection of all values related to this subregion.
1094 ValueMapT ValueMap;
1095
Johannes Doerfert275a1752015-02-24 16:16:32 +00001096 // The region represented by the statement.
1097 Region *R = Stmt.getRegion();
1098
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001099 // Create a dedicated entry for the region where we can reload all demoted
1100 // inputs.
1101 BasicBlock *EntryBB = R->getEntry();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001102 BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1103 &*Builder.GetInsertPoint(), &DT, &LI);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001104 EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001105 Builder.SetInsertPoint(&EntryBBCopy->front());
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001106
Michael Krusec9937392015-11-09 23:33:40 +00001107 ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
1108 generateScalarLoads(Stmt, EntryBBMap);
Michael Kruse225f0d12015-10-17 21:36:00 +00001109
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001110 for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1111 if (!R->contains(*PI))
1112 BlockMap[*PI] = EntryBBCopy;
Johannes Doerfert275a1752015-02-24 16:16:32 +00001113
Michael Krused6fb6f12015-11-09 23:07:38 +00001114 // Determine the original exit block of this subregion. If it the exit block
1115 // is also the scop's exit, it it has been changed to polly.merge_new_and_old.
1116 // We move one block back to find the original block. This only happens if the
1117 // scop required simplification.
1118 // If the whole scop consists of only this non-affine region, then they share
1119 // the same Region object, such that we cannot change the exit of one and not
1120 // the other.
1121 BasicBlock *ExitBB = R->getExit();
1122 if (!S->hasSingleExitEdge() && ExitBB == S->getRegion().getExit())
1123 ExitBB = *(++pred_begin(ExitBB));
1124
Johannes Doerfert275a1752015-02-24 16:16:32 +00001125 // Iterate over all blocks in the region in a breadth-first search.
1126 std::deque<BasicBlock *> Blocks;
1127 SmallPtrSet<BasicBlock *, 8> SeenBlocks;
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001128 Blocks.push_back(EntryBB);
1129 SeenBlocks.insert(EntryBB);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001130
1131 while (!Blocks.empty()) {
1132 BasicBlock *BB = Blocks.front();
1133 Blocks.pop_front();
1134
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001135 // First split the block and update dominance information.
1136 BasicBlock *BBCopy = splitBB(BB);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001137 BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1138
Michael Krusec9937392015-11-09 23:33:40 +00001139 // Get the mapping for this block and initialize it with either the scalar
1140 // loads from the generated entering block (which dominates all blocks of
1141 // this subregion) or the maps of the immediate dominator, if part of the
1142 // subregion. The latter necessarily includes the former.
1143 ValueMapT *InitBBMap;
1144 if (BBCopyIDom) {
1145 assert(RegionMaps.count(BBCopyIDom));
1146 InitBBMap = &RegionMaps[BBCopyIDom];
1147 } else
1148 InitBBMap = &EntryBBMap;
1149 auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1150 ValueMapT &RegionMap = Inserted.first->second;
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001151
Johannes Doerfert275a1752015-02-24 16:16:32 +00001152 // Copy the block with the BlockGenerator.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001153 Builder.SetInsertPoint(&BBCopy->front());
Tobias Grosserbc132602015-09-05 09:56:54 +00001154 copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001155
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001156 // In order to remap PHI nodes we store also basic block mappings.
1157 BlockMap[BB] = BBCopy;
1158
1159 // Add values to incomplete PHI nodes waiting for this block to be copied.
1160 for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
Tobias Grosserbc132602015-09-05 09:56:54 +00001161 addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001162 IncompletePHINodeMap[BB].clear();
1163
Johannes Doerfert275a1752015-02-24 16:16:32 +00001164 // And continue with new successors inside the region.
1165 for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1166 if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1167 Blocks.push_back(*SI);
Michael Kruseebffcbe2015-11-09 22:37:29 +00001168
1169 // Remember value in case it is visible after this subregion.
Michael Krusef33c1252016-02-25 14:08:48 +00001170 if (isDominatingSubregionExit(DT, R, BB))
Michael Kruseebffcbe2015-11-09 22:37:29 +00001171 ValueMap.insert(RegionMap.begin(), RegionMap.end());
Johannes Doerfert275a1752015-02-24 16:16:32 +00001172 }
1173
1174 // Now create a new dedicated region exit block and add it to the region map.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001175 BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1176 &*Builder.GetInsertPoint(), &DT, &LI);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001177 ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001178 BlockMap[R->getExit()] = ExitBBCopy;
1179
Michael Krusef33c1252016-02-25 14:08:48 +00001180 BasicBlock *ExitDomBBCopy = BlockMap.lookup(findExitDominator(DT, R));
1181 assert(ExitDomBBCopy && "Common exit dominator must be within region; at "
1182 "least the entry node must match");
1183 DT.changeImmediateDominator(ExitBBCopy, ExitDomBBCopy);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001184
1185 // As the block generator doesn't handle control flow we need to add the
1186 // region control flow by hand after all blocks have been copied.
1187 for (BasicBlock *BB : SeenBlocks) {
1188
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001189 BasicBlock *BBCopy = BlockMap[BB];
Johannes Doerferte114dc02015-09-14 11:15:58 +00001190 TerminatorInst *TI = BB->getTerminator();
1191 if (isa<UnreachableInst>(TI)) {
1192 while (!BBCopy->empty())
1193 BBCopy->begin()->eraseFromParent();
1194 new UnreachableInst(BBCopy->getContext(), BBCopy);
1195 continue;
1196 }
1197
Johannes Doerfert275a1752015-02-24 16:16:32 +00001198 Instruction *BICopy = BBCopy->getTerminator();
1199
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001200 ValueMapT &RegionMap = RegionMaps[BBCopy];
1201 RegionMap.insert(BlockMap.begin(), BlockMap.end());
1202
Tobias Grosser45e79442015-08-01 09:07:57 +00001203 Builder.SetInsertPoint(BICopy);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001204 copyInstScalar(Stmt, TI, RegionMap, LTS);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001205 BICopy->eraseFromParent();
1206 }
1207
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001208 // Add counting PHI nodes to all loops in the region that can be used as
1209 // replacement for SCEVs refering to the old loop.
1210 for (BasicBlock *BB : SeenBlocks) {
1211 Loop *L = LI.getLoopFor(BB);
Tobias Grosserbc29e0b2015-11-12 07:34:09 +00001212 if (L == nullptr || L->getHeader() != BB || !R->contains(L))
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001213 continue;
1214
1215 BasicBlock *BBCopy = BlockMap[BB];
1216 Value *NullVal = Builder.getInt32(0);
1217 PHINode *LoopPHI =
1218 PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1219 Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1220 LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001221 LoopPHI->insertBefore(&BBCopy->front());
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001222 LoopPHIInc->insertBefore(BBCopy->getTerminator());
1223
1224 for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1225 if (!R->contains(PredBB))
1226 continue;
1227 if (L->contains(PredBB))
1228 LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1229 else
1230 LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1231 }
1232
1233 for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1234 if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1235 LoopPHI->addIncoming(NullVal, PredBBCopy);
1236
1237 LTS[L] = SE.getUnknown(LoopPHI);
1238 }
1239
Michael Kruse225f0d12015-10-17 21:36:00 +00001240 // Continue generating code in the exit block.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001241 Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
Michael Kruse225f0d12015-10-17 21:36:00 +00001242
1243 // Write values visible to other statements.
1244 generateScalarStores(Stmt, LTS, ValueMap);
Tobias Grosser3e956022015-10-26 20:41:53 +00001245 BlockMap.clear();
1246 RegionMaps.clear();
1247 IncompletePHINodeMap.clear();
Johannes Doerfert275a1752015-02-24 16:16:32 +00001248}
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001249
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001250PHINode *RegionGenerator::buildExitPHI(MemoryAccess *MA, LoopToScevMapT &LTS,
1251 ValueMapT &BBMap, Loop *L) {
1252 ScopStmt *Stmt = MA->getStatement();
1253 Region *SubR = Stmt->getRegion();
1254 auto Incoming = MA->getIncoming();
1255
1256 PollyIRBuilder::InsertPointGuard IPGuard(Builder);
1257 PHINode *OrigPHI = cast<PHINode>(MA->getAccessInstruction());
1258 BasicBlock *NewSubregionExit = Builder.GetInsertBlock();
1259
1260 // This can happen if the subregion is simplified after the ScopStmts
1261 // have been created; simplification happens as part of CodeGeneration.
1262 if (OrigPHI->getParent() != SubR->getExit()) {
1263 BasicBlock *FormerExit = SubR->getExitingBlock();
1264 if (FormerExit)
1265 NewSubregionExit = BlockMap.lookup(FormerExit);
1266 }
1267
1268 PHINode *NewPHI = PHINode::Create(OrigPHI->getType(), Incoming.size(),
1269 "polly." + OrigPHI->getName(),
1270 NewSubregionExit->getFirstNonPHI());
1271
1272 // Add the incoming values to the PHI.
1273 for (auto &Pair : Incoming) {
1274 BasicBlock *OrigIncomingBlock = Pair.first;
1275 BasicBlock *NewIncomingBlock = BlockMap.lookup(OrigIncomingBlock);
1276 Builder.SetInsertPoint(NewIncomingBlock->getTerminator());
1277 assert(RegionMaps.count(NewIncomingBlock));
1278 ValueMapT *LocalBBMap = &RegionMaps[NewIncomingBlock];
1279
1280 Value *OrigIncomingValue = Pair.second;
1281 Value *NewIncomingValue =
1282 getNewValue(*Stmt, OrigIncomingValue, *LocalBBMap, LTS, L);
1283 NewPHI->addIncoming(NewIncomingValue, NewIncomingBlock);
1284 }
1285
1286 return NewPHI;
1287}
1288
1289Value *RegionGenerator::getExitScalar(MemoryAccess *MA, LoopToScevMapT &LTS,
1290 ValueMapT &BBMap) {
1291 ScopStmt *Stmt = MA->getStatement();
1292
1293 // TODO: Add some test cases that ensure this is really the right choice.
1294 Loop *L = LI.getLoopFor(Stmt->getRegion()->getExit());
1295
1296 if (MA->isAnyPHIKind()) {
1297 auto Incoming = MA->getIncoming();
1298 assert(!Incoming.empty() &&
1299 "PHI WRITEs must have originate from at least one incoming block");
1300
1301 // If there is only one incoming value, we do not need to create a PHI.
1302 if (Incoming.size() == 1) {
1303 Value *OldVal = Incoming[0].second;
1304 return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1305 }
1306
1307 return buildExitPHI(MA, LTS, BBMap, L);
1308 }
1309
1310 // MK_Value accesses leaving the subregion must dominate the exit block; just
1311 // pass the copied value
1312 Value *OldVal = MA->getAccessValue();
1313 return getNewValue(*Stmt, OldVal, BBMap, LTS, L);
1314}
1315
Michael Kruse225f0d12015-10-17 21:36:00 +00001316void RegionGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosserbc132602015-09-05 09:56:54 +00001317 ValueMapT &BBMap) {
Tobias Grosser75296902015-08-21 19:23:21 +00001318 assert(Stmt.getRegion() &&
1319 "Block statements need to use the generateScalarStores() "
1320 "function in the BlockGenerator");
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001321
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001322 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00001323 if (MA->isArrayKind() || MA->isRead())
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001324 continue;
1325
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001326 Value *NewVal = getExitScalar(MA, LTS, BBMap);
1327 Value *Address = getOrCreateAlloca(*MA);
Michael Kruseeac97262016-02-24 22:08:14 +00001328 assert((!isa<Instruction>(NewVal) ||
1329 DT.dominates(cast<Instruction>(NewVal)->getParent(),
1330 Builder.GetInsertBlock())) &&
1331 "Domination violation");
1332 assert((!isa<Instruction>(Address) ||
1333 DT.dominates(cast<Instruction>(Address)->getParent(),
1334 Builder.GetInsertBlock())) &&
1335 "Domination violation");
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001336 Builder.CreateStore(NewVal, Address);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001337 }
1338}
1339
1340void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1341 PHINode *PHICopy, BasicBlock *IncomingBB,
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001342 LoopToScevMapT &LTS) {
1343 Region *StmtR = Stmt.getRegion();
1344
1345 // If the incoming block was not yet copied mark this PHI as incomplete.
1346 // Once the block will be copied the incoming value will be added.
1347 BasicBlock *BBCopy = BlockMap[IncomingBB];
1348 if (!BBCopy) {
1349 assert(StmtR->contains(IncomingBB) &&
1350 "Bad incoming block for PHI in non-affine region");
1351 IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1352 return;
1353 }
1354
1355 Value *OpCopy = nullptr;
1356 if (StmtR->contains(IncomingBB)) {
1357 assert(RegionMaps.count(BBCopy) &&
1358 "Incoming PHI block did not have a BBMap");
1359 ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1360
1361 Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
Michael Krusedc122222015-10-19 09:19:25 +00001362
Johannes Doerfert6ba92712016-04-01 11:25:47 +00001363 // If the current insert block is different from the PHIs incoming block
1364 // change it, otherwise do not.
1365 auto IP = Builder.GetInsertPoint();
1366 if (IP->getParent() != BBCopy)
1367 Builder.SetInsertPoint(BBCopy->getTerminator());
Johannes Doerfert2c3ffc02016-02-16 12:36:14 +00001368 OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForStmt(Stmt));
Johannes Doerfert6ba92712016-04-01 11:25:47 +00001369 if (IP->getParent() != BBCopy)
1370 Builder.SetInsertPoint(&*IP);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001371 } else {
1372
1373 if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1374 return;
1375
Tobias Grosserbc132602015-09-05 09:56:54 +00001376 Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001377 OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1378 BlockMap[IncomingBB]->getTerminator());
1379 }
1380
1381 assert(OpCopy && "Incoming PHI value was not copied properly");
1382 assert(BBCopy && "Incoming PHI block was not copied properly");
1383 PHICopy->addIncoming(OpCopy, BBCopy);
1384}
1385
Tobias Grosser2b809d12016-02-21 15:44:34 +00001386void RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
1387 ValueMapT &BBMap,
1388 LoopToScevMapT &LTS) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001389 unsigned NumIncoming = PHI->getNumIncomingValues();
1390 PHINode *PHICopy =
1391 Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1392 PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1393 BBMap[PHI] = PHICopy;
1394
1395 for (unsigned u = 0; u < NumIncoming; u++)
Tobias Grosserbc132602015-09-05 09:56:54 +00001396 addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001397}