blob: cbcaa12d32917ffd3608dc02da3f669a1dc889b2 [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 Grosser75805372011-04-29 06:27:02 +000020#include "polly/LinkAllPasses.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000021#include "polly/CodeGen/BlockGenerators.h"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000022#include "polly/Options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000023#include "polly/ScopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000024#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000025#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000026#include "polly/Support/ScopHelper.h"
Tobias 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"
Tobias Grosserba0d0922015-05-09 09:13:42 +000034#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000035#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000036#include "llvm/Analysis/RegionIterator.h"
37#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Tobias Grosser75805372011-04-29 06:27:02 +000038#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000039#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000040#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000041#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000042#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000043#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000044#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000045#include "isl/schedule.h"
46#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000047#include "isl/set.h"
48#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000049#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000050#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000051#include <sstream>
52#include <string>
53#include <vector>
54
55using namespace llvm;
56using namespace polly;
57
Chandler Carruth95fef942014-04-22 03:30:19 +000058#define DEBUG_TYPE "polly-scops"
59
Tobias Grosser74394f02013-01-14 22:40:23 +000060STATISTIC(ScopFound, "Number of valid Scops");
61STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000062
Michael Kruse7bf39442015-09-10 12:46:52 +000063static cl::opt<bool> ModelReadOnlyScalars(
64 "polly-analyze-read-only-scalars",
65 cl::desc("Model read-only scalar values in the scop description"),
66 cl::Hidden, cl::ZeroOrMore, cl::init(true), cl::cat(PollyCategory));
67
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000068// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000069// operations can overflow easily. Additive reductions and bit operations
70// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000071static cl::opt<bool> DisableMultiplicativeReductions(
72 "polly-disable-multiplicative-reductions",
73 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
74 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000075
Johannes Doerfert9143d672014-09-27 11:02:39 +000076static cl::opt<unsigned> RunTimeChecksMaxParameters(
77 "polly-rtc-max-parameters",
78 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
79 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
80
Tobias Grosser71500722015-03-28 15:11:14 +000081static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
82 "polly-rtc-max-arrays-per-group",
83 cl::desc("The maximal number of arrays to compare in each alias group."),
84 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Tobias Grosser8a9c2352015-08-16 10:19:29 +000085static cl::opt<std::string> UserContextStr(
86 "polly-context", cl::value_desc("isl parameter set"),
87 cl::desc("Provide additional constraints on the context parameters"),
88 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +000089
Tobias Grosserd83b8a82015-08-20 19:08:11 +000090static cl::opt<bool> DetectReductions("polly-detect-reductions",
91 cl::desc("Detect and exploit reductions"),
92 cl::Hidden, cl::ZeroOrMore,
93 cl::init(true), cl::cat(PollyCategory));
94
Michael Kruse7bf39442015-09-10 12:46:52 +000095//===----------------------------------------------------------------------===//
96/// Helper Classes
97
98void Comparison::print(raw_ostream &OS) const {
99 // Not yet implemented.
100}
101
Michael Kruse046dde42015-08-10 13:01:57 +0000102// Create a sequence of two schedules. Either argument may be null and is
103// interpreted as the empty schedule. Can also return null if both schedules are
104// empty.
105static __isl_give isl_schedule *
106combineInSequence(__isl_take isl_schedule *Prev,
107 __isl_take isl_schedule *Succ) {
108 if (!Prev)
109 return Succ;
110 if (!Succ)
111 return Prev;
112
113 return isl_schedule_sequence(Prev, Succ);
114}
115
Johannes Doerferte7044942015-02-24 11:58:30 +0000116static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
117 const ConstantRange &Range,
118 int dim,
119 enum isl_dim_type type) {
120 isl_val *V;
121 isl_ctx *ctx = isl_set_get_ctx(S);
122
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000123 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
124 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000125 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000126 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
127
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000128 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000129 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000130 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000131 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000132 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
133
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000134 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000135 return isl_set_union(SLB, SUB);
136 else
137 return isl_set_intersect(SLB, SUB);
138}
139
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000140static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
141 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
142 if (!BasePtrLI)
143 return nullptr;
144
145 if (!S->getRegion().contains(BasePtrLI))
146 return nullptr;
147
148 ScalarEvolution &SE = *S->getSE();
149
150 auto *OriginBaseSCEV =
151 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
152 if (!OriginBaseSCEV)
153 return nullptr;
154
155 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
156 if (!OriginBaseSCEVUnknown)
157 return nullptr;
158
159 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue());
160}
161
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000162ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000163 ArrayRef<const SCEV *> Sizes, bool IsPHI, Scop *S)
164 : BasePtr(BasePtr), ElementType(ElementType), IsPHI(IsPHI), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000165 std::string BasePtrName =
166 getIslCompatibleName("MemRef_", BasePtr, IsPHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000167 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000168
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000169 updateSizes(Sizes);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000170 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
171 if (BasePtrOriginSAI)
172 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000173}
174
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000175__isl_give isl_space *ScopArrayInfo::getSpace() const {
176 auto Space =
177 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
178 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
179 return Space;
180}
181
182void ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes) {
183#ifndef NDEBUG
184 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
185 int ExtraDimsNew = NewSizes.size() - SharedDims;
186 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
187 for (int i = 0; i < SharedDims; i++) {
188 assert(NewSizes[i + ExtraDimsNew] == DimensionSizes[i + ExtraDimsOld] &&
189 "Array update with non-matching dimension sizes");
190 }
191#endif
192
193 DimensionSizes.clear();
194 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
195 NewSizes.end());
196 for (isl_pw_aff *Size : DimensionSizesPw)
197 isl_pw_aff_free(Size);
198 DimensionSizesPw.clear();
199 for (const SCEV *Expr : DimensionSizes) {
200 isl_pw_aff *Size = S.getPwAff(Expr);
201 DimensionSizesPw.push_back(Size);
202 }
203}
204
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000205ScopArrayInfo::~ScopArrayInfo() {
206 isl_id_free(Id);
207 for (isl_pw_aff *Size : DimensionSizesPw)
208 isl_pw_aff_free(Size);
209}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000210
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000211std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
212
213int ScopArrayInfo::getElemSizeInBytes() const {
214 return ElementType->getPrimitiveSizeInBits() / 8;
215}
216
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000217isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
218
219void ScopArrayInfo::dump() const { print(errs()); }
220
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000221void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000222 OS.indent(8) << *getElementType() << " " << getName() << "[*]";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000223 for (unsigned u = 0; u < getNumberOfDimensions(); u++) {
224 OS << "[";
225
226 if (SizeAsPwAff)
227 OS << " " << DimensionSizesPw[u] << " ";
228 else
229 OS << *DimensionSizes[u];
230
231 OS << "]";
232 }
233
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000234 if (BasePtrOriginSAI)
235 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
236
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000237 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000238}
239
240const ScopArrayInfo *
241ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
242 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
243 assert(Id && "Output dimension didn't have an ID");
244 return getFromId(Id);
245}
246
247const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
248 void *User = isl_id_get_user(Id);
249 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
250 isl_id_free(Id);
251 return SAI;
252}
253
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000254void MemoryAccess::updateDimensionality() {
255 auto ArraySpace = getScopArrayInfo()->getSpace();
256 auto AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
257
258 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
259 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
260 auto DimsMissing = DimsArray - DimsAccess;
261
262 auto Map = isl_map_from_domain_and_range(isl_set_universe(AccessSpace),
263 isl_set_universe(ArraySpace));
264
265 for (unsigned i = 0; i < DimsMissing; i++)
266 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
267
268 for (unsigned i = DimsMissing; i < DimsArray; i++)
269 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
270
271 AccessRelation = isl_map_apply_range(AccessRelation, Map);
272}
273
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000274const std::string
275MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
276 switch (RT) {
277 case MemoryAccess::RT_NONE:
278 llvm_unreachable("Requested a reduction operator string for a memory "
279 "access which isn't a reduction");
280 case MemoryAccess::RT_ADD:
281 return "+";
282 case MemoryAccess::RT_MUL:
283 return "*";
284 case MemoryAccess::RT_BOR:
285 return "|";
286 case MemoryAccess::RT_BXOR:
287 return "^";
288 case MemoryAccess::RT_BAND:
289 return "&";
290 }
291 llvm_unreachable("Unknown reduction type");
292 return "";
293}
294
Johannes Doerfertf6183392014-07-01 20:52:51 +0000295/// @brief Return the reduction type for a given binary operator
296static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
297 const Instruction *Load) {
298 if (!BinOp)
299 return MemoryAccess::RT_NONE;
300 switch (BinOp->getOpcode()) {
301 case Instruction::FAdd:
302 if (!BinOp->hasUnsafeAlgebra())
303 return MemoryAccess::RT_NONE;
304 // Fall through
305 case Instruction::Add:
306 return MemoryAccess::RT_ADD;
307 case Instruction::Or:
308 return MemoryAccess::RT_BOR;
309 case Instruction::Xor:
310 return MemoryAccess::RT_BXOR;
311 case Instruction::And:
312 return MemoryAccess::RT_BAND;
313 case Instruction::FMul:
314 if (!BinOp->hasUnsafeAlgebra())
315 return MemoryAccess::RT_NONE;
316 // Fall through
317 case Instruction::Mul:
318 if (DisableMultiplicativeReductions)
319 return MemoryAccess::RT_NONE;
320 return MemoryAccess::RT_MUL;
321 default:
322 return MemoryAccess::RT_NONE;
323 }
324}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000325
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000326/// @brief Derive the individual index expressions from a GEP instruction
327///
328/// This function optimistically assumes the GEP references into a fixed size
329/// array. If this is actually true, this function returns a list of array
330/// subscript expressions as SCEV as well as a list of integers describing
331/// the size of the individual array dimensions. Both lists have either equal
332/// length of the size list is one element shorter in case there is no known
333/// size available for the outermost array dimension.
334///
335/// @param GEP The GetElementPtr instruction to analyze.
336///
337/// @return A tuple with the subscript expressions and the dimension sizes.
338static std::tuple<std::vector<const SCEV *>, std::vector<int>>
339getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
340 std::vector<const SCEV *> Subscripts;
341 std::vector<int> Sizes;
342
343 Type *Ty = GEP->getPointerOperandType();
344
345 bool DroppedFirstDim = false;
346
Michael Kruse26ed65e2015-09-24 17:32:49 +0000347 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000348
349 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
350
351 if (i == 1) {
352 if (auto PtrTy = dyn_cast<PointerType>(Ty)) {
353 Ty = PtrTy->getElementType();
354 } else if (auto ArrayTy = dyn_cast<ArrayType>(Ty)) {
355 Ty = ArrayTy->getElementType();
356 } else {
357 Subscripts.clear();
358 Sizes.clear();
359 break;
360 }
361 if (auto Const = dyn_cast<SCEVConstant>(Expr))
362 if (Const->getValue()->isZero()) {
363 DroppedFirstDim = true;
364 continue;
365 }
366 Subscripts.push_back(Expr);
367 continue;
368 }
369
370 auto ArrayTy = dyn_cast<ArrayType>(Ty);
371 if (!ArrayTy) {
372 Subscripts.clear();
373 Sizes.clear();
374 break;
375 }
376
377 Subscripts.push_back(Expr);
378 if (!(DroppedFirstDim && i == 2))
379 Sizes.push_back(ArrayTy->getNumElements());
380
381 Ty = ArrayTy->getElementType();
382 }
383
384 return std::make_tuple(Subscripts, Sizes);
385}
386
Tobias Grosser75805372011-04-29 06:27:02 +0000387MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000388 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000389 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000390 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000391}
392
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000393const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
394 isl_id *ArrayId = getArrayId();
395 void *User = isl_id_get_user(ArrayId);
396 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
397 isl_id_free(ArrayId);
398 return SAI;
399}
400
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000401__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000402 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
403}
404
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000405__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
406 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000407 isl_map *Schedule, *ScheduledAccRel;
408 isl_union_set *UDomain;
409
410 UDomain = isl_union_set_from_set(getStatement()->getDomain());
411 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
412 Schedule = isl_map_from_union_map(USchedule);
413 ScheduledAccRel = isl_map_apply_domain(getAccessRelation(), Schedule);
414 return isl_pw_multi_aff_from_map(ScheduledAccRel);
415}
416
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000417__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000418 return isl_map_copy(AccessRelation);
419}
420
Johannes Doerferta99130f2014-10-13 12:58:03 +0000421std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000422 return stringFromIslObj(AccessRelation);
423}
424
Johannes Doerferta99130f2014-10-13 12:58:03 +0000425__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000426 return isl_map_get_space(AccessRelation);
427}
428
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000429__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000430 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000431}
432
Tobias Grosser6f730082015-09-05 07:46:47 +0000433std::string MemoryAccess::getNewAccessRelationStr() const {
434 return stringFromIslObj(NewAccessRelation);
435}
436
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000437__isl_give isl_basic_map *
438MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000439 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000440 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000441
Tobias Grosser084d8f72012-05-29 09:29:44 +0000442 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000443 isl_basic_set_universe(Statement->getDomainSpace()),
444 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000445}
446
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000447// Formalize no out-of-bound access assumption
448//
449// When delinearizing array accesses we optimistically assume that the
450// delinearized accesses do not access out of bound locations (the subscript
451// expression of each array evaluates for each statement instance that is
452// executed to a value that is larger than zero and strictly smaller than the
453// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000454// dimension for which we do not need to assume any upper bound. At this point
455// we formalize this assumption to ensure that at code generation time the
456// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000457//
458// To find the set of constraints necessary to avoid out of bound accesses, we
459// first build the set of data locations that are not within array bounds. We
460// then apply the reverse access relation to obtain the set of iterations that
461// may contain invalid accesses and reduce this set of iterations to the ones
462// that are actually executed by intersecting them with the domain of the
463// statement. If we now project out all loop dimensions, we obtain a set of
464// parameters that may cause statement instances to be executed that may
465// possibly yield out of bound memory accesses. The complement of these
466// constraints is the set of constraints that needs to be assumed to ensure such
467// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000468void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000469 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000470 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Michael Krusee2bccbb2015-09-18 19:59:43 +0000471 for (int i = 1, Size = Subscripts.size(); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000472 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
473 isl_pw_aff *Var =
474 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
475 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
476
477 isl_set *DimOutside;
478
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000479 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Michael Krusee2bccbb2015-09-18 19:59:43 +0000480 isl_pw_aff *SizeE = Statement->getPwAff(Sizes[i - 1]);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000481
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000482 SizeE = isl_pw_aff_drop_dims(SizeE, isl_dim_in, 0,
483 Statement->getNumIterators());
484 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
485 isl_space_dim(Space, isl_dim_set));
486 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
487 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000488
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000489 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000490
491 Outside = isl_set_union(Outside, DimOutside);
492 }
493
494 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
495 Outside = isl_set_intersect(Outside, Statement->getDomain());
496 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000497
498 // Remove divs to avoid the construction of overly complicated assumptions.
499 // Doing so increases the set of parameter combinations that are assumed to
500 // not appear. This is always save, but may make the resulting run-time check
501 // bail out more often than strictly necessary.
502 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000503 Outside = isl_set_complement(Outside);
504 Statement->getParent()->addAssumption(Outside);
505 isl_space_free(Space);
506}
507
Johannes Doerferte7044942015-02-24 11:58:30 +0000508void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
509 ScalarEvolution *SE = Statement->getParent()->getSE();
510
511 Value *Ptr = getPointerOperand(*getAccessInstruction());
512 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
513 return;
514
515 auto *PtrSCEV = SE->getSCEV(Ptr);
516 if (isa<SCEVCouldNotCompute>(PtrSCEV))
517 return;
518
519 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
520 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
521 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
522
523 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
524 if (Range.isFullSet())
525 return;
526
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000527 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000528 unsigned BW = Range.getBitWidth();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000529 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
530 const auto UB = isWrapping ? Range.getUpper() : Range.getSignedMax();
531
532 auto Min = LB.sdiv(APInt(BW, ElementSize));
533 auto Max = (UB - APInt(BW, 1)).sdiv(APInt(BW, ElementSize));
Johannes Doerferte7044942015-02-24 11:58:30 +0000534
535 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
536 AccessRange =
537 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
538 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
539}
540
Michael Krusee2bccbb2015-09-18 19:59:43 +0000541__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000542 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000543 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000544
545 for (int i = Size - 2; i >= 0; --i) {
546 isl_space *Space;
547 isl_map *MapOne, *MapTwo;
Michael Krusee2bccbb2015-09-18 19:59:43 +0000548 isl_pw_aff *DimSize = Statement->getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000549
550 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
551 isl_pw_aff_free(DimSize);
552 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
553
554 Space = isl_map_get_space(AccessRelation);
555 Space = isl_space_map_from_set(isl_space_range(Space));
556 Space = isl_space_align_params(Space, SpaceSize);
557
558 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
559 isl_id_free(ParamId);
560
561 MapOne = isl_map_universe(isl_space_copy(Space));
562 for (int j = 0; j < Size; ++j)
563 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
564 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
565
566 MapTwo = isl_map_universe(isl_space_copy(Space));
567 for (int j = 0; j < Size; ++j)
568 if (j < i || j > i + 1)
569 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
570
571 isl_local_space *LS = isl_local_space_from_space(Space);
572 isl_constraint *C;
573 C = isl_equality_alloc(isl_local_space_copy(LS));
574 C = isl_constraint_set_constant_si(C, -1);
575 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
576 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
577 MapTwo = isl_map_add_constraint(MapTwo, C);
578 C = isl_equality_alloc(LS);
579 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
580 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
581 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
582 MapTwo = isl_map_add_constraint(MapTwo, C);
583 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
584
585 MapOne = isl_map_union(MapOne, MapTwo);
586 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
587 }
588 return AccessRelation;
589}
590
Michael Krusee2bccbb2015-09-18 19:59:43 +0000591void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
592 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000593
Michael Krusee2bccbb2015-09-18 19:59:43 +0000594 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000595 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000596
Michael Krusee2bccbb2015-09-18 19:59:43 +0000597 if (!isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000598 // We overapproximate non-affine accesses with a possible access to the
599 // whole array. For read accesses it does not make a difference, if an
600 // access must or may happen. However, for write accesses it is important to
601 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser04d6ae62013-06-23 06:04:54 +0000602 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000603 AccessRelation =
604 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Johannes Doerferte7044942015-02-24 11:58:30 +0000605
Michael Krusee2bccbb2015-09-18 19:59:43 +0000606 computeBoundsOnAccessRelation(getElemSizeInBytes());
Tobias Grossera1879642011-12-20 10:43:14 +0000607 return;
608 }
609
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000610 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000611 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000612
Michael Krusee2bccbb2015-09-18 19:59:43 +0000613 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
614 isl_pw_aff *Affine = Statement->getPwAff(Subscripts[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000615
Sebastian Pop422e33f2014-06-03 18:16:31 +0000616 if (Size == 1) {
617 // For the non delinearized arrays, divide the access function of the last
618 // subscript by the size of the elements in the array.
Sebastian Pop18016682014-04-08 21:20:44 +0000619 //
620 // A stride one array access in C expressed as A[i] is expressed in
621 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
622 // two subsequent values of 'i' index two values that are stored next to
623 // each other in memory. By this division we make this characteristic
624 // obvious again.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000625 isl_val *v = isl_val_int_from_si(Ctx, getElemSizeInBytes());
Sebastian Pop18016682014-04-08 21:20:44 +0000626 Affine = isl_pw_aff_scale_down_val(Affine, v);
627 }
628
629 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
630
Tobias Grosser79baa212014-04-10 08:38:02 +0000631 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000632 }
633
Michael Krusee2bccbb2015-09-18 19:59:43 +0000634 if (Sizes.size() > 1 && !isa<SCEVConstant>(Sizes[0]))
635 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000636
Tobias Grosser79baa212014-04-10 08:38:02 +0000637 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000638 AccessRelation = isl_map_set_tuple_id(
639 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000640 AccessRelation =
641 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
642
Michael Krusee2bccbb2015-09-18 19:59:43 +0000643 assumeNoOutOfBound();
Tobias Grosseraa660a92015-03-30 00:07:50 +0000644 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000645 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000646}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000647
Michael Krusecac948e2015-10-02 13:53:07 +0000648MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
649 __isl_take isl_id *Id, AccessType Type,
650 Value *BaseAddress, unsigned ElemBytes, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000651 ArrayRef<const SCEV *> Subscripts,
652 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Michael Kruse8d0b7342015-09-25 21:21:00 +0000653 AccessOrigin Origin, StringRef BaseName)
Michael Krusecac948e2015-10-02 13:53:07 +0000654 : Id(Id), Origin(Origin), AccType(Type), RedType(RT_NONE), Statement(Stmt),
655 BaseAddr(BaseAddress), BaseName(BaseName), ElemBytes(ElemBytes),
656 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
657 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000658 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
659 NewAccessRelation(nullptr) {}
660
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000661void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000662 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000663 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000664}
665
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000666const std::string MemoryAccess::getReductionOperatorStr() const {
667 return MemoryAccess::getReductionOperatorStr(getReductionType());
668}
669
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000670__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
671
Johannes Doerfertf6183392014-07-01 20:52:51 +0000672raw_ostream &polly::operator<<(raw_ostream &OS,
673 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000674 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000675 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000676 else
677 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000678 return OS;
679}
680
Tobias Grosser75805372011-04-29 06:27:02 +0000681void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000682 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000683 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000684 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000685 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000686 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000687 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000688 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000689 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000690 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000691 break;
692 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000693 OS << "[Reduction Type: " << getReductionType() << "] ";
Michael Kruse8d0b7342015-09-25 21:21:00 +0000694 OS << "[Scalar: " << isImplicit() << "]\n";
Johannes Doerferta99130f2014-10-13 12:58:03 +0000695 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000696 if (hasNewAccessRelation())
697 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000698}
699
Tobias Grosser74394f02013-01-14 22:40:23 +0000700void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000701
702// Create a map in the size of the provided set domain, that maps from the
703// one element of the provided set domain to another element of the provided
704// set domain.
705// The mapping is limited to all points that are equal in all but the last
706// dimension and for which the last dimension of the input is strict smaller
707// than the last dimension of the output.
708//
709// getEqualAndLarger(set[i0, i1, ..., iX]):
710//
711// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
712// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
713//
Tobias Grosserf5338802011-10-06 00:03:35 +0000714static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000715 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000716 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000717 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000718
719 // Set all but the last dimension to be equal for the input and output
720 //
721 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
722 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000723 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000724 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000725
726 // Set the last dimension of the input to be strict smaller than the
727 // last dimension of the output.
728 //
729 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000730 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
731 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000732 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000733}
734
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000735__isl_give isl_set *
736MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000737 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000738 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000739 isl_space *Space = isl_space_range(isl_map_get_space(S));
740 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000741
Sebastian Popa00a0292012-12-18 07:46:06 +0000742 S = isl_map_reverse(S);
743 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000744
Sebastian Popa00a0292012-12-18 07:46:06 +0000745 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
746 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
747 NextScatt = isl_map_apply_domain(NextScatt, S);
748 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000749
Sebastian Popa00a0292012-12-18 07:46:06 +0000750 isl_set *Deltas = isl_map_deltas(NextScatt);
751 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000752}
753
Sebastian Popa00a0292012-12-18 07:46:06 +0000754bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000755 int StrideWidth) const {
756 isl_set *Stride, *StrideX;
757 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000758
Sebastian Popa00a0292012-12-18 07:46:06 +0000759 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000760 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000761 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
762 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
763 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
764 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000765 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000766
Tobias Grosser28dd4862012-01-24 16:42:16 +0000767 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000768 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000769
Tobias Grosser28dd4862012-01-24 16:42:16 +0000770 return IsStrideX;
771}
772
Sebastian Popa00a0292012-12-18 07:46:06 +0000773bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
774 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000775}
776
Sebastian Popa00a0292012-12-18 07:46:06 +0000777bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
778 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000779}
780
Tobias Grosser166c4222015-09-05 07:46:40 +0000781void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
782 isl_map_free(NewAccessRelation);
783 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000784}
Tobias Grosser75805372011-04-29 06:27:02 +0000785
786//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000787
Tobias Grosser808cd692015-07-14 09:33:13 +0000788isl_map *ScopStmt::getSchedule() const {
789 isl_set *Domain = getDomain();
790 if (isl_set_is_empty(Domain)) {
791 isl_set_free(Domain);
792 return isl_map_from_aff(
793 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
794 }
795 auto *Schedule = getParent()->getSchedule();
796 Schedule = isl_union_map_intersect_domain(
797 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
798 if (isl_union_map_is_empty(Schedule)) {
799 isl_set_free(Domain);
800 isl_union_map_free(Schedule);
801 return isl_map_from_aff(
802 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
803 }
804 auto *M = isl_map_from_union_map(Schedule);
805 M = isl_map_coalesce(M);
806 M = isl_map_gist_domain(M, Domain);
807 M = isl_map_coalesce(M);
808 return M;
809}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000810
Johannes Doerfert574182d2015-08-12 10:19:50 +0000811__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Johannes Doerfertcef616f2015-09-15 22:49:04 +0000812 return getParent()->getPwAff(E, isBlockStmt() ? getBasicBlock()
813 : getRegion()->getEntry());
Johannes Doerfert574182d2015-08-12 10:19:50 +0000814}
815
Tobias Grosser37eb4222014-02-20 21:43:54 +0000816void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
817 assert(isl_set_is_subset(NewDomain, Domain) &&
818 "New domain is not a subset of old domain!");
819 isl_set_free(Domain);
820 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000821}
822
Michael Krusecac948e2015-10-02 13:53:07 +0000823void ScopStmt::buildAccessRelations() {
824 for (MemoryAccess *Access : MemAccs) {
825 Type *ElementType = Access->getAccessValue()->getType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000826
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000827 const ScopArrayInfo *SAI = getParent()->getOrCreateScopArrayInfo(
Michael Krusecac948e2015-10-02 13:53:07 +0000828 Access->getBaseAddr(), ElementType, Access->Sizes, Access->isPHI());
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000829
Michael Krusecac948e2015-10-02 13:53:07 +0000830 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +0000831 }
832}
833
Michael Krusecac948e2015-10-02 13:53:07 +0000834void ScopStmt::addAccess(MemoryAccess *Access) {
835 Instruction *AccessInst = Access->getAccessInstruction();
836
837 MemoryAccessList *&MAL = InstructionToAccess[AccessInst];
838 if (!MAL)
839 MAL = new MemoryAccessList();
840 MAL->emplace_front(Access);
841 MemAccs.push_back(MAL->front());
842}
843
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000844void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000845 for (MemoryAccess *MA : *this)
846 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000847
848 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000849}
850
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000851/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
852static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
853 void *User) {
854 isl_set **BoundedParts = static_cast<isl_set **>(User);
855 if (isl_basic_set_is_bounded(BSet))
856 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
857 else
858 isl_basic_set_free(BSet);
859 return isl_stat_ok;
860}
861
862/// @brief Return the bounded parts of @p S.
863static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
864 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
865 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
866 isl_set_free(S);
867 return BoundedParts;
868}
869
870/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
871///
872/// @returns A separation of @p S into first an unbounded then a bounded subset,
873/// both with regards to the dimension @p Dim.
874static std::pair<__isl_give isl_set *, __isl_give isl_set *>
875partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
876
877 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000878 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000879
880 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000881 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000882
883 // Remove dimensions that are greater than Dim as they are not interesting.
884 assert(NumDimsS >= Dim + 1);
885 OnlyDimS =
886 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
887
888 // Create artificial parametric upper bounds for dimensions smaller than Dim
889 // as we are not interested in them.
890 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
891 for (unsigned u = 0; u < Dim; u++) {
892 isl_constraint *C = isl_inequality_alloc(
893 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
894 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
895 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
896 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
897 }
898
899 // Collect all bounded parts of OnlyDimS.
900 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
901
902 // Create the dimensions greater than Dim again.
903 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
904 NumDimsS - Dim - 1);
905
906 // Remove the artificial upper bound parameters again.
907 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
908
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000909 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000910 return std::make_pair(UnboundedParts, BoundedParts);
911}
912
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000913/// @brief Set the dimension Ids from @p From in @p To.
914static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
915 __isl_take isl_set *To) {
916 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
917 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
918 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
919 }
920 return To;
921}
922
923/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000924static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000925 __isl_take isl_pw_aff *L,
926 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +0000927 switch (Pred) {
928 case ICmpInst::ICMP_EQ:
929 return isl_pw_aff_eq_set(L, R);
930 case ICmpInst::ICMP_NE:
931 return isl_pw_aff_ne_set(L, R);
932 case ICmpInst::ICMP_SLT:
933 return isl_pw_aff_lt_set(L, R);
934 case ICmpInst::ICMP_SLE:
935 return isl_pw_aff_le_set(L, R);
936 case ICmpInst::ICMP_SGT:
937 return isl_pw_aff_gt_set(L, R);
938 case ICmpInst::ICMP_SGE:
939 return isl_pw_aff_ge_set(L, R);
940 case ICmpInst::ICMP_ULT:
941 return isl_pw_aff_lt_set(L, R);
942 case ICmpInst::ICMP_UGT:
943 return isl_pw_aff_gt_set(L, R);
944 case ICmpInst::ICMP_ULE:
945 return isl_pw_aff_le_set(L, R);
946 case ICmpInst::ICMP_UGE:
947 return isl_pw_aff_ge_set(L, R);
948 default:
949 llvm_unreachable("Non integer predicate not supported");
950 }
951}
952
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000953/// @brief Create the conditions under which @p L @p Pred @p R is true.
954///
955/// Helper function that will make sure the dimensions of the result have the
956/// same isl_id's as the @p Domain.
957static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
958 __isl_take isl_pw_aff *L,
959 __isl_take isl_pw_aff *R,
960 __isl_keep isl_set *Domain) {
961 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
962 return setDimensionIds(Domain, ConsequenceCondSet);
963}
964
965/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000966///
967/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000968/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
969/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000970static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000971buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +0000972 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
973
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000974 Value *Condition = getConditionFromTerminator(SI);
975 assert(Condition && "No condition for switch");
976
977 ScalarEvolution &SE = *S.getSE();
978 BasicBlock *BB = SI->getParent();
979 isl_pw_aff *LHS, *RHS;
980 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
981
982 unsigned NumSuccessors = SI->getNumSuccessors();
983 ConditionSets.resize(NumSuccessors);
984 for (auto &Case : SI->cases()) {
985 unsigned Idx = Case.getSuccessorIndex();
986 ConstantInt *CaseValue = Case.getCaseValue();
987
988 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
989 isl_set *CaseConditionSet =
990 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
991 ConditionSets[Idx] = isl_set_coalesce(
992 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
993 }
994
995 assert(ConditionSets[0] == nullptr && "Default condition set was set");
996 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
997 for (unsigned u = 2; u < NumSuccessors; u++)
998 ConditionSetUnion =
999 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1000 ConditionSets[0] = setDimensionIds(
1001 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1002
1003 S.markAsOptimized();
1004 isl_pw_aff_free(LHS);
1005}
1006
1007/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1008///
1009/// This will fill @p ConditionSets with the conditions under which control
1010/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1011/// have as many elements as @p TI has successors.
1012static void
1013buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1014 __isl_keep isl_set *Domain,
1015 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1016
1017 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1018 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1019
1020 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1021
1022 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001023 ConditionSets.push_back(isl_set_copy(Domain));
1024 return;
1025 }
1026
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001027 Value *Condition = getConditionFromTerminator(TI);
1028 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001029
1030 isl_set *ConsequenceCondSet = nullptr;
1031 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1032 if (CCond->isZero())
1033 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1034 else
1035 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1036 } else {
1037 auto *ICond = dyn_cast<ICmpInst>(Condition);
1038 assert(ICond &&
1039 "Condition of exiting branch was neither constant nor ICmp!");
1040
1041 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001042 BasicBlock *BB = TI->getParent();
Johannes Doerfert96425c22015-08-30 21:13:53 +00001043 isl_pw_aff *LHS, *RHS;
Johannes Doerfertcef616f2015-09-15 22:49:04 +00001044 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1045 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001046 ConsequenceCondSet =
1047 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001048 }
1049
1050 assert(ConsequenceCondSet);
1051 isl_set *AlternativeCondSet =
1052 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1053
1054 ConditionSets.push_back(isl_set_coalesce(
1055 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1056 ConditionSets.push_back(isl_set_coalesce(
1057 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1058}
1059
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001060void ScopStmt::buildDomain() {
Tobias Grosser084d8f72012-05-29 09:29:44 +00001061 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +00001062
Tobias Grosser084d8f72012-05-29 09:29:44 +00001063 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1064
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001065 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001066 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001067}
1068
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001069void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001070 isl_ctx *Ctx = Parent.getIslCtx();
1071 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1072 Type *Ty = GEP->getPointerOperandType();
1073 ScalarEvolution &SE = *Parent.getSE();
1074
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001075 std::vector<const SCEV *> Subscripts;
1076 std::vector<int> Sizes;
1077
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001078 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001079
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001080 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001081 Ty = PtrTy->getElementType();
1082 }
1083
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001084 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001085
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001086 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001087
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001088 for (size_t i = 0; i < Sizes.size(); i++) {
1089 auto Expr = Subscripts[i + IndexOffset];
1090 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001091
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001092 if (!isAffineExpr(&Parent.getRegion(), Expr, SE))
1093 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001094
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001095 isl_pw_aff *AccessOffset = getPwAff(Expr);
1096 AccessOffset =
1097 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001098
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001099 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1100 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001101
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001102 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1103 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1104 OutOfBound = isl_set_params(OutOfBound);
1105 isl_set *InBound = isl_set_complement(OutOfBound);
1106 isl_set *Executed = isl_set_params(getDomain());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001107
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001108 // A => B == !A or B
1109 isl_set *InBoundIfExecuted =
1110 isl_set_union(isl_set_complement(Executed), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001111
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001112 Parent.addAssumption(InBoundIfExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001113 }
1114
1115 isl_local_space_free(LSpace);
1116}
1117
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001118void ScopStmt::deriveAssumptions(BasicBlock *Block) {
1119 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001120 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
1121 deriveAssumptionsFromGEP(GEP);
1122}
1123
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001124void ScopStmt::collectSurroundingLoops() {
1125 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1126 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1127 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1128 isl_id_free(DimId);
1129 }
1130}
1131
Michael Kruse9d080092015-09-11 21:41:48 +00001132ScopStmt::ScopStmt(Scop &parent, Region &R)
Michael Krusecac948e2015-10-02 13:53:07 +00001133 : Parent(parent), Domain(nullptr), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001134
Tobias Grosser16c44032015-07-09 07:31:45 +00001135 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001136}
1137
Michael Kruse9d080092015-09-11 21:41:48 +00001138ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Michael Krusecac948e2015-10-02 13:53:07 +00001139 : Parent(parent), Domain(nullptr), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001140
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001141 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001142}
1143
1144void ScopStmt::init() {
1145 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001146
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001147 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001148 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001149 buildAccessRelations();
1150
1151 if (BB) {
1152 deriveAssumptions(BB);
1153 } else {
1154 for (BasicBlock *Block : R->blocks()) {
1155 deriveAssumptions(Block);
1156 }
1157 }
1158
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001159 if (DetectReductions)
1160 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001161}
1162
Johannes Doerferte58a0122014-06-27 20:31:28 +00001163/// @brief Collect loads which might form a reduction chain with @p StoreMA
1164///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001165/// Check if the stored value for @p StoreMA is a binary operator with one or
1166/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001167/// used only once (by @p StoreMA) and its load operands are also used only
1168/// once, we have found a possible reduction chain. It starts at an operand
1169/// load and includes the binary operator and @p StoreMA.
1170///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001171/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001172/// escape this block or into any other store except @p StoreMA.
1173void ScopStmt::collectCandiateReductionLoads(
1174 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1175 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1176 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001177 return;
1178
1179 // Skip if there is not one binary operator between the load and the store
1180 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001181 if (!BinOp)
1182 return;
1183
1184 // Skip if the binary operators has multiple uses
1185 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001186 return;
1187
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001188 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001189 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1190 return;
1191
Johannes Doerfert9890a052014-07-01 00:32:29 +00001192 // Skip if the binary operator is outside the current SCoP
1193 if (BinOp->getParent() != Store->getParent())
1194 return;
1195
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001196 // Skip if it is a multiplicative reduction and we disabled them
1197 if (DisableMultiplicativeReductions &&
1198 (BinOp->getOpcode() == Instruction::Mul ||
1199 BinOp->getOpcode() == Instruction::FMul))
1200 return;
1201
Johannes Doerferte58a0122014-06-27 20:31:28 +00001202 // Check the binary operator operands for a candidate load
1203 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1204 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1205 if (!PossibleLoad0 && !PossibleLoad1)
1206 return;
1207
1208 // A load is only a candidate if it cannot escape (thus has only this use)
1209 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001210 if (PossibleLoad0->getParent() == Store->getParent())
1211 Loads.push_back(lookupAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001212 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001213 if (PossibleLoad1->getParent() == Store->getParent())
1214 Loads.push_back(lookupAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001215}
1216
1217/// @brief Check for reductions in this ScopStmt
1218///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001219/// Iterate over all store memory accesses and check for valid binary reduction
1220/// like chains. For all candidates we check if they have the same base address
1221/// and there are no other accesses which overlap with them. The base address
1222/// check rules out impossible reductions candidates early. The overlap check,
1223/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001224/// guarantees that none of the intermediate results will escape during
1225/// execution of the loop nest. We basically check here that no other memory
1226/// access can access the same memory as the potential reduction.
1227void ScopStmt::checkForReductions() {
1228 SmallVector<MemoryAccess *, 2> Loads;
1229 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1230
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001231 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001232 // stores and collecting possible reduction loads.
1233 for (MemoryAccess *StoreMA : MemAccs) {
1234 if (StoreMA->isRead())
1235 continue;
1236
1237 Loads.clear();
1238 collectCandiateReductionLoads(StoreMA, Loads);
1239 for (MemoryAccess *LoadMA : Loads)
1240 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1241 }
1242
1243 // Then check each possible candidate pair.
1244 for (const auto &CandidatePair : Candidates) {
1245 bool Valid = true;
1246 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1247 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1248
1249 // Skip those with obviously unequal base addresses.
1250 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1251 isl_map_free(LoadAccs);
1252 isl_map_free(StoreAccs);
1253 continue;
1254 }
1255
1256 // And check if the remaining for overlap with other memory accesses.
1257 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1258 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1259 isl_set *AllAccs = isl_map_range(AllAccsRel);
1260
1261 for (MemoryAccess *MA : MemAccs) {
1262 if (MA == CandidatePair.first || MA == CandidatePair.second)
1263 continue;
1264
1265 isl_map *AccRel =
1266 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1267 isl_set *Accs = isl_map_range(AccRel);
1268
1269 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1270 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1271 Valid = Valid && isl_set_is_empty(OverlapAccs);
1272 isl_set_free(OverlapAccs);
1273 }
1274 }
1275
1276 isl_set_free(AllAccs);
1277 if (!Valid)
1278 continue;
1279
Johannes Doerfertf6183392014-07-01 20:52:51 +00001280 const LoadInst *Load =
1281 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1282 MemoryAccess::ReductionType RT =
1283 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1284
Johannes Doerferte58a0122014-06-27 20:31:28 +00001285 // If no overlapping access was found we mark the load and store as
1286 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001287 CandidatePair.first->markAsReductionLike(RT);
1288 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001289 }
Tobias Grosser75805372011-04-29 06:27:02 +00001290}
1291
Tobias Grosser74394f02013-01-14 22:40:23 +00001292std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001293
Tobias Grosser54839312015-04-21 11:37:25 +00001294std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001295 auto *S = getSchedule();
1296 auto Str = stringFromIslObj(S);
1297 isl_map_free(S);
1298 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001299}
1300
Tobias Grosser74394f02013-01-14 22:40:23 +00001301unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001302
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001303unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001304
Tobias Grosser75805372011-04-29 06:27:02 +00001305const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1306
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001307const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001308 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001309}
1310
Tobias Grosser74394f02013-01-14 22:40:23 +00001311isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001312
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001313__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001314
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001315__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001316 return isl_set_get_space(Domain);
1317}
1318
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001319__isl_give isl_id *ScopStmt::getDomainId() const {
1320 return isl_set_get_tuple_id(Domain);
1321}
Tobias Grossercd95b772012-08-30 11:49:38 +00001322
Tobias Grosser75805372011-04-29 06:27:02 +00001323ScopStmt::~ScopStmt() {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001324 DeleteContainerSeconds(InstructionToAccess);
Tobias Grosser75805372011-04-29 06:27:02 +00001325 isl_set_free(Domain);
Tobias Grosser75805372011-04-29 06:27:02 +00001326}
1327
1328void ScopStmt::print(raw_ostream &OS) const {
1329 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001330 OS.indent(12) << "Domain :=\n";
1331
1332 if (Domain) {
1333 OS.indent(16) << getDomainStr() << ";\n";
1334 } else
1335 OS.indent(16) << "n/a\n";
1336
Tobias Grosser54839312015-04-21 11:37:25 +00001337 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001338
1339 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001340 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001341 } else
1342 OS.indent(16) << "n/a\n";
1343
Tobias Grosser083d3d32014-06-28 08:59:45 +00001344 for (MemoryAccess *Access : MemAccs)
1345 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001346}
1347
1348void ScopStmt::dump() const { print(dbgs()); }
1349
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001350void ScopStmt::hoistMemoryAccesses(MemoryAccessList &InvMAs,
1351 InvariantAccessesTy &TargetList) {
1352
1353 // Remove all memory accesses in @p InvMAs from this statement together
1354 // with all scalar accesses that were caused by them. The tricky iteration
1355 // order uses is needed because the MemAccs is a vector and the order in
1356 // which the accesses of each memory access list (MAL) are stored in this
1357 // vector is reversed.
1358 for (MemoryAccess *MA : InvMAs) {
1359 auto &MAL = *lookupAccessesFor(MA->getAccessInstruction());
1360 MAL.reverse();
1361
1362 auto MALIt = MAL.begin();
1363 auto MALEnd = MAL.end();
1364 auto MemAccsIt = MemAccs.begin();
1365 while (MALIt != MALEnd) {
1366 while (*MemAccsIt != *MALIt)
1367 MemAccsIt++;
1368
1369 MALIt++;
1370 MemAccs.erase(MemAccsIt);
1371 }
1372
1373 InstructionToAccess.erase(MA->getAccessInstruction());
1374 delete &MAL;
1375 }
1376
1377 // Get the context under which this statement, hence the memory accesses, are
1378 // executed.
1379 isl_set *DomainCtx = isl_set_params(getDomain());
1380 DomainCtx = isl_set_remove_redundancies(DomainCtx);
1381 DomainCtx = isl_set_detect_equalities(DomainCtx);
1382 DomainCtx = isl_set_coalesce(DomainCtx);
1383
1384 for (MemoryAccess *MA : InvMAs)
1385 TargetList.push_back(std::make_pair(MA, isl_set_copy(DomainCtx)));
1386
1387 isl_set_free(DomainCtx);
1388}
1389
Tobias Grosser75805372011-04-29 06:27:02 +00001390//===----------------------------------------------------------------------===//
1391/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001392
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001393void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001394 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1395 isl_set_free(Context);
1396 Context = NewContext;
1397}
1398
Tobias Grosserabfbe632013-02-05 12:09:06 +00001399void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001400 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001401 Parameter = extractConstantFactor(Parameter, *SE).second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001402 if (ParameterIds.find(Parameter) != ParameterIds.end())
1403 continue;
1404
1405 int dimension = Parameters.size();
1406
1407 Parameters.push_back(Parameter);
1408 ParameterIds[Parameter] = dimension;
1409 }
1410}
1411
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001412__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) const {
1413 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001414
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001415 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001416 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001417
Tobias Grosser8f99c162011-11-15 11:38:55 +00001418 std::string ParameterName;
1419
1420 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1421 Value *Val = ValueParameter->getValue();
Tobias Grosser29ee0b12011-11-17 14:52:36 +00001422 ParameterName = Val->getName();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001423 }
1424
1425 if (ParameterName == "" || ParameterName.substr(0, 2) == "p_")
Hongbin Zheng86a37742012-04-25 08:01:38 +00001426 ParameterName = "p_" + utostr_32(IdIter->second);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001427
Tobias Grosser20532b82014-04-11 17:56:49 +00001428 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1429 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001430}
Tobias Grosser75805372011-04-29 06:27:02 +00001431
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001432isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1433 isl_set *DomainContext = isl_union_set_params(getDomains());
1434 return isl_set_intersect_params(C, DomainContext);
1435}
1436
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001437void Scop::buildBoundaryContext() {
1438 BoundaryContext = Affinator.getWrappingContext();
1439 BoundaryContext = isl_set_complement(BoundaryContext);
1440 BoundaryContext = isl_set_gist_params(BoundaryContext, getContext());
1441}
1442
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001443void Scop::addUserContext() {
1444 if (UserContextStr.empty())
1445 return;
1446
1447 isl_set *UserContext = isl_set_read_from_str(IslCtx, UserContextStr.c_str());
1448 isl_space *Space = getParamSpace();
1449 if (isl_space_dim(Space, isl_dim_param) !=
1450 isl_set_dim(UserContext, isl_dim_param)) {
1451 auto SpaceStr = isl_space_to_str(Space);
1452 errs() << "Error: the context provided in -polly-context has not the same "
1453 << "number of dimensions than the computed context. Due to this "
1454 << "mismatch, the -polly-context option is ignored. Please provide "
1455 << "the context in the parameter space: " << SpaceStr << ".\n";
1456 free(SpaceStr);
1457 isl_set_free(UserContext);
1458 isl_space_free(Space);
1459 return;
1460 }
1461
1462 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
1463 auto NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1464 auto NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
1465
1466 if (strcmp(NameContext, NameUserContext) != 0) {
1467 auto SpaceStr = isl_space_to_str(Space);
1468 errs() << "Error: the name of dimension " << i
1469 << " provided in -polly-context "
1470 << "is '" << NameUserContext << "', but the name in the computed "
1471 << "context is '" << NameContext
1472 << "'. Due to this name mismatch, "
1473 << "the -polly-context option is ignored. Please provide "
1474 << "the context in the parameter space: " << SpaceStr << ".\n";
1475 free(SpaceStr);
1476 isl_set_free(UserContext);
1477 isl_space_free(Space);
1478 return;
1479 }
1480
1481 UserContext =
1482 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1483 isl_space_get_dim_id(Space, isl_dim_param, i));
1484 }
1485
1486 Context = isl_set_intersect(Context, UserContext);
1487 isl_space_free(Space);
1488}
1489
Tobias Grosser6be480c2011-11-08 15:41:13 +00001490void Scop::buildContext() {
1491 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001492 Context = isl_set_universe(isl_space_copy(Space));
1493 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001494}
1495
Tobias Grosser18daaca2012-05-22 10:47:27 +00001496void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001497 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001498 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001499
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001500 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001501
Johannes Doerferte7044942015-02-24 11:58:30 +00001502 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001503 }
1504}
1505
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001506void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001507 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001508 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001509
Tobias Grosser083d3d32014-06-28 08:59:45 +00001510 for (const auto &ParamID : ParameterIds) {
1511 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001512 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001513 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001514 }
1515
1516 // Align the parameters of all data structures to the model.
1517 Context = isl_set_align_params(Context, Space);
1518
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001519 for (ScopStmt &Stmt : *this)
1520 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001521}
1522
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001523static __isl_give isl_set *
1524simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1525 const Scop &S) {
1526 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1527 AssumptionContext = isl_set_gist_params(AssumptionContext, DomainParameters);
1528 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1529 return AssumptionContext;
1530}
1531
1532void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001533 // The parameter constraints of the iteration domains give us a set of
1534 // constraints that need to hold for all cases where at least a single
1535 // statement iteration is executed in the whole scop. We now simplify the
1536 // assumed context under the assumption that such constraints hold and at
1537 // least a single statement iteration is executed. For cases where no
1538 // statement instances are executed, the assumptions we have taken about
1539 // the executed code do not matter and can be changed.
1540 //
1541 // WARNING: This only holds if the assumptions we have taken do not reduce
1542 // the set of statement instances that are executed. Otherwise we
1543 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001544 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001545 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001546 // performed. In such a case, modifying the run-time conditions and
1547 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001548 // to not be executed.
1549 //
1550 // Example:
1551 //
1552 // When delinearizing the following code:
1553 //
1554 // for (long i = 0; i < 100; i++)
1555 // for (long j = 0; j < m; j++)
1556 // A[i+p][j] = 1.0;
1557 //
1558 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001559 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001560 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001561 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
1562 BoundaryContext = simplifyAssumptionContext(BoundaryContext, *this);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001563}
1564
Johannes Doerfertb164c792014-09-18 11:17:17 +00001565/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001566static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001567 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1568 isl_pw_multi_aff *MinPMA, *MaxPMA;
1569 isl_pw_aff *LastDimAff;
1570 isl_aff *OneAff;
1571 unsigned Pos;
1572
Johannes Doerfert9143d672014-09-27 11:02:39 +00001573 // Restrict the number of parameters involved in the access as the lexmin/
1574 // lexmax computation will take too long if this number is high.
1575 //
1576 // Experiments with a simple test case using an i7 4800MQ:
1577 //
1578 // #Parameters involved | Time (in sec)
1579 // 6 | 0.01
1580 // 7 | 0.04
1581 // 8 | 0.12
1582 // 9 | 0.40
1583 // 10 | 1.54
1584 // 11 | 6.78
1585 // 12 | 30.38
1586 //
1587 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1588 unsigned InvolvedParams = 0;
1589 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1590 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1591 InvolvedParams++;
1592
1593 if (InvolvedParams > RunTimeChecksMaxParameters) {
1594 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001595 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00001596 }
1597 }
1598
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001599 Set = isl_set_remove_divs(Set);
1600
Johannes Doerfertb164c792014-09-18 11:17:17 +00001601 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1602 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1603
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001604 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1605 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1606
Johannes Doerfertb164c792014-09-18 11:17:17 +00001607 // Adjust the last dimension of the maximal access by one as we want to
1608 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1609 // we test during code generation might now point after the end of the
1610 // allocated array but we will never dereference it anyway.
1611 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1612 "Assumed at least one output dimension");
1613 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1614 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1615 OneAff = isl_aff_zero_on_domain(
1616 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1617 OneAff = isl_aff_add_constant_si(OneAff, 1);
1618 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1619 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1620
1621 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1622
1623 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001624 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001625}
1626
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001627static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1628 isl_set *Domain = MA->getStatement()->getDomain();
1629 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1630 return isl_set_reset_tuple_id(Domain);
1631}
1632
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001633/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
1634static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00001635 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001636 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001637
1638 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
1639 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001640 Locations = isl_union_set_coalesce(Locations);
1641 Locations = isl_union_set_detect_equalities(Locations);
1642 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001643 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001644 isl_union_set_free(Locations);
1645 return Valid;
1646}
1647
Johannes Doerfert96425c22015-08-30 21:13:53 +00001648/// @brief Helper to treat non-affine regions and basic blocks the same.
1649///
1650///{
1651
1652/// @brief Return the block that is the representing block for @p RN.
1653static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
1654 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
1655 : RN->getNodeAs<BasicBlock>();
1656}
1657
1658/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001659static inline BasicBlock *
1660getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001661 if (RN->isSubRegion()) {
1662 assert(idx == 0);
1663 return RN->getNodeAs<Region>()->getExit();
1664 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001665 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001666}
1667
1668/// @brief Return the smallest loop surrounding @p RN.
1669static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
1670 if (!RN->isSubRegion())
1671 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
1672
1673 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
1674 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
1675 while (L && NonAffineSubRegion->contains(L))
1676 L = L->getParentLoop();
1677 return L;
1678}
1679
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001680static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
1681 if (!RN->isSubRegion())
1682 return 1;
1683
1684 unsigned NumBlocks = 0;
1685 Region *R = RN->getNodeAs<Region>();
1686 for (auto BB : R->blocks()) {
1687 (void)BB;
1688 NumBlocks++;
1689 }
1690 return NumBlocks;
1691}
1692
Johannes Doerfertf5673802015-10-01 23:48:18 +00001693static bool containsErrorBlock(RegionNode *RN) {
1694 if (!RN->isSubRegion())
1695 return isErrorBlock(*RN->getNodeAs<BasicBlock>());
1696 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
1697 if (isErrorBlock(*BB))
1698 return true;
1699 return false;
1700}
1701
Johannes Doerfert96425c22015-08-30 21:13:53 +00001702///}
1703
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001704static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
1705 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001706 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001707 isl_id *DimId =
1708 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
1709 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
1710}
1711
Johannes Doerfert96425c22015-08-30 21:13:53 +00001712isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
1713 BasicBlock *BB = Stmt->isBlockStmt() ? Stmt->getBasicBlock()
1714 : Stmt->getRegion()->getEntry();
Johannes Doerfertcef616f2015-09-15 22:49:04 +00001715 return getDomainConditions(BB);
1716}
1717
1718isl_set *Scop::getDomainConditions(BasicBlock *BB) {
1719 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001720 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001721}
1722
Johannes Doerfert478a7de2015-10-02 13:09:31 +00001723void Scop::buildDomains(Region *R, LoopInfo &LI, DominatorTree &DT) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001724
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001725 auto *EntryBB = R->getEntry();
1726 int LD = getRelativeLoopDepth(LI.getLoopFor(EntryBB));
1727 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001728
1729 Loop *L = LI.getLoopFor(EntryBB);
1730 while (LD-- >= 0) {
1731 S = addDomainDimId(S, LD + 1, L);
1732 L = L->getParentLoop();
1733 }
1734
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001735 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001736
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00001737 if (SD.isNonAffineSubRegion(R, R))
1738 return;
1739
Johannes Doerfert478a7de2015-10-02 13:09:31 +00001740 buildDomainsWithBranchConstraints(R, LI, DT);
1741 propagateDomainConstraints(R, LI, DT);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001742}
1743
1744void Scop::buildDomainsWithBranchConstraints(Region *R, LoopInfo &LI,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001745 DominatorTree &DT) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001746 RegionInfo &RI = *R->getRegionInfo();
Johannes Doerfert96425c22015-08-30 21:13:53 +00001747
1748 // To create the domain for each block in R we iterate over all blocks and
1749 // subregions in R and propagate the conditions under which the current region
1750 // element is executed. To this end we iterate in reverse post order over R as
1751 // it ensures that we first visit all predecessors of a region node (either a
1752 // basic block or a subregion) before we visit the region node itself.
1753 // Initially, only the domain for the SCoP region entry block is set and from
1754 // there we propagate the current domain to all successors, however we add the
1755 // condition that the successor is actually executed next.
1756 // As we are only interested in non-loop carried constraints here we can
1757 // simply skip loop back edges.
1758
1759 ReversePostOrderTraversal<Region *> RTraversal(R);
1760 for (auto *RN : RTraversal) {
1761
1762 // Recurse for affine subregions but go on for basic blocks and non-affine
1763 // subregions.
1764 if (RN->isSubRegion()) {
1765 Region *SubRegion = RN->getNodeAs<Region>();
1766 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert478a7de2015-10-02 13:09:31 +00001767 buildDomainsWithBranchConstraints(SubRegion, LI, DT);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001768 continue;
1769 }
1770 }
1771
Johannes Doerfertf5673802015-10-01 23:48:18 +00001772 // Error blocks are assumed not to be executed. Therefor they are not
1773 // checked properly in the ScopDetection. Any attempt to generate control
1774 // conditions from them might result in a crash. However, this is only true
1775 // for the first step of the domain generation (this function) where we
1776 // push the control conditions of a block to the successors. In the second
1777 // step (propagateDomainConstraints) we only receive domain constraints from
1778 // the predecessors and can therefor look at the domain of a error block.
1779 // That allows us to generate the assumptions needed for them not to be
1780 // executed at runtime.
1781 if (containsErrorBlock(RN))
1782 continue;
1783
Johannes Doerfert96425c22015-08-30 21:13:53 +00001784 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001785 TerminatorInst *TI = BB->getTerminator();
1786
Johannes Doerfertf5673802015-10-01 23:48:18 +00001787 isl_set *Domain = DomainMap.lookup(BB);
1788 if (!Domain) {
1789 DEBUG(dbgs() << "\tSkip: " << BB->getName()
1790 << ", it is only reachable from error blocks.\n");
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001791 continue;
1792 }
1793
Johannes Doerfert96425c22015-08-30 21:13:53 +00001794 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001795
1796 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1797 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1798
1799 // Build the condition sets for the successor nodes of the current region
1800 // node. If it is a non-affine subregion we will always execute the single
1801 // exit node, hence the single entry node domain is the condition set. For
1802 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001803 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001804 if (RN->isSubRegion())
1805 ConditionSets.push_back(isl_set_copy(Domain));
1806 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001807 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001808
1809 // Now iterate over the successors and set their initial domain based on
1810 // their condition set. We skip back edges here and have to be careful when
1811 // we leave a loop not to keep constraints over a dimension that doesn't
1812 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001813 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00001814 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001815 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001816 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001817
1818 // Skip back edges.
1819 if (DT.dominates(SuccBB, BB)) {
1820 isl_set_free(CondSet);
1821 continue;
1822 }
1823
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001824 // Do not adjust the number of dimensions if we enter a boxed loop or are
1825 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001826 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001827 Region *SuccRegion = RI.getRegionFor(SuccBB);
1828 if (BBLoop != SuccBBLoop && !RN->isSubRegion() &&
1829 !(SD.isNonAffineSubRegion(SuccRegion, &getRegion()) &&
1830 SuccRegion->contains(SuccBBLoop))) {
1831
1832 // Check if the edge to SuccBB is a loop entry or exit edge. If so
1833 // adjust the dimensionality accordingly. Lastly, if we leave a loop
1834 // and enter a new one we need to drop the old constraints.
1835 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001836 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001837 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001838 CondSet = isl_set_project_out(CondSet, isl_dim_set,
1839 isl_set_n_dim(CondSet) - LoopDepthDiff,
1840 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001841 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001842 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001843 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001844 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001845 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001846 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001847 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
1848 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001849 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001850 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00001851 }
1852
1853 // Set the domain for the successor or merge it with an existing domain in
1854 // case there are multiple paths (without loop back edges) to the
1855 // successor block.
1856 isl_set *&SuccDomain = DomainMap[SuccBB];
1857 if (!SuccDomain)
1858 SuccDomain = CondSet;
1859 else
1860 SuccDomain = isl_set_union(SuccDomain, CondSet);
1861
1862 SuccDomain = isl_set_coalesce(SuccDomain);
1863 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : " << Domain
1864 << "\n");
1865 }
1866 }
1867}
1868
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001869/// @brief Return the domain for @p BB wrt @p DomainMap.
1870///
1871/// This helper function will lookup @p BB in @p DomainMap but also handle the
1872/// case where @p BB is contained in a non-affine subregion using the region
1873/// tree obtained by @p RI.
1874static __isl_give isl_set *
1875getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
1876 RegionInfo &RI) {
1877 auto DIt = DomainMap.find(BB);
1878 if (DIt != DomainMap.end())
1879 return isl_set_copy(DIt->getSecond());
1880
1881 Region *R = RI.getRegionFor(BB);
1882 while (R->getEntry() == BB)
1883 R = R->getParent();
1884 return getDomainForBlock(R->getEntry(), DomainMap, RI);
1885}
1886
1887void Scop::propagateDomainConstraints(Region *R, LoopInfo &LI,
Johannes Doerfert478a7de2015-10-02 13:09:31 +00001888 DominatorTree &DT) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001889 // Iterate over the region R and propagate the domain constrains from the
1890 // predecessors to the current node. In contrast to the
1891 // buildDomainsWithBranchConstraints function, this one will pull the domain
1892 // information from the predecessors instead of pushing it to the successors.
1893 // Additionally, we assume the domains to be already present in the domain
1894 // map here. However, we iterate again in reverse post order so we know all
1895 // predecessors have been visited before a block or non-affine subregion is
1896 // visited.
1897
1898 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
1899 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
1900
1901 ReversePostOrderTraversal<Region *> RTraversal(R);
1902 for (auto *RN : RTraversal) {
1903
1904 // Recurse for affine subregions but go on for basic blocks and non-affine
1905 // subregions.
1906 if (RN->isSubRegion()) {
1907 Region *SubRegion = RN->getNodeAs<Region>();
1908 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert478a7de2015-10-02 13:09:31 +00001909 propagateDomainConstraints(SubRegion, LI, DT);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001910 continue;
1911 }
1912 }
1913
Johannes Doerfertf5673802015-10-01 23:48:18 +00001914 // Get the domain for the current block and check if it was initialized or
1915 // not. The only way it was not is if this block is only reachable via error
1916 // blocks, thus will not be executed under the assumptions we make. Such
1917 // blocks have to be skipped as their predecessors might not have domains
1918 // either. It would not benefit us to compute the domain anyway, only the
1919 // domains of the error blocks that are reachable from non-error blocks
1920 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001921 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00001922 isl_set *&Domain = DomainMap[BB];
1923 if (!Domain) {
1924 DEBUG(dbgs() << "\tSkip: " << BB->getName()
1925 << ", it is only reachable from error blocks.\n");
1926 DomainMap.erase(BB);
1927 continue;
1928 }
1929 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
1930
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001931 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1932 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1933
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001934 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
1935 for (auto *PredBB : predecessors(BB)) {
1936
1937 // Skip backedges
1938 if (DT.dominates(BB, PredBB))
1939 continue;
1940
1941 isl_set *PredBBDom = nullptr;
1942
1943 // Handle the SCoP entry block with its outside predecessors.
1944 if (!getRegion().contains(PredBB))
1945 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
1946
1947 if (!PredBBDom) {
1948 // Determine the loop depth of the predecessor and adjust its domain to
1949 // the domain of the current block. This can mean we have to:
1950 // o) Drop a dimension if this block is the exit of a loop, not the
1951 // header of a new loop and the predecessor was part of the loop.
1952 // o) Add an unconstrainted new dimension if this block is the header
1953 // of a loop and the predecessor is not part of it.
1954 // o) Drop the information about the innermost loop dimension when the
1955 // predecessor and the current block are surrounded by different
1956 // loops in the same depth.
1957 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
1958 Loop *PredBBLoop = LI.getLoopFor(PredBB);
1959 while (BoxedLoops.count(PredBBLoop))
1960 PredBBLoop = PredBBLoop->getParentLoop();
1961
1962 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001963 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001964 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001965 PredBBDom = isl_set_project_out(
1966 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
1967 LoopDepthDiff);
1968 else if (PredBBLoopDepth < BBLoopDepth) {
1969 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001970 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001971 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
1972 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001973 PredBBDom = isl_set_drop_constraints_involving_dims(
1974 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001975 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001976 }
1977
1978 PredDom = isl_set_union(PredDom, PredBBDom);
1979 }
1980
1981 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00001982 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001983
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00001984 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001985 addLoopBoundsToHeaderDomain(BBLoop, LI);
1986
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001987 // Add assumptions for error blocks.
Johannes Doerferte114dc02015-09-14 11:15:58 +00001988 if (containsErrorBlock(RN)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001989 IsOptimized = true;
1990 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
1991 addAssumption(isl_set_complement(DomPar));
1992 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001993 }
1994}
1995
1996/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
1997/// is incremented by one and all other dimensions are equal, e.g.,
1998/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
1999/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2000static __isl_give isl_map *
2001createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2002 auto *MapSpace = isl_space_map_from_set(SetSpace);
2003 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2004 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2005 if (u != Dim)
2006 NextIterationMap =
2007 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2008 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2009 C = isl_constraint_set_constant_si(C, 1);
2010 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2011 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2012 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2013 return NextIterationMap;
2014}
2015
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002016void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
2017 int LoopDepth = getRelativeLoopDepth(L);
2018 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002019
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002020 BasicBlock *HeaderBB = L->getHeader();
2021 assert(DomainMap.count(HeaderBB));
2022 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002023
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002024 isl_map *NextIterationMap =
2025 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002026
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002027 isl_set *UnionBackedgeCondition =
2028 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002029
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002030 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2031 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002032
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002033 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002034
2035 // If the latch is only reachable via error statements we skip it.
2036 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2037 if (!LatchBBDom)
2038 continue;
2039
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002040 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002041
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002042 TerminatorInst *TI = LatchBB->getTerminator();
2043 BranchInst *BI = dyn_cast<BranchInst>(TI);
2044 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002045 BackedgeCondition = isl_set_copy(LatchBBDom);
2046 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002047 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002048 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002049 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002050
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002051 // Free the non back edge condition set as we do not need it.
2052 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002053
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002054 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002055 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002056
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002057 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2058 assert(LatchLoopDepth >= LoopDepth);
2059 BackedgeCondition =
2060 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2061 LatchLoopDepth - LoopDepth);
2062 UnionBackedgeCondition =
2063 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002064 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002065
2066 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2067 for (int i = 0; i < LoopDepth; i++)
2068 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2069
2070 isl_set *UnionBackedgeConditionComplement =
2071 isl_set_complement(UnionBackedgeCondition);
2072 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2073 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2074 UnionBackedgeConditionComplement =
2075 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2076 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2077 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2078
2079 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2080 HeaderBBDom = Parts.second;
2081
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002082 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2083 // the bounded assumptions to the context as they are already implied by the
2084 // <nsw> tag.
2085 if (Affinator.hasNSWAddRecForLoop(L)) {
2086 isl_set_free(Parts.first);
2087 return;
2088 }
2089
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002090 isl_set *UnboundedCtx = isl_set_params(Parts.first);
2091 isl_set *BoundedCtx = isl_set_complement(UnboundedCtx);
Johannes Doerfert707a4062015-09-20 16:38:19 +00002092 addAssumption(BoundedCtx);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002093}
2094
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002095void Scop::buildAliasChecks(AliasAnalysis &AA) {
2096 if (!PollyUseRuntimeAliasChecks)
2097 return;
2098
2099 if (buildAliasGroups(AA))
2100 return;
2101
2102 // If a problem occurs while building the alias groups we need to delete
2103 // this SCoP and pretend it wasn't valid in the first place. To this end
2104 // we make the assumed context infeasible.
2105 addAssumption(isl_set_empty(getParamSpace()));
2106
2107 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2108 << " could not be created as the number of parameters involved "
2109 "is too high. The SCoP will be "
2110 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2111 "the maximal number of parameters but be advised that the "
2112 "compile time might increase exponentially.\n\n");
2113}
2114
Johannes Doerfert9143d672014-09-27 11:02:39 +00002115bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002116 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002117 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002118 // for all memory accesses inside the SCoP.
2119 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002120 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002121 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002122 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002123 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002124 // if their access domains intersect, otherwise they are in different
2125 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002126 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002127 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002128 // and maximal accesses to each array of a group in read only and non
2129 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002130 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2131
2132 AliasSetTracker AST(AA);
2133
2134 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002135 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002136 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002137
2138 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002139 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002140 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2141 isl_set_free(StmtDomain);
2142 if (StmtDomainEmpty)
2143 continue;
2144
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002145 for (MemoryAccess *MA : Stmt) {
Michael Kruse8d0b7342015-09-25 21:21:00 +00002146 if (MA->isImplicit())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002147 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002148 if (!MA->isRead())
2149 HasWriteAccess.insert(MA->getBaseAddr());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002150 Instruction *Acc = MA->getAccessInstruction();
2151 PtrToAcc[getPointerOperand(*Acc)] = MA;
2152 AST.add(Acc);
2153 }
2154 }
2155
2156 SmallVector<AliasGroupTy, 4> AliasGroups;
2157 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002158 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002159 continue;
2160 AliasGroupTy AG;
2161 for (auto PR : AS)
2162 AG.push_back(PtrToAcc[PR.getValue()]);
2163 assert(AG.size() > 1 &&
2164 "Alias groups should contain at least two accesses");
2165 AliasGroups.push_back(std::move(AG));
2166 }
2167
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002168 // Split the alias groups based on their domain.
2169 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2170 AliasGroupTy NewAG;
2171 AliasGroupTy &AG = AliasGroups[u];
2172 AliasGroupTy::iterator AGI = AG.begin();
2173 isl_set *AGDomain = getAccessDomain(*AGI);
2174 while (AGI != AG.end()) {
2175 MemoryAccess *MA = *AGI;
2176 isl_set *MADomain = getAccessDomain(MA);
2177 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2178 NewAG.push_back(MA);
2179 AGI = AG.erase(AGI);
2180 isl_set_free(MADomain);
2181 } else {
2182 AGDomain = isl_set_union(AGDomain, MADomain);
2183 AGI++;
2184 }
2185 }
2186 if (NewAG.size() > 1)
2187 AliasGroups.push_back(std::move(NewAG));
2188 isl_set_free(AGDomain);
2189 }
2190
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002191 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002192 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2193 for (AliasGroupTy &AG : AliasGroups) {
2194 NonReadOnlyBaseValues.clear();
2195 ReadOnlyPairs.clear();
2196
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002197 if (AG.size() < 2) {
2198 AG.clear();
2199 continue;
2200 }
2201
Johannes Doerfert13771732014-10-01 12:40:46 +00002202 for (auto II = AG.begin(); II != AG.end();) {
2203 Value *BaseAddr = (*II)->getBaseAddr();
2204 if (HasWriteAccess.count(BaseAddr)) {
2205 NonReadOnlyBaseValues.insert(BaseAddr);
2206 II++;
2207 } else {
2208 ReadOnlyPairs[BaseAddr].insert(*II);
2209 II = AG.erase(II);
2210 }
2211 }
2212
2213 // If we don't have read only pointers check if there are at least two
2214 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002215 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002216 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002217 continue;
2218 }
2219
2220 // If we don't have non read only pointers clear the alias group.
2221 if (NonReadOnlyBaseValues.empty()) {
2222 AG.clear();
2223 continue;
2224 }
2225
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002226 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002227 MinMaxAliasGroups.emplace_back();
2228 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2229 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2230 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2231 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002232
2233 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002234
2235 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002236 for (MemoryAccess *MA : AG)
2237 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002238
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002239 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2240 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002241
2242 // Bail out if the number of values we need to compare is too large.
2243 // This is important as the number of comparisions grows quadratically with
2244 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002245 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2246 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002247 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002248
2249 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002250 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002251 Accesses = isl_union_map_empty(getParamSpace());
2252
2253 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2254 for (MemoryAccess *MA : ReadOnlyPair.second)
2255 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2256
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002257 Valid =
2258 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002259
2260 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002261 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002262 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002263
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002264 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002265}
2266
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002267static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
2268 Loop *L = LI.getLoopFor(R.getEntry());
2269 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2270}
2271
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002272static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2273 ScopDetection &SD) {
2274
2275 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2276
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002277 unsigned MinLD = INT_MAX, MaxLD = 0;
2278 for (BasicBlock *BB : R.blocks()) {
2279 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002280 if (!R.contains(L))
2281 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002282 if (BoxedLoops && BoxedLoops->count(L))
2283 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002284 unsigned LD = L->getLoopDepth();
2285 MinLD = std::min(MinLD, LD);
2286 MaxLD = std::max(MaxLD, LD);
2287 }
2288 }
2289
2290 // Handle the case that there is no loop in the SCoP first.
2291 if (MaxLD == 0)
2292 return 1;
2293
2294 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2295 assert(MaxLD >= MinLD &&
2296 "Maximal loop depth was smaller than mininaml loop depth?");
2297 return MaxLD - MinLD + 1;
2298}
2299
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002300Scop::Scop(Region &R, AccFuncMapType &AccFuncMap, ScopDetection &SD,
Michael Kruse9d080092015-09-11 21:41:48 +00002301 ScalarEvolution &ScalarEvolution, DominatorTree &DT,
Johannes Doerfert96425c22015-08-30 21:13:53 +00002302 isl_ctx *Context, unsigned MaxLoopDepth)
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002303 : DT(DT), SE(&ScalarEvolution), SD(SD), R(R), AccFuncMap(AccFuncMap),
Michael Kruse9d080092015-09-11 21:41:48 +00002304 IsOptimized(false), HasSingleExitEdge(R.getExitingBlock()),
Michael Kruseafe06702015-10-02 16:33:27 +00002305 MaxLoopDepth(MaxLoopDepth), IslCtx(Context), Context(nullptr),
2306 Affinator(this), AssumedContext(nullptr), BoundaryContext(nullptr),
2307 Schedule(nullptr) {}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002308
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002309void Scop::init(LoopInfo &LI, AliasAnalysis &AA) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002310 buildContext();
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002311 buildDomains(&R, LI, DT);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002312
Michael Krusecac948e2015-10-02 13:53:07 +00002313 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00002314 // Exit early in case there are no executable statements left in this scop.
Michael Krusecac948e2015-10-02 13:53:07 +00002315 simplifySCoP(true);
Michael Kruseafe06702015-10-02 16:33:27 +00002316 if (Stmts.empty())
2317 return;
Tobias Grosser75805372011-04-29 06:27:02 +00002318
Michael Krusecac948e2015-10-02 13:53:07 +00002319 // The ScopStmts now have enough information to initialize themselves.
2320 for (ScopStmt &Stmt : Stmts)
2321 Stmt.init();
2322
2323 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> LoopSchedules;
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002324 Loop *L = getLoopSurroundingRegion(R, LI);
2325 LoopSchedules[L];
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002326 buildSchedule(&R, LI, LoopSchedules);
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002327 updateAccessDimensionality();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002328 Schedule = LoopSchedules[L].first;
Tobias Grosser75805372011-04-29 06:27:02 +00002329
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002330 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002331 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002332 addUserContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002333 buildBoundaryContext();
2334 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002335 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002336
2337 hoistInvariantLoads();
Michael Krusecac948e2015-10-02 13:53:07 +00002338 simplifySCoP(false);
Tobias Grosser75805372011-04-29 06:27:02 +00002339}
2340
2341Scop::~Scop() {
2342 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002343 isl_set_free(AssumedContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002344 isl_set_free(BoundaryContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002345 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002346
Johannes Doerfert96425c22015-08-30 21:13:53 +00002347 for (auto It : DomainMap)
2348 isl_set_free(It.second);
2349
Johannes Doerfertb164c792014-09-18 11:17:17 +00002350 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002351 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002352 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002353 isl_pw_multi_aff_free(MMA.first);
2354 isl_pw_multi_aff_free(MMA.second);
2355 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002356 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002357 isl_pw_multi_aff_free(MMA.first);
2358 isl_pw_multi_aff_free(MMA.second);
2359 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002360 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002361
2362 for (const auto &IA : InvariantAccesses)
2363 isl_set_free(IA.second);
Tobias Grosser75805372011-04-29 06:27:02 +00002364}
2365
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002366void Scop::updateAccessDimensionality() {
2367 for (auto &Stmt : *this)
2368 for (auto &Access : Stmt)
2369 Access->updateDimensionality();
2370}
2371
Michael Krusecac948e2015-10-02 13:53:07 +00002372void Scop::simplifySCoP(bool RemoveIgnoredStmts) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002373 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
2374 ScopStmt &Stmt = *StmtIt;
Michael Krusecac948e2015-10-02 13:53:07 +00002375 RegionNode *RN = Stmt.isRegionStmt()
2376 ? Stmt.getRegion()->getNode()
2377 : getRegion().getBBNode(Stmt.getBasicBlock());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002378
Michael Krusecac948e2015-10-02 13:53:07 +00002379 if (StmtIt->isEmpty() || (RemoveIgnoredStmts && isIgnored(RN))) {
2380 // Remove the statement because it is unnecessary.
2381 if (Stmt.isRegionStmt())
2382 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2383 StmtMap.erase(BB);
2384 else
2385 StmtMap.erase(Stmt.getBasicBlock());
2386
2387 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002388 continue;
2389 }
2390
Michael Krusecac948e2015-10-02 13:53:07 +00002391 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002392 }
2393}
2394
2395void Scop::hoistInvariantLoads() {
2396 isl_union_map *Writes = getWrites();
2397 for (ScopStmt &Stmt : *this) {
2398
2399 // TODO: Loads that are not loop carried, hence are in a statement with
2400 // zero iterators, are by construction invariant, though we
2401 // currently "hoist" them anyway.
2402
Johannes Doerfert8930f482015-10-02 14:51:00 +00002403 BasicBlock *BB = Stmt.isBlockStmt() ? Stmt.getBasicBlock()
2404 : Stmt.getRegion()->getEntry();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002405 isl_set *Domain = Stmt.getDomain();
2406 MemoryAccessList InvMAs;
2407
2408 for (MemoryAccess *MA : Stmt) {
2409 if (MA->isImplicit() || MA->isWrite() || !MA->isAffine())
2410 continue;
2411
Johannes Doerfert8930f482015-10-02 14:51:00 +00002412 // Skip accesses in non-affine subregions as they might not be executed
2413 // under the same condition as the entry of the non-affine subregion.
2414 if (BB != MA->getAccessInstruction()->getParent())
2415 continue;
2416
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002417 isl_map *AccessRelation = MA->getAccessRelation();
2418 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
2419 Stmt.getNumIterators())) {
2420 isl_map_free(AccessRelation);
2421 continue;
2422 }
2423
2424 AccessRelation =
2425 isl_map_intersect_domain(AccessRelation, isl_set_copy(Domain));
2426 isl_set *AccessRange = isl_map_range(AccessRelation);
2427
2428 isl_union_map *Written = isl_union_map_intersect_range(
2429 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
2430 bool IsWritten = !isl_union_map_is_empty(Written);
2431 isl_union_map_free(Written);
2432
2433 if (IsWritten)
2434 continue;
2435
2436 InvMAs.push_front(MA);
2437 }
2438
2439 // We inserted invariant accesses always in the front but need them to be
2440 // sorted in a "natural order". The statements are already sorted in reverse
2441 // post order and that suffices for the accesses too. The reason we require
2442 // an order in the first place is the dependences between invariant loads
2443 // that can be caused by indirect loads.
2444 InvMAs.reverse();
2445
2446 // Transfer the memory access from the statement to the SCoP.
2447 Stmt.hoistMemoryAccesses(InvMAs, InvariantAccesses);
2448
2449 isl_set_free(Domain);
2450 }
2451 isl_union_map_free(Writes);
2452
2453 if (!InvariantAccesses.empty())
2454 IsOptimized = true;
2455}
2456
Johannes Doerfert80ef1102014-11-07 08:31:31 +00002457const ScopArrayInfo *
2458Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *AccessType,
Michael Kruse28468772015-09-14 15:45:33 +00002459 ArrayRef<const SCEV *> Sizes, bool IsPHI) {
Tobias Grosser92245222015-07-28 14:53:44 +00002460 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002461 if (!SAI) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002462 SAI.reset(new ScopArrayInfo(BasePtr, AccessType, getIslCtx(), Sizes, IsPHI,
2463 this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002464 } else {
2465 if (Sizes.size() > SAI->getNumberOfDimensions())
2466 SAI->updateSizes(Sizes);
2467 }
Tobias Grosserab671442015-05-23 05:58:27 +00002468 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002469}
2470
Tobias Grosser92245222015-07-28 14:53:44 +00002471const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, bool IsPHI) {
2472 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002473 assert(SAI && "No ScopArrayInfo available for this base pointer");
2474 return SAI;
2475}
2476
Tobias Grosser74394f02013-01-14 22:40:23 +00002477std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002478std::string Scop::getAssumedContextStr() const {
2479 return stringFromIslObj(AssumedContext);
2480}
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002481std::string Scop::getBoundaryContextStr() const {
2482 return stringFromIslObj(BoundaryContext);
2483}
Tobias Grosser75805372011-04-29 06:27:02 +00002484
2485std::string Scop::getNameStr() const {
2486 std::string ExitName, EntryName;
2487 raw_string_ostream ExitStr(ExitName);
2488 raw_string_ostream EntryStr(EntryName);
2489
Tobias Grosserf240b482014-01-09 10:42:15 +00002490 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002491 EntryStr.str();
2492
2493 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00002494 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002495 ExitStr.str();
2496 } else
2497 ExitName = "FunctionExit";
2498
2499 return EntryName + "---" + ExitName;
2500}
2501
Tobias Grosser74394f02013-01-14 22:40:23 +00002502__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00002503__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002504 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00002505}
2506
Tobias Grossere86109f2013-10-29 21:05:49 +00002507__isl_give isl_set *Scop::getAssumedContext() const {
2508 return isl_set_copy(AssumedContext);
2509}
2510
Johannes Doerfert43788c52015-08-20 05:58:56 +00002511__isl_give isl_set *Scop::getRuntimeCheckContext() const {
2512 isl_set *RuntimeCheckContext = getAssumedContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002513 RuntimeCheckContext =
2514 isl_set_intersect(RuntimeCheckContext, getBoundaryContext());
2515 RuntimeCheckContext = simplifyAssumptionContext(RuntimeCheckContext, *this);
Johannes Doerfert43788c52015-08-20 05:58:56 +00002516 return RuntimeCheckContext;
2517}
2518
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002519bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00002520 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002521 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00002522 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
2523 isl_set_free(RuntimeCheckContext);
2524 return IsFeasible;
2525}
2526
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002527void Scop::addAssumption(__isl_take isl_set *Set) {
2528 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00002529 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002530}
2531
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002532__isl_give isl_set *Scop::getBoundaryContext() const {
2533 return isl_set_copy(BoundaryContext);
2534}
2535
Tobias Grosser75805372011-04-29 06:27:02 +00002536void Scop::printContext(raw_ostream &OS) const {
2537 OS << "Context:\n";
2538
2539 if (!Context) {
2540 OS.indent(4) << "n/a\n\n";
2541 return;
2542 }
2543
2544 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00002545
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002546 OS.indent(4) << "Assumed Context:\n";
2547 if (!AssumedContext) {
2548 OS.indent(4) << "n/a\n\n";
2549 return;
2550 }
2551
2552 OS.indent(4) << getAssumedContextStr() << "\n";
2553
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002554 OS.indent(4) << "Boundary Context:\n";
2555 if (!BoundaryContext) {
2556 OS.indent(4) << "n/a\n\n";
2557 return;
2558 }
2559
2560 OS.indent(4) << getBoundaryContextStr() << "\n";
2561
Tobias Grosser083d3d32014-06-28 08:59:45 +00002562 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00002563 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00002564 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
2565 }
Tobias Grosser75805372011-04-29 06:27:02 +00002566}
2567
Johannes Doerfertb164c792014-09-18 11:17:17 +00002568void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002569 int noOfGroups = 0;
2570 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002571 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002572 noOfGroups += 1;
2573 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002574 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002575 }
2576
Tobias Grosserbb853c22015-07-25 12:31:03 +00002577 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00002578 if (MinMaxAliasGroups.empty()) {
2579 OS.indent(8) << "n/a\n";
2580 return;
2581 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002582
Tobias Grosserbb853c22015-07-25 12:31:03 +00002583 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002584
2585 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002586 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002587 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002588 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002589 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2590 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002591 }
2592 OS << " ]]\n";
2593 }
2594
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002595 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002596 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00002597 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002598 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002599 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2600 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002601 }
2602 OS << " ]]\n";
2603 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002604 }
2605}
2606
Tobias Grosser75805372011-04-29 06:27:02 +00002607void Scop::printStatements(raw_ostream &OS) const {
2608 OS << "Statements {\n";
2609
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002610 for (const ScopStmt &Stmt : *this)
2611 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00002612
2613 OS.indent(4) << "}\n";
2614}
2615
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002616void Scop::printArrayInfo(raw_ostream &OS) const {
2617 OS << "Arrays {\n";
2618
Tobias Grosserab671442015-05-23 05:58:27 +00002619 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002620 Array.second->print(OS);
2621
2622 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002623
2624 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
2625
2626 for (auto &Array : arrays())
2627 Array.second->print(OS, /* SizeAsPwAff */ true);
2628
2629 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002630}
2631
Tobias Grosser75805372011-04-29 06:27:02 +00002632void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00002633 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
2634 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00002635 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00002636 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002637 OS.indent(4) << "Invariant Accesses: {\n";
2638 for (const auto &IA : InvariantAccesses) {
2639 IA.first->print(OS);
2640 OS.indent(12) << "Execution Context: " << IA.second << "\n";
2641 }
2642 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00002643 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002644 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002645 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00002646 printStatements(OS.indent(4));
2647}
2648
2649void Scop::dump() const { print(dbgs()); }
2650
Tobias Grosser9a38ab82011-11-08 15:41:03 +00002651isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00002652
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002653__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
2654 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00002655}
2656
Tobias Grosser808cd692015-07-14 09:33:13 +00002657__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002658 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002659
Tobias Grosser808cd692015-07-14 09:33:13 +00002660 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002661 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002662
2663 return Domain;
2664}
2665
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002666__isl_give isl_union_map *Scop::getMustWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002667 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002668
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002669 for (ScopStmt &Stmt : *this) {
2670 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002671 if (!MA->isMustWrite())
2672 continue;
2673
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002674 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002675 isl_map *AccessDomain = MA->getAccessRelation();
2676 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2677 Write = isl_union_map_add_map(Write, AccessDomain);
2678 }
2679 }
2680 return isl_union_map_coalesce(Write);
2681}
2682
2683__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002684 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002685
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002686 for (ScopStmt &Stmt : *this) {
2687 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002688 if (!MA->isMayWrite())
2689 continue;
2690
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002691 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002692 isl_map *AccessDomain = MA->getAccessRelation();
2693 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2694 Write = isl_union_map_add_map(Write, AccessDomain);
2695 }
2696 }
2697 return isl_union_map_coalesce(Write);
2698}
2699
Tobias Grosser37eb4222014-02-20 21:43:54 +00002700__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002701 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002702
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002703 for (ScopStmt &Stmt : *this) {
2704 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002705 if (!MA->isWrite())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002706 continue;
2707
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002708 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002709 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002710 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2711 Write = isl_union_map_add_map(Write, AccessDomain);
2712 }
2713 }
2714 return isl_union_map_coalesce(Write);
2715}
2716
2717__isl_give isl_union_map *Scop::getReads() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002718 isl_union_map *Read = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002719
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002720 for (ScopStmt &Stmt : *this) {
2721 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002722 if (!MA->isRead())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002723 continue;
2724
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002725 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002726 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002727
2728 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2729 Read = isl_union_map_add_map(Read, AccessDomain);
2730 }
2731 }
2732 return isl_union_map_coalesce(Read);
2733}
2734
Tobias Grosser808cd692015-07-14 09:33:13 +00002735__isl_give isl_union_map *Scop::getSchedule() const {
2736 auto Tree = getScheduleTree();
2737 auto S = isl_schedule_get_map(Tree);
2738 isl_schedule_free(Tree);
2739 return S;
2740}
Tobias Grosser37eb4222014-02-20 21:43:54 +00002741
Tobias Grosser808cd692015-07-14 09:33:13 +00002742__isl_give isl_schedule *Scop::getScheduleTree() const {
2743 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
2744 getDomains());
2745}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002746
Tobias Grosser808cd692015-07-14 09:33:13 +00002747void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
2748 auto *S = isl_schedule_from_domain(getDomains());
2749 S = isl_schedule_insert_partial_schedule(
2750 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
2751 isl_schedule_free(Schedule);
2752 Schedule = S;
2753}
2754
2755void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
2756 isl_schedule_free(Schedule);
2757 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00002758}
2759
2760bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
2761 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002762 for (ScopStmt &Stmt : *this) {
2763 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002764 isl_union_set *NewStmtDomain = isl_union_set_intersect(
2765 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
2766
2767 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
2768 isl_union_set_free(StmtDomain);
2769 isl_union_set_free(NewStmtDomain);
2770 continue;
2771 }
2772
2773 Changed = true;
2774
2775 isl_union_set_free(StmtDomain);
2776 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
2777
2778 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002779 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002780 isl_union_set_free(NewStmtDomain);
2781 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002782 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002783 }
2784 isl_union_set_free(Domain);
2785 return Changed;
2786}
2787
Tobias Grosser75805372011-04-29 06:27:02 +00002788ScalarEvolution *Scop::getSE() const { return SE; }
2789
Johannes Doerfertf5673802015-10-01 23:48:18 +00002790bool Scop::isIgnored(RegionNode *RN) {
2791 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser75805372011-04-29 06:27:02 +00002792
Johannes Doerfertf5673802015-10-01 23:48:18 +00002793 // Check if there are accesses contained.
2794 bool ContainsAccesses = false;
2795 if (!RN->isSubRegion())
2796 ContainsAccesses = getAccessFunctions(BB);
2797 else
2798 for (BasicBlock *RBB : RN->getNodeAs<Region>()->blocks())
2799 ContainsAccesses |= (getAccessFunctions(RBB) != nullptr);
2800 if (!ContainsAccesses)
2801 return true;
2802
2803 // Check for reachability via non-error blocks.
2804 if (!DomainMap.count(BB))
2805 return true;
2806
2807 // Check if error blocks are contained.
2808 if (containsErrorBlock(RN))
2809 return true;
2810
2811 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00002812}
2813
Tobias Grosser808cd692015-07-14 09:33:13 +00002814struct MapToDimensionDataTy {
2815 int N;
2816 isl_union_pw_multi_aff *Res;
2817};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002818
Tobias Grosser808cd692015-07-14 09:33:13 +00002819// @brief Create a function that maps the elements of 'Set' to its N-th
2820// dimension.
2821//
2822// The result is added to 'User->Res'.
2823//
2824// @param Set The input set.
2825// @param N The dimension to map to.
2826//
2827// @returns Zero if no error occurred, non-zero otherwise.
2828static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
2829 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
2830 int Dim;
2831 isl_space *Space;
2832 isl_pw_multi_aff *PMA;
2833
2834 Dim = isl_set_dim(Set, isl_dim_set);
2835 Space = isl_set_get_space(Set);
2836 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
2837 Dim - Data->N);
2838 if (Data->N > 1)
2839 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
2840 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
2841
2842 isl_set_free(Set);
2843
2844 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002845}
2846
Tobias Grosser808cd692015-07-14 09:33:13 +00002847// @brief Create a function that maps the elements of Domain to their Nth
2848// dimension.
2849//
2850// @param Domain The set of elements to map.
2851// @param N The dimension to map to.
2852static __isl_give isl_multi_union_pw_aff *
2853mapToDimension(__isl_take isl_union_set *Domain, int N) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002854 if (N <= 0 || isl_union_set_is_empty(Domain)) {
2855 isl_union_set_free(Domain);
2856 return nullptr;
2857 }
2858
Tobias Grosser808cd692015-07-14 09:33:13 +00002859 struct MapToDimensionDataTy Data;
2860 isl_space *Space;
2861
2862 Space = isl_union_set_get_space(Domain);
2863 Data.N = N;
2864 Data.Res = isl_union_pw_multi_aff_empty(Space);
2865 if (isl_union_set_foreach_set(Domain, &mapToDimension_AddSet, &Data) < 0)
2866 Data.Res = isl_union_pw_multi_aff_free(Data.Res);
2867
2868 isl_union_set_free(Domain);
2869 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
2870}
2871
Michael Kruse9d080092015-09-11 21:41:48 +00002872ScopStmt *Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00002873 ScopStmt *Stmt;
2874 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00002875 Stmts.emplace_back(*this, *BB);
Tobias Grosser808cd692015-07-14 09:33:13 +00002876 Stmt = &Stmts.back();
2877 StmtMap[BB] = Stmt;
2878 } else {
2879 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00002880 Stmts.emplace_back(*this, *R);
Tobias Grosser808cd692015-07-14 09:33:13 +00002881 Stmt = &Stmts.back();
2882 for (BasicBlock *BB : R->blocks())
2883 StmtMap[BB] = Stmt;
2884 }
2885 return Stmt;
2886}
2887
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002888void Scop::buildSchedule(
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002889 Region *R, LoopInfo &LI,
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002890 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> &LoopSchedules) {
Michael Kruse046dde42015-08-10 13:01:57 +00002891
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002892 if (SD.isNonAffineSubRegion(R, &getRegion())) {
Johannes Doerfertc6987c12015-09-26 13:41:43 +00002893 Loop *L = getLoopSurroundingRegion(*R, LI);
2894 auto &LSchedulePair = LoopSchedules[L];
Michael Krusecac948e2015-10-02 13:53:07 +00002895 ScopStmt *Stmt = getStmtForBasicBlock(R->getEntry());
Michael Kruseafe06702015-10-02 16:33:27 +00002896 isl_set *Domain = Stmt->getDomain();
Michael Krusecac948e2015-10-02 13:53:07 +00002897 auto *UDomain = isl_union_set_from_set(Domain);
2898 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002899 LSchedulePair.first = StmtSchedule;
2900 return;
2901 }
2902
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002903 ReversePostOrderTraversal<Region *> RTraversal(R);
2904 for (auto *RN : RTraversal) {
Michael Kruse046dde42015-08-10 13:01:57 +00002905
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002906 if (RN->isSubRegion()) {
2907 Region *SubRegion = RN->getNodeAs<Region>();
2908 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert478a7de2015-10-02 13:09:31 +00002909 buildSchedule(SubRegion, LI, LoopSchedules);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002910 continue;
2911 }
Tobias Grosser75805372011-04-29 06:27:02 +00002912 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002913
2914 Loop *L = getRegionNodeLoop(RN, LI);
2915 int LD = getRelativeLoopDepth(L);
2916 auto &LSchedulePair = LoopSchedules[L];
2917 LSchedulePair.second += getNumBlocksInRegionNode(RN);
2918
Michael Krusecac948e2015-10-02 13:53:07 +00002919 BasicBlock *BB = getRegionNodeBasicBlock(RN);
2920 ScopStmt *Stmt = getStmtForBasicBlock(BB);
2921 if (Stmt) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002922 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
2923 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
2924 LSchedulePair.first =
2925 combineInSequence(LSchedulePair.first, StmtSchedule);
2926 }
2927
2928 unsigned NumVisited = LSchedulePair.second;
2929 while (L && NumVisited == L->getNumBlocks()) {
2930 auto *LDomain = isl_schedule_get_domain(LSchedulePair.first);
2931 if (auto *MUPA = mapToDimension(LDomain, LD + 1))
2932 LSchedulePair.first =
2933 isl_schedule_insert_partial_schedule(LSchedulePair.first, MUPA);
2934
2935 auto *PL = L->getParentLoop();
2936 assert(LoopSchedules.count(PL));
2937 auto &PSchedulePair = LoopSchedules[PL];
2938 PSchedulePair.first =
2939 combineInSequence(PSchedulePair.first, LSchedulePair.first);
2940 PSchedulePair.second += NumVisited;
2941
2942 L = PL;
2943 NumVisited = PSchedulePair.second;
2944 }
Tobias Grosser808cd692015-07-14 09:33:13 +00002945 }
Tobias Grosser75805372011-04-29 06:27:02 +00002946}
2947
Johannes Doerfert7c494212014-10-31 23:13:39 +00002948ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00002949 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00002950 if (StmtMapIt == StmtMap.end())
2951 return nullptr;
2952 return StmtMapIt->second;
2953}
2954
Johannes Doerfert96425c22015-08-30 21:13:53 +00002955int Scop::getRelativeLoopDepth(const Loop *L) const {
2956 Loop *OuterLoop =
2957 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
2958 if (!OuterLoop)
2959 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00002960 return L->getLoopDepth() - OuterLoop->getLoopDepth();
2961}
2962
Michael Krused868b5d2015-09-10 15:25:24 +00002963void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00002964 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002965
2966 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
2967 // true, are not modeled as ordinary PHI nodes as they are not part of the
2968 // region. However, we model the operands in the predecessor blocks that are
2969 // part of the region as regular scalar accesses.
2970
2971 // If we can synthesize a PHI we can skip it, however only if it is in
2972 // the region. If it is not it can only be in the exit block of the region.
2973 // In this case we model the operands but not the PHI itself.
2974 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
2975 return;
2976
2977 // PHI nodes are modeled as if they had been demoted prior to the SCoP
2978 // detection. Hence, the PHI is a load of a new memory location in which the
2979 // incoming value was written at the end of the incoming basic block.
2980 bool OnlyNonAffineSubRegionOperands = true;
2981 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
2982 Value *Op = PHI->getIncomingValue(u);
2983 BasicBlock *OpBB = PHI->getIncomingBlock(u);
2984
2985 // Do not build scalar dependences inside a non-affine subregion.
2986 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
2987 continue;
2988
2989 OnlyNonAffineSubRegionOperands = false;
2990
2991 if (!R.contains(OpBB))
2992 continue;
2993
2994 Instruction *OpI = dyn_cast<Instruction>(Op);
2995 if (OpI) {
2996 BasicBlock *OpIBB = OpI->getParent();
2997 // As we pretend there is a use (or more precise a write) of OpI in OpBB
2998 // we have to insert a scalar dependence from the definition of OpI to
2999 // OpBB if the definition is not in OpBB.
3000 if (OpIBB != OpBB) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003001 addScalarReadAccess(OpI, PHI, OpBB);
3002 addScalarWriteAccess(OpI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003003 }
Tobias Grosserda95a4a2015-09-24 20:59:59 +00003004 } else if (ModelReadOnlyScalars && !isa<Constant>(Op)) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003005 addScalarReadAccess(Op, PHI, OpBB);
Michael Kruse7bf39442015-09-10 12:46:52 +00003006 }
3007
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003008 addPHIWriteAccess(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003009 }
3010
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003011 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3012 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003013 }
3014}
3015
Michael Krused868b5d2015-09-10 15:25:24 +00003016bool ScopInfo::buildScalarDependences(Instruction *Inst, Region *R,
3017 Region *NonAffineSubRegion) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003018 bool canSynthesizeInst = canSynthesize(Inst, LI, SE, R);
3019 if (isIgnoredIntrinsic(Inst))
3020 return false;
3021
3022 bool AnyCrossStmtUse = false;
3023 BasicBlock *ParentBB = Inst->getParent();
3024
3025 for (User *U : Inst->users()) {
3026 Instruction *UI = dyn_cast<Instruction>(U);
3027
3028 // Ignore the strange user
3029 if (UI == 0)
3030 continue;
3031
3032 BasicBlock *UseParent = UI->getParent();
3033
3034 // Ignore the users in the same BB (statement)
3035 if (UseParent == ParentBB)
3036 continue;
3037
3038 // Do not build scalar dependences inside a non-affine subregion.
3039 if (NonAffineSubRegion && NonAffineSubRegion->contains(UseParent))
3040 continue;
3041
3042 // Check whether or not the use is in the SCoP.
3043 if (!R->contains(UseParent)) {
3044 AnyCrossStmtUse = true;
3045 continue;
3046 }
3047
3048 // If the instruction can be synthesized and the user is in the region
3049 // we do not need to add scalar dependences.
3050 if (canSynthesizeInst)
3051 continue;
3052
3053 // No need to translate these scalar dependences into polyhedral form,
3054 // because synthesizable scalars can be generated by the code generator.
3055 if (canSynthesize(UI, LI, SE, R))
3056 continue;
3057
3058 // Skip PHI nodes in the region as they handle their operands on their own.
3059 if (isa<PHINode>(UI))
3060 continue;
3061
3062 // Now U is used in another statement.
3063 AnyCrossStmtUse = true;
3064
3065 // Do not build a read access that is not in the current SCoP
Michael Krusee2bccbb2015-09-18 19:59:43 +00003066 // Use the def instruction as base address of the MemoryAccess, so that it
3067 // will become the name of the scalar access in the polyhedral form.
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003068 addScalarReadAccess(Inst, UI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003069 }
3070
Tobias Grosserda95a4a2015-09-24 20:59:59 +00003071 if (ModelReadOnlyScalars && !isa<PHINode>(Inst)) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003072 for (Value *Op : Inst->operands()) {
3073 if (canSynthesize(Op, LI, SE, R))
3074 continue;
3075
3076 if (Instruction *OpInst = dyn_cast<Instruction>(Op))
3077 if (R->contains(OpInst))
3078 continue;
3079
3080 if (isa<Constant>(Op))
3081 continue;
3082
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003083 addScalarReadAccess(Op, Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003084 }
3085 }
3086
3087 return AnyCrossStmtUse;
3088}
3089
3090extern MapInsnToMemAcc InsnToMemAcc;
3091
Michael Krusee2bccbb2015-09-18 19:59:43 +00003092void ScopInfo::buildMemoryAccess(
3093 Instruction *Inst, Loop *L, Region *R,
3094 const ScopDetection::BoxedLoopsSetTy *BoxedLoops) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003095 unsigned Size;
3096 Type *SizeType;
3097 Value *Val;
Michael Krusee2bccbb2015-09-18 19:59:43 +00003098 enum MemoryAccess::AccessType Type;
Michael Kruse7bf39442015-09-10 12:46:52 +00003099
3100 if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
3101 SizeType = Load->getType();
3102 Size = TD->getTypeStoreSize(SizeType);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003103 Type = MemoryAccess::READ;
Michael Kruse7bf39442015-09-10 12:46:52 +00003104 Val = Load;
3105 } else {
3106 StoreInst *Store = cast<StoreInst>(Inst);
3107 SizeType = Store->getValueOperand()->getType();
3108 Size = TD->getTypeStoreSize(SizeType);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003109 Type = MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003110 Val = Store->getValueOperand();
3111 }
3112
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003113 auto Address = getPointerOperand(*Inst);
3114
3115 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003116 const SCEVUnknown *BasePointer =
3117 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3118
3119 assert(BasePointer && "Could not find base pointer");
3120 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
3121
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003122 if (isa<GetElementPtrInst>(Address) || isa<BitCastInst>(Address)) {
3123 auto NewAddress = Address;
3124 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
3125 auto Src = BitCast->getOperand(0);
3126 auto SrcTy = Src->getType();
3127 auto DstTy = BitCast->getType();
3128 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3129 NewAddress = Src;
3130 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003131
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003132 if (auto *GEP = dyn_cast<GetElementPtrInst>(NewAddress)) {
3133 std::vector<const SCEV *> Subscripts;
3134 std::vector<int> Sizes;
3135 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
3136 auto BasePtr = GEP->getOperand(0);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003137
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003138 std::vector<const SCEV *> SizesSCEV;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003139
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003140 bool AllAffineSubcripts = true;
3141 for (auto Subscript : Subscripts)
3142 if (!isAffineExpr(R, Subscript, *SE)) {
3143 AllAffineSubcripts = false;
3144 break;
3145 }
3146
3147 if (AllAffineSubcripts && Sizes.size() > 0) {
3148 for (auto V : Sizes)
3149 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
3150 IntegerType::getInt64Ty(BasePtr->getContext()), V)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003151 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003152 IntegerType::getInt64Ty(BasePtr->getContext()), Size)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003153
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003154 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, true,
3155 Subscripts, SizesSCEV, Val);
Tobias Grosserb1c39422015-09-21 16:19:25 +00003156 return;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003157 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003158 }
3159 }
3160
Michael Kruse7bf39442015-09-10 12:46:52 +00003161 auto AccItr = InsnToMemAcc.find(Inst);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003162 if (PollyDelinearize && AccItr != InsnToMemAcc.end()) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003163 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, true,
3164 AccItr->second.DelinearizedSubscripts,
3165 AccItr->second.Shape->DelinearizedSizes, Val);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003166 return;
3167 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003168
3169 // Check if the access depends on a loop contained in a non-affine subregion.
3170 bool isVariantInNonAffineLoop = false;
3171 if (BoxedLoops) {
3172 SetVector<const Loop *> Loops;
3173 findLoops(AccessFunction, Loops);
3174 for (const Loop *L : Loops)
3175 if (BoxedLoops->count(L))
3176 isVariantInNonAffineLoop = true;
3177 }
3178
3179 bool IsAffine = !isVariantInNonAffineLoop &&
3180 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue());
3181
Michael Krusecaac2b62015-09-26 15:51:44 +00003182 // FIXME: Size of the number of bytes of an array element, not the number of
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003183 // elements as probably intended here.
Tobias Grossera43b6e92015-09-27 17:54:50 +00003184 const SCEV *SizeSCEV =
3185 SE->getConstant(TD->getIntPtrType(Inst->getContext()), Size);
Michael Kruse7bf39442015-09-10 12:46:52 +00003186
Michael Krusee2bccbb2015-09-18 19:59:43 +00003187 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
3188 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003189
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003190 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, IsAffine,
3191 ArrayRef<const SCEV *>(AccessFunction),
3192 ArrayRef<const SCEV *>(SizeSCEV), Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00003193}
3194
Michael Krused868b5d2015-09-10 15:25:24 +00003195void ScopInfo::buildAccessFunctions(Region &R, Region &SR) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003196
3197 if (SD->isNonAffineSubRegion(&SR, &R)) {
3198 for (BasicBlock *BB : SR.blocks())
3199 buildAccessFunctions(R, *BB, &SR);
3200 return;
3201 }
3202
3203 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
3204 if (I->isSubRegion())
3205 buildAccessFunctions(R, *I->getNodeAs<Region>());
3206 else
3207 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>());
3208}
3209
Michael Krusecac948e2015-10-02 13:53:07 +00003210void ScopInfo::buildStmts(Region &SR) {
3211 Region *R = getRegion();
3212
3213 if (SD->isNonAffineSubRegion(&SR, R)) {
3214 scop->addScopStmt(nullptr, &SR);
3215 return;
3216 }
3217
3218 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
3219 if (I->isSubRegion())
3220 buildStmts(*I->getNodeAs<Region>());
3221 else
3222 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
3223}
3224
Michael Krused868b5d2015-09-10 15:25:24 +00003225void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
3226 Region *NonAffineSubRegion,
3227 bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003228 Loop *L = LI->getLoopFor(&BB);
3229
3230 // The set of loops contained in non-affine subregions that are part of R.
3231 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
3232
3233 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I) {
3234 Instruction *Inst = I;
3235
3236 PHINode *PHI = dyn_cast<PHINode>(Inst);
3237 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00003238 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003239
3240 // For the exit block we stop modeling after the last PHI node.
3241 if (!PHI && IsExitBlock)
3242 break;
3243
3244 if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
Michael Krusee2bccbb2015-09-18 19:59:43 +00003245 buildMemoryAccess(Inst, L, &R, BoxedLoops);
Michael Kruse7bf39442015-09-10 12:46:52 +00003246
3247 if (isIgnoredIntrinsic(Inst))
3248 continue;
3249
3250 if (buildScalarDependences(Inst, &R, NonAffineSubRegion)) {
Michael Krusee2bccbb2015-09-18 19:59:43 +00003251 if (!isa<StoreInst>(Inst))
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003252 addScalarWriteAccess(Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003253 }
3254 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00003255}
Michael Kruse7bf39442015-09-10 12:46:52 +00003256
Michael Kruse2d0ece92015-09-24 11:41:21 +00003257void ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
3258 MemoryAccess::AccessType Type,
3259 Value *BaseAddress, unsigned ElemBytes,
3260 bool Affine, Value *AccessValue,
3261 ArrayRef<const SCEV *> Subscripts,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003262 ArrayRef<const SCEV *> Sizes,
3263 MemoryAccess::AccessOrigin Origin) {
Michael Krusecac948e2015-10-02 13:53:07 +00003264 ScopStmt *Stmt = scop->getStmtForBasicBlock(BB);
3265
3266 // Do not create a memory access for anything not in the SCoP. It would be
3267 // ignored anyway.
3268 if (!Stmt)
3269 return;
3270
Michael Krusee2bccbb2015-09-18 19:59:43 +00003271 AccFuncSetType &AccList = AccFuncMap[BB];
3272 size_t Identifier = AccList.size();
Michael Kruse7bf39442015-09-10 12:46:52 +00003273
Michael Krusee2bccbb2015-09-18 19:59:43 +00003274 Value *BaseAddr = BaseAddress;
3275 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
3276
3277 std::string IdName = "__polly_array_ref_" + std::to_string(Identifier);
3278 isl_id *Id = isl_id_alloc(ctx, IdName.c_str(), nullptr);
3279
Michael Krusecac948e2015-10-02 13:53:07 +00003280 bool isApproximated =
3281 Stmt->isRegionStmt() && (Stmt->getRegion()->getEntry() != BB);
3282 if (isApproximated && Type == MemoryAccess::MUST_WRITE)
3283 Type = MemoryAccess::MAY_WRITE;
3284
3285 AccList.emplace_back(Stmt, Inst, Id, Type, BaseAddress, ElemBytes, Affine,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003286 Subscripts, Sizes, AccessValue, Origin, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00003287 Stmt->addAccess(&AccList.back());
Michael Kruse7bf39442015-09-10 12:46:52 +00003288}
3289
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003290void ScopInfo::addExplicitAccess(
3291 Instruction *MemAccInst, MemoryAccess::AccessType Type, Value *BaseAddress,
3292 unsigned ElemBytes, bool IsAffine, ArrayRef<const SCEV *> Subscripts,
3293 ArrayRef<const SCEV *> Sizes, Value *AccessValue) {
3294 assert(isa<LoadInst>(MemAccInst) || isa<StoreInst>(MemAccInst));
3295 assert(isa<LoadInst>(MemAccInst) == (Type == MemoryAccess::READ));
3296 addMemoryAccess(MemAccInst->getParent(), MemAccInst, Type, BaseAddress,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003297 ElemBytes, IsAffine, AccessValue, Subscripts, Sizes,
3298 MemoryAccess::EXPLICIT);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003299}
3300void ScopInfo::addScalarWriteAccess(Instruction *Value) {
3301 addMemoryAccess(Value->getParent(), Value, MemoryAccess::MUST_WRITE, Value, 1,
3302 true, Value, ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003303 ArrayRef<const SCEV *>(), MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003304}
3305void ScopInfo::addScalarReadAccess(Value *Value, Instruction *User) {
3306 assert(!isa<PHINode>(User));
3307 addMemoryAccess(User->getParent(), User, MemoryAccess::READ, Value, 1, true,
3308 Value, ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003309 MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003310}
3311void ScopInfo::addScalarReadAccess(Value *Value, PHINode *User,
3312 BasicBlock *UserBB) {
3313 addMemoryAccess(UserBB, User, MemoryAccess::READ, Value, 1, true, Value,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003314 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
3315 MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003316}
3317void ScopInfo::addPHIWriteAccess(PHINode *PHI, BasicBlock *IncomingBlock,
3318 Value *IncomingValue, bool IsExitBlock) {
3319 addMemoryAccess(IncomingBlock, IncomingBlock->getTerminator(),
3320 MemoryAccess::MUST_WRITE, PHI, 1, true, IncomingValue,
3321 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003322 IsExitBlock ? MemoryAccess::SCALAR : MemoryAccess::PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003323}
3324void ScopInfo::addPHIReadAccess(PHINode *PHI) {
3325 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI, 1, true, PHI,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003326 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
3327 MemoryAccess::PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003328}
3329
Michael Kruse76e924d2015-09-30 09:16:07 +00003330void ScopInfo::buildScop(Region &R, DominatorTree &DT) {
Michael Kruse9d080092015-09-11 21:41:48 +00003331 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Johannes Doerfert478a7de2015-10-02 13:09:31 +00003332 scop = new Scop(R, AccFuncMap, *SD, *SE, DT, ctx, MaxLoopDepth);
Michael Kruse7bf39442015-09-10 12:46:52 +00003333
Michael Krusecac948e2015-10-02 13:53:07 +00003334 buildStmts(R);
Michael Kruse7bf39442015-09-10 12:46:52 +00003335 buildAccessFunctions(R, R);
3336
3337 // In case the region does not have an exiting block we will later (during
3338 // code generation) split the exit block. This will move potential PHI nodes
3339 // from the current exit block into the new region exiting block. Hence, PHI
3340 // nodes that are at this point not part of the region will be.
3341 // To handle these PHI nodes later we will now model their operands as scalar
3342 // accesses. Note that we do not model anything in the exit block if we have
3343 // an exiting block in the region, as there will not be any splitting later.
3344 if (!R.getExitingBlock())
3345 buildAccessFunctions(R, *R.getExit(), nullptr, /* IsExitBlock */ true);
3346
Johannes Doerfert478a7de2015-10-02 13:09:31 +00003347 scop->init(*LI, *AA);
Michael Kruse7bf39442015-09-10 12:46:52 +00003348}
3349
Michael Krused868b5d2015-09-10 15:25:24 +00003350void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00003351 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00003352 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00003353 return;
3354 }
3355
Michael Kruse9d080092015-09-11 21:41:48 +00003356 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00003357}
3358
Michael Krused868b5d2015-09-10 15:25:24 +00003359void ScopInfo::clear() {
Michael Kruse7bf39442015-09-10 12:46:52 +00003360 AccFuncMap.clear();
Michael Krused868b5d2015-09-10 15:25:24 +00003361 if (scop) {
3362 delete scop;
3363 scop = 0;
3364 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003365}
3366
3367//===----------------------------------------------------------------------===//
Michael Kruse9d080092015-09-11 21:41:48 +00003368ScopInfo::ScopInfo() : RegionPass(ID), scop(0) {
Tobias Grosserb76f38532011-08-20 11:11:25 +00003369 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00003370 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00003371}
3372
3373ScopInfo::~ScopInfo() {
3374 clear();
3375 isl_ctx_free(ctx);
3376}
3377
Tobias Grosser75805372011-04-29 06:27:02 +00003378void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Michael Krused868b5d2015-09-10 15:25:24 +00003379 AU.addRequiredID(IndependentBlocksID);
Chandler Carruthf5579872015-01-17 14:16:56 +00003380 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00003381 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00003382 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00003383 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
3384 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00003385 AU.addRequired<AAResultsWrapperPass>();
Tobias Grosser75805372011-04-29 06:27:02 +00003386 AU.setPreservesAll();
3387}
3388
3389bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00003390 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00003391
Michael Krused868b5d2015-09-10 15:25:24 +00003392 if (!SD->isMaxRegionInScop(*R))
3393 return false;
3394
3395 Function *F = R->getEntry()->getParent();
3396 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
3397 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
3398 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
3399 TD = &F->getParent()->getDataLayout();
3400 DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Krused868b5d2015-09-10 15:25:24 +00003401
Michael Kruse76e924d2015-09-30 09:16:07 +00003402 buildScop(*R, DT);
Tobias Grosser75805372011-04-29 06:27:02 +00003403
Tobias Grosserd6a50b32015-05-30 06:26:21 +00003404 DEBUG(scop->print(dbgs()));
3405
Michael Kruseafe06702015-10-02 16:33:27 +00003406 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert43788c52015-08-20 05:58:56 +00003407 delete scop;
3408 scop = nullptr;
3409 return false;
3410 }
3411
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003412 // Statistics.
3413 ++ScopFound;
3414 if (scop->getMaxLoopDepth() > 0)
3415 ++RichScopFound;
Tobias Grosser75805372011-04-29 06:27:02 +00003416 return false;
3417}
3418
3419char ScopInfo::ID = 0;
3420
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003421Pass *polly::createScopInfoPass() { return new ScopInfo(); }
3422
Tobias Grosser73600b82011-10-08 00:30:40 +00003423INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
3424 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003425 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00003426INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Chandler Carruthf5579872015-01-17 14:16:56 +00003427INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00003428INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00003429INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003430INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00003431INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00003432INITIALIZE_PASS_END(ScopInfo, "polly-scops",
3433 "Polly - Create polyhedral description of Scops", false,
3434 false)