blob: b89ed718855053ede04c145823a567ebc2552b09 [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);
Tobias Grosser4556c9b2017-07-17 20:47:10 +00001243 NewAccess = isl_map_gist_domain(NewAccess, getStatement()->getDomain());
Tobias Grosser166c4222015-09-05 07:46:40 +00001244 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001245}
Tobias Grosser75805372011-04-29 06:27:02 +00001246
Michael Kruse706f79a2017-05-21 22:46:57 +00001247bool MemoryAccess::isLatestPartialAccess() const {
1248 isl::set StmtDom = give(getStatement()->getDomain());
1249 isl::set AccDom = give(isl_map_domain(getLatestAccessRelation()));
1250
1251 return isl_set_is_subset(StmtDom.keep(), AccDom.keep()) == isl_bool_false;
1252}
1253
Tobias Grosser75805372011-04-29 06:27:02 +00001254//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001255
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001256__isl_give isl_map *ScopStmt::getSchedule() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001257 isl_set *Domain = getDomain();
1258 if (isl_set_is_empty(Domain)) {
1259 isl_set_free(Domain);
1260 return isl_map_from_aff(
1261 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1262 }
1263 auto *Schedule = getParent()->getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001264 if (!Schedule) {
1265 isl_set_free(Domain);
1266 return nullptr;
1267 }
Tobias Grosser808cd692015-07-14 09:33:13 +00001268 Schedule = isl_union_map_intersect_domain(
1269 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
1270 if (isl_union_map_is_empty(Schedule)) {
1271 isl_set_free(Domain);
1272 isl_union_map_free(Schedule);
1273 return isl_map_from_aff(
1274 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1275 }
1276 auto *M = isl_map_from_union_map(Schedule);
1277 M = isl_map_coalesce(M);
1278 M = isl_map_gist_domain(M, Domain);
1279 M = isl_map_coalesce(M);
1280 return M;
1281}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001282
Tobias Grosser37eb4222014-02-20 21:43:54 +00001283void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
1284 assert(isl_set_is_subset(NewDomain, Domain) &&
1285 "New domain is not a subset of old domain!");
1286 isl_set_free(Domain);
1287 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001288}
1289
Michael Krusecac948e2015-10-02 13:53:07 +00001290void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +00001291 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +00001292 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00001293 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001294
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001295 MemoryKind Ty;
Tobias Grossera535dff2015-12-13 19:59:01 +00001296 if (Access->isPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001297 Ty = MemoryKind::PHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001298 else if (Access->isExitPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001299 Ty = MemoryKind::ExitPHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001300 else if (Access->isValueKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001301 Ty = MemoryKind::Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001302 else
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001303 Ty = MemoryKind::Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001304
Tobias Grosser296fe2e2017-02-10 10:09:46 +00001305 auto *SAI = S.getOrCreateScopArrayInfo(Access->getOriginalBaseAddr(),
1306 ElementType, Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001307 Access->buildAccessRelation(SAI);
Michael Kruse8b805802017-07-19 17:11:25 +00001308 S.addAccessData(Access);
Tobias Grosser75805372011-04-29 06:27:02 +00001309 }
1310}
1311
Michael Kruse4c276432017-05-11 22:56:46 +00001312MemoryAccess *ScopStmt::lookupPHIReadOf(PHINode *PHI) const {
1313 for (auto *MA : *this) {
1314 if (!MA->isRead())
1315 continue;
Michael Kruse22058c32017-07-20 16:21:55 +00001316 if (!MA->isOriginalAnyPHIKind())
Michael Kruse4c276432017-05-11 22:56:46 +00001317 continue;
1318
1319 if (MA->getAccessInstruction() == PHI)
1320 return MA;
1321 }
1322 return nullptr;
1323}
1324
Michael Krusecac948e2015-10-02 13:53:07 +00001325void ScopStmt::addAccess(MemoryAccess *Access) {
1326 Instruction *AccessInst = Access->getAccessInstruction();
1327
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001328 if (Access->isArrayKind()) {
1329 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1330 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001331 } else if (Access->isValueKind() && Access->isWrite()) {
1332 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001333 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001334 assert(!ValueWrites.lookup(AccessVal));
1335
1336 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001337 } else if (Access->isValueKind() && Access->isRead()) {
1338 Value *AccessVal = Access->getAccessValue();
1339 assert(!ValueReads.lookup(AccessVal));
1340
1341 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001342 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
Tobias Grosser5db171a2017-02-10 10:09:44 +00001343 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001344 assert(!PHIWrites.lookup(PHI));
1345
1346 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001347 }
1348
1349 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001350}
1351
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001352void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001353 for (MemoryAccess *MA : *this)
1354 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001355
Johannes Doerferta60ad842016-05-10 12:18:22 +00001356 auto *Ctx = Parent.getContext();
1357 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
1358 Domain = isl_set_gist_params(Domain, Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001359}
1360
Tobias Grosserc80d6972016-09-02 06:33:33 +00001361/// Add @p BSet to the set @p User if @p BSet is bounded.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001362static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1363 void *User) {
1364 isl_set **BoundedParts = static_cast<isl_set **>(User);
1365 if (isl_basic_set_is_bounded(BSet))
1366 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1367 else
1368 isl_basic_set_free(BSet);
1369 return isl_stat_ok;
1370}
1371
Tobias Grosserc80d6972016-09-02 06:33:33 +00001372/// Return the bounded parts of @p S.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001373static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1374 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1375 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1376 isl_set_free(S);
1377 return BoundedParts;
1378}
1379
Tobias Grosserc80d6972016-09-02 06:33:33 +00001380/// Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001381///
1382/// @returns A separation of @p S into first an unbounded then a bounded subset,
1383/// both with regards to the dimension @p Dim.
1384static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1385partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1386
1387 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001388 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001389
1390 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001391 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001392
1393 // Remove dimensions that are greater than Dim as they are not interesting.
1394 assert(NumDimsS >= Dim + 1);
1395 OnlyDimS =
1396 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1397
1398 // Create artificial parametric upper bounds for dimensions smaller than Dim
1399 // as we are not interested in them.
1400 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1401 for (unsigned u = 0; u < Dim; u++) {
1402 isl_constraint *C = isl_inequality_alloc(
1403 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1404 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1405 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1406 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1407 }
1408
1409 // Collect all bounded parts of OnlyDimS.
1410 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1411
1412 // Create the dimensions greater than Dim again.
1413 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1414 NumDimsS - Dim - 1);
1415
1416 // Remove the artificial upper bound parameters again.
1417 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1418
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001419 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001420 return std::make_pair(UnboundedParts, BoundedParts);
1421}
1422
Tobias Grosserc80d6972016-09-02 06:33:33 +00001423/// Set the dimension Ids from @p From in @p To.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001424static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1425 __isl_take isl_set *To) {
1426 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1427 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1428 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1429 }
1430 return To;
1431}
1432
Tobias Grosserc80d6972016-09-02 06:33:33 +00001433/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001434static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001435 __isl_take isl_pw_aff *L,
1436 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001437 switch (Pred) {
1438 case ICmpInst::ICMP_EQ:
1439 return isl_pw_aff_eq_set(L, R);
1440 case ICmpInst::ICMP_NE:
1441 return isl_pw_aff_ne_set(L, R);
1442 case ICmpInst::ICMP_SLT:
1443 return isl_pw_aff_lt_set(L, R);
1444 case ICmpInst::ICMP_SLE:
1445 return isl_pw_aff_le_set(L, R);
1446 case ICmpInst::ICMP_SGT:
1447 return isl_pw_aff_gt_set(L, R);
1448 case ICmpInst::ICMP_SGE:
1449 return isl_pw_aff_ge_set(L, R);
1450 case ICmpInst::ICMP_ULT:
1451 return isl_pw_aff_lt_set(L, R);
1452 case ICmpInst::ICMP_UGT:
1453 return isl_pw_aff_gt_set(L, R);
1454 case ICmpInst::ICMP_ULE:
1455 return isl_pw_aff_le_set(L, R);
1456 case ICmpInst::ICMP_UGE:
1457 return isl_pw_aff_ge_set(L, R);
1458 default:
1459 llvm_unreachable("Non integer predicate not supported");
1460 }
1461}
1462
Tobias Grosserc80d6972016-09-02 06:33:33 +00001463/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001464///
1465/// Helper function that will make sure the dimensions of the result have the
1466/// same isl_id's as the @p Domain.
1467static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1468 __isl_take isl_pw_aff *L,
1469 __isl_take isl_pw_aff *R,
1470 __isl_keep isl_set *Domain) {
1471 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1472 return setDimensionIds(Domain, ConsequenceCondSet);
1473}
1474
Michael Kruse476f8552017-06-29 12:47:41 +00001475/// Compute the isl representation for the SCEV @p E in this BB.
1476///
1477/// @param S The Scop in which @p BB resides in.
1478/// @param BB The BB for which isl representation is to be
1479/// computed.
1480/// @param InvalidDomainMap A map of BB to their invalid domains.
1481/// @param E The SCEV that should be translated.
1482/// @param NonNegative Flag to indicate the @p E has to be non-negative.
1483///
1484/// Note that this function will also adjust the invalid context accordingly.
1485
1486__isl_give isl_pw_aff *
1487getPwAff(Scop &S, BasicBlock *BB,
Tobias Grosser13acbb92017-07-15 09:01:31 +00001488 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap, const SCEV *E,
1489 bool NonNegative = false) {
Michael Kruse476f8552017-06-29 12:47:41 +00001490 PWACtx PWAC = S.getPwAff(E, BB, NonNegative);
Tobias Grosser13acbb92017-07-15 09:01:31 +00001491 InvalidDomainMap[BB] = InvalidDomainMap[BB].unite(isl::manage(PWAC.second));
Michael Kruse476f8552017-06-29 12:47:41 +00001492 return PWAC.first;
1493}
1494
Tobias Grosserc80d6972016-09-02 06:33:33 +00001495/// Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001496///
1497/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001498/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1499/// have as many elements as @p SI has successors.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001500static bool
1501buildConditionSets(Scop &S, BasicBlock *BB, SwitchInst *SI, Loop *L,
1502 __isl_keep isl_set *Domain,
1503 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1504 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001505
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001506 Value *Condition = getConditionFromTerminator(SI);
1507 assert(Condition && "No condition for switch");
1508
1509 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001510 isl_pw_aff *LHS, *RHS;
Michael Kruse476f8552017-06-29 12:47:41 +00001511 LHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001512
1513 unsigned NumSuccessors = SI->getNumSuccessors();
1514 ConditionSets.resize(NumSuccessors);
1515 for (auto &Case : SI->cases()) {
1516 unsigned Idx = Case.getSuccessorIndex();
1517 ConstantInt *CaseValue = Case.getCaseValue();
1518
Michael Kruse476f8552017-06-29 12:47:41 +00001519 RHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001520 isl_set *CaseConditionSet =
1521 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1522 ConditionSets[Idx] = isl_set_coalesce(
1523 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1524 }
1525
1526 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1527 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1528 for (unsigned u = 2; u < NumSuccessors; u++)
1529 ConditionSetUnion =
1530 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1531 ConditionSets[0] = setDimensionIds(
1532 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1533
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001534 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001535
1536 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001537}
1538
Michael Kruse08655852017-07-20 12:37:02 +00001539/// Build condition sets for unsigned ICmpInst(s).
1540/// Special handling is required for unsigned operands to ensure that if
1541/// MSB (aka the Sign bit) is set for an operands in an unsigned ICmpInst
1542/// it should wrap around.
1543///
1544/// @param IsStrictUpperBound holds information on the predicate relation
1545/// between TestVal and UpperBound, i.e,
1546/// TestVal < UpperBound OR TestVal <= UpperBound
1547static __isl_give isl_set *
1548buildUnsignedConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1549 __isl_keep isl_set *Domain, const SCEV *SCEV_TestVal,
1550 const SCEV *SCEV_UpperBound,
1551 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1552 bool IsStrictUpperBound) {
1553
1554 // Do not take NonNeg assumption on TestVal
1555 // as it might have MSB (Sign bit) set.
1556 isl_pw_aff *TestVal = getPwAff(S, BB, InvalidDomainMap, SCEV_TestVal, false);
1557 // Take NonNeg assumption on UpperBound.
1558 isl_pw_aff *UpperBound =
1559 getPwAff(S, BB, InvalidDomainMap, SCEV_UpperBound, true);
1560
1561 // 0 <= TestVal
1562 isl_set *First =
1563 isl_pw_aff_le_set(isl_pw_aff_zero_on_domain(isl_local_space_from_space(
1564 isl_pw_aff_get_domain_space(TestVal))),
1565 isl_pw_aff_copy(TestVal));
1566
1567 isl_set *Second;
1568 if (IsStrictUpperBound)
1569 // TestVal < UpperBound
1570 Second = isl_pw_aff_lt_set(TestVal, UpperBound);
1571 else
1572 // TestVal <= UpperBound
1573 Second = isl_pw_aff_le_set(TestVal, UpperBound);
1574
1575 isl_set *ConsequenceCondSet = isl_set_intersect(First, Second);
1576 ConsequenceCondSet = setDimensionIds(Domain, ConsequenceCondSet);
1577 return ConsequenceCondSet;
1578}
1579
Tobias Grosserc80d6972016-09-02 06:33:33 +00001580/// Build the conditions sets for the branch condition @p Condition in
1581/// the @p Domain.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001582///
1583/// This will fill @p ConditionSets with the conditions under which control
1584/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001585/// have as many elements as @p TI has successors. If @p TI is nullptr the
1586/// context under which @p Condition is true/false will be returned as the
1587/// new elements of @p ConditionSets.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001588static bool
1589buildConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1590 TerminatorInst *TI, Loop *L, __isl_keep isl_set *Domain,
1591 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1592 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001593
1594 isl_set *ConsequenceCondSet = nullptr;
1595 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1596 if (CCond->isZero())
1597 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1598 else
1599 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1600 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1601 auto Opcode = BinOp->getOpcode();
1602 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1603
Michael Kruse476f8552017-06-29 12:47:41 +00001604 bool Valid = buildConditionSets(S, BB, BinOp->getOperand(0), TI, L, Domain,
1605 InvalidDomainMap, ConditionSets) &&
1606 buildConditionSets(S, BB, BinOp->getOperand(1), TI, L, Domain,
1607 InvalidDomainMap, ConditionSets);
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001608 if (!Valid) {
1609 while (!ConditionSets.empty())
1610 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001611 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001612 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001613
1614 isl_set_free(ConditionSets.pop_back_val());
1615 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1616 isl_set_free(ConditionSets.pop_back_val());
1617 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1618
1619 if (Opcode == Instruction::And)
1620 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1621 else
1622 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1623 } else {
1624 auto *ICond = dyn_cast<ICmpInst>(Condition);
1625 assert(ICond &&
1626 "Condition of exiting branch was neither constant nor ICmp!");
1627
1628 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001629 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001630 // For unsigned comparisons we assumed the signed bit of neither operand
1631 // to be set. The comparison is equal to a signed comparison under this
1632 // assumption.
1633 bool NonNeg = ICond->isUnsigned();
Michael Kruse08655852017-07-20 12:37:02 +00001634 const SCEV *LeftOperand = SE.getSCEVAtScope(ICond->getOperand(0), L),
1635 *RightOperand = SE.getSCEVAtScope(ICond->getOperand(1), L);
1636
1637 switch (ICond->getPredicate()) {
1638 case ICmpInst::ICMP_ULT:
1639 ConsequenceCondSet =
1640 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1641 RightOperand, InvalidDomainMap, true);
1642 break;
1643 case ICmpInst::ICMP_ULE:
1644 ConsequenceCondSet =
1645 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1646 RightOperand, InvalidDomainMap, false);
1647 break;
1648 case ICmpInst::ICMP_UGT:
1649 ConsequenceCondSet =
1650 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1651 LeftOperand, InvalidDomainMap, true);
1652 break;
1653 case ICmpInst::ICMP_UGE:
1654 ConsequenceCondSet =
1655 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1656 LeftOperand, InvalidDomainMap, false);
1657 break;
1658 default:
1659 LHS = getPwAff(S, BB, InvalidDomainMap, LeftOperand, NonNeg);
1660 RHS = getPwAff(S, BB, InvalidDomainMap, RightOperand, NonNeg);
1661 ConsequenceCondSet =
1662 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1663 break;
1664 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001665 }
1666
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001667 // If no terminator was given we are only looking for parameter constraints
1668 // under which @p Condition is true/false.
1669 if (!TI)
1670 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001671 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001672 ConsequenceCondSet = isl_set_coalesce(
1673 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001674
Johannes Doerfertb2885792016-04-26 09:20:41 +00001675 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001676 bool TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001677 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001678
Michael Krusef7a4a942016-05-02 12:25:36 +00001679 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001680 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1681 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001682 TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001683 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001684 }
1685
Michael Krusef7a4a942016-05-02 12:25:36 +00001686 if (TooComplex) {
Eli Friedmane737fc12017-07-17 23:58:33 +00001687 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc(),
1688 TI ? TI->getParent() : nullptr /* BasicBlock */);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001689 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001690 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001691 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001692 }
1693
1694 ConditionSets.push_back(ConsequenceCondSet);
1695 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001696
1697 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001698}
1699
Tobias Grosserc80d6972016-09-02 06:33:33 +00001700/// Build the conditions sets for the terminator @p TI in the @p Domain.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001701///
1702/// This will fill @p ConditionSets with the conditions under which control
1703/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1704/// have as many elements as @p TI has successors.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001705static bool
1706buildConditionSets(Scop &S, BasicBlock *BB, TerminatorInst *TI, Loop *L,
1707 __isl_keep isl_set *Domain,
1708 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1709 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001710
1711 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Michael Kruse476f8552017-06-29 12:47:41 +00001712 return buildConditionSets(S, BB, SI, L, Domain, InvalidDomainMap,
1713 ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001714
1715 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1716
1717 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001718 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001719 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001720 }
1721
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001722 Value *Condition = getConditionFromTerminator(TI);
1723 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001724
Michael Kruse476f8552017-06-29 12:47:41 +00001725 return buildConditionSets(S, BB, Condition, TI, L, Domain, InvalidDomainMap,
1726 ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001727}
1728
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001729void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001730 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001731
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001732 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001733 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001734}
1735
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001736void ScopStmt::collectSurroundingLoops() {
1737 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1738 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1739 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1740 isl_id_free(DimId);
1741 }
1742}
1743
Michael Kruse55454072017-03-15 22:16:43 +00001744ScopStmt::ScopStmt(Scop &parent, Region &R, Loop *SurroundingLoop)
Johannes Doerferta3519512016-04-23 13:02:23 +00001745 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
Michael Kruse55454072017-03-15 22:16:43 +00001746 R(&R), Build(nullptr), SurroundingLoop(SurroundingLoop) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001747
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001748 BaseName = getIslCompatibleName(
1749 "Stmt", R.getNameStr(), parent.getNextStmtIdx(), "", UseInstructionNames);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001750}
1751
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001752ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb, Loop *SurroundingLoop,
1753 std::vector<Instruction *> Instructions)
Johannes Doerferta3519512016-04-23 13:02:23 +00001754 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001755 R(nullptr), Build(nullptr), SurroundingLoop(SurroundingLoop),
1756 Instructions(Instructions) {
Tobias Grosser75805372011-04-29 06:27:02 +00001757
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001758 BaseName = getIslCompatibleName("Stmt", &bb, parent.getNextStmtIdx(), "",
1759 UseInstructionNames);
Michael Krusecac948e2015-10-02 13:53:07 +00001760}
1761
Roman Gareevb3224ad2016-09-14 06:26:09 +00001762ScopStmt::ScopStmt(Scop &parent, __isl_take isl_map *SourceRel,
1763 __isl_take isl_map *TargetRel, __isl_take isl_set *NewDomain)
1764 : Parent(parent), InvalidDomain(nullptr), Domain(NewDomain), BB(nullptr),
1765 R(nullptr), Build(nullptr) {
1766 BaseName = getIslCompatibleName("CopyStmt_", "",
1767 std::to_string(parent.getCopyStmtsNum()));
1768 auto *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1769 Domain = isl_set_set_tuple_id(Domain, isl_id_copy(Id));
1770 TargetRel = isl_map_set_tuple_id(TargetRel, isl_dim_in, Id);
1771 auto *Access =
1772 new MemoryAccess(this, MemoryAccess::AccessType::MUST_WRITE, TargetRel);
1773 parent.addAccessFunction(Access);
1774 addAccess(Access);
1775 SourceRel = isl_map_set_tuple_id(SourceRel, isl_dim_in, isl_id_copy(Id));
1776 Access = new MemoryAccess(this, MemoryAccess::AccessType::READ, SourceRel);
1777 parent.addAccessFunction(Access);
1778 addAccess(Access);
1779}
1780
Johannes Doerfertffd222f2016-05-19 12:34:57 +00001781void ScopStmt::init(LoopInfo &LI) {
Michael Krusecac948e2015-10-02 13:53:07 +00001782 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001783
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001784 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001785 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001786 buildAccessRelations();
1787
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001788 if (DetectReductions)
1789 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001790}
1791
Tobias Grosserc80d6972016-09-02 06:33:33 +00001792/// Collect loads which might form a reduction chain with @p StoreMA.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001793///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001794/// Check if the stored value for @p StoreMA is a binary operator with one or
1795/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001796/// used only once (by @p StoreMA) and its load operands are also used only
1797/// once, we have found a possible reduction chain. It starts at an operand
1798/// load and includes the binary operator and @p StoreMA.
1799///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001800/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001801/// escape this block or into any other store except @p StoreMA.
1802void ScopStmt::collectCandiateReductionLoads(
1803 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1804 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1805 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001806 return;
1807
1808 // Skip if there is not one binary operator between the load and the store
1809 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001810 if (!BinOp)
1811 return;
1812
1813 // Skip if the binary operators has multiple uses
1814 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001815 return;
1816
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001817 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001818 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1819 return;
1820
Johannes Doerfert9890a052014-07-01 00:32:29 +00001821 // Skip if the binary operator is outside the current SCoP
1822 if (BinOp->getParent() != Store->getParent())
1823 return;
1824
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001825 // Skip if it is a multiplicative reduction and we disabled them
1826 if (DisableMultiplicativeReductions &&
1827 (BinOp->getOpcode() == Instruction::Mul ||
1828 BinOp->getOpcode() == Instruction::FMul))
1829 return;
1830
Johannes Doerferte58a0122014-06-27 20:31:28 +00001831 // Check the binary operator operands for a candidate load
1832 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1833 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1834 if (!PossibleLoad0 && !PossibleLoad1)
1835 return;
1836
1837 // A load is only a candidate if it cannot escape (thus has only this use)
1838 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001839 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001840 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001841 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001842 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001843 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001844}
1845
Tobias Grosserc80d6972016-09-02 06:33:33 +00001846/// Check for reductions in this ScopStmt.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001847///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001848/// Iterate over all store memory accesses and check for valid binary reduction
1849/// like chains. For all candidates we check if they have the same base address
1850/// and there are no other accesses which overlap with them. The base address
1851/// check rules out impossible reductions candidates early. The overlap check,
1852/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001853/// guarantees that none of the intermediate results will escape during
1854/// execution of the loop nest. We basically check here that no other memory
1855/// access can access the same memory as the potential reduction.
1856void ScopStmt::checkForReductions() {
1857 SmallVector<MemoryAccess *, 2> Loads;
1858 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1859
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001860 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001861 // stores and collecting possible reduction loads.
1862 for (MemoryAccess *StoreMA : MemAccs) {
1863 if (StoreMA->isRead())
1864 continue;
1865
1866 Loads.clear();
1867 collectCandiateReductionLoads(StoreMA, Loads);
1868 for (MemoryAccess *LoadMA : Loads)
1869 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1870 }
1871
1872 // Then check each possible candidate pair.
1873 for (const auto &CandidatePair : Candidates) {
1874 bool Valid = true;
1875 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1876 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1877
1878 // Skip those with obviously unequal base addresses.
1879 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1880 isl_map_free(LoadAccs);
1881 isl_map_free(StoreAccs);
1882 continue;
1883 }
1884
1885 // And check if the remaining for overlap with other memory accesses.
1886 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1887 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1888 isl_set *AllAccs = isl_map_range(AllAccsRel);
1889
1890 for (MemoryAccess *MA : MemAccs) {
1891 if (MA == CandidatePair.first || MA == CandidatePair.second)
1892 continue;
1893
1894 isl_map *AccRel =
1895 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1896 isl_set *Accs = isl_map_range(AccRel);
1897
Tobias Grosser55a7af72016-09-08 14:08:07 +00001898 if (isl_set_has_equal_space(AllAccs, Accs)) {
Johannes Doerferte58a0122014-06-27 20:31:28 +00001899 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1900 Valid = Valid && isl_set_is_empty(OverlapAccs);
1901 isl_set_free(OverlapAccs);
Tobias Grosser55a7af72016-09-08 14:08:07 +00001902 } else {
1903 isl_set_free(Accs);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001904 }
1905 }
1906
1907 isl_set_free(AllAccs);
1908 if (!Valid)
1909 continue;
1910
Johannes Doerfertf6183392014-07-01 20:52:51 +00001911 const LoadInst *Load =
1912 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1913 MemoryAccess::ReductionType RT =
1914 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1915
Johannes Doerferte58a0122014-06-27 20:31:28 +00001916 // If no overlapping access was found we mark the load and store as
1917 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001918 CandidatePair.first->markAsReductionLike(RT);
1919 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001920 }
Tobias Grosser75805372011-04-29 06:27:02 +00001921}
1922
Tobias Grosser74394f02013-01-14 22:40:23 +00001923std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001924
Tobias Grosser54839312015-04-21 11:37:25 +00001925std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001926 auto *S = getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001927 if (!S)
1928 return "";
Tobias Grosser808cd692015-07-14 09:33:13 +00001929 auto Str = stringFromIslObj(S);
1930 isl_map_free(S);
1931 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001932}
1933
Johannes Doerferta3519512016-04-23 13:02:23 +00001934void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1935 isl_set_free(InvalidDomain);
1936 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001937}
1938
Michael Kruse375cb5f2016-02-24 22:08:24 +00001939BasicBlock *ScopStmt::getEntryBlock() const {
1940 if (isBlockStmt())
1941 return getBasicBlock();
1942 return getRegion()->getEntry();
1943}
1944
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001945unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001946
Tobias Grosser75805372011-04-29 06:27:02 +00001947const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1948
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001949Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001950 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001951}
1952
Tobias Grosser74394f02013-01-14 22:40:23 +00001953isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001954
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001955__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001956
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001957__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001958 return isl_set_get_space(Domain);
1959}
1960
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001961__isl_give isl_id *ScopStmt::getDomainId() const {
1962 return isl_set_get_tuple_id(Domain);
1963}
Tobias Grossercd95b772012-08-30 11:49:38 +00001964
Johannes Doerfert7c013572016-04-12 09:57:34 +00001965ScopStmt::~ScopStmt() {
1966 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001967 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001968}
Tobias Grosser75805372011-04-29 06:27:02 +00001969
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001970void ScopStmt::printInstructions(raw_ostream &OS) const {
1971 OS << "Instructions {\n";
1972
1973 for (Instruction *Inst : Instructions)
1974 OS.indent(16) << *Inst << "\n";
1975
1976 OS.indent(16) << "}\n";
1977}
1978
Tobias Grosser75805372011-04-29 06:27:02 +00001979void ScopStmt::print(raw_ostream &OS) const {
1980 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001981 OS.indent(12) << "Domain :=\n";
1982
1983 if (Domain) {
1984 OS.indent(16) << getDomainStr() << ";\n";
1985 } else
1986 OS.indent(16) << "n/a\n";
1987
Tobias Grosser54839312015-04-21 11:37:25 +00001988 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001989
1990 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001991 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001992 } else
1993 OS.indent(16) << "n/a\n";
1994
Tobias Grosser083d3d32014-06-28 08:59:45 +00001995 for (MemoryAccess *Access : MemAccs)
1996 Access->print(OS);
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001997
1998 if (PollyPrintInstructions)
1999 printInstructions(OS.indent(12));
Tobias Grosser75805372011-04-29 06:27:02 +00002000}
2001
2002void ScopStmt::dump() const { print(dbgs()); }
2003
Michael Krusee60eca72017-05-11 22:56:12 +00002004void ScopStmt::removeAccessData(MemoryAccess *MA) {
2005 if (MA->isRead() && MA->isOriginalValueKind()) {
2006 bool Found = ValueReads.erase(MA->getAccessValue());
2007 (void)Found;
2008 assert(Found && "Expected access data not found");
2009 }
2010 if (MA->isWrite() && MA->isOriginalValueKind()) {
2011 bool Found = ValueWrites.erase(cast<Instruction>(MA->getAccessValue()));
2012 (void)Found;
2013 assert(Found && "Expected access data not found");
2014 }
2015 if (MA->isWrite() && MA->isOriginalAnyPHIKind()) {
2016 bool Found = PHIWrites.erase(cast<PHINode>(MA->getAccessInstruction()));
2017 (void)Found;
2018 assert(Found && "Expected access data not found");
2019 }
2020}
2021
Michael Kruse10071822016-05-23 14:45:58 +00002022void ScopStmt::removeMemoryAccess(MemoryAccess *MA) {
Tobias Grosser4d5a9172017-01-14 20:25:44 +00002023 // Remove the memory accesses from this statement together with all scalar
2024 // accesses that were caused by it. MemoryKind::Value READs have no access
2025 // instruction, hence would not be removed by this function. However, it is
2026 // only used for invariant LoadInst accesses, its arguments are always affine,
2027 // hence synthesizable, and therefore there are no MemoryKind::Value READ
2028 // accesses to be removed.
Michael Kruse10071822016-05-23 14:45:58 +00002029 auto Predicate = [&](MemoryAccess *Acc) {
2030 return Acc->getAccessInstruction() == MA->getAccessInstruction();
2031 };
Michael Krusee60eca72017-05-11 22:56:12 +00002032 for (auto *MA : MemAccs) {
Michael Kruse8b805802017-07-19 17:11:25 +00002033 if (Predicate(MA)) {
Michael Krusee60eca72017-05-11 22:56:12 +00002034 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00002035 Parent.removeAccessData(MA);
2036 }
Michael Krusee60eca72017-05-11 22:56:12 +00002037 }
Michael Kruse10071822016-05-23 14:45:58 +00002038 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
2039 MemAccs.end());
2040 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002041}
2042
Michael Kruse0446d812017-03-10 16:05:24 +00002043void ScopStmt::removeSingleMemoryAccess(MemoryAccess *MA) {
2044 auto MAIt = std::find(MemAccs.begin(), MemAccs.end(), MA);
2045 assert(MAIt != MemAccs.end());
2046 MemAccs.erase(MAIt);
2047
Michael Krusee60eca72017-05-11 22:56:12 +00002048 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00002049 Parent.removeAccessData(MA);
Michael Krusee60eca72017-05-11 22:56:12 +00002050
Michael Kruse0446d812017-03-10 16:05:24 +00002051 auto It = InstructionToAccess.find(MA->getAccessInstruction());
2052 if (It != InstructionToAccess.end()) {
2053 It->second.remove(MA);
2054 if (It->second.empty())
2055 InstructionToAccess.erase(MA->getAccessInstruction());
2056 }
2057}
2058
Tobias Grosser75805372011-04-29 06:27:02 +00002059//===----------------------------------------------------------------------===//
2060/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00002061
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00002062void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00002063 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
2064 isl_set_free(Context);
2065 Context = NewContext;
2066}
2067
Eli Friedman5e589ea2017-06-20 22:53:02 +00002068namespace {
Tobias Grosserc80d6972016-09-02 06:33:33 +00002069/// Remap parameter values but keep AddRecs valid wrt. invariant loads.
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002070struct SCEVSensitiveParameterRewriter
Tobias Grosser278f9e72016-11-26 17:58:40 +00002071 : public SCEVRewriteVisitor<SCEVSensitiveParameterRewriter> {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002072 ValueToValueMap &VMap;
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002073
2074public:
2075 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
Tobias Grosser278f9e72016-11-26 17:58:40 +00002076 : SCEVRewriteVisitor(SE), VMap(VMap) {}
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002077
2078 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
2079 ValueToValueMap &VMap) {
2080 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
2081 return SSPR.visit(E);
2082 }
2083
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002084 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
2085 auto *Start = visit(E->getStart());
2086 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
2087 visit(E->getStepRecurrence(SE)),
2088 E->getLoop(), SCEV::FlagAnyWrap);
2089 return SE.getAddExpr(Start, AddRec);
2090 }
2091
2092 const SCEV *visitUnknown(const SCEVUnknown *E) {
2093 if (auto *NewValue = VMap.lookup(E->getValue()))
2094 return SE.getUnknown(NewValue);
2095 return E;
2096 }
2097};
2098
Eli Friedman5e589ea2017-06-20 22:53:02 +00002099/// Check whether we should remap a SCEV expression.
2100struct SCEVFindInsideScop : public SCEVTraversal<SCEVFindInsideScop> {
2101 ValueToValueMap &VMap;
2102 bool FoundInside = false;
2103 Scop *S;
2104
2105public:
2106 SCEVFindInsideScop(ValueToValueMap &VMap, ScalarEvolution &SE, Scop *S)
2107 : SCEVTraversal(*this), VMap(VMap), S(S) {}
2108
2109 static bool hasVariant(const SCEV *E, ScalarEvolution &SE,
2110 ValueToValueMap &VMap, Scop *S) {
2111 SCEVFindInsideScop SFIS(VMap, SE, S);
2112 SFIS.visitAll(E);
2113 return SFIS.FoundInside;
2114 }
2115
2116 bool follow(const SCEV *E) {
2117 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(E)) {
2118 FoundInside |= S->getRegion().contains(AddRec->getLoop());
2119 } else if (auto *Unknown = dyn_cast<SCEVUnknown>(E)) {
2120 if (Instruction *I = dyn_cast<Instruction>(Unknown->getValue()))
2121 FoundInside |= S->getRegion().contains(I) && !VMap.count(I);
2122 }
2123 return !FoundInside;
2124 }
2125 bool isDone() { return FoundInside; }
2126};
2127} // namespace
2128
2129const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *E) {
2130 // Check whether it makes sense to rewrite the SCEV. (ScalarEvolution
2131 // doesn't like addition between an AddRec and an expression that
2132 // doesn't have a dominance relationship with it.)
2133 if (SCEVFindInsideScop::hasVariant(E, *SE, InvEquivClassVMap, this))
2134 return E;
2135
2136 // Rewrite SCEV.
2137 return SCEVSensitiveParameterRewriter::rewrite(E, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002138}
2139
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002140// This table of function names is used to translate parameter names in more
2141// human-readable names. This makes it easier to interpret Polly analysis
2142// results.
2143StringMap<std::string> KnownNames = {
2144 {"_Z13get_global_idj", "global_id"},
2145 {"_Z12get_local_idj", "local_id"},
2146 {"_Z15get_global_sizej", "global_size"},
2147 {"_Z14get_local_sizej", "local_size"},
2148 {"_Z12get_work_dimv", "work_dim"},
2149 {"_Z17get_global_offsetj", "global_offset"},
2150 {"_Z12get_group_idj", "group_id"},
2151 {"_Z14get_num_groupsj", "num_groups"},
2152};
2153
2154static std::string getCallParamName(CallInst *Call) {
2155 std::string Result;
2156 raw_string_ostream OS(Result);
2157 std::string Name = Call->getCalledFunction()->getName();
2158
2159 auto Iterator = KnownNames.find(Name);
2160 if (Iterator != KnownNames.end())
Tobias Grosserdff902f2017-06-01 12:46:51 +00002161 Name = "__" + Iterator->getValue();
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002162 OS << Name;
2163 for (auto &Operand : Call->arg_operands()) {
2164 ConstantInt *Op = cast<ConstantInt>(&Operand);
2165 OS << "_" << Op->getValue();
2166 }
2167 OS.flush();
2168 return Result;
2169}
2170
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002171void Scop::createParameterId(const SCEV *Parameter) {
2172 assert(Parameters.count(Parameter));
2173 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002174
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002175 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002176
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002177 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
2178 Value *Val = ValueParameter->getValue();
2179 CallInst *Call = dyn_cast<CallInst>(Val);
Tobias Grosser8f99c162011-11-15 11:38:55 +00002180
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002181 if (Call && isConstCall(Call)) {
2182 ParameterName = getCallParamName(Call);
2183 } else if (UseInstructionNames) {
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002184 // If this parameter references a specific Value and this value has a name
2185 // we use this name as it is likely to be unique and more useful than just
2186 // a number.
2187 if (Val->hasName())
2188 ParameterName = Val->getName();
2189 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
2190 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
2191 if (LoadOrigin->hasName()) {
2192 ParameterName += "_loaded_from_";
2193 ParameterName +=
2194 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
2195 }
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002196 }
2197 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00002198
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002199 ParameterName = getIslCompatibleName("", ParameterName, "");
2200 }
Tobias Grosser2ea7c6e2016-07-01 13:40:28 +00002201
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002202 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
2203 const_cast<void *>((const void *)Parameter));
2204 ParameterIds[Parameter] = Id;
2205}
2206
2207void Scop::addParams(const ParameterSetTy &NewParameters) {
2208 for (const SCEV *Parameter : NewParameters) {
2209 // Normalize the SCEV to get the representing element for an invariant load.
2210 Parameter = extractConstantFactor(Parameter, *SE).second;
2211 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2212
2213 if (Parameters.insert(Parameter))
2214 createParameterId(Parameter);
2215 }
2216}
2217
2218__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
2219 // Normalize the SCEV to get the representing element for an invariant load.
2220 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2221 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00002222}
Tobias Grosser75805372011-04-29 06:27:02 +00002223
Michael Krused56b90a2016-09-01 09:03:27 +00002224__isl_give isl_set *
2225Scop::addNonEmptyDomainConstraints(__isl_take isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002226 isl_set *DomainContext = isl_union_set_params(getDomains());
2227 return isl_set_intersect_params(C, DomainContext);
2228}
2229
Johannes Doerferte0b08072016-05-23 12:43:44 +00002230bool Scop::isDominatedBy(const DominatorTree &DT, BasicBlock *BB) const {
2231 return DT.dominates(BB, getEntry());
2232}
2233
Michael Kruse476f8552017-06-29 12:47:41 +00002234void Scop::addUserAssumptions(
2235 AssumptionCache &AC, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002236 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse89b1f942017-03-17 13:56:53 +00002237 for (auto &Assumption : AC.assumptions()) {
2238 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
2239 if (!CI || CI->getNumArgOperands() != 1)
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002240 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00002241
Michael Kruse89b1f942017-03-17 13:56:53 +00002242 bool InScop = contains(CI);
2243 if (!InScop && !isDominatedBy(DT, CI->getParent()))
2244 continue;
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002245
Michael Kruse89b1f942017-03-17 13:56:53 +00002246 auto *L = LI.getLoopFor(CI->getParent());
2247 auto *Val = CI->getArgOperand(0);
2248 ParameterSetTy DetectedParams;
2249 if (!isAffineConstraint(Val, &R, L, *SE, DetectedParams)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00002250 ORE.emit(
2251 OptimizationRemarkAnalysis(DEBUG_TYPE, "IgnoreUserAssumption", CI)
2252 << "Non-affine user assumption ignored.");
Michael Kruse89b1f942017-03-17 13:56:53 +00002253 continue;
Michael Kruse7037fde2016-12-15 09:25:14 +00002254 }
Michael Kruse89b1f942017-03-17 13:56:53 +00002255
2256 // Collect all newly introduced parameters.
2257 ParameterSetTy NewParams;
2258 for (auto *Param : DetectedParams) {
2259 Param = extractConstantFactor(Param, *SE).second;
2260 Param = getRepresentingInvariantLoadSCEV(Param);
2261 if (Parameters.count(Param))
2262 continue;
2263 NewParams.insert(Param);
2264 }
2265
2266 SmallVector<isl_set *, 2> ConditionSets;
2267 auto *TI = InScop ? CI->getParent()->getTerminator() : nullptr;
2268 auto &Stmt = InScop ? *getStmtFor(CI->getParent()) : *Stmts.begin();
2269 auto *Dom = InScop ? getDomainConditions(&Stmt) : isl_set_copy(Context);
Michael Kruse476f8552017-06-29 12:47:41 +00002270 bool Valid = buildConditionSets(*this, Stmt.getEntryBlock(), Val, TI, L,
2271 Dom, InvalidDomainMap, ConditionSets);
Michael Kruse89b1f942017-03-17 13:56:53 +00002272 isl_set_free(Dom);
2273
2274 if (!Valid)
2275 continue;
2276
2277 isl_set *AssumptionCtx = nullptr;
2278 if (InScop) {
2279 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
2280 isl_set_free(ConditionSets[0]);
2281 } else {
2282 AssumptionCtx = isl_set_complement(ConditionSets[1]);
2283 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
2284 }
2285
2286 // Project out newly introduced parameters as they are not otherwise useful.
2287 if (!NewParams.empty()) {
2288 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
2289 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
2290 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
2291 isl_id_free(Id);
2292
2293 if (!NewParams.count(Param))
2294 continue;
2295
2296 AssumptionCtx =
2297 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
2298 }
2299 }
Eli Friedmane737fc12017-07-17 23:58:33 +00002300 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "UserAssumption", CI)
2301 << "Use user assumption: " << stringFromIslObj(AssumptionCtx));
Michael Kruse89b1f942017-03-17 13:56:53 +00002302 Context = isl_set_intersect(Context, AssumptionCtx);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002303 }
2304}
2305
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002306void Scop::addUserContext() {
2307 if (UserContextStr.empty())
2308 return;
2309
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002310 isl_set *UserContext =
2311 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002312 isl_space *Space = getParamSpace();
2313 if (isl_space_dim(Space, isl_dim_param) !=
2314 isl_set_dim(UserContext, isl_dim_param)) {
2315 auto SpaceStr = isl_space_to_str(Space);
2316 errs() << "Error: the context provided in -polly-context has not the same "
2317 << "number of dimensions than the computed context. Due to this "
2318 << "mismatch, the -polly-context option is ignored. Please provide "
2319 << "the context in the parameter space: " << SpaceStr << ".\n";
2320 free(SpaceStr);
2321 isl_set_free(UserContext);
2322 isl_space_free(Space);
2323 return;
2324 }
2325
2326 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002327 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
2328 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002329
2330 if (strcmp(NameContext, NameUserContext) != 0) {
2331 auto SpaceStr = isl_space_to_str(Space);
2332 errs() << "Error: the name of dimension " << i
2333 << " provided in -polly-context "
2334 << "is '" << NameUserContext << "', but the name in the computed "
2335 << "context is '" << NameContext
2336 << "'. Due to this name mismatch, "
2337 << "the -polly-context option is ignored. Please provide "
2338 << "the context in the parameter space: " << SpaceStr << ".\n";
2339 free(SpaceStr);
2340 isl_set_free(UserContext);
2341 isl_space_free(Space);
2342 return;
2343 }
2344
2345 UserContext =
2346 isl_set_set_dim_id(UserContext, isl_dim_param, i,
2347 isl_space_get_dim_id(Space, isl_dim_param, i));
2348 }
2349
2350 Context = isl_set_intersect(Context, UserContext);
2351 isl_space_free(Space);
2352}
2353
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002354void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002355 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002356
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002357 const InvariantLoadsSetTy &RIL = getRequiredInvariantLoads();
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002358 for (LoadInst *LInst : RIL) {
2359 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2360
Johannes Doerfert96e54712016-02-07 17:30:13 +00002361 Type *Ty = LInst->getType();
2362 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002363 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002364 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002365 continue;
2366 }
2367
2368 ClassRep = LInst;
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00002369 InvariantEquivClasses.emplace_back(
2370 InvariantEquivClassTy{PointerSCEV, MemoryAccessList(), nullptr, Ty});
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002371 }
2372}
2373
Tobias Grosser6be480c2011-11-08 15:41:13 +00002374void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002375 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00002376 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002377 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00002378 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002379}
2380
Tobias Grosser18daaca2012-05-22 10:47:27 +00002381void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002382 unsigned PDim = 0;
2383 for (auto *Parameter : Parameters) {
2384 ConstantRange SRange = SE->getSignedRange(Parameter);
Tobias Grosser99ea1d02017-05-21 20:23:20 +00002385 Context =
2386 addRangeBoundsToSet(give(Context), SRange, PDim++, isl::dim::param)
2387 .release();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002388 }
2389}
2390
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002391// We use the outermost dimension to generate GPU transfers for Fortran arrays
2392// even when the array bounds are not known statically. To do so, we need the
2393// outermost dimension information. We add this into the context so that the
2394// outermost dimension is available during codegen.
2395// We currently do not care about dimensions other than the outermost
2396// dimension since it doesn't affect transfers.
2397static isl_set *addFortranArrayOutermostDimParams(__isl_give isl_set *Context,
2398 Scop::array_range Arrays) {
2399
2400 std::vector<isl_id *> OutermostSizeIds;
2401 for (auto Array : Arrays) {
2402 // To check if an array is a Fortran array, we check if it has a isl_pw_aff
2403 // for its outermost dimension. Fortran arrays will have this since the
2404 // outermost dimension size can be picked up from their runtime description.
2405 // TODO: actually need to check if it has a FAD, but for now this works.
2406 if (Array->getNumberOfDimensions() > 0) {
2407 isl_pw_aff *PwAff = Array->getDimensionSizePw(0);
2408 if (!PwAff)
2409 continue;
2410
2411 isl_id *Id = isl_pw_aff_get_dim_id(PwAff, isl_dim_param, 0);
2412 isl_pw_aff_free(PwAff);
2413 assert(Id && "Invalid Id for PwAff expression in Fortran array");
2414 OutermostSizeIds.push_back(Id);
2415 }
2416 }
2417
2418 const int NumTrueParams = isl_set_dim(Context, isl_dim_param);
2419 Context = isl_set_add_dims(Context, isl_dim_param, OutermostSizeIds.size());
2420
2421 for (size_t i = 0; i < OutermostSizeIds.size(); i++) {
2422 Context = isl_set_set_dim_id(Context, isl_dim_param, NumTrueParams + i,
2423 OutermostSizeIds[i]);
2424 Context =
2425 isl_set_lower_bound_si(Context, isl_dim_param, NumTrueParams + i, 0);
2426 }
2427
2428 return Context;
2429}
2430
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002431void Scop::realignParams() {
Tobias Grosser5842dee2017-03-17 13:00:53 +00002432 if (PollyIgnoreParamBounds)
2433 return;
2434
Tobias Grosser6be480c2011-11-08 15:41:13 +00002435 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002436 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002437
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002438 unsigned PDim = 0;
2439 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002440 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002441 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002442 }
2443
2444 // Align the parameters of all data structures to the model.
2445 Context = isl_set_align_params(Context, Space);
2446
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002447 // Add the outermost dimension of the Fortran arrays into the Context.
2448 // See the description of the function for more information.
2449 Context = addFortranArrayOutermostDimParams(Context, arrays());
2450
Johannes Doerferta60ad842016-05-10 12:18:22 +00002451 // As all parameters are known add bounds to them.
2452 addParameterBounds();
2453
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002454 for (ScopStmt &Stmt : *this)
2455 Stmt.realignParams();
Johannes Doerfert06445ded2016-06-02 15:07:41 +00002456 // Simplify the schedule according to the context too.
2457 Schedule = isl_schedule_gist_domain_params(Schedule, getContext());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002458}
2459
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002460static __isl_give isl_set *
2461simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2462 const Scop &S) {
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002463 // If we have modeled all blocks in the SCoP that have side effects we can
2464 // simplify the context with the constraints that are needed for anything to
2465 // be executed at all. However, if we have error blocks in the SCoP we already
2466 // assumed some parameter combinations cannot occur and removed them from the
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002467 // domains, thus we cannot use the remaining domain to simplify the
2468 // assumptions.
2469 if (!S.hasErrorBlock()) {
2470 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2471 AssumptionContext =
2472 isl_set_gist_params(AssumptionContext, DomainParameters);
2473 }
2474
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002475 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2476 return AssumptionContext;
2477}
2478
2479void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002480 // The parameter constraints of the iteration domains give us a set of
2481 // constraints that need to hold for all cases where at least a single
2482 // statement iteration is executed in the whole scop. We now simplify the
2483 // assumed context under the assumption that such constraints hold and at
2484 // least a single statement iteration is executed. For cases where no
2485 // statement instances are executed, the assumptions we have taken about
2486 // the executed code do not matter and can be changed.
2487 //
2488 // WARNING: This only holds if the assumptions we have taken do not reduce
2489 // the set of statement instances that are executed. Otherwise we
2490 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002491 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002492 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002493 // performed. In such a case, modifying the run-time conditions and
2494 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002495 // to not be executed.
2496 //
2497 // Example:
2498 //
2499 // When delinearizing the following code:
2500 //
2501 // for (long i = 0; i < 100; i++)
2502 // for (long j = 0; j < m; j++)
2503 // A[i+p][j] = 1.0;
2504 //
2505 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002506 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002507 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002508 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002509 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002510}
2511
Tobias Grosserc80d6972016-09-02 06:33:33 +00002512/// Add the minimal/maximal access in @p Set to @p User.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002513static isl::stat
2514buildMinMaxAccess(isl::set Set, Scop::MinMaxVectorTy &MinMaxAccesses, Scop &S) {
2515 isl::pw_multi_aff MinPMA, MaxPMA;
2516 isl::pw_aff LastDimAff;
2517 isl::aff OneAff;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002518 unsigned Pos;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002519 isl::ctx Ctx = Set.get_ctx();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002520
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002521 Set = Set.remove_divs();
Johannes Doerfert6296d952016-04-22 11:38:19 +00002522
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002523 if (isl_set_n_basic_set(Set.get()) >= MaxDisjunctsInDomain)
2524 return isl::stat::error;
Johannes Doerfert6296d952016-04-22 11:38:19 +00002525
Johannes Doerfert9143d672014-09-27 11:02:39 +00002526 // Restrict the number of parameters involved in the access as the lexmin/
2527 // lexmax computation will take too long if this number is high.
2528 //
2529 // Experiments with a simple test case using an i7 4800MQ:
2530 //
2531 // #Parameters involved | Time (in sec)
2532 // 6 | 0.01
2533 // 7 | 0.04
2534 // 8 | 0.12
2535 // 9 | 0.40
2536 // 10 | 1.54
2537 // 11 | 6.78
2538 // 12 | 30.38
2539 //
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002540 if (isl_set_n_param(Set.get()) > RunTimeChecksMaxParameters) {
Johannes Doerfert9143d672014-09-27 11:02:39 +00002541 unsigned InvolvedParams = 0;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002542 for (unsigned u = 0, e = isl_set_n_param(Set.get()); u < e; u++)
2543 if (Set.involves_dims(isl::dim::param, u, 1))
Johannes Doerfert9143d672014-09-27 11:02:39 +00002544 InvolvedParams++;
2545
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002546 if (InvolvedParams > RunTimeChecksMaxParameters)
2547 return isl::stat::error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002548 }
2549
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +00002550 if (isl_set_n_basic_set(Set.get()) > RunTimeChecksMaxAccessDisjuncts)
2551 return isl::stat::error;
2552
Tobias Grosser57a1d362017-06-23 08:05:27 +00002553 MinPMA = Set.lexmin_pw_multi_aff();
2554 MaxPMA = Set.lexmax_pw_multi_aff();
Tobias Grosser45e9fd12017-05-19 03:45:00 +00002555
Tobias Grosser57a1d362017-06-23 08:05:27 +00002556 if (isl_ctx_last_error(Ctx.get()) == isl_error_quota)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002557 return isl::stat::error;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002558
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002559 MinPMA = MinPMA.coalesce();
2560 MaxPMA = MaxPMA.coalesce();
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002561
Johannes Doerfertb164c792014-09-18 11:17:17 +00002562 // Adjust the last dimension of the maximal access by one as we want to
2563 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2564 // we test during code generation might now point after the end of the
2565 // allocated array but we will never dereference it anyway.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002566 assert(MaxPMA.dim(isl::dim::out) && "Assumed at least one output dimension");
2567 Pos = MaxPMA.dim(isl::dim::out) - 1;
2568 LastDimAff = MaxPMA.get_pw_aff(Pos);
2569 OneAff = isl::aff(isl::local_space(LastDimAff.get_domain_space()));
2570 OneAff = OneAff.add_constant_si(1);
2571 LastDimAff = LastDimAff.add(OneAff);
2572 MaxPMA = MaxPMA.set_pw_aff(Pos, LastDimAff);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002573
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002574 MinMaxAccesses.push_back(std::make_pair(MinPMA.copy(), MaxPMA.copy()));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002575
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002576 return isl::stat::ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002577}
2578
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002579static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2580 isl_set *Domain = MA->getStatement()->getDomain();
2581 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2582 return isl_set_reset_tuple_id(Domain);
2583}
2584
Tobias Grosserc80d6972016-09-02 06:33:33 +00002585/// Wrapper function to calculate minimal/maximal accesses to each array.
Tobias Grossere9522232017-01-16 15:49:04 +00002586static bool calculateMinMaxAccess(Scop::AliasGroupTy AliasGroup, Scop &S,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002587 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002588
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002589 MinMaxAccesses.reserve(AliasGroup.size());
Tobias Grossere9522232017-01-16 15:49:04 +00002590
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002591 isl::union_set Domains = give(S.getDomains());
2592 isl::union_map Accesses = isl::union_map::empty(give(S.getParamSpace()));
Tobias Grossere9522232017-01-16 15:49:04 +00002593
2594 for (MemoryAccess *MA : AliasGroup)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002595 Accesses = Accesses.add_map(give(MA->getAccessRelation()));
Tobias Grossere9522232017-01-16 15:49:04 +00002596
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002597 Accesses = Accesses.intersect_domain(Domains);
2598 isl::union_set Locations = Accesses.range();
2599 Locations = Locations.coalesce();
2600 Locations = Locations.detect_equalities();
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002601
2602 auto Lambda = [&MinMaxAccesses, &S](isl::set Set) -> isl::stat {
2603 return buildMinMaxAccess(Set, MinMaxAccesses, S);
2604 };
2605 return Locations.foreach_set(Lambda) == isl::stat::ok;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002606}
2607
Tobias Grosserc80d6972016-09-02 06:33:33 +00002608/// Helper to treat non-affine regions and basic blocks the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002609///
2610///{
2611
Tobias Grosserc80d6972016-09-02 06:33:33 +00002612/// Return the block that is the representing block for @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002613static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2614 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2615 : RN->getNodeAs<BasicBlock>();
2616}
2617
Tobias Grosserc80d6972016-09-02 06:33:33 +00002618/// Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002619static inline BasicBlock *
2620getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002621 if (RN->isSubRegion()) {
2622 assert(idx == 0);
2623 return RN->getNodeAs<Region>()->getExit();
2624 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002625 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002626}
2627
Tobias Grosserc80d6972016-09-02 06:33:33 +00002628/// Return the smallest loop surrounding @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002629static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002630 if (!RN->isSubRegion()) {
2631 BasicBlock *BB = RN->getNodeAs<BasicBlock>();
2632 Loop *L = LI.getLoopFor(BB);
2633
2634 // Unreachable statements are not considered to belong to a LLVM loop, as
2635 // they are not part of an actual loop in the control flow graph.
2636 // Nevertheless, we handle certain unreachable statements that are common
2637 // when modeling run-time bounds checks as being part of the loop to be
2638 // able to model them and to later eliminate the run-time bounds checks.
2639 //
2640 // Specifically, for basic blocks that terminate in an unreachable and
Michael Krusea6d48f52017-06-08 12:06:15 +00002641 // where the immediate predecessor is part of a loop, we assume these
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002642 // basic blocks belong to the loop the predecessor belongs to. This
2643 // allows us to model the following code.
2644 //
2645 // for (i = 0; i < N; i++) {
2646 // if (i > 1024)
2647 // abort(); <- this abort might be translated to an
2648 // unreachable
2649 //
2650 // A[i] = ...
2651 // }
2652 if (!L && isa<UnreachableInst>(BB->getTerminator()) && BB->getPrevNode())
2653 L = LI.getLoopFor(BB->getPrevNode());
2654 return L;
2655 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002656
2657 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2658 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2659 while (L && NonAffineSubRegion->contains(L))
2660 L = L->getParentLoop();
2661 return L;
2662}
2663
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002664/// Get the number of blocks in @p L.
2665///
2666/// The number of blocks in a loop are the number of basic blocks actually
2667/// belonging to the loop, as well as all single basic blocks that the loop
2668/// exits to and which terminate in an unreachable instruction. We do not
2669/// allow such basic blocks in the exit of a scop, hence they belong to the
2670/// scop and represent run-time conditions which we want to model and
2671/// subsequently speculate away.
2672///
2673/// @see getRegionNodeLoop for additional details.
Reid Klecknerdf2b2832017-06-19 17:44:02 +00002674unsigned getNumBlocksInLoop(Loop *L) {
2675 unsigned NumBlocks = L->getNumBlocks();
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002676 SmallVector<llvm::BasicBlock *, 4> ExitBlocks;
2677 L->getExitBlocks(ExitBlocks);
2678
2679 for (auto ExitBlock : ExitBlocks) {
2680 if (isa<UnreachableInst>(ExitBlock->getTerminator()))
2681 NumBlocks++;
2682 }
2683 return NumBlocks;
2684}
2685
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002686static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2687 if (!RN->isSubRegion())
2688 return 1;
2689
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002690 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002691 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002692}
2693
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002694static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2695 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002696 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002697 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002698 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002699 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002700 return true;
2701 return false;
2702}
2703
Johannes Doerfert96425c22015-08-30 21:13:53 +00002704///}
2705
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002706static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2707 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002708 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002709 isl_id *DimId =
2710 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2711 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2712}
2713
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002714__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002715 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002716}
2717
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002718__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002719 auto DIt = DomainMap.find(BB);
2720 if (DIt != DomainMap.end())
Tobias Grosser325204a32017-07-15 12:41:32 +00002721 return DIt->getSecond().copy();
Johannes Doerfert41cda152016-04-08 10:32:26 +00002722
2723 auto &RI = *R.getRegionInfo();
2724 auto *BBR = RI.getRegionFor(BB);
2725 while (BBR->getEntry() == BB)
2726 BBR = BBR->getParent();
2727 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002728}
2729
Tobias Grosser13acbb92017-07-15 09:01:31 +00002730bool Scop::buildDomains(Region *R, DominatorTree &DT, LoopInfo &LI,
2731 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002732
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002733 bool IsOnlyNonAffineRegion = isNonAffineSubRegion(R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002734 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002735 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2736 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002737 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002738
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002739 while (LD-- >= 0) {
2740 S = addDomainDimId(S, LD + 1, L);
2741 L = L->getParentLoop();
2742 }
2743
Tobias Grosser13acbb92017-07-15 09:01:31 +00002744 InvalidDomainMap[EntryBB] = isl::manage(isl_set_empty(isl_set_get_space(S)));
Tobias Grosser325204a32017-07-15 12:41:32 +00002745 DomainMap[EntryBB] = isl::manage(S);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002746
Johannes Doerfert432658d2016-01-26 11:01:41 +00002747 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002748 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002749
Michael Kruse476f8552017-06-29 12:47:41 +00002750 if (!buildDomainsWithBranchConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002751 return false;
2752
Michael Kruse476f8552017-06-29 12:47:41 +00002753 if (!propagateDomainConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002754 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002755
2756 // Error blocks and blocks dominated by them have been assumed to never be
2757 // executed. Representing them in the Scop does not add any value. In fact,
2758 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002759 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002760 // will cause problems when building up a ScopStmt for them.
2761 // Furthermore, basic blocks dominated by error blocks may reference
2762 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002763 // can themselves not be constructed properly. To this end we will replace
2764 // the domains of error blocks and those only reachable via error blocks
2765 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002766 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002767 // InvalidDomain. This information is needed during load hoisting.
Michael Kruse476f8552017-06-29 12:47:41 +00002768 if (!propagateInvalidStmtDomains(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002769 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002770
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002771 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002772}
2773
Tobias Grosserc80d6972016-09-02 06:33:33 +00002774/// Adjust the dimensions of @p Dom that was constructed for @p OldL
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002775/// to be compatible to domains constructed for loop @p NewL.
2776///
2777/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2778/// edge from @p OldL to @p NewL.
2779static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2780 __isl_take isl_set *Dom,
2781 Loop *OldL, Loop *NewL) {
2782
2783 // If the loops are the same there is nothing to do.
2784 if (NewL == OldL)
2785 return Dom;
2786
2787 int OldDepth = S.getRelativeLoopDepth(OldL);
2788 int NewDepth = S.getRelativeLoopDepth(NewL);
2789 // If both loops are non-affine loops there is nothing to do.
2790 if (OldDepth == -1 && NewDepth == -1)
2791 return Dom;
2792
2793 // Distinguish three cases:
2794 // 1) The depth is the same but the loops are not.
2795 // => One loop was left one was entered.
2796 // 2) The depth increased from OldL to NewL.
2797 // => One loop was entered, none was left.
2798 // 3) The depth decreased from OldL to NewL.
2799 // => Loops were left were difference of the depths defines how many.
2800 if (OldDepth == NewDepth) {
2801 assert(OldL->getParentLoop() == NewL->getParentLoop());
2802 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2803 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2804 Dom = addDomainDimId(Dom, NewDepth, NewL);
2805 } else if (OldDepth < NewDepth) {
2806 assert(OldDepth + 1 == NewDepth);
2807 auto &R = S.getRegion();
2808 (void)R;
2809 assert(NewL->getParentLoop() == OldL ||
2810 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2811 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2812 Dom = addDomainDimId(Dom, NewDepth, NewL);
2813 } else {
2814 assert(OldDepth > NewDepth);
2815 int Diff = OldDepth - NewDepth;
2816 int NumDim = isl_set_n_dim(Dom);
2817 assert(NumDim >= Diff);
2818 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2819 }
2820
2821 return Dom;
2822}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002823
Michael Kruse476f8552017-06-29 12:47:41 +00002824bool Scop::propagateInvalidStmtDomains(
2825 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002826 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse476f8552017-06-29 12:47:41 +00002827
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002828 ReversePostOrderTraversal<Region *> RTraversal(R);
2829 for (auto *RN : RTraversal) {
2830
2831 // Recurse for affine subregions but go on for basic blocks and non-affine
2832 // subregions.
2833 if (RN->isSubRegion()) {
2834 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002835 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002836 propagateInvalidStmtDomains(SubRegion, DT, LI, InvalidDomainMap);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002837 continue;
2838 }
2839 }
2840
2841 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2842 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002843 isl::set &Domain = DomainMap[BB];
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002844 assert(Domain && "Cannot propagate a nullptr");
2845
Tobias Grosser325204a32017-07-15 12:41:32 +00002846 isl::set InvalidDomain = InvalidDomainMap[BB];
Michael Kruse476f8552017-06-29 12:47:41 +00002847
Tobias Grosser325204a32017-07-15 12:41:32 +00002848 bool IsInvalidBlock = ContainsErrorBlock || Domain.is_subset(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002849
Johannes Doerferta3519512016-04-23 13:02:23 +00002850 if (!IsInvalidBlock) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002851 InvalidDomain = InvalidDomain.intersect(Domain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002852 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002853 InvalidDomain = Domain;
Tobias Grosser325204a32017-07-15 12:41:32 +00002854 isl::set DomPar = Domain.params();
2855 recordAssumption(ERRORBLOCK, DomPar.release(),
2856 BB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002857 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002858 }
2859
Tobias Grosser325204a32017-07-15 12:41:32 +00002860 if (InvalidDomain.is_empty()) {
2861 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002862 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002863 }
2864
Johannes Doerferta3519512016-04-23 13:02:23 +00002865 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002866 auto *TI = BB->getTerminator();
2867 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2868 for (unsigned u = 0; u < NumSuccs; u++) {
2869 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002870
2871 // Skip successors outside the SCoP.
Michael Kruse476f8552017-06-29 12:47:41 +00002872 if (!contains(SuccBB))
Johannes Doerfert7c013572016-04-12 09:57:34 +00002873 continue;
2874
Johannes Doerferte4459a22016-04-25 13:34:50 +00002875 // Skip backedges.
2876 if (DT.dominates(SuccBB, BB))
2877 continue;
2878
Michael Kruse476f8552017-06-29 12:47:41 +00002879 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2880
Johannes Doerferta3519512016-04-23 13:02:23 +00002881 auto *AdjustedInvalidDomain = adjustDomainDimensions(
Tobias Grosser325204a32017-07-15 12:41:32 +00002882 *this, InvalidDomain.copy(), BBLoop, SuccBBLoop);
Michael Kruse476f8552017-06-29 12:47:41 +00002883
Tobias Grosser13acbb92017-07-15 09:01:31 +00002884 auto *SuccInvalidDomain = InvalidDomainMap[SuccBB].copy();
Johannes Doerferta3519512016-04-23 13:02:23 +00002885 SuccInvalidDomain =
2886 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2887 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2888 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
Michael Kruse476f8552017-06-29 12:47:41 +00002889
Tobias Grosser13acbb92017-07-15 09:01:31 +00002890 InvalidDomainMap[SuccBB] = isl::manage(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002891
Michael Krusebc150122016-05-02 12:25:18 +00002892 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002893 // In case this happens we will bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00002894 if (NumConjucts < MaxDisjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002895 continue;
2896
Tobias Grosserf44f0052017-07-09 15:47:17 +00002897 InvalidDomainMap.erase(BB);
Eli Friedmane737fc12017-07-17 23:58:33 +00002898 invalidate(COMPLEXITY, TI->getDebugLoc(), TI->getParent());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002899 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002900 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002901
Tobias Grosser325204a32017-07-15 12:41:32 +00002902 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002903 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002904
2905 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002906}
2907
Johannes Doerfert642594a2016-04-04 07:57:39 +00002908void Scop::propagateDomainConstraintsToRegionExit(
2909 BasicBlock *BB, Loop *BBLoop,
Michael Kruse476f8552017-06-29 12:47:41 +00002910 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002911 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002912
2913 // Check if the block @p BB is the entry of a region. If so we propagate it's
2914 // domain to the exit block of the region. Otherwise we are done.
2915 auto *RI = R.getRegionInfo();
2916 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2917 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002918 if (!BBReg || BBReg->getEntry() != BB || !contains(ExitBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002919 return;
2920
Johannes Doerfert642594a2016-04-04 07:57:39 +00002921 // Do not propagate the domain if there is a loop backedge inside the region
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002922 // that would prevent the exit block from being executed.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002923 auto *L = BBLoop;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002924 while (L && contains(L)) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002925 SmallVector<BasicBlock *, 4> LatchBBs;
2926 BBLoop->getLoopLatches(LatchBBs);
2927 for (auto *LatchBB : LatchBBs)
2928 if (BB != LatchBB && BBReg->contains(LatchBB))
2929 return;
2930 L = L->getParentLoop();
2931 }
2932
Tobias Grosser325204a32017-07-15 12:41:32 +00002933 isl::set Domain = DomainMap[BB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002934 assert(Domain && "Cannot propagate a nullptr");
2935
Michael Kruse476f8552017-06-29 12:47:41 +00002936 Loop *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002937
2938 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2939 // adjust the domain before we can propagate it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002940 isl::set AdjustedDomain = isl::manage(
2941 adjustDomainDimensions(*this, Domain.copy(), BBLoop, ExitBBLoop));
2942 isl::set &ExitDomain = DomainMap[ExitBB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002943
2944 // If the exit domain is not yet created we set it otherwise we "add" the
2945 // current domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002946 ExitDomain = ExitDomain ? AdjustedDomain.unite(ExitDomain) : AdjustedDomain;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002947
Johannes Doerferta3519512016-04-23 13:02:23 +00002948 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002949 InvalidDomainMap[ExitBB] = ExitDomain.empty(ExitDomain.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002950
Johannes Doerfert642594a2016-04-04 07:57:39 +00002951 FinishedExitBlocks.insert(ExitBB);
2952}
2953
Michael Kruse476f8552017-06-29 12:47:41 +00002954bool Scop::buildDomainsWithBranchConstraints(
2955 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002956 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse476f8552017-06-29 12:47:41 +00002957
Johannes Doerfert96425c22015-08-30 21:13:53 +00002958 // To create the domain for each block in R we iterate over all blocks and
2959 // subregions in R and propagate the conditions under which the current region
2960 // element is executed. To this end we iterate in reverse post order over R as
2961 // it ensures that we first visit all predecessors of a region node (either a
2962 // basic block or a subregion) before we visit the region node itself.
2963 // Initially, only the domain for the SCoP region entry block is set and from
2964 // there we propagate the current domain to all successors, however we add the
2965 // condition that the successor is actually executed next.
2966 // As we are only interested in non-loop carried constraints here we can
2967 // simply skip loop back edges.
2968
Johannes Doerfert642594a2016-04-04 07:57:39 +00002969 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002970 ReversePostOrderTraversal<Region *> RTraversal(R);
2971 for (auto *RN : RTraversal) {
2972
2973 // Recurse for affine subregions but go on for basic blocks and non-affine
2974 // subregions.
2975 if (RN->isSubRegion()) {
2976 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002977 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002978 if (!buildDomainsWithBranchConstraints(SubRegion, DT, LI,
2979 InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002980 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002981 continue;
2982 }
2983 }
2984
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002985 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002986 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002987
Johannes Doerfert96425c22015-08-30 21:13:53 +00002988 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002989 TerminatorInst *TI = BB->getTerminator();
2990
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002991 if (isa<UnreachableInst>(TI))
2992 continue;
2993
Tobias Grosser325204a32017-07-15 12:41:32 +00002994 isl::set Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002995 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002996 continue;
Tobias Grosser325204a32017-07-15 12:41:32 +00002997 MaxLoopDepth = std::max(MaxLoopDepth, isl_set_n_dim(Domain.get()));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002998
Johannes Doerfert642594a2016-04-04 07:57:39 +00002999 auto *BBLoop = getRegionNodeLoop(RN, LI);
3000 // Propagate the domain from BB directly to blocks that have a superset
3001 // domain, at the moment only region exit nodes of regions that start in BB.
Michael Kruse476f8552017-06-29 12:47:41 +00003002 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, LI,
3003 InvalidDomainMap);
Johannes Doerfert642594a2016-04-04 07:57:39 +00003004
3005 // If all successors of BB have been set a domain through the propagation
3006 // above we do not need to build condition sets but can just skip this
3007 // block. However, it is important to note that this is a local property
3008 // with regards to the region @p R. To this end FinishedExitBlocks is a
3009 // local variable.
3010 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
3011 return FinishedExitBlocks.count(SuccBB);
3012 };
3013 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
3014 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003015
3016 // Build the condition sets for the successor nodes of the current region
3017 // node. If it is a non-affine subregion we will always execute the single
3018 // exit node, hence the single entry node domain is the condition set. For
3019 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003020 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003021 if (RN->isSubRegion())
Tobias Grosser325204a32017-07-15 12:41:32 +00003022 ConditionSets.push_back(Domain.copy());
3023 else if (!buildConditionSets(*this, BB, TI, BBLoop, Domain.get(),
Michael Kruse476f8552017-06-29 12:47:41 +00003024 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003025 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003026
3027 // Now iterate over the successors and set their initial domain based on
3028 // their condition set. We skip back edges here and have to be careful when
3029 // we leave a loop not to keep constraints over a dimension that doesn't
3030 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003031 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00003032 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Tobias Grosser325204a32017-07-15 12:41:32 +00003033 isl::set CondSet = isl::manage(ConditionSets[u]);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003034 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00003035
Johannes Doerfert535de032016-04-19 14:49:05 +00003036 // Skip blocks outside the region.
Tobias Grosser325204a32017-07-15 12:41:32 +00003037 if (!contains(SuccBB))
Johannes Doerfert535de032016-04-19 14:49:05 +00003038 continue;
Johannes Doerfert535de032016-04-19 14:49:05 +00003039
Johannes Doerfert642594a2016-04-04 07:57:39 +00003040 // If we propagate the domain of some block to "SuccBB" we do not have to
3041 // adjust the domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00003042 if (FinishedExitBlocks.count(SuccBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00003043 continue;
Johannes Doerfert642594a2016-04-04 07:57:39 +00003044
Johannes Doerfert96425c22015-08-30 21:13:53 +00003045 // Skip back edges.
Tobias Grosser325204a32017-07-15 12:41:32 +00003046 if (DT.dominates(SuccBB, BB))
Johannes Doerfert96425c22015-08-30 21:13:53 +00003047 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003048
Michael Kruse476f8552017-06-29 12:47:41 +00003049 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
3050
Tobias Grosser325204a32017-07-15 12:41:32 +00003051 CondSet = isl::manage(
3052 adjustDomainDimensions(*this, CondSet.copy(), BBLoop, SuccBBLoop));
Johannes Doerfert96425c22015-08-30 21:13:53 +00003053
3054 // Set the domain for the successor or merge it with an existing domain in
3055 // case there are multiple paths (without loop back edges) to the
3056 // successor block.
Tobias Grosser325204a32017-07-15 12:41:32 +00003057 isl::set &SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00003058
Johannes Doerferta3519512016-04-23 13:02:23 +00003059 if (SuccDomain) {
Tobias Grosser325204a32017-07-15 12:41:32 +00003060 SuccDomain = SuccDomain.unite(CondSet).coalesce();
Johannes Doerferta3519512016-04-23 13:02:23 +00003061 } else {
3062 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00003063 InvalidDomainMap[SuccBB] = CondSet.empty(CondSet.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00003064 SuccDomain = CondSet;
3065 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00003066
Tobias Grosser325204a32017-07-15 12:41:32 +00003067 SuccDomain = SuccDomain.detect_equalities();
Tobias Grosser6d459c52017-05-23 04:26:28 +00003068
Michael Krusebc150122016-05-02 12:25:18 +00003069 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003070 // In case this happens we will clean up and bail.
Tobias Grosser325204a32017-07-15 12:41:32 +00003071 if (isl_set_n_basic_set(SuccDomain.get()) < MaxDisjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003072 continue;
3073
3074 invalidate(COMPLEXITY, DebugLoc());
3075 while (++u < ConditionSets.size())
3076 isl_set_free(ConditionSets[u]);
3077 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003078 }
3079 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003080
3081 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003082}
3083
Michael Krused56b90a2016-09-01 09:03:27 +00003084__isl_give isl_set *
3085Scop::getPredecessorDomainConstraints(BasicBlock *BB,
3086 __isl_keep isl_set *Domain,
3087 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00003088 // If @p BB is the ScopEntry we are done
3089 if (R.getEntry() == BB)
3090 return isl_set_universe(isl_set_get_space(Domain));
3091
Johannes Doerfert642594a2016-04-04 07:57:39 +00003092 // The region info of this function.
3093 auto &RI = *R.getRegionInfo();
3094
Michael Kruse476f8552017-06-29 12:47:41 +00003095 Loop *BBLoop = getFirstNonBoxedLoopFor(BB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00003096
3097 // A domain to collect all predecessor domains, thus all conditions under
3098 // which the block is executed. To this end we start with the empty domain.
3099 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
3100
3101 // Set of regions of which the entry block domain has been propagated to BB.
3102 // all predecessors inside any of the regions can be skipped.
3103 SmallSet<Region *, 8> PropagatedRegions;
3104
3105 for (auto *PredBB : predecessors(BB)) {
3106 // Skip backedges.
3107 if (DT.dominates(BB, PredBB))
3108 continue;
3109
3110 // If the predecessor is in a region we used for propagation we can skip it.
3111 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
3112 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
3113 PredBBInRegion)) {
3114 continue;
3115 }
3116
3117 // Check if there is a valid region we can use for propagation, thus look
3118 // for a region that contains the predecessor and has @p BB as exit block.
3119 auto *PredR = RI.getRegionFor(PredBB);
3120 while (PredR->getExit() != BB && !PredR->contains(BB))
3121 PredR->getParent();
3122
3123 // If a valid region for propagation was found use the entry of that region
3124 // for propagation, otherwise the PredBB directly.
3125 if (PredR->getExit() == BB) {
3126 PredBB = PredR->getEntry();
3127 PropagatedRegions.insert(PredR);
3128 }
3129
Johannes Doerfert41cda152016-04-08 10:32:26 +00003130 auto *PredBBDom = getDomainConditions(PredBB);
Michael Kruse476f8552017-06-29 12:47:41 +00003131 Loop *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, getBoxedLoops());
3132
Johannes Doerfert642594a2016-04-04 07:57:39 +00003133 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
3134
3135 PredDom = isl_set_union(PredDom, PredBBDom);
3136 }
3137
3138 return PredDom;
3139}
3140
Michael Kruse476f8552017-06-29 12:47:41 +00003141bool Scop::propagateDomainConstraints(
3142 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00003143 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003144 // Iterate over the region R and propagate the domain constrains from the
3145 // predecessors to the current node. In contrast to the
3146 // buildDomainsWithBranchConstraints function, this one will pull the domain
3147 // information from the predecessors instead of pushing it to the successors.
3148 // Additionally, we assume the domains to be already present in the domain
3149 // map here. However, we iterate again in reverse post order so we know all
3150 // predecessors have been visited before a block or non-affine subregion is
3151 // visited.
3152
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003153 ReversePostOrderTraversal<Region *> RTraversal(R);
3154 for (auto *RN : RTraversal) {
3155
3156 // Recurse for affine subregions but go on for basic blocks and non-affine
3157 // subregions.
3158 if (RN->isSubRegion()) {
3159 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003160 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00003161 if (!propagateDomainConstraints(SubRegion, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003162 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003163 continue;
3164 }
3165 }
3166
3167 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00003168 isl::set &Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00003169 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003170
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003171 // Under the union of all predecessor conditions we can reach this block.
Tobias Grosser325204a32017-07-15 12:41:32 +00003172 isl::set PredDom =
3173 isl::manage(getPredecessorDomainConstraints(BB, Domain.get(), DT, LI));
3174 Domain = Domain.intersect(PredDom).coalesce();
3175 Domain = Domain.align_params(isl::manage(getParamSpace()));
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003176
Johannes Doerfert642594a2016-04-04 07:57:39 +00003177 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00003178 if (BBLoop && BBLoop->getHeader() == BB && contains(BBLoop))
Michael Kruse476f8552017-06-29 12:47:41 +00003179 if (!addLoopBoundsToHeaderDomain(BBLoop, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003180 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003181 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00003182
3183 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003184}
3185
Tobias Grosserc80d6972016-09-02 06:33:33 +00003186/// Create a map to map from a given iteration to a subsequent iteration.
3187///
3188/// This map maps from SetSpace -> SetSpace where the dimensions @p Dim
3189/// is incremented by one and all other dimensions are equal, e.g.,
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003190/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
Tobias Grosserc80d6972016-09-02 06:33:33 +00003191///
3192/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003193static __isl_give isl_map *
3194createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
3195 auto *MapSpace = isl_space_map_from_set(SetSpace);
3196 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
Tobias Grosserf4fe34b2017-03-16 21:33:20 +00003197 for (unsigned u = 0; u < isl_map_dim(NextIterationMap, isl_dim_in); u++)
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003198 if (u != Dim)
3199 NextIterationMap =
3200 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
3201 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
3202 C = isl_constraint_set_constant_si(C, 1);
3203 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
3204 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
3205 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
3206 return NextIterationMap;
3207}
3208
Michael Kruse476f8552017-06-29 12:47:41 +00003209bool Scop::addLoopBoundsToHeaderDomain(
Tobias Grosser13acbb92017-07-15 09:01:31 +00003210 Loop *L, LoopInfo &LI, DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003211 int LoopDepth = getRelativeLoopDepth(L);
3212 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003213
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003214 BasicBlock *HeaderBB = L->getHeader();
3215 assert(DomainMap.count(HeaderBB));
Tobias Grosser325204a32017-07-15 12:41:32 +00003216 isl::set &HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003217
Tobias Grosser325204a32017-07-15 12:41:32 +00003218 isl::map NextIterationMap = isl::manage(
3219 createNextIterationMap(HeaderBBDom.get_space().release(), LoopDepth));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003220
Tobias Grosser325204a32017-07-15 12:41:32 +00003221 isl::set UnionBackedgeCondition = HeaderBBDom.empty(HeaderBBDom.get_space());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003222
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003223 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
3224 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003225
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003226 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003227
3228 // If the latch is only reachable via error statements we skip it.
Tobias Grosser325204a32017-07-15 12:41:32 +00003229 isl::set LatchBBDom = DomainMap.lookup(LatchBB);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003230 if (!LatchBBDom)
3231 continue;
3232
Tobias Grosser325204a32017-07-15 12:41:32 +00003233 isl::set BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003234
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003235 TerminatorInst *TI = LatchBB->getTerminator();
3236 BranchInst *BI = dyn_cast<BranchInst>(TI);
Tobias Grosserbbaeda32016-11-10 05:20:29 +00003237 assert(BI && "Only branch instructions allowed in loop latches");
3238
3239 if (BI->isUnconditional())
Tobias Grosser325204a32017-07-15 12:41:32 +00003240 BackedgeCondition = LatchBBDom;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003241 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003242 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003243 int idx = BI->getSuccessor(0) != HeaderBB;
Tobias Grosser325204a32017-07-15 12:41:32 +00003244 if (!buildConditionSets(*this, LatchBB, TI, L, LatchBBDom.get(),
3245 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003246 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003247
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003248 // Free the non back edge condition set as we do not need it.
3249 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003250
Tobias Grosser325204a32017-07-15 12:41:32 +00003251 BackedgeCondition = isl::manage(ConditionSets[idx]);
Johannes Doerfert06c57b52015-09-20 15:00:20 +00003252 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003253
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003254 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
3255 assert(LatchLoopDepth >= LoopDepth);
Tobias Grosser325204a32017-07-15 12:41:32 +00003256 BackedgeCondition = BackedgeCondition.project_out(
3257 isl::dim::set, LoopDepth + 1, LatchLoopDepth - LoopDepth);
3258 UnionBackedgeCondition = UnionBackedgeCondition.unite(BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003259 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003260
Tobias Grosser325204a32017-07-15 12:41:32 +00003261 isl::map ForwardMap = ForwardMap.lex_le(HeaderBBDom.get_space());
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003262 for (int i = 0; i < LoopDepth; i++)
Tobias Grosser325204a32017-07-15 12:41:32 +00003263 ForwardMap = ForwardMap.equate(isl::dim::in, i, isl::dim::out, i);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003264
Tobias Grosser325204a32017-07-15 12:41:32 +00003265 isl::set UnionBackedgeConditionComplement =
3266 UnionBackedgeCondition.complement();
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003267 UnionBackedgeConditionComplement =
Tobias Grosser325204a32017-07-15 12:41:32 +00003268 UnionBackedgeConditionComplement.lower_bound_si(isl::dim::set, LoopDepth,
3269 0);
3270 UnionBackedgeConditionComplement =
3271 UnionBackedgeConditionComplement.apply(ForwardMap);
3272 HeaderBBDom = HeaderBBDom.subtract(UnionBackedgeConditionComplement);
3273 HeaderBBDom = HeaderBBDom.apply(NextIterationMap);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003274
Tobias Grosser325204a32017-07-15 12:41:32 +00003275 auto Parts = partitionSetParts(HeaderBBDom.copy(), LoopDepth);
3276 HeaderBBDom = isl::manage(Parts.second);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003277
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003278 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
3279 // the bounded assumptions to the context as they are already implied by the
3280 // <nsw> tag.
3281 if (Affinator.hasNSWAddRecForLoop(L)) {
3282 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003283 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003284 }
3285
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003286 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003287 recordAssumption(INFINITELOOP, UnboundedCtx,
3288 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003289 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003290}
3291
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003292MemoryAccess *Scop::lookupBasePtrAccess(MemoryAccess *MA) {
Tobias Grosserbe372d52017-02-09 10:11:58 +00003293 Value *PointerBase = MA->getOriginalBaseAddr();
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003294
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003295 auto *PointerBaseInst = dyn_cast<Instruction>(PointerBase);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003296 if (!PointerBaseInst)
3297 return nullptr;
3298
3299 auto *BasePtrStmt = getStmtFor(PointerBaseInst);
3300 if (!BasePtrStmt)
3301 return nullptr;
3302
3303 return BasePtrStmt->getArrayAccessOrNULLFor(PointerBaseInst);
3304}
3305
3306bool Scop::hasNonHoistableBasePtrInScop(MemoryAccess *MA,
Tobias Grosser4071cb52017-06-06 23:13:02 +00003307 isl::union_map Writes) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003308 if (auto *BasePtrMA = lookupBasePtrAccess(MA)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003309 return getNonHoistableCtx(BasePtrMA, Writes).is_null();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003310 }
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003311
Tobias Grosserbe372d52017-02-09 10:11:58 +00003312 Value *BaseAddr = MA->getOriginalBaseAddr();
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003313 if (auto *BasePtrInst = dyn_cast<Instruction>(BaseAddr))
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003314 if (!isa<LoadInst>(BasePtrInst))
Johannes Doerfert952b5302016-05-23 12:40:48 +00003315 return contains(BasePtrInst);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003316
3317 return false;
3318}
3319
Johannes Doerfert5210da52016-06-02 11:06:54 +00003320bool Scop::buildAliasChecks(AliasAnalysis &AA) {
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003321 if (!PollyUseRuntimeAliasChecks)
Johannes Doerfert5210da52016-06-02 11:06:54 +00003322 return true;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003323
Johannes Doerfertcd195322016-11-17 21:41:08 +00003324 if (buildAliasGroups(AA)) {
3325 // Aliasing assumptions do not go through addAssumption but we still want to
3326 // collect statistics so we do it here explicitly.
3327 if (MinMaxAliasGroups.size())
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00003328 AssumptionsAliasing++;
Johannes Doerfert5210da52016-06-02 11:06:54 +00003329 return true;
Johannes Doerfertcd195322016-11-17 21:41:08 +00003330 }
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003331
3332 // If a problem occurs while building the alias groups we need to delete
3333 // this SCoP and pretend it wasn't valid in the first place. To this end
3334 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003335 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003336
3337 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
3338 << " could not be created as the number of parameters involved "
3339 "is too high. The SCoP will be "
3340 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
3341 "the maximal number of parameters but be advised that the "
3342 "compile time might increase exponentially.\n\n");
Johannes Doerfert5210da52016-06-02 11:06:54 +00003343 return false;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003344}
3345
Tobias Grosser889830b2017-02-09 23:12:22 +00003346std::tuple<Scop::AliasGroupVectorTy, DenseSet<const ScopArrayInfo *>>
Tobias Grosser9edcf072017-01-16 14:07:57 +00003347Scop::buildAliasGroupsForAccesses(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003348 AliasSetTracker AST(AA);
3349
3350 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Tobias Grosser889830b2017-02-09 23:12:22 +00003351 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003352 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003353
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003354 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003355 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
3356 isl_set_free(StmtDomain);
Tobias Grosser9edcf072017-01-16 14:07:57 +00003357
3358 // Statements with an empty domain will never be executed.
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003359 if (StmtDomainEmpty)
3360 continue;
3361
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003362 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00003363 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003364 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00003365 if (!MA->isRead())
Tobias Grosser889830b2017-02-09 23:12:22 +00003366 HasWriteAccess.insert(MA->getScopArrayInfo());
Michael Kruse70131d32016-01-27 17:09:17 +00003367 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003368 if (MA->isRead() && isa<MemTransferInst>(Acc))
Michael Kruse426e6f72016-10-25 13:37:43 +00003369 PtrToAcc[cast<MemTransferInst>(Acc)->getRawSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00003370 else
3371 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003372 AST.add(Acc);
3373 }
3374 }
3375
Tobias Grosser9edcf072017-01-16 14:07:57 +00003376 AliasGroupVectorTy AliasGroups;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003377 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00003378 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003379 continue;
3380 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00003381 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00003382 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003383 if (AG.size() < 2)
3384 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003385 AliasGroups.push_back(std::move(AG));
3386 }
3387
Tobias Grosser9edcf072017-01-16 14:07:57 +00003388 return std::make_tuple(AliasGroups, HasWriteAccess);
3389}
3390
Tobias Grossere39f9122017-01-16 14:08:00 +00003391void Scop::splitAliasGroupsByDomain(AliasGroupVectorTy &AliasGroups) {
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003392 for (unsigned u = 0; u < AliasGroups.size(); u++) {
3393 AliasGroupTy NewAG;
3394 AliasGroupTy &AG = AliasGroups[u];
3395 AliasGroupTy::iterator AGI = AG.begin();
3396 isl_set *AGDomain = getAccessDomain(*AGI);
3397 while (AGI != AG.end()) {
3398 MemoryAccess *MA = *AGI;
3399 isl_set *MADomain = getAccessDomain(MA);
3400 if (isl_set_is_disjoint(AGDomain, MADomain)) {
3401 NewAG.push_back(MA);
3402 AGI = AG.erase(AGI);
3403 isl_set_free(MADomain);
3404 } else {
3405 AGDomain = isl_set_union(AGDomain, MADomain);
3406 AGI++;
3407 }
3408 }
3409 if (NewAG.size() > 1)
3410 AliasGroups.push_back(std::move(NewAG));
3411 isl_set_free(AGDomain);
3412 }
Tobias Grossere39f9122017-01-16 14:08:00 +00003413}
3414
3415bool Scop::buildAliasGroups(AliasAnalysis &AA) {
3416 // To create sound alias checks we perform the following steps:
3417 // o) We partition each group into read only and non read only accesses.
3418 // o) For each group with more than one base pointer we then compute minimal
3419 // and maximal accesses to each array of a group in read only and non
3420 // read only partitions separately.
3421 AliasGroupVectorTy AliasGroups;
Tobias Grosser889830b2017-02-09 23:12:22 +00003422 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grossere39f9122017-01-16 14:08:00 +00003423
3424 std::tie(AliasGroups, HasWriteAccess) = buildAliasGroupsForAccesses(AA);
3425
3426 splitAliasGroupsByDomain(AliasGroups);
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003427
Johannes Doerfert13771732014-10-01 12:40:46 +00003428 for (AliasGroupTy &AG : AliasGroups) {
Tobias Grosser78a7a6c2017-06-23 08:05:31 +00003429 if (!hasFeasibleRuntimeContext())
3430 return false;
3431
Tobias Grosser57a1d362017-06-23 08:05:27 +00003432 {
3433 IslMaxOperationsGuard MaxOpGuard(getIslCtx(), OptComputeOut);
3434 bool Valid = buildAliasGroup(AG, HasWriteAccess);
3435 if (!Valid)
3436 return false;
3437 }
3438 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
3439 invalidate(COMPLEXITY, DebugLoc());
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003440 return false;
Tobias Grosser57a1d362017-06-23 08:05:27 +00003441 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003442 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003443
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003444 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003445}
3446
Tobias Grosser77f32572017-01-16 15:49:07 +00003447bool Scop::buildAliasGroup(Scop::AliasGroupTy &AliasGroup,
Tobias Grosser889830b2017-02-09 23:12:22 +00003448 DenseSet<const ScopArrayInfo *> HasWriteAccess) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003449 AliasGroupTy ReadOnlyAccesses;
3450 AliasGroupTy ReadWriteAccesses;
Tobias Grosser889830b2017-02-09 23:12:22 +00003451 SmallPtrSet<const ScopArrayInfo *, 4> ReadWriteArrays;
Tobias Grosser079d5112017-02-18 20:51:29 +00003452 SmallPtrSet<const ScopArrayInfo *, 4> ReadOnlyArrays;
Tobias Grosser77f32572017-01-16 15:49:07 +00003453
Tobias Grosser77f32572017-01-16 15:49:07 +00003454 if (AliasGroup.size() < 2)
3455 return true;
3456
3457 for (MemoryAccess *Access : AliasGroup) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003458 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "PossibleAlias",
3459 Access->getAccessInstruction())
3460 << "Possibly aliasing pointer, use restrict keyword.");
Tobias Grosser889830b2017-02-09 23:12:22 +00003461 const ScopArrayInfo *Array = Access->getScopArrayInfo();
3462 if (HasWriteAccess.count(Array)) {
3463 ReadWriteArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003464 ReadWriteAccesses.push_back(Access);
3465 } else {
Tobias Grosser079d5112017-02-18 20:51:29 +00003466 ReadOnlyArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003467 ReadOnlyAccesses.push_back(Access);
3468 }
3469 }
3470
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003471 // If there are no read-only pointers, and less than two read-write pointers,
3472 // no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003473 if (ReadOnlyAccesses.empty() && ReadWriteArrays.size() <= 1)
Tobias Grosser77f32572017-01-16 15:49:07 +00003474 return true;
3475
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003476 // If there is no read-write pointer, no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003477 if (ReadWriteArrays.empty())
Tobias Grosser77f32572017-01-16 15:49:07 +00003478 return true;
3479
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003480 // For non-affine accesses, no alias check can be generated as we cannot
3481 // compute a sufficiently tight lower and upper bound: bail out.
Tobias Grosser77f32572017-01-16 15:49:07 +00003482 for (MemoryAccess *MA : AliasGroup) {
3483 if (!MA->isAffine()) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003484 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc(),
3485 MA->getAccessInstruction()->getParent());
Tobias Grosser77f32572017-01-16 15:49:07 +00003486 return false;
3487 }
Tobias Grosser0032d872017-01-16 15:49:14 +00003488 }
3489
3490 // Ensure that for all memory accesses for which we generate alias checks,
3491 // their base pointers are available.
3492 for (MemoryAccess *MA : AliasGroup) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003493 if (MemoryAccess *BasePtrMA = lookupBasePtrAccess(MA))
3494 addRequiredInvariantLoad(
3495 cast<LoadInst>(BasePtrMA->getAccessInstruction()));
3496 }
3497
3498 MinMaxAliasGroups.emplace_back();
3499 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3500 MinMaxVectorTy &MinMaxAccessesReadWrite = pair.first;
3501 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3502
3503 bool Valid;
3504
3505 Valid =
3506 calculateMinMaxAccess(ReadWriteAccesses, *this, MinMaxAccessesReadWrite);
3507
3508 if (!Valid)
3509 return false;
3510
3511 // Bail out if the number of values we need to compare is too large.
3512 // This is important as the number of comparisons grows quadratically with
3513 // the number of values we need to compare.
Tobias Grosser079d5112017-02-18 20:51:29 +00003514 if (MinMaxAccessesReadWrite.size() + ReadOnlyArrays.size() >
Tobias Grosser77f32572017-01-16 15:49:07 +00003515 RunTimeChecksMaxArraysPerGroup)
3516 return false;
3517
3518 Valid =
3519 calculateMinMaxAccess(ReadOnlyAccesses, *this, MinMaxAccessesReadOnly);
3520
3521 if (!Valid)
3522 return false;
3523
3524 return true;
3525}
3526
Tobias Grosserc80d6972016-09-02 06:33:33 +00003527/// Get the smallest loop that contains @p S but is not in @p S.
Johannes Doerfertef744432016-05-23 12:42:38 +00003528static Loop *getLoopSurroundingScop(Scop &S, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003529 // Start with the smallest loop containing the entry and expand that
3530 // loop until it contains all blocks in the region. If there is a loop
3531 // containing all blocks in the region check if it is itself contained
3532 // and if so take the parent loop as it will be the smallest containing
3533 // the region but not contained by it.
Johannes Doerfertef744432016-05-23 12:42:38 +00003534 Loop *L = LI.getLoopFor(S.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003535 while (L) {
3536 bool AllContained = true;
Johannes Doerfertef744432016-05-23 12:42:38 +00003537 for (auto *BB : S.blocks())
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003538 AllContained &= L->contains(BB);
3539 if (AllContained)
3540 break;
3541 L = L->getParentLoop();
3542 }
3543
Johannes Doerfertef744432016-05-23 12:42:38 +00003544 return L ? (S.contains(L) ? L->getParentLoop() : L) : nullptr;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003545}
3546
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003547int Scop::NextScopID = 0;
3548
3549std::string Scop::CurrentFunc = "";
3550
3551int Scop::getNextID(std::string ParentFunc) {
3552 if (ParentFunc != CurrentFunc) {
3553 CurrentFunc = ParentFunc;
3554 NextScopID = 0;
3555 }
3556 return NextScopID++;
3557}
3558
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003559Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
Eli Friedmane737fc12017-07-17 23:58:33 +00003560 ScopDetection::DetectionContext &DC, OptimizationRemarkEmitter &ORE)
Philip Pfaffe35bdcaf2017-05-15 13:43:01 +00003561 : SE(&ScalarEvolution), R(R), name(R.getNameStr()), IsOptimized(false),
Siddharth Bhat47c72372017-07-05 15:07:28 +00003562 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Eli Friedmane737fc12017-07-17 23:58:33 +00003563 MaxLoopDepth(0), CopyStmtsNum(0), SkipScop(false), DC(DC), ORE(ORE),
Roman Gareevb3224ad2016-09-14 06:26:09 +00003564 IslCtx(isl_ctx_alloc(), isl_ctx_free), Context(nullptr),
3565 Affinator(this, LI), AssumedContext(nullptr), InvalidContext(nullptr),
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003566 Schedule(nullptr),
3567 ID(getNextID((*R.getEntry()->getParent()).getName().str())) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003568 if (IslOnErrorAbort)
3569 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003570 buildContext();
3571}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003572
Tobias Grosserbedef002016-12-02 08:10:56 +00003573void Scop::foldSizeConstantsToRight() {
3574 isl_union_set *Accessed = isl_union_map_range(getAccesses());
3575
3576 for (auto Array : arrays()) {
3577 if (Array->getNumberOfDimensions() <= 1)
3578 continue;
3579
3580 isl_space *Space = Array->getSpace();
3581
3582 Space = isl_space_align_params(Space, isl_union_set_get_space(Accessed));
3583
3584 if (!isl_union_set_contains(Accessed, Space)) {
3585 isl_space_free(Space);
3586 continue;
3587 }
3588
3589 isl_set *Elements = isl_union_set_extract_set(Accessed, Space);
3590
3591 isl_map *Transform =
3592 isl_map_universe(isl_space_map_from_set(Array->getSpace()));
3593
3594 std::vector<int> Int;
3595
3596 int Dims = isl_set_dim(Elements, isl_dim_set);
3597 for (int i = 0; i < Dims; i++) {
3598 isl_set *DimOnly =
3599 isl_set_project_out(isl_set_copy(Elements), isl_dim_set, 0, i);
3600 DimOnly = isl_set_project_out(DimOnly, isl_dim_set, 1, Dims - i - 1);
3601 DimOnly = isl_set_lower_bound_si(DimOnly, isl_dim_set, 0, 0);
3602
3603 isl_basic_set *DimHull = isl_set_affine_hull(DimOnly);
3604
3605 if (i == Dims - 1) {
3606 Int.push_back(1);
3607 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3608 isl_basic_set_free(DimHull);
3609 continue;
3610 }
3611
3612 if (isl_basic_set_dim(DimHull, isl_dim_div) == 1) {
3613 isl_aff *Diff = isl_basic_set_get_div(DimHull, 0);
3614 isl_val *Val = isl_aff_get_denominator_val(Diff);
3615 isl_aff_free(Diff);
3616
3617 int ValInt = 1;
3618
3619 if (isl_val_is_int(Val))
3620 ValInt = isl_val_get_num_si(Val);
3621 isl_val_free(Val);
3622
3623 Int.push_back(ValInt);
3624
3625 isl_constraint *C = isl_constraint_alloc_equality(
3626 isl_local_space_from_space(isl_map_get_space(Transform)));
3627 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, ValInt);
3628 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, -1);
3629 Transform = isl_map_add_constraint(Transform, C);
3630 isl_basic_set_free(DimHull);
3631 continue;
3632 }
3633
3634 isl_basic_set *ZeroSet = isl_basic_set_copy(DimHull);
3635 ZeroSet = isl_basic_set_fix_si(ZeroSet, isl_dim_set, 0, 0);
3636
3637 int ValInt = 1;
3638 if (isl_basic_set_is_equal(ZeroSet, DimHull)) {
3639 ValInt = 0;
3640 }
3641
3642 Int.push_back(ValInt);
3643 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3644 isl_basic_set_free(DimHull);
3645 isl_basic_set_free(ZeroSet);
3646 }
3647
3648 isl_set *MappedElements = isl_map_domain(isl_map_copy(Transform));
3649
3650 if (!isl_set_is_subset(Elements, MappedElements)) {
3651 isl_set_free(Elements);
3652 isl_set_free(MappedElements);
3653 isl_map_free(Transform);
3654 continue;
3655 }
3656
3657 isl_set_free(MappedElements);
3658
3659 bool CanFold = true;
3660
3661 if (Int[0] <= 1)
3662 CanFold = false;
3663
3664 unsigned NumDims = Array->getNumberOfDimensions();
3665 for (unsigned i = 1; i < NumDims - 1; i++)
3666 if (Int[0] != Int[i] && Int[i])
3667 CanFold = false;
3668
3669 if (!CanFold) {
3670 isl_set_free(Elements);
3671 isl_map_free(Transform);
3672 continue;
3673 }
3674
Tobias Grosserbedef002016-12-02 08:10:56 +00003675 for (auto &Access : AccessFunctions)
3676 if (Access->getScopArrayInfo() == Array)
3677 Access->setAccessRelation(isl_map_apply_range(
3678 Access->getAccessRelation(), isl_map_copy(Transform)));
3679
3680 isl_map_free(Transform);
3681
3682 std::vector<const SCEV *> Sizes;
3683 for (unsigned i = 0; i < NumDims; i++) {
3684 auto Size = Array->getDimensionSize(i);
3685
3686 if (i == NumDims - 1)
3687 Size = SE->getMulExpr(Size, SE->getConstant(Size->getType(), Int[0]));
3688 Sizes.push_back(Size);
3689 }
3690
3691 Array->updateSizes(Sizes, false /* CheckConsistency */);
3692
3693 isl_set_free(Elements);
3694 }
3695 isl_union_set_free(Accessed);
3696 return;
3697}
3698
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003699void Scop::markFortranArrays() {
3700 for (ScopStmt &Stmt : Stmts) {
3701 for (MemoryAccess *MemAcc : Stmt) {
3702 Value *FAD = MemAcc->getFortranArrayDescriptor();
3703 if (!FAD)
3704 continue;
3705
3706 // TODO: const_cast-ing to edit
3707 ScopArrayInfo *SAI =
3708 const_cast<ScopArrayInfo *>(MemAcc->getLatestScopArrayInfo());
3709 assert(SAI && "memory access into a Fortran array does not "
3710 "have an associated ScopArrayInfo");
3711 SAI->applyAndSetFAD(FAD);
3712 }
3713 }
3714}
3715
Tobias Grosser491b7992016-12-02 05:21:22 +00003716void Scop::finalizeAccesses() {
3717 updateAccessDimensionality();
Tobias Grosserbedef002016-12-02 08:10:56 +00003718 foldSizeConstantsToRight();
Tobias Grosser491b7992016-12-02 05:21:22 +00003719 foldAccessRelations();
3720 assumeNoOutOfBounds();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003721 markFortranArrays();
Tobias Grosser491b7992016-12-02 05:21:22 +00003722}
3723
Tobias Grosser75805372011-04-29 06:27:02 +00003724Scop::~Scop() {
3725 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003726 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003727 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003728 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003729
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003730 for (auto &It : ParameterIds)
3731 isl_id_free(It.second);
3732
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003733 for (auto &AS : RecordedAssumptions)
3734 isl_set_free(AS.Set);
3735
Johannes Doerfertb164c792014-09-18 11:17:17 +00003736 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003737 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003738 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003739 isl_pw_multi_aff_free(MMA.first);
3740 isl_pw_multi_aff_free(MMA.second);
3741 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003742 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003743 isl_pw_multi_aff_free(MMA.first);
3744 isl_pw_multi_aff_free(MMA.second);
3745 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003746 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003747
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003748 for (const auto &IAClass : InvariantEquivClasses)
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003749 isl_set_free(IAClass.ExecutionContext);
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003750
3751 // Explicitly release all Scop objects and the underlying isl objects before
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003752 // we release the isl context.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003753 Stmts.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003754 ScopArrayInfoSet.clear();
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003755 ScopArrayInfoMap.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003756 ScopArrayNameMap.clear();
Roman Gareeve2ee79a2016-08-21 11:09:19 +00003757 AccessFunctions.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003758}
3759
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003760void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003761 // Check all array accesses for each base pointer and find a (virtual) element
3762 // size for the base pointer that divides all access functions.
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003763 for (ScopStmt &Stmt : *this)
3764 for (MemoryAccess *Access : Stmt) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003765 if (!Access->isArrayKind())
3766 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003767 ScopArrayInfo *Array =
Tobias Grossere24b7b92017-02-09 23:24:57 +00003768 const_cast<ScopArrayInfo *>(Access->getScopArrayInfo());
3769
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003770 if (Array->getNumberOfDimensions() != 1)
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003771 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003772 unsigned DivisibleSize = Array->getElemSizeInBytes();
3773 const SCEV *Subscript = Access->getSubscript(0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003774 while (!isDivisible(Subscript, DivisibleSize, *SE))
3775 DivisibleSize /= 2;
3776 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003777 Array->updateElementType(Ty);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003778 }
3779
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003780 for (auto &Stmt : *this)
3781 for (auto &Access : Stmt)
3782 Access->updateDimensionality();
3783}
3784
Tobias Grosser491b7992016-12-02 05:21:22 +00003785void Scop::foldAccessRelations() {
3786 for (auto &Stmt : *this)
3787 for (auto &Access : Stmt)
3788 Access->foldAccessRelation();
3789}
3790
3791void Scop::assumeNoOutOfBounds() {
3792 for (auto &Stmt : *this)
3793 for (auto &Access : Stmt)
3794 Access->assumeNoOutOfBound();
3795}
3796
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003797void Scop::removeFromStmtMap(ScopStmt &Stmt) {
3798 if (Stmt.isRegionStmt())
3799 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3800 StmtMap.erase(BB);
3801 else
3802 StmtMap.erase(Stmt.getBasicBlock());
3803}
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003804
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003805void Scop::removeStmts(std::function<bool(ScopStmt &)> ShouldDelete) {
3806 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3807 if (!ShouldDelete(*StmtIt)) {
3808 StmtIt++;
3809 continue;
3810 }
3811
3812 removeFromStmtMap(*StmtIt);
3813 StmtIt = Stmts.erase(StmtIt);
3814 }
3815}
3816
3817void Scop::removeStmtNotInDomainMap() {
3818 auto ShouldDelete = [this](ScopStmt &Stmt) -> bool {
Tobias Grosser199ec4a2017-07-19 16:31:10 +00003819 return !this->DomainMap.lookup(Stmt.getEntryBlock());
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003820 };
3821 removeStmts(ShouldDelete);
3822}
3823
3824void Scop::simplifySCoP(bool AfterHoisting) {
3825
3826 auto ShouldDelete = [AfterHoisting](ScopStmt &Stmt) -> bool {
Johannes Doerfert26404542016-05-10 12:19:47 +00003827 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003828
Tobias Grosser3012a0b2017-07-16 22:44:17 +00003829 // Remove read only statements only after invariant load hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003830 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003831 bool OnlyRead = true;
3832 for (MemoryAccess *MA : Stmt) {
3833 if (MA->isRead())
3834 continue;
3835
3836 OnlyRead = false;
3837 break;
3838 }
3839
3840 RemoveStmt = OnlyRead;
3841 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003842 return RemoveStmt;
3843 };
Johannes Doerferteca9e892015-11-03 16:54:49 +00003844
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003845 removeStmts(ShouldDelete);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003846}
3847
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003848InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003849 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3850 if (!LInst)
3851 return nullptr;
3852
3853 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3854 LInst = cast<LoadInst>(Rep);
3855
Johannes Doerfert96e54712016-02-07 17:30:13 +00003856 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003857 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003858 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003859 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfert549768c2016-03-24 13:22:16 +00003860 continue;
3861
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003862 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfert549768c2016-03-24 13:22:16 +00003863 for (auto *MA : MAs)
3864 if (MA->getAccessInstruction() == Val)
3865 return &IAClass;
3866 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003867
3868 return nullptr;
3869}
3870
Tobias Grosserc80d6972016-09-02 06:33:33 +00003871/// Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003872static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003873 bool MAInvalidCtxIsEmpty,
3874 bool NonHoistableCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003875 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3876 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3877 // TODO: We can provide more information for better but more expensive
3878 // results.
3879 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3880 LInst->getAlignment(), DL))
3881 return false;
3882
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003883 // If the location might be overwritten we do not hoist it unconditionally.
3884 //
3885 // TODO: This is probably to conservative.
3886 if (!NonHoistableCtxIsEmpty)
3887 return false;
3888
Michael Krusea6d48f52017-06-08 12:06:15 +00003889 // If a dereferenceable load is in a statement that is modeled precisely we
3890 // can hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003891 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003892 return true;
3893
3894 // Even if the statement is not modeled precisely we can hoist the load if it
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003895 // does not involve any parameters that might have been specialized by the
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003896 // statement domain.
3897 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3898 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3899 return false;
3900 return true;
3901}
3902
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003903void Scop::addInvariantLoads(ScopStmt &Stmt, InvariantAccessesTy &InvMAs) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003904
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003905 if (InvMAs.empty())
3906 return;
3907
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003908 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003909 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003910
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003911 // Get the context under which the statement is executed but remove the error
3912 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003913 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003914 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003915
Tobias Grosser90411a92017-02-16 19:11:33 +00003916 if (isl_set_n_basic_set(DomainCtx) >= MaxDisjunctsInDomain) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003917 auto *AccInst = InvMAs.front().MA->getAccessInstruction();
Eli Friedmane737fc12017-07-17 23:58:33 +00003918 invalidate(COMPLEXITY, AccInst->getDebugLoc(), AccInst->getParent());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003919 isl_set_free(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003920 for (auto &InvMA : InvMAs)
3921 isl_set_free(InvMA.NonHoistableCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003922 return;
3923 }
3924
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003925 // Project out all parameters that relate to loads in the statement. Otherwise
3926 // we could have cyclic dependences on the constraints under which the
3927 // hoisted loads are executed and we could not determine an order in which to
3928 // pre-load them. This happens because not only lower bounds are part of the
3929 // domain but also upper bounds.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003930 for (auto &InvMA : InvMAs) {
3931 auto *MA = InvMA.MA;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003932 Instruction *AccInst = MA->getAccessInstruction();
3933 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003934 SetVector<Value *> Values;
3935 for (const SCEV *Parameter : Parameters) {
3936 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003937 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003938 if (!Values.count(AccInst))
3939 continue;
3940
3941 if (isl_id *ParamId = getIdForParam(Parameter)) {
3942 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
Tobias Grosserb58ed8d2017-03-17 09:02:53 +00003943 if (Dim >= 0)
3944 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003945 isl_id_free(ParamId);
3946 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003947 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003948 }
3949 }
3950
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003951 for (auto &InvMA : InvMAs) {
3952 auto *MA = InvMA.MA;
3953 auto *NHCtx = InvMA.NonHoistableCtx;
3954
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003955 // Check for another invariant access that accesses the same location as
3956 // MA and if found consolidate them. Otherwise create a new equivalence
3957 // class at the end of InvariantEquivClasses.
3958 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003959 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003960 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3961
Johannes Doerfert85676e32016-04-23 14:32:34 +00003962 auto *MAInvalidCtx = MA->getInvalidContext();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003963 bool NonHoistableCtxIsEmpty = isl_set_is_empty(NHCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003964 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3965
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003966 isl_set *MACtx;
3967 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003968 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty,
3969 NonHoistableCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003970 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003971 isl_set_free(MAInvalidCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003972 isl_set_free(NHCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003973 } else {
3974 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003975 MACtx = isl_set_subtract(MACtx, isl_set_union(MAInvalidCtx, NHCtx));
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003976 MACtx = isl_set_gist_params(MACtx, getContext());
3977 }
3978
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003979 bool Consolidated = false;
3980 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003981 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003982 continue;
3983
Johannes Doerfertdf880232016-03-03 12:26:58 +00003984 // If the pointer and the type is equal check if the access function wrt.
3985 // to the domain is equal too. It can happen that the domain fixes
3986 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003987 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003988 // create a new invariant load equivalence class.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003989 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertdf880232016-03-03 12:26:58 +00003990 if (!MAs.empty()) {
3991 auto *LastMA = MAs.front();
3992
3993 auto *AR = isl_map_range(MA->getAccessRelation());
3994 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3995 bool SameAR = isl_set_is_equal(AR, LastAR);
3996 isl_set_free(AR);
3997 isl_set_free(LastAR);
3998
3999 if (!SameAR)
4000 continue;
4001 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004002
4003 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004004 MAs.push_front(MA);
4005
Johannes Doerfertdf880232016-03-03 12:26:58 +00004006 Consolidated = true;
4007
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004008 // Unify the execution context of the class and this statement.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004009 isl_set *&IAClassDomainCtx = IAClass.ExecutionContext;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00004010 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00004011 IAClassDomainCtx =
4012 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00004013 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00004014 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004015 break;
4016 }
4017
4018 if (Consolidated)
4019 continue;
4020
4021 // If we did not consolidate MA, thus did not find an equivalence class
4022 // for it, we create a new one.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004023 InvariantEquivClasses.emplace_back(
4024 InvariantEquivClassTy{PointerSCEV, MemoryAccessList{MA}, MACtx, Ty});
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004025 }
4026
4027 isl_set_free(DomainCtx);
4028}
4029
Tobias Grosser4071cb52017-06-06 23:13:02 +00004030isl::set Scop::getNonHoistableCtx(MemoryAccess *Access, isl::union_map Writes) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004031 // TODO: Loads that are not loop carried, hence are in a statement with
4032 // zero iterators, are by construction invariant, though we
4033 // currently "hoist" them anyway. This is necessary because we allow
4034 // them to be treated as parameters (e.g., in conditions) and our code
4035 // generation would otherwise use the old value.
4036
4037 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00004038 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004039
Johannes Doerfertc9765462016-11-17 22:11:56 +00004040 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine() ||
4041 Access->isMemoryIntrinsic())
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004042 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004043
4044 // Skip accesses that have an invariant base pointer which is defined but
4045 // not loaded inside the SCoP. This can happened e.g., if a readnone call
4046 // returns a pointer that is used as a base address. However, as we want
4047 // to hoist indirect pointers, we allow the base pointer to be defined in
4048 // the region if it is also a memory access. Each ScopArrayInfo object
4049 // that has a base pointer origin has a base pointer that is loaded and
4050 // that it is invariant, thus it will be hoisted too. However, if there is
4051 // no base pointer origin we check that the base pointer is defined
4052 // outside the region.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004053 auto *LI = cast<LoadInst>(Access->getAccessInstruction());
Johannes Doerfert764b7e62016-05-23 09:26:46 +00004054 if (hasNonHoistableBasePtrInScop(Access, Writes))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004055 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004056
Tobias Grosser4071cb52017-06-06 23:13:02 +00004057 isl::map AccessRelation = give(Access->getAccessRelation());
4058 assert(!AccessRelation.is_empty());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004059
Tobias Grosser4071cb52017-06-06 23:13:02 +00004060 if (AccessRelation.involves_dims(isl::dim::in, 0, Stmt.getNumIterators()))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004061 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004062
Tobias Grosser4071cb52017-06-06 23:13:02 +00004063 AccessRelation = AccessRelation.intersect_domain(give(Stmt.getDomain()));
4064 isl::set SafeToLoad;
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004065
4066 auto &DL = getFunction().getParent()->getDataLayout();
4067 if (isSafeToLoadUnconditionally(LI->getPointerOperand(), LI->getAlignment(),
4068 DL)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004069 SafeToLoad = isl::set::universe(AccessRelation.get_space().range());
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004070 } else if (BB != LI->getParent()) {
4071 // Skip accesses in non-affine subregions as they might not be executed
4072 // under the same condition as the entry of the non-affine subregion.
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004073 return nullptr;
4074 } else {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004075 SafeToLoad = AccessRelation.range();
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004076 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004077
Tobias Grosser4071cb52017-06-06 23:13:02 +00004078 isl::union_map Written = Writes.intersect_range(SafeToLoad);
4079 isl::set WrittenCtx = Written.params();
4080 bool IsWritten = !WrittenCtx.is_empty();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004081
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004082 if (!IsWritten)
4083 return WrittenCtx;
4084
Tobias Grosser4071cb52017-06-06 23:13:02 +00004085 WrittenCtx = WrittenCtx.remove_divs();
4086 bool TooComplex =
4087 isl_set_n_basic_set(WrittenCtx.get()) >= MaxDisjunctsInDomain;
4088 if (TooComplex || !isRequiredInvariantLoad(LI))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004089 return nullptr;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004090
Tobias Grosser4071cb52017-06-06 23:13:02 +00004091 addAssumption(INVARIANTLOAD, WrittenCtx.copy(), LI->getDebugLoc(),
Eli Friedmane737fc12017-07-17 23:58:33 +00004092 AS_RESTRICTION, LI->getParent());
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004093 return WrittenCtx;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004094}
4095
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004096void Scop::verifyInvariantLoads() {
4097 auto &RIL = getRequiredInvariantLoads();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004098 for (LoadInst *LI : RIL) {
Johannes Doerfert952b5302016-05-23 12:40:48 +00004099 assert(LI && contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00004100 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00004101 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004102 invalidate(INVARIANTLOAD, LI->getDebugLoc(), LI->getParent());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004103 return;
4104 }
4105 }
4106}
4107
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004108void Scop::hoistInvariantLoads() {
Tobias Grosser0865e7752016-02-29 07:29:42 +00004109 if (!PollyInvariantLoadHoisting)
4110 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004111
Tobias Grosser4071cb52017-06-06 23:13:02 +00004112 isl::union_map Writes = give(getWrites());
Tobias Grosser0865e7752016-02-29 07:29:42 +00004113 for (ScopStmt &Stmt : *this) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004114 InvariantAccessesTy InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004115
Tobias Grosser0865e7752016-02-29 07:29:42 +00004116 for (MemoryAccess *Access : Stmt)
Tobias Grosser4071cb52017-06-06 23:13:02 +00004117 if (isl::set NHCtx = getNonHoistableCtx(Access, Writes))
4118 InvariantAccesses.push_back({Access, NHCtx.release()});
Tobias Grosser0865e7752016-02-29 07:29:42 +00004119
4120 // Transfer the memory access from the statement to the SCoP.
Michael Kruse10071822016-05-23 14:45:58 +00004121 for (auto InvMA : InvariantAccesses)
4122 Stmt.removeMemoryAccess(InvMA.MA);
Tobias Grosser0865e7752016-02-29 07:29:42 +00004123 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004124 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004125}
4126
Tobias Grosserf3adab42017-05-10 10:59:58 +00004127/// Find the canonical scop array info object for a set of invariant load
4128/// hoisted loads. The canonical array is the one that corresponds to the
4129/// first load in the list of accesses which is used as base pointer of a
4130/// scop array.
4131static const ScopArrayInfo *findCanonicalArray(Scop *S,
4132 MemoryAccessList &Accesses) {
4133 for (MemoryAccess *Access : Accesses) {
4134 const ScopArrayInfo *CanonicalArray = S->getScopArrayInfoOrNull(
4135 Access->getAccessInstruction(), MemoryKind::Array);
4136 if (CanonicalArray)
4137 return CanonicalArray;
4138 }
4139 return nullptr;
4140}
4141
4142/// Check if @p Array severs as base array in an invariant load.
4143static bool isUsedForIndirectHoistedLoad(Scop *S, const ScopArrayInfo *Array) {
4144 for (InvariantEquivClassTy &EqClass2 : S->getInvariantAccesses())
4145 for (MemoryAccess *Access2 : EqClass2.InvariantAccesses)
4146 if (Access2->getScopArrayInfo() == Array)
4147 return true;
4148 return false;
4149}
4150
4151/// Replace the base pointer arrays in all memory accesses referencing @p Old,
4152/// with a reference to @p New.
4153static void replaceBasePtrArrays(Scop *S, const ScopArrayInfo *Old,
4154 const ScopArrayInfo *New) {
4155 for (ScopStmt &Stmt : *S)
4156 for (MemoryAccess *Access : Stmt) {
4157 if (Access->getLatestScopArrayInfo() != Old)
4158 continue;
4159
4160 isl_id *Id = New->getBasePtrId();
4161 isl_map *Map = Access->getAccessRelation();
4162 Map = isl_map_set_tuple_id(Map, isl_dim_out, Id);
4163 Access->setAccessRelation(Map);
4164 }
4165}
4166
4167void Scop::canonicalizeDynamicBasePtrs() {
4168 for (InvariantEquivClassTy &EqClass : InvariantEquivClasses) {
4169 MemoryAccessList &BasePtrAccesses = EqClass.InvariantAccesses;
4170
4171 const ScopArrayInfo *CanonicalBasePtrSAI =
4172 findCanonicalArray(this, BasePtrAccesses);
4173
4174 if (!CanonicalBasePtrSAI)
4175 continue;
4176
4177 for (MemoryAccess *BasePtrAccess : BasePtrAccesses) {
4178 const ScopArrayInfo *BasePtrSAI = getScopArrayInfoOrNull(
4179 BasePtrAccess->getAccessInstruction(), MemoryKind::Array);
4180 if (!BasePtrSAI || BasePtrSAI == CanonicalBasePtrSAI ||
4181 !BasePtrSAI->isCompatibleWith(CanonicalBasePtrSAI))
4182 continue;
4183
4184 // we currently do not canonicalize arrays where some accesses are
4185 // hoisted as invariant loads. If we would, we need to update the access
4186 // function of the invariant loads as well. However, as this is not a
4187 // very common situation, we leave this for now to avoid further
4188 // complexity increases.
4189 if (isUsedForIndirectHoistedLoad(this, BasePtrSAI))
4190 continue;
4191
4192 replaceBasePtrArrays(this, BasePtrSAI, CanonicalBasePtrSAI);
4193 }
4194 }
4195}
4196
Michael Kruseb738ffa2017-06-28 13:02:43 +00004197ScopArrayInfo *Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
4198 ArrayRef<const SCEV *> Sizes,
4199 MemoryKind Kind,
4200 const char *BaseName) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004201 assert((BasePtr || BaseName) &&
4202 "BasePtr and BaseName can not be nullptr at the same time.");
4203 assert(!(BasePtr && BaseName) && "BaseName is redundant.");
4204 auto &SAI = BasePtr ? ScopArrayInfoMap[std::make_pair(BasePtr, Kind)]
4205 : ScopArrayNameMap[BaseName];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004206 if (!SAI) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004207 auto &DL = getFunction().getParent()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00004208 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +00004209 DL, this, BaseName));
4210 ScopArrayInfoSet.insert(SAI.get());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004211 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004212 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00004213 // In case of mismatching array sizes, we bail out by setting the run-time
4214 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004215 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004216 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004217 }
Tobias Grosserab671442015-05-23 05:58:27 +00004218 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004219}
4220
Michael Kruseb738ffa2017-06-28 13:02:43 +00004221ScopArrayInfo *Scop::createScopArrayInfo(Type *ElementType,
4222 const std::string &BaseName,
4223 const std::vector<unsigned> &Sizes) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004224 auto *DimSizeType = Type::getInt64Ty(getSE()->getContext());
4225 std::vector<const SCEV *> SCEVSizes;
4226
4227 for (auto size : Sizes)
Roman Gareevf5aff702016-09-12 17:08:31 +00004228 if (size)
4229 SCEVSizes.push_back(getSE()->getConstant(DimSizeType, size, false));
4230 else
4231 SCEVSizes.push_back(nullptr);
Roman Gareevd7754a12016-07-30 09:25:51 +00004232
Tobias Grosser4d5a9172017-01-14 20:25:44 +00004233 auto *SAI = getOrCreateScopArrayInfo(nullptr, ElementType, SCEVSizes,
4234 MemoryKind::Array, BaseName.c_str());
Roman Gareevd7754a12016-07-30 09:25:51 +00004235 return SAI;
4236}
4237
Tobias Grosserf3adab42017-05-10 10:59:58 +00004238const ScopArrayInfo *Scop::getScopArrayInfoOrNull(Value *BasePtr,
4239 MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00004240 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004241 return SAI;
4242}
4243
4244const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, MemoryKind Kind) {
4245 auto *SAI = getScopArrayInfoOrNull(BasePtr, Kind);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004246 assert(SAI && "No ScopArrayInfo available for this base pointer");
4247 return SAI;
4248}
4249
Tobias Grosser74394f02013-01-14 22:40:23 +00004250std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004251
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004252std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004253 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004254 return stringFromIslObj(AssumedContext);
4255}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004256
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004257std::string Scop::getInvalidContextStr() const {
4258 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004259}
Tobias Grosser75805372011-04-29 06:27:02 +00004260
4261std::string Scop::getNameStr() const {
4262 std::string ExitName, EntryName;
Siddharth Bhat07bee292017-06-02 08:01:22 +00004263 std::tie(EntryName, ExitName) = getEntryExitStr();
4264 return EntryName + "---" + ExitName;
4265}
4266
4267std::pair<std::string, std::string> Scop::getEntryExitStr() const {
4268 std::string ExitName, EntryName;
Tobias Grosser75805372011-04-29 06:27:02 +00004269 raw_string_ostream ExitStr(ExitName);
4270 raw_string_ostream EntryStr(EntryName);
4271
Tobias Grosserf240b482014-01-09 10:42:15 +00004272 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004273 EntryStr.str();
4274
4275 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00004276 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004277 ExitStr.str();
4278 } else
4279 ExitName = "FunctionExit";
4280
Siddharth Bhat07bee292017-06-02 08:01:22 +00004281 return std::make_pair(EntryName, ExitName);
Tobias Grosser75805372011-04-29 06:27:02 +00004282}
4283
Tobias Grosser74394f02013-01-14 22:40:23 +00004284__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00004285__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00004286 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00004287}
4288
Tobias Grossere86109f2013-10-29 21:05:49 +00004289__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004290 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00004291 return isl_set_copy(AssumedContext);
4292}
4293
Michael Krusef3091bf2017-03-17 13:09:52 +00004294bool Scop::isProfitable(bool ScalarsAreUnprofitable) const {
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004295 if (PollyProcessUnprofitable)
4296 return true;
4297
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004298 if (isEmpty())
4299 return false;
4300
4301 unsigned OptimizableStmtsOrLoops = 0;
4302 for (auto &Stmt : *this) {
4303 if (Stmt.getNumIterators() == 0)
4304 continue;
4305
4306 bool ContainsArrayAccs = false;
4307 bool ContainsScalarAccs = false;
4308 for (auto *MA : Stmt) {
4309 if (MA->isRead())
4310 continue;
Michael Krusef3091bf2017-03-17 13:09:52 +00004311 ContainsArrayAccs |= MA->isLatestArrayKind();
4312 ContainsScalarAccs |= MA->isLatestScalarKind();
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004313 }
4314
Michael Krusef3091bf2017-03-17 13:09:52 +00004315 if (!ScalarsAreUnprofitable || (ContainsArrayAccs && !ContainsScalarAccs))
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004316 OptimizableStmtsOrLoops += Stmt.getNumIterators();
4317 }
4318
4319 return OptimizableStmtsOrLoops > 1;
4320}
4321
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00004322bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004323 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004324 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00004325 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
4326 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
4327 isl_set_is_subset(PositiveContext, NegativeContext));
4328 isl_set_free(PositiveContext);
4329 if (!IsFeasible) {
4330 isl_set_free(NegativeContext);
4331 return false;
4332 }
4333
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004334 auto *DomainContext = isl_union_set_params(getDomains());
4335 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00004336 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004337 isl_set_free(NegativeContext);
4338 isl_set_free(DomainContext);
4339
Johannes Doerfert43788c52015-08-20 05:58:56 +00004340 return IsFeasible;
4341}
4342
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004343static std::string toString(AssumptionKind Kind) {
4344 switch (Kind) {
4345 case ALIASING:
4346 return "No-aliasing";
4347 case INBOUNDS:
4348 return "Inbounds";
4349 case WRAPPING:
4350 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00004351 case UNSIGNED:
4352 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004353 case COMPLEXITY:
4354 return "Low complexity";
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004355 case PROFITABLE:
4356 return "Profitable";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004357 case ERRORBLOCK:
4358 return "No-error";
4359 case INFINITELOOP:
4360 return "Finite loop";
4361 case INVARIANTLOAD:
4362 return "Invariant load";
4363 case DELINEARIZATION:
4364 return "Delinearization";
4365 }
4366 llvm_unreachable("Unknown AssumptionKind!");
4367}
4368
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004369bool Scop::isEffectiveAssumption(__isl_keep isl_set *Set, AssumptionSign Sign) {
4370 if (Sign == AS_ASSUMPTION) {
4371 if (isl_set_is_subset(Context, Set))
4372 return false;
4373
4374 if (isl_set_is_subset(AssumedContext, Set))
4375 return false;
4376 } else {
4377 if (isl_set_is_disjoint(Set, Context))
4378 return false;
4379
4380 if (isl_set_is_subset(Set, InvalidContext))
4381 return false;
4382 }
4383 return true;
4384}
4385
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004386bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
Eli Friedmane737fc12017-07-17 23:58:33 +00004387 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004388 if (PollyRemarksMinimal && !isEffectiveAssumption(Set, Sign))
4389 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004390
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004391 // Do never emit trivial assumptions as they only clutter the output.
4392 if (!PollyRemarksMinimal) {
4393 isl_set *Univ = nullptr;
4394 if (Sign == AS_ASSUMPTION)
4395 Univ = isl_set_universe(isl_set_get_space(Set));
4396
4397 bool IsTrivial = (Sign == AS_RESTRICTION && isl_set_is_empty(Set)) ||
4398 (Sign == AS_ASSUMPTION && isl_set_is_equal(Univ, Set));
4399 isl_set_free(Univ);
4400
4401 if (IsTrivial)
4402 return false;
4403 }
4404
Johannes Doerfertcd195322016-11-17 21:41:08 +00004405 switch (Kind) {
4406 case ALIASING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004407 AssumptionsAliasing++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004408 break;
4409 case INBOUNDS:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004410 AssumptionsInbounds++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004411 break;
4412 case WRAPPING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004413 AssumptionsWrapping++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004414 break;
4415 case UNSIGNED:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004416 AssumptionsUnsigned++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004417 break;
4418 case COMPLEXITY:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004419 AssumptionsComplexity++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004420 break;
4421 case PROFITABLE:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004422 AssumptionsUnprofitable++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004423 break;
4424 case ERRORBLOCK:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004425 AssumptionsErrorBlock++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004426 break;
4427 case INFINITELOOP:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004428 AssumptionsInfiniteLoop++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004429 break;
4430 case INVARIANTLOAD:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004431 AssumptionsInvariantLoad++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004432 break;
4433 case DELINEARIZATION:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004434 AssumptionsDelinearization++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004435 break;
4436 }
4437
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004438 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
4439 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Eli Friedmane737fc12017-07-17 23:58:33 +00004440 if (BB)
4441 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc, BB)
4442 << Msg);
4443 else
4444 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc,
4445 R.getEntry())
4446 << Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004447 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004448}
4449
4450void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Eli Friedmane737fc12017-07-17 23:58:33 +00004451 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004452 // Simplify the assumptions/restrictions first.
4453 Set = isl_set_gist_params(Set, getContext());
4454
Eli Friedmane737fc12017-07-17 23:58:33 +00004455 if (!trackAssumption(Kind, Set, Loc, Sign, BB)) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004456 isl_set_free(Set);
4457 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00004458 }
4459
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004460 if (Sign == AS_ASSUMPTION) {
4461 AssumedContext = isl_set_intersect(AssumedContext, Set);
4462 AssumedContext = isl_set_coalesce(AssumedContext);
4463 } else {
4464 InvalidContext = isl_set_union(InvalidContext, Set);
4465 InvalidContext = isl_set_coalesce(InvalidContext);
4466 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004467}
4468
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004469void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004470 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Tobias Grosserf67433a2016-11-10 11:44:10 +00004471 assert((isl_set_is_params(Set) || BB) &&
4472 "Assumptions without a basic block must be parameter sets");
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004473 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004474}
4475
4476void Scop::addRecordedAssumptions() {
4477 while (!RecordedAssumptions.empty()) {
4478 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004479
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004480 if (!AS.BB) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004481 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign, nullptr /* BasicBlock */);
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004482 continue;
4483 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004484
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004485 // If the domain was deleted the assumptions are void.
4486 isl_set *Dom = getDomainConditions(AS.BB);
4487 if (!Dom) {
4488 isl_set_free(AS.Set);
4489 continue;
4490 }
4491
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004492 // If a basic block was given use its domain to simplify the assumption.
4493 // In case of restrictions we know they only have to hold on the domain,
4494 // thus we can intersect them with the domain of the block. However, for
4495 // assumptions the domain has to imply them, thus:
4496 // _ _____
4497 // Dom => S <==> A v B <==> A - B
4498 //
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004499 // To avoid the complement we will register A - B as a restriction not an
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004500 // assumption.
4501 isl_set *S = AS.Set;
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004502 if (AS.Sign == AS_RESTRICTION)
4503 S = isl_set_params(isl_set_intersect(S, Dom));
4504 else /* (AS.Sign == AS_ASSUMPTION) */
4505 S = isl_set_params(isl_set_subtract(Dom, S));
4506
Eli Friedmane737fc12017-07-17 23:58:33 +00004507 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION, AS.BB);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004508 }
4509}
4510
Eli Friedmane737fc12017-07-17 23:58:33 +00004511void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc, BasicBlock *BB) {
4512 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION, BB);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004513}
4514
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004515__isl_give isl_set *Scop::getInvalidContext() const {
4516 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004517}
4518
Tobias Grosser75805372011-04-29 06:27:02 +00004519void Scop::printContext(raw_ostream &OS) const {
4520 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004521 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00004522
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004523 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004524 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004525
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004526 OS.indent(4) << "Invalid Context:\n";
4527 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004528
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00004529 unsigned Dim = 0;
4530 for (const SCEV *Parameter : Parameters)
4531 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004532}
4533
Johannes Doerfertb164c792014-09-18 11:17:17 +00004534void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004535 int noOfGroups = 0;
4536 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004537 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004538 noOfGroups += 1;
4539 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004540 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004541 }
4542
Tobias Grosserbb853c22015-07-25 12:31:03 +00004543 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00004544 if (MinMaxAliasGroups.empty()) {
4545 OS.indent(8) << "n/a\n";
4546 return;
4547 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004548
Tobias Grosserbb853c22015-07-25 12:31:03 +00004549 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004550
4551 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004552 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004553 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004554 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004555 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4556 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004557 }
4558 OS << " ]]\n";
4559 }
4560
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004561 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004562 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00004563 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004564 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004565 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4566 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004567 }
4568 OS << " ]]\n";
4569 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00004570 }
4571}
4572
Tobias Grosser75805372011-04-29 06:27:02 +00004573void Scop::printStatements(raw_ostream &OS) const {
4574 OS << "Statements {\n";
4575
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004576 for (const ScopStmt &Stmt : *this)
4577 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00004578
4579 OS.indent(4) << "}\n";
4580}
4581
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004582void Scop::printArrayInfo(raw_ostream &OS) const {
4583 OS << "Arrays {\n";
4584
Tobias Grosserab671442015-05-23 05:58:27 +00004585 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004586 Array->print(OS);
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004587
4588 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004589
4590 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
4591
4592 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004593 Array->print(OS, /* SizeAsPwAff */ true);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004594
4595 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004596}
4597
Tobias Grosser75805372011-04-29 06:27:02 +00004598void Scop::print(raw_ostream &OS) const {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004599 OS.indent(4) << "Function: " << getFunction().getName() << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00004600 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00004601 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004602 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004603 for (const auto &IAClass : InvariantEquivClasses) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004604 const auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004605 if (MAs.empty()) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004606 OS.indent(12) << "Class Pointer: " << *IAClass.IdentifyingPointer << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004607 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004608 MAs.front()->print(OS);
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004609 OS.indent(12) << "Execution Context: " << IAClass.ExecutionContext
4610 << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004611 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004612 }
4613 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004614 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004615 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00004616 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00004617 printStatements(OS.indent(4));
4618}
4619
4620void Scop::dump() const { print(dbgs()); }
4621
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004622isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00004623
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004624__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
4625 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004626 // First try to use the SCEVAffinator to generate a piecewise defined
4627 // affine function from @p E in the context of @p BB. If that tasks becomes to
4628 // complex the affinator might return a nullptr. In such a case we invalidate
4629 // the SCoP and return a dummy value. This way we do not need to add error
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004630 // handling code to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004631 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004632 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00004633 // TODO: We could use a heuristic and either use:
4634 // SCEVAffinator::takeNonNegativeAssumption
4635 // or
4636 // SCEVAffinator::interpretAsUnsigned
4637 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004638 if (NonNegative)
4639 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004640 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004641 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004642
4643 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
Eli Friedmane737fc12017-07-17 23:58:33 +00004644 invalidate(COMPLEXITY, DL, BB);
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004645 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00004646}
4647
Tobias Grosser808cd692015-07-14 09:33:13 +00004648__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosser941cb7d2017-03-17 09:02:50 +00004649 isl_space *EmptySpace = isl_space_params_alloc(getIslCtx(), 0);
4650 isl_union_set *Domain = isl_union_set_empty(EmptySpace);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004651
Tobias Grosser808cd692015-07-14 09:33:13 +00004652 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004653 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004654
4655 return Domain;
4656}
4657
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004658__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
4659 PWACtx PWAC = getPwAff(E, BB);
4660 isl_set_free(PWAC.second);
4661 return PWAC.first;
4662}
4663
Tobias Grossere5a35142015-11-12 14:07:09 +00004664__isl_give isl_union_map *
4665Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
4666 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004667
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004668 for (ScopStmt &Stmt : *this) {
4669 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00004670 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004671 continue;
4672
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004673 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004674 isl_map *AccessDomain = MA->getAccessRelation();
4675 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00004676 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004677 }
4678 }
Tobias Grossere5a35142015-11-12 14:07:09 +00004679 return isl_union_map_coalesce(Accesses);
4680}
4681
4682__isl_give isl_union_map *Scop::getMustWrites() {
4683 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004684}
4685
4686__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004687 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004688}
4689
Tobias Grosser37eb4222014-02-20 21:43:54 +00004690__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004691 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004692}
4693
4694__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004695 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004696}
4697
Tobias Grosser2ac23382015-11-12 14:07:13 +00004698__isl_give isl_union_map *Scop::getAccesses() {
4699 return getAccessesOfType([](MemoryAccess &MA) { return true; });
4700}
4701
Roman Gareevb3224ad2016-09-14 06:26:09 +00004702// Check whether @p Node is an extension node.
4703//
4704// @return true if @p Node is an extension node.
4705isl_bool isNotExtNode(__isl_keep isl_schedule_node *Node, void *User) {
4706 if (isl_schedule_node_get_type(Node) == isl_schedule_node_extension)
4707 return isl_bool_error;
4708 else
4709 return isl_bool_true;
4710}
4711
4712bool Scop::containsExtensionNode(__isl_keep isl_schedule *Schedule) {
4713 return isl_schedule_foreach_schedule_node_top_down(Schedule, isNotExtNode,
4714 nullptr) == isl_stat_error;
4715}
4716
Tobias Grosser808cd692015-07-14 09:33:13 +00004717__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004718 auto *Tree = getScheduleTree();
Roman Gareevb3224ad2016-09-14 06:26:09 +00004719 if (containsExtensionNode(Tree)) {
4720 isl_schedule_free(Tree);
4721 return nullptr;
4722 }
Johannes Doerferta90943d2016-02-21 16:37:25 +00004723 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00004724 isl_schedule_free(Tree);
4725 return S;
4726}
Tobias Grosser37eb4222014-02-20 21:43:54 +00004727
Tobias Grosser808cd692015-07-14 09:33:13 +00004728__isl_give isl_schedule *Scop::getScheduleTree() const {
4729 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
4730 getDomains());
4731}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00004732
Tobias Grosser808cd692015-07-14 09:33:13 +00004733void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
4734 auto *S = isl_schedule_from_domain(getDomains());
4735 S = isl_schedule_insert_partial_schedule(
4736 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
4737 isl_schedule_free(Schedule);
4738 Schedule = S;
4739}
4740
4741void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
4742 isl_schedule_free(Schedule);
4743 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004744}
4745
4746bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
4747 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004748 for (ScopStmt &Stmt : *this) {
4749 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00004750 isl_union_set *NewStmtDomain = isl_union_set_intersect(
4751 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
4752
4753 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
4754 isl_union_set_free(StmtDomain);
4755 isl_union_set_free(NewStmtDomain);
4756 continue;
4757 }
4758
4759 Changed = true;
4760
4761 isl_union_set_free(StmtDomain);
4762 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
4763
4764 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004765 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004766 isl_union_set_free(NewStmtDomain);
4767 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004768 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004769 }
4770 isl_union_set_free(Domain);
4771 return Changed;
4772}
4773
Tobias Grosser75805372011-04-29 06:27:02 +00004774ScalarEvolution *Scop::getSE() const { return SE; }
4775
Tobias Grosserc80d6972016-09-02 06:33:33 +00004776// Create an isl_multi_union_aff that defines an identity mapping from the
4777// elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00004778//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004779// # Example:
4780//
4781// Domain: { A[i,j]; B[i,j,k] }
4782// N: 1
4783//
4784// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
4785//
4786// @param USet A union set describing the elements for which to generate a
4787// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00004788// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004789// @returns A mapping from USet to its N-th dimension.
Tobias Grosser99320862017-05-26 17:22:03 +00004790static isl::multi_union_pw_aff mapToDimension(isl::union_set USet, int N) {
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004791 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00004792 assert(USet);
Siddharth Bhat8bb436e2017-05-29 11:34:29 +00004793 assert(!USet.is_empty());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004794
Tobias Grosser99320862017-05-26 17:22:03 +00004795 auto Result = isl::union_pw_multi_aff::empty(USet.get_space());
Tobias Grosser808cd692015-07-14 09:33:13 +00004796
Tobias Grosser99320862017-05-26 17:22:03 +00004797 auto Lambda = [&Result, N](isl::set S) -> isl::stat {
4798 int Dim = S.dim(isl::dim::set);
4799 auto PMA = isl::pw_multi_aff::project_out_map(S.get_space(), isl::dim::set,
4800 N, Dim - N);
4801 if (N > 1)
4802 PMA = PMA.drop_dims(isl::dim::out, 0, N - 1);
Tobias Grosser808cd692015-07-14 09:33:13 +00004803
Tobias Grosser99320862017-05-26 17:22:03 +00004804 Result = Result.add_pw_multi_aff(PMA);
4805 return isl::stat::ok;
4806 };
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004807
Tobias Grosser99320862017-05-26 17:22:03 +00004808 isl::stat Res = USet.foreach_set(Lambda);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004809 (void)Res;
4810
Tobias Grosser99320862017-05-26 17:22:03 +00004811 assert(Res == isl::stat::ok);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004812
Tobias Grosser99320862017-05-26 17:22:03 +00004813 return isl::multi_union_pw_aff(isl::union_pw_multi_aff(Result));
Tobias Grosser808cd692015-07-14 09:33:13 +00004814}
4815
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004816void Scop::addScopStmt(BasicBlock *BB, Loop *SurroundingLoop,
4817 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004818 assert(BB && "Unexpected nullptr!");
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004819 Stmts.emplace_back(*this, *BB, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004820 auto *Stmt = &Stmts.back();
Michael Kruse4dfa7322017-07-18 15:41:49 +00004821 StmtMap[BB].push_back(Stmt);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004822}
4823
Michael Kruse55454072017-03-15 22:16:43 +00004824void Scop::addScopStmt(Region *R, Loop *SurroundingLoop) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004825 assert(R && "Unexpected nullptr!");
Michael Kruse55454072017-03-15 22:16:43 +00004826 Stmts.emplace_back(*this, *R, SurroundingLoop);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004827 auto *Stmt = &Stmts.back();
4828 for (BasicBlock *BB : R->blocks())
Michael Kruse4dfa7322017-07-18 15:41:49 +00004829 StmtMap[BB].push_back(Stmt);
Tobias Grosser808cd692015-07-14 09:33:13 +00004830}
4831
Roman Gareevb3224ad2016-09-14 06:26:09 +00004832ScopStmt *Scop::addScopStmt(__isl_take isl_map *SourceRel,
4833 __isl_take isl_map *TargetRel,
4834 __isl_take isl_set *Domain) {
Tobias Grossereba86a12016-11-09 04:24:49 +00004835#ifndef NDEBUG
Tobias Grosser744740a2016-11-05 21:02:43 +00004836 isl_set *SourceDomain = isl_map_domain(isl_map_copy(SourceRel));
4837 isl_set *TargetDomain = isl_map_domain(isl_map_copy(TargetRel));
4838 assert(isl_set_is_subset(Domain, TargetDomain) &&
4839 "Target access not defined for complete statement domain");
4840 assert(isl_set_is_subset(Domain, SourceDomain) &&
4841 "Source access not defined for complete statement domain");
4842 isl_set_free(SourceDomain);
4843 isl_set_free(TargetDomain);
Tobias Grossereba86a12016-11-09 04:24:49 +00004844#endif
Roman Gareevb3224ad2016-09-14 06:26:09 +00004845 Stmts.emplace_back(*this, SourceRel, TargetRel, Domain);
4846 CopyStmtsNum++;
4847 return &(Stmts.back());
4848}
4849
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004850void Scop::buildSchedule(LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004851 Loop *L = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004852 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004853 buildSchedule(getRegion().getNode(), LoopStack, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004854 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4855 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004856}
4857
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004858/// To generate a schedule for the elements in a Region we traverse the Region
4859/// in reverse-post-order and add the contained RegionNodes in traversal order
4860/// to the schedule of the loop that is currently at the top of the LoopStack.
4861/// For loop-free codes, this results in a correct sequential ordering.
4862///
4863/// Example:
4864/// bb1(0)
4865/// / \.
4866/// bb2(1) bb3(2)
4867/// \ / \.
4868/// bb4(3) bb5(4)
4869/// \ /
4870/// bb6(5)
4871///
4872/// Including loops requires additional processing. Whenever a loop header is
4873/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4874/// from an empty schedule, we first process all RegionNodes that are within
4875/// this loop and complete the sequential schedule at this loop-level before
4876/// processing about any other nodes. To implement this
4877/// loop-nodes-first-processing, the reverse post-order traversal is
4878/// insufficient. Hence, we additionally check if the traversal yields
4879/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4880/// These region-nodes are then queue and only traverse after the all nodes
4881/// within the current loop have been processed.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004882void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004883 Loop *OuterScopLoop = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004884
4885 ReversePostOrderTraversal<Region *> RTraversal(R);
4886 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4887 std::deque<RegionNode *> DelayList;
4888 bool LastRNWaiting = false;
4889
4890 // Iterate over the region @p R in reverse post-order but queue
4891 // sub-regions/blocks iff they are not part of the last encountered but not
4892 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4893 // that we queued the last sub-region/block from the reverse post-order
4894 // iterator. If it is set we have to explore the next sub-region/block from
4895 // the iterator (if any) to guarantee progress. If it is not set we first try
4896 // the next queued sub-region/blocks.
4897 while (!WorkList.empty() || !DelayList.empty()) {
4898 RegionNode *RN;
4899
4900 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4901 RN = WorkList.front();
4902 WorkList.pop_front();
4903 LastRNWaiting = false;
4904 } else {
4905 RN = DelayList.front();
4906 DelayList.pop_front();
4907 }
4908
4909 Loop *L = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00004910 if (!contains(L))
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004911 L = OuterScopLoop;
4912
Tobias Grosser151ae322016-04-03 19:36:52 +00004913 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004914 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004915 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004916 LastRNWaiting = true;
4917 DelayList.push_back(RN);
4918 continue;
4919 }
4920 LoopStack.push_back({L, nullptr, 0});
4921 }
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004922 buildSchedule(RN, LoopStack, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004923 }
4924
4925 return;
4926}
4927
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004928void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004929
Tobias Grosser8362c262016-01-06 15:30:06 +00004930 if (RN->isSubRegion()) {
4931 auto *LocalRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004932 if (!isNonAffineSubRegion(LocalRegion)) {
4933 buildSchedule(LocalRegion, LoopStack, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004934 return;
4935 }
4936 }
Michael Kruse046dde42015-08-10 13:01:57 +00004937
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004938 auto &LoopData = LoopStack.back();
4939 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004940
Michael Kruse6f7721f2016-02-24 22:08:19 +00004941 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004942 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4943 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004944 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004945 }
4946
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004947 // Check if we just processed the last node in this loop. If we did, finalize
4948 // the loop by:
4949 //
4950 // - adding new schedule dimensions
4951 // - folding the resulting schedule into the parent loop schedule
4952 // - dropping the loop schedule from the LoopStack.
4953 //
4954 // Then continue to check surrounding loops, which might also have been
4955 // completed by this node.
4956 while (LoopData.L &&
Tobias Grosserce69e7b2017-03-07 16:17:55 +00004957 LoopData.NumBlocksProcessed == getNumBlocksInLoop(LoopData.L)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004958 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004959 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004960
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004961 LoopStack.pop_back();
4962 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004963
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004964 if (Schedule) {
Tobias Grosser99320862017-05-26 17:22:03 +00004965 isl::union_set Domain = give(isl_schedule_get_domain(Schedule));
4966 isl::multi_union_pw_aff MUPA = mapToDimension(Domain, LoopStack.size());
4967 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA.release());
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004968 NextLoopData.Schedule =
4969 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004970 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004971
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004972 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4973 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004974 }
Tobias Grosser75805372011-04-29 06:27:02 +00004975}
4976
Michael Kruse6f7721f2016-02-24 22:08:19 +00004977ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004978 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004979 if (StmtMapIt == StmtMap.end())
4980 return nullptr;
Michael Kruse4dfa7322017-07-18 15:41:49 +00004981 assert(StmtMapIt->second.size() == 1);
4982 return StmtMapIt->second.front();
Johannes Doerfert7c494212014-10-31 23:13:39 +00004983}
4984
Michael Kruse6f7721f2016-02-24 22:08:19 +00004985ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4986 if (RN->isSubRegion())
4987 return getStmtFor(RN->getNodeAs<Region>());
4988 return getStmtFor(RN->getNodeAs<BasicBlock>());
4989}
4990
4991ScopStmt *Scop::getStmtFor(Region *R) const {
4992 ScopStmt *Stmt = getStmtFor(R->getEntry());
4993 assert(!Stmt || Stmt->getRegion() == R);
4994 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004995}
4996
Johannes Doerfert96425c22015-08-30 21:13:53 +00004997int Scop::getRelativeLoopDepth(const Loop *L) const {
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00004998 if (!L || !R.contains(L))
Johannes Doerfert96425c22015-08-30 21:13:53 +00004999 return -1;
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00005000 // outermostLoopInRegion always returns nullptr for top level regions
5001 if (R.isTopLevelRegion()) {
5002 // LoopInfo's depths start at 1, we start at 0
5003 return L->getLoopDepth() - 1;
5004 } else {
5005 Loop *OuterLoop = R.outermostLoopInRegion(const_cast<Loop *>(L));
5006 assert(OuterLoop);
5007 return L->getLoopDepth() - OuterLoop->getLoopDepth();
5008 }
Johannes Doerfertd020b772015-08-27 06:53:52 +00005009}
5010
Roman Gareevd7754a12016-07-30 09:25:51 +00005011ScopArrayInfo *Scop::getArrayInfoByName(const std::string BaseName) {
5012 for (auto &SAI : arrays()) {
5013 if (SAI->getName() == BaseName)
5014 return SAI;
5015 }
5016 return nullptr;
5017}
5018
Michael Kruse8b805802017-07-19 17:11:25 +00005019void Scop::addAccessData(MemoryAccess *Access) {
5020 const ScopArrayInfo *SAI = Access->getOriginalScopArrayInfo();
5021 assert(SAI && "can only use after access relations have been constructed");
5022
5023 if (Access->isOriginalValueKind() && Access->isRead())
5024 ValueUseAccs[SAI].push_back(Access);
5025 else if (Access->isOriginalAnyPHIKind() && Access->isWrite())
5026 PHIIncomingAccs[SAI].push_back(Access);
5027}
5028
5029void Scop::removeAccessData(MemoryAccess *Access) {
5030 if (Access->isOriginalValueKind() && Access->isRead()) {
5031 auto &Uses = ValueUseAccs[Access->getScopArrayInfo()];
5032 std::remove(Uses.begin(), Uses.end(), Access);
5033 } else if (Access->isOriginalAnyPHIKind() && Access->isWrite()) {
5034 auto &Incomings = PHIIncomingAccs[Access->getScopArrayInfo()];
5035 std::remove(Incomings.begin(), Incomings.end(), Access);
5036 }
5037}
5038
5039MemoryAccess *Scop::getValueDef(const ScopArrayInfo *SAI) const {
5040 assert(SAI->isValueKind());
5041
5042 Instruction *Val = dyn_cast<Instruction>(SAI->getBasePtr());
5043 if (!Val)
5044 return nullptr;
5045
5046 ScopStmt *Stmt = getStmtFor(Val);
5047 if (!Stmt)
5048 return nullptr;
5049
5050 return Stmt->lookupValueWriteOf(Val);
5051}
5052
5053ArrayRef<MemoryAccess *> Scop::getValueUses(const ScopArrayInfo *SAI) const {
5054 assert(SAI->isValueKind());
5055 auto It = ValueUseAccs.find(SAI);
5056 if (It == ValueUseAccs.end())
5057 return {};
5058 return It->second;
5059}
5060
5061MemoryAccess *Scop::getPHIRead(const ScopArrayInfo *SAI) const {
5062 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
5063
5064 if (SAI->isExitPHIKind())
5065 return nullptr;
5066
5067 PHINode *PHI = cast<PHINode>(SAI->getBasePtr());
5068 ScopStmt *Stmt = getStmtFor(PHI);
5069 assert(Stmt && "PHINode must be within the SCoP");
5070
5071 return Stmt->lookupPHIReadOf(PHI);
5072}
5073
5074ArrayRef<MemoryAccess *> Scop::getPHIIncomings(const ScopArrayInfo *SAI) const {
5075 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
5076 auto It = PHIIncomingAccs.find(SAI);
5077 if (It == PHIIncomingAccs.end())
5078 return {};
5079 return It->second;
5080}
5081
Johannes Doerfert99191c72016-05-31 09:41:04 +00005082//===----------------------------------------------------------------------===//
5083void ScopInfoRegionPass::getAnalysisUsage(AnalysisUsage &AU) const {
5084 AU.addRequired<LoopInfoWrapperPass>();
5085 AU.addRequired<RegionInfoPass>();
5086 AU.addRequired<DominatorTreeWrapperPass>();
5087 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005088 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005089 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005090 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005091 AU.setPreservesAll();
5092}
5093
Tobias Grossercd01a362017-02-17 08:12:36 +00005094void updateLoopCountStatistic(ScopDetection::LoopStats Stats) {
5095 NumLoopsInScop += Stats.NumLoops;
5096 MaxNumLoopsInScop =
5097 std::max(MaxNumLoopsInScop.getValue(), (unsigned)Stats.NumLoops);
5098
Tobias Grossercd01a362017-02-17 08:12:36 +00005099 if (Stats.MaxDepth == 1)
5100 NumScopsDepthOne++;
5101 else if (Stats.MaxDepth == 2)
5102 NumScopsDepthTwo++;
5103 else if (Stats.MaxDepth == 3)
5104 NumScopsDepthThree++;
5105 else if (Stats.MaxDepth == 4)
5106 NumScopsDepthFour++;
5107 else if (Stats.MaxDepth == 5)
5108 NumScopsDepthFive++;
5109 else
5110 NumScopsDepthLarger++;
5111}
5112
Johannes Doerfert99191c72016-05-31 09:41:04 +00005113bool ScopInfoRegionPass::runOnRegion(Region *R, RGPassManager &RGM) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005114 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005115
5116 if (!SD.isMaxRegionInScop(*R))
5117 return false;
5118
5119 Function *F = R->getEntry()->getParent();
5120 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5121 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5122 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5123 auto const &DL = F->getParent()->getDataLayout();
5124 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005125 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005126
Michael Kruse89b1f942017-03-17 13:56:53 +00005127 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005128 S = SB.getScop(); // take ownership of scop object
Tobias Grossercd01a362017-02-17 08:12:36 +00005129
5130 if (S) {
5131 ScopDetection::LoopStats Stats =
5132 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
5133 updateLoopCountStatistic(Stats);
5134 }
5135
Tobias Grosser75805372011-04-29 06:27:02 +00005136 return false;
5137}
5138
Johannes Doerfert99191c72016-05-31 09:41:04 +00005139void ScopInfoRegionPass::print(raw_ostream &OS, const Module *) const {
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005140 if (S)
5141 S->print(OS);
5142 else
5143 OS << "Invalid Scop!\n";
Johannes Doerfert99191c72016-05-31 09:41:04 +00005144}
Tobias Grosser75805372011-04-29 06:27:02 +00005145
Johannes Doerfert99191c72016-05-31 09:41:04 +00005146char ScopInfoRegionPass::ID = 0;
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005147
Johannes Doerfert99191c72016-05-31 09:41:04 +00005148Pass *polly::createScopInfoRegionPassPass() { return new ScopInfoRegionPass(); }
5149
5150INITIALIZE_PASS_BEGIN(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005151 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005152 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00005153INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005154INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00005155INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00005156INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00005157INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005158INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert96425c22015-08-30 21:13:53 +00005159INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005160INITIALIZE_PASS_END(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005161 "Polly - Create polyhedral description of Scops", false,
5162 false)
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005163
5164//===----------------------------------------------------------------------===//
Philip Pfaffe838e0882017-05-15 12:55:14 +00005165ScopInfo::ScopInfo(const DataLayout &DL, ScopDetection &SD, ScalarEvolution &SE,
5166 LoopInfo &LI, AliasAnalysis &AA, DominatorTree &DT,
5167 AssumptionCache &AC) {
Michael Krusea6d48f52017-06-08 12:06:15 +00005168 /// Create polyhedral description of scops for all the valid regions of a
Philip Pfaffe838e0882017-05-15 12:55:14 +00005169 /// function.
5170 for (auto &It : SD) {
5171 Region *R = const_cast<Region *>(It);
5172 if (!SD.isMaxRegionInScop(*R))
5173 continue;
5174
5175 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
5176 std::unique_ptr<Scop> S = SB.getScop();
5177 if (!S)
5178 continue;
5179 bool Inserted = RegionToScopMap.insert({R, std::move(S)}).second;
5180 assert(Inserted && "Building Scop for the same region twice!");
5181 (void)Inserted;
5182 }
5183}
5184
5185AnalysisKey ScopInfoAnalysis::Key;
5186
5187ScopInfoAnalysis::Result ScopInfoAnalysis::run(Function &F,
5188 FunctionAnalysisManager &FAM) {
5189 auto &SD = FAM.getResult<ScopAnalysis>(F);
5190 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
5191 auto &LI = FAM.getResult<LoopAnalysis>(F);
5192 auto &AA = FAM.getResult<AAManager>(F);
5193 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
5194 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
5195 auto &DL = F.getParent()->getDataLayout();
5196 return {DL, SD, SE, LI, AA, DT, AC};
5197}
5198
5199PreservedAnalyses ScopInfoPrinterPass::run(Function &F,
5200 FunctionAnalysisManager &FAM) {
5201 auto &SI = FAM.getResult<ScopInfoAnalysis>(F);
5202 for (auto &It : SI) {
5203 if (It.second)
5204 It.second->print(Stream);
5205 else
5206 Stream << "Invalid Scop!\n";
5207 }
5208 return PreservedAnalyses::all();
5209}
5210
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005211void ScopInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
5212 AU.addRequired<LoopInfoWrapperPass>();
5213 AU.addRequired<RegionInfoPass>();
5214 AU.addRequired<DominatorTreeWrapperPass>();
5215 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005216 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005217 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005218 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005219 AU.setPreservesAll();
5220}
5221
5222bool ScopInfoWrapperPass::runOnFunction(Function &F) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005223 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005224 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5225 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5226 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5227 auto const &DL = F.getParent()->getDataLayout();
5228 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005229 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005230
Philip Pfaffe838e0882017-05-15 12:55:14 +00005231 Result.reset(new ScopInfo{DL, SD, SE, LI, AA, DT, AC});
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005232 return false;
5233}
5234
5235void ScopInfoWrapperPass::print(raw_ostream &OS, const Module *) const {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005236 for (auto &It : *Result) {
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005237 if (It.second)
5238 It.second->print(OS);
5239 else
5240 OS << "Invalid Scop!\n";
5241 }
5242}
5243
5244char ScopInfoWrapperPass::ID = 0;
5245
5246Pass *polly::createScopInfoWrapperPassPass() {
5247 return new ScopInfoWrapperPass();
5248}
5249
5250INITIALIZE_PASS_BEGIN(
5251 ScopInfoWrapperPass, "polly-function-scops",
5252 "Polly - Create polyhedral description of all Scops of a function", false,
5253 false);
5254INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005255INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005256INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
5257INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
5258INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005259INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005260INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
5261INITIALIZE_PASS_END(
5262 ScopInfoWrapperPass, "polly-function-scops",
5263 "Polly - Create polyhedral description of all Scops of a function", false,
5264 false)