blob: 49a49f1fe1a4b3b9c06270c1f088c6fd19b41cf0 [file] [log] [blame]
Michael Kruse2133cb92016-06-28 01:37:20 +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"
Tobias Grosser75805372011-04-29 06:27:02 +000024#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000025#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000026#include "polly/Support/ScopHelper.h"
Tobias Grosser9737c7b2015-11-22 11:06:51 +000027#include "llvm/ADT/DepthFirstIterator.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000028#include "llvm/ADT/MapVector.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000029#include "llvm/ADT/PostOrderIterator.h"
30#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000031#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000032#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000033#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000034#include "llvm/Analysis/AliasAnalysis.h"
Michael Kruse89b1f942017-03-17 13:56:53 +000035#include "llvm/Analysis/AssumptionCache.h"
Johannes Doerfert1dc12af2016-04-23 12:59:18 +000036#include "llvm/Analysis/Loads.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000037#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000038#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000039#include "llvm/Analysis/RegionIterator.h"
40#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000041#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000042#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000043#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000044#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000045#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000046#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000047#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000048#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000049#include "isl/schedule.h"
50#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000051#include "isl/set.h"
52#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000053#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000054#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000055#include <sstream>
56#include <string>
57#include <vector>
58
59using namespace llvm;
60using namespace polly;
61
Chandler Carruth95fef942014-04-22 03:30:19 +000062#define DEBUG_TYPE "polly-scops"
63
Johannes Doerfert81aa6e82016-11-18 14:37:08 +000064STATISTIC(AssumptionsAliasing, "Number of aliasing assumptions taken.");
65STATISTIC(AssumptionsInbounds, "Number of inbounds assumptions taken.");
66STATISTIC(AssumptionsWrapping, "Number of wrapping assumptions taken.");
67STATISTIC(AssumptionsUnsigned, "Number of unsigned assumptions taken.");
68STATISTIC(AssumptionsComplexity, "Number of too complex SCoPs.");
69STATISTIC(AssumptionsUnprofitable, "Number of unprofitable SCoPs.");
70STATISTIC(AssumptionsErrorBlock, "Number of error block assumptions taken.");
71STATISTIC(AssumptionsInfiniteLoop, "Number of bounded loop assumptions taken.");
72STATISTIC(AssumptionsInvariantLoad,
Johannes Doerfertcd195322016-11-17 21:41:08 +000073 "Number of invariant loads assumptions taken.");
Johannes Doerfert81aa6e82016-11-18 14:37:08 +000074STATISTIC(AssumptionsDelinearization,
Johannes Doerfertcd195322016-11-17 21:41:08 +000075 "Number of delinearization assumptions taken.");
76
Tobias Grossercd01a362017-02-17 08:12:36 +000077STATISTIC(NumLoopsInScop, "Number of loops in scops");
78STATISTIC(NumScopsDepthOne, "Number of scops with maximal loop depth 1");
79STATISTIC(NumScopsDepthTwo, "Number of scops with maximal loop depth 2");
80STATISTIC(NumScopsDepthThree, "Number of scops with maximal loop depth 3");
81STATISTIC(NumScopsDepthFour, "Number of scops with maximal loop depth 4");
82STATISTIC(NumScopsDepthFive, "Number of scops with maximal loop depth 5");
83STATISTIC(NumScopsDepthLarger,
84 "Number of scops with maximal loop depth 6 and larger");
85STATISTIC(MaxNumLoopsInScop, "Maximal number of loops in scops");
86
Tobias Grosser75dc40c2015-12-20 13:31:48 +000087// The maximal number of basic sets we allow during domain construction to
88// be created. More complex scops will result in very high compile time and
89// are also unlikely to result in good code
Tobias Grosser90411a92017-02-16 19:11:33 +000090static int const MaxDisjunctsInDomain = 20;
Tobias Grosser75dc40c2015-12-20 13:31:48 +000091
Tobias Grosserc8a82762017-02-16 19:11:25 +000092// The number of disjunct in the context after which we stop to add more
93// disjuncts. This parameter is there to avoid exponential growth in the
94// number of disjunct when adding non-convex sets to the context.
95static int const MaxDisjunctsInContext = 4;
96
Tobias Grosser97715842017-05-19 04:01:52 +000097static cl::opt<int>
98 OptComputeOut("polly-analysis-computeout",
99 cl::desc("Bound the scop analysis by a maximal amount of "
100 "computational steps (0 means no bound)"),
Tobias Grosser57a1d362017-06-23 08:05:27 +0000101 cl::Hidden, cl::init(800000), cl::ZeroOrMore,
Tobias Grosser97715842017-05-19 04:01:52 +0000102 cl::cat(PollyCategory));
Tobias Grosser45e9fd12017-05-19 03:45:00 +0000103
Johannes Doerfert2f705842016-04-12 16:09:44 +0000104static cl::opt<bool> PollyRemarksMinimal(
105 "polly-remarks-minimal",
106 cl::desc("Do not emit remarks about assumptions that are known"),
107 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
108
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +0000109// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +0000110// operations can overflow easily. Additive reductions and bit operations
111// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +0000112static cl::opt<bool> DisableMultiplicativeReductions(
113 "polly-disable-multiplicative-reductions",
114 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
115 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +0000116
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +0000117static cl::opt<int> RunTimeChecksMaxAccessDisjuncts(
118 "polly-rtc-max-array-disjuncts",
119 cl::desc("The maximal number of disjunts allowed in memory accesses to "
120 "to build RTCs."),
121 cl::Hidden, cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
122
Johannes Doerfert9143d672014-09-27 11:02:39 +0000123static cl::opt<unsigned> RunTimeChecksMaxParameters(
124 "polly-rtc-max-parameters",
125 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
126 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
127
Tobias Grosser71500722015-03-28 15:11:14 +0000128static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
129 "polly-rtc-max-arrays-per-group",
130 cl::desc("The maximal number of arrays to compare in each alias group."),
131 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Johannes Doerfert5210da52016-06-02 11:06:54 +0000132
Tobias Grosser8a9c2352015-08-16 10:19:29 +0000133static cl::opt<std::string> UserContextStr(
134 "polly-context", cl::value_desc("isl parameter set"),
135 cl::desc("Provide additional constraints on the context parameters"),
136 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +0000137
Tobias Grosserd83b8a82015-08-20 19:08:11 +0000138static cl::opt<bool> DetectReductions("polly-detect-reductions",
139 cl::desc("Detect and exploit reductions"),
140 cl::Hidden, cl::ZeroOrMore,
141 cl::init(true), cl::cat(PollyCategory));
142
Tobias Grosser2937b592016-04-29 11:43:20 +0000143static cl::opt<bool>
144 IslOnErrorAbort("polly-on-isl-error-abort",
145 cl::desc("Abort if an isl error is encountered"),
146 cl::init(true), cl::cat(PollyCategory));
147
Tobias Grosserd7c49752017-02-28 09:45:54 +0000148static cl::opt<bool> PollyPreciseInbounds(
149 "polly-precise-inbounds",
150 cl::desc("Take more precise inbounds assumptions (do not scale well)"),
151 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
152
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000153static cl::opt<bool>
154 PollyIgnoreInbounds("polly-ignore-inbounds",
155 cl::desc("Do not take inbounds assumptions at all"),
156 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
157
Tobias Grosser5842dee2017-03-17 13:00:53 +0000158static cl::opt<bool> PollyIgnoreParamBounds(
159 "polly-ignore-parameter-bounds",
160 cl::desc(
161 "Do not add parameter bounds and do no gist simplify sets accordingly"),
162 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
163
Tobias Grosserc2f15102017-03-01 21:11:27 +0000164static cl::opt<bool> PollyPreciseFoldAccesses(
165 "polly-precise-fold-accesses",
Michael Kruse6e7854a2017-04-03 12:03:38 +0000166 cl::desc("Fold memory accesses to model more possible delinearizations "
167 "(does not scale well)"),
Tobias Grosserc2f15102017-03-01 21:11:27 +0000168 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000169
Michael Kruse5ae08c02017-05-06 14:03:58 +0000170bool polly::UseInstructionNames;
171static cl::opt<bool, true> XUseInstructionNames(
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000172 "polly-use-llvm-names",
Michael Kruse5ae08c02017-05-06 14:03:58 +0000173 cl::desc("Use LLVM-IR names when deriving statement names"),
174 cl::location(UseInstructionNames), cl::Hidden, cl::init(false),
175 cl::ZeroOrMore, cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000176
Tobias Grosserd5fcbef2017-05-27 04:40:18 +0000177static cl::opt<bool> PollyPrintInstructions(
178 "polly-print-instructions", cl::desc("Output instructions per ScopStmt"),
179 cl::Hidden, cl::Optional, cl::init(false), cl::cat(PollyCategory));
180
Michael Kruse7bf39442015-09-10 12:46:52 +0000181//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000182
Michael Kruse046dde42015-08-10 13:01:57 +0000183// Create a sequence of two schedules. Either argument may be null and is
184// interpreted as the empty schedule. Can also return null if both schedules are
185// empty.
186static __isl_give isl_schedule *
187combineInSequence(__isl_take isl_schedule *Prev,
188 __isl_take isl_schedule *Succ) {
189 if (!Prev)
190 return Succ;
191 if (!Succ)
192 return Prev;
193
194 return isl_schedule_sequence(Prev, Succ);
195}
196
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000197static isl::set addRangeBoundsToSet(isl::set S, const ConstantRange &Range,
198 int dim, isl::dim type) {
199 isl::val V;
200 isl::ctx Ctx = S.get_ctx();
Johannes Doerferte7044942015-02-24 11:58:30 +0000201
Tobias Grosser3281f602017-02-16 18:39:14 +0000202 // The upper and lower bound for a parameter value is derived either from
203 // the data type of the parameter or from the - possibly more restrictive -
204 // range metadata.
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000205 V = valFromAPInt(Ctx.get(), Range.getSignedMin(), true);
206 S = S.lower_bound_val(type, dim, V);
207 V = valFromAPInt(Ctx.get(), Range.getSignedMax(), true);
208 S = S.upper_bound_val(type, dim, V);
Johannes Doerferte7044942015-02-24 11:58:30 +0000209
Tobias Grosser3281f602017-02-16 18:39:14 +0000210 if (Range.isFullSet())
211 return S;
212
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000213 if (isl_set_n_basic_set(S.get()) > MaxDisjunctsInContext)
Tobias Grosserc8a82762017-02-16 19:11:25 +0000214 return S;
215
Tobias Grosser3281f602017-02-16 18:39:14 +0000216 // In case of signed wrapping, we can refine the set of valid values by
217 // excluding the part not covered by the wrapping range.
218 if (Range.isSignWrappedSet()) {
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000219 V = valFromAPInt(Ctx.get(), Range.getLower(), true);
220 isl::set SLB = S.lower_bound_val(type, dim, V);
Tobias Grosser3281f602017-02-16 18:39:14 +0000221
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000222 V = valFromAPInt(Ctx.get(), Range.getUpper(), true);
223 V = V.sub_ui(1);
224 isl::set SUB = S.upper_bound_val(type, dim, V);
225 S = SLB.unite(SUB);
Tobias Grosser3281f602017-02-16 18:39:14 +0000226 }
Johannes Doerferte7044942015-02-24 11:58:30 +0000227
Tobias Grosser3281f602017-02-16 18:39:14 +0000228 return S;
Johannes Doerferte7044942015-02-24 11:58:30 +0000229}
230
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000231static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
232 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
233 if (!BasePtrLI)
234 return nullptr;
235
Johannes Doerfert952b5302016-05-23 12:40:48 +0000236 if (!S->contains(BasePtrLI))
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000237 return nullptr;
238
239 ScalarEvolution &SE = *S->getSE();
240
241 auto *OriginBaseSCEV =
242 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
243 if (!OriginBaseSCEV)
244 return nullptr;
245
246 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
247 if (!OriginBaseSCEVUnknown)
248 return nullptr;
249
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000250 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000251 MemoryKind::Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000252}
253
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000254ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Hongbin Zheng6aded2a2017-01-15 16:47:26 +0000255 ArrayRef<const SCEV *> Sizes, MemoryKind Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +0000256 const DataLayout &DL, Scop *S,
257 const char *BaseName)
Michael Kruseb738ffa2017-06-28 13:02:43 +0000258 : BasePtr(BasePtr), ElementType(ElementType), IsOnHeap(false), Kind(Kind),
259 DL(DL), S(*S), FAD(nullptr) {
Tobias Grosser92245222015-07-28 14:53:44 +0000260 std::string BasePtrName =
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000261 BaseName ? BaseName
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000262 : getIslCompatibleName("MemRef", BasePtr, S->getNextArrayIdx(),
263 Kind == MemoryKind::PHI ? "__phi" : "",
264 UseInstructionNames);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000265 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000266
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000267 updateSizes(Sizes);
Roman Gareevd7754a12016-07-30 09:25:51 +0000268
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000269 if (!BasePtr || Kind != MemoryKind::Array) {
Roman Gareevd7754a12016-07-30 09:25:51 +0000270 BasePtrOriginSAI = nullptr;
271 return;
272 }
273
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000274 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
275 if (BasePtrOriginSAI)
276 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000277}
278
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000279__isl_give isl_space *ScopArrayInfo::getSpace() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000280 auto *Space =
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000281 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
282 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
283 return Space;
284}
285
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000286bool ScopArrayInfo::isReadOnly() {
Tobias Grosser2ade9862017-05-23 06:41:04 +0000287 isl::union_set WriteSet = give(S.getWrites()).range();
288 isl::space Space = give(getSpace());
289 WriteSet = WriteSet.extract_set(Space);
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000290
Tobias Grosser2ade9862017-05-23 06:41:04 +0000291 return bool(WriteSet.is_empty());
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000292}
293
Tobias Grosserf3adab42017-05-10 10:59:58 +0000294bool ScopArrayInfo::isCompatibleWith(const ScopArrayInfo *Array) const {
295 if (Array->getElementType() != getElementType())
296 return false;
297
298 if (Array->getNumberOfDimensions() != getNumberOfDimensions())
299 return false;
300
301 for (unsigned i = 0; i < getNumberOfDimensions(); i++)
302 if (Array->getDimensionSize(i) != getDimensionSize(i))
303 return false;
304
305 return true;
306}
307
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000308void ScopArrayInfo::updateElementType(Type *NewElementType) {
309 if (NewElementType == ElementType)
310 return;
311
Tobias Grosserd840fc72016-02-04 13:18:42 +0000312 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
313 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
314
Johannes Doerferta7920982016-02-25 14:08:48 +0000315 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000316 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000317
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000318 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
319 ElementType = NewElementType;
320 } else {
321 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
322 ElementType = IntegerType::get(ElementType->getContext(), GCD);
323 }
324}
325
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000326/// Make the ScopArrayInfo model a Fortran Array
327void ScopArrayInfo::applyAndSetFAD(Value *FAD) {
328 assert(FAD && "got invalid Fortran array descriptor");
329 if (this->FAD) {
330 assert(this->FAD == FAD &&
331 "receiving different array descriptors for same array");
332 return;
333 }
334
335 assert(DimensionSizesPw.size() > 0 && !DimensionSizesPw[0]);
336 assert(!this->FAD);
337 this->FAD = FAD;
338
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000339 isl::space Space(S.getIslCtx(), 1, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000340
341 std::string param_name = getName();
342 param_name += "_fortranarr_size";
343 // TODO: see if we need to add `this` as the id user pointer
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000344 isl::id IdPwAff = isl::id::alloc(S.getIslCtx(), param_name.c_str(), nullptr);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000345
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000346 Space = Space.set_dim_id(isl::dim::param, 0, IdPwAff);
347 isl::pw_aff PwAff =
348 isl::aff::var_on_domain(isl::local_space(Space), isl::dim::param, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000349
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000350 DimensionSizesPw[0] = PwAff.release();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000351}
352
Tobias Grosserbedef002016-12-02 08:10:56 +0000353bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes,
354 bool CheckConsistency) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000355 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
356 int ExtraDimsNew = NewSizes.size() - SharedDims;
357 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Roman Gareevf5aff702016-09-12 17:08:31 +0000358
Tobias Grosserbedef002016-12-02 08:10:56 +0000359 if (CheckConsistency) {
360 for (int i = 0; i < SharedDims; i++) {
361 auto *NewSize = NewSizes[i + ExtraDimsNew];
362 auto *KnownSize = DimensionSizes[i + ExtraDimsOld];
363 if (NewSize && KnownSize && NewSize != KnownSize)
364 return false;
365 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000366
Tobias Grosserbedef002016-12-02 08:10:56 +0000367 if (DimensionSizes.size() >= NewSizes.size())
368 return true;
369 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000370
371 DimensionSizes.clear();
372 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
373 NewSizes.end());
374 for (isl_pw_aff *Size : DimensionSizesPw)
375 isl_pw_aff_free(Size);
376 DimensionSizesPw.clear();
377 for (const SCEV *Expr : DimensionSizes) {
Roman Gareevf5aff702016-09-12 17:08:31 +0000378 if (!Expr) {
379 DimensionSizesPw.push_back(nullptr);
380 continue;
381 }
Johannes Doerfertac9c32e2016-04-23 14:31:17 +0000382 isl_pw_aff *Size = S.getPwAffOnly(Expr);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000383 DimensionSizesPw.push_back(Size);
384 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000385 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000386}
387
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000388ScopArrayInfo::~ScopArrayInfo() {
389 isl_id_free(Id);
390 for (isl_pw_aff *Size : DimensionSizesPw)
391 isl_pw_aff_free(Size);
392}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000393
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000394std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
395
396int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000397 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000398}
399
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +0000400__isl_give isl_id *ScopArrayInfo::getBasePtrId() const {
401 return isl_id_copy(Id);
402}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000403
404void ScopArrayInfo::dump() const { print(errs()); }
405
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000406void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000407 OS.indent(8) << *getElementType() << " " << getName();
Roman Gareevf5aff702016-09-12 17:08:31 +0000408 unsigned u = 0;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000409 // If this is a Fortran array, then we can print the outermost dimension
410 // as a isl_pw_aff even though there is no SCEV information.
411 bool IsOutermostSizeKnown = SizeAsPwAff && FAD;
412
413 if (!IsOutermostSizeKnown && getNumberOfDimensions() > 0 &&
414 !getDimensionSize(0)) {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000415 OS << "[*]";
Roman Gareevf5aff702016-09-12 17:08:31 +0000416 u++;
417 }
418 for (; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000419 OS << "[";
420
Tobias Grosser26253842015-11-10 14:24:21 +0000421 if (SizeAsPwAff) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000422 auto *Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000423 OS << " " << Size << " ";
424 isl_pw_aff_free(Size);
425 } else {
426 OS << *getDimensionSize(u);
427 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000428
429 OS << "]";
430 }
431
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000432 OS << ";";
433
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000434 if (BasePtrOriginSAI)
435 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
436
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000437 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000438}
439
440const ScopArrayInfo *
441ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
442 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
443 assert(Id && "Output dimension didn't have an ID");
444 return getFromId(Id);
445}
446
Michael Krused56b90a2016-09-01 09:03:27 +0000447const ScopArrayInfo *ScopArrayInfo::getFromId(__isl_take isl_id *Id) {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000448 void *User = isl_id_get_user(Id);
449 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
450 isl_id_free(Id);
451 return SAI;
452}
453
Michael Kruse3b425ff2016-04-11 14:34:08 +0000454void MemoryAccess::wrapConstantDimensions() {
455 auto *SAI = getScopArrayInfo();
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000456 isl::space ArraySpace = give(SAI->getSpace());
457 isl::ctx Ctx = ArraySpace.get_ctx();
Michael Kruse3b425ff2016-04-11 14:34:08 +0000458 unsigned DimsArray = SAI->getNumberOfDimensions();
459
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000460 isl::multi_aff DivModAff = isl::multi_aff::identity(
461 ArraySpace.map_from_domain_and_range(ArraySpace));
462 isl::local_space LArraySpace = isl::local_space(ArraySpace);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000463
464 // Begin with last dimension, to iteratively carry into higher dimensions.
465 for (int i = DimsArray - 1; i > 0; i--) {
466 auto *DimSize = SAI->getDimensionSize(i);
467 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
468
469 // This transformation is not applicable to dimensions with dynamic size.
470 if (!DimSizeCst)
471 continue;
472
Tobias Grosserca2cfd02017-02-17 04:48:52 +0000473 // This transformation is not applicable to dimensions of size zero.
474 if (DimSize->isZero())
475 continue;
476
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000477 isl::val DimSizeVal =
478 valFromAPInt(Ctx.get(), DimSizeCst->getAPInt(), false);
479 isl::aff Var = isl::aff::var_on_domain(LArraySpace, isl::dim::set, i);
480 isl::aff PrevVar =
481 isl::aff::var_on_domain(LArraySpace, isl::dim::set, i - 1);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000482
483 // Compute: index % size
484 // Modulo must apply in the divide of the previous iteration, if any.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000485 isl::aff Modulo = Var.mod_val(DimSizeVal);
486 Modulo = Modulo.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000487
488 // Compute: floor(index / size)
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000489 isl::aff Divide = Var.div(isl::aff(LArraySpace, DimSizeVal));
490 Divide = Divide.floor();
491 Divide = Divide.add(PrevVar);
492 Divide = Divide.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000493
494 // Apply Modulo and Divide.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000495 DivModAff = DivModAff.set_aff(i, Modulo);
496 DivModAff = DivModAff.set_aff(i - 1, Divide);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000497 }
498
499 // Apply all modulo/divides on the accesses.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000500 isl::map Relation = give(AccessRelation);
501 Relation = Relation.apply_range(isl::map::from_multi_aff(DivModAff));
502 Relation = Relation.detect_equalities();
503 AccessRelation = Relation.release();
Michael Kruse3b425ff2016-04-11 14:34:08 +0000504}
505
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000506void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000507 auto *SAI = getScopArrayInfo();
Tobias Grosser7be82452017-05-21 20:38:33 +0000508 isl::space ArraySpace = give(SAI->getSpace());
509 isl::space AccessSpace = give(isl_map_get_space(AccessRelation)).range();
510 isl::ctx Ctx = ArraySpace.get_ctx();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000511
Tobias Grosser7be82452017-05-21 20:38:33 +0000512 auto DimsArray = ArraySpace.dim(isl::dim::set);
513 auto DimsAccess = AccessSpace.dim(isl::dim::set);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000514 auto DimsMissing = DimsArray - DimsAccess;
515
Michael Kruse375cb5f2016-02-24 22:08:24 +0000516 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000517 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000518 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000519 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000520
Tobias Grosser7be82452017-05-21 20:38:33 +0000521 isl::map Map = isl::map::from_domain_and_range(
522 isl::set::universe(AccessSpace), isl::set::universe(ArraySpace));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000523
524 for (unsigned i = 0; i < DimsMissing; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000525 Map = Map.fix_si(isl::dim::out, i, 0);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000526
527 for (unsigned i = DimsMissing; i < DimsArray; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000528 Map = Map.equate(isl::dim::in, i - DimsMissing, isl::dim::out, i);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000529
Tobias Grosser7be82452017-05-21 20:38:33 +0000530 AccessRelation = isl_map_apply_range(AccessRelation, Map.release());
Roman Gareev10595a12016-01-08 14:01:59 +0000531
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000532 // For the non delinearized arrays, divide the access function of the last
533 // subscript by the size of the elements in the array.
534 //
535 // A stride one array access in C expressed as A[i] is expressed in
536 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
537 // two subsequent values of 'i' index two values that are stored next to
538 // each other in memory. By this division we make this characteristic
539 // obvious again. If the base pointer was accessed with offsets not divisible
Tobias Grosser2219d152016-08-03 05:28:09 +0000540 // by the accesses element size, we will have chosen a smaller ArrayElemSize
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000541 // that divides the offsets of all accesses to this base pointer.
542 if (DimsAccess == 1) {
Tobias Grosser7be82452017-05-21 20:38:33 +0000543 isl::val V = isl::val(Ctx, ArrayElemSize);
544 AccessRelation = isl_map_floordiv_val(AccessRelation, V.release());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000545 }
546
Michael Kruse3b425ff2016-04-11 14:34:08 +0000547 // We currently do this only if we added at least one dimension, which means
548 // some dimension's indices have not been specified, an indicator that some
549 // index values have been added together.
550 // TODO: Investigate general usefulness; Effect on unit tests is to make index
551 // expressions more complicated.
552 if (DimsMissing)
553 wrapConstantDimensions();
554
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000555 if (!isAffine())
556 computeBoundsOnAccessRelation(ArrayElemSize);
557
Tobias Grosserd840fc72016-02-04 13:18:42 +0000558 // Introduce multi-element accesses in case the type loaded by this memory
559 // access is larger than the canonical element type of the array.
560 //
561 // An access ((float *)A)[i] to an array char *A is modeled as
562 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000563 if (ElemBytes > ArrayElemSize) {
564 assert(ElemBytes % ArrayElemSize == 0 &&
565 "Loaded element size should be multiple of canonical element size");
Tobias Grosser7be82452017-05-21 20:38:33 +0000566 isl::map Map = isl::map::from_domain_and_range(
567 isl::set::universe(ArraySpace), isl::set::universe(ArraySpace));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000568 for (unsigned i = 0; i < DimsArray - 1; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000569 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000570
Tobias Grosser7be82452017-05-21 20:38:33 +0000571 isl::constraint C;
572 isl::local_space LS;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000573
Tobias Grosser7be82452017-05-21 20:38:33 +0000574 LS = isl::local_space(Map.get_space());
Tobias Grosserd840fc72016-02-04 13:18:42 +0000575 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
576
Tobias Grosser7be82452017-05-21 20:38:33 +0000577 C = isl::constraint::alloc_inequality(LS);
578 C = C.set_constant_val(isl::val(Ctx, Num - 1));
579 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, 1);
580 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, -1);
581 Map = Map.add_constraint(C);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000582
Tobias Grosser7be82452017-05-21 20:38:33 +0000583 C = isl::constraint::alloc_inequality(LS);
584 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, -1);
585 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, 1);
586 C = C.set_constant_val(isl::val(Ctx, 0));
587 Map = Map.add_constraint(C);
588 AccessRelation = isl_map_apply_range(AccessRelation, Map.release());
Tobias Grosserd840fc72016-02-04 13:18:42 +0000589 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000590}
591
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000592const std::string
593MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
594 switch (RT) {
595 case MemoryAccess::RT_NONE:
596 llvm_unreachable("Requested a reduction operator string for a memory "
597 "access which isn't a reduction");
598 case MemoryAccess::RT_ADD:
599 return "+";
600 case MemoryAccess::RT_MUL:
601 return "*";
602 case MemoryAccess::RT_BOR:
603 return "|";
604 case MemoryAccess::RT_BXOR:
605 return "^";
606 case MemoryAccess::RT_BAND:
607 return "&";
608 }
609 llvm_unreachable("Unknown reduction type");
610 return "";
611}
612
Tobias Grosserc80d6972016-09-02 06:33:33 +0000613/// Return the reduction type for a given binary operator.
Johannes Doerfertf6183392014-07-01 20:52:51 +0000614static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
615 const Instruction *Load) {
616 if (!BinOp)
617 return MemoryAccess::RT_NONE;
618 switch (BinOp->getOpcode()) {
619 case Instruction::FAdd:
620 if (!BinOp->hasUnsafeAlgebra())
621 return MemoryAccess::RT_NONE;
622 // Fall through
623 case Instruction::Add:
624 return MemoryAccess::RT_ADD;
625 case Instruction::Or:
626 return MemoryAccess::RT_BOR;
627 case Instruction::Xor:
628 return MemoryAccess::RT_BXOR;
629 case Instruction::And:
630 return MemoryAccess::RT_BAND;
631 case Instruction::FMul:
632 if (!BinOp->hasUnsafeAlgebra())
633 return MemoryAccess::RT_NONE;
634 // Fall through
635 case Instruction::Mul:
636 if (DisableMultiplicativeReductions)
637 return MemoryAccess::RT_NONE;
638 return MemoryAccess::RT_MUL;
639 default:
640 return MemoryAccess::RT_NONE;
641 }
642}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000643
Tobias Grosser75805372011-04-29 06:27:02 +0000644MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000645 isl_id_free(Id);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000646 isl_set_free(InvalidDomain);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000647 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000648 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000649}
650
Michael Kruse2fa35192016-09-01 19:53:31 +0000651const ScopArrayInfo *MemoryAccess::getOriginalScopArrayInfo() const {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000652 isl_id *ArrayId = getArrayId();
653 void *User = isl_id_get_user(ArrayId);
654 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
655 isl_id_free(ArrayId);
656 return SAI;
657}
658
Michael Kruse2fa35192016-09-01 19:53:31 +0000659const ScopArrayInfo *MemoryAccess::getLatestScopArrayInfo() const {
660 isl_id *ArrayId = getLatestArrayId();
661 void *User = isl_id_get_user(ArrayId);
662 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
663 isl_id_free(ArrayId);
664 return SAI;
665}
666
667__isl_give isl_id *MemoryAccess::getOriginalArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000668 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
669}
670
Michael Kruse2fa35192016-09-01 19:53:31 +0000671__isl_give isl_id *MemoryAccess::getLatestArrayId() const {
672 if (!hasNewAccessRelation())
673 return getOriginalArrayId();
674 return isl_map_get_tuple_id(NewAccessRelation, isl_dim_out);
675}
676
Tobias Grosserd840fc72016-02-04 13:18:42 +0000677__isl_give isl_map *MemoryAccess::getAddressFunction() const {
678 return isl_map_lexmin(getAccessRelation());
679}
680
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000681__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
682 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000683 isl_map *Schedule, *ScheduledAccRel;
684 isl_union_set *UDomain;
685
686 UDomain = isl_union_set_from_set(getStatement()->getDomain());
687 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
688 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000689 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000690 return isl_pw_multi_aff_from_map(ScheduledAccRel);
691}
692
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000693__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000694 return isl_map_copy(AccessRelation);
695}
696
Johannes Doerferta99130f2014-10-13 12:58:03 +0000697std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000698 return stringFromIslObj(AccessRelation);
699}
700
Johannes Doerferta99130f2014-10-13 12:58:03 +0000701__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000702 return isl_map_get_space(AccessRelation);
703}
704
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000705__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000706 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000707}
708
Tobias Grosser6f730082015-09-05 07:46:47 +0000709std::string MemoryAccess::getNewAccessRelationStr() const {
710 return stringFromIslObj(NewAccessRelation);
711}
712
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000713std::string MemoryAccess::getAccessRelationStr() const {
714 return isl::manage(getAccessRelation()).to_str();
715}
716
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000717__isl_give isl_basic_map *
718MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000719 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000720 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000721
Tobias Grosser084d8f72012-05-29 09:29:44 +0000722 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000723 isl_basic_set_universe(Statement->getDomainSpace()),
724 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000725}
726
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000727// Formalize no out-of-bound access assumption
728//
729// When delinearizing array accesses we optimistically assume that the
730// delinearized accesses do not access out of bound locations (the subscript
731// expression of each array evaluates for each statement instance that is
732// executed to a value that is larger than zero and strictly smaller than the
733// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000734// dimension for which we do not need to assume any upper bound. At this point
735// we formalize this assumption to ensure that at code generation time the
736// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000737//
738// To find the set of constraints necessary to avoid out of bound accesses, we
739// first build the set of data locations that are not within array bounds. We
740// then apply the reverse access relation to obtain the set of iterations that
741// may contain invalid accesses and reduce this set of iterations to the ones
742// that are actually executed by intersecting them with the domain of the
743// statement. If we now project out all loop dimensions, we obtain a set of
744// parameters that may cause statement instances to be executed that may
745// possibly yield out of bound memory accesses. The complement of these
746// constraints is the set of constraints that needs to be assumed to ensure such
747// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000748void MemoryAccess::assumeNoOutOfBound() {
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000749 if (PollyIgnoreInbounds)
750 return;
Johannes Doerfertadeab372016-02-07 13:57:32 +0000751 auto *SAI = getScopArrayInfo();
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000752 isl::space Space = give(getOriginalAccessRelationSpace()).range();
753 isl::set Outside = isl::set::empty(Space);
754 for (int i = 1, Size = Space.dim(isl::dim::set); i < Size; ++i) {
755 isl::local_space LS(Space);
756 isl::pw_aff Var = isl::pw_aff::var_on_domain(LS, isl::dim::set, i);
757 isl::pw_aff Zero = isl::pw_aff(LS);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000758
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000759 isl::set DimOutside = Var.lt_set(Zero);
760 isl::pw_aff SizeE = give(SAI->getDimensionSizePw(i));
761 SizeE = SizeE.add_dims(isl::dim::in, Space.dim(isl::dim::set));
762 SizeE = SizeE.set_tuple_id(isl::dim::in, Space.get_tuple_id(isl::dim::set));
763 DimOutside = DimOutside.unite(SizeE.le_set(Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000764
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000765 Outside = Outside.unite(DimOutside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000766 }
767
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000768 Outside = Outside.apply(give(getAccessRelation()).reverse());
769 Outside = Outside.intersect(give(Statement->getDomain()));
770 Outside = Outside.params();
Tobias Grosserf54bb772015-06-26 12:09:28 +0000771
772 // Remove divs to avoid the construction of overly complicated assumptions.
773 // Doing so increases the set of parameter combinations that are assumed to
774 // not appear. This is always save, but may make the resulting run-time check
775 // bail out more often than strictly necessary.
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000776 Outside = Outside.remove_divs();
777 Outside = Outside.complement();
Michael Kruse7071e8b2016-04-11 13:24:29 +0000778 const auto &Loc = getAccessInstruction()
779 ? getAccessInstruction()->getDebugLoc()
780 : DebugLoc();
Tobias Grosserd7c49752017-02-28 09:45:54 +0000781 if (!PollyPreciseInbounds)
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000782 Outside = Outside.gist_params(give(Statement->getDomain()).params());
783 Statement->getParent()->recordAssumption(INBOUNDS, Outside.release(), Loc,
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000784 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000785}
786
Johannes Doerfertcea61932016-02-21 19:13:19 +0000787void MemoryAccess::buildMemIntrinsicAccessRelation() {
Johannes Doerfertc9765462016-11-17 22:11:56 +0000788 assert(isMemoryIntrinsic());
Roman Gareevf5aff702016-09-12 17:08:31 +0000789 assert(Subscripts.size() == 2 && Sizes.size() == 1);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000790
Tobias Grosser53fc3552017-05-23 07:07:09 +0000791 isl::pw_aff SubscriptPWA = give(getPwAff(Subscripts[0]));
792 isl::map SubscriptMap = isl::map::from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000793
Tobias Grosser53fc3552017-05-23 07:07:09 +0000794 isl::map LengthMap;
Johannes Doerferta7920982016-02-25 14:08:48 +0000795 if (Subscripts[1] == nullptr) {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000796 LengthMap = isl::map::universe(SubscriptMap.get_space());
Johannes Doerferta7920982016-02-25 14:08:48 +0000797 } else {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000798 isl::pw_aff LengthPWA = give(getPwAff(Subscripts[1]));
799 LengthMap = isl::map::from_pw_aff(LengthPWA);
800 isl::space RangeSpace = LengthMap.get_space().range();
801 LengthMap = LengthMap.apply_range(isl::map::lex_gt(RangeSpace));
Johannes Doerferta7920982016-02-25 14:08:48 +0000802 }
Tobias Grosser53fc3552017-05-23 07:07:09 +0000803 LengthMap = LengthMap.lower_bound_si(isl::dim::out, 0, 0);
804 LengthMap = LengthMap.align_params(SubscriptMap.get_space());
805 SubscriptMap = SubscriptMap.align_params(LengthMap.get_space());
806 LengthMap = LengthMap.sum(SubscriptMap);
807 AccessRelation =
808 LengthMap.set_tuple_id(isl::dim::in, give(getStatement()->getDomainId()))
809 .release();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000810}
811
Johannes Doerferte7044942015-02-24 11:58:30 +0000812void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
813 ScalarEvolution *SE = Statement->getParent()->getSE();
814
Johannes Doerfertcea61932016-02-21 19:13:19 +0000815 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000816 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000817 return;
818
819 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000820 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
821 return;
822
823 auto *PtrSCEV = SE->getSCEV(Ptr);
824 if (isa<SCEVCouldNotCompute>(PtrSCEV))
825 return;
826
827 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
828 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
829 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
830
831 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
832 if (Range.isFullSet())
833 return;
834
Michael Kruse960c0d02017-05-18 21:55:36 +0000835 if (Range.isWrappedSet() || Range.isSignWrappedSet())
Tobias Grosserb3a85882017-02-12 08:11:12 +0000836 return;
837
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000838 bool isWrapping = Range.isSignWrappedSet();
Tobias Grosserb3a85882017-02-12 08:11:12 +0000839
Johannes Doerferte7044942015-02-24 11:58:30 +0000840 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000841 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000842 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000843 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000844
845 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000846 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000847
Tobias Grosserb3a85882017-02-12 08:11:12 +0000848 assert(Min.sle(Max) && "Minimum expected to be less or equal than max");
849
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000850 isl::map Relation = give(AccessRelation);
851 isl::set AccessRange = Relation.range();
852 AccessRange = addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0,
853 isl::dim::set);
854 AccessRelation = Relation.intersect_range(AccessRange).release();
Johannes Doerferte7044942015-02-24 11:58:30 +0000855}
856
Tobias Grosser491b7992016-12-02 05:21:22 +0000857void MemoryAccess::foldAccessRelation() {
858 if (Sizes.size() < 2 || isa<SCEVConstant>(Sizes[1]))
859 return;
860
Michael Krusee2bccbb2015-09-18 19:59:43 +0000861 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000862
Tobias Grossera32de132017-05-23 07:22:56 +0000863 isl::map NewAccessRelation = give(isl_map_copy(AccessRelation));
Tobias Grosserc2f15102017-03-01 21:11:27 +0000864
Tobias Grosser619190d2015-03-30 17:22:28 +0000865 for (int i = Size - 2; i >= 0; --i) {
Tobias Grossera32de132017-05-23 07:22:56 +0000866 isl::space Space;
867 isl::map MapOne, MapTwo;
868 isl::pw_aff DimSize = give(getPwAff(Sizes[i + 1]));
Tobias Grosser619190d2015-03-30 17:22:28 +0000869
Tobias Grossera32de132017-05-23 07:22:56 +0000870 isl::space SpaceSize = DimSize.get_space();
871 isl::id ParamId =
872 give(isl_space_get_dim_id(SpaceSize.get(), isl_dim_param, 0));
Tobias Grosser619190d2015-03-30 17:22:28 +0000873
Tobias Grossera32de132017-05-23 07:22:56 +0000874 Space = give(isl_map_copy(AccessRelation)).get_space();
875 Space = Space.range().map_from_set();
876 Space = Space.align_params(SpaceSize);
Tobias Grosser619190d2015-03-30 17:22:28 +0000877
Tobias Grossera32de132017-05-23 07:22:56 +0000878 int ParamLocation = Space.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosser619190d2015-03-30 17:22:28 +0000879
Tobias Grossera32de132017-05-23 07:22:56 +0000880 MapOne = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000881 for (int j = 0; j < Size; ++j)
Tobias Grossera32de132017-05-23 07:22:56 +0000882 MapOne = MapOne.equate(isl::dim::in, j, isl::dim::out, j);
883 MapOne = MapOne.lower_bound_si(isl::dim::in, i + 1, 0);
Tobias Grosser619190d2015-03-30 17:22:28 +0000884
Tobias Grossera32de132017-05-23 07:22:56 +0000885 MapTwo = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000886 for (int j = 0; j < Size; ++j)
887 if (j < i || j > i + 1)
Tobias Grossera32de132017-05-23 07:22:56 +0000888 MapTwo = MapTwo.equate(isl::dim::in, j, isl::dim::out, j);
Tobias Grosser619190d2015-03-30 17:22:28 +0000889
Tobias Grossera32de132017-05-23 07:22:56 +0000890 isl::local_space LS(Space);
891 isl::constraint C;
892 C = isl::constraint::alloc_equality(LS);
893 C = C.set_constant_si(-1);
894 C = C.set_coefficient_si(isl::dim::in, i, 1);
895 C = C.set_coefficient_si(isl::dim::out, i, -1);
896 MapTwo = MapTwo.add_constraint(C);
897 C = isl::constraint::alloc_equality(LS);
898 C = C.set_coefficient_si(isl::dim::in, i + 1, 1);
899 C = C.set_coefficient_si(isl::dim::out, i + 1, -1);
900 C = C.set_coefficient_si(isl::dim::param, ParamLocation, 1);
901 MapTwo = MapTwo.add_constraint(C);
902 MapTwo = MapTwo.upper_bound_si(isl::dim::in, i + 1, -1);
Tobias Grosser619190d2015-03-30 17:22:28 +0000903
Tobias Grossera32de132017-05-23 07:22:56 +0000904 MapOne = MapOne.unite(MapTwo);
905 NewAccessRelation = NewAccessRelation.apply_range(MapOne);
Tobias Grosser619190d2015-03-30 17:22:28 +0000906 }
Tobias Grosser491b7992016-12-02 05:21:22 +0000907
Tobias Grossera32de132017-05-23 07:22:56 +0000908 isl::id BaseAddrId = give(getScopArrayInfo()->getBasePtrId());
909 isl::space Space = give(Statement->getDomainSpace());
910 NewAccessRelation = NewAccessRelation.set_tuple_id(
911 isl::dim::in, Space.get_tuple_id(isl::dim::set));
912 NewAccessRelation = NewAccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
913 NewAccessRelation =
914 NewAccessRelation.gist_domain(give(Statement->getDomain()));
Tobias Grosserc2f15102017-03-01 21:11:27 +0000915
916 // Access dimension folding might in certain cases increase the number of
917 // disjuncts in the memory access, which can possibly complicate the generated
918 // run-time checks and can lead to costly compilation.
Tobias Grossera32de132017-05-23 07:22:56 +0000919 if (!PollyPreciseFoldAccesses &&
920 isl_map_n_basic_map(NewAccessRelation.get()) >
921 isl_map_n_basic_map(AccessRelation)) {
Tobias Grosserc2f15102017-03-01 21:11:27 +0000922 } else {
Tobias Grossera32de132017-05-23 07:22:56 +0000923 isl_map_free(AccessRelation);
924 AccessRelation = NewAccessRelation.release();
Tobias Grosserc2f15102017-03-01 21:11:27 +0000925 }
Tobias Grosser619190d2015-03-30 17:22:28 +0000926}
927
Tobias Grosserc80d6972016-09-02 06:33:33 +0000928/// Check if @p Expr is divisible by @p Size.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000929static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000930 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000931 if (Size == 1)
932 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000933
934 // Only one factor needs to be divisible.
935 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
936 for (auto *FactorExpr : MulExpr->operands())
937 if (isDivisible(FactorExpr, Size, SE))
938 return true;
939 return false;
940 }
941
942 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
Michael Krusea6d48f52017-06-08 12:06:15 +0000943 // to be divisible.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000944 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
945 for (auto *OpExpr : NAryExpr->operands())
946 if (!isDivisible(OpExpr, Size, SE))
947 return false;
948 return true;
949 }
950
951 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
952 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
953 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
954 return MulSCEV == Expr;
955}
956
Michael Krusee2bccbb2015-09-18 19:59:43 +0000957void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
Tobias Grosser37c8ee72017-06-30 06:30:51 +0000958 assert(!AccessRelation && "AccessRelation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000959
Johannes Doerfert85676e32016-04-23 14:32:34 +0000960 // Initialize the invalid domain which describes all iterations for which the
961 // access relation is not modeled correctly.
Johannes Doerferta4dd8ef2016-04-25 13:36:23 +0000962 auto *StmtInvalidDomain = getStatement()->getInvalidDomain();
963 InvalidDomain = isl_set_empty(isl_set_get_space(StmtInvalidDomain));
964 isl_set_free(StmtInvalidDomain);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000965
Michael Krusee2bccbb2015-09-18 19:59:43 +0000966 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000967 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000968
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000969 if (getAccessInstruction() && isa<MemIntrinsic>(getAccessInstruction())) {
970 buildMemIntrinsicAccessRelation();
971 AccessRelation =
972 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
973 return;
974 }
Johannes Doerfertcea61932016-02-21 19:13:19 +0000975
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000976 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000977 // We overapproximate non-affine accesses with a possible access to the
978 // whole array. For read accesses it does not make a difference, if an
979 // access must or may happen. However, for write accesses it is important to
980 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000981 if (!AccessRelation)
982 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
983
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000984 AccessRelation =
985 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000986 return;
987 }
988
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000989 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000990 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000991
Michael Krusee2bccbb2015-09-18 19:59:43 +0000992 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000993 isl_pw_aff *Affine = getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000994 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000995 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000996 }
997
Tobias Grosser79baa212014-04-10 08:38:02 +0000998 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000999 AccessRelation = isl_map_set_tuple_id(
1000 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +00001001 AccessRelation =
1002 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
1003
Tobias Grosseraa660a92015-03-30 00:07:50 +00001004 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +00001005 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001006}
Tobias Grosser30b8a092011-08-18 07:51:37 +00001007
Michael Krusecac948e2015-10-02 13:53:07 +00001008MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00001009 AccessType AccType, Value *BaseAddress,
1010 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +00001011 ArrayRef<const SCEV *> Subscripts,
1012 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grosser72684bb2017-05-03 08:02:32 +00001013 MemoryKind Kind)
Johannes Doerfertcea61932016-02-21 19:13:19 +00001014 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
Tobias Grosser81331282017-05-03 07:57:35 +00001015 InvalidDomain(nullptr), BaseAddr(BaseAddress), ElementType(ElementType),
1016 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
1017 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +00001018 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001019 NewAccessRelation(nullptr), FAD(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +00001020 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001021 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001022
Tobias Grosser81331282017-05-03 07:57:35 +00001023 std::string IdName = Stmt->getBaseName() + Access;
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001024 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
1025}
Michael Krusee2bccbb2015-09-18 19:59:43 +00001026
Roman Gareevb3224ad2016-09-14 06:26:09 +00001027MemoryAccess::MemoryAccess(ScopStmt *Stmt, AccessType AccType,
1028 __isl_take isl_map *AccRel)
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001029 : Kind(MemoryKind::Array), AccType(AccType), RedType(RT_NONE),
1030 Statement(Stmt), InvalidDomain(nullptr), AccessInstruction(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001031 IsAffine(true), AccessRelation(nullptr), NewAccessRelation(AccRel),
1032 FAD(nullptr) {
Roman Gareevb3224ad2016-09-14 06:26:09 +00001033 auto *ArrayInfoId = isl_map_get_tuple_id(NewAccessRelation, isl_dim_out);
1034 auto *SAI = ScopArrayInfo::getFromId(ArrayInfoId);
1035 Sizes.push_back(nullptr);
1036 for (unsigned i = 1; i < SAI->getNumberOfDimensions(); i++)
1037 Sizes.push_back(SAI->getDimensionSize(i));
1038 ElementType = SAI->getElementType();
1039 BaseAddr = SAI->getBasePtr();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001040 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001041 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Roman Gareevb3224ad2016-09-14 06:26:09 +00001042
Tobias Grosser81331282017-05-03 07:57:35 +00001043 std::string IdName = Stmt->getBaseName() + Access;
Roman Gareevb3224ad2016-09-14 06:26:09 +00001044 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
1045}
1046
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001047void MemoryAccess::realignParams() {
Johannes Doerferta60ad842016-05-10 12:18:22 +00001048 auto *Ctx = Statement->getParent()->getContext();
1049 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
1050 AccessRelation = isl_map_gist_params(AccessRelation, Ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00001051}
1052
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001053const std::string MemoryAccess::getReductionOperatorStr() const {
1054 return MemoryAccess::getReductionOperatorStr(getReductionType());
1055}
1056
Tobias Grosser6f48e0f2015-05-15 09:58:32 +00001057__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
1058
Johannes Doerfertf6183392014-07-01 20:52:51 +00001059raw_ostream &polly::operator<<(raw_ostream &OS,
1060 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001061 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +00001062 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001063 else
1064 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +00001065 return OS;
1066}
1067
Siddharth Bhat0fe72312017-05-15 08:41:30 +00001068void MemoryAccess::setFortranArrayDescriptor(Value *FAD) { this->FAD = FAD; }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001069
Tobias Grosser75805372011-04-29 06:27:02 +00001070void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +00001071 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001072 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001073 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001074 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001075 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001076 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001077 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001078 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001079 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001080 break;
1081 }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001082
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +00001083 OS << "[Reduction Type: " << getReductionType() << "] ";
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001084
1085 if (FAD) {
1086 OS << "[Fortran array descriptor: " << FAD->getName();
1087 OS << "] ";
1088 };
1089
Tobias Grossera535dff2015-12-13 19:59:01 +00001090 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +00001091 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +00001092 if (hasNewAccessRelation())
1093 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001094}
1095
Tobias Grosser74394f02013-01-14 22:40:23 +00001096void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +00001097
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001098__isl_give isl_pw_aff *MemoryAccess::getPwAff(const SCEV *E) {
1099 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +00001100 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
Tobias Grosser53292772016-07-11 12:01:26 +00001101 isl_set *StmtDom = isl_set_reset_tuple_id(getStatement()->getDomain());
1102 isl_set *NewInvalidDom = isl_set_intersect(StmtDom, PWAC.second);
1103 InvalidDomain = isl_set_union(InvalidDomain, NewInvalidDom);
Johannes Doerfert85676e32016-04-23 14:32:34 +00001104 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001105}
1106
Tobias Grosser75805372011-04-29 06:27:02 +00001107// Create a map in the size of the provided set domain, that maps from the
1108// one element of the provided set domain to another element of the provided
1109// set domain.
1110// The mapping is limited to all points that are equal in all but the last
1111// dimension and for which the last dimension of the input is strict smaller
1112// than the last dimension of the output.
1113//
1114// getEqualAndLarger(set[i0, i1, ..., iX]):
1115//
1116// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
1117// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
1118//
Tobias Grosser2a526fe2016-09-08 11:18:56 +00001119static isl_map *getEqualAndLarger(__isl_take isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +00001120 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +00001121 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +00001122 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +00001123
1124 // Set all but the last dimension to be equal for the input and output
1125 //
1126 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
1127 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +00001128 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +00001129 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +00001130
1131 // Set the last dimension of the input to be strict smaller than the
1132 // last dimension of the output.
1133 //
1134 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +00001135 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
1136 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +00001137 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +00001138}
1139
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001140__isl_give isl_set *
1141MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +00001142 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +00001143 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +00001144 isl_space *Space = isl_space_range(isl_map_get_space(S));
1145 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +00001146
Sebastian Popa00a0292012-12-18 07:46:06 +00001147 S = isl_map_reverse(S);
1148 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +00001149
Sebastian Popa00a0292012-12-18 07:46:06 +00001150 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
1151 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
1152 NextScatt = isl_map_apply_domain(NextScatt, S);
1153 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +00001154
Sebastian Popa00a0292012-12-18 07:46:06 +00001155 isl_set *Deltas = isl_map_deltas(NextScatt);
1156 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +00001157}
1158
Sebastian Popa00a0292012-12-18 07:46:06 +00001159bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +00001160 int StrideWidth) const {
1161 isl_set *Stride, *StrideX;
1162 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +00001163
Sebastian Popa00a0292012-12-18 07:46:06 +00001164 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +00001165 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +00001166 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
1167 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
1168 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
1169 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +00001170 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +00001171
Tobias Grosser28dd4862012-01-24 16:42:16 +00001172 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +00001173 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001174
Tobias Grosser28dd4862012-01-24 16:42:16 +00001175 return IsStrideX;
1176}
1177
Michael Krused56b90a2016-09-01 09:03:27 +00001178bool MemoryAccess::isStrideZero(__isl_take const isl_map *Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001179 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001180}
1181
Michael Krused56b90a2016-09-01 09:03:27 +00001182bool MemoryAccess::isStrideOne(__isl_take const isl_map *Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001183 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001184}
1185
Tobias Grosserbedef002016-12-02 08:10:56 +00001186void MemoryAccess::setAccessRelation(__isl_take isl_map *NewAccess) {
1187 isl_map_free(AccessRelation);
1188 AccessRelation = NewAccess;
1189}
1190
Michael Krused56b90a2016-09-01 09:03:27 +00001191void MemoryAccess::setNewAccessRelation(__isl_take isl_map *NewAccess) {
Michael Kruse772ce722016-09-01 19:16:58 +00001192 assert(NewAccess);
1193
1194#ifndef NDEBUG
1195 // Check domain space compatibility.
1196 auto *NewSpace = isl_map_get_space(NewAccess);
1197 auto *NewDomainSpace = isl_space_domain(isl_space_copy(NewSpace));
1198 auto *OriginalDomainSpace = getStatement()->getDomainSpace();
1199 assert(isl_space_has_equal_tuples(OriginalDomainSpace, NewDomainSpace));
1200 isl_space_free(NewDomainSpace);
1201 isl_space_free(OriginalDomainSpace);
1202
Michael Kruse706f79a2017-05-21 22:46:57 +00001203 // Reads must be executed unconditionally. Writes might be executed in a
1204 // subdomain only.
1205 if (isRead()) {
1206 // Check whether there is an access for every statement instance.
1207 auto *StmtDomain = getStatement()->getDomain();
1208 StmtDomain = isl_set_intersect_params(
1209 StmtDomain, getStatement()->getParent()->getContext());
1210 auto *NewDomain = isl_map_domain(isl_map_copy(NewAccess));
1211 assert(isl_set_is_subset(StmtDomain, NewDomain) &&
1212 "Partial READ accesses not supported");
1213 isl_set_free(NewDomain);
1214 isl_set_free(StmtDomain);
1215 }
Michael Kruse772ce722016-09-01 19:16:58 +00001216
Michael Kruse772ce722016-09-01 19:16:58 +00001217 auto *NewAccessSpace = isl_space_range(NewSpace);
1218 assert(isl_space_has_tuple_id(NewAccessSpace, isl_dim_set) &&
1219 "Must specify the array that is accessed");
1220 auto *NewArrayId = isl_space_get_tuple_id(NewAccessSpace, isl_dim_set);
1221 auto *SAI = static_cast<ScopArrayInfo *>(isl_id_get_user(NewArrayId));
1222 assert(SAI && "Must set a ScopArrayInfo");
Tobias Grossere1ff0cf2017-01-17 12:00:42 +00001223
1224 if (SAI->isArrayKind() && SAI->getBasePtrOriginSAI()) {
1225 InvariantEquivClassTy *EqClass =
1226 getStatement()->getParent()->lookupInvariantEquivClass(
1227 SAI->getBasePtr());
1228 assert(EqClass &&
1229 "Access functions to indirect arrays must have an invariant and "
1230 "hoisted base pointer");
1231 }
1232
1233 // Check whether access dimensions correspond to number of dimensions of the
1234 // accesses array.
Michael Kruse772ce722016-09-01 19:16:58 +00001235 auto Dims = SAI->getNumberOfDimensions();
1236 assert(isl_space_dim(NewAccessSpace, isl_dim_set) == Dims &&
1237 "Access dims must match array dims");
1238 isl_space_free(NewAccessSpace);
1239 isl_id_free(NewArrayId);
1240#endif
1241
Tobias Grosser166c4222015-09-05 07:46:40 +00001242 isl_map_free(NewAccessRelation);
1243 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001244}
Tobias Grosser75805372011-04-29 06:27:02 +00001245
Michael Kruse706f79a2017-05-21 22:46:57 +00001246bool MemoryAccess::isLatestPartialAccess() const {
1247 isl::set StmtDom = give(getStatement()->getDomain());
1248 isl::set AccDom = give(isl_map_domain(getLatestAccessRelation()));
1249
1250 return isl_set_is_subset(StmtDom.keep(), AccDom.keep()) == isl_bool_false;
1251}
1252
Tobias Grosser75805372011-04-29 06:27:02 +00001253//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001254
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001255__isl_give isl_map *ScopStmt::getSchedule() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001256 isl_set *Domain = getDomain();
1257 if (isl_set_is_empty(Domain)) {
1258 isl_set_free(Domain);
1259 return isl_map_from_aff(
1260 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1261 }
1262 auto *Schedule = getParent()->getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001263 if (!Schedule) {
1264 isl_set_free(Domain);
1265 return nullptr;
1266 }
Tobias Grosser808cd692015-07-14 09:33:13 +00001267 Schedule = isl_union_map_intersect_domain(
1268 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
1269 if (isl_union_map_is_empty(Schedule)) {
1270 isl_set_free(Domain);
1271 isl_union_map_free(Schedule);
1272 return isl_map_from_aff(
1273 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1274 }
1275 auto *M = isl_map_from_union_map(Schedule);
1276 M = isl_map_coalesce(M);
1277 M = isl_map_gist_domain(M, Domain);
1278 M = isl_map_coalesce(M);
1279 return M;
1280}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001281
Tobias Grosser37eb4222014-02-20 21:43:54 +00001282void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
1283 assert(isl_set_is_subset(NewDomain, Domain) &&
1284 "New domain is not a subset of old domain!");
1285 isl_set_free(Domain);
1286 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001287}
1288
Michael Krusecac948e2015-10-02 13:53:07 +00001289void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +00001290 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +00001291 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00001292 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001293
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001294 MemoryKind Ty;
Tobias Grossera535dff2015-12-13 19:59:01 +00001295 if (Access->isPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001296 Ty = MemoryKind::PHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001297 else if (Access->isExitPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001298 Ty = MemoryKind::ExitPHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001299 else if (Access->isValueKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001300 Ty = MemoryKind::Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001301 else
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001302 Ty = MemoryKind::Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001303
Tobias Grosser296fe2e2017-02-10 10:09:46 +00001304 auto *SAI = S.getOrCreateScopArrayInfo(Access->getOriginalBaseAddr(),
1305 ElementType, Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001306 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +00001307 }
1308}
1309
Michael Kruse4c276432017-05-11 22:56:46 +00001310MemoryAccess *ScopStmt::lookupPHIReadOf(PHINode *PHI) const {
1311 for (auto *MA : *this) {
1312 if (!MA->isRead())
1313 continue;
1314 if (!MA->isLatestAnyPHIKind())
1315 continue;
1316
1317 if (MA->getAccessInstruction() == PHI)
1318 return MA;
1319 }
1320 return nullptr;
1321}
1322
Michael Krusecac948e2015-10-02 13:53:07 +00001323void ScopStmt::addAccess(MemoryAccess *Access) {
1324 Instruction *AccessInst = Access->getAccessInstruction();
1325
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001326 if (Access->isArrayKind()) {
1327 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1328 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001329 } else if (Access->isValueKind() && Access->isWrite()) {
1330 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001331 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001332 assert(!ValueWrites.lookup(AccessVal));
1333
1334 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001335 } else if (Access->isValueKind() && Access->isRead()) {
1336 Value *AccessVal = Access->getAccessValue();
1337 assert(!ValueReads.lookup(AccessVal));
1338
1339 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001340 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
Tobias Grosser5db171a2017-02-10 10:09:44 +00001341 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001342 assert(!PHIWrites.lookup(PHI));
1343
1344 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001345 }
1346
1347 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001348}
1349
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001350void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001351 for (MemoryAccess *MA : *this)
1352 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001353
Johannes Doerferta60ad842016-05-10 12:18:22 +00001354 auto *Ctx = Parent.getContext();
1355 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
1356 Domain = isl_set_gist_params(Domain, Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001357}
1358
Tobias Grosserc80d6972016-09-02 06:33:33 +00001359/// Add @p BSet to the set @p User if @p BSet is bounded.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001360static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1361 void *User) {
1362 isl_set **BoundedParts = static_cast<isl_set **>(User);
1363 if (isl_basic_set_is_bounded(BSet))
1364 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1365 else
1366 isl_basic_set_free(BSet);
1367 return isl_stat_ok;
1368}
1369
Tobias Grosserc80d6972016-09-02 06:33:33 +00001370/// Return the bounded parts of @p S.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001371static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1372 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1373 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1374 isl_set_free(S);
1375 return BoundedParts;
1376}
1377
Tobias Grosserc80d6972016-09-02 06:33:33 +00001378/// Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001379///
1380/// @returns A separation of @p S into first an unbounded then a bounded subset,
1381/// both with regards to the dimension @p Dim.
1382static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1383partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1384
1385 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001386 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001387
1388 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001389 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001390
1391 // Remove dimensions that are greater than Dim as they are not interesting.
1392 assert(NumDimsS >= Dim + 1);
1393 OnlyDimS =
1394 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1395
1396 // Create artificial parametric upper bounds for dimensions smaller than Dim
1397 // as we are not interested in them.
1398 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1399 for (unsigned u = 0; u < Dim; u++) {
1400 isl_constraint *C = isl_inequality_alloc(
1401 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1402 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1403 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1404 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1405 }
1406
1407 // Collect all bounded parts of OnlyDimS.
1408 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1409
1410 // Create the dimensions greater than Dim again.
1411 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1412 NumDimsS - Dim - 1);
1413
1414 // Remove the artificial upper bound parameters again.
1415 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1416
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001417 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001418 return std::make_pair(UnboundedParts, BoundedParts);
1419}
1420
Tobias Grosserc80d6972016-09-02 06:33:33 +00001421/// Set the dimension Ids from @p From in @p To.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001422static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1423 __isl_take isl_set *To) {
1424 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1425 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1426 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1427 }
1428 return To;
1429}
1430
Tobias Grosserc80d6972016-09-02 06:33:33 +00001431/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001432static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001433 __isl_take isl_pw_aff *L,
1434 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001435 switch (Pred) {
1436 case ICmpInst::ICMP_EQ:
1437 return isl_pw_aff_eq_set(L, R);
1438 case ICmpInst::ICMP_NE:
1439 return isl_pw_aff_ne_set(L, R);
1440 case ICmpInst::ICMP_SLT:
1441 return isl_pw_aff_lt_set(L, R);
1442 case ICmpInst::ICMP_SLE:
1443 return isl_pw_aff_le_set(L, R);
1444 case ICmpInst::ICMP_SGT:
1445 return isl_pw_aff_gt_set(L, R);
1446 case ICmpInst::ICMP_SGE:
1447 return isl_pw_aff_ge_set(L, R);
1448 case ICmpInst::ICMP_ULT:
1449 return isl_pw_aff_lt_set(L, R);
1450 case ICmpInst::ICMP_UGT:
1451 return isl_pw_aff_gt_set(L, R);
1452 case ICmpInst::ICMP_ULE:
1453 return isl_pw_aff_le_set(L, R);
1454 case ICmpInst::ICMP_UGE:
1455 return isl_pw_aff_ge_set(L, R);
1456 default:
1457 llvm_unreachable("Non integer predicate not supported");
1458 }
1459}
1460
Tobias Grosserc80d6972016-09-02 06:33:33 +00001461/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001462///
1463/// Helper function that will make sure the dimensions of the result have the
1464/// same isl_id's as the @p Domain.
1465static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1466 __isl_take isl_pw_aff *L,
1467 __isl_take isl_pw_aff *R,
1468 __isl_keep isl_set *Domain) {
1469 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1470 return setDimensionIds(Domain, ConsequenceCondSet);
1471}
1472
Michael Kruse476f8552017-06-29 12:47:41 +00001473/// Compute the isl representation for the SCEV @p E in this BB.
1474///
1475/// @param S The Scop in which @p BB resides in.
1476/// @param BB The BB for which isl representation is to be
1477/// computed.
1478/// @param InvalidDomainMap A map of BB to their invalid domains.
1479/// @param E The SCEV that should be translated.
1480/// @param NonNegative Flag to indicate the @p E has to be non-negative.
1481///
1482/// Note that this function will also adjust the invalid context accordingly.
1483
1484__isl_give isl_pw_aff *
1485getPwAff(Scop &S, BasicBlock *BB,
1486 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap,
1487 const SCEV *E, bool NonNegative = false) {
1488 PWACtx PWAC = S.getPwAff(E, BB, NonNegative);
1489 InvalidDomainMap[BB] = isl_set_union(InvalidDomainMap[BB], PWAC.second);
1490 return PWAC.first;
1491}
1492
Tobias Grosserc80d6972016-09-02 06:33:33 +00001493/// Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001494///
1495/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001496/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1497/// have as many elements as @p SI has successors.
Michael Kruse476f8552017-06-29 12:47:41 +00001498static bool buildConditionSets(
1499 Scop &S, BasicBlock *BB, SwitchInst *SI, Loop *L,
1500 __isl_keep isl_set *Domain,
1501 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap,
1502 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001503
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001504 Value *Condition = getConditionFromTerminator(SI);
1505 assert(Condition && "No condition for switch");
1506
1507 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001508 isl_pw_aff *LHS, *RHS;
Michael Kruse476f8552017-06-29 12:47:41 +00001509 LHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001510
1511 unsigned NumSuccessors = SI->getNumSuccessors();
1512 ConditionSets.resize(NumSuccessors);
1513 for (auto &Case : SI->cases()) {
1514 unsigned Idx = Case.getSuccessorIndex();
1515 ConstantInt *CaseValue = Case.getCaseValue();
1516
Michael Kruse476f8552017-06-29 12:47:41 +00001517 RHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001518 isl_set *CaseConditionSet =
1519 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1520 ConditionSets[Idx] = isl_set_coalesce(
1521 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1522 }
1523
1524 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1525 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1526 for (unsigned u = 2; u < NumSuccessors; u++)
1527 ConditionSetUnion =
1528 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1529 ConditionSets[0] = setDimensionIds(
1530 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1531
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001532 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001533
1534 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001535}
1536
Tobias Grosserc80d6972016-09-02 06:33:33 +00001537/// Build the conditions sets for the branch condition @p Condition in
1538/// the @p Domain.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001539///
1540/// This will fill @p ConditionSets with the conditions under which control
1541/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001542/// have as many elements as @p TI has successors. If @p TI is nullptr the
1543/// context under which @p Condition is true/false will be returned as the
1544/// new elements of @p ConditionSets.
Michael Kruse476f8552017-06-29 12:47:41 +00001545static bool buildConditionSets(
1546 Scop &S, BasicBlock *BB, Value *Condition, TerminatorInst *TI, Loop *L,
1547 __isl_keep isl_set *Domain,
1548 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap,
1549 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001550
1551 isl_set *ConsequenceCondSet = nullptr;
1552 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1553 if (CCond->isZero())
1554 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1555 else
1556 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1557 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1558 auto Opcode = BinOp->getOpcode();
1559 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1560
Michael Kruse476f8552017-06-29 12:47:41 +00001561 bool Valid = buildConditionSets(S, BB, BinOp->getOperand(0), TI, L, Domain,
1562 InvalidDomainMap, ConditionSets) &&
1563 buildConditionSets(S, BB, BinOp->getOperand(1), TI, L, Domain,
1564 InvalidDomainMap, ConditionSets);
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001565 if (!Valid) {
1566 while (!ConditionSets.empty())
1567 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001568 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001569 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001570
1571 isl_set_free(ConditionSets.pop_back_val());
1572 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1573 isl_set_free(ConditionSets.pop_back_val());
1574 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1575
1576 if (Opcode == Instruction::And)
1577 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1578 else
1579 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1580 } else {
1581 auto *ICond = dyn_cast<ICmpInst>(Condition);
1582 assert(ICond &&
1583 "Condition of exiting branch was neither constant nor ICmp!");
1584
1585 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001586 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001587 // For unsigned comparisons we assumed the signed bit of neither operand
1588 // to be set. The comparison is equal to a signed comparison under this
1589 // assumption.
1590 bool NonNeg = ICond->isUnsigned();
Michael Kruse476f8552017-06-29 12:47:41 +00001591 LHS = getPwAff(S, BB, InvalidDomainMap,
1592 SE.getSCEVAtScope(ICond->getOperand(0), L), NonNeg);
1593 RHS = getPwAff(S, BB, InvalidDomainMap,
1594 SE.getSCEVAtScope(ICond->getOperand(1), L), NonNeg);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001595 ConsequenceCondSet =
1596 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1597 }
1598
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001599 // If no terminator was given we are only looking for parameter constraints
1600 // under which @p Condition is true/false.
1601 if (!TI)
1602 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001603 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001604 ConsequenceCondSet = isl_set_coalesce(
1605 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001606
Johannes Doerfertb2885792016-04-26 09:20:41 +00001607 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001608 bool TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001609 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001610
Michael Krusef7a4a942016-05-02 12:25:36 +00001611 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001612 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1613 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001614 TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001615 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001616 }
1617
Michael Krusef7a4a942016-05-02 12:25:36 +00001618 if (TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001619 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc());
Johannes Doerfertb2885792016-04-26 09:20:41 +00001620 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001621 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001622 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001623 }
1624
1625 ConditionSets.push_back(ConsequenceCondSet);
1626 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001627
1628 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001629}
1630
Tobias Grosserc80d6972016-09-02 06:33:33 +00001631/// Build the conditions sets for the terminator @p TI in the @p Domain.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001632///
1633/// This will fill @p ConditionSets with the conditions under which control
1634/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1635/// have as many elements as @p TI has successors.
Michael Kruse476f8552017-06-29 12:47:41 +00001636static bool buildConditionSets(
1637 Scop &S, BasicBlock *BB, TerminatorInst *TI, Loop *L,
1638 __isl_keep isl_set *Domain,
1639 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap,
1640 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001641
1642 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Michael Kruse476f8552017-06-29 12:47:41 +00001643 return buildConditionSets(S, BB, SI, L, Domain, InvalidDomainMap,
1644 ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001645
1646 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1647
1648 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001649 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001650 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001651 }
1652
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001653 Value *Condition = getConditionFromTerminator(TI);
1654 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001655
Michael Kruse476f8552017-06-29 12:47:41 +00001656 return buildConditionSets(S, BB, Condition, TI, L, Domain, InvalidDomainMap,
1657 ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001658}
1659
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001660void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001661 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001662
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001663 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001664 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001665}
1666
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001667void ScopStmt::collectSurroundingLoops() {
1668 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1669 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1670 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1671 isl_id_free(DimId);
1672 }
1673}
1674
Michael Kruse55454072017-03-15 22:16:43 +00001675ScopStmt::ScopStmt(Scop &parent, Region &R, Loop *SurroundingLoop)
Johannes Doerferta3519512016-04-23 13:02:23 +00001676 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
Michael Kruse55454072017-03-15 22:16:43 +00001677 R(&R), Build(nullptr), SurroundingLoop(SurroundingLoop) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001678
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001679 BaseName = getIslCompatibleName(
1680 "Stmt", R.getNameStr(), parent.getNextStmtIdx(), "", UseInstructionNames);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001681}
1682
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001683ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb, Loop *SurroundingLoop,
1684 std::vector<Instruction *> Instructions)
Johannes Doerferta3519512016-04-23 13:02:23 +00001685 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001686 R(nullptr), Build(nullptr), SurroundingLoop(SurroundingLoop),
1687 Instructions(Instructions) {
Tobias Grosser75805372011-04-29 06:27:02 +00001688
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001689 BaseName = getIslCompatibleName("Stmt", &bb, parent.getNextStmtIdx(), "",
1690 UseInstructionNames);
Michael Krusecac948e2015-10-02 13:53:07 +00001691}
1692
Roman Gareevb3224ad2016-09-14 06:26:09 +00001693ScopStmt::ScopStmt(Scop &parent, __isl_take isl_map *SourceRel,
1694 __isl_take isl_map *TargetRel, __isl_take isl_set *NewDomain)
1695 : Parent(parent), InvalidDomain(nullptr), Domain(NewDomain), BB(nullptr),
1696 R(nullptr), Build(nullptr) {
1697 BaseName = getIslCompatibleName("CopyStmt_", "",
1698 std::to_string(parent.getCopyStmtsNum()));
1699 auto *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1700 Domain = isl_set_set_tuple_id(Domain, isl_id_copy(Id));
1701 TargetRel = isl_map_set_tuple_id(TargetRel, isl_dim_in, Id);
1702 auto *Access =
1703 new MemoryAccess(this, MemoryAccess::AccessType::MUST_WRITE, TargetRel);
1704 parent.addAccessFunction(Access);
1705 addAccess(Access);
1706 SourceRel = isl_map_set_tuple_id(SourceRel, isl_dim_in, isl_id_copy(Id));
1707 Access = new MemoryAccess(this, MemoryAccess::AccessType::READ, SourceRel);
1708 parent.addAccessFunction(Access);
1709 addAccess(Access);
1710}
1711
Johannes Doerfertffd222f2016-05-19 12:34:57 +00001712void ScopStmt::init(LoopInfo &LI) {
Michael Krusecac948e2015-10-02 13:53:07 +00001713 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001714
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001715 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001716 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001717 buildAccessRelations();
1718
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001719 if (DetectReductions)
1720 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001721}
1722
Tobias Grosserc80d6972016-09-02 06:33:33 +00001723/// Collect loads which might form a reduction chain with @p StoreMA.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001724///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001725/// Check if the stored value for @p StoreMA is a binary operator with one or
1726/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001727/// used only once (by @p StoreMA) and its load operands are also used only
1728/// once, we have found a possible reduction chain. It starts at an operand
1729/// load and includes the binary operator and @p StoreMA.
1730///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001731/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001732/// escape this block or into any other store except @p StoreMA.
1733void ScopStmt::collectCandiateReductionLoads(
1734 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1735 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1736 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001737 return;
1738
1739 // Skip if there is not one binary operator between the load and the store
1740 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001741 if (!BinOp)
1742 return;
1743
1744 // Skip if the binary operators has multiple uses
1745 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001746 return;
1747
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001748 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001749 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1750 return;
1751
Johannes Doerfert9890a052014-07-01 00:32:29 +00001752 // Skip if the binary operator is outside the current SCoP
1753 if (BinOp->getParent() != Store->getParent())
1754 return;
1755
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001756 // Skip if it is a multiplicative reduction and we disabled them
1757 if (DisableMultiplicativeReductions &&
1758 (BinOp->getOpcode() == Instruction::Mul ||
1759 BinOp->getOpcode() == Instruction::FMul))
1760 return;
1761
Johannes Doerferte58a0122014-06-27 20:31:28 +00001762 // Check the binary operator operands for a candidate load
1763 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1764 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1765 if (!PossibleLoad0 && !PossibleLoad1)
1766 return;
1767
1768 // A load is only a candidate if it cannot escape (thus has only this use)
1769 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001770 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001771 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001772 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001773 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001774 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001775}
1776
Tobias Grosserc80d6972016-09-02 06:33:33 +00001777/// Check for reductions in this ScopStmt.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001778///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001779/// Iterate over all store memory accesses and check for valid binary reduction
1780/// like chains. For all candidates we check if they have the same base address
1781/// and there are no other accesses which overlap with them. The base address
1782/// check rules out impossible reductions candidates early. The overlap check,
1783/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001784/// guarantees that none of the intermediate results will escape during
1785/// execution of the loop nest. We basically check here that no other memory
1786/// access can access the same memory as the potential reduction.
1787void ScopStmt::checkForReductions() {
1788 SmallVector<MemoryAccess *, 2> Loads;
1789 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1790
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001791 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001792 // stores and collecting possible reduction loads.
1793 for (MemoryAccess *StoreMA : MemAccs) {
1794 if (StoreMA->isRead())
1795 continue;
1796
1797 Loads.clear();
1798 collectCandiateReductionLoads(StoreMA, Loads);
1799 for (MemoryAccess *LoadMA : Loads)
1800 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1801 }
1802
1803 // Then check each possible candidate pair.
1804 for (const auto &CandidatePair : Candidates) {
1805 bool Valid = true;
1806 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1807 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1808
1809 // Skip those with obviously unequal base addresses.
1810 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1811 isl_map_free(LoadAccs);
1812 isl_map_free(StoreAccs);
1813 continue;
1814 }
1815
1816 // And check if the remaining for overlap with other memory accesses.
1817 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1818 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1819 isl_set *AllAccs = isl_map_range(AllAccsRel);
1820
1821 for (MemoryAccess *MA : MemAccs) {
1822 if (MA == CandidatePair.first || MA == CandidatePair.second)
1823 continue;
1824
1825 isl_map *AccRel =
1826 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1827 isl_set *Accs = isl_map_range(AccRel);
1828
Tobias Grosser55a7af72016-09-08 14:08:07 +00001829 if (isl_set_has_equal_space(AllAccs, Accs)) {
Johannes Doerferte58a0122014-06-27 20:31:28 +00001830 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1831 Valid = Valid && isl_set_is_empty(OverlapAccs);
1832 isl_set_free(OverlapAccs);
Tobias Grosser55a7af72016-09-08 14:08:07 +00001833 } else {
1834 isl_set_free(Accs);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001835 }
1836 }
1837
1838 isl_set_free(AllAccs);
1839 if (!Valid)
1840 continue;
1841
Johannes Doerfertf6183392014-07-01 20:52:51 +00001842 const LoadInst *Load =
1843 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1844 MemoryAccess::ReductionType RT =
1845 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1846
Johannes Doerferte58a0122014-06-27 20:31:28 +00001847 // If no overlapping access was found we mark the load and store as
1848 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001849 CandidatePair.first->markAsReductionLike(RT);
1850 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001851 }
Tobias Grosser75805372011-04-29 06:27:02 +00001852}
1853
Tobias Grosser74394f02013-01-14 22:40:23 +00001854std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001855
Tobias Grosser54839312015-04-21 11:37:25 +00001856std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001857 auto *S = getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001858 if (!S)
1859 return "";
Tobias Grosser808cd692015-07-14 09:33:13 +00001860 auto Str = stringFromIslObj(S);
1861 isl_map_free(S);
1862 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001863}
1864
Johannes Doerferta3519512016-04-23 13:02:23 +00001865void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1866 isl_set_free(InvalidDomain);
1867 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001868}
1869
Michael Kruse375cb5f2016-02-24 22:08:24 +00001870BasicBlock *ScopStmt::getEntryBlock() const {
1871 if (isBlockStmt())
1872 return getBasicBlock();
1873 return getRegion()->getEntry();
1874}
1875
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001876unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001877
Tobias Grosser75805372011-04-29 06:27:02 +00001878const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1879
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001880Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001881 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001882}
1883
Tobias Grosser74394f02013-01-14 22:40:23 +00001884isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001885
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001886__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001887
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001888__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001889 return isl_set_get_space(Domain);
1890}
1891
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001892__isl_give isl_id *ScopStmt::getDomainId() const {
1893 return isl_set_get_tuple_id(Domain);
1894}
Tobias Grossercd95b772012-08-30 11:49:38 +00001895
Johannes Doerfert7c013572016-04-12 09:57:34 +00001896ScopStmt::~ScopStmt() {
1897 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001898 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001899}
Tobias Grosser75805372011-04-29 06:27:02 +00001900
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001901void ScopStmt::printInstructions(raw_ostream &OS) const {
1902 OS << "Instructions {\n";
1903
1904 for (Instruction *Inst : Instructions)
1905 OS.indent(16) << *Inst << "\n";
1906
1907 OS.indent(16) << "}\n";
1908}
1909
Tobias Grosser75805372011-04-29 06:27:02 +00001910void ScopStmt::print(raw_ostream &OS) const {
1911 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001912 OS.indent(12) << "Domain :=\n";
1913
1914 if (Domain) {
1915 OS.indent(16) << getDomainStr() << ";\n";
1916 } else
1917 OS.indent(16) << "n/a\n";
1918
Tobias Grosser54839312015-04-21 11:37:25 +00001919 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001920
1921 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001922 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001923 } else
1924 OS.indent(16) << "n/a\n";
1925
Tobias Grosser083d3d32014-06-28 08:59:45 +00001926 for (MemoryAccess *Access : MemAccs)
1927 Access->print(OS);
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001928
1929 if (PollyPrintInstructions)
1930 printInstructions(OS.indent(12));
Tobias Grosser75805372011-04-29 06:27:02 +00001931}
1932
1933void ScopStmt::dump() const { print(dbgs()); }
1934
Michael Krusee60eca72017-05-11 22:56:12 +00001935void ScopStmt::removeAccessData(MemoryAccess *MA) {
1936 if (MA->isRead() && MA->isOriginalValueKind()) {
1937 bool Found = ValueReads.erase(MA->getAccessValue());
1938 (void)Found;
1939 assert(Found && "Expected access data not found");
1940 }
1941 if (MA->isWrite() && MA->isOriginalValueKind()) {
1942 bool Found = ValueWrites.erase(cast<Instruction>(MA->getAccessValue()));
1943 (void)Found;
1944 assert(Found && "Expected access data not found");
1945 }
1946 if (MA->isWrite() && MA->isOriginalAnyPHIKind()) {
1947 bool Found = PHIWrites.erase(cast<PHINode>(MA->getAccessInstruction()));
1948 (void)Found;
1949 assert(Found && "Expected access data not found");
1950 }
1951}
1952
Michael Kruse10071822016-05-23 14:45:58 +00001953void ScopStmt::removeMemoryAccess(MemoryAccess *MA) {
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001954 // Remove the memory accesses from this statement together with all scalar
1955 // accesses that were caused by it. MemoryKind::Value READs have no access
1956 // instruction, hence would not be removed by this function. However, it is
1957 // only used for invariant LoadInst accesses, its arguments are always affine,
1958 // hence synthesizable, and therefore there are no MemoryKind::Value READ
1959 // accesses to be removed.
Michael Kruse10071822016-05-23 14:45:58 +00001960 auto Predicate = [&](MemoryAccess *Acc) {
1961 return Acc->getAccessInstruction() == MA->getAccessInstruction();
1962 };
Michael Krusee60eca72017-05-11 22:56:12 +00001963 for (auto *MA : MemAccs) {
1964 if (Predicate(MA))
1965 removeAccessData(MA);
1966 }
Michael Kruse10071822016-05-23 14:45:58 +00001967 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1968 MemAccs.end());
1969 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001970}
1971
Michael Kruse0446d812017-03-10 16:05:24 +00001972void ScopStmt::removeSingleMemoryAccess(MemoryAccess *MA) {
1973 auto MAIt = std::find(MemAccs.begin(), MemAccs.end(), MA);
1974 assert(MAIt != MemAccs.end());
1975 MemAccs.erase(MAIt);
1976
Michael Krusee60eca72017-05-11 22:56:12 +00001977 removeAccessData(MA);
1978
Michael Kruse0446d812017-03-10 16:05:24 +00001979 auto It = InstructionToAccess.find(MA->getAccessInstruction());
1980 if (It != InstructionToAccess.end()) {
1981 It->second.remove(MA);
1982 if (It->second.empty())
1983 InstructionToAccess.erase(MA->getAccessInstruction());
1984 }
1985}
1986
Tobias Grosser75805372011-04-29 06:27:02 +00001987//===----------------------------------------------------------------------===//
1988/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001989
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001990void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001991 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1992 isl_set_free(Context);
1993 Context = NewContext;
1994}
1995
Eli Friedman5e589ea2017-06-20 22:53:02 +00001996namespace {
Tobias Grosserc80d6972016-09-02 06:33:33 +00001997/// Remap parameter values but keep AddRecs valid wrt. invariant loads.
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001998struct SCEVSensitiveParameterRewriter
Tobias Grosser278f9e72016-11-26 17:58:40 +00001999 : public SCEVRewriteVisitor<SCEVSensitiveParameterRewriter> {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002000 ValueToValueMap &VMap;
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002001
2002public:
2003 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
Tobias Grosser278f9e72016-11-26 17:58:40 +00002004 : SCEVRewriteVisitor(SE), VMap(VMap) {}
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002005
2006 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
2007 ValueToValueMap &VMap) {
2008 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
2009 return SSPR.visit(E);
2010 }
2011
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002012 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
2013 auto *Start = visit(E->getStart());
2014 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
2015 visit(E->getStepRecurrence(SE)),
2016 E->getLoop(), SCEV::FlagAnyWrap);
2017 return SE.getAddExpr(Start, AddRec);
2018 }
2019
2020 const SCEV *visitUnknown(const SCEVUnknown *E) {
2021 if (auto *NewValue = VMap.lookup(E->getValue()))
2022 return SE.getUnknown(NewValue);
2023 return E;
2024 }
2025};
2026
Eli Friedman5e589ea2017-06-20 22:53:02 +00002027/// Check whether we should remap a SCEV expression.
2028struct SCEVFindInsideScop : public SCEVTraversal<SCEVFindInsideScop> {
2029 ValueToValueMap &VMap;
2030 bool FoundInside = false;
2031 Scop *S;
2032
2033public:
2034 SCEVFindInsideScop(ValueToValueMap &VMap, ScalarEvolution &SE, Scop *S)
2035 : SCEVTraversal(*this), VMap(VMap), S(S) {}
2036
2037 static bool hasVariant(const SCEV *E, ScalarEvolution &SE,
2038 ValueToValueMap &VMap, Scop *S) {
2039 SCEVFindInsideScop SFIS(VMap, SE, S);
2040 SFIS.visitAll(E);
2041 return SFIS.FoundInside;
2042 }
2043
2044 bool follow(const SCEV *E) {
2045 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(E)) {
2046 FoundInside |= S->getRegion().contains(AddRec->getLoop());
2047 } else if (auto *Unknown = dyn_cast<SCEVUnknown>(E)) {
2048 if (Instruction *I = dyn_cast<Instruction>(Unknown->getValue()))
2049 FoundInside |= S->getRegion().contains(I) && !VMap.count(I);
2050 }
2051 return !FoundInside;
2052 }
2053 bool isDone() { return FoundInside; }
2054};
2055} // namespace
2056
2057const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *E) {
2058 // Check whether it makes sense to rewrite the SCEV. (ScalarEvolution
2059 // doesn't like addition between an AddRec and an expression that
2060 // doesn't have a dominance relationship with it.)
2061 if (SCEVFindInsideScop::hasVariant(E, *SE, InvEquivClassVMap, this))
2062 return E;
2063
2064 // Rewrite SCEV.
2065 return SCEVSensitiveParameterRewriter::rewrite(E, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002066}
2067
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002068// This table of function names is used to translate parameter names in more
2069// human-readable names. This makes it easier to interpret Polly analysis
2070// results.
2071StringMap<std::string> KnownNames = {
2072 {"_Z13get_global_idj", "global_id"},
2073 {"_Z12get_local_idj", "local_id"},
2074 {"_Z15get_global_sizej", "global_size"},
2075 {"_Z14get_local_sizej", "local_size"},
2076 {"_Z12get_work_dimv", "work_dim"},
2077 {"_Z17get_global_offsetj", "global_offset"},
2078 {"_Z12get_group_idj", "group_id"},
2079 {"_Z14get_num_groupsj", "num_groups"},
2080};
2081
2082static std::string getCallParamName(CallInst *Call) {
2083 std::string Result;
2084 raw_string_ostream OS(Result);
2085 std::string Name = Call->getCalledFunction()->getName();
2086
2087 auto Iterator = KnownNames.find(Name);
2088 if (Iterator != KnownNames.end())
Tobias Grosserdff902f2017-06-01 12:46:51 +00002089 Name = "__" + Iterator->getValue();
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002090 OS << Name;
2091 for (auto &Operand : Call->arg_operands()) {
2092 ConstantInt *Op = cast<ConstantInt>(&Operand);
2093 OS << "_" << Op->getValue();
2094 }
2095 OS.flush();
2096 return Result;
2097}
2098
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002099void Scop::createParameterId(const SCEV *Parameter) {
2100 assert(Parameters.count(Parameter));
2101 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002102
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002103 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002104
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002105 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
2106 Value *Val = ValueParameter->getValue();
2107 CallInst *Call = dyn_cast<CallInst>(Val);
Tobias Grosser8f99c162011-11-15 11:38:55 +00002108
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002109 if (Call && isConstCall(Call)) {
2110 ParameterName = getCallParamName(Call);
2111 } else if (UseInstructionNames) {
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002112 // If this parameter references a specific Value and this value has a name
2113 // we use this name as it is likely to be unique and more useful than just
2114 // a number.
2115 if (Val->hasName())
2116 ParameterName = Val->getName();
2117 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
2118 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
2119 if (LoadOrigin->hasName()) {
2120 ParameterName += "_loaded_from_";
2121 ParameterName +=
2122 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
2123 }
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002124 }
2125 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00002126
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002127 ParameterName = getIslCompatibleName("", ParameterName, "");
2128 }
Tobias Grosser2ea7c6e2016-07-01 13:40:28 +00002129
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002130 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
2131 const_cast<void *>((const void *)Parameter));
2132 ParameterIds[Parameter] = Id;
2133}
2134
2135void Scop::addParams(const ParameterSetTy &NewParameters) {
2136 for (const SCEV *Parameter : NewParameters) {
2137 // Normalize the SCEV to get the representing element for an invariant load.
2138 Parameter = extractConstantFactor(Parameter, *SE).second;
2139 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2140
2141 if (Parameters.insert(Parameter))
2142 createParameterId(Parameter);
2143 }
2144}
2145
2146__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
2147 // Normalize the SCEV to get the representing element for an invariant load.
2148 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2149 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00002150}
Tobias Grosser75805372011-04-29 06:27:02 +00002151
Michael Krused56b90a2016-09-01 09:03:27 +00002152__isl_give isl_set *
2153Scop::addNonEmptyDomainConstraints(__isl_take isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002154 isl_set *DomainContext = isl_union_set_params(getDomains());
2155 return isl_set_intersect_params(C, DomainContext);
2156}
2157
Johannes Doerferte0b08072016-05-23 12:43:44 +00002158bool Scop::isDominatedBy(const DominatorTree &DT, BasicBlock *BB) const {
2159 return DT.dominates(BB, getEntry());
2160}
2161
Michael Kruse476f8552017-06-29 12:47:41 +00002162void Scop::addUserAssumptions(
2163 AssumptionCache &AC, DominatorTree &DT, LoopInfo &LI,
2164 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00002165 auto &F = getFunction();
Michael Kruse89b1f942017-03-17 13:56:53 +00002166 for (auto &Assumption : AC.assumptions()) {
2167 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
2168 if (!CI || CI->getNumArgOperands() != 1)
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002169 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00002170
Michael Kruse89b1f942017-03-17 13:56:53 +00002171 bool InScop = contains(CI);
2172 if (!InScop && !isDominatedBy(DT, CI->getParent()))
2173 continue;
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002174
Michael Kruse89b1f942017-03-17 13:56:53 +00002175 auto *L = LI.getLoopFor(CI->getParent());
2176 auto *Val = CI->getArgOperand(0);
2177 ParameterSetTy DetectedParams;
2178 if (!isAffineConstraint(Val, &R, L, *SE, DetectedParams)) {
2179 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
2180 CI->getDebugLoc(),
2181 "Non-affine user assumption ignored.");
2182 continue;
Michael Kruse7037fde2016-12-15 09:25:14 +00002183 }
Michael Kruse89b1f942017-03-17 13:56:53 +00002184
2185 // Collect all newly introduced parameters.
2186 ParameterSetTy NewParams;
2187 for (auto *Param : DetectedParams) {
2188 Param = extractConstantFactor(Param, *SE).second;
2189 Param = getRepresentingInvariantLoadSCEV(Param);
2190 if (Parameters.count(Param))
2191 continue;
2192 NewParams.insert(Param);
2193 }
2194
2195 SmallVector<isl_set *, 2> ConditionSets;
2196 auto *TI = InScop ? CI->getParent()->getTerminator() : nullptr;
2197 auto &Stmt = InScop ? *getStmtFor(CI->getParent()) : *Stmts.begin();
2198 auto *Dom = InScop ? getDomainConditions(&Stmt) : isl_set_copy(Context);
Michael Kruse476f8552017-06-29 12:47:41 +00002199 bool Valid = buildConditionSets(*this, Stmt.getEntryBlock(), Val, TI, L,
2200 Dom, InvalidDomainMap, ConditionSets);
Michael Kruse89b1f942017-03-17 13:56:53 +00002201 isl_set_free(Dom);
2202
2203 if (!Valid)
2204 continue;
2205
2206 isl_set *AssumptionCtx = nullptr;
2207 if (InScop) {
2208 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
2209 isl_set_free(ConditionSets[0]);
2210 } else {
2211 AssumptionCtx = isl_set_complement(ConditionSets[1]);
2212 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
2213 }
2214
2215 // Project out newly introduced parameters as they are not otherwise useful.
2216 if (!NewParams.empty()) {
2217 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
2218 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
2219 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
2220 isl_id_free(Id);
2221
2222 if (!NewParams.count(Param))
2223 continue;
2224
2225 AssumptionCtx =
2226 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
2227 }
2228 }
2229
2230 emitOptimizationRemarkAnalysis(
2231 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
2232 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
2233 Context = isl_set_intersect(Context, AssumptionCtx);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002234 }
2235}
2236
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002237void Scop::addUserContext() {
2238 if (UserContextStr.empty())
2239 return;
2240
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002241 isl_set *UserContext =
2242 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002243 isl_space *Space = getParamSpace();
2244 if (isl_space_dim(Space, isl_dim_param) !=
2245 isl_set_dim(UserContext, isl_dim_param)) {
2246 auto SpaceStr = isl_space_to_str(Space);
2247 errs() << "Error: the context provided in -polly-context has not the same "
2248 << "number of dimensions than the computed context. Due to this "
2249 << "mismatch, the -polly-context option is ignored. Please provide "
2250 << "the context in the parameter space: " << SpaceStr << ".\n";
2251 free(SpaceStr);
2252 isl_set_free(UserContext);
2253 isl_space_free(Space);
2254 return;
2255 }
2256
2257 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002258 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
2259 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002260
2261 if (strcmp(NameContext, NameUserContext) != 0) {
2262 auto SpaceStr = isl_space_to_str(Space);
2263 errs() << "Error: the name of dimension " << i
2264 << " provided in -polly-context "
2265 << "is '" << NameUserContext << "', but the name in the computed "
2266 << "context is '" << NameContext
2267 << "'. Due to this name mismatch, "
2268 << "the -polly-context option is ignored. Please provide "
2269 << "the context in the parameter space: " << SpaceStr << ".\n";
2270 free(SpaceStr);
2271 isl_set_free(UserContext);
2272 isl_space_free(Space);
2273 return;
2274 }
2275
2276 UserContext =
2277 isl_set_set_dim_id(UserContext, isl_dim_param, i,
2278 isl_space_get_dim_id(Space, isl_dim_param, i));
2279 }
2280
2281 Context = isl_set_intersect(Context, UserContext);
2282 isl_space_free(Space);
2283}
2284
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002285void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002286 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002287
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002288 const InvariantLoadsSetTy &RIL = getRequiredInvariantLoads();
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002289 for (LoadInst *LInst : RIL) {
2290 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2291
Johannes Doerfert96e54712016-02-07 17:30:13 +00002292 Type *Ty = LInst->getType();
2293 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002294 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002295 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002296 continue;
2297 }
2298
2299 ClassRep = LInst;
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00002300 InvariantEquivClasses.emplace_back(
2301 InvariantEquivClassTy{PointerSCEV, MemoryAccessList(), nullptr, Ty});
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002302 }
2303}
2304
Tobias Grosser6be480c2011-11-08 15:41:13 +00002305void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002306 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00002307 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002308 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00002309 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002310}
2311
Tobias Grosser18daaca2012-05-22 10:47:27 +00002312void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002313 unsigned PDim = 0;
2314 for (auto *Parameter : Parameters) {
2315 ConstantRange SRange = SE->getSignedRange(Parameter);
Tobias Grosser99ea1d02017-05-21 20:23:20 +00002316 Context =
2317 addRangeBoundsToSet(give(Context), SRange, PDim++, isl::dim::param)
2318 .release();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002319 }
2320}
2321
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002322// We use the outermost dimension to generate GPU transfers for Fortran arrays
2323// even when the array bounds are not known statically. To do so, we need the
2324// outermost dimension information. We add this into the context so that the
2325// outermost dimension is available during codegen.
2326// We currently do not care about dimensions other than the outermost
2327// dimension since it doesn't affect transfers.
2328static isl_set *addFortranArrayOutermostDimParams(__isl_give isl_set *Context,
2329 Scop::array_range Arrays) {
2330
2331 std::vector<isl_id *> OutermostSizeIds;
2332 for (auto Array : Arrays) {
2333 // To check if an array is a Fortran array, we check if it has a isl_pw_aff
2334 // for its outermost dimension. Fortran arrays will have this since the
2335 // outermost dimension size can be picked up from their runtime description.
2336 // TODO: actually need to check if it has a FAD, but for now this works.
2337 if (Array->getNumberOfDimensions() > 0) {
2338 isl_pw_aff *PwAff = Array->getDimensionSizePw(0);
2339 if (!PwAff)
2340 continue;
2341
2342 isl_id *Id = isl_pw_aff_get_dim_id(PwAff, isl_dim_param, 0);
2343 isl_pw_aff_free(PwAff);
2344 assert(Id && "Invalid Id for PwAff expression in Fortran array");
2345 OutermostSizeIds.push_back(Id);
2346 }
2347 }
2348
2349 const int NumTrueParams = isl_set_dim(Context, isl_dim_param);
2350 Context = isl_set_add_dims(Context, isl_dim_param, OutermostSizeIds.size());
2351
2352 for (size_t i = 0; i < OutermostSizeIds.size(); i++) {
2353 Context = isl_set_set_dim_id(Context, isl_dim_param, NumTrueParams + i,
2354 OutermostSizeIds[i]);
2355 Context =
2356 isl_set_lower_bound_si(Context, isl_dim_param, NumTrueParams + i, 0);
2357 }
2358
2359 return Context;
2360}
2361
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002362void Scop::realignParams() {
Tobias Grosser5842dee2017-03-17 13:00:53 +00002363 if (PollyIgnoreParamBounds)
2364 return;
2365
Tobias Grosser6be480c2011-11-08 15:41:13 +00002366 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002367 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002368
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002369 unsigned PDim = 0;
2370 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002371 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002372 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002373 }
2374
2375 // Align the parameters of all data structures to the model.
2376 Context = isl_set_align_params(Context, Space);
2377
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002378 // Add the outermost dimension of the Fortran arrays into the Context.
2379 // See the description of the function for more information.
2380 Context = addFortranArrayOutermostDimParams(Context, arrays());
2381
Johannes Doerferta60ad842016-05-10 12:18:22 +00002382 // As all parameters are known add bounds to them.
2383 addParameterBounds();
2384
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002385 for (ScopStmt &Stmt : *this)
2386 Stmt.realignParams();
Johannes Doerfert06445ded2016-06-02 15:07:41 +00002387 // Simplify the schedule according to the context too.
2388 Schedule = isl_schedule_gist_domain_params(Schedule, getContext());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002389}
2390
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002391static __isl_give isl_set *
2392simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2393 const Scop &S) {
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002394 // If we have modeled all blocks in the SCoP that have side effects we can
2395 // simplify the context with the constraints that are needed for anything to
2396 // be executed at all. However, if we have error blocks in the SCoP we already
2397 // assumed some parameter combinations cannot occur and removed them from the
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002398 // domains, thus we cannot use the remaining domain to simplify the
2399 // assumptions.
2400 if (!S.hasErrorBlock()) {
2401 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2402 AssumptionContext =
2403 isl_set_gist_params(AssumptionContext, DomainParameters);
2404 }
2405
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002406 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2407 return AssumptionContext;
2408}
2409
2410void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002411 // The parameter constraints of the iteration domains give us a set of
2412 // constraints that need to hold for all cases where at least a single
2413 // statement iteration is executed in the whole scop. We now simplify the
2414 // assumed context under the assumption that such constraints hold and at
2415 // least a single statement iteration is executed. For cases where no
2416 // statement instances are executed, the assumptions we have taken about
2417 // the executed code do not matter and can be changed.
2418 //
2419 // WARNING: This only holds if the assumptions we have taken do not reduce
2420 // the set of statement instances that are executed. Otherwise we
2421 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002422 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002423 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002424 // performed. In such a case, modifying the run-time conditions and
2425 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002426 // to not be executed.
2427 //
2428 // Example:
2429 //
2430 // When delinearizing the following code:
2431 //
2432 // for (long i = 0; i < 100; i++)
2433 // for (long j = 0; j < m; j++)
2434 // A[i+p][j] = 1.0;
2435 //
2436 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002437 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002438 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002439 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002440 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002441}
2442
Tobias Grosserc80d6972016-09-02 06:33:33 +00002443/// Add the minimal/maximal access in @p Set to @p User.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002444static isl::stat
2445buildMinMaxAccess(isl::set Set, Scop::MinMaxVectorTy &MinMaxAccesses, Scop &S) {
2446 isl::pw_multi_aff MinPMA, MaxPMA;
2447 isl::pw_aff LastDimAff;
2448 isl::aff OneAff;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002449 unsigned Pos;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002450 isl::ctx Ctx = Set.get_ctx();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002451
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002452 Set = Set.remove_divs();
Johannes Doerfert6296d952016-04-22 11:38:19 +00002453
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002454 if (isl_set_n_basic_set(Set.get()) >= MaxDisjunctsInDomain)
2455 return isl::stat::error;
Johannes Doerfert6296d952016-04-22 11:38:19 +00002456
Johannes Doerfert9143d672014-09-27 11:02:39 +00002457 // Restrict the number of parameters involved in the access as the lexmin/
2458 // lexmax computation will take too long if this number is high.
2459 //
2460 // Experiments with a simple test case using an i7 4800MQ:
2461 //
2462 // #Parameters involved | Time (in sec)
2463 // 6 | 0.01
2464 // 7 | 0.04
2465 // 8 | 0.12
2466 // 9 | 0.40
2467 // 10 | 1.54
2468 // 11 | 6.78
2469 // 12 | 30.38
2470 //
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002471 if (isl_set_n_param(Set.get()) > RunTimeChecksMaxParameters) {
Johannes Doerfert9143d672014-09-27 11:02:39 +00002472 unsigned InvolvedParams = 0;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002473 for (unsigned u = 0, e = isl_set_n_param(Set.get()); u < e; u++)
2474 if (Set.involves_dims(isl::dim::param, u, 1))
Johannes Doerfert9143d672014-09-27 11:02:39 +00002475 InvolvedParams++;
2476
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002477 if (InvolvedParams > RunTimeChecksMaxParameters)
2478 return isl::stat::error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002479 }
2480
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +00002481 if (isl_set_n_basic_set(Set.get()) > RunTimeChecksMaxAccessDisjuncts)
2482 return isl::stat::error;
2483
Tobias Grosser57a1d362017-06-23 08:05:27 +00002484 MinPMA = Set.lexmin_pw_multi_aff();
2485 MaxPMA = Set.lexmax_pw_multi_aff();
Tobias Grosser45e9fd12017-05-19 03:45:00 +00002486
Tobias Grosser57a1d362017-06-23 08:05:27 +00002487 if (isl_ctx_last_error(Ctx.get()) == isl_error_quota)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002488 return isl::stat::error;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002489
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002490 MinPMA = MinPMA.coalesce();
2491 MaxPMA = MaxPMA.coalesce();
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002492
Johannes Doerfertb164c792014-09-18 11:17:17 +00002493 // Adjust the last dimension of the maximal access by one as we want to
2494 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2495 // we test during code generation might now point after the end of the
2496 // allocated array but we will never dereference it anyway.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002497 assert(MaxPMA.dim(isl::dim::out) && "Assumed at least one output dimension");
2498 Pos = MaxPMA.dim(isl::dim::out) - 1;
2499 LastDimAff = MaxPMA.get_pw_aff(Pos);
2500 OneAff = isl::aff(isl::local_space(LastDimAff.get_domain_space()));
2501 OneAff = OneAff.add_constant_si(1);
2502 LastDimAff = LastDimAff.add(OneAff);
2503 MaxPMA = MaxPMA.set_pw_aff(Pos, LastDimAff);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002504
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002505 MinMaxAccesses.push_back(std::make_pair(MinPMA.copy(), MaxPMA.copy()));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002506
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002507 return isl::stat::ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002508}
2509
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002510static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2511 isl_set *Domain = MA->getStatement()->getDomain();
2512 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2513 return isl_set_reset_tuple_id(Domain);
2514}
2515
Tobias Grosserc80d6972016-09-02 06:33:33 +00002516/// Wrapper function to calculate minimal/maximal accesses to each array.
Tobias Grossere9522232017-01-16 15:49:04 +00002517static bool calculateMinMaxAccess(Scop::AliasGroupTy AliasGroup, Scop &S,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002518 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002519
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002520 MinMaxAccesses.reserve(AliasGroup.size());
Tobias Grossere9522232017-01-16 15:49:04 +00002521
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002522 isl::union_set Domains = give(S.getDomains());
2523 isl::union_map Accesses = isl::union_map::empty(give(S.getParamSpace()));
Tobias Grossere9522232017-01-16 15:49:04 +00002524
2525 for (MemoryAccess *MA : AliasGroup)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002526 Accesses = Accesses.add_map(give(MA->getAccessRelation()));
Tobias Grossere9522232017-01-16 15:49:04 +00002527
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002528 Accesses = Accesses.intersect_domain(Domains);
2529 isl::union_set Locations = Accesses.range();
2530 Locations = Locations.coalesce();
2531 Locations = Locations.detect_equalities();
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002532
2533 auto Lambda = [&MinMaxAccesses, &S](isl::set Set) -> isl::stat {
2534 return buildMinMaxAccess(Set, MinMaxAccesses, S);
2535 };
2536 return Locations.foreach_set(Lambda) == isl::stat::ok;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002537}
2538
Tobias Grosserc80d6972016-09-02 06:33:33 +00002539/// Helper to treat non-affine regions and basic blocks the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002540///
2541///{
2542
Tobias Grosserc80d6972016-09-02 06:33:33 +00002543/// Return the block that is the representing block for @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002544static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2545 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2546 : RN->getNodeAs<BasicBlock>();
2547}
2548
Tobias Grosserc80d6972016-09-02 06:33:33 +00002549/// Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002550static inline BasicBlock *
2551getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002552 if (RN->isSubRegion()) {
2553 assert(idx == 0);
2554 return RN->getNodeAs<Region>()->getExit();
2555 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002556 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002557}
2558
Tobias Grosserc80d6972016-09-02 06:33:33 +00002559/// Return the smallest loop surrounding @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002560static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002561 if (!RN->isSubRegion()) {
2562 BasicBlock *BB = RN->getNodeAs<BasicBlock>();
2563 Loop *L = LI.getLoopFor(BB);
2564
2565 // Unreachable statements are not considered to belong to a LLVM loop, as
2566 // they are not part of an actual loop in the control flow graph.
2567 // Nevertheless, we handle certain unreachable statements that are common
2568 // when modeling run-time bounds checks as being part of the loop to be
2569 // able to model them and to later eliminate the run-time bounds checks.
2570 //
2571 // Specifically, for basic blocks that terminate in an unreachable and
Michael Krusea6d48f52017-06-08 12:06:15 +00002572 // where the immediate predecessor is part of a loop, we assume these
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002573 // basic blocks belong to the loop the predecessor belongs to. This
2574 // allows us to model the following code.
2575 //
2576 // for (i = 0; i < N; i++) {
2577 // if (i > 1024)
2578 // abort(); <- this abort might be translated to an
2579 // unreachable
2580 //
2581 // A[i] = ...
2582 // }
2583 if (!L && isa<UnreachableInst>(BB->getTerminator()) && BB->getPrevNode())
2584 L = LI.getLoopFor(BB->getPrevNode());
2585 return L;
2586 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002587
2588 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2589 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2590 while (L && NonAffineSubRegion->contains(L))
2591 L = L->getParentLoop();
2592 return L;
2593}
2594
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002595/// Get the number of blocks in @p L.
2596///
2597/// The number of blocks in a loop are the number of basic blocks actually
2598/// belonging to the loop, as well as all single basic blocks that the loop
2599/// exits to and which terminate in an unreachable instruction. We do not
2600/// allow such basic blocks in the exit of a scop, hence they belong to the
2601/// scop and represent run-time conditions which we want to model and
2602/// subsequently speculate away.
2603///
2604/// @see getRegionNodeLoop for additional details.
Reid Klecknerdf2b2832017-06-19 17:44:02 +00002605unsigned getNumBlocksInLoop(Loop *L) {
2606 unsigned NumBlocks = L->getNumBlocks();
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002607 SmallVector<llvm::BasicBlock *, 4> ExitBlocks;
2608 L->getExitBlocks(ExitBlocks);
2609
2610 for (auto ExitBlock : ExitBlocks) {
2611 if (isa<UnreachableInst>(ExitBlock->getTerminator()))
2612 NumBlocks++;
2613 }
2614 return NumBlocks;
2615}
2616
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002617static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2618 if (!RN->isSubRegion())
2619 return 1;
2620
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002621 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002622 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002623}
2624
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002625static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2626 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002627 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002628 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002629 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002630 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002631 return true;
2632 return false;
2633}
2634
Johannes Doerfert96425c22015-08-30 21:13:53 +00002635///}
2636
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002637static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2638 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002639 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002640 isl_id *DimId =
2641 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2642 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2643}
2644
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002645__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002646 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002647}
2648
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002649__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002650 auto DIt = DomainMap.find(BB);
2651 if (DIt != DomainMap.end())
2652 return isl_set_copy(DIt->getSecond());
2653
2654 auto &RI = *R.getRegionInfo();
2655 auto *BBR = RI.getRegionFor(BB);
2656 while (BBR->getEntry() == BB)
2657 BBR = BBR->getParent();
2658 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002659}
2660
Michael Kruse476f8552017-06-29 12:47:41 +00002661bool Scop::buildDomains(
2662 Region *R, DominatorTree &DT, LoopInfo &LI,
2663 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002664
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002665 bool IsOnlyNonAffineRegion = isNonAffineSubRegion(R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002666 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002667 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2668 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002669 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002670
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002671 while (LD-- >= 0) {
2672 S = addDomainDimId(S, LD + 1, L);
2673 L = L->getParentLoop();
2674 }
2675
Michael Kruse476f8552017-06-29 12:47:41 +00002676 InvalidDomainMap[EntryBB] = isl_set_empty(isl_set_get_space(S));
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002677 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002678
Johannes Doerfert432658d2016-01-26 11:01:41 +00002679 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002680 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002681
Michael Kruse476f8552017-06-29 12:47:41 +00002682 if (!buildDomainsWithBranchConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002683 return false;
2684
Michael Kruse476f8552017-06-29 12:47:41 +00002685 if (!propagateDomainConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002686 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002687
2688 // Error blocks and blocks dominated by them have been assumed to never be
2689 // executed. Representing them in the Scop does not add any value. In fact,
2690 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002691 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002692 // will cause problems when building up a ScopStmt for them.
2693 // Furthermore, basic blocks dominated by error blocks may reference
2694 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002695 // can themselves not be constructed properly. To this end we will replace
2696 // the domains of error blocks and those only reachable via error blocks
2697 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002698 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002699 // InvalidDomain. This information is needed during load hoisting.
Michael Kruse476f8552017-06-29 12:47:41 +00002700 if (!propagateInvalidStmtDomains(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002701 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002702
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002703 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002704}
2705
Tobias Grosserc80d6972016-09-02 06:33:33 +00002706/// Adjust the dimensions of @p Dom that was constructed for @p OldL
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002707/// to be compatible to domains constructed for loop @p NewL.
2708///
2709/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2710/// edge from @p OldL to @p NewL.
2711static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2712 __isl_take isl_set *Dom,
2713 Loop *OldL, Loop *NewL) {
2714
2715 // If the loops are the same there is nothing to do.
2716 if (NewL == OldL)
2717 return Dom;
2718
2719 int OldDepth = S.getRelativeLoopDepth(OldL);
2720 int NewDepth = S.getRelativeLoopDepth(NewL);
2721 // If both loops are non-affine loops there is nothing to do.
2722 if (OldDepth == -1 && NewDepth == -1)
2723 return Dom;
2724
2725 // Distinguish three cases:
2726 // 1) The depth is the same but the loops are not.
2727 // => One loop was left one was entered.
2728 // 2) The depth increased from OldL to NewL.
2729 // => One loop was entered, none was left.
2730 // 3) The depth decreased from OldL to NewL.
2731 // => Loops were left were difference of the depths defines how many.
2732 if (OldDepth == NewDepth) {
2733 assert(OldL->getParentLoop() == NewL->getParentLoop());
2734 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2735 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2736 Dom = addDomainDimId(Dom, NewDepth, NewL);
2737 } else if (OldDepth < NewDepth) {
2738 assert(OldDepth + 1 == NewDepth);
2739 auto &R = S.getRegion();
2740 (void)R;
2741 assert(NewL->getParentLoop() == OldL ||
2742 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2743 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2744 Dom = addDomainDimId(Dom, NewDepth, NewL);
2745 } else {
2746 assert(OldDepth > NewDepth);
2747 int Diff = OldDepth - NewDepth;
2748 int NumDim = isl_set_n_dim(Dom);
2749 assert(NumDim >= Diff);
2750 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2751 }
2752
2753 return Dom;
2754}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002755
Michael Kruse476f8552017-06-29 12:47:41 +00002756bool Scop::propagateInvalidStmtDomains(
2757 Region *R, DominatorTree &DT, LoopInfo &LI,
2758 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
2759
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002760 ReversePostOrderTraversal<Region *> RTraversal(R);
2761 for (auto *RN : RTraversal) {
2762
2763 // Recurse for affine subregions but go on for basic blocks and non-affine
2764 // subregions.
2765 if (RN->isSubRegion()) {
2766 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002767 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002768 propagateInvalidStmtDomains(SubRegion, DT, LI, InvalidDomainMap);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002769 continue;
2770 }
2771 }
2772
2773 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2774 BasicBlock *BB = getRegionNodeBasicBlock(RN);
2775 isl_set *&Domain = DomainMap[BB];
2776 assert(Domain && "Cannot propagate a nullptr");
2777
Michael Kruse476f8552017-06-29 12:47:41 +00002778 auto *InvalidDomain = InvalidDomainMap[BB];
2779
Johannes Doerfert7c013572016-04-12 09:57:34 +00002780 bool IsInvalidBlock =
Johannes Doerferta3519512016-04-23 13:02:23 +00002781 ContainsErrorBlock || isl_set_is_subset(Domain, InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002782
Johannes Doerferta3519512016-04-23 13:02:23 +00002783 if (!IsInvalidBlock) {
2784 InvalidDomain = isl_set_intersect(InvalidDomain, isl_set_copy(Domain));
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002785 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002786 isl_set_free(InvalidDomain);
2787 InvalidDomain = Domain;
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002788 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
2789 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2790 AS_RESTRICTION);
2791 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002792 }
2793
Johannes Doerferta3519512016-04-23 13:02:23 +00002794 if (isl_set_is_empty(InvalidDomain)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002795 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002796 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002797 }
2798
Johannes Doerferta3519512016-04-23 13:02:23 +00002799 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002800 auto *TI = BB->getTerminator();
2801 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2802 for (unsigned u = 0; u < NumSuccs; u++) {
2803 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002804
2805 // Skip successors outside the SCoP.
Michael Kruse476f8552017-06-29 12:47:41 +00002806 if (!contains(SuccBB))
Johannes Doerfert7c013572016-04-12 09:57:34 +00002807 continue;
2808
Johannes Doerferte4459a22016-04-25 13:34:50 +00002809 // Skip backedges.
2810 if (DT.dominates(SuccBB, BB))
2811 continue;
2812
Michael Kruse476f8552017-06-29 12:47:41 +00002813 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2814
Johannes Doerferta3519512016-04-23 13:02:23 +00002815 auto *AdjustedInvalidDomain = adjustDomainDimensions(
2816 *this, isl_set_copy(InvalidDomain), BBLoop, SuccBBLoop);
Michael Kruse476f8552017-06-29 12:47:41 +00002817
2818 auto *SuccInvalidDomain = InvalidDomainMap[SuccBB];
Johannes Doerferta3519512016-04-23 13:02:23 +00002819 SuccInvalidDomain =
2820 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2821 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2822 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
Michael Kruse476f8552017-06-29 12:47:41 +00002823
2824 InvalidDomainMap[SuccBB] = SuccInvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002825
Michael Krusebc150122016-05-02 12:25:18 +00002826 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002827 // In case this happens we will bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00002828 if (NumConjucts < MaxDisjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002829 continue;
2830
Johannes Doerferta3519512016-04-23 13:02:23 +00002831 isl_set_free(InvalidDomain);
Tobias Grosserf44f0052017-07-09 15:47:17 +00002832 InvalidDomainMap.erase(BB);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002833 invalidate(COMPLEXITY, TI->getDebugLoc());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002834 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002835 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002836
Michael Kruse476f8552017-06-29 12:47:41 +00002837 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002838 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002839
2840 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002841}
2842
Johannes Doerfert642594a2016-04-04 07:57:39 +00002843void Scop::propagateDomainConstraintsToRegionExit(
2844 BasicBlock *BB, Loop *BBLoop,
Michael Kruse476f8552017-06-29 12:47:41 +00002845 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, LoopInfo &LI,
2846 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002847
2848 // Check if the block @p BB is the entry of a region. If so we propagate it's
2849 // domain to the exit block of the region. Otherwise we are done.
2850 auto *RI = R.getRegionInfo();
2851 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2852 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002853 if (!BBReg || BBReg->getEntry() != BB || !contains(ExitBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002854 return;
2855
Johannes Doerfert642594a2016-04-04 07:57:39 +00002856 // Do not propagate the domain if there is a loop backedge inside the region
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002857 // that would prevent the exit block from being executed.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002858 auto *L = BBLoop;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002859 while (L && contains(L)) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002860 SmallVector<BasicBlock *, 4> LatchBBs;
2861 BBLoop->getLoopLatches(LatchBBs);
2862 for (auto *LatchBB : LatchBBs)
2863 if (BB != LatchBB && BBReg->contains(LatchBB))
2864 return;
2865 L = L->getParentLoop();
2866 }
2867
2868 auto *Domain = DomainMap[BB];
2869 assert(Domain && "Cannot propagate a nullptr");
2870
Michael Kruse476f8552017-06-29 12:47:41 +00002871 Loop *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002872
2873 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2874 // adjust the domain before we can propagate it.
2875 auto *AdjustedDomain =
2876 adjustDomainDimensions(*this, isl_set_copy(Domain), BBLoop, ExitBBLoop);
2877 auto *&ExitDomain = DomainMap[ExitBB];
2878
2879 // If the exit domain is not yet created we set it otherwise we "add" the
2880 // current domain.
2881 ExitDomain =
2882 ExitDomain ? isl_set_union(AdjustedDomain, ExitDomain) : AdjustedDomain;
2883
Johannes Doerferta3519512016-04-23 13:02:23 +00002884 // Initialize the invalid domain.
Michael Kruse476f8552017-06-29 12:47:41 +00002885 auto IDIt = InvalidDomainMap.find(ExitBB);
2886 if (IDIt != InvalidDomainMap.end())
2887 isl_set_free(IDIt->getSecond());
2888 InvalidDomainMap[ExitBB] = isl_set_empty(isl_set_get_space(ExitDomain));
Johannes Doerferta3519512016-04-23 13:02:23 +00002889
Johannes Doerfert642594a2016-04-04 07:57:39 +00002890 FinishedExitBlocks.insert(ExitBB);
2891}
2892
Michael Kruse476f8552017-06-29 12:47:41 +00002893bool Scop::buildDomainsWithBranchConstraints(
2894 Region *R, DominatorTree &DT, LoopInfo &LI,
2895 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
2896
Johannes Doerfert96425c22015-08-30 21:13:53 +00002897 // To create the domain for each block in R we iterate over all blocks and
2898 // subregions in R and propagate the conditions under which the current region
2899 // element is executed. To this end we iterate in reverse post order over R as
2900 // it ensures that we first visit all predecessors of a region node (either a
2901 // basic block or a subregion) before we visit the region node itself.
2902 // Initially, only the domain for the SCoP region entry block is set and from
2903 // there we propagate the current domain to all successors, however we add the
2904 // condition that the successor is actually executed next.
2905 // As we are only interested in non-loop carried constraints here we can
2906 // simply skip loop back edges.
2907
Johannes Doerfert642594a2016-04-04 07:57:39 +00002908 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002909 ReversePostOrderTraversal<Region *> RTraversal(R);
2910 for (auto *RN : RTraversal) {
2911
2912 // Recurse for affine subregions but go on for basic blocks and non-affine
2913 // subregions.
2914 if (RN->isSubRegion()) {
2915 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002916 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002917 if (!buildDomainsWithBranchConstraints(SubRegion, DT, LI,
2918 InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002919 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002920 continue;
2921 }
2922 }
2923
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002924 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002925 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002926
Johannes Doerfert96425c22015-08-30 21:13:53 +00002927 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002928 TerminatorInst *TI = BB->getTerminator();
2929
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002930 if (isa<UnreachableInst>(TI))
2931 continue;
2932
Johannes Doerfertf5673802015-10-01 23:48:18 +00002933 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002934 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002935 continue;
Johannes Doerfert60dd9e12016-05-19 12:33:14 +00002936 MaxLoopDepth = std::max(MaxLoopDepth, isl_set_n_dim(Domain));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002937
Johannes Doerfert642594a2016-04-04 07:57:39 +00002938 auto *BBLoop = getRegionNodeLoop(RN, LI);
2939 // Propagate the domain from BB directly to blocks that have a superset
2940 // domain, at the moment only region exit nodes of regions that start in BB.
Michael Kruse476f8552017-06-29 12:47:41 +00002941 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, LI,
2942 InvalidDomainMap);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002943
2944 // If all successors of BB have been set a domain through the propagation
2945 // above we do not need to build condition sets but can just skip this
2946 // block. However, it is important to note that this is a local property
2947 // with regards to the region @p R. To this end FinishedExitBlocks is a
2948 // local variable.
2949 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2950 return FinishedExitBlocks.count(SuccBB);
2951 };
2952 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2953 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002954
2955 // Build the condition sets for the successor nodes of the current region
2956 // node. If it is a non-affine subregion we will always execute the single
2957 // exit node, hence the single entry node domain is the condition set. For
2958 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002959 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002960 if (RN->isSubRegion())
2961 ConditionSets.push_back(isl_set_copy(Domain));
Michael Kruse476f8552017-06-29 12:47:41 +00002962 else if (!buildConditionSets(*this, BB, TI, BBLoop, Domain,
2963 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002964 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002965
2966 // Now iterate over the successors and set their initial domain based on
2967 // their condition set. We skip back edges here and have to be careful when
2968 // we leave a loop not to keep constraints over a dimension that doesn't
2969 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002970 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002971 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002972 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002973 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002974
Johannes Doerfert535de032016-04-19 14:49:05 +00002975 // Skip blocks outside the region.
Michael Kruse476f8552017-06-29 12:47:41 +00002976 if (!contains(SuccBB)) {
Johannes Doerfert535de032016-04-19 14:49:05 +00002977 isl_set_free(CondSet);
2978 continue;
2979 }
2980
Johannes Doerfert642594a2016-04-04 07:57:39 +00002981 // If we propagate the domain of some block to "SuccBB" we do not have to
2982 // adjust the domain.
2983 if (FinishedExitBlocks.count(SuccBB)) {
2984 isl_set_free(CondSet);
2985 continue;
2986 }
2987
Johannes Doerfert96425c22015-08-30 21:13:53 +00002988 // Skip back edges.
2989 if (DT.dominates(SuccBB, BB)) {
2990 isl_set_free(CondSet);
2991 continue;
2992 }
2993
Michael Kruse476f8552017-06-29 12:47:41 +00002994 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2995
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002996 CondSet = adjustDomainDimensions(*this, CondSet, BBLoop, SuccBBLoop);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002997
2998 // Set the domain for the successor or merge it with an existing domain in
2999 // case there are multiple paths (without loop back edges) to the
3000 // successor block.
3001 isl_set *&SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00003002
Johannes Doerferta3519512016-04-23 13:02:23 +00003003 if (SuccDomain) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003004 SuccDomain = isl_set_coalesce(isl_set_union(SuccDomain, CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00003005 } else {
3006 // Initialize the invalid domain.
Michael Kruse476f8552017-06-29 12:47:41 +00003007 auto IDIt = InvalidDomainMap.find(SuccBB);
3008 if (IDIt != InvalidDomainMap.end())
3009 isl_set_free(IDIt->getSecond());
3010 InvalidDomainMap[SuccBB] = isl_set_empty(isl_set_get_space(CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00003011 SuccDomain = CondSet;
3012 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00003013
Tobias Grosser6d459c52017-05-23 04:26:28 +00003014 SuccDomain = isl_set_detect_equalities(SuccDomain);
3015
Michael Krusebc150122016-05-02 12:25:18 +00003016 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003017 // In case this happens we will clean up and bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00003018 if (isl_set_n_basic_set(SuccDomain) < MaxDisjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003019 continue;
3020
3021 invalidate(COMPLEXITY, DebugLoc());
3022 while (++u < ConditionSets.size())
3023 isl_set_free(ConditionSets[u]);
3024 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003025 }
3026 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003027
3028 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003029}
3030
Michael Krused56b90a2016-09-01 09:03:27 +00003031__isl_give isl_set *
3032Scop::getPredecessorDomainConstraints(BasicBlock *BB,
3033 __isl_keep isl_set *Domain,
3034 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00003035 // If @p BB is the ScopEntry we are done
3036 if (R.getEntry() == BB)
3037 return isl_set_universe(isl_set_get_space(Domain));
3038
Johannes Doerfert642594a2016-04-04 07:57:39 +00003039 // The region info of this function.
3040 auto &RI = *R.getRegionInfo();
3041
Michael Kruse476f8552017-06-29 12:47:41 +00003042 Loop *BBLoop = getFirstNonBoxedLoopFor(BB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00003043
3044 // A domain to collect all predecessor domains, thus all conditions under
3045 // which the block is executed. To this end we start with the empty domain.
3046 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
3047
3048 // Set of regions of which the entry block domain has been propagated to BB.
3049 // all predecessors inside any of the regions can be skipped.
3050 SmallSet<Region *, 8> PropagatedRegions;
3051
3052 for (auto *PredBB : predecessors(BB)) {
3053 // Skip backedges.
3054 if (DT.dominates(BB, PredBB))
3055 continue;
3056
3057 // If the predecessor is in a region we used for propagation we can skip it.
3058 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
3059 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
3060 PredBBInRegion)) {
3061 continue;
3062 }
3063
3064 // Check if there is a valid region we can use for propagation, thus look
3065 // for a region that contains the predecessor and has @p BB as exit block.
3066 auto *PredR = RI.getRegionFor(PredBB);
3067 while (PredR->getExit() != BB && !PredR->contains(BB))
3068 PredR->getParent();
3069
3070 // If a valid region for propagation was found use the entry of that region
3071 // for propagation, otherwise the PredBB directly.
3072 if (PredR->getExit() == BB) {
3073 PredBB = PredR->getEntry();
3074 PropagatedRegions.insert(PredR);
3075 }
3076
Johannes Doerfert41cda152016-04-08 10:32:26 +00003077 auto *PredBBDom = getDomainConditions(PredBB);
Michael Kruse476f8552017-06-29 12:47:41 +00003078 Loop *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, getBoxedLoops());
3079
Johannes Doerfert642594a2016-04-04 07:57:39 +00003080 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
3081
3082 PredDom = isl_set_union(PredDom, PredBBDom);
3083 }
3084
3085 return PredDom;
3086}
3087
Michael Kruse476f8552017-06-29 12:47:41 +00003088bool Scop::propagateDomainConstraints(
3089 Region *R, DominatorTree &DT, LoopInfo &LI,
3090 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003091 // Iterate over the region R and propagate the domain constrains from the
3092 // predecessors to the current node. In contrast to the
3093 // buildDomainsWithBranchConstraints function, this one will pull the domain
3094 // information from the predecessors instead of pushing it to the successors.
3095 // Additionally, we assume the domains to be already present in the domain
3096 // map here. However, we iterate again in reverse post order so we know all
3097 // predecessors have been visited before a block or non-affine subregion is
3098 // visited.
3099
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003100 ReversePostOrderTraversal<Region *> RTraversal(R);
3101 for (auto *RN : RTraversal) {
3102
3103 // Recurse for affine subregions but go on for basic blocks and non-affine
3104 // subregions.
3105 if (RN->isSubRegion()) {
3106 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003107 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00003108 if (!propagateDomainConstraints(SubRegion, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003109 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003110 continue;
3111 }
3112 }
3113
3114 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003115 isl_set *&Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00003116 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003117
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003118 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003119 auto *PredDom = getPredecessorDomainConstraints(BB, Domain, DT, LI);
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003120 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00003121 Domain = isl_set_align_params(Domain, getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003122
Johannes Doerfert642594a2016-04-04 07:57:39 +00003123 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00003124 if (BBLoop && BBLoop->getHeader() == BB && contains(BBLoop))
Michael Kruse476f8552017-06-29 12:47:41 +00003125 if (!addLoopBoundsToHeaderDomain(BBLoop, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003126 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003127 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00003128
3129 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003130}
3131
Tobias Grosserc80d6972016-09-02 06:33:33 +00003132/// Create a map to map from a given iteration to a subsequent iteration.
3133///
3134/// This map maps from SetSpace -> SetSpace where the dimensions @p Dim
3135/// is incremented by one and all other dimensions are equal, e.g.,
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003136/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
Tobias Grosserc80d6972016-09-02 06:33:33 +00003137///
3138/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003139static __isl_give isl_map *
3140createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
3141 auto *MapSpace = isl_space_map_from_set(SetSpace);
3142 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
Tobias Grosserf4fe34b2017-03-16 21:33:20 +00003143 for (unsigned u = 0; u < isl_map_dim(NextIterationMap, isl_dim_in); u++)
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003144 if (u != Dim)
3145 NextIterationMap =
3146 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
3147 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
3148 C = isl_constraint_set_constant_si(C, 1);
3149 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
3150 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
3151 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
3152 return NextIterationMap;
3153}
3154
Michael Kruse476f8552017-06-29 12:47:41 +00003155bool Scop::addLoopBoundsToHeaderDomain(
3156 Loop *L, LoopInfo &LI,
3157 DenseMap<BasicBlock *, __isl_keep isl_set *> &InvalidDomainMap) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003158 int LoopDepth = getRelativeLoopDepth(L);
3159 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003160
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003161 BasicBlock *HeaderBB = L->getHeader();
3162 assert(DomainMap.count(HeaderBB));
3163 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003164
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003165 isl_map *NextIterationMap =
3166 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003167
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003168 isl_set *UnionBackedgeCondition =
3169 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003170
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003171 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
3172 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003173
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003174 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003175
3176 // If the latch is only reachable via error statements we skip it.
3177 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
3178 if (!LatchBBDom)
3179 continue;
3180
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003181 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003182
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003183 TerminatorInst *TI = LatchBB->getTerminator();
3184 BranchInst *BI = dyn_cast<BranchInst>(TI);
Tobias Grosserbbaeda32016-11-10 05:20:29 +00003185 assert(BI && "Only branch instructions allowed in loop latches");
3186
3187 if (BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003188 BackedgeCondition = isl_set_copy(LatchBBDom);
3189 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003190 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003191 int idx = BI->getSuccessor(0) != HeaderBB;
Michael Kruse476f8552017-06-29 12:47:41 +00003192 if (!buildConditionSets(*this, LatchBB, TI, L, LatchBBDom,
3193 InvalidDomainMap, ConditionSets)) {
Michael Krusee1dc3872016-11-03 15:19:41 +00003194 isl_map_free(NextIterationMap);
3195 isl_set_free(UnionBackedgeCondition);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003196 return false;
Michael Krusee1dc3872016-11-03 15:19:41 +00003197 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003198
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003199 // Free the non back edge condition set as we do not need it.
3200 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003201
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003202 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00003203 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003204
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003205 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
3206 assert(LatchLoopDepth >= LoopDepth);
3207 BackedgeCondition =
3208 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
3209 LatchLoopDepth - LoopDepth);
3210 UnionBackedgeCondition =
3211 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003212 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003213
3214 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
3215 for (int i = 0; i < LoopDepth; i++)
3216 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
3217
3218 isl_set *UnionBackedgeConditionComplement =
3219 isl_set_complement(UnionBackedgeCondition);
3220 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
3221 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
3222 UnionBackedgeConditionComplement =
3223 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
3224 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
3225 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
3226
3227 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
3228 HeaderBBDom = Parts.second;
3229
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003230 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
3231 // the bounded assumptions to the context as they are already implied by the
3232 // <nsw> tag.
3233 if (Affinator.hasNSWAddRecForLoop(L)) {
3234 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003235 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003236 }
3237
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003238 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003239 recordAssumption(INFINITELOOP, UnboundedCtx,
3240 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003241 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003242}
3243
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003244MemoryAccess *Scop::lookupBasePtrAccess(MemoryAccess *MA) {
Tobias Grosserbe372d52017-02-09 10:11:58 +00003245 Value *PointerBase = MA->getOriginalBaseAddr();
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003246
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003247 auto *PointerBaseInst = dyn_cast<Instruction>(PointerBase);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003248 if (!PointerBaseInst)
3249 return nullptr;
3250
3251 auto *BasePtrStmt = getStmtFor(PointerBaseInst);
3252 if (!BasePtrStmt)
3253 return nullptr;
3254
3255 return BasePtrStmt->getArrayAccessOrNULLFor(PointerBaseInst);
3256}
3257
3258bool Scop::hasNonHoistableBasePtrInScop(MemoryAccess *MA,
Tobias Grosser4071cb52017-06-06 23:13:02 +00003259 isl::union_map Writes) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003260 if (auto *BasePtrMA = lookupBasePtrAccess(MA)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003261 return getNonHoistableCtx(BasePtrMA, Writes).is_null();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003262 }
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003263
Tobias Grosserbe372d52017-02-09 10:11:58 +00003264 Value *BaseAddr = MA->getOriginalBaseAddr();
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003265 if (auto *BasePtrInst = dyn_cast<Instruction>(BaseAddr))
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003266 if (!isa<LoadInst>(BasePtrInst))
Johannes Doerfert952b5302016-05-23 12:40:48 +00003267 return contains(BasePtrInst);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003268
3269 return false;
3270}
3271
Johannes Doerfert5210da52016-06-02 11:06:54 +00003272bool Scop::buildAliasChecks(AliasAnalysis &AA) {
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003273 if (!PollyUseRuntimeAliasChecks)
Johannes Doerfert5210da52016-06-02 11:06:54 +00003274 return true;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003275
Johannes Doerfertcd195322016-11-17 21:41:08 +00003276 if (buildAliasGroups(AA)) {
3277 // Aliasing assumptions do not go through addAssumption but we still want to
3278 // collect statistics so we do it here explicitly.
3279 if (MinMaxAliasGroups.size())
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00003280 AssumptionsAliasing++;
Johannes Doerfert5210da52016-06-02 11:06:54 +00003281 return true;
Johannes Doerfertcd195322016-11-17 21:41:08 +00003282 }
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003283
3284 // If a problem occurs while building the alias groups we need to delete
3285 // this SCoP and pretend it wasn't valid in the first place. To this end
3286 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003287 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003288
3289 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
3290 << " could not be created as the number of parameters involved "
3291 "is too high. The SCoP will be "
3292 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
3293 "the maximal number of parameters but be advised that the "
3294 "compile time might increase exponentially.\n\n");
Johannes Doerfert5210da52016-06-02 11:06:54 +00003295 return false;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003296}
3297
Tobias Grosser889830b2017-02-09 23:12:22 +00003298std::tuple<Scop::AliasGroupVectorTy, DenseSet<const ScopArrayInfo *>>
Tobias Grosser9edcf072017-01-16 14:07:57 +00003299Scop::buildAliasGroupsForAccesses(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003300 AliasSetTracker AST(AA);
3301
3302 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Tobias Grosser889830b2017-02-09 23:12:22 +00003303 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003304 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003305
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003306 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003307 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
3308 isl_set_free(StmtDomain);
Tobias Grosser9edcf072017-01-16 14:07:57 +00003309
3310 // Statements with an empty domain will never be executed.
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003311 if (StmtDomainEmpty)
3312 continue;
3313
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003314 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00003315 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003316 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00003317 if (!MA->isRead())
Tobias Grosser889830b2017-02-09 23:12:22 +00003318 HasWriteAccess.insert(MA->getScopArrayInfo());
Michael Kruse70131d32016-01-27 17:09:17 +00003319 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003320 if (MA->isRead() && isa<MemTransferInst>(Acc))
Michael Kruse426e6f72016-10-25 13:37:43 +00003321 PtrToAcc[cast<MemTransferInst>(Acc)->getRawSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00003322 else
3323 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003324 AST.add(Acc);
3325 }
3326 }
3327
Tobias Grosser9edcf072017-01-16 14:07:57 +00003328 AliasGroupVectorTy AliasGroups;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003329 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00003330 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003331 continue;
3332 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00003333 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00003334 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003335 if (AG.size() < 2)
3336 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003337 AliasGroups.push_back(std::move(AG));
3338 }
3339
Tobias Grosser9edcf072017-01-16 14:07:57 +00003340 return std::make_tuple(AliasGroups, HasWriteAccess);
3341}
3342
Tobias Grossere39f9122017-01-16 14:08:00 +00003343void Scop::splitAliasGroupsByDomain(AliasGroupVectorTy &AliasGroups) {
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003344 for (unsigned u = 0; u < AliasGroups.size(); u++) {
3345 AliasGroupTy NewAG;
3346 AliasGroupTy &AG = AliasGroups[u];
3347 AliasGroupTy::iterator AGI = AG.begin();
3348 isl_set *AGDomain = getAccessDomain(*AGI);
3349 while (AGI != AG.end()) {
3350 MemoryAccess *MA = *AGI;
3351 isl_set *MADomain = getAccessDomain(MA);
3352 if (isl_set_is_disjoint(AGDomain, MADomain)) {
3353 NewAG.push_back(MA);
3354 AGI = AG.erase(AGI);
3355 isl_set_free(MADomain);
3356 } else {
3357 AGDomain = isl_set_union(AGDomain, MADomain);
3358 AGI++;
3359 }
3360 }
3361 if (NewAG.size() > 1)
3362 AliasGroups.push_back(std::move(NewAG));
3363 isl_set_free(AGDomain);
3364 }
Tobias Grossere39f9122017-01-16 14:08:00 +00003365}
3366
3367bool Scop::buildAliasGroups(AliasAnalysis &AA) {
3368 // To create sound alias checks we perform the following steps:
3369 // o) We partition each group into read only and non read only accesses.
3370 // o) For each group with more than one base pointer we then compute minimal
3371 // and maximal accesses to each array of a group in read only and non
3372 // read only partitions separately.
3373 AliasGroupVectorTy AliasGroups;
Tobias Grosser889830b2017-02-09 23:12:22 +00003374 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grossere39f9122017-01-16 14:08:00 +00003375
3376 std::tie(AliasGroups, HasWriteAccess) = buildAliasGroupsForAccesses(AA);
3377
3378 splitAliasGroupsByDomain(AliasGroups);
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003379
Johannes Doerfert13771732014-10-01 12:40:46 +00003380 for (AliasGroupTy &AG : AliasGroups) {
Tobias Grosser78a7a6c2017-06-23 08:05:31 +00003381 if (!hasFeasibleRuntimeContext())
3382 return false;
3383
Tobias Grosser57a1d362017-06-23 08:05:27 +00003384 {
3385 IslMaxOperationsGuard MaxOpGuard(getIslCtx(), OptComputeOut);
3386 bool Valid = buildAliasGroup(AG, HasWriteAccess);
3387 if (!Valid)
3388 return false;
3389 }
3390 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
3391 invalidate(COMPLEXITY, DebugLoc());
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003392 return false;
Tobias Grosser57a1d362017-06-23 08:05:27 +00003393 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003394 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003395
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003396 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003397}
3398
Tobias Grosser77f32572017-01-16 15:49:07 +00003399bool Scop::buildAliasGroup(Scop::AliasGroupTy &AliasGroup,
Tobias Grosser889830b2017-02-09 23:12:22 +00003400 DenseSet<const ScopArrayInfo *> HasWriteAccess) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003401 AliasGroupTy ReadOnlyAccesses;
3402 AliasGroupTy ReadWriteAccesses;
Tobias Grosser889830b2017-02-09 23:12:22 +00003403 SmallPtrSet<const ScopArrayInfo *, 4> ReadWriteArrays;
Tobias Grosser079d5112017-02-18 20:51:29 +00003404 SmallPtrSet<const ScopArrayInfo *, 4> ReadOnlyArrays;
Tobias Grosser77f32572017-01-16 15:49:07 +00003405
3406 auto &F = getFunction();
3407
3408 if (AliasGroup.size() < 2)
3409 return true;
3410
3411 for (MemoryAccess *Access : AliasGroup) {
3412 emitOptimizationRemarkAnalysis(
3413 F.getContext(), DEBUG_TYPE, F,
3414 Access->getAccessInstruction()->getDebugLoc(),
3415 "Possibly aliasing pointer, use restrict keyword.");
3416
Tobias Grosser889830b2017-02-09 23:12:22 +00003417 const ScopArrayInfo *Array = Access->getScopArrayInfo();
3418 if (HasWriteAccess.count(Array)) {
3419 ReadWriteArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003420 ReadWriteAccesses.push_back(Access);
3421 } else {
Tobias Grosser079d5112017-02-18 20:51:29 +00003422 ReadOnlyArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003423 ReadOnlyAccesses.push_back(Access);
3424 }
3425 }
3426
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003427 // If there are no read-only pointers, and less than two read-write pointers,
3428 // no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003429 if (ReadOnlyAccesses.empty() && ReadWriteArrays.size() <= 1)
Tobias Grosser77f32572017-01-16 15:49:07 +00003430 return true;
3431
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003432 // If there is no read-write pointer, no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003433 if (ReadWriteArrays.empty())
Tobias Grosser77f32572017-01-16 15:49:07 +00003434 return true;
3435
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003436 // For non-affine accesses, no alias check can be generated as we cannot
3437 // compute a sufficiently tight lower and upper bound: bail out.
Tobias Grosser77f32572017-01-16 15:49:07 +00003438 for (MemoryAccess *MA : AliasGroup) {
3439 if (!MA->isAffine()) {
3440 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
3441 return false;
3442 }
Tobias Grosser0032d872017-01-16 15:49:14 +00003443 }
3444
3445 // Ensure that for all memory accesses for which we generate alias checks,
3446 // their base pointers are available.
3447 for (MemoryAccess *MA : AliasGroup) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003448 if (MemoryAccess *BasePtrMA = lookupBasePtrAccess(MA))
3449 addRequiredInvariantLoad(
3450 cast<LoadInst>(BasePtrMA->getAccessInstruction()));
3451 }
3452
3453 MinMaxAliasGroups.emplace_back();
3454 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3455 MinMaxVectorTy &MinMaxAccessesReadWrite = pair.first;
3456 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3457
3458 bool Valid;
3459
3460 Valid =
3461 calculateMinMaxAccess(ReadWriteAccesses, *this, MinMaxAccessesReadWrite);
3462
3463 if (!Valid)
3464 return false;
3465
3466 // Bail out if the number of values we need to compare is too large.
3467 // This is important as the number of comparisons grows quadratically with
3468 // the number of values we need to compare.
Tobias Grosser079d5112017-02-18 20:51:29 +00003469 if (MinMaxAccessesReadWrite.size() + ReadOnlyArrays.size() >
Tobias Grosser77f32572017-01-16 15:49:07 +00003470 RunTimeChecksMaxArraysPerGroup)
3471 return false;
3472
3473 Valid =
3474 calculateMinMaxAccess(ReadOnlyAccesses, *this, MinMaxAccessesReadOnly);
3475
3476 if (!Valid)
3477 return false;
3478
3479 return true;
3480}
3481
Tobias Grosserc80d6972016-09-02 06:33:33 +00003482/// Get the smallest loop that contains @p S but is not in @p S.
Johannes Doerfertef744432016-05-23 12:42:38 +00003483static Loop *getLoopSurroundingScop(Scop &S, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003484 // Start with the smallest loop containing the entry and expand that
3485 // loop until it contains all blocks in the region. If there is a loop
3486 // containing all blocks in the region check if it is itself contained
3487 // and if so take the parent loop as it will be the smallest containing
3488 // the region but not contained by it.
Johannes Doerfertef744432016-05-23 12:42:38 +00003489 Loop *L = LI.getLoopFor(S.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003490 while (L) {
3491 bool AllContained = true;
Johannes Doerfertef744432016-05-23 12:42:38 +00003492 for (auto *BB : S.blocks())
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003493 AllContained &= L->contains(BB);
3494 if (AllContained)
3495 break;
3496 L = L->getParentLoop();
3497 }
3498
Johannes Doerfertef744432016-05-23 12:42:38 +00003499 return L ? (S.contains(L) ? L->getParentLoop() : L) : nullptr;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003500}
3501
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003502int Scop::NextScopID = 0;
3503
3504std::string Scop::CurrentFunc = "";
3505
3506int Scop::getNextID(std::string ParentFunc) {
3507 if (ParentFunc != CurrentFunc) {
3508 CurrentFunc = ParentFunc;
3509 NextScopID = 0;
3510 }
3511 return NextScopID++;
3512}
3513
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003514Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
Johannes Doerfert1dafea42016-05-23 09:07:08 +00003515 ScopDetection::DetectionContext &DC)
Philip Pfaffe35bdcaf2017-05-15 13:43:01 +00003516 : SE(&ScalarEvolution), R(R), name(R.getNameStr()), IsOptimized(false),
Siddharth Bhat47c72372017-07-05 15:07:28 +00003517 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
3518 MaxLoopDepth(0), CopyStmtsNum(0), SkipScop(false), DC(DC),
Roman Gareevb3224ad2016-09-14 06:26:09 +00003519 IslCtx(isl_ctx_alloc(), isl_ctx_free), Context(nullptr),
3520 Affinator(this, LI), AssumedContext(nullptr), InvalidContext(nullptr),
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003521 Schedule(nullptr),
3522 ID(getNextID((*R.getEntry()->getParent()).getName().str())) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003523 if (IslOnErrorAbort)
3524 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003525 buildContext();
3526}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003527
Tobias Grosserbedef002016-12-02 08:10:56 +00003528void Scop::foldSizeConstantsToRight() {
3529 isl_union_set *Accessed = isl_union_map_range(getAccesses());
3530
3531 for (auto Array : arrays()) {
3532 if (Array->getNumberOfDimensions() <= 1)
3533 continue;
3534
3535 isl_space *Space = Array->getSpace();
3536
3537 Space = isl_space_align_params(Space, isl_union_set_get_space(Accessed));
3538
3539 if (!isl_union_set_contains(Accessed, Space)) {
3540 isl_space_free(Space);
3541 continue;
3542 }
3543
3544 isl_set *Elements = isl_union_set_extract_set(Accessed, Space);
3545
3546 isl_map *Transform =
3547 isl_map_universe(isl_space_map_from_set(Array->getSpace()));
3548
3549 std::vector<int> Int;
3550
3551 int Dims = isl_set_dim(Elements, isl_dim_set);
3552 for (int i = 0; i < Dims; i++) {
3553 isl_set *DimOnly =
3554 isl_set_project_out(isl_set_copy(Elements), isl_dim_set, 0, i);
3555 DimOnly = isl_set_project_out(DimOnly, isl_dim_set, 1, Dims - i - 1);
3556 DimOnly = isl_set_lower_bound_si(DimOnly, isl_dim_set, 0, 0);
3557
3558 isl_basic_set *DimHull = isl_set_affine_hull(DimOnly);
3559
3560 if (i == Dims - 1) {
3561 Int.push_back(1);
3562 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3563 isl_basic_set_free(DimHull);
3564 continue;
3565 }
3566
3567 if (isl_basic_set_dim(DimHull, isl_dim_div) == 1) {
3568 isl_aff *Diff = isl_basic_set_get_div(DimHull, 0);
3569 isl_val *Val = isl_aff_get_denominator_val(Diff);
3570 isl_aff_free(Diff);
3571
3572 int ValInt = 1;
3573
3574 if (isl_val_is_int(Val))
3575 ValInt = isl_val_get_num_si(Val);
3576 isl_val_free(Val);
3577
3578 Int.push_back(ValInt);
3579
3580 isl_constraint *C = isl_constraint_alloc_equality(
3581 isl_local_space_from_space(isl_map_get_space(Transform)));
3582 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, ValInt);
3583 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, -1);
3584 Transform = isl_map_add_constraint(Transform, C);
3585 isl_basic_set_free(DimHull);
3586 continue;
3587 }
3588
3589 isl_basic_set *ZeroSet = isl_basic_set_copy(DimHull);
3590 ZeroSet = isl_basic_set_fix_si(ZeroSet, isl_dim_set, 0, 0);
3591
3592 int ValInt = 1;
3593 if (isl_basic_set_is_equal(ZeroSet, DimHull)) {
3594 ValInt = 0;
3595 }
3596
3597 Int.push_back(ValInt);
3598 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3599 isl_basic_set_free(DimHull);
3600 isl_basic_set_free(ZeroSet);
3601 }
3602
3603 isl_set *MappedElements = isl_map_domain(isl_map_copy(Transform));
3604
3605 if (!isl_set_is_subset(Elements, MappedElements)) {
3606 isl_set_free(Elements);
3607 isl_set_free(MappedElements);
3608 isl_map_free(Transform);
3609 continue;
3610 }
3611
3612 isl_set_free(MappedElements);
3613
3614 bool CanFold = true;
3615
3616 if (Int[0] <= 1)
3617 CanFold = false;
3618
3619 unsigned NumDims = Array->getNumberOfDimensions();
3620 for (unsigned i = 1; i < NumDims - 1; i++)
3621 if (Int[0] != Int[i] && Int[i])
3622 CanFold = false;
3623
3624 if (!CanFold) {
3625 isl_set_free(Elements);
3626 isl_map_free(Transform);
3627 continue;
3628 }
3629
Tobias Grosserbedef002016-12-02 08:10:56 +00003630 for (auto &Access : AccessFunctions)
3631 if (Access->getScopArrayInfo() == Array)
3632 Access->setAccessRelation(isl_map_apply_range(
3633 Access->getAccessRelation(), isl_map_copy(Transform)));
3634
3635 isl_map_free(Transform);
3636
3637 std::vector<const SCEV *> Sizes;
3638 for (unsigned i = 0; i < NumDims; i++) {
3639 auto Size = Array->getDimensionSize(i);
3640
3641 if (i == NumDims - 1)
3642 Size = SE->getMulExpr(Size, SE->getConstant(Size->getType(), Int[0]));
3643 Sizes.push_back(Size);
3644 }
3645
3646 Array->updateSizes(Sizes, false /* CheckConsistency */);
3647
3648 isl_set_free(Elements);
3649 }
3650 isl_union_set_free(Accessed);
3651 return;
3652}
3653
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003654void Scop::markFortranArrays() {
3655 for (ScopStmt &Stmt : Stmts) {
3656 for (MemoryAccess *MemAcc : Stmt) {
3657 Value *FAD = MemAcc->getFortranArrayDescriptor();
3658 if (!FAD)
3659 continue;
3660
3661 // TODO: const_cast-ing to edit
3662 ScopArrayInfo *SAI =
3663 const_cast<ScopArrayInfo *>(MemAcc->getLatestScopArrayInfo());
3664 assert(SAI && "memory access into a Fortran array does not "
3665 "have an associated ScopArrayInfo");
3666 SAI->applyAndSetFAD(FAD);
3667 }
3668 }
3669}
3670
Tobias Grosser491b7992016-12-02 05:21:22 +00003671void Scop::finalizeAccesses() {
3672 updateAccessDimensionality();
Tobias Grosserbedef002016-12-02 08:10:56 +00003673 foldSizeConstantsToRight();
Tobias Grosser491b7992016-12-02 05:21:22 +00003674 foldAccessRelations();
3675 assumeNoOutOfBounds();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003676 markFortranArrays();
Tobias Grosser491b7992016-12-02 05:21:22 +00003677}
3678
Tobias Grosser75805372011-04-29 06:27:02 +00003679Scop::~Scop() {
3680 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003681 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003682 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003683 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003684
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003685 for (auto &It : ParameterIds)
3686 isl_id_free(It.second);
3687
Johannes Doerfert96425c22015-08-30 21:13:53 +00003688 for (auto It : DomainMap)
3689 isl_set_free(It.second);
3690
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003691 for (auto &AS : RecordedAssumptions)
3692 isl_set_free(AS.Set);
3693
Johannes Doerfertb164c792014-09-18 11:17:17 +00003694 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003695 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003696 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003697 isl_pw_multi_aff_free(MMA.first);
3698 isl_pw_multi_aff_free(MMA.second);
3699 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003700 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003701 isl_pw_multi_aff_free(MMA.first);
3702 isl_pw_multi_aff_free(MMA.second);
3703 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003704 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003705
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003706 for (const auto &IAClass : InvariantEquivClasses)
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003707 isl_set_free(IAClass.ExecutionContext);
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003708
3709 // Explicitly release all Scop objects and the underlying isl objects before
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003710 // we release the isl context.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003711 Stmts.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003712 ScopArrayInfoSet.clear();
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003713 ScopArrayInfoMap.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003714 ScopArrayNameMap.clear();
Roman Gareeve2ee79a2016-08-21 11:09:19 +00003715 AccessFunctions.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003716}
3717
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003718void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003719 // Check all array accesses for each base pointer and find a (virtual) element
3720 // size for the base pointer that divides all access functions.
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003721 for (ScopStmt &Stmt : *this)
3722 for (MemoryAccess *Access : Stmt) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003723 if (!Access->isArrayKind())
3724 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003725 ScopArrayInfo *Array =
Tobias Grossere24b7b92017-02-09 23:24:57 +00003726 const_cast<ScopArrayInfo *>(Access->getScopArrayInfo());
3727
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003728 if (Array->getNumberOfDimensions() != 1)
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003729 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003730 unsigned DivisibleSize = Array->getElemSizeInBytes();
3731 const SCEV *Subscript = Access->getSubscript(0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003732 while (!isDivisible(Subscript, DivisibleSize, *SE))
3733 DivisibleSize /= 2;
3734 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003735 Array->updateElementType(Ty);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003736 }
3737
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003738 for (auto &Stmt : *this)
3739 for (auto &Access : Stmt)
3740 Access->updateDimensionality();
3741}
3742
Tobias Grosser491b7992016-12-02 05:21:22 +00003743void Scop::foldAccessRelations() {
3744 for (auto &Stmt : *this)
3745 for (auto &Access : Stmt)
3746 Access->foldAccessRelation();
3747}
3748
3749void Scop::assumeNoOutOfBounds() {
3750 for (auto &Stmt : *this)
3751 for (auto &Access : Stmt)
3752 Access->assumeNoOutOfBound();
3753}
3754
Michael Kruse977d38b2016-07-22 17:31:17 +00003755void Scop::simplifySCoP(bool AfterHoisting) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003756 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3757 ScopStmt &Stmt = *StmtIt;
3758
Johannes Doerfert26404542016-05-10 12:19:47 +00003759 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerferteca9e892015-11-03 16:54:49 +00003760 if (!RemoveStmt)
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00003761 RemoveStmt = !DomainMap[Stmt.getEntryBlock()];
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003762
Johannes Doerferteca9e892015-11-03 16:54:49 +00003763 // Remove read only statements only after invariant loop hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003764 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003765 bool OnlyRead = true;
3766 for (MemoryAccess *MA : Stmt) {
3767 if (MA->isRead())
3768 continue;
3769
3770 OnlyRead = false;
3771 break;
3772 }
3773
3774 RemoveStmt = OnlyRead;
3775 }
3776
Johannes Doerfert26404542016-05-10 12:19:47 +00003777 if (!RemoveStmt) {
3778 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003779 continue;
3780 }
3781
Johannes Doerfert26404542016-05-10 12:19:47 +00003782 // Remove the statement because it is unnecessary.
3783 if (Stmt.isRegionStmt())
3784 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3785 StmtMap.erase(BB);
3786 else
3787 StmtMap.erase(Stmt.getBasicBlock());
3788
3789 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003790 }
3791}
3792
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003793InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003794 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3795 if (!LInst)
3796 return nullptr;
3797
3798 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3799 LInst = cast<LoadInst>(Rep);
3800
Johannes Doerfert96e54712016-02-07 17:30:13 +00003801 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003802 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003803 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003804 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfert549768c2016-03-24 13:22:16 +00003805 continue;
3806
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003807 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfert549768c2016-03-24 13:22:16 +00003808 for (auto *MA : MAs)
3809 if (MA->getAccessInstruction() == Val)
3810 return &IAClass;
3811 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003812
3813 return nullptr;
3814}
3815
Tobias Grosserc80d6972016-09-02 06:33:33 +00003816/// Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003817static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003818 bool MAInvalidCtxIsEmpty,
3819 bool NonHoistableCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003820 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3821 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3822 // TODO: We can provide more information for better but more expensive
3823 // results.
3824 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3825 LInst->getAlignment(), DL))
3826 return false;
3827
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003828 // If the location might be overwritten we do not hoist it unconditionally.
3829 //
3830 // TODO: This is probably to conservative.
3831 if (!NonHoistableCtxIsEmpty)
3832 return false;
3833
Michael Krusea6d48f52017-06-08 12:06:15 +00003834 // If a dereferenceable load is in a statement that is modeled precisely we
3835 // can hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003836 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003837 return true;
3838
3839 // Even if the statement is not modeled precisely we can hoist the load if it
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003840 // does not involve any parameters that might have been specialized by the
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003841 // statement domain.
3842 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3843 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3844 return false;
3845 return true;
3846}
3847
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003848void Scop::addInvariantLoads(ScopStmt &Stmt, InvariantAccessesTy &InvMAs) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003849
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003850 if (InvMAs.empty())
3851 return;
3852
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003853 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003854 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003855
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003856 // Get the context under which the statement is executed but remove the error
3857 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003858 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003859 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003860
Tobias Grosser90411a92017-02-16 19:11:33 +00003861 if (isl_set_n_basic_set(DomainCtx) >= MaxDisjunctsInDomain) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003862 auto *AccInst = InvMAs.front().MA->getAccessInstruction();
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003863 invalidate(COMPLEXITY, AccInst->getDebugLoc());
3864 isl_set_free(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003865 for (auto &InvMA : InvMAs)
3866 isl_set_free(InvMA.NonHoistableCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003867 return;
3868 }
3869
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003870 // Project out all parameters that relate to loads in the statement. Otherwise
3871 // we could have cyclic dependences on the constraints under which the
3872 // hoisted loads are executed and we could not determine an order in which to
3873 // pre-load them. This happens because not only lower bounds are part of the
3874 // domain but also upper bounds.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003875 for (auto &InvMA : InvMAs) {
3876 auto *MA = InvMA.MA;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003877 Instruction *AccInst = MA->getAccessInstruction();
3878 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003879 SetVector<Value *> Values;
3880 for (const SCEV *Parameter : Parameters) {
3881 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003882 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003883 if (!Values.count(AccInst))
3884 continue;
3885
3886 if (isl_id *ParamId = getIdForParam(Parameter)) {
3887 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
Tobias Grosserb58ed8d2017-03-17 09:02:53 +00003888 if (Dim >= 0)
3889 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003890 isl_id_free(ParamId);
3891 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003892 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003893 }
3894 }
3895
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003896 for (auto &InvMA : InvMAs) {
3897 auto *MA = InvMA.MA;
3898 auto *NHCtx = InvMA.NonHoistableCtx;
3899
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003900 // Check for another invariant access that accesses the same location as
3901 // MA and if found consolidate them. Otherwise create a new equivalence
3902 // class at the end of InvariantEquivClasses.
3903 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003904 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003905 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3906
Johannes Doerfert85676e32016-04-23 14:32:34 +00003907 auto *MAInvalidCtx = MA->getInvalidContext();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003908 bool NonHoistableCtxIsEmpty = isl_set_is_empty(NHCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003909 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3910
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003911 isl_set *MACtx;
3912 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003913 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty,
3914 NonHoistableCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003915 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003916 isl_set_free(MAInvalidCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003917 isl_set_free(NHCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003918 } else {
3919 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003920 MACtx = isl_set_subtract(MACtx, isl_set_union(MAInvalidCtx, NHCtx));
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003921 MACtx = isl_set_gist_params(MACtx, getContext());
3922 }
3923
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003924 bool Consolidated = false;
3925 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003926 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003927 continue;
3928
Johannes Doerfertdf880232016-03-03 12:26:58 +00003929 // If the pointer and the type is equal check if the access function wrt.
3930 // to the domain is equal too. It can happen that the domain fixes
3931 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003932 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003933 // create a new invariant load equivalence class.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003934 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertdf880232016-03-03 12:26:58 +00003935 if (!MAs.empty()) {
3936 auto *LastMA = MAs.front();
3937
3938 auto *AR = isl_map_range(MA->getAccessRelation());
3939 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3940 bool SameAR = isl_set_is_equal(AR, LastAR);
3941 isl_set_free(AR);
3942 isl_set_free(LastAR);
3943
3944 if (!SameAR)
3945 continue;
3946 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003947
3948 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003949 MAs.push_front(MA);
3950
Johannes Doerfertdf880232016-03-03 12:26:58 +00003951 Consolidated = true;
3952
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003953 // Unify the execution context of the class and this statement.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003954 isl_set *&IAClassDomainCtx = IAClass.ExecutionContext;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003955 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003956 IAClassDomainCtx =
3957 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003958 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003959 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003960 break;
3961 }
3962
3963 if (Consolidated)
3964 continue;
3965
3966 // If we did not consolidate MA, thus did not find an equivalence class
3967 // for it, we create a new one.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003968 InvariantEquivClasses.emplace_back(
3969 InvariantEquivClassTy{PointerSCEV, MemoryAccessList{MA}, MACtx, Ty});
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003970 }
3971
3972 isl_set_free(DomainCtx);
3973}
3974
Tobias Grosser4071cb52017-06-06 23:13:02 +00003975isl::set Scop::getNonHoistableCtx(MemoryAccess *Access, isl::union_map Writes) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003976 // TODO: Loads that are not loop carried, hence are in a statement with
3977 // zero iterators, are by construction invariant, though we
3978 // currently "hoist" them anyway. This is necessary because we allow
3979 // them to be treated as parameters (e.g., in conditions) and our code
3980 // generation would otherwise use the old value.
3981
3982 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003983 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003984
Johannes Doerfertc9765462016-11-17 22:11:56 +00003985 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine() ||
3986 Access->isMemoryIntrinsic())
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003987 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003988
3989 // Skip accesses that have an invariant base pointer which is defined but
3990 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3991 // returns a pointer that is used as a base address. However, as we want
3992 // to hoist indirect pointers, we allow the base pointer to be defined in
3993 // the region if it is also a memory access. Each ScopArrayInfo object
3994 // that has a base pointer origin has a base pointer that is loaded and
3995 // that it is invariant, thus it will be hoisted too. However, if there is
3996 // no base pointer origin we check that the base pointer is defined
3997 // outside the region.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003998 auto *LI = cast<LoadInst>(Access->getAccessInstruction());
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003999 if (hasNonHoistableBasePtrInScop(Access, Writes))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004000 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004001
Tobias Grosser4071cb52017-06-06 23:13:02 +00004002 isl::map AccessRelation = give(Access->getAccessRelation());
4003 assert(!AccessRelation.is_empty());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004004
Tobias Grosser4071cb52017-06-06 23:13:02 +00004005 if (AccessRelation.involves_dims(isl::dim::in, 0, Stmt.getNumIterators()))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004006 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004007
Tobias Grosser4071cb52017-06-06 23:13:02 +00004008 AccessRelation = AccessRelation.intersect_domain(give(Stmt.getDomain()));
4009 isl::set SafeToLoad;
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004010
4011 auto &DL = getFunction().getParent()->getDataLayout();
4012 if (isSafeToLoadUnconditionally(LI->getPointerOperand(), LI->getAlignment(),
4013 DL)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004014 SafeToLoad = isl::set::universe(AccessRelation.get_space().range());
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004015 } else if (BB != LI->getParent()) {
4016 // Skip accesses in non-affine subregions as they might not be executed
4017 // under the same condition as the entry of the non-affine subregion.
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004018 return nullptr;
4019 } else {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004020 SafeToLoad = AccessRelation.range();
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004021 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004022
Tobias Grosser4071cb52017-06-06 23:13:02 +00004023 isl::union_map Written = Writes.intersect_range(SafeToLoad);
4024 isl::set WrittenCtx = Written.params();
4025 bool IsWritten = !WrittenCtx.is_empty();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004026
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004027 if (!IsWritten)
4028 return WrittenCtx;
4029
Tobias Grosser4071cb52017-06-06 23:13:02 +00004030 WrittenCtx = WrittenCtx.remove_divs();
4031 bool TooComplex =
4032 isl_set_n_basic_set(WrittenCtx.get()) >= MaxDisjunctsInDomain;
4033 if (TooComplex || !isRequiredInvariantLoad(LI))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004034 return nullptr;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004035
Tobias Grosser4071cb52017-06-06 23:13:02 +00004036 addAssumption(INVARIANTLOAD, WrittenCtx.copy(), LI->getDebugLoc(),
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004037 AS_RESTRICTION);
4038 return WrittenCtx;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004039}
4040
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004041void Scop::verifyInvariantLoads() {
4042 auto &RIL = getRequiredInvariantLoads();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004043 for (LoadInst *LI : RIL) {
Johannes Doerfert952b5302016-05-23 12:40:48 +00004044 assert(LI && contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00004045 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00004046 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004047 invalidate(INVARIANTLOAD, LI->getDebugLoc());
4048 return;
4049 }
4050 }
4051}
4052
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004053void Scop::hoistInvariantLoads() {
Tobias Grosser0865e7752016-02-29 07:29:42 +00004054 if (!PollyInvariantLoadHoisting)
4055 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004056
Tobias Grosser4071cb52017-06-06 23:13:02 +00004057 isl::union_map Writes = give(getWrites());
Tobias Grosser0865e7752016-02-29 07:29:42 +00004058 for (ScopStmt &Stmt : *this) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004059 InvariantAccessesTy InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004060
Tobias Grosser0865e7752016-02-29 07:29:42 +00004061 for (MemoryAccess *Access : Stmt)
Tobias Grosser4071cb52017-06-06 23:13:02 +00004062 if (isl::set NHCtx = getNonHoistableCtx(Access, Writes))
4063 InvariantAccesses.push_back({Access, NHCtx.release()});
Tobias Grosser0865e7752016-02-29 07:29:42 +00004064
4065 // Transfer the memory access from the statement to the SCoP.
Michael Kruse10071822016-05-23 14:45:58 +00004066 for (auto InvMA : InvariantAccesses)
4067 Stmt.removeMemoryAccess(InvMA.MA);
Tobias Grosser0865e7752016-02-29 07:29:42 +00004068 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004069 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004070}
4071
Tobias Grosserf3adab42017-05-10 10:59:58 +00004072/// Find the canonical scop array info object for a set of invariant load
4073/// hoisted loads. The canonical array is the one that corresponds to the
4074/// first load in the list of accesses which is used as base pointer of a
4075/// scop array.
4076static const ScopArrayInfo *findCanonicalArray(Scop *S,
4077 MemoryAccessList &Accesses) {
4078 for (MemoryAccess *Access : Accesses) {
4079 const ScopArrayInfo *CanonicalArray = S->getScopArrayInfoOrNull(
4080 Access->getAccessInstruction(), MemoryKind::Array);
4081 if (CanonicalArray)
4082 return CanonicalArray;
4083 }
4084 return nullptr;
4085}
4086
4087/// Check if @p Array severs as base array in an invariant load.
4088static bool isUsedForIndirectHoistedLoad(Scop *S, const ScopArrayInfo *Array) {
4089 for (InvariantEquivClassTy &EqClass2 : S->getInvariantAccesses())
4090 for (MemoryAccess *Access2 : EqClass2.InvariantAccesses)
4091 if (Access2->getScopArrayInfo() == Array)
4092 return true;
4093 return false;
4094}
4095
4096/// Replace the base pointer arrays in all memory accesses referencing @p Old,
4097/// with a reference to @p New.
4098static void replaceBasePtrArrays(Scop *S, const ScopArrayInfo *Old,
4099 const ScopArrayInfo *New) {
4100 for (ScopStmt &Stmt : *S)
4101 for (MemoryAccess *Access : Stmt) {
4102 if (Access->getLatestScopArrayInfo() != Old)
4103 continue;
4104
4105 isl_id *Id = New->getBasePtrId();
4106 isl_map *Map = Access->getAccessRelation();
4107 Map = isl_map_set_tuple_id(Map, isl_dim_out, Id);
4108 Access->setAccessRelation(Map);
4109 }
4110}
4111
4112void Scop::canonicalizeDynamicBasePtrs() {
4113 for (InvariantEquivClassTy &EqClass : InvariantEquivClasses) {
4114 MemoryAccessList &BasePtrAccesses = EqClass.InvariantAccesses;
4115
4116 const ScopArrayInfo *CanonicalBasePtrSAI =
4117 findCanonicalArray(this, BasePtrAccesses);
4118
4119 if (!CanonicalBasePtrSAI)
4120 continue;
4121
4122 for (MemoryAccess *BasePtrAccess : BasePtrAccesses) {
4123 const ScopArrayInfo *BasePtrSAI = getScopArrayInfoOrNull(
4124 BasePtrAccess->getAccessInstruction(), MemoryKind::Array);
4125 if (!BasePtrSAI || BasePtrSAI == CanonicalBasePtrSAI ||
4126 !BasePtrSAI->isCompatibleWith(CanonicalBasePtrSAI))
4127 continue;
4128
4129 // we currently do not canonicalize arrays where some accesses are
4130 // hoisted as invariant loads. If we would, we need to update the access
4131 // function of the invariant loads as well. However, as this is not a
4132 // very common situation, we leave this for now to avoid further
4133 // complexity increases.
4134 if (isUsedForIndirectHoistedLoad(this, BasePtrSAI))
4135 continue;
4136
4137 replaceBasePtrArrays(this, BasePtrSAI, CanonicalBasePtrSAI);
4138 }
4139 }
4140}
4141
Michael Kruseb738ffa2017-06-28 13:02:43 +00004142ScopArrayInfo *Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
4143 ArrayRef<const SCEV *> Sizes,
4144 MemoryKind Kind,
4145 const char *BaseName) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004146 assert((BasePtr || BaseName) &&
4147 "BasePtr and BaseName can not be nullptr at the same time.");
4148 assert(!(BasePtr && BaseName) && "BaseName is redundant.");
4149 auto &SAI = BasePtr ? ScopArrayInfoMap[std::make_pair(BasePtr, Kind)]
4150 : ScopArrayNameMap[BaseName];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004151 if (!SAI) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004152 auto &DL = getFunction().getParent()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00004153 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +00004154 DL, this, BaseName));
4155 ScopArrayInfoSet.insert(SAI.get());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004156 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004157 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00004158 // In case of mismatching array sizes, we bail out by setting the run-time
4159 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004160 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004161 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004162 }
Tobias Grosserab671442015-05-23 05:58:27 +00004163 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004164}
4165
Michael Kruseb738ffa2017-06-28 13:02:43 +00004166ScopArrayInfo *Scop::createScopArrayInfo(Type *ElementType,
4167 const std::string &BaseName,
4168 const std::vector<unsigned> &Sizes) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004169 auto *DimSizeType = Type::getInt64Ty(getSE()->getContext());
4170 std::vector<const SCEV *> SCEVSizes;
4171
4172 for (auto size : Sizes)
Roman Gareevf5aff702016-09-12 17:08:31 +00004173 if (size)
4174 SCEVSizes.push_back(getSE()->getConstant(DimSizeType, size, false));
4175 else
4176 SCEVSizes.push_back(nullptr);
Roman Gareevd7754a12016-07-30 09:25:51 +00004177
Tobias Grosser4d5a9172017-01-14 20:25:44 +00004178 auto *SAI = getOrCreateScopArrayInfo(nullptr, ElementType, SCEVSizes,
4179 MemoryKind::Array, BaseName.c_str());
Roman Gareevd7754a12016-07-30 09:25:51 +00004180 return SAI;
4181}
4182
Tobias Grosserf3adab42017-05-10 10:59:58 +00004183const ScopArrayInfo *Scop::getScopArrayInfoOrNull(Value *BasePtr,
4184 MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00004185 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004186 return SAI;
4187}
4188
4189const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, MemoryKind Kind) {
4190 auto *SAI = getScopArrayInfoOrNull(BasePtr, Kind);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004191 assert(SAI && "No ScopArrayInfo available for this base pointer");
4192 return SAI;
4193}
4194
Tobias Grosser74394f02013-01-14 22:40:23 +00004195std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004196
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004197std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004198 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004199 return stringFromIslObj(AssumedContext);
4200}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004201
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004202std::string Scop::getInvalidContextStr() const {
4203 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004204}
Tobias Grosser75805372011-04-29 06:27:02 +00004205
4206std::string Scop::getNameStr() const {
4207 std::string ExitName, EntryName;
Siddharth Bhat07bee292017-06-02 08:01:22 +00004208 std::tie(EntryName, ExitName) = getEntryExitStr();
4209 return EntryName + "---" + ExitName;
4210}
4211
4212std::pair<std::string, std::string> Scop::getEntryExitStr() const {
4213 std::string ExitName, EntryName;
Tobias Grosser75805372011-04-29 06:27:02 +00004214 raw_string_ostream ExitStr(ExitName);
4215 raw_string_ostream EntryStr(EntryName);
4216
Tobias Grosserf240b482014-01-09 10:42:15 +00004217 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004218 EntryStr.str();
4219
4220 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00004221 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004222 ExitStr.str();
4223 } else
4224 ExitName = "FunctionExit";
4225
Siddharth Bhat07bee292017-06-02 08:01:22 +00004226 return std::make_pair(EntryName, ExitName);
Tobias Grosser75805372011-04-29 06:27:02 +00004227}
4228
Tobias Grosser74394f02013-01-14 22:40:23 +00004229__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00004230__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00004231 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00004232}
4233
Tobias Grossere86109f2013-10-29 21:05:49 +00004234__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004235 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00004236 return isl_set_copy(AssumedContext);
4237}
4238
Michael Krusef3091bf2017-03-17 13:09:52 +00004239bool Scop::isProfitable(bool ScalarsAreUnprofitable) const {
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004240 if (PollyProcessUnprofitable)
4241 return true;
4242
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004243 if (isEmpty())
4244 return false;
4245
4246 unsigned OptimizableStmtsOrLoops = 0;
4247 for (auto &Stmt : *this) {
4248 if (Stmt.getNumIterators() == 0)
4249 continue;
4250
4251 bool ContainsArrayAccs = false;
4252 bool ContainsScalarAccs = false;
4253 for (auto *MA : Stmt) {
4254 if (MA->isRead())
4255 continue;
Michael Krusef3091bf2017-03-17 13:09:52 +00004256 ContainsArrayAccs |= MA->isLatestArrayKind();
4257 ContainsScalarAccs |= MA->isLatestScalarKind();
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004258 }
4259
Michael Krusef3091bf2017-03-17 13:09:52 +00004260 if (!ScalarsAreUnprofitable || (ContainsArrayAccs && !ContainsScalarAccs))
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004261 OptimizableStmtsOrLoops += Stmt.getNumIterators();
4262 }
4263
4264 return OptimizableStmtsOrLoops > 1;
4265}
4266
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00004267bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004268 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004269 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00004270 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
4271 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
4272 isl_set_is_subset(PositiveContext, NegativeContext));
4273 isl_set_free(PositiveContext);
4274 if (!IsFeasible) {
4275 isl_set_free(NegativeContext);
4276 return false;
4277 }
4278
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004279 auto *DomainContext = isl_union_set_params(getDomains());
4280 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00004281 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004282 isl_set_free(NegativeContext);
4283 isl_set_free(DomainContext);
4284
Johannes Doerfert43788c52015-08-20 05:58:56 +00004285 return IsFeasible;
4286}
4287
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004288static std::string toString(AssumptionKind Kind) {
4289 switch (Kind) {
4290 case ALIASING:
4291 return "No-aliasing";
4292 case INBOUNDS:
4293 return "Inbounds";
4294 case WRAPPING:
4295 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00004296 case UNSIGNED:
4297 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004298 case COMPLEXITY:
4299 return "Low complexity";
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004300 case PROFITABLE:
4301 return "Profitable";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004302 case ERRORBLOCK:
4303 return "No-error";
4304 case INFINITELOOP:
4305 return "Finite loop";
4306 case INVARIANTLOAD:
4307 return "Invariant load";
4308 case DELINEARIZATION:
4309 return "Delinearization";
4310 }
4311 llvm_unreachable("Unknown AssumptionKind!");
4312}
4313
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004314bool Scop::isEffectiveAssumption(__isl_keep isl_set *Set, AssumptionSign Sign) {
4315 if (Sign == AS_ASSUMPTION) {
4316 if (isl_set_is_subset(Context, Set))
4317 return false;
4318
4319 if (isl_set_is_subset(AssumedContext, Set))
4320 return false;
4321 } else {
4322 if (isl_set_is_disjoint(Set, Context))
4323 return false;
4324
4325 if (isl_set_is_subset(Set, InvalidContext))
4326 return false;
4327 }
4328 return true;
4329}
4330
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004331bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
4332 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004333 if (PollyRemarksMinimal && !isEffectiveAssumption(Set, Sign))
4334 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004335
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004336 // Do never emit trivial assumptions as they only clutter the output.
4337 if (!PollyRemarksMinimal) {
4338 isl_set *Univ = nullptr;
4339 if (Sign == AS_ASSUMPTION)
4340 Univ = isl_set_universe(isl_set_get_space(Set));
4341
4342 bool IsTrivial = (Sign == AS_RESTRICTION && isl_set_is_empty(Set)) ||
4343 (Sign == AS_ASSUMPTION && isl_set_is_equal(Univ, Set));
4344 isl_set_free(Univ);
4345
4346 if (IsTrivial)
4347 return false;
4348 }
4349
Johannes Doerfertcd195322016-11-17 21:41:08 +00004350 switch (Kind) {
4351 case ALIASING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004352 AssumptionsAliasing++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004353 break;
4354 case INBOUNDS:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004355 AssumptionsInbounds++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004356 break;
4357 case WRAPPING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004358 AssumptionsWrapping++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004359 break;
4360 case UNSIGNED:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004361 AssumptionsUnsigned++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004362 break;
4363 case COMPLEXITY:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004364 AssumptionsComplexity++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004365 break;
4366 case PROFITABLE:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004367 AssumptionsUnprofitable++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004368 break;
4369 case ERRORBLOCK:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004370 AssumptionsErrorBlock++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004371 break;
4372 case INFINITELOOP:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004373 AssumptionsInfiniteLoop++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004374 break;
4375 case INVARIANTLOAD:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004376 AssumptionsInvariantLoad++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004377 break;
4378 case DELINEARIZATION:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004379 AssumptionsDelinearization++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004380 break;
4381 }
4382
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004383 auto &F = getFunction();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004384 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
4385 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004386 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004387 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004388}
4389
4390void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004391 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004392 // Simplify the assumptions/restrictions first.
4393 Set = isl_set_gist_params(Set, getContext());
4394
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004395 if (!trackAssumption(Kind, Set, Loc, Sign)) {
4396 isl_set_free(Set);
4397 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00004398 }
4399
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004400 if (Sign == AS_ASSUMPTION) {
4401 AssumedContext = isl_set_intersect(AssumedContext, Set);
4402 AssumedContext = isl_set_coalesce(AssumedContext);
4403 } else {
4404 InvalidContext = isl_set_union(InvalidContext, Set);
4405 InvalidContext = isl_set_coalesce(InvalidContext);
4406 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004407}
4408
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004409void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004410 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Tobias Grosserf67433a2016-11-10 11:44:10 +00004411 assert((isl_set_is_params(Set) || BB) &&
4412 "Assumptions without a basic block must be parameter sets");
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004413 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004414}
4415
4416void Scop::addRecordedAssumptions() {
4417 while (!RecordedAssumptions.empty()) {
4418 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004419
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004420 if (!AS.BB) {
4421 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign);
4422 continue;
4423 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004424
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004425 // If the domain was deleted the assumptions are void.
4426 isl_set *Dom = getDomainConditions(AS.BB);
4427 if (!Dom) {
4428 isl_set_free(AS.Set);
4429 continue;
4430 }
4431
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004432 // If a basic block was given use its domain to simplify the assumption.
4433 // In case of restrictions we know they only have to hold on the domain,
4434 // thus we can intersect them with the domain of the block. However, for
4435 // assumptions the domain has to imply them, thus:
4436 // _ _____
4437 // Dom => S <==> A v B <==> A - B
4438 //
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004439 // To avoid the complement we will register A - B as a restriction not an
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004440 // assumption.
4441 isl_set *S = AS.Set;
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004442 if (AS.Sign == AS_RESTRICTION)
4443 S = isl_set_params(isl_set_intersect(S, Dom));
4444 else /* (AS.Sign == AS_ASSUMPTION) */
4445 S = isl_set_params(isl_set_subtract(Dom, S));
4446
4447 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004448 }
4449}
4450
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004451void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004452 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004453}
4454
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004455__isl_give isl_set *Scop::getInvalidContext() const {
4456 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004457}
4458
Tobias Grosser75805372011-04-29 06:27:02 +00004459void Scop::printContext(raw_ostream &OS) const {
4460 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004461 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00004462
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004463 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004464 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004465
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004466 OS.indent(4) << "Invalid Context:\n";
4467 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004468
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00004469 unsigned Dim = 0;
4470 for (const SCEV *Parameter : Parameters)
4471 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004472}
4473
Johannes Doerfertb164c792014-09-18 11:17:17 +00004474void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004475 int noOfGroups = 0;
4476 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004477 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004478 noOfGroups += 1;
4479 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004480 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004481 }
4482
Tobias Grosserbb853c22015-07-25 12:31:03 +00004483 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00004484 if (MinMaxAliasGroups.empty()) {
4485 OS.indent(8) << "n/a\n";
4486 return;
4487 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004488
Tobias Grosserbb853c22015-07-25 12:31:03 +00004489 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004490
4491 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004492 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004493 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004494 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004495 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4496 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004497 }
4498 OS << " ]]\n";
4499 }
4500
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004501 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004502 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00004503 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004504 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004505 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4506 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004507 }
4508 OS << " ]]\n";
4509 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00004510 }
4511}
4512
Tobias Grosser75805372011-04-29 06:27:02 +00004513void Scop::printStatements(raw_ostream &OS) const {
4514 OS << "Statements {\n";
4515
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004516 for (const ScopStmt &Stmt : *this)
4517 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00004518
4519 OS.indent(4) << "}\n";
4520}
4521
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004522void Scop::printArrayInfo(raw_ostream &OS) const {
4523 OS << "Arrays {\n";
4524
Tobias Grosserab671442015-05-23 05:58:27 +00004525 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004526 Array->print(OS);
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004527
4528 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004529
4530 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
4531
4532 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004533 Array->print(OS, /* SizeAsPwAff */ true);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004534
4535 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004536}
4537
Tobias Grosser75805372011-04-29 06:27:02 +00004538void Scop::print(raw_ostream &OS) const {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004539 OS.indent(4) << "Function: " << getFunction().getName() << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00004540 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00004541 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004542 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004543 for (const auto &IAClass : InvariantEquivClasses) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004544 const auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004545 if (MAs.empty()) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004546 OS.indent(12) << "Class Pointer: " << *IAClass.IdentifyingPointer << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004547 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004548 MAs.front()->print(OS);
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004549 OS.indent(12) << "Execution Context: " << IAClass.ExecutionContext
4550 << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004551 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004552 }
4553 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004554 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004555 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00004556 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00004557 printStatements(OS.indent(4));
4558}
4559
4560void Scop::dump() const { print(dbgs()); }
4561
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004562isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00004563
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004564__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
4565 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004566 // First try to use the SCEVAffinator to generate a piecewise defined
4567 // affine function from @p E in the context of @p BB. If that tasks becomes to
4568 // complex the affinator might return a nullptr. In such a case we invalidate
4569 // the SCoP and return a dummy value. This way we do not need to add error
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004570 // handling code to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004571 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004572 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00004573 // TODO: We could use a heuristic and either use:
4574 // SCEVAffinator::takeNonNegativeAssumption
4575 // or
4576 // SCEVAffinator::interpretAsUnsigned
4577 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004578 if (NonNegative)
4579 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004580 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004581 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004582
4583 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
4584 invalidate(COMPLEXITY, DL);
4585 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00004586}
4587
Tobias Grosser808cd692015-07-14 09:33:13 +00004588__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosser941cb7d2017-03-17 09:02:50 +00004589 isl_space *EmptySpace = isl_space_params_alloc(getIslCtx(), 0);
4590 isl_union_set *Domain = isl_union_set_empty(EmptySpace);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004591
Tobias Grosser808cd692015-07-14 09:33:13 +00004592 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004593 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004594
4595 return Domain;
4596}
4597
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004598__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
4599 PWACtx PWAC = getPwAff(E, BB);
4600 isl_set_free(PWAC.second);
4601 return PWAC.first;
4602}
4603
Tobias Grossere5a35142015-11-12 14:07:09 +00004604__isl_give isl_union_map *
4605Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
4606 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004607
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004608 for (ScopStmt &Stmt : *this) {
4609 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00004610 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004611 continue;
4612
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004613 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004614 isl_map *AccessDomain = MA->getAccessRelation();
4615 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00004616 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004617 }
4618 }
Tobias Grossere5a35142015-11-12 14:07:09 +00004619 return isl_union_map_coalesce(Accesses);
4620}
4621
4622__isl_give isl_union_map *Scop::getMustWrites() {
4623 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004624}
4625
4626__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004627 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004628}
4629
Tobias Grosser37eb4222014-02-20 21:43:54 +00004630__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004631 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004632}
4633
4634__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004635 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004636}
4637
Tobias Grosser2ac23382015-11-12 14:07:13 +00004638__isl_give isl_union_map *Scop::getAccesses() {
4639 return getAccessesOfType([](MemoryAccess &MA) { return true; });
4640}
4641
Roman Gareevb3224ad2016-09-14 06:26:09 +00004642// Check whether @p Node is an extension node.
4643//
4644// @return true if @p Node is an extension node.
4645isl_bool isNotExtNode(__isl_keep isl_schedule_node *Node, void *User) {
4646 if (isl_schedule_node_get_type(Node) == isl_schedule_node_extension)
4647 return isl_bool_error;
4648 else
4649 return isl_bool_true;
4650}
4651
4652bool Scop::containsExtensionNode(__isl_keep isl_schedule *Schedule) {
4653 return isl_schedule_foreach_schedule_node_top_down(Schedule, isNotExtNode,
4654 nullptr) == isl_stat_error;
4655}
4656
Tobias Grosser808cd692015-07-14 09:33:13 +00004657__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004658 auto *Tree = getScheduleTree();
Roman Gareevb3224ad2016-09-14 06:26:09 +00004659 if (containsExtensionNode(Tree)) {
4660 isl_schedule_free(Tree);
4661 return nullptr;
4662 }
Johannes Doerferta90943d2016-02-21 16:37:25 +00004663 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00004664 isl_schedule_free(Tree);
4665 return S;
4666}
Tobias Grosser37eb4222014-02-20 21:43:54 +00004667
Tobias Grosser808cd692015-07-14 09:33:13 +00004668__isl_give isl_schedule *Scop::getScheduleTree() const {
4669 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
4670 getDomains());
4671}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00004672
Tobias Grosser808cd692015-07-14 09:33:13 +00004673void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
4674 auto *S = isl_schedule_from_domain(getDomains());
4675 S = isl_schedule_insert_partial_schedule(
4676 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
4677 isl_schedule_free(Schedule);
4678 Schedule = S;
4679}
4680
4681void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
4682 isl_schedule_free(Schedule);
4683 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004684}
4685
4686bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
4687 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004688 for (ScopStmt &Stmt : *this) {
4689 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00004690 isl_union_set *NewStmtDomain = isl_union_set_intersect(
4691 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
4692
4693 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
4694 isl_union_set_free(StmtDomain);
4695 isl_union_set_free(NewStmtDomain);
4696 continue;
4697 }
4698
4699 Changed = true;
4700
4701 isl_union_set_free(StmtDomain);
4702 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
4703
4704 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004705 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004706 isl_union_set_free(NewStmtDomain);
4707 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004708 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004709 }
4710 isl_union_set_free(Domain);
4711 return Changed;
4712}
4713
Tobias Grosser75805372011-04-29 06:27:02 +00004714ScalarEvolution *Scop::getSE() const { return SE; }
4715
Tobias Grosserc80d6972016-09-02 06:33:33 +00004716// Create an isl_multi_union_aff that defines an identity mapping from the
4717// elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00004718//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004719// # Example:
4720//
4721// Domain: { A[i,j]; B[i,j,k] }
4722// N: 1
4723//
4724// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
4725//
4726// @param USet A union set describing the elements for which to generate a
4727// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00004728// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004729// @returns A mapping from USet to its N-th dimension.
Tobias Grosser99320862017-05-26 17:22:03 +00004730static isl::multi_union_pw_aff mapToDimension(isl::union_set USet, int N) {
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004731 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00004732 assert(USet);
Siddharth Bhat8bb436e2017-05-29 11:34:29 +00004733 assert(!USet.is_empty());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004734
Tobias Grosser99320862017-05-26 17:22:03 +00004735 auto Result = isl::union_pw_multi_aff::empty(USet.get_space());
Tobias Grosser808cd692015-07-14 09:33:13 +00004736
Tobias Grosser99320862017-05-26 17:22:03 +00004737 auto Lambda = [&Result, N](isl::set S) -> isl::stat {
4738 int Dim = S.dim(isl::dim::set);
4739 auto PMA = isl::pw_multi_aff::project_out_map(S.get_space(), isl::dim::set,
4740 N, Dim - N);
4741 if (N > 1)
4742 PMA = PMA.drop_dims(isl::dim::out, 0, N - 1);
Tobias Grosser808cd692015-07-14 09:33:13 +00004743
Tobias Grosser99320862017-05-26 17:22:03 +00004744 Result = Result.add_pw_multi_aff(PMA);
4745 return isl::stat::ok;
4746 };
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004747
Tobias Grosser99320862017-05-26 17:22:03 +00004748 isl::stat Res = USet.foreach_set(Lambda);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004749 (void)Res;
4750
Tobias Grosser99320862017-05-26 17:22:03 +00004751 assert(Res == isl::stat::ok);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004752
Tobias Grosser99320862017-05-26 17:22:03 +00004753 return isl::multi_union_pw_aff(isl::union_pw_multi_aff(Result));
Tobias Grosser808cd692015-07-14 09:33:13 +00004754}
4755
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004756void Scop::addScopStmt(BasicBlock *BB, Loop *SurroundingLoop,
4757 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004758 assert(BB && "Unexpected nullptr!");
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004759 Stmts.emplace_back(*this, *BB, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004760 auto *Stmt = &Stmts.back();
4761 StmtMap[BB] = Stmt;
4762}
4763
Michael Kruse55454072017-03-15 22:16:43 +00004764void Scop::addScopStmt(Region *R, Loop *SurroundingLoop) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004765 assert(R && "Unexpected nullptr!");
Michael Kruse55454072017-03-15 22:16:43 +00004766 Stmts.emplace_back(*this, *R, SurroundingLoop);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004767 auto *Stmt = &Stmts.back();
4768 for (BasicBlock *BB : R->blocks())
Tobias Grosser808cd692015-07-14 09:33:13 +00004769 StmtMap[BB] = Stmt;
Tobias Grosser808cd692015-07-14 09:33:13 +00004770}
4771
Roman Gareevb3224ad2016-09-14 06:26:09 +00004772ScopStmt *Scop::addScopStmt(__isl_take isl_map *SourceRel,
4773 __isl_take isl_map *TargetRel,
4774 __isl_take isl_set *Domain) {
Tobias Grossereba86a12016-11-09 04:24:49 +00004775#ifndef NDEBUG
Tobias Grosser744740a2016-11-05 21:02:43 +00004776 isl_set *SourceDomain = isl_map_domain(isl_map_copy(SourceRel));
4777 isl_set *TargetDomain = isl_map_domain(isl_map_copy(TargetRel));
4778 assert(isl_set_is_subset(Domain, TargetDomain) &&
4779 "Target access not defined for complete statement domain");
4780 assert(isl_set_is_subset(Domain, SourceDomain) &&
4781 "Source access not defined for complete statement domain");
4782 isl_set_free(SourceDomain);
4783 isl_set_free(TargetDomain);
Tobias Grossereba86a12016-11-09 04:24:49 +00004784#endif
Roman Gareevb3224ad2016-09-14 06:26:09 +00004785 Stmts.emplace_back(*this, SourceRel, TargetRel, Domain);
4786 CopyStmtsNum++;
4787 return &(Stmts.back());
4788}
4789
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004790void Scop::buildSchedule(LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004791 Loop *L = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004792 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004793 buildSchedule(getRegion().getNode(), LoopStack, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004794 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4795 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004796}
4797
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004798/// To generate a schedule for the elements in a Region we traverse the Region
4799/// in reverse-post-order and add the contained RegionNodes in traversal order
4800/// to the schedule of the loop that is currently at the top of the LoopStack.
4801/// For loop-free codes, this results in a correct sequential ordering.
4802///
4803/// Example:
4804/// bb1(0)
4805/// / \.
4806/// bb2(1) bb3(2)
4807/// \ / \.
4808/// bb4(3) bb5(4)
4809/// \ /
4810/// bb6(5)
4811///
4812/// Including loops requires additional processing. Whenever a loop header is
4813/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4814/// from an empty schedule, we first process all RegionNodes that are within
4815/// this loop and complete the sequential schedule at this loop-level before
4816/// processing about any other nodes. To implement this
4817/// loop-nodes-first-processing, the reverse post-order traversal is
4818/// insufficient. Hence, we additionally check if the traversal yields
4819/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4820/// These region-nodes are then queue and only traverse after the all nodes
4821/// within the current loop have been processed.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004822void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004823 Loop *OuterScopLoop = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004824
4825 ReversePostOrderTraversal<Region *> RTraversal(R);
4826 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4827 std::deque<RegionNode *> DelayList;
4828 bool LastRNWaiting = false;
4829
4830 // Iterate over the region @p R in reverse post-order but queue
4831 // sub-regions/blocks iff they are not part of the last encountered but not
4832 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4833 // that we queued the last sub-region/block from the reverse post-order
4834 // iterator. If it is set we have to explore the next sub-region/block from
4835 // the iterator (if any) to guarantee progress. If it is not set we first try
4836 // the next queued sub-region/blocks.
4837 while (!WorkList.empty() || !DelayList.empty()) {
4838 RegionNode *RN;
4839
4840 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4841 RN = WorkList.front();
4842 WorkList.pop_front();
4843 LastRNWaiting = false;
4844 } else {
4845 RN = DelayList.front();
4846 DelayList.pop_front();
4847 }
4848
4849 Loop *L = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00004850 if (!contains(L))
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004851 L = OuterScopLoop;
4852
Tobias Grosser151ae322016-04-03 19:36:52 +00004853 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004854 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004855 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004856 LastRNWaiting = true;
4857 DelayList.push_back(RN);
4858 continue;
4859 }
4860 LoopStack.push_back({L, nullptr, 0});
4861 }
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004862 buildSchedule(RN, LoopStack, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004863 }
4864
4865 return;
4866}
4867
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004868void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004869
Tobias Grosser8362c262016-01-06 15:30:06 +00004870 if (RN->isSubRegion()) {
4871 auto *LocalRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004872 if (!isNonAffineSubRegion(LocalRegion)) {
4873 buildSchedule(LocalRegion, LoopStack, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004874 return;
4875 }
4876 }
Michael Kruse046dde42015-08-10 13:01:57 +00004877
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004878 auto &LoopData = LoopStack.back();
4879 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004880
Michael Kruse6f7721f2016-02-24 22:08:19 +00004881 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004882 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4883 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004884 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004885 }
4886
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004887 // Check if we just processed the last node in this loop. If we did, finalize
4888 // the loop by:
4889 //
4890 // - adding new schedule dimensions
4891 // - folding the resulting schedule into the parent loop schedule
4892 // - dropping the loop schedule from the LoopStack.
4893 //
4894 // Then continue to check surrounding loops, which might also have been
4895 // completed by this node.
4896 while (LoopData.L &&
Tobias Grosserce69e7b2017-03-07 16:17:55 +00004897 LoopData.NumBlocksProcessed == getNumBlocksInLoop(LoopData.L)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004898 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004899 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004900
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004901 LoopStack.pop_back();
4902 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004903
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004904 if (Schedule) {
Tobias Grosser99320862017-05-26 17:22:03 +00004905 isl::union_set Domain = give(isl_schedule_get_domain(Schedule));
4906 isl::multi_union_pw_aff MUPA = mapToDimension(Domain, LoopStack.size());
4907 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA.release());
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004908 NextLoopData.Schedule =
4909 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004910 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004911
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004912 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4913 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004914 }
Tobias Grosser75805372011-04-29 06:27:02 +00004915}
4916
Michael Kruse6f7721f2016-02-24 22:08:19 +00004917ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004918 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004919 if (StmtMapIt == StmtMap.end())
4920 return nullptr;
4921 return StmtMapIt->second;
4922}
4923
Michael Kruse6f7721f2016-02-24 22:08:19 +00004924ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4925 if (RN->isSubRegion())
4926 return getStmtFor(RN->getNodeAs<Region>());
4927 return getStmtFor(RN->getNodeAs<BasicBlock>());
4928}
4929
4930ScopStmt *Scop::getStmtFor(Region *R) const {
4931 ScopStmt *Stmt = getStmtFor(R->getEntry());
4932 assert(!Stmt || Stmt->getRegion() == R);
4933 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004934}
4935
Johannes Doerfert96425c22015-08-30 21:13:53 +00004936int Scop::getRelativeLoopDepth(const Loop *L) const {
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004937 if (!L || !R.contains(L))
Johannes Doerfert96425c22015-08-30 21:13:53 +00004938 return -1;
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004939 // outermostLoopInRegion always returns nullptr for top level regions
4940 if (R.isTopLevelRegion()) {
4941 // LoopInfo's depths start at 1, we start at 0
4942 return L->getLoopDepth() - 1;
4943 } else {
4944 Loop *OuterLoop = R.outermostLoopInRegion(const_cast<Loop *>(L));
4945 assert(OuterLoop);
4946 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4947 }
Johannes Doerfertd020b772015-08-27 06:53:52 +00004948}
4949
Roman Gareevd7754a12016-07-30 09:25:51 +00004950ScopArrayInfo *Scop::getArrayInfoByName(const std::string BaseName) {
4951 for (auto &SAI : arrays()) {
4952 if (SAI->getName() == BaseName)
4953 return SAI;
4954 }
4955 return nullptr;
4956}
4957
Johannes Doerfert99191c72016-05-31 09:41:04 +00004958//===----------------------------------------------------------------------===//
4959void ScopInfoRegionPass::getAnalysisUsage(AnalysisUsage &AU) const {
4960 AU.addRequired<LoopInfoWrapperPass>();
4961 AU.addRequired<RegionInfoPass>();
4962 AU.addRequired<DominatorTreeWrapperPass>();
4963 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00004964 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004965 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00004966 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004967 AU.setPreservesAll();
4968}
4969
Tobias Grossercd01a362017-02-17 08:12:36 +00004970void updateLoopCountStatistic(ScopDetection::LoopStats Stats) {
4971 NumLoopsInScop += Stats.NumLoops;
4972 MaxNumLoopsInScop =
4973 std::max(MaxNumLoopsInScop.getValue(), (unsigned)Stats.NumLoops);
4974
Tobias Grossercd01a362017-02-17 08:12:36 +00004975 if (Stats.MaxDepth == 1)
4976 NumScopsDepthOne++;
4977 else if (Stats.MaxDepth == 2)
4978 NumScopsDepthTwo++;
4979 else if (Stats.MaxDepth == 3)
4980 NumScopsDepthThree++;
4981 else if (Stats.MaxDepth == 4)
4982 NumScopsDepthFour++;
4983 else if (Stats.MaxDepth == 5)
4984 NumScopsDepthFive++;
4985 else
4986 NumScopsDepthLarger++;
4987}
4988
Johannes Doerfert99191c72016-05-31 09:41:04 +00004989bool ScopInfoRegionPass::runOnRegion(Region *R, RGPassManager &RGM) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00004990 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert99191c72016-05-31 09:41:04 +00004991
4992 if (!SD.isMaxRegionInScop(*R))
4993 return false;
4994
4995 Function *F = R->getEntry()->getParent();
4996 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4997 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4998 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
4999 auto const &DL = F->getParent()->getDataLayout();
5000 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005001 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005002
Michael Kruse89b1f942017-03-17 13:56:53 +00005003 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005004 S = SB.getScop(); // take ownership of scop object
Tobias Grossercd01a362017-02-17 08:12:36 +00005005
5006 if (S) {
5007 ScopDetection::LoopStats Stats =
5008 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
5009 updateLoopCountStatistic(Stats);
5010 }
5011
Tobias Grosser75805372011-04-29 06:27:02 +00005012 return false;
5013}
5014
Johannes Doerfert99191c72016-05-31 09:41:04 +00005015void ScopInfoRegionPass::print(raw_ostream &OS, const Module *) const {
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005016 if (S)
5017 S->print(OS);
5018 else
5019 OS << "Invalid Scop!\n";
Johannes Doerfert99191c72016-05-31 09:41:04 +00005020}
Tobias Grosser75805372011-04-29 06:27:02 +00005021
Johannes Doerfert99191c72016-05-31 09:41:04 +00005022char ScopInfoRegionPass::ID = 0;
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005023
Johannes Doerfert99191c72016-05-31 09:41:04 +00005024Pass *polly::createScopInfoRegionPassPass() { return new ScopInfoRegionPass(); }
5025
5026INITIALIZE_PASS_BEGIN(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005027 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005028 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00005029INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005030INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00005031INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00005032INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00005033INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005034INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert96425c22015-08-30 21:13:53 +00005035INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005036INITIALIZE_PASS_END(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005037 "Polly - Create polyhedral description of Scops", false,
5038 false)
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005039
5040//===----------------------------------------------------------------------===//
Philip Pfaffe838e0882017-05-15 12:55:14 +00005041ScopInfo::ScopInfo(const DataLayout &DL, ScopDetection &SD, ScalarEvolution &SE,
5042 LoopInfo &LI, AliasAnalysis &AA, DominatorTree &DT,
5043 AssumptionCache &AC) {
Michael Krusea6d48f52017-06-08 12:06:15 +00005044 /// Create polyhedral description of scops for all the valid regions of a
Philip Pfaffe838e0882017-05-15 12:55:14 +00005045 /// function.
5046 for (auto &It : SD) {
5047 Region *R = const_cast<Region *>(It);
5048 if (!SD.isMaxRegionInScop(*R))
5049 continue;
5050
5051 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
5052 std::unique_ptr<Scop> S = SB.getScop();
5053 if (!S)
5054 continue;
5055 bool Inserted = RegionToScopMap.insert({R, std::move(S)}).second;
5056 assert(Inserted && "Building Scop for the same region twice!");
5057 (void)Inserted;
5058 }
5059}
5060
5061AnalysisKey ScopInfoAnalysis::Key;
5062
5063ScopInfoAnalysis::Result ScopInfoAnalysis::run(Function &F,
5064 FunctionAnalysisManager &FAM) {
5065 auto &SD = FAM.getResult<ScopAnalysis>(F);
5066 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
5067 auto &LI = FAM.getResult<LoopAnalysis>(F);
5068 auto &AA = FAM.getResult<AAManager>(F);
5069 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
5070 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
5071 auto &DL = F.getParent()->getDataLayout();
5072 return {DL, SD, SE, LI, AA, DT, AC};
5073}
5074
5075PreservedAnalyses ScopInfoPrinterPass::run(Function &F,
5076 FunctionAnalysisManager &FAM) {
5077 auto &SI = FAM.getResult<ScopInfoAnalysis>(F);
5078 for (auto &It : SI) {
5079 if (It.second)
5080 It.second->print(Stream);
5081 else
5082 Stream << "Invalid Scop!\n";
5083 }
5084 return PreservedAnalyses::all();
5085}
5086
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005087void ScopInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
5088 AU.addRequired<LoopInfoWrapperPass>();
5089 AU.addRequired<RegionInfoPass>();
5090 AU.addRequired<DominatorTreeWrapperPass>();
5091 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005092 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005093 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005094 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005095 AU.setPreservesAll();
5096}
5097
5098bool ScopInfoWrapperPass::runOnFunction(Function &F) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005099 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005100 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5101 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5102 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5103 auto const &DL = F.getParent()->getDataLayout();
5104 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005105 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005106
Philip Pfaffe838e0882017-05-15 12:55:14 +00005107 Result.reset(new ScopInfo{DL, SD, SE, LI, AA, DT, AC});
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005108 return false;
5109}
5110
5111void ScopInfoWrapperPass::print(raw_ostream &OS, const Module *) const {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005112 for (auto &It : *Result) {
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005113 if (It.second)
5114 It.second->print(OS);
5115 else
5116 OS << "Invalid Scop!\n";
5117 }
5118}
5119
5120char ScopInfoWrapperPass::ID = 0;
5121
5122Pass *polly::createScopInfoWrapperPassPass() {
5123 return new ScopInfoWrapperPass();
5124}
5125
5126INITIALIZE_PASS_BEGIN(
5127 ScopInfoWrapperPass, "polly-function-scops",
5128 "Polly - Create polyhedral description of all Scops of a function", false,
5129 false);
5130INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005131INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005132INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
5133INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
5134INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005135INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005136INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
5137INITIALIZE_PASS_END(
5138 ScopInfoWrapperPass, "polly-function-scops",
5139 "Polly - Create polyhedral description of all Scops of a function", false,
5140 false)