blob: 6642e692f50c9500cfbb827668a346240d5efbbd [file] [log] [blame]
Tobias Grosser75805372011-04-29 06:27:02 +00001//===----- ScopDetection.cpp - Detect Scops --------------------*- 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// Detect the maximal Scops of a function.
11//
12// A static control part (Scop) is a subgraph of the control flow graph (CFG)
13// that only has statically known control flow and can therefore be described
14// within the polyhedral model.
15//
16// Every Scop fullfills these restrictions:
17//
18// * It is a single entry single exit region
19//
20// * Only affine linear bounds in the loops
21//
22// Every natural loop in a Scop must have a number of loop iterations that can
23// be described as an affine linear function in surrounding loop iterators or
24// parameters. (A parameter is a scalar that does not change its value during
25// execution of the Scop).
26//
27// * Only comparisons of affine linear expressions in conditions
28//
29// * All loops and conditions perfectly nested
30//
31// The control flow needs to be structured such that it could be written using
32// just 'for' and 'if' statements, without the need for any 'goto', 'break' or
33// 'continue'.
34//
35// * Side effect free functions call
36//
37// Only function calls and intrinsics that do not have side effects are allowed
38// (readnone).
39//
40// The Scop detection finds the largest Scops by checking if the largest
41// region is a Scop. If this is not the case, its canonical subregions are
42// checked until a region is a Scop. It is now tried to extend this Scop by
43// creating a larger non canonical region.
44//
45//===----------------------------------------------------------------------===//
46
Tobias Grosserecfe21b2013-03-20 18:03:18 +000047#include "polly/CodeGen/BlockGenerators.h"
Tobias Grosser75805372011-04-29 06:27:02 +000048#include "polly/LinkAllPasses.h"
Tobias Grosser637bd632013-05-07 07:31:10 +000049#include "polly/Options.h"
Tobias Grosserecfe21b2013-03-20 18:03:18 +000050#include "polly/ScopDetection.h"
Tobias Grosser120db6b2011-11-07 12:58:54 +000051#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000052#include "polly/Support/ScopHelper.h"
Tobias Grosser75805372011-04-29 06:27:02 +000053#include "llvm/ADT/Statistic.h"
54#include "llvm/Analysis/AliasAnalysis.h"
Tobias Grosser6e9f25a2011-11-09 22:35:00 +000055#include "llvm/Analysis/LoopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000056#include "llvm/Analysis/RegionIterator.h"
Tobias Grosser6e9f25a2011-11-09 22:35:00 +000057#include "llvm/Analysis/ScalarEvolution.h"
Tobias Grosserb8710b52011-11-10 12:44:50 +000058#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Tobias Grosser75805372011-04-29 06:27:02 +000059#include "llvm/Assembly/Writer.h"
Tobias Grosser83628182013-05-07 08:11:54 +000060#include "llvm/DebugInfo.h"
61#include "llvm/IR/LLVMContext.h"
Tobias Grosser75805372011-04-29 06:27:02 +000062
63#define DEBUG_TYPE "polly-detect"
64#include "llvm/Support/Debug.h"
65
Tobias Grosser60b54f12011-11-08 15:41:28 +000066#include <set>
67
Tobias Grosser75805372011-04-29 06:27:02 +000068using namespace llvm;
69using namespace polly;
70
Sebastian Pop8fe6d112013-05-30 17:47:32 +000071static cl::opt<bool>
72DetectScopsWithoutLoops("polly-detect-scops-in-functions-without-loops",
73 cl::desc("Detect scops in functions without loops"),
74 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
75
Sebastian Pop2c9ec2e2013-06-03 16:35:37 +000076static cl::opt<bool>
77DetectRegionsWithoutLoops("polly-detect-scops-in-regions-without-loops",
78 cl::desc("Detect scops in regions without loops"),
79 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
80
Tobias Grosser2ff87232011-10-23 11:17:06 +000081static cl::opt<std::string>
Tobias Grosser637bd632013-05-07 07:31:10 +000082OnlyFunction("polly-only-func", cl::desc("Only run on a single function"),
83 cl::value_desc("function-name"), cl::ValueRequired, cl::init(""),
84 cl::cat(PollyCategory));
Tobias Grosser2ff87232011-10-23 11:17:06 +000085
Tobias Grosser60cd9322011-11-10 12:47:26 +000086static cl::opt<bool>
87IgnoreAliasing("polly-ignore-aliasing",
88 cl::desc("Ignore possible aliasing of the array bases"),
Tobias Grosser637bd632013-05-07 07:31:10 +000089 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grosser2ff87232011-10-23 11:17:06 +000090
Tobias Grosser637bd632013-05-07 07:31:10 +000091static cl::opt<bool>
92ReportLevel("polly-report",
93 cl::desc("Print information about the activities of Polly"),
94 cl::init(false), cl::cat(PollyCategory));
Tobias Grosser531891e2012-11-01 16:45:20 +000095
96static cl::opt<bool>
Tobias Grossera1879642011-12-20 10:43:14 +000097AllowNonAffine("polly-allow-nonaffine",
98 cl::desc("Allow non affine access functions in arrays"),
Tobias Grosser637bd632013-05-07 07:31:10 +000099 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grossera1879642011-12-20 10:43:14 +0000100
Tobias Grosser75805372011-04-29 06:27:02 +0000101//===----------------------------------------------------------------------===//
102// Statistics.
103
104STATISTIC(ValidRegion, "Number of regions that a valid part of Scop");
105
Tobias Grosser74394f02013-01-14 22:40:23 +0000106#define BADSCOP_STAT(NAME, DESC) \
107 STATISTIC(Bad##NAME##ForScop, "Number of bad regions for Scop: " DESC)
Tobias Grosser75805372011-04-29 06:27:02 +0000108
Tobias Grosser74394f02013-01-14 22:40:23 +0000109#define INVALID(NAME, MESSAGE) \
110 do { \
111 std::string Buf; \
112 raw_string_ostream fmt(Buf); \
113 fmt << MESSAGE; \
114 fmt.flush(); \
115 LastFailure = Buf; \
116 DEBUG(dbgs() << MESSAGE); \
117 DEBUG(dbgs() << "\n"); \
118 assert(!Context.Verifying && #NAME); \
119 if (!Context.Verifying) \
120 ++Bad##NAME##ForScop; \
121 return false; \
Tobias Grosser84b81de2013-03-19 21:44:07 +0000122 } while (0)
Tobias Grosserfff5adc2011-11-10 13:21:43 +0000123
Tobias Grosser74394f02013-01-14 22:40:23 +0000124#define INVALID_NOVERIFY(NAME, MESSAGE) \
125 do { \
126 std::string Buf; \
127 raw_string_ostream fmt(Buf); \
128 fmt << MESSAGE; \
129 fmt.flush(); \
130 LastFailure = Buf; \
131 DEBUG(dbgs() << MESSAGE); \
132 DEBUG(dbgs() << "\n"); \
133 /* DISABLED: assert(!Context.Verifying && #NAME); */ \
134 if (!Context.Verifying) \
135 ++Bad##NAME##ForScop; \
136 return false; \
Tobias Grosser84b81de2013-03-19 21:44:07 +0000137 } while (0)
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000138
Tobias Grosser74394f02013-01-14 22:40:23 +0000139BADSCOP_STAT(CFG, "CFG too complex");
140BADSCOP_STAT(IndVar, "Non canonical induction variable in loop");
Sebastian Pop9d632342013-06-11 22:20:40 +0000141BADSCOP_STAT(IndEdge, "Found invalid region entering edges");
Tobias Grosser74394f02013-01-14 22:40:23 +0000142BADSCOP_STAT(LoopBound, "Loop bounds can not be computed");
143BADSCOP_STAT(FuncCall, "Function call with side effects appeared");
144BADSCOP_STAT(AffFunc, "Expression not affine");
Tobias Grosser74394f02013-01-14 22:40:23 +0000145BADSCOP_STAT(Alias, "Found base address alias");
Tobias Grosser8edce4e2013-04-16 08:04:42 +0000146BADSCOP_STAT(SimpleLoop, "Loop not in -loop-simplify form");
Tobias Grosser74394f02013-01-14 22:40:23 +0000147BADSCOP_STAT(Other, "Others");
Tobias Grosser75805372011-04-29 06:27:02 +0000148
149//===----------------------------------------------------------------------===//
150// ScopDetection.
Tobias Grosser75805372011-04-29 06:27:02 +0000151bool ScopDetection::isMaxRegionInScop(const Region &R) const {
152 // The Region is valid only if it could be found in the set.
153 return ValidRegions.count(&R);
154}
155
Tobias Grosser4f129a62011-10-08 00:30:55 +0000156std::string ScopDetection::regionIsInvalidBecause(const Region *R) const {
157 if (!InvalidRegions.count(R))
158 return "";
159
160 return InvalidRegions.find(R)->second;
161}
162
Tobias Grossere602a072013-05-07 07:30:56 +0000163bool ScopDetection::isValidCFG(BasicBlock &BB,
164 DetectionContext &Context) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000165 Region &RefRegion = Context.CurRegion;
166 TerminatorInst *TI = BB.getTerminator();
167
168 // Return instructions are only valid if the region is the top level region.
169 if (isa<ReturnInst>(TI) && !RefRegion.getExit() && TI->getNumOperands() == 0)
170 return true;
171
172 BranchInst *Br = dyn_cast<BranchInst>(TI);
173
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000174 if (!Br)
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000175 INVALID(CFG, "Non branch instruction terminates BB: " + BB.getName());
Tobias Grosser75805372011-04-29 06:27:02 +0000176
Tobias Grosser74394f02013-01-14 22:40:23 +0000177 if (Br->isUnconditional())
178 return true;
Tobias Grosser75805372011-04-29 06:27:02 +0000179
180 Value *Condition = Br->getCondition();
181
182 // UndefValue is not allowed as condition.
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000183 if (isa<UndefValue>(Condition))
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000184 INVALID(AffFunc, "Condition based on 'undef' value in BB: " + BB.getName());
Tobias Grosser75805372011-04-29 06:27:02 +0000185
186 // Only Constant and ICmpInst are allowed as condition.
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000187 if (!(isa<Constant>(Condition) || isa<ICmpInst>(Condition)))
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000188 INVALID(AffFunc, "Condition in BB '" + BB.getName() +
Tobias Grosserd7e58642013-04-10 06:55:45 +0000189 "' neither constant nor an icmp instruction");
Tobias Grosser75805372011-04-29 06:27:02 +0000190
191 // Allow perfectly nested conditions.
192 assert(Br->getNumSuccessors() == 2 && "Unexpected number of successors");
193
194 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(Condition)) {
195 // Unsigned comparisons are not allowed. They trigger overflow problems
196 // in the code generation.
197 //
198 // TODO: This is not sufficient and just hides bugs. However it does pretty
199 // well.
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000200 if (ICmp->isUnsigned())
Tobias Grosser75805372011-04-29 06:27:02 +0000201 return false;
202
203 // Are both operands of the ICmp affine?
Tobias Grosser74394f02013-01-14 22:40:23 +0000204 if (isa<UndefValue>(ICmp->getOperand(0)) ||
205 isa<UndefValue>(ICmp->getOperand(1)))
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000206 INVALID(AffFunc, "undef operand in branch at BB: " + BB.getName());
Tobias Grosser75805372011-04-29 06:27:02 +0000207
Sebastian Pop9f57c5b2013-04-10 04:05:18 +0000208 Loop *L = LI->getLoopFor(ICmp->getParent());
209 const SCEV *LHS = SE->getSCEVAtScope(ICmp->getOperand(0), L);
210 const SCEV *RHS = SE->getSCEVAtScope(ICmp->getOperand(1), L);
Tobias Grosser75805372011-04-29 06:27:02 +0000211
Tobias Grossera66fa6c2011-11-10 12:45:11 +0000212 if (!isAffineExpr(&Context.CurRegion, LHS, *SE) ||
213 !isAffineExpr(&Context.CurRegion, RHS, *SE))
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000214 INVALID(AffFunc, "Non affine branch in BB '" << BB.getName()
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000215 << "' with LHS: " << *LHS
216 << " and RHS: " << *RHS);
Tobias Grosser75805372011-04-29 06:27:02 +0000217 }
218
219 // Allow loop exit conditions.
220 Loop *L = LI->getLoopFor(&BB);
221 if (L && L->getExitingBlock() == &BB)
222 return true;
223
224 // Allow perfectly nested conditions.
225 Region *R = RI->getRegionFor(&BB);
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000226 if (R->getEntry() != &BB)
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000227 INVALID(CFG, "Not well structured condition at BB: " + BB.getName());
Tobias Grosser75805372011-04-29 06:27:02 +0000228
229 return true;
230}
231
232bool ScopDetection::isValidCallInst(CallInst &CI) {
233 if (CI.mayHaveSideEffects() || CI.doesNotReturn())
234 return false;
235
236 if (CI.doesNotAccessMemory())
237 return true;
238
239 Function *CalledFunction = CI.getCalledFunction();
240
241 // Indirect calls are not supported.
242 if (CalledFunction == 0)
243 return false;
244
245 // TODO: Intrinsics.
246 return false;
247}
248
249bool ScopDetection::isValidMemoryAccess(Instruction &Inst,
250 DetectionContext &Context) const {
Tobias Grossere5e171e2011-11-10 12:45:03 +0000251 Value *Ptr = getPointerOperand(Inst);
Sebastian Pop9f57c5b2013-04-10 04:05:18 +0000252 Loop *L = LI->getLoopFor(Inst.getParent());
253 const SCEV *AccessFunction = SE->getSCEVAtScope(Ptr, L);
Tobias Grosserb8710b52011-11-10 12:44:50 +0000254 const SCEVUnknown *BasePointer;
Tobias Grossere5e171e2011-11-10 12:45:03 +0000255 Value *BaseValue;
Tobias Grosser75805372011-04-29 06:27:02 +0000256
Tobias Grosserb8710b52011-11-10 12:44:50 +0000257 BasePointer = dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
258
259 if (!BasePointer)
260 INVALID(AffFunc, "No base pointer");
261
262 BaseValue = BasePointer->getValue();
263
264 if (isa<UndefValue>(BaseValue))
265 INVALID(AffFunc, "Undefined base pointer");
266
267 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
268
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000269 if (!isAffineExpr(&Context.CurRegion, AccessFunction, *SE, BaseValue) &&
270 !AllowNonAffine)
Tobias Grossereeb776a2012-09-08 14:00:37 +0000271 INVALID(AffFunc, "Non affine access function: " << *AccessFunction);
Tobias Grosser75805372011-04-29 06:27:02 +0000272
273 // FIXME: Alias Analysis thinks IntToPtrInst aliases with alloca instructions
274 // created by IndependentBlocks Pass.
Tobias Grossere5e171e2011-11-10 12:45:03 +0000275 if (isa<IntToPtrInst>(BaseValue))
276 INVALID(Other, "Find bad intToptr prt: " << *BaseValue);
Tobias Grosser75805372011-04-29 06:27:02 +0000277
Sebastian Popb35892b2013-06-03 16:35:41 +0000278 if (!IgnoreAliasing) {
279 // Check if the base pointer of the memory access does alias with
280 // any other pointer. This cannot be handled at the moment.
281 AliasSet &AS =
282 Context.AST.getAliasSetForPointer(BaseValue, AliasAnalysis::UnknownSize,
283 Inst.getMetadata(LLVMContext::MD_tbaa));
Tobias Grosserfff5adc2011-11-10 13:21:43 +0000284
Sebastian Popb35892b2013-06-03 16:35:41 +0000285 // INVALID triggers an assertion in verifying mode, if it detects that a SCoP
286 // was detected by SCoP detection and that this SCoP was invalidated by a pass
287 // that stated it would preserve the SCoPs.
288 // We disable this check as the independent blocks pass may create memory
289 // references which seem to alias, if -basicaa is not available. They actually
290 // do not, but as we can not proof this without -basicaa we would fail. We
291 // disable this check to not cause irrelevant verification failures.
292 if (!AS.isMustAlias()) {
293 std::string Message;
294 raw_string_ostream OS(Message);
Tobias Grosser428b3e42013-02-04 15:46:25 +0000295
Sebastian Popb35892b2013-06-03 16:35:41 +0000296 OS << "Possible aliasing: ";
Tobias Grosser428b3e42013-02-04 15:46:25 +0000297
Sebastian Popb35892b2013-06-03 16:35:41 +0000298 std::vector<Value *> Pointers;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000299
Sebastian Popb35892b2013-06-03 16:35:41 +0000300 for (AliasSet::iterator AI = AS.begin(), AE = AS.end(); AI != AE; ++AI)
301 Pointers.push_back(AI.getPointer());
Tobias Grosser428b3e42013-02-04 15:46:25 +0000302
Sebastian Popb35892b2013-06-03 16:35:41 +0000303 std::sort(Pointers.begin(), Pointers.end());
Tobias Grosser428b3e42013-02-04 15:46:25 +0000304
Sebastian Popb35892b2013-06-03 16:35:41 +0000305 for (std::vector<Value *>::iterator PI = Pointers.begin(),
306 PE = Pointers.end(); ;) {
307 Value *V = *PI;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000308
Sebastian Popb35892b2013-06-03 16:35:41 +0000309 if (V->getName().size() == 0)
310 OS << "\"" << *V << "\"";
311 else
312 OS << "\"" << V->getName() << "\"";
Tobias Grosser428b3e42013-02-04 15:46:25 +0000313
Sebastian Popb35892b2013-06-03 16:35:41 +0000314 ++PI;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000315
Sebastian Popb35892b2013-06-03 16:35:41 +0000316 if (PI != PE)
317 OS << ", ";
318 else
319 break;
320 }
321
322 INVALID_NOVERIFY(Alias, OS.str());
Tobias Grosser428b3e42013-02-04 15:46:25 +0000323 }
Tobias Grosser428b3e42013-02-04 15:46:25 +0000324 }
Tobias Grosser75805372011-04-29 06:27:02 +0000325
326 return true;
327}
328
Tobias Grosser75805372011-04-29 06:27:02 +0000329bool ScopDetection::isValidInstruction(Instruction &Inst,
330 DetectionContext &Context) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000331 if (PHINode *PN = dyn_cast<PHINode>(&Inst))
Tobias Grosserecfe21b2013-03-20 18:03:18 +0000332 if (!canSynthesize(PN, LI, SE, &Context.CurRegion)) {
333 if (SCEVCodegen)
334 INVALID(IndVar,
335 "SCEV of PHI node refers to SSA names in region: " << Inst);
336 else
337 INVALID(IndVar, "Non canonical PHI node: " << Inst);
338 }
Tobias Grosser75805372011-04-29 06:27:02 +0000339
Tobias Grosser75805372011-04-29 06:27:02 +0000340 // We only check the call instruction but not invoke instruction.
341 if (CallInst *CI = dyn_cast<CallInst>(&Inst)) {
342 if (isValidCallInst(*CI))
343 return true;
344
Tobias Grosserb43ba822011-10-08 00:49:30 +0000345 INVALID(FuncCall, "Call instruction: " << Inst);
Tobias Grosser75805372011-04-29 06:27:02 +0000346 }
347
348 if (!Inst.mayWriteToMemory() && !Inst.mayReadFromMemory()) {
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000349 if (isa<AllocaInst>(Inst))
Tobias Grosserb43ba822011-10-08 00:49:30 +0000350 INVALID(Other, "Alloca instruction: " << Inst);
Tobias Grosser75805372011-04-29 06:27:02 +0000351
352 return true;
353 }
354
355 // Check the access function.
356 if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
357 return isValidMemoryAccess(Inst, Context);
358
359 // We do not know this instruction, therefore we assume it is invalid.
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000360 INVALID(Other, "Unknown instruction: " << Inst);
Tobias Grosser75805372011-04-29 06:27:02 +0000361}
362
363bool ScopDetection::isValidBasicBlock(BasicBlock &BB,
364 DetectionContext &Context) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000365 // Check all instructions, except the terminator instruction.
366 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
367 if (!isValidInstruction(*I, Context))
368 return false;
369
Tobias Grosser75805372011-04-29 06:27:02 +0000370 return true;
371}
372
373bool ScopDetection::isValidLoop(Loop *L, DetectionContext &Context) const {
Tobias Grosser826b2af2013-03-21 16:14:50 +0000374 if (!SCEVCodegen) {
375 // If code generation is not in scev based mode, we need to ensure that
376 // each loop has a canonical induction variable.
377 PHINode *IndVar = L->getCanonicalInductionVariable();
378 if (!IndVar)
379 INVALID(IndVar,
380 "No canonical IV at loop header: " << L->getHeader()->getName());
381 }
Tobias Grosser75805372011-04-29 06:27:02 +0000382
383 // Is the loop count affine?
384 const SCEV *LoopCount = SE->getBackedgeTakenCount(L);
Tobias Grosser120db6b2011-11-07 12:58:54 +0000385 if (!isAffineExpr(&Context.CurRegion, LoopCount, *SE))
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000386 INVALID(LoopBound,
387 "Non affine loop bound '"
Tobias Grosserd7e58642013-04-10 06:55:45 +0000388 << *LoopCount << "' in loop: " << L->getHeader()->getName());
Tobias Grosser75805372011-04-29 06:27:02 +0000389
390 return true;
391}
392
393Region *ScopDetection::expandRegion(Region &R) {
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000394 // Initial no valid region was found (greater than R)
395 Region *LastValidRegion = NULL;
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000396 Region *ExpandedRegion = R.getExpandedRegion();
Tobias Grosser75805372011-04-29 06:27:02 +0000397
398 DEBUG(dbgs() << "\tExpanding " << R.getNameStr() << "\n");
399
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000400 while (ExpandedRegion) {
401 DetectionContext Context(*ExpandedRegion, *AA, false /* verifying */);
402 DEBUG(dbgs() << "\t\tTrying " << ExpandedRegion->getNameStr() << "\n");
Tobias Grosser75805372011-04-29 06:27:02 +0000403
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000404 // Check the exit first (cheap)
Tobias Grosser75805372011-04-29 06:27:02 +0000405 if (isValidExit(Context)) {
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000406 // If the exit is valid check all blocks
407 // - if true, a valid region was found => store it + keep expanding
408 // - if false, .tbd. => stop (should this really end the loop?)
409 if (!allBlocksValid(Context))
410 break;
Tobias Grosser75805372011-04-29 06:27:02 +0000411
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000412 // Delete unnecessary regions (allocated by getExpandedRegion)
413 if (LastValidRegion)
414 delete LastValidRegion;
415
Tobias Grosserd7e58642013-04-10 06:55:45 +0000416 // Store this region, because it is the greatest valid (encountered so
417 // far).
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000418 LastValidRegion = ExpandedRegion;
419
420 // Create and test the next greater region (if any)
421 ExpandedRegion = ExpandedRegion->getExpandedRegion();
422
423 } else {
424 // Create and test the next greater region (if any)
425 Region *TmpRegion = ExpandedRegion->getExpandedRegion();
426
427 // Delete unnecessary regions (allocated by getExpandedRegion)
428 delete ExpandedRegion;
429
430 ExpandedRegion = TmpRegion;
Tobias Grosser75805372011-04-29 06:27:02 +0000431 }
Tobias Grosser75805372011-04-29 06:27:02 +0000432 }
433
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000434 DEBUG(if (LastValidRegion)
Tobias Grosserd7e58642013-04-10 06:55:45 +0000435 dbgs() << "\tto " << LastValidRegion->getNameStr() << "\n";
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000436 else dbgs() << "\tExpanding " << R.getNameStr() << " failed\n";);
Tobias Grosser75805372011-04-29 06:27:02 +0000437
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000438 return LastValidRegion;
Tobias Grosser75805372011-04-29 06:27:02 +0000439}
Sebastian Pop2c9ec2e2013-06-03 16:35:37 +0000440static bool regionWithoutLoops(Region &R, LoopInfo *LI) {
441 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
442 ++I)
443 if (R.contains(LI->getLoopFor(*I)))
444 return false;
445
446 return true;
447}
Tobias Grosser75805372011-04-29 06:27:02 +0000448
Tobias Grosser75805372011-04-29 06:27:02 +0000449void ScopDetection::findScops(Region &R) {
Sebastian Pop2c9ec2e2013-06-03 16:35:37 +0000450
451 if (!DetectRegionsWithoutLoops && regionWithoutLoops(R, LI))
452 return;
453
Tobias Grosser75805372011-04-29 06:27:02 +0000454 DetectionContext Context(R, *AA, false /*verifying*/);
455
Tobias Grosser4eb73812011-11-10 12:45:15 +0000456 LastFailure = "";
457
Tobias Grosser75805372011-04-29 06:27:02 +0000458 if (isValidRegion(Context)) {
459 ++ValidRegion;
460 ValidRegions.insert(&R);
461 return;
462 }
463
Tobias Grosser4f129a62011-10-08 00:30:55 +0000464 InvalidRegions[&R] = LastFailure;
465
Tobias Grosser75805372011-04-29 06:27:02 +0000466 for (Region::iterator I = R.begin(), E = R.end(); I != E; ++I)
467 findScops(**I);
468
469 // Try to expand regions.
470 //
471 // As the region tree normally only contains canonical regions, non canonical
472 // regions that form a Scop are not found. Therefore, those non canonical
473 // regions are checked by expanding the canonical ones.
474
Tobias Grosser0d1eee32013-02-05 11:56:05 +0000475 std::vector<Region *> ToExpand;
Tobias Grosser75805372011-04-29 06:27:02 +0000476
477 for (Region::iterator I = R.begin(), E = R.end(); I != E; ++I)
478 ToExpand.push_back(*I);
479
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000480 for (std::vector<Region *>::iterator RI = ToExpand.begin(),
481 RE = ToExpand.end();
482 RI != RE; ++RI) {
Tobias Grosser75805372011-04-29 06:27:02 +0000483 Region *CurrentRegion = *RI;
484
485 // Skip invalid regions. Regions may become invalid, if they are element of
486 // an already expanded region.
487 if (ValidRegions.find(CurrentRegion) == ValidRegions.end())
488 continue;
489
490 Region *ExpandedR = expandRegion(*CurrentRegion);
491
492 if (!ExpandedR)
493 continue;
494
495 R.addSubRegion(ExpandedR, true);
496 ValidRegions.insert(ExpandedR);
497 ValidRegions.erase(CurrentRegion);
498
499 for (Region::iterator I = ExpandedR->begin(), E = ExpandedR->end(); I != E;
500 ++I)
501 ValidRegions.erase(*I);
502 }
503}
504
505bool ScopDetection::allBlocksValid(DetectionContext &Context) const {
506 Region &R = Context.CurRegion;
507
508 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
Sebastian Popb88ea5e2013-06-11 22:20:32 +0000509 ++I) {
510 Loop *L = LI->getLoopFor(*I);
511 if (L && L->getHeader() == *I && !isValidLoop(L, Context))
512 return false;
513 }
514
515 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
Tobias Grosser75805372011-04-29 06:27:02 +0000516 ++I)
Sebastian Pop9e3d2dd2013-06-11 22:20:27 +0000517 if (!isValidCFG(**I, Context))
518 return false;
519
520 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
521 ++I)
Chandler Carruth30dfdfc2012-05-04 21:24:27 +0000522 if (!isValidBasicBlock(**I, Context))
Tobias Grosser75805372011-04-29 06:27:02 +0000523 return false;
524
525 return true;
526}
527
528bool ScopDetection::isValidExit(DetectionContext &Context) const {
529 Region &R = Context.CurRegion;
530
531 // PHI nodes are not allowed in the exit basic block.
532 if (BasicBlock *Exit = R.getExit()) {
533 BasicBlock::iterator I = Exit->begin();
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000534 if (I != Exit->end() && isa<PHINode>(*I))
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000535 INVALID(Other, "PHI node in exit BB");
Tobias Grosser75805372011-04-29 06:27:02 +0000536 }
537
538 return true;
539}
540
541bool ScopDetection::isValidRegion(DetectionContext &Context) const {
542 Region &R = Context.CurRegion;
543
544 DEBUG(dbgs() << "Checking region: " << R.getNameStr() << "\n\t");
545
546 // The toplevel region is no valid region.
Tobias Grosseraeabcf22013-04-02 06:41:48 +0000547 if (R.isTopLevelRegion()) {
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000548 DEBUG(dbgs() << "Top level region is invalid"; dbgs() << "\n");
Tobias Grosser75805372011-04-29 06:27:02 +0000549 return false;
550 }
551
Tobias Grossere602a072013-05-07 07:30:56 +0000552 if (!R.getEnteringBlock()) {
Sebastian Pop9d632342013-06-11 22:20:40 +0000553 BasicBlock *entry = R.getEntry();
554 Loop *L = LI->getLoopFor(entry);
555
556 if (L) {
557 if (!L->isLoopSimplifyForm())
558 INVALID(SimpleLoop, "Loop not in simplify form is invalid!");
559
560 for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
561 ++PI) {
562 // Region entering edges come from the same loop but outside the region
563 // are not allowed.
564 if (L->contains(*PI) && !R.contains(*PI))
565 INVALID(IndEdge, "Region has invalid entering edges!");
566 }
567 }
Tobias Grosser8edce4e2013-04-16 08:04:42 +0000568 }
569
Tobias Grosserd654c252012-04-10 18:12:19 +0000570 // SCoP cannot contain the entry block of the function, because we need
Tobias Grosser75805372011-04-29 06:27:02 +0000571 // to insert alloca instruction there when translate scalar to array.
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000572 if (R.getEntry() == &(R.getEntry()->getParent()->getEntryBlock()))
573 INVALID(Other, "Region containing entry block of function is invalid!");
Tobias Grosser75805372011-04-29 06:27:02 +0000574
Hongbin Zheng94868e62012-04-07 12:29:17 +0000575 if (!isValidExit(Context))
Tobias Grosser75805372011-04-29 06:27:02 +0000576 return false;
577
Hongbin Zheng94868e62012-04-07 12:29:17 +0000578 if (!allBlocksValid(Context))
Tobias Grosser75805372011-04-29 06:27:02 +0000579 return false;
580
581 DEBUG(dbgs() << "OK\n");
582 return true;
583}
584
585bool ScopDetection::isValidFunction(llvm::Function &F) {
Hongbin Zheng94c5df12011-05-06 02:38:20 +0000586 return !InvalidFunctions.count(&F);
Tobias Grosser75805372011-04-29 06:27:02 +0000587}
588
Tobias Grosser531891e2012-11-01 16:45:20 +0000589void ScopDetection::getDebugLocation(const Region *R, unsigned &LineBegin,
590 unsigned &LineEnd, std::string &FileName) {
591 LineBegin = -1;
592 LineEnd = 0;
593
594 for (Region::const_block_iterator RI = R->block_begin(), RE = R->block_end();
595 RI != RE; ++RI)
596 for (BasicBlock::iterator BI = (*RI)->begin(), BE = (*RI)->end(); BI != BE;
597 ++BI) {
598 DebugLoc DL = BI->getDebugLoc();
599 if (DL.isUnknown())
600 continue;
601
602 DIScope Scope(DL.getScope(BI->getContext()));
603
604 if (FileName.empty())
605 FileName = Scope.getFilename();
606
607 unsigned NewLine = DL.getLine();
608
609 LineBegin = std::min(LineBegin, NewLine);
610 LineEnd = std::max(LineEnd, NewLine);
611 break;
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000612 }
Tobias Grosser531891e2012-11-01 16:45:20 +0000613}
614
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000615void ScopDetection::printLocations(llvm::Function &F) {
616 int NumberOfScops = std::distance(begin(), end());
617
618 if (NumberOfScops)
619 outs() << ":: Static control regions in " << F.getName() << "\n";
620
Tobias Grosser531891e2012-11-01 16:45:20 +0000621 for (iterator RI = begin(), RE = end(); RI != RE; ++RI) {
622 unsigned LineEntry, LineExit;
623 std::string FileName;
624
625 getDebugLocation(*RI, LineEntry, LineExit, FileName);
626
627 if (FileName.empty()) {
628 outs() << "Scop detected at unknown location. Compile with debug info "
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000629 "(-g) to get more precise information. \n";
Tobias Grosser531891e2012-11-01 16:45:20 +0000630 return;
631 }
632
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000633 outs() << FileName << ":" << LineEntry
634 << ": Start of static control region\n";
635 outs() << FileName << ":" << LineExit << ": End of static control region\n";
Tobias Grosser531891e2012-11-01 16:45:20 +0000636 }
637}
638
Tobias Grosser75805372011-04-29 06:27:02 +0000639bool ScopDetection::runOnFunction(llvm::Function &F) {
Sebastian Pop8fe6d112013-05-30 17:47:32 +0000640 LI = &getAnalysis<LoopInfo>();
641 if (!DetectScopsWithoutLoops && LI->empty())
642 return false;
643
Tobias Grosser75805372011-04-29 06:27:02 +0000644 AA = &getAnalysis<AliasAnalysis>();
645 SE = &getAnalysis<ScalarEvolution>();
Tobias Grosser75805372011-04-29 06:27:02 +0000646 RI = &getAnalysis<RegionInfo>();
647 Region *TopRegion = RI->getTopLevelRegion();
648
Tobias Grosser2ff87232011-10-23 11:17:06 +0000649 releaseMemory();
650
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000651 if (OnlyFunction != "" && F.getName() != OnlyFunction)
Tobias Grosser2ff87232011-10-23 11:17:06 +0000652 return false;
653
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000654 if (!isValidFunction(F))
Tobias Grosser75805372011-04-29 06:27:02 +0000655 return false;
656
657 findScops(*TopRegion);
Tobias Grosser531891e2012-11-01 16:45:20 +0000658
659 if (ReportLevel >= 1)
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000660 printLocations(F);
Tobias Grosser531891e2012-11-01 16:45:20 +0000661
Tobias Grosser75805372011-04-29 06:27:02 +0000662 return false;
663}
664
Tobias Grosser75805372011-04-29 06:27:02 +0000665void polly::ScopDetection::verifyRegion(const Region &R) const {
666 assert(isMaxRegionInScop(R) && "Expect R is a valid region.");
Tobias Grosser0d1eee32013-02-05 11:56:05 +0000667 DetectionContext Context(const_cast<Region &>(R), *AA, true /*verifying*/);
Tobias Grosser75805372011-04-29 06:27:02 +0000668 isValidRegion(Context);
669}
670
671void polly::ScopDetection::verifyAnalysis() const {
672 for (RegionSet::const_iterator I = ValidRegions.begin(),
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000673 E = ValidRegions.end();
674 I != E; ++I)
Tobias Grosser75805372011-04-29 06:27:02 +0000675 verifyRegion(**I);
676}
677
678void ScopDetection::getAnalysisUsage(AnalysisUsage &AU) const {
679 AU.addRequired<DominatorTree>();
680 AU.addRequired<PostDominatorTree>();
681 AU.addRequired<LoopInfo>();
682 AU.addRequired<ScalarEvolution>();
683 // We also need AA and RegionInfo when we are verifying analysis.
684 AU.addRequiredTransitive<AliasAnalysis>();
685 AU.addRequiredTransitive<RegionInfo>();
686 AU.setPreservesAll();
687}
688
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000689void ScopDetection::print(raw_ostream &OS, const Module *) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000690 for (RegionSet::const_iterator I = ValidRegions.begin(),
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000691 E = ValidRegions.end();
692 I != E; ++I)
Tobias Grosser75805372011-04-29 06:27:02 +0000693 OS << "Valid Region for Scop: " << (*I)->getNameStr() << '\n';
694
695 OS << "\n";
696}
697
698void ScopDetection::releaseMemory() {
699 ValidRegions.clear();
Tobias Grosser4f129a62011-10-08 00:30:55 +0000700 InvalidRegions.clear();
Hongbin Zheng94c5df12011-05-06 02:38:20 +0000701 // Do not clear the invalid function set.
Tobias Grosser75805372011-04-29 06:27:02 +0000702}
703
704char ScopDetection::ID = 0;
705
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000706Pass *polly::createScopDetectionPass() { return new ScopDetection(); }
707
Tobias Grosser73600b82011-10-08 00:30:40 +0000708INITIALIZE_PASS_BEGIN(ScopDetection, "polly-detect",
709 "Polly - Detect static control parts (SCoPs)", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000710 false);
711INITIALIZE_AG_DEPENDENCY(AliasAnalysis);
712INITIALIZE_PASS_DEPENDENCY(DominatorTree);
713INITIALIZE_PASS_DEPENDENCY(LoopInfo);
714INITIALIZE_PASS_DEPENDENCY(PostDominatorTree);
715INITIALIZE_PASS_DEPENDENCY(RegionInfo);
716INITIALIZE_PASS_DEPENDENCY(ScalarEvolution);
Tobias Grosser73600b82011-10-08 00:30:40 +0000717INITIALIZE_PASS_END(ScopDetection, "polly-detect",
718 "Polly - Detect static control parts (SCoPs)", false, false)