blob: 2b0c18295075517b404a6bfea1efcc5498b40cd6 [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 Doerfert792374b2016-04-26 14:33:12 +00001320
1321 if (ICond->isUnsigned()) {
1322 // For unsigned comparisons we assumed the signed bit of neither operand
1323 // to be set. The comparison is equal to a signed comparison under this
1324 // assumption.
1325 auto *BB = Stmt.getEntryBlock();
1326 S.recordAssumption(UNSIGNED, isl_pw_aff_nonneg_set(isl_pw_aff_copy(LHS)),
1327 TI->getDebugLoc(), AS_ASSUMPTION, BB);
1328 S.recordAssumption(UNSIGNED, isl_pw_aff_nonneg_set(isl_pw_aff_copy(RHS)),
1329 TI->getDebugLoc(), AS_ASSUMPTION, BB);
1330 }
1331
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001332 ConsequenceCondSet =
1333 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1334 }
1335
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001336 // If no terminator was given we are only looking for parameter constraints
1337 // under which @p Condition is true/false.
1338 if (!TI)
1339 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001340 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001341 ConsequenceCondSet = isl_set_coalesce(
1342 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001343
Johannes Doerfertb2885792016-04-26 09:20:41 +00001344 isl_set *AlternativeCondSet = nullptr;
1345 bool ToComplex =
1346 isl_set_n_basic_set(ConsequenceCondSet) >= MaxConjunctsInDomain;
1347
1348 if (!ToComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001349 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1350 isl_set_copy(ConsequenceCondSet));
Johannes Doerfertb2885792016-04-26 09:20:41 +00001351 ToComplex = isl_set_n_basic_set(AlternativeCondSet) >= MaxConjunctsInDomain;
1352 }
1353
1354 if (ToComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001355 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc());
Johannes Doerfertb2885792016-04-26 09:20:41 +00001356 isl_set_free(AlternativeCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001357 AlternativeCondSet = isl_set_empty(isl_set_get_space(ConsequenceCondSet));
Johannes Doerfertb2885792016-04-26 09:20:41 +00001358 isl_set_free(ConsequenceCondSet);
1359 ConsequenceCondSet = isl_set_empty(isl_set_get_space(AlternativeCondSet));
Johannes Doerfert15194912016-04-04 07:59:41 +00001360 }
1361
1362 ConditionSets.push_back(ConsequenceCondSet);
1363 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001364}
1365
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001366/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1367///
1368/// This will fill @p ConditionSets with the conditions under which control
1369/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1370/// have as many elements as @p TI has successors.
1371static void
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001372buildConditionSets(ScopStmt &Stmt, TerminatorInst *TI, Loop *L,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001373 __isl_keep isl_set *Domain,
1374 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1375
1376 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001377 return buildConditionSets(Stmt, SI, L, Domain, ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001378
1379 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1380
1381 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001382 ConditionSets.push_back(isl_set_copy(Domain));
1383 return;
1384 }
1385
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001386 Value *Condition = getConditionFromTerminator(TI);
1387 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001388
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001389 return buildConditionSets(Stmt, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001390}
1391
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001392void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001393 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001394
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001395 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001396 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001397}
1398
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001399void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1400 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001401 isl_ctx *Ctx = Parent.getIslCtx();
1402 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1403 Type *Ty = GEP->getPointerOperandType();
1404 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001405
1406 // The set of loads that are required to be invariant.
1407 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001408
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001409 std::vector<const SCEV *> Subscripts;
1410 std::vector<int> Sizes;
1411
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001412 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001413
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001414 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001415 Ty = PtrTy->getElementType();
1416 }
1417
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001418 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001419
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001420 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001421
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001422 auto *NotExecuted = isl_set_complement(isl_set_params(getDomain()));
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001423 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001424 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001425 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001426
Michael Kruse09eb4452016-03-03 22:10:47 +00001427 auto *Scope = SD.getLI()->getLoopFor(getEntryBlock());
Johannes Doerfert09e36972015-10-07 20:17:36 +00001428 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00001429 if (!isAffineExpr(&Parent.getRegion(), Scope, Expr, SE, &AccessILS))
Johannes Doerfert09e36972015-10-07 20:17:36 +00001430 continue;
1431
1432 bool NonAffine = false;
1433 for (LoadInst *LInst : AccessILS)
1434 if (!ScopRIL.count(LInst))
1435 NonAffine = true;
1436
1437 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001438 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001439
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001440 isl_pw_aff *AccessOffset = getPwAff(Expr);
1441 AccessOffset =
1442 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001443
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001444 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1445 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001446
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001447 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1448 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1449 OutOfBound = isl_set_params(OutOfBound);
1450 isl_set *InBound = isl_set_complement(OutOfBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001451
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001452 // A => B == !A or B
1453 isl_set *InBoundIfExecuted =
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001454 isl_set_union(isl_set_copy(NotExecuted), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001455
Roman Gareev10595a12016-01-08 14:01:59 +00001456 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00001457 Parent.recordAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc(),
1458 AS_ASSUMPTION);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001459 }
1460
1461 isl_local_space_free(LSpace);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001462 isl_set_free(NotExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001463}
1464
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001465void ScopStmt::deriveAssumptions(ScopDetection &SD) {
1466 for (auto *MA : *this) {
1467 if (!MA->isArrayKind())
1468 continue;
1469
1470 MemAccInst Acc(MA->getAccessInstruction());
1471 auto *GEP = dyn_cast_or_null<GetElementPtrInst>(Acc.getPointerOperand());
1472
1473 if (GEP)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001474 deriveAssumptionsFromGEP(GEP, SD);
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001475 }
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001476}
1477
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001478void ScopStmt::collectSurroundingLoops() {
1479 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1480 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1481 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1482 isl_id_free(DimId);
1483 }
1484}
1485
Michael Kruse9d080092015-09-11 21:41:48 +00001486ScopStmt::ScopStmt(Scop &parent, Region &R)
Johannes Doerferta3519512016-04-23 13:02:23 +00001487 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
1488 R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001489
Tobias Grosser16c44032015-07-09 07:31:45 +00001490 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001491}
1492
Michael Kruse9d080092015-09-11 21:41:48 +00001493ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Johannes Doerferta3519512016-04-23 13:02:23 +00001494 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
1495 R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001496
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001497 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001498}
1499
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001500void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001501 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001502
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001503 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001504 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001505 buildAccessRelations();
1506
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001507 deriveAssumptions(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001508
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001509 if (DetectReductions)
1510 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001511}
1512
Johannes Doerferte58a0122014-06-27 20:31:28 +00001513/// @brief Collect loads which might form a reduction chain with @p StoreMA
1514///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001515/// Check if the stored value for @p StoreMA is a binary operator with one or
1516/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001517/// used only once (by @p StoreMA) and its load operands are also used only
1518/// once, we have found a possible reduction chain. It starts at an operand
1519/// load and includes the binary operator and @p StoreMA.
1520///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001521/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001522/// escape this block or into any other store except @p StoreMA.
1523void ScopStmt::collectCandiateReductionLoads(
1524 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1525 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1526 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001527 return;
1528
1529 // Skip if there is not one binary operator between the load and the store
1530 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001531 if (!BinOp)
1532 return;
1533
1534 // Skip if the binary operators has multiple uses
1535 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001536 return;
1537
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001538 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001539 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1540 return;
1541
Johannes Doerfert9890a052014-07-01 00:32:29 +00001542 // Skip if the binary operator is outside the current SCoP
1543 if (BinOp->getParent() != Store->getParent())
1544 return;
1545
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001546 // Skip if it is a multiplicative reduction and we disabled them
1547 if (DisableMultiplicativeReductions &&
1548 (BinOp->getOpcode() == Instruction::Mul ||
1549 BinOp->getOpcode() == Instruction::FMul))
1550 return;
1551
Johannes Doerferte58a0122014-06-27 20:31:28 +00001552 // Check the binary operator operands for a candidate load
1553 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1554 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1555 if (!PossibleLoad0 && !PossibleLoad1)
1556 return;
1557
1558 // A load is only a candidate if it cannot escape (thus has only this use)
1559 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001560 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001561 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001562 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001563 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001564 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001565}
1566
1567/// @brief Check for reductions in this ScopStmt
1568///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001569/// Iterate over all store memory accesses and check for valid binary reduction
1570/// like chains. For all candidates we check if they have the same base address
1571/// and there are no other accesses which overlap with them. The base address
1572/// check rules out impossible reductions candidates early. The overlap check,
1573/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001574/// guarantees that none of the intermediate results will escape during
1575/// execution of the loop nest. We basically check here that no other memory
1576/// access can access the same memory as the potential reduction.
1577void ScopStmt::checkForReductions() {
1578 SmallVector<MemoryAccess *, 2> Loads;
1579 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1580
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001581 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001582 // stores and collecting possible reduction loads.
1583 for (MemoryAccess *StoreMA : MemAccs) {
1584 if (StoreMA->isRead())
1585 continue;
1586
1587 Loads.clear();
1588 collectCandiateReductionLoads(StoreMA, Loads);
1589 for (MemoryAccess *LoadMA : Loads)
1590 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1591 }
1592
1593 // Then check each possible candidate pair.
1594 for (const auto &CandidatePair : Candidates) {
1595 bool Valid = true;
1596 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1597 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1598
1599 // Skip those with obviously unequal base addresses.
1600 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1601 isl_map_free(LoadAccs);
1602 isl_map_free(StoreAccs);
1603 continue;
1604 }
1605
1606 // And check if the remaining for overlap with other memory accesses.
1607 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1608 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1609 isl_set *AllAccs = isl_map_range(AllAccsRel);
1610
1611 for (MemoryAccess *MA : MemAccs) {
1612 if (MA == CandidatePair.first || MA == CandidatePair.second)
1613 continue;
1614
1615 isl_map *AccRel =
1616 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1617 isl_set *Accs = isl_map_range(AccRel);
1618
1619 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1620 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1621 Valid = Valid && isl_set_is_empty(OverlapAccs);
1622 isl_set_free(OverlapAccs);
1623 }
1624 }
1625
1626 isl_set_free(AllAccs);
1627 if (!Valid)
1628 continue;
1629
Johannes Doerfertf6183392014-07-01 20:52:51 +00001630 const LoadInst *Load =
1631 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1632 MemoryAccess::ReductionType RT =
1633 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1634
Johannes Doerferte58a0122014-06-27 20:31:28 +00001635 // If no overlapping access was found we mark the load and store as
1636 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001637 CandidatePair.first->markAsReductionLike(RT);
1638 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001639 }
Tobias Grosser75805372011-04-29 06:27:02 +00001640}
1641
Tobias Grosser74394f02013-01-14 22:40:23 +00001642std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001643
Tobias Grosser54839312015-04-21 11:37:25 +00001644std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001645 auto *S = getSchedule();
1646 auto Str = stringFromIslObj(S);
1647 isl_map_free(S);
1648 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001649}
1650
Johannes Doerferta3519512016-04-23 13:02:23 +00001651void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1652 isl_set_free(InvalidDomain);
1653 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001654}
1655
Michael Kruse375cb5f2016-02-24 22:08:24 +00001656BasicBlock *ScopStmt::getEntryBlock() const {
1657 if (isBlockStmt())
1658 return getBasicBlock();
1659 return getRegion()->getEntry();
1660}
1661
Michael Kruse7b5caa42016-02-24 22:08:28 +00001662RegionNode *ScopStmt::getRegionNode() const {
1663 if (isRegionStmt())
1664 return getRegion()->getNode();
1665 return getParent()->getRegion().getBBNode(getBasicBlock());
1666}
1667
Tobias Grosser74394f02013-01-14 22:40:23 +00001668unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001669
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001670unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001671
Tobias Grosser75805372011-04-29 06:27:02 +00001672const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1673
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001674const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001675 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001676}
1677
Tobias Grosser74394f02013-01-14 22:40:23 +00001678isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001679
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001680__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001681
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001682__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001683 return isl_set_get_space(Domain);
1684}
1685
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001686__isl_give isl_id *ScopStmt::getDomainId() const {
1687 return isl_set_get_tuple_id(Domain);
1688}
Tobias Grossercd95b772012-08-30 11:49:38 +00001689
Johannes Doerfert7c013572016-04-12 09:57:34 +00001690ScopStmt::~ScopStmt() {
1691 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001692 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001693}
Tobias Grosser75805372011-04-29 06:27:02 +00001694
1695void ScopStmt::print(raw_ostream &OS) const {
1696 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001697 OS.indent(12) << "Domain :=\n";
1698
1699 if (Domain) {
1700 OS.indent(16) << getDomainStr() << ";\n";
1701 } else
1702 OS.indent(16) << "n/a\n";
1703
Tobias Grosser54839312015-04-21 11:37:25 +00001704 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001705
1706 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001707 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001708 } else
1709 OS.indent(16) << "n/a\n";
1710
Tobias Grosser083d3d32014-06-28 08:59:45 +00001711 for (MemoryAccess *Access : MemAccs)
1712 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001713}
1714
1715void ScopStmt::dump() const { print(dbgs()); }
1716
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001717void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001718 // Remove all memory accesses in @p InvMAs from this statement
1719 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001720 // MK_Value READs have no access instruction, hence would not be removed by
1721 // this function. However, it is only used for invariant LoadInst accesses,
1722 // its arguments are always affine, hence synthesizable, and therefore there
1723 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001724 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001725 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001726 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001727 };
1728 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1729 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001730 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001731 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001732}
1733
Tobias Grosser75805372011-04-29 06:27:02 +00001734//===----------------------------------------------------------------------===//
1735/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001736
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001737void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001738 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1739 isl_set_free(Context);
1740 Context = NewContext;
1741}
1742
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001743/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1744struct SCEVSensitiveParameterRewriter
1745 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1746 ValueToValueMap &VMap;
1747 ScalarEvolution &SE;
1748
1749public:
1750 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1751 : VMap(VMap), SE(SE) {}
1752
1753 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1754 ValueToValueMap &VMap) {
1755 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1756 return SSPR.visit(E);
1757 }
1758
1759 const SCEV *visit(const SCEV *E) {
1760 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1761 }
1762
1763 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1764
1765 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1766 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1767 }
1768
1769 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1770 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1771 }
1772
1773 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1774 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1775 }
1776
1777 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1778 SmallVector<const SCEV *, 4> Operands;
1779 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1780 Operands.push_back(visit(E->getOperand(i)));
1781 return SE.getAddExpr(Operands);
1782 }
1783
1784 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1785 SmallVector<const SCEV *, 4> Operands;
1786 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1787 Operands.push_back(visit(E->getOperand(i)));
1788 return SE.getMulExpr(Operands);
1789 }
1790
1791 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1792 SmallVector<const SCEV *, 4> Operands;
1793 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1794 Operands.push_back(visit(E->getOperand(i)));
1795 return SE.getSMaxExpr(Operands);
1796 }
1797
1798 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1799 SmallVector<const SCEV *, 4> Operands;
1800 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1801 Operands.push_back(visit(E->getOperand(i)));
1802 return SE.getUMaxExpr(Operands);
1803 }
1804
1805 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1806 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1807 }
1808
1809 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1810 auto *Start = visit(E->getStart());
1811 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1812 visit(E->getStepRecurrence(SE)),
1813 E->getLoop(), SCEV::FlagAnyWrap);
1814 return SE.getAddExpr(Start, AddRec);
1815 }
1816
1817 const SCEV *visitUnknown(const SCEVUnknown *E) {
1818 if (auto *NewValue = VMap.lookup(E->getValue()))
1819 return SE.getUnknown(NewValue);
1820 return E;
1821 }
1822};
1823
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001824const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001825 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001826}
1827
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001828void Scop::createParameterId(const SCEV *Parameter) {
1829 assert(Parameters.count(Parameter));
1830 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001831
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001832 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001833
Tobias Grosser8f99c162011-11-15 11:38:55 +00001834 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1835 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001836
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001837 // If this parameter references a specific Value and this value has a name
1838 // we use this name as it is likely to be unique and more useful than just
1839 // a number.
1840 if (Val->hasName())
1841 ParameterName = Val->getName();
1842 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001843 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001844 if (LoadOrigin->hasName()) {
1845 ParameterName += "_loaded_from_";
1846 ParameterName +=
1847 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1848 }
1849 }
1850 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001851
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001852 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1853 const_cast<void *>((const void *)Parameter));
1854 ParameterIds[Parameter] = Id;
1855}
1856
1857void Scop::addParams(const ParameterSetTy &NewParameters) {
1858 for (const SCEV *Parameter : NewParameters) {
1859 // Normalize the SCEV to get the representing element for an invariant load.
1860 Parameter = extractConstantFactor(Parameter, *SE).second;
1861 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1862
1863 if (Parameters.insert(Parameter))
1864 createParameterId(Parameter);
1865 }
1866}
1867
1868__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
1869 // Normalize the SCEV to get the representing element for an invariant load.
1870 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1871 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001872}
Tobias Grosser75805372011-04-29 06:27:02 +00001873
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001874__isl_give isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001875 isl_set *DomainContext = isl_union_set_params(getDomains());
1876 return isl_set_intersect_params(C, DomainContext);
1877}
1878
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001879void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1880 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001881 auto *R = &getRegion();
1882 auto &F = *R->getEntry()->getParent();
1883 for (auto &Assumption : AC.assumptions()) {
1884 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1885 if (!CI || CI->getNumArgOperands() != 1)
1886 continue;
1887 if (!DT.dominates(CI->getParent(), R->getEntry()))
1888 continue;
1889
Michael Kruse09eb4452016-03-03 22:10:47 +00001890 auto *L = LI.getLoopFor(CI->getParent());
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001891 auto *Val = CI->getArgOperand(0);
Johannes Doerfertf560b3d2016-04-25 13:33:07 +00001892 ParameterSetTy DetectedParams;
1893 if (!isAffineParamConstraint(Val, R, L, *SE, DetectedParams)) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001894 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1895 CI->getDebugLoc(),
1896 "Non-affine user assumption ignored.");
1897 continue;
1898 }
1899
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001900 // Collect all newly introduced parameters.
1901 ParameterSetTy NewParams;
1902 for (auto *Param : DetectedParams) {
1903 Param = extractConstantFactor(Param, *SE).second;
1904 Param = getRepresentingInvariantLoadSCEV(Param);
1905 if (Parameters.count(Param))
1906 continue;
1907 NewParams.insert(Param);
1908 }
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001909
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001910 SmallVector<isl_set *, 2> ConditionSets;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001911 buildConditionSets(*Stmts.begin(), Val, nullptr, L, Context, ConditionSets);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001912 assert(ConditionSets.size() == 2);
1913 isl_set_free(ConditionSets[1]);
1914
1915 auto *AssumptionCtx = ConditionSets[0];
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001916
1917 // Project out newly introduced parameters as they are not otherwise useful.
1918 if (!NewParams.empty()) {
1919 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
1920 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
1921 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
1922 isl_id_free(Id);
1923
1924 if (!NewParams.count(Param))
1925 continue;
1926
1927 AssumptionCtx =
1928 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
1929 }
1930 }
1931
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001932 emitOptimizationRemarkAnalysis(
1933 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1934 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1935 Context = isl_set_intersect(Context, AssumptionCtx);
1936 }
1937}
1938
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001939void Scop::addUserContext() {
1940 if (UserContextStr.empty())
1941 return;
1942
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001943 isl_set *UserContext =
1944 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001945 isl_space *Space = getParamSpace();
1946 if (isl_space_dim(Space, isl_dim_param) !=
1947 isl_set_dim(UserContext, isl_dim_param)) {
1948 auto SpaceStr = isl_space_to_str(Space);
1949 errs() << "Error: the context provided in -polly-context has not the same "
1950 << "number of dimensions than the computed context. Due to this "
1951 << "mismatch, the -polly-context option is ignored. Please provide "
1952 << "the context in the parameter space: " << SpaceStr << ".\n";
1953 free(SpaceStr);
1954 isl_set_free(UserContext);
1955 isl_space_free(Space);
1956 return;
1957 }
1958
1959 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001960 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1961 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001962
1963 if (strcmp(NameContext, NameUserContext) != 0) {
1964 auto SpaceStr = isl_space_to_str(Space);
1965 errs() << "Error: the name of dimension " << i
1966 << " provided in -polly-context "
1967 << "is '" << NameUserContext << "', but the name in the computed "
1968 << "context is '" << NameContext
1969 << "'. Due to this name mismatch, "
1970 << "the -polly-context option is ignored. Please provide "
1971 << "the context in the parameter space: " << SpaceStr << ".\n";
1972 free(SpaceStr);
1973 isl_set_free(UserContext);
1974 isl_space_free(Space);
1975 return;
1976 }
1977
1978 UserContext =
1979 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1980 isl_space_get_dim_id(Space, isl_dim_param, i));
1981 }
1982
1983 Context = isl_set_intersect(Context, UserContext);
1984 isl_space_free(Space);
1985}
1986
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001987void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001988 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001989
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001990 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001991 for (LoadInst *LInst : RIL) {
1992 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1993
Johannes Doerfert96e54712016-02-07 17:30:13 +00001994 Type *Ty = LInst->getType();
1995 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001996 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001997 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001998 continue;
1999 }
2000
2001 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00002002 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
2003 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002004 }
2005}
2006
Tobias Grosser6be480c2011-11-08 15:41:13 +00002007void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002008 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00002009 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002010 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00002011 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002012}
2013
Tobias Grosser18daaca2012-05-22 10:47:27 +00002014void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002015 unsigned PDim = 0;
2016 for (auto *Parameter : Parameters) {
2017 ConstantRange SRange = SE->getSignedRange(Parameter);
2018 Context = addRangeBoundsToSet(Context, SRange, PDim++, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00002019 }
2020}
2021
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002022void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002023 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002024 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002025
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002026 unsigned PDim = 0;
2027 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002028 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002029 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002030 }
2031
2032 // Align the parameters of all data structures to the model.
2033 Context = isl_set_align_params(Context, Space);
2034
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002035 for (ScopStmt &Stmt : *this)
2036 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002037}
2038
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002039static __isl_give isl_set *
2040simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2041 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002042 // If we modelt all blocks in the SCoP that have side effects we can simplify
2043 // the context with the constraints that are needed for anything to be
2044 // executed at all. However, if we have error blocks in the SCoP we already
2045 // assumed some parameter combinations cannot occure and removed them from the
2046 // domains, thus we cannot use the remaining domain to simplify the
2047 // assumptions.
2048 if (!S.hasErrorBlock()) {
2049 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2050 AssumptionContext =
2051 isl_set_gist_params(AssumptionContext, DomainParameters);
2052 }
2053
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002054 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2055 return AssumptionContext;
2056}
2057
2058void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002059 // The parameter constraints of the iteration domains give us a set of
2060 // constraints that need to hold for all cases where at least a single
2061 // statement iteration is executed in the whole scop. We now simplify the
2062 // assumed context under the assumption that such constraints hold and at
2063 // least a single statement iteration is executed. For cases where no
2064 // statement instances are executed, the assumptions we have taken about
2065 // the executed code do not matter and can be changed.
2066 //
2067 // WARNING: This only holds if the assumptions we have taken do not reduce
2068 // the set of statement instances that are executed. Otherwise we
2069 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002070 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002071 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002072 // performed. In such a case, modifying the run-time conditions and
2073 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002074 // to not be executed.
2075 //
2076 // Example:
2077 //
2078 // When delinearizing the following code:
2079 //
2080 // for (long i = 0; i < 100; i++)
2081 // for (long j = 0; j < m; j++)
2082 // A[i+p][j] = 1.0;
2083 //
2084 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002085 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002086 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002087 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002088 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002089}
2090
Johannes Doerfertb164c792014-09-18 11:17:17 +00002091/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00002092static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002093 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
2094 isl_pw_multi_aff *MinPMA, *MaxPMA;
2095 isl_pw_aff *LastDimAff;
2096 isl_aff *OneAff;
2097 unsigned Pos;
2098
Johannes Doerfert6296d952016-04-22 11:38:19 +00002099 Set = isl_set_remove_divs(Set);
2100
2101 if (isl_set_n_basic_set(Set) >= MaxConjunctsInDomain) {
2102 isl_set_free(Set);
2103 return isl_stat_error;
2104 }
2105
Johannes Doerfert9143d672014-09-27 11:02:39 +00002106 // Restrict the number of parameters involved in the access as the lexmin/
2107 // lexmax computation will take too long if this number is high.
2108 //
2109 // Experiments with a simple test case using an i7 4800MQ:
2110 //
2111 // #Parameters involved | Time (in sec)
2112 // 6 | 0.01
2113 // 7 | 0.04
2114 // 8 | 0.12
2115 // 9 | 0.40
2116 // 10 | 1.54
2117 // 11 | 6.78
2118 // 12 | 30.38
2119 //
2120 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
2121 unsigned InvolvedParams = 0;
2122 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
2123 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
2124 InvolvedParams++;
2125
2126 if (InvolvedParams > RunTimeChecksMaxParameters) {
2127 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002128 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002129 }
2130 }
2131
Johannes Doerfertb164c792014-09-18 11:17:17 +00002132 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2133 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2134
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002135 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2136 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2137
Johannes Doerfertb164c792014-09-18 11:17:17 +00002138 // Adjust the last dimension of the maximal access by one as we want to
2139 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2140 // we test during code generation might now point after the end of the
2141 // allocated array but we will never dereference it anyway.
2142 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2143 "Assumed at least one output dimension");
2144 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2145 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2146 OneAff = isl_aff_zero_on_domain(
2147 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2148 OneAff = isl_aff_add_constant_si(OneAff, 1);
2149 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2150 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2151
2152 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2153
2154 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002155 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002156}
2157
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002158static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2159 isl_set *Domain = MA->getStatement()->getDomain();
2160 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2161 return isl_set_reset_tuple_id(Domain);
2162}
2163
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002164/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2165static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002166 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002167 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002168
2169 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2170 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002171 Locations = isl_union_set_coalesce(Locations);
2172 Locations = isl_union_set_detect_equalities(Locations);
2173 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002174 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002175 isl_union_set_free(Locations);
2176 return Valid;
2177}
2178
Johannes Doerfert96425c22015-08-30 21:13:53 +00002179/// @brief Helper to treat non-affine regions and basic blocks the same.
2180///
2181///{
2182
2183/// @brief Return the block that is the representing block for @p RN.
2184static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2185 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2186 : RN->getNodeAs<BasicBlock>();
2187}
2188
2189/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002190static inline BasicBlock *
2191getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002192 if (RN->isSubRegion()) {
2193 assert(idx == 0);
2194 return RN->getNodeAs<Region>()->getExit();
2195 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002196 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002197}
2198
2199/// @brief Return the smallest loop surrounding @p RN.
2200static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2201 if (!RN->isSubRegion())
2202 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2203
2204 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2205 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2206 while (L && NonAffineSubRegion->contains(L))
2207 L = L->getParentLoop();
2208 return L;
2209}
2210
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002211static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2212 if (!RN->isSubRegion())
2213 return 1;
2214
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002215 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002216 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002217}
2218
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002219static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2220 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002221 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002222 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002223 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002224 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002225 return true;
2226 return false;
2227}
2228
Johannes Doerfert96425c22015-08-30 21:13:53 +00002229///}
2230
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002231static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2232 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002233 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002234 isl_id *DimId =
2235 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2236 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2237}
2238
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002239__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002240 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002241}
2242
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002243__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002244 auto DIt = DomainMap.find(BB);
2245 if (DIt != DomainMap.end())
2246 return isl_set_copy(DIt->getSecond());
2247
2248 auto &RI = *R.getRegionInfo();
2249 auto *BBR = RI.getRegionFor(BB);
2250 while (BBR->getEntry() == BB)
2251 BBR = BBR->getParent();
2252 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002253}
2254
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002255bool Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002256 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002257
Johannes Doerfert432658d2016-01-26 11:01:41 +00002258 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002259 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002260 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2261 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002262 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002263
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002264 while (LD-- >= 0) {
2265 S = addDomainDimId(S, LD + 1, L);
2266 L = L->getParentLoop();
2267 }
2268
Johannes Doerferta3519512016-04-23 13:02:23 +00002269 // Initialize the invalid domain.
2270 auto *EntryStmt = getStmtFor(EntryBB);
2271 EntryStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(S)));
2272
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002273 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002274
Johannes Doerfert432658d2016-01-26 11:01:41 +00002275 if (IsOnlyNonAffineRegion)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002276 return true;
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002277
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002278 if (!buildDomainsWithBranchConstraints(R, SD, DT, LI))
2279 return false;
2280
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002281 propagateDomainConstraints(R, SD, DT, LI);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002282
2283 // Error blocks and blocks dominated by them have been assumed to never be
2284 // executed. Representing them in the Scop does not add any value. In fact,
2285 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002286 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002287 // will cause problems when building up a ScopStmt for them.
2288 // Furthermore, basic blocks dominated by error blocks may reference
2289 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002290 // can themselves not be constructed properly. To this end we will replace
2291 // the domains of error blocks and those only reachable via error blocks
2292 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002293 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002294 // InvalidDomain. This information is needed during load hoisting.
2295 propagateInvalidStmtDomains(R, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002296
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002297 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002298}
2299
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002300static Loop *
2301getFirstNonBoxedLoopFor(BasicBlock *BB, LoopInfo &LI,
2302 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
2303 auto *L = LI.getLoopFor(BB);
2304 while (BoxedLoops.count(L))
2305 L = L->getParentLoop();
2306 return L;
2307}
2308
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002309/// @brief Adjust the dimensions of @p Dom that was constructed for @p OldL
2310/// to be compatible to domains constructed for loop @p NewL.
2311///
2312/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2313/// edge from @p OldL to @p NewL.
2314static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2315 __isl_take isl_set *Dom,
2316 Loop *OldL, Loop *NewL) {
2317
2318 // If the loops are the same there is nothing to do.
2319 if (NewL == OldL)
2320 return Dom;
2321
2322 int OldDepth = S.getRelativeLoopDepth(OldL);
2323 int NewDepth = S.getRelativeLoopDepth(NewL);
2324 // If both loops are non-affine loops there is nothing to do.
2325 if (OldDepth == -1 && NewDepth == -1)
2326 return Dom;
2327
2328 // Distinguish three cases:
2329 // 1) The depth is the same but the loops are not.
2330 // => One loop was left one was entered.
2331 // 2) The depth increased from OldL to NewL.
2332 // => One loop was entered, none was left.
2333 // 3) The depth decreased from OldL to NewL.
2334 // => Loops were left were difference of the depths defines how many.
2335 if (OldDepth == NewDepth) {
2336 assert(OldL->getParentLoop() == NewL->getParentLoop());
2337 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2338 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2339 Dom = addDomainDimId(Dom, NewDepth, NewL);
2340 } else if (OldDepth < NewDepth) {
2341 assert(OldDepth + 1 == NewDepth);
2342 auto &R = S.getRegion();
2343 (void)R;
2344 assert(NewL->getParentLoop() == OldL ||
2345 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2346 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2347 Dom = addDomainDimId(Dom, NewDepth, NewL);
2348 } else {
2349 assert(OldDepth > NewDepth);
2350 int Diff = OldDepth - NewDepth;
2351 int NumDim = isl_set_n_dim(Dom);
2352 assert(NumDim >= Diff);
2353 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2354 }
2355
2356 return Dom;
2357}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002358
Johannes Doerferta3519512016-04-23 13:02:23 +00002359void Scop::propagateInvalidStmtDomains(Region *R, ScopDetection &SD,
2360 DominatorTree &DT, LoopInfo &LI) {
2361 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002362
2363 ReversePostOrderTraversal<Region *> RTraversal(R);
2364 for (auto *RN : RTraversal) {
2365
2366 // Recurse for affine subregions but go on for basic blocks and non-affine
2367 // subregions.
2368 if (RN->isSubRegion()) {
2369 Region *SubRegion = RN->getNodeAs<Region>();
2370 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerferta3519512016-04-23 13:02:23 +00002371 propagateInvalidStmtDomains(SubRegion, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002372 continue;
2373 }
2374 }
2375
2376 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2377 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002378 ScopStmt *Stmt = getStmtFor(BB);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002379 isl_set *&Domain = DomainMap[BB];
2380 assert(Domain && "Cannot propagate a nullptr");
2381
Johannes Doerferta3519512016-04-23 13:02:23 +00002382 auto *InvalidDomain = Stmt->getInvalidDomain();
Johannes Doerfert7c013572016-04-12 09:57:34 +00002383 bool IsInvalidBlock =
Johannes Doerferta3519512016-04-23 13:02:23 +00002384 ContainsErrorBlock || isl_set_is_subset(Domain, InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002385
Johannes Doerferta3519512016-04-23 13:02:23 +00002386 if (!IsInvalidBlock) {
2387 InvalidDomain = isl_set_intersect(InvalidDomain, isl_set_copy(Domain));
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002388 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002389 isl_set_free(InvalidDomain);
2390 InvalidDomain = Domain;
2391 auto *EmptyDom = isl_set_empty(isl_set_get_space(InvalidDomain));
2392 Domain = EmptyDom;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002393 }
2394
Johannes Doerferta3519512016-04-23 13:02:23 +00002395 if (isl_set_is_empty(InvalidDomain)) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00002396 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002397 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002398 }
2399
Johannes Doerferta3519512016-04-23 13:02:23 +00002400 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002401 auto *TI = BB->getTerminator();
2402 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2403 for (unsigned u = 0; u < NumSuccs; u++) {
2404 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002405 auto *SuccStmt = getStmtFor(SuccBB);
2406
2407 // Skip successors outside the SCoP.
2408 if (!SuccStmt)
2409 continue;
2410
Johannes Doerferte4459a22016-04-25 13:34:50 +00002411 // Skip backedges.
2412 if (DT.dominates(SuccBB, BB))
2413 continue;
2414
Johannes Doerferta3519512016-04-23 13:02:23 +00002415 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
2416 auto *AdjustedInvalidDomain = adjustDomainDimensions(
2417 *this, isl_set_copy(InvalidDomain), BBLoop, SuccBBLoop);
2418 auto *SuccInvalidDomain = SuccStmt->getInvalidDomain();
2419 SuccInvalidDomain =
2420 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2421 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2422 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
2423 SuccStmt->setInvalidDomain(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002424
2425 // Check if the maximal number of domain conjuncts was reached.
2426 // In case this happens we will bail.
Johannes Doerfert7c013572016-04-12 09:57:34 +00002427 if (NumConjucts < MaxConjunctsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002428 continue;
2429
Johannes Doerferta3519512016-04-23 13:02:23 +00002430 isl_set_free(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002431 invalidate(COMPLEXITY, TI->getDebugLoc());
2432 return;
2433 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002434
2435 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002436 }
2437}
2438
Johannes Doerfert642594a2016-04-04 07:57:39 +00002439void Scop::propagateDomainConstraintsToRegionExit(
2440 BasicBlock *BB, Loop *BBLoop,
2441 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, ScopDetection &SD,
2442 LoopInfo &LI) {
2443
2444 // Check if the block @p BB is the entry of a region. If so we propagate it's
2445 // domain to the exit block of the region. Otherwise we are done.
2446 auto *RI = R.getRegionInfo();
2447 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2448 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
2449 if (!BBReg || BBReg->getEntry() != BB || !R.contains(ExitBB))
2450 return;
2451
2452 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2453 // Do not propagate the domain if there is a loop backedge inside the region
2454 // that would prevent the exit block from beeing executed.
2455 auto *L = BBLoop;
2456 while (L && R.contains(L)) {
2457 SmallVector<BasicBlock *, 4> LatchBBs;
2458 BBLoop->getLoopLatches(LatchBBs);
2459 for (auto *LatchBB : LatchBBs)
2460 if (BB != LatchBB && BBReg->contains(LatchBB))
2461 return;
2462 L = L->getParentLoop();
2463 }
2464
2465 auto *Domain = DomainMap[BB];
2466 assert(Domain && "Cannot propagate a nullptr");
2467
2468 auto *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, BoxedLoops);
2469
2470 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2471 // adjust the domain before we can propagate it.
2472 auto *AdjustedDomain =
2473 adjustDomainDimensions(*this, isl_set_copy(Domain), BBLoop, ExitBBLoop);
2474 auto *&ExitDomain = DomainMap[ExitBB];
2475
2476 // If the exit domain is not yet created we set it otherwise we "add" the
2477 // current domain.
2478 ExitDomain =
2479 ExitDomain ? isl_set_union(AdjustedDomain, ExitDomain) : AdjustedDomain;
2480
Johannes Doerferta3519512016-04-23 13:02:23 +00002481 // Initialize the invalid domain.
2482 auto *ExitStmt = getStmtFor(ExitBB);
2483 ExitStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(ExitDomain)));
2484
Johannes Doerfert642594a2016-04-04 07:57:39 +00002485 FinishedExitBlocks.insert(ExitBB);
2486}
2487
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002488bool Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002489 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002490 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002491
2492 // To create the domain for each block in R we iterate over all blocks and
2493 // subregions in R and propagate the conditions under which the current region
2494 // element is executed. To this end we iterate in reverse post order over R as
2495 // it ensures that we first visit all predecessors of a region node (either a
2496 // basic block or a subregion) before we visit the region node itself.
2497 // Initially, only the domain for the SCoP region entry block is set and from
2498 // there we propagate the current domain to all successors, however we add the
2499 // condition that the successor is actually executed next.
2500 // As we are only interested in non-loop carried constraints here we can
2501 // simply skip loop back edges.
2502
Johannes Doerfert642594a2016-04-04 07:57:39 +00002503 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002504 ReversePostOrderTraversal<Region *> RTraversal(R);
2505 for (auto *RN : RTraversal) {
2506
2507 // Recurse for affine subregions but go on for basic blocks and non-affine
2508 // subregions.
2509 if (RN->isSubRegion()) {
2510 Region *SubRegion = RN->getNodeAs<Region>();
2511 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002512 if (!buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI))
2513 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002514 continue;
2515 }
2516 }
2517
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002518 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002519 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002520
Johannes Doerfert96425c22015-08-30 21:13:53 +00002521 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002522 TerminatorInst *TI = BB->getTerminator();
2523
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002524 if (isa<UnreachableInst>(TI))
2525 continue;
2526
Johannes Doerfertf5673802015-10-01 23:48:18 +00002527 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002528 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002529 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002530
Johannes Doerfert642594a2016-04-04 07:57:39 +00002531 auto *BBLoop = getRegionNodeLoop(RN, LI);
2532 // Propagate the domain from BB directly to blocks that have a superset
2533 // domain, at the moment only region exit nodes of regions that start in BB.
2534 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, SD,
2535 LI);
2536
2537 // If all successors of BB have been set a domain through the propagation
2538 // above we do not need to build condition sets but can just skip this
2539 // block. However, it is important to note that this is a local property
2540 // with regards to the region @p R. To this end FinishedExitBlocks is a
2541 // local variable.
2542 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2543 return FinishedExitBlocks.count(SuccBB);
2544 };
2545 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2546 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002547
2548 // Build the condition sets for the successor nodes of the current region
2549 // node. If it is a non-affine subregion we will always execute the single
2550 // exit node, hence the single entry node domain is the condition set. For
2551 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002552 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002553 if (RN->isSubRegion())
2554 ConditionSets.push_back(isl_set_copy(Domain));
2555 else
Johannes Doerfert171b92f2016-04-19 14:53:13 +00002556 buildConditionSets(*getStmtFor(BB), TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002557
2558 // Now iterate over the successors and set their initial domain based on
2559 // their condition set. We skip back edges here and have to be careful when
2560 // we leave a loop not to keep constraints over a dimension that doesn't
2561 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002562 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002563 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002564 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002565 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002566
Johannes Doerfert535de032016-04-19 14:49:05 +00002567 auto *SuccStmt = getStmtFor(SuccBB);
2568 // Skip blocks outside the region.
2569 if (!SuccStmt) {
2570 isl_set_free(CondSet);
2571 continue;
2572 }
2573
Johannes Doerfert642594a2016-04-04 07:57:39 +00002574 // If we propagate the domain of some block to "SuccBB" we do not have to
2575 // adjust the domain.
2576 if (FinishedExitBlocks.count(SuccBB)) {
2577 isl_set_free(CondSet);
2578 continue;
2579 }
2580
Johannes Doerfert96425c22015-08-30 21:13:53 +00002581 // Skip back edges.
2582 if (DT.dominates(SuccBB, BB)) {
2583 isl_set_free(CondSet);
2584 continue;
2585 }
2586
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002587 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002588 CondSet = adjustDomainDimensions(*this, CondSet, BBLoop, SuccBBLoop);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002589
2590 // Set the domain for the successor or merge it with an existing domain in
2591 // case there are multiple paths (without loop back edges) to the
2592 // successor block.
2593 isl_set *&SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002594
Johannes Doerferta3519512016-04-23 13:02:23 +00002595 if (SuccDomain) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002596 SuccDomain = isl_set_coalesce(isl_set_union(SuccDomain, CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00002597 } else {
2598 // Initialize the invalid domain.
2599 SuccStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(CondSet)));
2600 SuccDomain = CondSet;
2601 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002602
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002603 // Check if the maximal number of domain conjuncts was reached.
2604 // In case this happens we will clean up and bail.
Johannes Doerfert15194912016-04-04 07:59:41 +00002605 if (isl_set_n_basic_set(SuccDomain) < MaxConjunctsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002606 continue;
2607
2608 invalidate(COMPLEXITY, DebugLoc());
2609 while (++u < ConditionSets.size())
2610 isl_set_free(ConditionSets[u]);
2611 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002612 }
2613 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002614
2615 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002616}
2617
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00002618__isl_give isl_set *Scop::getPredecessorDomainConstraints(BasicBlock *BB,
2619 isl_set *Domain,
2620 ScopDetection &SD,
2621 DominatorTree &DT,
2622 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002623 // If @p BB is the ScopEntry we are done
2624 if (R.getEntry() == BB)
2625 return isl_set_universe(isl_set_get_space(Domain));
2626
2627 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2628 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2629
2630 // The region info of this function.
2631 auto &RI = *R.getRegionInfo();
2632
2633 auto *BBLoop = getFirstNonBoxedLoopFor(BB, LI, BoxedLoops);
2634
2635 // A domain to collect all predecessor domains, thus all conditions under
2636 // which the block is executed. To this end we start with the empty domain.
2637 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2638
2639 // Set of regions of which the entry block domain has been propagated to BB.
2640 // all predecessors inside any of the regions can be skipped.
2641 SmallSet<Region *, 8> PropagatedRegions;
2642
2643 for (auto *PredBB : predecessors(BB)) {
2644 // Skip backedges.
2645 if (DT.dominates(BB, PredBB))
2646 continue;
2647
2648 // If the predecessor is in a region we used for propagation we can skip it.
2649 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2650 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2651 PredBBInRegion)) {
2652 continue;
2653 }
2654
2655 // Check if there is a valid region we can use for propagation, thus look
2656 // for a region that contains the predecessor and has @p BB as exit block.
2657 auto *PredR = RI.getRegionFor(PredBB);
2658 while (PredR->getExit() != BB && !PredR->contains(BB))
2659 PredR->getParent();
2660
2661 // If a valid region for propagation was found use the entry of that region
2662 // for propagation, otherwise the PredBB directly.
2663 if (PredR->getExit() == BB) {
2664 PredBB = PredR->getEntry();
2665 PropagatedRegions.insert(PredR);
2666 }
2667
Johannes Doerfert41cda152016-04-08 10:32:26 +00002668 auto *PredBBDom = getDomainConditions(PredBB);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002669 auto *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, BoxedLoops);
2670 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2671
2672 PredDom = isl_set_union(PredDom, PredBBDom);
2673 }
2674
2675 return PredDom;
2676}
2677
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002678void Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002679 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002680 // Iterate over the region R and propagate the domain constrains from the
2681 // predecessors to the current node. In contrast to the
2682 // buildDomainsWithBranchConstraints function, this one will pull the domain
2683 // information from the predecessors instead of pushing it to the successors.
2684 // Additionally, we assume the domains to be already present in the domain
2685 // map here. However, we iterate again in reverse post order so we know all
2686 // predecessors have been visited before a block or non-affine subregion is
2687 // visited.
2688
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002689 ReversePostOrderTraversal<Region *> RTraversal(R);
2690 for (auto *RN : RTraversal) {
2691
2692 // Recurse for affine subregions but go on for basic blocks and non-affine
2693 // subregions.
2694 if (RN->isSubRegion()) {
2695 Region *SubRegion = RN->getNodeAs<Region>();
2696 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002697 propagateDomainConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002698 continue;
2699 }
2700 }
2701
2702 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002703 isl_set *&Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002704 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002705
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002706 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002707 auto *PredDom = getPredecessorDomainConstraints(BB, Domain, SD, DT, LI);
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002708 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002709 Domain = isl_set_align_params(Domain, getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002710
Johannes Doerfert642594a2016-04-04 07:57:39 +00002711 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002712 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002713 addLoopBoundsToHeaderDomain(BBLoop, LI);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002714
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002715 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002716 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002717 IsOptimized = true;
2718 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002719 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2720 AS_RESTRICTION);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002721 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002722 }
2723}
2724
2725/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2726/// is incremented by one and all other dimensions are equal, e.g.,
2727/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2728/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2729static __isl_give isl_map *
2730createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2731 auto *MapSpace = isl_space_map_from_set(SetSpace);
2732 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2733 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2734 if (u != Dim)
2735 NextIterationMap =
2736 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2737 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2738 C = isl_constraint_set_constant_si(C, 1);
2739 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2740 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2741 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2742 return NextIterationMap;
2743}
2744
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002745void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002746 int LoopDepth = getRelativeLoopDepth(L);
2747 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002748
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002749 BasicBlock *HeaderBB = L->getHeader();
2750 assert(DomainMap.count(HeaderBB));
2751 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002752
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002753 isl_map *NextIterationMap =
2754 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002755
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002756 isl_set *UnionBackedgeCondition =
2757 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002758
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002759 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2760 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002761
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002762 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002763
2764 // If the latch is only reachable via error statements we skip it.
2765 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2766 if (!LatchBBDom)
2767 continue;
2768
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002769 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002770
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002771 TerminatorInst *TI = LatchBB->getTerminator();
2772 BranchInst *BI = dyn_cast<BranchInst>(TI);
2773 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002774 BackedgeCondition = isl_set_copy(LatchBBDom);
2775 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002776 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002777 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00002778 buildConditionSets(*getStmtFor(LatchBB), TI, L, LatchBBDom,
2779 ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002780
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002781 // Free the non back edge condition set as we do not need it.
2782 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002783
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002784 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002785 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002786
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002787 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2788 assert(LatchLoopDepth >= LoopDepth);
2789 BackedgeCondition =
2790 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2791 LatchLoopDepth - LoopDepth);
2792 UnionBackedgeCondition =
2793 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002794 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002795
2796 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2797 for (int i = 0; i < LoopDepth; i++)
2798 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2799
2800 isl_set *UnionBackedgeConditionComplement =
2801 isl_set_complement(UnionBackedgeCondition);
2802 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2803 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2804 UnionBackedgeConditionComplement =
2805 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2806 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2807 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2808
2809 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2810 HeaderBBDom = Parts.second;
2811
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002812 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2813 // the bounded assumptions to the context as they are already implied by the
2814 // <nsw> tag.
2815 if (Affinator.hasNSWAddRecForLoop(L)) {
2816 isl_set_free(Parts.first);
2817 return;
2818 }
2819
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002820 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002821 recordAssumption(INFINITELOOP, UnboundedCtx,
2822 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002823}
2824
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002825void Scop::buildAliasChecks(AliasAnalysis &AA) {
2826 if (!PollyUseRuntimeAliasChecks)
2827 return;
2828
2829 if (buildAliasGroups(AA))
2830 return;
2831
2832 // If a problem occurs while building the alias groups we need to delete
2833 // this SCoP and pretend it wasn't valid in the first place. To this end
2834 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002835 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002836
2837 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2838 << " could not be created as the number of parameters involved "
2839 "is too high. The SCoP will be "
2840 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2841 "the maximal number of parameters but be advised that the "
2842 "compile time might increase exponentially.\n\n");
2843}
2844
Johannes Doerfert9143d672014-09-27 11:02:39 +00002845bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002846 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002847 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002848 // for all memory accesses inside the SCoP.
2849 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002850 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002851 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002852 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002853 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002854 // if their access domains intersect, otherwise they are in different
2855 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002856 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002857 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002858 // and maximal accesses to each array of a group in read only and non
2859 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002860 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2861
2862 AliasSetTracker AST(AA);
2863
2864 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002865 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002866 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002867
2868 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002869 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002870 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2871 isl_set_free(StmtDomain);
2872 if (StmtDomainEmpty)
2873 continue;
2874
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002875 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002876 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002877 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002878 if (!MA->isRead())
2879 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002880 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00002881 if (MA->isRead() && isa<MemTransferInst>(Acc))
2882 PtrToAcc[cast<MemTransferInst>(Acc)->getSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00002883 else
2884 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002885 AST.add(Acc);
2886 }
2887 }
2888
2889 SmallVector<AliasGroupTy, 4> AliasGroups;
2890 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002891 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002892 continue;
2893 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002894 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002895 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002896 if (AG.size() < 2)
2897 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002898 AliasGroups.push_back(std::move(AG));
2899 }
2900
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002901 // Split the alias groups based on their domain.
2902 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2903 AliasGroupTy NewAG;
2904 AliasGroupTy &AG = AliasGroups[u];
2905 AliasGroupTy::iterator AGI = AG.begin();
2906 isl_set *AGDomain = getAccessDomain(*AGI);
2907 while (AGI != AG.end()) {
2908 MemoryAccess *MA = *AGI;
2909 isl_set *MADomain = getAccessDomain(MA);
2910 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2911 NewAG.push_back(MA);
2912 AGI = AG.erase(AGI);
2913 isl_set_free(MADomain);
2914 } else {
2915 AGDomain = isl_set_union(AGDomain, MADomain);
2916 AGI++;
2917 }
2918 }
2919 if (NewAG.size() > 1)
2920 AliasGroups.push_back(std::move(NewAG));
2921 isl_set_free(AGDomain);
2922 }
2923
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002924 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002925 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002926 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2927 for (AliasGroupTy &AG : AliasGroups) {
2928 NonReadOnlyBaseValues.clear();
2929 ReadOnlyPairs.clear();
2930
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002931 if (AG.size() < 2) {
2932 AG.clear();
2933 continue;
2934 }
2935
Johannes Doerfert13771732014-10-01 12:40:46 +00002936 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002937 emitOptimizationRemarkAnalysis(
2938 F.getContext(), DEBUG_TYPE, F,
2939 (*II)->getAccessInstruction()->getDebugLoc(),
2940 "Possibly aliasing pointer, use restrict keyword.");
2941
Johannes Doerfert13771732014-10-01 12:40:46 +00002942 Value *BaseAddr = (*II)->getBaseAddr();
2943 if (HasWriteAccess.count(BaseAddr)) {
2944 NonReadOnlyBaseValues.insert(BaseAddr);
2945 II++;
2946 } else {
2947 ReadOnlyPairs[BaseAddr].insert(*II);
2948 II = AG.erase(II);
2949 }
2950 }
2951
2952 // If we don't have read only pointers check if there are at least two
2953 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002954 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002955 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002956 continue;
2957 }
2958
2959 // If we don't have non read only pointers clear the alias group.
2960 if (NonReadOnlyBaseValues.empty()) {
2961 AG.clear();
2962 continue;
2963 }
2964
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002965 // Check if we have non-affine accesses left, if so bail out as we cannot
2966 // generate a good access range yet.
2967 for (auto *MA : AG)
2968 if (!MA->isAffine()) {
2969 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2970 return false;
2971 }
2972 for (auto &ReadOnlyPair : ReadOnlyPairs)
2973 for (auto *MA : ReadOnlyPair.second)
2974 if (!MA->isAffine()) {
2975 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2976 return false;
2977 }
2978
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002979 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002980 MinMaxAliasGroups.emplace_back();
2981 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2982 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2983 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2984 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002985
2986 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002987
2988 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002989 for (MemoryAccess *MA : AG)
2990 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002991
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002992 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2993 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002994
2995 // Bail out if the number of values we need to compare is too large.
2996 // This is important as the number of comparisions grows quadratically with
2997 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002998 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2999 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003000 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003001
3002 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003003 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003004 Accesses = isl_union_map_empty(getParamSpace());
3005
3006 for (const auto &ReadOnlyPair : ReadOnlyPairs)
3007 for (MemoryAccess *MA : ReadOnlyPair.second)
3008 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
3009
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00003010 Valid =
3011 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00003012
3013 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003014 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003015 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003016
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003017 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003018}
3019
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003020/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003021static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003022 // Start with the smallest loop containing the entry and expand that
3023 // loop until it contains all blocks in the region. If there is a loop
3024 // containing all blocks in the region check if it is itself contained
3025 // and if so take the parent loop as it will be the smallest containing
3026 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003027 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003028 while (L) {
3029 bool AllContained = true;
3030 for (auto *BB : R.blocks())
3031 AllContained &= L->contains(BB);
3032 if (AllContained)
3033 break;
3034 L = L->getParentLoop();
3035 }
3036
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003037 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
3038}
3039
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003040static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
3041 ScopDetection &SD) {
3042
3043 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
3044
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003045 unsigned MinLD = INT_MAX, MaxLD = 0;
3046 for (BasicBlock *BB : R.blocks()) {
3047 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00003048 if (!R.contains(L))
3049 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003050 if (BoxedLoops && BoxedLoops->count(L))
3051 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003052 unsigned LD = L->getLoopDepth();
3053 MinLD = std::min(MinLD, LD);
3054 MaxLD = std::max(MaxLD, LD);
3055 }
3056 }
3057
3058 // Handle the case that there is no loop in the SCoP first.
3059 if (MaxLD == 0)
3060 return 1;
3061
3062 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
3063 assert(MaxLD >= MinLD &&
3064 "Maximal loop depth was smaller than mininaml loop depth?");
3065 return MaxLD - MinLD + 1;
3066}
3067
Michael Kruse09eb4452016-03-03 22:10:47 +00003068Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
3069 unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00003070 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003071 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003072 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
3073 Context(nullptr), Affinator(this, LI), AssumedContext(nullptr),
3074 InvalidContext(nullptr), Schedule(nullptr) {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003075 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003076 buildContext();
3077}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003078
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00003079void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003080 DominatorTree &DT, LoopInfo &LI) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003081 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003082
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003083 if (!buildDomains(&R, SD, DT, LI))
3084 return;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003085
Johannes Doerfertff68f462016-04-19 14:49:42 +00003086 addUserAssumptions(AC, DT, LI);
3087
Michael Krusecac948e2015-10-02 13:53:07 +00003088 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00003089 // Exit early in case there are no executable statements left in this scop.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003090 simplifySCoP(true, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00003091 if (Stmts.empty())
3092 return;
Tobias Grosser75805372011-04-29 06:27:02 +00003093
Michael Krusecac948e2015-10-02 13:53:07 +00003094 // The ScopStmts now have enough information to initialize themselves.
3095 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003096 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00003097
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003098 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003099
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003100 if (!hasFeasibleRuntimeContext())
Tobias Grosser8286b832015-11-02 11:29:32 +00003101 return;
3102
3103 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00003104 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00003105 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00003106 addUserContext();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003107
3108 // After the context was fully constructed, thus all our knowledge about
3109 // the parameters is in there, we add all recorded assumptions to the
3110 // assumed/invalid context.
3111 addRecordedAssumptions();
3112
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003113 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003114 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003115
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003116 hoistInvariantLoads(SD);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003117 verifyInvariantLoads(SD);
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003118 simplifySCoP(false, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003119}
3120
3121Scop::~Scop() {
3122 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003123 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003124 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003125 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003126
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003127 for (auto &It : ParameterIds)
3128 isl_id_free(It.second);
3129
Johannes Doerfert96425c22015-08-30 21:13:53 +00003130 for (auto It : DomainMap)
3131 isl_set_free(It.second);
3132
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003133 for (auto &AS : RecordedAssumptions)
3134 isl_set_free(AS.Set);
3135
Johannes Doerfertb164c792014-09-18 11:17:17 +00003136 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003137 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003138 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003139 isl_pw_multi_aff_free(MMA.first);
3140 isl_pw_multi_aff_free(MMA.second);
3141 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003142 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003143 isl_pw_multi_aff_free(MMA.first);
3144 isl_pw_multi_aff_free(MMA.second);
3145 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003146 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003147
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003148 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003149 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003150
3151 // Explicitly release all Scop objects and the underlying isl objects before
3152 // we relase the isl context.
3153 Stmts.clear();
3154 ScopArrayInfoMap.clear();
3155 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003156}
3157
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003158void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003159 // Check all array accesses for each base pointer and find a (virtual) element
3160 // size for the base pointer that divides all access functions.
3161 for (auto &Stmt : *this)
3162 for (auto *Access : Stmt) {
3163 if (!Access->isArrayKind())
3164 continue;
3165 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
3166 ScopArrayInfo::MK_Array)];
3167 if (SAI->getNumberOfDimensions() != 1)
3168 continue;
3169 unsigned DivisibleSize = SAI->getElemSizeInBytes();
3170 auto *Subscript = Access->getSubscript(0);
3171 while (!isDivisible(Subscript, DivisibleSize, *SE))
3172 DivisibleSize /= 2;
3173 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
3174 SAI->updateElementType(Ty);
3175 }
3176
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003177 for (auto &Stmt : *this)
3178 for (auto &Access : Stmt)
3179 Access->updateDimensionality();
3180}
3181
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003182void Scop::simplifySCoP(bool RemoveIgnoredStmts, DominatorTree &DT,
3183 LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003184 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3185 ScopStmt &Stmt = *StmtIt;
Michael Kruse7b5caa42016-02-24 22:08:28 +00003186 RegionNode *RN = Stmt.getRegionNode();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003187
Johannes Doerferteca9e892015-11-03 16:54:49 +00003188 bool RemoveStmt = StmtIt->isEmpty();
3189 if (!RemoveStmt)
Michael Kruse375cb5f2016-02-24 22:08:24 +00003190 RemoveStmt = isl_set_is_empty(DomainMap[Stmt.getEntryBlock()]);
Johannes Doerferteca9e892015-11-03 16:54:49 +00003191 if (!RemoveStmt)
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003192 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN, DT, LI));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003193
Johannes Doerferteca9e892015-11-03 16:54:49 +00003194 // Remove read only statements only after invariant loop hoisting.
3195 if (!RemoveStmt && !RemoveIgnoredStmts) {
3196 bool OnlyRead = true;
3197 for (MemoryAccess *MA : Stmt) {
3198 if (MA->isRead())
3199 continue;
3200
3201 OnlyRead = false;
3202 break;
3203 }
3204
3205 RemoveStmt = OnlyRead;
3206 }
3207
3208 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00003209 // Remove the statement because it is unnecessary.
3210 if (Stmt.isRegionStmt())
3211 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3212 StmtMap.erase(BB);
3213 else
3214 StmtMap.erase(Stmt.getBasicBlock());
3215
3216 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003217 continue;
3218 }
3219
Michael Krusecac948e2015-10-02 13:53:07 +00003220 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003221 }
3222}
3223
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003224InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003225 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3226 if (!LInst)
3227 return nullptr;
3228
3229 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3230 LInst = cast<LoadInst>(Rep);
3231
Johannes Doerfert96e54712016-02-07 17:30:13 +00003232 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003233 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003234 for (auto &IAClass : InvariantEquivClasses) {
3235 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
3236 continue;
3237
3238 auto &MAs = std::get<1>(IAClass);
3239 for (auto *MA : MAs)
3240 if (MA->getAccessInstruction() == Val)
3241 return &IAClass;
3242 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003243
3244 return nullptr;
3245}
3246
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003247/// @brief Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003248static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3249 bool MAInvalidCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003250 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3251 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3252 // TODO: We can provide more information for better but more expensive
3253 // results.
3254 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3255 LInst->getAlignment(), DL))
3256 return false;
3257
3258 // If a dereferencable load is in a statement that is modeled precisely we can
3259 // hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003260 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003261 return true;
3262
3263 // Even if the statement is not modeled precisely we can hoist the load if it
3264 // does not involve any parameters that might have been specilized by the
3265 // statement domain.
3266 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3267 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3268 return false;
3269 return true;
3270}
3271
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003272void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
3273
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003274 if (InvMAs.empty())
3275 return;
3276
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003277 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003278 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003279
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003280 // Get the context under which the statement is executed but remove the error
3281 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003282 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003283 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003284
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003285 if (isl_set_n_basic_set(DomainCtx) >= MaxConjunctsInDomain) {
3286 auto *AccInst = InvMAs.front()->getAccessInstruction();
3287 invalidate(COMPLEXITY, AccInst->getDebugLoc());
3288 isl_set_free(DomainCtx);
3289 return;
3290 }
3291
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003292 // Project out all parameters that relate to loads in the statement. Otherwise
3293 // we could have cyclic dependences on the constraints under which the
3294 // hoisted loads are executed and we could not determine an order in which to
3295 // pre-load them. This happens because not only lower bounds are part of the
3296 // domain but also upper bounds.
3297 for (MemoryAccess *MA : InvMAs) {
3298 Instruction *AccInst = MA->getAccessInstruction();
3299 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003300 SetVector<Value *> Values;
3301 for (const SCEV *Parameter : Parameters) {
3302 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003303 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003304 if (!Values.count(AccInst))
3305 continue;
3306
3307 if (isl_id *ParamId = getIdForParam(Parameter)) {
3308 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
3309 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
3310 isl_id_free(ParamId);
3311 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003312 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003313 }
3314 }
3315
3316 for (MemoryAccess *MA : InvMAs) {
3317 // Check for another invariant access that accesses the same location as
3318 // MA and if found consolidate them. Otherwise create a new equivalence
3319 // class at the end of InvariantEquivClasses.
3320 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003321 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003322 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3323
Johannes Doerfert85676e32016-04-23 14:32:34 +00003324 auto *MAInvalidCtx = MA->getInvalidContext();
3325 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3326
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003327 isl_set *MACtx;
3328 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003329 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003330 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003331 isl_set_free(MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003332 } else {
3333 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003334 MACtx = isl_set_subtract(MACtx, MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003335 MACtx = isl_set_gist_params(MACtx, getContext());
3336 }
3337
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003338 bool Consolidated = false;
3339 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00003340 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003341 continue;
3342
Johannes Doerfertdf880232016-03-03 12:26:58 +00003343 // If the pointer and the type is equal check if the access function wrt.
3344 // to the domain is equal too. It can happen that the domain fixes
3345 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003346 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003347 // create a new invariant load equivalence class.
3348 auto &MAs = std::get<1>(IAClass);
3349 if (!MAs.empty()) {
3350 auto *LastMA = MAs.front();
3351
3352 auto *AR = isl_map_range(MA->getAccessRelation());
3353 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3354 bool SameAR = isl_set_is_equal(AR, LastAR);
3355 isl_set_free(AR);
3356 isl_set_free(LastAR);
3357
3358 if (!SameAR)
3359 continue;
3360 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003361
3362 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003363 MAs.push_front(MA);
3364
Johannes Doerfertdf880232016-03-03 12:26:58 +00003365 Consolidated = true;
3366
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003367 // Unify the execution context of the class and this statement.
3368 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003369 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003370 IAClassDomainCtx =
3371 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003372 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003373 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003374 break;
3375 }
3376
3377 if (Consolidated)
3378 continue;
3379
3380 // If we did not consolidate MA, thus did not find an equivalence class
3381 // for it, we create a new one.
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003382 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA}, MACtx,
3383 Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003384 }
3385
3386 isl_set_free(DomainCtx);
3387}
3388
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003389bool Scop::isHoistableAccess(MemoryAccess *Access,
3390 __isl_keep isl_union_map *Writes) {
3391 // TODO: Loads that are not loop carried, hence are in a statement with
3392 // zero iterators, are by construction invariant, though we
3393 // currently "hoist" them anyway. This is necessary because we allow
3394 // them to be treated as parameters (e.g., in conditions) and our code
3395 // generation would otherwise use the old value.
3396
3397 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003398 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003399
3400 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3401 return false;
3402
3403 // Skip accesses that have an invariant base pointer which is defined but
3404 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3405 // returns a pointer that is used as a base address. However, as we want
3406 // to hoist indirect pointers, we allow the base pointer to be defined in
3407 // the region if it is also a memory access. Each ScopArrayInfo object
3408 // that has a base pointer origin has a base pointer that is loaded and
3409 // that it is invariant, thus it will be hoisted too. However, if there is
3410 // no base pointer origin we check that the base pointer is defined
3411 // outside the region.
3412 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003413 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3414 if (SAI->getBasePtrOriginSAI()) {
3415 assert(BasePtrInst && R.contains(BasePtrInst));
3416 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003417 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003418 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003419 assert(BasePtrStmt);
3420 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3421 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3422 return false;
3423 } else if (BasePtrInst && R.contains(BasePtrInst))
3424 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003425
3426 // Skip accesses in non-affine subregions as they might not be executed
3427 // under the same condition as the entry of the non-affine subregion.
3428 if (BB != Access->getAccessInstruction()->getParent())
3429 return false;
3430
3431 isl_map *AccessRelation = Access->getAccessRelation();
Johannes Doerfert2b470e82016-03-24 13:19:16 +00003432 assert(!isl_map_is_empty(AccessRelation));
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003433
3434 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3435 Stmt.getNumIterators())) {
3436 isl_map_free(AccessRelation);
3437 return false;
3438 }
3439
3440 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3441 isl_set *AccessRange = isl_map_range(AccessRelation);
3442
3443 isl_union_map *Written = isl_union_map_intersect_range(
3444 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3445 bool IsWritten = !isl_union_map_is_empty(Written);
3446 isl_union_map_free(Written);
3447
3448 if (IsWritten)
3449 return false;
3450
3451 return true;
3452}
3453
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003454void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003455 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3456 for (LoadInst *LI : RIL) {
3457 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003458 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003459 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003460 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3461 return;
3462 }
3463 }
3464}
3465
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003466void Scop::hoistInvariantLoads(ScopDetection &SD) {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003467 if (!PollyInvariantLoadHoisting)
3468 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003469
Tobias Grosser0865e7752016-02-29 07:29:42 +00003470 isl_union_map *Writes = getWrites();
3471 for (ScopStmt &Stmt : *this) {
3472 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003473
Tobias Grosser0865e7752016-02-29 07:29:42 +00003474 for (MemoryAccess *Access : Stmt)
3475 if (isHoistableAccess(Access, Writes))
3476 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003477
Tobias Grosser0865e7752016-02-29 07:29:42 +00003478 // We inserted invariant accesses always in the front but need them to be
3479 // sorted in a "natural order". The statements are already sorted in
3480 // reverse post order and that suffices for the accesses too. The reason
3481 // we require an order in the first place is the dependences between
3482 // invariant loads that can be caused by indirect loads.
3483 InvariantAccesses.reverse();
3484
3485 // Transfer the memory access from the statement to the SCoP.
3486 Stmt.removeMemoryAccesses(InvariantAccesses);
3487 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003488 }
Tobias Grosser0865e7752016-02-29 07:29:42 +00003489 isl_union_map_free(Writes);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003490}
3491
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003492const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003493Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003494 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003495 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003496 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003497 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003498 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003499 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003500 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003501 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003502 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003503 // In case of mismatching array sizes, we bail out by setting the run-time
3504 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003505 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003506 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003507 }
Tobias Grosserab671442015-05-23 05:58:27 +00003508 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003509}
3510
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003511const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003512 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003513 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003514 assert(SAI && "No ScopArrayInfo available for this base pointer");
3515 return SAI;
3516}
3517
Tobias Grosser74394f02013-01-14 22:40:23 +00003518std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003519
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003520std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003521 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003522 return stringFromIslObj(AssumedContext);
3523}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003524
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003525std::string Scop::getInvalidContextStr() const {
3526 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003527}
Tobias Grosser75805372011-04-29 06:27:02 +00003528
3529std::string Scop::getNameStr() const {
3530 std::string ExitName, EntryName;
3531 raw_string_ostream ExitStr(ExitName);
3532 raw_string_ostream EntryStr(EntryName);
3533
Tobias Grosserf240b482014-01-09 10:42:15 +00003534 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003535 EntryStr.str();
3536
3537 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003538 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003539 ExitStr.str();
3540 } else
3541 ExitName = "FunctionExit";
3542
3543 return EntryName + "---" + ExitName;
3544}
3545
Tobias Grosser74394f02013-01-14 22:40:23 +00003546__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003547__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003548 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003549}
3550
Tobias Grossere86109f2013-10-29 21:05:49 +00003551__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003552 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00003553 return isl_set_copy(AssumedContext);
3554}
3555
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003556bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003557 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003558 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00003559 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
3560 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
3561 isl_set_is_subset(PositiveContext, NegativeContext));
3562 isl_set_free(PositiveContext);
3563 if (!IsFeasible) {
3564 isl_set_free(NegativeContext);
3565 return false;
3566 }
3567
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003568 auto *DomainContext = isl_union_set_params(getDomains());
3569 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00003570 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003571 isl_set_free(NegativeContext);
3572 isl_set_free(DomainContext);
3573
Johannes Doerfert43788c52015-08-20 05:58:56 +00003574 return IsFeasible;
3575}
3576
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003577static std::string toString(AssumptionKind Kind) {
3578 switch (Kind) {
3579 case ALIASING:
3580 return "No-aliasing";
3581 case INBOUNDS:
3582 return "Inbounds";
3583 case WRAPPING:
3584 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00003585 case UNSIGNED:
3586 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003587 case COMPLEXITY:
3588 return "Low complexity";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003589 case ERRORBLOCK:
3590 return "No-error";
3591 case INFINITELOOP:
3592 return "Finite loop";
3593 case INVARIANTLOAD:
3594 return "Invariant load";
3595 case DELINEARIZATION:
3596 return "Delinearization";
3597 }
3598 llvm_unreachable("Unknown AssumptionKind!");
3599}
3600
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003601bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3602 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert2f705842016-04-12 16:09:44 +00003603 if (PollyRemarksMinimal) {
3604 if (Sign == AS_ASSUMPTION) {
3605 if (isl_set_is_subset(Context, Set))
3606 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003607
Johannes Doerfert2f705842016-04-12 16:09:44 +00003608 if (isl_set_is_subset(AssumedContext, Set))
3609 return false;
3610 } else {
3611 if (isl_set_is_disjoint(Set, Context))
3612 return false;
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003613
Johannes Doerfert2f705842016-04-12 16:09:44 +00003614 if (isl_set_is_subset(Set, InvalidContext))
3615 return false;
3616 }
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003617 }
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003618
3619 auto &F = *getRegion().getEntry()->getParent();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003620 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
3621 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003622 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003623 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003624}
3625
3626void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003627 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003628 // Simplify the assumptions/restrictions first.
3629 Set = isl_set_gist_params(Set, getContext());
3630
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003631 if (!trackAssumption(Kind, Set, Loc, Sign)) {
3632 isl_set_free(Set);
3633 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003634 }
3635
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003636 if (Sign == AS_ASSUMPTION) {
3637 AssumedContext = isl_set_intersect(AssumedContext, Set);
3638 AssumedContext = isl_set_coalesce(AssumedContext);
3639 } else {
3640 InvalidContext = isl_set_union(InvalidContext, Set);
3641 InvalidContext = isl_set_coalesce(InvalidContext);
3642 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003643}
3644
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003645void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003646 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
3647 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003648}
3649
3650void Scop::addRecordedAssumptions() {
3651 while (!RecordedAssumptions.empty()) {
3652 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003653
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003654 if (!AS.BB) {
3655 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign);
3656 continue;
3657 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003658
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003659 // If a basic block was given use its domain to simplify the assumption.
3660 // In case of restrictions we know they only have to hold on the domain,
3661 // thus we can intersect them with the domain of the block. However, for
3662 // assumptions the domain has to imply them, thus:
3663 // _ _____
3664 // Dom => S <==> A v B <==> A - B
3665 //
3666 // To avoid the complement we will register A - B as a restricton not an
3667 // assumption.
3668 isl_set *S = AS.Set;
3669 isl_set *Dom = getDomainConditions(AS.BB);
3670 if (AS.Sign == AS_RESTRICTION)
3671 S = isl_set_params(isl_set_intersect(S, Dom));
3672 else /* (AS.Sign == AS_ASSUMPTION) */
3673 S = isl_set_params(isl_set_subtract(Dom, S));
3674
3675 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003676 }
3677}
3678
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003679void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003680 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003681}
3682
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003683__isl_give isl_set *Scop::getInvalidContext() const {
3684 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003685}
3686
Tobias Grosser75805372011-04-29 06:27:02 +00003687void Scop::printContext(raw_ostream &OS) const {
3688 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003689 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003690
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003691 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003692 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003693
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003694 OS.indent(4) << "Invalid Context:\n";
3695 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003696
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003697 unsigned Dim = 0;
3698 for (const SCEV *Parameter : Parameters)
3699 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003700}
3701
Johannes Doerfertb164c792014-09-18 11:17:17 +00003702void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003703 int noOfGroups = 0;
3704 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003705 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003706 noOfGroups += 1;
3707 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003708 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003709 }
3710
Tobias Grosserbb853c22015-07-25 12:31:03 +00003711 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003712 if (MinMaxAliasGroups.empty()) {
3713 OS.indent(8) << "n/a\n";
3714 return;
3715 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003716
Tobias Grosserbb853c22015-07-25 12:31:03 +00003717 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003718
3719 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003720 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003721 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003722 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003723 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3724 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003725 }
3726 OS << " ]]\n";
3727 }
3728
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003729 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003730 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003731 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003732 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003733 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3734 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003735 }
3736 OS << " ]]\n";
3737 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003738 }
3739}
3740
Tobias Grosser75805372011-04-29 06:27:02 +00003741void Scop::printStatements(raw_ostream &OS) const {
3742 OS << "Statements {\n";
3743
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003744 for (const ScopStmt &Stmt : *this)
3745 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003746
3747 OS.indent(4) << "}\n";
3748}
3749
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003750void Scop::printArrayInfo(raw_ostream &OS) const {
3751 OS << "Arrays {\n";
3752
Tobias Grosserab671442015-05-23 05:58:27 +00003753 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003754 Array.second->print(OS);
3755
3756 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003757
3758 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3759
3760 for (auto &Array : arrays())
3761 Array.second->print(OS, /* SizeAsPwAff */ true);
3762
3763 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003764}
3765
Tobias Grosser75805372011-04-29 06:27:02 +00003766void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003767 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3768 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003769 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003770 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003771 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003772 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003773 const auto &MAs = std::get<1>(IAClass);
3774 if (MAs.empty()) {
3775 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003776 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003777 MAs.front()->print(OS);
3778 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003779 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003780 }
3781 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003782 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003783 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003784 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003785 printStatements(OS.indent(4));
3786}
3787
3788void Scop::dump() const { print(dbgs()); }
3789
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003790isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003791
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003792__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003793 // First try to use the SCEVAffinator to generate a piecewise defined
3794 // affine function from @p E in the context of @p BB. If that tasks becomes to
3795 // complex the affinator might return a nullptr. In such a case we invalidate
3796 // the SCoP and return a dummy value. This way we do not need to add error
3797 // handling cdoe to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003798 auto PWAC = Affinator.getPwAff(E, BB);
3799 if (PWAC.first)
3800 return PWAC;
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003801
3802 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
3803 invalidate(COMPLEXITY, DL);
3804 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003805}
3806
Tobias Grosser808cd692015-07-14 09:33:13 +00003807__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003808 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003809
Tobias Grosser808cd692015-07-14 09:33:13 +00003810 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003811 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003812
3813 return Domain;
3814}
3815
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003816__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
3817 PWACtx PWAC = getPwAff(E, BB);
3818 isl_set_free(PWAC.second);
3819 return PWAC.first;
3820}
3821
Tobias Grossere5a35142015-11-12 14:07:09 +00003822__isl_give isl_union_map *
3823Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3824 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003825
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003826 for (ScopStmt &Stmt : *this) {
3827 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003828 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003829 continue;
3830
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003831 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003832 isl_map *AccessDomain = MA->getAccessRelation();
3833 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003834 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003835 }
3836 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003837 return isl_union_map_coalesce(Accesses);
3838}
3839
3840__isl_give isl_union_map *Scop::getMustWrites() {
3841 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003842}
3843
3844__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003845 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003846}
3847
Tobias Grosser37eb4222014-02-20 21:43:54 +00003848__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003849 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003850}
3851
3852__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003853 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003854}
3855
Tobias Grosser2ac23382015-11-12 14:07:13 +00003856__isl_give isl_union_map *Scop::getAccesses() {
3857 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3858}
3859
Tobias Grosser808cd692015-07-14 09:33:13 +00003860__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003861 auto *Tree = getScheduleTree();
3862 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003863 isl_schedule_free(Tree);
3864 return S;
3865}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003866
Tobias Grosser808cd692015-07-14 09:33:13 +00003867__isl_give isl_schedule *Scop::getScheduleTree() const {
3868 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3869 getDomains());
3870}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003871
Tobias Grosser808cd692015-07-14 09:33:13 +00003872void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3873 auto *S = isl_schedule_from_domain(getDomains());
3874 S = isl_schedule_insert_partial_schedule(
3875 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3876 isl_schedule_free(Schedule);
3877 Schedule = S;
3878}
3879
3880void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3881 isl_schedule_free(Schedule);
3882 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003883}
3884
3885bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3886 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003887 for (ScopStmt &Stmt : *this) {
3888 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003889 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3890 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3891
3892 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3893 isl_union_set_free(StmtDomain);
3894 isl_union_set_free(NewStmtDomain);
3895 continue;
3896 }
3897
3898 Changed = true;
3899
3900 isl_union_set_free(StmtDomain);
3901 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3902
3903 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003904 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003905 isl_union_set_free(NewStmtDomain);
3906 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003907 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003908 }
3909 isl_union_set_free(Domain);
3910 return Changed;
3911}
3912
Tobias Grosser75805372011-04-29 06:27:02 +00003913ScalarEvolution *Scop::getSE() const { return SE; }
3914
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003915bool Scop::isIgnored(RegionNode *RN, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003916 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Kruse6f7721f2016-02-24 22:08:19 +00003917 ScopStmt *Stmt = getStmtFor(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003918
3919 // If there is no stmt, then it already has been removed.
3920 if (!Stmt)
3921 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003922
Johannes Doerfertf5673802015-10-01 23:48:18 +00003923 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003924 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003925 return true;
3926
3927 // Check for reachability via non-error blocks.
3928 if (!DomainMap.count(BB))
3929 return true;
3930
3931 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003932 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003933 return true;
3934
3935 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003936}
3937
Tobias Grosser808cd692015-07-14 09:33:13 +00003938struct MapToDimensionDataTy {
3939 int N;
3940 isl_union_pw_multi_aff *Res;
3941};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003942
Tobias Grosser808cd692015-07-14 09:33:13 +00003943// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003944// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003945//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003946// @param Set The input set.
3947// @param User->N The dimension to map to.
3948// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003949//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003950// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003951static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3952 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3953 int Dim;
3954 isl_space *Space;
3955 isl_pw_multi_aff *PMA;
3956
3957 Dim = isl_set_dim(Set, isl_dim_set);
3958 Space = isl_set_get_space(Set);
3959 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3960 Dim - Data->N);
3961 if (Data->N > 1)
3962 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3963 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3964
3965 isl_set_free(Set);
3966
3967 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003968}
3969
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003970// @brief Create an isl_multi_union_aff that defines an identity mapping
3971// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003972//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003973// # Example:
3974//
3975// Domain: { A[i,j]; B[i,j,k] }
3976// N: 1
3977//
3978// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3979//
3980// @param USet A union set describing the elements for which to generate a
3981// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003982// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003983// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003984static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003985mapToDimension(__isl_take isl_union_set *USet, int N) {
3986 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003987 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003988 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003989
Tobias Grosser808cd692015-07-14 09:33:13 +00003990 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003991
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003992 auto *Space = isl_union_set_get_space(USet);
3993 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003994
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003995 Data = {N, PwAff};
3996
3997 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003998 (void)Res;
3999
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004000 assert(Res == isl_stat_ok);
4001
4002 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00004003 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
4004}
4005
Tobias Grosser316b5b22015-11-11 19:28:14 +00004006void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00004007 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00004008 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004009 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004010 StmtMap[BB] = Stmt;
4011 } else {
4012 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00004013 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004014 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004015 for (BasicBlock *BB : R->blocks())
4016 StmtMap[BB] = Stmt;
4017 }
Tobias Grosser808cd692015-07-14 09:33:13 +00004018}
4019
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004020void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004021 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004022 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004023 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004024 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4025 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004026}
4027
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004028/// To generate a schedule for the elements in a Region we traverse the Region
4029/// in reverse-post-order and add the contained RegionNodes in traversal order
4030/// to the schedule of the loop that is currently at the top of the LoopStack.
4031/// For loop-free codes, this results in a correct sequential ordering.
4032///
4033/// Example:
4034/// bb1(0)
4035/// / \.
4036/// bb2(1) bb3(2)
4037/// \ / \.
4038/// bb4(3) bb5(4)
4039/// \ /
4040/// bb6(5)
4041///
4042/// Including loops requires additional processing. Whenever a loop header is
4043/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4044/// from an empty schedule, we first process all RegionNodes that are within
4045/// this loop and complete the sequential schedule at this loop-level before
4046/// processing about any other nodes. To implement this
4047/// loop-nodes-first-processing, the reverse post-order traversal is
4048/// insufficient. Hence, we additionally check if the traversal yields
4049/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4050/// These region-nodes are then queue and only traverse after the all nodes
4051/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004052void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
4053 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004054 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
4055
4056 ReversePostOrderTraversal<Region *> RTraversal(R);
4057 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4058 std::deque<RegionNode *> DelayList;
4059 bool LastRNWaiting = false;
4060
4061 // Iterate over the region @p R in reverse post-order but queue
4062 // sub-regions/blocks iff they are not part of the last encountered but not
4063 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4064 // that we queued the last sub-region/block from the reverse post-order
4065 // iterator. If it is set we have to explore the next sub-region/block from
4066 // the iterator (if any) to guarantee progress. If it is not set we first try
4067 // the next queued sub-region/blocks.
4068 while (!WorkList.empty() || !DelayList.empty()) {
4069 RegionNode *RN;
4070
4071 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4072 RN = WorkList.front();
4073 WorkList.pop_front();
4074 LastRNWaiting = false;
4075 } else {
4076 RN = DelayList.front();
4077 DelayList.pop_front();
4078 }
4079
4080 Loop *L = getRegionNodeLoop(RN, LI);
4081 if (!getRegion().contains(L))
4082 L = OuterScopLoop;
4083
Tobias Grosser151ae322016-04-03 19:36:52 +00004084 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004085 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004086 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004087 LastRNWaiting = true;
4088 DelayList.push_back(RN);
4089 continue;
4090 }
4091 LoopStack.push_back({L, nullptr, 0});
4092 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004093 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004094 }
4095
4096 return;
4097}
4098
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00004099void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004100 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004101
Tobias Grosser8362c262016-01-06 15:30:06 +00004102 if (RN->isSubRegion()) {
4103 auto *LocalRegion = RN->getNodeAs<Region>();
4104 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004105 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004106 return;
4107 }
4108 }
Michael Kruse046dde42015-08-10 13:01:57 +00004109
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004110 auto &LoopData = LoopStack.back();
4111 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004112
Michael Kruse6f7721f2016-02-24 22:08:19 +00004113 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004114 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4115 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004116 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004117 }
4118
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004119 // Check if we just processed the last node in this loop. If we did, finalize
4120 // the loop by:
4121 //
4122 // - adding new schedule dimensions
4123 // - folding the resulting schedule into the parent loop schedule
4124 // - dropping the loop schedule from the LoopStack.
4125 //
4126 // Then continue to check surrounding loops, which might also have been
4127 // completed by this node.
4128 while (LoopData.L &&
4129 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004130 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004131 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004132
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004133 LoopStack.pop_back();
4134 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004135
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004136 if (Schedule) {
4137 auto *Domain = isl_schedule_get_domain(Schedule);
4138 auto *MUPA = mapToDimension(Domain, LoopStack.size());
4139 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
4140 NextLoopData.Schedule =
4141 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004142 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004143
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004144 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4145 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004146 }
Tobias Grosser75805372011-04-29 06:27:02 +00004147}
4148
Michael Kruse6f7721f2016-02-24 22:08:19 +00004149ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004150 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004151 if (StmtMapIt == StmtMap.end())
4152 return nullptr;
4153 return StmtMapIt->second;
4154}
4155
Michael Kruse6f7721f2016-02-24 22:08:19 +00004156ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4157 if (RN->isSubRegion())
4158 return getStmtFor(RN->getNodeAs<Region>());
4159 return getStmtFor(RN->getNodeAs<BasicBlock>());
4160}
4161
4162ScopStmt *Scop::getStmtFor(Region *R) const {
4163 ScopStmt *Stmt = getStmtFor(R->getEntry());
4164 assert(!Stmt || Stmt->getRegion() == R);
4165 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004166}
4167
Johannes Doerfert96425c22015-08-30 21:13:53 +00004168int Scop::getRelativeLoopDepth(const Loop *L) const {
4169 Loop *OuterLoop =
4170 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
4171 if (!OuterLoop)
4172 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00004173 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4174}
4175
Michael Krused868b5d2015-09-10 15:25:24 +00004176void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00004177 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004178
4179 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
4180 // true, are not modeled as ordinary PHI nodes as they are not part of the
4181 // region. However, we model the operands in the predecessor blocks that are
4182 // part of the region as regular scalar accesses.
4183
4184 // If we can synthesize a PHI we can skip it, however only if it is in
4185 // the region. If it is not it can only be in the exit block of the region.
4186 // In this case we model the operands but not the PHI itself.
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004187 auto *Scope = LI->getLoopFor(PHI->getParent());
4188 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R, Scope))
Michael Kruse7bf39442015-09-10 12:46:52 +00004189 return;
4190
4191 // PHI nodes are modeled as if they had been demoted prior to the SCoP
4192 // detection. Hence, the PHI is a load of a new memory location in which the
4193 // incoming value was written at the end of the incoming basic block.
4194 bool OnlyNonAffineSubRegionOperands = true;
4195 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
4196 Value *Op = PHI->getIncomingValue(u);
4197 BasicBlock *OpBB = PHI->getIncomingBlock(u);
4198
4199 // Do not build scalar dependences inside a non-affine subregion.
4200 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
4201 continue;
4202
4203 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004204 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004205 }
4206
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004207 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
4208 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004209 }
4210}
4211
Michael Kruse2e02d562016-02-06 09:19:40 +00004212void ScopInfo::buildScalarDependences(Instruction *Inst) {
4213 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00004214
Michael Kruse2e02d562016-02-06 09:19:40 +00004215 // Pull-in required operands.
4216 for (Use &Op : Inst->operands())
4217 ensureValueRead(Op.get(), Inst->getParent());
4218}
Michael Kruse7bf39442015-09-10 12:46:52 +00004219
Michael Kruse2e02d562016-02-06 09:19:40 +00004220void ScopInfo::buildEscapingDependences(Instruction *Inst) {
4221 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00004222
Michael Kruse2e02d562016-02-06 09:19:40 +00004223 // Check for uses of this instruction outside the scop. Because we do not
4224 // iterate over such instructions and therefore did not "ensure" the existence
4225 // of a write, we must determine such use here.
4226 for (Use &U : Inst->uses()) {
4227 Instruction *UI = dyn_cast<Instruction>(U.getUser());
4228 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00004229 continue;
4230
Michael Kruse2e02d562016-02-06 09:19:40 +00004231 BasicBlock *UseParent = getUseBlock(U);
4232 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00004233
Michael Kruse2e02d562016-02-06 09:19:40 +00004234 // An escaping value is either used by an instruction not within the scop,
4235 // or (when the scop region's exit needs to be simplified) by a PHI in the
4236 // scop's exit block. This is because region simplification before code
4237 // generation inserts new basic blocks before the PHI such that its incoming
4238 // blocks are not in the scop anymore.
4239 if (!R->contains(UseParent) ||
4240 (isa<PHINode>(UI) && UserParent == R->getExit() &&
4241 R->getExitingBlock())) {
4242 // At least one escaping use found.
4243 ensureValueWrite(Inst);
4244 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00004245 }
4246 }
Michael Kruse7bf39442015-09-10 12:46:52 +00004247}
4248
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004249bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00004250 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00004251 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4252 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00004253 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004254 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004255 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004256 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00004257 const SCEVUnknown *BasePointer =
4258 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004259 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004260 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004261
Michael Kruse37d136e2016-02-26 16:08:24 +00004262 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
4263 auto *Src = BitCast->getOperand(0);
4264 auto *SrcTy = Src->getType();
4265 auto *DstTy = BitCast->getType();
Johannes Doerfert41725a12016-04-08 19:20:03 +00004266 // Do not try to delinearize non-sized (opaque) pointers.
4267 if ((SrcTy->isPointerTy() && !SrcTy->getPointerElementType()->isSized()) ||
4268 (DstTy->isPointerTy() && !DstTy->getPointerElementType()->isSized())) {
4269 return false;
4270 }
Michael Kruse436c9062016-04-08 16:20:08 +00004271 if (SrcTy->isPointerTy() && DstTy->isPointerTy() &&
4272 DL->getTypeAllocSize(SrcTy->getPointerElementType()) ==
4273 DL->getTypeAllocSize(DstTy->getPointerElementType()))
Michael Kruse37d136e2016-02-26 16:08:24 +00004274 Address = Src;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004275 }
Michael Kruse37d136e2016-02-26 16:08:24 +00004276
4277 auto *GEP = dyn_cast<GetElementPtrInst>(Address);
4278 if (!GEP)
4279 return false;
4280
4281 std::vector<const SCEV *> Subscripts;
4282 std::vector<int> Sizes;
4283 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
4284 auto *BasePtr = GEP->getOperand(0);
4285
Tobias Grosser535afd82016-04-05 06:23:45 +00004286 if (auto *BasePtrCast = dyn_cast<BitCastInst>(BasePtr))
4287 BasePtr = BasePtrCast->getOperand(0);
4288
4289 // Check for identical base pointers to ensure that we do not miss index
4290 // offsets that have been added before this GEP is applied.
4291 if (BasePtr != BasePointer->getValue())
4292 return false;
4293
Michael Kruse37d136e2016-02-26 16:08:24 +00004294 std::vector<const SCEV *> SizesSCEV;
4295
4296 for (auto *Subscript : Subscripts) {
4297 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004298 if (!isAffineExpr(R, L, Subscript, *SE, &AccessILS))
Michael Kruse37d136e2016-02-26 16:08:24 +00004299 return false;
4300
4301 for (LoadInst *LInst : AccessILS)
4302 if (!ScopRIL.count(LInst))
4303 return false;
4304 }
4305
4306 if (Sizes.empty())
4307 return false;
4308
4309 for (auto V : Sizes)
4310 SizesSCEV.push_back(SE->getSCEV(
4311 ConstantInt::get(IntegerType::getInt64Ty(BasePtr->getContext()), V)));
4312
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004313 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004314 Subscripts, SizesSCEV, Val);
4315 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004316}
4317
4318bool ScopInfo::buildAccessMultiDimParam(
4319 MemAccInst Inst, Loop *L, Region *R,
4320 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004321 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse37d136e2016-02-26 16:08:24 +00004322 if (!PollyDelinearize)
4323 return false;
4324
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004325 Value *Address = Inst.getPointerOperand();
4326 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004327 Type *ElementType = Val->getType();
4328 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004329 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004330 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004331
4332 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4333 const SCEVUnknown *BasePointer =
4334 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4335
4336 assert(BasePointer && "Could not find base pointer");
4337 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004338
Michael Kruse7bf39442015-09-10 12:46:52 +00004339 auto AccItr = InsnToMemAcc.find(Inst);
Michael Kruse37d136e2016-02-26 16:08:24 +00004340 if (AccItr == InsnToMemAcc.end())
4341 return false;
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004342
Michael Kruse37d136e2016-02-26 16:08:24 +00004343 std::vector<const SCEV *> Sizes(
4344 AccItr->second.Shape->DelinearizedSizes.begin(),
4345 AccItr->second.Shape->DelinearizedSizes.end());
4346 // Remove the element size. This information is already provided by the
4347 // ElementSize parameter. In case the element size of this access and the
4348 // element size used for delinearization differs the delinearization is
4349 // incorrect. Hence, we invalidate the scop.
4350 //
4351 // TODO: Handle delinearization with differing element sizes.
4352 auto DelinearizedSize =
4353 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
4354 Sizes.pop_back();
4355 if (ElementSize != DelinearizedSize)
4356 scop->invalidate(DELINEARIZATION, Inst->getDebugLoc());
4357
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004358 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004359 AccItr->second.DelinearizedSubscripts, Sizes, Val);
4360 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004361}
4362
Johannes Doerfertcea61932016-02-21 19:13:19 +00004363bool ScopInfo::buildAccessMemIntrinsic(
4364 MemAccInst Inst, Loop *L, Region *R,
4365 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4366 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004367 auto *MemIntr = dyn_cast_or_null<MemIntrinsic>(Inst);
4368
4369 if (MemIntr == nullptr)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004370 return false;
4371
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004372 auto *LengthVal = SE->getSCEVAtScope(MemIntr->getLength(), L);
Johannes Doerfertcea61932016-02-21 19:13:19 +00004373 assert(LengthVal);
4374
Johannes Doerferta7920982016-02-25 14:08:48 +00004375 // Check if the length val is actually affine or if we overapproximate it
4376 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004377 bool LengthIsAffine = isAffineExpr(R, L, LengthVal, *SE, &AccessILS);
Johannes Doerferta7920982016-02-25 14:08:48 +00004378 for (LoadInst *LInst : AccessILS)
4379 if (!ScopRIL.count(LInst))
4380 LengthIsAffine = false;
4381 if (!LengthIsAffine)
4382 LengthVal = nullptr;
4383
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004384 auto *DestPtrVal = MemIntr->getDest();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004385 assert(DestPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004386
Johannes Doerfertcea61932016-02-21 19:13:19 +00004387 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
4388 assert(DestAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004389 // Ignore accesses to "NULL".
4390 // TODO: We could use this to optimize the region further, e.g., intersect
4391 // the context with
4392 // isl_set_complement(isl_set_params(getDomain()))
4393 // as we know it would be undefined to execute this instruction anyway.
4394 if (DestAccFunc->isZero())
4395 return true;
4396
Johannes Doerfertcea61932016-02-21 19:13:19 +00004397 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
4398 assert(DestPtrSCEV);
4399 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
4400 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
4401 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
4402 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
4403
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004404 auto *MemTrans = dyn_cast<MemTransferInst>(MemIntr);
4405 if (!MemTrans)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004406 return true;
4407
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004408 auto *SrcPtrVal = MemTrans->getSource();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004409 assert(SrcPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004410
Johannes Doerfertcea61932016-02-21 19:13:19 +00004411 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
4412 assert(SrcAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004413 // Ignore accesses to "NULL".
4414 // TODO: See above TODO
4415 if (SrcAccFunc->isZero())
4416 return true;
4417
Johannes Doerfertcea61932016-02-21 19:13:19 +00004418 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
4419 assert(SrcPtrSCEV);
4420 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
4421 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
4422 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
4423 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
4424
4425 return true;
4426}
4427
Johannes Doerferta7920982016-02-25 14:08:48 +00004428bool ScopInfo::buildAccessCallInst(
4429 MemAccInst Inst, Loop *L, Region *R,
4430 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4431 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004432 auto *CI = dyn_cast_or_null<CallInst>(Inst);
4433
4434 if (CI == nullptr)
Johannes Doerferta7920982016-02-25 14:08:48 +00004435 return false;
4436
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004437 if (CI->doesNotAccessMemory() || isIgnoredIntrinsic(CI))
Johannes Doerferta7920982016-02-25 14:08:48 +00004438 return true;
4439
4440 bool ReadOnly = false;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004441 auto *AF = SE->getConstant(IntegerType::getInt64Ty(CI->getContext()), 0);
4442 auto *CalledFunction = CI->getCalledFunction();
Johannes Doerferta7920982016-02-25 14:08:48 +00004443 switch (AA->getModRefBehavior(CalledFunction)) {
4444 case llvm::FMRB_UnknownModRefBehavior:
4445 llvm_unreachable("Unknown mod ref behaviour cannot be represented.");
4446 case llvm::FMRB_DoesNotAccessMemory:
4447 return true;
4448 case llvm::FMRB_OnlyReadsMemory:
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004449 GlobalReads.push_back(CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004450 return true;
4451 case llvm::FMRB_OnlyReadsArgumentPointees:
4452 ReadOnly = true;
4453 // Fall through
4454 case llvm::FMRB_OnlyAccessesArgumentPointees:
4455 auto AccType = ReadOnly ? MemoryAccess::READ : MemoryAccess::MAY_WRITE;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004456 for (const auto &Arg : CI->arg_operands()) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004457 if (!Arg->getType()->isPointerTy())
4458 continue;
4459
4460 auto *ArgSCEV = SE->getSCEVAtScope(Arg, L);
4461 if (ArgSCEV->isZero())
4462 continue;
4463
4464 auto *ArgBasePtr = cast<SCEVUnknown>(SE->getPointerBase(ArgSCEV));
4465 addArrayAccess(Inst, AccType, ArgBasePtr->getValue(),
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004466 ArgBasePtr->getType(), false, {AF}, {}, CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004467 }
4468 return true;
4469 }
4470
4471 return true;
4472}
4473
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004474void ScopInfo::buildAccessSingleDim(
4475 MemAccInst Inst, Loop *L, Region *R,
4476 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4477 const InvariantLoadsSetTy &ScopRIL) {
4478 Value *Address = Inst.getPointerOperand();
4479 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004480 Type *ElementType = Val->getType();
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004481 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004482 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004483
4484 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4485 const SCEVUnknown *BasePointer =
4486 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4487
4488 assert(BasePointer && "Could not find base pointer");
4489 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00004490
4491 // Check if the access depends on a loop contained in a non-affine subregion.
4492 bool isVariantInNonAffineLoop = false;
4493 if (BoxedLoops) {
4494 SetVector<const Loop *> Loops;
4495 findLoops(AccessFunction, Loops);
4496 for (const Loop *L : Loops)
4497 if (BoxedLoops->count(L))
4498 isVariantInNonAffineLoop = true;
4499 }
4500
Johannes Doerfert09e36972015-10-07 20:17:36 +00004501 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00004502 bool IsAffine = !isVariantInNonAffineLoop &&
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004503 isAffineExpr(R, L, AccessFunction, *SE, &AccessILS);
Johannes Doerfert09e36972015-10-07 20:17:36 +00004504
4505 for (LoadInst *LInst : AccessILS)
4506 if (!ScopRIL.count(LInst))
4507 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004508
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004509 if (!IsAffine && AccType == MemoryAccess::MUST_WRITE)
4510 AccType = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004511
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004512 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004513 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004514}
4515
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004516void ScopInfo::buildMemoryAccess(
4517 MemAccInst Inst, Loop *L, Region *R,
4518 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004519 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004520
Johannes Doerfertcea61932016-02-21 19:13:19 +00004521 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4522 return;
4523
Johannes Doerferta7920982016-02-25 14:08:48 +00004524 if (buildAccessCallInst(Inst, L, R, BoxedLoops, ScopRIL))
4525 return;
4526
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004527 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4528 return;
4529
Hongbin Zheng22623202016-02-15 00:20:58 +00004530 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004531 return;
4532
4533 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4534}
4535
Hongbin Zheng22623202016-02-15 00:20:58 +00004536void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4537 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004538
4539 if (SD->isNonAffineSubRegion(&SR, &R)) {
4540 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004541 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004542 return;
4543 }
4544
4545 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4546 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004547 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004548 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004549 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004550}
4551
Johannes Doerferta8781032016-02-02 14:14:40 +00004552void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004553
Johannes Doerferta8781032016-02-02 14:14:40 +00004554 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004555 scop->addScopStmt(nullptr, &SR);
4556 return;
4557 }
4558
4559 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4560 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004561 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004562 else
4563 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4564}
4565
Michael Krused868b5d2015-09-10 15:25:24 +00004566void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004567 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004568 Region *NonAffineSubRegion,
4569 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004570 // We do not build access functions for error blocks, as they may contain
4571 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004572 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004573 return;
4574
Michael Kruse7bf39442015-09-10 12:46:52 +00004575 Loop *L = LI->getLoopFor(&BB);
4576
4577 // The set of loops contained in non-affine subregions that are part of R.
4578 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4579
Johannes Doerfert09e36972015-10-07 20:17:36 +00004580 // The set of loads that are required to be invariant.
4581 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4582
Michael Kruse2e02d562016-02-06 09:19:40 +00004583 for (Instruction &Inst : BB) {
4584 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004585 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004586 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004587
4588 // For the exit block we stop modeling after the last PHI node.
4589 if (!PHI && IsExitBlock)
4590 break;
4591
Johannes Doerfert09e36972015-10-07 20:17:36 +00004592 // TODO: At this point we only know that elements of ScopRIL have to be
4593 // invariant and will be hoisted for the SCoP to be processed. Though,
4594 // there might be other invariant accesses that will be hoisted and
4595 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004596 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004597 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004598
Michael Kruse2e02d562016-02-06 09:19:40 +00004599 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004600 continue;
4601
Tobias Grosser0904c692016-03-16 23:33:54 +00004602 // PHI nodes have already been modeled above and TerminatorInsts that are
4603 // not part of a non-affine subregion are fully modeled and regenerated
4604 // from the polyhedral domains. Hence, they do not need to be modeled as
4605 // explicit data dependences.
4606 if (!PHI && (!isa<TerminatorInst>(&Inst) || NonAffineSubRegion))
Michael Kruse2e02d562016-02-06 09:19:40 +00004607 buildScalarDependences(&Inst);
Tobias Grosser0904c692016-03-16 23:33:54 +00004608
Michael Kruse2e02d562016-02-06 09:19:40 +00004609 if (!IsExitBlock)
4610 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004611 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004612}
Michael Kruse7bf39442015-09-10 12:46:52 +00004613
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004614MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004615 MemoryAccess::AccessType AccType,
4616 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004617 bool Affine, Value *AccessValue,
4618 ArrayRef<const SCEV *> Subscripts,
4619 ArrayRef<const SCEV *> Sizes,
4620 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004621 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004622
4623 // Do not create a memory access for anything not in the SCoP. It would be
4624 // ignored anyway.
4625 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004626 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004627
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004628 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004629 Value *BaseAddr = BaseAddress;
4630 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4631
Tobias Grosserf4f68702015-12-14 15:05:37 +00004632 bool isKnownMustAccess = false;
4633
4634 // Accesses in single-basic block statements are always excuted.
4635 if (Stmt->isBlockStmt())
4636 isKnownMustAccess = true;
4637
4638 if (Stmt->isRegionStmt()) {
4639 // Accesses that dominate the exit block of a non-affine region are always
4640 // executed. In non-affine regions there may exist MK_Values that do not
4641 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4642 // only if there is at most one PHI_WRITE in the non-affine region.
4643 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4644 isKnownMustAccess = true;
4645 }
4646
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004647 // Non-affine PHI writes do not "happen" at a particular instruction, but
4648 // after exiting the statement. Therefore they are guaranteed execute and
4649 // overwrite the old value.
4650 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4651 isKnownMustAccess = true;
4652
Johannes Doerfertcea61932016-02-21 19:13:19 +00004653 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4654 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004655
Johannes Doerfertcea61932016-02-21 19:13:19 +00004656 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004657 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004658 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004659 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004660}
4661
Michael Kruse70131d32016-01-27 17:09:17 +00004662void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004663 MemoryAccess::AccessType AccType,
4664 Value *BaseAddress, Type *ElementType,
4665 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004666 ArrayRef<const SCEV *> Sizes,
4667 Value *AccessValue) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004668 ArrayBasePointers.insert(BaseAddress);
Hongbin Zhengf3d66122016-02-26 09:47:11 +00004669 addMemoryAccess(MemAccInst->getParent(), MemAccInst, AccType, BaseAddress,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004670 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004671 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004672}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004673
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004674void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004675 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004676
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004677 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004678 if (!Stmt)
4679 return;
4680
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004681 // Do not process further if the instruction is already written.
4682 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004683 return;
4684
Johannes Doerfertcea61932016-02-21 19:13:19 +00004685 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4686 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004687 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004688}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004689
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004690void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004691
Michael Kruse2e02d562016-02-06 09:19:40 +00004692 // There cannot be an "access" for literal constants. BasicBlock references
4693 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004694 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004695 return;
4696
Michael Krusefd463082016-01-27 22:51:56 +00004697 // If the instruction can be synthesized and the user is in the region we do
4698 // not need to add a value dependences.
4699 Region &ScopRegion = scop->getRegion();
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004700 auto *Scope = LI->getLoopFor(UserBB);
4701 if (canSynthesize(V, LI, SE, &ScopRegion, Scope))
Michael Krusefd463082016-01-27 22:51:56 +00004702 return;
4703
Michael Kruse2e02d562016-02-06 09:19:40 +00004704 // Do not build scalar dependences for required invariant loads as we will
4705 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004706 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004707 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004708 return;
4709
4710 // Determine the ScopStmt containing the value's definition and use. There is
4711 // no defining ScopStmt if the value is a function argument, a global value,
4712 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004713 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004714 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004715
Michael Kruse6f7721f2016-02-24 22:08:19 +00004716 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004717
4718 // We do not model uses outside the scop.
4719 if (!UserStmt)
4720 return;
4721
Michael Kruse2e02d562016-02-06 09:19:40 +00004722 // Add MemoryAccess for invariant values only if requested.
4723 if (!ModelReadOnlyScalars && !ValueStmt)
4724 return;
4725
4726 // Ignore use-def chains within the same ScopStmt.
4727 if (ValueStmt == UserStmt)
4728 return;
4729
Michael Krusead28e5a2016-01-26 13:33:15 +00004730 // Do not create another MemoryAccess for reloading the value if one already
4731 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004732 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004733 return;
4734
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004735 // For exit PHIs use the MK_ExitPHI MemoryKind not MK_Value.
4736 ScopArrayInfo::MemoryKind Kind = ScopArrayInfo::MK_Value;
4737 if (!ValueStmt && isa<PHINode>(V))
4738 Kind = ScopArrayInfo::MK_ExitPHI;
4739
Johannes Doerfertcea61932016-02-21 19:13:19 +00004740 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004741 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(), Kind);
Michael Kruse2e02d562016-02-06 09:19:40 +00004742 if (ValueInst)
4743 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004744}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004745
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004746void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4747 Value *IncomingValue, bool IsExitBlock) {
Johannes Doerfert57c5f0b2016-04-05 13:44:21 +00004748 // As the incoming block might turn out to be an error statement ensure we
4749 // will create an exit PHI SAI object. It is needed during code generation
4750 // and would be created later anyway.
4751 if (IsExitBlock)
4752 scop->getOrCreateScopArrayInfo(PHI, PHI->getType(), {},
4753 ScopArrayInfo::MK_ExitPHI);
4754
Michael Kruse6f7721f2016-02-24 22:08:19 +00004755 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004756 if (!IncomingStmt)
4757 return;
4758
4759 // Take care for the incoming value being available in the incoming block.
4760 // This must be done before the check for multiple PHI writes because multiple
4761 // exiting edges from subregion each can be the effective written value of the
4762 // subregion. As such, all of them must be made available in the subregion
4763 // statement.
4764 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004765
4766 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4767 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4768 assert(Acc->getAccessInstruction() == PHI);
4769 Acc->addIncoming(IncomingBlock, IncomingValue);
4770 return;
4771 }
4772
4773 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004774 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4775 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4776 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004777 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4778 assert(Acc);
4779 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004780}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004781
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004782void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004783 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4784 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4785 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004786}
4787
Michael Krusedaf66942015-12-13 22:10:37 +00004788void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004789 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse09eb4452016-03-03 22:10:47 +00004790 scop.reset(new Scop(R, *SE, *LI, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004791
Johannes Doerferta8781032016-02-02 14:14:40 +00004792 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004793 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004794
4795 // In case the region does not have an exiting block we will later (during
4796 // code generation) split the exit block. This will move potential PHI nodes
4797 // from the current exit block into the new region exiting block. Hence, PHI
4798 // nodes that are at this point not part of the region will be.
4799 // To handle these PHI nodes later we will now model their operands as scalar
4800 // accesses. Note that we do not model anything in the exit block if we have
4801 // an exiting block in the region, as there will not be any splitting later.
4802 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004803 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4804 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004805
Johannes Doerferta7920982016-02-25 14:08:48 +00004806 // Create memory accesses for global reads since all arrays are now known.
4807 auto *AF = SE->getConstant(IntegerType::getInt64Ty(SE->getContext()), 0);
4808 for (auto *GlobalRead : GlobalReads)
4809 for (auto *BP : ArrayBasePointers)
4810 addArrayAccess(MemAccInst(GlobalRead), MemoryAccess::READ, BP,
4811 BP->getType(), false, {AF}, {}, GlobalRead);
4812
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004813 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004814}
4815
Michael Krused868b5d2015-09-10 15:25:24 +00004816void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004817 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004818 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004819 return;
4820 }
4821
Michael Kruse9d080092015-09-11 21:41:48 +00004822 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004823}
4824
Hongbin Zhengfec32802016-02-13 15:13:02 +00004825void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004826
4827//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004828ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004829
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004830ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004831
Tobias Grosser75805372011-04-29 06:27:02 +00004832void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004833 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004834 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004835 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004836 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4837 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004838 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004839 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004840 AU.setPreservesAll();
4841}
4842
4843bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004844 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004845
Michael Krused868b5d2015-09-10 15:25:24 +00004846 if (!SD->isMaxRegionInScop(*R))
4847 return false;
4848
4849 Function *F = R->getEntry()->getParent();
4850 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4851 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4852 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004853 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004854 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004855 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004856
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004857 DebugLoc Beg, End;
4858 getDebugLocations(R, Beg, End);
4859 std::string Msg = "SCoP begins here.";
4860 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4861
Michael Krusedaf66942015-12-13 22:10:37 +00004862 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004863
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004864 DEBUG(scop->print(dbgs()));
4865
Michael Kruseafe06702015-10-02 16:33:27 +00004866 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004867 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004868 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004869 } else {
4870 Msg = "SCoP ends here.";
4871 ++ScopFound;
4872 if (scop->getMaxLoopDepth() > 0)
4873 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004874 }
4875
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004876 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4877
Tobias Grosser75805372011-04-29 06:27:02 +00004878 return false;
4879}
4880
4881char ScopInfo::ID = 0;
4882
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004883Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4884
Tobias Grosser73600b82011-10-08 00:30:40 +00004885INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4886 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004887 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004888INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004889INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004890INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004891INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004892INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004893INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004894INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004895INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4896 "Polly - Create polyhedral description of Scops", false,
4897 false)