blob: 9b2a9a8ce573f4210bc52b43eb647654d5b57b5a [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"); \
Tobias Grosser58032cb2013-06-23 01:29:29 +0000118 assert(!Context.Verifying &&#NAME); \
Tobias Grosser74394f02013-01-14 22:40:23 +0000119 if (!Context.Verifying) \
120 ++Bad##NAME##ForScop; \
Tobias Grosser84b81de2013-03-19 21:44:07 +0000121 } while (0)
Tobias Grosserfff5adc2011-11-10 13:21:43 +0000122
Tobias Grosser74394f02013-01-14 22:40:23 +0000123#define INVALID_NOVERIFY(NAME, MESSAGE) \
124 do { \
125 std::string Buf; \
126 raw_string_ostream fmt(Buf); \
127 fmt << MESSAGE; \
128 fmt.flush(); \
129 LastFailure = Buf; \
130 DEBUG(dbgs() << MESSAGE); \
131 DEBUG(dbgs() << "\n"); \
132 /* DISABLED: assert(!Context.Verifying && #NAME); */ \
133 if (!Context.Verifying) \
134 ++Bad##NAME##ForScop; \
Tobias Grosser84b81de2013-03-19 21:44:07 +0000135 } while (0)
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000136
Tobias Grosser74394f02013-01-14 22:40:23 +0000137BADSCOP_STAT(CFG, "CFG too complex");
138BADSCOP_STAT(IndVar, "Non canonical induction variable in loop");
Sebastian Pop9d632342013-06-11 22:20:40 +0000139BADSCOP_STAT(IndEdge, "Found invalid region entering edges");
Tobias Grosser74394f02013-01-14 22:40:23 +0000140BADSCOP_STAT(LoopBound, "Loop bounds can not be computed");
141BADSCOP_STAT(FuncCall, "Function call with side effects appeared");
142BADSCOP_STAT(AffFunc, "Expression not affine");
Tobias Grosser74394f02013-01-14 22:40:23 +0000143BADSCOP_STAT(Alias, "Found base address alias");
Tobias Grosser8edce4e2013-04-16 08:04:42 +0000144BADSCOP_STAT(SimpleLoop, "Loop not in -loop-simplify form");
Tobias Grosser74394f02013-01-14 22:40:23 +0000145BADSCOP_STAT(Other, "Others");
Tobias Grosser75805372011-04-29 06:27:02 +0000146
147//===----------------------------------------------------------------------===//
148// ScopDetection.
Tobias Grosser75805372011-04-29 06:27:02 +0000149bool ScopDetection::isMaxRegionInScop(const Region &R) const {
150 // The Region is valid only if it could be found in the set.
151 return ValidRegions.count(&R);
152}
153
Tobias Grosser4f129a62011-10-08 00:30:55 +0000154std::string ScopDetection::regionIsInvalidBecause(const Region *R) const {
155 if (!InvalidRegions.count(R))
156 return "";
157
158 return InvalidRegions.find(R)->second;
159}
160
Tobias Grossere602a072013-05-07 07:30:56 +0000161bool ScopDetection::isValidCFG(BasicBlock &BB,
162 DetectionContext &Context) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000163 Region &RefRegion = Context.CurRegion;
164 TerminatorInst *TI = BB.getTerminator();
165
166 // Return instructions are only valid if the region is the top level region.
167 if (isa<ReturnInst>(TI) && !RefRegion.getExit() && TI->getNumOperands() == 0)
168 return true;
169
170 BranchInst *Br = dyn_cast<BranchInst>(TI);
171
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000172 if (!Br) {
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000173 INVALID(CFG, "Non branch instruction terminates BB: " + BB.getName());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000174 return false;
175 }
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 Grosser5b1a7f22013-07-22 03:50:33 +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 Grosser5b1a7f22013-07-22 03:50:33 +0000185 return false;
186 }
Tobias Grosser75805372011-04-29 06:27:02 +0000187
188 // Only Constant and ICmpInst are allowed as condition.
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000189 if (!(isa<Constant>(Condition) || isa<ICmpInst>(Condition))) {
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000190 INVALID(AffFunc, "Condition in BB '" + BB.getName() +
Tobias Grosserd7e58642013-04-10 06:55:45 +0000191 "' neither constant nor an icmp instruction");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000192 return false;
193 }
Tobias Grosser75805372011-04-29 06:27:02 +0000194
195 // Allow perfectly nested conditions.
196 assert(Br->getNumSuccessors() == 2 && "Unexpected number of successors");
197
198 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(Condition)) {
199 // Unsigned comparisons are not allowed. They trigger overflow problems
200 // in the code generation.
201 //
202 // TODO: This is not sufficient and just hides bugs. However it does pretty
203 // well.
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000204 if (ICmp->isUnsigned())
Tobias Grosser75805372011-04-29 06:27:02 +0000205 return false;
206
207 // Are both operands of the ICmp affine?
Tobias Grosser74394f02013-01-14 22:40:23 +0000208 if (isa<UndefValue>(ICmp->getOperand(0)) ||
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000209 isa<UndefValue>(ICmp->getOperand(1))) {
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000210 INVALID(AffFunc, "undef operand in branch at BB: " + BB.getName());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000211 return false;
212 }
Tobias Grosser75805372011-04-29 06:27:02 +0000213
Sebastian Pop9f57c5b2013-04-10 04:05:18 +0000214 Loop *L = LI->getLoopFor(ICmp->getParent());
215 const SCEV *LHS = SE->getSCEVAtScope(ICmp->getOperand(0), L);
216 const SCEV *RHS = SE->getSCEVAtScope(ICmp->getOperand(1), L);
Tobias Grosser75805372011-04-29 06:27:02 +0000217
Tobias Grossera66fa6c2011-11-10 12:45:11 +0000218 if (!isAffineExpr(&Context.CurRegion, LHS, *SE) ||
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000219 !isAffineExpr(&Context.CurRegion, RHS, *SE)) {
Tobias Grosser58032cb2013-06-23 01:29:29 +0000220 INVALID(AffFunc,
221 "Non affine branch in BB '" << BB.getName() << "' with LHS: "
222 << *LHS << " and RHS: " << *RHS);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000223 return false;
224 }
Tobias Grosser75805372011-04-29 06:27:02 +0000225 }
226
227 // Allow loop exit conditions.
228 Loop *L = LI->getLoopFor(&BB);
229 if (L && L->getExitingBlock() == &BB)
230 return true;
231
232 // Allow perfectly nested conditions.
233 Region *R = RI->getRegionFor(&BB);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000234 if (R->getEntry() != &BB) {
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000235 INVALID(CFG, "Not well structured condition at BB: " + BB.getName());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000236 return false;
237 }
Tobias Grosser75805372011-04-29 06:27:02 +0000238
239 return true;
240}
241
242bool ScopDetection::isValidCallInst(CallInst &CI) {
243 if (CI.mayHaveSideEffects() || CI.doesNotReturn())
244 return false;
245
246 if (CI.doesNotAccessMemory())
247 return true;
248
249 Function *CalledFunction = CI.getCalledFunction();
250
251 // Indirect calls are not supported.
252 if (CalledFunction == 0)
253 return false;
254
255 // TODO: Intrinsics.
256 return false;
257}
258
259bool ScopDetection::isValidMemoryAccess(Instruction &Inst,
260 DetectionContext &Context) const {
Tobias Grossere5e171e2011-11-10 12:45:03 +0000261 Value *Ptr = getPointerOperand(Inst);
Sebastian Pop9f57c5b2013-04-10 04:05:18 +0000262 Loop *L = LI->getLoopFor(Inst.getParent());
263 const SCEV *AccessFunction = SE->getSCEVAtScope(Ptr, L);
Tobias Grosserb8710b52011-11-10 12:44:50 +0000264 const SCEVUnknown *BasePointer;
Tobias Grossere5e171e2011-11-10 12:45:03 +0000265 Value *BaseValue;
Tobias Grosser75805372011-04-29 06:27:02 +0000266
Tobias Grosserb8710b52011-11-10 12:44:50 +0000267 BasePointer = dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
268
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000269 if (!BasePointer) {
Tobias Grosserb8710b52011-11-10 12:44:50 +0000270 INVALID(AffFunc, "No base pointer");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000271 return false;
272 }
Tobias Grosserb8710b52011-11-10 12:44:50 +0000273
274 BaseValue = BasePointer->getValue();
275
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000276 if (isa<UndefValue>(BaseValue)) {
Tobias Grosserb8710b52011-11-10 12:44:50 +0000277 INVALID(AffFunc, "Undefined base pointer");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000278 return false;
279 }
Tobias Grosserb8710b52011-11-10 12:44:50 +0000280
281 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
282
Tobias Grosser58032cb2013-06-23 01:29:29 +0000283 if (!AllowNonAffine &&
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000284 !isAffineExpr(&Context.CurRegion, AccessFunction, *SE, BaseValue)) {
Tobias Grossereeb776a2012-09-08 14:00:37 +0000285 INVALID(AffFunc, "Non affine access function: " << *AccessFunction);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000286 return false;
287 }
Tobias Grosser75805372011-04-29 06:27:02 +0000288
289 // FIXME: Alias Analysis thinks IntToPtrInst aliases with alloca instructions
290 // created by IndependentBlocks Pass.
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000291 if (isa<IntToPtrInst>(BaseValue)) {
Tobias Grossere5e171e2011-11-10 12:45:03 +0000292 INVALID(Other, "Find bad intToptr prt: " << *BaseValue);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000293 return false;
294 }
Tobias Grosser75805372011-04-29 06:27:02 +0000295
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000296 if (IgnoreAliasing)
297 return true;
Tobias Grosserfff5adc2011-11-10 13:21:43 +0000298
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000299 // Check if the base pointer of the memory access does alias with
300 // any other pointer. This cannot be handled at the moment.
Tobias Grosser298a7642013-07-14 18:09:43 +0000301 AliasSet &AS =
302 Context.AST.getAliasSetForPointer(BaseValue, AliasAnalysis::UnknownSize,
303 Inst.getMetadata(LLVMContext::MD_tbaa));
Tobias Grosser428b3e42013-02-04 15:46:25 +0000304
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000305 // INVALID triggers an assertion in verifying mode, if it detects that a
306 // SCoP was detected by SCoP detection and that this SCoP was invalidated by
307 // a pass that stated it would preserve the SCoPs. We disable this check as
308 // the independent blocks pass may create memory references which seem to
309 // alias, if -basicaa is not available. They actually do not, but as we can
310 // not proof this without -basicaa we would fail. We disable this check to
311 // not cause irrelevant verification failures.
312 if (!AS.isMustAlias()) {
313 std::string Message;
314 raw_string_ostream OS(Message);
Tobias Grosser428b3e42013-02-04 15:46:25 +0000315
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000316 OS << "Possible aliasing: ";
Tobias Grosser428b3e42013-02-04 15:46:25 +0000317
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000318 std::vector<Value *> Pointers;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000319
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000320 for (AliasSet::iterator AI = AS.begin(), AE = AS.end(); AI != AE; ++AI)
321 Pointers.push_back(AI.getPointer());
Tobias Grosser428b3e42013-02-04 15:46:25 +0000322
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000323 std::sort(Pointers.begin(), Pointers.end());
Tobias Grosser428b3e42013-02-04 15:46:25 +0000324
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000325 for (std::vector<Value *>::iterator PI = Pointers.begin(),
Tobias Grosser298a7642013-07-14 18:09:43 +0000326 PE = Pointers.end();
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000327 ;) {
328 Value *V = *PI;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000329
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000330 if (V->getName().size() == 0)
331 OS << "\"" << *V << "\"";
332 else
333 OS << "\"" << V->getName() << "\"";
Tobias Grosser428b3e42013-02-04 15:46:25 +0000334
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000335 ++PI;
Sebastian Popb35892b2013-06-03 16:35:41 +0000336
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000337 if (PI != PE)
338 OS << ", ";
339 else
340 break;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000341 }
Sebastian Pop8c2d7532013-07-03 22:50:36 +0000342
343 INVALID_NOVERIFY(Alias, OS.str());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000344 return false;
Tobias Grosser428b3e42013-02-04 15:46:25 +0000345 }
Tobias Grosser75805372011-04-29 06:27:02 +0000346
347 return true;
348}
349
Tobias Grosser75805372011-04-29 06:27:02 +0000350bool ScopDetection::isValidInstruction(Instruction &Inst,
351 DetectionContext &Context) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000352 if (PHINode *PN = dyn_cast<PHINode>(&Inst))
Tobias Grosserecfe21b2013-03-20 18:03:18 +0000353 if (!canSynthesize(PN, LI, SE, &Context.CurRegion)) {
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000354 if (SCEVCodegen) {
Tobias Grosserecfe21b2013-03-20 18:03:18 +0000355 INVALID(IndVar,
356 "SCEV of PHI node refers to SSA names in region: " << Inst);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000357 return false;
358
359 } else {
Tobias Grosserecfe21b2013-03-20 18:03:18 +0000360 INVALID(IndVar, "Non canonical PHI node: " << Inst);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000361 return false;
362 }
Tobias Grosserecfe21b2013-03-20 18:03:18 +0000363 }
Tobias Grosser75805372011-04-29 06:27:02 +0000364
Tobias Grosser75805372011-04-29 06:27:02 +0000365 // We only check the call instruction but not invoke instruction.
366 if (CallInst *CI = dyn_cast<CallInst>(&Inst)) {
367 if (isValidCallInst(*CI))
368 return true;
369
Tobias Grosserb43ba822011-10-08 00:49:30 +0000370 INVALID(FuncCall, "Call instruction: " << Inst);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000371 return false;
Tobias Grosser75805372011-04-29 06:27:02 +0000372 }
373
374 if (!Inst.mayWriteToMemory() && !Inst.mayReadFromMemory()) {
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000375 if (!isa<AllocaInst>(Inst))
376 return true;
Tobias Grosser75805372011-04-29 06:27:02 +0000377
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000378 INVALID(Other, "Alloca instruction: " << Inst);
379 return false;
Tobias Grosser75805372011-04-29 06:27:02 +0000380 }
381
382 // Check the access function.
383 if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
384 return isValidMemoryAccess(Inst, Context);
385
386 // We do not know this instruction, therefore we assume it is invalid.
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000387 INVALID(Other, "Unknown instruction: " << Inst);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000388 return false;
Tobias Grosser75805372011-04-29 06:27:02 +0000389}
390
Tobias Grosser75805372011-04-29 06:27:02 +0000391bool ScopDetection::isValidLoop(Loop *L, DetectionContext &Context) const {
Tobias Grosser826b2af2013-03-21 16:14:50 +0000392 if (!SCEVCodegen) {
393 // If code generation is not in scev based mode, we need to ensure that
394 // each loop has a canonical induction variable.
395 PHINode *IndVar = L->getCanonicalInductionVariable();
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000396 if (!IndVar) {
Tobias Grosser826b2af2013-03-21 16:14:50 +0000397 INVALID(IndVar,
398 "No canonical IV at loop header: " << L->getHeader()->getName());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000399 return false;
400 }
Tobias Grosser826b2af2013-03-21 16:14:50 +0000401 }
Tobias Grosser75805372011-04-29 06:27:02 +0000402
403 // Is the loop count affine?
404 const SCEV *LoopCount = SE->getBackedgeTakenCount(L);
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000405 if (!isAffineExpr(&Context.CurRegion, LoopCount, *SE)) {
Tobias Grosser58032cb2013-06-23 01:29:29 +0000406 INVALID(LoopBound, "Non affine loop bound '" << *LoopCount << "' in loop: "
407 << L->getHeader()->getName());
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000408 return false;
409 }
Tobias Grosser75805372011-04-29 06:27:02 +0000410
411 return true;
412}
413
414Region *ScopDetection::expandRegion(Region &R) {
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000415 // Initial no valid region was found (greater than R)
416 Region *LastValidRegion = NULL;
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000417 Region *ExpandedRegion = R.getExpandedRegion();
Tobias Grosser75805372011-04-29 06:27:02 +0000418
419 DEBUG(dbgs() << "\tExpanding " << R.getNameStr() << "\n");
420
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000421 while (ExpandedRegion) {
422 DetectionContext Context(*ExpandedRegion, *AA, false /* verifying */);
423 DEBUG(dbgs() << "\t\tTrying " << ExpandedRegion->getNameStr() << "\n");
Tobias Grosser75805372011-04-29 06:27:02 +0000424
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000425 // Check the exit first (cheap)
Tobias Grosser75805372011-04-29 06:27:02 +0000426 if (isValidExit(Context)) {
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000427 // If the exit is valid check all blocks
428 // - if true, a valid region was found => store it + keep expanding
429 // - if false, .tbd. => stop (should this really end the loop?)
430 if (!allBlocksValid(Context))
431 break;
Tobias Grosser75805372011-04-29 06:27:02 +0000432
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000433 // Delete unnecessary regions (allocated by getExpandedRegion)
434 if (LastValidRegion)
435 delete LastValidRegion;
436
Tobias Grosserd7e58642013-04-10 06:55:45 +0000437 // Store this region, because it is the greatest valid (encountered so
438 // far).
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000439 LastValidRegion = ExpandedRegion;
440
441 // Create and test the next greater region (if any)
442 ExpandedRegion = ExpandedRegion->getExpandedRegion();
443
444 } else {
445 // Create and test the next greater region (if any)
446 Region *TmpRegion = ExpandedRegion->getExpandedRegion();
447
448 // Delete unnecessary regions (allocated by getExpandedRegion)
449 delete ExpandedRegion;
450
451 ExpandedRegion = TmpRegion;
Tobias Grosser75805372011-04-29 06:27:02 +0000452 }
Tobias Grosser75805372011-04-29 06:27:02 +0000453 }
454
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000455 DEBUG(if (LastValidRegion)
Tobias Grosserd7e58642013-04-10 06:55:45 +0000456 dbgs() << "\tto " << LastValidRegion->getNameStr() << "\n";
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000457 else dbgs() << "\tExpanding " << R.getNameStr() << " failed\n";);
Tobias Grosser75805372011-04-29 06:27:02 +0000458
Hongbin Zhenged986ab2012-04-07 15:14:28 +0000459 return LastValidRegion;
Tobias Grosser75805372011-04-29 06:27:02 +0000460}
Sebastian Pop2c9ec2e2013-06-03 16:35:37 +0000461static bool regionWithoutLoops(Region &R, LoopInfo *LI) {
462 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
463 ++I)
464 if (R.contains(LI->getLoopFor(*I)))
465 return false;
466
467 return true;
468}
Tobias Grosser75805372011-04-29 06:27:02 +0000469
Tobias Grosser75805372011-04-29 06:27:02 +0000470void ScopDetection::findScops(Region &R) {
Sebastian Pop2c9ec2e2013-06-03 16:35:37 +0000471
472 if (!DetectRegionsWithoutLoops && regionWithoutLoops(R, LI))
473 return;
474
Tobias Grosser75805372011-04-29 06:27:02 +0000475 DetectionContext Context(R, *AA, false /*verifying*/);
476
Tobias Grosser4eb73812011-11-10 12:45:15 +0000477 LastFailure = "";
478
Tobias Grosser75805372011-04-29 06:27:02 +0000479 if (isValidRegion(Context)) {
480 ++ValidRegion;
481 ValidRegions.insert(&R);
482 return;
483 }
484
Tobias Grosser4f129a62011-10-08 00:30:55 +0000485 InvalidRegions[&R] = LastFailure;
486
Tobias Grosser75805372011-04-29 06:27:02 +0000487 for (Region::iterator I = R.begin(), E = R.end(); I != E; ++I)
488 findScops(**I);
489
490 // Try to expand regions.
491 //
492 // As the region tree normally only contains canonical regions, non canonical
493 // regions that form a Scop are not found. Therefore, those non canonical
494 // regions are checked by expanding the canonical ones.
495
Tobias Grosser0d1eee32013-02-05 11:56:05 +0000496 std::vector<Region *> ToExpand;
Tobias Grosser75805372011-04-29 06:27:02 +0000497
498 for (Region::iterator I = R.begin(), E = R.end(); I != E; ++I)
499 ToExpand.push_back(*I);
500
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000501 for (std::vector<Region *>::iterator RI = ToExpand.begin(),
502 RE = ToExpand.end();
503 RI != RE; ++RI) {
Tobias Grosser75805372011-04-29 06:27:02 +0000504 Region *CurrentRegion = *RI;
505
506 // Skip invalid regions. Regions may become invalid, if they are element of
507 // an already expanded region.
508 if (ValidRegions.find(CurrentRegion) == ValidRegions.end())
509 continue;
510
511 Region *ExpandedR = expandRegion(*CurrentRegion);
512
513 if (!ExpandedR)
514 continue;
515
516 R.addSubRegion(ExpandedR, true);
517 ValidRegions.insert(ExpandedR);
518 ValidRegions.erase(CurrentRegion);
519
520 for (Region::iterator I = ExpandedR->begin(), E = ExpandedR->end(); I != E;
521 ++I)
522 ValidRegions.erase(*I);
523 }
524}
525
526bool ScopDetection::allBlocksValid(DetectionContext &Context) const {
527 Region &R = Context.CurRegion;
528
529 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
Sebastian Popb88ea5e2013-06-11 22:20:32 +0000530 ++I) {
531 Loop *L = LI->getLoopFor(*I);
532 if (L && L->getHeader() == *I && !isValidLoop(L, Context))
533 return false;
534 }
535
536 for (Region::block_iterator I = R.block_begin(), E = R.block_end(); I != E;
Tobias Grosser75805372011-04-29 06:27:02 +0000537 ++I)
Sebastian Pop9e3d2dd2013-06-11 22:20:27 +0000538 if (!isValidCFG(**I, Context))
539 return false;
540
Sebastian Pop8ca899c2013-06-14 20:20:43 +0000541 for (Region::block_iterator BI = R.block_begin(), E = R.block_end(); BI != E;
542 ++BI)
543 for (BasicBlock::iterator I = (*BI)->begin(), E = --(*BI)->end(); I != E;
544 ++I)
545 if (!isValidInstruction(*I, Context))
546 return false;
Tobias Grosser75805372011-04-29 06:27:02 +0000547
548 return true;
549}
550
551bool ScopDetection::isValidExit(DetectionContext &Context) const {
552 Region &R = Context.CurRegion;
553
554 // PHI nodes are not allowed in the exit basic block.
555 if (BasicBlock *Exit = R.getExit()) {
556 BasicBlock::iterator I = Exit->begin();
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000557 if (I != Exit->end() && isa<PHINode>(*I)) {
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000558 INVALID(Other, "PHI node in exit BB");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000559 return false;
560 }
Tobias Grosser75805372011-04-29 06:27:02 +0000561 }
562
563 return true;
564}
565
566bool ScopDetection::isValidRegion(DetectionContext &Context) const {
567 Region &R = Context.CurRegion;
568
569 DEBUG(dbgs() << "Checking region: " << R.getNameStr() << "\n\t");
570
571 // The toplevel region is no valid region.
Tobias Grosseraeabcf22013-04-02 06:41:48 +0000572 if (R.isTopLevelRegion()) {
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000573 DEBUG(dbgs() << "Top level region is invalid"; dbgs() << "\n");
Tobias Grosser75805372011-04-29 06:27:02 +0000574 return false;
575 }
576
Tobias Grossere602a072013-05-07 07:30:56 +0000577 if (!R.getEnteringBlock()) {
Sebastian Pop9d632342013-06-11 22:20:40 +0000578 BasicBlock *entry = R.getEntry();
579 Loop *L = LI->getLoopFor(entry);
580
581 if (L) {
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000582 if (!L->isLoopSimplifyForm()) {
Sebastian Pop9d632342013-06-11 22:20:40 +0000583 INVALID(SimpleLoop, "Loop not in simplify form is invalid!");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000584 return false;
585 }
Sebastian Pop9d632342013-06-11 22:20:40 +0000586
587 for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
588 ++PI) {
589 // Region entering edges come from the same loop but outside the region
590 // are not allowed.
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000591 if (L->contains(*PI) && !R.contains(*PI)) {
Sebastian Pop9d632342013-06-11 22:20:40 +0000592 INVALID(IndEdge, "Region has invalid entering edges!");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000593 return false;
594 }
Sebastian Pop9d632342013-06-11 22:20:40 +0000595 }
596 }
Tobias Grosser8edce4e2013-04-16 08:04:42 +0000597 }
598
Tobias Grosserd654c252012-04-10 18:12:19 +0000599 // SCoP cannot contain the entry block of the function, because we need
Tobias Grosser75805372011-04-29 06:27:02 +0000600 // to insert alloca instruction there when translate scalar to array.
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000601 if (R.getEntry() == &(R.getEntry()->getParent()->getEntryBlock())) {
Tobias Grosserc4a0bd12011-10-08 00:30:48 +0000602 INVALID(Other, "Region containing entry block of function is invalid!");
Tobias Grosser5b1a7f22013-07-22 03:50:33 +0000603 return false;
604 }
Tobias Grosser75805372011-04-29 06:27:02 +0000605
Hongbin Zheng94868e62012-04-07 12:29:17 +0000606 if (!isValidExit(Context))
Tobias Grosser75805372011-04-29 06:27:02 +0000607 return false;
608
Hongbin Zheng94868e62012-04-07 12:29:17 +0000609 if (!allBlocksValid(Context))
Tobias Grosser75805372011-04-29 06:27:02 +0000610 return false;
611
612 DEBUG(dbgs() << "OK\n");
613 return true;
614}
615
616bool ScopDetection::isValidFunction(llvm::Function &F) {
Hongbin Zheng94c5df12011-05-06 02:38:20 +0000617 return !InvalidFunctions.count(&F);
Tobias Grosser75805372011-04-29 06:27:02 +0000618}
619
Tobias Grosser531891e2012-11-01 16:45:20 +0000620void ScopDetection::getDebugLocation(const Region *R, unsigned &LineBegin,
621 unsigned &LineEnd, std::string &FileName) {
622 LineBegin = -1;
623 LineEnd = 0;
624
625 for (Region::const_block_iterator RI = R->block_begin(), RE = R->block_end();
626 RI != RE; ++RI)
627 for (BasicBlock::iterator BI = (*RI)->begin(), BE = (*RI)->end(); BI != BE;
628 ++BI) {
629 DebugLoc DL = BI->getDebugLoc();
630 if (DL.isUnknown())
631 continue;
632
633 DIScope Scope(DL.getScope(BI->getContext()));
634
635 if (FileName.empty())
636 FileName = Scope.getFilename();
637
638 unsigned NewLine = DL.getLine();
639
640 LineBegin = std::min(LineBegin, NewLine);
641 LineEnd = std::max(LineEnd, NewLine);
642 break;
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000643 }
Tobias Grosser531891e2012-11-01 16:45:20 +0000644}
645
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000646void ScopDetection::printLocations(llvm::Function &F) {
647 int NumberOfScops = std::distance(begin(), end());
648
649 if (NumberOfScops)
650 outs() << ":: Static control regions in " << F.getName() << "\n";
651
Tobias Grosser531891e2012-11-01 16:45:20 +0000652 for (iterator RI = begin(), RE = end(); RI != RE; ++RI) {
653 unsigned LineEntry, LineExit;
654 std::string FileName;
655
656 getDebugLocation(*RI, LineEntry, LineExit, FileName);
657
658 if (FileName.empty()) {
659 outs() << "Scop detected at unknown location. Compile with debug info "
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000660 "(-g) to get more precise information. \n";
Tobias Grosser531891e2012-11-01 16:45:20 +0000661 return;
662 }
663
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000664 outs() << FileName << ":" << LineEntry
665 << ": Start of static control region\n";
666 outs() << FileName << ":" << LineExit << ": End of static control region\n";
Tobias Grosser531891e2012-11-01 16:45:20 +0000667 }
668}
669
Tobias Grosser75805372011-04-29 06:27:02 +0000670bool ScopDetection::runOnFunction(llvm::Function &F) {
Sebastian Pop8fe6d112013-05-30 17:47:32 +0000671 LI = &getAnalysis<LoopInfo>();
672 if (!DetectScopsWithoutLoops && LI->empty())
673 return false;
674
Tobias Grosser75805372011-04-29 06:27:02 +0000675 AA = &getAnalysis<AliasAnalysis>();
676 SE = &getAnalysis<ScalarEvolution>();
Tobias Grosser75805372011-04-29 06:27:02 +0000677 RI = &getAnalysis<RegionInfo>();
678 Region *TopRegion = RI->getTopLevelRegion();
679
Tobias Grosser2ff87232011-10-23 11:17:06 +0000680 releaseMemory();
681
Tobias Grosser29ee0b12011-11-17 14:52:36 +0000682 if (OnlyFunction != "" && F.getName() != OnlyFunction)
Tobias Grosser2ff87232011-10-23 11:17:06 +0000683 return false;
684
Tobias Grosser1bb59b02012-12-29 23:47:38 +0000685 if (!isValidFunction(F))
Tobias Grosser75805372011-04-29 06:27:02 +0000686 return false;
687
688 findScops(*TopRegion);
Tobias Grosser531891e2012-11-01 16:45:20 +0000689
690 if (ReportLevel >= 1)
Tobias Grosserb2863ca2013-03-04 19:49:51 +0000691 printLocations(F);
Tobias Grosser531891e2012-11-01 16:45:20 +0000692
Tobias Grosser75805372011-04-29 06:27:02 +0000693 return false;
694}
695
Tobias Grosser75805372011-04-29 06:27:02 +0000696void polly::ScopDetection::verifyRegion(const Region &R) const {
697 assert(isMaxRegionInScop(R) && "Expect R is a valid region.");
Tobias Grosser0d1eee32013-02-05 11:56:05 +0000698 DetectionContext Context(const_cast<Region &>(R), *AA, true /*verifying*/);
Tobias Grosser75805372011-04-29 06:27:02 +0000699 isValidRegion(Context);
700}
701
702void polly::ScopDetection::verifyAnalysis() const {
703 for (RegionSet::const_iterator I = ValidRegions.begin(),
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000704 E = ValidRegions.end();
705 I != E; ++I)
Tobias Grosser75805372011-04-29 06:27:02 +0000706 verifyRegion(**I);
707}
708
709void ScopDetection::getAnalysisUsage(AnalysisUsage &AU) const {
710 AU.addRequired<DominatorTree>();
711 AU.addRequired<PostDominatorTree>();
712 AU.addRequired<LoopInfo>();
713 AU.addRequired<ScalarEvolution>();
714 // We also need AA and RegionInfo when we are verifying analysis.
715 AU.addRequiredTransitive<AliasAnalysis>();
716 AU.addRequiredTransitive<RegionInfo>();
717 AU.setPreservesAll();
718}
719
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000720void ScopDetection::print(raw_ostream &OS, const Module *) const {
Tobias Grosser75805372011-04-29 06:27:02 +0000721 for (RegionSet::const_iterator I = ValidRegions.begin(),
Tobias Grosseraf3c00b82013-02-05 09:40:22 +0000722 E = ValidRegions.end();
723 I != E; ++I)
Tobias Grosser75805372011-04-29 06:27:02 +0000724 OS << "Valid Region for Scop: " << (*I)->getNameStr() << '\n';
725
726 OS << "\n";
727}
728
729void ScopDetection::releaseMemory() {
730 ValidRegions.clear();
Tobias Grosser4f129a62011-10-08 00:30:55 +0000731 InvalidRegions.clear();
Hongbin Zheng94c5df12011-05-06 02:38:20 +0000732 // Do not clear the invalid function set.
Tobias Grosser75805372011-04-29 06:27:02 +0000733}
734
735char ScopDetection::ID = 0;
736
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000737Pass *polly::createScopDetectionPass() { return new ScopDetection(); }
738
Tobias Grosser73600b82011-10-08 00:30:40 +0000739INITIALIZE_PASS_BEGIN(ScopDetection, "polly-detect",
740 "Polly - Detect static control parts (SCoPs)", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +0000741 false);
742INITIALIZE_AG_DEPENDENCY(AliasAnalysis);
743INITIALIZE_PASS_DEPENDENCY(DominatorTree);
744INITIALIZE_PASS_DEPENDENCY(LoopInfo);
745INITIALIZE_PASS_DEPENDENCY(PostDominatorTree);
746INITIALIZE_PASS_DEPENDENCY(RegionInfo);
747INITIALIZE_PASS_DEPENDENCY(ScalarEvolution);
Tobias Grosser73600b82011-10-08 00:30:40 +0000748INITIALIZE_PASS_END(ScopDetection, "polly-detect",
749 "Polly - Detect static control parts (SCoPs)", false, false)