blob: 38d402f10b4392593d3b78c4a014af2494c87e10 [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 Doerfertede4eca2016-05-10 14:01:21 +00001304 bool Valid = buildConditionSets(Stmt, BinOp->getOperand(0), TI, L, Domain,
1305 ConditionSets) &&
1306 buildConditionSets(Stmt, BinOp->getOperand(1), TI, L, Domain,
1307 ConditionSets);
1308 if (!Valid) {
1309 while (!ConditionSets.empty())
1310 isl_set_free(ConditionSets.pop_back_val());
Johannes Doerfert297c7202016-05-10 13:06:42 +00001311 return false;
Johannes Doerfertede4eca2016-05-10 14:01:21 +00001312 }
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001313
1314 isl_set_free(ConditionSets.pop_back_val());
1315 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1316 isl_set_free(ConditionSets.pop_back_val());
1317 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1318
1319 if (Opcode == Instruction::And)
1320 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1321 else
1322 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1323 } else {
1324 auto *ICond = dyn_cast<ICmpInst>(Condition);
1325 assert(ICond &&
1326 "Condition of exiting branch was neither constant nor ICmp!");
1327
1328 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001329 isl_pw_aff *LHS, *RHS;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00001330 // For unsigned comparisons we assumed the signed bit of neither operand
1331 // to be set. The comparison is equal to a signed comparison under this
1332 // assumption.
1333 bool NonNeg = ICond->isUnsigned();
1334 LHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), NonNeg);
1335 RHS = Stmt.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), NonNeg);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001336 ConsequenceCondSet =
1337 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1338 }
1339
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001340 // If no terminator was given we are only looking for parameter constraints
1341 // under which @p Condition is true/false.
1342 if (!TI)
1343 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001344 assert(ConsequenceCondSet);
Johannes Doerfert15194912016-04-04 07:59:41 +00001345 ConsequenceCondSet = isl_set_coalesce(
1346 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain)));
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001347
Johannes Doerfertb2885792016-04-26 09:20:41 +00001348 isl_set *AlternativeCondSet = nullptr;
Michael Krusef7a4a942016-05-02 12:25:36 +00001349 bool TooComplex =
Michael Krusebc150122016-05-02 12:25:18 +00001350 isl_set_n_basic_set(ConsequenceCondSet) >= MaxDisjunctionsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001351
Michael Krusef7a4a942016-05-02 12:25:36 +00001352 if (!TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001353 AlternativeCondSet = isl_set_subtract(isl_set_copy(Domain),
1354 isl_set_copy(ConsequenceCondSet));
Michael Krusef7a4a942016-05-02 12:25:36 +00001355 TooComplex =
Michael Krusebc150122016-05-02 12:25:18 +00001356 isl_set_n_basic_set(AlternativeCondSet) >= MaxDisjunctionsInDomain;
Johannes Doerfertb2885792016-04-26 09:20:41 +00001357 }
1358
Michael Krusef7a4a942016-05-02 12:25:36 +00001359 if (TooComplex) {
Johannes Doerfert15194912016-04-04 07:59:41 +00001360 S.invalidate(COMPLEXITY, TI ? TI->getDebugLoc() : DebugLoc());
Johannes Doerfertb2885792016-04-26 09:20:41 +00001361 isl_set_free(AlternativeCondSet);
Johannes Doerfertb2885792016-04-26 09:20:41 +00001362 isl_set_free(ConsequenceCondSet);
Johannes Doerfert297c7202016-05-10 13:06:42 +00001363 return false;
Johannes Doerfert15194912016-04-04 07:59:41 +00001364 }
1365
1366 ConditionSets.push_back(ConsequenceCondSet);
1367 ConditionSets.push_back(isl_set_coalesce(AlternativeCondSet));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001368
1369 return true;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001370}
1371
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001372/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1373///
1374/// This will fill @p ConditionSets with the conditions under which control
1375/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1376/// have as many elements as @p TI has successors.
Johannes Doerfert297c7202016-05-10 13:06:42 +00001377static bool
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001378buildConditionSets(ScopStmt &Stmt, TerminatorInst *TI, Loop *L,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001379 __isl_keep isl_set *Domain,
1380 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1381
1382 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001383 return buildConditionSets(Stmt, SI, L, Domain, ConditionSets);
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001384
1385 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1386
1387 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001388 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00001389 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00001390 }
1391
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001392 Value *Condition = getConditionFromTerminator(TI);
1393 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001394
Johannes Doerfert171b92f2016-04-19 14:53:13 +00001395 return buildConditionSets(Stmt, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001396}
1397
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001398void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001399 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001400
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001401 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001402 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001403}
1404
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001405void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1406 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001407 isl_ctx *Ctx = Parent.getIslCtx();
1408 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1409 Type *Ty = GEP->getPointerOperandType();
1410 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001411
1412 // The set of loads that are required to be invariant.
1413 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001414
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001415 std::vector<const SCEV *> Subscripts;
1416 std::vector<int> Sizes;
1417
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001418 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001419
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001420 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001421 Ty = PtrTy->getElementType();
1422 }
1423
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001424 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001425
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001426 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001427
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001428 auto *NotExecuted = isl_set_complement(isl_set_params(getDomain()));
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001429 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001430 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001431 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001432
Michael Kruse09eb4452016-03-03 22:10:47 +00001433 auto *Scope = SD.getLI()->getLoopFor(getEntryBlock());
Johannes Doerfert09e36972015-10-07 20:17:36 +00001434 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00001435 if (!isAffineExpr(&Parent.getRegion(), Scope, Expr, SE, &AccessILS))
Johannes Doerfert09e36972015-10-07 20:17:36 +00001436 continue;
1437
1438 bool NonAffine = false;
1439 for (LoadInst *LInst : AccessILS)
1440 if (!ScopRIL.count(LInst))
1441 NonAffine = true;
1442
1443 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001444 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001445
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001446 isl_pw_aff *AccessOffset = getPwAff(Expr);
1447 AccessOffset =
1448 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001449
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001450 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1451 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001452
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001453 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1454 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1455 OutOfBound = isl_set_params(OutOfBound);
1456 isl_set *InBound = isl_set_complement(OutOfBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001457
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001458 // A => B == !A or B
1459 isl_set *InBoundIfExecuted =
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001460 isl_set_union(isl_set_copy(NotExecuted), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001461
Roman Gareev10595a12016-01-08 14:01:59 +00001462 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00001463 Parent.recordAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc(),
1464 AS_ASSUMPTION);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001465 }
1466
1467 isl_local_space_free(LSpace);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001468 isl_set_free(NotExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001469}
1470
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001471void ScopStmt::deriveAssumptions(ScopDetection &SD) {
1472 for (auto *MA : *this) {
1473 if (!MA->isArrayKind())
1474 continue;
1475
1476 MemAccInst Acc(MA->getAccessInstruction());
1477 auto *GEP = dyn_cast_or_null<GetElementPtrInst>(Acc.getPointerOperand());
1478
1479 if (GEP)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001480 deriveAssumptionsFromGEP(GEP, SD);
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001481 }
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001482}
1483
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001484void ScopStmt::collectSurroundingLoops() {
1485 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1486 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1487 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1488 isl_id_free(DimId);
1489 }
1490}
1491
Michael Kruse9d080092015-09-11 21:41:48 +00001492ScopStmt::ScopStmt(Scop &parent, Region &R)
Johannes Doerferta3519512016-04-23 13:02:23 +00001493 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(nullptr),
1494 R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001495
Tobias Grosser16c44032015-07-09 07:31:45 +00001496 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001497}
1498
Michael Kruse9d080092015-09-11 21:41:48 +00001499ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Johannes Doerferta3519512016-04-23 13:02:23 +00001500 : Parent(parent), InvalidDomain(nullptr), Domain(nullptr), BB(&bb),
1501 R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001502
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001503 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001504}
1505
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001506void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001507 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001508
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001509 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001510 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001511 buildAccessRelations();
1512
Johannes Doerfertd5c369f2016-04-25 18:55:15 +00001513 deriveAssumptions(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001514
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001515 if (DetectReductions)
1516 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001517}
1518
Johannes Doerferte58a0122014-06-27 20:31:28 +00001519/// @brief Collect loads which might form a reduction chain with @p StoreMA
1520///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001521/// Check if the stored value for @p StoreMA is a binary operator with one or
1522/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001523/// used only once (by @p StoreMA) and its load operands are also used only
1524/// once, we have found a possible reduction chain. It starts at an operand
1525/// load and includes the binary operator and @p StoreMA.
1526///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001527/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001528/// escape this block or into any other store except @p StoreMA.
1529void ScopStmt::collectCandiateReductionLoads(
1530 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1531 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1532 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001533 return;
1534
1535 // Skip if there is not one binary operator between the load and the store
1536 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001537 if (!BinOp)
1538 return;
1539
1540 // Skip if the binary operators has multiple uses
1541 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001542 return;
1543
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001544 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001545 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1546 return;
1547
Johannes Doerfert9890a052014-07-01 00:32:29 +00001548 // Skip if the binary operator is outside the current SCoP
1549 if (BinOp->getParent() != Store->getParent())
1550 return;
1551
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001552 // Skip if it is a multiplicative reduction and we disabled them
1553 if (DisableMultiplicativeReductions &&
1554 (BinOp->getOpcode() == Instruction::Mul ||
1555 BinOp->getOpcode() == Instruction::FMul))
1556 return;
1557
Johannes Doerferte58a0122014-06-27 20:31:28 +00001558 // Check the binary operator operands for a candidate load
1559 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1560 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1561 if (!PossibleLoad0 && !PossibleLoad1)
1562 return;
1563
1564 // A load is only a candidate if it cannot escape (thus has only this use)
1565 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001566 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001567 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001568 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001569 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001570 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001571}
1572
1573/// @brief Check for reductions in this ScopStmt
1574///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001575/// Iterate over all store memory accesses and check for valid binary reduction
1576/// like chains. For all candidates we check if they have the same base address
1577/// and there are no other accesses which overlap with them. The base address
1578/// check rules out impossible reductions candidates early. The overlap check,
1579/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001580/// guarantees that none of the intermediate results will escape during
1581/// execution of the loop nest. We basically check here that no other memory
1582/// access can access the same memory as the potential reduction.
1583void ScopStmt::checkForReductions() {
1584 SmallVector<MemoryAccess *, 2> Loads;
1585 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1586
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001587 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001588 // stores and collecting possible reduction loads.
1589 for (MemoryAccess *StoreMA : MemAccs) {
1590 if (StoreMA->isRead())
1591 continue;
1592
1593 Loads.clear();
1594 collectCandiateReductionLoads(StoreMA, Loads);
1595 for (MemoryAccess *LoadMA : Loads)
1596 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1597 }
1598
1599 // Then check each possible candidate pair.
1600 for (const auto &CandidatePair : Candidates) {
1601 bool Valid = true;
1602 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1603 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1604
1605 // Skip those with obviously unequal base addresses.
1606 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1607 isl_map_free(LoadAccs);
1608 isl_map_free(StoreAccs);
1609 continue;
1610 }
1611
1612 // And check if the remaining for overlap with other memory accesses.
1613 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1614 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1615 isl_set *AllAccs = isl_map_range(AllAccsRel);
1616
1617 for (MemoryAccess *MA : MemAccs) {
1618 if (MA == CandidatePair.first || MA == CandidatePair.second)
1619 continue;
1620
1621 isl_map *AccRel =
1622 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1623 isl_set *Accs = isl_map_range(AccRel);
1624
1625 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1626 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1627 Valid = Valid && isl_set_is_empty(OverlapAccs);
1628 isl_set_free(OverlapAccs);
1629 }
1630 }
1631
1632 isl_set_free(AllAccs);
1633 if (!Valid)
1634 continue;
1635
Johannes Doerfertf6183392014-07-01 20:52:51 +00001636 const LoadInst *Load =
1637 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1638 MemoryAccess::ReductionType RT =
1639 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1640
Johannes Doerferte58a0122014-06-27 20:31:28 +00001641 // If no overlapping access was found we mark the load and store as
1642 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001643 CandidatePair.first->markAsReductionLike(RT);
1644 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001645 }
Tobias Grosser75805372011-04-29 06:27:02 +00001646}
1647
Tobias Grosser74394f02013-01-14 22:40:23 +00001648std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001649
Tobias Grosser54839312015-04-21 11:37:25 +00001650std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001651 auto *S = getSchedule();
1652 auto Str = stringFromIslObj(S);
1653 isl_map_free(S);
1654 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001655}
1656
Johannes Doerferta3519512016-04-23 13:02:23 +00001657void ScopStmt::setInvalidDomain(__isl_take isl_set *ID) {
1658 isl_set_free(InvalidDomain);
1659 InvalidDomain = ID;
Johannes Doerfert7c013572016-04-12 09:57:34 +00001660}
1661
Michael Kruse375cb5f2016-02-24 22:08:24 +00001662BasicBlock *ScopStmt::getEntryBlock() const {
1663 if (isBlockStmt())
1664 return getBasicBlock();
1665 return getRegion()->getEntry();
1666}
1667
Tobias Grosser74394f02013-01-14 22:40:23 +00001668unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001669
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001670unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001671
Tobias Grosser75805372011-04-29 06:27:02 +00001672const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1673
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001674Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001675 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001676}
1677
Tobias Grosser74394f02013-01-14 22:40:23 +00001678isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001679
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001680__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001681
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001682__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001683 return isl_set_get_space(Domain);
1684}
1685
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001686__isl_give isl_id *ScopStmt::getDomainId() const {
1687 return isl_set_get_tuple_id(Domain);
1688}
Tobias Grossercd95b772012-08-30 11:49:38 +00001689
Johannes Doerfert7c013572016-04-12 09:57:34 +00001690ScopStmt::~ScopStmt() {
1691 isl_set_free(Domain);
Johannes Doerferta3519512016-04-23 13:02:23 +00001692 isl_set_free(InvalidDomain);
Johannes Doerfert7c013572016-04-12 09:57:34 +00001693}
Tobias Grosser75805372011-04-29 06:27:02 +00001694
1695void ScopStmt::print(raw_ostream &OS) const {
1696 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001697 OS.indent(12) << "Domain :=\n";
1698
1699 if (Domain) {
1700 OS.indent(16) << getDomainStr() << ";\n";
1701 } else
1702 OS.indent(16) << "n/a\n";
1703
Tobias Grosser54839312015-04-21 11:37:25 +00001704 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001705
1706 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001707 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001708 } else
1709 OS.indent(16) << "n/a\n";
1710
Tobias Grosser083d3d32014-06-28 08:59:45 +00001711 for (MemoryAccess *Access : MemAccs)
1712 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001713}
1714
1715void ScopStmt::dump() const { print(dbgs()); }
1716
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001717void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001718 // Remove all memory accesses in @p InvMAs from this statement
1719 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001720 // MK_Value READs have no access instruction, hence would not be removed by
1721 // this function. However, it is only used for invariant LoadInst accesses,
1722 // its arguments are always affine, hence synthesizable, and therefore there
1723 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001724 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001725 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001726 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001727 };
1728 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1729 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001730 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001731 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001732}
1733
Tobias Grosser75805372011-04-29 06:27:02 +00001734//===----------------------------------------------------------------------===//
1735/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001736
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001737void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001738 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1739 isl_set_free(Context);
1740 Context = NewContext;
1741}
1742
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001743/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1744struct SCEVSensitiveParameterRewriter
1745 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1746 ValueToValueMap &VMap;
1747 ScalarEvolution &SE;
1748
1749public:
1750 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1751 : VMap(VMap), SE(SE) {}
1752
1753 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1754 ValueToValueMap &VMap) {
1755 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1756 return SSPR.visit(E);
1757 }
1758
1759 const SCEV *visit(const SCEV *E) {
1760 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1761 }
1762
1763 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1764
1765 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1766 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1767 }
1768
1769 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1770 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1771 }
1772
1773 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1774 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1775 }
1776
1777 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1778 SmallVector<const SCEV *, 4> Operands;
1779 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1780 Operands.push_back(visit(E->getOperand(i)));
1781 return SE.getAddExpr(Operands);
1782 }
1783
1784 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1785 SmallVector<const SCEV *, 4> Operands;
1786 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1787 Operands.push_back(visit(E->getOperand(i)));
1788 return SE.getMulExpr(Operands);
1789 }
1790
1791 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1792 SmallVector<const SCEV *, 4> Operands;
1793 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1794 Operands.push_back(visit(E->getOperand(i)));
1795 return SE.getSMaxExpr(Operands);
1796 }
1797
1798 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1799 SmallVector<const SCEV *, 4> Operands;
1800 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1801 Operands.push_back(visit(E->getOperand(i)));
1802 return SE.getUMaxExpr(Operands);
1803 }
1804
1805 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1806 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1807 }
1808
1809 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1810 auto *Start = visit(E->getStart());
1811 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1812 visit(E->getStepRecurrence(SE)),
1813 E->getLoop(), SCEV::FlagAnyWrap);
1814 return SE.getAddExpr(Start, AddRec);
1815 }
1816
1817 const SCEV *visitUnknown(const SCEVUnknown *E) {
1818 if (auto *NewValue = VMap.lookup(E->getValue()))
1819 return SE.getUnknown(NewValue);
1820 return E;
1821 }
1822};
1823
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001824const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001825 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001826}
1827
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001828void Scop::createParameterId(const SCEV *Parameter) {
1829 assert(Parameters.count(Parameter));
1830 assert(!ParameterIds.count(Parameter));
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001831
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001832 std::string ParameterName = "p_" + std::to_string(getNumParams() - 1);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001833
Tobias Grosser8f99c162011-11-15 11:38:55 +00001834 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1835 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001836
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001837 // If this parameter references a specific Value and this value has a name
1838 // we use this name as it is likely to be unique and more useful than just
1839 // a number.
1840 if (Val->hasName())
1841 ParameterName = Val->getName();
1842 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001843 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001844 if (LoadOrigin->hasName()) {
1845 ParameterName += "_loaded_from_";
1846 ParameterName +=
1847 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1848 }
1849 }
1850 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001851
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00001852 auto *Id = isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1853 const_cast<void *>((const void *)Parameter));
1854 ParameterIds[Parameter] = Id;
1855}
1856
1857void Scop::addParams(const ParameterSetTy &NewParameters) {
1858 for (const SCEV *Parameter : NewParameters) {
1859 // Normalize the SCEV to get the representing element for an invariant load.
1860 Parameter = extractConstantFactor(Parameter, *SE).second;
1861 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1862
1863 if (Parameters.insert(Parameter))
1864 createParameterId(Parameter);
1865 }
1866}
1867
1868__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
1869 // Normalize the SCEV to get the representing element for an invariant load.
1870 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1871 return isl_id_copy(ParameterIds.lookup(Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001872}
Tobias Grosser75805372011-04-29 06:27:02 +00001873
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00001874__isl_give isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001875 isl_set *DomainContext = isl_union_set_params(getDomains());
1876 return isl_set_intersect_params(C, DomainContext);
1877}
1878
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001879void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1880 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001881 auto *R = &getRegion();
1882 auto &F = *R->getEntry()->getParent();
1883 for (auto &Assumption : AC.assumptions()) {
1884 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1885 if (!CI || CI->getNumArgOperands() != 1)
1886 continue;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001887
1888 bool InR = R->contains(CI);
1889 if (!InR && !DT.dominates(CI->getParent(), R->getEntry()))
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001890 continue;
1891
Michael Kruse09eb4452016-03-03 22:10:47 +00001892 auto *L = LI.getLoopFor(CI->getParent());
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001893 auto *Val = CI->getArgOperand(0);
Johannes Doerfertf560b3d2016-04-25 13:33:07 +00001894 ParameterSetTy DetectedParams;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001895 if (!isAffineConstraint(Val, R, L, *SE, DetectedParams)) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001896 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1897 CI->getDebugLoc(),
1898 "Non-affine user assumption ignored.");
1899 continue;
1900 }
1901
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001902 // Collect all newly introduced parameters.
1903 ParameterSetTy NewParams;
1904 for (auto *Param : DetectedParams) {
1905 Param = extractConstantFactor(Param, *SE).second;
1906 Param = getRepresentingInvariantLoadSCEV(Param);
1907 if (Parameters.count(Param))
1908 continue;
1909 NewParams.insert(Param);
1910 }
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001911
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001912 SmallVector<isl_set *, 2> ConditionSets;
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001913 auto *TI = InR ? CI->getParent()->getTerminator() : nullptr;
1914 auto &Stmt = InR ? *getStmtFor(CI->getParent()) : *Stmts.begin();
1915 auto *Dom = InR ? getDomainConditions(&Stmt) : isl_set_copy(Context);
1916 bool Valid = buildConditionSets(Stmt, Val, TI, L, Dom, ConditionSets);
1917 isl_set_free(Dom);
1918
1919 if (!Valid)
Johannes Doerfert297c7202016-05-10 13:06:42 +00001920 continue;
1921
Johannes Doerfert2b92a0e2016-05-10 14:00:57 +00001922 isl_set *AssumptionCtx = nullptr;
1923 if (InR) {
1924 AssumptionCtx = isl_set_complement(isl_set_params(ConditionSets[1]));
1925 isl_set_free(ConditionSets[0]);
1926 } else {
1927 AssumptionCtx = isl_set_complement(ConditionSets[1]);
1928 AssumptionCtx = isl_set_intersect(AssumptionCtx, ConditionSets[0]);
1929 }
Johannes Doerfertc78ce7d2016-04-25 18:51:27 +00001930
1931 // Project out newly introduced parameters as they are not otherwise useful.
1932 if (!NewParams.empty()) {
1933 for (unsigned u = 0; u < isl_set_n_param(AssumptionCtx); u++) {
1934 auto *Id = isl_set_get_dim_id(AssumptionCtx, isl_dim_param, u);
1935 auto *Param = static_cast<const SCEV *>(isl_id_get_user(Id));
1936 isl_id_free(Id);
1937
1938 if (!NewParams.count(Param))
1939 continue;
1940
1941 AssumptionCtx =
1942 isl_set_project_out(AssumptionCtx, isl_dim_param, u--, 1);
1943 }
1944 }
1945
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001946 emitOptimizationRemarkAnalysis(
1947 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1948 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1949 Context = isl_set_intersect(Context, AssumptionCtx);
1950 }
1951}
1952
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001953void Scop::addUserContext() {
1954 if (UserContextStr.empty())
1955 return;
1956
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001957 isl_set *UserContext =
1958 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001959 isl_space *Space = getParamSpace();
1960 if (isl_space_dim(Space, isl_dim_param) !=
1961 isl_set_dim(UserContext, isl_dim_param)) {
1962 auto SpaceStr = isl_space_to_str(Space);
1963 errs() << "Error: the context provided in -polly-context has not the same "
1964 << "number of dimensions than the computed context. Due to this "
1965 << "mismatch, the -polly-context option is ignored. Please provide "
1966 << "the context in the parameter space: " << SpaceStr << ".\n";
1967 free(SpaceStr);
1968 isl_set_free(UserContext);
1969 isl_space_free(Space);
1970 return;
1971 }
1972
1973 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001974 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1975 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001976
1977 if (strcmp(NameContext, NameUserContext) != 0) {
1978 auto SpaceStr = isl_space_to_str(Space);
1979 errs() << "Error: the name of dimension " << i
1980 << " provided in -polly-context "
1981 << "is '" << NameUserContext << "', but the name in the computed "
1982 << "context is '" << NameContext
1983 << "'. Due to this name mismatch, "
1984 << "the -polly-context option is ignored. Please provide "
1985 << "the context in the parameter space: " << SpaceStr << ".\n";
1986 free(SpaceStr);
1987 isl_set_free(UserContext);
1988 isl_space_free(Space);
1989 return;
1990 }
1991
1992 UserContext =
1993 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1994 isl_space_get_dim_id(Space, isl_dim_param, i));
1995 }
1996
1997 Context = isl_set_intersect(Context, UserContext);
1998 isl_space_free(Space);
1999}
2000
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002001void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002002 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002003
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002004 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002005 for (LoadInst *LInst : RIL) {
2006 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2007
Johannes Doerfert96e54712016-02-07 17:30:13 +00002008 Type *Ty = LInst->getType();
2009 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002010 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002011 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002012 continue;
2013 }
2014
2015 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00002016 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
2017 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002018 }
2019}
2020
Tobias Grosser6be480c2011-11-08 15:41:13 +00002021void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002022 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00002023 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002024 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00002025 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00002026}
2027
Tobias Grosser18daaca2012-05-22 10:47:27 +00002028void Scop::addParameterBounds() {
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002029 unsigned PDim = 0;
2030 for (auto *Parameter : Parameters) {
2031 ConstantRange SRange = SE->getSignedRange(Parameter);
2032 Context = addRangeBoundsToSet(Context, SRange, PDim++, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00002033 }
2034}
2035
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002036void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002037 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002038 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00002039
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002040 unsigned PDim = 0;
2041 for (const auto *Parameter : Parameters) {
Tobias Grosser6be480c2011-11-08 15:41:13 +00002042 isl_id *id = getIdForParam(Parameter);
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00002043 Space = isl_space_set_dim_id(Space, isl_dim_param, PDim++, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00002044 }
2045
2046 // Align the parameters of all data structures to the model.
2047 Context = isl_set_align_params(Context, Space);
2048
Johannes Doerferta60ad842016-05-10 12:18:22 +00002049 // As all parameters are known add bounds to them.
2050 addParameterBounds();
2051
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002052 for (ScopStmt &Stmt : *this)
2053 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002054}
2055
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002056static __isl_give isl_set *
2057simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
2058 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002059 // If we modelt all blocks in the SCoP that have side effects we can simplify
2060 // the context with the constraints that are needed for anything to be
2061 // executed at all. However, if we have error blocks in the SCoP we already
2062 // assumed some parameter combinations cannot occure and removed them from the
2063 // domains, thus we cannot use the remaining domain to simplify the
2064 // assumptions.
2065 if (!S.hasErrorBlock()) {
2066 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
2067 AssumptionContext =
2068 isl_set_gist_params(AssumptionContext, DomainParameters);
2069 }
2070
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002071 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
2072 return AssumptionContext;
2073}
2074
2075void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002076 // The parameter constraints of the iteration domains give us a set of
2077 // constraints that need to hold for all cases where at least a single
2078 // statement iteration is executed in the whole scop. We now simplify the
2079 // assumed context under the assumption that such constraints hold and at
2080 // least a single statement iteration is executed. For cases where no
2081 // statement instances are executed, the assumptions we have taken about
2082 // the executed code do not matter and can be changed.
2083 //
2084 // WARNING: This only holds if the assumptions we have taken do not reduce
2085 // the set of statement instances that are executed. Otherwise we
2086 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002087 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002088 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002089 // performed. In such a case, modifying the run-time conditions and
2090 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002091 // to not be executed.
2092 //
2093 // Example:
2094 //
2095 // When delinearizing the following code:
2096 //
2097 // for (long i = 0; i < 100; i++)
2098 // for (long j = 0; j < m; j++)
2099 // A[i+p][j] = 1.0;
2100 //
2101 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002102 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002103 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002104 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002105 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00002106}
2107
Johannes Doerfertb164c792014-09-18 11:17:17 +00002108/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00002109static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002110 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
2111 isl_pw_multi_aff *MinPMA, *MaxPMA;
2112 isl_pw_aff *LastDimAff;
2113 isl_aff *OneAff;
2114 unsigned Pos;
2115
Johannes Doerfert6296d952016-04-22 11:38:19 +00002116 Set = isl_set_remove_divs(Set);
2117
Michael Krusebc150122016-05-02 12:25:18 +00002118 if (isl_set_n_basic_set(Set) >= MaxDisjunctionsInDomain) {
Johannes Doerfert6296d952016-04-22 11:38:19 +00002119 isl_set_free(Set);
2120 return isl_stat_error;
2121 }
2122
Johannes Doerfert9143d672014-09-27 11:02:39 +00002123 // Restrict the number of parameters involved in the access as the lexmin/
2124 // lexmax computation will take too long if this number is high.
2125 //
2126 // Experiments with a simple test case using an i7 4800MQ:
2127 //
2128 // #Parameters involved | Time (in sec)
2129 // 6 | 0.01
2130 // 7 | 0.04
2131 // 8 | 0.12
2132 // 9 | 0.40
2133 // 10 | 1.54
2134 // 11 | 6.78
2135 // 12 | 30.38
2136 //
2137 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
2138 unsigned InvolvedParams = 0;
2139 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
2140 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
2141 InvolvedParams++;
2142
2143 if (InvolvedParams > RunTimeChecksMaxParameters) {
2144 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002145 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002146 }
2147 }
2148
Johannes Doerfertb164c792014-09-18 11:17:17 +00002149 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2150 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2151
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002152 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2153 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2154
Johannes Doerfertb164c792014-09-18 11:17:17 +00002155 // Adjust the last dimension of the maximal access by one as we want to
2156 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2157 // we test during code generation might now point after the end of the
2158 // allocated array but we will never dereference it anyway.
2159 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2160 "Assumed at least one output dimension");
2161 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2162 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2163 OneAff = isl_aff_zero_on_domain(
2164 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2165 OneAff = isl_aff_add_constant_si(OneAff, 1);
2166 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2167 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2168
2169 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2170
2171 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002172 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002173}
2174
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002175static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2176 isl_set *Domain = MA->getStatement()->getDomain();
2177 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2178 return isl_set_reset_tuple_id(Domain);
2179}
2180
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002181/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2182static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002183 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002184 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002185
2186 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2187 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002188 Locations = isl_union_set_coalesce(Locations);
2189 Locations = isl_union_set_detect_equalities(Locations);
2190 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002191 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002192 isl_union_set_free(Locations);
2193 return Valid;
2194}
2195
Johannes Doerfert96425c22015-08-30 21:13:53 +00002196/// @brief Helper to treat non-affine regions and basic blocks the same.
2197///
2198///{
2199
2200/// @brief Return the block that is the representing block for @p RN.
2201static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2202 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2203 : RN->getNodeAs<BasicBlock>();
2204}
2205
2206/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002207static inline BasicBlock *
2208getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002209 if (RN->isSubRegion()) {
2210 assert(idx == 0);
2211 return RN->getNodeAs<Region>()->getExit();
2212 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002213 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002214}
2215
2216/// @brief Return the smallest loop surrounding @p RN.
2217static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2218 if (!RN->isSubRegion())
2219 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2220
2221 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2222 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2223 while (L && NonAffineSubRegion->contains(L))
2224 L = L->getParentLoop();
2225 return L;
2226}
2227
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002228static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2229 if (!RN->isSubRegion())
2230 return 1;
2231
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002232 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002233 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002234}
2235
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002236static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2237 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002238 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002239 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002240 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002241 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002242 return true;
2243 return false;
2244}
2245
Johannes Doerfert96425c22015-08-30 21:13:53 +00002246///}
2247
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002248static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2249 unsigned Dim, Loop *L) {
Michael Kruse88a22562016-03-29 07:50:52 +00002250 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002251 isl_id *DimId =
2252 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2253 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2254}
2255
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002256__isl_give isl_set *Scop::getDomainConditions(const ScopStmt *Stmt) const {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002257 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002258}
2259
Johannes Doerfertfff283d2016-04-19 14:48:22 +00002260__isl_give isl_set *Scop::getDomainConditions(BasicBlock *BB) const {
Johannes Doerfert41cda152016-04-08 10:32:26 +00002261 auto DIt = DomainMap.find(BB);
2262 if (DIt != DomainMap.end())
2263 return isl_set_copy(DIt->getSecond());
2264
2265 auto &RI = *R.getRegionInfo();
2266 auto *BBR = RI.getRegionFor(BB);
2267 while (BBR->getEntry() == BB)
2268 BBR = BBR->getParent();
2269 return getDomainConditions(BBR->getEntry());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002270}
2271
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002272bool Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002273 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002274
Johannes Doerfert432658d2016-01-26 11:01:41 +00002275 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002276 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002277 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2278 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002279 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002280
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002281 while (LD-- >= 0) {
2282 S = addDomainDimId(S, LD + 1, L);
2283 L = L->getParentLoop();
2284 }
2285
Johannes Doerferta3519512016-04-23 13:02:23 +00002286 // Initialize the invalid domain.
2287 auto *EntryStmt = getStmtFor(EntryBB);
2288 EntryStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(S)));
2289
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002290 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002291
Johannes Doerfert432658d2016-01-26 11:01:41 +00002292 if (IsOnlyNonAffineRegion)
Johannes Doerfert26404542016-05-10 12:19:47 +00002293 return !containsErrorBlock(R->getNode(), *R, LI, DT);
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002294
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002295 if (!buildDomainsWithBranchConstraints(R, SD, DT, LI))
2296 return false;
2297
Johannes Doerfert297c7202016-05-10 13:06:42 +00002298 if (!propagateDomainConstraints(R, SD, DT, LI))
2299 return false;
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002300
2301 // Error blocks and blocks dominated by them have been assumed to never be
2302 // executed. Representing them in the Scop does not add any value. In fact,
2303 // it is likely to cause issues during construction of the ScopStmts. The
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002304 // contents of error blocks have not been verified to be expressible and
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002305 // will cause problems when building up a ScopStmt for them.
2306 // Furthermore, basic blocks dominated by error blocks may reference
2307 // instructions in the error block which, if the error block is not modeled,
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002308 // can themselves not be constructed properly. To this end we will replace
2309 // the domains of error blocks and those only reachable via error blocks
2310 // with an empty set. Additionally, we will record for each block under which
Johannes Doerfert7c013572016-04-12 09:57:34 +00002311 // parameter combination it would be reached via an error block in its
Johannes Doerferta3519512016-04-23 13:02:23 +00002312 // InvalidDomain. This information is needed during load hoisting.
Johannes Doerfert297c7202016-05-10 13:06:42 +00002313 if (!propagateInvalidStmtDomains(R, SD, DT, LI))
2314 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002315
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002316 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002317}
2318
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002319static Loop *
2320getFirstNonBoxedLoopFor(BasicBlock *BB, LoopInfo &LI,
2321 const ScopDetection::BoxedLoopsSetTy &BoxedLoops) {
2322 auto *L = LI.getLoopFor(BB);
2323 while (BoxedLoops.count(L))
2324 L = L->getParentLoop();
2325 return L;
2326}
2327
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002328/// @brief Adjust the dimensions of @p Dom that was constructed for @p OldL
2329/// to be compatible to domains constructed for loop @p NewL.
2330///
2331/// This function assumes @p NewL and @p OldL are equal or there is a CFG
2332/// edge from @p OldL to @p NewL.
2333static __isl_give isl_set *adjustDomainDimensions(Scop &S,
2334 __isl_take isl_set *Dom,
2335 Loop *OldL, Loop *NewL) {
2336
2337 // If the loops are the same there is nothing to do.
2338 if (NewL == OldL)
2339 return Dom;
2340
2341 int OldDepth = S.getRelativeLoopDepth(OldL);
2342 int NewDepth = S.getRelativeLoopDepth(NewL);
2343 // If both loops are non-affine loops there is nothing to do.
2344 if (OldDepth == -1 && NewDepth == -1)
2345 return Dom;
2346
2347 // Distinguish three cases:
2348 // 1) The depth is the same but the loops are not.
2349 // => One loop was left one was entered.
2350 // 2) The depth increased from OldL to NewL.
2351 // => One loop was entered, none was left.
2352 // 3) The depth decreased from OldL to NewL.
2353 // => Loops were left were difference of the depths defines how many.
2354 if (OldDepth == NewDepth) {
2355 assert(OldL->getParentLoop() == NewL->getParentLoop());
2356 Dom = isl_set_project_out(Dom, isl_dim_set, NewDepth, 1);
2357 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2358 Dom = addDomainDimId(Dom, NewDepth, NewL);
2359 } else if (OldDepth < NewDepth) {
2360 assert(OldDepth + 1 == NewDepth);
2361 auto &R = S.getRegion();
2362 (void)R;
2363 assert(NewL->getParentLoop() == OldL ||
2364 ((!OldL || !R.contains(OldL)) && R.contains(NewL)));
2365 Dom = isl_set_add_dims(Dom, isl_dim_set, 1);
2366 Dom = addDomainDimId(Dom, NewDepth, NewL);
2367 } else {
2368 assert(OldDepth > NewDepth);
2369 int Diff = OldDepth - NewDepth;
2370 int NumDim = isl_set_n_dim(Dom);
2371 assert(NumDim >= Diff);
2372 Dom = isl_set_project_out(Dom, isl_dim_set, NumDim - Diff, Diff);
2373 }
2374
2375 return Dom;
2376}
Johannes Doerfert642594a2016-04-04 07:57:39 +00002377
Johannes Doerfert297c7202016-05-10 13:06:42 +00002378bool Scop::propagateInvalidStmtDomains(Region *R, ScopDetection &SD,
Johannes Doerferta3519512016-04-23 13:02:23 +00002379 DominatorTree &DT, LoopInfo &LI) {
2380 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002381
2382 ReversePostOrderTraversal<Region *> RTraversal(R);
2383 for (auto *RN : RTraversal) {
2384
2385 // Recurse for affine subregions but go on for basic blocks and non-affine
2386 // subregions.
2387 if (RN->isSubRegion()) {
2388 Region *SubRegion = RN->getNodeAs<Region>();
2389 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerferta3519512016-04-23 13:02:23 +00002390 propagateInvalidStmtDomains(SubRegion, SD, DT, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002391 continue;
2392 }
2393 }
2394
2395 bool ContainsErrorBlock = containsErrorBlock(RN, getRegion(), LI, DT);
2396 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002397 ScopStmt *Stmt = getStmtFor(BB);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002398 isl_set *&Domain = DomainMap[BB];
2399 assert(Domain && "Cannot propagate a nullptr");
2400
Johannes Doerferta3519512016-04-23 13:02:23 +00002401 auto *InvalidDomain = Stmt->getInvalidDomain();
Johannes Doerfert7c013572016-04-12 09:57:34 +00002402 bool IsInvalidBlock =
Johannes Doerferta3519512016-04-23 13:02:23 +00002403 ContainsErrorBlock || isl_set_is_subset(Domain, InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002404
Johannes Doerferta3519512016-04-23 13:02:23 +00002405 if (!IsInvalidBlock) {
2406 InvalidDomain = isl_set_intersect(InvalidDomain, isl_set_copy(Domain));
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002407 } else {
Johannes Doerferta3519512016-04-23 13:02:23 +00002408 isl_set_free(InvalidDomain);
2409 InvalidDomain = Domain;
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00002410 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
2411 recordAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2412 AS_RESTRICTION);
2413 Domain = nullptr;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002414 }
2415
Johannes Doerferta3519512016-04-23 13:02:23 +00002416 if (isl_set_is_empty(InvalidDomain)) {
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00002417 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002418 continue;
Johannes Doerfert7c013572016-04-12 09:57:34 +00002419 }
2420
Johannes Doerferta3519512016-04-23 13:02:23 +00002421 auto *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002422 auto *TI = BB->getTerminator();
2423 unsigned NumSuccs = RN->isSubRegion() ? 1 : TI->getNumSuccessors();
2424 for (unsigned u = 0; u < NumSuccs; u++) {
2425 auto *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert7c013572016-04-12 09:57:34 +00002426 auto *SuccStmt = getStmtFor(SuccBB);
2427
2428 // Skip successors outside the SCoP.
2429 if (!SuccStmt)
2430 continue;
2431
Johannes Doerferte4459a22016-04-25 13:34:50 +00002432 // Skip backedges.
2433 if (DT.dominates(SuccBB, BB))
2434 continue;
2435
Johannes Doerferta3519512016-04-23 13:02:23 +00002436 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
2437 auto *AdjustedInvalidDomain = adjustDomainDimensions(
2438 *this, isl_set_copy(InvalidDomain), BBLoop, SuccBBLoop);
2439 auto *SuccInvalidDomain = SuccStmt->getInvalidDomain();
2440 SuccInvalidDomain =
2441 isl_set_union(SuccInvalidDomain, AdjustedInvalidDomain);
2442 SuccInvalidDomain = isl_set_coalesce(SuccInvalidDomain);
2443 unsigned NumConjucts = isl_set_n_basic_set(SuccInvalidDomain);
2444 SuccStmt->setInvalidDomain(SuccInvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002445
Michael Krusebc150122016-05-02 12:25:18 +00002446 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002447 // In case this happens we will bail.
Michael Krusebc150122016-05-02 12:25:18 +00002448 if (NumConjucts < MaxDisjunctionsInDomain)
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002449 continue;
2450
Johannes Doerferta3519512016-04-23 13:02:23 +00002451 isl_set_free(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002452 invalidate(COMPLEXITY, TI->getDebugLoc());
Johannes Doerfert297c7202016-05-10 13:06:42 +00002453 return false;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002454 }
Johannes Doerferta3519512016-04-23 13:02:23 +00002455
2456 Stmt->setInvalidDomain(InvalidDomain);
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002457 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002458
2459 return true;
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00002460}
2461
Johannes Doerfert642594a2016-04-04 07:57:39 +00002462void Scop::propagateDomainConstraintsToRegionExit(
2463 BasicBlock *BB, Loop *BBLoop,
2464 SmallPtrSetImpl<BasicBlock *> &FinishedExitBlocks, ScopDetection &SD,
2465 LoopInfo &LI) {
2466
2467 // Check if the block @p BB is the entry of a region. If so we propagate it's
2468 // domain to the exit block of the region. Otherwise we are done.
2469 auto *RI = R.getRegionInfo();
2470 auto *BBReg = RI ? RI->getRegionFor(BB) : nullptr;
2471 auto *ExitBB = BBReg ? BBReg->getExit() : nullptr;
2472 if (!BBReg || BBReg->getEntry() != BB || !R.contains(ExitBB))
2473 return;
2474
2475 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2476 // Do not propagate the domain if there is a loop backedge inside the region
2477 // that would prevent the exit block from beeing executed.
2478 auto *L = BBLoop;
2479 while (L && R.contains(L)) {
2480 SmallVector<BasicBlock *, 4> LatchBBs;
2481 BBLoop->getLoopLatches(LatchBBs);
2482 for (auto *LatchBB : LatchBBs)
2483 if (BB != LatchBB && BBReg->contains(LatchBB))
2484 return;
2485 L = L->getParentLoop();
2486 }
2487
2488 auto *Domain = DomainMap[BB];
2489 assert(Domain && "Cannot propagate a nullptr");
2490
2491 auto *ExitBBLoop = getFirstNonBoxedLoopFor(ExitBB, LI, BoxedLoops);
2492
2493 // Since the dimensions of @p BB and @p ExitBB might be different we have to
2494 // adjust the domain before we can propagate it.
2495 auto *AdjustedDomain =
2496 adjustDomainDimensions(*this, isl_set_copy(Domain), BBLoop, ExitBBLoop);
2497 auto *&ExitDomain = DomainMap[ExitBB];
2498
2499 // If the exit domain is not yet created we set it otherwise we "add" the
2500 // current domain.
2501 ExitDomain =
2502 ExitDomain ? isl_set_union(AdjustedDomain, ExitDomain) : AdjustedDomain;
2503
Johannes Doerferta3519512016-04-23 13:02:23 +00002504 // Initialize the invalid domain.
2505 auto *ExitStmt = getStmtFor(ExitBB);
2506 ExitStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(ExitDomain)));
2507
Johannes Doerfert642594a2016-04-04 07:57:39 +00002508 FinishedExitBlocks.insert(ExitBB);
2509}
2510
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002511bool Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002512 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002513 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002514
2515 // To create the domain for each block in R we iterate over all blocks and
2516 // subregions in R and propagate the conditions under which the current region
2517 // element is executed. To this end we iterate in reverse post order over R as
2518 // it ensures that we first visit all predecessors of a region node (either a
2519 // basic block or a subregion) before we visit the region node itself.
2520 // Initially, only the domain for the SCoP region entry block is set and from
2521 // there we propagate the current domain to all successors, however we add the
2522 // condition that the successor is actually executed next.
2523 // As we are only interested in non-loop carried constraints here we can
2524 // simply skip loop back edges.
2525
Johannes Doerfert642594a2016-04-04 07:57:39 +00002526 SmallPtrSet<BasicBlock *, 8> FinishedExitBlocks;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002527 ReversePostOrderTraversal<Region *> RTraversal(R);
2528 for (auto *RN : RTraversal) {
2529
2530 // Recurse for affine subregions but go on for basic blocks and non-affine
2531 // subregions.
2532 if (RN->isSubRegion()) {
2533 Region *SubRegion = RN->getNodeAs<Region>();
2534 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002535 if (!buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI))
2536 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002537 continue;
2538 }
2539 }
2540
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002541 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002542 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002543
Johannes Doerfert96425c22015-08-30 21:13:53 +00002544 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002545 TerminatorInst *TI = BB->getTerminator();
2546
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002547 if (isa<UnreachableInst>(TI))
2548 continue;
2549
Johannes Doerfertf5673802015-10-01 23:48:18 +00002550 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002551 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002552 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002553
Johannes Doerfert642594a2016-04-04 07:57:39 +00002554 auto *BBLoop = getRegionNodeLoop(RN, LI);
2555 // Propagate the domain from BB directly to blocks that have a superset
2556 // domain, at the moment only region exit nodes of regions that start in BB.
2557 propagateDomainConstraintsToRegionExit(BB, BBLoop, FinishedExitBlocks, SD,
2558 LI);
2559
2560 // If all successors of BB have been set a domain through the propagation
2561 // above we do not need to build condition sets but can just skip this
2562 // block. However, it is important to note that this is a local property
2563 // with regards to the region @p R. To this end FinishedExitBlocks is a
2564 // local variable.
2565 auto IsFinishedRegionExit = [&FinishedExitBlocks](BasicBlock *SuccBB) {
2566 return FinishedExitBlocks.count(SuccBB);
2567 };
2568 if (std::all_of(succ_begin(BB), succ_end(BB), IsFinishedRegionExit))
2569 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002570
2571 // Build the condition sets for the successor nodes of the current region
2572 // node. If it is a non-affine subregion we will always execute the single
2573 // exit node, hence the single entry node domain is the condition set. For
2574 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002575 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002576 if (RN->isSubRegion())
2577 ConditionSets.push_back(isl_set_copy(Domain));
Johannes Doerfert297c7202016-05-10 13:06:42 +00002578 else if (!buildConditionSets(*getStmtFor(BB), TI, BBLoop, Domain,
2579 ConditionSets))
2580 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002581
2582 // Now iterate over the successors and set their initial domain based on
2583 // their condition set. We skip back edges here and have to be careful when
2584 // we leave a loop not to keep constraints over a dimension that doesn't
2585 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002586 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002587 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002588 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002589 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002590
Johannes Doerfert535de032016-04-19 14:49:05 +00002591 auto *SuccStmt = getStmtFor(SuccBB);
2592 // Skip blocks outside the region.
2593 if (!SuccStmt) {
2594 isl_set_free(CondSet);
2595 continue;
2596 }
2597
Johannes Doerfert642594a2016-04-04 07:57:39 +00002598 // If we propagate the domain of some block to "SuccBB" we do not have to
2599 // adjust the domain.
2600 if (FinishedExitBlocks.count(SuccBB)) {
2601 isl_set_free(CondSet);
2602 continue;
2603 }
2604
Johannes Doerfert96425c22015-08-30 21:13:53 +00002605 // Skip back edges.
2606 if (DT.dominates(SuccBB, BB)) {
2607 isl_set_free(CondSet);
2608 continue;
2609 }
2610
Johannes Doerfert29cb0672016-03-29 20:32:43 +00002611 auto *SuccBBLoop = getFirstNonBoxedLoopFor(SuccBB, LI, BoxedLoops);
Johannes Doerferta07f0ac2016-04-04 07:50:40 +00002612 CondSet = adjustDomainDimensions(*this, CondSet, BBLoop, SuccBBLoop);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002613
2614 // Set the domain for the successor or merge it with an existing domain in
2615 // case there are multiple paths (without loop back edges) to the
2616 // successor block.
2617 isl_set *&SuccDomain = DomainMap[SuccBB];
Tobias Grosser5a8c0522016-03-22 22:05:32 +00002618
Johannes Doerferta3519512016-04-23 13:02:23 +00002619 if (SuccDomain) {
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002620 SuccDomain = isl_set_coalesce(isl_set_union(SuccDomain, CondSet));
Johannes Doerferta3519512016-04-23 13:02:23 +00002621 } else {
2622 // Initialize the invalid domain.
2623 SuccStmt->setInvalidDomain(isl_set_empty(isl_set_get_space(CondSet)));
2624 SuccDomain = CondSet;
2625 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002626
Michael Krusebc150122016-05-02 12:25:18 +00002627 // Check if the maximal number of domain disjunctions was reached.
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002628 // In case this happens we will clean up and bail.
Michael Krusebc150122016-05-02 12:25:18 +00002629 if (isl_set_n_basic_set(SuccDomain) < MaxDisjunctionsInDomain)
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002630 continue;
2631
2632 invalidate(COMPLEXITY, DebugLoc());
2633 while (++u < ConditionSets.size())
2634 isl_set_free(ConditionSets[u]);
2635 return false;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002636 }
2637 }
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00002638
2639 return true;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002640}
2641
Johannes Doerfert3c6a99b2016-04-09 21:55:23 +00002642__isl_give isl_set *Scop::getPredecessorDomainConstraints(BasicBlock *BB,
2643 isl_set *Domain,
2644 ScopDetection &SD,
2645 DominatorTree &DT,
2646 LoopInfo &LI) {
Johannes Doerfert642594a2016-04-04 07:57:39 +00002647 // If @p BB is the ScopEntry we are done
2648 if (R.getEntry() == BB)
2649 return isl_set_universe(isl_set_get_space(Domain));
2650
2651 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2652 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2653
2654 // The region info of this function.
2655 auto &RI = *R.getRegionInfo();
2656
2657 auto *BBLoop = getFirstNonBoxedLoopFor(BB, LI, BoxedLoops);
2658
2659 // A domain to collect all predecessor domains, thus all conditions under
2660 // which the block is executed. To this end we start with the empty domain.
2661 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2662
2663 // Set of regions of which the entry block domain has been propagated to BB.
2664 // all predecessors inside any of the regions can be skipped.
2665 SmallSet<Region *, 8> PropagatedRegions;
2666
2667 for (auto *PredBB : predecessors(BB)) {
2668 // Skip backedges.
2669 if (DT.dominates(BB, PredBB))
2670 continue;
2671
2672 // If the predecessor is in a region we used for propagation we can skip it.
2673 auto PredBBInRegion = [PredBB](Region *PR) { return PR->contains(PredBB); };
2674 if (std::any_of(PropagatedRegions.begin(), PropagatedRegions.end(),
2675 PredBBInRegion)) {
2676 continue;
2677 }
2678
2679 // Check if there is a valid region we can use for propagation, thus look
2680 // for a region that contains the predecessor and has @p BB as exit block.
2681 auto *PredR = RI.getRegionFor(PredBB);
2682 while (PredR->getExit() != BB && !PredR->contains(BB))
2683 PredR->getParent();
2684
2685 // If a valid region for propagation was found use the entry of that region
2686 // for propagation, otherwise the PredBB directly.
2687 if (PredR->getExit() == BB) {
2688 PredBB = PredR->getEntry();
2689 PropagatedRegions.insert(PredR);
2690 }
2691
Johannes Doerfert41cda152016-04-08 10:32:26 +00002692 auto *PredBBDom = getDomainConditions(PredBB);
Johannes Doerfert642594a2016-04-04 07:57:39 +00002693 auto *PredBBLoop = getFirstNonBoxedLoopFor(PredBB, LI, BoxedLoops);
2694 PredBBDom = adjustDomainDimensions(*this, PredBBDom, PredBBLoop, BBLoop);
2695
2696 PredDom = isl_set_union(PredDom, PredBBDom);
2697 }
2698
2699 return PredDom;
2700}
2701
Johannes Doerfert297c7202016-05-10 13:06:42 +00002702bool Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002703 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002704 // Iterate over the region R and propagate the domain constrains from the
2705 // predecessors to the current node. In contrast to the
2706 // buildDomainsWithBranchConstraints function, this one will pull the domain
2707 // information from the predecessors instead of pushing it to the successors.
2708 // Additionally, we assume the domains to be already present in the domain
2709 // map here. However, we iterate again in reverse post order so we know all
2710 // predecessors have been visited before a block or non-affine subregion is
2711 // visited.
2712
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002713 ReversePostOrderTraversal<Region *> RTraversal(R);
2714 for (auto *RN : RTraversal) {
2715
2716 // Recurse for affine subregions but go on for basic blocks and non-affine
2717 // subregions.
2718 if (RN->isSubRegion()) {
2719 Region *SubRegion = RN->getNodeAs<Region>();
2720 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Johannes Doerfert297c7202016-05-10 13:06:42 +00002721 if (!propagateDomainConstraints(SubRegion, SD, DT, LI))
2722 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002723 continue;
2724 }
2725 }
2726
2727 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002728 isl_set *&Domain = DomainMap[BB];
Johannes Doerferta49c5572016-04-05 16:18:53 +00002729 assert(Domain);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002730
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002731 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfert642594a2016-04-04 07:57:39 +00002732 auto *PredDom = getPredecessorDomainConstraints(BB, Domain, SD, DT, LI);
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002733 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert642594a2016-04-04 07:57:39 +00002734 Domain = isl_set_align_params(Domain, getParamSpace());
Tobias Grosser6deba4e2016-03-30 18:18:31 +00002735
Johannes Doerfert642594a2016-04-04 07:57:39 +00002736 Loop *BBLoop = getRegionNodeLoop(RN, LI);
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002737 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Johannes Doerfert297c7202016-05-10 13:06:42 +00002738 if (!addLoopBoundsToHeaderDomain(BBLoop, LI))
2739 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002740 }
Johannes Doerfert297c7202016-05-10 13:06:42 +00002741
2742 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002743}
2744
2745/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2746/// is incremented by one and all other dimensions are equal, e.g.,
2747/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2748/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2749static __isl_give isl_map *
2750createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2751 auto *MapSpace = isl_space_map_from_set(SetSpace);
2752 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2753 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2754 if (u != Dim)
2755 NextIterationMap =
2756 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2757 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2758 C = isl_constraint_set_constant_si(C, 1);
2759 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2760 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2761 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2762 return NextIterationMap;
2763}
2764
Johannes Doerfert297c7202016-05-10 13:06:42 +00002765bool Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002766 int LoopDepth = getRelativeLoopDepth(L);
2767 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002768
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002769 BasicBlock *HeaderBB = L->getHeader();
2770 assert(DomainMap.count(HeaderBB));
2771 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002772
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002773 isl_map *NextIterationMap =
2774 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002775
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002776 isl_set *UnionBackedgeCondition =
2777 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002778
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002779 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2780 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002781
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002782 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002783
2784 // If the latch is only reachable via error statements we skip it.
2785 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2786 if (!LatchBBDom)
2787 continue;
2788
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002789 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002790
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002791 TerminatorInst *TI = LatchBB->getTerminator();
2792 BranchInst *BI = dyn_cast<BranchInst>(TI);
2793 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002794 BackedgeCondition = isl_set_copy(LatchBBDom);
2795 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002796 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002797 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert297c7202016-05-10 13:06:42 +00002798 if (!buildConditionSets(*getStmtFor(LatchBB), TI, L, LatchBBDom,
2799 ConditionSets))
2800 return false;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002801
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002802 // Free the non back edge condition set as we do not need it.
2803 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002804
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002805 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002806 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002807
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002808 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2809 assert(LatchLoopDepth >= LoopDepth);
2810 BackedgeCondition =
2811 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2812 LatchLoopDepth - LoopDepth);
2813 UnionBackedgeCondition =
2814 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002815 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002816
2817 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2818 for (int i = 0; i < LoopDepth; i++)
2819 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2820
2821 isl_set *UnionBackedgeConditionComplement =
2822 isl_set_complement(UnionBackedgeCondition);
2823 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2824 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2825 UnionBackedgeConditionComplement =
2826 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2827 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2828 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2829
2830 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2831 HeaderBBDom = Parts.second;
2832
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002833 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2834 // the bounded assumptions to the context as they are already implied by the
2835 // <nsw> tag.
2836 if (Affinator.hasNSWAddRecForLoop(L)) {
2837 isl_set_free(Parts.first);
Johannes Doerfert297c7202016-05-10 13:06:42 +00002838 return true;
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002839 }
2840
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002841 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00002842 recordAssumption(INFINITELOOP, UnboundedCtx,
2843 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert297c7202016-05-10 13:06:42 +00002844 return true;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002845}
2846
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002847void Scop::buildAliasChecks(AliasAnalysis &AA) {
2848 if (!PollyUseRuntimeAliasChecks)
2849 return;
2850
2851 if (buildAliasGroups(AA))
2852 return;
2853
2854 // If a problem occurs while building the alias groups we need to delete
2855 // this SCoP and pretend it wasn't valid in the first place. To this end
2856 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002857 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002858
2859 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2860 << " could not be created as the number of parameters involved "
2861 "is too high. The SCoP will be "
2862 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2863 "the maximal number of parameters but be advised that the "
2864 "compile time might increase exponentially.\n\n");
2865}
2866
Johannes Doerfert9143d672014-09-27 11:02:39 +00002867bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002868 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002869 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002870 // for all memory accesses inside the SCoP.
2871 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002872 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002873 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002874 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002875 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002876 // if their access domains intersect, otherwise they are in different
2877 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002878 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002879 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002880 // and maximal accesses to each array of a group in read only and non
2881 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002882 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2883
2884 AliasSetTracker AST(AA);
2885
2886 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002887 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002888 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002889
2890 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002891 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002892 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2893 isl_set_free(StmtDomain);
2894 if (StmtDomainEmpty)
2895 continue;
2896
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002897 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002898 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002899 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002900 if (!MA->isRead())
2901 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002902 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00002903 if (MA->isRead() && isa<MemTransferInst>(Acc))
2904 PtrToAcc[cast<MemTransferInst>(Acc)->getSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00002905 else
2906 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002907 AST.add(Acc);
2908 }
2909 }
2910
2911 SmallVector<AliasGroupTy, 4> AliasGroups;
2912 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002913 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002914 continue;
2915 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002916 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002917 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002918 if (AG.size() < 2)
2919 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002920 AliasGroups.push_back(std::move(AG));
2921 }
2922
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002923 // Split the alias groups based on their domain.
2924 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2925 AliasGroupTy NewAG;
2926 AliasGroupTy &AG = AliasGroups[u];
2927 AliasGroupTy::iterator AGI = AG.begin();
2928 isl_set *AGDomain = getAccessDomain(*AGI);
2929 while (AGI != AG.end()) {
2930 MemoryAccess *MA = *AGI;
2931 isl_set *MADomain = getAccessDomain(MA);
2932 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2933 NewAG.push_back(MA);
2934 AGI = AG.erase(AGI);
2935 isl_set_free(MADomain);
2936 } else {
2937 AGDomain = isl_set_union(AGDomain, MADomain);
2938 AGI++;
2939 }
2940 }
2941 if (NewAG.size() > 1)
2942 AliasGroups.push_back(std::move(NewAG));
2943 isl_set_free(AGDomain);
2944 }
2945
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002946 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002947 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002948 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2949 for (AliasGroupTy &AG : AliasGroups) {
2950 NonReadOnlyBaseValues.clear();
2951 ReadOnlyPairs.clear();
2952
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002953 if (AG.size() < 2) {
2954 AG.clear();
2955 continue;
2956 }
2957
Johannes Doerfert13771732014-10-01 12:40:46 +00002958 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002959 emitOptimizationRemarkAnalysis(
2960 F.getContext(), DEBUG_TYPE, F,
2961 (*II)->getAccessInstruction()->getDebugLoc(),
2962 "Possibly aliasing pointer, use restrict keyword.");
2963
Johannes Doerfert13771732014-10-01 12:40:46 +00002964 Value *BaseAddr = (*II)->getBaseAddr();
2965 if (HasWriteAccess.count(BaseAddr)) {
2966 NonReadOnlyBaseValues.insert(BaseAddr);
2967 II++;
2968 } else {
2969 ReadOnlyPairs[BaseAddr].insert(*II);
2970 II = AG.erase(II);
2971 }
2972 }
2973
2974 // If we don't have read only pointers check if there are at least two
2975 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002976 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002977 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002978 continue;
2979 }
2980
2981 // If we don't have non read only pointers clear the alias group.
2982 if (NonReadOnlyBaseValues.empty()) {
2983 AG.clear();
2984 continue;
2985 }
2986
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002987 // Check if we have non-affine accesses left, if so bail out as we cannot
2988 // generate a good access range yet.
2989 for (auto *MA : AG)
2990 if (!MA->isAffine()) {
2991 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2992 return false;
2993 }
2994 for (auto &ReadOnlyPair : ReadOnlyPairs)
2995 for (auto *MA : ReadOnlyPair.second)
2996 if (!MA->isAffine()) {
2997 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2998 return false;
2999 }
3000
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003001 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003002 MinMaxAliasGroups.emplace_back();
3003 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
3004 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
3005 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
3006 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00003007
3008 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003009
3010 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00003011 for (MemoryAccess *MA : AG)
3012 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00003013
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00003014 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
3015 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003016
3017 // Bail out if the number of values we need to compare is too large.
3018 // This is important as the number of comparisions grows quadratically with
3019 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003020 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
3021 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003022 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003023
3024 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003025 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003026 Accesses = isl_union_map_empty(getParamSpace());
3027
3028 for (const auto &ReadOnlyPair : ReadOnlyPairs)
3029 for (MemoryAccess *MA : ReadOnlyPair.second)
3030 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
3031
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00003032 Valid =
3033 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00003034
3035 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003036 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003037 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00003038
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00003039 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00003040}
3041
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003042/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003043static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003044 // Start with the smallest loop containing the entry and expand that
3045 // loop until it contains all blocks in the region. If there is a loop
3046 // containing all blocks in the region check if it is itself contained
3047 // and if so take the parent loop as it will be the smallest containing
3048 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003049 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00003050 while (L) {
3051 bool AllContained = true;
3052 for (auto *BB : R.blocks())
3053 AllContained &= L->contains(BB);
3054 if (AllContained)
3055 break;
3056 L = L->getParentLoop();
3057 }
3058
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003059 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
3060}
3061
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003062static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
3063 ScopDetection &SD) {
3064
3065 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
3066
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003067 unsigned MinLD = INT_MAX, MaxLD = 0;
3068 for (BasicBlock *BB : R.blocks()) {
3069 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00003070 if (!R.contains(L))
3071 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00003072 if (BoxedLoops && BoxedLoops->count(L))
3073 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00003074 unsigned LD = L->getLoopDepth();
3075 MinLD = std::min(MinLD, LD);
3076 MaxLD = std::max(MaxLD, LD);
3077 }
3078 }
3079
3080 // Handle the case that there is no loop in the SCoP first.
3081 if (MaxLD == 0)
3082 return 1;
3083
3084 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
3085 assert(MaxLD >= MinLD &&
3086 "Maximal loop depth was smaller than mininaml loop depth?");
3087 return MaxLD - MinLD + 1;
3088}
3089
Michael Kruse09eb4452016-03-03 22:10:47 +00003090Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
3091 unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00003092 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003093 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003094 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
3095 Context(nullptr), Affinator(this, LI), AssumedContext(nullptr),
3096 InvalidContext(nullptr), Schedule(nullptr) {
Tobias Grosser2937b592016-04-29 11:43:20 +00003097 if (IslOnErrorAbort)
3098 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00003099 buildContext();
3100}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003101
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00003102void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003103 DominatorTree &DT, LoopInfo &LI) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003104 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003105
Johannes Doerfert5fb9b212016-03-29 20:02:05 +00003106 if (!buildDomains(&R, SD, DT, LI))
3107 return;
Johannes Doerfert96425c22015-08-30 21:13:53 +00003108
Johannes Doerfertff68f462016-04-19 14:49:42 +00003109 addUserAssumptions(AC, DT, LI);
3110
Johannes Doerfert26404542016-05-10 12:19:47 +00003111 // Remove empty statements.
Michael Kruseafe06702015-10-02 16:33:27 +00003112 // Exit early in case there are no executable statements left in this scop.
Johannes Doerfert26404542016-05-10 12:19:47 +00003113 simplifySCoP(false, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00003114 if (Stmts.empty())
3115 return;
Tobias Grosser75805372011-04-29 06:27:02 +00003116
Michael Krusecac948e2015-10-02 13:53:07 +00003117 // The ScopStmts now have enough information to initialize themselves.
3118 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003119 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00003120
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003121 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003122
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003123 if (!hasFeasibleRuntimeContext())
Tobias Grosser8286b832015-11-02 11:29:32 +00003124 return;
3125
3126 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00003127 realignParams();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00003128 addUserContext();
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003129
3130 // After the context was fully constructed, thus all our knowledge about
3131 // the parameters is in there, we add all recorded assumptions to the
3132 // assumed/invalid context.
3133 addRecordedAssumptions();
3134
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003135 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00003136 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003137
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003138 hoistInvariantLoads(SD);
Tobias Grosser0865e7752016-02-29 07:29:42 +00003139 verifyInvariantLoads(SD);
Johannes Doerfert26404542016-05-10 12:19:47 +00003140 simplifySCoP(true, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00003141}
3142
3143Scop::~Scop() {
3144 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00003145 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003146 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00003147 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003148
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003149 for (auto &It : ParameterIds)
3150 isl_id_free(It.second);
3151
Johannes Doerfert96425c22015-08-30 21:13:53 +00003152 for (auto It : DomainMap)
3153 isl_set_free(It.second);
3154
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003155 for (auto &AS : RecordedAssumptions)
3156 isl_set_free(AS.Set);
3157
Johannes Doerfertb164c792014-09-18 11:17:17 +00003158 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003159 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003160 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00003161 isl_pw_multi_aff_free(MMA.first);
3162 isl_pw_multi_aff_free(MMA.second);
3163 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003164 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003165 isl_pw_multi_aff_free(MMA.first);
3166 isl_pw_multi_aff_free(MMA.second);
3167 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003168 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003169
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003170 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003171 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003172
3173 // Explicitly release all Scop objects and the underlying isl objects before
3174 // we relase the isl context.
3175 Stmts.clear();
3176 ScopArrayInfoMap.clear();
3177 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00003178}
3179
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003180void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00003181 // Check all array accesses for each base pointer and find a (virtual) element
3182 // size for the base pointer that divides all access functions.
3183 for (auto &Stmt : *this)
3184 for (auto *Access : Stmt) {
3185 if (!Access->isArrayKind())
3186 continue;
3187 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
3188 ScopArrayInfo::MK_Array)];
3189 if (SAI->getNumberOfDimensions() != 1)
3190 continue;
3191 unsigned DivisibleSize = SAI->getElemSizeInBytes();
3192 auto *Subscript = Access->getSubscript(0);
3193 while (!isDivisible(Subscript, DivisibleSize, *SE))
3194 DivisibleSize /= 2;
3195 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
3196 SAI->updateElementType(Ty);
3197 }
3198
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003199 for (auto &Stmt : *this)
3200 for (auto &Access : Stmt)
3201 Access->updateDimensionality();
3202}
3203
Johannes Doerfert26404542016-05-10 12:19:47 +00003204void Scop::simplifySCoP(bool AfterHoisting, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003205 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
3206 ScopStmt &Stmt = *StmtIt;
3207
Johannes Doerfert26404542016-05-10 12:19:47 +00003208 bool RemoveStmt = Stmt.isEmpty();
Johannes Doerferteca9e892015-11-03 16:54:49 +00003209 if (!RemoveStmt)
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00003210 RemoveStmt = !DomainMap[Stmt.getEntryBlock()];
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00003211
Johannes Doerferteca9e892015-11-03 16:54:49 +00003212 // Remove read only statements only after invariant loop hoisting.
Johannes Doerfert26404542016-05-10 12:19:47 +00003213 if (!RemoveStmt && AfterHoisting) {
Johannes Doerferteca9e892015-11-03 16:54:49 +00003214 bool OnlyRead = true;
3215 for (MemoryAccess *MA : Stmt) {
3216 if (MA->isRead())
3217 continue;
3218
3219 OnlyRead = false;
3220 break;
3221 }
3222
3223 RemoveStmt = OnlyRead;
3224 }
3225
Johannes Doerfert26404542016-05-10 12:19:47 +00003226 if (!RemoveStmt) {
3227 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003228 continue;
3229 }
3230
Johannes Doerfert26404542016-05-10 12:19:47 +00003231 // Remove the statement because it is unnecessary.
3232 if (Stmt.isRegionStmt())
3233 for (BasicBlock *BB : Stmt.getRegion()->blocks())
3234 StmtMap.erase(BB);
3235 else
3236 StmtMap.erase(Stmt.getBasicBlock());
3237
3238 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003239 }
3240}
3241
Johannes Doerfert8ab28032016-04-27 12:49:11 +00003242InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003243 LoadInst *LInst = dyn_cast<LoadInst>(Val);
3244 if (!LInst)
3245 return nullptr;
3246
3247 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
3248 LInst = cast<LoadInst>(Rep);
3249
Johannes Doerfert96e54712016-02-07 17:30:13 +00003250 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003251 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
Johannes Doerfert549768c2016-03-24 13:22:16 +00003252 for (auto &IAClass : InvariantEquivClasses) {
3253 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
3254 continue;
3255
3256 auto &MAs = std::get<1>(IAClass);
3257 for (auto *MA : MAs)
3258 if (MA->getAccessInstruction() == Val)
3259 return &IAClass;
3260 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003261
3262 return nullptr;
3263}
3264
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003265/// @brief Check if @p MA can always be hoisted without execution context.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003266static bool canAlwaysBeHoisted(MemoryAccess *MA, bool StmtInvalidCtxIsEmpty,
3267 bool MAInvalidCtxIsEmpty) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003268 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
3269 const DataLayout &DL = LInst->getParent()->getModule()->getDataLayout();
3270 // TODO: We can provide more information for better but more expensive
3271 // results.
3272 if (!isDereferenceableAndAlignedPointer(LInst->getPointerOperand(),
3273 LInst->getAlignment(), DL))
3274 return false;
3275
3276 // If a dereferencable load is in a statement that is modeled precisely we can
3277 // hoist it.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003278 if (StmtInvalidCtxIsEmpty && MAInvalidCtxIsEmpty)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003279 return true;
3280
3281 // Even if the statement is not modeled precisely we can hoist the load if it
3282 // does not involve any parameters that might have been specilized by the
3283 // statement domain.
3284 for (unsigned u = 0, e = MA->getNumSubscripts(); u < e; u++)
3285 if (!isa<SCEVConstant>(MA->getSubscript(u)))
3286 return false;
3287 return true;
3288}
3289
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003290void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
3291
Johannes Doerfert5d03f842016-04-22 11:38:44 +00003292 if (InvMAs.empty())
3293 return;
3294
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003295 auto *StmtInvalidCtx = Stmt.getInvalidContext();
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003296 bool StmtInvalidCtxIsEmpty = isl_set_is_empty(StmtInvalidCtx);
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003297
Johannes Doerfert3ef78d62016-04-08 10:30:09 +00003298 // Get the context under which the statement is executed but remove the error
3299 // context under which this statement is reached.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003300 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003301 DomainCtx = isl_set_subtract(DomainCtx, StmtInvalidCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003302
Michael Krusebc150122016-05-02 12:25:18 +00003303 if (isl_set_n_basic_set(DomainCtx) >= MaxDisjunctionsInDomain) {
Johannes Doerfertd77089e2016-04-22 11:41:14 +00003304 auto *AccInst = InvMAs.front()->getAccessInstruction();
3305 invalidate(COMPLEXITY, AccInst->getDebugLoc());
3306 isl_set_free(DomainCtx);
3307 return;
3308 }
3309
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003310 // Project out all parameters that relate to loads in the statement. Otherwise
3311 // we could have cyclic dependences on the constraints under which the
3312 // hoisted loads are executed and we could not determine an order in which to
3313 // pre-load them. This happens because not only lower bounds are part of the
3314 // domain but also upper bounds.
3315 for (MemoryAccess *MA : InvMAs) {
3316 Instruction *AccInst = MA->getAccessInstruction();
3317 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00003318 SetVector<Value *> Values;
3319 for (const SCEV *Parameter : Parameters) {
3320 Values.clear();
Johannes Doerfert7b811032016-04-08 10:25:58 +00003321 findValues(Parameter, *SE, Values);
Johannes Doerfert44483c52015-11-07 19:45:27 +00003322 if (!Values.count(AccInst))
3323 continue;
3324
3325 if (isl_id *ParamId = getIdForParam(Parameter)) {
3326 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
3327 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
3328 isl_id_free(ParamId);
3329 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003330 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003331 }
3332 }
3333
3334 for (MemoryAccess *MA : InvMAs) {
3335 // Check for another invariant access that accesses the same location as
3336 // MA and if found consolidate them. Otherwise create a new equivalence
3337 // class at the end of InvariantEquivClasses.
3338 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00003339 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003340 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
3341
Johannes Doerfert85676e32016-04-23 14:32:34 +00003342 auto *MAInvalidCtx = MA->getInvalidContext();
3343 bool MAInvalidCtxIsEmpty = isl_set_is_empty(MAInvalidCtx);
3344
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003345 isl_set *MACtx;
3346 // Check if we know that this pointer can be speculatively accessed.
Johannes Doerfert85676e32016-04-23 14:32:34 +00003347 if (canAlwaysBeHoisted(MA, StmtInvalidCtxIsEmpty, MAInvalidCtxIsEmpty)) {
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003348 MACtx = isl_set_universe(isl_set_get_space(DomainCtx));
Johannes Doerfert85676e32016-04-23 14:32:34 +00003349 isl_set_free(MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003350 } else {
3351 MACtx = isl_set_copy(DomainCtx);
Johannes Doerfert85676e32016-04-23 14:32:34 +00003352 MACtx = isl_set_subtract(MACtx, MAInvalidCtx);
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003353 MACtx = isl_set_gist_params(MACtx, getContext());
3354 }
3355
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003356 bool Consolidated = false;
3357 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00003358 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003359 continue;
3360
Johannes Doerfertdf880232016-03-03 12:26:58 +00003361 // If the pointer and the type is equal check if the access function wrt.
3362 // to the domain is equal too. It can happen that the domain fixes
3363 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00003364 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00003365 // create a new invariant load equivalence class.
3366 auto &MAs = std::get<1>(IAClass);
3367 if (!MAs.empty()) {
3368 auto *LastMA = MAs.front();
3369
3370 auto *AR = isl_map_range(MA->getAccessRelation());
3371 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
3372 bool SameAR = isl_set_is_equal(AR, LastAR);
3373 isl_set_free(AR);
3374 isl_set_free(LastAR);
3375
3376 if (!SameAR)
3377 continue;
3378 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003379
3380 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003381 MAs.push_front(MA);
3382
Johannes Doerfertdf880232016-03-03 12:26:58 +00003383 Consolidated = true;
3384
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003385 // Unify the execution context of the class and this statement.
3386 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003387 if (IAClassDomainCtx)
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003388 IAClassDomainCtx =
3389 isl_set_coalesce(isl_set_union(IAClassDomainCtx, MACtx));
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003390 else
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003391 IAClassDomainCtx = MACtx;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003392 break;
3393 }
3394
3395 if (Consolidated)
3396 continue;
3397
3398 // If we did not consolidate MA, thus did not find an equivalence class
3399 // for it, we create a new one.
Johannes Doerfert1dc12af2016-04-23 12:59:18 +00003400 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA}, MACtx,
3401 Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003402 }
3403
3404 isl_set_free(DomainCtx);
3405}
3406
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003407bool Scop::isHoistableAccess(MemoryAccess *Access,
3408 __isl_keep isl_union_map *Writes) {
3409 // TODO: Loads that are not loop carried, hence are in a statement with
3410 // zero iterators, are by construction invariant, though we
3411 // currently "hoist" them anyway. This is necessary because we allow
3412 // them to be treated as parameters (e.g., in conditions) and our code
3413 // generation would otherwise use the old value.
3414
3415 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003416 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003417
3418 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3419 return false;
3420
3421 // Skip accesses that have an invariant base pointer which is defined but
3422 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3423 // returns a pointer that is used as a base address. However, as we want
3424 // to hoist indirect pointers, we allow the base pointer to be defined in
3425 // the region if it is also a memory access. Each ScopArrayInfo object
3426 // that has a base pointer origin has a base pointer that is loaded and
3427 // that it is invariant, thus it will be hoisted too. However, if there is
3428 // no base pointer origin we check that the base pointer is defined
3429 // outside the region.
3430 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003431 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3432 if (SAI->getBasePtrOriginSAI()) {
3433 assert(BasePtrInst && R.contains(BasePtrInst));
3434 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003435 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003436 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003437 assert(BasePtrStmt);
3438 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3439 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3440 return false;
3441 } else if (BasePtrInst && R.contains(BasePtrInst))
3442 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003443
3444 // Skip accesses in non-affine subregions as they might not be executed
3445 // under the same condition as the entry of the non-affine subregion.
3446 if (BB != Access->getAccessInstruction()->getParent())
3447 return false;
3448
3449 isl_map *AccessRelation = Access->getAccessRelation();
Johannes Doerfert2b470e82016-03-24 13:19:16 +00003450 assert(!isl_map_is_empty(AccessRelation));
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003451
3452 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3453 Stmt.getNumIterators())) {
3454 isl_map_free(AccessRelation);
3455 return false;
3456 }
3457
3458 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3459 isl_set *AccessRange = isl_map_range(AccessRelation);
3460
3461 isl_union_map *Written = isl_union_map_intersect_range(
3462 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3463 bool IsWritten = !isl_union_map_is_empty(Written);
3464 isl_union_map_free(Written);
3465
3466 if (IsWritten)
3467 return false;
3468
3469 return true;
3470}
3471
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003472void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003473 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3474 for (LoadInst *LI : RIL) {
3475 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003476 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003477 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003478 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3479 return;
3480 }
3481 }
3482}
3483
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003484void Scop::hoistInvariantLoads(ScopDetection &SD) {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003485 if (!PollyInvariantLoadHoisting)
3486 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003487
Tobias Grosser0865e7752016-02-29 07:29:42 +00003488 isl_union_map *Writes = getWrites();
3489 for (ScopStmt &Stmt : *this) {
3490 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003491
Tobias Grosser0865e7752016-02-29 07:29:42 +00003492 for (MemoryAccess *Access : Stmt)
3493 if (isHoistableAccess(Access, Writes))
3494 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003495
Tobias Grosser0865e7752016-02-29 07:29:42 +00003496 // We inserted invariant accesses always in the front but need them to be
3497 // sorted in a "natural order". The statements are already sorted in
3498 // reverse post order and that suffices for the accesses too. The reason
3499 // we require an order in the first place is the dependences between
3500 // invariant loads that can be caused by indirect loads.
3501 InvariantAccesses.reverse();
3502
3503 // Transfer the memory access from the statement to the SCoP.
3504 Stmt.removeMemoryAccesses(InvariantAccesses);
3505 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003506 }
Tobias Grosser0865e7752016-02-29 07:29:42 +00003507 isl_union_map_free(Writes);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003508}
3509
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003510const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003511Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003512 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003513 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003514 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003515 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003516 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003517 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003518 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003519 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003520 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003521 // In case of mismatching array sizes, we bail out by setting the run-time
3522 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003523 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003524 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003525 }
Tobias Grosserab671442015-05-23 05:58:27 +00003526 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003527}
3528
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003529const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003530 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003531 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003532 assert(SAI && "No ScopArrayInfo available for this base pointer");
3533 return SAI;
3534}
3535
Tobias Grosser74394f02013-01-14 22:40:23 +00003536std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003537
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003538std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003539 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003540 return stringFromIslObj(AssumedContext);
3541}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003542
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003543std::string Scop::getInvalidContextStr() const {
3544 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003545}
Tobias Grosser75805372011-04-29 06:27:02 +00003546
3547std::string Scop::getNameStr() const {
3548 std::string ExitName, EntryName;
3549 raw_string_ostream ExitStr(ExitName);
3550 raw_string_ostream EntryStr(EntryName);
3551
Tobias Grosserf240b482014-01-09 10:42:15 +00003552 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003553 EntryStr.str();
3554
3555 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003556 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003557 ExitStr.str();
3558 } else
3559 ExitName = "FunctionExit";
3560
3561 return EntryName + "---" + ExitName;
3562}
3563
Tobias Grosser74394f02013-01-14 22:40:23 +00003564__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003565__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003566 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003567}
3568
Tobias Grossere86109f2013-10-29 21:05:49 +00003569__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003570 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00003571 return isl_set_copy(AssumedContext);
3572}
3573
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003574bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003575 auto *PositiveContext = getAssumedContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003576 auto *NegativeContext = getInvalidContext();
Johannes Doerfert94341c92016-04-23 13:00:27 +00003577 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
3578 bool IsFeasible = !(isl_set_is_empty(PositiveContext) ||
3579 isl_set_is_subset(PositiveContext, NegativeContext));
3580 isl_set_free(PositiveContext);
3581 if (!IsFeasible) {
3582 isl_set_free(NegativeContext);
3583 return false;
3584 }
3585
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003586 auto *DomainContext = isl_union_set_params(getDomains());
3587 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
Johannes Doerfertfb721872016-04-12 17:54:29 +00003588 IsFeasible &= !isl_set_is_subset(Context, NegativeContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003589 isl_set_free(NegativeContext);
3590 isl_set_free(DomainContext);
3591
Johannes Doerfert43788c52015-08-20 05:58:56 +00003592 return IsFeasible;
3593}
3594
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003595static std::string toString(AssumptionKind Kind) {
3596 switch (Kind) {
3597 case ALIASING:
3598 return "No-aliasing";
3599 case INBOUNDS:
3600 return "Inbounds";
3601 case WRAPPING:
3602 return "No-overflows";
Johannes Doerfertc3596282016-04-25 14:01:36 +00003603 case UNSIGNED:
3604 return "Signed-unsigned";
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003605 case COMPLEXITY:
3606 return "Low complexity";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003607 case ERRORBLOCK:
3608 return "No-error";
3609 case INFINITELOOP:
3610 return "Finite loop";
3611 case INVARIANTLOAD:
3612 return "Invariant load";
3613 case DELINEARIZATION:
3614 return "Delinearization";
3615 }
3616 llvm_unreachable("Unknown AssumptionKind!");
3617}
3618
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003619bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3620 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert2f705842016-04-12 16:09:44 +00003621 if (PollyRemarksMinimal) {
3622 if (Sign == AS_ASSUMPTION) {
3623 if (isl_set_is_subset(Context, Set))
3624 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003625
Johannes Doerfert2f705842016-04-12 16:09:44 +00003626 if (isl_set_is_subset(AssumedContext, Set))
3627 return false;
3628 } else {
3629 if (isl_set_is_disjoint(Set, Context))
3630 return false;
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003631
Johannes Doerfert2f705842016-04-12 16:09:44 +00003632 if (isl_set_is_subset(Set, InvalidContext))
3633 return false;
3634 }
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003635 }
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003636
3637 auto &F = *getRegion().getEntry()->getParent();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003638 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
3639 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003640 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003641 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003642}
3643
3644void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003645 DebugLoc Loc, AssumptionSign Sign) {
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003646 // Simplify the assumptions/restrictions first.
3647 Set = isl_set_gist_params(Set, getContext());
3648
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003649 if (!trackAssumption(Kind, Set, Loc, Sign)) {
3650 isl_set_free(Set);
3651 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003652 }
3653
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003654 if (Sign == AS_ASSUMPTION) {
3655 AssumedContext = isl_set_intersect(AssumedContext, Set);
3656 AssumedContext = isl_set_coalesce(AssumedContext);
3657 } else {
3658 InvalidContext = isl_set_union(InvalidContext, Set);
3659 InvalidContext = isl_set_coalesce(InvalidContext);
3660 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003661}
3662
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003663void Scop::recordAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003664 DebugLoc Loc, AssumptionSign Sign, BasicBlock *BB) {
3665 RecordedAssumptions.push_back({Kind, Sign, Set, Loc, BB});
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003666}
3667
3668void Scop::addRecordedAssumptions() {
3669 while (!RecordedAssumptions.empty()) {
3670 const Assumption &AS = RecordedAssumptions.pop_back_val();
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003671
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003672 if (!AS.BB) {
3673 addAssumption(AS.Kind, AS.Set, AS.Loc, AS.Sign);
3674 continue;
3675 }
Johannes Doerfert615e0b82016-04-12 13:28:39 +00003676
Johannes Doerfert14b1cf32016-05-10 12:42:26 +00003677 // If the domain was deleted the assumptions are void.
3678 isl_set *Dom = getDomainConditions(AS.BB);
3679 if (!Dom) {
3680 isl_set_free(AS.Set);
3681 continue;
3682 }
3683
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003684 // If a basic block was given use its domain to simplify the assumption.
3685 // In case of restrictions we know they only have to hold on the domain,
3686 // thus we can intersect them with the domain of the block. However, for
3687 // assumptions the domain has to imply them, thus:
3688 // _ _____
3689 // Dom => S <==> A v B <==> A - B
3690 //
3691 // To avoid the complement we will register A - B as a restricton not an
3692 // assumption.
3693 isl_set *S = AS.Set;
Johannes Doerfert8475d1c2016-04-28 14:32:58 +00003694 if (AS.Sign == AS_RESTRICTION)
3695 S = isl_set_params(isl_set_intersect(S, Dom));
3696 else /* (AS.Sign == AS_ASSUMPTION) */
3697 S = isl_set_params(isl_set_subtract(Dom, S));
3698
3699 addAssumption(AS.Kind, S, AS.Loc, AS_RESTRICTION);
Johannes Doerfert3bf6e4122016-04-12 13:27:35 +00003700 }
3701}
3702
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003703void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003704 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003705}
3706
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003707__isl_give isl_set *Scop::getInvalidContext() const {
3708 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003709}
3710
Tobias Grosser75805372011-04-29 06:27:02 +00003711void Scop::printContext(raw_ostream &OS) const {
3712 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003713 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003714
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003715 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003716 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003717
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003718 OS.indent(4) << "Invalid Context:\n";
3719 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003720
Johannes Doerfert4e3bb7b2016-04-25 16:15:13 +00003721 unsigned Dim = 0;
3722 for (const SCEV *Parameter : Parameters)
3723 OS.indent(4) << "p" << Dim++ << ": " << *Parameter << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003724}
3725
Johannes Doerfertb164c792014-09-18 11:17:17 +00003726void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003727 int noOfGroups = 0;
3728 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003729 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003730 noOfGroups += 1;
3731 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003732 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003733 }
3734
Tobias Grosserbb853c22015-07-25 12:31:03 +00003735 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003736 if (MinMaxAliasGroups.empty()) {
3737 OS.indent(8) << "n/a\n";
3738 return;
3739 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003740
Tobias Grosserbb853c22015-07-25 12:31:03 +00003741 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003742
3743 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003744 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003745 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003746 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003747 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3748 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003749 }
3750 OS << " ]]\n";
3751 }
3752
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003753 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003754 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003755 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003756 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003757 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3758 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003759 }
3760 OS << " ]]\n";
3761 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003762 }
3763}
3764
Tobias Grosser75805372011-04-29 06:27:02 +00003765void Scop::printStatements(raw_ostream &OS) const {
3766 OS << "Statements {\n";
3767
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003768 for (const ScopStmt &Stmt : *this)
3769 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003770
3771 OS.indent(4) << "}\n";
3772}
3773
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003774void Scop::printArrayInfo(raw_ostream &OS) const {
3775 OS << "Arrays {\n";
3776
Tobias Grosserab671442015-05-23 05:58:27 +00003777 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003778 Array.second->print(OS);
3779
3780 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003781
3782 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3783
3784 for (auto &Array : arrays())
3785 Array.second->print(OS, /* SizeAsPwAff */ true);
3786
3787 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003788}
3789
Tobias Grosser75805372011-04-29 06:27:02 +00003790void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003791 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3792 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003793 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003794 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003795 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003796 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003797 const auto &MAs = std::get<1>(IAClass);
3798 if (MAs.empty()) {
3799 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003800 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003801 MAs.front()->print(OS);
3802 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003803 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003804 }
3805 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003806 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003807 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003808 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003809 printStatements(OS.indent(4));
3810}
3811
3812void Scop::dump() const { print(dbgs()); }
3813
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003814isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003815
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003816__isl_give PWACtx Scop::getPwAff(const SCEV *E, BasicBlock *BB,
3817 bool NonNegative) {
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003818 // First try to use the SCEVAffinator to generate a piecewise defined
3819 // affine function from @p E in the context of @p BB. If that tasks becomes to
3820 // complex the affinator might return a nullptr. In such a case we invalidate
3821 // the SCoP and return a dummy value. This way we do not need to add error
3822 // handling cdoe to all users of this function.
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003823 auto PWAC = Affinator.getPwAff(E, BB);
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003824 if (PWAC.first) {
Johannes Doerfert56b37762016-05-10 11:45:46 +00003825 // TODO: We could use a heuristic and either use:
3826 // SCEVAffinator::takeNonNegativeAssumption
3827 // or
3828 // SCEVAffinator::interpretAsUnsigned
3829 // to deal with unsigned or "NonNegative" SCEVs.
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003830 if (NonNegative)
3831 Affinator.takeNonNegativeAssumption(PWAC);
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003832 return PWAC;
Johannes Doerfert3e48ee22016-04-29 10:44:41 +00003833 }
Johannes Doerfert6462d8c2016-03-26 16:17:00 +00003834
3835 auto DL = BB ? BB->getTerminator()->getDebugLoc() : DebugLoc();
3836 invalidate(COMPLEXITY, DL);
3837 return Affinator.getPwAff(SE->getZero(E->getType()), BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003838}
3839
Tobias Grosser808cd692015-07-14 09:33:13 +00003840__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003841 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003842
Tobias Grosser808cd692015-07-14 09:33:13 +00003843 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003844 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003845
3846 return Domain;
3847}
3848
Johannes Doerfertac9c32e2016-04-23 14:31:17 +00003849__isl_give isl_pw_aff *Scop::getPwAffOnly(const SCEV *E, BasicBlock *BB) {
3850 PWACtx PWAC = getPwAff(E, BB);
3851 isl_set_free(PWAC.second);
3852 return PWAC.first;
3853}
3854
Tobias Grossere5a35142015-11-12 14:07:09 +00003855__isl_give isl_union_map *
3856Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3857 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003858
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003859 for (ScopStmt &Stmt : *this) {
3860 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003861 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003862 continue;
3863
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003864 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003865 isl_map *AccessDomain = MA->getAccessRelation();
3866 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003867 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003868 }
3869 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003870 return isl_union_map_coalesce(Accesses);
3871}
3872
3873__isl_give isl_union_map *Scop::getMustWrites() {
3874 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003875}
3876
3877__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003878 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003879}
3880
Tobias Grosser37eb4222014-02-20 21:43:54 +00003881__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003882 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003883}
3884
3885__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003886 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003887}
3888
Tobias Grosser2ac23382015-11-12 14:07:13 +00003889__isl_give isl_union_map *Scop::getAccesses() {
3890 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3891}
3892
Tobias Grosser808cd692015-07-14 09:33:13 +00003893__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003894 auto *Tree = getScheduleTree();
3895 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003896 isl_schedule_free(Tree);
3897 return S;
3898}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003899
Tobias Grosser808cd692015-07-14 09:33:13 +00003900__isl_give isl_schedule *Scop::getScheduleTree() const {
3901 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3902 getDomains());
3903}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003904
Tobias Grosser808cd692015-07-14 09:33:13 +00003905void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3906 auto *S = isl_schedule_from_domain(getDomains());
3907 S = isl_schedule_insert_partial_schedule(
3908 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3909 isl_schedule_free(Schedule);
3910 Schedule = S;
3911}
3912
3913void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3914 isl_schedule_free(Schedule);
3915 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003916}
3917
3918bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3919 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003920 for (ScopStmt &Stmt : *this) {
3921 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003922 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3923 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3924
3925 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3926 isl_union_set_free(StmtDomain);
3927 isl_union_set_free(NewStmtDomain);
3928 continue;
3929 }
3930
3931 Changed = true;
3932
3933 isl_union_set_free(StmtDomain);
3934 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3935
3936 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003937 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003938 isl_union_set_free(NewStmtDomain);
3939 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003940 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003941 }
3942 isl_union_set_free(Domain);
3943 return Changed;
3944}
3945
Tobias Grosser75805372011-04-29 06:27:02 +00003946ScalarEvolution *Scop::getSE() const { return SE; }
3947
Tobias Grosser808cd692015-07-14 09:33:13 +00003948struct MapToDimensionDataTy {
3949 int N;
3950 isl_union_pw_multi_aff *Res;
3951};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003952
Tobias Grosser808cd692015-07-14 09:33:13 +00003953// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003954// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003955//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003956// @param Set The input set.
3957// @param User->N The dimension to map to.
3958// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003959//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003960// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003961static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3962 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3963 int Dim;
3964 isl_space *Space;
3965 isl_pw_multi_aff *PMA;
3966
3967 Dim = isl_set_dim(Set, isl_dim_set);
3968 Space = isl_set_get_space(Set);
3969 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3970 Dim - Data->N);
3971 if (Data->N > 1)
3972 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3973 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3974
3975 isl_set_free(Set);
3976
3977 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003978}
3979
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003980// @brief Create an isl_multi_union_aff that defines an identity mapping
3981// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003982//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003983// # Example:
3984//
3985// Domain: { A[i,j]; B[i,j,k] }
3986// N: 1
3987//
3988// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3989//
3990// @param USet A union set describing the elements for which to generate a
3991// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003992// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003993// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003994static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003995mapToDimension(__isl_take isl_union_set *USet, int N) {
3996 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003997 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003998 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003999
Tobias Grosser808cd692015-07-14 09:33:13 +00004000 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00004001
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004002 auto *Space = isl_union_set_get_space(USet);
4003 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00004004
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004005 Data = {N, PwAff};
4006
4007 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00004008 (void)Res;
4009
Tobias Grossercbf7ae82015-12-21 22:45:53 +00004010 assert(Res == isl_stat_ok);
4011
4012 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00004013 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
4014}
4015
Tobias Grosser316b5b22015-11-11 19:28:14 +00004016void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00004017 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00004018 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004019 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004020 StmtMap[BB] = Stmt;
4021 } else {
4022 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00004023 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00004024 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00004025 for (BasicBlock *BB : R->blocks())
4026 StmtMap[BB] = Stmt;
4027 }
Tobias Grosser808cd692015-07-14 09:33:13 +00004028}
4029
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004030void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004031 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004032 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004033 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosser151ae322016-04-03 19:36:52 +00004034 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
4035 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00004036}
4037
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004038/// To generate a schedule for the elements in a Region we traverse the Region
4039/// in reverse-post-order and add the contained RegionNodes in traversal order
4040/// to the schedule of the loop that is currently at the top of the LoopStack.
4041/// For loop-free codes, this results in a correct sequential ordering.
4042///
4043/// Example:
4044/// bb1(0)
4045/// / \.
4046/// bb2(1) bb3(2)
4047/// \ / \.
4048/// bb4(3) bb5(4)
4049/// \ /
4050/// bb6(5)
4051///
4052/// Including loops requires additional processing. Whenever a loop header is
4053/// encountered, the corresponding loop is added to the @p LoopStack. Starting
4054/// from an empty schedule, we first process all RegionNodes that are within
4055/// this loop and complete the sequential schedule at this loop-level before
4056/// processing about any other nodes. To implement this
4057/// loop-nodes-first-processing, the reverse post-order traversal is
4058/// insufficient. Hence, we additionally check if the traversal yields
4059/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
4060/// These region-nodes are then queue and only traverse after the all nodes
4061/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004062void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
4063 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004064 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
4065
4066 ReversePostOrderTraversal<Region *> RTraversal(R);
4067 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
4068 std::deque<RegionNode *> DelayList;
4069 bool LastRNWaiting = false;
4070
4071 // Iterate over the region @p R in reverse post-order but queue
4072 // sub-regions/blocks iff they are not part of the last encountered but not
4073 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
4074 // that we queued the last sub-region/block from the reverse post-order
4075 // iterator. If it is set we have to explore the next sub-region/block from
4076 // the iterator (if any) to guarantee progress. If it is not set we first try
4077 // the next queued sub-region/blocks.
4078 while (!WorkList.empty() || !DelayList.empty()) {
4079 RegionNode *RN;
4080
4081 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
4082 RN = WorkList.front();
4083 WorkList.pop_front();
4084 LastRNWaiting = false;
4085 } else {
4086 RN = DelayList.front();
4087 DelayList.pop_front();
4088 }
4089
4090 Loop *L = getRegionNodeLoop(RN, LI);
4091 if (!getRegion().contains(L))
4092 L = OuterScopLoop;
4093
Tobias Grosser151ae322016-04-03 19:36:52 +00004094 Loop *LastLoop = LoopStack.back().L;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004095 if (LastLoop != L) {
Johannes Doerfertd5edbd62016-04-03 23:09:06 +00004096 if (LastLoop && !LastLoop->contains(L)) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004097 LastRNWaiting = true;
4098 DelayList.push_back(RN);
4099 continue;
4100 }
4101 LoopStack.push_back({L, nullptr, 0});
4102 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004103 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004104 }
4105
4106 return;
4107}
4108
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00004109void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004110 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00004111
Tobias Grosser8362c262016-01-06 15:30:06 +00004112 if (RN->isSubRegion()) {
4113 auto *LocalRegion = RN->getNodeAs<Region>();
4114 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004115 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00004116 return;
4117 }
4118 }
Michael Kruse046dde42015-08-10 13:01:57 +00004119
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004120 auto &LoopData = LoopStack.back();
4121 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00004122
Michael Kruse6f7721f2016-02-24 22:08:19 +00004123 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00004124 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
4125 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004126 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00004127 }
4128
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004129 // Check if we just processed the last node in this loop. If we did, finalize
4130 // the loop by:
4131 //
4132 // - adding new schedule dimensions
4133 // - folding the resulting schedule into the parent loop schedule
4134 // - dropping the loop schedule from the LoopStack.
4135 //
4136 // Then continue to check surrounding loops, which might also have been
4137 // completed by this node.
4138 while (LoopData.L &&
4139 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00004140 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004141 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00004142
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004143 LoopStack.pop_back();
4144 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00004145
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004146 if (Schedule) {
4147 auto *Domain = isl_schedule_get_domain(Schedule);
4148 auto *MUPA = mapToDimension(Domain, LoopStack.size());
4149 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
4150 NextLoopData.Schedule =
4151 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00004152 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00004153
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00004154 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
4155 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00004156 }
Tobias Grosser75805372011-04-29 06:27:02 +00004157}
4158
Michael Kruse6f7721f2016-02-24 22:08:19 +00004159ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00004160 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00004161 if (StmtMapIt == StmtMap.end())
4162 return nullptr;
4163 return StmtMapIt->second;
4164}
4165
Michael Kruse6f7721f2016-02-24 22:08:19 +00004166ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
4167 if (RN->isSubRegion())
4168 return getStmtFor(RN->getNodeAs<Region>());
4169 return getStmtFor(RN->getNodeAs<BasicBlock>());
4170}
4171
4172ScopStmt *Scop::getStmtFor(Region *R) const {
4173 ScopStmt *Stmt = getStmtFor(R->getEntry());
4174 assert(!Stmt || Stmt->getRegion() == R);
4175 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00004176}
4177
Johannes Doerfert96425c22015-08-30 21:13:53 +00004178int Scop::getRelativeLoopDepth(const Loop *L) const {
4179 Loop *OuterLoop =
4180 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
4181 if (!OuterLoop)
4182 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00004183 return L->getLoopDepth() - OuterLoop->getLoopDepth();
4184}
4185
Michael Krused868b5d2015-09-10 15:25:24 +00004186void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00004187 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004188
4189 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
4190 // true, are not modeled as ordinary PHI nodes as they are not part of the
4191 // region. However, we model the operands in the predecessor blocks that are
4192 // part of the region as regular scalar accesses.
4193
4194 // If we can synthesize a PHI we can skip it, however only if it is in
4195 // the region. If it is not it can only be in the exit block of the region.
4196 // In this case we model the operands but not the PHI itself.
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004197 auto *Scope = LI->getLoopFor(PHI->getParent());
4198 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R, Scope))
Michael Kruse7bf39442015-09-10 12:46:52 +00004199 return;
4200
4201 // PHI nodes are modeled as if they had been demoted prior to the SCoP
4202 // detection. Hence, the PHI is a load of a new memory location in which the
4203 // incoming value was written at the end of the incoming basic block.
4204 bool OnlyNonAffineSubRegionOperands = true;
4205 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
4206 Value *Op = PHI->getIncomingValue(u);
4207 BasicBlock *OpBB = PHI->getIncomingBlock(u);
4208
4209 // Do not build scalar dependences inside a non-affine subregion.
4210 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
4211 continue;
4212
4213 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004214 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004215 }
4216
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004217 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
4218 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004219 }
4220}
4221
Michael Kruse2e02d562016-02-06 09:19:40 +00004222void ScopInfo::buildScalarDependences(Instruction *Inst) {
4223 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00004224
Michael Kruse2e02d562016-02-06 09:19:40 +00004225 // Pull-in required operands.
4226 for (Use &Op : Inst->operands())
4227 ensureValueRead(Op.get(), Inst->getParent());
4228}
Michael Kruse7bf39442015-09-10 12:46:52 +00004229
Michael Kruse2e02d562016-02-06 09:19:40 +00004230void ScopInfo::buildEscapingDependences(Instruction *Inst) {
4231 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00004232
Michael Kruse2e02d562016-02-06 09:19:40 +00004233 // Check for uses of this instruction outside the scop. Because we do not
4234 // iterate over such instructions and therefore did not "ensure" the existence
4235 // of a write, we must determine such use here.
4236 for (Use &U : Inst->uses()) {
4237 Instruction *UI = dyn_cast<Instruction>(U.getUser());
4238 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00004239 continue;
4240
Michael Kruse2e02d562016-02-06 09:19:40 +00004241 BasicBlock *UseParent = getUseBlock(U);
4242 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00004243
Michael Kruse2e02d562016-02-06 09:19:40 +00004244 // An escaping value is either used by an instruction not within the scop,
4245 // or (when the scop region's exit needs to be simplified) by a PHI in the
4246 // scop's exit block. This is because region simplification before code
4247 // generation inserts new basic blocks before the PHI such that its incoming
4248 // blocks are not in the scop anymore.
4249 if (!R->contains(UseParent) ||
4250 (isa<PHINode>(UI) && UserParent == R->getExit() &&
4251 R->getExitingBlock())) {
4252 // At least one escaping use found.
4253 ensureValueWrite(Inst);
4254 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00004255 }
4256 }
Michael Kruse7bf39442015-09-10 12:46:52 +00004257}
4258
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004259bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00004260 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00004261 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4262 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00004263 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004264 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004265 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004266 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00004267 const SCEVUnknown *BasePointer =
4268 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004269 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004270 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004271
Michael Kruse37d136e2016-02-26 16:08:24 +00004272 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
4273 auto *Src = BitCast->getOperand(0);
4274 auto *SrcTy = Src->getType();
4275 auto *DstTy = BitCast->getType();
Johannes Doerfert41725a12016-04-08 19:20:03 +00004276 // Do not try to delinearize non-sized (opaque) pointers.
4277 if ((SrcTy->isPointerTy() && !SrcTy->getPointerElementType()->isSized()) ||
4278 (DstTy->isPointerTy() && !DstTy->getPointerElementType()->isSized())) {
4279 return false;
4280 }
Michael Kruse436c9062016-04-08 16:20:08 +00004281 if (SrcTy->isPointerTy() && DstTy->isPointerTy() &&
4282 DL->getTypeAllocSize(SrcTy->getPointerElementType()) ==
4283 DL->getTypeAllocSize(DstTy->getPointerElementType()))
Michael Kruse37d136e2016-02-26 16:08:24 +00004284 Address = Src;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004285 }
Michael Kruse37d136e2016-02-26 16:08:24 +00004286
4287 auto *GEP = dyn_cast<GetElementPtrInst>(Address);
4288 if (!GEP)
4289 return false;
4290
4291 std::vector<const SCEV *> Subscripts;
4292 std::vector<int> Sizes;
4293 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
4294 auto *BasePtr = GEP->getOperand(0);
4295
Tobias Grosser535afd82016-04-05 06:23:45 +00004296 if (auto *BasePtrCast = dyn_cast<BitCastInst>(BasePtr))
4297 BasePtr = BasePtrCast->getOperand(0);
4298
4299 // Check for identical base pointers to ensure that we do not miss index
4300 // offsets that have been added before this GEP is applied.
4301 if (BasePtr != BasePointer->getValue())
4302 return false;
4303
Michael Kruse37d136e2016-02-26 16:08:24 +00004304 std::vector<const SCEV *> SizesSCEV;
4305
4306 for (auto *Subscript : Subscripts) {
4307 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004308 if (!isAffineExpr(R, L, Subscript, *SE, &AccessILS))
Michael Kruse37d136e2016-02-26 16:08:24 +00004309 return false;
4310
4311 for (LoadInst *LInst : AccessILS)
4312 if (!ScopRIL.count(LInst))
4313 return false;
4314 }
4315
4316 if (Sizes.empty())
4317 return false;
4318
4319 for (auto V : Sizes)
4320 SizesSCEV.push_back(SE->getSCEV(
4321 ConstantInt::get(IntegerType::getInt64Ty(BasePtr->getContext()), V)));
4322
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004323 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004324 Subscripts, SizesSCEV, Val);
4325 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004326}
4327
4328bool ScopInfo::buildAccessMultiDimParam(
4329 MemAccInst Inst, Loop *L, Region *R,
4330 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004331 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse37d136e2016-02-26 16:08:24 +00004332 if (!PollyDelinearize)
4333 return false;
4334
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004335 Value *Address = Inst.getPointerOperand();
4336 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004337 Type *ElementType = Val->getType();
4338 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004339 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004340 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004341
4342 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4343 const SCEVUnknown *BasePointer =
4344 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4345
4346 assert(BasePointer && "Could not find base pointer");
4347 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00004348
Michael Kruse7bf39442015-09-10 12:46:52 +00004349 auto AccItr = InsnToMemAcc.find(Inst);
Michael Kruse37d136e2016-02-26 16:08:24 +00004350 if (AccItr == InsnToMemAcc.end())
4351 return false;
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004352
Michael Kruse37d136e2016-02-26 16:08:24 +00004353 std::vector<const SCEV *> Sizes(
4354 AccItr->second.Shape->DelinearizedSizes.begin(),
4355 AccItr->second.Shape->DelinearizedSizes.end());
4356 // Remove the element size. This information is already provided by the
4357 // ElementSize parameter. In case the element size of this access and the
4358 // element size used for delinearization differs the delinearization is
4359 // incorrect. Hence, we invalidate the scop.
4360 //
4361 // TODO: Handle delinearization with differing element sizes.
4362 auto DelinearizedSize =
4363 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
4364 Sizes.pop_back();
4365 if (ElementSize != DelinearizedSize)
4366 scop->invalidate(DELINEARIZATION, Inst->getDebugLoc());
4367
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004368 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, true,
Michael Kruse37d136e2016-02-26 16:08:24 +00004369 AccItr->second.DelinearizedSubscripts, Sizes, Val);
4370 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004371}
4372
Johannes Doerfertcea61932016-02-21 19:13:19 +00004373bool ScopInfo::buildAccessMemIntrinsic(
4374 MemAccInst Inst, Loop *L, Region *R,
4375 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4376 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004377 auto *MemIntr = dyn_cast_or_null<MemIntrinsic>(Inst);
4378
4379 if (MemIntr == nullptr)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004380 return false;
4381
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004382 auto *LengthVal = SE->getSCEVAtScope(MemIntr->getLength(), L);
Johannes Doerfertcea61932016-02-21 19:13:19 +00004383 assert(LengthVal);
4384
Johannes Doerferta7920982016-02-25 14:08:48 +00004385 // Check if the length val is actually affine or if we overapproximate it
4386 InvariantLoadsSetTy AccessILS;
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004387 bool LengthIsAffine = isAffineExpr(R, L, LengthVal, *SE, &AccessILS);
Johannes Doerferta7920982016-02-25 14:08:48 +00004388 for (LoadInst *LInst : AccessILS)
4389 if (!ScopRIL.count(LInst))
4390 LengthIsAffine = false;
4391 if (!LengthIsAffine)
4392 LengthVal = nullptr;
4393
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004394 auto *DestPtrVal = MemIntr->getDest();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004395 assert(DestPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004396
Johannes Doerfertcea61932016-02-21 19:13:19 +00004397 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
4398 assert(DestAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004399 // Ignore accesses to "NULL".
4400 // TODO: We could use this to optimize the region further, e.g., intersect
4401 // the context with
4402 // isl_set_complement(isl_set_params(getDomain()))
4403 // as we know it would be undefined to execute this instruction anyway.
4404 if (DestAccFunc->isZero())
4405 return true;
4406
Johannes Doerfertcea61932016-02-21 19:13:19 +00004407 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
4408 assert(DestPtrSCEV);
4409 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
4410 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
4411 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
4412 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
4413
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004414 auto *MemTrans = dyn_cast<MemTransferInst>(MemIntr);
4415 if (!MemTrans)
Johannes Doerfertcea61932016-02-21 19:13:19 +00004416 return true;
4417
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004418 auto *SrcPtrVal = MemTrans->getSource();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004419 assert(SrcPtrVal);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004420
Johannes Doerfertcea61932016-02-21 19:13:19 +00004421 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
4422 assert(SrcAccFunc);
Johannes Doerfert733ea342016-03-24 13:50:04 +00004423 // Ignore accesses to "NULL".
4424 // TODO: See above TODO
4425 if (SrcAccFunc->isZero())
4426 return true;
4427
Johannes Doerfertcea61932016-02-21 19:13:19 +00004428 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
4429 assert(SrcPtrSCEV);
4430 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
4431 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
4432 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
4433 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
4434
4435 return true;
4436}
4437
Johannes Doerferta7920982016-02-25 14:08:48 +00004438bool ScopInfo::buildAccessCallInst(
4439 MemAccInst Inst, Loop *L, Region *R,
4440 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4441 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004442 auto *CI = dyn_cast_or_null<CallInst>(Inst);
4443
4444 if (CI == nullptr)
Johannes Doerferta7920982016-02-25 14:08:48 +00004445 return false;
4446
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004447 if (CI->doesNotAccessMemory() || isIgnoredIntrinsic(CI))
Johannes Doerferta7920982016-02-25 14:08:48 +00004448 return true;
4449
4450 bool ReadOnly = false;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004451 auto *AF = SE->getConstant(IntegerType::getInt64Ty(CI->getContext()), 0);
4452 auto *CalledFunction = CI->getCalledFunction();
Johannes Doerferta7920982016-02-25 14:08:48 +00004453 switch (AA->getModRefBehavior(CalledFunction)) {
4454 case llvm::FMRB_UnknownModRefBehavior:
4455 llvm_unreachable("Unknown mod ref behaviour cannot be represented.");
4456 case llvm::FMRB_DoesNotAccessMemory:
4457 return true;
4458 case llvm::FMRB_OnlyReadsMemory:
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004459 GlobalReads.push_back(CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004460 return true;
4461 case llvm::FMRB_OnlyReadsArgumentPointees:
4462 ReadOnly = true;
4463 // Fall through
4464 case llvm::FMRB_OnlyAccessesArgumentPointees:
4465 auto AccType = ReadOnly ? MemoryAccess::READ : MemoryAccess::MAY_WRITE;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004466 for (const auto &Arg : CI->arg_operands()) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004467 if (!Arg->getType()->isPointerTy())
4468 continue;
4469
4470 auto *ArgSCEV = SE->getSCEVAtScope(Arg, L);
4471 if (ArgSCEV->isZero())
4472 continue;
4473
4474 auto *ArgBasePtr = cast<SCEVUnknown>(SE->getPointerBase(ArgSCEV));
4475 addArrayAccess(Inst, AccType, ArgBasePtr->getValue(),
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004476 ArgBasePtr->getType(), false, {AF}, {}, CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004477 }
4478 return true;
4479 }
4480
4481 return true;
4482}
4483
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004484void ScopInfo::buildAccessSingleDim(
4485 MemAccInst Inst, Loop *L, Region *R,
4486 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4487 const InvariantLoadsSetTy &ScopRIL) {
4488 Value *Address = Inst.getPointerOperand();
4489 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004490 Type *ElementType = Val->getType();
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004491 enum MemoryAccess::AccessType AccType =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004492 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004493
4494 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4495 const SCEVUnknown *BasePointer =
4496 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4497
4498 assert(BasePointer && "Could not find base pointer");
4499 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00004500
4501 // Check if the access depends on a loop contained in a non-affine subregion.
4502 bool isVariantInNonAffineLoop = false;
4503 if (BoxedLoops) {
4504 SetVector<const Loop *> Loops;
4505 findLoops(AccessFunction, Loops);
4506 for (const Loop *L : Loops)
4507 if (BoxedLoops->count(L))
4508 isVariantInNonAffineLoop = true;
4509 }
4510
Johannes Doerfert09e36972015-10-07 20:17:36 +00004511 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00004512 bool IsAffine = !isVariantInNonAffineLoop &&
Johannes Doerfertec8a2172016-04-25 13:32:36 +00004513 isAffineExpr(R, L, AccessFunction, *SE, &AccessILS);
Johannes Doerfert09e36972015-10-07 20:17:36 +00004514
4515 for (LoadInst *LInst : AccessILS)
4516 if (!ScopRIL.count(LInst))
4517 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004518
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004519 if (!IsAffine && AccType == MemoryAccess::MUST_WRITE)
4520 AccType = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004521
Michael Kruse1fdc2ff2016-04-08 14:35:59 +00004522 addArrayAccess(Inst, AccType, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004523 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004524}
4525
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004526void ScopInfo::buildMemoryAccess(
4527 MemAccInst Inst, Loop *L, Region *R,
4528 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004529 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004530
Johannes Doerfertcea61932016-02-21 19:13:19 +00004531 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4532 return;
4533
Johannes Doerferta7920982016-02-25 14:08:48 +00004534 if (buildAccessCallInst(Inst, L, R, BoxedLoops, ScopRIL))
4535 return;
4536
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004537 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4538 return;
4539
Hongbin Zheng22623202016-02-15 00:20:58 +00004540 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004541 return;
4542
4543 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4544}
4545
Hongbin Zheng22623202016-02-15 00:20:58 +00004546void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4547 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004548
4549 if (SD->isNonAffineSubRegion(&SR, &R)) {
4550 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004551 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004552 return;
4553 }
4554
4555 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4556 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004557 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004558 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004559 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004560}
4561
Johannes Doerferta8781032016-02-02 14:14:40 +00004562void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004563
Johannes Doerferta8781032016-02-02 14:14:40 +00004564 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004565 scop->addScopStmt(nullptr, &SR);
4566 return;
4567 }
4568
4569 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4570 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004571 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004572 else
4573 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4574}
4575
Michael Krused868b5d2015-09-10 15:25:24 +00004576void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004577 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004578 Region *NonAffineSubRegion,
4579 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004580 // We do not build access functions for error blocks, as they may contain
4581 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004582 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004583 return;
4584
Michael Kruse7bf39442015-09-10 12:46:52 +00004585 Loop *L = LI->getLoopFor(&BB);
4586
4587 // The set of loops contained in non-affine subregions that are part of R.
4588 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4589
Johannes Doerfert09e36972015-10-07 20:17:36 +00004590 // The set of loads that are required to be invariant.
4591 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4592
Michael Kruse2e02d562016-02-06 09:19:40 +00004593 for (Instruction &Inst : BB) {
4594 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004595 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004596 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004597
4598 // For the exit block we stop modeling after the last PHI node.
4599 if (!PHI && IsExitBlock)
4600 break;
4601
Johannes Doerfert09e36972015-10-07 20:17:36 +00004602 // TODO: At this point we only know that elements of ScopRIL have to be
4603 // invariant and will be hoisted for the SCoP to be processed. Though,
4604 // there might be other invariant accesses that will be hoisted and
4605 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004606 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004607 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004608
Michael Kruse2e02d562016-02-06 09:19:40 +00004609 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004610 continue;
4611
Tobias Grosser0904c692016-03-16 23:33:54 +00004612 // PHI nodes have already been modeled above and TerminatorInsts that are
4613 // not part of a non-affine subregion are fully modeled and regenerated
4614 // from the polyhedral domains. Hence, they do not need to be modeled as
4615 // explicit data dependences.
4616 if (!PHI && (!isa<TerminatorInst>(&Inst) || NonAffineSubRegion))
Michael Kruse2e02d562016-02-06 09:19:40 +00004617 buildScalarDependences(&Inst);
Tobias Grosser0904c692016-03-16 23:33:54 +00004618
Michael Kruse2e02d562016-02-06 09:19:40 +00004619 if (!IsExitBlock)
4620 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004621 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004622}
Michael Kruse7bf39442015-09-10 12:46:52 +00004623
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004624MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004625 MemoryAccess::AccessType AccType,
4626 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004627 bool Affine, Value *AccessValue,
4628 ArrayRef<const SCEV *> Subscripts,
4629 ArrayRef<const SCEV *> Sizes,
4630 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004631 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004632
4633 // Do not create a memory access for anything not in the SCoP. It would be
4634 // ignored anyway.
4635 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004636 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004637
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004638 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004639 Value *BaseAddr = BaseAddress;
4640 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4641
Tobias Grosserf4f68702015-12-14 15:05:37 +00004642 bool isKnownMustAccess = false;
4643
4644 // Accesses in single-basic block statements are always excuted.
4645 if (Stmt->isBlockStmt())
4646 isKnownMustAccess = true;
4647
4648 if (Stmt->isRegionStmt()) {
4649 // Accesses that dominate the exit block of a non-affine region are always
4650 // executed. In non-affine regions there may exist MK_Values that do not
4651 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4652 // only if there is at most one PHI_WRITE in the non-affine region.
4653 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4654 isKnownMustAccess = true;
4655 }
4656
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004657 // Non-affine PHI writes do not "happen" at a particular instruction, but
4658 // after exiting the statement. Therefore they are guaranteed execute and
4659 // overwrite the old value.
4660 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4661 isKnownMustAccess = true;
4662
Johannes Doerfertcea61932016-02-21 19:13:19 +00004663 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4664 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004665
Johannes Doerfertcea61932016-02-21 19:13:19 +00004666 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004667 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004668 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004669 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004670}
4671
Michael Kruse70131d32016-01-27 17:09:17 +00004672void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004673 MemoryAccess::AccessType AccType,
4674 Value *BaseAddress, Type *ElementType,
4675 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004676 ArrayRef<const SCEV *> Sizes,
4677 Value *AccessValue) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004678 ArrayBasePointers.insert(BaseAddress);
Hongbin Zhengf3d66122016-02-26 09:47:11 +00004679 addMemoryAccess(MemAccInst->getParent(), MemAccInst, AccType, BaseAddress,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004680 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004681 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004682}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004683
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004684void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004685 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004686
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004687 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004688 if (!Stmt)
4689 return;
4690
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004691 // Do not process further if the instruction is already written.
4692 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004693 return;
4694
Johannes Doerfertcea61932016-02-21 19:13:19 +00004695 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4696 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004697 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004698}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004699
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004700void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004701
Michael Kruse2e02d562016-02-06 09:19:40 +00004702 // There cannot be an "access" for literal constants. BasicBlock references
4703 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004704 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004705 return;
4706
Michael Krusefd463082016-01-27 22:51:56 +00004707 // If the instruction can be synthesized and the user is in the region we do
4708 // not need to add a value dependences.
4709 Region &ScopRegion = scop->getRegion();
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004710 auto *Scope = LI->getLoopFor(UserBB);
4711 if (canSynthesize(V, LI, SE, &ScopRegion, Scope))
Michael Krusefd463082016-01-27 22:51:56 +00004712 return;
4713
Michael Kruse2e02d562016-02-06 09:19:40 +00004714 // Do not build scalar dependences for required invariant loads as we will
4715 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004716 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004717 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004718 return;
4719
4720 // Determine the ScopStmt containing the value's definition and use. There is
4721 // no defining ScopStmt if the value is a function argument, a global value,
4722 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004723 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004724 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004725
Michael Kruse6f7721f2016-02-24 22:08:19 +00004726 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004727
4728 // We do not model uses outside the scop.
4729 if (!UserStmt)
4730 return;
4731
Michael Kruse2e02d562016-02-06 09:19:40 +00004732 // Add MemoryAccess for invariant values only if requested.
4733 if (!ModelReadOnlyScalars && !ValueStmt)
4734 return;
4735
4736 // Ignore use-def chains within the same ScopStmt.
4737 if (ValueStmt == UserStmt)
4738 return;
4739
Michael Krusead28e5a2016-01-26 13:33:15 +00004740 // Do not create another MemoryAccess for reloading the value if one already
4741 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004742 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004743 return;
4744
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004745 // For exit PHIs use the MK_ExitPHI MemoryKind not MK_Value.
4746 ScopArrayInfo::MemoryKind Kind = ScopArrayInfo::MK_Value;
4747 if (!ValueStmt && isa<PHINode>(V))
4748 Kind = ScopArrayInfo::MK_ExitPHI;
4749
Johannes Doerfertcea61932016-02-21 19:13:19 +00004750 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Johannes Doerfert2075b5d2016-04-03 11:16:00 +00004751 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(), Kind);
Michael Kruse2e02d562016-02-06 09:19:40 +00004752 if (ValueInst)
4753 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004754}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004755
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004756void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4757 Value *IncomingValue, bool IsExitBlock) {
Johannes Doerfert57c5f0b2016-04-05 13:44:21 +00004758 // As the incoming block might turn out to be an error statement ensure we
4759 // will create an exit PHI SAI object. It is needed during code generation
4760 // and would be created later anyway.
4761 if (IsExitBlock)
4762 scop->getOrCreateScopArrayInfo(PHI, PHI->getType(), {},
4763 ScopArrayInfo::MK_ExitPHI);
4764
Michael Kruse6f7721f2016-02-24 22:08:19 +00004765 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004766 if (!IncomingStmt)
4767 return;
4768
4769 // Take care for the incoming value being available in the incoming block.
4770 // This must be done before the check for multiple PHI writes because multiple
4771 // exiting edges from subregion each can be the effective written value of the
4772 // subregion. As such, all of them must be made available in the subregion
4773 // statement.
4774 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004775
4776 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4777 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4778 assert(Acc->getAccessInstruction() == PHI);
4779 Acc->addIncoming(IncomingBlock, IncomingValue);
4780 return;
4781 }
4782
4783 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004784 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4785 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4786 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004787 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4788 assert(Acc);
4789 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004790}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004791
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004792void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004793 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4794 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4795 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004796}
4797
Michael Krusedaf66942015-12-13 22:10:37 +00004798void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004799 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse09eb4452016-03-03 22:10:47 +00004800 scop.reset(new Scop(R, *SE, *LI, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004801
Johannes Doerferta8781032016-02-02 14:14:40 +00004802 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004803 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004804
4805 // In case the region does not have an exiting block we will later (during
4806 // code generation) split the exit block. This will move potential PHI nodes
4807 // from the current exit block into the new region exiting block. Hence, PHI
4808 // nodes that are at this point not part of the region will be.
4809 // To handle these PHI nodes later we will now model their operands as scalar
4810 // accesses. Note that we do not model anything in the exit block if we have
4811 // an exiting block in the region, as there will not be any splitting later.
4812 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004813 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4814 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004815
Johannes Doerferta7920982016-02-25 14:08:48 +00004816 // Create memory accesses for global reads since all arrays are now known.
4817 auto *AF = SE->getConstant(IntegerType::getInt64Ty(SE->getContext()), 0);
4818 for (auto *GlobalRead : GlobalReads)
4819 for (auto *BP : ArrayBasePointers)
4820 addArrayAccess(MemAccInst(GlobalRead), MemoryAccess::READ, BP,
4821 BP->getType(), false, {AF}, {}, GlobalRead);
4822
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004823 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004824}
4825
Michael Krused868b5d2015-09-10 15:25:24 +00004826void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004827 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004828 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004829 return;
4830 }
4831
Michael Kruse9d080092015-09-11 21:41:48 +00004832 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004833}
4834
Hongbin Zhengfec32802016-02-13 15:13:02 +00004835void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004836
4837//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004838ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004839
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004840ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004841
Tobias Grosser75805372011-04-29 06:27:02 +00004842void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004843 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004844 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004845 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004846 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4847 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004848 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004849 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004850 AU.setPreservesAll();
4851}
4852
4853bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004854 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004855
Michael Krused868b5d2015-09-10 15:25:24 +00004856 if (!SD->isMaxRegionInScop(*R))
4857 return false;
4858
4859 Function *F = R->getEntry()->getParent();
4860 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4861 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4862 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004863 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004864 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004865 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004866
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004867 DebugLoc Beg, End;
4868 getDebugLocations(R, Beg, End);
4869 std::string Msg = "SCoP begins here.";
4870 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4871
Michael Krusedaf66942015-12-13 22:10:37 +00004872 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004873
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004874 DEBUG(scop->print(dbgs()));
4875
Michael Kruseafe06702015-10-02 16:33:27 +00004876 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004877 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004878 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004879 } else {
4880 Msg = "SCoP ends here.";
4881 ++ScopFound;
4882 if (scop->getMaxLoopDepth() > 0)
4883 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004884 }
4885
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004886 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4887
Tobias Grosser75805372011-04-29 06:27:02 +00004888 return false;
4889}
4890
4891char ScopInfo::ID = 0;
4892
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004893Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4894
Tobias Grosser73600b82011-10-08 00:30:40 +00004895INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4896 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004897 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004898INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004899INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004900INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004901INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004902INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004903INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004904INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004905INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4906 "Polly - Create polyhedral description of Scops", false,
4907 false)