blob: 157b4c6fde822f223f79082f52b86e94ed29132d [file] [log] [blame]
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001//===- ScopInfo.cpp -------------------------------------------------------===//
Tobias Grosser75805372011-04-29 06:27:02 +00002//
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// Create a polyhedral description for a static control flow region.
11//
12// The pass creates a polyhedral description of the Scops detected by the Scop
13// detection derived from their LLVM-IR code.
14//
Tobias Grossera5605d32014-10-29 19:58:28 +000015// This representation is shared among several tools in the polyhedral
Tobias Grosser75805372011-04-29 06:27:02 +000016// community, which are e.g. Cloog, Pluto, Loopo, Graphite.
17//
18//===----------------------------------------------------------------------===//
19
Tobias Grosser5624d3c2015-12-21 12:38:56 +000020#include "polly/ScopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000021#include "polly/LinkAllPasses.h"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000022#include "polly/Options.h"
Michael Kruse73fa33b2016-06-28 01:37:28 +000023#include "polly/ScopBuilder.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000024#include "polly/ScopDetection.h"
Tobias Grosser75805372011-04-29 06:27:02 +000025#include "polly/Support/GICHelper.h"
Tobias Grosser77eef902017-07-21 23:07:56 +000026#include "polly/Support/ISLOStream.h"
Michael Krusee3300712018-05-09 16:23:56 +000027#include "polly/Support/ISLTools.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000028#include "polly/Support/SCEVAffinator.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000029#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000030#include "polly/Support/ScopHelper.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000031#include "llvm/ADT/APInt.h"
32#include "llvm/ADT/ArrayRef.h"
33#include "llvm/ADT/DenseMap.h"
34#include "llvm/ADT/DenseSet.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000035#include "llvm/ADT/PostOrderIterator.h"
36#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000037#include "llvm/ADT/SetVector.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000038#include "llvm/ADT/SmallPtrSet.h"
39#include "llvm/ADT/SmallSet.h"
40#include "llvm/ADT/SmallVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000041#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000042#include "llvm/ADT/StringExtras.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000043#include "llvm/ADT/StringMap.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000044#include "llvm/Analysis/AliasAnalysis.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000045#include "llvm/Analysis/AliasSetTracker.h"
Michael Kruse89b1f942017-03-17 13:56:53 +000046#include "llvm/Analysis/AssumptionCache.h"
Johannes Doerfert1dc12af2016-04-23 12:59:18 +000047#include "llvm/Analysis/Loads.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000048#include "llvm/Analysis/LoopInfo.h"
Adam Nemete0f15412017-10-09 23:49:08 +000049#include "llvm/Analysis/OptimizationRemarkEmitter.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000050#include "llvm/Analysis/RegionInfo.h"
Tobias Grosser83628182013-05-07 08:11:54 +000051#include "llvm/Analysis/RegionIterator.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000052#include "llvm/Analysis/ScalarEvolution.h"
Tobias Grosser83628182013-05-07 08:11:54 +000053#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000054#include "llvm/IR/Argument.h"
55#include "llvm/IR/BasicBlock.h"
56#include "llvm/IR/CFG.h"
57#include "llvm/IR/ConstantRange.h"
58#include "llvm/IR/Constants.h"
59#include "llvm/IR/DataLayout.h"
60#include "llvm/IR/DebugLoc.h"
61#include "llvm/IR/DerivedTypes.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000062#include "llvm/IR/DiagnosticInfo.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000063#include "llvm/IR/Dominators.h"
64#include "llvm/IR/Function.h"
65#include "llvm/IR/InstrTypes.h"
66#include "llvm/IR/Instruction.h"
67#include "llvm/IR/Instructions.h"
68#include "llvm/IR/IntrinsicInst.h"
69#include "llvm/IR/Module.h"
70#include "llvm/IR/PassManager.h"
71#include "llvm/IR/Type.h"
72#include "llvm/IR/Use.h"
73#include "llvm/IR/User.h"
74#include "llvm/IR/Value.h"
75#include "llvm/Pass.h"
76#include "llvm/Support/Casting.h"
77#include "llvm/Support/CommandLine.h"
78#include "llvm/Support/Compiler.h"
Tobias Grosser75805372011-04-29 06:27:02 +000079#include "llvm/Support/Debug.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000080#include "llvm/Support/ErrorHandling.h"
81#include "llvm/Support/MathExtras.h"
82#include "llvm/Support/raw_ostream.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000083#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000084#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000085#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000086#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000087#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000088#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000089#include "isl/schedule.h"
90#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000091#include "isl/set.h"
92#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000093#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000094#include "isl/val.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000095#include <algorithm>
96#include <cassert>
97#include <cstdlib>
98#include <cstring>
99#include <deque>
100#include <iterator>
101#include <memory>
Tobias Grosser75805372011-04-29 06:27:02 +0000102#include <string>
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000103#include <tuple>
104#include <utility>
Tobias Grosser75805372011-04-29 06:27:02 +0000105#include <vector>
106
107using namespace llvm;
108using namespace polly;
109
Chandler Carruth95fef942014-04-22 03:30:19 +0000110#define DEBUG_TYPE "polly-scops"
111
Johannes Doerfert81aa6e82016-11-18 14:37:08 +0000112STATISTIC(AssumptionsAliasing, "Number of aliasing assumptions taken.");
113STATISTIC(AssumptionsInbounds, "Number of inbounds assumptions taken.");
114STATISTIC(AssumptionsWrapping, "Number of wrapping assumptions taken.");
115STATISTIC(AssumptionsUnsigned, "Number of unsigned assumptions taken.");
116STATISTIC(AssumptionsComplexity, "Number of too complex SCoPs.");
117STATISTIC(AssumptionsUnprofitable, "Number of unprofitable SCoPs.");
118STATISTIC(AssumptionsErrorBlock, "Number of error block assumptions taken.");
119STATISTIC(AssumptionsInfiniteLoop, "Number of bounded loop assumptions taken.");
120STATISTIC(AssumptionsInvariantLoad,
Johannes Doerfertcd195322016-11-17 21:41:08 +0000121 "Number of invariant loads assumptions taken.");
Johannes Doerfert81aa6e82016-11-18 14:37:08 +0000122STATISTIC(AssumptionsDelinearization,
Johannes Doerfertcd195322016-11-17 21:41:08 +0000123 "Number of delinearization assumptions taken.");
124
Michael Kruse06ed5292017-08-23 13:50:30 +0000125STATISTIC(NumScops, "Number of feasible SCoPs after ScopInfo");
Tobias Grossercd01a362017-02-17 08:12:36 +0000126STATISTIC(NumLoopsInScop, "Number of loops in scops");
Michael Kruse06ed5292017-08-23 13:50:30 +0000127STATISTIC(NumBoxedLoops, "Number of boxed loops in SCoPs after ScopInfo");
128STATISTIC(NumAffineLoops, "Number of affine loops in SCoPs after ScopInfo");
129
Tobias Grosserfcc3ad52018-04-18 20:03:36 +0000130STATISTIC(NumScopsDepthZero, "Number of scops with maximal loop depth 0");
Tobias Grossercd01a362017-02-17 08:12:36 +0000131STATISTIC(NumScopsDepthOne, "Number of scops with maximal loop depth 1");
132STATISTIC(NumScopsDepthTwo, "Number of scops with maximal loop depth 2");
133STATISTIC(NumScopsDepthThree, "Number of scops with maximal loop depth 3");
134STATISTIC(NumScopsDepthFour, "Number of scops with maximal loop depth 4");
135STATISTIC(NumScopsDepthFive, "Number of scops with maximal loop depth 5");
136STATISTIC(NumScopsDepthLarger,
137 "Number of scops with maximal loop depth 6 and larger");
138STATISTIC(MaxNumLoopsInScop, "Maximal number of loops in scops");
139
Michael Kruse06ed5292017-08-23 13:50:30 +0000140STATISTIC(NumValueWrites, "Number of scalar value writes after ScopInfo");
141STATISTIC(
142 NumValueWritesInLoops,
143 "Number of scalar value writes nested in affine loops after ScopInfo");
144STATISTIC(NumPHIWrites, "Number of scalar phi writes after ScopInfo");
145STATISTIC(NumPHIWritesInLoops,
146 "Number of scalar phi writes nested in affine loops after ScopInfo");
147STATISTIC(NumSingletonWrites, "Number of singleton writes after ScopInfo");
148STATISTIC(NumSingletonWritesInLoops,
149 "Number of singleton writes nested in affine loops after ScopInfo");
150
Tobias Grosser75dc40c2015-12-20 13:31:48 +0000151// The maximal number of basic sets we allow during domain construction to
152// be created. More complex scops will result in very high compile time and
153// are also unlikely to result in good code
Tobias Grosser90411a92017-02-16 19:11:33 +0000154static int const MaxDisjunctsInDomain = 20;
Tobias Grosser75dc40c2015-12-20 13:31:48 +0000155
Tobias Grosserc8a82762017-02-16 19:11:25 +0000156// The number of disjunct in the context after which we stop to add more
157// disjuncts. This parameter is there to avoid exponential growth in the
158// number of disjunct when adding non-convex sets to the context.
159static int const MaxDisjunctsInContext = 4;
160
Tobias Grosser1eeedf42017-07-20 19:55:19 +0000161// The maximal number of dimensions we allow during invariant load construction.
162// More complex access ranges will result in very high compile time and are also
163// unlikely to result in good code. This value is very high and should only
164// trigger for corner cases (e.g., the "dct_luma" function in h264, SPEC2006).
165static int const MaxDimensionsInAccessRange = 9;
166
Tobias Grosser97715842017-05-19 04:01:52 +0000167static cl::opt<int>
168 OptComputeOut("polly-analysis-computeout",
169 cl::desc("Bound the scop analysis by a maximal amount of "
170 "computational steps (0 means no bound)"),
Tobias Grosser57a1d362017-06-23 08:05:27 +0000171 cl::Hidden, cl::init(800000), cl::ZeroOrMore,
Tobias Grosser97715842017-05-19 04:01:52 +0000172 cl::cat(PollyCategory));
Tobias Grosser45e9fd12017-05-19 03:45:00 +0000173
Johannes Doerfert2f705842016-04-12 16:09:44 +0000174static cl::opt<bool> PollyRemarksMinimal(
175 "polly-remarks-minimal",
176 cl::desc("Do not emit remarks about assumptions that are known"),
177 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
178
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +0000179static cl::opt<int> RunTimeChecksMaxAccessDisjuncts(
180 "polly-rtc-max-array-disjuncts",
181 cl::desc("The maximal number of disjunts allowed in memory accesses to "
182 "to build RTCs."),
183 cl::Hidden, cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
184
Johannes Doerfert9143d672014-09-27 11:02:39 +0000185static cl::opt<unsigned> RunTimeChecksMaxParameters(
186 "polly-rtc-max-parameters",
187 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
188 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
189
Tobias Grosser71500722015-03-28 15:11:14 +0000190static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
191 "polly-rtc-max-arrays-per-group",
192 cl::desc("The maximal number of arrays to compare in each alias group."),
193 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Johannes Doerfert5210da52016-06-02 11:06:54 +0000194
Tobias Grosser8a9c2352015-08-16 10:19:29 +0000195static cl::opt<std::string> UserContextStr(
196 "polly-context", cl::value_desc("isl parameter set"),
197 cl::desc("Provide additional constraints on the context parameters"),
198 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +0000199
Tobias Grosser2937b592016-04-29 11:43:20 +0000200static cl::opt<bool>
201 IslOnErrorAbort("polly-on-isl-error-abort",
202 cl::desc("Abort if an isl error is encountered"),
203 cl::init(true), cl::cat(PollyCategory));
204
Tobias Grosserd7c49752017-02-28 09:45:54 +0000205static cl::opt<bool> PollyPreciseInbounds(
206 "polly-precise-inbounds",
207 cl::desc("Take more precise inbounds assumptions (do not scale well)"),
208 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
209
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000210static cl::opt<bool>
211 PollyIgnoreInbounds("polly-ignore-inbounds",
212 cl::desc("Do not take inbounds assumptions at all"),
213 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
214
Tobias Grosser5842dee2017-03-17 13:00:53 +0000215static cl::opt<bool> PollyIgnoreParamBounds(
216 "polly-ignore-parameter-bounds",
217 cl::desc(
218 "Do not add parameter bounds and do no gist simplify sets accordingly"),
219 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
220
Siddharth Bhat7bc77e82017-08-21 11:57:04 +0000221static cl::opt<bool> PollyAllowDereferenceOfAllFunctionParams(
222 "polly-allow-dereference-of-all-function-parameters",
223 cl::desc(
224 "Treat all parameters to functions that are pointers as dereferencible."
225 " This is useful for invariant load hoisting, since we can generate"
226 " less runtime checks. This is only valid if all pointers to functions"
227 " are always initialized, so that Polly can choose to hoist"
228 " their loads. "),
229 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
230
Tobias Grosserc2f15102017-03-01 21:11:27 +0000231static cl::opt<bool> PollyPreciseFoldAccesses(
232 "polly-precise-fold-accesses",
Michael Kruse6e7854a2017-04-03 12:03:38 +0000233 cl::desc("Fold memory accesses to model more possible delinearizations "
234 "(does not scale well)"),
Tobias Grosserc2f15102017-03-01 21:11:27 +0000235 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000236
Michael Kruse5ae08c02017-05-06 14:03:58 +0000237bool polly::UseInstructionNames;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000238
Michael Kruse5ae08c02017-05-06 14:03:58 +0000239static cl::opt<bool, true> XUseInstructionNames(
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000240 "polly-use-llvm-names",
Michael Kruse5ae08c02017-05-06 14:03:58 +0000241 cl::desc("Use LLVM-IR names when deriving statement names"),
242 cl::location(UseInstructionNames), cl::Hidden, cl::init(false),
243 cl::ZeroOrMore, cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000244
Tobias Grosserd5fcbef2017-05-27 04:40:18 +0000245static cl::opt<bool> PollyPrintInstructions(
246 "polly-print-instructions", cl::desc("Output instructions per ScopStmt"),
247 cl::Hidden, cl::Optional, cl::init(false), cl::cat(PollyCategory));
248
Michael Kruse7bf39442015-09-10 12:46:52 +0000249//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000250
Michael Kruse046dde42015-08-10 13:01:57 +0000251// Create a sequence of two schedules. Either argument may be null and is
252// interpreted as the empty schedule. Can also return null if both schedules are
253// empty.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000254static isl::schedule combineInSequence(isl::schedule Prev, isl::schedule Succ) {
Michael Kruse046dde42015-08-10 13:01:57 +0000255 if (!Prev)
256 return Succ;
257 if (!Succ)
258 return Prev;
259
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000260 return Prev.sequence(Succ);
Michael Kruse046dde42015-08-10 13:01:57 +0000261}
262
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000263static isl::set addRangeBoundsToSet(isl::set S, const ConstantRange &Range,
264 int dim, isl::dim type) {
265 isl::val V;
266 isl::ctx Ctx = S.get_ctx();
Johannes Doerferte7044942015-02-24 11:58:30 +0000267
Tobias Grosser3281f602017-02-16 18:39:14 +0000268 // The upper and lower bound for a parameter value is derived either from
269 // the data type of the parameter or from the - possibly more restrictive -
270 // range metadata.
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000271 V = valFromAPInt(Ctx.get(), Range.getSignedMin(), true);
272 S = S.lower_bound_val(type, dim, V);
273 V = valFromAPInt(Ctx.get(), Range.getSignedMax(), true);
274 S = S.upper_bound_val(type, dim, V);
Johannes Doerferte7044942015-02-24 11:58:30 +0000275
Tobias Grosser3281f602017-02-16 18:39:14 +0000276 if (Range.isFullSet())
277 return S;
278
Philip Pfaffe9375d572018-05-16 14:05:03 +0000279 if (S.n_basic_set() > MaxDisjunctsInContext)
Tobias Grosserc8a82762017-02-16 19:11:25 +0000280 return S;
281
Tobias Grosser3281f602017-02-16 18:39:14 +0000282 // In case of signed wrapping, we can refine the set of valid values by
283 // excluding the part not covered by the wrapping range.
284 if (Range.isSignWrappedSet()) {
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000285 V = valFromAPInt(Ctx.get(), Range.getLower(), true);
286 isl::set SLB = S.lower_bound_val(type, dim, V);
Tobias Grosser3281f602017-02-16 18:39:14 +0000287
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000288 V = valFromAPInt(Ctx.get(), Range.getUpper(), true);
289 V = V.sub_ui(1);
290 isl::set SUB = S.upper_bound_val(type, dim, V);
291 S = SLB.unite(SUB);
Tobias Grosser3281f602017-02-16 18:39:14 +0000292 }
Johannes Doerferte7044942015-02-24 11:58:30 +0000293
Tobias Grosser3281f602017-02-16 18:39:14 +0000294 return S;
Johannes Doerferte7044942015-02-24 11:58:30 +0000295}
296
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000297static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
298 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
299 if (!BasePtrLI)
300 return nullptr;
301
Johannes Doerfert952b5302016-05-23 12:40:48 +0000302 if (!S->contains(BasePtrLI))
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000303 return nullptr;
304
305 ScalarEvolution &SE = *S->getSE();
306
307 auto *OriginBaseSCEV =
308 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
309 if (!OriginBaseSCEV)
310 return nullptr;
311
312 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
313 if (!OriginBaseSCEVUnknown)
314 return nullptr;
315
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000316 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000317 MemoryKind::Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000318}
319
Tobias Grosser27db02b2017-08-06 17:25:05 +0000320ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl::ctx Ctx,
Hongbin Zheng6aded2a2017-01-15 16:47:26 +0000321 ArrayRef<const SCEV *> Sizes, MemoryKind Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +0000322 const DataLayout &DL, Scop *S,
323 const char *BaseName)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000324 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000325 std::string BasePtrName =
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000326 BaseName ? BaseName
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000327 : getIslCompatibleName("MemRef", BasePtr, S->getNextArrayIdx(),
328 Kind == MemoryKind::PHI ? "__phi" : "",
329 UseInstructionNames);
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000330 Id = isl::id::alloc(Ctx, BasePtrName, this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000331
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000332 updateSizes(Sizes);
Roman Gareevd7754a12016-07-30 09:25:51 +0000333
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000334 if (!BasePtr || Kind != MemoryKind::Array) {
Roman Gareevd7754a12016-07-30 09:25:51 +0000335 BasePtrOriginSAI = nullptr;
336 return;
337 }
338
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000339 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
340 if (BasePtrOriginSAI)
341 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000342}
343
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000344ScopArrayInfo::~ScopArrayInfo() = default;
345
Tobias Grosser77eef902017-07-21 23:07:56 +0000346isl::space ScopArrayInfo::getSpace() const {
347 auto Space = isl::space(Id.get_ctx(), 0, getNumberOfDimensions());
348 Space = Space.set_tuple_id(isl::dim::set, Id);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000349 return Space;
350}
351
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000352bool ScopArrayInfo::isReadOnly() {
Tobias Grosser5ab39ff2017-08-06 19:22:27 +0000353 isl::union_set WriteSet = S.getWrites().range();
Tobias Grosser77eef902017-07-21 23:07:56 +0000354 isl::space Space = getSpace();
Tobias Grosser2ade9862017-05-23 06:41:04 +0000355 WriteSet = WriteSet.extract_set(Space);
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000356
Tobias Grosser2ade9862017-05-23 06:41:04 +0000357 return bool(WriteSet.is_empty());
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000358}
359
Tobias Grosserf3adab42017-05-10 10:59:58 +0000360bool ScopArrayInfo::isCompatibleWith(const ScopArrayInfo *Array) const {
361 if (Array->getElementType() != getElementType())
362 return false;
363
364 if (Array->getNumberOfDimensions() != getNumberOfDimensions())
365 return false;
366
367 for (unsigned i = 0; i < getNumberOfDimensions(); i++)
368 if (Array->getDimensionSize(i) != getDimensionSize(i))
369 return false;
370
371 return true;
372}
373
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000374void ScopArrayInfo::updateElementType(Type *NewElementType) {
375 if (NewElementType == ElementType)
376 return;
377
Tobias Grosserd840fc72016-02-04 13:18:42 +0000378 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
379 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
380
Johannes Doerferta7920982016-02-25 14:08:48 +0000381 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000382 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000383
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000384 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
385 ElementType = NewElementType;
386 } else {
387 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
388 ElementType = IntegerType::get(ElementType->getContext(), GCD);
389 }
390}
391
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000392/// Make the ScopArrayInfo model a Fortran Array
393void ScopArrayInfo::applyAndSetFAD(Value *FAD) {
394 assert(FAD && "got invalid Fortran array descriptor");
395 if (this->FAD) {
396 assert(this->FAD == FAD &&
397 "receiving different array descriptors for same array");
398 return;
399 }
400
401 assert(DimensionSizesPw.size() > 0 && !DimensionSizesPw[0]);
402 assert(!this->FAD);
403 this->FAD = FAD;
404
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000405 isl::space Space(S.getIslCtx(), 1, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000406
407 std::string param_name = getName();
408 param_name += "_fortranarr_size";
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000409 isl::id IdPwAff = isl::id::alloc(S.getIslCtx(), param_name, this);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000410
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000411 Space = Space.set_dim_id(isl::dim::param, 0, IdPwAff);
412 isl::pw_aff PwAff =
413 isl::aff::var_on_domain(isl::local_space(Space), isl::dim::param, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000414
Tobias Grosser77eef902017-07-21 23:07:56 +0000415 DimensionSizesPw[0] = PwAff;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000416}
417
Tobias Grosserbedef002016-12-02 08:10:56 +0000418bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes,
419 bool CheckConsistency) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000420 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
421 int ExtraDimsNew = NewSizes.size() - SharedDims;
422 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Roman Gareevf5aff702016-09-12 17:08:31 +0000423
Tobias Grosserbedef002016-12-02 08:10:56 +0000424 if (CheckConsistency) {
425 for (int i = 0; i < SharedDims; i++) {
426 auto *NewSize = NewSizes[i + ExtraDimsNew];
427 auto *KnownSize = DimensionSizes[i + ExtraDimsOld];
428 if (NewSize && KnownSize && NewSize != KnownSize)
429 return false;
430 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000431
Tobias Grosserbedef002016-12-02 08:10:56 +0000432 if (DimensionSizes.size() >= NewSizes.size())
433 return true;
434 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000435
436 DimensionSizes.clear();
437 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
438 NewSizes.end());
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000439 DimensionSizesPw.clear();
440 for (const SCEV *Expr : DimensionSizes) {
Roman Gareevf5aff702016-09-12 17:08:31 +0000441 if (!Expr) {
442 DimensionSizesPw.push_back(nullptr);
443 continue;
444 }
Tobias Grosser61bd3a42017-08-06 21:42:38 +0000445 isl::pw_aff Size = S.getPwAffOnly(Expr);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000446 DimensionSizesPw.push_back(Size);
447 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000448 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000449}
450
Tobias Grosser77eef902017-07-21 23:07:56 +0000451std::string ScopArrayInfo::getName() const { return Id.get_name(); }
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000452
453int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000454 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000455}
456
Tobias Grosser77eef902017-07-21 23:07:56 +0000457isl::id ScopArrayInfo::getBasePtrId() const { return Id; }
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000458
Michael Kruse5d518462017-07-21 15:54:07 +0000459#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +0000460LLVM_DUMP_METHOD void ScopArrayInfo::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +0000461#endif
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000462
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000463void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000464 OS.indent(8) << *getElementType() << " " << getName();
Roman Gareevf5aff702016-09-12 17:08:31 +0000465 unsigned u = 0;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000466 // If this is a Fortran array, then we can print the outermost dimension
467 // as a isl_pw_aff even though there is no SCEV information.
468 bool IsOutermostSizeKnown = SizeAsPwAff && FAD;
469
470 if (!IsOutermostSizeKnown && getNumberOfDimensions() > 0 &&
471 !getDimensionSize(0)) {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000472 OS << "[*]";
Roman Gareevf5aff702016-09-12 17:08:31 +0000473 u++;
474 }
475 for (; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000476 OS << "[";
477
Tobias Grosser26253842015-11-10 14:24:21 +0000478 if (SizeAsPwAff) {
Tobias Grosser77eef902017-07-21 23:07:56 +0000479 isl::pw_aff Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000480 OS << " " << Size << " ";
Tobias Grosser26253842015-11-10 14:24:21 +0000481 } else {
482 OS << *getDimensionSize(u);
483 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000484
485 OS << "]";
486 }
487
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000488 OS << ";";
489
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000490 if (BasePtrOriginSAI)
491 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
492
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000493 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000494}
495
496const ScopArrayInfo *
Tobias Grosser206e9e32017-07-24 16:22:27 +0000497ScopArrayInfo::getFromAccessFunction(isl::pw_multi_aff PMA) {
498 isl::id Id = PMA.get_tuple_id(isl::dim::out);
499 assert(!Id.is_null() && "Output dimension didn't have an ID");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000500 return getFromId(Id);
501}
502
Tobias Grosser206e9e32017-07-24 16:22:27 +0000503const ScopArrayInfo *ScopArrayInfo::getFromId(isl::id Id) {
504 void *User = Id.get_user();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000505 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000506 return SAI;
507}
508
Michael Kruse3b425ff2016-04-11 14:34:08 +0000509void MemoryAccess::wrapConstantDimensions() {
510 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000511 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000512 isl::ctx Ctx = ArraySpace.get_ctx();
Michael Kruse3b425ff2016-04-11 14:34:08 +0000513 unsigned DimsArray = SAI->getNumberOfDimensions();
514
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000515 isl::multi_aff DivModAff = isl::multi_aff::identity(
516 ArraySpace.map_from_domain_and_range(ArraySpace));
517 isl::local_space LArraySpace = isl::local_space(ArraySpace);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000518
519 // Begin with last dimension, to iteratively carry into higher dimensions.
520 for (int i = DimsArray - 1; i > 0; i--) {
521 auto *DimSize = SAI->getDimensionSize(i);
522 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
523
524 // This transformation is not applicable to dimensions with dynamic size.
525 if (!DimSizeCst)
526 continue;
527
Tobias Grosserca2cfd02017-02-17 04:48:52 +0000528 // This transformation is not applicable to dimensions of size zero.
529 if (DimSize->isZero())
530 continue;
531
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000532 isl::val DimSizeVal =
533 valFromAPInt(Ctx.get(), DimSizeCst->getAPInt(), false);
534 isl::aff Var = isl::aff::var_on_domain(LArraySpace, isl::dim::set, i);
535 isl::aff PrevVar =
536 isl::aff::var_on_domain(LArraySpace, isl::dim::set, i - 1);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000537
538 // Compute: index % size
539 // Modulo must apply in the divide of the previous iteration, if any.
Tobias Grossercb0224a2017-08-06 15:56:45 +0000540 isl::aff Modulo = Var.mod(DimSizeVal);
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000541 Modulo = Modulo.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000542
543 // Compute: floor(index / size)
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000544 isl::aff Divide = Var.div(isl::aff(LArraySpace, DimSizeVal));
545 Divide = Divide.floor();
546 Divide = Divide.add(PrevVar);
547 Divide = Divide.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000548
549 // Apply Modulo and Divide.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000550 DivModAff = DivModAff.set_aff(i, Modulo);
551 DivModAff = DivModAff.set_aff(i - 1, Divide);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000552 }
553
554 // Apply all modulo/divides on the accesses.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000555 isl::map Relation = AccessRelation;
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000556 Relation = Relation.apply_range(isl::map::from_multi_aff(DivModAff));
557 Relation = Relation.detect_equalities();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000558 AccessRelation = Relation;
Michael Kruse3b425ff2016-04-11 14:34:08 +0000559}
560
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000561void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000562 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000563 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000564 isl::space AccessSpace = AccessRelation.get_space().range();
Tobias Grosser7be82452017-05-21 20:38:33 +0000565 isl::ctx Ctx = ArraySpace.get_ctx();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000566
Tobias Grosser7be82452017-05-21 20:38:33 +0000567 auto DimsArray = ArraySpace.dim(isl::dim::set);
568 auto DimsAccess = AccessSpace.dim(isl::dim::set);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000569 auto DimsMissing = DimsArray - DimsAccess;
570
Michael Kruse375cb5f2016-02-24 22:08:24 +0000571 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000572 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000573 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000574 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000575
Tobias Grosser7be82452017-05-21 20:38:33 +0000576 isl::map Map = isl::map::from_domain_and_range(
577 isl::set::universe(AccessSpace), isl::set::universe(ArraySpace));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000578
579 for (unsigned i = 0; i < DimsMissing; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000580 Map = Map.fix_si(isl::dim::out, i, 0);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000581
582 for (unsigned i = DimsMissing; i < DimsArray; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000583 Map = Map.equate(isl::dim::in, i - DimsMissing, isl::dim::out, i);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000584
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000585 AccessRelation = AccessRelation.apply_range(Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000586
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000587 // For the non delinearized arrays, divide the access function of the last
588 // subscript by the size of the elements in the array.
589 //
590 // A stride one array access in C expressed as A[i] is expressed in
591 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
592 // two subsequent values of 'i' index two values that are stored next to
593 // each other in memory. By this division we make this characteristic
594 // obvious again. If the base pointer was accessed with offsets not divisible
Tobias Grosser2219d152016-08-03 05:28:09 +0000595 // by the accesses element size, we will have chosen a smaller ArrayElemSize
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000596 // that divides the offsets of all accesses to this base pointer.
597 if (DimsAccess == 1) {
Tobias Grosser7be82452017-05-21 20:38:33 +0000598 isl::val V = isl::val(Ctx, ArrayElemSize);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000599 AccessRelation = AccessRelation.floordiv_val(V);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000600 }
601
Michael Kruse3b425ff2016-04-11 14:34:08 +0000602 // We currently do this only if we added at least one dimension, which means
603 // some dimension's indices have not been specified, an indicator that some
604 // index values have been added together.
605 // TODO: Investigate general usefulness; Effect on unit tests is to make index
606 // expressions more complicated.
607 if (DimsMissing)
608 wrapConstantDimensions();
609
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000610 if (!isAffine())
611 computeBoundsOnAccessRelation(ArrayElemSize);
612
Tobias Grosserd840fc72016-02-04 13:18:42 +0000613 // Introduce multi-element accesses in case the type loaded by this memory
614 // access is larger than the canonical element type of the array.
615 //
616 // An access ((float *)A)[i] to an array char *A is modeled as
617 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000618 if (ElemBytes > ArrayElemSize) {
619 assert(ElemBytes % ArrayElemSize == 0 &&
620 "Loaded element size should be multiple of canonical element size");
Tobias Grosser7be82452017-05-21 20:38:33 +0000621 isl::map Map = isl::map::from_domain_and_range(
622 isl::set::universe(ArraySpace), isl::set::universe(ArraySpace));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000623 for (unsigned i = 0; i < DimsArray - 1; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000624 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000625
Tobias Grosser7be82452017-05-21 20:38:33 +0000626 isl::constraint C;
627 isl::local_space LS;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000628
Tobias Grosser7be82452017-05-21 20:38:33 +0000629 LS = isl::local_space(Map.get_space());
Tobias Grosserd840fc72016-02-04 13:18:42 +0000630 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
631
Tobias Grosser7be82452017-05-21 20:38:33 +0000632 C = isl::constraint::alloc_inequality(LS);
633 C = C.set_constant_val(isl::val(Ctx, Num - 1));
634 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, 1);
635 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, -1);
636 Map = Map.add_constraint(C);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000637
Tobias Grosser7be82452017-05-21 20:38:33 +0000638 C = isl::constraint::alloc_inequality(LS);
639 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, -1);
640 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, 1);
641 C = C.set_constant_val(isl::val(Ctx, 0));
642 Map = Map.add_constraint(C);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000643 AccessRelation = AccessRelation.apply_range(Map);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000644 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000645}
646
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000647const std::string
648MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
649 switch (RT) {
650 case MemoryAccess::RT_NONE:
651 llvm_unreachable("Requested a reduction operator string for a memory "
652 "access which isn't a reduction");
653 case MemoryAccess::RT_ADD:
654 return "+";
655 case MemoryAccess::RT_MUL:
656 return "*";
657 case MemoryAccess::RT_BOR:
658 return "|";
659 case MemoryAccess::RT_BXOR:
660 return "^";
661 case MemoryAccess::RT_BAND:
662 return "&";
663 }
664 llvm_unreachable("Unknown reduction type");
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000665}
666
Michael Kruse2fa35192016-09-01 19:53:31 +0000667const ScopArrayInfo *MemoryAccess::getOriginalScopArrayInfo() const {
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000668 isl::id ArrayId = getArrayId();
669 void *User = ArrayId.get_user();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000670 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000671 return SAI;
672}
673
Michael Kruse2fa35192016-09-01 19:53:31 +0000674const ScopArrayInfo *MemoryAccess::getLatestScopArrayInfo() const {
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000675 isl::id ArrayId = getLatestArrayId();
676 void *User = ArrayId.get_user();
Michael Kruse2fa35192016-09-01 19:53:31 +0000677 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Michael Kruse2fa35192016-09-01 19:53:31 +0000678 return SAI;
679}
680
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000681isl::id MemoryAccess::getOriginalArrayId() const {
682 return AccessRelation.get_tuple_id(isl::dim::out);
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000683}
684
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000685isl::id MemoryAccess::getLatestArrayId() const {
Michael Kruse2fa35192016-09-01 19:53:31 +0000686 if (!hasNewAccessRelation())
687 return getOriginalArrayId();
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000688 return NewAccessRelation.get_tuple_id(isl::dim::out);
Michael Kruse2fa35192016-09-01 19:53:31 +0000689}
690
Tobias Grosser6a870362017-07-23 04:08:45 +0000691isl::map MemoryAccess::getAddressFunction() const {
692 return getAccessRelation().lexmin();
Tobias Grosserd840fc72016-02-04 13:18:42 +0000693}
694
Tobias Grosser3b196132017-07-23 04:08:52 +0000695isl::pw_multi_aff
696MemoryAccess::applyScheduleToAccessRelation(isl::union_map USchedule) const {
697 isl::map Schedule, ScheduledAccRel;
698 isl::union_set UDomain;
Johannes Doerferta99130f2014-10-13 12:58:03 +0000699
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000700 UDomain = getStatement()->getDomain();
Tobias Grosser3b196132017-07-23 04:08:52 +0000701 USchedule = USchedule.intersect_domain(UDomain);
702 Schedule = isl::map::from_union_map(USchedule);
703 ScheduledAccRel = getAddressFunction().apply_domain(Schedule);
704 return isl::pw_multi_aff::from_map(ScheduledAccRel);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000705}
706
Tobias Grosser22da5f02017-07-23 04:08:27 +0000707isl::map MemoryAccess::getOriginalAccessRelation() const {
708 return AccessRelation;
Tobias Grosser5d453812011-10-06 00:04:11 +0000709}
710
Johannes Doerferta99130f2014-10-13 12:58:03 +0000711std::string MemoryAccess::getOriginalAccessRelationStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000712 return AccessRelation.to_str();
Tobias Grosser5d453812011-10-06 00:04:11 +0000713}
714
Tobias Grosser22da5f02017-07-23 04:08:27 +0000715isl::space MemoryAccess::getOriginalAccessRelationSpace() const {
716 return AccessRelation.get_space();
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000717}
718
Tobias Grosser1515f6b2017-07-23 04:08:38 +0000719isl::map MemoryAccess::getNewAccessRelation() const {
720 return NewAccessRelation;
Tobias Grosser75805372011-04-29 06:27:02 +0000721}
722
Tobias Grosser6f730082015-09-05 07:46:47 +0000723std::string MemoryAccess::getNewAccessRelationStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000724 return NewAccessRelation.to_str();
Tobias Grosser6f730082015-09-05 07:46:47 +0000725}
726
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000727std::string MemoryAccess::getAccessRelationStr() const {
Tobias Grosser2b7479b2017-08-06 11:41:10 +0000728 return getAccessRelation().to_str();
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000729}
730
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000731isl::basic_map MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
732 isl::space Space = isl::space(Statement->getIslCtx(), 0, 1);
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000733 Space = Space.align_params(Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000734
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000735 return isl::basic_map::from_domain_and_range(
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000736 isl::basic_set::universe(Statement->getDomainSpace()),
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000737 isl::basic_set::universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000738}
739
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000740// Formalize no out-of-bound access assumption
741//
742// When delinearizing array accesses we optimistically assume that the
743// delinearized accesses do not access out of bound locations (the subscript
744// expression of each array evaluates for each statement instance that is
745// executed to a value that is larger than zero and strictly smaller than the
746// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000747// dimension for which we do not need to assume any upper bound. At this point
748// we formalize this assumption to ensure that at code generation time the
749// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000750//
751// To find the set of constraints necessary to avoid out of bound accesses, we
752// first build the set of data locations that are not within array bounds. We
753// then apply the reverse access relation to obtain the set of iterations that
754// may contain invalid accesses and reduce this set of iterations to the ones
755// that are actually executed by intersecting them with the domain of the
756// statement. If we now project out all loop dimensions, we obtain a set of
757// parameters that may cause statement instances to be executed that may
758// possibly yield out of bound memory accesses. The complement of these
759// constraints is the set of constraints that needs to be assumed to ensure such
760// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000761void MemoryAccess::assumeNoOutOfBound() {
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000762 if (PollyIgnoreInbounds)
763 return;
Johannes Doerfertadeab372016-02-07 13:57:32 +0000764 auto *SAI = getScopArrayInfo();
Tobias Grosser22da5f02017-07-23 04:08:27 +0000765 isl::space Space = getOriginalAccessRelationSpace().range();
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000766 isl::set Outside = isl::set::empty(Space);
767 for (int i = 1, Size = Space.dim(isl::dim::set); i < Size; ++i) {
768 isl::local_space LS(Space);
769 isl::pw_aff Var = isl::pw_aff::var_on_domain(LS, isl::dim::set, i);
770 isl::pw_aff Zero = isl::pw_aff(LS);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000771
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000772 isl::set DimOutside = Var.lt_set(Zero);
Tobias Grosser77eef902017-07-21 23:07:56 +0000773 isl::pw_aff SizeE = SAI->getDimensionSizePw(i);
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000774 SizeE = SizeE.add_dims(isl::dim::in, Space.dim(isl::dim::set));
775 SizeE = SizeE.set_tuple_id(isl::dim::in, Space.get_tuple_id(isl::dim::set));
776 DimOutside = DimOutside.unite(SizeE.le_set(Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000777
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000778 Outside = Outside.unite(DimOutside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000779 }
780
Tobias Grosser1515f6b2017-07-23 04:08:38 +0000781 Outside = Outside.apply(getAccessRelation().reverse());
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000782 Outside = Outside.intersect(Statement->getDomain());
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000783 Outside = Outside.params();
Tobias Grosserf54bb772015-06-26 12:09:28 +0000784
785 // Remove divs to avoid the construction of overly complicated assumptions.
786 // Doing so increases the set of parameter combinations that are assumed to
787 // not appear. This is always save, but may make the resulting run-time check
788 // bail out more often than strictly necessary.
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000789 Outside = Outside.remove_divs();
790 Outside = Outside.complement();
Michael Kruse7071e8b2016-04-11 13:24:29 +0000791 const auto &Loc = getAccessInstruction()
792 ? getAccessInstruction()->getDebugLoc()
793 : DebugLoc();
Tobias Grosserd7c49752017-02-28 09:45:54 +0000794 if (!PollyPreciseInbounds)
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000795 Outside = Outside.gist_params(Statement->getDomain().params());
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000796 Statement->getParent()->recordAssumption(INBOUNDS, Outside, Loc,
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000797 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000798}
799
Johannes Doerfertcea61932016-02-21 19:13:19 +0000800void MemoryAccess::buildMemIntrinsicAccessRelation() {
Johannes Doerfertc9765462016-11-17 22:11:56 +0000801 assert(isMemoryIntrinsic());
Roman Gareevf5aff702016-09-12 17:08:31 +0000802 assert(Subscripts.size() == 2 && Sizes.size() == 1);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000803
Tobias Grossercdf471b2017-07-24 16:36:34 +0000804 isl::pw_aff SubscriptPWA = getPwAff(Subscripts[0]);
Tobias Grosser53fc3552017-05-23 07:07:09 +0000805 isl::map SubscriptMap = isl::map::from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000806
Tobias Grosser53fc3552017-05-23 07:07:09 +0000807 isl::map LengthMap;
Johannes Doerferta7920982016-02-25 14:08:48 +0000808 if (Subscripts[1] == nullptr) {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000809 LengthMap = isl::map::universe(SubscriptMap.get_space());
Johannes Doerferta7920982016-02-25 14:08:48 +0000810 } else {
Tobias Grossercdf471b2017-07-24 16:36:34 +0000811 isl::pw_aff LengthPWA = getPwAff(Subscripts[1]);
Tobias Grosser53fc3552017-05-23 07:07:09 +0000812 LengthMap = isl::map::from_pw_aff(LengthPWA);
813 isl::space RangeSpace = LengthMap.get_space().range();
814 LengthMap = LengthMap.apply_range(isl::map::lex_gt(RangeSpace));
Johannes Doerferta7920982016-02-25 14:08:48 +0000815 }
Tobias Grosser53fc3552017-05-23 07:07:09 +0000816 LengthMap = LengthMap.lower_bound_si(isl::dim::out, 0, 0);
817 LengthMap = LengthMap.align_params(SubscriptMap.get_space());
818 SubscriptMap = SubscriptMap.align_params(LengthMap.get_space());
819 LengthMap = LengthMap.sum(SubscriptMap);
820 AccessRelation =
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000821 LengthMap.set_tuple_id(isl::dim::in, getStatement()->getDomainId());
Johannes Doerfertcea61932016-02-21 19:13:19 +0000822}
823
Johannes Doerferte7044942015-02-24 11:58:30 +0000824void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
825 ScalarEvolution *SE = Statement->getParent()->getSE();
826
Johannes Doerfertcea61932016-02-21 19:13:19 +0000827 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000828 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000829 return;
830
831 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000832 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
833 return;
834
835 auto *PtrSCEV = SE->getSCEV(Ptr);
836 if (isa<SCEVCouldNotCompute>(PtrSCEV))
837 return;
838
839 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
840 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
841 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
842
843 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
844 if (Range.isFullSet())
845 return;
846
Michael Kruse960c0d02017-05-18 21:55:36 +0000847 if (Range.isWrappedSet() || Range.isSignWrappedSet())
Tobias Grosserb3a85882017-02-12 08:11:12 +0000848 return;
849
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000850 bool isWrapping = Range.isSignWrappedSet();
Tobias Grosserb3a85882017-02-12 08:11:12 +0000851
Johannes Doerferte7044942015-02-24 11:58:30 +0000852 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000853 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000854 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000855 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000856
857 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000858 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000859
Tobias Grosserb3a85882017-02-12 08:11:12 +0000860 assert(Min.sle(Max) && "Minimum expected to be less or equal than max");
861
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000862 isl::map Relation = AccessRelation;
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000863 isl::set AccessRange = Relation.range();
864 AccessRange = addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0,
865 isl::dim::set);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000866 AccessRelation = Relation.intersect_range(AccessRange);
Johannes Doerferte7044942015-02-24 11:58:30 +0000867}
868
Tobias Grosser491b7992016-12-02 05:21:22 +0000869void MemoryAccess::foldAccessRelation() {
870 if (Sizes.size() < 2 || isa<SCEVConstant>(Sizes[1]))
871 return;
872
Michael Krusee2bccbb2015-09-18 19:59:43 +0000873 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000874
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000875 isl::map NewAccessRelation = AccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000876
Tobias Grosser619190d2015-03-30 17:22:28 +0000877 for (int i = Size - 2; i >= 0; --i) {
Tobias Grossera32de132017-05-23 07:22:56 +0000878 isl::space Space;
879 isl::map MapOne, MapTwo;
Tobias Grossercdf471b2017-07-24 16:36:34 +0000880 isl::pw_aff DimSize = getPwAff(Sizes[i + 1]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000881
Tobias Grossera32de132017-05-23 07:22:56 +0000882 isl::space SpaceSize = DimSize.get_space();
Tobias Grosserd3d3d6b2018-04-29 00:28:26 +0000883 isl::id ParamId = SpaceSize.get_dim_id(isl::dim::param, 0);
Tobias Grosser619190d2015-03-30 17:22:28 +0000884
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000885 Space = AccessRelation.get_space();
Tobias Grossera32de132017-05-23 07:22:56 +0000886 Space = Space.range().map_from_set();
887 Space = Space.align_params(SpaceSize);
Tobias Grosser619190d2015-03-30 17:22:28 +0000888
Tobias Grossera32de132017-05-23 07:22:56 +0000889 int ParamLocation = Space.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosser619190d2015-03-30 17:22:28 +0000890
Tobias Grossera32de132017-05-23 07:22:56 +0000891 MapOne = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000892 for (int j = 0; j < Size; ++j)
Tobias Grossera32de132017-05-23 07:22:56 +0000893 MapOne = MapOne.equate(isl::dim::in, j, isl::dim::out, j);
894 MapOne = MapOne.lower_bound_si(isl::dim::in, i + 1, 0);
Tobias Grosser619190d2015-03-30 17:22:28 +0000895
Tobias Grossera32de132017-05-23 07:22:56 +0000896 MapTwo = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000897 for (int j = 0; j < Size; ++j)
898 if (j < i || j > i + 1)
Tobias Grossera32de132017-05-23 07:22:56 +0000899 MapTwo = MapTwo.equate(isl::dim::in, j, isl::dim::out, j);
Tobias Grosser619190d2015-03-30 17:22:28 +0000900
Tobias Grossera32de132017-05-23 07:22:56 +0000901 isl::local_space LS(Space);
902 isl::constraint C;
903 C = isl::constraint::alloc_equality(LS);
904 C = C.set_constant_si(-1);
905 C = C.set_coefficient_si(isl::dim::in, i, 1);
906 C = C.set_coefficient_si(isl::dim::out, i, -1);
907 MapTwo = MapTwo.add_constraint(C);
908 C = isl::constraint::alloc_equality(LS);
909 C = C.set_coefficient_si(isl::dim::in, i + 1, 1);
910 C = C.set_coefficient_si(isl::dim::out, i + 1, -1);
911 C = C.set_coefficient_si(isl::dim::param, ParamLocation, 1);
912 MapTwo = MapTwo.add_constraint(C);
913 MapTwo = MapTwo.upper_bound_si(isl::dim::in, i + 1, -1);
Tobias Grosser619190d2015-03-30 17:22:28 +0000914
Tobias Grossera32de132017-05-23 07:22:56 +0000915 MapOne = MapOne.unite(MapTwo);
916 NewAccessRelation = NewAccessRelation.apply_range(MapOne);
Tobias Grosser619190d2015-03-30 17:22:28 +0000917 }
Tobias Grosser491b7992016-12-02 05:21:22 +0000918
Tobias Grosser77eef902017-07-21 23:07:56 +0000919 isl::id BaseAddrId = getScopArrayInfo()->getBasePtrId();
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000920 isl::space Space = Statement->getDomainSpace();
Tobias Grossera32de132017-05-23 07:22:56 +0000921 NewAccessRelation = NewAccessRelation.set_tuple_id(
922 isl::dim::in, Space.get_tuple_id(isl::dim::set));
923 NewAccessRelation = NewAccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000924 NewAccessRelation = NewAccessRelation.gist_domain(Statement->getDomain());
Tobias Grosserc2f15102017-03-01 21:11:27 +0000925
926 // Access dimension folding might in certain cases increase the number of
927 // disjuncts in the memory access, which can possibly complicate the generated
928 // run-time checks and can lead to costly compilation.
Tobias Grossera32de132017-05-23 07:22:56 +0000929 if (!PollyPreciseFoldAccesses &&
930 isl_map_n_basic_map(NewAccessRelation.get()) >
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000931 isl_map_n_basic_map(AccessRelation.get())) {
Tobias Grosserc2f15102017-03-01 21:11:27 +0000932 } else {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000933 AccessRelation = NewAccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000934 }
Tobias Grosser619190d2015-03-30 17:22:28 +0000935}
936
Tobias Grosserc80d6972016-09-02 06:33:33 +0000937/// Check if @p Expr is divisible by @p Size.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000938static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000939 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000940 if (Size == 1)
941 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000942
943 // Only one factor needs to be divisible.
944 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
945 for (auto *FactorExpr : MulExpr->operands())
946 if (isDivisible(FactorExpr, Size, SE))
947 return true;
948 return false;
949 }
950
951 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
Michael Krusea6d48f52017-06-08 12:06:15 +0000952 // to be divisible.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000953 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
954 for (auto *OpExpr : NAryExpr->operands())
955 if (!isDivisible(OpExpr, Size, SE))
956 return false;
957 return true;
958 }
959
960 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
961 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
962 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
963 return MulSCEV == Expr;
964}
965
Michael Krusee2bccbb2015-09-18 19:59:43 +0000966void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000967 assert(AccessRelation.is_null() && "AccessRelation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000968
Johannes Doerfert85676e32016-04-23 14:32:34 +0000969 // Initialize the invalid domain which describes all iterations for which the
970 // access relation is not modeled correctly.
Tobias Grosser2332fa32017-08-06 15:36:48 +0000971 isl::set StmtInvalidDomain = getStatement()->getInvalidDomain();
Tobias Grosserb739cb42017-07-24 20:30:34 +0000972 InvalidDomain = isl::set::empty(StmtInvalidDomain.get_space());
Johannes Doerfert85676e32016-04-23 14:32:34 +0000973
Tobias Grosserb739cb42017-07-24 20:30:34 +0000974 isl::ctx Ctx = Id.get_ctx();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000975 isl::id BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000976
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000977 if (getAccessInstruction() && isa<MemIntrinsic>(getAccessInstruction())) {
978 buildMemIntrinsicAccessRelation();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000979 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000980 return;
981 }
Johannes Doerfertcea61932016-02-21 19:13:19 +0000982
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000983 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000984 // We overapproximate non-affine accesses with a possible access to the
985 // whole array. For read accesses it does not make a difference, if an
986 // access must or may happen. However, for write accesses it is important to
987 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000988 if (AccessRelation.is_null())
989 AccessRelation = createBasicAccessMap(Statement);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000990
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000991 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000992 return;
993 }
994
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000995 isl::space Space = isl::space(Ctx, 0, Statement->getNumIterators(), 0);
996 AccessRelation = isl::map::universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000997
Michael Krusee2bccbb2015-09-18 19:59:43 +0000998 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Tobias Grossercdf471b2017-07-24 16:36:34 +0000999 isl::pw_aff Affine = getPwAff(Subscripts[i]);
1000 isl::map SubscriptMap = isl::map::from_pw_aff(Affine);
1001 AccessRelation = AccessRelation.flat_range_product(SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +00001002 }
1003
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001004 Space = Statement->getDomainSpace();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +00001005 AccessRelation = AccessRelation.set_tuple_id(
1006 isl::dim::in, Space.get_tuple_id(isl::dim::set));
1007 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Johannes Doerfert5d83f092014-07-29 08:37:55 +00001008
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001009 AccessRelation = AccessRelation.gist_domain(Statement->getDomain());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001010}
Tobias Grosser30b8a092011-08-18 07:51:37 +00001011
Michael Krusecac948e2015-10-02 13:53:07 +00001012MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00001013 AccessType AccType, Value *BaseAddress,
1014 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +00001015 ArrayRef<const SCEV *> Subscripts,
1016 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grosser72684bb2017-05-03 08:02:32 +00001017 MemoryKind Kind)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001018 : Kind(Kind), AccType(AccType), Statement(Stmt), InvalidDomain(nullptr),
1019 BaseAddr(BaseAddress), ElementType(ElementType),
Tobias Grosser81331282017-05-03 07:57:35 +00001020 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
1021 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +00001022 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001023 NewAccessRelation(nullptr), FAD(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +00001024 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001025 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001026
Tobias Grosser81331282017-05-03 07:57:35 +00001027 std::string IdName = Stmt->getBaseName() + Access;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001028 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName, this);
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001029}
Michael Krusee2bccbb2015-09-18 19:59:43 +00001030
Tobias Grosser1f6ba7e2017-07-24 16:22:32 +00001031MemoryAccess::MemoryAccess(ScopStmt *Stmt, AccessType AccType, isl::map AccRel)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001032 : Kind(MemoryKind::Array), AccType(AccType), Statement(Stmt),
1033 InvalidDomain(nullptr), AccessRelation(nullptr),
1034 NewAccessRelation(AccRel), FAD(nullptr) {
Tobias Grosser206e9e32017-07-24 16:22:27 +00001035 isl::id ArrayInfoId = NewAccessRelation.get_tuple_id(isl::dim::out);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001036 auto *SAI = ScopArrayInfo::getFromId(ArrayInfoId);
1037 Sizes.push_back(nullptr);
1038 for (unsigned i = 1; i < SAI->getNumberOfDimensions(); i++)
1039 Sizes.push_back(SAI->getDimensionSize(i));
1040 ElementType = SAI->getElementType();
1041 BaseAddr = SAI->getBasePtr();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001042 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001043 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Roman Gareevb3224ad2016-09-14 06:26:09 +00001044
Tobias Grosser81331282017-05-03 07:57:35 +00001045 std::string IdName = Stmt->getBaseName() + Access;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001046 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName, this);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001047}
1048
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001049MemoryAccess::~MemoryAccess() = default;
1050
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001051void MemoryAccess::realignParams() {
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00001052 isl::set Ctx = Statement->getParent()->getContext();
Tobias Grosserb739cb42017-07-24 20:30:34 +00001053 InvalidDomain = InvalidDomain.gist_params(Ctx);
1054 AccessRelation = AccessRelation.gist_params(Ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00001055}
1056
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001057const std::string MemoryAccess::getReductionOperatorStr() const {
1058 return MemoryAccess::getReductionOperatorStr(getReductionType());
1059}
1060
Tobias Grosserfe46c3f2017-07-23 04:08:11 +00001061isl::id MemoryAccess::getId() const { return Id; }
Tobias Grosser6f48e0f2015-05-15 09:58:32 +00001062
Johannes Doerfertf6183392014-07-01 20:52:51 +00001063raw_ostream &polly::operator<<(raw_ostream &OS,
1064 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001065 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +00001066 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001067 else
1068 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +00001069 return OS;
1070}
1071
Siddharth Bhat0fe72312017-05-15 08:41:30 +00001072void MemoryAccess::setFortranArrayDescriptor(Value *FAD) { this->FAD = FAD; }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001073
Tobias Grosser75805372011-04-29 06:27:02 +00001074void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +00001075 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001076 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001077 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001078 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001079 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001080 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001081 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001082 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001083 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001084 break;
1085 }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001086
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +00001087 OS << "[Reduction Type: " << getReductionType() << "] ";
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001088
1089 if (FAD) {
1090 OS << "[Fortran array descriptor: " << FAD->getName();
1091 OS << "] ";
1092 };
1093
Tobias Grossera535dff2015-12-13 19:59:01 +00001094 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +00001095 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +00001096 if (hasNewAccessRelation())
1097 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001098}
1099
Michael Kruse5d518462017-07-21 15:54:07 +00001100#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001101LLVM_DUMP_METHOD void MemoryAccess::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +00001102#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001103
Tobias Grossercdf471b2017-07-24 16:36:34 +00001104isl::pw_aff MemoryAccess::getPwAff(const SCEV *E) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001105 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +00001106 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001107 isl::set StmtDom = getStatement()->getDomain();
Tobias Grossercdf471b2017-07-24 16:36:34 +00001108 StmtDom = StmtDom.reset_tuple_id();
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001109 isl::set NewInvalidDom = StmtDom.intersect(PWAC.second);
Tobias Grosserb739cb42017-07-24 20:30:34 +00001110 InvalidDomain = InvalidDomain.unite(NewInvalidDom);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001111 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001112}
1113
Tobias Grosser75805372011-04-29 06:27:02 +00001114// Create a map in the size of the provided set domain, that maps from the
1115// one element of the provided set domain to another element of the provided
1116// set domain.
1117// The mapping is limited to all points that are equal in all but the last
1118// dimension and for which the last dimension of the input is strict smaller
1119// than the last dimension of the output.
1120//
1121// getEqualAndLarger(set[i0, i1, ..., iX]):
1122//
1123// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
1124// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
1125//
Tobias Grosserd7065e52017-07-24 20:50:22 +00001126static isl::map getEqualAndLarger(isl::space SetDomain) {
1127 isl::space Space = SetDomain.map_from_set();
1128 isl::map Map = isl::map::universe(Space);
1129 unsigned lastDimension = Map.dim(isl::dim::in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +00001130
1131 // Set all but the last dimension to be equal for the input and output
1132 //
1133 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
1134 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +00001135 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserd7065e52017-07-24 20:50:22 +00001136 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosser75805372011-04-29 06:27:02 +00001137
1138 // Set the last dimension of the input to be strict smaller than the
1139 // last dimension of the output.
1140 //
1141 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosserd7065e52017-07-24 20:50:22 +00001142 Map = Map.order_lt(isl::dim::in, lastDimension, isl::dim::out, lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +00001143 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +00001144}
1145
Tobias Grosserd7065e52017-07-24 20:50:22 +00001146isl::set MemoryAccess::getStride(isl::map Schedule) const {
1147 isl::map AccessRelation = getAccessRelation();
1148 isl::space Space = Schedule.get_space().range();
1149 isl::map NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +00001150
Tobias Grosserd7065e52017-07-24 20:50:22 +00001151 Schedule = Schedule.reverse();
1152 NextScatt = NextScatt.lexmin();
Tobias Grosser75805372011-04-29 06:27:02 +00001153
Tobias Grosserd7065e52017-07-24 20:50:22 +00001154 NextScatt = NextScatt.apply_range(Schedule);
1155 NextScatt = NextScatt.apply_range(AccessRelation);
1156 NextScatt = NextScatt.apply_domain(Schedule);
1157 NextScatt = NextScatt.apply_domain(AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +00001158
Tobias Grosserd7065e52017-07-24 20:50:22 +00001159 isl::set Deltas = NextScatt.deltas();
Sebastian Popa00a0292012-12-18 07:46:06 +00001160 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +00001161}
1162
Tobias Grosserd7065e52017-07-24 20:50:22 +00001163bool MemoryAccess::isStrideX(isl::map Schedule, int StrideWidth) const {
1164 isl::set Stride, StrideX;
Tobias Grosser28dd4862012-01-24 16:42:16 +00001165 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +00001166
Sebastian Popa00a0292012-12-18 07:46:06 +00001167 Stride = getStride(Schedule);
Tobias Grosserd7065e52017-07-24 20:50:22 +00001168 StrideX = isl::set::universe(Stride.get_space());
1169 for (unsigned i = 0; i < StrideX.dim(isl::dim::set) - 1; i++)
1170 StrideX = StrideX.fix_si(isl::dim::set, i, 0);
1171 StrideX = StrideX.fix_si(isl::dim::set, StrideX.dim(isl::dim::set) - 1,
1172 StrideWidth);
1173 IsStrideX = Stride.is_subset(StrideX);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001174
Tobias Grosser28dd4862012-01-24 16:42:16 +00001175 return IsStrideX;
1176}
1177
Tobias Grosserd7065e52017-07-24 20:50:22 +00001178bool MemoryAccess::isStrideZero(isl::map Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001179 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001180}
1181
Tobias Grosserd7065e52017-07-24 20:50:22 +00001182bool MemoryAccess::isStrideOne(isl::map Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001183 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001184}
1185
Tobias Grosser6d588042017-08-02 19:27:16 +00001186void MemoryAccess::setAccessRelation(isl::map NewAccess) {
1187 AccessRelation = NewAccess;
Tobias Grosserbedef002016-12-02 08:10:56 +00001188}
1189
Tobias Grosser7b45af12017-08-02 19:27:25 +00001190void MemoryAccess::setNewAccessRelation(isl::map NewAccess) {
Michael Kruse772ce722016-09-01 19:16:58 +00001191 assert(NewAccess);
1192
1193#ifndef NDEBUG
1194 // Check domain space compatibility.
Tobias Grosser7b45af12017-08-02 19:27:25 +00001195 isl::space NewSpace = NewAccess.get_space();
1196 isl::space NewDomainSpace = NewSpace.domain();
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001197 isl::space OriginalDomainSpace = getStatement()->getDomainSpace();
Tobias Grosser7b45af12017-08-02 19:27:25 +00001198 assert(OriginalDomainSpace.has_equal_tuples(NewDomainSpace));
Michael Kruse772ce722016-09-01 19:16:58 +00001199
Michael Kruse706f79a2017-05-21 22:46:57 +00001200 // Reads must be executed unconditionally. Writes might be executed in a
1201 // subdomain only.
1202 if (isRead()) {
1203 // Check whether there is an access for every statement instance.
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001204 isl::set StmtDomain = getStatement()->getDomain();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00001205 StmtDomain =
1206 StmtDomain.intersect_params(getStatement()->getParent()->getContext());
Tobias Grosser7b45af12017-08-02 19:27:25 +00001207 isl::set NewDomain = NewAccess.domain();
1208 assert(StmtDomain.is_subset(NewDomain) &&
Michael Kruse706f79a2017-05-21 22:46:57 +00001209 "Partial READ accesses not supported");
Michael Kruse706f79a2017-05-21 22:46:57 +00001210 }
Michael Kruse772ce722016-09-01 19:16:58 +00001211
Tobias Grosser7b45af12017-08-02 19:27:25 +00001212 isl::space NewAccessSpace = NewAccess.get_space();
1213 assert(NewAccessSpace.has_tuple_id(isl::dim::set) &&
Michael Kruse772ce722016-09-01 19:16:58 +00001214 "Must specify the array that is accessed");
Tobias Grosser7b45af12017-08-02 19:27:25 +00001215 isl::id NewArrayId = NewAccessSpace.get_tuple_id(isl::dim::set);
1216 auto *SAI = static_cast<ScopArrayInfo *>(NewArrayId.get_user());
Michael Kruse772ce722016-09-01 19:16:58 +00001217 assert(SAI && "Must set a ScopArrayInfo");
Tobias Grossere1ff0cf2017-01-17 12:00:42 +00001218
1219 if (SAI->isArrayKind() && SAI->getBasePtrOriginSAI()) {
1220 InvariantEquivClassTy *EqClass =
1221 getStatement()->getParent()->lookupInvariantEquivClass(
1222 SAI->getBasePtr());
1223 assert(EqClass &&
1224 "Access functions to indirect arrays must have an invariant and "
1225 "hoisted base pointer");
1226 }
1227
1228 // Check whether access dimensions correspond to number of dimensions of the
1229 // accesses array.
Michael Kruse772ce722016-09-01 19:16:58 +00001230 auto Dims = SAI->getNumberOfDimensions();
Tobias Grosser7b45af12017-08-02 19:27:25 +00001231 assert(NewAccessSpace.dim(isl::dim::set) == Dims &&
Michael Kruse772ce722016-09-01 19:16:58 +00001232 "Access dims must match array dims");
Michael Kruse772ce722016-09-01 19:16:58 +00001233#endif
1234
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001235 NewAccess = NewAccess.gist_domain(getStatement()->getDomain());
Tobias Grosser7b45af12017-08-02 19:27:25 +00001236 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001237}
Tobias Grosser75805372011-04-29 06:27:02 +00001238
Michael Kruse706f79a2017-05-21 22:46:57 +00001239bool MemoryAccess::isLatestPartialAccess() const {
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001240 isl::set StmtDom = getStatement()->getDomain();
Tobias Grosser1515f6b2017-07-23 04:08:38 +00001241 isl::set AccDom = getLatestAccessRelation().domain();
Michael Kruse706f79a2017-05-21 22:46:57 +00001242
Tobias Grosserd3d3d6b2018-04-29 00:28:26 +00001243 return !StmtDom.is_subset(AccDom);
Michael Kruse706f79a2017-05-21 22:46:57 +00001244}
1245
Tobias Grosser75805372011-04-29 06:27:02 +00001246//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001247
Tobias Grosser6ad16402017-08-06 17:45:28 +00001248isl::map ScopStmt::getSchedule() const {
Tobias Grosser1e09c132017-08-14 06:49:06 +00001249 isl::set Domain = getDomain();
1250 if (Domain.is_empty())
1251 return isl::map::from_aff(isl::aff(isl::local_space(getDomainSpace())));
1252 auto Schedule = getParent()->getSchedule();
1253 if (!Schedule)
Roman Gareevb3224ad2016-09-14 06:26:09 +00001254 return nullptr;
Tobias Grosser1e09c132017-08-14 06:49:06 +00001255 Schedule = Schedule.intersect_domain(isl::union_set(Domain));
1256 if (Schedule.is_empty())
1257 return isl::map::from_aff(isl::aff(isl::local_space(getDomainSpace())));
1258 isl::map M = M.from_union_map(Schedule);
1259 M = M.coalesce();
1260 M = M.gist_domain(Domain);
1261 M = M.coalesce();
1262 return M;
Tobias Grosser808cd692015-07-14 09:33:13 +00001263}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001264
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001265void ScopStmt::restrictDomain(isl::set NewDomain) {
1266 assert(NewDomain.is_subset(Domain) &&
Tobias Grosser37eb4222014-02-20 21:43:54 +00001267 "New domain is not a subset of old domain!");
Tobias Grosser37eb4222014-02-20 21:43:54 +00001268 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001269}
1270
Michael Kruse70af4f52017-08-07 18:40:29 +00001271void ScopStmt::addAccess(MemoryAccess *Access, bool Prepend) {
Michael Krusecac948e2015-10-02 13:53:07 +00001272 Instruction *AccessInst = Access->getAccessInstruction();
1273
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001274 if (Access->isArrayKind()) {
1275 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1276 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001277 } else if (Access->isValueKind() && Access->isWrite()) {
1278 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse436db622016-01-26 13:33:10 +00001279 assert(!ValueWrites.lookup(AccessVal));
1280
1281 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001282 } else if (Access->isValueKind() && Access->isRead()) {
1283 Value *AccessVal = Access->getAccessValue();
1284 assert(!ValueReads.lookup(AccessVal));
1285
1286 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001287 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
Tobias Grosser5db171a2017-02-10 10:09:44 +00001288 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001289 assert(!PHIWrites.lookup(PHI));
1290
1291 PHIWrites[PHI] = Access;
Michael Kruse3562f272017-07-20 16:47:57 +00001292 } else if (Access->isAnyPHIKind() && Access->isRead()) {
1293 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
1294 assert(!PHIReads.lookup(PHI));
1295
1296 PHIReads[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001297 }
1298
Michael Kruse70af4f52017-08-07 18:40:29 +00001299 if (Prepend) {
1300 MemAccs.insert(MemAccs.begin(), Access);
1301 return;
1302 }
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001303 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001304}
1305
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001306void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001307 for (MemoryAccess *MA : *this)
1308 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001309
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00001310 isl::set Ctx = Parent.getContext();
Tobias Grosser2332fa32017-08-06 15:36:48 +00001311 InvalidDomain = InvalidDomain.gist_params(Ctx);
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001312 Domain = Domain.gist_params(Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001313}
1314
Tobias Grosser78a84942018-06-01 19:12:00 +00001315/// Add @p BSet to set @p BoundedParts if @p BSet is bounded.
1316static isl::set collectBoundedParts(isl::set S) {
1317 isl::set BoundedParts = isl::set::empty(S.get_space());
1318 S.foreach_basic_set([&BoundedParts](isl::basic_set BSet) -> isl::stat {
1319 if (BSet.is_bounded()) {
1320 BoundedParts = BoundedParts.unite(isl::set(BSet));
1321 }
1322 return isl::stat::ok;
1323 });
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001324 return BoundedParts;
1325}
1326
Tobias Grosserc80d6972016-09-02 06:33:33 +00001327/// Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001328///
1329/// @returns A separation of @p S into first an unbounded then a bounded subset,
1330/// both with regards to the dimension @p Dim.
Tobias Grosser78a84942018-06-01 19:12:00 +00001331static std::pair<isl::set, isl::set> partitionSetParts(isl::set S,
1332 unsigned Dim) {
1333 for (unsigned u = 0, e = S.n_dim(); u < e; u++)
1334 S = S.lower_bound_si(isl::dim::set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001335
Tobias Grosser78a84942018-06-01 19:12:00 +00001336 unsigned NumDimsS = S.n_dim();
1337 isl::set OnlyDimS = S;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001338
1339 // Remove dimensions that are greater than Dim as they are not interesting.
1340 assert(NumDimsS >= Dim + 1);
Tobias Grosser78a84942018-06-01 19:12:00 +00001341 OnlyDimS = OnlyDimS.project_out(isl::dim::set, Dim + 1, NumDimsS - Dim - 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001342
1343 // Create artificial parametric upper bounds for dimensions smaller than Dim
1344 // as we are not interested in them.
Tobias Grosser78a84942018-06-01 19:12:00 +00001345 OnlyDimS = OnlyDimS.insert_dims(isl::dim::param, 0, Dim);
1346
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001347 for (unsigned u = 0; u < Dim; u++) {
Tobias Grosser78a84942018-06-01 19:12:00 +00001348 isl::constraint C = isl::constraint::alloc_inequality(
1349 isl::local_space(OnlyDimS.get_space()));
1350 C = C.set_coefficient_si(isl::dim::param, u, 1);
1351 C = C.set_coefficient_si(isl::dim::set, u, -1);
1352 OnlyDimS = OnlyDimS.add_constraint(C);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001353 }
1354
1355 // Collect all bounded parts of OnlyDimS.
Tobias Grosser78a84942018-06-01 19:12:00 +00001356 isl::set BoundedParts = collectBoundedParts(OnlyDimS);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001357
1358 // Create the dimensions greater than Dim again.
Tobias Grosser78a84942018-06-01 19:12:00 +00001359 BoundedParts =
1360 BoundedParts.insert_dims(isl::dim::set, Dim + 1, NumDimsS - Dim - 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001361
1362 // Remove the artificial upper bound parameters again.
Tobias Grosser78a84942018-06-01 19:12:00 +00001363 BoundedParts = BoundedParts.remove_dims(isl::dim::param, 0, Dim);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001364
Tobias Grosser78a84942018-06-01 19:12:00 +00001365 isl::set UnboundedParts = S.subtract(BoundedParts);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001366 return std::make_pair(UnboundedParts, BoundedParts);
1367}
1368
Tobias Grosserc80d6972016-09-02 06:33:33 +00001369/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001370static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001371 __isl_take isl_pw_aff *L,
1372 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001373 switch (Pred) {
1374 case ICmpInst::ICMP_EQ:
1375 return isl_pw_aff_eq_set(L, R);
1376 case ICmpInst::ICMP_NE:
1377 return isl_pw_aff_ne_set(L, R);
1378 case ICmpInst::ICMP_SLT:
1379 return isl_pw_aff_lt_set(L, R);
1380 case ICmpInst::ICMP_SLE:
1381 return isl_pw_aff_le_set(L, R);
1382 case ICmpInst::ICMP_SGT:
1383 return isl_pw_aff_gt_set(L, R);
1384 case ICmpInst::ICMP_SGE:
1385 return isl_pw_aff_ge_set(L, R);
1386 case ICmpInst::ICMP_ULT:
1387 return isl_pw_aff_lt_set(L, R);
1388 case ICmpInst::ICMP_UGT:
1389 return isl_pw_aff_gt_set(L, R);
1390 case ICmpInst::ICMP_ULE:
1391 return isl_pw_aff_le_set(L, R);
1392 case ICmpInst::ICMP_UGE:
1393 return isl_pw_aff_ge_set(L, R);
1394 default:
1395 llvm_unreachable("Non integer predicate not supported");
1396 }
1397}
1398
Michael Kruse476f8552017-06-29 12:47:41 +00001399/// Compute the isl representation for the SCEV @p E in this BB.
1400///
1401/// @param S The Scop in which @p BB resides in.
1402/// @param BB The BB for which isl representation is to be
1403/// computed.
1404/// @param InvalidDomainMap A map of BB to their invalid domains.
1405/// @param E The SCEV that should be translated.
1406/// @param NonNegative Flag to indicate the @p E has to be non-negative.
1407///
1408/// Note that this function will also adjust the invalid context accordingly.
1409
1410__isl_give isl_pw_aff *
1411getPwAff(Scop &S, BasicBlock *BB,
Tobias Grosser13acbb92017-07-15 09:01:31 +00001412 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap, const SCEV *E,
1413 bool NonNegative = false) {
Michael Kruse476f8552017-06-29 12:47:41 +00001414 PWACtx PWAC = S.getPwAff(E, BB, NonNegative);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001415 InvalidDomainMap[BB] = InvalidDomainMap[BB].unite(PWAC.second);
Tobias Grosser8dae41a2018-04-29 00:57:38 +00001416 return PWAC.first.release();
Michael Kruse476f8552017-06-29 12:47:41 +00001417}
1418
Tobias Grosserc80d6972016-09-02 06:33:33 +00001419/// Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001420///
1421/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001422/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1423/// have as many elements as @p SI has successors.
Tobias Grosseree457592017-09-24 09:25:30 +00001424bool buildConditionSets(Scop &S, BasicBlock *BB, SwitchInst *SI, Loop *L,
1425 __isl_keep isl_set *Domain,
1426 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1427 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001428 Value *Condition = getConditionFromTerminator(SI);
1429 assert(Condition && "No condition for switch");
1430
1431 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001432 isl_pw_aff *LHS, *RHS;
Michael Kruse476f8552017-06-29 12:47:41 +00001433 LHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001434
1435 unsigned NumSuccessors = SI->getNumSuccessors();
1436 ConditionSets.resize(NumSuccessors);
1437 for (auto &Case : SI->cases()) {
1438 unsigned Idx = Case.getSuccessorIndex();
1439 ConstantInt *CaseValue = Case.getCaseValue();
1440
Michael Kruse476f8552017-06-29 12:47:41 +00001441 RHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001442 isl_set *CaseConditionSet =
Tobias Grosserb9486302018-03-03 19:27:54 +00001443 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001444 ConditionSets[Idx] = isl_set_coalesce(
1445 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1446 }
1447
1448 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1449 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1450 for (unsigned u = 2; u < NumSuccessors; u++)
1451 ConditionSetUnion =
1452 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
Tobias Grosserb9486302018-03-03 19:27:54 +00001453 ConditionSets[0] = isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001454
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001455 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001456
1457 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001458}
1459
Michael Kruse08655852017-07-20 12:37:02 +00001460/// Build condition sets for unsigned ICmpInst(s).
1461/// Special handling is required for unsigned operands to ensure that if
1462/// MSB (aka the Sign bit) is set for an operands in an unsigned ICmpInst
1463/// it should wrap around.
1464///
1465/// @param IsStrictUpperBound holds information on the predicate relation
1466/// between TestVal and UpperBound, i.e,
1467/// TestVal < UpperBound OR TestVal <= UpperBound
Tobias Grosseree457592017-09-24 09:25:30 +00001468__isl_give isl_set *
Michael Kruse08655852017-07-20 12:37:02 +00001469buildUnsignedConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1470 __isl_keep isl_set *Domain, const SCEV *SCEV_TestVal,
1471 const SCEV *SCEV_UpperBound,
1472 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1473 bool IsStrictUpperBound) {
Michael Kruse08655852017-07-20 12:37:02 +00001474 // Do not take NonNeg assumption on TestVal
1475 // as it might have MSB (Sign bit) set.
1476 isl_pw_aff *TestVal = getPwAff(S, BB, InvalidDomainMap, SCEV_TestVal, false);
1477 // Take NonNeg assumption on UpperBound.
1478 isl_pw_aff *UpperBound =
1479 getPwAff(S, BB, InvalidDomainMap, SCEV_UpperBound, true);
1480
1481 // 0 <= TestVal
1482 isl_set *First =
1483 isl_pw_aff_le_set(isl_pw_aff_zero_on_domain(isl_local_space_from_space(
1484 isl_pw_aff_get_domain_space(TestVal))),
1485 isl_pw_aff_copy(TestVal));
1486
1487 isl_set *Second;
1488 if (IsStrictUpperBound)
1489 // TestVal < UpperBound
1490 Second = isl_pw_aff_lt_set(TestVal, UpperBound);
1491 else
1492 // TestVal <= UpperBound
1493 Second = isl_pw_aff_le_set(TestVal, UpperBound);
1494
1495 isl_set *ConsequenceCondSet = isl_set_intersect(First, Second);
Michael Kruse08655852017-07-20 12:37:02 +00001496 return ConsequenceCondSet;
1497}
1498
Tobias Grosserc80d6972016-09-02 06:33:33 +00001499/// Build the conditions sets for the branch condition @p Condition in
1500/// the @p Domain.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001501///
1502/// This will fill @p ConditionSets with the conditions under which control
1503/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001504/// have as many elements as @p TI has successors. If @p TI is nullptr the
1505/// context under which @p Condition is true/false will be returned as the
1506/// new elements of @p ConditionSets.
Tobias Grosseree457592017-09-24 09:25:30 +00001507bool buildConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1508 TerminatorInst *TI, Loop *L, __isl_keep isl_set *Domain,
1509 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1510 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Tobias Grosser5e531df2017-09-25 20:27:15 +00001511 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001512 isl_set *ConsequenceCondSet = nullptr;
Tobias Grosser0a62b2d2017-09-25 16:37:15 +00001513
Tobias Grosser5e531df2017-09-25 20:27:15 +00001514 if (auto Load = dyn_cast<LoadInst>(Condition)) {
1515 const SCEV *LHSSCEV = SE.getSCEVAtScope(Load, L);
1516 const SCEV *RHSSCEV = SE.getZero(LHSSCEV->getType());
1517 bool NonNeg = false;
1518 isl_pw_aff *LHS = getPwAff(S, BB, InvalidDomainMap, LHSSCEV, NonNeg);
1519 isl_pw_aff *RHS = getPwAff(S, BB, InvalidDomainMap, RHSSCEV, NonNeg);
Tobias Grosserb9486302018-03-03 19:27:54 +00001520 ConsequenceCondSet = buildConditionSet(ICmpInst::ICMP_SLE, LHS, RHS);
Tobias Grosser5e531df2017-09-25 20:27:15 +00001521 } else if (auto *PHI = dyn_cast<PHINode>(Condition)) {
Tobias Grosser0a62b2d2017-09-25 16:37:15 +00001522 auto *Unique = dyn_cast<ConstantInt>(
1523 getUniqueNonErrorValue(PHI, &S.getRegion(), *S.getLI(), *S.getDT()));
1524
1525 if (Unique->isZero())
1526 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1527 else
1528 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1529 } else if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001530 if (CCond->isZero())
1531 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1532 else
1533 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1534 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1535 auto Opcode = BinOp->getOpcode();
1536 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1537
Michael Kruse476f8552017-06-29 12:47:41 +00001538 bool Valid = buildConditionSets(S, BB, BinOp->getOperand(0), TI, L, Domain,
1539 InvalidDomainMap, ConditionSets) &&
1540 buildConditionSets(S, BB, BinOp->getOperand(1), TI, L, Domain,
1541 InvalidDomainMap, ConditionSets);
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001542 if (!Valid) {
1543 while (!ConditionSets.empty())
1544 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001545 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001546 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001547
1548 isl_set_free(ConditionSets.pop_back_val());
1549 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1550 isl_set_free(ConditionSets.pop_back_val());
1551 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1552
1553 if (Opcode == Instruction::And)
1554 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1555 else
1556 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1557 } else {
1558 auto *ICond = dyn_cast<ICmpInst>(Condition);
1559 assert(ICond &&
1560 "Condition of exiting branch was neither constant nor ICmp!");
1561
Tobias Grosseree457592017-09-24 09:25:30 +00001562 LoopInfo &LI = *S.getLI();
1563 DominatorTree &DT = *S.getDT();
1564 Region &R = S.getRegion();
1565
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001566 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001567 // For unsigned comparisons we assumed the signed bit of neither operand
1568 // to be set. The comparison is equal to a signed comparison under this
1569 // assumption.
1570 bool NonNeg = ICond->isUnsigned();
Michael Kruse08655852017-07-20 12:37:02 +00001571 const SCEV *LeftOperand = SE.getSCEVAtScope(ICond->getOperand(0), L),
1572 *RightOperand = SE.getSCEVAtScope(ICond->getOperand(1), L);
1573
Tobias Grosseree457592017-09-24 09:25:30 +00001574 LeftOperand = tryForwardThroughPHI(LeftOperand, R, SE, LI, DT);
1575 RightOperand = tryForwardThroughPHI(RightOperand, R, SE, LI, DT);
1576
Michael Kruse08655852017-07-20 12:37:02 +00001577 switch (ICond->getPredicate()) {
1578 case ICmpInst::ICMP_ULT:
1579 ConsequenceCondSet =
1580 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1581 RightOperand, InvalidDomainMap, true);
1582 break;
1583 case ICmpInst::ICMP_ULE:
1584 ConsequenceCondSet =
1585 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1586 RightOperand, InvalidDomainMap, false);
1587 break;
1588 case ICmpInst::ICMP_UGT:
1589 ConsequenceCondSet =
1590 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1591 LeftOperand, InvalidDomainMap, true);
1592 break;
1593 case ICmpInst::ICMP_UGE:
1594 ConsequenceCondSet =
1595 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1596 LeftOperand, InvalidDomainMap, false);
1597 break;
1598 default:
1599 LHS = getPwAff(S, BB, InvalidDomainMap, LeftOperand, NonNeg);
1600 RHS = getPwAff(S, BB, InvalidDomainMap, RightOperand, NonNeg);
Tobias Grosserb9486302018-03-03 19:27:54 +00001601 ConsequenceCondSet = buildConditionSet(ICond->getPredicate(), LHS, RHS);
Michael Kruse08655852017-07-20 12:37:02 +00001602 break;
1603 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001604 }
1605
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001606 // If no terminator was given we are only looking for parameter constraints
1607 // under which @p Condition is true/false.
1608 if (!TI)
1609 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001610 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001611 ConsequenceCondSet = isl_set_coalesce(
1612 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001613
Johannes Doerfertb2885792016-04-26 09:20:41 +00001614 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001615 bool TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001616 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001617
Michael Krusef7a4a942016-05-02 12:25:36 +00001618 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001619 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1620 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001621 TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001622 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001623 }
1624
Michael Krusef7a4a942016-05-02 12:25:36 +00001625 if (TooComplex) {
Eli Friedmane737fc12017-07-17 23:58:33 +00001626 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc(),
1627 TI ? TI->getParent() : nullptr /* BasicBlock */);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001628 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001629 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001630 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001631 }
1632
1633 ConditionSets.push_back(ConsequenceCondSet);
1634 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001635
1636 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001637}
1638
Tobias Grosserc80d6972016-09-02 06:33:33 +00001639/// Build the conditions sets for the terminator @p TI in the @p Domain.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001640///
1641/// This will fill @p ConditionSets with the conditions under which control
1642/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1643/// have as many elements as @p TI has successors.
Tobias Grosseree457592017-09-24 09:25:30 +00001644bool buildConditionSets(Scop &S, BasicBlock *BB, TerminatorInst *TI, Loop *L,
1645 __isl_keep isl_set *Domain,
1646 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1647 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001648 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Michael Kruse476f8552017-06-29 12:47:41 +00001649 return buildConditionSets(S, BB, SI, L, Domain, InvalidDomainMap,
1650 ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001651
1652 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1653
1654 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001655 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001656 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001657 }
1658
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001659 Value *Condition = getConditionFromTerminator(TI);
1660 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001661
Michael Kruse476f8552017-06-29 12:47:41 +00001662 return buildConditionSets(S, BB, Condition, TI, L, Domain, InvalidDomainMap,
1663 ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001664}
1665
Michael Krused6e22082018-01-18 15:15:38 +00001666ScopStmt::ScopStmt(Scop &parent, Region &R, StringRef Name,
1667 Loop *SurroundingLoop,
Tobias Grosserbd15d132017-08-31 03:15:56 +00001668 std::vector<Instruction *> EntryBlockInstructions)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001669 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), R(&R),
Michael Krused6e22082018-01-18 15:15:38 +00001670 Build(nullptr), BaseName(Name), SurroundingLoop(SurroundingLoop),
1671 Instructions(EntryBlockInstructions) {}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001672
Michael Krused6e22082018-01-18 15:15:38 +00001673ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb, StringRef Name,
1674 Loop *SurroundingLoop,
1675 std::vector<Instruction *> Instructions)
Johannes Doerferta3519512016-04-23 13:02:23 +00001676 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
Michael Krused6e22082018-01-18 15:15:38 +00001677 Build(nullptr), BaseName(Name), SurroundingLoop(SurroundingLoop),
1678 Instructions(Instructions) {}
Michael Krusecac948e2015-10-02 13:53:07 +00001679
Tobias Grosser85048ef2017-08-06 17:24:59 +00001680ScopStmt::ScopStmt(Scop &parent, isl::map SourceRel, isl::map TargetRel,
1681 isl::set NewDomain)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001682 : Parent(parent), InvalidDomain(nullptr), Domain(NewDomain),
1683 Build(nullptr) {
Roman Gareevb3224ad2016-09-14 06:26:09 +00001684 BaseName = getIslCompatibleName("CopyStmt_", "",
1685 std::to_string(parent.getCopyStmtsNum()));
Tobias Grosser85048ef2017-08-06 17:24:59 +00001686 isl::id Id = isl::id::alloc(getIslCtx(), getBaseName(), this);
1687 Domain = Domain.set_tuple_id(Id);
1688 TargetRel = TargetRel.set_tuple_id(isl::dim::in, Id);
1689 auto *Access =
1690 new MemoryAccess(this, MemoryAccess::AccessType::MUST_WRITE, TargetRel);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001691 parent.addAccessFunction(Access);
1692 addAccess(Access);
Tobias Grosser85048ef2017-08-06 17:24:59 +00001693 SourceRel = SourceRel.set_tuple_id(isl::dim::in, Id);
1694 Access = new MemoryAccess(this, MemoryAccess::AccessType::READ, SourceRel);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001695 parent.addAccessFunction(Access);
1696 addAccess(Access);
1697}
1698
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001699ScopStmt::~ScopStmt() = default;
1700
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001701std::string ScopStmt::getDomainStr() const { return Domain.to_str(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001702
Tobias Grosser54839312015-04-21 11:37:25 +00001703std::string ScopStmt::getScheduleStr() const {
Tobias Grosser6ad16402017-08-06 17:45:28 +00001704 auto *S = getSchedule().release();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001705 if (!S)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001706 return {};
Tobias Grosser808cd692015-07-14 09:33:13 +00001707 auto Str = stringFromIslObj(S);
1708 isl_map_free(S);
1709 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001710}
1711
Tobias Grosser2332fa32017-08-06 15:36:48 +00001712void ScopStmt::setInvalidDomain(isl::set ID) { InvalidDomain = ID; }
Johannes Doerfert7c013572016-04-12 09:57:34 +00001713
Michael Kruse375cb5f2016-02-24 22:08:24 +00001714BasicBlock *ScopStmt::getEntryBlock() const {
1715 if (isBlockStmt())
1716 return getBasicBlock();
1717 return getRegion()->getEntry();
1718}
1719
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001720unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001721
Tobias Grosser75805372011-04-29 06:27:02 +00001722const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1723
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001724Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001725 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001726}
1727
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00001728isl::ctx ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001729
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001730isl::set ScopStmt::getDomain() const { return Domain; }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001731
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001732isl::space ScopStmt::getDomainSpace() const { return Domain.get_space(); }
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001733
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001734isl::id ScopStmt::getDomainId() const { return Domain.get_tuple_id(); }
Tobias Grossercd95b772012-08-30 11:49:38 +00001735
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001736void ScopStmt::printInstructions(raw_ostream &OS) const {
1737 OS << "Instructions {\n";
1738
1739 for (Instruction *Inst : Instructions)
1740 OS.indent(16) << *Inst << "\n";
1741
Michael Krusee52ebd12017-07-22 16:44:39 +00001742 OS.indent(12) << "}\n";
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001743}
1744
Michael Krusecd4c9772017-07-21 15:35:53 +00001745void ScopStmt::print(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00001746 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001747 OS.indent(12) << "Domain :=\n";
1748
1749 if (Domain) {
1750 OS.indent(16) << getDomainStr() << ";\n";
1751 } else
1752 OS.indent(16) << "n/a\n";
1753
Tobias Grosser54839312015-04-21 11:37:25 +00001754 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001755
1756 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001757 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001758 } else
1759 OS.indent(16) << "n/a\n";
1760
Tobias Grosser083d3d32014-06-28 08:59:45 +00001761 for (MemoryAccess *Access : MemAccs)
1762 Access->print(OS);
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001763
Tobias Grosserbd15d132017-08-31 03:15:56 +00001764 if (PrintInstructions)
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001765 printInstructions(OS.indent(12));
Tobias Grosser75805372011-04-29 06:27:02 +00001766}
1767
Michael Kruse5d518462017-07-21 15:54:07 +00001768#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001769LLVM_DUMP_METHOD void ScopStmt::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00001770#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001771
Michael Krusee60eca72017-05-11 22:56:12 +00001772void ScopStmt::removeAccessData(MemoryAccess *MA) {
1773 if (MA->isRead() && MA->isOriginalValueKind()) {
1774 bool Found = ValueReads.erase(MA->getAccessValue());
1775 (void)Found;
1776 assert(Found && "Expected access data not found");
1777 }
1778 if (MA->isWrite() && MA->isOriginalValueKind()) {
1779 bool Found = ValueWrites.erase(cast<Instruction>(MA->getAccessValue()));
1780 (void)Found;
1781 assert(Found && "Expected access data not found");
1782 }
1783 if (MA->isWrite() && MA->isOriginalAnyPHIKind()) {
1784 bool Found = PHIWrites.erase(cast<PHINode>(MA->getAccessInstruction()));
1785 (void)Found;
1786 assert(Found && "Expected access data not found");
1787 }
Michael Kruse3562f272017-07-20 16:47:57 +00001788 if (MA->isRead() && MA->isOriginalAnyPHIKind()) {
1789 bool Found = PHIReads.erase(cast<PHINode>(MA->getAccessInstruction()));
1790 (void)Found;
1791 assert(Found && "Expected access data not found");
1792 }
Michael Krusee60eca72017-05-11 22:56:12 +00001793}
1794
Michael Kruse10071822016-05-23 14:45:58 +00001795void ScopStmt::removeMemoryAccess(MemoryAccess *MA) {
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001796 // Remove the memory accesses from this statement together with all scalar
1797 // accesses that were caused by it. MemoryKind::Value READs have no access
1798 // instruction, hence would not be removed by this function. However, it is
1799 // only used for invariant LoadInst accesses, its arguments are always affine,
1800 // hence synthesizable, and therefore there are no MemoryKind::Value READ
1801 // accesses to be removed.
Michael Kruse10071822016-05-23 14:45:58 +00001802 auto Predicate = [&](MemoryAccess *Acc) {
1803 return Acc->getAccessInstruction() == MA->getAccessInstruction();
1804 };
Michael Krusee60eca72017-05-11 22:56:12 +00001805 for (auto *MA : MemAccs) {
Michael Kruse8b805802017-07-19 17:11:25 +00001806 if (Predicate(MA)) {
Michael Krusee60eca72017-05-11 22:56:12 +00001807 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00001808 Parent.removeAccessData(MA);
1809 }
Michael Krusee60eca72017-05-11 22:56:12 +00001810 }
Michael Kruse10071822016-05-23 14:45:58 +00001811 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1812 MemAccs.end());
1813 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001814}
1815
Michael Kruse192e7f72018-04-09 23:13:05 +00001816void ScopStmt::removeSingleMemoryAccess(MemoryAccess *MA, bool AfterHoisting) {
1817 if (AfterHoisting) {
1818 auto MAIt = std::find(MemAccs.begin(), MemAccs.end(), MA);
1819 assert(MAIt != MemAccs.end());
1820 MemAccs.erase(MAIt);
Michael Kruse0446d812017-03-10 16:05:24 +00001821
Michael Kruse192e7f72018-04-09 23:13:05 +00001822 removeAccessData(MA);
1823 Parent.removeAccessData(MA);
1824 }
Michael Krusee60eca72017-05-11 22:56:12 +00001825
Michael Kruse0446d812017-03-10 16:05:24 +00001826 auto It = InstructionToAccess.find(MA->getAccessInstruction());
1827 if (It != InstructionToAccess.end()) {
1828 It->second.remove(MA);
1829 if (It->second.empty())
1830 InstructionToAccess.erase(MA->getAccessInstruction());
1831 }
1832}
1833
Michael Kruse07e8c362017-07-24 12:43:27 +00001834MemoryAccess *ScopStmt::ensureValueRead(Value *V) {
1835 MemoryAccess *Access = lookupInputAccessOf(V);
1836 if (Access)
1837 return Access;
1838
1839 ScopArrayInfo *SAI =
1840 Parent.getOrCreateScopArrayInfo(V, V->getType(), {}, MemoryKind::Value);
1841 Access = new MemoryAccess(this, nullptr, MemoryAccess::READ, V, V->getType(),
1842 true, {}, {}, V, MemoryKind::Value);
1843 Parent.addAccessFunction(Access);
1844 Access->buildAccessRelation(SAI);
1845 addAccess(Access);
1846 Parent.addAccessData(Access);
1847 return Access;
1848}
1849
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001850raw_ostream &polly::operator<<(raw_ostream &OS, const ScopStmt &S) {
1851 S.print(OS, PollyPrintInstructions);
1852 return OS;
Michael Krusecd4c9772017-07-21 15:35:53 +00001853}
1854
Tobias Grosser75805372011-04-29 06:27:02 +00001855//===----------------------------------------------------------------------===//
1856/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001857
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00001858void Scop::setContext(isl::set NewContext) {
1859 Context = NewContext.align_params(Context.get_space());
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001860}
1861
Eli Friedman5e589ea2017-06-20 22:53:02 +00001862namespace {
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001863
Tobias Grosserc80d6972016-09-02 06:33:33 +00001864/// Remap parameter values but keep AddRecs valid wrt. invariant loads.
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001865struct SCEVSensitiveParameterRewriter
Tobias Grosser278f9e72016-11-26 17:58:40 +00001866 : public SCEVRewriteVisitor<SCEVSensitiveParameterRewriter> {
Tobias Grosserb5563c62017-08-03 13:51:15 +00001867 const ValueToValueMap &VMap;
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001868
1869public:
Tobias Grosserb5563c62017-08-03 13:51:15 +00001870 SCEVSensitiveParameterRewriter(const ValueToValueMap &VMap,
1871 ScalarEvolution &SE)
Tobias Grosser278f9e72016-11-26 17:58:40 +00001872 : SCEVRewriteVisitor(SE), VMap(VMap) {}
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001873
1874 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
Tobias Grosserb5563c62017-08-03 13:51:15 +00001875 const ValueToValueMap &VMap) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001876 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1877 return SSPR.visit(E);
1878 }
1879
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001880 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1881 auto *Start = visit(E->getStart());
1882 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1883 visit(E->getStepRecurrence(SE)),
1884 E->getLoop(), SCEV::FlagAnyWrap);
1885 return SE.getAddExpr(Start, AddRec);
1886 }
1887
1888 const SCEV *visitUnknown(const SCEVUnknown *E) {
1889 if (auto *NewValue = VMap.lookup(E->getValue()))
1890 return SE.getUnknown(NewValue);
1891 return E;
1892 }
1893};
1894
Eli Friedman5e589ea2017-06-20 22:53:02 +00001895/// Check whether we should remap a SCEV expression.
1896struct SCEVFindInsideScop : public SCEVTraversal<SCEVFindInsideScop> {
Tobias Grosserb5563c62017-08-03 13:51:15 +00001897 const ValueToValueMap &VMap;
Eli Friedman5e589ea2017-06-20 22:53:02 +00001898 bool FoundInside = false;
Tobias Grosserb5563c62017-08-03 13:51:15 +00001899 const Scop *S;
Eli Friedman5e589ea2017-06-20 22:53:02 +00001900
1901public:
Tobias Grosserb5563c62017-08-03 13:51:15 +00001902 SCEVFindInsideScop(const ValueToValueMap &VMap, ScalarEvolution &SE,
1903 const Scop *S)
Eli Friedman5e589ea2017-06-20 22:53:02 +00001904 : SCEVTraversal(*this), VMap(VMap), S(S) {}
1905
1906 static bool hasVariant(const SCEV *E, ScalarEvolution &SE,
Tobias Grosserb5563c62017-08-03 13:51:15 +00001907 const ValueToValueMap &VMap, const Scop *S) {
Eli Friedman5e589ea2017-06-20 22:53:02 +00001908 SCEVFindInsideScop SFIS(VMap, SE, S);
1909 SFIS.visitAll(E);
1910 return SFIS.FoundInside;
1911 }
1912
1913 bool follow(const SCEV *E) {
1914 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(E)) {
1915 FoundInside |= S->getRegion().contains(AddRec->getLoop());
1916 } else if (auto *Unknown = dyn_cast<SCEVUnknown>(E)) {
1917 if (Instruction *I = dyn_cast<Instruction>(Unknown->getValue()))
1918 FoundInside |= S->getRegion().contains(I) && !VMap.count(I);
1919 }
1920 return !FoundInside;
1921 }
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001922
Eli Friedman5e589ea2017-06-20 22:53:02 +00001923 bool isDone() { return FoundInside; }
1924};
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001925} // end anonymous namespace
Eli Friedman5e589ea2017-06-20 22:53:02 +00001926
Tobias Grosserb5563c62017-08-03 13:51:15 +00001927const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *E) const {
Eli Friedman5e589ea2017-06-20 22:53:02 +00001928 // Check whether it makes sense to rewrite the SCEV. (ScalarEvolution
1929 // doesn't like addition between an AddRec and an expression that
1930 // doesn't have a dominance relationship with it.)
1931 if (SCEVFindInsideScop::hasVariant(E, *SE, InvEquivClassVMap, this))
1932 return E;
1933
1934 // Rewrite SCEV.
1935 return SCEVSensitiveParameterRewriter::rewrite(E, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001936}
1937
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001938// This table of function names is used to translate parameter names in more
1939// human-readable names. This makes it easier to interpret Polly analysis
1940// results.
1941StringMap<std::string> KnownNames = {
1942 {"_Z13get_global_idj", "global_id"},
1943 {"_Z12get_local_idj", "local_id"},
1944 {"_Z15get_global_sizej", "global_size"},
1945 {"_Z14get_local_sizej", "local_size"},
1946 {"_Z12get_work_dimv", "work_dim"},
1947 {"_Z17get_global_offsetj", "global_offset"},
1948 {"_Z12get_group_idj", "group_id"},
1949 {"_Z14get_num_groupsj", "num_groups"},
1950};
1951
1952static std::string getCallParamName(CallInst *Call) {
1953 std::string Result;
1954 raw_string_ostream OS(Result);
1955 std::string Name = Call->getCalledFunction()->getName();
1956
1957 auto Iterator = KnownNames.find(Name);
1958 if (Iterator != KnownNames.end())
Tobias Grosserdff902f2017-06-01 12:46:51 +00001959 Name = "__" + Iterator->getValue();
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001960 OS << Name;
1961 for (auto &Operand : Call->arg_operands()) {
1962 ConstantInt *Op = cast<ConstantInt>(&Operand);
1963 OS << "_" << Op->getValue();
1964 }
1965 OS.flush();
1966 return Result;
1967}
1968
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001969void Scop::createParameterId(const SCEV *Parameter) {
1970 assert(Parameters.count(Parameter));
1971 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001972
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001973 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001974
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001975 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1976 Value *Val = ValueParameter->getValue();
1977 CallInst *Call = dyn_cast<CallInst>(Val);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001978
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001979 if (Call && isConstCall(Call)) {
1980 ParameterName = getCallParamName(Call);
1981 } else if (UseInstructionNames) {
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001982 // If this parameter references a specific Value and this value has a name
1983 // we use this name as it is likely to be unique and more useful than just
1984 // a number.
1985 if (Val->hasName())
1986 ParameterName = Val->getName();
1987 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
1988 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
1989 if (LoadOrigin->hasName()) {
1990 ParameterName += "_loaded_from_";
1991 ParameterName +=
1992 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1993 }
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001994 }
1995 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001996
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001997 ParameterName = getIslCompatibleName("", ParameterName, "");
1998 }
Tobias Grosser2ea7c6e2016-07-01 13:40:28 +00001999
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002000 isl::id Id = isl::id::alloc(getIslCtx(), ParameterName,
Tobias Grosser6e78cc62017-08-13 17:54:51 +00002001 const_cast<void *>((const void *)Parameter));
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002002 ParameterIds[Parameter] = Id;
2003}
2004
2005void Scop::addParams(const ParameterSetTy &NewParameters) {
2006 for (const SCEV *Parameter : NewParameters) {
2007 // Normalize the SCEV to get the representing element for an invariant load.
2008 Parameter = extractConstantFactor(Parameter, *SE).second;
2009 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2010
2011 if (Parameters.insert(Parameter))
2012 createParameterId(Parameter);
2013 }
2014}
2015
Tobias Grosser9a635702017-08-06 19:31:27 +00002016isl::id Scop::getIdForParam(const SCEV *Parameter) const {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002017 // Normalize the SCEV to get the representing element for an invariant load.
2018 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
Tobias Grosser6e78cc62017-08-13 17:54:51 +00002019 return ParameterIds.lookup(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00002020}
Tobias Grosser75805372011-04-29 06:27:02 +00002021
Tobias Grosser232fdad2017-08-06 20:19:26 +00002022isl::set Scop::addNonEmptyDomainConstraints(isl::set C) const {
Tobias Grosser31df6f32017-08-06 21:42:25 +00002023 isl_set *DomainContext = isl_union_set_params(getDomains().release());
Tobias Grosser232fdad2017-08-06 20:19:26 +00002024 return isl::manage(isl_set_intersect_params(C.release(), DomainContext));
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002025}
2026
Johannes Doerferte0b08072016-05-23 12:43:44 +00002027bool Scop::isDominatedBy(const DominatorTree &DT, BasicBlock *BB) const {
2028 return DT.dominates(BB, getEntry());
2029}
2030
Michael Kruse476f8552017-06-29 12:47:41 +00002031void Scop::addUserAssumptions(
2032 AssumptionCache &AC, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002033 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse89b1f942017-03-17 13:56:53 +00002034 for (auto &Assumption : AC.assumptions()) {
2035 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
2036 if (!CI || CI->getNumArgOperands() != 1)
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002037 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00002038
Michael Kruse89b1f942017-03-17 13:56:53 +00002039 bool InScop = contains(CI);
2040 if (!InScop && !isDominatedBy(DT, CI->getParent()))
2041 continue;
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002042
Michael Kruse89b1f942017-03-17 13:56:53 +00002043 auto *L = LI.getLoopFor(CI->getParent());
2044 auto *Val = CI->getArgOperand(0);
2045 ParameterSetTy DetectedParams;
2046 if (!isAffineConstraint(Val, &R, L, *SE, DetectedParams)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00002047 ORE.emit(
2048 OptimizationRemarkAnalysis(DEBUG_TYPE, "IgnoreUserAssumption", CI)
2049 << "Non-affine user assumption ignored.");
Michael Kruse89b1f942017-03-17 13:56:53 +00002050 continue;
Michael Kruse7037fde2016-12-15 09:25:14 +00002051 }
Michael Kruse89b1f942017-03-17 13:56:53 +00002052
2053 // Collect all newly introduced parameters.
2054 ParameterSetTy NewParams;
2055 for (auto *Param : DetectedParams) {
2056 Param = extractConstantFactor(Param, *SE).second;
2057 Param = getRepresentingInvariantLoadSCEV(Param);
2058 if (Parameters.count(Param))
2059 continue;
2060 NewParams.insert(Param);
2061 }
2062
2063 SmallVector<isl_set *, 2> ConditionSets;
2064 auto *TI = InScop ? CI->getParent()->getTerminator() : nullptr;
Michael Kruse1df1aac2017-07-26 13:25:28 +00002065 BasicBlock *BB = InScop ? CI->getParent() : getRegion().getEntry();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002066 auto *Dom = InScop ? DomainMap[BB].copy() : Context.copy();
Michael Kruse1df1aac2017-07-26 13:25:28 +00002067 assert(Dom && "Cannot propagate a nullptr.");
2068 bool Valid = buildConditionSets(*this, BB, Val, TI, L, Dom,
2069 InvalidDomainMap, ConditionSets);
Michael Kruse89b1f942017-03-17 13:56:53 +00002070 isl_set_free(Dom);
2071
2072 if (!Valid)
2073 continue;
2074
2075 isl_set *AssumptionCtx = nullptr;
2076 if (InScop) {
2077 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
2078 isl_set_free(ConditionSets[0]);
2079 } else {
2080 AssumptionCtx = isl_set_complement(ConditionSets[1]);
2081 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
2082 }
2083
2084 // Project out newly introduced parameters as they are not otherwise useful.
2085 if (!NewParams.empty()) {
2086 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
2087 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
2088 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
2089 isl_id_free(Id);
2090
2091 if (!NewParams.count(Param))
2092 continue;
2093
2094 AssumptionCtx =
2095 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
2096 }
2097 }
Eli Friedmane737fc12017-07-17 23:58:33 +00002098 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "UserAssumption", CI)
2099 << "Use user assumption: " << stringFromIslObj(AssumptionCtx));
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002100 Context = Context.intersect(isl::manage(AssumptionCtx));
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002101 }
2102}
2103
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002104void Scop::addUserContext() {
2105 if (UserContextStr.empty())
2106 return;
2107
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002108 isl::set UserContext = isl::set(getIslCtx(), UserContextStr.c_str());
2109 isl::space Space = getParamSpace();
2110 if (Space.dim(isl::dim::param) != UserContext.dim(isl::dim::param)) {
2111 std::string SpaceStr = Space.to_str();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002112 errs() << "Error: the context provided in -polly-context has not the same "
2113 << "number of dimensions than the computed context. Due to this "
2114 << "mismatch, the -polly-context option is ignored. Please provide "
2115 << "the context in the parameter space: " << SpaceStr << ".\n";
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002116 return;
2117 }
2118
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002119 for (unsigned i = 0; i < Space.dim(isl::dim::param); i++) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002120 std::string NameContext = Context.get_dim_name(isl::dim::param, i);
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002121 std::string NameUserContext = UserContext.get_dim_name(isl::dim::param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002122
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002123 if (NameContext != NameUserContext) {
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002124 std::string SpaceStr = Space.to_str();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002125 errs() << "Error: the name of dimension " << i
2126 << " provided in -polly-context "
2127 << "is '" << NameUserContext << "', but the name in the computed "
2128 << "context is '" << NameContext
2129 << "'. Due to this name mismatch, "
2130 << "the -polly-context option is ignored. Please provide "
2131 << "the context in the parameter space: " << SpaceStr << ".\n";
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002132 return;
2133 }
2134
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002135 UserContext = UserContext.set_dim_id(isl::dim::param, i,
2136 Space.get_dim_id(isl::dim::param, i));
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002137 }
2138
Tobias Grosser9b9c7012018-05-28 07:45:25 +00002139 Context = Context.intersect(UserContext);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002140}
2141
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002142void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002143 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002144
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002145 const InvariantLoadsSetTy &RIL = getRequiredInvariantLoads();
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002146 for (LoadInst *LInst : RIL) {
2147 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2148
Johannes Doerfert96e54712016-02-07 17:30:13 +00002149 Type *Ty = LInst->getType();
2150 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002151 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002152 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002153 continue;
2154 }
2155
2156 ClassRep = LInst;
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00002157 InvariantEquivClasses.emplace_back(
2158 InvariantEquivClassTy{PointerSCEV, MemoryAccessList(), nullptr, Ty});
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002159 }
2160}
2161
Tobias Grosser6be480c2011-11-08 15:41:13 +00002162void Scop::buildContext() {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002163 isl::space Space = isl::space::params_alloc(getIslCtx(), 0);
2164 Context = isl::set::universe(Space);
2165 InvalidContext = isl::set::empty(Space);
2166 AssumedContext = isl::set::universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002167}
2168
Tobias Grosser18daaca2012-05-22 10:47:27 +00002169void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002170 unsigned PDim = 0;
2171 for (auto *Parameter : Parameters) {
2172 ConstantRange SRange = SE->getSignedRange(Parameter);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002173 Context = addRangeBoundsToSet(Context, SRange, PDim++, isl::dim::param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00002174 }
2175}
2176
Tobias Grosserb5563c62017-08-03 13:51:15 +00002177static std::vector<isl::id> getFortranArrayIds(Scop::array_range Arrays) {
2178 std::vector<isl::id> OutermostSizeIds;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002179 for (auto Array : Arrays) {
2180 // To check if an array is a Fortran array, we check if it has a isl_pw_aff
2181 // for its outermost dimension. Fortran arrays will have this since the
2182 // outermost dimension size can be picked up from their runtime description.
2183 // TODO: actually need to check if it has a FAD, but for now this works.
2184 if (Array->getNumberOfDimensions() > 0) {
Tobias Grosserb5563c62017-08-03 13:51:15 +00002185 isl::pw_aff PwAff = Array->getDimensionSizePw(0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002186 if (!PwAff)
2187 continue;
2188
Tobias Grosserb5563c62017-08-03 13:51:15 +00002189 isl::id Id =
2190 isl::manage(isl_pw_aff_get_dim_id(PwAff.get(), isl_dim_param, 0));
2191 assert(!Id.is_null() &&
2192 "Invalid Id for PwAff expression in Fortran array");
2193 Id.dump();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002194 OutermostSizeIds.push_back(Id);
2195 }
2196 }
Tobias Grosserb5563c62017-08-03 13:51:15 +00002197 return OutermostSizeIds;
2198}
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002199
Tobias Grosserb5563c62017-08-03 13:51:15 +00002200// The FORTRAN array size parameters are known to be non-negative.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002201static isl::set boundFortranArrayParams(isl::set Context,
Tobias Grosserb5563c62017-08-03 13:51:15 +00002202 Scop::array_range Arrays) {
2203 std::vector<isl::id> OutermostSizeIds;
2204 OutermostSizeIds = getFortranArrayIds(Arrays);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002205
Tobias Grosserb5563c62017-08-03 13:51:15 +00002206 for (isl::id Id : OutermostSizeIds) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002207 int dim = Context.find_dim_by_id(isl::dim::param, Id);
2208 Context = Context.lower_bound_si(isl::dim::param, dim, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002209 }
2210
2211 return Context;
2212}
2213
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002214void Scop::realignParams() {
Tobias Grosser5842dee2017-03-17 13:00:53 +00002215 if (PollyIgnoreParamBounds)
2216 return;
2217
Tobias Grosser6be480c2011-11-08 15:41:13 +00002218 // Add all parameters into a common model.
Tobias Grosserb5563c62017-08-03 13:51:15 +00002219 isl::space Space = getFullParamSpace();
Tobias Grosser6be480c2011-11-08 15:41:13 +00002220
2221 // Align the parameters of all data structures to the model.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002222 Context = Context.align_params(Space);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002223
Tobias Grosserb5563c62017-08-03 13:51:15 +00002224 // Bound the size of the fortran array dimensions.
2225 Context = boundFortranArrayParams(Context, arrays());
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002226
Johannes Doerferta60ad842016-05-10 12:18:22 +00002227 // As all parameters are known add bounds to them.
2228 addParameterBounds();
2229
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002230 for (ScopStmt &Stmt : *this)
2231 Stmt.realignParams();
Johannes Doerfert06445ded2016-06-02 15:07:41 +00002232 // Simplify the schedule according to the context too.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002233 Schedule = Schedule.gist_domain_params(getContext());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002234}
2235
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002236static isl::set simplifyAssumptionContext(isl::set AssumptionContext,
2237 const Scop &S) {
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002238 // If we have modeled all blocks in the SCoP that have side effects we can
2239 // simplify the context with the constraints that are needed for anything to
2240 // be executed at all. However, if we have error blocks in the SCoP we already
2241 // assumed some parameter combinations cannot occur and removed them from the
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002242 // domains, thus we cannot use the remaining domain to simplify the
2243 // assumptions.
2244 if (!S.hasErrorBlock()) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002245 auto DomainParameters = S.getDomains().params();
2246 AssumptionContext = AssumptionContext.gist_params(DomainParameters);
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002247 }
2248
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002249 AssumptionContext = AssumptionContext.gist_params(S.getContext());
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002250 return AssumptionContext;
2251}
2252
2253void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002254 // The parameter constraints of the iteration domains give us a set of
2255 // constraints that need to hold for all cases where at least a single
2256 // statement iteration is executed in the whole scop. We now simplify the
2257 // assumed context under the assumption that such constraints hold and at
2258 // least a single statement iteration is executed. For cases where no
2259 // statement instances are executed, the assumptions we have taken about
2260 // the executed code do not matter and can be changed.
2261 //
2262 // WARNING: This only holds if the assumptions we have taken do not reduce
2263 // the set of statement instances that are executed. Otherwise we
2264 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002265 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002266 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002267 // performed. In such a case, modifying the run-time conditions and
2268 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002269 // to not be executed.
2270 //
2271 // Example:
2272 //
2273 // When delinearizing the following code:
2274 //
2275 // for (long i = 0; i < 100; i++)
2276 // for (long j = 0; j < m; j++)
2277 // A[i+p][j] = 1.0;
2278 //
2279 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002280 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002281 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002282 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002283 InvalidContext = InvalidContext.align_params(getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002284}
2285
Tobias Grosserc80d6972016-09-02 06:33:33 +00002286/// Add the minimal/maximal access in @p Set to @p User.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002287static isl::stat
2288buildMinMaxAccess(isl::set Set, Scop::MinMaxVectorTy &MinMaxAccesses, Scop &S) {
2289 isl::pw_multi_aff MinPMA, MaxPMA;
2290 isl::pw_aff LastDimAff;
2291 isl::aff OneAff;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002292 unsigned Pos;
2293
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002294 Set = Set.remove_divs();
Michael Krusee3300712018-05-09 16:23:56 +00002295 polly::simplify(Set);
Johannes Doerfert6296d952016-04-22 11:38:19 +00002296
Philip Pfaffe9375d572018-05-16 14:05:03 +00002297 if (Set.n_basic_set() > RunTimeChecksMaxAccessDisjuncts)
Michael Krusee3300712018-05-09 16:23:56 +00002298 Set = Set.simple_hull();
Johannes Doerfert6296d952016-04-22 11:38:19 +00002299
Johannes Doerfert9143d672014-09-27 11:02:39 +00002300 // Restrict the number of parameters involved in the access as the lexmin/
2301 // lexmax computation will take too long if this number is high.
2302 //
2303 // Experiments with a simple test case using an i7 4800MQ:
2304 //
2305 // #Parameters involved | Time (in sec)
2306 // 6 | 0.01
2307 // 7 | 0.04
2308 // 8 | 0.12
2309 // 9 | 0.40
2310 // 10 | 1.54
2311 // 11 | 6.78
2312 // 12 | 30.38
2313 //
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002314 if (isl_set_n_param(Set.get()) > RunTimeChecksMaxParameters) {
Johannes Doerfert9143d672014-09-27 11:02:39 +00002315 unsigned InvolvedParams = 0;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002316 for (unsigned u = 0, e = isl_set_n_param(Set.get()); u < e; u++)
2317 if (Set.involves_dims(isl::dim::param, u, 1))
Johannes Doerfert9143d672014-09-27 11:02:39 +00002318 InvolvedParams++;
2319
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002320 if (InvolvedParams > RunTimeChecksMaxParameters)
2321 return isl::stat::error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002322 }
2323
Tobias Grosser57a1d362017-06-23 08:05:27 +00002324 MinPMA = Set.lexmin_pw_multi_aff();
2325 MaxPMA = Set.lexmax_pw_multi_aff();
Tobias Grosser45e9fd12017-05-19 03:45:00 +00002326
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002327 MinPMA = MinPMA.coalesce();
2328 MaxPMA = MaxPMA.coalesce();
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002329
Johannes Doerfertb164c792014-09-18 11:17:17 +00002330 // Adjust the last dimension of the maximal access by one as we want to
2331 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2332 // we test during code generation might now point after the end of the
2333 // allocated array but we will never dereference it anyway.
Michael Krusee3300712018-05-09 16:23:56 +00002334 assert((!MaxPMA || MaxPMA.dim(isl::dim::out)) &&
2335 "Assumed at least one output dimension");
2336
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002337 Pos = MaxPMA.dim(isl::dim::out) - 1;
2338 LastDimAff = MaxPMA.get_pw_aff(Pos);
2339 OneAff = isl::aff(isl::local_space(LastDimAff.get_domain_space()));
2340 OneAff = OneAff.add_constant_si(1);
2341 LastDimAff = LastDimAff.add(OneAff);
2342 MaxPMA = MaxPMA.set_pw_aff(Pos, LastDimAff);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002343
Michael Krusee3300712018-05-09 16:23:56 +00002344 if (!MinPMA || !MaxPMA)
2345 return isl::stat::error;
2346
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002347 MinMaxAccesses.push_back(std::make_pair(MinPMA, MaxPMA));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002348
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002349 return isl::stat::ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002350}
2351
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002352static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
Tobias Grosserdcf8d692017-08-06 16:39:52 +00002353 isl_set *Domain = MA->getStatement()->getDomain().release();
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002354 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2355 return isl_set_reset_tuple_id(Domain);
2356}
2357
Tobias Grosserc80d6972016-09-02 06:33:33 +00002358/// Wrapper function to calculate minimal/maximal accesses to each array.
Tobias Grossere9522232017-01-16 15:49:04 +00002359static bool calculateMinMaxAccess(Scop::AliasGroupTy AliasGroup, Scop &S,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002360 Scop::MinMaxVectorTy &MinMaxAccesses) {
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002361 MinMaxAccesses.reserve(AliasGroup.size());
Tobias Grossere9522232017-01-16 15:49:04 +00002362
Tobias Grosser31df6f32017-08-06 21:42:25 +00002363 isl::union_set Domains = S.getDomains();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00002364 isl::union_map Accesses = isl::union_map::empty(S.getParamSpace());
Tobias Grossere9522232017-01-16 15:49:04 +00002365
2366 for (MemoryAccess *MA : AliasGroup)
Tobias Grosserd3d3d6b2018-04-29 00:28:26 +00002367 Accesses = Accesses.add_map(MA->getAccessRelation());
Tobias Grossere9522232017-01-16 15:49:04 +00002368
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002369 Accesses = Accesses.intersect_domain(Domains);
2370 isl::union_set Locations = Accesses.range();
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002371
2372 auto Lambda = [&MinMaxAccesses, &S](isl::set Set) -> isl::stat {
2373 return buildMinMaxAccess(Set, MinMaxAccesses, S);
2374 };
2375 return Locations.foreach_set(Lambda) == isl::stat::ok;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002376}
2377
Tobias Grosserc80d6972016-09-02 06:33:33 +00002378/// Helper to treat non-affine regions and basic blocks the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002379///
2380///{
2381
Tobias Grosserc80d6972016-09-02 06:33:33 +00002382/// Return the block that is the representing block for @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002383static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2384 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2385 : RN->getNodeAs<BasicBlock>();
2386}
2387
Tobias Grosserc80d6972016-09-02 06:33:33 +00002388/// Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002389static inline BasicBlock *
2390getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002391 if (RN->isSubRegion()) {
2392 assert(idx == 0);
2393 return RN->getNodeAs<Region>()->getExit();
2394 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002395 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002396}
2397
Tobias Grosserc80d6972016-09-02 06:33:33 +00002398/// Return the smallest loop surrounding @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002399static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002400 if (!RN->isSubRegion()) {
2401 BasicBlock *BB = RN->getNodeAs<BasicBlock>();
2402 Loop *L = LI.getLoopFor(BB);
2403
2404 // Unreachable statements are not considered to belong to a LLVM loop, as
2405 // they are not part of an actual loop in the control flow graph.
2406 // Nevertheless, we handle certain unreachable statements that are common
2407 // when modeling run-time bounds checks as being part of the loop to be
2408 // able to model them and to later eliminate the run-time bounds checks.
2409 //
2410 // Specifically, for basic blocks that terminate in an unreachable and
Michael Krusea6d48f52017-06-08 12:06:15 +00002411 // where the immediate predecessor is part of a loop, we assume these
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002412 // basic blocks belong to the loop the predecessor belongs to. This
2413 // allows us to model the following code.
2414 //
2415 // for (i = 0; i < N; i++) {
2416 // if (i > 1024)
2417 // abort(); <- this abort might be translated to an
2418 // unreachable
2419 //
2420 // A[i] = ...
2421 // }
2422 if (!L && isa<UnreachableInst>(BB->getTerminator()) && BB->getPrevNode())
2423 L = LI.getLoopFor(BB->getPrevNode());
2424 return L;
2425 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002426
2427 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2428 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2429 while (L && NonAffineSubRegion->contains(L))
2430 L = L->getParentLoop();
2431 return L;
2432}
2433
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002434/// Get the number of blocks in @p L.
2435///
2436/// The number of blocks in a loop are the number of basic blocks actually
2437/// belonging to the loop, as well as all single basic blocks that the loop
2438/// exits to and which terminate in an unreachable instruction. We do not
2439/// allow such basic blocks in the exit of a scop, hence they belong to the
2440/// scop and represent run-time conditions which we want to model and
2441/// subsequently speculate away.
2442///
2443/// @see getRegionNodeLoop for additional details.
Reid Klecknerdf2b2832017-06-19 17:44:02 +00002444unsigned getNumBlocksInLoop(Loop *L) {
2445 unsigned NumBlocks = L->getNumBlocks();
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002446 SmallVector<BasicBlock *, 4> ExitBlocks;
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002447 L->getExitBlocks(ExitBlocks);
2448
2449 for (auto ExitBlock : ExitBlocks) {
2450 if (isa<UnreachableInst>(ExitBlock->getTerminator()))
2451 NumBlocks++;
2452 }
2453 return NumBlocks;
2454}
2455
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002456static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2457 if (!RN->isSubRegion())
2458 return 1;
2459
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002460 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002461 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002462}
2463
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002464static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2465 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002466 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002467 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002468 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002469 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002470 return true;
2471 return false;
2472}
2473
Johannes Doerfert96425c22015-08-30 21:13:53 +00002474///}
2475
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002476isl::set Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002477 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002478}
2479
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002480isl::set Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002481 auto DIt = DomainMap.find(BB);
2482 if (DIt != DomainMap.end())
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002483 return DIt->getSecond();
Johannes Doerfert41cda152016-04-08 10:32:26 +00002484
2485 auto &RI = *R.getRegionInfo();
2486 auto *BBR = RI.getRegionFor(BB);
2487 while (BBR->getEntry() == BB)
2488 BBR = BBR->getParent();
2489 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002490}
2491
Tobias Grosser13acbb92017-07-15 09:01:31 +00002492bool Scop::buildDomains(Region *R, DominatorTree &DT, LoopInfo &LI,
2493 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002494 bool IsOnlyNonAffineRegion = isNonAffineSubRegion(R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002495 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002496 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2497 int LD = getRelativeLoopDepth(L);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002498 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx().get(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002499
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002500 while (LD-- >= 0) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002501 L = L->getParentLoop();
2502 }
2503
Tobias Grosser13acbb92017-07-15 09:01:31 +00002504 InvalidDomainMap[EntryBB] = isl::manage(isl_set_empty(isl_set_get_space(S)));
Tobias Grosser325204a32017-07-15 12:41:32 +00002505 DomainMap[EntryBB] = isl::manage(S);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002506
Johannes Doerfert432658d2016-01-26 11:01:41 +00002507 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002508 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002509
Michael Kruse476f8552017-06-29 12:47:41 +00002510 if (!buildDomainsWithBranchConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002511 return false;
2512
Michael Kruse476f8552017-06-29 12:47:41 +00002513 if (!propagateDomainConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002514 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002515
2516 // Error blocks and blocks dominated by them have been assumed to never be
2517 // executed. Representing them in the Scop does not add any value. In fact,
2518 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002519 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002520 // will cause problems when building up a ScopStmt for them.
2521 // Furthermore, basic blocks dominated by error blocks may reference
2522 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002523 // can themselves not be constructed properly. To this end we will replace
2524 // the domains of error blocks and those only reachable via error blocks
2525 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002526 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002527 // InvalidDomain. This information is needed during load hoisting.
Michael Kruse476f8552017-06-29 12:47:41 +00002528 if (!propagateInvalidStmtDomains(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002529 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002530
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002531 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002532}
2533
Tobias Grosserc80d6972016-09-02 06:33:33 +00002534/// Adjust the dimensions of @p Dom that was constructed for @p OldL
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002535/// to be compatible to domains constructed for loop @p NewL.
2536///
2537/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2538/// edge from @p OldL to @p NewL.
2539static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2540 __isl_take isl_set *Dom,
2541 Loop *OldL, Loop *NewL) {
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002542 // If the loops are the same there is nothing to do.
2543 if (NewL == OldL)
2544 return Dom;
2545
2546 int OldDepth = S.getRelativeLoopDepth(OldL);
2547 int NewDepth = S.getRelativeLoopDepth(NewL);
2548 // If both loops are non-affine loops there is nothing to do.
2549 if (OldDepth == -1 && NewDepth == -1)
2550 return Dom;
2551
2552 // Distinguish three cases:
2553 // 1) The depth is the same but the loops are not.
2554 // => One loop was left one was entered.
2555 // 2) The depth increased from OldL to NewL.
2556 // => One loop was entered, none was left.
2557 // 3) The depth decreased from OldL to NewL.
2558 // => Loops were left were difference of the depths defines how many.
2559 if (OldDepth == NewDepth) {
2560 assert(OldL->getParentLoop() == NewL->getParentLoop());
2561 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2562 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002563 } else if (OldDepth < NewDepth) {
2564 assert(OldDepth + 1 == NewDepth);
2565 auto &R = S.getRegion();
2566 (void)R;
2567 assert(NewL->getParentLoop() == OldL ||
2568 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2569 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002570 } else {
2571 assert(OldDepth > NewDepth);
2572 int Diff = OldDepth - NewDepth;
2573 int NumDim = isl_set_n_dim(Dom);
2574 assert(NumDim >= Diff);
2575 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2576 }
2577
2578 return Dom;
2579}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002580
Michael Kruse476f8552017-06-29 12:47:41 +00002581bool Scop::propagateInvalidStmtDomains(
2582 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002583 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002584 ReversePostOrderTraversal<Region *> RTraversal(R);
2585 for (auto *RN : RTraversal) {
2586
2587 // Recurse for affine subregions but go on for basic blocks and non-affine
2588 // subregions.
2589 if (RN->isSubRegion()) {
2590 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002591 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002592 propagateInvalidStmtDomains(SubRegion, DT, LI, InvalidDomainMap);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002593 continue;
2594 }
2595 }
2596
2597 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2598 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002599 isl::set &Domain = DomainMap[BB];
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002600 assert(Domain && "Cannot propagate a nullptr");
2601
Tobias Grosser325204a32017-07-15 12:41:32 +00002602 isl::set InvalidDomain = InvalidDomainMap[BB];
Michael Kruse476f8552017-06-29 12:47:41 +00002603
Tobias Grosser325204a32017-07-15 12:41:32 +00002604 bool IsInvalidBlock = ContainsErrorBlock || Domain.is_subset(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002605
Johannes Doerferta3519512016-04-23 13:02:23 +00002606 if (!IsInvalidBlock) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002607 InvalidDomain = InvalidDomain.intersect(Domain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002608 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002609 InvalidDomain = Domain;
Tobias Grosser325204a32017-07-15 12:41:32 +00002610 isl::set DomPar = Domain.params();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002611 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2612 AS_RESTRICTION);
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002613 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002614 }
2615
Tobias Grosser325204a32017-07-15 12:41:32 +00002616 if (InvalidDomain.is_empty()) {
2617 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002618 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002619 }
2620
Johannes Doerferta3519512016-04-23 13:02:23 +00002621 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002622 auto *TI = BB->getTerminator();
2623 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2624 for (unsigned u = 0; u < NumSuccs; u++) {
2625 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002626
2627 // Skip successors outside the SCoP.
Michael Kruse476f8552017-06-29 12:47:41 +00002628 if (!contains(SuccBB))
Johannes Doerfert7c013572016-04-12 09:57:34 +00002629 continue;
2630
Johannes Doerferte4459a22016-04-25 13:34:50 +00002631 // Skip backedges.
2632 if (DT.dominates(SuccBB, BB))
2633 continue;
2634
Michael Kruse476f8552017-06-29 12:47:41 +00002635 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2636
Philip Pfaffe9375d572018-05-16 14:05:03 +00002637 auto AdjustedInvalidDomain = isl::manage(adjustDomainDimensions(
2638 *this, InvalidDomain.copy(), BBLoop, SuccBBLoop));
Michael Kruse476f8552017-06-29 12:47:41 +00002639
Philip Pfaffe9375d572018-05-16 14:05:03 +00002640 isl::set SuccInvalidDomain = InvalidDomainMap[SuccBB];
2641 SuccInvalidDomain = SuccInvalidDomain.unite(AdjustedInvalidDomain);
2642 SuccInvalidDomain = SuccInvalidDomain.coalesce();
2643 unsigned NumConjucts = SuccInvalidDomain.n_basic_set();
Michael Kruse476f8552017-06-29 12:47:41 +00002644
Philip Pfaffe9375d572018-05-16 14:05:03 +00002645 InvalidDomainMap[SuccBB] = SuccInvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002646
Michael Krusebc150122016-05-02 12:25:18 +00002647 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002648 // In case this happens we will bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00002649 if (NumConjucts < MaxDisjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002650 continue;
2651
Tobias Grosserf44f0052017-07-09 15:47:17 +00002652 InvalidDomainMap.erase(BB);
Eli Friedmane737fc12017-07-17 23:58:33 +00002653 invalidate(COMPLEXITY, TI->getDebugLoc(), TI->getParent());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002654 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002655 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002656
Tobias Grosser325204a32017-07-15 12:41:32 +00002657 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002658 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002659
2660 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002661}
2662
Johannes Doerfert642594a2016-04-04 07:57:39 +00002663void Scop::propagateDomainConstraintsToRegionExit(
2664 BasicBlock *BB, Loop *BBLoop,
Michael Kruse476f8552017-06-29 12:47:41 +00002665 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002666 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002667 // Check if the block @p BB is the entry of a region. If so we propagate it's
2668 // domain to the exit block of the region. Otherwise we are done.
2669 auto *RI = R.getRegionInfo();
2670 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2671 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002672 if (!BBReg || BBReg->getEntry() != BB || !contains(ExitBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002673 return;
2674
Johannes Doerfert642594a2016-04-04 07:57:39 +00002675 // Do not propagate the domain if there is a loop backedge inside the region
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002676 // that would prevent the exit block from being executed.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002677 auto *L = BBLoop;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002678 while (L && contains(L)) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002679 SmallVector<BasicBlock *, 4> LatchBBs;
2680 BBLoop->getLoopLatches(LatchBBs);
2681 for (auto *LatchBB : LatchBBs)
2682 if (BB != LatchBB && BBReg->contains(LatchBB))
2683 return;
2684 L = L->getParentLoop();
2685 }
2686
Tobias Grosser325204a32017-07-15 12:41:32 +00002687 isl::set Domain = DomainMap[BB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002688 assert(Domain && "Cannot propagate a nullptr");
2689
Michael Kruse476f8552017-06-29 12:47:41 +00002690 Loop *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002691
2692 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2693 // adjust the domain before we can propagate it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002694 isl::set AdjustedDomain = isl::manage(
2695 adjustDomainDimensions(*this, Domain.copy(), BBLoop, ExitBBLoop));
2696 isl::set &ExitDomain = DomainMap[ExitBB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002697
2698 // If the exit domain is not yet created we set it otherwise we "add" the
2699 // current domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002700 ExitDomain = ExitDomain ? AdjustedDomain.unite(ExitDomain) : AdjustedDomain;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002701
Johannes Doerferta3519512016-04-23 13:02:23 +00002702 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002703 InvalidDomainMap[ExitBB] = ExitDomain.empty(ExitDomain.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002704
Johannes Doerfert642594a2016-04-04 07:57:39 +00002705 FinishedExitBlocks.insert(ExitBB);
2706}
2707
Michael Kruse476f8552017-06-29 12:47:41 +00002708bool Scop::buildDomainsWithBranchConstraints(
2709 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002710 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002711 // To create the domain for each block in R we iterate over all blocks and
2712 // subregions in R and propagate the conditions under which the current region
2713 // element is executed. To this end we iterate in reverse post order over R as
2714 // it ensures that we first visit all predecessors of a region node (either a
2715 // basic block or a subregion) before we visit the region node itself.
2716 // Initially, only the domain for the SCoP region entry block is set and from
2717 // there we propagate the current domain to all successors, however we add the
2718 // condition that the successor is actually executed next.
2719 // As we are only interested in non-loop carried constraints here we can
2720 // simply skip loop back edges.
2721
Johannes Doerfert642594a2016-04-04 07:57:39 +00002722 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002723 ReversePostOrderTraversal<Region *> RTraversal(R);
2724 for (auto *RN : RTraversal) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002725 // Recurse for affine subregions but go on for basic blocks and non-affine
2726 // subregions.
2727 if (RN->isSubRegion()) {
2728 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002729 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002730 if (!buildDomainsWithBranchConstraints(SubRegion, DT, LI,
2731 InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002732 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002733 continue;
2734 }
2735 }
2736
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002737 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002738 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002739
Johannes Doerfert96425c22015-08-30 21:13:53 +00002740 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002741 TerminatorInst *TI = BB->getTerminator();
2742
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002743 if (isa<UnreachableInst>(TI))
2744 continue;
2745
Tobias Grosser325204a32017-07-15 12:41:32 +00002746 isl::set Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002747 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002748 continue;
Tobias Grosser325204a32017-07-15 12:41:32 +00002749 MaxLoopDepth = std::max(MaxLoopDepth, isl_set_n_dim(Domain.get()));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002750
Johannes Doerfert642594a2016-04-04 07:57:39 +00002751 auto *BBLoop = getRegionNodeLoop(RN, LI);
2752 // Propagate the domain from BB directly to blocks that have a superset
2753 // domain, at the moment only region exit nodes of regions that start in BB.
Michael Kruse476f8552017-06-29 12:47:41 +00002754 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, LI,
2755 InvalidDomainMap);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002756
2757 // If all successors of BB have been set a domain through the propagation
2758 // above we do not need to build condition sets but can just skip this
2759 // block. However, it is important to note that this is a local property
2760 // with regards to the region @p R. To this end FinishedExitBlocks is a
2761 // local variable.
2762 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2763 return FinishedExitBlocks.count(SuccBB);
2764 };
2765 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2766 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002767
2768 // Build the condition sets for the successor nodes of the current region
2769 // node. If it is a non-affine subregion we will always execute the single
2770 // exit node, hence the single entry node domain is the condition set. For
2771 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002772 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002773 if (RN->isSubRegion())
Tobias Grosser325204a32017-07-15 12:41:32 +00002774 ConditionSets.push_back(Domain.copy());
2775 else if (!buildConditionSets(*this, BB, TI, BBLoop, Domain.get(),
Michael Kruse476f8552017-06-29 12:47:41 +00002776 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002777 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002778
2779 // Now iterate over the successors and set their initial domain based on
2780 // their condition set. We skip back edges here and have to be careful when
2781 // we leave a loop not to keep constraints over a dimension that doesn't
2782 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002783 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002784 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002785 isl::set CondSet = isl::manage(ConditionSets[u]);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002786 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002787
Johannes Doerfert535de032016-04-19 14:49:05 +00002788 // Skip blocks outside the region.
Tobias Grosser325204a32017-07-15 12:41:32 +00002789 if (!contains(SuccBB))
Johannes Doerfert535de032016-04-19 14:49:05 +00002790 continue;
Johannes Doerfert535de032016-04-19 14:49:05 +00002791
Johannes Doerfert642594a2016-04-04 07:57:39 +00002792 // If we propagate the domain of some block to "SuccBB" we do not have to
2793 // adjust the domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002794 if (FinishedExitBlocks.count(SuccBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002795 continue;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002796
Johannes Doerfert96425c22015-08-30 21:13:53 +00002797 // Skip back edges.
Tobias Grosser325204a32017-07-15 12:41:32 +00002798 if (DT.dominates(SuccBB, BB))
Johannes Doerfert96425c22015-08-30 21:13:53 +00002799 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002800
Michael Kruse476f8552017-06-29 12:47:41 +00002801 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2802
Tobias Grosser325204a32017-07-15 12:41:32 +00002803 CondSet = isl::manage(
2804 adjustDomainDimensions(*this, CondSet.copy(), BBLoop, SuccBBLoop));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002805
2806 // Set the domain for the successor or merge it with an existing domain in
2807 // case there are multiple paths (without loop back edges) to the
2808 // successor block.
Tobias Grosser325204a32017-07-15 12:41:32 +00002809 isl::set &SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002810
Johannes Doerferta3519512016-04-23 13:02:23 +00002811 if (SuccDomain) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002812 SuccDomain = SuccDomain.unite(CondSet).coalesce();
Johannes Doerferta3519512016-04-23 13:02:23 +00002813 } else {
2814 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002815 InvalidDomainMap[SuccBB] = CondSet.empty(CondSet.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002816 SuccDomain = CondSet;
2817 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002818
Tobias Grosser325204a32017-07-15 12:41:32 +00002819 SuccDomain = SuccDomain.detect_equalities();
Tobias Grosser6d459c52017-05-23 04:26:28 +00002820
Michael Krusebc150122016-05-02 12:25:18 +00002821 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002822 // In case this happens we will clean up and bail.
Philip Pfaffe9375d572018-05-16 14:05:03 +00002823 if (SuccDomain.n_basic_set() < MaxDisjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002824 continue;
2825
2826 invalidate(COMPLEXITY, DebugLoc());
2827 while (++u < ConditionSets.size())
2828 isl_set_free(ConditionSets[u]);
2829 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002830 }
2831 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002832
2833 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002834}
2835
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002836isl::set Scop::getPredecessorDomainConstraints(BasicBlock *BB, isl::set Domain,
2837 DominatorTree &DT,
2838 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002839 // If @p BB is the ScopEntry we are done
2840 if (R.getEntry() == BB)
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002841 return isl::set::universe(Domain.get_space());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002842
Johannes Doerfert642594a2016-04-04 07:57:39 +00002843 // The region info of this function.
2844 auto &RI = *R.getRegionInfo();
2845
Michael Kruse476f8552017-06-29 12:47:41 +00002846 Loop *BBLoop = getFirstNonBoxedLoopFor(BB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002847
2848 // A domain to collect all predecessor domains, thus all conditions under
2849 // which the block is executed. To this end we start with the empty domain.
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002850 isl::set PredDom = isl::set::empty(Domain.get_space());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002851
2852 // Set of regions of which the entry block domain has been propagated to BB.
2853 // all predecessors inside any of the regions can be skipped.
2854 SmallSet<Region *, 8> PropagatedRegions;
2855
2856 for (auto *PredBB : predecessors(BB)) {
2857 // Skip backedges.
2858 if (DT.dominates(BB, PredBB))
2859 continue;
2860
2861 // If the predecessor is in a region we used for propagation we can skip it.
2862 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2863 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2864 PredBBInRegion)) {
2865 continue;
2866 }
2867
2868 // Check if there is a valid region we can use for propagation, thus look
2869 // for a region that contains the predecessor and has @p BB as exit block.
2870 auto *PredR = RI.getRegionFor(PredBB);
2871 while (PredR->getExit() != BB && !PredR->contains(BB))
2872 PredR->getParent();
2873
2874 // If a valid region for propagation was found use the entry of that region
2875 // for propagation, otherwise the PredBB directly.
2876 if (PredR->getExit() == BB) {
2877 PredBB = PredR->getEntry();
2878 PropagatedRegions.insert(PredR);
2879 }
2880
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002881 auto *PredBBDom = getDomainConditions(PredBB).release();
Michael Kruse476f8552017-06-29 12:47:41 +00002882 Loop *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, getBoxedLoops());
2883
Johannes Doerfert642594a2016-04-04 07:57:39 +00002884 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2885
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002886 PredDom = PredDom.unite(isl::manage(PredBBDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002887 }
2888
2889 return PredDom;
2890}
2891
Michael Kruse476f8552017-06-29 12:47:41 +00002892bool Scop::propagateDomainConstraints(
2893 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002894 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002895 // Iterate over the region R and propagate the domain constrains from the
2896 // predecessors to the current node. In contrast to the
2897 // buildDomainsWithBranchConstraints function, this one will pull the domain
2898 // information from the predecessors instead of pushing it to the successors.
2899 // Additionally, we assume the domains to be already present in the domain
2900 // map here. However, we iterate again in reverse post order so we know all
2901 // predecessors have been visited before a block or non-affine subregion is
2902 // visited.
2903
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002904 ReversePostOrderTraversal<Region *> RTraversal(R);
2905 for (auto *RN : RTraversal) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002906 // Recurse for affine subregions but go on for basic blocks and non-affine
2907 // subregions.
2908 if (RN->isSubRegion()) {
2909 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002910 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002911 if (!propagateDomainConstraints(SubRegion, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002912 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002913 continue;
2914 }
2915 }
2916
2917 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002918 isl::set &Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002919 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002920
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002921 // Under the union of all predecessor conditions we can reach this block.
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002922 isl::set PredDom = getPredecessorDomainConstraints(BB, Domain, DT, LI);
Tobias Grosser325204a32017-07-15 12:41:32 +00002923 Domain = Domain.intersect(PredDom).coalesce();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00002924 Domain = Domain.align_params(getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002925
Johannes Doerfert642594a2016-04-04 07:57:39 +00002926 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00002927 if (BBLoop && BBLoop->getHeader() == BB && contains(BBLoop))
Michael Kruse476f8552017-06-29 12:47:41 +00002928 if (!addLoopBoundsToHeaderDomain(BBLoop, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002929 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002930 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002931
2932 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002933}
2934
Tobias Grosserc80d6972016-09-02 06:33:33 +00002935/// Create a map to map from a given iteration to a subsequent iteration.
2936///
2937/// This map maps from SetSpace -> SetSpace where the dimensions @p Dim
2938/// is incremented by one and all other dimensions are equal, e.g.,
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002939/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
Tobias Grosserc80d6972016-09-02 06:33:33 +00002940///
2941/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
Tobias Grosser10da5a02018-05-23 18:41:40 +00002942static isl::map createNextIterationMap(isl::space SetSpace, unsigned Dim) {
2943 isl::space MapSpace = SetSpace.map_from_set();
2944 isl::map NextIterationMap = isl::map::universe(MapSpace);
2945 for (unsigned u = 0; u < NextIterationMap.dim(isl::dim::in); u++)
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002946 if (u != Dim)
2947 NextIterationMap =
Tobias Grosser10da5a02018-05-23 18:41:40 +00002948 NextIterationMap.equate(isl::dim::in, u, isl::dim::out, u);
2949 isl::constraint C =
2950 isl::constraint::alloc_equality(isl::local_space(MapSpace));
2951 C = C.set_constant_si(1);
2952 C = C.set_coefficient_si(isl::dim::in, Dim, 1);
2953 C = C.set_coefficient_si(isl::dim::out, Dim, -1);
2954 NextIterationMap = NextIterationMap.add_constraint(C);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002955 return NextIterationMap;
2956}
2957
Michael Kruse476f8552017-06-29 12:47:41 +00002958bool Scop::addLoopBoundsToHeaderDomain(
Tobias Grosser13acbb92017-07-15 09:01:31 +00002959 Loop *L, LoopInfo &LI, DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002960 int LoopDepth = getRelativeLoopDepth(L);
2961 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002962
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002963 BasicBlock *HeaderBB = L->getHeader();
2964 assert(DomainMap.count(HeaderBB));
Tobias Grosser325204a32017-07-15 12:41:32 +00002965 isl::set &HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002966
Tobias Grosser10da5a02018-05-23 18:41:40 +00002967 isl::map NextIterationMap =
2968 createNextIterationMap(HeaderBBDom.get_space(), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002969
Tobias Grosser325204a32017-07-15 12:41:32 +00002970 isl::set UnionBackedgeCondition = HeaderBBDom.empty(HeaderBBDom.get_space());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002971
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002972 SmallVector<BasicBlock *, 4> LatchBlocks;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002973 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002974
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002975 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002976 // If the latch is only reachable via error statements we skip it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002977 isl::set LatchBBDom = DomainMap.lookup(LatchBB);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002978 if (!LatchBBDom)
2979 continue;
2980
Tobias Grosser325204a32017-07-15 12:41:32 +00002981 isl::set BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002982
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002983 TerminatorInst *TI = LatchBB->getTerminator();
2984 BranchInst *BI = dyn_cast<BranchInst>(TI);
Tobias Grosserbbaeda32016-11-10 05:20:29 +00002985 assert(BI && "Only branch instructions allowed in loop latches");
2986
2987 if (BI->isUnconditional())
Tobias Grosser325204a32017-07-15 12:41:32 +00002988 BackedgeCondition = LatchBBDom;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002989 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002990 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002991 int idx = BI->getSuccessor(0) != HeaderBB;
Tobias Grosser325204a32017-07-15 12:41:32 +00002992 if (!buildConditionSets(*this, LatchBB, TI, L, LatchBBDom.get(),
2993 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002994 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002995
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002996 // Free the non back edge condition set as we do not need it.
2997 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002998
Tobias Grosser325204a32017-07-15 12:41:32 +00002999 BackedgeCondition = isl::manage(ConditionSets[idx]);
Johannes Doerfert06c57b52015-09-20 15:00:20 +00003000 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003001
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003002 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
3003 assert(LatchLoopDepth >= LoopDepth);
Tobias Grosser325204a32017-07-15 12:41:32 +00003004 BackedgeCondition = BackedgeCondition.project_out(
3005 isl::dim::set, LoopDepth + 1, LatchLoopDepth - LoopDepth);
3006 UnionBackedgeCondition = UnionBackedgeCondition.unite(BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003007 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003008
Tobias Grosser325204a32017-07-15 12:41:32 +00003009 isl::map ForwardMap = ForwardMap.lex_le(HeaderBBDom.get_space());
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003010 for (int i = 0; i < LoopDepth; i++)
Tobias Grosser325204a32017-07-15 12:41:32 +00003011 ForwardMap = ForwardMap.equate(isl::dim::in, i, isl::dim::out, i);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003012
Tobias Grosser325204a32017-07-15 12:41:32 +00003013 isl::set UnionBackedgeConditionComplement =
3014 UnionBackedgeCondition.complement();
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003015 UnionBackedgeConditionComplement =
Tobias Grosser325204a32017-07-15 12:41:32 +00003016 UnionBackedgeConditionComplement.lower_bound_si(isl::dim::set, LoopDepth,
3017 0);
3018 UnionBackedgeConditionComplement =
3019 UnionBackedgeConditionComplement.apply(ForwardMap);
3020 HeaderBBDom = HeaderBBDom.subtract(UnionBackedgeConditionComplement);
3021 HeaderBBDom = HeaderBBDom.apply(NextIterationMap);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003022
Tobias Grosser78a84942018-06-01 19:12:00 +00003023 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
3024 HeaderBBDom = Parts.second;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003025
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003026 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
3027 // the bounded assumptions to the context as they are already implied by the
3028 // <nsw> tag.
Tobias Grosser78a84942018-06-01 19:12:00 +00003029 if (Affinator.hasNSWAddRecForLoop(L))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003030 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003031
Tobias Grosser78a84942018-06-01 19:12:00 +00003032 isl::set UnboundedCtx = Parts.first.params();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003033 recordAssumption(INFINITELOOP, UnboundedCtx,
3034 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003035 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003036}
3037
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003038MemoryAccess *Scop::lookupBasePtrAccess(MemoryAccess *MA) {
Tobias Grosserbe372d52017-02-09 10:11:58 +00003039 Value *PointerBase = MA->getOriginalBaseAddr();
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003040
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003041 auto *PointerBaseInst = dyn_cast<Instruction>(PointerBase);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003042 if (!PointerBaseInst)
3043 return nullptr;
3044
3045 auto *BasePtrStmt = getStmtFor(PointerBaseInst);
3046 if (!BasePtrStmt)
3047 return nullptr;
3048
3049 return BasePtrStmt->getArrayAccessOrNULLFor(PointerBaseInst);
3050}
3051
3052bool Scop::hasNonHoistableBasePtrInScop(MemoryAccess *MA,
Tobias Grosser4071cb52017-06-06 23:13:02 +00003053 isl::union_map Writes) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003054 if (auto *BasePtrMA = lookupBasePtrAccess(MA)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003055 return getNonHoistableCtx(BasePtrMA, Writes).is_null();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003056 }
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003057
Tobias Grosserbe372d52017-02-09 10:11:58 +00003058 Value *BaseAddr = MA->getOriginalBaseAddr();
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003059 if (auto *BasePtrInst = dyn_cast<Instruction>(BaseAddr))
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003060 if (!isa<LoadInst>(BasePtrInst))
Johannes Doerfert952b5302016-05-23 12:40:48 +00003061 return contains(BasePtrInst);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003062
3063 return false;
3064}
3065
Johannes Doerfert5210da52016-06-02 11:06:54 +00003066bool Scop::buildAliasChecks(AliasAnalysis &AA) {
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003067 if (!PollyUseRuntimeAliasChecks)
Johannes Doerfert5210da52016-06-02 11:06:54 +00003068 return true;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003069
Johannes Doerfertcd195322016-11-17 21:41:08 +00003070 if (buildAliasGroups(AA)) {
3071 // Aliasing assumptions do not go through addAssumption but we still want to
3072 // collect statistics so we do it here explicitly.
3073 if (MinMaxAliasGroups.size())
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00003074 AssumptionsAliasing++;
Johannes Doerfert5210da52016-06-02 11:06:54 +00003075 return true;
Johannes Doerfertcd195322016-11-17 21:41:08 +00003076 }
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003077
3078 // If a problem occurs while building the alias groups we need to delete
3079 // this SCoP and pretend it wasn't valid in the first place. To this end
3080 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003081 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003082
Nicola Zaghen349506a2018-05-15 13:37:17 +00003083 LLVM_DEBUG(
3084 dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
3085 << " could not be created as the number of parameters involved "
3086 "is too high. The SCoP will be "
3087 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
3088 "the maximal number of parameters but be advised that the "
3089 "compile time might increase exponentially.\n\n");
Johannes Doerfert5210da52016-06-02 11:06:54 +00003090 return false;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003091}
3092
Tobias Grosser889830b2017-02-09 23:12:22 +00003093std::tuple<Scop::AliasGroupVectorTy, DenseSet<const ScopArrayInfo *>>
Tobias Grosser9edcf072017-01-16 14:07:57 +00003094Scop::buildAliasGroupsForAccesses(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003095 AliasSetTracker AST(AA);
3096
3097 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Tobias Grosser889830b2017-02-09 23:12:22 +00003098 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003099 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003100
Tobias Grosserdcf8d692017-08-06 16:39:52 +00003101 isl_set *StmtDomain = Stmt.getDomain().release();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003102 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
3103 isl_set_free(StmtDomain);
Tobias Grosser9edcf072017-01-16 14:07:57 +00003104
3105 // Statements with an empty domain will never be executed.
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003106 if (StmtDomainEmpty)
3107 continue;
3108
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003109 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00003110 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003111 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00003112 if (!MA->isRead())
Tobias Grosser889830b2017-02-09 23:12:22 +00003113 HasWriteAccess.insert(MA->getScopArrayInfo());
Michael Kruse70131d32016-01-27 17:09:17 +00003114 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003115 if (MA->isRead() && isa<MemTransferInst>(Acc))
Michael Kruse426e6f72016-10-25 13:37:43 +00003116 PtrToAcc[cast<MemTransferInst>(Acc)->getRawSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00003117 else
3118 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003119 AST.add(Acc);
3120 }
3121 }
3122
Tobias Grosser9edcf072017-01-16 14:07:57 +00003123 AliasGroupVectorTy AliasGroups;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003124 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00003125 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003126 continue;
3127 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00003128 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00003129 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003130 if (AG.size() < 2)
3131 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003132 AliasGroups.push_back(std::move(AG));
3133 }
3134
Tobias Grosser9edcf072017-01-16 14:07:57 +00003135 return std::make_tuple(AliasGroups, HasWriteAccess);
3136}
3137
Tobias Grossere39f9122017-01-16 14:08:00 +00003138void Scop::splitAliasGroupsByDomain(AliasGroupVectorTy &AliasGroups) {
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003139 for (unsigned u = 0; u < AliasGroups.size(); u++) {
3140 AliasGroupTy NewAG;
3141 AliasGroupTy &AG = AliasGroups[u];
3142 AliasGroupTy::iterator AGI = AG.begin();
3143 isl_set *AGDomain = getAccessDomain(*AGI);
3144 while (AGI != AG.end()) {
3145 MemoryAccess *MA = *AGI;
3146 isl_set *MADomain = getAccessDomain(MA);
3147 if (isl_set_is_disjoint(AGDomain, MADomain)) {
3148 NewAG.push_back(MA);
3149 AGI = AG.erase(AGI);
3150 isl_set_free(MADomain);
3151 } else {
3152 AGDomain = isl_set_union(AGDomain, MADomain);
3153 AGI++;
3154 }
3155 }
3156 if (NewAG.size() > 1)
3157 AliasGroups.push_back(std::move(NewAG));
3158 isl_set_free(AGDomain);
3159 }
Tobias Grossere39f9122017-01-16 14:08:00 +00003160}
3161
3162bool Scop::buildAliasGroups(AliasAnalysis &AA) {
3163 // To create sound alias checks we perform the following steps:
3164 // o) We partition each group into read only and non read only accesses.
3165 // o) For each group with more than one base pointer we then compute minimal
3166 // and maximal accesses to each array of a group in read only and non
3167 // read only partitions separately.
3168 AliasGroupVectorTy AliasGroups;
Tobias Grosser889830b2017-02-09 23:12:22 +00003169 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grossere39f9122017-01-16 14:08:00 +00003170
3171 std::tie(AliasGroups, HasWriteAccess) = buildAliasGroupsForAccesses(AA);
3172
3173 splitAliasGroupsByDomain(AliasGroups);
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003174
Johannes Doerfert13771732014-10-01 12:40:46 +00003175 for (AliasGroupTy &AG : AliasGroups) {
Tobias Grosser78a7a6c2017-06-23 08:05:31 +00003176 if (!hasFeasibleRuntimeContext())
3177 return false;
3178
Tobias Grosser57a1d362017-06-23 08:05:27 +00003179 {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003180 IslMaxOperationsGuard MaxOpGuard(getIslCtx().get(), OptComputeOut);
Tobias Grosser57a1d362017-06-23 08:05:27 +00003181 bool Valid = buildAliasGroup(AG, HasWriteAccess);
3182 if (!Valid)
3183 return false;
3184 }
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003185 if (isl_ctx_last_error(getIslCtx().get()) == isl_error_quota) {
Tobias Grosser57a1d362017-06-23 08:05:27 +00003186 invalidate(COMPLEXITY, DebugLoc());
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003187 return false;
Tobias Grosser57a1d362017-06-23 08:05:27 +00003188 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003189 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003190
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003191 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003192}
3193
Tobias Grosser77f32572017-01-16 15:49:07 +00003194bool Scop::buildAliasGroup(Scop::AliasGroupTy &AliasGroup,
Tobias Grosser889830b2017-02-09 23:12:22 +00003195 DenseSet<const ScopArrayInfo *> HasWriteAccess) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003196 AliasGroupTy ReadOnlyAccesses;
3197 AliasGroupTy ReadWriteAccesses;
Tobias Grosser889830b2017-02-09 23:12:22 +00003198 SmallPtrSet<const ScopArrayInfo *, 4> ReadWriteArrays;
Tobias Grosser079d5112017-02-18 20:51:29 +00003199 SmallPtrSet<const ScopArrayInfo *, 4> ReadOnlyArrays;
Tobias Grosser77f32572017-01-16 15:49:07 +00003200
Tobias Grosser77f32572017-01-16 15:49:07 +00003201 if (AliasGroup.size() < 2)
3202 return true;
3203
3204 for (MemoryAccess *Access : AliasGroup) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003205 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "PossibleAlias",
3206 Access->getAccessInstruction())
3207 << "Possibly aliasing pointer, use restrict keyword.");
Tobias Grosser889830b2017-02-09 23:12:22 +00003208 const ScopArrayInfo *Array = Access->getScopArrayInfo();
3209 if (HasWriteAccess.count(Array)) {
3210 ReadWriteArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003211 ReadWriteAccesses.push_back(Access);
3212 } else {
Tobias Grosser079d5112017-02-18 20:51:29 +00003213 ReadOnlyArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003214 ReadOnlyAccesses.push_back(Access);
3215 }
3216 }
3217
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003218 // If there are no read-only pointers, and less than two read-write pointers,
3219 // no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003220 if (ReadOnlyAccesses.empty() && ReadWriteArrays.size() <= 1)
Tobias Grosser77f32572017-01-16 15:49:07 +00003221 return true;
3222
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003223 // If there is no read-write pointer, no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003224 if (ReadWriteArrays.empty())
Tobias Grosser77f32572017-01-16 15:49:07 +00003225 return true;
3226
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003227 // For non-affine accesses, no alias check can be generated as we cannot
3228 // compute a sufficiently tight lower and upper bound: bail out.
Tobias Grosser77f32572017-01-16 15:49:07 +00003229 for (MemoryAccess *MA : AliasGroup) {
3230 if (!MA->isAffine()) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003231 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc(),
3232 MA->getAccessInstruction()->getParent());
Tobias Grosser77f32572017-01-16 15:49:07 +00003233 return false;
3234 }
Tobias Grosser0032d872017-01-16 15:49:14 +00003235 }
3236
3237 // Ensure that for all memory accesses for which we generate alias checks,
3238 // their base pointers are available.
3239 for (MemoryAccess *MA : AliasGroup) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003240 if (MemoryAccess *BasePtrMA = lookupBasePtrAccess(MA))
3241 addRequiredInvariantLoad(
3242 cast<LoadInst>(BasePtrMA->getAccessInstruction()));
3243 }
3244
3245 MinMaxAliasGroups.emplace_back();
3246 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3247 MinMaxVectorTy &MinMaxAccessesReadWrite = pair.first;
3248 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3249
3250 bool Valid;
3251
3252 Valid =
3253 calculateMinMaxAccess(ReadWriteAccesses, *this, MinMaxAccessesReadWrite);
3254
3255 if (!Valid)
3256 return false;
3257
3258 // Bail out if the number of values we need to compare is too large.
3259 // This is important as the number of comparisons grows quadratically with
3260 // the number of values we need to compare.
Tobias Grosser079d5112017-02-18 20:51:29 +00003261 if (MinMaxAccessesReadWrite.size() + ReadOnlyArrays.size() >
Tobias Grosser77f32572017-01-16 15:49:07 +00003262 RunTimeChecksMaxArraysPerGroup)
3263 return false;
3264
3265 Valid =
3266 calculateMinMaxAccess(ReadOnlyAccesses, *this, MinMaxAccessesReadOnly);
3267
3268 if (!Valid)
3269 return false;
3270
3271 return true;
3272}
3273
Tobias Grosserc80d6972016-09-02 06:33:33 +00003274/// Get the smallest loop that contains @p S but is not in @p S.
Johannes Doerfertef744432016-05-23 12:42:38 +00003275static Loop *getLoopSurroundingScop(Scop &S, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003276 // Start with the smallest loop containing the entry and expand that
3277 // loop until it contains all blocks in the region. If there is a loop
3278 // containing all blocks in the region check if it is itself contained
3279 // and if so take the parent loop as it will be the smallest containing
3280 // the region but not contained by it.
Johannes Doerfertef744432016-05-23 12:42:38 +00003281 Loop *L = LI.getLoopFor(S.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003282 while (L) {
3283 bool AllContained = true;
Johannes Doerfertef744432016-05-23 12:42:38 +00003284 for (auto *BB : S.blocks())
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003285 AllContained &= L->contains(BB);
3286 if (AllContained)
3287 break;
3288 L = L->getParentLoop();
3289 }
3290
Johannes Doerfertef744432016-05-23 12:42:38 +00003291 return L ? (S.contains(L) ? L->getParentLoop() : L) : nullptr;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003292}
3293
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003294int Scop::NextScopID = 0;
3295
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00003296std::string Scop::CurrentFunc;
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003297
3298int Scop::getNextID(std::string ParentFunc) {
3299 if (ParentFunc != CurrentFunc) {
3300 CurrentFunc = ParentFunc;
3301 NextScopID = 0;
3302 }
3303 return NextScopID++;
3304}
3305
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003306Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
Tobias Grosseree457592017-09-24 09:25:30 +00003307 DominatorTree &DT, ScopDetection::DetectionContext &DC,
3308 OptimizationRemarkEmitter &ORE)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003309 : IslCtx(isl_ctx_alloc(), isl_ctx_free), SE(&ScalarEvolution), DT(&DT),
Philip Pfaffed477bb92018-05-15 14:53:25 +00003310 R(R), name(None), HasSingleExitEdge(R.getExitingBlock()), DC(DC),
3311 ORE(ORE), Affinator(this, LI),
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003312 ID(getNextID((*R.getEntry()->getParent()).getName().str())) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003313 if (IslOnErrorAbort)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003314 isl_options_set_on_error(getIslCtx().get(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003315 buildContext();
3316}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003317
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003318Scop::~Scop() = default;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00003319
Tobias Grosserbedef002016-12-02 08:10:56 +00003320void Scop::foldSizeConstantsToRight() {
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00003321 isl_union_set *Accessed = isl_union_map_range(getAccesses().release());
Tobias Grosserbedef002016-12-02 08:10:56 +00003322
3323 for (auto Array : arrays()) {
3324 if (Array->getNumberOfDimensions() <= 1)
3325 continue;
3326
Tobias Grosser77eef902017-07-21 23:07:56 +00003327 isl_space *Space = Array->getSpace().release();
Tobias Grosserbedef002016-12-02 08:10:56 +00003328
3329 Space = isl_space_align_params(Space, isl_union_set_get_space(Accessed));
3330
3331 if (!isl_union_set_contains(Accessed, Space)) {
3332 isl_space_free(Space);
3333 continue;
3334 }
3335
3336 isl_set *Elements = isl_union_set_extract_set(Accessed, Space);
3337
3338 isl_map *Transform =
Tobias Grosser77eef902017-07-21 23:07:56 +00003339 isl_map_universe(isl_space_map_from_set(Array->getSpace().release()));
Tobias Grosserbedef002016-12-02 08:10:56 +00003340
3341 std::vector<int> Int;
3342
3343 int Dims = isl_set_dim(Elements, isl_dim_set);
3344 for (int i = 0; i < Dims; i++) {
3345 isl_set *DimOnly =
3346 isl_set_project_out(isl_set_copy(Elements), isl_dim_set, 0, i);
3347 DimOnly = isl_set_project_out(DimOnly, isl_dim_set, 1, Dims - i - 1);
3348 DimOnly = isl_set_lower_bound_si(DimOnly, isl_dim_set, 0, 0);
3349
3350 isl_basic_set *DimHull = isl_set_affine_hull(DimOnly);
3351
3352 if (i == Dims - 1) {
3353 Int.push_back(1);
3354 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3355 isl_basic_set_free(DimHull);
3356 continue;
3357 }
3358
3359 if (isl_basic_set_dim(DimHull, isl_dim_div) == 1) {
3360 isl_aff *Diff = isl_basic_set_get_div(DimHull, 0);
3361 isl_val *Val = isl_aff_get_denominator_val(Diff);
3362 isl_aff_free(Diff);
3363
3364 int ValInt = 1;
3365
Eli Friedmana75d53c2018-01-17 21:59:02 +00003366 if (isl_val_is_int(Val)) {
3367 auto ValAPInt = APIntFromVal(Val);
3368 if (ValAPInt.isSignedIntN(32))
3369 ValInt = ValAPInt.getSExtValue();
3370 } else {
3371 isl_val_free(Val);
3372 }
Tobias Grosserbedef002016-12-02 08:10:56 +00003373
3374 Int.push_back(ValInt);
3375
3376 isl_constraint *C = isl_constraint_alloc_equality(
3377 isl_local_space_from_space(isl_map_get_space(Transform)));
3378 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, ValInt);
3379 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, -1);
3380 Transform = isl_map_add_constraint(Transform, C);
3381 isl_basic_set_free(DimHull);
3382 continue;
3383 }
3384
3385 isl_basic_set *ZeroSet = isl_basic_set_copy(DimHull);
3386 ZeroSet = isl_basic_set_fix_si(ZeroSet, isl_dim_set, 0, 0);
3387
3388 int ValInt = 1;
3389 if (isl_basic_set_is_equal(ZeroSet, DimHull)) {
3390 ValInt = 0;
3391 }
3392
3393 Int.push_back(ValInt);
3394 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3395 isl_basic_set_free(DimHull);
3396 isl_basic_set_free(ZeroSet);
3397 }
3398
3399 isl_set *MappedElements = isl_map_domain(isl_map_copy(Transform));
3400
3401 if (!isl_set_is_subset(Elements, MappedElements)) {
3402 isl_set_free(Elements);
3403 isl_set_free(MappedElements);
3404 isl_map_free(Transform);
3405 continue;
3406 }
3407
3408 isl_set_free(MappedElements);
3409
3410 bool CanFold = true;
3411
3412 if (Int[0] <= 1)
3413 CanFold = false;
3414
3415 unsigned NumDims = Array->getNumberOfDimensions();
3416 for (unsigned i = 1; i < NumDims - 1; i++)
3417 if (Int[0] != Int[i] && Int[i])
3418 CanFold = false;
3419
3420 if (!CanFold) {
3421 isl_set_free(Elements);
3422 isl_map_free(Transform);
3423 continue;
3424 }
3425
Tobias Grosserbedef002016-12-02 08:10:56 +00003426 for (auto &Access : AccessFunctions)
3427 if (Access->getScopArrayInfo() == Array)
Tobias Grosser6d588042017-08-02 19:27:16 +00003428 Access->setAccessRelation(Access->getAccessRelation().apply_range(
Tobias Grosser718d04c2018-02-20 07:26:58 +00003429 isl::manage_copy(Transform)));
Tobias Grosserbedef002016-12-02 08:10:56 +00003430
3431 isl_map_free(Transform);
3432
3433 std::vector<const SCEV *> Sizes;
3434 for (unsigned i = 0; i < NumDims; i++) {
3435 auto Size = Array->getDimensionSize(i);
3436
3437 if (i == NumDims - 1)
3438 Size = SE->getMulExpr(Size, SE->getConstant(Size->getType(), Int[0]));
3439 Sizes.push_back(Size);
3440 }
3441
3442 Array->updateSizes(Sizes, false /* CheckConsistency */);
3443
3444 isl_set_free(Elements);
3445 }
3446 isl_union_set_free(Accessed);
Tobias Grosserbedef002016-12-02 08:10:56 +00003447}
3448
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003449void Scop::markFortranArrays() {
3450 for (ScopStmt &Stmt : Stmts) {
3451 for (MemoryAccess *MemAcc : Stmt) {
3452 Value *FAD = MemAcc->getFortranArrayDescriptor();
3453 if (!FAD)
3454 continue;
3455
3456 // TODO: const_cast-ing to edit
3457 ScopArrayInfo *SAI =
3458 const_cast<ScopArrayInfo *>(MemAcc->getLatestScopArrayInfo());
3459 assert(SAI && "memory access into a Fortran array does not "
3460 "have an associated ScopArrayInfo");
3461 SAI->applyAndSetFAD(FAD);
3462 }
3463 }
3464}
3465
Tobias Grosser491b7992016-12-02 05:21:22 +00003466void Scop::finalizeAccesses() {
3467 updateAccessDimensionality();
Tobias Grosserbedef002016-12-02 08:10:56 +00003468 foldSizeConstantsToRight();
Tobias Grosser491b7992016-12-02 05:21:22 +00003469 foldAccessRelations();
3470 assumeNoOutOfBounds();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003471 markFortranArrays();
Tobias Grosser491b7992016-12-02 05:21:22 +00003472}
3473
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003474void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003475 // Check all array accesses for each base pointer and find a (virtual) element
3476 // size for the base pointer that divides all access functions.
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003477 for (ScopStmt &Stmt : *this)
3478 for (MemoryAccess *Access : Stmt) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003479 if (!Access->isArrayKind())
3480 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003481 ScopArrayInfo *Array =
Tobias Grossere24b7b92017-02-09 23:24:57 +00003482 const_cast<ScopArrayInfo *>(Access->getScopArrayInfo());
3483
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003484 if (Array->getNumberOfDimensions() != 1)
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003485 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003486 unsigned DivisibleSize = Array->getElemSizeInBytes();
3487 const SCEV *Subscript = Access->getSubscript(0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003488 while (!isDivisible(Subscript, DivisibleSize, *SE))
3489 DivisibleSize /= 2;
3490 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003491 Array->updateElementType(Ty);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003492 }
3493
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003494 for (auto &Stmt : *this)
3495 for (auto &Access : Stmt)
3496 Access->updateDimensionality();
3497}
3498
Tobias Grosser491b7992016-12-02 05:21:22 +00003499void Scop::foldAccessRelations() {
3500 for (auto &Stmt : *this)
3501 for (auto &Access : Stmt)
3502 Access->foldAccessRelation();
3503}
3504
3505void Scop::assumeNoOutOfBounds() {
3506 for (auto &Stmt : *this)
3507 for (auto &Access : Stmt)
3508 Access->assumeNoOutOfBound();
3509}
3510
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003511void Scop::removeFromStmtMap(ScopStmt &Stmt) {
Tobias Grosserbd15d132017-08-31 03:15:56 +00003512 for (Instruction *Inst : Stmt.getInstructions())
3513 InstStmtMap.erase(Inst);
3514
3515 if (Stmt.isRegionStmt()) {
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003516 for (BasicBlock *BB : Stmt.getRegion()->blocks()) {
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003517 StmtMap.erase(BB);
Tobias Grosserbd15d132017-08-31 03:15:56 +00003518 // Skip entry basic block, as its instructions are already deleted as
3519 // part of the statement's instruction list.
3520 if (BB == Stmt.getEntryBlock())
3521 continue;
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003522 for (Instruction &Inst : *BB)
3523 InstStmtMap.erase(&Inst);
3524 }
Tobias Grosserbd15d132017-08-31 03:15:56 +00003525 } else {
Michael Kruse0c6c5552017-09-01 11:36:52 +00003526 auto StmtMapIt = StmtMap.find(Stmt.getBasicBlock());
3527 if (StmtMapIt != StmtMap.end())
3528 StmtMapIt->second.erase(std::remove(StmtMapIt->second.begin(),
3529 StmtMapIt->second.end(), &Stmt),
3530 StmtMapIt->second.end());
3531 for (Instruction *Inst : Stmt.getInstructions())
3532 InstStmtMap.erase(Inst);
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003533 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003534}
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003535
Michael Kruse192e7f72018-04-09 23:13:05 +00003536void Scop::removeStmts(std::function<bool(ScopStmt &)> ShouldDelete,
3537 bool AfterHoisting) {
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003538 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3539 if (!ShouldDelete(*StmtIt)) {
3540 StmtIt++;
3541 continue;
3542 }
3543
Michael Kruse192e7f72018-04-09 23:13:05 +00003544 // Start with removing all of the statement's accesses including erasing it
3545 // from all maps that are pointing to them.
Michael Krusedb6f71e2018-04-10 01:20:41 +00003546 // Make a temporary copy because removing MAs invalidates the iterator.
3547 SmallVector<MemoryAccess *, 16> MAList(StmtIt->begin(), StmtIt->end());
3548 for (MemoryAccess *MA : MAList)
Michael Kruse192e7f72018-04-09 23:13:05 +00003549 StmtIt->removeSingleMemoryAccess(MA, AfterHoisting);
3550
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003551 removeFromStmtMap(*StmtIt);
3552 StmtIt = Stmts.erase(StmtIt);
3553 }
3554}
3555
3556void Scop::removeStmtNotInDomainMap() {
3557 auto ShouldDelete = [this](ScopStmt &Stmt) -> bool {
Tobias Grosser199ec4a2017-07-19 16:31:10 +00003558 return !this->DomainMap.lookup(Stmt.getEntryBlock());
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003559 };
Michael Kruse192e7f72018-04-09 23:13:05 +00003560 removeStmts(ShouldDelete, false);
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003561}
3562
3563void Scop::simplifySCoP(bool AfterHoisting) {
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003564 auto ShouldDelete = [AfterHoisting](ScopStmt &Stmt) -> bool {
Michael Kruse5369ea52018-04-20 18:55:44 +00003565 // Never delete statements that contain calls to debug functions.
3566 if (hasDebugCall(&Stmt))
3567 return false;
3568
Johannes Doerfert26404542016-05-10 12:19:47 +00003569 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003570
Tobias Grosser3012a0b2017-07-16 22:44:17 +00003571 // Remove read only statements only after invariant load hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003572 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003573 bool OnlyRead = true;
3574 for (MemoryAccess *MA : Stmt) {
3575 if (MA->isRead())
3576 continue;
3577
3578 OnlyRead = false;
3579 break;
3580 }
3581
3582 RemoveStmt = OnlyRead;
3583 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003584 return RemoveStmt;
3585 };
Johannes Doerferteca9e892015-11-03 16:54:49 +00003586
Michael Kruse192e7f72018-04-09 23:13:05 +00003587 removeStmts(ShouldDelete, AfterHoisting);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003588}
3589
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003590InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003591 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3592 if (!LInst)
3593 return nullptr;
3594
3595 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3596 LInst = cast<LoadInst>(Rep);
3597
Johannes Doerfert96e54712016-02-07 17:30:13 +00003598 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003599 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003600 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003601 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfert549768c2016-03-24 13:22:16 +00003602 continue;
3603
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003604 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfert549768c2016-03-24 13:22:16 +00003605 for (auto *MA : MAs)
3606 if (MA->getAccessInstruction() == Val)
3607 return &IAClass;
3608 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003609
3610 return nullptr;
3611}
3612
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003613bool isAParameter(llvm::Value *maybeParam, const Function &F) {
3614 for (const llvm::Argument &Arg : F.args())
3615 if (&Arg == maybeParam)
3616 return true;
3617
3618 return false;
Michael Kruse594386e2017-08-23 12:34:37 +00003619}
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003620
Tobias Grosser305d3162017-08-07 00:10:11 +00003621bool Scop::canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3622 bool MAInvalidCtxIsEmpty,
3623 bool NonHoistableCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003624 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3625 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003626 if (PollyAllowDereferenceOfAllFunctionParams &&
3627 isAParameter(LInst->getPointerOperand(), getFunction()))
3628 return true;
3629
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003630 // TODO: We can provide more information for better but more expensive
3631 // results.
3632 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3633 LInst->getAlignment(), DL))
3634 return false;
3635
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003636 // If the location might be overwritten we do not hoist it unconditionally.
3637 //
Siddharth Bhat83fe6b52017-08-08 12:26:32 +00003638 // TODO: This is probably too conservative.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003639 if (!NonHoistableCtxIsEmpty)
3640 return false;
3641
Michael Krusea6d48f52017-06-08 12:06:15 +00003642 // If a dereferenceable load is in a statement that is modeled precisely we
3643 // can hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003644 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003645 return true;
3646
3647 // Even if the statement is not modeled precisely we can hoist the load if it
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003648 // does not involve any parameters that might have been specialized by the
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003649 // statement domain.
3650 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3651 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3652 return false;
3653 return true;
3654}
3655
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003656void Scop::addInvariantLoads(ScopStmt &Stmt, InvariantAccessesTy &InvMAs) {
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003657 if (InvMAs.empty())
3658 return;
3659
Tobias Grosser2332fa32017-08-06 15:36:48 +00003660 isl::set StmtInvalidCtx = Stmt.getInvalidContext();
3661 bool StmtInvalidCtxIsEmpty = StmtInvalidCtx.is_empty();
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003662
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003663 // Get the context under which the statement is executed but remove the error
3664 // context under which this statement is reached.
Tobias Grossere69b2722017-08-06 23:50:25 +00003665 isl::set DomainCtx = Stmt.getDomain().params();
3666 DomainCtx = DomainCtx.subtract(StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003667
Philip Pfaffe9375d572018-05-16 14:05:03 +00003668 if (DomainCtx.n_basic_set() >= MaxDisjunctsInDomain) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003669 auto *AccInst = InvMAs.front().MA->getAccessInstruction();
Eli Friedmane737fc12017-07-17 23:58:33 +00003670 invalidate(COMPLEXITY, AccInst->getDebugLoc(), AccInst->getParent());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003671 return;
3672 }
3673
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003674 // Project out all parameters that relate to loads in the statement. Otherwise
3675 // we could have cyclic dependences on the constraints under which the
3676 // hoisted loads are executed and we could not determine an order in which to
3677 // pre-load them. This happens because not only lower bounds are part of the
3678 // domain but also upper bounds.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003679 for (auto &InvMA : InvMAs) {
3680 auto *MA = InvMA.MA;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003681 Instruction *AccInst = MA->getAccessInstruction();
3682 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003683 SetVector<Value *> Values;
3684 for (const SCEV *Parameter : Parameters) {
3685 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003686 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003687 if (!Values.count(AccInst))
3688 continue;
3689
Tobias Grossere69b2722017-08-06 23:50:25 +00003690 if (isl::id ParamId = getIdForParam(Parameter)) {
3691 int Dim = DomainCtx.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosserb58ed8d2017-03-17 09:02:53 +00003692 if (Dim >= 0)
Tobias Grossere69b2722017-08-06 23:50:25 +00003693 DomainCtx = DomainCtx.eliminate(isl::dim::param, Dim, 1);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003694 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003695 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003696 }
3697 }
3698
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003699 for (auto &InvMA : InvMAs) {
3700 auto *MA = InvMA.MA;
Tobias Grossere69b2722017-08-06 23:50:25 +00003701 isl::set NHCtx = InvMA.NonHoistableCtx;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003702
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003703 // Check for another invariant access that accesses the same location as
3704 // MA and if found consolidate them. Otherwise create a new equivalence
3705 // class at the end of InvariantEquivClasses.
3706 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003707 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003708 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3709
Tobias Grossere69b2722017-08-06 23:50:25 +00003710 isl::set MAInvalidCtx = MA->getInvalidContext();
3711 bool NonHoistableCtxIsEmpty = NHCtx.is_empty();
3712 bool MAInvalidCtxIsEmpty = MAInvalidCtx.is_empty();
Johannes Doerfert85676e32016-04-23 14:32:34 +00003713
Tobias Grossere69b2722017-08-06 23:50:25 +00003714 isl::set MACtx;
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003715 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003716 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty,
3717 NonHoistableCtxIsEmpty)) {
Tobias Grossere69b2722017-08-06 23:50:25 +00003718 MACtx = isl::set::universe(DomainCtx.get_space());
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003719 } else {
Tobias Grossere69b2722017-08-06 23:50:25 +00003720 MACtx = DomainCtx;
3721 MACtx = MACtx.subtract(MAInvalidCtx.unite(NHCtx));
3722 MACtx = MACtx.gist_params(getContext());
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003723 }
3724
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003725 bool Consolidated = false;
3726 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003727 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003728 continue;
3729
Johannes Doerfertdf880232016-03-03 12:26:58 +00003730 // If the pointer and the type is equal check if the access function wrt.
3731 // to the domain is equal too. It can happen that the domain fixes
3732 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003733 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003734 // create a new invariant load equivalence class.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003735 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertdf880232016-03-03 12:26:58 +00003736 if (!MAs.empty()) {
3737 auto *LastMA = MAs.front();
3738
Tobias Grossere69b2722017-08-06 23:50:25 +00003739 isl::set AR = MA->getAccessRelation().range();
3740 isl::set LastAR = LastMA->getAccessRelation().range();
3741 bool SameAR = AR.is_equal(LastAR);
Johannes Doerfertdf880232016-03-03 12:26:58 +00003742
3743 if (!SameAR)
3744 continue;
3745 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003746
3747 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003748 MAs.push_front(MA);
3749
Johannes Doerfertdf880232016-03-03 12:26:58 +00003750 Consolidated = true;
3751
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003752 // Unify the execution context of the class and this statement.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003753 isl::set IAClassDomainCtx = IAClass.ExecutionContext;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003754 if (IAClassDomainCtx)
Tobias Grossere69b2722017-08-06 23:50:25 +00003755 IAClassDomainCtx = IAClassDomainCtx.unite(MACtx).coalesce();
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003756 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003757 IAClassDomainCtx = MACtx;
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003758 IAClass.ExecutionContext = IAClassDomainCtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003759 break;
3760 }
3761
3762 if (Consolidated)
3763 continue;
3764
3765 // If we did not consolidate MA, thus did not find an equivalence class
3766 // for it, we create a new one.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003767 InvariantEquivClasses.emplace_back(
3768 InvariantEquivClassTy{PointerSCEV, MemoryAccessList{MA}, MACtx, Ty});
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003769 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003770}
3771
Tobias Grosser1eeedf42017-07-20 19:55:19 +00003772/// Check if an access range is too complex.
3773///
3774/// An access range is too complex, if it contains either many disjuncts or
3775/// very complex expressions. As a simple heuristic, we assume if a set to
3776/// be too complex if the sum of existentially quantified dimensions and
3777/// set dimensions is larger than a threshold. This reliably detects both
3778/// sets with many disjuncts as well as sets with many divisions as they
3779/// arise in h264.
3780///
3781/// @param AccessRange The range to check for complexity.
3782///
3783/// @returns True if the access range is too complex.
3784static bool isAccessRangeTooComplex(isl::set AccessRange) {
3785 unsigned NumTotalDims = 0;
3786
3787 auto CountDimensions = [&NumTotalDims](isl::basic_set BSet) -> isl::stat {
3788 NumTotalDims += BSet.dim(isl::dim::div);
3789 NumTotalDims += BSet.dim(isl::dim::set);
3790 return isl::stat::ok;
3791 };
3792
3793 AccessRange.foreach_basic_set(CountDimensions);
3794
3795 if (NumTotalDims > MaxDimensionsInAccessRange)
3796 return true;
3797
3798 return false;
3799}
3800
Tobias Grosser4071cb52017-06-06 23:13:02 +00003801isl::set Scop::getNonHoistableCtx(MemoryAccess *Access, isl::union_map Writes) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003802 // TODO: Loads that are not loop carried, hence are in a statement with
3803 // zero iterators, are by construction invariant, though we
3804 // currently "hoist" them anyway. This is necessary because we allow
3805 // them to be treated as parameters (e.g., in conditions) and our code
3806 // generation would otherwise use the old value.
3807
3808 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003809 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003810
Johannes Doerfertc9765462016-11-17 22:11:56 +00003811 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine() ||
3812 Access->isMemoryIntrinsic())
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003813 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003814
3815 // Skip accesses that have an invariant base pointer which is defined but
3816 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3817 // returns a pointer that is used as a base address. However, as we want
3818 // to hoist indirect pointers, we allow the base pointer to be defined in
3819 // the region if it is also a memory access. Each ScopArrayInfo object
3820 // that has a base pointer origin has a base pointer that is loaded and
3821 // that it is invariant, thus it will be hoisted too. However, if there is
3822 // no base pointer origin we check that the base pointer is defined
3823 // outside the region.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003824 auto *LI = cast<LoadInst>(Access->getAccessInstruction());
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003825 if (hasNonHoistableBasePtrInScop(Access, Writes))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003826 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003827
Tobias Grosserd3d3d6b2018-04-29 00:28:26 +00003828 isl::map AccessRelation = Access->getAccessRelation();
Tobias Grosser4071cb52017-06-06 23:13:02 +00003829 assert(!AccessRelation.is_empty());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003830
Tobias Grosser4071cb52017-06-06 23:13:02 +00003831 if (AccessRelation.involves_dims(isl::dim::in, 0, Stmt.getNumIterators()))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003832 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003833
Tobias Grosserdcf8d692017-08-06 16:39:52 +00003834 AccessRelation = AccessRelation.intersect_domain(Stmt.getDomain());
Tobias Grosser4071cb52017-06-06 23:13:02 +00003835 isl::set SafeToLoad;
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003836
3837 auto &DL = getFunction().getParent()->getDataLayout();
3838 if (isSafeToLoadUnconditionally(LI->getPointerOperand(), LI->getAlignment(),
3839 DL)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003840 SafeToLoad = isl::set::universe(AccessRelation.get_space().range());
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003841 } else if (BB != LI->getParent()) {
3842 // Skip accesses in non-affine subregions as they might not be executed
3843 // under the same condition as the entry of the non-affine subregion.
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003844 return nullptr;
3845 } else {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003846 SafeToLoad = AccessRelation.range();
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003847 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003848
Tobias Grosser1eeedf42017-07-20 19:55:19 +00003849 if (isAccessRangeTooComplex(AccessRelation.range()))
3850 return nullptr;
3851
Tobias Grosser4071cb52017-06-06 23:13:02 +00003852 isl::union_map Written = Writes.intersect_range(SafeToLoad);
3853 isl::set WrittenCtx = Written.params();
3854 bool IsWritten = !WrittenCtx.is_empty();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003855
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003856 if (!IsWritten)
3857 return WrittenCtx;
3858
Tobias Grosser4071cb52017-06-06 23:13:02 +00003859 WrittenCtx = WrittenCtx.remove_divs();
Philip Pfaffe9375d572018-05-16 14:05:03 +00003860 bool TooComplex = WrittenCtx.n_basic_set() >= MaxDisjunctsInDomain;
Tobias Grosser4071cb52017-06-06 23:13:02 +00003861 if (TooComplex || !isRequiredInvariantLoad(LI))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003862 return nullptr;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003863
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003864 addAssumption(INVARIANTLOAD, WrittenCtx, LI->getDebugLoc(), AS_RESTRICTION,
3865 LI->getParent());
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003866 return WrittenCtx;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003867}
3868
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003869void Scop::verifyInvariantLoads() {
3870 auto &RIL = getRequiredInvariantLoads();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003871 for (LoadInst *LI : RIL) {
Johannes Doerfert952b5302016-05-23 12:40:48 +00003872 assert(LI && contains(LI));
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003873 // If there exists a statement in the scop which has a memory access for
3874 // @p LI, then mark this scop as infeasible for optimization.
3875 for (ScopStmt &Stmt : Stmts)
3876 if (Stmt.getArrayAccessOrNULLFor(LI)) {
3877 invalidate(INVARIANTLOAD, LI->getDebugLoc(), LI->getParent());
3878 return;
3879 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003880 }
3881}
3882
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003883void Scop::hoistInvariantLoads() {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003884 if (!PollyInvariantLoadHoisting)
3885 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003886
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00003887 isl::union_map Writes = getWrites();
Tobias Grosser0865e7752016-02-29 07:29:42 +00003888 for (ScopStmt &Stmt : *this) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003889 InvariantAccessesTy InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003890
Tobias Grosser0865e7752016-02-29 07:29:42 +00003891 for (MemoryAccess *Access : Stmt)
Tobias Grosser4071cb52017-06-06 23:13:02 +00003892 if (isl::set NHCtx = getNonHoistableCtx(Access, Writes))
Tobias Grosserd16f9272017-08-06 17:25:14 +00003893 InvariantAccesses.push_back({Access, NHCtx});
Tobias Grosser0865e7752016-02-29 07:29:42 +00003894
3895 // Transfer the memory access from the statement to the SCoP.
Michael Kruse10071822016-05-23 14:45:58 +00003896 for (auto InvMA : InvariantAccesses)
3897 Stmt.removeMemoryAccess(InvMA.MA);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003898 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003899 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003900}
3901
Tobias Grosserf3adab42017-05-10 10:59:58 +00003902/// Find the canonical scop array info object for a set of invariant load
3903/// hoisted loads. The canonical array is the one that corresponds to the
3904/// first load in the list of accesses which is used as base pointer of a
3905/// scop array.
3906static const ScopArrayInfo *findCanonicalArray(Scop *S,
3907 MemoryAccessList &Accesses) {
3908 for (MemoryAccess *Access : Accesses) {
3909 const ScopArrayInfo *CanonicalArray = S->getScopArrayInfoOrNull(
3910 Access->getAccessInstruction(), MemoryKind::Array);
3911 if (CanonicalArray)
3912 return CanonicalArray;
3913 }
3914 return nullptr;
3915}
3916
3917/// Check if @p Array severs as base array in an invariant load.
3918static bool isUsedForIndirectHoistedLoad(Scop *S, const ScopArrayInfo *Array) {
3919 for (InvariantEquivClassTy &EqClass2 : S->getInvariantAccesses())
3920 for (MemoryAccess *Access2 : EqClass2.InvariantAccesses)
3921 if (Access2->getScopArrayInfo() == Array)
3922 return true;
3923 return false;
3924}
3925
3926/// Replace the base pointer arrays in all memory accesses referencing @p Old,
3927/// with a reference to @p New.
3928static void replaceBasePtrArrays(Scop *S, const ScopArrayInfo *Old,
3929 const ScopArrayInfo *New) {
3930 for (ScopStmt &Stmt : *S)
3931 for (MemoryAccess *Access : Stmt) {
3932 if (Access->getLatestScopArrayInfo() != Old)
3933 continue;
3934
Tobias Grosser6d588042017-08-02 19:27:16 +00003935 isl::id Id = New->getBasePtrId();
3936 isl::map Map = Access->getAccessRelation();
3937 Map = Map.set_tuple_id(isl::dim::out, Id);
Tobias Grosserf3adab42017-05-10 10:59:58 +00003938 Access->setAccessRelation(Map);
3939 }
3940}
3941
3942void Scop::canonicalizeDynamicBasePtrs() {
3943 for (InvariantEquivClassTy &EqClass : InvariantEquivClasses) {
3944 MemoryAccessList &BasePtrAccesses = EqClass.InvariantAccesses;
3945
3946 const ScopArrayInfo *CanonicalBasePtrSAI =
3947 findCanonicalArray(this, BasePtrAccesses);
3948
3949 if (!CanonicalBasePtrSAI)
3950 continue;
3951
3952 for (MemoryAccess *BasePtrAccess : BasePtrAccesses) {
3953 const ScopArrayInfo *BasePtrSAI = getScopArrayInfoOrNull(
3954 BasePtrAccess->getAccessInstruction(), MemoryKind::Array);
3955 if (!BasePtrSAI || BasePtrSAI == CanonicalBasePtrSAI ||
3956 !BasePtrSAI->isCompatibleWith(CanonicalBasePtrSAI))
3957 continue;
3958
3959 // we currently do not canonicalize arrays where some accesses are
3960 // hoisted as invariant loads. If we would, we need to update the access
3961 // function of the invariant loads as well. However, as this is not a
3962 // very common situation, we leave this for now to avoid further
3963 // complexity increases.
3964 if (isUsedForIndirectHoistedLoad(this, BasePtrSAI))
3965 continue;
3966
3967 replaceBasePtrArrays(this, BasePtrSAI, CanonicalBasePtrSAI);
3968 }
3969 }
3970}
3971
Michael Kruseb738ffa2017-06-28 13:02:43 +00003972ScopArrayInfo *Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
3973 ArrayRef<const SCEV *> Sizes,
3974 MemoryKind Kind,
3975 const char *BaseName) {
Roman Gareevd7754a12016-07-30 09:25:51 +00003976 assert((BasePtr || BaseName) &&
3977 "BasePtr and BaseName can not be nullptr at the same time.");
3978 assert(!(BasePtr && BaseName) && "BaseName is redundant.");
3979 auto &SAI = BasePtr ? ScopArrayInfoMap[std::make_pair(BasePtr, Kind)]
3980 : ScopArrayNameMap[BaseName];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003981 if (!SAI) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00003982 auto &DL = getFunction().getParent()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003983 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +00003984 DL, this, BaseName));
3985 ScopArrayInfoSet.insert(SAI.get());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003986 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003987 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003988 // In case of mismatching array sizes, we bail out by setting the run-time
3989 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003990 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003991 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003992 }
Tobias Grosserab671442015-05-23 05:58:27 +00003993 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003994}
3995
Michael Kruseb738ffa2017-06-28 13:02:43 +00003996ScopArrayInfo *Scop::createScopArrayInfo(Type *ElementType,
3997 const std::string &BaseName,
3998 const std::vector<unsigned> &Sizes) {
Roman Gareevd7754a12016-07-30 09:25:51 +00003999 auto *DimSizeType = Type::getInt64Ty(getSE()->getContext());
4000 std::vector<const SCEV *> SCEVSizes;
4001
4002 for (auto size : Sizes)
Roman Gareevf5aff702016-09-12 17:08:31 +00004003 if (size)
4004 SCEVSizes.push_back(getSE()->getConstant(DimSizeType, size, false));
4005 else
4006 SCEVSizes.push_back(nullptr);
Roman Gareevd7754a12016-07-30 09:25:51 +00004007
Tobias Grosser4d5a9172017-01-14 20:25:44 +00004008 auto *SAI = getOrCreateScopArrayInfo(nullptr, ElementType, SCEVSizes,
4009 MemoryKind::Array, BaseName.c_str());
Roman Gareevd7754a12016-07-30 09:25:51 +00004010 return SAI;
4011}
4012
Tobias Grosserf3adab42017-05-10 10:59:58 +00004013const ScopArrayInfo *Scop::getScopArrayInfoOrNull(Value *BasePtr,
4014 MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00004015 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004016 return SAI;
4017}
4018
4019const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, MemoryKind Kind) {
4020 auto *SAI = getScopArrayInfoOrNull(BasePtr, Kind);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004021 assert(SAI && "No ScopArrayInfo available for this base pointer");
4022 return SAI;
4023}
4024
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00004025std::string Scop::getContextStr() const { return getContext().to_str(); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004026
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004027std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004028 assert(AssumedContext && "Assumed context not yet built");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004029 return AssumedContext.to_str();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004030}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004031
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004032std::string Scop::getInvalidContextStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004033 return InvalidContext.to_str();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004034}
Tobias Grosser75805372011-04-29 06:27:02 +00004035
4036std::string Scop::getNameStr() const {
4037 std::string ExitName, EntryName;
Siddharth Bhat07bee292017-06-02 08:01:22 +00004038 std::tie(EntryName, ExitName) = getEntryExitStr();
4039 return EntryName + "---" + ExitName;
4040}
4041
4042std::pair<std::string, std::string> Scop::getEntryExitStr() const {
4043 std::string ExitName, EntryName;
Tobias Grosser75805372011-04-29 06:27:02 +00004044 raw_string_ostream ExitStr(ExitName);
4045 raw_string_ostream EntryStr(EntryName);
4046
Tobias Grosserf240b482014-01-09 10:42:15 +00004047 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004048 EntryStr.str();
4049
4050 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00004051 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004052 ExitStr.str();
4053 } else
4054 ExitName = "FunctionExit";
4055
Siddharth Bhat07bee292017-06-02 08:01:22 +00004056 return std::make_pair(EntryName, ExitName);
Tobias Grosser75805372011-04-29 06:27:02 +00004057}
4058
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004059isl::set Scop::getContext() const { return Context; }
Tobias Grosserb65ccc42017-08-06 20:11:59 +00004060isl::space Scop::getParamSpace() const { return getContext().get_space(); }
Tobias Grosser37487052011-10-06 00:03:42 +00004061
Tobias Grosserb5563c62017-08-03 13:51:15 +00004062isl::space Scop::getFullParamSpace() const {
4063 std::vector<isl::id> FortranIDs;
4064 FortranIDs = getFortranArrayIds(arrays());
4065
4066 isl::space Space = isl::space::params_alloc(
4067 getIslCtx(), ParameterIds.size() + FortranIDs.size());
4068
4069 unsigned PDim = 0;
4070 for (const SCEV *Parameter : Parameters) {
Tobias Grosser9a635702017-08-06 19:31:27 +00004071 isl::id Id = getIdForParam(Parameter);
Tobias Grosserb5563c62017-08-03 13:51:15 +00004072 Space = Space.set_dim_id(isl::dim::param, PDim++, Id);
4073 }
4074
4075 for (isl::id Id : FortranIDs)
4076 Space = Space.set_dim_id(isl::dim::param, PDim++, Id);
4077
4078 return Space;
4079}
4080
Tobias Grossere1270332017-08-06 21:42:09 +00004081isl::set Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004082 assert(AssumedContext && "Assumed context not yet built");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004083 return AssumedContext;
Tobias Grossere86109f2013-10-29 21:05:49 +00004084}
4085
Michael Krusef3091bf2017-03-17 13:09:52 +00004086bool Scop::isProfitable(bool ScalarsAreUnprofitable) const {
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004087 if (PollyProcessUnprofitable)
4088 return true;
4089
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004090 if (isEmpty())
4091 return false;
4092
4093 unsigned OptimizableStmtsOrLoops = 0;
4094 for (auto &Stmt : *this) {
4095 if (Stmt.getNumIterators() == 0)
4096 continue;
4097
4098 bool ContainsArrayAccs = false;
4099 bool ContainsScalarAccs = false;
4100 for (auto *MA : Stmt) {
4101 if (MA->isRead())
4102 continue;
Michael Krusef3091bf2017-03-17 13:09:52 +00004103 ContainsArrayAccs |= MA->isLatestArrayKind();
4104 ContainsScalarAccs |= MA->isLatestScalarKind();
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004105 }
4106
Michael Krusef3091bf2017-03-17 13:09:52 +00004107 if (!ScalarsAreUnprofitable || (ContainsArrayAccs && !ContainsScalarAccs))
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004108 OptimizableStmtsOrLoops += Stmt.getNumIterators();
4109 }
4110
4111 return OptimizableStmtsOrLoops > 1;
4112}
4113
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00004114bool Scop::hasFeasibleRuntimeContext() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004115 auto PositiveContext = getAssumedContext();
4116 auto NegativeContext = getInvalidContext();
4117 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
4118 // addNonEmptyDomainConstraints returns null if ScopStmts have a null domain
4119 if (!PositiveContext)
Johannes Doerfert94341c92016-04-23 13:00:27 +00004120 return false;
Johannes Doerfert94341c92016-04-23 13:00:27 +00004121
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004122 bool IsFeasible = !(PositiveContext.is_empty() ||
4123 PositiveContext.is_subset(NegativeContext));
4124 if (!IsFeasible)
4125 return false;
4126
4127 auto DomainContext = getDomains().params();
4128 IsFeasible = !DomainContext.is_subset(NegativeContext);
4129 IsFeasible &= !Context.is_subset(NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004130
Johannes Doerfert43788c52015-08-20 05:58:56 +00004131 return IsFeasible;
4132}
4133
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004134static std::string toString(AssumptionKind Kind) {
4135 switch (Kind) {
4136 case ALIASING:
4137 return "No-aliasing";
4138 case INBOUNDS:
4139 return "Inbounds";
4140 case WRAPPING:
4141 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00004142 case UNSIGNED:
4143 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004144 case COMPLEXITY:
4145 return "Low complexity";
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004146 case PROFITABLE:
4147 return "Profitable";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004148 case ERRORBLOCK:
4149 return "No-error";
4150 case INFINITELOOP:
4151 return "Finite loop";
4152 case INVARIANTLOAD:
4153 return "Invariant load";
4154 case DELINEARIZATION:
4155 return "Delinearization";
4156 }
4157 llvm_unreachable("Unknown AssumptionKind!");
4158}
4159
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004160bool Scop::isEffectiveAssumption(isl::set Set, AssumptionSign Sign) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004161 if (Sign == AS_ASSUMPTION) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004162 if (Context.is_subset(Set))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004163 return false;
4164
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004165 if (AssumedContext.is_subset(Set))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004166 return false;
4167 } else {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004168 if (Set.is_disjoint(Context))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004169 return false;
4170
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004171 if (Set.is_subset(InvalidContext))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004172 return false;
4173 }
4174 return true;
4175}
4176
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004177bool Scop::trackAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4178 AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004179 if (PollyRemarksMinimal && !isEffectiveAssumption(Set, Sign))
4180 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004181
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004182 // Do never emit trivial assumptions as they only clutter the output.
4183 if (!PollyRemarksMinimal) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004184 isl::set Univ;
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004185 if (Sign == AS_ASSUMPTION)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004186 Univ = isl::set::universe(Set.get_space());
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004187
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004188 bool IsTrivial = (Sign == AS_RESTRICTION && Set.is_empty()) ||
4189 (Sign == AS_ASSUMPTION && Univ.is_equal(Set));
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004190
4191 if (IsTrivial)
4192 return false;
4193 }
4194
Johannes Doerfertcd195322016-11-17 21:41:08 +00004195 switch (Kind) {
4196 case ALIASING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004197 AssumptionsAliasing++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004198 break;
4199 case INBOUNDS:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004200 AssumptionsInbounds++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004201 break;
4202 case WRAPPING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004203 AssumptionsWrapping++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004204 break;
4205 case UNSIGNED:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004206 AssumptionsUnsigned++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004207 break;
4208 case COMPLEXITY:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004209 AssumptionsComplexity++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004210 break;
4211 case PROFITABLE:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004212 AssumptionsUnprofitable++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004213 break;
4214 case ERRORBLOCK:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004215 AssumptionsErrorBlock++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004216 break;
4217 case INFINITELOOP:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004218 AssumptionsInfiniteLoop++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004219 break;
4220 case INVARIANTLOAD:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004221 AssumptionsInvariantLoad++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004222 break;
4223 case DELINEARIZATION:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004224 AssumptionsDelinearization++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004225 break;
4226 }
4227
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004228 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004229 std::string Msg = toString(Kind) + Suffix + Set.to_str();
Eli Friedmane737fc12017-07-17 23:58:33 +00004230 if (BB)
4231 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc, BB)
4232 << Msg);
4233 else
4234 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc,
4235 R.getEntry())
4236 << Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004237 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004238}
4239
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004240void Scop::addAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4241 AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004242 // Simplify the assumptions/restrictions first.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004243 Set = Set.gist_params(getContext());
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004244
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004245 if (!trackAssumption(Kind, Set, Loc, Sign, BB))
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004246 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00004247
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004248 if (Sign == AS_ASSUMPTION)
4249 AssumedContext = AssumedContext.intersect(Set).coalesce();
4250 else
4251 InvalidContext = InvalidContext.unite(Set).coalesce();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004252}
4253
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004254void Scop::recordAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4255 AssumptionSign Sign, BasicBlock *BB) {
4256 assert((Set.is_params() || BB) &&
Tobias Grosserf67433a2016-11-10 11:44:10 +00004257 "Assumptions without a basic block must be parameter sets");
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004258 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004259}
4260
4261void Scop::addRecordedAssumptions() {
4262 while (!RecordedAssumptions.empty()) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004263 Assumption AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004264
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004265 if (!AS.BB) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004266 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign, nullptr /* BasicBlock */);
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004267 continue;
4268 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004269
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004270 // If the domain was deleted the assumptions are void.
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004271 isl_set *Dom = getDomainConditions(AS.BB).release();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004272 if (!Dom)
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004273 continue;
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004274
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004275 // If a basic block was given use its domain to simplify the assumption.
4276 // In case of restrictions we know they only have to hold on the domain,
4277 // thus we can intersect them with the domain of the block. However, for
4278 // assumptions the domain has to imply them, thus:
4279 // _ _____
4280 // Dom => S <==> A v B <==> A - B
4281 //
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004282 // To avoid the complement we will register A - B as a restriction not an
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004283 // assumption.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004284 isl_set *S = AS.Set.copy();
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004285 if (AS.Sign == AS_RESTRICTION)
4286 S = isl_set_params(isl_set_intersect(S, Dom));
4287 else /* (AS.Sign == AS_ASSUMPTION) */
4288 S = isl_set_params(isl_set_subtract(Dom, S));
4289
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004290 addAssumption(AS.Kind, isl::manage(S), AS.Loc, AS_RESTRICTION, AS.BB);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004291 }
4292}
4293
Eli Friedmane737fc12017-07-17 23:58:33 +00004294void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc, BasicBlock *BB) {
Nicola Zaghen349506a2018-05-15 13:37:17 +00004295 LLVM_DEBUG(dbgs() << "Invalidate SCoP because of reason " << Kind << "\n");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004296 addAssumption(Kind, isl::set::empty(getParamSpace()), Loc, AS_ASSUMPTION, BB);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004297}
4298
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004299isl::set Scop::getInvalidContext() const { return InvalidContext; }
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004300
Tobias Grosser75805372011-04-29 06:27:02 +00004301void Scop::printContext(raw_ostream &OS) const {
4302 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004303 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00004304
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004305 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004306 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004307
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004308 OS.indent(4) << "Invalid Context:\n";
4309 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004310
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00004311 unsigned Dim = 0;
4312 for (const SCEV *Parameter : Parameters)
4313 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004314}
4315
Johannes Doerfertb164c792014-09-18 11:17:17 +00004316void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004317 int noOfGroups = 0;
4318 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004319 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004320 noOfGroups += 1;
4321 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004322 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004323 }
4324
Tobias Grosserbb853c22015-07-25 12:31:03 +00004325 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00004326 if (MinMaxAliasGroups.empty()) {
4327 OS.indent(8) << "n/a\n";
4328 return;
4329 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004330
Tobias Grosserbb853c22015-07-25 12:31:03 +00004331 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004332
4333 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004334 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004335 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004336 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004337 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4338 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004339 }
4340 OS << " ]]\n";
4341 }
4342
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004343 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004344 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00004345 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004346 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004347 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4348 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004349 }
4350 OS << " ]]\n";
4351 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00004352 }
4353}
4354
Michael Krusecd4c9772017-07-21 15:35:53 +00004355void Scop::printStatements(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00004356 OS << "Statements {\n";
4357
Michael Krusecd4c9772017-07-21 15:35:53 +00004358 for (const ScopStmt &Stmt : *this) {
4359 OS.indent(4);
4360 Stmt.print(OS, PrintInstructions);
4361 }
Tobias Grosser75805372011-04-29 06:27:02 +00004362
4363 OS.indent(4) << "}\n";
4364}
4365
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004366void Scop::printArrayInfo(raw_ostream &OS) const {
4367 OS << "Arrays {\n";
4368
Tobias Grosserab671442015-05-23 05:58:27 +00004369 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004370 Array->print(OS);
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004371
4372 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004373
4374 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
4375
4376 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004377 Array->print(OS, /* SizeAsPwAff */ true);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004378
4379 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004380}
4381
Michael Krusecd4c9772017-07-21 15:35:53 +00004382void Scop::print(raw_ostream &OS, bool PrintInstructions) const {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004383 OS.indent(4) << "Function: " << getFunction().getName() << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00004384 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00004385 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004386 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004387 for (const auto &IAClass : InvariantEquivClasses) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004388 const auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004389 if (MAs.empty()) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004390 OS.indent(12) << "Class Pointer: " << *IAClass.IdentifyingPointer << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004391 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004392 MAs.front()->print(OS);
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004393 OS.indent(12) << "Execution Context: " << IAClass.ExecutionContext
4394 << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004395 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004396 }
4397 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004398 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004399 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00004400 printAliasAssumptions(OS);
Michael Krusecd4c9772017-07-21 15:35:53 +00004401 printStatements(OS.indent(4), PrintInstructions);
Tobias Grosser75805372011-04-29 06:27:02 +00004402}
4403
Michael Kruse5d518462017-07-21 15:54:07 +00004404#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00004405LLVM_DUMP_METHOD void Scop::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00004406#endif
Tobias Grosser75805372011-04-29 06:27:02 +00004407
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004408isl::ctx Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00004409
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004410__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
4411 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004412 // First try to use the SCEVAffinator to generate a piecewise defined
4413 // affine function from @p E in the context of @p BB. If that tasks becomes to
4414 // complex the affinator might return a nullptr. In such a case we invalidate
4415 // the SCoP and return a dummy value. This way we do not need to add error
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004416 // handling code to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004417 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004418 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00004419 // TODO: We could use a heuristic and either use:
4420 // SCEVAffinator::takeNonNegativeAssumption
4421 // or
4422 // SCEVAffinator::interpretAsUnsigned
4423 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004424 if (NonNegative)
4425 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004426 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004427 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004428
4429 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
Eli Friedmane737fc12017-07-17 23:58:33 +00004430 invalidate(COMPLEXITY, DL, BB);
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004431 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00004432}
4433
Tobias Grosser31df6f32017-08-06 21:42:25 +00004434isl::union_set Scop::getDomains() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004435 isl_space *EmptySpace = isl_space_params_alloc(getIslCtx().get(), 0);
Tobias Grosser941cb7d2017-03-17 09:02:50 +00004436 isl_union_set *Domain = isl_union_set_empty(EmptySpace);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004437
Tobias Grosser808cd692015-07-14 09:33:13 +00004438 for (const ScopStmt &Stmt : *this)
Tobias Grosserdcf8d692017-08-06 16:39:52 +00004439 Domain = isl_union_set_add_set(Domain, Stmt.getDomain().release());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004440
Tobias Grosser31df6f32017-08-06 21:42:25 +00004441 return isl::manage(Domain);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004442}
4443
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004444isl::pw_aff Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004445 PWACtx PWAC = getPwAff(E, BB);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00004446 return PWAC.first;
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004447}
4448
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004449isl::union_map
Tobias Grossere5a35142015-11-12 14:07:09 +00004450Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
Tobias Grosserb65ccc42017-08-06 20:11:59 +00004451 isl::union_map Accesses = isl::union_map::empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004452
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004453 for (ScopStmt &Stmt : *this) {
4454 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00004455 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004456 continue;
4457
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004458 isl::set Domain = Stmt.getDomain();
4459 isl::map AccessDomain = MA->getAccessRelation();
4460 AccessDomain = AccessDomain.intersect_domain(Domain);
4461 Accesses = Accesses.add_map(AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004462 }
4463 }
Tobias Grosser206e9e32017-07-24 16:22:27 +00004464
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004465 return Accesses.coalesce();
Tobias Grossere5a35142015-11-12 14:07:09 +00004466}
4467
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004468isl::union_map Scop::getMustWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004469 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004470}
4471
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004472isl::union_map Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004473 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004474}
4475
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004476isl::union_map Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004477 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004478}
4479
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004480isl::union_map Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004481 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004482}
4483
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004484isl::union_map Scop::getAccesses() {
Tobias Grosser2ac23382015-11-12 14:07:13 +00004485 return getAccessesOfType([](MemoryAccess &MA) { return true; });
4486}
4487
Tobias Grosserfa03cb72017-08-17 22:04:53 +00004488isl::union_map Scop::getAccesses(ScopArrayInfo *Array) {
4489 return getAccessesOfType(
4490 [Array](MemoryAccess &MA) { return MA.getScopArrayInfo() == Array; });
4491}
4492
Roman Gareevb3224ad2016-09-14 06:26:09 +00004493// Check whether @p Node is an extension node.
4494//
4495// @return true if @p Node is an extension node.
4496isl_bool isNotExtNode(__isl_keep isl_schedule_node *Node, void *User) {
4497 if (isl_schedule_node_get_type(Node) == isl_schedule_node_extension)
4498 return isl_bool_error;
4499 else
4500 return isl_bool_true;
4501}
4502
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004503bool Scop::containsExtensionNode(isl::schedule Schedule) {
4504 return isl_schedule_foreach_schedule_node_top_down(
Tobias Grosserd3d3d6b2018-04-29 00:28:26 +00004505 Schedule.get(), isNotExtNode, nullptr) == isl_stat_error;
Roman Gareevb3224ad2016-09-14 06:26:09 +00004506}
4507
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004508isl::union_map Scop::getSchedule() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004509 auto Tree = getScheduleTree();
4510 if (containsExtensionNode(Tree))
Roman Gareevb3224ad2016-09-14 06:26:09 +00004511 return nullptr;
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004512
4513 return Tree.get_map();
Tobias Grosser808cd692015-07-14 09:33:13 +00004514}
Tobias Grosser37eb4222014-02-20 21:43:54 +00004515
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004516isl::schedule Scop::getScheduleTree() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004517 return Schedule.intersect_domain(getDomains());
Tobias Grosser808cd692015-07-14 09:33:13 +00004518}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00004519
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004520void Scop::setSchedule(isl::union_map NewSchedule) {
4521 auto S = isl::schedule::from_domain(getDomains());
4522 Schedule = S.insert_partial_schedule(
4523 isl::multi_union_pw_aff::from_union_map(NewSchedule));
Michael Kruse2dab88e2018-06-06 21:37:35 +00004524 ScheduleModified = true;
Tobias Grosser808cd692015-07-14 09:33:13 +00004525}
4526
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004527void Scop::setScheduleTree(isl::schedule NewSchedule) {
Tobias Grosser808cd692015-07-14 09:33:13 +00004528 Schedule = NewSchedule;
Michael Kruse2dab88e2018-06-06 21:37:35 +00004529 ScheduleModified = true;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004530}
4531
Tobias Grosser990cbb42017-08-14 06:49:01 +00004532bool Scop::restrictDomains(isl::union_set Domain) {
Tobias Grosser37eb4222014-02-20 21:43:54 +00004533 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004534 for (ScopStmt &Stmt : *this) {
Tobias Grosser990cbb42017-08-14 06:49:01 +00004535 isl::union_set StmtDomain = isl::union_set(Stmt.getDomain());
4536 isl::union_set NewStmtDomain = StmtDomain.intersect(Domain);
Tobias Grosser37eb4222014-02-20 21:43:54 +00004537
Tobias Grosser990cbb42017-08-14 06:49:01 +00004538 if (StmtDomain.is_subset(NewStmtDomain))
Tobias Grosser37eb4222014-02-20 21:43:54 +00004539 continue;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004540
4541 Changed = true;
4542
Tobias Grosser990cbb42017-08-14 06:49:01 +00004543 NewStmtDomain = NewStmtDomain.coalesce();
Tobias Grosser37eb4222014-02-20 21:43:54 +00004544
Tobias Grosser990cbb42017-08-14 06:49:01 +00004545 if (NewStmtDomain.is_empty())
Tobias Grosserdcf8d692017-08-06 16:39:52 +00004546 Stmt.restrictDomain(isl::set::empty(Stmt.getDomainSpace()));
Tobias Grosser990cbb42017-08-14 06:49:01 +00004547 else
4548 Stmt.restrictDomain(isl::set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004549 }
Tobias Grosser37eb4222014-02-20 21:43:54 +00004550 return Changed;
4551}
4552
Tobias Grosser75805372011-04-29 06:27:02 +00004553ScalarEvolution *Scop::getSE() const { return SE; }
4554
Tobias Grosserc80d6972016-09-02 06:33:33 +00004555// Create an isl_multi_union_aff that defines an identity mapping from the
4556// elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00004557//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004558// # Example:
4559//
4560// Domain: { A[i,j]; B[i,j,k] }
4561// N: 1
4562//
4563// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
4564//
4565// @param USet A union set describing the elements for which to generate a
4566// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00004567// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004568// @returns A mapping from USet to its N-th dimension.
Tobias Grosser99320862017-05-26 17:22:03 +00004569static isl::multi_union_pw_aff mapToDimension(isl::union_set USet, int N) {
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004570 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00004571 assert(USet);
Siddharth Bhat8bb436e2017-05-29 11:34:29 +00004572 assert(!USet.is_empty());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004573
Tobias Grosser99320862017-05-26 17:22:03 +00004574 auto Result = isl::union_pw_multi_aff::empty(USet.get_space());
Tobias Grosser808cd692015-07-14 09:33:13 +00004575
Tobias Grosser99320862017-05-26 17:22:03 +00004576 auto Lambda = [&Result, N](isl::set S) -> isl::stat {
4577 int Dim = S.dim(isl::dim::set);
4578 auto PMA = isl::pw_multi_aff::project_out_map(S.get_space(), isl::dim::set,
4579 N, Dim - N);
4580 if (N > 1)
4581 PMA = PMA.drop_dims(isl::dim::out, 0, N - 1);
Tobias Grosser808cd692015-07-14 09:33:13 +00004582
Tobias Grosser99320862017-05-26 17:22:03 +00004583 Result = Result.add_pw_multi_aff(PMA);
4584 return isl::stat::ok;
4585 };
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004586
Tobias Grosser99320862017-05-26 17:22:03 +00004587 isl::stat Res = USet.foreach_set(Lambda);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004588 (void)Res;
4589
Tobias Grosser99320862017-05-26 17:22:03 +00004590 assert(Res == isl::stat::ok);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004591
Tobias Grosser99320862017-05-26 17:22:03 +00004592 return isl::multi_union_pw_aff(isl::union_pw_multi_aff(Result));
Tobias Grosser808cd692015-07-14 09:33:13 +00004593}
4594
Michael Krused6e22082018-01-18 15:15:38 +00004595void Scop::addScopStmt(BasicBlock *BB, StringRef Name, Loop *SurroundingLoop,
4596 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004597 assert(BB && "Unexpected nullptr!");
Michael Krused6e22082018-01-18 15:15:38 +00004598 Stmts.emplace_back(*this, *BB, Name, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004599 auto *Stmt = &Stmts.back();
Michael Kruse4dfa7322017-07-18 15:41:49 +00004600 StmtMap[BB].push_back(Stmt);
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004601 for (Instruction *Inst : Instructions) {
4602 assert(!InstStmtMap.count(Inst) &&
4603 "Unexpected statement corresponding to the instruction.");
4604 InstStmtMap[Inst] = Stmt;
4605 }
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004606}
4607
Michael Krused6e22082018-01-18 15:15:38 +00004608void Scop::addScopStmt(Region *R, StringRef Name, Loop *SurroundingLoop,
Tobias Grosserbd15d132017-08-31 03:15:56 +00004609 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004610 assert(R && "Unexpected nullptr!");
Michael Krused6e22082018-01-18 15:15:38 +00004611 Stmts.emplace_back(*this, *R, Name, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004612 auto *Stmt = &Stmts.back();
Tobias Grosserbd15d132017-08-31 03:15:56 +00004613
4614 for (Instruction *Inst : Instructions) {
4615 assert(!InstStmtMap.count(Inst) &&
4616 "Unexpected statement corresponding to the instruction.");
4617 InstStmtMap[Inst] = Stmt;
4618 }
4619
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004620 for (BasicBlock *BB : R->blocks()) {
Michael Kruse4dfa7322017-07-18 15:41:49 +00004621 StmtMap[BB].push_back(Stmt);
Tobias Grosserbd15d132017-08-31 03:15:56 +00004622 if (BB == R->getEntry())
4623 continue;
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004624 for (Instruction &Inst : *BB) {
4625 assert(!InstStmtMap.count(&Inst) &&
4626 "Unexpected statement corresponding to the instruction.");
4627 InstStmtMap[&Inst] = Stmt;
4628 }
4629 }
Tobias Grosser808cd692015-07-14 09:33:13 +00004630}
4631
Tobias Grosser85048ef2017-08-06 17:24:59 +00004632ScopStmt *Scop::addScopStmt(isl::map SourceRel, isl::map TargetRel,
4633 isl::set Domain) {
Tobias Grossereba86a12016-11-09 04:24:49 +00004634#ifndef NDEBUG
Tobias Grosser85048ef2017-08-06 17:24:59 +00004635 isl::set SourceDomain = SourceRel.domain();
4636 isl::set TargetDomain = TargetRel.domain();
4637 assert(Domain.is_subset(TargetDomain) &&
Tobias Grosser744740a2016-11-05 21:02:43 +00004638 "Target access not defined for complete statement domain");
Tobias Grosser85048ef2017-08-06 17:24:59 +00004639 assert(Domain.is_subset(SourceDomain) &&
Tobias Grosser744740a2016-11-05 21:02:43 +00004640 "Source access not defined for complete statement domain");
Tobias Grossereba86a12016-11-09 04:24:49 +00004641#endif
Roman Gareevb3224ad2016-09-14 06:26:09 +00004642 Stmts.emplace_back(*this, SourceRel, TargetRel, Domain);
4643 CopyStmtsNum++;
4644 return &(Stmts.back());
4645}
4646
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004647void Scop::buildSchedule(LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004648 Loop *L = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004649 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004650 buildSchedule(getRegion().getNode(), LoopStack, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004651 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4652 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004653}
4654
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004655/// To generate a schedule for the elements in a Region we traverse the Region
4656/// in reverse-post-order and add the contained RegionNodes in traversal order
4657/// to the schedule of the loop that is currently at the top of the LoopStack.
4658/// For loop-free codes, this results in a correct sequential ordering.
4659///
4660/// Example:
4661/// bb1(0)
4662/// / \.
4663/// bb2(1) bb3(2)
4664/// \ / \.
4665/// bb4(3) bb5(4)
4666/// \ /
4667/// bb6(5)
4668///
4669/// Including loops requires additional processing. Whenever a loop header is
4670/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4671/// from an empty schedule, we first process all RegionNodes that are within
4672/// this loop and complete the sequential schedule at this loop-level before
4673/// processing about any other nodes. To implement this
4674/// loop-nodes-first-processing, the reverse post-order traversal is
4675/// insufficient. Hence, we additionally check if the traversal yields
4676/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4677/// These region-nodes are then queue and only traverse after the all nodes
4678/// within the current loop have been processed.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004679void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004680 Loop *OuterScopLoop = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004681
4682 ReversePostOrderTraversal<Region *> RTraversal(R);
4683 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4684 std::deque<RegionNode *> DelayList;
4685 bool LastRNWaiting = false;
4686
4687 // Iterate over the region @p R in reverse post-order but queue
4688 // sub-regions/blocks iff they are not part of the last encountered but not
4689 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4690 // that we queued the last sub-region/block from the reverse post-order
4691 // iterator. If it is set we have to explore the next sub-region/block from
4692 // the iterator (if any) to guarantee progress. If it is not set we first try
4693 // the next queued sub-region/blocks.
4694 while (!WorkList.empty() || !DelayList.empty()) {
4695 RegionNode *RN;
4696
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004697 if ((LastRNWaiting && !WorkList.empty()) || DelayList.empty()) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004698 RN = WorkList.front();
4699 WorkList.pop_front();
4700 LastRNWaiting = false;
4701 } else {
4702 RN = DelayList.front();
4703 DelayList.pop_front();
4704 }
4705
4706 Loop *L = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00004707 if (!contains(L))
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004708 L = OuterScopLoop;
4709
Tobias Grosser151ae322016-04-03 19:36:52 +00004710 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004711 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004712 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004713 LastRNWaiting = true;
4714 DelayList.push_back(RN);
4715 continue;
4716 }
4717 LoopStack.push_back({L, nullptr, 0});
4718 }
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004719 buildSchedule(RN, LoopStack, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004720 }
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004721}
4722
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004723void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack, LoopInfo &LI) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004724 if (RN->isSubRegion()) {
4725 auto *LocalRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004726 if (!isNonAffineSubRegion(LocalRegion)) {
4727 buildSchedule(LocalRegion, LoopStack, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004728 return;
4729 }
4730 }
Michael Kruse046dde42015-08-10 13:01:57 +00004731
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004732 assert(LoopStack.rbegin() != LoopStack.rend());
4733 auto LoopData = LoopStack.rbegin();
4734 LoopData->NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004735
Michael Kruse1ce67912017-07-20 17:18:58 +00004736 for (auto *Stmt : getStmtListFor(RN)) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004737 isl::union_set UDomain{Stmt->getDomain()};
4738 auto StmtSchedule = isl::schedule::from_domain(UDomain);
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004739 LoopData->Schedule = combineInSequence(LoopData->Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004740 }
4741
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004742 // Check if we just processed the last node in this loop. If we did, finalize
4743 // the loop by:
4744 //
4745 // - adding new schedule dimensions
4746 // - folding the resulting schedule into the parent loop schedule
4747 // - dropping the loop schedule from the LoopStack.
4748 //
4749 // Then continue to check surrounding loops, which might also have been
4750 // completed by this node.
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004751 size_t Dimension = LoopStack.size();
4752 while (LoopData->L &&
4753 LoopData->NumBlocksProcessed == getNumBlocksInLoop(LoopData->L)) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004754 isl::schedule Schedule = LoopData->Schedule;
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004755 auto NumBlocksProcessed = LoopData->NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004756
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004757 assert(std::next(LoopData) != LoopStack.rend());
4758 ++LoopData;
4759 --Dimension;
Tobias Grosser8362c262016-01-06 15:30:06 +00004760
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004761 if (Schedule) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004762 isl::union_set Domain = Schedule.get_domain();
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004763 isl::multi_union_pw_aff MUPA = mapToDimension(Domain, Dimension);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004764 Schedule = Schedule.insert_partial_schedule(MUPA);
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004765 LoopData->Schedule = combineInSequence(LoopData->Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004766 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004767
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004768 LoopData->NumBlocksProcessed += NumBlocksProcessed;
Tobias Grosser808cd692015-07-14 09:33:13 +00004769 }
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004770 // Now pop all loops processed up there from the LoopStack
4771 LoopStack.erase(LoopStack.begin() + Dimension, LoopStack.end());
Tobias Grosser75805372011-04-29 06:27:02 +00004772}
4773
Michael Kruse6eba4b12017-07-20 17:08:50 +00004774ArrayRef<ScopStmt *> Scop::getStmtListFor(BasicBlock *BB) const {
4775 auto StmtMapIt = StmtMap.find(BB);
4776 if (StmtMapIt == StmtMap.end())
4777 return {};
Michael Kruse6eba4b12017-07-20 17:08:50 +00004778 return StmtMapIt->second;
4779}
4780
Michael Krusea230f222018-01-23 23:56:36 +00004781ScopStmt *Scop::getIncomingStmtFor(const Use &U) const {
4782 auto *PHI = cast<PHINode>(U.getUser());
4783 BasicBlock *IncomingBB = PHI->getIncomingBlock(U);
4784
4785 // If the value is a non-synthesizable from the incoming block, use the
4786 // statement that contains it as user statement.
4787 if (auto *IncomingInst = dyn_cast<Instruction>(U.get())) {
4788 if (IncomingInst->getParent() == IncomingBB) {
4789 if (ScopStmt *IncomingStmt = getStmtFor(IncomingInst))
4790 return IncomingStmt;
4791 }
4792 }
4793
4794 // Otherwise, use the epilogue/last statement.
4795 return getLastStmtFor(IncomingBB);
4796}
4797
Michael Kruse6eba4b12017-07-20 17:08:50 +00004798ScopStmt *Scop::getLastStmtFor(BasicBlock *BB) const {
4799 ArrayRef<ScopStmt *> StmtList = getStmtListFor(BB);
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004800 if (!StmtList.empty())
Michael Kruse6eba4b12017-07-20 17:08:50 +00004801 return StmtList.back();
4802 return nullptr;
4803}
4804
Michael Kruse1ce67912017-07-20 17:18:58 +00004805ArrayRef<ScopStmt *> Scop::getStmtListFor(RegionNode *RN) const {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004806 if (RN->isSubRegion())
Michael Kruse1ce67912017-07-20 17:18:58 +00004807 return getStmtListFor(RN->getNodeAs<Region>());
4808 return getStmtListFor(RN->getNodeAs<BasicBlock>());
Michael Kruse6f7721f2016-02-24 22:08:19 +00004809}
4810
Michael Kruse1ce67912017-07-20 17:18:58 +00004811ArrayRef<ScopStmt *> Scop::getStmtListFor(Region *R) const {
4812 return getStmtListFor(R->getEntry());
Michael Krusea902ba62015-12-13 19:21:45 +00004813}
4814
Johannes Doerfert96425c22015-08-30 21:13:53 +00004815int Scop::getRelativeLoopDepth(const Loop *L) const {
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004816 if (!L || !R.contains(L))
Johannes Doerfert96425c22015-08-30 21:13:53 +00004817 return -1;
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004818 // outermostLoopInRegion always returns nullptr for top level regions
4819 if (R.isTopLevelRegion()) {
4820 // LoopInfo's depths start at 1, we start at 0
4821 return L->getLoopDepth() - 1;
4822 } else {
4823 Loop *OuterLoop = R.outermostLoopInRegion(const_cast<Loop *>(L));
4824 assert(OuterLoop);
4825 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4826 }
Johannes Doerfertd020b772015-08-27 06:53:52 +00004827}
4828
Roman Gareevd7754a12016-07-30 09:25:51 +00004829ScopArrayInfo *Scop::getArrayInfoByName(const std::string BaseName) {
4830 for (auto &SAI : arrays()) {
4831 if (SAI->getName() == BaseName)
4832 return SAI;
4833 }
4834 return nullptr;
4835}
4836
Michael Kruse8b805802017-07-19 17:11:25 +00004837void Scop::addAccessData(MemoryAccess *Access) {
4838 const ScopArrayInfo *SAI = Access->getOriginalScopArrayInfo();
4839 assert(SAI && "can only use after access relations have been constructed");
4840
4841 if (Access->isOriginalValueKind() && Access->isRead())
4842 ValueUseAccs[SAI].push_back(Access);
4843 else if (Access->isOriginalAnyPHIKind() && Access->isWrite())
4844 PHIIncomingAccs[SAI].push_back(Access);
4845}
4846
4847void Scop::removeAccessData(MemoryAccess *Access) {
Michael Kruse6d7a7892017-09-21 14:23:11 +00004848 if (Access->isOriginalValueKind() && Access->isWrite()) {
4849 ValueDefAccs.erase(Access->getAccessValue());
4850 } else if (Access->isOriginalValueKind() && Access->isRead()) {
Michael Kruse8b805802017-07-19 17:11:25 +00004851 auto &Uses = ValueUseAccs[Access->getScopArrayInfo()];
Michael Kruse7de61662018-04-09 23:13:01 +00004852 auto NewEnd = std::remove(Uses.begin(), Uses.end(), Access);
4853 Uses.erase(NewEnd, Uses.end());
Michael Kruse6d7a7892017-09-21 14:23:11 +00004854 } else if (Access->isOriginalPHIKind() && Access->isRead()) {
4855 PHINode *PHI = cast<PHINode>(Access->getAccessInstruction());
4856 PHIReadAccs.erase(PHI);
Michael Kruse8b805802017-07-19 17:11:25 +00004857 } else if (Access->isOriginalAnyPHIKind() && Access->isWrite()) {
4858 auto &Incomings = PHIIncomingAccs[Access->getScopArrayInfo()];
Michael Kruse7de61662018-04-09 23:13:01 +00004859 auto NewEnd = std::remove(Incomings.begin(), Incomings.end(), Access);
4860 Incomings.erase(NewEnd, Incomings.end());
Michael Kruse8b805802017-07-19 17:11:25 +00004861 }
4862}
4863
4864MemoryAccess *Scop::getValueDef(const ScopArrayInfo *SAI) const {
4865 assert(SAI->isValueKind());
4866
4867 Instruction *Val = dyn_cast<Instruction>(SAI->getBasePtr());
4868 if (!Val)
4869 return nullptr;
4870
Michael Kruse6d7a7892017-09-21 14:23:11 +00004871 return ValueDefAccs.lookup(Val);
Michael Kruse8b805802017-07-19 17:11:25 +00004872}
4873
4874ArrayRef<MemoryAccess *> Scop::getValueUses(const ScopArrayInfo *SAI) const {
4875 assert(SAI->isValueKind());
4876 auto It = ValueUseAccs.find(SAI);
4877 if (It == ValueUseAccs.end())
4878 return {};
4879 return It->second;
4880}
4881
4882MemoryAccess *Scop::getPHIRead(const ScopArrayInfo *SAI) const {
4883 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
4884
4885 if (SAI->isExitPHIKind())
4886 return nullptr;
4887
4888 PHINode *PHI = cast<PHINode>(SAI->getBasePtr());
Michael Kruse6d7a7892017-09-21 14:23:11 +00004889 return PHIReadAccs.lookup(PHI);
Michael Kruse8b805802017-07-19 17:11:25 +00004890}
4891
4892ArrayRef<MemoryAccess *> Scop::getPHIIncomings(const ScopArrayInfo *SAI) const {
4893 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
4894 auto It = PHIIncomingAccs.find(SAI);
4895 if (It == PHIIncomingAccs.end())
4896 return {};
4897 return It->second;
4898}
4899
Michael Krusea508a4e2017-07-27 14:39:52 +00004900bool Scop::isEscaping(Instruction *Inst) {
4901 assert(contains(Inst) && "The concept of escaping makes only sense for "
4902 "values defined inside the SCoP");
4903
4904 for (Use &Use : Inst->uses()) {
4905 BasicBlock *UserBB = getUseBlock(Use);
4906 if (!contains(UserBB))
4907 return true;
4908
4909 // When the SCoP region exit needs to be simplified, PHIs in the region exit
4910 // move to a new basic block such that its incoming blocks are not in the
4911 // SCoP anymore.
4912 if (hasSingleExitEdge() && isa<PHINode>(Use.getUser()) &&
4913 isExit(cast<PHINode>(Use.getUser())->getParent()))
4914 return true;
4915 }
4916 return false;
4917}
4918
Michael Kruse06ed5292017-08-23 13:50:30 +00004919Scop::ScopStatistics Scop::getStatistics() const {
4920 ScopStatistics Result;
4921#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
4922 auto LoopStat = ScopDetection::countBeneficialLoops(&R, *SE, *getLI(), 0);
4923
4924 int NumTotalLoops = LoopStat.NumLoops;
4925 Result.NumBoxedLoops = getBoxedLoops().size();
4926 Result.NumAffineLoops = NumTotalLoops - Result.NumBoxedLoops;
4927
4928 for (const ScopStmt &Stmt : *this) {
4929 isl::set Domain = Stmt.getDomain().intersect_params(getContext());
4930 bool IsInLoop = Stmt.getNumIterators() >= 1;
4931 for (MemoryAccess *MA : Stmt) {
4932 if (!MA->isWrite())
4933 continue;
4934
4935 if (MA->isLatestValueKind()) {
4936 Result.NumValueWrites += 1;
4937 if (IsInLoop)
4938 Result.NumValueWritesInLoops += 1;
4939 }
4940
4941 if (MA->isLatestAnyPHIKind()) {
4942 Result.NumPHIWrites += 1;
4943 if (IsInLoop)
4944 Result.NumPHIWritesInLoops += 1;
4945 }
4946
4947 isl::set AccSet =
4948 MA->getAccessRelation().intersect_domain(Domain).range();
4949 if (AccSet.is_singleton()) {
4950 Result.NumSingletonWrites += 1;
4951 if (IsInLoop)
4952 Result.NumSingletonWritesInLoops += 1;
4953 }
4954 }
4955 }
4956#endif
4957 return Result;
4958}
4959
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004960raw_ostream &polly::operator<<(raw_ostream &OS, const Scop &scop) {
4961 scop.print(OS, PollyPrintInstructions);
4962 return OS;
Michael Krusecd4c9772017-07-21 15:35:53 +00004963}
4964
Johannes Doerfert99191c72016-05-31 09:41:04 +00004965//===----------------------------------------------------------------------===//
4966void ScopInfoRegionPass::getAnalysisUsage(AnalysisUsage &AU) const {
4967 AU.addRequired<LoopInfoWrapperPass>();
4968 AU.addRequired<RegionInfoPass>();
4969 AU.addRequired<DominatorTreeWrapperPass>();
4970 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00004971 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004972 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00004973 AU.addRequired<AssumptionCacheTracker>();
Michael Krusea4f447c2017-08-28 14:07:33 +00004974 AU.addRequired<OptimizationRemarkEmitterWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004975 AU.setPreservesAll();
4976}
4977
Michael Kruse06ed5292017-08-23 13:50:30 +00004978void updateLoopCountStatistic(ScopDetection::LoopStats Stats,
4979 Scop::ScopStatistics ScopStats) {
4980 assert(Stats.NumLoops == ScopStats.NumAffineLoops + ScopStats.NumBoxedLoops);
4981
4982 NumScops++;
Tobias Grossercd01a362017-02-17 08:12:36 +00004983 NumLoopsInScop += Stats.NumLoops;
4984 MaxNumLoopsInScop =
4985 std::max(MaxNumLoopsInScop.getValue(), (unsigned)Stats.NumLoops);
4986
Tobias Grosserfcc3ad52018-04-18 20:03:36 +00004987 if (Stats.MaxDepth == 0)
4988 NumScopsDepthZero++;
4989 else if (Stats.MaxDepth == 1)
Tobias Grossercd01a362017-02-17 08:12:36 +00004990 NumScopsDepthOne++;
4991 else if (Stats.MaxDepth == 2)
4992 NumScopsDepthTwo++;
4993 else if (Stats.MaxDepth == 3)
4994 NumScopsDepthThree++;
4995 else if (Stats.MaxDepth == 4)
4996 NumScopsDepthFour++;
4997 else if (Stats.MaxDepth == 5)
4998 NumScopsDepthFive++;
4999 else
5000 NumScopsDepthLarger++;
Michael Kruse06ed5292017-08-23 13:50:30 +00005001
5002 NumAffineLoops += ScopStats.NumAffineLoops;
5003 NumBoxedLoops += ScopStats.NumBoxedLoops;
5004
5005 NumValueWrites += ScopStats.NumValueWrites;
5006 NumValueWritesInLoops += ScopStats.NumValueWritesInLoops;
5007 NumPHIWrites += ScopStats.NumPHIWrites;
5008 NumPHIWritesInLoops += ScopStats.NumPHIWritesInLoops;
5009 NumSingletonWrites += ScopStats.NumSingletonWrites;
5010 NumSingletonWritesInLoops += ScopStats.NumSingletonWritesInLoops;
Tobias Grossercd01a362017-02-17 08:12:36 +00005011}
5012
Johannes Doerfert99191c72016-05-31 09:41:04 +00005013bool ScopInfoRegionPass::runOnRegion(Region *R, RGPassManager &RGM) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005014 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005015
5016 if (!SD.isMaxRegionInScop(*R))
5017 return false;
5018
5019 Function *F = R->getEntry()->getParent();
5020 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5021 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5022 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5023 auto const &DL = F->getParent()->getDataLayout();
5024 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005025 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krusea4f447c2017-08-28 14:07:33 +00005026 auto &ORE = getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005027
Michael Krusea4f447c2017-08-28 14:07:33 +00005028 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE, ORE);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005029 S = SB.getScop(); // take ownership of scop object
Tobias Grossercd01a362017-02-17 08:12:36 +00005030
Michael Kruse06ed5292017-08-23 13:50:30 +00005031#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
Tobias Grossercd01a362017-02-17 08:12:36 +00005032 if (S) {
5033 ScopDetection::LoopStats Stats =
5034 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
Michael Kruse06ed5292017-08-23 13:50:30 +00005035 updateLoopCountStatistic(Stats, S->getStatistics());
Tobias Grossercd01a362017-02-17 08:12:36 +00005036 }
Michael Kruse06ed5292017-08-23 13:50:30 +00005037#endif
Tobias Grossercd01a362017-02-17 08:12:36 +00005038
Tobias Grosser75805372011-04-29 06:27:02 +00005039 return false;
5040}
5041
Johannes Doerfert99191c72016-05-31 09:41:04 +00005042void ScopInfoRegionPass::print(raw_ostream &OS, const Module *) const {
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005043 if (S)
Michael Krusecd4c9772017-07-21 15:35:53 +00005044 S->print(OS, PollyPrintInstructions);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005045 else
5046 OS << "Invalid Scop!\n";
Johannes Doerfert99191c72016-05-31 09:41:04 +00005047}
Tobias Grosser75805372011-04-29 06:27:02 +00005048
Johannes Doerfert99191c72016-05-31 09:41:04 +00005049char ScopInfoRegionPass::ID = 0;
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005050
Johannes Doerfert99191c72016-05-31 09:41:04 +00005051Pass *polly::createScopInfoRegionPassPass() { return new ScopInfoRegionPass(); }
5052
5053INITIALIZE_PASS_BEGIN(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005054 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005055 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00005056INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005057INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00005058INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00005059INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00005060INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005061INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert96425c22015-08-30 21:13:53 +00005062INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005063INITIALIZE_PASS_END(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005064 "Polly - Create polyhedral description of Scops", false,
5065 false)
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005066
5067//===----------------------------------------------------------------------===//
Philip Pfaffe838e0882017-05-15 12:55:14 +00005068ScopInfo::ScopInfo(const DataLayout &DL, ScopDetection &SD, ScalarEvolution &SE,
5069 LoopInfo &LI, AliasAnalysis &AA, DominatorTree &DT,
Michael Krusea4f447c2017-08-28 14:07:33 +00005070 AssumptionCache &AC, OptimizationRemarkEmitter &ORE)
5071 : DL(DL), SD(SD), SE(SE), LI(LI), AA(AA), DT(DT), AC(AC), ORE(ORE) {
Philip Pfaffef43e7c22017-08-10 07:43:46 +00005072 recompute();
5073}
5074
5075void ScopInfo::recompute() {
5076 RegionToScopMap.clear();
Michael Krusea6d48f52017-06-08 12:06:15 +00005077 /// Create polyhedral description of scops for all the valid regions of a
Philip Pfaffe838e0882017-05-15 12:55:14 +00005078 /// function.
5079 for (auto &It : SD) {
5080 Region *R = const_cast<Region *>(It);
5081 if (!SD.isMaxRegionInScop(*R))
5082 continue;
5083
Michael Krusea4f447c2017-08-28 14:07:33 +00005084 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE, ORE);
Philip Pfaffe838e0882017-05-15 12:55:14 +00005085 std::unique_ptr<Scop> S = SB.getScop();
5086 if (!S)
5087 continue;
Michael Kruse06ed5292017-08-23 13:50:30 +00005088#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
Philip Pfaffeead67db2017-08-02 11:14:41 +00005089 ScopDetection::LoopStats Stats =
5090 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
Michael Kruse06ed5292017-08-23 13:50:30 +00005091 updateLoopCountStatistic(Stats, S->getStatistics());
5092#endif
Philip Pfaffe838e0882017-05-15 12:55:14 +00005093 bool Inserted = RegionToScopMap.insert({R, std::move(S)}).second;
5094 assert(Inserted && "Building Scop for the same region twice!");
5095 (void)Inserted;
5096 }
5097}
5098
Philip Pfaffef43e7c22017-08-10 07:43:46 +00005099bool ScopInfo::invalidate(Function &F, const PreservedAnalyses &PA,
5100 FunctionAnalysisManager::Invalidator &Inv) {
5101 // Check whether the analysis, all analyses on functions have been preserved
5102 // or anything we're holding references to is being invalidated
5103 auto PAC = PA.getChecker<ScopInfoAnalysis>();
5104 return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) ||
5105 Inv.invalidate<ScopAnalysis>(F, PA) ||
5106 Inv.invalidate<ScalarEvolutionAnalysis>(F, PA) ||
5107 Inv.invalidate<LoopAnalysis>(F, PA) ||
5108 Inv.invalidate<AAManager>(F, PA) ||
5109 Inv.invalidate<DominatorTreeAnalysis>(F, PA) ||
5110 Inv.invalidate<AssumptionAnalysis>(F, PA);
5111}
5112
Philip Pfaffe838e0882017-05-15 12:55:14 +00005113AnalysisKey ScopInfoAnalysis::Key;
5114
5115ScopInfoAnalysis::Result ScopInfoAnalysis::run(Function &F,
5116 FunctionAnalysisManager &FAM) {
5117 auto &SD = FAM.getResult<ScopAnalysis>(F);
5118 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
5119 auto &LI = FAM.getResult<LoopAnalysis>(F);
5120 auto &AA = FAM.getResult<AAManager>(F);
5121 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
5122 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
5123 auto &DL = F.getParent()->getDataLayout();
Michael Krusea4f447c2017-08-28 14:07:33 +00005124 auto &ORE = FAM.getResult<OptimizationRemarkEmitterAnalysis>(F);
5125 return {DL, SD, SE, LI, AA, DT, AC, ORE};
Philip Pfaffe838e0882017-05-15 12:55:14 +00005126}
5127
5128PreservedAnalyses ScopInfoPrinterPass::run(Function &F,
5129 FunctionAnalysisManager &FAM) {
5130 auto &SI = FAM.getResult<ScopInfoAnalysis>(F);
Philip Pfaffe96d21432017-08-04 11:28:51 +00005131 // Since the legacy PM processes Scops in bottom up, we print them in reverse
5132 // order here to keep the output persistent
5133 for (auto &It : reverse(SI)) {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005134 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005135 It.second->print(Stream, PollyPrintInstructions);
Philip Pfaffe838e0882017-05-15 12:55:14 +00005136 else
5137 Stream << "Invalid Scop!\n";
5138 }
5139 return PreservedAnalyses::all();
5140}
5141
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005142void ScopInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
5143 AU.addRequired<LoopInfoWrapperPass>();
5144 AU.addRequired<RegionInfoPass>();
5145 AU.addRequired<DominatorTreeWrapperPass>();
5146 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005147 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005148 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005149 AU.addRequired<AssumptionCacheTracker>();
Michael Krusea4f447c2017-08-28 14:07:33 +00005150 AU.addRequired<OptimizationRemarkEmitterWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005151 AU.setPreservesAll();
5152}
5153
5154bool ScopInfoWrapperPass::runOnFunction(Function &F) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005155 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005156 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5157 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5158 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5159 auto const &DL = F.getParent()->getDataLayout();
5160 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005161 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Michael Krusea4f447c2017-08-28 14:07:33 +00005162 auto &ORE = getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005163
Michael Krusea4f447c2017-08-28 14:07:33 +00005164 Result.reset(new ScopInfo{DL, SD, SE, LI, AA, DT, AC, ORE});
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005165 return false;
5166}
5167
5168void ScopInfoWrapperPass::print(raw_ostream &OS, const Module *) const {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005169 for (auto &It : *Result) {
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005170 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005171 It.second->print(OS, PollyPrintInstructions);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005172 else
5173 OS << "Invalid Scop!\n";
5174 }
5175}
5176
5177char ScopInfoWrapperPass::ID = 0;
5178
5179Pass *polly::createScopInfoWrapperPassPass() {
5180 return new ScopInfoWrapperPass();
5181}
5182
5183INITIALIZE_PASS_BEGIN(
5184 ScopInfoWrapperPass, "polly-function-scops",
5185 "Polly - Create polyhedral description of all Scops of a function", false,
5186 false);
5187INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005188INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005189INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
5190INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
5191INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005192INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005193INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
5194INITIALIZE_PASS_END(
5195 ScopInfoWrapperPass, "polly-function-scops",
5196 "Polly - Create polyhedral description of all Scops of a function", false,
5197 false)