blob: dddef6689d1ed2cd0bf41c06347a24e0e46a335f [file] [log] [blame]
Tobias Grosser75805372011-04-29 06:27:02 +00001//===--------- ScopInfo.cpp - Create Scops from LLVM IR ------------------===//
2//
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"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000021#include "polly/Options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000022#include "polly/ScopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000023#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000024#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000025#include "polly/Support/ScopHelper.h"
Michael Kruse7bf39442015-09-10 12:46:52 +000026#include "polly/CodeGen/BlockGenerators.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000027#include "llvm/ADT/MapVector.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000028#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000029#include "llvm/ADT/Statistic.h"
Johannes Doerfertecff11d2015-05-22 23:43:58 +000030#include "llvm/ADT/STLExtras.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000031#include "llvm/ADT/StringExtras.h"
Johannes Doerfert96425c22015-08-30 21:13:53 +000032#include "llvm/ADT/PostOrderIterator.h"
Johannes Doerfertb68cffb2015-09-10 15:27:46 +000033#include "llvm/Analysis/LoopIterator.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000034#include "llvm/Analysis/AliasAnalysis.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000035#include "llvm/Analysis/LoopInfo.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 Grosser92245222015-07-28 14:53:44 +0000163 const SmallVector<const SCEV *, 4> &DimensionSizes,
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000164 bool IsPHI, Scop *S)
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000165 : BasePtr(BasePtr), ElementType(ElementType),
Tobias Grosser92245222015-07-28 14:53:44 +0000166 DimensionSizes(DimensionSizes), IsPHI(IsPHI) {
167 std::string BasePtrName =
168 getIslCompatibleName("MemRef_", BasePtr, IsPHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000169 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000170 for (const SCEV *Expr : DimensionSizes) {
171 isl_pw_aff *Size = S->getPwAff(Expr);
172 DimensionSizesPw.push_back(Size);
173 }
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000174
175 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
176 if (BasePtrOriginSAI)
177 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000178}
179
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000180ScopArrayInfo::~ScopArrayInfo() {
181 isl_id_free(Id);
182 for (isl_pw_aff *Size : DimensionSizesPw)
183 isl_pw_aff_free(Size);
184}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000185
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000186std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
187
188int ScopArrayInfo::getElemSizeInBytes() const {
189 return ElementType->getPrimitiveSizeInBits() / 8;
190}
191
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000192isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
193
194void ScopArrayInfo::dump() const { print(errs()); }
195
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000196void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000197 OS.indent(8) << *getElementType() << " " << getName() << "[*]";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000198 for (unsigned u = 0; u < getNumberOfDimensions(); u++) {
199 OS << "[";
200
201 if (SizeAsPwAff)
202 OS << " " << DimensionSizesPw[u] << " ";
203 else
204 OS << *DimensionSizes[u];
205
206 OS << "]";
207 }
208
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000209 if (BasePtrOriginSAI)
210 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
211
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000212 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000213}
214
215const ScopArrayInfo *
216ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
217 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
218 assert(Id && "Output dimension didn't have an ID");
219 return getFromId(Id);
220}
221
222const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
223 void *User = isl_id_get_user(Id);
224 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
225 isl_id_free(Id);
226 return SAI;
227}
228
Michael Kruse7bf39442015-09-10 12:46:52 +0000229void IRAccess::print(raw_ostream &OS) const {
230 if (isRead())
231 OS << "Read ";
232 else {
233 if (isMayWrite())
234 OS << "May";
235 OS << "Write ";
236 }
237 OS << BaseAddress->getName() << '[' << *Offset << "]\n";
238}
239
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000240const std::string
241MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
242 switch (RT) {
243 case MemoryAccess::RT_NONE:
244 llvm_unreachable("Requested a reduction operator string for a memory "
245 "access which isn't a reduction");
246 case MemoryAccess::RT_ADD:
247 return "+";
248 case MemoryAccess::RT_MUL:
249 return "*";
250 case MemoryAccess::RT_BOR:
251 return "|";
252 case MemoryAccess::RT_BXOR:
253 return "^";
254 case MemoryAccess::RT_BAND:
255 return "&";
256 }
257 llvm_unreachable("Unknown reduction type");
258 return "";
259}
260
Johannes Doerfertf6183392014-07-01 20:52:51 +0000261/// @brief Return the reduction type for a given binary operator
262static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
263 const Instruction *Load) {
264 if (!BinOp)
265 return MemoryAccess::RT_NONE;
266 switch (BinOp->getOpcode()) {
267 case Instruction::FAdd:
268 if (!BinOp->hasUnsafeAlgebra())
269 return MemoryAccess::RT_NONE;
270 // Fall through
271 case Instruction::Add:
272 return MemoryAccess::RT_ADD;
273 case Instruction::Or:
274 return MemoryAccess::RT_BOR;
275 case Instruction::Xor:
276 return MemoryAccess::RT_BXOR;
277 case Instruction::And:
278 return MemoryAccess::RT_BAND;
279 case Instruction::FMul:
280 if (!BinOp->hasUnsafeAlgebra())
281 return MemoryAccess::RT_NONE;
282 // Fall through
283 case Instruction::Mul:
284 if (DisableMultiplicativeReductions)
285 return MemoryAccess::RT_NONE;
286 return MemoryAccess::RT_MUL;
287 default:
288 return MemoryAccess::RT_NONE;
289 }
290}
Tobias Grosser75805372011-04-29 06:27:02 +0000291//===----------------------------------------------------------------------===//
292
293MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000294 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000295 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000296 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000297}
298
Johannes Doerfert8f7124c2014-09-12 11:00:49 +0000299static MemoryAccess::AccessType getMemoryAccessType(const IRAccess &Access) {
300 switch (Access.getType()) {
301 case IRAccess::READ:
302 return MemoryAccess::READ;
303 case IRAccess::MUST_WRITE:
304 return MemoryAccess::MUST_WRITE;
305 case IRAccess::MAY_WRITE:
306 return MemoryAccess::MAY_WRITE;
307 }
308 llvm_unreachable("Unknown IRAccess type!");
309}
310
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000311const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
312 isl_id *ArrayId = getArrayId();
313 void *User = isl_id_get_user(ArrayId);
314 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
315 isl_id_free(ArrayId);
316 return SAI;
317}
318
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000319__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000320 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
321}
322
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000323__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
324 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000325 isl_map *Schedule, *ScheduledAccRel;
326 isl_union_set *UDomain;
327
328 UDomain = isl_union_set_from_set(getStatement()->getDomain());
329 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
330 Schedule = isl_map_from_union_map(USchedule);
331 ScheduledAccRel = isl_map_apply_domain(getAccessRelation(), Schedule);
332 return isl_pw_multi_aff_from_map(ScheduledAccRel);
333}
334
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000335__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000336 return isl_map_copy(AccessRelation);
337}
338
Johannes Doerferta99130f2014-10-13 12:58:03 +0000339std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000340 return stringFromIslObj(AccessRelation);
341}
342
Johannes Doerferta99130f2014-10-13 12:58:03 +0000343__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000344 return isl_map_get_space(AccessRelation);
345}
346
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000347__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000348 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000349}
350
Tobias Grosser6f730082015-09-05 07:46:47 +0000351std::string MemoryAccess::getNewAccessRelationStr() const {
352 return stringFromIslObj(NewAccessRelation);
353}
354
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000355__isl_give isl_basic_map *
356MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000357 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000358 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000359
Tobias Grosser084d8f72012-05-29 09:29:44 +0000360 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000361 isl_basic_set_universe(Statement->getDomainSpace()),
362 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000363}
364
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000365// Formalize no out-of-bound access assumption
366//
367// When delinearizing array accesses we optimistically assume that the
368// delinearized accesses do not access out of bound locations (the subscript
369// expression of each array evaluates for each statement instance that is
370// executed to a value that is larger than zero and strictly smaller than the
371// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000372// dimension for which we do not need to assume any upper bound. At this point
373// we formalize this assumption to ensure that at code generation time the
374// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000375//
376// To find the set of constraints necessary to avoid out of bound accesses, we
377// first build the set of data locations that are not within array bounds. We
378// then apply the reverse access relation to obtain the set of iterations that
379// may contain invalid accesses and reduce this set of iterations to the ones
380// that are actually executed by intersecting them with the domain of the
381// statement. If we now project out all loop dimensions, we obtain a set of
382// parameters that may cause statement instances to be executed that may
383// possibly yield out of bound memory accesses. The complement of these
384// constraints is the set of constraints that needs to be assumed to ensure such
385// statement instances are never executed.
386void MemoryAccess::assumeNoOutOfBound(const IRAccess &Access) {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000387 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000388 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000389 for (int i = 1, Size = Access.Subscripts.size(); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000390 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
391 isl_pw_aff *Var =
392 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
393 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
394
395 isl_set *DimOutside;
396
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000397 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfert574182d2015-08-12 10:19:50 +0000398 isl_pw_aff *SizeE = Statement->getPwAff(Access.Sizes[i - 1]);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000399
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000400 SizeE = isl_pw_aff_drop_dims(SizeE, isl_dim_in, 0,
401 Statement->getNumIterators());
402 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
403 isl_space_dim(Space, isl_dim_set));
404 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
405 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000406
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000407 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000408
409 Outside = isl_set_union(Outside, DimOutside);
410 }
411
412 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
413 Outside = isl_set_intersect(Outside, Statement->getDomain());
414 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000415
416 // Remove divs to avoid the construction of overly complicated assumptions.
417 // Doing so increases the set of parameter combinations that are assumed to
418 // not appear. This is always save, but may make the resulting run-time check
419 // bail out more often than strictly necessary.
420 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000421 Outside = isl_set_complement(Outside);
422 Statement->getParent()->addAssumption(Outside);
423 isl_space_free(Space);
424}
425
Johannes Doerferte7044942015-02-24 11:58:30 +0000426void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
427 ScalarEvolution *SE = Statement->getParent()->getSE();
428
429 Value *Ptr = getPointerOperand(*getAccessInstruction());
430 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
431 return;
432
433 auto *PtrSCEV = SE->getSCEV(Ptr);
434 if (isa<SCEVCouldNotCompute>(PtrSCEV))
435 return;
436
437 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
438 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
439 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
440
441 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
442 if (Range.isFullSet())
443 return;
444
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000445 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000446 unsigned BW = Range.getBitWidth();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000447 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
448 const auto UB = isWrapping ? Range.getUpper() : Range.getSignedMax();
449
450 auto Min = LB.sdiv(APInt(BW, ElementSize));
451 auto Max = (UB - APInt(BW, 1)).sdiv(APInt(BW, ElementSize));
Johannes Doerferte7044942015-02-24 11:58:30 +0000452
453 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
454 AccessRange =
455 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
456 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
457}
458
Tobias Grosser619190d2015-03-30 17:22:28 +0000459__isl_give isl_map *MemoryAccess::foldAccess(const IRAccess &Access,
460 __isl_take isl_map *AccessRelation,
461 ScopStmt *Statement) {
462 int Size = Access.Subscripts.size();
463
464 for (int i = Size - 2; i >= 0; --i) {
465 isl_space *Space;
466 isl_map *MapOne, *MapTwo;
Johannes Doerfert574182d2015-08-12 10:19:50 +0000467 isl_pw_aff *DimSize = Statement->getPwAff(Access.Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000468
469 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
470 isl_pw_aff_free(DimSize);
471 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
472
473 Space = isl_map_get_space(AccessRelation);
474 Space = isl_space_map_from_set(isl_space_range(Space));
475 Space = isl_space_align_params(Space, SpaceSize);
476
477 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
478 isl_id_free(ParamId);
479
480 MapOne = isl_map_universe(isl_space_copy(Space));
481 for (int j = 0; j < Size; ++j)
482 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
483 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
484
485 MapTwo = isl_map_universe(isl_space_copy(Space));
486 for (int j = 0; j < Size; ++j)
487 if (j < i || j > i + 1)
488 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
489
490 isl_local_space *LS = isl_local_space_from_space(Space);
491 isl_constraint *C;
492 C = isl_equality_alloc(isl_local_space_copy(LS));
493 C = isl_constraint_set_constant_si(C, -1);
494 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
495 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
496 MapTwo = isl_map_add_constraint(MapTwo, C);
497 C = isl_equality_alloc(LS);
498 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
499 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
500 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
501 MapTwo = isl_map_add_constraint(MapTwo, C);
502 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
503
504 MapOne = isl_map_union(MapOne, MapTwo);
505 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
506 }
507 return AccessRelation;
508}
509
Johannes Doerfert13c8cf22014-08-10 08:09:38 +0000510MemoryAccess::MemoryAccess(const IRAccess &Access, Instruction *AccInst,
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000511 ScopStmt *Statement, const ScopArrayInfo *SAI,
512 int Identifier)
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000513 : AccType(getMemoryAccessType(Access)), Statement(Statement),
514 AccessInstruction(AccInst), AccessValue(Access.getAccessValue()),
Tobias Grosser166c4222015-09-05 07:46:40 +0000515 NewAccessRelation(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +0000516
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000517 isl_ctx *Ctx = Statement->getIslCtx();
Tobias Grosser9759f852011-11-10 12:44:55 +0000518 BaseAddr = Access.getBase();
Johannes Doerfert79fc23f2014-07-24 23:48:02 +0000519 BaseName = getIslCompatibleName("MemRef_", getBaseAddr(), "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000520
521 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000522
Tobias Grosserac3a95f2015-08-03 17:53:21 +0000523 auto IdName = "__polly_array_ref_" + std::to_string(Identifier);
Tobias Grossere29d31c2015-05-15 12:24:09 +0000524 Id = isl_id_alloc(Ctx, IdName.c_str(), nullptr);
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000525
Tobias Grossera1879642011-12-20 10:43:14 +0000526 if (!Access.isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000527 // We overapproximate non-affine accesses with a possible access to the
528 // whole array. For read accesses it does not make a difference, if an
529 // access must or may happen. However, for write accesses it is important to
530 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser04d6ae62013-06-23 06:04:54 +0000531 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000532 AccessRelation =
533 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Johannes Doerferte7044942015-02-24 11:58:30 +0000534
535 computeBoundsOnAccessRelation(Access.getElemSizeInBytes());
Tobias Grossera1879642011-12-20 10:43:14 +0000536 return;
537 }
538
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000539 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000540 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000541
Tobias Grosser79baa212014-04-10 08:38:02 +0000542 for (int i = 0, Size = Access.Subscripts.size(); i < Size; ++i) {
Johannes Doerfert574182d2015-08-12 10:19:50 +0000543 isl_pw_aff *Affine = Statement->getPwAff(Access.Subscripts[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000544
Sebastian Pop422e33f2014-06-03 18:16:31 +0000545 if (Size == 1) {
546 // For the non delinearized arrays, divide the access function of the last
547 // subscript by the size of the elements in the array.
Sebastian Pop18016682014-04-08 21:20:44 +0000548 //
549 // A stride one array access in C expressed as A[i] is expressed in
550 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
551 // two subsequent values of 'i' index two values that are stored next to
552 // each other in memory. By this division we make this characteristic
553 // obvious again.
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000554 isl_val *v = isl_val_int_from_si(Ctx, Access.getElemSizeInBytes());
Sebastian Pop18016682014-04-08 21:20:44 +0000555 Affine = isl_pw_aff_scale_down_val(Affine, v);
556 }
557
558 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
559
Tobias Grosser79baa212014-04-10 08:38:02 +0000560 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000561 }
562
Tobias Grosser619190d2015-03-30 17:22:28 +0000563 AccessRelation = foldAccess(Access, AccessRelation, Statement);
564
Tobias Grosser79baa212014-04-10 08:38:02 +0000565 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000566 AccessRelation = isl_map_set_tuple_id(
567 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000568 AccessRelation =
569 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
570
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000571 assumeNoOutOfBound(Access);
Tobias Grosseraa660a92015-03-30 00:07:50 +0000572 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000573 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000574}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000575
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000576void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000577 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000578 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000579}
580
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000581const std::string MemoryAccess::getReductionOperatorStr() const {
582 return MemoryAccess::getReductionOperatorStr(getReductionType());
583}
584
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000585__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
586
Johannes Doerfertf6183392014-07-01 20:52:51 +0000587raw_ostream &polly::operator<<(raw_ostream &OS,
588 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000589 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000590 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000591 else
592 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000593 return OS;
594}
595
Tobias Grosser75805372011-04-29 06:27:02 +0000596void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000597 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000598 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000599 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000600 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000601 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000602 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000603 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000604 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000605 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000606 break;
607 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000608 OS << "[Reduction Type: " << getReductionType() << "] ";
609 OS << "[Scalar: " << isScalar() << "]\n";
Johannes Doerferta99130f2014-10-13 12:58:03 +0000610 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000611 if (hasNewAccessRelation())
612 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000613}
614
Tobias Grosser74394f02013-01-14 22:40:23 +0000615void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000616
617// Create a map in the size of the provided set domain, that maps from the
618// one element of the provided set domain to another element of the provided
619// set domain.
620// The mapping is limited to all points that are equal in all but the last
621// dimension and for which the last dimension of the input is strict smaller
622// than the last dimension of the output.
623//
624// getEqualAndLarger(set[i0, i1, ..., iX]):
625//
626// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
627// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
628//
Tobias Grosserf5338802011-10-06 00:03:35 +0000629static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000630 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000631 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000632 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000633
634 // Set all but the last dimension to be equal for the input and output
635 //
636 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
637 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000638 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000639 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000640
641 // Set the last dimension of the input to be strict smaller than the
642 // last dimension of the output.
643 //
644 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000645 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
646 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000647 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000648}
649
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000650__isl_give isl_set *
651MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000652 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000653 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000654 isl_space *Space = isl_space_range(isl_map_get_space(S));
655 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000656
Sebastian Popa00a0292012-12-18 07:46:06 +0000657 S = isl_map_reverse(S);
658 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000659
Sebastian Popa00a0292012-12-18 07:46:06 +0000660 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
661 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
662 NextScatt = isl_map_apply_domain(NextScatt, S);
663 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000664
Sebastian Popa00a0292012-12-18 07:46:06 +0000665 isl_set *Deltas = isl_map_deltas(NextScatt);
666 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000667}
668
Sebastian Popa00a0292012-12-18 07:46:06 +0000669bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000670 int StrideWidth) const {
671 isl_set *Stride, *StrideX;
672 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000673
Sebastian Popa00a0292012-12-18 07:46:06 +0000674 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000675 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000676 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
677 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
678 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
679 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000680 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000681
Tobias Grosser28dd4862012-01-24 16:42:16 +0000682 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000683 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000684
Tobias Grosser28dd4862012-01-24 16:42:16 +0000685 return IsStrideX;
686}
687
Sebastian Popa00a0292012-12-18 07:46:06 +0000688bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
689 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000690}
691
Tobias Grosser79baa212014-04-10 08:38:02 +0000692bool MemoryAccess::isScalar() const {
693 return isl_map_n_out(AccessRelation) == 0;
694}
695
Sebastian Popa00a0292012-12-18 07:46:06 +0000696bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
697 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000698}
699
Tobias Grosser166c4222015-09-05 07:46:40 +0000700void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
701 isl_map_free(NewAccessRelation);
702 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000703}
Tobias Grosser75805372011-04-29 06:27:02 +0000704
705//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000706
Tobias Grosser808cd692015-07-14 09:33:13 +0000707isl_map *ScopStmt::getSchedule() const {
708 isl_set *Domain = getDomain();
709 if (isl_set_is_empty(Domain)) {
710 isl_set_free(Domain);
711 return isl_map_from_aff(
712 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
713 }
714 auto *Schedule = getParent()->getSchedule();
715 Schedule = isl_union_map_intersect_domain(
716 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
717 if (isl_union_map_is_empty(Schedule)) {
718 isl_set_free(Domain);
719 isl_union_map_free(Schedule);
720 return isl_map_from_aff(
721 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
722 }
723 auto *M = isl_map_from_union_map(Schedule);
724 M = isl_map_coalesce(M);
725 M = isl_map_gist_domain(M, Domain);
726 M = isl_map_coalesce(M);
727 return M;
728}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000729
Johannes Doerfert574182d2015-08-12 10:19:50 +0000730__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Johannes Doerfertb409fdc2015-08-28 09:24:35 +0000731 return getParent()->getPwAff(E, Domain);
Johannes Doerfert574182d2015-08-12 10:19:50 +0000732}
733
Tobias Grosser37eb4222014-02-20 21:43:54 +0000734void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
735 assert(isl_set_is_subset(NewDomain, Domain) &&
736 "New domain is not a subset of old domain!");
737 isl_set_free(Domain);
738 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000739}
740
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000741void ScopStmt::buildAccesses(TempScop &tempScop, BasicBlock *Block,
742 bool isApproximated) {
743 AccFuncSetType *AFS = tempScop.getAccessFunctions(Block);
744 if (!AFS)
745 return;
746
747 for (auto &AccessPair : *AFS) {
748 IRAccess &Access = AccessPair.first;
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000749 Instruction *AccessInst = AccessPair.second;
Johannes Doerfertd86f2152015-08-17 10:58:17 +0000750 Type *ElementType = Access.getAccessValue()->getType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000751
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000752 const ScopArrayInfo *SAI = getParent()->getOrCreateScopArrayInfo(
Tobias Grosser92245222015-07-28 14:53:44 +0000753 Access.getBase(), ElementType, Access.Sizes, Access.isPHI());
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000754
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000755 if (isApproximated && Access.isWrite())
756 Access.setMayWrite();
757
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000758 MemoryAccessList *&MAL = InstructionToAccess[AccessInst];
759 if (!MAL)
760 MAL = new MemoryAccessList();
761 MAL->emplace_front(Access, AccessInst, this, SAI, MemAccs.size());
762 MemAccs.push_back(&MAL->front());
Tobias Grosser75805372011-04-29 06:27:02 +0000763 }
764}
765
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000766void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000767 for (MemoryAccess *MA : *this)
768 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000769
770 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000771}
772
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000773/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
774static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
775 void *User) {
776 isl_set **BoundedParts = static_cast<isl_set **>(User);
777 if (isl_basic_set_is_bounded(BSet))
778 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
779 else
780 isl_basic_set_free(BSet);
781 return isl_stat_ok;
782}
783
784/// @brief Return the bounded parts of @p S.
785static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
786 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
787 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
788 isl_set_free(S);
789 return BoundedParts;
790}
791
792/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
793///
794/// @returns A separation of @p S into first an unbounded then a bounded subset,
795/// both with regards to the dimension @p Dim.
796static std::pair<__isl_give isl_set *, __isl_give isl_set *>
797partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
798
799 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
800 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
801
802 unsigned NumDimsS = isl_set_n_dim(S);
803 isl_set *OnlyDimS = isl_set_copy(S);
804
805 // Remove dimensions that are greater than Dim as they are not interesting.
806 assert(NumDimsS >= Dim + 1);
807 OnlyDimS =
808 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
809
810 // Create artificial parametric upper bounds for dimensions smaller than Dim
811 // as we are not interested in them.
812 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
813 for (unsigned u = 0; u < Dim; u++) {
814 isl_constraint *C = isl_inequality_alloc(
815 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
816 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
817 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
818 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
819 }
820
821 // Collect all bounded parts of OnlyDimS.
822 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
823
824 // Create the dimensions greater than Dim again.
825 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
826 NumDimsS - Dim - 1);
827
828 // Remove the artificial upper bound parameters again.
829 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
830
831 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
832 return std::make_pair(UnboundedParts, BoundedParts);
833}
834
Johannes Doerfert96425c22015-08-30 21:13:53 +0000835static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
836 isl_pw_aff *L, isl_pw_aff *R) {
837 switch (Pred) {
838 case ICmpInst::ICMP_EQ:
839 return isl_pw_aff_eq_set(L, R);
840 case ICmpInst::ICMP_NE:
841 return isl_pw_aff_ne_set(L, R);
842 case ICmpInst::ICMP_SLT:
843 return isl_pw_aff_lt_set(L, R);
844 case ICmpInst::ICMP_SLE:
845 return isl_pw_aff_le_set(L, R);
846 case ICmpInst::ICMP_SGT:
847 return isl_pw_aff_gt_set(L, R);
848 case ICmpInst::ICMP_SGE:
849 return isl_pw_aff_ge_set(L, R);
850 case ICmpInst::ICMP_ULT:
851 return isl_pw_aff_lt_set(L, R);
852 case ICmpInst::ICMP_UGT:
853 return isl_pw_aff_gt_set(L, R);
854 case ICmpInst::ICMP_ULE:
855 return isl_pw_aff_le_set(L, R);
856 case ICmpInst::ICMP_UGE:
857 return isl_pw_aff_ge_set(L, R);
858 default:
859 llvm_unreachable("Non integer predicate not supported");
860 }
861}
862
863/// @brief Build the conditions sets for the branch @p BI in the @p Domain.
864///
865/// This will fill @p ConditionSets with the conditions under which control
866/// will be moved from @p BI to its successors. Hence, @p ConditionSets will
867/// have as many elements as @p BI has successors.
868static void
869buildConditionSets(Scop &S, BranchInst *BI, Loop *L, __isl_keep isl_set *Domain,
870 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
871
872 if (BI->isUnconditional()) {
873 ConditionSets.push_back(isl_set_copy(Domain));
874 return;
875 }
876
877 Value *Condition = BI->getCondition();
878
879 isl_set *ConsequenceCondSet = nullptr;
880 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
881 if (CCond->isZero())
882 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
883 else
884 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
885 } else {
886 auto *ICond = dyn_cast<ICmpInst>(Condition);
887 assert(ICond &&
888 "Condition of exiting branch was neither constant nor ICmp!");
889
890 ScalarEvolution &SE = *S.getSE();
891 isl_pw_aff *LHS, *RHS;
892 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), Domain);
893 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), Domain);
894 ConsequenceCondSet = buildConditionSet(ICond->getPredicate(), LHS, RHS);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +0000895
896 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
897 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
898 ConsequenceCondSet =
899 isl_set_set_dim_id(ConsequenceCondSet, isl_dim_set, u, DimId);
900 }
Johannes Doerfert96425c22015-08-30 21:13:53 +0000901 }
902
903 assert(ConsequenceCondSet);
904 isl_set *AlternativeCondSet =
905 isl_set_complement(isl_set_copy(ConsequenceCondSet));
906
907 ConditionSets.push_back(isl_set_coalesce(
908 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
909 ConditionSets.push_back(isl_set_coalesce(
910 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
911}
912
Johannes Doerfert32ae76e2015-09-10 13:12:02 +0000913void ScopStmt::buildDomain() {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000914 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +0000915
Tobias Grosser084d8f72012-05-29 09:29:44 +0000916 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
917
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +0000918 Domain = getParent()->getDomainConditions(this);
Johannes Doerfert96425c22015-08-30 21:13:53 +0000919 Domain = isl_set_coalesce(Domain);
Tobias Grosser084d8f72012-05-29 09:29:44 +0000920 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +0000921}
922
Tobias Grosser7b50bee2014-11-25 10:51:12 +0000923void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
924 int Dimension = 0;
925 isl_ctx *Ctx = Parent.getIslCtx();
926 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
927 Type *Ty = GEP->getPointerOperandType();
928 ScalarEvolution &SE = *Parent.getSE();
929
930 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
931 Dimension = 1;
932 Ty = PtrTy->getElementType();
933 }
934
935 while (auto ArrayTy = dyn_cast<ArrayType>(Ty)) {
936 unsigned int Operand = 1 + Dimension;
937
938 if (GEP->getNumOperands() <= Operand)
939 break;
940
941 const SCEV *Expr = SE.getSCEV(GEP->getOperand(Operand));
942
943 if (isAffineExpr(&Parent.getRegion(), Expr, SE)) {
Johannes Doerfert574182d2015-08-12 10:19:50 +0000944 isl_pw_aff *AccessOffset = getPwAff(Expr);
Tobias Grosser7b50bee2014-11-25 10:51:12 +0000945 AccessOffset =
946 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
947
948 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
949 isl_local_space_copy(LSpace),
950 isl_val_int_from_si(Ctx, ArrayTy->getNumElements())));
951
952 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
953 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
954 OutOfBound = isl_set_params(OutOfBound);
955 isl_set *InBound = isl_set_complement(OutOfBound);
956 isl_set *Executed = isl_set_params(getDomain());
957
958 // A => B == !A or B
959 isl_set *InBoundIfExecuted =
960 isl_set_union(isl_set_complement(Executed), InBound);
961
962 Parent.addAssumption(InBoundIfExecuted);
963 }
964
965 Dimension += 1;
966 Ty = ArrayTy->getElementType();
967 }
968
969 isl_local_space_free(LSpace);
970}
971
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000972void ScopStmt::deriveAssumptions(BasicBlock *Block) {
973 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +0000974 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
975 deriveAssumptionsFromGEP(GEP);
976}
977
Johannes Doerfertb68cffb2015-09-10 15:27:46 +0000978void ScopStmt::collectSurroundingLoops() {
979 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
980 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
981 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
982 isl_id_free(DimId);
983 }
984}
985
986ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, Region &R)
987 : Parent(parent), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000988
Tobias Grosser16c44032015-07-09 07:31:45 +0000989 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000990
Johannes Doerfert32ae76e2015-09-10 13:12:02 +0000991 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +0000992 collectSurroundingLoops();
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000993
994 BasicBlock *EntryBB = R.getEntry();
995 for (BasicBlock *Block : R.blocks()) {
996 buildAccesses(tempScop, Block, Block != EntryBB);
997 deriveAssumptions(Block);
998 }
Tobias Grosserd83b8a82015-08-20 19:08:11 +0000999 if (DetectReductions)
1000 checkForReductions();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001001}
1002
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001003ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, BasicBlock &bb)
1004 : Parent(parent), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001005
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001006 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Tobias Grosser75805372011-04-29 06:27:02 +00001007
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001008 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001009 collectSurroundingLoops();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001010 buildAccesses(tempScop, BB);
1011 deriveAssumptions(BB);
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001012 if (DetectReductions)
1013 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001014}
1015
Johannes Doerferte58a0122014-06-27 20:31:28 +00001016/// @brief Collect loads which might form a reduction chain with @p StoreMA
1017///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001018/// Check if the stored value for @p StoreMA is a binary operator with one or
1019/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001020/// used only once (by @p StoreMA) and its load operands are also used only
1021/// once, we have found a possible reduction chain. It starts at an operand
1022/// load and includes the binary operator and @p StoreMA.
1023///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001024/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001025/// escape this block or into any other store except @p StoreMA.
1026void ScopStmt::collectCandiateReductionLoads(
1027 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1028 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1029 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001030 return;
1031
1032 // Skip if there is not one binary operator between the load and the store
1033 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001034 if (!BinOp)
1035 return;
1036
1037 // Skip if the binary operators has multiple uses
1038 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001039 return;
1040
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001041 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001042 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1043 return;
1044
Johannes Doerfert9890a052014-07-01 00:32:29 +00001045 // Skip if the binary operator is outside the current SCoP
1046 if (BinOp->getParent() != Store->getParent())
1047 return;
1048
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001049 // Skip if it is a multiplicative reduction and we disabled them
1050 if (DisableMultiplicativeReductions &&
1051 (BinOp->getOpcode() == Instruction::Mul ||
1052 BinOp->getOpcode() == Instruction::FMul))
1053 return;
1054
Johannes Doerferte58a0122014-06-27 20:31:28 +00001055 // Check the binary operator operands for a candidate load
1056 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1057 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1058 if (!PossibleLoad0 && !PossibleLoad1)
1059 return;
1060
1061 // A load is only a candidate if it cannot escape (thus has only this use)
1062 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001063 if (PossibleLoad0->getParent() == Store->getParent())
1064 Loads.push_back(lookupAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001065 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001066 if (PossibleLoad1->getParent() == Store->getParent())
1067 Loads.push_back(lookupAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001068}
1069
1070/// @brief Check for reductions in this ScopStmt
1071///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001072/// Iterate over all store memory accesses and check for valid binary reduction
1073/// like chains. For all candidates we check if they have the same base address
1074/// and there are no other accesses which overlap with them. The base address
1075/// check rules out impossible reductions candidates early. The overlap check,
1076/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001077/// guarantees that none of the intermediate results will escape during
1078/// execution of the loop nest. We basically check here that no other memory
1079/// access can access the same memory as the potential reduction.
1080void ScopStmt::checkForReductions() {
1081 SmallVector<MemoryAccess *, 2> Loads;
1082 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1083
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001084 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001085 // stores and collecting possible reduction loads.
1086 for (MemoryAccess *StoreMA : MemAccs) {
1087 if (StoreMA->isRead())
1088 continue;
1089
1090 Loads.clear();
1091 collectCandiateReductionLoads(StoreMA, Loads);
1092 for (MemoryAccess *LoadMA : Loads)
1093 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1094 }
1095
1096 // Then check each possible candidate pair.
1097 for (const auto &CandidatePair : Candidates) {
1098 bool Valid = true;
1099 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1100 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1101
1102 // Skip those with obviously unequal base addresses.
1103 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1104 isl_map_free(LoadAccs);
1105 isl_map_free(StoreAccs);
1106 continue;
1107 }
1108
1109 // And check if the remaining for overlap with other memory accesses.
1110 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1111 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1112 isl_set *AllAccs = isl_map_range(AllAccsRel);
1113
1114 for (MemoryAccess *MA : MemAccs) {
1115 if (MA == CandidatePair.first || MA == CandidatePair.second)
1116 continue;
1117
1118 isl_map *AccRel =
1119 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1120 isl_set *Accs = isl_map_range(AccRel);
1121
1122 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1123 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1124 Valid = Valid && isl_set_is_empty(OverlapAccs);
1125 isl_set_free(OverlapAccs);
1126 }
1127 }
1128
1129 isl_set_free(AllAccs);
1130 if (!Valid)
1131 continue;
1132
Johannes Doerfertf6183392014-07-01 20:52:51 +00001133 const LoadInst *Load =
1134 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1135 MemoryAccess::ReductionType RT =
1136 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1137
Johannes Doerferte58a0122014-06-27 20:31:28 +00001138 // If no overlapping access was found we mark the load and store as
1139 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001140 CandidatePair.first->markAsReductionLike(RT);
1141 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001142 }
Tobias Grosser75805372011-04-29 06:27:02 +00001143}
1144
Tobias Grosser74394f02013-01-14 22:40:23 +00001145std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001146
Tobias Grosser54839312015-04-21 11:37:25 +00001147std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001148 auto *S = getSchedule();
1149 auto Str = stringFromIslObj(S);
1150 isl_map_free(S);
1151 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001152}
1153
Tobias Grosser74394f02013-01-14 22:40:23 +00001154unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001155
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001156unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001157
Tobias Grosser75805372011-04-29 06:27:02 +00001158const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1159
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001160const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001161 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001162}
1163
Tobias Grosser74394f02013-01-14 22:40:23 +00001164isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001165
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001166__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001167
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001168__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001169 return isl_set_get_space(Domain);
1170}
1171
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001172__isl_give isl_id *ScopStmt::getDomainId() const {
1173 return isl_set_get_tuple_id(Domain);
1174}
Tobias Grossercd95b772012-08-30 11:49:38 +00001175
Tobias Grosser75805372011-04-29 06:27:02 +00001176ScopStmt::~ScopStmt() {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001177 DeleteContainerSeconds(InstructionToAccess);
Tobias Grosser75805372011-04-29 06:27:02 +00001178 isl_set_free(Domain);
Tobias Grosser75805372011-04-29 06:27:02 +00001179}
1180
1181void ScopStmt::print(raw_ostream &OS) const {
1182 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001183 OS.indent(12) << "Domain :=\n";
1184
1185 if (Domain) {
1186 OS.indent(16) << getDomainStr() << ";\n";
1187 } else
1188 OS.indent(16) << "n/a\n";
1189
Tobias Grosser54839312015-04-21 11:37:25 +00001190 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001191
1192 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001193 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001194 } else
1195 OS.indent(16) << "n/a\n";
1196
Tobias Grosser083d3d32014-06-28 08:59:45 +00001197 for (MemoryAccess *Access : MemAccs)
1198 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001199}
1200
1201void ScopStmt::dump() const { print(dbgs()); }
1202
1203//===----------------------------------------------------------------------===//
1204/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001205
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001206void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001207 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1208 isl_set_free(Context);
1209 Context = NewContext;
1210}
1211
Tobias Grosserabfbe632013-02-05 12:09:06 +00001212void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001213 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001214 Parameter = extractConstantFactor(Parameter, *SE).second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001215 if (ParameterIds.find(Parameter) != ParameterIds.end())
1216 continue;
1217
1218 int dimension = Parameters.size();
1219
1220 Parameters.push_back(Parameter);
1221 ParameterIds[Parameter] = dimension;
1222 }
1223}
1224
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001225__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) const {
1226 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001227
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001228 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001229 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001230
Tobias Grosser8f99c162011-11-15 11:38:55 +00001231 std::string ParameterName;
1232
1233 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1234 Value *Val = ValueParameter->getValue();
Tobias Grosser29ee0b12011-11-17 14:52:36 +00001235 ParameterName = Val->getName();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001236 }
1237
1238 if (ParameterName == "" || ParameterName.substr(0, 2) == "p_")
Hongbin Zheng86a37742012-04-25 08:01:38 +00001239 ParameterName = "p_" + utostr_32(IdIter->second);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001240
Tobias Grosser20532b82014-04-11 17:56:49 +00001241 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1242 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001243}
Tobias Grosser75805372011-04-29 06:27:02 +00001244
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001245isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1246 isl_set *DomainContext = isl_union_set_params(getDomains());
1247 return isl_set_intersect_params(C, DomainContext);
1248}
1249
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001250void Scop::addUserContext() {
1251 if (UserContextStr.empty())
1252 return;
1253
1254 isl_set *UserContext = isl_set_read_from_str(IslCtx, UserContextStr.c_str());
1255 isl_space *Space = getParamSpace();
1256 if (isl_space_dim(Space, isl_dim_param) !=
1257 isl_set_dim(UserContext, isl_dim_param)) {
1258 auto SpaceStr = isl_space_to_str(Space);
1259 errs() << "Error: the context provided in -polly-context has not the same "
1260 << "number of dimensions than the computed context. Due to this "
1261 << "mismatch, the -polly-context option is ignored. Please provide "
1262 << "the context in the parameter space: " << SpaceStr << ".\n";
1263 free(SpaceStr);
1264 isl_set_free(UserContext);
1265 isl_space_free(Space);
1266 return;
1267 }
1268
1269 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
1270 auto NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1271 auto NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
1272
1273 if (strcmp(NameContext, NameUserContext) != 0) {
1274 auto SpaceStr = isl_space_to_str(Space);
1275 errs() << "Error: the name of dimension " << i
1276 << " provided in -polly-context "
1277 << "is '" << NameUserContext << "', but the name in the computed "
1278 << "context is '" << NameContext
1279 << "'. Due to this name mismatch, "
1280 << "the -polly-context option is ignored. Please provide "
1281 << "the context in the parameter space: " << SpaceStr << ".\n";
1282 free(SpaceStr);
1283 isl_set_free(UserContext);
1284 isl_space_free(Space);
1285 return;
1286 }
1287
1288 UserContext =
1289 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1290 isl_space_get_dim_id(Space, isl_dim_param, i));
1291 }
1292
1293 Context = isl_set_intersect(Context, UserContext);
1294 isl_space_free(Space);
1295}
1296
Tobias Grosser6be480c2011-11-08 15:41:13 +00001297void Scop::buildContext() {
1298 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001299 Context = isl_set_universe(isl_space_copy(Space));
1300 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001301}
1302
Tobias Grosser18daaca2012-05-22 10:47:27 +00001303void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001304 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001305 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001306
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001307 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001308
Johannes Doerferte7044942015-02-24 11:58:30 +00001309 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001310 }
1311}
1312
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001313void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001314 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001315 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001316
Tobias Grosser083d3d32014-06-28 08:59:45 +00001317 for (const auto &ParamID : ParameterIds) {
1318 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001319 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001320 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001321 }
1322
1323 // Align the parameters of all data structures to the model.
1324 Context = isl_set_align_params(Context, Space);
1325
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001326 for (ScopStmt &Stmt : *this)
1327 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001328}
1329
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001330void Scop::simplifyAssumedContext() {
1331 // The parameter constraints of the iteration domains give us a set of
1332 // constraints that need to hold for all cases where at least a single
1333 // statement iteration is executed in the whole scop. We now simplify the
1334 // assumed context under the assumption that such constraints hold and at
1335 // least a single statement iteration is executed. For cases where no
1336 // statement instances are executed, the assumptions we have taken about
1337 // the executed code do not matter and can be changed.
1338 //
1339 // WARNING: This only holds if the assumptions we have taken do not reduce
1340 // the set of statement instances that are executed. Otherwise we
1341 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001342 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001343 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001344 // performed. In such a case, modifying the run-time conditions and
1345 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001346 // to not be executed.
1347 //
1348 // Example:
1349 //
1350 // When delinearizing the following code:
1351 //
1352 // for (long i = 0; i < 100; i++)
1353 // for (long j = 0; j < m; j++)
1354 // A[i+p][j] = 1.0;
1355 //
1356 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001357 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001358 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
1359 AssumedContext =
1360 isl_set_gist_params(AssumedContext, isl_union_set_params(getDomains()));
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001361 AssumedContext = isl_set_gist_params(AssumedContext, getContext());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001362}
1363
Johannes Doerfertb164c792014-09-18 11:17:17 +00001364/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001365static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001366 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1367 isl_pw_multi_aff *MinPMA, *MaxPMA;
1368 isl_pw_aff *LastDimAff;
1369 isl_aff *OneAff;
1370 unsigned Pos;
1371
Johannes Doerfert9143d672014-09-27 11:02:39 +00001372 // Restrict the number of parameters involved in the access as the lexmin/
1373 // lexmax computation will take too long if this number is high.
1374 //
1375 // Experiments with a simple test case using an i7 4800MQ:
1376 //
1377 // #Parameters involved | Time (in sec)
1378 // 6 | 0.01
1379 // 7 | 0.04
1380 // 8 | 0.12
1381 // 9 | 0.40
1382 // 10 | 1.54
1383 // 11 | 6.78
1384 // 12 | 30.38
1385 //
1386 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1387 unsigned InvolvedParams = 0;
1388 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1389 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1390 InvolvedParams++;
1391
1392 if (InvolvedParams > RunTimeChecksMaxParameters) {
1393 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001394 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00001395 }
1396 }
1397
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001398 Set = isl_set_remove_divs(Set);
1399
Johannes Doerfertb164c792014-09-18 11:17:17 +00001400 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1401 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1402
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001403 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1404 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1405
Johannes Doerfertb164c792014-09-18 11:17:17 +00001406 // Adjust the last dimension of the maximal access by one as we want to
1407 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1408 // we test during code generation might now point after the end of the
1409 // allocated array but we will never dereference it anyway.
1410 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1411 "Assumed at least one output dimension");
1412 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1413 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1414 OneAff = isl_aff_zero_on_domain(
1415 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1416 OneAff = isl_aff_add_constant_si(OneAff, 1);
1417 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1418 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1419
1420 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1421
1422 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001423 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001424}
1425
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001426static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1427 isl_set *Domain = MA->getStatement()->getDomain();
1428 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1429 return isl_set_reset_tuple_id(Domain);
1430}
1431
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001432/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
1433static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00001434 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001435 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001436
1437 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
1438 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001439 Locations = isl_union_set_coalesce(Locations);
1440 Locations = isl_union_set_detect_equalities(Locations);
1441 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00001442 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001443 isl_union_set_free(Locations);
1444 return Valid;
1445}
1446
Johannes Doerfert96425c22015-08-30 21:13:53 +00001447/// @brief Helper to treat non-affine regions and basic blocks the same.
1448///
1449///{
1450
1451/// @brief Return the block that is the representing block for @p RN.
1452static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
1453 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
1454 : RN->getNodeAs<BasicBlock>();
1455}
1456
1457/// @brief Return the @p idx'th block that is executed after @p RN.
1458static inline BasicBlock *getRegionNodeSuccessor(RegionNode *RN, BranchInst *BI,
1459 unsigned idx) {
1460 if (RN->isSubRegion()) {
1461 assert(idx == 0);
1462 return RN->getNodeAs<Region>()->getExit();
1463 }
1464 return BI->getSuccessor(idx);
1465}
1466
1467/// @brief Return the smallest loop surrounding @p RN.
1468static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
1469 if (!RN->isSubRegion())
1470 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
1471
1472 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
1473 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
1474 while (L && NonAffineSubRegion->contains(L))
1475 L = L->getParentLoop();
1476 return L;
1477}
1478
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001479static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
1480 if (!RN->isSubRegion())
1481 return 1;
1482
1483 unsigned NumBlocks = 0;
1484 Region *R = RN->getNodeAs<Region>();
1485 for (auto BB : R->blocks()) {
1486 (void)BB;
1487 NumBlocks++;
1488 }
1489 return NumBlocks;
1490}
1491
Johannes Doerfert96425c22015-08-30 21:13:53 +00001492///}
1493
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001494static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
1495 unsigned Dim, Loop *L) {
1496 isl_id *DimId =
1497 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
1498 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
1499}
1500
Johannes Doerfert96425c22015-08-30 21:13:53 +00001501isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
1502 BasicBlock *BB = Stmt->isBlockStmt() ? Stmt->getBasicBlock()
1503 : Stmt->getRegion()->getEntry();
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001504 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001505}
1506
1507void Scop::buildDomains(Region *R, LoopInfo &LI, ScopDetection &SD,
1508 DominatorTree &DT) {
1509
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001510 auto *EntryBB = R->getEntry();
1511 int LD = getRelativeLoopDepth(LI.getLoopFor(EntryBB));
1512 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001513
1514 Loop *L = LI.getLoopFor(EntryBB);
1515 while (LD-- >= 0) {
1516 S = addDomainDimId(S, LD + 1, L);
1517 L = L->getParentLoop();
1518 }
1519
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001520 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001521
1522 buildDomainsWithBranchConstraints(R, LI, SD, DT);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001523 addLoopBoundsToHeaderDomains(LI, SD, DT);
1524 propagateDomainConstraints(R, LI, SD, DT);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001525}
1526
1527void Scop::buildDomainsWithBranchConstraints(Region *R, LoopInfo &LI,
1528 ScopDetection &SD,
1529 DominatorTree &DT) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001530 RegionInfo &RI = *R->getRegionInfo();
Johannes Doerfert96425c22015-08-30 21:13:53 +00001531
1532 // To create the domain for each block in R we iterate over all blocks and
1533 // subregions in R and propagate the conditions under which the current region
1534 // element is executed. To this end we iterate in reverse post order over R as
1535 // it ensures that we first visit all predecessors of a region node (either a
1536 // basic block or a subregion) before we visit the region node itself.
1537 // Initially, only the domain for the SCoP region entry block is set and from
1538 // there we propagate the current domain to all successors, however we add the
1539 // condition that the successor is actually executed next.
1540 // As we are only interested in non-loop carried constraints here we can
1541 // simply skip loop back edges.
1542
1543 ReversePostOrderTraversal<Region *> RTraversal(R);
1544 for (auto *RN : RTraversal) {
1545
1546 // Recurse for affine subregions but go on for basic blocks and non-affine
1547 // subregions.
1548 if (RN->isSubRegion()) {
1549 Region *SubRegion = RN->getNodeAs<Region>();
1550 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
1551 buildDomainsWithBranchConstraints(SubRegion, LI, SD, DT);
1552 continue;
1553 }
1554 }
1555
1556 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001557 TerminatorInst *TI = BB->getTerminator();
1558
1559 // Unreachable instructions do not have successors so we can skip them.
1560 if (isa<UnreachableInst>(TI)) {
1561 // Assume unreachables only in error blocks.
1562 assert(isErrorBlock(*BB));
1563 continue;
1564 }
1565
Johannes Doerfert96425c22015-08-30 21:13:53 +00001566 isl_set *Domain = DomainMap[BB];
1567 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
1568 assert(Domain && "Due to reverse post order traversal of the region all "
1569 "predecessor of the current region node should have been "
1570 "visited and a domain for this region node should have "
1571 "been set.");
1572
1573 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1574 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1575
1576 // Build the condition sets for the successor nodes of the current region
1577 // node. If it is a non-affine subregion we will always execute the single
1578 // exit node, hence the single entry node domain is the condition set. For
1579 // basic blocks we use the helper function buildConditionSets.
1580 SmallVector<isl_set *, 2> ConditionSets;
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001581 BranchInst *BI = cast<BranchInst>(TI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001582 if (RN->isSubRegion())
1583 ConditionSets.push_back(isl_set_copy(Domain));
1584 else
1585 buildConditionSets(*this, BI, BBLoop, Domain, ConditionSets);
1586
1587 // Now iterate over the successors and set their initial domain based on
1588 // their condition set. We skip back edges here and have to be careful when
1589 // we leave a loop not to keep constraints over a dimension that doesn't
1590 // exist anymore.
1591 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
1592 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, BI, u);
1593 isl_set *CondSet = ConditionSets[u];
1594
1595 // Skip back edges.
1596 if (DT.dominates(SuccBB, BB)) {
1597 isl_set_free(CondSet);
1598 continue;
1599 }
1600
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001601 // Do not adjust the number of dimensions if we enter a boxed loop or are
1602 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001603 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001604 Region *SuccRegion = RI.getRegionFor(SuccBB);
1605 if (BBLoop != SuccBBLoop && !RN->isSubRegion() &&
1606 !(SD.isNonAffineSubRegion(SuccRegion, &getRegion()) &&
1607 SuccRegion->contains(SuccBBLoop))) {
1608
1609 // Check if the edge to SuccBB is a loop entry or exit edge. If so
1610 // adjust the dimensionality accordingly. Lastly, if we leave a loop
1611 // and enter a new one we need to drop the old constraints.
1612 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001613 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001614 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001615 CondSet = isl_set_project_out(CondSet, isl_dim_set,
1616 isl_set_n_dim(CondSet) - LoopDepthDiff,
1617 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001618 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001619 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00001620 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001621 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001622 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001623 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001624 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
1625 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001626 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00001627 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00001628 }
1629
1630 // Set the domain for the successor or merge it with an existing domain in
1631 // case there are multiple paths (without loop back edges) to the
1632 // successor block.
1633 isl_set *&SuccDomain = DomainMap[SuccBB];
1634 if (!SuccDomain)
1635 SuccDomain = CondSet;
1636 else
1637 SuccDomain = isl_set_union(SuccDomain, CondSet);
1638
1639 SuccDomain = isl_set_coalesce(SuccDomain);
1640 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : " << Domain
1641 << "\n");
1642 }
1643 }
1644}
1645
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001646/// @brief Return the domain for @p BB wrt @p DomainMap.
1647///
1648/// This helper function will lookup @p BB in @p DomainMap but also handle the
1649/// case where @p BB is contained in a non-affine subregion using the region
1650/// tree obtained by @p RI.
1651static __isl_give isl_set *
1652getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
1653 RegionInfo &RI) {
1654 auto DIt = DomainMap.find(BB);
1655 if (DIt != DomainMap.end())
1656 return isl_set_copy(DIt->getSecond());
1657
1658 Region *R = RI.getRegionFor(BB);
1659 while (R->getEntry() == BB)
1660 R = R->getParent();
1661 return getDomainForBlock(R->getEntry(), DomainMap, RI);
1662}
1663
1664void Scop::propagateDomainConstraints(Region *R, LoopInfo &LI,
1665 ScopDetection &SD, DominatorTree &DT) {
1666 // Iterate over the region R and propagate the domain constrains from the
1667 // predecessors to the current node. In contrast to the
1668 // buildDomainsWithBranchConstraints function, this one will pull the domain
1669 // information from the predecessors instead of pushing it to the successors.
1670 // Additionally, we assume the domains to be already present in the domain
1671 // map here. However, we iterate again in reverse post order so we know all
1672 // predecessors have been visited before a block or non-affine subregion is
1673 // visited.
1674
1675 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
1676 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
1677
1678 ReversePostOrderTraversal<Region *> RTraversal(R);
1679 for (auto *RN : RTraversal) {
1680
1681 // Recurse for affine subregions but go on for basic blocks and non-affine
1682 // subregions.
1683 if (RN->isSubRegion()) {
1684 Region *SubRegion = RN->getNodeAs<Region>();
1685 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
1686 propagateDomainConstraints(SubRegion, LI, SD, DT);
1687 continue;
1688 }
1689 }
1690
1691 BasicBlock *BB = getRegionNodeBasicBlock(RN);
1692 Loop *BBLoop = getRegionNodeLoop(RN, LI);
1693 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
1694
1695 isl_set *&Domain = DomainMap[BB];
1696 assert(Domain && "Due to reverse post order traversal of the region all "
1697 "predecessor of the current region node should have been "
1698 "visited and a domain for this region node should have "
1699 "been set.");
1700
1701 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
1702 for (auto *PredBB : predecessors(BB)) {
1703
1704 // Skip backedges
1705 if (DT.dominates(BB, PredBB))
1706 continue;
1707
1708 isl_set *PredBBDom = nullptr;
1709
1710 // Handle the SCoP entry block with its outside predecessors.
1711 if (!getRegion().contains(PredBB))
1712 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
1713
1714 if (!PredBBDom) {
1715 // Determine the loop depth of the predecessor and adjust its domain to
1716 // the domain of the current block. This can mean we have to:
1717 // o) Drop a dimension if this block is the exit of a loop, not the
1718 // header of a new loop and the predecessor was part of the loop.
1719 // o) Add an unconstrainted new dimension if this block is the header
1720 // of a loop and the predecessor is not part of it.
1721 // o) Drop the information about the innermost loop dimension when the
1722 // predecessor and the current block are surrounded by different
1723 // loops in the same depth.
1724 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
1725 Loop *PredBBLoop = LI.getLoopFor(PredBB);
1726 while (BoxedLoops.count(PredBBLoop))
1727 PredBBLoop = PredBBLoop->getParentLoop();
1728
1729 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001730 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001731 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001732 PredBBDom = isl_set_project_out(
1733 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
1734 LoopDepthDiff);
1735 else if (PredBBLoopDepth < BBLoopDepth) {
1736 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001737 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001738 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
1739 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001740 PredBBDom = isl_set_drop_constraints_involving_dims(
1741 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00001742 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001743 }
1744
1745 PredDom = isl_set_union(PredDom, PredBBDom);
1746 }
1747
1748 // Under the union of all predecessor conditions we can reach this block.
1749 Domain = isl_set_intersect(Domain, PredDom);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00001750
1751 // Add assumptions for error blocks.
1752 if (isErrorBlock(*BB)) {
1753 IsOptimized = true;
1754 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
1755 addAssumption(isl_set_complement(DomPar));
1756 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001757 }
1758}
1759
1760/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
1761/// is incremented by one and all other dimensions are equal, e.g.,
1762/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
1763/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
1764static __isl_give isl_map *
1765createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
1766 auto *MapSpace = isl_space_map_from_set(SetSpace);
1767 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
1768 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
1769 if (u != Dim)
1770 NextIterationMap =
1771 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
1772 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
1773 C = isl_constraint_set_constant_si(C, 1);
1774 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
1775 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
1776 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
1777 return NextIterationMap;
1778}
1779
1780/// @brief Add @p L & all children to @p Loops if they are not in @p BoxedLoops.
1781static inline void
1782addLoopAndSubloops(Loop *L, SmallVectorImpl<Loop *> &Loops,
1783 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
1784 if (BoxedLoops.count(L))
1785 return;
1786
1787 Loops.push_back(L);
1788 for (Loop *Subloop : *L)
1789 addLoopAndSubloops(Subloop, Loops, BoxedLoops);
1790}
1791
1792/// @brief Add loops in @p R to @p RegionLoops if they are not in @p BoxedLoops.
1793static inline void
1794collectLoopsInRegion(Region &R, LoopInfo &LI,
1795 SmallVector<Loop *, 8> &RegionLoops,
1796 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
1797
1798 SmallVector<Loop *, 8> Loops(LI.begin(), LI.end());
1799 while (!Loops.empty()) {
1800 Loop *L = Loops.pop_back_val();
1801
1802 if (R.contains(L))
1803 addLoopAndSubloops(L, RegionLoops, BoxedLoops);
1804 else if (L->contains(R.getEntry()))
1805 Loops.append(L->begin(), L->end());
1806 }
1807}
1808
1809/// @brief Create a set from @p Space with @p Dim fixed to 0.
1810static __isl_give isl_set *
1811createFirstIterationDomain(__isl_take isl_space *Space, unsigned Dim) {
1812 auto *Domain = isl_set_universe(Space);
1813 Domain = isl_set_fix_si(Domain, isl_dim_set, Dim, 0);
1814 return Domain;
1815}
1816
1817void Scop::addLoopBoundsToHeaderDomains(LoopInfo &LI, ScopDetection &SD,
1818 DominatorTree &DT) {
1819 // We iterate over all loops in the SCoP, create the condition set under which
1820 // we will take the back edge, and then apply these restrictions to the
1821 // header.
1822
1823 Region &R = getRegion();
1824 SmallVector<Loop *, 8> RegionLoops;
1825 collectLoopsInRegion(R, LI, RegionLoops, *SD.getBoxedLoops(&R));
1826
1827 while (!RegionLoops.empty()) {
1828 Loop *L = RegionLoops.pop_back_val();
1829 int LoopDepth = getRelativeLoopDepth(L);
1830 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
1831
1832 BasicBlock *LatchBB = L->getLoopLatch();
1833 assert(LatchBB && "TODO implement multiple exit loop handling");
1834
1835 isl_set *LatchBBDom = DomainMap[LatchBB];
1836 isl_set *BackedgeCondition = nullptr;
1837
1838 BasicBlock *HeaderBB = L->getHeader();
1839
1840 BranchInst *BI = cast<BranchInst>(LatchBB->getTerminator());
1841 if (BI->isUnconditional())
1842 BackedgeCondition = isl_set_copy(LatchBBDom);
1843 else {
1844 SmallVector<isl_set *, 2> ConditionSets;
1845 int idx = BI->getSuccessor(0) != HeaderBB;
1846 buildConditionSets(*this, BI, L, LatchBBDom, ConditionSets);
1847
1848 // Free the non back edge condition set as we do not need it.
1849 isl_set_free(ConditionSets[1 - idx]);
1850
1851 BackedgeCondition = ConditionSets[idx];
1852 }
1853
1854 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
1855 isl_set *FirstIteration =
1856 createFirstIterationDomain(isl_set_get_space(HeaderBBDom), LoopDepth);
1857
1858 isl_map *NextIterationMap =
1859 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
1860
1861 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
1862 assert(LatchLoopDepth >= LoopDepth);
1863 BackedgeCondition =
1864 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
1865 LatchLoopDepth - LoopDepth);
1866
1867 auto Parts = partitionSetParts(BackedgeCondition, LoopDepth);
1868
1869 // If a loop has an unbounded back edge condition part (here Parts.first)
1870 // we do not want to assume the header will even be executed for the first
1871 // iteration of an execution that will lead to an infinite loop. While it
1872 // would not be wrong to do so, it does not seem helpful.
1873 FirstIteration = isl_set_subtract(FirstIteration, Parts.first);
1874
1875 BackedgeCondition = isl_set_apply(Parts.second, NextIterationMap);
1876 BackedgeCondition = isl_set_union(BackedgeCondition, FirstIteration);
1877 BackedgeCondition = isl_set_coalesce(BackedgeCondition);
1878
1879 HeaderBBDom = isl_set_intersect(HeaderBBDom, BackedgeCondition);
1880 }
1881}
1882
Johannes Doerfert120de4b2015-08-20 18:30:08 +00001883void Scop::buildAliasChecks(AliasAnalysis &AA) {
1884 if (!PollyUseRuntimeAliasChecks)
1885 return;
1886
1887 if (buildAliasGroups(AA))
1888 return;
1889
1890 // If a problem occurs while building the alias groups we need to delete
1891 // this SCoP and pretend it wasn't valid in the first place. To this end
1892 // we make the assumed context infeasible.
1893 addAssumption(isl_set_empty(getParamSpace()));
1894
1895 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
1896 << " could not be created as the number of parameters involved "
1897 "is too high. The SCoP will be "
1898 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
1899 "the maximal number of parameters but be advised that the "
1900 "compile time might increase exponentially.\n\n");
1901}
1902
Johannes Doerfert9143d672014-09-27 11:02:39 +00001903bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001904 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001905 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00001906 // for all memory accesses inside the SCoP.
1907 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001908 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00001909 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001910 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001911 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001912 // if their access domains intersect, otherwise they are in different
1913 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001914 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001915 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00001916 // and maximal accesses to each array of a group in read only and non
1917 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00001918 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
1919
1920 AliasSetTracker AST(AA);
1921
1922 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00001923 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001924 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00001925
1926 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001927 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00001928 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
1929 isl_set_free(StmtDomain);
1930 if (StmtDomainEmpty)
1931 continue;
1932
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001933 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001934 if (MA->isScalar())
1935 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00001936 if (!MA->isRead())
1937 HasWriteAccess.insert(MA->getBaseAddr());
Johannes Doerfertb164c792014-09-18 11:17:17 +00001938 Instruction *Acc = MA->getAccessInstruction();
1939 PtrToAcc[getPointerOperand(*Acc)] = MA;
1940 AST.add(Acc);
1941 }
1942 }
1943
1944 SmallVector<AliasGroupTy, 4> AliasGroups;
1945 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00001946 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00001947 continue;
1948 AliasGroupTy AG;
1949 for (auto PR : AS)
1950 AG.push_back(PtrToAcc[PR.getValue()]);
1951 assert(AG.size() > 1 &&
1952 "Alias groups should contain at least two accesses");
1953 AliasGroups.push_back(std::move(AG));
1954 }
1955
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001956 // Split the alias groups based on their domain.
1957 for (unsigned u = 0; u < AliasGroups.size(); u++) {
1958 AliasGroupTy NewAG;
1959 AliasGroupTy &AG = AliasGroups[u];
1960 AliasGroupTy::iterator AGI = AG.begin();
1961 isl_set *AGDomain = getAccessDomain(*AGI);
1962 while (AGI != AG.end()) {
1963 MemoryAccess *MA = *AGI;
1964 isl_set *MADomain = getAccessDomain(MA);
1965 if (isl_set_is_disjoint(AGDomain, MADomain)) {
1966 NewAG.push_back(MA);
1967 AGI = AG.erase(AGI);
1968 isl_set_free(MADomain);
1969 } else {
1970 AGDomain = isl_set_union(AGDomain, MADomain);
1971 AGI++;
1972 }
1973 }
1974 if (NewAG.size() > 1)
1975 AliasGroups.push_back(std::move(NewAG));
1976 isl_set_free(AGDomain);
1977 }
1978
Tobias Grosserf4c24b22015-04-05 13:11:54 +00001979 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00001980 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
1981 for (AliasGroupTy &AG : AliasGroups) {
1982 NonReadOnlyBaseValues.clear();
1983 ReadOnlyPairs.clear();
1984
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001985 if (AG.size() < 2) {
1986 AG.clear();
1987 continue;
1988 }
1989
Johannes Doerfert13771732014-10-01 12:40:46 +00001990 for (auto II = AG.begin(); II != AG.end();) {
1991 Value *BaseAddr = (*II)->getBaseAddr();
1992 if (HasWriteAccess.count(BaseAddr)) {
1993 NonReadOnlyBaseValues.insert(BaseAddr);
1994 II++;
1995 } else {
1996 ReadOnlyPairs[BaseAddr].insert(*II);
1997 II = AG.erase(II);
1998 }
1999 }
2000
2001 // If we don't have read only pointers check if there are at least two
2002 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002003 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002004 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002005 continue;
2006 }
2007
2008 // If we don't have non read only pointers clear the alias group.
2009 if (NonReadOnlyBaseValues.empty()) {
2010 AG.clear();
2011 continue;
2012 }
2013
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002014 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002015 MinMaxAliasGroups.emplace_back();
2016 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2017 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2018 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2019 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002020
2021 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002022
2023 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002024 for (MemoryAccess *MA : AG)
2025 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002026
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002027 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2028 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002029
2030 // Bail out if the number of values we need to compare is too large.
2031 // This is important as the number of comparisions grows quadratically with
2032 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002033 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2034 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002035 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002036
2037 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002038 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002039 Accesses = isl_union_map_empty(getParamSpace());
2040
2041 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2042 for (MemoryAccess *MA : ReadOnlyPair.second)
2043 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2044
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002045 Valid =
2046 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002047
2048 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002049 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002050 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002051
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002052 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002053}
2054
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002055static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
2056 Loop *L = LI.getLoopFor(R.getEntry());
2057 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2058}
2059
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002060static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2061 ScopDetection &SD) {
2062
2063 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2064
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002065 unsigned MinLD = INT_MAX, MaxLD = 0;
2066 for (BasicBlock *BB : R.blocks()) {
2067 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002068 if (!R.contains(L))
2069 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002070 if (BoxedLoops && BoxedLoops->count(L))
2071 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002072 unsigned LD = L->getLoopDepth();
2073 MinLD = std::min(MinLD, LD);
2074 MaxLD = std::max(MaxLD, LD);
2075 }
2076 }
2077
2078 // Handle the case that there is no loop in the SCoP first.
2079 if (MaxLD == 0)
2080 return 1;
2081
2082 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2083 assert(MaxLD >= MinLD &&
2084 "Maximal loop depth was smaller than mininaml loop depth?");
2085 return MaxLD - MinLD + 1;
2086}
2087
Johannes Doerfert96425c22015-08-30 21:13:53 +00002088Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, DominatorTree &DT,
2089 isl_ctx *Context, unsigned MaxLoopDepth)
2090 : DT(DT), SE(&ScalarEvolution), R(R), IsOptimized(false),
Johannes Doerfert717b8662015-09-08 21:44:27 +00002091 HasSingleExitEdge(R.getExitingBlock()), MaxLoopDepth(MaxLoopDepth),
2092 IslCtx(Context), Affinator(this) {}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002093
Tobias Grosser40985012015-08-20 19:08:05 +00002094void Scop::initFromTempScop(TempScop &TempScop, LoopInfo &LI, ScopDetection &SD,
2095 AliasAnalysis &AA) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002096 buildContext();
Tobias Grosser75805372011-04-29 06:27:02 +00002097
Johannes Doerfert96425c22015-08-30 21:13:53 +00002098 buildDomains(&R, LI, SD, DT);
2099
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002100 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> LoopSchedules;
Tobias Grosser75805372011-04-29 06:27:02 +00002101
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002102 Loop *L = getLoopSurroundingRegion(R, LI);
2103 LoopSchedules[L];
2104 buildSchedule(&R, TempScop, LI, SD, LoopSchedules);
2105 Schedule = LoopSchedules[L].first;
Tobias Grosser75805372011-04-29 06:27:02 +00002106
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002107 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002108 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002109 addUserContext();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002110 simplifyAssumedContext();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002111 buildAliasChecks(AA);
Tobias Grosser75805372011-04-29 06:27:02 +00002112}
2113
Michael Kruse471a5e32015-07-30 19:27:04 +00002114Scop *Scop::createFromTempScop(TempScop &TempScop, LoopInfo &LI,
2115 ScalarEvolution &SE, ScopDetection &SD,
Johannes Doerfert96425c22015-08-30 21:13:53 +00002116 AliasAnalysis &AA, DominatorTree &DT,
2117 isl_ctx *ctx) {
Michael Kruse471a5e32015-07-30 19:27:04 +00002118 auto &R = TempScop.getMaxRegion();
2119 auto MaxLoopDepth = getMaxLoopDepthInRegion(R, LI, SD);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002120 auto S = new Scop(R, SE, DT, ctx, MaxLoopDepth);
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002121 S->initFromTempScop(TempScop, LI, SD, AA);
2122
Michael Kruse471a5e32015-07-30 19:27:04 +00002123 return S;
2124}
2125
Tobias Grosser75805372011-04-29 06:27:02 +00002126Scop::~Scop() {
2127 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002128 isl_set_free(AssumedContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002129 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002130
Johannes Doerfert96425c22015-08-30 21:13:53 +00002131 for (auto It : DomainMap)
2132 isl_set_free(It.second);
2133
Johannes Doerfertb164c792014-09-18 11:17:17 +00002134 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002135 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002136 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002137 isl_pw_multi_aff_free(MMA.first);
2138 isl_pw_multi_aff_free(MMA.second);
2139 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002140 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002141 isl_pw_multi_aff_free(MMA.first);
2142 isl_pw_multi_aff_free(MMA.second);
2143 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002144 }
Tobias Grosser75805372011-04-29 06:27:02 +00002145}
2146
Johannes Doerfert80ef1102014-11-07 08:31:31 +00002147const ScopArrayInfo *
2148Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *AccessType,
Tobias Grosser92245222015-07-28 14:53:44 +00002149 const SmallVector<const SCEV *, 4> &Sizes,
2150 bool IsPHI) {
2151 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)];
Johannes Doerfert80ef1102014-11-07 08:31:31 +00002152 if (!SAI)
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002153 SAI.reset(new ScopArrayInfo(BasePtr, AccessType, getIslCtx(), Sizes, IsPHI,
2154 this));
Tobias Grosserab671442015-05-23 05:58:27 +00002155 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002156}
2157
Tobias Grosser92245222015-07-28 14:53:44 +00002158const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr, bool IsPHI) {
2159 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, IsPHI)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00002160 assert(SAI && "No ScopArrayInfo available for this base pointer");
2161 return SAI;
2162}
2163
Tobias Grosser74394f02013-01-14 22:40:23 +00002164std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002165std::string Scop::getAssumedContextStr() const {
2166 return stringFromIslObj(AssumedContext);
2167}
Tobias Grosser75805372011-04-29 06:27:02 +00002168
2169std::string Scop::getNameStr() const {
2170 std::string ExitName, EntryName;
2171 raw_string_ostream ExitStr(ExitName);
2172 raw_string_ostream EntryStr(EntryName);
2173
Tobias Grosserf240b482014-01-09 10:42:15 +00002174 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002175 EntryStr.str();
2176
2177 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00002178 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00002179 ExitStr.str();
2180 } else
2181 ExitName = "FunctionExit";
2182
2183 return EntryName + "---" + ExitName;
2184}
2185
Tobias Grosser74394f02013-01-14 22:40:23 +00002186__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00002187__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002188 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00002189}
2190
Tobias Grossere86109f2013-10-29 21:05:49 +00002191__isl_give isl_set *Scop::getAssumedContext() const {
2192 return isl_set_copy(AssumedContext);
2193}
2194
Johannes Doerfert43788c52015-08-20 05:58:56 +00002195__isl_give isl_set *Scop::getRuntimeCheckContext() const {
2196 isl_set *RuntimeCheckContext = getAssumedContext();
2197 return RuntimeCheckContext;
2198}
2199
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002200bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00002201 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002202 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00002203 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
2204 isl_set_free(RuntimeCheckContext);
2205 return IsFeasible;
2206}
2207
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002208void Scop::addAssumption(__isl_take isl_set *Set) {
2209 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00002210 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002211}
2212
Tobias Grosser75805372011-04-29 06:27:02 +00002213void Scop::printContext(raw_ostream &OS) const {
2214 OS << "Context:\n";
2215
2216 if (!Context) {
2217 OS.indent(4) << "n/a\n\n";
2218 return;
2219 }
2220
2221 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00002222
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002223 OS.indent(4) << "Assumed Context:\n";
2224 if (!AssumedContext) {
2225 OS.indent(4) << "n/a\n\n";
2226 return;
2227 }
2228
2229 OS.indent(4) << getAssumedContextStr() << "\n";
2230
Tobias Grosser083d3d32014-06-28 08:59:45 +00002231 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00002232 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00002233 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
2234 }
Tobias Grosser75805372011-04-29 06:27:02 +00002235}
2236
Johannes Doerfertb164c792014-09-18 11:17:17 +00002237void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002238 int noOfGroups = 0;
2239 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002240 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002241 noOfGroups += 1;
2242 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002243 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002244 }
2245
Tobias Grosserbb853c22015-07-25 12:31:03 +00002246 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00002247 if (MinMaxAliasGroups.empty()) {
2248 OS.indent(8) << "n/a\n";
2249 return;
2250 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002251
Tobias Grosserbb853c22015-07-25 12:31:03 +00002252 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002253
2254 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002255 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002256 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002257 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002258 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2259 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002260 }
2261 OS << " ]]\n";
2262 }
2263
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002264 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002265 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00002266 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002267 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00002268 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
2269 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002270 }
2271 OS << " ]]\n";
2272 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002273 }
2274}
2275
Tobias Grosser75805372011-04-29 06:27:02 +00002276void Scop::printStatements(raw_ostream &OS) const {
2277 OS << "Statements {\n";
2278
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002279 for (const ScopStmt &Stmt : *this)
2280 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00002281
2282 OS.indent(4) << "}\n";
2283}
2284
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002285void Scop::printArrayInfo(raw_ostream &OS) const {
2286 OS << "Arrays {\n";
2287
Tobias Grosserab671442015-05-23 05:58:27 +00002288 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002289 Array.second->print(OS);
2290
2291 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00002292
2293 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
2294
2295 for (auto &Array : arrays())
2296 Array.second->print(OS, /* SizeAsPwAff */ true);
2297
2298 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002299}
2300
Tobias Grosser75805372011-04-29 06:27:02 +00002301void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00002302 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
2303 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00002304 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00002305 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00002306 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00002307 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00002308 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00002309 printStatements(OS.indent(4));
2310}
2311
2312void Scop::dump() const { print(dbgs()); }
2313
Tobias Grosser9a38ab82011-11-08 15:41:03 +00002314isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00002315
Johannes Doerfertb409fdc2015-08-28 09:24:35 +00002316__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, isl_set *Domain) {
2317 return Affinator.getPwAff(E, Domain);
Johannes Doerfert574182d2015-08-12 10:19:50 +00002318}
2319
Tobias Grosser808cd692015-07-14 09:33:13 +00002320__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002321 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002322
Tobias Grosser808cd692015-07-14 09:33:13 +00002323 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002324 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00002325
2326 return Domain;
2327}
2328
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002329__isl_give isl_union_map *Scop::getMustWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002330 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002331
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002332 for (ScopStmt &Stmt : *this) {
2333 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002334 if (!MA->isMustWrite())
2335 continue;
2336
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002337 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002338 isl_map *AccessDomain = MA->getAccessRelation();
2339 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2340 Write = isl_union_map_add_map(Write, AccessDomain);
2341 }
2342 }
2343 return isl_union_map_coalesce(Write);
2344}
2345
2346__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002347 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002348
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002349 for (ScopStmt &Stmt : *this) {
2350 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002351 if (!MA->isMayWrite())
2352 continue;
2353
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002354 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00002355 isl_map *AccessDomain = MA->getAccessRelation();
2356 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2357 Write = isl_union_map_add_map(Write, AccessDomain);
2358 }
2359 }
2360 return isl_union_map_coalesce(Write);
2361}
2362
Tobias Grosser37eb4222014-02-20 21:43:54 +00002363__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00002364 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002365
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002366 for (ScopStmt &Stmt : *this) {
2367 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002368 if (!MA->isWrite())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002369 continue;
2370
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002371 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002372 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002373 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2374 Write = isl_union_map_add_map(Write, AccessDomain);
2375 }
2376 }
2377 return isl_union_map_coalesce(Write);
2378}
2379
2380__isl_give isl_union_map *Scop::getReads() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002381 isl_union_map *Read = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002382
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002383 for (ScopStmt &Stmt : *this) {
2384 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00002385 if (!MA->isRead())
Tobias Grosser37eb4222014-02-20 21:43:54 +00002386 continue;
2387
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002388 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00002389 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00002390
2391 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
2392 Read = isl_union_map_add_map(Read, AccessDomain);
2393 }
2394 }
2395 return isl_union_map_coalesce(Read);
2396}
2397
Tobias Grosser808cd692015-07-14 09:33:13 +00002398__isl_give isl_union_map *Scop::getSchedule() const {
2399 auto Tree = getScheduleTree();
2400 auto S = isl_schedule_get_map(Tree);
2401 isl_schedule_free(Tree);
2402 return S;
2403}
Tobias Grosser37eb4222014-02-20 21:43:54 +00002404
Tobias Grosser808cd692015-07-14 09:33:13 +00002405__isl_give isl_schedule *Scop::getScheduleTree() const {
2406 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
2407 getDomains());
2408}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00002409
Tobias Grosser808cd692015-07-14 09:33:13 +00002410void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
2411 auto *S = isl_schedule_from_domain(getDomains());
2412 S = isl_schedule_insert_partial_schedule(
2413 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
2414 isl_schedule_free(Schedule);
2415 Schedule = S;
2416}
2417
2418void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
2419 isl_schedule_free(Schedule);
2420 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00002421}
2422
2423bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
2424 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002425 for (ScopStmt &Stmt : *this) {
2426 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00002427 isl_union_set *NewStmtDomain = isl_union_set_intersect(
2428 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
2429
2430 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
2431 isl_union_set_free(StmtDomain);
2432 isl_union_set_free(NewStmtDomain);
2433 continue;
2434 }
2435
2436 Changed = true;
2437
2438 isl_union_set_free(StmtDomain);
2439 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
2440
2441 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002442 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002443 isl_union_set_free(NewStmtDomain);
2444 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002445 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00002446 }
2447 isl_union_set_free(Domain);
2448 return Changed;
2449}
2450
Tobias Grosser75805372011-04-29 06:27:02 +00002451ScalarEvolution *Scop::getSE() const { return SE; }
2452
2453bool Scop::isTrivialBB(BasicBlock *BB, TempScop &tempScop) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002454 if (tempScop.getAccessFunctions(BB) && !isErrorBlock(*BB))
Tobias Grosser75805372011-04-29 06:27:02 +00002455 return false;
2456
2457 return true;
2458}
2459
Tobias Grosser808cd692015-07-14 09:33:13 +00002460struct MapToDimensionDataTy {
2461 int N;
2462 isl_union_pw_multi_aff *Res;
2463};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002464
Tobias Grosser808cd692015-07-14 09:33:13 +00002465// @brief Create a function that maps the elements of 'Set' to its N-th
2466// dimension.
2467//
2468// The result is added to 'User->Res'.
2469//
2470// @param Set The input set.
2471// @param N The dimension to map to.
2472//
2473// @returns Zero if no error occurred, non-zero otherwise.
2474static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
2475 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
2476 int Dim;
2477 isl_space *Space;
2478 isl_pw_multi_aff *PMA;
2479
2480 Dim = isl_set_dim(Set, isl_dim_set);
2481 Space = isl_set_get_space(Set);
2482 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
2483 Dim - Data->N);
2484 if (Data->N > 1)
2485 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
2486 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
2487
2488 isl_set_free(Set);
2489
2490 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002491}
2492
Tobias Grosser808cd692015-07-14 09:33:13 +00002493// @brief Create a function that maps the elements of Domain to their Nth
2494// dimension.
2495//
2496// @param Domain The set of elements to map.
2497// @param N The dimension to map to.
2498static __isl_give isl_multi_union_pw_aff *
2499mapToDimension(__isl_take isl_union_set *Domain, int N) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002500 if (N <= 0 || isl_union_set_is_empty(Domain)) {
2501 isl_union_set_free(Domain);
2502 return nullptr;
2503 }
2504
Tobias Grosser808cd692015-07-14 09:33:13 +00002505 struct MapToDimensionDataTy Data;
2506 isl_space *Space;
2507
2508 Space = isl_union_set_get_space(Domain);
2509 Data.N = N;
2510 Data.Res = isl_union_pw_multi_aff_empty(Space);
2511 if (isl_union_set_foreach_set(Domain, &mapToDimension_AddSet, &Data) < 0)
2512 Data.Res = isl_union_pw_multi_aff_free(Data.Res);
2513
2514 isl_union_set_free(Domain);
2515 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
2516}
2517
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002518ScopStmt *Scop::addScopStmt(BasicBlock *BB, Region *R, TempScop &tempScop) {
Tobias Grosser808cd692015-07-14 09:33:13 +00002519 ScopStmt *Stmt;
2520 if (BB) {
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002521 Stmts.emplace_back(*this, tempScop, *BB);
Tobias Grosser808cd692015-07-14 09:33:13 +00002522 Stmt = &Stmts.back();
2523 StmtMap[BB] = Stmt;
2524 } else {
2525 assert(R && "Either basic block or a region expected.");
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002526 Stmts.emplace_back(*this, tempScop, *R);
Tobias Grosser808cd692015-07-14 09:33:13 +00002527 Stmt = &Stmts.back();
2528 for (BasicBlock *BB : R->blocks())
2529 StmtMap[BB] = Stmt;
2530 }
2531 return Stmt;
2532}
2533
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002534void Scop::buildSchedule(
2535 Region *R, TempScop &TS, LoopInfo &LI, ScopDetection &SD,
2536 DenseMap<Loop *, std::pair<isl_schedule *, unsigned>> &LoopSchedules) {
Michael Kruse046dde42015-08-10 13:01:57 +00002537
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002538 ReversePostOrderTraversal<Region *> RTraversal(R);
2539 for (auto *RN : RTraversal) {
Michael Kruse046dde42015-08-10 13:01:57 +00002540
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002541 if (RN->isSubRegion()) {
2542 Region *SubRegion = RN->getNodeAs<Region>();
2543 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
2544 buildSchedule(SubRegion, TS, LI, SD, LoopSchedules);
2545 continue;
2546 }
Tobias Grosser75805372011-04-29 06:27:02 +00002547 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002548
2549 Loop *L = getRegionNodeLoop(RN, LI);
2550 int LD = getRelativeLoopDepth(L);
2551 auto &LSchedulePair = LoopSchedules[L];
2552 LSchedulePair.second += getNumBlocksInRegionNode(RN);
2553
2554 BasicBlock *BB = getRegionNodeBasicBlock(RN);
2555 if (RN->isSubRegion() || !isTrivialBB(BB, TS)) {
2556
2557 ScopStmt *Stmt;
2558 if (RN->isSubRegion())
2559 Stmt = addScopStmt(nullptr, RN->getNodeAs<Region>(), TS);
2560 else
2561 Stmt = addScopStmt(BB, nullptr, TS);
2562
2563 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
2564 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
2565 LSchedulePair.first =
2566 combineInSequence(LSchedulePair.first, StmtSchedule);
2567 }
2568
2569 unsigned NumVisited = LSchedulePair.second;
2570 while (L && NumVisited == L->getNumBlocks()) {
2571 auto *LDomain = isl_schedule_get_domain(LSchedulePair.first);
2572 if (auto *MUPA = mapToDimension(LDomain, LD + 1))
2573 LSchedulePair.first =
2574 isl_schedule_insert_partial_schedule(LSchedulePair.first, MUPA);
2575
2576 auto *PL = L->getParentLoop();
2577 assert(LoopSchedules.count(PL));
2578 auto &PSchedulePair = LoopSchedules[PL];
2579 PSchedulePair.first =
2580 combineInSequence(PSchedulePair.first, LSchedulePair.first);
2581 PSchedulePair.second += NumVisited;
2582
2583 L = PL;
2584 NumVisited = PSchedulePair.second;
2585 }
Tobias Grosser808cd692015-07-14 09:33:13 +00002586 }
Tobias Grosser75805372011-04-29 06:27:02 +00002587}
2588
Johannes Doerfert7c494212014-10-31 23:13:39 +00002589ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00002590 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00002591 if (StmtMapIt == StmtMap.end())
2592 return nullptr;
2593 return StmtMapIt->second;
2594}
2595
Michael Kruse7bf39442015-09-10 12:46:52 +00002596//===----------------------------------------------------------------------===//
2597// TempScop implementation
2598TempScop::~TempScop() {}
2599
2600void TempScop::print(raw_ostream &OS, ScalarEvolution *SE, LoopInfo *LI) const {
2601 OS << "Scop: " << R.getNameStr() << "\n";
2602
2603 printDetail(OS, SE, LI, &R, 0);
2604}
2605
2606void TempScop::printDetail(raw_ostream &OS, ScalarEvolution *SE, LoopInfo *LI,
2607 const Region *CurR, unsigned ind) const {
2608 // FIXME: Print other details rather than memory accesses.
2609 for (const auto &CurBlock : CurR->blocks()) {
2610 AccFuncMapType::const_iterator AccSetIt = AccFuncMap.find(CurBlock);
2611
2612 // Ignore trivial blocks that do not contain any memory access.
2613 if (AccSetIt == AccFuncMap.end())
2614 continue;
2615
2616 OS.indent(ind) << "BB: " << CurBlock->getName() << '\n';
2617 typedef AccFuncSetType::const_iterator access_iterator;
2618 const AccFuncSetType &AccFuncs = AccSetIt->second;
2619
2620 for (access_iterator AI = AccFuncs.begin(), AE = AccFuncs.end(); AI != AE;
2621 ++AI)
2622 AI->first.print(OS.indent(ind + 2));
2623 }
2624}
2625
Johannes Doerfert96425c22015-08-30 21:13:53 +00002626int Scop::getRelativeLoopDepth(const Loop *L) const {
2627 Loop *OuterLoop =
2628 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
2629 if (!OuterLoop)
2630 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00002631 return L->getLoopDepth() - OuterLoop->getLoopDepth();
2632}
2633
Michael Krused868b5d2015-09-10 15:25:24 +00002634void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
2635 AccFuncSetType &Functions,
2636 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002637
2638 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
2639 // true, are not modeled as ordinary PHI nodes as they are not part of the
2640 // region. However, we model the operands in the predecessor blocks that are
2641 // part of the region as regular scalar accesses.
2642
2643 // If we can synthesize a PHI we can skip it, however only if it is in
2644 // the region. If it is not it can only be in the exit block of the region.
2645 // In this case we model the operands but not the PHI itself.
2646 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
2647 return;
2648
2649 // PHI nodes are modeled as if they had been demoted prior to the SCoP
2650 // detection. Hence, the PHI is a load of a new memory location in which the
2651 // incoming value was written at the end of the incoming basic block.
2652 bool OnlyNonAffineSubRegionOperands = true;
2653 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
2654 Value *Op = PHI->getIncomingValue(u);
2655 BasicBlock *OpBB = PHI->getIncomingBlock(u);
2656
2657 // Do not build scalar dependences inside a non-affine subregion.
2658 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
2659 continue;
2660
2661 OnlyNonAffineSubRegionOperands = false;
2662
2663 if (!R.contains(OpBB))
2664 continue;
2665
2666 Instruction *OpI = dyn_cast<Instruction>(Op);
2667 if (OpI) {
2668 BasicBlock *OpIBB = OpI->getParent();
2669 // As we pretend there is a use (or more precise a write) of OpI in OpBB
2670 // we have to insert a scalar dependence from the definition of OpI to
2671 // OpBB if the definition is not in OpBB.
2672 if (OpIBB != OpBB) {
2673 IRAccess ScalarRead(IRAccess::READ, OpI, ZeroOffset, 1, true, OpI);
2674 AccFuncMap[OpBB].push_back(std::make_pair(ScalarRead, PHI));
2675 IRAccess ScalarWrite(IRAccess::MUST_WRITE, OpI, ZeroOffset, 1, true,
2676 OpI);
2677 AccFuncMap[OpIBB].push_back(std::make_pair(ScalarWrite, OpI));
2678 }
2679 }
2680
2681 // Always use the terminator of the incoming basic block as the access
2682 // instruction.
2683 OpI = OpBB->getTerminator();
2684
2685 IRAccess ScalarAccess(IRAccess::MUST_WRITE, PHI, ZeroOffset, 1, true, Op,
2686 /* IsPHI */ !IsExitBlock);
2687 AccFuncMap[OpBB].push_back(std::make_pair(ScalarAccess, OpI));
2688 }
2689
2690 if (!OnlyNonAffineSubRegionOperands) {
2691 IRAccess ScalarAccess(IRAccess::READ, PHI, ZeroOffset, 1, true, PHI,
2692 /* IsPHI */ !IsExitBlock);
2693 Functions.push_back(std::make_pair(ScalarAccess, PHI));
2694 }
2695}
2696
Michael Krused868b5d2015-09-10 15:25:24 +00002697bool ScopInfo::buildScalarDependences(Instruction *Inst, Region *R,
2698 Region *NonAffineSubRegion) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002699 bool canSynthesizeInst = canSynthesize(Inst, LI, SE, R);
2700 if (isIgnoredIntrinsic(Inst))
2701 return false;
2702
2703 bool AnyCrossStmtUse = false;
2704 BasicBlock *ParentBB = Inst->getParent();
2705
2706 for (User *U : Inst->users()) {
2707 Instruction *UI = dyn_cast<Instruction>(U);
2708
2709 // Ignore the strange user
2710 if (UI == 0)
2711 continue;
2712
2713 BasicBlock *UseParent = UI->getParent();
2714
2715 // Ignore the users in the same BB (statement)
2716 if (UseParent == ParentBB)
2717 continue;
2718
2719 // Do not build scalar dependences inside a non-affine subregion.
2720 if (NonAffineSubRegion && NonAffineSubRegion->contains(UseParent))
2721 continue;
2722
2723 // Check whether or not the use is in the SCoP.
2724 if (!R->contains(UseParent)) {
2725 AnyCrossStmtUse = true;
2726 continue;
2727 }
2728
2729 // If the instruction can be synthesized and the user is in the region
2730 // we do not need to add scalar dependences.
2731 if (canSynthesizeInst)
2732 continue;
2733
2734 // No need to translate these scalar dependences into polyhedral form,
2735 // because synthesizable scalars can be generated by the code generator.
2736 if (canSynthesize(UI, LI, SE, R))
2737 continue;
2738
2739 // Skip PHI nodes in the region as they handle their operands on their own.
2740 if (isa<PHINode>(UI))
2741 continue;
2742
2743 // Now U is used in another statement.
2744 AnyCrossStmtUse = true;
2745
2746 // Do not build a read access that is not in the current SCoP
2747 // Use the def instruction as base address of the IRAccess, so that it will
2748 // become the name of the scalar access in the polyhedral form.
2749 IRAccess ScalarAccess(IRAccess::READ, Inst, ZeroOffset, 1, true, Inst);
2750 AccFuncMap[UseParent].push_back(std::make_pair(ScalarAccess, UI));
2751 }
2752
2753 if (ModelReadOnlyScalars) {
2754 for (Value *Op : Inst->operands()) {
2755 if (canSynthesize(Op, LI, SE, R))
2756 continue;
2757
2758 if (Instruction *OpInst = dyn_cast<Instruction>(Op))
2759 if (R->contains(OpInst))
2760 continue;
2761
2762 if (isa<Constant>(Op))
2763 continue;
2764
2765 IRAccess ScalarAccess(IRAccess::READ, Op, ZeroOffset, 1, true, Op);
2766 AccFuncMap[Inst->getParent()].push_back(
2767 std::make_pair(ScalarAccess, Inst));
2768 }
2769 }
2770
2771 return AnyCrossStmtUse;
2772}
2773
2774extern MapInsnToMemAcc InsnToMemAcc;
2775
2776IRAccess
Michael Krused868b5d2015-09-10 15:25:24 +00002777ScopInfo::buildIRAccess(Instruction *Inst, Loop *L, Region *R,
2778 const ScopDetection::BoxedLoopsSetTy *BoxedLoops) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002779 unsigned Size;
2780 Type *SizeType;
2781 Value *Val;
2782 enum IRAccess::TypeKind Type;
2783
2784 if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
2785 SizeType = Load->getType();
2786 Size = TD->getTypeStoreSize(SizeType);
2787 Type = IRAccess::READ;
2788 Val = Load;
2789 } else {
2790 StoreInst *Store = cast<StoreInst>(Inst);
2791 SizeType = Store->getValueOperand()->getType();
2792 Size = TD->getTypeStoreSize(SizeType);
2793 Type = IRAccess::MUST_WRITE;
2794 Val = Store->getValueOperand();
2795 }
2796
2797 const SCEV *AccessFunction = SE->getSCEVAtScope(getPointerOperand(*Inst), L);
2798 const SCEVUnknown *BasePointer =
2799 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
2800
2801 assert(BasePointer && "Could not find base pointer");
2802 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
2803
2804 auto AccItr = InsnToMemAcc.find(Inst);
2805 if (PollyDelinearize && AccItr != InsnToMemAcc.end())
2806 return IRAccess(Type, BasePointer->getValue(), AccessFunction, Size, true,
2807 AccItr->second.DelinearizedSubscripts,
2808 AccItr->second.Shape->DelinearizedSizes, Val);
2809
2810 // Check if the access depends on a loop contained in a non-affine subregion.
2811 bool isVariantInNonAffineLoop = false;
2812 if (BoxedLoops) {
2813 SetVector<const Loop *> Loops;
2814 findLoops(AccessFunction, Loops);
2815 for (const Loop *L : Loops)
2816 if (BoxedLoops->count(L))
2817 isVariantInNonAffineLoop = true;
2818 }
2819
2820 bool IsAffine = !isVariantInNonAffineLoop &&
2821 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue());
2822
2823 SmallVector<const SCEV *, 4> Subscripts, Sizes;
2824 Subscripts.push_back(AccessFunction);
2825 Sizes.push_back(SE->getConstant(ZeroOffset->getType(), Size));
2826
2827 if (!IsAffine && Type == IRAccess::MUST_WRITE)
2828 Type = IRAccess::MAY_WRITE;
2829
2830 return IRAccess(Type, BasePointer->getValue(), AccessFunction, Size, IsAffine,
2831 Subscripts, Sizes, Val);
2832}
2833
Michael Krused868b5d2015-09-10 15:25:24 +00002834void ScopInfo::buildAccessFunctions(Region &R, Region &SR) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002835
2836 if (SD->isNonAffineSubRegion(&SR, &R)) {
2837 for (BasicBlock *BB : SR.blocks())
2838 buildAccessFunctions(R, *BB, &SR);
2839 return;
2840 }
2841
2842 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
2843 if (I->isSubRegion())
2844 buildAccessFunctions(R, *I->getNodeAs<Region>());
2845 else
2846 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>());
2847}
2848
Michael Krused868b5d2015-09-10 15:25:24 +00002849void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
2850 Region *NonAffineSubRegion,
2851 bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002852 AccFuncSetType Functions;
2853 Loop *L = LI->getLoopFor(&BB);
2854
2855 // The set of loops contained in non-affine subregions that are part of R.
2856 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
2857
2858 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I) {
2859 Instruction *Inst = I;
2860
2861 PHINode *PHI = dyn_cast<PHINode>(Inst);
2862 if (PHI)
2863 buildPHIAccesses(PHI, R, Functions, NonAffineSubRegion, IsExitBlock);
2864
2865 // For the exit block we stop modeling after the last PHI node.
2866 if (!PHI && IsExitBlock)
2867 break;
2868
2869 if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
2870 Functions.push_back(
2871 std::make_pair(buildIRAccess(Inst, L, &R, BoxedLoops), Inst));
2872
2873 if (isIgnoredIntrinsic(Inst))
2874 continue;
2875
2876 if (buildScalarDependences(Inst, &R, NonAffineSubRegion)) {
2877 // If the Instruction is used outside the statement, we need to build the
2878 // write access.
2879 if (!isa<StoreInst>(Inst)) {
2880 IRAccess ScalarAccess(IRAccess::MUST_WRITE, Inst, ZeroOffset, 1, true,
2881 Inst);
2882 Functions.push_back(std::make_pair(ScalarAccess, Inst));
2883 }
2884 }
2885 }
2886
2887 if (Functions.empty())
2888 return;
2889
2890 AccFuncSetType &Accs = AccFuncMap[&BB];
2891 Accs.insert(Accs.end(), Functions.begin(), Functions.end());
2892}
2893
Michael Krused868b5d2015-09-10 15:25:24 +00002894TempScop *ScopInfo::buildTempScop(Region &R) {
Michael Kruse7bf39442015-09-10 12:46:52 +00002895 TempScop *TScop = new TempScop(R, AccFuncMap);
2896
2897 buildAccessFunctions(R, R);
2898
2899 // In case the region does not have an exiting block we will later (during
2900 // code generation) split the exit block. This will move potential PHI nodes
2901 // from the current exit block into the new region exiting block. Hence, PHI
2902 // nodes that are at this point not part of the region will be.
2903 // To handle these PHI nodes later we will now model their operands as scalar
2904 // accesses. Note that we do not model anything in the exit block if we have
2905 // an exiting block in the region, as there will not be any splitting later.
2906 if (!R.getExitingBlock())
2907 buildAccessFunctions(R, *R.getExit(), nullptr, /* IsExitBlock */ true);
2908
2909 return TScop;
2910}
2911
Michael Krused868b5d2015-09-10 15:25:24 +00002912TempScop *ScopInfo::getTempScop() const { return TempScopOfRegion; }
Michael Kruse7bf39442015-09-10 12:46:52 +00002913
Michael Krused868b5d2015-09-10 15:25:24 +00002914void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse7bf39442015-09-10 12:46:52 +00002915 if (TempScopOfRegion)
2916 TempScopOfRegion->print(OS, SE, LI);
Michael Krused868b5d2015-09-10 15:25:24 +00002917
2918 if (scop)
2919 scop->print(OS);
2920 else
2921 OS << "Invalid Scop!\n";
Michael Kruse7bf39442015-09-10 12:46:52 +00002922}
2923
Michael Krused868b5d2015-09-10 15:25:24 +00002924void ScopInfo::clear() {
Michael Kruse7bf39442015-09-10 12:46:52 +00002925 AccFuncMap.clear();
2926 if (TempScopOfRegion)
2927 delete TempScopOfRegion;
2928 TempScopOfRegion = nullptr;
Michael Krused868b5d2015-09-10 15:25:24 +00002929
2930 if (scop) {
2931 delete scop;
2932 scop = 0;
2933 }
Michael Kruse7bf39442015-09-10 12:46:52 +00002934}
2935
2936//===----------------------------------------------------------------------===//
Michael Krused868b5d2015-09-10 15:25:24 +00002937ScopInfo::ScopInfo() : RegionPass(ID), TempScopOfRegion(nullptr), scop(0) {
Tobias Grosserb76f38532011-08-20 11:11:25 +00002938 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00002939 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00002940}
2941
2942ScopInfo::~ScopInfo() {
2943 clear();
2944 isl_ctx_free(ctx);
2945}
2946
Tobias Grosser75805372011-04-29 06:27:02 +00002947void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Michael Krused868b5d2015-09-10 15:25:24 +00002948 AU.addRequiredID(IndependentBlocksID);
Chandler Carruthf5579872015-01-17 14:16:56 +00002949 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00002950 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00002951 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00002952 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
2953 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00002954 AU.addRequired<AAResultsWrapperPass>();
Tobias Grosser75805372011-04-29 06:27:02 +00002955 AU.setPreservesAll();
2956}
2957
2958bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00002959 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00002960
Michael Krused868b5d2015-09-10 15:25:24 +00002961 if (!SD->isMaxRegionInScop(*R))
2962 return false;
2963
2964 Function *F = R->getEntry()->getParent();
2965 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
2966 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
2967 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
2968 TD = &F->getParent()->getDataLayout();
2969 DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
2970 ZeroOffset = SE->getConstant(TD->getIntPtrType(F->getContext()), 0);
2971
2972 assert(!TempScopOfRegion && "Build the TempScop only once");
2973 TempScopOfRegion = buildTempScop(*R);
Tobias Grosser75805372011-04-29 06:27:02 +00002974
2975 // This region is no Scop.
Michael Krused868b5d2015-09-10 15:25:24 +00002976 if (!TempScopOfRegion) {
Tobias Grosserc98a8fc2014-11-14 11:12:31 +00002977 scop = nullptr;
Tobias Grosser75805372011-04-29 06:27:02 +00002978 return false;
2979 }
2980
Michael Krused868b5d2015-09-10 15:25:24 +00002981 scop =
2982 Scop::createFromTempScop(*TempScopOfRegion, *LI, *SE, *SD, *AA, DT, ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00002983
Tobias Grosserd6a50b32015-05-30 06:26:21 +00002984 DEBUG(scop->print(dbgs()));
2985
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00002986 if (!scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert43788c52015-08-20 05:58:56 +00002987 delete scop;
2988 scop = nullptr;
2989 return false;
2990 }
2991
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002992 // Statistics.
2993 ++ScopFound;
2994 if (scop->getMaxLoopDepth() > 0)
2995 ++RichScopFound;
Tobias Grosser75805372011-04-29 06:27:02 +00002996 return false;
2997}
2998
2999char ScopInfo::ID = 0;
3000
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003001Pass *polly::createScopInfoPass() { return new ScopInfo(); }
3002
Tobias Grosser73600b82011-10-08 00:30:40 +00003003INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
3004 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00003005 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00003006INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Chandler Carruthf5579872015-01-17 14:16:56 +00003007INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00003008INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00003009INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003010INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00003011INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00003012INITIALIZE_PASS_END(ScopInfo, "polly-scops",
3013 "Polly - Create polyhedral description of Scops", false,
3014 false)