blob: e549ba2132798ffb1fdc58b6c3222680e3a01ab2 [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"
Tobias Grosserba0d0922015-05-09 09:13:42 +000035#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000036#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000037#include "llvm/Analysis/RegionIterator.h"
38#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000039#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000040#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000041#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000042#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000043#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000044#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000045#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000046#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000047#include "isl/schedule.h"
48#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000049#include "isl/set.h"
50#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000051#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000052#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000053#include <sstream>
54#include <string>
55#include <vector>
56
57using namespace llvm;
58using namespace polly;
59
Chandler Carruth95fef942014-04-22 03:30:19 +000060#define DEBUG_TYPE "polly-scops"
61
Tobias Grosser74394f02013-01-14 22:40:23 +000062STATISTIC(ScopFound, "Number of valid Scops");
63STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000064
Tobias Grosser75dc40c2015-12-20 13:31:48 +000065// The maximal number of basic sets we allow during domain construction to
66// be created. More complex scops will result in very high compile time and
67// are also unlikely to result in good code
68static int const MaxConjunctsInDomain = 20;
69
Michael Kruse7bf39442015-09-10 12:46:52 +000070static cl::opt<bool> ModelReadOnlyScalars(
71 "polly-analyze-read-only-scalars",
72 cl::desc("Model read-only scalar values in the scop description"),
73 cl::Hidden, cl::ZeroOrMore, cl::init(true), cl::cat(PollyCategory));
74
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000075// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000076// operations can overflow easily. Additive reductions and bit operations
77// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000078static cl::opt<bool> DisableMultiplicativeReductions(
79 "polly-disable-multiplicative-reductions",
80 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
81 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000082
Johannes Doerfert9143d672014-09-27 11:02:39 +000083static cl::opt<unsigned> RunTimeChecksMaxParameters(
84 "polly-rtc-max-parameters",
85 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
86 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
87
Tobias Grosser71500722015-03-28 15:11:14 +000088static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
89 "polly-rtc-max-arrays-per-group",
90 cl::desc("The maximal number of arrays to compare in each alias group."),
91 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Tobias Grosser8a9c2352015-08-16 10:19:29 +000092static cl::opt<std::string> UserContextStr(
93 "polly-context", cl::value_desc("isl parameter set"),
94 cl::desc("Provide additional constraints on the context parameters"),
95 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +000096
Tobias Grosserd83b8a82015-08-20 19:08:11 +000097static cl::opt<bool> DetectReductions("polly-detect-reductions",
98 cl::desc("Detect and exploit reductions"),
99 cl::Hidden, cl::ZeroOrMore,
100 cl::init(true), cl::cat(PollyCategory));
101
Tobias Grosser20a4c0c2015-11-11 16:22:36 +0000102static cl::opt<int> MaxDisjunctsAssumed(
103 "polly-max-disjuncts-assumed",
104 cl::desc("The maximal number of disjuncts we allow in the assumption "
105 "context (this bounds compile time)"),
106 cl::Hidden, cl::ZeroOrMore, cl::init(150), cl::cat(PollyCategory));
107
Tobias Grosser4927c8e2015-11-24 12:50:02 +0000108static cl::opt<bool> IgnoreIntegerWrapping(
109 "polly-ignore-integer-wrapping",
110 cl::desc("Do not build run-time checks to proof absence of integer "
111 "wrapping"),
112 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
113
Michael Kruse7bf39442015-09-10 12:46:52 +0000114//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000115
Michael Kruse046dde42015-08-10 13:01:57 +0000116// Create a sequence of two schedules. Either argument may be null and is
117// interpreted as the empty schedule. Can also return null if both schedules are
118// empty.
119static __isl_give isl_schedule *
120combineInSequence(__isl_take isl_schedule *Prev,
121 __isl_take isl_schedule *Succ) {
122 if (!Prev)
123 return Succ;
124 if (!Succ)
125 return Prev;
126
127 return isl_schedule_sequence(Prev, Succ);
128}
129
Johannes Doerferte7044942015-02-24 11:58:30 +0000130static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
131 const ConstantRange &Range,
132 int dim,
133 enum isl_dim_type type) {
134 isl_val *V;
135 isl_ctx *ctx = isl_set_get_ctx(S);
136
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000137 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
138 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000139 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000140 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
141
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000142 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000143 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000144 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000145 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000146 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
147
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000148 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000149 return isl_set_union(SLB, SUB);
150 else
151 return isl_set_intersect(SLB, SUB);
152}
153
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000154static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
155 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
156 if (!BasePtrLI)
157 return nullptr;
158
159 if (!S->getRegion().contains(BasePtrLI))
160 return nullptr;
161
162 ScalarEvolution &SE = *S->getSE();
163
164 auto *OriginBaseSCEV =
165 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
166 if (!OriginBaseSCEV)
167 return nullptr;
168
169 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
170 if (!OriginBaseSCEVUnknown)
171 return nullptr;
172
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000173 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grossera535dff2015-12-13 19:59:01 +0000174 ScopArrayInfo::MK_Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000175}
176
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000177ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grossera535dff2015-12-13 19:59:01 +0000178 ArrayRef<const SCEV *> Sizes, enum MemoryKind Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000179 const DataLayout &DL, Scop *S)
180 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000181 std::string BasePtrName =
Tobias Grossera535dff2015-12-13 19:59:01 +0000182 getIslCompatibleName("MemRef_", BasePtr, Kind == MK_PHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000183 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000184
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000185 updateSizes(Sizes);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000186 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
187 if (BasePtrOriginSAI)
188 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000189}
190
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000191__isl_give isl_space *ScopArrayInfo::getSpace() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000192 auto *Space =
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000193 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
194 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
195 return Space;
196}
197
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000198void ScopArrayInfo::updateElementType(Type *NewElementType) {
199 if (NewElementType == ElementType)
200 return;
201
Tobias Grosserd840fc72016-02-04 13:18:42 +0000202 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
203 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
204
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000205 if (NewElementSize == OldElementSize)
206 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000207
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000208 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
209 ElementType = NewElementType;
210 } else {
211 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
212 ElementType = IntegerType::get(ElementType->getContext(), GCD);
213 }
214}
215
216bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000217 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
218 int ExtraDimsNew = NewSizes.size() - SharedDims;
219 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Tobias Grosser8286b832015-11-02 11:29:32 +0000220 for (int i = 0; i < SharedDims; i++)
221 if (NewSizes[i + ExtraDimsNew] != DimensionSizes[i + ExtraDimsOld])
222 return false;
223
224 if (DimensionSizes.size() >= NewSizes.size())
225 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000226
227 DimensionSizes.clear();
228 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
229 NewSizes.end());
230 for (isl_pw_aff *Size : DimensionSizesPw)
231 isl_pw_aff_free(Size);
232 DimensionSizesPw.clear();
233 for (const SCEV *Expr : DimensionSizes) {
234 isl_pw_aff *Size = S.getPwAff(Expr);
235 DimensionSizesPw.push_back(Size);
236 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000237 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000238}
239
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000240ScopArrayInfo::~ScopArrayInfo() {
241 isl_id_free(Id);
242 for (isl_pw_aff *Size : DimensionSizesPw)
243 isl_pw_aff_free(Size);
244}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000245
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000246std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
247
248int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000249 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000250}
251
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000252isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
253
254void ScopArrayInfo::dump() const { print(errs()); }
255
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000256void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000257 OS.indent(8) << *getElementType() << " " << getName();
258 if (getNumberOfDimensions() > 0)
259 OS << "[*]";
Tobias Grosser26253842015-11-10 14:24:21 +0000260 for (unsigned u = 1; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000261 OS << "[";
262
Tobias Grosser26253842015-11-10 14:24:21 +0000263 if (SizeAsPwAff) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000264 auto *Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000265 OS << " " << Size << " ";
266 isl_pw_aff_free(Size);
267 } else {
268 OS << *getDimensionSize(u);
269 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000270
271 OS << "]";
272 }
273
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000274 OS << ";";
275
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000276 if (BasePtrOriginSAI)
277 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
278
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000279 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000280}
281
282const ScopArrayInfo *
283ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
284 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
285 assert(Id && "Output dimension didn't have an ID");
286 return getFromId(Id);
287}
288
289const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
290 void *User = isl_id_get_user(Id);
291 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
292 isl_id_free(Id);
293 return SAI;
294}
295
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000296void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000297 auto *SAI = getScopArrayInfo();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000298 auto *ArraySpace = SAI->getSpace();
299 auto *AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000300 auto *Ctx = isl_space_get_ctx(AccessSpace);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000301
302 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
303 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
304 auto DimsMissing = DimsArray - DimsAccess;
305
Michael Kruse375cb5f2016-02-24 22:08:24 +0000306 auto *BB = getStatement()->getEntryBlock();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000307 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000308 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000309 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000310
Johannes Doerferta90943d2016-02-21 16:37:25 +0000311 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000312 isl_set_universe(AccessSpace),
313 isl_set_universe(isl_space_copy(ArraySpace)));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000314
315 for (unsigned i = 0; i < DimsMissing; i++)
316 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
317
318 for (unsigned i = DimsMissing; i < DimsArray; i++)
319 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
320
321 AccessRelation = isl_map_apply_range(AccessRelation, Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000322
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000323 // For the non delinearized arrays, divide the access function of the last
324 // subscript by the size of the elements in the array.
325 //
326 // A stride one array access in C expressed as A[i] is expressed in
327 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
328 // two subsequent values of 'i' index two values that are stored next to
329 // each other in memory. By this division we make this characteristic
330 // obvious again. If the base pointer was accessed with offsets not divisible
331 // by the accesses element size, we will have choosen a smaller ArrayElemSize
332 // that divides the offsets of all accesses to this base pointer.
333 if (DimsAccess == 1) {
334 isl_val *V = isl_val_int_from_si(Ctx, ArrayElemSize);
335 AccessRelation = isl_map_floordiv_val(AccessRelation, V);
336 }
337
338 if (!isAffine())
339 computeBoundsOnAccessRelation(ArrayElemSize);
340
Tobias Grosserd840fc72016-02-04 13:18:42 +0000341 // Introduce multi-element accesses in case the type loaded by this memory
342 // access is larger than the canonical element type of the array.
343 //
344 // An access ((float *)A)[i] to an array char *A is modeled as
345 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000346 if (ElemBytes > ArrayElemSize) {
347 assert(ElemBytes % ArrayElemSize == 0 &&
348 "Loaded element size should be multiple of canonical element size");
Johannes Doerferta90943d2016-02-21 16:37:25 +0000349 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000350 isl_set_universe(isl_space_copy(ArraySpace)),
351 isl_set_universe(isl_space_copy(ArraySpace)));
352 for (unsigned i = 0; i < DimsArray - 1; i++)
353 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
354
Tobias Grosserd840fc72016-02-04 13:18:42 +0000355 isl_constraint *C;
356 isl_local_space *LS;
357
358 LS = isl_local_space_from_space(isl_map_get_space(Map));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000359 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
360
361 C = isl_constraint_alloc_inequality(isl_local_space_copy(LS));
362 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, Num - 1));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000363 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, 1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000364 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, -1);
365 Map = isl_map_add_constraint(Map, C);
366
367 C = isl_constraint_alloc_inequality(LS);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000368 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, -1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000369 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, 1);
370 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, 0));
371 Map = isl_map_add_constraint(Map, C);
372 AccessRelation = isl_map_apply_range(AccessRelation, Map);
373 }
374
375 isl_space_free(ArraySpace);
376
Roman Gareev10595a12016-01-08 14:01:59 +0000377 assumeNoOutOfBound();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000378}
379
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000380const std::string
381MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
382 switch (RT) {
383 case MemoryAccess::RT_NONE:
384 llvm_unreachable("Requested a reduction operator string for a memory "
385 "access which isn't a reduction");
386 case MemoryAccess::RT_ADD:
387 return "+";
388 case MemoryAccess::RT_MUL:
389 return "*";
390 case MemoryAccess::RT_BOR:
391 return "|";
392 case MemoryAccess::RT_BXOR:
393 return "^";
394 case MemoryAccess::RT_BAND:
395 return "&";
396 }
397 llvm_unreachable("Unknown reduction type");
398 return "";
399}
400
Johannes Doerfertf6183392014-07-01 20:52:51 +0000401/// @brief Return the reduction type for a given binary operator
402static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
403 const Instruction *Load) {
404 if (!BinOp)
405 return MemoryAccess::RT_NONE;
406 switch (BinOp->getOpcode()) {
407 case Instruction::FAdd:
408 if (!BinOp->hasUnsafeAlgebra())
409 return MemoryAccess::RT_NONE;
410 // Fall through
411 case Instruction::Add:
412 return MemoryAccess::RT_ADD;
413 case Instruction::Or:
414 return MemoryAccess::RT_BOR;
415 case Instruction::Xor:
416 return MemoryAccess::RT_BXOR;
417 case Instruction::And:
418 return MemoryAccess::RT_BAND;
419 case Instruction::FMul:
420 if (!BinOp->hasUnsafeAlgebra())
421 return MemoryAccess::RT_NONE;
422 // Fall through
423 case Instruction::Mul:
424 if (DisableMultiplicativeReductions)
425 return MemoryAccess::RT_NONE;
426 return MemoryAccess::RT_MUL;
427 default:
428 return MemoryAccess::RT_NONE;
429 }
430}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000431
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000432/// @brief Derive the individual index expressions from a GEP instruction
433///
434/// This function optimistically assumes the GEP references into a fixed size
435/// array. If this is actually true, this function returns a list of array
436/// subscript expressions as SCEV as well as a list of integers describing
437/// the size of the individual array dimensions. Both lists have either equal
438/// length of the size list is one element shorter in case there is no known
439/// size available for the outermost array dimension.
440///
441/// @param GEP The GetElementPtr instruction to analyze.
442///
443/// @return A tuple with the subscript expressions and the dimension sizes.
444static std::tuple<std::vector<const SCEV *>, std::vector<int>>
445getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
446 std::vector<const SCEV *> Subscripts;
447 std::vector<int> Sizes;
448
449 Type *Ty = GEP->getPointerOperandType();
450
451 bool DroppedFirstDim = false;
452
Michael Kruse26ed65e2015-09-24 17:32:49 +0000453 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000454
455 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
456
457 if (i == 1) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000458 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000459 Ty = PtrTy->getElementType();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000460 } else if (auto *ArrayTy = dyn_cast<ArrayType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000461 Ty = ArrayTy->getElementType();
462 } else {
463 Subscripts.clear();
464 Sizes.clear();
465 break;
466 }
Johannes Doerferta90943d2016-02-21 16:37:25 +0000467 if (auto *Const = dyn_cast<SCEVConstant>(Expr))
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000468 if (Const->getValue()->isZero()) {
469 DroppedFirstDim = true;
470 continue;
471 }
472 Subscripts.push_back(Expr);
473 continue;
474 }
475
Johannes Doerferta90943d2016-02-21 16:37:25 +0000476 auto *ArrayTy = dyn_cast<ArrayType>(Ty);
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000477 if (!ArrayTy) {
478 Subscripts.clear();
479 Sizes.clear();
480 break;
481 }
482
483 Subscripts.push_back(Expr);
484 if (!(DroppedFirstDim && i == 2))
485 Sizes.push_back(ArrayTy->getNumElements());
486
487 Ty = ArrayTy->getElementType();
488 }
489
490 return std::make_tuple(Subscripts, Sizes);
491}
492
Tobias Grosser75805372011-04-29 06:27:02 +0000493MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000494 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000495 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000496 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000497}
498
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000499const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
500 isl_id *ArrayId = getArrayId();
501 void *User = isl_id_get_user(ArrayId);
502 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
503 isl_id_free(ArrayId);
504 return SAI;
505}
506
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000507__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000508 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
509}
510
Tobias Grosserd840fc72016-02-04 13:18:42 +0000511__isl_give isl_map *MemoryAccess::getAddressFunction() const {
512 return isl_map_lexmin(getAccessRelation());
513}
514
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000515__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
516 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000517 isl_map *Schedule, *ScheduledAccRel;
518 isl_union_set *UDomain;
519
520 UDomain = isl_union_set_from_set(getStatement()->getDomain());
521 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
522 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000523 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000524 return isl_pw_multi_aff_from_map(ScheduledAccRel);
525}
526
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000527__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000528 return isl_map_copy(AccessRelation);
529}
530
Johannes Doerferta99130f2014-10-13 12:58:03 +0000531std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000532 return stringFromIslObj(AccessRelation);
533}
534
Johannes Doerferta99130f2014-10-13 12:58:03 +0000535__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000536 return isl_map_get_space(AccessRelation);
537}
538
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000539__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000540 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000541}
542
Tobias Grosser6f730082015-09-05 07:46:47 +0000543std::string MemoryAccess::getNewAccessRelationStr() const {
544 return stringFromIslObj(NewAccessRelation);
545}
546
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000547__isl_give isl_basic_map *
548MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000549 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000550 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000551
Tobias Grosser084d8f72012-05-29 09:29:44 +0000552 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000553 isl_basic_set_universe(Statement->getDomainSpace()),
554 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000555}
556
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000557// Formalize no out-of-bound access assumption
558//
559// When delinearizing array accesses we optimistically assume that the
560// delinearized accesses do not access out of bound locations (the subscript
561// expression of each array evaluates for each statement instance that is
562// executed to a value that is larger than zero and strictly smaller than the
563// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000564// dimension for which we do not need to assume any upper bound. At this point
565// we formalize this assumption to ensure that at code generation time the
566// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000567//
568// To find the set of constraints necessary to avoid out of bound accesses, we
569// first build the set of data locations that are not within array bounds. We
570// then apply the reverse access relation to obtain the set of iterations that
571// may contain invalid accesses and reduce this set of iterations to the ones
572// that are actually executed by intersecting them with the domain of the
573// statement. If we now project out all loop dimensions, we obtain a set of
574// parameters that may cause statement instances to be executed that may
575// possibly yield out of bound memory accesses. The complement of these
576// constraints is the set of constraints that needs to be assumed to ensure such
577// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000578void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000579 auto *SAI = getScopArrayInfo();
Johannes Doerferta99130f2014-10-13 12:58:03 +0000580 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000581 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Roman Gareev10595a12016-01-08 14:01:59 +0000582 for (int i = 1, Size = isl_space_dim(Space, isl_dim_set); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000583 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
584 isl_pw_aff *Var =
585 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
586 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
587
588 isl_set *DimOutside;
589
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000590 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfertadeab372016-02-07 13:57:32 +0000591 isl_pw_aff *SizeE = SAI->getDimensionSizePw(i);
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000592 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
593 isl_space_dim(Space, isl_dim_set));
594 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
595 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000596
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000597 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000598
599 Outside = isl_set_union(Outside, DimOutside);
600 }
601
602 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
603 Outside = isl_set_intersect(Outside, Statement->getDomain());
604 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000605
606 // Remove divs to avoid the construction of overly complicated assumptions.
607 // Doing so increases the set of parameter combinations that are assumed to
608 // not appear. This is always save, but may make the resulting run-time check
609 // bail out more often than strictly necessary.
610 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000611 Outside = isl_set_complement(Outside);
Michael Krusead28e5a2016-01-26 13:33:15 +0000612 Statement->getParent()->addAssumption(
613 INBOUNDS, Outside,
614 getAccessInstruction() ? getAccessInstruction()->getDebugLoc() : nullptr);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000615 isl_space_free(Space);
616}
617
Johannes Doerfertcea61932016-02-21 19:13:19 +0000618void MemoryAccess::buildMemIntrinsicAccessRelation() {
619 auto MAI = MemAccInst(getAccessInstruction());
620 assert(MAI.isMemIntrinsic());
621 assert(Subscripts.size() == 2 && Sizes.size() == 0);
622
623 auto *LengthPWA = Statement->getPwAff(Subscripts[1]);
624 auto *LengthMap = isl_map_from_pw_aff(LengthPWA);
625 auto *RangeSpace = isl_space_range(isl_map_get_space(LengthMap));
626 LengthMap = isl_map_apply_range(LengthMap, isl_map_lex_gt(RangeSpace));
627 LengthMap = isl_map_lower_bound_si(LengthMap, isl_dim_out, 0, 0);
628 auto *SubscriptPWA = Statement->getPwAff(Subscripts[0]);
629 auto *SubscriptMap = isl_map_from_pw_aff(SubscriptPWA);
630 SubscriptMap =
631 isl_map_align_params(SubscriptMap, isl_map_get_space(LengthMap));
632 LengthMap = isl_map_align_params(LengthMap, isl_map_get_space(SubscriptMap));
633 LengthMap = isl_map_sum(LengthMap, SubscriptMap);
634 AccessRelation = isl_map_set_tuple_id(LengthMap, isl_dim_in,
635 getStatement()->getDomainId());
636}
637
Johannes Doerferte7044942015-02-24 11:58:30 +0000638void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
639 ScalarEvolution *SE = Statement->getParent()->getSE();
640
Johannes Doerfertcea61932016-02-21 19:13:19 +0000641 auto MAI = MemAccInst(getAccessInstruction());
642 if (MAI.isMemIntrinsic())
643 return;
644
645 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000646 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
647 return;
648
649 auto *PtrSCEV = SE->getSCEV(Ptr);
650 if (isa<SCEVCouldNotCompute>(PtrSCEV))
651 return;
652
653 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
654 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
655 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
656
657 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
658 if (Range.isFullSet())
659 return;
660
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000661 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000662 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000663 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000664 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000665 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000666
667 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000668 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000669
670 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
671 AccessRange =
672 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
673 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
674}
675
Michael Krusee2bccbb2015-09-18 19:59:43 +0000676__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000677 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000678 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000679
680 for (int i = Size - 2; i >= 0; --i) {
681 isl_space *Space;
682 isl_map *MapOne, *MapTwo;
Michael Krusee2bccbb2015-09-18 19:59:43 +0000683 isl_pw_aff *DimSize = Statement->getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000684
685 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
686 isl_pw_aff_free(DimSize);
687 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
688
689 Space = isl_map_get_space(AccessRelation);
690 Space = isl_space_map_from_set(isl_space_range(Space));
691 Space = isl_space_align_params(Space, SpaceSize);
692
693 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
694 isl_id_free(ParamId);
695
696 MapOne = isl_map_universe(isl_space_copy(Space));
697 for (int j = 0; j < Size; ++j)
698 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
699 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
700
701 MapTwo = isl_map_universe(isl_space_copy(Space));
702 for (int j = 0; j < Size; ++j)
703 if (j < i || j > i + 1)
704 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
705
706 isl_local_space *LS = isl_local_space_from_space(Space);
707 isl_constraint *C;
708 C = isl_equality_alloc(isl_local_space_copy(LS));
709 C = isl_constraint_set_constant_si(C, -1);
710 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
711 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
712 MapTwo = isl_map_add_constraint(MapTwo, C);
713 C = isl_equality_alloc(LS);
714 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
715 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
716 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
717 MapTwo = isl_map_add_constraint(MapTwo, C);
718 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
719
720 MapOne = isl_map_union(MapOne, MapTwo);
721 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
722 }
723 return AccessRelation;
724}
725
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000726/// @brief Check if @p Expr is divisible by @p Size.
727static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000728 if (Size == 1)
729 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000730
731 // Only one factor needs to be divisible.
732 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
733 for (auto *FactorExpr : MulExpr->operands())
734 if (isDivisible(FactorExpr, Size, SE))
735 return true;
736 return false;
737 }
738
739 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
740 // to be divisble.
741 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
742 for (auto *OpExpr : NAryExpr->operands())
743 if (!isDivisible(OpExpr, Size, SE))
744 return false;
745 return true;
746 }
747
748 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
749 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
750 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
751 return MulSCEV == Expr;
752}
753
Michael Krusee2bccbb2015-09-18 19:59:43 +0000754void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
755 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000756
Michael Krusee2bccbb2015-09-18 19:59:43 +0000757 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000758 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000759
Michael Krusee2bccbb2015-09-18 19:59:43 +0000760 if (!isAffine()) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000761 if (isa<MemIntrinsic>(getAccessInstruction()))
762 buildMemIntrinsicAccessRelation();
763
Tobias Grosser4f967492013-06-23 05:21:18 +0000764 // We overapproximate non-affine accesses with a possible access to the
765 // whole array. For read accesses it does not make a difference, if an
766 // access must or may happen. However, for write accesses it is important to
767 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000768 if (!AccessRelation)
769 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
770
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000771 AccessRelation =
772 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000773 return;
774 }
775
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000776 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000777 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000778
Michael Krusee2bccbb2015-09-18 19:59:43 +0000779 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
780 isl_pw_aff *Affine = Statement->getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000781 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000782 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000783 }
784
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000785 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000786 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000787
Tobias Grosser79baa212014-04-10 08:38:02 +0000788 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000789 AccessRelation = isl_map_set_tuple_id(
790 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000791 AccessRelation =
792 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
793
Tobias Grosseraa660a92015-03-30 00:07:50 +0000794 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000795 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000796}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000797
Michael Krusecac948e2015-10-02 13:53:07 +0000798MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +0000799 AccessType AccType, Value *BaseAddress,
800 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000801 ArrayRef<const SCEV *> Subscripts,
802 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000803 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
Johannes Doerfertcea61932016-02-21 19:13:19 +0000804 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
805 BaseAddr(BaseAddress), BaseName(BaseName), ElementType(ElementType),
Michael Krusecac948e2015-10-02 13:53:07 +0000806 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
807 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000808 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000809 NewAccessRelation(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000810 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Johannes Doerfertcea61932016-02-21 19:13:19 +0000811 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size()) + "_";
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000812
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000813 std::string IdName =
814 getIslCompatibleName(Stmt->getBaseName(), Access, BaseName);
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000815 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
816}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000817
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000818void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000819 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000820 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000821}
822
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000823const std::string MemoryAccess::getReductionOperatorStr() const {
824 return MemoryAccess::getReductionOperatorStr(getReductionType());
825}
826
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000827__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
828
Johannes Doerfertf6183392014-07-01 20:52:51 +0000829raw_ostream &polly::operator<<(raw_ostream &OS,
830 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000831 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000832 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000833 else
834 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000835 return OS;
836}
837
Tobias Grosser75805372011-04-29 06:27:02 +0000838void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000839 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000840 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000841 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000842 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000843 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000844 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000845 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000846 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000847 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000848 break;
849 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000850 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000851 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000852 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000853 if (hasNewAccessRelation())
854 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000855}
856
Tobias Grosser74394f02013-01-14 22:40:23 +0000857void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000858
859// Create a map in the size of the provided set domain, that maps from the
860// one element of the provided set domain to another element of the provided
861// set domain.
862// The mapping is limited to all points that are equal in all but the last
863// dimension and for which the last dimension of the input is strict smaller
864// than the last dimension of the output.
865//
866// getEqualAndLarger(set[i0, i1, ..., iX]):
867//
868// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
869// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
870//
Tobias Grosserf5338802011-10-06 00:03:35 +0000871static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000872 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000873 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000874 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000875
876 // Set all but the last dimension to be equal for the input and output
877 //
878 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
879 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000880 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000881 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000882
883 // Set the last dimension of the input to be strict smaller than the
884 // last dimension of the output.
885 //
886 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000887 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
888 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000889 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000890}
891
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000892__isl_give isl_set *
893MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000894 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000895 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000896 isl_space *Space = isl_space_range(isl_map_get_space(S));
897 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000898
Sebastian Popa00a0292012-12-18 07:46:06 +0000899 S = isl_map_reverse(S);
900 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000901
Sebastian Popa00a0292012-12-18 07:46:06 +0000902 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
903 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
904 NextScatt = isl_map_apply_domain(NextScatt, S);
905 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000906
Sebastian Popa00a0292012-12-18 07:46:06 +0000907 isl_set *Deltas = isl_map_deltas(NextScatt);
908 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000909}
910
Sebastian Popa00a0292012-12-18 07:46:06 +0000911bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000912 int StrideWidth) const {
913 isl_set *Stride, *StrideX;
914 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000915
Sebastian Popa00a0292012-12-18 07:46:06 +0000916 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000917 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000918 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
919 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
920 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
921 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000922 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000923
Tobias Grosser28dd4862012-01-24 16:42:16 +0000924 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000925 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000926
Tobias Grosser28dd4862012-01-24 16:42:16 +0000927 return IsStrideX;
928}
929
Sebastian Popa00a0292012-12-18 07:46:06 +0000930bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
931 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000932}
933
Sebastian Popa00a0292012-12-18 07:46:06 +0000934bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
935 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000936}
937
Tobias Grosser166c4222015-09-05 07:46:40 +0000938void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
939 isl_map_free(NewAccessRelation);
940 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000941}
Tobias Grosser75805372011-04-29 06:27:02 +0000942
943//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000944
Tobias Grosser808cd692015-07-14 09:33:13 +0000945isl_map *ScopStmt::getSchedule() const {
946 isl_set *Domain = getDomain();
947 if (isl_set_is_empty(Domain)) {
948 isl_set_free(Domain);
949 return isl_map_from_aff(
950 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
951 }
952 auto *Schedule = getParent()->getSchedule();
953 Schedule = isl_union_map_intersect_domain(
954 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
955 if (isl_union_map_is_empty(Schedule)) {
956 isl_set_free(Domain);
957 isl_union_map_free(Schedule);
958 return isl_map_from_aff(
959 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
960 }
961 auto *M = isl_map_from_union_map(Schedule);
962 M = isl_map_coalesce(M);
963 M = isl_map_gist_domain(M, Domain);
964 M = isl_map_coalesce(M);
965 return M;
966}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000967
Johannes Doerfert574182d2015-08-12 10:19:50 +0000968__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Michael Kruse375cb5f2016-02-24 22:08:24 +0000969 return getParent()->getPwAff(E, getEntryBlock());
Johannes Doerfert574182d2015-08-12 10:19:50 +0000970}
971
Tobias Grosser37eb4222014-02-20 21:43:54 +0000972void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
973 assert(isl_set_is_subset(NewDomain, Domain) &&
974 "New domain is not a subset of old domain!");
975 isl_set_free(Domain);
976 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000977}
978
Michael Krusecac948e2015-10-02 13:53:07 +0000979void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000980 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +0000981 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000982 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000983
Tobias Grossera535dff2015-12-13 19:59:01 +0000984 ScopArrayInfo::MemoryKind Ty;
985 if (Access->isPHIKind())
986 Ty = ScopArrayInfo::MK_PHI;
987 else if (Access->isExitPHIKind())
988 Ty = ScopArrayInfo::MK_ExitPHI;
989 else if (Access->isValueKind())
990 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000991 else
Tobias Grossera535dff2015-12-13 19:59:01 +0000992 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000993
Johannes Doerfertadeab372016-02-07 13:57:32 +0000994 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
995 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +0000996 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +0000997 }
998}
999
Michael Krusecac948e2015-10-02 13:53:07 +00001000void ScopStmt::addAccess(MemoryAccess *Access) {
1001 Instruction *AccessInst = Access->getAccessInstruction();
1002
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001003 if (Access->isArrayKind()) {
1004 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1005 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001006 } else if (Access->isValueKind() && Access->isWrite()) {
1007 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001008 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001009 assert(!ValueWrites.lookup(AccessVal));
1010
1011 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001012 } else if (Access->isValueKind() && Access->isRead()) {
1013 Value *AccessVal = Access->getAccessValue();
1014 assert(!ValueReads.lookup(AccessVal));
1015
1016 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001017 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
1018 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
1019 assert(!PHIWrites.lookup(PHI));
1020
1021 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001022 }
1023
1024 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001025}
1026
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001027void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001028 for (MemoryAccess *MA : *this)
1029 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001030
1031 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001032}
1033
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001034/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1035static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1036 void *User) {
1037 isl_set **BoundedParts = static_cast<isl_set **>(User);
1038 if (isl_basic_set_is_bounded(BSet))
1039 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1040 else
1041 isl_basic_set_free(BSet);
1042 return isl_stat_ok;
1043}
1044
1045/// @brief Return the bounded parts of @p S.
1046static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1047 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1048 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1049 isl_set_free(S);
1050 return BoundedParts;
1051}
1052
1053/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1054///
1055/// @returns A separation of @p S into first an unbounded then a bounded subset,
1056/// both with regards to the dimension @p Dim.
1057static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1058partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1059
1060 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001061 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001062
1063 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001064 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001065
1066 // Remove dimensions that are greater than Dim as they are not interesting.
1067 assert(NumDimsS >= Dim + 1);
1068 OnlyDimS =
1069 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1070
1071 // Create artificial parametric upper bounds for dimensions smaller than Dim
1072 // as we are not interested in them.
1073 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1074 for (unsigned u = 0; u < Dim; u++) {
1075 isl_constraint *C = isl_inequality_alloc(
1076 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1077 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1078 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1079 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1080 }
1081
1082 // Collect all bounded parts of OnlyDimS.
1083 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1084
1085 // Create the dimensions greater than Dim again.
1086 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1087 NumDimsS - Dim - 1);
1088
1089 // Remove the artificial upper bound parameters again.
1090 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1091
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001092 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001093 return std::make_pair(UnboundedParts, BoundedParts);
1094}
1095
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001096/// @brief Set the dimension Ids from @p From in @p To.
1097static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1098 __isl_take isl_set *To) {
1099 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1100 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1101 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1102 }
1103 return To;
1104}
1105
1106/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001107static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001108 __isl_take isl_pw_aff *L,
1109 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001110 switch (Pred) {
1111 case ICmpInst::ICMP_EQ:
1112 return isl_pw_aff_eq_set(L, R);
1113 case ICmpInst::ICMP_NE:
1114 return isl_pw_aff_ne_set(L, R);
1115 case ICmpInst::ICMP_SLT:
1116 return isl_pw_aff_lt_set(L, R);
1117 case ICmpInst::ICMP_SLE:
1118 return isl_pw_aff_le_set(L, R);
1119 case ICmpInst::ICMP_SGT:
1120 return isl_pw_aff_gt_set(L, R);
1121 case ICmpInst::ICMP_SGE:
1122 return isl_pw_aff_ge_set(L, R);
1123 case ICmpInst::ICMP_ULT:
1124 return isl_pw_aff_lt_set(L, R);
1125 case ICmpInst::ICMP_UGT:
1126 return isl_pw_aff_gt_set(L, R);
1127 case ICmpInst::ICMP_ULE:
1128 return isl_pw_aff_le_set(L, R);
1129 case ICmpInst::ICMP_UGE:
1130 return isl_pw_aff_ge_set(L, R);
1131 default:
1132 llvm_unreachable("Non integer predicate not supported");
1133 }
1134}
1135
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001136/// @brief Create the conditions under which @p L @p Pred @p R is true.
1137///
1138/// Helper function that will make sure the dimensions of the result have the
1139/// same isl_id's as the @p Domain.
1140static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1141 __isl_take isl_pw_aff *L,
1142 __isl_take isl_pw_aff *R,
1143 __isl_keep isl_set *Domain) {
1144 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1145 return setDimensionIds(Domain, ConsequenceCondSet);
1146}
1147
1148/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001149///
1150/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001151/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1152/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001153static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001154buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001155 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1156
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001157 Value *Condition = getConditionFromTerminator(SI);
1158 assert(Condition && "No condition for switch");
1159
1160 ScalarEvolution &SE = *S.getSE();
1161 BasicBlock *BB = SI->getParent();
1162 isl_pw_aff *LHS, *RHS;
1163 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
1164
1165 unsigned NumSuccessors = SI->getNumSuccessors();
1166 ConditionSets.resize(NumSuccessors);
1167 for (auto &Case : SI->cases()) {
1168 unsigned Idx = Case.getSuccessorIndex();
1169 ConstantInt *CaseValue = Case.getCaseValue();
1170
1171 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
1172 isl_set *CaseConditionSet =
1173 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1174 ConditionSets[Idx] = isl_set_coalesce(
1175 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1176 }
1177
1178 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1179 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1180 for (unsigned u = 2; u < NumSuccessors; u++)
1181 ConditionSetUnion =
1182 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1183 ConditionSets[0] = setDimensionIds(
1184 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1185
1186 S.markAsOptimized();
1187 isl_pw_aff_free(LHS);
1188}
1189
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001190/// @brief Build the conditions sets for the branch condition @p Condition in
1191/// the @p Domain.
1192///
1193/// This will fill @p ConditionSets with the conditions under which control
1194/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001195/// have as many elements as @p TI has successors. If @p TI is nullptr the
1196/// context under which @p Condition is true/false will be returned as the
1197/// new elements of @p ConditionSets.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001198static void
1199buildConditionSets(Scop &S, Value *Condition, TerminatorInst *TI, Loop *L,
1200 __isl_keep isl_set *Domain,
1201 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1202
1203 isl_set *ConsequenceCondSet = nullptr;
1204 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1205 if (CCond->isZero())
1206 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1207 else
1208 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1209 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1210 auto Opcode = BinOp->getOpcode();
1211 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1212
1213 buildConditionSets(S, BinOp->getOperand(0), TI, L, Domain, ConditionSets);
1214 buildConditionSets(S, BinOp->getOperand(1), TI, L, Domain, ConditionSets);
1215
1216 isl_set_free(ConditionSets.pop_back_val());
1217 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1218 isl_set_free(ConditionSets.pop_back_val());
1219 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1220
1221 if (Opcode == Instruction::And)
1222 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1223 else
1224 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1225 } else {
1226 auto *ICond = dyn_cast<ICmpInst>(Condition);
1227 assert(ICond &&
1228 "Condition of exiting branch was neither constant nor ICmp!");
1229
1230 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001231 BasicBlock *BB = TI ? TI->getParent() : nullptr;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001232 isl_pw_aff *LHS, *RHS;
1233 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1234 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
1235 ConsequenceCondSet =
1236 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1237 }
1238
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001239 // If no terminator was given we are only looking for parameter constraints
1240 // under which @p Condition is true/false.
1241 if (!TI)
1242 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
1243
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001244 assert(ConsequenceCondSet);
1245 isl_set *AlternativeCondSet =
1246 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1247
1248 ConditionSets.push_back(isl_set_coalesce(
1249 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1250 ConditionSets.push_back(isl_set_coalesce(
1251 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1252}
1253
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001254/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1255///
1256/// This will fill @p ConditionSets with the conditions under which control
1257/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1258/// have as many elements as @p TI has successors.
1259static void
1260buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1261 __isl_keep isl_set *Domain,
1262 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1263
1264 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1265 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1266
1267 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1268
1269 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001270 ConditionSets.push_back(isl_set_copy(Domain));
1271 return;
1272 }
1273
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001274 Value *Condition = getConditionFromTerminator(TI);
1275 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001276
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001277 return buildConditionSets(S, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001278}
1279
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001280void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001281 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001282
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001283 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001284 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001285}
1286
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001287void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1288 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001289 isl_ctx *Ctx = Parent.getIslCtx();
1290 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1291 Type *Ty = GEP->getPointerOperandType();
1292 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001293
1294 // The set of loads that are required to be invariant.
1295 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001296
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001297 std::vector<const SCEV *> Subscripts;
1298 std::vector<int> Sizes;
1299
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001300 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001301
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001302 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001303 Ty = PtrTy->getElementType();
1304 }
1305
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001306 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001307
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001308 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001309
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001310 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001311 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001312 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001313
Johannes Doerfert09e36972015-10-07 20:17:36 +00001314 InvariantLoadsSetTy AccessILS;
1315 if (!isAffineExpr(&Parent.getRegion(), Expr, SE, nullptr, &AccessILS))
1316 continue;
1317
1318 bool NonAffine = false;
1319 for (LoadInst *LInst : AccessILS)
1320 if (!ScopRIL.count(LInst))
1321 NonAffine = true;
1322
1323 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001324 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001325
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001326 isl_pw_aff *AccessOffset = getPwAff(Expr);
1327 AccessOffset =
1328 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001329
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001330 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1331 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001332
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001333 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1334 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1335 OutOfBound = isl_set_params(OutOfBound);
1336 isl_set *InBound = isl_set_complement(OutOfBound);
1337 isl_set *Executed = isl_set_params(getDomain());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001338
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001339 // A => B == !A or B
1340 isl_set *InBoundIfExecuted =
1341 isl_set_union(isl_set_complement(Executed), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001342
Roman Gareev10595a12016-01-08 14:01:59 +00001343 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001344 Parent.addAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001345 }
1346
1347 isl_local_space_free(LSpace);
1348}
1349
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001350void ScopStmt::deriveAssumptions(BasicBlock *Block, ScopDetection &SD) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001351 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001352 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001353 deriveAssumptionsFromGEP(GEP, SD);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001354}
1355
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001356void ScopStmt::collectSurroundingLoops() {
1357 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1358 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1359 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1360 isl_id_free(DimId);
1361 }
1362}
1363
Michael Kruse9d080092015-09-11 21:41:48 +00001364ScopStmt::ScopStmt(Scop &parent, Region &R)
Michael Krusecac948e2015-10-02 13:53:07 +00001365 : Parent(parent), Domain(nullptr), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001366
Tobias Grosser16c44032015-07-09 07:31:45 +00001367 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001368}
1369
Michael Kruse9d080092015-09-11 21:41:48 +00001370ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Michael Krusecac948e2015-10-02 13:53:07 +00001371 : Parent(parent), Domain(nullptr), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001372
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001373 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001374}
1375
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001376void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001377 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001378
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001379 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001380 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001381 buildAccessRelations();
1382
1383 if (BB) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001384 deriveAssumptions(BB, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001385 } else {
1386 for (BasicBlock *Block : R->blocks()) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001387 deriveAssumptions(Block, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001388 }
1389 }
1390
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001391 if (DetectReductions)
1392 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001393}
1394
Johannes Doerferte58a0122014-06-27 20:31:28 +00001395/// @brief Collect loads which might form a reduction chain with @p StoreMA
1396///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001397/// Check if the stored value for @p StoreMA is a binary operator with one or
1398/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001399/// used only once (by @p StoreMA) and its load operands are also used only
1400/// once, we have found a possible reduction chain. It starts at an operand
1401/// load and includes the binary operator and @p StoreMA.
1402///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001403/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001404/// escape this block or into any other store except @p StoreMA.
1405void ScopStmt::collectCandiateReductionLoads(
1406 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1407 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1408 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001409 return;
1410
1411 // Skip if there is not one binary operator between the load and the store
1412 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001413 if (!BinOp)
1414 return;
1415
1416 // Skip if the binary operators has multiple uses
1417 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001418 return;
1419
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001420 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001421 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1422 return;
1423
Johannes Doerfert9890a052014-07-01 00:32:29 +00001424 // Skip if the binary operator is outside the current SCoP
1425 if (BinOp->getParent() != Store->getParent())
1426 return;
1427
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001428 // Skip if it is a multiplicative reduction and we disabled them
1429 if (DisableMultiplicativeReductions &&
1430 (BinOp->getOpcode() == Instruction::Mul ||
1431 BinOp->getOpcode() == Instruction::FMul))
1432 return;
1433
Johannes Doerferte58a0122014-06-27 20:31:28 +00001434 // Check the binary operator operands for a candidate load
1435 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1436 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1437 if (!PossibleLoad0 && !PossibleLoad1)
1438 return;
1439
1440 // A load is only a candidate if it cannot escape (thus has only this use)
1441 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001442 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001443 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001444 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001445 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001446 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001447}
1448
1449/// @brief Check for reductions in this ScopStmt
1450///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001451/// Iterate over all store memory accesses and check for valid binary reduction
1452/// like chains. For all candidates we check if they have the same base address
1453/// and there are no other accesses which overlap with them. The base address
1454/// check rules out impossible reductions candidates early. The overlap check,
1455/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001456/// guarantees that none of the intermediate results will escape during
1457/// execution of the loop nest. We basically check here that no other memory
1458/// access can access the same memory as the potential reduction.
1459void ScopStmt::checkForReductions() {
1460 SmallVector<MemoryAccess *, 2> Loads;
1461 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1462
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001463 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001464 // stores and collecting possible reduction loads.
1465 for (MemoryAccess *StoreMA : MemAccs) {
1466 if (StoreMA->isRead())
1467 continue;
1468
1469 Loads.clear();
1470 collectCandiateReductionLoads(StoreMA, Loads);
1471 for (MemoryAccess *LoadMA : Loads)
1472 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1473 }
1474
1475 // Then check each possible candidate pair.
1476 for (const auto &CandidatePair : Candidates) {
1477 bool Valid = true;
1478 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1479 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1480
1481 // Skip those with obviously unequal base addresses.
1482 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1483 isl_map_free(LoadAccs);
1484 isl_map_free(StoreAccs);
1485 continue;
1486 }
1487
1488 // And check if the remaining for overlap with other memory accesses.
1489 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1490 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1491 isl_set *AllAccs = isl_map_range(AllAccsRel);
1492
1493 for (MemoryAccess *MA : MemAccs) {
1494 if (MA == CandidatePair.first || MA == CandidatePair.second)
1495 continue;
1496
1497 isl_map *AccRel =
1498 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1499 isl_set *Accs = isl_map_range(AccRel);
1500
1501 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1502 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1503 Valid = Valid && isl_set_is_empty(OverlapAccs);
1504 isl_set_free(OverlapAccs);
1505 }
1506 }
1507
1508 isl_set_free(AllAccs);
1509 if (!Valid)
1510 continue;
1511
Johannes Doerfertf6183392014-07-01 20:52:51 +00001512 const LoadInst *Load =
1513 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1514 MemoryAccess::ReductionType RT =
1515 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1516
Johannes Doerferte58a0122014-06-27 20:31:28 +00001517 // If no overlapping access was found we mark the load and store as
1518 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001519 CandidatePair.first->markAsReductionLike(RT);
1520 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001521 }
Tobias Grosser75805372011-04-29 06:27:02 +00001522}
1523
Tobias Grosser74394f02013-01-14 22:40:23 +00001524std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001525
Tobias Grosser54839312015-04-21 11:37:25 +00001526std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001527 auto *S = getSchedule();
1528 auto Str = stringFromIslObj(S);
1529 isl_map_free(S);
1530 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001531}
1532
Michael Kruse375cb5f2016-02-24 22:08:24 +00001533BasicBlock *ScopStmt::getEntryBlock() const {
1534 if (isBlockStmt())
1535 return getBasicBlock();
1536 return getRegion()->getEntry();
1537}
1538
Michael Kruse7b5caa42016-02-24 22:08:28 +00001539RegionNode *ScopStmt::getRegionNode() const {
1540 if (isRegionStmt())
1541 return getRegion()->getNode();
1542 return getParent()->getRegion().getBBNode(getBasicBlock());
1543}
1544
Tobias Grosser74394f02013-01-14 22:40:23 +00001545unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001546
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001547unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001548
Tobias Grosser75805372011-04-29 06:27:02 +00001549const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1550
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001551const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001552 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001553}
1554
Tobias Grosser74394f02013-01-14 22:40:23 +00001555isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001556
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001557__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001558
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001559__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001560 return isl_set_get_space(Domain);
1561}
1562
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001563__isl_give isl_id *ScopStmt::getDomainId() const {
1564 return isl_set_get_tuple_id(Domain);
1565}
Tobias Grossercd95b772012-08-30 11:49:38 +00001566
Tobias Grosser10120182015-12-16 16:14:03 +00001567ScopStmt::~ScopStmt() { isl_set_free(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001568
1569void ScopStmt::print(raw_ostream &OS) const {
1570 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001571 OS.indent(12) << "Domain :=\n";
1572
1573 if (Domain) {
1574 OS.indent(16) << getDomainStr() << ";\n";
1575 } else
1576 OS.indent(16) << "n/a\n";
1577
Tobias Grosser54839312015-04-21 11:37:25 +00001578 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001579
1580 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001581 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001582 } else
1583 OS.indent(16) << "n/a\n";
1584
Tobias Grosser083d3d32014-06-28 08:59:45 +00001585 for (MemoryAccess *Access : MemAccs)
1586 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001587}
1588
1589void ScopStmt::dump() const { print(dbgs()); }
1590
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001591void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001592 // Remove all memory accesses in @p InvMAs from this statement
1593 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001594 // MK_Value READs have no access instruction, hence would not be removed by
1595 // this function. However, it is only used for invariant LoadInst accesses,
1596 // its arguments are always affine, hence synthesizable, and therefore there
1597 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001598 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001599 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001600 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001601 };
1602 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1603 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001604 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001605 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001606}
1607
Tobias Grosser75805372011-04-29 06:27:02 +00001608//===----------------------------------------------------------------------===//
1609/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001610
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001611void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001612 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1613 isl_set_free(Context);
1614 Context = NewContext;
1615}
1616
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001617/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1618struct SCEVSensitiveParameterRewriter
1619 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1620 ValueToValueMap &VMap;
1621 ScalarEvolution &SE;
1622
1623public:
1624 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1625 : VMap(VMap), SE(SE) {}
1626
1627 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1628 ValueToValueMap &VMap) {
1629 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1630 return SSPR.visit(E);
1631 }
1632
1633 const SCEV *visit(const SCEV *E) {
1634 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1635 }
1636
1637 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1638
1639 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1640 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1641 }
1642
1643 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1644 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1645 }
1646
1647 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1648 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1649 }
1650
1651 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1652 SmallVector<const SCEV *, 4> Operands;
1653 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1654 Operands.push_back(visit(E->getOperand(i)));
1655 return SE.getAddExpr(Operands);
1656 }
1657
1658 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1659 SmallVector<const SCEV *, 4> Operands;
1660 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1661 Operands.push_back(visit(E->getOperand(i)));
1662 return SE.getMulExpr(Operands);
1663 }
1664
1665 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1666 SmallVector<const SCEV *, 4> Operands;
1667 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1668 Operands.push_back(visit(E->getOperand(i)));
1669 return SE.getSMaxExpr(Operands);
1670 }
1671
1672 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1673 SmallVector<const SCEV *, 4> Operands;
1674 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1675 Operands.push_back(visit(E->getOperand(i)));
1676 return SE.getUMaxExpr(Operands);
1677 }
1678
1679 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1680 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1681 }
1682
1683 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1684 auto *Start = visit(E->getStart());
1685 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1686 visit(E->getStepRecurrence(SE)),
1687 E->getLoop(), SCEV::FlagAnyWrap);
1688 return SE.getAddExpr(Start, AddRec);
1689 }
1690
1691 const SCEV *visitUnknown(const SCEVUnknown *E) {
1692 if (auto *NewValue = VMap.lookup(E->getValue()))
1693 return SE.getUnknown(NewValue);
1694 return E;
1695 }
1696};
1697
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001698const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001699 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001700}
1701
Tobias Grosserabfbe632013-02-05 12:09:06 +00001702void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001703 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001704 Parameter = extractConstantFactor(Parameter, *SE).second;
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001705
1706 // Normalize the SCEV to get the representing element for an invariant load.
1707 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1708
Tobias Grosser60b54f12011-11-08 15:41:28 +00001709 if (ParameterIds.find(Parameter) != ParameterIds.end())
1710 continue;
1711
1712 int dimension = Parameters.size();
1713
1714 Parameters.push_back(Parameter);
1715 ParameterIds[Parameter] = dimension;
1716 }
1717}
1718
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001719__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001720 // Normalize the SCEV to get the representing element for an invariant load.
1721 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1722
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001723 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001724
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001725 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001726 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001727
Tobias Grosser8f99c162011-11-15 11:38:55 +00001728 std::string ParameterName;
1729
Craig Topper7fb6e472016-01-31 20:36:20 +00001730 ParameterName = "p_" + utostr(IdIter->second);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001731
Tobias Grosser8f99c162011-11-15 11:38:55 +00001732 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1733 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001734
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001735 // If this parameter references a specific Value and this value has a name
1736 // we use this name as it is likely to be unique and more useful than just
1737 // a number.
1738 if (Val->hasName())
1739 ParameterName = Val->getName();
1740 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001741 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001742 if (LoadOrigin->hasName()) {
1743 ParameterName += "_loaded_from_";
1744 ParameterName +=
1745 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1746 }
1747 }
1748 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001749
Tobias Grosser20532b82014-04-11 17:56:49 +00001750 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1751 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001752}
Tobias Grosser75805372011-04-29 06:27:02 +00001753
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001754isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1755 isl_set *DomainContext = isl_union_set_params(getDomains());
1756 return isl_set_intersect_params(C, DomainContext);
1757}
1758
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001759void Scop::buildBoundaryContext() {
Tobias Grosser4927c8e2015-11-24 12:50:02 +00001760 if (IgnoreIntegerWrapping) {
1761 BoundaryContext = isl_set_universe(getParamSpace());
1762 return;
1763 }
1764
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001765 BoundaryContext = Affinator.getWrappingContext();
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001766
1767 // The isl_set_complement operation used to create the boundary context
1768 // can possibly become very expensive. We bound the compile time of
1769 // this operation by setting a compute out.
1770 //
1771 // TODO: We can probably get around using isl_set_complement and directly
1772 // AST generate BoundaryContext.
1773 long MaxOpsOld = isl_ctx_get_max_operations(getIslCtx());
Tobias Grosserf920fb12015-11-13 16:56:13 +00001774 isl_ctx_reset_operations(getIslCtx());
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001775 isl_ctx_set_max_operations(getIslCtx(), 300000);
1776 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_CONTINUE);
1777
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001778 BoundaryContext = isl_set_complement(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001779
Tobias Grossera52b4da2015-11-11 17:59:53 +00001780 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
1781 isl_set_free(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001782 BoundaryContext = isl_set_empty(getParamSpace());
Tobias Grossera52b4da2015-11-11 17:59:53 +00001783 }
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001784
1785 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
1786 isl_ctx_reset_operations(getIslCtx());
1787 isl_ctx_set_max_operations(getIslCtx(), MaxOpsOld);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001788 BoundaryContext = isl_set_gist_params(BoundaryContext, getContext());
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001789 trackAssumption(WRAPPING, BoundaryContext, DebugLoc());
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001790}
1791
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001792void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1793 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001794 auto *R = &getRegion();
1795 auto &F = *R->getEntry()->getParent();
1796 for (auto &Assumption : AC.assumptions()) {
1797 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1798 if (!CI || CI->getNumArgOperands() != 1)
1799 continue;
1800 if (!DT.dominates(CI->getParent(), R->getEntry()))
1801 continue;
1802
1803 auto *Val = CI->getArgOperand(0);
1804 std::vector<const SCEV *> Params;
1805 if (!isAffineParamConstraint(Val, R, *SE, Params)) {
1806 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1807 CI->getDebugLoc(),
1808 "Non-affine user assumption ignored.");
1809 continue;
1810 }
1811
1812 addParams(Params);
1813
1814 auto *L = LI.getLoopFor(CI->getParent());
1815 SmallVector<isl_set *, 2> ConditionSets;
1816 buildConditionSets(*this, Val, nullptr, L, Context, ConditionSets);
1817 assert(ConditionSets.size() == 2);
1818 isl_set_free(ConditionSets[1]);
1819
1820 auto *AssumptionCtx = ConditionSets[0];
1821 emitOptimizationRemarkAnalysis(
1822 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1823 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1824 Context = isl_set_intersect(Context, AssumptionCtx);
1825 }
1826}
1827
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001828void Scop::addUserContext() {
1829 if (UserContextStr.empty())
1830 return;
1831
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001832 isl_set *UserContext =
1833 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001834 isl_space *Space = getParamSpace();
1835 if (isl_space_dim(Space, isl_dim_param) !=
1836 isl_set_dim(UserContext, isl_dim_param)) {
1837 auto SpaceStr = isl_space_to_str(Space);
1838 errs() << "Error: the context provided in -polly-context has not the same "
1839 << "number of dimensions than the computed context. Due to this "
1840 << "mismatch, the -polly-context option is ignored. Please provide "
1841 << "the context in the parameter space: " << SpaceStr << ".\n";
1842 free(SpaceStr);
1843 isl_set_free(UserContext);
1844 isl_space_free(Space);
1845 return;
1846 }
1847
1848 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001849 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1850 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001851
1852 if (strcmp(NameContext, NameUserContext) != 0) {
1853 auto SpaceStr = isl_space_to_str(Space);
1854 errs() << "Error: the name of dimension " << i
1855 << " provided in -polly-context "
1856 << "is '" << NameUserContext << "', but the name in the computed "
1857 << "context is '" << NameContext
1858 << "'. Due to this name mismatch, "
1859 << "the -polly-context option is ignored. Please provide "
1860 << "the context in the parameter space: " << SpaceStr << ".\n";
1861 free(SpaceStr);
1862 isl_set_free(UserContext);
1863 isl_space_free(Space);
1864 return;
1865 }
1866
1867 UserContext =
1868 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1869 isl_space_get_dim_id(Space, isl_dim_param, i));
1870 }
1871
1872 Context = isl_set_intersect(Context, UserContext);
1873 isl_space_free(Space);
1874}
1875
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001876void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001877 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001878
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001879 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001880 for (LoadInst *LInst : RIL) {
1881 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1882
Johannes Doerfert96e54712016-02-07 17:30:13 +00001883 Type *Ty = LInst->getType();
1884 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001885 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001886 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001887 continue;
1888 }
1889
1890 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00001891 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
1892 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001893 }
1894}
1895
Tobias Grosser6be480c2011-11-08 15:41:13 +00001896void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001897 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001898 Context = isl_set_universe(isl_space_copy(Space));
1899 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001900}
1901
Tobias Grosser18daaca2012-05-22 10:47:27 +00001902void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001903 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001904 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001905
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001906 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001907
Johannes Doerferte7044942015-02-24 11:58:30 +00001908 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001909 }
1910}
1911
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001912void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001913 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001914 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001915
Tobias Grosser083d3d32014-06-28 08:59:45 +00001916 for (const auto &ParamID : ParameterIds) {
1917 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001918 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001919 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001920 }
1921
1922 // Align the parameters of all data structures to the model.
1923 Context = isl_set_align_params(Context, Space);
1924
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001925 for (ScopStmt &Stmt : *this)
1926 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001927}
1928
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001929static __isl_give isl_set *
1930simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1931 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00001932 // If we modelt all blocks in the SCoP that have side effects we can simplify
1933 // the context with the constraints that are needed for anything to be
1934 // executed at all. However, if we have error blocks in the SCoP we already
1935 // assumed some parameter combinations cannot occure and removed them from the
1936 // domains, thus we cannot use the remaining domain to simplify the
1937 // assumptions.
1938 if (!S.hasErrorBlock()) {
1939 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1940 AssumptionContext =
1941 isl_set_gist_params(AssumptionContext, DomainParameters);
1942 }
1943
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001944 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1945 return AssumptionContext;
1946}
1947
1948void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001949 // The parameter constraints of the iteration domains give us a set of
1950 // constraints that need to hold for all cases where at least a single
1951 // statement iteration is executed in the whole scop. We now simplify the
1952 // assumed context under the assumption that such constraints hold and at
1953 // least a single statement iteration is executed. For cases where no
1954 // statement instances are executed, the assumptions we have taken about
1955 // the executed code do not matter and can be changed.
1956 //
1957 // WARNING: This only holds if the assumptions we have taken do not reduce
1958 // the set of statement instances that are executed. Otherwise we
1959 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001960 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001961 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001962 // performed. In such a case, modifying the run-time conditions and
1963 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001964 // to not be executed.
1965 //
1966 // Example:
1967 //
1968 // When delinearizing the following code:
1969 //
1970 // for (long i = 0; i < 100; i++)
1971 // for (long j = 0; j < m; j++)
1972 // A[i+p][j] = 1.0;
1973 //
1974 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001975 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001976 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001977 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
1978 BoundaryContext = simplifyAssumptionContext(BoundaryContext, *this);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001979}
1980
Johannes Doerfertb164c792014-09-18 11:17:17 +00001981/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001982static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001983 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1984 isl_pw_multi_aff *MinPMA, *MaxPMA;
1985 isl_pw_aff *LastDimAff;
1986 isl_aff *OneAff;
1987 unsigned Pos;
1988
Johannes Doerfert9143d672014-09-27 11:02:39 +00001989 // Restrict the number of parameters involved in the access as the lexmin/
1990 // lexmax computation will take too long if this number is high.
1991 //
1992 // Experiments with a simple test case using an i7 4800MQ:
1993 //
1994 // #Parameters involved | Time (in sec)
1995 // 6 | 0.01
1996 // 7 | 0.04
1997 // 8 | 0.12
1998 // 9 | 0.40
1999 // 10 | 1.54
2000 // 11 | 6.78
2001 // 12 | 30.38
2002 //
2003 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
2004 unsigned InvolvedParams = 0;
2005 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
2006 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
2007 InvolvedParams++;
2008
2009 if (InvolvedParams > RunTimeChecksMaxParameters) {
2010 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002011 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002012 }
2013 }
2014
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00002015 Set = isl_set_remove_divs(Set);
2016
Johannes Doerfertb164c792014-09-18 11:17:17 +00002017 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2018 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2019
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002020 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2021 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2022
Johannes Doerfertb164c792014-09-18 11:17:17 +00002023 // Adjust the last dimension of the maximal access by one as we want to
2024 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2025 // we test during code generation might now point after the end of the
2026 // allocated array but we will never dereference it anyway.
2027 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2028 "Assumed at least one output dimension");
2029 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2030 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2031 OneAff = isl_aff_zero_on_domain(
2032 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2033 OneAff = isl_aff_add_constant_si(OneAff, 1);
2034 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2035 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2036
2037 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2038
2039 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002040 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002041}
2042
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002043static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2044 isl_set *Domain = MA->getStatement()->getDomain();
2045 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2046 return isl_set_reset_tuple_id(Domain);
2047}
2048
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002049/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2050static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002051 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002052 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002053
2054 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2055 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002056 Locations = isl_union_set_coalesce(Locations);
2057 Locations = isl_union_set_detect_equalities(Locations);
2058 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002059 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002060 isl_union_set_free(Locations);
2061 return Valid;
2062}
2063
Johannes Doerfert96425c22015-08-30 21:13:53 +00002064/// @brief Helper to treat non-affine regions and basic blocks the same.
2065///
2066///{
2067
2068/// @brief Return the block that is the representing block for @p RN.
2069static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2070 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2071 : RN->getNodeAs<BasicBlock>();
2072}
2073
2074/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002075static inline BasicBlock *
2076getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002077 if (RN->isSubRegion()) {
2078 assert(idx == 0);
2079 return RN->getNodeAs<Region>()->getExit();
2080 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002081 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002082}
2083
2084/// @brief Return the smallest loop surrounding @p RN.
2085static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2086 if (!RN->isSubRegion())
2087 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2088
2089 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2090 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2091 while (L && NonAffineSubRegion->contains(L))
2092 L = L->getParentLoop();
2093 return L;
2094}
2095
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002096static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2097 if (!RN->isSubRegion())
2098 return 1;
2099
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002100 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002101 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002102}
2103
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002104static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2105 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002106 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002107 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002108 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002109 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002110 return true;
2111 return false;
2112}
2113
Johannes Doerfert96425c22015-08-30 21:13:53 +00002114///}
2115
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002116static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2117 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002118 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002119 isl_id *DimId =
2120 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2121 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2122}
2123
Johannes Doerfert96425c22015-08-30 21:13:53 +00002124isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002125 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002126}
2127
2128isl_set *Scop::getDomainConditions(BasicBlock *BB) {
2129 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002130 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002131}
2132
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002133void Scop::removeErrorBlockDomains(ScopDetection &SD, DominatorTree &DT,
2134 LoopInfo &LI) {
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002135 auto removeDomains = [this, &DT](BasicBlock *Start) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002136 auto *BBNode = DT.getNode(Start);
2137 for (auto *ErrorChild : depth_first(BBNode)) {
2138 auto *ErrorChildBlock = ErrorChild->getBlock();
2139 auto *CurrentDomain = DomainMap[ErrorChildBlock];
2140 auto *Empty = isl_set_empty(isl_set_get_space(CurrentDomain));
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002141 DomainMap[ErrorChildBlock] = Empty;
2142 isl_set_free(CurrentDomain);
2143 }
2144 };
2145
Tobias Grosser5ef2bc32015-11-23 10:18:23 +00002146 SmallVector<Region *, 4> Todo = {&R};
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002147
2148 while (!Todo.empty()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002149 auto *SubRegion = Todo.back();
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002150 Todo.pop_back();
2151
2152 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
2153 for (auto &Child : *SubRegion)
2154 Todo.push_back(Child.get());
2155 continue;
2156 }
2157 if (containsErrorBlock(SubRegion->getNode(), getRegion(), LI, DT))
2158 removeDomains(SubRegion->getEntry());
2159 }
2160
Johannes Doerferta90943d2016-02-21 16:37:25 +00002161 for (auto *BB : R.blocks())
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002162 if (isErrorBlock(*BB, R, LI, DT))
2163 removeDomains(BB);
2164}
2165
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002166void Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
2167 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002168
Johannes Doerfert432658d2016-01-26 11:01:41 +00002169 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002170 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002171 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2172 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002173 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002174
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002175 while (LD-- >= 0) {
2176 S = addDomainDimId(S, LD + 1, L);
2177 L = L->getParentLoop();
2178 }
2179
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002180 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002181
Johannes Doerfert432658d2016-01-26 11:01:41 +00002182 if (IsOnlyNonAffineRegion)
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002183 return;
2184
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002185 buildDomainsWithBranchConstraints(R, SD, DT, LI);
2186 propagateDomainConstraints(R, SD, DT, LI);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002187
2188 // Error blocks and blocks dominated by them have been assumed to never be
2189 // executed. Representing them in the Scop does not add any value. In fact,
2190 // it is likely to cause issues during construction of the ScopStmts. The
2191 // contents of error blocks have not been verfied to be expressible and
2192 // will cause problems when building up a ScopStmt for them.
2193 // Furthermore, basic blocks dominated by error blocks may reference
2194 // instructions in the error block which, if the error block is not modeled,
2195 // can themselves not be constructed properly.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002196 removeErrorBlockDomains(SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002197}
2198
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002199void Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002200 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002201 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002202
2203 // To create the domain for each block in R we iterate over all blocks and
2204 // subregions in R and propagate the conditions under which the current region
2205 // element is executed. To this end we iterate in reverse post order over R as
2206 // it ensures that we first visit all predecessors of a region node (either a
2207 // basic block or a subregion) before we visit the region node itself.
2208 // Initially, only the domain for the SCoP region entry block is set and from
2209 // there we propagate the current domain to all successors, however we add the
2210 // condition that the successor is actually executed next.
2211 // As we are only interested in non-loop carried constraints here we can
2212 // simply skip loop back edges.
2213
2214 ReversePostOrderTraversal<Region *> RTraversal(R);
2215 for (auto *RN : RTraversal) {
2216
2217 // Recurse for affine subregions but go on for basic blocks and non-affine
2218 // subregions.
2219 if (RN->isSubRegion()) {
2220 Region *SubRegion = RN->getNodeAs<Region>();
2221 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002222 buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002223 continue;
2224 }
2225 }
2226
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002227 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002228 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002229
Johannes Doerfert96425c22015-08-30 21:13:53 +00002230 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002231 TerminatorInst *TI = BB->getTerminator();
2232
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002233 if (isa<UnreachableInst>(TI))
2234 continue;
2235
Johannes Doerfertf5673802015-10-01 23:48:18 +00002236 isl_set *Domain = DomainMap.lookup(BB);
2237 if (!Domain) {
2238 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2239 << ", it is only reachable from error blocks.\n");
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002240 continue;
2241 }
2242
Johannes Doerfert96425c22015-08-30 21:13:53 +00002243 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002244
2245 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2246 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2247
2248 // Build the condition sets for the successor nodes of the current region
2249 // node. If it is a non-affine subregion we will always execute the single
2250 // exit node, hence the single entry node domain is the condition set. For
2251 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002252 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002253 if (RN->isSubRegion())
2254 ConditionSets.push_back(isl_set_copy(Domain));
2255 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002256 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002257
2258 // Now iterate over the successors and set their initial domain based on
2259 // their condition set. We skip back edges here and have to be careful when
2260 // we leave a loop not to keep constraints over a dimension that doesn't
2261 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002262 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002263 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002264 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002265 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002266
2267 // Skip back edges.
2268 if (DT.dominates(SuccBB, BB)) {
2269 isl_set_free(CondSet);
2270 continue;
2271 }
2272
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002273 // Do not adjust the number of dimensions if we enter a boxed loop or are
2274 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002275 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002276 while (BoxedLoops.count(SuccBBLoop))
2277 SuccBBLoop = SuccBBLoop->getParentLoop();
Johannes Doerfert634909c2015-10-04 14:57:41 +00002278
2279 if (BBLoop != SuccBBLoop) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002280
2281 // Check if the edge to SuccBB is a loop entry or exit edge. If so
2282 // adjust the dimensionality accordingly. Lastly, if we leave a loop
2283 // and enter a new one we need to drop the old constraints.
2284 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002285 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002286 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002287 CondSet = isl_set_project_out(CondSet, isl_dim_set,
2288 isl_set_n_dim(CondSet) - LoopDepthDiff,
2289 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002290 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002291 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002292 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002293 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002294 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002295 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002296 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
2297 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002298 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002299 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002300 }
2301
2302 // Set the domain for the successor or merge it with an existing domain in
2303 // case there are multiple paths (without loop back edges) to the
2304 // successor block.
2305 isl_set *&SuccDomain = DomainMap[SuccBB];
2306 if (!SuccDomain)
2307 SuccDomain = CondSet;
2308 else
2309 SuccDomain = isl_set_union(SuccDomain, CondSet);
2310
2311 SuccDomain = isl_set_coalesce(SuccDomain);
Tobias Grosser75dc40c2015-12-20 13:31:48 +00002312 if (isl_set_n_basic_set(SuccDomain) > MaxConjunctsInDomain) {
2313 auto *Empty = isl_set_empty(isl_set_get_space(SuccDomain));
2314 isl_set_free(SuccDomain);
2315 SuccDomain = Empty;
2316 invalidate(ERROR_DOMAINCONJUNCTS, DebugLoc());
2317 }
Johannes Doerfert634909c2015-10-04 14:57:41 +00002318 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : "
2319 << SuccDomain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002320 }
2321 }
2322}
2323
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002324/// @brief Return the domain for @p BB wrt @p DomainMap.
2325///
2326/// This helper function will lookup @p BB in @p DomainMap but also handle the
2327/// case where @p BB is contained in a non-affine subregion using the region
2328/// tree obtained by @p RI.
2329static __isl_give isl_set *
2330getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
2331 RegionInfo &RI) {
2332 auto DIt = DomainMap.find(BB);
2333 if (DIt != DomainMap.end())
2334 return isl_set_copy(DIt->getSecond());
2335
2336 Region *R = RI.getRegionFor(BB);
2337 while (R->getEntry() == BB)
2338 R = R->getParent();
2339 return getDomainForBlock(R->getEntry(), DomainMap, RI);
2340}
2341
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002342void Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002343 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002344 // Iterate over the region R and propagate the domain constrains from the
2345 // predecessors to the current node. In contrast to the
2346 // buildDomainsWithBranchConstraints function, this one will pull the domain
2347 // information from the predecessors instead of pushing it to the successors.
2348 // Additionally, we assume the domains to be already present in the domain
2349 // map here. However, we iterate again in reverse post order so we know all
2350 // predecessors have been visited before a block or non-affine subregion is
2351 // visited.
2352
2353 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2354 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2355
2356 ReversePostOrderTraversal<Region *> RTraversal(R);
2357 for (auto *RN : RTraversal) {
2358
2359 // Recurse for affine subregions but go on for basic blocks and non-affine
2360 // subregions.
2361 if (RN->isSubRegion()) {
2362 Region *SubRegion = RN->getNodeAs<Region>();
2363 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002364 propagateDomainConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002365 continue;
2366 }
2367 }
2368
Johannes Doerfertf5673802015-10-01 23:48:18 +00002369 // Get the domain for the current block and check if it was initialized or
2370 // not. The only way it was not is if this block is only reachable via error
2371 // blocks, thus will not be executed under the assumptions we make. Such
2372 // blocks have to be skipped as their predecessors might not have domains
2373 // either. It would not benefit us to compute the domain anyway, only the
2374 // domains of the error blocks that are reachable from non-error blocks
2375 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002376 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002377 isl_set *&Domain = DomainMap[BB];
2378 if (!Domain) {
2379 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2380 << ", it is only reachable from error blocks.\n");
2381 DomainMap.erase(BB);
2382 continue;
2383 }
2384 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
2385
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002386 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2387 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2388
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002389 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2390 for (auto *PredBB : predecessors(BB)) {
2391
2392 // Skip backedges
2393 if (DT.dominates(BB, PredBB))
2394 continue;
2395
2396 isl_set *PredBBDom = nullptr;
2397
2398 // Handle the SCoP entry block with its outside predecessors.
2399 if (!getRegion().contains(PredBB))
2400 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
2401
2402 if (!PredBBDom) {
2403 // Determine the loop depth of the predecessor and adjust its domain to
2404 // the domain of the current block. This can mean we have to:
2405 // o) Drop a dimension if this block is the exit of a loop, not the
2406 // header of a new loop and the predecessor was part of the loop.
2407 // o) Add an unconstrainted new dimension if this block is the header
2408 // of a loop and the predecessor is not part of it.
2409 // o) Drop the information about the innermost loop dimension when the
2410 // predecessor and the current block are surrounded by different
2411 // loops in the same depth.
2412 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
2413 Loop *PredBBLoop = LI.getLoopFor(PredBB);
2414 while (BoxedLoops.count(PredBBLoop))
2415 PredBBLoop = PredBBLoop->getParentLoop();
2416
2417 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002418 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002419 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002420 PredBBDom = isl_set_project_out(
2421 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
2422 LoopDepthDiff);
2423 else if (PredBBLoopDepth < BBLoopDepth) {
2424 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002425 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002426 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
2427 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002428 PredBBDom = isl_set_drop_constraints_involving_dims(
2429 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002430 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002431 }
2432
2433 PredDom = isl_set_union(PredDom, PredBBDom);
2434 }
2435
2436 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00002437 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002438
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002439 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002440 addLoopBoundsToHeaderDomain(BBLoop, LI);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002441
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002442 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002443 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002444 IsOptimized = true;
2445 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002446 addAssumption(ERRORBLOCK, isl_set_complement(DomPar),
2447 BB->getTerminator()->getDebugLoc());
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002448 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002449 }
2450}
2451
2452/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2453/// is incremented by one and all other dimensions are equal, e.g.,
2454/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2455/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2456static __isl_give isl_map *
2457createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2458 auto *MapSpace = isl_space_map_from_set(SetSpace);
2459 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2460 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2461 if (u != Dim)
2462 NextIterationMap =
2463 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2464 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2465 C = isl_constraint_set_constant_si(C, 1);
2466 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2467 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2468 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2469 return NextIterationMap;
2470}
2471
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002472void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002473 int LoopDepth = getRelativeLoopDepth(L);
2474 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002475
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002476 BasicBlock *HeaderBB = L->getHeader();
2477 assert(DomainMap.count(HeaderBB));
2478 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002479
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002480 isl_map *NextIterationMap =
2481 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002482
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002483 isl_set *UnionBackedgeCondition =
2484 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002485
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002486 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2487 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002488
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002489 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002490
2491 // If the latch is only reachable via error statements we skip it.
2492 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2493 if (!LatchBBDom)
2494 continue;
2495
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002496 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002497
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002498 TerminatorInst *TI = LatchBB->getTerminator();
2499 BranchInst *BI = dyn_cast<BranchInst>(TI);
2500 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002501 BackedgeCondition = isl_set_copy(LatchBBDom);
2502 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002503 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002504 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002505 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002506
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002507 // Free the non back edge condition set as we do not need it.
2508 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002509
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002510 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002511 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002512
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002513 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2514 assert(LatchLoopDepth >= LoopDepth);
2515 BackedgeCondition =
2516 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2517 LatchLoopDepth - LoopDepth);
2518 UnionBackedgeCondition =
2519 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002520 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002521
2522 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2523 for (int i = 0; i < LoopDepth; i++)
2524 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2525
2526 isl_set *UnionBackedgeConditionComplement =
2527 isl_set_complement(UnionBackedgeCondition);
2528 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2529 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2530 UnionBackedgeConditionComplement =
2531 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2532 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2533 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2534
2535 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2536 HeaderBBDom = Parts.second;
2537
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002538 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2539 // the bounded assumptions to the context as they are already implied by the
2540 // <nsw> tag.
2541 if (Affinator.hasNSWAddRecForLoop(L)) {
2542 isl_set_free(Parts.first);
2543 return;
2544 }
2545
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002546 isl_set *UnboundedCtx = isl_set_params(Parts.first);
2547 isl_set *BoundedCtx = isl_set_complement(UnboundedCtx);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002548 addAssumption(INFINITELOOP, BoundedCtx,
2549 HeaderBB->getTerminator()->getDebugLoc());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002550}
2551
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002552void Scop::buildAliasChecks(AliasAnalysis &AA) {
2553 if (!PollyUseRuntimeAliasChecks)
2554 return;
2555
2556 if (buildAliasGroups(AA))
2557 return;
2558
2559 // If a problem occurs while building the alias groups we need to delete
2560 // this SCoP and pretend it wasn't valid in the first place. To this end
2561 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002562 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002563
2564 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2565 << " could not be created as the number of parameters involved "
2566 "is too high. The SCoP will be "
2567 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2568 "the maximal number of parameters but be advised that the "
2569 "compile time might increase exponentially.\n\n");
2570}
2571
Johannes Doerfert9143d672014-09-27 11:02:39 +00002572bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002573 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002574 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002575 // for all memory accesses inside the SCoP.
2576 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002577 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002578 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002579 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002580 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002581 // if their access domains intersect, otherwise they are in different
2582 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002583 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002584 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002585 // and maximal accesses to each array of a group in read only and non
2586 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002587 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2588
2589 AliasSetTracker AST(AA);
2590
2591 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002592 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002593 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002594
2595 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002596 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002597 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2598 isl_set_free(StmtDomain);
2599 if (StmtDomainEmpty)
2600 continue;
2601
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002602 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002603 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002604 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002605 if (!MA->isRead())
2606 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002607 MemAccInst Acc(MA->getAccessInstruction());
Johannes Doerfertcea61932016-02-21 19:13:19 +00002608 if (MA->isRead() && Acc.isMemTransferInst())
2609 PtrToAcc[Acc.asMemTransferInst()->getSource()] = MA;
2610 else
2611 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002612 AST.add(Acc);
2613 }
2614 }
2615
2616 SmallVector<AliasGroupTy, 4> AliasGroups;
2617 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002618 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002619 continue;
2620 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002621 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002622 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002623 if (AG.size() < 2)
2624 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002625 AliasGroups.push_back(std::move(AG));
2626 }
2627
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002628 // Split the alias groups based on their domain.
2629 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2630 AliasGroupTy NewAG;
2631 AliasGroupTy &AG = AliasGroups[u];
2632 AliasGroupTy::iterator AGI = AG.begin();
2633 isl_set *AGDomain = getAccessDomain(*AGI);
2634 while (AGI != AG.end()) {
2635 MemoryAccess *MA = *AGI;
2636 isl_set *MADomain = getAccessDomain(MA);
2637 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2638 NewAG.push_back(MA);
2639 AGI = AG.erase(AGI);
2640 isl_set_free(MADomain);
2641 } else {
2642 AGDomain = isl_set_union(AGDomain, MADomain);
2643 AGI++;
2644 }
2645 }
2646 if (NewAG.size() > 1)
2647 AliasGroups.push_back(std::move(NewAG));
2648 isl_set_free(AGDomain);
2649 }
2650
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002651 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002652 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002653 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2654 for (AliasGroupTy &AG : AliasGroups) {
2655 NonReadOnlyBaseValues.clear();
2656 ReadOnlyPairs.clear();
2657
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002658 if (AG.size() < 2) {
2659 AG.clear();
2660 continue;
2661 }
2662
Johannes Doerfert13771732014-10-01 12:40:46 +00002663 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002664 emitOptimizationRemarkAnalysis(
2665 F.getContext(), DEBUG_TYPE, F,
2666 (*II)->getAccessInstruction()->getDebugLoc(),
2667 "Possibly aliasing pointer, use restrict keyword.");
2668
Johannes Doerfert13771732014-10-01 12:40:46 +00002669 Value *BaseAddr = (*II)->getBaseAddr();
2670 if (HasWriteAccess.count(BaseAddr)) {
2671 NonReadOnlyBaseValues.insert(BaseAddr);
2672 II++;
2673 } else {
2674 ReadOnlyPairs[BaseAddr].insert(*II);
2675 II = AG.erase(II);
2676 }
2677 }
2678
2679 // If we don't have read only pointers check if there are at least two
2680 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002681 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002682 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002683 continue;
2684 }
2685
2686 // If we don't have non read only pointers clear the alias group.
2687 if (NonReadOnlyBaseValues.empty()) {
2688 AG.clear();
2689 continue;
2690 }
2691
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002692 // Check if we have non-affine accesses left, if so bail out as we cannot
2693 // generate a good access range yet.
2694 for (auto *MA : AG)
2695 if (!MA->isAffine()) {
2696 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2697 return false;
2698 }
2699 for (auto &ReadOnlyPair : ReadOnlyPairs)
2700 for (auto *MA : ReadOnlyPair.second)
2701 if (!MA->isAffine()) {
2702 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2703 return false;
2704 }
2705
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002706 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002707 MinMaxAliasGroups.emplace_back();
2708 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2709 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2710 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2711 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002712
2713 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002714
2715 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002716 for (MemoryAccess *MA : AG)
2717 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002718
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002719 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2720 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002721
2722 // Bail out if the number of values we need to compare is too large.
2723 // This is important as the number of comparisions grows quadratically with
2724 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002725 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2726 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002727 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002728
2729 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002730 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002731 Accesses = isl_union_map_empty(getParamSpace());
2732
2733 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2734 for (MemoryAccess *MA : ReadOnlyPair.second)
2735 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2736
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002737 Valid =
2738 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002739
2740 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002741 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002742 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002743
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002744 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002745}
2746
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002747/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002748static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002749 // Start with the smallest loop containing the entry and expand that
2750 // loop until it contains all blocks in the region. If there is a loop
2751 // containing all blocks in the region check if it is itself contained
2752 // and if so take the parent loop as it will be the smallest containing
2753 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002754 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002755 while (L) {
2756 bool AllContained = true;
2757 for (auto *BB : R.blocks())
2758 AllContained &= L->contains(BB);
2759 if (AllContained)
2760 break;
2761 L = L->getParentLoop();
2762 }
2763
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002764 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2765}
2766
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002767static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2768 ScopDetection &SD) {
2769
2770 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2771
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002772 unsigned MinLD = INT_MAX, MaxLD = 0;
2773 for (BasicBlock *BB : R.blocks()) {
2774 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002775 if (!R.contains(L))
2776 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002777 if (BoxedLoops && BoxedLoops->count(L))
2778 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002779 unsigned LD = L->getLoopDepth();
2780 MinLD = std::min(MinLD, LD);
2781 MaxLD = std::max(MaxLD, LD);
2782 }
2783 }
2784
2785 // Handle the case that there is no loop in the SCoP first.
2786 if (MaxLD == 0)
2787 return 1;
2788
2789 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2790 assert(MaxLD >= MinLD &&
2791 "Maximal loop depth was smaller than mininaml loop depth?");
2792 return MaxLD - MinLD + 1;
2793}
2794
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002795Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00002796 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002797 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002798 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
2799 Context(nullptr), Affinator(this), AssumedContext(nullptr),
2800 BoundaryContext(nullptr), Schedule(nullptr) {
2801 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00002802 buildContext();
2803}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002804
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002805void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002806 DominatorTree &DT, LoopInfo &LI) {
2807 addUserAssumptions(AC, DT, LI);
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002808 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002809
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002810 buildDomains(&R, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002811
Michael Krusecac948e2015-10-02 13:53:07 +00002812 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00002813 // Exit early in case there are no executable statements left in this scop.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002814 simplifySCoP(true, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00002815 if (Stmts.empty())
2816 return;
Tobias Grosser75805372011-04-29 06:27:02 +00002817
Michael Krusecac948e2015-10-02 13:53:07 +00002818 // The ScopStmts now have enough information to initialize themselves.
2819 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002820 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00002821
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002822 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00002823
Tobias Grosser8286b832015-11-02 11:29:32 +00002824 if (isl_set_is_empty(AssumedContext))
2825 return;
2826
2827 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002828 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002829 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002830 addUserContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002831 buildBoundaryContext();
2832 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002833 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002834
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002835 hoistInvariantLoads(SD);
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002836 simplifySCoP(false, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00002837}
2838
2839Scop::~Scop() {
2840 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002841 isl_set_free(AssumedContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002842 isl_set_free(BoundaryContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002843 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002844
Johannes Doerfert96425c22015-08-30 21:13:53 +00002845 for (auto It : DomainMap)
2846 isl_set_free(It.second);
2847
Johannes Doerfertb164c792014-09-18 11:17:17 +00002848 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002849 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002850 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002851 isl_pw_multi_aff_free(MMA.first);
2852 isl_pw_multi_aff_free(MMA.second);
2853 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002854 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002855 isl_pw_multi_aff_free(MMA.first);
2856 isl_pw_multi_aff_free(MMA.second);
2857 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002858 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002859
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002860 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002861 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002862
2863 // Explicitly release all Scop objects and the underlying isl objects before
2864 // we relase the isl context.
2865 Stmts.clear();
2866 ScopArrayInfoMap.clear();
2867 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00002868}
2869
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002870void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00002871 // Check all array accesses for each base pointer and find a (virtual) element
2872 // size for the base pointer that divides all access functions.
2873 for (auto &Stmt : *this)
2874 for (auto *Access : Stmt) {
2875 if (!Access->isArrayKind())
2876 continue;
2877 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
2878 ScopArrayInfo::MK_Array)];
2879 if (SAI->getNumberOfDimensions() != 1)
2880 continue;
2881 unsigned DivisibleSize = SAI->getElemSizeInBytes();
2882 auto *Subscript = Access->getSubscript(0);
2883 while (!isDivisible(Subscript, DivisibleSize, *SE))
2884 DivisibleSize /= 2;
2885 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
2886 SAI->updateElementType(Ty);
2887 }
2888
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002889 for (auto &Stmt : *this)
2890 for (auto &Access : Stmt)
2891 Access->updateDimensionality();
2892}
2893
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002894void Scop::simplifySCoP(bool RemoveIgnoredStmts, DominatorTree &DT,
2895 LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002896 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
2897 ScopStmt &Stmt = *StmtIt;
Michael Kruse7b5caa42016-02-24 22:08:28 +00002898 RegionNode *RN = Stmt.getRegionNode();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002899
Johannes Doerferteca9e892015-11-03 16:54:49 +00002900 bool RemoveStmt = StmtIt->isEmpty();
2901 if (!RemoveStmt)
Michael Kruse375cb5f2016-02-24 22:08:24 +00002902 RemoveStmt = isl_set_is_empty(DomainMap[Stmt.getEntryBlock()]);
Johannes Doerferteca9e892015-11-03 16:54:49 +00002903 if (!RemoveStmt)
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002904 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN, DT, LI));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00002905
Johannes Doerferteca9e892015-11-03 16:54:49 +00002906 // Remove read only statements only after invariant loop hoisting.
2907 if (!RemoveStmt && !RemoveIgnoredStmts) {
2908 bool OnlyRead = true;
2909 for (MemoryAccess *MA : Stmt) {
2910 if (MA->isRead())
2911 continue;
2912
2913 OnlyRead = false;
2914 break;
2915 }
2916
2917 RemoveStmt = OnlyRead;
2918 }
2919
2920 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00002921 // Remove the statement because it is unnecessary.
2922 if (Stmt.isRegionStmt())
2923 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2924 StmtMap.erase(BB);
2925 else
2926 StmtMap.erase(Stmt.getBasicBlock());
2927
2928 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002929 continue;
2930 }
2931
Michael Krusecac948e2015-10-02 13:53:07 +00002932 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002933 }
2934}
2935
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002936const InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) const {
2937 LoadInst *LInst = dyn_cast<LoadInst>(Val);
2938 if (!LInst)
2939 return nullptr;
2940
2941 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
2942 LInst = cast<LoadInst>(Rep);
2943
Johannes Doerfert96e54712016-02-07 17:30:13 +00002944 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002945 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2946 for (auto &IAClass : InvariantEquivClasses)
Johannes Doerfert96e54712016-02-07 17:30:13 +00002947 if (PointerSCEV == std::get<0>(IAClass) && Ty == std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002948 return &IAClass;
2949
2950 return nullptr;
2951}
2952
2953void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
2954
2955 // Get the context under which the statement is executed.
2956 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
2957 DomainCtx = isl_set_remove_redundancies(DomainCtx);
2958 DomainCtx = isl_set_detect_equalities(DomainCtx);
2959 DomainCtx = isl_set_coalesce(DomainCtx);
2960
2961 // Project out all parameters that relate to loads in the statement. Otherwise
2962 // we could have cyclic dependences on the constraints under which the
2963 // hoisted loads are executed and we could not determine an order in which to
2964 // pre-load them. This happens because not only lower bounds are part of the
2965 // domain but also upper bounds.
2966 for (MemoryAccess *MA : InvMAs) {
2967 Instruction *AccInst = MA->getAccessInstruction();
2968 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00002969 SetVector<Value *> Values;
2970 for (const SCEV *Parameter : Parameters) {
2971 Values.clear();
2972 findValues(Parameter, Values);
2973 if (!Values.count(AccInst))
2974 continue;
2975
2976 if (isl_id *ParamId = getIdForParam(Parameter)) {
2977 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
2978 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
2979 isl_id_free(ParamId);
2980 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002981 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002982 }
2983 }
2984
2985 for (MemoryAccess *MA : InvMAs) {
2986 // Check for another invariant access that accesses the same location as
2987 // MA and if found consolidate them. Otherwise create a new equivalence
2988 // class at the end of InvariantEquivClasses.
2989 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00002990 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002991 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2992
2993 bool Consolidated = false;
2994 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002995 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002996 continue;
2997
2998 Consolidated = true;
2999
3000 // Add MA to the list of accesses that are in this class.
3001 auto &MAs = std::get<1>(IAClass);
3002 MAs.push_front(MA);
3003
3004 // Unify the execution context of the class and this statement.
3005 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003006 if (IAClassDomainCtx)
3007 IAClassDomainCtx = isl_set_coalesce(
3008 isl_set_union(IAClassDomainCtx, isl_set_copy(DomainCtx)));
3009 else
3010 IAClassDomainCtx = isl_set_copy(DomainCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003011 break;
3012 }
3013
3014 if (Consolidated)
3015 continue;
3016
3017 // If we did not consolidate MA, thus did not find an equivalence class
3018 // for it, we create a new one.
3019 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA},
Johannes Doerfert96e54712016-02-07 17:30:13 +00003020 isl_set_copy(DomainCtx), Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003021 }
3022
3023 isl_set_free(DomainCtx);
3024}
3025
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003026bool Scop::isHoistableAccess(MemoryAccess *Access,
3027 __isl_keep isl_union_map *Writes) {
3028 // TODO: Loads that are not loop carried, hence are in a statement with
3029 // zero iterators, are by construction invariant, though we
3030 // currently "hoist" them anyway. This is necessary because we allow
3031 // them to be treated as parameters (e.g., in conditions) and our code
3032 // generation would otherwise use the old value.
3033
3034 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003035 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003036
3037 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3038 return false;
3039
3040 // Skip accesses that have an invariant base pointer which is defined but
3041 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3042 // returns a pointer that is used as a base address. However, as we want
3043 // to hoist indirect pointers, we allow the base pointer to be defined in
3044 // the region if it is also a memory access. Each ScopArrayInfo object
3045 // that has a base pointer origin has a base pointer that is loaded and
3046 // that it is invariant, thus it will be hoisted too. However, if there is
3047 // no base pointer origin we check that the base pointer is defined
3048 // outside the region.
3049 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003050 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3051 if (SAI->getBasePtrOriginSAI()) {
3052 assert(BasePtrInst && R.contains(BasePtrInst));
3053 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003054 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003055 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003056 assert(BasePtrStmt);
3057 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3058 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3059 return false;
3060 } else if (BasePtrInst && R.contains(BasePtrInst))
3061 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003062
3063 // Skip accesses in non-affine subregions as they might not be executed
3064 // under the same condition as the entry of the non-affine subregion.
3065 if (BB != Access->getAccessInstruction()->getParent())
3066 return false;
3067
3068 isl_map *AccessRelation = Access->getAccessRelation();
3069
3070 // Skip accesses that have an empty access relation. These can be caused
3071 // by multiple offsets with a type cast in-between that cause the overall
3072 // byte offset to be not divisible by the new types sizes.
3073 if (isl_map_is_empty(AccessRelation)) {
3074 isl_map_free(AccessRelation);
3075 return false;
3076 }
3077
3078 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3079 Stmt.getNumIterators())) {
3080 isl_map_free(AccessRelation);
3081 return false;
3082 }
3083
3084 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3085 isl_set *AccessRange = isl_map_range(AccessRelation);
3086
3087 isl_union_map *Written = isl_union_map_intersect_range(
3088 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3089 bool IsWritten = !isl_union_map_is_empty(Written);
3090 isl_union_map_free(Written);
3091
3092 if (IsWritten)
3093 return false;
3094
3095 return true;
3096}
3097
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003098void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003099 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3100 for (LoadInst *LI : RIL) {
3101 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003102 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003103 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003104 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3105 return;
3106 }
3107 }
3108}
3109
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003110void Scop::hoistInvariantLoads(ScopDetection &SD) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003111 isl_union_map *Writes = getWrites();
3112 for (ScopStmt &Stmt : *this) {
3113
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003114 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003115
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003116 for (MemoryAccess *Access : Stmt)
3117 if (isHoistableAccess(Access, Writes))
3118 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003119
3120 // We inserted invariant accesses always in the front but need them to be
3121 // sorted in a "natural order". The statements are already sorted in reverse
3122 // post order and that suffices for the accesses too. The reason we require
3123 // an order in the first place is the dependences between invariant loads
3124 // that can be caused by indirect loads.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003125 InvariantAccesses.reverse();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003126
3127 // Transfer the memory access from the statement to the SCoP.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003128 Stmt.removeMemoryAccesses(InvariantAccesses);
3129 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003130 }
3131 isl_union_map_free(Writes);
3132
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003133 verifyInvariantLoads(SD);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003134}
3135
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003136const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003137Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003138 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003139 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003140 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003141 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003142 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003143 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003144 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003145 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003146 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003147 // In case of mismatching array sizes, we bail out by setting the run-time
3148 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003149 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003150 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003151 }
Tobias Grosserab671442015-05-23 05:58:27 +00003152 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003153}
3154
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003155const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003156 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003157 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003158 assert(SAI && "No ScopArrayInfo available for this base pointer");
3159 return SAI;
3160}
3161
Tobias Grosser74394f02013-01-14 22:40:23 +00003162std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003163
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003164std::string Scop::getAssumedContextStr() const {
3165 return stringFromIslObj(AssumedContext);
3166}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003167
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003168std::string Scop::getBoundaryContextStr() const {
3169 return stringFromIslObj(BoundaryContext);
3170}
Tobias Grosser75805372011-04-29 06:27:02 +00003171
3172std::string Scop::getNameStr() const {
3173 std::string ExitName, EntryName;
3174 raw_string_ostream ExitStr(ExitName);
3175 raw_string_ostream EntryStr(EntryName);
3176
Tobias Grosserf240b482014-01-09 10:42:15 +00003177 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003178 EntryStr.str();
3179
3180 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003181 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003182 ExitStr.str();
3183 } else
3184 ExitName = "FunctionExit";
3185
3186 return EntryName + "---" + ExitName;
3187}
3188
Tobias Grosser74394f02013-01-14 22:40:23 +00003189__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003190__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003191 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003192}
3193
Tobias Grossere86109f2013-10-29 21:05:49 +00003194__isl_give isl_set *Scop::getAssumedContext() const {
3195 return isl_set_copy(AssumedContext);
3196}
3197
Johannes Doerfert43788c52015-08-20 05:58:56 +00003198__isl_give isl_set *Scop::getRuntimeCheckContext() const {
3199 isl_set *RuntimeCheckContext = getAssumedContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003200 RuntimeCheckContext =
3201 isl_set_intersect(RuntimeCheckContext, getBoundaryContext());
3202 RuntimeCheckContext = simplifyAssumptionContext(RuntimeCheckContext, *this);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003203 return RuntimeCheckContext;
3204}
3205
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003206bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00003207 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003208 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003209 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
3210 isl_set_free(RuntimeCheckContext);
3211 return IsFeasible;
3212}
3213
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003214static std::string toString(AssumptionKind Kind) {
3215 switch (Kind) {
3216 case ALIASING:
3217 return "No-aliasing";
3218 case INBOUNDS:
3219 return "Inbounds";
3220 case WRAPPING:
3221 return "No-overflows";
3222 case ERRORBLOCK:
3223 return "No-error";
3224 case INFINITELOOP:
3225 return "Finite loop";
3226 case INVARIANTLOAD:
3227 return "Invariant load";
3228 case DELINEARIZATION:
3229 return "Delinearization";
Tobias Grosser75dc40c2015-12-20 13:31:48 +00003230 case ERROR_DOMAINCONJUNCTS:
3231 return "Low number of domain conjuncts";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003232 }
3233 llvm_unreachable("Unknown AssumptionKind!");
3234}
3235
3236void Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3237 DebugLoc Loc) {
3238 if (isl_set_is_subset(Context, Set))
3239 return;
3240
3241 if (isl_set_is_subset(AssumedContext, Set))
3242 return;
3243
3244 auto &F = *getRegion().getEntry()->getParent();
3245 std::string Msg = toString(Kind) + " assumption:\t" + stringFromIslObj(Set);
3246 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
3247}
3248
3249void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
3250 DebugLoc Loc) {
3251 trackAssumption(Kind, Set, Loc);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003252 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003253
Johannes Doerfert9d7899e2015-11-11 20:01:31 +00003254 int NSets = isl_set_n_basic_set(AssumedContext);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003255 if (NSets >= MaxDisjunctsAssumed) {
3256 isl_space *Space = isl_set_get_space(AssumedContext);
3257 isl_set_free(AssumedContext);
Tobias Grossere19fca42015-11-11 20:21:39 +00003258 AssumedContext = isl_set_empty(Space);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003259 }
3260
Tobias Grosser7b50bee2014-11-25 10:51:12 +00003261 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003262}
3263
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003264void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
3265 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc);
3266}
3267
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003268__isl_give isl_set *Scop::getBoundaryContext() const {
3269 return isl_set_copy(BoundaryContext);
3270}
3271
Tobias Grosser75805372011-04-29 06:27:02 +00003272void Scop::printContext(raw_ostream &OS) const {
3273 OS << "Context:\n";
3274
3275 if (!Context) {
3276 OS.indent(4) << "n/a\n\n";
3277 return;
3278 }
3279
3280 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003281
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003282 OS.indent(4) << "Assumed Context:\n";
3283 if (!AssumedContext) {
3284 OS.indent(4) << "n/a\n\n";
3285 return;
3286 }
3287
3288 OS.indent(4) << getAssumedContextStr() << "\n";
3289
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003290 OS.indent(4) << "Boundary Context:\n";
3291 if (!BoundaryContext) {
3292 OS.indent(4) << "n/a\n\n";
3293 return;
3294 }
3295
3296 OS.indent(4) << getBoundaryContextStr() << "\n";
3297
Tobias Grosser083d3d32014-06-28 08:59:45 +00003298 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00003299 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00003300 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
3301 }
Tobias Grosser75805372011-04-29 06:27:02 +00003302}
3303
Johannes Doerfertb164c792014-09-18 11:17:17 +00003304void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003305 int noOfGroups = 0;
3306 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003307 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003308 noOfGroups += 1;
3309 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003310 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003311 }
3312
Tobias Grosserbb853c22015-07-25 12:31:03 +00003313 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003314 if (MinMaxAliasGroups.empty()) {
3315 OS.indent(8) << "n/a\n";
3316 return;
3317 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003318
Tobias Grosserbb853c22015-07-25 12:31:03 +00003319 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003320
3321 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003322 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003323 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003324 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003325 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3326 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003327 }
3328 OS << " ]]\n";
3329 }
3330
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003331 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003332 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003333 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003334 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003335 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3336 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003337 }
3338 OS << " ]]\n";
3339 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003340 }
3341}
3342
Tobias Grosser75805372011-04-29 06:27:02 +00003343void Scop::printStatements(raw_ostream &OS) const {
3344 OS << "Statements {\n";
3345
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003346 for (const ScopStmt &Stmt : *this)
3347 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003348
3349 OS.indent(4) << "}\n";
3350}
3351
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003352void Scop::printArrayInfo(raw_ostream &OS) const {
3353 OS << "Arrays {\n";
3354
Tobias Grosserab671442015-05-23 05:58:27 +00003355 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003356 Array.second->print(OS);
3357
3358 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003359
3360 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3361
3362 for (auto &Array : arrays())
3363 Array.second->print(OS, /* SizeAsPwAff */ true);
3364
3365 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003366}
3367
Tobias Grosser75805372011-04-29 06:27:02 +00003368void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003369 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3370 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003371 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003372 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003373 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003374 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003375 const auto &MAs = std::get<1>(IAClass);
3376 if (MAs.empty()) {
3377 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003378 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003379 MAs.front()->print(OS);
3380 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003381 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003382 }
3383 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003384 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003385 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003386 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003387 printStatements(OS.indent(4));
3388}
3389
3390void Scop::dump() const { print(dbgs()); }
3391
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003392isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003393
Johannes Doerfertcef616f2015-09-15 22:49:04 +00003394__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
3395 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003396}
3397
Tobias Grosser808cd692015-07-14 09:33:13 +00003398__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003399 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003400
Tobias Grosser808cd692015-07-14 09:33:13 +00003401 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003402 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003403
3404 return Domain;
3405}
3406
Tobias Grossere5a35142015-11-12 14:07:09 +00003407__isl_give isl_union_map *
3408Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3409 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003410
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003411 for (ScopStmt &Stmt : *this) {
3412 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003413 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003414 continue;
3415
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003416 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003417 isl_map *AccessDomain = MA->getAccessRelation();
3418 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003419 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003420 }
3421 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003422 return isl_union_map_coalesce(Accesses);
3423}
3424
3425__isl_give isl_union_map *Scop::getMustWrites() {
3426 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003427}
3428
3429__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003430 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003431}
3432
Tobias Grosser37eb4222014-02-20 21:43:54 +00003433__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003434 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003435}
3436
3437__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003438 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003439}
3440
Tobias Grosser2ac23382015-11-12 14:07:13 +00003441__isl_give isl_union_map *Scop::getAccesses() {
3442 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3443}
3444
Tobias Grosser808cd692015-07-14 09:33:13 +00003445__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003446 auto *Tree = getScheduleTree();
3447 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003448 isl_schedule_free(Tree);
3449 return S;
3450}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003451
Tobias Grosser808cd692015-07-14 09:33:13 +00003452__isl_give isl_schedule *Scop::getScheduleTree() const {
3453 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3454 getDomains());
3455}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003456
Tobias Grosser808cd692015-07-14 09:33:13 +00003457void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3458 auto *S = isl_schedule_from_domain(getDomains());
3459 S = isl_schedule_insert_partial_schedule(
3460 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3461 isl_schedule_free(Schedule);
3462 Schedule = S;
3463}
3464
3465void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3466 isl_schedule_free(Schedule);
3467 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003468}
3469
3470bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3471 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003472 for (ScopStmt &Stmt : *this) {
3473 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003474 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3475 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3476
3477 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3478 isl_union_set_free(StmtDomain);
3479 isl_union_set_free(NewStmtDomain);
3480 continue;
3481 }
3482
3483 Changed = true;
3484
3485 isl_union_set_free(StmtDomain);
3486 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3487
3488 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003489 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003490 isl_union_set_free(NewStmtDomain);
3491 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003492 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003493 }
3494 isl_union_set_free(Domain);
3495 return Changed;
3496}
3497
Tobias Grosser75805372011-04-29 06:27:02 +00003498ScalarEvolution *Scop::getSE() const { return SE; }
3499
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003500bool Scop::isIgnored(RegionNode *RN, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003501 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Kruse6f7721f2016-02-24 22:08:19 +00003502 ScopStmt *Stmt = getStmtFor(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003503
3504 // If there is no stmt, then it already has been removed.
3505 if (!Stmt)
3506 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003507
Johannes Doerfertf5673802015-10-01 23:48:18 +00003508 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003509 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003510 return true;
3511
3512 // Check for reachability via non-error blocks.
3513 if (!DomainMap.count(BB))
3514 return true;
3515
3516 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003517 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003518 return true;
3519
3520 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003521}
3522
Tobias Grosser808cd692015-07-14 09:33:13 +00003523struct MapToDimensionDataTy {
3524 int N;
3525 isl_union_pw_multi_aff *Res;
3526};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003527
Tobias Grosser808cd692015-07-14 09:33:13 +00003528// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003529// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003530//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003531// @param Set The input set.
3532// @param User->N The dimension to map to.
3533// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003534//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003535// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003536static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3537 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3538 int Dim;
3539 isl_space *Space;
3540 isl_pw_multi_aff *PMA;
3541
3542 Dim = isl_set_dim(Set, isl_dim_set);
3543 Space = isl_set_get_space(Set);
3544 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3545 Dim - Data->N);
3546 if (Data->N > 1)
3547 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3548 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3549
3550 isl_set_free(Set);
3551
3552 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003553}
3554
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003555// @brief Create an isl_multi_union_aff that defines an identity mapping
3556// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003557//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003558// # Example:
3559//
3560// Domain: { A[i,j]; B[i,j,k] }
3561// N: 1
3562//
3563// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3564//
3565// @param USet A union set describing the elements for which to generate a
3566// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003567// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003568// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003569static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003570mapToDimension(__isl_take isl_union_set *USet, int N) {
3571 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003572 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003573 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003574
Tobias Grosser808cd692015-07-14 09:33:13 +00003575 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003576
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003577 auto *Space = isl_union_set_get_space(USet);
3578 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003579
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003580 Data = {N, PwAff};
3581
3582 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003583 (void)Res;
3584
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003585 assert(Res == isl_stat_ok);
3586
3587 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003588 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
3589}
3590
Tobias Grosser316b5b22015-11-11 19:28:14 +00003591void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00003592 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00003593 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003594 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003595 StmtMap[BB] = Stmt;
3596 } else {
3597 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00003598 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003599 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003600 for (BasicBlock *BB : R->blocks())
3601 StmtMap[BB] = Stmt;
3602 }
Tobias Grosser808cd692015-07-14 09:33:13 +00003603}
3604
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003605void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003606 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003607 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003608 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003609 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
3610 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003611}
3612
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003613/// To generate a schedule for the elements in a Region we traverse the Region
3614/// in reverse-post-order and add the contained RegionNodes in traversal order
3615/// to the schedule of the loop that is currently at the top of the LoopStack.
3616/// For loop-free codes, this results in a correct sequential ordering.
3617///
3618/// Example:
3619/// bb1(0)
3620/// / \.
3621/// bb2(1) bb3(2)
3622/// \ / \.
3623/// bb4(3) bb5(4)
3624/// \ /
3625/// bb6(5)
3626///
3627/// Including loops requires additional processing. Whenever a loop header is
3628/// encountered, the corresponding loop is added to the @p LoopStack. Starting
3629/// from an empty schedule, we first process all RegionNodes that are within
3630/// this loop and complete the sequential schedule at this loop-level before
3631/// processing about any other nodes. To implement this
3632/// loop-nodes-first-processing, the reverse post-order traversal is
3633/// insufficient. Hence, we additionally check if the traversal yields
3634/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
3635/// These region-nodes are then queue and only traverse after the all nodes
3636/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003637void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
3638 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003639 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
3640
3641 ReversePostOrderTraversal<Region *> RTraversal(R);
3642 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
3643 std::deque<RegionNode *> DelayList;
3644 bool LastRNWaiting = false;
3645
3646 // Iterate over the region @p R in reverse post-order but queue
3647 // sub-regions/blocks iff they are not part of the last encountered but not
3648 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
3649 // that we queued the last sub-region/block from the reverse post-order
3650 // iterator. If it is set we have to explore the next sub-region/block from
3651 // the iterator (if any) to guarantee progress. If it is not set we first try
3652 // the next queued sub-region/blocks.
3653 while (!WorkList.empty() || !DelayList.empty()) {
3654 RegionNode *RN;
3655
3656 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
3657 RN = WorkList.front();
3658 WorkList.pop_front();
3659 LastRNWaiting = false;
3660 } else {
3661 RN = DelayList.front();
3662 DelayList.pop_front();
3663 }
3664
3665 Loop *L = getRegionNodeLoop(RN, LI);
3666 if (!getRegion().contains(L))
3667 L = OuterScopLoop;
3668
3669 Loop *LastLoop = LoopStack.back().L;
3670 if (LastLoop != L) {
3671 if (!LastLoop->contains(L)) {
3672 LastRNWaiting = true;
3673 DelayList.push_back(RN);
3674 continue;
3675 }
3676 LoopStack.push_back({L, nullptr, 0});
3677 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003678 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003679 }
3680
3681 return;
3682}
3683
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003684void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003685 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00003686
Tobias Grosser8362c262016-01-06 15:30:06 +00003687 if (RN->isSubRegion()) {
3688 auto *LocalRegion = RN->getNodeAs<Region>();
3689 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003690 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00003691 return;
3692 }
3693 }
Michael Kruse046dde42015-08-10 13:01:57 +00003694
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003695 auto &LoopData = LoopStack.back();
3696 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00003697
Michael Kruse6f7721f2016-02-24 22:08:19 +00003698 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00003699 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
3700 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003701 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00003702 }
3703
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003704 // Check if we just processed the last node in this loop. If we did, finalize
3705 // the loop by:
3706 //
3707 // - adding new schedule dimensions
3708 // - folding the resulting schedule into the parent loop schedule
3709 // - dropping the loop schedule from the LoopStack.
3710 //
3711 // Then continue to check surrounding loops, which might also have been
3712 // completed by this node.
3713 while (LoopData.L &&
3714 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003715 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003716 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00003717
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003718 LoopStack.pop_back();
3719 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00003720
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003721 if (Schedule) {
3722 auto *Domain = isl_schedule_get_domain(Schedule);
3723 auto *MUPA = mapToDimension(Domain, LoopStack.size());
3724 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
3725 NextLoopData.Schedule =
3726 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003727 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003728
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003729 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
3730 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00003731 }
Tobias Grosser75805372011-04-29 06:27:02 +00003732}
3733
Michael Kruse6f7721f2016-02-24 22:08:19 +00003734ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00003735 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00003736 if (StmtMapIt == StmtMap.end())
3737 return nullptr;
3738 return StmtMapIt->second;
3739}
3740
Michael Kruse6f7721f2016-02-24 22:08:19 +00003741ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
3742 if (RN->isSubRegion())
3743 return getStmtFor(RN->getNodeAs<Region>());
3744 return getStmtFor(RN->getNodeAs<BasicBlock>());
3745}
3746
3747ScopStmt *Scop::getStmtFor(Region *R) const {
3748 ScopStmt *Stmt = getStmtFor(R->getEntry());
3749 assert(!Stmt || Stmt->getRegion() == R);
3750 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00003751}
3752
Johannes Doerfert96425c22015-08-30 21:13:53 +00003753int Scop::getRelativeLoopDepth(const Loop *L) const {
3754 Loop *OuterLoop =
3755 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
3756 if (!OuterLoop)
3757 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00003758 return L->getLoopDepth() - OuterLoop->getLoopDepth();
3759}
3760
Michael Krused868b5d2015-09-10 15:25:24 +00003761void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00003762 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003763
3764 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
3765 // true, are not modeled as ordinary PHI nodes as they are not part of the
3766 // region. However, we model the operands in the predecessor blocks that are
3767 // part of the region as regular scalar accesses.
3768
3769 // If we can synthesize a PHI we can skip it, however only if it is in
3770 // the region. If it is not it can only be in the exit block of the region.
3771 // In this case we model the operands but not the PHI itself.
3772 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
3773 return;
3774
3775 // PHI nodes are modeled as if they had been demoted prior to the SCoP
3776 // detection. Hence, the PHI is a load of a new memory location in which the
3777 // incoming value was written at the end of the incoming basic block.
3778 bool OnlyNonAffineSubRegionOperands = true;
3779 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
3780 Value *Op = PHI->getIncomingValue(u);
3781 BasicBlock *OpBB = PHI->getIncomingBlock(u);
3782
3783 // Do not build scalar dependences inside a non-affine subregion.
3784 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
3785 continue;
3786
3787 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003788 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003789 }
3790
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003791 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3792 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003793 }
3794}
3795
Michael Kruse2e02d562016-02-06 09:19:40 +00003796void ScopInfo::buildScalarDependences(Instruction *Inst) {
3797 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00003798
Michael Kruse2e02d562016-02-06 09:19:40 +00003799 // Pull-in required operands.
3800 for (Use &Op : Inst->operands())
3801 ensureValueRead(Op.get(), Inst->getParent());
3802}
Michael Kruse7bf39442015-09-10 12:46:52 +00003803
Michael Kruse2e02d562016-02-06 09:19:40 +00003804void ScopInfo::buildEscapingDependences(Instruction *Inst) {
3805 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00003806
Michael Kruse2e02d562016-02-06 09:19:40 +00003807 // Check for uses of this instruction outside the scop. Because we do not
3808 // iterate over such instructions and therefore did not "ensure" the existence
3809 // of a write, we must determine such use here.
3810 for (Use &U : Inst->uses()) {
3811 Instruction *UI = dyn_cast<Instruction>(U.getUser());
3812 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00003813 continue;
3814
Michael Kruse2e02d562016-02-06 09:19:40 +00003815 BasicBlock *UseParent = getUseBlock(U);
3816 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00003817
Michael Kruse2e02d562016-02-06 09:19:40 +00003818 // An escaping value is either used by an instruction not within the scop,
3819 // or (when the scop region's exit needs to be simplified) by a PHI in the
3820 // scop's exit block. This is because region simplification before code
3821 // generation inserts new basic blocks before the PHI such that its incoming
3822 // blocks are not in the scop anymore.
3823 if (!R->contains(UseParent) ||
3824 (isa<PHINode>(UI) && UserParent == R->getExit() &&
3825 R->getExitingBlock())) {
3826 // At least one escaping use found.
3827 ensureValueWrite(Inst);
3828 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00003829 }
3830 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003831}
3832
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003833bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00003834 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00003835 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3836 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00003837 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003838 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003839 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003840 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003841 const SCEVUnknown *BasePointer =
3842 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003843 enum MemoryAccess::AccessType Type =
3844 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003845
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003846 if (isa<GetElementPtrInst>(Address) || isa<BitCastInst>(Address)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003847 auto *NewAddress = Address;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003848 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003849 auto *Src = BitCast->getOperand(0);
3850 auto *SrcTy = Src->getType();
3851 auto *DstTy = BitCast->getType();
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003852 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3853 NewAddress = Src;
3854 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003855
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003856 if (auto *GEP = dyn_cast<GetElementPtrInst>(NewAddress)) {
3857 std::vector<const SCEV *> Subscripts;
3858 std::vector<int> Sizes;
3859 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003860 auto *BasePtr = GEP->getOperand(0);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003861
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003862 std::vector<const SCEV *> SizesSCEV;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003863
Johannes Doerferta90943d2016-02-21 16:37:25 +00003864 for (auto *Subscript : Subscripts) {
Johannes Doerfert09e36972015-10-07 20:17:36 +00003865 InvariantLoadsSetTy AccessILS;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003866 if (!isAffineExpr(R, Subscript, *SE, nullptr, &AccessILS))
3867 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003868
3869 for (LoadInst *LInst : AccessILS)
3870 if (!ScopRIL.count(LInst))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003871 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003872 }
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003873
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003874 if (Sizes.size() > 0) {
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003875 for (auto V : Sizes)
3876 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
3877 IntegerType::getInt64Ty(BasePtr->getContext()), V)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003878
Johannes Doerfertcea61932016-02-21 19:13:19 +00003879 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
Tobias Grossera535dff2015-12-13 19:59:01 +00003880 Subscripts, SizesSCEV, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003881 return true;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003882 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003883 }
3884 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003885 return false;
3886}
3887
3888bool ScopInfo::buildAccessMultiDimParam(
3889 MemAccInst Inst, Loop *L, Region *R,
3890 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00003891 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003892 Value *Address = Inst.getPointerOperand();
3893 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003894 Type *ElementType = Val->getType();
3895 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003896 enum MemoryAccess::AccessType Type =
3897 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3898
3899 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3900 const SCEVUnknown *BasePointer =
3901 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3902
3903 assert(BasePointer && "Could not find base pointer");
3904 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003905
Michael Kruse7bf39442015-09-10 12:46:52 +00003906 auto AccItr = InsnToMemAcc.find(Inst);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003907 if (PollyDelinearize && AccItr != InsnToMemAcc.end()) {
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003908 std::vector<const SCEV *> Sizes(
3909 AccItr->second.Shape->DelinearizedSizes.begin(),
3910 AccItr->second.Shape->DelinearizedSizes.end());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003911 // Remove the element size. This information is already provided by the
Tobias Grosserd840fc72016-02-04 13:18:42 +00003912 // ElementSize parameter. In case the element size of this access and the
3913 // element size used for delinearization differs the delinearization is
3914 // incorrect. Hence, we invalidate the scop.
3915 //
3916 // TODO: Handle delinearization with differing element sizes.
3917 auto DelinearizedSize =
3918 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003919 Sizes.pop_back();
Tobias Grosserd840fc72016-02-04 13:18:42 +00003920 if (ElementSize != DelinearizedSize)
3921 scop->invalidate(DELINEARIZATION, Inst.getDebugLoc());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003922
Johannes Doerfertcea61932016-02-21 19:13:19 +00003923 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003924 AccItr->second.DelinearizedSubscripts, Sizes, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003925 return true;
Michael Krusee2bccbb2015-09-18 19:59:43 +00003926 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003927 return false;
3928}
3929
Johannes Doerfertcea61932016-02-21 19:13:19 +00003930bool ScopInfo::buildAccessMemIntrinsic(
3931 MemAccInst Inst, Loop *L, Region *R,
3932 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3933 const InvariantLoadsSetTy &ScopRIL) {
3934 if (!Inst.isMemIntrinsic())
3935 return false;
3936
3937 auto *LengthVal = SE->getSCEVAtScope(Inst.asMemIntrinsic()->getLength(), L);
3938 assert(LengthVal);
3939
3940 auto *DestPtrVal = Inst.asMemIntrinsic()->getDest();
3941 assert(DestPtrVal);
3942 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
3943 assert(DestAccFunc);
3944 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
3945 assert(DestPtrSCEV);
3946 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
3947 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
3948 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
3949 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
3950
3951 if (!Inst.isMemTransferInst())
3952 return true;
3953
3954 auto *SrcPtrVal = Inst.asMemTransferInst()->getSource();
3955 assert(SrcPtrVal);
3956 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
3957 assert(SrcAccFunc);
3958 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
3959 assert(SrcPtrSCEV);
3960 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
3961 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
3962 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
3963 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
3964
3965 return true;
3966}
3967
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003968void ScopInfo::buildAccessSingleDim(
3969 MemAccInst Inst, Loop *L, Region *R,
3970 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3971 const InvariantLoadsSetTy &ScopRIL) {
3972 Value *Address = Inst.getPointerOperand();
3973 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003974 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003975 enum MemoryAccess::AccessType Type =
3976 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3977
3978 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3979 const SCEVUnknown *BasePointer =
3980 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3981
3982 assert(BasePointer && "Could not find base pointer");
3983 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00003984
3985 // Check if the access depends on a loop contained in a non-affine subregion.
3986 bool isVariantInNonAffineLoop = false;
3987 if (BoxedLoops) {
3988 SetVector<const Loop *> Loops;
3989 findLoops(AccessFunction, Loops);
3990 for (const Loop *L : Loops)
3991 if (BoxedLoops->count(L))
3992 isVariantInNonAffineLoop = true;
3993 }
3994
Johannes Doerfert09e36972015-10-07 20:17:36 +00003995 InvariantLoadsSetTy AccessILS;
3996 bool IsAffine =
3997 !isVariantInNonAffineLoop &&
3998 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue(), &AccessILS);
3999
4000 for (LoadInst *LInst : AccessILS)
4001 if (!ScopRIL.count(LInst))
4002 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004003
Michael Krusee2bccbb2015-09-18 19:59:43 +00004004 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
4005 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004006
Johannes Doerfertcea61932016-02-21 19:13:19 +00004007 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004008 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004009}
4010
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004011void ScopInfo::buildMemoryAccess(
4012 MemAccInst Inst, Loop *L, Region *R,
4013 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004014 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004015
Johannes Doerfertcea61932016-02-21 19:13:19 +00004016 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4017 return;
4018
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004019 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4020 return;
4021
Hongbin Zheng22623202016-02-15 00:20:58 +00004022 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004023 return;
4024
4025 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4026}
4027
Hongbin Zheng22623202016-02-15 00:20:58 +00004028void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4029 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004030
4031 if (SD->isNonAffineSubRegion(&SR, &R)) {
4032 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004033 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004034 return;
4035 }
4036
4037 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4038 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004039 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004040 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004041 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004042}
4043
Johannes Doerferta8781032016-02-02 14:14:40 +00004044void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004045
Johannes Doerferta8781032016-02-02 14:14:40 +00004046 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004047 scop->addScopStmt(nullptr, &SR);
4048 return;
4049 }
4050
4051 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4052 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004053 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004054 else
4055 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4056}
4057
Michael Krused868b5d2015-09-10 15:25:24 +00004058void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004059 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004060 Region *NonAffineSubRegion,
4061 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004062 // We do not build access functions for error blocks, as they may contain
4063 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004064 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004065 return;
4066
Michael Kruse7bf39442015-09-10 12:46:52 +00004067 Loop *L = LI->getLoopFor(&BB);
4068
4069 // The set of loops contained in non-affine subregions that are part of R.
4070 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4071
Johannes Doerfert09e36972015-10-07 20:17:36 +00004072 // The set of loads that are required to be invariant.
4073 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4074
Michael Kruse2e02d562016-02-06 09:19:40 +00004075 for (Instruction &Inst : BB) {
4076 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004077 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004078 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004079
4080 // For the exit block we stop modeling after the last PHI node.
4081 if (!PHI && IsExitBlock)
4082 break;
4083
Johannes Doerfert09e36972015-10-07 20:17:36 +00004084 // TODO: At this point we only know that elements of ScopRIL have to be
4085 // invariant and will be hoisted for the SCoP to be processed. Though,
4086 // there might be other invariant accesses that will be hoisted and
4087 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004088 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004089 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004090
Michael Kruse2e02d562016-02-06 09:19:40 +00004091 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004092 continue;
4093
Michael Kruse2e02d562016-02-06 09:19:40 +00004094 if (!PHI)
4095 buildScalarDependences(&Inst);
4096 if (!IsExitBlock)
4097 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004098 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004099}
Michael Kruse7bf39442015-09-10 12:46:52 +00004100
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004101MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004102 MemoryAccess::AccessType AccType,
4103 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004104 bool Affine, Value *AccessValue,
4105 ArrayRef<const SCEV *> Subscripts,
4106 ArrayRef<const SCEV *> Sizes,
4107 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004108 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004109
4110 // Do not create a memory access for anything not in the SCoP. It would be
4111 // ignored anyway.
4112 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004113 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004114
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004115 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004116 Value *BaseAddr = BaseAddress;
4117 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4118
Tobias Grosserf4f68702015-12-14 15:05:37 +00004119 bool isKnownMustAccess = false;
4120
4121 // Accesses in single-basic block statements are always excuted.
4122 if (Stmt->isBlockStmt())
4123 isKnownMustAccess = true;
4124
4125 if (Stmt->isRegionStmt()) {
4126 // Accesses that dominate the exit block of a non-affine region are always
4127 // executed. In non-affine regions there may exist MK_Values that do not
4128 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4129 // only if there is at most one PHI_WRITE in the non-affine region.
4130 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4131 isKnownMustAccess = true;
4132 }
4133
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004134 // Non-affine PHI writes do not "happen" at a particular instruction, but
4135 // after exiting the statement. Therefore they are guaranteed execute and
4136 // overwrite the old value.
4137 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4138 isKnownMustAccess = true;
4139
Johannes Doerfertcea61932016-02-21 19:13:19 +00004140 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4141 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004142
Johannes Doerfertcea61932016-02-21 19:13:19 +00004143 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004144 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004145 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004146 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004147}
4148
Michael Kruse70131d32016-01-27 17:09:17 +00004149void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004150 MemoryAccess::AccessType AccType,
4151 Value *BaseAddress, Type *ElementType,
4152 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004153 ArrayRef<const SCEV *> Sizes,
4154 Value *AccessValue) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004155 addMemoryAccess(MemAccInst.getParent(), MemAccInst, AccType, BaseAddress,
4156 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004157 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004158}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004159
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004160void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004161 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004162
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004163 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004164 if (!Stmt)
4165 return;
4166
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004167 // Do not process further if the instruction is already written.
4168 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004169 return;
4170
Johannes Doerfertcea61932016-02-21 19:13:19 +00004171 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4172 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004173 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004174}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004175
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004176void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004177
Michael Kruse2e02d562016-02-06 09:19:40 +00004178 // There cannot be an "access" for literal constants. BasicBlock references
4179 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004180 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004181 return;
4182
Michael Krusefd463082016-01-27 22:51:56 +00004183 // If the instruction can be synthesized and the user is in the region we do
4184 // not need to add a value dependences.
4185 Region &ScopRegion = scop->getRegion();
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004186 if (canSynthesize(V, LI, SE, &ScopRegion))
Michael Krusefd463082016-01-27 22:51:56 +00004187 return;
4188
Michael Kruse2e02d562016-02-06 09:19:40 +00004189 // Do not build scalar dependences for required invariant loads as we will
4190 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004191 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004192 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004193 return;
4194
4195 // Determine the ScopStmt containing the value's definition and use. There is
4196 // no defining ScopStmt if the value is a function argument, a global value,
4197 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004198 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004199 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004200
Michael Kruse6f7721f2016-02-24 22:08:19 +00004201 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004202
4203 // We do not model uses outside the scop.
4204 if (!UserStmt)
4205 return;
4206
Michael Kruse2e02d562016-02-06 09:19:40 +00004207 // Add MemoryAccess for invariant values only if requested.
4208 if (!ModelReadOnlyScalars && !ValueStmt)
4209 return;
4210
4211 // Ignore use-def chains within the same ScopStmt.
4212 if (ValueStmt == UserStmt)
4213 return;
4214
Michael Krusead28e5a2016-01-26 13:33:15 +00004215 // Do not create another MemoryAccess for reloading the value if one already
4216 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004217 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004218 return;
4219
Johannes Doerfertcea61932016-02-21 19:13:19 +00004220 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004221 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004222 ScopArrayInfo::MK_Value);
Michael Kruse2e02d562016-02-06 09:19:40 +00004223 if (ValueInst)
4224 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004225}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004226
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004227void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4228 Value *IncomingValue, bool IsExitBlock) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004229 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004230 if (!IncomingStmt)
4231 return;
4232
4233 // Take care for the incoming value being available in the incoming block.
4234 // This must be done before the check for multiple PHI writes because multiple
4235 // exiting edges from subregion each can be the effective written value of the
4236 // subregion. As such, all of them must be made available in the subregion
4237 // statement.
4238 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004239
4240 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4241 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4242 assert(Acc->getAccessInstruction() == PHI);
4243 Acc->addIncoming(IncomingBlock, IncomingValue);
4244 return;
4245 }
4246
4247 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004248 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4249 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4250 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004251 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4252 assert(Acc);
4253 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004254}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004255
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004256void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004257 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4258 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4259 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004260}
4261
Michael Krusedaf66942015-12-13 22:10:37 +00004262void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004263 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004264 scop.reset(new Scop(R, *SE, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004265
Johannes Doerferta8781032016-02-02 14:14:40 +00004266 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004267 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004268
4269 // In case the region does not have an exiting block we will later (during
4270 // code generation) split the exit block. This will move potential PHI nodes
4271 // from the current exit block into the new region exiting block. Hence, PHI
4272 // nodes that are at this point not part of the region will be.
4273 // To handle these PHI nodes later we will now model their operands as scalar
4274 // accesses. Note that we do not model anything in the exit block if we have
4275 // an exiting block in the region, as there will not be any splitting later.
4276 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004277 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4278 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004279
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004280 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004281}
4282
Michael Krused868b5d2015-09-10 15:25:24 +00004283void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004284 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004285 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004286 return;
4287 }
4288
Michael Kruse9d080092015-09-11 21:41:48 +00004289 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004290}
4291
Hongbin Zhengfec32802016-02-13 15:13:02 +00004292void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004293
4294//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004295ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004296
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004297ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004298
Tobias Grosser75805372011-04-29 06:27:02 +00004299void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004300 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004301 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004302 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004303 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4304 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004305 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004306 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004307 AU.setPreservesAll();
4308}
4309
4310bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004311 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004312
Michael Krused868b5d2015-09-10 15:25:24 +00004313 if (!SD->isMaxRegionInScop(*R))
4314 return false;
4315
4316 Function *F = R->getEntry()->getParent();
4317 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4318 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4319 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004320 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004321 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004322 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004323
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004324 DebugLoc Beg, End;
4325 getDebugLocations(R, Beg, End);
4326 std::string Msg = "SCoP begins here.";
4327 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4328
Michael Krusedaf66942015-12-13 22:10:37 +00004329 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004330
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004331 DEBUG(scop->print(dbgs()));
4332
Michael Kruseafe06702015-10-02 16:33:27 +00004333 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004334 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004335 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004336 } else {
4337 Msg = "SCoP ends here.";
4338 ++ScopFound;
4339 if (scop->getMaxLoopDepth() > 0)
4340 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004341 }
4342
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004343 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4344
Tobias Grosser75805372011-04-29 06:27:02 +00004345 return false;
4346}
4347
4348char ScopInfo::ID = 0;
4349
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004350Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4351
Tobias Grosser73600b82011-10-08 00:30:40 +00004352INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4353 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004354 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004355INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004356INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004357INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004358INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004359INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004360INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004361INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004362INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4363 "Polly - Create polyhedral description of Scops", false,
4364 false)