blob: 7c1f8ef015be2a4eac07ac5b2f6e8a7d30712577 [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 Grosser77eef902017-07-21 23:07:56 +000025#include "polly/Support/ISLOStream.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000026#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000027#include "polly/Support/ScopHelper.h"
Tobias Grosser9737c7b2015-11-22 11:06:51 +000028#include "llvm/ADT/DepthFirstIterator.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000029#include "llvm/ADT/MapVector.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000030#include "llvm/ADT/PostOrderIterator.h"
31#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000032#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000033#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000034#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000035#include "llvm/Analysis/AliasAnalysis.h"
Michael Kruse89b1f942017-03-17 13:56:53 +000036#include "llvm/Analysis/AssumptionCache.h"
Johannes Doerfert1dc12af2016-04-23 12:59:18 +000037#include "llvm/Analysis/Loads.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000038#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000039#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000040#include "llvm/Analysis/RegionIterator.h"
41#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000042#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000043#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000044#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000045#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000046#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000047#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000048#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000049#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000050#include "isl/schedule.h"
51#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000052#include "isl/set.h"
53#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000054#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000055#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000056#include <sstream>
57#include <string>
58#include <vector>
59
60using namespace llvm;
61using namespace polly;
62
Chandler Carruth95fef942014-04-22 03:30:19 +000063#define DEBUG_TYPE "polly-scops"
64
Johannes Doerfert81aa6e82016-11-18 14:37:08 +000065STATISTIC(AssumptionsAliasing, "Number of aliasing assumptions taken.");
66STATISTIC(AssumptionsInbounds, "Number of inbounds assumptions taken.");
67STATISTIC(AssumptionsWrapping, "Number of wrapping assumptions taken.");
68STATISTIC(AssumptionsUnsigned, "Number of unsigned assumptions taken.");
69STATISTIC(AssumptionsComplexity, "Number of too complex SCoPs.");
70STATISTIC(AssumptionsUnprofitable, "Number of unprofitable SCoPs.");
71STATISTIC(AssumptionsErrorBlock, "Number of error block assumptions taken.");
72STATISTIC(AssumptionsInfiniteLoop, "Number of bounded loop assumptions taken.");
73STATISTIC(AssumptionsInvariantLoad,
Johannes Doerfertcd195322016-11-17 21:41:08 +000074 "Number of invariant loads assumptions taken.");
Johannes Doerfert81aa6e82016-11-18 14:37:08 +000075STATISTIC(AssumptionsDelinearization,
Johannes Doerfertcd195322016-11-17 21:41:08 +000076 "Number of delinearization assumptions taken.");
77
Tobias Grossercd01a362017-02-17 08:12:36 +000078STATISTIC(NumLoopsInScop, "Number of loops in scops");
79STATISTIC(NumScopsDepthOne, "Number of scops with maximal loop depth 1");
80STATISTIC(NumScopsDepthTwo, "Number of scops with maximal loop depth 2");
81STATISTIC(NumScopsDepthThree, "Number of scops with maximal loop depth 3");
82STATISTIC(NumScopsDepthFour, "Number of scops with maximal loop depth 4");
83STATISTIC(NumScopsDepthFive, "Number of scops with maximal loop depth 5");
84STATISTIC(NumScopsDepthLarger,
85 "Number of scops with maximal loop depth 6 and larger");
86STATISTIC(MaxNumLoopsInScop, "Maximal number of loops in scops");
87
Tobias Grosser75dc40c2015-12-20 13:31:48 +000088// The maximal number of basic sets we allow during domain construction to
89// be created. More complex scops will result in very high compile time and
90// are also unlikely to result in good code
Tobias Grosser90411a92017-02-16 19:11:33 +000091static int const MaxDisjunctsInDomain = 20;
Tobias Grosser75dc40c2015-12-20 13:31:48 +000092
Tobias Grosserc8a82762017-02-16 19:11:25 +000093// The number of disjunct in the context after which we stop to add more
94// disjuncts. This parameter is there to avoid exponential growth in the
95// number of disjunct when adding non-convex sets to the context.
96static int const MaxDisjunctsInContext = 4;
97
Tobias Grosser1eeedf42017-07-20 19:55:19 +000098// The maximal number of dimensions we allow during invariant load construction.
99// More complex access ranges will result in very high compile time and are also
100// unlikely to result in good code. This value is very high and should only
101// trigger for corner cases (e.g., the "dct_luma" function in h264, SPEC2006).
102static int const MaxDimensionsInAccessRange = 9;
103
Tobias Grosser97715842017-05-19 04:01:52 +0000104static cl::opt<int>
105 OptComputeOut("polly-analysis-computeout",
106 cl::desc("Bound the scop analysis by a maximal amount of "
107 "computational steps (0 means no bound)"),
Tobias Grosser57a1d362017-06-23 08:05:27 +0000108 cl::Hidden, cl::init(800000), cl::ZeroOrMore,
Tobias Grosser97715842017-05-19 04:01:52 +0000109 cl::cat(PollyCategory));
Tobias Grosser45e9fd12017-05-19 03:45:00 +0000110
Johannes Doerfert2f705842016-04-12 16:09:44 +0000111static cl::opt<bool> PollyRemarksMinimal(
112 "polly-remarks-minimal",
113 cl::desc("Do not emit remarks about assumptions that are known"),
114 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
115
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +0000116// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +0000117// operations can overflow easily. Additive reductions and bit operations
118// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +0000119static cl::opt<bool> DisableMultiplicativeReductions(
120 "polly-disable-multiplicative-reductions",
121 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
122 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +0000123
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +0000124static cl::opt<int> RunTimeChecksMaxAccessDisjuncts(
125 "polly-rtc-max-array-disjuncts",
126 cl::desc("The maximal number of disjunts allowed in memory accesses to "
127 "to build RTCs."),
128 cl::Hidden, cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
129
Johannes Doerfert9143d672014-09-27 11:02:39 +0000130static cl::opt<unsigned> RunTimeChecksMaxParameters(
131 "polly-rtc-max-parameters",
132 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
133 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
134
Tobias Grosser71500722015-03-28 15:11:14 +0000135static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
136 "polly-rtc-max-arrays-per-group",
137 cl::desc("The maximal number of arrays to compare in each alias group."),
138 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Johannes Doerfert5210da52016-06-02 11:06:54 +0000139
Tobias Grosser8a9c2352015-08-16 10:19:29 +0000140static cl::opt<std::string> UserContextStr(
141 "polly-context", cl::value_desc("isl parameter set"),
142 cl::desc("Provide additional constraints on the context parameters"),
143 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +0000144
Tobias Grosserd83b8a82015-08-20 19:08:11 +0000145static cl::opt<bool> DetectReductions("polly-detect-reductions",
146 cl::desc("Detect and exploit reductions"),
147 cl::Hidden, cl::ZeroOrMore,
148 cl::init(true), cl::cat(PollyCategory));
149
Tobias Grosser2937b592016-04-29 11:43:20 +0000150static cl::opt<bool>
151 IslOnErrorAbort("polly-on-isl-error-abort",
152 cl::desc("Abort if an isl error is encountered"),
153 cl::init(true), cl::cat(PollyCategory));
154
Tobias Grosserd7c49752017-02-28 09:45:54 +0000155static cl::opt<bool> PollyPreciseInbounds(
156 "polly-precise-inbounds",
157 cl::desc("Take more precise inbounds assumptions (do not scale well)"),
158 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
159
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000160static cl::opt<bool>
161 PollyIgnoreInbounds("polly-ignore-inbounds",
162 cl::desc("Do not take inbounds assumptions at all"),
163 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
164
Tobias Grosser5842dee2017-03-17 13:00:53 +0000165static cl::opt<bool> PollyIgnoreParamBounds(
166 "polly-ignore-parameter-bounds",
167 cl::desc(
168 "Do not add parameter bounds and do no gist simplify sets accordingly"),
169 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
170
Tobias Grosserc2f15102017-03-01 21:11:27 +0000171static cl::opt<bool> PollyPreciseFoldAccesses(
172 "polly-precise-fold-accesses",
Michael Kruse6e7854a2017-04-03 12:03:38 +0000173 cl::desc("Fold memory accesses to model more possible delinearizations "
174 "(does not scale well)"),
Tobias Grosserc2f15102017-03-01 21:11:27 +0000175 cl::Hidden, cl::init(false), cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000176
Michael Kruse5ae08c02017-05-06 14:03:58 +0000177bool polly::UseInstructionNames;
178static cl::opt<bool, true> XUseInstructionNames(
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000179 "polly-use-llvm-names",
Michael Kruse5ae08c02017-05-06 14:03:58 +0000180 cl::desc("Use LLVM-IR names when deriving statement names"),
181 cl::location(UseInstructionNames), cl::Hidden, cl::init(false),
182 cl::ZeroOrMore, cl::cat(PollyCategory));
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000183
Tobias Grosserd5fcbef2017-05-27 04:40:18 +0000184static cl::opt<bool> PollyPrintInstructions(
185 "polly-print-instructions", cl::desc("Output instructions per ScopStmt"),
186 cl::Hidden, cl::Optional, cl::init(false), cl::cat(PollyCategory));
187
Michael Kruse7bf39442015-09-10 12:46:52 +0000188//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000189
Michael Kruse046dde42015-08-10 13:01:57 +0000190// Create a sequence of two schedules. Either argument may be null and is
191// interpreted as the empty schedule. Can also return null if both schedules are
192// empty.
193static __isl_give isl_schedule *
194combineInSequence(__isl_take isl_schedule *Prev,
195 __isl_take isl_schedule *Succ) {
196 if (!Prev)
197 return Succ;
198 if (!Succ)
199 return Prev;
200
201 return isl_schedule_sequence(Prev, Succ);
202}
203
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000204static isl::set addRangeBoundsToSet(isl::set S, const ConstantRange &Range,
205 int dim, isl::dim type) {
206 isl::val V;
207 isl::ctx Ctx = S.get_ctx();
Johannes Doerferte7044942015-02-24 11:58:30 +0000208
Tobias Grosser3281f602017-02-16 18:39:14 +0000209 // The upper and lower bound for a parameter value is derived either from
210 // the data type of the parameter or from the - possibly more restrictive -
211 // range metadata.
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000212 V = valFromAPInt(Ctx.get(), Range.getSignedMin(), true);
213 S = S.lower_bound_val(type, dim, V);
214 V = valFromAPInt(Ctx.get(), Range.getSignedMax(), true);
215 S = S.upper_bound_val(type, dim, V);
Johannes Doerferte7044942015-02-24 11:58:30 +0000216
Tobias Grosser3281f602017-02-16 18:39:14 +0000217 if (Range.isFullSet())
218 return S;
219
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000220 if (isl_set_n_basic_set(S.get()) > MaxDisjunctsInContext)
Tobias Grosserc8a82762017-02-16 19:11:25 +0000221 return S;
222
Tobias Grosser3281f602017-02-16 18:39:14 +0000223 // In case of signed wrapping, we can refine the set of valid values by
224 // excluding the part not covered by the wrapping range.
225 if (Range.isSignWrappedSet()) {
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000226 V = valFromAPInt(Ctx.get(), Range.getLower(), true);
227 isl::set SLB = S.lower_bound_val(type, dim, V);
Tobias Grosser3281f602017-02-16 18:39:14 +0000228
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000229 V = valFromAPInt(Ctx.get(), Range.getUpper(), true);
230 V = V.sub_ui(1);
231 isl::set SUB = S.upper_bound_val(type, dim, V);
232 S = SLB.unite(SUB);
Tobias Grosser3281f602017-02-16 18:39:14 +0000233 }
Johannes Doerferte7044942015-02-24 11:58:30 +0000234
Tobias Grosser3281f602017-02-16 18:39:14 +0000235 return S;
Johannes Doerferte7044942015-02-24 11:58:30 +0000236}
237
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000238static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
239 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
240 if (!BasePtrLI)
241 return nullptr;
242
Johannes Doerfert952b5302016-05-23 12:40:48 +0000243 if (!S->contains(BasePtrLI))
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000244 return nullptr;
245
246 ScalarEvolution &SE = *S->getSE();
247
248 auto *OriginBaseSCEV =
249 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
250 if (!OriginBaseSCEV)
251 return nullptr;
252
253 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
254 if (!OriginBaseSCEVUnknown)
255 return nullptr;
256
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000257 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000258 MemoryKind::Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000259}
260
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000261ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Hongbin Zheng6aded2a2017-01-15 16:47:26 +0000262 ArrayRef<const SCEV *> Sizes, MemoryKind Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +0000263 const DataLayout &DL, Scop *S,
264 const char *BaseName)
Michael Kruseb738ffa2017-06-28 13:02:43 +0000265 : BasePtr(BasePtr), ElementType(ElementType), IsOnHeap(false), Kind(Kind),
266 DL(DL), S(*S), FAD(nullptr) {
Tobias Grosser92245222015-07-28 14:53:44 +0000267 std::string BasePtrName =
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000268 BaseName ? BaseName
Tobias Grossere2ccc3f2017-05-03 20:08:52 +0000269 : getIslCompatibleName("MemRef", BasePtr, S->getNextArrayIdx(),
270 Kind == MemoryKind::PHI ? "__phi" : "",
271 UseInstructionNames);
Tobias Grosser77eef902017-07-21 23:07:56 +0000272 Id = isl::id::alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000273
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000274 updateSizes(Sizes);
Roman Gareevd7754a12016-07-30 09:25:51 +0000275
Tobias Grosser4d5a9172017-01-14 20:25:44 +0000276 if (!BasePtr || Kind != MemoryKind::Array) {
Roman Gareevd7754a12016-07-30 09:25:51 +0000277 BasePtrOriginSAI = nullptr;
278 return;
279 }
280
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000281 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
282 if (BasePtrOriginSAI)
283 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000284}
285
Tobias Grosser77eef902017-07-21 23:07:56 +0000286isl::space ScopArrayInfo::getSpace() const {
287 auto Space = isl::space(Id.get_ctx(), 0, getNumberOfDimensions());
288 Space = Space.set_tuple_id(isl::dim::set, Id);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000289 return Space;
290}
291
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000292bool ScopArrayInfo::isReadOnly() {
Tobias Grosser2ade9862017-05-23 06:41:04 +0000293 isl::union_set WriteSet = give(S.getWrites()).range();
Tobias Grosser77eef902017-07-21 23:07:56 +0000294 isl::space Space = getSpace();
Tobias Grosser2ade9862017-05-23 06:41:04 +0000295 WriteSet = WriteSet.extract_set(Space);
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000296
Tobias Grosser2ade9862017-05-23 06:41:04 +0000297 return bool(WriteSet.is_empty());
Tobias Grosserfe74a7a2016-09-17 19:22:18 +0000298}
299
Tobias Grosserf3adab42017-05-10 10:59:58 +0000300bool ScopArrayInfo::isCompatibleWith(const ScopArrayInfo *Array) const {
301 if (Array->getElementType() != getElementType())
302 return false;
303
304 if (Array->getNumberOfDimensions() != getNumberOfDimensions())
305 return false;
306
307 for (unsigned i = 0; i < getNumberOfDimensions(); i++)
308 if (Array->getDimensionSize(i) != getDimensionSize(i))
309 return false;
310
311 return true;
312}
313
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000314void ScopArrayInfo::updateElementType(Type *NewElementType) {
315 if (NewElementType == ElementType)
316 return;
317
Tobias Grosserd840fc72016-02-04 13:18:42 +0000318 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
319 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
320
Johannes Doerferta7920982016-02-25 14:08:48 +0000321 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000322 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000323
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000324 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
325 ElementType = NewElementType;
326 } else {
327 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
328 ElementType = IntegerType::get(ElementType->getContext(), GCD);
329 }
330}
331
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000332/// Make the ScopArrayInfo model a Fortran Array
333void ScopArrayInfo::applyAndSetFAD(Value *FAD) {
334 assert(FAD && "got invalid Fortran array descriptor");
335 if (this->FAD) {
336 assert(this->FAD == FAD &&
337 "receiving different array descriptors for same array");
338 return;
339 }
340
341 assert(DimensionSizesPw.size() > 0 && !DimensionSizesPw[0]);
342 assert(!this->FAD);
343 this->FAD = FAD;
344
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000345 isl::space Space(S.getIslCtx(), 1, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000346
347 std::string param_name = getName();
348 param_name += "_fortranarr_size";
349 // TODO: see if we need to add `this` as the id user pointer
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000350 isl::id IdPwAff = isl::id::alloc(S.getIslCtx(), param_name.c_str(), nullptr);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000351
Tobias Grosserb1ed3d92017-05-23 07:07:05 +0000352 Space = Space.set_dim_id(isl::dim::param, 0, IdPwAff);
353 isl::pw_aff PwAff =
354 isl::aff::var_on_domain(isl::local_space(Space), isl::dim::param, 0);
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000355
Tobias Grosser77eef902017-07-21 23:07:56 +0000356 DimensionSizesPw[0] = PwAff;
Siddharth Bhatb7f68b82017-05-19 15:07:45 +0000357}
358
Tobias Grosserbedef002016-12-02 08:10:56 +0000359bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes,
360 bool CheckConsistency) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000361 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
362 int ExtraDimsNew = NewSizes.size() - SharedDims;
363 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Roman Gareevf5aff702016-09-12 17:08:31 +0000364
Tobias Grosserbedef002016-12-02 08:10:56 +0000365 if (CheckConsistency) {
366 for (int i = 0; i < SharedDims; i++) {
367 auto *NewSize = NewSizes[i + ExtraDimsNew];
368 auto *KnownSize = DimensionSizes[i + ExtraDimsOld];
369 if (NewSize && KnownSize && NewSize != KnownSize)
370 return false;
371 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000372
Tobias Grosserbedef002016-12-02 08:10:56 +0000373 if (DimensionSizes.size() >= NewSizes.size())
374 return true;
375 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000376
377 DimensionSizes.clear();
378 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
379 NewSizes.end());
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000380 DimensionSizesPw.clear();
381 for (const SCEV *Expr : DimensionSizes) {
Roman Gareevf5aff702016-09-12 17:08:31 +0000382 if (!Expr) {
383 DimensionSizesPw.push_back(nullptr);
384 continue;
385 }
Tobias Grosser77eef902017-07-21 23:07:56 +0000386 isl::pw_aff Size = isl::manage(S.getPwAffOnly(Expr));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000387 DimensionSizesPw.push_back(Size);
388 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000389 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000390}
391
Tobias Grosser77eef902017-07-21 23:07:56 +0000392ScopArrayInfo::~ScopArrayInfo() {}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000393
Tobias Grosser77eef902017-07-21 23:07:56 +0000394std::string ScopArrayInfo::getName() const { return Id.get_name(); }
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000395
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
Tobias Grosser77eef902017-07-21 23:07:56 +0000400isl::id ScopArrayInfo::getBasePtrId() const { return Id; }
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000401
Michael Kruse5d518462017-07-21 15:54:07 +0000402#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +0000403LLVM_DUMP_METHOD void ScopArrayInfo::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +0000404#endif
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000405
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) {
Tobias Grosser77eef902017-07-21 23:07:56 +0000422 isl::pw_aff Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000423 OS << " " << Size << " ";
Tobias Grosser26253842015-11-10 14:24:21 +0000424 } else {
425 OS << *getDimensionSize(u);
426 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000427
428 OS << "]";
429 }
430
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000431 OS << ";";
432
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000433 if (BasePtrOriginSAI)
434 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
435
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000436 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000437}
438
439const ScopArrayInfo *
440ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
441 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
442 assert(Id && "Output dimension didn't have an ID");
443 return getFromId(Id);
444}
445
Michael Krused56b90a2016-09-01 09:03:27 +0000446const ScopArrayInfo *ScopArrayInfo::getFromId(__isl_take isl_id *Id) {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000447 void *User = isl_id_get_user(Id);
448 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
449 isl_id_free(Id);
450 return SAI;
451}
452
Michael Kruse3b425ff2016-04-11 14:34:08 +0000453void MemoryAccess::wrapConstantDimensions() {
454 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000455 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000456 isl::ctx Ctx = ArraySpace.get_ctx();
Michael Kruse3b425ff2016-04-11 14:34:08 +0000457 unsigned DimsArray = SAI->getNumberOfDimensions();
458
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000459 isl::multi_aff DivModAff = isl::multi_aff::identity(
460 ArraySpace.map_from_domain_and_range(ArraySpace));
461 isl::local_space LArraySpace = isl::local_space(ArraySpace);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000462
463 // Begin with last dimension, to iteratively carry into higher dimensions.
464 for (int i = DimsArray - 1; i > 0; i--) {
465 auto *DimSize = SAI->getDimensionSize(i);
466 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
467
468 // This transformation is not applicable to dimensions with dynamic size.
469 if (!DimSizeCst)
470 continue;
471
Tobias Grosserca2cfd02017-02-17 04:48:52 +0000472 // This transformation is not applicable to dimensions of size zero.
473 if (DimSize->isZero())
474 continue;
475
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000476 isl::val DimSizeVal =
477 valFromAPInt(Ctx.get(), DimSizeCst->getAPInt(), false);
478 isl::aff Var = isl::aff::var_on_domain(LArraySpace, isl::dim::set, i);
479 isl::aff PrevVar =
480 isl::aff::var_on_domain(LArraySpace, isl::dim::set, i - 1);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000481
482 // Compute: index % size
483 // Modulo must apply in the divide of the previous iteration, if any.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000484 isl::aff Modulo = Var.mod_val(DimSizeVal);
485 Modulo = Modulo.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000486
487 // Compute: floor(index / size)
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000488 isl::aff Divide = Var.div(isl::aff(LArraySpace, DimSizeVal));
489 Divide = Divide.floor();
490 Divide = Divide.add(PrevVar);
491 Divide = Divide.pullback(DivModAff);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000492
493 // Apply Modulo and Divide.
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000494 DivModAff = DivModAff.set_aff(i, Modulo);
495 DivModAff = DivModAff.set_aff(i - 1, Divide);
Michael Kruse3b425ff2016-04-11 14:34:08 +0000496 }
497
498 // Apply all modulo/divides on the accesses.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000499 isl::map Relation = AccessRelation;
Tobias Grosser3137f2c2017-05-21 20:23:23 +0000500 Relation = Relation.apply_range(isl::map::from_multi_aff(DivModAff));
501 Relation = Relation.detect_equalities();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000502 AccessRelation = Relation;
Michael Kruse3b425ff2016-04-11 14:34:08 +0000503}
504
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000505void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000506 auto *SAI = getScopArrayInfo();
Tobias Grosser77eef902017-07-21 23:07:56 +0000507 isl::space ArraySpace = SAI->getSpace();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000508 isl::space AccessSpace = AccessRelation.get_space().range();
Tobias Grosser7be82452017-05-21 20:38:33 +0000509 isl::ctx Ctx = ArraySpace.get_ctx();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000510
Tobias Grosser7be82452017-05-21 20:38:33 +0000511 auto DimsArray = ArraySpace.dim(isl::dim::set);
512 auto DimsAccess = AccessSpace.dim(isl::dim::set);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000513 auto DimsMissing = DimsArray - DimsAccess;
514
Michael Kruse375cb5f2016-02-24 22:08:24 +0000515 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000516 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000517 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000518 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000519
Tobias Grosser7be82452017-05-21 20:38:33 +0000520 isl::map Map = isl::map::from_domain_and_range(
521 isl::set::universe(AccessSpace), isl::set::universe(ArraySpace));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000522
523 for (unsigned i = 0; i < DimsMissing; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000524 Map = Map.fix_si(isl::dim::out, i, 0);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000525
526 for (unsigned i = DimsMissing; i < DimsArray; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000527 Map = Map.equate(isl::dim::in, i - DimsMissing, isl::dim::out, i);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000528
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000529 AccessRelation = AccessRelation.apply_range(Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000530
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000531 // For the non delinearized arrays, divide the access function of the last
532 // subscript by the size of the elements in the array.
533 //
534 // A stride one array access in C expressed as A[i] is expressed in
535 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
536 // two subsequent values of 'i' index two values that are stored next to
537 // each other in memory. By this division we make this characteristic
538 // obvious again. If the base pointer was accessed with offsets not divisible
Tobias Grosser2219d152016-08-03 05:28:09 +0000539 // by the accesses element size, we will have chosen a smaller ArrayElemSize
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000540 // that divides the offsets of all accesses to this base pointer.
541 if (DimsAccess == 1) {
Tobias Grosser7be82452017-05-21 20:38:33 +0000542 isl::val V = isl::val(Ctx, ArrayElemSize);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000543 AccessRelation = AccessRelation.floordiv_val(V);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000544 }
545
Michael Kruse3b425ff2016-04-11 14:34:08 +0000546 // We currently do this only if we added at least one dimension, which means
547 // some dimension's indices have not been specified, an indicator that some
548 // index values have been added together.
549 // TODO: Investigate general usefulness; Effect on unit tests is to make index
550 // expressions more complicated.
551 if (DimsMissing)
552 wrapConstantDimensions();
553
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000554 if (!isAffine())
555 computeBoundsOnAccessRelation(ArrayElemSize);
556
Tobias Grosserd840fc72016-02-04 13:18:42 +0000557 // Introduce multi-element accesses in case the type loaded by this memory
558 // access is larger than the canonical element type of the array.
559 //
560 // An access ((float *)A)[i] to an array char *A is modeled as
561 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000562 if (ElemBytes > ArrayElemSize) {
563 assert(ElemBytes % ArrayElemSize == 0 &&
564 "Loaded element size should be multiple of canonical element size");
Tobias Grosser7be82452017-05-21 20:38:33 +0000565 isl::map Map = isl::map::from_domain_and_range(
566 isl::set::universe(ArraySpace), isl::set::universe(ArraySpace));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000567 for (unsigned i = 0; i < DimsArray - 1; i++)
Tobias Grosser7be82452017-05-21 20:38:33 +0000568 Map = Map.equate(isl::dim::in, i, isl::dim::out, i);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000569
Tobias Grosser7be82452017-05-21 20:38:33 +0000570 isl::constraint C;
571 isl::local_space LS;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000572
Tobias Grosser7be82452017-05-21 20:38:33 +0000573 LS = isl::local_space(Map.get_space());
Tobias Grosserd840fc72016-02-04 13:18:42 +0000574 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
575
Tobias Grosser7be82452017-05-21 20:38:33 +0000576 C = isl::constraint::alloc_inequality(LS);
577 C = C.set_constant_val(isl::val(Ctx, Num - 1));
578 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, 1);
579 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, -1);
580 Map = Map.add_constraint(C);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000581
Tobias Grosser7be82452017-05-21 20:38:33 +0000582 C = isl::constraint::alloc_inequality(LS);
583 C = C.set_coefficient_si(isl::dim::in, DimsArray - 1, -1);
584 C = C.set_coefficient_si(isl::dim::out, DimsArray - 1, 1);
585 C = C.set_constant_val(isl::val(Ctx, 0));
586 Map = Map.add_constraint(C);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000587 AccessRelation = AccessRelation.apply_range(Map);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000588 }
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000589}
590
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000591const std::string
592MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
593 switch (RT) {
594 case MemoryAccess::RT_NONE:
595 llvm_unreachable("Requested a reduction operator string for a memory "
596 "access which isn't a reduction");
597 case MemoryAccess::RT_ADD:
598 return "+";
599 case MemoryAccess::RT_MUL:
600 return "*";
601 case MemoryAccess::RT_BOR:
602 return "|";
603 case MemoryAccess::RT_BXOR:
604 return "^";
605 case MemoryAccess::RT_BAND:
606 return "&";
607 }
608 llvm_unreachable("Unknown reduction type");
609 return "";
610}
611
Tobias Grosserc80d6972016-09-02 06:33:33 +0000612/// Return the reduction type for a given binary operator.
Johannes Doerfertf6183392014-07-01 20:52:51 +0000613static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
614 const Instruction *Load) {
615 if (!BinOp)
616 return MemoryAccess::RT_NONE;
617 switch (BinOp->getOpcode()) {
618 case Instruction::FAdd:
619 if (!BinOp->hasUnsafeAlgebra())
620 return MemoryAccess::RT_NONE;
621 // Fall through
622 case Instruction::Add:
623 return MemoryAccess::RT_ADD;
624 case Instruction::Or:
625 return MemoryAccess::RT_BOR;
626 case Instruction::Xor:
627 return MemoryAccess::RT_BXOR;
628 case Instruction::And:
629 return MemoryAccess::RT_BAND;
630 case Instruction::FMul:
631 if (!BinOp->hasUnsafeAlgebra())
632 return MemoryAccess::RT_NONE;
633 // Fall through
634 case Instruction::Mul:
635 if (DisableMultiplicativeReductions)
636 return MemoryAccess::RT_NONE;
637 return MemoryAccess::RT_MUL;
638 default:
639 return MemoryAccess::RT_NONE;
640 }
641}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000642
Tobias Grosser75805372011-04-29 06:27:02 +0000643MemoryAccess::~MemoryAccess() {
Johannes Doerfert85676e32016-04-23 14:32:34 +0000644 isl_set_free(InvalidDomain);
Tobias Grosser166c4222015-09-05 07:46:40 +0000645 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000646}
647
Michael Kruse2fa35192016-09-01 19:53:31 +0000648const ScopArrayInfo *MemoryAccess::getOriginalScopArrayInfo() const {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000649 isl_id *ArrayId = getArrayId();
650 void *User = isl_id_get_user(ArrayId);
651 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
652 isl_id_free(ArrayId);
653 return SAI;
654}
655
Michael Kruse2fa35192016-09-01 19:53:31 +0000656const ScopArrayInfo *MemoryAccess::getLatestScopArrayInfo() const {
657 isl_id *ArrayId = getLatestArrayId();
658 void *User = isl_id_get_user(ArrayId);
659 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
660 isl_id_free(ArrayId);
661 return SAI;
662}
663
664__isl_give isl_id *MemoryAccess::getOriginalArrayId() const {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000665 return isl_map_get_tuple_id(AccessRelation.get(), isl_dim_out);
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000666}
667
Michael Kruse2fa35192016-09-01 19:53:31 +0000668__isl_give isl_id *MemoryAccess::getLatestArrayId() const {
669 if (!hasNewAccessRelation())
670 return getOriginalArrayId();
671 return isl_map_get_tuple_id(NewAccessRelation, isl_dim_out);
672}
673
Tobias Grosserd840fc72016-02-04 13:18:42 +0000674__isl_give isl_map *MemoryAccess::getAddressFunction() const {
675 return isl_map_lexmin(getAccessRelation());
676}
677
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000678__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
679 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000680 isl_map *Schedule, *ScheduledAccRel;
681 isl_union_set *UDomain;
682
683 UDomain = isl_union_set_from_set(getStatement()->getDomain());
684 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
685 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000686 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000687 return isl_pw_multi_aff_from_map(ScheduledAccRel);
688}
689
Tobias Grosser22da5f02017-07-23 04:08:27 +0000690isl::map MemoryAccess::getOriginalAccessRelation() const {
691 return AccessRelation;
Tobias Grosser5d453812011-10-06 00:04:11 +0000692}
693
Johannes Doerferta99130f2014-10-13 12:58:03 +0000694std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000695 return stringFromIslObj(AccessRelation.get());
Tobias Grosser5d453812011-10-06 00:04:11 +0000696}
697
Tobias Grosser22da5f02017-07-23 04:08:27 +0000698isl::space MemoryAccess::getOriginalAccessRelationSpace() const {
699 return AccessRelation.get_space();
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000700}
701
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000702__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000703 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000704}
705
Tobias Grosser6f730082015-09-05 07:46:47 +0000706std::string MemoryAccess::getNewAccessRelationStr() const {
707 return stringFromIslObj(NewAccessRelation);
708}
709
Tobias Grosser6a4c12f2017-07-11 10:10:13 +0000710std::string MemoryAccess::getAccessRelationStr() const {
711 return isl::manage(getAccessRelation()).to_str();
712}
713
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000714isl::basic_map MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
715 isl::space Space = isl::space(Statement->getIslCtx(), 0, 1);
716 Space = Space.align_params(isl::manage(Statement->getDomainSpace()));
Tobias Grosser75805372011-04-29 06:27:02 +0000717
Tobias Grosserb6e7a852017-07-23 04:08:17 +0000718 return isl::basic_map::from_domain_and_range(
719 isl::basic_set::universe(isl::manage(Statement->getDomainSpace())),
720 isl::basic_set::universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000721}
722
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000723// Formalize no out-of-bound access assumption
724//
725// When delinearizing array accesses we optimistically assume that the
726// delinearized accesses do not access out of bound locations (the subscript
727// expression of each array evaluates for each statement instance that is
728// executed to a value that is larger than zero and strictly smaller than the
729// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000730// dimension for which we do not need to assume any upper bound. At this point
731// we formalize this assumption to ensure that at code generation time the
732// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000733//
734// To find the set of constraints necessary to avoid out of bound accesses, we
735// first build the set of data locations that are not within array bounds. We
736// then apply the reverse access relation to obtain the set of iterations that
737// may contain invalid accesses and reduce this set of iterations to the ones
738// that are actually executed by intersecting them with the domain of the
739// statement. If we now project out all loop dimensions, we obtain a set of
740// parameters that may cause statement instances to be executed that may
741// possibly yield out of bound memory accesses. The complement of these
742// constraints is the set of constraints that needs to be assumed to ensure such
743// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000744void MemoryAccess::assumeNoOutOfBound() {
Tobias Grosser8a6e6052017-03-17 12:26:58 +0000745 if (PollyIgnoreInbounds)
746 return;
Johannes Doerfertadeab372016-02-07 13:57:32 +0000747 auto *SAI = getScopArrayInfo();
Tobias Grosser22da5f02017-07-23 04:08:27 +0000748 isl::space Space = getOriginalAccessRelationSpace().range();
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000749 isl::set Outside = isl::set::empty(Space);
750 for (int i = 1, Size = Space.dim(isl::dim::set); i < Size; ++i) {
751 isl::local_space LS(Space);
752 isl::pw_aff Var = isl::pw_aff::var_on_domain(LS, isl::dim::set, i);
753 isl::pw_aff Zero = isl::pw_aff(LS);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000754
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000755 isl::set DimOutside = Var.lt_set(Zero);
Tobias Grosser77eef902017-07-21 23:07:56 +0000756 isl::pw_aff SizeE = SAI->getDimensionSizePw(i);
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000757 SizeE = SizeE.add_dims(isl::dim::in, Space.dim(isl::dim::set));
758 SizeE = SizeE.set_tuple_id(isl::dim::in, Space.get_tuple_id(isl::dim::set));
759 DimOutside = DimOutside.unite(SizeE.le_set(Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000760
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000761 Outside = Outside.unite(DimOutside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000762 }
763
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000764 Outside = Outside.apply(give(getAccessRelation()).reverse());
765 Outside = Outside.intersect(give(Statement->getDomain()));
766 Outside = Outside.params();
Tobias Grosserf54bb772015-06-26 12:09:28 +0000767
768 // Remove divs to avoid the construction of overly complicated assumptions.
769 // Doing so increases the set of parameter combinations that are assumed to
770 // not appear. This is always save, but may make the resulting run-time check
771 // bail out more often than strictly necessary.
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000772 Outside = Outside.remove_divs();
773 Outside = Outside.complement();
Michael Kruse7071e8b2016-04-11 13:24:29 +0000774 const auto &Loc = getAccessInstruction()
775 ? getAccessInstruction()->getDebugLoc()
776 : DebugLoc();
Tobias Grosserd7c49752017-02-28 09:45:54 +0000777 if (!PollyPreciseInbounds)
Tobias Grosser1e2edaf2017-05-23 07:07:07 +0000778 Outside = Outside.gist_params(give(Statement->getDomain()).params());
779 Statement->getParent()->recordAssumption(INBOUNDS, Outside.release(), Loc,
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000780 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000781}
782
Johannes Doerfertcea61932016-02-21 19:13:19 +0000783void MemoryAccess::buildMemIntrinsicAccessRelation() {
Johannes Doerfertc9765462016-11-17 22:11:56 +0000784 assert(isMemoryIntrinsic());
Roman Gareevf5aff702016-09-12 17:08:31 +0000785 assert(Subscripts.size() == 2 && Sizes.size() == 1);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000786
Tobias Grosser53fc3552017-05-23 07:07:09 +0000787 isl::pw_aff SubscriptPWA = give(getPwAff(Subscripts[0]));
788 isl::map SubscriptMap = isl::map::from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000789
Tobias Grosser53fc3552017-05-23 07:07:09 +0000790 isl::map LengthMap;
Johannes Doerferta7920982016-02-25 14:08:48 +0000791 if (Subscripts[1] == nullptr) {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000792 LengthMap = isl::map::universe(SubscriptMap.get_space());
Johannes Doerferta7920982016-02-25 14:08:48 +0000793 } else {
Tobias Grosser53fc3552017-05-23 07:07:09 +0000794 isl::pw_aff LengthPWA = give(getPwAff(Subscripts[1]));
795 LengthMap = isl::map::from_pw_aff(LengthPWA);
796 isl::space RangeSpace = LengthMap.get_space().range();
797 LengthMap = LengthMap.apply_range(isl::map::lex_gt(RangeSpace));
Johannes Doerferta7920982016-02-25 14:08:48 +0000798 }
Tobias Grosser53fc3552017-05-23 07:07:09 +0000799 LengthMap = LengthMap.lower_bound_si(isl::dim::out, 0, 0);
800 LengthMap = LengthMap.align_params(SubscriptMap.get_space());
801 SubscriptMap = SubscriptMap.align_params(LengthMap.get_space());
802 LengthMap = LengthMap.sum(SubscriptMap);
803 AccessRelation =
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000804 LengthMap.set_tuple_id(isl::dim::in, give(getStatement()->getDomainId()));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000805}
806
Johannes Doerferte7044942015-02-24 11:58:30 +0000807void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
808 ScalarEvolution *SE = Statement->getParent()->getSE();
809
Johannes Doerfertcea61932016-02-21 19:13:19 +0000810 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000811 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000812 return;
813
814 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000815 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
816 return;
817
818 auto *PtrSCEV = SE->getSCEV(Ptr);
819 if (isa<SCEVCouldNotCompute>(PtrSCEV))
820 return;
821
822 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
823 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
824 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
825
826 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
827 if (Range.isFullSet())
828 return;
829
Michael Kruse960c0d02017-05-18 21:55:36 +0000830 if (Range.isWrappedSet() || Range.isSignWrappedSet())
Tobias Grosserb3a85882017-02-12 08:11:12 +0000831 return;
832
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000833 bool isWrapping = Range.isSignWrappedSet();
Tobias Grosserb3a85882017-02-12 08:11:12 +0000834
Johannes Doerferte7044942015-02-24 11:58:30 +0000835 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000836 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000837 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000838 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000839
840 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000841 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000842
Tobias Grosserb3a85882017-02-12 08:11:12 +0000843 assert(Min.sle(Max) && "Minimum expected to be less or equal than max");
844
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000845 isl::map Relation = AccessRelation;
Tobias Grosser99ea1d02017-05-21 20:23:20 +0000846 isl::set AccessRange = Relation.range();
847 AccessRange = addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0,
848 isl::dim::set);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000849 AccessRelation = Relation.intersect_range(AccessRange);
Johannes Doerferte7044942015-02-24 11:58:30 +0000850}
851
Tobias Grosser491b7992016-12-02 05:21:22 +0000852void MemoryAccess::foldAccessRelation() {
853 if (Sizes.size() < 2 || isa<SCEVConstant>(Sizes[1]))
854 return;
855
Michael Krusee2bccbb2015-09-18 19:59:43 +0000856 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000857
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000858 isl::map NewAccessRelation = AccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000859
Tobias Grosser619190d2015-03-30 17:22:28 +0000860 for (int i = Size - 2; i >= 0; --i) {
Tobias Grossera32de132017-05-23 07:22:56 +0000861 isl::space Space;
862 isl::map MapOne, MapTwo;
863 isl::pw_aff DimSize = give(getPwAff(Sizes[i + 1]));
Tobias Grosser619190d2015-03-30 17:22:28 +0000864
Tobias Grossera32de132017-05-23 07:22:56 +0000865 isl::space SpaceSize = DimSize.get_space();
866 isl::id ParamId =
867 give(isl_space_get_dim_id(SpaceSize.get(), isl_dim_param, 0));
Tobias Grosser619190d2015-03-30 17:22:28 +0000868
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000869 Space = AccessRelation.get_space();
Tobias Grossera32de132017-05-23 07:22:56 +0000870 Space = Space.range().map_from_set();
871 Space = Space.align_params(SpaceSize);
Tobias Grosser619190d2015-03-30 17:22:28 +0000872
Tobias Grossera32de132017-05-23 07:22:56 +0000873 int ParamLocation = Space.find_dim_by_id(isl::dim::param, ParamId);
Tobias Grosser619190d2015-03-30 17:22:28 +0000874
Tobias Grossera32de132017-05-23 07:22:56 +0000875 MapOne = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000876 for (int j = 0; j < Size; ++j)
Tobias Grossera32de132017-05-23 07:22:56 +0000877 MapOne = MapOne.equate(isl::dim::in, j, isl::dim::out, j);
878 MapOne = MapOne.lower_bound_si(isl::dim::in, i + 1, 0);
Tobias Grosser619190d2015-03-30 17:22:28 +0000879
Tobias Grossera32de132017-05-23 07:22:56 +0000880 MapTwo = isl::map::universe(Space);
Tobias Grosser619190d2015-03-30 17:22:28 +0000881 for (int j = 0; j < Size; ++j)
882 if (j < i || j > i + 1)
Tobias Grossera32de132017-05-23 07:22:56 +0000883 MapTwo = MapTwo.equate(isl::dim::in, j, isl::dim::out, j);
Tobias Grosser619190d2015-03-30 17:22:28 +0000884
Tobias Grossera32de132017-05-23 07:22:56 +0000885 isl::local_space LS(Space);
886 isl::constraint C;
887 C = isl::constraint::alloc_equality(LS);
888 C = C.set_constant_si(-1);
889 C = C.set_coefficient_si(isl::dim::in, i, 1);
890 C = C.set_coefficient_si(isl::dim::out, i, -1);
891 MapTwo = MapTwo.add_constraint(C);
892 C = isl::constraint::alloc_equality(LS);
893 C = C.set_coefficient_si(isl::dim::in, i + 1, 1);
894 C = C.set_coefficient_si(isl::dim::out, i + 1, -1);
895 C = C.set_coefficient_si(isl::dim::param, ParamLocation, 1);
896 MapTwo = MapTwo.add_constraint(C);
897 MapTwo = MapTwo.upper_bound_si(isl::dim::in, i + 1, -1);
Tobias Grosser619190d2015-03-30 17:22:28 +0000898
Tobias Grossera32de132017-05-23 07:22:56 +0000899 MapOne = MapOne.unite(MapTwo);
900 NewAccessRelation = NewAccessRelation.apply_range(MapOne);
Tobias Grosser619190d2015-03-30 17:22:28 +0000901 }
Tobias Grosser491b7992016-12-02 05:21:22 +0000902
Tobias Grosser77eef902017-07-21 23:07:56 +0000903 isl::id BaseAddrId = getScopArrayInfo()->getBasePtrId();
Tobias Grossera32de132017-05-23 07:22:56 +0000904 isl::space Space = give(Statement->getDomainSpace());
905 NewAccessRelation = NewAccessRelation.set_tuple_id(
906 isl::dim::in, Space.get_tuple_id(isl::dim::set));
907 NewAccessRelation = NewAccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
908 NewAccessRelation =
909 NewAccessRelation.gist_domain(give(Statement->getDomain()));
Tobias Grosserc2f15102017-03-01 21:11:27 +0000910
911 // Access dimension folding might in certain cases increase the number of
912 // disjuncts in the memory access, which can possibly complicate the generated
913 // run-time checks and can lead to costly compilation.
Tobias Grossera32de132017-05-23 07:22:56 +0000914 if (!PollyPreciseFoldAccesses &&
915 isl_map_n_basic_map(NewAccessRelation.get()) >
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000916 isl_map_n_basic_map(AccessRelation.get())) {
Tobias Grosserc2f15102017-03-01 21:11:27 +0000917 } else {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000918 AccessRelation = NewAccessRelation;
Tobias Grosserc2f15102017-03-01 21:11:27 +0000919 }
Tobias Grosser619190d2015-03-30 17:22:28 +0000920}
921
Tobias Grosserc80d6972016-09-02 06:33:33 +0000922/// Check if @p Expr is divisible by @p Size.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000923static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000924 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000925 if (Size == 1)
926 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000927
928 // Only one factor needs to be divisible.
929 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
930 for (auto *FactorExpr : MulExpr->operands())
931 if (isDivisible(FactorExpr, Size, SE))
932 return true;
933 return false;
934 }
935
936 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
Michael Krusea6d48f52017-06-08 12:06:15 +0000937 // to be divisible.
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000938 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
939 for (auto *OpExpr : NAryExpr->operands())
940 if (!isDivisible(OpExpr, Size, SE))
941 return false;
942 return true;
943 }
944
945 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
946 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
947 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
948 return MulSCEV == Expr;
949}
950
Michael Krusee2bccbb2015-09-18 19:59:43 +0000951void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000952 assert(AccessRelation.is_null() && "AccessRelation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000953
Johannes Doerfert85676e32016-04-23 14:32:34 +0000954 // Initialize the invalid domain which describes all iterations for which the
955 // access relation is not modeled correctly.
Johannes Doerferta4dd8ef2016-04-25 13:36:23 +0000956 auto *StmtInvalidDomain = getStatement()->getInvalidDomain();
957 InvalidDomain = isl_set_empty(isl_set_get_space(StmtInvalidDomain));
958 isl_set_free(StmtInvalidDomain);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000959
Tobias Grosserfe46c3f2017-07-23 04:08:11 +0000960 isl_ctx *Ctx = Id.get_ctx().release();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000961 isl::id BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000962
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000963 if (getAccessInstruction() && isa<MemIntrinsic>(getAccessInstruction())) {
964 buildMemIntrinsicAccessRelation();
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000965 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000966 return;
967 }
Johannes Doerfertcea61932016-02-21 19:13:19 +0000968
Eli Friedmanb9c6f012016-11-01 20:53:11 +0000969 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000970 // We overapproximate non-affine accesses with a possible access to the
971 // whole array. For read accesses it does not make a difference, if an
972 // access must or may happen. However, for write accesses it is important to
973 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000974 if (AccessRelation.is_null())
975 AccessRelation = createBasicAccessMap(Statement);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000976
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000977 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000978 return;
979 }
980
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000981 isl::space Space = isl::space(Ctx, 0, Statement->getNumIterators(), 0);
982 AccessRelation = isl::map::universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000983
Michael Krusee2bccbb2015-09-18 19:59:43 +0000984 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000985 isl_pw_aff *Affine = getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000986 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000987 AccessRelation =
988 AccessRelation.flat_range_product(isl::manage(SubscriptMap));
Sebastian Pop18016682014-04-08 21:20:44 +0000989 }
990
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000991 Space = isl::manage(Statement->getDomainSpace());
992 AccessRelation = AccessRelation.set_tuple_id(
993 isl::dim::in, Space.get_tuple_id(isl::dim::set));
994 AccessRelation = AccessRelation.set_tuple_id(isl::dim::out, BaseAddrId);
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000995
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +0000996 AccessRelation =
997 AccessRelation.gist_domain(isl::manage(Statement->getDomain()));
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000998}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000999
Michael Krusecac948e2015-10-02 13:53:07 +00001000MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00001001 AccessType AccType, Value *BaseAddress,
1002 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +00001003 ArrayRef<const SCEV *> Subscripts,
1004 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grosser72684bb2017-05-03 08:02:32 +00001005 MemoryKind Kind)
Johannes Doerfertcea61932016-02-21 19:13:19 +00001006 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
Tobias Grosser81331282017-05-03 07:57:35 +00001007 InvalidDomain(nullptr), BaseAddr(BaseAddress), ElementType(ElementType),
1008 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
1009 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +00001010 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001011 NewAccessRelation(nullptr), FAD(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +00001012 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001013 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001014
Tobias Grosser81331282017-05-03 07:57:35 +00001015 std::string IdName = Stmt->getBaseName() + Access;
Tobias Grosserfe46c3f2017-07-23 04:08:11 +00001016 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
Tobias Grosserf1bfd752015-11-05 20:15:37 +00001017}
Michael Krusee2bccbb2015-09-18 19:59:43 +00001018
Roman Gareevb3224ad2016-09-14 06:26:09 +00001019MemoryAccess::MemoryAccess(ScopStmt *Stmt, AccessType AccType,
1020 __isl_take isl_map *AccRel)
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001021 : Kind(MemoryKind::Array), AccType(AccType), RedType(RT_NONE),
1022 Statement(Stmt), InvalidDomain(nullptr), AccessInstruction(nullptr),
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001023 IsAffine(true), AccessRelation(nullptr), NewAccessRelation(AccRel),
1024 FAD(nullptr) {
Roman Gareevb3224ad2016-09-14 06:26:09 +00001025 auto *ArrayInfoId = isl_map_get_tuple_id(NewAccessRelation, isl_dim_out);
1026 auto *SAI = ScopArrayInfo::getFromId(ArrayInfoId);
1027 Sizes.push_back(nullptr);
1028 for (unsigned i = 1; i < SAI->getNumberOfDimensions(); i++)
1029 Sizes.push_back(SAI->getDimensionSize(i));
1030 ElementType = SAI->getElementType();
1031 BaseAddr = SAI->getBasePtr();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001032 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Tobias Grosser81331282017-05-03 07:57:35 +00001033 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size());
Roman Gareevb3224ad2016-09-14 06:26:09 +00001034
Tobias Grosser81331282017-05-03 07:57:35 +00001035 std::string IdName = Stmt->getBaseName() + Access;
Tobias Grosserfe46c3f2017-07-23 04:08:11 +00001036 Id = isl::id::alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
Roman Gareevb3224ad2016-09-14 06:26:09 +00001037}
1038
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001039void MemoryAccess::realignParams() {
Johannes Doerferta60ad842016-05-10 12:18:22 +00001040 auto *Ctx = Statement->getParent()->getContext();
1041 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +00001042 AccessRelation = AccessRelation.gist_params(isl::manage(Ctx));
Tobias Grosser75805372011-04-29 06:27:02 +00001043}
1044
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001045const std::string MemoryAccess::getReductionOperatorStr() const {
1046 return MemoryAccess::getReductionOperatorStr(getReductionType());
1047}
1048
Tobias Grosserfe46c3f2017-07-23 04:08:11 +00001049isl::id MemoryAccess::getId() const { return Id; }
Tobias Grosser6f48e0f2015-05-15 09:58:32 +00001050
Johannes Doerfertf6183392014-07-01 20:52:51 +00001051raw_ostream &polly::operator<<(raw_ostream &OS,
1052 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001053 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +00001054 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +00001055 else
1056 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +00001057 return OS;
1058}
1059
Siddharth Bhat0fe72312017-05-15 08:41:30 +00001060void MemoryAccess::setFortranArrayDescriptor(Value *FAD) { this->FAD = FAD; }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001061
Tobias Grosser75805372011-04-29 06:27:02 +00001062void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +00001063 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001064 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001065 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001066 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001067 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001068 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001069 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +00001070 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +00001071 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +00001072 break;
1073 }
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001074
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +00001075 OS << "[Reduction Type: " << getReductionType() << "] ";
Siddharth Bhatf2dbba82017-05-10 13:11:20 +00001076
1077 if (FAD) {
1078 OS << "[Fortran array descriptor: " << FAD->getName();
1079 OS << "] ";
1080 };
1081
Tobias Grossera535dff2015-12-13 19:59:01 +00001082 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +00001083 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +00001084 if (hasNewAccessRelation())
1085 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001086}
1087
Michael Kruse5d518462017-07-21 15:54:07 +00001088#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001089LLVM_DUMP_METHOD void MemoryAccess::dump() const { print(errs()); }
Michael Kruse5d518462017-07-21 15:54:07 +00001090#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001091
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001092__isl_give isl_pw_aff *MemoryAccess::getPwAff(const SCEV *E) {
1093 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +00001094 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
Tobias Grosser53292772016-07-11 12:01:26 +00001095 isl_set *StmtDom = isl_set_reset_tuple_id(getStatement()->getDomain());
1096 isl_set *NewInvalidDom = isl_set_intersect(StmtDom, PWAC.second);
1097 InvalidDomain = isl_set_union(InvalidDomain, NewInvalidDom);
Johannes Doerfert85676e32016-04-23 14:32:34 +00001098 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +00001099}
1100
Tobias Grosser75805372011-04-29 06:27:02 +00001101// Create a map in the size of the provided set domain, that maps from the
1102// one element of the provided set domain to another element of the provided
1103// set domain.
1104// The mapping is limited to all points that are equal in all but the last
1105// dimension and for which the last dimension of the input is strict smaller
1106// than the last dimension of the output.
1107//
1108// getEqualAndLarger(set[i0, i1, ..., iX]):
1109//
1110// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
1111// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
1112//
Tobias Grosser2a526fe2016-09-08 11:18:56 +00001113static isl_map *getEqualAndLarger(__isl_take isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +00001114 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +00001115 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +00001116 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +00001117
1118 // Set all but the last dimension to be equal for the input and output
1119 //
1120 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
1121 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +00001122 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +00001123 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +00001124
1125 // Set the last dimension of the input to be strict smaller than the
1126 // last dimension of the output.
1127 //
1128 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +00001129 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
1130 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +00001131 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +00001132}
1133
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001134__isl_give isl_set *
1135MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +00001136 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +00001137 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +00001138 isl_space *Space = isl_space_range(isl_map_get_space(S));
1139 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +00001140
Sebastian Popa00a0292012-12-18 07:46:06 +00001141 S = isl_map_reverse(S);
1142 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +00001143
Sebastian Popa00a0292012-12-18 07:46:06 +00001144 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
1145 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
1146 NextScatt = isl_map_apply_domain(NextScatt, S);
1147 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +00001148
Sebastian Popa00a0292012-12-18 07:46:06 +00001149 isl_set *Deltas = isl_map_deltas(NextScatt);
1150 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +00001151}
1152
Sebastian Popa00a0292012-12-18 07:46:06 +00001153bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +00001154 int StrideWidth) const {
1155 isl_set *Stride, *StrideX;
1156 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +00001157
Sebastian Popa00a0292012-12-18 07:46:06 +00001158 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +00001159 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +00001160 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
1161 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
1162 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
1163 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +00001164 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +00001165
Tobias Grosser28dd4862012-01-24 16:42:16 +00001166 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +00001167 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001168
Tobias Grosser28dd4862012-01-24 16:42:16 +00001169 return IsStrideX;
1170}
1171
Michael Krused56b90a2016-09-01 09:03:27 +00001172bool MemoryAccess::isStrideZero(__isl_take const isl_map *Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001173 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001174}
1175
Michael Krused56b90a2016-09-01 09:03:27 +00001176bool MemoryAccess::isStrideOne(__isl_take const isl_map *Schedule) const {
Sebastian Popa00a0292012-12-18 07:46:06 +00001177 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001178}
1179
Tobias Grosserbedef002016-12-02 08:10:56 +00001180void MemoryAccess::setAccessRelation(__isl_take isl_map *NewAccess) {
Tobias Grosser0c4c2ee2017-07-23 04:08:22 +00001181 AccessRelation = isl::manage(NewAccess);
Tobias Grosserbedef002016-12-02 08:10:56 +00001182}
1183
Michael Krused56b90a2016-09-01 09:03:27 +00001184void MemoryAccess::setNewAccessRelation(__isl_take isl_map *NewAccess) {
Michael Kruse772ce722016-09-01 19:16:58 +00001185 assert(NewAccess);
1186
1187#ifndef NDEBUG
1188 // Check domain space compatibility.
1189 auto *NewSpace = isl_map_get_space(NewAccess);
1190 auto *NewDomainSpace = isl_space_domain(isl_space_copy(NewSpace));
1191 auto *OriginalDomainSpace = getStatement()->getDomainSpace();
1192 assert(isl_space_has_equal_tuples(OriginalDomainSpace, NewDomainSpace));
1193 isl_space_free(NewDomainSpace);
1194 isl_space_free(OriginalDomainSpace);
1195
Michael Kruse706f79a2017-05-21 22:46:57 +00001196 // Reads must be executed unconditionally. Writes might be executed in a
1197 // subdomain only.
1198 if (isRead()) {
1199 // Check whether there is an access for every statement instance.
1200 auto *StmtDomain = getStatement()->getDomain();
1201 StmtDomain = isl_set_intersect_params(
1202 StmtDomain, getStatement()->getParent()->getContext());
1203 auto *NewDomain = isl_map_domain(isl_map_copy(NewAccess));
1204 assert(isl_set_is_subset(StmtDomain, NewDomain) &&
1205 "Partial READ accesses not supported");
1206 isl_set_free(NewDomain);
1207 isl_set_free(StmtDomain);
1208 }
Michael Kruse772ce722016-09-01 19:16:58 +00001209
Michael Kruse772ce722016-09-01 19:16:58 +00001210 auto *NewAccessSpace = isl_space_range(NewSpace);
1211 assert(isl_space_has_tuple_id(NewAccessSpace, isl_dim_set) &&
1212 "Must specify the array that is accessed");
1213 auto *NewArrayId = isl_space_get_tuple_id(NewAccessSpace, isl_dim_set);
1214 auto *SAI = static_cast<ScopArrayInfo *>(isl_id_get_user(NewArrayId));
1215 assert(SAI && "Must set a ScopArrayInfo");
Tobias Grossere1ff0cf2017-01-17 12:00:42 +00001216
1217 if (SAI->isArrayKind() && SAI->getBasePtrOriginSAI()) {
1218 InvariantEquivClassTy *EqClass =
1219 getStatement()->getParent()->lookupInvariantEquivClass(
1220 SAI->getBasePtr());
1221 assert(EqClass &&
1222 "Access functions to indirect arrays must have an invariant and "
1223 "hoisted base pointer");
1224 }
1225
1226 // Check whether access dimensions correspond to number of dimensions of the
1227 // accesses array.
Michael Kruse772ce722016-09-01 19:16:58 +00001228 auto Dims = SAI->getNumberOfDimensions();
1229 assert(isl_space_dim(NewAccessSpace, isl_dim_set) == Dims &&
1230 "Access dims must match array dims");
1231 isl_space_free(NewAccessSpace);
1232 isl_id_free(NewArrayId);
1233#endif
1234
Tobias Grosser166c4222015-09-05 07:46:40 +00001235 isl_map_free(NewAccessRelation);
Tobias Grosser4556c9b2017-07-17 20:47:10 +00001236 NewAccess = isl_map_gist_domain(NewAccess, getStatement()->getDomain());
Tobias Grosser166c4222015-09-05 07:46:40 +00001237 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001238}
Tobias Grosser75805372011-04-29 06:27:02 +00001239
Michael Kruse706f79a2017-05-21 22:46:57 +00001240bool MemoryAccess::isLatestPartialAccess() const {
1241 isl::set StmtDom = give(getStatement()->getDomain());
1242 isl::set AccDom = give(isl_map_domain(getLatestAccessRelation()));
1243
1244 return isl_set_is_subset(StmtDom.keep(), AccDom.keep()) == isl_bool_false;
1245}
1246
Tobias Grosser75805372011-04-29 06:27:02 +00001247//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001248
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001249__isl_give isl_map *ScopStmt::getSchedule() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001250 isl_set *Domain = getDomain();
1251 if (isl_set_is_empty(Domain)) {
1252 isl_set_free(Domain);
1253 return isl_map_from_aff(
1254 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1255 }
1256 auto *Schedule = getParent()->getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001257 if (!Schedule) {
1258 isl_set_free(Domain);
1259 return nullptr;
1260 }
Tobias Grosser808cd692015-07-14 09:33:13 +00001261 Schedule = isl_union_map_intersect_domain(
1262 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
1263 if (isl_union_map_is_empty(Schedule)) {
1264 isl_set_free(Domain);
1265 isl_union_map_free(Schedule);
1266 return isl_map_from_aff(
1267 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1268 }
1269 auto *M = isl_map_from_union_map(Schedule);
1270 M = isl_map_coalesce(M);
1271 M = isl_map_gist_domain(M, Domain);
1272 M = isl_map_coalesce(M);
1273 return M;
1274}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001275
Tobias Grosser37eb4222014-02-20 21:43:54 +00001276void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
1277 assert(isl_set_is_subset(NewDomain, Domain) &&
1278 "New domain is not a subset of old domain!");
1279 isl_set_free(Domain);
1280 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001281}
1282
Michael Krusecac948e2015-10-02 13:53:07 +00001283void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +00001284 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +00001285 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00001286 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001287
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001288 MemoryKind Ty;
Tobias Grossera535dff2015-12-13 19:59:01 +00001289 if (Access->isPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001290 Ty = MemoryKind::PHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001291 else if (Access->isExitPHIKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001292 Ty = MemoryKind::ExitPHI;
Tobias Grossera535dff2015-12-13 19:59:01 +00001293 else if (Access->isValueKind())
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001294 Ty = MemoryKind::Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001295 else
Tobias Grosser4d5a9172017-01-14 20:25:44 +00001296 Ty = MemoryKind::Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001297
Tobias Grosser296fe2e2017-02-10 10:09:46 +00001298 auto *SAI = S.getOrCreateScopArrayInfo(Access->getOriginalBaseAddr(),
1299 ElementType, Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001300 Access->buildAccessRelation(SAI);
Michael Kruse8b805802017-07-19 17:11:25 +00001301 S.addAccessData(Access);
Tobias Grosser75805372011-04-29 06:27:02 +00001302 }
1303}
1304
Michael Krusecac948e2015-10-02 13:53:07 +00001305void ScopStmt::addAccess(MemoryAccess *Access) {
1306 Instruction *AccessInst = Access->getAccessInstruction();
1307
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001308 if (Access->isArrayKind()) {
1309 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1310 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001311 } else if (Access->isValueKind() && Access->isWrite()) {
1312 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001313 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001314 assert(!ValueWrites.lookup(AccessVal));
1315
1316 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001317 } else if (Access->isValueKind() && Access->isRead()) {
1318 Value *AccessVal = Access->getAccessValue();
1319 assert(!ValueReads.lookup(AccessVal));
1320
1321 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001322 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
Tobias Grosser5db171a2017-02-10 10:09:44 +00001323 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001324 assert(!PHIWrites.lookup(PHI));
1325
1326 PHIWrites[PHI] = Access;
Michael Kruse3562f272017-07-20 16:47:57 +00001327 } else if (Access->isAnyPHIKind() && Access->isRead()) {
1328 PHINode *PHI = cast<PHINode>(Access->getAccessValue());
1329 assert(!PHIReads.lookup(PHI));
1330
1331 PHIReads[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001332 }
1333
1334 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001335}
1336
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001337void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001338 for (MemoryAccess *MA : *this)
1339 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001340
Johannes Doerferta60ad842016-05-10 12:18:22 +00001341 auto *Ctx = Parent.getContext();
1342 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
1343 Domain = isl_set_gist_params(Domain, Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001344}
1345
Tobias Grosserc80d6972016-09-02 06:33:33 +00001346/// Add @p BSet to the set @p User if @p BSet is bounded.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001347static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1348 void *User) {
1349 isl_set **BoundedParts = static_cast<isl_set **>(User);
1350 if (isl_basic_set_is_bounded(BSet))
1351 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1352 else
1353 isl_basic_set_free(BSet);
1354 return isl_stat_ok;
1355}
1356
Tobias Grosserc80d6972016-09-02 06:33:33 +00001357/// Return the bounded parts of @p S.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001358static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1359 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1360 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1361 isl_set_free(S);
1362 return BoundedParts;
1363}
1364
Tobias Grosserc80d6972016-09-02 06:33:33 +00001365/// Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001366///
1367/// @returns A separation of @p S into first an unbounded then a bounded subset,
1368/// both with regards to the dimension @p Dim.
1369static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1370partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1371
1372 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001373 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001374
1375 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001376 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001377
1378 // Remove dimensions that are greater than Dim as they are not interesting.
1379 assert(NumDimsS >= Dim + 1);
1380 OnlyDimS =
1381 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1382
1383 // Create artificial parametric upper bounds for dimensions smaller than Dim
1384 // as we are not interested in them.
1385 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1386 for (unsigned u = 0; u < Dim; u++) {
1387 isl_constraint *C = isl_inequality_alloc(
1388 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1389 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1390 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1391 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1392 }
1393
1394 // Collect all bounded parts of OnlyDimS.
1395 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1396
1397 // Create the dimensions greater than Dim again.
1398 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1399 NumDimsS - Dim - 1);
1400
1401 // Remove the artificial upper bound parameters again.
1402 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1403
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001404 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001405 return std::make_pair(UnboundedParts, BoundedParts);
1406}
1407
Tobias Grosserc80d6972016-09-02 06:33:33 +00001408/// Set the dimension Ids from @p From in @p To.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001409static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1410 __isl_take isl_set *To) {
1411 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1412 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1413 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1414 }
1415 return To;
1416}
1417
Tobias Grosserc80d6972016-09-02 06:33:33 +00001418/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001419static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001420 __isl_take isl_pw_aff *L,
1421 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001422 switch (Pred) {
1423 case ICmpInst::ICMP_EQ:
1424 return isl_pw_aff_eq_set(L, R);
1425 case ICmpInst::ICMP_NE:
1426 return isl_pw_aff_ne_set(L, R);
1427 case ICmpInst::ICMP_SLT:
1428 return isl_pw_aff_lt_set(L, R);
1429 case ICmpInst::ICMP_SLE:
1430 return isl_pw_aff_le_set(L, R);
1431 case ICmpInst::ICMP_SGT:
1432 return isl_pw_aff_gt_set(L, R);
1433 case ICmpInst::ICMP_SGE:
1434 return isl_pw_aff_ge_set(L, R);
1435 case ICmpInst::ICMP_ULT:
1436 return isl_pw_aff_lt_set(L, R);
1437 case ICmpInst::ICMP_UGT:
1438 return isl_pw_aff_gt_set(L, R);
1439 case ICmpInst::ICMP_ULE:
1440 return isl_pw_aff_le_set(L, R);
1441 case ICmpInst::ICMP_UGE:
1442 return isl_pw_aff_ge_set(L, R);
1443 default:
1444 llvm_unreachable("Non integer predicate not supported");
1445 }
1446}
1447
Tobias Grosserc80d6972016-09-02 06:33:33 +00001448/// Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001449///
1450/// Helper function that will make sure the dimensions of the result have the
1451/// same isl_id's as the @p Domain.
1452static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1453 __isl_take isl_pw_aff *L,
1454 __isl_take isl_pw_aff *R,
1455 __isl_keep isl_set *Domain) {
1456 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1457 return setDimensionIds(Domain, ConsequenceCondSet);
1458}
1459
Michael Kruse476f8552017-06-29 12:47:41 +00001460/// Compute the isl representation for the SCEV @p E in this BB.
1461///
1462/// @param S The Scop in which @p BB resides in.
1463/// @param BB The BB for which isl representation is to be
1464/// computed.
1465/// @param InvalidDomainMap A map of BB to their invalid domains.
1466/// @param E The SCEV that should be translated.
1467/// @param NonNegative Flag to indicate the @p E has to be non-negative.
1468///
1469/// Note that this function will also adjust the invalid context accordingly.
1470
1471__isl_give isl_pw_aff *
1472getPwAff(Scop &S, BasicBlock *BB,
Tobias Grosser13acbb92017-07-15 09:01:31 +00001473 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap, const SCEV *E,
1474 bool NonNegative = false) {
Michael Kruse476f8552017-06-29 12:47:41 +00001475 PWACtx PWAC = S.getPwAff(E, BB, NonNegative);
Tobias Grosser13acbb92017-07-15 09:01:31 +00001476 InvalidDomainMap[BB] = InvalidDomainMap[BB].unite(isl::manage(PWAC.second));
Michael Kruse476f8552017-06-29 12:47:41 +00001477 return PWAC.first;
1478}
1479
Tobias Grosserc80d6972016-09-02 06:33:33 +00001480/// Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001481///
1482/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001483/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1484/// have as many elements as @p SI has successors.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001485static bool
1486buildConditionSets(Scop &S, BasicBlock *BB, SwitchInst *SI, Loop *L,
1487 __isl_keep isl_set *Domain,
1488 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1489 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001490
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001491 Value *Condition = getConditionFromTerminator(SI);
1492 assert(Condition && "No condition for switch");
1493
1494 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001495 isl_pw_aff *LHS, *RHS;
Michael Kruse476f8552017-06-29 12:47:41 +00001496 LHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001497
1498 unsigned NumSuccessors = SI->getNumSuccessors();
1499 ConditionSets.resize(NumSuccessors);
1500 for (auto &Case : SI->cases()) {
1501 unsigned Idx = Case.getSuccessorIndex();
1502 ConstantInt *CaseValue = Case.getCaseValue();
1503
Michael Kruse476f8552017-06-29 12:47:41 +00001504 RHS = getPwAff(S, BB, InvalidDomainMap, SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001505 isl_set *CaseConditionSet =
1506 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1507 ConditionSets[Idx] = isl_set_coalesce(
1508 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1509 }
1510
1511 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1512 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1513 for (unsigned u = 2; u < NumSuccessors; u++)
1514 ConditionSetUnion =
1515 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1516 ConditionSets[0] = setDimensionIds(
1517 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1518
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001519 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001520
1521 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001522}
1523
Michael Kruse08655852017-07-20 12:37:02 +00001524/// Build condition sets for unsigned ICmpInst(s).
1525/// Special handling is required for unsigned operands to ensure that if
1526/// MSB (aka the Sign bit) is set for an operands in an unsigned ICmpInst
1527/// it should wrap around.
1528///
1529/// @param IsStrictUpperBound holds information on the predicate relation
1530/// between TestVal and UpperBound, i.e,
1531/// TestVal < UpperBound OR TestVal <= UpperBound
1532static __isl_give isl_set *
1533buildUnsignedConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1534 __isl_keep isl_set *Domain, const SCEV *SCEV_TestVal,
1535 const SCEV *SCEV_UpperBound,
1536 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1537 bool IsStrictUpperBound) {
1538
1539 // Do not take NonNeg assumption on TestVal
1540 // as it might have MSB (Sign bit) set.
1541 isl_pw_aff *TestVal = getPwAff(S, BB, InvalidDomainMap, SCEV_TestVal, false);
1542 // Take NonNeg assumption on UpperBound.
1543 isl_pw_aff *UpperBound =
1544 getPwAff(S, BB, InvalidDomainMap, SCEV_UpperBound, true);
1545
1546 // 0 <= TestVal
1547 isl_set *First =
1548 isl_pw_aff_le_set(isl_pw_aff_zero_on_domain(isl_local_space_from_space(
1549 isl_pw_aff_get_domain_space(TestVal))),
1550 isl_pw_aff_copy(TestVal));
1551
1552 isl_set *Second;
1553 if (IsStrictUpperBound)
1554 // TestVal < UpperBound
1555 Second = isl_pw_aff_lt_set(TestVal, UpperBound);
1556 else
1557 // TestVal <= UpperBound
1558 Second = isl_pw_aff_le_set(TestVal, UpperBound);
1559
1560 isl_set *ConsequenceCondSet = isl_set_intersect(First, Second);
1561 ConsequenceCondSet = setDimensionIds(Domain, ConsequenceCondSet);
1562 return ConsequenceCondSet;
1563}
1564
Tobias Grosserc80d6972016-09-02 06:33:33 +00001565/// Build the conditions sets for the branch condition @p Condition in
1566/// the @p Domain.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001567///
1568/// This will fill @p ConditionSets with the conditions under which control
1569/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001570/// have as many elements as @p TI has successors. If @p TI is nullptr the
1571/// context under which @p Condition is true/false will be returned as the
1572/// new elements of @p ConditionSets.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001573static bool
1574buildConditionSets(Scop &S, BasicBlock *BB, Value *Condition,
1575 TerminatorInst *TI, Loop *L, __isl_keep isl_set *Domain,
1576 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1577 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001578
1579 isl_set *ConsequenceCondSet = nullptr;
1580 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1581 if (CCond->isZero())
1582 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1583 else
1584 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1585 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1586 auto Opcode = BinOp->getOpcode();
1587 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1588
Michael Kruse476f8552017-06-29 12:47:41 +00001589 bool Valid = buildConditionSets(S, BB, BinOp->getOperand(0), TI, L, Domain,
1590 InvalidDomainMap, ConditionSets) &&
1591 buildConditionSets(S, BB, BinOp->getOperand(1), TI, L, Domain,
1592 InvalidDomainMap, ConditionSets);
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001593 if (!Valid) {
1594 while (!ConditionSets.empty())
1595 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001596 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001597 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001598
1599 isl_set_free(ConditionSets.pop_back_val());
1600 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1601 isl_set_free(ConditionSets.pop_back_val());
1602 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1603
1604 if (Opcode == Instruction::And)
1605 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1606 else
1607 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1608 } else {
1609 auto *ICond = dyn_cast<ICmpInst>(Condition);
1610 assert(ICond &&
1611 "Condition of exiting branch was neither constant nor ICmp!");
1612
1613 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001614 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001615 // For unsigned comparisons we assumed the signed bit of neither operand
1616 // to be set. The comparison is equal to a signed comparison under this
1617 // assumption.
1618 bool NonNeg = ICond->isUnsigned();
Michael Kruse08655852017-07-20 12:37:02 +00001619 const SCEV *LeftOperand = SE.getSCEVAtScope(ICond->getOperand(0), L),
1620 *RightOperand = SE.getSCEVAtScope(ICond->getOperand(1), L);
1621
1622 switch (ICond->getPredicate()) {
1623 case ICmpInst::ICMP_ULT:
1624 ConsequenceCondSet =
1625 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1626 RightOperand, InvalidDomainMap, true);
1627 break;
1628 case ICmpInst::ICMP_ULE:
1629 ConsequenceCondSet =
1630 buildUnsignedConditionSets(S, BB, Condition, Domain, LeftOperand,
1631 RightOperand, InvalidDomainMap, false);
1632 break;
1633 case ICmpInst::ICMP_UGT:
1634 ConsequenceCondSet =
1635 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1636 LeftOperand, InvalidDomainMap, true);
1637 break;
1638 case ICmpInst::ICMP_UGE:
1639 ConsequenceCondSet =
1640 buildUnsignedConditionSets(S, BB, Condition, Domain, RightOperand,
1641 LeftOperand, InvalidDomainMap, false);
1642 break;
1643 default:
1644 LHS = getPwAff(S, BB, InvalidDomainMap, LeftOperand, NonNeg);
1645 RHS = getPwAff(S, BB, InvalidDomainMap, RightOperand, NonNeg);
1646 ConsequenceCondSet =
1647 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1648 break;
1649 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001650 }
1651
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001652 // If no terminator was given we are only looking for parameter constraints
1653 // under which @p Condition is true/false.
1654 if (!TI)
1655 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001656 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001657 ConsequenceCondSet = isl_set_coalesce(
1658 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001659
Johannes Doerfertb2885792016-04-26 09:20:41 +00001660 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001661 bool TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001662 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001663
Michael Krusef7a4a942016-05-02 12:25:36 +00001664 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001665 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1666 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001667 TooComplex =
Tobias Grosser90411a92017-02-16 19:11:33 +00001668 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001669 }
1670
Michael Krusef7a4a942016-05-02 12:25:36 +00001671 if (TooComplex) {
Eli Friedmane737fc12017-07-17 23:58:33 +00001672 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc(),
1673 TI ? TI->getParent() : nullptr /* BasicBlock */);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001674 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001675 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001676 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001677 }
1678
1679 ConditionSets.push_back(ConsequenceCondSet);
1680 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001681
1682 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001683}
1684
Tobias Grosserc80d6972016-09-02 06:33:33 +00001685/// Build the conditions sets for the terminator @p TI in the @p Domain.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001686///
1687/// This will fill @p ConditionSets with the conditions under which control
1688/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1689/// have as many elements as @p TI has successors.
Tobias Grosser13acbb92017-07-15 09:01:31 +00001690static bool
1691buildConditionSets(Scop &S, BasicBlock *BB, TerminatorInst *TI, Loop *L,
1692 __isl_keep isl_set *Domain,
1693 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap,
1694 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001695
1696 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Michael Kruse476f8552017-06-29 12:47:41 +00001697 return buildConditionSets(S, BB, SI, L, Domain, InvalidDomainMap,
1698 ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001699
1700 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1701
1702 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001703 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001704 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001705 }
1706
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001707 Value *Condition = getConditionFromTerminator(TI);
1708 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001709
Michael Kruse476f8552017-06-29 12:47:41 +00001710 return buildConditionSets(S, BB, Condition, TI, L, Domain, InvalidDomainMap,
1711 ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001712}
1713
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001714void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001715 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001716
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001717 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001718 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001719}
1720
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001721void ScopStmt::collectSurroundingLoops() {
1722 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1723 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1724 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1725 isl_id_free(DimId);
1726 }
1727}
1728
Michael Kruse55454072017-03-15 22:16:43 +00001729ScopStmt::ScopStmt(Scop &parent, Region &R, Loop *SurroundingLoop)
Johannes Doerferta3519512016-04-23 13:02:23 +00001730 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
Michael Kruse55454072017-03-15 22:16:43 +00001731 R(&R), Build(nullptr), SurroundingLoop(SurroundingLoop) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001732
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001733 BaseName = getIslCompatibleName(
1734 "Stmt", R.getNameStr(), parent.getNextStmtIdx(), "", UseInstructionNames);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001735}
1736
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001737ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb, Loop *SurroundingLoop,
1738 std::vector<Instruction *> Instructions)
Johannes Doerferta3519512016-04-23 13:02:23 +00001739 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001740 R(nullptr), Build(nullptr), SurroundingLoop(SurroundingLoop),
1741 Instructions(Instructions) {
Tobias Grosser75805372011-04-29 06:27:02 +00001742
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00001743 BaseName = getIslCompatibleName("Stmt", &bb, parent.getNextStmtIdx(), "",
1744 UseInstructionNames);
Michael Krusecac948e2015-10-02 13:53:07 +00001745}
1746
Roman Gareevb3224ad2016-09-14 06:26:09 +00001747ScopStmt::ScopStmt(Scop &parent, __isl_take isl_map *SourceRel,
1748 __isl_take isl_map *TargetRel, __isl_take isl_set *NewDomain)
1749 : Parent(parent), InvalidDomain(nullptr), Domain(NewDomain), BB(nullptr),
1750 R(nullptr), Build(nullptr) {
1751 BaseName = getIslCompatibleName("CopyStmt_", "",
1752 std::to_string(parent.getCopyStmtsNum()));
1753 auto *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1754 Domain = isl_set_set_tuple_id(Domain, isl_id_copy(Id));
1755 TargetRel = isl_map_set_tuple_id(TargetRel, isl_dim_in, Id);
1756 auto *Access =
1757 new MemoryAccess(this, MemoryAccess::AccessType::MUST_WRITE, TargetRel);
1758 parent.addAccessFunction(Access);
1759 addAccess(Access);
1760 SourceRel = isl_map_set_tuple_id(SourceRel, isl_dim_in, isl_id_copy(Id));
1761 Access = new MemoryAccess(this, MemoryAccess::AccessType::READ, SourceRel);
1762 parent.addAccessFunction(Access);
1763 addAccess(Access);
1764}
1765
Johannes Doerfertffd222f2016-05-19 12:34:57 +00001766void ScopStmt::init(LoopInfo &LI) {
Michael Krusecac948e2015-10-02 13:53:07 +00001767 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001768
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001769 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001770 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001771 buildAccessRelations();
1772
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001773 if (DetectReductions)
1774 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001775}
1776
Tobias Grosserc80d6972016-09-02 06:33:33 +00001777/// Collect loads which might form a reduction chain with @p StoreMA.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001778///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001779/// Check if the stored value for @p StoreMA is a binary operator with one or
1780/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001781/// used only once (by @p StoreMA) and its load operands are also used only
1782/// once, we have found a possible reduction chain. It starts at an operand
1783/// load and includes the binary operator and @p StoreMA.
1784///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001785/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001786/// escape this block or into any other store except @p StoreMA.
1787void ScopStmt::collectCandiateReductionLoads(
1788 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1789 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1790 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001791 return;
1792
1793 // Skip if there is not one binary operator between the load and the store
1794 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001795 if (!BinOp)
1796 return;
1797
1798 // Skip if the binary operators has multiple uses
1799 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001800 return;
1801
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001802 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001803 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1804 return;
1805
Johannes Doerfert9890a052014-07-01 00:32:29 +00001806 // Skip if the binary operator is outside the current SCoP
1807 if (BinOp->getParent() != Store->getParent())
1808 return;
1809
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001810 // Skip if it is a multiplicative reduction and we disabled them
1811 if (DisableMultiplicativeReductions &&
1812 (BinOp->getOpcode() == Instruction::Mul ||
1813 BinOp->getOpcode() == Instruction::FMul))
1814 return;
1815
Johannes Doerferte58a0122014-06-27 20:31:28 +00001816 // Check the binary operator operands for a candidate load
1817 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1818 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1819 if (!PossibleLoad0 && !PossibleLoad1)
1820 return;
1821
1822 // A load is only a candidate if it cannot escape (thus has only this use)
1823 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001824 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001825 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001826 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001827 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001828 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001829}
1830
Tobias Grosserc80d6972016-09-02 06:33:33 +00001831/// Check for reductions in this ScopStmt.
Johannes Doerferte58a0122014-06-27 20:31:28 +00001832///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001833/// Iterate over all store memory accesses and check for valid binary reduction
1834/// like chains. For all candidates we check if they have the same base address
1835/// and there are no other accesses which overlap with them. The base address
1836/// check rules out impossible reductions candidates early. The overlap check,
1837/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001838/// guarantees that none of the intermediate results will escape during
1839/// execution of the loop nest. We basically check here that no other memory
1840/// access can access the same memory as the potential reduction.
1841void ScopStmt::checkForReductions() {
1842 SmallVector<MemoryAccess *, 2> Loads;
1843 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1844
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001845 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001846 // stores and collecting possible reduction loads.
1847 for (MemoryAccess *StoreMA : MemAccs) {
1848 if (StoreMA->isRead())
1849 continue;
1850
1851 Loads.clear();
1852 collectCandiateReductionLoads(StoreMA, Loads);
1853 for (MemoryAccess *LoadMA : Loads)
1854 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1855 }
1856
1857 // Then check each possible candidate pair.
1858 for (const auto &CandidatePair : Candidates) {
1859 bool Valid = true;
1860 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1861 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1862
1863 // Skip those with obviously unequal base addresses.
1864 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1865 isl_map_free(LoadAccs);
1866 isl_map_free(StoreAccs);
1867 continue;
1868 }
1869
1870 // And check if the remaining for overlap with other memory accesses.
1871 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1872 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1873 isl_set *AllAccs = isl_map_range(AllAccsRel);
1874
1875 for (MemoryAccess *MA : MemAccs) {
1876 if (MA == CandidatePair.first || MA == CandidatePair.second)
1877 continue;
1878
1879 isl_map *AccRel =
1880 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1881 isl_set *Accs = isl_map_range(AccRel);
1882
Tobias Grosser55a7af72016-09-08 14:08:07 +00001883 if (isl_set_has_equal_space(AllAccs, Accs)) {
Johannes Doerferte58a0122014-06-27 20:31:28 +00001884 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1885 Valid = Valid && isl_set_is_empty(OverlapAccs);
1886 isl_set_free(OverlapAccs);
Tobias Grosser55a7af72016-09-08 14:08:07 +00001887 } else {
1888 isl_set_free(Accs);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001889 }
1890 }
1891
1892 isl_set_free(AllAccs);
1893 if (!Valid)
1894 continue;
1895
Johannes Doerfertf6183392014-07-01 20:52:51 +00001896 const LoadInst *Load =
1897 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1898 MemoryAccess::ReductionType RT =
1899 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1900
Johannes Doerferte58a0122014-06-27 20:31:28 +00001901 // If no overlapping access was found we mark the load and store as
1902 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001903 CandidatePair.first->markAsReductionLike(RT);
1904 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001905 }
Tobias Grosser75805372011-04-29 06:27:02 +00001906}
1907
Tobias Grosser74394f02013-01-14 22:40:23 +00001908std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001909
Tobias Grosser54839312015-04-21 11:37:25 +00001910std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001911 auto *S = getSchedule();
Roman Gareevb3224ad2016-09-14 06:26:09 +00001912 if (!S)
1913 return "";
Tobias Grosser808cd692015-07-14 09:33:13 +00001914 auto Str = stringFromIslObj(S);
1915 isl_map_free(S);
1916 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001917}
1918
Johannes Doerferta3519512016-04-23 13:02:23 +00001919void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1920 isl_set_free(InvalidDomain);
1921 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001922}
1923
Michael Kruse375cb5f2016-02-24 22:08:24 +00001924BasicBlock *ScopStmt::getEntryBlock() const {
1925 if (isBlockStmt())
1926 return getBasicBlock();
1927 return getRegion()->getEntry();
1928}
1929
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001930unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001931
Tobias Grosser75805372011-04-29 06:27:02 +00001932const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1933
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001934Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001935 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001936}
1937
Tobias Grosser74394f02013-01-14 22:40:23 +00001938isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001939
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001940__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001941
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001942__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001943 return isl_set_get_space(Domain);
1944}
1945
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001946__isl_give isl_id *ScopStmt::getDomainId() const {
1947 return isl_set_get_tuple_id(Domain);
1948}
Tobias Grossercd95b772012-08-30 11:49:38 +00001949
Johannes Doerfert7c013572016-04-12 09:57:34 +00001950ScopStmt::~ScopStmt() {
1951 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001952 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001953}
Tobias Grosser75805372011-04-29 06:27:02 +00001954
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001955void ScopStmt::printInstructions(raw_ostream &OS) const {
1956 OS << "Instructions {\n";
1957
1958 for (Instruction *Inst : Instructions)
1959 OS.indent(16) << *Inst << "\n";
1960
Michael Krusee52ebd12017-07-22 16:44:39 +00001961 OS.indent(12) << "}\n";
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001962}
1963
Michael Krusecd4c9772017-07-21 15:35:53 +00001964void ScopStmt::print(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00001965 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001966 OS.indent(12) << "Domain :=\n";
1967
1968 if (Domain) {
1969 OS.indent(16) << getDomainStr() << ";\n";
1970 } else
1971 OS.indent(16) << "n/a\n";
1972
Tobias Grosser54839312015-04-21 11:37:25 +00001973 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001974
1975 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001976 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001977 } else
1978 OS.indent(16) << "n/a\n";
1979
Tobias Grosser083d3d32014-06-28 08:59:45 +00001980 for (MemoryAccess *Access : MemAccs)
1981 Access->print(OS);
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001982
Michael Krusecd4c9772017-07-21 15:35:53 +00001983 if (PrintInstructions)
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00001984 printInstructions(OS.indent(12));
Tobias Grosser75805372011-04-29 06:27:02 +00001985}
1986
Michael Kruse5d518462017-07-21 15:54:07 +00001987#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00001988LLVM_DUMP_METHOD void ScopStmt::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00001989#endif
Tobias Grosser75805372011-04-29 06:27:02 +00001990
Michael Krusee60eca72017-05-11 22:56:12 +00001991void ScopStmt::removeAccessData(MemoryAccess *MA) {
1992 if (MA->isRead() && MA->isOriginalValueKind()) {
1993 bool Found = ValueReads.erase(MA->getAccessValue());
1994 (void)Found;
1995 assert(Found && "Expected access data not found");
1996 }
1997 if (MA->isWrite() && MA->isOriginalValueKind()) {
1998 bool Found = ValueWrites.erase(cast<Instruction>(MA->getAccessValue()));
1999 (void)Found;
2000 assert(Found && "Expected access data not found");
2001 }
2002 if (MA->isWrite() && MA->isOriginalAnyPHIKind()) {
2003 bool Found = PHIWrites.erase(cast<PHINode>(MA->getAccessInstruction()));
2004 (void)Found;
2005 assert(Found && "Expected access data not found");
2006 }
Michael Kruse3562f272017-07-20 16:47:57 +00002007 if (MA->isRead() && MA->isOriginalAnyPHIKind()) {
2008 bool Found = PHIReads.erase(cast<PHINode>(MA->getAccessInstruction()));
2009 (void)Found;
2010 assert(Found && "Expected access data not found");
2011 }
Michael Krusee60eca72017-05-11 22:56:12 +00002012}
2013
Michael Kruse10071822016-05-23 14:45:58 +00002014void ScopStmt::removeMemoryAccess(MemoryAccess *MA) {
Tobias Grosser4d5a9172017-01-14 20:25:44 +00002015 // Remove the memory accesses from this statement together with all scalar
2016 // accesses that were caused by it. MemoryKind::Value READs have no access
2017 // instruction, hence would not be removed by this function. However, it is
2018 // only used for invariant LoadInst accesses, its arguments are always affine,
2019 // hence synthesizable, and therefore there are no MemoryKind::Value READ
2020 // accesses to be removed.
Michael Kruse10071822016-05-23 14:45:58 +00002021 auto Predicate = [&](MemoryAccess *Acc) {
2022 return Acc->getAccessInstruction() == MA->getAccessInstruction();
2023 };
Michael Krusee60eca72017-05-11 22:56:12 +00002024 for (auto *MA : MemAccs) {
Michael Kruse8b805802017-07-19 17:11:25 +00002025 if (Predicate(MA)) {
Michael Krusee60eca72017-05-11 22:56:12 +00002026 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00002027 Parent.removeAccessData(MA);
2028 }
Michael Krusee60eca72017-05-11 22:56:12 +00002029 }
Michael Kruse10071822016-05-23 14:45:58 +00002030 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
2031 MemAccs.end());
2032 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002033}
2034
Michael Kruse0446d812017-03-10 16:05:24 +00002035void ScopStmt::removeSingleMemoryAccess(MemoryAccess *MA) {
2036 auto MAIt = std::find(MemAccs.begin(), MemAccs.end(), MA);
2037 assert(MAIt != MemAccs.end());
2038 MemAccs.erase(MAIt);
2039
Michael Krusee60eca72017-05-11 22:56:12 +00002040 removeAccessData(MA);
Michael Kruse8b805802017-07-19 17:11:25 +00002041 Parent.removeAccessData(MA);
Michael Krusee60eca72017-05-11 22:56:12 +00002042
Michael Kruse0446d812017-03-10 16:05:24 +00002043 auto It = InstructionToAccess.find(MA->getAccessInstruction());
2044 if (It != InstructionToAccess.end()) {
2045 It->second.remove(MA);
2046 if (It->second.empty())
2047 InstructionToAccess.erase(MA->getAccessInstruction());
2048 }
2049}
2050
Michael Krusecd4c9772017-07-21 15:35:53 +00002051raw_ostream &polly::operator<<(raw_ostream &O, const ScopStmt &S) {
2052 S.print(O, PollyPrintInstructions);
2053 return O;
2054}
2055
Tobias Grosser75805372011-04-29 06:27:02 +00002056//===----------------------------------------------------------------------===//
2057/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00002058
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00002059void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00002060 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
2061 isl_set_free(Context);
2062 Context = NewContext;
2063}
2064
Eli Friedman5e589ea2017-06-20 22:53:02 +00002065namespace {
Tobias Grosserc80d6972016-09-02 06:33:33 +00002066/// Remap parameter values but keep AddRecs valid wrt. invariant loads.
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002067struct SCEVSensitiveParameterRewriter
Tobias Grosser278f9e72016-11-26 17:58:40 +00002068 : public SCEVRewriteVisitor<SCEVSensitiveParameterRewriter> {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002069 ValueToValueMap &VMap;
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002070
2071public:
2072 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
Tobias Grosser278f9e72016-11-26 17:58:40 +00002073 : SCEVRewriteVisitor(SE), VMap(VMap) {}
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002074
2075 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
2076 ValueToValueMap &VMap) {
2077 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
2078 return SSPR.visit(E);
2079 }
2080
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00002081 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
2082 auto *Start = visit(E->getStart());
2083 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
2084 visit(E->getStepRecurrence(SE)),
2085 E->getLoop(), SCEV::FlagAnyWrap);
2086 return SE.getAddExpr(Start, AddRec);
2087 }
2088
2089 const SCEV *visitUnknown(const SCEVUnknown *E) {
2090 if (auto *NewValue = VMap.lookup(E->getValue()))
2091 return SE.getUnknown(NewValue);
2092 return E;
2093 }
2094};
2095
Eli Friedman5e589ea2017-06-20 22:53:02 +00002096/// Check whether we should remap a SCEV expression.
2097struct SCEVFindInsideScop : public SCEVTraversal<SCEVFindInsideScop> {
2098 ValueToValueMap &VMap;
2099 bool FoundInside = false;
2100 Scop *S;
2101
2102public:
2103 SCEVFindInsideScop(ValueToValueMap &VMap, ScalarEvolution &SE, Scop *S)
2104 : SCEVTraversal(*this), VMap(VMap), S(S) {}
2105
2106 static bool hasVariant(const SCEV *E, ScalarEvolution &SE,
2107 ValueToValueMap &VMap, Scop *S) {
2108 SCEVFindInsideScop SFIS(VMap, SE, S);
2109 SFIS.visitAll(E);
2110 return SFIS.FoundInside;
2111 }
2112
2113 bool follow(const SCEV *E) {
2114 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(E)) {
2115 FoundInside |= S->getRegion().contains(AddRec->getLoop());
2116 } else if (auto *Unknown = dyn_cast<SCEVUnknown>(E)) {
2117 if (Instruction *I = dyn_cast<Instruction>(Unknown->getValue()))
2118 FoundInside |= S->getRegion().contains(I) && !VMap.count(I);
2119 }
2120 return !FoundInside;
2121 }
2122 bool isDone() { return FoundInside; }
2123};
2124} // namespace
2125
2126const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *E) {
2127 // Check whether it makes sense to rewrite the SCEV. (ScalarEvolution
2128 // doesn't like addition between an AddRec and an expression that
2129 // doesn't have a dominance relationship with it.)
2130 if (SCEVFindInsideScop::hasVariant(E, *SE, InvEquivClassVMap, this))
2131 return E;
2132
2133 // Rewrite SCEV.
2134 return SCEVSensitiveParameterRewriter::rewrite(E, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002135}
2136
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002137// This table of function names is used to translate parameter names in more
2138// human-readable names. This makes it easier to interpret Polly analysis
2139// results.
2140StringMap<std::string> KnownNames = {
2141 {"_Z13get_global_idj", "global_id"},
2142 {"_Z12get_local_idj", "local_id"},
2143 {"_Z15get_global_sizej", "global_size"},
2144 {"_Z14get_local_sizej", "local_size"},
2145 {"_Z12get_work_dimv", "work_dim"},
2146 {"_Z17get_global_offsetj", "global_offset"},
2147 {"_Z12get_group_idj", "group_id"},
2148 {"_Z14get_num_groupsj", "num_groups"},
2149};
2150
2151static std::string getCallParamName(CallInst *Call) {
2152 std::string Result;
2153 raw_string_ostream OS(Result);
2154 std::string Name = Call->getCalledFunction()->getName();
2155
2156 auto Iterator = KnownNames.find(Name);
2157 if (Iterator != KnownNames.end())
Tobias Grosserdff902f2017-06-01 12:46:51 +00002158 Name = "__" + Iterator->getValue();
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002159 OS << Name;
2160 for (auto &Operand : Call->arg_operands()) {
2161 ConstantInt *Op = cast<ConstantInt>(&Operand);
2162 OS << "_" << Op->getValue();
2163 }
2164 OS.flush();
2165 return Result;
2166}
2167
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002168void Scop::createParameterId(const SCEV *Parameter) {
2169 assert(Parameters.count(Parameter));
2170 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002171
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002172 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002173
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002174 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
2175 Value *Val = ValueParameter->getValue();
2176 CallInst *Call = dyn_cast<CallInst>(Val);
Tobias Grosser8f99c162011-11-15 11:38:55 +00002177
Tobias Grosserf5e7e602017-05-27 15:18:46 +00002178 if (Call && isConstCall(Call)) {
2179 ParameterName = getCallParamName(Call);
2180 } else if (UseInstructionNames) {
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002181 // If this parameter references a specific Value and this value has a name
2182 // we use this name as it is likely to be unique and more useful than just
2183 // a number.
2184 if (Val->hasName())
2185 ParameterName = Val->getName();
2186 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
2187 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
2188 if (LoadOrigin->hasName()) {
2189 ParameterName += "_loaded_from_";
2190 ParameterName +=
2191 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
2192 }
Tobias Grosserb39c96a2015-11-17 11:54:51 +00002193 }
2194 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00002195
Tobias Grossere2ccc3f2017-05-03 20:08:52 +00002196 ParameterName = getIslCompatibleName("", ParameterName, "");
2197 }
Tobias Grosser2ea7c6e2016-07-01 13:40:28 +00002198
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002199 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
2200 const_cast<void *>((const void *)Parameter));
2201 ParameterIds[Parameter] = Id;
2202}
2203
2204void Scop::addParams(const ParameterSetTy &NewParameters) {
2205 for (const SCEV *Parameter : NewParameters) {
2206 // Normalize the SCEV to get the representing element for an invariant load.
2207 Parameter = extractConstantFactor(Parameter, *SE).second;
2208 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2209
2210 if (Parameters.insert(Parameter))
2211 createParameterId(Parameter);
2212 }
2213}
2214
2215__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
2216 // Normalize the SCEV to get the representing element for an invariant load.
2217 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
2218 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00002219}
Tobias Grosser75805372011-04-29 06:27:02 +00002220
Michael Krused56b90a2016-09-01 09:03:27 +00002221__isl_give isl_set *
2222Scop::addNonEmptyDomainConstraints(__isl_take isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002223 isl_set *DomainContext = isl_union_set_params(getDomains());
2224 return isl_set_intersect_params(C, DomainContext);
2225}
2226
Johannes Doerferte0b08072016-05-23 12:43:44 +00002227bool Scop::isDominatedBy(const DominatorTree &DT, BasicBlock *BB) const {
2228 return DT.dominates(BB, getEntry());
2229}
2230
Michael Kruse476f8552017-06-29 12:47:41 +00002231void Scop::addUserAssumptions(
2232 AssumptionCache &AC, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002233 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse89b1f942017-03-17 13:56:53 +00002234 for (auto &Assumption : AC.assumptions()) {
2235 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
2236 if (!CI || CI->getNumArgOperands() != 1)
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002237 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00002238
Michael Kruse89b1f942017-03-17 13:56:53 +00002239 bool InScop = contains(CI);
2240 if (!InScop && !isDominatedBy(DT, CI->getParent()))
2241 continue;
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002242
Michael Kruse89b1f942017-03-17 13:56:53 +00002243 auto *L = LI.getLoopFor(CI->getParent());
2244 auto *Val = CI->getArgOperand(0);
2245 ParameterSetTy DetectedParams;
2246 if (!isAffineConstraint(Val, &R, L, *SE, DetectedParams)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00002247 ORE.emit(
2248 OptimizationRemarkAnalysis(DEBUG_TYPE, "IgnoreUserAssumption", CI)
2249 << "Non-affine user assumption ignored.");
Michael Kruse89b1f942017-03-17 13:56:53 +00002250 continue;
Michael Kruse7037fde2016-12-15 09:25:14 +00002251 }
Michael Kruse89b1f942017-03-17 13:56:53 +00002252
2253 // Collect all newly introduced parameters.
2254 ParameterSetTy NewParams;
2255 for (auto *Param : DetectedParams) {
2256 Param = extractConstantFactor(Param, *SE).second;
2257 Param = getRepresentingInvariantLoadSCEV(Param);
2258 if (Parameters.count(Param))
2259 continue;
2260 NewParams.insert(Param);
2261 }
2262
2263 SmallVector<isl_set *, 2> ConditionSets;
2264 auto *TI = InScop ? CI->getParent()->getTerminator() : nullptr;
2265 auto &Stmt = InScop ? *getStmtFor(CI->getParent()) : *Stmts.begin();
2266 auto *Dom = InScop ? getDomainConditions(&Stmt) : isl_set_copy(Context);
Michael Kruse476f8552017-06-29 12:47:41 +00002267 bool Valid = buildConditionSets(*this, Stmt.getEntryBlock(), Val, TI, L,
2268 Dom, InvalidDomainMap, ConditionSets);
Michael Kruse89b1f942017-03-17 13:56:53 +00002269 isl_set_free(Dom);
2270
2271 if (!Valid)
2272 continue;
2273
2274 isl_set *AssumptionCtx = nullptr;
2275 if (InScop) {
2276 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
2277 isl_set_free(ConditionSets[0]);
2278 } else {
2279 AssumptionCtx = isl_set_complement(ConditionSets[1]);
2280 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
2281 }
2282
2283 // Project out newly introduced parameters as they are not otherwise useful.
2284 if (!NewParams.empty()) {
2285 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
2286 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
2287 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
2288 isl_id_free(Id);
2289
2290 if (!NewParams.count(Param))
2291 continue;
2292
2293 AssumptionCtx =
2294 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
2295 }
2296 }
Eli Friedmane737fc12017-07-17 23:58:33 +00002297 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "UserAssumption", CI)
2298 << "Use user assumption: " << stringFromIslObj(AssumptionCtx));
Michael Kruse89b1f942017-03-17 13:56:53 +00002299 Context = isl_set_intersect(Context, AssumptionCtx);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002300 }
2301}
2302
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002303void Scop::addUserContext() {
2304 if (UserContextStr.empty())
2305 return;
2306
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002307 isl_set *UserContext =
2308 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002309 isl_space *Space = getParamSpace();
2310 if (isl_space_dim(Space, isl_dim_param) !=
2311 isl_set_dim(UserContext, isl_dim_param)) {
2312 auto SpaceStr = isl_space_to_str(Space);
2313 errs() << "Error: the context provided in -polly-context has not the same "
2314 << "number of dimensions than the computed context. Due to this "
2315 << "mismatch, the -polly-context option is ignored. Please provide "
2316 << "the context in the parameter space: " << SpaceStr << ".\n";
2317 free(SpaceStr);
2318 isl_set_free(UserContext);
2319 isl_space_free(Space);
2320 return;
2321 }
2322
2323 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002324 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
2325 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002326
2327 if (strcmp(NameContext, NameUserContext) != 0) {
2328 auto SpaceStr = isl_space_to_str(Space);
2329 errs() << "Error: the name of dimension " << i
2330 << " provided in -polly-context "
2331 << "is '" << NameUserContext << "', but the name in the computed "
2332 << "context is '" << NameContext
2333 << "'. Due to this name mismatch, "
2334 << "the -polly-context option is ignored. Please provide "
2335 << "the context in the parameter space: " << SpaceStr << ".\n";
2336 free(SpaceStr);
2337 isl_set_free(UserContext);
2338 isl_space_free(Space);
2339 return;
2340 }
2341
2342 UserContext =
2343 isl_set_set_dim_id(UserContext, isl_dim_param, i,
2344 isl_space_get_dim_id(Space, isl_dim_param, i));
2345 }
2346
2347 Context = isl_set_intersect(Context, UserContext);
2348 isl_space_free(Space);
2349}
2350
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002351void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002352 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002353
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002354 const InvariantLoadsSetTy &RIL = getRequiredInvariantLoads();
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002355 for (LoadInst *LInst : RIL) {
2356 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2357
Johannes Doerfert96e54712016-02-07 17:30:13 +00002358 Type *Ty = LInst->getType();
2359 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002360 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002361 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002362 continue;
2363 }
2364
2365 ClassRep = LInst;
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00002366 InvariantEquivClasses.emplace_back(
2367 InvariantEquivClassTy{PointerSCEV, MemoryAccessList(), nullptr, Ty});
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002368 }
2369}
2370
Tobias Grosser6be480c2011-11-08 15:41:13 +00002371void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002372 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00002373 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002374 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00002375 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002376}
2377
Tobias Grosser18daaca2012-05-22 10:47:27 +00002378void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002379 unsigned PDim = 0;
2380 for (auto *Parameter : Parameters) {
2381 ConstantRange SRange = SE->getSignedRange(Parameter);
Tobias Grosser99ea1d02017-05-21 20:23:20 +00002382 Context =
2383 addRangeBoundsToSet(give(Context), SRange, PDim++, isl::dim::param)
2384 .release();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002385 }
2386}
2387
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002388// We use the outermost dimension to generate GPU transfers for Fortran arrays
2389// even when the array bounds are not known statically. To do so, we need the
2390// outermost dimension information. We add this into the context so that the
2391// outermost dimension is available during codegen.
2392// We currently do not care about dimensions other than the outermost
2393// dimension since it doesn't affect transfers.
2394static isl_set *addFortranArrayOutermostDimParams(__isl_give isl_set *Context,
2395 Scop::array_range Arrays) {
2396
2397 std::vector<isl_id *> OutermostSizeIds;
2398 for (auto Array : Arrays) {
2399 // To check if an array is a Fortran array, we check if it has a isl_pw_aff
2400 // for its outermost dimension. Fortran arrays will have this since the
2401 // outermost dimension size can be picked up from their runtime description.
2402 // TODO: actually need to check if it has a FAD, but for now this works.
2403 if (Array->getNumberOfDimensions() > 0) {
Tobias Grosser77eef902017-07-21 23:07:56 +00002404 isl_pw_aff *PwAff = Array->getDimensionSizePw(0).release();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002405 if (!PwAff)
2406 continue;
2407
2408 isl_id *Id = isl_pw_aff_get_dim_id(PwAff, isl_dim_param, 0);
2409 isl_pw_aff_free(PwAff);
2410 assert(Id && "Invalid Id for PwAff expression in Fortran array");
2411 OutermostSizeIds.push_back(Id);
2412 }
2413 }
2414
2415 const int NumTrueParams = isl_set_dim(Context, isl_dim_param);
2416 Context = isl_set_add_dims(Context, isl_dim_param, OutermostSizeIds.size());
2417
2418 for (size_t i = 0; i < OutermostSizeIds.size(); i++) {
2419 Context = isl_set_set_dim_id(Context, isl_dim_param, NumTrueParams + i,
2420 OutermostSizeIds[i]);
2421 Context =
2422 isl_set_lower_bound_si(Context, isl_dim_param, NumTrueParams + i, 0);
2423 }
2424
2425 return Context;
2426}
2427
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002428void Scop::realignParams() {
Tobias Grosser5842dee2017-03-17 13:00:53 +00002429 if (PollyIgnoreParamBounds)
2430 return;
2431
Tobias Grosser6be480c2011-11-08 15:41:13 +00002432 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002433 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002434
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002435 unsigned PDim = 0;
2436 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002437 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002438 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002439 }
2440
2441 // Align the parameters of all data structures to the model.
2442 Context = isl_set_align_params(Context, Space);
2443
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00002444 // Add the outermost dimension of the Fortran arrays into the Context.
2445 // See the description of the function for more information.
2446 Context = addFortranArrayOutermostDimParams(Context, arrays());
2447
Johannes Doerferta60ad842016-05-10 12:18:22 +00002448 // As all parameters are known add bounds to them.
2449 addParameterBounds();
2450
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002451 for (ScopStmt &Stmt : *this)
2452 Stmt.realignParams();
Johannes Doerfert06445ded2016-06-02 15:07:41 +00002453 // Simplify the schedule according to the context too.
2454 Schedule = isl_schedule_gist_domain_params(Schedule, getContext());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002455}
2456
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002457static __isl_give isl_set *
2458simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2459 const Scop &S) {
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002460 // If we have modeled all blocks in the SCoP that have side effects we can
2461 // simplify the context with the constraints that are needed for anything to
2462 // be executed at all. However, if we have error blocks in the SCoP we already
2463 // assumed some parameter combinations cannot occur and removed them from the
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002464 // domains, thus we cannot use the remaining domain to simplify the
2465 // assumptions.
2466 if (!S.hasErrorBlock()) {
2467 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2468 AssumptionContext =
2469 isl_set_gist_params(AssumptionContext, DomainParameters);
2470 }
2471
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002472 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2473 return AssumptionContext;
2474}
2475
2476void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002477 // The parameter constraints of the iteration domains give us a set of
2478 // constraints that need to hold for all cases where at least a single
2479 // statement iteration is executed in the whole scop. We now simplify the
2480 // assumed context under the assumption that such constraints hold and at
2481 // least a single statement iteration is executed. For cases where no
2482 // statement instances are executed, the assumptions we have taken about
2483 // the executed code do not matter and can be changed.
2484 //
2485 // WARNING: This only holds if the assumptions we have taken do not reduce
2486 // the set of statement instances that are executed. Otherwise we
2487 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002488 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002489 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002490 // performed. In such a case, modifying the run-time conditions and
2491 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002492 // to not be executed.
2493 //
2494 // Example:
2495 //
2496 // When delinearizing the following code:
2497 //
2498 // for (long i = 0; i < 100; i++)
2499 // for (long j = 0; j < m; j++)
2500 // A[i+p][j] = 1.0;
2501 //
2502 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002503 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002504 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002505 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002506 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002507}
2508
Tobias Grosserc80d6972016-09-02 06:33:33 +00002509/// Add the minimal/maximal access in @p Set to @p User.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002510static isl::stat
2511buildMinMaxAccess(isl::set Set, Scop::MinMaxVectorTy &MinMaxAccesses, Scop &S) {
2512 isl::pw_multi_aff MinPMA, MaxPMA;
2513 isl::pw_aff LastDimAff;
2514 isl::aff OneAff;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002515 unsigned Pos;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002516 isl::ctx Ctx = Set.get_ctx();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002517
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002518 Set = Set.remove_divs();
Johannes Doerfert6296d952016-04-22 11:38:19 +00002519
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002520 if (isl_set_n_basic_set(Set.get()) >= MaxDisjunctsInDomain)
2521 return isl::stat::error;
Johannes Doerfert6296d952016-04-22 11:38:19 +00002522
Johannes Doerfert9143d672014-09-27 11:02:39 +00002523 // Restrict the number of parameters involved in the access as the lexmin/
2524 // lexmax computation will take too long if this number is high.
2525 //
2526 // Experiments with a simple test case using an i7 4800MQ:
2527 //
2528 // #Parameters involved | Time (in sec)
2529 // 6 | 0.01
2530 // 7 | 0.04
2531 // 8 | 0.12
2532 // 9 | 0.40
2533 // 10 | 1.54
2534 // 11 | 6.78
2535 // 12 | 30.38
2536 //
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002537 if (isl_set_n_param(Set.get()) > RunTimeChecksMaxParameters) {
Johannes Doerfert9143d672014-09-27 11:02:39 +00002538 unsigned InvolvedParams = 0;
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002539 for (unsigned u = 0, e = isl_set_n_param(Set.get()); u < e; u++)
2540 if (Set.involves_dims(isl::dim::param, u, 1))
Johannes Doerfert9143d672014-09-27 11:02:39 +00002541 InvolvedParams++;
2542
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002543 if (InvolvedParams > RunTimeChecksMaxParameters)
2544 return isl::stat::error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002545 }
2546
Tobias Grosser1b9d1bc2017-06-25 06:32:00 +00002547 if (isl_set_n_basic_set(Set.get()) > RunTimeChecksMaxAccessDisjuncts)
2548 return isl::stat::error;
2549
Tobias Grosser57a1d362017-06-23 08:05:27 +00002550 MinPMA = Set.lexmin_pw_multi_aff();
2551 MaxPMA = Set.lexmax_pw_multi_aff();
Tobias Grosser45e9fd12017-05-19 03:45:00 +00002552
Tobias Grosser57a1d362017-06-23 08:05:27 +00002553 if (isl_ctx_last_error(Ctx.get()) == isl_error_quota)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002554 return isl::stat::error;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002555
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002556 MinPMA = MinPMA.coalesce();
2557 MaxPMA = MaxPMA.coalesce();
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002558
Johannes Doerfertb164c792014-09-18 11:17:17 +00002559 // Adjust the last dimension of the maximal access by one as we want to
2560 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2561 // we test during code generation might now point after the end of the
2562 // allocated array but we will never dereference it anyway.
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002563 assert(MaxPMA.dim(isl::dim::out) && "Assumed at least one output dimension");
2564 Pos = MaxPMA.dim(isl::dim::out) - 1;
2565 LastDimAff = MaxPMA.get_pw_aff(Pos);
2566 OneAff = isl::aff(isl::local_space(LastDimAff.get_domain_space()));
2567 OneAff = OneAff.add_constant_si(1);
2568 LastDimAff = LastDimAff.add(OneAff);
2569 MaxPMA = MaxPMA.set_pw_aff(Pos, LastDimAff);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002570
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002571 MinMaxAccesses.push_back(std::make_pair(MinPMA.copy(), MaxPMA.copy()));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002572
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002573 return isl::stat::ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002574}
2575
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002576static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2577 isl_set *Domain = MA->getStatement()->getDomain();
2578 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2579 return isl_set_reset_tuple_id(Domain);
2580}
2581
Tobias Grosserc80d6972016-09-02 06:33:33 +00002582/// Wrapper function to calculate minimal/maximal accesses to each array.
Tobias Grossere9522232017-01-16 15:49:04 +00002583static bool calculateMinMaxAccess(Scop::AliasGroupTy AliasGroup, Scop &S,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002584 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002585
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002586 MinMaxAccesses.reserve(AliasGroup.size());
Tobias Grossere9522232017-01-16 15:49:04 +00002587
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002588 isl::union_set Domains = give(S.getDomains());
2589 isl::union_map Accesses = isl::union_map::empty(give(S.getParamSpace()));
Tobias Grossere9522232017-01-16 15:49:04 +00002590
2591 for (MemoryAccess *MA : AliasGroup)
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002592 Accesses = Accesses.add_map(give(MA->getAccessRelation()));
Tobias Grossere9522232017-01-16 15:49:04 +00002593
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002594 Accesses = Accesses.intersect_domain(Domains);
2595 isl::union_set Locations = Accesses.range();
2596 Locations = Locations.coalesce();
2597 Locations = Locations.detect_equalities();
Tobias Grosser8f23fb82017-06-23 08:05:20 +00002598
2599 auto Lambda = [&MinMaxAccesses, &S](isl::set Set) -> isl::stat {
2600 return buildMinMaxAccess(Set, MinMaxAccesses, S);
2601 };
2602 return Locations.foreach_set(Lambda) == isl::stat::ok;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002603}
2604
Tobias Grosserc80d6972016-09-02 06:33:33 +00002605/// Helper to treat non-affine regions and basic blocks the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002606///
2607///{
2608
Tobias Grosserc80d6972016-09-02 06:33:33 +00002609/// Return the block that is the representing block for @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002610static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2611 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2612 : RN->getNodeAs<BasicBlock>();
2613}
2614
Tobias Grosserc80d6972016-09-02 06:33:33 +00002615/// Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002616static inline BasicBlock *
2617getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002618 if (RN->isSubRegion()) {
2619 assert(idx == 0);
2620 return RN->getNodeAs<Region>()->getExit();
2621 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002622 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002623}
2624
Tobias Grosserc80d6972016-09-02 06:33:33 +00002625/// Return the smallest loop surrounding @p RN.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002626static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002627 if (!RN->isSubRegion()) {
2628 BasicBlock *BB = RN->getNodeAs<BasicBlock>();
2629 Loop *L = LI.getLoopFor(BB);
2630
2631 // Unreachable statements are not considered to belong to a LLVM loop, as
2632 // they are not part of an actual loop in the control flow graph.
2633 // Nevertheless, we handle certain unreachable statements that are common
2634 // when modeling run-time bounds checks as being part of the loop to be
2635 // able to model them and to later eliminate the run-time bounds checks.
2636 //
2637 // Specifically, for basic blocks that terminate in an unreachable and
Michael Krusea6d48f52017-06-08 12:06:15 +00002638 // where the immediate predecessor is part of a loop, we assume these
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002639 // basic blocks belong to the loop the predecessor belongs to. This
2640 // allows us to model the following code.
2641 //
2642 // for (i = 0; i < N; i++) {
2643 // if (i > 1024)
2644 // abort(); <- this abort might be translated to an
2645 // unreachable
2646 //
2647 // A[i] = ...
2648 // }
2649 if (!L && isa<UnreachableInst>(BB->getTerminator()) && BB->getPrevNode())
2650 L = LI.getLoopFor(BB->getPrevNode());
2651 return L;
2652 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002653
2654 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2655 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2656 while (L && NonAffineSubRegion->contains(L))
2657 L = L->getParentLoop();
2658 return L;
2659}
2660
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002661/// Get the number of blocks in @p L.
2662///
2663/// The number of blocks in a loop are the number of basic blocks actually
2664/// belonging to the loop, as well as all single basic blocks that the loop
2665/// exits to and which terminate in an unreachable instruction. We do not
2666/// allow such basic blocks in the exit of a scop, hence they belong to the
2667/// scop and represent run-time conditions which we want to model and
2668/// subsequently speculate away.
2669///
2670/// @see getRegionNodeLoop for additional details.
Reid Klecknerdf2b2832017-06-19 17:44:02 +00002671unsigned getNumBlocksInLoop(Loop *L) {
2672 unsigned NumBlocks = L->getNumBlocks();
Tobias Grosserce69e7b2017-03-07 16:17:55 +00002673 SmallVector<llvm::BasicBlock *, 4> ExitBlocks;
2674 L->getExitBlocks(ExitBlocks);
2675
2676 for (auto ExitBlock : ExitBlocks) {
2677 if (isa<UnreachableInst>(ExitBlock->getTerminator()))
2678 NumBlocks++;
2679 }
2680 return NumBlocks;
2681}
2682
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002683static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2684 if (!RN->isSubRegion())
2685 return 1;
2686
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002687 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002688 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002689}
2690
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002691static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2692 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002693 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002694 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002695 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002696 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002697 return true;
2698 return false;
2699}
2700
Johannes Doerfert96425c22015-08-30 21:13:53 +00002701///}
2702
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002703static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2704 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002705 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002706 isl_id *DimId =
2707 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2708 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2709}
2710
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002711__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002712 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002713}
2714
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002715__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002716 auto DIt = DomainMap.find(BB);
2717 if (DIt != DomainMap.end())
Tobias Grosser325204a32017-07-15 12:41:32 +00002718 return DIt->getSecond().copy();
Johannes Doerfert41cda152016-04-08 10:32:26 +00002719
2720 auto &RI = *R.getRegionInfo();
2721 auto *BBR = RI.getRegionFor(BB);
2722 while (BBR->getEntry() == BB)
2723 BBR = BBR->getParent();
2724 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002725}
2726
Tobias Grosser13acbb92017-07-15 09:01:31 +00002727bool Scop::buildDomains(Region *R, DominatorTree &DT, LoopInfo &LI,
2728 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002729
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002730 bool IsOnlyNonAffineRegion = isNonAffineSubRegion(R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002731 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002732 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2733 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002734 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002735
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002736 while (LD-- >= 0) {
2737 S = addDomainDimId(S, LD + 1, L);
2738 L = L->getParentLoop();
2739 }
2740
Tobias Grosser13acbb92017-07-15 09:01:31 +00002741 InvalidDomainMap[EntryBB] = isl::manage(isl_set_empty(isl_set_get_space(S)));
Tobias Grosser325204a32017-07-15 12:41:32 +00002742 DomainMap[EntryBB] = isl::manage(S);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002743
Johannes Doerfert432658d2016-01-26 11:01:41 +00002744 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002745 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002746
Michael Kruse476f8552017-06-29 12:47:41 +00002747 if (!buildDomainsWithBranchConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002748 return false;
2749
Michael Kruse476f8552017-06-29 12:47:41 +00002750 if (!propagateDomainConstraints(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002751 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002752
2753 // Error blocks and blocks dominated by them have been assumed to never be
2754 // executed. Representing them in the Scop does not add any value. In fact,
2755 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002756 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002757 // will cause problems when building up a ScopStmt for them.
2758 // Furthermore, basic blocks dominated by error blocks may reference
2759 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002760 // can themselves not be constructed properly. To this end we will replace
2761 // the domains of error blocks and those only reachable via error blocks
2762 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002763 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002764 // InvalidDomain. This information is needed during load hoisting.
Michael Kruse476f8552017-06-29 12:47:41 +00002765 if (!propagateInvalidStmtDomains(R, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002766 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002767
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002768 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002769}
2770
Tobias Grosserc80d6972016-09-02 06:33:33 +00002771/// Adjust the dimensions of @p Dom that was constructed for @p OldL
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002772/// to be compatible to domains constructed for loop @p NewL.
2773///
2774/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2775/// edge from @p OldL to @p NewL.
2776static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2777 __isl_take isl_set *Dom,
2778 Loop *OldL, Loop *NewL) {
2779
2780 // If the loops are the same there is nothing to do.
2781 if (NewL == OldL)
2782 return Dom;
2783
2784 int OldDepth = S.getRelativeLoopDepth(OldL);
2785 int NewDepth = S.getRelativeLoopDepth(NewL);
2786 // If both loops are non-affine loops there is nothing to do.
2787 if (OldDepth == -1 && NewDepth == -1)
2788 return Dom;
2789
2790 // Distinguish three cases:
2791 // 1) The depth is the same but the loops are not.
2792 // => One loop was left one was entered.
2793 // 2) The depth increased from OldL to NewL.
2794 // => One loop was entered, none was left.
2795 // 3) The depth decreased from OldL to NewL.
2796 // => Loops were left were difference of the depths defines how many.
2797 if (OldDepth == NewDepth) {
2798 assert(OldL->getParentLoop() == NewL->getParentLoop());
2799 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2800 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2801 Dom = addDomainDimId(Dom, NewDepth, NewL);
2802 } else if (OldDepth < NewDepth) {
2803 assert(OldDepth + 1 == NewDepth);
2804 auto &R = S.getRegion();
2805 (void)R;
2806 assert(NewL->getParentLoop() == OldL ||
2807 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2808 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2809 Dom = addDomainDimId(Dom, NewDepth, NewL);
2810 } else {
2811 assert(OldDepth > NewDepth);
2812 int Diff = OldDepth - NewDepth;
2813 int NumDim = isl_set_n_dim(Dom);
2814 assert(NumDim >= Diff);
2815 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2816 }
2817
2818 return Dom;
2819}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002820
Michael Kruse476f8552017-06-29 12:47:41 +00002821bool Scop::propagateInvalidStmtDomains(
2822 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002823 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse476f8552017-06-29 12:47:41 +00002824
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002825 ReversePostOrderTraversal<Region *> RTraversal(R);
2826 for (auto *RN : RTraversal) {
2827
2828 // Recurse for affine subregions but go on for basic blocks and non-affine
2829 // subregions.
2830 if (RN->isSubRegion()) {
2831 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002832 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002833 propagateInvalidStmtDomains(SubRegion, DT, LI, InvalidDomainMap);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002834 continue;
2835 }
2836 }
2837
2838 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2839 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00002840 isl::set &Domain = DomainMap[BB];
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002841 assert(Domain && "Cannot propagate a nullptr");
2842
Tobias Grosser325204a32017-07-15 12:41:32 +00002843 isl::set InvalidDomain = InvalidDomainMap[BB];
Michael Kruse476f8552017-06-29 12:47:41 +00002844
Tobias Grosser325204a32017-07-15 12:41:32 +00002845 bool IsInvalidBlock = ContainsErrorBlock || Domain.is_subset(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002846
Johannes Doerferta3519512016-04-23 13:02:23 +00002847 if (!IsInvalidBlock) {
Tobias Grosser325204a32017-07-15 12:41:32 +00002848 InvalidDomain = InvalidDomain.intersect(Domain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002849 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002850 InvalidDomain = Domain;
Tobias Grosser325204a32017-07-15 12:41:32 +00002851 isl::set DomPar = Domain.params();
2852 recordAssumption(ERRORBLOCK, DomPar.release(),
2853 BB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002854 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002855 }
2856
Tobias Grosser325204a32017-07-15 12:41:32 +00002857 if (InvalidDomain.is_empty()) {
2858 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002859 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002860 }
2861
Johannes Doerferta3519512016-04-23 13:02:23 +00002862 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002863 auto *TI = BB->getTerminator();
2864 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2865 for (unsigned u = 0; u < NumSuccs; u++) {
2866 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002867
2868 // Skip successors outside the SCoP.
Michael Kruse476f8552017-06-29 12:47:41 +00002869 if (!contains(SuccBB))
Johannes Doerfert7c013572016-04-12 09:57:34 +00002870 continue;
2871
Johannes Doerferte4459a22016-04-25 13:34:50 +00002872 // Skip backedges.
2873 if (DT.dominates(SuccBB, BB))
2874 continue;
2875
Michael Kruse476f8552017-06-29 12:47:41 +00002876 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
2877
Johannes Doerferta3519512016-04-23 13:02:23 +00002878 auto *AdjustedInvalidDomain = adjustDomainDimensions(
Tobias Grosser325204a32017-07-15 12:41:32 +00002879 *this, InvalidDomain.copy(), BBLoop, SuccBBLoop);
Michael Kruse476f8552017-06-29 12:47:41 +00002880
Tobias Grosser13acbb92017-07-15 09:01:31 +00002881 auto *SuccInvalidDomain = InvalidDomainMap[SuccBB].copy();
Johannes Doerferta3519512016-04-23 13:02:23 +00002882 SuccInvalidDomain =
2883 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2884 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2885 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
Michael Kruse476f8552017-06-29 12:47:41 +00002886
Tobias Grosser13acbb92017-07-15 09:01:31 +00002887 InvalidDomainMap[SuccBB] = isl::manage(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002888
Michael Krusebc150122016-05-02 12:25:18 +00002889 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002890 // In case this happens we will bail.
Tobias Grosser90411a92017-02-16 19:11:33 +00002891 if (NumConjucts < MaxDisjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002892 continue;
2893
Tobias Grosserf44f0052017-07-09 15:47:17 +00002894 InvalidDomainMap.erase(BB);
Eli Friedmane737fc12017-07-17 23:58:33 +00002895 invalidate(COMPLEXITY, TI->getDebugLoc(), TI->getParent());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002896 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002897 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002898
Tobias Grosser325204a32017-07-15 12:41:32 +00002899 InvalidDomainMap[BB] = InvalidDomain;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002900 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002901
2902 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002903}
2904
Johannes Doerfert642594a2016-04-04 07:57:39 +00002905void Scop::propagateDomainConstraintsToRegionExit(
2906 BasicBlock *BB, Loop *BBLoop,
Michael Kruse476f8552017-06-29 12:47:41 +00002907 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002908 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002909
2910 // Check if the block @p BB is the entry of a region. If so we propagate it's
2911 // domain to the exit block of the region. Otherwise we are done.
2912 auto *RI = R.getRegionInfo();
2913 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2914 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002915 if (!BBReg || BBReg->getEntry() != BB || !contains(ExitBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00002916 return;
2917
Johannes Doerfert642594a2016-04-04 07:57:39 +00002918 // Do not propagate the domain if there is a loop backedge inside the region
Tobias Grossercdbe5c92017-01-06 17:30:34 +00002919 // that would prevent the exit block from being executed.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002920 auto *L = BBLoop;
Johannes Doerfert952b5302016-05-23 12:40:48 +00002921 while (L && contains(L)) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002922 SmallVector<BasicBlock *, 4> LatchBBs;
2923 BBLoop->getLoopLatches(LatchBBs);
2924 for (auto *LatchBB : LatchBBs)
2925 if (BB != LatchBB && BBReg->contains(LatchBB))
2926 return;
2927 L = L->getParentLoop();
2928 }
2929
Tobias Grosser325204a32017-07-15 12:41:32 +00002930 isl::set Domain = DomainMap[BB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002931 assert(Domain && "Cannot propagate a nullptr");
2932
Michael Kruse476f8552017-06-29 12:47:41 +00002933 Loop *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00002934
2935 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2936 // adjust the domain before we can propagate it.
Tobias Grosser325204a32017-07-15 12:41:32 +00002937 isl::set AdjustedDomain = isl::manage(
2938 adjustDomainDimensions(*this, Domain.copy(), BBLoop, ExitBBLoop));
2939 isl::set &ExitDomain = DomainMap[ExitBB];
Johannes Doerfert642594a2016-04-04 07:57:39 +00002940
2941 // If the exit domain is not yet created we set it otherwise we "add" the
2942 // current domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002943 ExitDomain = ExitDomain ? AdjustedDomain.unite(ExitDomain) : AdjustedDomain;
Johannes Doerfert642594a2016-04-04 07:57:39 +00002944
Johannes Doerferta3519512016-04-23 13:02:23 +00002945 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00002946 InvalidDomainMap[ExitBB] = ExitDomain.empty(ExitDomain.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00002947
Johannes Doerfert642594a2016-04-04 07:57:39 +00002948 FinishedExitBlocks.insert(ExitBB);
2949}
2950
Michael Kruse476f8552017-06-29 12:47:41 +00002951bool Scop::buildDomainsWithBranchConstraints(
2952 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00002953 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Michael Kruse476f8552017-06-29 12:47:41 +00002954
Johannes Doerfert96425c22015-08-30 21:13:53 +00002955 // To create the domain for each block in R we iterate over all blocks and
2956 // subregions in R and propagate the conditions under which the current region
2957 // element is executed. To this end we iterate in reverse post order over R as
2958 // it ensures that we first visit all predecessors of a region node (either a
2959 // basic block or a subregion) before we visit the region node itself.
2960 // Initially, only the domain for the SCoP region entry block is set and from
2961 // there we propagate the current domain to all successors, however we add the
2962 // condition that the successor is actually executed next.
2963 // As we are only interested in non-loop carried constraints here we can
2964 // simply skip loop back edges.
2965
Johannes Doerfert642594a2016-04-04 07:57:39 +00002966 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002967 ReversePostOrderTraversal<Region *> RTraversal(R);
2968 for (auto *RN : RTraversal) {
2969
2970 // Recurse for affine subregions but go on for basic blocks and non-affine
2971 // subregions.
2972 if (RN->isSubRegion()) {
2973 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00002974 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00002975 if (!buildDomainsWithBranchConstraints(SubRegion, DT, LI,
2976 InvalidDomainMap))
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002977 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002978 continue;
2979 }
2980 }
2981
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002982 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002983 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002984
Johannes Doerfert96425c22015-08-30 21:13:53 +00002985 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002986 TerminatorInst *TI = BB->getTerminator();
2987
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002988 if (isa<UnreachableInst>(TI))
2989 continue;
2990
Tobias Grosser325204a32017-07-15 12:41:32 +00002991 isl::set Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002992 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002993 continue;
Tobias Grosser325204a32017-07-15 12:41:32 +00002994 MaxLoopDepth = std::max(MaxLoopDepth, isl_set_n_dim(Domain.get()));
Johannes Doerfert96425c22015-08-30 21:13:53 +00002995
Johannes Doerfert642594a2016-04-04 07:57:39 +00002996 auto *BBLoop = getRegionNodeLoop(RN, LI);
2997 // Propagate the domain from BB directly to blocks that have a superset
2998 // domain, at the moment only region exit nodes of regions that start in BB.
Michael Kruse476f8552017-06-29 12:47:41 +00002999 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, LI,
3000 InvalidDomainMap);
Johannes Doerfert642594a2016-04-04 07:57:39 +00003001
3002 // If all successors of BB have been set a domain through the propagation
3003 // above we do not need to build condition sets but can just skip this
3004 // block. However, it is important to note that this is a local property
3005 // with regards to the region @p R. To this end FinishedExitBlocks is a
3006 // local variable.
3007 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
3008 return FinishedExitBlocks.count(SuccBB);
3009 };
3010 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
3011 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003012
3013 // Build the condition sets for the successor nodes of the current region
3014 // node. If it is a non-affine subregion we will always execute the single
3015 // exit node, hence the single entry node domain is the condition set. For
3016 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003017 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003018 if (RN->isSubRegion())
Tobias Grosser325204a32017-07-15 12:41:32 +00003019 ConditionSets.push_back(Domain.copy());
3020 else if (!buildConditionSets(*this, BB, TI, BBLoop, Domain.get(),
Michael Kruse476f8552017-06-29 12:47:41 +00003021 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003022 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003023
3024 // Now iterate over the successors and set their initial domain based on
3025 // their condition set. We skip back edges here and have to be careful when
3026 // we leave a loop not to keep constraints over a dimension that doesn't
3027 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003028 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00003029 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Tobias Grosser325204a32017-07-15 12:41:32 +00003030 isl::set CondSet = isl::manage(ConditionSets[u]);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003031 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00003032
Johannes Doerfert535de032016-04-19 14:49:05 +00003033 // Skip blocks outside the region.
Tobias Grosser325204a32017-07-15 12:41:32 +00003034 if (!contains(SuccBB))
Johannes Doerfert535de032016-04-19 14:49:05 +00003035 continue;
Johannes Doerfert535de032016-04-19 14:49:05 +00003036
Johannes Doerfert642594a2016-04-04 07:57:39 +00003037 // If we propagate the domain of some block to "SuccBB" we do not have to
3038 // adjust the domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00003039 if (FinishedExitBlocks.count(SuccBB))
Johannes Doerfert642594a2016-04-04 07:57:39 +00003040 continue;
Johannes Doerfert642594a2016-04-04 07:57:39 +00003041
Johannes Doerfert96425c22015-08-30 21:13:53 +00003042 // Skip back edges.
Tobias Grosser325204a32017-07-15 12:41:32 +00003043 if (DT.dominates(SuccBB, BB))
Johannes Doerfert96425c22015-08-30 21:13:53 +00003044 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003045
Michael Kruse476f8552017-06-29 12:47:41 +00003046 Loop *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, getBoxedLoops());
3047
Tobias Grosser325204a32017-07-15 12:41:32 +00003048 CondSet = isl::manage(
3049 adjustDomainDimensions(*this, CondSet.copy(), BBLoop, SuccBBLoop));
Johannes Doerfert96425c22015-08-30 21:13:53 +00003050
3051 // Set the domain for the successor or merge it with an existing domain in
3052 // case there are multiple paths (without loop back edges) to the
3053 // successor block.
Tobias Grosser325204a32017-07-15 12:41:32 +00003054 isl::set &SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00003055
Johannes Doerferta3519512016-04-23 13:02:23 +00003056 if (SuccDomain) {
Tobias Grosser325204a32017-07-15 12:41:32 +00003057 SuccDomain = SuccDomain.unite(CondSet).coalesce();
Johannes Doerferta3519512016-04-23 13:02:23 +00003058 } else {
3059 // Initialize the invalid domain.
Tobias Grosser325204a32017-07-15 12:41:32 +00003060 InvalidDomainMap[SuccBB] = CondSet.empty(CondSet.get_space());
Johannes Doerferta3519512016-04-23 13:02:23 +00003061 SuccDomain = CondSet;
3062 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00003063
Tobias Grosser325204a32017-07-15 12:41:32 +00003064 SuccDomain = SuccDomain.detect_equalities();
Tobias Grosser6d459c52017-05-23 04:26:28 +00003065
Michael Krusebc150122016-05-02 12:25:18 +00003066 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003067 // In case this happens we will clean up and bail.
Tobias Grosser325204a32017-07-15 12:41:32 +00003068 if (isl_set_n_basic_set(SuccDomain.get()) < MaxDisjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003069 continue;
3070
3071 invalidate(COMPLEXITY, DebugLoc());
3072 while (++u < ConditionSets.size())
3073 isl_set_free(ConditionSets[u]);
3074 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003075 }
3076 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003077
3078 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003079}
3080
Michael Krused56b90a2016-09-01 09:03:27 +00003081__isl_give isl_set *
3082Scop::getPredecessorDomainConstraints(BasicBlock *BB,
3083 __isl_keep isl_set *Domain,
3084 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00003085 // If @p BB is the ScopEntry we are done
3086 if (R.getEntry() == BB)
3087 return isl_set_universe(isl_set_get_space(Domain));
3088
Johannes Doerfert642594a2016-04-04 07:57:39 +00003089 // The region info of this function.
3090 auto &RI = *R.getRegionInfo();
3091
Michael Kruse476f8552017-06-29 12:47:41 +00003092 Loop *BBLoop = getFirstNonBoxedLoopFor(BB, LI, getBoxedLoops());
Johannes Doerfert642594a2016-04-04 07:57:39 +00003093
3094 // A domain to collect all predecessor domains, thus all conditions under
3095 // which the block is executed. To this end we start with the empty domain.
3096 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
3097
3098 // Set of regions of which the entry block domain has been propagated to BB.
3099 // all predecessors inside any of the regions can be skipped.
3100 SmallSet<Region *, 8> PropagatedRegions;
3101
3102 for (auto *PredBB : predecessors(BB)) {
3103 // Skip backedges.
3104 if (DT.dominates(BB, PredBB))
3105 continue;
3106
3107 // If the predecessor is in a region we used for propagation we can skip it.
3108 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
3109 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
3110 PredBBInRegion)) {
3111 continue;
3112 }
3113
3114 // Check if there is a valid region we can use for propagation, thus look
3115 // for a region that contains the predecessor and has @p BB as exit block.
3116 auto *PredR = RI.getRegionFor(PredBB);
3117 while (PredR->getExit() != BB && !PredR->contains(BB))
3118 PredR->getParent();
3119
3120 // If a valid region for propagation was found use the entry of that region
3121 // for propagation, otherwise the PredBB directly.
3122 if (PredR->getExit() == BB) {
3123 PredBB = PredR->getEntry();
3124 PropagatedRegions.insert(PredR);
3125 }
3126
Johannes Doerfert41cda152016-04-08 10:32:26 +00003127 auto *PredBBDom = getDomainConditions(PredBB);
Michael Kruse476f8552017-06-29 12:47:41 +00003128 Loop *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, getBoxedLoops());
3129
Johannes Doerfert642594a2016-04-04 07:57:39 +00003130 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
3131
3132 PredDom = isl_set_union(PredDom, PredBBDom);
3133 }
3134
3135 return PredDom;
3136}
3137
Michael Kruse476f8552017-06-29 12:47:41 +00003138bool Scop::propagateDomainConstraints(
3139 Region *R, DominatorTree &DT, LoopInfo &LI,
Tobias Grosser13acbb92017-07-15 09:01:31 +00003140 DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003141 // Iterate over the region R and propagate the domain constrains from the
3142 // predecessors to the current node. In contrast to the
3143 // buildDomainsWithBranchConstraints function, this one will pull the domain
3144 // information from the predecessors instead of pushing it to the successors.
3145 // Additionally, we assume the domains to be already present in the domain
3146 // map here. However, we iterate again in reverse post order so we know all
3147 // predecessors have been visited before a block or non-affine subregion is
3148 // visited.
3149
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003150 ReversePostOrderTraversal<Region *> RTraversal(R);
3151 for (auto *RN : RTraversal) {
3152
3153 // Recurse for affine subregions but go on for basic blocks and non-affine
3154 // subregions.
3155 if (RN->isSubRegion()) {
3156 Region *SubRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003157 if (!isNonAffineSubRegion(SubRegion)) {
Michael Kruse476f8552017-06-29 12:47:41 +00003158 if (!propagateDomainConstraints(SubRegion, DT, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003159 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003160 continue;
3161 }
3162 }
3163
3164 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser325204a32017-07-15 12:41:32 +00003165 isl::set &Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00003166 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003167
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003168 // Under the union of all predecessor conditions we can reach this block.
Tobias Grosser325204a32017-07-15 12:41:32 +00003169 isl::set PredDom =
3170 isl::manage(getPredecessorDomainConstraints(BB, Domain.get(), DT, LI));
3171 Domain = Domain.intersect(PredDom).coalesce();
3172 Domain = Domain.align_params(isl::manage(getParamSpace()));
Tobias Grosser6deba4e2016-03-30 18:18:31 +00003173
Johannes Doerfert642594a2016-04-04 07:57:39 +00003174 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00003175 if (BBLoop && BBLoop->getHeader() == BB && contains(BBLoop))
Michael Kruse476f8552017-06-29 12:47:41 +00003176 if (!addLoopBoundsToHeaderDomain(BBLoop, LI, InvalidDomainMap))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003177 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003178 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00003179
3180 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003181}
3182
Tobias Grosserc80d6972016-09-02 06:33:33 +00003183/// Create a map to map from a given iteration to a subsequent iteration.
3184///
3185/// This map maps from SetSpace -> SetSpace where the dimensions @p Dim
3186/// is incremented by one and all other dimensions are equal, e.g.,
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003187/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
Tobias Grosserc80d6972016-09-02 06:33:33 +00003188///
3189/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003190static __isl_give isl_map *
3191createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
3192 auto *MapSpace = isl_space_map_from_set(SetSpace);
3193 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
Tobias Grosserf4fe34b2017-03-16 21:33:20 +00003194 for (unsigned u = 0; u < isl_map_dim(NextIterationMap, isl_dim_in); u++)
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003195 if (u != Dim)
3196 NextIterationMap =
3197 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
3198 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
3199 C = isl_constraint_set_constant_si(C, 1);
3200 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
3201 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
3202 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
3203 return NextIterationMap;
3204}
3205
Michael Kruse476f8552017-06-29 12:47:41 +00003206bool Scop::addLoopBoundsToHeaderDomain(
Tobias Grosser13acbb92017-07-15 09:01:31 +00003207 Loop *L, LoopInfo &LI, DenseMap<BasicBlock *, isl::set> &InvalidDomainMap) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003208 int LoopDepth = getRelativeLoopDepth(L);
3209 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003210
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003211 BasicBlock *HeaderBB = L->getHeader();
3212 assert(DomainMap.count(HeaderBB));
Tobias Grosser325204a32017-07-15 12:41:32 +00003213 isl::set &HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003214
Tobias Grosser325204a32017-07-15 12:41:32 +00003215 isl::map NextIterationMap = isl::manage(
3216 createNextIterationMap(HeaderBBDom.get_space().release(), LoopDepth));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003217
Tobias Grosser325204a32017-07-15 12:41:32 +00003218 isl::set UnionBackedgeCondition = HeaderBBDom.empty(HeaderBBDom.get_space());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003219
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003220 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
3221 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003222
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003223 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003224
3225 // If the latch is only reachable via error statements we skip it.
Tobias Grosser325204a32017-07-15 12:41:32 +00003226 isl::set LatchBBDom = DomainMap.lookup(LatchBB);
Johannes Doerfertf5673802015-10-01 23:48:18 +00003227 if (!LatchBBDom)
3228 continue;
3229
Tobias Grosser325204a32017-07-15 12:41:32 +00003230 isl::set BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003231
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003232 TerminatorInst *TI = LatchBB->getTerminator();
3233 BranchInst *BI = dyn_cast<BranchInst>(TI);
Tobias Grosserbbaeda32016-11-10 05:20:29 +00003234 assert(BI && "Only branch instructions allowed in loop latches");
3235
3236 if (BI->isUnconditional())
Tobias Grosser325204a32017-07-15 12:41:32 +00003237 BackedgeCondition = LatchBBDom;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003238 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00003239 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003240 int idx = BI->getSuccessor(0) != HeaderBB;
Tobias Grosser325204a32017-07-15 12:41:32 +00003241 if (!buildConditionSets(*this, LatchBB, TI, L, LatchBBDom.get(),
3242 InvalidDomainMap, ConditionSets))
Johannes Doerfert297c7202016-05-10 13:06:42 +00003243 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003244
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003245 // Free the non back edge condition set as we do not need it.
3246 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003247
Tobias Grosser325204a32017-07-15 12:41:32 +00003248 BackedgeCondition = isl::manage(ConditionSets[idx]);
Johannes Doerfert06c57b52015-09-20 15:00:20 +00003249 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003250
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003251 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
3252 assert(LatchLoopDepth >= LoopDepth);
Tobias Grosser325204a32017-07-15 12:41:32 +00003253 BackedgeCondition = BackedgeCondition.project_out(
3254 isl::dim::set, LoopDepth + 1, LatchLoopDepth - LoopDepth);
3255 UnionBackedgeCondition = UnionBackedgeCondition.unite(BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003256 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003257
Tobias Grosser325204a32017-07-15 12:41:32 +00003258 isl::map ForwardMap = ForwardMap.lex_le(HeaderBBDom.get_space());
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003259 for (int i = 0; i < LoopDepth; i++)
Tobias Grosser325204a32017-07-15 12:41:32 +00003260 ForwardMap = ForwardMap.equate(isl::dim::in, i, isl::dim::out, i);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003261
Tobias Grosser325204a32017-07-15 12:41:32 +00003262 isl::set UnionBackedgeConditionComplement =
3263 UnionBackedgeCondition.complement();
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003264 UnionBackedgeConditionComplement =
Tobias Grosser325204a32017-07-15 12:41:32 +00003265 UnionBackedgeConditionComplement.lower_bound_si(isl::dim::set, LoopDepth,
3266 0);
3267 UnionBackedgeConditionComplement =
3268 UnionBackedgeConditionComplement.apply(ForwardMap);
3269 HeaderBBDom = HeaderBBDom.subtract(UnionBackedgeConditionComplement);
3270 HeaderBBDom = HeaderBBDom.apply(NextIterationMap);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003271
Tobias Grosser325204a32017-07-15 12:41:32 +00003272 auto Parts = partitionSetParts(HeaderBBDom.copy(), LoopDepth);
3273 HeaderBBDom = isl::manage(Parts.second);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003274
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003275 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
3276 // the bounded assumptions to the context as they are already implied by the
3277 // <nsw> tag.
3278 if (Affinator.hasNSWAddRecForLoop(L)) {
3279 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003280 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00003281 }
3282
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00003283 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003284 recordAssumption(INFINITELOOP, UnboundedCtx,
3285 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00003286 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00003287}
3288
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003289MemoryAccess *Scop::lookupBasePtrAccess(MemoryAccess *MA) {
Tobias Grosserbe372d52017-02-09 10:11:58 +00003290 Value *PointerBase = MA->getOriginalBaseAddr();
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003291
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003292 auto *PointerBaseInst = dyn_cast<Instruction>(PointerBase);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003293 if (!PointerBaseInst)
3294 return nullptr;
3295
3296 auto *BasePtrStmt = getStmtFor(PointerBaseInst);
3297 if (!BasePtrStmt)
3298 return nullptr;
3299
3300 return BasePtrStmt->getArrayAccessOrNULLFor(PointerBaseInst);
3301}
3302
3303bool Scop::hasNonHoistableBasePtrInScop(MemoryAccess *MA,
Tobias Grosser4071cb52017-06-06 23:13:02 +00003304 isl::union_map Writes) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003305 if (auto *BasePtrMA = lookupBasePtrAccess(MA)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00003306 return getNonHoistableCtx(BasePtrMA, Writes).is_null();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003307 }
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003308
Tobias Grosserbe372d52017-02-09 10:11:58 +00003309 Value *BaseAddr = MA->getOriginalBaseAddr();
Tobias Grossere0e0e4d2017-02-09 09:34:46 +00003310 if (auto *BasePtrInst = dyn_cast<Instruction>(BaseAddr))
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003311 if (!isa<LoadInst>(BasePtrInst))
Johannes Doerfert952b5302016-05-23 12:40:48 +00003312 return contains(BasePtrInst);
Johannes Doerfert764b7e62016-05-23 09:26:46 +00003313
3314 return false;
3315}
3316
Johannes Doerfert5210da52016-06-02 11:06:54 +00003317bool Scop::buildAliasChecks(AliasAnalysis &AA) {
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003318 if (!PollyUseRuntimeAliasChecks)
Johannes Doerfert5210da52016-06-02 11:06:54 +00003319 return true;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003320
Johannes Doerfertcd195322016-11-17 21:41:08 +00003321 if (buildAliasGroups(AA)) {
3322 // Aliasing assumptions do not go through addAssumption but we still want to
3323 // collect statistics so we do it here explicitly.
3324 if (MinMaxAliasGroups.size())
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00003325 AssumptionsAliasing++;
Johannes Doerfert5210da52016-06-02 11:06:54 +00003326 return true;
Johannes Doerfertcd195322016-11-17 21:41:08 +00003327 }
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003328
3329 // If a problem occurs while building the alias groups we need to delete
3330 // this SCoP and pretend it wasn't valid in the first place. To this end
3331 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003332 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003333
3334 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
3335 << " could not be created as the number of parameters involved "
3336 "is too high. The SCoP will be "
3337 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
3338 "the maximal number of parameters but be advised that the "
3339 "compile time might increase exponentially.\n\n");
Johannes Doerfert5210da52016-06-02 11:06:54 +00003340 return false;
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003341}
3342
Tobias Grosser889830b2017-02-09 23:12:22 +00003343std::tuple<Scop::AliasGroupVectorTy, DenseSet<const ScopArrayInfo *>>
Tobias Grosser9edcf072017-01-16 14:07:57 +00003344Scop::buildAliasGroupsForAccesses(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003345 AliasSetTracker AST(AA);
3346
3347 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Tobias Grosser889830b2017-02-09 23:12:22 +00003348 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003349 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003350
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003351 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003352 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
3353 isl_set_free(StmtDomain);
Tobias Grosser9edcf072017-01-16 14:07:57 +00003354
3355 // Statements with an empty domain will never be executed.
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00003356 if (StmtDomainEmpty)
3357 continue;
3358
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003359 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00003360 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003361 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00003362 if (!MA->isRead())
Tobias Grosser889830b2017-02-09 23:12:22 +00003363 HasWriteAccess.insert(MA->getScopArrayInfo());
Michael Kruse70131d32016-01-27 17:09:17 +00003364 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003365 if (MA->isRead() && isa<MemTransferInst>(Acc))
Michael Kruse426e6f72016-10-25 13:37:43 +00003366 PtrToAcc[cast<MemTransferInst>(Acc)->getRawSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00003367 else
3368 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003369 AST.add(Acc);
3370 }
3371 }
3372
Tobias Grosser9edcf072017-01-16 14:07:57 +00003373 AliasGroupVectorTy AliasGroups;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003374 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00003375 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00003376 continue;
3377 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00003378 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00003379 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003380 if (AG.size() < 2)
3381 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003382 AliasGroups.push_back(std::move(AG));
3383 }
3384
Tobias Grosser9edcf072017-01-16 14:07:57 +00003385 return std::make_tuple(AliasGroups, HasWriteAccess);
3386}
3387
Tobias Grossere39f9122017-01-16 14:08:00 +00003388void Scop::splitAliasGroupsByDomain(AliasGroupVectorTy &AliasGroups) {
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003389 for (unsigned u = 0; u < AliasGroups.size(); u++) {
3390 AliasGroupTy NewAG;
3391 AliasGroupTy &AG = AliasGroups[u];
3392 AliasGroupTy::iterator AGI = AG.begin();
3393 isl_set *AGDomain = getAccessDomain(*AGI);
3394 while (AGI != AG.end()) {
3395 MemoryAccess *MA = *AGI;
3396 isl_set *MADomain = getAccessDomain(MA);
3397 if (isl_set_is_disjoint(AGDomain, MADomain)) {
3398 NewAG.push_back(MA);
3399 AGI = AG.erase(AGI);
3400 isl_set_free(MADomain);
3401 } else {
3402 AGDomain = isl_set_union(AGDomain, MADomain);
3403 AGI++;
3404 }
3405 }
3406 if (NewAG.size() > 1)
3407 AliasGroups.push_back(std::move(NewAG));
3408 isl_set_free(AGDomain);
3409 }
Tobias Grossere39f9122017-01-16 14:08:00 +00003410}
3411
3412bool Scop::buildAliasGroups(AliasAnalysis &AA) {
3413 // To create sound alias checks we perform the following steps:
3414 // o) We partition each group into read only and non read only accesses.
3415 // o) For each group with more than one base pointer we then compute minimal
3416 // and maximal accesses to each array of a group in read only and non
3417 // read only partitions separately.
3418 AliasGroupVectorTy AliasGroups;
Tobias Grosser889830b2017-02-09 23:12:22 +00003419 DenseSet<const ScopArrayInfo *> HasWriteAccess;
Tobias Grossere39f9122017-01-16 14:08:00 +00003420
3421 std::tie(AliasGroups, HasWriteAccess) = buildAliasGroupsForAccesses(AA);
3422
3423 splitAliasGroupsByDomain(AliasGroups);
Johannes Doerferteeab05a2014-10-01 12:42:37 +00003424
Johannes Doerfert13771732014-10-01 12:40:46 +00003425 for (AliasGroupTy &AG : AliasGroups) {
Tobias Grosser78a7a6c2017-06-23 08:05:31 +00003426 if (!hasFeasibleRuntimeContext())
3427 return false;
3428
Tobias Grosser57a1d362017-06-23 08:05:27 +00003429 {
3430 IslMaxOperationsGuard MaxOpGuard(getIslCtx(), OptComputeOut);
3431 bool Valid = buildAliasGroup(AG, HasWriteAccess);
3432 if (!Valid)
3433 return false;
3434 }
3435 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
3436 invalidate(COMPLEXITY, DebugLoc());
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003437 return false;
Tobias Grosser57a1d362017-06-23 08:05:27 +00003438 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003439 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003440
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003441 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003442}
3443
Tobias Grosser77f32572017-01-16 15:49:07 +00003444bool Scop::buildAliasGroup(Scop::AliasGroupTy &AliasGroup,
Tobias Grosser889830b2017-02-09 23:12:22 +00003445 DenseSet<const ScopArrayInfo *> HasWriteAccess) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003446 AliasGroupTy ReadOnlyAccesses;
3447 AliasGroupTy ReadWriteAccesses;
Tobias Grosser889830b2017-02-09 23:12:22 +00003448 SmallPtrSet<const ScopArrayInfo *, 4> ReadWriteArrays;
Tobias Grosser079d5112017-02-18 20:51:29 +00003449 SmallPtrSet<const ScopArrayInfo *, 4> ReadOnlyArrays;
Tobias Grosser77f32572017-01-16 15:49:07 +00003450
Tobias Grosser77f32572017-01-16 15:49:07 +00003451 if (AliasGroup.size() < 2)
3452 return true;
3453
3454 for (MemoryAccess *Access : AliasGroup) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003455 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "PossibleAlias",
3456 Access->getAccessInstruction())
3457 << "Possibly aliasing pointer, use restrict keyword.");
Tobias Grosser889830b2017-02-09 23:12:22 +00003458 const ScopArrayInfo *Array = Access->getScopArrayInfo();
3459 if (HasWriteAccess.count(Array)) {
3460 ReadWriteArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003461 ReadWriteAccesses.push_back(Access);
3462 } else {
Tobias Grosser079d5112017-02-18 20:51:29 +00003463 ReadOnlyArrays.insert(Array);
Tobias Grosser77f32572017-01-16 15:49:07 +00003464 ReadOnlyAccesses.push_back(Access);
3465 }
3466 }
3467
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003468 // If there are no read-only pointers, and less than two read-write pointers,
3469 // no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003470 if (ReadOnlyAccesses.empty() && ReadWriteArrays.size() <= 1)
Tobias Grosser77f32572017-01-16 15:49:07 +00003471 return true;
3472
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003473 // If there is no read-write pointer, no alias check is needed.
Tobias Grosser889830b2017-02-09 23:12:22 +00003474 if (ReadWriteArrays.empty())
Tobias Grosser77f32572017-01-16 15:49:07 +00003475 return true;
3476
Tobias Grosserf3c145f2017-01-16 15:49:09 +00003477 // For non-affine accesses, no alias check can be generated as we cannot
3478 // compute a sufficiently tight lower and upper bound: bail out.
Tobias Grosser77f32572017-01-16 15:49:07 +00003479 for (MemoryAccess *MA : AliasGroup) {
3480 if (!MA->isAffine()) {
Eli Friedmane737fc12017-07-17 23:58:33 +00003481 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc(),
3482 MA->getAccessInstruction()->getParent());
Tobias Grosser77f32572017-01-16 15:49:07 +00003483 return false;
3484 }
Tobias Grosser0032d872017-01-16 15:49:14 +00003485 }
3486
3487 // Ensure that for all memory accesses for which we generate alias checks,
3488 // their base pointers are available.
3489 for (MemoryAccess *MA : AliasGroup) {
Tobias Grosser77f32572017-01-16 15:49:07 +00003490 if (MemoryAccess *BasePtrMA = lookupBasePtrAccess(MA))
3491 addRequiredInvariantLoad(
3492 cast<LoadInst>(BasePtrMA->getAccessInstruction()));
3493 }
3494
3495 MinMaxAliasGroups.emplace_back();
3496 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3497 MinMaxVectorTy &MinMaxAccessesReadWrite = pair.first;
3498 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3499
3500 bool Valid;
3501
3502 Valid =
3503 calculateMinMaxAccess(ReadWriteAccesses, *this, MinMaxAccessesReadWrite);
3504
3505 if (!Valid)
3506 return false;
3507
3508 // Bail out if the number of values we need to compare is too large.
3509 // This is important as the number of comparisons grows quadratically with
3510 // the number of values we need to compare.
Tobias Grosser079d5112017-02-18 20:51:29 +00003511 if (MinMaxAccessesReadWrite.size() + ReadOnlyArrays.size() >
Tobias Grosser77f32572017-01-16 15:49:07 +00003512 RunTimeChecksMaxArraysPerGroup)
3513 return false;
3514
3515 Valid =
3516 calculateMinMaxAccess(ReadOnlyAccesses, *this, MinMaxAccessesReadOnly);
3517
3518 if (!Valid)
3519 return false;
3520
3521 return true;
3522}
3523
Tobias Grosserc80d6972016-09-02 06:33:33 +00003524/// Get the smallest loop that contains @p S but is not in @p S.
Johannes Doerfertef744432016-05-23 12:42:38 +00003525static Loop *getLoopSurroundingScop(Scop &S, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003526 // Start with the smallest loop containing the entry and expand that
3527 // loop until it contains all blocks in the region. If there is a loop
3528 // containing all blocks in the region check if it is itself contained
3529 // and if so take the parent loop as it will be the smallest containing
3530 // the region but not contained by it.
Johannes Doerfertef744432016-05-23 12:42:38 +00003531 Loop *L = LI.getLoopFor(S.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003532 while (L) {
3533 bool AllContained = true;
Johannes Doerfertef744432016-05-23 12:42:38 +00003534 for (auto *BB : S.blocks())
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003535 AllContained &= L->contains(BB);
3536 if (AllContained)
3537 break;
3538 L = L->getParentLoop();
3539 }
3540
Johannes Doerfertef744432016-05-23 12:42:38 +00003541 return L ? (S.contains(L) ? L->getParentLoop() : L) : nullptr;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003542}
3543
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003544int Scop::NextScopID = 0;
3545
3546std::string Scop::CurrentFunc = "";
3547
3548int Scop::getNextID(std::string ParentFunc) {
3549 if (ParentFunc != CurrentFunc) {
3550 CurrentFunc = ParentFunc;
3551 NextScopID = 0;
3552 }
3553 return NextScopID++;
3554}
3555
Johannes Doerfertffd222f2016-05-19 12:34:57 +00003556Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
Eli Friedmane737fc12017-07-17 23:58:33 +00003557 ScopDetection::DetectionContext &DC, OptimizationRemarkEmitter &ORE)
Philip Pfaffe35bdcaf2017-05-15 13:43:01 +00003558 : SE(&ScalarEvolution), R(R), name(R.getNameStr()), IsOptimized(false),
Siddharth Bhat47c72372017-07-05 15:07:28 +00003559 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Eli Friedmane737fc12017-07-17 23:58:33 +00003560 MaxLoopDepth(0), CopyStmtsNum(0), SkipScop(false), DC(DC), ORE(ORE),
Roman Gareevb3224ad2016-09-14 06:26:09 +00003561 IslCtx(isl_ctx_alloc(), isl_ctx_free), Context(nullptr),
3562 Affinator(this, LI), AssumedContext(nullptr), InvalidContext(nullptr),
Singapuram Sanjay Srivallabh1abd9ff2017-07-12 16:46:19 +00003563 Schedule(nullptr),
3564 ID(getNextID((*R.getEntry()->getParent()).getName().str())) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003565 if (IslOnErrorAbort)
3566 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003567 buildContext();
3568}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003569
Tobias Grosserbedef002016-12-02 08:10:56 +00003570void Scop::foldSizeConstantsToRight() {
3571 isl_union_set *Accessed = isl_union_map_range(getAccesses());
3572
3573 for (auto Array : arrays()) {
3574 if (Array->getNumberOfDimensions() <= 1)
3575 continue;
3576
Tobias Grosser77eef902017-07-21 23:07:56 +00003577 isl_space *Space = Array->getSpace().release();
Tobias Grosserbedef002016-12-02 08:10:56 +00003578
3579 Space = isl_space_align_params(Space, isl_union_set_get_space(Accessed));
3580
3581 if (!isl_union_set_contains(Accessed, Space)) {
3582 isl_space_free(Space);
3583 continue;
3584 }
3585
3586 isl_set *Elements = isl_union_set_extract_set(Accessed, Space);
3587
3588 isl_map *Transform =
Tobias Grosser77eef902017-07-21 23:07:56 +00003589 isl_map_universe(isl_space_map_from_set(Array->getSpace().release()));
Tobias Grosserbedef002016-12-02 08:10:56 +00003590
3591 std::vector<int> Int;
3592
3593 int Dims = isl_set_dim(Elements, isl_dim_set);
3594 for (int i = 0; i < Dims; i++) {
3595 isl_set *DimOnly =
3596 isl_set_project_out(isl_set_copy(Elements), isl_dim_set, 0, i);
3597 DimOnly = isl_set_project_out(DimOnly, isl_dim_set, 1, Dims - i - 1);
3598 DimOnly = isl_set_lower_bound_si(DimOnly, isl_dim_set, 0, 0);
3599
3600 isl_basic_set *DimHull = isl_set_affine_hull(DimOnly);
3601
3602 if (i == Dims - 1) {
3603 Int.push_back(1);
3604 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3605 isl_basic_set_free(DimHull);
3606 continue;
3607 }
3608
3609 if (isl_basic_set_dim(DimHull, isl_dim_div) == 1) {
3610 isl_aff *Diff = isl_basic_set_get_div(DimHull, 0);
3611 isl_val *Val = isl_aff_get_denominator_val(Diff);
3612 isl_aff_free(Diff);
3613
3614 int ValInt = 1;
3615
3616 if (isl_val_is_int(Val))
3617 ValInt = isl_val_get_num_si(Val);
3618 isl_val_free(Val);
3619
3620 Int.push_back(ValInt);
3621
3622 isl_constraint *C = isl_constraint_alloc_equality(
3623 isl_local_space_from_space(isl_map_get_space(Transform)));
3624 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, ValInt);
3625 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, -1);
3626 Transform = isl_map_add_constraint(Transform, C);
3627 isl_basic_set_free(DimHull);
3628 continue;
3629 }
3630
3631 isl_basic_set *ZeroSet = isl_basic_set_copy(DimHull);
3632 ZeroSet = isl_basic_set_fix_si(ZeroSet, isl_dim_set, 0, 0);
3633
3634 int ValInt = 1;
3635 if (isl_basic_set_is_equal(ZeroSet, DimHull)) {
3636 ValInt = 0;
3637 }
3638
3639 Int.push_back(ValInt);
3640 Transform = isl_map_equate(Transform, isl_dim_in, i, isl_dim_out, i);
3641 isl_basic_set_free(DimHull);
3642 isl_basic_set_free(ZeroSet);
3643 }
3644
3645 isl_set *MappedElements = isl_map_domain(isl_map_copy(Transform));
3646
3647 if (!isl_set_is_subset(Elements, MappedElements)) {
3648 isl_set_free(Elements);
3649 isl_set_free(MappedElements);
3650 isl_map_free(Transform);
3651 continue;
3652 }
3653
3654 isl_set_free(MappedElements);
3655
3656 bool CanFold = true;
3657
3658 if (Int[0] <= 1)
3659 CanFold = false;
3660
3661 unsigned NumDims = Array->getNumberOfDimensions();
3662 for (unsigned i = 1; i < NumDims - 1; i++)
3663 if (Int[0] != Int[i] && Int[i])
3664 CanFold = false;
3665
3666 if (!CanFold) {
3667 isl_set_free(Elements);
3668 isl_map_free(Transform);
3669 continue;
3670 }
3671
Tobias Grosserbedef002016-12-02 08:10:56 +00003672 for (auto &Access : AccessFunctions)
3673 if (Access->getScopArrayInfo() == Array)
3674 Access->setAccessRelation(isl_map_apply_range(
3675 Access->getAccessRelation(), isl_map_copy(Transform)));
3676
3677 isl_map_free(Transform);
3678
3679 std::vector<const SCEV *> Sizes;
3680 for (unsigned i = 0; i < NumDims; i++) {
3681 auto Size = Array->getDimensionSize(i);
3682
3683 if (i == NumDims - 1)
3684 Size = SE->getMulExpr(Size, SE->getConstant(Size->getType(), Int[0]));
3685 Sizes.push_back(Size);
3686 }
3687
3688 Array->updateSizes(Sizes, false /* CheckConsistency */);
3689
3690 isl_set_free(Elements);
3691 }
3692 isl_union_set_free(Accessed);
3693 return;
3694}
3695
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003696void Scop::markFortranArrays() {
3697 for (ScopStmt &Stmt : Stmts) {
3698 for (MemoryAccess *MemAcc : Stmt) {
3699 Value *FAD = MemAcc->getFortranArrayDescriptor();
3700 if (!FAD)
3701 continue;
3702
3703 // TODO: const_cast-ing to edit
3704 ScopArrayInfo *SAI =
3705 const_cast<ScopArrayInfo *>(MemAcc->getLatestScopArrayInfo());
3706 assert(SAI && "memory access into a Fortran array does not "
3707 "have an associated ScopArrayInfo");
3708 SAI->applyAndSetFAD(FAD);
3709 }
3710 }
3711}
3712
Tobias Grosser491b7992016-12-02 05:21:22 +00003713void Scop::finalizeAccesses() {
3714 updateAccessDimensionality();
Tobias Grosserbedef002016-12-02 08:10:56 +00003715 foldSizeConstantsToRight();
Tobias Grosser491b7992016-12-02 05:21:22 +00003716 foldAccessRelations();
3717 assumeNoOutOfBounds();
Siddharth Bhatb7f68b82017-05-19 15:07:45 +00003718 markFortranArrays();
Tobias Grosser491b7992016-12-02 05:21:22 +00003719}
3720
Tobias Grosser75805372011-04-29 06:27:02 +00003721Scop::~Scop() {
3722 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003723 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003724 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003725 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003726
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003727 for (auto &It : ParameterIds)
3728 isl_id_free(It.second);
3729
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003730 for (auto &AS : RecordedAssumptions)
3731 isl_set_free(AS.Set);
3732
Johannes Doerfertb164c792014-09-18 11:17:17 +00003733 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003734 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003735 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003736 isl_pw_multi_aff_free(MMA.first);
3737 isl_pw_multi_aff_free(MMA.second);
3738 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003739 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003740 isl_pw_multi_aff_free(MMA.first);
3741 isl_pw_multi_aff_free(MMA.second);
3742 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003743 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003744
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003745 for (const auto &IAClass : InvariantEquivClasses)
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003746 isl_set_free(IAClass.ExecutionContext);
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003747
3748 // Explicitly release all Scop objects and the underlying isl objects before
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003749 // we release the isl context.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003750 Stmts.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003751 ScopArrayInfoSet.clear();
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003752 ScopArrayInfoMap.clear();
Roman Gareevd7754a12016-07-30 09:25:51 +00003753 ScopArrayNameMap.clear();
Roman Gareeve2ee79a2016-08-21 11:09:19 +00003754 AccessFunctions.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003755}
3756
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003757void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003758 // Check all array accesses for each base pointer and find a (virtual) element
3759 // size for the base pointer that divides all access functions.
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003760 for (ScopStmt &Stmt : *this)
3761 for (MemoryAccess *Access : Stmt) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003762 if (!Access->isArrayKind())
3763 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003764 ScopArrayInfo *Array =
Tobias Grossere24b7b92017-02-09 23:24:57 +00003765 const_cast<ScopArrayInfo *>(Access->getScopArrayInfo());
3766
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003767 if (Array->getNumberOfDimensions() != 1)
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003768 continue;
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003769 unsigned DivisibleSize = Array->getElemSizeInBytes();
3770 const SCEV *Subscript = Access->getSubscript(0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003771 while (!isDivisible(Subscript, DivisibleSize, *SE))
3772 DivisibleSize /= 2;
3773 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
Tobias Grosser9c7d1812017-02-09 23:24:54 +00003774 Array->updateElementType(Ty);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003775 }
3776
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003777 for (auto &Stmt : *this)
3778 for (auto &Access : Stmt)
3779 Access->updateDimensionality();
3780}
3781
Tobias Grosser491b7992016-12-02 05:21:22 +00003782void Scop::foldAccessRelations() {
3783 for (auto &Stmt : *this)
3784 for (auto &Access : Stmt)
3785 Access->foldAccessRelation();
3786}
3787
3788void Scop::assumeNoOutOfBounds() {
3789 for (auto &Stmt : *this)
3790 for (auto &Access : Stmt)
3791 Access->assumeNoOutOfBound();
3792}
3793
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003794void Scop::removeFromStmtMap(ScopStmt &Stmt) {
3795 if (Stmt.isRegionStmt())
3796 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3797 StmtMap.erase(BB);
3798 else
3799 StmtMap.erase(Stmt.getBasicBlock());
3800}
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003801
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003802void Scop::removeStmts(std::function<bool(ScopStmt &)> ShouldDelete) {
3803 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3804 if (!ShouldDelete(*StmtIt)) {
3805 StmtIt++;
3806 continue;
3807 }
3808
3809 removeFromStmtMap(*StmtIt);
3810 StmtIt = Stmts.erase(StmtIt);
3811 }
3812}
3813
3814void Scop::removeStmtNotInDomainMap() {
3815 auto ShouldDelete = [this](ScopStmt &Stmt) -> bool {
Tobias Grosser199ec4a2017-07-19 16:31:10 +00003816 return !this->DomainMap.lookup(Stmt.getEntryBlock());
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003817 };
3818 removeStmts(ShouldDelete);
3819}
3820
3821void Scop::simplifySCoP(bool AfterHoisting) {
3822
3823 auto ShouldDelete = [AfterHoisting](ScopStmt &Stmt) -> bool {
Johannes Doerfert26404542016-05-10 12:19:47 +00003824 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003825
Tobias Grosser3012a0b2017-07-16 22:44:17 +00003826 // Remove read only statements only after invariant load hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003827 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003828 bool OnlyRead = true;
3829 for (MemoryAccess *MA : Stmt) {
3830 if (MA->isRead())
3831 continue;
3832
3833 OnlyRead = false;
3834 break;
3835 }
3836
3837 RemoveStmt = OnlyRead;
3838 }
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003839 return RemoveStmt;
3840 };
Johannes Doerferteca9e892015-11-03 16:54:49 +00003841
Tobias Grosser21cbcf02017-07-16 23:55:38 +00003842 removeStmts(ShouldDelete);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003843}
3844
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003845InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003846 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3847 if (!LInst)
3848 return nullptr;
3849
3850 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3851 LInst = cast<LoadInst>(Rep);
3852
Johannes Doerfert96e54712016-02-07 17:30:13 +00003853 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003854 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003855 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003856 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfert549768c2016-03-24 13:22:16 +00003857 continue;
3858
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003859 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfert549768c2016-03-24 13:22:16 +00003860 for (auto *MA : MAs)
3861 if (MA->getAccessInstruction() == Val)
3862 return &IAClass;
3863 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003864
3865 return nullptr;
3866}
3867
Tobias Grosserc80d6972016-09-02 06:33:33 +00003868/// Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003869static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003870 bool MAInvalidCtxIsEmpty,
3871 bool NonHoistableCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003872 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3873 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3874 // TODO: We can provide more information for better but more expensive
3875 // results.
3876 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3877 LInst->getAlignment(), DL))
3878 return false;
3879
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003880 // If the location might be overwritten we do not hoist it unconditionally.
3881 //
3882 // TODO: This is probably to conservative.
3883 if (!NonHoistableCtxIsEmpty)
3884 return false;
3885
Michael Krusea6d48f52017-06-08 12:06:15 +00003886 // If a dereferenceable load is in a statement that is modeled precisely we
3887 // can hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003888 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003889 return true;
3890
3891 // Even if the statement is not modeled precisely we can hoist the load if it
Tobias Grossercdbe5c92017-01-06 17:30:34 +00003892 // does not involve any parameters that might have been specialized by the
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003893 // statement domain.
3894 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3895 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3896 return false;
3897 return true;
3898}
3899
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003900void Scop::addInvariantLoads(ScopStmt &Stmt, InvariantAccessesTy &InvMAs) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003901
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003902 if (InvMAs.empty())
3903 return;
3904
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003905 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003906 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003907
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003908 // Get the context under which the statement is executed but remove the error
3909 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003910 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003911 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003912
Tobias Grosser90411a92017-02-16 19:11:33 +00003913 if (isl_set_n_basic_set(DomainCtx) >= MaxDisjunctsInDomain) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003914 auto *AccInst = InvMAs.front().MA->getAccessInstruction();
Eli Friedmane737fc12017-07-17 23:58:33 +00003915 invalidate(COMPLEXITY, AccInst->getDebugLoc(), AccInst->getParent());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003916 isl_set_free(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003917 for (auto &InvMA : InvMAs)
3918 isl_set_free(InvMA.NonHoistableCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003919 return;
3920 }
3921
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003922 // Project out all parameters that relate to loads in the statement. Otherwise
3923 // we could have cyclic dependences on the constraints under which the
3924 // hoisted loads are executed and we could not determine an order in which to
3925 // pre-load them. This happens because not only lower bounds are part of the
3926 // domain but also upper bounds.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003927 for (auto &InvMA : InvMAs) {
3928 auto *MA = InvMA.MA;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003929 Instruction *AccInst = MA->getAccessInstruction();
3930 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003931 SetVector<Value *> Values;
3932 for (const SCEV *Parameter : Parameters) {
3933 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003934 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003935 if (!Values.count(AccInst))
3936 continue;
3937
3938 if (isl_id *ParamId = getIdForParam(Parameter)) {
3939 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
Tobias Grosserb58ed8d2017-03-17 09:02:53 +00003940 if (Dim >= 0)
3941 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003942 isl_id_free(ParamId);
3943 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003944 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003945 }
3946 }
3947
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003948 for (auto &InvMA : InvMAs) {
3949 auto *MA = InvMA.MA;
3950 auto *NHCtx = InvMA.NonHoistableCtx;
3951
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003952 // Check for another invariant access that accesses the same location as
3953 // MA and if found consolidate them. Otherwise create a new equivalence
3954 // class at the end of InvariantEquivClasses.
3955 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003956 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003957 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3958
Johannes Doerfert85676e32016-04-23 14:32:34 +00003959 auto *MAInvalidCtx = MA->getInvalidContext();
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003960 bool NonHoistableCtxIsEmpty = isl_set_is_empty(NHCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003961 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3962
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003963 isl_set *MACtx;
3964 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003965 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty,
3966 NonHoistableCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003967 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003968 isl_set_free(MAInvalidCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003969 isl_set_free(NHCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003970 } else {
3971 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert25227fe2016-05-23 10:40:54 +00003972 MACtx = isl_set_subtract(MACtx, isl_set_union(MAInvalidCtx, NHCtx));
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003973 MACtx = isl_set_gist_params(MACtx, getContext());
3974 }
3975
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003976 bool Consolidated = false;
3977 for (auto &IAClass : InvariantEquivClasses) {
Tobias Grosserfaef9a72016-07-11 12:27:04 +00003978 if (PointerSCEV != IAClass.IdentifyingPointer || Ty != IAClass.AccessType)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003979 continue;
3980
Johannes Doerfertdf880232016-03-03 12:26:58 +00003981 // If the pointer and the type is equal check if the access function wrt.
3982 // to the domain is equal too. It can happen that the domain fixes
3983 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003984 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003985 // create a new invariant load equivalence class.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00003986 auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertdf880232016-03-03 12:26:58 +00003987 if (!MAs.empty()) {
3988 auto *LastMA = MAs.front();
3989
3990 auto *AR = isl_map_range(MA->getAccessRelation());
3991 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3992 bool SameAR = isl_set_is_equal(AR, LastAR);
3993 isl_set_free(AR);
3994 isl_set_free(LastAR);
3995
3996 if (!SameAR)
3997 continue;
3998 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003999
4000 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004001 MAs.push_front(MA);
4002
Johannes Doerfertdf880232016-03-03 12:26:58 +00004003 Consolidated = true;
4004
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004005 // Unify the execution context of the class and this statement.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004006 isl_set *&IAClassDomainCtx = IAClass.ExecutionContext;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00004007 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00004008 IAClassDomainCtx =
4009 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00004010 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00004011 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004012 break;
4013 }
4014
4015 if (Consolidated)
4016 continue;
4017
4018 // If we did not consolidate MA, thus did not find an equivalence class
4019 // for it, we create a new one.
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004020 InvariantEquivClasses.emplace_back(
4021 InvariantEquivClassTy{PointerSCEV, MemoryAccessList{MA}, MACtx, Ty});
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004022 }
4023
4024 isl_set_free(DomainCtx);
4025}
4026
Tobias Grosser1eeedf42017-07-20 19:55:19 +00004027/// Check if an access range is too complex.
4028///
4029/// An access range is too complex, if it contains either many disjuncts or
4030/// very complex expressions. As a simple heuristic, we assume if a set to
4031/// be too complex if the sum of existentially quantified dimensions and
4032/// set dimensions is larger than a threshold. This reliably detects both
4033/// sets with many disjuncts as well as sets with many divisions as they
4034/// arise in h264.
4035///
4036/// @param AccessRange The range to check for complexity.
4037///
4038/// @returns True if the access range is too complex.
4039static bool isAccessRangeTooComplex(isl::set AccessRange) {
4040 unsigned NumTotalDims = 0;
4041
4042 auto CountDimensions = [&NumTotalDims](isl::basic_set BSet) -> isl::stat {
4043 NumTotalDims += BSet.dim(isl::dim::div);
4044 NumTotalDims += BSet.dim(isl::dim::set);
4045 return isl::stat::ok;
4046 };
4047
4048 AccessRange.foreach_basic_set(CountDimensions);
4049
4050 if (NumTotalDims > MaxDimensionsInAccessRange)
4051 return true;
4052
4053 return false;
4054}
4055
Tobias Grosser4071cb52017-06-06 23:13:02 +00004056isl::set Scop::getNonHoistableCtx(MemoryAccess *Access, isl::union_map Writes) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004057 // TODO: Loads that are not loop carried, hence are in a statement with
4058 // zero iterators, are by construction invariant, though we
4059 // currently "hoist" them anyway. This is necessary because we allow
4060 // them to be treated as parameters (e.g., in conditions) and our code
4061 // generation would otherwise use the old value.
4062
4063 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00004064 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004065
Johannes Doerfertc9765462016-11-17 22:11:56 +00004066 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine() ||
4067 Access->isMemoryIntrinsic())
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004068 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004069
4070 // Skip accesses that have an invariant base pointer which is defined but
4071 // not loaded inside the SCoP. This can happened e.g., if a readnone call
4072 // returns a pointer that is used as a base address. However, as we want
4073 // to hoist indirect pointers, we allow the base pointer to be defined in
4074 // the region if it is also a memory access. Each ScopArrayInfo object
4075 // that has a base pointer origin has a base pointer that is loaded and
4076 // that it is invariant, thus it will be hoisted too. However, if there is
4077 // no base pointer origin we check that the base pointer is defined
4078 // outside the region.
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004079 auto *LI = cast<LoadInst>(Access->getAccessInstruction());
Johannes Doerfert764b7e62016-05-23 09:26:46 +00004080 if (hasNonHoistableBasePtrInScop(Access, Writes))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004081 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004082
Tobias Grosser4071cb52017-06-06 23:13:02 +00004083 isl::map AccessRelation = give(Access->getAccessRelation());
4084 assert(!AccessRelation.is_empty());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004085
Tobias Grosser4071cb52017-06-06 23:13:02 +00004086 if (AccessRelation.involves_dims(isl::dim::in, 0, Stmt.getNumIterators()))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004087 return nullptr;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004088
Tobias Grosser4071cb52017-06-06 23:13:02 +00004089 AccessRelation = AccessRelation.intersect_domain(give(Stmt.getDomain()));
4090 isl::set SafeToLoad;
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004091
4092 auto &DL = getFunction().getParent()->getDataLayout();
4093 if (isSafeToLoadUnconditionally(LI->getPointerOperand(), LI->getAlignment(),
4094 DL)) {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004095 SafeToLoad = isl::set::universe(AccessRelation.get_space().range());
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004096 } else if (BB != LI->getParent()) {
4097 // Skip accesses in non-affine subregions as they might not be executed
4098 // under the same condition as the entry of the non-affine subregion.
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004099 return nullptr;
4100 } else {
Tobias Grosser4071cb52017-06-06 23:13:02 +00004101 SafeToLoad = AccessRelation.range();
Tobias Grosserc96c1d82017-04-27 20:08:16 +00004102 }
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004103
Tobias Grosser1eeedf42017-07-20 19:55:19 +00004104 if (isAccessRangeTooComplex(AccessRelation.range()))
4105 return nullptr;
4106
Tobias Grosser4071cb52017-06-06 23:13:02 +00004107 isl::union_map Written = Writes.intersect_range(SafeToLoad);
4108 isl::set WrittenCtx = Written.params();
4109 bool IsWritten = !WrittenCtx.is_empty();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004110
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004111 if (!IsWritten)
4112 return WrittenCtx;
4113
Tobias Grosser4071cb52017-06-06 23:13:02 +00004114 WrittenCtx = WrittenCtx.remove_divs();
4115 bool TooComplex =
4116 isl_set_n_basic_set(WrittenCtx.get()) >= MaxDisjunctsInDomain;
4117 if (TooComplex || !isRequiredInvariantLoad(LI))
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004118 return nullptr;
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004119
Tobias Grosser4071cb52017-06-06 23:13:02 +00004120 addAssumption(INVARIANTLOAD, WrittenCtx.copy(), LI->getDebugLoc(),
Eli Friedmane737fc12017-07-17 23:58:33 +00004121 AS_RESTRICTION, LI->getParent());
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004122 return WrittenCtx;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004123}
4124
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004125void Scop::verifyInvariantLoads() {
4126 auto &RIL = getRequiredInvariantLoads();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004127 for (LoadInst *LI : RIL) {
Johannes Doerfert952b5302016-05-23 12:40:48 +00004128 assert(LI && contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00004129 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00004130 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004131 invalidate(INVARIANTLOAD, LI->getDebugLoc(), LI->getParent());
Tobias Grosser29f38ab2015-12-13 21:00:40 +00004132 return;
4133 }
4134 }
4135}
4136
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004137void Scop::hoistInvariantLoads() {
Tobias Grosser0865e7752016-02-29 07:29:42 +00004138 if (!PollyInvariantLoadHoisting)
4139 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004140
Tobias Grosser4071cb52017-06-06 23:13:02 +00004141 isl::union_map Writes = give(getWrites());
Tobias Grosser0865e7752016-02-29 07:29:42 +00004142 for (ScopStmt &Stmt : *this) {
Johannes Doerfert25227fe2016-05-23 10:40:54 +00004143 InvariantAccessesTy InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004144
Tobias Grosser0865e7752016-02-29 07:29:42 +00004145 for (MemoryAccess *Access : Stmt)
Tobias Grosser4071cb52017-06-06 23:13:02 +00004146 if (isl::set NHCtx = getNonHoistableCtx(Access, Writes))
4147 InvariantAccesses.push_back({Access, NHCtx.release()});
Tobias Grosser0865e7752016-02-29 07:29:42 +00004148
4149 // Transfer the memory access from the statement to the SCoP.
Michael Kruse10071822016-05-23 14:45:58 +00004150 for (auto InvMA : InvariantAccesses)
4151 Stmt.removeMemoryAccess(InvMA.MA);
Tobias Grosser0865e7752016-02-29 07:29:42 +00004152 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004153 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004154}
4155
Tobias Grosserf3adab42017-05-10 10:59:58 +00004156/// Find the canonical scop array info object for a set of invariant load
4157/// hoisted loads. The canonical array is the one that corresponds to the
4158/// first load in the list of accesses which is used as base pointer of a
4159/// scop array.
4160static const ScopArrayInfo *findCanonicalArray(Scop *S,
4161 MemoryAccessList &Accesses) {
4162 for (MemoryAccess *Access : Accesses) {
4163 const ScopArrayInfo *CanonicalArray = S->getScopArrayInfoOrNull(
4164 Access->getAccessInstruction(), MemoryKind::Array);
4165 if (CanonicalArray)
4166 return CanonicalArray;
4167 }
4168 return nullptr;
4169}
4170
4171/// Check if @p Array severs as base array in an invariant load.
4172static bool isUsedForIndirectHoistedLoad(Scop *S, const ScopArrayInfo *Array) {
4173 for (InvariantEquivClassTy &EqClass2 : S->getInvariantAccesses())
4174 for (MemoryAccess *Access2 : EqClass2.InvariantAccesses)
4175 if (Access2->getScopArrayInfo() == Array)
4176 return true;
4177 return false;
4178}
4179
4180/// Replace the base pointer arrays in all memory accesses referencing @p Old,
4181/// with a reference to @p New.
4182static void replaceBasePtrArrays(Scop *S, const ScopArrayInfo *Old,
4183 const ScopArrayInfo *New) {
4184 for (ScopStmt &Stmt : *S)
4185 for (MemoryAccess *Access : Stmt) {
4186 if (Access->getLatestScopArrayInfo() != Old)
4187 continue;
4188
Tobias Grosser77eef902017-07-21 23:07:56 +00004189 isl_id *Id = New->getBasePtrId().release();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004190 isl_map *Map = Access->getAccessRelation();
4191 Map = isl_map_set_tuple_id(Map, isl_dim_out, Id);
4192 Access->setAccessRelation(Map);
4193 }
4194}
4195
4196void Scop::canonicalizeDynamicBasePtrs() {
4197 for (InvariantEquivClassTy &EqClass : InvariantEquivClasses) {
4198 MemoryAccessList &BasePtrAccesses = EqClass.InvariantAccesses;
4199
4200 const ScopArrayInfo *CanonicalBasePtrSAI =
4201 findCanonicalArray(this, BasePtrAccesses);
4202
4203 if (!CanonicalBasePtrSAI)
4204 continue;
4205
4206 for (MemoryAccess *BasePtrAccess : BasePtrAccesses) {
4207 const ScopArrayInfo *BasePtrSAI = getScopArrayInfoOrNull(
4208 BasePtrAccess->getAccessInstruction(), MemoryKind::Array);
4209 if (!BasePtrSAI || BasePtrSAI == CanonicalBasePtrSAI ||
4210 !BasePtrSAI->isCompatibleWith(CanonicalBasePtrSAI))
4211 continue;
4212
4213 // we currently do not canonicalize arrays where some accesses are
4214 // hoisted as invariant loads. If we would, we need to update the access
4215 // function of the invariant loads as well. However, as this is not a
4216 // very common situation, we leave this for now to avoid further
4217 // complexity increases.
4218 if (isUsedForIndirectHoistedLoad(this, BasePtrSAI))
4219 continue;
4220
4221 replaceBasePtrArrays(this, BasePtrSAI, CanonicalBasePtrSAI);
4222 }
4223 }
4224}
4225
Michael Kruseb738ffa2017-06-28 13:02:43 +00004226ScopArrayInfo *Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
4227 ArrayRef<const SCEV *> Sizes,
4228 MemoryKind Kind,
4229 const char *BaseName) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004230 assert((BasePtr || BaseName) &&
4231 "BasePtr and BaseName can not be nullptr at the same time.");
4232 assert(!(BasePtr && BaseName) && "BaseName is redundant.");
4233 auto &SAI = BasePtr ? ScopArrayInfoMap[std::make_pair(BasePtr, Kind)]
4234 : ScopArrayNameMap[BaseName];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004235 if (!SAI) {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004236 auto &DL = getFunction().getParent()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00004237 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Roman Gareevd7754a12016-07-30 09:25:51 +00004238 DL, this, BaseName));
4239 ScopArrayInfoSet.insert(SAI.get());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004240 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004241 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00004242 // In case of mismatching array sizes, we bail out by setting the run-time
4243 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00004244 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004245 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00004246 }
Tobias Grosserab671442015-05-23 05:58:27 +00004247 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004248}
4249
Michael Kruseb738ffa2017-06-28 13:02:43 +00004250ScopArrayInfo *Scop::createScopArrayInfo(Type *ElementType,
4251 const std::string &BaseName,
4252 const std::vector<unsigned> &Sizes) {
Roman Gareevd7754a12016-07-30 09:25:51 +00004253 auto *DimSizeType = Type::getInt64Ty(getSE()->getContext());
4254 std::vector<const SCEV *> SCEVSizes;
4255
4256 for (auto size : Sizes)
Roman Gareevf5aff702016-09-12 17:08:31 +00004257 if (size)
4258 SCEVSizes.push_back(getSE()->getConstant(DimSizeType, size, false));
4259 else
4260 SCEVSizes.push_back(nullptr);
Roman Gareevd7754a12016-07-30 09:25:51 +00004261
Tobias Grosser4d5a9172017-01-14 20:25:44 +00004262 auto *SAI = getOrCreateScopArrayInfo(nullptr, ElementType, SCEVSizes,
4263 MemoryKind::Array, BaseName.c_str());
Roman Gareevd7754a12016-07-30 09:25:51 +00004264 return SAI;
4265}
4266
Tobias Grosserf3adab42017-05-10 10:59:58 +00004267const ScopArrayInfo *Scop::getScopArrayInfoOrNull(Value *BasePtr,
4268 MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00004269 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Tobias Grosserf3adab42017-05-10 10:59:58 +00004270 return SAI;
4271}
4272
4273const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, MemoryKind Kind) {
4274 auto *SAI = getScopArrayInfoOrNull(BasePtr, Kind);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00004275 assert(SAI && "No ScopArrayInfo available for this base pointer");
4276 return SAI;
4277}
4278
Tobias Grosser74394f02013-01-14 22:40:23 +00004279std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004280
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004281std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004282 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004283 return stringFromIslObj(AssumedContext);
4284}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004285
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004286std::string Scop::getInvalidContextStr() const {
4287 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004288}
Tobias Grosser75805372011-04-29 06:27:02 +00004289
4290std::string Scop::getNameStr() const {
4291 std::string ExitName, EntryName;
Siddharth Bhat07bee292017-06-02 08:01:22 +00004292 std::tie(EntryName, ExitName) = getEntryExitStr();
4293 return EntryName + "---" + ExitName;
4294}
4295
4296std::pair<std::string, std::string> Scop::getEntryExitStr() const {
4297 std::string ExitName, EntryName;
Tobias Grosser75805372011-04-29 06:27:02 +00004298 raw_string_ostream ExitStr(ExitName);
4299 raw_string_ostream EntryStr(EntryName);
4300
Tobias Grosserf240b482014-01-09 10:42:15 +00004301 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004302 EntryStr.str();
4303
4304 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00004305 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00004306 ExitStr.str();
4307 } else
4308 ExitName = "FunctionExit";
4309
Siddharth Bhat07bee292017-06-02 08:01:22 +00004310 return std::make_pair(EntryName, ExitName);
Tobias Grosser75805372011-04-29 06:27:02 +00004311}
4312
Tobias Grosser74394f02013-01-14 22:40:23 +00004313__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00004314__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00004315 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00004316}
4317
Tobias Grossere86109f2013-10-29 21:05:49 +00004318__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004319 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00004320 return isl_set_copy(AssumedContext);
4321}
4322
Michael Krusef3091bf2017-03-17 13:09:52 +00004323bool Scop::isProfitable(bool ScalarsAreUnprofitable) const {
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004324 if (PollyProcessUnprofitable)
4325 return true;
4326
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004327 if (isEmpty())
4328 return false;
4329
4330 unsigned OptimizableStmtsOrLoops = 0;
4331 for (auto &Stmt : *this) {
4332 if (Stmt.getNumIterators() == 0)
4333 continue;
4334
4335 bool ContainsArrayAccs = false;
4336 bool ContainsScalarAccs = false;
4337 for (auto *MA : Stmt) {
4338 if (MA->isRead())
4339 continue;
Michael Krusef3091bf2017-03-17 13:09:52 +00004340 ContainsArrayAccs |= MA->isLatestArrayKind();
4341 ContainsScalarAccs |= MA->isLatestScalarKind();
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004342 }
4343
Michael Krusef3091bf2017-03-17 13:09:52 +00004344 if (!ScalarsAreUnprofitable || (ContainsArrayAccs && !ContainsScalarAccs))
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004345 OptimizableStmtsOrLoops += Stmt.getNumIterators();
4346 }
4347
4348 return OptimizableStmtsOrLoops > 1;
4349}
4350
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00004351bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004352 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004353 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00004354 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
4355 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
4356 isl_set_is_subset(PositiveContext, NegativeContext));
4357 isl_set_free(PositiveContext);
4358 if (!IsFeasible) {
4359 isl_set_free(NegativeContext);
4360 return false;
4361 }
4362
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004363 auto *DomainContext = isl_union_set_params(getDomains());
4364 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00004365 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004366 isl_set_free(NegativeContext);
4367 isl_set_free(DomainContext);
4368
Johannes Doerfert43788c52015-08-20 05:58:56 +00004369 return IsFeasible;
4370}
4371
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004372static std::string toString(AssumptionKind Kind) {
4373 switch (Kind) {
4374 case ALIASING:
4375 return "No-aliasing";
4376 case INBOUNDS:
4377 return "Inbounds";
4378 case WRAPPING:
4379 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00004380 case UNSIGNED:
4381 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004382 case COMPLEXITY:
4383 return "Low complexity";
Johannes Doerfert27d12d32016-05-10 16:38:09 +00004384 case PROFITABLE:
4385 return "Profitable";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004386 case ERRORBLOCK:
4387 return "No-error";
4388 case INFINITELOOP:
4389 return "Finite loop";
4390 case INVARIANTLOAD:
4391 return "Invariant load";
4392 case DELINEARIZATION:
4393 return "Delinearization";
4394 }
4395 llvm_unreachable("Unknown AssumptionKind!");
4396}
4397
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004398bool Scop::isEffectiveAssumption(__isl_keep isl_set *Set, AssumptionSign Sign) {
4399 if (Sign == AS_ASSUMPTION) {
4400 if (isl_set_is_subset(Context, Set))
4401 return false;
4402
4403 if (isl_set_is_subset(AssumedContext, Set))
4404 return false;
4405 } else {
4406 if (isl_set_is_disjoint(Set, Context))
4407 return false;
4408
4409 if (isl_set_is_subset(Set, InvalidContext))
4410 return false;
4411 }
4412 return true;
4413}
4414
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004415bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
Eli Friedmane737fc12017-07-17 23:58:33 +00004416 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert1a6b0f72016-06-06 12:16:10 +00004417 if (PollyRemarksMinimal && !isEffectiveAssumption(Set, Sign))
4418 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004419
Johannes Doerfertb3265a32016-11-17 22:08:40 +00004420 // Do never emit trivial assumptions as they only clutter the output.
4421 if (!PollyRemarksMinimal) {
4422 isl_set *Univ = nullptr;
4423 if (Sign == AS_ASSUMPTION)
4424 Univ = isl_set_universe(isl_set_get_space(Set));
4425
4426 bool IsTrivial = (Sign == AS_RESTRICTION && isl_set_is_empty(Set)) ||
4427 (Sign == AS_ASSUMPTION && isl_set_is_equal(Univ, Set));
4428 isl_set_free(Univ);
4429
4430 if (IsTrivial)
4431 return false;
4432 }
4433
Johannes Doerfertcd195322016-11-17 21:41:08 +00004434 switch (Kind) {
4435 case ALIASING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004436 AssumptionsAliasing++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004437 break;
4438 case INBOUNDS:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004439 AssumptionsInbounds++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004440 break;
4441 case WRAPPING:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004442 AssumptionsWrapping++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004443 break;
4444 case UNSIGNED:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004445 AssumptionsUnsigned++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004446 break;
4447 case COMPLEXITY:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004448 AssumptionsComplexity++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004449 break;
4450 case PROFITABLE:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004451 AssumptionsUnprofitable++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004452 break;
4453 case ERRORBLOCK:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004454 AssumptionsErrorBlock++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004455 break;
4456 case INFINITELOOP:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004457 AssumptionsInfiniteLoop++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004458 break;
4459 case INVARIANTLOAD:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004460 AssumptionsInvariantLoad++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004461 break;
4462 case DELINEARIZATION:
Johannes Doerfert81aa6e82016-11-18 14:37:08 +00004463 AssumptionsDelinearization++;
Johannes Doerfertcd195322016-11-17 21:41:08 +00004464 break;
4465 }
4466
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004467 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
4468 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Eli Friedmane737fc12017-07-17 23:58:33 +00004469 if (BB)
4470 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc, BB)
4471 << Msg);
4472 else
4473 ORE.emit(OptimizationRemarkAnalysis(DEBUG_TYPE, "AssumpRestrict", Loc,
4474 R.getEntry())
4475 << Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004476 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00004477}
4478
4479void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Eli Friedmane737fc12017-07-17 23:58:33 +00004480 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004481 // Simplify the assumptions/restrictions first.
4482 Set = isl_set_gist_params(Set, getContext());
4483
Eli Friedmane737fc12017-07-17 23:58:33 +00004484 if (!trackAssumption(Kind, Set, Loc, Sign, BB)) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004485 isl_set_free(Set);
4486 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00004487 }
4488
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004489 if (Sign == AS_ASSUMPTION) {
4490 AssumedContext = isl_set_intersect(AssumedContext, Set);
4491 AssumedContext = isl_set_coalesce(AssumedContext);
4492 } else {
4493 InvalidContext = isl_set_union(InvalidContext, Set);
4494 InvalidContext = isl_set_coalesce(InvalidContext);
4495 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004496}
4497
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004498void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004499 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
Tobias Grosserf67433a2016-11-10 11:44:10 +00004500 assert((isl_set_is_params(Set) || BB) &&
4501 "Assumptions without a basic block must be parameter sets");
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004502 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004503}
4504
4505void Scop::addRecordedAssumptions() {
4506 while (!RecordedAssumptions.empty()) {
4507 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004508
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004509 if (!AS.BB) {
Eli Friedmane737fc12017-07-17 23:58:33 +00004510 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign, nullptr /* BasicBlock */);
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004511 continue;
4512 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00004513
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00004514 // If the domain was deleted the assumptions are void.
4515 isl_set *Dom = getDomainConditions(AS.BB);
4516 if (!Dom) {
4517 isl_set_free(AS.Set);
4518 continue;
4519 }
4520
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004521 // If a basic block was given use its domain to simplify the assumption.
4522 // In case of restrictions we know they only have to hold on the domain,
4523 // thus we can intersect them with the domain of the block. However, for
4524 // assumptions the domain has to imply them, thus:
4525 // _ _____
4526 // Dom => S <==> A v B <==> A - B
4527 //
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004528 // To avoid the complement we will register A - B as a restriction not an
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004529 // assumption.
4530 isl_set *S = AS.Set;
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00004531 if (AS.Sign == AS_RESTRICTION)
4532 S = isl_set_params(isl_set_intersect(S, Dom));
4533 else /* (AS.Sign == AS_ASSUMPTION) */
4534 S = isl_set_params(isl_set_subtract(Dom, S));
4535
Eli Friedmane737fc12017-07-17 23:58:33 +00004536 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION, AS.BB);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00004537 }
4538}
4539
Eli Friedmane737fc12017-07-17 23:58:33 +00004540void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc, BasicBlock *BB) {
4541 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION, BB);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00004542}
4543
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004544__isl_give isl_set *Scop::getInvalidContext() const {
4545 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004546}
4547
Tobias Grosser75805372011-04-29 06:27:02 +00004548void Scop::printContext(raw_ostream &OS) const {
4549 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004550 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00004551
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004552 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004553 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00004554
Johannes Doerfert066dbf32016-03-01 13:06:28 +00004555 OS.indent(4) << "Invalid Context:\n";
4556 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00004557
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00004558 unsigned Dim = 0;
4559 for (const SCEV *Parameter : Parameters)
4560 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004561}
4562
Johannes Doerfertb164c792014-09-18 11:17:17 +00004563void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004564 int noOfGroups = 0;
4565 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004566 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004567 noOfGroups += 1;
4568 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004569 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004570 }
4571
Tobias Grosserbb853c22015-07-25 12:31:03 +00004572 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00004573 if (MinMaxAliasGroups.empty()) {
4574 OS.indent(8) << "n/a\n";
4575 return;
4576 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004577
Tobias Grosserbb853c22015-07-25 12:31:03 +00004578 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004579
4580 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004581 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004582 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004583 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004584 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4585 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004586 }
4587 OS << " ]]\n";
4588 }
4589
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004590 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004591 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00004592 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00004593 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00004594 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
4595 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00004596 }
4597 OS << " ]]\n";
4598 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00004599 }
4600}
4601
Michael Krusecd4c9772017-07-21 15:35:53 +00004602void Scop::printStatements(raw_ostream &OS, bool PrintInstructions) const {
Tobias Grosser75805372011-04-29 06:27:02 +00004603 OS << "Statements {\n";
4604
Michael Krusecd4c9772017-07-21 15:35:53 +00004605 for (const ScopStmt &Stmt : *this) {
4606 OS.indent(4);
4607 Stmt.print(OS, PrintInstructions);
4608 }
Tobias Grosser75805372011-04-29 06:27:02 +00004609
4610 OS.indent(4) << "}\n";
4611}
4612
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004613void Scop::printArrayInfo(raw_ostream &OS) const {
4614 OS << "Arrays {\n";
4615
Tobias Grosserab671442015-05-23 05:58:27 +00004616 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004617 Array->print(OS);
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004618
4619 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004620
4621 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
4622
4623 for (auto &Array : arrays())
Roman Gareevd7754a12016-07-30 09:25:51 +00004624 Array->print(OS, /* SizeAsPwAff */ true);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00004625
4626 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004627}
4628
Michael Krusecd4c9772017-07-21 15:35:53 +00004629void Scop::print(raw_ostream &OS, bool PrintInstructions) const {
Johannes Doerfert3f52e352016-05-23 12:38:05 +00004630 OS.indent(4) << "Function: " << getFunction().getName() << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00004631 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00004632 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004633 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004634 for (const auto &IAClass : InvariantEquivClasses) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004635 const auto &MAs = IAClass.InvariantAccesses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004636 if (MAs.empty()) {
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004637 OS.indent(12) << "Class Pointer: " << *IAClass.IdentifyingPointer << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004638 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00004639 MAs.front()->print(OS);
Tobias Grosser4e2d9c42016-07-11 12:15:10 +00004640 OS.indent(12) << "Execution Context: " << IAClass.ExecutionContext
4641 << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00004642 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00004643 }
4644 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00004645 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00004646 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00004647 printAliasAssumptions(OS);
Michael Krusecd4c9772017-07-21 15:35:53 +00004648 printStatements(OS.indent(4), PrintInstructions);
Tobias Grosser75805372011-04-29 06:27:02 +00004649}
4650
Michael Kruse5d518462017-07-21 15:54:07 +00004651#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Michael Krusee1860132017-07-21 15:54:13 +00004652LLVM_DUMP_METHOD void Scop::dump() const { print(dbgs(), true); }
Michael Kruse5d518462017-07-21 15:54:07 +00004653#endif
Tobias Grosser75805372011-04-29 06:27:02 +00004654
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004655isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00004656
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004657__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
4658 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004659 // First try to use the SCEVAffinator to generate a piecewise defined
4660 // affine function from @p E in the context of @p BB. If that tasks becomes to
4661 // complex the affinator might return a nullptr. In such a case we invalidate
4662 // the SCoP and return a dummy value. This way we do not need to add error
Tobias Grossercdbe5c92017-01-06 17:30:34 +00004663 // handling code to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004664 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004665 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00004666 // TODO: We could use a heuristic and either use:
4667 // SCEVAffinator::takeNonNegativeAssumption
4668 // or
4669 // SCEVAffinator::interpretAsUnsigned
4670 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004671 if (NonNegative)
4672 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004673 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00004674 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004675
4676 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
Eli Friedmane737fc12017-07-17 23:58:33 +00004677 invalidate(COMPLEXITY, DL, BB);
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00004678 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00004679}
4680
Tobias Grosser808cd692015-07-14 09:33:13 +00004681__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosser941cb7d2017-03-17 09:02:50 +00004682 isl_space *EmptySpace = isl_space_params_alloc(getIslCtx(), 0);
4683 isl_union_set *Domain = isl_union_set_empty(EmptySpace);
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004684
Tobias Grosser808cd692015-07-14 09:33:13 +00004685 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004686 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00004687
4688 return Domain;
4689}
4690
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00004691__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
4692 PWACtx PWAC = getPwAff(E, BB);
4693 isl_set_free(PWAC.second);
4694 return PWAC.first;
4695}
4696
Tobias Grossere5a35142015-11-12 14:07:09 +00004697__isl_give isl_union_map *
4698Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
4699 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004700
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004701 for (ScopStmt &Stmt : *this) {
4702 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00004703 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004704 continue;
4705
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004706 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004707 isl_map *AccessDomain = MA->getAccessRelation();
4708 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00004709 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004710 }
4711 }
Tobias Grossere5a35142015-11-12 14:07:09 +00004712 return isl_union_map_coalesce(Accesses);
4713}
4714
4715__isl_give isl_union_map *Scop::getMustWrites() {
4716 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004717}
4718
4719__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004720 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00004721}
4722
Tobias Grosser37eb4222014-02-20 21:43:54 +00004723__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004724 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004725}
4726
4727__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00004728 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00004729}
4730
Tobias Grosser2ac23382015-11-12 14:07:13 +00004731__isl_give isl_union_map *Scop::getAccesses() {
4732 return getAccessesOfType([](MemoryAccess &MA) { return true; });
4733}
4734
Roman Gareevb3224ad2016-09-14 06:26:09 +00004735// Check whether @p Node is an extension node.
4736//
4737// @return true if @p Node is an extension node.
4738isl_bool isNotExtNode(__isl_keep isl_schedule_node *Node, void *User) {
4739 if (isl_schedule_node_get_type(Node) == isl_schedule_node_extension)
4740 return isl_bool_error;
4741 else
4742 return isl_bool_true;
4743}
4744
4745bool Scop::containsExtensionNode(__isl_keep isl_schedule *Schedule) {
4746 return isl_schedule_foreach_schedule_node_top_down(Schedule, isNotExtNode,
4747 nullptr) == isl_stat_error;
4748}
4749
Tobias Grosser808cd692015-07-14 09:33:13 +00004750__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004751 auto *Tree = getScheduleTree();
Roman Gareevb3224ad2016-09-14 06:26:09 +00004752 if (containsExtensionNode(Tree)) {
4753 isl_schedule_free(Tree);
4754 return nullptr;
4755 }
Johannes Doerferta90943d2016-02-21 16:37:25 +00004756 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00004757 isl_schedule_free(Tree);
4758 return S;
4759}
Tobias Grosser37eb4222014-02-20 21:43:54 +00004760
Tobias Grosser808cd692015-07-14 09:33:13 +00004761__isl_give isl_schedule *Scop::getScheduleTree() const {
4762 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
4763 getDomains());
4764}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00004765
Tobias Grosser808cd692015-07-14 09:33:13 +00004766void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
4767 auto *S = isl_schedule_from_domain(getDomains());
4768 S = isl_schedule_insert_partial_schedule(
4769 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
4770 isl_schedule_free(Schedule);
4771 Schedule = S;
4772}
4773
4774void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
4775 isl_schedule_free(Schedule);
4776 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00004777}
4778
4779bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
4780 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004781 for (ScopStmt &Stmt : *this) {
4782 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00004783 isl_union_set *NewStmtDomain = isl_union_set_intersect(
4784 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
4785
4786 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
4787 isl_union_set_free(StmtDomain);
4788 isl_union_set_free(NewStmtDomain);
4789 continue;
4790 }
4791
4792 Changed = true;
4793
4794 isl_union_set_free(StmtDomain);
4795 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
4796
4797 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004798 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004799 isl_union_set_free(NewStmtDomain);
4800 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00004801 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00004802 }
4803 isl_union_set_free(Domain);
4804 return Changed;
4805}
4806
Tobias Grosser75805372011-04-29 06:27:02 +00004807ScalarEvolution *Scop::getSE() const { return SE; }
4808
Tobias Grosserc80d6972016-09-02 06:33:33 +00004809// Create an isl_multi_union_aff that defines an identity mapping from the
4810// elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00004811//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004812// # Example:
4813//
4814// Domain: { A[i,j]; B[i,j,k] }
4815// N: 1
4816//
4817// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
4818//
4819// @param USet A union set describing the elements for which to generate a
4820// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00004821// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004822// @returns A mapping from USet to its N-th dimension.
Tobias Grosser99320862017-05-26 17:22:03 +00004823static isl::multi_union_pw_aff mapToDimension(isl::union_set USet, int N) {
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004824 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00004825 assert(USet);
Siddharth Bhat8bb436e2017-05-29 11:34:29 +00004826 assert(!USet.is_empty());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004827
Tobias Grosser99320862017-05-26 17:22:03 +00004828 auto Result = isl::union_pw_multi_aff::empty(USet.get_space());
Tobias Grosser808cd692015-07-14 09:33:13 +00004829
Tobias Grosser99320862017-05-26 17:22:03 +00004830 auto Lambda = [&Result, N](isl::set S) -> isl::stat {
4831 int Dim = S.dim(isl::dim::set);
4832 auto PMA = isl::pw_multi_aff::project_out_map(S.get_space(), isl::dim::set,
4833 N, Dim - N);
4834 if (N > 1)
4835 PMA = PMA.drop_dims(isl::dim::out, 0, N - 1);
Tobias Grosser808cd692015-07-14 09:33:13 +00004836
Tobias Grosser99320862017-05-26 17:22:03 +00004837 Result = Result.add_pw_multi_aff(PMA);
4838 return isl::stat::ok;
4839 };
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004840
Tobias Grosser99320862017-05-26 17:22:03 +00004841 isl::stat Res = USet.foreach_set(Lambda);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004842 (void)Res;
4843
Tobias Grosser99320862017-05-26 17:22:03 +00004844 assert(Res == isl::stat::ok);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004845
Tobias Grosser99320862017-05-26 17:22:03 +00004846 return isl::multi_union_pw_aff(isl::union_pw_multi_aff(Result));
Tobias Grosser808cd692015-07-14 09:33:13 +00004847}
4848
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004849void Scop::addScopStmt(BasicBlock *BB, Loop *SurroundingLoop,
4850 std::vector<Instruction *> Instructions) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004851 assert(BB && "Unexpected nullptr!");
Tobias Grosserd5fcbef2017-05-27 04:40:18 +00004852 Stmts.emplace_back(*this, *BB, SurroundingLoop, Instructions);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004853 auto *Stmt = &Stmts.back();
Michael Kruse4dfa7322017-07-18 15:41:49 +00004854 StmtMap[BB].push_back(Stmt);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004855}
4856
Michael Kruse55454072017-03-15 22:16:43 +00004857void Scop::addScopStmt(Region *R, Loop *SurroundingLoop) {
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004858 assert(R && "Unexpected nullptr!");
Michael Kruse55454072017-03-15 22:16:43 +00004859 Stmts.emplace_back(*this, *R, SurroundingLoop);
Hongbin Zhenga8fb73f2016-11-21 20:09:40 +00004860 auto *Stmt = &Stmts.back();
4861 for (BasicBlock *BB : R->blocks())
Michael Kruse4dfa7322017-07-18 15:41:49 +00004862 StmtMap[BB].push_back(Stmt);
Tobias Grosser808cd692015-07-14 09:33:13 +00004863}
4864
Roman Gareevb3224ad2016-09-14 06:26:09 +00004865ScopStmt *Scop::addScopStmt(__isl_take isl_map *SourceRel,
4866 __isl_take isl_map *TargetRel,
4867 __isl_take isl_set *Domain) {
Tobias Grossereba86a12016-11-09 04:24:49 +00004868#ifndef NDEBUG
Tobias Grosser744740a2016-11-05 21:02:43 +00004869 isl_set *SourceDomain = isl_map_domain(isl_map_copy(SourceRel));
4870 isl_set *TargetDomain = isl_map_domain(isl_map_copy(TargetRel));
4871 assert(isl_set_is_subset(Domain, TargetDomain) &&
4872 "Target access not defined for complete statement domain");
4873 assert(isl_set_is_subset(Domain, SourceDomain) &&
4874 "Source access not defined for complete statement domain");
4875 isl_set_free(SourceDomain);
4876 isl_set_free(TargetDomain);
Tobias Grossereba86a12016-11-09 04:24:49 +00004877#endif
Roman Gareevb3224ad2016-09-14 06:26:09 +00004878 Stmts.emplace_back(*this, SourceRel, TargetRel, Domain);
4879 CopyStmtsNum++;
4880 return &(Stmts.back());
4881}
4882
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004883void Scop::buildSchedule(LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004884 Loop *L = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004885 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004886 buildSchedule(getRegion().getNode(), LoopStack, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004887 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4888 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004889}
4890
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004891/// To generate a schedule for the elements in a Region we traverse the Region
4892/// in reverse-post-order and add the contained RegionNodes in traversal order
4893/// to the schedule of the loop that is currently at the top of the LoopStack.
4894/// For loop-free codes, this results in a correct sequential ordering.
4895///
4896/// Example:
4897/// bb1(0)
4898/// / \.
4899/// bb2(1) bb3(2)
4900/// \ / \.
4901/// bb4(3) bb5(4)
4902/// \ /
4903/// bb6(5)
4904///
4905/// Including loops requires additional processing. Whenever a loop header is
4906/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4907/// from an empty schedule, we first process all RegionNodes that are within
4908/// this loop and complete the sequential schedule at this loop-level before
4909/// processing about any other nodes. To implement this
4910/// loop-nodes-first-processing, the reverse post-order traversal is
4911/// insufficient. Hence, we additionally check if the traversal yields
4912/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4913/// These region-nodes are then queue and only traverse after the all nodes
4914/// within the current loop have been processed.
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004915void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, LoopInfo &LI) {
Johannes Doerfertef744432016-05-23 12:42:38 +00004916 Loop *OuterScopLoop = getLoopSurroundingScop(*this, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004917
4918 ReversePostOrderTraversal<Region *> RTraversal(R);
4919 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4920 std::deque<RegionNode *> DelayList;
4921 bool LastRNWaiting = false;
4922
4923 // Iterate over the region @p R in reverse post-order but queue
4924 // sub-regions/blocks iff they are not part of the last encountered but not
4925 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4926 // that we queued the last sub-region/block from the reverse post-order
4927 // iterator. If it is set we have to explore the next sub-region/block from
4928 // the iterator (if any) to guarantee progress. If it is not set we first try
4929 // the next queued sub-region/blocks.
4930 while (!WorkList.empty() || !DelayList.empty()) {
4931 RegionNode *RN;
4932
4933 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4934 RN = WorkList.front();
4935 WorkList.pop_front();
4936 LastRNWaiting = false;
4937 } else {
4938 RN = DelayList.front();
4939 DelayList.pop_front();
4940 }
4941
4942 Loop *L = getRegionNodeLoop(RN, LI);
Johannes Doerfert952b5302016-05-23 12:40:48 +00004943 if (!contains(L))
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004944 L = OuterScopLoop;
4945
Tobias Grosser151ae322016-04-03 19:36:52 +00004946 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004947 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004948 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004949 LastRNWaiting = true;
4950 DelayList.push_back(RN);
4951 continue;
4952 }
4953 LoopStack.push_back({L, nullptr, 0});
4954 }
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004955 buildSchedule(RN, LoopStack, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004956 }
4957
4958 return;
4959}
4960
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004961void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004962
Tobias Grosser8362c262016-01-06 15:30:06 +00004963 if (RN->isSubRegion()) {
4964 auto *LocalRegion = RN->getNodeAs<Region>();
Johannes Doerfertffd222f2016-05-19 12:34:57 +00004965 if (!isNonAffineSubRegion(LocalRegion)) {
4966 buildSchedule(LocalRegion, LoopStack, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004967 return;
4968 }
4969 }
Michael Kruse046dde42015-08-10 13:01:57 +00004970
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004971 auto &LoopData = LoopStack.back();
4972 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004973
Michael Kruse1ce67912017-07-20 17:18:58 +00004974 for (auto *Stmt : getStmtListFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004975 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4976 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004977 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004978 }
4979
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004980 // Check if we just processed the last node in this loop. If we did, finalize
4981 // the loop by:
4982 //
4983 // - adding new schedule dimensions
4984 // - folding the resulting schedule into the parent loop schedule
4985 // - dropping the loop schedule from the LoopStack.
4986 //
4987 // Then continue to check surrounding loops, which might also have been
4988 // completed by this node.
4989 while (LoopData.L &&
Tobias Grosserce69e7b2017-03-07 16:17:55 +00004990 LoopData.NumBlocksProcessed == getNumBlocksInLoop(LoopData.L)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004991 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004992 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004993
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004994 LoopStack.pop_back();
4995 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004996
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004997 if (Schedule) {
Tobias Grosser99320862017-05-26 17:22:03 +00004998 isl::union_set Domain = give(isl_schedule_get_domain(Schedule));
4999 isl::multi_union_pw_aff MUPA = mapToDimension(Domain, LoopStack.size());
5000 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA.release());
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00005001 NextLoopData.Schedule =
5002 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00005003 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00005004
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00005005 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
5006 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00005007 }
Tobias Grosser75805372011-04-29 06:27:02 +00005008}
5009
Michael Kruse6f7721f2016-02-24 22:08:19 +00005010ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00005011 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00005012 if (StmtMapIt == StmtMap.end())
5013 return nullptr;
Michael Kruse4dfa7322017-07-18 15:41:49 +00005014 assert(StmtMapIt->second.size() == 1);
5015 return StmtMapIt->second.front();
Johannes Doerfert7c494212014-10-31 23:13:39 +00005016}
5017
Michael Kruse6eba4b12017-07-20 17:08:50 +00005018ArrayRef<ScopStmt *> Scop::getStmtListFor(BasicBlock *BB) const {
5019 auto StmtMapIt = StmtMap.find(BB);
5020 if (StmtMapIt == StmtMap.end())
5021 return {};
5022 assert(StmtMapIt->second.size() == 1 &&
5023 "Each statement corresponds to exactly one BB.");
5024 return StmtMapIt->second;
5025}
5026
5027ScopStmt *Scop::getLastStmtFor(BasicBlock *BB) const {
5028 ArrayRef<ScopStmt *> StmtList = getStmtListFor(BB);
5029 if (StmtList.size() > 0)
5030 return StmtList.back();
5031 return nullptr;
5032}
5033
Michael Kruse1ce67912017-07-20 17:18:58 +00005034ArrayRef<ScopStmt *> Scop::getStmtListFor(RegionNode *RN) const {
Michael Kruse6f7721f2016-02-24 22:08:19 +00005035 if (RN->isSubRegion())
Michael Kruse1ce67912017-07-20 17:18:58 +00005036 return getStmtListFor(RN->getNodeAs<Region>());
5037 return getStmtListFor(RN->getNodeAs<BasicBlock>());
Michael Kruse6f7721f2016-02-24 22:08:19 +00005038}
5039
Michael Kruse1ce67912017-07-20 17:18:58 +00005040ArrayRef<ScopStmt *> Scop::getStmtListFor(Region *R) const {
5041 return getStmtListFor(R->getEntry());
Michael Krusea902ba62015-12-13 19:21:45 +00005042}
5043
Johannes Doerfert96425c22015-08-30 21:13:53 +00005044int Scop::getRelativeLoopDepth(const Loop *L) const {
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00005045 if (!L || !R.contains(L))
Johannes Doerfert96425c22015-08-30 21:13:53 +00005046 return -1;
Philip Pfaffe1a0128f2017-05-24 18:39:39 +00005047 // outermostLoopInRegion always returns nullptr for top level regions
5048 if (R.isTopLevelRegion()) {
5049 // LoopInfo's depths start at 1, we start at 0
5050 return L->getLoopDepth() - 1;
5051 } else {
5052 Loop *OuterLoop = R.outermostLoopInRegion(const_cast<Loop *>(L));
5053 assert(OuterLoop);
5054 return L->getLoopDepth() - OuterLoop->getLoopDepth();
5055 }
Johannes Doerfertd020b772015-08-27 06:53:52 +00005056}
5057
Roman Gareevd7754a12016-07-30 09:25:51 +00005058ScopArrayInfo *Scop::getArrayInfoByName(const std::string BaseName) {
5059 for (auto &SAI : arrays()) {
5060 if (SAI->getName() == BaseName)
5061 return SAI;
5062 }
5063 return nullptr;
5064}
5065
Michael Kruse8b805802017-07-19 17:11:25 +00005066void Scop::addAccessData(MemoryAccess *Access) {
5067 const ScopArrayInfo *SAI = Access->getOriginalScopArrayInfo();
5068 assert(SAI && "can only use after access relations have been constructed");
5069
5070 if (Access->isOriginalValueKind() && Access->isRead())
5071 ValueUseAccs[SAI].push_back(Access);
5072 else if (Access->isOriginalAnyPHIKind() && Access->isWrite())
5073 PHIIncomingAccs[SAI].push_back(Access);
5074}
5075
5076void Scop::removeAccessData(MemoryAccess *Access) {
5077 if (Access->isOriginalValueKind() && Access->isRead()) {
5078 auto &Uses = ValueUseAccs[Access->getScopArrayInfo()];
5079 std::remove(Uses.begin(), Uses.end(), Access);
5080 } else if (Access->isOriginalAnyPHIKind() && Access->isWrite()) {
5081 auto &Incomings = PHIIncomingAccs[Access->getScopArrayInfo()];
5082 std::remove(Incomings.begin(), Incomings.end(), Access);
5083 }
5084}
5085
5086MemoryAccess *Scop::getValueDef(const ScopArrayInfo *SAI) const {
5087 assert(SAI->isValueKind());
5088
5089 Instruction *Val = dyn_cast<Instruction>(SAI->getBasePtr());
5090 if (!Val)
5091 return nullptr;
5092
5093 ScopStmt *Stmt = getStmtFor(Val);
5094 if (!Stmt)
5095 return nullptr;
5096
5097 return Stmt->lookupValueWriteOf(Val);
5098}
5099
5100ArrayRef<MemoryAccess *> Scop::getValueUses(const ScopArrayInfo *SAI) const {
5101 assert(SAI->isValueKind());
5102 auto It = ValueUseAccs.find(SAI);
5103 if (It == ValueUseAccs.end())
5104 return {};
5105 return It->second;
5106}
5107
5108MemoryAccess *Scop::getPHIRead(const ScopArrayInfo *SAI) const {
5109 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
5110
5111 if (SAI->isExitPHIKind())
5112 return nullptr;
5113
5114 PHINode *PHI = cast<PHINode>(SAI->getBasePtr());
5115 ScopStmt *Stmt = getStmtFor(PHI);
5116 assert(Stmt && "PHINode must be within the SCoP");
5117
5118 return Stmt->lookupPHIReadOf(PHI);
5119}
5120
5121ArrayRef<MemoryAccess *> Scop::getPHIIncomings(const ScopArrayInfo *SAI) const {
5122 assert(SAI->isPHIKind() || SAI->isExitPHIKind());
5123 auto It = PHIIncomingAccs.find(SAI);
5124 if (It == PHIIncomingAccs.end())
5125 return {};
5126 return It->second;
5127}
5128
Michael Krusecd4c9772017-07-21 15:35:53 +00005129raw_ostream &polly::operator<<(raw_ostream &O, const Scop &scop) {
5130 scop.print(O, PollyPrintInstructions);
5131 return O;
5132}
5133
Johannes Doerfert99191c72016-05-31 09:41:04 +00005134//===----------------------------------------------------------------------===//
5135void ScopInfoRegionPass::getAnalysisUsage(AnalysisUsage &AU) const {
5136 AU.addRequired<LoopInfoWrapperPass>();
5137 AU.addRequired<RegionInfoPass>();
5138 AU.addRequired<DominatorTreeWrapperPass>();
5139 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005140 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005141 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005142 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005143 AU.setPreservesAll();
5144}
5145
Tobias Grossercd01a362017-02-17 08:12:36 +00005146void updateLoopCountStatistic(ScopDetection::LoopStats Stats) {
5147 NumLoopsInScop += Stats.NumLoops;
5148 MaxNumLoopsInScop =
5149 std::max(MaxNumLoopsInScop.getValue(), (unsigned)Stats.NumLoops);
5150
Tobias Grossercd01a362017-02-17 08:12:36 +00005151 if (Stats.MaxDepth == 1)
5152 NumScopsDepthOne++;
5153 else if (Stats.MaxDepth == 2)
5154 NumScopsDepthTwo++;
5155 else if (Stats.MaxDepth == 3)
5156 NumScopsDepthThree++;
5157 else if (Stats.MaxDepth == 4)
5158 NumScopsDepthFour++;
5159 else if (Stats.MaxDepth == 5)
5160 NumScopsDepthFive++;
5161 else
5162 NumScopsDepthLarger++;
5163}
5164
Johannes Doerfert99191c72016-05-31 09:41:04 +00005165bool ScopInfoRegionPass::runOnRegion(Region *R, RGPassManager &RGM) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005166 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert99191c72016-05-31 09:41:04 +00005167
5168 if (!SD.isMaxRegionInScop(*R))
5169 return false;
5170
5171 Function *F = R->getEntry()->getParent();
5172 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5173 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5174 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5175 auto const &DL = F->getParent()->getDataLayout();
5176 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005177 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005178
Michael Kruse89b1f942017-03-17 13:56:53 +00005179 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005180 S = SB.getScop(); // take ownership of scop object
Tobias Grossercd01a362017-02-17 08:12:36 +00005181
5182 if (S) {
5183 ScopDetection::LoopStats Stats =
5184 ScopDetection::countBeneficialLoops(&S->getRegion(), SE, LI, 0);
5185 updateLoopCountStatistic(Stats);
5186 }
5187
Tobias Grosser75805372011-04-29 06:27:02 +00005188 return false;
5189}
5190
Johannes Doerfert99191c72016-05-31 09:41:04 +00005191void ScopInfoRegionPass::print(raw_ostream &OS, const Module *) const {
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005192 if (S)
Michael Krusecd4c9772017-07-21 15:35:53 +00005193 S->print(OS, PollyPrintInstructions);
Johannes Doerfertb7e97132016-06-27 09:25:40 +00005194 else
5195 OS << "Invalid Scop!\n";
Johannes Doerfert99191c72016-05-31 09:41:04 +00005196}
Tobias Grosser75805372011-04-29 06:27:02 +00005197
Johannes Doerfert99191c72016-05-31 09:41:04 +00005198char ScopInfoRegionPass::ID = 0;
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005199
Johannes Doerfert99191c72016-05-31 09:41:04 +00005200Pass *polly::createScopInfoRegionPassPass() { return new ScopInfoRegionPass(); }
5201
5202INITIALIZE_PASS_BEGIN(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005203 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00005204 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00005205INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005206INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00005207INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00005208INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00005209INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005210INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert96425c22015-08-30 21:13:53 +00005211INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Johannes Doerfert99191c72016-05-31 09:41:04 +00005212INITIALIZE_PASS_END(ScopInfoRegionPass, "polly-scops",
Tobias Grosser73600b82011-10-08 00:30:40 +00005213 "Polly - Create polyhedral description of Scops", false,
5214 false)
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005215
5216//===----------------------------------------------------------------------===//
Philip Pfaffe838e0882017-05-15 12:55:14 +00005217ScopInfo::ScopInfo(const DataLayout &DL, ScopDetection &SD, ScalarEvolution &SE,
5218 LoopInfo &LI, AliasAnalysis &AA, DominatorTree &DT,
5219 AssumptionCache &AC) {
Michael Krusea6d48f52017-06-08 12:06:15 +00005220 /// Create polyhedral description of scops for all the valid regions of a
Philip Pfaffe838e0882017-05-15 12:55:14 +00005221 /// function.
5222 for (auto &It : SD) {
5223 Region *R = const_cast<Region *>(It);
5224 if (!SD.isMaxRegionInScop(*R))
5225 continue;
5226
5227 ScopBuilder SB(R, AC, AA, DL, DT, LI, SD, SE);
5228 std::unique_ptr<Scop> S = SB.getScop();
5229 if (!S)
5230 continue;
5231 bool Inserted = RegionToScopMap.insert({R, std::move(S)}).second;
5232 assert(Inserted && "Building Scop for the same region twice!");
5233 (void)Inserted;
5234 }
5235}
5236
5237AnalysisKey ScopInfoAnalysis::Key;
5238
5239ScopInfoAnalysis::Result ScopInfoAnalysis::run(Function &F,
5240 FunctionAnalysisManager &FAM) {
5241 auto &SD = FAM.getResult<ScopAnalysis>(F);
5242 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
5243 auto &LI = FAM.getResult<LoopAnalysis>(F);
5244 auto &AA = FAM.getResult<AAManager>(F);
5245 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
5246 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
5247 auto &DL = F.getParent()->getDataLayout();
5248 return {DL, SD, SE, LI, AA, DT, AC};
5249}
5250
5251PreservedAnalyses ScopInfoPrinterPass::run(Function &F,
5252 FunctionAnalysisManager &FAM) {
5253 auto &SI = FAM.getResult<ScopInfoAnalysis>(F);
5254 for (auto &It : SI) {
5255 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005256 It.second->print(Stream, PollyPrintInstructions);
Philip Pfaffe838e0882017-05-15 12:55:14 +00005257 else
5258 Stream << "Invalid Scop!\n";
5259 }
5260 return PreservedAnalyses::all();
5261}
5262
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005263void ScopInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
5264 AU.addRequired<LoopInfoWrapperPass>();
5265 AU.addRequired<RegionInfoPass>();
5266 AU.addRequired<DominatorTreeWrapperPass>();
5267 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005268 AU.addRequiredTransitive<ScopDetectionWrapperPass>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005269 AU.addRequired<AAResultsWrapperPass>();
Michael Kruse89b1f942017-03-17 13:56:53 +00005270 AU.addRequired<AssumptionCacheTracker>();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005271 AU.setPreservesAll();
5272}
5273
5274bool ScopInfoWrapperPass::runOnFunction(Function &F) {
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005275 auto &SD = getAnalysis<ScopDetectionWrapperPass>().getSD();
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005276 auto &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
5277 auto &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
5278 auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
5279 auto const &DL = F.getParent()->getDataLayout();
5280 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Kruse89b1f942017-03-17 13:56:53 +00005281 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005282
Philip Pfaffe838e0882017-05-15 12:55:14 +00005283 Result.reset(new ScopInfo{DL, SD, SE, LI, AA, DT, AC});
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005284 return false;
5285}
5286
5287void ScopInfoWrapperPass::print(raw_ostream &OS, const Module *) const {
Philip Pfaffe838e0882017-05-15 12:55:14 +00005288 for (auto &It : *Result) {
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005289 if (It.second)
Michael Krusecd4c9772017-07-21 15:35:53 +00005290 It.second->print(OS, PollyPrintInstructions);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005291 else
5292 OS << "Invalid Scop!\n";
5293 }
5294}
5295
5296char ScopInfoWrapperPass::ID = 0;
5297
5298Pass *polly::createScopInfoWrapperPassPass() {
5299 return new ScopInfoWrapperPass();
5300}
5301
5302INITIALIZE_PASS_BEGIN(
5303 ScopInfoWrapperPass, "polly-function-scops",
5304 "Polly - Create polyhedral description of all Scops of a function", false,
5305 false);
5306INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Michael Kruse89b1f942017-03-17 13:56:53 +00005307INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005308INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
5309INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
5310INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Philip Pfaffe5cc87e32017-05-12 14:37:29 +00005311INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
Johannes Doerfert4ba65a52016-06-27 09:32:30 +00005312INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
5313INITIALIZE_PASS_END(
5314 ScopInfoWrapperPass, "polly-function-scops",
5315 "Polly - Create polyhedral description of all Scops of a function", false,
5316 false)