blob: 3b8770afa9a788a89027d957dfc139585d29c34d [file] [log] [blame]
Johannes Doerfert58a7c752015-09-28 09:48:53 +00001//===--------- ScopInfo.cpp - Create Scops from LLVM IR ------------------===//
Tobias Grosser75805372011-04-29 06:27:02 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Create a polyhedral description for a static control flow region.
11//
12// The pass creates a polyhedral description of the Scops detected by the Scop
13// detection derived from their LLVM-IR code.
14//
Tobias Grossera5605d32014-10-29 19:58:28 +000015// This representation is shared among several tools in the polyhedral
Tobias Grosser75805372011-04-29 06:27:02 +000016// community, which are e.g. Cloog, Pluto, Loopo, Graphite.
17//
18//===----------------------------------------------------------------------===//
19
Tobias Grosser5624d3c2015-12-21 12:38:56 +000020#include "polly/ScopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000021#include "polly/LinkAllPasses.h"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000022#include "polly/Options.h"
Tobias Grosser75805372011-04-29 06:27:02 +000023#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000024#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000025#include "polly/Support/ScopHelper.h"
Tobias Grosser9737c7b2015-11-22 11:06:51 +000026#include "llvm/ADT/DepthFirstIterator.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000027#include "llvm/ADT/MapVector.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000028#include "llvm/ADT/PostOrderIterator.h"
29#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000030#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000031#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000032#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000033#include "llvm/Analysis/AliasAnalysis.h"
Johannes Doerfert2af10e22015-11-12 03:25:01 +000034#include "llvm/Analysis/AssumptionCache.h"
Johannes Doerfert1dc12af2016-04-23 12:59:18 +000035#include "llvm/Analysis/Loads.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000036#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000037#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000038#include "llvm/Analysis/RegionIterator.h"
39#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000040#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000041#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000042#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000043#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000044#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000045#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000046#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000047#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000048#include "isl/schedule.h"
49#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000050#include "isl/set.h"
51#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000052#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000053#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000054#include <sstream>
55#include <string>
56#include <vector>
57
58using namespace llvm;
59using namespace polly;
60
Chandler Carruth95fef942014-04-22 03:30:19 +000061#define DEBUG_TYPE "polly-scops"
62
Tobias Grosser74394f02013-01-14 22:40:23 +000063STATISTIC(ScopFound, "Number of valid Scops");
64STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000065
Tobias Grosser75dc40c2015-12-20 13:31:48 +000066// The maximal number of basic sets we allow during domain construction to
67// be created. More complex scops will result in very high compile time and
68// are also unlikely to result in good code
69static int const MaxConjunctsInDomain = 20;
70
Johannes Doerfert2f705842016-04-12 16:09:44 +000071static cl::opt<bool> PollyRemarksMinimal(
72 "polly-remarks-minimal",
73 cl::desc("Do not emit remarks about assumptions that are known"),
74 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
75
Michael Kruse7bf39442015-09-10 12:46:52 +000076static cl::opt<bool> ModelReadOnlyScalars(
77 "polly-analyze-read-only-scalars",
78 cl::desc("Model read-only scalar values in the scop description"),
79 cl::Hidden, cl::ZeroOrMore, cl::init(true), cl::cat(PollyCategory));
80
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000081// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000082// operations can overflow easily. Additive reductions and bit operations
83// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000084static cl::opt<bool> DisableMultiplicativeReductions(
85 "polly-disable-multiplicative-reductions",
86 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
87 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000088
Johannes Doerfert9143d672014-09-27 11:02:39 +000089static cl::opt<unsigned> RunTimeChecksMaxParameters(
90 "polly-rtc-max-parameters",
91 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
92 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
93
Tobias Grosser71500722015-03-28 15:11:14 +000094static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
95 "polly-rtc-max-arrays-per-group",
96 cl::desc("The maximal number of arrays to compare in each alias group."),
97 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Tobias Grosser8a9c2352015-08-16 10:19:29 +000098static cl::opt<std::string> UserContextStr(
99 "polly-context", cl::value_desc("isl parameter set"),
100 cl::desc("Provide additional constraints on the context parameters"),
101 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +0000102
Tobias Grosserd83b8a82015-08-20 19:08:11 +0000103static cl::opt<bool> DetectReductions("polly-detect-reductions",
104 cl::desc("Detect and exploit reductions"),
105 cl::Hidden, cl::ZeroOrMore,
106 cl::init(true), cl::cat(PollyCategory));
107
Michael Kruse7bf39442015-09-10 12:46:52 +0000108//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000109
Michael Kruse046dde42015-08-10 13:01:57 +0000110// Create a sequence of two schedules. Either argument may be null and is
111// interpreted as the empty schedule. Can also return null if both schedules are
112// empty.
113static __isl_give isl_schedule *
114combineInSequence(__isl_take isl_schedule *Prev,
115 __isl_take isl_schedule *Succ) {
116 if (!Prev)
117 return Succ;
118 if (!Succ)
119 return Prev;
120
121 return isl_schedule_sequence(Prev, Succ);
122}
123
Johannes Doerferte7044942015-02-24 11:58:30 +0000124static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
125 const ConstantRange &Range,
126 int dim,
127 enum isl_dim_type type) {
128 isl_val *V;
129 isl_ctx *ctx = isl_set_get_ctx(S);
130
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000131 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
132 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000133 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000134 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
135
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000136 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000137 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000138 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000139 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000140 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
141
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000142 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000143 return isl_set_union(SLB, SUB);
144 else
145 return isl_set_intersect(SLB, SUB);
146}
147
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000148static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
149 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
150 if (!BasePtrLI)
151 return nullptr;
152
153 if (!S->getRegion().contains(BasePtrLI))
154 return nullptr;
155
156 ScalarEvolution &SE = *S->getSE();
157
158 auto *OriginBaseSCEV =
159 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
160 if (!OriginBaseSCEV)
161 return nullptr;
162
163 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
164 if (!OriginBaseSCEVUnknown)
165 return nullptr;
166
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000167 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grossera535dff2015-12-13 19:59:01 +0000168 ScopArrayInfo::MK_Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000169}
170
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000171ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grossera535dff2015-12-13 19:59:01 +0000172 ArrayRef<const SCEV *> Sizes, enum MemoryKind Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000173 const DataLayout &DL, Scop *S)
174 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000175 std::string BasePtrName =
Tobias Grossera535dff2015-12-13 19:59:01 +0000176 getIslCompatibleName("MemRef_", BasePtr, Kind == MK_PHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000177 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000178
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000179 updateSizes(Sizes);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000180 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
181 if (BasePtrOriginSAI)
182 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000183}
184
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000185__isl_give isl_space *ScopArrayInfo::getSpace() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000186 auto *Space =
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000187 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
188 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
189 return Space;
190}
191
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000192void ScopArrayInfo::updateElementType(Type *NewElementType) {
193 if (NewElementType == ElementType)
194 return;
195
Tobias Grosserd840fc72016-02-04 13:18:42 +0000196 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
197 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
198
Johannes Doerferta7920982016-02-25 14:08:48 +0000199 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000200 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000201
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000202 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
203 ElementType = NewElementType;
204 } else {
205 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
206 ElementType = IntegerType::get(ElementType->getContext(), GCD);
207 }
208}
209
210bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000211 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
212 int ExtraDimsNew = NewSizes.size() - SharedDims;
213 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Tobias Grosser8286b832015-11-02 11:29:32 +0000214 for (int i = 0; i < SharedDims; i++)
215 if (NewSizes[i + ExtraDimsNew] != DimensionSizes[i + ExtraDimsOld])
216 return false;
217
218 if (DimensionSizes.size() >= NewSizes.size())
219 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000220
221 DimensionSizes.clear();
222 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
223 NewSizes.end());
224 for (isl_pw_aff *Size : DimensionSizesPw)
225 isl_pw_aff_free(Size);
226 DimensionSizesPw.clear();
227 for (const SCEV *Expr : DimensionSizes) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +0000228 isl_pw_aff *Size = S.getPwAffOnly(Expr);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000229 DimensionSizesPw.push_back(Size);
230 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000231 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000232}
233
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000234ScopArrayInfo::~ScopArrayInfo() {
235 isl_id_free(Id);
236 for (isl_pw_aff *Size : DimensionSizesPw)
237 isl_pw_aff_free(Size);
238}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000239
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000240std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
241
242int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000243 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000244}
245
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +0000246__isl_give isl_id *ScopArrayInfo::getBasePtrId() const {
247 return isl_id_copy(Id);
248}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000249
250void ScopArrayInfo::dump() const { print(errs()); }
251
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000252void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000253 OS.indent(8) << *getElementType() << " " << getName();
254 if (getNumberOfDimensions() > 0)
255 OS << "[*]";
Tobias Grosser26253842015-11-10 14:24:21 +0000256 for (unsigned u = 1; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000257 OS << "[";
258
Tobias Grosser26253842015-11-10 14:24:21 +0000259 if (SizeAsPwAff) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000260 auto *Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000261 OS << " " << Size << " ";
262 isl_pw_aff_free(Size);
263 } else {
264 OS << *getDimensionSize(u);
265 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000266
267 OS << "]";
268 }
269
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000270 OS << ";";
271
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000272 if (BasePtrOriginSAI)
273 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
274
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000275 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000276}
277
278const ScopArrayInfo *
279ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
280 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
281 assert(Id && "Output dimension didn't have an ID");
282 return getFromId(Id);
283}
284
285const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
286 void *User = isl_id_get_user(Id);
287 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
288 isl_id_free(Id);
289 return SAI;
290}
291
Michael Kruse3b425ff2016-04-11 14:34:08 +0000292void MemoryAccess::wrapConstantDimensions() {
293 auto *SAI = getScopArrayInfo();
294 auto *ArraySpace = SAI->getSpace();
295 auto *Ctx = isl_space_get_ctx(ArraySpace);
296 unsigned DimsArray = SAI->getNumberOfDimensions();
297
298 auto *DivModAff = isl_multi_aff_identity(isl_space_map_from_domain_and_range(
299 isl_space_copy(ArraySpace), isl_space_copy(ArraySpace)));
300 auto *LArraySpace = isl_local_space_from_space(ArraySpace);
301
302 // Begin with last dimension, to iteratively carry into higher dimensions.
303 for (int i = DimsArray - 1; i > 0; i--) {
304 auto *DimSize = SAI->getDimensionSize(i);
305 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
306
307 // This transformation is not applicable to dimensions with dynamic size.
308 if (!DimSizeCst)
309 continue;
310
311 auto *DimSizeVal = isl_valFromAPInt(Ctx, DimSizeCst->getAPInt(), false);
312 auto *Var = isl_aff_var_on_domain(isl_local_space_copy(LArraySpace),
313 isl_dim_set, i);
314 auto *PrevVar = isl_aff_var_on_domain(isl_local_space_copy(LArraySpace),
315 isl_dim_set, i - 1);
316
317 // Compute: index % size
318 // Modulo must apply in the divide of the previous iteration, if any.
319 auto *Modulo = isl_aff_copy(Var);
320 Modulo = isl_aff_mod_val(Modulo, isl_val_copy(DimSizeVal));
321 Modulo = isl_aff_pullback_multi_aff(Modulo, isl_multi_aff_copy(DivModAff));
322
323 // Compute: floor(index / size)
324 auto *Divide = Var;
325 Divide = isl_aff_div(
326 Divide,
327 isl_aff_val_on_domain(isl_local_space_copy(LArraySpace), DimSizeVal));
328 Divide = isl_aff_floor(Divide);
329 Divide = isl_aff_add(Divide, PrevVar);
330 Divide = isl_aff_pullback_multi_aff(Divide, isl_multi_aff_copy(DivModAff));
331
332 // Apply Modulo and Divide.
333 DivModAff = isl_multi_aff_set_aff(DivModAff, i, Modulo);
334 DivModAff = isl_multi_aff_set_aff(DivModAff, i - 1, Divide);
335 }
336
337 // Apply all modulo/divides on the accesses.
338 AccessRelation =
339 isl_map_apply_range(AccessRelation, isl_map_from_multi_aff(DivModAff));
340 AccessRelation = isl_map_detect_equalities(AccessRelation);
341 isl_local_space_free(LArraySpace);
342}
343
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000344void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000345 auto *SAI = getScopArrayInfo();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000346 auto *ArraySpace = SAI->getSpace();
347 auto *AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000348 auto *Ctx = isl_space_get_ctx(AccessSpace);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000349
350 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
351 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
352 auto DimsMissing = DimsArray - DimsAccess;
353
Michael Kruse375cb5f2016-02-24 22:08:24 +0000354 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000355 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000356 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000357 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000358
Johannes Doerferta90943d2016-02-21 16:37:25 +0000359 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000360 isl_set_universe(AccessSpace),
361 isl_set_universe(isl_space_copy(ArraySpace)));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000362
363 for (unsigned i = 0; i < DimsMissing; i++)
364 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
365
366 for (unsigned i = DimsMissing; i < DimsArray; i++)
367 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
368
369 AccessRelation = isl_map_apply_range(AccessRelation, Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000370
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000371 // For the non delinearized arrays, divide the access function of the last
372 // subscript by the size of the elements in the array.
373 //
374 // A stride one array access in C expressed as A[i] is expressed in
375 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
376 // two subsequent values of 'i' index two values that are stored next to
377 // each other in memory. By this division we make this characteristic
378 // obvious again. If the base pointer was accessed with offsets not divisible
379 // by the accesses element size, we will have choosen a smaller ArrayElemSize
380 // that divides the offsets of all accesses to this base pointer.
381 if (DimsAccess == 1) {
382 isl_val *V = isl_val_int_from_si(Ctx, ArrayElemSize);
383 AccessRelation = isl_map_floordiv_val(AccessRelation, V);
384 }
385
Michael Kruse3b425ff2016-04-11 14:34:08 +0000386 // We currently do this only if we added at least one dimension, which means
387 // some dimension's indices have not been specified, an indicator that some
388 // index values have been added together.
389 // TODO: Investigate general usefulness; Effect on unit tests is to make index
390 // expressions more complicated.
391 if (DimsMissing)
392 wrapConstantDimensions();
393
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000394 if (!isAffine())
395 computeBoundsOnAccessRelation(ArrayElemSize);
396
Tobias Grosserd840fc72016-02-04 13:18:42 +0000397 // Introduce multi-element accesses in case the type loaded by this memory
398 // access is larger than the canonical element type of the array.
399 //
400 // An access ((float *)A)[i] to an array char *A is modeled as
401 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000402 if (ElemBytes > ArrayElemSize) {
403 assert(ElemBytes % ArrayElemSize == 0 &&
404 "Loaded element size should be multiple of canonical element size");
Johannes Doerferta90943d2016-02-21 16:37:25 +0000405 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000406 isl_set_universe(isl_space_copy(ArraySpace)),
407 isl_set_universe(isl_space_copy(ArraySpace)));
408 for (unsigned i = 0; i < DimsArray - 1; i++)
409 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
410
Tobias Grosserd840fc72016-02-04 13:18:42 +0000411 isl_constraint *C;
412 isl_local_space *LS;
413
414 LS = isl_local_space_from_space(isl_map_get_space(Map));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000415 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
416
417 C = isl_constraint_alloc_inequality(isl_local_space_copy(LS));
418 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, Num - 1));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000419 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, 1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000420 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, -1);
421 Map = isl_map_add_constraint(Map, C);
422
423 C = isl_constraint_alloc_inequality(LS);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000424 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, -1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000425 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, 1);
426 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, 0));
427 Map = isl_map_add_constraint(Map, C);
428 AccessRelation = isl_map_apply_range(AccessRelation, Map);
429 }
430
431 isl_space_free(ArraySpace);
432
Roman Gareev10595a12016-01-08 14:01:59 +0000433 assumeNoOutOfBound();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000434}
435
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000436const std::string
437MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
438 switch (RT) {
439 case MemoryAccess::RT_NONE:
440 llvm_unreachable("Requested a reduction operator string for a memory "
441 "access which isn't a reduction");
442 case MemoryAccess::RT_ADD:
443 return "+";
444 case MemoryAccess::RT_MUL:
445 return "*";
446 case MemoryAccess::RT_BOR:
447 return "|";
448 case MemoryAccess::RT_BXOR:
449 return "^";
450 case MemoryAccess::RT_BAND:
451 return "&";
452 }
453 llvm_unreachable("Unknown reduction type");
454 return "";
455}
456
Johannes Doerfertf6183392014-07-01 20:52:51 +0000457/// @brief Return the reduction type for a given binary operator
458static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
459 const Instruction *Load) {
460 if (!BinOp)
461 return MemoryAccess::RT_NONE;
462 switch (BinOp->getOpcode()) {
463 case Instruction::FAdd:
464 if (!BinOp->hasUnsafeAlgebra())
465 return MemoryAccess::RT_NONE;
466 // Fall through
467 case Instruction::Add:
468 return MemoryAccess::RT_ADD;
469 case Instruction::Or:
470 return MemoryAccess::RT_BOR;
471 case Instruction::Xor:
472 return MemoryAccess::RT_BXOR;
473 case Instruction::And:
474 return MemoryAccess::RT_BAND;
475 case Instruction::FMul:
476 if (!BinOp->hasUnsafeAlgebra())
477 return MemoryAccess::RT_NONE;
478 // Fall through
479 case Instruction::Mul:
480 if (DisableMultiplicativeReductions)
481 return MemoryAccess::RT_NONE;
482 return MemoryAccess::RT_MUL;
483 default:
484 return MemoryAccess::RT_NONE;
485 }
486}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000487
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000488/// @brief Derive the individual index expressions from a GEP instruction
489///
490/// This function optimistically assumes the GEP references into a fixed size
491/// array. If this is actually true, this function returns a list of array
492/// subscript expressions as SCEV as well as a list of integers describing
493/// the size of the individual array dimensions. Both lists have either equal
494/// length of the size list is one element shorter in case there is no known
495/// size available for the outermost array dimension.
496///
497/// @param GEP The GetElementPtr instruction to analyze.
498///
499/// @return A tuple with the subscript expressions and the dimension sizes.
500static std::tuple<std::vector<const SCEV *>, std::vector<int>>
501getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
502 std::vector<const SCEV *> Subscripts;
503 std::vector<int> Sizes;
504
505 Type *Ty = GEP->getPointerOperandType();
506
507 bool DroppedFirstDim = false;
508
Michael Kruse26ed65e2015-09-24 17:32:49 +0000509 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000510
511 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
512
513 if (i == 1) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000514 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000515 Ty = PtrTy->getElementType();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000516 } else if (auto *ArrayTy = dyn_cast<ArrayType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000517 Ty = ArrayTy->getElementType();
518 } else {
519 Subscripts.clear();
520 Sizes.clear();
521 break;
522 }
Johannes Doerferta90943d2016-02-21 16:37:25 +0000523 if (auto *Const = dyn_cast<SCEVConstant>(Expr))
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000524 if (Const->getValue()->isZero()) {
525 DroppedFirstDim = true;
526 continue;
527 }
528 Subscripts.push_back(Expr);
529 continue;
530 }
531
Johannes Doerferta90943d2016-02-21 16:37:25 +0000532 auto *ArrayTy = dyn_cast<ArrayType>(Ty);
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000533 if (!ArrayTy) {
534 Subscripts.clear();
535 Sizes.clear();
536 break;
537 }
538
539 Subscripts.push_back(Expr);
540 if (!(DroppedFirstDim && i == 2))
541 Sizes.push_back(ArrayTy->getNumElements());
542
543 Ty = ArrayTy->getElementType();
544 }
545
546 return std::make_tuple(Subscripts, Sizes);
547}
548
Tobias Grosser75805372011-04-29 06:27:02 +0000549MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000550 isl_id_free(Id);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000551 isl_set_free(InvalidDomain);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000552 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000553 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000554}
555
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000556const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
557 isl_id *ArrayId = getArrayId();
558 void *User = isl_id_get_user(ArrayId);
559 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
560 isl_id_free(ArrayId);
561 return SAI;
562}
563
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000564__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000565 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
566}
567
Tobias Grosserd840fc72016-02-04 13:18:42 +0000568__isl_give isl_map *MemoryAccess::getAddressFunction() const {
569 return isl_map_lexmin(getAccessRelation());
570}
571
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000572__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
573 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000574 isl_map *Schedule, *ScheduledAccRel;
575 isl_union_set *UDomain;
576
577 UDomain = isl_union_set_from_set(getStatement()->getDomain());
578 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
579 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000580 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000581 return isl_pw_multi_aff_from_map(ScheduledAccRel);
582}
583
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000584__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000585 return isl_map_copy(AccessRelation);
586}
587
Johannes Doerferta99130f2014-10-13 12:58:03 +0000588std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000589 return stringFromIslObj(AccessRelation);
590}
591
Johannes Doerferta99130f2014-10-13 12:58:03 +0000592__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000593 return isl_map_get_space(AccessRelation);
594}
595
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000596__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000597 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000598}
599
Tobias Grosser6f730082015-09-05 07:46:47 +0000600std::string MemoryAccess::getNewAccessRelationStr() const {
601 return stringFromIslObj(NewAccessRelation);
602}
603
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000604__isl_give isl_basic_map *
605MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000606 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000607 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000608
Tobias Grosser084d8f72012-05-29 09:29:44 +0000609 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000610 isl_basic_set_universe(Statement->getDomainSpace()),
611 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000612}
613
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000614// Formalize no out-of-bound access assumption
615//
616// When delinearizing array accesses we optimistically assume that the
617// delinearized accesses do not access out of bound locations (the subscript
618// expression of each array evaluates for each statement instance that is
619// executed to a value that is larger than zero and strictly smaller than the
620// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000621// dimension for which we do not need to assume any upper bound. At this point
622// we formalize this assumption to ensure that at code generation time the
623// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000624//
625// To find the set of constraints necessary to avoid out of bound accesses, we
626// first build the set of data locations that are not within array bounds. We
627// then apply the reverse access relation to obtain the set of iterations that
628// may contain invalid accesses and reduce this set of iterations to the ones
629// that are actually executed by intersecting them with the domain of the
630// statement. If we now project out all loop dimensions, we obtain a set of
631// parameters that may cause statement instances to be executed that may
632// possibly yield out of bound memory accesses. The complement of these
633// constraints is the set of constraints that needs to be assumed to ensure such
634// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000635void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000636 auto *SAI = getScopArrayInfo();
Johannes Doerferta99130f2014-10-13 12:58:03 +0000637 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000638 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Roman Gareev10595a12016-01-08 14:01:59 +0000639 for (int i = 1, Size = isl_space_dim(Space, isl_dim_set); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000640 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
641 isl_pw_aff *Var =
642 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
643 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
644
645 isl_set *DimOutside;
646
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000647 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfertadeab372016-02-07 13:57:32 +0000648 isl_pw_aff *SizeE = SAI->getDimensionSizePw(i);
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000649 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
650 isl_space_dim(Space, isl_dim_set));
651 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
652 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000653
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000654 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000655
656 Outside = isl_set_union(Outside, DimOutside);
657 }
658
659 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
660 Outside = isl_set_intersect(Outside, Statement->getDomain());
661 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000662
663 // Remove divs to avoid the construction of overly complicated assumptions.
664 // Doing so increases the set of parameter combinations that are assumed to
665 // not appear. This is always save, but may make the resulting run-time check
666 // bail out more often than strictly necessary.
667 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000668 Outside = isl_set_complement(Outside);
Michael Kruse7071e8b2016-04-11 13:24:29 +0000669 const auto &Loc = getAccessInstruction()
670 ? getAccessInstruction()->getDebugLoc()
671 : DebugLoc();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000672 Statement->getParent()->recordAssumption(INBOUNDS, Outside, Loc,
673 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000674 isl_space_free(Space);
675}
676
Johannes Doerfertcea61932016-02-21 19:13:19 +0000677void MemoryAccess::buildMemIntrinsicAccessRelation() {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000678 assert(isa<MemIntrinsic>(getAccessInstruction()));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000679 assert(Subscripts.size() == 2 && Sizes.size() == 0);
680
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000681 auto *SubscriptPWA = getPwAff(Subscripts[0]);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000682 auto *SubscriptMap = isl_map_from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000683
684 isl_map *LengthMap;
685 if (Subscripts[1] == nullptr) {
686 LengthMap = isl_map_universe(isl_map_get_space(SubscriptMap));
687 } else {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000688 auto *LengthPWA = getPwAff(Subscripts[1]);
Johannes Doerferta7920982016-02-25 14:08:48 +0000689 LengthMap = isl_map_from_pw_aff(LengthPWA);
690 auto *RangeSpace = isl_space_range(isl_map_get_space(LengthMap));
691 LengthMap = isl_map_apply_range(LengthMap, isl_map_lex_gt(RangeSpace));
692 }
693 LengthMap = isl_map_lower_bound_si(LengthMap, isl_dim_out, 0, 0);
694 LengthMap = isl_map_align_params(LengthMap, isl_map_get_space(SubscriptMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000695 SubscriptMap =
696 isl_map_align_params(SubscriptMap, isl_map_get_space(LengthMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000697 LengthMap = isl_map_sum(LengthMap, SubscriptMap);
698 AccessRelation = isl_map_set_tuple_id(LengthMap, isl_dim_in,
699 getStatement()->getDomainId());
700}
701
Johannes Doerferte7044942015-02-24 11:58:30 +0000702void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
703 ScalarEvolution *SE = Statement->getParent()->getSE();
704
Johannes Doerfertcea61932016-02-21 19:13:19 +0000705 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000706 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000707 return;
708
709 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000710 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
711 return;
712
713 auto *PtrSCEV = SE->getSCEV(Ptr);
714 if (isa<SCEVCouldNotCompute>(PtrSCEV))
715 return;
716
717 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
718 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
719 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
720
721 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
722 if (Range.isFullSet())
723 return;
724
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000725 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000726 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000727 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000728 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000729 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000730
731 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000732 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000733
734 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
735 AccessRange =
736 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
737 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
738}
739
Michael Krusee2bccbb2015-09-18 19:59:43 +0000740__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000741 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000742 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000743
744 for (int i = Size - 2; i >= 0; --i) {
745 isl_space *Space;
746 isl_map *MapOne, *MapTwo;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000747 isl_pw_aff *DimSize = getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000748
749 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
750 isl_pw_aff_free(DimSize);
751 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
752
753 Space = isl_map_get_space(AccessRelation);
754 Space = isl_space_map_from_set(isl_space_range(Space));
755 Space = isl_space_align_params(Space, SpaceSize);
756
757 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
758 isl_id_free(ParamId);
759
760 MapOne = isl_map_universe(isl_space_copy(Space));
761 for (int j = 0; j < Size; ++j)
762 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
763 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
764
765 MapTwo = isl_map_universe(isl_space_copy(Space));
766 for (int j = 0; j < Size; ++j)
767 if (j < i || j > i + 1)
768 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
769
770 isl_local_space *LS = isl_local_space_from_space(Space);
771 isl_constraint *C;
772 C = isl_equality_alloc(isl_local_space_copy(LS));
773 C = isl_constraint_set_constant_si(C, -1);
774 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
775 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
776 MapTwo = isl_map_add_constraint(MapTwo, C);
777 C = isl_equality_alloc(LS);
778 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
779 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
780 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
781 MapTwo = isl_map_add_constraint(MapTwo, C);
782 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
783
784 MapOne = isl_map_union(MapOne, MapTwo);
785 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
786 }
787 return AccessRelation;
788}
789
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000790/// @brief Check if @p Expr is divisible by @p Size.
791static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000792 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000793 if (Size == 1)
794 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000795
796 // Only one factor needs to be divisible.
797 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
798 for (auto *FactorExpr : MulExpr->operands())
799 if (isDivisible(FactorExpr, Size, SE))
800 return true;
801 return false;
802 }
803
804 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
805 // to be divisble.
806 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
807 for (auto *OpExpr : NAryExpr->operands())
808 if (!isDivisible(OpExpr, Size, SE))
809 return false;
810 return true;
811 }
812
813 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
814 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
815 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
816 return MulSCEV == Expr;
817}
818
Michael Krusee2bccbb2015-09-18 19:59:43 +0000819void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
820 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000821
Johannes Doerfert85676e32016-04-23 14:32:34 +0000822 // Initialize the invalid domain which describes all iterations for which the
823 // access relation is not modeled correctly.
Johannes Doerferta4dd8ef2016-04-25 13:36:23 +0000824 auto *StmtInvalidDomain = getStatement()->getInvalidDomain();
825 InvalidDomain = isl_set_empty(isl_set_get_space(StmtInvalidDomain));
826 isl_set_free(StmtInvalidDomain);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000827
Michael Krusee2bccbb2015-09-18 19:59:43 +0000828 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000829 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000830
Michael Krusee2bccbb2015-09-18 19:59:43 +0000831 if (!isAffine()) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000832 if (isa<MemIntrinsic>(getAccessInstruction()))
833 buildMemIntrinsicAccessRelation();
834
Tobias Grosser4f967492013-06-23 05:21:18 +0000835 // We overapproximate non-affine accesses with a possible access to the
836 // whole array. For read accesses it does not make a difference, if an
837 // access must or may happen. However, for write accesses it is important to
838 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000839 if (!AccessRelation)
840 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
841
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000842 AccessRelation =
843 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000844 return;
845 }
846
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000847 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000848 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000849
Michael Krusee2bccbb2015-09-18 19:59:43 +0000850 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000851 isl_pw_aff *Affine = getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000852 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000853 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000854 }
855
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000856 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000857 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000858
Tobias Grosser79baa212014-04-10 08:38:02 +0000859 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000860 AccessRelation = isl_map_set_tuple_id(
861 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000862 AccessRelation =
863 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
864
Tobias Grosseraa660a92015-03-30 00:07:50 +0000865 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000866 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000867}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000868
Michael Krusecac948e2015-10-02 13:53:07 +0000869MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +0000870 AccessType AccType, Value *BaseAddress,
871 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000872 ArrayRef<const SCEV *> Subscripts,
873 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000874 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
Johannes Doerfertcea61932016-02-21 19:13:19 +0000875 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
Johannes Doerfert85676e32016-04-23 14:32:34 +0000876 InvalidDomain(nullptr), BaseAddr(BaseAddress), BaseName(BaseName),
877 ElementType(ElementType), Sizes(Sizes.begin(), Sizes.end()),
878 AccessInstruction(AccessInst), AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000879 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000880 NewAccessRelation(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000881 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Johannes Doerfertcea61932016-02-21 19:13:19 +0000882 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size()) + "_";
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000883
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000884 std::string IdName =
885 getIslCompatibleName(Stmt->getBaseName(), Access, BaseName);
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000886 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
887}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000888
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000889void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000890 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Johannes Doerfert85676e32016-04-23 14:32:34 +0000891 InvalidDomain =
892 isl_set_align_params(InvalidDomain, isl_space_copy(ParamSpace));
Tobias Grosser37487052011-10-06 00:03:42 +0000893 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000894}
895
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000896const std::string MemoryAccess::getReductionOperatorStr() const {
897 return MemoryAccess::getReductionOperatorStr(getReductionType());
898}
899
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000900__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
901
Johannes Doerfertf6183392014-07-01 20:52:51 +0000902raw_ostream &polly::operator<<(raw_ostream &OS,
903 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000904 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000905 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000906 else
907 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000908 return OS;
909}
910
Tobias Grosser75805372011-04-29 06:27:02 +0000911void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000912 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000913 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000914 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000915 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000916 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000917 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000918 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000919 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000920 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000921 break;
922 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000923 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000924 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000925 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000926 if (hasNewAccessRelation())
927 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000928}
929
Tobias Grosser74394f02013-01-14 22:40:23 +0000930void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000931
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000932__isl_give isl_pw_aff *MemoryAccess::getPwAff(const SCEV *E) {
933 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +0000934 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
935 InvalidDomain = isl_set_union(InvalidDomain, PWAC.second);
936 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000937}
938
Tobias Grosser75805372011-04-29 06:27:02 +0000939// Create a map in the size of the provided set domain, that maps from the
940// one element of the provided set domain to another element of the provided
941// set domain.
942// The mapping is limited to all points that are equal in all but the last
943// dimension and for which the last dimension of the input is strict smaller
944// than the last dimension of the output.
945//
946// getEqualAndLarger(set[i0, i1, ..., iX]):
947//
948// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
949// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
950//
Tobias Grosserf5338802011-10-06 00:03:35 +0000951static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000952 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000953 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000954 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000955
956 // Set all but the last dimension to be equal for the input and output
957 //
958 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
959 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000960 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000961 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000962
963 // Set the last dimension of the input to be strict smaller than the
964 // last dimension of the output.
965 //
966 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000967 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
968 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000969 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000970}
971
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000972__isl_give isl_set *
973MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000974 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000975 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000976 isl_space *Space = isl_space_range(isl_map_get_space(S));
977 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000978
Sebastian Popa00a0292012-12-18 07:46:06 +0000979 S = isl_map_reverse(S);
980 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000981
Sebastian Popa00a0292012-12-18 07:46:06 +0000982 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
983 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
984 NextScatt = isl_map_apply_domain(NextScatt, S);
985 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000986
Sebastian Popa00a0292012-12-18 07:46:06 +0000987 isl_set *Deltas = isl_map_deltas(NextScatt);
988 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000989}
990
Sebastian Popa00a0292012-12-18 07:46:06 +0000991bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000992 int StrideWidth) const {
993 isl_set *Stride, *StrideX;
994 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000995
Sebastian Popa00a0292012-12-18 07:46:06 +0000996 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000997 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000998 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
999 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
1000 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
1001 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +00001002 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +00001003
Tobias Grosser28dd4862012-01-24 16:42:16 +00001004 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +00001005 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001006
Tobias Grosser28dd4862012-01-24 16:42:16 +00001007 return IsStrideX;
1008}
1009
Sebastian Popa00a0292012-12-18 07:46:06 +00001010bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
1011 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001012}
1013
Sebastian Popa00a0292012-12-18 07:46:06 +00001014bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
1015 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001016}
1017
Tobias Grosser166c4222015-09-05 07:46:40 +00001018void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
1019 isl_map_free(NewAccessRelation);
1020 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001021}
Tobias Grosser75805372011-04-29 06:27:02 +00001022
1023//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001024
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001025__isl_give isl_map *ScopStmt::getSchedule() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001026 isl_set *Domain = getDomain();
1027 if (isl_set_is_empty(Domain)) {
1028 isl_set_free(Domain);
1029 return isl_map_from_aff(
1030 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1031 }
1032 auto *Schedule = getParent()->getSchedule();
1033 Schedule = isl_union_map_intersect_domain(
1034 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
1035 if (isl_union_map_is_empty(Schedule)) {
1036 isl_set_free(Domain);
1037 isl_union_map_free(Schedule);
1038 return isl_map_from_aff(
1039 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1040 }
1041 auto *M = isl_map_from_union_map(Schedule);
1042 M = isl_map_coalesce(M);
1043 M = isl_map_gist_domain(M, Domain);
1044 M = isl_map_coalesce(M);
1045 return M;
1046}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001047
Johannes Doerfert574182d2015-08-12 10:19:50 +00001048__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00001049 PWACtx PWAC = getParent()->getPwAff(E, getEntryBlock());
1050 InvalidDomain = isl_set_union(InvalidDomain, PWAC.second);
1051 return PWAC.first;
Johannes Doerfert574182d2015-08-12 10:19:50 +00001052}
1053
Tobias Grosser37eb4222014-02-20 21:43:54 +00001054void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
1055 assert(isl_set_is_subset(NewDomain, Domain) &&
1056 "New domain is not a subset of old domain!");
1057 isl_set_free(Domain);
1058 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001059}
1060
Michael Krusecac948e2015-10-02 13:53:07 +00001061void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +00001062 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +00001063 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00001064 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001065
Tobias Grossera535dff2015-12-13 19:59:01 +00001066 ScopArrayInfo::MemoryKind Ty;
1067 if (Access->isPHIKind())
1068 Ty = ScopArrayInfo::MK_PHI;
1069 else if (Access->isExitPHIKind())
1070 Ty = ScopArrayInfo::MK_ExitPHI;
1071 else if (Access->isValueKind())
1072 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001073 else
Tobias Grossera535dff2015-12-13 19:59:01 +00001074 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001075
Johannes Doerfertadeab372016-02-07 13:57:32 +00001076 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
1077 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001078 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +00001079 }
1080}
1081
Michael Krusecac948e2015-10-02 13:53:07 +00001082void ScopStmt::addAccess(MemoryAccess *Access) {
1083 Instruction *AccessInst = Access->getAccessInstruction();
1084
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001085 if (Access->isArrayKind()) {
1086 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1087 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001088 } else if (Access->isValueKind() && Access->isWrite()) {
1089 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001090 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001091 assert(!ValueWrites.lookup(AccessVal));
1092
1093 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001094 } else if (Access->isValueKind() && Access->isRead()) {
1095 Value *AccessVal = Access->getAccessValue();
1096 assert(!ValueReads.lookup(AccessVal));
1097
1098 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001099 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
1100 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
1101 assert(!PHIWrites.lookup(PHI));
1102
1103 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001104 }
1105
1106 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001107}
1108
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001109void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001110 for (MemoryAccess *MA : *this)
1111 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001112
Johannes Doerferta3519512016-04-23 13:02:23 +00001113 InvalidDomain = isl_set_align_params(InvalidDomain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001114 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001115}
1116
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001117/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1118static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1119 void *User) {
1120 isl_set **BoundedParts = static_cast<isl_set **>(User);
1121 if (isl_basic_set_is_bounded(BSet))
1122 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1123 else
1124 isl_basic_set_free(BSet);
1125 return isl_stat_ok;
1126}
1127
1128/// @brief Return the bounded parts of @p S.
1129static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1130 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1131 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1132 isl_set_free(S);
1133 return BoundedParts;
1134}
1135
1136/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1137///
1138/// @returns A separation of @p S into first an unbounded then a bounded subset,
1139/// both with regards to the dimension @p Dim.
1140static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1141partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1142
1143 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001144 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001145
1146 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001147 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001148
1149 // Remove dimensions that are greater than Dim as they are not interesting.
1150 assert(NumDimsS >= Dim + 1);
1151 OnlyDimS =
1152 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1153
1154 // Create artificial parametric upper bounds for dimensions smaller than Dim
1155 // as we are not interested in them.
1156 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1157 for (unsigned u = 0; u < Dim; u++) {
1158 isl_constraint *C = isl_inequality_alloc(
1159 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1160 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1161 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1162 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1163 }
1164
1165 // Collect all bounded parts of OnlyDimS.
1166 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1167
1168 // Create the dimensions greater than Dim again.
1169 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1170 NumDimsS - Dim - 1);
1171
1172 // Remove the artificial upper bound parameters again.
1173 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1174
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001175 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001176 return std::make_pair(UnboundedParts, BoundedParts);
1177}
1178
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001179/// @brief Set the dimension Ids from @p From in @p To.
1180static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1181 __isl_take isl_set *To) {
1182 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1183 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1184 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1185 }
1186 return To;
1187}
1188
1189/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001190static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001191 __isl_take isl_pw_aff *L,
1192 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001193 switch (Pred) {
1194 case ICmpInst::ICMP_EQ:
1195 return isl_pw_aff_eq_set(L, R);
1196 case ICmpInst::ICMP_NE:
1197 return isl_pw_aff_ne_set(L, R);
1198 case ICmpInst::ICMP_SLT:
1199 return isl_pw_aff_lt_set(L, R);
1200 case ICmpInst::ICMP_SLE:
1201 return isl_pw_aff_le_set(L, R);
1202 case ICmpInst::ICMP_SGT:
1203 return isl_pw_aff_gt_set(L, R);
1204 case ICmpInst::ICMP_SGE:
1205 return isl_pw_aff_ge_set(L, R);
1206 case ICmpInst::ICMP_ULT:
1207 return isl_pw_aff_lt_set(L, R);
1208 case ICmpInst::ICMP_UGT:
1209 return isl_pw_aff_gt_set(L, R);
1210 case ICmpInst::ICMP_ULE:
1211 return isl_pw_aff_le_set(L, R);
1212 case ICmpInst::ICMP_UGE:
1213 return isl_pw_aff_ge_set(L, R);
1214 default:
1215 llvm_unreachable("Non integer predicate not supported");
1216 }
1217}
1218
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001219/// @brief Create the conditions under which @p L @p Pred @p R is true.
1220///
1221/// Helper function that will make sure the dimensions of the result have the
1222/// same isl_id's as the @p Domain.
1223static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1224 __isl_take isl_pw_aff *L,
1225 __isl_take isl_pw_aff *R,
1226 __isl_keep isl_set *Domain) {
1227 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1228 return setDimensionIds(Domain, ConsequenceCondSet);
1229}
1230
1231/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001232///
1233/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001234/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1235/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001236static void
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001237buildConditionSets(ScopStmt &Stmt, SwitchInst *SI, Loop *L,
1238 __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001239 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1240
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001241 Value *Condition = getConditionFromTerminator(SI);
1242 assert(Condition && "No condition for switch");
1243
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001244 Scop &S = *Stmt.getParent();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001245 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001246 isl_pw_aff *LHS, *RHS;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001247 LHS = Stmt.getPwAff(SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001248
1249 unsigned NumSuccessors = SI->getNumSuccessors();
1250 ConditionSets.resize(NumSuccessors);
1251 for (auto &Case : SI->cases()) {
1252 unsigned Idx = Case.getSuccessorIndex();
1253 ConstantInt *CaseValue = Case.getCaseValue();
1254
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001255 RHS = Stmt.getPwAff(SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001256 isl_set *CaseConditionSet =
1257 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1258 ConditionSets[Idx] = isl_set_coalesce(
1259 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1260 }
1261
1262 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1263 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1264 for (unsigned u = 2; u < NumSuccessors; u++)
1265 ConditionSetUnion =
1266 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1267 ConditionSets[0] = setDimensionIds(
1268 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1269
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001270 isl_pw_aff_free(LHS);
1271}
1272
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001273/// @brief Build the conditions sets for the branch condition @p Condition in
1274/// the @p Domain.
1275///
1276/// This will fill @p ConditionSets with the conditions under which control
1277/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001278/// have as many elements as @p TI has successors. If @p TI is nullptr the
1279/// context under which @p Condition is true/false will be returned as the
1280/// new elements of @p ConditionSets.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001281static void
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001282buildConditionSets(ScopStmt &Stmt, Value *Condition, TerminatorInst *TI,
1283 Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001284 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1285
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001286 Scop &S = *Stmt.getParent();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001287 isl_set *ConsequenceCondSet = nullptr;
1288 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1289 if (CCond->isZero())
1290 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1291 else
1292 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1293 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1294 auto Opcode = BinOp->getOpcode();
1295 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1296
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001297 buildConditionSets(Stmt, BinOp->getOperand(0), TI, L, Domain,
1298 ConditionSets);
1299 buildConditionSets(Stmt, BinOp->getOperand(1), TI, L, Domain,
1300 ConditionSets);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001301
1302 isl_set_free(ConditionSets.pop_back_val());
1303 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1304 isl_set_free(ConditionSets.pop_back_val());
1305 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1306
1307 if (Opcode == Instruction::And)
1308 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1309 else
1310 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1311 } else {
1312 auto *ICond = dyn_cast<ICmpInst>(Condition);
1313 assert(ICond &&
1314 "Condition of exiting branch was neither constant nor ICmp!");
1315
1316 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001317 isl_pw_aff *LHS, *RHS;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001318 LHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L));
1319 RHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001320 ConsequenceCondSet =
1321 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1322 }
1323
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001324 // If no terminator was given we are only looking for parameter constraints
1325 // under which @p Condition is true/false.
1326 if (!TI)
1327 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001328 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001329 ConsequenceCondSet = isl_set_coalesce(
1330 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001331
Johannes Doerfertb2885792016-04-26 09:20:41 +00001332 isl_set *AlternativeCondSet = nullptr;
1333 bool ToComplex =
1334 isl_set_n_basic_set(ConsequenceCondSet) >= MaxConjunctsInDomain;
1335
1336 if (!ToComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001337 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1338 isl_set_copy(ConsequenceCondSet));
Johannes Doerfertb2885792016-04-26 09:20:41 +00001339 ToComplex = isl_set_n_basic_set(AlternativeCondSet) >= MaxConjunctsInDomain;
1340 }
1341
1342 if (ToComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001343 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc());
Johannes Doerfertb2885792016-04-26 09:20:41 +00001344 isl_set_free(AlternativeCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001345 AlternativeCondSet = isl_set_empty(isl_set_get_space(ConsequenceCondSet));
Johannes Doerfertb2885792016-04-26 09:20:41 +00001346 isl_set_free(ConsequenceCondSet);
1347 ConsequenceCondSet = isl_set_empty(isl_set_get_space(AlternativeCondSet));
Johannes Doerfert15194912016-04-04 07:59:41 +00001348 }
1349
1350 ConditionSets.push_back(ConsequenceCondSet);
1351 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001352}
1353
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001354/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1355///
1356/// This will fill @p ConditionSets with the conditions under which control
1357/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1358/// have as many elements as @p TI has successors.
1359static void
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001360buildConditionSets(ScopStmt &Stmt, TerminatorInst *TI, Loop *L,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001361 __isl_keep isl_set *Domain,
1362 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1363
1364 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001365 return buildConditionSets(Stmt, SI, L, Domain, ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001366
1367 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1368
1369 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001370 ConditionSets.push_back(isl_set_copy(Domain));
1371 return;
1372 }
1373
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001374 Value *Condition = getConditionFromTerminator(TI);
1375 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001376
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001377 return buildConditionSets(Stmt, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001378}
1379
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001380void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001381 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001382
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001383 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001384 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001385}
1386
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001387void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1388 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001389 isl_ctx *Ctx = Parent.getIslCtx();
1390 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1391 Type *Ty = GEP->getPointerOperandType();
1392 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001393
1394 // The set of loads that are required to be invariant.
1395 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001396
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001397 std::vector<const SCEV *> Subscripts;
1398 std::vector<int> Sizes;
1399
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001400 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001401
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001402 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001403 Ty = PtrTy->getElementType();
1404 }
1405
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001406 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001407
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001408 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001409
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001410 auto *NotExecuted = isl_set_complement(isl_set_params(getDomain()));
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001411 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001412 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001413 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001414
Michael Kruse09eb4452016-03-03 22:10:47 +00001415 auto *Scope = SD.getLI()->getLoopFor(getEntryBlock());
Johannes Doerfert09e36972015-10-07 20:17:36 +00001416 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00001417 if (!isAffineExpr(&Parent.getRegion(), Scope, Expr, SE, &AccessILS))
Johannes Doerfert09e36972015-10-07 20:17:36 +00001418 continue;
1419
1420 bool NonAffine = false;
1421 for (LoadInst *LInst : AccessILS)
1422 if (!ScopRIL.count(LInst))
1423 NonAffine = true;
1424
1425 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001426 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001427
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001428 isl_pw_aff *AccessOffset = getPwAff(Expr);
1429 AccessOffset =
1430 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001431
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001432 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1433 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001434
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001435 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1436 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1437 OutOfBound = isl_set_params(OutOfBound);
1438 isl_set *InBound = isl_set_complement(OutOfBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001439
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001440 // A => B == !A or B
1441 isl_set *InBoundIfExecuted =
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001442 isl_set_union(isl_set_copy(NotExecuted), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001443
Roman Gareev10595a12016-01-08 14:01:59 +00001444 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00001445 Parent.recordAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc(),
1446 AS_ASSUMPTION);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001447 }
1448
1449 isl_local_space_free(LSpace);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001450 isl_set_free(NotExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001451}
1452
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001453void ScopStmt::deriveAssumptions(ScopDetection &SD) {
1454 for (auto *MA : *this) {
1455 if (!MA->isArrayKind())
1456 continue;
1457
1458 MemAccInst Acc(MA->getAccessInstruction());
1459 auto *GEP = dyn_cast_or_null<GetElementPtrInst>(Acc.getPointerOperand());
1460
1461 if (GEP)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001462 deriveAssumptionsFromGEP(GEP, SD);
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001463 }
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001464}
1465
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001466void ScopStmt::collectSurroundingLoops() {
1467 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1468 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1469 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1470 isl_id_free(DimId);
1471 }
1472}
1473
Michael Kruse9d080092015-09-11 21:41:48 +00001474ScopStmt::ScopStmt(Scop &parent, Region &R)
Johannes Doerferta3519512016-04-23 13:02:23 +00001475 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
1476 R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001477
Tobias Grosser16c44032015-07-09 07:31:45 +00001478 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001479}
1480
Michael Kruse9d080092015-09-11 21:41:48 +00001481ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Johannes Doerferta3519512016-04-23 13:02:23 +00001482 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
1483 R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001484
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001485 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001486}
1487
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001488void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001489 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001490
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001491 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001492 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001493 buildAccessRelations();
1494
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001495 deriveAssumptions(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001496
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001497 if (DetectReductions)
1498 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001499}
1500
Johannes Doerferte58a0122014-06-27 20:31:28 +00001501/// @brief Collect loads which might form a reduction chain with @p StoreMA
1502///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001503/// Check if the stored value for @p StoreMA is a binary operator with one or
1504/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001505/// used only once (by @p StoreMA) and its load operands are also used only
1506/// once, we have found a possible reduction chain. It starts at an operand
1507/// load and includes the binary operator and @p StoreMA.
1508///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001509/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001510/// escape this block or into any other store except @p StoreMA.
1511void ScopStmt::collectCandiateReductionLoads(
1512 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1513 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1514 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001515 return;
1516
1517 // Skip if there is not one binary operator between the load and the store
1518 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001519 if (!BinOp)
1520 return;
1521
1522 // Skip if the binary operators has multiple uses
1523 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001524 return;
1525
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001526 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001527 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1528 return;
1529
Johannes Doerfert9890a052014-07-01 00:32:29 +00001530 // Skip if the binary operator is outside the current SCoP
1531 if (BinOp->getParent() != Store->getParent())
1532 return;
1533
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001534 // Skip if it is a multiplicative reduction and we disabled them
1535 if (DisableMultiplicativeReductions &&
1536 (BinOp->getOpcode() == Instruction::Mul ||
1537 BinOp->getOpcode() == Instruction::FMul))
1538 return;
1539
Johannes Doerferte58a0122014-06-27 20:31:28 +00001540 // Check the binary operator operands for a candidate load
1541 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1542 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1543 if (!PossibleLoad0 && !PossibleLoad1)
1544 return;
1545
1546 // A load is only a candidate if it cannot escape (thus has only this use)
1547 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001548 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001549 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001550 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001551 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001552 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001553}
1554
1555/// @brief Check for reductions in this ScopStmt
1556///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001557/// Iterate over all store memory accesses and check for valid binary reduction
1558/// like chains. For all candidates we check if they have the same base address
1559/// and there are no other accesses which overlap with them. The base address
1560/// check rules out impossible reductions candidates early. The overlap check,
1561/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001562/// guarantees that none of the intermediate results will escape during
1563/// execution of the loop nest. We basically check here that no other memory
1564/// access can access the same memory as the potential reduction.
1565void ScopStmt::checkForReductions() {
1566 SmallVector<MemoryAccess *, 2> Loads;
1567 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1568
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001569 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001570 // stores and collecting possible reduction loads.
1571 for (MemoryAccess *StoreMA : MemAccs) {
1572 if (StoreMA->isRead())
1573 continue;
1574
1575 Loads.clear();
1576 collectCandiateReductionLoads(StoreMA, Loads);
1577 for (MemoryAccess *LoadMA : Loads)
1578 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1579 }
1580
1581 // Then check each possible candidate pair.
1582 for (const auto &CandidatePair : Candidates) {
1583 bool Valid = true;
1584 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1585 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1586
1587 // Skip those with obviously unequal base addresses.
1588 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1589 isl_map_free(LoadAccs);
1590 isl_map_free(StoreAccs);
1591 continue;
1592 }
1593
1594 // And check if the remaining for overlap with other memory accesses.
1595 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1596 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1597 isl_set *AllAccs = isl_map_range(AllAccsRel);
1598
1599 for (MemoryAccess *MA : MemAccs) {
1600 if (MA == CandidatePair.first || MA == CandidatePair.second)
1601 continue;
1602
1603 isl_map *AccRel =
1604 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1605 isl_set *Accs = isl_map_range(AccRel);
1606
1607 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1608 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1609 Valid = Valid && isl_set_is_empty(OverlapAccs);
1610 isl_set_free(OverlapAccs);
1611 }
1612 }
1613
1614 isl_set_free(AllAccs);
1615 if (!Valid)
1616 continue;
1617
Johannes Doerfertf6183392014-07-01 20:52:51 +00001618 const LoadInst *Load =
1619 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1620 MemoryAccess::ReductionType RT =
1621 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1622
Johannes Doerferte58a0122014-06-27 20:31:28 +00001623 // If no overlapping access was found we mark the load and store as
1624 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001625 CandidatePair.first->markAsReductionLike(RT);
1626 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001627 }
Tobias Grosser75805372011-04-29 06:27:02 +00001628}
1629
Tobias Grosser74394f02013-01-14 22:40:23 +00001630std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001631
Tobias Grosser54839312015-04-21 11:37:25 +00001632std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001633 auto *S = getSchedule();
1634 auto Str = stringFromIslObj(S);
1635 isl_map_free(S);
1636 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001637}
1638
Johannes Doerferta3519512016-04-23 13:02:23 +00001639void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1640 isl_set_free(InvalidDomain);
1641 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001642}
1643
Michael Kruse375cb5f2016-02-24 22:08:24 +00001644BasicBlock *ScopStmt::getEntryBlock() const {
1645 if (isBlockStmt())
1646 return getBasicBlock();
1647 return getRegion()->getEntry();
1648}
1649
Michael Kruse7b5caa42016-02-24 22:08:28 +00001650RegionNode *ScopStmt::getRegionNode() const {
1651 if (isRegionStmt())
1652 return getRegion()->getNode();
1653 return getParent()->getRegion().getBBNode(getBasicBlock());
1654}
1655
Tobias Grosser74394f02013-01-14 22:40:23 +00001656unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001657
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001658unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001659
Tobias Grosser75805372011-04-29 06:27:02 +00001660const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1661
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001662const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001663 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001664}
1665
Tobias Grosser74394f02013-01-14 22:40:23 +00001666isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001667
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001668__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001669
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001670__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001671 return isl_set_get_space(Domain);
1672}
1673
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001674__isl_give isl_id *ScopStmt::getDomainId() const {
1675 return isl_set_get_tuple_id(Domain);
1676}
Tobias Grossercd95b772012-08-30 11:49:38 +00001677
Johannes Doerfert7c013572016-04-12 09:57:34 +00001678ScopStmt::~ScopStmt() {
1679 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001680 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001681}
Tobias Grosser75805372011-04-29 06:27:02 +00001682
1683void ScopStmt::print(raw_ostream &OS) const {
1684 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001685 OS.indent(12) << "Domain :=\n";
1686
1687 if (Domain) {
1688 OS.indent(16) << getDomainStr() << ";\n";
1689 } else
1690 OS.indent(16) << "n/a\n";
1691
Tobias Grosser54839312015-04-21 11:37:25 +00001692 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001693
1694 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001695 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001696 } else
1697 OS.indent(16) << "n/a\n";
1698
Tobias Grosser083d3d32014-06-28 08:59:45 +00001699 for (MemoryAccess *Access : MemAccs)
1700 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001701}
1702
1703void ScopStmt::dump() const { print(dbgs()); }
1704
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001705void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001706 // Remove all memory accesses in @p InvMAs from this statement
1707 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001708 // MK_Value READs have no access instruction, hence would not be removed by
1709 // this function. However, it is only used for invariant LoadInst accesses,
1710 // its arguments are always affine, hence synthesizable, and therefore there
1711 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001712 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001713 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001714 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001715 };
1716 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1717 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001718 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001719 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001720}
1721
Tobias Grosser75805372011-04-29 06:27:02 +00001722//===----------------------------------------------------------------------===//
1723/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001724
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001725void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001726 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1727 isl_set_free(Context);
1728 Context = NewContext;
1729}
1730
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001731/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1732struct SCEVSensitiveParameterRewriter
1733 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1734 ValueToValueMap &VMap;
1735 ScalarEvolution &SE;
1736
1737public:
1738 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1739 : VMap(VMap), SE(SE) {}
1740
1741 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1742 ValueToValueMap &VMap) {
1743 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1744 return SSPR.visit(E);
1745 }
1746
1747 const SCEV *visit(const SCEV *E) {
1748 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1749 }
1750
1751 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1752
1753 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1754 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1755 }
1756
1757 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1758 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1759 }
1760
1761 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1762 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1763 }
1764
1765 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1766 SmallVector<const SCEV *, 4> Operands;
1767 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1768 Operands.push_back(visit(E->getOperand(i)));
1769 return SE.getAddExpr(Operands);
1770 }
1771
1772 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1773 SmallVector<const SCEV *, 4> Operands;
1774 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1775 Operands.push_back(visit(E->getOperand(i)));
1776 return SE.getMulExpr(Operands);
1777 }
1778
1779 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1780 SmallVector<const SCEV *, 4> Operands;
1781 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1782 Operands.push_back(visit(E->getOperand(i)));
1783 return SE.getSMaxExpr(Operands);
1784 }
1785
1786 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1787 SmallVector<const SCEV *, 4> Operands;
1788 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1789 Operands.push_back(visit(E->getOperand(i)));
1790 return SE.getUMaxExpr(Operands);
1791 }
1792
1793 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1794 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1795 }
1796
1797 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1798 auto *Start = visit(E->getStart());
1799 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1800 visit(E->getStepRecurrence(SE)),
1801 E->getLoop(), SCEV::FlagAnyWrap);
1802 return SE.getAddExpr(Start, AddRec);
1803 }
1804
1805 const SCEV *visitUnknown(const SCEVUnknown *E) {
1806 if (auto *NewValue = VMap.lookup(E->getValue()))
1807 return SE.getUnknown(NewValue);
1808 return E;
1809 }
1810};
1811
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001812const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001813 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001814}
1815
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001816void Scop::createParameterId(const SCEV *Parameter) {
1817 assert(Parameters.count(Parameter));
1818 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001819
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001820 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001821
Tobias Grosser8f99c162011-11-15 11:38:55 +00001822 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1823 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001824
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001825 // If this parameter references a specific Value and this value has a name
1826 // we use this name as it is likely to be unique and more useful than just
1827 // a number.
1828 if (Val->hasName())
1829 ParameterName = Val->getName();
1830 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001831 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001832 if (LoadOrigin->hasName()) {
1833 ParameterName += "_loaded_from_";
1834 ParameterName +=
1835 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1836 }
1837 }
1838 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001839
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001840 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1841 const_cast<void *>((const void *)Parameter));
1842 ParameterIds[Parameter] = Id;
1843}
1844
1845void Scop::addParams(const ParameterSetTy &NewParameters) {
1846 for (const SCEV *Parameter : NewParameters) {
1847 // Normalize the SCEV to get the representing element for an invariant load.
1848 Parameter = extractConstantFactor(Parameter, *SE).second;
1849 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1850
1851 if (Parameters.insert(Parameter))
1852 createParameterId(Parameter);
1853 }
1854}
1855
1856__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
1857 // Normalize the SCEV to get the representing element for an invariant load.
1858 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1859 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001860}
Tobias Grosser75805372011-04-29 06:27:02 +00001861
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001862__isl_give isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001863 isl_set *DomainContext = isl_union_set_params(getDomains());
1864 return isl_set_intersect_params(C, DomainContext);
1865}
1866
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001867void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1868 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001869 auto *R = &getRegion();
1870 auto &F = *R->getEntry()->getParent();
1871 for (auto &Assumption : AC.assumptions()) {
1872 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1873 if (!CI || CI->getNumArgOperands() != 1)
1874 continue;
1875 if (!DT.dominates(CI->getParent(), R->getEntry()))
1876 continue;
1877
Michael Kruse09eb4452016-03-03 22:10:47 +00001878 auto *L = LI.getLoopFor(CI->getParent());
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001879 auto *Val = CI->getArgOperand(0);
Johannes Doerfertf560b3d2016-04-25 13:33:07 +00001880 ParameterSetTy DetectedParams;
1881 if (!isAffineParamConstraint(Val, R, L, *SE, DetectedParams)) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001882 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1883 CI->getDebugLoc(),
1884 "Non-affine user assumption ignored.");
1885 continue;
1886 }
1887
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001888 // Collect all newly introduced parameters.
1889 ParameterSetTy NewParams;
1890 for (auto *Param : DetectedParams) {
1891 Param = extractConstantFactor(Param, *SE).second;
1892 Param = getRepresentingInvariantLoadSCEV(Param);
1893 if (Parameters.count(Param))
1894 continue;
1895 NewParams.insert(Param);
1896 }
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001897
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001898 SmallVector<isl_set *, 2> ConditionSets;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001899 buildConditionSets(*Stmts.begin(), Val, nullptr, L, Context, ConditionSets);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001900 assert(ConditionSets.size() == 2);
1901 isl_set_free(ConditionSets[1]);
1902
1903 auto *AssumptionCtx = ConditionSets[0];
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001904
1905 // Project out newly introduced parameters as they are not otherwise useful.
1906 if (!NewParams.empty()) {
1907 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
1908 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
1909 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
1910 isl_id_free(Id);
1911
1912 if (!NewParams.count(Param))
1913 continue;
1914
1915 AssumptionCtx =
1916 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
1917 }
1918 }
1919
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001920 emitOptimizationRemarkAnalysis(
1921 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1922 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1923 Context = isl_set_intersect(Context, AssumptionCtx);
1924 }
1925}
1926
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001927void Scop::addUserContext() {
1928 if (UserContextStr.empty())
1929 return;
1930
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001931 isl_set *UserContext =
1932 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001933 isl_space *Space = getParamSpace();
1934 if (isl_space_dim(Space, isl_dim_param) !=
1935 isl_set_dim(UserContext, isl_dim_param)) {
1936 auto SpaceStr = isl_space_to_str(Space);
1937 errs() << "Error: the context provided in -polly-context has not the same "
1938 << "number of dimensions than the computed context. Due to this "
1939 << "mismatch, the -polly-context option is ignored. Please provide "
1940 << "the context in the parameter space: " << SpaceStr << ".\n";
1941 free(SpaceStr);
1942 isl_set_free(UserContext);
1943 isl_space_free(Space);
1944 return;
1945 }
1946
1947 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001948 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1949 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001950
1951 if (strcmp(NameContext, NameUserContext) != 0) {
1952 auto SpaceStr = isl_space_to_str(Space);
1953 errs() << "Error: the name of dimension " << i
1954 << " provided in -polly-context "
1955 << "is '" << NameUserContext << "', but the name in the computed "
1956 << "context is '" << NameContext
1957 << "'. Due to this name mismatch, "
1958 << "the -polly-context option is ignored. Please provide "
1959 << "the context in the parameter space: " << SpaceStr << ".\n";
1960 free(SpaceStr);
1961 isl_set_free(UserContext);
1962 isl_space_free(Space);
1963 return;
1964 }
1965
1966 UserContext =
1967 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1968 isl_space_get_dim_id(Space, isl_dim_param, i));
1969 }
1970
1971 Context = isl_set_intersect(Context, UserContext);
1972 isl_space_free(Space);
1973}
1974
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001975void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001976 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001977
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001978 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001979 for (LoadInst *LInst : RIL) {
1980 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1981
Johannes Doerfert96e54712016-02-07 17:30:13 +00001982 Type *Ty = LInst->getType();
1983 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001984 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001985 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001986 continue;
1987 }
1988
1989 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00001990 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
1991 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001992 }
1993}
1994
Tobias Grosser6be480c2011-11-08 15:41:13 +00001995void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001996 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001997 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001998 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00001999 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002000}
2001
Tobias Grosser18daaca2012-05-22 10:47:27 +00002002void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002003 unsigned PDim = 0;
2004 for (auto *Parameter : Parameters) {
2005 ConstantRange SRange = SE->getSignedRange(Parameter);
2006 Context = addRangeBoundsToSet(Context, SRange, PDim++, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00002007 }
2008}
2009
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002010void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002011 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002012 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002013
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002014 unsigned PDim = 0;
2015 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002016 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002017 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002018 }
2019
2020 // Align the parameters of all data structures to the model.
2021 Context = isl_set_align_params(Context, Space);
2022
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002023 for (ScopStmt &Stmt : *this)
2024 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002025}
2026
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002027static __isl_give isl_set *
2028simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2029 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002030 // If we modelt all blocks in the SCoP that have side effects we can simplify
2031 // the context with the constraints that are needed for anything to be
2032 // executed at all. However, if we have error blocks in the SCoP we already
2033 // assumed some parameter combinations cannot occure and removed them from the
2034 // domains, thus we cannot use the remaining domain to simplify the
2035 // assumptions.
2036 if (!S.hasErrorBlock()) {
2037 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2038 AssumptionContext =
2039 isl_set_gist_params(AssumptionContext, DomainParameters);
2040 }
2041
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002042 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2043 return AssumptionContext;
2044}
2045
2046void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002047 // The parameter constraints of the iteration domains give us a set of
2048 // constraints that need to hold for all cases where at least a single
2049 // statement iteration is executed in the whole scop. We now simplify the
2050 // assumed context under the assumption that such constraints hold and at
2051 // least a single statement iteration is executed. For cases where no
2052 // statement instances are executed, the assumptions we have taken about
2053 // the executed code do not matter and can be changed.
2054 //
2055 // WARNING: This only holds if the assumptions we have taken do not reduce
2056 // the set of statement instances that are executed. Otherwise we
2057 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002058 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002059 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002060 // performed. In such a case, modifying the run-time conditions and
2061 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002062 // to not be executed.
2063 //
2064 // Example:
2065 //
2066 // When delinearizing the following code:
2067 //
2068 // for (long i = 0; i < 100; i++)
2069 // for (long j = 0; j < m; j++)
2070 // A[i+p][j] = 1.0;
2071 //
2072 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002073 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002074 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002075 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002076 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002077}
2078
Johannes Doerfertb164c792014-09-18 11:17:17 +00002079/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00002080static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002081 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
2082 isl_pw_multi_aff *MinPMA, *MaxPMA;
2083 isl_pw_aff *LastDimAff;
2084 isl_aff *OneAff;
2085 unsigned Pos;
2086
Johannes Doerfert6296d952016-04-22 11:38:19 +00002087 Set = isl_set_remove_divs(Set);
2088
2089 if (isl_set_n_basic_set(Set) >= MaxConjunctsInDomain) {
2090 isl_set_free(Set);
2091 return isl_stat_error;
2092 }
2093
Johannes Doerfert9143d672014-09-27 11:02:39 +00002094 // Restrict the number of parameters involved in the access as the lexmin/
2095 // lexmax computation will take too long if this number is high.
2096 //
2097 // Experiments with a simple test case using an i7 4800MQ:
2098 //
2099 // #Parameters involved | Time (in sec)
2100 // 6 | 0.01
2101 // 7 | 0.04
2102 // 8 | 0.12
2103 // 9 | 0.40
2104 // 10 | 1.54
2105 // 11 | 6.78
2106 // 12 | 30.38
2107 //
2108 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
2109 unsigned InvolvedParams = 0;
2110 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
2111 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
2112 InvolvedParams++;
2113
2114 if (InvolvedParams > RunTimeChecksMaxParameters) {
2115 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002116 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002117 }
2118 }
2119
Johannes Doerfertb164c792014-09-18 11:17:17 +00002120 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2121 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2122
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002123 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2124 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2125
Johannes Doerfertb164c792014-09-18 11:17:17 +00002126 // Adjust the last dimension of the maximal access by one as we want to
2127 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2128 // we test during code generation might now point after the end of the
2129 // allocated array but we will never dereference it anyway.
2130 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2131 "Assumed at least one output dimension");
2132 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2133 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2134 OneAff = isl_aff_zero_on_domain(
2135 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2136 OneAff = isl_aff_add_constant_si(OneAff, 1);
2137 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2138 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2139
2140 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2141
2142 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002143 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002144}
2145
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002146static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2147 isl_set *Domain = MA->getStatement()->getDomain();
2148 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2149 return isl_set_reset_tuple_id(Domain);
2150}
2151
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002152/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2153static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002154 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002155 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002156
2157 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2158 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002159 Locations = isl_union_set_coalesce(Locations);
2160 Locations = isl_union_set_detect_equalities(Locations);
2161 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002162 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002163 isl_union_set_free(Locations);
2164 return Valid;
2165}
2166
Johannes Doerfert96425c22015-08-30 21:13:53 +00002167/// @brief Helper to treat non-affine regions and basic blocks the same.
2168///
2169///{
2170
2171/// @brief Return the block that is the representing block for @p RN.
2172static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2173 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2174 : RN->getNodeAs<BasicBlock>();
2175}
2176
2177/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002178static inline BasicBlock *
2179getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002180 if (RN->isSubRegion()) {
2181 assert(idx == 0);
2182 return RN->getNodeAs<Region>()->getExit();
2183 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002184 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002185}
2186
2187/// @brief Return the smallest loop surrounding @p RN.
2188static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2189 if (!RN->isSubRegion())
2190 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2191
2192 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2193 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2194 while (L && NonAffineSubRegion->contains(L))
2195 L = L->getParentLoop();
2196 return L;
2197}
2198
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002199static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2200 if (!RN->isSubRegion())
2201 return 1;
2202
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002203 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002204 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002205}
2206
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002207static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2208 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002209 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002210 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002211 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002212 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002213 return true;
2214 return false;
2215}
2216
Johannes Doerfert96425c22015-08-30 21:13:53 +00002217///}
2218
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002219static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2220 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002221 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002222 isl_id *DimId =
2223 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2224 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2225}
2226
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002227__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002228 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002229}
2230
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002231__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002232 auto DIt = DomainMap.find(BB);
2233 if (DIt != DomainMap.end())
2234 return isl_set_copy(DIt->getSecond());
2235
2236 auto &RI = *R.getRegionInfo();
2237 auto *BBR = RI.getRegionFor(BB);
2238 while (BBR->getEntry() == BB)
2239 BBR = BBR->getParent();
2240 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002241}
2242
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002243bool Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002244 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002245
Johannes Doerfert432658d2016-01-26 11:01:41 +00002246 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002247 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002248 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2249 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002250 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002251
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002252 while (LD-- >= 0) {
2253 S = addDomainDimId(S, LD + 1, L);
2254 L = L->getParentLoop();
2255 }
2256
Johannes Doerferta3519512016-04-23 13:02:23 +00002257 // Initialize the invalid domain.
2258 auto *EntryStmt = getStmtFor(EntryBB);
2259 EntryStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(S)));
2260
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002261 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002262
Johannes Doerfert432658d2016-01-26 11:01:41 +00002263 if (IsOnlyNonAffineRegion)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002264 return true;
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002265
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002266 if (!buildDomainsWithBranchConstraints(R, SD, DT, LI))
2267 return false;
2268
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002269 propagateDomainConstraints(R, SD, DT, LI);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002270
2271 // Error blocks and blocks dominated by them have been assumed to never be
2272 // executed. Representing them in the Scop does not add any value. In fact,
2273 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002274 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002275 // will cause problems when building up a ScopStmt for them.
2276 // Furthermore, basic blocks dominated by error blocks may reference
2277 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002278 // can themselves not be constructed properly. To this end we will replace
2279 // the domains of error blocks and those only reachable via error blocks
2280 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002281 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002282 // InvalidDomain. This information is needed during load hoisting.
2283 propagateInvalidStmtDomains(R, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002284
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002285 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002286}
2287
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002288static Loop *
2289getFirstNonBoxedLoopFor(BasicBlock *BB, LoopInfo &LI,
2290 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
2291 auto *L = LI.getLoopFor(BB);
2292 while (BoxedLoops.count(L))
2293 L = L->getParentLoop();
2294 return L;
2295}
2296
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002297/// @brief Adjust the dimensions of @p Dom that was constructed for @p OldL
2298/// to be compatible to domains constructed for loop @p NewL.
2299///
2300/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2301/// edge from @p OldL to @p NewL.
2302static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2303 __isl_take isl_set *Dom,
2304 Loop *OldL, Loop *NewL) {
2305
2306 // If the loops are the same there is nothing to do.
2307 if (NewL == OldL)
2308 return Dom;
2309
2310 int OldDepth = S.getRelativeLoopDepth(OldL);
2311 int NewDepth = S.getRelativeLoopDepth(NewL);
2312 // If both loops are non-affine loops there is nothing to do.
2313 if (OldDepth == -1 && NewDepth == -1)
2314 return Dom;
2315
2316 // Distinguish three cases:
2317 // 1) The depth is the same but the loops are not.
2318 // => One loop was left one was entered.
2319 // 2) The depth increased from OldL to NewL.
2320 // => One loop was entered, none was left.
2321 // 3) The depth decreased from OldL to NewL.
2322 // => Loops were left were difference of the depths defines how many.
2323 if (OldDepth == NewDepth) {
2324 assert(OldL->getParentLoop() == NewL->getParentLoop());
2325 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2326 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2327 Dom = addDomainDimId(Dom, NewDepth, NewL);
2328 } else if (OldDepth < NewDepth) {
2329 assert(OldDepth + 1 == NewDepth);
2330 auto &R = S.getRegion();
2331 (void)R;
2332 assert(NewL->getParentLoop() == OldL ||
2333 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2334 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2335 Dom = addDomainDimId(Dom, NewDepth, NewL);
2336 } else {
2337 assert(OldDepth > NewDepth);
2338 int Diff = OldDepth - NewDepth;
2339 int NumDim = isl_set_n_dim(Dom);
2340 assert(NumDim >= Diff);
2341 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2342 }
2343
2344 return Dom;
2345}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002346
Johannes Doerferta3519512016-04-23 13:02:23 +00002347void Scop::propagateInvalidStmtDomains(Region *R, ScopDetection &SD,
2348 DominatorTree &DT, LoopInfo &LI) {
2349 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002350
2351 ReversePostOrderTraversal<Region *> RTraversal(R);
2352 for (auto *RN : RTraversal) {
2353
2354 // Recurse for affine subregions but go on for basic blocks and non-affine
2355 // subregions.
2356 if (RN->isSubRegion()) {
2357 Region *SubRegion = RN->getNodeAs<Region>();
2358 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerferta3519512016-04-23 13:02:23 +00002359 propagateInvalidStmtDomains(SubRegion, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002360 continue;
2361 }
2362 }
2363
2364 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2365 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002366 ScopStmt *Stmt = getStmtFor(BB);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002367 isl_set *&Domain = DomainMap[BB];
2368 assert(Domain && "Cannot propagate a nullptr");
2369
Johannes Doerferta3519512016-04-23 13:02:23 +00002370 auto *InvalidDomain = Stmt->getInvalidDomain();
Johannes Doerfert7c013572016-04-12 09:57:34 +00002371 bool IsInvalidBlock =
Johannes Doerferta3519512016-04-23 13:02:23 +00002372 ContainsErrorBlock || isl_set_is_subset(Domain, InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002373
Johannes Doerferta3519512016-04-23 13:02:23 +00002374 if (!IsInvalidBlock) {
2375 InvalidDomain = isl_set_intersect(InvalidDomain, isl_set_copy(Domain));
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002376 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002377 isl_set_free(InvalidDomain);
2378 InvalidDomain = Domain;
2379 auto *EmptyDom = isl_set_empty(isl_set_get_space(InvalidDomain));
2380 Domain = EmptyDom;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002381 }
2382
Johannes Doerferta3519512016-04-23 13:02:23 +00002383 if (isl_set_is_empty(InvalidDomain)) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00002384 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002385 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002386 }
2387
Johannes Doerferta3519512016-04-23 13:02:23 +00002388 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002389 auto *TI = BB->getTerminator();
2390 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2391 for (unsigned u = 0; u < NumSuccs; u++) {
2392 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002393 auto *SuccStmt = getStmtFor(SuccBB);
2394
2395 // Skip successors outside the SCoP.
2396 if (!SuccStmt)
2397 continue;
2398
Johannes Doerferte4459a22016-04-25 13:34:50 +00002399 // Skip backedges.
2400 if (DT.dominates(SuccBB, BB))
2401 continue;
2402
Johannes Doerferta3519512016-04-23 13:02:23 +00002403 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
2404 auto *AdjustedInvalidDomain = adjustDomainDimensions(
2405 *this, isl_set_copy(InvalidDomain), BBLoop, SuccBBLoop);
2406 auto *SuccInvalidDomain = SuccStmt->getInvalidDomain();
2407 SuccInvalidDomain =
2408 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2409 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2410 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
2411 SuccStmt->setInvalidDomain(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002412
2413 // Check if the maximal number of domain conjuncts was reached.
2414 // In case this happens we will bail.
Johannes Doerfert7c013572016-04-12 09:57:34 +00002415 if (NumConjucts < MaxConjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002416 continue;
2417
Johannes Doerferta3519512016-04-23 13:02:23 +00002418 isl_set_free(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002419 invalidate(COMPLEXITY, TI->getDebugLoc());
2420 return;
2421 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002422
2423 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002424 }
2425}
2426
Johannes Doerfert642594a2016-04-04 07:57:39 +00002427void Scop::propagateDomainConstraintsToRegionExit(
2428 BasicBlock *BB, Loop *BBLoop,
2429 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, ScopDetection &SD,
2430 LoopInfo &LI) {
2431
2432 // Check if the block @p BB is the entry of a region. If so we propagate it's
2433 // domain to the exit block of the region. Otherwise we are done.
2434 auto *RI = R.getRegionInfo();
2435 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2436 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
2437 if (!BBReg || BBReg->getEntry() != BB || !R.contains(ExitBB))
2438 return;
2439
2440 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2441 // Do not propagate the domain if there is a loop backedge inside the region
2442 // that would prevent the exit block from beeing executed.
2443 auto *L = BBLoop;
2444 while (L && R.contains(L)) {
2445 SmallVector<BasicBlock *, 4> LatchBBs;
2446 BBLoop->getLoopLatches(LatchBBs);
2447 for (auto *LatchBB : LatchBBs)
2448 if (BB != LatchBB && BBReg->contains(LatchBB))
2449 return;
2450 L = L->getParentLoop();
2451 }
2452
2453 auto *Domain = DomainMap[BB];
2454 assert(Domain && "Cannot propagate a nullptr");
2455
2456 auto *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, BoxedLoops);
2457
2458 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2459 // adjust the domain before we can propagate it.
2460 auto *AdjustedDomain =
2461 adjustDomainDimensions(*this, isl_set_copy(Domain), BBLoop, ExitBBLoop);
2462 auto *&ExitDomain = DomainMap[ExitBB];
2463
2464 // If the exit domain is not yet created we set it otherwise we "add" the
2465 // current domain.
2466 ExitDomain =
2467 ExitDomain ? isl_set_union(AdjustedDomain, ExitDomain) : AdjustedDomain;
2468
Johannes Doerferta3519512016-04-23 13:02:23 +00002469 // Initialize the invalid domain.
2470 auto *ExitStmt = getStmtFor(ExitBB);
2471 ExitStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(ExitDomain)));
2472
Johannes Doerfert642594a2016-04-04 07:57:39 +00002473 FinishedExitBlocks.insert(ExitBB);
2474}
2475
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002476bool Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002477 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002478 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002479
2480 // To create the domain for each block in R we iterate over all blocks and
2481 // subregions in R and propagate the conditions under which the current region
2482 // element is executed. To this end we iterate in reverse post order over R as
2483 // it ensures that we first visit all predecessors of a region node (either a
2484 // basic block or a subregion) before we visit the region node itself.
2485 // Initially, only the domain for the SCoP region entry block is set and from
2486 // there we propagate the current domain to all successors, however we add the
2487 // condition that the successor is actually executed next.
2488 // As we are only interested in non-loop carried constraints here we can
2489 // simply skip loop back edges.
2490
Johannes Doerfert642594a2016-04-04 07:57:39 +00002491 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002492 ReversePostOrderTraversal<Region *> RTraversal(R);
2493 for (auto *RN : RTraversal) {
2494
2495 // Recurse for affine subregions but go on for basic blocks and non-affine
2496 // subregions.
2497 if (RN->isSubRegion()) {
2498 Region *SubRegion = RN->getNodeAs<Region>();
2499 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002500 if (!buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI))
2501 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002502 continue;
2503 }
2504 }
2505
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002506 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002507 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002508
Johannes Doerfert96425c22015-08-30 21:13:53 +00002509 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002510 TerminatorInst *TI = BB->getTerminator();
2511
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002512 if (isa<UnreachableInst>(TI))
2513 continue;
2514
Johannes Doerfertf5673802015-10-01 23:48:18 +00002515 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002516 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002517 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002518
Johannes Doerfert642594a2016-04-04 07:57:39 +00002519 auto *BBLoop = getRegionNodeLoop(RN, LI);
2520 // Propagate the domain from BB directly to blocks that have a superset
2521 // domain, at the moment only region exit nodes of regions that start in BB.
2522 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, SD,
2523 LI);
2524
2525 // If all successors of BB have been set a domain through the propagation
2526 // above we do not need to build condition sets but can just skip this
2527 // block. However, it is important to note that this is a local property
2528 // with regards to the region @p R. To this end FinishedExitBlocks is a
2529 // local variable.
2530 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2531 return FinishedExitBlocks.count(SuccBB);
2532 };
2533 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2534 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002535
2536 // Build the condition sets for the successor nodes of the current region
2537 // node. If it is a non-affine subregion we will always execute the single
2538 // exit node, hence the single entry node domain is the condition set. For
2539 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002540 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002541 if (RN->isSubRegion())
2542 ConditionSets.push_back(isl_set_copy(Domain));
2543 else
Johannes Doerfert171b92f2016-04-19 14:53:13 +00002544 buildConditionSets(*getStmtFor(BB), TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002545
2546 // Now iterate over the successors and set their initial domain based on
2547 // their condition set. We skip back edges here and have to be careful when
2548 // we leave a loop not to keep constraints over a dimension that doesn't
2549 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002550 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002551 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002552 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002553 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002554
Johannes Doerfert535de032016-04-19 14:49:05 +00002555 auto *SuccStmt = getStmtFor(SuccBB);
2556 // Skip blocks outside the region.
2557 if (!SuccStmt) {
2558 isl_set_free(CondSet);
2559 continue;
2560 }
2561
Johannes Doerfert642594a2016-04-04 07:57:39 +00002562 // If we propagate the domain of some block to "SuccBB" we do not have to
2563 // adjust the domain.
2564 if (FinishedExitBlocks.count(SuccBB)) {
2565 isl_set_free(CondSet);
2566 continue;
2567 }
2568
Johannes Doerfert96425c22015-08-30 21:13:53 +00002569 // Skip back edges.
2570 if (DT.dominates(SuccBB, BB)) {
2571 isl_set_free(CondSet);
2572 continue;
2573 }
2574
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002575 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002576 CondSet = adjustDomainDimensions(*this, CondSet, BBLoop, SuccBBLoop);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002577
2578 // Set the domain for the successor or merge it with an existing domain in
2579 // case there are multiple paths (without loop back edges) to the
2580 // successor block.
2581 isl_set *&SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002582
Johannes Doerferta3519512016-04-23 13:02:23 +00002583 if (SuccDomain) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002584 SuccDomain = isl_set_coalesce(isl_set_union(SuccDomain, CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00002585 } else {
2586 // Initialize the invalid domain.
2587 SuccStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(CondSet)));
2588 SuccDomain = CondSet;
2589 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002590
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002591 // Check if the maximal number of domain conjuncts was reached.
2592 // In case this happens we will clean up and bail.
Johannes Doerfert15194912016-04-04 07:59:41 +00002593 if (isl_set_n_basic_set(SuccDomain) < MaxConjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002594 continue;
2595
2596 invalidate(COMPLEXITY, DebugLoc());
2597 while (++u < ConditionSets.size())
2598 isl_set_free(ConditionSets[u]);
2599 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002600 }
2601 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002602
2603 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002604}
2605
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00002606__isl_give isl_set *Scop::getPredecessorDomainConstraints(BasicBlock *BB,
2607 isl_set *Domain,
2608 ScopDetection &SD,
2609 DominatorTree &DT,
2610 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002611 // If @p BB is the ScopEntry we are done
2612 if (R.getEntry() == BB)
2613 return isl_set_universe(isl_set_get_space(Domain));
2614
2615 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2616 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2617
2618 // The region info of this function.
2619 auto &RI = *R.getRegionInfo();
2620
2621 auto *BBLoop = getFirstNonBoxedLoopFor(BB, LI, BoxedLoops);
2622
2623 // A domain to collect all predecessor domains, thus all conditions under
2624 // which the block is executed. To this end we start with the empty domain.
2625 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2626
2627 // Set of regions of which the entry block domain has been propagated to BB.
2628 // all predecessors inside any of the regions can be skipped.
2629 SmallSet<Region *, 8> PropagatedRegions;
2630
2631 for (auto *PredBB : predecessors(BB)) {
2632 // Skip backedges.
2633 if (DT.dominates(BB, PredBB))
2634 continue;
2635
2636 // If the predecessor is in a region we used for propagation we can skip it.
2637 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2638 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2639 PredBBInRegion)) {
2640 continue;
2641 }
2642
2643 // Check if there is a valid region we can use for propagation, thus look
2644 // for a region that contains the predecessor and has @p BB as exit block.
2645 auto *PredR = RI.getRegionFor(PredBB);
2646 while (PredR->getExit() != BB && !PredR->contains(BB))
2647 PredR->getParent();
2648
2649 // If a valid region for propagation was found use the entry of that region
2650 // for propagation, otherwise the PredBB directly.
2651 if (PredR->getExit() == BB) {
2652 PredBB = PredR->getEntry();
2653 PropagatedRegions.insert(PredR);
2654 }
2655
Johannes Doerfert41cda152016-04-08 10:32:26 +00002656 auto *PredBBDom = getDomainConditions(PredBB);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002657 auto *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, BoxedLoops);
2658 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2659
2660 PredDom = isl_set_union(PredDom, PredBBDom);
2661 }
2662
2663 return PredDom;
2664}
2665
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002666void Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002667 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002668 // Iterate over the region R and propagate the domain constrains from the
2669 // predecessors to the current node. In contrast to the
2670 // buildDomainsWithBranchConstraints function, this one will pull the domain
2671 // information from the predecessors instead of pushing it to the successors.
2672 // Additionally, we assume the domains to be already present in the domain
2673 // map here. However, we iterate again in reverse post order so we know all
2674 // predecessors have been visited before a block or non-affine subregion is
2675 // visited.
2676
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002677 ReversePostOrderTraversal<Region *> RTraversal(R);
2678 for (auto *RN : RTraversal) {
2679
2680 // Recurse for affine subregions but go on for basic blocks and non-affine
2681 // subregions.
2682 if (RN->isSubRegion()) {
2683 Region *SubRegion = RN->getNodeAs<Region>();
2684 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002685 propagateDomainConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002686 continue;
2687 }
2688 }
2689
2690 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002691 isl_set *&Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002692 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002693
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002694 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002695 auto *PredDom = getPredecessorDomainConstraints(BB, Domain, SD, DT, LI);
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002696 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002697 Domain = isl_set_align_params(Domain, getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002698
Johannes Doerfert642594a2016-04-04 07:57:39 +00002699 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002700 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002701 addLoopBoundsToHeaderDomain(BBLoop, LI);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002702
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002703 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002704 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002705 IsOptimized = true;
2706 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002707 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2708 AS_RESTRICTION);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002709 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002710 }
2711}
2712
2713/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2714/// is incremented by one and all other dimensions are equal, e.g.,
2715/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2716/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2717static __isl_give isl_map *
2718createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2719 auto *MapSpace = isl_space_map_from_set(SetSpace);
2720 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2721 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2722 if (u != Dim)
2723 NextIterationMap =
2724 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2725 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2726 C = isl_constraint_set_constant_si(C, 1);
2727 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2728 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2729 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2730 return NextIterationMap;
2731}
2732
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002733void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002734 int LoopDepth = getRelativeLoopDepth(L);
2735 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002736
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002737 BasicBlock *HeaderBB = L->getHeader();
2738 assert(DomainMap.count(HeaderBB));
2739 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002740
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002741 isl_map *NextIterationMap =
2742 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002743
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002744 isl_set *UnionBackedgeCondition =
2745 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002746
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002747 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2748 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002749
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002750 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002751
2752 // If the latch is only reachable via error statements we skip it.
2753 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2754 if (!LatchBBDom)
2755 continue;
2756
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002757 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002758
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002759 TerminatorInst *TI = LatchBB->getTerminator();
2760 BranchInst *BI = dyn_cast<BranchInst>(TI);
2761 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002762 BackedgeCondition = isl_set_copy(LatchBBDom);
2763 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002764 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002765 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00002766 buildConditionSets(*getStmtFor(LatchBB), TI, L, LatchBBDom,
2767 ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002768
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002769 // Free the non back edge condition set as we do not need it.
2770 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002771
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002772 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002773 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002774
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002775 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2776 assert(LatchLoopDepth >= LoopDepth);
2777 BackedgeCondition =
2778 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2779 LatchLoopDepth - LoopDepth);
2780 UnionBackedgeCondition =
2781 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002782 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002783
2784 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2785 for (int i = 0; i < LoopDepth; i++)
2786 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2787
2788 isl_set *UnionBackedgeConditionComplement =
2789 isl_set_complement(UnionBackedgeCondition);
2790 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2791 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2792 UnionBackedgeConditionComplement =
2793 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2794 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2795 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2796
2797 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2798 HeaderBBDom = Parts.second;
2799
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002800 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2801 // the bounded assumptions to the context as they are already implied by the
2802 // <nsw> tag.
2803 if (Affinator.hasNSWAddRecForLoop(L)) {
2804 isl_set_free(Parts.first);
2805 return;
2806 }
2807
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002808 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002809 recordAssumption(INFINITELOOP, UnboundedCtx,
2810 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002811}
2812
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002813void Scop::buildAliasChecks(AliasAnalysis &AA) {
2814 if (!PollyUseRuntimeAliasChecks)
2815 return;
2816
2817 if (buildAliasGroups(AA))
2818 return;
2819
2820 // If a problem occurs while building the alias groups we need to delete
2821 // this SCoP and pretend it wasn't valid in the first place. To this end
2822 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002823 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002824
2825 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2826 << " could not be created as the number of parameters involved "
2827 "is too high. The SCoP will be "
2828 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2829 "the maximal number of parameters but be advised that the "
2830 "compile time might increase exponentially.\n\n");
2831}
2832
Johannes Doerfert9143d672014-09-27 11:02:39 +00002833bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002834 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002835 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002836 // for all memory accesses inside the SCoP.
2837 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002838 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002839 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002840 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002841 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002842 // if their access domains intersect, otherwise they are in different
2843 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002844 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002845 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002846 // and maximal accesses to each array of a group in read only and non
2847 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002848 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2849
2850 AliasSetTracker AST(AA);
2851
2852 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002853 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002854 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002855
2856 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002857 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002858 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2859 isl_set_free(StmtDomain);
2860 if (StmtDomainEmpty)
2861 continue;
2862
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002863 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002864 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002865 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002866 if (!MA->isRead())
2867 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002868 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00002869 if (MA->isRead() && isa<MemTransferInst>(Acc))
2870 PtrToAcc[cast<MemTransferInst>(Acc)->getSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00002871 else
2872 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002873 AST.add(Acc);
2874 }
2875 }
2876
2877 SmallVector<AliasGroupTy, 4> AliasGroups;
2878 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002879 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002880 continue;
2881 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002882 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002883 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002884 if (AG.size() < 2)
2885 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002886 AliasGroups.push_back(std::move(AG));
2887 }
2888
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002889 // Split the alias groups based on their domain.
2890 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2891 AliasGroupTy NewAG;
2892 AliasGroupTy &AG = AliasGroups[u];
2893 AliasGroupTy::iterator AGI = AG.begin();
2894 isl_set *AGDomain = getAccessDomain(*AGI);
2895 while (AGI != AG.end()) {
2896 MemoryAccess *MA = *AGI;
2897 isl_set *MADomain = getAccessDomain(MA);
2898 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2899 NewAG.push_back(MA);
2900 AGI = AG.erase(AGI);
2901 isl_set_free(MADomain);
2902 } else {
2903 AGDomain = isl_set_union(AGDomain, MADomain);
2904 AGI++;
2905 }
2906 }
2907 if (NewAG.size() > 1)
2908 AliasGroups.push_back(std::move(NewAG));
2909 isl_set_free(AGDomain);
2910 }
2911
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002912 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002913 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002914 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2915 for (AliasGroupTy &AG : AliasGroups) {
2916 NonReadOnlyBaseValues.clear();
2917 ReadOnlyPairs.clear();
2918
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002919 if (AG.size() < 2) {
2920 AG.clear();
2921 continue;
2922 }
2923
Johannes Doerfert13771732014-10-01 12:40:46 +00002924 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002925 emitOptimizationRemarkAnalysis(
2926 F.getContext(), DEBUG_TYPE, F,
2927 (*II)->getAccessInstruction()->getDebugLoc(),
2928 "Possibly aliasing pointer, use restrict keyword.");
2929
Johannes Doerfert13771732014-10-01 12:40:46 +00002930 Value *BaseAddr = (*II)->getBaseAddr();
2931 if (HasWriteAccess.count(BaseAddr)) {
2932 NonReadOnlyBaseValues.insert(BaseAddr);
2933 II++;
2934 } else {
2935 ReadOnlyPairs[BaseAddr].insert(*II);
2936 II = AG.erase(II);
2937 }
2938 }
2939
2940 // If we don't have read only pointers check if there are at least two
2941 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002942 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002943 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002944 continue;
2945 }
2946
2947 // If we don't have non read only pointers clear the alias group.
2948 if (NonReadOnlyBaseValues.empty()) {
2949 AG.clear();
2950 continue;
2951 }
2952
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002953 // Check if we have non-affine accesses left, if so bail out as we cannot
2954 // generate a good access range yet.
2955 for (auto *MA : AG)
2956 if (!MA->isAffine()) {
2957 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2958 return false;
2959 }
2960 for (auto &ReadOnlyPair : ReadOnlyPairs)
2961 for (auto *MA : ReadOnlyPair.second)
2962 if (!MA->isAffine()) {
2963 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2964 return false;
2965 }
2966
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002967 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002968 MinMaxAliasGroups.emplace_back();
2969 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2970 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2971 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2972 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002973
2974 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002975
2976 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002977 for (MemoryAccess *MA : AG)
2978 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002979
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002980 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2981 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002982
2983 // Bail out if the number of values we need to compare is too large.
2984 // This is important as the number of comparisions grows quadratically with
2985 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002986 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2987 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002988 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002989
2990 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002991 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002992 Accesses = isl_union_map_empty(getParamSpace());
2993
2994 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2995 for (MemoryAccess *MA : ReadOnlyPair.second)
2996 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2997
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002998 Valid =
2999 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00003000
3001 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003002 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003003 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003004
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003005 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003006}
3007
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003008/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003009static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003010 // Start with the smallest loop containing the entry and expand that
3011 // loop until it contains all blocks in the region. If there is a loop
3012 // containing all blocks in the region check if it is itself contained
3013 // and if so take the parent loop as it will be the smallest containing
3014 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003015 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003016 while (L) {
3017 bool AllContained = true;
3018 for (auto *BB : R.blocks())
3019 AllContained &= L->contains(BB);
3020 if (AllContained)
3021 break;
3022 L = L->getParentLoop();
3023 }
3024
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003025 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
3026}
3027
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003028static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
3029 ScopDetection &SD) {
3030
3031 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
3032
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003033 unsigned MinLD = INT_MAX, MaxLD = 0;
3034 for (BasicBlock *BB : R.blocks()) {
3035 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00003036 if (!R.contains(L))
3037 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003038 if (BoxedLoops && BoxedLoops->count(L))
3039 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003040 unsigned LD = L->getLoopDepth();
3041 MinLD = std::min(MinLD, LD);
3042 MaxLD = std::max(MaxLD, LD);
3043 }
3044 }
3045
3046 // Handle the case that there is no loop in the SCoP first.
3047 if (MaxLD == 0)
3048 return 1;
3049
3050 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
3051 assert(MaxLD >= MinLD &&
3052 "Maximal loop depth was smaller than mininaml loop depth?");
3053 return MaxLD - MinLD + 1;
3054}
3055
Michael Kruse09eb4452016-03-03 22:10:47 +00003056Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
3057 unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00003058 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003059 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003060 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
3061 Context(nullptr), Affinator(this, LI), AssumedContext(nullptr),
3062 InvalidContext(nullptr), Schedule(nullptr) {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003063 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003064 buildContext();
3065}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003066
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00003067void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003068 DominatorTree &DT, LoopInfo &LI) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003069 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003070
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003071 if (!buildDomains(&R, SD, DT, LI))
3072 return;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003073
Johannes Doerfertff68f462016-04-19 14:49:42 +00003074 addUserAssumptions(AC, DT, LI);
3075
Michael Krusecac948e2015-10-02 13:53:07 +00003076 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00003077 // Exit early in case there are no executable statements left in this scop.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003078 simplifySCoP(true, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00003079 if (Stmts.empty())
3080 return;
Tobias Grosser75805372011-04-29 06:27:02 +00003081
Michael Krusecac948e2015-10-02 13:53:07 +00003082 // The ScopStmts now have enough information to initialize themselves.
3083 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003084 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00003085
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003086 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003087
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003088 if (!hasFeasibleRuntimeContext())
Tobias Grosser8286b832015-11-02 11:29:32 +00003089 return;
3090
3091 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00003092 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00003093 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00003094 addUserContext();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003095
3096 // After the context was fully constructed, thus all our knowledge about
3097 // the parameters is in there, we add all recorded assumptions to the
3098 // assumed/invalid context.
3099 addRecordedAssumptions();
3100
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003101 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003102 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003103
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003104 hoistInvariantLoads(SD);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003105 verifyInvariantLoads(SD);
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003106 simplifySCoP(false, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003107}
3108
3109Scop::~Scop() {
3110 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003111 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003112 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003113 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003114
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003115 for (auto &It : ParameterIds)
3116 isl_id_free(It.second);
3117
Johannes Doerfert96425c22015-08-30 21:13:53 +00003118 for (auto It : DomainMap)
3119 isl_set_free(It.second);
3120
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003121 for (auto &AS : RecordedAssumptions)
3122 isl_set_free(AS.Set);
3123
Johannes Doerfertb164c792014-09-18 11:17:17 +00003124 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003125 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003126 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003127 isl_pw_multi_aff_free(MMA.first);
3128 isl_pw_multi_aff_free(MMA.second);
3129 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003130 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003131 isl_pw_multi_aff_free(MMA.first);
3132 isl_pw_multi_aff_free(MMA.second);
3133 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003134 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003135
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003136 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003137 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003138
3139 // Explicitly release all Scop objects and the underlying isl objects before
3140 // we relase the isl context.
3141 Stmts.clear();
3142 ScopArrayInfoMap.clear();
3143 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003144}
3145
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003146void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003147 // Check all array accesses for each base pointer and find a (virtual) element
3148 // size for the base pointer that divides all access functions.
3149 for (auto &Stmt : *this)
3150 for (auto *Access : Stmt) {
3151 if (!Access->isArrayKind())
3152 continue;
3153 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
3154 ScopArrayInfo::MK_Array)];
3155 if (SAI->getNumberOfDimensions() != 1)
3156 continue;
3157 unsigned DivisibleSize = SAI->getElemSizeInBytes();
3158 auto *Subscript = Access->getSubscript(0);
3159 while (!isDivisible(Subscript, DivisibleSize, *SE))
3160 DivisibleSize /= 2;
3161 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
3162 SAI->updateElementType(Ty);
3163 }
3164
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003165 for (auto &Stmt : *this)
3166 for (auto &Access : Stmt)
3167 Access->updateDimensionality();
3168}
3169
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003170void Scop::simplifySCoP(bool RemoveIgnoredStmts, DominatorTree &DT,
3171 LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003172 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3173 ScopStmt &Stmt = *StmtIt;
Michael Kruse7b5caa42016-02-24 22:08:28 +00003174 RegionNode *RN = Stmt.getRegionNode();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003175
Johannes Doerferteca9e892015-11-03 16:54:49 +00003176 bool RemoveStmt = StmtIt->isEmpty();
3177 if (!RemoveStmt)
Michael Kruse375cb5f2016-02-24 22:08:24 +00003178 RemoveStmt = isl_set_is_empty(DomainMap[Stmt.getEntryBlock()]);
Johannes Doerferteca9e892015-11-03 16:54:49 +00003179 if (!RemoveStmt)
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003180 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN, DT, LI));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003181
Johannes Doerferteca9e892015-11-03 16:54:49 +00003182 // Remove read only statements only after invariant loop hoisting.
3183 if (!RemoveStmt && !RemoveIgnoredStmts) {
3184 bool OnlyRead = true;
3185 for (MemoryAccess *MA : Stmt) {
3186 if (MA->isRead())
3187 continue;
3188
3189 OnlyRead = false;
3190 break;
3191 }
3192
3193 RemoveStmt = OnlyRead;
3194 }
3195
3196 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00003197 // Remove the statement because it is unnecessary.
3198 if (Stmt.isRegionStmt())
3199 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3200 StmtMap.erase(BB);
3201 else
3202 StmtMap.erase(Stmt.getBasicBlock());
3203
3204 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003205 continue;
3206 }
3207
Michael Krusecac948e2015-10-02 13:53:07 +00003208 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003209 }
3210}
3211
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003212const InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) const {
3213 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3214 if (!LInst)
3215 return nullptr;
3216
3217 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3218 LInst = cast<LoadInst>(Rep);
3219
Johannes Doerfert96e54712016-02-07 17:30:13 +00003220 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003221 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003222 for (auto &IAClass : InvariantEquivClasses) {
3223 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
3224 continue;
3225
3226 auto &MAs = std::get<1>(IAClass);
3227 for (auto *MA : MAs)
3228 if (MA->getAccessInstruction() == Val)
3229 return &IAClass;
3230 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003231
3232 return nullptr;
3233}
3234
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003235/// @brief Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003236static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3237 bool MAInvalidCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003238 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3239 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3240 // TODO: We can provide more information for better but more expensive
3241 // results.
3242 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3243 LInst->getAlignment(), DL))
3244 return false;
3245
3246 // If a dereferencable load is in a statement that is modeled precisely we can
3247 // hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003248 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003249 return true;
3250
3251 // Even if the statement is not modeled precisely we can hoist the load if it
3252 // does not involve any parameters that might have been specilized by the
3253 // statement domain.
3254 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3255 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3256 return false;
3257 return true;
3258}
3259
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003260void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
3261
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003262 if (InvMAs.empty())
3263 return;
3264
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003265 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003266 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003267
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003268 // Get the context under which the statement is executed but remove the error
3269 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003270 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003271 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003272
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003273 if (isl_set_n_basic_set(DomainCtx) >= MaxConjunctsInDomain) {
3274 auto *AccInst = InvMAs.front()->getAccessInstruction();
3275 invalidate(COMPLEXITY, AccInst->getDebugLoc());
3276 isl_set_free(DomainCtx);
3277 return;
3278 }
3279
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003280 // Project out all parameters that relate to loads in the statement. Otherwise
3281 // we could have cyclic dependences on the constraints under which the
3282 // hoisted loads are executed and we could not determine an order in which to
3283 // pre-load them. This happens because not only lower bounds are part of the
3284 // domain but also upper bounds.
3285 for (MemoryAccess *MA : InvMAs) {
3286 Instruction *AccInst = MA->getAccessInstruction();
3287 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003288 SetVector<Value *> Values;
3289 for (const SCEV *Parameter : Parameters) {
3290 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003291 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003292 if (!Values.count(AccInst))
3293 continue;
3294
3295 if (isl_id *ParamId = getIdForParam(Parameter)) {
3296 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
3297 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
3298 isl_id_free(ParamId);
3299 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003300 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003301 }
3302 }
3303
3304 for (MemoryAccess *MA : InvMAs) {
3305 // Check for another invariant access that accesses the same location as
3306 // MA and if found consolidate them. Otherwise create a new equivalence
3307 // class at the end of InvariantEquivClasses.
3308 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003309 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003310 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3311
Johannes Doerfert85676e32016-04-23 14:32:34 +00003312 auto *MAInvalidCtx = MA->getInvalidContext();
3313 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3314
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003315 isl_set *MACtx;
3316 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003317 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003318 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003319 isl_set_free(MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003320 } else {
3321 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003322 MACtx = isl_set_subtract(MACtx, MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003323 MACtx = isl_set_gist_params(MACtx, getContext());
3324 }
3325
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003326 bool Consolidated = false;
3327 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00003328 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003329 continue;
3330
Johannes Doerfertdf880232016-03-03 12:26:58 +00003331 // If the pointer and the type is equal check if the access function wrt.
3332 // to the domain is equal too. It can happen that the domain fixes
3333 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003334 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003335 // create a new invariant load equivalence class.
3336 auto &MAs = std::get<1>(IAClass);
3337 if (!MAs.empty()) {
3338 auto *LastMA = MAs.front();
3339
3340 auto *AR = isl_map_range(MA->getAccessRelation());
3341 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3342 bool SameAR = isl_set_is_equal(AR, LastAR);
3343 isl_set_free(AR);
3344 isl_set_free(LastAR);
3345
3346 if (!SameAR)
3347 continue;
3348 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003349
3350 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003351 MAs.push_front(MA);
3352
Johannes Doerfertdf880232016-03-03 12:26:58 +00003353 Consolidated = true;
3354
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003355 // Unify the execution context of the class and this statement.
3356 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003357 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003358 IAClassDomainCtx =
3359 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003360 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003361 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003362 break;
3363 }
3364
3365 if (Consolidated)
3366 continue;
3367
3368 // If we did not consolidate MA, thus did not find an equivalence class
3369 // for it, we create a new one.
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003370 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA}, MACtx,
3371 Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003372 }
3373
3374 isl_set_free(DomainCtx);
3375}
3376
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003377bool Scop::isHoistableAccess(MemoryAccess *Access,
3378 __isl_keep isl_union_map *Writes) {
3379 // TODO: Loads that are not loop carried, hence are in a statement with
3380 // zero iterators, are by construction invariant, though we
3381 // currently "hoist" them anyway. This is necessary because we allow
3382 // them to be treated as parameters (e.g., in conditions) and our code
3383 // generation would otherwise use the old value.
3384
3385 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003386 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003387
3388 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3389 return false;
3390
3391 // Skip accesses that have an invariant base pointer which is defined but
3392 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3393 // returns a pointer that is used as a base address. However, as we want
3394 // to hoist indirect pointers, we allow the base pointer to be defined in
3395 // the region if it is also a memory access. Each ScopArrayInfo object
3396 // that has a base pointer origin has a base pointer that is loaded and
3397 // that it is invariant, thus it will be hoisted too. However, if there is
3398 // no base pointer origin we check that the base pointer is defined
3399 // outside the region.
3400 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003401 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3402 if (SAI->getBasePtrOriginSAI()) {
3403 assert(BasePtrInst && R.contains(BasePtrInst));
3404 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003405 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003406 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003407 assert(BasePtrStmt);
3408 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3409 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3410 return false;
3411 } else if (BasePtrInst && R.contains(BasePtrInst))
3412 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003413
3414 // Skip accesses in non-affine subregions as they might not be executed
3415 // under the same condition as the entry of the non-affine subregion.
3416 if (BB != Access->getAccessInstruction()->getParent())
3417 return false;
3418
3419 isl_map *AccessRelation = Access->getAccessRelation();
Johannes Doerfert2b470e82016-03-24 13:19:16 +00003420 assert(!isl_map_is_empty(AccessRelation));
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003421
3422 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3423 Stmt.getNumIterators())) {
3424 isl_map_free(AccessRelation);
3425 return false;
3426 }
3427
3428 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3429 isl_set *AccessRange = isl_map_range(AccessRelation);
3430
3431 isl_union_map *Written = isl_union_map_intersect_range(
3432 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3433 bool IsWritten = !isl_union_map_is_empty(Written);
3434 isl_union_map_free(Written);
3435
3436 if (IsWritten)
3437 return false;
3438
3439 return true;
3440}
3441
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003442void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003443 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3444 for (LoadInst *LI : RIL) {
3445 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003446 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003447 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003448 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3449 return;
3450 }
3451 }
3452}
3453
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003454void Scop::hoistInvariantLoads(ScopDetection &SD) {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003455 if (!PollyInvariantLoadHoisting)
3456 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003457
Tobias Grosser0865e7752016-02-29 07:29:42 +00003458 isl_union_map *Writes = getWrites();
3459 for (ScopStmt &Stmt : *this) {
3460 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003461
Tobias Grosser0865e7752016-02-29 07:29:42 +00003462 for (MemoryAccess *Access : Stmt)
3463 if (isHoistableAccess(Access, Writes))
3464 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003465
Tobias Grosser0865e7752016-02-29 07:29:42 +00003466 // We inserted invariant accesses always in the front but need them to be
3467 // sorted in a "natural order". The statements are already sorted in
3468 // reverse post order and that suffices for the accesses too. The reason
3469 // we require an order in the first place is the dependences between
3470 // invariant loads that can be caused by indirect loads.
3471 InvariantAccesses.reverse();
3472
3473 // Transfer the memory access from the statement to the SCoP.
3474 Stmt.removeMemoryAccesses(InvariantAccesses);
3475 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003476 }
Tobias Grosser0865e7752016-02-29 07:29:42 +00003477 isl_union_map_free(Writes);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003478}
3479
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003480const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003481Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003482 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003483 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003484 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003485 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003486 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003487 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003488 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003489 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003490 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003491 // In case of mismatching array sizes, we bail out by setting the run-time
3492 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003493 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003494 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003495 }
Tobias Grosserab671442015-05-23 05:58:27 +00003496 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003497}
3498
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003499const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003500 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003501 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003502 assert(SAI && "No ScopArrayInfo available for this base pointer");
3503 return SAI;
3504}
3505
Tobias Grosser74394f02013-01-14 22:40:23 +00003506std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003507
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003508std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003509 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003510 return stringFromIslObj(AssumedContext);
3511}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003512
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003513std::string Scop::getInvalidContextStr() const {
3514 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003515}
Tobias Grosser75805372011-04-29 06:27:02 +00003516
3517std::string Scop::getNameStr() const {
3518 std::string ExitName, EntryName;
3519 raw_string_ostream ExitStr(ExitName);
3520 raw_string_ostream EntryStr(EntryName);
3521
Tobias Grosserf240b482014-01-09 10:42:15 +00003522 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003523 EntryStr.str();
3524
3525 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003526 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003527 ExitStr.str();
3528 } else
3529 ExitName = "FunctionExit";
3530
3531 return EntryName + "---" + ExitName;
3532}
3533
Tobias Grosser74394f02013-01-14 22:40:23 +00003534__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003535__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003536 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003537}
3538
Tobias Grossere86109f2013-10-29 21:05:49 +00003539__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003540 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00003541 return isl_set_copy(AssumedContext);
3542}
3543
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003544bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003545 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003546 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00003547 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
3548 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
3549 isl_set_is_subset(PositiveContext, NegativeContext));
3550 isl_set_free(PositiveContext);
3551 if (!IsFeasible) {
3552 isl_set_free(NegativeContext);
3553 return false;
3554 }
3555
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003556 auto *DomainContext = isl_union_set_params(getDomains());
3557 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00003558 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003559 isl_set_free(NegativeContext);
3560 isl_set_free(DomainContext);
3561
Johannes Doerfert43788c52015-08-20 05:58:56 +00003562 return IsFeasible;
3563}
3564
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003565static std::string toString(AssumptionKind Kind) {
3566 switch (Kind) {
3567 case ALIASING:
3568 return "No-aliasing";
3569 case INBOUNDS:
3570 return "Inbounds";
3571 case WRAPPING:
3572 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00003573 case UNSIGNED:
3574 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003575 case COMPLEXITY:
3576 return "Low complexity";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003577 case ERRORBLOCK:
3578 return "No-error";
3579 case INFINITELOOP:
3580 return "Finite loop";
3581 case INVARIANTLOAD:
3582 return "Invariant load";
3583 case DELINEARIZATION:
3584 return "Delinearization";
3585 }
3586 llvm_unreachable("Unknown AssumptionKind!");
3587}
3588
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003589bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3590 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert2f705842016-04-12 16:09:44 +00003591 if (PollyRemarksMinimal) {
3592 if (Sign == AS_ASSUMPTION) {
3593 if (isl_set_is_subset(Context, Set))
3594 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003595
Johannes Doerfert2f705842016-04-12 16:09:44 +00003596 if (isl_set_is_subset(AssumedContext, Set))
3597 return false;
3598 } else {
3599 if (isl_set_is_disjoint(Set, Context))
3600 return false;
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003601
Johannes Doerfert2f705842016-04-12 16:09:44 +00003602 if (isl_set_is_subset(Set, InvalidContext))
3603 return false;
3604 }
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003605 }
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003606
3607 auto &F = *getRegion().getEntry()->getParent();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003608 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
3609 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003610 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003611 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003612}
3613
3614void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003615 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003616 // Simplify the assumptions/restrictions first.
3617 Set = isl_set_gist_params(Set, getContext());
3618
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003619 if (!trackAssumption(Kind, Set, Loc, Sign)) {
3620 isl_set_free(Set);
3621 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003622 }
3623
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003624 if (Sign == AS_ASSUMPTION) {
3625 AssumedContext = isl_set_intersect(AssumedContext, Set);
3626 AssumedContext = isl_set_coalesce(AssumedContext);
3627 } else {
3628 InvalidContext = isl_set_union(InvalidContext, Set);
3629 InvalidContext = isl_set_coalesce(InvalidContext);
3630 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003631}
3632
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003633void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003634 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
3635 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003636}
3637
3638void Scop::addRecordedAssumptions() {
3639 while (!RecordedAssumptions.empty()) {
3640 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003641
3642 isl_set *S = AS.Set;
3643 // If a basic block was given use its domain to simplify the assumption.
3644 if (AS.BB)
3645 S = isl_set_params(isl_set_intersect(S, getDomainConditions(AS.BB)));
3646
3647 addAssumption(AS.Kind, S, AS.Loc, AS.Sign);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003648 }
3649}
3650
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003651void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003652 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003653}
3654
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003655__isl_give isl_set *Scop::getInvalidContext() const {
3656 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003657}
3658
Tobias Grosser75805372011-04-29 06:27:02 +00003659void Scop::printContext(raw_ostream &OS) const {
3660 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003661 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003662
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003663 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003664 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003665
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003666 OS.indent(4) << "Invalid Context:\n";
3667 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003668
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003669 unsigned Dim = 0;
3670 for (const SCEV *Parameter : Parameters)
3671 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003672}
3673
Johannes Doerfertb164c792014-09-18 11:17:17 +00003674void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003675 int noOfGroups = 0;
3676 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003677 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003678 noOfGroups += 1;
3679 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003680 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003681 }
3682
Tobias Grosserbb853c22015-07-25 12:31:03 +00003683 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003684 if (MinMaxAliasGroups.empty()) {
3685 OS.indent(8) << "n/a\n";
3686 return;
3687 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003688
Tobias Grosserbb853c22015-07-25 12:31:03 +00003689 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003690
3691 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003692 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003693 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003694 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003695 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3696 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003697 }
3698 OS << " ]]\n";
3699 }
3700
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003701 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003702 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003703 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003704 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003705 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3706 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003707 }
3708 OS << " ]]\n";
3709 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003710 }
3711}
3712
Tobias Grosser75805372011-04-29 06:27:02 +00003713void Scop::printStatements(raw_ostream &OS) const {
3714 OS << "Statements {\n";
3715
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003716 for (const ScopStmt &Stmt : *this)
3717 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003718
3719 OS.indent(4) << "}\n";
3720}
3721
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003722void Scop::printArrayInfo(raw_ostream &OS) const {
3723 OS << "Arrays {\n";
3724
Tobias Grosserab671442015-05-23 05:58:27 +00003725 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003726 Array.second->print(OS);
3727
3728 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003729
3730 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3731
3732 for (auto &Array : arrays())
3733 Array.second->print(OS, /* SizeAsPwAff */ true);
3734
3735 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003736}
3737
Tobias Grosser75805372011-04-29 06:27:02 +00003738void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003739 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3740 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003741 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003742 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003743 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003744 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003745 const auto &MAs = std::get<1>(IAClass);
3746 if (MAs.empty()) {
3747 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003748 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003749 MAs.front()->print(OS);
3750 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003751 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003752 }
3753 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003754 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003755 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003756 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003757 printStatements(OS.indent(4));
3758}
3759
3760void Scop::dump() const { print(dbgs()); }
3761
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003762isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003763
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003764__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003765 // First try to use the SCEVAffinator to generate a piecewise defined
3766 // affine function from @p E in the context of @p BB. If that tasks becomes to
3767 // complex the affinator might return a nullptr. In such a case we invalidate
3768 // the SCoP and return a dummy value. This way we do not need to add error
3769 // handling cdoe to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003770 auto PWAC = Affinator.getPwAff(E, BB);
3771 if (PWAC.first)
3772 return PWAC;
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003773
3774 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
3775 invalidate(COMPLEXITY, DL);
3776 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003777}
3778
Tobias Grosser808cd692015-07-14 09:33:13 +00003779__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003780 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003781
Tobias Grosser808cd692015-07-14 09:33:13 +00003782 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003783 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003784
3785 return Domain;
3786}
3787
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003788__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
3789 PWACtx PWAC = getPwAff(E, BB);
3790 isl_set_free(PWAC.second);
3791 return PWAC.first;
3792}
3793
Tobias Grossere5a35142015-11-12 14:07:09 +00003794__isl_give isl_union_map *
3795Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3796 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003797
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003798 for (ScopStmt &Stmt : *this) {
3799 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003800 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003801 continue;
3802
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003803 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003804 isl_map *AccessDomain = MA->getAccessRelation();
3805 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003806 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003807 }
3808 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003809 return isl_union_map_coalesce(Accesses);
3810}
3811
3812__isl_give isl_union_map *Scop::getMustWrites() {
3813 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003814}
3815
3816__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003817 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003818}
3819
Tobias Grosser37eb4222014-02-20 21:43:54 +00003820__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003821 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003822}
3823
3824__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003825 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003826}
3827
Tobias Grosser2ac23382015-11-12 14:07:13 +00003828__isl_give isl_union_map *Scop::getAccesses() {
3829 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3830}
3831
Tobias Grosser808cd692015-07-14 09:33:13 +00003832__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003833 auto *Tree = getScheduleTree();
3834 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003835 isl_schedule_free(Tree);
3836 return S;
3837}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003838
Tobias Grosser808cd692015-07-14 09:33:13 +00003839__isl_give isl_schedule *Scop::getScheduleTree() const {
3840 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3841 getDomains());
3842}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003843
Tobias Grosser808cd692015-07-14 09:33:13 +00003844void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3845 auto *S = isl_schedule_from_domain(getDomains());
3846 S = isl_schedule_insert_partial_schedule(
3847 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3848 isl_schedule_free(Schedule);
3849 Schedule = S;
3850}
3851
3852void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3853 isl_schedule_free(Schedule);
3854 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003855}
3856
3857bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3858 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003859 for (ScopStmt &Stmt : *this) {
3860 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003861 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3862 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3863
3864 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3865 isl_union_set_free(StmtDomain);
3866 isl_union_set_free(NewStmtDomain);
3867 continue;
3868 }
3869
3870 Changed = true;
3871
3872 isl_union_set_free(StmtDomain);
3873 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3874
3875 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003876 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003877 isl_union_set_free(NewStmtDomain);
3878 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003879 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003880 }
3881 isl_union_set_free(Domain);
3882 return Changed;
3883}
3884
Tobias Grosser75805372011-04-29 06:27:02 +00003885ScalarEvolution *Scop::getSE() const { return SE; }
3886
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003887bool Scop::isIgnored(RegionNode *RN, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003888 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Kruse6f7721f2016-02-24 22:08:19 +00003889 ScopStmt *Stmt = getStmtFor(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003890
3891 // If there is no stmt, then it already has been removed.
3892 if (!Stmt)
3893 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003894
Johannes Doerfertf5673802015-10-01 23:48:18 +00003895 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003896 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003897 return true;
3898
3899 // Check for reachability via non-error blocks.
3900 if (!DomainMap.count(BB))
3901 return true;
3902
3903 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003904 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003905 return true;
3906
3907 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003908}
3909
Tobias Grosser808cd692015-07-14 09:33:13 +00003910struct MapToDimensionDataTy {
3911 int N;
3912 isl_union_pw_multi_aff *Res;
3913};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003914
Tobias Grosser808cd692015-07-14 09:33:13 +00003915// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003916// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003917//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003918// @param Set The input set.
3919// @param User->N The dimension to map to.
3920// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003921//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003922// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003923static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3924 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3925 int Dim;
3926 isl_space *Space;
3927 isl_pw_multi_aff *PMA;
3928
3929 Dim = isl_set_dim(Set, isl_dim_set);
3930 Space = isl_set_get_space(Set);
3931 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3932 Dim - Data->N);
3933 if (Data->N > 1)
3934 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3935 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3936
3937 isl_set_free(Set);
3938
3939 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003940}
3941
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003942// @brief Create an isl_multi_union_aff that defines an identity mapping
3943// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003944//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003945// # Example:
3946//
3947// Domain: { A[i,j]; B[i,j,k] }
3948// N: 1
3949//
3950// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3951//
3952// @param USet A union set describing the elements for which to generate a
3953// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003954// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003955// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003956static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003957mapToDimension(__isl_take isl_union_set *USet, int N) {
3958 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003959 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003960 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003961
Tobias Grosser808cd692015-07-14 09:33:13 +00003962 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003963
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003964 auto *Space = isl_union_set_get_space(USet);
3965 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003966
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003967 Data = {N, PwAff};
3968
3969 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003970 (void)Res;
3971
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003972 assert(Res == isl_stat_ok);
3973
3974 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003975 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
3976}
3977
Tobias Grosser316b5b22015-11-11 19:28:14 +00003978void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00003979 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00003980 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003981 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003982 StmtMap[BB] = Stmt;
3983 } else {
3984 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00003985 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003986 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003987 for (BasicBlock *BB : R->blocks())
3988 StmtMap[BB] = Stmt;
3989 }
Tobias Grosser808cd692015-07-14 09:33:13 +00003990}
3991
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003992void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003993 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003994 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003995 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00003996 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
3997 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003998}
3999
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004000/// To generate a schedule for the elements in a Region we traverse the Region
4001/// in reverse-post-order and add the contained RegionNodes in traversal order
4002/// to the schedule of the loop that is currently at the top of the LoopStack.
4003/// For loop-free codes, this results in a correct sequential ordering.
4004///
4005/// Example:
4006/// bb1(0)
4007/// / \.
4008/// bb2(1) bb3(2)
4009/// \ / \.
4010/// bb4(3) bb5(4)
4011/// \ /
4012/// bb6(5)
4013///
4014/// Including loops requires additional processing. Whenever a loop header is
4015/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4016/// from an empty schedule, we first process all RegionNodes that are within
4017/// this loop and complete the sequential schedule at this loop-level before
4018/// processing about any other nodes. To implement this
4019/// loop-nodes-first-processing, the reverse post-order traversal is
4020/// insufficient. Hence, we additionally check if the traversal yields
4021/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4022/// These region-nodes are then queue and only traverse after the all nodes
4023/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004024void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
4025 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004026 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
4027
4028 ReversePostOrderTraversal<Region *> RTraversal(R);
4029 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4030 std::deque<RegionNode *> DelayList;
4031 bool LastRNWaiting = false;
4032
4033 // Iterate over the region @p R in reverse post-order but queue
4034 // sub-regions/blocks iff they are not part of the last encountered but not
4035 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4036 // that we queued the last sub-region/block from the reverse post-order
4037 // iterator. If it is set we have to explore the next sub-region/block from
4038 // the iterator (if any) to guarantee progress. If it is not set we first try
4039 // the next queued sub-region/blocks.
4040 while (!WorkList.empty() || !DelayList.empty()) {
4041 RegionNode *RN;
4042
4043 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4044 RN = WorkList.front();
4045 WorkList.pop_front();
4046 LastRNWaiting = false;
4047 } else {
4048 RN = DelayList.front();
4049 DelayList.pop_front();
4050 }
4051
4052 Loop *L = getRegionNodeLoop(RN, LI);
4053 if (!getRegion().contains(L))
4054 L = OuterScopLoop;
4055
Tobias Grosser151ae322016-04-03 19:36:52 +00004056 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004057 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004058 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004059 LastRNWaiting = true;
4060 DelayList.push_back(RN);
4061 continue;
4062 }
4063 LoopStack.push_back({L, nullptr, 0});
4064 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004065 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004066 }
4067
4068 return;
4069}
4070
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00004071void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004072 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004073
Tobias Grosser8362c262016-01-06 15:30:06 +00004074 if (RN->isSubRegion()) {
4075 auto *LocalRegion = RN->getNodeAs<Region>();
4076 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004077 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004078 return;
4079 }
4080 }
Michael Kruse046dde42015-08-10 13:01:57 +00004081
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004082 auto &LoopData = LoopStack.back();
4083 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004084
Michael Kruse6f7721f2016-02-24 22:08:19 +00004085 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004086 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4087 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004088 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004089 }
4090
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004091 // Check if we just processed the last node in this loop. If we did, finalize
4092 // the loop by:
4093 //
4094 // - adding new schedule dimensions
4095 // - folding the resulting schedule into the parent loop schedule
4096 // - dropping the loop schedule from the LoopStack.
4097 //
4098 // Then continue to check surrounding loops, which might also have been
4099 // completed by this node.
4100 while (LoopData.L &&
4101 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004102 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004103 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004104
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004105 LoopStack.pop_back();
4106 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004107
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004108 if (Schedule) {
4109 auto *Domain = isl_schedule_get_domain(Schedule);
4110 auto *MUPA = mapToDimension(Domain, LoopStack.size());
4111 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
4112 NextLoopData.Schedule =
4113 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004114 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004115
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004116 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4117 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004118 }
Tobias Grosser75805372011-04-29 06:27:02 +00004119}
4120
Michael Kruse6f7721f2016-02-24 22:08:19 +00004121ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004122 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004123 if (StmtMapIt == StmtMap.end())
4124 return nullptr;
4125 return StmtMapIt->second;
4126}
4127
Michael Kruse6f7721f2016-02-24 22:08:19 +00004128ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4129 if (RN->isSubRegion())
4130 return getStmtFor(RN->getNodeAs<Region>());
4131 return getStmtFor(RN->getNodeAs<BasicBlock>());
4132}
4133
4134ScopStmt *Scop::getStmtFor(Region *R) const {
4135 ScopStmt *Stmt = getStmtFor(R->getEntry());
4136 assert(!Stmt || Stmt->getRegion() == R);
4137 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004138}
4139
Johannes Doerfert96425c22015-08-30 21:13:53 +00004140int Scop::getRelativeLoopDepth(const Loop *L) const {
4141 Loop *OuterLoop =
4142 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
4143 if (!OuterLoop)
4144 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00004145 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4146}
4147
Michael Krused868b5d2015-09-10 15:25:24 +00004148void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00004149 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004150
4151 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
4152 // true, are not modeled as ordinary PHI nodes as they are not part of the
4153 // region. However, we model the operands in the predecessor blocks that are
4154 // part of the region as regular scalar accesses.
4155
4156 // If we can synthesize a PHI we can skip it, however only if it is in
4157 // the region. If it is not it can only be in the exit block of the region.
4158 // In this case we model the operands but not the PHI itself.
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004159 auto *Scope = LI->getLoopFor(PHI->getParent());
4160 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R, Scope))
Michael Kruse7bf39442015-09-10 12:46:52 +00004161 return;
4162
4163 // PHI nodes are modeled as if they had been demoted prior to the SCoP
4164 // detection. Hence, the PHI is a load of a new memory location in which the
4165 // incoming value was written at the end of the incoming basic block.
4166 bool OnlyNonAffineSubRegionOperands = true;
4167 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
4168 Value *Op = PHI->getIncomingValue(u);
4169 BasicBlock *OpBB = PHI->getIncomingBlock(u);
4170
4171 // Do not build scalar dependences inside a non-affine subregion.
4172 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
4173 continue;
4174
4175 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004176 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004177 }
4178
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004179 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
4180 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004181 }
4182}
4183
Michael Kruse2e02d562016-02-06 09:19:40 +00004184void ScopInfo::buildScalarDependences(Instruction *Inst) {
4185 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00004186
Michael Kruse2e02d562016-02-06 09:19:40 +00004187 // Pull-in required operands.
4188 for (Use &Op : Inst->operands())
4189 ensureValueRead(Op.get(), Inst->getParent());
4190}
Michael Kruse7bf39442015-09-10 12:46:52 +00004191
Michael Kruse2e02d562016-02-06 09:19:40 +00004192void ScopInfo::buildEscapingDependences(Instruction *Inst) {
4193 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00004194
Michael Kruse2e02d562016-02-06 09:19:40 +00004195 // Check for uses of this instruction outside the scop. Because we do not
4196 // iterate over such instructions and therefore did not "ensure" the existence
4197 // of a write, we must determine such use here.
4198 for (Use &U : Inst->uses()) {
4199 Instruction *UI = dyn_cast<Instruction>(U.getUser());
4200 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00004201 continue;
4202
Michael Kruse2e02d562016-02-06 09:19:40 +00004203 BasicBlock *UseParent = getUseBlock(U);
4204 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00004205
Michael Kruse2e02d562016-02-06 09:19:40 +00004206 // An escaping value is either used by an instruction not within the scop,
4207 // or (when the scop region's exit needs to be simplified) by a PHI in the
4208 // scop's exit block. This is because region simplification before code
4209 // generation inserts new basic blocks before the PHI such that its incoming
4210 // blocks are not in the scop anymore.
4211 if (!R->contains(UseParent) ||
4212 (isa<PHINode>(UI) && UserParent == R->getExit() &&
4213 R->getExitingBlock())) {
4214 // At least one escaping use found.
4215 ensureValueWrite(Inst);
4216 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00004217 }
4218 }
Michael Kruse7bf39442015-09-10 12:46:52 +00004219}
4220
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004221bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00004222 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00004223 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4224 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00004225 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004226 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004227 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004228 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00004229 const SCEVUnknown *BasePointer =
4230 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004231 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004232 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004233
Michael Kruse37d136e2016-02-26 16:08:24 +00004234 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
4235 auto *Src = BitCast->getOperand(0);
4236 auto *SrcTy = Src->getType();
4237 auto *DstTy = BitCast->getType();
Johannes Doerfert41725a12016-04-08 19:20:03 +00004238 // Do not try to delinearize non-sized (opaque) pointers.
4239 if ((SrcTy->isPointerTy() && !SrcTy->getPointerElementType()->isSized()) ||
4240 (DstTy->isPointerTy() && !DstTy->getPointerElementType()->isSized())) {
4241 return false;
4242 }
Michael Kruse436c9062016-04-08 16:20:08 +00004243 if (SrcTy->isPointerTy() && DstTy->isPointerTy() &&
4244 DL->getTypeAllocSize(SrcTy->getPointerElementType()) ==
4245 DL->getTypeAllocSize(DstTy->getPointerElementType()))
Michael Kruse37d136e2016-02-26 16:08:24 +00004246 Address = Src;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004247 }
Michael Kruse37d136e2016-02-26 16:08:24 +00004248
4249 auto *GEP = dyn_cast<GetElementPtrInst>(Address);
4250 if (!GEP)
4251 return false;
4252
4253 std::vector<const SCEV *> Subscripts;
4254 std::vector<int> Sizes;
4255 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
4256 auto *BasePtr = GEP->getOperand(0);
4257
Tobias Grosser535afd82016-04-05 06:23:45 +00004258 if (auto *BasePtrCast = dyn_cast<BitCastInst>(BasePtr))
4259 BasePtr = BasePtrCast->getOperand(0);
4260
4261 // Check for identical base pointers to ensure that we do not miss index
4262 // offsets that have been added before this GEP is applied.
4263 if (BasePtr != BasePointer->getValue())
4264 return false;
4265
Michael Kruse37d136e2016-02-26 16:08:24 +00004266 std::vector<const SCEV *> SizesSCEV;
4267
4268 for (auto *Subscript : Subscripts) {
4269 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004270 if (!isAffineExpr(R, L, Subscript, *SE, &AccessILS))
Michael Kruse37d136e2016-02-26 16:08:24 +00004271 return false;
4272
4273 for (LoadInst *LInst : AccessILS)
4274 if (!ScopRIL.count(LInst))
4275 return false;
4276 }
4277
4278 if (Sizes.empty())
4279 return false;
4280
4281 for (auto V : Sizes)
4282 SizesSCEV.push_back(SE->getSCEV(
4283 ConstantInt::get(IntegerType::getInt64Ty(BasePtr->getContext()), V)));
4284
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004285 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004286 Subscripts, SizesSCEV, Val);
4287 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004288}
4289
4290bool ScopInfo::buildAccessMultiDimParam(
4291 MemAccInst Inst, Loop *L, Region *R,
4292 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004293 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse37d136e2016-02-26 16:08:24 +00004294 if (!PollyDelinearize)
4295 return false;
4296
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004297 Value *Address = Inst.getPointerOperand();
4298 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004299 Type *ElementType = Val->getType();
4300 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004301 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004302 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004303
4304 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4305 const SCEVUnknown *BasePointer =
4306 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4307
4308 assert(BasePointer && "Could not find base pointer");
4309 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004310
Michael Kruse7bf39442015-09-10 12:46:52 +00004311 auto AccItr = InsnToMemAcc.find(Inst);
Michael Kruse37d136e2016-02-26 16:08:24 +00004312 if (AccItr == InsnToMemAcc.end())
4313 return false;
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004314
Michael Kruse37d136e2016-02-26 16:08:24 +00004315 std::vector<const SCEV *> Sizes(
4316 AccItr->second.Shape->DelinearizedSizes.begin(),
4317 AccItr->second.Shape->DelinearizedSizes.end());
4318 // Remove the element size. This information is already provided by the
4319 // ElementSize parameter. In case the element size of this access and the
4320 // element size used for delinearization differs the delinearization is
4321 // incorrect. Hence, we invalidate the scop.
4322 //
4323 // TODO: Handle delinearization with differing element sizes.
4324 auto DelinearizedSize =
4325 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
4326 Sizes.pop_back();
4327 if (ElementSize != DelinearizedSize)
4328 scop->invalidate(DELINEARIZATION, Inst->getDebugLoc());
4329
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004330 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004331 AccItr->second.DelinearizedSubscripts, Sizes, Val);
4332 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004333}
4334
Johannes Doerfertcea61932016-02-21 19:13:19 +00004335bool ScopInfo::buildAccessMemIntrinsic(
4336 MemAccInst Inst, Loop *L, Region *R,
4337 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4338 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004339 auto *MemIntr = dyn_cast_or_null<MemIntrinsic>(Inst);
4340
4341 if (MemIntr == nullptr)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004342 return false;
4343
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004344 auto *LengthVal = SE->getSCEVAtScope(MemIntr->getLength(), L);
Johannes Doerfertcea61932016-02-21 19:13:19 +00004345 assert(LengthVal);
4346
Johannes Doerferta7920982016-02-25 14:08:48 +00004347 // Check if the length val is actually affine or if we overapproximate it
4348 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004349 bool LengthIsAffine = isAffineExpr(R, L, LengthVal, *SE, &AccessILS);
Johannes Doerferta7920982016-02-25 14:08:48 +00004350 for (LoadInst *LInst : AccessILS)
4351 if (!ScopRIL.count(LInst))
4352 LengthIsAffine = false;
4353 if (!LengthIsAffine)
4354 LengthVal = nullptr;
4355
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004356 auto *DestPtrVal = MemIntr->getDest();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004357 assert(DestPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004358
Johannes Doerfertcea61932016-02-21 19:13:19 +00004359 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
4360 assert(DestAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004361 // Ignore accesses to "NULL".
4362 // TODO: We could use this to optimize the region further, e.g., intersect
4363 // the context with
4364 // isl_set_complement(isl_set_params(getDomain()))
4365 // as we know it would be undefined to execute this instruction anyway.
4366 if (DestAccFunc->isZero())
4367 return true;
4368
Johannes Doerfertcea61932016-02-21 19:13:19 +00004369 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
4370 assert(DestPtrSCEV);
4371 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
4372 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
4373 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
4374 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
4375
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004376 auto *MemTrans = dyn_cast<MemTransferInst>(MemIntr);
4377 if (!MemTrans)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004378 return true;
4379
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004380 auto *SrcPtrVal = MemTrans->getSource();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004381 assert(SrcPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004382
Johannes Doerfertcea61932016-02-21 19:13:19 +00004383 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
4384 assert(SrcAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004385 // Ignore accesses to "NULL".
4386 // TODO: See above TODO
4387 if (SrcAccFunc->isZero())
4388 return true;
4389
Johannes Doerfertcea61932016-02-21 19:13:19 +00004390 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
4391 assert(SrcPtrSCEV);
4392 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
4393 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
4394 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
4395 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
4396
4397 return true;
4398}
4399
Johannes Doerferta7920982016-02-25 14:08:48 +00004400bool ScopInfo::buildAccessCallInst(
4401 MemAccInst Inst, Loop *L, Region *R,
4402 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4403 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004404 auto *CI = dyn_cast_or_null<CallInst>(Inst);
4405
4406 if (CI == nullptr)
Johannes Doerferta7920982016-02-25 14:08:48 +00004407 return false;
4408
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004409 if (CI->doesNotAccessMemory() || isIgnoredIntrinsic(CI))
Johannes Doerferta7920982016-02-25 14:08:48 +00004410 return true;
4411
4412 bool ReadOnly = false;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004413 auto *AF = SE->getConstant(IntegerType::getInt64Ty(CI->getContext()), 0);
4414 auto *CalledFunction = CI->getCalledFunction();
Johannes Doerferta7920982016-02-25 14:08:48 +00004415 switch (AA->getModRefBehavior(CalledFunction)) {
4416 case llvm::FMRB_UnknownModRefBehavior:
4417 llvm_unreachable("Unknown mod ref behaviour cannot be represented.");
4418 case llvm::FMRB_DoesNotAccessMemory:
4419 return true;
4420 case llvm::FMRB_OnlyReadsMemory:
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004421 GlobalReads.push_back(CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004422 return true;
4423 case llvm::FMRB_OnlyReadsArgumentPointees:
4424 ReadOnly = true;
4425 // Fall through
4426 case llvm::FMRB_OnlyAccessesArgumentPointees:
4427 auto AccType = ReadOnly ? MemoryAccess::READ : MemoryAccess::MAY_WRITE;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004428 for (const auto &Arg : CI->arg_operands()) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004429 if (!Arg->getType()->isPointerTy())
4430 continue;
4431
4432 auto *ArgSCEV = SE->getSCEVAtScope(Arg, L);
4433 if (ArgSCEV->isZero())
4434 continue;
4435
4436 auto *ArgBasePtr = cast<SCEVUnknown>(SE->getPointerBase(ArgSCEV));
4437 addArrayAccess(Inst, AccType, ArgBasePtr->getValue(),
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004438 ArgBasePtr->getType(), false, {AF}, {}, CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004439 }
4440 return true;
4441 }
4442
4443 return true;
4444}
4445
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004446void ScopInfo::buildAccessSingleDim(
4447 MemAccInst Inst, Loop *L, Region *R,
4448 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4449 const InvariantLoadsSetTy &ScopRIL) {
4450 Value *Address = Inst.getPointerOperand();
4451 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004452 Type *ElementType = Val->getType();
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004453 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004454 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004455
4456 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4457 const SCEVUnknown *BasePointer =
4458 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4459
4460 assert(BasePointer && "Could not find base pointer");
4461 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00004462
4463 // Check if the access depends on a loop contained in a non-affine subregion.
4464 bool isVariantInNonAffineLoop = false;
4465 if (BoxedLoops) {
4466 SetVector<const Loop *> Loops;
4467 findLoops(AccessFunction, Loops);
4468 for (const Loop *L : Loops)
4469 if (BoxedLoops->count(L))
4470 isVariantInNonAffineLoop = true;
4471 }
4472
Johannes Doerfert09e36972015-10-07 20:17:36 +00004473 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00004474 bool IsAffine = !isVariantInNonAffineLoop &&
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004475 isAffineExpr(R, L, AccessFunction, *SE, &AccessILS);
Johannes Doerfert09e36972015-10-07 20:17:36 +00004476
4477 for (LoadInst *LInst : AccessILS)
4478 if (!ScopRIL.count(LInst))
4479 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004480
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004481 if (!IsAffine && AccType == MemoryAccess::MUST_WRITE)
4482 AccType = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004483
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004484 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004485 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004486}
4487
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004488void ScopInfo::buildMemoryAccess(
4489 MemAccInst Inst, Loop *L, Region *R,
4490 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004491 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004492
Johannes Doerfertcea61932016-02-21 19:13:19 +00004493 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4494 return;
4495
Johannes Doerferta7920982016-02-25 14:08:48 +00004496 if (buildAccessCallInst(Inst, L, R, BoxedLoops, ScopRIL))
4497 return;
4498
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004499 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4500 return;
4501
Hongbin Zheng22623202016-02-15 00:20:58 +00004502 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004503 return;
4504
4505 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4506}
4507
Hongbin Zheng22623202016-02-15 00:20:58 +00004508void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4509 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004510
4511 if (SD->isNonAffineSubRegion(&SR, &R)) {
4512 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004513 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004514 return;
4515 }
4516
4517 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4518 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004519 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004520 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004521 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004522}
4523
Johannes Doerferta8781032016-02-02 14:14:40 +00004524void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004525
Johannes Doerferta8781032016-02-02 14:14:40 +00004526 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004527 scop->addScopStmt(nullptr, &SR);
4528 return;
4529 }
4530
4531 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4532 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004533 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004534 else
4535 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4536}
4537
Michael Krused868b5d2015-09-10 15:25:24 +00004538void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004539 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004540 Region *NonAffineSubRegion,
4541 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004542 // We do not build access functions for error blocks, as they may contain
4543 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004544 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004545 return;
4546
Michael Kruse7bf39442015-09-10 12:46:52 +00004547 Loop *L = LI->getLoopFor(&BB);
4548
4549 // The set of loops contained in non-affine subregions that are part of R.
4550 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4551
Johannes Doerfert09e36972015-10-07 20:17:36 +00004552 // The set of loads that are required to be invariant.
4553 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4554
Michael Kruse2e02d562016-02-06 09:19:40 +00004555 for (Instruction &Inst : BB) {
4556 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004557 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004558 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004559
4560 // For the exit block we stop modeling after the last PHI node.
4561 if (!PHI && IsExitBlock)
4562 break;
4563
Johannes Doerfert09e36972015-10-07 20:17:36 +00004564 // TODO: At this point we only know that elements of ScopRIL have to be
4565 // invariant and will be hoisted for the SCoP to be processed. Though,
4566 // there might be other invariant accesses that will be hoisted and
4567 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004568 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004569 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004570
Michael Kruse2e02d562016-02-06 09:19:40 +00004571 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004572 continue;
4573
Tobias Grosser0904c692016-03-16 23:33:54 +00004574 // PHI nodes have already been modeled above and TerminatorInsts that are
4575 // not part of a non-affine subregion are fully modeled and regenerated
4576 // from the polyhedral domains. Hence, they do not need to be modeled as
4577 // explicit data dependences.
4578 if (!PHI && (!isa<TerminatorInst>(&Inst) || NonAffineSubRegion))
Michael Kruse2e02d562016-02-06 09:19:40 +00004579 buildScalarDependences(&Inst);
Tobias Grosser0904c692016-03-16 23:33:54 +00004580
Michael Kruse2e02d562016-02-06 09:19:40 +00004581 if (!IsExitBlock)
4582 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004583 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004584}
Michael Kruse7bf39442015-09-10 12:46:52 +00004585
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004586MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004587 MemoryAccess::AccessType AccType,
4588 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004589 bool Affine, Value *AccessValue,
4590 ArrayRef<const SCEV *> Subscripts,
4591 ArrayRef<const SCEV *> Sizes,
4592 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004593 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004594
4595 // Do not create a memory access for anything not in the SCoP. It would be
4596 // ignored anyway.
4597 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004598 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004599
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004600 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004601 Value *BaseAddr = BaseAddress;
4602 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4603
Tobias Grosserf4f68702015-12-14 15:05:37 +00004604 bool isKnownMustAccess = false;
4605
4606 // Accesses in single-basic block statements are always excuted.
4607 if (Stmt->isBlockStmt())
4608 isKnownMustAccess = true;
4609
4610 if (Stmt->isRegionStmt()) {
4611 // Accesses that dominate the exit block of a non-affine region are always
4612 // executed. In non-affine regions there may exist MK_Values that do not
4613 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4614 // only if there is at most one PHI_WRITE in the non-affine region.
4615 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4616 isKnownMustAccess = true;
4617 }
4618
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004619 // Non-affine PHI writes do not "happen" at a particular instruction, but
4620 // after exiting the statement. Therefore they are guaranteed execute and
4621 // overwrite the old value.
4622 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4623 isKnownMustAccess = true;
4624
Johannes Doerfertcea61932016-02-21 19:13:19 +00004625 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4626 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004627
Johannes Doerfertcea61932016-02-21 19:13:19 +00004628 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004629 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004630 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004631 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004632}
4633
Michael Kruse70131d32016-01-27 17:09:17 +00004634void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004635 MemoryAccess::AccessType AccType,
4636 Value *BaseAddress, Type *ElementType,
4637 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004638 ArrayRef<const SCEV *> Sizes,
4639 Value *AccessValue) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004640 ArrayBasePointers.insert(BaseAddress);
Hongbin Zhengf3d66122016-02-26 09:47:11 +00004641 addMemoryAccess(MemAccInst->getParent(), MemAccInst, AccType, BaseAddress,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004642 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004643 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004644}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004645
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004646void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004647 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004648
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004649 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004650 if (!Stmt)
4651 return;
4652
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004653 // Do not process further if the instruction is already written.
4654 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004655 return;
4656
Johannes Doerfertcea61932016-02-21 19:13:19 +00004657 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4658 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004659 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004660}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004661
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004662void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004663
Michael Kruse2e02d562016-02-06 09:19:40 +00004664 // There cannot be an "access" for literal constants. BasicBlock references
4665 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004666 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004667 return;
4668
Michael Krusefd463082016-01-27 22:51:56 +00004669 // If the instruction can be synthesized and the user is in the region we do
4670 // not need to add a value dependences.
4671 Region &ScopRegion = scop->getRegion();
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004672 auto *Scope = LI->getLoopFor(UserBB);
4673 if (canSynthesize(V, LI, SE, &ScopRegion, Scope))
Michael Krusefd463082016-01-27 22:51:56 +00004674 return;
4675
Michael Kruse2e02d562016-02-06 09:19:40 +00004676 // Do not build scalar dependences for required invariant loads as we will
4677 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004678 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004679 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004680 return;
4681
4682 // Determine the ScopStmt containing the value's definition and use. There is
4683 // no defining ScopStmt if the value is a function argument, a global value,
4684 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004685 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004686 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004687
Michael Kruse6f7721f2016-02-24 22:08:19 +00004688 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004689
4690 // We do not model uses outside the scop.
4691 if (!UserStmt)
4692 return;
4693
Michael Kruse2e02d562016-02-06 09:19:40 +00004694 // Add MemoryAccess for invariant values only if requested.
4695 if (!ModelReadOnlyScalars && !ValueStmt)
4696 return;
4697
4698 // Ignore use-def chains within the same ScopStmt.
4699 if (ValueStmt == UserStmt)
4700 return;
4701
Michael Krusead28e5a2016-01-26 13:33:15 +00004702 // Do not create another MemoryAccess for reloading the value if one already
4703 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004704 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004705 return;
4706
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004707 // For exit PHIs use the MK_ExitPHI MemoryKind not MK_Value.
4708 ScopArrayInfo::MemoryKind Kind = ScopArrayInfo::MK_Value;
4709 if (!ValueStmt && isa<PHINode>(V))
4710 Kind = ScopArrayInfo::MK_ExitPHI;
4711
Johannes Doerfertcea61932016-02-21 19:13:19 +00004712 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004713 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(), Kind);
Michael Kruse2e02d562016-02-06 09:19:40 +00004714 if (ValueInst)
4715 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004716}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004717
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004718void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4719 Value *IncomingValue, bool IsExitBlock) {
Johannes Doerfert57c5f0b2016-04-05 13:44:21 +00004720 // As the incoming block might turn out to be an error statement ensure we
4721 // will create an exit PHI SAI object. It is needed during code generation
4722 // and would be created later anyway.
4723 if (IsExitBlock)
4724 scop->getOrCreateScopArrayInfo(PHI, PHI->getType(), {},
4725 ScopArrayInfo::MK_ExitPHI);
4726
Michael Kruse6f7721f2016-02-24 22:08:19 +00004727 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004728 if (!IncomingStmt)
4729 return;
4730
4731 // Take care for the incoming value being available in the incoming block.
4732 // This must be done before the check for multiple PHI writes because multiple
4733 // exiting edges from subregion each can be the effective written value of the
4734 // subregion. As such, all of them must be made available in the subregion
4735 // statement.
4736 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004737
4738 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4739 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4740 assert(Acc->getAccessInstruction() == PHI);
4741 Acc->addIncoming(IncomingBlock, IncomingValue);
4742 return;
4743 }
4744
4745 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004746 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4747 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4748 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004749 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4750 assert(Acc);
4751 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004752}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004753
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004754void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004755 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4756 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4757 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004758}
4759
Michael Krusedaf66942015-12-13 22:10:37 +00004760void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004761 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse09eb4452016-03-03 22:10:47 +00004762 scop.reset(new Scop(R, *SE, *LI, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004763
Johannes Doerferta8781032016-02-02 14:14:40 +00004764 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004765 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004766
4767 // In case the region does not have an exiting block we will later (during
4768 // code generation) split the exit block. This will move potential PHI nodes
4769 // from the current exit block into the new region exiting block. Hence, PHI
4770 // nodes that are at this point not part of the region will be.
4771 // To handle these PHI nodes later we will now model their operands as scalar
4772 // accesses. Note that we do not model anything in the exit block if we have
4773 // an exiting block in the region, as there will not be any splitting later.
4774 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004775 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4776 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004777
Johannes Doerferta7920982016-02-25 14:08:48 +00004778 // Create memory accesses for global reads since all arrays are now known.
4779 auto *AF = SE->getConstant(IntegerType::getInt64Ty(SE->getContext()), 0);
4780 for (auto *GlobalRead : GlobalReads)
4781 for (auto *BP : ArrayBasePointers)
4782 addArrayAccess(MemAccInst(GlobalRead), MemoryAccess::READ, BP,
4783 BP->getType(), false, {AF}, {}, GlobalRead);
4784
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004785 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004786}
4787
Michael Krused868b5d2015-09-10 15:25:24 +00004788void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004789 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004790 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004791 return;
4792 }
4793
Michael Kruse9d080092015-09-11 21:41:48 +00004794 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004795}
4796
Hongbin Zhengfec32802016-02-13 15:13:02 +00004797void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004798
4799//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004800ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004801
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004802ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004803
Tobias Grosser75805372011-04-29 06:27:02 +00004804void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004805 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004806 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004807 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004808 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4809 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004810 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004811 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004812 AU.setPreservesAll();
4813}
4814
4815bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004816 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004817
Michael Krused868b5d2015-09-10 15:25:24 +00004818 if (!SD->isMaxRegionInScop(*R))
4819 return false;
4820
4821 Function *F = R->getEntry()->getParent();
4822 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4823 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4824 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004825 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004826 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004827 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004828
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004829 DebugLoc Beg, End;
4830 getDebugLocations(R, Beg, End);
4831 std::string Msg = "SCoP begins here.";
4832 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4833
Michael Krusedaf66942015-12-13 22:10:37 +00004834 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004835
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004836 DEBUG(scop->print(dbgs()));
4837
Michael Kruseafe06702015-10-02 16:33:27 +00004838 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004839 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004840 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004841 } else {
4842 Msg = "SCoP ends here.";
4843 ++ScopFound;
4844 if (scop->getMaxLoopDepth() > 0)
4845 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004846 }
4847
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004848 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4849
Tobias Grosser75805372011-04-29 06:27:02 +00004850 return false;
4851}
4852
4853char ScopInfo::ID = 0;
4854
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004855Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4856
Tobias Grosser73600b82011-10-08 00:30:40 +00004857INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4858 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004859 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004860INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004861INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004862INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004863INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004864INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004865INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004866INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004867INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4868 "Polly - Create polyhedral description of Scops", false,
4869 false)