blob: e33f9bfac8f02f5e9e2b8ca5b5e96055b1481fe1 [file] [log] [blame]
Johannes Doerfert58a7c752015-09-28 09:48:53 +00001//===--------- ScopInfo.cpp - Create Scops from LLVM IR ------------------===//
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"
Tobias Grosser75805372011-04-29 06:27:02 +000023#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000024#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000025#include "polly/Support/ScopHelper.h"
Tobias Grosser9737c7b2015-11-22 11:06:51 +000026#include "llvm/ADT/DepthFirstIterator.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000027#include "llvm/ADT/MapVector.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000028#include "llvm/ADT/PostOrderIterator.h"
29#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000030#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000031#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000032#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000033#include "llvm/Analysis/AliasAnalysis.h"
Johannes Doerfert2af10e22015-11-12 03:25:01 +000034#include "llvm/Analysis/AssumptionCache.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000035#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000036#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000037#include "llvm/Analysis/RegionIterator.h"
38#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000039#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000040#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000041#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000042#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000043#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000044#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000045#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000046#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000047#include "isl/schedule.h"
48#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000049#include "isl/set.h"
50#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000051#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000052#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000053#include <sstream>
54#include <string>
55#include <vector>
56
57using namespace llvm;
58using namespace polly;
59
Chandler Carruth95fef942014-04-22 03:30:19 +000060#define DEBUG_TYPE "polly-scops"
61
Tobias Grosser74394f02013-01-14 22:40:23 +000062STATISTIC(ScopFound, "Number of valid Scops");
63STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000064
Tobias Grosser75dc40c2015-12-20 13:31:48 +000065// The maximal number of basic sets we allow during domain construction to
66// be created. More complex scops will result in very high compile time and
67// are also unlikely to result in good code
68static int const MaxConjunctsInDomain = 20;
69
Michael Kruse7bf39442015-09-10 12:46:52 +000070static cl::opt<bool> ModelReadOnlyScalars(
71 "polly-analyze-read-only-scalars",
72 cl::desc("Model read-only scalar values in the scop description"),
73 cl::Hidden, cl::ZeroOrMore, cl::init(true), cl::cat(PollyCategory));
74
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000075// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000076// operations can overflow easily. Additive reductions and bit operations
77// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000078static cl::opt<bool> DisableMultiplicativeReductions(
79 "polly-disable-multiplicative-reductions",
80 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
81 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000082
Johannes Doerfert9143d672014-09-27 11:02:39 +000083static cl::opt<unsigned> RunTimeChecksMaxParameters(
84 "polly-rtc-max-parameters",
85 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
86 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
87
Tobias Grosser71500722015-03-28 15:11:14 +000088static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
89 "polly-rtc-max-arrays-per-group",
90 cl::desc("The maximal number of arrays to compare in each alias group."),
91 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Tobias Grosser8a9c2352015-08-16 10:19:29 +000092static cl::opt<std::string> UserContextStr(
93 "polly-context", cl::value_desc("isl parameter set"),
94 cl::desc("Provide additional constraints on the context parameters"),
95 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +000096
Tobias Grosserd83b8a82015-08-20 19:08:11 +000097static cl::opt<bool> DetectReductions("polly-detect-reductions",
98 cl::desc("Detect and exploit reductions"),
99 cl::Hidden, cl::ZeroOrMore,
100 cl::init(true), cl::cat(PollyCategory));
101
Tobias Grosser20a4c0c2015-11-11 16:22:36 +0000102static cl::opt<int> MaxDisjunctsAssumed(
103 "polly-max-disjuncts-assumed",
104 cl::desc("The maximal number of disjuncts we allow in the assumption "
105 "context (this bounds compile time)"),
106 cl::Hidden, cl::ZeroOrMore, cl::init(150), cl::cat(PollyCategory));
107
Tobias Grosser4927c8e2015-11-24 12:50:02 +0000108static cl::opt<bool> IgnoreIntegerWrapping(
109 "polly-ignore-integer-wrapping",
110 cl::desc("Do not build run-time checks to proof absence of integer "
111 "wrapping"),
112 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
113
Michael Kruse7bf39442015-09-10 12:46:52 +0000114//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000115
Michael Kruse046dde42015-08-10 13:01:57 +0000116// Create a sequence of two schedules. Either argument may be null and is
117// interpreted as the empty schedule. Can also return null if both schedules are
118// empty.
119static __isl_give isl_schedule *
120combineInSequence(__isl_take isl_schedule *Prev,
121 __isl_take isl_schedule *Succ) {
122 if (!Prev)
123 return Succ;
124 if (!Succ)
125 return Prev;
126
127 return isl_schedule_sequence(Prev, Succ);
128}
129
Johannes Doerferte7044942015-02-24 11:58:30 +0000130static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
131 const ConstantRange &Range,
132 int dim,
133 enum isl_dim_type type) {
134 isl_val *V;
135 isl_ctx *ctx = isl_set_get_ctx(S);
136
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000137 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
138 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000139 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000140 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
141
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000142 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000143 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000144 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000145 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000146 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
147
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000148 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000149 return isl_set_union(SLB, SUB);
150 else
151 return isl_set_intersect(SLB, SUB);
152}
153
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000154static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
155 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
156 if (!BasePtrLI)
157 return nullptr;
158
159 if (!S->getRegion().contains(BasePtrLI))
160 return nullptr;
161
162 ScalarEvolution &SE = *S->getSE();
163
164 auto *OriginBaseSCEV =
165 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
166 if (!OriginBaseSCEV)
167 return nullptr;
168
169 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
170 if (!OriginBaseSCEVUnknown)
171 return nullptr;
172
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000173 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grossera535dff2015-12-13 19:59:01 +0000174 ScopArrayInfo::MK_Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000175}
176
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000177ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grossera535dff2015-12-13 19:59:01 +0000178 ArrayRef<const SCEV *> Sizes, enum MemoryKind Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000179 const DataLayout &DL, Scop *S)
180 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000181 std::string BasePtrName =
Tobias Grossera535dff2015-12-13 19:59:01 +0000182 getIslCompatibleName("MemRef_", BasePtr, Kind == MK_PHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000183 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000184
Tobias Grosserd840fc72016-02-04 13:18:42 +0000185 updateSizes(Sizes, ElementType);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000186 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
187 if (BasePtrOriginSAI)
188 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000189}
190
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000191__isl_give isl_space *ScopArrayInfo::getSpace() const {
192 auto Space =
193 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
194 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
195 return Space;
196}
197
Tobias Grosserd840fc72016-02-04 13:18:42 +0000198bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes,
199 Type *NewElementType) {
200 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
201 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
202
203 if (NewElementSize != OldElementSize) {
204 if (NewElementSize % OldElementSize == 0 &&
205 NewElementSize < OldElementSize) {
206 ElementType = NewElementType;
207 } else {
208 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
209 ElementType = IntegerType::get(ElementType->getContext(), GCD);
210 }
211 }
212
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000213 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
214 int ExtraDimsNew = NewSizes.size() - SharedDims;
215 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Tobias Grosser8286b832015-11-02 11:29:32 +0000216 for (int i = 0; i < SharedDims; i++)
217 if (NewSizes[i + ExtraDimsNew] != DimensionSizes[i + ExtraDimsOld])
218 return false;
219
220 if (DimensionSizes.size() >= NewSizes.size())
221 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000222
223 DimensionSizes.clear();
224 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
225 NewSizes.end());
226 for (isl_pw_aff *Size : DimensionSizesPw)
227 isl_pw_aff_free(Size);
228 DimensionSizesPw.clear();
229 for (const SCEV *Expr : DimensionSizes) {
230 isl_pw_aff *Size = S.getPwAff(Expr);
231 DimensionSizesPw.push_back(Size);
232 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000233 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000234}
235
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000236ScopArrayInfo::~ScopArrayInfo() {
237 isl_id_free(Id);
238 for (isl_pw_aff *Size : DimensionSizesPw)
239 isl_pw_aff_free(Size);
240}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000241
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000242std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
243
244int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000245 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000246}
247
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000248isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
249
250void ScopArrayInfo::dump() const { print(errs()); }
251
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000252void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000253 OS.indent(8) << *getElementType() << " " << getName();
254 if (getNumberOfDimensions() > 0)
255 OS << "[*]";
Tobias Grosser26253842015-11-10 14:24:21 +0000256 for (unsigned u = 1; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000257 OS << "[";
258
Tobias Grosser26253842015-11-10 14:24:21 +0000259 if (SizeAsPwAff) {
260 auto Size = getDimensionSizePw(u);
261 OS << " " << Size << " ";
262 isl_pw_aff_free(Size);
263 } else {
264 OS << *getDimensionSize(u);
265 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000266
267 OS << "]";
268 }
269
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000270 OS << ";";
271
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000272 if (BasePtrOriginSAI)
273 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
274
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000275 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000276}
277
278const ScopArrayInfo *
279ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
280 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
281 assert(Id && "Output dimension didn't have an ID");
282 return getFromId(Id);
283}
284
285const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
286 void *User = isl_id_get_user(Id);
287 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
288 isl_id_free(Id);
289 return SAI;
290}
291
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000292void MemoryAccess::updateDimensionality() {
293 auto ArraySpace = getScopArrayInfo()->getSpace();
294 auto AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
295
296 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
297 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
298 auto DimsMissing = DimsArray - DimsAccess;
299
Tobias Grosserd840fc72016-02-04 13:18:42 +0000300 auto Map = isl_map_from_domain_and_range(
301 isl_set_universe(AccessSpace),
302 isl_set_universe(isl_space_copy(ArraySpace)));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000303
304 for (unsigned i = 0; i < DimsMissing; i++)
305 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
306
307 for (unsigned i = DimsMissing; i < DimsArray; i++)
308 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
309
310 AccessRelation = isl_map_apply_range(AccessRelation, Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000311
Tobias Grosserd840fc72016-02-04 13:18:42 +0000312 // Introduce multi-element accesses in case the type loaded by this memory
313 // access is larger than the canonical element type of the array.
314 //
315 // An access ((float *)A)[i] to an array char *A is modeled as
316 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
317 unsigned ArrayElemSize = getScopArrayInfo()->getElemSizeInBytes();
318 if (ElemBytes > ArrayElemSize) {
319 assert(ElemBytes % ArrayElemSize == 0 &&
320 "Loaded element size should be multiple of canonical element size");
321 auto Map = isl_map_from_domain_and_range(
322 isl_set_universe(isl_space_copy(ArraySpace)),
323 isl_set_universe(isl_space_copy(ArraySpace)));
324 for (unsigned i = 0; i < DimsArray - 1; i++)
325 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
326
327 isl_ctx *Ctx;
328 isl_constraint *C;
329 isl_local_space *LS;
330
331 LS = isl_local_space_from_space(isl_map_get_space(Map));
332 Ctx = isl_map_get_ctx(Map);
333 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
334
335 C = isl_constraint_alloc_inequality(isl_local_space_copy(LS));
336 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, Num - 1));
337 C = isl_constraint_set_coefficient_si(C, isl_dim_in,
338 DimsArray - 1 - DimsMissing, Num);
339 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, -1);
340 Map = isl_map_add_constraint(Map, C);
341
342 C = isl_constraint_alloc_inequality(LS);
343 C = isl_constraint_set_coefficient_si(C, isl_dim_in,
344 DimsArray - 1 - DimsMissing, -Num);
345 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, 1);
346 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, 0));
347 Map = isl_map_add_constraint(Map, C);
348 AccessRelation = isl_map_apply_range(AccessRelation, Map);
349 }
350
351 isl_space_free(ArraySpace);
352
Roman Gareev10595a12016-01-08 14:01:59 +0000353 assumeNoOutOfBound();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000354}
355
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000356const std::string
357MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
358 switch (RT) {
359 case MemoryAccess::RT_NONE:
360 llvm_unreachable("Requested a reduction operator string for a memory "
361 "access which isn't a reduction");
362 case MemoryAccess::RT_ADD:
363 return "+";
364 case MemoryAccess::RT_MUL:
365 return "*";
366 case MemoryAccess::RT_BOR:
367 return "|";
368 case MemoryAccess::RT_BXOR:
369 return "^";
370 case MemoryAccess::RT_BAND:
371 return "&";
372 }
373 llvm_unreachable("Unknown reduction type");
374 return "";
375}
376
Johannes Doerfertf6183392014-07-01 20:52:51 +0000377/// @brief Return the reduction type for a given binary operator
378static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
379 const Instruction *Load) {
380 if (!BinOp)
381 return MemoryAccess::RT_NONE;
382 switch (BinOp->getOpcode()) {
383 case Instruction::FAdd:
384 if (!BinOp->hasUnsafeAlgebra())
385 return MemoryAccess::RT_NONE;
386 // Fall through
387 case Instruction::Add:
388 return MemoryAccess::RT_ADD;
389 case Instruction::Or:
390 return MemoryAccess::RT_BOR;
391 case Instruction::Xor:
392 return MemoryAccess::RT_BXOR;
393 case Instruction::And:
394 return MemoryAccess::RT_BAND;
395 case Instruction::FMul:
396 if (!BinOp->hasUnsafeAlgebra())
397 return MemoryAccess::RT_NONE;
398 // Fall through
399 case Instruction::Mul:
400 if (DisableMultiplicativeReductions)
401 return MemoryAccess::RT_NONE;
402 return MemoryAccess::RT_MUL;
403 default:
404 return MemoryAccess::RT_NONE;
405 }
406}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000407
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000408/// @brief Derive the individual index expressions from a GEP instruction
409///
410/// This function optimistically assumes the GEP references into a fixed size
411/// array. If this is actually true, this function returns a list of array
412/// subscript expressions as SCEV as well as a list of integers describing
413/// the size of the individual array dimensions. Both lists have either equal
414/// length of the size list is one element shorter in case there is no known
415/// size available for the outermost array dimension.
416///
417/// @param GEP The GetElementPtr instruction to analyze.
418///
419/// @return A tuple with the subscript expressions and the dimension sizes.
420static std::tuple<std::vector<const SCEV *>, std::vector<int>>
421getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
422 std::vector<const SCEV *> Subscripts;
423 std::vector<int> Sizes;
424
425 Type *Ty = GEP->getPointerOperandType();
426
427 bool DroppedFirstDim = false;
428
Michael Kruse26ed65e2015-09-24 17:32:49 +0000429 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000430
431 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
432
433 if (i == 1) {
434 if (auto PtrTy = dyn_cast<PointerType>(Ty)) {
435 Ty = PtrTy->getElementType();
436 } else if (auto ArrayTy = dyn_cast<ArrayType>(Ty)) {
437 Ty = ArrayTy->getElementType();
438 } else {
439 Subscripts.clear();
440 Sizes.clear();
441 break;
442 }
443 if (auto Const = dyn_cast<SCEVConstant>(Expr))
444 if (Const->getValue()->isZero()) {
445 DroppedFirstDim = true;
446 continue;
447 }
448 Subscripts.push_back(Expr);
449 continue;
450 }
451
452 auto ArrayTy = dyn_cast<ArrayType>(Ty);
453 if (!ArrayTy) {
454 Subscripts.clear();
455 Sizes.clear();
456 break;
457 }
458
459 Subscripts.push_back(Expr);
460 if (!(DroppedFirstDim && i == 2))
461 Sizes.push_back(ArrayTy->getNumElements());
462
463 Ty = ArrayTy->getElementType();
464 }
465
466 return std::make_tuple(Subscripts, Sizes);
467}
468
Tobias Grosser75805372011-04-29 06:27:02 +0000469MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000470 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000471 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000472 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000473}
474
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000475const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
476 isl_id *ArrayId = getArrayId();
477 void *User = isl_id_get_user(ArrayId);
478 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
479 isl_id_free(ArrayId);
480 return SAI;
481}
482
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000483__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000484 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
485}
486
Tobias Grosserd840fc72016-02-04 13:18:42 +0000487__isl_give isl_map *MemoryAccess::getAddressFunction() const {
488 return isl_map_lexmin(getAccessRelation());
489}
490
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000491__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
492 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000493 isl_map *Schedule, *ScheduledAccRel;
494 isl_union_set *UDomain;
495
496 UDomain = isl_union_set_from_set(getStatement()->getDomain());
497 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
498 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000499 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000500 return isl_pw_multi_aff_from_map(ScheduledAccRel);
501}
502
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000503__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000504 return isl_map_copy(AccessRelation);
505}
506
Johannes Doerferta99130f2014-10-13 12:58:03 +0000507std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000508 return stringFromIslObj(AccessRelation);
509}
510
Johannes Doerferta99130f2014-10-13 12:58:03 +0000511__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000512 return isl_map_get_space(AccessRelation);
513}
514
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000515__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000516 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000517}
518
Tobias Grosser6f730082015-09-05 07:46:47 +0000519std::string MemoryAccess::getNewAccessRelationStr() const {
520 return stringFromIslObj(NewAccessRelation);
521}
522
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000523__isl_give isl_basic_map *
524MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000525 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000526 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000527
Tobias Grosser084d8f72012-05-29 09:29:44 +0000528 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000529 isl_basic_set_universe(Statement->getDomainSpace()),
530 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000531}
532
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000533// Formalize no out-of-bound access assumption
534//
535// When delinearizing array accesses we optimistically assume that the
536// delinearized accesses do not access out of bound locations (the subscript
537// expression of each array evaluates for each statement instance that is
538// executed to a value that is larger than zero and strictly smaller than the
539// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000540// dimension for which we do not need to assume any upper bound. At this point
541// we formalize this assumption to ensure that at code generation time the
542// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000543//
544// To find the set of constraints necessary to avoid out of bound accesses, we
545// first build the set of data locations that are not within array bounds. We
546// then apply the reverse access relation to obtain the set of iterations that
547// may contain invalid accesses and reduce this set of iterations to the ones
548// that are actually executed by intersecting them with the domain of the
549// statement. If we now project out all loop dimensions, we obtain a set of
550// parameters that may cause statement instances to be executed that may
551// possibly yield out of bound memory accesses. The complement of these
552// constraints is the set of constraints that needs to be assumed to ensure such
553// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000554void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000555 auto *SAI = getScopArrayInfo();
Johannes Doerferta99130f2014-10-13 12:58:03 +0000556 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000557 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Roman Gareev10595a12016-01-08 14:01:59 +0000558 for (int i = 1, Size = isl_space_dim(Space, isl_dim_set); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000559 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
560 isl_pw_aff *Var =
561 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
562 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
563
564 isl_set *DimOutside;
565
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000566 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfertadeab372016-02-07 13:57:32 +0000567 isl_pw_aff *SizeE = SAI->getDimensionSizePw(i);
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000568 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
569 isl_space_dim(Space, isl_dim_set));
570 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
571 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000572
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000573 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000574
575 Outside = isl_set_union(Outside, DimOutside);
576 }
577
578 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
579 Outside = isl_set_intersect(Outside, Statement->getDomain());
580 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000581
582 // Remove divs to avoid the construction of overly complicated assumptions.
583 // Doing so increases the set of parameter combinations that are assumed to
584 // not appear. This is always save, but may make the resulting run-time check
585 // bail out more often than strictly necessary.
586 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000587 Outside = isl_set_complement(Outside);
Michael Krusead28e5a2016-01-26 13:33:15 +0000588 Statement->getParent()->addAssumption(
589 INBOUNDS, Outside,
590 getAccessInstruction() ? getAccessInstruction()->getDebugLoc() : nullptr);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000591 isl_space_free(Space);
592}
593
Johannes Doerferte7044942015-02-24 11:58:30 +0000594void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
595 ScalarEvolution *SE = Statement->getParent()->getSE();
596
Michael Kruse70131d32016-01-27 17:09:17 +0000597 Value *Ptr = MemAccInst(getAccessInstruction()).getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000598 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
599 return;
600
601 auto *PtrSCEV = SE->getSCEV(Ptr);
602 if (isa<SCEVCouldNotCompute>(PtrSCEV))
603 return;
604
605 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
606 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
607 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
608
609 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
610 if (Range.isFullSet())
611 return;
612
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000613 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000614 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000615 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000616 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000617 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000618
619 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000620 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000621
622 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
623 AccessRange =
624 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
625 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
626}
627
Michael Krusee2bccbb2015-09-18 19:59:43 +0000628__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000629 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000630 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000631
632 for (int i = Size - 2; i >= 0; --i) {
633 isl_space *Space;
634 isl_map *MapOne, *MapTwo;
Michael Krusee2bccbb2015-09-18 19:59:43 +0000635 isl_pw_aff *DimSize = Statement->getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000636
637 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
638 isl_pw_aff_free(DimSize);
639 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
640
641 Space = isl_map_get_space(AccessRelation);
642 Space = isl_space_map_from_set(isl_space_range(Space));
643 Space = isl_space_align_params(Space, SpaceSize);
644
645 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
646 isl_id_free(ParamId);
647
648 MapOne = isl_map_universe(isl_space_copy(Space));
649 for (int j = 0; j < Size; ++j)
650 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
651 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
652
653 MapTwo = isl_map_universe(isl_space_copy(Space));
654 for (int j = 0; j < Size; ++j)
655 if (j < i || j > i + 1)
656 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
657
658 isl_local_space *LS = isl_local_space_from_space(Space);
659 isl_constraint *C;
660 C = isl_equality_alloc(isl_local_space_copy(LS));
661 C = isl_constraint_set_constant_si(C, -1);
662 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
663 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
664 MapTwo = isl_map_add_constraint(MapTwo, C);
665 C = isl_equality_alloc(LS);
666 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
667 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
668 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
669 MapTwo = isl_map_add_constraint(MapTwo, C);
670 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
671
672 MapOne = isl_map_union(MapOne, MapTwo);
673 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
674 }
675 return AccessRelation;
676}
677
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000678/// @brief Check if @p Expr is divisible by @p Size.
679static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
680
681 // Only one factor needs to be divisible.
682 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
683 for (auto *FactorExpr : MulExpr->operands())
684 if (isDivisible(FactorExpr, Size, SE))
685 return true;
686 return false;
687 }
688
689 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
690 // to be divisble.
691 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
692 for (auto *OpExpr : NAryExpr->operands())
693 if (!isDivisible(OpExpr, Size, SE))
694 return false;
695 return true;
696 }
697
698 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
699 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
700 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
701 return MulSCEV == Expr;
702}
703
Michael Krusee2bccbb2015-09-18 19:59:43 +0000704void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
705 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000706
Michael Krusee2bccbb2015-09-18 19:59:43 +0000707 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000708 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000709
Michael Krusee2bccbb2015-09-18 19:59:43 +0000710 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000711 // We overapproximate non-affine accesses with a possible access to the
712 // whole array. For read accesses it does not make a difference, if an
713 // access must or may happen. However, for write accesses it is important to
714 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser04d6ae62013-06-23 06:04:54 +0000715 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000716 AccessRelation =
717 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Johannes Doerferte7044942015-02-24 11:58:30 +0000718
Michael Krusee2bccbb2015-09-18 19:59:43 +0000719 computeBoundsOnAccessRelation(getElemSizeInBytes());
Tobias Grossera1879642011-12-20 10:43:14 +0000720 return;
721 }
722
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000723 Scop &S = *getStatement()->getParent();
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000724 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000725 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000726
Michael Krusee2bccbb2015-09-18 19:59:43 +0000727 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
728 isl_pw_aff *Affine = Statement->getPwAff(Subscripts[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000729
Sebastian Pop422e33f2014-06-03 18:16:31 +0000730 if (Size == 1) {
731 // For the non delinearized arrays, divide the access function of the last
732 // subscript by the size of the elements in the array.
Sebastian Pop18016682014-04-08 21:20:44 +0000733 //
734 // A stride one array access in C expressed as A[i] is expressed in
735 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
736 // two subsequent values of 'i' index two values that are stored next to
737 // each other in memory. By this division we make this characteristic
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000738 // obvious again. However, if the index is not divisible by the element
739 // size we will bail out.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000740 isl_val *v = isl_val_int_from_si(Ctx, getElemSizeInBytes());
Sebastian Pop18016682014-04-08 21:20:44 +0000741 Affine = isl_pw_aff_scale_down_val(Affine, v);
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000742
743 if (!isDivisible(Subscripts[0], getElemSizeInBytes(), *S.getSE()))
Tobias Grosser8d4f6262015-12-12 09:52:26 +0000744 S.invalidate(ALIGNMENT, AccessInstruction->getDebugLoc());
Sebastian Pop18016682014-04-08 21:20:44 +0000745 }
746
747 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
748
Tobias Grosser79baa212014-04-10 08:38:02 +0000749 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000750 }
751
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000752 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000753 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000754
Tobias Grosser79baa212014-04-10 08:38:02 +0000755 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000756 AccessRelation = isl_map_set_tuple_id(
757 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000758 AccessRelation =
759 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
760
Tobias Grosseraa660a92015-03-30 00:07:50 +0000761 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000762 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000763}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000764
Michael Krusecac948e2015-10-02 13:53:07 +0000765MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000766 AccessType Type, Value *BaseAddress,
767 unsigned ElemBytes, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000768 ArrayRef<const SCEV *> Subscripts,
769 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000770 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
771 : Kind(Kind), AccType(Type), RedType(RT_NONE), Statement(Stmt),
Michael Krusecac948e2015-10-02 13:53:07 +0000772 BaseAddr(BaseAddress), BaseName(BaseName), ElemBytes(ElemBytes),
773 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
774 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000775 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000776 NewAccessRelation(nullptr) {
777
778 std::string IdName = "__polly_array_ref";
779 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
780}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000781
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000782void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000783 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000784 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000785}
786
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000787const std::string MemoryAccess::getReductionOperatorStr() const {
788 return MemoryAccess::getReductionOperatorStr(getReductionType());
789}
790
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000791__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
792
Johannes Doerfertf6183392014-07-01 20:52:51 +0000793raw_ostream &polly::operator<<(raw_ostream &OS,
794 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000795 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000796 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000797 else
798 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000799 return OS;
800}
801
Tobias Grosser75805372011-04-29 06:27:02 +0000802void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000803 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000804 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000805 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000806 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000807 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000808 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000809 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000810 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000811 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000812 break;
813 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000814 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000815 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000816 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000817 if (hasNewAccessRelation())
818 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000819}
820
Tobias Grosser74394f02013-01-14 22:40:23 +0000821void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000822
823// Create a map in the size of the provided set domain, that maps from the
824// one element of the provided set domain to another element of the provided
825// set domain.
826// The mapping is limited to all points that are equal in all but the last
827// dimension and for which the last dimension of the input is strict smaller
828// than the last dimension of the output.
829//
830// getEqualAndLarger(set[i0, i1, ..., iX]):
831//
832// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
833// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
834//
Tobias Grosserf5338802011-10-06 00:03:35 +0000835static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000836 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000837 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000838 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000839
840 // Set all but the last dimension to be equal for the input and output
841 //
842 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
843 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000844 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000845 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000846
847 // Set the last dimension of the input to be strict smaller than the
848 // last dimension of the output.
849 //
850 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000851 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
852 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000853 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000854}
855
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000856__isl_give isl_set *
857MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000858 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000859 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000860 isl_space *Space = isl_space_range(isl_map_get_space(S));
861 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000862
Sebastian Popa00a0292012-12-18 07:46:06 +0000863 S = isl_map_reverse(S);
864 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000865
Sebastian Popa00a0292012-12-18 07:46:06 +0000866 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
867 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
868 NextScatt = isl_map_apply_domain(NextScatt, S);
869 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000870
Sebastian Popa00a0292012-12-18 07:46:06 +0000871 isl_set *Deltas = isl_map_deltas(NextScatt);
872 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000873}
874
Sebastian Popa00a0292012-12-18 07:46:06 +0000875bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000876 int StrideWidth) const {
877 isl_set *Stride, *StrideX;
878 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000879
Sebastian Popa00a0292012-12-18 07:46:06 +0000880 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000881 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000882 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
883 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
884 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
885 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000886 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000887
Tobias Grosser28dd4862012-01-24 16:42:16 +0000888 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000889 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000890
Tobias Grosser28dd4862012-01-24 16:42:16 +0000891 return IsStrideX;
892}
893
Sebastian Popa00a0292012-12-18 07:46:06 +0000894bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
895 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000896}
897
Sebastian Popa00a0292012-12-18 07:46:06 +0000898bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
899 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000900}
901
Tobias Grosser166c4222015-09-05 07:46:40 +0000902void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
903 isl_map_free(NewAccessRelation);
904 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000905}
Tobias Grosser75805372011-04-29 06:27:02 +0000906
907//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000908
Tobias Grosser808cd692015-07-14 09:33:13 +0000909isl_map *ScopStmt::getSchedule() const {
910 isl_set *Domain = getDomain();
911 if (isl_set_is_empty(Domain)) {
912 isl_set_free(Domain);
913 return isl_map_from_aff(
914 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
915 }
916 auto *Schedule = getParent()->getSchedule();
917 Schedule = isl_union_map_intersect_domain(
918 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
919 if (isl_union_map_is_empty(Schedule)) {
920 isl_set_free(Domain);
921 isl_union_map_free(Schedule);
922 return isl_map_from_aff(
923 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
924 }
925 auto *M = isl_map_from_union_map(Schedule);
926 M = isl_map_coalesce(M);
927 M = isl_map_gist_domain(M, Domain);
928 M = isl_map_coalesce(M);
929 return M;
930}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000931
Johannes Doerfert574182d2015-08-12 10:19:50 +0000932__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Johannes Doerfertcef616f2015-09-15 22:49:04 +0000933 return getParent()->getPwAff(E, isBlockStmt() ? getBasicBlock()
934 : getRegion()->getEntry());
Johannes Doerfert574182d2015-08-12 10:19:50 +0000935}
936
Tobias Grosser37eb4222014-02-20 21:43:54 +0000937void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
938 assert(isl_set_is_subset(NewDomain, Domain) &&
939 "New domain is not a subset of old domain!");
940 isl_set_free(Domain);
941 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000942}
943
Michael Krusecac948e2015-10-02 13:53:07 +0000944void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000945 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +0000946 for (MemoryAccess *Access : MemAccs) {
947 Type *ElementType = Access->getAccessValue()->getType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000948
Tobias Grossera535dff2015-12-13 19:59:01 +0000949 ScopArrayInfo::MemoryKind Ty;
950 if (Access->isPHIKind())
951 Ty = ScopArrayInfo::MK_PHI;
952 else if (Access->isExitPHIKind())
953 Ty = ScopArrayInfo::MK_ExitPHI;
954 else if (Access->isValueKind())
955 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000956 else
Tobias Grossera535dff2015-12-13 19:59:01 +0000957 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000958
Johannes Doerfertadeab372016-02-07 13:57:32 +0000959 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
960 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +0000961 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +0000962 }
963}
964
Michael Krusecac948e2015-10-02 13:53:07 +0000965void ScopStmt::addAccess(MemoryAccess *Access) {
966 Instruction *AccessInst = Access->getAccessInstruction();
967
Michael Kruse58fa3bb2015-12-22 23:25:11 +0000968 if (Access->isArrayKind()) {
969 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
970 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +0000971 } else if (Access->isValueKind() && Access->isWrite()) {
972 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
973 assert(Parent.getStmtForBasicBlock(AccessVal->getParent()) == this);
974 assert(!ValueWrites.lookup(AccessVal));
975
976 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +0000977 } else if (Access->isValueKind() && Access->isRead()) {
978 Value *AccessVal = Access->getAccessValue();
979 assert(!ValueReads.lookup(AccessVal));
980
981 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +0000982 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
983 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
984 assert(!PHIWrites.lookup(PHI));
985
986 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +0000987 }
988
989 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +0000990}
991
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000992void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000993 for (MemoryAccess *MA : *this)
994 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000995
996 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000997}
998
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000999/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1000static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1001 void *User) {
1002 isl_set **BoundedParts = static_cast<isl_set **>(User);
1003 if (isl_basic_set_is_bounded(BSet))
1004 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1005 else
1006 isl_basic_set_free(BSet);
1007 return isl_stat_ok;
1008}
1009
1010/// @brief Return the bounded parts of @p S.
1011static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1012 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1013 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1014 isl_set_free(S);
1015 return BoundedParts;
1016}
1017
1018/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1019///
1020/// @returns A separation of @p S into first an unbounded then a bounded subset,
1021/// both with regards to the dimension @p Dim.
1022static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1023partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1024
1025 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001026 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001027
1028 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001029 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001030
1031 // Remove dimensions that are greater than Dim as they are not interesting.
1032 assert(NumDimsS >= Dim + 1);
1033 OnlyDimS =
1034 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1035
1036 // Create artificial parametric upper bounds for dimensions smaller than Dim
1037 // as we are not interested in them.
1038 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1039 for (unsigned u = 0; u < Dim; u++) {
1040 isl_constraint *C = isl_inequality_alloc(
1041 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1042 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1043 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1044 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1045 }
1046
1047 // Collect all bounded parts of OnlyDimS.
1048 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1049
1050 // Create the dimensions greater than Dim again.
1051 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1052 NumDimsS - Dim - 1);
1053
1054 // Remove the artificial upper bound parameters again.
1055 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1056
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001057 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001058 return std::make_pair(UnboundedParts, BoundedParts);
1059}
1060
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001061/// @brief Set the dimension Ids from @p From in @p To.
1062static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1063 __isl_take isl_set *To) {
1064 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1065 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1066 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1067 }
1068 return To;
1069}
1070
1071/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001072static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001073 __isl_take isl_pw_aff *L,
1074 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001075 switch (Pred) {
1076 case ICmpInst::ICMP_EQ:
1077 return isl_pw_aff_eq_set(L, R);
1078 case ICmpInst::ICMP_NE:
1079 return isl_pw_aff_ne_set(L, R);
1080 case ICmpInst::ICMP_SLT:
1081 return isl_pw_aff_lt_set(L, R);
1082 case ICmpInst::ICMP_SLE:
1083 return isl_pw_aff_le_set(L, R);
1084 case ICmpInst::ICMP_SGT:
1085 return isl_pw_aff_gt_set(L, R);
1086 case ICmpInst::ICMP_SGE:
1087 return isl_pw_aff_ge_set(L, R);
1088 case ICmpInst::ICMP_ULT:
1089 return isl_pw_aff_lt_set(L, R);
1090 case ICmpInst::ICMP_UGT:
1091 return isl_pw_aff_gt_set(L, R);
1092 case ICmpInst::ICMP_ULE:
1093 return isl_pw_aff_le_set(L, R);
1094 case ICmpInst::ICMP_UGE:
1095 return isl_pw_aff_ge_set(L, R);
1096 default:
1097 llvm_unreachable("Non integer predicate not supported");
1098 }
1099}
1100
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001101/// @brief Create the conditions under which @p L @p Pred @p R is true.
1102///
1103/// Helper function that will make sure the dimensions of the result have the
1104/// same isl_id's as the @p Domain.
1105static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1106 __isl_take isl_pw_aff *L,
1107 __isl_take isl_pw_aff *R,
1108 __isl_keep isl_set *Domain) {
1109 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1110 return setDimensionIds(Domain, ConsequenceCondSet);
1111}
1112
1113/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001114///
1115/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001116/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1117/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001118static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001119buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001120 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1121
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001122 Value *Condition = getConditionFromTerminator(SI);
1123 assert(Condition && "No condition for switch");
1124
1125 ScalarEvolution &SE = *S.getSE();
1126 BasicBlock *BB = SI->getParent();
1127 isl_pw_aff *LHS, *RHS;
1128 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
1129
1130 unsigned NumSuccessors = SI->getNumSuccessors();
1131 ConditionSets.resize(NumSuccessors);
1132 for (auto &Case : SI->cases()) {
1133 unsigned Idx = Case.getSuccessorIndex();
1134 ConstantInt *CaseValue = Case.getCaseValue();
1135
1136 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
1137 isl_set *CaseConditionSet =
1138 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1139 ConditionSets[Idx] = isl_set_coalesce(
1140 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1141 }
1142
1143 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1144 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1145 for (unsigned u = 2; u < NumSuccessors; u++)
1146 ConditionSetUnion =
1147 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1148 ConditionSets[0] = setDimensionIds(
1149 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1150
1151 S.markAsOptimized();
1152 isl_pw_aff_free(LHS);
1153}
1154
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001155/// @brief Build the conditions sets for the branch condition @p Condition in
1156/// the @p Domain.
1157///
1158/// This will fill @p ConditionSets with the conditions under which control
1159/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001160/// have as many elements as @p TI has successors. If @p TI is nullptr the
1161/// context under which @p Condition is true/false will be returned as the
1162/// new elements of @p ConditionSets.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001163static void
1164buildConditionSets(Scop &S, Value *Condition, TerminatorInst *TI, Loop *L,
1165 __isl_keep isl_set *Domain,
1166 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1167
1168 isl_set *ConsequenceCondSet = nullptr;
1169 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1170 if (CCond->isZero())
1171 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1172 else
1173 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1174 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1175 auto Opcode = BinOp->getOpcode();
1176 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1177
1178 buildConditionSets(S, BinOp->getOperand(0), TI, L, Domain, ConditionSets);
1179 buildConditionSets(S, BinOp->getOperand(1), TI, L, Domain, ConditionSets);
1180
1181 isl_set_free(ConditionSets.pop_back_val());
1182 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1183 isl_set_free(ConditionSets.pop_back_val());
1184 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1185
1186 if (Opcode == Instruction::And)
1187 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1188 else
1189 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1190 } else {
1191 auto *ICond = dyn_cast<ICmpInst>(Condition);
1192 assert(ICond &&
1193 "Condition of exiting branch was neither constant nor ICmp!");
1194
1195 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001196 BasicBlock *BB = TI ? TI->getParent() : nullptr;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001197 isl_pw_aff *LHS, *RHS;
1198 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1199 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
1200 ConsequenceCondSet =
1201 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1202 }
1203
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001204 // If no terminator was given we are only looking for parameter constraints
1205 // under which @p Condition is true/false.
1206 if (!TI)
1207 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
1208
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001209 assert(ConsequenceCondSet);
1210 isl_set *AlternativeCondSet =
1211 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1212
1213 ConditionSets.push_back(isl_set_coalesce(
1214 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1215 ConditionSets.push_back(isl_set_coalesce(
1216 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1217}
1218
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001219/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1220///
1221/// This will fill @p ConditionSets with the conditions under which control
1222/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1223/// have as many elements as @p TI has successors.
1224static void
1225buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1226 __isl_keep isl_set *Domain,
1227 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1228
1229 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1230 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1231
1232 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1233
1234 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001235 ConditionSets.push_back(isl_set_copy(Domain));
1236 return;
1237 }
1238
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001239 Value *Condition = getConditionFromTerminator(TI);
1240 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001241
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001242 return buildConditionSets(S, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001243}
1244
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001245void ScopStmt::buildDomain() {
Tobias Grosser084d8f72012-05-29 09:29:44 +00001246 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +00001247
Tobias Grosser084d8f72012-05-29 09:29:44 +00001248 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1249
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001250 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001251 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001252}
1253
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001254void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001255 isl_ctx *Ctx = Parent.getIslCtx();
1256 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1257 Type *Ty = GEP->getPointerOperandType();
1258 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001259 ScopDetection &SD = Parent.getSD();
1260
1261 // The set of loads that are required to be invariant.
1262 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001263
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001264 std::vector<const SCEV *> Subscripts;
1265 std::vector<int> Sizes;
1266
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001267 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001268
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001269 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001270 Ty = PtrTy->getElementType();
1271 }
1272
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001273 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001274
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001275 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001276
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001277 for (size_t i = 0; i < Sizes.size(); i++) {
1278 auto Expr = Subscripts[i + IndexOffset];
1279 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001280
Johannes Doerfert09e36972015-10-07 20:17:36 +00001281 InvariantLoadsSetTy AccessILS;
1282 if (!isAffineExpr(&Parent.getRegion(), Expr, SE, nullptr, &AccessILS))
1283 continue;
1284
1285 bool NonAffine = false;
1286 for (LoadInst *LInst : AccessILS)
1287 if (!ScopRIL.count(LInst))
1288 NonAffine = true;
1289
1290 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001291 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001292
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001293 isl_pw_aff *AccessOffset = getPwAff(Expr);
1294 AccessOffset =
1295 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001296
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001297 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1298 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001299
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001300 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1301 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1302 OutOfBound = isl_set_params(OutOfBound);
1303 isl_set *InBound = isl_set_complement(OutOfBound);
1304 isl_set *Executed = isl_set_params(getDomain());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001305
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001306 // A => B == !A or B
1307 isl_set *InBoundIfExecuted =
1308 isl_set_union(isl_set_complement(Executed), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001309
Roman Gareev10595a12016-01-08 14:01:59 +00001310 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001311 Parent.addAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001312 }
1313
1314 isl_local_space_free(LSpace);
1315}
1316
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001317void ScopStmt::deriveAssumptions(BasicBlock *Block) {
1318 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001319 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
1320 deriveAssumptionsFromGEP(GEP);
1321}
1322
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001323void ScopStmt::collectSurroundingLoops() {
1324 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1325 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1326 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1327 isl_id_free(DimId);
1328 }
1329}
1330
Michael Kruse9d080092015-09-11 21:41:48 +00001331ScopStmt::ScopStmt(Scop &parent, Region &R)
Michael Krusecac948e2015-10-02 13:53:07 +00001332 : Parent(parent), Domain(nullptr), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001333
Tobias Grosser16c44032015-07-09 07:31:45 +00001334 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001335}
1336
Michael Kruse9d080092015-09-11 21:41:48 +00001337ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Michael Krusecac948e2015-10-02 13:53:07 +00001338 : Parent(parent), Domain(nullptr), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001339
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001340 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001341}
1342
1343void ScopStmt::init() {
1344 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001345
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001346 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001347 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001348 buildAccessRelations();
1349
1350 if (BB) {
1351 deriveAssumptions(BB);
1352 } else {
1353 for (BasicBlock *Block : R->blocks()) {
1354 deriveAssumptions(Block);
1355 }
1356 }
1357
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001358 if (DetectReductions)
1359 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001360}
1361
Johannes Doerferte58a0122014-06-27 20:31:28 +00001362/// @brief Collect loads which might form a reduction chain with @p StoreMA
1363///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001364/// Check if the stored value for @p StoreMA is a binary operator with one or
1365/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001366/// used only once (by @p StoreMA) and its load operands are also used only
1367/// once, we have found a possible reduction chain. It starts at an operand
1368/// load and includes the binary operator and @p StoreMA.
1369///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001370/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001371/// escape this block or into any other store except @p StoreMA.
1372void ScopStmt::collectCandiateReductionLoads(
1373 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1374 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1375 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001376 return;
1377
1378 // Skip if there is not one binary operator between the load and the store
1379 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001380 if (!BinOp)
1381 return;
1382
1383 // Skip if the binary operators has multiple uses
1384 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001385 return;
1386
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001387 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001388 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1389 return;
1390
Johannes Doerfert9890a052014-07-01 00:32:29 +00001391 // Skip if the binary operator is outside the current SCoP
1392 if (BinOp->getParent() != Store->getParent())
1393 return;
1394
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001395 // Skip if it is a multiplicative reduction and we disabled them
1396 if (DisableMultiplicativeReductions &&
1397 (BinOp->getOpcode() == Instruction::Mul ||
1398 BinOp->getOpcode() == Instruction::FMul))
1399 return;
1400
Johannes Doerferte58a0122014-06-27 20:31:28 +00001401 // Check the binary operator operands for a candidate load
1402 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1403 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1404 if (!PossibleLoad0 && !PossibleLoad1)
1405 return;
1406
1407 // A load is only a candidate if it cannot escape (thus has only this use)
1408 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001409 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001410 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001411 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001412 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001413 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001414}
1415
1416/// @brief Check for reductions in this ScopStmt
1417///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001418/// Iterate over all store memory accesses and check for valid binary reduction
1419/// like chains. For all candidates we check if they have the same base address
1420/// and there are no other accesses which overlap with them. The base address
1421/// check rules out impossible reductions candidates early. The overlap check,
1422/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001423/// guarantees that none of the intermediate results will escape during
1424/// execution of the loop nest. We basically check here that no other memory
1425/// access can access the same memory as the potential reduction.
1426void ScopStmt::checkForReductions() {
1427 SmallVector<MemoryAccess *, 2> Loads;
1428 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1429
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001430 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001431 // stores and collecting possible reduction loads.
1432 for (MemoryAccess *StoreMA : MemAccs) {
1433 if (StoreMA->isRead())
1434 continue;
1435
1436 Loads.clear();
1437 collectCandiateReductionLoads(StoreMA, Loads);
1438 for (MemoryAccess *LoadMA : Loads)
1439 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1440 }
1441
1442 // Then check each possible candidate pair.
1443 for (const auto &CandidatePair : Candidates) {
1444 bool Valid = true;
1445 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1446 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1447
1448 // Skip those with obviously unequal base addresses.
1449 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1450 isl_map_free(LoadAccs);
1451 isl_map_free(StoreAccs);
1452 continue;
1453 }
1454
1455 // And check if the remaining for overlap with other memory accesses.
1456 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1457 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1458 isl_set *AllAccs = isl_map_range(AllAccsRel);
1459
1460 for (MemoryAccess *MA : MemAccs) {
1461 if (MA == CandidatePair.first || MA == CandidatePair.second)
1462 continue;
1463
1464 isl_map *AccRel =
1465 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1466 isl_set *Accs = isl_map_range(AccRel);
1467
1468 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1469 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1470 Valid = Valid && isl_set_is_empty(OverlapAccs);
1471 isl_set_free(OverlapAccs);
1472 }
1473 }
1474
1475 isl_set_free(AllAccs);
1476 if (!Valid)
1477 continue;
1478
Johannes Doerfertf6183392014-07-01 20:52:51 +00001479 const LoadInst *Load =
1480 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1481 MemoryAccess::ReductionType RT =
1482 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1483
Johannes Doerferte58a0122014-06-27 20:31:28 +00001484 // If no overlapping access was found we mark the load and store as
1485 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001486 CandidatePair.first->markAsReductionLike(RT);
1487 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001488 }
Tobias Grosser75805372011-04-29 06:27:02 +00001489}
1490
Tobias Grosser74394f02013-01-14 22:40:23 +00001491std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001492
Tobias Grosser54839312015-04-21 11:37:25 +00001493std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001494 auto *S = getSchedule();
1495 auto Str = stringFromIslObj(S);
1496 isl_map_free(S);
1497 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001498}
1499
Tobias Grosser74394f02013-01-14 22:40:23 +00001500unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001501
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001502unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001503
Tobias Grosser75805372011-04-29 06:27:02 +00001504const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1505
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001506const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001507 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001508}
1509
Tobias Grosser74394f02013-01-14 22:40:23 +00001510isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001511
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001512__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001513
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001514__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001515 return isl_set_get_space(Domain);
1516}
1517
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001518__isl_give isl_id *ScopStmt::getDomainId() const {
1519 return isl_set_get_tuple_id(Domain);
1520}
Tobias Grossercd95b772012-08-30 11:49:38 +00001521
Tobias Grosser10120182015-12-16 16:14:03 +00001522ScopStmt::~ScopStmt() { isl_set_free(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001523
1524void ScopStmt::print(raw_ostream &OS) const {
1525 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001526 OS.indent(12) << "Domain :=\n";
1527
1528 if (Domain) {
1529 OS.indent(16) << getDomainStr() << ";\n";
1530 } else
1531 OS.indent(16) << "n/a\n";
1532
Tobias Grosser54839312015-04-21 11:37:25 +00001533 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001534
1535 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001536 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001537 } else
1538 OS.indent(16) << "n/a\n";
1539
Tobias Grosser083d3d32014-06-28 08:59:45 +00001540 for (MemoryAccess *Access : MemAccs)
1541 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001542}
1543
1544void ScopStmt::dump() const { print(dbgs()); }
1545
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001546void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001547 // Remove all memory accesses in @p InvMAs from this statement
1548 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001549 // MK_Value READs have no access instruction, hence would not be removed by
1550 // this function. However, it is only used for invariant LoadInst accesses,
1551 // its arguments are always affine, hence synthesizable, and therefore there
1552 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001553 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001554 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001555 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001556 };
1557 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1558 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001559 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001560 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001561}
1562
Tobias Grosser75805372011-04-29 06:27:02 +00001563//===----------------------------------------------------------------------===//
1564/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001565
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001566void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001567 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1568 isl_set_free(Context);
1569 Context = NewContext;
1570}
1571
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001572/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1573struct SCEVSensitiveParameterRewriter
1574 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1575 ValueToValueMap &VMap;
1576 ScalarEvolution &SE;
1577
1578public:
1579 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1580 : VMap(VMap), SE(SE) {}
1581
1582 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1583 ValueToValueMap &VMap) {
1584 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1585 return SSPR.visit(E);
1586 }
1587
1588 const SCEV *visit(const SCEV *E) {
1589 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1590 }
1591
1592 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1593
1594 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1595 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1596 }
1597
1598 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1599 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1600 }
1601
1602 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1603 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1604 }
1605
1606 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1607 SmallVector<const SCEV *, 4> Operands;
1608 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1609 Operands.push_back(visit(E->getOperand(i)));
1610 return SE.getAddExpr(Operands);
1611 }
1612
1613 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1614 SmallVector<const SCEV *, 4> Operands;
1615 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1616 Operands.push_back(visit(E->getOperand(i)));
1617 return SE.getMulExpr(Operands);
1618 }
1619
1620 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1621 SmallVector<const SCEV *, 4> Operands;
1622 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1623 Operands.push_back(visit(E->getOperand(i)));
1624 return SE.getSMaxExpr(Operands);
1625 }
1626
1627 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1628 SmallVector<const SCEV *, 4> Operands;
1629 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1630 Operands.push_back(visit(E->getOperand(i)));
1631 return SE.getUMaxExpr(Operands);
1632 }
1633
1634 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1635 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1636 }
1637
1638 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1639 auto *Start = visit(E->getStart());
1640 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1641 visit(E->getStepRecurrence(SE)),
1642 E->getLoop(), SCEV::FlagAnyWrap);
1643 return SE.getAddExpr(Start, AddRec);
1644 }
1645
1646 const SCEV *visitUnknown(const SCEVUnknown *E) {
1647 if (auto *NewValue = VMap.lookup(E->getValue()))
1648 return SE.getUnknown(NewValue);
1649 return E;
1650 }
1651};
1652
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001653const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001654 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001655}
1656
Tobias Grosserabfbe632013-02-05 12:09:06 +00001657void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001658 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001659 Parameter = extractConstantFactor(Parameter, *SE).second;
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001660
1661 // Normalize the SCEV to get the representing element for an invariant load.
1662 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1663
Tobias Grosser60b54f12011-11-08 15:41:28 +00001664 if (ParameterIds.find(Parameter) != ParameterIds.end())
1665 continue;
1666
1667 int dimension = Parameters.size();
1668
1669 Parameters.push_back(Parameter);
1670 ParameterIds[Parameter] = dimension;
1671 }
1672}
1673
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001674__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001675 // Normalize the SCEV to get the representing element for an invariant load.
1676 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1677
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001678 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001679
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001680 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001681 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001682
Tobias Grosser8f99c162011-11-15 11:38:55 +00001683 std::string ParameterName;
1684
Craig Topper7fb6e472016-01-31 20:36:20 +00001685 ParameterName = "p_" + utostr(IdIter->second);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001686
Tobias Grosser8f99c162011-11-15 11:38:55 +00001687 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1688 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001689
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001690 // If this parameter references a specific Value and this value has a name
1691 // we use this name as it is likely to be unique and more useful than just
1692 // a number.
1693 if (Val->hasName())
1694 ParameterName = Val->getName();
1695 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
1696 auto LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
1697 if (LoadOrigin->hasName()) {
1698 ParameterName += "_loaded_from_";
1699 ParameterName +=
1700 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1701 }
1702 }
1703 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001704
Tobias Grosser20532b82014-04-11 17:56:49 +00001705 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1706 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001707}
Tobias Grosser75805372011-04-29 06:27:02 +00001708
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001709isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1710 isl_set *DomainContext = isl_union_set_params(getDomains());
1711 return isl_set_intersect_params(C, DomainContext);
1712}
1713
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001714void Scop::buildBoundaryContext() {
Tobias Grosser4927c8e2015-11-24 12:50:02 +00001715 if (IgnoreIntegerWrapping) {
1716 BoundaryContext = isl_set_universe(getParamSpace());
1717 return;
1718 }
1719
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001720 BoundaryContext = Affinator.getWrappingContext();
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001721
1722 // The isl_set_complement operation used to create the boundary context
1723 // can possibly become very expensive. We bound the compile time of
1724 // this operation by setting a compute out.
1725 //
1726 // TODO: We can probably get around using isl_set_complement and directly
1727 // AST generate BoundaryContext.
1728 long MaxOpsOld = isl_ctx_get_max_operations(getIslCtx());
Tobias Grosserf920fb12015-11-13 16:56:13 +00001729 isl_ctx_reset_operations(getIslCtx());
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001730 isl_ctx_set_max_operations(getIslCtx(), 300000);
1731 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_CONTINUE);
1732
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001733 BoundaryContext = isl_set_complement(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001734
Tobias Grossera52b4da2015-11-11 17:59:53 +00001735 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
1736 isl_set_free(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001737 BoundaryContext = isl_set_empty(getParamSpace());
Tobias Grossera52b4da2015-11-11 17:59:53 +00001738 }
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001739
1740 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
1741 isl_ctx_reset_operations(getIslCtx());
1742 isl_ctx_set_max_operations(getIslCtx(), MaxOpsOld);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001743 BoundaryContext = isl_set_gist_params(BoundaryContext, getContext());
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001744 trackAssumption(WRAPPING, BoundaryContext, DebugLoc());
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001745}
1746
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001747void Scop::addUserAssumptions(AssumptionCache &AC) {
1748 auto *R = &getRegion();
1749 auto &F = *R->getEntry()->getParent();
1750 for (auto &Assumption : AC.assumptions()) {
1751 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1752 if (!CI || CI->getNumArgOperands() != 1)
1753 continue;
1754 if (!DT.dominates(CI->getParent(), R->getEntry()))
1755 continue;
1756
1757 auto *Val = CI->getArgOperand(0);
1758 std::vector<const SCEV *> Params;
1759 if (!isAffineParamConstraint(Val, R, *SE, Params)) {
1760 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1761 CI->getDebugLoc(),
1762 "Non-affine user assumption ignored.");
1763 continue;
1764 }
1765
1766 addParams(Params);
1767
1768 auto *L = LI.getLoopFor(CI->getParent());
1769 SmallVector<isl_set *, 2> ConditionSets;
1770 buildConditionSets(*this, Val, nullptr, L, Context, ConditionSets);
1771 assert(ConditionSets.size() == 2);
1772 isl_set_free(ConditionSets[1]);
1773
1774 auto *AssumptionCtx = ConditionSets[0];
1775 emitOptimizationRemarkAnalysis(
1776 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1777 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1778 Context = isl_set_intersect(Context, AssumptionCtx);
1779 }
1780}
1781
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001782void Scop::addUserContext() {
1783 if (UserContextStr.empty())
1784 return;
1785
1786 isl_set *UserContext = isl_set_read_from_str(IslCtx, UserContextStr.c_str());
1787 isl_space *Space = getParamSpace();
1788 if (isl_space_dim(Space, isl_dim_param) !=
1789 isl_set_dim(UserContext, isl_dim_param)) {
1790 auto SpaceStr = isl_space_to_str(Space);
1791 errs() << "Error: the context provided in -polly-context has not the same "
1792 << "number of dimensions than the computed context. Due to this "
1793 << "mismatch, the -polly-context option is ignored. Please provide "
1794 << "the context in the parameter space: " << SpaceStr << ".\n";
1795 free(SpaceStr);
1796 isl_set_free(UserContext);
1797 isl_space_free(Space);
1798 return;
1799 }
1800
1801 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
1802 auto NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1803 auto NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
1804
1805 if (strcmp(NameContext, NameUserContext) != 0) {
1806 auto SpaceStr = isl_space_to_str(Space);
1807 errs() << "Error: the name of dimension " << i
1808 << " provided in -polly-context "
1809 << "is '" << NameUserContext << "', but the name in the computed "
1810 << "context is '" << NameContext
1811 << "'. Due to this name mismatch, "
1812 << "the -polly-context option is ignored. Please provide "
1813 << "the context in the parameter space: " << SpaceStr << ".\n";
1814 free(SpaceStr);
1815 isl_set_free(UserContext);
1816 isl_space_free(Space);
1817 return;
1818 }
1819
1820 UserContext =
1821 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1822 isl_space_get_dim_id(Space, isl_dim_param, i));
1823 }
1824
1825 Context = isl_set_intersect(Context, UserContext);
1826 isl_space_free(Space);
1827}
1828
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001829void Scop::buildInvariantEquivalenceClasses() {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001830 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001831
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001832 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001833 for (LoadInst *LInst : RIL) {
1834 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1835
Johannes Doerfert96e54712016-02-07 17:30:13 +00001836 Type *Ty = LInst->getType();
1837 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001838 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001839 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001840 continue;
1841 }
1842
1843 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00001844 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
1845 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001846 }
1847}
1848
Tobias Grosser6be480c2011-11-08 15:41:13 +00001849void Scop::buildContext() {
1850 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001851 Context = isl_set_universe(isl_space_copy(Space));
1852 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001853}
1854
Tobias Grosser18daaca2012-05-22 10:47:27 +00001855void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001856 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001857 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001858
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001859 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001860
Johannes Doerferte7044942015-02-24 11:58:30 +00001861 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001862 }
1863}
1864
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001865void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001866 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001867 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001868
Tobias Grosser083d3d32014-06-28 08:59:45 +00001869 for (const auto &ParamID : ParameterIds) {
1870 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001871 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001872 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001873 }
1874
1875 // Align the parameters of all data structures to the model.
1876 Context = isl_set_align_params(Context, Space);
1877
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001878 for (ScopStmt &Stmt : *this)
1879 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001880}
1881
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001882static __isl_give isl_set *
1883simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1884 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00001885 // If we modelt all blocks in the SCoP that have side effects we can simplify
1886 // the context with the constraints that are needed for anything to be
1887 // executed at all. However, if we have error blocks in the SCoP we already
1888 // assumed some parameter combinations cannot occure and removed them from the
1889 // domains, thus we cannot use the remaining domain to simplify the
1890 // assumptions.
1891 if (!S.hasErrorBlock()) {
1892 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1893 AssumptionContext =
1894 isl_set_gist_params(AssumptionContext, DomainParameters);
1895 }
1896
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001897 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1898 return AssumptionContext;
1899}
1900
1901void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001902 // The parameter constraints of the iteration domains give us a set of
1903 // constraints that need to hold for all cases where at least a single
1904 // statement iteration is executed in the whole scop. We now simplify the
1905 // assumed context under the assumption that such constraints hold and at
1906 // least a single statement iteration is executed. For cases where no
1907 // statement instances are executed, the assumptions we have taken about
1908 // the executed code do not matter and can be changed.
1909 //
1910 // WARNING: This only holds if the assumptions we have taken do not reduce
1911 // the set of statement instances that are executed. Otherwise we
1912 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001913 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001914 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001915 // performed. In such a case, modifying the run-time conditions and
1916 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001917 // to not be executed.
1918 //
1919 // Example:
1920 //
1921 // When delinearizing the following code:
1922 //
1923 // for (long i = 0; i < 100; i++)
1924 // for (long j = 0; j < m; j++)
1925 // A[i+p][j] = 1.0;
1926 //
1927 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001928 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001929 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001930 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
1931 BoundaryContext = simplifyAssumptionContext(BoundaryContext, *this);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001932}
1933
Johannes Doerfertb164c792014-09-18 11:17:17 +00001934/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001935static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001936 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1937 isl_pw_multi_aff *MinPMA, *MaxPMA;
1938 isl_pw_aff *LastDimAff;
1939 isl_aff *OneAff;
1940 unsigned Pos;
1941
Johannes Doerfert9143d672014-09-27 11:02:39 +00001942 // Restrict the number of parameters involved in the access as the lexmin/
1943 // lexmax computation will take too long if this number is high.
1944 //
1945 // Experiments with a simple test case using an i7 4800MQ:
1946 //
1947 // #Parameters involved | Time (in sec)
1948 // 6 | 0.01
1949 // 7 | 0.04
1950 // 8 | 0.12
1951 // 9 | 0.40
1952 // 10 | 1.54
1953 // 11 | 6.78
1954 // 12 | 30.38
1955 //
1956 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1957 unsigned InvolvedParams = 0;
1958 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1959 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1960 InvolvedParams++;
1961
1962 if (InvolvedParams > RunTimeChecksMaxParameters) {
1963 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001964 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00001965 }
1966 }
1967
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001968 Set = isl_set_remove_divs(Set);
1969
Johannes Doerfertb164c792014-09-18 11:17:17 +00001970 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1971 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1972
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001973 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1974 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1975
Johannes Doerfertb164c792014-09-18 11:17:17 +00001976 // Adjust the last dimension of the maximal access by one as we want to
1977 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1978 // we test during code generation might now point after the end of the
1979 // allocated array but we will never dereference it anyway.
1980 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1981 "Assumed at least one output dimension");
1982 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1983 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1984 OneAff = isl_aff_zero_on_domain(
1985 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1986 OneAff = isl_aff_add_constant_si(OneAff, 1);
1987 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1988 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1989
1990 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1991
1992 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001993 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001994}
1995
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001996static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1997 isl_set *Domain = MA->getStatement()->getDomain();
1998 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1999 return isl_set_reset_tuple_id(Domain);
2000}
2001
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002002/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2003static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002004 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002005 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002006
2007 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2008 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002009 Locations = isl_union_set_coalesce(Locations);
2010 Locations = isl_union_set_detect_equalities(Locations);
2011 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002012 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002013 isl_union_set_free(Locations);
2014 return Valid;
2015}
2016
Johannes Doerfert96425c22015-08-30 21:13:53 +00002017/// @brief Helper to treat non-affine regions and basic blocks the same.
2018///
2019///{
2020
2021/// @brief Return the block that is the representing block for @p RN.
2022static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2023 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2024 : RN->getNodeAs<BasicBlock>();
2025}
2026
2027/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002028static inline BasicBlock *
2029getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002030 if (RN->isSubRegion()) {
2031 assert(idx == 0);
2032 return RN->getNodeAs<Region>()->getExit();
2033 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002034 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002035}
2036
2037/// @brief Return the smallest loop surrounding @p RN.
2038static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2039 if (!RN->isSubRegion())
2040 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2041
2042 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2043 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2044 while (L && NonAffineSubRegion->contains(L))
2045 L = L->getParentLoop();
2046 return L;
2047}
2048
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002049static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2050 if (!RN->isSubRegion())
2051 return 1;
2052
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002053 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002054 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002055}
2056
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002057static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2058 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002059 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002060 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002061 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002062 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002063 return true;
2064 return false;
2065}
2066
Johannes Doerfert96425c22015-08-30 21:13:53 +00002067///}
2068
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002069static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2070 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002071 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002072 isl_id *DimId =
2073 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2074 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2075}
2076
Johannes Doerfert96425c22015-08-30 21:13:53 +00002077isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
2078 BasicBlock *BB = Stmt->isBlockStmt() ? Stmt->getBasicBlock()
2079 : Stmt->getRegion()->getEntry();
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002080 return getDomainConditions(BB);
2081}
2082
2083isl_set *Scop::getDomainConditions(BasicBlock *BB) {
2084 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002085 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002086}
2087
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002088void Scop::removeErrorBlockDomains() {
2089 auto removeDomains = [this](BasicBlock *Start) {
2090 auto BBNode = DT.getNode(Start);
2091 for (auto ErrorChild : depth_first(BBNode)) {
2092 auto ErrorChildBlock = ErrorChild->getBlock();
2093 auto CurrentDomain = DomainMap[ErrorChildBlock];
2094 auto Empty = isl_set_empty(isl_set_get_space(CurrentDomain));
2095 DomainMap[ErrorChildBlock] = Empty;
2096 isl_set_free(CurrentDomain);
2097 }
2098 };
2099
Tobias Grosser5ef2bc32015-11-23 10:18:23 +00002100 SmallVector<Region *, 4> Todo = {&R};
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002101
2102 while (!Todo.empty()) {
2103 auto SubRegion = Todo.back();
2104 Todo.pop_back();
2105
2106 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
2107 for (auto &Child : *SubRegion)
2108 Todo.push_back(Child.get());
2109 continue;
2110 }
2111 if (containsErrorBlock(SubRegion->getNode(), getRegion(), LI, DT))
2112 removeDomains(SubRegion->getEntry());
2113 }
2114
2115 for (auto BB : R.blocks())
2116 if (isErrorBlock(*BB, R, LI, DT))
2117 removeDomains(BB);
2118}
2119
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002120void Scop::buildDomains(Region *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002121
Johannes Doerfert432658d2016-01-26 11:01:41 +00002122 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002123 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002124 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2125 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002126 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002127
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002128 while (LD-- >= 0) {
2129 S = addDomainDimId(S, LD + 1, L);
2130 L = L->getParentLoop();
2131 }
2132
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002133 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002134
Johannes Doerfert432658d2016-01-26 11:01:41 +00002135 if (IsOnlyNonAffineRegion)
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002136 return;
2137
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002138 buildDomainsWithBranchConstraints(R);
2139 propagateDomainConstraints(R);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002140
2141 // Error blocks and blocks dominated by them have been assumed to never be
2142 // executed. Representing them in the Scop does not add any value. In fact,
2143 // it is likely to cause issues during construction of the ScopStmts. The
2144 // contents of error blocks have not been verfied to be expressible and
2145 // will cause problems when building up a ScopStmt for them.
2146 // Furthermore, basic blocks dominated by error blocks may reference
2147 // instructions in the error block which, if the error block is not modeled,
2148 // can themselves not be constructed properly.
2149 removeErrorBlockDomains();
Johannes Doerfert96425c22015-08-30 21:13:53 +00002150}
2151
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002152void Scop::buildDomainsWithBranchConstraints(Region *R) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002153 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002154
2155 // To create the domain for each block in R we iterate over all blocks and
2156 // subregions in R and propagate the conditions under which the current region
2157 // element is executed. To this end we iterate in reverse post order over R as
2158 // it ensures that we first visit all predecessors of a region node (either a
2159 // basic block or a subregion) before we visit the region node itself.
2160 // Initially, only the domain for the SCoP region entry block is set and from
2161 // there we propagate the current domain to all successors, however we add the
2162 // condition that the successor is actually executed next.
2163 // As we are only interested in non-loop carried constraints here we can
2164 // simply skip loop back edges.
2165
2166 ReversePostOrderTraversal<Region *> RTraversal(R);
2167 for (auto *RN : RTraversal) {
2168
2169 // Recurse for affine subregions but go on for basic blocks and non-affine
2170 // subregions.
2171 if (RN->isSubRegion()) {
2172 Region *SubRegion = RN->getNodeAs<Region>();
2173 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002174 buildDomainsWithBranchConstraints(SubRegion);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002175 continue;
2176 }
2177 }
2178
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002179 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002180 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002181
Johannes Doerfert96425c22015-08-30 21:13:53 +00002182 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002183 TerminatorInst *TI = BB->getTerminator();
2184
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002185 if (isa<UnreachableInst>(TI))
2186 continue;
2187
Johannes Doerfertf5673802015-10-01 23:48:18 +00002188 isl_set *Domain = DomainMap.lookup(BB);
2189 if (!Domain) {
2190 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2191 << ", it is only reachable from error blocks.\n");
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002192 continue;
2193 }
2194
Johannes Doerfert96425c22015-08-30 21:13:53 +00002195 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002196
2197 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2198 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2199
2200 // Build the condition sets for the successor nodes of the current region
2201 // node. If it is a non-affine subregion we will always execute the single
2202 // exit node, hence the single entry node domain is the condition set. For
2203 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002204 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002205 if (RN->isSubRegion())
2206 ConditionSets.push_back(isl_set_copy(Domain));
2207 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002208 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002209
2210 // Now iterate over the successors and set their initial domain based on
2211 // their condition set. We skip back edges here and have to be careful when
2212 // we leave a loop not to keep constraints over a dimension that doesn't
2213 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002214 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002215 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002216 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002217 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002218
2219 // Skip back edges.
2220 if (DT.dominates(SuccBB, BB)) {
2221 isl_set_free(CondSet);
2222 continue;
2223 }
2224
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002225 // Do not adjust the number of dimensions if we enter a boxed loop or are
2226 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002227 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002228 while (BoxedLoops.count(SuccBBLoop))
2229 SuccBBLoop = SuccBBLoop->getParentLoop();
Johannes Doerfert634909c2015-10-04 14:57:41 +00002230
2231 if (BBLoop != SuccBBLoop) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002232
2233 // Check if the edge to SuccBB is a loop entry or exit edge. If so
2234 // adjust the dimensionality accordingly. Lastly, if we leave a loop
2235 // and enter a new one we need to drop the old constraints.
2236 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002237 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002238 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002239 CondSet = isl_set_project_out(CondSet, isl_dim_set,
2240 isl_set_n_dim(CondSet) - LoopDepthDiff,
2241 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002242 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002243 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002244 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002245 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002246 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002247 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002248 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
2249 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002250 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002251 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002252 }
2253
2254 // Set the domain for the successor or merge it with an existing domain in
2255 // case there are multiple paths (without loop back edges) to the
2256 // successor block.
2257 isl_set *&SuccDomain = DomainMap[SuccBB];
2258 if (!SuccDomain)
2259 SuccDomain = CondSet;
2260 else
2261 SuccDomain = isl_set_union(SuccDomain, CondSet);
2262
2263 SuccDomain = isl_set_coalesce(SuccDomain);
Tobias Grosser75dc40c2015-12-20 13:31:48 +00002264 if (isl_set_n_basic_set(SuccDomain) > MaxConjunctsInDomain) {
2265 auto *Empty = isl_set_empty(isl_set_get_space(SuccDomain));
2266 isl_set_free(SuccDomain);
2267 SuccDomain = Empty;
2268 invalidate(ERROR_DOMAINCONJUNCTS, DebugLoc());
2269 }
Johannes Doerfert634909c2015-10-04 14:57:41 +00002270 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : "
2271 << SuccDomain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002272 }
2273 }
2274}
2275
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002276/// @brief Return the domain for @p BB wrt @p DomainMap.
2277///
2278/// This helper function will lookup @p BB in @p DomainMap but also handle the
2279/// case where @p BB is contained in a non-affine subregion using the region
2280/// tree obtained by @p RI.
2281static __isl_give isl_set *
2282getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
2283 RegionInfo &RI) {
2284 auto DIt = DomainMap.find(BB);
2285 if (DIt != DomainMap.end())
2286 return isl_set_copy(DIt->getSecond());
2287
2288 Region *R = RI.getRegionFor(BB);
2289 while (R->getEntry() == BB)
2290 R = R->getParent();
2291 return getDomainForBlock(R->getEntry(), DomainMap, RI);
2292}
2293
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002294void Scop::propagateDomainConstraints(Region *R) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002295 // Iterate over the region R and propagate the domain constrains from the
2296 // predecessors to the current node. In contrast to the
2297 // buildDomainsWithBranchConstraints function, this one will pull the domain
2298 // information from the predecessors instead of pushing it to the successors.
2299 // Additionally, we assume the domains to be already present in the domain
2300 // map here. However, we iterate again in reverse post order so we know all
2301 // predecessors have been visited before a block or non-affine subregion is
2302 // visited.
2303
2304 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2305 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2306
2307 ReversePostOrderTraversal<Region *> RTraversal(R);
2308 for (auto *RN : RTraversal) {
2309
2310 // Recurse for affine subregions but go on for basic blocks and non-affine
2311 // subregions.
2312 if (RN->isSubRegion()) {
2313 Region *SubRegion = RN->getNodeAs<Region>();
2314 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002315 propagateDomainConstraints(SubRegion);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002316 continue;
2317 }
2318 }
2319
Johannes Doerfertf5673802015-10-01 23:48:18 +00002320 // Get the domain for the current block and check if it was initialized or
2321 // not. The only way it was not is if this block is only reachable via error
2322 // blocks, thus will not be executed under the assumptions we make. Such
2323 // blocks have to be skipped as their predecessors might not have domains
2324 // either. It would not benefit us to compute the domain anyway, only the
2325 // domains of the error blocks that are reachable from non-error blocks
2326 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002327 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002328 isl_set *&Domain = DomainMap[BB];
2329 if (!Domain) {
2330 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2331 << ", it is only reachable from error blocks.\n");
2332 DomainMap.erase(BB);
2333 continue;
2334 }
2335 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
2336
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002337 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2338 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2339
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002340 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2341 for (auto *PredBB : predecessors(BB)) {
2342
2343 // Skip backedges
2344 if (DT.dominates(BB, PredBB))
2345 continue;
2346
2347 isl_set *PredBBDom = nullptr;
2348
2349 // Handle the SCoP entry block with its outside predecessors.
2350 if (!getRegion().contains(PredBB))
2351 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
2352
2353 if (!PredBBDom) {
2354 // Determine the loop depth of the predecessor and adjust its domain to
2355 // the domain of the current block. This can mean we have to:
2356 // o) Drop a dimension if this block is the exit of a loop, not the
2357 // header of a new loop and the predecessor was part of the loop.
2358 // o) Add an unconstrainted new dimension if this block is the header
2359 // of a loop and the predecessor is not part of it.
2360 // o) Drop the information about the innermost loop dimension when the
2361 // predecessor and the current block are surrounded by different
2362 // loops in the same depth.
2363 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
2364 Loop *PredBBLoop = LI.getLoopFor(PredBB);
2365 while (BoxedLoops.count(PredBBLoop))
2366 PredBBLoop = PredBBLoop->getParentLoop();
2367
2368 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002369 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002370 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002371 PredBBDom = isl_set_project_out(
2372 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
2373 LoopDepthDiff);
2374 else if (PredBBLoopDepth < BBLoopDepth) {
2375 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002376 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002377 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
2378 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002379 PredBBDom = isl_set_drop_constraints_involving_dims(
2380 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002381 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002382 }
2383
2384 PredDom = isl_set_union(PredDom, PredBBDom);
2385 }
2386
2387 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00002388 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002389
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002390 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002391 addLoopBoundsToHeaderDomain(BBLoop);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002392
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002393 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002394 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002395 IsOptimized = true;
2396 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002397 addAssumption(ERRORBLOCK, isl_set_complement(DomPar),
2398 BB->getTerminator()->getDebugLoc());
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002399 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002400 }
2401}
2402
2403/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2404/// is incremented by one and all other dimensions are equal, e.g.,
2405/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2406/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2407static __isl_give isl_map *
2408createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2409 auto *MapSpace = isl_space_map_from_set(SetSpace);
2410 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2411 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2412 if (u != Dim)
2413 NextIterationMap =
2414 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2415 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2416 C = isl_constraint_set_constant_si(C, 1);
2417 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2418 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2419 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2420 return NextIterationMap;
2421}
2422
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002423void Scop::addLoopBoundsToHeaderDomain(Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002424 int LoopDepth = getRelativeLoopDepth(L);
2425 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002426
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002427 BasicBlock *HeaderBB = L->getHeader();
2428 assert(DomainMap.count(HeaderBB));
2429 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002430
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002431 isl_map *NextIterationMap =
2432 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002433
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002434 isl_set *UnionBackedgeCondition =
2435 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002436
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002437 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2438 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002439
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002440 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002441
2442 // If the latch is only reachable via error statements we skip it.
2443 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2444 if (!LatchBBDom)
2445 continue;
2446
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002447 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002448
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002449 TerminatorInst *TI = LatchBB->getTerminator();
2450 BranchInst *BI = dyn_cast<BranchInst>(TI);
2451 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002452 BackedgeCondition = isl_set_copy(LatchBBDom);
2453 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002454 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002455 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002456 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002457
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002458 // Free the non back edge condition set as we do not need it.
2459 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002460
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002461 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002462 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002463
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002464 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2465 assert(LatchLoopDepth >= LoopDepth);
2466 BackedgeCondition =
2467 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2468 LatchLoopDepth - LoopDepth);
2469 UnionBackedgeCondition =
2470 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002471 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002472
2473 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2474 for (int i = 0; i < LoopDepth; i++)
2475 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2476
2477 isl_set *UnionBackedgeConditionComplement =
2478 isl_set_complement(UnionBackedgeCondition);
2479 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2480 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2481 UnionBackedgeConditionComplement =
2482 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2483 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2484 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2485
2486 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2487 HeaderBBDom = Parts.second;
2488
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002489 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2490 // the bounded assumptions to the context as they are already implied by the
2491 // <nsw> tag.
2492 if (Affinator.hasNSWAddRecForLoop(L)) {
2493 isl_set_free(Parts.first);
2494 return;
2495 }
2496
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002497 isl_set *UnboundedCtx = isl_set_params(Parts.first);
2498 isl_set *BoundedCtx = isl_set_complement(UnboundedCtx);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002499 addAssumption(INFINITELOOP, BoundedCtx,
2500 HeaderBB->getTerminator()->getDebugLoc());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002501}
2502
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002503void Scop::buildAliasChecks(AliasAnalysis &AA) {
2504 if (!PollyUseRuntimeAliasChecks)
2505 return;
2506
2507 if (buildAliasGroups(AA))
2508 return;
2509
2510 // If a problem occurs while building the alias groups we need to delete
2511 // this SCoP and pretend it wasn't valid in the first place. To this end
2512 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002513 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002514
2515 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2516 << " could not be created as the number of parameters involved "
2517 "is too high. The SCoP will be "
2518 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2519 "the maximal number of parameters but be advised that the "
2520 "compile time might increase exponentially.\n\n");
2521}
2522
Johannes Doerfert9143d672014-09-27 11:02:39 +00002523bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002524 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002525 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002526 // for all memory accesses inside the SCoP.
2527 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002528 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002529 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002530 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002531 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002532 // if their access domains intersect, otherwise they are in different
2533 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002534 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002535 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002536 // and maximal accesses to each array of a group in read only and non
2537 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002538 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2539
2540 AliasSetTracker AST(AA);
2541
2542 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002543 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002544 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002545
2546 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002547 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002548 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2549 isl_set_free(StmtDomain);
2550 if (StmtDomainEmpty)
2551 continue;
2552
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002553 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002554 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002555 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002556 if (!MA->isRead())
2557 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002558 MemAccInst Acc(MA->getAccessInstruction());
2559 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002560 AST.add(Acc);
2561 }
2562 }
2563
2564 SmallVector<AliasGroupTy, 4> AliasGroups;
2565 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002566 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002567 continue;
2568 AliasGroupTy AG;
2569 for (auto PR : AS)
2570 AG.push_back(PtrToAcc[PR.getValue()]);
2571 assert(AG.size() > 1 &&
2572 "Alias groups should contain at least two accesses");
2573 AliasGroups.push_back(std::move(AG));
2574 }
2575
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002576 // Split the alias groups based on their domain.
2577 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2578 AliasGroupTy NewAG;
2579 AliasGroupTy &AG = AliasGroups[u];
2580 AliasGroupTy::iterator AGI = AG.begin();
2581 isl_set *AGDomain = getAccessDomain(*AGI);
2582 while (AGI != AG.end()) {
2583 MemoryAccess *MA = *AGI;
2584 isl_set *MADomain = getAccessDomain(MA);
2585 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2586 NewAG.push_back(MA);
2587 AGI = AG.erase(AGI);
2588 isl_set_free(MADomain);
2589 } else {
2590 AGDomain = isl_set_union(AGDomain, MADomain);
2591 AGI++;
2592 }
2593 }
2594 if (NewAG.size() > 1)
2595 AliasGroups.push_back(std::move(NewAG));
2596 isl_set_free(AGDomain);
2597 }
2598
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002599 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002600 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002601 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2602 for (AliasGroupTy &AG : AliasGroups) {
2603 NonReadOnlyBaseValues.clear();
2604 ReadOnlyPairs.clear();
2605
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002606 if (AG.size() < 2) {
2607 AG.clear();
2608 continue;
2609 }
2610
Johannes Doerfert13771732014-10-01 12:40:46 +00002611 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002612 emitOptimizationRemarkAnalysis(
2613 F.getContext(), DEBUG_TYPE, F,
2614 (*II)->getAccessInstruction()->getDebugLoc(),
2615 "Possibly aliasing pointer, use restrict keyword.");
2616
Johannes Doerfert13771732014-10-01 12:40:46 +00002617 Value *BaseAddr = (*II)->getBaseAddr();
2618 if (HasWriteAccess.count(BaseAddr)) {
2619 NonReadOnlyBaseValues.insert(BaseAddr);
2620 II++;
2621 } else {
2622 ReadOnlyPairs[BaseAddr].insert(*II);
2623 II = AG.erase(II);
2624 }
2625 }
2626
2627 // If we don't have read only pointers check if there are at least two
2628 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002629 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002630 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002631 continue;
2632 }
2633
2634 // If we don't have non read only pointers clear the alias group.
2635 if (NonReadOnlyBaseValues.empty()) {
2636 AG.clear();
2637 continue;
2638 }
2639
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002640 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002641 MinMaxAliasGroups.emplace_back();
2642 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2643 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2644 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2645 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002646
2647 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002648
2649 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002650 for (MemoryAccess *MA : AG)
2651 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002652
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002653 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2654 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002655
2656 // Bail out if the number of values we need to compare is too large.
2657 // This is important as the number of comparisions grows quadratically with
2658 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002659 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2660 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002661 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002662
2663 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002664 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002665 Accesses = isl_union_map_empty(getParamSpace());
2666
2667 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2668 for (MemoryAccess *MA : ReadOnlyPair.second)
2669 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2670
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002671 Valid =
2672 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002673
2674 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002675 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002676 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002677
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002678 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002679}
2680
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002681/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002682static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002683 // Start with the smallest loop containing the entry and expand that
2684 // loop until it contains all blocks in the region. If there is a loop
2685 // containing all blocks in the region check if it is itself contained
2686 // and if so take the parent loop as it will be the smallest containing
2687 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002688 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002689 while (L) {
2690 bool AllContained = true;
2691 for (auto *BB : R.blocks())
2692 AllContained &= L->contains(BB);
2693 if (AllContained)
2694 break;
2695 L = L->getParentLoop();
2696 }
2697
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002698 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2699}
2700
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002701static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2702 ScopDetection &SD) {
2703
2704 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2705
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002706 unsigned MinLD = INT_MAX, MaxLD = 0;
2707 for (BasicBlock *BB : R.blocks()) {
2708 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002709 if (!R.contains(L))
2710 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002711 if (BoxedLoops && BoxedLoops->count(L))
2712 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002713 unsigned LD = L->getLoopDepth();
2714 MinLD = std::min(MinLD, LD);
2715 MaxLD = std::max(MaxLD, LD);
2716 }
2717 }
2718
2719 // Handle the case that there is no loop in the SCoP first.
2720 if (MaxLD == 0)
2721 return 1;
2722
2723 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2724 assert(MaxLD >= MinLD &&
2725 "Maximal loop depth was smaller than mininaml loop depth?");
2726 return MaxLD - MinLD + 1;
2727}
2728
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002729Scop::Scop(Region &R, AccFuncMapType &AccFuncMap, ScopDetection &SD,
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002730 ScalarEvolution &ScalarEvolution, DominatorTree &DT, LoopInfo &LI,
Johannes Doerfert96425c22015-08-30 21:13:53 +00002731 isl_ctx *Context, unsigned MaxLoopDepth)
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002732 : LI(LI), DT(DT), SE(&ScalarEvolution), SD(SD), R(R),
2733 AccFuncMap(AccFuncMap), IsOptimized(false),
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002734 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
2735 MaxLoopDepth(MaxLoopDepth), IslCtx(Context), Context(nullptr),
2736 Affinator(this), AssumedContext(nullptr), BoundaryContext(nullptr),
Tobias Grosserd840fc72016-02-04 13:18:42 +00002737 Schedule(nullptr) {
2738 buildContext();
2739}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002740
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002741void Scop::init(AliasAnalysis &AA, AssumptionCache &AC) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00002742 addUserAssumptions(AC);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002743 buildInvariantEquivalenceClasses();
2744
Johannes Doerfertd8dd8632015-10-07 20:31:36 +00002745 buildDomains(&R);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002746
Michael Krusecac948e2015-10-02 13:53:07 +00002747 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00002748 // Exit early in case there are no executable statements left in this scop.
Michael Krusecac948e2015-10-02 13:53:07 +00002749 simplifySCoP(true);
Michael Kruseafe06702015-10-02 16:33:27 +00002750 if (Stmts.empty())
2751 return;
Tobias Grosser75805372011-04-29 06:27:02 +00002752
Michael Krusecac948e2015-10-02 13:53:07 +00002753 // The ScopStmts now have enough information to initialize themselves.
2754 for (ScopStmt &Stmt : Stmts)
2755 Stmt.init();
2756
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00002757 buildSchedule();
Tobias Grosser75805372011-04-29 06:27:02 +00002758
Tobias Grosser8286b832015-11-02 11:29:32 +00002759 if (isl_set_is_empty(AssumedContext))
2760 return;
2761
2762 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002763 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002764 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002765 addUserContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002766 buildBoundaryContext();
2767 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002768 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002769
2770 hoistInvariantLoads();
Michael Krusecac948e2015-10-02 13:53:07 +00002771 simplifySCoP(false);
Tobias Grosser75805372011-04-29 06:27:02 +00002772}
2773
2774Scop::~Scop() {
2775 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002776 isl_set_free(AssumedContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002777 isl_set_free(BoundaryContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002778 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002779
Johannes Doerfert96425c22015-08-30 21:13:53 +00002780 for (auto It : DomainMap)
2781 isl_set_free(It.second);
2782
Johannes Doerfertb164c792014-09-18 11:17:17 +00002783 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002784 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002785 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002786 isl_pw_multi_aff_free(MMA.first);
2787 isl_pw_multi_aff_free(MMA.second);
2788 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002789 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002790 isl_pw_multi_aff_free(MMA.first);
2791 isl_pw_multi_aff_free(MMA.second);
2792 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002793 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002794
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002795 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002796 isl_set_free(std::get<2>(IAClass));
Tobias Grosser75805372011-04-29 06:27:02 +00002797}
2798
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002799void Scop::updateAccessDimensionality() {
2800 for (auto &Stmt : *this)
2801 for (auto &Access : Stmt)
2802 Access->updateDimensionality();
2803}
2804
Michael Krusecac948e2015-10-02 13:53:07 +00002805void Scop::simplifySCoP(bool RemoveIgnoredStmts) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002806 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
2807 ScopStmt &Stmt = *StmtIt;
Michael Krusecac948e2015-10-02 13:53:07 +00002808 RegionNode *RN = Stmt.isRegionStmt()
2809 ? Stmt.getRegion()->getNode()
2810 : getRegion().getBBNode(Stmt.getBasicBlock());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002811
Johannes Doerferteca9e892015-11-03 16:54:49 +00002812 bool RemoveStmt = StmtIt->isEmpty();
2813 if (!RemoveStmt)
2814 RemoveStmt = isl_set_is_empty(DomainMap[getRegionNodeBasicBlock(RN)]);
2815 if (!RemoveStmt)
2816 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00002817
Johannes Doerferteca9e892015-11-03 16:54:49 +00002818 // Remove read only statements only after invariant loop hoisting.
2819 if (!RemoveStmt && !RemoveIgnoredStmts) {
2820 bool OnlyRead = true;
2821 for (MemoryAccess *MA : Stmt) {
2822 if (MA->isRead())
2823 continue;
2824
2825 OnlyRead = false;
2826 break;
2827 }
2828
2829 RemoveStmt = OnlyRead;
2830 }
2831
2832 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00002833 // Remove the statement because it is unnecessary.
2834 if (Stmt.isRegionStmt())
2835 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2836 StmtMap.erase(BB);
2837 else
2838 StmtMap.erase(Stmt.getBasicBlock());
2839
2840 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002841 continue;
2842 }
2843
Michael Krusecac948e2015-10-02 13:53:07 +00002844 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002845 }
2846}
2847
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002848const InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) const {
2849 LoadInst *LInst = dyn_cast<LoadInst>(Val);
2850 if (!LInst)
2851 return nullptr;
2852
2853 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
2854 LInst = cast<LoadInst>(Rep);
2855
Johannes Doerfert96e54712016-02-07 17:30:13 +00002856 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002857 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2858 for (auto &IAClass : InvariantEquivClasses)
Johannes Doerfert96e54712016-02-07 17:30:13 +00002859 if (PointerSCEV == std::get<0>(IAClass) && Ty == std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002860 return &IAClass;
2861
2862 return nullptr;
2863}
2864
2865void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
2866
2867 // Get the context under which the statement is executed.
2868 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
2869 DomainCtx = isl_set_remove_redundancies(DomainCtx);
2870 DomainCtx = isl_set_detect_equalities(DomainCtx);
2871 DomainCtx = isl_set_coalesce(DomainCtx);
2872
2873 // Project out all parameters that relate to loads in the statement. Otherwise
2874 // we could have cyclic dependences on the constraints under which the
2875 // hoisted loads are executed and we could not determine an order in which to
2876 // pre-load them. This happens because not only lower bounds are part of the
2877 // domain but also upper bounds.
2878 for (MemoryAccess *MA : InvMAs) {
2879 Instruction *AccInst = MA->getAccessInstruction();
2880 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00002881 SetVector<Value *> Values;
2882 for (const SCEV *Parameter : Parameters) {
2883 Values.clear();
2884 findValues(Parameter, Values);
2885 if (!Values.count(AccInst))
2886 continue;
2887
2888 if (isl_id *ParamId = getIdForParam(Parameter)) {
2889 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
2890 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
2891 isl_id_free(ParamId);
2892 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002893 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002894 }
2895 }
2896
2897 for (MemoryAccess *MA : InvMAs) {
2898 // Check for another invariant access that accesses the same location as
2899 // MA and if found consolidate them. Otherwise create a new equivalence
2900 // class at the end of InvariantEquivClasses.
2901 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00002902 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002903 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2904
2905 bool Consolidated = false;
2906 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002907 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002908 continue;
2909
2910 Consolidated = true;
2911
2912 // Add MA to the list of accesses that are in this class.
2913 auto &MAs = std::get<1>(IAClass);
2914 MAs.push_front(MA);
2915
2916 // Unify the execution context of the class and this statement.
2917 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002918 if (IAClassDomainCtx)
2919 IAClassDomainCtx = isl_set_coalesce(
2920 isl_set_union(IAClassDomainCtx, isl_set_copy(DomainCtx)));
2921 else
2922 IAClassDomainCtx = isl_set_copy(DomainCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002923 break;
2924 }
2925
2926 if (Consolidated)
2927 continue;
2928
2929 // If we did not consolidate MA, thus did not find an equivalence class
2930 // for it, we create a new one.
2931 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA},
Johannes Doerfert96e54712016-02-07 17:30:13 +00002932 isl_set_copy(DomainCtx), Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002933 }
2934
2935 isl_set_free(DomainCtx);
2936}
2937
Tobias Grosser29f38ab2015-12-13 21:00:40 +00002938bool Scop::isHoistableAccess(MemoryAccess *Access,
2939 __isl_keep isl_union_map *Writes) {
2940 // TODO: Loads that are not loop carried, hence are in a statement with
2941 // zero iterators, are by construction invariant, though we
2942 // currently "hoist" them anyway. This is necessary because we allow
2943 // them to be treated as parameters (e.g., in conditions) and our code
2944 // generation would otherwise use the old value.
2945
2946 auto &Stmt = *Access->getStatement();
2947 BasicBlock *BB =
2948 Stmt.isBlockStmt() ? Stmt.getBasicBlock() : Stmt.getRegion()->getEntry();
2949
2950 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
2951 return false;
2952
2953 // Skip accesses that have an invariant base pointer which is defined but
2954 // not loaded inside the SCoP. This can happened e.g., if a readnone call
2955 // returns a pointer that is used as a base address. However, as we want
2956 // to hoist indirect pointers, we allow the base pointer to be defined in
2957 // the region if it is also a memory access. Each ScopArrayInfo object
2958 // that has a base pointer origin has a base pointer that is loaded and
2959 // that it is invariant, thus it will be hoisted too. However, if there is
2960 // no base pointer origin we check that the base pointer is defined
2961 // outside the region.
2962 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
2963 while (auto *BasePtrOriginSAI = SAI->getBasePtrOriginSAI())
2964 SAI = BasePtrOriginSAI;
2965
2966 if (auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr()))
2967 if (R.contains(BasePtrInst))
2968 return false;
2969
2970 // Skip accesses in non-affine subregions as they might not be executed
2971 // under the same condition as the entry of the non-affine subregion.
2972 if (BB != Access->getAccessInstruction()->getParent())
2973 return false;
2974
2975 isl_map *AccessRelation = Access->getAccessRelation();
2976
2977 // Skip accesses that have an empty access relation. These can be caused
2978 // by multiple offsets with a type cast in-between that cause the overall
2979 // byte offset to be not divisible by the new types sizes.
2980 if (isl_map_is_empty(AccessRelation)) {
2981 isl_map_free(AccessRelation);
2982 return false;
2983 }
2984
2985 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
2986 Stmt.getNumIterators())) {
2987 isl_map_free(AccessRelation);
2988 return false;
2989 }
2990
2991 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
2992 isl_set *AccessRange = isl_map_range(AccessRelation);
2993
2994 isl_union_map *Written = isl_union_map_intersect_range(
2995 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
2996 bool IsWritten = !isl_union_map_is_empty(Written);
2997 isl_union_map_free(Written);
2998
2999 if (IsWritten)
3000 return false;
3001
3002 return true;
3003}
3004
3005void Scop::verifyInvariantLoads() {
3006 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3007 for (LoadInst *LI : RIL) {
3008 assert(LI && getRegion().contains(LI));
3009 ScopStmt *Stmt = getStmtForBasicBlock(LI->getParent());
Tobias Grosser949e8c62015-12-21 07:10:39 +00003010 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003011 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3012 return;
3013 }
3014 }
3015}
3016
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003017void Scop::hoistInvariantLoads() {
3018 isl_union_map *Writes = getWrites();
3019 for (ScopStmt &Stmt : *this) {
3020
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003021 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003022
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003023 for (MemoryAccess *Access : Stmt)
3024 if (isHoistableAccess(Access, Writes))
3025 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003026
3027 // We inserted invariant accesses always in the front but need them to be
3028 // sorted in a "natural order". The statements are already sorted in reverse
3029 // post order and that suffices for the accesses too. The reason we require
3030 // an order in the first place is the dependences between invariant loads
3031 // that can be caused by indirect loads.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003032 InvariantAccesses.reverse();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003033
3034 // Transfer the memory access from the statement to the SCoP.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003035 Stmt.removeMemoryAccesses(InvariantAccesses);
3036 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003037 }
3038 isl_union_map_free(Writes);
3039
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003040 verifyInvariantLoads();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003041}
3042
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003043const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003044Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003045 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003046 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003047 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003048 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003049 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003050 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003051 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003052 } else {
Tobias Grosser8286b832015-11-02 11:29:32 +00003053 // In case of mismatching array sizes, we bail out by setting the run-time
3054 // context to false.
Tobias Grosserd840fc72016-02-04 13:18:42 +00003055 if (!SAI->updateSizes(Sizes, ElementType))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003056 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003057 }
Tobias Grosserab671442015-05-23 05:58:27 +00003058 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003059}
3060
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003061const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003062 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003063 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003064 assert(SAI && "No ScopArrayInfo available for this base pointer");
3065 return SAI;
3066}
3067
Tobias Grosser74394f02013-01-14 22:40:23 +00003068std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003069std::string Scop::getAssumedContextStr() const {
3070 return stringFromIslObj(AssumedContext);
3071}
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003072std::string Scop::getBoundaryContextStr() const {
3073 return stringFromIslObj(BoundaryContext);
3074}
Tobias Grosser75805372011-04-29 06:27:02 +00003075
3076std::string Scop::getNameStr() const {
3077 std::string ExitName, EntryName;
3078 raw_string_ostream ExitStr(ExitName);
3079 raw_string_ostream EntryStr(EntryName);
3080
Tobias Grosserf240b482014-01-09 10:42:15 +00003081 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003082 EntryStr.str();
3083
3084 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003085 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003086 ExitStr.str();
3087 } else
3088 ExitName = "FunctionExit";
3089
3090 return EntryName + "---" + ExitName;
3091}
3092
Tobias Grosser74394f02013-01-14 22:40:23 +00003093__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003094__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003095 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003096}
3097
Tobias Grossere86109f2013-10-29 21:05:49 +00003098__isl_give isl_set *Scop::getAssumedContext() const {
3099 return isl_set_copy(AssumedContext);
3100}
3101
Johannes Doerfert43788c52015-08-20 05:58:56 +00003102__isl_give isl_set *Scop::getRuntimeCheckContext() const {
3103 isl_set *RuntimeCheckContext = getAssumedContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003104 RuntimeCheckContext =
3105 isl_set_intersect(RuntimeCheckContext, getBoundaryContext());
3106 RuntimeCheckContext = simplifyAssumptionContext(RuntimeCheckContext, *this);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003107 return RuntimeCheckContext;
3108}
3109
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003110bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00003111 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003112 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003113 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
3114 isl_set_free(RuntimeCheckContext);
3115 return IsFeasible;
3116}
3117
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003118static std::string toString(AssumptionKind Kind) {
3119 switch (Kind) {
3120 case ALIASING:
3121 return "No-aliasing";
3122 case INBOUNDS:
3123 return "Inbounds";
3124 case WRAPPING:
3125 return "No-overflows";
Johannes Doerferta4b77c02015-11-12 20:15:32 +00003126 case ALIGNMENT:
3127 return "Alignment";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003128 case ERRORBLOCK:
3129 return "No-error";
3130 case INFINITELOOP:
3131 return "Finite loop";
3132 case INVARIANTLOAD:
3133 return "Invariant load";
3134 case DELINEARIZATION:
3135 return "Delinearization";
Tobias Grosser75dc40c2015-12-20 13:31:48 +00003136 case ERROR_DOMAINCONJUNCTS:
3137 return "Low number of domain conjuncts";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003138 }
3139 llvm_unreachable("Unknown AssumptionKind!");
3140}
3141
3142void Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3143 DebugLoc Loc) {
3144 if (isl_set_is_subset(Context, Set))
3145 return;
3146
3147 if (isl_set_is_subset(AssumedContext, Set))
3148 return;
3149
3150 auto &F = *getRegion().getEntry()->getParent();
3151 std::string Msg = toString(Kind) + " assumption:\t" + stringFromIslObj(Set);
3152 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
3153}
3154
3155void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
3156 DebugLoc Loc) {
3157 trackAssumption(Kind, Set, Loc);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003158 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003159
Johannes Doerfert9d7899e2015-11-11 20:01:31 +00003160 int NSets = isl_set_n_basic_set(AssumedContext);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003161 if (NSets >= MaxDisjunctsAssumed) {
3162 isl_space *Space = isl_set_get_space(AssumedContext);
3163 isl_set_free(AssumedContext);
Tobias Grossere19fca42015-11-11 20:21:39 +00003164 AssumedContext = isl_set_empty(Space);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003165 }
3166
Tobias Grosser7b50bee2014-11-25 10:51:12 +00003167 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003168}
3169
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003170void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
3171 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc);
3172}
3173
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003174__isl_give isl_set *Scop::getBoundaryContext() const {
3175 return isl_set_copy(BoundaryContext);
3176}
3177
Tobias Grosser75805372011-04-29 06:27:02 +00003178void Scop::printContext(raw_ostream &OS) const {
3179 OS << "Context:\n";
3180
3181 if (!Context) {
3182 OS.indent(4) << "n/a\n\n";
3183 return;
3184 }
3185
3186 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003187
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003188 OS.indent(4) << "Assumed Context:\n";
3189 if (!AssumedContext) {
3190 OS.indent(4) << "n/a\n\n";
3191 return;
3192 }
3193
3194 OS.indent(4) << getAssumedContextStr() << "\n";
3195
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003196 OS.indent(4) << "Boundary Context:\n";
3197 if (!BoundaryContext) {
3198 OS.indent(4) << "n/a\n\n";
3199 return;
3200 }
3201
3202 OS.indent(4) << getBoundaryContextStr() << "\n";
3203
Tobias Grosser083d3d32014-06-28 08:59:45 +00003204 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00003205 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00003206 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
3207 }
Tobias Grosser75805372011-04-29 06:27:02 +00003208}
3209
Johannes Doerfertb164c792014-09-18 11:17:17 +00003210void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003211 int noOfGroups = 0;
3212 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003213 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003214 noOfGroups += 1;
3215 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003216 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003217 }
3218
Tobias Grosserbb853c22015-07-25 12:31:03 +00003219 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003220 if (MinMaxAliasGroups.empty()) {
3221 OS.indent(8) << "n/a\n";
3222 return;
3223 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003224
Tobias Grosserbb853c22015-07-25 12:31:03 +00003225 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003226
3227 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003228 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003229 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003230 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003231 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3232 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003233 }
3234 OS << " ]]\n";
3235 }
3236
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003237 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003238 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003239 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003240 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003241 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3242 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003243 }
3244 OS << " ]]\n";
3245 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003246 }
3247}
3248
Tobias Grosser75805372011-04-29 06:27:02 +00003249void Scop::printStatements(raw_ostream &OS) const {
3250 OS << "Statements {\n";
3251
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003252 for (const ScopStmt &Stmt : *this)
3253 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003254
3255 OS.indent(4) << "}\n";
3256}
3257
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003258void Scop::printArrayInfo(raw_ostream &OS) const {
3259 OS << "Arrays {\n";
3260
Tobias Grosserab671442015-05-23 05:58:27 +00003261 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003262 Array.second->print(OS);
3263
3264 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003265
3266 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3267
3268 for (auto &Array : arrays())
3269 Array.second->print(OS, /* SizeAsPwAff */ true);
3270
3271 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003272}
3273
Tobias Grosser75805372011-04-29 06:27:02 +00003274void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003275 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3276 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003277 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003278 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003279 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003280 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003281 const auto &MAs = std::get<1>(IAClass);
3282 if (MAs.empty()) {
3283 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003284 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003285 MAs.front()->print(OS);
3286 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003287 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003288 }
3289 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003290 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003291 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003292 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003293 printStatements(OS.indent(4));
3294}
3295
3296void Scop::dump() const { print(dbgs()); }
3297
Tobias Grosser9a38ab82011-11-08 15:41:03 +00003298isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00003299
Johannes Doerfertcef616f2015-09-15 22:49:04 +00003300__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
3301 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003302}
3303
Tobias Grosser808cd692015-07-14 09:33:13 +00003304__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003305 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003306
Tobias Grosser808cd692015-07-14 09:33:13 +00003307 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003308 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003309
3310 return Domain;
3311}
3312
Tobias Grossere5a35142015-11-12 14:07:09 +00003313__isl_give isl_union_map *
3314Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3315 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003316
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003317 for (ScopStmt &Stmt : *this) {
3318 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003319 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003320 continue;
3321
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003322 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003323 isl_map *AccessDomain = MA->getAccessRelation();
3324 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003325 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003326 }
3327 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003328 return isl_union_map_coalesce(Accesses);
3329}
3330
3331__isl_give isl_union_map *Scop::getMustWrites() {
3332 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003333}
3334
3335__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003336 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003337}
3338
Tobias Grosser37eb4222014-02-20 21:43:54 +00003339__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003340 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003341}
3342
3343__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003344 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003345}
3346
Tobias Grosser2ac23382015-11-12 14:07:13 +00003347__isl_give isl_union_map *Scop::getAccesses() {
3348 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3349}
3350
Tobias Grosser808cd692015-07-14 09:33:13 +00003351__isl_give isl_union_map *Scop::getSchedule() const {
3352 auto Tree = getScheduleTree();
3353 auto S = isl_schedule_get_map(Tree);
3354 isl_schedule_free(Tree);
3355 return S;
3356}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003357
Tobias Grosser808cd692015-07-14 09:33:13 +00003358__isl_give isl_schedule *Scop::getScheduleTree() const {
3359 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3360 getDomains());
3361}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003362
Tobias Grosser808cd692015-07-14 09:33:13 +00003363void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3364 auto *S = isl_schedule_from_domain(getDomains());
3365 S = isl_schedule_insert_partial_schedule(
3366 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3367 isl_schedule_free(Schedule);
3368 Schedule = S;
3369}
3370
3371void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3372 isl_schedule_free(Schedule);
3373 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003374}
3375
3376bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3377 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003378 for (ScopStmt &Stmt : *this) {
3379 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003380 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3381 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3382
3383 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3384 isl_union_set_free(StmtDomain);
3385 isl_union_set_free(NewStmtDomain);
3386 continue;
3387 }
3388
3389 Changed = true;
3390
3391 isl_union_set_free(StmtDomain);
3392 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3393
3394 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003395 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003396 isl_union_set_free(NewStmtDomain);
3397 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003398 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003399 }
3400 isl_union_set_free(Domain);
3401 return Changed;
3402}
3403
Tobias Grosser75805372011-04-29 06:27:02 +00003404ScalarEvolution *Scop::getSE() const { return SE; }
3405
Johannes Doerfertf5673802015-10-01 23:48:18 +00003406bool Scop::isIgnored(RegionNode *RN) {
3407 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003408 ScopStmt *Stmt = getStmtForRegionNode(RN);
3409
3410 // If there is no stmt, then it already has been removed.
3411 if (!Stmt)
3412 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003413
Johannes Doerfertf5673802015-10-01 23:48:18 +00003414 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003415 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003416 return true;
3417
3418 // Check for reachability via non-error blocks.
3419 if (!DomainMap.count(BB))
3420 return true;
3421
3422 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003423 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003424 return true;
3425
3426 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003427}
3428
Tobias Grosser808cd692015-07-14 09:33:13 +00003429struct MapToDimensionDataTy {
3430 int N;
3431 isl_union_pw_multi_aff *Res;
3432};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003433
Tobias Grosser808cd692015-07-14 09:33:13 +00003434// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003435// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003436//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003437// @param Set The input set.
3438// @param User->N The dimension to map to.
3439// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003440//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003441// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003442static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3443 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3444 int Dim;
3445 isl_space *Space;
3446 isl_pw_multi_aff *PMA;
3447
3448 Dim = isl_set_dim(Set, isl_dim_set);
3449 Space = isl_set_get_space(Set);
3450 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3451 Dim - Data->N);
3452 if (Data->N > 1)
3453 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3454 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3455
3456 isl_set_free(Set);
3457
3458 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003459}
3460
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003461// @brief Create an isl_multi_union_aff that defines an identity mapping
3462// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003463//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003464// # Example:
3465//
3466// Domain: { A[i,j]; B[i,j,k] }
3467// N: 1
3468//
3469// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3470//
3471// @param USet A union set describing the elements for which to generate a
3472// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003473// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003474// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003475static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003476mapToDimension(__isl_take isl_union_set *USet, int N) {
3477 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003478 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003479 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003480
Tobias Grosser808cd692015-07-14 09:33:13 +00003481 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003482
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003483 auto *Space = isl_union_set_get_space(USet);
3484 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003485
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003486 Data = {N, PwAff};
3487
3488 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
3489
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003490 (void)Res;
3491
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003492 assert(Res == isl_stat_ok);
3493
3494 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003495 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
3496}
3497
Tobias Grosser316b5b22015-11-11 19:28:14 +00003498void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00003499 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00003500 Stmts.emplace_back(*this, *BB);
Tobias Grosser316b5b22015-11-11 19:28:14 +00003501 auto Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003502 StmtMap[BB] = Stmt;
3503 } else {
3504 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00003505 Stmts.emplace_back(*this, *R);
Tobias Grosser316b5b22015-11-11 19:28:14 +00003506 auto Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003507 for (BasicBlock *BB : R->blocks())
3508 StmtMap[BB] = Stmt;
3509 }
Tobias Grosser808cd692015-07-14 09:33:13 +00003510}
3511
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003512void Scop::buildSchedule() {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003513 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003514 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
3515 buildSchedule(getRegion().getNode(), LoopStack);
3516 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
3517 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003518}
3519
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003520/// To generate a schedule for the elements in a Region we traverse the Region
3521/// in reverse-post-order and add the contained RegionNodes in traversal order
3522/// to the schedule of the loop that is currently at the top of the LoopStack.
3523/// For loop-free codes, this results in a correct sequential ordering.
3524///
3525/// Example:
3526/// bb1(0)
3527/// / \.
3528/// bb2(1) bb3(2)
3529/// \ / \.
3530/// bb4(3) bb5(4)
3531/// \ /
3532/// bb6(5)
3533///
3534/// Including loops requires additional processing. Whenever a loop header is
3535/// encountered, the corresponding loop is added to the @p LoopStack. Starting
3536/// from an empty schedule, we first process all RegionNodes that are within
3537/// this loop and complete the sequential schedule at this loop-level before
3538/// processing about any other nodes. To implement this
3539/// loop-nodes-first-processing, the reverse post-order traversal is
3540/// insufficient. Hence, we additionally check if the traversal yields
3541/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
3542/// These region-nodes are then queue and only traverse after the all nodes
3543/// within the current loop have been processed.
3544void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack) {
3545 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
3546
3547 ReversePostOrderTraversal<Region *> RTraversal(R);
3548 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
3549 std::deque<RegionNode *> DelayList;
3550 bool LastRNWaiting = false;
3551
3552 // Iterate over the region @p R in reverse post-order but queue
3553 // sub-regions/blocks iff they are not part of the last encountered but not
3554 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
3555 // that we queued the last sub-region/block from the reverse post-order
3556 // iterator. If it is set we have to explore the next sub-region/block from
3557 // the iterator (if any) to guarantee progress. If it is not set we first try
3558 // the next queued sub-region/blocks.
3559 while (!WorkList.empty() || !DelayList.empty()) {
3560 RegionNode *RN;
3561
3562 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
3563 RN = WorkList.front();
3564 WorkList.pop_front();
3565 LastRNWaiting = false;
3566 } else {
3567 RN = DelayList.front();
3568 DelayList.pop_front();
3569 }
3570
3571 Loop *L = getRegionNodeLoop(RN, LI);
3572 if (!getRegion().contains(L))
3573 L = OuterScopLoop;
3574
3575 Loop *LastLoop = LoopStack.back().L;
3576 if (LastLoop != L) {
3577 if (!LastLoop->contains(L)) {
3578 LastRNWaiting = true;
3579 DelayList.push_back(RN);
3580 continue;
3581 }
3582 LoopStack.push_back({L, nullptr, 0});
3583 }
3584 buildSchedule(RN, LoopStack);
3585 }
3586
3587 return;
3588}
3589
3590void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack) {
Michael Kruse046dde42015-08-10 13:01:57 +00003591
Tobias Grosser8362c262016-01-06 15:30:06 +00003592 if (RN->isSubRegion()) {
3593 auto *LocalRegion = RN->getNodeAs<Region>();
3594 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003595 buildSchedule(LocalRegion, LoopStack);
Tobias Grosser8362c262016-01-06 15:30:06 +00003596 return;
3597 }
3598 }
Michael Kruse046dde42015-08-10 13:01:57 +00003599
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003600 auto &LoopData = LoopStack.back();
3601 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00003602
Tobias Grosserc9abde82016-01-23 20:23:06 +00003603 if (auto *Stmt = getStmtForRegionNode(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00003604 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
3605 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003606 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00003607 }
3608
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003609 // Check if we just processed the last node in this loop. If we did, finalize
3610 // the loop by:
3611 //
3612 // - adding new schedule dimensions
3613 // - folding the resulting schedule into the parent loop schedule
3614 // - dropping the loop schedule from the LoopStack.
3615 //
3616 // Then continue to check surrounding loops, which might also have been
3617 // completed by this node.
3618 while (LoopData.L &&
3619 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
3620 auto Schedule = LoopData.Schedule;
3621 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00003622
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003623 LoopStack.pop_back();
3624 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00003625
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003626 if (Schedule) {
3627 auto *Domain = isl_schedule_get_domain(Schedule);
3628 auto *MUPA = mapToDimension(Domain, LoopStack.size());
3629 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
3630 NextLoopData.Schedule =
3631 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003632 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003633
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003634 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
3635 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00003636 }
Tobias Grosser75805372011-04-29 06:27:02 +00003637}
3638
Johannes Doerfert7c494212014-10-31 23:13:39 +00003639ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00003640 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00003641 if (StmtMapIt == StmtMap.end())
3642 return nullptr;
3643 return StmtMapIt->second;
3644}
3645
Michael Krusea902ba62015-12-13 19:21:45 +00003646ScopStmt *Scop::getStmtForRegionNode(RegionNode *RN) const {
3647 return getStmtForBasicBlock(getRegionNodeBasicBlock(RN));
3648}
3649
Johannes Doerfert96425c22015-08-30 21:13:53 +00003650int Scop::getRelativeLoopDepth(const Loop *L) const {
3651 Loop *OuterLoop =
3652 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
3653 if (!OuterLoop)
3654 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00003655 return L->getLoopDepth() - OuterLoop->getLoopDepth();
3656}
3657
Michael Krused868b5d2015-09-10 15:25:24 +00003658void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00003659 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003660
3661 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
3662 // true, are not modeled as ordinary PHI nodes as they are not part of the
3663 // region. However, we model the operands in the predecessor blocks that are
3664 // part of the region as regular scalar accesses.
3665
3666 // If we can synthesize a PHI we can skip it, however only if it is in
3667 // the region. If it is not it can only be in the exit block of the region.
3668 // In this case we model the operands but not the PHI itself.
3669 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
3670 return;
3671
3672 // PHI nodes are modeled as if they had been demoted prior to the SCoP
3673 // detection. Hence, the PHI is a load of a new memory location in which the
3674 // incoming value was written at the end of the incoming basic block.
3675 bool OnlyNonAffineSubRegionOperands = true;
3676 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
3677 Value *Op = PHI->getIncomingValue(u);
3678 BasicBlock *OpBB = PHI->getIncomingBlock(u);
3679
3680 // Do not build scalar dependences inside a non-affine subregion.
3681 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
3682 continue;
3683
3684 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003685 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003686 }
3687
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003688 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3689 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003690 }
3691}
3692
Michael Kruse2e02d562016-02-06 09:19:40 +00003693void ScopInfo::buildScalarDependences(Instruction *Inst) {
3694 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00003695
Michael Kruse2e02d562016-02-06 09:19:40 +00003696 // Pull-in required operands.
3697 for (Use &Op : Inst->operands())
3698 ensureValueRead(Op.get(), Inst->getParent());
3699}
Michael Kruse7bf39442015-09-10 12:46:52 +00003700
Michael Kruse2e02d562016-02-06 09:19:40 +00003701void ScopInfo::buildEscapingDependences(Instruction *Inst) {
3702 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00003703
Michael Kruse2e02d562016-02-06 09:19:40 +00003704 // Check for uses of this instruction outside the scop. Because we do not
3705 // iterate over such instructions and therefore did not "ensure" the existence
3706 // of a write, we must determine such use here.
3707 for (Use &U : Inst->uses()) {
3708 Instruction *UI = dyn_cast<Instruction>(U.getUser());
3709 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00003710 continue;
3711
Michael Kruse2e02d562016-02-06 09:19:40 +00003712 BasicBlock *UseParent = getUseBlock(U);
3713 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00003714
Michael Kruse2e02d562016-02-06 09:19:40 +00003715 // An escaping value is either used by an instruction not within the scop,
3716 // or (when the scop region's exit needs to be simplified) by a PHI in the
3717 // scop's exit block. This is because region simplification before code
3718 // generation inserts new basic blocks before the PHI such that its incoming
3719 // blocks are not in the scop anymore.
3720 if (!R->contains(UseParent) ||
3721 (isa<PHINode>(UI) && UserParent == R->getExit() &&
3722 R->getExitingBlock())) {
3723 // At least one escaping use found.
3724 ensureValueWrite(Inst);
3725 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00003726 }
3727 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003728}
3729
3730extern MapInsnToMemAcc InsnToMemAcc;
3731
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003732bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00003733 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00003734 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3735 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00003736 Value *Val = Inst.getValueOperand();
3737 Type *SizeType = Val->getType();
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003738 unsigned ElementSize = DL->getTypeAllocSize(SizeType);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003739 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003740 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003741 const SCEVUnknown *BasePointer =
3742 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003743 enum MemoryAccess::AccessType Type =
3744 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003745
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003746 if (isa<GetElementPtrInst>(Address) || isa<BitCastInst>(Address)) {
3747 auto NewAddress = Address;
3748 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
3749 auto Src = BitCast->getOperand(0);
3750 auto SrcTy = Src->getType();
3751 auto DstTy = BitCast->getType();
3752 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3753 NewAddress = Src;
3754 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003755
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003756 if (auto *GEP = dyn_cast<GetElementPtrInst>(NewAddress)) {
3757 std::vector<const SCEV *> Subscripts;
3758 std::vector<int> Sizes;
3759 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
3760 auto BasePtr = GEP->getOperand(0);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003761
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003762 std::vector<const SCEV *> SizesSCEV;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003763
Johannes Doerfert09e36972015-10-07 20:17:36 +00003764 for (auto Subscript : Subscripts) {
3765 InvariantLoadsSetTy AccessILS;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003766 if (!isAffineExpr(R, Subscript, *SE, nullptr, &AccessILS))
3767 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003768
3769 for (LoadInst *LInst : AccessILS)
3770 if (!ScopRIL.count(LInst))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003771 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003772 }
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003773
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003774 if (Sizes.size() > 0) {
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003775 for (auto V : Sizes)
3776 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
3777 IntegerType::getInt64Ty(BasePtr->getContext()), V)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003778
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003779 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementSize, true,
Tobias Grossera535dff2015-12-13 19:59:01 +00003780 Subscripts, SizesSCEV, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003781 return true;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003782 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003783 }
3784 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003785 return false;
3786}
3787
3788bool ScopInfo::buildAccessMultiDimParam(
3789 MemAccInst Inst, Loop *L, Region *R,
3790 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3791 const InvariantLoadsSetTy &ScopRIL) {
3792 Value *Address = Inst.getPointerOperand();
3793 Value *Val = Inst.getValueOperand();
3794 Type *SizeType = Val->getType();
3795 unsigned ElementSize = DL->getTypeAllocSize(SizeType);
3796 enum MemoryAccess::AccessType Type =
3797 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3798
3799 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3800 const SCEVUnknown *BasePointer =
3801 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3802
3803 assert(BasePointer && "Could not find base pointer");
3804 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003805
Michael Kruse7bf39442015-09-10 12:46:52 +00003806 auto AccItr = InsnToMemAcc.find(Inst);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003807 if (PollyDelinearize && AccItr != InsnToMemAcc.end()) {
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003808 std::vector<const SCEV *> Sizes(
3809 AccItr->second.Shape->DelinearizedSizes.begin(),
3810 AccItr->second.Shape->DelinearizedSizes.end());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003811 // Remove the element size. This information is already provided by the
Tobias Grosserd840fc72016-02-04 13:18:42 +00003812 // ElementSize parameter. In case the element size of this access and the
3813 // element size used for delinearization differs the delinearization is
3814 // incorrect. Hence, we invalidate the scop.
3815 //
3816 // TODO: Handle delinearization with differing element sizes.
3817 auto DelinearizedSize =
3818 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003819 Sizes.pop_back();
Tobias Grosserd840fc72016-02-04 13:18:42 +00003820 if (ElementSize != DelinearizedSize)
3821 scop->invalidate(DELINEARIZATION, Inst.getDebugLoc());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003822
3823 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementSize, true,
3824 AccItr->second.DelinearizedSubscripts, Sizes, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003825 return true;
Michael Krusee2bccbb2015-09-18 19:59:43 +00003826 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003827 return false;
3828}
3829
3830void ScopInfo::buildAccessSingleDim(
3831 MemAccInst Inst, Loop *L, Region *R,
3832 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3833 const InvariantLoadsSetTy &ScopRIL) {
3834 Value *Address = Inst.getPointerOperand();
3835 Value *Val = Inst.getValueOperand();
3836 Type *SizeType = Val->getType();
3837 unsigned ElementSize = DL->getTypeAllocSize(SizeType);
3838 enum MemoryAccess::AccessType Type =
3839 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3840
3841 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3842 const SCEVUnknown *BasePointer =
3843 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3844
3845 assert(BasePointer && "Could not find base pointer");
3846 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00003847
3848 // Check if the access depends on a loop contained in a non-affine subregion.
3849 bool isVariantInNonAffineLoop = false;
3850 if (BoxedLoops) {
3851 SetVector<const Loop *> Loops;
3852 findLoops(AccessFunction, Loops);
3853 for (const Loop *L : Loops)
3854 if (BoxedLoops->count(L))
3855 isVariantInNonAffineLoop = true;
3856 }
3857
Johannes Doerfert09e36972015-10-07 20:17:36 +00003858 InvariantLoadsSetTy AccessILS;
3859 bool IsAffine =
3860 !isVariantInNonAffineLoop &&
3861 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue(), &AccessILS);
3862
3863 for (LoadInst *LInst : AccessILS)
3864 if (!ScopRIL.count(LInst))
3865 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00003866
Michael Krusee2bccbb2015-09-18 19:59:43 +00003867 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
3868 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003869
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003870 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementSize, IsAffine,
3871 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00003872}
3873
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003874void ScopInfo::buildMemoryAccess(
3875 MemAccInst Inst, Loop *L, Region *R,
3876 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3877 const InvariantLoadsSetTy &ScopRIL) {
3878
3879 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
3880 return;
3881
3882 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL))
3883 return;
3884
3885 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
3886}
3887
Michael Krused868b5d2015-09-10 15:25:24 +00003888void ScopInfo::buildAccessFunctions(Region &R, Region &SR) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003889
3890 if (SD->isNonAffineSubRegion(&SR, &R)) {
3891 for (BasicBlock *BB : SR.blocks())
3892 buildAccessFunctions(R, *BB, &SR);
3893 return;
3894 }
3895
3896 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
3897 if (I->isSubRegion())
3898 buildAccessFunctions(R, *I->getNodeAs<Region>());
3899 else
3900 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>());
3901}
3902
Johannes Doerferta8781032016-02-02 14:14:40 +00003903void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00003904
Johannes Doerferta8781032016-02-02 14:14:40 +00003905 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00003906 scop->addScopStmt(nullptr, &SR);
3907 return;
3908 }
3909
3910 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
3911 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00003912 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00003913 else
3914 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
3915}
3916
Michael Krused868b5d2015-09-10 15:25:24 +00003917void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
3918 Region *NonAffineSubRegion,
3919 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00003920 // We do not build access functions for error blocks, as they may contain
3921 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00003922 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00003923 return;
3924
Michael Kruse7bf39442015-09-10 12:46:52 +00003925 Loop *L = LI->getLoopFor(&BB);
3926
3927 // The set of loops contained in non-affine subregions that are part of R.
3928 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
3929
Johannes Doerfert09e36972015-10-07 20:17:36 +00003930 // The set of loads that are required to be invariant.
3931 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
3932
Michael Kruse2e02d562016-02-06 09:19:40 +00003933 for (Instruction &Inst : BB) {
3934 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003935 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00003936 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003937
3938 // For the exit block we stop modeling after the last PHI node.
3939 if (!PHI && IsExitBlock)
3940 break;
3941
Johannes Doerfert09e36972015-10-07 20:17:36 +00003942 // TODO: At this point we only know that elements of ScopRIL have to be
3943 // invariant and will be hoisted for the SCoP to be processed. Though,
3944 // there might be other invariant accesses that will be hoisted and
3945 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00003946 if (auto MemInst = MemAccInst::dyn_cast(Inst))
3947 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL);
Michael Kruse7bf39442015-09-10 12:46:52 +00003948
Michael Kruse2e02d562016-02-06 09:19:40 +00003949 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00003950 continue;
3951
Michael Kruse2e02d562016-02-06 09:19:40 +00003952 if (!PHI)
3953 buildScalarDependences(&Inst);
3954 if (!IsExitBlock)
3955 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003956 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00003957}
Michael Kruse7bf39442015-09-10 12:46:52 +00003958
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003959MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
3960 MemoryAccess::AccessType Type,
3961 Value *BaseAddress, unsigned ElemBytes,
3962 bool Affine, Value *AccessValue,
3963 ArrayRef<const SCEV *> Subscripts,
3964 ArrayRef<const SCEV *> Sizes,
3965 ScopArrayInfo::MemoryKind Kind) {
Michael Krusecac948e2015-10-02 13:53:07 +00003966 ScopStmt *Stmt = scop->getStmtForBasicBlock(BB);
3967
3968 // Do not create a memory access for anything not in the SCoP. It would be
3969 // ignored anyway.
3970 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003971 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00003972
Michael Krusee2bccbb2015-09-18 19:59:43 +00003973 AccFuncSetType &AccList = AccFuncMap[BB];
Michael Krusee2bccbb2015-09-18 19:59:43 +00003974 Value *BaseAddr = BaseAddress;
3975 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
3976
Tobias Grosserf4f68702015-12-14 15:05:37 +00003977 bool isKnownMustAccess = false;
3978
3979 // Accesses in single-basic block statements are always excuted.
3980 if (Stmt->isBlockStmt())
3981 isKnownMustAccess = true;
3982
3983 if (Stmt->isRegionStmt()) {
3984 // Accesses that dominate the exit block of a non-affine region are always
3985 // executed. In non-affine regions there may exist MK_Values that do not
3986 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
3987 // only if there is at most one PHI_WRITE in the non-affine region.
3988 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
3989 isKnownMustAccess = true;
3990 }
3991
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003992 // Non-affine PHI writes do not "happen" at a particular instruction, but
3993 // after exiting the statement. Therefore they are guaranteed execute and
3994 // overwrite the old value.
3995 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
3996 isKnownMustAccess = true;
3997
Tobias Grosserf4f68702015-12-14 15:05:37 +00003998 if (!isKnownMustAccess && Type == MemoryAccess::MUST_WRITE)
Michael Krusecac948e2015-10-02 13:53:07 +00003999 Type = MemoryAccess::MAY_WRITE;
4000
Tobias Grosserf1bfd752015-11-05 20:15:37 +00004001 AccList.emplace_back(Stmt, Inst, Type, BaseAddress, ElemBytes, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004002 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004003 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004004 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004005}
4006
Michael Kruse70131d32016-01-27 17:09:17 +00004007void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Tobias Grossera535dff2015-12-13 19:59:01 +00004008 MemoryAccess::AccessType Type, Value *BaseAddress,
4009 unsigned ElemBytes, bool IsAffine,
4010 ArrayRef<const SCEV *> Subscripts,
4011 ArrayRef<const SCEV *> Sizes,
4012 Value *AccessValue) {
Michael Kruse70131d32016-01-27 17:09:17 +00004013 assert(MemAccInst.isLoad() == (Type == MemoryAccess::READ));
4014 addMemoryAccess(MemAccInst.getParent(), MemAccInst, Type, BaseAddress,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004015 ElemBytes, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004016 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004017}
Michael Kruse436db622016-01-26 13:33:10 +00004018void ScopInfo::ensureValueWrite(Instruction *Value) {
4019 ScopStmt *Stmt = scop->getStmtForBasicBlock(Value->getParent());
4020
4021 // Value not defined within this SCoP.
4022 if (!Stmt)
4023 return;
4024
4025 // Do not process further if the value is already written.
4026 if (Stmt->lookupValueWriteOf(Value))
4027 return;
4028
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004029 addMemoryAccess(Value->getParent(), Value, MemoryAccess::MUST_WRITE, Value, 1,
4030 true, Value, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004031 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004032}
Michael Krusead28e5a2016-01-26 13:33:15 +00004033void ScopInfo::ensureValueRead(Value *Value, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004034
Michael Kruse2e02d562016-02-06 09:19:40 +00004035 // There cannot be an "access" for literal constants. BasicBlock references
4036 // (jump destinations) also never change.
4037 if ((isa<Constant>(Value) && !isa<GlobalVariable>(Value)) ||
4038 isa<BasicBlock>(Value))
4039 return;
4040
Michael Krusefd463082016-01-27 22:51:56 +00004041 // If the instruction can be synthesized and the user is in the region we do
4042 // not need to add a value dependences.
4043 Region &ScopRegion = scop->getRegion();
4044 if (canSynthesize(Value, LI, SE, &ScopRegion))
4045 return;
4046
Michael Kruse2e02d562016-02-06 09:19:40 +00004047 // Do not build scalar dependences for required invariant loads as we will
4048 // hoist them later on anyway or drop the SCoP if we cannot.
4049 auto ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
4050 if (ScopRIL->count(dyn_cast<LoadInst>(Value)))
4051 return;
4052
4053 // Determine the ScopStmt containing the value's definition and use. There is
4054 // no defining ScopStmt if the value is a function argument, a global value,
4055 // or defined outside the SCoP.
4056 Instruction *ValueInst = dyn_cast<Instruction>(Value);
4057 ScopStmt *ValueStmt =
4058 ValueInst ? scop->getStmtForBasicBlock(ValueInst->getParent()) : nullptr;
4059
Michael Krusead28e5a2016-01-26 13:33:15 +00004060 ScopStmt *UserStmt = scop->getStmtForBasicBlock(UserBB);
4061
4062 // We do not model uses outside the scop.
4063 if (!UserStmt)
4064 return;
4065
Michael Kruse2e02d562016-02-06 09:19:40 +00004066 // Add MemoryAccess for invariant values only if requested.
4067 if (!ModelReadOnlyScalars && !ValueStmt)
4068 return;
4069
4070 // Ignore use-def chains within the same ScopStmt.
4071 if (ValueStmt == UserStmt)
4072 return;
4073
Michael Krusead28e5a2016-01-26 13:33:15 +00004074 // Do not create another MemoryAccess for reloading the value if one already
4075 // exists.
4076 if (UserStmt->lookupValueReadOf(Value))
4077 return;
4078
4079 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, Value, 1, true, Value,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004080 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004081 ScopArrayInfo::MK_Value);
Michael Kruse2e02d562016-02-06 09:19:40 +00004082 if (ValueInst)
4083 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004084}
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004085void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4086 Value *IncomingValue, bool IsExitBlock) {
4087 ScopStmt *IncomingStmt = scop->getStmtForBasicBlock(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004088 if (!IncomingStmt)
4089 return;
4090
4091 // Take care for the incoming value being available in the incoming block.
4092 // This must be done before the check for multiple PHI writes because multiple
4093 // exiting edges from subregion each can be the effective written value of the
4094 // subregion. As such, all of them must be made available in the subregion
4095 // statement.
4096 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004097
4098 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4099 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4100 assert(Acc->getAccessInstruction() == PHI);
4101 Acc->addIncoming(IncomingBlock, IncomingValue);
4102 return;
4103 }
4104
4105 MemoryAccess *Acc = addMemoryAccess(
4106 IncomingStmt->isBlockStmt() ? IncomingBlock
4107 : IncomingStmt->getRegion()->getEntry(),
4108 PHI, MemoryAccess::MUST_WRITE, PHI, 1, true, PHI,
4109 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
4110 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4111 assert(Acc);
4112 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004113}
4114void ScopInfo::addPHIReadAccess(PHINode *PHI) {
4115 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI, 1, true, PHI,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004116 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004117 ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004118}
4119
Michael Krusedaf66942015-12-13 22:10:37 +00004120void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004121 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Krusedaf66942015-12-13 22:10:37 +00004122 scop = new Scop(R, AccFuncMap, *SD, *SE, *DT, *LI, ctx, MaxLoopDepth);
Michael Kruse7bf39442015-09-10 12:46:52 +00004123
Johannes Doerferta8781032016-02-02 14:14:40 +00004124 buildStmts(R, R);
Michael Kruse7bf39442015-09-10 12:46:52 +00004125 buildAccessFunctions(R, R);
4126
4127 // In case the region does not have an exiting block we will later (during
4128 // code generation) split the exit block. This will move potential PHI nodes
4129 // from the current exit block into the new region exiting block. Hence, PHI
4130 // nodes that are at this point not part of the region will be.
4131 // To handle these PHI nodes later we will now model their operands as scalar
4132 // accesses. Note that we do not model anything in the exit block if we have
4133 // an exiting block in the region, as there will not be any splitting later.
4134 if (!R.getExitingBlock())
4135 buildAccessFunctions(R, *R.getExit(), nullptr, /* IsExitBlock */ true);
4136
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004137 scop->init(*AA, AC);
Michael Kruse7bf39442015-09-10 12:46:52 +00004138}
4139
Michael Krused868b5d2015-09-10 15:25:24 +00004140void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004141 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004142 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004143 return;
4144 }
4145
Michael Kruse9d080092015-09-11 21:41:48 +00004146 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004147}
4148
Michael Krused868b5d2015-09-10 15:25:24 +00004149void ScopInfo::clear() {
Michael Kruse7bf39442015-09-10 12:46:52 +00004150 AccFuncMap.clear();
Michael Krused868b5d2015-09-10 15:25:24 +00004151 if (scop) {
4152 delete scop;
4153 scop = 0;
4154 }
Michael Kruse7bf39442015-09-10 12:46:52 +00004155}
4156
4157//===----------------------------------------------------------------------===//
Michael Kruse9d080092015-09-11 21:41:48 +00004158ScopInfo::ScopInfo() : RegionPass(ID), scop(0) {
Tobias Grosserb76f38532011-08-20 11:11:25 +00004159 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00004160 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00004161}
4162
4163ScopInfo::~ScopInfo() {
4164 clear();
4165 isl_ctx_free(ctx);
4166}
4167
Tobias Grosser75805372011-04-29 06:27:02 +00004168void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004169 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004170 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004171 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004172 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4173 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004174 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004175 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004176 AU.setPreservesAll();
4177}
4178
4179bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004180 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004181
Michael Krused868b5d2015-09-10 15:25:24 +00004182 if (!SD->isMaxRegionInScop(*R))
4183 return false;
4184
4185 Function *F = R->getEntry()->getParent();
4186 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4187 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4188 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004189 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004190 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004191 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004192
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004193 DebugLoc Beg, End;
4194 getDebugLocations(R, Beg, End);
4195 std::string Msg = "SCoP begins here.";
4196 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4197
Michael Krusedaf66942015-12-13 22:10:37 +00004198 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004199
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004200 DEBUG(scop->print(dbgs()));
4201
Michael Kruseafe06702015-10-02 16:33:27 +00004202 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004203 Msg = "SCoP ends here but was dismissed.";
Johannes Doerfert43788c52015-08-20 05:58:56 +00004204 delete scop;
4205 scop = nullptr;
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004206 } else {
4207 Msg = "SCoP ends here.";
4208 ++ScopFound;
4209 if (scop->getMaxLoopDepth() > 0)
4210 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004211 }
4212
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004213 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4214
Tobias Grosser75805372011-04-29 06:27:02 +00004215 return false;
4216}
4217
4218char ScopInfo::ID = 0;
4219
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004220Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4221
Tobias Grosser73600b82011-10-08 00:30:40 +00004222INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4223 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004224 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004225INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004226INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004227INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004228INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004229INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004230INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004231INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004232INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4233 "Polly - Create polyhedral description of Scops", false,
4234 false)