blob: e68551b470f6b955027466967e7d2d8b0d361dd5 [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"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000027#include "polly/Support/SCEVAffinator.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000028#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000029#include "polly/Support/ScopHelper.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000030#include "llvm/ADT/APInt.h"
31#include "llvm/ADT/ArrayRef.h"
32#include "llvm/ADT/DenseMap.h"
33#include "llvm/ADT/DenseSet.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000034#include "llvm/ADT/PostOrderIterator.h"
35#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000036#include "llvm/ADT/SetVector.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000037#include "llvm/ADT/SmallPtrSet.h"
38#include "llvm/ADT/SmallSet.h"
39#include "llvm/ADT/SmallVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000040#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000041#include "llvm/ADT/StringExtras.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000042#include "llvm/ADT/StringMap.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000043#include "llvm/Analysis/AliasAnalysis.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000044#include "llvm/Analysis/AliasSetTracker.h"
Michael Kruse89b1f942017-03-17 13:56:53 +000045#include "llvm/Analysis/AssumptionCache.h"
Johannes Doerfert1dc12af2016-04-23 12:59:18 +000046#include "llvm/Analysis/Loads.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000047#include "llvm/Analysis/LoopInfo.h"
Adam Nemete0f15412017-10-09 23:49:08 +000048#include "llvm/Analysis/OptimizationRemarkEmitter.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000049#include "llvm/Analysis/RegionInfo.h"
Tobias Grosser83628182013-05-07 08:11:54 +000050#include "llvm/Analysis/RegionIterator.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000051#include "llvm/Analysis/ScalarEvolution.h"
Tobias Grosser83628182013-05-07 08:11:54 +000052#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000053#include "llvm/IR/Argument.h"
54#include "llvm/IR/BasicBlock.h"
55#include "llvm/IR/CFG.h"
56#include "llvm/IR/ConstantRange.h"
57#include "llvm/IR/Constants.h"
58#include "llvm/IR/DataLayout.h"
59#include "llvm/IR/DebugLoc.h"
60#include "llvm/IR/DerivedTypes.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000061#include "llvm/IR/DiagnosticInfo.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000062#include "llvm/IR/Dominators.h"
63#include "llvm/IR/Function.h"
64#include "llvm/IR/InstrTypes.h"
65#include "llvm/IR/Instruction.h"
66#include "llvm/IR/Instructions.h"
67#include "llvm/IR/IntrinsicInst.h"
68#include "llvm/IR/Module.h"
69#include "llvm/IR/PassManager.h"
70#include "llvm/IR/Type.h"
71#include "llvm/IR/Use.h"
72#include "llvm/IR/User.h"
73#include "llvm/IR/Value.h"
74#include "llvm/Pass.h"
75#include "llvm/Support/Casting.h"
76#include "llvm/Support/CommandLine.h"
77#include "llvm/Support/Compiler.h"
Tobias Grosser75805372011-04-29 06:27:02 +000078#include "llvm/Support/Debug.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000079#include "llvm/Support/ErrorHandling.h"
80#include "llvm/Support/MathExtras.h"
81#include "llvm/Support/raw_ostream.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000082#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000083#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000084#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000085#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000086#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000087#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000088#include "isl/schedule.h"
89#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000090#include "isl/set.h"
91#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000092#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000093#include "isl/val.h"
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +000094#include <algorithm>
95#include <cassert>
96#include <cstdlib>
97#include <cstring>
98#include <deque>
99#include <iterator>
100#include <memory>
Tobias Grosser75805372011-04-29 06:27:02 +0000101#include <string>
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000102#include <tuple>
103#include <utility>
Tobias Grosser75805372011-04-29 06:27:02 +0000104#include <vector>
105
106using namespace llvm;
107using namespace polly;
108
Chandler Carruth95fef942014-04-22 03:30:19 +0000109#define DEBUG_TYPE "polly-scops"
110
Johannes Doerfert81aa6e82016-11-18 14:37:08 +0000111STATISTIC(AssumptionsAliasing, "Number of aliasing assumptions taken.");
112STATISTIC(AssumptionsInbounds, "Number of inbounds assumptions taken.");
113STATISTIC(AssumptionsWrapping, "Number of wrapping assumptions taken.");
114STATISTIC(AssumptionsUnsigned, "Number of unsigned assumptions taken.");
115STATISTIC(AssumptionsComplexity, "Number of too complex SCoPs.");
116STATISTIC(AssumptionsUnprofitable, "Number of unprofitable SCoPs.");
117STATISTIC(AssumptionsErrorBlock, "Number of error block assumptions taken.");
118STATISTIC(AssumptionsInfiniteLoop, "Number of bounded loop assumptions taken.");
119STATISTIC(AssumptionsInvariantLoad,
Johannes Doerfertcd195322016-11-17 21:41:08 +0000120 "Number of invariant loads assumptions taken.");
Johannes Doerfert81aa6e82016-11-18 14:37:08 +0000121STATISTIC(AssumptionsDelinearization,
Johannes Doerfertcd195322016-11-17 21:41:08 +0000122 "Number of delinearization assumptions taken.");
123
Michael Kruse06ed5292017-08-23 13:50:30 +0000124STATISTIC(NumScops, "Number of feasible SCoPs after ScopInfo");
Tobias Grossercd01a362017-02-17 08:12:36 +0000125STATISTIC(NumLoopsInScop, "Number of loops in scops");
Michael Kruse06ed5292017-08-23 13:50:30 +0000126STATISTIC(NumBoxedLoops, "Number of boxed loops in SCoPs after ScopInfo");
127STATISTIC(NumAffineLoops, "Number of affine loops in SCoPs after ScopInfo");
128
Tobias Grossercd01a362017-02-17 08:12:36 +0000129STATISTIC(NumScopsDepthOne, "Number of scops with maximal loop depth 1");
130STATISTIC(NumScopsDepthTwo, "Number of scops with maximal loop depth 2");
131STATISTIC(NumScopsDepthThree, "Number of scops with maximal loop depth 3");
132STATISTIC(NumScopsDepthFour, "Number of scops with maximal loop depth 4");
133STATISTIC(NumScopsDepthFive, "Number of scops with maximal loop depth 5");
134STATISTIC(NumScopsDepthLarger,
135 "Number of scops with maximal loop depth 6 and larger");
136STATISTIC(MaxNumLoopsInScop, "Maximal number of loops in scops");
137
Michael Kruse06ed5292017-08-23 13:50:30 +0000138STATISTIC(NumValueWrites, "Number of scalar value writes after ScopInfo");
139STATISTIC(
140 NumValueWritesInLoops,
141 "Number of scalar value writes nested in affine loops after ScopInfo");
142STATISTIC(NumPHIWrites, "Number of scalar phi writes after ScopInfo");
143STATISTIC(NumPHIWritesInLoops,
144 "Number of scalar phi writes nested in affine loops after ScopInfo");
145STATISTIC(NumSingletonWrites, "Number of singleton writes after ScopInfo");
146STATISTIC(NumSingletonWritesInLoops,
147 "Number of singleton writes nested in affine loops after ScopInfo");
148
Tobias Grosser75dc40c2015-12-20 13:31:48 +0000149// The maximal number of basic sets we allow during domain construction to
150// be created. More complex scops will result in very high compile time and
151// are also unlikely to result in good code
Tobias Grosser90411a92017-02-16 19:11:33 +0000152static int const MaxDisjunctsInDomain = 20;
Tobias Grosser75dc40c2015-12-20 13:31:48 +0000153
Tobias Grosserc8a82762017-02-16 19:11:25 +0000154// The number of disjunct in the context after which we stop to add more
155// disjuncts. This parameter is there to avoid exponential growth in the
156// number of disjunct when adding non-convex sets to the context.
157static int const MaxDisjunctsInContext = 4;
158
Tobias Grosser1eeedf42017-07-20 19:55:19 +0000159// The maximal number of dimensions we allow during invariant load construction.
160// More complex access ranges will result in very high compile time and are also
161// unlikely to result in good code. This value is very high and should only
162// trigger for corner cases (e.g., the "dct_luma" function in h264, SPEC2006).
163static int const MaxDimensionsInAccessRange = 9;
164
Tobias Grosser97715842017-05-19 04:01:52 +0000165static cl::opt<int>
166 OptComputeOut("polly-analysis-computeout",
167 cl::desc("Bound the scop analysis by a maximal amount of "
168 "computational steps (0 means no bound)"),
Tobias Grosser57a1d362017-06-23 08:05:27 +0000169 cl::Hidden, cl::init(800000), cl::ZeroOrMore,
Tobias Grosser97715842017-05-19 04:01:52 +0000170 cl::cat(PollyCategory));
Tobias Grosser45e9fd12017-05-19 03:45:00 +0000171
Johannes Doerfert2f705842016-04-12 16:09:44 +0000172static cl::opt<bool> PollyRemarksMinimal(
173 "polly-remarks-minimal",
174 cl::desc("Do not emit remarks about assumptions that are known"),
175 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
176
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +0000177static cl::opt<int> RunTimeChecksMaxAccessDisjuncts(
178 "polly-rtc-max-array-disjuncts",
179 cl::desc("The maximal number of disjunts allowed in memory accesses to "
180 "to build RTCs."),
181 cl::Hidden, cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
182
Johannes Doerfert9143d672014-09-27 11:02:39 +0000183static cl::opt<unsigned> RunTimeChecksMaxParameters(
184 "polly-rtc-max-parameters",
185 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
186 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
187
Tobias Grosser71500722015-03-28 15:11:14 +0000188static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
189 "polly-rtc-max-arrays-per-group",
190 cl::desc("The maximal number of arrays to compare in each alias group."),
191 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Johannes Doerfert5210da52016-06-02 11:06:54 +0000192
Tobias Grosser8a9c2352015-08-16 10:19:29 +0000193static cl::opt<std::string> UserContextStr(
194 "polly-context", cl::value_desc("isl parameter set"),
195 cl::desc("Provide additional constraints on the context parameters"),
196 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +0000197
Tobias Grosser2937b592016-04-29 11:43:20 +0000198static cl::opt<bool>
199 IslOnErrorAbort("polly-on-isl-error-abort",
200 cl::desc("Abort if an isl error is encountered"),
201 cl::init(true), cl::cat(PollyCategory));
202
Tobias Grosserd7c49752017-02-28 09:45:54 +0000203static cl::opt<bool> PollyPreciseInbounds(
204 "polly-precise-inbounds",
205 cl::desc("Take more precise inbounds assumptions (do not scale well)"),
206 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
207
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000208static cl::opt<bool>
209 PollyIgnoreInbounds("polly-ignore-inbounds",
210 cl::desc("Do not take inbounds assumptions at all"),
211 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
212
Tobias Grosser5842dee2017-03-17 13:00:53 +0000213static cl::opt<bool> PollyIgnoreParamBounds(
214 "polly-ignore-parameter-bounds",
215 cl::desc(
216 "Do not add parameter bounds and do no gist simplify sets accordingly"),
217 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
218
Siddharth Bhat7bc77e82017-08-21 11:57:04 +0000219static cl::opt<bool> PollyAllowDereferenceOfAllFunctionParams(
220 "polly-allow-dereference-of-all-function-parameters",
221 cl::desc(
222 "Treat all parameters to functions that are pointers as dereferencible."
223 " This is useful for invariant load hoisting, since we can generate"
224 " less runtime checks. This is only valid if all pointers to functions"
225 " are always initialized, so that Polly can choose to hoist"
226 " their loads. "),
227 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
228
Tobias Grosserc2f15102017-03-01 21:11:27 +0000229static cl::opt<bool> PollyPreciseFoldAccesses(
230 "polly-precise-fold-accesses",
Michael Kruse6e7854a2017-04-03 12:03:38 +0000231 cl::desc("Fold memory accesses to model more possible delinearizations "
232 "(does not scale well)"),
Tobias Grosserc2f15102017-03-01 21:11:27 +0000233 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000234
Michael Kruse5ae08c02017-05-06 14:03:58 +0000235bool polly::UseInstructionNames;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000236
Michael Kruse5ae08c02017-05-06 14:03:58 +0000237static cl::opt<bool, true> XUseInstructionNames(
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000238 "polly-use-llvm-names",
Michael Kruse5ae08c02017-05-06 14:03:58 +0000239 cl::desc("Use LLVM-IR names when deriving statement names"),
240 cl::location(UseInstructionNames), cl::Hidden, cl::init(false),
241 cl::ZeroOrMore, cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000242
Tobias Grosserd5fcbef2017-05-27 04:40:18 +0000243static cl::opt<bool> PollyPrintInstructions(
244 "polly-print-instructions", cl::desc("Output instructions per ScopStmt"),
245 cl::Hidden, cl::Optional, cl::init(false), cl::cat(PollyCategory));
246
Michael Kruse7bf39442015-09-10 12:46:52 +0000247//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000248
Michael Kruse046dde42015-08-10 13:01:57 +0000249// Create a sequence of two schedules. Either argument may be null and is
250// interpreted as the empty schedule. Can also return null if both schedules are
251// empty.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000252static isl::schedule combineInSequence(isl::schedule Prev, isl::schedule Succ) {
Michael Kruse046dde42015-08-10 13:01:57 +0000253 if (!Prev)
254 return Succ;
255 if (!Succ)
256 return Prev;
257
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000258 return Prev.sequence(Succ);
Michael Kruse046dde42015-08-10 13:01:57 +0000259}
260
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000261static isl::set addRangeBoundsToSet(isl::set S, const ConstantRange &Range,
262 int dim, isl::dim type) {
263 isl::val V;
264 isl::ctx Ctx = S.get_ctx();
Johannes Doerferte7044942015-02-24 11:58:30 +0000265
Tobias Grosser3281f602017-02-16 18:39:14 +0000266 // The upper and lower bound for a parameter value is derived either from
267 // the data type of the parameter or from the - possibly more restrictive -
268 // range metadata.
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000269 V = valFromAPInt(Ctx.get(), Range.getSignedMin(), true);
270 S = S.lower_bound_val(type, dim, V);
271 V = valFromAPInt(Ctx.get(), Range.getSignedMax(), true);
272 S = S.upper_bound_val(type, dim, V);
Johannes Doerferte7044942015-02-24 11:58:30 +0000273
Tobias Grosser3281f602017-02-16 18:39:14 +0000274 if (Range.isFullSet())
275 return S;
276
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000277 if (isl_set_n_basic_set(S.get()) > MaxDisjunctsInContext)
Tobias Grosserc8a82762017-02-16 19:11:25 +0000278 return S;
279
Tobias Grosser3281f602017-02-16 18:39:14 +0000280 // In case of signed wrapping, we can refine the set of valid values by
281 // excluding the part not covered by the wrapping range.
282 if (Range.isSignWrappedSet()) {
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000283 V = valFromAPInt(Ctx.get(), Range.getLower(), true);
284 isl::set SLB = S.lower_bound_val(type, dim, V);
Tobias Grosser3281f602017-02-16 18:39:14 +0000285
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000286 V = valFromAPInt(Ctx.get(), Range.getUpper(), true);
287 V = V.sub_ui(1);
288 isl::set SUB = S.upper_bound_val(type, dim, V);
289 S = SLB.unite(SUB);
Tobias Grosser3281f602017-02-16 18:39:14 +0000290 }
Johannes Doerferte7044942015-02-24 11:58:30 +0000291
Tobias Grosser3281f602017-02-16 18:39:14 +0000292 return S;
Johannes Doerferte7044942015-02-24 11:58:30 +0000293}
294
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000295static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
296 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
297 if (!BasePtrLI)
298 return nullptr;
299
Johannes Doerfert952b5302016-05-23 12:40:48 +0000300 if (!S->contains(BasePtrLI))
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000301 return nullptr;
302
303 ScalarEvolution &SE = *S->getSE();
304
305 auto *OriginBaseSCEV =
306 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
307 if (!OriginBaseSCEV)
308 return nullptr;
309
310 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
311 if (!OriginBaseSCEVUnknown)
312 return nullptr;
313
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000314 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000315 MemoryKind::Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000316}
317
Tobias Grosser27db02b2017-08-06 17:25:05 +0000318ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl::ctx Ctx,
Hongbin Zheng6aded2a2017-01-15 16:47:26 +0000319 ArrayRef<const SCEV *> Sizes, MemoryKind Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +0000320 const DataLayout &DL, Scop *S,
321 const char *BaseName)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000322 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000323 std::string BasePtrName =
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000324 BaseName ? BaseName
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000325 : getIslCompatibleName("MemRef", BasePtr, S->getNextArrayIdx(),
326 Kind == MemoryKind::PHI ? "__phi" : "",
327 UseInstructionNames);
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000328 Id = isl::id::alloc(Ctx, BasePtrName, this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000329
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000330 updateSizes(Sizes);
Roman Gareevd7754a12016-07-30 09:25:51 +0000331
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000332 if (!BasePtr || Kind != MemoryKind::Array) {
Roman Gareevd7754a12016-07-30 09:25:51 +0000333 BasePtrOriginSAI = nullptr;
334 return;
335 }
336
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000337 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
338 if (BasePtrOriginSAI)
339 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000340}
341
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000342ScopArrayInfo::~ScopArrayInfo() = default;
343
Tobias Grosser77eef902017-07-21 23:07:56 +0000344isl::space ScopArrayInfo::getSpace() const {
345 auto Space = isl::space(Id.get_ctx(), 0, getNumberOfDimensions());
346 Space = Space.set_tuple_id(isl::dim::set, Id);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000347 return Space;
348}
349
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000350bool ScopArrayInfo::isReadOnly() {
Tobias Grosser5ab39ff2017-08-06 19:22:27 +0000351 isl::union_set WriteSet = S.getWrites().range();
Tobias Grosser77eef902017-07-21 23:07:56 +0000352 isl::space Space = getSpace();
Tobias Grosser2ade9862017-05-23 06:41:04 +0000353 WriteSet = WriteSet.extract_set(Space);
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000354
Tobias Grosser2ade9862017-05-23 06:41:04 +0000355 return bool(WriteSet.is_empty());
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000356}
357
Tobias Grosserf3adab42017-05-10 10:59:58 +0000358bool ScopArrayInfo::isCompatibleWith(const ScopArrayInfo *Array) const {
359 if (Array->getElementType() != getElementType())
360 return false;
361
362 if (Array->getNumberOfDimensions() != getNumberOfDimensions())
363 return false;
364
365 for (unsigned i = 0; i < getNumberOfDimensions(); i++)
366 if (Array->getDimensionSize(i) != getDimensionSize(i))
367 return false;
368
369 return true;
370}
371
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000372void ScopArrayInfo::updateElementType(Type *NewElementType) {
373 if (NewElementType == ElementType)
374 return;
375
Tobias Grosserd840fc72016-02-04 13:18:42 +0000376 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
377 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
378
Johannes Doerferta7920982016-02-25 14:08:48 +0000379 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000380 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000381
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000382 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
383 ElementType = NewElementType;
384 } else {
385 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
386 ElementType = IntegerType::get(ElementType->getContext(), GCD);
387 }
388}
389
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000390/// Make the ScopArrayInfo model a Fortran Array
391void ScopArrayInfo::applyAndSetFAD(Value *FAD) {
392 assert(FAD && "got invalid Fortran array descriptor");
393 if (this->FAD) {
394 assert(this->FAD == FAD &&
395 "receiving different array descriptors for same array");
396 return;
397 }
398
399 assert(DimensionSizesPw.size() > 0 && !DimensionSizesPw[0]);
400 assert(!this->FAD);
401 this->FAD = FAD;
402
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000403 isl::space Space(S.getIslCtx(), 1, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000404
405 std::string param_name = getName();
406 param_name += "_fortranarr_size";
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +0000407 isl::id IdPwAff = isl::id::alloc(S.getIslCtx(), param_name, this);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000408
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000409 Space = Space.set_dim_id(isl::dim::param, 0, IdPwAff);
410 isl::pw_aff PwAff =
411 isl::aff::var_on_domain(isl::local_space(Space), isl::dim::param, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000412
Tobias Grosser77eef902017-07-21 23:07:56 +0000413 DimensionSizesPw[0] = PwAff;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000414}
415
Tobias Grosserbedef002016-12-02 08:10:56 +0000416bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes,
417 bool CheckConsistency) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000418 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
419 int ExtraDimsNew = NewSizes.size() - SharedDims;
420 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Roman Gareevf5aff702016-09-12 17:08:31 +0000421
Tobias Grosserbedef002016-12-02 08:10:56 +0000422 if (CheckConsistency) {
423 for (int i = 0; i < SharedDims; i++) {
424 auto *NewSize = NewSizes[i + ExtraDimsNew];
425 auto *KnownSize = DimensionSizes[i + ExtraDimsOld];
426 if (NewSize && KnownSize && NewSize != KnownSize)
427 return false;
428 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000429
Tobias Grosserbedef002016-12-02 08:10:56 +0000430 if (DimensionSizes.size() >= NewSizes.size())
431 return true;
432 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000433
434 DimensionSizes.clear();
435 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
436 NewSizes.end());
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000437 DimensionSizesPw.clear();
438 for (const SCEV *Expr : DimensionSizes) {
Roman Gareevf5aff702016-09-12 17:08:31 +0000439 if (!Expr) {
440 DimensionSizesPw.push_back(nullptr);
441 continue;
442 }
Tobias Grosser61bd3a42017-08-06 21:42:38 +0000443 isl::pw_aff Size = S.getPwAffOnly(Expr);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000444 DimensionSizesPw.push_back(Size);
445 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000446 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000447}
448
Tobias Grosser77eef902017-07-21 23:07:56 +0000449std::string ScopArrayInfo::getName() const { return Id.get_name(); }
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000450
451int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000452 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000453}
454
Tobias Grosser77eef902017-07-21 23:07:56 +0000455isl::id ScopArrayInfo::getBasePtrId() const { return Id; }
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000456
Michael Kruse5d518462017-07-21 15:54:07 +0000457#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +0000458LLVM_DUMP_METHOD void ScopArrayInfo::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +0000459#endif
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000460
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000461void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000462 OS.indent(8) << *getElementType() << " " << getName();
Roman Gareevf5aff702016-09-12 17:08:31 +0000463 unsigned u = 0;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000464 // If this is a Fortran array, then we can print the outermost dimension
465 // as a isl_pw_aff even though there is no SCEV information.
466 bool IsOutermostSizeKnown = SizeAsPwAff && FAD;
467
468 if (!IsOutermostSizeKnown && getNumberOfDimensions() > 0 &&
469 !getDimensionSize(0)) {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000470 OS << "[*]";
Roman Gareevf5aff702016-09-12 17:08:31 +0000471 u++;
472 }
473 for (; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000474 OS << "[";
475
Tobias Grosser26253842015-11-10 14:24:21 +0000476 if (SizeAsPwAff) {
Tobias Grosser77eef902017-07-21 23:07:56 +0000477 isl::pw_aff Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000478 OS << " " << Size << " ";
Tobias Grosser26253842015-11-10 14:24:21 +0000479 } else {
480 OS << *getDimensionSize(u);
481 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000482
483 OS << "]";
484 }
485
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000486 OS << ";";
487
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000488 if (BasePtrOriginSAI)
489 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
490
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000491 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000492}
493
494const ScopArrayInfo *
Tobias Grosser206e9e32017-07-24 16:22:27 +0000495ScopArrayInfo::getFromAccessFunction(isl::pw_multi_aff PMA) {
496 isl::id Id = PMA.get_tuple_id(isl::dim::out);
497 assert(!Id.is_null() && "Output dimension didn't have an ID");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000498 return getFromId(Id);
499}
500
Tobias Grosser206e9e32017-07-24 16:22:27 +0000501const ScopArrayInfo *ScopArrayInfo::getFromId(isl::id Id) {
502 void *User = Id.get_user();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000503 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000504 return SAI;
505}
506
Michael Kruse3b425ff2016-04-11 14:34:08 +0000507void MemoryAccess::wrapConstantDimensions() {
508 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000509 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000510 isl::ctx Ctx = ArraySpace.get_ctx();
Michael Kruse3b425ff2016-04-11 14:34:08 +0000511 unsigned DimsArray = SAI->getNumberOfDimensions();
512
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000513 isl::multi_aff DivModAff = isl::multi_aff::identity(
514 ArraySpace.map_from_domain_and_range(ArraySpace));
515 isl::local_space LArraySpace = isl::local_space(ArraySpace);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000516
517 // Begin with last dimension, to iteratively carry into higher dimensions.
518 for (int i = DimsArray - 1; i > 0; i--) {
519 auto *DimSize = SAI->getDimensionSize(i);
520 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
521
522 // This transformation is not applicable to dimensions with dynamic size.
523 if (!DimSizeCst)
524 continue;
525
Tobias Grosserca2cfd02017-02-17 04:48:52 +0000526 // This transformation is not applicable to dimensions of size zero.
527 if (DimSize->isZero())
528 continue;
529
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000530 isl::val DimSizeVal =
531 valFromAPInt(Ctx.get(), DimSizeCst->getAPInt(), false);
532 isl::aff Var = isl::aff::var_on_domain(LArraySpace, isl::dim::set, i);
533 isl::aff PrevVar =
534 isl::aff::var_on_domain(LArraySpace, isl::dim::set, i - 1);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000535
536 // Compute: index % size
537 // Modulo must apply in the divide of the previous iteration, if any.
Tobias Grossercb0224a2017-08-06 15:56:45 +0000538 isl::aff Modulo = Var.mod(DimSizeVal);
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000539 Modulo = Modulo.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000540
541 // Compute: floor(index / size)
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000542 isl::aff Divide = Var.div(isl::aff(LArraySpace, DimSizeVal));
543 Divide = Divide.floor();
544 Divide = Divide.add(PrevVar);
545 Divide = Divide.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000546
547 // Apply Modulo and Divide.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000548 DivModAff = DivModAff.set_aff(i, Modulo);
549 DivModAff = DivModAff.set_aff(i - 1, Divide);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000550 }
551
552 // Apply all modulo/divides on the accesses.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000553 isl::map Relation = AccessRelation;
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000554 Relation = Relation.apply_range(isl::map::from_multi_aff(DivModAff));
555 Relation = Relation.detect_equalities();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000556 AccessRelation = Relation;
Michael Kruse3b425ff2016-04-11 14:34:08 +0000557}
558
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000559void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000560 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000561 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000562 isl::space AccessSpace = AccessRelation.get_space().range();
Tobias Grosser7be82452017-05-21 20:38:33 +0000563 isl::ctx Ctx = ArraySpace.get_ctx();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000564
Tobias Grosser7be82452017-05-21 20:38:33 +0000565 auto DimsArray = ArraySpace.dim(isl::dim::set);
566 auto DimsAccess = AccessSpace.dim(isl::dim::set);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000567 auto DimsMissing = DimsArray - DimsAccess;
568
Michael Kruse375cb5f2016-02-24 22:08:24 +0000569 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000570 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000571 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000572 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000573
Tobias Grosser7be82452017-05-21 20:38:33 +0000574 isl::map Map = isl::map::from_domain_and_range(
575 isl::set::universe(AccessSpace), isl::set::universe(ArraySpace));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000576
577 for (unsigned i = 0; i < DimsMissing; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000578 Map = Map.fix_si(isl::dim::out, i, 0);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000579
580 for (unsigned i = DimsMissing; i < DimsArray; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000581 Map = Map.equate(isl::dim::in, i - DimsMissing, isl::dim::out, i);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000582
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000583 AccessRelation = AccessRelation.apply_range(Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000584
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000585 // For the non delinearized arrays, divide the access function of the last
586 // subscript by the size of the elements in the array.
587 //
588 // A stride one array access in C expressed as A[i] is expressed in
589 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
590 // two subsequent values of 'i' index two values that are stored next to
591 // each other in memory. By this division we make this characteristic
592 // obvious again. If the base pointer was accessed with offsets not divisible
Tobias Grosser2219d152016-08-03 05:28:09 +0000593 // by the accesses element size, we will have chosen a smaller ArrayElemSize
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000594 // that divides the offsets of all accesses to this base pointer.
595 if (DimsAccess == 1) {
Tobias Grosser7be82452017-05-21 20:38:33 +0000596 isl::val V = isl::val(Ctx, ArrayElemSize);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000597 AccessRelation = AccessRelation.floordiv_val(V);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000598 }
599
Michael Kruse3b425ff2016-04-11 14:34:08 +0000600 // We currently do this only if we added at least one dimension, which means
601 // some dimension's indices have not been specified, an indicator that some
602 // index values have been added together.
603 // TODO: Investigate general usefulness; Effect on unit tests is to make index
604 // expressions more complicated.
605 if (DimsMissing)
606 wrapConstantDimensions();
607
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000608 if (!isAffine())
609 computeBoundsOnAccessRelation(ArrayElemSize);
610
Tobias Grosserd840fc72016-02-04 13:18:42 +0000611 // Introduce multi-element accesses in case the type loaded by this memory
612 // access is larger than the canonical element type of the array.
613 //
614 // An access ((float *)A)[i] to an array char *A is modeled as
615 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000616 if (ElemBytes > ArrayElemSize) {
617 assert(ElemBytes % ArrayElemSize == 0 &&
618 "Loaded element size should be multiple of canonical element size");
Tobias Grosser7be82452017-05-21 20:38:33 +0000619 isl::map Map = isl::map::from_domain_and_range(
620 isl::set::universe(ArraySpace), isl::set::universe(ArraySpace));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000621 for (unsigned i = 0; i < DimsArray - 1; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000622 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000623
Tobias Grosser7be82452017-05-21 20:38:33 +0000624 isl::constraint C;
625 isl::local_space LS;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000626
Tobias Grosser7be82452017-05-21 20:38:33 +0000627 LS = isl::local_space(Map.get_space());
Tobias Grosserd840fc72016-02-04 13:18:42 +0000628 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
629
Tobias Grosser7be82452017-05-21 20:38:33 +0000630 C = isl::constraint::alloc_inequality(LS);
631 C = C.set_constant_val(isl::val(Ctx, Num - 1));
632 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, 1);
633 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, -1);
634 Map = Map.add_constraint(C);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000635
Tobias Grosser7be82452017-05-21 20:38:33 +0000636 C = isl::constraint::alloc_inequality(LS);
637 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, -1);
638 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, 1);
639 C = C.set_constant_val(isl::val(Ctx, 0));
640 Map = Map.add_constraint(C);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000641 AccessRelation = AccessRelation.apply_range(Map);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000642 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000643}
644
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000645const std::string
646MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
647 switch (RT) {
648 case MemoryAccess::RT_NONE:
649 llvm_unreachable("Requested a reduction operator string for a memory "
650 "access which isn't a reduction");
651 case MemoryAccess::RT_ADD:
652 return "+";
653 case MemoryAccess::RT_MUL:
654 return "*";
655 case MemoryAccess::RT_BOR:
656 return "|";
657 case MemoryAccess::RT_BXOR:
658 return "^";
659 case MemoryAccess::RT_BAND:
660 return "&";
661 }
662 llvm_unreachable("Unknown reduction type");
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000663}
664
Michael Kruse2fa35192016-09-01 19:53:31 +0000665const ScopArrayInfo *MemoryAccess::getOriginalScopArrayInfo() const {
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000666 isl::id ArrayId = getArrayId();
667 void *User = ArrayId.get_user();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000668 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000669 return SAI;
670}
671
Michael Kruse2fa35192016-09-01 19:53:31 +0000672const ScopArrayInfo *MemoryAccess::getLatestScopArrayInfo() const {
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000673 isl::id ArrayId = getLatestArrayId();
674 void *User = ArrayId.get_user();
Michael Kruse2fa35192016-09-01 19:53:31 +0000675 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
Michael Kruse2fa35192016-09-01 19:53:31 +0000676 return SAI;
677}
678
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000679isl::id MemoryAccess::getOriginalArrayId() const {
680 return AccessRelation.get_tuple_id(isl::dim::out);
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000681}
682
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000683isl::id MemoryAccess::getLatestArrayId() const {
Michael Kruse2fa35192016-09-01 19:53:31 +0000684 if (!hasNewAccessRelation())
685 return getOriginalArrayId();
Tobias Grosser1959dbd2017-07-23 04:08:59 +0000686 return NewAccessRelation.get_tuple_id(isl::dim::out);
Michael Kruse2fa35192016-09-01 19:53:31 +0000687}
688
Tobias Grosser6a870362017-07-23 04:08:45 +0000689isl::map MemoryAccess::getAddressFunction() const {
690 return getAccessRelation().lexmin();
Tobias Grosserd840fc72016-02-04 13:18:42 +0000691}
692
Tobias Grosser3b196132017-07-23 04:08:52 +0000693isl::pw_multi_aff
694MemoryAccess::applyScheduleToAccessRelation(isl::union_map USchedule) const {
695 isl::map Schedule, ScheduledAccRel;
696 isl::union_set UDomain;
Johannes Doerferta99130f2014-10-13 12:58:03 +0000697
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000698 UDomain = getStatement()->getDomain();
Tobias Grosser3b196132017-07-23 04:08:52 +0000699 USchedule = USchedule.intersect_domain(UDomain);
700 Schedule = isl::map::from_union_map(USchedule);
701 ScheduledAccRel = getAddressFunction().apply_domain(Schedule);
702 return isl::pw_multi_aff::from_map(ScheduledAccRel);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000703}
704
Tobias Grosser22da5f02017-07-23 04:08:27 +0000705isl::map MemoryAccess::getOriginalAccessRelation() const {
706 return AccessRelation;
Tobias Grosser5d453812011-10-06 00:04:11 +0000707}
708
Johannes Doerferta99130f2014-10-13 12:58:03 +0000709std::string MemoryAccess::getOriginalAccessRelationStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000710 return AccessRelation.to_str();
Tobias Grosser5d453812011-10-06 00:04:11 +0000711}
712
Tobias Grosser22da5f02017-07-23 04:08:27 +0000713isl::space MemoryAccess::getOriginalAccessRelationSpace() const {
714 return AccessRelation.get_space();
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000715}
716
Tobias Grosser1515f6b2017-07-23 04:08:38 +0000717isl::map MemoryAccess::getNewAccessRelation() const {
718 return NewAccessRelation;
Tobias Grosser75805372011-04-29 06:27:02 +0000719}
720
Tobias Grosser6f730082015-09-05 07:46:47 +0000721std::string MemoryAccess::getNewAccessRelationStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000722 return NewAccessRelation.to_str();
Tobias Grosser6f730082015-09-05 07:46:47 +0000723}
724
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000725std::string MemoryAccess::getAccessRelationStr() const {
Tobias Grosser2b7479b2017-08-06 11:41:10 +0000726 return getAccessRelation().to_str();
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000727}
728
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000729isl::basic_map MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
730 isl::space Space = isl::space(Statement->getIslCtx(), 0, 1);
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000731 Space = Space.align_params(Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000732
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000733 return isl::basic_map::from_domain_and_range(
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000734 isl::basic_set::universe(Statement->getDomainSpace()),
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000735 isl::basic_set::universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000736}
737
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000738// Formalize no out-of-bound access assumption
739//
740// When delinearizing array accesses we optimistically assume that the
741// delinearized accesses do not access out of bound locations (the subscript
742// expression of each array evaluates for each statement instance that is
743// executed to a value that is larger than zero and strictly smaller than the
744// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000745// dimension for which we do not need to assume any upper bound. At this point
746// we formalize this assumption to ensure that at code generation time the
747// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000748//
749// To find the set of constraints necessary to avoid out of bound accesses, we
750// first build the set of data locations that are not within array bounds. We
751// then apply the reverse access relation to obtain the set of iterations that
752// may contain invalid accesses and reduce this set of iterations to the ones
753// that are actually executed by intersecting them with the domain of the
754// statement. If we now project out all loop dimensions, we obtain a set of
755// parameters that may cause statement instances to be executed that may
756// possibly yield out of bound memory accesses. The complement of these
757// constraints is the set of constraints that needs to be assumed to ensure such
758// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000759void MemoryAccess::assumeNoOutOfBound() {
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000760 if (PollyIgnoreInbounds)
761 return;
Johannes Doerfertadeab372016-02-07 13:57:32 +0000762 auto *SAI = getScopArrayInfo();
Tobias Grosser22da5f02017-07-23 04:08:27 +0000763 isl::space Space = getOriginalAccessRelationSpace().range();
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000764 isl::set Outside = isl::set::empty(Space);
765 for (int i = 1, Size = Space.dim(isl::dim::set); i < Size; ++i) {
766 isl::local_space LS(Space);
767 isl::pw_aff Var = isl::pw_aff::var_on_domain(LS, isl::dim::set, i);
768 isl::pw_aff Zero = isl::pw_aff(LS);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000769
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000770 isl::set DimOutside = Var.lt_set(Zero);
Tobias Grosser77eef902017-07-21 23:07:56 +0000771 isl::pw_aff SizeE = SAI->getDimensionSizePw(i);
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000772 SizeE = SizeE.add_dims(isl::dim::in, Space.dim(isl::dim::set));
773 SizeE = SizeE.set_tuple_id(isl::dim::in, Space.get_tuple_id(isl::dim::set));
774 DimOutside = DimOutside.unite(SizeE.le_set(Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000775
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000776 Outside = Outside.unite(DimOutside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000777 }
778
Tobias Grosser1515f6b2017-07-23 04:08:38 +0000779 Outside = Outside.apply(getAccessRelation().reverse());
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000780 Outside = Outside.intersect(Statement->getDomain());
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000781 Outside = Outside.params();
Tobias Grosserf54bb772015-06-26 12:09:28 +0000782
783 // Remove divs to avoid the construction of overly complicated assumptions.
784 // Doing so increases the set of parameter combinations that are assumed to
785 // not appear. This is always save, but may make the resulting run-time check
786 // bail out more often than strictly necessary.
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000787 Outside = Outside.remove_divs();
788 Outside = Outside.complement();
Michael Kruse7071e8b2016-04-11 13:24:29 +0000789 const auto &Loc = getAccessInstruction()
790 ? getAccessInstruction()->getDebugLoc()
791 : DebugLoc();
Tobias Grosserd7c49752017-02-28 09:45:54 +0000792 if (!PollyPreciseInbounds)
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000793 Outside = Outside.gist_params(Statement->getDomain().params());
Philip Pfaffe00fd43b2017-11-19 22:13:34 +0000794 Statement->getParent()->recordAssumption(INBOUNDS, Outside, Loc,
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000795 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000796}
797
Johannes Doerfertcea61932016-02-21 19:13:19 +0000798void MemoryAccess::buildMemIntrinsicAccessRelation() {
Johannes Doerfertc9765462016-11-17 22:11:56 +0000799 assert(isMemoryIntrinsic());
Roman Gareevf5aff702016-09-12 17:08:31 +0000800 assert(Subscripts.size() == 2 && Sizes.size() == 1);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000801
Tobias Grossercdf471b2017-07-24 16:36:34 +0000802 isl::pw_aff SubscriptPWA = getPwAff(Subscripts[0]);
Tobias Grosser53fc3552017-05-23 07:07:09 +0000803 isl::map SubscriptMap = isl::map::from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000804
Tobias Grosser53fc3552017-05-23 07:07:09 +0000805 isl::map LengthMap;
Johannes Doerferta7920982016-02-25 14:08:48 +0000806 if (Subscripts[1] == nullptr) {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000807 LengthMap = isl::map::universe(SubscriptMap.get_space());
Johannes Doerferta7920982016-02-25 14:08:48 +0000808 } else {
Tobias Grossercdf471b2017-07-24 16:36:34 +0000809 isl::pw_aff LengthPWA = getPwAff(Subscripts[1]);
Tobias Grosser53fc3552017-05-23 07:07:09 +0000810 LengthMap = isl::map::from_pw_aff(LengthPWA);
811 isl::space RangeSpace = LengthMap.get_space().range();
812 LengthMap = LengthMap.apply_range(isl::map::lex_gt(RangeSpace));
Johannes Doerferta7920982016-02-25 14:08:48 +0000813 }
Tobias Grosser53fc3552017-05-23 07:07:09 +0000814 LengthMap = LengthMap.lower_bound_si(isl::dim::out, 0, 0);
815 LengthMap = LengthMap.align_params(SubscriptMap.get_space());
816 SubscriptMap = SubscriptMap.align_params(LengthMap.get_space());
817 LengthMap = LengthMap.sum(SubscriptMap);
818 AccessRelation =
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000819 LengthMap.set_tuple_id(isl::dim::in, getStatement()->getDomainId());
Johannes Doerfertcea61932016-02-21 19:13:19 +0000820}
821
Johannes Doerferte7044942015-02-24 11:58:30 +0000822void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
823 ScalarEvolution *SE = Statement->getParent()->getSE();
824
Johannes Doerfertcea61932016-02-21 19:13:19 +0000825 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000826 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000827 return;
828
829 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000830 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
831 return;
832
833 auto *PtrSCEV = SE->getSCEV(Ptr);
834 if (isa<SCEVCouldNotCompute>(PtrSCEV))
835 return;
836
837 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
838 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
839 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
840
841 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
842 if (Range.isFullSet())
843 return;
844
Michael Kruse960c0d02017-05-18 21:55:36 +0000845 if (Range.isWrappedSet() || Range.isSignWrappedSet())
Tobias Grosserb3a85882017-02-12 08:11:12 +0000846 return;
847
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000848 bool isWrapping = Range.isSignWrappedSet();
Tobias Grosserb3a85882017-02-12 08:11:12 +0000849
Johannes Doerferte7044942015-02-24 11:58:30 +0000850 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000851 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000852 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000853 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000854
855 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000856 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000857
Tobias Grosserb3a85882017-02-12 08:11:12 +0000858 assert(Min.sle(Max) && "Minimum expected to be less or equal than max");
859
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000860 isl::map Relation = AccessRelation;
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000861 isl::set AccessRange = Relation.range();
862 AccessRange = addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0,
863 isl::dim::set);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000864 AccessRelation = Relation.intersect_range(AccessRange);
Johannes Doerferte7044942015-02-24 11:58:30 +0000865}
866
Tobias Grosser491b7992016-12-02 05:21:22 +0000867void MemoryAccess::foldAccessRelation() {
868 if (Sizes.size() < 2 || isa<SCEVConstant>(Sizes[1]))
869 return;
870
Michael Krusee2bccbb2015-09-18 19:59:43 +0000871 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000872
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000873 isl::map NewAccessRelation = AccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000874
Tobias Grosser619190d2015-03-30 17:22:28 +0000875 for (int i = Size - 2; i >= 0; --i) {
Tobias Grossera32de132017-05-23 07:22:56 +0000876 isl::space Space;
877 isl::map MapOne, MapTwo;
Tobias Grossercdf471b2017-07-24 16:36:34 +0000878 isl::pw_aff DimSize = getPwAff(Sizes[i + 1]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000879
Tobias Grossera32de132017-05-23 07:22:56 +0000880 isl::space SpaceSize = DimSize.get_space();
881 isl::id ParamId =
882 give(isl_space_get_dim_id(SpaceSize.get(), isl_dim_param, 0));
Tobias Grosser619190d2015-03-30 17:22:28 +0000883
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000884 Space = AccessRelation.get_space();
Tobias Grossera32de132017-05-23 07:22:56 +0000885 Space = Space.range().map_from_set();
886 Space = Space.align_params(SpaceSize);
Tobias Grosser619190d2015-03-30 17:22:28 +0000887
Tobias Grossera32de132017-05-23 07:22:56 +0000888 int ParamLocation = Space.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosser619190d2015-03-30 17:22:28 +0000889
Tobias Grossera32de132017-05-23 07:22:56 +0000890 MapOne = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000891 for (int j = 0; j < Size; ++j)
Tobias Grossera32de132017-05-23 07:22:56 +0000892 MapOne = MapOne.equate(isl::dim::in, j, isl::dim::out, j);
893 MapOne = MapOne.lower_bound_si(isl::dim::in, i + 1, 0);
Tobias Grosser619190d2015-03-30 17:22:28 +0000894
Tobias Grossera32de132017-05-23 07:22:56 +0000895 MapTwo = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000896 for (int j = 0; j < Size; ++j)
897 if (j < i || j > i + 1)
Tobias Grossera32de132017-05-23 07:22:56 +0000898 MapTwo = MapTwo.equate(isl::dim::in, j, isl::dim::out, j);
Tobias Grosser619190d2015-03-30 17:22:28 +0000899
Tobias Grossera32de132017-05-23 07:22:56 +0000900 isl::local_space LS(Space);
901 isl::constraint C;
902 C = isl::constraint::alloc_equality(LS);
903 C = C.set_constant_si(-1);
904 C = C.set_coefficient_si(isl::dim::in, i, 1);
905 C = C.set_coefficient_si(isl::dim::out, i, -1);
906 MapTwo = MapTwo.add_constraint(C);
907 C = isl::constraint::alloc_equality(LS);
908 C = C.set_coefficient_si(isl::dim::in, i + 1, 1);
909 C = C.set_coefficient_si(isl::dim::out, i + 1, -1);
910 C = C.set_coefficient_si(isl::dim::param, ParamLocation, 1);
911 MapTwo = MapTwo.add_constraint(C);
912 MapTwo = MapTwo.upper_bound_si(isl::dim::in, i + 1, -1);
Tobias Grosser619190d2015-03-30 17:22:28 +0000913
Tobias Grossera32de132017-05-23 07:22:56 +0000914 MapOne = MapOne.unite(MapTwo);
915 NewAccessRelation = NewAccessRelation.apply_range(MapOne);
Tobias Grosser619190d2015-03-30 17:22:28 +0000916 }
Tobias Grosser491b7992016-12-02 05:21:22 +0000917
Tobias Grosser77eef902017-07-21 23:07:56 +0000918 isl::id BaseAddrId = getScopArrayInfo()->getBasePtrId();
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000919 isl::space Space = Statement->getDomainSpace();
Tobias Grossera32de132017-05-23 07:22:56 +0000920 NewAccessRelation = NewAccessRelation.set_tuple_id(
921 isl::dim::in, Space.get_tuple_id(isl::dim::set));
922 NewAccessRelation = NewAccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Tobias Grosserdcf8d692017-08-06 16:39:52 +0000923 NewAccessRelation = NewAccessRelation.gist_domain(Statement->getDomain());
Tobias Grosserc2f15102017-03-01 21:11:27 +0000924
925 // Access dimension folding might in certain cases increase the number of
926 // disjuncts in the memory access, which can possibly complicate the generated
927 // run-time checks and can lead to costly compilation.
Tobias Grossera32de132017-05-23 07:22:56 +0000928 if (!PollyPreciseFoldAccesses &&
929 isl_map_n_basic_map(NewAccessRelation.get()) >
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000930 isl_map_n_basic_map(AccessRelation.get())) {
Tobias Grosserc2f15102017-03-01 21:11:27 +0000931 } else {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000932 AccessRelation = NewAccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000933 }
Tobias Grosser619190d2015-03-30 17:22:28 +0000934}
935
Tobias Grosserc80d6972016-09-02 06:33:33 +0000936/// Check if @p Expr is divisible by @p Size.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000937static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000938 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000939 if (Size == 1)
940 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000941
942 // Only one factor needs to be divisible.
943 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
944 for (auto *FactorExpr : MulExpr->operands())
945 if (isDivisible(FactorExpr, Size, SE))
946 return true;
947 return false;
948 }
949
950 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
Michael Krusea6d48f52017-06-08 12:06:15 +0000951 // to be divisible.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000952 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
953 for (auto *OpExpr : NAryExpr->operands())
954 if (!isDivisible(OpExpr, Size, SE))
955 return false;
956 return true;
957 }
958
959 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
960 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
961 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
962 return MulSCEV == Expr;
963}
964
Michael Krusee2bccbb2015-09-18 19:59:43 +0000965void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000966 assert(AccessRelation.is_null() && "AccessRelation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000967
Johannes Doerfert85676e32016-04-23 14:32:34 +0000968 // Initialize the invalid domain which describes all iterations for which the
969 // access relation is not modeled correctly.
Tobias Grosser2332fa32017-08-06 15:36:48 +0000970 isl::set StmtInvalidDomain = getStatement()->getInvalidDomain();
Tobias Grosserb739cb42017-07-24 20:30:34 +0000971 InvalidDomain = isl::set::empty(StmtInvalidDomain.get_space());
Johannes Doerfert85676e32016-04-23 14:32:34 +0000972
Tobias Grosserb739cb42017-07-24 20:30:34 +0000973 isl::ctx Ctx = Id.get_ctx();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000974 isl::id BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000975
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000976 if (getAccessInstruction() && isa<MemIntrinsic>(getAccessInstruction())) {
977 buildMemIntrinsicAccessRelation();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000978 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000979 return;
980 }
Johannes Doerfertcea61932016-02-21 19:13:19 +0000981
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000982 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000983 // We overapproximate non-affine accesses with a possible access to the
984 // whole array. For read accesses it does not make a difference, if an
985 // access must or may happen. However, for write accesses it is important to
986 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000987 if (AccessRelation.is_null())
988 AccessRelation = createBasicAccessMap(Statement);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000989
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000990 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000991 return;
992 }
993
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000994 isl::space Space = isl::space(Ctx, 0, Statement->getNumIterators(), 0);
995 AccessRelation = isl::map::universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000996
Michael Krusee2bccbb2015-09-18 19:59:43 +0000997 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Tobias Grossercdf471b2017-07-24 16:36:34 +0000998 isl::pw_aff Affine = getPwAff(Subscripts[i]);
999 isl::map SubscriptMap = isl::map::from_pw_aff(Affine);
1000 AccessRelation = AccessRelation.flat_range_product(SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +00001001 }
1002
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001003 Space = Statement->getDomainSpace();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +00001004 AccessRelation = AccessRelation.set_tuple_id(
1005 isl::dim::in, Space.get_tuple_id(isl::dim::set));
1006 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Johannes Doerfert5d83f092014-07-29 08:37:55 +00001007
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001008 AccessRelation = AccessRelation.gist_domain(Statement->getDomain());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001009}
Tobias Grosser30b8a092011-08-18 07:51:37 +00001010
Michael Krusecac948e2015-10-02 13:53:07 +00001011MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00001012 AccessType AccType, Value *BaseAddress,
1013 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +00001014 ArrayRef<const SCEV *> Subscripts,
1015 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grosser72684bb2017-05-03 08:02:32 +00001016 MemoryKind Kind)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001017 : Kind(Kind), AccType(AccType), Statement(Stmt), InvalidDomain(nullptr),
1018 BaseAddr(BaseAddress), ElementType(ElementType),
Tobias Grosser81331282017-05-03 07:57:35 +00001019 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
1020 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +00001021 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001022 NewAccessRelation(nullptr), FAD(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +00001023 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001024 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001025
Tobias Grosser81331282017-05-03 07:57:35 +00001026 std::string IdName = Stmt->getBaseName() + Access;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001027 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName, this);
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001028}
Michael Krusee2bccbb2015-09-18 19:59:43 +00001029
Tobias Grosser1f6ba7e2017-07-24 16:22:32 +00001030MemoryAccess::MemoryAccess(ScopStmt *Stmt, AccessType AccType, isl::map AccRel)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001031 : Kind(MemoryKind::Array), AccType(AccType), Statement(Stmt),
1032 InvalidDomain(nullptr), AccessRelation(nullptr),
1033 NewAccessRelation(AccRel), FAD(nullptr) {
Tobias Grosser206e9e32017-07-24 16:22:27 +00001034 isl::id ArrayInfoId = NewAccessRelation.get_tuple_id(isl::dim::out);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001035 auto *SAI = ScopArrayInfo::getFromId(ArrayInfoId);
1036 Sizes.push_back(nullptr);
1037 for (unsigned i = 1; i < SAI->getNumberOfDimensions(); i++)
1038 Sizes.push_back(SAI->getDimensionSize(i));
1039 ElementType = SAI->getElementType();
1040 BaseAddr = SAI->getBasePtr();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001041 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001042 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Roman Gareevb3224ad2016-09-14 06:26:09 +00001043
Tobias Grosser81331282017-05-03 07:57:35 +00001044 std::string IdName = Stmt->getBaseName() + Access;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001045 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName, this);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001046}
1047
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001048MemoryAccess::~MemoryAccess() = default;
1049
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001050void MemoryAccess::realignParams() {
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00001051 isl::set Ctx = Statement->getParent()->getContext();
Tobias Grosserb739cb42017-07-24 20:30:34 +00001052 InvalidDomain = InvalidDomain.gist_params(Ctx);
1053 AccessRelation = AccessRelation.gist_params(Ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00001054}
1055
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001056const std::string MemoryAccess::getReductionOperatorStr() const {
1057 return MemoryAccess::getReductionOperatorStr(getReductionType());
1058}
1059
Tobias Grosserfe46c3f2017-07-23 04:08:11 +00001060isl::id MemoryAccess::getId() const { return Id; }
Tobias Grosser6f48e0f2015-05-15 09:58:32 +00001061
Johannes Doerfertf6183392014-07-01 20:52:51 +00001062raw_ostream &polly::operator<<(raw_ostream &OS,
1063 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001064 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +00001065 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001066 else
1067 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +00001068 return OS;
1069}
1070
Siddharth Bhat0fe72312017-05-15 08:41:30 +00001071void MemoryAccess::setFortranArrayDescriptor(Value *FAD) { this->FAD = FAD; }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001072
Tobias Grosser75805372011-04-29 06:27:02 +00001073void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +00001074 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001075 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001076 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001077 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001078 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001079 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001080 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001081 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001082 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001083 break;
1084 }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001085
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +00001086 OS << "[Reduction Type: " << getReductionType() << "] ";
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001087
1088 if (FAD) {
1089 OS << "[Fortran array descriptor: " << FAD->getName();
1090 OS << "] ";
1091 };
1092
Tobias Grossera535dff2015-12-13 19:59:01 +00001093 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +00001094 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +00001095 if (hasNewAccessRelation())
1096 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001097}
1098
Michael Kruse5d518462017-07-21 15:54:07 +00001099#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001100LLVM_DUMP_METHOD void MemoryAccess::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +00001101#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001102
Tobias Grossercdf471b2017-07-24 16:36:34 +00001103isl::pw_aff MemoryAccess::getPwAff(const SCEV *E) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001104 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +00001105 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001106 isl::set StmtDom = getStatement()->getDomain();
Tobias Grossercdf471b2017-07-24 16:36:34 +00001107 StmtDom = StmtDom.reset_tuple_id();
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001108 isl::set NewInvalidDom = StmtDom.intersect(PWAC.second);
Tobias Grosserb739cb42017-07-24 20:30:34 +00001109 InvalidDomain = InvalidDomain.unite(NewInvalidDom);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001110 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001111}
1112
Tobias Grosser75805372011-04-29 06:27:02 +00001113// Create a map in the size of the provided set domain, that maps from the
1114// one element of the provided set domain to another element of the provided
1115// set domain.
1116// The mapping is limited to all points that are equal in all but the last
1117// dimension and for which the last dimension of the input is strict smaller
1118// than the last dimension of the output.
1119//
1120// getEqualAndLarger(set[i0, i1, ..., iX]):
1121//
1122// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
1123// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
1124//
Tobias Grosserd7065e52017-07-24 20:50:22 +00001125static isl::map getEqualAndLarger(isl::space SetDomain) {
1126 isl::space Space = SetDomain.map_from_set();
1127 isl::map Map = isl::map::universe(Space);
1128 unsigned lastDimension = Map.dim(isl::dim::in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +00001129
1130 // Set all but the last dimension to be equal for the input and output
1131 //
1132 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
1133 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +00001134 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserd7065e52017-07-24 20:50:22 +00001135 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosser75805372011-04-29 06:27:02 +00001136
1137 // Set the last dimension of the input to be strict smaller than the
1138 // last dimension of the output.
1139 //
1140 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosserd7065e52017-07-24 20:50:22 +00001141 Map = Map.order_lt(isl::dim::in, lastDimension, isl::dim::out, lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +00001142 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +00001143}
1144
Tobias Grosserd7065e52017-07-24 20:50:22 +00001145isl::set MemoryAccess::getStride(isl::map Schedule) const {
1146 isl::map AccessRelation = getAccessRelation();
1147 isl::space Space = Schedule.get_space().range();
1148 isl::map NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +00001149
Tobias Grosserd7065e52017-07-24 20:50:22 +00001150 Schedule = Schedule.reverse();
1151 NextScatt = NextScatt.lexmin();
Tobias Grosser75805372011-04-29 06:27:02 +00001152
Tobias Grosserd7065e52017-07-24 20:50:22 +00001153 NextScatt = NextScatt.apply_range(Schedule);
1154 NextScatt = NextScatt.apply_range(AccessRelation);
1155 NextScatt = NextScatt.apply_domain(Schedule);
1156 NextScatt = NextScatt.apply_domain(AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +00001157
Tobias Grosserd7065e52017-07-24 20:50:22 +00001158 isl::set Deltas = NextScatt.deltas();
Sebastian Popa00a0292012-12-18 07:46:06 +00001159 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +00001160}
1161
Tobias Grosserd7065e52017-07-24 20:50:22 +00001162bool MemoryAccess::isStrideX(isl::map Schedule, int StrideWidth) const {
1163 isl::set Stride, StrideX;
Tobias Grosser28dd4862012-01-24 16:42:16 +00001164 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +00001165
Sebastian Popa00a0292012-12-18 07:46:06 +00001166 Stride = getStride(Schedule);
Tobias Grosserd7065e52017-07-24 20:50:22 +00001167 StrideX = isl::set::universe(Stride.get_space());
1168 for (unsigned i = 0; i < StrideX.dim(isl::dim::set) - 1; i++)
1169 StrideX = StrideX.fix_si(isl::dim::set, i, 0);
1170 StrideX = StrideX.fix_si(isl::dim::set, StrideX.dim(isl::dim::set) - 1,
1171 StrideWidth);
1172 IsStrideX = Stride.is_subset(StrideX);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001173
Tobias Grosser28dd4862012-01-24 16:42:16 +00001174 return IsStrideX;
1175}
1176
Tobias Grosserd7065e52017-07-24 20:50:22 +00001177bool MemoryAccess::isStrideZero(isl::map Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001178 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001179}
1180
Tobias Grosserd7065e52017-07-24 20:50:22 +00001181bool MemoryAccess::isStrideOne(isl::map Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001182 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001183}
1184
Tobias Grosser6d588042017-08-02 19:27:16 +00001185void MemoryAccess::setAccessRelation(isl::map NewAccess) {
1186 AccessRelation = NewAccess;
Tobias Grosserbedef002016-12-02 08:10:56 +00001187}
1188
Tobias Grosser7b45af12017-08-02 19:27:25 +00001189void MemoryAccess::setNewAccessRelation(isl::map NewAccess) {
Michael Kruse772ce722016-09-01 19:16:58 +00001190 assert(NewAccess);
1191
1192#ifndef NDEBUG
1193 // Check domain space compatibility.
Tobias Grosser7b45af12017-08-02 19:27:25 +00001194 isl::space NewSpace = NewAccess.get_space();
1195 isl::space NewDomainSpace = NewSpace.domain();
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001196 isl::space OriginalDomainSpace = getStatement()->getDomainSpace();
Tobias Grosser7b45af12017-08-02 19:27:25 +00001197 assert(OriginalDomainSpace.has_equal_tuples(NewDomainSpace));
Michael Kruse772ce722016-09-01 19:16:58 +00001198
Michael Kruse706f79a2017-05-21 22:46:57 +00001199 // Reads must be executed unconditionally. Writes might be executed in a
1200 // subdomain only.
1201 if (isRead()) {
1202 // Check whether there is an access for every statement instance.
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001203 isl::set StmtDomain = getStatement()->getDomain();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00001204 StmtDomain =
1205 StmtDomain.intersect_params(getStatement()->getParent()->getContext());
Tobias Grosser7b45af12017-08-02 19:27:25 +00001206 isl::set NewDomain = NewAccess.domain();
1207 assert(StmtDomain.is_subset(NewDomain) &&
Michael Kruse706f79a2017-05-21 22:46:57 +00001208 "Partial READ accesses not supported");
Michael Kruse706f79a2017-05-21 22:46:57 +00001209 }
Michael Kruse772ce722016-09-01 19:16:58 +00001210
Tobias Grosser7b45af12017-08-02 19:27:25 +00001211 isl::space NewAccessSpace = NewAccess.get_space();
1212 assert(NewAccessSpace.has_tuple_id(isl::dim::set) &&
Michael Kruse772ce722016-09-01 19:16:58 +00001213 "Must specify the array that is accessed");
Tobias Grosser7b45af12017-08-02 19:27:25 +00001214 isl::id NewArrayId = NewAccessSpace.get_tuple_id(isl::dim::set);
1215 auto *SAI = static_cast<ScopArrayInfo *>(NewArrayId.get_user());
Michael Kruse772ce722016-09-01 19:16:58 +00001216 assert(SAI && "Must set a ScopArrayInfo");
Tobias Grossere1ff0cf2017-01-17 12:00:42 +00001217
1218 if (SAI->isArrayKind() && SAI->getBasePtrOriginSAI()) {
1219 InvariantEquivClassTy *EqClass =
1220 getStatement()->getParent()->lookupInvariantEquivClass(
1221 SAI->getBasePtr());
1222 assert(EqClass &&
1223 "Access functions to indirect arrays must have an invariant and "
1224 "hoisted base pointer");
1225 }
1226
1227 // Check whether access dimensions correspond to number of dimensions of the
1228 // accesses array.
Michael Kruse772ce722016-09-01 19:16:58 +00001229 auto Dims = SAI->getNumberOfDimensions();
Tobias Grosser7b45af12017-08-02 19:27:25 +00001230 assert(NewAccessSpace.dim(isl::dim::set) == Dims &&
Michael Kruse772ce722016-09-01 19:16:58 +00001231 "Access dims must match array dims");
Michael Kruse772ce722016-09-01 19:16:58 +00001232#endif
1233
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001234 NewAccess = NewAccess.gist_domain(getStatement()->getDomain());
Tobias Grosser7b45af12017-08-02 19:27:25 +00001235 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001236}
Tobias Grosser75805372011-04-29 06:27:02 +00001237
Michael Kruse706f79a2017-05-21 22:46:57 +00001238bool MemoryAccess::isLatestPartialAccess() const {
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001239 isl::set StmtDom = getStatement()->getDomain();
Tobias Grosser1515f6b2017-07-23 04:08:38 +00001240 isl::set AccDom = getLatestAccessRelation().domain();
Michael Kruse706f79a2017-05-21 22:46:57 +00001241
1242 return isl_set_is_subset(StmtDom.keep(), AccDom.keep()) == isl_bool_false;
1243}
1244
Tobias Grosser75805372011-04-29 06:27:02 +00001245//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001246
Tobias Grosser6ad16402017-08-06 17:45:28 +00001247isl::map ScopStmt::getSchedule() const {
Tobias Grosser1e09c132017-08-14 06:49:06 +00001248 isl::set Domain = getDomain();
1249 if (Domain.is_empty())
1250 return isl::map::from_aff(isl::aff(isl::local_space(getDomainSpace())));
1251 auto Schedule = getParent()->getSchedule();
1252 if (!Schedule)
Roman Gareevb3224ad2016-09-14 06:26:09 +00001253 return nullptr;
Tobias Grosser1e09c132017-08-14 06:49:06 +00001254 Schedule = Schedule.intersect_domain(isl::union_set(Domain));
1255 if (Schedule.is_empty())
1256 return isl::map::from_aff(isl::aff(isl::local_space(getDomainSpace())));
1257 isl::map M = M.from_union_map(Schedule);
1258 M = M.coalesce();
1259 M = M.gist_domain(Domain);
1260 M = M.coalesce();
1261 return M;
Tobias Grosser808cd692015-07-14 09:33:13 +00001262}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001263
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001264void ScopStmt::restrictDomain(isl::set NewDomain) {
1265 assert(NewDomain.is_subset(Domain) &&
Tobias Grosser37eb4222014-02-20 21:43:54 +00001266 "New domain is not a subset of old domain!");
Tobias Grosser37eb4222014-02-20 21:43:54 +00001267 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001268}
1269
Michael Kruse70af4f52017-08-07 18:40:29 +00001270void ScopStmt::addAccess(MemoryAccess *Access, bool Prepend) {
Michael Krusecac948e2015-10-02 13:53:07 +00001271 Instruction *AccessInst = Access->getAccessInstruction();
1272
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001273 if (Access->isArrayKind()) {
1274 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1275 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001276 } else if (Access->isValueKind() && Access->isWrite()) {
1277 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse436db622016-01-26 13:33:10 +00001278 assert(!ValueWrites.lookup(AccessVal));
1279
1280 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001281 } else if (Access->isValueKind() && Access->isRead()) {
1282 Value *AccessVal = Access->getAccessValue();
1283 assert(!ValueReads.lookup(AccessVal));
1284
1285 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001286 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
Tobias Grosser5db171a2017-02-10 10:09:44 +00001287 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001288 assert(!PHIWrites.lookup(PHI));
1289
1290 PHIWrites[PHI] = Access;
Michael Kruse3562f272017-07-20 16:47:57 +00001291 } else if (Access->isAnyPHIKind() && Access->isRead()) {
1292 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
1293 assert(!PHIReads.lookup(PHI));
1294
1295 PHIReads[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001296 }
1297
Michael Kruse70af4f52017-08-07 18:40:29 +00001298 if (Prepend) {
1299 MemAccs.insert(MemAccs.begin(), Access);
1300 return;
1301 }
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001302 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001303}
1304
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001305void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001306 for (MemoryAccess *MA : *this)
1307 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001308
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00001309 isl::set Ctx = Parent.getContext();
Tobias Grosser2332fa32017-08-06 15:36:48 +00001310 InvalidDomain = InvalidDomain.gist_params(Ctx);
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001311 Domain = Domain.gist_params(Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001312}
1313
Tobias Grosserc80d6972016-09-02 06:33:33 +00001314/// Add @p BSet to the set @p User if @p BSet is bounded.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001315static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1316 void *User) {
1317 isl_set **BoundedParts = static_cast<isl_set **>(User);
1318 if (isl_basic_set_is_bounded(BSet))
1319 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1320 else
1321 isl_basic_set_free(BSet);
1322 return isl_stat_ok;
1323}
1324
Tobias Grosserc80d6972016-09-02 06:33:33 +00001325/// Return the bounded parts of @p S.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001326static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1327 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1328 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1329 isl_set_free(S);
1330 return BoundedParts;
1331}
1332
Tobias Grosserc80d6972016-09-02 06:33:33 +00001333/// Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001334///
1335/// @returns A separation of @p S into first an unbounded then a bounded subset,
1336/// both with regards to the dimension @p Dim.
1337static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1338partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001339 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001340 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001341
1342 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001343 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001344
1345 // Remove dimensions that are greater than Dim as they are not interesting.
1346 assert(NumDimsS >= Dim + 1);
1347 OnlyDimS =
1348 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1349
1350 // Create artificial parametric upper bounds for dimensions smaller than Dim
1351 // as we are not interested in them.
1352 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1353 for (unsigned u = 0; u < Dim; u++) {
1354 isl_constraint *C = isl_inequality_alloc(
1355 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1356 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1357 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1358 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1359 }
1360
1361 // Collect all bounded parts of OnlyDimS.
1362 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1363
1364 // Create the dimensions greater than Dim again.
1365 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1366 NumDimsS - Dim - 1);
1367
1368 // Remove the artificial upper bound parameters again.
1369 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1370
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001371 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001372 return std::make_pair(UnboundedParts, BoundedParts);
1373}
1374
Tobias Grosserc80d6972016-09-02 06:33:33 +00001375/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001376static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001377 __isl_take isl_pw_aff *L,
1378 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001379 switch (Pred) {
1380 case ICmpInst::ICMP_EQ:
1381 return isl_pw_aff_eq_set(L, R);
1382 case ICmpInst::ICMP_NE:
1383 return isl_pw_aff_ne_set(L, R);
1384 case ICmpInst::ICMP_SLT:
1385 return isl_pw_aff_lt_set(L, R);
1386 case ICmpInst::ICMP_SLE:
1387 return isl_pw_aff_le_set(L, R);
1388 case ICmpInst::ICMP_SGT:
1389 return isl_pw_aff_gt_set(L, R);
1390 case ICmpInst::ICMP_SGE:
1391 return isl_pw_aff_ge_set(L, R);
1392 case ICmpInst::ICMP_ULT:
1393 return isl_pw_aff_lt_set(L, R);
1394 case ICmpInst::ICMP_UGT:
1395 return isl_pw_aff_gt_set(L, R);
1396 case ICmpInst::ICMP_ULE:
1397 return isl_pw_aff_le_set(L, R);
1398 case ICmpInst::ICMP_UGE:
1399 return isl_pw_aff_ge_set(L, R);
1400 default:
1401 llvm_unreachable("Non integer predicate not supported");
1402 }
1403}
1404
Michael Kruse476f8552017-06-29 12:47:41 +00001405/// Compute the isl representation for the SCEV @p E in this BB.
1406///
1407/// @param S The Scop in which @p BB resides in.
1408/// @param BB The BB for which isl representation is to be
1409/// computed.
1410/// @param InvalidDomainMap A map of BB to their invalid domains.
1411/// @param E The SCEV that should be translated.
1412/// @param NonNegative Flag to indicate the @p E has to be non-negative.
1413///
1414/// Note that this function will also adjust the invalid context accordingly.
1415
1416__isl_give isl_pw_aff *
1417getPwAff(Scop &S, BasicBlock *BB,
Tobias Grosser13acbb92017-07-15 09:01:31 +00001418 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap, const SCEV *E,
1419 bool NonNegative = false) {
Michael Kruse476f8552017-06-29 12:47:41 +00001420 PWACtx PWAC = S.getPwAff(E, BB, NonNegative);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00001421 InvalidDomainMap[BB] = InvalidDomainMap[BB].unite(PWAC.second);
1422 return PWAC.first.take();
Michael Kruse476f8552017-06-29 12:47:41 +00001423}
1424
Tobias Grosserc80d6972016-09-02 06:33:33 +00001425/// Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001426///
1427/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001428/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1429/// have as many elements as @p SI has successors.
Tobias Grosseree457592017-09-24 09:25:30 +00001430bool buildConditionSets(Scop &S, BasicBlock *BB, SwitchInst *SI, Loop *L,
1431 __isl_keep isl_set *Domain,
1432 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1433 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001434 Value *Condition = getConditionFromTerminator(SI);
1435 assert(Condition && "No condition for switch");
1436
1437 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001438 isl_pw_aff *LHS, *RHS;
Michael Kruse476f8552017-06-29 12:47:41 +00001439 LHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001440
1441 unsigned NumSuccessors = SI->getNumSuccessors();
1442 ConditionSets.resize(NumSuccessors);
1443 for (auto &Case : SI->cases()) {
1444 unsigned Idx = Case.getSuccessorIndex();
1445 ConstantInt *CaseValue = Case.getCaseValue();
1446
Michael Kruse476f8552017-06-29 12:47:41 +00001447 RHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001448 isl_set *CaseConditionSet =
Tobias Grosserb9486302018-03-03 19:27:54 +00001449 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001450 ConditionSets[Idx] = isl_set_coalesce(
1451 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1452 }
1453
1454 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1455 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1456 for (unsigned u = 2; u < NumSuccessors; u++)
1457 ConditionSetUnion =
1458 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
Tobias Grosserb9486302018-03-03 19:27:54 +00001459 ConditionSets[0] = isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001460
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001461 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001462
1463 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001464}
1465
Michael Kruse08655852017-07-20 12:37:02 +00001466/// Build condition sets for unsigned ICmpInst(s).
1467/// Special handling is required for unsigned operands to ensure that if
1468/// MSB (aka the Sign bit) is set for an operands in an unsigned ICmpInst
1469/// it should wrap around.
1470///
1471/// @param IsStrictUpperBound holds information on the predicate relation
1472/// between TestVal and UpperBound, i.e,
1473/// TestVal < UpperBound OR TestVal <= UpperBound
Tobias Grosseree457592017-09-24 09:25:30 +00001474__isl_give isl_set *
Michael Kruse08655852017-07-20 12:37:02 +00001475buildUnsignedConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1476 __isl_keep isl_set *Domain, const SCEV *SCEV_TestVal,
1477 const SCEV *SCEV_UpperBound,
1478 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1479 bool IsStrictUpperBound) {
Michael Kruse08655852017-07-20 12:37:02 +00001480 // Do not take NonNeg assumption on TestVal
1481 // as it might have MSB (Sign bit) set.
1482 isl_pw_aff *TestVal = getPwAff(S, BB, InvalidDomainMap, SCEV_TestVal, false);
1483 // Take NonNeg assumption on UpperBound.
1484 isl_pw_aff *UpperBound =
1485 getPwAff(S, BB, InvalidDomainMap, SCEV_UpperBound, true);
1486
1487 // 0 <= TestVal
1488 isl_set *First =
1489 isl_pw_aff_le_set(isl_pw_aff_zero_on_domain(isl_local_space_from_space(
1490 isl_pw_aff_get_domain_space(TestVal))),
1491 isl_pw_aff_copy(TestVal));
1492
1493 isl_set *Second;
1494 if (IsStrictUpperBound)
1495 // TestVal < UpperBound
1496 Second = isl_pw_aff_lt_set(TestVal, UpperBound);
1497 else
1498 // TestVal <= UpperBound
1499 Second = isl_pw_aff_le_set(TestVal, UpperBound);
1500
1501 isl_set *ConsequenceCondSet = isl_set_intersect(First, Second);
Michael Kruse08655852017-07-20 12:37:02 +00001502 return ConsequenceCondSet;
1503}
1504
Tobias Grosserc80d6972016-09-02 06:33:33 +00001505/// Build the conditions sets for the branch condition @p Condition in
1506/// the @p Domain.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001507///
1508/// This will fill @p ConditionSets with the conditions under which control
1509/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001510/// have as many elements as @p TI has successors. If @p TI is nullptr the
1511/// context under which @p Condition is true/false will be returned as the
1512/// new elements of @p ConditionSets.
Tobias Grosseree457592017-09-24 09:25:30 +00001513bool buildConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1514 TerminatorInst *TI, Loop *L, __isl_keep isl_set *Domain,
1515 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1516 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Tobias Grosser5e531df2017-09-25 20:27:15 +00001517 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001518 isl_set *ConsequenceCondSet = nullptr;
Tobias Grosser0a62b2d2017-09-25 16:37:15 +00001519
Tobias Grosser5e531df2017-09-25 20:27:15 +00001520 if (auto Load = dyn_cast<LoadInst>(Condition)) {
1521 const SCEV *LHSSCEV = SE.getSCEVAtScope(Load, L);
1522 const SCEV *RHSSCEV = SE.getZero(LHSSCEV->getType());
1523 bool NonNeg = false;
1524 isl_pw_aff *LHS = getPwAff(S, BB, InvalidDomainMap, LHSSCEV, NonNeg);
1525 isl_pw_aff *RHS = getPwAff(S, BB, InvalidDomainMap, RHSSCEV, NonNeg);
Tobias Grosserb9486302018-03-03 19:27:54 +00001526 ConsequenceCondSet = buildConditionSet(ICmpInst::ICMP_SLE, LHS, RHS);
Tobias Grosser5e531df2017-09-25 20:27:15 +00001527 } else if (auto *PHI = dyn_cast<PHINode>(Condition)) {
Tobias Grosser0a62b2d2017-09-25 16:37:15 +00001528 auto *Unique = dyn_cast<ConstantInt>(
1529 getUniqueNonErrorValue(PHI, &S.getRegion(), *S.getLI(), *S.getDT()));
1530
1531 if (Unique->isZero())
1532 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1533 else
1534 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1535 } else if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001536 if (CCond->isZero())
1537 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1538 else
1539 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1540 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1541 auto Opcode = BinOp->getOpcode();
1542 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1543
Michael Kruse476f8552017-06-29 12:47:41 +00001544 bool Valid = buildConditionSets(S, BB, BinOp->getOperand(0), TI, L, Domain,
1545 InvalidDomainMap, ConditionSets) &&
1546 buildConditionSets(S, BB, BinOp->getOperand(1), TI, L, Domain,
1547 InvalidDomainMap, ConditionSets);
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001548 if (!Valid) {
1549 while (!ConditionSets.empty())
1550 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001551 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001552 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001553
1554 isl_set_free(ConditionSets.pop_back_val());
1555 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1556 isl_set_free(ConditionSets.pop_back_val());
1557 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1558
1559 if (Opcode == Instruction::And)
1560 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1561 else
1562 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1563 } else {
1564 auto *ICond = dyn_cast<ICmpInst>(Condition);
1565 assert(ICond &&
1566 "Condition of exiting branch was neither constant nor ICmp!");
1567
Tobias Grosseree457592017-09-24 09:25:30 +00001568 LoopInfo &LI = *S.getLI();
1569 DominatorTree &DT = *S.getDT();
1570 Region &R = S.getRegion();
1571
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001572 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001573 // For unsigned comparisons we assumed the signed bit of neither operand
1574 // to be set. The comparison is equal to a signed comparison under this
1575 // assumption.
1576 bool NonNeg = ICond->isUnsigned();
Michael Kruse08655852017-07-20 12:37:02 +00001577 const SCEV *LeftOperand = SE.getSCEVAtScope(ICond->getOperand(0), L),
1578 *RightOperand = SE.getSCEVAtScope(ICond->getOperand(1), L);
1579
Tobias Grosseree457592017-09-24 09:25:30 +00001580 LeftOperand = tryForwardThroughPHI(LeftOperand, R, SE, LI, DT);
1581 RightOperand = tryForwardThroughPHI(RightOperand, R, SE, LI, DT);
1582
Michael Kruse08655852017-07-20 12:37:02 +00001583 switch (ICond->getPredicate()) {
1584 case ICmpInst::ICMP_ULT:
1585 ConsequenceCondSet =
1586 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1587 RightOperand, InvalidDomainMap, true);
1588 break;
1589 case ICmpInst::ICMP_ULE:
1590 ConsequenceCondSet =
1591 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1592 RightOperand, InvalidDomainMap, false);
1593 break;
1594 case ICmpInst::ICMP_UGT:
1595 ConsequenceCondSet =
1596 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1597 LeftOperand, InvalidDomainMap, true);
1598 break;
1599 case ICmpInst::ICMP_UGE:
1600 ConsequenceCondSet =
1601 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1602 LeftOperand, InvalidDomainMap, false);
1603 break;
1604 default:
1605 LHS = getPwAff(S, BB, InvalidDomainMap, LeftOperand, NonNeg);
1606 RHS = getPwAff(S, BB, InvalidDomainMap, RightOperand, NonNeg);
Tobias Grosserb9486302018-03-03 19:27:54 +00001607 ConsequenceCondSet = buildConditionSet(ICond->getPredicate(), LHS, RHS);
Michael Kruse08655852017-07-20 12:37:02 +00001608 break;
1609 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001610 }
1611
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001612 // If no terminator was given we are only looking for parameter constraints
1613 // under which @p Condition is true/false.
1614 if (!TI)
1615 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001616 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001617 ConsequenceCondSet = isl_set_coalesce(
1618 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001619
Johannes Doerfertb2885792016-04-26 09:20:41 +00001620 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001621 bool TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001622 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001623
Michael Krusef7a4a942016-05-02 12:25:36 +00001624 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001625 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1626 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001627 TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001628 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001629 }
1630
Michael Krusef7a4a942016-05-02 12:25:36 +00001631 if (TooComplex) {
Eli Friedmane737fc12017-07-17 23:58:33 +00001632 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc(),
1633 TI ? TI->getParent() : nullptr /* BasicBlock */);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001634 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001635 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001636 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001637 }
1638
1639 ConditionSets.push_back(ConsequenceCondSet);
1640 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001641
1642 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001643}
1644
Tobias Grosserc80d6972016-09-02 06:33:33 +00001645/// Build the conditions sets for the terminator @p TI in the @p Domain.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001646///
1647/// This will fill @p ConditionSets with the conditions under which control
1648/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1649/// have as many elements as @p TI has successors.
Tobias Grosseree457592017-09-24 09:25:30 +00001650bool buildConditionSets(Scop &S, BasicBlock *BB, TerminatorInst *TI, Loop *L,
1651 __isl_keep isl_set *Domain,
1652 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1653 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001654 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Michael Kruse476f8552017-06-29 12:47:41 +00001655 return buildConditionSets(S, BB, SI, L, Domain, InvalidDomainMap,
1656 ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001657
1658 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1659
1660 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001661 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001662 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001663 }
1664
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001665 Value *Condition = getConditionFromTerminator(TI);
1666 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001667
Michael Kruse476f8552017-06-29 12:47:41 +00001668 return buildConditionSets(S, BB, Condition, TI, L, Domain, InvalidDomainMap,
1669 ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001670}
1671
Michael Krused6e22082018-01-18 15:15:38 +00001672ScopStmt::ScopStmt(Scop &parent, Region &R, StringRef Name,
1673 Loop *SurroundingLoop,
Tobias Grosserbd15d132017-08-31 03:15:56 +00001674 std::vector<Instruction *> EntryBlockInstructions)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001675 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), R(&R),
Michael Krused6e22082018-01-18 15:15:38 +00001676 Build(nullptr), BaseName(Name), SurroundingLoop(SurroundingLoop),
1677 Instructions(EntryBlockInstructions) {}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001678
Michael Krused6e22082018-01-18 15:15:38 +00001679ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb, StringRef Name,
1680 Loop *SurroundingLoop,
1681 std::vector<Instruction *> Instructions)
Johannes Doerferta3519512016-04-23 13:02:23 +00001682 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
Michael Krused6e22082018-01-18 15:15:38 +00001683 Build(nullptr), BaseName(Name), SurroundingLoop(SurroundingLoop),
1684 Instructions(Instructions) {}
Michael Krusecac948e2015-10-02 13:53:07 +00001685
Tobias Grosser85048ef2017-08-06 17:24:59 +00001686ScopStmt::ScopStmt(Scop &parent, isl::map SourceRel, isl::map TargetRel,
1687 isl::set NewDomain)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001688 : Parent(parent), InvalidDomain(nullptr), Domain(NewDomain),
1689 Build(nullptr) {
Roman Gareevb3224ad2016-09-14 06:26:09 +00001690 BaseName = getIslCompatibleName("CopyStmt_", "",
1691 std::to_string(parent.getCopyStmtsNum()));
Tobias Grosser85048ef2017-08-06 17:24:59 +00001692 isl::id Id = isl::id::alloc(getIslCtx(), getBaseName(), this);
1693 Domain = Domain.set_tuple_id(Id);
1694 TargetRel = TargetRel.set_tuple_id(isl::dim::in, Id);
1695 auto *Access =
1696 new MemoryAccess(this, MemoryAccess::AccessType::MUST_WRITE, TargetRel);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001697 parent.addAccessFunction(Access);
1698 addAccess(Access);
Tobias Grosser85048ef2017-08-06 17:24:59 +00001699 SourceRel = SourceRel.set_tuple_id(isl::dim::in, Id);
1700 Access = new MemoryAccess(this, MemoryAccess::AccessType::READ, SourceRel);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001701 parent.addAccessFunction(Access);
1702 addAccess(Access);
1703}
1704
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001705ScopStmt::~ScopStmt() = default;
1706
Tobias Grossera9b5bba2017-08-06 16:11:53 +00001707std::string ScopStmt::getDomainStr() const { return Domain.to_str(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001708
Tobias Grosser54839312015-04-21 11:37:25 +00001709std::string ScopStmt::getScheduleStr() const {
Tobias Grosser6ad16402017-08-06 17:45:28 +00001710 auto *S = getSchedule().release();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001711 if (!S)
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001712 return {};
Tobias Grosser808cd692015-07-14 09:33:13 +00001713 auto Str = stringFromIslObj(S);
1714 isl_map_free(S);
1715 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001716}
1717
Tobias Grosser2332fa32017-08-06 15:36:48 +00001718void ScopStmt::setInvalidDomain(isl::set ID) { InvalidDomain = ID; }
Johannes Doerfert7c013572016-04-12 09:57:34 +00001719
Michael Kruse375cb5f2016-02-24 22:08:24 +00001720BasicBlock *ScopStmt::getEntryBlock() const {
1721 if (isBlockStmt())
1722 return getBasicBlock();
1723 return getRegion()->getEntry();
1724}
1725
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001726unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001727
Tobias Grosser75805372011-04-29 06:27:02 +00001728const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1729
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001730Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001731 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001732}
1733
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00001734isl::ctx ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001735
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001736isl::set ScopStmt::getDomain() const { return Domain; }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001737
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001738isl::space ScopStmt::getDomainSpace() const { return Domain.get_space(); }
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001739
Tobias Grosserdcf8d692017-08-06 16:39:52 +00001740isl::id ScopStmt::getDomainId() const { return Domain.get_tuple_id(); }
Tobias Grossercd95b772012-08-30 11:49:38 +00001741
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001742void ScopStmt::printInstructions(raw_ostream &OS) const {
1743 OS << "Instructions {\n";
1744
1745 for (Instruction *Inst : Instructions)
1746 OS.indent(16) << *Inst << "\n";
1747
Michael Krusee52ebd12017-07-22 16:44:39 +00001748 OS.indent(12) << "}\n";
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001749}
1750
Michael Krusecd4c9772017-07-21 15:35:53 +00001751void ScopStmt::print(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00001752 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001753 OS.indent(12) << "Domain :=\n";
1754
1755 if (Domain) {
1756 OS.indent(16) << getDomainStr() << ";\n";
1757 } else
1758 OS.indent(16) << "n/a\n";
1759
Tobias Grosser54839312015-04-21 11:37:25 +00001760 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001761
1762 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001763 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001764 } else
1765 OS.indent(16) << "n/a\n";
1766
Tobias Grosser083d3d32014-06-28 08:59:45 +00001767 for (MemoryAccess *Access : MemAccs)
1768 Access->print(OS);
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001769
Tobias Grosserbd15d132017-08-31 03:15:56 +00001770 if (PrintInstructions)
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001771 printInstructions(OS.indent(12));
Tobias Grosser75805372011-04-29 06:27:02 +00001772}
1773
Michael Kruse5d518462017-07-21 15:54:07 +00001774#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001775LLVM_DUMP_METHOD void ScopStmt::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00001776#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001777
Michael Krusee60eca72017-05-11 22:56:12 +00001778void ScopStmt::removeAccessData(MemoryAccess *MA) {
1779 if (MA->isRead() && MA->isOriginalValueKind()) {
1780 bool Found = ValueReads.erase(MA->getAccessValue());
1781 (void)Found;
1782 assert(Found && "Expected access data not found");
1783 }
1784 if (MA->isWrite() && MA->isOriginalValueKind()) {
1785 bool Found = ValueWrites.erase(cast<Instruction>(MA->getAccessValue()));
1786 (void)Found;
1787 assert(Found && "Expected access data not found");
1788 }
1789 if (MA->isWrite() && MA->isOriginalAnyPHIKind()) {
1790 bool Found = PHIWrites.erase(cast<PHINode>(MA->getAccessInstruction()));
1791 (void)Found;
1792 assert(Found && "Expected access data not found");
1793 }
Michael Kruse3562f272017-07-20 16:47:57 +00001794 if (MA->isRead() && MA->isOriginalAnyPHIKind()) {
1795 bool Found = PHIReads.erase(cast<PHINode>(MA->getAccessInstruction()));
1796 (void)Found;
1797 assert(Found && "Expected access data not found");
1798 }
Michael Krusee60eca72017-05-11 22:56:12 +00001799}
1800
Michael Kruse10071822016-05-23 14:45:58 +00001801void ScopStmt::removeMemoryAccess(MemoryAccess *MA) {
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001802 // Remove the memory accesses from this statement together with all scalar
1803 // accesses that were caused by it. MemoryKind::Value READs have no access
1804 // instruction, hence would not be removed by this function. However, it is
1805 // only used for invariant LoadInst accesses, its arguments are always affine,
1806 // hence synthesizable, and therefore there are no MemoryKind::Value READ
1807 // accesses to be removed.
Michael Kruse10071822016-05-23 14:45:58 +00001808 auto Predicate = [&](MemoryAccess *Acc) {
1809 return Acc->getAccessInstruction() == MA->getAccessInstruction();
1810 };
Michael Krusee60eca72017-05-11 22:56:12 +00001811 for (auto *MA : MemAccs) {
Michael Kruse8b805802017-07-19 17:11:25 +00001812 if (Predicate(MA)) {
Michael Krusee60eca72017-05-11 22:56:12 +00001813 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00001814 Parent.removeAccessData(MA);
1815 }
Michael Krusee60eca72017-05-11 22:56:12 +00001816 }
Michael Kruse10071822016-05-23 14:45:58 +00001817 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1818 MemAccs.end());
1819 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001820}
1821
Michael Kruse0446d812017-03-10 16:05:24 +00001822void ScopStmt::removeSingleMemoryAccess(MemoryAccess *MA) {
1823 auto MAIt = std::find(MemAccs.begin(), MemAccs.end(), MA);
1824 assert(MAIt != MemAccs.end());
1825 MemAccs.erase(MAIt);
1826
Michael Krusee60eca72017-05-11 22:56:12 +00001827 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00001828 Parent.removeAccessData(MA);
Michael Krusee60eca72017-05-11 22:56:12 +00001829
Michael Kruse0446d812017-03-10 16:05:24 +00001830 auto It = InstructionToAccess.find(MA->getAccessInstruction());
1831 if (It != InstructionToAccess.end()) {
1832 It->second.remove(MA);
1833 if (It->second.empty())
1834 InstructionToAccess.erase(MA->getAccessInstruction());
1835 }
1836}
1837
Michael Kruse07e8c362017-07-24 12:43:27 +00001838MemoryAccess *ScopStmt::ensureValueRead(Value *V) {
1839 MemoryAccess *Access = lookupInputAccessOf(V);
1840 if (Access)
1841 return Access;
1842
1843 ScopArrayInfo *SAI =
1844 Parent.getOrCreateScopArrayInfo(V, V->getType(), {}, MemoryKind::Value);
1845 Access = new MemoryAccess(this, nullptr, MemoryAccess::READ, V, V->getType(),
1846 true, {}, {}, V, MemoryKind::Value);
1847 Parent.addAccessFunction(Access);
1848 Access->buildAccessRelation(SAI);
1849 addAccess(Access);
1850 Parent.addAccessData(Access);
1851 return Access;
1852}
1853
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001854raw_ostream &polly::operator<<(raw_ostream &OS, const ScopStmt &S) {
1855 S.print(OS, PollyPrintInstructions);
1856 return OS;
Michael Krusecd4c9772017-07-21 15:35:53 +00001857}
1858
Tobias Grosser75805372011-04-29 06:27:02 +00001859//===----------------------------------------------------------------------===//
1860/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001861
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00001862void Scop::setContext(isl::set NewContext) {
1863 Context = NewContext.align_params(Context.get_space());
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001864}
1865
Eli Friedman5e589ea2017-06-20 22:53:02 +00001866namespace {
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001867
Tobias Grosserc80d6972016-09-02 06:33:33 +00001868/// Remap parameter values but keep AddRecs valid wrt. invariant loads.
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001869struct SCEVSensitiveParameterRewriter
Tobias Grosser278f9e72016-11-26 17:58:40 +00001870 : public SCEVRewriteVisitor<SCEVSensitiveParameterRewriter> {
Tobias Grosserb5563c62017-08-03 13:51:15 +00001871 const ValueToValueMap &VMap;
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001872
1873public:
Tobias Grosserb5563c62017-08-03 13:51:15 +00001874 SCEVSensitiveParameterRewriter(const ValueToValueMap &VMap,
1875 ScalarEvolution &SE)
Tobias Grosser278f9e72016-11-26 17:58:40 +00001876 : SCEVRewriteVisitor(SE), VMap(VMap) {}
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001877
1878 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
Tobias Grosserb5563c62017-08-03 13:51:15 +00001879 const ValueToValueMap &VMap) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001880 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1881 return SSPR.visit(E);
1882 }
1883
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001884 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1885 auto *Start = visit(E->getStart());
1886 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1887 visit(E->getStepRecurrence(SE)),
1888 E->getLoop(), SCEV::FlagAnyWrap);
1889 return SE.getAddExpr(Start, AddRec);
1890 }
1891
1892 const SCEV *visitUnknown(const SCEVUnknown *E) {
1893 if (auto *NewValue = VMap.lookup(E->getValue()))
1894 return SE.getUnknown(NewValue);
1895 return E;
1896 }
1897};
1898
Eli Friedman5e589ea2017-06-20 22:53:02 +00001899/// Check whether we should remap a SCEV expression.
1900struct SCEVFindInsideScop : public SCEVTraversal<SCEVFindInsideScop> {
Tobias Grosserb5563c62017-08-03 13:51:15 +00001901 const ValueToValueMap &VMap;
Eli Friedman5e589ea2017-06-20 22:53:02 +00001902 bool FoundInside = false;
Tobias Grosserb5563c62017-08-03 13:51:15 +00001903 const Scop *S;
Eli Friedman5e589ea2017-06-20 22:53:02 +00001904
1905public:
Tobias Grosserb5563c62017-08-03 13:51:15 +00001906 SCEVFindInsideScop(const ValueToValueMap &VMap, ScalarEvolution &SE,
1907 const Scop *S)
Eli Friedman5e589ea2017-06-20 22:53:02 +00001908 : SCEVTraversal(*this), VMap(VMap), S(S) {}
1909
1910 static bool hasVariant(const SCEV *E, ScalarEvolution &SE,
Tobias Grosserb5563c62017-08-03 13:51:15 +00001911 const ValueToValueMap &VMap, const Scop *S) {
Eli Friedman5e589ea2017-06-20 22:53:02 +00001912 SCEVFindInsideScop SFIS(VMap, SE, S);
1913 SFIS.visitAll(E);
1914 return SFIS.FoundInside;
1915 }
1916
1917 bool follow(const SCEV *E) {
1918 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(E)) {
1919 FoundInside |= S->getRegion().contains(AddRec->getLoop());
1920 } else if (auto *Unknown = dyn_cast<SCEVUnknown>(E)) {
1921 if (Instruction *I = dyn_cast<Instruction>(Unknown->getValue()))
1922 FoundInside |= S->getRegion().contains(I) && !VMap.count(I);
1923 }
1924 return !FoundInside;
1925 }
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001926
Eli Friedman5e589ea2017-06-20 22:53:02 +00001927 bool isDone() { return FoundInside; }
1928};
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00001929
1930} // end anonymous namespace
Eli Friedman5e589ea2017-06-20 22:53:02 +00001931
Tobias Grosserb5563c62017-08-03 13:51:15 +00001932const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *E) const {
Eli Friedman5e589ea2017-06-20 22:53:02 +00001933 // Check whether it makes sense to rewrite the SCEV. (ScalarEvolution
1934 // doesn't like addition between an AddRec and an expression that
1935 // doesn't have a dominance relationship with it.)
1936 if (SCEVFindInsideScop::hasVariant(E, *SE, InvEquivClassVMap, this))
1937 return E;
1938
1939 // Rewrite SCEV.
1940 return SCEVSensitiveParameterRewriter::rewrite(E, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001941}
1942
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001943// This table of function names is used to translate parameter names in more
1944// human-readable names. This makes it easier to interpret Polly analysis
1945// results.
1946StringMap<std::string> KnownNames = {
1947 {"_Z13get_global_idj", "global_id"},
1948 {"_Z12get_local_idj", "local_id"},
1949 {"_Z15get_global_sizej", "global_size"},
1950 {"_Z14get_local_sizej", "local_size"},
1951 {"_Z12get_work_dimv", "work_dim"},
1952 {"_Z17get_global_offsetj", "global_offset"},
1953 {"_Z12get_group_idj", "group_id"},
1954 {"_Z14get_num_groupsj", "num_groups"},
1955};
1956
1957static std::string getCallParamName(CallInst *Call) {
1958 std::string Result;
1959 raw_string_ostream OS(Result);
1960 std::string Name = Call->getCalledFunction()->getName();
1961
1962 auto Iterator = KnownNames.find(Name);
1963 if (Iterator != KnownNames.end())
Tobias Grosserdff902f2017-06-01 12:46:51 +00001964 Name = "__" + Iterator->getValue();
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001965 OS << Name;
1966 for (auto &Operand : Call->arg_operands()) {
1967 ConstantInt *Op = cast<ConstantInt>(&Operand);
1968 OS << "_" << Op->getValue();
1969 }
1970 OS.flush();
1971 return Result;
1972}
1973
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001974void Scop::createParameterId(const SCEV *Parameter) {
1975 assert(Parameters.count(Parameter));
1976 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001977
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001978 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001979
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001980 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1981 Value *Val = ValueParameter->getValue();
1982 CallInst *Call = dyn_cast<CallInst>(Val);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001983
Tobias Grosserf5e7e602017-05-27 15:18:46 +00001984 if (Call && isConstCall(Call)) {
1985 ParameterName = getCallParamName(Call);
1986 } else if (UseInstructionNames) {
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001987 // If this parameter references a specific Value and this value has a name
1988 // we use this name as it is likely to be unique and more useful than just
1989 // a number.
1990 if (Val->hasName())
1991 ParameterName = Val->getName();
1992 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
1993 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
1994 if (LoadOrigin->hasName()) {
1995 ParameterName += "_loaded_from_";
1996 ParameterName +=
1997 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1998 }
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001999 }
2000 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00002001
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002002 ParameterName = getIslCompatibleName("", ParameterName, "");
2003 }
Tobias Grosser2ea7c6e2016-07-01 13:40:28 +00002004
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002005 isl::id Id = isl::id::alloc(getIslCtx(), ParameterName,
Tobias Grosser6e78cc62017-08-13 17:54:51 +00002006 const_cast<void *>((const void *)Parameter));
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002007 ParameterIds[Parameter] = Id;
2008}
2009
2010void Scop::addParams(const ParameterSetTy &NewParameters) {
2011 for (const SCEV *Parameter : NewParameters) {
2012 // Normalize the SCEV to get the representing element for an invariant load.
2013 Parameter = extractConstantFactor(Parameter, *SE).second;
2014 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2015
2016 if (Parameters.insert(Parameter))
2017 createParameterId(Parameter);
2018 }
2019}
2020
Tobias Grosser9a635702017-08-06 19:31:27 +00002021isl::id Scop::getIdForParam(const SCEV *Parameter) const {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002022 // Normalize the SCEV to get the representing element for an invariant load.
2023 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
Tobias Grosser6e78cc62017-08-13 17:54:51 +00002024 return ParameterIds.lookup(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00002025}
Tobias Grosser75805372011-04-29 06:27:02 +00002026
Tobias Grosser232fdad2017-08-06 20:19:26 +00002027isl::set Scop::addNonEmptyDomainConstraints(isl::set C) const {
Tobias Grosser31df6f32017-08-06 21:42:25 +00002028 isl_set *DomainContext = isl_union_set_params(getDomains().release());
Tobias Grosser232fdad2017-08-06 20:19:26 +00002029 return isl::manage(isl_set_intersect_params(C.release(), DomainContext));
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002030}
2031
Johannes Doerferte0b08072016-05-23 12:43:44 +00002032bool Scop::isDominatedBy(const DominatorTree &DT, BasicBlock *BB) const {
2033 return DT.dominates(BB, getEntry());
2034}
2035
Michael Kruse476f8552017-06-29 12:47:41 +00002036void Scop::addUserAssumptions(
2037 AssumptionCache &AC, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002038 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse89b1f942017-03-17 13:56:53 +00002039 for (auto &Assumption : AC.assumptions()) {
2040 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
2041 if (!CI || CI->getNumArgOperands() != 1)
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002042 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00002043
Michael Kruse89b1f942017-03-17 13:56:53 +00002044 bool InScop = contains(CI);
2045 if (!InScop && !isDominatedBy(DT, CI->getParent()))
2046 continue;
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002047
Michael Kruse89b1f942017-03-17 13:56:53 +00002048 auto *L = LI.getLoopFor(CI->getParent());
2049 auto *Val = CI->getArgOperand(0);
2050 ParameterSetTy DetectedParams;
2051 if (!isAffineConstraint(Val, &R, L, *SE, DetectedParams)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00002052 ORE.emit(
2053 OptimizationRemarkAnalysis(DEBUG_TYPE, "IgnoreUserAssumption", CI)
2054 << "Non-affine user assumption ignored.");
Michael Kruse89b1f942017-03-17 13:56:53 +00002055 continue;
Michael Kruse7037fde2016-12-15 09:25:14 +00002056 }
Michael Kruse89b1f942017-03-17 13:56:53 +00002057
2058 // Collect all newly introduced parameters.
2059 ParameterSetTy NewParams;
2060 for (auto *Param : DetectedParams) {
2061 Param = extractConstantFactor(Param, *SE).second;
2062 Param = getRepresentingInvariantLoadSCEV(Param);
2063 if (Parameters.count(Param))
2064 continue;
2065 NewParams.insert(Param);
2066 }
2067
2068 SmallVector<isl_set *, 2> ConditionSets;
2069 auto *TI = InScop ? CI->getParent()->getTerminator() : nullptr;
Michael Kruse1df1aac2017-07-26 13:25:28 +00002070 BasicBlock *BB = InScop ? CI->getParent() : getRegion().getEntry();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002071 auto *Dom = InScop ? DomainMap[BB].copy() : Context.copy();
Michael Kruse1df1aac2017-07-26 13:25:28 +00002072 assert(Dom && "Cannot propagate a nullptr.");
2073 bool Valid = buildConditionSets(*this, BB, Val, TI, L, Dom,
2074 InvalidDomainMap, ConditionSets);
Michael Kruse89b1f942017-03-17 13:56:53 +00002075 isl_set_free(Dom);
2076
2077 if (!Valid)
2078 continue;
2079
2080 isl_set *AssumptionCtx = nullptr;
2081 if (InScop) {
2082 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
2083 isl_set_free(ConditionSets[0]);
2084 } else {
2085 AssumptionCtx = isl_set_complement(ConditionSets[1]);
2086 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
2087 }
2088
2089 // Project out newly introduced parameters as they are not otherwise useful.
2090 if (!NewParams.empty()) {
2091 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
2092 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
2093 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
2094 isl_id_free(Id);
2095
2096 if (!NewParams.count(Param))
2097 continue;
2098
2099 AssumptionCtx =
2100 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
2101 }
2102 }
Eli Friedmane737fc12017-07-17 23:58:33 +00002103 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "UserAssumption", CI)
2104 << "Use user assumption: " << stringFromIslObj(AssumptionCtx));
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002105 Context = Context.intersect(isl::manage(AssumptionCtx));
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002106 }
2107}
2108
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002109void Scop::addUserContext() {
2110 if (UserContextStr.empty())
2111 return;
2112
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002113 isl_set *UserContext =
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002114 isl_set_read_from_str(getIslCtx().get(), UserContextStr.c_str());
Tobias Grosserb65ccc42017-08-06 20:11:59 +00002115 isl_space *Space = getParamSpace().release();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002116 if (isl_space_dim(Space, isl_dim_param) !=
2117 isl_set_dim(UserContext, isl_dim_param)) {
2118 auto SpaceStr = isl_space_to_str(Space);
2119 errs() << "Error: the context provided in -polly-context has not the same "
2120 << "number of dimensions than the computed context. Due to this "
2121 << "mismatch, the -polly-context option is ignored. Please provide "
2122 << "the context in the parameter space: " << SpaceStr << ".\n";
2123 free(SpaceStr);
2124 isl_set_free(UserContext);
2125 isl_space_free(Space);
2126 return;
2127 }
2128
2129 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002130 std::string NameContext = Context.get_dim_name(isl::dim::param, i);
2131 std::string NameUserContext =
2132 isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002133
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002134 if (NameContext != NameUserContext) {
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002135 auto SpaceStr = isl_space_to_str(Space);
2136 errs() << "Error: the name of dimension " << i
2137 << " provided in -polly-context "
2138 << "is '" << NameUserContext << "', but the name in the computed "
2139 << "context is '" << NameContext
2140 << "'. Due to this name mismatch, "
2141 << "the -polly-context option is ignored. Please provide "
2142 << "the context in the parameter space: " << SpaceStr << ".\n";
2143 free(SpaceStr);
2144 isl_set_free(UserContext);
2145 isl_space_free(Space);
2146 return;
2147 }
2148
2149 UserContext =
2150 isl_set_set_dim_id(UserContext, isl_dim_param, i,
2151 isl_space_get_dim_id(Space, isl_dim_param, i));
2152 }
2153
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002154 Context = Context.intersect(isl::manage(UserContext));
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002155 isl_space_free(Space);
2156}
2157
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002158void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002159 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002160
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002161 const InvariantLoadsSetTy &RIL = getRequiredInvariantLoads();
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002162 for (LoadInst *LInst : RIL) {
2163 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2164
Johannes Doerfert96e54712016-02-07 17:30:13 +00002165 Type *Ty = LInst->getType();
2166 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002167 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002168 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002169 continue;
2170 }
2171
2172 ClassRep = LInst;
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00002173 InvariantEquivClasses.emplace_back(
2174 InvariantEquivClassTy{PointerSCEV, MemoryAccessList(), nullptr, Ty});
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002175 }
2176}
2177
Tobias Grosser6be480c2011-11-08 15:41:13 +00002178void Scop::buildContext() {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002179 isl::space Space = isl::space::params_alloc(getIslCtx(), 0);
2180 Context = isl::set::universe(Space);
2181 InvalidContext = isl::set::empty(Space);
2182 AssumedContext = isl::set::universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002183}
2184
Tobias Grosser18daaca2012-05-22 10:47:27 +00002185void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002186 unsigned PDim = 0;
2187 for (auto *Parameter : Parameters) {
2188 ConstantRange SRange = SE->getSignedRange(Parameter);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002189 Context = addRangeBoundsToSet(Context, SRange, PDim++, isl::dim::param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00002190 }
2191}
2192
Tobias Grosserb5563c62017-08-03 13:51:15 +00002193static std::vector<isl::id> getFortranArrayIds(Scop::array_range Arrays) {
2194 std::vector<isl::id> OutermostSizeIds;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002195 for (auto Array : Arrays) {
2196 // To check if an array is a Fortran array, we check if it has a isl_pw_aff
2197 // for its outermost dimension. Fortran arrays will have this since the
2198 // outermost dimension size can be picked up from their runtime description.
2199 // TODO: actually need to check if it has a FAD, but for now this works.
2200 if (Array->getNumberOfDimensions() > 0) {
Tobias Grosserb5563c62017-08-03 13:51:15 +00002201 isl::pw_aff PwAff = Array->getDimensionSizePw(0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002202 if (!PwAff)
2203 continue;
2204
Tobias Grosserb5563c62017-08-03 13:51:15 +00002205 isl::id Id =
2206 isl::manage(isl_pw_aff_get_dim_id(PwAff.get(), isl_dim_param, 0));
2207 assert(!Id.is_null() &&
2208 "Invalid Id for PwAff expression in Fortran array");
2209 Id.dump();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002210 OutermostSizeIds.push_back(Id);
2211 }
2212 }
Tobias Grosserb5563c62017-08-03 13:51:15 +00002213 return OutermostSizeIds;
2214}
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002215
Tobias Grosserb5563c62017-08-03 13:51:15 +00002216// The FORTRAN array size parameters are known to be non-negative.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002217static isl::set boundFortranArrayParams(isl::set Context,
Tobias Grosserb5563c62017-08-03 13:51:15 +00002218 Scop::array_range Arrays) {
2219 std::vector<isl::id> OutermostSizeIds;
2220 OutermostSizeIds = getFortranArrayIds(Arrays);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002221
Tobias Grosserb5563c62017-08-03 13:51:15 +00002222 for (isl::id Id : OutermostSizeIds) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002223 int dim = Context.find_dim_by_id(isl::dim::param, Id);
2224 Context = Context.lower_bound_si(isl::dim::param, dim, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002225 }
2226
2227 return Context;
2228}
2229
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002230void Scop::realignParams() {
Tobias Grosser5842dee2017-03-17 13:00:53 +00002231 if (PollyIgnoreParamBounds)
2232 return;
2233
Tobias Grosser6be480c2011-11-08 15:41:13 +00002234 // Add all parameters into a common model.
Tobias Grosserb5563c62017-08-03 13:51:15 +00002235 isl::space Space = getFullParamSpace();
Tobias Grosser6be480c2011-11-08 15:41:13 +00002236
2237 // Align the parameters of all data structures to the model.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002238 Context = Context.align_params(Space);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002239
Tobias Grosserb5563c62017-08-03 13:51:15 +00002240 // Bound the size of the fortran array dimensions.
2241 Context = boundFortranArrayParams(Context, arrays());
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002242
Johannes Doerferta60ad842016-05-10 12:18:22 +00002243 // As all parameters are known add bounds to them.
2244 addParameterBounds();
2245
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002246 for (ScopStmt &Stmt : *this)
2247 Stmt.realignParams();
Johannes Doerfert06445ded2016-06-02 15:07:41 +00002248 // Simplify the schedule according to the context too.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002249 Schedule = Schedule.gist_domain_params(getContext());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002250}
2251
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002252static isl::set simplifyAssumptionContext(isl::set AssumptionContext,
2253 const Scop &S) {
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002254 // If we have modeled all blocks in the SCoP that have side effects we can
2255 // simplify the context with the constraints that are needed for anything to
2256 // be executed at all. However, if we have error blocks in the SCoP we already
2257 // assumed some parameter combinations cannot occur and removed them from the
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002258 // domains, thus we cannot use the remaining domain to simplify the
2259 // assumptions.
2260 if (!S.hasErrorBlock()) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002261 auto DomainParameters = S.getDomains().params();
2262 AssumptionContext = AssumptionContext.gist_params(DomainParameters);
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002263 }
2264
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002265 AssumptionContext = AssumptionContext.gist_params(S.getContext());
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002266 return AssumptionContext;
2267}
2268
2269void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002270 // The parameter constraints of the iteration domains give us a set of
2271 // constraints that need to hold for all cases where at least a single
2272 // statement iteration is executed in the whole scop. We now simplify the
2273 // assumed context under the assumption that such constraints hold and at
2274 // least a single statement iteration is executed. For cases where no
2275 // statement instances are executed, the assumptions we have taken about
2276 // the executed code do not matter and can be changed.
2277 //
2278 // WARNING: This only holds if the assumptions we have taken do not reduce
2279 // the set of statement instances that are executed. Otherwise we
2280 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002281 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002282 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002283 // performed. In such a case, modifying the run-time conditions and
2284 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002285 // to not be executed.
2286 //
2287 // Example:
2288 //
2289 // When delinearizing the following code:
2290 //
2291 // for (long i = 0; i < 100; i++)
2292 // for (long j = 0; j < m; j++)
2293 // A[i+p][j] = 1.0;
2294 //
2295 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002296 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002297 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002298 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002299 InvalidContext = InvalidContext.align_params(getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002300}
2301
Tobias Grosserc80d6972016-09-02 06:33:33 +00002302/// Add the minimal/maximal access in @p Set to @p User.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002303static isl::stat
2304buildMinMaxAccess(isl::set Set, Scop::MinMaxVectorTy &MinMaxAccesses, Scop &S) {
2305 isl::pw_multi_aff MinPMA, MaxPMA;
2306 isl::pw_aff LastDimAff;
2307 isl::aff OneAff;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002308 unsigned Pos;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002309 isl::ctx Ctx = Set.get_ctx();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002310
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002311 Set = Set.remove_divs();
Johannes Doerfert6296d952016-04-22 11:38:19 +00002312
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002313 if (isl_set_n_basic_set(Set.get()) >= MaxDisjunctsInDomain)
2314 return isl::stat::error;
Johannes Doerfert6296d952016-04-22 11:38:19 +00002315
Johannes Doerfert9143d672014-09-27 11:02:39 +00002316 // Restrict the number of parameters involved in the access as the lexmin/
2317 // lexmax computation will take too long if this number is high.
2318 //
2319 // Experiments with a simple test case using an i7 4800MQ:
2320 //
2321 // #Parameters involved | Time (in sec)
2322 // 6 | 0.01
2323 // 7 | 0.04
2324 // 8 | 0.12
2325 // 9 | 0.40
2326 // 10 | 1.54
2327 // 11 | 6.78
2328 // 12 | 30.38
2329 //
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002330 if (isl_set_n_param(Set.get()) > RunTimeChecksMaxParameters) {
Johannes Doerfert9143d672014-09-27 11:02:39 +00002331 unsigned InvolvedParams = 0;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002332 for (unsigned u = 0, e = isl_set_n_param(Set.get()); u < e; u++)
2333 if (Set.involves_dims(isl::dim::param, u, 1))
Johannes Doerfert9143d672014-09-27 11:02:39 +00002334 InvolvedParams++;
2335
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002336 if (InvolvedParams > RunTimeChecksMaxParameters)
2337 return isl::stat::error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002338 }
2339
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +00002340 if (isl_set_n_basic_set(Set.get()) > RunTimeChecksMaxAccessDisjuncts)
2341 return isl::stat::error;
2342
Tobias Grosser57a1d362017-06-23 08:05:27 +00002343 MinPMA = Set.lexmin_pw_multi_aff();
2344 MaxPMA = Set.lexmax_pw_multi_aff();
Tobias Grosser45e9fd12017-05-19 03:45:00 +00002345
Tobias Grosser57a1d362017-06-23 08:05:27 +00002346 if (isl_ctx_last_error(Ctx.get()) == isl_error_quota)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002347 return isl::stat::error;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002348
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002349 MinPMA = MinPMA.coalesce();
2350 MaxPMA = MaxPMA.coalesce();
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002351
Johannes Doerfertb164c792014-09-18 11:17:17 +00002352 // Adjust the last dimension of the maximal access by one as we want to
2353 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2354 // we test during code generation might now point after the end of the
2355 // allocated array but we will never dereference it anyway.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002356 assert(MaxPMA.dim(isl::dim::out) && "Assumed at least one output dimension");
2357 Pos = MaxPMA.dim(isl::dim::out) - 1;
2358 LastDimAff = MaxPMA.get_pw_aff(Pos);
2359 OneAff = isl::aff(isl::local_space(LastDimAff.get_domain_space()));
2360 OneAff = OneAff.add_constant_si(1);
2361 LastDimAff = LastDimAff.add(OneAff);
2362 MaxPMA = MaxPMA.set_pw_aff(Pos, LastDimAff);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002363
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002364 MinMaxAccesses.push_back(std::make_pair(MinPMA, MaxPMA));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002365
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002366 return isl::stat::ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002367}
2368
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002369static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
Tobias Grosserdcf8d692017-08-06 16:39:52 +00002370 isl_set *Domain = MA->getStatement()->getDomain().release();
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002371 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2372 return isl_set_reset_tuple_id(Domain);
2373}
2374
Tobias Grosserc80d6972016-09-02 06:33:33 +00002375/// Wrapper function to calculate minimal/maximal accesses to each array.
Tobias Grossere9522232017-01-16 15:49:04 +00002376static bool calculateMinMaxAccess(Scop::AliasGroupTy AliasGroup, Scop &S,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002377 Scop::MinMaxVectorTy &MinMaxAccesses) {
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002378 MinMaxAccesses.reserve(AliasGroup.size());
Tobias Grossere9522232017-01-16 15:49:04 +00002379
Tobias Grosser31df6f32017-08-06 21:42:25 +00002380 isl::union_set Domains = S.getDomains();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00002381 isl::union_map Accesses = isl::union_map::empty(S.getParamSpace());
Tobias Grossere9522232017-01-16 15:49:04 +00002382
2383 for (MemoryAccess *MA : AliasGroup)
Tobias Grosser1515f6b2017-07-23 04:08:38 +00002384 Accesses = Accesses.add_map(give(MA->getAccessRelation().release()));
Tobias Grossere9522232017-01-16 15:49:04 +00002385
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002386 Accesses = Accesses.intersect_domain(Domains);
2387 isl::union_set Locations = Accesses.range();
2388 Locations = Locations.coalesce();
2389 Locations = Locations.detect_equalities();
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002390
2391 auto Lambda = [&MinMaxAccesses, &S](isl::set Set) -> isl::stat {
2392 return buildMinMaxAccess(Set, MinMaxAccesses, S);
2393 };
2394 return Locations.foreach_set(Lambda) == isl::stat::ok;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002395}
2396
Tobias Grosserc80d6972016-09-02 06:33:33 +00002397/// Helper to treat non-affine regions and basic blocks the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002398///
2399///{
2400
Tobias Grosserc80d6972016-09-02 06:33:33 +00002401/// Return the block that is the representing block for @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002402static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2403 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2404 : RN->getNodeAs<BasicBlock>();
2405}
2406
Tobias Grosserc80d6972016-09-02 06:33:33 +00002407/// Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002408static inline BasicBlock *
2409getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002410 if (RN->isSubRegion()) {
2411 assert(idx == 0);
2412 return RN->getNodeAs<Region>()->getExit();
2413 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002414 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002415}
2416
Tobias Grosserc80d6972016-09-02 06:33:33 +00002417/// Return the smallest loop surrounding @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002418static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002419 if (!RN->isSubRegion()) {
2420 BasicBlock *BB = RN->getNodeAs<BasicBlock>();
2421 Loop *L = LI.getLoopFor(BB);
2422
2423 // Unreachable statements are not considered to belong to a LLVM loop, as
2424 // they are not part of an actual loop in the control flow graph.
2425 // Nevertheless, we handle certain unreachable statements that are common
2426 // when modeling run-time bounds checks as being part of the loop to be
2427 // able to model them and to later eliminate the run-time bounds checks.
2428 //
2429 // Specifically, for basic blocks that terminate in an unreachable and
Michael Krusea6d48f52017-06-08 12:06:15 +00002430 // where the immediate predecessor is part of a loop, we assume these
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002431 // basic blocks belong to the loop the predecessor belongs to. This
2432 // allows us to model the following code.
2433 //
2434 // for (i = 0; i < N; i++) {
2435 // if (i > 1024)
2436 // abort(); <- this abort might be translated to an
2437 // unreachable
2438 //
2439 // A[i] = ...
2440 // }
2441 if (!L && isa<UnreachableInst>(BB->getTerminator()) && BB->getPrevNode())
2442 L = LI.getLoopFor(BB->getPrevNode());
2443 return L;
2444 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002445
2446 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2447 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2448 while (L && NonAffineSubRegion->contains(L))
2449 L = L->getParentLoop();
2450 return L;
2451}
2452
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002453/// Get the number of blocks in @p L.
2454///
2455/// The number of blocks in a loop are the number of basic blocks actually
2456/// belonging to the loop, as well as all single basic blocks that the loop
2457/// exits to and which terminate in an unreachable instruction. We do not
2458/// allow such basic blocks in the exit of a scop, hence they belong to the
2459/// scop and represent run-time conditions which we want to model and
2460/// subsequently speculate away.
2461///
2462/// @see getRegionNodeLoop for additional details.
Reid Klecknerdf2b2832017-06-19 17:44:02 +00002463unsigned getNumBlocksInLoop(Loop *L) {
2464 unsigned NumBlocks = L->getNumBlocks();
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002465 SmallVector<BasicBlock *, 4> ExitBlocks;
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002466 L->getExitBlocks(ExitBlocks);
2467
2468 for (auto ExitBlock : ExitBlocks) {
2469 if (isa<UnreachableInst>(ExitBlock->getTerminator()))
2470 NumBlocks++;
2471 }
2472 return NumBlocks;
2473}
2474
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002475static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2476 if (!RN->isSubRegion())
2477 return 1;
2478
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002479 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002480 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002481}
2482
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002483static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2484 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002485 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002486 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002487 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002488 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002489 return true;
2490 return false;
2491}
2492
Johannes Doerfert96425c22015-08-30 21:13:53 +00002493///}
2494
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002495isl::set Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002496 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002497}
2498
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002499isl::set Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002500 auto DIt = DomainMap.find(BB);
2501 if (DIt != DomainMap.end())
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002502 return DIt->getSecond();
Johannes Doerfert41cda152016-04-08 10:32:26 +00002503
2504 auto &RI = *R.getRegionInfo();
2505 auto *BBR = RI.getRegionFor(BB);
2506 while (BBR->getEntry() == BB)
2507 BBR = BBR->getParent();
2508 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002509}
2510
Tobias Grosser13acbb92017-07-15 09:01:31 +00002511bool Scop::buildDomains(Region *R, DominatorTree &DT, LoopInfo &LI,
2512 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002513 bool IsOnlyNonAffineRegion = isNonAffineSubRegion(R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002514 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002515 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2516 int LD = getRelativeLoopDepth(L);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002517 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx().get(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002518
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002519 while (LD-- >= 0) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002520 L = L->getParentLoop();
2521 }
2522
Tobias Grosser13acbb92017-07-15 09:01:31 +00002523 InvalidDomainMap[EntryBB] = isl::manage(isl_set_empty(isl_set_get_space(S)));
Tobias Grosser325204a32017-07-15 12:41:32 +00002524 DomainMap[EntryBB] = isl::manage(S);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002525
Johannes Doerfert432658d2016-01-26 11:01:41 +00002526 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002527 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002528
Michael Kruse476f8552017-06-29 12:47:41 +00002529 if (!buildDomainsWithBranchConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002530 return false;
2531
Michael Kruse476f8552017-06-29 12:47:41 +00002532 if (!propagateDomainConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002533 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002534
2535 // Error blocks and blocks dominated by them have been assumed to never be
2536 // executed. Representing them in the Scop does not add any value. In fact,
2537 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002538 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002539 // will cause problems when building up a ScopStmt for them.
2540 // Furthermore, basic blocks dominated by error blocks may reference
2541 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002542 // can themselves not be constructed properly. To this end we will replace
2543 // the domains of error blocks and those only reachable via error blocks
2544 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002545 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002546 // InvalidDomain. This information is needed during load hoisting.
Michael Kruse476f8552017-06-29 12:47:41 +00002547 if (!propagateInvalidStmtDomains(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002548 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002549
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002550 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002551}
2552
Tobias Grosserc80d6972016-09-02 06:33:33 +00002553/// Adjust the dimensions of @p Dom that was constructed for @p OldL
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002554/// to be compatible to domains constructed for loop @p NewL.
2555///
2556/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2557/// edge from @p OldL to @p NewL.
2558static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2559 __isl_take isl_set *Dom,
2560 Loop *OldL, Loop *NewL) {
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002561 // If the loops are the same there is nothing to do.
2562 if (NewL == OldL)
2563 return Dom;
2564
2565 int OldDepth = S.getRelativeLoopDepth(OldL);
2566 int NewDepth = S.getRelativeLoopDepth(NewL);
2567 // If both loops are non-affine loops there is nothing to do.
2568 if (OldDepth == -1 && NewDepth == -1)
2569 return Dom;
2570
2571 // Distinguish three cases:
2572 // 1) The depth is the same but the loops are not.
2573 // => One loop was left one was entered.
2574 // 2) The depth increased from OldL to NewL.
2575 // => One loop was entered, none was left.
2576 // 3) The depth decreased from OldL to NewL.
2577 // => Loops were left were difference of the depths defines how many.
2578 if (OldDepth == NewDepth) {
2579 assert(OldL->getParentLoop() == NewL->getParentLoop());
2580 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2581 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002582 } else if (OldDepth < NewDepth) {
2583 assert(OldDepth + 1 == NewDepth);
2584 auto &R = S.getRegion();
2585 (void)R;
2586 assert(NewL->getParentLoop() == OldL ||
2587 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2588 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002589 } else {
2590 assert(OldDepth > NewDepth);
2591 int Diff = OldDepth - NewDepth;
2592 int NumDim = isl_set_n_dim(Dom);
2593 assert(NumDim >= Diff);
2594 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2595 }
2596
2597 return Dom;
2598}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002599
Michael Kruse476f8552017-06-29 12:47:41 +00002600bool Scop::propagateInvalidStmtDomains(
2601 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002602 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002603 ReversePostOrderTraversal<Region *> RTraversal(R);
2604 for (auto *RN : RTraversal) {
2605
2606 // Recurse for affine subregions but go on for basic blocks and non-affine
2607 // subregions.
2608 if (RN->isSubRegion()) {
2609 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002610 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002611 propagateInvalidStmtDomains(SubRegion, DT, LI, InvalidDomainMap);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002612 continue;
2613 }
2614 }
2615
2616 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2617 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002618 isl::set &Domain = DomainMap[BB];
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002619 assert(Domain && "Cannot propagate a nullptr");
2620
Tobias Grosser325204a32017-07-15 12:41:32 +00002621 isl::set InvalidDomain = InvalidDomainMap[BB];
Michael Kruse476f8552017-06-29 12:47:41 +00002622
Tobias Grosser325204a32017-07-15 12:41:32 +00002623 bool IsInvalidBlock = ContainsErrorBlock || Domain.is_subset(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002624
Johannes Doerferta3519512016-04-23 13:02:23 +00002625 if (!IsInvalidBlock) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002626 InvalidDomain = InvalidDomain.intersect(Domain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002627 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002628 InvalidDomain = Domain;
Tobias Grosser325204a32017-07-15 12:41:32 +00002629 isl::set DomPar = Domain.params();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00002630 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2631 AS_RESTRICTION);
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002632 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002633 }
2634
Tobias Grosser325204a32017-07-15 12:41:32 +00002635 if (InvalidDomain.is_empty()) {
2636 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002637 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002638 }
2639
Johannes Doerferta3519512016-04-23 13:02:23 +00002640 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002641 auto *TI = BB->getTerminator();
2642 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2643 for (unsigned u = 0; u < NumSuccs; u++) {
2644 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002645
2646 // Skip successors outside the SCoP.
Michael Kruse476f8552017-06-29 12:47:41 +00002647 if (!contains(SuccBB))
Johannes Doerfert7c013572016-04-12 09:57:34 +00002648 continue;
2649
Johannes Doerferte4459a22016-04-25 13:34:50 +00002650 // Skip backedges.
2651 if (DT.dominates(SuccBB, BB))
2652 continue;
2653
Michael Kruse476f8552017-06-29 12:47:41 +00002654 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2655
Johannes Doerferta3519512016-04-23 13:02:23 +00002656 auto *AdjustedInvalidDomain = adjustDomainDimensions(
Tobias Grosser325204a32017-07-15 12:41:32 +00002657 *this, InvalidDomain.copy(), BBLoop, SuccBBLoop);
Michael Kruse476f8552017-06-29 12:47:41 +00002658
Tobias Grosser13acbb92017-07-15 09:01:31 +00002659 auto *SuccInvalidDomain = InvalidDomainMap[SuccBB].copy();
Johannes Doerferta3519512016-04-23 13:02:23 +00002660 SuccInvalidDomain =
2661 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2662 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2663 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
Michael Kruse476f8552017-06-29 12:47:41 +00002664
Tobias Grosser13acbb92017-07-15 09:01:31 +00002665 InvalidDomainMap[SuccBB] = isl::manage(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002666
Michael Krusebc150122016-05-02 12:25:18 +00002667 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002668 // In case this happens we will bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00002669 if (NumConjucts < MaxDisjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002670 continue;
2671
Tobias Grosserf44f0052017-07-09 15:47:17 +00002672 InvalidDomainMap.erase(BB);
Eli Friedmane737fc12017-07-17 23:58:33 +00002673 invalidate(COMPLEXITY, TI->getDebugLoc(), TI->getParent());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002674 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002675 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002676
Tobias Grosser325204a32017-07-15 12:41:32 +00002677 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002678 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002679
2680 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002681}
2682
Johannes Doerfert642594a2016-04-04 07:57:39 +00002683void Scop::propagateDomainConstraintsToRegionExit(
2684 BasicBlock *BB, Loop *BBLoop,
Michael Kruse476f8552017-06-29 12:47:41 +00002685 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002686 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002687 // Check if the block @p BB is the entry of a region. If so we propagate it's
2688 // domain to the exit block of the region. Otherwise we are done.
2689 auto *RI = R.getRegionInfo();
2690 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2691 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002692 if (!BBReg || BBReg->getEntry() != BB || !contains(ExitBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002693 return;
2694
Johannes Doerfert642594a2016-04-04 07:57:39 +00002695 // Do not propagate the domain if there is a loop backedge inside the region
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002696 // that would prevent the exit block from being executed.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002697 auto *L = BBLoop;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002698 while (L && contains(L)) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002699 SmallVector<BasicBlock *, 4> LatchBBs;
2700 BBLoop->getLoopLatches(LatchBBs);
2701 for (auto *LatchBB : LatchBBs)
2702 if (BB != LatchBB && BBReg->contains(LatchBB))
2703 return;
2704 L = L->getParentLoop();
2705 }
2706
Tobias Grosser325204a32017-07-15 12:41:32 +00002707 isl::set Domain = DomainMap[BB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002708 assert(Domain && "Cannot propagate a nullptr");
2709
Michael Kruse476f8552017-06-29 12:47:41 +00002710 Loop *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002711
2712 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2713 // adjust the domain before we can propagate it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002714 isl::set AdjustedDomain = isl::manage(
2715 adjustDomainDimensions(*this, Domain.copy(), BBLoop, ExitBBLoop));
2716 isl::set &ExitDomain = DomainMap[ExitBB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002717
2718 // If the exit domain is not yet created we set it otherwise we "add" the
2719 // current domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002720 ExitDomain = ExitDomain ? AdjustedDomain.unite(ExitDomain) : AdjustedDomain;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002721
Johannes Doerferta3519512016-04-23 13:02:23 +00002722 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002723 InvalidDomainMap[ExitBB] = ExitDomain.empty(ExitDomain.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002724
Johannes Doerfert642594a2016-04-04 07:57:39 +00002725 FinishedExitBlocks.insert(ExitBB);
2726}
2727
Michael Kruse476f8552017-06-29 12:47:41 +00002728bool Scop::buildDomainsWithBranchConstraints(
2729 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002730 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002731 // To create the domain for each block in R we iterate over all blocks and
2732 // subregions in R and propagate the conditions under which the current region
2733 // element is executed. To this end we iterate in reverse post order over R as
2734 // it ensures that we first visit all predecessors of a region node (either a
2735 // basic block or a subregion) before we visit the region node itself.
2736 // Initially, only the domain for the SCoP region entry block is set and from
2737 // there we propagate the current domain to all successors, however we add the
2738 // condition that the successor is actually executed next.
2739 // As we are only interested in non-loop carried constraints here we can
2740 // simply skip loop back edges.
2741
Johannes Doerfert642594a2016-04-04 07:57:39 +00002742 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002743 ReversePostOrderTraversal<Region *> RTraversal(R);
2744 for (auto *RN : RTraversal) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002745 // Recurse for affine subregions but go on for basic blocks and non-affine
2746 // subregions.
2747 if (RN->isSubRegion()) {
2748 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002749 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002750 if (!buildDomainsWithBranchConstraints(SubRegion, DT, LI,
2751 InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002752 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002753 continue;
2754 }
2755 }
2756
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002757 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002758 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002759
Johannes Doerfert96425c22015-08-30 21:13:53 +00002760 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002761 TerminatorInst *TI = BB->getTerminator();
2762
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002763 if (isa<UnreachableInst>(TI))
2764 continue;
2765
Tobias Grosser325204a32017-07-15 12:41:32 +00002766 isl::set Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002767 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002768 continue;
Tobias Grosser325204a32017-07-15 12:41:32 +00002769 MaxLoopDepth = std::max(MaxLoopDepth, isl_set_n_dim(Domain.get()));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002770
Johannes Doerfert642594a2016-04-04 07:57:39 +00002771 auto *BBLoop = getRegionNodeLoop(RN, LI);
2772 // Propagate the domain from BB directly to blocks that have a superset
2773 // domain, at the moment only region exit nodes of regions that start in BB.
Michael Kruse476f8552017-06-29 12:47:41 +00002774 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, LI,
2775 InvalidDomainMap);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002776
2777 // If all successors of BB have been set a domain through the propagation
2778 // above we do not need to build condition sets but can just skip this
2779 // block. However, it is important to note that this is a local property
2780 // with regards to the region @p R. To this end FinishedExitBlocks is a
2781 // local variable.
2782 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2783 return FinishedExitBlocks.count(SuccBB);
2784 };
2785 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2786 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002787
2788 // Build the condition sets for the successor nodes of the current region
2789 // node. If it is a non-affine subregion we will always execute the single
2790 // exit node, hence the single entry node domain is the condition set. For
2791 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002792 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002793 if (RN->isSubRegion())
Tobias Grosser325204a32017-07-15 12:41:32 +00002794 ConditionSets.push_back(Domain.copy());
2795 else if (!buildConditionSets(*this, BB, TI, BBLoop, Domain.get(),
Michael Kruse476f8552017-06-29 12:47:41 +00002796 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002797 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002798
2799 // Now iterate over the successors and set their initial domain based on
2800 // their condition set. We skip back edges here and have to be careful when
2801 // we leave a loop not to keep constraints over a dimension that doesn't
2802 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002803 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002804 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002805 isl::set CondSet = isl::manage(ConditionSets[u]);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002806 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002807
Johannes Doerfert535de032016-04-19 14:49:05 +00002808 // Skip blocks outside the region.
Tobias Grosser325204a32017-07-15 12:41:32 +00002809 if (!contains(SuccBB))
Johannes Doerfert535de032016-04-19 14:49:05 +00002810 continue;
Johannes Doerfert535de032016-04-19 14:49:05 +00002811
Johannes Doerfert642594a2016-04-04 07:57:39 +00002812 // If we propagate the domain of some block to "SuccBB" we do not have to
2813 // adjust the domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002814 if (FinishedExitBlocks.count(SuccBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002815 continue;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002816
Johannes Doerfert96425c22015-08-30 21:13:53 +00002817 // Skip back edges.
Tobias Grosser325204a32017-07-15 12:41:32 +00002818 if (DT.dominates(SuccBB, BB))
Johannes Doerfert96425c22015-08-30 21:13:53 +00002819 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002820
Michael Kruse476f8552017-06-29 12:47:41 +00002821 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2822
Tobias Grosser325204a32017-07-15 12:41:32 +00002823 CondSet = isl::manage(
2824 adjustDomainDimensions(*this, CondSet.copy(), BBLoop, SuccBBLoop));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002825
2826 // Set the domain for the successor or merge it with an existing domain in
2827 // case there are multiple paths (without loop back edges) to the
2828 // successor block.
Tobias Grosser325204a32017-07-15 12:41:32 +00002829 isl::set &SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002830
Johannes Doerferta3519512016-04-23 13:02:23 +00002831 if (SuccDomain) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002832 SuccDomain = SuccDomain.unite(CondSet).coalesce();
Johannes Doerferta3519512016-04-23 13:02:23 +00002833 } else {
2834 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002835 InvalidDomainMap[SuccBB] = CondSet.empty(CondSet.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002836 SuccDomain = CondSet;
2837 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002838
Tobias Grosser325204a32017-07-15 12:41:32 +00002839 SuccDomain = SuccDomain.detect_equalities();
Tobias Grosser6d459c52017-05-23 04:26:28 +00002840
Michael Krusebc150122016-05-02 12:25:18 +00002841 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002842 // In case this happens we will clean up and bail.
Tobias Grosser325204a32017-07-15 12:41:32 +00002843 if (isl_set_n_basic_set(SuccDomain.get()) < MaxDisjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002844 continue;
2845
2846 invalidate(COMPLEXITY, DebugLoc());
2847 while (++u < ConditionSets.size())
2848 isl_set_free(ConditionSets[u]);
2849 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002850 }
2851 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002852
2853 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002854}
2855
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002856isl::set Scop::getPredecessorDomainConstraints(BasicBlock *BB, isl::set Domain,
2857 DominatorTree &DT,
2858 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002859 // If @p BB is the ScopEntry we are done
2860 if (R.getEntry() == BB)
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002861 return isl::set::universe(Domain.get_space());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002862
Johannes Doerfert642594a2016-04-04 07:57:39 +00002863 // The region info of this function.
2864 auto &RI = *R.getRegionInfo();
2865
Michael Kruse476f8552017-06-29 12:47:41 +00002866 Loop *BBLoop = getFirstNonBoxedLoopFor(BB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002867
2868 // A domain to collect all predecessor domains, thus all conditions under
2869 // which the block is executed. To this end we start with the empty domain.
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002870 isl::set PredDom = isl::set::empty(Domain.get_space());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002871
2872 // Set of regions of which the entry block domain has been propagated to BB.
2873 // all predecessors inside any of the regions can be skipped.
2874 SmallSet<Region *, 8> PropagatedRegions;
2875
2876 for (auto *PredBB : predecessors(BB)) {
2877 // Skip backedges.
2878 if (DT.dominates(BB, PredBB))
2879 continue;
2880
2881 // If the predecessor is in a region we used for propagation we can skip it.
2882 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2883 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2884 PredBBInRegion)) {
2885 continue;
2886 }
2887
2888 // Check if there is a valid region we can use for propagation, thus look
2889 // for a region that contains the predecessor and has @p BB as exit block.
2890 auto *PredR = RI.getRegionFor(PredBB);
2891 while (PredR->getExit() != BB && !PredR->contains(BB))
2892 PredR->getParent();
2893
2894 // If a valid region for propagation was found use the entry of that region
2895 // for propagation, otherwise the PredBB directly.
2896 if (PredR->getExit() == BB) {
2897 PredBB = PredR->getEntry();
2898 PropagatedRegions.insert(PredR);
2899 }
2900
Tobias Grosser61bd3a42017-08-06 21:42:38 +00002901 auto *PredBBDom = getDomainConditions(PredBB).release();
Michael Kruse476f8552017-06-29 12:47:41 +00002902 Loop *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, getBoxedLoops());
2903
Johannes Doerfert642594a2016-04-04 07:57:39 +00002904 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2905
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002906 PredDom = PredDom.unite(isl::manage(PredBBDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002907 }
2908
2909 return PredDom;
2910}
2911
Michael Kruse476f8552017-06-29 12:47:41 +00002912bool Scop::propagateDomainConstraints(
2913 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002914 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002915 // Iterate over the region R and propagate the domain constrains from the
2916 // predecessors to the current node. In contrast to the
2917 // buildDomainsWithBranchConstraints function, this one will pull the domain
2918 // information from the predecessors instead of pushing it to the successors.
2919 // Additionally, we assume the domains to be already present in the domain
2920 // map here. However, we iterate again in reverse post order so we know all
2921 // predecessors have been visited before a block or non-affine subregion is
2922 // visited.
2923
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002924 ReversePostOrderTraversal<Region *> RTraversal(R);
2925 for (auto *RN : RTraversal) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002926 // Recurse for affine subregions but go on for basic blocks and non-affine
2927 // subregions.
2928 if (RN->isSubRegion()) {
2929 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002930 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002931 if (!propagateDomainConstraints(SubRegion, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002932 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002933 continue;
2934 }
2935 }
2936
2937 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002938 isl::set &Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002939 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002940
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002941 // Under the union of all predecessor conditions we can reach this block.
Tobias Grosser2f3041f2017-08-06 17:31:38 +00002942 isl::set PredDom = getPredecessorDomainConstraints(BB, Domain, DT, LI);
Tobias Grosser325204a32017-07-15 12:41:32 +00002943 Domain = Domain.intersect(PredDom).coalesce();
Tobias Grosserb65ccc42017-08-06 20:11:59 +00002944 Domain = Domain.align_params(getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002945
Johannes Doerfert642594a2016-04-04 07:57:39 +00002946 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00002947 if (BBLoop && BBLoop->getHeader() == BB && contains(BBLoop))
Michael Kruse476f8552017-06-29 12:47:41 +00002948 if (!addLoopBoundsToHeaderDomain(BBLoop, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002949 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002950 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002951
2952 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002953}
2954
Tobias Grosserc80d6972016-09-02 06:33:33 +00002955/// Create a map to map from a given iteration to a subsequent iteration.
2956///
2957/// This map maps from SetSpace -> SetSpace where the dimensions @p Dim
2958/// is incremented by one and all other dimensions are equal, e.g.,
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002959/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
Tobias Grosserc80d6972016-09-02 06:33:33 +00002960///
2961/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002962static __isl_give isl_map *
2963createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2964 auto *MapSpace = isl_space_map_from_set(SetSpace);
2965 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
Tobias Grosserf4fe34b2017-03-16 21:33:20 +00002966 for (unsigned u = 0; u < isl_map_dim(NextIterationMap, isl_dim_in); u++)
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002967 if (u != Dim)
2968 NextIterationMap =
2969 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2970 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2971 C = isl_constraint_set_constant_si(C, 1);
2972 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2973 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2974 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2975 return NextIterationMap;
2976}
2977
Michael Kruse476f8552017-06-29 12:47:41 +00002978bool Scop::addLoopBoundsToHeaderDomain(
Tobias Grosser13acbb92017-07-15 09:01:31 +00002979 Loop *L, LoopInfo &LI, DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002980 int LoopDepth = getRelativeLoopDepth(L);
2981 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002982
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002983 BasicBlock *HeaderBB = L->getHeader();
2984 assert(DomainMap.count(HeaderBB));
Tobias Grosser325204a32017-07-15 12:41:32 +00002985 isl::set &HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002986
Tobias Grosser325204a32017-07-15 12:41:32 +00002987 isl::map NextIterationMap = isl::manage(
2988 createNextIterationMap(HeaderBBDom.get_space().release(), LoopDepth));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002989
Tobias Grosser325204a32017-07-15 12:41:32 +00002990 isl::set UnionBackedgeCondition = HeaderBBDom.empty(HeaderBBDom.get_space());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002991
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00002992 SmallVector<BasicBlock *, 4> LatchBlocks;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002993 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002994
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002995 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002996 // If the latch is only reachable via error statements we skip it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002997 isl::set LatchBBDom = DomainMap.lookup(LatchBB);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002998 if (!LatchBBDom)
2999 continue;
3000
Tobias Grosser325204a32017-07-15 12:41:32 +00003001 isl::set BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003002
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003003 TerminatorInst *TI = LatchBB->getTerminator();
3004 BranchInst *BI = dyn_cast<BranchInst>(TI);
Tobias Grosserbbaeda32016-11-10 05:20:29 +00003005 assert(BI && "Only branch instructions allowed in loop latches");
3006
3007 if (BI->isUnconditional())
Tobias Grosser325204a32017-07-15 12:41:32 +00003008 BackedgeCondition = LatchBBDom;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003009 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003010 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003011 int idx = BI->getSuccessor(0) != HeaderBB;
Tobias Grosser325204a32017-07-15 12:41:32 +00003012 if (!buildConditionSets(*this, LatchBB, TI, L, LatchBBDom.get(),
3013 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003014 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003015
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003016 // Free the non back edge condition set as we do not need it.
3017 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003018
Tobias Grosser325204a32017-07-15 12:41:32 +00003019 BackedgeCondition = isl::manage(ConditionSets[idx]);
Johannes Doerfert06c57b52015-09-20 15:00:20 +00003020 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003021
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003022 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
3023 assert(LatchLoopDepth >= LoopDepth);
Tobias Grosser325204a32017-07-15 12:41:32 +00003024 BackedgeCondition = BackedgeCondition.project_out(
3025 isl::dim::set, LoopDepth + 1, LatchLoopDepth - LoopDepth);
3026 UnionBackedgeCondition = UnionBackedgeCondition.unite(BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003027 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003028
Tobias Grosser325204a32017-07-15 12:41:32 +00003029 isl::map ForwardMap = ForwardMap.lex_le(HeaderBBDom.get_space());
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003030 for (int i = 0; i < LoopDepth; i++)
Tobias Grosser325204a32017-07-15 12:41:32 +00003031 ForwardMap = ForwardMap.equate(isl::dim::in, i, isl::dim::out, i);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003032
Tobias Grosser325204a32017-07-15 12:41:32 +00003033 isl::set UnionBackedgeConditionComplement =
3034 UnionBackedgeCondition.complement();
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003035 UnionBackedgeConditionComplement =
Tobias Grosser325204a32017-07-15 12:41:32 +00003036 UnionBackedgeConditionComplement.lower_bound_si(isl::dim::set, LoopDepth,
3037 0);
3038 UnionBackedgeConditionComplement =
3039 UnionBackedgeConditionComplement.apply(ForwardMap);
3040 HeaderBBDom = HeaderBBDom.subtract(UnionBackedgeConditionComplement);
3041 HeaderBBDom = HeaderBBDom.apply(NextIterationMap);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003042
Tobias Grosser325204a32017-07-15 12:41:32 +00003043 auto Parts = partitionSetParts(HeaderBBDom.copy(), LoopDepth);
3044 HeaderBBDom = isl::manage(Parts.second);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003045
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003046 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
3047 // the bounded assumptions to the context as they are already implied by the
3048 // <nsw> tag.
3049 if (Affinator.hasNSWAddRecForLoop(L)) {
3050 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003051 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003052 }
3053
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003054 isl::set UnboundedCtx = isl::manage(Parts.first).params();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003055 recordAssumption(INFINITELOOP, UnboundedCtx,
3056 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003057 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003058}
3059
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003060MemoryAccess *Scop::lookupBasePtrAccess(MemoryAccess *MA) {
Tobias Grosserbe372d52017-02-09 10:11:58 +00003061 Value *PointerBase = MA->getOriginalBaseAddr();
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003062
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003063 auto *PointerBaseInst = dyn_cast<Instruction>(PointerBase);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003064 if (!PointerBaseInst)
3065 return nullptr;
3066
3067 auto *BasePtrStmt = getStmtFor(PointerBaseInst);
3068 if (!BasePtrStmt)
3069 return nullptr;
3070
3071 return BasePtrStmt->getArrayAccessOrNULLFor(PointerBaseInst);
3072}
3073
3074bool Scop::hasNonHoistableBasePtrInScop(MemoryAccess *MA,
Tobias Grosser4071cb52017-06-06 23:13:02 +00003075 isl::union_map Writes) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003076 if (auto *BasePtrMA = lookupBasePtrAccess(MA)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003077 return getNonHoistableCtx(BasePtrMA, Writes).is_null();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003078 }
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003079
Tobias Grosserbe372d52017-02-09 10:11:58 +00003080 Value *BaseAddr = MA->getOriginalBaseAddr();
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003081 if (auto *BasePtrInst = dyn_cast<Instruction>(BaseAddr))
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003082 if (!isa<LoadInst>(BasePtrInst))
Johannes Doerfert952b5302016-05-23 12:40:48 +00003083 return contains(BasePtrInst);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003084
3085 return false;
3086}
3087
Johannes Doerfert5210da52016-06-02 11:06:54 +00003088bool Scop::buildAliasChecks(AliasAnalysis &AA) {
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003089 if (!PollyUseRuntimeAliasChecks)
Johannes Doerfert5210da52016-06-02 11:06:54 +00003090 return true;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003091
Johannes Doerfertcd195322016-11-17 21:41:08 +00003092 if (buildAliasGroups(AA)) {
3093 // Aliasing assumptions do not go through addAssumption but we still want to
3094 // collect statistics so we do it here explicitly.
3095 if (MinMaxAliasGroups.size())
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00003096 AssumptionsAliasing++;
Johannes Doerfert5210da52016-06-02 11:06:54 +00003097 return true;
Johannes Doerfertcd195322016-11-17 21:41:08 +00003098 }
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003099
3100 // If a problem occurs while building the alias groups we need to delete
3101 // this SCoP and pretend it wasn't valid in the first place. To this end
3102 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003103 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003104
3105 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
3106 << " could not be created as the number of parameters involved "
3107 "is too high. The SCoP will be "
3108 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
3109 "the maximal number of parameters but be advised that the "
3110 "compile time might increase exponentially.\n\n");
Johannes Doerfert5210da52016-06-02 11:06:54 +00003111 return false;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003112}
3113
Tobias Grosser889830b2017-02-09 23:12:22 +00003114std::tuple<Scop::AliasGroupVectorTy, DenseSet<const ScopArrayInfo *>>
Tobias Grosser9edcf072017-01-16 14:07:57 +00003115Scop::buildAliasGroupsForAccesses(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003116 AliasSetTracker AST(AA);
3117
3118 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Tobias Grosser889830b2017-02-09 23:12:22 +00003119 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003120 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003121
Tobias Grosserdcf8d692017-08-06 16:39:52 +00003122 isl_set *StmtDomain = Stmt.getDomain().release();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003123 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
3124 isl_set_free(StmtDomain);
Tobias Grosser9edcf072017-01-16 14:07:57 +00003125
3126 // Statements with an empty domain will never be executed.
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003127 if (StmtDomainEmpty)
3128 continue;
3129
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003130 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00003131 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003132 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00003133 if (!MA->isRead())
Tobias Grosser889830b2017-02-09 23:12:22 +00003134 HasWriteAccess.insert(MA->getScopArrayInfo());
Michael Kruse70131d32016-01-27 17:09:17 +00003135 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003136 if (MA->isRead() && isa<MemTransferInst>(Acc))
Michael Kruse426e6f72016-10-25 13:37:43 +00003137 PtrToAcc[cast<MemTransferInst>(Acc)->getRawSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00003138 else
3139 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003140 AST.add(Acc);
3141 }
3142 }
3143
Tobias Grosser9edcf072017-01-16 14:07:57 +00003144 AliasGroupVectorTy AliasGroups;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003145 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00003146 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003147 continue;
3148 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00003149 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00003150 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003151 if (AG.size() < 2)
3152 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003153 AliasGroups.push_back(std::move(AG));
3154 }
3155
Tobias Grosser9edcf072017-01-16 14:07:57 +00003156 return std::make_tuple(AliasGroups, HasWriteAccess);
3157}
3158
Tobias Grossere39f9122017-01-16 14:08:00 +00003159void Scop::splitAliasGroupsByDomain(AliasGroupVectorTy &AliasGroups) {
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003160 for (unsigned u = 0; u < AliasGroups.size(); u++) {
3161 AliasGroupTy NewAG;
3162 AliasGroupTy &AG = AliasGroups[u];
3163 AliasGroupTy::iterator AGI = AG.begin();
3164 isl_set *AGDomain = getAccessDomain(*AGI);
3165 while (AGI != AG.end()) {
3166 MemoryAccess *MA = *AGI;
3167 isl_set *MADomain = getAccessDomain(MA);
3168 if (isl_set_is_disjoint(AGDomain, MADomain)) {
3169 NewAG.push_back(MA);
3170 AGI = AG.erase(AGI);
3171 isl_set_free(MADomain);
3172 } else {
3173 AGDomain = isl_set_union(AGDomain, MADomain);
3174 AGI++;
3175 }
3176 }
3177 if (NewAG.size() > 1)
3178 AliasGroups.push_back(std::move(NewAG));
3179 isl_set_free(AGDomain);
3180 }
Tobias Grossere39f9122017-01-16 14:08:00 +00003181}
3182
3183bool Scop::buildAliasGroups(AliasAnalysis &AA) {
3184 // To create sound alias checks we perform the following steps:
3185 // o) We partition each group into read only and non read only accesses.
3186 // o) For each group with more than one base pointer we then compute minimal
3187 // and maximal accesses to each array of a group in read only and non
3188 // read only partitions separately.
3189 AliasGroupVectorTy AliasGroups;
Tobias Grosser889830b2017-02-09 23:12:22 +00003190 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grossere39f9122017-01-16 14:08:00 +00003191
3192 std::tie(AliasGroups, HasWriteAccess) = buildAliasGroupsForAccesses(AA);
3193
3194 splitAliasGroupsByDomain(AliasGroups);
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003195
Johannes Doerfert13771732014-10-01 12:40:46 +00003196 for (AliasGroupTy &AG : AliasGroups) {
Tobias Grosser78a7a6c2017-06-23 08:05:31 +00003197 if (!hasFeasibleRuntimeContext())
3198 return false;
3199
Tobias Grosser57a1d362017-06-23 08:05:27 +00003200 {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003201 IslMaxOperationsGuard MaxOpGuard(getIslCtx().get(), OptComputeOut);
Tobias Grosser57a1d362017-06-23 08:05:27 +00003202 bool Valid = buildAliasGroup(AG, HasWriteAccess);
3203 if (!Valid)
3204 return false;
3205 }
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003206 if (isl_ctx_last_error(getIslCtx().get()) == isl_error_quota) {
Tobias Grosser57a1d362017-06-23 08:05:27 +00003207 invalidate(COMPLEXITY, DebugLoc());
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003208 return false;
Tobias Grosser57a1d362017-06-23 08:05:27 +00003209 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003210 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003211
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003212 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003213}
3214
Tobias Grosser77f32572017-01-16 15:49:07 +00003215bool Scop::buildAliasGroup(Scop::AliasGroupTy &AliasGroup,
Tobias Grosser889830b2017-02-09 23:12:22 +00003216 DenseSet<const ScopArrayInfo *> HasWriteAccess) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003217 AliasGroupTy ReadOnlyAccesses;
3218 AliasGroupTy ReadWriteAccesses;
Tobias Grosser889830b2017-02-09 23:12:22 +00003219 SmallPtrSet<const ScopArrayInfo *, 4> ReadWriteArrays;
Tobias Grosser079d5112017-02-18 20:51:29 +00003220 SmallPtrSet<const ScopArrayInfo *, 4> ReadOnlyArrays;
Tobias Grosser77f32572017-01-16 15:49:07 +00003221
Tobias Grosser77f32572017-01-16 15:49:07 +00003222 if (AliasGroup.size() < 2)
3223 return true;
3224
3225 for (MemoryAccess *Access : AliasGroup) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003226 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "PossibleAlias",
3227 Access->getAccessInstruction())
3228 << "Possibly aliasing pointer, use restrict keyword.");
Tobias Grosser889830b2017-02-09 23:12:22 +00003229 const ScopArrayInfo *Array = Access->getScopArrayInfo();
3230 if (HasWriteAccess.count(Array)) {
3231 ReadWriteArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003232 ReadWriteAccesses.push_back(Access);
3233 } else {
Tobias Grosser079d5112017-02-18 20:51:29 +00003234 ReadOnlyArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003235 ReadOnlyAccesses.push_back(Access);
3236 }
3237 }
3238
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003239 // If there are no read-only pointers, and less than two read-write pointers,
3240 // no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003241 if (ReadOnlyAccesses.empty() && ReadWriteArrays.size() <= 1)
Tobias Grosser77f32572017-01-16 15:49:07 +00003242 return true;
3243
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003244 // If there is no read-write pointer, no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003245 if (ReadWriteArrays.empty())
Tobias Grosser77f32572017-01-16 15:49:07 +00003246 return true;
3247
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003248 // For non-affine accesses, no alias check can be generated as we cannot
3249 // compute a sufficiently tight lower and upper bound: bail out.
Tobias Grosser77f32572017-01-16 15:49:07 +00003250 for (MemoryAccess *MA : AliasGroup) {
3251 if (!MA->isAffine()) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003252 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc(),
3253 MA->getAccessInstruction()->getParent());
Tobias Grosser77f32572017-01-16 15:49:07 +00003254 return false;
3255 }
Tobias Grosser0032d872017-01-16 15:49:14 +00003256 }
3257
3258 // Ensure that for all memory accesses for which we generate alias checks,
3259 // their base pointers are available.
3260 for (MemoryAccess *MA : AliasGroup) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003261 if (MemoryAccess *BasePtrMA = lookupBasePtrAccess(MA))
3262 addRequiredInvariantLoad(
3263 cast<LoadInst>(BasePtrMA->getAccessInstruction()));
3264 }
3265
3266 MinMaxAliasGroups.emplace_back();
3267 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3268 MinMaxVectorTy &MinMaxAccessesReadWrite = pair.first;
3269 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3270
3271 bool Valid;
3272
3273 Valid =
3274 calculateMinMaxAccess(ReadWriteAccesses, *this, MinMaxAccessesReadWrite);
3275
3276 if (!Valid)
3277 return false;
3278
3279 // Bail out if the number of values we need to compare is too large.
3280 // This is important as the number of comparisons grows quadratically with
3281 // the number of values we need to compare.
Tobias Grosser079d5112017-02-18 20:51:29 +00003282 if (MinMaxAccessesReadWrite.size() + ReadOnlyArrays.size() >
Tobias Grosser77f32572017-01-16 15:49:07 +00003283 RunTimeChecksMaxArraysPerGroup)
3284 return false;
3285
3286 Valid =
3287 calculateMinMaxAccess(ReadOnlyAccesses, *this, MinMaxAccessesReadOnly);
3288
3289 if (!Valid)
3290 return false;
3291
3292 return true;
3293}
3294
Tobias Grosserc80d6972016-09-02 06:33:33 +00003295/// Get the smallest loop that contains @p S but is not in @p S.
Johannes Doerfertef744432016-05-23 12:42:38 +00003296static Loop *getLoopSurroundingScop(Scop &S, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003297 // Start with the smallest loop containing the entry and expand that
3298 // loop until it contains all blocks in the region. If there is a loop
3299 // containing all blocks in the region check if it is itself contained
3300 // and if so take the parent loop as it will be the smallest containing
3301 // the region but not contained by it.
Johannes Doerfertef744432016-05-23 12:42:38 +00003302 Loop *L = LI.getLoopFor(S.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003303 while (L) {
3304 bool AllContained = true;
Johannes Doerfertef744432016-05-23 12:42:38 +00003305 for (auto *BB : S.blocks())
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003306 AllContained &= L->contains(BB);
3307 if (AllContained)
3308 break;
3309 L = L->getParentLoop();
3310 }
3311
Johannes Doerfertef744432016-05-23 12:42:38 +00003312 return L ? (S.contains(L) ? L->getParentLoop() : L) : nullptr;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003313}
3314
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003315int Scop::NextScopID = 0;
3316
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00003317std::string Scop::CurrentFunc;
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003318
3319int Scop::getNextID(std::string ParentFunc) {
3320 if (ParentFunc != CurrentFunc) {
3321 CurrentFunc = ParentFunc;
3322 NextScopID = 0;
3323 }
3324 return NextScopID++;
3325}
3326
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003327Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
Tobias Grosseree457592017-09-24 09:25:30 +00003328 DominatorTree &DT, ScopDetection::DetectionContext &DC,
3329 OptimizationRemarkEmitter &ORE)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003330 : IslCtx(isl_ctx_alloc(), isl_ctx_free), SE(&ScalarEvolution), DT(&DT),
3331 R(R), name(R.getNameStr()), HasSingleExitEdge(R.getExitingBlock()),
3332 DC(DC), ORE(ORE), Affinator(this, LI),
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003333 ID(getNextID((*R.getEntry()->getParent()).getName().str())) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003334 if (IslOnErrorAbort)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003335 isl_options_set_on_error(getIslCtx().get(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003336 buildContext();
3337}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003338
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003339Scop::~Scop() = default;
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00003340
Tobias Grosserbedef002016-12-02 08:10:56 +00003341void Scop::foldSizeConstantsToRight() {
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00003342 isl_union_set *Accessed = isl_union_map_range(getAccesses().release());
Tobias Grosserbedef002016-12-02 08:10:56 +00003343
3344 for (auto Array : arrays()) {
3345 if (Array->getNumberOfDimensions() <= 1)
3346 continue;
3347
Tobias Grosser77eef902017-07-21 23:07:56 +00003348 isl_space *Space = Array->getSpace().release();
Tobias Grosserbedef002016-12-02 08:10:56 +00003349
3350 Space = isl_space_align_params(Space, isl_union_set_get_space(Accessed));
3351
3352 if (!isl_union_set_contains(Accessed, Space)) {
3353 isl_space_free(Space);
3354 continue;
3355 }
3356
3357 isl_set *Elements = isl_union_set_extract_set(Accessed, Space);
3358
3359 isl_map *Transform =
Tobias Grosser77eef902017-07-21 23:07:56 +00003360 isl_map_universe(isl_space_map_from_set(Array->getSpace().release()));
Tobias Grosserbedef002016-12-02 08:10:56 +00003361
3362 std::vector<int> Int;
3363
3364 int Dims = isl_set_dim(Elements, isl_dim_set);
3365 for (int i = 0; i < Dims; i++) {
3366 isl_set *DimOnly =
3367 isl_set_project_out(isl_set_copy(Elements), isl_dim_set, 0, i);
3368 DimOnly = isl_set_project_out(DimOnly, isl_dim_set, 1, Dims - i - 1);
3369 DimOnly = isl_set_lower_bound_si(DimOnly, isl_dim_set, 0, 0);
3370
3371 isl_basic_set *DimHull = isl_set_affine_hull(DimOnly);
3372
3373 if (i == Dims - 1) {
3374 Int.push_back(1);
3375 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3376 isl_basic_set_free(DimHull);
3377 continue;
3378 }
3379
3380 if (isl_basic_set_dim(DimHull, isl_dim_div) == 1) {
3381 isl_aff *Diff = isl_basic_set_get_div(DimHull, 0);
3382 isl_val *Val = isl_aff_get_denominator_val(Diff);
3383 isl_aff_free(Diff);
3384
3385 int ValInt = 1;
3386
Eli Friedmana75d53c2018-01-17 21:59:02 +00003387 if (isl_val_is_int(Val)) {
3388 auto ValAPInt = APIntFromVal(Val);
3389 if (ValAPInt.isSignedIntN(32))
3390 ValInt = ValAPInt.getSExtValue();
3391 } else {
3392 isl_val_free(Val);
3393 }
Tobias Grosserbedef002016-12-02 08:10:56 +00003394
3395 Int.push_back(ValInt);
3396
3397 isl_constraint *C = isl_constraint_alloc_equality(
3398 isl_local_space_from_space(isl_map_get_space(Transform)));
3399 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, ValInt);
3400 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, -1);
3401 Transform = isl_map_add_constraint(Transform, C);
3402 isl_basic_set_free(DimHull);
3403 continue;
3404 }
3405
3406 isl_basic_set *ZeroSet = isl_basic_set_copy(DimHull);
3407 ZeroSet = isl_basic_set_fix_si(ZeroSet, isl_dim_set, 0, 0);
3408
3409 int ValInt = 1;
3410 if (isl_basic_set_is_equal(ZeroSet, DimHull)) {
3411 ValInt = 0;
3412 }
3413
3414 Int.push_back(ValInt);
3415 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3416 isl_basic_set_free(DimHull);
3417 isl_basic_set_free(ZeroSet);
3418 }
3419
3420 isl_set *MappedElements = isl_map_domain(isl_map_copy(Transform));
3421
3422 if (!isl_set_is_subset(Elements, MappedElements)) {
3423 isl_set_free(Elements);
3424 isl_set_free(MappedElements);
3425 isl_map_free(Transform);
3426 continue;
3427 }
3428
3429 isl_set_free(MappedElements);
3430
3431 bool CanFold = true;
3432
3433 if (Int[0] <= 1)
3434 CanFold = false;
3435
3436 unsigned NumDims = Array->getNumberOfDimensions();
3437 for (unsigned i = 1; i < NumDims - 1; i++)
3438 if (Int[0] != Int[i] && Int[i])
3439 CanFold = false;
3440
3441 if (!CanFold) {
3442 isl_set_free(Elements);
3443 isl_map_free(Transform);
3444 continue;
3445 }
3446
Tobias Grosserbedef002016-12-02 08:10:56 +00003447 for (auto &Access : AccessFunctions)
3448 if (Access->getScopArrayInfo() == Array)
Tobias Grosser6d588042017-08-02 19:27:16 +00003449 Access->setAccessRelation(Access->getAccessRelation().apply_range(
Tobias Grosser718d04c2018-02-20 07:26:58 +00003450 isl::manage_copy(Transform)));
Tobias Grosserbedef002016-12-02 08:10:56 +00003451
3452 isl_map_free(Transform);
3453
3454 std::vector<const SCEV *> Sizes;
3455 for (unsigned i = 0; i < NumDims; i++) {
3456 auto Size = Array->getDimensionSize(i);
3457
3458 if (i == NumDims - 1)
3459 Size = SE->getMulExpr(Size, SE->getConstant(Size->getType(), Int[0]));
3460 Sizes.push_back(Size);
3461 }
3462
3463 Array->updateSizes(Sizes, false /* CheckConsistency */);
3464
3465 isl_set_free(Elements);
3466 }
3467 isl_union_set_free(Accessed);
Tobias Grosserbedef002016-12-02 08:10:56 +00003468}
3469
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003470void Scop::markFortranArrays() {
3471 for (ScopStmt &Stmt : Stmts) {
3472 for (MemoryAccess *MemAcc : Stmt) {
3473 Value *FAD = MemAcc->getFortranArrayDescriptor();
3474 if (!FAD)
3475 continue;
3476
3477 // TODO: const_cast-ing to edit
3478 ScopArrayInfo *SAI =
3479 const_cast<ScopArrayInfo *>(MemAcc->getLatestScopArrayInfo());
3480 assert(SAI && "memory access into a Fortran array does not "
3481 "have an associated ScopArrayInfo");
3482 SAI->applyAndSetFAD(FAD);
3483 }
3484 }
3485}
3486
Tobias Grosser491b7992016-12-02 05:21:22 +00003487void Scop::finalizeAccesses() {
3488 updateAccessDimensionality();
Tobias Grosserbedef002016-12-02 08:10:56 +00003489 foldSizeConstantsToRight();
Tobias Grosser491b7992016-12-02 05:21:22 +00003490 foldAccessRelations();
3491 assumeNoOutOfBounds();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003492 markFortranArrays();
Tobias Grosser491b7992016-12-02 05:21:22 +00003493}
3494
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003495void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003496 // Check all array accesses for each base pointer and find a (virtual) element
3497 // size for the base pointer that divides all access functions.
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003498 for (ScopStmt &Stmt : *this)
3499 for (MemoryAccess *Access : Stmt) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003500 if (!Access->isArrayKind())
3501 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003502 ScopArrayInfo *Array =
Tobias Grossere24b7b92017-02-09 23:24:57 +00003503 const_cast<ScopArrayInfo *>(Access->getScopArrayInfo());
3504
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003505 if (Array->getNumberOfDimensions() != 1)
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003506 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003507 unsigned DivisibleSize = Array->getElemSizeInBytes();
3508 const SCEV *Subscript = Access->getSubscript(0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003509 while (!isDivisible(Subscript, DivisibleSize, *SE))
3510 DivisibleSize /= 2;
3511 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003512 Array->updateElementType(Ty);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003513 }
3514
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003515 for (auto &Stmt : *this)
3516 for (auto &Access : Stmt)
3517 Access->updateDimensionality();
3518}
3519
Tobias Grosser491b7992016-12-02 05:21:22 +00003520void Scop::foldAccessRelations() {
3521 for (auto &Stmt : *this)
3522 for (auto &Access : Stmt)
3523 Access->foldAccessRelation();
3524}
3525
3526void Scop::assumeNoOutOfBounds() {
3527 for (auto &Stmt : *this)
3528 for (auto &Access : Stmt)
3529 Access->assumeNoOutOfBound();
3530}
3531
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003532void Scop::removeFromStmtMap(ScopStmt &Stmt) {
Tobias Grosserbd15d132017-08-31 03:15:56 +00003533 for (Instruction *Inst : Stmt.getInstructions())
3534 InstStmtMap.erase(Inst);
3535
3536 if (Stmt.isRegionStmt()) {
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003537 for (BasicBlock *BB : Stmt.getRegion()->blocks()) {
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003538 StmtMap.erase(BB);
Tobias Grosserbd15d132017-08-31 03:15:56 +00003539 // Skip entry basic block, as its instructions are already deleted as
3540 // part of the statement's instruction list.
3541 if (BB == Stmt.getEntryBlock())
3542 continue;
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003543 for (Instruction &Inst : *BB)
3544 InstStmtMap.erase(&Inst);
3545 }
Tobias Grosserbd15d132017-08-31 03:15:56 +00003546 } else {
Michael Kruse0c6c5552017-09-01 11:36:52 +00003547 auto StmtMapIt = StmtMap.find(Stmt.getBasicBlock());
3548 if (StmtMapIt != StmtMap.end())
3549 StmtMapIt->second.erase(std::remove(StmtMapIt->second.begin(),
3550 StmtMapIt->second.end(), &Stmt),
3551 StmtMapIt->second.end());
3552 for (Instruction *Inst : Stmt.getInstructions())
3553 InstStmtMap.erase(Inst);
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003554 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003555}
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003556
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003557void Scop::removeStmts(std::function<bool(ScopStmt &)> ShouldDelete) {
3558 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3559 if (!ShouldDelete(*StmtIt)) {
3560 StmtIt++;
3561 continue;
3562 }
3563
3564 removeFromStmtMap(*StmtIt);
3565 StmtIt = Stmts.erase(StmtIt);
3566 }
3567}
3568
3569void Scop::removeStmtNotInDomainMap() {
3570 auto ShouldDelete = [this](ScopStmt &Stmt) -> bool {
Tobias Grosser199ec4a2017-07-19 16:31:10 +00003571 return !this->DomainMap.lookup(Stmt.getEntryBlock());
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003572 };
3573 removeStmts(ShouldDelete);
3574}
3575
3576void Scop::simplifySCoP(bool AfterHoisting) {
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003577 auto ShouldDelete = [AfterHoisting](ScopStmt &Stmt) -> bool {
Johannes Doerfert26404542016-05-10 12:19:47 +00003578 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003579
Tobias Grosser3012a0b2017-07-16 22:44:17 +00003580 // Remove read only statements only after invariant load hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003581 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003582 bool OnlyRead = true;
3583 for (MemoryAccess *MA : Stmt) {
3584 if (MA->isRead())
3585 continue;
3586
3587 OnlyRead = false;
3588 break;
3589 }
3590
3591 RemoveStmt = OnlyRead;
3592 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003593 return RemoveStmt;
3594 };
Johannes Doerferteca9e892015-11-03 16:54:49 +00003595
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003596 removeStmts(ShouldDelete);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003597}
3598
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003599InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003600 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3601 if (!LInst)
3602 return nullptr;
3603
3604 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3605 LInst = cast<LoadInst>(Rep);
3606
Johannes Doerfert96e54712016-02-07 17:30:13 +00003607 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003608 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003609 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003610 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfert549768c2016-03-24 13:22:16 +00003611 continue;
3612
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003613 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfert549768c2016-03-24 13:22:16 +00003614 for (auto *MA : MAs)
3615 if (MA->getAccessInstruction() == Val)
3616 return &IAClass;
3617 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003618
3619 return nullptr;
3620}
3621
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003622bool isAParameter(llvm::Value *maybeParam, const Function &F) {
3623 for (const llvm::Argument &Arg : F.args())
3624 if (&Arg == maybeParam)
3625 return true;
3626
3627 return false;
Michael Kruse594386e2017-08-23 12:34:37 +00003628}
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003629
Tobias Grosser305d3162017-08-07 00:10:11 +00003630bool Scop::canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3631 bool MAInvalidCtxIsEmpty,
3632 bool NonHoistableCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003633 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3634 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
Siddharth Bhat7bc77e82017-08-21 11:57:04 +00003635 if (PollyAllowDereferenceOfAllFunctionParams &&
3636 isAParameter(LInst->getPointerOperand(), getFunction()))
3637 return true;
3638
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003639 // TODO: We can provide more information for better but more expensive
3640 // results.
3641 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3642 LInst->getAlignment(), DL))
3643 return false;
3644
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003645 // If the location might be overwritten we do not hoist it unconditionally.
3646 //
Siddharth Bhat83fe6b52017-08-08 12:26:32 +00003647 // TODO: This is probably too conservative.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003648 if (!NonHoistableCtxIsEmpty)
3649 return false;
3650
Michael Krusea6d48f52017-06-08 12:06:15 +00003651 // If a dereferenceable load is in a statement that is modeled precisely we
3652 // can hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003653 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003654 return true;
3655
3656 // Even if the statement is not modeled precisely we can hoist the load if it
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003657 // does not involve any parameters that might have been specialized by the
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003658 // statement domain.
3659 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3660 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3661 return false;
3662 return true;
3663}
3664
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003665void Scop::addInvariantLoads(ScopStmt &Stmt, InvariantAccessesTy &InvMAs) {
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003666 if (InvMAs.empty())
3667 return;
3668
Tobias Grosser2332fa32017-08-06 15:36:48 +00003669 isl::set StmtInvalidCtx = Stmt.getInvalidContext();
3670 bool StmtInvalidCtxIsEmpty = StmtInvalidCtx.is_empty();
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003671
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003672 // Get the context under which the statement is executed but remove the error
3673 // context under which this statement is reached.
Tobias Grossere69b2722017-08-06 23:50:25 +00003674 isl::set DomainCtx = Stmt.getDomain().params();
3675 DomainCtx = DomainCtx.subtract(StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003676
Tobias Grossere69b2722017-08-06 23:50:25 +00003677 if (isl_set_n_basic_set(DomainCtx.get()) >= MaxDisjunctsInDomain) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003678 auto *AccInst = InvMAs.front().MA->getAccessInstruction();
Eli Friedmane737fc12017-07-17 23:58:33 +00003679 invalidate(COMPLEXITY, AccInst->getDebugLoc(), AccInst->getParent());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003680 return;
3681 }
3682
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003683 // Project out all parameters that relate to loads in the statement. Otherwise
3684 // we could have cyclic dependences on the constraints under which the
3685 // hoisted loads are executed and we could not determine an order in which to
3686 // pre-load them. This happens because not only lower bounds are part of the
3687 // domain but also upper bounds.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003688 for (auto &InvMA : InvMAs) {
3689 auto *MA = InvMA.MA;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003690 Instruction *AccInst = MA->getAccessInstruction();
3691 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003692 SetVector<Value *> Values;
3693 for (const SCEV *Parameter : Parameters) {
3694 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003695 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003696 if (!Values.count(AccInst))
3697 continue;
3698
Tobias Grossere69b2722017-08-06 23:50:25 +00003699 if (isl::id ParamId = getIdForParam(Parameter)) {
3700 int Dim = DomainCtx.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosserb58ed8d2017-03-17 09:02:53 +00003701 if (Dim >= 0)
Tobias Grossere69b2722017-08-06 23:50:25 +00003702 DomainCtx = DomainCtx.eliminate(isl::dim::param, Dim, 1);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003703 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003704 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003705 }
3706 }
3707
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003708 for (auto &InvMA : InvMAs) {
3709 auto *MA = InvMA.MA;
Tobias Grossere69b2722017-08-06 23:50:25 +00003710 isl::set NHCtx = InvMA.NonHoistableCtx;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003711
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003712 // Check for another invariant access that accesses the same location as
3713 // MA and if found consolidate them. Otherwise create a new equivalence
3714 // class at the end of InvariantEquivClasses.
3715 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003716 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003717 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3718
Tobias Grossere69b2722017-08-06 23:50:25 +00003719 isl::set MAInvalidCtx = MA->getInvalidContext();
3720 bool NonHoistableCtxIsEmpty = NHCtx.is_empty();
3721 bool MAInvalidCtxIsEmpty = MAInvalidCtx.is_empty();
Johannes Doerfert85676e32016-04-23 14:32:34 +00003722
Tobias Grossere69b2722017-08-06 23:50:25 +00003723 isl::set MACtx;
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003724 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003725 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty,
3726 NonHoistableCtxIsEmpty)) {
Tobias Grossere69b2722017-08-06 23:50:25 +00003727 MACtx = isl::set::universe(DomainCtx.get_space());
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003728 } else {
Tobias Grossere69b2722017-08-06 23:50:25 +00003729 MACtx = DomainCtx;
3730 MACtx = MACtx.subtract(MAInvalidCtx.unite(NHCtx));
3731 MACtx = MACtx.gist_params(getContext());
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003732 }
3733
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003734 bool Consolidated = false;
3735 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003736 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003737 continue;
3738
Johannes Doerfertdf880232016-03-03 12:26:58 +00003739 // If the pointer and the type is equal check if the access function wrt.
3740 // to the domain is equal too. It can happen that the domain fixes
3741 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003742 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003743 // create a new invariant load equivalence class.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003744 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertdf880232016-03-03 12:26:58 +00003745 if (!MAs.empty()) {
3746 auto *LastMA = MAs.front();
3747
Tobias Grossere69b2722017-08-06 23:50:25 +00003748 isl::set AR = MA->getAccessRelation().range();
3749 isl::set LastAR = LastMA->getAccessRelation().range();
3750 bool SameAR = AR.is_equal(LastAR);
Johannes Doerfertdf880232016-03-03 12:26:58 +00003751
3752 if (!SameAR)
3753 continue;
3754 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003755
3756 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003757 MAs.push_front(MA);
3758
Johannes Doerfertdf880232016-03-03 12:26:58 +00003759 Consolidated = true;
3760
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003761 // Unify the execution context of the class and this statement.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003762 isl::set IAClassDomainCtx = IAClass.ExecutionContext;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003763 if (IAClassDomainCtx)
Tobias Grossere69b2722017-08-06 23:50:25 +00003764 IAClassDomainCtx = IAClassDomainCtx.unite(MACtx).coalesce();
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003765 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003766 IAClassDomainCtx = MACtx;
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003767 IAClass.ExecutionContext = IAClassDomainCtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003768 break;
3769 }
3770
3771 if (Consolidated)
3772 continue;
3773
3774 // If we did not consolidate MA, thus did not find an equivalence class
3775 // for it, we create a new one.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003776 InvariantEquivClasses.emplace_back(
3777 InvariantEquivClassTy{PointerSCEV, MemoryAccessList{MA}, MACtx, Ty});
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003778 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003779}
3780
Tobias Grosser1eeedf42017-07-20 19:55:19 +00003781/// Check if an access range is too complex.
3782///
3783/// An access range is too complex, if it contains either many disjuncts or
3784/// very complex expressions. As a simple heuristic, we assume if a set to
3785/// be too complex if the sum of existentially quantified dimensions and
3786/// set dimensions is larger than a threshold. This reliably detects both
3787/// sets with many disjuncts as well as sets with many divisions as they
3788/// arise in h264.
3789///
3790/// @param AccessRange The range to check for complexity.
3791///
3792/// @returns True if the access range is too complex.
3793static bool isAccessRangeTooComplex(isl::set AccessRange) {
3794 unsigned NumTotalDims = 0;
3795
3796 auto CountDimensions = [&NumTotalDims](isl::basic_set BSet) -> isl::stat {
3797 NumTotalDims += BSet.dim(isl::dim::div);
3798 NumTotalDims += BSet.dim(isl::dim::set);
3799 return isl::stat::ok;
3800 };
3801
3802 AccessRange.foreach_basic_set(CountDimensions);
3803
3804 if (NumTotalDims > MaxDimensionsInAccessRange)
3805 return true;
3806
3807 return false;
3808}
3809
Tobias Grosser4071cb52017-06-06 23:13:02 +00003810isl::set Scop::getNonHoistableCtx(MemoryAccess *Access, isl::union_map Writes) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003811 // TODO: Loads that are not loop carried, hence are in a statement with
3812 // zero iterators, are by construction invariant, though we
3813 // currently "hoist" them anyway. This is necessary because we allow
3814 // them to be treated as parameters (e.g., in conditions) and our code
3815 // generation would otherwise use the old value.
3816
3817 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003818 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003819
Johannes Doerfertc9765462016-11-17 22:11:56 +00003820 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine() ||
3821 Access->isMemoryIntrinsic())
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003822 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003823
3824 // Skip accesses that have an invariant base pointer which is defined but
3825 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3826 // returns a pointer that is used as a base address. However, as we want
3827 // to hoist indirect pointers, we allow the base pointer to be defined in
3828 // the region if it is also a memory access. Each ScopArrayInfo object
3829 // that has a base pointer origin has a base pointer that is loaded and
3830 // that it is invariant, thus it will be hoisted too. However, if there is
3831 // no base pointer origin we check that the base pointer is defined
3832 // outside the region.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003833 auto *LI = cast<LoadInst>(Access->getAccessInstruction());
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003834 if (hasNonHoistableBasePtrInScop(Access, Writes))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003835 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003836
Tobias Grosser1515f6b2017-07-23 04:08:38 +00003837 isl::map AccessRelation = give(Access->getAccessRelation().release());
Tobias Grosser4071cb52017-06-06 23:13:02 +00003838 assert(!AccessRelation.is_empty());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003839
Tobias Grosser4071cb52017-06-06 23:13:02 +00003840 if (AccessRelation.involves_dims(isl::dim::in, 0, Stmt.getNumIterators()))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003841 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003842
Tobias Grosserdcf8d692017-08-06 16:39:52 +00003843 AccessRelation = AccessRelation.intersect_domain(Stmt.getDomain());
Tobias Grosser4071cb52017-06-06 23:13:02 +00003844 isl::set SafeToLoad;
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003845
3846 auto &DL = getFunction().getParent()->getDataLayout();
3847 if (isSafeToLoadUnconditionally(LI->getPointerOperand(), LI->getAlignment(),
3848 DL)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003849 SafeToLoad = isl::set::universe(AccessRelation.get_space().range());
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003850 } else if (BB != LI->getParent()) {
3851 // Skip accesses in non-affine subregions as they might not be executed
3852 // under the same condition as the entry of the non-affine subregion.
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003853 return nullptr;
3854 } else {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003855 SafeToLoad = AccessRelation.range();
Tobias Grosserc96c1d82017-04-27 20:08:16 +00003856 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003857
Tobias Grosser1eeedf42017-07-20 19:55:19 +00003858 if (isAccessRangeTooComplex(AccessRelation.range()))
3859 return nullptr;
3860
Tobias Grosser4071cb52017-06-06 23:13:02 +00003861 isl::union_map Written = Writes.intersect_range(SafeToLoad);
3862 isl::set WrittenCtx = Written.params();
3863 bool IsWritten = !WrittenCtx.is_empty();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003864
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003865 if (!IsWritten)
3866 return WrittenCtx;
3867
Tobias Grosser4071cb52017-06-06 23:13:02 +00003868 WrittenCtx = WrittenCtx.remove_divs();
3869 bool TooComplex =
3870 isl_set_n_basic_set(WrittenCtx.get()) >= MaxDisjunctsInDomain;
3871 if (TooComplex || !isRequiredInvariantLoad(LI))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003872 return nullptr;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003873
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00003874 addAssumption(INVARIANTLOAD, WrittenCtx, LI->getDebugLoc(), AS_RESTRICTION,
3875 LI->getParent());
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003876 return WrittenCtx;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003877}
3878
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003879void Scop::verifyInvariantLoads() {
3880 auto &RIL = getRequiredInvariantLoads();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003881 for (LoadInst *LI : RIL) {
Johannes Doerfert952b5302016-05-23 12:40:48 +00003882 assert(LI && contains(LI));
Michael Krusecd3b9fe2017-08-09 16:45:37 +00003883 // If there exists a statement in the scop which has a memory access for
3884 // @p LI, then mark this scop as infeasible for optimization.
3885 for (ScopStmt &Stmt : Stmts)
3886 if (Stmt.getArrayAccessOrNULLFor(LI)) {
3887 invalidate(INVARIANTLOAD, LI->getDebugLoc(), LI->getParent());
3888 return;
3889 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003890 }
3891}
3892
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003893void Scop::hoistInvariantLoads() {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003894 if (!PollyInvariantLoadHoisting)
3895 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003896
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00003897 isl::union_map Writes = getWrites();
Tobias Grosser0865e7752016-02-29 07:29:42 +00003898 for (ScopStmt &Stmt : *this) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003899 InvariantAccessesTy InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003900
Tobias Grosser0865e7752016-02-29 07:29:42 +00003901 for (MemoryAccess *Access : Stmt)
Tobias Grosser4071cb52017-06-06 23:13:02 +00003902 if (isl::set NHCtx = getNonHoistableCtx(Access, Writes))
Tobias Grosserd16f9272017-08-06 17:25:14 +00003903 InvariantAccesses.push_back({Access, NHCtx});
Tobias Grosser0865e7752016-02-29 07:29:42 +00003904
3905 // Transfer the memory access from the statement to the SCoP.
Michael Kruse10071822016-05-23 14:45:58 +00003906 for (auto InvMA : InvariantAccesses)
3907 Stmt.removeMemoryAccess(InvMA.MA);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003908 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003909 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003910}
3911
Tobias Grosserf3adab42017-05-10 10:59:58 +00003912/// Find the canonical scop array info object for a set of invariant load
3913/// hoisted loads. The canonical array is the one that corresponds to the
3914/// first load in the list of accesses which is used as base pointer of a
3915/// scop array.
3916static const ScopArrayInfo *findCanonicalArray(Scop *S,
3917 MemoryAccessList &Accesses) {
3918 for (MemoryAccess *Access : Accesses) {
3919 const ScopArrayInfo *CanonicalArray = S->getScopArrayInfoOrNull(
3920 Access->getAccessInstruction(), MemoryKind::Array);
3921 if (CanonicalArray)
3922 return CanonicalArray;
3923 }
3924 return nullptr;
3925}
3926
3927/// Check if @p Array severs as base array in an invariant load.
3928static bool isUsedForIndirectHoistedLoad(Scop *S, const ScopArrayInfo *Array) {
3929 for (InvariantEquivClassTy &EqClass2 : S->getInvariantAccesses())
3930 for (MemoryAccess *Access2 : EqClass2.InvariantAccesses)
3931 if (Access2->getScopArrayInfo() == Array)
3932 return true;
3933 return false;
3934}
3935
3936/// Replace the base pointer arrays in all memory accesses referencing @p Old,
3937/// with a reference to @p New.
3938static void replaceBasePtrArrays(Scop *S, const ScopArrayInfo *Old,
3939 const ScopArrayInfo *New) {
3940 for (ScopStmt &Stmt : *S)
3941 for (MemoryAccess *Access : Stmt) {
3942 if (Access->getLatestScopArrayInfo() != Old)
3943 continue;
3944
Tobias Grosser6d588042017-08-02 19:27:16 +00003945 isl::id Id = New->getBasePtrId();
3946 isl::map Map = Access->getAccessRelation();
3947 Map = Map.set_tuple_id(isl::dim::out, Id);
Tobias Grosserf3adab42017-05-10 10:59:58 +00003948 Access->setAccessRelation(Map);
3949 }
3950}
3951
3952void Scop::canonicalizeDynamicBasePtrs() {
3953 for (InvariantEquivClassTy &EqClass : InvariantEquivClasses) {
3954 MemoryAccessList &BasePtrAccesses = EqClass.InvariantAccesses;
3955
3956 const ScopArrayInfo *CanonicalBasePtrSAI =
3957 findCanonicalArray(this, BasePtrAccesses);
3958
3959 if (!CanonicalBasePtrSAI)
3960 continue;
3961
3962 for (MemoryAccess *BasePtrAccess : BasePtrAccesses) {
3963 const ScopArrayInfo *BasePtrSAI = getScopArrayInfoOrNull(
3964 BasePtrAccess->getAccessInstruction(), MemoryKind::Array);
3965 if (!BasePtrSAI || BasePtrSAI == CanonicalBasePtrSAI ||
3966 !BasePtrSAI->isCompatibleWith(CanonicalBasePtrSAI))
3967 continue;
3968
3969 // we currently do not canonicalize arrays where some accesses are
3970 // hoisted as invariant loads. If we would, we need to update the access
3971 // function of the invariant loads as well. However, as this is not a
3972 // very common situation, we leave this for now to avoid further
3973 // complexity increases.
3974 if (isUsedForIndirectHoistedLoad(this, BasePtrSAI))
3975 continue;
3976
3977 replaceBasePtrArrays(this, BasePtrSAI, CanonicalBasePtrSAI);
3978 }
3979 }
3980}
3981
Michael Kruseb738ffa2017-06-28 13:02:43 +00003982ScopArrayInfo *Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
3983 ArrayRef<const SCEV *> Sizes,
3984 MemoryKind Kind,
3985 const char *BaseName) {
Roman Gareevd7754a12016-07-30 09:25:51 +00003986 assert((BasePtr || BaseName) &&
3987 "BasePtr and BaseName can not be nullptr at the same time.");
3988 assert(!(BasePtr && BaseName) && "BaseName is redundant.");
3989 auto &SAI = BasePtr ? ScopArrayInfoMap[std::make_pair(BasePtr, Kind)]
3990 : ScopArrayNameMap[BaseName];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003991 if (!SAI) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00003992 auto &DL = getFunction().getParent()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003993 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +00003994 DL, this, BaseName));
3995 ScopArrayInfoSet.insert(SAI.get());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003996 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003997 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003998 // In case of mismatching array sizes, we bail out by setting the run-time
3999 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004000 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004001 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004002 }
Tobias Grosserab671442015-05-23 05:58:27 +00004003 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004004}
4005
Michael Kruseb738ffa2017-06-28 13:02:43 +00004006ScopArrayInfo *Scop::createScopArrayInfo(Type *ElementType,
4007 const std::string &BaseName,
4008 const std::vector<unsigned> &Sizes) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004009 auto *DimSizeType = Type::getInt64Ty(getSE()->getContext());
4010 std::vector<const SCEV *> SCEVSizes;
4011
4012 for (auto size : Sizes)
Roman Gareevf5aff702016-09-12 17:08:31 +00004013 if (size)
4014 SCEVSizes.push_back(getSE()->getConstant(DimSizeType, size, false));
4015 else
4016 SCEVSizes.push_back(nullptr);
Roman Gareevd7754a12016-07-30 09:25:51 +00004017
Tobias Grosser4d5a9172017-01-14 20:25:44 +00004018 auto *SAI = getOrCreateScopArrayInfo(nullptr, ElementType, SCEVSizes,
4019 MemoryKind::Array, BaseName.c_str());
Roman Gareevd7754a12016-07-30 09:25:51 +00004020 return SAI;
4021}
4022
Tobias Grosserf3adab42017-05-10 10:59:58 +00004023const ScopArrayInfo *Scop::getScopArrayInfoOrNull(Value *BasePtr,
4024 MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00004025 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004026 return SAI;
4027}
4028
4029const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, MemoryKind Kind) {
4030 auto *SAI = getScopArrayInfoOrNull(BasePtr, Kind);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004031 assert(SAI && "No ScopArrayInfo available for this base pointer");
4032 return SAI;
4033}
4034
Tobias Grosser8ea1fc12017-08-06 19:52:38 +00004035std::string Scop::getContextStr() const { return getContext().to_str(); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004036
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004037std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004038 assert(AssumedContext && "Assumed context not yet built");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004039 return AssumedContext.to_str();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004040}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004041
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004042std::string Scop::getInvalidContextStr() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004043 return InvalidContext.to_str();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004044}
Tobias Grosser75805372011-04-29 06:27:02 +00004045
4046std::string Scop::getNameStr() const {
4047 std::string ExitName, EntryName;
Siddharth Bhat07bee292017-06-02 08:01:22 +00004048 std::tie(EntryName, ExitName) = getEntryExitStr();
4049 return EntryName + "---" + ExitName;
4050}
4051
4052std::pair<std::string, std::string> Scop::getEntryExitStr() const {
4053 std::string ExitName, EntryName;
Tobias Grosser75805372011-04-29 06:27:02 +00004054 raw_string_ostream ExitStr(ExitName);
4055 raw_string_ostream EntryStr(EntryName);
4056
Tobias Grosserf240b482014-01-09 10:42:15 +00004057 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004058 EntryStr.str();
4059
4060 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00004061 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004062 ExitStr.str();
4063 } else
4064 ExitName = "FunctionExit";
4065
Siddharth Bhat07bee292017-06-02 08:01:22 +00004066 return std::make_pair(EntryName, ExitName);
Tobias Grosser75805372011-04-29 06:27:02 +00004067}
4068
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004069isl::set Scop::getContext() const { return Context; }
Tobias Grosserb65ccc42017-08-06 20:11:59 +00004070isl::space Scop::getParamSpace() const { return getContext().get_space(); }
Tobias Grosser37487052011-10-06 00:03:42 +00004071
Tobias Grosserb5563c62017-08-03 13:51:15 +00004072isl::space Scop::getFullParamSpace() const {
4073 std::vector<isl::id> FortranIDs;
4074 FortranIDs = getFortranArrayIds(arrays());
4075
4076 isl::space Space = isl::space::params_alloc(
4077 getIslCtx(), ParameterIds.size() + FortranIDs.size());
4078
4079 unsigned PDim = 0;
4080 for (const SCEV *Parameter : Parameters) {
Tobias Grosser9a635702017-08-06 19:31:27 +00004081 isl::id Id = getIdForParam(Parameter);
Tobias Grosserb5563c62017-08-03 13:51:15 +00004082 Space = Space.set_dim_id(isl::dim::param, PDim++, Id);
4083 }
4084
4085 for (isl::id Id : FortranIDs)
4086 Space = Space.set_dim_id(isl::dim::param, PDim++, Id);
4087
4088 return Space;
4089}
4090
Tobias Grossere1270332017-08-06 21:42:09 +00004091isl::set Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004092 assert(AssumedContext && "Assumed context not yet built");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004093 return AssumedContext;
Tobias Grossere86109f2013-10-29 21:05:49 +00004094}
4095
Michael Krusef3091bf2017-03-17 13:09:52 +00004096bool Scop::isProfitable(bool ScalarsAreUnprofitable) const {
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004097 if (PollyProcessUnprofitable)
4098 return true;
4099
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004100 if (isEmpty())
4101 return false;
4102
4103 unsigned OptimizableStmtsOrLoops = 0;
4104 for (auto &Stmt : *this) {
4105 if (Stmt.getNumIterators() == 0)
4106 continue;
4107
4108 bool ContainsArrayAccs = false;
4109 bool ContainsScalarAccs = false;
4110 for (auto *MA : Stmt) {
4111 if (MA->isRead())
4112 continue;
Michael Krusef3091bf2017-03-17 13:09:52 +00004113 ContainsArrayAccs |= MA->isLatestArrayKind();
4114 ContainsScalarAccs |= MA->isLatestScalarKind();
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004115 }
4116
Michael Krusef3091bf2017-03-17 13:09:52 +00004117 if (!ScalarsAreUnprofitable || (ContainsArrayAccs && !ContainsScalarAccs))
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004118 OptimizableStmtsOrLoops += Stmt.getNumIterators();
4119 }
4120
4121 return OptimizableStmtsOrLoops > 1;
4122}
4123
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00004124bool Scop::hasFeasibleRuntimeContext() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004125 auto PositiveContext = getAssumedContext();
4126 auto NegativeContext = getInvalidContext();
4127 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
4128 // addNonEmptyDomainConstraints returns null if ScopStmts have a null domain
4129 if (!PositiveContext)
Johannes Doerfert94341c92016-04-23 13:00:27 +00004130 return false;
Johannes Doerfert94341c92016-04-23 13:00:27 +00004131
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004132 bool IsFeasible = !(PositiveContext.is_empty() ||
4133 PositiveContext.is_subset(NegativeContext));
4134 if (!IsFeasible)
4135 return false;
4136
4137 auto DomainContext = getDomains().params();
4138 IsFeasible = !DomainContext.is_subset(NegativeContext);
4139 IsFeasible &= !Context.is_subset(NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004140
Johannes Doerfert43788c52015-08-20 05:58:56 +00004141 return IsFeasible;
4142}
4143
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004144static std::string toString(AssumptionKind Kind) {
4145 switch (Kind) {
4146 case ALIASING:
4147 return "No-aliasing";
4148 case INBOUNDS:
4149 return "Inbounds";
4150 case WRAPPING:
4151 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00004152 case UNSIGNED:
4153 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004154 case COMPLEXITY:
4155 return "Low complexity";
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004156 case PROFITABLE:
4157 return "Profitable";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004158 case ERRORBLOCK:
4159 return "No-error";
4160 case INFINITELOOP:
4161 return "Finite loop";
4162 case INVARIANTLOAD:
4163 return "Invariant load";
4164 case DELINEARIZATION:
4165 return "Delinearization";
4166 }
4167 llvm_unreachable("Unknown AssumptionKind!");
4168}
4169
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004170bool Scop::isEffectiveAssumption(isl::set Set, AssumptionSign Sign) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004171 if (Sign == AS_ASSUMPTION) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004172 if (Context.is_subset(Set))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004173 return false;
4174
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004175 if (AssumedContext.is_subset(Set))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004176 return false;
4177 } else {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004178 if (Set.is_disjoint(Context))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004179 return false;
4180
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004181 if (Set.is_subset(InvalidContext))
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004182 return false;
4183 }
4184 return true;
4185}
4186
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004187bool Scop::trackAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4188 AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004189 if (PollyRemarksMinimal && !isEffectiveAssumption(Set, Sign))
4190 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004191
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004192 // Do never emit trivial assumptions as they only clutter the output.
4193 if (!PollyRemarksMinimal) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004194 isl::set Univ;
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004195 if (Sign == AS_ASSUMPTION)
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004196 Univ = isl::set::universe(Set.get_space());
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004197
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004198 bool IsTrivial = (Sign == AS_RESTRICTION && Set.is_empty()) ||
4199 (Sign == AS_ASSUMPTION && Univ.is_equal(Set));
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004200
4201 if (IsTrivial)
4202 return false;
4203 }
4204
Johannes Doerfertcd195322016-11-17 21:41:08 +00004205 switch (Kind) {
4206 case ALIASING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004207 AssumptionsAliasing++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004208 break;
4209 case INBOUNDS:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004210 AssumptionsInbounds++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004211 break;
4212 case WRAPPING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004213 AssumptionsWrapping++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004214 break;
4215 case UNSIGNED:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004216 AssumptionsUnsigned++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004217 break;
4218 case COMPLEXITY:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004219 AssumptionsComplexity++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004220 break;
4221 case PROFITABLE:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004222 AssumptionsUnprofitable++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004223 break;
4224 case ERRORBLOCK:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004225 AssumptionsErrorBlock++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004226 break;
4227 case INFINITELOOP:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004228 AssumptionsInfiniteLoop++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004229 break;
4230 case INVARIANTLOAD:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004231 AssumptionsInvariantLoad++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004232 break;
4233 case DELINEARIZATION:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004234 AssumptionsDelinearization++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004235 break;
4236 }
4237
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004238 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004239 std::string Msg = toString(Kind) + Suffix + Set.to_str();
Eli Friedmane737fc12017-07-17 23:58:33 +00004240 if (BB)
4241 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc, BB)
4242 << Msg);
4243 else
4244 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc,
4245 R.getEntry())
4246 << Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004247 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004248}
4249
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004250void Scop::addAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4251 AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004252 // Simplify the assumptions/restrictions first.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004253 Set = Set.gist_params(getContext());
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004254
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004255 if (!trackAssumption(Kind, Set, Loc, Sign, BB))
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004256 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00004257
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004258 if (Sign == AS_ASSUMPTION)
4259 AssumedContext = AssumedContext.intersect(Set).coalesce();
4260 else
4261 InvalidContext = InvalidContext.unite(Set).coalesce();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004262}
4263
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004264void Scop::recordAssumption(AssumptionKind Kind, isl::set Set, DebugLoc Loc,
4265 AssumptionSign Sign, BasicBlock *BB) {
4266 assert((Set.is_params() || BB) &&
Tobias Grosserf67433a2016-11-10 11:44:10 +00004267 "Assumptions without a basic block must be parameter sets");
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004268 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004269}
4270
4271void Scop::addRecordedAssumptions() {
4272 while (!RecordedAssumptions.empty()) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004273 Assumption AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004274
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004275 if (!AS.BB) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004276 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign, nullptr /* BasicBlock */);
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004277 continue;
4278 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004279
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004280 // If the domain was deleted the assumptions are void.
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004281 isl_set *Dom = getDomainConditions(AS.BB).release();
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004282 if (!Dom)
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004283 continue;
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004284
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004285 // If a basic block was given use its domain to simplify the assumption.
4286 // In case of restrictions we know they only have to hold on the domain,
4287 // thus we can intersect them with the domain of the block. However, for
4288 // assumptions the domain has to imply them, thus:
4289 // _ _____
4290 // Dom => S <==> A v B <==> A - B
4291 //
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004292 // To avoid the complement we will register A - B as a restriction not an
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004293 // assumption.
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004294 isl_set *S = AS.Set.copy();
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004295 if (AS.Sign == AS_RESTRICTION)
4296 S = isl_set_params(isl_set_intersect(S, Dom));
4297 else /* (AS.Sign == AS_ASSUMPTION) */
4298 S = isl_set_params(isl_set_subtract(Dom, S));
4299
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004300 addAssumption(AS.Kind, isl::manage(S), AS.Loc, AS_RESTRICTION, AS.BB);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004301 }
4302}
4303
Eli Friedmane737fc12017-07-17 23:58:33 +00004304void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc, BasicBlock *BB) {
Michael Kruse860870b2017-08-30 11:52:03 +00004305 DEBUG(dbgs() << "Invalidate SCoP because of reason " << Kind << "\n");
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004306 addAssumption(Kind, isl::set::empty(getParamSpace()), Loc, AS_ASSUMPTION, BB);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004307}
4308
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004309isl::set Scop::getInvalidContext() const { return InvalidContext; }
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004310
Tobias Grosser75805372011-04-29 06:27:02 +00004311void Scop::printContext(raw_ostream &OS) const {
4312 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004313 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00004314
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004315 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004316 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004317
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004318 OS.indent(4) << "Invalid Context:\n";
4319 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004320
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00004321 unsigned Dim = 0;
4322 for (const SCEV *Parameter : Parameters)
4323 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004324}
4325
Johannes Doerfertb164c792014-09-18 11:17:17 +00004326void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004327 int noOfGroups = 0;
4328 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004329 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004330 noOfGroups += 1;
4331 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004332 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004333 }
4334
Tobias Grosserbb853c22015-07-25 12:31:03 +00004335 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00004336 if (MinMaxAliasGroups.empty()) {
4337 OS.indent(8) << "n/a\n";
4338 return;
4339 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004340
Tobias Grosserbb853c22015-07-25 12:31:03 +00004341 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004342
4343 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004344 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004345 OS.indent(8) << "[[";
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 }
4352
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004353 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004354 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00004355 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004356 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004357 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4358 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004359 }
4360 OS << " ]]\n";
4361 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00004362 }
4363}
4364
Michael Krusecd4c9772017-07-21 15:35:53 +00004365void Scop::printStatements(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00004366 OS << "Statements {\n";
4367
Michael Krusecd4c9772017-07-21 15:35:53 +00004368 for (const ScopStmt &Stmt : *this) {
4369 OS.indent(4);
4370 Stmt.print(OS, PrintInstructions);
4371 }
Tobias Grosser75805372011-04-29 06:27:02 +00004372
4373 OS.indent(4) << "}\n";
4374}
4375
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004376void Scop::printArrayInfo(raw_ostream &OS) const {
4377 OS << "Arrays {\n";
4378
Tobias Grosserab671442015-05-23 05:58:27 +00004379 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004380 Array->print(OS);
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004381
4382 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004383
4384 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
4385
4386 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004387 Array->print(OS, /* SizeAsPwAff */ true);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004388
4389 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004390}
4391
Michael Krusecd4c9772017-07-21 15:35:53 +00004392void Scop::print(raw_ostream &OS, bool PrintInstructions) const {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004393 OS.indent(4) << "Function: " << getFunction().getName() << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00004394 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00004395 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004396 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004397 for (const auto &IAClass : InvariantEquivClasses) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004398 const auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004399 if (MAs.empty()) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004400 OS.indent(12) << "Class Pointer: " << *IAClass.IdentifyingPointer << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004401 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004402 MAs.front()->print(OS);
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004403 OS.indent(12) << "Execution Context: " << IAClass.ExecutionContext
4404 << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004405 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004406 }
4407 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004408 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004409 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00004410 printAliasAssumptions(OS);
Michael Krusecd4c9772017-07-21 15:35:53 +00004411 printStatements(OS.indent(4), PrintInstructions);
Tobias Grosser75805372011-04-29 06:27:02 +00004412}
4413
Michael Kruse5d518462017-07-21 15:54:07 +00004414#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00004415LLVM_DUMP_METHOD void Scop::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00004416#endif
Tobias Grosser75805372011-04-29 06:27:02 +00004417
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004418isl::ctx Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00004419
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004420__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
4421 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004422 // First try to use the SCEVAffinator to generate a piecewise defined
4423 // affine function from @p E in the context of @p BB. If that tasks becomes to
4424 // complex the affinator might return a nullptr. In such a case we invalidate
4425 // the SCoP and return a dummy value. This way we do not need to add error
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004426 // handling code to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004427 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004428 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00004429 // TODO: We could use a heuristic and either use:
4430 // SCEVAffinator::takeNonNegativeAssumption
4431 // or
4432 // SCEVAffinator::interpretAsUnsigned
4433 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004434 if (NonNegative)
4435 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004436 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004437 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004438
4439 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
Eli Friedmane737fc12017-07-17 23:58:33 +00004440 invalidate(COMPLEXITY, DL, BB);
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004441 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00004442}
4443
Tobias Grosser31df6f32017-08-06 21:42:25 +00004444isl::union_set Scop::getDomains() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004445 isl_space *EmptySpace = isl_space_params_alloc(getIslCtx().get(), 0);
Tobias Grosser941cb7d2017-03-17 09:02:50 +00004446 isl_union_set *Domain = isl_union_set_empty(EmptySpace);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004447
Tobias Grosser808cd692015-07-14 09:33:13 +00004448 for (const ScopStmt &Stmt : *this)
Tobias Grosserdcf8d692017-08-06 16:39:52 +00004449 Domain = isl_union_set_add_set(Domain, Stmt.getDomain().release());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004450
Tobias Grosser31df6f32017-08-06 21:42:25 +00004451 return isl::manage(Domain);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004452}
4453
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004454isl::pw_aff Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004455 PWACtx PWAC = getPwAff(E, BB);
Philip Pfaffed98dbee2017-12-06 21:02:22 +00004456 return PWAC.first;
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004457}
4458
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004459isl::union_map
Tobias Grossere5a35142015-11-12 14:07:09 +00004460Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
Tobias Grosserb65ccc42017-08-06 20:11:59 +00004461 isl::union_map Accesses = isl::union_map::empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004462
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004463 for (ScopStmt &Stmt : *this) {
4464 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00004465 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004466 continue;
4467
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004468 isl::set Domain = Stmt.getDomain();
4469 isl::map AccessDomain = MA->getAccessRelation();
4470 AccessDomain = AccessDomain.intersect_domain(Domain);
4471 Accesses = Accesses.add_map(AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004472 }
4473 }
Tobias Grosser206e9e32017-07-24 16:22:27 +00004474
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004475 return Accesses.coalesce();
Tobias Grossere5a35142015-11-12 14:07:09 +00004476}
4477
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004478isl::union_map Scop::getMustWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004479 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004480}
4481
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004482isl::union_map Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004483 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004484}
4485
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004486isl::union_map Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004487 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004488}
4489
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004490isl::union_map Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004491 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004492}
4493
Tobias Grosser5ab39ff2017-08-06 19:22:27 +00004494isl::union_map Scop::getAccesses() {
Tobias Grosser2ac23382015-11-12 14:07:13 +00004495 return getAccessesOfType([](MemoryAccess &MA) { return true; });
4496}
4497
Tobias Grosserfa03cb72017-08-17 22:04:53 +00004498isl::union_map Scop::getAccesses(ScopArrayInfo *Array) {
4499 return getAccessesOfType(
4500 [Array](MemoryAccess &MA) { return MA.getScopArrayInfo() == Array; });
4501}
4502
Roman Gareevb3224ad2016-09-14 06:26:09 +00004503// Check whether @p Node is an extension node.
4504//
4505// @return true if @p Node is an extension node.
4506isl_bool isNotExtNode(__isl_keep isl_schedule_node *Node, void *User) {
4507 if (isl_schedule_node_get_type(Node) == isl_schedule_node_extension)
4508 return isl_bool_error;
4509 else
4510 return isl_bool_true;
4511}
4512
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004513bool Scop::containsExtensionNode(isl::schedule Schedule) {
4514 return isl_schedule_foreach_schedule_node_top_down(
4515 Schedule.keep(), isNotExtNode, nullptr) == isl_stat_error;
Roman Gareevb3224ad2016-09-14 06:26:09 +00004516}
4517
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004518isl::union_map Scop::getSchedule() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004519 auto Tree = getScheduleTree();
4520 if (containsExtensionNode(Tree))
Roman Gareevb3224ad2016-09-14 06:26:09 +00004521 return nullptr;
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004522
4523 return Tree.get_map();
Tobias Grosser808cd692015-07-14 09:33:13 +00004524}
Tobias Grosser37eb4222014-02-20 21:43:54 +00004525
Tobias Grosser61bd3a42017-08-06 21:42:38 +00004526isl::schedule Scop::getScheduleTree() const {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004527 return Schedule.intersect_domain(getDomains());
Tobias Grosser808cd692015-07-14 09:33:13 +00004528}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00004529
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004530void Scop::setSchedule(isl::union_map NewSchedule) {
4531 auto S = isl::schedule::from_domain(getDomains());
4532 Schedule = S.insert_partial_schedule(
4533 isl::multi_union_pw_aff::from_union_map(NewSchedule));
Tobias Grosser808cd692015-07-14 09:33:13 +00004534}
4535
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004536void Scop::setScheduleTree(isl::schedule NewSchedule) {
Tobias Grosser808cd692015-07-14 09:33:13 +00004537 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004538}
4539
Tobias Grosser990cbb42017-08-14 06:49:01 +00004540bool Scop::restrictDomains(isl::union_set Domain) {
Tobias Grosser37eb4222014-02-20 21:43:54 +00004541 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004542 for (ScopStmt &Stmt : *this) {
Tobias Grosser990cbb42017-08-14 06:49:01 +00004543 isl::union_set StmtDomain = isl::union_set(Stmt.getDomain());
4544 isl::union_set NewStmtDomain = StmtDomain.intersect(Domain);
Tobias Grosser37eb4222014-02-20 21:43:54 +00004545
Tobias Grosser990cbb42017-08-14 06:49:01 +00004546 if (StmtDomain.is_subset(NewStmtDomain))
Tobias Grosser37eb4222014-02-20 21:43:54 +00004547 continue;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004548
4549 Changed = true;
4550
Tobias Grosser990cbb42017-08-14 06:49:01 +00004551 NewStmtDomain = NewStmtDomain.coalesce();
Tobias Grosser37eb4222014-02-20 21:43:54 +00004552
Tobias Grosser990cbb42017-08-14 06:49:01 +00004553 if (NewStmtDomain.is_empty())
Tobias Grosserdcf8d692017-08-06 16:39:52 +00004554 Stmt.restrictDomain(isl::set::empty(Stmt.getDomainSpace()));
Tobias Grosser990cbb42017-08-14 06:49:01 +00004555 else
4556 Stmt.restrictDomain(isl::set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004557 }
Tobias Grosser37eb4222014-02-20 21:43:54 +00004558 return Changed;
4559}
4560
Tobias Grosser75805372011-04-29 06:27:02 +00004561ScalarEvolution *Scop::getSE() const { return SE; }
4562
Tobias Grosserc80d6972016-09-02 06:33:33 +00004563// Create an isl_multi_union_aff that defines an identity mapping from the
4564// elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00004565//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004566// # Example:
4567//
4568// Domain: { A[i,j]; B[i,j,k] }
4569// N: 1
4570//
4571// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
4572//
4573// @param USet A union set describing the elements for which to generate a
4574// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00004575// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004576// @returns A mapping from USet to its N-th dimension.
Tobias Grosser99320862017-05-26 17:22:03 +00004577static isl::multi_union_pw_aff mapToDimension(isl::union_set USet, int N) {
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004578 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00004579 assert(USet);
Siddharth Bhat8bb436e2017-05-29 11:34:29 +00004580 assert(!USet.is_empty());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004581
Tobias Grosser99320862017-05-26 17:22:03 +00004582 auto Result = isl::union_pw_multi_aff::empty(USet.get_space());
Tobias Grosser808cd692015-07-14 09:33:13 +00004583
Tobias Grosser99320862017-05-26 17:22:03 +00004584 auto Lambda = [&Result, N](isl::set S) -> isl::stat {
4585 int Dim = S.dim(isl::dim::set);
4586 auto PMA = isl::pw_multi_aff::project_out_map(S.get_space(), isl::dim::set,
4587 N, Dim - N);
4588 if (N > 1)
4589 PMA = PMA.drop_dims(isl::dim::out, 0, N - 1);
Tobias Grosser808cd692015-07-14 09:33:13 +00004590
Tobias Grosser99320862017-05-26 17:22:03 +00004591 Result = Result.add_pw_multi_aff(PMA);
4592 return isl::stat::ok;
4593 };
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004594
Tobias Grosser99320862017-05-26 17:22:03 +00004595 isl::stat Res = USet.foreach_set(Lambda);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004596 (void)Res;
4597
Tobias Grosser99320862017-05-26 17:22:03 +00004598 assert(Res == isl::stat::ok);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004599
Tobias Grosser99320862017-05-26 17:22:03 +00004600 return isl::multi_union_pw_aff(isl::union_pw_multi_aff(Result));
Tobias Grosser808cd692015-07-14 09:33:13 +00004601}
4602
Michael Krused6e22082018-01-18 15:15:38 +00004603void Scop::addScopStmt(BasicBlock *BB, StringRef Name, Loop *SurroundingLoop,
4604 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004605 assert(BB && "Unexpected nullptr!");
Michael Krused6e22082018-01-18 15:15:38 +00004606 Stmts.emplace_back(*this, *BB, Name, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004607 auto *Stmt = &Stmts.back();
Michael Kruse4dfa7322017-07-18 15:41:49 +00004608 StmtMap[BB].push_back(Stmt);
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004609 for (Instruction *Inst : Instructions) {
4610 assert(!InstStmtMap.count(Inst) &&
4611 "Unexpected statement corresponding to the instruction.");
4612 InstStmtMap[Inst] = Stmt;
4613 }
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004614}
4615
Michael Krused6e22082018-01-18 15:15:38 +00004616void Scop::addScopStmt(Region *R, StringRef Name, Loop *SurroundingLoop,
Tobias Grosserbd15d132017-08-31 03:15:56 +00004617 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004618 assert(R && "Unexpected nullptr!");
Michael Krused6e22082018-01-18 15:15:38 +00004619 Stmts.emplace_back(*this, *R, Name, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004620 auto *Stmt = &Stmts.back();
Tobias Grosserbd15d132017-08-31 03:15:56 +00004621
4622 for (Instruction *Inst : Instructions) {
4623 assert(!InstStmtMap.count(Inst) &&
4624 "Unexpected statement corresponding to the instruction.");
4625 InstStmtMap[Inst] = Stmt;
4626 }
4627
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004628 for (BasicBlock *BB : R->blocks()) {
Michael Kruse4dfa7322017-07-18 15:41:49 +00004629 StmtMap[BB].push_back(Stmt);
Tobias Grosserbd15d132017-08-31 03:15:56 +00004630 if (BB == R->getEntry())
4631 continue;
Michael Krusecd3b9fe2017-08-09 16:45:37 +00004632 for (Instruction &Inst : *BB) {
4633 assert(!InstStmtMap.count(&Inst) &&
4634 "Unexpected statement corresponding to the instruction.");
4635 InstStmtMap[&Inst] = Stmt;
4636 }
4637 }
Tobias Grosser808cd692015-07-14 09:33:13 +00004638}
4639
Tobias Grosser85048ef2017-08-06 17:24:59 +00004640ScopStmt *Scop::addScopStmt(isl::map SourceRel, isl::map TargetRel,
4641 isl::set Domain) {
Tobias Grossereba86a12016-11-09 04:24:49 +00004642#ifndef NDEBUG
Tobias Grosser85048ef2017-08-06 17:24:59 +00004643 isl::set SourceDomain = SourceRel.domain();
4644 isl::set TargetDomain = TargetRel.domain();
4645 assert(Domain.is_subset(TargetDomain) &&
Tobias Grosser744740a2016-11-05 21:02:43 +00004646 "Target access not defined for complete statement domain");
Tobias Grosser85048ef2017-08-06 17:24:59 +00004647 assert(Domain.is_subset(SourceDomain) &&
Tobias Grosser744740a2016-11-05 21:02:43 +00004648 "Source access not defined for complete statement domain");
Tobias Grossereba86a12016-11-09 04:24:49 +00004649#endif
Roman Gareevb3224ad2016-09-14 06:26:09 +00004650 Stmts.emplace_back(*this, SourceRel, TargetRel, Domain);
4651 CopyStmtsNum++;
4652 return &(Stmts.back());
4653}
4654
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004655void Scop::buildSchedule(LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004656 Loop *L = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004657 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004658 buildSchedule(getRegion().getNode(), LoopStack, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004659 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4660 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004661}
4662
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004663/// To generate a schedule for the elements in a Region we traverse the Region
4664/// in reverse-post-order and add the contained RegionNodes in traversal order
4665/// to the schedule of the loop that is currently at the top of the LoopStack.
4666/// For loop-free codes, this results in a correct sequential ordering.
4667///
4668/// Example:
4669/// bb1(0)
4670/// / \.
4671/// bb2(1) bb3(2)
4672/// \ / \.
4673/// bb4(3) bb5(4)
4674/// \ /
4675/// bb6(5)
4676///
4677/// Including loops requires additional processing. Whenever a loop header is
4678/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4679/// from an empty schedule, we first process all RegionNodes that are within
4680/// this loop and complete the sequential schedule at this loop-level before
4681/// processing about any other nodes. To implement this
4682/// loop-nodes-first-processing, the reverse post-order traversal is
4683/// insufficient. Hence, we additionally check if the traversal yields
4684/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4685/// These region-nodes are then queue and only traverse after the all nodes
4686/// within the current loop have been processed.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004687void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004688 Loop *OuterScopLoop = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004689
4690 ReversePostOrderTraversal<Region *> RTraversal(R);
4691 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4692 std::deque<RegionNode *> DelayList;
4693 bool LastRNWaiting = false;
4694
4695 // Iterate over the region @p R in reverse post-order but queue
4696 // sub-regions/blocks iff they are not part of the last encountered but not
4697 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4698 // that we queued the last sub-region/block from the reverse post-order
4699 // iterator. If it is set we have to explore the next sub-region/block from
4700 // the iterator (if any) to guarantee progress. If it is not set we first try
4701 // the next queued sub-region/blocks.
4702 while (!WorkList.empty() || !DelayList.empty()) {
4703 RegionNode *RN;
4704
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004705 if ((LastRNWaiting && !WorkList.empty()) || DelayList.empty()) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004706 RN = WorkList.front();
4707 WorkList.pop_front();
4708 LastRNWaiting = false;
4709 } else {
4710 RN = DelayList.front();
4711 DelayList.pop_front();
4712 }
4713
4714 Loop *L = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00004715 if (!contains(L))
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004716 L = OuterScopLoop;
4717
Tobias Grosser151ae322016-04-03 19:36:52 +00004718 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004719 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004720 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004721 LastRNWaiting = true;
4722 DelayList.push_back(RN);
4723 continue;
4724 }
4725 LoopStack.push_back({L, nullptr, 0});
4726 }
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004727 buildSchedule(RN, LoopStack, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004728 }
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004729}
4730
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004731void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack, LoopInfo &LI) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004732 if (RN->isSubRegion()) {
4733 auto *LocalRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004734 if (!isNonAffineSubRegion(LocalRegion)) {
4735 buildSchedule(LocalRegion, LoopStack, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004736 return;
4737 }
4738 }
Michael Kruse046dde42015-08-10 13:01:57 +00004739
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004740 assert(LoopStack.rbegin() != LoopStack.rend());
4741 auto LoopData = LoopStack.rbegin();
4742 LoopData->NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004743
Michael Kruse1ce67912017-07-20 17:18:58 +00004744 for (auto *Stmt : getStmtListFor(RN)) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004745 isl::union_set UDomain{Stmt->getDomain()};
4746 auto StmtSchedule = isl::schedule::from_domain(UDomain);
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004747 LoopData->Schedule = combineInSequence(LoopData->Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004748 }
4749
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004750 // Check if we just processed the last node in this loop. If we did, finalize
4751 // the loop by:
4752 //
4753 // - adding new schedule dimensions
4754 // - folding the resulting schedule into the parent loop schedule
4755 // - dropping the loop schedule from the LoopStack.
4756 //
4757 // Then continue to check surrounding loops, which might also have been
4758 // completed by this node.
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004759 size_t Dimension = LoopStack.size();
4760 while (LoopData->L &&
4761 LoopData->NumBlocksProcessed == getNumBlocksInLoop(LoopData->L)) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004762 isl::schedule Schedule = LoopData->Schedule;
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004763 auto NumBlocksProcessed = LoopData->NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004764
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004765 assert(std::next(LoopData) != LoopStack.rend());
4766 ++LoopData;
4767 --Dimension;
Tobias Grosser8362c262016-01-06 15:30:06 +00004768
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004769 if (Schedule) {
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004770 isl::union_set Domain = Schedule.get_domain();
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004771 isl::multi_union_pw_aff MUPA = mapToDimension(Domain, Dimension);
Philip Pfaffe00fd43b2017-11-19 22:13:34 +00004772 Schedule = Schedule.insert_partial_schedule(MUPA);
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004773 LoopData->Schedule = combineInSequence(LoopData->Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004774 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004775
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004776 LoopData->NumBlocksProcessed += NumBlocksProcessed;
Tobias Grosser808cd692015-07-14 09:33:13 +00004777 }
Philip Pfaffe8dd0f472017-11-16 16:35:19 +00004778 // Now pop all loops processed up there from the LoopStack
4779 LoopStack.erase(LoopStack.begin() + Dimension, LoopStack.end());
Tobias Grosser75805372011-04-29 06:27:02 +00004780}
4781
Michael Kruse6eba4b12017-07-20 17:08:50 +00004782ArrayRef<ScopStmt *> Scop::getStmtListFor(BasicBlock *BB) const {
4783 auto StmtMapIt = StmtMap.find(BB);
4784 if (StmtMapIt == StmtMap.end())
4785 return {};
Michael Kruse6eba4b12017-07-20 17:08:50 +00004786 return StmtMapIt->second;
4787}
4788
Michael Krusea230f222018-01-23 23:56:36 +00004789ScopStmt *Scop::getIncomingStmtFor(const Use &U) const {
4790 auto *PHI = cast<PHINode>(U.getUser());
4791 BasicBlock *IncomingBB = PHI->getIncomingBlock(U);
4792
4793 // If the value is a non-synthesizable from the incoming block, use the
4794 // statement that contains it as user statement.
4795 if (auto *IncomingInst = dyn_cast<Instruction>(U.get())) {
4796 if (IncomingInst->getParent() == IncomingBB) {
4797 if (ScopStmt *IncomingStmt = getStmtFor(IncomingInst))
4798 return IncomingStmt;
4799 }
4800 }
4801
4802 // Otherwise, use the epilogue/last statement.
4803 return getLastStmtFor(IncomingBB);
4804}
4805
Michael Kruse6eba4b12017-07-20 17:08:50 +00004806ScopStmt *Scop::getLastStmtFor(BasicBlock *BB) const {
4807 ArrayRef<ScopStmt *> StmtList = getStmtListFor(BB);
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004808 if (!StmtList.empty())
Michael Kruse6eba4b12017-07-20 17:08:50 +00004809 return StmtList.back();
4810 return nullptr;
4811}
4812
Michael Kruse1ce67912017-07-20 17:18:58 +00004813ArrayRef<ScopStmt *> Scop::getStmtListFor(RegionNode *RN) const {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004814 if (RN->isSubRegion())
Michael Kruse1ce67912017-07-20 17:18:58 +00004815 return getStmtListFor(RN->getNodeAs<Region>());
4816 return getStmtListFor(RN->getNodeAs<BasicBlock>());
Michael Kruse6f7721f2016-02-24 22:08:19 +00004817}
4818
Michael Kruse1ce67912017-07-20 17:18:58 +00004819ArrayRef<ScopStmt *> Scop::getStmtListFor(Region *R) const {
4820 return getStmtListFor(R->getEntry());
Michael Krusea902ba62015-12-13 19:21:45 +00004821}
4822
Johannes Doerfert96425c22015-08-30 21:13:53 +00004823int Scop::getRelativeLoopDepth(const Loop *L) const {
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004824 if (!L || !R.contains(L))
Johannes Doerfert96425c22015-08-30 21:13:53 +00004825 return -1;
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004826 // outermostLoopInRegion always returns nullptr for top level regions
4827 if (R.isTopLevelRegion()) {
4828 // LoopInfo's depths start at 1, we start at 0
4829 return L->getLoopDepth() - 1;
4830 } else {
4831 Loop *OuterLoop = R.outermostLoopInRegion(const_cast<Loop *>(L));
4832 assert(OuterLoop);
4833 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4834 }
Johannes Doerfertd020b772015-08-27 06:53:52 +00004835}
4836
Roman Gareevd7754a12016-07-30 09:25:51 +00004837ScopArrayInfo *Scop::getArrayInfoByName(const std::string BaseName) {
4838 for (auto &SAI : arrays()) {
4839 if (SAI->getName() == BaseName)
4840 return SAI;
4841 }
4842 return nullptr;
4843}
4844
Michael Kruse8b805802017-07-19 17:11:25 +00004845void Scop::addAccessData(MemoryAccess *Access) {
4846 const ScopArrayInfo *SAI = Access->getOriginalScopArrayInfo();
4847 assert(SAI && "can only use after access relations have been constructed");
4848
4849 if (Access->isOriginalValueKind() && Access->isRead())
4850 ValueUseAccs[SAI].push_back(Access);
4851 else if (Access->isOriginalAnyPHIKind() && Access->isWrite())
4852 PHIIncomingAccs[SAI].push_back(Access);
4853}
4854
4855void Scop::removeAccessData(MemoryAccess *Access) {
Michael Kruse6d7a7892017-09-21 14:23:11 +00004856 if (Access->isOriginalValueKind() && Access->isWrite()) {
4857 ValueDefAccs.erase(Access->getAccessValue());
4858 } else if (Access->isOriginalValueKind() && Access->isRead()) {
Michael Kruse8b805802017-07-19 17:11:25 +00004859 auto &Uses = ValueUseAccs[Access->getScopArrayInfo()];
4860 std::remove(Uses.begin(), Uses.end(), Access);
Michael Kruse6d7a7892017-09-21 14:23:11 +00004861 } else if (Access->isOriginalPHIKind() && Access->isRead()) {
4862 PHINode *PHI = cast<PHINode>(Access->getAccessInstruction());
4863 PHIReadAccs.erase(PHI);
Michael Kruse8b805802017-07-19 17:11:25 +00004864 } else if (Access->isOriginalAnyPHIKind() && Access->isWrite()) {
4865 auto &Incomings = PHIIncomingAccs[Access->getScopArrayInfo()];
4866 std::remove(Incomings.begin(), Incomings.end(), Access);
4867 }
4868}
4869
4870MemoryAccess *Scop::getValueDef(const ScopArrayInfo *SAI) const {
4871 assert(SAI->isValueKind());
4872
4873 Instruction *Val = dyn_cast<Instruction>(SAI->getBasePtr());
4874 if (!Val)
4875 return nullptr;
4876
Michael Kruse6d7a7892017-09-21 14:23:11 +00004877 return ValueDefAccs.lookup(Val);
Michael Kruse8b805802017-07-19 17:11:25 +00004878}
4879
4880ArrayRef<MemoryAccess *> Scop::getValueUses(const ScopArrayInfo *SAI) const {
4881 assert(SAI->isValueKind());
4882 auto It = ValueUseAccs.find(SAI);
4883 if (It == ValueUseAccs.end())
4884 return {};
4885 return It->second;
4886}
4887
4888MemoryAccess *Scop::getPHIRead(const ScopArrayInfo *SAI) const {
4889 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
4890
4891 if (SAI->isExitPHIKind())
4892 return nullptr;
4893
4894 PHINode *PHI = cast<PHINode>(SAI->getBasePtr());
Michael Kruse6d7a7892017-09-21 14:23:11 +00004895 return PHIReadAccs.lookup(PHI);
Michael Kruse8b805802017-07-19 17:11:25 +00004896}
4897
4898ArrayRef<MemoryAccess *> Scop::getPHIIncomings(const ScopArrayInfo *SAI) const {
4899 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
4900 auto It = PHIIncomingAccs.find(SAI);
4901 if (It == PHIIncomingAccs.end())
4902 return {};
4903 return It->second;
4904}
4905
Michael Krusea508a4e2017-07-27 14:39:52 +00004906bool Scop::isEscaping(Instruction *Inst) {
4907 assert(contains(Inst) && "The concept of escaping makes only sense for "
4908 "values defined inside the SCoP");
4909
4910 for (Use &Use : Inst->uses()) {
4911 BasicBlock *UserBB = getUseBlock(Use);
4912 if (!contains(UserBB))
4913 return true;
4914
4915 // When the SCoP region exit needs to be simplified, PHIs in the region exit
4916 // move to a new basic block such that its incoming blocks are not in the
4917 // SCoP anymore.
4918 if (hasSingleExitEdge() && isa<PHINode>(Use.getUser()) &&
4919 isExit(cast<PHINode>(Use.getUser())->getParent()))
4920 return true;
4921 }
4922 return false;
4923}
4924
Michael Kruse06ed5292017-08-23 13:50:30 +00004925Scop::ScopStatistics Scop::getStatistics() const {
4926 ScopStatistics Result;
4927#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
4928 auto LoopStat = ScopDetection::countBeneficialLoops(&R, *SE, *getLI(), 0);
4929
4930 int NumTotalLoops = LoopStat.NumLoops;
4931 Result.NumBoxedLoops = getBoxedLoops().size();
4932 Result.NumAffineLoops = NumTotalLoops - Result.NumBoxedLoops;
4933
4934 for (const ScopStmt &Stmt : *this) {
4935 isl::set Domain = Stmt.getDomain().intersect_params(getContext());
4936 bool IsInLoop = Stmt.getNumIterators() >= 1;
4937 for (MemoryAccess *MA : Stmt) {
4938 if (!MA->isWrite())
4939 continue;
4940
4941 if (MA->isLatestValueKind()) {
4942 Result.NumValueWrites += 1;
4943 if (IsInLoop)
4944 Result.NumValueWritesInLoops += 1;
4945 }
4946
4947 if (MA->isLatestAnyPHIKind()) {
4948 Result.NumPHIWrites += 1;
4949 if (IsInLoop)
4950 Result.NumPHIWritesInLoops += 1;
4951 }
4952
4953 isl::set AccSet =
4954 MA->getAccessRelation().intersect_domain(Domain).range();
4955 if (AccSet.is_singleton()) {
4956 Result.NumSingletonWrites += 1;
4957 if (IsInLoop)
4958 Result.NumSingletonWritesInLoops += 1;
4959 }
4960 }
4961 }
4962#endif
4963 return Result;
4964}
4965
Eugene Zelenko0c4c2ce2017-08-22 21:25:51 +00004966raw_ostream &polly::operator<<(raw_ostream &OS, const Scop &scop) {
4967 scop.print(OS, PollyPrintInstructions);
4968 return OS;
Michael Krusecd4c9772017-07-21 15:35:53 +00004969}
4970
Johannes Doerfert99191c72016-05-31 09:41:04 +00004971//===----------------------------------------------------------------------===//
4972void ScopInfoRegionPass::getAnalysisUsage(AnalysisUsage &AU) const {
4973 AU.addRequired<LoopInfoWrapperPass>();
4974 AU.addRequired<RegionInfoPass>();
4975 AU.addRequired<DominatorTreeWrapperPass>();
4976 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00004977 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004978 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00004979 AU.addRequired<AssumptionCacheTracker>();
Michael Krusea4f447c2017-08-28 14:07:33 +00004980 AU.addRequired<OptimizationRemarkEmitterWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004981 AU.setPreservesAll();
4982}
4983
Michael Kruse06ed5292017-08-23 13:50:30 +00004984void updateLoopCountStatistic(ScopDetection::LoopStats Stats,
4985 Scop::ScopStatistics ScopStats) {
4986 assert(Stats.NumLoops == ScopStats.NumAffineLoops + ScopStats.NumBoxedLoops);
4987
4988 NumScops++;
Tobias Grossercd01a362017-02-17 08:12:36 +00004989 NumLoopsInScop += Stats.NumLoops;
4990 MaxNumLoopsInScop =
4991 std::max(MaxNumLoopsInScop.getValue(), (unsigned)Stats.NumLoops);
4992
Tobias Grossercd01a362017-02-17 08:12:36 +00004993 if (Stats.MaxDepth == 1)
4994 NumScopsDepthOne++;
4995 else if (Stats.MaxDepth == 2)
4996 NumScopsDepthTwo++;
4997 else if (Stats.MaxDepth == 3)
4998 NumScopsDepthThree++;
4999 else if (Stats.MaxDepth == 4)
5000 NumScopsDepthFour++;
5001 else if (Stats.MaxDepth == 5)
5002 NumScopsDepthFive++;
5003 else
5004 NumScopsDepthLarger++;
Michael Kruse06ed5292017-08-23 13:50:30 +00005005
5006 NumAffineLoops += ScopStats.NumAffineLoops;
5007 NumBoxedLoops += ScopStats.NumBoxedLoops;
5008
5009 NumValueWrites += ScopStats.NumValueWrites;
5010 NumValueWritesInLoops += ScopStats.NumValueWritesInLoops;
5011 NumPHIWrites += ScopStats.NumPHIWrites;
5012 NumPHIWritesInLoops += ScopStats.NumPHIWritesInLoops;
5013 NumSingletonWrites += ScopStats.NumSingletonWrites;
5014 NumSingletonWritesInLoops += ScopStats.NumSingletonWritesInLoops;
Tobias Grossercd01a362017-02-17 08:12:36 +00005015}
5016
Johannes Doerfert99191c72016-05-31 09:41:04 +00005017bool ScopInfoRegionPass::runOnRegion(Region *R, RGPassManager &RGM) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005018 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005019
5020 if (!SD.isMaxRegionInScop(*R))
5021 return false;
5022
5023 Function *F = R->getEntry()->getParent();
5024 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5025 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5026 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5027 auto const &DL = F->getParent()->getDataLayout();
5028 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005029 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krusea4f447c2017-08-28 14:07:33 +00005030 auto &ORE = getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005031
Michael Krusea4f447c2017-08-28 14:07:33 +00005032 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE, ORE);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005033 S = SB.getScop(); // take ownership of scop object
Tobias Grossercd01a362017-02-17 08:12:36 +00005034
Michael Kruse06ed5292017-08-23 13:50:30 +00005035#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
Tobias Grossercd01a362017-02-17 08:12:36 +00005036 if (S) {
5037 ScopDetection::LoopStats Stats =
5038 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
Michael Kruse06ed5292017-08-23 13:50:30 +00005039 updateLoopCountStatistic(Stats, S->getStatistics());
Tobias Grossercd01a362017-02-17 08:12:36 +00005040 }
Michael Kruse06ed5292017-08-23 13:50:30 +00005041#endif
Tobias Grossercd01a362017-02-17 08:12:36 +00005042
Tobias Grosser75805372011-04-29 06:27:02 +00005043 return false;
5044}
5045
Johannes Doerfert99191c72016-05-31 09:41:04 +00005046void ScopInfoRegionPass::print(raw_ostream &OS, const Module *) const {
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005047 if (S)
Michael Krusecd4c9772017-07-21 15:35:53 +00005048 S->print(OS, PollyPrintInstructions);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005049 else
5050 OS << "Invalid Scop!\n";
Johannes Doerfert99191c72016-05-31 09:41:04 +00005051}
Tobias Grosser75805372011-04-29 06:27:02 +00005052
Johannes Doerfert99191c72016-05-31 09:41:04 +00005053char ScopInfoRegionPass::ID = 0;
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005054
Johannes Doerfert99191c72016-05-31 09:41:04 +00005055Pass *polly::createScopInfoRegionPassPass() { return new ScopInfoRegionPass(); }
5056
5057INITIALIZE_PASS_BEGIN(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005058 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005059 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00005060INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005061INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00005062INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00005063INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00005064INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005065INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert96425c22015-08-30 21:13:53 +00005066INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005067INITIALIZE_PASS_END(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005068 "Polly - Create polyhedral description of Scops", false,
5069 false)
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005070
5071//===----------------------------------------------------------------------===//
Philip Pfaffe838e0882017-05-15 12:55:14 +00005072ScopInfo::ScopInfo(const DataLayout &DL, ScopDetection &SD, ScalarEvolution &SE,
5073 LoopInfo &LI, AliasAnalysis &AA, DominatorTree &DT,
Michael Krusea4f447c2017-08-28 14:07:33 +00005074 AssumptionCache &AC, OptimizationRemarkEmitter &ORE)
5075 : DL(DL), SD(SD), SE(SE), LI(LI), AA(AA), DT(DT), AC(AC), ORE(ORE) {
Philip Pfaffef43e7c22017-08-10 07:43:46 +00005076 recompute();
5077}
5078
5079void ScopInfo::recompute() {
5080 RegionToScopMap.clear();
Michael Krusea6d48f52017-06-08 12:06:15 +00005081 /// Create polyhedral description of scops for all the valid regions of a
Philip Pfaffe838e0882017-05-15 12:55:14 +00005082 /// function.
5083 for (auto &It : SD) {
5084 Region *R = const_cast<Region *>(It);
5085 if (!SD.isMaxRegionInScop(*R))
5086 continue;
5087
Michael Krusea4f447c2017-08-28 14:07:33 +00005088 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE, ORE);
Philip Pfaffe838e0882017-05-15 12:55:14 +00005089 std::unique_ptr<Scop> S = SB.getScop();
5090 if (!S)
5091 continue;
Michael Kruse06ed5292017-08-23 13:50:30 +00005092#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
Philip Pfaffeead67db2017-08-02 11:14:41 +00005093 ScopDetection::LoopStats Stats =
5094 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
Michael Kruse06ed5292017-08-23 13:50:30 +00005095 updateLoopCountStatistic(Stats, S->getStatistics());
5096#endif
Philip Pfaffe838e0882017-05-15 12:55:14 +00005097 bool Inserted = RegionToScopMap.insert({R, std::move(S)}).second;
5098 assert(Inserted && "Building Scop for the same region twice!");
5099 (void)Inserted;
5100 }
5101}
5102
Philip Pfaffef43e7c22017-08-10 07:43:46 +00005103bool ScopInfo::invalidate(Function &F, const PreservedAnalyses &PA,
5104 FunctionAnalysisManager::Invalidator &Inv) {
5105 // Check whether the analysis, all analyses on functions have been preserved
5106 // or anything we're holding references to is being invalidated
5107 auto PAC = PA.getChecker<ScopInfoAnalysis>();
5108 return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) ||
5109 Inv.invalidate<ScopAnalysis>(F, PA) ||
5110 Inv.invalidate<ScalarEvolutionAnalysis>(F, PA) ||
5111 Inv.invalidate<LoopAnalysis>(F, PA) ||
5112 Inv.invalidate<AAManager>(F, PA) ||
5113 Inv.invalidate<DominatorTreeAnalysis>(F, PA) ||
5114 Inv.invalidate<AssumptionAnalysis>(F, PA);
5115}
5116
Philip Pfaffe838e0882017-05-15 12:55:14 +00005117AnalysisKey ScopInfoAnalysis::Key;
5118
5119ScopInfoAnalysis::Result ScopInfoAnalysis::run(Function &F,
5120 FunctionAnalysisManager &FAM) {
5121 auto &SD = FAM.getResult<ScopAnalysis>(F);
5122 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
5123 auto &LI = FAM.getResult<LoopAnalysis>(F);
5124 auto &AA = FAM.getResult<AAManager>(F);
5125 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
5126 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
5127 auto &DL = F.getParent()->getDataLayout();
Michael Krusea4f447c2017-08-28 14:07:33 +00005128 auto &ORE = FAM.getResult<OptimizationRemarkEmitterAnalysis>(F);
5129 return {DL, SD, SE, LI, AA, DT, AC, ORE};
Philip Pfaffe838e0882017-05-15 12:55:14 +00005130}
5131
5132PreservedAnalyses ScopInfoPrinterPass::run(Function &F,
5133 FunctionAnalysisManager &FAM) {
5134 auto &SI = FAM.getResult<ScopInfoAnalysis>(F);
Philip Pfaffe96d21432017-08-04 11:28:51 +00005135 // Since the legacy PM processes Scops in bottom up, we print them in reverse
5136 // order here to keep the output persistent
5137 for (auto &It : reverse(SI)) {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005138 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005139 It.second->print(Stream, PollyPrintInstructions);
Philip Pfaffe838e0882017-05-15 12:55:14 +00005140 else
5141 Stream << "Invalid Scop!\n";
5142 }
5143 return PreservedAnalyses::all();
5144}
5145
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005146void ScopInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
5147 AU.addRequired<LoopInfoWrapperPass>();
5148 AU.addRequired<RegionInfoPass>();
5149 AU.addRequired<DominatorTreeWrapperPass>();
5150 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005151 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005152 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005153 AU.addRequired<AssumptionCacheTracker>();
Michael Krusea4f447c2017-08-28 14:07:33 +00005154 AU.addRequired<OptimizationRemarkEmitterWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005155 AU.setPreservesAll();
5156}
5157
5158bool ScopInfoWrapperPass::runOnFunction(Function &F) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005159 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005160 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5161 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5162 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5163 auto const &DL = F.getParent()->getDataLayout();
5164 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005165 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Michael Krusea4f447c2017-08-28 14:07:33 +00005166 auto &ORE = getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005167
Michael Krusea4f447c2017-08-28 14:07:33 +00005168 Result.reset(new ScopInfo{DL, SD, SE, LI, AA, DT, AC, ORE});
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005169 return false;
5170}
5171
5172void ScopInfoWrapperPass::print(raw_ostream &OS, const Module *) const {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005173 for (auto &It : *Result) {
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005174 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005175 It.second->print(OS, PollyPrintInstructions);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005176 else
5177 OS << "Invalid Scop!\n";
5178 }
5179}
5180
5181char ScopInfoWrapperPass::ID = 0;
5182
5183Pass *polly::createScopInfoWrapperPassPass() {
5184 return new ScopInfoWrapperPass();
5185}
5186
5187INITIALIZE_PASS_BEGIN(
5188 ScopInfoWrapperPass, "polly-function-scops",
5189 "Polly - Create polyhedral description of all Scops of a function", false,
5190 false);
5191INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005192INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005193INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
5194INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
5195INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005196INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005197INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
5198INITIALIZE_PASS_END(
5199 ScopInfoWrapperPass, "polly-function-scops",
5200 "Polly - Create polyhedral description of all Scops of a function", false,
5201 false)