blob: 962cc3802443cb948b77c647b11c4f4dfb000e9b [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
16#include "polly/ScopInfo.h"
Hongbin Zheng8a846612012-04-25 13:18:28 +000017#include "polly/CodeGen/BlockGenerators.h"
Tobias Grosser83628182013-05-07 08:11:54 +000018#include "polly/CodeGen/CodeGeneration.h"
Johannes Doerferta63b2572014-08-03 01:51:59 +000019#include "polly/CodeGen/IslExprBuilder.h"
Tobias Grosser86bc93a2015-09-06 08:47:57 +000020#include "polly/CodeGen/RuntimeDebugBuilder.h"
Tobias Grosser637bd632013-05-07 07:31:10 +000021#include "polly/Options.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 {
Tobias Grosser683b8e42014-11-30 14:33:31 +000066 if (SE.isSCEVable(Old->getType()))
Tobias Grosser369430f2013-03-22 23:42:53 +000067 if (const SCEV *Scev = SE.getSCEVAtScope(const_cast<Value *>(Old), L)) {
Tobias Grossere71c6ab2012-04-27 16:36:14 +000068 if (!isa<SCEVCouldNotCompute>(Scev)) {
Sebastian Pop637b23d2013-02-15 20:56:01 +000069 const SCEV *NewScev = apply(Scev, LTS, SE);
Johannes Doerfert09e36972015-10-07 20:17:36 +000070 ValueMapT VTV;
Sebastian Pop637b23d2013-02-15 20:56:01 +000071 VTV.insert(BBMap.begin(), BBMap.end());
72 VTV.insert(GlobalMap.begin(), GlobalMap.end());
Johannes Doerferte69e1142015-08-18 11:56:00 +000073
74 Scop &S = *Stmt.getParent();
75 const DataLayout &DL =
76 S.getRegion().getEntry()->getParent()->getParent()->getDataLayout();
77 auto IP = Builder.GetInsertPoint();
78
79 assert(IP != Builder.GetInsertBlock()->end() &&
Tobias Grosser45e79442015-08-01 09:07:57 +000080 "Only instructions can be insert points for SCEVExpander");
Johannes Doerfertc0729a32015-09-30 16:52:03 +000081 Value *Expanded = expandCodeFor(S, SE, DL, "polly", NewScev,
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +000082 Old->getType(), &*IP, &VTV);
Tobias Grossere71c6ab2012-04-27 16:36:14 +000083
84 BBMap[Old] = Expanded;
85 return Expanded;
86 }
Tobias Grosser369430f2013-03-22 23:42:53 +000087 }
Tobias Grossere71c6ab2012-04-27 16:36:14 +000088
Tobias Grosser33cb9f92015-09-30 11:56:19 +000089 return nullptr;
90}
91
Tobias Grosser2f1acac2015-10-04 10:18:45 +000092Value *BlockGenerator::getNewValue(ScopStmt &Stmt, Value *Old, ValueMapT &BBMap,
93 LoopToScevMapT &LTS, Loop *L) const {
Tobias Grosser33cb9f92015-09-30 11:56:19 +000094 // We assume constants never change.
95 // This avoids map lookups for many calls to this function.
96 if (isa<Constant>(Old))
97 return const_cast<Value *>(Old);
98
99 if (Value *New = GlobalMap.lookup(Old)) {
100 if (Value *NewRemapped = GlobalMap.lookup(New))
101 New = NewRemapped;
102 if (Old->getType()->getScalarSizeInBits() <
103 New->getType()->getScalarSizeInBits())
104 New = Builder.CreateTruncOrBitCast(New, Old->getType());
105
106 return New;
107 }
108
109 if (Value *New = BBMap.lookup(Old))
110 return New;
111
112 if (Value *New = trySynthesizeNewValue(Stmt, Old, BBMap, LTS, L))
113 return New;
114
Tobias Grosser16371ac2014-11-05 20:48:56 +0000115 // A scop-constant value defined by a global or a function parameter.
116 if (isa<GlobalValue>(Old) || isa<Argument>(Old))
117 return const_cast<Value *>(Old);
118
119 // A scop-constant value defined by an instruction executed outside the scop.
120 if (const Instruction *Inst = dyn_cast<Instruction>(Old))
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000121 if (!Stmt.getParent()->getRegion().contains(Inst->getParent()))
Tobias Grosser16371ac2014-11-05 20:48:56 +0000122 return const_cast<Value *>(Old);
123
124 // The scalar dependence is neither available nor SCEVCodegenable.
Hongbin Zheng5b463ce2013-07-25 09:12:07 +0000125 llvm_unreachable("Unexpected scalar dependence in region!");
Tobias Grosser5a56cbf2014-04-16 07:33:47 +0000126 return nullptr;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000127}
128
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000129void BlockGenerator::copyInstScalar(ScopStmt &Stmt, Instruction *Inst,
Tobias Grosserbc132602015-09-05 09:56:54 +0000130 ValueMapT &BBMap, LoopToScevMapT &LTS) {
Tobias Grosser030237d2014-02-21 15:06:05 +0000131 // We do not generate debug intrinsics as we did not investigate how to
132 // copy them correctly. At the current state, they just crash the code
133 // generation as the meta-data operands are not correctly copied.
134 if (isa<DbgInfoIntrinsic>(Inst))
135 return;
136
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000137 Instruction *NewInst = Inst->clone();
138
139 // Replace old operands with the new ones.
Tobias Grosser91f5b262014-06-04 08:06:40 +0000140 for (Value *OldOperand : Inst->operands()) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000141 Value *NewOperand =
142 getNewValue(Stmt, OldOperand, BBMap, LTS, getLoopForInst(Inst));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000143
144 if (!NewOperand) {
Tobias Grosserc14582f2013-02-05 18:01:29 +0000145 assert(!isa<StoreInst>(NewInst) &&
146 "Store instructions are always needed!");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000147 delete NewInst;
148 return;
149 }
150
151 NewInst->replaceUsesOfWith(OldOperand, NewOperand);
152 }
153
154 Builder.Insert(NewInst);
155 BBMap[Inst] = NewInst;
156
157 if (!NewInst->getType()->isVoidTy())
158 NewInst->setName("p_" + Inst->getName());
159}
160
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000161Value *BlockGenerator::generateLocationAccessed(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000162 ScopStmt &Stmt, const Instruction *Inst, Value *Pointer, ValueMapT &BBMap,
163 LoopToScevMapT &LTS, isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000164 const MemoryAccess &MA = Stmt.getAccessFor(Inst);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000165
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000166 isl_ast_expr *AccessExpr = isl_id_to_ast_expr_get(NewAccesses, MA.getId());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000167
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000168 if (AccessExpr) {
169 AccessExpr = isl_ast_expr_address_of(AccessExpr);
Tobias Grosser98b3ee52015-09-29 06:44:38 +0000170 auto Address = ExprBuilder->create(AccessExpr);
171
172 // Cast the address of this memory access to a pointer type that has the
173 // same element type as the original access, but uses the address space of
174 // the newly generated pointer.
175 auto OldPtrTy = MA.getAccessValue()->getType()->getPointerTo();
176 auto NewPtrTy = Address->getType();
177 OldPtrTy = PointerType::get(OldPtrTy->getElementType(),
178 NewPtrTy->getPointerAddressSpace());
179
180 if (OldPtrTy != NewPtrTy) {
181 assert(OldPtrTy->getPointerElementType()->getPrimitiveSizeInBits() ==
182 NewPtrTy->getPointerElementType()->getPrimitiveSizeInBits() &&
183 "Pointer types to elements with different size found");
184 Address = Builder.CreateBitOrPointerCast(Address, OldPtrTy);
185 }
186 return Address;
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000187 }
188
Tobias Grosserbc132602015-09-05 09:56:54 +0000189 return getNewValue(Stmt, Pointer, BBMap, LTS, getLoopForInst(Inst));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000190}
191
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000192Loop *BlockGenerator::getLoopForInst(const llvm::Instruction *Inst) {
Johannes Doerfert2ef3f4f2014-08-07 17:14:54 +0000193 return LI.getLoopFor(Inst->getParent());
Tobias Grosser369430f2013-03-22 23:42:53 +0000194}
195
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000196Value *BlockGenerator::generateScalarLoad(ScopStmt &Stmt, LoadInst *Load,
Tobias Grosserbc132602015-09-05 09:56:54 +0000197 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000198 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +0000199 if (Value *PreloadLoad = GlobalMap.lookup(Load))
200 return PreloadLoad;
201
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000202 auto *Pointer = Load->getPointerOperand();
Tobias Grosserbc132602015-09-05 09:56:54 +0000203 Value *NewPointer =
204 generateLocationAccessed(Stmt, Load, Pointer, BBMap, LTS, NewAccesses);
Johannes Doerfert87901452014-10-02 16:22:19 +0000205 Value *ScalarLoad = Builder.CreateAlignedLoad(
206 NewPointer, Load->getAlignment(), Load->getName() + "_p_scalar_");
Tobias Grosser86bc93a2015-09-06 08:47:57 +0000207
208 if (DebugPrinting)
209 RuntimeDebugBuilder::createCPUPrinter(Builder, "Load from ", NewPointer,
210 ": ", ScalarLoad, "\n");
211
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000212 return ScalarLoad;
213}
214
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000215void BlockGenerator::generateScalarStore(ScopStmt &Stmt, StoreInst *Store,
Tobias Grosserbc132602015-09-05 09:56:54 +0000216 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000217 isl_id_to_ast_expr *NewAccesses) {
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000218 auto *Pointer = Store->getPointerOperand();
Tobias Grosserbc132602015-09-05 09:56:54 +0000219 Value *NewPointer =
220 generateLocationAccessed(Stmt, Store, Pointer, BBMap, LTS, NewAccesses);
221 Value *ValueOperand = getNewValue(Stmt, Store->getValueOperand(), BBMap, LTS,
222 getLoopForInst(Store));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000223
Tobias Grosser86bc93a2015-09-06 08:47:57 +0000224 if (DebugPrinting)
225 RuntimeDebugBuilder::createCPUPrinter(Builder, "Store to ", NewPointer,
226 ": ", ValueOperand, "\n");
227
Tobias Grosserc186ac72015-08-11 08:13:15 +0000228 Builder.CreateAlignedStore(ValueOperand, NewPointer, Store->getAlignment());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000229}
230
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000231void BlockGenerator::copyInstruction(ScopStmt &Stmt, Instruction *Inst,
Tobias Grosserbc132602015-09-05 09:56:54 +0000232 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000233 isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000234 // Terminator instructions control the control flow. They are explicitly
235 // expressed in the clast and do not need to be copied.
236 if (Inst->isTerminator())
237 return;
238
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000239 Loop *L = getLoopForInst(Inst);
240 if ((Stmt.isBlockStmt() || !Stmt.getRegion()->contains(L)) &&
241 canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion())) {
Tobias Grosseraff56c82015-09-30 13:36:54 +0000242 // Synthesizable statements will be generated on-demand.
Tobias Grossere71c6ab2012-04-27 16:36:14 +0000243 return;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000244 }
Tobias Grossere71c6ab2012-04-27 16:36:14 +0000245
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000246 if (auto *Load = dyn_cast<LoadInst>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000247 Value *NewLoad = generateScalarLoad(Stmt, Load, BBMap, LTS, NewAccesses);
Sebastian Pop3d94fed2013-05-24 18:46:02 +0000248 // Compute NewLoad before its insertion in BBMap to make the insertion
249 // deterministic.
Sebastian Pop753d43f2013-05-24 17:16:02 +0000250 BBMap[Load] = NewLoad;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000251 return;
252 }
253
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000254 if (auto *Store = dyn_cast<StoreInst>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000255 generateScalarStore(Stmt, Store, BBMap, LTS, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000256 return;
257 }
258
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000259 if (auto *PHI = dyn_cast<PHINode>(Inst)) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000260 copyPHIInstruction(Stmt, PHI, BBMap, LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000261 return;
262 }
263
Johannes Doerfert3f500fa2015-01-25 18:07:30 +0000264 // Skip some special intrinsics for which we do not adjust the semantics to
265 // the new schedule. All others are handled like every other instruction.
Tobias Grosser9c0ffe32015-08-30 16:57:15 +0000266 if (isIgnoredIntrinsic(Inst))
267 return;
Johannes Doerfert3f500fa2015-01-25 18:07:30 +0000268
Tobias Grosserbc132602015-09-05 09:56:54 +0000269 copyInstScalar(Stmt, Inst, BBMap, LTS);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000270}
271
Tobias Grosserbc132602015-09-05 09:56:54 +0000272void BlockGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000273 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert275a1752015-02-24 16:16:32 +0000274 assert(Stmt.isBlockStmt() &&
275 "Only block statements can be copied by the block generator");
276
277 ValueMapT BBMap;
278
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000279 BasicBlock *BB = Stmt.getBasicBlock();
Tobias Grosserbc132602015-09-05 09:56:54 +0000280 copyBB(Stmt, BB, BBMap, LTS, NewAccesses);
Johannes Doerfert275a1752015-02-24 16:16:32 +0000281}
282
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000283BasicBlock *BlockGenerator::splitBB(BasicBlock *BB) {
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000284 BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
285 &*Builder.GetInsertPoint(), &DT, &LI);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000286 CopyBB->setName("polly.stmt." + BB->getName());
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000287 return CopyBB;
288}
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000289
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000290BasicBlock *BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB,
Tobias Grosserbc132602015-09-05 09:56:54 +0000291 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000292 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000293 BasicBlock *CopyBB = splitBB(BB);
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000294 Builder.SetInsertPoint(&CopyBB->front());
Michael Kruse225f0d12015-10-17 21:36:00 +0000295 generateScalarLoads(Stmt, BBMap);
296
Tobias Grosserbc132602015-09-05 09:56:54 +0000297 copyBB(Stmt, BB, CopyBB, BBMap, LTS, NewAccesses);
Michael Kruse225f0d12015-10-17 21:36:00 +0000298
299 // After a basic block was copied store all scalars that escape this block in
300 // their alloca.
301 generateScalarStores(Stmt, LTS, BBMap);
Johannes Doerfert514f6ef2015-02-27 18:29:04 +0000302 return CopyBB;
303}
304
305void BlockGenerator::copyBB(ScopStmt &Stmt, BasicBlock *BB, BasicBlock *CopyBB,
Tobias Grosserbc132602015-09-05 09:56:54 +0000306 ValueMapT &BBMap, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000307 isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000308 EntryBB = &CopyBB->getParent()->getEntryBlock();
309
Tobias Grosser91f5b262014-06-04 08:06:40 +0000310 for (Instruction &Inst : *BB)
Tobias Grosserbc132602015-09-05 09:56:54 +0000311 copyInstruction(Stmt, &Inst, BBMap, LTS, NewAccesses);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000312}
313
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000314Value *BlockGenerator::getOrCreateAlloca(Value *ScalarBase,
315 ScalarAllocaMapTy &Map,
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000316 const char *NameExt) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000317 // If no alloca was found create one and insert it in the entry block.
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000318 if (!Map.count(ScalarBase)) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000319 auto *Ty = ScalarBase->getType();
Tobias Grosserb09455d2015-09-18 06:01:11 +0000320 auto NewAddr = new AllocaInst(Ty, ScalarBase->getName() + NameExt);
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000321 EntryBB = &Builder.GetInsertBlock()->getParent()->getEntryBlock();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000322 NewAddr->insertBefore(&*EntryBB->getFirstInsertionPt());
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000323 Map[ScalarBase] = NewAddr;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000324 }
325
Tobias Grossere9cb5a02015-10-03 17:19:49 +0000326 auto Addr = Map[ScalarBase];
327
Tobias Grosserbc132602015-09-05 09:56:54 +0000328 if (GlobalMap.count(Addr))
329 return GlobalMap[Addr];
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000330
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000331 return Addr;
332}
333
Tobias Grosserbc132602015-09-05 09:56:54 +0000334Value *BlockGenerator::getOrCreateAlloca(MemoryAccess &Access) {
Tobias Grosserb8d27aa2015-10-18 00:51:13 +0000335 if (Access.isPHI())
336 return getOrCreatePHIAlloca(Access.getBaseAddr());
337 else
338 return getOrCreateScalarAlloca(Access.getBaseAddr());
Tobias Grossera4f09882015-10-17 22:16:00 +0000339}
340
341Value *BlockGenerator::getOrCreateAlloca(const ScopArrayInfo *Array) {
342 if (Array->isPHI())
343 return getOrCreatePHIAlloca(Array->getBasePtr());
Tobias Grosserf8d55f72015-08-29 18:12:03 +0000344 else
Tobias Grossera4f09882015-10-17 22:16:00 +0000345 return getOrCreateScalarAlloca(Array->getBasePtr());
Tobias Grosserf8d55f72015-08-29 18:12:03 +0000346}
347
Tobias Grosserbc132602015-09-05 09:56:54 +0000348Value *BlockGenerator::getOrCreateScalarAlloca(Value *ScalarBase) {
349 return getOrCreateAlloca(ScalarBase, ScalarMap, ".s2a");
Tobias Grosserb79a67d2015-08-28 08:23:35 +0000350}
351
Tobias Grosserbc132602015-09-05 09:56:54 +0000352Value *BlockGenerator::getOrCreatePHIAlloca(Value *ScalarBase) {
353 return getOrCreateAlloca(ScalarBase, PHIOpMap, ".phiops");
Tobias Grosserb79a67d2015-08-28 08:23:35 +0000354}
355
Tobias Grosserbc132602015-09-05 09:56:54 +0000356void BlockGenerator::handleOutsideUsers(const Region &R, Instruction *Inst,
Tobias Grosser26e59ee2015-10-17 08:25:54 +0000357 Value *Address) {
Tobias Grosser29854002015-08-30 15:03:59 +0000358 // If there are escape users we get the alloca for this instruction and put it
359 // in the EscapeMap for later finalization. Lastly, if the instruction was
360 // copied multiple times we already did this and can exit.
Michael Kruseacb6ade2015-08-18 17:25:48 +0000361 if (EscapeMap.count(Inst))
362 return;
Johannes Doerferte69e1142015-08-18 11:56:00 +0000363
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000364 EscapeUserVectorTy EscapeUsers;
365 for (User *U : Inst->users()) {
366
367 // Non-instruction user will never escape.
368 Instruction *UI = dyn_cast<Instruction>(U);
369 if (!UI)
370 continue;
371
Johannes Doerfertddb83d02015-08-16 08:35:40 +0000372 if (R.contains(UI))
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000373 continue;
374
375 EscapeUsers.push_back(UI);
376 }
377
378 // Exit if no escape uses were found.
379 if (EscapeUsers.empty())
380 return;
381
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000382 // Get or create an escape alloca for this instruction.
Tobias Grosserb09455d2015-09-18 06:01:11 +0000383 auto *ScalarAddr = Address ? Address : getOrCreateScalarAlloca(Inst);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000384
385 // Remember that this instruction has escape uses and the escape alloca.
386 EscapeMap[Inst] = std::make_pair(ScalarAddr, std::move(EscapeUsers));
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000387}
388
Michael Kruse225f0d12015-10-17 21:36:00 +0000389void BlockGenerator::generateScalarLoads(ScopStmt &Stmt, ValueMapT &BBMap) {
390 for (MemoryAccess *MA : Stmt) {
391 if (MA->isExplicit() || MA->isWrite())
Tobias Grosserd4dd6ec2015-07-27 17:57:58 +0000392 continue;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000393
Michael Krusee2bccbb2015-09-18 19:59:43 +0000394 auto *Address = getOrCreateAlloca(*MA);
395 BBMap[MA->getBaseAddr()] =
Tobias Grosser2fc50df2015-08-30 19:51:01 +0000396 Builder.CreateLoad(Address, Address->getName() + ".reload");
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000397 }
398}
399
400Value *BlockGenerator::getNewScalarValue(Value *ScalarValue, const Region &R,
Tobias Grosseraff56c82015-09-30 13:36:54 +0000401 ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosserbc132602015-09-05 09:56:54 +0000402 ValueMapT &BBMap) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000403 // If the value we want to store is an instruction we might have demoted it
404 // in order to make it accessible here. In such a case a reload is
405 // necessary. If it is no instruction it will always be a value that
406 // dominates the current point and we can just use it. In total there are 4
407 // options:
408 // (1) The value is no instruction ==> use the value.
409 // (2) The value is an instruction that was split out of the region prior to
410 // code generation ==> use the instruction as it dominates the region.
411 // (3) The value is an instruction:
412 // (a) The value was defined in the current block, thus a copy is in
413 // the BBMap ==> use the mapped value.
414 // (b) The value was defined in a previous block, thus we demoted it
415 // earlier ==> use the reloaded value.
416 Instruction *ScalarValueInst = dyn_cast<Instruction>(ScalarValue);
417 if (!ScalarValueInst)
418 return ScalarValue;
419
420 if (!R.contains(ScalarValueInst)) {
421 if (Value *ScalarValueCopy = GlobalMap.lookup(ScalarValueInst))
422 return /* Case (3a) */ ScalarValueCopy;
423 else
424 return /* Case 2 */ ScalarValue;
425 }
426
427 if (Value *ScalarValueCopy = BBMap.lookup(ScalarValueInst))
428 return /* Case (3a) */ ScalarValueCopy;
429
Tobias Grosseraff56c82015-09-30 13:36:54 +0000430 if ((Stmt.isBlockStmt() &&
431 Stmt.getBasicBlock() == ScalarValueInst->getParent()) ||
432 (Stmt.isRegionStmt() && Stmt.getRegion()->contains(ScalarValueInst))) {
433 auto SynthesizedValue = trySynthesizeNewValue(
434 Stmt, ScalarValueInst, BBMap, LTS, getLoopForInst(ScalarValueInst));
435
436 if (SynthesizedValue)
437 return SynthesizedValue;
438 }
439
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000440 // Case (3b)
Tobias Grosserbc132602015-09-05 09:56:54 +0000441 Value *Address = getOrCreateScalarAlloca(ScalarValueInst);
Tobias Grosserb649e262015-08-30 17:37:55 +0000442 ScalarValue = Builder.CreateLoad(Address, Address->getName() + ".reload");
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000443
444 return ScalarValue;
445}
446
Michael Kruse225f0d12015-10-17 21:36:00 +0000447void BlockGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosserbc132602015-09-05 09:56:54 +0000448 ValueMapT &BBMap) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000449 const Region &R = Stmt.getParent()->getRegion();
450
Michael Kruse225f0d12015-10-17 21:36:00 +0000451 assert(Stmt.isBlockStmt() && "Region statements need to use the "
452 "generateScalarStores() function in the "
453 "RegionGenerator");
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000454
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000455 for (MemoryAccess *MA : Stmt) {
Michael Kruse8d0b7342015-09-25 21:21:00 +0000456 if (MA->isExplicit() || MA->isRead())
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000457 continue;
458
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000459 Value *Val = MA->getAccessValue();
Tobias Grosserbc132602015-09-05 09:56:54 +0000460 auto *Address = getOrCreateAlloca(*MA);
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000461
Tobias Grosseraff56c82015-09-30 13:36:54 +0000462 Val = getNewScalarValue(Val, R, Stmt, LTS, BBMap);
Tobias Grosser92245222015-07-28 14:53:44 +0000463 Builder.CreateStore(Val, Address);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000464 }
465}
466
Tobias Grosserc0091a72015-08-30 19:19:34 +0000467void BlockGenerator::createScalarInitialization(Scop &S) {
468 Region &R = S.getRegion();
Johannes Doerfert188542f2015-11-09 00:21:21 +0000469 BasicBlock *ExitBB = R.getExit();
470
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000471 // The split block __just before__ the region and optimized region.
472 BasicBlock *SplitBB = R.getEnteringBlock();
473 BranchInst *SplitBBTerm = cast<BranchInst>(SplitBB->getTerminator());
474 assert(SplitBBTerm->getNumSuccessors() == 2 && "Bad region entering block!");
475
476 // Get the start block of the __optimized__ region.
477 BasicBlock *StartBB = SplitBBTerm->getSuccessor(0);
478 if (StartBB == R.getEntry())
479 StartBB = SplitBBTerm->getSuccessor(1);
480
Johannes Doerfertfb19dd62015-09-26 20:57:59 +0000481 Builder.SetInsertPoint(StartBB->getTerminator());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000482
Tobias Grosserc0091a72015-08-30 19:19:34 +0000483 for (auto &Pair : S.arrays()) {
484 auto &Array = Pair.second;
485 if (Array->getNumberOfDimensions() != 0)
486 continue;
487 if (Array->isPHI()) {
488 // For PHI nodes, the only values we need to store are the ones that
489 // reach the PHI node from outside the region. In general there should
490 // only be one such incoming edge and this edge should enter through
491 // 'SplitBB'.
492 auto PHI = cast<PHINode>(Array->getBasePtr());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000493
Tobias Grosserc0091a72015-08-30 19:19:34 +0000494 for (auto BI = PHI->block_begin(), BE = PHI->block_end(); BI != BE; BI++)
495 if (!R.contains(*BI) && *BI != SplitBB)
496 llvm_unreachable("Incoming edges from outside the scop should always "
497 "come from SplitBB");
498
499 int Idx = PHI->getBasicBlockIndex(SplitBB);
500 if (Idx < 0)
501 continue;
502
503 Value *ScalarValue = PHI->getIncomingValue(Idx);
504
Tobias Grosserbc132602015-09-05 09:56:54 +0000505 Builder.CreateStore(ScalarValue, getOrCreatePHIAlloca(PHI));
Tobias Grosserc0091a72015-08-30 19:19:34 +0000506 continue;
507 }
508
509 auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
510
511 if (Inst && R.contains(Inst))
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000512 continue;
513
Johannes Doerfert188542f2015-11-09 00:21:21 +0000514 // PHI nodes that are not marked as such in their SAI object are either exit
515 // PHI nodes we model as common scalars but without initialization, or
516 // incoming phi nodes that need to be initialized. Check if the first is the
517 // case for Inst and do not create and initialize memory if so.
518 if (auto *PHI = dyn_cast_or_null<PHINode>(Inst))
519 if (!S.hasSingleExitEdge() && PHI->getBasicBlockIndex(ExitBB) >= 0)
520 continue;
Johannes Doerfert717b8662015-09-08 21:44:27 +0000521
Tobias Grosserc0091a72015-08-30 19:19:34 +0000522 Builder.CreateStore(Array->getBasePtr(),
Tobias Grosserbc132602015-09-05 09:56:54 +0000523 getOrCreateScalarAlloca(Array->getBasePtr()));
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000524 }
525}
526
527void BlockGenerator::createScalarFinalization(Region &R) {
528 // The exit block of the __unoptimized__ region.
529 BasicBlock *ExitBB = R.getExitingBlock();
530 // The merge block __just after__ the region and the optimized region.
531 BasicBlock *MergeBB = R.getExit();
532
533 // The exit block of the __optimized__ region.
534 BasicBlock *OptExitBB = *(pred_begin(MergeBB));
535 if (OptExitBB == ExitBB)
536 OptExitBB = *(++pred_begin(MergeBB));
537
538 Builder.SetInsertPoint(OptExitBB->getTerminator());
539 for (const auto &EscapeMapping : EscapeMap) {
540 // Extract the escaping instruction and the escaping users as well as the
541 // alloca the instruction was demoted to.
542 Instruction *EscapeInst = EscapeMapping.getFirst();
543 const auto &EscapeMappingValue = EscapeMapping.getSecond();
544 const EscapeUserVectorTy &EscapeUsers = EscapeMappingValue.second;
Tobias Grosser64c0ff42015-08-31 05:52:24 +0000545 Value *ScalarAddr = EscapeMappingValue.first;
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000546
547 // Reload the demoted instruction in the optimized version of the SCoP.
Johannes Doerfertd8b6ad22015-10-18 12:36:42 +0000548 Value *EscapeInstReload =
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000549 Builder.CreateLoad(ScalarAddr, EscapeInst->getName() + ".final_reload");
Johannes Doerfertd8b6ad22015-10-18 12:36:42 +0000550 EscapeInstReload =
551 Builder.CreateBitOrPointerCast(EscapeInstReload, EscapeInst->getType());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000552
553 // Create the merge PHI that merges the optimized and unoptimized version.
554 PHINode *MergePHI = PHINode::Create(EscapeInst->getType(), 2,
555 EscapeInst->getName() + ".merge");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000556 MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000557
558 // Add the respective values to the merge PHI.
559 MergePHI->addIncoming(EscapeInstReload, OptExitBB);
560 MergePHI->addIncoming(EscapeInst, ExitBB);
561
562 // The information of scalar evolution about the escaping instruction needs
563 // to be revoked so the new merged instruction will be used.
564 if (SE.isSCEVable(EscapeInst->getType()))
565 SE.forgetValue(EscapeInst);
566
567 // Replace all uses of the demoted instruction with the merge PHI.
568 for (Instruction *EUser : EscapeUsers)
569 EUser->replaceUsesOfWith(EscapeInst, MergePHI);
570 }
571}
572
Tobias Grosserffa24462015-10-17 08:54:13 +0000573void BlockGenerator::findOutsideUsers(Scop &S) {
574 auto &R = S.getRegion();
Tobias Grosserffa24462015-10-17 08:54:13 +0000575 for (auto &Pair : S.arrays()) {
576 auto &Array = Pair.second;
577
578 if (Array->getNumberOfDimensions() != 0)
579 continue;
580
581 if (Array->isPHI())
582 continue;
583
584 auto *Inst = dyn_cast<Instruction>(Array->getBasePtr());
585
586 if (!Inst)
587 continue;
588
589 // Scop invariant hoisting moves some of the base pointers out of the scop.
590 // We can ignore these, as the invariant load hoisting already registers the
591 // relevant outside users.
592 if (!R.contains(Inst))
593 continue;
594
595 handleOutsideUsers(R, Inst, nullptr);
596 }
597}
598
Tobias Grosser27d742d2015-10-24 17:41:29 +0000599void BlockGenerator::createExitPHINodeMerges(Scop &S) {
600 if (S.hasSingleExitEdge())
601 return;
602
603 Region &R = S.getRegion();
604
605 auto *ExitBB = R.getExitingBlock();
606 auto *MergeBB = R.getExit();
607 auto *AfterMergeBB = MergeBB->getSingleSuccessor();
608 BasicBlock *OptExitBB = *(pred_begin(MergeBB));
609 if (OptExitBB == ExitBB)
610 OptExitBB = *(++pred_begin(MergeBB));
611
612 Builder.SetInsertPoint(OptExitBB->getTerminator());
613
614 for (auto &Pair : S.arrays()) {
615 auto &SAI = Pair.second;
616 auto *Val = SAI->getBasePtr();
617
618 PHINode *PHI = dyn_cast<PHINode>(Val);
619 if (!PHI)
620 continue;
621
Tobias Grossera3f6eda2015-10-24 19:01:09 +0000622 if (PHI->getParent() != AfterMergeBB)
Tobias Grosser27d742d2015-10-24 17:41:29 +0000623 continue;
Tobias Grosser27d742d2015-10-24 17:41:29 +0000624
625 std::string Name = PHI->getName();
626 Value *ScalarAddr = getOrCreateScalarAlloca(PHI);
627 Value *Reload = Builder.CreateLoad(ScalarAddr, Name + ".ph.final_reload");
628 Reload = Builder.CreateBitOrPointerCast(Reload, PHI->getType());
629 Value *OriginalValue = PHI->getIncomingValueForBlock(MergeBB);
630 auto *MergePHI = PHINode::Create(PHI->getType(), 2, Name + ".ph.merge");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000631 MergePHI->insertBefore(&*MergeBB->getFirstInsertionPt());
Tobias Grosser27d742d2015-10-24 17:41:29 +0000632 MergePHI->addIncoming(Reload, OptExitBB);
633 MergePHI->addIncoming(OriginalValue, ExitBB);
634 int Idx = PHI->getBasicBlockIndex(MergeBB);
635 PHI->setIncomingValue(Idx, MergePHI);
636 }
637}
638
Tobias Grosserffa24462015-10-17 08:54:13 +0000639void BlockGenerator::finalizeSCoP(Scop &S) {
640 findOutsideUsers(S);
Tobias Grosserc0091a72015-08-30 19:19:34 +0000641 createScalarInitialization(S);
Tobias Grosser27d742d2015-10-24 17:41:29 +0000642 createExitPHINodeMerges(S);
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000643 createScalarFinalization(S.getRegion());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000644}
645
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000646VectorBlockGenerator::VectorBlockGenerator(BlockGenerator &BlockGen,
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000647 std::vector<LoopToScevMapT> &VLTS,
648 isl_map *Schedule)
Tobias Grosserbc132602015-09-05 09:56:54 +0000649 : BlockGenerator(BlockGen), VLTS(VLTS), Schedule(Schedule) {
Sebastian Popa00a0292012-12-18 07:46:06 +0000650 assert(Schedule && "No statement domain provided");
651}
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000652
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000653Value *VectorBlockGenerator::getVectorValue(ScopStmt &Stmt, Value *Old,
Tobias Grossere602a072013-05-07 07:30:56 +0000654 ValueMapT &VectorMap,
655 VectorValueMapT &ScalarMaps,
656 Loop *L) {
Hongbin Zhengfe11e282013-06-29 13:22:15 +0000657 if (Value *NewValue = VectorMap.lookup(Old))
658 return NewValue;
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000659
660 int Width = getVectorWidth();
661
662 Value *Vector = UndefValue::get(VectorType::get(Old->getType(), Width));
663
664 for (int Lane = 0; Lane < Width; Lane++)
Tobias Grosserc14582f2013-02-05 18:01:29 +0000665 Vector = Builder.CreateInsertElement(
Tobias Grosserbc132602015-09-05 09:56:54 +0000666 Vector, getNewValue(Stmt, Old, ScalarMaps[Lane], VLTS[Lane], L),
Tobias Grosser7242ad92013-02-22 08:07:06 +0000667 Builder.getInt32(Lane));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000668
669 VectorMap[Old] = Vector;
670
671 return Vector;
672}
673
674Type *VectorBlockGenerator::getVectorPtrTy(const Value *Val, int Width) {
675 PointerType *PointerTy = dyn_cast<PointerType>(Val->getType());
676 assert(PointerTy && "PointerType expected");
677
678 Type *ScalarType = PointerTy->getElementType();
679 VectorType *VectorType = VectorType::get(ScalarType, Width);
680
681 return PointerType::getUnqual(VectorType);
682}
683
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000684Value *VectorBlockGenerator::generateStrideOneLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000685 ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000686 __isl_keep isl_id_to_ast_expr *NewAccesses, bool NegativeStride = false) {
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000687 unsigned VectorWidth = getVectorWidth();
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000688 auto *Pointer = Load->getPointerOperand();
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000689 Type *VectorPtrType = getVectorPtrTy(Pointer, VectorWidth);
690 unsigned Offset = NegativeStride ? VectorWidth - 1 : 0;
691
Tobias Grosser5a56cbf2014-04-16 07:33:47 +0000692 Value *NewPointer = nullptr;
Tobias Grosserbc132602015-09-05 09:56:54 +0000693 NewPointer = generateLocationAccessed(Stmt, Load, Pointer, ScalarMaps[Offset],
694 VLTS[Offset], NewAccesses);
Tobias Grosserc14582f2013-02-05 18:01:29 +0000695 Value *VectorPtr =
696 Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
697 LoadInst *VecLoad =
698 Builder.CreateLoad(VectorPtr, Load->getName() + "_p_vec_full");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000699 if (!Aligned)
700 VecLoad->setAlignment(8);
701
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000702 if (NegativeStride) {
703 SmallVector<Constant *, 16> Indices;
704 for (int i = VectorWidth - 1; i >= 0; i--)
705 Indices.push_back(ConstantInt::get(Builder.getInt32Ty(), i));
706 Constant *SV = llvm::ConstantVector::get(Indices);
707 Value *RevVecLoad = Builder.CreateShuffleVector(
708 VecLoad, VecLoad, SV, Load->getName() + "_reverse");
709 return RevVecLoad;
710 }
711
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000712 return VecLoad;
713}
714
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000715Value *VectorBlockGenerator::generateStrideZeroLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000716 ScopStmt &Stmt, LoadInst *Load, ValueMapT &BBMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000717 __isl_keep isl_id_to_ast_expr *NewAccesses) {
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000718 auto *Pointer = Load->getPointerOperand();
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000719 Type *VectorPtrType = getVectorPtrTy(Pointer, 1);
Tobias Grosserbc132602015-09-05 09:56:54 +0000720 Value *NewPointer = generateLocationAccessed(Stmt, Load, Pointer, BBMap,
721 VLTS[0], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000722 Value *VectorPtr = Builder.CreateBitCast(NewPointer, VectorPtrType,
723 Load->getName() + "_p_vec_p");
Tobias Grosserc14582f2013-02-05 18:01:29 +0000724 LoadInst *ScalarLoad =
725 Builder.CreateLoad(VectorPtr, Load->getName() + "_p_splat_one");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000726
727 if (!Aligned)
728 ScalarLoad->setAlignment(8);
729
Tobias Grosserc14582f2013-02-05 18:01:29 +0000730 Constant *SplatVector = Constant::getNullValue(
731 VectorType::get(Builder.getInt32Ty(), getVectorWidth()));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000732
Tobias Grosserc14582f2013-02-05 18:01:29 +0000733 Value *VectorLoad = Builder.CreateShuffleVector(
734 ScalarLoad, ScalarLoad, SplatVector, Load->getName() + "_p_splat");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000735 return VectorLoad;
736}
737
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000738Value *VectorBlockGenerator::generateUnknownStrideLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000739 ScopStmt &Stmt, LoadInst *Load, VectorValueMapT &ScalarMaps,
Johannes Doerfert09e36972015-10-07 20:17:36 +0000740 __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000741 int VectorWidth = getVectorWidth();
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000742 auto *Pointer = Load->getPointerOperand();
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000743 VectorType *VectorType = VectorType::get(
Tobias Grosserc14582f2013-02-05 18:01:29 +0000744 dyn_cast<PointerType>(Pointer->getType())->getElementType(), VectorWidth);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000745
746 Value *Vector = UndefValue::get(VectorType);
747
748 for (int i = 0; i < VectorWidth; i++) {
Tobias Grosserbc132602015-09-05 09:56:54 +0000749 Value *NewPointer = generateLocationAccessed(
750 Stmt, Load, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
Tobias Grosserc14582f2013-02-05 18:01:29 +0000751 Value *ScalarLoad =
752 Builder.CreateLoad(NewPointer, Load->getName() + "_p_scalar_");
753 Vector = Builder.CreateInsertElement(
754 Vector, ScalarLoad, Builder.getInt32(i), Load->getName() + "_p_vec_");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000755 }
756
757 return Vector;
758}
759
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000760void VectorBlockGenerator::generateLoad(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000761 ScopStmt &Stmt, LoadInst *Load, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000762 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +0000763 if (Value *PreloadLoad = GlobalMap.lookup(Load)) {
764 VectorMap[Load] = Builder.CreateVectorSplat(getVectorWidth(), PreloadLoad,
765 Load->getName() + "_p");
766 return;
767 }
768
Tobias Grosser28736452015-03-23 07:00:36 +0000769 if (!VectorType::isValidElementType(Load->getType())) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000770 for (int i = 0; i < getVectorWidth(); i++)
Tobias Grosserbc132602015-09-05 09:56:54 +0000771 ScalarMaps[i][Load] =
772 generateScalarLoad(Stmt, Load, ScalarMaps[i], VLTS[i], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000773 return;
774 }
775
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000776 const MemoryAccess &Access = Stmt.getAccessFor(Load);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000777
Tobias Grosser95493982014-04-18 09:46:35 +0000778 // Make sure we have scalar values available to access the pointer to
779 // the data location.
780 extractScalarValues(Load, VectorMap, ScalarMaps);
781
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000782 Value *NewLoad;
Sebastian Popa00a0292012-12-18 07:46:06 +0000783 if (Access.isStrideZero(isl_map_copy(Schedule)))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000784 NewLoad = generateStrideZeroLoad(Stmt, Load, ScalarMaps[0], NewAccesses);
Sebastian Popa00a0292012-12-18 07:46:06 +0000785 else if (Access.isStrideOne(isl_map_copy(Schedule)))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000786 NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses);
Tobias Grosser0dd463f2014-03-19 19:27:24 +0000787 else if (Access.isStrideX(isl_map_copy(Schedule), -1))
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000788 NewLoad = generateStrideOneLoad(Stmt, Load, ScalarMaps, NewAccesses, true);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000789 else
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000790 NewLoad = generateUnknownStrideLoad(Stmt, Load, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000791
792 VectorMap[Load] = NewLoad;
793}
794
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000795void VectorBlockGenerator::copyUnaryInst(ScopStmt &Stmt, UnaryInstruction *Inst,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000796 ValueMapT &VectorMap,
797 VectorValueMapT &ScalarMaps) {
798 int VectorWidth = getVectorWidth();
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000799 Value *NewOperand = getVectorValue(Stmt, Inst->getOperand(0), VectorMap,
800 ScalarMaps, getLoopForInst(Inst));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000801
802 assert(isa<CastInst>(Inst) && "Can not generate vector code for instruction");
803
804 const CastInst *Cast = dyn_cast<CastInst>(Inst);
805 VectorType *DestType = VectorType::get(Inst->getType(), VectorWidth);
806 VectorMap[Inst] = Builder.CreateCast(Cast->getOpcode(), NewOperand, DestType);
807}
808
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000809void VectorBlockGenerator::copyBinaryInst(ScopStmt &Stmt, BinaryOperator *Inst,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000810 ValueMapT &VectorMap,
811 VectorValueMapT &ScalarMaps) {
Tobias Grosser369430f2013-03-22 23:42:53 +0000812 Loop *L = getLoopForInst(Inst);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000813 Value *OpZero = Inst->getOperand(0);
814 Value *OpOne = Inst->getOperand(1);
815
816 Value *NewOpZero, *NewOpOne;
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000817 NewOpZero = getVectorValue(Stmt, OpZero, VectorMap, ScalarMaps, L);
818 NewOpOne = getVectorValue(Stmt, OpOne, VectorMap, ScalarMaps, L);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000819
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000820 Value *NewInst = Builder.CreateBinOp(Inst->getOpcode(), NewOpZero, NewOpOne,
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000821 Inst->getName() + "p_vec");
822 VectorMap[Inst] = NewInst;
823}
824
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000825void VectorBlockGenerator::copyStore(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000826 ScopStmt &Stmt, StoreInst *Store, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000827 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000828 const MemoryAccess &Access = Stmt.getAccessFor(Store);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000829
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000830 auto *Pointer = Store->getPointerOperand();
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000831 Value *Vector = getVectorValue(Stmt, Store->getValueOperand(), VectorMap,
Tobias Grosser369430f2013-03-22 23:42:53 +0000832 ScalarMaps, getLoopForInst(Store));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000833
Tobias Grosser50fd7012014-04-17 23:13:49 +0000834 // Make sure we have scalar values available to access the pointer to
835 // the data location.
836 extractScalarValues(Store, VectorMap, ScalarMaps);
837
Sebastian Popa00a0292012-12-18 07:46:06 +0000838 if (Access.isStrideOne(isl_map_copy(Schedule))) {
Johannes Doerfert1947f862014-10-08 20:18:32 +0000839 Type *VectorPtrType = getVectorPtrTy(Pointer, getVectorWidth());
Tobias Grosserbc132602015-09-05 09:56:54 +0000840 Value *NewPointer = generateLocationAccessed(
841 Stmt, Store, Pointer, ScalarMaps[0], VLTS[0], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000842
Tobias Grosserc14582f2013-02-05 18:01:29 +0000843 Value *VectorPtr =
844 Builder.CreateBitCast(NewPointer, VectorPtrType, "vector_ptr");
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000845 StoreInst *Store = Builder.CreateStore(Vector, VectorPtr);
846
847 if (!Aligned)
848 Store->setAlignment(8);
849 } else {
850 for (unsigned i = 0; i < ScalarMaps.size(); i++) {
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000851 Value *Scalar = Builder.CreateExtractElement(Vector, Builder.getInt32(i));
Tobias Grosserbc132602015-09-05 09:56:54 +0000852 Value *NewPointer = generateLocationAccessed(
853 Stmt, Store, Pointer, ScalarMaps[i], VLTS[i], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000854 Builder.CreateStore(Scalar, NewPointer);
855 }
856 }
857}
858
859bool VectorBlockGenerator::hasVectorOperands(const Instruction *Inst,
860 ValueMapT &VectorMap) {
Tobias Grosser91f5b262014-06-04 08:06:40 +0000861 for (Value *Operand : Inst->operands())
862 if (VectorMap.count(Operand))
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000863 return true;
864 return false;
865}
866
867bool VectorBlockGenerator::extractScalarValues(const Instruction *Inst,
868 ValueMapT &VectorMap,
869 VectorValueMapT &ScalarMaps) {
870 bool HasVectorOperand = false;
871 int VectorWidth = getVectorWidth();
872
Tobias Grosser91f5b262014-06-04 08:06:40 +0000873 for (Value *Operand : Inst->operands()) {
874 ValueMapT::iterator VecOp = VectorMap.find(Operand);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000875
876 if (VecOp == VectorMap.end())
877 continue;
878
879 HasVectorOperand = true;
880 Value *NewVector = VecOp->second;
881
882 for (int i = 0; i < VectorWidth; ++i) {
883 ValueMapT &SM = ScalarMaps[i];
884
885 // If there is one scalar extracted, all scalar elements should have
886 // already been extracted by the code here. So no need to check for the
887 // existance of all of them.
Tobias Grosser91f5b262014-06-04 08:06:40 +0000888 if (SM.count(Operand))
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000889 break;
890
Tobias Grosser91f5b262014-06-04 08:06:40 +0000891 SM[Operand] =
892 Builder.CreateExtractElement(NewVector, Builder.getInt32(i));
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000893 }
894 }
895
896 return HasVectorOperand;
897}
898
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000899void VectorBlockGenerator::copyInstScalarized(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000900 ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000901 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000902 bool HasVectorOperand;
903 int VectorWidth = getVectorWidth();
904
905 HasVectorOperand = extractScalarValues(Inst, VectorMap, ScalarMaps);
906
907 for (int VectorLane = 0; VectorLane < getVectorWidth(); VectorLane++)
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000908 BlockGenerator::copyInstruction(Stmt, Inst, ScalarMaps[VectorLane],
Tobias Grosserbc132602015-09-05 09:56:54 +0000909 VLTS[VectorLane], NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000910
911 if (!VectorType::isValidElementType(Inst->getType()) || !HasVectorOperand)
912 return;
913
914 // Make the result available as vector value.
915 VectorType *VectorType = VectorType::get(Inst->getType(), VectorWidth);
916 Value *Vector = UndefValue::get(VectorType);
917
918 for (int i = 0; i < VectorWidth; i++)
919 Vector = Builder.CreateInsertElement(Vector, ScalarMaps[i][Inst],
920 Builder.getInt32(i));
921
922 VectorMap[Inst] = Vector;
923}
924
Tobias Grosserbc132602015-09-05 09:56:54 +0000925int VectorBlockGenerator::getVectorWidth() { return VLTS.size(); }
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000926
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000927void VectorBlockGenerator::copyInstruction(
Tobias Grosser2f1acac2015-10-04 10:18:45 +0000928 ScopStmt &Stmt, Instruction *Inst, ValueMapT &VectorMap,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000929 VectorValueMapT &ScalarMaps, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000930 // Terminator instructions control the control flow. They are explicitly
931 // expressed in the clast and do not need to be copied.
932 if (Inst->isTerminator())
933 return;
934
Johannes Doerfert1ef52332015-02-08 20:50:42 +0000935 if (canSynthesize(Inst, &LI, &SE, &Stmt.getParent()->getRegion()))
Tobias Grossere71c6ab2012-04-27 16:36:14 +0000936 return;
937
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000938 if (auto *Load = dyn_cast<LoadInst>(Inst)) {
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000939 generateLoad(Stmt, Load, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000940 return;
941 }
942
943 if (hasVectorOperands(Inst, VectorMap)) {
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000944 if (auto *Store = dyn_cast<StoreInst>(Inst)) {
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000945 copyStore(Stmt, Store, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000946 return;
947 }
948
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000949 if (auto *Unary = dyn_cast<UnaryInstruction>(Inst)) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000950 copyUnaryInst(Stmt, Unary, VectorMap, ScalarMaps);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000951 return;
952 }
953
Tobias Grosser9646e3f2015-10-04 10:18:39 +0000954 if (auto *Binary = dyn_cast<BinaryOperator>(Inst)) {
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000955 copyBinaryInst(Stmt, Binary, VectorMap, ScalarMaps);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000956 return;
957 }
958
959 // Falltrough: We generate scalar instructions, if we don't know how to
960 // generate vector code.
961 }
962
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000963 copyInstScalarized(Stmt, Inst, VectorMap, ScalarMaps, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000964}
965
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000966void VectorBlockGenerator::copyStmt(
967 ScopStmt &Stmt, __isl_keep isl_id_to_ast_expr *NewAccesses) {
Johannes Doerfert275a1752015-02-24 16:16:32 +0000968 assert(Stmt.isBlockStmt() && "TODO: Only block statements can be copied by "
969 "the vector block generator");
970
Johannes Doerfertbe9c9112015-02-06 21:39:31 +0000971 BasicBlock *BB = Stmt.getBasicBlock();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000972 BasicBlock *CopyBB = SplitBlock(Builder.GetInsertBlock(),
973 &*Builder.GetInsertPoint(), &DT, &LI);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000974 CopyBB->setName("polly.stmt." + BB->getName());
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +0000975 Builder.SetInsertPoint(&CopyBB->front());
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000976
977 // Create two maps that store the mapping from the original instructions of
978 // the old basic block to their copies in the new basic block. Those maps
979 // are basic block local.
980 //
981 // As vector code generation is supported there is one map for scalar values
982 // and one for vector values.
983 //
984 // In case we just do scalar code generation, the vectorMap is not used and
985 // the scalarMap has just one dimension, which contains the mapping.
986 //
987 // In case vector code generation is done, an instruction may either appear
988 // in the vector map once (as it is calculating >vectorwidth< values at a
989 // time. Or (if the values are calculated using scalar operations), it
990 // appears once in every dimension of the scalarMap.
991 VectorValueMapT ScalarBlockMap(getVectorWidth());
992 ValueMapT VectorBlockMap;
993
Tobias Grosser91f5b262014-06-04 08:06:40 +0000994 for (Instruction &Inst : *BB)
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +0000995 copyInstruction(Stmt, &Inst, VectorBlockMap, ScalarBlockMap, NewAccesses);
Hongbin Zheng3b11a162012-04-25 13:16:49 +0000996}
Johannes Doerfert275a1752015-02-24 16:16:32 +0000997
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000998BasicBlock *RegionGenerator::repairDominance(BasicBlock *BB,
999 BasicBlock *BBCopy) {
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001000
1001 BasicBlock *BBIDom = DT.getNode(BB)->getIDom()->getBlock();
1002 BasicBlock *BBCopyIDom = BlockMap.lookup(BBIDom);
1003
1004 if (BBCopyIDom)
1005 DT.changeImmediateDominator(BBCopy, BBCopyIDom);
1006
1007 return BBCopyIDom;
1008}
1009
Tobias Grosserbc132602015-09-05 09:56:54 +00001010void RegionGenerator::copyStmt(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosser2d1ed0b2015-08-27 07:28:16 +00001011 isl_id_to_ast_expr *IdToAstExp) {
Johannes Doerfert275a1752015-02-24 16:16:32 +00001012 assert(Stmt.isRegionStmt() &&
Tobias Grosserd3f21832015-08-01 06:26:51 +00001013 "Only region statements can be copied by the region generator");
Johannes Doerfert275a1752015-02-24 16:16:32 +00001014
Michael Krused6fb6f12015-11-09 23:07:38 +00001015 Scop *S = Stmt.getParent();
1016
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001017 // Forget all old mappings.
1018 BlockMap.clear();
1019 RegionMaps.clear();
1020 IncompletePHINodeMap.clear();
1021
Michael Kruse225f0d12015-10-17 21:36:00 +00001022 // Collection of all values related to this subregion.
1023 ValueMapT ValueMap;
1024
Johannes Doerfert275a1752015-02-24 16:16:32 +00001025 // The region represented by the statement.
1026 Region *R = Stmt.getRegion();
1027
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001028 // Create a dedicated entry for the region where we can reload all demoted
1029 // inputs.
1030 BasicBlock *EntryBB = R->getEntry();
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001031 BasicBlock *EntryBBCopy = SplitBlock(Builder.GetInsertBlock(),
1032 &*Builder.GetInsertPoint(), &DT, &LI);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001033 EntryBBCopy->setName("polly.stmt." + EntryBB->getName() + ".entry");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001034 Builder.SetInsertPoint(&EntryBBCopy->front());
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001035
Michael Krusec9937392015-11-09 23:33:40 +00001036 ValueMapT &EntryBBMap = RegionMaps[EntryBBCopy];
1037 generateScalarLoads(Stmt, EntryBBMap);
Michael Kruse225f0d12015-10-17 21:36:00 +00001038
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001039 for (auto PI = pred_begin(EntryBB), PE = pred_end(EntryBB); PI != PE; ++PI)
1040 if (!R->contains(*PI))
1041 BlockMap[*PI] = EntryBBCopy;
Johannes Doerfert275a1752015-02-24 16:16:32 +00001042
Michael Krused6fb6f12015-11-09 23:07:38 +00001043 // Determine the original exit block of this subregion. If it the exit block
1044 // is also the scop's exit, it it has been changed to polly.merge_new_and_old.
1045 // We move one block back to find the original block. This only happens if the
1046 // scop required simplification.
1047 // If the whole scop consists of only this non-affine region, then they share
1048 // the same Region object, such that we cannot change the exit of one and not
1049 // the other.
1050 BasicBlock *ExitBB = R->getExit();
1051 if (!S->hasSingleExitEdge() && ExitBB == S->getRegion().getExit())
1052 ExitBB = *(++pred_begin(ExitBB));
1053
Johannes Doerfert275a1752015-02-24 16:16:32 +00001054 // Iterate over all blocks in the region in a breadth-first search.
1055 std::deque<BasicBlock *> Blocks;
1056 SmallPtrSet<BasicBlock *, 8> SeenBlocks;
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001057 Blocks.push_back(EntryBB);
1058 SeenBlocks.insert(EntryBB);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001059
1060 while (!Blocks.empty()) {
1061 BasicBlock *BB = Blocks.front();
1062 Blocks.pop_front();
1063
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001064 // First split the block and update dominance information.
1065 BasicBlock *BBCopy = splitBB(BB);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001066 BasicBlock *BBCopyIDom = repairDominance(BB, BBCopy);
1067
1068 // In order to remap PHI nodes we store also basic block mappings.
1069 BlockMap[BB] = BBCopy;
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001070
Michael Krusec9937392015-11-09 23:33:40 +00001071 // Get the mapping for this block and initialize it with either the scalar
1072 // loads from the generated entering block (which dominates all blocks of
1073 // this subregion) or the maps of the immediate dominator, if part of the
1074 // subregion. The latter necessarily includes the former.
1075 ValueMapT *InitBBMap;
1076 if (BBCopyIDom) {
1077 assert(RegionMaps.count(BBCopyIDom));
1078 InitBBMap = &RegionMaps[BBCopyIDom];
1079 } else
1080 InitBBMap = &EntryBBMap;
1081 auto Inserted = RegionMaps.insert(std::make_pair(BBCopy, *InitBBMap));
1082 ValueMapT &RegionMap = Inserted.first->second;
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001083
Johannes Doerfert275a1752015-02-24 16:16:32 +00001084 // Copy the block with the BlockGenerator.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001085 Builder.SetInsertPoint(&BBCopy->front());
Tobias Grosserbc132602015-09-05 09:56:54 +00001086 copyBB(Stmt, BB, BBCopy, RegionMap, LTS, IdToAstExp);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001087
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001088 // In order to remap PHI nodes we store also basic block mappings.
1089 BlockMap[BB] = BBCopy;
1090
1091 // Add values to incomplete PHI nodes waiting for this block to be copied.
1092 for (const PHINodePairTy &PHINodePair : IncompletePHINodeMap[BB])
Tobias Grosserbc132602015-09-05 09:56:54 +00001093 addOperandToPHI(Stmt, PHINodePair.first, PHINodePair.second, BB, LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001094 IncompletePHINodeMap[BB].clear();
1095
Johannes Doerfert275a1752015-02-24 16:16:32 +00001096 // And continue with new successors inside the region.
1097 for (auto SI = succ_begin(BB), SE = succ_end(BB); SI != SE; SI++)
1098 if (R->contains(*SI) && SeenBlocks.insert(*SI).second)
1099 Blocks.push_back(*SI);
Michael Kruseebffcbe2015-11-09 22:37:29 +00001100
1101 // Remember value in case it is visible after this subregion.
Michael Krused6fb6f12015-11-09 23:07:38 +00001102 if (DT.dominates(BB, ExitBB))
Michael Kruseebffcbe2015-11-09 22:37:29 +00001103 ValueMap.insert(RegionMap.begin(), RegionMap.end());
Johannes Doerfert275a1752015-02-24 16:16:32 +00001104 }
1105
1106 // 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 +00001107 BasicBlock *ExitBBCopy = SplitBlock(Builder.GetInsertBlock(),
1108 &*Builder.GetInsertPoint(), &DT, &LI);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001109 ExitBBCopy->setName("polly.stmt." + R->getExit()->getName() + ".exit");
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001110 BlockMap[R->getExit()] = ExitBBCopy;
1111
Michael Krused6fb6f12015-11-09 23:07:38 +00001112 if (ExitBB == R->getExit())
1113 repairDominance(ExitBB, ExitBBCopy);
1114 else
1115 DT.changeImmediateDominator(ExitBBCopy, BlockMap.lookup(ExitBB));
Johannes Doerfert275a1752015-02-24 16:16:32 +00001116
1117 // As the block generator doesn't handle control flow we need to add the
1118 // region control flow by hand after all blocks have been copied.
1119 for (BasicBlock *BB : SeenBlocks) {
1120
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001121 BasicBlock *BBCopy = BlockMap[BB];
Johannes Doerferte114dc02015-09-14 11:15:58 +00001122 TerminatorInst *TI = BB->getTerminator();
1123 if (isa<UnreachableInst>(TI)) {
1124 while (!BBCopy->empty())
1125 BBCopy->begin()->eraseFromParent();
1126 new UnreachableInst(BBCopy->getContext(), BBCopy);
1127 continue;
1128 }
1129
Johannes Doerfert275a1752015-02-24 16:16:32 +00001130 Instruction *BICopy = BBCopy->getTerminator();
1131
Johannes Doerfert514f6ef2015-02-27 18:29:04 +00001132 ValueMapT &RegionMap = RegionMaps[BBCopy];
1133 RegionMap.insert(BlockMap.begin(), BlockMap.end());
1134
Tobias Grosser45e79442015-08-01 09:07:57 +00001135 Builder.SetInsertPoint(BICopy);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001136 copyInstScalar(Stmt, TI, RegionMap, LTS);
Johannes Doerfert275a1752015-02-24 16:16:32 +00001137 BICopy->eraseFromParent();
1138 }
1139
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001140 // Add counting PHI nodes to all loops in the region that can be used as
1141 // replacement for SCEVs refering to the old loop.
1142 for (BasicBlock *BB : SeenBlocks) {
1143 Loop *L = LI.getLoopFor(BB);
Tobias Grosserbc29e0b2015-11-12 07:34:09 +00001144 if (L == nullptr || L->getHeader() != BB || !R->contains(L))
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001145 continue;
1146
1147 BasicBlock *BBCopy = BlockMap[BB];
1148 Value *NullVal = Builder.getInt32(0);
1149 PHINode *LoopPHI =
1150 PHINode::Create(Builder.getInt32Ty(), 2, "polly.subregion.iv");
1151 Instruction *LoopPHIInc = BinaryOperator::CreateAdd(
1152 LoopPHI, Builder.getInt32(1), "polly.subregion.iv.inc");
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001153 LoopPHI->insertBefore(&BBCopy->front());
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001154 LoopPHIInc->insertBefore(BBCopy->getTerminator());
1155
1156 for (auto *PredBB : make_range(pred_begin(BB), pred_end(BB))) {
1157 if (!R->contains(PredBB))
1158 continue;
1159 if (L->contains(PredBB))
1160 LoopPHI->addIncoming(LoopPHIInc, BlockMap[PredBB]);
1161 else
1162 LoopPHI->addIncoming(NullVal, BlockMap[PredBB]);
1163 }
1164
1165 for (auto *PredBBCopy : make_range(pred_begin(BBCopy), pred_end(BBCopy)))
1166 if (LoopPHI->getBasicBlockIndex(PredBBCopy) < 0)
1167 LoopPHI->addIncoming(NullVal, PredBBCopy);
1168
1169 LTS[L] = SE.getUnknown(LoopPHI);
1170 }
1171
Michael Kruse225f0d12015-10-17 21:36:00 +00001172 // Continue generating code in the exit block.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001173 Builder.SetInsertPoint(&*ExitBBCopy->getFirstInsertionPt());
Michael Kruse225f0d12015-10-17 21:36:00 +00001174
1175 // Write values visible to other statements.
1176 generateScalarStores(Stmt, LTS, ValueMap);
Tobias Grosser3e956022015-10-26 20:41:53 +00001177 BlockMap.clear();
1178 RegionMaps.clear();
1179 IncompletePHINodeMap.clear();
Johannes Doerfert275a1752015-02-24 16:16:32 +00001180}
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001181
Michael Kruse225f0d12015-10-17 21:36:00 +00001182void RegionGenerator::generateScalarStores(ScopStmt &Stmt, LoopToScevMapT &LTS,
Tobias Grosserbc132602015-09-05 09:56:54 +00001183 ValueMapT &BBMap) {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001184 const Region &R = Stmt.getParent()->getRegion();
1185
Tobias Grosser75296902015-08-21 19:23:21 +00001186 assert(Stmt.getRegion() &&
1187 "Block statements need to use the generateScalarStores() "
1188 "function in the BlockGenerator");
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001189
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001190 for (MemoryAccess *MA : Stmt) {
Michael Kruse8d0b7342015-09-25 21:21:00 +00001191 if (MA->isExplicit() || MA->isRead())
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001192 continue;
1193
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001194 Instruction *ScalarInst = MA->getAccessInstruction();
Johannes Doerfertd86f2152015-08-17 10:58:17 +00001195 Value *Val = MA->getAccessValue();
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001196
Michael Kruse225f0d12015-10-17 21:36:00 +00001197 // In case we add the store into an exiting block, we need to restore the
1198 // position for stores in the exit node.
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001199 BasicBlock *SavedInsertBB = Builder.GetInsertBlock();
Michael Kruse225f0d12015-10-17 21:36:00 +00001200 auto SavedInsertionPoint = Builder.GetInsertPoint();
Michael Kruse27149cf2015-11-05 16:17:17 +00001201 ValueMapT *LocalBBMap = &BBMap;
Michael Kruse225f0d12015-10-17 21:36:00 +00001202
1203 // Implicit writes induced by PHIs must be written in the incoming blocks.
1204 if (isa<TerminatorInst>(ScalarInst)) {
1205 BasicBlock *ExitingBB = ScalarInst->getParent();
1206 BasicBlock *ExitingBBCopy = BlockMap[ExitingBB];
1207 Builder.SetInsertPoint(ExitingBBCopy->getTerminator());
Michael Kruse27149cf2015-11-05 16:17:17 +00001208
1209 // For the incoming blocks, use the block's BBMap instead of the one for
1210 // the entire region.
1211 LocalBBMap = &RegionMaps[ExitingBBCopy];
Michael Kruse225f0d12015-10-17 21:36:00 +00001212 }
1213
Tobias Grosserbc132602015-09-05 09:56:54 +00001214 auto Address = getOrCreateAlloca(*MA);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001215
Michael Kruse27149cf2015-11-05 16:17:17 +00001216 Val = getNewScalarValue(Val, R, Stmt, LTS, *LocalBBMap);
Tobias Grosserf8d55f72015-08-29 18:12:03 +00001217 Builder.CreateStore(Val, Address);
Michael Kruse225f0d12015-10-17 21:36:00 +00001218
1219 // Restore the insertion point if necessary.
1220 if (isa<TerminatorInst>(ScalarInst))
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001221 Builder.SetInsertPoint(SavedInsertBB, SavedInsertionPoint);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001222 }
1223}
1224
1225void RegionGenerator::addOperandToPHI(ScopStmt &Stmt, const PHINode *PHI,
1226 PHINode *PHICopy, BasicBlock *IncomingBB,
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001227 LoopToScevMapT &LTS) {
1228 Region *StmtR = Stmt.getRegion();
1229
1230 // If the incoming block was not yet copied mark this PHI as incomplete.
1231 // Once the block will be copied the incoming value will be added.
1232 BasicBlock *BBCopy = BlockMap[IncomingBB];
1233 if (!BBCopy) {
1234 assert(StmtR->contains(IncomingBB) &&
1235 "Bad incoming block for PHI in non-affine region");
1236 IncompletePHINodeMap[IncomingBB].push_back(std::make_pair(PHI, PHICopy));
1237 return;
1238 }
1239
1240 Value *OpCopy = nullptr;
1241 if (StmtR->contains(IncomingBB)) {
1242 assert(RegionMaps.count(BBCopy) &&
1243 "Incoming PHI block did not have a BBMap");
1244 ValueMapT &BBCopyMap = RegionMaps[BBCopy];
1245
1246 Value *Op = PHI->getIncomingValueForBlock(IncomingBB);
Michael Krusedc122222015-10-19 09:19:25 +00001247
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001248 BasicBlock *OldBlock = Builder.GetInsertBlock();
Michael Krusedc122222015-10-19 09:19:25 +00001249 auto OldIP = Builder.GetInsertPoint();
1250 Builder.SetInsertPoint(BBCopy->getTerminator());
Tobias Grosserbc132602015-09-05 09:56:54 +00001251 OpCopy = getNewValue(Stmt, Op, BBCopyMap, LTS, getLoopForInst(PHI));
Duncan P. N. Exon Smithb8f58b52015-11-06 22:56:54 +00001252 Builder.SetInsertPoint(OldBlock, OldIP);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001253 } else {
1254
1255 if (PHICopy->getBasicBlockIndex(BBCopy) >= 0)
1256 return;
1257
Tobias Grosserbc132602015-09-05 09:56:54 +00001258 Value *PHIOpAddr = getOrCreatePHIAlloca(const_cast<PHINode *>(PHI));
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001259 OpCopy = new LoadInst(PHIOpAddr, PHIOpAddr->getName() + ".reload",
1260 BlockMap[IncomingBB]->getTerminator());
1261 }
1262
1263 assert(OpCopy && "Incoming PHI value was not copied properly");
1264 assert(BBCopy && "Incoming PHI block was not copied properly");
1265 PHICopy->addIncoming(OpCopy, BBCopy);
1266}
1267
Tobias Grosser2f1acac2015-10-04 10:18:45 +00001268Value *RegionGenerator::copyPHIInstruction(ScopStmt &Stmt, PHINode *PHI,
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001269 ValueMapT &BBMap,
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001270 LoopToScevMapT &LTS) {
1271 unsigned NumIncoming = PHI->getNumIncomingValues();
1272 PHINode *PHICopy =
1273 Builder.CreatePHI(PHI->getType(), NumIncoming, "polly." + PHI->getName());
1274 PHICopy->moveBefore(PHICopy->getParent()->getFirstNonPHI());
1275 BBMap[PHI] = PHICopy;
1276
1277 for (unsigned u = 0; u < NumIncoming; u++)
Tobias Grosserbc132602015-09-05 09:56:54 +00001278 addOperandToPHI(Stmt, PHI, PHICopy, PHI->getIncomingBlock(u), LTS);
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001279 return PHICopy;
1280}