blob: 48b0837e59ebb1f1cc7fe9d539c817a90ddef8b9 [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
Michael Krusebc150122016-05-02 12:25:18 +000069static int const MaxDisjunctionsInDomain = 20;
Tobias Grosser75dc40c2015-12-20 13:31:48 +000070
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
Tobias Grosser2937b592016-04-29 11:43:20 +0000108static cl::opt<bool>
109 IslOnErrorAbort("polly-on-isl-error-abort",
110 cl::desc("Abort if an isl error is encountered"),
111 cl::init(true), cl::cat(PollyCategory));
112
Michael Kruse7bf39442015-09-10 12:46:52 +0000113//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000114
Michael Kruse046dde42015-08-10 13:01:57 +0000115// Create a sequence of two schedules. Either argument may be null and is
116// interpreted as the empty schedule. Can also return null if both schedules are
117// empty.
118static __isl_give isl_schedule *
119combineInSequence(__isl_take isl_schedule *Prev,
120 __isl_take isl_schedule *Succ) {
121 if (!Prev)
122 return Succ;
123 if (!Succ)
124 return Prev;
125
126 return isl_schedule_sequence(Prev, Succ);
127}
128
Johannes Doerferte7044942015-02-24 11:58:30 +0000129static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
130 const ConstantRange &Range,
131 int dim,
132 enum isl_dim_type type) {
133 isl_val *V;
134 isl_ctx *ctx = isl_set_get_ctx(S);
135
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000136 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
137 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000138 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000139 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
140
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000141 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000142 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000143 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000144 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000145 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
146
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000147 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000148 return isl_set_union(SLB, SUB);
149 else
150 return isl_set_intersect(SLB, SUB);
151}
152
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000153static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
154 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
155 if (!BasePtrLI)
156 return nullptr;
157
158 if (!S->getRegion().contains(BasePtrLI))
159 return nullptr;
160
161 ScalarEvolution &SE = *S->getSE();
162
163 auto *OriginBaseSCEV =
164 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
165 if (!OriginBaseSCEV)
166 return nullptr;
167
168 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
169 if (!OriginBaseSCEVUnknown)
170 return nullptr;
171
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000172 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grossera535dff2015-12-13 19:59:01 +0000173 ScopArrayInfo::MK_Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000174}
175
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000176ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grossera535dff2015-12-13 19:59:01 +0000177 ArrayRef<const SCEV *> Sizes, enum MemoryKind Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000178 const DataLayout &DL, Scop *S)
179 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000180 std::string BasePtrName =
Tobias Grossera535dff2015-12-13 19:59:01 +0000181 getIslCompatibleName("MemRef_", BasePtr, Kind == MK_PHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000182 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000183
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000184 updateSizes(Sizes);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000185 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
186 if (BasePtrOriginSAI)
187 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000188}
189
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000190__isl_give isl_space *ScopArrayInfo::getSpace() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000191 auto *Space =
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000192 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
193 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
194 return Space;
195}
196
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000197void ScopArrayInfo::updateElementType(Type *NewElementType) {
198 if (NewElementType == ElementType)
199 return;
200
Tobias Grosserd840fc72016-02-04 13:18:42 +0000201 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
202 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
203
Johannes Doerferta7920982016-02-25 14:08:48 +0000204 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000205 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000206
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000207 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
208 ElementType = NewElementType;
209 } else {
210 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
211 ElementType = IntegerType::get(ElementType->getContext(), GCD);
212 }
213}
214
215bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000216 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
217 int ExtraDimsNew = NewSizes.size() - SharedDims;
218 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Tobias Grosser8286b832015-11-02 11:29:32 +0000219 for (int i = 0; i < SharedDims; i++)
220 if (NewSizes[i + ExtraDimsNew] != DimensionSizes[i + ExtraDimsOld])
221 return false;
222
223 if (DimensionSizes.size() >= NewSizes.size())
224 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000225
226 DimensionSizes.clear();
227 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
228 NewSizes.end());
229 for (isl_pw_aff *Size : DimensionSizesPw)
230 isl_pw_aff_free(Size);
231 DimensionSizesPw.clear();
232 for (const SCEV *Expr : DimensionSizes) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +0000233 isl_pw_aff *Size = S.getPwAffOnly(Expr);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000234 DimensionSizesPw.push_back(Size);
235 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000236 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000237}
238
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000239ScopArrayInfo::~ScopArrayInfo() {
240 isl_id_free(Id);
241 for (isl_pw_aff *Size : DimensionSizesPw)
242 isl_pw_aff_free(Size);
243}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000244
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000245std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
246
247int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000248 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000249}
250
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +0000251__isl_give isl_id *ScopArrayInfo::getBasePtrId() const {
252 return isl_id_copy(Id);
253}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000254
255void ScopArrayInfo::dump() const { print(errs()); }
256
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000257void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000258 OS.indent(8) << *getElementType() << " " << getName();
259 if (getNumberOfDimensions() > 0)
260 OS << "[*]";
Tobias Grosser26253842015-11-10 14:24:21 +0000261 for (unsigned u = 1; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000262 OS << "[";
263
Tobias Grosser26253842015-11-10 14:24:21 +0000264 if (SizeAsPwAff) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000265 auto *Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000266 OS << " " << Size << " ";
267 isl_pw_aff_free(Size);
268 } else {
269 OS << *getDimensionSize(u);
270 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000271
272 OS << "]";
273 }
274
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000275 OS << ";";
276
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000277 if (BasePtrOriginSAI)
278 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
279
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000280 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000281}
282
283const ScopArrayInfo *
284ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
285 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
286 assert(Id && "Output dimension didn't have an ID");
287 return getFromId(Id);
288}
289
290const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
291 void *User = isl_id_get_user(Id);
292 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
293 isl_id_free(Id);
294 return SAI;
295}
296
Michael Kruse3b425ff2016-04-11 14:34:08 +0000297void MemoryAccess::wrapConstantDimensions() {
298 auto *SAI = getScopArrayInfo();
299 auto *ArraySpace = SAI->getSpace();
300 auto *Ctx = isl_space_get_ctx(ArraySpace);
301 unsigned DimsArray = SAI->getNumberOfDimensions();
302
303 auto *DivModAff = isl_multi_aff_identity(isl_space_map_from_domain_and_range(
304 isl_space_copy(ArraySpace), isl_space_copy(ArraySpace)));
305 auto *LArraySpace = isl_local_space_from_space(ArraySpace);
306
307 // Begin with last dimension, to iteratively carry into higher dimensions.
308 for (int i = DimsArray - 1; i > 0; i--) {
309 auto *DimSize = SAI->getDimensionSize(i);
310 auto *DimSizeCst = dyn_cast<SCEVConstant>(DimSize);
311
312 // This transformation is not applicable to dimensions with dynamic size.
313 if (!DimSizeCst)
314 continue;
315
316 auto *DimSizeVal = isl_valFromAPInt(Ctx, DimSizeCst->getAPInt(), false);
317 auto *Var = isl_aff_var_on_domain(isl_local_space_copy(LArraySpace),
318 isl_dim_set, i);
319 auto *PrevVar = isl_aff_var_on_domain(isl_local_space_copy(LArraySpace),
320 isl_dim_set, i - 1);
321
322 // Compute: index % size
323 // Modulo must apply in the divide of the previous iteration, if any.
324 auto *Modulo = isl_aff_copy(Var);
325 Modulo = isl_aff_mod_val(Modulo, isl_val_copy(DimSizeVal));
326 Modulo = isl_aff_pullback_multi_aff(Modulo, isl_multi_aff_copy(DivModAff));
327
328 // Compute: floor(index / size)
329 auto *Divide = Var;
330 Divide = isl_aff_div(
331 Divide,
332 isl_aff_val_on_domain(isl_local_space_copy(LArraySpace), DimSizeVal));
333 Divide = isl_aff_floor(Divide);
334 Divide = isl_aff_add(Divide, PrevVar);
335 Divide = isl_aff_pullback_multi_aff(Divide, isl_multi_aff_copy(DivModAff));
336
337 // Apply Modulo and Divide.
338 DivModAff = isl_multi_aff_set_aff(DivModAff, i, Modulo);
339 DivModAff = isl_multi_aff_set_aff(DivModAff, i - 1, Divide);
340 }
341
342 // Apply all modulo/divides on the accesses.
343 AccessRelation =
344 isl_map_apply_range(AccessRelation, isl_map_from_multi_aff(DivModAff));
345 AccessRelation = isl_map_detect_equalities(AccessRelation);
346 isl_local_space_free(LArraySpace);
347}
348
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000349void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000350 auto *SAI = getScopArrayInfo();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000351 auto *ArraySpace = SAI->getSpace();
352 auto *AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000353 auto *Ctx = isl_space_get_ctx(AccessSpace);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000354
355 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
356 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
357 auto DimsMissing = DimsArray - DimsAccess;
358
Michael Kruse375cb5f2016-02-24 22:08:24 +0000359 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000360 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000361 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000362 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000363
Johannes Doerferta90943d2016-02-21 16:37:25 +0000364 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000365 isl_set_universe(AccessSpace),
366 isl_set_universe(isl_space_copy(ArraySpace)));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000367
368 for (unsigned i = 0; i < DimsMissing; i++)
369 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
370
371 for (unsigned i = DimsMissing; i < DimsArray; i++)
372 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
373
374 AccessRelation = isl_map_apply_range(AccessRelation, Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000375
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000376 // For the non delinearized arrays, divide the access function of the last
377 // subscript by the size of the elements in the array.
378 //
379 // A stride one array access in C expressed as A[i] is expressed in
380 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
381 // two subsequent values of 'i' index two values that are stored next to
382 // each other in memory. By this division we make this characteristic
383 // obvious again. If the base pointer was accessed with offsets not divisible
384 // by the accesses element size, we will have choosen a smaller ArrayElemSize
385 // that divides the offsets of all accesses to this base pointer.
386 if (DimsAccess == 1) {
387 isl_val *V = isl_val_int_from_si(Ctx, ArrayElemSize);
388 AccessRelation = isl_map_floordiv_val(AccessRelation, V);
389 }
390
Michael Kruse3b425ff2016-04-11 14:34:08 +0000391 // We currently do this only if we added at least one dimension, which means
392 // some dimension's indices have not been specified, an indicator that some
393 // index values have been added together.
394 // TODO: Investigate general usefulness; Effect on unit tests is to make index
395 // expressions more complicated.
396 if (DimsMissing)
397 wrapConstantDimensions();
398
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000399 if (!isAffine())
400 computeBoundsOnAccessRelation(ArrayElemSize);
401
Tobias Grosserd840fc72016-02-04 13:18:42 +0000402 // Introduce multi-element accesses in case the type loaded by this memory
403 // access is larger than the canonical element type of the array.
404 //
405 // An access ((float *)A)[i] to an array char *A is modeled as
406 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000407 if (ElemBytes > ArrayElemSize) {
408 assert(ElemBytes % ArrayElemSize == 0 &&
409 "Loaded element size should be multiple of canonical element size");
Johannes Doerferta90943d2016-02-21 16:37:25 +0000410 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000411 isl_set_universe(isl_space_copy(ArraySpace)),
412 isl_set_universe(isl_space_copy(ArraySpace)));
413 for (unsigned i = 0; i < DimsArray - 1; i++)
414 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
415
Tobias Grosserd840fc72016-02-04 13:18:42 +0000416 isl_constraint *C;
417 isl_local_space *LS;
418
419 LS = isl_local_space_from_space(isl_map_get_space(Map));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000420 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
421
422 C = isl_constraint_alloc_inequality(isl_local_space_copy(LS));
423 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, Num - 1));
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 Map = isl_map_add_constraint(Map, C);
427
428 C = isl_constraint_alloc_inequality(LS);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000429 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, -1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000430 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, 1);
431 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, 0));
432 Map = isl_map_add_constraint(Map, C);
433 AccessRelation = isl_map_apply_range(AccessRelation, Map);
434 }
435
436 isl_space_free(ArraySpace);
437
Roman Gareev10595a12016-01-08 14:01:59 +0000438 assumeNoOutOfBound();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000439}
440
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000441const std::string
442MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
443 switch (RT) {
444 case MemoryAccess::RT_NONE:
445 llvm_unreachable("Requested a reduction operator string for a memory "
446 "access which isn't a reduction");
447 case MemoryAccess::RT_ADD:
448 return "+";
449 case MemoryAccess::RT_MUL:
450 return "*";
451 case MemoryAccess::RT_BOR:
452 return "|";
453 case MemoryAccess::RT_BXOR:
454 return "^";
455 case MemoryAccess::RT_BAND:
456 return "&";
457 }
458 llvm_unreachable("Unknown reduction type");
459 return "";
460}
461
Johannes Doerfertf6183392014-07-01 20:52:51 +0000462/// @brief Return the reduction type for a given binary operator
463static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
464 const Instruction *Load) {
465 if (!BinOp)
466 return MemoryAccess::RT_NONE;
467 switch (BinOp->getOpcode()) {
468 case Instruction::FAdd:
469 if (!BinOp->hasUnsafeAlgebra())
470 return MemoryAccess::RT_NONE;
471 // Fall through
472 case Instruction::Add:
473 return MemoryAccess::RT_ADD;
474 case Instruction::Or:
475 return MemoryAccess::RT_BOR;
476 case Instruction::Xor:
477 return MemoryAccess::RT_BXOR;
478 case Instruction::And:
479 return MemoryAccess::RT_BAND;
480 case Instruction::FMul:
481 if (!BinOp->hasUnsafeAlgebra())
482 return MemoryAccess::RT_NONE;
483 // Fall through
484 case Instruction::Mul:
485 if (DisableMultiplicativeReductions)
486 return MemoryAccess::RT_NONE;
487 return MemoryAccess::RT_MUL;
488 default:
489 return MemoryAccess::RT_NONE;
490 }
491}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000492
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000493/// @brief Derive the individual index expressions from a GEP instruction
494///
495/// This function optimistically assumes the GEP references into a fixed size
496/// array. If this is actually true, this function returns a list of array
497/// subscript expressions as SCEV as well as a list of integers describing
498/// the size of the individual array dimensions. Both lists have either equal
499/// length of the size list is one element shorter in case there is no known
500/// size available for the outermost array dimension.
501///
502/// @param GEP The GetElementPtr instruction to analyze.
503///
504/// @return A tuple with the subscript expressions and the dimension sizes.
505static std::tuple<std::vector<const SCEV *>, std::vector<int>>
506getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
507 std::vector<const SCEV *> Subscripts;
508 std::vector<int> Sizes;
509
510 Type *Ty = GEP->getPointerOperandType();
511
512 bool DroppedFirstDim = false;
513
Michael Kruse26ed65e2015-09-24 17:32:49 +0000514 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000515
516 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
517
518 if (i == 1) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000519 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000520 Ty = PtrTy->getElementType();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000521 } else if (auto *ArrayTy = dyn_cast<ArrayType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000522 Ty = ArrayTy->getElementType();
523 } else {
524 Subscripts.clear();
525 Sizes.clear();
526 break;
527 }
Johannes Doerferta90943d2016-02-21 16:37:25 +0000528 if (auto *Const = dyn_cast<SCEVConstant>(Expr))
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000529 if (Const->getValue()->isZero()) {
530 DroppedFirstDim = true;
531 continue;
532 }
533 Subscripts.push_back(Expr);
534 continue;
535 }
536
Johannes Doerferta90943d2016-02-21 16:37:25 +0000537 auto *ArrayTy = dyn_cast<ArrayType>(Ty);
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000538 if (!ArrayTy) {
539 Subscripts.clear();
540 Sizes.clear();
541 break;
542 }
543
544 Subscripts.push_back(Expr);
545 if (!(DroppedFirstDim && i == 2))
546 Sizes.push_back(ArrayTy->getNumElements());
547
548 Ty = ArrayTy->getElementType();
549 }
550
551 return std::make_tuple(Subscripts, Sizes);
552}
553
Tobias Grosser75805372011-04-29 06:27:02 +0000554MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000555 isl_id_free(Id);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000556 isl_set_free(InvalidDomain);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000557 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000558 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000559}
560
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000561const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
562 isl_id *ArrayId = getArrayId();
563 void *User = isl_id_get_user(ArrayId);
564 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
565 isl_id_free(ArrayId);
566 return SAI;
567}
568
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000569__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000570 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
571}
572
Tobias Grosserd840fc72016-02-04 13:18:42 +0000573__isl_give isl_map *MemoryAccess::getAddressFunction() const {
574 return isl_map_lexmin(getAccessRelation());
575}
576
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000577__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
578 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000579 isl_map *Schedule, *ScheduledAccRel;
580 isl_union_set *UDomain;
581
582 UDomain = isl_union_set_from_set(getStatement()->getDomain());
583 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
584 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000585 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000586 return isl_pw_multi_aff_from_map(ScheduledAccRel);
587}
588
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000589__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000590 return isl_map_copy(AccessRelation);
591}
592
Johannes Doerferta99130f2014-10-13 12:58:03 +0000593std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000594 return stringFromIslObj(AccessRelation);
595}
596
Johannes Doerferta99130f2014-10-13 12:58:03 +0000597__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000598 return isl_map_get_space(AccessRelation);
599}
600
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000601__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000602 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000603}
604
Tobias Grosser6f730082015-09-05 07:46:47 +0000605std::string MemoryAccess::getNewAccessRelationStr() const {
606 return stringFromIslObj(NewAccessRelation);
607}
608
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000609__isl_give isl_basic_map *
610MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000611 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000612 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000613
Tobias Grosser084d8f72012-05-29 09:29:44 +0000614 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000615 isl_basic_set_universe(Statement->getDomainSpace()),
616 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000617}
618
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000619// Formalize no out-of-bound access assumption
620//
621// When delinearizing array accesses we optimistically assume that the
622// delinearized accesses do not access out of bound locations (the subscript
623// expression of each array evaluates for each statement instance that is
624// executed to a value that is larger than zero and strictly smaller than the
625// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000626// dimension for which we do not need to assume any upper bound. At this point
627// we formalize this assumption to ensure that at code generation time the
628// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000629//
630// To find the set of constraints necessary to avoid out of bound accesses, we
631// first build the set of data locations that are not within array bounds. We
632// then apply the reverse access relation to obtain the set of iterations that
633// may contain invalid accesses and reduce this set of iterations to the ones
634// that are actually executed by intersecting them with the domain of the
635// statement. If we now project out all loop dimensions, we obtain a set of
636// parameters that may cause statement instances to be executed that may
637// possibly yield out of bound memory accesses. The complement of these
638// constraints is the set of constraints that needs to be assumed to ensure such
639// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000640void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000641 auto *SAI = getScopArrayInfo();
Johannes Doerferta99130f2014-10-13 12:58:03 +0000642 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000643 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Roman Gareev10595a12016-01-08 14:01:59 +0000644 for (int i = 1, Size = isl_space_dim(Space, isl_dim_set); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000645 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
646 isl_pw_aff *Var =
647 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
648 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
649
650 isl_set *DimOutside;
651
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000652 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfertadeab372016-02-07 13:57:32 +0000653 isl_pw_aff *SizeE = SAI->getDimensionSizePw(i);
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000654 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
655 isl_space_dim(Space, isl_dim_set));
656 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
657 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000658
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000659 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000660
661 Outside = isl_set_union(Outside, DimOutside);
662 }
663
664 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
665 Outside = isl_set_intersect(Outside, Statement->getDomain());
666 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000667
668 // Remove divs to avoid the construction of overly complicated assumptions.
669 // Doing so increases the set of parameter combinations that are assumed to
670 // not appear. This is always save, but may make the resulting run-time check
671 // bail out more often than strictly necessary.
672 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000673 Outside = isl_set_complement(Outside);
Michael Kruse7071e8b2016-04-11 13:24:29 +0000674 const auto &Loc = getAccessInstruction()
675 ? getAccessInstruction()->getDebugLoc()
676 : DebugLoc();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +0000677 Statement->getParent()->recordAssumption(INBOUNDS, Outside, Loc,
678 AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000679 isl_space_free(Space);
680}
681
Johannes Doerfertcea61932016-02-21 19:13:19 +0000682void MemoryAccess::buildMemIntrinsicAccessRelation() {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000683 assert(isa<MemIntrinsic>(getAccessInstruction()));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000684 assert(Subscripts.size() == 2 && Sizes.size() == 0);
685
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000686 auto *SubscriptPWA = getPwAff(Subscripts[0]);
Johannes Doerfertcea61932016-02-21 19:13:19 +0000687 auto *SubscriptMap = isl_map_from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000688
689 isl_map *LengthMap;
690 if (Subscripts[1] == nullptr) {
691 LengthMap = isl_map_universe(isl_map_get_space(SubscriptMap));
692 } else {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000693 auto *LengthPWA = getPwAff(Subscripts[1]);
Johannes Doerferta7920982016-02-25 14:08:48 +0000694 LengthMap = isl_map_from_pw_aff(LengthPWA);
695 auto *RangeSpace = isl_space_range(isl_map_get_space(LengthMap));
696 LengthMap = isl_map_apply_range(LengthMap, isl_map_lex_gt(RangeSpace));
697 }
698 LengthMap = isl_map_lower_bound_si(LengthMap, isl_dim_out, 0, 0);
699 LengthMap = isl_map_align_params(LengthMap, isl_map_get_space(SubscriptMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000700 SubscriptMap =
701 isl_map_align_params(SubscriptMap, isl_map_get_space(LengthMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000702 LengthMap = isl_map_sum(LengthMap, SubscriptMap);
703 AccessRelation = isl_map_set_tuple_id(LengthMap, isl_dim_in,
704 getStatement()->getDomainId());
705}
706
Johannes Doerferte7044942015-02-24 11:58:30 +0000707void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
708 ScalarEvolution *SE = Statement->getParent()->getSE();
709
Johannes Doerfertcea61932016-02-21 19:13:19 +0000710 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000711 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000712 return;
713
714 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000715 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
716 return;
717
718 auto *PtrSCEV = SE->getSCEV(Ptr);
719 if (isa<SCEVCouldNotCompute>(PtrSCEV))
720 return;
721
722 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
723 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
724 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
725
726 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
727 if (Range.isFullSet())
728 return;
729
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000730 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000731 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000732 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000733 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000734 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000735
736 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000737 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000738
739 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
740 AccessRange =
741 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
742 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
743}
744
Michael Krusee2bccbb2015-09-18 19:59:43 +0000745__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000746 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000747 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000748
749 for (int i = Size - 2; i >= 0; --i) {
750 isl_space *Space;
751 isl_map *MapOne, *MapTwo;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000752 isl_pw_aff *DimSize = getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000753
754 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
755 isl_pw_aff_free(DimSize);
756 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
757
758 Space = isl_map_get_space(AccessRelation);
759 Space = isl_space_map_from_set(isl_space_range(Space));
760 Space = isl_space_align_params(Space, SpaceSize);
761
762 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
763 isl_id_free(ParamId);
764
765 MapOne = isl_map_universe(isl_space_copy(Space));
766 for (int j = 0; j < Size; ++j)
767 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
768 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
769
770 MapTwo = isl_map_universe(isl_space_copy(Space));
771 for (int j = 0; j < Size; ++j)
772 if (j < i || j > i + 1)
773 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
774
775 isl_local_space *LS = isl_local_space_from_space(Space);
776 isl_constraint *C;
777 C = isl_equality_alloc(isl_local_space_copy(LS));
778 C = isl_constraint_set_constant_si(C, -1);
779 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
780 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
781 MapTwo = isl_map_add_constraint(MapTwo, C);
782 C = isl_equality_alloc(LS);
783 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
784 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
785 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
786 MapTwo = isl_map_add_constraint(MapTwo, C);
787 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
788
789 MapOne = isl_map_union(MapOne, MapTwo);
790 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
791 }
792 return AccessRelation;
793}
794
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000795/// @brief Check if @p Expr is divisible by @p Size.
796static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000797 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000798 if (Size == 1)
799 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000800
801 // Only one factor needs to be divisible.
802 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
803 for (auto *FactorExpr : MulExpr->operands())
804 if (isDivisible(FactorExpr, Size, SE))
805 return true;
806 return false;
807 }
808
809 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
810 // to be divisble.
811 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
812 for (auto *OpExpr : NAryExpr->operands())
813 if (!isDivisible(OpExpr, Size, SE))
814 return false;
815 return true;
816 }
817
818 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
819 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
820 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
821 return MulSCEV == Expr;
822}
823
Michael Krusee2bccbb2015-09-18 19:59:43 +0000824void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
825 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000826
Johannes Doerfert85676e32016-04-23 14:32:34 +0000827 // Initialize the invalid domain which describes all iterations for which the
828 // access relation is not modeled correctly.
Johannes Doerferta4dd8ef2016-04-25 13:36:23 +0000829 auto *StmtInvalidDomain = getStatement()->getInvalidDomain();
830 InvalidDomain = isl_set_empty(isl_set_get_space(StmtInvalidDomain));
831 isl_set_free(StmtInvalidDomain);
Johannes Doerfert85676e32016-04-23 14:32:34 +0000832
Michael Krusee2bccbb2015-09-18 19:59:43 +0000833 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000834 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000835
Michael Krusee2bccbb2015-09-18 19:59:43 +0000836 if (!isAffine()) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000837 if (isa<MemIntrinsic>(getAccessInstruction()))
838 buildMemIntrinsicAccessRelation();
839
Tobias Grosser4f967492013-06-23 05:21:18 +0000840 // We overapproximate non-affine accesses with a possible access to the
841 // whole array. For read accesses it does not make a difference, if an
842 // access must or may happen. However, for write accesses it is important to
843 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000844 if (!AccessRelation)
845 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
846
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000847 AccessRelation =
848 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000849 return;
850 }
851
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000852 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000853 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000854
Michael Krusee2bccbb2015-09-18 19:59:43 +0000855 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000856 isl_pw_aff *Affine = getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000857 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000858 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000859 }
860
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000861 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000862 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000863
Tobias Grosser79baa212014-04-10 08:38:02 +0000864 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000865 AccessRelation = isl_map_set_tuple_id(
866 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000867 AccessRelation =
868 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
869
Tobias Grosseraa660a92015-03-30 00:07:50 +0000870 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000871 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000872}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000873
Michael Krusecac948e2015-10-02 13:53:07 +0000874MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +0000875 AccessType AccType, Value *BaseAddress,
876 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000877 ArrayRef<const SCEV *> Subscripts,
878 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000879 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
Johannes Doerfertcea61932016-02-21 19:13:19 +0000880 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
Johannes Doerfert85676e32016-04-23 14:32:34 +0000881 InvalidDomain(nullptr), BaseAddr(BaseAddress), BaseName(BaseName),
882 ElementType(ElementType), Sizes(Sizes.begin(), Sizes.end()),
883 AccessInstruction(AccessInst), AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000884 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000885 NewAccessRelation(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000886 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Johannes Doerfertcea61932016-02-21 19:13:19 +0000887 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size()) + "_";
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000888
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000889 std::string IdName =
890 getIslCompatibleName(Stmt->getBaseName(), Access, BaseName);
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000891 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
892}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000893
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000894void MemoryAccess::realignParams() {
Johannes Doerferta60ad842016-05-10 12:18:22 +0000895 auto *Ctx = Statement->getParent()->getContext();
896 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
897 AccessRelation = isl_map_gist_params(AccessRelation, Ctx);
Tobias Grosser75805372011-04-29 06:27:02 +0000898}
899
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000900const std::string MemoryAccess::getReductionOperatorStr() const {
901 return MemoryAccess::getReductionOperatorStr(getReductionType());
902}
903
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000904__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
905
Johannes Doerfertf6183392014-07-01 20:52:51 +0000906raw_ostream &polly::operator<<(raw_ostream &OS,
907 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000908 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000909 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000910 else
911 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000912 return OS;
913}
914
Tobias Grosser75805372011-04-29 06:27:02 +0000915void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000916 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000917 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000918 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000919 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000920 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000921 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000922 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000923 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000924 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000925 break;
926 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000927 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000928 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000929 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000930 if (hasNewAccessRelation())
931 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000932}
933
Tobias Grosser74394f02013-01-14 22:40:23 +0000934void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000935
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000936__isl_give isl_pw_aff *MemoryAccess::getPwAff(const SCEV *E) {
937 auto *Stmt = getStatement();
Johannes Doerfert85676e32016-04-23 14:32:34 +0000938 PWACtx PWAC = Stmt->getParent()->getPwAff(E, Stmt->getEntryBlock());
939 InvalidDomain = isl_set_union(InvalidDomain, PWAC.second);
940 return PWAC.first;
Johannes Doerfert97f0dcd2016-04-12 13:26:45 +0000941}
942
Tobias Grosser75805372011-04-29 06:27:02 +0000943// Create a map in the size of the provided set domain, that maps from the
944// one element of the provided set domain to another element of the provided
945// set domain.
946// The mapping is limited to all points that are equal in all but the last
947// dimension and for which the last dimension of the input is strict smaller
948// than the last dimension of the output.
949//
950// getEqualAndLarger(set[i0, i1, ..., iX]):
951//
952// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
953// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
954//
Tobias Grosserf5338802011-10-06 00:03:35 +0000955static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000956 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000957 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000958 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000959
960 // Set all but the last dimension to be equal for the input and output
961 //
962 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
963 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000964 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000965 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000966
967 // Set the last dimension of the input to be strict smaller than the
968 // last dimension of the output.
969 //
970 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000971 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
972 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000973 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000974}
975
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000976__isl_give isl_set *
977MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000978 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000979 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000980 isl_space *Space = isl_space_range(isl_map_get_space(S));
981 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000982
Sebastian Popa00a0292012-12-18 07:46:06 +0000983 S = isl_map_reverse(S);
984 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000985
Sebastian Popa00a0292012-12-18 07:46:06 +0000986 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
987 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
988 NextScatt = isl_map_apply_domain(NextScatt, S);
989 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000990
Sebastian Popa00a0292012-12-18 07:46:06 +0000991 isl_set *Deltas = isl_map_deltas(NextScatt);
992 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000993}
994
Sebastian Popa00a0292012-12-18 07:46:06 +0000995bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000996 int StrideWidth) const {
997 isl_set *Stride, *StrideX;
998 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000999
Sebastian Popa00a0292012-12-18 07:46:06 +00001000 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +00001001 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +00001002 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
1003 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
1004 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
1005 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +00001006 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +00001007
Tobias Grosser28dd4862012-01-24 16:42:16 +00001008 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +00001009 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +00001010
Tobias Grosser28dd4862012-01-24 16:42:16 +00001011 return IsStrideX;
1012}
1013
Sebastian Popa00a0292012-12-18 07:46:06 +00001014bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
1015 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001016}
1017
Sebastian Popa00a0292012-12-18 07:46:06 +00001018bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
1019 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +00001020}
1021
Tobias Grosser166c4222015-09-05 07:46:40 +00001022void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
1023 isl_map_free(NewAccessRelation);
1024 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +00001025}
Tobias Grosser75805372011-04-29 06:27:02 +00001026
1027//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +00001028
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001029__isl_give isl_map *ScopStmt::getSchedule() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001030 isl_set *Domain = getDomain();
1031 if (isl_set_is_empty(Domain)) {
1032 isl_set_free(Domain);
1033 return isl_map_from_aff(
1034 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1035 }
1036 auto *Schedule = getParent()->getSchedule();
1037 Schedule = isl_union_map_intersect_domain(
1038 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
1039 if (isl_union_map_is_empty(Schedule)) {
1040 isl_set_free(Domain);
1041 isl_union_map_free(Schedule);
1042 return isl_map_from_aff(
1043 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
1044 }
1045 auto *M = isl_map_from_union_map(Schedule);
1046 M = isl_map_coalesce(M);
1047 M = isl_map_gist_domain(M, Domain);
1048 M = isl_map_coalesce(M);
1049 return M;
1050}
Tobias Grossercf3942d2011-10-06 00:04:05 +00001051
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001052__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E, bool NonNegative) {
1053 PWACtx PWAC = getParent()->getPwAff(E, getEntryBlock(), NonNegative);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00001054 InvalidDomain = isl_set_union(InvalidDomain, PWAC.second);
1055 return PWAC.first;
Johannes Doerfert574182d2015-08-12 10:19:50 +00001056}
1057
Tobias Grosser37eb4222014-02-20 21:43:54 +00001058void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
1059 assert(isl_set_is_subset(NewDomain, Domain) &&
1060 "New domain is not a subset of old domain!");
1061 isl_set_free(Domain);
1062 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +00001063}
1064
Michael Krusecac948e2015-10-02 13:53:07 +00001065void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +00001066 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +00001067 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00001068 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001069
Tobias Grossera535dff2015-12-13 19:59:01 +00001070 ScopArrayInfo::MemoryKind Ty;
1071 if (Access->isPHIKind())
1072 Ty = ScopArrayInfo::MK_PHI;
1073 else if (Access->isExitPHIKind())
1074 Ty = ScopArrayInfo::MK_ExitPHI;
1075 else if (Access->isValueKind())
1076 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001077 else
Tobias Grossera535dff2015-12-13 19:59:01 +00001078 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +00001079
Johannes Doerfertadeab372016-02-07 13:57:32 +00001080 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
1081 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001082 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +00001083 }
1084}
1085
Michael Krusecac948e2015-10-02 13:53:07 +00001086void ScopStmt::addAccess(MemoryAccess *Access) {
1087 Instruction *AccessInst = Access->getAccessInstruction();
1088
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001089 if (Access->isArrayKind()) {
1090 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1091 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001092 } else if (Access->isValueKind() && Access->isWrite()) {
1093 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001094 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001095 assert(!ValueWrites.lookup(AccessVal));
1096
1097 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001098 } else if (Access->isValueKind() && Access->isRead()) {
1099 Value *AccessVal = Access->getAccessValue();
1100 assert(!ValueReads.lookup(AccessVal));
1101
1102 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001103 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
1104 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
1105 assert(!PHIWrites.lookup(PHI));
1106
1107 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001108 }
1109
1110 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001111}
1112
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001113void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001114 for (MemoryAccess *MA : *this)
1115 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001116
Johannes Doerferta60ad842016-05-10 12:18:22 +00001117 auto *Ctx = Parent.getContext();
1118 InvalidDomain = isl_set_gist_params(InvalidDomain, isl_set_copy(Ctx));
1119 Domain = isl_set_gist_params(Domain, Ctx);
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001120}
1121
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001122/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1123static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1124 void *User) {
1125 isl_set **BoundedParts = static_cast<isl_set **>(User);
1126 if (isl_basic_set_is_bounded(BSet))
1127 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1128 else
1129 isl_basic_set_free(BSet);
1130 return isl_stat_ok;
1131}
1132
1133/// @brief Return the bounded parts of @p S.
1134static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1135 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1136 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1137 isl_set_free(S);
1138 return BoundedParts;
1139}
1140
1141/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1142///
1143/// @returns A separation of @p S into first an unbounded then a bounded subset,
1144/// both with regards to the dimension @p Dim.
1145static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1146partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1147
1148 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001149 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001150
1151 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001152 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001153
1154 // Remove dimensions that are greater than Dim as they are not interesting.
1155 assert(NumDimsS >= Dim + 1);
1156 OnlyDimS =
1157 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1158
1159 // Create artificial parametric upper bounds for dimensions smaller than Dim
1160 // as we are not interested in them.
1161 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1162 for (unsigned u = 0; u < Dim; u++) {
1163 isl_constraint *C = isl_inequality_alloc(
1164 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1165 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1166 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1167 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1168 }
1169
1170 // Collect all bounded parts of OnlyDimS.
1171 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1172
1173 // Create the dimensions greater than Dim again.
1174 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1175 NumDimsS - Dim - 1);
1176
1177 // Remove the artificial upper bound parameters again.
1178 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1179
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001180 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001181 return std::make_pair(UnboundedParts, BoundedParts);
1182}
1183
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001184/// @brief Set the dimension Ids from @p From in @p To.
1185static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1186 __isl_take isl_set *To) {
1187 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1188 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1189 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1190 }
1191 return To;
1192}
1193
1194/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001195static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001196 __isl_take isl_pw_aff *L,
1197 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001198 switch (Pred) {
1199 case ICmpInst::ICMP_EQ:
1200 return isl_pw_aff_eq_set(L, R);
1201 case ICmpInst::ICMP_NE:
1202 return isl_pw_aff_ne_set(L, R);
1203 case ICmpInst::ICMP_SLT:
1204 return isl_pw_aff_lt_set(L, R);
1205 case ICmpInst::ICMP_SLE:
1206 return isl_pw_aff_le_set(L, R);
1207 case ICmpInst::ICMP_SGT:
1208 return isl_pw_aff_gt_set(L, R);
1209 case ICmpInst::ICMP_SGE:
1210 return isl_pw_aff_ge_set(L, R);
1211 case ICmpInst::ICMP_ULT:
1212 return isl_pw_aff_lt_set(L, R);
1213 case ICmpInst::ICMP_UGT:
1214 return isl_pw_aff_gt_set(L, R);
1215 case ICmpInst::ICMP_ULE:
1216 return isl_pw_aff_le_set(L, R);
1217 case ICmpInst::ICMP_UGE:
1218 return isl_pw_aff_ge_set(L, R);
1219 default:
1220 llvm_unreachable("Non integer predicate not supported");
1221 }
1222}
1223
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001224/// @brief Create the conditions under which @p L @p Pred @p R is true.
1225///
1226/// Helper function that will make sure the dimensions of the result have the
1227/// same isl_id's as the @p Domain.
1228static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1229 __isl_take isl_pw_aff *L,
1230 __isl_take isl_pw_aff *R,
1231 __isl_keep isl_set *Domain) {
1232 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1233 return setDimensionIds(Domain, ConsequenceCondSet);
1234}
1235
1236/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001237///
1238/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001239/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1240/// have as many elements as @p SI has successors.
Johannes Doerfert297c7202016-05-10 13:06:42 +00001241static bool
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001242buildConditionSets(ScopStmt &Stmt, SwitchInst *SI, Loop *L,
1243 __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001244 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1245
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001246 Value *Condition = getConditionFromTerminator(SI);
1247 assert(Condition && "No condition for switch");
1248
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001249 Scop &S = *Stmt.getParent();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001250 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001251 isl_pw_aff *LHS, *RHS;
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001252 LHS = Stmt.getPwAff(SE.getSCEVAtScope(Condition, L));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001253
1254 unsigned NumSuccessors = SI->getNumSuccessors();
1255 ConditionSets.resize(NumSuccessors);
1256 for (auto &Case : SI->cases()) {
1257 unsigned Idx = Case.getSuccessorIndex();
1258 ConstantInt *CaseValue = Case.getCaseValue();
1259
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001260 RHS = Stmt.getPwAff(SE.getSCEV(CaseValue));
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001261 isl_set *CaseConditionSet =
1262 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1263 ConditionSets[Idx] = isl_set_coalesce(
1264 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1265 }
1266
1267 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1268 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1269 for (unsigned u = 2; u < NumSuccessors; u++)
1270 ConditionSetUnion =
1271 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1272 ConditionSets[0] = setDimensionIds(
1273 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1274
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001275 isl_pw_aff_free(LHS);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001276
1277 return true;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001278}
1279
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001280/// @brief Build the conditions sets for the branch condition @p Condition in
1281/// the @p Domain.
1282///
1283/// This will fill @p ConditionSets with the conditions under which control
1284/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001285/// have as many elements as @p TI has successors. If @p TI is nullptr the
1286/// context under which @p Condition is true/false will be returned as the
1287/// new elements of @p ConditionSets.
Johannes Doerfert297c7202016-05-10 13:06:42 +00001288static bool
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001289buildConditionSets(ScopStmt &Stmt, Value *Condition, TerminatorInst *TI,
1290 Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001291 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1292
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001293 Scop &S = *Stmt.getParent();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001294 isl_set *ConsequenceCondSet = nullptr;
1295 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1296 if (CCond->isZero())
1297 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1298 else
1299 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1300 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1301 auto Opcode = BinOp->getOpcode();
1302 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1303
Johannes Doerfert297c7202016-05-10 13:06:42 +00001304 if (!buildConditionSets(Stmt, BinOp->getOperand(0), TI, L, Domain,
1305 ConditionSets))
1306 return false;
1307 if (!buildConditionSets(Stmt, BinOp->getOperand(1), TI, L, Domain,
1308 ConditionSets))
1309 return false;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001310
1311 isl_set_free(ConditionSets.pop_back_val());
1312 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1313 isl_set_free(ConditionSets.pop_back_val());
1314 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1315
1316 if (Opcode == Instruction::And)
1317 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1318 else
1319 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1320 } else {
1321 auto *ICond = dyn_cast<ICmpInst>(Condition);
1322 assert(ICond &&
1323 "Condition of exiting branch was neither constant nor ICmp!");
1324
1325 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001326 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001327 // For unsigned comparisons we assumed the signed bit of neither operand
1328 // to be set. The comparison is equal to a signed comparison under this
1329 // assumption.
1330 bool NonNeg = ICond->isUnsigned();
1331 LHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), NonNeg);
1332 RHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), NonNeg);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001333 ConsequenceCondSet =
1334 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1335 }
1336
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001337 // If no terminator was given we are only looking for parameter constraints
1338 // under which @p Condition is true/false.
1339 if (!TI)
1340 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001341 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001342 ConsequenceCondSet = isl_set_coalesce(
1343 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001344
Johannes Doerfertb2885792016-04-26 09:20:41 +00001345 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001346 bool TooComplex =
Michael Krusebc150122016-05-02 12:25:18 +00001347 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctionsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001348
Michael Krusef7a4a942016-05-02 12:25:36 +00001349 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001350 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1351 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001352 TooComplex =
Michael Krusebc150122016-05-02 12:25:18 +00001353 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctionsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001354 }
1355
Michael Krusef7a4a942016-05-02 12:25:36 +00001356 if (TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001357 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc());
Johannes Doerfertb2885792016-04-26 09:20:41 +00001358 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001359 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001360 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001361 }
1362
1363 ConditionSets.push_back(ConsequenceCondSet);
1364 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001365
1366 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001367}
1368
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001369/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1370///
1371/// This will fill @p ConditionSets with the conditions under which control
1372/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1373/// have as many elements as @p TI has successors.
Johannes Doerfert297c7202016-05-10 13:06:42 +00001374static bool
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001375buildConditionSets(ScopStmt &Stmt, TerminatorInst *TI, Loop *L,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001376 __isl_keep isl_set *Domain,
1377 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1378
1379 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001380 return buildConditionSets(Stmt, SI, L, Domain, ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001381
1382 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1383
1384 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001385 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001386 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001387 }
1388
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001389 Value *Condition = getConditionFromTerminator(TI);
1390 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001391
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001392 return buildConditionSets(Stmt, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001393}
1394
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001395void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001396 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001397
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001398 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001399 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001400}
1401
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001402void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1403 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001404 isl_ctx *Ctx = Parent.getIslCtx();
1405 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1406 Type *Ty = GEP->getPointerOperandType();
1407 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001408
1409 // The set of loads that are required to be invariant.
1410 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001411
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001412 std::vector<const SCEV *> Subscripts;
1413 std::vector<int> Sizes;
1414
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001415 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001416
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001417 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001418 Ty = PtrTy->getElementType();
1419 }
1420
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001421 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001422
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001423 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001424
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001425 auto *NotExecuted = isl_set_complement(isl_set_params(getDomain()));
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001426 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001427 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001428 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001429
Michael Kruse09eb4452016-03-03 22:10:47 +00001430 auto *Scope = SD.getLI()->getLoopFor(getEntryBlock());
Johannes Doerfert09e36972015-10-07 20:17:36 +00001431 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00001432 if (!isAffineExpr(&Parent.getRegion(), Scope, Expr, SE, &AccessILS))
Johannes Doerfert09e36972015-10-07 20:17:36 +00001433 continue;
1434
1435 bool NonAffine = false;
1436 for (LoadInst *LInst : AccessILS)
1437 if (!ScopRIL.count(LInst))
1438 NonAffine = true;
1439
1440 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001441 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001442
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001443 isl_pw_aff *AccessOffset = getPwAff(Expr);
1444 AccessOffset =
1445 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001446
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001447 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1448 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001449
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001450 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1451 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1452 OutOfBound = isl_set_params(OutOfBound);
1453 isl_set *InBound = isl_set_complement(OutOfBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001454
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001455 // A => B == !A or B
1456 isl_set *InBoundIfExecuted =
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001457 isl_set_union(isl_set_copy(NotExecuted), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001458
Roman Gareev10595a12016-01-08 14:01:59 +00001459 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00001460 Parent.recordAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc(),
1461 AS_ASSUMPTION);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001462 }
1463
1464 isl_local_space_free(LSpace);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001465 isl_set_free(NotExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001466}
1467
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001468void ScopStmt::deriveAssumptions(ScopDetection &SD) {
1469 for (auto *MA : *this) {
1470 if (!MA->isArrayKind())
1471 continue;
1472
1473 MemAccInst Acc(MA->getAccessInstruction());
1474 auto *GEP = dyn_cast_or_null<GetElementPtrInst>(Acc.getPointerOperand());
1475
1476 if (GEP)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001477 deriveAssumptionsFromGEP(GEP, SD);
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001478 }
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001479}
1480
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001481void ScopStmt::collectSurroundingLoops() {
1482 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1483 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1484 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1485 isl_id_free(DimId);
1486 }
1487}
1488
Michael Kruse9d080092015-09-11 21:41:48 +00001489ScopStmt::ScopStmt(Scop &parent, Region &R)
Johannes Doerferta3519512016-04-23 13:02:23 +00001490 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
1491 R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001492
Tobias Grosser16c44032015-07-09 07:31:45 +00001493 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001494}
1495
Michael Kruse9d080092015-09-11 21:41:48 +00001496ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Johannes Doerferta3519512016-04-23 13:02:23 +00001497 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
1498 R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001499
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001500 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001501}
1502
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001503void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001504 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001505
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001506 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001507 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001508 buildAccessRelations();
1509
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001510 deriveAssumptions(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001511
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001512 if (DetectReductions)
1513 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001514}
1515
Johannes Doerferte58a0122014-06-27 20:31:28 +00001516/// @brief Collect loads which might form a reduction chain with @p StoreMA
1517///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001518/// Check if the stored value for @p StoreMA is a binary operator with one or
1519/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001520/// used only once (by @p StoreMA) and its load operands are also used only
1521/// once, we have found a possible reduction chain. It starts at an operand
1522/// load and includes the binary operator and @p StoreMA.
1523///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001524/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001525/// escape this block or into any other store except @p StoreMA.
1526void ScopStmt::collectCandiateReductionLoads(
1527 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1528 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1529 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001530 return;
1531
1532 // Skip if there is not one binary operator between the load and the store
1533 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001534 if (!BinOp)
1535 return;
1536
1537 // Skip if the binary operators has multiple uses
1538 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001539 return;
1540
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001541 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001542 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1543 return;
1544
Johannes Doerfert9890a052014-07-01 00:32:29 +00001545 // Skip if the binary operator is outside the current SCoP
1546 if (BinOp->getParent() != Store->getParent())
1547 return;
1548
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001549 // Skip if it is a multiplicative reduction and we disabled them
1550 if (DisableMultiplicativeReductions &&
1551 (BinOp->getOpcode() == Instruction::Mul ||
1552 BinOp->getOpcode() == Instruction::FMul))
1553 return;
1554
Johannes Doerferte58a0122014-06-27 20:31:28 +00001555 // Check the binary operator operands for a candidate load
1556 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1557 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1558 if (!PossibleLoad0 && !PossibleLoad1)
1559 return;
1560
1561 // A load is only a candidate if it cannot escape (thus has only this use)
1562 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001563 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001564 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001565 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001566 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001567 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001568}
1569
1570/// @brief Check for reductions in this ScopStmt
1571///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001572/// Iterate over all store memory accesses and check for valid binary reduction
1573/// like chains. For all candidates we check if they have the same base address
1574/// and there are no other accesses which overlap with them. The base address
1575/// check rules out impossible reductions candidates early. The overlap check,
1576/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001577/// guarantees that none of the intermediate results will escape during
1578/// execution of the loop nest. We basically check here that no other memory
1579/// access can access the same memory as the potential reduction.
1580void ScopStmt::checkForReductions() {
1581 SmallVector<MemoryAccess *, 2> Loads;
1582 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1583
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001584 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001585 // stores and collecting possible reduction loads.
1586 for (MemoryAccess *StoreMA : MemAccs) {
1587 if (StoreMA->isRead())
1588 continue;
1589
1590 Loads.clear();
1591 collectCandiateReductionLoads(StoreMA, Loads);
1592 for (MemoryAccess *LoadMA : Loads)
1593 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1594 }
1595
1596 // Then check each possible candidate pair.
1597 for (const auto &CandidatePair : Candidates) {
1598 bool Valid = true;
1599 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1600 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1601
1602 // Skip those with obviously unequal base addresses.
1603 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1604 isl_map_free(LoadAccs);
1605 isl_map_free(StoreAccs);
1606 continue;
1607 }
1608
1609 // And check if the remaining for overlap with other memory accesses.
1610 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1611 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1612 isl_set *AllAccs = isl_map_range(AllAccsRel);
1613
1614 for (MemoryAccess *MA : MemAccs) {
1615 if (MA == CandidatePair.first || MA == CandidatePair.second)
1616 continue;
1617
1618 isl_map *AccRel =
1619 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1620 isl_set *Accs = isl_map_range(AccRel);
1621
1622 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1623 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1624 Valid = Valid && isl_set_is_empty(OverlapAccs);
1625 isl_set_free(OverlapAccs);
1626 }
1627 }
1628
1629 isl_set_free(AllAccs);
1630 if (!Valid)
1631 continue;
1632
Johannes Doerfertf6183392014-07-01 20:52:51 +00001633 const LoadInst *Load =
1634 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1635 MemoryAccess::ReductionType RT =
1636 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1637
Johannes Doerferte58a0122014-06-27 20:31:28 +00001638 // If no overlapping access was found we mark the load and store as
1639 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001640 CandidatePair.first->markAsReductionLike(RT);
1641 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001642 }
Tobias Grosser75805372011-04-29 06:27:02 +00001643}
1644
Tobias Grosser74394f02013-01-14 22:40:23 +00001645std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001646
Tobias Grosser54839312015-04-21 11:37:25 +00001647std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001648 auto *S = getSchedule();
1649 auto Str = stringFromIslObj(S);
1650 isl_map_free(S);
1651 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001652}
1653
Johannes Doerferta3519512016-04-23 13:02:23 +00001654void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1655 isl_set_free(InvalidDomain);
1656 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001657}
1658
Michael Kruse375cb5f2016-02-24 22:08:24 +00001659BasicBlock *ScopStmt::getEntryBlock() const {
1660 if (isBlockStmt())
1661 return getBasicBlock();
1662 return getRegion()->getEntry();
1663}
1664
Tobias Grosser74394f02013-01-14 22:40:23 +00001665unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001666
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001667unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001668
Tobias Grosser75805372011-04-29 06:27:02 +00001669const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1670
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001671const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001672 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001673}
1674
Tobias Grosser74394f02013-01-14 22:40:23 +00001675isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001676
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001677__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001678
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001679__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001680 return isl_set_get_space(Domain);
1681}
1682
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001683__isl_give isl_id *ScopStmt::getDomainId() const {
1684 return isl_set_get_tuple_id(Domain);
1685}
Tobias Grossercd95b772012-08-30 11:49:38 +00001686
Johannes Doerfert7c013572016-04-12 09:57:34 +00001687ScopStmt::~ScopStmt() {
1688 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001689 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001690}
Tobias Grosser75805372011-04-29 06:27:02 +00001691
1692void ScopStmt::print(raw_ostream &OS) const {
1693 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001694 OS.indent(12) << "Domain :=\n";
1695
1696 if (Domain) {
1697 OS.indent(16) << getDomainStr() << ";\n";
1698 } else
1699 OS.indent(16) << "n/a\n";
1700
Tobias Grosser54839312015-04-21 11:37:25 +00001701 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001702
1703 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001704 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001705 } else
1706 OS.indent(16) << "n/a\n";
1707
Tobias Grosser083d3d32014-06-28 08:59:45 +00001708 for (MemoryAccess *Access : MemAccs)
1709 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001710}
1711
1712void ScopStmt::dump() const { print(dbgs()); }
1713
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001714void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001715 // Remove all memory accesses in @p InvMAs from this statement
1716 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001717 // MK_Value READs have no access instruction, hence would not be removed by
1718 // this function. However, it is only used for invariant LoadInst accesses,
1719 // its arguments are always affine, hence synthesizable, and therefore there
1720 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001721 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001722 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001723 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001724 };
1725 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1726 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001727 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001728 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001729}
1730
Tobias Grosser75805372011-04-29 06:27:02 +00001731//===----------------------------------------------------------------------===//
1732/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001733
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001734void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001735 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1736 isl_set_free(Context);
1737 Context = NewContext;
1738}
1739
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001740/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1741struct SCEVSensitiveParameterRewriter
1742 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1743 ValueToValueMap &VMap;
1744 ScalarEvolution &SE;
1745
1746public:
1747 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1748 : VMap(VMap), SE(SE) {}
1749
1750 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1751 ValueToValueMap &VMap) {
1752 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1753 return SSPR.visit(E);
1754 }
1755
1756 const SCEV *visit(const SCEV *E) {
1757 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1758 }
1759
1760 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1761
1762 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1763 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1764 }
1765
1766 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1767 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1768 }
1769
1770 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1771 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1772 }
1773
1774 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1775 SmallVector<const SCEV *, 4> Operands;
1776 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1777 Operands.push_back(visit(E->getOperand(i)));
1778 return SE.getAddExpr(Operands);
1779 }
1780
1781 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1782 SmallVector<const SCEV *, 4> Operands;
1783 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1784 Operands.push_back(visit(E->getOperand(i)));
1785 return SE.getMulExpr(Operands);
1786 }
1787
1788 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1789 SmallVector<const SCEV *, 4> Operands;
1790 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1791 Operands.push_back(visit(E->getOperand(i)));
1792 return SE.getSMaxExpr(Operands);
1793 }
1794
1795 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1796 SmallVector<const SCEV *, 4> Operands;
1797 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1798 Operands.push_back(visit(E->getOperand(i)));
1799 return SE.getUMaxExpr(Operands);
1800 }
1801
1802 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1803 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1804 }
1805
1806 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1807 auto *Start = visit(E->getStart());
1808 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1809 visit(E->getStepRecurrence(SE)),
1810 E->getLoop(), SCEV::FlagAnyWrap);
1811 return SE.getAddExpr(Start, AddRec);
1812 }
1813
1814 const SCEV *visitUnknown(const SCEVUnknown *E) {
1815 if (auto *NewValue = VMap.lookup(E->getValue()))
1816 return SE.getUnknown(NewValue);
1817 return E;
1818 }
1819};
1820
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001821const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001822 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001823}
1824
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001825void Scop::createParameterId(const SCEV *Parameter) {
1826 assert(Parameters.count(Parameter));
1827 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001828
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001829 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001830
Tobias Grosser8f99c162011-11-15 11:38:55 +00001831 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1832 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001833
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001834 // If this parameter references a specific Value and this value has a name
1835 // we use this name as it is likely to be unique and more useful than just
1836 // a number.
1837 if (Val->hasName())
1838 ParameterName = Val->getName();
1839 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001840 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001841 if (LoadOrigin->hasName()) {
1842 ParameterName += "_loaded_from_";
1843 ParameterName +=
1844 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1845 }
1846 }
1847 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001848
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001849 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1850 const_cast<void *>((const void *)Parameter));
1851 ParameterIds[Parameter] = Id;
1852}
1853
1854void Scop::addParams(const ParameterSetTy &NewParameters) {
1855 for (const SCEV *Parameter : NewParameters) {
1856 // Normalize the SCEV to get the representing element for an invariant load.
1857 Parameter = extractConstantFactor(Parameter, *SE).second;
1858 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1859
1860 if (Parameters.insert(Parameter))
1861 createParameterId(Parameter);
1862 }
1863}
1864
1865__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
1866 // Normalize the SCEV to get the representing element for an invariant load.
1867 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1868 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001869}
Tobias Grosser75805372011-04-29 06:27:02 +00001870
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001871__isl_give isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001872 isl_set *DomainContext = isl_union_set_params(getDomains());
1873 return isl_set_intersect_params(C, DomainContext);
1874}
1875
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001876void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1877 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001878 auto *R = &getRegion();
1879 auto &F = *R->getEntry()->getParent();
1880 for (auto &Assumption : AC.assumptions()) {
1881 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1882 if (!CI || CI->getNumArgOperands() != 1)
1883 continue;
1884 if (!DT.dominates(CI->getParent(), R->getEntry()))
1885 continue;
1886
Michael Kruse09eb4452016-03-03 22:10:47 +00001887 auto *L = LI.getLoopFor(CI->getParent());
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001888 auto *Val = CI->getArgOperand(0);
Johannes Doerfertf560b3d2016-04-25 13:33:07 +00001889 ParameterSetTy DetectedParams;
1890 if (!isAffineParamConstraint(Val, R, L, *SE, DetectedParams)) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001891 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1892 CI->getDebugLoc(),
1893 "Non-affine user assumption ignored.");
1894 continue;
1895 }
1896
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001897 // Collect all newly introduced parameters.
1898 ParameterSetTy NewParams;
1899 for (auto *Param : DetectedParams) {
1900 Param = extractConstantFactor(Param, *SE).second;
1901 Param = getRepresentingInvariantLoadSCEV(Param);
1902 if (Parameters.count(Param))
1903 continue;
1904 NewParams.insert(Param);
1905 }
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001906
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001907 SmallVector<isl_set *, 2> ConditionSets;
Johannes Doerfert297c7202016-05-10 13:06:42 +00001908 if (!buildConditionSets(*Stmts.begin(), Val, nullptr, L, Context,
1909 ConditionSets))
1910 continue;
1911
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
Johannes Doerferta60ad842016-05-10 12:18:22 +00002035 // As all parameters are known add bounds to them.
2036 addParameterBounds();
2037
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002038 for (ScopStmt &Stmt : *this)
2039 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002040}
2041
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002042static __isl_give isl_set *
2043simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2044 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002045 // If we modelt all blocks in the SCoP that have side effects we can simplify
2046 // the context with the constraints that are needed for anything to be
2047 // executed at all. However, if we have error blocks in the SCoP we already
2048 // assumed some parameter combinations cannot occure and removed them from the
2049 // domains, thus we cannot use the remaining domain to simplify the
2050 // assumptions.
2051 if (!S.hasErrorBlock()) {
2052 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2053 AssumptionContext =
2054 isl_set_gist_params(AssumptionContext, DomainParameters);
2055 }
2056
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002057 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2058 return AssumptionContext;
2059}
2060
2061void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002062 // The parameter constraints of the iteration domains give us a set of
2063 // constraints that need to hold for all cases where at least a single
2064 // statement iteration is executed in the whole scop. We now simplify the
2065 // assumed context under the assumption that such constraints hold and at
2066 // least a single statement iteration is executed. For cases where no
2067 // statement instances are executed, the assumptions we have taken about
2068 // the executed code do not matter and can be changed.
2069 //
2070 // WARNING: This only holds if the assumptions we have taken do not reduce
2071 // the set of statement instances that are executed. Otherwise we
2072 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002073 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002074 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002075 // performed. In such a case, modifying the run-time conditions and
2076 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002077 // to not be executed.
2078 //
2079 // Example:
2080 //
2081 // When delinearizing the following code:
2082 //
2083 // for (long i = 0; i < 100; i++)
2084 // for (long j = 0; j < m; j++)
2085 // A[i+p][j] = 1.0;
2086 //
2087 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002088 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002089 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002090 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002091 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002092}
2093
Johannes Doerfertb164c792014-09-18 11:17:17 +00002094/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00002095static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002096 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
2097 isl_pw_multi_aff *MinPMA, *MaxPMA;
2098 isl_pw_aff *LastDimAff;
2099 isl_aff *OneAff;
2100 unsigned Pos;
2101
Johannes Doerfert6296d952016-04-22 11:38:19 +00002102 Set = isl_set_remove_divs(Set);
2103
Michael Krusebc150122016-05-02 12:25:18 +00002104 if (isl_set_n_basic_set(Set) >= MaxDisjunctionsInDomain) {
Johannes Doerfert6296d952016-04-22 11:38:19 +00002105 isl_set_free(Set);
2106 return isl_stat_error;
2107 }
2108
Johannes Doerfert9143d672014-09-27 11:02:39 +00002109 // Restrict the number of parameters involved in the access as the lexmin/
2110 // lexmax computation will take too long if this number is high.
2111 //
2112 // Experiments with a simple test case using an i7 4800MQ:
2113 //
2114 // #Parameters involved | Time (in sec)
2115 // 6 | 0.01
2116 // 7 | 0.04
2117 // 8 | 0.12
2118 // 9 | 0.40
2119 // 10 | 1.54
2120 // 11 | 6.78
2121 // 12 | 30.38
2122 //
2123 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
2124 unsigned InvolvedParams = 0;
2125 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
2126 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
2127 InvolvedParams++;
2128
2129 if (InvolvedParams > RunTimeChecksMaxParameters) {
2130 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002131 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002132 }
2133 }
2134
Johannes Doerfertb164c792014-09-18 11:17:17 +00002135 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2136 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2137
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002138 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2139 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2140
Johannes Doerfertb164c792014-09-18 11:17:17 +00002141 // Adjust the last dimension of the maximal access by one as we want to
2142 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2143 // we test during code generation might now point after the end of the
2144 // allocated array but we will never dereference it anyway.
2145 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2146 "Assumed at least one output dimension");
2147 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2148 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2149 OneAff = isl_aff_zero_on_domain(
2150 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2151 OneAff = isl_aff_add_constant_si(OneAff, 1);
2152 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2153 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2154
2155 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2156
2157 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002158 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002159}
2160
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002161static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2162 isl_set *Domain = MA->getStatement()->getDomain();
2163 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2164 return isl_set_reset_tuple_id(Domain);
2165}
2166
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002167/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2168static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002169 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002170 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002171
2172 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2173 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002174 Locations = isl_union_set_coalesce(Locations);
2175 Locations = isl_union_set_detect_equalities(Locations);
2176 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002177 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002178 isl_union_set_free(Locations);
2179 return Valid;
2180}
2181
Johannes Doerfert96425c22015-08-30 21:13:53 +00002182/// @brief Helper to treat non-affine regions and basic blocks the same.
2183///
2184///{
2185
2186/// @brief Return the block that is the representing block for @p RN.
2187static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2188 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2189 : RN->getNodeAs<BasicBlock>();
2190}
2191
2192/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002193static inline BasicBlock *
2194getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002195 if (RN->isSubRegion()) {
2196 assert(idx == 0);
2197 return RN->getNodeAs<Region>()->getExit();
2198 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002199 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002200}
2201
2202/// @brief Return the smallest loop surrounding @p RN.
2203static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2204 if (!RN->isSubRegion())
2205 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2206
2207 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2208 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2209 while (L && NonAffineSubRegion->contains(L))
2210 L = L->getParentLoop();
2211 return L;
2212}
2213
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002214static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2215 if (!RN->isSubRegion())
2216 return 1;
2217
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002218 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002219 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002220}
2221
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002222static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2223 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002224 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002225 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002226 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002227 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002228 return true;
2229 return false;
2230}
2231
Johannes Doerfert96425c22015-08-30 21:13:53 +00002232///}
2233
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002234static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2235 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002236 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002237 isl_id *DimId =
2238 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2239 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2240}
2241
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002242__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002243 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002244}
2245
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002246__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002247 auto DIt = DomainMap.find(BB);
2248 if (DIt != DomainMap.end())
2249 return isl_set_copy(DIt->getSecond());
2250
2251 auto &RI = *R.getRegionInfo();
2252 auto *BBR = RI.getRegionFor(BB);
2253 while (BBR->getEntry() == BB)
2254 BBR = BBR->getParent();
2255 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002256}
2257
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002258bool Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002259 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002260
Johannes Doerfert432658d2016-01-26 11:01:41 +00002261 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002262 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002263 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2264 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002265 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002266
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002267 while (LD-- >= 0) {
2268 S = addDomainDimId(S, LD + 1, L);
2269 L = L->getParentLoop();
2270 }
2271
Johannes Doerferta3519512016-04-23 13:02:23 +00002272 // Initialize the invalid domain.
2273 auto *EntryStmt = getStmtFor(EntryBB);
2274 EntryStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(S)));
2275
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002276 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002277
Johannes Doerfert432658d2016-01-26 11:01:41 +00002278 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002279 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002280
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002281 if (!buildDomainsWithBranchConstraints(R, SD, DT, LI))
2282 return false;
2283
Johannes Doerfert297c7202016-05-10 13:06:42 +00002284 if (!propagateDomainConstraints(R, SD, DT, LI))
2285 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002286
2287 // Error blocks and blocks dominated by them have been assumed to never be
2288 // executed. Representing them in the Scop does not add any value. In fact,
2289 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002290 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002291 // will cause problems when building up a ScopStmt for them.
2292 // Furthermore, basic blocks dominated by error blocks may reference
2293 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002294 // can themselves not be constructed properly. To this end we will replace
2295 // the domains of error blocks and those only reachable via error blocks
2296 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002297 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002298 // InvalidDomain. This information is needed during load hoisting.
Johannes Doerfert297c7202016-05-10 13:06:42 +00002299 if (!propagateInvalidStmtDomains(R, SD, DT, LI))
2300 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002301
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002302 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002303}
2304
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002305static Loop *
2306getFirstNonBoxedLoopFor(BasicBlock *BB, LoopInfo &LI,
2307 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
2308 auto *L = LI.getLoopFor(BB);
2309 while (BoxedLoops.count(L))
2310 L = L->getParentLoop();
2311 return L;
2312}
2313
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002314/// @brief Adjust the dimensions of @p Dom that was constructed for @p OldL
2315/// to be compatible to domains constructed for loop @p NewL.
2316///
2317/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2318/// edge from @p OldL to @p NewL.
2319static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2320 __isl_take isl_set *Dom,
2321 Loop *OldL, Loop *NewL) {
2322
2323 // If the loops are the same there is nothing to do.
2324 if (NewL == OldL)
2325 return Dom;
2326
2327 int OldDepth = S.getRelativeLoopDepth(OldL);
2328 int NewDepth = S.getRelativeLoopDepth(NewL);
2329 // If both loops are non-affine loops there is nothing to do.
2330 if (OldDepth == -1 && NewDepth == -1)
2331 return Dom;
2332
2333 // Distinguish three cases:
2334 // 1) The depth is the same but the loops are not.
2335 // => One loop was left one was entered.
2336 // 2) The depth increased from OldL to NewL.
2337 // => One loop was entered, none was left.
2338 // 3) The depth decreased from OldL to NewL.
2339 // => Loops were left were difference of the depths defines how many.
2340 if (OldDepth == NewDepth) {
2341 assert(OldL->getParentLoop() == NewL->getParentLoop());
2342 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2343 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2344 Dom = addDomainDimId(Dom, NewDepth, NewL);
2345 } else if (OldDepth < NewDepth) {
2346 assert(OldDepth + 1 == NewDepth);
2347 auto &R = S.getRegion();
2348 (void)R;
2349 assert(NewL->getParentLoop() == OldL ||
2350 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2351 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2352 Dom = addDomainDimId(Dom, NewDepth, NewL);
2353 } else {
2354 assert(OldDepth > NewDepth);
2355 int Diff = OldDepth - NewDepth;
2356 int NumDim = isl_set_n_dim(Dom);
2357 assert(NumDim >= Diff);
2358 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2359 }
2360
2361 return Dom;
2362}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002363
Johannes Doerfert297c7202016-05-10 13:06:42 +00002364bool Scop::propagateInvalidStmtDomains(Region *R, ScopDetection &SD,
Johannes Doerferta3519512016-04-23 13:02:23 +00002365 DominatorTree &DT, LoopInfo &LI) {
2366 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002367
2368 ReversePostOrderTraversal<Region *> RTraversal(R);
2369 for (auto *RN : RTraversal) {
2370
2371 // Recurse for affine subregions but go on for basic blocks and non-affine
2372 // subregions.
2373 if (RN->isSubRegion()) {
2374 Region *SubRegion = RN->getNodeAs<Region>();
2375 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerferta3519512016-04-23 13:02:23 +00002376 propagateInvalidStmtDomains(SubRegion, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002377 continue;
2378 }
2379 }
2380
2381 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2382 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002383 ScopStmt *Stmt = getStmtFor(BB);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002384 isl_set *&Domain = DomainMap[BB];
2385 assert(Domain && "Cannot propagate a nullptr");
2386
Johannes Doerferta3519512016-04-23 13:02:23 +00002387 auto *InvalidDomain = Stmt->getInvalidDomain();
Johannes Doerfert7c013572016-04-12 09:57:34 +00002388 bool IsInvalidBlock =
Johannes Doerferta3519512016-04-23 13:02:23 +00002389 ContainsErrorBlock || isl_set_is_subset(Domain, InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002390
Johannes Doerferta3519512016-04-23 13:02:23 +00002391 if (!IsInvalidBlock) {
2392 InvalidDomain = isl_set_intersect(InvalidDomain, isl_set_copy(Domain));
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002393 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002394 isl_set_free(InvalidDomain);
2395 InvalidDomain = Domain;
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002396 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
2397 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2398 AS_RESTRICTION);
2399 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002400 }
2401
Johannes Doerferta3519512016-04-23 13:02:23 +00002402 if (isl_set_is_empty(InvalidDomain)) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00002403 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002404 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002405 }
2406
Johannes Doerferta3519512016-04-23 13:02:23 +00002407 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002408 auto *TI = BB->getTerminator();
2409 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2410 for (unsigned u = 0; u < NumSuccs; u++) {
2411 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002412 auto *SuccStmt = getStmtFor(SuccBB);
2413
2414 // Skip successors outside the SCoP.
2415 if (!SuccStmt)
2416 continue;
2417
Johannes Doerferte4459a22016-04-25 13:34:50 +00002418 // Skip backedges.
2419 if (DT.dominates(SuccBB, BB))
2420 continue;
2421
Johannes Doerferta3519512016-04-23 13:02:23 +00002422 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
2423 auto *AdjustedInvalidDomain = adjustDomainDimensions(
2424 *this, isl_set_copy(InvalidDomain), BBLoop, SuccBBLoop);
2425 auto *SuccInvalidDomain = SuccStmt->getInvalidDomain();
2426 SuccInvalidDomain =
2427 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2428 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2429 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
2430 SuccStmt->setInvalidDomain(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002431
Michael Krusebc150122016-05-02 12:25:18 +00002432 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002433 // In case this happens we will bail.
Michael Krusebc150122016-05-02 12:25:18 +00002434 if (NumConjucts < MaxDisjunctionsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002435 continue;
2436
Johannes Doerferta3519512016-04-23 13:02:23 +00002437 isl_set_free(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002438 invalidate(COMPLEXITY, TI->getDebugLoc());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002439 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002440 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002441
2442 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002443 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002444
2445 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002446}
2447
Johannes Doerfert642594a2016-04-04 07:57:39 +00002448void Scop::propagateDomainConstraintsToRegionExit(
2449 BasicBlock *BB, Loop *BBLoop,
2450 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, ScopDetection &SD,
2451 LoopInfo &LI) {
2452
2453 // Check if the block @p BB is the entry of a region. If so we propagate it's
2454 // domain to the exit block of the region. Otherwise we are done.
2455 auto *RI = R.getRegionInfo();
2456 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2457 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
2458 if (!BBReg || BBReg->getEntry() != BB || !R.contains(ExitBB))
2459 return;
2460
2461 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2462 // Do not propagate the domain if there is a loop backedge inside the region
2463 // that would prevent the exit block from beeing executed.
2464 auto *L = BBLoop;
2465 while (L && R.contains(L)) {
2466 SmallVector<BasicBlock *, 4> LatchBBs;
2467 BBLoop->getLoopLatches(LatchBBs);
2468 for (auto *LatchBB : LatchBBs)
2469 if (BB != LatchBB && BBReg->contains(LatchBB))
2470 return;
2471 L = L->getParentLoop();
2472 }
2473
2474 auto *Domain = DomainMap[BB];
2475 assert(Domain && "Cannot propagate a nullptr");
2476
2477 auto *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, BoxedLoops);
2478
2479 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2480 // adjust the domain before we can propagate it.
2481 auto *AdjustedDomain =
2482 adjustDomainDimensions(*this, isl_set_copy(Domain), BBLoop, ExitBBLoop);
2483 auto *&ExitDomain = DomainMap[ExitBB];
2484
2485 // If the exit domain is not yet created we set it otherwise we "add" the
2486 // current domain.
2487 ExitDomain =
2488 ExitDomain ? isl_set_union(AdjustedDomain, ExitDomain) : AdjustedDomain;
2489
Johannes Doerferta3519512016-04-23 13:02:23 +00002490 // Initialize the invalid domain.
2491 auto *ExitStmt = getStmtFor(ExitBB);
2492 ExitStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(ExitDomain)));
2493
Johannes Doerfert642594a2016-04-04 07:57:39 +00002494 FinishedExitBlocks.insert(ExitBB);
2495}
2496
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002497bool Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002498 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002499 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002500
2501 // To create the domain for each block in R we iterate over all blocks and
2502 // subregions in R and propagate the conditions under which the current region
2503 // element is executed. To this end we iterate in reverse post order over R as
2504 // it ensures that we first visit all predecessors of a region node (either a
2505 // basic block or a subregion) before we visit the region node itself.
2506 // Initially, only the domain for the SCoP region entry block is set and from
2507 // there we propagate the current domain to all successors, however we add the
2508 // condition that the successor is actually executed next.
2509 // As we are only interested in non-loop carried constraints here we can
2510 // simply skip loop back edges.
2511
Johannes Doerfert642594a2016-04-04 07:57:39 +00002512 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002513 ReversePostOrderTraversal<Region *> RTraversal(R);
2514 for (auto *RN : RTraversal) {
2515
2516 // Recurse for affine subregions but go on for basic blocks and non-affine
2517 // subregions.
2518 if (RN->isSubRegion()) {
2519 Region *SubRegion = RN->getNodeAs<Region>();
2520 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002521 if (!buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI))
2522 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002523 continue;
2524 }
2525 }
2526
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002527 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002528 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002529
Johannes Doerfert96425c22015-08-30 21:13:53 +00002530 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002531 TerminatorInst *TI = BB->getTerminator();
2532
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002533 if (isa<UnreachableInst>(TI))
2534 continue;
2535
Johannes Doerfertf5673802015-10-01 23:48:18 +00002536 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002537 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002538 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002539
Johannes Doerfert642594a2016-04-04 07:57:39 +00002540 auto *BBLoop = getRegionNodeLoop(RN, LI);
2541 // Propagate the domain from BB directly to blocks that have a superset
2542 // domain, at the moment only region exit nodes of regions that start in BB.
2543 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, SD,
2544 LI);
2545
2546 // If all successors of BB have been set a domain through the propagation
2547 // above we do not need to build condition sets but can just skip this
2548 // block. However, it is important to note that this is a local property
2549 // with regards to the region @p R. To this end FinishedExitBlocks is a
2550 // local variable.
2551 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2552 return FinishedExitBlocks.count(SuccBB);
2553 };
2554 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2555 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002556
2557 // Build the condition sets for the successor nodes of the current region
2558 // node. If it is a non-affine subregion we will always execute the single
2559 // exit node, hence the single entry node domain is the condition set. For
2560 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002561 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002562 if (RN->isSubRegion())
2563 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00002564 else if (!buildConditionSets(*getStmtFor(BB), TI, BBLoop, Domain,
2565 ConditionSets))
2566 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002567
2568 // Now iterate over the successors and set their initial domain based on
2569 // their condition set. We skip back edges here and have to be careful when
2570 // we leave a loop not to keep constraints over a dimension that doesn't
2571 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002572 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002573 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002574 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002575 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002576
Johannes Doerfert535de032016-04-19 14:49:05 +00002577 auto *SuccStmt = getStmtFor(SuccBB);
2578 // Skip blocks outside the region.
2579 if (!SuccStmt) {
2580 isl_set_free(CondSet);
2581 continue;
2582 }
2583
Johannes Doerfert642594a2016-04-04 07:57:39 +00002584 // If we propagate the domain of some block to "SuccBB" we do not have to
2585 // adjust the domain.
2586 if (FinishedExitBlocks.count(SuccBB)) {
2587 isl_set_free(CondSet);
2588 continue;
2589 }
2590
Johannes Doerfert96425c22015-08-30 21:13:53 +00002591 // Skip back edges.
2592 if (DT.dominates(SuccBB, BB)) {
2593 isl_set_free(CondSet);
2594 continue;
2595 }
2596
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002597 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002598 CondSet = adjustDomainDimensions(*this, CondSet, BBLoop, SuccBBLoop);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002599
2600 // Set the domain for the successor or merge it with an existing domain in
2601 // case there are multiple paths (without loop back edges) to the
2602 // successor block.
2603 isl_set *&SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002604
Johannes Doerferta3519512016-04-23 13:02:23 +00002605 if (SuccDomain) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002606 SuccDomain = isl_set_coalesce(isl_set_union(SuccDomain, CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00002607 } else {
2608 // Initialize the invalid domain.
2609 SuccStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(CondSet)));
2610 SuccDomain = CondSet;
2611 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002612
Michael Krusebc150122016-05-02 12:25:18 +00002613 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002614 // In case this happens we will clean up and bail.
Michael Krusebc150122016-05-02 12:25:18 +00002615 if (isl_set_n_basic_set(SuccDomain) < MaxDisjunctionsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002616 continue;
2617
2618 invalidate(COMPLEXITY, DebugLoc());
2619 while (++u < ConditionSets.size())
2620 isl_set_free(ConditionSets[u]);
2621 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002622 }
2623 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002624
2625 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002626}
2627
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00002628__isl_give isl_set *Scop::getPredecessorDomainConstraints(BasicBlock *BB,
2629 isl_set *Domain,
2630 ScopDetection &SD,
2631 DominatorTree &DT,
2632 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002633 // If @p BB is the ScopEntry we are done
2634 if (R.getEntry() == BB)
2635 return isl_set_universe(isl_set_get_space(Domain));
2636
2637 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2638 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2639
2640 // The region info of this function.
2641 auto &RI = *R.getRegionInfo();
2642
2643 auto *BBLoop = getFirstNonBoxedLoopFor(BB, LI, BoxedLoops);
2644
2645 // A domain to collect all predecessor domains, thus all conditions under
2646 // which the block is executed. To this end we start with the empty domain.
2647 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2648
2649 // Set of regions of which the entry block domain has been propagated to BB.
2650 // all predecessors inside any of the regions can be skipped.
2651 SmallSet<Region *, 8> PropagatedRegions;
2652
2653 for (auto *PredBB : predecessors(BB)) {
2654 // Skip backedges.
2655 if (DT.dominates(BB, PredBB))
2656 continue;
2657
2658 // If the predecessor is in a region we used for propagation we can skip it.
2659 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2660 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2661 PredBBInRegion)) {
2662 continue;
2663 }
2664
2665 // Check if there is a valid region we can use for propagation, thus look
2666 // for a region that contains the predecessor and has @p BB as exit block.
2667 auto *PredR = RI.getRegionFor(PredBB);
2668 while (PredR->getExit() != BB && !PredR->contains(BB))
2669 PredR->getParent();
2670
2671 // If a valid region for propagation was found use the entry of that region
2672 // for propagation, otherwise the PredBB directly.
2673 if (PredR->getExit() == BB) {
2674 PredBB = PredR->getEntry();
2675 PropagatedRegions.insert(PredR);
2676 }
2677
Johannes Doerfert41cda152016-04-08 10:32:26 +00002678 auto *PredBBDom = getDomainConditions(PredBB);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002679 auto *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, BoxedLoops);
2680 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2681
2682 PredDom = isl_set_union(PredDom, PredBBDom);
2683 }
2684
2685 return PredDom;
2686}
2687
Johannes Doerfert297c7202016-05-10 13:06:42 +00002688bool Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002689 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002690 // Iterate over the region R and propagate the domain constrains from the
2691 // predecessors to the current node. In contrast to the
2692 // buildDomainsWithBranchConstraints function, this one will pull the domain
2693 // information from the predecessors instead of pushing it to the successors.
2694 // Additionally, we assume the domains to be already present in the domain
2695 // map here. However, we iterate again in reverse post order so we know all
2696 // predecessors have been visited before a block or non-affine subregion is
2697 // visited.
2698
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002699 ReversePostOrderTraversal<Region *> RTraversal(R);
2700 for (auto *RN : RTraversal) {
2701
2702 // Recurse for affine subregions but go on for basic blocks and non-affine
2703 // subregions.
2704 if (RN->isSubRegion()) {
2705 Region *SubRegion = RN->getNodeAs<Region>();
2706 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert297c7202016-05-10 13:06:42 +00002707 if (!propagateDomainConstraints(SubRegion, SD, DT, LI))
2708 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002709 continue;
2710 }
2711 }
2712
2713 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002714 isl_set *&Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002715 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002716
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002717 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002718 auto *PredDom = getPredecessorDomainConstraints(BB, Domain, SD, DT, LI);
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002719 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002720 Domain = isl_set_align_params(Domain, getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002721
Johannes Doerfert642594a2016-04-04 07:57:39 +00002722 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002723 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002724 if (!addLoopBoundsToHeaderDomain(BBLoop, LI))
2725 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002726 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002727
2728 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002729}
2730
2731/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2732/// is incremented by one and all other dimensions are equal, e.g.,
2733/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2734/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2735static __isl_give isl_map *
2736createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2737 auto *MapSpace = isl_space_map_from_set(SetSpace);
2738 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2739 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2740 if (u != Dim)
2741 NextIterationMap =
2742 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2743 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2744 C = isl_constraint_set_constant_si(C, 1);
2745 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2746 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2747 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2748 return NextIterationMap;
2749}
2750
Johannes Doerfert297c7202016-05-10 13:06:42 +00002751bool Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002752 int LoopDepth = getRelativeLoopDepth(L);
2753 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002754
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002755 BasicBlock *HeaderBB = L->getHeader();
2756 assert(DomainMap.count(HeaderBB));
2757 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002758
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002759 isl_map *NextIterationMap =
2760 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002761
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002762 isl_set *UnionBackedgeCondition =
2763 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002764
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002765 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2766 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002767
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002768 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002769
2770 // If the latch is only reachable via error statements we skip it.
2771 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2772 if (!LatchBBDom)
2773 continue;
2774
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002775 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002776
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002777 TerminatorInst *TI = LatchBB->getTerminator();
2778 BranchInst *BI = dyn_cast<BranchInst>(TI);
2779 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002780 BackedgeCondition = isl_set_copy(LatchBBDom);
2781 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002782 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002783 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert297c7202016-05-10 13:06:42 +00002784 if (!buildConditionSets(*getStmtFor(LatchBB), TI, L, LatchBBDom,
2785 ConditionSets))
2786 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002787
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002788 // Free the non back edge condition set as we do not need it.
2789 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002790
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002791 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002792 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002793
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002794 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2795 assert(LatchLoopDepth >= LoopDepth);
2796 BackedgeCondition =
2797 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2798 LatchLoopDepth - LoopDepth);
2799 UnionBackedgeCondition =
2800 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002801 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002802
2803 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2804 for (int i = 0; i < LoopDepth; i++)
2805 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2806
2807 isl_set *UnionBackedgeConditionComplement =
2808 isl_set_complement(UnionBackedgeCondition);
2809 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2810 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2811 UnionBackedgeConditionComplement =
2812 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2813 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2814 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2815
2816 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2817 HeaderBBDom = Parts.second;
2818
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002819 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2820 // the bounded assumptions to the context as they are already implied by the
2821 // <nsw> tag.
2822 if (Affinator.hasNSWAddRecForLoop(L)) {
2823 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00002824 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002825 }
2826
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002827 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002828 recordAssumption(INFINITELOOP, UnboundedCtx,
2829 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00002830 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002831}
2832
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002833void Scop::buildAliasChecks(AliasAnalysis &AA) {
2834 if (!PollyUseRuntimeAliasChecks)
2835 return;
2836
2837 if (buildAliasGroups(AA))
2838 return;
2839
2840 // If a problem occurs while building the alias groups we need to delete
2841 // this SCoP and pretend it wasn't valid in the first place. To this end
2842 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002843 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002844
2845 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2846 << " could not be created as the number of parameters involved "
2847 "is too high. The SCoP will be "
2848 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2849 "the maximal number of parameters but be advised that the "
2850 "compile time might increase exponentially.\n\n");
2851}
2852
Johannes Doerfert9143d672014-09-27 11:02:39 +00002853bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002854 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002855 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002856 // for all memory accesses inside the SCoP.
2857 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002858 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002859 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002860 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002861 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002862 // if their access domains intersect, otherwise they are in different
2863 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002864 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002865 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002866 // and maximal accesses to each array of a group in read only and non
2867 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002868 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2869
2870 AliasSetTracker AST(AA);
2871
2872 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002873 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002874 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002875
2876 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002877 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002878 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2879 isl_set_free(StmtDomain);
2880 if (StmtDomainEmpty)
2881 continue;
2882
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002883 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002884 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002885 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002886 if (!MA->isRead())
2887 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002888 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00002889 if (MA->isRead() && isa<MemTransferInst>(Acc))
2890 PtrToAcc[cast<MemTransferInst>(Acc)->getSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00002891 else
2892 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002893 AST.add(Acc);
2894 }
2895 }
2896
2897 SmallVector<AliasGroupTy, 4> AliasGroups;
2898 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002899 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002900 continue;
2901 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002902 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002903 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002904 if (AG.size() < 2)
2905 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002906 AliasGroups.push_back(std::move(AG));
2907 }
2908
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002909 // Split the alias groups based on their domain.
2910 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2911 AliasGroupTy NewAG;
2912 AliasGroupTy &AG = AliasGroups[u];
2913 AliasGroupTy::iterator AGI = AG.begin();
2914 isl_set *AGDomain = getAccessDomain(*AGI);
2915 while (AGI != AG.end()) {
2916 MemoryAccess *MA = *AGI;
2917 isl_set *MADomain = getAccessDomain(MA);
2918 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2919 NewAG.push_back(MA);
2920 AGI = AG.erase(AGI);
2921 isl_set_free(MADomain);
2922 } else {
2923 AGDomain = isl_set_union(AGDomain, MADomain);
2924 AGI++;
2925 }
2926 }
2927 if (NewAG.size() > 1)
2928 AliasGroups.push_back(std::move(NewAG));
2929 isl_set_free(AGDomain);
2930 }
2931
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002932 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002933 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002934 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2935 for (AliasGroupTy &AG : AliasGroups) {
2936 NonReadOnlyBaseValues.clear();
2937 ReadOnlyPairs.clear();
2938
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002939 if (AG.size() < 2) {
2940 AG.clear();
2941 continue;
2942 }
2943
Johannes Doerfert13771732014-10-01 12:40:46 +00002944 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002945 emitOptimizationRemarkAnalysis(
2946 F.getContext(), DEBUG_TYPE, F,
2947 (*II)->getAccessInstruction()->getDebugLoc(),
2948 "Possibly aliasing pointer, use restrict keyword.");
2949
Johannes Doerfert13771732014-10-01 12:40:46 +00002950 Value *BaseAddr = (*II)->getBaseAddr();
2951 if (HasWriteAccess.count(BaseAddr)) {
2952 NonReadOnlyBaseValues.insert(BaseAddr);
2953 II++;
2954 } else {
2955 ReadOnlyPairs[BaseAddr].insert(*II);
2956 II = AG.erase(II);
2957 }
2958 }
2959
2960 // If we don't have read only pointers check if there are at least two
2961 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002962 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002963 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002964 continue;
2965 }
2966
2967 // If we don't have non read only pointers clear the alias group.
2968 if (NonReadOnlyBaseValues.empty()) {
2969 AG.clear();
2970 continue;
2971 }
2972
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002973 // Check if we have non-affine accesses left, if so bail out as we cannot
2974 // generate a good access range yet.
2975 for (auto *MA : AG)
2976 if (!MA->isAffine()) {
2977 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2978 return false;
2979 }
2980 for (auto &ReadOnlyPair : ReadOnlyPairs)
2981 for (auto *MA : ReadOnlyPair.second)
2982 if (!MA->isAffine()) {
2983 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2984 return false;
2985 }
2986
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002987 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002988 MinMaxAliasGroups.emplace_back();
2989 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2990 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2991 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2992 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002993
2994 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002995
2996 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002997 for (MemoryAccess *MA : AG)
2998 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002999
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00003000 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
3001 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003002
3003 // Bail out if the number of values we need to compare is too large.
3004 // This is important as the number of comparisions grows quadratically with
3005 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003006 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
3007 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003008 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003009
3010 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003011 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003012 Accesses = isl_union_map_empty(getParamSpace());
3013
3014 for (const auto &ReadOnlyPair : ReadOnlyPairs)
3015 for (MemoryAccess *MA : ReadOnlyPair.second)
3016 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
3017
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00003018 Valid =
3019 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00003020
3021 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003022 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003023 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003024
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003025 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003026}
3027
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003028/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003029static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003030 // Start with the smallest loop containing the entry and expand that
3031 // loop until it contains all blocks in the region. If there is a loop
3032 // containing all blocks in the region check if it is itself contained
3033 // and if so take the parent loop as it will be the smallest containing
3034 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003035 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003036 while (L) {
3037 bool AllContained = true;
3038 for (auto *BB : R.blocks())
3039 AllContained &= L->contains(BB);
3040 if (AllContained)
3041 break;
3042 L = L->getParentLoop();
3043 }
3044
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003045 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
3046}
3047
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003048static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
3049 ScopDetection &SD) {
3050
3051 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
3052
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003053 unsigned MinLD = INT_MAX, MaxLD = 0;
3054 for (BasicBlock *BB : R.blocks()) {
3055 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00003056 if (!R.contains(L))
3057 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003058 if (BoxedLoops && BoxedLoops->count(L))
3059 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003060 unsigned LD = L->getLoopDepth();
3061 MinLD = std::min(MinLD, LD);
3062 MaxLD = std::max(MaxLD, LD);
3063 }
3064 }
3065
3066 // Handle the case that there is no loop in the SCoP first.
3067 if (MaxLD == 0)
3068 return 1;
3069
3070 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
3071 assert(MaxLD >= MinLD &&
3072 "Maximal loop depth was smaller than mininaml loop depth?");
3073 return MaxLD - MinLD + 1;
3074}
3075
Michael Kruse09eb4452016-03-03 22:10:47 +00003076Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
3077 unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00003078 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003079 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003080 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
3081 Context(nullptr), Affinator(this, LI), AssumedContext(nullptr),
3082 InvalidContext(nullptr), Schedule(nullptr) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003083 if (IslOnErrorAbort)
3084 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003085 buildContext();
3086}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003087
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00003088void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003089 DominatorTree &DT, LoopInfo &LI) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003090 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003091
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003092 if (!buildDomains(&R, SD, DT, LI))
3093 return;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003094
Johannes Doerfertff68f462016-04-19 14:49:42 +00003095 addUserAssumptions(AC, DT, LI);
3096
Johannes Doerfert26404542016-05-10 12:19:47 +00003097 // Remove empty statements.
Michael Kruseafe06702015-10-02 16:33:27 +00003098 // Exit early in case there are no executable statements left in this scop.
Johannes Doerfert26404542016-05-10 12:19:47 +00003099 simplifySCoP(false, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00003100 if (Stmts.empty())
3101 return;
Tobias Grosser75805372011-04-29 06:27:02 +00003102
Michael Krusecac948e2015-10-02 13:53:07 +00003103 // The ScopStmts now have enough information to initialize themselves.
3104 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003105 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00003106
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003107 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003108
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003109 if (!hasFeasibleRuntimeContext())
Tobias Grosser8286b832015-11-02 11:29:32 +00003110 return;
3111
3112 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00003113 realignParams();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00003114 addUserContext();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003115
3116 // After the context was fully constructed, thus all our knowledge about
3117 // the parameters is in there, we add all recorded assumptions to the
3118 // assumed/invalid context.
3119 addRecordedAssumptions();
3120
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003121 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003122 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003123
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003124 hoistInvariantLoads(SD);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003125 verifyInvariantLoads(SD);
Johannes Doerfert26404542016-05-10 12:19:47 +00003126 simplifySCoP(true, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003127}
3128
3129Scop::~Scop() {
3130 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003131 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003132 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003133 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003134
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003135 for (auto &It : ParameterIds)
3136 isl_id_free(It.second);
3137
Johannes Doerfert96425c22015-08-30 21:13:53 +00003138 for (auto It : DomainMap)
3139 isl_set_free(It.second);
3140
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003141 for (auto &AS : RecordedAssumptions)
3142 isl_set_free(AS.Set);
3143
Johannes Doerfertb164c792014-09-18 11:17:17 +00003144 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003145 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003146 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003147 isl_pw_multi_aff_free(MMA.first);
3148 isl_pw_multi_aff_free(MMA.second);
3149 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003150 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003151 isl_pw_multi_aff_free(MMA.first);
3152 isl_pw_multi_aff_free(MMA.second);
3153 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003154 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003155
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003156 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003157 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003158
3159 // Explicitly release all Scop objects and the underlying isl objects before
3160 // we relase the isl context.
3161 Stmts.clear();
3162 ScopArrayInfoMap.clear();
3163 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003164}
3165
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003166void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003167 // Check all array accesses for each base pointer and find a (virtual) element
3168 // size for the base pointer that divides all access functions.
3169 for (auto &Stmt : *this)
3170 for (auto *Access : Stmt) {
3171 if (!Access->isArrayKind())
3172 continue;
3173 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
3174 ScopArrayInfo::MK_Array)];
3175 if (SAI->getNumberOfDimensions() != 1)
3176 continue;
3177 unsigned DivisibleSize = SAI->getElemSizeInBytes();
3178 auto *Subscript = Access->getSubscript(0);
3179 while (!isDivisible(Subscript, DivisibleSize, *SE))
3180 DivisibleSize /= 2;
3181 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
3182 SAI->updateElementType(Ty);
3183 }
3184
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003185 for (auto &Stmt : *this)
3186 for (auto &Access : Stmt)
3187 Access->updateDimensionality();
3188}
3189
Johannes Doerfert26404542016-05-10 12:19:47 +00003190void Scop::simplifySCoP(bool AfterHoisting, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003191 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3192 ScopStmt &Stmt = *StmtIt;
3193
Johannes Doerfert26404542016-05-10 12:19:47 +00003194 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerferteca9e892015-11-03 16:54:49 +00003195 if (!RemoveStmt)
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00003196 RemoveStmt = !DomainMap[Stmt.getEntryBlock()];
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003197
Johannes Doerferteca9e892015-11-03 16:54:49 +00003198 // Remove read only statements only after invariant loop hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003199 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003200 bool OnlyRead = true;
3201 for (MemoryAccess *MA : Stmt) {
3202 if (MA->isRead())
3203 continue;
3204
3205 OnlyRead = false;
3206 break;
3207 }
3208
3209 RemoveStmt = OnlyRead;
3210 }
3211
Johannes Doerfert26404542016-05-10 12:19:47 +00003212 if (!RemoveStmt) {
3213 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003214 continue;
3215 }
3216
Johannes Doerfert26404542016-05-10 12:19:47 +00003217 // Remove the statement because it is unnecessary.
3218 if (Stmt.isRegionStmt())
3219 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3220 StmtMap.erase(BB);
3221 else
3222 StmtMap.erase(Stmt.getBasicBlock());
3223
3224 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003225 }
3226}
3227
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003228InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003229 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3230 if (!LInst)
3231 return nullptr;
3232
3233 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3234 LInst = cast<LoadInst>(Rep);
3235
Johannes Doerfert96e54712016-02-07 17:30:13 +00003236 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003237 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003238 for (auto &IAClass : InvariantEquivClasses) {
3239 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
3240 continue;
3241
3242 auto &MAs = std::get<1>(IAClass);
3243 for (auto *MA : MAs)
3244 if (MA->getAccessInstruction() == Val)
3245 return &IAClass;
3246 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003247
3248 return nullptr;
3249}
3250
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003251/// @brief Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003252static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3253 bool MAInvalidCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003254 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3255 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3256 // TODO: We can provide more information for better but more expensive
3257 // results.
3258 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3259 LInst->getAlignment(), DL))
3260 return false;
3261
3262 // If a dereferencable load is in a statement that is modeled precisely we can
3263 // hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003264 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003265 return true;
3266
3267 // Even if the statement is not modeled precisely we can hoist the load if it
3268 // does not involve any parameters that might have been specilized by the
3269 // statement domain.
3270 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3271 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3272 return false;
3273 return true;
3274}
3275
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003276void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
3277
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003278 if (InvMAs.empty())
3279 return;
3280
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003281 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003282 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003283
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003284 // Get the context under which the statement is executed but remove the error
3285 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003286 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003287 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003288
Michael Krusebc150122016-05-02 12:25:18 +00003289 if (isl_set_n_basic_set(DomainCtx) >= MaxDisjunctionsInDomain) {
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003290 auto *AccInst = InvMAs.front()->getAccessInstruction();
3291 invalidate(COMPLEXITY, AccInst->getDebugLoc());
3292 isl_set_free(DomainCtx);
3293 return;
3294 }
3295
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003296 // Project out all parameters that relate to loads in the statement. Otherwise
3297 // we could have cyclic dependences on the constraints under which the
3298 // hoisted loads are executed and we could not determine an order in which to
3299 // pre-load them. This happens because not only lower bounds are part of the
3300 // domain but also upper bounds.
3301 for (MemoryAccess *MA : InvMAs) {
3302 Instruction *AccInst = MA->getAccessInstruction();
3303 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003304 SetVector<Value *> Values;
3305 for (const SCEV *Parameter : Parameters) {
3306 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003307 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003308 if (!Values.count(AccInst))
3309 continue;
3310
3311 if (isl_id *ParamId = getIdForParam(Parameter)) {
3312 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
3313 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
3314 isl_id_free(ParamId);
3315 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003316 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003317 }
3318 }
3319
3320 for (MemoryAccess *MA : InvMAs) {
3321 // Check for another invariant access that accesses the same location as
3322 // MA and if found consolidate them. Otherwise create a new equivalence
3323 // class at the end of InvariantEquivClasses.
3324 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003325 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003326 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3327
Johannes Doerfert85676e32016-04-23 14:32:34 +00003328 auto *MAInvalidCtx = MA->getInvalidContext();
3329 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3330
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003331 isl_set *MACtx;
3332 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003333 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003334 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003335 isl_set_free(MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003336 } else {
3337 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003338 MACtx = isl_set_subtract(MACtx, MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003339 MACtx = isl_set_gist_params(MACtx, getContext());
3340 }
3341
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003342 bool Consolidated = false;
3343 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00003344 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003345 continue;
3346
Johannes Doerfertdf880232016-03-03 12:26:58 +00003347 // If the pointer and the type is equal check if the access function wrt.
3348 // to the domain is equal too. It can happen that the domain fixes
3349 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003350 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003351 // create a new invariant load equivalence class.
3352 auto &MAs = std::get<1>(IAClass);
3353 if (!MAs.empty()) {
3354 auto *LastMA = MAs.front();
3355
3356 auto *AR = isl_map_range(MA->getAccessRelation());
3357 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3358 bool SameAR = isl_set_is_equal(AR, LastAR);
3359 isl_set_free(AR);
3360 isl_set_free(LastAR);
3361
3362 if (!SameAR)
3363 continue;
3364 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003365
3366 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003367 MAs.push_front(MA);
3368
Johannes Doerfertdf880232016-03-03 12:26:58 +00003369 Consolidated = true;
3370
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003371 // Unify the execution context of the class and this statement.
3372 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003373 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003374 IAClassDomainCtx =
3375 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003376 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003377 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003378 break;
3379 }
3380
3381 if (Consolidated)
3382 continue;
3383
3384 // If we did not consolidate MA, thus did not find an equivalence class
3385 // for it, we create a new one.
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003386 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA}, MACtx,
3387 Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003388 }
3389
3390 isl_set_free(DomainCtx);
3391}
3392
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003393bool Scop::isHoistableAccess(MemoryAccess *Access,
3394 __isl_keep isl_union_map *Writes) {
3395 // TODO: Loads that are not loop carried, hence are in a statement with
3396 // zero iterators, are by construction invariant, though we
3397 // currently "hoist" them anyway. This is necessary because we allow
3398 // them to be treated as parameters (e.g., in conditions) and our code
3399 // generation would otherwise use the old value.
3400
3401 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003402 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003403
3404 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3405 return false;
3406
3407 // Skip accesses that have an invariant base pointer which is defined but
3408 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3409 // returns a pointer that is used as a base address. However, as we want
3410 // to hoist indirect pointers, we allow the base pointer to be defined in
3411 // the region if it is also a memory access. Each ScopArrayInfo object
3412 // that has a base pointer origin has a base pointer that is loaded and
3413 // that it is invariant, thus it will be hoisted too. However, if there is
3414 // no base pointer origin we check that the base pointer is defined
3415 // outside the region.
3416 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003417 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3418 if (SAI->getBasePtrOriginSAI()) {
3419 assert(BasePtrInst && R.contains(BasePtrInst));
3420 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003421 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003422 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003423 assert(BasePtrStmt);
3424 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3425 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3426 return false;
3427 } else if (BasePtrInst && R.contains(BasePtrInst))
3428 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003429
3430 // Skip accesses in non-affine subregions as they might not be executed
3431 // under the same condition as the entry of the non-affine subregion.
3432 if (BB != Access->getAccessInstruction()->getParent())
3433 return false;
3434
3435 isl_map *AccessRelation = Access->getAccessRelation();
Johannes Doerfert2b470e82016-03-24 13:19:16 +00003436 assert(!isl_map_is_empty(AccessRelation));
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003437
3438 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3439 Stmt.getNumIterators())) {
3440 isl_map_free(AccessRelation);
3441 return false;
3442 }
3443
3444 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3445 isl_set *AccessRange = isl_map_range(AccessRelation);
3446
3447 isl_union_map *Written = isl_union_map_intersect_range(
3448 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3449 bool IsWritten = !isl_union_map_is_empty(Written);
3450 isl_union_map_free(Written);
3451
3452 if (IsWritten)
3453 return false;
3454
3455 return true;
3456}
3457
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003458void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003459 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3460 for (LoadInst *LI : RIL) {
3461 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003462 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003463 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003464 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3465 return;
3466 }
3467 }
3468}
3469
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003470void Scop::hoistInvariantLoads(ScopDetection &SD) {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003471 if (!PollyInvariantLoadHoisting)
3472 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003473
Tobias Grosser0865e7752016-02-29 07:29:42 +00003474 isl_union_map *Writes = getWrites();
3475 for (ScopStmt &Stmt : *this) {
3476 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003477
Tobias Grosser0865e7752016-02-29 07:29:42 +00003478 for (MemoryAccess *Access : Stmt)
3479 if (isHoistableAccess(Access, Writes))
3480 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003481
Tobias Grosser0865e7752016-02-29 07:29:42 +00003482 // We inserted invariant accesses always in the front but need them to be
3483 // sorted in a "natural order". The statements are already sorted in
3484 // reverse post order and that suffices for the accesses too. The reason
3485 // we require an order in the first place is the dependences between
3486 // invariant loads that can be caused by indirect loads.
3487 InvariantAccesses.reverse();
3488
3489 // Transfer the memory access from the statement to the SCoP.
3490 Stmt.removeMemoryAccesses(InvariantAccesses);
3491 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003492 }
Tobias Grosser0865e7752016-02-29 07:29:42 +00003493 isl_union_map_free(Writes);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003494}
3495
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003496const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003497Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003498 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003499 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003500 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003501 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003502 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003503 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003504 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003505 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003506 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003507 // In case of mismatching array sizes, we bail out by setting the run-time
3508 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003509 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003510 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003511 }
Tobias Grosserab671442015-05-23 05:58:27 +00003512 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003513}
3514
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003515const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003516 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003517 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003518 assert(SAI && "No ScopArrayInfo available for this base pointer");
3519 return SAI;
3520}
3521
Tobias Grosser74394f02013-01-14 22:40:23 +00003522std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003523
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003524std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003525 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003526 return stringFromIslObj(AssumedContext);
3527}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003528
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003529std::string Scop::getInvalidContextStr() const {
3530 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003531}
Tobias Grosser75805372011-04-29 06:27:02 +00003532
3533std::string Scop::getNameStr() const {
3534 std::string ExitName, EntryName;
3535 raw_string_ostream ExitStr(ExitName);
3536 raw_string_ostream EntryStr(EntryName);
3537
Tobias Grosserf240b482014-01-09 10:42:15 +00003538 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003539 EntryStr.str();
3540
3541 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003542 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003543 ExitStr.str();
3544 } else
3545 ExitName = "FunctionExit";
3546
3547 return EntryName + "---" + ExitName;
3548}
3549
Tobias Grosser74394f02013-01-14 22:40:23 +00003550__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003551__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003552 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003553}
3554
Tobias Grossere86109f2013-10-29 21:05:49 +00003555__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003556 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00003557 return isl_set_copy(AssumedContext);
3558}
3559
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003560bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003561 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003562 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00003563 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
3564 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
3565 isl_set_is_subset(PositiveContext, NegativeContext));
3566 isl_set_free(PositiveContext);
3567 if (!IsFeasible) {
3568 isl_set_free(NegativeContext);
3569 return false;
3570 }
3571
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003572 auto *DomainContext = isl_union_set_params(getDomains());
3573 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00003574 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003575 isl_set_free(NegativeContext);
3576 isl_set_free(DomainContext);
3577
Johannes Doerfert43788c52015-08-20 05:58:56 +00003578 return IsFeasible;
3579}
3580
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003581static std::string toString(AssumptionKind Kind) {
3582 switch (Kind) {
3583 case ALIASING:
3584 return "No-aliasing";
3585 case INBOUNDS:
3586 return "Inbounds";
3587 case WRAPPING:
3588 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00003589 case UNSIGNED:
3590 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003591 case COMPLEXITY:
3592 return "Low complexity";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003593 case ERRORBLOCK:
3594 return "No-error";
3595 case INFINITELOOP:
3596 return "Finite loop";
3597 case INVARIANTLOAD:
3598 return "Invariant load";
3599 case DELINEARIZATION:
3600 return "Delinearization";
3601 }
3602 llvm_unreachable("Unknown AssumptionKind!");
3603}
3604
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003605bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3606 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert2f705842016-04-12 16:09:44 +00003607 if (PollyRemarksMinimal) {
3608 if (Sign == AS_ASSUMPTION) {
3609 if (isl_set_is_subset(Context, Set))
3610 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003611
Johannes Doerfert2f705842016-04-12 16:09:44 +00003612 if (isl_set_is_subset(AssumedContext, Set))
3613 return false;
3614 } else {
3615 if (isl_set_is_disjoint(Set, Context))
3616 return false;
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003617
Johannes Doerfert2f705842016-04-12 16:09:44 +00003618 if (isl_set_is_subset(Set, InvalidContext))
3619 return false;
3620 }
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003621 }
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003622
3623 auto &F = *getRegion().getEntry()->getParent();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003624 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
3625 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003626 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003627 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003628}
3629
3630void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003631 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003632 // Simplify the assumptions/restrictions first.
3633 Set = isl_set_gist_params(Set, getContext());
3634
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003635 if (!trackAssumption(Kind, Set, Loc, Sign)) {
3636 isl_set_free(Set);
3637 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003638 }
3639
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003640 if (Sign == AS_ASSUMPTION) {
3641 AssumedContext = isl_set_intersect(AssumedContext, Set);
3642 AssumedContext = isl_set_coalesce(AssumedContext);
3643 } else {
3644 InvalidContext = isl_set_union(InvalidContext, Set);
3645 InvalidContext = isl_set_coalesce(InvalidContext);
3646 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003647}
3648
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003649void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003650 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
3651 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003652}
3653
3654void Scop::addRecordedAssumptions() {
3655 while (!RecordedAssumptions.empty()) {
3656 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003657
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003658 if (!AS.BB) {
3659 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign);
3660 continue;
3661 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003662
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00003663 // If the domain was deleted the assumptions are void.
3664 isl_set *Dom = getDomainConditions(AS.BB);
3665 if (!Dom) {
3666 isl_set_free(AS.Set);
3667 continue;
3668 }
3669
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003670 // If a basic block was given use its domain to simplify the assumption.
3671 // In case of restrictions we know they only have to hold on the domain,
3672 // thus we can intersect them with the domain of the block. However, for
3673 // assumptions the domain has to imply them, thus:
3674 // _ _____
3675 // Dom => S <==> A v B <==> A - B
3676 //
3677 // To avoid the complement we will register A - B as a restricton not an
3678 // assumption.
3679 isl_set *S = AS.Set;
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003680 if (AS.Sign == AS_RESTRICTION)
3681 S = isl_set_params(isl_set_intersect(S, Dom));
3682 else /* (AS.Sign == AS_ASSUMPTION) */
3683 S = isl_set_params(isl_set_subtract(Dom, S));
3684
3685 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003686 }
3687}
3688
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003689void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003690 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003691}
3692
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003693__isl_give isl_set *Scop::getInvalidContext() const {
3694 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003695}
3696
Tobias Grosser75805372011-04-29 06:27:02 +00003697void Scop::printContext(raw_ostream &OS) const {
3698 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003699 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003700
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003701 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003702 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003703
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003704 OS.indent(4) << "Invalid Context:\n";
3705 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003706
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003707 unsigned Dim = 0;
3708 for (const SCEV *Parameter : Parameters)
3709 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003710}
3711
Johannes Doerfertb164c792014-09-18 11:17:17 +00003712void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003713 int noOfGroups = 0;
3714 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003715 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003716 noOfGroups += 1;
3717 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003718 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003719 }
3720
Tobias Grosserbb853c22015-07-25 12:31:03 +00003721 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003722 if (MinMaxAliasGroups.empty()) {
3723 OS.indent(8) << "n/a\n";
3724 return;
3725 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003726
Tobias Grosserbb853c22015-07-25 12:31:03 +00003727 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003728
3729 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003730 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003731 OS.indent(8) << "[[";
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 }
3738
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003739 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003740 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003741 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003742 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003743 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3744 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003745 }
3746 OS << " ]]\n";
3747 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003748 }
3749}
3750
Tobias Grosser75805372011-04-29 06:27:02 +00003751void Scop::printStatements(raw_ostream &OS) const {
3752 OS << "Statements {\n";
3753
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003754 for (const ScopStmt &Stmt : *this)
3755 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003756
3757 OS.indent(4) << "}\n";
3758}
3759
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003760void Scop::printArrayInfo(raw_ostream &OS) const {
3761 OS << "Arrays {\n";
3762
Tobias Grosserab671442015-05-23 05:58:27 +00003763 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003764 Array.second->print(OS);
3765
3766 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003767
3768 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3769
3770 for (auto &Array : arrays())
3771 Array.second->print(OS, /* SizeAsPwAff */ true);
3772
3773 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003774}
3775
Tobias Grosser75805372011-04-29 06:27:02 +00003776void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003777 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3778 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003779 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003780 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003781 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003782 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003783 const auto &MAs = std::get<1>(IAClass);
3784 if (MAs.empty()) {
3785 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003786 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003787 MAs.front()->print(OS);
3788 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003789 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003790 }
3791 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003792 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003793 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003794 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003795 printStatements(OS.indent(4));
3796}
3797
3798void Scop::dump() const { print(dbgs()); }
3799
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003800isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003801
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003802__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
3803 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003804 // First try to use the SCEVAffinator to generate a piecewise defined
3805 // affine function from @p E in the context of @p BB. If that tasks becomes to
3806 // complex the affinator might return a nullptr. In such a case we invalidate
3807 // the SCoP and return a dummy value. This way we do not need to add error
3808 // handling cdoe to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003809 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003810 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00003811 // TODO: We could use a heuristic and either use:
3812 // SCEVAffinator::takeNonNegativeAssumption
3813 // or
3814 // SCEVAffinator::interpretAsUnsigned
3815 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003816 if (NonNegative)
3817 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003818 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003819 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003820
3821 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
3822 invalidate(COMPLEXITY, DL);
3823 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003824}
3825
Tobias Grosser808cd692015-07-14 09:33:13 +00003826__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003827 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003828
Tobias Grosser808cd692015-07-14 09:33:13 +00003829 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003830 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003831
3832 return Domain;
3833}
3834
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003835__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
3836 PWACtx PWAC = getPwAff(E, BB);
3837 isl_set_free(PWAC.second);
3838 return PWAC.first;
3839}
3840
Tobias Grossere5a35142015-11-12 14:07:09 +00003841__isl_give isl_union_map *
3842Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3843 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003844
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003845 for (ScopStmt &Stmt : *this) {
3846 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003847 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003848 continue;
3849
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003850 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003851 isl_map *AccessDomain = MA->getAccessRelation();
3852 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003853 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003854 }
3855 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003856 return isl_union_map_coalesce(Accesses);
3857}
3858
3859__isl_give isl_union_map *Scop::getMustWrites() {
3860 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003861}
3862
3863__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003864 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003865}
3866
Tobias Grosser37eb4222014-02-20 21:43:54 +00003867__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003868 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003869}
3870
3871__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003872 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003873}
3874
Tobias Grosser2ac23382015-11-12 14:07:13 +00003875__isl_give isl_union_map *Scop::getAccesses() {
3876 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3877}
3878
Tobias Grosser808cd692015-07-14 09:33:13 +00003879__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003880 auto *Tree = getScheduleTree();
3881 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003882 isl_schedule_free(Tree);
3883 return S;
3884}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003885
Tobias Grosser808cd692015-07-14 09:33:13 +00003886__isl_give isl_schedule *Scop::getScheduleTree() const {
3887 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3888 getDomains());
3889}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003890
Tobias Grosser808cd692015-07-14 09:33:13 +00003891void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3892 auto *S = isl_schedule_from_domain(getDomains());
3893 S = isl_schedule_insert_partial_schedule(
3894 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3895 isl_schedule_free(Schedule);
3896 Schedule = S;
3897}
3898
3899void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3900 isl_schedule_free(Schedule);
3901 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003902}
3903
3904bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3905 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003906 for (ScopStmt &Stmt : *this) {
3907 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003908 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3909 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3910
3911 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3912 isl_union_set_free(StmtDomain);
3913 isl_union_set_free(NewStmtDomain);
3914 continue;
3915 }
3916
3917 Changed = true;
3918
3919 isl_union_set_free(StmtDomain);
3920 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3921
3922 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003923 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003924 isl_union_set_free(NewStmtDomain);
3925 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003926 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003927 }
3928 isl_union_set_free(Domain);
3929 return Changed;
3930}
3931
Tobias Grosser75805372011-04-29 06:27:02 +00003932ScalarEvolution *Scop::getSE() const { return SE; }
3933
Tobias Grosser808cd692015-07-14 09:33:13 +00003934struct MapToDimensionDataTy {
3935 int N;
3936 isl_union_pw_multi_aff *Res;
3937};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003938
Tobias Grosser808cd692015-07-14 09:33:13 +00003939// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003940// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003941//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003942// @param Set The input set.
3943// @param User->N The dimension to map to.
3944// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003945//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003946// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003947static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3948 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3949 int Dim;
3950 isl_space *Space;
3951 isl_pw_multi_aff *PMA;
3952
3953 Dim = isl_set_dim(Set, isl_dim_set);
3954 Space = isl_set_get_space(Set);
3955 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3956 Dim - Data->N);
3957 if (Data->N > 1)
3958 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3959 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3960
3961 isl_set_free(Set);
3962
3963 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003964}
3965
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003966// @brief Create an isl_multi_union_aff that defines an identity mapping
3967// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003968//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003969// # Example:
3970//
3971// Domain: { A[i,j]; B[i,j,k] }
3972// N: 1
3973//
3974// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3975//
3976// @param USet A union set describing the elements for which to generate a
3977// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003978// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003979// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003980static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003981mapToDimension(__isl_take isl_union_set *USet, int N) {
3982 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003983 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003984 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003985
Tobias Grosser808cd692015-07-14 09:33:13 +00003986 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003987
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003988 auto *Space = isl_union_set_get_space(USet);
3989 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003990
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003991 Data = {N, PwAff};
3992
3993 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003994 (void)Res;
3995
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003996 assert(Res == isl_stat_ok);
3997
3998 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003999 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
4000}
4001
Tobias Grosser316b5b22015-11-11 19:28:14 +00004002void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00004003 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00004004 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004005 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004006 StmtMap[BB] = Stmt;
4007 } else {
4008 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00004009 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004010 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004011 for (BasicBlock *BB : R->blocks())
4012 StmtMap[BB] = Stmt;
4013 }
Tobias Grosser808cd692015-07-14 09:33:13 +00004014}
4015
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004016void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004017 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004018 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004019 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004020 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4021 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004022}
4023
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004024/// To generate a schedule for the elements in a Region we traverse the Region
4025/// in reverse-post-order and add the contained RegionNodes in traversal order
4026/// to the schedule of the loop that is currently at the top of the LoopStack.
4027/// For loop-free codes, this results in a correct sequential ordering.
4028///
4029/// Example:
4030/// bb1(0)
4031/// / \.
4032/// bb2(1) bb3(2)
4033/// \ / \.
4034/// bb4(3) bb5(4)
4035/// \ /
4036/// bb6(5)
4037///
4038/// Including loops requires additional processing. Whenever a loop header is
4039/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4040/// from an empty schedule, we first process all RegionNodes that are within
4041/// this loop and complete the sequential schedule at this loop-level before
4042/// processing about any other nodes. To implement this
4043/// loop-nodes-first-processing, the reverse post-order traversal is
4044/// insufficient. Hence, we additionally check if the traversal yields
4045/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4046/// These region-nodes are then queue and only traverse after the all nodes
4047/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004048void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
4049 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004050 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
4051
4052 ReversePostOrderTraversal<Region *> RTraversal(R);
4053 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4054 std::deque<RegionNode *> DelayList;
4055 bool LastRNWaiting = false;
4056
4057 // Iterate over the region @p R in reverse post-order but queue
4058 // sub-regions/blocks iff they are not part of the last encountered but not
4059 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4060 // that we queued the last sub-region/block from the reverse post-order
4061 // iterator. If it is set we have to explore the next sub-region/block from
4062 // the iterator (if any) to guarantee progress. If it is not set we first try
4063 // the next queued sub-region/blocks.
4064 while (!WorkList.empty() || !DelayList.empty()) {
4065 RegionNode *RN;
4066
4067 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4068 RN = WorkList.front();
4069 WorkList.pop_front();
4070 LastRNWaiting = false;
4071 } else {
4072 RN = DelayList.front();
4073 DelayList.pop_front();
4074 }
4075
4076 Loop *L = getRegionNodeLoop(RN, LI);
4077 if (!getRegion().contains(L))
4078 L = OuterScopLoop;
4079
Tobias Grosser151ae322016-04-03 19:36:52 +00004080 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004081 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004082 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004083 LastRNWaiting = true;
4084 DelayList.push_back(RN);
4085 continue;
4086 }
4087 LoopStack.push_back({L, nullptr, 0});
4088 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004089 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004090 }
4091
4092 return;
4093}
4094
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00004095void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004096 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004097
Tobias Grosser8362c262016-01-06 15:30:06 +00004098 if (RN->isSubRegion()) {
4099 auto *LocalRegion = RN->getNodeAs<Region>();
4100 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004101 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004102 return;
4103 }
4104 }
Michael Kruse046dde42015-08-10 13:01:57 +00004105
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004106 auto &LoopData = LoopStack.back();
4107 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004108
Michael Kruse6f7721f2016-02-24 22:08:19 +00004109 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004110 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4111 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004112 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004113 }
4114
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004115 // Check if we just processed the last node in this loop. If we did, finalize
4116 // the loop by:
4117 //
4118 // - adding new schedule dimensions
4119 // - folding the resulting schedule into the parent loop schedule
4120 // - dropping the loop schedule from the LoopStack.
4121 //
4122 // Then continue to check surrounding loops, which might also have been
4123 // completed by this node.
4124 while (LoopData.L &&
4125 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004126 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004127 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004128
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004129 LoopStack.pop_back();
4130 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004131
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004132 if (Schedule) {
4133 auto *Domain = isl_schedule_get_domain(Schedule);
4134 auto *MUPA = mapToDimension(Domain, LoopStack.size());
4135 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
4136 NextLoopData.Schedule =
4137 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004138 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004139
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004140 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4141 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004142 }
Tobias Grosser75805372011-04-29 06:27:02 +00004143}
4144
Michael Kruse6f7721f2016-02-24 22:08:19 +00004145ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004146 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004147 if (StmtMapIt == StmtMap.end())
4148 return nullptr;
4149 return StmtMapIt->second;
4150}
4151
Michael Kruse6f7721f2016-02-24 22:08:19 +00004152ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4153 if (RN->isSubRegion())
4154 return getStmtFor(RN->getNodeAs<Region>());
4155 return getStmtFor(RN->getNodeAs<BasicBlock>());
4156}
4157
4158ScopStmt *Scop::getStmtFor(Region *R) const {
4159 ScopStmt *Stmt = getStmtFor(R->getEntry());
4160 assert(!Stmt || Stmt->getRegion() == R);
4161 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004162}
4163
Johannes Doerfert96425c22015-08-30 21:13:53 +00004164int Scop::getRelativeLoopDepth(const Loop *L) const {
4165 Loop *OuterLoop =
4166 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
4167 if (!OuterLoop)
4168 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00004169 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4170}
4171
Michael Krused868b5d2015-09-10 15:25:24 +00004172void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00004173 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004174
4175 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
4176 // true, are not modeled as ordinary PHI nodes as they are not part of the
4177 // region. However, we model the operands in the predecessor blocks that are
4178 // part of the region as regular scalar accesses.
4179
4180 // If we can synthesize a PHI we can skip it, however only if it is in
4181 // the region. If it is not it can only be in the exit block of the region.
4182 // In this case we model the operands but not the PHI itself.
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004183 auto *Scope = LI->getLoopFor(PHI->getParent());
4184 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R, Scope))
Michael Kruse7bf39442015-09-10 12:46:52 +00004185 return;
4186
4187 // PHI nodes are modeled as if they had been demoted prior to the SCoP
4188 // detection. Hence, the PHI is a load of a new memory location in which the
4189 // incoming value was written at the end of the incoming basic block.
4190 bool OnlyNonAffineSubRegionOperands = true;
4191 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
4192 Value *Op = PHI->getIncomingValue(u);
4193 BasicBlock *OpBB = PHI->getIncomingBlock(u);
4194
4195 // Do not build scalar dependences inside a non-affine subregion.
4196 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
4197 continue;
4198
4199 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004200 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004201 }
4202
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004203 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
4204 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004205 }
4206}
4207
Michael Kruse2e02d562016-02-06 09:19:40 +00004208void ScopInfo::buildScalarDependences(Instruction *Inst) {
4209 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00004210
Michael Kruse2e02d562016-02-06 09:19:40 +00004211 // Pull-in required operands.
4212 for (Use &Op : Inst->operands())
4213 ensureValueRead(Op.get(), Inst->getParent());
4214}
Michael Kruse7bf39442015-09-10 12:46:52 +00004215
Michael Kruse2e02d562016-02-06 09:19:40 +00004216void ScopInfo::buildEscapingDependences(Instruction *Inst) {
4217 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00004218
Michael Kruse2e02d562016-02-06 09:19:40 +00004219 // Check for uses of this instruction outside the scop. Because we do not
4220 // iterate over such instructions and therefore did not "ensure" the existence
4221 // of a write, we must determine such use here.
4222 for (Use &U : Inst->uses()) {
4223 Instruction *UI = dyn_cast<Instruction>(U.getUser());
4224 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00004225 continue;
4226
Michael Kruse2e02d562016-02-06 09:19:40 +00004227 BasicBlock *UseParent = getUseBlock(U);
4228 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00004229
Michael Kruse2e02d562016-02-06 09:19:40 +00004230 // An escaping value is either used by an instruction not within the scop,
4231 // or (when the scop region's exit needs to be simplified) by a PHI in the
4232 // scop's exit block. This is because region simplification before code
4233 // generation inserts new basic blocks before the PHI such that its incoming
4234 // blocks are not in the scop anymore.
4235 if (!R->contains(UseParent) ||
4236 (isa<PHINode>(UI) && UserParent == R->getExit() &&
4237 R->getExitingBlock())) {
4238 // At least one escaping use found.
4239 ensureValueWrite(Inst);
4240 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00004241 }
4242 }
Michael Kruse7bf39442015-09-10 12:46:52 +00004243}
4244
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004245bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00004246 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00004247 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4248 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00004249 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004250 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004251 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004252 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00004253 const SCEVUnknown *BasePointer =
4254 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004255 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004256 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004257
Michael Kruse37d136e2016-02-26 16:08:24 +00004258 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
4259 auto *Src = BitCast->getOperand(0);
4260 auto *SrcTy = Src->getType();
4261 auto *DstTy = BitCast->getType();
Johannes Doerfert41725a12016-04-08 19:20:03 +00004262 // Do not try to delinearize non-sized (opaque) pointers.
4263 if ((SrcTy->isPointerTy() && !SrcTy->getPointerElementType()->isSized()) ||
4264 (DstTy->isPointerTy() && !DstTy->getPointerElementType()->isSized())) {
4265 return false;
4266 }
Michael Kruse436c9062016-04-08 16:20:08 +00004267 if (SrcTy->isPointerTy() && DstTy->isPointerTy() &&
4268 DL->getTypeAllocSize(SrcTy->getPointerElementType()) ==
4269 DL->getTypeAllocSize(DstTy->getPointerElementType()))
Michael Kruse37d136e2016-02-26 16:08:24 +00004270 Address = Src;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004271 }
Michael Kruse37d136e2016-02-26 16:08:24 +00004272
4273 auto *GEP = dyn_cast<GetElementPtrInst>(Address);
4274 if (!GEP)
4275 return false;
4276
4277 std::vector<const SCEV *> Subscripts;
4278 std::vector<int> Sizes;
4279 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
4280 auto *BasePtr = GEP->getOperand(0);
4281
Tobias Grosser535afd82016-04-05 06:23:45 +00004282 if (auto *BasePtrCast = dyn_cast<BitCastInst>(BasePtr))
4283 BasePtr = BasePtrCast->getOperand(0);
4284
4285 // Check for identical base pointers to ensure that we do not miss index
4286 // offsets that have been added before this GEP is applied.
4287 if (BasePtr != BasePointer->getValue())
4288 return false;
4289
Michael Kruse37d136e2016-02-26 16:08:24 +00004290 std::vector<const SCEV *> SizesSCEV;
4291
4292 for (auto *Subscript : Subscripts) {
4293 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004294 if (!isAffineExpr(R, L, Subscript, *SE, &AccessILS))
Michael Kruse37d136e2016-02-26 16:08:24 +00004295 return false;
4296
4297 for (LoadInst *LInst : AccessILS)
4298 if (!ScopRIL.count(LInst))
4299 return false;
4300 }
4301
4302 if (Sizes.empty())
4303 return false;
4304
4305 for (auto V : Sizes)
4306 SizesSCEV.push_back(SE->getSCEV(
4307 ConstantInt::get(IntegerType::getInt64Ty(BasePtr->getContext()), V)));
4308
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004309 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004310 Subscripts, SizesSCEV, Val);
4311 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004312}
4313
4314bool ScopInfo::buildAccessMultiDimParam(
4315 MemAccInst Inst, Loop *L, Region *R,
4316 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004317 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse37d136e2016-02-26 16:08:24 +00004318 if (!PollyDelinearize)
4319 return false;
4320
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004321 Value *Address = Inst.getPointerOperand();
4322 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004323 Type *ElementType = Val->getType();
4324 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004325 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004326 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004327
4328 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4329 const SCEVUnknown *BasePointer =
4330 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4331
4332 assert(BasePointer && "Could not find base pointer");
4333 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004334
Michael Kruse7bf39442015-09-10 12:46:52 +00004335 auto AccItr = InsnToMemAcc.find(Inst);
Michael Kruse37d136e2016-02-26 16:08:24 +00004336 if (AccItr == InsnToMemAcc.end())
4337 return false;
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004338
Michael Kruse37d136e2016-02-26 16:08:24 +00004339 std::vector<const SCEV *> Sizes(
4340 AccItr->second.Shape->DelinearizedSizes.begin(),
4341 AccItr->second.Shape->DelinearizedSizes.end());
4342 // Remove the element size. This information is already provided by the
4343 // ElementSize parameter. In case the element size of this access and the
4344 // element size used for delinearization differs the delinearization is
4345 // incorrect. Hence, we invalidate the scop.
4346 //
4347 // TODO: Handle delinearization with differing element sizes.
4348 auto DelinearizedSize =
4349 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
4350 Sizes.pop_back();
4351 if (ElementSize != DelinearizedSize)
4352 scop->invalidate(DELINEARIZATION, Inst->getDebugLoc());
4353
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004354 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004355 AccItr->second.DelinearizedSubscripts, Sizes, Val);
4356 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004357}
4358
Johannes Doerfertcea61932016-02-21 19:13:19 +00004359bool ScopInfo::buildAccessMemIntrinsic(
4360 MemAccInst Inst, Loop *L, Region *R,
4361 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4362 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004363 auto *MemIntr = dyn_cast_or_null<MemIntrinsic>(Inst);
4364
4365 if (MemIntr == nullptr)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004366 return false;
4367
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004368 auto *LengthVal = SE->getSCEVAtScope(MemIntr->getLength(), L);
Johannes Doerfertcea61932016-02-21 19:13:19 +00004369 assert(LengthVal);
4370
Johannes Doerferta7920982016-02-25 14:08:48 +00004371 // Check if the length val is actually affine or if we overapproximate it
4372 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004373 bool LengthIsAffine = isAffineExpr(R, L, LengthVal, *SE, &AccessILS);
Johannes Doerferta7920982016-02-25 14:08:48 +00004374 for (LoadInst *LInst : AccessILS)
4375 if (!ScopRIL.count(LInst))
4376 LengthIsAffine = false;
4377 if (!LengthIsAffine)
4378 LengthVal = nullptr;
4379
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004380 auto *DestPtrVal = MemIntr->getDest();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004381 assert(DestPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004382
Johannes Doerfertcea61932016-02-21 19:13:19 +00004383 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
4384 assert(DestAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004385 // Ignore accesses to "NULL".
4386 // TODO: We could use this to optimize the region further, e.g., intersect
4387 // the context with
4388 // isl_set_complement(isl_set_params(getDomain()))
4389 // as we know it would be undefined to execute this instruction anyway.
4390 if (DestAccFunc->isZero())
4391 return true;
4392
Johannes Doerfertcea61932016-02-21 19:13:19 +00004393 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
4394 assert(DestPtrSCEV);
4395 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
4396 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
4397 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
4398 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
4399
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004400 auto *MemTrans = dyn_cast<MemTransferInst>(MemIntr);
4401 if (!MemTrans)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004402 return true;
4403
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004404 auto *SrcPtrVal = MemTrans->getSource();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004405 assert(SrcPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004406
Johannes Doerfertcea61932016-02-21 19:13:19 +00004407 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
4408 assert(SrcAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004409 // Ignore accesses to "NULL".
4410 // TODO: See above TODO
4411 if (SrcAccFunc->isZero())
4412 return true;
4413
Johannes Doerfertcea61932016-02-21 19:13:19 +00004414 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
4415 assert(SrcPtrSCEV);
4416 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
4417 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
4418 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
4419 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
4420
4421 return true;
4422}
4423
Johannes Doerferta7920982016-02-25 14:08:48 +00004424bool ScopInfo::buildAccessCallInst(
4425 MemAccInst Inst, Loop *L, Region *R,
4426 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4427 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004428 auto *CI = dyn_cast_or_null<CallInst>(Inst);
4429
4430 if (CI == nullptr)
Johannes Doerferta7920982016-02-25 14:08:48 +00004431 return false;
4432
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004433 if (CI->doesNotAccessMemory() || isIgnoredIntrinsic(CI))
Johannes Doerferta7920982016-02-25 14:08:48 +00004434 return true;
4435
4436 bool ReadOnly = false;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004437 auto *AF = SE->getConstant(IntegerType::getInt64Ty(CI->getContext()), 0);
4438 auto *CalledFunction = CI->getCalledFunction();
Johannes Doerferta7920982016-02-25 14:08:48 +00004439 switch (AA->getModRefBehavior(CalledFunction)) {
4440 case llvm::FMRB_UnknownModRefBehavior:
4441 llvm_unreachable("Unknown mod ref behaviour cannot be represented.");
4442 case llvm::FMRB_DoesNotAccessMemory:
4443 return true;
4444 case llvm::FMRB_OnlyReadsMemory:
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004445 GlobalReads.push_back(CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004446 return true;
4447 case llvm::FMRB_OnlyReadsArgumentPointees:
4448 ReadOnly = true;
4449 // Fall through
4450 case llvm::FMRB_OnlyAccessesArgumentPointees:
4451 auto AccType = ReadOnly ? MemoryAccess::READ : MemoryAccess::MAY_WRITE;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004452 for (const auto &Arg : CI->arg_operands()) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004453 if (!Arg->getType()->isPointerTy())
4454 continue;
4455
4456 auto *ArgSCEV = SE->getSCEVAtScope(Arg, L);
4457 if (ArgSCEV->isZero())
4458 continue;
4459
4460 auto *ArgBasePtr = cast<SCEVUnknown>(SE->getPointerBase(ArgSCEV));
4461 addArrayAccess(Inst, AccType, ArgBasePtr->getValue(),
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004462 ArgBasePtr->getType(), false, {AF}, {}, CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004463 }
4464 return true;
4465 }
4466
4467 return true;
4468}
4469
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004470void ScopInfo::buildAccessSingleDim(
4471 MemAccInst Inst, Loop *L, Region *R,
4472 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4473 const InvariantLoadsSetTy &ScopRIL) {
4474 Value *Address = Inst.getPointerOperand();
4475 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004476 Type *ElementType = Val->getType();
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004477 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004478 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004479
4480 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4481 const SCEVUnknown *BasePointer =
4482 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4483
4484 assert(BasePointer && "Could not find base pointer");
4485 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00004486
4487 // Check if the access depends on a loop contained in a non-affine subregion.
4488 bool isVariantInNonAffineLoop = false;
4489 if (BoxedLoops) {
4490 SetVector<const Loop *> Loops;
4491 findLoops(AccessFunction, Loops);
4492 for (const Loop *L : Loops)
4493 if (BoxedLoops->count(L))
4494 isVariantInNonAffineLoop = true;
4495 }
4496
Johannes Doerfert09e36972015-10-07 20:17:36 +00004497 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00004498 bool IsAffine = !isVariantInNonAffineLoop &&
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004499 isAffineExpr(R, L, AccessFunction, *SE, &AccessILS);
Johannes Doerfert09e36972015-10-07 20:17:36 +00004500
4501 for (LoadInst *LInst : AccessILS)
4502 if (!ScopRIL.count(LInst))
4503 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004504
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004505 if (!IsAffine && AccType == MemoryAccess::MUST_WRITE)
4506 AccType = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004507
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004508 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004509 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004510}
4511
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004512void ScopInfo::buildMemoryAccess(
4513 MemAccInst Inst, Loop *L, Region *R,
4514 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004515 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004516
Johannes Doerfertcea61932016-02-21 19:13:19 +00004517 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4518 return;
4519
Johannes Doerferta7920982016-02-25 14:08:48 +00004520 if (buildAccessCallInst(Inst, L, R, BoxedLoops, ScopRIL))
4521 return;
4522
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004523 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4524 return;
4525
Hongbin Zheng22623202016-02-15 00:20:58 +00004526 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004527 return;
4528
4529 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4530}
4531
Hongbin Zheng22623202016-02-15 00:20:58 +00004532void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4533 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004534
4535 if (SD->isNonAffineSubRegion(&SR, &R)) {
4536 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004537 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004538 return;
4539 }
4540
4541 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4542 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004543 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004544 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004545 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004546}
4547
Johannes Doerferta8781032016-02-02 14:14:40 +00004548void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004549
Johannes Doerferta8781032016-02-02 14:14:40 +00004550 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004551 scop->addScopStmt(nullptr, &SR);
4552 return;
4553 }
4554
4555 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4556 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004557 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004558 else
4559 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4560}
4561
Michael Krused868b5d2015-09-10 15:25:24 +00004562void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004563 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004564 Region *NonAffineSubRegion,
4565 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004566 // We do not build access functions for error blocks, as they may contain
4567 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004568 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004569 return;
4570
Michael Kruse7bf39442015-09-10 12:46:52 +00004571 Loop *L = LI->getLoopFor(&BB);
4572
4573 // The set of loops contained in non-affine subregions that are part of R.
4574 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4575
Johannes Doerfert09e36972015-10-07 20:17:36 +00004576 // The set of loads that are required to be invariant.
4577 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4578
Michael Kruse2e02d562016-02-06 09:19:40 +00004579 for (Instruction &Inst : BB) {
4580 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004581 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004582 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004583
4584 // For the exit block we stop modeling after the last PHI node.
4585 if (!PHI && IsExitBlock)
4586 break;
4587
Johannes Doerfert09e36972015-10-07 20:17:36 +00004588 // TODO: At this point we only know that elements of ScopRIL have to be
4589 // invariant and will be hoisted for the SCoP to be processed. Though,
4590 // there might be other invariant accesses that will be hoisted and
4591 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004592 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004593 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004594
Michael Kruse2e02d562016-02-06 09:19:40 +00004595 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004596 continue;
4597
Tobias Grosser0904c692016-03-16 23:33:54 +00004598 // PHI nodes have already been modeled above and TerminatorInsts that are
4599 // not part of a non-affine subregion are fully modeled and regenerated
4600 // from the polyhedral domains. Hence, they do not need to be modeled as
4601 // explicit data dependences.
4602 if (!PHI && (!isa<TerminatorInst>(&Inst) || NonAffineSubRegion))
Michael Kruse2e02d562016-02-06 09:19:40 +00004603 buildScalarDependences(&Inst);
Tobias Grosser0904c692016-03-16 23:33:54 +00004604
Michael Kruse2e02d562016-02-06 09:19:40 +00004605 if (!IsExitBlock)
4606 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004607 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004608}
Michael Kruse7bf39442015-09-10 12:46:52 +00004609
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004610MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004611 MemoryAccess::AccessType AccType,
4612 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004613 bool Affine, Value *AccessValue,
4614 ArrayRef<const SCEV *> Subscripts,
4615 ArrayRef<const SCEV *> Sizes,
4616 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004617 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004618
4619 // Do not create a memory access for anything not in the SCoP. It would be
4620 // ignored anyway.
4621 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004622 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004623
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004624 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004625 Value *BaseAddr = BaseAddress;
4626 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4627
Tobias Grosserf4f68702015-12-14 15:05:37 +00004628 bool isKnownMustAccess = false;
4629
4630 // Accesses in single-basic block statements are always excuted.
4631 if (Stmt->isBlockStmt())
4632 isKnownMustAccess = true;
4633
4634 if (Stmt->isRegionStmt()) {
4635 // Accesses that dominate the exit block of a non-affine region are always
4636 // executed. In non-affine regions there may exist MK_Values that do not
4637 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4638 // only if there is at most one PHI_WRITE in the non-affine region.
4639 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4640 isKnownMustAccess = true;
4641 }
4642
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004643 // Non-affine PHI writes do not "happen" at a particular instruction, but
4644 // after exiting the statement. Therefore they are guaranteed execute and
4645 // overwrite the old value.
4646 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4647 isKnownMustAccess = true;
4648
Johannes Doerfertcea61932016-02-21 19:13:19 +00004649 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4650 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004651
Johannes Doerfertcea61932016-02-21 19:13:19 +00004652 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004653 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004654 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004655 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004656}
4657
Michael Kruse70131d32016-01-27 17:09:17 +00004658void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004659 MemoryAccess::AccessType AccType,
4660 Value *BaseAddress, Type *ElementType,
4661 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004662 ArrayRef<const SCEV *> Sizes,
4663 Value *AccessValue) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004664 ArrayBasePointers.insert(BaseAddress);
Hongbin Zhengf3d66122016-02-26 09:47:11 +00004665 addMemoryAccess(MemAccInst->getParent(), MemAccInst, AccType, BaseAddress,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004666 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004667 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004668}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004669
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004670void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004671 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004672
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004673 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004674 if (!Stmt)
4675 return;
4676
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004677 // Do not process further if the instruction is already written.
4678 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004679 return;
4680
Johannes Doerfertcea61932016-02-21 19:13:19 +00004681 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4682 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004683 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004684}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004685
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004686void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004687
Michael Kruse2e02d562016-02-06 09:19:40 +00004688 // There cannot be an "access" for literal constants. BasicBlock references
4689 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004690 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004691 return;
4692
Michael Krusefd463082016-01-27 22:51:56 +00004693 // If the instruction can be synthesized and the user is in the region we do
4694 // not need to add a value dependences.
4695 Region &ScopRegion = scop->getRegion();
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004696 auto *Scope = LI->getLoopFor(UserBB);
4697 if (canSynthesize(V, LI, SE, &ScopRegion, Scope))
Michael Krusefd463082016-01-27 22:51:56 +00004698 return;
4699
Michael Kruse2e02d562016-02-06 09:19:40 +00004700 // Do not build scalar dependences for required invariant loads as we will
4701 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004702 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004703 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004704 return;
4705
4706 // Determine the ScopStmt containing the value's definition and use. There is
4707 // no defining ScopStmt if the value is a function argument, a global value,
4708 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004709 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004710 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004711
Michael Kruse6f7721f2016-02-24 22:08:19 +00004712 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004713
4714 // We do not model uses outside the scop.
4715 if (!UserStmt)
4716 return;
4717
Michael Kruse2e02d562016-02-06 09:19:40 +00004718 // Add MemoryAccess for invariant values only if requested.
4719 if (!ModelReadOnlyScalars && !ValueStmt)
4720 return;
4721
4722 // Ignore use-def chains within the same ScopStmt.
4723 if (ValueStmt == UserStmt)
4724 return;
4725
Michael Krusead28e5a2016-01-26 13:33:15 +00004726 // Do not create another MemoryAccess for reloading the value if one already
4727 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004728 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004729 return;
4730
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004731 // For exit PHIs use the MK_ExitPHI MemoryKind not MK_Value.
4732 ScopArrayInfo::MemoryKind Kind = ScopArrayInfo::MK_Value;
4733 if (!ValueStmt && isa<PHINode>(V))
4734 Kind = ScopArrayInfo::MK_ExitPHI;
4735
Johannes Doerfertcea61932016-02-21 19:13:19 +00004736 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004737 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(), Kind);
Michael Kruse2e02d562016-02-06 09:19:40 +00004738 if (ValueInst)
4739 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004740}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004741
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004742void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4743 Value *IncomingValue, bool IsExitBlock) {
Johannes Doerfert57c5f0b2016-04-05 13:44:21 +00004744 // As the incoming block might turn out to be an error statement ensure we
4745 // will create an exit PHI SAI object. It is needed during code generation
4746 // and would be created later anyway.
4747 if (IsExitBlock)
4748 scop->getOrCreateScopArrayInfo(PHI, PHI->getType(), {},
4749 ScopArrayInfo::MK_ExitPHI);
4750
Michael Kruse6f7721f2016-02-24 22:08:19 +00004751 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004752 if (!IncomingStmt)
4753 return;
4754
4755 // Take care for the incoming value being available in the incoming block.
4756 // This must be done before the check for multiple PHI writes because multiple
4757 // exiting edges from subregion each can be the effective written value of the
4758 // subregion. As such, all of them must be made available in the subregion
4759 // statement.
4760 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004761
4762 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4763 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4764 assert(Acc->getAccessInstruction() == PHI);
4765 Acc->addIncoming(IncomingBlock, IncomingValue);
4766 return;
4767 }
4768
4769 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004770 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4771 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4772 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004773 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4774 assert(Acc);
4775 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004776}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004777
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004778void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004779 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4780 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4781 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004782}
4783
Michael Krusedaf66942015-12-13 22:10:37 +00004784void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004785 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse09eb4452016-03-03 22:10:47 +00004786 scop.reset(new Scop(R, *SE, *LI, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004787
Johannes Doerferta8781032016-02-02 14:14:40 +00004788 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004789 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004790
4791 // In case the region does not have an exiting block we will later (during
4792 // code generation) split the exit block. This will move potential PHI nodes
4793 // from the current exit block into the new region exiting block. Hence, PHI
4794 // nodes that are at this point not part of the region will be.
4795 // To handle these PHI nodes later we will now model their operands as scalar
4796 // accesses. Note that we do not model anything in the exit block if we have
4797 // an exiting block in the region, as there will not be any splitting later.
4798 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004799 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4800 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004801
Johannes Doerferta7920982016-02-25 14:08:48 +00004802 // Create memory accesses for global reads since all arrays are now known.
4803 auto *AF = SE->getConstant(IntegerType::getInt64Ty(SE->getContext()), 0);
4804 for (auto *GlobalRead : GlobalReads)
4805 for (auto *BP : ArrayBasePointers)
4806 addArrayAccess(MemAccInst(GlobalRead), MemoryAccess::READ, BP,
4807 BP->getType(), false, {AF}, {}, GlobalRead);
4808
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004809 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004810}
4811
Michael Krused868b5d2015-09-10 15:25:24 +00004812void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004813 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004814 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004815 return;
4816 }
4817
Michael Kruse9d080092015-09-11 21:41:48 +00004818 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004819}
4820
Hongbin Zhengfec32802016-02-13 15:13:02 +00004821void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004822
4823//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004824ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004825
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004826ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004827
Tobias Grosser75805372011-04-29 06:27:02 +00004828void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004829 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004830 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004831 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004832 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4833 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004834 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004835 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004836 AU.setPreservesAll();
4837}
4838
4839bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004840 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004841
Michael Krused868b5d2015-09-10 15:25:24 +00004842 if (!SD->isMaxRegionInScop(*R))
4843 return false;
4844
4845 Function *F = R->getEntry()->getParent();
4846 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4847 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4848 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004849 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004850 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004851 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004852
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004853 DebugLoc Beg, End;
4854 getDebugLocations(R, Beg, End);
4855 std::string Msg = "SCoP begins here.";
4856 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4857
Michael Krusedaf66942015-12-13 22:10:37 +00004858 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004859
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004860 DEBUG(scop->print(dbgs()));
4861
Michael Kruseafe06702015-10-02 16:33:27 +00004862 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004863 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004864 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004865 } else {
4866 Msg = "SCoP ends here.";
4867 ++ScopFound;
4868 if (scop->getMaxLoopDepth() > 0)
4869 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004870 }
4871
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004872 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4873
Tobias Grosser75805372011-04-29 06:27:02 +00004874 return false;
4875}
4876
4877char ScopInfo::ID = 0;
4878
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004879Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4880
Tobias Grosser73600b82011-10-08 00:30:40 +00004881INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4882 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004883 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004884INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004885INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004886INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004887INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004888INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004889INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004890INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004891INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4892 "Polly - Create polyhedral description of Scops", false,
4893 false)