blob: 31c85f6a19e1b134bcecc08789500484d9571390 [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 Krusee2bccbb2015-09-18 19:59:43 +0000648MemoryAccess::MemoryAccess(Instruction *AccessInst, __isl_take isl_id *Id,
649 AccessType Type, Value *BaseAddress,
Michael Kruse2d0ece92015-09-24 11:41:21 +0000650 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)
654 : Id(Id), Origin(Origin), AccType(Type), RedType(RT_NONE),
655 Statement(nullptr), BaseAddr(BaseAddress), BaseName(BaseName),
656 ElemBytes(ElemBytes), Sizes(Sizes.begin(), Sizes.end()),
657 AccessInstruction(AccessInst), 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 Kruse9d080092015-09-11 21:41:48 +0000823void ScopStmt::buildAccesses(BasicBlock *Block, bool isApproximated) {
824 AccFuncSetType *AFS = Parent.getAccessFunctions(Block);
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000825 if (!AFS)
826 return;
827
Michael Krusee2bccbb2015-09-18 19:59:43 +0000828 for (auto &Access : *AFS) {
829 Instruction *AccessInst = Access.getAccessInstruction();
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000830 Type *ElementType = Access.getAccessValue()->getType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000831
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000832 const ScopArrayInfo *SAI = getParent()->getOrCreateScopArrayInfo(
Michael Krusee2bccbb2015-09-18 19:59:43 +0000833 Access.getBaseAddr(), ElementType, Access.Sizes, Access.isPHI());
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000834
Michael Krusee2bccbb2015-09-18 19:59:43 +0000835 if (isApproximated && Access.isMustWrite())
836 Access.AccType = MemoryAccess::MAY_WRITE;
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000837
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000838 MemoryAccessList *&MAL = InstructionToAccess[AccessInst];
839 if (!MAL)
840 MAL = new MemoryAccessList();
Michael Krusee2bccbb2015-09-18 19:59:43 +0000841 Access.setStatement(this);
842 Access.buildAccessRelation(SAI);
843 MAL->emplace_front(&Access);
844 MemAccs.push_back(MAL->front());
Tobias Grosser75805372011-04-29 06:27:02 +0000845 }
846}
847
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000848void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000849 for (MemoryAccess *MA : *this)
850 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000851
852 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000853}
854
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000855/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
856static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
857 void *User) {
858 isl_set **BoundedParts = static_cast<isl_set **>(User);
859 if (isl_basic_set_is_bounded(BSet))
860 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
861 else
862 isl_basic_set_free(BSet);
863 return isl_stat_ok;
864}
865
866/// @brief Return the bounded parts of @p S.
867static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
868 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
869 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
870 isl_set_free(S);
871 return BoundedParts;
872}
873
874/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
875///
876/// @returns A separation of @p S into first an unbounded then a bounded subset,
877/// both with regards to the dimension @p Dim.
878static std::pair<__isl_give isl_set *, __isl_give isl_set *>
879partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
880
881 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000882 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000883
884 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000885 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000886
887 // Remove dimensions that are greater than Dim as they are not interesting.
888 assert(NumDimsS >= Dim + 1);
889 OnlyDimS =
890 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
891
892 // Create artificial parametric upper bounds for dimensions smaller than Dim
893 // as we are not interested in them.
894 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
895 for (unsigned u = 0; u < Dim; u++) {
896 isl_constraint *C = isl_inequality_alloc(
897 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
898 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
899 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
900 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
901 }
902
903 // Collect all bounded parts of OnlyDimS.
904 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
905
906 // Create the dimensions greater than Dim again.
907 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
908 NumDimsS - Dim - 1);
909
910 // Remove the artificial upper bound parameters again.
911 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
912
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +0000913 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000914 return std::make_pair(UnboundedParts, BoundedParts);
915}
916
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000917/// @brief Set the dimension Ids from @p From in @p To.
918static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
919 __isl_take isl_set *To) {
920 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
921 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
922 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
923 }
924 return To;
925}
926
927/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000928static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000929 __isl_take isl_pw_aff *L,
930 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +0000931 switch (Pred) {
932 case ICmpInst::ICMP_EQ:
933 return isl_pw_aff_eq_set(L, R);
934 case ICmpInst::ICMP_NE:
935 return isl_pw_aff_ne_set(L, R);
936 case ICmpInst::ICMP_SLT:
937 return isl_pw_aff_lt_set(L, R);
938 case ICmpInst::ICMP_SLE:
939 return isl_pw_aff_le_set(L, R);
940 case ICmpInst::ICMP_SGT:
941 return isl_pw_aff_gt_set(L, R);
942 case ICmpInst::ICMP_SGE:
943 return isl_pw_aff_ge_set(L, R);
944 case ICmpInst::ICMP_ULT:
945 return isl_pw_aff_lt_set(L, R);
946 case ICmpInst::ICMP_UGT:
947 return isl_pw_aff_gt_set(L, R);
948 case ICmpInst::ICMP_ULE:
949 return isl_pw_aff_le_set(L, R);
950 case ICmpInst::ICMP_UGE:
951 return isl_pw_aff_ge_set(L, R);
952 default:
953 llvm_unreachable("Non integer predicate not supported");
954 }
955}
956
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000957/// @brief Create the conditions under which @p L @p Pred @p R is true.
958///
959/// Helper function that will make sure the dimensions of the result have the
960/// same isl_id's as the @p Domain.
961static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
962 __isl_take isl_pw_aff *L,
963 __isl_take isl_pw_aff *R,
964 __isl_keep isl_set *Domain) {
965 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
966 return setDimensionIds(Domain, ConsequenceCondSet);
967}
968
969/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000970///
971/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000972/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
973/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +0000974static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000975buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +0000976 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
977
Johannes Doerfert9a132f32015-09-28 09:33:22 +0000978 Value *Condition = getConditionFromTerminator(SI);
979 assert(Condition && "No condition for switch");
980
981 ScalarEvolution &SE = *S.getSE();
982 BasicBlock *BB = SI->getParent();
983 isl_pw_aff *LHS, *RHS;
984 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
985
986 unsigned NumSuccessors = SI->getNumSuccessors();
987 ConditionSets.resize(NumSuccessors);
988 for (auto &Case : SI->cases()) {
989 unsigned Idx = Case.getSuccessorIndex();
990 ConstantInt *CaseValue = Case.getCaseValue();
991
992 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
993 isl_set *CaseConditionSet =
994 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
995 ConditionSets[Idx] = isl_set_coalesce(
996 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
997 }
998
999 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1000 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1001 for (unsigned u = 2; u < NumSuccessors; u++)
1002 ConditionSetUnion =
1003 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1004 ConditionSets[0] = setDimensionIds(
1005 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1006
1007 S.markAsOptimized();
1008 isl_pw_aff_free(LHS);
1009}
1010
1011/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1012///
1013/// This will fill @p ConditionSets with the conditions under which control
1014/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1015/// have as many elements as @p TI has successors.
1016static void
1017buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1018 __isl_keep isl_set *Domain,
1019 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1020
1021 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1022 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1023
1024 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1025
1026 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001027 ConditionSets.push_back(isl_set_copy(Domain));
1028 return;
1029 }
1030
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001031 Value *Condition = getConditionFromTerminator(TI);
1032 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001033
1034 isl_set *ConsequenceCondSet = nullptr;
1035 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1036 if (CCond->isZero())
1037 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1038 else
1039 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1040 } else {
1041 auto *ICond = dyn_cast<ICmpInst>(Condition);
1042 assert(ICond &&
1043 "Condition of exiting branch was neither constant nor ICmp!");
1044
1045 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001046 BasicBlock *BB = TI->getParent();
Johannes Doerfert96425c22015-08-30 21:13:53 +00001047 isl_pw_aff *LHS, *RHS;
Johannes Doerfertcef616f2015-09-15 22:49:04 +00001048 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1049 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001050 ConsequenceCondSet =
1051 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001052 }
1053
1054 assert(ConsequenceCondSet);
1055 isl_set *AlternativeCondSet =
1056 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1057
1058 ConditionSets.push_back(isl_set_coalesce(
1059 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1060 ConditionSets.push_back(isl_set_coalesce(
1061 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1062}
1063
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001064void ScopStmt::buildDomain() {
Tobias Grosser084d8f72012-05-29 09:29:44 +00001065 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +00001066
Tobias Grosser084d8f72012-05-29 09:29:44 +00001067 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1068
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001069 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001070 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001071}
1072
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001073void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001074 isl_ctx *Ctx = Parent.getIslCtx();
1075 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1076 Type *Ty = GEP->getPointerOperandType();
1077 ScalarEvolution &SE = *Parent.getSE();
1078
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001079 std::vector<const SCEV *> Subscripts;
1080 std::vector<int> Sizes;
1081
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001082 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001083
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001084 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001085 Ty = PtrTy->getElementType();
1086 }
1087
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001088 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001089
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001090 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001091
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001092 for (size_t i = 0; i < Sizes.size(); i++) {
1093 auto Expr = Subscripts[i + IndexOffset];
1094 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001095
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001096 if (!isAffineExpr(&Parent.getRegion(), Expr, SE))
1097 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001098
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001099 isl_pw_aff *AccessOffset = getPwAff(Expr);
1100 AccessOffset =
1101 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001102
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001103 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1104 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001105
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001106 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1107 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1108 OutOfBound = isl_set_params(OutOfBound);
1109 isl_set *InBound = isl_set_complement(OutOfBound);
1110 isl_set *Executed = isl_set_params(getDomain());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001111
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001112 // A => B == !A or B
1113 isl_set *InBoundIfExecuted =
1114 isl_set_union(isl_set_complement(Executed), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001115
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001116 Parent.addAssumption(InBoundIfExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001117 }
1118
1119 isl_local_space_free(LSpace);
1120}
1121
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001122void ScopStmt::deriveAssumptions(BasicBlock *Block) {
1123 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001124 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
1125 deriveAssumptionsFromGEP(GEP);
1126}
1127
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001128void ScopStmt::collectSurroundingLoops() {
1129 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1130 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1131 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1132 isl_id_free(DimId);
1133 }
1134}
1135
Michael Kruse9d080092015-09-11 21:41:48 +00001136ScopStmt::ScopStmt(Scop &parent, Region &R)
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001137 : Parent(parent), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001138
Tobias Grosser16c44032015-07-09 07:31:45 +00001139 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001140
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001141 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001142 collectSurroundingLoops();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001143
1144 BasicBlock *EntryBB = R.getEntry();
1145 for (BasicBlock *Block : R.blocks()) {
Michael Kruse9d080092015-09-11 21:41:48 +00001146 buildAccesses(Block, Block != EntryBB);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001147 deriveAssumptions(Block);
1148 }
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001149 if (DetectReductions)
1150 checkForReductions();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001151}
1152
Michael Kruse9d080092015-09-11 21:41:48 +00001153ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001154 : Parent(parent), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001155
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001156 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Tobias Grosser75805372011-04-29 06:27:02 +00001157
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001158 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001159 collectSurroundingLoops();
Michael Kruse9d080092015-09-11 21:41:48 +00001160 buildAccesses(BB);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001161 deriveAssumptions(BB);
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001162 if (DetectReductions)
1163 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001164}
1165
Johannes Doerferte58a0122014-06-27 20:31:28 +00001166/// @brief Collect loads which might form a reduction chain with @p StoreMA
1167///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001168/// Check if the stored value for @p StoreMA is a binary operator with one or
1169/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001170/// used only once (by @p StoreMA) and its load operands are also used only
1171/// once, we have found a possible reduction chain. It starts at an operand
1172/// load and includes the binary operator and @p StoreMA.
1173///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001174/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001175/// escape this block or into any other store except @p StoreMA.
1176void ScopStmt::collectCandiateReductionLoads(
1177 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1178 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1179 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001180 return;
1181
1182 // Skip if there is not one binary operator between the load and the store
1183 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001184 if (!BinOp)
1185 return;
1186
1187 // Skip if the binary operators has multiple uses
1188 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001189 return;
1190
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001191 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001192 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1193 return;
1194
Johannes Doerfert9890a052014-07-01 00:32:29 +00001195 // Skip if the binary operator is outside the current SCoP
1196 if (BinOp->getParent() != Store->getParent())
1197 return;
1198
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001199 // Skip if it is a multiplicative reduction and we disabled them
1200 if (DisableMultiplicativeReductions &&
1201 (BinOp->getOpcode() == Instruction::Mul ||
1202 BinOp->getOpcode() == Instruction::FMul))
1203 return;
1204
Johannes Doerferte58a0122014-06-27 20:31:28 +00001205 // Check the binary operator operands for a candidate load
1206 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1207 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1208 if (!PossibleLoad0 && !PossibleLoad1)
1209 return;
1210
1211 // A load is only a candidate if it cannot escape (thus has only this use)
1212 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001213 if (PossibleLoad0->getParent() == Store->getParent())
1214 Loads.push_back(lookupAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001215 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001216 if (PossibleLoad1->getParent() == Store->getParent())
1217 Loads.push_back(lookupAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001218}
1219
1220/// @brief Check for reductions in this ScopStmt
1221///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001222/// Iterate over all store memory accesses and check for valid binary reduction
1223/// like chains. For all candidates we check if they have the same base address
1224/// and there are no other accesses which overlap with them. The base address
1225/// check rules out impossible reductions candidates early. The overlap check,
1226/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001227/// guarantees that none of the intermediate results will escape during
1228/// execution of the loop nest. We basically check here that no other memory
1229/// access can access the same memory as the potential reduction.
1230void ScopStmt::checkForReductions() {
1231 SmallVector<MemoryAccess *, 2> Loads;
1232 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1233
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001234 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001235 // stores and collecting possible reduction loads.
1236 for (MemoryAccess *StoreMA : MemAccs) {
1237 if (StoreMA->isRead())
1238 continue;
1239
1240 Loads.clear();
1241 collectCandiateReductionLoads(StoreMA, Loads);
1242 for (MemoryAccess *LoadMA : Loads)
1243 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1244 }
1245
1246 // Then check each possible candidate pair.
1247 for (const auto &CandidatePair : Candidates) {
1248 bool Valid = true;
1249 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1250 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1251
1252 // Skip those with obviously unequal base addresses.
1253 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1254 isl_map_free(LoadAccs);
1255 isl_map_free(StoreAccs);
1256 continue;
1257 }
1258
1259 // And check if the remaining for overlap with other memory accesses.
1260 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1261 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1262 isl_set *AllAccs = isl_map_range(AllAccsRel);
1263
1264 for (MemoryAccess *MA : MemAccs) {
1265 if (MA == CandidatePair.first || MA == CandidatePair.second)
1266 continue;
1267
1268 isl_map *AccRel =
1269 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1270 isl_set *Accs = isl_map_range(AccRel);
1271
1272 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1273 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1274 Valid = Valid && isl_set_is_empty(OverlapAccs);
1275 isl_set_free(OverlapAccs);
1276 }
1277 }
1278
1279 isl_set_free(AllAccs);
1280 if (!Valid)
1281 continue;
1282
Johannes Doerfertf6183392014-07-01 20:52:51 +00001283 const LoadInst *Load =
1284 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1285 MemoryAccess::ReductionType RT =
1286 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1287
Johannes Doerferte58a0122014-06-27 20:31:28 +00001288 // If no overlapping access was found we mark the load and store as
1289 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001290 CandidatePair.first->markAsReductionLike(RT);
1291 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001292 }
Tobias Grosser75805372011-04-29 06:27:02 +00001293}
1294
Tobias Grosser74394f02013-01-14 22:40:23 +00001295std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001296
Tobias Grosser54839312015-04-21 11:37:25 +00001297std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001298 auto *S = getSchedule();
1299 auto Str = stringFromIslObj(S);
1300 isl_map_free(S);
1301 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001302}
1303
Tobias Grosser74394f02013-01-14 22:40:23 +00001304unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001305
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001306unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001307
Tobias Grosser75805372011-04-29 06:27:02 +00001308const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1309
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001310const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001311 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001312}
1313
Tobias Grosser74394f02013-01-14 22:40:23 +00001314isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001315
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001316__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001317
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001318__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001319 return isl_set_get_space(Domain);
1320}
1321
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001322__isl_give isl_id *ScopStmt::getDomainId() const {
1323 return isl_set_get_tuple_id(Domain);
1324}
Tobias Grossercd95b772012-08-30 11:49:38 +00001325
Tobias Grosser75805372011-04-29 06:27:02 +00001326ScopStmt::~ScopStmt() {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001327 DeleteContainerSeconds(InstructionToAccess);
Tobias Grosser75805372011-04-29 06:27:02 +00001328 isl_set_free(Domain);
Tobias Grosser75805372011-04-29 06:27:02 +00001329}
1330
1331void ScopStmt::print(raw_ostream &OS) const {
1332 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001333 OS.indent(12) << "Domain :=\n";
1334
1335 if (Domain) {
1336 OS.indent(16) << getDomainStr() << ";\n";
1337 } else
1338 OS.indent(16) << "n/a\n";
1339
Tobias Grosser54839312015-04-21 11:37:25 +00001340 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001341
1342 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001343 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001344 } else
1345 OS.indent(16) << "n/a\n";
1346
Tobias Grosser083d3d32014-06-28 08:59:45 +00001347 for (MemoryAccess *Access : MemAccs)
1348 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001349}
1350
1351void ScopStmt::dump() const { print(dbgs()); }
1352
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001353void ScopStmt::hoistMemoryAccesses(MemoryAccessList &InvMAs,
1354 InvariantAccessesTy &TargetList) {
1355
1356 // Remove all memory accesses in @p InvMAs from this statement together
1357 // with all scalar accesses that were caused by them. The tricky iteration
1358 // order uses is needed because the MemAccs is a vector and the order in
1359 // which the accesses of each memory access list (MAL) are stored in this
1360 // vector is reversed.
1361 for (MemoryAccess *MA : InvMAs) {
1362 auto &MAL = *lookupAccessesFor(MA->getAccessInstruction());
1363 MAL.reverse();
1364
1365 auto MALIt = MAL.begin();
1366 auto MALEnd = MAL.end();
1367 auto MemAccsIt = MemAccs.begin();
1368 while (MALIt != MALEnd) {
1369 while (*MemAccsIt != *MALIt)
1370 MemAccsIt++;
1371
1372 MALIt++;
1373 MemAccs.erase(MemAccsIt);
1374 }
1375
1376 InstructionToAccess.erase(MA->getAccessInstruction());
1377 delete &MAL;
1378 }
1379
1380 // Get the context under which this statement, hence the memory accesses, are
1381 // executed.
1382 isl_set *DomainCtx = isl_set_params(getDomain());
1383 DomainCtx = isl_set_remove_redundancies(DomainCtx);
1384 DomainCtx = isl_set_detect_equalities(DomainCtx);
1385 DomainCtx = isl_set_coalesce(DomainCtx);
1386
1387 for (MemoryAccess *MA : InvMAs)
1388 TargetList.push_back(std::make_pair(MA, isl_set_copy(DomainCtx)));
1389
1390 isl_set_free(DomainCtx);
1391}
1392
Tobias Grosser75805372011-04-29 06:27:02 +00001393//===----------------------------------------------------------------------===//
1394/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001395
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001396void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001397 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1398 isl_set_free(Context);
1399 Context = NewContext;
1400}
1401
Tobias Grosserabfbe632013-02-05 12:09:06 +00001402void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001403 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001404 Parameter = extractConstantFactor(Parameter, *SE).second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001405 if (ParameterIds.find(Parameter) != ParameterIds.end())
1406 continue;
1407
1408 int dimension = Parameters.size();
1409
1410 Parameters.push_back(Parameter);
1411 ParameterIds[Parameter] = dimension;
1412 }
1413}
1414
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001415__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) const {
1416 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001417
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001418 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001419 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001420
Tobias Grosser8f99c162011-11-15 11:38:55 +00001421 std::string ParameterName;
1422
1423 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1424 Value *Val = ValueParameter->getValue();
Tobias Grosser29ee0b12011-11-17 14:52:36 +00001425 ParameterName = Val->getName();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001426 }
1427
1428 if (ParameterName == "" || ParameterName.substr(0, 2) == "p_")
Hongbin Zheng86a37742012-04-25 08:01:38 +00001429 ParameterName = "p_" + utostr_32(IdIter->second);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001430
Tobias Grosser20532b82014-04-11 17:56:49 +00001431 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1432 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001433}
Tobias Grosser75805372011-04-29 06:27:02 +00001434
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001435isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1436 isl_set *DomainContext = isl_union_set_params(getDomains());
1437 return isl_set_intersect_params(C, DomainContext);
1438}
1439
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001440void Scop::buildBoundaryContext() {
1441 BoundaryContext = Affinator.getWrappingContext();
1442 BoundaryContext = isl_set_complement(BoundaryContext);
1443 BoundaryContext = isl_set_gist_params(BoundaryContext, getContext());
1444}
1445
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001446void Scop::addUserContext() {
1447 if (UserContextStr.empty())
1448 return;
1449
1450 isl_set *UserContext = isl_set_read_from_str(IslCtx, UserContextStr.c_str());
1451 isl_space *Space = getParamSpace();
1452 if (isl_space_dim(Space, isl_dim_param) !=
1453 isl_set_dim(UserContext, isl_dim_param)) {
1454 auto SpaceStr = isl_space_to_str(Space);
1455 errs() << "Error: the context provided in -polly-context has not the same "
1456 << "number of dimensions than the computed context. Due to this "
1457 << "mismatch, the -polly-context option is ignored. Please provide "
1458 << "the context in the parameter space: " << SpaceStr << ".\n";
1459 free(SpaceStr);
1460 isl_set_free(UserContext);
1461 isl_space_free(Space);
1462 return;
1463 }
1464
1465 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
1466 auto NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1467 auto NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
1468
1469 if (strcmp(NameContext, NameUserContext) != 0) {
1470 auto SpaceStr = isl_space_to_str(Space);
1471 errs() << "Error: the name of dimension " << i
1472 << " provided in -polly-context "
1473 << "is '" << NameUserContext << "', but the name in the computed "
1474 << "context is '" << NameContext
1475 << "'. Due to this name mismatch, "
1476 << "the -polly-context option is ignored. Please provide "
1477 << "the context in the parameter space: " << SpaceStr << ".\n";
1478 free(SpaceStr);
1479 isl_set_free(UserContext);
1480 isl_space_free(Space);
1481 return;
1482 }
1483
1484 UserContext =
1485 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1486 isl_space_get_dim_id(Space, isl_dim_param, i));
1487 }
1488
1489 Context = isl_set_intersect(Context, UserContext);
1490 isl_space_free(Space);
1491}
1492
Tobias Grosser6be480c2011-11-08 15:41:13 +00001493void Scop::buildContext() {
1494 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001495 Context = isl_set_universe(isl_space_copy(Space));
1496 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001497}
1498
Tobias Grosser18daaca2012-05-22 10:47:27 +00001499void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001500 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001501 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001502
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001503 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001504
Johannes Doerferte7044942015-02-24 11:58:30 +00001505 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001506 }
1507}
1508
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001509void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001510 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001511 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001512
Tobias Grosser083d3d32014-06-28 08:59:45 +00001513 for (const auto &ParamID : ParameterIds) {
1514 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001515 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001516 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001517 }
1518
1519 // Align the parameters of all data structures to the model.
1520 Context = isl_set_align_params(Context, Space);
1521
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001522 for (ScopStmt &Stmt : *this)
1523 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001524}
1525
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001526static __isl_give isl_set *
1527simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1528 const Scop &S) {
1529 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1530 AssumptionContext = isl_set_gist_params(AssumptionContext, DomainParameters);
1531 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1532 return AssumptionContext;
1533}
1534
1535void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001536 // The parameter constraints of the iteration domains give us a set of
1537 // constraints that need to hold for all cases where at least a single
1538 // statement iteration is executed in the whole scop. We now simplify the
1539 // assumed context under the assumption that such constraints hold and at
1540 // least a single statement iteration is executed. For cases where no
1541 // statement instances are executed, the assumptions we have taken about
1542 // the executed code do not matter and can be changed.
1543 //
1544 // WARNING: This only holds if the assumptions we have taken do not reduce
1545 // the set of statement instances that are executed. Otherwise we
1546 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001547 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001548 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001549 // performed. In such a case, modifying the run-time conditions and
1550 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001551 // to not be executed.
1552 //
1553 // Example:
1554 //
1555 // When delinearizing the following code:
1556 //
1557 // for (long i = 0; i < 100; i++)
1558 // for (long j = 0; j < m; j++)
1559 // A[i+p][j] = 1.0;
1560 //
1561 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001562 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001563 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001564 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
1565 BoundaryContext = simplifyAssumptionContext(BoundaryContext, *this);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001566}
1567
Johannes Doerfertb164c792014-09-18 11:17:17 +00001568/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001569static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001570 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1571 isl_pw_multi_aff *MinPMA, *MaxPMA;
1572 isl_pw_aff *LastDimAff;
1573 isl_aff *OneAff;
1574 unsigned Pos;
1575
Johannes Doerfert9143d672014-09-27 11:02:39 +00001576 // Restrict the number of parameters involved in the access as the lexmin/
1577 // lexmax computation will take too long if this number is high.
1578 //
1579 // Experiments with a simple test case using an i7 4800MQ:
1580 //
1581 // #Parameters involved | Time (in sec)
1582 // 6 | 0.01
1583 // 7 | 0.04
1584 // 8 | 0.12
1585 // 9 | 0.40
1586 // 10 | 1.54
1587 // 11 | 6.78
1588 // 12 | 30.38
1589 //
1590 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1591 unsigned InvolvedParams = 0;
1592 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1593 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1594 InvolvedParams++;
1595
1596 if (InvolvedParams > RunTimeChecksMaxParameters) {
1597 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001598 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00001599 }
1600 }
1601
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001602 Set = isl_set_remove_divs(Set);
1603
Johannes Doerfertb164c792014-09-18 11:17:17 +00001604 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1605 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1606
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001607 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1608 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1609
Johannes Doerfertb164c792014-09-18 11:17:17 +00001610 // Adjust the last dimension of the maximal access by one as we want to
1611 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1612 // we test during code generation might now point after the end of the
1613 // allocated array but we will never dereference it anyway.
1614 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1615 "Assumed at least one output dimension");
1616 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1617 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1618 OneAff = isl_aff_zero_on_domain(
1619 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1620 OneAff = isl_aff_add_constant_si(OneAff, 1);
1621 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1622 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1623
1624 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1625
1626 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001627 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001628}
1629
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001630static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1631 isl_set *Domain = MA->getStatement()->getDomain();
1632 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1633 return isl_set_reset_tuple_id(Domain);
1634}
1635
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001636/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
1637static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00001638 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001639 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001640
1641 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
1642 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001643 Locations = isl_union_set_coalesce(Locations);
1644 Locations = isl_union_set_detect_equalities(Locations);
1645 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001646 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001647 isl_union_set_free(Locations);
1648 return Valid;
1649}
1650
Johannes Doerfert96425c22015-08-30 21:13:53 +00001651/// @brief Helper to treat non-affine regions and basic blocks the same.
1652///
1653///{
1654
1655/// @brief Return the block that is the representing block for @p RN.
1656static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
1657 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
1658 : RN->getNodeAs<BasicBlock>();
1659}
1660
1661/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001662static inline BasicBlock *
1663getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001664 if (RN->isSubRegion()) {
1665 assert(idx == 0);
1666 return RN->getNodeAs<Region>()->getExit();
1667 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001668 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001669}
1670
1671/// @brief Return the smallest loop surrounding @p RN.
1672static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
1673 if (!RN->isSubRegion())
1674 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
1675
1676 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
1677 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
1678 while (L && NonAffineSubRegion->contains(L))
1679 L = L->getParentLoop();
1680 return L;
1681}
1682
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001683static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
1684 if (!RN->isSubRegion())
1685 return 1;
1686
1687 unsigned NumBlocks = 0;
1688 Region *R = RN->getNodeAs<Region>();
1689 for (auto BB : R->blocks()) {
1690 (void)BB;
1691 NumBlocks++;
1692 }
1693 return NumBlocks;
1694}
1695
Johannes Doerfertf5673802015-10-01 23:48:18 +00001696static bool containsErrorBlock(RegionNode *RN) {
1697 if (!RN->isSubRegion())
1698 return isErrorBlock(*RN->getNodeAs<BasicBlock>());
1699 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
1700 if (isErrorBlock(*BB))
1701 return true;
1702 return false;
1703}
1704
Johannes Doerfert96425c22015-08-30 21:13:53 +00001705///}
1706
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001707static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
1708 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001709 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001710 isl_id *DimId =
1711 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
1712 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
1713}
1714
Johannes Doerfert96425c22015-08-30 21:13:53 +00001715isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
1716 BasicBlock *BB = Stmt->isBlockStmt() ? Stmt->getBasicBlock()
1717 : Stmt->getRegion()->getEntry();
Johannes Doerfertcef616f2015-09-15 22:49:04 +00001718 return getDomainConditions(BB);
1719}
1720
1721isl_set *Scop::getDomainConditions(BasicBlock *BB) {
1722 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001723 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001724}
1725
1726void Scop::buildDomains(Region *R, LoopInfo &LI, ScopDetection &SD,
1727 DominatorTree &DT) {
1728
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001729 auto *EntryBB = R->getEntry();
1730 int LD = getRelativeLoopDepth(LI.getLoopFor(EntryBB));
1731 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001732
1733 Loop *L = LI.getLoopFor(EntryBB);
1734 while (LD-- >= 0) {
1735 S = addDomainDimId(S, LD + 1, L);
1736 L = L->getParentLoop();
1737 }
1738
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001739 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001740
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00001741 if (SD.isNonAffineSubRegion(R, R))
1742 return;
1743
Johannes Doerfert96425c22015-08-30 21:13:53 +00001744 buildDomainsWithBranchConstraints(R, LI, SD, DT);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001745 propagateDomainConstraints(R, LI, SD, DT);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001746}
1747
1748void Scop::buildDomainsWithBranchConstraints(Region *R, LoopInfo &LI,
1749 ScopDetection &SD,
1750 DominatorTree &DT) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001751 RegionInfo &RI = *R->getRegionInfo();
Johannes Doerfert96425c22015-08-30 21:13:53 +00001752
1753 // To create the domain for each block in R we iterate over all blocks and
1754 // subregions in R and propagate the conditions under which the current region
1755 // element is executed. To this end we iterate in reverse post order over R as
1756 // it ensures that we first visit all predecessors of a region node (either a
1757 // basic block or a subregion) before we visit the region node itself.
1758 // Initially, only the domain for the SCoP region entry block is set and from
1759 // there we propagate the current domain to all successors, however we add the
1760 // condition that the successor is actually executed next.
1761 // As we are only interested in non-loop carried constraints here we can
1762 // simply skip loop back edges.
1763
1764 ReversePostOrderTraversal<Region *> RTraversal(R);
1765 for (auto *RN : RTraversal) {
1766
1767 // Recurse for affine subregions but go on for basic blocks and non-affine
1768 // subregions.
1769 if (RN->isSubRegion()) {
1770 Region *SubRegion = RN->getNodeAs<Region>();
1771 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
1772 buildDomainsWithBranchConstraints(SubRegion, LI, SD, DT);
1773 continue;
1774 }
1775 }
1776
Johannes Doerfertf5673802015-10-01 23:48:18 +00001777 // Error blocks are assumed not to be executed. Therefor they are not
1778 // checked properly in the ScopDetection. Any attempt to generate control
1779 // conditions from them might result in a crash. However, this is only true
1780 // for the first step of the domain generation (this function) where we
1781 // push the control conditions of a block to the successors. In the second
1782 // step (propagateDomainConstraints) we only receive domain constraints from
1783 // the predecessors and can therefor look at the domain of a error block.
1784 // That allows us to generate the assumptions needed for them not to be
1785 // executed at runtime.
1786 if (containsErrorBlock(RN))
1787 continue;
1788
Johannes Doerfert96425c22015-08-30 21:13:53 +00001789 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001790 TerminatorInst *TI = BB->getTerminator();
1791
Johannes Doerfertf5673802015-10-01 23:48:18 +00001792 isl_set *Domain = DomainMap.lookup(BB);
1793 if (!Domain) {
1794 DEBUG(dbgs() << "\tSkip: " << BB->getName()
1795 << ", it is only reachable from error blocks.\n");
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001796 continue;
1797 }
1798
Johannes Doerfert96425c22015-08-30 21:13:53 +00001799 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001800
1801 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1802 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1803
1804 // Build the condition sets for the successor nodes of the current region
1805 // node. If it is a non-affine subregion we will always execute the single
1806 // exit node, hence the single entry node domain is the condition set. For
1807 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001808 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001809 if (RN->isSubRegion())
1810 ConditionSets.push_back(isl_set_copy(Domain));
1811 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001812 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001813
1814 // Now iterate over the successors and set their initial domain based on
1815 // their condition set. We skip back edges here and have to be careful when
1816 // we leave a loop not to keep constraints over a dimension that doesn't
1817 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001818 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00001819 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001820 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001821 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001822
1823 // Skip back edges.
1824 if (DT.dominates(SuccBB, BB)) {
1825 isl_set_free(CondSet);
1826 continue;
1827 }
1828
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001829 // Do not adjust the number of dimensions if we enter a boxed loop or are
1830 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001831 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001832 Region *SuccRegion = RI.getRegionFor(SuccBB);
1833 if (BBLoop != SuccBBLoop && !RN->isSubRegion() &&
1834 !(SD.isNonAffineSubRegion(SuccRegion, &getRegion()) &&
1835 SuccRegion->contains(SuccBBLoop))) {
1836
1837 // Check if the edge to SuccBB is a loop entry or exit edge. If so
1838 // adjust the dimensionality accordingly. Lastly, if we leave a loop
1839 // and enter a new one we need to drop the old constraints.
1840 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001841 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001842 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001843 CondSet = isl_set_project_out(CondSet, isl_dim_set,
1844 isl_set_n_dim(CondSet) - LoopDepthDiff,
1845 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001846 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001847 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001848 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 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001851 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001852 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
1853 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001854 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001855 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00001856 }
1857
1858 // Set the domain for the successor or merge it with an existing domain in
1859 // case there are multiple paths (without loop back edges) to the
1860 // successor block.
1861 isl_set *&SuccDomain = DomainMap[SuccBB];
1862 if (!SuccDomain)
1863 SuccDomain = CondSet;
1864 else
1865 SuccDomain = isl_set_union(SuccDomain, CondSet);
1866
1867 SuccDomain = isl_set_coalesce(SuccDomain);
1868 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : " << Domain
1869 << "\n");
1870 }
1871 }
1872}
1873
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001874/// @brief Return the domain for @p BB wrt @p DomainMap.
1875///
1876/// This helper function will lookup @p BB in @p DomainMap but also handle the
1877/// case where @p BB is contained in a non-affine subregion using the region
1878/// tree obtained by @p RI.
1879static __isl_give isl_set *
1880getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
1881 RegionInfo &RI) {
1882 auto DIt = DomainMap.find(BB);
1883 if (DIt != DomainMap.end())
1884 return isl_set_copy(DIt->getSecond());
1885
1886 Region *R = RI.getRegionFor(BB);
1887 while (R->getEntry() == BB)
1888 R = R->getParent();
1889 return getDomainForBlock(R->getEntry(), DomainMap, RI);
1890}
1891
1892void Scop::propagateDomainConstraints(Region *R, LoopInfo &LI,
1893 ScopDetection &SD, DominatorTree &DT) {
1894 // Iterate over the region R and propagate the domain constrains from the
1895 // predecessors to the current node. In contrast to the
1896 // buildDomainsWithBranchConstraints function, this one will pull the domain
1897 // information from the predecessors instead of pushing it to the successors.
1898 // Additionally, we assume the domains to be already present in the domain
1899 // map here. However, we iterate again in reverse post order so we know all
1900 // predecessors have been visited before a block or non-affine subregion is
1901 // visited.
1902
1903 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
1904 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
1905
1906 ReversePostOrderTraversal<Region *> RTraversal(R);
1907 for (auto *RN : RTraversal) {
1908
1909 // Recurse for affine subregions but go on for basic blocks and non-affine
1910 // subregions.
1911 if (RN->isSubRegion()) {
1912 Region *SubRegion = RN->getNodeAs<Region>();
1913 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
1914 propagateDomainConstraints(SubRegion, LI, SD, DT);
1915 continue;
1916 }
1917 }
1918
Johannes Doerfertf5673802015-10-01 23:48:18 +00001919 // Get the domain for the current block and check if it was initialized or
1920 // not. The only way it was not is if this block is only reachable via error
1921 // blocks, thus will not be executed under the assumptions we make. Such
1922 // blocks have to be skipped as their predecessors might not have domains
1923 // either. It would not benefit us to compute the domain anyway, only the
1924 // domains of the error blocks that are reachable from non-error blocks
1925 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001926 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00001927 isl_set *&Domain = DomainMap[BB];
1928 if (!Domain) {
1929 DEBUG(dbgs() << "\tSkip: " << BB->getName()
1930 << ", it is only reachable from error blocks.\n");
1931 DomainMap.erase(BB);
1932 continue;
1933 }
1934 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
1935
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001936 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1937 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1938
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001939 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
1940 for (auto *PredBB : predecessors(BB)) {
1941
1942 // Skip backedges
1943 if (DT.dominates(BB, PredBB))
1944 continue;
1945
1946 isl_set *PredBBDom = nullptr;
1947
1948 // Handle the SCoP entry block with its outside predecessors.
1949 if (!getRegion().contains(PredBB))
1950 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
1951
1952 if (!PredBBDom) {
1953 // Determine the loop depth of the predecessor and adjust its domain to
1954 // the domain of the current block. This can mean we have to:
1955 // o) Drop a dimension if this block is the exit of a loop, not the
1956 // header of a new loop and the predecessor was part of the loop.
1957 // o) Add an unconstrainted new dimension if this block is the header
1958 // of a loop and the predecessor is not part of it.
1959 // o) Drop the information about the innermost loop dimension when the
1960 // predecessor and the current block are surrounded by different
1961 // loops in the same depth.
1962 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
1963 Loop *PredBBLoop = LI.getLoopFor(PredBB);
1964 while (BoxedLoops.count(PredBBLoop))
1965 PredBBLoop = PredBBLoop->getParentLoop();
1966
1967 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001968 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001969 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001970 PredBBDom = isl_set_project_out(
1971 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
1972 LoopDepthDiff);
1973 else if (PredBBLoopDepth < BBLoopDepth) {
1974 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001975 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001976 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
1977 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001978 PredBBDom = isl_set_drop_constraints_involving_dims(
1979 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001980 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001981 }
1982
1983 PredDom = isl_set_union(PredDom, PredBBDom);
1984 }
1985
1986 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00001987 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001988
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00001989 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001990 addLoopBoundsToHeaderDomain(BBLoop, LI);
1991
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001992 // Add assumptions for error blocks.
Johannes Doerferte114dc02015-09-14 11:15:58 +00001993 if (containsErrorBlock(RN)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001994 IsOptimized = true;
1995 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
1996 addAssumption(isl_set_complement(DomPar));
1997 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001998 }
1999}
2000
2001/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2002/// is incremented by one and all other dimensions are equal, e.g.,
2003/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2004/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2005static __isl_give isl_map *
2006createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2007 auto *MapSpace = isl_space_map_from_set(SetSpace);
2008 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2009 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2010 if (u != Dim)
2011 NextIterationMap =
2012 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2013 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2014 C = isl_constraint_set_constant_si(C, 1);
2015 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2016 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2017 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2018 return NextIterationMap;
2019}
2020
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002021void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
2022 int LoopDepth = getRelativeLoopDepth(L);
2023 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002024
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002025 BasicBlock *HeaderBB = L->getHeader();
2026 assert(DomainMap.count(HeaderBB));
2027 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002028
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002029 isl_map *NextIterationMap =
2030 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002031
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002032 isl_set *UnionBackedgeCondition =
2033 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002034
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002035 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2036 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002037
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002038 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002039
2040 // If the latch is only reachable via error statements we skip it.
2041 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2042 if (!LatchBBDom)
2043 continue;
2044
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002045 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002046
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002047 TerminatorInst *TI = LatchBB->getTerminator();
2048 BranchInst *BI = dyn_cast<BranchInst>(TI);
2049 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002050 BackedgeCondition = isl_set_copy(LatchBBDom);
2051 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002052 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002053 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002054 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002055
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002056 // Free the non back edge condition set as we do not need it.
2057 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002058
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002059 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002060 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002061
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002062 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2063 assert(LatchLoopDepth >= LoopDepth);
2064 BackedgeCondition =
2065 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2066 LatchLoopDepth - LoopDepth);
2067 UnionBackedgeCondition =
2068 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002069 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002070
2071 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2072 for (int i = 0; i < LoopDepth; i++)
2073 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2074
2075 isl_set *UnionBackedgeConditionComplement =
2076 isl_set_complement(UnionBackedgeCondition);
2077 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2078 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2079 UnionBackedgeConditionComplement =
2080 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2081 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2082 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2083
2084 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2085 HeaderBBDom = Parts.second;
2086
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002087 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2088 // the bounded assumptions to the context as they are already implied by the
2089 // <nsw> tag.
2090 if (Affinator.hasNSWAddRecForLoop(L)) {
2091 isl_set_free(Parts.first);
2092 return;
2093 }
2094
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002095 isl_set *UnboundedCtx = isl_set_params(Parts.first);
2096 isl_set *BoundedCtx = isl_set_complement(UnboundedCtx);
Johannes Doerfert707a4062015-09-20 16:38:19 +00002097 addAssumption(BoundedCtx);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002098}
2099
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002100void Scop::buildAliasChecks(AliasAnalysis &AA) {
2101 if (!PollyUseRuntimeAliasChecks)
2102 return;
2103
2104 if (buildAliasGroups(AA))
2105 return;
2106
2107 // If a problem occurs while building the alias groups we need to delete
2108 // this SCoP and pretend it wasn't valid in the first place. To this end
2109 // we make the assumed context infeasible.
2110 addAssumption(isl_set_empty(getParamSpace()));
2111
2112 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2113 << " could not be created as the number of parameters involved "
2114 "is too high. The SCoP will be "
2115 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2116 "the maximal number of parameters but be advised that the "
2117 "compile time might increase exponentially.\n\n");
2118}
2119
Johannes Doerfert9143d672014-09-27 11:02:39 +00002120bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002121 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002122 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002123 // for all memory accesses inside the SCoP.
2124 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002125 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002126 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002127 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002128 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002129 // if their access domains intersect, otherwise they are in different
2130 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002131 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002132 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002133 // and maximal accesses to each array of a group in read only and non
2134 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002135 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2136
2137 AliasSetTracker AST(AA);
2138
2139 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002140 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002141 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002142
2143 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002144 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002145 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2146 isl_set_free(StmtDomain);
2147 if (StmtDomainEmpty)
2148 continue;
2149
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002150 for (MemoryAccess *MA : Stmt) {
Michael Kruse8d0b7342015-09-25 21:21:00 +00002151 if (MA->isImplicit())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002152 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002153 if (!MA->isRead())
2154 HasWriteAccess.insert(MA->getBaseAddr());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002155 Instruction *Acc = MA->getAccessInstruction();
2156 PtrToAcc[getPointerOperand(*Acc)] = MA;
2157 AST.add(Acc);
2158 }
2159 }
2160
2161 SmallVector<AliasGroupTy, 4> AliasGroups;
2162 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002163 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002164 continue;
2165 AliasGroupTy AG;
2166 for (auto PR : AS)
2167 AG.push_back(PtrToAcc[PR.getValue()]);
2168 assert(AG.size() > 1 &&
2169 "Alias groups should contain at least two accesses");
2170 AliasGroups.push_back(std::move(AG));
2171 }
2172
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002173 // Split the alias groups based on their domain.
2174 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2175 AliasGroupTy NewAG;
2176 AliasGroupTy &AG = AliasGroups[u];
2177 AliasGroupTy::iterator AGI = AG.begin();
2178 isl_set *AGDomain = getAccessDomain(*AGI);
2179 while (AGI != AG.end()) {
2180 MemoryAccess *MA = *AGI;
2181 isl_set *MADomain = getAccessDomain(MA);
2182 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2183 NewAG.push_back(MA);
2184 AGI = AG.erase(AGI);
2185 isl_set_free(MADomain);
2186 } else {
2187 AGDomain = isl_set_union(AGDomain, MADomain);
2188 AGI++;
2189 }
2190 }
2191 if (NewAG.size() > 1)
2192 AliasGroups.push_back(std::move(NewAG));
2193 isl_set_free(AGDomain);
2194 }
2195
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002196 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002197 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2198 for (AliasGroupTy &AG : AliasGroups) {
2199 NonReadOnlyBaseValues.clear();
2200 ReadOnlyPairs.clear();
2201
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002202 if (AG.size() < 2) {
2203 AG.clear();
2204 continue;
2205 }
2206
Johannes Doerfert13771732014-10-01 12:40:46 +00002207 for (auto II = AG.begin(); II != AG.end();) {
2208 Value *BaseAddr = (*II)->getBaseAddr();
2209 if (HasWriteAccess.count(BaseAddr)) {
2210 NonReadOnlyBaseValues.insert(BaseAddr);
2211 II++;
2212 } else {
2213 ReadOnlyPairs[BaseAddr].insert(*II);
2214 II = AG.erase(II);
2215 }
2216 }
2217
2218 // If we don't have read only pointers check if there are at least two
2219 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002220 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002221 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002222 continue;
2223 }
2224
2225 // If we don't have non read only pointers clear the alias group.
2226 if (NonReadOnlyBaseValues.empty()) {
2227 AG.clear();
2228 continue;
2229 }
2230
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002231 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002232 MinMaxAliasGroups.emplace_back();
2233 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2234 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2235 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2236 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002237
2238 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002239
2240 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002241 for (MemoryAccess *MA : AG)
2242 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002243
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002244 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2245 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002246
2247 // Bail out if the number of values we need to compare is too large.
2248 // This is important as the number of comparisions grows quadratically with
2249 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002250 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2251 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002252 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002253
2254 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002255 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002256 Accesses = isl_union_map_empty(getParamSpace());
2257
2258 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2259 for (MemoryAccess *MA : ReadOnlyPair.second)
2260 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2261
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002262 Valid =
2263 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002264
2265 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002266 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002267 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002268
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002269 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002270}
2271
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002272static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
2273 Loop *L = LI.getLoopFor(R.getEntry());
2274 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2275}
2276
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002277static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2278 ScopDetection &SD) {
2279
2280 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2281
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002282 unsigned MinLD = INT_MAX, MaxLD = 0;
2283 for (BasicBlock *BB : R.blocks()) {
2284 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002285 if (!R.contains(L))
2286 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002287 if (BoxedLoops && BoxedLoops->count(L))
2288 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002289 unsigned LD = L->getLoopDepth();
2290 MinLD = std::min(MinLD, LD);
2291 MaxLD = std::max(MaxLD, LD);
2292 }
2293 }
2294
2295 // Handle the case that there is no loop in the SCoP first.
2296 if (MaxLD == 0)
2297 return 1;
2298
2299 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2300 assert(MaxLD >= MinLD &&
2301 "Maximal loop depth was smaller than mininaml loop depth?");
2302 return MaxLD - MinLD + 1;
2303}
2304
Michael Kruse9d080092015-09-11 21:41:48 +00002305Scop::Scop(Region &R, AccFuncMapType &AccFuncMap,
2306 ScalarEvolution &ScalarEvolution, DominatorTree &DT,
Johannes Doerfert96425c22015-08-30 21:13:53 +00002307 isl_ctx *Context, unsigned MaxLoopDepth)
Michael Kruse9d080092015-09-11 21:41:48 +00002308 : DT(DT), SE(&ScalarEvolution), R(R), AccFuncMap(AccFuncMap),
2309 IsOptimized(false), HasSingleExitEdge(R.getExitingBlock()),
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002310 MaxLoopDepth(MaxLoopDepth), IslCtx(Context), Affinator(this),
2311 BoundaryContext(nullptr) {}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002312
Michael Kruse9d080092015-09-11 21:41:48 +00002313void Scop::init(LoopInfo &LI, ScopDetection &SD, AliasAnalysis &AA) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002314 buildContext();
Tobias Grosser75805372011-04-29 06:27:02 +00002315
Johannes Doerfert96425c22015-08-30 21:13:53 +00002316 buildDomains(&R, LI, SD, DT);
2317
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002318 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> LoopSchedules;
Tobias Grosser75805372011-04-29 06:27:02 +00002319
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002320 Loop *L = getLoopSurroundingRegion(R, LI);
2321 LoopSchedules[L];
Michael Kruse9d080092015-09-11 21:41:48 +00002322 buildSchedule(&R, LI, SD, LoopSchedules);
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002323 updateAccessDimensionality();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002324 Schedule = LoopSchedules[L].first;
Tobias Grosser75805372011-04-29 06:27:02 +00002325
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002326 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002327 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002328 addUserContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002329 buildBoundaryContext();
2330 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002331 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002332
2333 hoistInvariantLoads();
2334 simplifySCoP();
Tobias Grosser75805372011-04-29 06:27:02 +00002335}
2336
2337Scop::~Scop() {
2338 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002339 isl_set_free(AssumedContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002340 isl_set_free(BoundaryContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002341 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002342
Johannes Doerfert96425c22015-08-30 21:13:53 +00002343 for (auto It : DomainMap)
2344 isl_set_free(It.second);
2345
Johannes Doerfertb164c792014-09-18 11:17:17 +00002346 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002347 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002348 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002349 isl_pw_multi_aff_free(MMA.first);
2350 isl_pw_multi_aff_free(MMA.second);
2351 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002352 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002353 isl_pw_multi_aff_free(MMA.first);
2354 isl_pw_multi_aff_free(MMA.second);
2355 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002356 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002357
2358 for (const auto &IA : InvariantAccesses)
2359 isl_set_free(IA.second);
Tobias Grosser75805372011-04-29 06:27:02 +00002360}
2361
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002362void Scop::updateAccessDimensionality() {
2363 for (auto &Stmt : *this)
2364 for (auto &Access : Stmt)
2365 Access->updateDimensionality();
2366}
2367
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002368void Scop::simplifySCoP() {
2369
2370 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
2371 ScopStmt &Stmt = *StmtIt;
2372
2373 if (!StmtIt->isEmpty()) {
2374 StmtIt++;
2375 continue;
2376 }
2377
2378 if (Stmt.isRegionStmt())
2379 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2380 StmtMap.erase(BB);
2381 else
2382 StmtMap.erase(Stmt.getBasicBlock());
2383
2384 StmtIt = Stmts.erase(StmtIt);
2385 }
2386}
2387
2388void Scop::hoistInvariantLoads() {
2389 isl_union_map *Writes = getWrites();
2390 for (ScopStmt &Stmt : *this) {
2391
2392 // TODO: Loads that are not loop carried, hence are in a statement with
2393 // zero iterators, are by construction invariant, though we
2394 // currently "hoist" them anyway.
2395
2396 isl_set *Domain = Stmt.getDomain();
2397 MemoryAccessList InvMAs;
2398
2399 for (MemoryAccess *MA : Stmt) {
2400 if (MA->isImplicit() || MA->isWrite() || !MA->isAffine())
2401 continue;
2402
2403 isl_map *AccessRelation = MA->getAccessRelation();
2404 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
2405 Stmt.getNumIterators())) {
2406 isl_map_free(AccessRelation);
2407 continue;
2408 }
2409
2410 AccessRelation =
2411 isl_map_intersect_domain(AccessRelation, isl_set_copy(Domain));
2412 isl_set *AccessRange = isl_map_range(AccessRelation);
2413
2414 isl_union_map *Written = isl_union_map_intersect_range(
2415 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
2416 bool IsWritten = !isl_union_map_is_empty(Written);
2417 isl_union_map_free(Written);
2418
2419 if (IsWritten)
2420 continue;
2421
2422 InvMAs.push_front(MA);
2423 }
2424
2425 // We inserted invariant accesses always in the front but need them to be
2426 // sorted in a "natural order". The statements are already sorted in reverse
2427 // post order and that suffices for the accesses too. The reason we require
2428 // an order in the first place is the dependences between invariant loads
2429 // that can be caused by indirect loads.
2430 InvMAs.reverse();
2431
2432 // Transfer the memory access from the statement to the SCoP.
2433 Stmt.hoistMemoryAccesses(InvMAs, InvariantAccesses);
2434
2435 isl_set_free(Domain);
2436 }
2437 isl_union_map_free(Writes);
2438
2439 if (!InvariantAccesses.empty())
2440 IsOptimized = true;
2441}
2442
Johannes Doerfert80ef1102014-11-07 08:31:31 +00002443const ScopArrayInfo *
2444Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *AccessType,
Michael Kruse28468772015-09-14 15:45:33 +00002445 ArrayRef<const SCEV *> Sizes, bool IsPHI) {
Tobias Grosser92245222015-07-28 14:53:44 +00002446 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002447 if (!SAI) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002448 SAI.reset(new ScopArrayInfo(BasePtr, AccessType, getIslCtx(), Sizes, IsPHI,
2449 this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002450 } else {
2451 if (Sizes.size() > SAI->getNumberOfDimensions())
2452 SAI->updateSizes(Sizes);
2453 }
Tobias Grosserab671442015-05-23 05:58:27 +00002454 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002455}
2456
Tobias Grosser92245222015-07-28 14:53:44 +00002457const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, bool IsPHI) {
2458 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002459 assert(SAI && "No ScopArrayInfo available for this base pointer");
2460 return SAI;
2461}
2462
Tobias Grosser74394f02013-01-14 22:40:23 +00002463std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002464std::string Scop::getAssumedContextStr() const {
2465 return stringFromIslObj(AssumedContext);
2466}
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002467std::string Scop::getBoundaryContextStr() const {
2468 return stringFromIslObj(BoundaryContext);
2469}
Tobias Grosser75805372011-04-29 06:27:02 +00002470
2471std::string Scop::getNameStr() const {
2472 std::string ExitName, EntryName;
2473 raw_string_ostream ExitStr(ExitName);
2474 raw_string_ostream EntryStr(EntryName);
2475
Tobias Grosserf240b482014-01-09 10:42:15 +00002476 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002477 EntryStr.str();
2478
2479 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00002480 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002481 ExitStr.str();
2482 } else
2483 ExitName = "FunctionExit";
2484
2485 return EntryName + "---" + ExitName;
2486}
2487
Tobias Grosser74394f02013-01-14 22:40:23 +00002488__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00002489__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002490 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00002491}
2492
Tobias Grossere86109f2013-10-29 21:05:49 +00002493__isl_give isl_set *Scop::getAssumedContext() const {
2494 return isl_set_copy(AssumedContext);
2495}
2496
Johannes Doerfert43788c52015-08-20 05:58:56 +00002497__isl_give isl_set *Scop::getRuntimeCheckContext() const {
2498 isl_set *RuntimeCheckContext = getAssumedContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002499 RuntimeCheckContext =
2500 isl_set_intersect(RuntimeCheckContext, getBoundaryContext());
2501 RuntimeCheckContext = simplifyAssumptionContext(RuntimeCheckContext, *this);
Johannes Doerfert43788c52015-08-20 05:58:56 +00002502 return RuntimeCheckContext;
2503}
2504
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002505bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00002506 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002507 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00002508 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
2509 isl_set_free(RuntimeCheckContext);
2510 return IsFeasible;
2511}
2512
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002513void Scop::addAssumption(__isl_take isl_set *Set) {
2514 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00002515 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002516}
2517
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002518__isl_give isl_set *Scop::getBoundaryContext() const {
2519 return isl_set_copy(BoundaryContext);
2520}
2521
Tobias Grosser75805372011-04-29 06:27:02 +00002522void Scop::printContext(raw_ostream &OS) const {
2523 OS << "Context:\n";
2524
2525 if (!Context) {
2526 OS.indent(4) << "n/a\n\n";
2527 return;
2528 }
2529
2530 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00002531
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002532 OS.indent(4) << "Assumed Context:\n";
2533 if (!AssumedContext) {
2534 OS.indent(4) << "n/a\n\n";
2535 return;
2536 }
2537
2538 OS.indent(4) << getAssumedContextStr() << "\n";
2539
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002540 OS.indent(4) << "Boundary Context:\n";
2541 if (!BoundaryContext) {
2542 OS.indent(4) << "n/a\n\n";
2543 return;
2544 }
2545
2546 OS.indent(4) << getBoundaryContextStr() << "\n";
2547
Tobias Grosser083d3d32014-06-28 08:59:45 +00002548 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00002549 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00002550 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
2551 }
Tobias Grosser75805372011-04-29 06:27:02 +00002552}
2553
Johannes Doerfertb164c792014-09-18 11:17:17 +00002554void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002555 int noOfGroups = 0;
2556 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002557 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002558 noOfGroups += 1;
2559 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002560 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002561 }
2562
Tobias Grosserbb853c22015-07-25 12:31:03 +00002563 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00002564 if (MinMaxAliasGroups.empty()) {
2565 OS.indent(8) << "n/a\n";
2566 return;
2567 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002568
Tobias Grosserbb853c22015-07-25 12:31:03 +00002569 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002570
2571 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002572 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002573 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002574 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002575 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2576 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002577 }
2578 OS << " ]]\n";
2579 }
2580
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002581 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002582 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00002583 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002584 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002585 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2586 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002587 }
2588 OS << " ]]\n";
2589 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002590 }
2591}
2592
Tobias Grosser75805372011-04-29 06:27:02 +00002593void Scop::printStatements(raw_ostream &OS) const {
2594 OS << "Statements {\n";
2595
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002596 for (const ScopStmt &Stmt : *this)
2597 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00002598
2599 OS.indent(4) << "}\n";
2600}
2601
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002602void Scop::printArrayInfo(raw_ostream &OS) const {
2603 OS << "Arrays {\n";
2604
Tobias Grosserab671442015-05-23 05:58:27 +00002605 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002606 Array.second->print(OS);
2607
2608 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002609
2610 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
2611
2612 for (auto &Array : arrays())
2613 Array.second->print(OS, /* SizeAsPwAff */ true);
2614
2615 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002616}
2617
Tobias Grosser75805372011-04-29 06:27:02 +00002618void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00002619 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
2620 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00002621 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00002622 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002623 OS.indent(4) << "Invariant Accesses: {\n";
2624 for (const auto &IA : InvariantAccesses) {
2625 IA.first->print(OS);
2626 OS.indent(12) << "Execution Context: " << IA.second << "\n";
2627 }
2628 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00002629 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002630 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002631 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00002632 printStatements(OS.indent(4));
2633}
2634
2635void Scop::dump() const { print(dbgs()); }
2636
Tobias Grosser9a38ab82011-11-08 15:41:03 +00002637isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00002638
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002639__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
2640 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00002641}
2642
Tobias Grosser808cd692015-07-14 09:33:13 +00002643__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002644 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002645
Tobias Grosser808cd692015-07-14 09:33:13 +00002646 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002647 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002648
2649 return Domain;
2650}
2651
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002652__isl_give isl_union_map *Scop::getMustWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002653 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002654
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002655 for (ScopStmt &Stmt : *this) {
2656 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002657 if (!MA->isMustWrite())
2658 continue;
2659
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002660 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002661 isl_map *AccessDomain = MA->getAccessRelation();
2662 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2663 Write = isl_union_map_add_map(Write, AccessDomain);
2664 }
2665 }
2666 return isl_union_map_coalesce(Write);
2667}
2668
2669__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002670 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002671
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002672 for (ScopStmt &Stmt : *this) {
2673 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002674 if (!MA->isMayWrite())
2675 continue;
2676
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002677 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002678 isl_map *AccessDomain = MA->getAccessRelation();
2679 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2680 Write = isl_union_map_add_map(Write, AccessDomain);
2681 }
2682 }
2683 return isl_union_map_coalesce(Write);
2684}
2685
Tobias Grosser37eb4222014-02-20 21:43:54 +00002686__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002687 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002688
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002689 for (ScopStmt &Stmt : *this) {
2690 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002691 if (!MA->isWrite())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002692 continue;
2693
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002694 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002695 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002696 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2697 Write = isl_union_map_add_map(Write, AccessDomain);
2698 }
2699 }
2700 return isl_union_map_coalesce(Write);
2701}
2702
2703__isl_give isl_union_map *Scop::getReads() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002704 isl_union_map *Read = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002705
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002706 for (ScopStmt &Stmt : *this) {
2707 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002708 if (!MA->isRead())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002709 continue;
2710
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002711 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002712 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002713
2714 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2715 Read = isl_union_map_add_map(Read, AccessDomain);
2716 }
2717 }
2718 return isl_union_map_coalesce(Read);
2719}
2720
Tobias Grosser808cd692015-07-14 09:33:13 +00002721__isl_give isl_union_map *Scop::getSchedule() const {
2722 auto Tree = getScheduleTree();
2723 auto S = isl_schedule_get_map(Tree);
2724 isl_schedule_free(Tree);
2725 return S;
2726}
Tobias Grosser37eb4222014-02-20 21:43:54 +00002727
Tobias Grosser808cd692015-07-14 09:33:13 +00002728__isl_give isl_schedule *Scop::getScheduleTree() const {
2729 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
2730 getDomains());
2731}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002732
Tobias Grosser808cd692015-07-14 09:33:13 +00002733void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
2734 auto *S = isl_schedule_from_domain(getDomains());
2735 S = isl_schedule_insert_partial_schedule(
2736 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
2737 isl_schedule_free(Schedule);
2738 Schedule = S;
2739}
2740
2741void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
2742 isl_schedule_free(Schedule);
2743 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00002744}
2745
2746bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
2747 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002748 for (ScopStmt &Stmt : *this) {
2749 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002750 isl_union_set *NewStmtDomain = isl_union_set_intersect(
2751 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
2752
2753 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
2754 isl_union_set_free(StmtDomain);
2755 isl_union_set_free(NewStmtDomain);
2756 continue;
2757 }
2758
2759 Changed = true;
2760
2761 isl_union_set_free(StmtDomain);
2762 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
2763
2764 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002765 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002766 isl_union_set_free(NewStmtDomain);
2767 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002768 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002769 }
2770 isl_union_set_free(Domain);
2771 return Changed;
2772}
2773
Tobias Grosser75805372011-04-29 06:27:02 +00002774ScalarEvolution *Scop::getSE() const { return SE; }
2775
Johannes Doerfertf5673802015-10-01 23:48:18 +00002776bool Scop::isIgnored(RegionNode *RN) {
2777 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Tobias Grosser75805372011-04-29 06:27:02 +00002778
Johannes Doerfertf5673802015-10-01 23:48:18 +00002779 // Check if there are accesses contained.
2780 bool ContainsAccesses = false;
2781 if (!RN->isSubRegion())
2782 ContainsAccesses = getAccessFunctions(BB);
2783 else
2784 for (BasicBlock *RBB : RN->getNodeAs<Region>()->blocks())
2785 ContainsAccesses |= (getAccessFunctions(RBB) != nullptr);
2786 if (!ContainsAccesses)
2787 return true;
2788
2789 // Check for reachability via non-error blocks.
2790 if (!DomainMap.count(BB))
2791 return true;
2792
2793 // Check if error blocks are contained.
2794 if (containsErrorBlock(RN))
2795 return true;
2796
2797 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00002798}
2799
Tobias Grosser808cd692015-07-14 09:33:13 +00002800struct MapToDimensionDataTy {
2801 int N;
2802 isl_union_pw_multi_aff *Res;
2803};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002804
Tobias Grosser808cd692015-07-14 09:33:13 +00002805// @brief Create a function that maps the elements of 'Set' to its N-th
2806// dimension.
2807//
2808// The result is added to 'User->Res'.
2809//
2810// @param Set The input set.
2811// @param N The dimension to map to.
2812//
2813// @returns Zero if no error occurred, non-zero otherwise.
2814static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
2815 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
2816 int Dim;
2817 isl_space *Space;
2818 isl_pw_multi_aff *PMA;
2819
2820 Dim = isl_set_dim(Set, isl_dim_set);
2821 Space = isl_set_get_space(Set);
2822 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
2823 Dim - Data->N);
2824 if (Data->N > 1)
2825 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
2826 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
2827
2828 isl_set_free(Set);
2829
2830 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002831}
2832
Tobias Grosser808cd692015-07-14 09:33:13 +00002833// @brief Create a function that maps the elements of Domain to their Nth
2834// dimension.
2835//
2836// @param Domain The set of elements to map.
2837// @param N The dimension to map to.
2838static __isl_give isl_multi_union_pw_aff *
2839mapToDimension(__isl_take isl_union_set *Domain, int N) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002840 if (N <= 0 || isl_union_set_is_empty(Domain)) {
2841 isl_union_set_free(Domain);
2842 return nullptr;
2843 }
2844
Tobias Grosser808cd692015-07-14 09:33:13 +00002845 struct MapToDimensionDataTy Data;
2846 isl_space *Space;
2847
2848 Space = isl_union_set_get_space(Domain);
2849 Data.N = N;
2850 Data.Res = isl_union_pw_multi_aff_empty(Space);
2851 if (isl_union_set_foreach_set(Domain, &mapToDimension_AddSet, &Data) < 0)
2852 Data.Res = isl_union_pw_multi_aff_free(Data.Res);
2853
2854 isl_union_set_free(Domain);
2855 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
2856}
2857
Michael Kruse9d080092015-09-11 21:41:48 +00002858ScopStmt *Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00002859 ScopStmt *Stmt;
2860 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00002861 Stmts.emplace_back(*this, *BB);
Tobias Grosser808cd692015-07-14 09:33:13 +00002862 Stmt = &Stmts.back();
2863 StmtMap[BB] = Stmt;
2864 } else {
2865 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00002866 Stmts.emplace_back(*this, *R);
Tobias Grosser808cd692015-07-14 09:33:13 +00002867 Stmt = &Stmts.back();
2868 for (BasicBlock *BB : R->blocks())
2869 StmtMap[BB] = Stmt;
2870 }
2871 return Stmt;
2872}
2873
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002874void Scop::buildSchedule(
Michael Kruse9d080092015-09-11 21:41:48 +00002875 Region *R, LoopInfo &LI, ScopDetection &SD,
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002876 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> &LoopSchedules) {
Michael Kruse046dde42015-08-10 13:01:57 +00002877
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002878 if (SD.isNonAffineSubRegion(R, &getRegion())) {
2879 auto *Stmt = addScopStmt(nullptr, R);
2880 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
2881 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Johannes Doerfertc6987c12015-09-26 13:41:43 +00002882 Loop *L = getLoopSurroundingRegion(*R, LI);
2883 auto &LSchedulePair = LoopSchedules[L];
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002884 LSchedulePair.first = StmtSchedule;
2885 return;
2886 }
2887
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002888 ReversePostOrderTraversal<Region *> RTraversal(R);
2889 for (auto *RN : RTraversal) {
Michael Kruse046dde42015-08-10 13:01:57 +00002890
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002891 if (RN->isSubRegion()) {
2892 Region *SubRegion = RN->getNodeAs<Region>();
2893 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Michael Kruse9d080092015-09-11 21:41:48 +00002894 buildSchedule(SubRegion, LI, SD, LoopSchedules);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002895 continue;
2896 }
Tobias Grosser75805372011-04-29 06:27:02 +00002897 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002898
2899 Loop *L = getRegionNodeLoop(RN, LI);
2900 int LD = getRelativeLoopDepth(L);
2901 auto &LSchedulePair = LoopSchedules[L];
2902 LSchedulePair.second += getNumBlocksInRegionNode(RN);
2903
Johannes Doerfertf5673802015-10-01 23:48:18 +00002904 if (!isIgnored(RN)) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002905
2906 ScopStmt *Stmt;
2907 if (RN->isSubRegion())
Michael Kruse9d080092015-09-11 21:41:48 +00002908 Stmt = addScopStmt(nullptr, RN->getNodeAs<Region>());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002909 else
Johannes Doerfertf5673802015-10-01 23:48:18 +00002910 Stmt = addScopStmt(RN->getNodeAs<BasicBlock>(), nullptr);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002911
2912 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
2913 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
2914 LSchedulePair.first =
2915 combineInSequence(LSchedulePair.first, StmtSchedule);
2916 }
2917
2918 unsigned NumVisited = LSchedulePair.second;
2919 while (L && NumVisited == L->getNumBlocks()) {
2920 auto *LDomain = isl_schedule_get_domain(LSchedulePair.first);
2921 if (auto *MUPA = mapToDimension(LDomain, LD + 1))
2922 LSchedulePair.first =
2923 isl_schedule_insert_partial_schedule(LSchedulePair.first, MUPA);
2924
2925 auto *PL = L->getParentLoop();
2926 assert(LoopSchedules.count(PL));
2927 auto &PSchedulePair = LoopSchedules[PL];
2928 PSchedulePair.first =
2929 combineInSequence(PSchedulePair.first, LSchedulePair.first);
2930 PSchedulePair.second += NumVisited;
2931
2932 L = PL;
2933 NumVisited = PSchedulePair.second;
2934 }
Tobias Grosser808cd692015-07-14 09:33:13 +00002935 }
Tobias Grosser75805372011-04-29 06:27:02 +00002936}
2937
Johannes Doerfert7c494212014-10-31 23:13:39 +00002938ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00002939 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00002940 if (StmtMapIt == StmtMap.end())
2941 return nullptr;
2942 return StmtMapIt->second;
2943}
2944
Johannes Doerfert96425c22015-08-30 21:13:53 +00002945int Scop::getRelativeLoopDepth(const Loop *L) const {
2946 Loop *OuterLoop =
2947 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
2948 if (!OuterLoop)
2949 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00002950 return L->getLoopDepth() - OuterLoop->getLoopDepth();
2951}
2952
Michael Krused868b5d2015-09-10 15:25:24 +00002953void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00002954 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002955
2956 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
2957 // true, are not modeled as ordinary PHI nodes as they are not part of the
2958 // region. However, we model the operands in the predecessor blocks that are
2959 // part of the region as regular scalar accesses.
2960
2961 // If we can synthesize a PHI we can skip it, however only if it is in
2962 // the region. If it is not it can only be in the exit block of the region.
2963 // In this case we model the operands but not the PHI itself.
2964 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
2965 return;
2966
2967 // PHI nodes are modeled as if they had been demoted prior to the SCoP
2968 // detection. Hence, the PHI is a load of a new memory location in which the
2969 // incoming value was written at the end of the incoming basic block.
2970 bool OnlyNonAffineSubRegionOperands = true;
2971 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
2972 Value *Op = PHI->getIncomingValue(u);
2973 BasicBlock *OpBB = PHI->getIncomingBlock(u);
2974
2975 // Do not build scalar dependences inside a non-affine subregion.
2976 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
2977 continue;
2978
2979 OnlyNonAffineSubRegionOperands = false;
2980
2981 if (!R.contains(OpBB))
2982 continue;
2983
2984 Instruction *OpI = dyn_cast<Instruction>(Op);
2985 if (OpI) {
2986 BasicBlock *OpIBB = OpI->getParent();
2987 // As we pretend there is a use (or more precise a write) of OpI in OpBB
2988 // we have to insert a scalar dependence from the definition of OpI to
2989 // OpBB if the definition is not in OpBB.
2990 if (OpIBB != OpBB) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00002991 addScalarReadAccess(OpI, PHI, OpBB);
2992 addScalarWriteAccess(OpI);
Michael Kruse7bf39442015-09-10 12:46:52 +00002993 }
Tobias Grosserda95a4a2015-09-24 20:59:59 +00002994 } else if (ModelReadOnlyScalars && !isa<Constant>(Op)) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00002995 addScalarReadAccess(Op, PHI, OpBB);
Michael Kruse7bf39442015-09-10 12:46:52 +00002996 }
2997
Michael Kruse33d6c0b2015-09-25 18:53:27 +00002998 addPHIWriteAccess(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00002999 }
3000
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003001 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3002 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003003 }
3004}
3005
Michael Krused868b5d2015-09-10 15:25:24 +00003006bool ScopInfo::buildScalarDependences(Instruction *Inst, Region *R,
3007 Region *NonAffineSubRegion) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003008 bool canSynthesizeInst = canSynthesize(Inst, LI, SE, R);
3009 if (isIgnoredIntrinsic(Inst))
3010 return false;
3011
3012 bool AnyCrossStmtUse = false;
3013 BasicBlock *ParentBB = Inst->getParent();
3014
3015 for (User *U : Inst->users()) {
3016 Instruction *UI = dyn_cast<Instruction>(U);
3017
3018 // Ignore the strange user
3019 if (UI == 0)
3020 continue;
3021
3022 BasicBlock *UseParent = UI->getParent();
3023
3024 // Ignore the users in the same BB (statement)
3025 if (UseParent == ParentBB)
3026 continue;
3027
3028 // Do not build scalar dependences inside a non-affine subregion.
3029 if (NonAffineSubRegion && NonAffineSubRegion->contains(UseParent))
3030 continue;
3031
3032 // Check whether or not the use is in the SCoP.
3033 if (!R->contains(UseParent)) {
3034 AnyCrossStmtUse = true;
3035 continue;
3036 }
3037
3038 // If the instruction can be synthesized and the user is in the region
3039 // we do not need to add scalar dependences.
3040 if (canSynthesizeInst)
3041 continue;
3042
3043 // No need to translate these scalar dependences into polyhedral form,
3044 // because synthesizable scalars can be generated by the code generator.
3045 if (canSynthesize(UI, LI, SE, R))
3046 continue;
3047
3048 // Skip PHI nodes in the region as they handle their operands on their own.
3049 if (isa<PHINode>(UI))
3050 continue;
3051
3052 // Now U is used in another statement.
3053 AnyCrossStmtUse = true;
3054
3055 // Do not build a read access that is not in the current SCoP
Michael Krusee2bccbb2015-09-18 19:59:43 +00003056 // Use the def instruction as base address of the MemoryAccess, so that it
3057 // will become the name of the scalar access in the polyhedral form.
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003058 addScalarReadAccess(Inst, UI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003059 }
3060
Tobias Grosserda95a4a2015-09-24 20:59:59 +00003061 if (ModelReadOnlyScalars && !isa<PHINode>(Inst)) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003062 for (Value *Op : Inst->operands()) {
3063 if (canSynthesize(Op, LI, SE, R))
3064 continue;
3065
3066 if (Instruction *OpInst = dyn_cast<Instruction>(Op))
3067 if (R->contains(OpInst))
3068 continue;
3069
3070 if (isa<Constant>(Op))
3071 continue;
3072
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003073 addScalarReadAccess(Op, Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003074 }
3075 }
3076
3077 return AnyCrossStmtUse;
3078}
3079
3080extern MapInsnToMemAcc InsnToMemAcc;
3081
Michael Krusee2bccbb2015-09-18 19:59:43 +00003082void ScopInfo::buildMemoryAccess(
3083 Instruction *Inst, Loop *L, Region *R,
3084 const ScopDetection::BoxedLoopsSetTy *BoxedLoops) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003085 unsigned Size;
3086 Type *SizeType;
3087 Value *Val;
Michael Krusee2bccbb2015-09-18 19:59:43 +00003088 enum MemoryAccess::AccessType Type;
Michael Kruse7bf39442015-09-10 12:46:52 +00003089
3090 if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
3091 SizeType = Load->getType();
3092 Size = TD->getTypeStoreSize(SizeType);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003093 Type = MemoryAccess::READ;
Michael Kruse7bf39442015-09-10 12:46:52 +00003094 Val = Load;
3095 } else {
3096 StoreInst *Store = cast<StoreInst>(Inst);
3097 SizeType = Store->getValueOperand()->getType();
3098 Size = TD->getTypeStoreSize(SizeType);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003099 Type = MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003100 Val = Store->getValueOperand();
3101 }
3102
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003103 auto Address = getPointerOperand(*Inst);
3104
3105 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003106 const SCEVUnknown *BasePointer =
3107 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3108
3109 assert(BasePointer && "Could not find base pointer");
3110 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
3111
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003112 if (isa<GetElementPtrInst>(Address) || isa<BitCastInst>(Address)) {
3113 auto NewAddress = Address;
3114 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
3115 auto Src = BitCast->getOperand(0);
3116 auto SrcTy = Src->getType();
3117 auto DstTy = BitCast->getType();
3118 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3119 NewAddress = Src;
3120 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003121
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003122 if (auto *GEP = dyn_cast<GetElementPtrInst>(NewAddress)) {
3123 std::vector<const SCEV *> Subscripts;
3124 std::vector<int> Sizes;
3125 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
3126 auto BasePtr = GEP->getOperand(0);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003127
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003128 std::vector<const SCEV *> SizesSCEV;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003129
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003130 bool AllAffineSubcripts = true;
3131 for (auto Subscript : Subscripts)
3132 if (!isAffineExpr(R, Subscript, *SE)) {
3133 AllAffineSubcripts = false;
3134 break;
3135 }
3136
3137 if (AllAffineSubcripts && Sizes.size() > 0) {
3138 for (auto V : Sizes)
3139 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
3140 IntegerType::getInt64Ty(BasePtr->getContext()), V)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003141 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003142 IntegerType::getInt64Ty(BasePtr->getContext()), Size)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003143
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003144 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, true,
3145 Subscripts, SizesSCEV, Val);
Tobias Grosserb1c39422015-09-21 16:19:25 +00003146 return;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003147 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003148 }
3149 }
3150
Michael Kruse7bf39442015-09-10 12:46:52 +00003151 auto AccItr = InsnToMemAcc.find(Inst);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003152 if (PollyDelinearize && AccItr != InsnToMemAcc.end()) {
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003153 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, true,
3154 AccItr->second.DelinearizedSubscripts,
3155 AccItr->second.Shape->DelinearizedSizes, Val);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003156 return;
3157 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003158
3159 // Check if the access depends on a loop contained in a non-affine subregion.
3160 bool isVariantInNonAffineLoop = false;
3161 if (BoxedLoops) {
3162 SetVector<const Loop *> Loops;
3163 findLoops(AccessFunction, Loops);
3164 for (const Loop *L : Loops)
3165 if (BoxedLoops->count(L))
3166 isVariantInNonAffineLoop = true;
3167 }
3168
3169 bool IsAffine = !isVariantInNonAffineLoop &&
3170 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue());
3171
Michael Krusecaac2b62015-09-26 15:51:44 +00003172 // FIXME: Size of the number of bytes of an array element, not the number of
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003173 // elements as probably intended here.
Tobias Grossera43b6e92015-09-27 17:54:50 +00003174 const SCEV *SizeSCEV =
3175 SE->getConstant(TD->getIntPtrType(Inst->getContext()), Size);
Michael Kruse7bf39442015-09-10 12:46:52 +00003176
Michael Krusee2bccbb2015-09-18 19:59:43 +00003177 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
3178 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003179
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003180 addExplicitAccess(Inst, Type, BasePointer->getValue(), Size, IsAffine,
3181 ArrayRef<const SCEV *>(AccessFunction),
3182 ArrayRef<const SCEV *>(SizeSCEV), Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00003183}
3184
Michael Krused868b5d2015-09-10 15:25:24 +00003185void ScopInfo::buildAccessFunctions(Region &R, Region &SR) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003186
3187 if (SD->isNonAffineSubRegion(&SR, &R)) {
3188 for (BasicBlock *BB : SR.blocks())
3189 buildAccessFunctions(R, *BB, &SR);
3190 return;
3191 }
3192
3193 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
3194 if (I->isSubRegion())
3195 buildAccessFunctions(R, *I->getNodeAs<Region>());
3196 else
3197 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>());
3198}
3199
Michael Krused868b5d2015-09-10 15:25:24 +00003200void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
3201 Region *NonAffineSubRegion,
3202 bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003203 Loop *L = LI->getLoopFor(&BB);
3204
3205 // The set of loops contained in non-affine subregions that are part of R.
3206 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
3207
3208 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I) {
3209 Instruction *Inst = I;
3210
3211 PHINode *PHI = dyn_cast<PHINode>(Inst);
3212 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00003213 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003214
3215 // For the exit block we stop modeling after the last PHI node.
3216 if (!PHI && IsExitBlock)
3217 break;
3218
3219 if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
Michael Krusee2bccbb2015-09-18 19:59:43 +00003220 buildMemoryAccess(Inst, L, &R, BoxedLoops);
Michael Kruse7bf39442015-09-10 12:46:52 +00003221
3222 if (isIgnoredIntrinsic(Inst))
3223 continue;
3224
3225 if (buildScalarDependences(Inst, &R, NonAffineSubRegion)) {
Michael Krusee2bccbb2015-09-18 19:59:43 +00003226 if (!isa<StoreInst>(Inst))
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003227 addScalarWriteAccess(Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00003228 }
3229 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00003230}
Michael Kruse7bf39442015-09-10 12:46:52 +00003231
Michael Kruse2d0ece92015-09-24 11:41:21 +00003232void ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
3233 MemoryAccess::AccessType Type,
3234 Value *BaseAddress, unsigned ElemBytes,
3235 bool Affine, Value *AccessValue,
3236 ArrayRef<const SCEV *> Subscripts,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003237 ArrayRef<const SCEV *> Sizes,
3238 MemoryAccess::AccessOrigin Origin) {
Michael Krusee2bccbb2015-09-18 19:59:43 +00003239 AccFuncSetType &AccList = AccFuncMap[BB];
3240 size_t Identifier = AccList.size();
Michael Kruse7bf39442015-09-10 12:46:52 +00003241
Michael Krusee2bccbb2015-09-18 19:59:43 +00003242 Value *BaseAddr = BaseAddress;
3243 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
3244
3245 std::string IdName = "__polly_array_ref_" + std::to_string(Identifier);
3246 isl_id *Id = isl_id_alloc(ctx, IdName.c_str(), nullptr);
3247
Michael Kruse2d0ece92015-09-24 11:41:21 +00003248 AccList.emplace_back(Inst, Id, Type, BaseAddress, ElemBytes, Affine,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003249 Subscripts, Sizes, AccessValue, Origin, BaseName);
Michael Kruse7bf39442015-09-10 12:46:52 +00003250}
3251
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003252void ScopInfo::addExplicitAccess(
3253 Instruction *MemAccInst, MemoryAccess::AccessType Type, Value *BaseAddress,
3254 unsigned ElemBytes, bool IsAffine, ArrayRef<const SCEV *> Subscripts,
3255 ArrayRef<const SCEV *> Sizes, Value *AccessValue) {
3256 assert(isa<LoadInst>(MemAccInst) || isa<StoreInst>(MemAccInst));
3257 assert(isa<LoadInst>(MemAccInst) == (Type == MemoryAccess::READ));
3258 addMemoryAccess(MemAccInst->getParent(), MemAccInst, Type, BaseAddress,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003259 ElemBytes, IsAffine, AccessValue, Subscripts, Sizes,
3260 MemoryAccess::EXPLICIT);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003261}
3262void ScopInfo::addScalarWriteAccess(Instruction *Value) {
3263 addMemoryAccess(Value->getParent(), Value, MemoryAccess::MUST_WRITE, Value, 1,
3264 true, Value, ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003265 ArrayRef<const SCEV *>(), MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003266}
3267void ScopInfo::addScalarReadAccess(Value *Value, Instruction *User) {
3268 assert(!isa<PHINode>(User));
3269 addMemoryAccess(User->getParent(), User, MemoryAccess::READ, Value, 1, true,
3270 Value, ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003271 MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003272}
3273void ScopInfo::addScalarReadAccess(Value *Value, PHINode *User,
3274 BasicBlock *UserBB) {
3275 addMemoryAccess(UserBB, User, MemoryAccess::READ, Value, 1, true, Value,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003276 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
3277 MemoryAccess::SCALAR);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003278}
3279void ScopInfo::addPHIWriteAccess(PHINode *PHI, BasicBlock *IncomingBlock,
3280 Value *IncomingValue, bool IsExitBlock) {
3281 addMemoryAccess(IncomingBlock, IncomingBlock->getTerminator(),
3282 MemoryAccess::MUST_WRITE, PHI, 1, true, IncomingValue,
3283 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Michael Kruse8d0b7342015-09-25 21:21:00 +00003284 IsExitBlock ? MemoryAccess::SCALAR : MemoryAccess::PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003285}
3286void ScopInfo::addPHIReadAccess(PHINode *PHI) {
3287 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI, 1, true, PHI,
Michael Kruse8d0b7342015-09-25 21:21:00 +00003288 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
3289 MemoryAccess::PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003290}
3291
Michael Kruse76e924d2015-09-30 09:16:07 +00003292void ScopInfo::buildScop(Region &R, DominatorTree &DT) {
Michael Kruse9d080092015-09-11 21:41:48 +00003293 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse76e924d2015-09-30 09:16:07 +00003294 scop = new Scop(R, AccFuncMap, *SE, DT, ctx, MaxLoopDepth);
Michael Kruse7bf39442015-09-10 12:46:52 +00003295
3296 buildAccessFunctions(R, R);
3297
3298 // In case the region does not have an exiting block we will later (during
3299 // code generation) split the exit block. This will move potential PHI nodes
3300 // from the current exit block into the new region exiting block. Hence, PHI
3301 // nodes that are at this point not part of the region will be.
3302 // To handle these PHI nodes later we will now model their operands as scalar
3303 // accesses. Note that we do not model anything in the exit block if we have
3304 // an exiting block in the region, as there will not be any splitting later.
3305 if (!R.getExitingBlock())
3306 buildAccessFunctions(R, *R.getExit(), nullptr, /* IsExitBlock */ true);
3307
Michael Kruse76e924d2015-09-30 09:16:07 +00003308 scop->init(*LI, *SD, *AA);
Michael Kruse7bf39442015-09-10 12:46:52 +00003309}
3310
Michael Krused868b5d2015-09-10 15:25:24 +00003311void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00003312 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00003313 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00003314 return;
3315 }
3316
Michael Kruse9d080092015-09-11 21:41:48 +00003317 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00003318}
3319
Michael Krused868b5d2015-09-10 15:25:24 +00003320void ScopInfo::clear() {
Michael Kruse7bf39442015-09-10 12:46:52 +00003321 AccFuncMap.clear();
Michael Krused868b5d2015-09-10 15:25:24 +00003322 if (scop) {
3323 delete scop;
3324 scop = 0;
3325 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003326}
3327
3328//===----------------------------------------------------------------------===//
Michael Kruse9d080092015-09-11 21:41:48 +00003329ScopInfo::ScopInfo() : RegionPass(ID), scop(0) {
Tobias Grosserb76f38532011-08-20 11:11:25 +00003330 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00003331 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00003332}
3333
3334ScopInfo::~ScopInfo() {
3335 clear();
3336 isl_ctx_free(ctx);
3337}
3338
Tobias Grosser75805372011-04-29 06:27:02 +00003339void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Michael Krused868b5d2015-09-10 15:25:24 +00003340 AU.addRequiredID(IndependentBlocksID);
Chandler Carruthf5579872015-01-17 14:16:56 +00003341 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00003342 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00003343 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00003344 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
3345 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00003346 AU.addRequired<AAResultsWrapperPass>();
Tobias Grosser75805372011-04-29 06:27:02 +00003347 AU.setPreservesAll();
3348}
3349
3350bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00003351 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00003352
Michael Krused868b5d2015-09-10 15:25:24 +00003353 if (!SD->isMaxRegionInScop(*R))
3354 return false;
3355
3356 Function *F = R->getEntry()->getParent();
3357 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
3358 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
3359 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
3360 TD = &F->getParent()->getDataLayout();
3361 DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Michael Krused868b5d2015-09-10 15:25:24 +00003362
Michael Kruse76e924d2015-09-30 09:16:07 +00003363 buildScop(*R, DT);
Tobias Grosser75805372011-04-29 06:27:02 +00003364
Tobias Grosserd6a50b32015-05-30 06:26:21 +00003365 DEBUG(scop->print(dbgs()));
3366
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003367 if (!scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert43788c52015-08-20 05:58:56 +00003368 delete scop;
3369 scop = nullptr;
3370 return false;
3371 }
3372
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003373 // Statistics.
3374 ++ScopFound;
3375 if (scop->getMaxLoopDepth() > 0)
3376 ++RichScopFound;
Tobias Grosser75805372011-04-29 06:27:02 +00003377 return false;
3378}
3379
3380char ScopInfo::ID = 0;
3381
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003382Pass *polly::createScopInfoPass() { return new ScopInfo(); }
3383
Tobias Grosser73600b82011-10-08 00:30:40 +00003384INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
3385 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003386 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00003387INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Chandler Carruthf5579872015-01-17 14:16:56 +00003388INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00003389INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00003390INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003391INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00003392INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00003393INITIALIZE_PASS_END(ScopInfo, "polly-scops",
3394 "Polly - Create polyhedral description of Scops", false,
3395 false)